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

cannon: Export methods for Asterisc #9350

Merged

Conversation

ImTei
Copy link
Collaborator

@ImTei ImTei commented Feb 5, 2024

Description

Currently I'm working on Asterisc binary with Cannon-compatible commands. I have fixed some utilities to reuse in Asterisc.

  • Move cannon/cmd/json.go methods into op-service jsonutil package and export them. Existing WriteJSON() method is replaced with the Cannon's method.
  • Replace mipsevm.State with VMState interface in Matcher to make it compatible with other VM(Asterisc)

Asterisc implementation using these changes is here.

@ImTei ImTei marked this pull request as ready for review February 7, 2024 06:30
@ImTei ImTei requested a review from a team as a code owner February 7, 2024 06:30
Copy link
Contributor

coderabbitai bot commented Feb 7, 2024

Walkthrough

Walkthrough

The recent updates focus on standardizing JSON operations across various components of a software project. By integrating a jsonutil package, the changes replace direct JSON manipulation with utility functions for loading and writing JSON data, enhancing code maintainability and readability. Additionally, a more flexible interface approach is adopted in the matcher function, and file permission handling is standardized, indicating a move towards more robust and adaptable code practices.

Changes

Files Change Summary
cannon/cmd/load_elf.go
cannon/cmd/run.go
cannon/cmd/witness.go
op-chain-ops/cmd/op-upgrade/main.go
op-chain-ops/cmd/op-version-check/main.go
op-node/cmd/genesis/cmd.go
Replaced direct JSON operations with jsonutil utility functions. Added file permission parameters to WriteJSON calls.
cannon/cmd/matcher.go Refactored StepMatcher to accept an interface VMState instead of a specific type.
cannon/mipsevm/state.go Added GetStep() method to State struct.
op-service/jsonutil/json.go
op-service/jsonutil/json_test.go
Renamed package to jsonutil and updated function names. Added file permission parameter to WriteJSON.

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

@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. Nice to remove the duplication of the json writing util too.

@ajsutton ajsutton added this pull request to the merge queue Feb 7, 2024
Merged via the queue into ethereum-optimism:develop with commit dfc7eda Feb 7, 2024
55 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