From 793c013edb0824dfdcb7bb72277ca65a1b48f01e Mon Sep 17 00:00:00 2001 From: MSalopek Date: Mon, 14 Oct 2024 17:41:54 +0200 Subject: [PATCH] docs: update validators; remove expired links (#3391) * docs: update broken links (use relative path) * docs: update broken links and outdated links --- .../docs/architecture/adr/adr-002-globalfee.md | 4 ++-- docs/docs/delegators/delegator-faq.md | 2 +- docs/docs/delegators/delegator-guide-cli.md | 2 +- docs/docs/hub-tutorials/upgrade-node.md | 2 +- docs/docs/index.md | 5 ++--- docs/docs/validators/validator-faq.md | 4 ++-- docs/docs/validators/validator-setup.md | 18 +++++++++--------- 7 files changed, 18 insertions(+), 19 deletions(-) diff --git a/docs/docs/architecture/adr/adr-002-globalfee.md b/docs/docs/architecture/adr/adr-002-globalfee.md index 61e6a7d5dc6..bf55b38daf1 100644 --- a/docs/docs/architecture/adr/adr-002-globalfee.md +++ b/docs/docs/architecture/adr/adr-002-globalfee.md @@ -1,4 +1,4 @@ -# ADR 002: Globalfee Module +# ADR 002: Globalfee Module [DEPRECATED] ## Changelog * 2023-06-12: Initial Draft @@ -127,7 +127,7 @@ Please note that `feeCoins` does not contain zero coins. The fee coins are split ### Fee Checks in `DeliverTx` Implementing fee checks within the `DeliverTx` function introduces a few requirements: -- **Deterministic Minimum Fee Requirement**: For the `DeliverTx` process, it is essential to have a deterministic minimum fee requirement. In `CheckTx`, fee is checked by the `CombinedFeeRequirement(globalFees, localFees)`, which considers both `minimum-gas-prices` from `config/app.toml` and `MinimumGasPricesParam` from the globalfee Params (For more details, see [globalfee](../../modules/globalfee.md)). `CombinedFeeRequirement` contains non-deterministic part: `minimum-gas-prices` from `app.toml`. Therefore, `CombinedFeeRequirement` cannot be used in `DeliverTx`. In `DeliverTx`, only `MinimumGasPricesParam` in globalfee Params is used for fee verification. The code implementation is shown below. +- **Deterministic Minimum Fee Requirement**: For the `DeliverTx` process, it is essential to have a deterministic minimum fee requirement. In `CheckTx`, fee is checked by the `CombinedFeeRequirement(globalFees, localFees)`, which considers both `minimum-gas-prices` from `config/app.toml` and `MinimumGasPricesParam` from the globalfee Params (For more details, see [globalfee](https://github.com/cosmos/gaia/blob/v16.0.0/docs/docs/modules/globalfee.md)). `CombinedFeeRequirement` contains non-deterministic part: `minimum-gas-prices` from `app.toml`. Therefore, `CombinedFeeRequirement` cannot be used in `DeliverTx`. In `DeliverTx`, only `MinimumGasPricesParam` in globalfee Params is used for fee verification. The code implementation is shown below. ```go func (mfd FeeDecorator) GetTxFeeRequired(ctx sdk.Context, tx sdk.FeeTx) (sdk.Coins, error) { diff --git a/docs/docs/delegators/delegator-faq.md b/docs/docs/delegators/delegator-faq.md index 85b7d5bac9b..6432b219bcd 100644 --- a/docs/docs/delegators/delegator-faq.md +++ b/docs/docs/delegators/delegator-faq.md @@ -15,7 +15,7 @@ For a practical guide on how to become a delegator, click [here](./delegator-gui ## Choosing a validator -In order to choose their validators, delegators have access to a range of information directly in [Lunie](https://lunie.io) or other Cosmos block explorers. +In order to choose their validators, delegators have access to a range of information directly in [Mintscan](https://mintscan.io/cosmos/validators) or other Cosmos block explorers. - **Validator's moniker**: Name of the validator candidate. - **Validator's description**: Description provided by the validator operator. diff --git a/docs/docs/delegators/delegator-guide-cli.md b/docs/docs/delegators/delegator-guide-cli.md index b832d8e2d23..3d38d2e312e 100644 --- a/docs/docs/delegators/delegator-guide-cli.md +++ b/docs/docs/delegators/delegator-guide-cli.md @@ -405,7 +405,7 @@ gaiad tx bank send [from_key_or_address] [to_address] [amount] [flags] ::: :::warning -**Before bonding Atoms, please read the [delegator faq](https://hub.cosmos.network/delegators/delegator-faq) to understand the risk and responsibilities involved with delegating** +**Before bonding Atoms, please read the [delegator faq](./delegator-faq) to understand the risk and responsibilities involved with delegating** ::: :::warning diff --git a/docs/docs/hub-tutorials/upgrade-node.md b/docs/docs/hub-tutorials/upgrade-node.md index 9167bb8e398..b382a1a8311 100644 --- a/docs/docs/hub-tutorials/upgrade-node.md +++ b/docs/docs/hub-tutorials/upgrade-node.md @@ -81,7 +81,7 @@ gaiad start ## Upgrade Genesis File :::warning -If the new version you are upgrading to has breaking changes, you will have to restart your chain. If it is not breaking, you can skip to [Restart](/hub-tutorials/upgrade-node#restart) +If the new version you are upgrading to has breaking changes, you will have to restart your chain. If it is not breaking, you can skip to [Restart](./upgrade-node#restart) ::: To upgrade the genesis file, you can either fetch it from a trusted source or export it locally. diff --git a/docs/docs/index.md b/docs/docs/index.md index 1f96ef2e3d7..9012ffc38f2 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -63,9 +63,8 @@ These block explorers allow you to search, view and analyze Cosmos Hub data&mdas ## Running a full-node on the Cosmos Hub Mainnet -In order to run a full-node for the Cosmos Hub mainnet, you must first [install `gaiad`](./getting-started/installation). Then, follow [the guide](./hub-tutorials/join-mainnet). -If you are looking to run a validator node, follow the [validator setup guide](./validators/valid -ator-setup). +In order to run a full-node for the Cosmos Hub mainnet, you must first [install `gaiad`](./getting-started/installation.md). Then, follow [the guide](./hub-tutorials/join-mainnet.md). +If you are looking to run a validator node, follow the [validator setup guide](./validators/validator-setup.md). ## Join the Community diff --git a/docs/docs/validators/validator-faq.md b/docs/docs/validators/validator-faq.md index 15c8048dbf3..0bc22c992fb 100644 --- a/docs/docs/validators/validator-faq.md +++ b/docs/docs/validators/validator-faq.md @@ -32,11 +32,11 @@ You can find more details about the requirements in the [Joining Mainnet Tutoria ### What is a delegator? -Delegators are ATOM holders who cannot, or do not want to, run a validator themselves. ATOM holders can delegate ATOM to a validator and obtain a part of their revenue in exchange. For details on how revenue is distributed, see [What is the incentive to stake?](/validators/validator-faq#what-is-the-incentive-to-stake) and [What are validators commission?](/validators/validator-faq#what-is-a-validator-commission) in this document. +Delegators are ATOM holders who cannot, or do not want to, run a validator themselves. ATOM holders can delegate ATOM to a validator and obtain a part of their revenue in exchange. For details on how revenue is distributed, see [What is the incentive to stake?](./validator-faq#what-is-the-incentive-to-stake) and [What are validators commission?](./validator-faq#what-is-a-validator-commission) in this document. Because delegators share revenue with their validators, they also share risks. If a validator misbehaves, each of their delegators are partially slashed in proportion to their delegated stake. This penalty is one of the reasons why delegators must perform due diligence on validators before delegating. Spreading their stake over multiple validators is another layer of protection. -Delegators play a critical role in the system, as they are responsible for choosing validators. Being a delegator is not a passive role. Delegators must actively monitor the actions of their validators and participate in governance. For details on being a delegator, read the [Delegator FAQ](https://hub.cosmos.network/delegators/delegator-faq). +Delegators play a critical role in the system, as they are responsible for choosing validators. Being a delegator is not a passive role. Delegators must actively monitor the actions of their validators and participate in governance. For details on being a delegator, read the [Delegator FAQ](../delegators/delegator-faq.md). ## Becoming a Validator diff --git a/docs/docs/validators/validator-setup.md b/docs/docs/validators/validator-setup.md index 1a8b27669f8..e2b1fef296a 100644 --- a/docs/docs/validators/validator-setup.md +++ b/docs/docs/validators/validator-setup.md @@ -4,22 +4,22 @@ order: 2 --- :::tip -We suggest you try out joining a public testnet first. Information on how to join the most recent testnet can be found [here](/hub-tutorials/join-testnet). +We suggest you try out joining a public testnet first. Information on how to join the most recent testnet can be found [here](../hub-tutorials/join-testnet). ::: -Before setting up a validator node, make sure to have completed the [Joining Mainnet](/hub-tutorials/join-mainnet) guide. +Before setting up a validator node, make sure to have completed the [Joining Mainnet](../hub-tutorials/join-mainnet.md) guide. -If you plan to use a KMS (key management system), you should go through these steps first: [Using a KMS](/validators/kms/kms). +If you plan to use a KMS (key management system), you should go through these steps first: [Using a KMS](../validators/kms/kms.md). ## What is a Validator? -[Validators](/validators/overview) are responsible for committing new blocks to the blockchain through an automated voting process. A validator's stake is slashed if they become unavailable or sign blocks at the same height. Because there is a chance of slashing, we suggest you read about [Sentry Node Architecture](/validators/validator-faq#how-can-validators-protect-themselves-from-denial-of-service-attacks) to protect your node from DDOS attacks and to ensure high-availability. +[Validators](./overview) are responsible for committing new blocks to the blockchain through an automated voting process. A validator's stake is slashed if they become unavailable or sign blocks at the same height. Because there is a chance of slashing, we suggest you read about [Sentry Node Architecture](./validator-faq#how-can-validators-protect-themselves-from-denial-of-service-attacks) to protect your node from DDOS attacks and to ensure high-availability. :::warning -If you want to become a validator for the Hub's `mainnet`, you should learn more about [security](/validators/security). +If you want to become a validator for the Hub's `mainnet`, you should learn more about [security](./security). ::: -The following instructions assume you have already [set up a full-node](/hub-tutorials/join-mainnet) and are synchronised to the latest blockheight. +The following instructions assume you have already [set up a full-node](../hub-tutorials/join-mainnet.md) and are synchronised to the latest blockheight. ## Create Your Validator @@ -131,7 +131,7 @@ the block. ## Advanced configuration -You can find more advanced information about running a node or a validator on the [CometBFT Core documentation](https://docs.cometbft.com/v0.37/core/validators). +You can find more advanced information about running a node or a validator on the [CometBFT Core documentation](https://docs.cometbft.com/v0.38/core/validators). ## Common Problems @@ -139,7 +139,7 @@ You can find more advanced information about running a node or a validator on th Your validator has become jailed. Validators get jailed, i.e. get removed from the active validator set, if they do not vote on at least `500` of the last `10,000` blocks, or if they double sign. -If you got jailed for downtime, you can get your voting power back to your validator. First, if you're not using [Cosmovisor](https://docs.cosmos.network/v0.45/run-node/cosmovisor.html) and `gaiad` is not running, start it up again: +If you got jailed for downtime, you can get your voting power back to your validator. First, if you're not using [Cosmovisor](https://docs.cosmos.network/v0.50/build/tooling/cosmovisor#installation) and `gaiad` is not running, start it up again: ```bash gaiad start @@ -157,7 +157,7 @@ You may notice that your voting power is less than it used to be. That's because ### Problem #2: My `gaiad` crashes because of `too many open files` -The default number of files Linux can open (per-process) is `1024`. `gaiad` is known to open more than `1024` files. This causes the process to crash. A quick fix is to run `ulimit -n 4096` (increase the number of open files allowed) and then restarting the process with `gaiad start`. If you are using `systemd` or another process manager to launch `gaiad` (such as [Cosmovisor](https://docs.cosmos.network/v0.45/run-node/cosmovisor.html)) this may require some configuration at that level. A sample `systemd` file to fix this issue is below: +The default number of files Linux can open (per-process) is `1024`. `gaiad` is known to open more than `1024` files. This causes the process to crash. A quick fix is to run `ulimit -n 4096` (increase the number of open files allowed) and then restarting the process with `gaiad start`. If you are using `systemd` or another process manager to launch `gaiad` (such as [Cosmovisor](https://docs.cosmos.network/v0.50/build/tooling/cosmovisor#installation)) this may require some configuration at that level. A sample `systemd` file to fix this issue is below: ```toml # /etc/systemd/system/gaiad.service