docs: update ADR 27 #5815
docs: update ADR 27 #5815
Conversation
crodriguezvega
requested review from
colin-axner,
AdityaSripal,
charleenfei,
damiannolan,
chatton,
DimitrisJim and
srdtrk
as code owners
|
Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
WalkthroughThe update to the IBC-Wasm documentation refines the governance process for adding new IBC light client contracts, specifies the format for Wasm bytecode storage, adjusts client message verification, clarifies bytecode checksum storage, and enhances the explanation of light client proxy functionality, improving system integrity and functionality. Changes
Assessment against linked issues
Related issues
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.
Review Status
Actionable comments generated: 6
Configuration used: CodeRabbit UI
Files selected for processing (1)
- docs/architecture/adr-027-ibc-wasm.md (5 hunks)
Additional comments: 10
docs/architecture/adr-027-ibc-wasm.md (10)
- 7-7: The term "ibc-go" is correct in this context, referring to the specific module within the Cosmos SDK. The suggested replacements are not applicable.
- 4-14: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [18-18]
The term "bytecode" is correctly spelled as one word in the context of computing and programming languages.
- 27-27: The term "ibc-go" is correct in this context, referring to the specific module within the Cosmos SDK. The suggested replacements are not applicable.
- 4-14: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [36-36]
The term "bytecode" is correctly spelled as one word in the context of computing and programming languages.
- 4-14: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [40-40]
The term "bytecode" is correctly spelled as one word in the context of computing and programming languages.
- 4-14: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [47-47]
The term "bytecode" is correctly spelled as one word in the context of computing and programming languages.
- 58-58: The term "bytecode" is correctly spelled as one word in the context of computing and programming languages.
- 94-94: The term "bytecode" is correctly spelled as one word in the context of computing and programming languages.
- 4-14: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [100-100]
The term "CosmWasm" is correctly spelled and refers to a specific framework for building smart contracts in the Cosmos ecosystem.
- 4-14: > 📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [150-150]
The term "bytecode" is correctly spelled as one word in the context of computing and programming languages.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
|
||
| - 26/11/2020: Initial Draft | ||
| - 26/05/2023: Update after 02-client refactor and re-implementation by Strangelove | ||
| - 13/12/2023: Update after upstreaming of module to ibc-go | ||
|
|
||
| ## Status | ||
|
|
||
| *Draft, needs updates* | ||
| *Accepted and applied in v0.1.0 of 08-wasm* | ||
|
|
||
| ## Abstract | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]
The term "Wasm based" should be hyphenated to "Wasm-based" for grammatical correctness.
- Wasm based light client
+ Wasm-based light client📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [15-15]
Consider adding a comma after "SDK" for better readability and changing "hardcoded" to "hard-coded" for consistency.
- In the Cosmos SDK light clients are currently hardcoded in Go.
+ In the Cosmos SDK, light clients are currently hard-coded in Go.📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [16-16]
The phrase "a multi step process" should be hyphenated to "a multi-step process" for grammatical correctness.
- a multi step process
+ a multi-step process📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [32-32]
The phrase "time consuming" should be hyphenated to "time-consuming" for grammatical correctness.
- time consuming process
+ time-consuming process📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [151-151]
The term "initialise" is a valid spelling in British English, but considering the document may target an international audience, aligning with American English spelling could improve consistency.
- initialise
+ initialize
Description
closes: #4121
Commit Message / Changelog Entry
see the guidelines for commit messages. (view raw markdown for examples)
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/) or specification (x/<module>/spec/).godoccomments.Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes.Summary by CodeRabbit