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

Final version for Kontrol pausability proofs #9530

Merged

Conversation

JuanCoRo
Copy link
Contributor

Description

Building on #9183, this PR wraps up the existing pausability proofs by adding the following:

  • Native symbolic support for arguments of type bytes and bytes[]
  • Replace mockCall workaround with the vm.mockCall cheatcode
  • Replace startPrank workaround with the appropriate vm.prank cheatcode

Tests

No additional tests are added so far. This PR modifies the existing proofs to include all the latest and necessary improvements.

Additional context

Before this PR, a number of workarounds were in place to have these proofs pass. These workarounds didn't threaten the soundness of the proofs, but they affected long-term maintainability, execution performance, and the generality of the proofs.

@JuanCoRo JuanCoRo marked this pull request as ready for review February 29, 2024 18:30
@JuanCoRo JuanCoRo requested review from a team as code owners February 29, 2024 18:30
Copy link
Contributor

coderabbitai bot commented Feb 29, 2024

Walkthrough

Walkthrough

The recent updates aim to streamline test execution and deployment processes for kontrol tasks. Key changes include the introduction of a manual pipeline dispatch parameter, test renaming, and condition updates. Additionally, improvements were made to script flag handling for test selection, execution logic enhancements, version control best practices, proof process configuration updates, and cleanup in utility contracts and scripts.

Changes

File(s) Summary
.circleci/config.yml Introduced kontrol_dispatch parameter for manual pipeline dispatch and renamed scheduled-kontrol-tests to develop-kontrol-tests with updated conditions.
packages/contracts-bedrock/test/kontrol/... Enhanced test execution by updating script flags, adding conditional logic for test selection, supporting test specification, and refining argument parsing and execution options.
packages/contracts-bedrock/.gitignore Added kontrol_prove_report.xml to the ignore list for version control purposes.
packages/contracts-bedrock/foundry.toml Enabled Abstract Syntax Tree (AST) generation by setting ast = true in the foundry.toml configuration file.
packages/contracts-bedrock/test/kontrol/... Removed unused contracts and functions, and improved comments and formatting in KontrolUtils.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-tests 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 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 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

@ajsutton ajsutton left a comment

Choose a reason for hiding this comment

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

Approved, but need to add the filter to ensure Kontrol doesn't run on every scheduled trigger.

@mds1 mds1 enabled auto-merge March 13, 2024 14:24
@mds1 mds1 added this pull request to the merge queue Mar 13, 2024
Merged via the queue into ethereum-optimism:develop with commit 876e16a Mar 13, 2024
69 checks passed
@mds1 mds1 deleted the kontrol-symbolic-bytes branch March 13, 2024 17:01
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