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.

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

feat: Remove the store/internal module #18944

Merged
merged 8 commits into from
Jan 4, 2024
Merged

Conversation

cool-develope
Copy link
Contributor

@cool-develope cool-develope commented Jan 4, 2024

Description

Closes: #18738
Closes: #13534

  • Removed the original store/internal module
  • Added the simple merkle tree proof implementation

Regarding the issue #13534 , it introduced the new ics23 proof spec instead of TendermintSpec, since the store hash is already sha256 hash of the tree root, it doesn't make sense to use PreHash_SHA256. Also removed the unnecessary map conversion processes.


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

@cool-develope cool-develope requested a review from a team as a code owner January 4, 2024 12:32
Copy link
Contributor

coderabbitai bot commented Jan 4, 2024

Walkthrough

The recent updates involve enhancing the store module by removing dependencies on the internal module, adding a new CommitHash field to the CommitInfo struct, and refining the hash computation logic. The changes also introduce a simple Merkle proof implementation, which includes new methods for generating and handling proofs without relying on external crypto imports. The goal is to achieve a loosely coupled design and a self-contained proof format.

Changes

File(s) Change Summary
store/commit_info.go Added CommitHash field; updated Hash method; added GetStoreProof method.
store/proof.go Introduces changes related to the implementation of a simple Merkle proof.
store/proof_test.go Introduces a new test function TestProofFromBytesSlices that tests the functionality of creating proofs from byte slices.
store/root/store.go Modifies the way commitHash is initialized and hashed.

Assessment against linked issues

Objective Addressed Explanation
Remove the internal module from store and implement own proof format without cometbft/protof/tendermint/crypto imports (#18738) The changes in store/proof.go and the introduction of GetStoreProof method in commit_info.go indicate the move towards an independent proof format without external imports.
Avoid specifying the proof format and ensure loose coupling in the store module (#18738) By removing dependencies on the internal module and implementing a simple Merkle proof, the code changes promote loose coupling.
Address the issue with the ProofFromMap used in the multi-store proof discussed in the context (#18738) The summary does not explicitly mention ProofFromMap. If ProofFromMap was part of the internal module, then its removal and the creation of a new proof format suggest the issue might be addressed, but without specific details, this cannot be confirmed.

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's AI:

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.
    • @coderabbitai read the files in the src/scheduler package and generate 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.

Copy link
Contributor

github-actions bot commented Jan 4, 2024

@cool-develope your pull request is missing a changelog!

@cool-develope
Copy link
Contributor Author

Can we close #13534 here?

@tac0turtle
Copy link
Member

Can we close #13534 here?

i think that makes sense.

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.

Amazing, TYSM 👍

store/proof.go Outdated
Comment on lines 183 to 186
data := innerPrefix
data = append(data, left...)
data = append(data, right...)
h := sha256.Sum256(data)
Copy link
Contributor

Choose a reason for hiding this comment

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

I would allocate the exact amount of bytes for this instead of assigning from innerPrefix.

hash := make([]byte, len(innerPrefix) + len(left) + len(right))
copy(...)

@alexanderbez
Copy link
Contributor

Can we close #13534 here?

yup!

@cool-develope cool-develope added this pull request to the merge queue Jan 4, 2024
Merged via the queue into main with commit 014cbbc Jan 4, 2024
58 of 59 checks passed
@cool-develope cool-develope deleted the feat/store_internal branch January 4, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove the internal module from store remove simple map usage for multistore roothash/proof creation
3 participants