Skip to content

Commit

Permalink
fix the dead links in node docs (#96)
Browse files Browse the repository at this point in the history
* Update validator-bootcamp.md

* Update staking-and-delegation.md

* Update keys.md

* Update run-rpc-node-without-nearup.md

* Update state-sync.md

* Update snapshots.md

* Update mlc_config.json
  • Loading branch information
bucanero authored May 6, 2024
1 parent 83ca152 commit 9a1cf98
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 18 deletions.
10 changes: 5 additions & 5 deletions docs/intro/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Yes, but only in that keys can be _reset_ (ie. regenerated as a new key pair). I
<blockquote class="info">
<strong>Did you know?</strong><br /><br />

As a brief word on the NEAR runtime, the subsystem that manages state transitions on the blockchain (ie. keeping things moving from one block to the next), it's worth understanding that the movement of the system happens in stages, called epochs, during which the group of validators does not change. The [Nightshade whitepaper](https://near.org/downloads/Nightshade.pdf) introduces epochs this way: "the maintenance of the network is done in epochs, where an epoch is a period of time on the order of days." and there's much more detail in the paper.
As a brief word on the NEAR runtime, the subsystem that manages state transitions on the blockchain (ie. keeping things moving from one block to the next), it's worth understanding that the movement of the system happens in stages, called epochs, during which the group of validators does not change. The [Nightshade whitepaper](https://near.org/papers/nightshade) introduces epochs this way: "the maintenance of the network is done in epochs, where an epoch is a period of time on the order of days." and there's much more detail in the paper.

At the beginning of each epoch, some computation produces a list of validators for the very next epoch (not the one that just started). The input to this computation includes all validators that have "raised their hand" to be a validator by staking some amount over the system's staking threshold. The output of this computation is a list of the validators for the very next epoch.

Expand All @@ -57,12 +57,12 @@ If validator keys are changed _during an epoch in which the validator is staking
For concrete examples of keys being used as identifiers, you can see a list of validators and active nodes on various NEAR networks here:

- NEAR testnet (staking currently disabled)
- https://rpc.testnet.near.org/status
- https://rpc.testnet.near.org/network_info
- `https://rpc.testnet.near.org/status`
- `https://rpc.testnet.near.org/network_info`

- NEAR betanet
- https://rpc.betanet.near.org/status
- https://rpc.betanet.near.org/network_info
- `https://rpc.betanet.near.org/status`
- `https://rpc.betanet.near.org/network_info`

>Got a question?
<a href="https://stackoverflow.com/questions/tagged/nearprotocol">
Expand Down
8 changes: 4 additions & 4 deletions docs/intro/snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Here are the available snapshots directories based on node type and network. Ple

| Node Type and Network| S3 Path |
| -------------------- | ------------------------------------------------------------------------ |
| RPC testnet | https://dcf58hz8pnro2.cloudfront.net/backups/testnet/rpc/latest |
| RPC mainnet | https://dcf58hz8pnro2.cloudfront.net/backups/mainnet/rpc/latest |
| Archival testnet | https://dcf58hz8pnro2.cloudfront.net/backups/testnet/archive/latest |
| Archival mainnet | https://dcf58hz8pnro2.cloudfront.net/backups/mainnet/archive/latest |
| RPC testnet | `https://dcf58hz8pnro2.cloudfront.net/backups/testnet/rpc/latest` |
| RPC mainnet | `https://dcf58hz8pnro2.cloudfront.net/backups/mainnet/rpc/latest` |
| Archival testnet | `https://dcf58hz8pnro2.cloudfront.net/backups/testnet/archive/latest` |
| Archival mainnet | `https://dcf58hz8pnro2.cloudfront.net/backups/mainnet/archive/latest` |

----
Prerequisite:
Expand Down
2 changes: 1 addition & 1 deletion docs/rpc/run-rpc-node-without-nearup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Running a RPC node is very similar to running a [validator node](/validator/runn

## Prerequisites

- [Rust](https://www.rust-lang.org/). If not already installed, please [follow these instructions](https://docs.near.org/develop/prerequisites).
- [Rust](https://www.rust-lang.org/). If not already installed, please [follow these instructions](https://doc.rust-lang.org/book/ch01-01-installation.html).
- [Git](https://git-scm.com/)
- Installed developer tools:
- MacOS
Expand Down
2 changes: 1 addition & 1 deletion docs/rpc/state-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ If you notice that your node runs state sync and it hasn't completed after 3 hou
* `archive`
* `block_fetch_horizon`

The best way to see the exact config values used is to visit a debug page of your node: http://127.0.0.1:3030/debug/client_config
The best way to see the exact config values used is to visit a debug page of your node: `http://127.0.0.1:3030/debug/client_config`

Check whether state sync is enabled, and check whether it's configured to get state parts from the right location mentioned above.

Expand Down
7 changes: 4 additions & 3 deletions docs/validator/staking-and-delegation.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ near stake <accountId> <publicKey> --amount 0

# Delegation on NEAR

## How does delegating staking works?
NEAR token holders are encouraged to earn reward by delegate their tokens. By staking your NEAR tokens, you help to secure the network and earn rewards. When you delegate your tokens, you are depositing and staking your token with a specific staking pool that has been deployed by a validator.
## How does delegating staking work?

NEAR token holders are encouraged to earn rewards by delegating their tokens. By staking your NEAR tokens, you help to secure the network and earn rewards. When you delegate your tokens, you are depositing and staking your token with a specific staking pool that has been deployed by a validator.

## How to choose your validator(s)?
A list of available pools for delegation (one per validator) is available on the [Explorer Validator](https://explorer.near.org/nodes/validators) page. Delegators should review validators' performance and commission charged to decide how best to delegate.
Expand All @@ -56,7 +57,7 @@ Delegators may use the [NEAR wallet](https://wallet.near.org/) or the [NEAR CLI]

For delegators, who would like to delegate using the NEAR wallet, please create your `mainnet` wallet:
- Go to [wallet.near.org](https://wallet.near.org/) and create an account.
- Navigate to the [staking](https://wallet.near.org/staking) tab to select an available staking pool to delegate your tokens.
- Navigate to the [staking](https://app.mynearwallet.com/staking) tab to select an available staking pool to delegate your tokens.


## Delegate with the NEAR CLI
Expand Down
7 changes: 3 additions & 4 deletions docs/validator/validator-bootcamp.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: NEAR Validator Bootcamp

***What’s the current protocol upgrade that will increase the number of validators on Mainnet?***

The next upgrade to increase the number of mainnet validators will introduce Chunk-Only Producers, and is currently slated for Q3 2022. To find out more about how to become a Chunk-Only Producer, please head to https://near.org/decentralize/ and register.
The next upgrade to increase the number of mainnet validators will introduce Chunk-Only Producers, and is currently slated for Q3 2022.

***How do I join NEAR as a validator on the Mainnet? What steps do I need to take?***

Expand Down Expand Up @@ -1504,9 +1504,8 @@ INFO stats: #42376888 Waiting for peers 0/0/40 peers ⬇ 0 B/s ⬆ 0 B/s 0.00 bp

**Resolution**
Download the latest config.json file and restart:
- For Guildnet: https://s3.us-east-2.amazonaws.com/build.openshards.io/nearcore-deploy/guildnet/config.json
- For Testnet: https://s3-us-west-1.amazonaws.com/build.nearprotocol.com/nearcore-deploy/testnet/config.json
- For Mainnet: https://s3-us-west-1.amazonaws.com/build.nearprotocol.com/nearcore-deploy/mainnet/config.json
- For Testnet: `https://s3-us-west-1.amazonaws.com/build.nearprotocol.com/nearcore-deploy/testnet/config.json`
- For Mainnet: `https://s3-us-west-1.amazonaws.com/build.nearprotocol.com/nearcore-deploy/mainnet/config.json`


## LESSON 7 - NODE FAILOVER
Expand Down
3 changes: 3 additions & 0 deletions website/mlc_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
{
"pattern": "^https://near-node.zendesk.com"
},
{
"pattern": "^https://twitter.com"
},
{
"pattern": "^https://rpc.betanet.near.org"
}
Expand Down

0 comments on commit 9a1cf98

Please sign in to comment.