diff --git a/README.md b/README.md index 175067eaf5..95e3e98325 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ close soup mirror crew erode defy knock trigger gather eyebrow tent farm gym glo This mnemonic will have tokens on every chain running locally. #### Running integration tests -Ensure submoules are updated +Ensure submodules are updated ``` git submodule update --init --recursive ``` diff --git a/x/README.md b/x/README.md index c1cd156b36..b3f96e9257 100644 --- a/x/README.md +++ b/x/README.md @@ -13,7 +13,7 @@ category: 62c5c5ff03a5bf069004def2 `interchainquery` - Issues queries between IBC chains, verifies state proof and executes callbacks. `epochs` - Makes on-chain timers which other modules can execute code during. `mint` - Controls token supply emissions, and what modules they are directed to. -`ratelimit` - IBC middleware wrapping the transfer module, thottles large IBC transfers. +`ratelimit` - IBC middleware wrapping the transfer module, throttles large IBC transfers. ### Attribution diff --git a/x/claim/README.md b/x/claim/README.md index 0a2f360919..7c30ce9a89 100644 --- a/x/claim/README.md +++ b/x/claim/README.md @@ -6,7 +6,7 @@ category: 6392913957c533007128548e # The Claim Module -Users are required participate in core network activities to claim their airdrop. An Airdrop recipient is given 20% of the airdrop amount which is not in vesting, and then they have to perform the following activities to get the rest: +Users are required to participate in core network activities to claim their airdrop. An Airdrop recipient is given 20% of the airdrop amount which is not in vesting, and then they have to perform the following activities to get the rest: * 20% vesting over 3 months by staking * 60% vesting over 3 months by liquid staking @@ -23,7 +23,7 @@ ActionLiquidStake Action = 0 ActionDelegateStake Action = 1 ``` -These actions are monitored by registring claim **hooks** to the stakeibc, and staking modules. +These actions are monitored by registering claim **hooks** to the stakeibc, and staking modules. This means that when you perform an action, the claims module will immediately unlock those coins if they are applicable. These actions can be performed in any order. @@ -45,7 +45,7 @@ So for example, `[true, true]` means that `ActionLiquidStake` and `ActionDelegat type ClaimRecord struct { // address of claim user Address string - // weight that represent the portion from total allocation + // weight that represents the portion from total allocation Weight sdk.Dec // true if action is completed // index of bool in array refers to action enum # @@ -122,7 +122,7 @@ message ClaimRecord { // address of claim user string address = 1 [ (gogoproto.moretags) = "yaml:\"address\"" ]; - // weight that represent the portion from total allocations + // weight that represents the portion from total allocations double weight = 2; // true if action is completed diff --git a/x/epochs/README.md b/x/epochs/README.md index 3f8f774a4c..6c55b3f51e 100644 --- a/x/epochs/README.md +++ b/x/epochs/README.md @@ -36,7 +36,7 @@ When an epoch triggers the execution of code, that code is executed at the first Stride uses three epoch identifiers as found in `x/epochs/genesis.go` 1. `DAY_EPOCH`: this identifies an epoch that lasts 24 hours. -2. `STRIDE_EPOCH`: this identifies an epoch that lasts 5 minutes on local mode tesnet (although this may be changed) and longer on public testnet and mainnet, and is used in the `x/stakeibc/` module as a time interval in accordance with which the Stride app chain performs certain functions, such as autocompound stakig rewards. +2. `STRIDE_EPOCH`: this identifies an epoch that lasts 5 minutes on local mode testnet (although this may be changed) and longer on public testnet and mainnet, and is used in the `x/stakeibc/` module as a time interval in accordance with which the Stride app chain performs certain functions, such as autocompound staking rewards. ## State diff --git a/x/mint/README.md b/x/mint/README.md index de77a81d94..0a5114cbb3 100644 --- a/x/mint/README.md +++ b/x/mint/README.md @@ -73,7 +73,7 @@ func (m Minter) EpochProvision(params Params) sdk.Coin { 3. `epoch_identifier` defines the epoch identifier to be used for mint module e.g. "weekly" 4. `reduction_period_in_epochs` defines the number of epochs to pass to reduce mint amount 5. `reduction_factor` defines the reduction factor of tokens at every `reduction_period_in_epochs` -6. `distribution_proportions` defines distribution rules for minted tokens, when developer rewards address is empty, it distribute tokens to community pool. +6. `distribution_proportions` defines distribution rules for minted tokens, when developer rewards address is empty, it distributes tokens to community pool. 7. `weighted_developer_rewards_receivers` provides the addresses that receives developer rewards by weight 8. `minting_rewards_distribution_start_epoch` defines the start epoch of minting to make sure minting start after initial pools are set