optimism icon indicating copy to clipboard operation
optimism copied to clipboard

feat/L2ToL2CrossDomainMessenger: create

Open 0xfuturistic opened this issue 1 year ago • 7 comments

0xfuturistic avatar Apr 24 '24 20:04 0xfuturistic

Walkthrough

Walkthrough

The updates focus on enhancing secure ERC20 token transfers and message handling between Layer 2 networks. Key changes include introducing new contracts like L2ToL2CrossDomainMessenger for token transfers, CrossL2Inbox for message execution, and associated testing suites. The TransientContext library is renamed for clarity, and the Predeploys library is updated with a new constant address.

Changes

Files Changes
.../L2ToL2CrossDomainMessenger.sol, .../L2ToL2CrossDomainMessenger.t.sol Introduce L2ToL2CrossDomainMessenger for secure token transfers and message relaying between Layer 2 networks with its test suite.
.../CrossL2Inbox.sol, .../ICrossL2Inbox.sol, .../CrossL2Inbox.t.sol Add CrossL2Inbox contract and interface for executing cross-chain messages, along with a comprehensive test suite.
.../libraries/TransientContext.sol Rename the library to "TransientContext" for clarity.
.../libraries/Predeploys.sol Include a new constant address L2_TO_L2_CROSS_DOMAIN_MESSENGER in the Predeploys library.
.../L2Genesis.t.sol Update the number of proxies with the implementation set from 17 to 19.

Recent Review Details

Configuration used: .coderabbit.yml Review profile: CHILL

Commits Files that changed from the base of the PR and between bfe5fa8fec74726ef9fd95faf96d77ddb0946fe3 and a8e811142c46787010b970e24c7fd9242072008d.
Files selected for processing (1)
  • packages/contracts-bedrock/test/L2/L2ToL2CrossDomainMessenger.t.sol (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/contracts-bedrock/test/L2/L2ToL2CrossDomainMessenger.t.sol

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.

coderabbitai[bot] avatar Apr 24 '24 20:04 coderabbitai[bot]

We can focus on this after https://github.com/ethereum-optimism/optimism/pull/10296

tynes avatar Apr 24 '24 21:04 tynes

Semgrep found 2 golang_fmt_errorf_no_params findings:

No fmt.Errorf invocations without fmt arguments allowed

Ignore this finding from golang_fmt_errorf_no_params.

semgrep-app[bot] avatar Apr 25 '24 01:04 semgrep-app[bot]

Semgrep found 2 golang_fmt_errorf_no_params findings:

No fmt.Errorf invocations without fmt arguments allowed

Ignore this finding from golang_fmt_errorf_no_params.

Semgrep found 1 import-text-template finding:

  • op-bindings/bindgen/remote_handlers.go

When working with web applications that involve rendering user-generated content, it's important to properly escape any HTML content to prevent Cross-Site Scripting (XSS) attacks. In Go, the text/template package does not automatically escape HTML content, which can leave your application vulnerable to these types of attacks. To mitigate this risk, it's recommended to use the html/template package instead, which provides built-in functionality for HTML escaping. By using html/template to render your HTML content, you can help to ensure that your web application is more secure and less susceptible to XSS vulnerabilities.

Ignore this finding from import-text-template.

semgrep-app[bot] avatar Apr 25 '24 16:04 semgrep-app[bot]

We can rebase this on top of https://github.com/ethereum-optimism/optimism/pull/10296 once it merges

tynes avatar Apr 27 '24 00:04 tynes

Looks like this needs a rebase with the Predeploys.sol

tynes avatar Apr 27 '24 00:04 tynes

Codecov Report

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

Project coverage is 29.22%. Comparing base (826a7bd) to head (a8e8111). Report is 15 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff              @@
##           develop   #10297       +/-   ##
============================================
- 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

codecov[bot] avatar Apr 27 '24 01:04 codecov[bot]

Semgrep found 2 sol-style-return-arg-fmt findings:

Named return arguments to functions must be appended with an underscore (_)

Ignore this finding from sol-style-return-arg-fmt.

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

Prefer @notice over @dev in natspec comments

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

Semgrep found 3 sol-style-input-arg-fmt findings:

Inputs to functions must be prepended with an underscore (_)

Ignore this finding from sol-style-input-arg-fmt.

semgrep-app[bot] avatar Apr 29 '24 22:04 semgrep-app[bot]