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 fast summarization for Kontrol proofs #9092

Merged

Conversation

JuanCoRo
Copy link
Contributor

@JuanCoRo JuanCoRo commented Jan 18, 2024

Description

Building on #8634, this PR performs the following upgrades:

  • Enable Kontrol's fast summarization capability. Allowing the state changes recorded by the stateDiff modifier to be loaded directly into the initial node of the proofs without having to compute them with K. This reduces the computation time of the proofs
  • Exercise OptimismPortalKontrol.prove_finalizeWithdrawalTransaction_paused proof
  • Remove the dummy proof under contracts-bedrock/test/kontrol/proofs/tests
  • Add the file DeploymentSummary.t.sol under kontrol/deployment
  • In OptimismPortal_Test, mark setUp, test_constructor_succeeds, test_simple_isOutputFinalized_succeeds and test_isOutputFinalized_succeeds as virtual to be overridden by test/kontrol/deployment/DeploymentSummary.t.sol

Tests

  • OptimismPortalKontrol.prove_finalizeWithdrawalTransaction_paused is exercised
  • CounterTest.test_SetNumber is no longer exercised
  • DeploymentSummary.t.sol contains an adaptation of OptimismPortal_test tests to ensure the summarization of the KontrolDeployment::runKontrolDeployment function has been done correctly

@JuanCoRo JuanCoRo marked this pull request as ready for review January 19, 2024 19:44
@JuanCoRo JuanCoRo requested a review from a team as a code owner January 19, 2024 19:44
@JuanCoRo JuanCoRo requested a review from clabby January 19, 2024 19:44
Copy link
Contributor

coderabbitai bot commented Jan 19, 2024

Walkthrough

Walkthrough

The recent updates involve enhancing the test suite for the contracts-bedrock package, with a focus on virtualization and reorganization for better testing and deployment processes. Functions in test contracts have been made virtual to allow for overrides, and the directory structure has been optimized for clarity. The setup functions have been inlined for improved performance in the kontrol proofs, and access levels for constants have been adjusted for better encapsulation and inheritance use. Additionally, scripts have been updated to reflect the new file paths and to incorporate new options for initializing nodes.

Changes

File Path Change Summary
packages/contracts-bedrock/test/L1/OptimismPortal.t.sol Added virtual keyword to test functions and changed setUp to setUpInlined with documentation for performance.
packages/contracts-bedrock/test/kontrol/README.md Updated directory structure, moved KontrolDeployment.sol to a new subdirectory, and added DeploymentSummary.t.sol.
.../test/kontrol/proofs/OptimismPortal.k.sol Updated setUpInlined function, modified withdrawal proof, and adjusted types in WithdrawalTransaction.
.../test/kontrol/proofs/utils/DeploymentSummary.sol Changed access level of VM_ADDRESS and vm constants from internal to private.
.../test/kontrol/proofs/utils/KontrolUtils.sol Modified access level of VM_ADDRESS and vm constants from private to internal.
.../test/kontrol/scripts/make-summary-deployment.sh Modified path in FOUNDRY_PROFILE command and added jq command for prettifying a JSON file.
.../test/kontrol/scripts/run-kontrol.sh Added --init-node-from option, removed bmc_depth variable, and initialized state_diff with a new value.

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.

CI is passing and this looks great overall, on monday I'll try running the proofs locally as a sanity check

@clabby clabby requested review from mds1 and removed request for clabby January 21, 2024 20:55
@mds1 mds1 enabled auto-merge January 23, 2024 16:50
@mds1 mds1 added this pull request to the merge queue Jan 23, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Jan 23, 2024
@mds1 mds1 added this pull request to the merge queue Jan 23, 2024
Merged via the queue into ethereum-optimism:develop with commit e704fc6 Jan 23, 2024
64 checks passed
@mds1 mds1 deleted the kontrol-fast-summarization branch January 23, 2024 18:52
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