Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update default values for commission and gas prices #38

Merged
merged 2 commits into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/linters/mlc_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@
},
{
"pattern": "^https://docs.cosmos.network/v0.46/"
},
{
"pattern": "^https://twitter.com/"
}
],
"retryOn429": true
Expand Down
4 changes: 2 additions & 2 deletions architecture/adr-list/adr-002-mnemonic-keys-cosmos.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For example, an identity wallet application or backend application would need to

### Assumptions / Considerations

Cosmos SDK uses [known algorithms for deriving private keys from mnemonics](https://docs.cosmos.network/main/basics/accounts.html#keyring). This can be replicated using standard crypto libraries to carry out the same steps as in Cosmos SDK:
Cosmos SDK uses [known algorithms for deriving private keys from mnemonics](https://docs.cosmos.network/main/learn/beginner/accounts#keyring). This can be replicated using standard crypto libraries to carry out the same steps as in Cosmos SDK:

```text
rounds of iteration : 2048
Expand Down Expand Up @@ -64,4 +64,4 @@ N/A

## References

* [Cosmos SDK account generation and keyrings](https://docs.cosmos.network/main/basics/accounts.html)
* [Cosmos SDK account generation and keyrings](https://docs.cosmos.network/main/learn/beginner/accounts)
2 changes: 1 addition & 1 deletion architecture/adr-list/adr-004-token-fractions.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ It was decided to go with **10^-9** as the smallest fraction, with the whole num

## References

* [Cosmos ADR proposal to add coin metadata](https://docs.cosmos.network/main/architecture/adr-024-coin-metadata.html)
* [Cosmos ADR proposal to add coin metadata](https://docs.cosmos.network/main/build/architecture/adr-024-coin-metadata)
2 changes: 1 addition & 1 deletion architecture/adr-list/adr-005-genesis-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Cosmos application is divided [into a list of modules](https://docs.cosmos.netwo

| Parameter | Description | Mainnet | Testnet |
| - | - | - | - |
| `constant_fee` | The fee is used to verify the [invariant(s)](https://docs.cosmos.network/main/building-modules/invariants.html) | 10,000,000,000,000 ncheq (10,000 CHEQ) | 10,000,000,000,000 ncheq (10,000 CHEQ) |
| `constant_fee` | The fee is used to verify the [invariant(s)](https://docs.cosmos.network/main/build/building-modules/invariants) | 10,000,000,000,000 ncheq (10,000 CHEQ) | 10,000,000,000,000 ncheq (10,000 CHEQ) |

### `distribution` module

Expand Down
2 changes: 1 addition & 1 deletion architecture/adr-list/adr-007-revocation-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,5 +129,5 @@ _Reply Example_:

## References

* [Hyperledger Indy Credential Revocation Hype](https://hyperledger-indy.readthedocs.io/projects/hipe/en/latest/text/0011-cred-revocation/README.html)
* [Hyperledger Indy Credential Revocation Hype](https://hyperledger-indy.readthedocs.io/projects/hipe/en/latest/text/0011-cred-revocation/README/)

2 changes: 1 addition & 1 deletion docs/cheqd-cli/cheqd-cli-key-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Account addresses are on a cheqd node are an encoded version of a public key. Ea

To submit a transaction on behalf of an account, it must be signed with an account's private key.

Cosmos supports [multiple keyring backends](https://docs.cosmos.network/main/run-node/keyring.html) for the storage and management of keys. Each node operator is free to use the key management method they prefer.
Cosmos supports [multiple keyring backends](https://docs.cosmos.network/main/user/run-node/keyring) for the storage and management of keys. Each node operator is free to use the key management method they prefer.

By default, the `cheqd-noded` binary is configured to use the `os` keyring backend, as it is a safe default compared to file-based key management methods.

Expand Down
10 changes: 5 additions & 5 deletions docs/validator-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,15 @@ P.S. in case of using Ledger Nano device it would be helpful to use [this instru
* **`from`**: Key alias of the node operator account that makes the initial stake
* **`min-self-delegation`**: Minimum amount of tokens that the node operator promises to keep bonded
* **`pubkey`**: Node's `bech32`-encoded validator public key from the previous step
* **`commission-rate`**: Validator's commission rate
* **`commission-rate`**: Validator's commission rate. The minimum is set to `0.05`.
* **`commission-max-rate`**: Validator's maximum commission rate, expressed as a number with up to two decimal points. The value for this cannot be changed later.
* **`commission-max-change-rate`**: Maximum rate of change of a validator's commission rate per day, expressed as a number with up to two decimal points. The value for this cannot be changed later.
* **`chain-id`**: Unique identifier for the chain.
* For cheqd's current mainnet, this is `cheqd-mainnet-1`
* For cheqd's current testnet, this is `cheqd-testnet-4`
* For cheqd's current testnet, this is `cheqd-testnet-6`
* **`gas`**: Maximum gas to use for *this specific* transaction. Using `auto` uses Cosmos's auto-calculation mechanism, but can also be specified manually as an integer value.
* **gas-adjustment** (optional): If you're using `auto` gas calculation, this parameter multiplies the auto-calculated amount by the specified factor, e.g., `1.2`. This is recommended so that it leaves enough margin of error to add a bit more gas to the transaction and ensure it successfully goes through.
* **`gas-prices`**: Maximum gas price set by the validator
* **gas-adjustment** (optional): If you're using `auto` gas calculation, this parameter multiplies the auto-calculated amount by the specified factor, e.g., `1.3`. This is recommended so that it leaves enough margin of error to add a bit more gas to the transaction and ensure it successfully goes through.
* **`gas-prices`**: Maximum gas price set by the validator. Default value is `50ncheq`.

Please note the parameters below are just an “**example**”.

Expand All @@ -94,7 +94,7 @@ When setting parameters such as the commission rate, a good benchmark is to cons
You will see the commission they set, the max rate they set, and the rate of change. Please use this as a guide when thinking of your own commission configurations. This is important to get right, because the `commission-max-rate` and `commission-max-change-rate` cannot be changed after they are initially set.

```bash
cheqd-noded tx staking create-validator --amount 1000000000ncheq --from key-alias-name --moniker mainnet-validator-name --chain-id cheqd-mainnet-1 --min-self-delegation="1" --gas auto --gas-adjustment 1.2 --gas-prices="25ncheq" --pubkey '{"@type":"/cosmos.crypto.ed25519.PubKey","key":"4anVUO8WhmRMqG1t4z6VxqmqZL3V7q6HqucjwZePiUw="}' --commission-max-change-rate 0.01 --commission-max-rate 0.2 --commission-rate 0.01 --node https://rpc.cheqd.net:443
cheqd-noded tx staking create-validator --amount 1000000000ncheq --from key-alias-name --moniker mainnet-validator-name --chain-id cheqd-mainnet-1 --min-self-delegation="1" --gas auto --gas-adjustment 1.3 --gas-prices="50ncheq" --pubkey '{"@type":"/cosmos.crypto.ed25519.PubKey","key":"4anVUO8WhmRMqG1t4z6VxqmqZL3V7q6HqucjwZePiUw="}' --commission-max-change-rate 0.01 --commission-max-rate 0.2 --commission-rate 0.05 --node https://rpc.cheqd.net:443
```

1. **Check that your validator node is bonded**
Expand Down