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

docs: Improve markdownlint configuration (#11104)

Browse Source 
## Description

Closes: #9404



---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
This commit is contained in:
Julien Robert
2022-02-10 12:07:01 +00:00
committed by GitHub
parent b1f9a117f7
commit 58597139fa
212 changed files with 3792 additions and 3755 deletions
Download Patch File Download Diff File Expand all files Collapse all files
x/mint/README.md
+1 -1
View File
@@ -4,4 +4,4 @@ order: 0
# Mint
- [Mint](spec/README.md) - Creation of new units of staking token.
* [Mint](spec/README.md) - Creation of new units of staking token.
x/mint/spec/01_concepts.md
+5 -5
View File
@@ -8,8 +8,8 @@ order: 1
The minting mechanism was designed to:
- allow for a flexible inflation rate determined by market demand targeting a particular bonded-stake ratio
- effect a balance between market liquidity and staked supply
* allow for a flexible inflation rate determined by market demand targeting a particular bonded-stake ratio
* effect a balance between market liquidity and staked supply
In order to best determine the appropriate market rate for inflation rewards, a
moving change rate is used. The moving change rate mechanism ensures that if
@@ -20,9 +20,9 @@ which should help provide some liquidity.
It can be broken down in the following way:
- If the inflation rate is below the goal %-bonded the inflation rate will
* If the inflation rate is below the goal %-bonded the inflation rate will
increase until a maximum value is reached
- If the goal % bonded (67% in Cosmos-Hub) is maintained, then the inflation
* If the goal % bonded (67% in Cosmos-Hub) is maintained, then the inflation
rate will stay constant
- If the inflation rate is above the goal %-bonded the inflation rate will
* If the inflation rate is above the goal %-bonded the inflation rate will
decrease until a minimum value is reached
x/mint/spec/02_state.md
+4 -4
View File
@@ -8,14 +8,14 @@ order: 2
The minter is a space for holding current inflation information.
- Minter: `0x00 -> ProtocolBuffer(minter)`
* Minter: `0x00 -> ProtocolBuffer(minter)`
+++ https://github.com/cosmos/cosmos-sdk/blob/v0.40.0-rc7/proto/cosmos/mint/v1beta1/mint.proto#L8-L19
+++ <https://github.com/cosmos/cosmos-sdk/blob/v0.40.0-rc7/proto/cosmos/mint/v1beta1/mint.proto#L8-L19>
## Params
Minting params are held in the global params store.
- Params: `mint/params -> legacy_amino(params)`
* Params: `mint/params -> legacy_amino(params)`
+++ https://github.com/cosmos/cosmos-sdk/blob/v0.40.0-rc7/proto/cosmos/mint/v1beta1/mint.proto#L21-L53
+++ <https://github.com/cosmos/cosmos-sdk/blob/v0.40.0-rc7/proto/cosmos/mint/v1beta1/mint.proto#L21-L53>
x/mint/spec/03_begin_block.md
+3 -3
View File
@@ -15,7 +15,7 @@ depending on the distance from the desired ratio (67%). The maximum rate change
possible is defined to be 13% per year, however the annual inflation is capped
as between 7% and 20%.
```
```go
NextInflationRate(params Params, bondedRatio sdk.Dec) (inflation sdk.Dec) {
inflationRateChangePerYear = (1 - bondedRatio/params.GoalBonded) * params.InflationRateChange
inflationRateChange = inflationRateChangePerYear/blocksPerYr
@@ -38,7 +38,7 @@ NextInflationRate(params Params, bondedRatio sdk.Dec) (inflation sdk.Dec) {
Calculate the annual provisions based on current total supply and inflation
rate. This parameter is calculated once per block.
```
```go
NextAnnualProvisions(params Params, totalSupply sdk.Dec) (provisions sdk.Dec) {
return Inflation * totalSupply
```
@@ -47,7 +47,7 @@ NextAnnualProvisions(params Params, totalSupply sdk.Dec) (provisions sdk.Dec) {
Calculate the provisions generated for each block based on current annual provisions. The provisions are then minted by the `mint` module's `ModuleMinterAccount` and then transferred to the `auth`'s `FeeCollector` `ModuleAccount`.
```
```go
BlockProvision(params Params) sdk.Coin {
provisionAmt = AnnualProvisions/ params.BlocksPerYear
return sdk.NewCoin(params.MintDenom, provisionAmt.Truncate())
x/mint/spec/06_client.md
+27 -27
View File
@@ -12,7 +12,7 @@ A user can query and interact with the `mint` module using the CLI.
The `query` commands allow users to query `mint` state.
```
```sh
simd query mint --help
```
@@ -20,19 +20,19 @@ simd query mint --help
The `annual-provisions` command allow users to query the current minting annual provisions value
```
```sh
simd query mint annual-provisions [flags]
```
Example:
```
```sh
simd query mint annual-provisions
```
Example Output:
```
```sh
22268504368893.612100895088410693
```
@@ -40,19 +40,19 @@ Example Output:
The `inflation` command allow users to query the current minting inflation value
```
```sh
simd query mint inflation [flags]
```
Example:
```
```sh
simd query mint inflation
```
Example Output:
```
```sh
0.199200302563256955
```
@@ -60,13 +60,13 @@ Example Output:
The `params` command allow users to query the current minting parameters
```
```sh
simd query mint params [flags]
```
Example:
```
```yml
blocks_per_year: "4360000"
goal_bonded: "0.670000000000000000"
inflation_max: "0.200000000000000000"
@@ -83,19 +83,19 @@ A user can query the `mint` module using gRPC endpoints.
The `AnnualProvisions` endpoint allow users to query the current minting annual provisions value
```
```sh
/cosmos.mint.v1beta1.Query/AnnualProvisions
```
Example:
```
```sh
grpcurl -plaintext localhost:9090 cosmos.mint.v1beta1.Query/AnnualProvisions
```
Example Output:
```
```json
{
"annualProvisions": "1432452520532626265712995618"
}
@@ -105,19 +105,19 @@ Example Output:
The `Inflation` endpoint allow users to query the current minting inflation value
```
```sh
/cosmos.mint.v1beta1.Query/Inflation
```
Example:
```
```sh
grpcurl -plaintext localhost:9090 cosmos.mint.v1beta1.Query/Inflation
```
Example Output:
```
```json
{
"inflation": "130197115720711261"
}
@@ -127,19 +127,19 @@ Example Output:
The `Params` endpoint allow users to query the current minting parameters
```
```sh
/cosmos.mint.v1beta1.Query/Params
```
Example:
```
```sh
grpcurl -plaintext localhost:9090 cosmos.mint.v1beta1.Query/Params
```
Example Output:
```
```json
{
"params": {
"mintDenom": "stake",
@@ -158,19 +158,19 @@ A user can query the `mint` module using REST endpoints.
### annual-provisions
```
```sh
/cosmos/mint/v1beta1/annual_provisions
```
Example:
```
```sh
curl "localhost:1317/cosmos/mint/v1beta1/annual_provisions"
```
Example Output:
```
```json
{
"annualProvisions": "1432452520532626265712995618"
}
@@ -178,19 +178,19 @@ Example Output:
### inflation
```
```sh
/cosmos/mint/v1beta1/inflation
```
Example:
```
```sh
curl "localhost:1317/cosmos/mint/v1beta1/inflation"
```
Example Output:
```
```json
{
"inflation": "130197115720711261"
}
@@ -198,19 +198,19 @@ Example Output:
### params
```
```sh
/cosmos/mint/v1beta1/params
```
Example:
```
```sh
curl "localhost:1317/cosmos/mint/v1beta1/params"
```
Example Output:
```
```json
{
"params": {
"mintDenom": "stake",
x/mint/spec/README.md
+9 -9
View File
@@ -11,16 +11,16 @@ parent:
1. **[Concept](01_concepts.md)**
2. **[State](02_state.md)**
- [Minter](02_state.md#minter)
- [Params](02_state.md#params)
* [Minter](02_state.md#minter)
* [Params](02_state.md#params)
3. **[Begin-Block](03_begin_block.md)**
- [NextInflationRate](03_begin_block.md#nextinflationrate)
- [NextAnnualProvisions](03_begin_block.md#nextannualprovisions)
- [BlockProvision](03_begin_block.md#blockprovision)
* [NextInflationRate](03_begin_block.md#nextinflationrate)
* [NextAnnualProvisions](03_begin_block.md#nextannualprovisions)
* [BlockProvision](03_begin_block.md#blockprovision)
4. **[Parameters](04_params.md)**
5. **[Events](05_events.md)**
- [BeginBlocker](05_events.md#beginblocker)
* [BeginBlocker](05_events.md#beginblocker)
6. **[Client](06_client.md)**
- [CLI](06_client.md#cli)
- [gRPC](06_client.md#grpc)
- [REST](06_client.md#rest)
* [CLI](06_client.md#cli)
* [gRPC](06_client.md#grpc)
* [REST](06_client.md#rest)