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

fix!: bug of verifyMultiRowRootsToDataRootTupleRoot #307

Conversation

zhiqiangxu
Copy link
Contributor

@zhiqiangxu zhiqiangxu commented May 3, 2024

The original _root parameter is not verified before being used in verifyMultiRowRootsToDataRootTupleRootProof, it will allow arbitrary _rowRoots to be proved valid.

Summary by CodeRabbit

  • Refactor
    • Enhanced data integrity checks by updating the verification process in the application.

Copy link

coderabbitai bot commented May 3, 2024

Walkthrough

The update in the code involves refining the function parameters in DAVerifier.sol to enhance data handling clarity. This change streamlines the usage of data references and improves consistency across related contracts.

Changes

File Path Change Summary
src/lib/verifier/.../DAVerifier.sol Modified parameter in verifyMultiRowRootsToDataRootTupleRoot function.
src/lib/verifier/test/.../DAVerifier.t.sol Removed fixture.dataRoot() argument from function calls.
src/lib/verifier/test/.../RollupInclusionProofs.t.sol Updated call to DAVerifier.verifySharesToDataRootTupleRoot.

Poem

🌟🐇 A CodeRabbit's Ode to Code 🐇🌟

In the warren of wires and code,
A small change does brightly glow.
From bytes32 roots we've boldly strode,
To structured paths where data flows.
Hop, skip, a leap in logic's abode,
Crafted neatly in the coder's trove.


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between c92e4a1 and f62ca0e.
Files selected for processing (3)
  • src/lib/verifier/DAVerifier.sol (6 hunks)
  • src/lib/verifier/test/DAVerifier.t.sol (3 hunks)
  • src/lib/verifier/test/RollupInclusionProofs.t.sol (2 hunks)
Files skipped from review as they are similar to previous changes (3)
  • src/lib/verifier/DAVerifier.sol
  • src/lib/verifier/test/DAVerifier.t.sol
  • src/lib/verifier/test/RollupInclusionProofs.t.sol

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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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.

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.
  • Please see the configuration documentation 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Out of diff range and nitpick comments (1)
src/lib/verifier/DAVerifier.sol (1)

[!TIP]
Codebase Verification

Several files in the codebase still use the old function signature for verifyMultiRowRootsToDataRootTupleRoot. This could lead to inconsistencies and potential errors in data verification processes.

  • The function call in src/lib/verifier/DAVerifier.sol using _root as a parameter needs to be updated to _attestationProof.tuple.dataRoot.
  • It is recommended to review the test file src/lib/verifier/test/DAVerifier.t.sol to ensure that the correct parameters are being used in all test cases.
Analysis chain

Line range hint 223-236: Change in parameter usage enhances security by ensuring correct data root is used.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify integration of the parameter change in `verifyMultiRowRootsToDataRootTupleRoot` with other parts of the system.

# Test: Search for other usages of `verifyMultiRowRootsToDataRootTupleRoot` to ensure they pass the correct parameter.
ast-grep --lang solidity --pattern $'verifyMultiRowRootsToDataRootTupleRoot($_, $_, $_, $_, $_)'

Length of output: 214



Script:

#!/bin/bash
# Description: Verify integration of the parameter change in `verifyMultiRowRootsToDataRootTupleRoot` with other parts of the system using ripgrep.

# Search for usages of `verifyMultiRowRootsToDataRootTupleRoot` in Solidity files to ensure they pass the correct parameter.
rg "verifyMultiRowRootsToDataRootTupleRoot" --glob "*.sol"

Length of output: 798

Copy link
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

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

Thanks for reporting this 🙏

Can you provide test cases that fail without this fix?

@zhiqiangxu
Copy link
Contributor Author

zhiqiangxu commented May 3, 2024

Thanks for reporting this 🙏

Can you provide test cases that fail without this fix?

I don't have a test case, I found this problem when code review.

The main take-away is that the extra _root parameter is unnecessary and should use the one inside AttestationProof.tuple

@rach-id rach-id added the bug Something isn't working label May 3, 2024
@rach-id rach-id assigned rach-id and zhiqiangxu and unassigned rach-id May 3, 2024
@rach-id
Copy link
Member

rach-id commented May 3, 2024

@zhiqiangxu I confirm the bug, would you be able to add the tests? Also, this fix should also be done for: verifySharesToDataRootTupleRoot and verifyRowRootToDataRootTupleRoot. Would you be down to updating this PR to include fix + tests for those too?

If not, I'll gladly pick this PR up and add the necessary changes :D

@zhiqiangxu
Copy link
Contributor Author

zhiqiangxu commented May 3, 2024

@zhiqiangxu I confirm the bug, would you be able to add the tests? Also, this fix should also be done for: verifySharesToDataRootTupleRoot and verifyRowRootToDataRootTupleRoot. Would you be down to updating this PR to include fix + tests for those too?

If not, I'll gladly pick this PR up and add the necessary changes :D

I fixed the mentioned functions, please take a look, and feel free to add more tests if necessary:)

@rach-id rach-id changed the title fix bug of verifyMultiRowRootsToDataRootTupleRoot fix!: bug of verifyMultiRowRootsToDataRootTupleRoot May 3, 2024
Copy link
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

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

After double thinking about it, there is no need for a test since we're getting rid of the _root altogether.

Thanks a lot again for reporting this 🙏

@rach-id rach-id merged commit 688b3a1 into celestiaorg:master May 3, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants