Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove duplicate words #20622

Merged
merged 1 commit into from
Jun 11, 2024
Merged

Conversation

caseylove
Copy link
Contributor

@caseylove caseylove commented Jun 11, 2024

Summary by CodeRabbit

  • Documentation
    • Clarified account rekeying limitations and introduced the concept of an extra gas fee for pubkey changes.
    • Corrected duplicated words and typos across various documentation files, including architecture documents and README files.
    • Updated a method implementation example in the app upgrade guide to correctly call the PreBlock method.

@caseylove caseylove requested a review from a team as a code owner June 11, 2024 10:34
Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

Walkthrough

The changes primarily involve correcting typographical errors and clarifying documentation across various files. These corrections include fixing duplicated words, adjusting return statements in code snippets, and enhancing explanations. No alterations were made to the declarations of exported or public entities, ensuring that the core functionality remains unaffected.

Changes

Files Change Summary
docs/architecture/adr-034-account-rekeying.md Clarified inability to auto-prune accounts with changed pubkeys, introduced extra gas fee for pubkey changes, and hinted at future manual pruning with gas refund.
docs/architecture/adr-064-abci-2.0.md Corrected a duplicated word in the context of CometBFT's block proposal decision-making process.
docs/build/building-apps/03-app-upgrade.md Fixed a typo in the PreBlocker method implementation within the myApp struct.
docs/rfc/rfc-006-handlers.md Corrected a duplication error related to compiling down to a 32-bit environment using TinyGo.
x/auth/vesting/README.md Removed a duplicated word "of" in the description of the create-periodic-vesting-account command.
x/circuit/README.md Fixed a typo in a comment related to the ResetCircuitBreaker function by removing a duplicated word "been."

Warning

Review ran into problems

Problems (1)
  • Git: Failed to clone repository. Please contact CodeRabbit support.

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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.

@tac0turtle tac0turtle added this pull request to the merge queue Jun 11, 2024
Merged via the queue into cosmos:main with commit fbd3b75 Jun 11, 2024
63 of 64 checks passed
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

Outside diff range and nitpick comments (7)
docs/architecture/adr-034-account-rekeying.md (2)

Line range hint 17-17: Consider using "cannot" instead of "can not" for a more formal tone.

- This can not be updated.
+ This cannot be updated.
Tools
LanguageTool

[style] ~46-~46: The word ‘anyways’ is informal American English. Did you mean “anyway”? (ANYWAYS)
Context: ...do not automatically prune any accounts anyways, but we would like to keep this option ...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ... we would like to keep this option open the road (this is the purpose of account nu...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...we can allow accounts that have rekeyed manually prune themselves using a new Msg type s...


Line range hint 19-19: Remove the comma before "because" when the clause is essential to the meaning.

- is not sufficient, because some "engagements"
+ is not sufficient because some "engagements"
Tools
LanguageTool

[style] ~46-~46: The word ‘anyways’ is informal American English. Did you mean “anyway”? (ANYWAYS)
Context: ...do not automatically prune any accounts anyways, but we would like to keep this option ...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ... we would like to keep this option open the road (this is the purpose of account nu...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...we can allow accounts that have rekeyed manually prune themselves using a new Msg type s...

x/circuit/README.md (4)

Line range hint 9-9: Consider using "can" instead of "is able to" for conciseness.

- Any address with a permission is able to reset the circuit breaker
+ Any address with a permission can reset the circuit breaker

Line range hint 26-26: Add a comma after "antehandler" to improve readability.

- This some transactions (such as `x/authz` transactions or some `x/gov` transactions) may pass the ante handler.
+ This, some transactions (such as `x/authz` transactions or some `x/gov` transactions) may pass the ante handler.

Line range hint 72-72: Add a comma after "actions" to separate the clauses.

- actions including authorizing and deauthorizing other accounts.
+ actions, including authorizing and deauthorizing other accounts.

Line range hint 91-91: Replace "for" with "of" to correct the preposition usage.

- enable execution for a specific msgURL of previously disabled message.
+ enable execution of a specific msgURL of previously disabled message.
x/auth/vesting/README.md (1)

599-599: Clarify the description of the create-periodic-vesting-account command.

The description of the create-periodic-vesting-account command could be enhanced for clarity. Consider specifying that the periods are defined in the JSON file and that the command initializes the account with these specified vesting periods.

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 62aa118 and b1b147f.

Files selected for processing (6)
  • docs/architecture/adr-034-account-rekeying.md (1 hunks)
  • docs/architecture/adr-064-abci-2.0.md (1 hunks)
  • docs/build/building-apps/03-app-upgrade.md (1 hunks)
  • docs/rfc/rfc-006-handlers.md (1 hunks)
  • x/auth/vesting/README.md (1 hunks)
  • x/circuit/README.md (1 hunks)
Additional context used
Path-based instructions (6)
docs/architecture/adr-034-account-rekeying.md (1)

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

x/circuit/README.md (1)

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

docs/build/building-apps/03-app-upgrade.md (1)

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

docs/rfc/rfc-006-handlers.md (1)

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

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

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

docs/architecture/adr-064-abci-2.0.md (1)

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

LanguageTool
docs/architecture/adr-034-account-rekeying.md

[style] ~17-~17: Unless you want to emphasize “not”, use “cannot” which is more common. (CAN_NOT_PREMIUM)
Context: ...ce a multisig for an account is set, it can not be updated. This is problematic, as mu...


[formatting] ~19-~19: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause. (COMMA_BEFORE_BECAUSE)
Context: ...ith the updated pubkey is not sufficient, because some "engagements" of an account are no...


[style] ~46-~46: The word ‘anyways’ is informal American English. Did you mean “anyway”? (ANYWAYS)
Context: ...do not automatically prune any accounts anyways, but we would like to keep this option ...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ... we would like to keep this option open the road (this is the purpose of account nu...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...we can allow accounts that have rekeyed manually prune themselves using a new Msg type s...

x/circuit/README.md

[style] ~9-~9: As a shorter alternative for ‘able to’, consider using “can”. (BE_ABLE_TO)
Context: ... mempool. Any address with a permission is able to reset the circuit breaker for the messa...


[uncategorized] ~26-~26: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...arn/beginner/tx-lifecycle#antehandler). This some transactions (such as x/authz tr...


[uncategorized] ~72-~72: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... an account to take all circuit breaker actions including authorizing and deauthorizing...


[uncategorized] ~91-~91: The preposition ‘of’ seems more likely in this position. (AI_HYDRA_LEO_REPLACE_FOR_OF)
Context: ... authorized account to enable execution for a specific msgURL of previously disable...

docs/build/building-apps/03-app-upgrade.md

[style] ~24-~24: Often, this adverbial phrase is redundant. Consider using an alternative. (FIRST_OF_ALL)
Context: ....40.0. How would this look in practice? First of all, we want to finalize the v0.40.0 releas...


[uncategorized] ~25-~25: The abbreviation “e.g.” (= for example) requires two periods. (E_G)
Context: ...tall a specially named upgrade handler (eg. "testnet-v2" or even "v0.40.0"). An upg...


[uncategorized] ~31-~31: The abbreviation “e.g.” (= for example) requires two periods. (E_G)
Context: ...tify if this is the old or new version (eg. presence of a handler registered for th...


[typographical] ~40-~40: Consider adding a comma after ‘Generally’ for more clarity. (RB_LY_COMMA)
Context: ...bsolete software, and gracefully exit. Generally the application binary will restart on ...


[uncategorized] ~128-~128: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...e blockchain, the upgrade keeper simply panics which prevents the ABCI state machine f...


[typographical] ~130-~130: The word “thus” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ...t to lose connectivity with the exiting nodes, thus this module prefers to just halt but no...


[uncategorized] ~140-~140: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...l remove the scheduled upgrade plan. Of course this requires that the upgrade was know...

docs/rfc/rfc-006-handlers.md

[style] ~9-~9: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. (EN_WEAK_ADJECTIVE)
Context: ...ized ## Background The Cosmos SDK has a very powerful and flexible module system that has bee...


[style] ~10-~10: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. (EN_WEAK_ADJECTIVE)
Context: ...m that has been tested and proven to be very good in production. The design of how messag...


[typographical] ~13-~13: Consider adding a comma here. (IF_THAT_S_NOT_POSSIBLE_COMMA)
Context: ...ds of users today. While this design is useful it has caused a elevated learning curve...


[misspelling] ~13-~13: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’. (EN_A_VS_AN)
Context: ...ile this design is useful it has caused a elevated learning curve to be adopted b...


[style] ~26-~26: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...e looked at TinyGo for our first target in order to compile down to a 32 bit environment wh...


[uncategorized] ~33-~33: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...e future when we have proving tools and technologies integrated parts of the new core layer ...


[style] ~34-~34: ‘in conjunction with’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
Context: ... new core layer will be able to be used in conjunction with proving technologies without the need t...


[grammar] ~47-~47: It appears that hyphens are missing. (PRE_AND_POST_NN)
Context: ... in the same way as it does today. ### Pre and Post Message Handlers In the Cosmos SDK, there exis...


[typographical] ~50-~50: It seems that a comma is missing. (IF_COMMA)
Context: ...cus on message hooks. When a message is implemented it can be unknown if others will use th...


[grammar] ~50-~50: Consider removing ‘will’, as it should not usually occur in a conditional clause. (WILL_VB_IF_VBZ)
Context: ...rs will use the module and if a message will need hooks. When hooks are needed before or ...


[style] ~52-~52: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative. (A_LOT_OF)
Context: ...odule. This is not ideal as it leads to a lot of forks of modules and a lot of code dupl...


[grammar] ~53-~53: It appears that hyphens are missing. (PRE_AND_POST_NN)
Context: ...modules and a lot of code duplication. Pre and Post message handlers solve this issue. Where we all...


[style] ~54-~54: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ules to register listeners for messages in order to execute something before and/or after t...


[typographical] ~61-~61: It seems that a comma is missing. (IF_COMMA)
Context: ...c. If the sender is not allowed to send funds the pre-message handler can return an e...


[uncategorized] ~129-~129: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ...plication developer to replace existing gRPC based services with handlers. This enables th...


[uncategorized] ~133-~133: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...vices or the new handlers. For message handlers we propose the introduction of the foll...


[style] ~204-~204: This phrase is redundant. Consider using “outside”. (OUTSIDE_OF)
Context: ... consensus queries should be registered outside of the state machine itself, and we will p...


[uncategorized] ~207-~207: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...es on how to do so with serverv2. As a consequence queries would be now mapped by their me...


[style] ~244-~244: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ectly, one must query a schema endpoint in order to see all possible messages and queries. ...


[uncategorized] ~254-~254: It seems likely that a singular genitive (’s) apostrophe is missing. (AI_HYDRA_LEO_APOSTROPHE_S_XS)
Context: ...Allows other modules to extend existing modules behaviour using pre and post msg handle...


[grammar] ~254-~254: It appears that hyphens are missing. (PRE_AND_POST_NN)
Context: ...extend existing modules behaviour using pre and post msg handlers, without forking. * The system...


[uncategorized] ~280-~280: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...s no fixed format for this section, but ideally changes to this > section should be upd...

x/auth/vesting/README.md

[style] ~40-~40: As a shorter alternative for ‘able to’, consider using “can”. (BE_ABLE_TO)
Context: ...ounts, the owner of the vesting account is able to delegate and undelegate from validators...


[typographical] ~40-~40: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (HOWEVER_SENTENCE)
Context: ... delegate and undelegate from validators, however they cannot transfer coins to another a...


[style] ~43-~43: ‘with respect to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)
Context: ...begin to vest at ST and vest linearly with respect to time until ET is reached * Periodic v...


[uncategorized] ~49-~49: The abbreviation “i.e.” (= that is) requires two periods. (I_E)
Context: ...nly allows for unconditional vesting (ie. there is no possibility of reaching `ET...


[style] ~113-~113: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...ting/v1beta1/vesting.proto#L71-L81 ``` In order to facilitate less ad-hoc type checking an...


[uncategorized] ~138-~138: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ng in the proceeding operations: * OV: The original vesting coin amount. It is...


[uncategorized] ~139-~139: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...in amount. It is a constant value. * V: The number of OV coins that are still...


[uncategorized] ~141-~141: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...and and not on a per-block basis. * V': The number of OV coins that are _vest...


[uncategorized] ~142-~142: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...demand and not a per-block basis. * DV: The number of delegated vesting coins...


[uncategorized] ~143-~143: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... directly in the vesting account. * DF: The number of delegated vested (unloc...


[uncategorized] ~144-~144: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... directly in the vesting account. * BC: The number of OV coins less any coins...


[uncategorized] ~145-~145: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...e or delegated). It is considered to be balance of the embedded base account. It is sto...


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


[grammar] ~156-~156: This phrase is duplicated. You should probably use “Compute Compute” only once. (PHRASE_REPETITION)
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 ...


[duplication] ~190-~190: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...he end of that period is after T. 1. Set CT := StartTime 2. Set V' := 0 For each Period P: 1. Com...


[duplication] ~197-~197: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ... - CT 2. IFX >= P.Length 1. ComputeV' += P.Amount 2. ComputeCT += P.Length` 3. ELSE break ...


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


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


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


[uncategorized] ~354-~354: This verb does not appear to agree with the subject. Consider using a different form. (AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
Context: ...This is because undelegating free coins are prioritized. Note: The undelegatio...


[style] ~384-~384: ‘off of’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_OFF_OF)
Context: ... the correct accounts accordingly based off of these fields. ```go type GenesisAccoun...


[grammar] ~457-~457: Possible agreement error. The noun ‘vest’ seems to be countable. (CD_NN)
Context: ... 5. More time passes, 2 more coins vest text V = 6 V' = 4 `...


[typographical] ~464-~464: It appears that a comma is missing. (DURING_THAT_TIME_COMMA)
Context: ... = 4 ``` 6. Sends 2 coins. At this point the account cannot send anymore until f...


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


[formatting] ~465-~465: Consider inserting a comma before ‘however’. (HOWEVER_MISSING_COMMA)
Context: ...or it receives additional coins. It can still however, delegate. ```text BC = 2 `...


[grammar] ~475-~475: Possible agreement error. The noun ‘vest’ seems to be countable. (CD_NN)
Context: ...imple example. 1. Time passes, 5 coins vest ```text V = 5 V' = 5 `...


[formatting] ~506-~506: Consider inserting a comma before ‘however’. (HOWEVER_MISSING_COMMA)
Context: ... coins or until more coins vest. It can still however, delegate. ```text DV = 5 - 2.5...


[uncategorized] ~519-~519: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...ll be released over 1 year, with 1/4 of tokens vesting each quarter. The vesting sched...


[grammar] ~544-~544: Possible agreement error. The noun ‘vest’ seems to be countable. (CD_NN)
Context: ...` 2. Vesting period 1 passes, 25 coins vest ```text V = 75 V' = 25 ...


[grammar] ~558-~558: Possible agreement error. The noun ‘vest’ seems to be countable. (CD_NN)
Context: ...` 4. Vesting period 2 passes, 25 coins vest ```text V = 50 V' = 50 ...


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


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


[misspelling] ~572-~572: Did you mean “at a time”, “at the time”, or “at times”? (AT_TIME2)
Context: ...ing account that have been fully vested at time of delegation. * DelegatedVesting: The ...


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


[misspelling] ~574-~574: Did you mean “at a time”, “at the time”, or “at times”? (AT_TIME2)
Context: ...rom a vesting account that were vesting at time of delegation. * ContinuousVestingAccou...

docs/architecture/adr-064-abci-2.0.md

[style] ~26-~26: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...hods that the application can implement in order to gain further control, insight and custo...


[grammar] ~53-~53: The usual collocation for “independently” is “of”, not “from”. Did you mean “independently of”? (INDEPENDENTLY_FROM_OF)
Context: ...ly 2/3. * The pre-commit vote is signed independently from the vote extension. ### `VerifyVoteExt...


[uncategorized] ~89-~89: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...onger execute requests for these legacy methods and instead will just simply call `Fina...


[style] ~90-~90: This phrase is redundant. Consider writing “just” or “simply”. (JUST_RECENTLY)
Context: ...r these legacy methods and instead will just simply call FinalizeBlock. ## Decision We ...


[uncategorized] ~98-~98: A comma may be missing after the conjunctive/linking adverb ‘Similarly’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...FinalizeBlock. ### VoteExtensions Similarly for PrepareProposal and `ProcessPropo...


[style] ~100-~100: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...dlers that an application can implement in order to provide and verify vote extensions. We...


[typographical] ~120-~120: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ...s, VerifyVoteExtensionHandler must be deterministic, otherwise the chain may suffer from liveness faul...


[style] ~189-~189: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...H+1duringPrepareProposal`. However, in order to make vote extensions useful, all valida...


[style] ~214-~214: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...he validator MUST REJECT the proposal. In order to have the ability to validate signatures...


[style] ~285-~285: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. (EN_WEAK_ADJECTIVE)
Context: ... on the vote extensions. > NOTE: It is very important to state, that neither the vote propaga...


[uncategorized] ~289-~289: Did you mean “its” (the possessive pronoun)? (ITS_PREMIUM)
Context: ...ignatures. An application can implement it's own > PKI mechanism and use that to sig...


[style] ~295-~295: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...sist data derived from vote extensions. In order to facilitate this use case, we propose to...


[style] ~322-~322: ‘prior to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_PRIOR_TO)
Context: ...bution and inflation related operations prior to executing transactions and then have st...


[grammar] ~337-~337: There may an error in the verb form ‘be replace’. (MD_BE_NON_VBP)
Context: ...ll be removed, i.e. deliverState will be replace with finalizeState, which will be com...


[style] ~395-~395: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...BlockandEndBlock` implementations. In order to facilitate existing event functionality...


[style] ~415-~415: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase. (EN_WEAK_ADJECTIVE)
Context: ...vote extensions from height H. It is very important to note, for all heights after H: * Vo...

Additional comments not posted (1)
docs/build/building-apps/03-app-upgrade.md (1)

66-66: Correct the method call to match the intended functionality.

- return app.upgradeKeeper.PreBlocker(ctx, req)
+ return app.ModuleManager.PreBlock(ctx, req)

Likely invalid or redundant comment.

@@ -120,7 +120,7 @@ Recall, an implementation of `ExtendVoteHandler` does NOT need to be determinist
however, given a set of vote extensions, `VerifyVoteExtensionHandler` must be
deterministic, otherwise the chain may suffer from liveness faults. In addition,
recall CometBFT proceeds in rounds for each height, so if a decision cannot be
made about about a block proposal at a given height, CometBFT will proceed to the
made about a block proposal at a given height, CometBFT will proceed to the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure clarity in the description of the VoteExtensions process.

The description of the VoteExtensions process could be clearer. It's important to specify that the ExtendVote and VerifyVoteExtension handlers are called repeatedly in each new round until a consensus is reached, which might not be immediately obvious to readers.

@@ -43,7 +43,7 @@ The MsgChangePubKey transaction needs to be signed by the existing pubkey in sta

Once, approved, the handler for this message type, which takes in the AccountKeeper, will update the in-state pubkey for the account and replace it with the pubkey from the Msg.

An account that has had its pubkey changed cannot be automatically pruned from state. This is because if pruned, the original pubkey of the account would be needed to recreate the same address, but the owner of the address may not have the original pubkey anymore. Currently, we do not automatically prune any accounts anyways, but we would like to keep this option open the road (this is the purpose of account numbers). To resolve this, we charge an additional gas fee for this operation to compensate for this this externality (this bound gas amount is configured as parameter `PubKeyChangeCost`). The bonus gas is charged inside the handler, using the `ConsumeGas` function. Furthermore, in the future, we can allow accounts that have rekeyed manually prune themselves using a new Msg type such as `MsgDeleteAccount`. Manually pruning accounts can give a gas refund as an incentive for performing the action.
An account that has had its pubkey changed cannot be automatically pruned from state. This is because if pruned, the original pubkey of the account would be needed to recreate the same address, but the owner of the address may not have the original pubkey anymore. Currently, we do not automatically prune any accounts anyways, but we would like to keep this option open the road (this is the purpose of account numbers). To resolve this, we charge an additional gas fee for this operation to compensate for this externality (this bound gas amount is configured as parameter `PubKeyChangeCost`). The bonus gas is charged inside the handler, using the `ConsumeGas` function. Furthermore, in the future, we can allow accounts that have rekeyed manually prune themselves using a new Msg type such as `MsgDeleteAccount`. Manually pruning accounts can give a gas refund as an incentive for performing the action.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the missing preposition "to" for grammatical correctness.

- accounts that have rekeyed manually prune themselves
+ accounts that have rekeyed to manually prune themselves
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
An account that has had its pubkey changed cannot be automatically pruned from state. This is because if pruned, the original pubkey of the account would be needed to recreate the same address, but the owner of the address may not have the original pubkey anymore. Currently, we do not automatically prune any accounts anyways, but we would like to keep this option open the road (this is the purpose of account numbers). To resolve this, we charge an additional gas fee for this operation to compensate for this externality (this bound gas amount is configured as parameter `PubKeyChangeCost`). The bonus gas is charged inside the handler, using the `ConsumeGas` function. Furthermore, in the future, we can allow accounts that have rekeyed manually prune themselves using a new Msg type such as `MsgDeleteAccount`. Manually pruning accounts can give a gas refund as an incentive for performing the action.
An account that has had its pubkey changed cannot be automatically pruned from state. This is because if pruned, the original pubkey of the account would be needed to recreate the same address, but the owner of the address may not have the original pubkey anymore. Currently, we do not automatically prune any accounts anyways, but we would like to keep this option open the road (this is the purpose of account numbers). To resolve this, we charge an additional gas fee for this operation to compensate for this externality (this bound gas amount is configured as parameter `PubKeyChangeCost`). The bonus gas is charged inside the handler, using the `ConsumeGas` function. Furthermore, in the future, we can allow accounts that have rekeyed to manually prune themselves using a new Msg type such as `MsgDeleteAccount`. Manually pruning accounts can give a gas refund as an incentive for performing the action.
Tools
LanguageTool

[style] ~46-~46: The word ‘anyways’ is informal American English. Did you mean “anyway”? (ANYWAYS)
Context: ...do not automatically prune any accounts anyways, but we would like to keep this option ...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ... we would like to keep this option open the road (this is the purpose of account nu...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...we can allow accounts that have rekeyed manually prune themselves using a new Msg type s...


Replace "anyways" with "anyway" for formal writing.

- do not automatically prune any accounts anyways,
+ do not automatically prune any accounts anyway,
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
An account that has had its pubkey changed cannot be automatically pruned from state. This is because if pruned, the original pubkey of the account would be needed to recreate the same address, but the owner of the address may not have the original pubkey anymore. Currently, we do not automatically prune any accounts anyways, but we would like to keep this option open the road (this is the purpose of account numbers). To resolve this, we charge an additional gas fee for this operation to compensate for this externality (this bound gas amount is configured as parameter `PubKeyChangeCost`). The bonus gas is charged inside the handler, using the `ConsumeGas` function. Furthermore, in the future, we can allow accounts that have rekeyed manually prune themselves using a new Msg type such as `MsgDeleteAccount`. Manually pruning accounts can give a gas refund as an incentive for performing the action.
An account that has had its pubkey changed cannot be automatically pruned from state. This is because if pruned, the original pubkey of the account would be needed to recreate the same address, but the owner of the address may not have the original pubkey anymore. Currently, we do not automatically prune any accounts anyway, but we would like to keep this option open the road (this is the purpose of account numbers). To resolve this, we charge an additional gas fee for this operation to compensate for this externality (this bound gas amount is configured as parameter `PubKeyChangeCost`). The bonus gas is charged inside the handler, using the `ConsumeGas` function. Furthermore, in the future, we can allow accounts that have rekeyed manually prune themselves using a new Msg type such as `MsgDeleteAccount`. Manually pruning accounts can give a gas refund as an incentive for performing the action.
Tools
LanguageTool

[style] ~46-~46: The word ‘anyways’ is informal American English. Did you mean “anyway”? (ANYWAYS)
Context: ...do not automatically prune any accounts anyways, but we would like to keep this option ...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ... we would like to keep this option open the road (this is the purpose of account nu...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...we can allow accounts that have rekeyed manually prune themselves using a new Msg type s...


Add the missing preposition "down" to clarify the phrase.

- we would like to keep this option open the road
+ we would like to keep this option open down the road
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
An account that has had its pubkey changed cannot be automatically pruned from state. This is because if pruned, the original pubkey of the account would be needed to recreate the same address, but the owner of the address may not have the original pubkey anymore. Currently, we do not automatically prune any accounts anyways, but we would like to keep this option open the road (this is the purpose of account numbers). To resolve this, we charge an additional gas fee for this operation to compensate for this externality (this bound gas amount is configured as parameter `PubKeyChangeCost`). The bonus gas is charged inside the handler, using the `ConsumeGas` function. Furthermore, in the future, we can allow accounts that have rekeyed manually prune themselves using a new Msg type such as `MsgDeleteAccount`. Manually pruning accounts can give a gas refund as an incentive for performing the action.
An account that has had its pubkey changed cannot be automatically pruned from state. This is because if pruned, the original pubkey of the account would be needed to recreate the same address, but the owner of the address may not have the original pubkey anymore. Currently, we do not automatically prune any accounts anyways, but we would like to keep this option open down the road (this is the purpose of account numbers). To resolve this, we charge an additional gas fee for this operation to compensate for this externality (this bound gas amount is configured as parameter `PubKeyChangeCost`). The bonus gas is charged inside the handler, using the `ConsumeGas` function. Furthermore, in the future, we can allow accounts that have rekeyed manually prune themselves using a new Msg type such as `MsgDeleteAccount`. Manually pruning accounts can give a gas refund as an incentive for performing the action.
Tools
LanguageTool

[style] ~46-~46: The word ‘anyways’ is informal American English. Did you mean “anyway”? (ANYWAYS)
Context: ...do not automatically prune any accounts anyways, but we would like to keep this option ...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ... we would like to keep this option open the road (this is the purpose of account nu...


[uncategorized] ~46-~46: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...we can allow accounts that have rekeyed manually prune themselves using a new Msg type s...

@@ -23,7 +23,7 @@ the use of [gRPC](https://github.com/TinyGo-org/TinyGo/issues/2814) within modul
This has led us to look at a design which would allow the usage of TinyGo and
other technologies.

We looked at TinyGo for our first target in order to compile down down to a 32 bit environment which could be used with
We looked at TinyGo for our first target in order to compile down to a 32 bit environment which could be used with
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove duplication error in the text.

- We looked at TinyGo for our first target in order to compile down to a 32 bit environment which could be used with
+ We looked at TinyGo for our first target to compile down to a 32 bit environment which could be used with
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
We looked at TinyGo for our first target in order to compile down to a 32 bit environment which could be used with
We looked at TinyGo for our first target to compile down to a 32 bit environment which could be used with
Tools
LanguageTool

[style] ~26-~26: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...e looked at TinyGo for our first target in order to compile down to a 32 bit environment wh...

alpe added a commit that referenced this pull request Jun 12, 2024
* main:
  refactor(x/auth): Fix system test (#20531)
  feat(crypto): add blst (#20296)
  docs: Update high level overview and introduction (#20535)
  refactor(x/core): remove test (#20624)
  feat(x/mint)!: Replace InflationCalculationFn with MintFn + simple epoch minting (#20363)
  docs: remove duplicate words (#20622)
  feat: prep for errors v2 (#20539)
  chore: reduce default inflation (#20606)
  refactor(store): add miss defer (#20602)
  chore: use comet api pkg instead of comet alias (#20614)
  chore: write gentx info to cmd.ErrOrStderr (#20616)
  docs: ADR 073: update to accepted and add to README.md (#20619)
  chore(proto): change future extracted modules version from v1.0.0 to v0.2.0 (#20600)
  fix: remove some duplicate words (#20605)
  feat(stf): port simappv2 changes (#20587)
  chore: bring patch changelogs to main (#20599)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants