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.

Sign up for GitHub

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

Jump to bottom

fix: change prehash value back to sha256 from noop #19002

Merged
merged 4 commits into from
Jan 10, 2024
Merged

fix: change prehash value back to sha256 from noop #19002

merged 4 commits into from
Jan 10, 2024

Conversation

colin-axner
Copy link
Contributor

@colin-axner colin-axner commented Jan 10, 2024 •
edited
Loading

Description

Currently all chains use a spec which defines the prehash value to use sha256. If the root hash is not constructed with a prehash on the value, existing IBC clients will fail proof verification as they will be unable to match the roothash provided when updated with a cometbft header. It is possible to update IBC clients so that they expect no prehash on the value, but this requires chains to submit a on-chain upgrade which will commit to the new proof spec via a MsgIBCSoftwareUpgrade. Due to the extra coordination required to perform this upgrade, I would recommend leaving the prehash value as is until it is necessary to modify some other parameter within the IBC client, in which case we could do this change seamlessly as well.

credit to @damiannolan for doing this pr with me!

Closes: #XXXX

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

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@colin-axner @damiannolan
fix: change prehash value back to sha256 from noop
3e35fad 
Revert change to prehash value as this would require chains to upgrade the proof spec for their IBC clients.
Add documentation to increase readability of the proof generation code and the root hash construction.

Co-authored-by: Damian Nolan <damiannolan@gmail.com>
@colin-axner colin-axner requested a review from a team as a code owner January 10, 2024 11:29
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 10, 2024 •
edited
Loading

Walkthrough

The recent update introduces a new method to the CommitInfo struct for obtaining proof of a store key, with a fallback to the first store in lexicographical order when no key is specified. The proof.go file has been enriched with extensive comments and logic enhancements for proof construction, aligning with a specific ics23 version. Accompanying test cases in proof_test.go reflect these logic changes through updated expected hash values.

Changes

File Path Change Summary
store/commit_info.go Added GetStoreProof method to CommitInfo struct.
store/proof.go Updated with detailed comments/logic for proof construction.
store/proof_test.go Updated test cases with new expected hash values for proof logic.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions GitHub Actions
Copy link
Contributor

@colin-axner your pull request is missing a changelog!

cool-develope
cool-develope approved these changes Jan 10, 2024
View reviewed changes
Copy link
Contributor

@cool-develope cool-develope left a comment

Choose a reason for hiding this comment

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

Very appreciate for detailed documentation!

alexanderbez
alexanderbez approved these changes Jan 10, 2024
View reviewed changes
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

Phenomenal documentation, thanks team.

alexanderbez
alexanderbez approved these changes Jan 10, 2024
View reviewed changes
store/proof.go Outdated Show resolved Hide resolved
store/proof.go Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot reviewed Jan 10, 2024
View reviewed changes
store/proof.go Outdated Show resolved Hide resolved
@alexanderbez alexanderbez added this pull request to the merge queue Jan 10, 2024
Merged via the queue into main with commit 8c6df36 Jan 10, 2024
57 of 59 checks passed
@alexanderbez alexanderbez deleted the colin/store-prehash-value branch January 10, 2024 17:33
@cool-develope cool-develope mentioned this pull request Jan 11, 2024
Merged
12 tasks
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
@colin-axner @damiannolan
@alexanderbez @relyt29
fix: change prehash value back to sha256 from noop (cosmos#19002)
f9d1c56 
Co-authored-by: Damian Nolan <damiannolan@gmail.com>
Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai coderabbitai left review comments

@alexanderbez alexanderbez alexanderbez approved these changes

@cool-develope cool-develope cool-develope approved these changes

Assignees

@alexanderbez alexanderbez

@cool-develope cool-develope

Labels
C:Store
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@colin-axner @alexanderbez @cool-develope