search

celestiaorg / blobstream-contracts

Celestia -> EVM bridge
Apache License 2.0
132 stars 40 forks source link

verifyMultiNamespaced #326

Open S1nus opened 4 months ago

S1nus commented 4 months ago

New to Solidity so idk if there's a better way, but I wrote this to save us from needing to loop through the NamespaceNodes just to copy their digest field into another array.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

This update enhances a smart contract library by integrating the "forge-std" submodule, which enriches the development environment. New bit manipulation functions and improved Merkle Tree verification methods have been introduced, alongside expanded testing capabilities. The project now supports both "forge-std" and "openzeppelin-contracts-upgradeable," providing developers with more robust tools. Additionally, documentation clarifications have been made to facilitate effective usage of the new features.

Changes

Files Change Summary
.gitmodules, lib/forge-std Added "forge-std" submodule configuration, enhancing project capabilities.
remappings.txt Updated path for forge-std dependency for improved clarity; other remappings unchanged.
src/lib/tree/Utils.sol Introduced nextSubtreeSize and bitsTrailingZeroes functions for bit manipulation and subtree size calculations.
src/lib/tree/binary/BinaryMerkleMultiproof.sol, src/lib/tree/binary/BinaryMerkleTree.sol Defined BinaryMerkleMultiproof structure and added functions (verifyMulti, verifyMultiNamespaced, verifyMultiHashes) for Merkle proof verification.
src/lib/tree/binary/test/BinaryMerkleTree.t.sol Added new test function testMultiproof to validate multiproof functionality.
src/lib/tree/namespace/NamespaceMerkleMultiproof.sol Clarified comments for beginKey and endKey fields in NamespaceMerkleMultiproof.
src/lib/tree/namespace/NamespaceMerkleTree.sol Removed _nextSubtreeSize and _bitsTrailingZeroes functions, eliminating related functionality.
src/lib/tree/namespace/test/NamespaceMerkleMultiproof.t.sol Introduced testLoadFromBytes function to validate NamespaceMerkleTree.verifyMulti.
src/lib/tree/test/proofs.json Created a new JSON file to manage proof data for testing and verification processes.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant SW as Software
    participant Utils as Utility Functions
    participant Merkle as Merkle Tree
    participant Test as Testing Framework

    Dev->>SW: Integrate forge-std
    SW->>Utils: Update remappings
    SW->>Merkle: Add Utilities
    SW->>Merkle: Verify Multi-Proofs
    Merkle->>Test: Retrieve Proof Data
    Test-->>Merkle: Send Proof Data
    Merkle-->>SW: Verify Proofs
    SW-->>Dev: Testing Complete

🐇 In the meadow, where rabbits hop,
New features bloom and never stop!
With clever code and bits to play,
We celebrate in a joyful way!
Forge and verify, oh what fun,
Our smart contracts shine like the sun! 🌼

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - 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 testing code 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 and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.