chore: fix some typos in comments #20141

dockercui · 2024-04-22T13:11:22Z

Description

fix some typos in comments

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

included the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
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 in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

Documentation
- Improved clarity in the documentation for key renaming and CBOR functionality.
- Corrected typographical errors in the vesting account command description.
- Enhanced description of governance mechanisms for new chains.

Signed-off-by: dockercui <[email protected]>

coderabbitai · 2024-04-22T13:11:30Z

Walkthrough

This update focuses on enhancing documentation and code comments across several modules. Typos in comments within the key renaming and CBOR functionality files have been corrected. The documentation for the create-vesting-account command and the description of the governance "constitution" for new chains have also been refined for better clarity and understanding.

Changes

File(s)	Change Summary
`client/keys/rename_test.go`, `x/tx/signing/.../cbor.go`	Corrected typographical errors in comments to improve clarity and correctness.
`x/auth/vesting/README.md`	Fixed a typographical error in the command description for better consistency.
`x/gov/README.md`	Enhanced the description of the governance "constitution" for clearer understanding of its purpose and scope.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e59ca15 and 0f512c8.

Files selected for processing (4)

client/keys/rename_test.go (2 hunks)
x/auth/vesting/README.md (1 hunks)
x/gov/README.md (1 hunks)
x/tx/signing/textual/internal/cbor/cbor.go (1 hunks)

Additional Context Used

LanguageTool (463)

x/auth/vesting/README.md (98)

Near line 16: Possible spelling mistake found.
Context: ...t Types](#vesting-account-types) * BaseVestingAccount * [Continuous...

Near line 17: Possible spelling mistake found.
Context: ...ingAccount](#basevestingaccount) * ContinuousVestingAccount * [Dela...

Near line 18: Possible spelling mistake found.
Context: ...ount](#continuousvestingaccount) * DelayedVestingAccount * [Period]...

Near line 20: Possible spelling mistake found.
Context: ...account) * Period * PeriodicVestingAccount * [Perman...

Near line 21: Possible spelling mistake found.
Context: ...ccount](#periodicvestingaccount) * PermanentLockedAccount * [Vesting Ac...

Near line 27: Possible spelling mistake found.
Context: ... * Delegating * Undelegating * [Keepers & Handlers](...

Near line 38: You might be missing the article “the” here.
Context: ...the vesting period does not begin until start time is reached. If vesting periods are...

Near line 40: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...ounts, the owner of the vesting account is able to delegate and undelegate from validators...

Near line 40: Possible spelling mistake found.
Context: ...vesting account is able to delegate and undelegate from validators, however they cannot tr...

Near line 40: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... delegate and undelegate from validators, however they cannot transfer coins to another a...

Near line 43: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...begin to vest at ST and vest linearly with respect to time until ET is reached * Periodic v...

Near line 49: Possible spelling mistake found.
Context: ...oins would be immediately transferable. DelayedVesting ContinuousVesting, PeriodicVesting and ...

Near line 49: Possible spelling mistake found.
Context: ...mmediately transferable. DelayedVesting ContinuousVesting, PeriodicVesting and PermenantVesting a...

Near line 49: Possible spelling mistake found.
Context: ...able. DelayedVesting ContinuousVesting, PeriodicVesting and PermenantVesting accounts can be cr...

Near line 49: Possible spelling mistake found.
Context: ... ContinuousVesting, PeriodicVesting and PermenantVesting accounts can be created with normal mes...

Near line 49: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...nly allows for unconditional vesting (ie. there is no possibility of reaching `ET...

Near line 78: Possible spelling mistake found.
Context: ...int64 GetEndTime() int64 } ### BaseVestingAccount protobuf reference https://github.c...

Near line 84: Possible spelling mistake found.
Context: .../v1beta1/vesting.proto#L11-L35 ### ContinuousVestingAccount protobuf reference https://github.c...

Near line 90: Possible spelling mistake found.
Context: .../v1beta1/vesting.proto#L37-L46 ### DelayedVestingAccount protobuf reference https://github.c...

Near line 108: Possible spelling mistake found.
Context: ...Account type Periods []Period ### PeriodicVestingAccount protobuf reference https://github.c...

Near line 113: Consider a shorter alternative to avoid wordiness.
Context: ...ting/v1beta1/vesting.proto#L71-L81 ``` In order to facilitate less ad-hoc type checking an...

Near line 114: Possible spelling mistake found.
Context: ...nt balance usage, the existing x/bank ViewKeeper interface is updated to contain the fo...

Near line 128: Possible spelling mistake found.
Context: ...dr sdk.AccAddress) sdk.Coins } ### PermanentLockedAccount protobuf reference https://github.c...

Near line 136: Please check whether ‘preceding’ (coming before) might be the correct word here instead of ‘proceeding’ (continuing).
Context: ...account, we define the following in the proceeding operations: * OV: The original vesti...

Near line 138: Loose punctuation mark.
Context: ...ng in the proceeding operations: * OV: The original vesting coin amount. It is...

Near line 139: Loose punctuation mark.
Context: ...in amount. It is a constant value. * V: The number of OV coins that are still...

Near line 140: Possible spelling mistake found.
Context: ...still vesting. It is derived by OV, StartTime and EndTime. This value is computed ...

Near line 140: Possible spelling mistake found.
Context: ... It is derived by OV, StartTime and EndTime. This value is computed on demand and ...

Near line 141: Loose punctuation mark.
Context: ...and and not on a per-block basis. * V': The number of OV coins that are _vest...

Near line 142: Loose punctuation mark.
Context: ...demand and not a per-block basis. * DV: The number of delegated vesting coins...

Near line 143: Loose punctuation mark.
Context: ... directly in the vesting account. * DF: The number of delegated vested (unloc...

Near line 144: Loose punctuation mark.
Context: ... directly in the vesting account. * BC: The number of OV coins less any coins...

Near line 145: You might be missing the article “the” here.
Context: ...e or delegated). It is considered to be balance of the embedded base account. It is sto...

Near line 149: Possible spelling mistake found.
Context: ...ot on a mandatory per-block basis (e.g. BeginBlocker or EndBlocker). #### Continuously V...

Near line 149: Possible spelling mistake found.
Context: ...per-block basis (e.g. BeginBlocker or EndBlocker). #### Continuously Vesting Accounts ...

Near line 153: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...usly Vesting Accounts To determine the amount of coins that are vested for a given bl...

Near line 156: This phrase is duplicated. You should probably use “Compute Compute” only once.
Context: ...me T, the following is performed: 1. Compute X := T - StartTime 2. Compute Y := EndTime - StartTime 3. Compute V' := OV * (X / Y) 4. Compute V := OV - V' Thus, the total amount ...

Near line 161: Unpaired symbol: ‘'’ seems to be missing
Context: ..., the total amount of vested coins is V' and the remaining amount, V, is _ves...

Near line 188: Possible spelling mistake found.
Context: ... periods could have passed when calling GetVestedCoins, so we must iterate over each period u...

Near line 190: Possible typo: you repeated a word
Context: ...he end of that period is after T. 1. Set CT := StartTime 2. Set V' := 0 For each Period P: 1. Com...

Near line 197: Possible typo: you repeated a word
Context: ... - CT 2. IFX >= P.Length 1. ComputeV' += P.Amount 2. ComputeCT += P.Length` 3. ELSE break ...

Near line 257: Possible spelling mistake found.
Context: ...elegatedVesting, 0) } ``` The x/bank `ViewKeeper` can then provide APIs to determine loc...

Near line 275: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal).
Context: ...opriately handle sending coins based on if the account is a vesting account or not...

Near line 300: Possible typo: you repeated a word
Context: ...D - X(portion ofDthat is free) 4. SetDV += X5. SetDF += Y` ```go func (va VestingAccoun...

Near line 314: Possible spelling mistake found.
Context: ... va.DelegatedFree += y } ``` Note TrackDelegation only modifies the `DelegatedVesting` a...

Near line 314: Possible spelling mistake found.
Context: ...e** TrackDelegation only modifies the DelegatedVesting and DelegatedFree fields, so upstrea...

Near line 314: Possible spelling mistake found.
Context: ...nly modifies the DelegatedVesting and DelegatedFree fields, so upstream callers MUST modif...

Near line 330: Possible spelling mistake found.
Context: ... } // save account... } ``` ### Undelegating For a vesting account attempting to un...

Near line 332: Possible spelling mistake found.
Context: ...ng For a vesting account attempting to undelegate D coins, the following is performed: ...

Near line 334: Possible spelling mistake found.
Context: ...to quirks in the rounding of delegation/undelegation logic. 1. Verify D > 0 2. Compute `X...

Near line 339: Possible typo: you repeated a word
Context: ...n of D that should remain vesting) 4. Set DF -= X 5. Set DV -= Y ```go func (cva ContinuousVe...

Near line 352: Possible spelling mistake found.
Context: ...a.DelegatedVesting -= y } ``` Note TrackUnDelegation only modifies the `DelegatedVesting` a...

Near line 352: Possible spelling mistake found.
Context: ...* TrackUnDelegation only modifies the DelegatedVesting and DelegatedFree fields, so upstrea...

Near line 352: Possible spelling mistake found.
Context: ...nly modifies the DelegatedVesting and DelegatedFree fields, so upstream callers MUST modif...

Near line 354: Possible spelling mistake found.
Context: ... its coins have vested. This is because undelegating free coins are prioritized. Note: ...

Near line 354: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...This is because undelegating free coins are prioritized. Note: The undelegatio...

Near line 356: Possible spelling mistake found.
Context: ...e coins are prioritized. Note: The undelegation (bond refund) amount may exceed the del...

Near line 356: Possible spelling mistake found.
Context: ...ed vesting (bond) amount due to the way undelegation truncates the bond refund, which can in...

Near line 356: Possible spelling mistake found.
Context: ...ge rate (tokens/shares) slightly if the undelegated tokens are non-integral. #### Keepers/...

Near line 376: Possible spelling mistake found.
Context: ... } } ``` ## Keepers & Handlers The VestingAccount implementations reside in `x/auth`. Ho...

Near line 376: Possible spelling mistake found.
Context: ...it methods on the x/bank keeper (e.g. DelegateCoins) opposed to SendCoins and `SubtractC...

Near line 376: Possible spelling mistake found.
Context: ...eeper (e.g. DelegateCoins) opposed to SendCoins and SubtractCoins. In addition, the...

Near line 376: Possible spelling mistake found.
Context: ...egateCoins) opposed to SendCoinsandSubtractCoins`. In addition, the vesting account sho...

Near line 378: Possible spelling mistake found.
Context: ...om other users. Thus, the bank module's MsgSend handler should error if a vesting acco...

Near line 384: Possible spelling mistake found.
Context: ...h vesting and non-vesting accounts, the GenesisAccount struct includes new fields: Vesting,...

Near line 384: Possible spelling mistake found.
Context: ... struct includes new fields: Vesting, StartTime, and EndTime. Accounts meant to be o...

Near line 384: Possible spelling mistake found.
Context: ...new fields: Vesting, StartTime, and EndTime. Accounts meant to be of type `BaseAcc...

Near line 384: Possible spelling mistake found.
Context: ...EndTime. Accounts meant to be of type BaseAccount or any non-vesting type have `Vesting ...

Near line 384: Possible spelling mistake found.
Context: ... The genesis initialization logic (e.g. initFromGenesisState) must parse and return the correct acc...

Near line 384: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ... the correct accounts accordingly based off of these fields. ```go type GenesisAccoun...

Near line 457: Possible agreement error. The noun ‘vest’ seems to be countable.
Context: ... 5. More time passes, 2 more coins vest text V = 6 V' = 4 `...

Near line 464: It appears that a comma is missing.
Context: ... = 4 ``` 6. Sends 2 coins. At this point the account cannot send anymore until f...

Near line 465: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ot send anymore until further coins vest or it receives additional coins. It can st...

Near line 465: Consider inserting a comma before ‘however’.
Context: ...or it receives additional coins. It can still however, delegate. ```text BC = 2 `...

Near line 475: Possible agreement error. The noun ‘vest’ seems to be countable.
Context: ...imple example. 1. Time passes, 5 coins vest ```text V = 5 V' = 5 `...

Near line 497: Possible spelling mistake found.
Context: ... delegation to A now worth 2.5 coins 5. Undelegate from validator A (2.5 coins) ```te...

Near line 504: Possible spelling mistake found.
Context: ... 2.5 BC = 0 + 2.5 = 2.5 ``` 6. Undelegate from validator B (5 coins). The account...

Near line 506: Consider inserting a comma before ‘however’.
Context: ... coins or until more coins vest. It can still however, delegate. ```text DV = 5 - 2.5...

Near line 519: You might be missing the article “the” here.
Context: ...ll be released over 1 year, with 1/4 of tokens vesting each quarter. The vesting sched...

Near line 544: Possible agreement error. The noun ‘vest’ seems to be countable.
Context: ...` 2. Vesting period 1 passes, 25 coins vest ```text V = 75 V' = 25 ...

Near line 558: Possible agreement error. The noun ‘vest’ seems to be countable.
Context: ...` 4. Vesting period 2 passes, 25 coins vest ```text V = 50 V' = 50 ...

Near line 567: Possible spelling mistake found.
Context: ... 50 V' = 50 ``` ## Glossary * OriginalVesting: The amount of coins (per denomination)...

Near line 567: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...`` ## Glossary * OriginalVesting: The amount of coins (per denomination) that are in...

Near line 569: Possible spelling mistake found.
Context: ...ount. These coins are set at genesis. * StartTime: The BFT time at which a vesting accoun...

Near line 570: Possible spelling mistake found.
Context: ...ich a vesting account starts to vest. * EndTime: The BFT time at which a vesting accoun...

Near line 571: Possible spelling mistake found.
Context: ...ch a vesting account is fully vested. * DelegatedFree: The tracked amount of coins (per denom...

Near line 571: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ly vested. * DelegatedFree: The tracked amount of coins (per denomination) that are de...

Near line 572: Did you mean “at a time”, “at the time”, or “at times”?
Context: ...ing account that have been fully vested at time of delegation. * DelegatedVesting: The ...

Near line 573: Possible spelling mistake found.
Context: ...n fully vested at time of delegation. * DelegatedVesting: The tracked amount of coins (per denom...

Near line 573: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...gation. * DelegatedVesting: The tracked amount of coins (per denomination) that are de...

Near line 574: Did you mean “at a time”, “at the time”, or “at times”?
Context: ...rom a vesting account that were vesting at time of delegation. * ContinuousVestingAccou...

Near line 575: Possible spelling mistake found.
Context: ...t were vesting at time of delegation. * ContinuousVestingAccount: A vesting account implementation that ...

Near line 577: Possible spelling mistake found.
Context: ... that vests coins linearly over time. * DelayedVestingAccount: A vesting account implementation that ...

Near line 579: Possible spelling mistake found.
Context: ...ully vests all coins at a given time. * PeriodicVestingAccount: A vesting account implementation that ...

Near line 581: Possible spelling mistake found.
Context: ...cording to a custom vesting schedule. * PermanentLockedAccount: It does not ever release coins, lockin...

Near line 591: Possible spelling mistake found.
Context: ...e using the CLI. ### Transactions The tx commands allow users to interact with ...

Near line 597: This sentence does not start with an uppercase letter.
Context: ...``bash simd tx vesting --help ``` #### create-periodic-vesting-account The create-periodic-vesting-account ...

Near line 599: Possible typo: you repeated a word
Context: ...ds are sequential, in that the duration of of a period only starts at the end of the ...

x/gov/README.md (365)

Near line 10: Possible spelling mistake found.
Context: ...hich was first described in the [Cosmos Whitepaper](https://cosmos.network/about/whitepape...

Near line 20: Possible spelling mistake found.
Context: ...ants can vote on proposals that reached MinDeposit and entered voting period. * **Inherita...

Near line 21: Possible spelling mistake found.
Context: ...eriod. * Inheritance and penalties: Delegators inherit their validator's vote if they ...

Near line 26: The abbreviation/initialism is missing a period after the last letter.
Context: ...his module is in use on the Cosmos Hub (a.k.a gaia)...

Near line 26: Possible spelling mistake found.
Context: ...ule is in use on the Cosmos Hub (a.k.a gaia). Feat...

Near line 43: Possible spelling mistake found.
Context: ...e-types) * Deposit * ValidatorGovInfo * [Stores](#store...

Near line 52: Possible spelling mistake found.
Context: ...Vote](#vote-1) * Events * EndBlocker * Handlers...

Near line 70: Possible spelling mistake found.
Context: ...* Once deposit reaches a certain value (MinDeposit), proposal is confirmed and vote ope...

Near line 71: Possible spelling mistake found.
Context: ...pens. Bonded Atom holders can then send TxGovVote transactions to vote on the proposal...

Near line 80: Possible spelling mistake found.
Context: ...count can submit proposals by sending a MsgSubmitProposal transaction. Once a proposal is submit...

Near line 81: Possible spelling mistake found.
Context: ...bmitted, it is identified by its unique proposalID. #### Proposal Messages A proposal i...

Near line 85: An accent character was used instead of an apostrophe.
Context: ...ssages A proposal includes an array of sdk.Msgs which are executed automatically if the...

Near line 86: Possible spelling mistake found.
Context: ...messages are executed by the governance ModuleAccount itself. Modules such as x/upgrade, t...

Near line 87: Possible subject-verb agreement error detected.
Context: ...self. Modules such as x/upgrade, that want to allow certain messages to be execute...

Near line 87: Possible missing comma found.
Context: ...n messages to be executed by governance only should add a whitelist within the respe...

Near line 90: Possible spelling mistake found.
Context: ...reached. The governance module uses the MsgServiceRouter to check that these messages are corre...

Near line 94: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...eck. :::warning Ultimately, governance is able to execute any proposal, even if they were...

Near line 94: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...n't meant to be executed by governance (ie. no authority present). Messages without...

Near line 95: Possible spelling mistake found.
Context: ...eant to be executed by users. Using the MsgSudoExec message in a proposal, let governance ...

Near line 95: This is normally spelled as one word.
Context: ...cute any message, effectively acting as super user. ::: ### Deposit To prevent spam, pro...

Near line 101: Possible spelling mistake found.
Context: ...h a deposit in the coins defined by the MinDeposit param. When a proposal is submitted, ...

Near line 101: Possible spelling mistake found.
Context: ...n the coins defined by the MinDeposit param. When a proposal is submitted, it has ...

Near line 103: The usual collocation for “accompany” is “by”, not “with”.
Context: ...n a proposal is submitted, it has to be accompanied with a deposit that must be strictly positiv...

Near line 104: Possible spelling mistake found.
Context: ...rictly positive, but can be inferior to MinDeposit. The submitter doesn't need to pay for...

Near line 106: Possible spelling mistake found.
Context: ...tays there until its deposit passes the MinDeposit. Other token holders can increase the ...

Near line 108: Possible spelling mistake found.
Context: ...saction. If a proposal doesn't pass the MinDeposit before the deposit end time (the time ...

Near line 110: Possible spelling mistake found.
Context: ...d the deposit will be burned (see x/gov EndBlocker). When a proposal deposit passes the `...

Near line 111: Possible spelling mistake found.
Context: ...r). When a proposal deposit passes the MinDeposit` threshold (even during the proposal su...

Near line 115: Possible spelling mistake found.
Context: ...pt in escrow and held by the governance ModuleAccount until the proposal is finalized (passe...

Near line 124: Possible spelling mistake found.
Context: ...ositor (transferred from the governance ModuleAccount). * When the proposal is vetoed with g...

Near line 127: Possible spelling mistake found.
Context: ...ts will be burned from the governance ModuleAccount and the proposal information along wit...

Near line 136: Consider using “who” when you are referring to people instead of objects.
Context: ... Participants Participants are users that have the right to vote on proposals. On...

Near line 137: Possible spelling mistake found.
Context: ..., participants are bonded Atom holders. Unbonded Atom holders and other users do not get...

Near line 141: Possible spelling mistake found.
Context: ...hat when participants have bonded and unbonded Atoms, their voting power is calculated...

Near line 145: Possible spelling mistake found.
Context: ... Voting period Once a proposal reaches MinDeposit, it immediately enters Voting period...

Near line 162: This sentence does not start with an uppercase letter.
Context: ... * Spam / Option Spam NoWithVeto counts as No but also adds a Veto vote. `A...

Near line 166: Possible spelling mistake found.
Context: ... add a ‘Not Urgent’ option that casts a NoWithVeto vote.* #### Weighted Votes [ADR-037]...

Near line 170: Unpaired symbol: ‘[’ seems to be missing
Context: ...o` vote.* #### Weighted Votes [ADR-037](https://github.com/cosmos/cosmos-sdk/bl...

Near line 170: Possible spelling mistake found.
Context: ...he weighted vote feature which allows a staker to split their votes into several votin...

Near line 172: Possible spelling mistake found.
Context: ...tly, it is not possible for them to do "passthrough voting" and giving their users voting r...

Near line 174: Possible spelling mistake found.
Context: ...ted vote on chain, we use the following Protobuf message. ```protobuf reference https:/...

Near line 186: Possible spelling mistake found.
Context: ...developer via a config parameter, named MaxVoteOptionsLen, which gets passed into the gov keeper...

Near line 198: It seems that a comma is missing.
Context: ...oposal for the result to be valid. ### Yes Quorum Yes quorum is a more restrictiv...

Near line 199: It seems that a comma is missing.
Context: ...he result to be valid. ### Yes Quorum Yes quorum is a more restrictive quorum tha...

Near line 201: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...minimum percentage of voting power that needs to have voted Yes for the proposal to pa...

Near line 203: Possible spelling mistake found.
Context: ... only Yes and No votes. By default, YesQuorum is set to 0, which means no minimum. ...

Near line 237: Possible spelling mistake found.
Context: ...sts if more than 1/3rd of all votes are NoWithVeto votes. Note, both of these values are...

Near line 238: Possible spelling mistake found.
Context: ...th of these values are derived from the TallyParams on-chain parameter, which is modifiabl...

Near line 240: Possible spelling mistake found.
Context: ... This means that proposals are accepted iff: * There exist bonded tokens. * Quorum...

Near line 245: Possible spelling mistake found.
Context: ...is inferior to 1/1. * The proportion of NoWithVeto votes is inferior to 1/3, including ...

Near line 254: Possible spelling mistake found.
Context: ... namely, 66.7%. #### Inheritance If a delegator does not vote, it will inherit its vali...

Near line 256: Possible spelling mistake found.
Context: ...l inherit its validator vote. * If the delegator votes before its validator, it will not...

Near line 258: Possible spelling mistake found.
Context: ...t from the validator's vote. * If the delegator votes after its validator, it will over...

Near line 260: Possible spelling mistake found.
Context: ...sible that the vote will close before delegators have a chance to react and override t...

Near line 269: Possible spelling mistake found.
Context: ... permissioned keys that could only sign txs from certain modules. For the MVP, the ...

Near line 269: Possible spelling mistake found.
Context: ...This address corresponds to a different PrivKey than the CometBFT PrivKey which is resp...

Near line 269: Possible spelling mistake found.
Context: ...esponds to a different PrivKey than the CometBFT PrivKey which is responsible for signin...

Near line 269: Possible spelling mistake found.
Context: ...o a different PrivKey than the CometBFT PrivKey which is responsible for signing consen...

Near line 269: Possible spelling mistake found.
Context: ...ernance transactions with the sensitive CometBFT PrivKey. #### Burnable Params There a...

Near line 269: Possible spelling mistake found.
Context: ...ransactions with the sensitive CometBFT PrivKey. #### Burnable Params There are three...

Near line 271: Possible spelling mistake found.
Context: ...sitive CometBFT PrivKey. #### Burnable Params There are three parameters that define...

Near line 275: This sentence does not start with an uppercase letter.
Context: ...ed to the depositors. * BurnVoteVeto burns the proposal deposit if the proposal ge...

Near line 276: This sentence does not start with an uppercase letter.
Context: ...roposal gets vetoed. * BurnVoteQuorum burns the proposal deposit if the proposal de...

Near line 277: This sentence does not start with an uppercase letter.
Context: ... quorum. * BurnProposalDepositPrevote burns the proposal deposit if it does not ent...

Near line 285: This sentence does not start with an uppercase letter.
Context: ...State ### Constitution Constitution is found in the genesis state. It is a st...

Near line 288: Possible spelling mistake found.
Context: ...ture development * set expectations for delegators * set expectations for validators * def...

Near line 290: Possible spelling mistake found.
Context: ...s * define the chain's relationship to "meatspace" entities, like a foundation or corpora...

Near line 295: This sentence does not start with an uppercase letter.
Context: ...ations on governance exist, if any? * is it okay for the community to slash the ...

Near line 296: Possible spelling mistake found.
Context: ...sh" a validator who is using unapproved MEV? (viz: commonwealth.im/osmosis) * In ...

Near line 298: When specifying a month and year, the comma is unnecessary.
Context: ...uld validators do? * Terra crash of May, 2022, saw validators choose to run a new bin...

Near line 298: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...that had not been approved by governance, because the governance token had been inflated ...

Near line 300: This sentence does not start with an uppercase letter.
Context: ...purpose of the chain, specifically? * best example of this is the Cosmos hub, wher...

Near line 304: Possible spelling mistake found.
Context: ...ange over time by a pull request to the cosmos-sdk that allows for the constitution to be ...

Near line 304: Possible spelling mistake found.
Context: ... be changed by governance. Communities whishing to make amendments to their original co...

Near line 304: Consider shortening this phrase to strengthen your wording.
Context: ...by governance. Communities whishing to make amendments to their original constitution should use ...

Near line 314: Consider using “arise” to strengthen your wording.
Context: ...nesis, so that when difficult questions come up, the constutituon can provide guidance ...

Near line 314: Possible spelling mistake found.
Context: ...t when difficult questions come up, the constutituon can provide guidance to the community. ...

Near line 318: This sentence does not start with an uppercase letter.
Context: ...e community. ### Proposals Proposal objects are used to tally votes and generally t...

Near line 319: It seems that one apostrophe is unnecessary.
Context: ...ate. They contain an array of arbitrary sdk.Msg's which the governance module will attemp...

Near line 321: This abbreviation for “identification” is spelled all-uppercase.
Context: ...Proposal's are identified by a unique id and contains a series of timestamps: `s...

Near line 329: Possible missing comma found.
Context: ...a set of messages to explain its purpose but need some greater justification and all...

Near line 333: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ta` field allows custom use for networks, however, it is expected that the field contains ...

Near line 335: Possible spelling mistake found.
Context: ...ome form of CID using a system such as [IPFS](https://docs.ipfs.io/concepts/content-...

Near line 351: The verb form ‘are’ does not appear to fit in this context.
Context: ...keeper as a config. The default maximum length are: for the title 255 characters, for the ...

Near line 351: Make sure that ‘the one of’ is correct and that ‘one’ is a pronoun. Possibly, the ‘the’ is unnecessary or ‘of’ is better expressed with a preposition such as ‘about’ or ‘in’.
Context: ... for summary 10200 characters (40 times the one of the title). #### Writing a module that...

Near line 355: Possible missing comma found.
Context: ...spects of a chain, or of the individual modules that you may want to use governance to ...

Near line 356: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...as changing various parameters. This is very simple to do. First, write out your message ty...

Near line 357: Possible spelling mistake found.
Context: ...First, write out your message types and MsgServer implementation. Add an authority fie...

Near line 358: Possible missing comma found.
Context: ...tation. Add an authority field to the keeper which will be populated in the construc...

Near line 359: Add a space between sentences.
Context: ...tor with the governance module account: govKeeper.GetGovernanceAccount().GetAddress(). Then for the methods i...

Near line 364: Possible spelling mistake found.
Context: ...e executed by governance if embedded in MsgSudoExec. ::: ### Parameters and base types `...

Near line 369: This sentence does not start with an uppercase letter.
Context: ...Parameters and base types Parameters define the rules according to which votes are ...

Near line 372: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...d, a new parameter set has to be created and the previous one rendered inactive. ##...

Near line 374: Possible spelling mistake found.
Context: ...e previous one rendered inactive. #### DepositParams ```protobuf reference https://github.c...

Near line 380: Possible spelling mistake found.
Context: ...os/gov/v1/gov.proto#L152-L162 #### VotingParams protobuf reference https://github.c...

Near line 386: Possible spelling mistake found.
Context: ...os/gov/v1/gov.proto#L164-L168 #### TallyParams protobuf reference https://github.c...

Near line 392: Possible spelling mistake found.
Context: ... ``` Parameters are stored in a global GlobalParams KVStore. Additionally, we introduce s...

Near line 392: Possible spelling mistake found.
Context: ...s are stored in a global GlobalParams KVStore. Additionally, we introduce some basic...

Near line 416: Possible spelling mistake found.
Context: ...osmos/gov/v1/gov.proto#L38-L49 ``` ### ValidatorGovInfo This type is used in a temp map when t...

Near line 430: Possible spelling mistake found.
Context: ... } ``` ## Stores :::note Stores are KVStores in the multi-store. The key to find the...

Near line 433: Possible spelling mistake found.
Context: ...ameter in the list ::: We will use one KVStore Governance to store four mappings: *...

Near line 435: Possible spelling mistake found.
Context: ... store four mappings: * A mapping from proposalID|'proposal' to Proposal. * A mapping ...

Near line 436: Possible spelling mistake found.
Context: ...posal'toProposal. * A mapping from proposalID|'addresses'|addresstoVote`. This ma...

Near line 438: Possible spelling mistake found.
Context: ... their vote by doing a range query on proposalID:addresses. * A mapping from `ParamsKey...

Near line 439: Possible spelling mistake found.
Context: ...proposalID:addresses. * A mapping from ParamsKey|'Params'toParams`. This map allows ...

Near line 439: Possible spelling mistake found.
Context: ... A mapping from ParamsKey|'Params' to Params. This map allows to query all x/gov ...

Near line 439: Did you mean “querying”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ...|'Params'toParams`. This map allows to query all x/gov params. For pseudocode p...

Near line 440: Possible spelling mistake found.
Context: ...`. This map allows to query all x/gov params. For pseudocode purposes, here are t...

Near line 444: Loose punctuation mark.
Context: ...rite in stores: * load(StoreKey, Key): Retrieve item stored at key Key in st...

Near line 444: Possible spelling mistake found.
Context: ...ored at key Key in store found at key StoreKey in the multistore * `store(StoreKey, K...

Near line 444: Possible spelling mistake found.
Context: ...in store found at key StoreKey in the multistore * store(StoreKey, Key, value): Write ...

Near line 445: Possible spelling mistake found.
Context: ...lueat keyKeyin store found at keyStoreKey` in the multistore ### Proposal Proces...

Near line 445: Possible spelling mistake found.
Context: ...in store found at key StoreKey in the multistore ### Proposal Processing Queue **Store...

Near line 451: Loose punctuation mark.
Context: ... Store: * ProposalProcessingQueue: A queue queue[proposalID] containing ...

Near line 451: Possible spelling mistake found.
Context: ...* * ProposalProcessingQueue: A queue queue[proposalID] containing all the ProposalIDs of...

Near line 451: Possible spelling mistake found.
Context: ... queue[proposalID] containing all the ProposalIDs of proposals that reached MinDeposit...

Near line 452: Possible spelling mistake found.
Context: ...ProposalIDs of proposals that reached MinDeposit. During each EndBlock, all the pro...

Near line 452: Possible spelling mistake found.
Context: ... that reached MinDeposit. During each EndBlock, all the proposals that have reached...

Near line 453: Possible typo: you repeated a whitespace
Context: ...d of their voting period are processed. To process a finished proposal, the appl...

Near line 466: Did you mean “submitting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ... any messages, a legacy proposal allows to submit a set of pre-defined proposals. These p...

Near line 475: Possible spelling mistake found.
Context: ...s can be submitted by any account via a MsgSubmitProposal or a MsgSubmitMultipleChoiceProposal...

Near line 475: Possible spelling mistake found.
Context: ... account via a MsgSubmitProposal or a MsgSubmitMultipleChoiceProposal transaction. ```protobuf reference ht...

Near line 487: Possible spelling mistake found.
Context: ...itting a multiple choice proposal using MsgSubmitProposal is invalid, as vote options cannot be ...

Near line 490: Add a space between sentences.
Context: ...ote options cannot be defined. ::: All sdk.Msgs passed into the messages field of a ...

Near line 490: Possible spelling mistake found.
Context: ...passed into themessagesfield of aMsgSubmitProposal` message must be registered in the app'...

Near line 491: Possible spelling mistake found.
Context: ...message must be registered in the app's MsgServiceRouter. Each of these messages must have one ...

Near line 493: Possible spelling mistake found.
Context: ...data length must not be larger than the maxMetadataLen config passed into the gov keeper. The...

Near line 494: Possible spelling mistake found.
Context: ... config passed into the gov keeper. The initialDeposit must be strictly positive and conform ...

Near line 494: Possible spelling mistake found.
Context: ...ly positive and conform to the accepted denom of the MinDeposit param. **State mod...

Near line 494: Possible spelling mistake found.
Context: ...nd conform to the accepted denom of the MinDeposit param. State modifications: * Ge...

Near line 494: Possible spelling mistake found.
Context: ... the accepted denom of the MinDeposit param. State modifications: * Generate ...

Near line 500: Possible spelling mistake. ‘Initialise’ is British English.
Context: ... proposalID * Create new Proposal * Initialise Proposal's attributes * Decrease bala...

Near line 502: Possible spelling mistake found.
Context: ...ance of sender by InitialDeposit * If MinDeposit is reached: * Push proposalID in `...

Near line 503: Possible spelling mistake found.
Context: ... * If MinDeposit is reached: * Push proposalID in ProposalProcessingQueue * Transfe...

Near line 504: Possible spelling mistake found.
Context: ...in ProposalProcessingQueue * Transfer InitialDeposit from the Proposer to the governance ...

Near line 508: Add a space between sentences.
Context: ...posit Once a proposal is submitted, if Proposal.TotalDeposit < ActiveParam.MinDeposit, Atom holders...

Near line 508: Possible missing comma found.
Context: ...Deposit < ActiveParam.MinDeposit, Atom holders can send MsgDeposit` transactions to i...

Near line 508: Possible spelling mistake found.
Context: ...aram.MinDeposit, Atom holders can send MsgDeposit` transactions to increase the proposal'...

Near line 511: Possible spelling mistake found.
Context: ...posal's deposit. A deposit is accepted iff: * The proposal exists * The proposal ...

Near line 515: Consider using either the past participle “conformed” or the present participle “conforming” here.
Context: ...voting period * The deposited coins are conform to the accepted denom from the `MinDepo...

Near line 515: Possible spelling mistake found.
Context: ...sited coins are conform to the accepted denom from the MinDeposit param ```protobu...

Near line 515: Possible spelling mistake found.
Context: ... conform to the accepted denom from the MinDeposit param ```protobuf reference https://g...

Near line 515: Possible spelling mistake found.
Context: ...he accepted denom from the MinDeposit param ```protobuf reference https://github.c...

Near line 525: Add a space between sentences.
Context: ...ender in proposal.Deposits * Increase proposal.TotalDeposit by sender's deposit * If `MinDeposit...

Near line 526: Possible spelling mistake found.
Context: ...otalDepositby sender'sdeposit* IfMinDepositis reached: * PushproposalIDin...

Near line 527: Possible spelling mistake found.
Context: ... * If MinDeposit is reached: * Push proposalID in ProposalProcessingQueueEnd * Tran...

Near line 527: The preposition ‘to’ seems more likely in this position.
Context: ...ositis reached: * PushproposalIDinProposalProcessingQueueEnd` * Transfer...

Near line 532: Add a space between sentences.
Context: ...ernance ModuleAccount ### Vote Once ActiveParam.MinDeposit is reached, voting period starts. From...

Near line 533: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...starts. From there, bonded Atom holders are able to send MsgVote transactions to cast the...

Near line 533: Possible spelling mistake found.
Context: ...e, bonded Atom holders are able to send MsgVote transactions to cast their vote on the...

Near line 544: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ...:** * Record Vote of sender :::note Gas cost for this message has to take into ...

Near line 545: ‘take into account’ might be wordy. Consider a shorter alternative.
Context: ...::note Gas cost for this message has to take into account the future tallying of the vote in EndB...

Near line 545: Possible spelling mistake found.
Context: ...ount the future tallying of the vote in EndBlocker. ::: ## Events The governance module ...

Near line 552: Possible spelling mistake found.
Context: ...module emits the following events: ### EndBlocker | Type | Attribute Key ...

Near line 554: Possible typo: you repeated a whitespace
Context: ...ollowing events: ### EndBlocker | Type | Attribute Key | Attribute Value | |...

Near line 554: Possible typo: you repeated a whitespace
Context: ...ker | Type | Attribute Key | Attribute Value | | -----------------...

Near line 554: Possible typo: you repeated a whitespace
Context: ... | Attribute Key | Attribute Value | | ----------------- | --------------- ...

Near line 556: Possible typo: you repeated a whitespace
Context: ...---- | | inactive_proposal | proposal_id | {proposalID} | | inactive_proposal...

Near line 556: Possible typo: you repeated a whitespace
Context: ...roposal | proposal_id | {proposalID} | | inactive_proposal | proposal_result ...

Near line 558: Possible typo: you repeated a whitespace
Context: ...t | {proposalResult} | | active_proposal | proposal_id | {proposalID} | |...

Near line 558: Possible typo: you repeated a whitespace
Context: ...ult} | | active_proposal | proposal_id | {proposalID} | | active_proposal ...

Near line 558: Possible typo: you repeated a whitespace
Context: ...posal | proposal_id | {proposalID} | | active_proposal | proposal_result ...

Near line 559: Possible typo: you repeated a whitespace
Context: ... | {proposalID} | | active_proposal | proposal_result | {proposalResult} | ...

Near line 563: Possible spelling mistake found.
Context: ... {proposalResult} | ### Handlers #### MsgSubmitProposal, MsgSubmitMultipleChoiceProposal | Typ...

Near line 563: Possible spelling mistake found.
Context: ... ### Handlers #### MsgSubmitProposal, MsgSubmitMultipleChoiceProposal | Type | Attribute Key ...

Near line 565: Possible typo: you repeated a whitespace
Context: ... MsgSubmitMultipleChoiceProposal | Type | Attribute Key | Attribute Value ...

Near line 565: Possible typo: you repeated a whitespace
Context: ...l | Type | Attribute Key | Attribute Value | | ------------------...

Near line 567: Possible typo: you repeated a whitespace
Context: ...-- | --------------- | | submit_proposal | proposal_id | {proposalID} ...

Near line 567: Possible typo: you repeated a whitespace
Context: ...-- | | submit_proposal | proposal_id | {proposalID} | | submit_proposal [0...

Near line 567: Possible typo: you repeated a whitespace
Context: ... | proposal_id | {proposalID} | | submit_proposal [0] | voting_period_...

Near line 568: Possible typo: you repeated a whitespace
Context: ...[0] | voting_period_start | {proposalID} | | proposal_deposit | amount ...

Near line 569: Possible typo: you repeated a whitespace
Context: ...t | {proposalID} | | proposal_deposit | amount | {depositAmount} ...

Near line 569: Possible typo: you repeated a whitespace
Context: ...lID} | | proposal_deposit | amount | {depositAmount} | | proposal_deposit ...

Near line 570: Possible typo: you repeated a whitespace
Context: ... | {depositAmount} | | proposal_deposit | proposal_id | {proposalID} ...

Near line 570: Possible typo: you repeated a whitespace
Context: ...t} | | proposal_deposit | proposal_id | {proposalID} | | message ...

Near line 570: Possible typo: you repeated a whitespace
Context: ... | proposal_id | {proposalID} | | message | module ...

Near line 571: Possible typo: you repeated a whitespace
Context: ...id | {proposalID} | | message | module | governance ...

Near line 571: Possible typo: you repeated a whitespace
Context: ...lID} | | message | module | governance | | message ...

Near line 571: Possible typo: you repeated a whitespace
Context: ... | module | governance | | message | action ...

Near line 572: Possible typo: you repeated a whitespace
Context: ... | governance | | message | action | submit_proposal ...

Near line 572: Possible typo: you repeated a whitespace
Context: ...ce | | message | action | submit_proposal | | message ...

Near line 573: Possible typo: you repeated a whitespace
Context: ... | submit_proposal | | message | sender | {senderAddress} ...

Near line 573: Possible typo: you repeated a whitespace
Context: ...roposal | | message | sender | {senderAddress} | * [0] Event only em...

Near line 577: Possible spelling mistake found.
Context: ...iod starts during the submission. #### MsgVote | Type | Attribute Key | Attr...

Near line 579: Possible typo: you repeated a whitespace
Context: ...ng the submission. #### MsgVote | Type | Attribute Key | Attribute Value | | --...

Near line 581: Possible typo: you repeated a whitespace
Context: ...------------- | | proposal_vote | option | {voteOption} | | proposal_vote | pr...

Near line 581: Possible typo: you repeated a whitespace
Context: ...osal_vote | option | {voteOption} | | proposal_vote | proposal_id | {pro...

Near line 582: Possible typo: you repeated a whitespace
Context: ...tion} | | proposal_vote | proposal_id | {proposalID} | | message | mo...

Near line 582: Possible typo: you repeated a whitespace
Context: ...osal_vote | proposal_id | {proposalID} | | message | module | gove...

Near line 583: Possible typo: you repeated a whitespace
Context: ...posal_id | {proposalID} | | message | module | governance | | me...

Near line 583: Possible typo: you repeated a whitespace
Context: ...roposalID} | | message | module | governance | | message | ac...

Near line 583: Possible typo: you repeated a whitespace
Context: ...ssage | module | governance | | message | action | vote...

Near line 584: Possible typo: you repeated a whitespace
Context: ...ule | governance | | message | action | vote | | me...

Near line 584: Possible typo: you repeated a whitespace
Context: ...vernance | | message | action | vote | | message | se...

Near line 584: Possible typo: you repeated a whitespace
Context: ...| | message | action | vote | | message | sender | {sen...

Near line 585: Possible typo: you repeated a whitespace
Context: ...ion | vote | | message | sender | {senderAddress} | ###...

Near line 585: Possible typo: you repeated a whitespace
Context: ...te | | message | sender | {senderAddress} | #### MsgVoteWeighte...

Near line 587: Possible spelling mistake found.
Context: ...sender | {senderAddress} | #### MsgVoteWeighted | Type | Attribute Key | Attr...

Near line 589: Possible typo: you repeated a whitespace
Context: ...Address} | #### MsgVoteWeighted | Type | Attribute Key | Attribute Value ...

Near line 589: Possible typo: you repeated a whitespace
Context: ... | Attribute Key | Attribute Value | | ------------- | ------------- | ----...

Near line 591: Possible typo: you repeated a whitespace
Context: ...------------- | | proposal_vote | option | {weightedVoteOptions} | | proposal_vot...

Near line 592: Possible typo: you repeated a whitespace
Context: ...Options} | | proposal_vote | proposal_id | {proposalID} | | message ...

Near line 592: Possible typo: you repeated a whitespace
Context: ...osal_vote | proposal_id | {proposalID} | | message | module | gove...

Near line 593: Possible typo: you repeated a whitespace
Context: ...id | {proposalID} | | message | module | governance ...

Near line 593: Possible typo: you repeated a whitespace
Context: ...lID} | | message | module | governance | | message ...

Near line 593: Possible typo: you repeated a whitespace
Context: ...ssage | module | governance | | message | action | vote...

Near line 594: Possible typo: you repeated a whitespace
Context: ... | governance | | message | action | vote ...

Near line 594: Possible typo: you repeated a whitespace
Context: ...ce | | message | action | vote | | message ...

Near line 594: Possible typo: you repeated a whitespace
Context: ...| | message | action | vote | | message | sender | {sen...

Near line 595: Possible typo: you repeated a whitespace
Context: ... | vote | | message | sender | {senderAddress} ...

Near line 595: Possible typo: you repeated a whitespace
Context: ... | | message | sender | {senderAddress} | #### MsgDepos...

Near line 595: Possible typo: you repeated a whitespace
Context: ... | sender | {senderAddress} | #### MsgDeposit | Type ...

Near line 597: Possible spelling mistake found.
Context: ... | {senderAddress} | #### MsgDeposit | Type | Attribute Key...

Near line 599: Possible typo: you repeated a whitespace
Context: ...ddress} | #### MsgDeposit | Type | Attribute Key | Attribute Value ...

Near line 599: Possible typo: you repeated a whitespace
Context: ... | Type | Attribute Key | Attribute Value | | ------------------...

Near line 601: Possible typo: you repeated a whitespace
Context: ...- | --------------- | | proposal_deposit | amount | {depositAmount} ...

Near line 601: Possible typo: you repeated a whitespace
Context: ...------ | | proposal_deposit | amount | {depositAmount} | | proposal_deposit ...

Near line 602: Possible typo: you repeated a whitespace
Context: ... | {depositAmount} | | proposal_deposit | proposal_id | {proposalID} ...

Near line 602: Possible typo: you repeated a whitespace
Context: ...} | | proposal_deposit | proposal_id | {proposalID} | | proposal_deposit [...

Near line 602: Possible typo: you repeated a whitespace
Context: ... | proposal_id | {proposalID} | | proposal_deposit [0] | voting_period...

Near line 603: Possible typo: you repeated a whitespace
Context: ...[0] | voting_period_start | {proposalID} | | message | module ...

Near line 604: Possible typo: you repeated a whitespace
Context: ...riod_start | {proposalID} | | message | module | governance ...

Near line 604: Possible typo: you repeated a whitespace
Context: ...ID} | | message | module | governance | | message ...

Near line 604: Possible typo: you repeated a whitespace
Context: ... | module | governance | | message | action ...

Near line 605: Possible typo: you repeated a whitespace
Context: ... | governance | | message | action | deposit ...

Near line 605: Possible typo: you repeated a whitespace
Context: ...e | | message | action | deposit | | message ...

Near line 605: Possible typo: you repeated a whitespace
Context: ... | action | deposit | | message | sender ...

Near line 606: Possible typo: you repeated a whitespace
Context: ... | deposit | | message | sender | {senderAddress} ...

Near line 606: Possible typo: you repeated a whitespace
Context: ... | | message | sender | {senderAddress} | * [0] Event only em...

Near line 614: Possible typo: you repeated a whitespace
Context: ...ontains the following parameters: | Key | Type | Example ...

Near line 614: Possible typo: you repeated a whitespace
Context: ...| Key | Type | Example ...

Near line 614: Possible typo: you repeated a whitespace
Context: ... | Type | Example | | ------------------------------- | --...

Near line 616: Possible typo: you repeated a whitespace
Context: ...------------------------ | | min_deposit | array (coins) | [{"denom":"uatom",...

Near line 616: Possible typo: you repeated a whitespace
Context: ...osit | array (coins) | [{"denom":"uatom","amount":"10000000"}...

Near line 616: Possible spelling mistake found.
Context: ... | array (coins) | [{"denom":"uatom","amount":"10000000"}] | | max_...

Near line 616: Possible spelling mistake found.
Context: ... | array (coins) | [{"denom":"uatom","amount":"10000000"}] | | max_deposit_...

Near line 617: Possible typo: you repeated a whitespace
Context: ...unt":"10000000"}] | | max_deposit_period | string (time ns) | "172800000000000" ...

Near line 617: Possible spelling mistake found.
Context: ...osit_period | string (time ns) | "172800000000000" (17280s) ...

Near line 617: Possible typo: you repeated a whitespace
Context: ...t_period | string (time ns) | "172800000000000" (17280s) ...

Near line 617: Possible typo: you repeated a whitespace
Context: ... (time ns) | "172800000000000" (17280s) | | voting_period | st...

Near line 618: Possible typo: you repeated a whitespace
Context: ... (17280s) | | voting_period | string (time ns) | "172800000000000" ...

Near line 618: Possible spelling mistake found.
Context: ...period | string (time ns) | "172800000000000" (17280s) ...

Near line 618: Possible typo: you repeated a whitespace
Context: ...iod | string (time ns) | "172800000000000" (17280s) ...

Near line 618: Possible typo: you repeated a whitespace
Context: ... (time ns) | "172800000000000" (17280s) | | quorum | st...

Near line 619: Possible typo: you repeated a whitespace
Context: ...000000" (17280s) | | quorum | string (dec) | "0.334000000000000...

Near line 619: Possible spelling mistake found.
Context: ...orum | string (dec) | "0.334000000000000000" ...

Near line 619: Possible typo: you repeated a whitespace
Context: ... | string (dec) | "0.334000000000000000" ...

Near line 619: Possible typo: you repeated a whitespace
Context: ...ring (dec) | "0.334000000000000000" | | yes_quorum | st...

Near line 620: Possible typo: you repeated a whitespace
Context: ...0000000" | | yes_quorum | string (dec) | "0.4" ...

Near line 620: Possible spelling mistake found.
Context: ...s_quorum | string (dec) | "0.4" ...

Near line 620: Possible typo: you repeated a whitespace
Context: ...orum | string (dec) | "0.4" ...

Near line 620: Possible typo: you repeated a whitespace
Context: ... | string (dec) | "0.4" | | threshold | st...

Near line 621: Possible typo: you repeated a whitespace
Context: ... | | threshold | string (dec) | "0.500000000000000...

Near line 621: Possible spelling mistake found.
Context: ...reshold | string (dec) | "0.500000000000000000" ...

Near line 621: Possible typo: you repeated a whitespace
Context: ...old | string (dec) | "0.500000000000000000" ...

Near line 621: Possible typo: you repeated a whitespace
Context: ...ring (dec) | "0.500000000000000000" | | veto | st...

Near line 622: Possible typo: you repeated a whitespace
Context: ...0000000000000" | | veto | string (dec) | "0.334000000000000...

Near line 622: Possible spelling mistake found.
Context: ...to | string (dec) | "0.334000000000000000" ...

Near line 622: Possible typo: you repeated a whitespace
Context: ... | string (dec) | "0.334000000000000000" ...

Near line 622: Possible typo: you repeated a whitespace
Context: ...ring (dec) | "0.334000000000000000" | | expedited_threshold | st...

Near line 623: Possible typo: you repeated a whitespace
Context: ... | | expedited_threshold | string (time ns) | "0.667000000000000...

Near line 623: Possible spelling mistake found.
Context: ...ed_threshold | string (time ns) | "0.667000000000000000" ...

Near line 623: Possible typo: you repeated a whitespace
Context: ...threshold | string (time ns) | "0.667000000000000000" ...

Near line 623: Possible typo: you repeated a whitespace
Context: ...ring (time ns) | "0.667000000000000000" | | expedited_voting_period | st...

Near line 624: Possible typo: you repeated a whitespace
Context: ... | | expedited_voting_period | string (time ns) | "86400000000000" (...

Near line 624: Possible spelling mistake found.
Context: ...ed_voting_period | string (time ns) | "86400000000000" (8600s) ...

Near line 624: Possible typo: you repeated a whitespace
Context: ...voting_period | string (time ns) | "86400000000000" (8600s) ...

Near line 624: Possible typo: you repeated a whitespace
Context: ...ng (time ns) | "86400000000000" (8600s) | | expedited_min_deposit | ar...

Near line 625: Possible typo: you repeated a whitespace
Context: ... | | expedited_min_deposit | array (coins) | [{"denom":"uatom",...

Near line 625: Possible typo: you repeated a whitespace
Context: ...ed_min_deposit | array (coins) | [{"denom":"uatom","amount":"50000000"}...

Near line 625: Possible spelling mistake found.
Context: ...osit | array (coins) | [{"denom":"uatom","amount":"50000000"}] | | expe...

Near line 625: Possible spelling mistake found.
Context: ... | array (coins) | [{"denom":"uatom","amount":"50000000"}] | | expedited_qu...

Near line 626: Possible typo: you repeated a whitespace
Context: ...mount":"50000000"}] | | expedited_quorum | string (dec) | "0.5" ...

Near line 626: Possible spelling mistake found.
Context: ...pedited_quorum | string (dec) | "0.5" ...

Near line 626: Possible typo: you repeated a whitespace
Context: ...ted_quorum | string (dec) | "0.5" ...

Near line 626: Possible typo: you repeated a whitespace
Context: ... | string (dec) | "0.5" | | burn_proposal_deposit_prevote | bo...

Near line 627: Possible spelling mistake found.
Context: ... | | burn_proposal_deposit_prevote | bool | false ...

Near line 627: Possible typo: you repeated a whitespace
Context: ... | | burn_proposal_deposit_prevote | bool | false ...

Near line 627: Possible spelling mistake found.
Context: ... | | burn_proposal_deposit_prevote | bool | false ...

Near line 627: Possible typo: you repeated a whitespace
Context: ...| burn_proposal_deposit_prevote | bool | false ...

Near line 627: Possible typo: you repeated a whitespace
Context: ...it_prevote | bool | false | | burn_vote_quorum | bo...

Near line 628: Possible typo: you repeated a whitespace
Context: ... | | burn_vote_quorum | bool | false ...

Near line 628: Possible spelling mistake found.
Context: ... | | burn_vote_quorum | bool | false ...

Near line 628: Possible typo: you repeated a whitespace
Context: ...| burn_vote_quorum | bool | false ...

Near line 628: Possible typo: you repeated a whitespace
Context: ... | bool | false | | burn_vote_veto | bo...

Near line 629: Possible typo: you repeated a whitespace
Context: ... | | burn_vote_veto | bool | true ...

Near line 629: Possible spelling mistake found.
Context: ... | | burn_vote_veto | bool | true ...

Near line 629: Possible typo: you repeated a whitespace
Context: ...| burn_vote_veto | bool | true ...

Near line 629: Possible typo: you repeated a whitespace
Context: ... | bool | true | | min_initial_deposit_ratio | st...

Near line 630: Possible typo: you repeated a whitespace
Context: ... | | min_initial_deposit_ratio | string | "0.1" ...

Near line 630: Possible typo: you repeated a whitespace
Context: ...min_initial_deposit_ratio | string | "0.1" ...

Near line 630: Possible typo: you repeated a whitespace
Context: ..._ratio | string | "0.1" | | proposal_cancel_ratio | st...

Near line 631: Possible typo: you repeated a whitespace
Context: ... | | proposal_cancel_ratio | string (dec) | "0.5" ...

Near line 631: Possible spelling mistake found.
Context: ...oposal_cancel_ratio | string (dec) | "0.5" ...

Near line 631: Possible typo: you repeated a whitespace
Context: ...al_cancel_ratio | string (dec) | "0.5" ...

Near line 631: Possible typo: you repeated a whitespace
Context: ...io | string (dec) | "0.5" | | proposal_cancel_dest | st...

Near line 632: Possible spelling mistake found.
Context: ... | | proposal_cancel_dest | string (address) | "cosmo...

Near line 632: Possible typo: you repeated a whitespace
Context: ... | | proposal_cancel_dest | string (address) | "cosmos1.." or emp...

Near line 632: Possible typo: you repeated a whitespace
Context: ...ancel_dest | string (address) | "cosmos1.." or empty for burn ...

Near line 632: Two consecutive dots
Context: ... | string (address) | "cosmos1.." or empty for burn | | propos...

Near line 632: Possible typo: you repeated a whitespace
Context: ...ddress) | "cosmos1.." or empty for burn | | proposal_cancel_max_period | st...

Near line 633: Possible typo: you repeated a whitespace
Context: ... | | proposal_cancel_max_period | string (dec) | "0.5" ...

Near line 633: Possible spelling mistake found.
Context: ...oposal_cancel_max_period | string (dec) | "0.5" ...

Near line 633: Possible typo: you repeated a whitespace
Context: ...al_cancel_max_period | string (dec) | "0.5" ...

Near line 633: Possible typo: you repeated a whitespace
Context: ..._period | string (dec) | "0.5" | | optimistic_rejected_threshold | st...

Near line 634: Possible typo: you repeated a whitespace
Context: ... | | optimistic_rejected_threshold | string (dec) | "0.1" ...

Near line 634: Possible spelling mistake found.
Context: ...timistic_rejected_threshold | string (dec) | "0.1" ...

Near line 634: Possible typo: you repeated a whitespace
Context: ...stic_rejected_threshold | string (dec) | "0.1" ...

Near line 634: Possible typo: you repeated a whitespace
Context: ..._threshold | string (dec) | "0.1" | | optimistic_authorized_addresses | ar...

Near line 635: Possible typo: you repeated a whitespace
Context: ...rized_addresses | array (addresses) | [] | NOTE: The governance module conta...

Near line 637: Possible missing comma found.
Context: ...nce module contains parameters that are objects unlike other modules. If only a subset ...

Near line 638: Make sure the noun ‘subset’ is in agreement with the verb ‘are’. Beware that some collective nouns (like ‘police’ or ‘team’) can be treated as both singular and plural.
Context: ...modules. If only a subset of parameters are desired to be changed, only they need t...

Near line 641: This expression is usually spelled with a hyphen.
Context: ...entire parameter object structure. ### Message Based Parameters In addition to the paramete...

Near line 645: Possible typo: you repeated a whitespace
Context: ...ers for a given proposal message. | Key | Type | Example ...

Near line 645: Possible typo: you repeated a whitespace
Context: ...roposal message. | Key | Type | Example | | -------...

Near line 645: Possible typo: you repeated a whitespace
Context: ...y | Type | Example | | ------------- | ---------------- | -...

Near line 647: Possible spelling mistake found.
Context: ...------ | | voting_period | string (time ns) | "172800000000000" (17280s) | | yes_q...

Near line 648: Possible typo: you repeated a whitespace
Context: ...172800000000000" (17280s) | | yes_quorum | string (dec) | "0.4" ...

Near line 648: Possible spelling mistake found.
Context: ...0" (17280s) | | yes_quorum | string (dec) | "0.4" | | q...

Near line 648: Possible typo: you repeated a whitespace
Context: ...17280s) | | yes_quorum | string (dec) | "0.4" | | quorum ...

Near line 648: Possible typo: you repeated a whitespace
Context: ...yes_quorum | string (dec) | "0.4" | | quorum | string (dec) | "...

Near line 649: Possible typo: you repeated a whitespace
Context: ... | "0.4" | | quorum | string (dec) | "0.3340000000000000...

Near line 649: Possible spelling mistake found.
Context: ... | | quorum | string (dec) | "0.334000000000000000" | | t...

Near line 649: Possible typo: you repeated a whitespace
Context: ... | | quorum | string (dec) | "0.334000000000000000" | | thresho...

Near line 649: Possible typo: you repeated a whitespace
Context: ...tring (dec) | "0.334000000000000000" | | threshold | string (dec) | "...

Near line 650: Possible typo: you repeated a whitespace
Context: ..."0.334000000000000000" | | threshold | string (dec) | "0.5000000000000000...

Near line 650: Possible spelling mistake found.
Context: ...000000" | | threshold | string (dec) | "0.500000000000000000" | | v...

Near line 650: Possible typo: you repeated a whitespace
Context: ...00" | | threshold | string (dec) | "0.500000000000000000" | | veto ...

Near line 650: Possible typo: you repeated a whitespace
Context: ...tring (dec) | "0.500000000000000000" | | veto | string (dec) | "...

Near line 651: Possible typo: you repeated a whitespace
Context: ... | "0.500000000000000000" | | veto | string (dec) | "0.3340000000000000...

Near line 651: Possible spelling mistake found.
Context: ...000000" | | veto | string (dec) | "0.334000000000000000" | If...

Near line 651: Possible typo: you repeated a whitespace
Context: ...00" | | veto | string (dec) | "0.334000000000000000" | If confi...

Near line 651: Possible typo: you repeated a whitespace
Context: ...tring (dec) | "0.334000000000000000" | If configured, these params will take...

Near line 653: Possible spelling mistake found.
Context: ...0000000000" | If configured, these params will take precedence over the global pa...

Near line 653: Possible spelling mistake found.
Context: ...ms will take precedence over the global params for a specific proposal. :::warning Cu...

Near line 673: This sentence does not start with an uppercase letter.
Context: ...``bash simd query gov --help ``` ##### deposit The deposit command allows users to ...

Near line 725: Possible spelling mistake found.
Context: ... next_key: null total: "0" ``` ##### params The params command allows users to q...

Near line 727: Possible spelling mistake found.
Context: ...ull total: "0" ``` ##### params The params command allows users to query all para...

Near line 968: Possible spelling mistake found.
Context: ...: cosmos1.. ``` #### Transactions The tx commands allow users to interact with ...

Near line 974: This sentence does not start with an uppercase letter.
Context: ... bash simd tx gov --help ##### deposit The deposit command allows users to ...

Near line 991: Possible spelling mistake found.
Context: ...type of proposal. The command returns a draft_proposal.json, to be used by submit-proposal after...

Near line 992: Possible spelling mistake found.
Context: ...it-proposalafter being completed. Thedraft_metadata.json` is meant to be uploaded to [IPFS](#met...

Near line 992: Possible spelling mistake found.
Context: ...adata.json` is meant to be uploaded to IPFS. ```bash simd tx gov draft...

Near line 998: This sentence does not start with an uppercase letter.
Context: ...h simd tx gov draft-proposal ``` ##### submit-proposal The submit-proposal command allows u...

Near line 1013: Possible spelling mistake found.
Context: ...oposal.json --from cosmos1.. where `proposal.json` contains: json { "messages": [ ...

Near line 1054: Possible spelling mistake found.
Context: ...00stake" --from cosmos1.. Example (`param-change`): bash simd tx gov submit-legacy-p...

Near line 1077: Possible spelling mistake found.
Context: ...cancel_ratiowill be burned or sent toProposalCancelDestaddress , ifProposalCancelDest` is e...

Near line 1077: Put a space after the comma, but not before the comma.
Context: ... or sent to ProposalCancelDest address , if ProposalCancelDest is empty then d...

Near line 1077: Possible spelling mistake found.
Context: ...nt to ProposalCancelDest address , if ProposalCancelDest is empty then deposits will be burned....

Near line 1077: Possible spelling mistake found.
Context: ...he remaining deposits will be sent to depositers. ```bash simd tx gov cancel-proposal [...

Near line 1513: Possible spelling mistake found.
Context: ...on": { "total": "1" } } ``` #### Params The Params endpoint allows users to ...

Near line 1515: Possible spelling mistake found.
Context: ...total": "1" } } ``` #### Params The Params endpoint allows users to query all par...

Near line 1721: Possible spelling mistake found.
Context: ...on": { "total": "1" } } ``` #### TallyResult The TallyResult endpoint allows user...

Near line 1723: Possible spelling mistake found.
Context: ...": "1" } } ``` #### TallyResult The TallyResult endpoint allows users to query the tal...

Near line 1790: This sentence does not start with an uppercase letter.
Context: ...govmodule using REST endpoints. #### proposal Theproposals` endpoint allows users ...

Near line 2197: Possible spelling mistake found.
Context: ... null, "total": "1" } } ``` #### params The params endpoint allows users to ...

Near line 2199: Possible spelling mistake found.
Context: ...total": "1" } } ``` #### params The params endpoint allows users to query all par...

Near line 2459: Did you mean: “By default,”?
Context: ...t the on-chain actions they are taking. By default all metadata fields have a 255 characte...

Near line 2459: Possible spelling mistake found.
Context: ...h field where metadata can be stored in json format, either on-chain or off-chain de...

Near line 2459: Possible spelling mistake found.
Context: ...ere we provide a recommendation for the json structure and where the data should be ...

Near line 2459: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... of proposals made by all groups may be quite large. Second, that client applications such ...

Near line 2463: Possible spelling mistake found.
Context: .... ### Proposal Location: off-chain as json object stored on IPFS (mirrors [group p...

Near line 2463: Possible spelling mistake found.
Context: ...ion: off-chain as json object stored on IPFS (mirrors [group proposal](../group/READ...

Near line 2483: Possible spelling mistake found.
Context: ...y. ::: ### Vote Location: on-chain as json within 255 character limit (mirrors [gr...

Near line 2483: When ‘255-character’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...Vote Location: on-chain as json within 255 character limit (mirrors [group vote](../group/RE...

Path-based Instructions (4)

client/keys/rename_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

x/tx/signing/textual/internal/cbor/cbor.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

x/auth/vesting/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

x/gov/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (5)

client/keys/rename_test.go (2)

54-54: Corrected typo in comment enhances clarity.

104-104: Corrected typo in comment enhances clarity.

x/tx/signing/textual/internal/cbor/cbor.go (1)

110-110: Corrected typo in comment enhances clarity.

x/auth/vesting/README.md (1)

613-613: Corrected typo in command description enhances clarity and correctness.

x/gov/README.md (1)

302-304: Refine the description of the "constitution" for clarity and precision.

Consider rephrasing to enhance clarity and reduce redundancy. For example, "This genesis entry, 'constitution', is designed not for existing chains, which should ratify a constitution using their governance system, but for new chains. It provides validators and community members with clear expectations about their roles and the chain's objectives."

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

julienrbrt · 2024-04-22T13:55:02Z

Hi!

Thanks for your PR, however we do not accept PRs spelling from private and/or recent GitHub accounts as per our CONTRIBUTING.md -- See Note 2.
We'll make sure to integrate your changes the next time our nightly github action runs.

dockercui · 2024-04-23T03:17:45Z

Hi!

Thanks for your PR, however we do not accept PRs spelling from private and/or recent GitHub accounts as per our CONTRIBUTING.md -- See Note 2. We'll make sure to integrate your changes the next time our nightly github action runs.

Thanks for your replay!

chore: fix some typos in comments

0f512c8

Signed-off-by: dockercui <[email protected]>

dockercui requested a review from a team as a code owner April 22, 2024 13:11

github-actions bot added C:CLI C:x/gov C:Keys Keybase, KMS and HSMs C:x/auth C:x/tx labels Apr 22, 2024

sontrinh16 approved these changes Apr 22, 2024

View reviewed changes

julienrbrt closed this Apr 22, 2024

julienrbrt mentioned this pull request Apr 25, 2024

chore: fix spelling errors #20187

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: fix some typos in comments #20141

chore: fix some typos in comments #20141

dockercui commented Apr 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 22, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

julienrbrt commented Apr 22, 2024 •

edited

Loading

dockercui commented Apr 23, 2024

chore: fix some typos in comments #20141

chore: fix some typos in comments #20141

Conversation

dockercui commented Apr 22, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Apr 22, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

julienrbrt commented Apr 22, 2024 • edited Loading

dockercui commented Apr 23, 2024

dockercui commented Apr 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 22, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

julienrbrt commented Apr 22, 2024 •

edited

Loading