New guide for validator by DDeAlmeida · Pull Request #118 · near/node-docs

DDeAlmeida · 2025-02-05T23:36:47Z

No description provided.

Add How to get notify

Update guide.md

doc: epoch sync

DDeAlmeida · 2025-02-21T09:23:09Z

@walnut-the-cat
@staffik
@ilblackdragon
Please approve the new Validator Guide

Add Config.json link for Mainnet - Validator

staffik

Thanks @DDeAlmeida!
The content looks good, but the formatting needs improvement.

staffik · 2025-02-24T15:09:27Z

docs/validator/guide.md

+
+During the building time, let's make a wallet.
+
+We recommand to use a partner wallet like Meteor, MyNearWallet or SenderWallet.  


staffik · 2025-02-24T15:10:00Z

docs/validator/guide.md

+
+https://wallet.meteorwallet.app/
+
+![](file:///C:/Users/ddealmeida/Downloads/wallet_creation.png)  


local path, here and in other places

staffik · 2025-02-24T15:11:32Z

docs/validator/guide.md

+
+#### Wallet Authorization  
+
+A full access key needs to be installed locally to be able transactions via NEAR-CLI.


"to be able to send transactions"

staffik · 2025-02-24T15:20:29Z

docs/validator/guide.md

+near contract call-function as-transaction pool-details.near update_field json-args '{"pool_id": "<full_pool_id>", "name": "name", "value": "PandaPool"}' prepaid-gas '100.0 Tgas' attached-deposit '0 NEAR' sign-as <accountId> network-config mainnet sign-with-keychain
+near contract call-function as-transaction pool-details.near update_field json-args '{"pool_id": "<full_pool_id>", "name": "description", "value": "PandaPool Description"}' prepaid-gas '100.0 Tgas' attached-deposit '0 NEAR' sign-as <accountId> network-config mainnet sign-with-keychain


please format as code, here and below

staffik · 2025-02-24T15:21:28Z

docs/validator/guide.md

+You can use:
+Discord: https://discord.gg/nearprotocol
+Telegram: https://t.me/near_validators
+X: https://x.com/NEARChainStatus (Only Mainnet)
+Email : https://near.us14.list-manage.com/subscribe?u=faedf5dec8739fb92e05b4131&id=befd133f18 


When rendered, it is all in one line

staffik · 2025-02-24T15:22:12Z

docs/validator/guide.md

+
+Make sure the config file have store.load_mem_tries_for_tracked_shards with true value
+
+#### Usefull links: 


Review from Adam

Update images

Review from Adam

staffik

@DDeAlmeida I changed the formatting, PTAL.

docs/validator/guide.md

VanBarbascu

@DDeAlmeida, thanks for taking the time to update the docs!
I left a couple of suggestions. Please take a look

VanBarbascu · 2025-03-10T11:42:48Z

docs/validator/guide.md

+curl -s -X POST https://rpc.mainnet.near.org -H "Content-Type: application/json" -d '{
+        "jsonrpc": "2.0",
+        "method": "network_info",
+        "params": [],
+        "id": "dontcare"
+      }' | \
+jq --arg newBootNodes "$(curl -s -X POST https://rpc.mainnet.near.org -H "Content-Type: application/json" -d '{
+        "jsonrpc": "2.0",
+        "method": "network_info",
+        "params": [],
+        "id": "dontcare"
+      }' | jq -r '.result.active_peers as $list1 | .result.known_producers as $list2 |
+          $list1[] as $active_peer | $list2[] |
+          select(.peer_id == $active_peer.id) |
+          "\(.peer_id)@\($active_peer.addr)"' | paste -sd "," -)" \
+   '.network.boot_nodes = $newBootNodes' ~/.near/config.json > ~/.near/config.tmp && mv ~/.near/config.json ~/.near/config.json.backup && mv ~/.near/config.tmp ~/.near/config.json


There are a couple of redundant commands there. It is cleaner this way:

Suggested change

curl -s -X POST https://rpc.mainnet.near.org -H "Content-Type: application/json" -d '{

"jsonrpc": "2.0",

"method": "network_info",

"params": [],

"id": "dontcare"

}' | \

jq --arg newBootNodes "$(curl -s -X POST https://rpc.mainnet.near.org -H "Content-Type: application/json" -d '{

"jsonrpc": "2.0",

"method": "network_info",

"params": [],

"id": "dontcare"

}' | jq -r '.result.active_peers as $list1 | .result.known_producers as $list2 |

$list1[] as $active_peer | $list2[] |

select(.peer_id == $active_peer.id) |

"\(.peer_id)@\($active_peer.addr)"' | paste -sd "," -)" \

'.network.boot_nodes = $newBootNodes' ~/.near/config.json > ~/.near/config.tmp && mv ~/.near/config.json ~/.near/config.json.backup && mv ~/.near/config.tmp ~/.near/config.json

BOOT_NODES=$(curl -s -X POST https://rpc.mainnet.near.org -H "Content-Type: application/json" -d '{

"jsonrpc": "2.0",

"method": "network_info",

"params": [],

"id": "dontcare"

}' | jq -r '.result.active_peers as $list1 | .result.known_producers as $list2 |

$list1[] as $active_peer | $list2[] |

select(.peer_id == $active_peer.id) |

"\(.peer_id)@\($active_peer.addr)"' | paste -sd "," -)

jq --arg newBootNodes $BOOT_NODES '.network.boot_nodes = $newBootNodes' ~/.near/config.json > ~/.near/config.tmp && mv ~/.near/config.json ~/.near/config.json.backup && mv ~/.near/config.tmp ~/.near/config.json

VanBarbascu · 2025-03-10T11:55:55Z

docs/validator/guide.md

+- `<accountId>` or `accountId` – `xxx.near`, where `xxx` is your account name, for example `validator_near.near`.
+
+```sh
+cd ~/nearcore && target/release/neard init --chain-id="mainnet" --account-id=<full_pool_id>


Add these lines here to download the latest config.json and to configure the boot nodes to facilitate the epoch sync.

Suggested change

cd ~/nearcore && target/release/neard init --chain-id="mainnet" --account-id=<full_pool_id>

# You can use any RPC provider for this command.

BOOT_NODES=$(curl -s -X POST https://rpc.mainnet.near.org -H "Content-Type: application/json" -d '{

"jsonrpc": "2.0",

"method": "network_info",

"params": [],

"id": "dontcare"

}' | jq -r '.result.active_peers as $list1 | .result.known_producers as $list2 |

$list1[] as $active_peer | $list2[] |

select(.peer_id == $active_peer.id) |

"\(.peer_id)@\($active_peer.addr)"' | paste -sd "," -)

cd ~/nearcore && target/release/neard init --chain-id="mainnet" --account-id=<full_pool_id> --download-genesis --download-config validator --boot-nodes $BOOT_NODES

VanBarbascu · 2025-03-10T11:57:29Z

docs/validator/guide.md

+
+#### Update `config.json` to activate the validator config
+```sh
+sed -i 's/"tracked_shards": \[\s*0\s*\]/"tracked_shards": []/' ~/.near/config.json


Keep it consistent and use jq for any amendments to the config.json files. This is because the tracked_shards may not be in the config.json file. Also, this commands assumes the previous value of the field, which may not be '[0]' all the time.

If the user follows the init command that I suggested above, the config is already dedicated to the validator node so there is no need to overwrite it.

VanBarbascu · 2025-03-10T12:02:04Z

docs/validator/guide.md

+
+[Service]
+Type=simple
+User=root


Do encourage operation of any service under the root user. Leave a comment here to change User to a dedicated one.

If you don't want to change this Service, add a warning at the top of it about the risk of running services as root.
I cannot start to enumerate the disadvantages. There are both operational and security implications.
If the user opts for a dedicated vm/docker for this service, there are still some security concerns.

VanBarbascu · 2025-03-10T12:15:47Z

docs/validator/guide.md

+
+Now you only need to have enough token staked to start earning Rewards.  
+
+#### Network optimizations


Move/reference this in the node startup instructions.

docs/validator/guide.md

Co-authored-by: Razvan Barbascu <r.barbascu@gmail.com>

DDeAlmeida · 2025-03-27T15:06:43Z

@VanBarbascu doc updated

VanBarbascu

Great stuff! Please address these 2 commens and we are good to go.

docs/validator/guide.md

VanBarbascu

I committed those changes as they were quite trivial.

DDeAlmeida · 2025-04-03T06:51:56Z

I committed those changes as they were quite trivial.

Thank, i was going this right now ;)

DDeAlmeida added 4 commits February 3, 2025 16:58

Added Guide

c691921

Update guide.md

39c6d25

Update guide.md

cd224af

Update guide.md

d1b1e5b

DDeAlmeida requested a review from bowenwang1996 as a code owner February 5, 2025 23:36

staffik and others added 12 commits February 10, 2025 18:06

doc

50b7851

Update guide.md

d8eb9c7

separate things

21f66b1

Update guide.md

09d1805

rework

24d017a

Update guide.md

ab39bf2

Add How to get notify

Update guide.md

cbdb163

Merge pull request #2 from walnut-the-cat/walnut-the-cat-patch-1

a6d181f

Update guide.md

Merge branch 'near:main' into main

d3e48f4

nit

dba2411

Merge pull request #1 from staffik/epoch-sync

6cb4ed2

doc: epoch sync

Merge branch 'near:main' into main

0637d0f

Update guide.md

e898e6f

Add Config.json link for Mainnet - Validator

staffik reviewed Feb 24, 2025

View reviewed changes

DDeAlmeida and others added 5 commits February 24, 2025 16:32

Update guide.md

0cb094f

Review from Adam

Update guide.md

14a178b

Update images

Update guide.md

f0d1c12

Review from Adam

Update guide.md

86784d3

fmt

aca7bf5

staffik reviewed Feb 26, 2025

View reviewed changes

docs/validator/guide.md Outdated Show resolved Hide resolved

VanBarbascu requested changes Mar 10, 2025

View reviewed changes

DDeAlmeida and others added 2 commits March 14, 2025 08:51

Apply suggestions from code review

3ad0621

Co-authored-by: Razvan Barbascu <r.barbascu@gmail.com>

Update due to suggestion

7044bab

VanBarbascu requested changes Apr 2, 2025

View reviewed changes

docs/validator/guide.md Outdated Show resolved Hide resolved

docs/validator/guide.md Outdated Show resolved Hide resolved

VanBarbascu added 2 commits April 2, 2025 22:46

Fix comment.

ce8a7a2

FIx script

bcf3f77

VanBarbascu approved these changes Apr 2, 2025

View reviewed changes

build fix

26f8f7f

staffik merged commit 3ffc804 into near:main Apr 3, 2025
2 checks passed


		During the building time, let's make a wallet.

		We recommand to use a partner wallet like Meteor, MyNearWallet or SenderWallet.


		https://wallet.meteorwallet.app/

		![](file:///C:/Users/ddealmeida/Downloads/wallet_creation.png)


		#### Wallet Authorization

		A full access key needs to be installed locally to be able transactions via NEAR-CLI.

		near contract call-function as-transaction pool-details.near update_field json-args '{"pool_id": "<full_pool_id>", "name": "name", "value": "PandaPool"}' prepaid-gas '100.0 Tgas' attached-deposit '0 NEAR' sign-as <accountId> network-config mainnet sign-with-keychain
		near contract call-function as-transaction pool-details.near update_field json-args '{"pool_id": "<full_pool_id>", "name": "description", "value": "PandaPool Description"}' prepaid-gas '100.0 Tgas' attached-deposit '0 NEAR' sign-as <accountId> network-config mainnet sign-with-keychain


		Make sure the config file have store.load_mem_tries_for_tracked_shards with true value

		#### Usefull links:


		Now you only need to have enough token staked to start earning Rewards.

		#### Network optimizations

Conversation

DDeAlmeida commented Feb 5, 2025

Uh oh!

DDeAlmeida commented Feb 21, 2025

Uh oh!

staffik left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

staffik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

VanBarbascu left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

DDeAlmeida commented Mar 27, 2025

Uh oh!

VanBarbascu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

VanBarbascu left a comment

Choose a reason for hiding this comment

Uh oh!

DDeAlmeida commented Apr 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants