docs: documentation for v8.3.x #6311
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crodriguezvega
requested review from
colin-axner,
AdityaSripal,
charleenfei,
damiannolan,
chatton,
DimitrisJim and
srdtrk
as code owners
WalkthroughThe recent updates in version Changes
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: 6
Out of diff range and nitpick comments (14)
docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/09-active-channels.md (2)
Line range hint
8-8: Remove the trailing space at the end of the line.- The Interchain Accounts module uses either [ORDERED or UNORDERED](https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#ordering) channels. + The Interchain Accounts module uses either [ORDERED or UNORDERED](https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#ordering) channels.
Line range hint
1-1: Consider removing the second top-level heading to maintain a single top-level heading in the document.- --- - title: Active Channels - sidebar_label: Active Channels - sidebar_position: 9 - slug: /apps/interchain-accounts/active-channels - --- - - # Understanding Active Channels + --- + title: Active Channels + sidebar_label: Active Channels + sidebar_position: 9 + slug: /apps/interchain-accounts/active-channels + ---docs/versioned_docs/version-v8.3.x/02-apps/01-transfer/08-authorizations.md (4)
Line range hint
21-21: Consider using "number" instead of "amount" for countable nouns like tokens.- a `SpendLimit` that specifies the maximum amount of tokens the grantee can transfer. + a `SpendLimit` that specifies the maximum number of tokens the grantee can transfer.
Line range hint
21-21: Use an en dash for numerical ranges.- the maximum value for a 256-bit unsigned integer (i.e. 2^256 - 1) + the maximum value for a 256-bit unsigned integer (i.e. 2^256–1)
Line range hint
33-33: Remove the repeated word "is".- - the denomination of the spend limit is an invalid coin type + - the denomination of the spend limit is invalid
Line range hint
1-1: Consider removing the second top-level heading to maintain a single top-level heading in the document.- --- - title: Authorizations - sidebar_label: Authorizations - sidebar_position: 8 - slug: /apps/transfer/authorizations - --- - # `TransferAuthorization` + --- + title: Authorizations + sidebar_label: Authorizations + sidebar_position: 8 + slug: /apps/transfer/authorizations + ---docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/10-legacy/03-keeper-api.md (1)
Line range hint
9-9: Consider removing the second top-level heading to maintain a single top-level heading in the document.- --- - title: Keeper API - sidebar_label: Keeper API - sidebar_position: 3 - slug: /apps/interchain-accounts/legacy/keeper-api - --- - - # Keeper API + --- + title: Keeper API + sidebar_label: Keeper API + sidebar_position: 3 + slug: /apps/interchain-accounts/legacy/keeper-api + ---docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/05-messages.md (2)
Line range hint
41-41: Use "to" instead of "in" for better readability.- The `ChannelID` and `PortID` are returned in the message response. + The `ChannelID` and `PortID` are returned to the message response.
Line range hint
9-9: Consider removing the second top-level heading to maintain a single top-level heading in the document.- --- - title: Messages - sidebar_label: Messages - sidebar_position: 5 - slug: /apps/interchain-accounts/messages - --- - - # Messages + --- + title: Messages + sidebar_label: Messages + sidebar_position: 5 + slug: /apps/interchain-accounts/messages + ---docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/04-integration.md (3)
Line range hint
17-17: Use a comma before "or" if it connects two independent clauses.- Chains who wish to support ICS-27 may elect to act as a host chain, a controller chain or both. + Chains who wish to support ICS-27 may elect to act as a host chain, a controller chain, or both.
Line range hint
17-17: Use a comma before "or" if it connects two independent clauses.- Disabling host or controller functionality may be done statically by excluding the host or controller submodule entirely from the `app.go` file or it may be done dynamically by taking advantage of the on-chain parameters which enable or disable the host or controller submodules. + Disabling host or controller functionality may be done statically by excluding the host or controller submodule entirely from the `app.go` file, or it may be done dynamically by taking advantage of the on-chain parameters which enable or disable the host or controller submodules.
Line range hint
1-1: Consider removing the second top-level heading to maintain a single top-level heading in the document.- --- - title: Integration - sidebar_label: Integration - sidebar_position: 4 - slug: /apps/interchain-accounts/integration - --- - - # Integration + --- + title: Integration + sidebar_label: Integration + sidebar_position: 4 + slug: /apps/interchain-accounts/integration + ---docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/10-legacy/02-integration.md (2)
Line range hint
21-21: Use a comma before "or" if it connects two independent clauses.- Disabling host or controller functionality may be done statically by excluding the host or controller module entirely from the `app.go` file or it may be done dynamically by taking advantage of the on-chain parameters which enable or disable the host or controller submodules. + Disabling host or controller functionality may be done statically by excluding the host or controller module entirely from the `app.go` file, or it may be done dynamically by taking advantage of the on-chain parameters which enable or disable the host or controller submodules.
Line range hint
9-9: Consider removing the second top-level heading to maintain a single top-level heading in the document.- --- - title: Integration - sidebar_label: Integration - sidebar_position: 2 - slug: /apps/interchain-accounts/legacy/integration - --- - - # Integration + --- + title: Integration + sidebar_label: Integration + sidebar_position: 2 + slug: /apps/interchain-accounts/legacy/integration + ---
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files ignored due to path filters (12)
docs/versioned_docs/version-v8.3.x/01-ibc/03-apps/images/packet_flow.pngis excluded by!**/*.pngdocs/versioned_docs/version-v8.3.x/01-ibc/04-middleware/images/middleware-stack.pngis excluded by!**/*.pngdocs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/10-legacy/images/ica-pre-v6.pngis excluded by!**/*.pngdocs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/images/ica-v6.pngis excluded by!**/*.pngdocs/versioned_docs/version-v8.3.x/04-middleware/01-ics29-fee/images/feeflow.pngis excluded by!**/*.pngdocs/versioned_docs/version-v8.3.x/04-middleware/01-ics29-fee/images/msgpaypacket.pngis excluded by!**/*.pngdocs/versioned_docs/version-v8.3.x/04-middleware/01-ics29-fee/images/paypacketfeeasync.pngis excluded by!**/*.pngdocs/versioned_docs/version-v8.3.x/04-middleware/02-callbacks/images/callbackflow.svgis excluded by!**/*.svgdocs/versioned_docs/version-v8.3.x/04-middleware/02-callbacks/images/ics4-callbackflow.svgis excluded by!**/*.svgdocs/versioned_docs/version-v8.3.x/05-migrations/images/auth-module-decision-tree.pngis excluded by!**/*.pngdocs/versioned_docs/version-v8.3.x/images/ibcoverview-dark.svgis excluded by!**/*.svgdocs/versioned_docs/version-v8.3.x/images/ibcoverview-light.svgis excluded by!**/*.svg
Files selected for processing (7)
- docs/versioned_docs/version-v8.3.x/02-apps/01-transfer/08-authorizations.md (1 hunks)
- docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/04-integration.md (2 hunks)
- docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/05-messages.md (1 hunks)
- docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/09-active-channels.md (1 hunks)
- docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/10-legacy/02-integration.md (2 hunks)
- docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/10-legacy/03-keeper-api.md (1 hunks)
- docs/versions.json (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/versions.json
Additional Context Used
Path-based Instructions (6)
docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/09-active-channels.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/versioned_docs/version-v8.3.x/02-apps/01-transfer/08-authorizations.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/10-legacy/03-keeper-api.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/05-messages.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/04-integration.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/versioned_docs/version-v8.3.x/02-apps/02-interchain-accounts/10-legacy/02-integration.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
| @@ -11,7 +11,7 @@ The Interchain Accounts module uses either [ORDERED or UNORDERED](https://github | |||
|
|
|||
| When using `ORDERED` channels, the order of transactions when sending packets from a controller to a host chain is maintained. | |||
|
|
|||
| When using `UNORDERED` channels, there is no guarantee that the order of transactions when sending packets from the controller to the host chain is maintained. | |||
| When using `UNORDERED` channels, there is no guarantee that the order of transactions when sending packets from the controller to the host chain is maintained. Since ibc-go v8.3.0, the default ordering for new ICA channels is `UNORDERED`, if no ordering is specified in `MsgRegisterInterchainAccount` (previously the default ordering was `ORDERED`). | |||
There was a problem hiding this comment.
Use "cannot" instead of "can not" for better readability.
- new channels can not be opened
+ new channels cannot be openedCommittable 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.
Suggested change
| When using `UNORDERED` channels, there is no guarantee that the order of transactions when sending packets from the controller to the host chain is maintained. Since ibc-go v8.3.0, the default ordering for new ICA channels is `UNORDERED`, if no ordering is specified in `MsgRegisterInterchainAccount` (previously the default ordering was `ORDERED`). | |
| When using `UNORDERED` channels, there is no guarantee that the order of transactions when sending packets from the controller to the host chain is maintained. Since ibc-go v8.3.0, the default ordering for new ICA channels is `UNORDERED`, if no ordering is specified in `MsgRegisterInterchainAccount` (previously the default ordering was `ORDERED`). |
| @@ -72,6 +72,80 @@ type MsgSendTxResponse struct { | |||
|
|
|||
| The packet `Sequence` is returned in the message response. | |||
There was a problem hiding this comment.
Use "to" instead of "in" for better readability.
- The packet `Sequence` is returned in the message response.
+ The packet `Sequence` is returned to the message response.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.
Suggested change
| The packet `Sequence` is returned in the message response. | |
| The packet `Sequence` is returned to the message response. |
| @@ -72,6 +72,80 @@ | |||
|
|
|||
| The packet `Sequence` is returned in the message response. | |||
|
|
|||
| ### Queries | |||
|
|
|||
| It is possible to use [`MsgModuleQuerySafe`](https://github.com/cosmos/ibc-go/blob/eecfa5c09a4c38a5c9f2cc2a322d2286f45911da/proto/ibc/applications/interchain_accounts/host/v1/tx.proto#L41-L51) to execute a list of queries on the host chain. This message can be included in the list of encoded `sdk.Msg`s of `InterchainPacketData`. The host chain will return on the acknowledgment the responses for all the queries. Please note that only module safe queries can be executed ([deterministic queries that are safe to be called from within the state machine](https://docs.cosmos.network/main/build/building-modules/query-services#calling-queries-from-the-state-machine)). | |||
There was a problem hiding this comment.
Remove the trailing space at the end of the line.
- It is possible to use [`MsgModuleQuerySafe`](https://github.com/cosmos/ibc-go/blob/eecfa5c09a4c38a5c9f2cc2a322d2286f45911da/proto/ibc/applications/interchain_accounts/host/v1/tx.proto#L41-L51) to execute a list of queries on the host chain. This message can be included in the list of encoded `sdk.Msg`s of `InterchainPacketData`. The host chain will return on the acknowledgment the responses for all the queries. Please note that only module safe queries can be executed ([deterministic queries that are safe to be called from within the state machine](https://docs.cosmos.network/main/build/building-modules/query-services#calling-queries-from-the-state-machine)).
+ It is possible to use [`MsgModuleQuerySafe`](https://github.com/cosmos/ibc-go/blob/eecfa5c09a4c38a5c9f2cc2a322d2286f45911da/proto/ibc/applications/interchain_accounts/host/v1/tx.proto#L41-L51) to execute a list of queries on the host chain. This message can be included in the list of encoded `sdk.Msg`s of `InterchainPacketData`. The host chain will return on the acknowledgment the responses for all the queries. Please note that only module safe queries can be executed ([deterministic queries that are safe to be called from within the state machine](https://docs.cosmos.network/main/build/building-modules/query-services#calling-queries-from-the-state-machine)).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.
Suggested change
| It is possible to use [`MsgModuleQuerySafe`](https://github.com/cosmos/ibc-go/blob/eecfa5c09a4c38a5c9f2cc2a322d2286f45911da/proto/ibc/applications/interchain_accounts/host/v1/tx.proto#L41-L51) to execute a list of queries on the host chain. This message can be included in the list of encoded `sdk.Msg`s of `InterchainPacketData`. The host chain will return on the acknowledgment the responses for all the queries. Please note that only module safe queries can be executed ([deterministic queries that are safe to be called from within the state machine](https://docs.cosmos.network/main/build/building-modules/query-services#calling-queries-from-the-state-machine)). | |
| It is possible to use [`MsgModuleQuerySafe`](https://github.com/cosmos/ibc-go/blob/eecfa5c09a4c38a5c9f2cc2a322d2286f45911da/proto/ibc/applications/interchain_accounts/host/v1/tx.proto#L41-L51) to execute a list of queries on the host chain. This message can be included in the list of encoded `sdk.Msg`s of `InterchainPacketData`. The host chain will return on the acknowledgment the responses for all the queries. Please note that only module safe queries can be executed ([deterministic queries that are safe to be called from within the state machine](https://docs.cosmos.network/main/build/building-modules/query-services#calling-queries-from-the-state-machine)). |
| ### Queries | ||
|
|
||
| It is possible to use [`MsgModuleQuerySafe`](https://github.com/cosmos/ibc-go/blob/eecfa5c09a4c38a5c9f2cc2a322d2286f45911da/proto/ibc/applications/interchain_accounts/host/v1/tx.proto#L41-L51) to execute a list of queries on the host chain. This message can be included in the list of encoded `sdk.Msg`s of `InterchainPacketData`. The host chain will return on the acknowledgment the responses for all the queries. Please note that only module safe queries can be executed ([deterministic queries that are safe to be called from within the state machine](https://docs.cosmos.network/main/build/building-modules/query-services#calling-queries-from-the-state-machine)). | ||
|
|
There was a problem hiding this comment.
Remove the trailing space at the end of the line.
-
+ 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.
Suggested change
| @@ -25,6 +25,7 @@ Interchain Account authentication modules are the base application of a middlewa | |||
|  | |||
|
|
|||
| > Please note that since ibc-go v6 the channel capability is claimed by the controller submodule and therefore it is not required for authentication modules to claim the capability in the `OnChanOpenInit` callback. Therefore the custom authentication module does not need a scoped keeper anymore. | |||
There was a problem hiding this comment.
Use a comma before "and" if it connects two independent clauses.
- The channel capability is claimed by the controller submodule and therefore it is not required for authentication modules to claim the capability in the `OnChanOpenInit` callback.
+ The channel capability is claimed by the controller submodule, and therefore it is not required for authentication modules to claim the capability in the `OnChanOpenInit` callback.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.
Suggested change
| > Please note that since ibc-go v6 the channel capability is claimed by the controller submodule and therefore it is not required for authentication modules to claim the capability in the `OnChanOpenInit` callback. Therefore the custom authentication module does not need a scoped keeper anymore. | |
| > Please note that since ibc-go v6 the channel capability is claimed by the controller submodule, and therefore it is not required for authentication modules to claim the capability in the `OnChanOpenInit` callback. Therefore the custom authentication module does not need a scoped keeper anymore. |
Add a comma after "Therefore" for better readability.
- Therefore the custom authentication module does not need a scoped keeper anymore.
+ Therefore, the custom authentication module does not need a scoped keeper anymore.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.
Suggested change
| > Please note that since ibc-go v6 the channel capability is claimed by the controller submodule and therefore it is not required for authentication modules to claim the capability in the `OnChanOpenInit` callback. Therefore the custom authentication module does not need a scoped keeper anymore. | |
| > Please note that since ibc-go v6 the channel capability is claimed by the controller submodule and therefore it is not required for authentication modules to claim the capability in the `OnChanOpenInit` callback. Therefore, the custom authentication module does not need a scoped keeper anymore. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
closes: #XXXX
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/).godoccomments.Files changedin the GitHub PR explorer.SonarCloud Reportin the comment section below once CI passes.Summary by CodeRabbit
AllowedPacketDatalist inTransferAuthorizationto specify allowed memo strings.UNORDEREDif not specified.v8.3.x.