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: documentation for v7.5.x #6271

Merged
merged 11 commits into from May 14, 2024
Merged

docs: documentation for v7.5.x #6271

merged 11 commits into from May 14, 2024

Conversation

crodriguezvega
Copy link
Contributor

@crodriguezvega crodriguezvega commented May 7, 2024

Description

This copies the docs for v7.4.x and then updates documentation for the features coming in the v7.5.0 release. Maybe it's easier to review individually the commits that actually update the docs...

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.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

  • Documentation
    • Added detailed instructions for registering the gRPC query router in the Interchain Accounts module.
    • Clarified the use of ORDERED and UNORDERED channels in the Interchain Accounts module.
    • Updated the default channel ordering in RegisterInterchainAccount to UNORDERED.
    • Added new query paths and example code for MsgModuleQuerySafe in Interchain Accounts.
    • Updated version documentation to reflect ibc-go v7.5.0.

Copy link
Contributor

coderabbitai bot commented May 7, 2024

Warning

Rate Limit Exceeded

@crodriguezvega has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 18 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 4e8f19a and 7100975.

Walkthrough

The updates in version v7.5.x focus on enhancing the Interchain Accounts module and Transfer Authorization. Key changes include mandatory registration of the gRPC query router for node startup, introduction of new message types and query paths, and a shift in default channel ordering from ORDERED to UNORDERED. Additionally, the Transfer Authorization now supports an expanded list of allowed packet data. The version update is reflected in the documentation versioning.

Changes

File Path Change Summary
.../02-apps/01-transfer/08-authorizations.md Added AllowedPacketData list in TransferAuthorization.
.../02-apps/02-interchain-accounts/04-integration.md Introduced mandatory gRPC query router registration for ICA Host Keeper.
.../02-apps/02-interchain-accounts/05-messages.md Added MsgSendTxResponse, MsgModuleQuerySafe, new query paths, and example code.
.../02-apps/02-interchain-accounts/09-active-channels.md Clarified use of ORDERED and UNORDERED channels and packet timeout implications.
.../02-apps/02-interchain-accounts/10-legacy/02-integration.md Added app.ICAHostKeeper.WithQueryRouter(app.GRPCQueryRouter()).
.../02-apps/02-interchain-accounts/10-legacy/03-keeper-api.md Shifted default ordering in RegisterInterchainAccount to UNORDERED and added RegisterInterchainAccountWithOrdering.
docs/versions.json Updated version from "v7.4.x" to "v7.5.x".

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.

@crodriguezvega crodriguezvega marked this pull request as ready for review May 13, 2024 12:53
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: 6

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between de92573 and d7787f6.
Files ignored due to path filters (9)
  • docs/versioned_docs/version-v7.5.x/01-ibc/03-apps/images/packet_flow.png is excluded by !**/*.png
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/10-legacy/images/ica-pre-v6.png is excluded by !**/*.png
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/images/ica-v6.png is excluded by !**/*.png
  • docs/versioned_docs/version-v7.5.x/04-middleware/01-ics29-fee/images/feeflow.png is excluded by !**/*.png
  • docs/versioned_docs/version-v7.5.x/04-middleware/01-ics29-fee/images/msgpaypacket.png is excluded by !**/*.png
  • docs/versioned_docs/version-v7.5.x/04-middleware/01-ics29-fee/images/paypacketfeeasync.png is excluded by !**/*.png
  • docs/versioned_docs/version-v7.5.x/04-middleware/02-callbacks/images/callbackflow.svg is excluded by !**/*.svg
  • docs/versioned_docs/version-v7.5.x/04-middleware/02-callbacks/images/ics4-callbackflow.svg is excluded by !**/*.svg
  • docs/versioned_docs/version-v7.5.x/05-migrations/images/auth-module-decision-tree.png is excluded by !**/*.png
Files selected for processing (7)
  • docs/versioned_docs/version-v7.5.x/02-apps/01-transfer/08-authorizations.md (1 hunks)
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/04-integration.md (2 hunks)
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/05-messages.md (1 hunks)
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/09-active-channels.md (1 hunks)
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/10-legacy/02-integration.md (2 hunks)
  • docs/versioned_docs/version-v7.5.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-v7.5.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-v7.5.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-v7.5.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-v7.5.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-v7.5.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-v7.5.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"

Comment on lines +83 to +84
> Since ibc-go v7.5.0 the default ordering of new ICA channels created when invoking `RegisterInterchainAccount` has changed from `ORDERED` to `UNORDERED`. If this default behaviour does not meet your use case, please use the function `RegisterInterchainAccountWithOrdering` (available since ibc-go v7.5.0), which takes an extra parameter that can be used to specify the ordering of the channel.

Copy link
Contributor

Choose a reason for hiding this comment

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

Add a comma before "please use the function" for clarity.

- If this default behaviour does not meet your use case, please use the function `RegisterInterchainAccountWithOrdering` (available since ibc-go v7.5.0), which takes an extra parameter that can be used to specify the ordering of the channel.
+ If this default behaviour does not meet your use case, please use the function `RegisterInterchainAccountWithOrdering` (available since ibc-go v7.5.0), which takes an extra parameter that can be used to specify the ordering of the channel.

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
> Since ibc-go v7.5.0 the default ordering of new ICA channels created when invoking `RegisterInterchainAccount` has changed from `ORDERED` to `UNORDERED`. If this default behaviour does not meet your use case, please use the function `RegisterInterchainAccountWithOrdering` (available since ibc-go v7.5.0), which takes an extra parameter that can be used to specify the ordering of the channel.
> Since ibc-go v7.5.0 the default ordering of new ICA channels created when invoking `RegisterInterchainAccount` has changed from `ORDERED` to `UNORDERED`. If this default behaviour does not meet your use case, please use the function `RegisterInterchainAccountWithOrdering` (available since ibc-go v7.5.0), which takes an extra parameter that can be used to specify the ordering of the channel.

Comment on lines 74 to 77
### 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)).

Copy link
Contributor

Choose a reason for hiding this comment

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

Remove trailing spaces for consistency.

- ### 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)). 
+ ### 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)).

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
### 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)).
### 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)).

crodriguezvega and others added 2 commits May 14, 2024 13:50
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 7

Out of diff range and nitpick comments (17)
docs/versioned_docs/version-v7.5.x/02-apps/01-transfer/08-authorizations.md (5)

Line range hint 23-23: Use "number" instead of "amount" for countable nouns like tokens.

- `SpendLimit` that specifies the maximum amount of tokens the grantee can transfer.
+ `SpendLimit` that specifies the maximum number of tokens the grantee can transfer.

Line range hint 23-23: Use an en dash for numerical ranges.

- for a 256-bit unsigned integer (i.e. 2^256 - 1) is used for the amount,
+ for a 256-bit unsigned integer (i.e. 2^256–1) is used for the amount,

Line range hint 19-19: Remove trailing space.

- 
+ 

Line range hint 41-54: Replace hard tabs with spaces for consistency.

-	return &TransferAuthorization{
-		Allocations: allocations,
-	}
+    return &TransferAuthorization{
+        Allocations: allocations,
+    }

Line range hint 9-9: Avoid multiple top-level headings in the same document.

Consider using subheadings instead of multiple top-level headings.

docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/09-active-channels.md (2)

Line range hint 35-35: Use "cannot" instead of "can not" for better readability.

- new channels can not be opened for this account until the currently set `Active Channel` is set to `CLOSED`.
+ new channels cannot be opened for this account until the currently set `Active Channel` is set to `CLOSED`.

8-8: Avoid multiple top-level headings in the same document.

Consider using subheadings instead of multiple top-level headings.

docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/04-integration.md (7)

Line range hint 17-17: Add a comma before "or" for clarity.

- a host chain, a controller chain or both.
+ a host chain, a controller chain, or both.

Line range hint 17-17: Add a comma before "or" for clarity.

- from the `app.go` file or it may be done dynamically
+ from the `app.go` file, or it may be done dynamically

Line range hint 12-12: Remove trailing space.

- 
+ 

Line range hint 15-15: Remove trailing space.

- 
+ 

Line range hint 17-17: Remove trailing space.

- 
+ 

Line range hint 19-19: Remove trailing space.

- 
+ 

Line range hint 9-9: Avoid multiple top-level headings in the same document.

Consider using subheadings instead of multiple top-level headings.

docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/10-legacy/02-integration.md (3)

Line range hint 21-21: Add a comma before "or" for clarity.

- a host chain, a controller chain or both.
+ a host chain, a controller chain, or both.

Line range hint 21-21: Add a comma before "or" for clarity.

- from the `app.go` file or it may be done dynamically
+ from the `app.go` file, or it may be done dynamically

Line range hint 9-9: Avoid multiple top-level headings in the same document.

Consider using subheadings instead of multiple top-level headings.

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between d7787f6 and 4e8f19a.
Files selected for processing (4)
  • docs/versioned_docs/version-v7.5.x/02-apps/01-transfer/08-authorizations.md (1 hunks)
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/04-integration.md (2 hunks)
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/09-active-channels.md (1 hunks)
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/10-legacy/02-integration.md (2 hunks)
Files not summarized due to errors (1)
  • docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/10-legacy/02-integration.md: Error: Server error. Please try again later.
Additional Context Used
LanguageTool (10)
docs/versioned_docs/version-v7.5.x/02-apps/01-transfer/08-authorizations.md (2)

Near line 23: ‘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 transfer. The...


Near line 23: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...r a 256-bit unsigned integer (i.e. 2^256 - 1) is used for the amount, in which case...

docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/04-integration.md (2)

Near line 17: Possible missing comma found.
Context: ...ct to act as a host chain, a controller chain or both. Disabling host or controller f...


Near line 17: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ubmodule entirely from the app.go file or it may be done dynamically by taking ad...

docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/09-active-channels.md (2)

Near line 16: Possible missing comma found.
Context: ...ED channels is that when a packet times out the channel will be closed. In the cas...


Near line 35: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ... given interchain account, new channels can not be opened for this account until the cu...

docs/versioned_docs/version-v7.5.x/02-apps/02-interchain-accounts/10-legacy/02-integration.md (4)

Near line 21: Possible missing comma found.
Context: ...ct to act as a host chain, a controller chain or both. Disabling host or controller f...


Near line 21: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r module entirely from the app.go file or it may be done dynamically by taking ad...


Near line 27: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...y is claimed by the controller submodule and therefore it is not required for authen...


Near line 27: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...ility in the OnChanOpenInit callback. Therefore the custom authentication module does n...

Path-based Instructions (4)
docs/versioned_docs/version-v7.5.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-v7.5.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-v7.5.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-v7.5.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"

@@ -24,6 +24,8 @@ It takes:

- an `AllowList` list that specifies the list of addresses that are allowed to receive funds. If this list is empty, then all addresses are allowed to receive funds from the `TransferAuthorization`.

- an `AllowedPacketData` list that specifies the list of memo strings that are allowed to be included in the memo field of the packet. If this list is empty, then only an empty memo is allowed (a `memo` field with non-empty content will be denied). If this list includes a single element equal to `"*"`, then any content in the `memo` field will be allowed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Clarify the usage of the article "the" before "memo field".

- If this list includes a single element equal to `"*"`, then any content in `memo` field will be allowed.
+ If this list includes a single element equal to `"*"`, then any content in the `memo` field will be allowed.

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
- an `AllowedPacketData` list that specifies the list of memo strings that are allowed to be included in the memo field of the packet. If this list is empty, then only an empty memo is allowed (a `memo` field with non-empty content will be denied). If this list includes a single element equal to `"*"`, then any content in the `memo` field will be allowed.
- an `AllowedPacketData` list that specifies the list of memo strings that are allowed to be included in the memo field of the packet. If this list is empty, then only an empty memo is allowed (a `memo` field with non-empty content will be denied). If this list includes a single element equal to `"*"`, then any content in the `memo` field will be allowed.


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 v7.5.0, the default ordering for new ICA channels is `UNORDERED`, if no ordering is specified in `MsgRegisterInterchainAccount` (previously the default ordering was `ORDERED`).

> A limitation when using ORDERED channels is that when a packet times out the channel will be closed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a comma before "if no ordering is specified" for clarity.

- Since ibc-go v7.5.0, the default ordering for new ICA channels is `UNORDERED` if no ordering is specified in `MsgRegisterInterchainAccount` (previously the default ordering was `ORDERED`).
+ Since ibc-go v7.5.0, the default ordering for new ICA channels is `UNORDERED`, if no ordering is specified in `MsgRegisterInterchainAccount` (previously the default ordering was `ORDERED`).

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
> A limitation when using ORDERED channels is that when a packet times out the channel will be closed.
> A limitation when using ORDERED channels is that when a packet times out the channel will be closed.
Since ibc-go v7.5.0, the default ordering for new ICA channels is `UNORDERED`, if no ordering is specified in `MsgRegisterInterchainAccount` (previously the default ordering was `ORDERED`).

@@ -7,7 +7,13 @@

# Understanding Active Channels

The Interchain Accounts module uses [ORDERED channels](https://github.com/cosmos/ibc/tree/master/spec/core/ics-004-channel-and-packet-semantics#ordering) to maintain the order of transactions when sending packets from a controller to a host chain. A limitation when using ORDERED channels is that when a packet times out the channel will be closed.
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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove trailing space.

- 
+ 

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 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.

@@ -20,6 +20,8 @@ Interchain Account authentication modules (both custom or generic, such as the `

![ica-v6.png](./images/ica-v6.png)

> Please note that since ibc-go v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper; otherwise, nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.
Copy link
Contributor

Choose a reason for hiding this comment

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

Separate "otherwise" from the sentence for clarity.

- Please note that since ibc-go v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper, otherwise nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.
+ Please note that since ibc-go v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper; otherwise, nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.

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 v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper; otherwise, nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.
> Please note that since ibc-go v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper; otherwise, nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.

@@ -25,6 +25,7 @@ Interchain Account authentication modules are the base application of a middlewa
![ica-pre-v6.png](./images/ica-pre-v6.png)

> 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 v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper; otherwise, nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.
Copy link
Contributor

Choose a reason for hiding this comment

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

Separate "otherwise" from the sentence for clarity.

- Please note that since ibc-go v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper, otherwise nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.
+ Please note that since ibc-go v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper; otherwise, nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.

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 v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper; otherwise, nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.
> Please note that since ibc-go v7.5.0 it is mandatory to register the gRPC query router after the creation of the host submodule's keeper; otherwise, nodes will not start. The query router is used to execute on the host query messages encoded in the ICA packet data. Please check the sample integration code below for more details.

@@ -25,6 +25,7 @@
![ica-pre-v6.png](./images/ica-pre-v6.png)

> 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a comma before "and" for clarity.

- by the controller submodule and therefore it is not required
+ by the controller submodule, and therefore it is not required

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 clarity.

- 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.

@crodriguezvega crodriguezvega merged commit 5aa8922 into main May 14, 2024
25 checks passed
@crodriguezvega crodriguezvega deleted the carlos/docs-v7.5.x branch May 14, 2024 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant