diff --git a/docs/spec/SPEC-SPEC.md b/docs/spec/SPEC-SPEC.md index 7cb3ec0167..d600c24f70 100644 --- a/docs/spec/SPEC-SPEC.md +++ b/docs/spec/SPEC-SPEC.md @@ -34,6 +34,7 @@ following list is nonbinding and all files are optional. - `XX_end_block.md` - specify any end-block operations - `XX_hooks.md` - describe available hooks to be called by/from this module - `XX_tags.md` - list and describe event tags used + - `XX_params.md` - list all module parameters, their types (in JSON) and examples - `XX_future_improvements.md` - describe future improvements of this module - `XX_appendix.md` - supplementary details referenced elsewhere within the spec diff --git a/docs/spec/auth/07_params.md b/docs/spec/auth/07_params.md new file mode 100644 index 0000000000..b5d9ad9c20 --- /dev/null +++ b/docs/spec/auth/07_params.md @@ -0,0 +1,11 @@ +# Parameters + +The auth module contains the following parameters: + +| Key | Type | Example | +|------------------------|-----------------|---------| +| MaxMemoCharacters | string (uint64) | "256" | +| TxSigLimit | string (uint64) | "7" | +| TxSizeCostPerByte | string (uint64) | "10" | +| SigVerifyCostED25519 | string (uint64) | "590" | +| SigVerifyCostSecp256k1 | string (uint64) | "1000" | diff --git a/docs/spec/auth/README.md b/docs/spec/auth/README.md index 92ff7f4de9..1e57a39c09 100644 --- a/docs/spec/auth/README.md +++ b/docs/spec/auth/README.md @@ -34,3 +34,4 @@ This module will be used in the Cosmos Hub. - [Genesis Initialization](05_vesting.md#genesis-initialization) - [Examples](05_vesting.md#examples) - [Glossary](05_vesting.md#glossary) +7. **[Parameters](07_params.md)** diff --git a/docs/spec/bank/05_params.md b/docs/spec/bank/05_params.md new file mode 100644 index 0000000000..d68fad95e9 --- /dev/null +++ b/docs/spec/bank/05_params.md @@ -0,0 +1,8 @@ +# Parameters + +The bank module contains the following parameters: + +| Key | Type | Example | +|-------------|------|---------| +| sendenabled | bool | true | + diff --git a/docs/spec/bank/README.md b/docs/spec/bank/README.md index ba4beb856b..cd32692101 100644 --- a/docs/spec/bank/README.md +++ b/docs/spec/bank/README.md @@ -24,3 +24,4 @@ This module will be used in the Cosmos Hub. - [MsgSend](03_messages.md#msgsend) 4. **[Tags](04_tags.md)** - [Handlers](04_tags.md#handlers) +5. **[Parameters](05_params.md)** diff --git a/docs/spec/crisis/04_params.md b/docs/spec/crisis/04_params.md new file mode 100644 index 0000000000..19ccc36482 --- /dev/null +++ b/docs/spec/crisis/04_params.md @@ -0,0 +1,7 @@ +# Parameters + +The crisis module contains the following parameters: + +| Key | Type | Example | +|-------------|---------------|-----------------------------------| +| ConstantFee | object (coin) | {"denom":"uatom","amount":"1000"} | diff --git a/docs/spec/crisis/README.md b/docs/spec/crisis/README.md index b9a9ae7dc8..2031788002 100644 --- a/docs/spec/crisis/README.md +++ b/docs/spec/crisis/README.md @@ -14,3 +14,4 @@ application initialization process. - [MsgVerifyInvariant](02_messages.md#msgverifyinvariant) 3. **[Tags](03_tags.md)** - [Handlers](03_tags.md#handlers) +4. **[Parameters](04_params.md)** diff --git a/docs/spec/distribution/07_params.md b/docs/spec/distribution/07_params.md new file mode 100644 index 0000000000..563c2c4270 --- /dev/null +++ b/docs/spec/distribution/07_params.md @@ -0,0 +1,10 @@ +# Parameters + +The distribution module contains the following parameters: + +| Key | Type | Example | +|---------------------|--------------|------------------------| +| communitytax | string (dec) | "0.020000000000000000" | +| baseproposerreward | string (dec) | "0.010000000000000000" | +| bonusproposerreward | string (dec) | "0.040000000000000000" | +| withdrawaddrenabled | bool | true | diff --git a/docs/spec/distribution/README.md b/docs/spec/distribution/README.md index 4b412a49e4..506ba9f488 100644 --- a/docs/spec/distribution/README.md +++ b/docs/spec/distribution/README.md @@ -92,3 +92,4 @@ to set up a script to periodically withdraw and rebond rewards. - [Change in Validator State](05_hooks.md#change-in-validator-state) 6. **[Tags](06_tags.md)** - [Handlers](06_tags.md#handlers) +7. **[Parameters](07_params.md)** diff --git a/docs/spec/governance/06_params.md b/docs/spec/governance/06_params.md new file mode 100644 index 0000000000..4d24d03dfa --- /dev/null +++ b/docs/spec/governance/06_params.md @@ -0,0 +1,24 @@ +# Parameters + +The governance module contains the following parameters: + +| Key | Type | Example | +|---------------|--------|----------------------------------------------------------------------------------------------------| +| depositparams | object | {"min_deposit":[{"denom":"uatom","amount":"10000000"}],"max_deposit_period":"172800000000000"} | +| votingparams | object | {"voting_period":"172800000000000"} | +| tallyparams | object | {"quorum":"0.334000000000000000","threshold":"0.500000000000000000","veto":"0.334000000000000000"} | + +## SubKeys + +| Key | Type | Example | +|--------------------|------------------|-----------------------------------------| +| min_deposit | array (coins) | [{"denom":"uatom","amount":"10000000"}] | +| max_deposit_period | string (time ns) | "172800000000000" | +| voting_period | string (time ns) | "172800000000000" | +| quorum | string (dec) | "0.334000000000000000" | +| threshold | string (dec) | "0.500000000000000000" | +| veto | string (dec) | "0.334000000000000000" | + +__NOTE__: The governance module contains parameters that are objects unlike other +modules. If only a subset of parameters are desired to be changed, only they need +to be included and not the entire parameter object structure. diff --git a/docs/spec/governance/README.md b/docs/spec/governance/README.md index 7a0009b4ef..769ba03ec8 100644 --- a/docs/spec/governance/README.md +++ b/docs/spec/governance/README.md @@ -47,3 +47,4 @@ staking token of the chain. - [EndBlocker](04_tags.md#endblocker) - [Handlers](04_tags.md#handlers) 5. **[Future Improvements](05_future_improvements.md)** +6. **[Parameters](06_params.md)** diff --git a/docs/spec/mint/04_params.md b/docs/spec/mint/04_params.md new file mode 100644 index 0000000000..c743045e38 --- /dev/null +++ b/docs/spec/mint/04_params.md @@ -0,0 +1,12 @@ +# Parameters + +The minting module contains the following parameters: + +| Key | Type | Example | +|---------------------|-----------------|------------------------| +| MintDenom | string | "uatom" | +| InflationRateChange | string (dec) | "0.130000000000000000" | +| InflationMax | string (dec) | "0.200000000000000000" | +| InflationMin | string (dec) | "0.070000000000000000" | +| GoalBonded | string (dec) | "0.670000000000000000" | +| BlocksPerYear | string (uint64) | "6311520" | diff --git a/docs/spec/mint/README.md b/docs/spec/mint/README.md index aa8c28006c..d0feb6b5fe 100644 --- a/docs/spec/mint/README.md +++ b/docs/spec/mint/README.md @@ -10,3 +10,5 @@ - [NextInflationRate](03_begin_block.md#nextinflationrate) - [NextAnnualProvisions](03_begin_block.md#nextannualprovisions) - [BlockProvision](03_begin_block.md#blockprovision) +4. **[Parameters](04_params.md)** + diff --git a/docs/spec/slashing/08_params.md b/docs/spec/slashing/08_params.md new file mode 100644 index 0000000000..b9dfca0516 --- /dev/null +++ b/docs/spec/slashing/08_params.md @@ -0,0 +1,12 @@ +# Parameters + +The slashing module contains the following parameters: + +| Key | Type | Example | +|-------------------------|------------------|------------------------| +| MaxEvidenceAge | string (time ns) | "120000000000" | +| SignedBlocksWindow | string (int64) | "100" | +| MinSignedPerWindow | string (dec) | "0.500000000000000000" | +| DowntimeJailDuration | string (time ns) | "600000000000" | +| SlashFractionDoubleSign | string (dec) | "0.050000000000000000" | +| SlashFractionDowntime | string (dec) | "0.010000000000000000" | diff --git a/docs/spec/slashing/README.md b/docs/spec/slashing/README.md index a63be0c1d1..c7b7a04be8 100644 --- a/docs/spec/slashing/README.md +++ b/docs/spec/slashing/README.md @@ -33,3 +33,5 @@ This module will be used by the Cosmos Hub, the first hub in the Cosmos ecosyste - [Handlers](06_tags.md#handlers) 7. **[Staking Tombstone](07_tombstone.md)** - [Abstract](07_tombstone.md#abstract) +8. **[Parameters](08_params.md)** + diff --git a/docs/spec/staking/07_params.md b/docs/spec/staking/07_params.md new file mode 100644 index 0000000000..df44952b49 --- /dev/null +++ b/docs/spec/staking/07_params.md @@ -0,0 +1,10 @@ +# Parameters + +The staking module contains the following parameters: + +| Key | Type | Example | +|---------------|------------------|-------------------| +| UnbondingTime | string (time ns) | "259200000000000" | +| MaxValidators | uint16 | 100 | +| KeyMaxEntries | uint16 | 7 | +| BondDenom | string | "uatom" | diff --git a/docs/spec/staking/README.md b/docs/spec/staking/README.md index a44d8ed3c8..4265e75a32 100644 --- a/docs/spec/staking/README.md +++ b/docs/spec/staking/README.md @@ -42,3 +42,4 @@ network. 6. **[Tags](06_tags.md)** - [EndBlocker](06_tags.md#endblocker) - [Handlers](06_tags.md#handlers) +7. **[Parameters](07_params.md)**