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

Add Kontrol proofs for L1StandardBridgeKontrol and L1ERC721BridgeKontrol #9183

Merged
merged 24 commits into from
Jan 26, 2024

Conversation

JuanCoRo
Copy link
Contributor

Description

Building on #9156, this PR adds the following:

  • For the L1StandardBridgeKontrol contract, the proofs
    • prove_finalizeBridgeERC20_paused
    • prove_finalizeBridgeETH_paused
  • For the L1ERC721BridgeKontrol contract, the proof prove_finalizeBridgeERC21_paused

Tests

This PR adds the above proofs to be executed with Kontrol and exercises the tests from <contract>_Test on the deployment summary for L1StandardBridgeKontrol and L1ERC721BridgeKontrol

@JuanCoRo JuanCoRo marked this pull request as ready for review January 25, 2024 22:09
@JuanCoRo JuanCoRo requested review from a team as code owners January 25, 2024 22:09
Copy link
Contributor

coderabbitai bot commented Jan 25, 2024

Warning

Rate Limit Exceeded

@JuanCoRo has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 10 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 0d8fa45 and eb1b929.

Walkthrough

The recent updates expand the scope of CI/CD checks, enhance testing strategies for the bedrock contract suite, and introduce new contracts and proofs for ERC721 and standard bridge functionalities. Key modifications include making test functions virtual for extensibility, adding new test files and deployment logic for bridge contracts, and improving symbolic execution tests. These changes aim to bolster the framework's robustness and flexibility in managing and testing bridge operations.

Changes

File(s) Summary of Changes
.circleci/config.yml Expanded the check-changed job's patterns to include more files in CI/CD checks.
.../L1/L1ERC721Bridge.t.sol, .../L1/L1StandardBridge.t.sol Marked specific functions as virtual for overriding and added clarifying comments.
.../kontrol/README.md Added documentation for new files and their symbolic property tests.
.../kontrol/deployment/DeploymentSummary.t.sol, .../KontrolDeployment.sol Updated with imports, new test contracts, and functions for bridge contracts. Included deployment logic for new proxy contracts and initialization of bridge contracts.
.../kontrol/proofs/L1CrossDomainMessenger.k.sol, .../OptimismPortal.k.sol Added comments to clarify parameters and call structures in existing proofs.
.../kontrol/proofs/L1ERC721Bridge.k.sol, .../L1StandardBridge.k.sol Introduced new Solidity contracts for controlling and finalizing bridge operations.
.../kontrol/proofs/interfaces/KontrolInterfaces.sol, .../proofs/utils/DeploymentSummary.sol Updated function names, interfaces, and added new constants for address management. Significantly changed the functionality to accommodate new testing and deployment strategies.
.../kontrol/scripts/run-kontrol.sh Enhanced script flexibility for symbolic execution tests.

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-tests for this file.
  • 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.

Copy link
Contributor

@mds1 mds1 left a comment

Choose a reason for hiding this comment

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

Thank you!

Copy link
Contributor

@mds1 mds1 left a comment

Choose a reason for hiding this comment

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

Thank you!

@mds1 mds1 added this pull request to the merge queue Jan 26, 2024
Merged via the queue into ethereum-optimism:develop with commit 640b4cb Jan 26, 2024
64 checks passed
@mds1 mds1 deleted the milestone-3 branch January 26, 2024 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants