docs(x/feegrant): Update readme #21364
Conversation
WalkthroughWalkthroughThe documentation for the fee grant module in the Cosmos SDK has been updated to reflect changes from version Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant FeeGrantModule
participant GrantStorage
User->>FeeGrantModule: Request grants-by-grantee
FeeGrantModule->>GrantStorage: Fetch grants for grantee
GrantStorage-->>FeeGrantModule: Return grants
FeeGrantModule-->>User: Display grants
User->>FeeGrantModule: Request grants-by-granter
FeeGrantModule->>GrantStorage: Fetch grants for granter
GrantStorage-->>FeeGrantModule: Return grants
FeeGrantModule-->>User: Display grants
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
raynaudoe
added
backport/v0.52.x
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (3)
x/feegrant/README.md (3)
338-338: Remove trailing punctuation in headings.Headings should not have trailing punctuation.
- ###### One-time spend limit: + ###### One-time spend limit - ###### Periodic spend limit: + ###### Periodic spend limit - ###### With expiration: + ###### With expiration - ###### With allowed messages: + ###### With allowed messagesAlso applies to: 344-344, 350-350, 356-356
Tools
Markdownlint
338-338: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
364-369: Fix list formatting and word choice.Use asterisks for unordered list items and replace "amount of" with "number of" for countable nouns.
- - `--spend-limit`: The maximum amount of tokens the grantee can spend - - `--period`: The time duration in seconds for periodic allowance - - `--period-limit`: The maximum amount of tokens the grantee can spend within each period - - `--expiration`: The date and time when the grant expires (RFC3339 format) - - `--allowed-messages`: Comma-separated list of allowed message type URLs + * `--spend-limit`: The maximum number of tokens the grantee can spend + * `--period`: The time duration in seconds for periodic allowance + * `--period-limit`: The maximum number of tokens the grantee can spend within each period + * `--expiration`: The date and time when the grant expires (RFC3339 format) + * `--allowed-messages`: Comma-separated list of allowed message type URLsTools
LanguageTool
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ...``` Available flags: ---spend-limit: The maximum amount of tokens the grante...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... flags: ---spend-limit: The maximum amount of tokens the grantee can spend - `--pe...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~366-~366: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...lowance ---period-limit: The maximum amount of tokens the grantee can spend within ...(AMOUNTOF_TO_NUMBEROF)
Markdownlint
364-364: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
365-365: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
366-366: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
367-367: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
368-368: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
258-300: Inconsistency in Command Naming in DocumentationThe old command name
grantsis still present in several markdown files, includingx/authz/README.md. This indicates that the renaming togrants-by-granteeandgrants-by-granterhas not been consistently applied across all relevant documentation. Please update these occurrences to maintain consistency and clarity.
x/authz/README.md: Multiple instances of thegrantscommand need to be updated.Analysis chain
Verify command renaming and consistency.
Ensure that the
grants-by-granteeandgrants-by-grantercommands are consistently used throughout the documentation and that all examples are correctly updated.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the consistency of command renaming in the documentation. # Test: Check for occurrences of the old and new command names. Expect: No occurrences of the old command name. rg --type markdown 'grants\b' | rg -v 'grants-by-grantee|grants-by-granter'Length of output: 5830
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- x/feegrant/README.md (9 hunks)
Additional context used
Path-based instructions (1)
x/feegrant/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Gitleaks
x/feegrant/README.md
122-122: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
LanguageTool
x/feegrant/README.md
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ...``` Available flags: ---spend-limit: The maximum amount of tokens the grante...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... flags: ---spend-limit: The maximum amount of tokens the grantee can spend - `--pe...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~366-~366: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...lowance ---period-limit: The maximum amount of tokens the grantee can spend within ...(AMOUNTOF_TO_NUMBEROF)
Markdownlint
x/feegrant/README.md
364-364: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
365-365: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
366-366: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
367-367: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
368-368: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
338-338: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
344-344: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
350-350: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
356-356: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Additional comments not posted (3)
x/feegrant/README.md (3)
330-360: Verify example correctness and clarity.Ensure that the examples for the
grantcommand are correct and clearly demonstrate the intended functionality, including expiration dates and allowed messages.Tools
Markdownlint
338-338: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
344-344: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
350-350: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
356-356: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
122-122: Verify and address potential API key exposure.A generic API key has been detected in the command example. Ensure that no sensitive information is exposed in the documentation.
Tools
Gitleaks
122-122: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
38-44: Verify URL correctness and accessibility.Ensure that the updated URLs point to the correct and intended resources in the latest release.
Also applies to: 60-60, 74-74, 92-92, 104-116, 150-150, 168-176
Verification successful
URLs in the documentation are correct and accessible.
All updated URLs in the README.md file are accessible and correctly point to the intended resources. No further action is needed.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of updated URLs in the documentation. # Test: Check if URLs are accessible. Expect: HTTP status code 200 for each URL. for url in \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/feegrant/proto/cosmos/feegrant/v1beta1/feegrant.proto#L86-L96" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/feegrant/fees.go#L10-L34" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/feegrant/proto/cosmos/feegrant/v1beta1/feegrant.proto#L15-L33" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/feegrant/proto/cosmos/feegrant/v1beta1/feegrant.proto#L35-L71" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/feegrant/proto/cosmos/feegrant/v1beta1/feegrant.proto#L73-L84" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/client/cmd.go#L256-L267" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/client/tx/tx.go#L129-L131" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/auth/tx/builder.go#L208" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/proto/cosmos/tx/v1beta1/tx.proto#L216-L243" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/feegrant/feegrant.pb.go#L222-L230" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/feegrant/proto/cosmos/feegrant/v1beta1/tx.proto#L30-L44" \ "https://github.com/cosmos/cosmos-sdk/blob/release/v0.52.x/x/feegrant/proto/cosmos/feegrant/v1beta1/tx.proto#L49-L62" do curl -s -o /dev/null -w "%{http_code}" "$url" doneLength of output: 17222
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- x/feegrant/README.md (9 hunks)
Additional context used
Path-based instructions (1)
x/feegrant/README.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Gitleaks
x/feegrant/README.md
122-122: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
LanguageTool
x/feegrant/README.md
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ...``` Available flags: ---spend-limit: The maximum amount of tokens the grante...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... flags: ---spend-limit: The maximum amount of tokens the grantee can spend - `--pe...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~366-~366: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...lowance ---period-limit: The maximum amount of tokens the grantee can spend within ...(AMOUNTOF_TO_NUMBEROF)
Markdownlint
x/feegrant/README.md
364-364: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
365-365: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
366-366: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
367-367: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
368-368: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Additional comments not posted (4)
x/feegrant/README.md (4)
258-287: Ensure consistency in command examples.The
grants-by-granteecommand description and examples are clear and consistent with the rest of the documentation. No issues found.
Line range hint
289-313: Ensure consistency in command examples.The
grants-by-grantercommand description and examples are clear and consistent with the rest of the documentation. No issues found.
Line range hint
369-379: Ensure clarity in command descriptions.The
revokecommand description and example are clear and consistent with the rest of the documentation. No issues found.Tools
LanguageTool
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ...``` Available flags: ---spend-limit: The maximum amount of tokens the grante...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... flags: ---spend-limit: The maximum amount of tokens the grantee can spend - `--pe...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~366-~366: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...lowance ---period-limit: The maximum amount of tokens the grantee can spend within ...(AMOUNTOF_TO_NUMBEROF)
Markdownlint
364-364: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
365-365: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
366-366: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
367-367: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
368-368: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Line range hint
380-411: Ensure accuracy in gRPC endpoint examples.The gRPC endpoint descriptions and examples are clear and consistent with the rest of the documentation. No issues found.
| The `grant` command allows users to grant fee allowances to another account. The fee allowance can have an expiration date, a total spend limit, a periodic spend limit, and/or allowed messages. | ||
|
|
||
| ```shell | ||
| simd tx feegrant grant [granter] [grantee] [flags] | ||
| ``` | ||
|
|
||
| Example (one-time spend limit): | ||
| Examples: | ||
|
|
||
| ###### One-time spend limit | ||
|
|
||
| ```shell | ||
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake | ||
| ``` | ||
|
|
||
| Example (periodic spend limit): | ||
| ###### Periodic spend limit | ||
|
|
||
| ```shell | ||
| simd tx feegrant grant cosmos1.. cosmos1.. --period 3600 --period-limit 10stake | ||
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --period 3600 --period-limit 10stake | ||
| ``` | ||
|
|
||
| ###### With expiration | ||
|
|
||
| ```shell | ||
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --expiration 2024-10-31T15:04:05Z | ||
| ``` | ||
|
|
||
| ###### With allowed messages | ||
|
|
||
| ```shell | ||
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --expiration 2024-10-31T15:04:05Z --allowed-messages "/cosmos.gov.v1beta1.MsgSubmitProposal,/cosmos.gov.v1beta1.MsgVote" | ||
| ``` | ||
|
|
||
| Available flags: | ||
|
|
||
| - `--spend-limit`: The maximum amount of tokens the grantee can spend | ||
| - `--period`: The time duration in seconds for periodic allowance | ||
| - `--period-limit`: The maximum amount of tokens the grantee can spend within each period | ||
| - `--expiration`: The date and time when the grant expires (RFC3339 format) | ||
| - `--allowed-messages`: Comma-separated list of allowed message type URLs | ||
|
|
There was a problem hiding this comment.
Correct grammatical issues and improve list formatting.
There are grammatical issues with the use of "amount of" and list formatting inconsistencies. Here are the suggested changes:
- - `--spend-limit`: The maximum amount of tokens the grantee can spend
- - `--period`: The time duration in seconds for periodic allowance
- - `--period-limit`: The maximum amount of tokens the grantee can spend within each period
- - `--expiration`: The date and time when the grant expires (RFC3339 format)
- - `--allowed-messages`: Comma-separated list of allowed message type URLs
+ * `--spend-limit`: The maximum number of tokens the grantee can spend
+ * `--period`: The time duration in seconds for periodic allowance
+ * `--period-limit`: The maximum number of tokens the grantee can spend within each period
+ * `--expiration`: The date and time when the grant expires (RFC3339 format)
+ * `--allowed-messages`: Comma-separated list of allowed message type URLsCommittable 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.
| The `grant` command allows users to grant fee allowances to another account. The fee allowance can have an expiration date, a total spend limit, a periodic spend limit, and/or allowed messages. | |
| ```shell | |
| simd tx feegrant grant [granter] [grantee] [flags] | |
| ``` | |
| Example (one-time spend limit): | |
| Examples: | |
| ###### One-time spend limit | |
| ```shell | |
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake | |
| ``` | |
| Example (periodic spend limit): | |
| ###### Periodic spend limit | |
| ```shell | |
| simd tx feegrant grant cosmos1.. cosmos1.. --period 3600 --period-limit 10stake | |
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --period 3600 --period-limit 10stake | |
| ``` | |
| ###### With expiration | |
| ```shell | |
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --expiration 2024-10-31T15:04:05Z | |
| ``` | |
| ###### With allowed messages | |
| ```shell | |
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --expiration 2024-10-31T15:04:05Z --allowed-messages "/cosmos.gov.v1beta1.MsgSubmitProposal,/cosmos.gov.v1beta1.MsgVote" | |
| ``` | |
| Available flags: | |
| - `--spend-limit`: The maximum amount of tokens the grantee can spend | |
| - `--period`: The time duration in seconds for periodic allowance | |
| - `--period-limit`: The maximum amount of tokens the grantee can spend within each period | |
| - `--expiration`: The date and time when the grant expires (RFC3339 format) | |
| - `--allowed-messages`: Comma-separated list of allowed message type URLs | |
| The `grant` command allows users to grant fee allowances to another account. The fee allowance can have an expiration date, a total spend limit, a periodic spend limit, and/or allowed messages. | |
| ```shell | |
| simd tx feegrant grant [granter] [grantee] [flags] | |
| ``` | |
| Examples: | |
| ###### One-time spend limit | |
| ```shell | |
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake | |
| ``` | |
| ###### Periodic spend limit | |
| ```shell | |
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --period 3600 --period-limit 10stake | |
| ``` | |
| ###### With expiration | |
| ```shell | |
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --expiration 2024-10-31T15:04:05Z | |
| ``` | |
| ###### With allowed messages | |
| ```shell | |
| simd tx feegrant grant cosmos1.. cosmos1.. --spend-limit 100stake --expiration 2024-10-31T15:04:05Z --allowed-messages "/cosmos.gov.v1beta1.MsgSubmitProposal,/cosmos.gov.v1beta1.MsgVote" | |
| ``` | |
| Available flags: | |
| * `--spend-limit`: The maximum number of tokens the grantee can spend | |
| * `--period`: The time duration in seconds for periodic allowance | |
| * `--period-limit`: The maximum number of tokens the grantee can spend within each period | |
| * `--expiration`: The date and time when the grant expires (RFC3339 format) | |
| * `--allowed-messages`: Comma-separated list of allowed message type URLs |
Tools
LanguageTool
[uncategorized] ~364-~364: Loose punctuation mark.
Context: ...``` Available flags: ---spend-limit: The maximum amount of tokens the grante...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~364-~364: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ... flags: ---spend-limit: The maximum amount of tokens the grantee can spend - `--pe...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~366-~366: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...lowance ---period-limit: The maximum amount of tokens the grantee can spend within ...(AMOUNTOF_TO_NUMBEROF)
Markdownlint
364-364: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
365-365: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
366-366: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
367-367: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
368-368: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
(cherry picked from commit aeb0f27)
Description
this PR is part of #20955 audit process
grantexamples to match codebaseAuthor 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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
grantscommand togrants-by-granteeand introduced a newgrants-by-grantercommand.grantcommand to include expiration dates and allowed messages, improving clarity and usability.