docs: bump ibc for v6.5 #2555
docs: bump ibc for v6.5 #2555
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe recent update brings several notable changes and improvements. Key updates include the addition of version Changes
Poem
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: 3
Outside diff range and nitpick comments (3)
RELEASE_NOTES.md (1)
Line range hint
9-33: Ensure grammatical correctness in the release notes to maintain professionalism.- doesn't correctly re-established a connection + doesn't correctly re-establish a connection - Download latest binary + Download the latest binary - Wait for software upgrade proposal + Wait for the software upgrade proposal - Ensure latest Price Feeder + Ensure the latest Price FeederAlso, consider removing multiple blank lines to comply with Markdown best practices.
Tools
LanguageTool
[grammar] ~24-~24: The auxiliary verb ‘do’ requires the base form of the verb. (DID_BASEFORM)
Context: ...ved that Price Feeder doesn't correctly re-established a connection after the chain upgrade. ...
[uncategorized] ~28-~28: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: .... ### Upgrade instructions - Download latest binary or build from source. - Make sur...Markdownlint
17-17: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank linesutil/ibc/ibc_test.go (1)
Line range hint
10-52: The tests for packet transfer validations are well-implemented. Consider using table-driven tests to cover more edge cases and improve test maintainability.util/ibc/ibc.go (1)
14-15: Consider documenting the rationale behind the specific maximum length values for receiver and memo fields.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
go.sumis excluded by!**/*.sum
Files selected for processing (13)
- CHANGELOG.md (2 hunks)
- README.md (1 hunks)
- RELEASE_NOTES.md (1 hunks)
- app/upgrades.go (1 hunks)
- go.mod (8 hunks)
- tests/e2e/e2e_ibc_test.go (2 hunks)
- tests/e2e/setup/utils.go (1 hunks)
- tests/tsdk/string.go (1 hunks)
- tests/tsdk/string_test.go (1 hunks)
- tools/tools.go (1 hunks)
- util/ibc/ibc.go (2 hunks)
- util/ibc/ibc_test.go (2 hunks)
- x/oracle/keeper/historic_price.go (1 hunks)
Files skipped from review due to trivial changes (1)
- tests/tsdk/string_test.go
Additional context used
LanguageTool
RELEASE_NOTES.md
[grammar] ~24-~24: The auxiliary verb ‘do’ requires the base form of the verb. (DID_BASEFORM)
Context: ...ved that Price Feeder doesn't correctly re-established a connection after the chain upgrade. ...
[uncategorized] ~28-~28: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: .... ### Upgrade instructions - Download latest binary or build from source. - Make sur...
[uncategorized] ~31-~31: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...rks for you:umeed version- Wait for software upgrade proposal to pass and trigger th...
[uncategorized] ~33-~33: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...hain upgrade. - Swap binaries. - Ensure latest Price Feeder (see [compatibility matrix...README.md
[uncategorized] ~20-~20: The adjective “market-driven” is spelled with a hyphen. (DRIVEN_HYPHEN)
Context: ...ally determined interest rates based on market driven conditions. As a cross chain DeFi proto...
[grammar] ~26-~26: You’ve repeated a verb. Did you mean to only write one of them? (REPEATED_VERBS)
Context: ...ble of Contents](#table-of-contents) - Releases - [Release Compatibility Matrix](#release-compatib...
[uncategorized] ~76-~76: A comma may be missing after the conjunctive/linking adverb ‘However’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...reated as a part of the build process. However when you download a binary from GitHub,...
[grammar] ~113-~113: Did you mean “installing”? Or maybe you should add a pronoun? In active voice, ‘require’ + ‘to’ takes an object, usually a pronoun. (ALLOW_TO)
Context: ...e recommend to use RocksDB. It requires to installrocksdbsystem libraries. We plan to ...
[grammar] ~114-~114: An article may be missing. (BUNCH_OF)
Context: ...newer version of badgerdb, which brings lot of improvements and simplifies the setup. ...CHANGELOG.md
[grammar] ~107-~107: Using ‘plenty’ without ‘of’ is considered to be informal. (PLENTY_OF_NOUNS)
Context: .../pull/2368) Fix inflow amount calculation. Previously, the inflow amount of the t...
[grammar] ~209-~209: Did you mean “limiting”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun. (ALLOW_TO)
Context: ...veragedLiquidate.MaxRepay` which allows to limit the liquidation size using the leverage...
[grammar] ~342-~342: The singular proper name ‘Bridge’ must be used with a third-person or a past tense verb. (HE_VERB_AGR)
Context: ...-network/umee/pull/1967) Gravity Bridge phase out phase-2: disable Umee -> Ethereum t...
[grammar] ~343-~343: The singular proper name ‘Bridge’ must be used with a third-person or a past tense verb. (HE_VERB_AGR)
Context: ...-network/umee/pull/1967) Gravity Bridge phase out phase-2: disable Umee -> Ethereum t...
[grammar] ~393-~393: Make sure that the singular noun after the number ‘4.1’ is correct. (CD_POINT_CD_NN)
Context: ...e/pull/1807) Fixes BNB ibc denom in 4.1 migration - [1812](https://github.com/umee-networ...
[style] ~411-~411: In contexts where ‘if’ is followed by ‘or’, using ‘whether’ may be more appropriate (and formal). (IF_WHETHER)
Context: ...rowandMsgRepay` won't return errors if there is nothing to withdraw, borrow or...
[duplication] ~462-~462: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...e/pull/1555) Updates IBC to v5.1.0 that adds adds optional memo field to `FungibleTokenPa...
[uncategorized] ~519-~519: A comma may be missing after the conjunctive/linking adverb ‘Also’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...ableLend, docs, and internal functions. Also QueryLoaned similar queries to QuerySup...
[misspelling] ~523-~523: This word is normally spelled as one. (EN_COMPOUNDS_PROTO_TYPES)
Context: ...roto getters in x/leverage and x/oracle proto types. - [1126](https://github.com/umee-netwo...
[duplication] ~642-~642: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...k/umee/pull/1358/files) Disable Gravity Bridge bridge messages. ### Improvements - [#1355](...
Markdownlint
RELEASE_NOTES.md
17-17: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
Additional comments not posted (12)
tools/tools.go (1)
Line range hint
1-10: Tool tracking in this file follows the recommended practices for Go modules. Good job on maintaining clean and up-to-date tool dependencies.util/ibc/ibc_test.go (1)
Line range hint
53-62: TheTestGetLocalDenomfunction is straightforward and correctly implemented.util/ibc/ibc.go (2)
18-23: TheValidateRecvAddrfunction correctly checks the length againstMaximumReceiverLength. The error handling is appropriate usingibcerrors.ErrInvalidAddress.
Line range hint
31-50: TheGetFundsFromPacketfunction is well-implemented, with correct error handling and validation checks using the previously definedValidateRecvAddrandValidateMemo.app/upgrades.go (1)
54-54: The registration of thev6.5upgrade is consistent with previous patterns and correctly usesupgradeInfo.README.md (1)
67-67: The addition of versionv6.5.xin the compatibility matrix is clear and correctly formatted.tests/e2e/e2e_ibc_test.go (1)
169-176: The test for IBC token transfer with a receiver address exceeding the maximum length is correctly implemented. It ensures that the system handles such cases as expected.x/oracle/keeper/historic_price.go (1)
48-48: Ensure proper error wrapping for better error handling.go.mod (1)
12-12: Dependency updates align with the project's needs for the new version.Also applies to: 14-14, 15-15, 19-19, 31-31, 33-33, 34-34, 35-35, 44-44, 46-46, 110-110, 112-112, 115-115, 170-170, 186-186, 204-204, 205-205, 206-206, 207-207, 208-208, 213-213, 214-214, 221-221, 223-223, 224-224, 238-238, 239-239
CHANGELOG.md (3)
47-52: The changelog entry for version v6.5.0 correctly details the restriction on the IBC transfer memo and receiver fields as per the PR objectives. This ensures that users are aware of the changes and their implications.
67-67: The bug fix entry for v6.4.0 regarding theMaxModuleWithdrawconsideration inx/leverageis well documented. This entry helps users understand the specific changes made to the leverage calculations, which is crucial for transparency and user trust.
53-57: The changelog for version v6.4.1 includes an update on dependency changes. Ensure that all dependency updates are correctly listed and linked for full traceability and ease of access.Verification successful
The broader search range and general terms did not yield additional dependency update commits. This suggests that the changelog entry for v6.4.1 correctly lists the dependency updates.
- : The changelog entry for v6.4.1 correctly lists and links the dependency update commit. No additional dependency update commits were found around the release date.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all dependency updates are correctly listed in the v6.4.1 changelog entry. # Test: Search for dependency update commits around the release of v6.4.1. Expect: Corresponding entries in CHANGELOG.md. rg --type markdown $'Update dependencies' CHANGELOG.mdLength of output: 174
Script:
#!/bin/bash # Description: List all dependency update commits around the release of v6.4.1. # Get the release date of v6.4.1 from the changelog release_date="2024-04-30" # List all commits related to dependencies around the release date git log --since="$release_date" --until="$(date -I -d "$release_date + 1 month")" --grep="Update dependencies" --pretty=format:"%h %s"Length of output: 163
Script:
#!/bin/bash # Description: List all dependency update commits around the release of v6.4.1 with a broader search range. # Get the release date of v6.4.1 from the changelog release_date="2024-04-30" # List all commits related to dependencies around the release date with a broader search range git log --since="$(date -I -d "$release_date - 1 month")" --until="$(date -I -d "$release_date + 1 month")" --grep="dependenc" --pretty=format:"%h %s"Length of output: 188
Description
let's bring latest patches to the release
Summary by CodeRabbit
New Features
Documentation
CHANGELOG.md,README.md, andRELEASE_NOTES.mdto reflect new versionv6.5.0and detailed changes.Bug Fixes
Tests
Chores
golangci-lintto clean up dependencies.