contracts-bedrock: move immutables to storage for OptimismPortal

[0xfuturistic]

context: https://github.com/ethereum-optimism/client-pod/issues/265
security review (wip): https://www.notion.so/oplabs/DRAFT-Security-Review-Move-Immutables-to-Storage-in-L1-Contracts-56c07789fa454d8fb2df80f0b84a483b?pvs=4
legacy PR: #6446

[coderabbitai]

Walkthrough

Walkthrough

The updates reflect significant changes to the OptimismPortal functionality within an Ethereum Layer 2 scaling solution. The changes involve restructuring the initialization process to be more flexible by conditionally including additional parameters. A new L2OutputOracleProxy field is introduced in the configuration, and various contract functions and tests have been updated to accommodate these modifications. Additionally, there's an update to the subproject's commit hash indicating changes in dependencies, and gas cost benchmarks have been adjusted.

Changes

File Path	Change Summary
op-chain-ops/upgrades/l1.go packages/contracts-bedrock/scripts/Deploy.s.sol	Modified OptimismPortal initialization logic to include L2Oracle and SystemConfig checks. Updated calldata packing for initialization. Altered instantiation of OptimismPortal to remove dependency on L2OutputOracle and SystemConfig during deployment. Adjusted abi.encodeCall parameters during upgrade and initialization.
packages/contracts-bedrock/.gas-snapshot	Adjusted gas costs for benchmark tests.
packages/contracts-bedrock/scripts/ChainAssertions.sol	Modified logic in checkOptimismPortal function to include additional checks when _isProxy is false. Adjusted assertions related to addresses.
packages/contracts-bedrock/src/L1/OptimismPortal.sol	Removed L2_ORACLE and SYSTEM_CONFIG public immutable variables, replaced with l2Oracle and systemConfig public variables. Modified initialize function to take three parameters and initialize corresponding variables. Updated getter functions for l2Oracle and systemConfig. Updated comments for clarity. Semantic version updated to "2.4.0."
packages/contracts-bedrock/test/L1/OptimismPortal.t.sol	Added Constants import, modified test_constructor_succeeds and test_initialize_succeeds functions. Replaced instances of optimismPortal.L2_ORACLE() with optimismPortal.l2Oracle().
packages/contracts-bedrock/test/Specs.t.sol	Modified function call from initialize(address) to initialize(address,address,address).
packages/contracts-bedrock/lib/forge-std	Updated the subproject commit hash.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.

[codecov]

Codecov Report

Attention: 28 lines in your changes are missing coverage. Please review.

Comparison is base (670f534) 25.72% compared to head (7580960) 25.73%.
Report is 83 commits behind head on feat/mcp-l1.

Additional details and impacted files

@@             Coverage Diff              @@
##           feat/mcp-l1    #8629   +/-   ##
============================================
  Coverage        25.72%   25.73%           
============================================
  Files              117      117           
  Lines             4844     4854   +10     
  Branches          1057     1059    +2     
============================================
+ Hits              1246     1249    +3     
- Misses            3494     3499    +5     
- Partials           104      106    +2     

Flag	Coverage Δ
chain-mon-tests	27.14% <ø> (ø)
contracts-bedrock-tests	20.28% <0.00%> (+0.04%)	⬆️
contracts-ts-tests	12.25% <ø> (ø)
sdk-next-tests	42.08% <ø> (ø)
sdk-tests	42.08% <ø> (ø)

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

Files	Coverage Δ
...ock/src/universal/OptimismMintableERC20Factory.sol	0.00% <0.00%> (ø)
...ckages/contracts-bedrock/src/L1/OptimismPortal.sol	0.00% <0.00%> (ø)
...ckages/contracts-bedrock/src/L1/L2OutputOracle.sol	0.00% <0.00%> (ø)

... and 3 files with indirect coverage changes

[semgrep-app]

Semgrep found 1 iterate-over-empty-map finding:

• op-batcher/compressor/compressors.go: L12-23

Iteration over a possibly empty map Kinds. This is likely a bug or redundant code

_{Ignore this finding from iterate-over-empty-map.}

[semgrep-app]

Semgrep found 7 sol-style-notice-over-dev-natspec findings:

• packages/contracts-bedrock/src/dispute/interfaces/IOutputBisectionGame.sol: L57, L38, L12
• packages/contracts-bedrock/src/dispute/interfaces/IBondManager.sol: L48, L41, L36, L28

Prefer @notice over @dev in natspec comments

_{Ignore this finding from sol-style-notice-over-dev-natspec.}

Semgrep found 1 no-printf-in-responsewriter finding:

• op-exporter/main.go: L83

Detected 'printf' or similar in 'http.ResponseWriter.write()'. This bypasses HTML escaping that prevents cross-site scripting vulnerabilities. Instead, use the 'html/template' package to render data to users.

_{Ignore this finding from no-printf-in-responsewriter.}

Semgrep found 1 no-direct-write-to-responsewriter finding:

• op-exporter/main.go: L83

Detected directly writing or similar in 'http.ResponseWriter.write()'. This bypasses HTML escaping that prevents cross-site scripting vulnerabilities. Instead, use the 'html/template' package and render data using 'template.Execute()'.

_{Ignore this finding from no-direct-write-to-responsewriter.}

Semgrep found 1 use-tls finding:

• op-exporter/main.go: L138

Found an HTTP server without TLS. Use 'http.ListenAndServeTLS' instead. See https://golang.org/pkg/net/http/#ListenAndServeTLS for more information.

_{Ignore this finding from use-tls.}

Semgrep found 1 context-todo finding:

• op-exporter/main.go: L156

Consider to use well-defined context

_{Ignore this finding from context-todo.}

Semgrep found 1 use-fprintf-not-write-fsprint finding:

• op-exporter/main.go: L83

use fmt.Fprintf(w, { "healthy": "%t", "version": "%s" }, health.healthy, *health.version) instead of fmt.Sprintf and []byte conversion

_{Ignore this finding from use-fprintf-not-write-fsprint.}