refactor(store/v2): updates from integration

[alexanderbez]

Description

Some minor changes that were introduced in the attempt to integrate store v2 into the framework. Most notably introducing proof logic and a bit of cleanup.

---

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

Summary by CodeRabbit

• New Features

  • Introduced a new cryptographic proof handling package with various commitment operations.
  • Added search functionality with a new Search class and user interface components.
  • Implemented a new IsZero method for commit ID checks.
  • Added a new SetMetrics function for enhanced metric tracking.

• Enhancements

  • Improved concurrency control in pruning manager methods with mutex locks.
  • Enhanced logging within the Prune method for better debug information.

• Refactor

  • Changed the Gas type declaration for improved type compatibility.
  • Updated the Store struct to use a new header type for commit information.
  • Modified various function signatures to accommodate new pruning options and metrics.

• Bug Fixes

  • Fixed issues with proof handling in query results by changing the proof type.

• Documentation

  • Updated documentation to reflect new features and changes in the codebase.

• Style

  • Adjusted code style for consistency across new and existing files.

• Tests

  • Updated tests to align with changes in function calls and variable access.

[coderabbitai]

Walkthrough

The changes across the codebase involve interface removals, method additions, type redefinitions, and the introduction of new functions and types related to cryptographic proofs and store management. There's a shift towards more detailed concurrency control and logging, as well as adjustments to function signatures and logic to accommodate new features and improve existing ones. The updates reflect a significant refactor and enhancement of the store system, likely aimed at improving performance, security, and developer ergonomics.

Changes

File(s)	Change Summary
store/commit_info.go	Removed CommitHeader interface; added IsZero method to CommitID type.
store/gas.go	Changed Gas type from alias to type definition.
store/proof.go	Added new package store with types and functions for cryptographic proofs.
store/pruning/manager.go	Added mutex locks in SetStorageOptions and SetCommitmentOptions; added logging in Prune method.
store/root/store.go, store/root/store_test.go	Added imports; changed type fields, function signatures, and logic; added and removed functions.
store/store.go	Replaced imports; updated interface methods and type changes in RootStore and QueryResult.

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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

[alexanderbez]

Note to reviewer(s): This is a direct port from store v1 (with linting/cleanup).

[alexanderbez]

cc @cool-develope

[coderabbitai]

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between dd3db5c and 5a36fb1.

Files ignored due to filter (2)

• store/go.mod
• store/go.sum

Files selected for processing (7)

• store/commit_info.go (2 hunks)
• store/gas.go (1 hunks)
• store/proof.go (1 hunks)
• store/pruning/manager.go (3 hunks)
• store/root/store.go (9 hunks)
• store/root/store_test.go (4 hunks)
• store/store.go (5 hunks)

Additional comments: 27

store/commit_info.go (2)

• 8-13: The removal of the CommitHeader interface and the addition of the IsZero method to CommitID are consistent with the PR objectives and the provided summary.

• 72-78: The IsZero method has been correctly added to the CommitID type, providing a way to check if a CommitID is uninitialized or default.

store/gas.go (1)

• 9-12: The change from a type definition to a type alias for Gas is consistent with the PR objectives and summary provided. This change can affect type compatibility and inference in Go, so it's important to ensure that all usages of the Gas type are reviewed to confirm that they behave as expected with the new type alias.

store/proof.go (1)

• 134-134: The error message is clear and does not leak sensitive information.

store/pruning/manager.go (4)

• 41-47: The addition of mutex locking in the SetStorageOptions method is correctly implemented to prevent race conditions when setting storage options.

• 49-54: The addition of mutex locking in the SetCommitmentOptions method is correctly implemented to prevent race conditions when setting commitment options.

• 123-124: The additional logging within the select block of the Prune method provides useful debug information when storage pruning is still running and the current pruning operation is skipped.

• 145-146: The additional logging within the select block of the Prune method provides useful debug information when commitment pruning is still running and the current pruning operation is skipped.

store/root/store.go (10)

• 9-15: The addition of the coreheader import is appropriate given the changes to the Store struct and function signatures that now use coreheader.Info.

• 44-50: The change of the commitHeader field's type in the Store struct from store.CommitHeader to *coreheader.Info aligns with the PR objectives and summary.

• 68-75: The New function signature has been updated to include additional parameters for pruning options, which is consistent with the PR objectives and summary.

• 112-114: The addition of the SetMetrics function is not mentioned in the PR objectives or summary. Please ensure this addition is intentional and documented.

• 116-123: The addition of the SetInitialVersion function and the removal of the SetPruningOptions function align with the PR objectives and summary.

• 126-129: The GetSCStore function signature has been modified to no longer take parameters, which is consistent with the PR objectives and summary.

• 194-200: The Query function logic has been updated to use the new proof logic, which is consistent with the PR objectives and summary.

• 280-282: The SetCommitHeader function signature has been changed to accept *coreheader.Info, which is consistent with the PR objectives and summary.

• 350-352: The comparison of s.commitHeader.GetHeight() has been changed to uint64(s.commitHeader.Height) in the Commit function, which is consistent with the change in the type of commitHeader.

• 366-368: The Commit function now sets the Timestamp field of lastCommitInfo based on commitHeader.Time, which is consistent with the new commitHeader type.

store/root/store_test.go (4)

• 12-16: The addition of the "cosmossdk.io/store/v2/pruning" import is consistent with the PR objectives and the summary provided.

• 39-39: The change to the New function call to include additional pruning options is consistent with the PR objectives and the summary provided.

• 56-56: The update to the GetSCStore method call to remove the storeKey parameter is consistent with the PR objectives and the summary provided.

• 90-92: The change in variable access from result.Proof to result.Proof.Proof aligns with the PR objectives and the summary provided.

store/store.go (5)

• 3-8: The changes in the import paths reflect the updates mentioned in the summary, aligning with the new proof logic and metrics integration.

• 20-27: The removal of the storeKey parameter from the GetSCStore method aligns with the summary and indicates a change in how SC stores are accessed, potentially simplifying the interface.

• 56-65: The addition of SetInitialVersion, SetCommitHeader, and LastCommitID methods to the RootStore interface is consistent with the summary and suggests enhancements to the store's versioning and commit header management.

• 78-87: The addition of the SetMetrics method and the RootStore interface now extending io.Closer are in line with the summary, indicating an enhancement in metrics handling and resource management.

• 177-180: The change in the Proof field type within the QueryResult struct from ics23.CommitmentProof to CommitmentOp is consistent with the summary and reflects the integration of new proof logic.

[cool-develope]

lgtm

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5a36fb1 and c4d660b.

Files selected for processing (1)

• store/proof.go (1 hunks)

Additional comments: 4

store/proof.go (4)

• 75-75: Given the previous decision to include detailed error information, this is consistent with the current approach. However, it's important to ensure that this does not lead to unintended exposure of sensitive data.

• 84-84: As per the previous decision, detailed error messages will be maintained. Ensure that this aligns with the overall security policy regarding error logging.

• 90-90: The detailed error message is consistent with the previous decision to include such information. Confirm that this is acceptable within the context of the application's security practices.

• 1-98: The implementation of the CommitmentOp struct and its methods appears to be correct and well-structured, following good Go practices with clear factory methods and error handling.

[tac0turtle]

oh sorry this could of all stayed, but we only return our own type.

[alexanderbez]

But it relies on cmtcrypto.ProofOp as an argument. What exactly do you propose?

[tac0turtle]

need to open the code editor, i was playing with this code before to avoid the comet dependency but still be able to prove. Seems like the code you added does that anyways.