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

op-e2e: Refactor for asterisc e2e #10214

Conversation

pcw109550
Copy link
Contributor

@pcw109550 pcw109550 commented Apr 18, 2024

Description

Exposes fields and methods for running op-e2e faultproof tests at asterisc repo. Asterisc inherits the structure of output game helper and output cannon helper, so this exposure is necessary.

Added initializer methods to make exposure minimal.

@pcw109550 pcw109550 force-pushed the tip/pcw109550/expose-for-asterisc-e2e branch 4 times, most recently from f0be622 to 211d374 Compare April 22, 2024 21:24
@pcw109550 pcw109550 marked this pull request as ready for review April 22, 2024 22:35
@pcw109550 pcw109550 requested a review from a team as a code owner April 22, 2024 22:35
Copy link
Contributor

coderabbitai bot commented Apr 22, 2024

Walkthrough

The recent updates involve standardizing naming conventions by renaming functions and struct fields, transitioning from lowercase to uppercase initials. This change enhances code readability and consistency across various files. Additionally, new constructor functions have been introduced for improved struct initialization, and method calls have been adjusted to align with these naming and structural modifications.

Changes

Files Change Summary
.../challenger/helper.go
.../disputegame/*.go
.../faultproofs/*.go
.../faultproofs/util.go
Renamed functions and struct fields to start with uppercase letters. Introduced new constructor functions. Updated method and function calls to match new names and structures.
.../disputegame/claim_helper.go
.../disputegame/dishonest_helper.go
.../disputegame/output_*.go
Updated struct fields and method calls from lowercase to uppercase. Added new constructor functions in some helper files.
.../faultproofs/*.go Updated function calls to StartFaultDisputeSystem and adjusted method references and error handling to match new naming conventions.

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.

@pcw109550 pcw109550 force-pushed the tip/pcw109550/expose-for-asterisc-e2e branch from 211d374 to 8faf87a Compare April 23, 2024 19:35
@pcw109550
Copy link
Contributor Author

pcw109550 commented Apr 23, 2024

Rebasing broke op-e2e for asterisc. Will fix and reopen again.

@pcw109550 pcw109550 marked this pull request as draft April 23, 2024 22:51
@pcw109550 pcw109550 marked this pull request as ready for review April 23, 2024 23:02
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. I suspect we're going to break this on you quite a lot as we don't treat this as a library with a stable API, but I think it's a reasonable thing to do for now. Long term we probably need to find a better way to either build an explicit library with a more stable API or find a way to better separate the asterisc e2e test framework. Worth finding exactly what the pain points are before trying to do that though.

@ajsutton ajsutton added this pull request to the merge queue Apr 23, 2024
Merged via the queue into ethereum-optimism:develop with commit d4706da Apr 23, 2024
68 checks passed
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.

2 participants