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

plasma mode: Specify valid commitment type #10622

Merged
merged 11 commits into from
May 28, 2024
Merged

Conversation

trianglesphere
Copy link
Contributor

@trianglesphere trianglesphere commented May 22, 2024

Description

This PR modifies the plasma mode config to support specifying the valid commitment type. This commitment type is then checked inside the op-node.

This also adds support for generic commitments to the DA server for testing. The generic commitment version of the DA server is used in a new devnet matrix test.

Tests

Adds a devnet test for generic commitment types.

Metadata

@trianglesphere trianglesphere changed the title Jg/specify comm type plasma mode: Specify valid commitment type May 22, 2024
@trianglesphere trianglesphere marked this pull request as ready for review May 23, 2024 01:07
Copy link
Contributor

coderabbitai bot commented May 23, 2024

Walkthrough

Walkthrough

The changes involve introducing support for generic Plasma allocations and commitments across various components. This includes updating configuration files, environment variables, and deployment scripts to accommodate a new GENERIC_PLASMA mode. Additionally, validation and initialization logic for commitment types have been enhanced to ensure compatibility with both Keccak and generic commitments.

Changes

File(s) Change Summary
.circleci/config.yml, bedrock-devnet/devnet/__init__.py Added steps for generating and copying Generic Plasma allocations, updated matrix parameters and deployment logic.
op-chain-ops/genesis/config.go, op-node/rollup/types.go Updated struct fields and validation logic for DACommitmentType and CommitmentType respectively.
op-plasma/commitment.go, op-plasma/cmd/daserver/entrypoint.go Added functions for commitment type conversion and configuration for generic commitments.
op-plasma/cmd/daserver/flags.go, op-plasma/daclient.go Introduced flags for generic commitments and updated function calls accordingly.
op-plasma/daclient_test.go, op-plasma/damgr.go Updated server initialization and functions to handle commitment types.
op-plasma/daserver.go, ops-bedrock/docker-compose.yml Updated server struct and docker configurations to support generic commitments.
packages/contracts-bedrock/scripts/Deploy.s.sol, packages/contracts-bedrock/scripts/DeployConfig.s.sol Added condition checks and public variables for commitment types.

Assessment against linked issues

Objective Addressed Explanation
Add config for which commitment types to accept in Plasma Mode (#10401)
Allow empty contract for generic comm validity in Plasma Mode (#10402)

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 2d71169 and ba55aad.
Files selected for processing (1)
  • packages/contracts-bedrock/scripts/Deploy.s.sol (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/contracts-bedrock/scripts/Deploy.s.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
Contributor

@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: 9

Outside diff range and nitpick comments (5)
bedrock-devnet/devnet/__init__.py (2)

Line range hint 224-224: Refactor the condition checks to use more Pythonic expressions.

- if os.path.exists(l2_allocs_path) == False or DEVNET_FPAC == True:
+ if not os.path.exists(l2_allocs_path) or DEVNET_FPAC:

Line range hint 321-321: Remove or use the local variable e to handle exceptions appropriately.

- except Exception as e:
+ except Exception:
  log.info(f'Waiting for RPC server at {url}')
op-plasma/damgr.go (2)

54-55: Ensure the CommitmentType field is properly documented.

It would be beneficial to add a comment explaining the purpose and possible values of CommitmentType for future maintainability.


351-354: Clarify the handling of legacy and new plasma configurations.

The logic that handles both legacy and new plasma configurations could be simplified or better documented to avoid confusion and potential bugs in future modifications.

op-node/rollup/types.go (1)

565-567: Document plasma mode support in the configuration description.

It would be helpful to add a comment in the Description method to explain that it also reports the plasma mode configuration. This enhances the understandability of the configuration output.

op-chain-ops/genesis/config.go Outdated Show resolved Hide resolved
op-chain-ops/genesis/config.go Outdated Show resolved Hide resolved
op-plasma/damgr.go Show resolved Hide resolved
.circleci/config.yml Show resolved Hide resolved
op-plasma/damgr.go Show resolved Hide resolved
op-node/rollup/types.go Outdated Show resolved Hide resolved
op-node/rollup/types.go Outdated Show resolved Hide resolved
ops-bedrock/docker-compose.yml Show resolved Hide resolved
op-plasma/cmd/daserver/flags.go Show resolved Hide resolved
Copy link
Contributor

@maurelian maurelian left a comment

Choose a reason for hiding this comment

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

The contract changes LGTM

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.

It would be really, really nice to not use magic 0 and 1 values, particularly in the json config files where there's no context about what they mean. Seems particularly important since accidentally setting it to use generic commitments is very dangerous.

If you really insist I'll approve but I won't like it. :)

op-chain-ops/genesis/config.go Outdated Show resolved Hide resolved
Copy link
Contributor

semgrep-app bot commented May 23, 2024

Semgrep found 2 invalid-usage-of-modified-variable findings:

Variable unsafeInNode is likely modified and later used on error. In some cases this could result in panics due to a nil dereference

Ignore this finding from invalid-usage-of-modified-variable.

Copy link
Contributor

@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: 1

op-chain-ops/genesis/config.go Show resolved Hide resolved
Copy link
Contributor

@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

Outside diff range and nitpick comments (5)
bedrock-devnet/devnet/__init__.py (5)

Line range hint 7-7: Remove unused import: calendar.

- import calendar

The calendar module is imported but not used in this file. Removing unused imports can help reduce clutter and improve code readability.


Line range hint 12-12: Remove unused import: gzip.

- import gzip

The gzip module is imported but not used in this file. It's a good practice to remove unused imports to keep the codebase clean and maintainable.


Line range hint 18-18: Remove unused import: devnet.log_setup.

- import devnet.log_setup

The devnet.log_setup is imported but not used in this file. Removing it will clean up the code and potentially reduce initialization overhead.


Line range hint 224-224: Simplify boolean checks.

- if os.path.exists(l2_allocs_path) == False or DEVNET_FPAC == True:
-     # Also regenerate if FPAC.
-     # The FPAC flag may affect the L1 deployments addresses, which may affect the L2 genesis.
-     devnet_l2_allocs(paths)
- else:
-     log.info('Re-using existing L2 allocs.')
+ if not os.path.exists(l2_allocs_path) or DEVNET_FPAC:
+     # Also regenerate if FPAC.
+     # The FPAC flag may affect the L1 deployments addresses, which may affect the L2 genesis.
+     devnet_l2_allocs(paths)
+ else:
+     log.info('Re-using existing L2 allocs.')

Simplify the boolean expressions by directly using not for false checks and removing the comparison for true checks. This makes the code more Pythonic and easier to read.


Line range hint 321-321: Remove unused local variable e.

- except Exception as e:
+ except Exception:

The variable e is declared but not used in the exception block. It's good practice to remove unused variables to clean up the code.

@trianglesphere trianglesphere force-pushed the jg/specify_comm_type branch 3 times, most recently from 43ace75 to 3945d8f Compare May 23, 2024 17:36
Copy link
Contributor

@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: 3

op-e2e/e2eutils/setup.go Show resolved Hide resolved
bedrock-devnet/devnet/__init__.py Show resolved Hide resolved
@trianglesphere
Copy link
Contributor Author

@ajsutton everything got updated to use the string
@maurelian I had to make some more contract changes to make the string value work, PTAL.

@ajsutton ajsutton self-requested a review May 23, 2024 23:17
Copy link
Contributor

@maurelian maurelian left a comment

Choose a reason for hiding this comment

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

contracts LGTM

@0xfuturistic 0xfuturistic removed their request for review May 24, 2024 22:00
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.

LGTM.

@trianglesphere trianglesphere added this pull request to the merge queue May 28, 2024
Merged via the queue into develop with commit 926ba71 May 28, 2024
70 checks passed
@trianglesphere trianglesphere deleted the jg/specify_comm_type branch May 28, 2024 15:08
// CommitmentType describes the binary format of the commitment.
// KeccakCommitmentType is the default commitment type for the centralized DA storage.
// KeccakCommitmentStringType is the default commitment type for the centralized DA storage.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Revert diff. Should be KeccakCommitmentType

carterqw2 pushed a commit to celo-org/optimism that referenced this pull request May 29, 2024
* op-node: Better logging in commitment tracking

* op-node: Properly handle differences in Keccak vs Generic Commitments

* Use daCommitmentType in deploy config

* da-server: Add option to use generic commitments

* CI: Add generic commitment

* op-chain-ops: Set daCommitmentType in testdata

* Fix comm type check

* Fix CI env var

* Set proper default for daCommitmentType

* Use string for daCommitmentType

* Use bytes cast instead of abi.encodePacked
rdovgan pushed a commit to rdovgan/optimism that referenced this pull request Jun 24, 2024
* op-node: Better logging in commitment tracking

* op-node: Properly handle differences in Keccak vs Generic Commitments

* Use daCommitmentType in deploy config

* da-server: Add option to use generic commitments

* CI: Add generic commitment

* op-chain-ops: Set daCommitmentType in testdata

* Fix comm type check

* Fix CI env var

* Set proper default for daCommitmentType

* Use string for daCommitmentType

* Use bytes cast instead of abi.encodePacked
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants