Using 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.

Overview

• 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

Install binaries

Polygon node consists of 2 layers: Heimdall and Bor. Heimdall is a Cosmos-SDK/CometBFT 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/0xPolygon/install/heimdall-v2/heimdall-v2.sh | bash -s -- <heimdall_version> <network> <node_type>

You can run the above command with the following options:

• heimdall_version: Valid v0.2+ release tag from https://github.com/0xPolygon/heimdall-v2/releases
• network_type: mainnet and amoy
• node_type: sentry

This will install the heimdalld binary.

Then, edit the configuration files under /var/lib/heimdall/config
The templates for each supported network are available here
Download the genesis.json file and place it under /var/lib/heimdall/config/ Use the following commands based on your target network:

cd /var/lib/heimdall/config
curl -fsSL <BUCKET_URL> -o genesis.json

Where BUCKET_URL is

• https://storage.googleapis.com/amoy-heimdallv2-genesis/migrated_dump-genesis.json for amoy
• https://storage.googleapis.com/mainnet-heimdallv2-genesis/migrated_dump-genesis.json for mainnet

Verify the installation by checking the Heimdall version on your machine:

heimdalld version

It should return the version of Heimdall you installed.

Bor

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

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

You can run the above command with following options:

• bor_version: valid v2.0+ release tag from https://github.com/0xPolygon/bor/releases
• network_type: mainnet and amoy
• node_type: sentry

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

bor version

Configure Heimdall and Bor seeds

The latest bor and heimdall seeds can be found here. To configure them, update the following lines:

• If not done previously, set the seeds and persistent_peers values in /var/lib/heimdall/config/config.toml
• Set the bootnodes in /var/lib/bor/config.toml

This will ensure your node connects to the peers.

(Optional) Start Heimdall from snapshot

In case you want to start Heimdall from a snapshot,
you can download it, and extract in the data folder. Examples of snapshots can be found here https://all4nodes.io/Polygon, and they are managed by the community.

e.g.:

lz4 -dc polygon-heimdall-24404501-25758577.tar.lz4 | tar -x

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

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