docs: update token command docs #2940
Conversation
WalkthroughThe Changes
Sequence Diagram(s) (Beta)sequenceDiagram
participant User
participant CLI
participant TokenService
participant ERC20Service
User->>CLI: Execute swap-from-erc20
CLI->>TokenService: Request token swap from ERC20
TokenService->>ERC20Service: Validate and process ERC20 token
ERC20Service->>TokenService: Confirm token swap
TokenService->>CLI: Provide swap confirmation
CLI->>User: Display swap results
User->>CLI: Execute balances query
CLI->>TokenService: Request balances for owner
TokenService->>CLI: Provide balances
CLI->>User: Display balances
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 Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
Out of diff range and nitpick comments (8)
docs/cli-client/token.md (8)
15-16: Ensure consistent formatting for new commands.The new commands
swap-from-erc20andswap-to-erc20are correctly added. However, ensure that the descriptions are clear and consistent with the existing commands.
22-22: Ensure consistent formatting for new commands.The new command
balancesis correctly added. However, ensure that the description is clear and consistent with the existing commands.
169-172: Clarify the command description.The description "Swap native token from the corresponding ERC20 at 1:1" could be more detailed. Consider specifying the context or use case for this command.
191-192: Clarify the command description.The description "Swap native token to the corresponding ERC20 at 1:1" could be more detailed. Consider specifying the context or use case for this command.
287-288: Clarify the command description.The description "Query all the balances of an owner in special denom" could be more detailed. Consider specifying the context or use case for this command.
Line range hint
37-37: Use a hyphen for "case-insensitive".The word "case insensitive" is normally spelled with a hyphen.
- case insensitive + case-insensitive
Line range hint
39-39: Use "cannot" instead of "can not".Unless you want to emphasize "not", use "cannot" which is more common.
- can not exceed max supply + cannot exceed max supply
Line range hint
62-62: Fix the markdown link.The markdown link for "sending iris" is missing a closing bracket.
- [sending iris](./bank.md#iris-tx-bank-send + [sending iris](./bank.md#iris-tx-bank-send)
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/cli-client/token.md (4 hunks)
Additional Context Used
LanguageTool (4)
docs/cli-client/token.md (4)
Near line 37: This word is normally spelled with a hyphen.
Context: ...umeric characters beginning with alpha, case insensitive | | --initial-supply | u...
Near line 39: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...he hard cap of this token, total supply can not exceed max supply. The amount before bo...
Near line 62: Unpaired symbol: ‘]’ seems to be missing
Context: ... can send any tokens you have just like [sending iris](./bank.md#iris-tx-bank-sen...
Near line 209: Possible typo: you repeated a word
Context: ...ain-id> --fees=## iris query token token Query a token by symbolbash iris ...
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (5)
docs/cli-client/token.md (5)
15-16: Add a more detailed description for theswap-from-erc20command.The current description "Swap native token from the corresponding ERC20 at 1:1" could be expanded to explain the context or purpose of this operation more clearly.
16-16: Ensure consistency in command descriptions.The description for
swap-from-erc20ends with "at 1:1", which is not followed by a period, unlike other descriptions in the table. Consider adding a period for consistency.
22-22: Clarify the description of thebalancescommand.The description "Query all the balances of an owner in special denom" could be improved for clarity. Consider specifying what "special denom" refers to or rephrasing it to "Query all token balances of an owner in a specified denomination."
Line range hint
37-37: Correct the spelling of "case-insensitive".- case insensitive + case-insensitive
Line range hint
39-39: Use "cannot" instead of "can not".- can not exceed max supply + cannot exceed max supply
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/cli-client/token.md (4 hunks)
Additional Context Used
LanguageTool (3)
docs/cli-client/token.md (3)
Near line 37: This word is normally spelled with a hyphen.
Context: ...umeric characters beginning with alpha, case insensitive | | --initial-supply | u...
Rule ID: EN_COMPOUNDS_CASE_INSENSITIVE
Near line 39: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...he hard cap of this token, total supply can not exceed max supply. The amount before bo...
Rule ID: CAN_NOT_PREMIUM
Near line 209: Possible typo: you repeated a word
Context: ...ain-id> --fees=## iris query token token Query a token by symbolbash iris ...
Rule ID: ENGLISH_WORD_REPEAT_RULE
Additional comments not posted (2)
docs/cli-client/token.md (2)
209-209: Remove the repeated word "token".- ## iris query token token + ## iris query tokenLikely invalid or redundant comment.
16-16: Verify the accuracy of theswap-from-erc20command.
Summary by CodeRabbit
New Features
swap-from-erc20andswap-to-erc20commands for token swapping with ERC20 tokens.balancescommand to query all balances of an owner in a special denomination.Documentation