chore: add markdownlint to lint commands (#9353)

* add markdownlint config * update make lint commands * update markdownlint config * run make lint-fix * fix empty link * resuse docker container * run lint-fix * do not echo commands Co-authored-by: ryanchrypto <12519942+ryanchrypto@users.noreply.github.com>
2021-05-27 15:31:04 +00:00
parent b56e1a164b
commit cb66c99eab
147 changed files with 806 additions and 771 deletions
@@ -60,6 +60,7 @@ this process may be also be reversed. the following operations occur:
 - if unjailed add record to `ValidatorByPowerIndex`

 Jailed validators are not present in any of the following stores:
+
 - the power store (from consensus power to address)

 ## Delegations
@@ -21,9 +21,9 @@ This message is expected to fail if:
 - another validator with this pubkey is already registered
 - the initial self-delegation tokens are of a denom not specified as the bonding denom
 - the commission parameters are faulty, namely:
-  - `MaxRate` is either > 1 or < 0
-  - the initial `Rate` is either negative or > `MaxRate`
-  - the initial `MaxChangeRate` is either negative or > `MaxRate`
+    - `MaxRate` is either > 1 or < 0
+    - the initial `Rate` is either negative or > `MaxRate`
+    - the initial `MaxChangeRate` is either negative or > `MaxRate`
 - the description fields are too large

 This message creates and stores the `Validator` object at appropriate indexes.
@@ -108,11 +108,11 @@ When this message is processed the following actions occur:
 - validator's `DelegatorShares` and the delegation's `Shares` are both reduced by the message `SharesAmount`
 - calculate the token worth of the shares remove that amount tokens held within the validator
 - with those removed tokens, if the validator is:
-  - `Bonded` - add them to an entry in `UnbondingDelegation` (create `UnbondingDelegation` if it doesn't exist) with a completion time a full unbonding period from the current time. Update pool shares to reduce BondedTokens and increase NotBondedTokens by token worth of the shares.
-  - `Unbonding` - add them to an entry in `UnbondingDelegation` (create `UnbondingDelegation` if it doesn't exist) with the same completion time as the validator (`UnbondingMinTime`).
-  - `Unbonded` - then send the coins the message `DelegatorAddr`
+    - `Bonded` - add them to an entry in `UnbondingDelegation` (create `UnbondingDelegation` if it doesn't exist) with a completion time a full unbonding period from the current time. Update pool shares to reduce BondedTokens and increase NotBondedTokens by token worth of the shares.
+    - `Unbonding` - add them to an entry in `UnbondingDelegation` (create `UnbondingDelegation` if it doesn't exist) with the same completion time as the validator (`UnbondingMinTime`).
+    - `Unbonded` - then send the coins the message `DelegatorAddr`
 - if there are no more `Shares` in the delegation, then the delegation object is removed from the store
-  - under this situation if the delegation is the validator's self-delegation then also jail the validator.
+    - under this situation if the delegation is the validator's self-delegation then also jail the validator.

 ![Unbond sequence](../../../docs/uml/svg/unbond_sequence.svg)

@@ -144,11 +144,11 @@ When this message is processed the following actions occur:
 - the source validator's `DelegatorShares` and the delegations `Shares` are both reduced by the message `SharesAmount`
 - calculate the token worth of the shares remove that amount tokens held within the source validator.
 - if the source validator is:
-  - `Bonded` - add an entry to the `Redelegation` (create `Redelegation` if it doesn't exist) with a completion time a full unbonding period from the current time. Update pool shares to reduce BondedTokens and increase NotBondedTokens by token worth of the shares (this may be effectively reversed in the next step however).
-  - `Unbonding` - add an entry to the `Redelegation` (create `Redelegation` if it doesn't exist) with the same completion time as the validator (`UnbondingMinTime`).
-  - `Unbonded` - no action required in this step
+    - `Bonded` - add an entry to the `Redelegation` (create `Redelegation` if it doesn't exist) with a completion time a full unbonding period from the current time. Update pool shares to reduce BondedTokens and increase NotBondedTokens by token worth of the shares (this may be effectively reversed in the next step however).
+    - `Unbonding` - add an entry to the `Redelegation` (create `Redelegation` if it doesn't exist) with the same completion time as the validator (`UnbondingMinTime`).
+    - `Unbonded` - no action required in this step
 - Delegate the token worth to the destination validator, possibly moving tokens back to the bonded state.
 - if there are no more `Shares` in the source delegation, then the source delegation object is removed from the store
-  - under this situation if the delegation is the validator's self-delegation then also jail the validator.
+    - under this situation if the delegation is the validator's self-delegation then also jail the validator.

 ![Begin redelegation sequence](../../../docs/uml/svg/begin_redelegation_sequence.svg)
@@ -18,9 +18,9 @@ consensus layer. Operations are as following:
 - the new validator set is taken as the top `params.MaxValidators` number of
  validators retrieved from the `ValidatorsByPower` index
 - the previous validator set is compared with the new validator set:
-  - missing validators begin unbonding and their `Tokens` are transferred from the
+    - missing validators begin unbonding and their `Tokens` are transferred from the
    `BondedPool` to the `NotBondedPool` `ModuleAccount`
-  - new validators are instantly bonded and their `Tokens` are transferred from the
+    - new validators are instantly bonded and their `Tokens` are transferred from the
    `NotBondedPool` to the `BondedPool` `ModuleAccount`

 In all cases, any validators leaving or entering the bonded validator set or
@@ -7,21 +7,21 @@ order: 5
 Other modules may register operations to execute when a certain event has
 occurred within staking.  These events can be registered to execute either
 right `Before` or `After` the staking event (as per the hook name). The
-following hooks can registered with staking: 
+following hooks can registered with staking:

- - `AfterValidatorCreated(Context, ValAddress)`
-   - called when a validator is created
- - `BeforeValidatorModified(Context, ValAddress)`
-   - called when a validator's state is changed
- - `AfterValidatorRemoved(Context, ConsAddress, ValAddress)`
-   - called when a validator is deleted
- - `AfterValidatorBonded(Context, ConsAddress, ValAddress)`
-   - called when a validator is bonded
- - `AfterValidatorBeginUnbonding(Context, ConsAddress, ValAddress)`
-   - called when a validator begins unbonding
- - `BeforeDelegationCreated(Context, AccAddress, ValAddress)`
-   - called when a delegation is created
- - `BeforeDelegationSharesModified(Context, AccAddress, ValAddress)`
-   - called when a delegation's shares are modified
- - `BeforeDelegationRemoved(Context, AccAddress, ValAddress)`
-   - called when a delegation is removed
+- `AfterValidatorCreated(Context, ValAddress)`
+    - called when a validator is created
+- `BeforeValidatorModified(Context, ValAddress)`
+    - called when a validator's state is changed
+- `AfterValidatorRemoved(Context, ConsAddress, ValAddress)`
+    - called when a validator is deleted
+- `AfterValidatorBonded(Context, ConsAddress, ValAddress)`
+    - called when a validator is bonded
+- `AfterValidatorBeginUnbonding(Context, ConsAddress, ValAddress)`
+    - called when a validator begins unbonding
+- `BeforeDelegationCreated(Context, AccAddress, ValAddress)`
+    - called when a delegation is created
+- `BeforeDelegationSharesModified(Context, AccAddress, ValAddress)`
+    - called when a delegation's shares are modified
+- `BeforeDelegationRemoved(Context, AccAddress, ValAddress)`
+    - called when a delegation is removed
@@ -11,7 +11,7 @@ parent:

 This paper specifies the Staking module of the Cosmos-SDK, which was first
 described in the [Cosmos Whitepaper](https://cosmos.network/about/whitepaper)
-in June 2016. 
+in June 2016.

 The module enables Cosmos-SDK based blockchain to support an advanced
 Proof-of-Stake system. In this system, holders of the native staking token of
@@ -45,9 +45,9 @@ network.
    - [MsgBeginRedelegate](03_messages.md#msgbeginredelegate)
 4. **[Begin-Block](04_begin_block.md)**
    - [Historical Info Tracking](04_begin_block.md#historical-info-tracking)
-5. **[End-Block ](05_end_block.md)**
+5. **[End-Block](05_end_block.md)**
    - [Validator Set Changes](05_end_block.md#validator-set-changes)
-    - [Queues ](05_end_block.md#queues-)
+    - [Queues](05_end_block.md#queues-)
 6. **[Hooks](06_hooks.md)**
 7. **[Events](07_events.md)**
    - [EndBlocker](07_events.md#endblocker)