Skip to content

Latest commit

 

History

History
334 lines (228 loc) · 15.8 KB

compile-and-run-a-node.md

File metadata and controls

334 lines (228 loc) · 15.8 KB
Raw
id title sidebar_label sidebar_position description
compile-and-run-a-node
Run a Validator Node
Run a Node
3
Compile and Run a NEAR Node without Container in localnet, testnet, and mainnet

If this is the first time for you to setup a validator node, head to our Validator Bootcamp 🚀.

The following instructions are applicable across localnet, testnet, and mainnet. Note: We do not use nearup on mainnet.

If you are looking to learn how to compile and run a NEAR validator node natively (without containerization) for one of the following networks, this guide is for you.

Prerequisites {#prerequisites}

  • Rust. If not already installed, please follow these instructions.
  • Git
  • Installed developer tools:
    • MacOS 
      $ brew install cmake protobuf clang llvm awscli
    • Linux 
      $ apt update
$ apt install -y git binutils-dev libcurl4-openssl-dev zlib1g-dev libdw-dev libiberty-dev cmake gcc g++ python docker.io protobuf-compiler libssl-dev pkg-config clang llvm cargo awscli

How to use this document {#how-to-use-this-document}

This document is separated into sections by network ID. Although all of the sections have almost the exact same steps/text, we found it more helpful to create individual sections so you can easily copy-paste commands to quickly get your node running.

Choosing your nearcore version {#choosing-your-nearcore-version}

When building your NEAR node you will have two branch options to choose from depending on your desired use:

  • master : (Experimental)
    • Use this if you want to play around with the latest code and experiment. This branch is not guaranteed to be in a fully working state and there is absolutely no guarantee it will be compatible with the current state of mainnet or testnet.
  • Latest stable release : (Stable)
    • Use this if you want to run a NEAR node for mainnet. For mainnet, please use the latest stable release. This version is used by mainnet validators and other nodes and is fully compatible with the current state of mainnet.
  • Latest release candidates : (Release Candidates)
    • Use this if you want to run a NEAR node for tesnet. For testnet, we first release a RC version and then later make that release stable. For testnet, please run the latest RC version.

(Optional) Enable debug logging {#optional-enable-debug-logging}

Note: Feel free to skip this step unless you need more information to debug an issue.

To enable debug logging, run neard like this:

$ RUST_LOG=debug,actix_web=info ./target/release/neard --home ~/.near run

localnet {#localnet}

1. Clone nearcore project from GitHub {#1-clone-nearcore-project-from-github}

First, clone the nearcore repository.

$ git clone https://github.com/near/nearcore

Next, checkout the release branch you need if you will not be using the default master branch. [ More info ]

$ git checkout master

2. Compile nearcore binary {#2-compile-nearcore-binary}

In the repository run the following commands:

$ make neard

This will start the compilation process. It will take some time depending on your machine power (e.g. i9 8-core CPU, 32 GB RAM, SSD takes approximately 25 minutes). Note that compilation will need over 1 GB of memory per virtual core the machine has. If the build fails with processes being killed, you might want to try reducing number of parallel jobs, for example: CARGO_BUILD_JOBS=8 make neard.

By the way, if you’re familiar with Cargo, you could wonder why not run cargo build -p neard --release instead. While this will produce a binary, the result will be a less optimized version. On technical level, this is because building via make neard enables link-time optimisation which is disabled by default. The binary path is target/release/neard.

For localnet, you also have the option to build in nightly mode (which is experimental and is used for cutting-edge testing). When you compile, use the following command:

$ cargo build --package neard --features nightly_protocol,nightly_protocol_features --release

3. Initialize working directory {#3-initialize-working-directory}

The NEAR node requires a working directory with a couple of configuration files. Generate the initial required working directory by running:

$ ./target/release/neard --home ~/.near init --chain-id localnet

You can skip the --home argument if you are fine with the default working directory in ~/.near. If not, pass your preferred location.

This command will create the required directory structure and will generate config.json, node_key.json, validator_key.json, and genesis.json for localnet network.

  • config.json - Configuration parameters which are responsive for how the node will work.
  • genesis.json - A file with all the data the network started with at genesis. This contains initial accounts, contracts, access keys, and other records which represents the initial state of the blockchain.
  • node_key.json - A file which contains a public and private key for the node. Also includes an optional account_id parameter which is required to run a validator node (not covered in this doc).
  • data/ - A folder in which a NEAR node will write its state.
  • validator_key.json - A file which contains a public and private key for local test.near account which belongs to the only local network validator.

4. Run the node {#4-run-the-node}

To run your node, simply run the following command:

$ ./target/release/neard --home ~/.near run

That's all. The node is running you can see log outputs in your console.

testnet {#testnet}

1. Clone nearcore project from GitHub {#1-clone-nearcore-project-from-github-1}

First, clone the nearcore repository.

$ git clone https://github.com/near/nearcore
$ cd nearcore
$ git fetch origin --tags

Checkout to the branch you need if not master (default). Latest release is recommended. Please check the releases page on GitHub.

$ git checkout tags/1.26.1 -b mynode

2. Compile nearcore binary {#2-compile-nearcore-binary-1}

In the nearcore folder run the following commands:

$ make neard

This will start the compilation process. It will take some time depending on your machine power (e.g. i9 8-core CPU, 32 GB RAM, SSD takes approximately 25 minutes). Note that compilation will need over 1 GB of memory per virtual core the machine has. If the build fails with processes being killed, you might want to try reducing number of parallel jobs, for example: CARGO_BUILD_JOBS=8 make neard.

By the way, if you’re familiar with Cargo, you could wonder why not run cargo build -p neard --release instead. While this will produce a binary, the result will be a less optimized version. On technical level, this is because building via make neard enables link-time optimisation which is disabled by default.

The binary path is target/release/neard

3. Initialize working directory {#3-initialize-working-directory-1}

The NEAR node requires a working directory with a couple of configuration files. Generate the initial required working directory by running:

$ ./target/release/neard --home ~/.near init --chain-id testnet --download-genesis

You can specify trusted boot nodes that you'd like to use by pass in a flag during init: --boot-nodes ed25519:4k9csx6zMiXy4waUvRMPTkEtAS2RFKLVScocR5HwN53P@34.73.25.182:24567,ed25519:4keFArc3M4SE1debUQWi3F1jiuFZSWThgVuA2Ja2p3Jv@34.94.158.10:24567,ed25519:D2t1KTLJuwKDhbcD9tMXcXaydMNykA99Cedz7SkJkdj2@35.234.138.23:24567,ed25519:CAzhtaUPrxCuwJoFzceebiThD9wBofzqqEMCiupZ4M3E@34.94.177.51:24567

You can skip the --home argument if you are fine with the default working directory in ~/.near. If not, pass your preferred location.

This command will create the required directory structure and will generate config.json, node_key.json, and genesis.json for testnet network.

  • config.json - Configuration parameters which are responsive for how the node will work.
  • genesis.json - A file with all the data the network started with at genesis. This contains initial accounts, contracts, access keys, and other records which represents the initial state of the blockchain.
  • node_key.json - A file which contains a public and private key for the node. Also includes an optional account_id parameter which is required to run a validator node (not covered in this doc).
  • data/ - A folder in which a NEAR node will write it's state.

Heads up The genesis file for testnet is big (6GB +) so this command will be running for a while and no progress will be shown.

4. Replacing the config.json {#4-replacing-the-configjson}

From the generated config.json, there two parameters to modify:

  • boot_nodes: If you had not specify the boot nodes to use during init in Step 3, the generated config.json shows an empty array, so we will need to replace it with a full one specifying the boot nodes.
  • tracked_shards: In the generated config.json, this field is an empty empty. You will have to replace it to "tracked_shards": [0]

To replace the config.json, run the following commands:

$ rm ~/.near/config.json
$ wget -O ~/.near/config.json https://s3-us-west-1.amazonaws.com/build.nearprotocol.com/nearcore-deploy/testnet/config.json

5. Get data backup {#5-get-data-backup}

The node is ready to be started. However, you must first sync up with the network. This means your node needs to download all the headers and blocks that other nodes in the network already have.

$ aws s3 --no-sign-request cp s3://near-protocol-public/backups/testnet/rpc/latest .
$ LATEST=$(cat latest)
$ aws s3 --no-sign-request cp --no-sign-request --recursive s3://near-protocol-public/backups/testnet/rpc/$LATEST ~/.near/data

NOTE: The .tar file is around 147GB (and will grow) so make sure you have enough disk space to unpack inside the data folder.

6. Run the node {#6-run-the-node}

To start your node simply run the following command:

$ ./target/release/neard --home ~/.near run

That's all. The node is running you can see log outputs in your console. It will download a bit of missing data since the last backup was performed but it shouldn't take much time.

mainnet {#mainnet}

1. Clone nearcore project from GitHub {#1-clone-nearcore-project-from-github-2}

First, clone the nearcore repository.

$ git clone https://github.com/near/nearcore
$ cd nearcore
$ git fetch origin --tags

Next, checkout the release branch you need you will not be using the default master branch. Please check the releases page on GitHub for the latest release.

For more information on choosing between master and latest release branch [ click here ].

$ git checkout tags/1.26.1 -b mynode

2. Compile nearcore binary {#2-compile-nearcore-binary-2}

In the nearcore folder run the following commands:

$ make neard

This will start the compilation process. It will take some time depending on your machine power (e.g. i9 8-core CPU, 32 GB RAM, SSD takes approximately 25 minutes). Note that compilation will need over 1 GB of memory per virtual core the machine has. If the build fails with processes being killed, you might want to try reducing number of parallel jobs, for example: CARGO_BUILD_JOBS=8 make neard.

By the way, if you’re familiar with Cargo, you could wonder why not run cargo build -p neard --release instead. While this will produce a binary, the result will be a less optimized version. On technical level, this is because building via make neard enables link-time optimisation which is disabled by default.

The binary path is target/release/neard

3. Initialize working directory {#3-initialize-working-directory-2}

In order to work NEAR node requires to have working directory and a couple of configuration files. Generate the initial required working directory by running:

$ ./target/release/neard --home ~/.near init --chain-id mainnet

You can specify trusted boot nodes that you'd like to use by pass in a flag during init: --boot-nodes ed25519:86EtEy7epneKyrcJwSWP7zsisTkfDRH5CFVszt4qiQYw@35.195.32.249:24567,ed25519:BFB78VTDBBfCY4jCP99zWxhXUcFAZqR22oSx2KEr8UM1@35.229.222.235:24567,ed25519:Cw1YyiX9cybvz3yZcbYdG7oDV6D7Eihdfc8eM1e1KKoh@35.195.27.104:24567,ed25519:33g3PZRdDvzdRpRpFRZLyscJdbMxUA3j3Rf2ktSYwwF8@34.94.132.112:24567,ed25519:CDQFcD9bHUWdc31rDfRi4ZrJczxg8derCzybcac142tK@35.196.209.192:24567

You can skip the --home argument if you are fine with the default working directory in ~/.near. If not, pass your preferred location.

This command will create the required directory structure by generating a config.json, node_key.json, and downloads a genesis.json for mainnet.

  • config.json - Configuration parameters which are responsive for how the node will work.
  • genesis.json - A file with all the data the network started with at genesis. This contains initial accounts, contracts, access keys, and other records which represents the initial state of the blockchain.
  • node_key.json - A file which contains a public and private key for the node. Also includes an optional account_id parameter which is required to run a validator node (not covered in this doc).
  • data/ - A folder in which a NEAR node will write it's state.

4. Replacing the config.json {#4-replacing-the-configjson-1}

From the generated config.json, there two parameters to modify:

  • boot_nodes: If you had not specify the boot nodes to use during init in Step 3, the generated config.json shows an empty array, so we will need to replace it with a full one specifying the boot nodes.
  • tracked_shards: In the generated config.json, this field is an empty empty. You will have to replace it to "tracked_shards": [0]

To replace the config.json, run the following commands:

$ rm ~/.near/config.json
$ wget -O ~/.near/config.json https://s3-us-west-1.amazonaws.com/build.nearprotocol.com/nearcore-deploy/mainnet/config.json

If you are setting up a backup Mainnet Validator node, please make sure its config.json is set up correctly as described in Step 3 and 4.

5. Get data backup {#5-get-data-backup-1}

The node is ready to be started. However, you must first sync up with the network. This means your node needs to download all the headers and blocks that other nodes in the network already have.

$ aws s3 --no-sign-request cp s3://near-protocol-public/backups/mainnet/rpc/latest .
$ LATEST=$(cat latest)
$ aws s3 --no-sign-request cp --no-sign-request --recursive s3://near-protocol-public/backups/mainnet/rpc/$LATEST ~/.near/data

NOTE: The .tar file is ~125GB (and will grow) so make sure you have enough disk space to unpack inside the data folder.

6. Run the node {#6-run-the-node-1}

To start your node simply run the following command:

$ ./target/release/neard --home ~/.near run

That's all. The node is running and you can see log outputs in your console. It will download a bit of missing data since the last backup was performed but it shouldn't take much time.

Got a question?

Ask it on StackOverflow!