Bone-beta-1
Upgrades
This release includes new versions of Bor (v1.1.0-bone-beta-1) and Heimdall (v1.0.2-bone-beta-1). We have added a new CLI in Bor and have also changed the way Bor is deployed to follow DevOps best practices and make it easier to manage the processes. This upgrade is backward-incompatible. Please ensure that all Puppynet nodes are upgraded before the release of the next version, which will contain hardforks.
Deployment changes
Changes in Bor:
Provide a new approach to install Bor binary with a shell script: GitHub - shibaone/install 79.
Recommended default Bor home is changed from
~/.bor to /var/lib/bor
.bor/start.sh will be retired. We recommend moving flags from start.sh to
/var/lib/bor/config.toml
, which will be the single config file for all Bor configurations. Example config toml files can be found in GitHub -shibaone/launch: Shibarium network mainnet v1 launch.A new user named Bor will be created during package installation if it doesn’t exist. This user will be running the Bor service.
Move bor.service file from
/etc/systemd/system to /lib/systemd/system
.CLI flag changes. For validators who want to continue setting Bor configs through CLI, see appendix for detailed changes.
Bor profiles can be used with new hosts only, please note existing installations will not be able to take advantage of the profiles.
Bor packaging installation is now simplified to
sudo dpkg -i bor-$version-$arch.deb
Bor profile installation for new hosts is accomplished by running
sudo dpkg -i bor-$network-$nodetype-config_$version-$arch.deb
Changes in Heimdall:
Provide a new approach to install Heimdall binary with a shell script: GitHub - shibaone/install.
Remove bridge binary and add it as a subcommand in heimdalld.
Remove heimdalld-rest-server.service and heimdalld-bridge.service, and move heimdalld.service file from
/etc/systemd/system to /lib/systemd/system
.Change default heimdall home from
~/.heimdalld to /var/lib/heimdall
.A new user named heimdall will be created during package installation if it doesn’t exist. This user will be running the Heimdall service.
Heimdall packaging installation is now simplified to
sudo dpkg -i heimdalld-$version-$arch.deb
Heimdall profile installation for new hosts is accomplished by running
sudo dpkg -i heimdalld-$network-$nodetype-config_$version-$arch.deb
Upgrade instructions
Steps to migrate to the new version:
Stop all the services
Go version upgrade
3. Install Heimdall and Bor with a version tag, network name ( puppynet,shibarium) and node type (sentry, validator, or archive).
4. Set the old Bor home directory path and export it. This will be used, whenever needed, moving forward.
5. Check Heimdall & Bor Version
6. Create backup for service
7. Check and edit bor.service file to make any changes if required. You can skip this step if the Bor package is installed with the correct network and node type arguments in step 2. Check and edit heimdalld.service file to make any changes if required (like adding bridge flag --bridge --all for validators).
Example of bor.service file:
Example of heimdall.service file:
8. Migrating to config.toml from start.sh:
Example usage: network name ( puppynet,shibarium) and node type (sentry, validator, or archive)
9. For better monitoring of the overall network and conditions of the node, we have hosted the ethstats dashboard. We would advise all the nodes to use the public endpoint for sending data (if you’re not sending it to some other internal endpoint). The endpoint can be configured in the config file itself and is of the format: <node_identifier>:testnet@bor-eth-stat.shibariumscan.io:3000 ex- ethstats = "Explorer-archive-rpc:testnet@bor-eth-stat.shibariumscan.io:3000”
We would encourage users to use non-existing and understandable identifiers. This dashboard would also help us in alerting in case the nodes are not working properly (e.g. if they’re constantly out of sync).
Open the file /var/lib/bor/config.toml
in your favorite text editor and edit the value for ethstats:
ethstats = "<node_identifier>:testnet@bor-eth-stat.shibariumscan.io:3000"
10. Ensure that all the values have been populated correctly in Bor config file /var/lib/bor/config.toml
. If you want to change any config options, you can edit the file.
If you are not migrating from an old start.sh, the default values populated should work out of the box for a sentry node. For validator nodes, you might want to update some of the flags like: etherbase, unlock, password, keystore, maxpeers, static-nodes, ethstats, and additional telemetry configuration (from older start.sh based config).
11. Restart system processes:
Last updated