Skip to main content

Full node with binaries

This deployment guide walks you through starting and running a full node through various methods. For the system requirements, see the minimum technical requirements guide.

"Snapshots"

Steps in these guide involve waiting for the Heimdall and Bor services to fully sync. This process takes several days to complete.

Please use snapshots for faster syncing without having to sync over the network.

For snapshot download links, see the Shibarium Chains Snapshots page.

Overview​

warning

It is essential to follow the outlined sequence of actions precisely, as any deviation may lead to potential issues.

  • Prepare the machine.
  • Install Heimdall and Bor binaries on the full node machine.
  • Set up Heimdall and Bor services on the full node machine.
  • Configure the full node machine.
  • Start the full node machine.
  • Check node health with the community.

Install build-essential​

This is required for your full node. In order to install, run the below command:

sudo apt-get update
sudo apt-get install build-essential
note

Check the latest version of Heimdall and Bor for Shibarium (tags -- 1.x.x-bone) and Puppynet (tags -- 1.x.x-bone-beta-x). OR

Install binaries​

Shibarium node consists of 2 layers: Heimdall and Bor. Heimdall is a Tendermint fork that monitors contracts in parallel with the Ethereum network. Bor is basically a Geth fork that generates blocks shuffled by Heimdall nodes.

Both binaries must be installed and run in the correct order to function properly.

Heimdall​

Install the latest version of Heimdall and related services. Make sure you checkout to the correct release version.

To install Heimdall, run the following commands:

curl -L https://raw.githubusercontent.com/shibaone/install/bone/heimdall.sh | bash -s -- <heimdall_version> <network_type> <node_type>

You can run the above command with following options:

This will install the heimdalld and heimdallcli binaries. Verify the installation by checking the Heimdall version on your machine:

heimdalld version --long

Configure Heimdall seeds and Bor Bootnodes​

seeds and bootnodes

Bor​

Install the latest version of Bor, based on valid v1.0+ released version.

curl -L https://raw.githubusercontent.com/shibaone/install/bone/bor.sh | bash -s -- <bor_version> <network_type> <node_type>

You can run the above command with following options:

That will install the bor binary. Verify the installation by checking the Bor version on your machine:

bor version

Configure Bor seeds​

sed -i 's|.*\[p2p.discovery\]|  \[p2p.discovery\] |g' /var/lib/bor/config.toml
sed -i 's|.*bootnodes =.*|    bootnodes = [""]|g' /var/lib/bor/config.toml
chown bor /var/lib/bor

Update service config user permission​

sed -i 's/User=heimdall/User=root/g' /lib/systemd/system/heimdalld.service
sed -i 's/User=bor/User=root/g' /lib/systemd/system/bor.service

Start services​

Run the full Heimdall node with these commands on your Sentry Node:

sudo service heimdalld start
"Wait for Heimdall to complete syncing"

Ensure that Heimdall is fully synced before starting Bor. Initiating Bor without complete synchronization of Heimdall may lead to frequent issues.

To check if Heimdall is synced:

  1. On the remote machine/VM, run curl localhost:26657/status.
  2. In the output, catching_up value should be false.

Once Heimdall is synced, run the following command:

sudo service bor start

Logs​

Logs can be managed by the journalctl linux tool. Here is a tutorial for advanced usage: How To Use Journalctl to View and Manipulate Systemd Logs.

Check Heimdall node logs​

journalctl -u heimdalld.service -f

Check Bor node logs​

journalctl -u bor.service -f