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(store/v2): Implement the GetProof for multi store #18736

Merged
merged 22 commits into from
Jan 17, 2024
Merged

Conversation

cool-develope
Copy link
Contributor

Description

Closes: #18598

  • Implement the CommitInfo metadata storing in the commitment store
  • Add the multi store proof

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 December 13, 2023 16:42
Copy link
Contributor

coderabbitai bot commented Dec 13, 2023

Walkthrough

The codebase has undergone significant changes to enhance the cryptographic proof system, particularly for handling multi-store keys and their proofs. The modifications include the addition of new methods for marshaling and unmarshaling CommitInfo, calculating encoded sizes, and retrieving proofs and commit IDs from the store. Changes to method signatures and interfaces reflect a shift towards integrating cryptographic proof operations more tightly with the store's functionality.

Changes

File Pattern Change Summary
store/commit_info.go Added methods for encoding and cryptographic operations; new imports.
store/commitment/... Modified method signatures and comments for tree hashing and versioning; added database fields and functions.
store/database.go Updated import paths and interface method signatures for cryptographic operations.
store/encoding.go Added functions for encoding/decoding byte slices and varints; use of sync pools.
store/proof.go New imports; added methods for cryptographic proof operations; error handling.
store/pruning/..., store/root/..., store/store.go Adjusted to new function signatures and proof operations; test modifications.
store/internal/.../encoding.go Encoding/decoding functionality for varint length-prefixed byte slices; performance optimizations.
store/commit_info_test.go, store/root/store_test.go New test for store proof functionality; modified assertions for proof operations.
store/storage/pebbledb/iterator.go Removed return statement from the Next function.

Assessment against linked issues

Objective Addressed Explanation
Implement the GetProof considering the multi store keys (#18598) The code changes appear to address the primary objective of implementing the GetProof function with consideration for the multi-store keys structure. The addition of new methods and changes in method signatures across various files, including store/commit_info.go, store/commitment/store.go, and store/proof.go, align with the requirements to handle CommitInfo for given heights and improve the proof system for multi-store keys. The code modifications suggest that the proof of multi-store structure has been incorporated, meeting the issue's objective.

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.

@cool-develope cool-develope marked this pull request as draft December 13, 2023 16:42
@cool-develope cool-develope marked this pull request as ready for review January 5, 2024 12:50
Copy link
Contributor

github-actions bot commented Jan 5, 2024

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

Comment on lines +99 to +110
// encodeBytesSlice length-prefixes the byte slice and returns it.
func EncodeBytesSlice(bz []byte) ([]byte, error) {
buf := bufPool.Get().(*bytes.Buffer)
buf.Reset()
defer bufPool.Put(buf)

err := EncodeBytes(buf, bz)

bytesCopy := make([]byte, buf.Len())
copy(bytesCopy, buf.Bytes())

return bytesCopy, err
Copy link
Contributor

Choose a reason for hiding this comment

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

The EncodeBytesSlice function uses a buffer pool to encode bytes, which is a good practice. However, ensure that the error from EncodeBytes is checked before making a copy of the buffer's bytes.

	err := EncodeBytes(buf, bz)
+	if err != nil {
+		return nil, err
+	}
	bytesCopy := make([]byte, buf.Len())
	copy(bytesCopy, buf.Bytes())

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.

Suggested change
// encodeBytesSlice length-prefixes the byte slice and returns it.
func EncodeBytesSlice(bz []byte) ([]byte, error) {
buf := bufPool.Get().(*bytes.Buffer)
buf.Reset()
defer bufPool.Put(buf)
err := EncodeBytes(buf, bz)
bytesCopy := make([]byte, buf.Len())
copy(bytesCopy, buf.Bytes())
return bytesCopy, err
// encodeBytesSlice length-prefixes the byte slice and returns it.
func EncodeBytesSlice(bz []byte) ([]byte, error) {
buf := bufPool.Get().(*bytes.Buffer)
buf.Reset()
defer bufPool.Put(buf)
err := EncodeBytes(buf, bz)
if err != nil {
return nil, err
}
bytesCopy := make([]byte, buf.Len())
copy(bytesCopy, buf.Bytes())
return bytesCopy, err

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

any chance we could get a regression test with store/v1 to make sure it all works the same. It would help in providing assurances to relayers and others

@cool-develope
Copy link
Contributor Author

any chance we could get a regression test with store/v1 to make sure it all works the same. It would help in providing assurances to relayers and others

In PR #19002, we are using same test vectors with store v1 after prehash refactoring, what kind of regression tests do you want? like comparing the proof of store/v1?

treeRoots, err := result.ProofOps[0].Run([][]byte{[]byte("value1")})
s.Require().NoError(err)
s.Require().Equal(treeRoots[0], storeHash)
expRoots, err := result.ProofOps[1].Run([][]byte{storeHash})
Copy link
Contributor Author

Choose a reason for hiding this comment

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

here, we are testing the proof verification

@tac0turtle
Copy link
Member

any chance we could get a regression test with store/v1 to make sure it all works the same. It would help in providing assurances to relayers and others

In PR #19002, we are using same test vectors with store v1 after prehash refactoring, what kind of regression tests do you want? like comparing the proof of store/v1?

if its the same tests with the same output then maybe that enough?

@cool-develope
Copy link
Contributor Author

any chance we could get a regression test with store/v1 to make sure it all works the same. It would help in providing assurances to relayers and others

In PR #19002, we are using same test vectors with store v1 after prehash refactoring, what kind of regression tests do you want? like comparing the proof of store/v1?

if its the same tests with the same output then maybe that enough?

same root hash and valid proof, I think it's enough

Comment on lines +107 to +110
Key []byte
Value []byte
Version uint64
ProofOps []CommitmentOp
Copy link
Contributor

Choose a reason for hiding this comment

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

The QueryResult struct has been modified to use ProofOps instead of Proof, changing the type from CommitmentOp to []CommitmentOp. This change aligns with the PR objectives to support multi-store proofs. However, ensure that all references and usages of QueryResult throughout the codebase are updated to handle the new ProofOps field correctly.

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

can we add go docs to all missing/modified functions

@tac0turtle tac0turtle added this pull request to the merge queue Jan 17, 2024
Merged via the queue into main with commit bf37398 Jan 17, 2024
57 of 59 checks passed
@tac0turtle tac0turtle deleted the store/multi_proof branch January 17, 2024 13:53
relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024
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.

Implement the GetProof considering the multi store keys
6 participants