LaconicNetwork/cosmos-sdk
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Merge PR #4404: Update Spec to include params

Browse Source 
* Add staking params to spec

* Update format

* Add slashing params

* Update staking params

* Add minting params doc

* Add gov params doc

* Add distr params doc

* Add crisis params doc

* Add bank params doc

* Add auth params doc

* Update SPEC-SPEC
This commit is contained in:
Alexander Bezobchuk 2019-05-24 12:18:07 -04:00 committed by frog power 4000
parent a7a1a469ae
commit 91dc870e97
17 changed files with 105 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/spec/SPEC-SPEC.md
View File

@ -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

11
docs/spec/auth/07_params.md Normal file
View File

@ -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" |

1
docs/spec/auth/README.md
View File

@ -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)**

8
docs/spec/bank/05_params.md Normal file
View File

@ -0,0 +1,8 @@
# Parameters
The bank module contains the following parameters:
| Key | Type | Example |
|-------------|------|---------|
| sendenabled | bool | true |

1
docs/spec/bank/README.md
View File

@ -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)**

7
docs/spec/crisis/04_params.md Normal file
View File

@ -0,0 +1,7 @@
# Parameters
The crisis module contains the following parameters:
| Key | Type | Example |
|-------------|---------------|-----------------------------------|
| ConstantFee | object (coin) | {"denom":"uatom","amount":"1000"} |

1
docs/spec/crisis/README.md
View File

@ -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)**

10
docs/spec/distribution/07_params.md Normal file
View File

@ -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 |

1
docs/spec/distribution/README.md
View File

@ -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)**

24
docs/spec/governance/06_params.md Normal file
View File

@ -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.

1
docs/spec/governance/README.md
View File

@ -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)**

12
docs/spec/mint/04_params.md Normal file
View File

@ -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" |

2
docs/spec/mint/README.md
View File

@ -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)**

12
docs/spec/slashing/08_params.md Normal file
View File

@ -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" |

2
docs/spec/slashing/README.md
View File

@ -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)**

10
docs/spec/staking/07_params.md Normal file
View File

@ -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" |

1
docs/spec/staking/README.md
View File

@ -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)**