-
Notifications
You must be signed in to change notification settings - Fork 37
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
chore: update Changelog and Readme #181
Conversation
WalkthroughThe recent updates to the KYVE Network bring significant improvements in multi-coin support across various modules like bundles, funders, and delegation. Additionally, there are enhancements in storage cost management, proposal processes, and dependency updates for better functionality and performance. 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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
Out of diff range and nitpick comments (2)
README.md (2)
Line range hint
47-58
: Ensure proper formatting around headings and code blocks.+ #### Root + To create a regular `kyve-network/kyve:${VERSION}` docker image with `kyved` binary only execute: ```bash 51~ make docker-image 52~
To create the corresponding debug image containing a
sh
shell executemake docker-image-debug
.
+Nonroot
To create a nonroot docker image
kyve-network/kyve:${VERSION}-nonroot
running with usernonroot:65532
:58~ make docker-image-nonroot 59~
Adding blank lines around headings and code blocks improves readability and adheres to Markdown best practices. --- Line range hint `52-52`: Add a comma for clarity in instructions. ```diff - To create the corresponding debug image containing a `sh` shell execute `make docker-image-debug`. + To create the corresponding debug image containing a `sh` shell, execute `make docker-image-debug`.
This change clarifies that the execution of the command is a separate action.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- CHANGELOG.md (1 hunks)
- README.md (1 hunks)
Additional Context Used
LanguageTool (29)
CHANGELOG.md (28)
Near line 39: Unpaired symbol: ‘[’ seems to be missing
Context: ... Add funders back to pool query. - [#163](https://github.com/KYVENetwork/chain/pu...
Near line 41: Unpaired symbol: ‘[’ seems to be missing
Context: ...YVE and Cosmos REST queries. ## [v1.4.0](https://github.com/KYVENetwork/chain/re...
Near line 46: Unpaired symbol: ‘[’ seems to be missing
Context: ...nhancing-kyves-funders-concept). - [#128](https://github.com/KYVENetwork/chain/pu...
Near line 55: Unpaired symbol: ‘[’ seems to be missing
Context: ...47.6-kyve-rc0)). ### Bug Fixes - [#149](https://github.com/KYVENetwork/chain/pu...
Near line 58: Unpaired symbol: ‘[’ seems to be missing
Context: ...gs amount for tx redelegate. ## [v1.3.2](https://github.com/KYVENetwork/chain/re...
Near line 69: Unpaired symbol: ‘[’ seems to be missing
Context: ...ap to genesis import/export. ## [v1.3.1](https://github.com/KYVENetwork/chain/re...
Near line 73: Unpaired symbol: ‘[’ seems to be missing
Context: ....1) - 2023-08-02 ### Bug Fixes - [#122](https://github.com/KYVENetwork/chain/pu...
Near line 75: Unpaired symbol: ‘[’ seems to be missing
Context: ...kefile go version parse cmd. ## [v1.3.0](https://github.com/KYVENetwork/chain/re...
Near line 92: Unpaired symbol: ‘[’ seems to be missing
Context: ...ds to be claimed. ### Bug Fixes - [#96](https://github.com/KYVENetwork/chain/pu...
Near line 96: Using many exclamation marks might seem excessive (in this case: 21 exclamation marks for a text that’s 11263 characters long)
Context: ...de auth module. ### Client Breaking - ! (x/stakers
) [#46](https://github.com/...
Near line 104: Unpaired symbol: ‘[’ seems to be missing
Context: ...for finalized bundles query. ## [v1.2.3](https://github.com/KYVENetwork/chain/re...
Near line 111: Unpaired symbol: ‘[’ seems to be missing
Context: ...for finalized bundles query. ## [v1.2.2](https://github.com/KYVENetwork/chain/re...
Near line 117: Unpaired symbol: ‘[’ seems to be missing
Context: ...security-advisory-barberry). ## [v1.2.1](https://github.com/KYVENetwork/chain/re...
Near line 123: Unpaired symbol: ‘[’ seems to be missing
Context: ...urity-advisory-huckleberry). ## [v1.2.0](https://github.com/KYVENetwork/chain/re...
Near line 127: Unpaired symbol: ‘[’ seems to be missing
Context: ...2.0) - 2023-05-16 ### Bug Fixes - [#48](https://github.com/KYVENetwork/chain/pu...
Near line 130: Unpaired symbol: ‘[’ seems to be missing
Context: ...iple KYVE Core Team members. ## [v1.1.3](https://github.com/KYVENetwork/chain/re...
Near line 136: Unpaired symbol: ‘[’ seems to be missing
Context: ...urity-advisory-huckleberry). ## [v1.1.2](https://github.com/KYVENetwork/chain/re...
Near line 142: Unpaired symbol: ‘[’ seems to be missing
Context: ...t` when submitting a bundle. ## [v1.1.1](https://github.com/KYVENetwork/chain/re...
Near line 146: Unpaired symbol: ‘[’ seems to be missing
Context: ...) - 2023-05-08 ### Improvements - [#34](https://github.com/KYVENetwork/chain/pu...
Near line 148: Unpaired symbol: ‘[’ seems to be missing
Context: ...ve-ventures/interchaintest). ## [v1.1.0](https://github.com/KYVENetwork/chain/re...
Near line 152: Unpaired symbol: ‘[’ seems to be missing
Context: ...) - 2023-04-18 ### Improvements - [#22](https://github.com/KYVENetwork/chain/pu...
Near line 159: Unpaired symbol: ‘[’ seems to be missing
Context: ...received via IBC. ### Bug Fixes - [#20](https://github.com/KYVENetwork/chain/pu...
Near line 168: Unpaired symbol: ‘[’ seems to be missing
Context: ...tadata fields. ### API Breaking - [#22](https://github.com/KYVENetwork/chain/pu...
Near line 182: Unpaired symbol: ‘[’ seems to be missing
Context: ... fields, deprecatingLogo
. ## [v1.0.1](https://github.com/KYVENetwork/chain/re...
Near line 186: Unpaired symbol: ‘[’ seems to be missing
Context: ...) - 2023-05-08 ### Improvements - [#34](https://github.com/KYVENetwork/chain/pu...
Near line 188: Unpaired symbol: ‘[’ seems to be missing
Context: ...ve-ventures/interchaintest). ## [v1.0.0](https://github.com/KYVENetwork/chain/re...
Near line 192: Unpaired symbol: ‘[’ seems to be missing
Context: ...the KYVE network launch. ## [v1.0.0-rc1](https://github.com/KYVENetwork/chain/re...
Near line 207: Unpaired symbol: ‘[’ seems to be missing
Context: ...param to typesdk.Dec
. ## [v1.0.0-rc0](https://github.com/KYVENetwork/chain/re...README.md (1)
Near line 52: Possible missing comma found.
Context: ...esponding debug image containing ash
shell executemake docker-image-debug
. ###...
Additional comments not posted (1)
CHANGELOG.md (1)
31-32
: Clarify the removal of the dev-dependency.Please confirm the specific dev-dependency that was removed and ensure that it is no longer used anywhere in the project.
Verification successful
The removal of the
go-ethereum
dependency as noted in the CHANGELOG.md and associated pull request has been verified. The search across the codebase did not find any occurrences ofgo-ethereum
, confirming its removal.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the removal of the unnecessary dev-dependency. # Test: Search for the dependency in the project. Expect: No occurrences. rg --type all 'name_of_dependency'Length of output: 34
Script:
#!/bin/bash # Fetch the details of the pull request to identify the removed dev-dependency gh pr view 171 --repo KYVENetwork/chain --json bodyLength of output: 501
Script:
#!/bin/bash # Assuming the dependency name is extracted and stored in a variable `dependency_name`, verify its absence in the codebase dependency_name="extracted_dependency_name" # This line is a placeholder and should be replaced with the actual dependency name extracted from the PR rg --type all "$dependency_name"Length of output: 85
Script:
#!/bin/bash # Fetch the commit details from the pull request to identify the removed dev-dependency gh pr view 171 --repo KYVENetwork/chain --json commitsLength of output: 1015
Script:
#!/bin/bash # Assuming the dependency name is extracted and stored in a variable `dependency_name`, verify its absence in the codebase dependency_name="extracted_dependency_name" # This line is a placeholder and should be replaced with the actual dependency name extracted from the PR commits rg --type all "$dependency_name"Length of output: 85
Script:
#!/bin/bash # Verify the absence of 'go-ethereum' in the codebase rg --type all "go-ethereum"Length of output: 27
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
Out of diff range and nitpick comments (1)
CHANGELOG.md (1)
Line range hint
42-42
: Unpaired symbol: ‘[’ seems to be missing.- - [#163](https://github.com/KYVENetwork/chain/pull/163) Add back swagger UI for KYVE and Cosmos REST queries. + - ([#163](https://github.com/KYVENetwork/chain/pull/163)) Add back swagger UI for KYVE and Cosmos REST queries.Ensure that all markdown links are correctly paired.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CHANGELOG.md (1 hunks)
Additional Context Used
LanguageTool (29)
CHANGELOG.md (29)
Near line 31: Unpaired symbol: ‘[’ seems to be missing
Context: ...ploader-role. ### Improvements - [#182](https://github.com/KYVENetwork/chain/pu...
Near line 42: Unpaired symbol: ‘[’ seems to be missing
Context: ... Add funders back to pool query. - [#163](https://github.com/KYVENetwork/chain/pu...
Near line 44: Unpaired symbol: ‘[’ seems to be missing
Context: ...YVE and Cosmos REST queries. ## [v1.4.0](https://github.com/KYVENetwork/chain/re...
Near line 49: Unpaired symbol: ‘[’ seems to be missing
Context: ...nhancing-kyves-funders-concept). - [#128](https://github.com/KYVENetwork/chain/pu...
Near line 58: Unpaired symbol: ‘[’ seems to be missing
Context: ...47.6-kyve-rc0)). ### Bug Fixes - [#149](https://github.com/KYVENetwork/chain/pu...
Near line 61: Unpaired symbol: ‘[’ seems to be missing
Context: ...gs amount for tx redelegate. ## [v1.3.2](https://github.com/KYVENetwork/chain/re...
Near line 72: Unpaired symbol: ‘[’ seems to be missing
Context: ...ap to genesis import/export. ## [v1.3.1](https://github.com/KYVENetwork/chain/re...
Near line 76: Unpaired symbol: ‘[’ seems to be missing
Context: ....1) - 2023-08-02 ### Bug Fixes - [#122](https://github.com/KYVENetwork/chain/pu...
Near line 78: Unpaired symbol: ‘[’ seems to be missing
Context: ...kefile go version parse cmd. ## [v1.3.0](https://github.com/KYVENetwork/chain/re...
Near line 95: Unpaired symbol: ‘[’ seems to be missing
Context: ...ds to be claimed. ### Bug Fixes - [#96](https://github.com/KYVENetwork/chain/pu...
Near line 99: Using many exclamation marks might seem excessive (in this case: 23 exclamation marks for a text that’s 11566 characters long)
Context: ...de auth module. ### Client Breaking - ! (x/stakers
) [#46](https://github.com/...
Near line 107: Unpaired symbol: ‘[’ seems to be missing
Context: ...for finalized bundles query. ## [v1.2.3](https://github.com/KYVENetwork/chain/re...
Near line 114: Unpaired symbol: ‘[’ seems to be missing
Context: ...for finalized bundles query. ## [v1.2.2](https://github.com/KYVENetwork/chain/re...
Near line 120: Unpaired symbol: ‘[’ seems to be missing
Context: ...security-advisory-barberry). ## [v1.2.1](https://github.com/KYVENetwork/chain/re...
Near line 126: Unpaired symbol: ‘[’ seems to be missing
Context: ...urity-advisory-huckleberry). ## [v1.2.0](https://github.com/KYVENetwork/chain/re...
Near line 130: Unpaired symbol: ‘[’ seems to be missing
Context: ...2.0) - 2023-05-16 ### Bug Fixes - [#48](https://github.com/KYVENetwork/chain/pu...
Near line 133: Unpaired symbol: ‘[’ seems to be missing
Context: ...iple KYVE Core Team members. ## [v1.1.3](https://github.com/KYVENetwork/chain/re...
Near line 139: Unpaired symbol: ‘[’ seems to be missing
Context: ...urity-advisory-huckleberry). ## [v1.1.2](https://github.com/KYVENetwork/chain/re...
Near line 145: Unpaired symbol: ‘[’ seems to be missing
Context: ...t` when submitting a bundle. ## [v1.1.1](https://github.com/KYVENetwork/chain/re...
Near line 149: Unpaired symbol: ‘[’ seems to be missing
Context: ...) - 2023-05-08 ### Improvements - [#34](https://github.com/KYVENetwork/chain/pu...
Near line 151: Unpaired symbol: ‘[’ seems to be missing
Context: ...ve-ventures/interchaintest). ## [v1.1.0](https://github.com/KYVENetwork/chain/re...
Near line 155: Unpaired symbol: ‘[’ seems to be missing
Context: ...) - 2023-04-18 ### Improvements - [#22](https://github.com/KYVENetwork/chain/pu...
Near line 162: Unpaired symbol: ‘[’ seems to be missing
Context: ...received via IBC. ### Bug Fixes - [#20](https://github.com/KYVENetwork/chain/pu...
Near line 171: Unpaired symbol: ‘[’ seems to be missing
Context: ...tadata fields. ### API Breaking - [#22](https://github.com/KYVENetwork/chain/pu...
Near line 185: Unpaired symbol: ‘[’ seems to be missing
Context: ... fields, deprecatingLogo
. ## [v1.0.1](https://github.com/KYVENetwork/chain/re...
Near line 189: Unpaired symbol: ‘[’ seems to be missing
Context: ...) - 2023-05-08 ### Improvements - [#34](https://github.com/KYVENetwork/chain/pu...
Near line 191: Unpaired symbol: ‘[’ seems to be missing
Context: ...ve-ventures/interchaintest). ## [v1.0.0](https://github.com/KYVENetwork/chain/re...
Near line 195: Unpaired symbol: ‘[’ seems to be missing
Context: ...the KYVE network launch. ## [v1.0.0-rc1](https://github.com/KYVENetwork/chain/re...
Near line 210: Unpaired symbol: ‘[’ seems to be missing
Context: ...param to typesdk.Dec
. ## [v1.0.0-rc0](https://github.com/KYVENetwork/chain/re...
Additional comments not posted (1)
CHANGELOG.md (1)
21-27
: Ensure consistency in the use of exclamation marks.- - ! (`x/funders`) [#179](https://github.com/KYVENetwork/chain/pull/179) Support multiple coins for funding. + - (`x/funders`) [#179](https://github.com/KYVENetwork/chain/pull/179) Support multiple coins for funding.The use of exclamation marks should be consistent and reserved for significant breaking changes. If these are not breaking changes, the exclamation marks should be removed.
- [#182](https://github.com/KYVENetwork/chain/pull/182) Make release builds reproducible. | ||
- ! [#183](https://github.com/KYVENetwork/chain/pull/183) Only charge coins which are whitelisted. | ||
- ! (deps) [#174](https://github.com/KYVENetwork/chain/pull/174) Add mainnet KYVE image to interchain tests. | ||
- ! (deps) [#171](https://github.com/KYVENetwork/chain/pull/171) Bump ibc version to v8.2.0 and remove unnecessary dev-dependency. | ||
- ! (deps) [#169](https://github.com/KYVENetwork/chain/pull/169) Migrate to Cosmos-SDK v0.50 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ensure consistency in the use of exclamation marks.
- - ! [#183](https://github.com/KYVENetwork/chain/pull/183) Only charge coins which are whitelisted.
+ - [#183](https://github.com/KYVENetwork/chain/pull/183) Only charge coins which are whitelisted.
The use of exclamation marks should be consistent and reserved for significant breaking changes. If these are not breaking changes, the exclamation marks should be removed.
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.
- [#182](https://github.com/KYVENetwork/chain/pull/182) Make release builds reproducible. | |
- ! [#183](https://github.com/KYVENetwork/chain/pull/183) Only charge coins which are whitelisted. | |
- ! (deps) [#174](https://github.com/KYVENetwork/chain/pull/174) Add mainnet KYVE image to interchain tests. | |
- ! (deps) [#171](https://github.com/KYVENetwork/chain/pull/171) Bump ibc version to v8.2.0 and remove unnecessary dev-dependency. | |
- ! (deps) [#169](https://github.com/KYVENetwork/chain/pull/169) Migrate to Cosmos-SDK v0.50 | |
- [#182](https://github.com/KYVENetwork/chain/pull/182) Make release builds reproducible. | |
- [#183](https://github.com/KYVENetwork/chain/pull/183) Only charge coins which are whitelisted. | |
- ! (deps) [#174](https://github.com/KYVENetwork/chain/pull/174) Add mainnet KYVE image to interchain tests. | |
- ! (deps) [#171](https://github.com/KYVENetwork/chain/pull/171) Bump ibc version to v8.2.0 and remove unnecessary dev-dependency. | |
- ! (deps) [#169](https://github.com/KYVENetwork/chain/pull/169) Migrate to Cosmos-SDK v0.50 |
### Improvements | ||
|
||
- [#182](https://github.com/KYVENetwork/chain/pull/182) Make release builds reproducible. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unpaired symbol: ‘[’ seems to be missing.
- - [#182](https://github.com/KYVENetwork/chain/pull/182) Make release builds reproducible.
+ - ([#182](https://github.com/KYVENetwork/chain/pull/182)) Make release builds reproducible.
Ensure that all markdown links are correctly paired.
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.
- [#182](https://github.com/KYVENetwork/chain/pull/182) Make release builds reproducible. | |
- ([#182](https://github.com/KYVENetwork/chain/pull/182)) Make release builds reproducible. |
Summary by CodeRabbit
New Features
Documentation
Dependencies