fpac: reserve spacer slot in OptimismPortal2

[tynes]

Description

Allows for merging of OptimismPortal that supports custom gas token and also OptimismPortal2 that has a modified storage layout. The OptimismPortal has spacers to account for the storage layout changes in OptimismPortal2 and it adds its new storage slot at the location that the spacer is added in.

This faciliates the ability to merge the portal codebases in the future.

[coderabbitai[bot]]

Walkthrough

The recent updates focus on enhancing forwards compatibility in the system. A new verification has been introduced in the ChainAssertions script to ensure a slot for a potential future custom gas token remains untouched. Additionally, a spacer variable has been strategically placed in the OptimismPortal2 contract to accommodate future expansions without disrupting current functionalities.

Changes

File Path	Change Summary
.../scripts/ChainAssertions.sol	Added a new check to ensure a slot for future custom gas token usage remains unset.
.../src/L1/OptimismPortal2.sol	Introduced a new private variable spacer_61_0_32 as a forward compatibility measure.

---

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 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.

[codecov[bot]]

Codecov Report

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

Project coverage is 29.22%. Comparing base (344d919) to head (e30c448).

Additional details and impacted files

@@             Coverage Diff              @@
##           develop   #10279       +/-   ##
============================================
- Coverage    42.33%   29.22%   -13.11%     
============================================
  Files           73       31       -42     
  Lines         4845     2898     -1947     
  Branches       766      614      -152     
============================================
- Hits          2051      847     -1204     
+ Misses        2684     1976      -708     
+ Partials       110       75       -35     

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.

see 42 files with indirect coverage changes

[Inphi]

It'll be good to update the Portal2 post checks to further ensure that we don't accidentally reuse that slot for something else. Relying on human review for storage slot changes isn't as reliable.

[tynes]

Ok will address comments, ty for review

[tynes]

It'll be good to update the Portal2 post checks to further ensure that we don't accidentally reuse that slot for something else. Relying on human review for storage slot changes isn't as reliable.

I have also addressed this comment