# Running a Consensus Node ## System Requirement If you're planning to run a consensus miner, it's important to make sure your system meets the recommended requirements to ensure that your miner performs at its best. | Resource | Specification | | -------------------- | --------------------------- | | Recommended OS | Ubuntu\_x64 20.04 or higher | | CPU Processor Num | ≥ 4 | | Memory | ≥ 16 GB | | Bandwidth | ≥ 5 Mbps | | Public Network IP | required | | Linux Kernel Version | 5.11 or higher | ## Prepare Stash Account * **Stash Account**: This is the account where you keep all the funds you want to stake. This account requires at least 3,000,000 TCESS for staking it can be either from the node owner itself or delegated by other users. You can also refer to the page [Creating CESS Accounts](https://doc.cess.network/user/cess-account) for creating a CESS account. You can either use [CESS premainnet faucet](https://cess.network/faucet.html) to get TCESS, or [contact us](https://doc.cess.network/readme/contact) to receive TCESS tokens for staking. ## Binding Funds to Stash Account Open [CESS Explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ft2-rpc.cess.network%2Fws%2F#/) and Select **Network** > **Staking** > **Accounts** > **Stash** ![Add a Stash](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-2ed78ffc5672968777bba9ed8f616ec53adcd26d%2Fconsensus-pic1.png?alt=media) Select the appropriate `stash account` from the drop-down menu and enter at least **3,000,000** TCESS in `value bounded` field. In `payment destination`, select **Stash Account as the reward receiving account (do not increase the amount at stake)**, which means that mining income will not be automatically added to the stake. ![Bond Fund](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-7ff72ce1f734a7138cf0e0f949ff9dba4a7e2dea%2Fconsensus-pic2.png?alt=media) Click **Bond** -> **Sign and Submit** to link the Stash Account. ![Sign and Submit](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-ba81f1fa5f9021efe21ea74374310da774811a19%2Fconsensus-pic3.png?alt=media) Fund is bonded successfully! ![Bonded Fund Successfully](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-b65452790233d57483d0655b3d6de028a036c0a3%2Fconsensus-pic4.png?alt=media) ## Run a chain node ### Run with nodeadm #### Install nodeadm {% hint style="info" %} Please purge all of previous data before running a CESS consensus node on machine if an old version consensus node was installed. {% endhint %} ```bash cess purge cess uninstall ``` The `cess-nodeadm` is a CESS node deployment and management tool. It helps to deploy and manage storage nodes, consensus nodes, and rpc node, simplifying the devOps for all CESS miners. ```bash wget https://github.com/CESSProject/cess-nodeadm/archive/refs/tags/v0.7.0.tar.gz tar -xvf v0.7.0.tar.gz cd cess-nodeadm-0.7.0 sudo ./install.sh ``` {% hint style="info" %} You can verify that you are running the latest version of [cess-nodeadm here](https://github.com/CESSProject/cess-nodeadm/releases). {% endhint %} On successful installation of cess-nodeadm you will see `Install cess nodeadm success` message. If the installation fails, please check the [troubleshooting procedures](https://doc.cess.network/cess-miners/storage-miner/troubleshooting). #### Configure nodeadm Please run the following command to configure nodeadm. * set mode with `validator` * set a custom node name `cess` or any other name of your choice. ```bash $ cess config set Enter cess node mode from 'tee/storage/validator/rpcnode' (current: validator, press enter to skip): validator Enter cess node name (current: cess, press enter to skip): cess Set configurations successfully Start generate configurations and docker compose file debug: Loading config file: config.yaml info: Generating configurations done info: Generating docker compose file done e9e3df60a011799587e59f73e22db60d95c2ec7eebfe3058c358ed2d7c6d04a0 Configurations generated at: /opt/cess/nodeadm/build $ cess start [+] Running 3/3 ✔ Container chain Started ✔ Container watchtower Started ``` ### Run with container 1. Environment Setup Requirements ```shell curl -fsSL https://get.docker.com | bash docker --version docker pull cesslab/cess-chain:premainnet ``` 2. Running Command **Make sure that port 30336 and 9944 are not occupied by other processes.** ```bash mkdir -p /opt/cess/validator docker run --rm -v /opt/cess/validator:/opt/cess/data cesslab/cess-chain:premainnet key generate-node-key --base-path /opt/cess/data --chain cess-premainnet >/dev/null 2>&1 docker run -d \ --name premainnet-rpc \ -v /opt/cess/validator:/opt/cess/data \ -p 30336:30336 \ -p 9944:9944 \ cesslab/cess-chain:premainnet \ --base-path /opt/cess/data \ --chain cess-premainnet \ --port 30336 \ --rpc-port 9944 \ --rpc-external \ --execution WASM \ --wasm-execution compiled \ --in-peers 75 \ --out-peers 75 \ --state-pruning archive \ --validator \ --max-runtime-instances 32 \ --rpc-cors all \ --prometheus-external \ --rpc-methods unsafe ``` ### Run with systemd #### Download source files **Get the latest `release` from** [**Github**](https://github.com/CESSProject/cess/releases) ```bash mkidr -p /opt/cess/validator cd /opt/cess/validator wget https://github.com/CESSProject/cess/releases/download/cess-v0.8.0-premainnet/cess-node-v0.10.0-ubuntu22 -O cess-node ``` **Get the source files from a local container** ```bash rm -rf /opt/cess/chain-tmp && mkdir -p /opt/cess/chain-tmp docker pull cesslab/cess-chain:premainnet docker run -d --name chain-tmp -p 30337:30336 -p 9945:9944 -v /opt/cess/chain-tmp:/opt/cess/data cesslab/cess-chain:premainnet --base-path /opt/cess/data --chain cess-premainnet --port 30336 --name cess --rpc-port 9944 --rpc-external --execution WASM --wasm-execution compiled --in-peers 75 --out-peers 75 --state-pruning archive --rpc-cors all --prometheus-external docker cp chain-tmp:/opt/cess/cess-node /opt/cess/validator/cess-node docker stop chain-tmp && docker rm chain-tmp ``` #### Run as systemd service ```bash mkdir -p /opt/cess/validator /opt/cess/validator/cess-node key generate-node-key --base-path /opt/cess/validator --chain cess-premainnet >/dev/null 2>&1 cat > /lib/systemd/system/validator.service << EOF [Unit] Description=CESS-PREMAINNET-Validator After=network.target [Service] Type=simple User=root ExecStart=/opt/cess/validator/cess-node --base-path /opt/cess/validator --chain cess-premainnet --port 30336 --rpc-port 9944 --prometheus-external --name cess-premainnet --validator --max-runtime-instances 32 --state-pruning archive --rpc-methods unsafe WorkingDirectory=/opt/cess/validator StandardOutput=append:/opt/cess/validator/validator.log StandardError=append:/opt/cess/validator/validator.log Restart=on-failure [Install] WantedBy=multi-user.target EOF systemctl enable logrotate.timer systemctl restart logrotate.timer cat > /etc/logrotate.d/validator << EOF /opt/cess/validator/validator.log { daily rotate 7 missingok notifempty compress delaycompress copytruncate create 0644 root root } EOF sudo logrotate -d /opt/cess/validator/validator.log systemctl enable validator systemctl restart validator systemctl status validator tail -f /opt/cess/validator/validator.log ``` *** {% hint style="warning" %} consensus node(validator) is one of the most important part in cess network, it is recommended to set alert for consensus node to ensure that the service is always online. {% endhint %} ## Become a Validator 1. Start the chain node Make sure that the chain node is running normally before proceeding. ```bash $ ps -efww | grep cess-node ``` 2. Generate a session key ```bash # generate by nodeadm cess tools rotate-keys # generate by docker docker exec chain curl -H 'Content-Type: application/json' -d '{"id":1, "jsonrpc":"2.0", "method": "author_rotateKeys", "params":[]}' http://localhost:9944 2>/dev/null # generate by http request curl -H 'Content-Type: application/json' -d '{"id":1, "jsonrpc":"2.0", "method": "author_rotateKeys", "params":[]}' http://localhost:9944 2>/dev/null ``` ![rotate-keys Output Example](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-282405672527d7898b549ff0af77e1a74b29b3c2%2Frotate-keys.png?alt=media) 3. Set up a session key Navigate to [CESS Explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ft2-rpc.cess.network%2Fws%2F#/), choose **Network** > **Staking** > **Accounts** > **Session Key** ![Session Key 01](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-32ce0ea5c6c78cb9747c42e79dbab6f5fb5b4f86%2Fsession-key-01.png?alt=media) Fill in the **Session Key** in the red box ![Session Key 02](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-4ae03219e8c5f5c6219450faa65ed3e2c38c5112%2Fsession-key-02.png?alt=media) Click **Sign and Submit** ![Session Key 03](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-a567720374a38bc261fa98e7814029d85b5e233c%2Fsession-key-03.png?alt=media) 4. Becoming a validator Navigate to [CESS Explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ft2-rpc.cess.network%2Fws%2F#/), click **Network** > **Staking** > **Accounts** > **Validate** ![Validator 01](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-0f7a99fb296b4d264579d3b70bb8bbf0a4e0e294%2Fvalidator-01.webp?alt=media) ![Validator 02](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-d05c713b4e6353fb7be081c8b27c3f448a3c1a6e%2Fvalidator-02.png?alt=media) Enter **100** in *reward commission percentage*, indicating that the reward will not be distributed to others. Select **No, block all nominations** in *allows new nominations* dropdown, indicating that no nominations will be accepted. Again, click **Sign and Submit**. ![Validator 03](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-4f11ebe63db23881cf7025e8acb550e5086f8fe7%2Fvalidator-03.png?alt=media) After completing the steps above, open the [CESS Explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ft2-rpc.cess.network%2Fws%2F#/) and click **Network** > **Staking** > **Waiting**. ![Validator 04](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-bb3eac6c792607ef2046042c84a3b5989ff82d89%2Fvalidator-04.webp?alt=media) You should see that the node has already appeared on the candidate node list. ### Redeeming Rewards Navigate to CESS Explorer: **Network** > **Staking** > **Payouts** > **Payout**. ![Redemption: First Step](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-f9665601ff86e5ec0bf6a8e375ff177589a13f3a%2Fredemption-01.png?alt=media) In Payouts, click **Payout** to initiate a payment. Any account can initiate a payment. ![Redemption: Second Step](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-98450b3f9556d2ea6c2cf5f1a4e000d2d7e8c409%2Fredemption-02.png?alt=media) {% hint style="info" %} Please claim the reward within 84 era (each era of the test network is 6 hours), which is 21 days. Those who hasn't claimed the reward in this period will not be able to claim it. {% endhint %} ### Exiting Consensus from Validation 1. Stop the Consensus In [CESS Explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ft2-rpc.cess.network%2Fws%2F#/), navigate to: **Network > Staking > Account Actions > Stop**. ![Exiting-01](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-63d261fe7bd57f82b8d3f9ac19bb7d974efd3821%2Fexiting-01.png?alt=media) 2. Clear Session Keys In [CESS Explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ft2-rpc.cess.network%2Fws%2F#/), navigate to: **Developer -> Submission** ![Exiting-02](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-aa414ca4ead65a50a02416b4e1bbf9b9c392ba7e%2Fexiting-02.png?alt=media) Enter controller account in *using the selected account controller*. Then in *submit the following extrinsic*, enter **session** and choose **purgeKeys()** in the box next to it. ![Exiting-03](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-5edd914d0ddfa3b31e30470a43e69a04bd14b9e0%2Fexiting-03.png?alt=media) Click **Submit Transaction** button to clear session keys ![Exiting-04](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-be861a8a7c72a85eb1f3f9f12927079228e94390%2Fexiting-04.png?alt=media) ### Redeeming Stake 1. Unbond fund After 28 eras (each era of the test network is 6 hours), goto [CESS Explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ft2-rpc.cess.network%2Fws%2F#/), navigate to: **Network > Staking > Account Actions > Unbond Funds**. ![Staking 01](https://2951078474-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FFWgzFJTgbmbm8iaxYNRS%2Fuploads%2Fgit-blob-191f816741d0e97658e48b80faeabcc7d3d50f5b%2Fstaking-01.png?alt=media) 2. Stop the CESS client ```bash cess stop ``` ## Upgrade CESS Nodeadm Client ### Stop and Remove All Services ```bash cess stop cess down ``` ### Remove All Chain Data {% hint style="warning" %} Do not perform this operation unless the CESS network has been redeployed, and it is confirmed that the data can be cleared. {% endhint %} ```bash cess purge ``` ### Update `cess-nodeadm` ```bash wget https://github.com/CESSProject/cess-nodeadm/archive/refs/tags/.tar.gz tar -xvf .tar.gz cd cess-nodeadm- ./install.sh --skip-dep --retain-config --no-rmi ``` ### Pull Images ```bash cess pullimg ```