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.

Sign up for GitHub

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

Jump to bottom

docs(x/authz): Update Staking Module Broken Link #20157

Merged
merged 2 commits into from Apr 24, 2024
Merged

docs(x/authz): Update Staking Module Broken Link #20157

merged 2 commits into from Apr 24, 2024

Conversation

Erlangshen219
Copy link
Contributor

@Erlangshen219 Erlangshen219 commented Apr 23, 2024 •
edited by coderabbitai bot

Update Staking Module Broken Link at x\authz\README.md

Description

Closes: #XXXX

Author Checklist

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

I have...

  • [x ] included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • [x ] 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
    • Updated the StakeAuthorization documentation in the staking module to reference the latest version (0.50).

@Erlangshen219 Erlangshen219 requested a review from a team as a code owner April 23, 2024 13:28
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 23, 2024 •
edited

Walkthrough

Walkthrough

The update in the StakeAuthorization documentation within the staking module now aligns with version 0.50 of the documentation, ensuring that all references and links are current and accurate. The core content describing the parameters for delegation actions remains unchanged.

Changes

File Path Change Summary
x/authz/README.md Updated documentation reference from version 0.44 to version 0.50.

Possibly related issues

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 565a280 and 47d71b5.
Files selected for processing (1)
  • x/authz/README.md (1 hunks)
Additional Context Used
LanguageTool (96)
x/authz/README.md (96)

Near line 9: This sentence does not start with an uppercase letter.
Context: ...-- # x/authz ## Abstract x/authz is an implementation of a Cosmos SDK modul...

Near line 20: Possible spelling mistake found.
Context: ...e](#state) * Grant * GrantQueue * Messages ...

Near line 22: Possible spelling mistake found.
Context: ...ntqueue) * Messages * MsgGrant * [MsgRevoke](#msgrevok...

Near line 23: Possible spelling mistake found.
Context: ...ges) * MsgGrant * MsgRevoke * MsgExec ...

Near line 24: Possible spelling mistake found.
Context: ...t) * MsgRevoke * MsgExec * [MsgPruneExpiredGrants...

Near line 25: Possible spelling mistake found.
Context: ...evoke) * MsgExec * MsgPruneExpiredGrants * [Events](#ev...

Near line 36: Possible spelling mistake found.
Context: ...cepts ### Authorization and Grant The x/authz module defines interfaces and messages...

Near line 40: This phrase is redundant. Consider using “outside”.
Context: ...defined for any Msg service method even outside of the module where the Msg method is defi...

Near line 40: Possible spelling mistake found.
Context: ...here the Msg method is defined. See the SendAuthorization example in the next section for more d...

Near line 42: Possible spelling mistake found.
Context: ...ection for more details. Note: The authz module is different from the [auth (aut...

Near line 50: Possible spelling mistake found.
Context: ...Built-in Authorizations The Cosmos SDK x/authz module comes with following authorizat...

Near line 52: Possible spelling mistake found.
Context: ...th following authorization types: #### GenericAuthorization GenericAuthorization implements the ...

Near line 54: This sentence does not start with an uppercase letter.
Context: ...icAuthorization GenericAuthorization implements the Authorization interface that give...

Near line 64: This sentence does not start with an uppercase letter.
Context: ...c_authorization.go#L16-L29 ``` * msg stores Msg type URL. #### SendAuthorization ...

Near line 66: Possible spelling mistake found.
Context: ...``` * msg stores Msg type URL. #### SendAuthorization `SendAuthorization` implements the `Au...

Near line 68: This sentence does not start with an uppercase letter.
Context: ... SendAuthorization SendAuthorization implements the Authorization interface for the `...

Near line 68: Add a space between sentences.
Context: ...s the Authorization interface for the cosmos.bank.v1beta1.MsgSend Msg. * It takes a (positive) `SpendLi...

Near line 70: Possible spelling mistake found.
Context: ....MsgSendMsg. * It takes a (positive)SpendLimit` that specifies the maximum amount of t...

Near line 70: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...SpendLimit that specifies the maximum amount of tokens the grantee can spend. The `S...

Near line 70: Possible spelling mistake found.
Context: ...nt of tokens the grantee can spend. The SpendLimit is updated as the tokens are spent. * ...

Near line 71: Possible spelling mistake found.
Context: ...ens are spent. * It takes an (optional) AllowList that specifies to which addresses a gr...

Near line 81: This sentence does not start with an uppercase letter.
Context: ...ization.go#L29-L62 ``` * spend_limit keeps track of how many coins are left in the...

Near line 82: This sentence does not start with an uppercase letter.
Context: ...ft in the authorization. * allow_list specifies an optional list of addresses to whom t...

Near line 84: Possible spelling mistake found.
Context: ... tokens on behalf of the granter. #### StakeAuthorization StakeAuthorization implements the `A...

Near line 86: This sentence does not start with an uppercase letter.
Context: ...takeAuthorization StakeAuthorization implements the Authorization interface for messa...

Near line 86: Possible spelling mistake found.
Context: ...ain/build/modules/staking). It takes an AuthorizationType to specify whether you want to authori...

Near line 86: Possible spelling mistake. ‘authorise’ is British English.
Context: ...ionType` to specify whether you want to authorise delegating, undelegating or redelegatin...

Near line 86: Possible spelling mistake found.
Context: ...ether you want to authorise delegating, undelegating or redelegating (i.e. these have to be ...

Near line 86: Possible spelling mistake found.
Context: ...o authorise delegating, undelegating or redelegating (i.e. these have to be authorised separ...

Near line 86: Possible spelling mistake. ‘authorised’ is British English.
Context: ... or redelegating (i.e. these have to be authorised separately). It also takes a required `...

Near line 86: Possible spelling mistake found.
Context: ...d separately). It also takes a required MaxTokens that keeps track of a limit to the amo...

Near line 86: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...ens` that keeps track of a limit to the amount of tokens that can be delegated/undeleg...

Near line 86: Possible spelling mistake found.
Context: ... amount of tokens that can be delegated/undelegated/redelegated. If left empty, the amount ...

Near line 86: Possible spelling mistake found.
Context: ...okens that can be delegated/undelegated/redelegated. If left empty, the amount is unlimited...

Near line 86: Possible spelling mistake found.
Context: ...imited. Additionally, this Msg takes an AllowList or a DenyList, which allows you to s...

Near line 86: Possible spelling mistake found.
Context: ...lly, this Msg takes an AllowList or a DenyList, which allows you to select which vali...

Near line 97: Consider a shorter alternative to avoid wordiness.
Context: ...ng/types/authz.go#L15-L35 ``` ### Gas In order to prevent DoS attacks, granting `StakeAut...

Near line 98: Possible spelling mistake found.
Context: ... order to prevent DoS attacks, granting StakeAuthorizations with x/authz incurs gas. `StakeAuth...

Near line 98: Possible spelling mistake found.
Context: ...ks, granting StakeAuthorizations with x/authz incurs gas. StakeAuthorization allow...

Near line 98: Possible spelling mistake found.
Context: ...horizations with x/authzincurs gas.StakeAuthorization` allows you to authorize another accoun...

Near line 98: Do not mix variants of the same word (‘authorize’ and ‘authorise’) within a single text.
Context: ...gas. StakeAuthorization allows you to authorize another account to delegate, undelegate...

Near line 98: Possible spelling mistake found.
Context: ... authorize another account to delegate, undelegate, or redelegate to validators. The autho...

Near line 98: Possible spelling mistake found.
Context: ...her account to delegate, undelegate, or redelegate to validators. The authorizer can defin...

Near line 98: After the number ‘10’, use a plural noun. Did you mean “gases”, “gasses”?
Context: ...iterates over these lists and charge 10 gas for each validator in both of the lists...

Near line 100: Possible spelling mistake found.
Context: ...ove the grant (in case of any revoke of paritcular msgType) from the list and we are cha...

Near line 100: Possible spelling mistake found.
Context: ...nt (in case of any revoke of paritcular msgType) from the list and we are charging 20 ...

Near line 100: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e of paritcular msgType) from the list and we are charging 20 gas per iteration. ...

Near line 100: After the number ‘20’, use a plural noun. Did you mean “gases”, “gasses”?
Context: ...`) from the list and we are charging 20 gas per iteration. ## State ### Grant Gr...

Near line 106: A comma may be missing after the conjunctive/linking adverb ‘Hence’.
Context: ... and Authorization type (its type URL). Hence we only allow one grant for the (grante...

Near line 116: Possible spelling mistake found.
Context: ...hz/v1beta1/authz.proto#L24-L32 ``` ### GrantQueue We are maintaining a queue for authz p...

Near line 118: Possible spelling mistake found.
Context: ...ntQueue We are maintaining a queue for authz pruning. Whenever a grant is created, a...

Near line 118: Possible spelling mistake found.
Context: ...nt is created, an item will be added to GrantQueue with a key of expiration, granter, gra...

Near line 120: Possible spelling mistake found.
Context: ...ey of expiration, granter, grantee. In EndBlock (which runs for every block) we contin...

Near line 120: Possible spelling mistake found.
Context: ...ts by forming a prefix key with current blocktime that passed the stored expiration in `G...

Near line 120: Possible spelling mistake found.
Context: ...me that passed the stored expiration in GrantQueue, we iterate through all the matched re...

Near line 120: Possible spelling mistake found.
Context: ...te through all the matched records from GrantQueue and delete them from the GrantQueue ...

Near line 120: Possible spelling mistake found.
Context: ...m GrantQueue and delete them from the GrantQueue & Grants store. ```go reference htt...

Near line 120: An accent character was used instead of an apostrophe.
Context: ...and delete them from the GrantQueue & Grants store. ```go reference https://github....

Near line 126: Possible spelling mistake found.
Context: ...authz/keeper/keeper.go#L378-L403 ``` * GrantQueue: `0x02 | expiration_bytes | granter_add...

Near line 134: Possible spelling mistake found.
Context: ...x/authz/keeper/keys.go#L77-L93 ``` The GrantQueueItem object contains the list of type urls ...

Near line 134: Possible spelling mistake found.
Context: ...eItem` object contains the list of type urls between granter and grantee that expire...

Near line 138: It appears that a comma is missing.
Context: ...cated in the key. ## Messages In this section we describe the processing of messages ...

Near line 138: Possible spelling mistake found.
Context: ...ribe the processing of messages for the authz module. ### MsgGrant An authorization...

Near line 140: Possible spelling mistake found.
Context: ... of messages for the authz module. ### MsgGrant An authorization grant is created usin...

Near line 142: Possible spelling mistake found.
Context: ...uthorization grant is created using the MsgGrant message. If there is already a grant f...

Near line 151: This sentence does not start with an uppercase letter.
Context: ...The message handling should fail if: * both granter and grantee have the same addre...

Near line 152: This sentence does not start with an uppercase letter.
Context: ...er and grantee have the same address. * provided Expiration time is less than current ...

Near line 152: Possible spelling mistake found.
Context: ... Expiration time is less than current unix timestamp (but a grant will be created ...

Near line 152: Possible missing comma found.
Context: ...l be created if no expiration time is provided since expiration is optional). * prov...

Near line 153: This sentence does not start with an uppercase letter.
Context: ...ided since expiration is optional). * provided Grant.Authorization is not implemente...

Near line 153: Add a space between sentences.
Context: ...e expiration is optional). * provided Grant.Authorization is not implemented. * `Authorization.M...

Near line 154: This sentence does not start with an uppercase letter.
Context: ...emented. * Authorization.MsgTypeURL() is not defined in the router (there is no ...

Near line 156: Possible spelling mistake found.
Context: ... router to handle that Msg types). ### MsgRevoke A grant can be removed with the `MsgRe...

Near line 158: Possible spelling mistake found.
Context: ...Revoke A grant can be removed with the MsgRevoke message. ```protobuf reference https:...

Near line 166: This sentence does not start with an uppercase letter.
Context: ...The message handling should fail if: * both granter and grantee have the same addre...

Near line 167: This sentence does not start with an uppercase letter.
Context: ...er and grantee have the same address. * provided MsgTypeUrl is empty. NOTE: The `MsgE...

Near line 167: Possible spelling mistake found.
Context: ...antee have the same address. * provided MsgTypeUrl is empty. NOTE: The MsgExec message...

Near line 169: Possible spelling mistake found.
Context: ...vided MsgTypeUrl is empty. NOTE: The MsgExec message removes a grant if the grant h...

Near line 171: Possible spelling mistake found.
Context: ... a grant if the grant has expired. ### MsgExec When a grantee wants to execute a tran...

Near line 173: Possible spelling mistake found.
Context: ... on behalf of a granter, they must send MsgExec. ```protobuf reference https://github...

Near line 181: This sentence does not start with an uppercase letter.
Context: ...The message handling should fail if: * provided Authorization is not implemented. * g...

Near line 182: This sentence does not start with an uppercase letter.
Context: ...d Authorization is not implemented. * grantee doesn't have permission to run the tran...

Near line 183: This sentence does not start with an uppercase letter.
Context: ...ve permission to run the transaction. * if granted authorization is expired. ### ...

Near line 183: Possible missing comma found.
Context: ...permission to run the transaction. * if granted authorization is expired. ### MsgPrune...

Near line 185: Possible spelling mistake found.
Context: ... granted authorization is expired. ### MsgPruneExpiredGrants Message that clean up 75 expired grant...

Near line 191: Possible spelling mistake found.
Context: ...lean up expired grants. ## Events The authz module emits proto events defined in [t...

Near line 191: Possible spelling mistake found.
Context: ...dule emits proto events defined in [the Protobuf reference](https://buf.build/cosmos/cos...

Near line 191: Add a space between sentences.
Context: ...vents defined in the Protobuf reference. ## Client ### CLI A user can query...

Near line 197: Possible spelling mistake found.
Context: ... A user can query and interact with the authz module using the CLI. #### Query The...

Near line 201: Possible spelling mistake found.
Context: ...e query commands allow users to query authz state. ```bash simd query authz --hel...

Near line 207: This sentence does not start with an uppercase letter.
Context: ...bash simd query authz --help ``` ##### grants The grants command allows users to q...

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

Near line 236: Possible spelling mistake found.
Context: ...mmands allow users to interact with the authz module. ```bash simd tx authz --help ...

Near line 242: This sentence does not start with an uppercase letter.
Context: ...bash simd tx authz --help ##### exec The exec command allows a grantee to...

Near line 286: Possible spelling mistake found.
Context: ...1.. ``` ### gRPC A user can query the authz module using gRPC endpoints. #### Gra...

Near line 328: Possible spelling mistake found.
Context: ...] } ### REST A user can query the `authz` module using REST endpoints. bash ...

Path-based Instructions (1)
x/authz/README.md (1)

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

Additional comments not posted (1)
x/authz/README.md (1)

86-86: Update the documentation link to maintain accuracy.

Ensure the new link points to the correct and most recent documentation version as intended.

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.

likhita-809
likhita-809 requested changes Apr 23, 2024
View reviewed changes
x/authz/README.md Outdated Show resolved Hide resolved
@julienrbrt julienrbrt changed the title docs(x\authz): Update README.md - Update Staking Module Broken Link docs(x/authz): Update Staking Module Broken Link Apr 23, 2024
@Erlangshen219
Copy link
Contributor Author

Update Modules Staking Link as Suggested

@tac0turtle tac0turtle added this pull request to the merge queue Apr 24, 2024
Merged via the queue into cosmos:main with commit ed7cad3 Apr 24, 2024
51 of 55 checks passed
meetrick pushed a commit to meetrick/cosmos-sdk that referenced this pull request Apr 29, 2024
@Erlangshen219 @meetrick
docs(x/authz): Update Staking Module Broken Link (cosmos#20157)
c604ffd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle approved these changes

@likhita-809 likhita-809 likhita-809 approved these changes

Assignees
No one assigned
Labels
C:x/authz
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Erlangshen219 @tac0turtle @likhita-809