chore: fix struct field name and some typos in comment #23126
Conversation
oftenoccur
requested review from
a team,
kocubinski,
testinginprod,
aaronc,
facundomedica,
julienrbrt and
hieuvubk
as code owners
📝 WalkthroughWalkthroughThe pull request encompasses multiple changes across different files in the Cosmos SDK repository. The most significant update is in the Changes
Sequence DiagramsequenceDiagram
participant Hypervisor
participant VM1
participant VM2
participant AccountHandler
Hypervisor->>VM1: Create Account
VM1->>AccountHandler: Register Account
Hypervisor->>VM2: Create Account
VM2->>AccountHandler: Register Account
VM1->>VM2: Send Cross-VM Message
Hypervisor->>AccountHandler: Validate Message
AccountHandler-->>Hypervisor: Message Validation Result
Possibly related PRs
Suggested labels
Suggested reviewers
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
Signed-off-by: oftenoccur <ezc5@sina.com>
![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
🧹 Nitpick comments (2)
docs/rfc/rfc-003-crosslang.md (2)
Line range hint
1-400: Consider enhancing documentation with examplesThe RFC provides a comprehensive theoretical framework, but could benefit from:
- Code examples demonstrating the implementation of account handlers in different languages
- Sequence diagrams illustrating message flow between accounts and modules
- Concrete examples of volatility rules in action
These additions would help developers better understand the practical implications of the design.
🧰 Tools
🪛 LanguageTool
[style] ~167-~167: For conciseness, try rephrasing this sentence.
Context: ...rdinate around the usage of this token. It is possible that state modules expose methods for creating new **state tokens...(MAY_MIGHT_BE)
Line range hint
1-400: Specify timelines for future specificationsThe document mentions several aspects that will be specified in future updates or separate RFCs:
- Message packet layout details
- Message encoding and naming standards
- Storage specifications
- Event handling
- Authorization middleware details
Consider adding tentative timelines or tracking issues for these specifications to help manage expectations and dependencies.
🧰 Tools
🪛 LanguageTool
[style] ~167-~167: For conciseness, try rephrasing this sentence.
Context: ...rdinate around the usage of this token. It is possible that state modules expose methods for creating new **state tokens...(MAY_MIGHT_BE)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/rfc/rfc-003-crosslang.md(1 hunks)schema/testing/statesim/module_diff.go(1 hunks)simapp/v2/export.go(1 hunks)x/auth/ante/unordered.go(1 hunks)x/tx/decode/unknown.go(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- schema/testing/statesim/module_diff.go
- x/tx/decode/unknown.go
- simapp/v2/export.go
- x/auth/ante/unordered.go
🧰 Additional context used
📓 Path-based instructions (1)
docs/rfc/rfc-003-crosslang.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🔇 Additional comments (1)
docs/rfc/rfc-003-crosslang.md (1)
165-165:
Fix typo in volatility description
There's a typo in the word "readonly":
-* `volatile`: the handler can have side effects and send `volatile`, `radonly` or `pure` messages to other accounts. Such handlers are expected to both read and write state.
+* `volatile`: the handler can have side effects and send `volatile`, `readonly` or `pure` messages to other accounts. Such handlers are expected to both read and write state.Likely invalid or redundant comment.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
| @@ -162,7 +162,7 @@ These bytes can be used by the **state handler** to determine what type of state | |||
|
|
|||
| A **state token** is an opaque array of 32-bytes that is passed in each message request. | |||
| The hypervisor has no knowledge of what this token represents or how it is created, | |||
| but it is expected that modules that mange state do understand this token and use it to manage all state changes | |||
| but it is expected that modules that manage state do understand this token and use it to manage all state changes | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
| @@ -40,7 +40,7 @@ func DiffModuleStates(expected, actual view.ModuleState) string { | |||
| continue | |||
| } | |||
| if actualColl == nil { | |||
| res += fmt.Sprintf("Object Collection %s: actuall collection NOT FOUND\n", objTypeName) | |||
| res += fmt.Sprintf("Object Collection %s: actual collection NOT FOUND\n", objTypeName) | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
simapp/v2/export.go
Outdated
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
| @@ -44,7 +44,7 @@ var _ sdk.AnteDecorator = (*UnorderedTxDecorator)(nil) | |||
| // The UnorderedTxDecorator should be placed as early as possible in the AnteHandler | |||
| // chain to ensure that during DeliverTx, the transaction is added to the UnorderedTxManager. | |||
| type UnorderedTxDecorator struct { | |||
| // maxUnOrderedTTL defines the maximum TTL a transaction can define. | |||
| // maxTimeoutDuration defines the maximum TTL a transaction can define. | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
| @@ -98,7 +98,7 @@ func doRejectUnknownFields( | |||
| } | |||
| // if a message descriptor is a placeholder resolve it using the injected resolver. | |||
| // this can happen when a descriptor has been registered in the | |||
| // "google.golang.org/protobuf" resgistry but not in "github.com/cosmos/gogoproto". | |||
| // "google.golang.org/protobuf" registry but not in "github.com/cosmos/gogoproto". | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
Description
fix struct field name and some typos in comment
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...
!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
Documentation
Bug Fixes
Chores