Adds "real" L1 and L2 message passing contracts. by smartcontracts · Pull Request #236 · ethereum-optimism/optimism

smartcontracts · 2020-08-27T22:08:57Z

Description

Helloooo. This PR adds the "real" L1CrossDomainMessenger and L2CrossDomainMessenger contracts, along with interfaces and mocks for both. We'll have to make sure to update optimism-devex to account for these changes.

I think I've hit all of the necessary logic here (including checking inclusion proofs on the L1 side). Only thing left is to check that the state batch header timestamp is sufficiently old (requires a larger set of changes to various contracts).

Metadata

Fixes

Fixes YAS-581, YAS-582

Contributing Agreement

I have read and understood the Optimism Contributing Guide and Code of Conduct and am following those guidelines in this pull request.

karlfloersch

Alright this LG(reat)TM! Left one comment on standardizing the L1 / L2 interfaces & how this can allow us to keep the old mock-ed contracts based on the assumption that some of the inner workings of replay & verification happen in the background and can be unit-tested elsewhere / don't need to be in the mocks.

packages/contracts/contracts/optimistic-ethereum/ovm/precompiles/MockL2ToL1MessagePasser.sol

karlfloersch · 2020-08-28T22:25:23Z

packages/contracts/contracts/optimistic-ethereum/bridge/MockCrossDomainMessenger.sol

-     */
-    function sendMessage(
-        address _target,
-        bytes memory _message


As we discussed in person, I think it makes sense to add a gasLimit to this function and this way we can actually keep the old mocks. As long as we assume that the "relay message" on L1 & the "replay" functionality is handled in some standardized way, then developers building for L1 / L2 shouldn't have to unit test that functionality. It should just "happen" in the background.

Hmmm, interesting. After the Synthetix call today, I feel like having the full interface is probably useful for developers. We can always add a wrapper that ignores these extra parameters later if it seems to be useful.

karlfloersch · 2020-09-02T15:23:43Z

packages/contracts/contracts/optimistic-ethereum/bridge/MockL1CrossDomainMessenger.sol

+/**
+ * @title MockL1CrossDomainMessenger
+ */
+contract MockL1CrossDomainMessenger is L1CrossDomainMessenger {


So is it possible to just have a MockCrossDomainMessenger like before and not have them inherit from the more complete L1 / L2 messengers?

Basically we don't mock whole async 'relay' functionality in the mock version of the tests because that is all handled in the background for users / dapps

So these mocks bypass the proof checks within the complete contracts. It keeps the interface the same and does minimal verification so that developers can sanity check for common cases (e.g., attempting to send the same message twice). I feel like it's a good middle ground for now.

so that developers can sanity check for common cases (e.g., attempting to send the same message twice).

Do you think that developers should write unit tests which call replayMessage(...) ? My guess would be that this is not really required in the same way that developers normally don't add tests for users who send a tx with under-priced gas & then use a replace tx with higher gas price.

Generally down to keep this interface but I just want to make sure that we're on the same page wrt what makes sense to put in unit tests

To me the biggest thing missing in our mocks is a helper function which you can import called waitForCrossDomainMessage(txHash) which can be used something like this:

// Do something which sends a message to L2 const txHash = await myL1Contract.sendDepositToL2() // Wait for the L1->L2 message to be processed await waitForCrossDomainMessage(txHash) // Do another thing on L2 like spend the deposit await myL2Contract.spendMyMoney()

This way we can (in both L1->L2 direction & L2->L1 direction) just wait for the transaction to be "mined" / applied. And then when we build the "real" version we add a little util which is used for waiting for the same behavior.

I still am into to keeping the L1XDomainMessenger & L2XDomainMessenger separate--that way we can figure out a better way to mock out the fact that L2->L1 messages take a week. But other than that I feel like this is a solid abstraction.

karlfloersch

I want to get this merged but there are a few updates we need to make:

Update the MockL1/MockL2CrossDomainMessengers to use the same sendMessage(...) interface which includes gasLimit for the L2CrossDomainMessenger.
Add a waitForCrossDomainMessage(txHash) function which can be used in the mock. This is a standin for what we will need when we implement these unit tests against the real backend. (described here)
Update https://github.com/ethereum-optimism/Buidler-Deposit-Withdraw-Example to reflect these changes.

Once the mocks are set up this should be good for a merge!

karlfloersch

Dope this looks great! I remember you said that you updated the deposit / withdrawal example & it worked - is that pushed somewhere I can take a look at?

Anyway, hype! Excited to get this merged

tynes · 2020-09-09T13:36:46Z

packages/contracts/contracts/optimistic-ethereum/bridge/L1CrossDomainMessenger.sol

+        );
+
+        return EthMerkleTrie.proveAccountStorageSlotValue(
+            0x4200000000000000000000000000000000000000,


This is a ovm specific precompile address? Maybe a good idea to turn it into a constant so its not a magic number

…po into YAS-581/contracts/Messenger

troggy · 2020-09-16T15:01:42Z

packages/contracts/contracts/optimistic-ethereum/bridge/MockL1CrossDomainMessenger.sol

+/**
+ * @title MockL1CrossDomainMessenger
+ */
+contract MockL1CrossDomainMessenger is BaseMockCrossDomainMessenger, L1CrossDomainMessenger {


this contract misses the constructor call for the super class

troggy · 2020-09-16T15:02:12Z

packages/contracts/contracts/optimistic-ethereum/bridge/MockL2CrossDomainMessenger.sol

+/**
+ * @title MockL2CrossDomainMessenger
+ */
+contract MockL2CrossDomainMessenger is BaseMockCrossDomainMessenger, L2CrossDomainMessenger {


ditto. This contract misses the super constructor call as well

* migration: Update to UnreleasedTreasury contract * Update op-chain-ops/cmd/celo-migrate/state.go Co-authored-by: Karl Bartel <karl@karl.berlin> * Update op-chain-ops/cmd/celo-migrate/state.go Co-authored-by: Karl Bartel <karl@karl.berlin> --------- Co-authored-by: Karl Bartel <karl@karl.berlin>

* feat(ci): Dependabot config ## Overview Introduces jonhoo's dependabot config, which notifies on outdated github actions as well as outdated crate dependencies. * chore: Bump dependencies ## Overview Bumps dependencies in the workspace, before dependabot gets to them.

smol helper

This PR separates storage and account cursors which makes sense because these two cursors may have very different seek/next implementations. In the case of in-memory, a single cursor impl can still handle both, but for MDBX, it makes sense to implement separate cursors. Closes #236 --------- Co-authored-by: Arun Dhyani <dhyaniarun7@gmail.com>

smartcontracts added 4 commits August 26, 2020 17:23

First stab at the xdomain messenger contracts

0ea13ba

Merge branch 'master' into YAS-581/contracts/Messenger

db50e7c

Create 'real' messenger contracts

08d1cf0

Fixed interfaces a bit

4bf2a2f

karlfloersch approved these changes Aug 28, 2020

View reviewed changes

karlfloersch reviewed Sep 2, 2020

View reviewed changes

karlfloersch requested changes Sep 3, 2020

View reviewed changes

smartcontracts added 2 commits September 3, 2020 21:31

Added more developer functions

7331feb

Clean up waffle objects

5adc561

karlfloersch approved these changes Sep 8, 2020

View reviewed changes

Fixed linting issues

6d27daf

tynes reviewed Sep 9, 2020

View reviewed changes

karlfloersch added 4 commits September 15, 2020 17:14

Fix broken sendMessage(..) test usage

14b954c

Merge branch 'master' of github.com:ethereum-optimism/optimism-monore…

2f52617

…po into YAS-581/contracts/Messenger

Update yarn lock

6b8b121

Update msg passing tests to use startsAtIndex

2d7de51

karlfloersch merged commit cb2de09 into master Sep 15, 2020

troggy reviewed Sep 16, 2020

View reviewed changes

karlfloersch deleted the YAS-581/contracts/Messenger branch November 3, 2020 15:47

snario pushed a commit that referenced this pull request Apr 14, 2021

Fix some broken dependencies (#236)

d9a5297

bap2pecs pushed a commit to babylonlabs-io/optimism that referenced this pull request Jul 31, 2024

Bumps babylon to latest version (ethereum-optimism#236)

c503872

xibao-nr pushed a commit to node-real/combo-optimism that referenced this pull request Feb 19, 2025

doc: update v0.5.0 changelog (ethereum-optimism#236)

1a3fb74

Zena-park added a commit to tokamak-network/optimism that referenced this pull request Dec 30, 2025

[SMR-01S] Illegible Numeric Value Representations ethereum-optimism#236

52be69c

theochap pushed a commit that referenced this pull request Jan 15, 2026

feat: add fn for decoded 1559 params (#236)

d2bb64a

smol helper

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds "real" L1 and L2 message passing contracts.#236

Adds "real" L1 and L2 message passing contracts.#236
karlfloersch merged 11 commits intomasterfrom
YAS-581/contracts/Messenger

smartcontracts commented Aug 27, 2020

Uh oh!

karlfloersch left a comment

Uh oh!

Uh oh!

karlfloersch Aug 28, 2020

Uh oh!

smartcontracts Sep 2, 2020

Uh oh!

karlfloersch Sep 2, 2020

Uh oh!

smartcontracts Sep 2, 2020

Uh oh!

karlfloersch Sep 2, 2020 •

edited

Loading

Uh oh!

karlfloersch Sep 2, 2020 •

edited

Loading

Uh oh!

karlfloersch left a comment

Uh oh!

karlfloersch left a comment

Uh oh!

tynes Sep 9, 2020

Uh oh!

troggy Sep 16, 2020

Uh oh!

troggy Sep 16, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

smartcontracts commented Aug 27, 2020

Description

Metadata

Fixes

Contributing Agreement

Uh oh!

karlfloersch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

karlfloersch Aug 28, 2020

Choose a reason for hiding this comment

Uh oh!

smartcontracts Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

karlfloersch Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

smartcontracts Sep 2, 2020

Choose a reason for hiding this comment

Uh oh!

karlfloersch Sep 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

karlfloersch Sep 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

karlfloersch left a comment

Choose a reason for hiding this comment

Uh oh!

karlfloersch left a comment

Choose a reason for hiding this comment

Uh oh!

tynes Sep 9, 2020

Choose a reason for hiding this comment

Uh oh!

troggy Sep 16, 2020

Choose a reason for hiding this comment

Uh oh!

troggy Sep 16, 2020

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

karlfloersch Sep 2, 2020 •

edited

Loading

karlfloersch Sep 2, 2020 •

edited

Loading