optimism op-service: predeploys package

Description

Migrates the op-bindings/predeploys package to op-service/predeploys. There is various other "system related" code there. This unblocks fully deleting op-bindings as a top level package.

May 10 '24 13:05 tynes

Walkthrough

The recent updates primarily involve changing the import path of the predeploys package across various files from op-bindings/predeploys to op-service/predeploys. This systematic change suggests a reorganization or restructuring within the project, likely aimed at improving modularity or aligning with updated architectural standards.

Changes

Files	Change Summary
Various files across `indexer/`, `op-chain-ops/`, `op-e2e/`, `op-node/`, `op-program/`, `op-service/`, `packages/contracts-bedrock/`, `packages/contracts-ts/`	Updated import path for `predeploys` from `github.com/ethereum-optimism/optimism/op-bindings/predeploys` to `github.com/ethereum-optimism/optimism/op-service/predeploys`.
`packages/contracts-ts/wagmi.config.ts`	Updated a comment to reflect the new location for synchronization with contract addresses.

Recent Review Details

Configuration used: .coderabbit.yml Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9a22b09e0b3d1ae55a7149585bfbfb643dc8dc42 and 66f14a4d4c7051e1d9ccec7cd19e0a3aeeac1da4.

Files selected for processing (36)

indexer/config/config.go (1 hunks)
indexer/database/bridge_transfers.go (1 hunks)
indexer/e2e_tests/bridge_messages_e2e_test.go (1 hunks)
indexer/e2e_tests/bridge_transactions_e2e_test.go (1 hunks)
indexer/e2e_tests/bridge_transfers_e2e_test.go (1 hunks)
indexer/e2e_tests/reorg_e2e_test.go (1 hunks)
indexer/processors/bridge/legacy_bridge_processor.go (1 hunks)
indexer/processors/contracts/standard_bridge.go (1 hunks)
op-chain-ops/cmd/check-ecotone/main.go (2 hunks)
op-chain-ops/crossdomain/legacy_withdrawal.go (1 hunks)
op-chain-ops/crossdomain/legacy_withdrawal_test.go (1 hunks)
op-chain-ops/crossdomain/migrate.go (1 hunks)
op-chain-ops/crossdomain/migrate_test.go (1 hunks)
op-chain-ops/genesis/genesis.go (1 hunks)
op-chain-ops/genesis/layer_two.go (1 hunks)
op-chain-ops/upgrades/l1.go (1 hunks)
op-e2e/actions/ecotone_fork_test.go (1 hunks)
op-e2e/actions/user.go (2 hunks)
op-e2e/bridge_test.go (1 hunks)
op-e2e/custom_gas_token_test.go (1 hunks)
op-e2e/e2eutils/addresses.go (1 hunks)
op-e2e/e2eutils/setup_test.go (1 hunks)
op-e2e/setup.go (2 hunks)
op-e2e/system_test.go (2 hunks)
op-e2e/system_tob_test.go (2 hunks)
op-e2e/withdrawal_helper.go (2 hunks)
op-node/rollup/derive/attributes.go (1 hunks)
op-node/rollup/derive/attributes_queue_test.go (1 hunks)
op-node/rollup/derive/attributes_test.go (1 hunks)
op-node/rollup/derive/ecotone_upgrade_transactions.go (1 hunks)
op-node/rollup/derive/l1_block_info.go (1 hunks)
op-node/withdrawals/utils.go (1 hunks)
op-program/client/l2/engine.go (1 hunks)
op-service/sources/l2_client.go (1 hunks)
packages/contracts-bedrock/scripts/go-ffi/differential-testing.go (1 hunks)
packages/contracts-ts/wagmi.config.ts (1 hunks)

Files skipped from review due to trivial changes (11)

indexer/e2e_tests/bridge_transactions_e2e_test.go
indexer/processors/contracts/standard_bridge.go
op-chain-ops/crossdomain/legacy_withdrawal_test.go
op-chain-ops/upgrades/l1.go
op-e2e/actions/ecotone_fork_test.go
op-e2e/withdrawal_helper.go
op-node/rollup/derive/attributes_queue_test.go
op-node/rollup/derive/ecotone_upgrade_transactions.go
op-node/rollup/derive/l1_block_info.go
op-program/client/l2/engine.go
packages/contracts-ts/wagmi.config.ts

Additional comments not posted (29)

op-e2e/e2eutils/setup_test.go (1)

11-11: The updated import path aligns with the PR's objective of migrating the predeploys package. Good job ensuring all references are updated.

op-e2e/e2eutils/addresses.go (1)

11-11: The updated import path aligns with the PR's objective of migrating the predeploys package. Good job ensuring all references are updated.

op-chain-ops/crossdomain/migrate_test.go (1)

9-9: The updated import path aligns with the PR's objective of migrating the predeploys package. Good job ensuring all references are updated.

op-chain-ops/genesis/layer_two.go (1)

19-19: The updated import path aligns with the PR's objective of migrating the predeploys package. Good job ensuring all references are updated.

op-chain-ops/crossdomain/migrate.go (1)

8-8: The updated import path aligns with the PR's objective of migrating the predeploys package. Good job ensuring all references are updated.

indexer/e2e_tests/reorg_e2e_test.go (1)

12-12: The updated import path aligns with the PR's objective of migrating the predeploys package. Good job ensuring all references are updated.

op-e2e/bridge_test.go (1)

14-14: The updated import path aligns with the PR's objective of migrating the predeploys package. Good job ensuring all references are updated.

op-node/rollup/derive/attributes.go (1)

13-13: The updated import path aligns with the PR's objective of migrating the predeploys package. Good job ensuring all references are updated.

op-chain-ops/crossdomain/legacy_withdrawal.go (1)

10-10: Change of import path for predeploys is correctly implemented and used within the file.

indexer/config/config.go (1)

10-10: Change of import path for predeploys is correctly implemented and used within the file.

op-chain-ops/genesis/genesis.go (1)

9-9: Change of import path for predeploys is correctly implemented and used within the file.

op-service/sources/l2_client.go (1)

17-17: Change of import path for predeploys is correctly implemented and used within the file.

indexer/e2e_tests/bridge_messages_e2e_test.go (1)

16-16: Change of import path for predeploys is correctly implemented and used within the file.

op-node/withdrawals/utils.go (1)

19-19: Change of import path for predeploys is correctly implemented and used within the file.

op-node/rollup/derive/attributes_test.go (1)

18-18: Updated import path correctly reflects the new location of the predeploys package and is used appropriately in the test cases.
packages/contracts-bedrock/scripts/go-ffi/differential-testing.go (1)
12-12: Updated import path correctly reflects the new location of the predeploys package. Ensure that the usage of the predeploys package is appropriate wherever it is used in this file or related files.

Verification successful

The output from the executed script shows that the predeploys package is indeed used in the differential-testing.go file. Specifically, the predeploys.L2ToL1MessagePasserAddr is utilized in two different contexts: updating storage and proving state. This indicates that the import is not only updated correctly but is also actively used in the file, which aligns with the purpose of differential testing in Ethereum transactions.

Given this information, the import path update and the usage of the predeploys package in differential-testing.go are both appropriate and correctly implemented. There is no need for further verification scripts at this point.

Updated Import Path and Usage Verified

The updated import path for the predeploys package in differential-testing.go is correct and the usage of this package in the file is appropriate and functional. The specific uses of predeploys.L2ToL1MessagePasserAddr for updating storage and proving state are consistent with the expected functionalities in differential testing scenarios.

File: packages/contracts-bedrock/scripts/go-ffi/differential-testing.go

Correct import of predeploys package.

Appropriate usage of predeploys.L2ToL1MessagePasserAddr in storage update and state proof operations.
Scripts Executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify the usage of `predeploys` package in `differential-testing.go` and related files.

# Test: Search for the usage of `predeploys` package. Expect: Appropriate usage in the context of the file.
rg --type go $'predeploys' 'packages/contracts-bedrock/scripts/go-ffi'
Length of output: 533
indexer/database/bridge_transfers.go (2)

11-11: Updated import path to reflect the new location of the predeploys package.

11-11: Correct usage of the predeploys package for defining ETHTokenPair.

op-e2e/custom_gas_token_test.go (2)

14-14: Updated import path to reflect the new location of the predeploys package.

14-14: Correct usage of the predeploys package for accessing contract addresses in end-to-end tests.

indexer/processors/bridge/legacy_bridge_processor.go (2)

17-17: Updated import path to reflect the new location of the predeploys package.

17-17: Correct usage of the predeploys package for accessing contract addresses in processing legacy bridge events.

op-e2e/actions/user.go (1)

30-30: The import path update from op-bindings/predeploys to op-service/predeploys aligns with the PR's objectives and the AI-generated summary.

indexer/e2e_tests/bridge_transfers_e2e_test.go (1)

19-19: The import path update from op-bindings/predeploys to op-service/predeploys aligns with the PR's objectives and the AI-generated summary.
op-chain-ops/cmd/check-ecotone/main.go (2)
38-38: Updated import path to reflect new package location.

38-38: Ensure that all references to the predeploys package are updated throughout the project to prevent any broken dependencies.

Verification successful

All references to the predeploys package appear to have been successfully updated across the project, as no occurrences of the old import path were found in the Go files.
Scripts Executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify all references to `predeploys` are updated.

# Test: Search for the old import path. Expect: No occurrences.
rg --type go $'github.com/ethereum-optimism/optimism/op-bindings/predeploys'
Length of output: 75
op-e2e/system_tob_test.go (1)

22-22: Updated import path to reflect new package location.

op-e2e/setup.go (1)

65-65: Updated import path to reflect new package location.

This change aligns with the project's goal of restructuring and consolidating system-related code. Ensure all references to the predeploys package across the project are updated to this new path to maintain consistency.

op-e2e/system_test.go (1)

45-45: Update import path to reflect new package location.

This change correctly updates the import path from op-bindings/predeploys to op-service/predeploys as part of the migration process.

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.

May 10 '24 13:05 coderabbitai[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 29.22%. Comparing base (9a22b09) to head (66f14a4). Report is 8 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff              @@
##           develop   #10494       +/-   ##
============================================
- Coverage    42.31%   29.22%   -13.09%     
============================================
  Files           73       31       -42     
  Lines         4838     2898     -1940     
  Branches       766      614      -152     
============================================
- Hits          2047      847     -1200     
+ Misses        2682     1976      -706     
+ Partials       109       75       -34

Flag	Coverage Δ
cannon-go-tests	`?`
chain-mon-tests	`27.14% <ø> (ø)`
common-ts-tests	`?`
contracts-ts-tests	`12.25% <ø> (ø)`
core-utils-tests	`?`
sdk-tests	`40.27% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
packages/contracts-ts/wagmi.config.ts	`0.00% <ø> (ø)`

... and 42 files with indirect coverage changes

May 10 '24 13:05 codecov[bot]

op-service: predeploys package

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Codecov Report

CodeRabbit Configration File (`.coderabbit.yaml`)