sangtn0102 / massa-auto

Massa node + massa-guard

Massa node + Massa-guard

Last build for Massa testnet Episode 15 release 15.1.0

[DESCRIPTION]

[FEATURES]

Build a massa-node container wich include some automation features from a community image with Massalabs agreements

This image include a script named "/massa-guard/massa-guard.sh" to:

• [GENERAL]
  • Enable/Disable all massa-guard features (Except keys creations) with the "MASSAGUARD" setting in config.ini
• [AUTOBUY/AUTOSELL]
  • Autobuy 1 roll when your node failed and lost his "Active rolls".
  • Autobuy X rolls when your MAS amount greater than 200 MAS and if "Active rolls" dont exceed "TARGET_ROLL_AMOUNT" set in /massa_mount/config/config.ini (If set).
  • Autosell X rolls when "Active rolls" exceed "TARGET_ROLL_AMOUNT" set in /massa_mount/config/config.ini (If set).
• [BOOTSTRAPFINDER]
  • Auto refresh massa online bootstrap list with connected node.
  • Filter to only add node which have TCP port 31244 & 31245 reachable.
• [WATCHDOG]
  • Restart node when hang or when ram consumption exceed 90% (Value can be adjust)
  • You host your node under a dynamical IP? massa-guard will watch IP change and update your config.toml and push IP updates to massabot.
  • Push public IP or public IP change to massabot (Need to set discord token in /massa_mount/config/config.ini)
  • Logs his actions over /massa_mount/logs/ and backup node logs before restart if necessary.
  • Autoget MAS faucet on Discord 1 time by day (Need to set discord token in /massa_mount/config/config.ini)
• [STARTING]
  • Massa-guard will auto register your node with massabot.
  • Massa-guard will auto create wallet + nodekey + stacke privkey; all with default password "MassaToTheMoon2022".
  • Massa-guard auto create your config.toml with your public IP.
  • Massa-guard auto get faucet to buy your first roll.

[RELEASE NOTES]

• 20221010 - Testnet 15 - v15.1.0 - Testnet 15 - v15.1 Ready!
• 20221005 - Testnet 15 - v15.0.0 - Testnet 15 - v15.0 Ready!
• 20220921 - Testnet 14 - v14.7.0 - Testnet 14 - v14.7 Ready! Solve MAS amount calculation issue
• 20220920 - Testnet 14 - v14.6.0 - Testnet 14 - v14.6 Ready!
• 20220919 - Testnet 14 - v14.5.0 - Testnet 14 - v14.5 Ready! + Add MASSAGUARD setting in config.ini to switch on/off massa-guard
• 20220917 - Testnet 14 - v14.4.0 - Testnet 14 - v14.4 Ready!
• 20220916 - Testnet 14 - v14.3.0 - Testnet 14 - v14.3 Ready!
• 20220916 - Testnet 14 - v14.2.0 - Testnet 14 - v14.2 Ready!
• 20220909 - Testnet 14 - v14.1.0 - Testnet 14 - v14.1 Ready!
• 20220909 - Testnet 14 - v14.0.1 - Solve discord feature issues
• 20220909 - Testnet 14 - v14.0.0 - Testnet 14 Ready! /!\ Discord features dont work in this version (Faucet spammer / Dyn IP / Resgistration)

[HOWTO]

[SETUP]

[PREPARE]

STEP 1: /!\ Register your discord account to the testnet program

• Go to Massa Discord channel https://discord.com/channels/828270821042159636/872395473493839913 and follow inscructions.

STEP 2: Create an empty folder to mount in our container /massa_mount path or store your wallet /nodekey/stacking_key/config.toml into this folder if you have it:

• wallet.dat
• config.toml
• node_privkey.key
• staking_keys.json

/!\ If don't have this file, leave your folder empty, massa-guard will create a wallet and node key and automaticaly stake wallet for you. This files will be backup on your mount point by massa-guard.

/!\ User of one of previous release? Please update your /massa_mount/config/config.ini to check if all entries exist. Check template last here https://github.com/rykcod/massa/blob/main/config/default_config_template.ini

[RUN] Usecase Example

/!\ You can define ENV values when you create your container:

• ''MASSAGUARD'' - Set with 1 to enable all massa-guard features or with 0 to disable all features except keys creations (Enable by default without ENV value)
• ''DISCORD'' - Set with your discord token id (Refer to HELP section) - To enable discord feature (GetFaucet + NodeRegistration + DynamicalIP)
• ''DYNIP'' - Set with "0" if you host under static public IP or "1" if you host under dynimic public IP to enable update IP feature
• ''WALLETPWD'' - Set with "YourCustomPassword" if you want to use a custom wallet password.
• ''NODEPWD'' - Set with "YourCustomPassword" if you want to use a custom node password.
• ''IP'' - Set with "YourIPAddress" if your node have differents publics IPs and you want to set your custom selection. /!\ Please note, this ENV variables have a low priority if a previous config.ini exist in your mount point.

• Example N°1: Container creation example with ENV variables to define Dicord token :

docker run -d -v /%MY_PATH%/massa_mount:/massa_mount -p 31244-31245:31244-31245 -p 33035:33035 -e "DISCORD=OTc2MDkyTgP0OTU4NCXsNTIy.G5jqAc.b+rV4MgEnMvo48ICeGg6E_QPg4dHjlSBJA06CA" --name massa-node rykcod/massa

• Example N°2: Container creation example with ENV variables to define Dicord token and run a basical container without massa-guard automation :

docker run -d -v /%MY_PATH%/massa_mount:/massa_mount -p 31244-31245:31244-31245 -p 33035:33035 -e "DISCORD=OTc2MDkyTgP0OTU4NCXsNTIy.G5jqAc.b+rV4MgEnMvo48ICeGg6E_QPg4dHjlSBJA06CA" -e "MASSAGUARD=0" --name massa-node rykcod/massa

• To connect into your container:

docker exec -it massa-node /bin/bash

• Connect to massa-client after container connection:

screen -x massa-client

• Exit screen or container:

ctrl+a+d

[MAINTENANCE] After container creation

[OPTION] To enable or update features after container creation just edit /massa_mount/config/config.ini and set

• Set your ''DISCORD_TOKEN'' value to enable "Autoget MAS faucet" feature and autoregistration node and IP to massabot (Refer to HELP section)
• Set your ''DYN_PUB_IP'' value to enable dynamical IP management (0=Disable 1=Enable)
• Set your ''TARGET_ROLL_AMOUNT'' value to enable roll amount target to stake for your node (Integer value)
• Set your ''NODE_TESTNET_REGISTRATION'' value to enable node registration with massabot (KO=Enable OK=AlreadyDone)
• Set your ''MASSAGUARD'' value to enable or disable massa-guard features 0=Disable 1=Enable (Enable by default)

[HELP]

• Massa client is running over a "screen" named "massa-client"
• Massa node is running over a "screen" named "massa-node"
• To get your discord token, refer to https://shufflegazine.com/get-discord-token/

[LOGS PATH]

• Massa-guard actions and events are logs into %MountPoint%/logs/massa-guard/%DATE%-massa_guard.txt
• Massa-node events are archived after every restart into %MountPoint%/logs/massa-guard/%DATE%-logs.txt

[HELP - Easy beginner way for IPV6 usage]

• Create or edit your host /etc/docker/daemon.json to add:

{
  "ipv6": true,
  "fixed-cidr-v6": "fd00::/80"
}

• Restart docker service to reload config setting
• Allow MASQUERADE for ipv6

ip6tables -t nat -A POSTROUTING -s fd00::/80 ! -o docker0 -j MASQUERADE

• Create a container which dynamicaly edit your iptables rules for port redirection

docker run -d --restart=always -v /var/run/docker.sock:/var/run/docker.sock:ro --cap-drop=ALL --cap-add=NET_RAW --cap-add=NET_ADMIN --cap-add=SYS_MODULE --net=host --name ipv6nat robbertkl/ipv6nat

For more informations and sources - https://github.com/rykcod/massa/

[VIDEO TUTORIAL][FR]

https://youtu.be/IzeRq43DBSQ

[THANKS]

Thanks to fsidhoum for help