docs: add l1-l2-deposit-withdrawal (#684)

* Merge conflict

* add: integration test

* chore: cleanup deps

* fix: nohoist examples so that paths get set correctly

* chore: rename package.json script

* chore: combine test statements into 1

previously the individually separate tests did not test anything meaningful

* fix: get tests to pass

* add yarn and fix typo

* remove call to yarn

* re-add call to yarn for first tests

* revert compilerVersion paths to og

* update ovm-solc path

* update test commands

* typo

* final bug fix

* cleaning

* i will prevail

* i will prevail

* timeout to 60sec
Co-authored-by: Georgios Konstantopoulos <me@gakonst.com>

> LGTM, it may be worth splitting the examples testing in a separate github workflow to reduce CI times, as they've become long.

.github/workflows/integration.yml

@@ -45,40 +45,51 @@ jobs:
         run: docker-compose run integration_tests
 
       # Examples Tests
-      - name: Test & deploy hardhat-example on hardhat (regression)
+      - name: Test & deploy hardhat-example on Ethereum (regression)
         working-directory: ./examples/hardhat
         run: |
+          yarn
           yarn deploy
           yarn test:integration
 
-      - name: Test & deploy hardhat-example on Optimism
+      - name: Test & deploy hardhat-example on Optimistic Ethereum
         working-directory: ./examples/hardhat
         run: |
           yarn deploy:ovm
           yarn test:integration:ovm
 
-      - name: Test & deploy waffle-example on waffle (regression)
+      - name: Test & deploy waffle-example on Ethereum (regression)
         working-directory: ./examples/waffle
         run: |
+          yarn
           yarn compile
           yarn test:integration
 
-      - name: Test & deploy waffle-example on Optimism
+      - name: Test & deploy waffle-example on Optimistic Ethereum
         working-directory: ./examples/waffle
         run: |
           yarn compile:ovm
           yarn test:integration:ovm
 
-      - name: Test & deploy truffle-example on truffle (regression)
+      - name: Test & deploy truffle-example on Ethereum (regression)
         working-directory: ./examples/truffle
         run: |
+          yarn
           yarn compile
           yarn test:integration
           yarn deploy
 
-      - name: Test & deploy truffle-example on Optimism
+      - name: Test & deploy truffle-example on Optimistic Ethereum
         working-directory: ./examples/truffle
         run: |
           yarn compile:ovm
           yarn test:integration:ovm
           yarn deploy:ovm
+      
+      - name: Test l1-l2-deposit-withdrawal example on Optimistic Ethereum with cross-domain message passing
+        working-directory: ./examples/l1-l2-deposit-withdrawal
+        run: |
+          yarn
+          yarn compile
+          yarn compile:ovm
+          yarn test:integration:ovm

examples/hardhat/package.json

@@ -6,13 +6,13 @@
   "author": "Optimism PBC",
   "license": "MIT",
   "scripts": {
-    "deploy": "hardhat deploy",
-    "deploy:ovm": "hardhat deploy --network optimism",
+    "clean": "rimraf ./cache-ovm ./cache ./artifacts-ovm ./artifacts ./deployments",
     "compile": "hardhat compile",
     "compile:ovm": "hardhat compile --network optimism",
     "test:integration": "hardhat test",
     "test:integration:ovm": "hardhat test --network optimism",
-    "clean": "rimraf ./cache-ovm ./cache ./artifacts-ovm ./artifacts ./deployments"
+    "deploy": "hardhat deploy",
+    "deploy:ovm": "hardhat deploy --network optimism"
   },
   "devDependencies": {
     "@nomiclabs/hardhat-ethers": "^2.0.1",

examples/l1-l2-deposit-withdrawal/.gitignore

+# Packages
+node_modules/
+
+# Hardhat build outputs
+artifacts/
+artifacts-ovm/
+cache/
+cache-ovm/
+optimism
+
+.env
\ No newline at end of file

examples/l1-l2-deposit-withdrawal/README.md

+# L1/L2 ERC20 Deposit + Withdrawal Example
+
+### For the full README, please see the [guided repository of `l1-l2-deposit-withdrawal`](https://github.com/ethereum-optimism/l1-l2-deposit-withdrawal)
\ No newline at end of file

examples/l1-l2-deposit-withdrawal/contracts/ERC20.sol

+// SPDX-License-Identifier: MIT
+pragma solidity >0.6.0 <0.8.0;
+
+/**
+ * @title ERC20
+ * @dev A super simple ERC20 implementation! Also *very* insecure. Do not use in prod.
+ */
+contract ERC20 {
+
+    /**********
+     * Events *
+     **********/
+
+    event Transfer(
+        address indexed _from,
+        address indexed _to,
+        uint256 _value
+    );
+
+    event Approval(
+        address indexed _owner,
+        address indexed _spender,
+        uint256 _value
+    );
+
+
+    /*************
+     * Variables *
+     *************/
+
+    mapping (address => uint256) public balances;
+    mapping (address => mapping (address => uint256)) public allowances;
+
+    // Some optional extra goodies.
+    uint256 public totalSupply;
+    string public name;
+
+
+    /***************
+     * Constructor *
+     ***************/
+
+    /**
+     * @param _initialSupply Initial maximum token supply.
+     * @param _name A name for our ERC20 (technically optional, but it's fun ok jeez).
+     */
+    constructor(
+        uint256 _initialSupply,
+        string memory _name
+    )
+        public
+    {
+        balances[msg.sender] = _initialSupply;
+        totalSupply = _initialSupply;
+        name = _name;
+    }
+
+
+    /********************
+     * Public Functions *
+     ********************/
+
+    /**
+     * Checks the balance of an address.
+     * @param _owner Address to check a balance for.
+     * @return Balance of the address.
+     */
+    function balanceOf(
+        address _owner
+    )
+        external
+        view
+        returns (
+            uint256
+        )
+    {
+        return balances[_owner];
+    }
+
+    /**
+     * Transfers a balance from your account to someone else's account!
+     * @param _to Address to transfer a balance to.
+     * @param _amount Amount to transfer to the other account.
+     * @return true if the transfer was successful.
+     */
+    function transfer(
+        address _to,
+        uint256 _amount
+    )
+        external
+        returns (
+            bool
+        )
+    {
+        require(
+            balances[msg.sender] >= _amount,
+            "You don't have enough balance to make this transfer!"
+        );
+
+        balances[msg.sender] -= _amount;
+        balances[_to] += _amount;
+
+        emit Transfer(
+            msg.sender,
+            _to,
+            _amount
+        );
+
+        return true;
+    }
+
+    /**
+     * Transfers a balance from someone else's account to another account. You need an allowance
+     * from the sending account for this to work!
+     * @param _from Account to transfer a balance from.
+     * @param _to Account to transfer a balance to.
+     * @param _amount Amount to transfer to the other account.
+     * @return true if the transfer was successful.
+     */
+    function transferFrom(
+        address _from,
+        address _to,
+        uint256 _amount
+    )
+        external
+        returns (
+            bool
+        )
+    {
+        require(
+            balances[_from] >= _amount,
+            "Can't transfer from the desired account because it doesn't have enough balance."
+        );
+
+        require(
+            allowances[_from][msg.sender] >= _amount,
+            "Can't transfer from the desired account because you don't have enough of an allowance."
+        );
+
+        balances[_to] += _amount;
+        balances[_from] -= _amount;
+
+        emit Transfer(
+            _from,
+            _to,
+            _amount
+        );
+
+        return true;
+    }
+
+    /**
+     * Approves an account to spend some amount from your account.
+     * @param _spender Account to approve a balance for.
+     * @param _amount Amount to allow the account to spend from your account.
+     * @return true if the allowance was successful.
+     */
+    function approve(
+        address _spender,
+        uint256 _amount
+    )
+        external
+        returns (
+            bool
+        )
+    {
+        allowances[msg.sender][_spender] = _amount;
+
+        emit Approval(
+            msg.sender,
+            _spender,
+            _amount
+        );
+
+        return true;
+    }
+
+    /**
+     * Checks how much a given account is allowed to spend from another given account.
+     * @param _owner Address of the account to check an allowance from.
+     * @param _spender Address of the account trying to spend from the owner.
+     * @return Allowance for the spender from the owner.
+     */
+    function allowance(
+        address _owner,
+        address _spender
+    )
+        external
+        view
+        returns (
+            uint256
+        )
+    {
+        return allowances[_owner][_spender];
+    }
+
+    /**
+     * Internal minting function.
+     * @param _who Address to mint tokens for.
+     * @param _amount Number of tokens to mint.
+     */
+    function _mint(
+        address _who,
+        uint256 _amount
+    )
+        internal
+    {
+        totalSupply += _amount;
+        balances[_who] += _amount;
+        emit Transfer(address(0), _who, _amount);
+    }
+
+    /**
+     * Internal burning function.
+     * @param _who Address to burn tokens from.
+     * @param _amount Number of tokens to burn.
+     */
+    function _burn(
+        address _who,
+        uint256 _amount
+    )
+        internal
+    {
+        require(
+            totalSupply >= _amount,
+            "Can't burn more than total supply."
+        );
+
+        require(
+            balances[_who] >= _amount,
+            "Account does not have enough to burn."
+        );
+
+        totalSupply -= _amount;
+        balances[_who] -= _amount;
+        emit Transfer(_who, address(0), _amount);
+    }
+}

examples/l1-l2-deposit-withdrawal/contracts/L2DepositedERC20.sol

+// SPDX-License-Identifier: MIT LICENSE
+pragma solidity >0.5.0 <0.8.0;
+pragma experimental ABIEncoderV2;
+
+/* Contract Imports */
+import { ERC20 } from "./ERC20.sol";
+
+/* Library Imports */
+import {
+    Abs_L2DepositedToken
+} from "@eth-optimism/contracts/OVM/bridge/tokens/Abs_L2DepositedToken.sol";
+
+/**
+ * @title L2DepositedERC20
+ * @dev An L2 Deposited ERC20 is an ERC20 implementation which represents L1 assets deposited into L2, minting and burning on
+ * deposits and withdrawals.
+ *
+ * `L2DepositedERC20` uses the Abs_L2DepositedToken class provided by optimism to link into a standard L1 deposit contract
+ * while using the `ERC20`implementation I as a developer want to use.
+ *
+ * Compiler used: optimistic-solc
+ * Runtime target: OVM
+ */
+contract L2DepositedERC20 is Abs_L2DepositedToken, ERC20 {
+
+    /**
+     * @param _l2CrossDomainMessenger Address of the L2 cross domain messenger.
+     * @param _name Name for the ERC20 token.
+     */
+    constructor(
+        address _l2CrossDomainMessenger,
+        string memory _name
+    )
+        Abs_L2DepositedToken(_l2CrossDomainMessenger)
+        ERC20(0, _name)
+    {}
+
+    /**
+     * Handler that gets called when a withdrawal is initiated.
+     * @param _to Address triggering the withdrawal.
+     * @param _amount Amount being withdrawn.
+     */
+    function _handleInitiateWithdrawal(
+        address _to,
+        uint256 _amount
+    )
+        internal
+        override
+    {
+        _burn(msg.sender, _amount);
+    }
+
+    /**
+     * Handler that gets called when a deposit is received.
+     * @param _to Address receiving the deposit.
+     * @param _amount Amount being deposited. 
+     */
+    function _handleFinalizeDeposit(
+        address _to,
+        uint256 _amount
+    )
+        internal
+        override
+    {
+        _mint(_to, _amount);
+    }
+}

examples/l1-l2-deposit-withdrawal/hardhat.config.js

+// Plugins
+require('@nomiclabs/hardhat-ethers')
+require('@nomiclabs/hardhat-waffle')
+require('@eth-optimism/hardhat-ovm')
+
+module.exports = {
+  networks: {
+    // Add this network to your config!
+    optimism: {
+      url: 'http://127.0.0.1:8545',
+      // This sets the gas price to 0 for all transactions on L2. We do this
+      // because account balances are not automatically initiated with an ETH
+      // balance.
+      gasPrice: 0,
+      ovm: true // This sets the network as using the ovm and ensure contract will be compiled against that.
+    },
+  },
+  solidity: '0.7.6',
+  ovm: {
+    solcVersion: '0.7.6'
+  },
+  mocha: {
+    timeout: 60000
+  }
+}

examples/l1-l2-deposit-withdrawal/package.json

+{
+  "name": "l1-l2-deposit-withdrawal",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "scripts": {
+    "clean": "rimraf ./cache ./artifacts ./cache-ovm ./artifacts-ovm",
+    "compile": "hardhat compile",
+    "compile:ovm": "hardhat compile --network optimism",
+    "test:integration:ovm": "yarn hardhat test --network optimism"
+  },
+  "devDependencies": {
+    "@eth-optimism/contracts": "^0.3.0",
+    "@eth-optimism/core-utils": "^0.4.2",
+    "@eth-optimism/hardhat-ovm": "^0.2.0",
+    "@eth-optimism/watcher": "^0.0.1-alpha.9",
+    "@nomiclabs/hardhat-ethers": "^2.0.2",
+    "@nomiclabs/hardhat-waffle": "^2.0.1",
+    "chai": "^4.3.4",
+    "ethereum-waffle": "^3.3.0",
+    "ethers": "^5.1.4",
+    "hardhat": "^2.2.1",
+    "mocha": "^8.4.0",
+    "rimraf": "^3.0.2"
+  }
+}

examples/l1-l2-deposit-withdrawal/test/example.test.js

+/* External Imports */
+const { ethers } = require('hardhat')
+const { expect } = require('chai')
+const { Watcher } = require('@eth-optimism/watcher')
+const { getContractFactory } = require('@eth-optimism/contracts')
+
+/* Internal Imports */
+const factory = (name, ovm = false) => {
+  const artifact = require(`../artifacts${ovm ? '-ovm' : ''}/contracts/${name}.sol/${name}.json`)
+  return new ethers.ContractFactory(artifact.abi, artifact.bytecode)
+}
+const factory__L1_ERC20 = factory('ERC20')
+const factory__L2_ERC20 = factory('L2DepositedERC20', true)
+const factory__L1_ERC20Gateway = getContractFactory('OVM_L1ERC20Gateway')
+
+
+describe(`L1 <> L2 Deposit and Withdrawal`, () => {
+  // Set up our RPC provider connections.
+  const l1RpcProvider = new ethers.providers.JsonRpcProvider('http://127.0.0.1:9545')
+  const l2RpcProvider = new ethers.providers.JsonRpcProvider('http://127.0.0.1:8545')
+
+  // Constructor arguments for `ERC20.sol`
+  const INITIAL_SUPPLY = 1234
+  const L1_ERC20_NAME = 'L1 ERC20'
+
+  // L1 messenger address depends on the deployment, this is default for our local deployment.
+  const l1MessengerAddress = '0x59b670e9fA9D0A427751Af201D676719a970857b'
+  // L2 messenger address is always the same.
+  const l2MessengerAddress = '0x4200000000000000000000000000000000000007'
+  const L2_ERC20_NAME = 'L2 ERC20'
+
+  // Set up our wallets (using a default private key with 10k ETH allocated to it).
+  // Need two wallets objects, one for interacting with L1 and one for interacting with L2.
+  // Both will use the same private key.
+  const key = '0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80'
+  const l1Wallet = new ethers.Wallet(key, l1RpcProvider)
+  const l2Wallet = new ethers.Wallet(key, l2RpcProvider)
+
+  // Tool that helps watches and waits for messages to be relayed between L1 and L2.
+  const watcher = new Watcher({
+    l1: {
+      provider: l1RpcProvider,
+      messengerAddress: l1MessengerAddress
+    },
+    l2: {
+      provider: l2RpcProvider,
+      messengerAddress: l2MessengerAddress
+    }
+  })
+
+  let L1_ERC20,
+    L2_ERC20,
+    L1_ERC20Gateway
+
+  before(`deploy contracts`, async () => {
+    // Deploy an ERC20 token on L1.
+    L1_ERC20 = await factory__L1_ERC20.connect(l1Wallet).deploy(
+      INITIAL_SUPPLY,
+      L1_ERC20_NAME,
+      {
+        gasPrice: 0
+      }
+    )
+
+    await L1_ERC20.deployTransaction.wait()
+
+    // Deploy the paired ERC20 token to L2.
+    L2_ERC20 = await factory__L2_ERC20.connect(l2Wallet).deploy(
+      l2MessengerAddress,
+      L2_ERC20_NAME,
+      {
+        gasPrice: 0
+      }
+    )
+
+    await L2_ERC20.deployTransaction.wait()
+
+    // Create a gateway that connects the two contracts.
+    L1_ERC20Gateway = await factory__L1_ERC20Gateway.connect(l1Wallet).deploy(
+      L1_ERC20.address,
+      L2_ERC20.address,
+      l1MessengerAddress,
+      {
+        gasPrice: 0
+      }
+    )
+
+    await L1_ERC20Gateway.deployTransaction.wait()
+  })
+
+  describe('Initialization and initial balances', async () => {
+    it(`should initialize L2 ERC20`, async () => {
+      const tx = await L2_ERC20.init(L1_ERC20Gateway.address, { gasPrice: 0 })
+      await tx.wait()
+      const txHashPrefix = tx.hash.slice(0, 2)
+      expect(txHashPrefix).to.eq('0x')
+    })
+
+    it(`should have initial L1 balance of 1234 and initial L2 balance of 0`, async () => {
+      const l1Balance = await L1_ERC20.balanceOf(l1Wallet.address)
+      const l2Balance = await L2_ERC20.balanceOf(l1Wallet.address)
+      expect(l1Balance).to.eq(1234)
+      expect(l2Balance).to.eq(0)
+    })
+  })
+
+  describe('L1 to L2 deposit', async () => {
+    let l1Tx1
+
+    it(`should approve 1234 tokens for ERC20 gateway`, async () => {
+      const tx = await L1_ERC20.approve(L1_ERC20Gateway.address, 1234)
+      await tx.wait()
+      const txHashPrefix = tx.hash.slice(0, 2)
+      expect(txHashPrefix).to.eq('0x')
+    })
+
+    it(`should deposit 1234 tokens into L2 ERC20`, async () => {
+      l1Tx1 = await L1_ERC20Gateway.deposit(1234, { gasPrice: 0 })
+      await l1Tx1.wait()
+      const txHashPrefix = l1Tx1.hash.slice(0, 2)
+      expect(txHashPrefix).to.eq('0x')
+    })
+
+    it(`should relay deposit message to L2`, async () => {
+      // Wait for the message to be relayed to L2.
+      const [ msgHash1 ] = await watcher.getMessageHashesFromL1Tx(l1Tx1.hash)
+      const l2TxReceipt = await watcher.getL2TransactionReceipt(msgHash1)
+      expect(l2TxReceipt.to).to.eq(l2MessengerAddress)
+    })
+
+    it(`should have changed L1 balance to 0 and L2 balance to 1234`, async () => {
+      const l1Balance = await L1_ERC20.balanceOf(l1Wallet.address)
+      const l2Balance = await L2_ERC20.balanceOf(l1Wallet.address)
+      expect(l1Balance).to.eq(0)
+      expect(l2Balance).to.eq(1234)
+    })
+  })
+
+  describe('L2 to L1 withdrawal', async () => {
+    let l2Tx1
+
+    it(`should withdraw tokens back to L1 ERC20 and relay the message`, async () => {
+      // Burn the tokens on L2 and ask the L1 contract to unlock on our behalf.
+      l2Tx1 = await L2_ERC20.withdraw(1234, { gasPrice: 0 })
+      await l2Tx1.wait()
+      const txHashPrefix = l2Tx1.hash.slice(0, 2)
+      expect(txHashPrefix).to.eq('0x')
+    })
+
+    it(`should relay withdrawal message to L1`, async () => {
+      const [ msgHash2 ] = await watcher.getMessageHashesFromL2Tx(l2Tx1.hash)
+      const l1TxReceipt = await watcher.getL1TransactionReceipt(msgHash2)
+      expect(l1TxReceipt.to).to.eq(l1MessengerAddress)
+    })
+
+    it(`should have changed L1 balance back to 1234 and L2 balance back to 0`, async () => {
+      const l1Balance = await L1_ERC20.balanceOf(l1Wallet.address)
+      const l2Balance = await L2_ERC20.balanceOf(l1Wallet.address)
+      expect(l1Balance).to.eq(1234)
+      expect(l2Balance).to.eq(0)
+    })
+  })
+})

examples/truffle/truffle-config-ovm.js

@@ -22,7 +22,7 @@ module.exports = {
   compilers: {
     solc: {
       // Add path to the optimism solc fork
-      version: '../../node_modules/@eth-optimism/solc',
+      version: './node_modules/@eth-optimism/solc',
       settings: {
         optimizer: {
           enabled: true,

examples/waffle/waffle-ovm.json

 {
-  "compilerVersion": "./../../node_modules/@eth-optimism/solc",
+  "compilerVersion": "./node_modules/@eth-optimism/solc",
   "sourceDirectory": "./contracts",
   "outputDirectory": "./build-ovm"
 }
\ No newline at end of file

examples/waffle/waffle.json

 {
-  "compilerVersion": "./../../node_modules/solc",
+  "compilerVersion": "./node_modules/solc",
   "sourceDirectory": "./contracts",
   "outputDirectory": "./build"
-}
+}
\ No newline at end of file

examples/waffle/yarn.lock

@@ -509,6 +509,24 @@
   dependencies:
     "@types/node" "*"
 
+"@types/chai@^4.2.17":
+  version "4.2.18"
+  resolved "https://registry.yarnpkg.com/@types/chai/-/chai-4.2.18.tgz#0c8e298dbff8205e2266606c1ea5fbdba29b46e4"
+  integrity sha512-rS27+EkB/RE1Iz3u0XtVL5q36MGDWbgYe7zWiodyKNUnthxY0rukK5V36eiUCtCisB7NN8zKYH6DO2M37qxFEQ==
+
+"@types/glob@*":
+  version "7.1.3"
+  resolved "https://registry.yarnpkg.com/@types/glob/-/glob-7.1.3.tgz#e6ba80f36b7daad2c685acd9266382e68985c183"
+  integrity sha512-SEYeGAIQIQX8NN6LDKprLjbrd5dARM5EXsd8GI/A5l0apYI1fGMWgPHSe4ZKL4eozlAyI+doUE9XbYS4xCkQ1w==
+  dependencies:
+    "@types/minimatch" "*"
+    "@types/node" "*"
+
+"@types/minimatch@*":
+  version "3.0.4"
+  resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.4.tgz#f0ec25dbf2f0e4b18647313ac031134ca5b24b21"
+  integrity sha512-1z8k4wzFnNjVK/tlxvrWuK5WMt6mydWWP7+zvH5eFep4oj+UkrfiJTRtjCeBXNpwaA/FYqqtb4/QS4ianFpIRA==
+
 "@types/mkdirp@^0.5.2":
   version "0.5.2"
   resolved "https://registry.yarnpkg.com/@types/mkdirp/-/mkdirp-0.5.2.tgz#503aacfe5cc2703d5484326b1b27efa67a339c1f"
@@ -516,6 +534,11 @@
   dependencies:
     "@types/node" "*"
 
+"@types/mocha@^7.0.2":
+  version "7.0.2"
+  resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-7.0.2.tgz#b17f16cf933597e10d6d78eae3251e692ce8b0ce"
+  integrity sha512-ZvO2tAcjmMi8V/5Z3JsyofMe3hasRcaw88cto5etSVMwVQfeivGAlEYmaQgceUSVYFofVjT+ioHsATjdWcFt1w==
+
 "@types/node-fetch@^2.5.5":
   version "2.5.10"
   resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.5.10.tgz#9b4d4a0425562f9fcea70b12cb3fcdd946ca8132"
@@ -553,6 +576,14 @@
   dependencies:
     "@types/node" "*"
 
+"@types/rimraf@^3.0.0":
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/@types/rimraf/-/rimraf-3.0.0.tgz#b9d03f090ece263671898d57bb7bb007023ac19f"
+  integrity sha512-7WhJ0MdpFgYQPXlF4Dx+DhgvlPCfz/x5mHaeDQAKhcenvQP1KCpLQ18JklAqeGMYSAT2PxLpzd0g2/HE7fj7hQ==
+  dependencies:
+    "@types/glob" "*"
+    "@types/node" "*"
+
 "@types/secp256k1@^4.0.1":
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/@types/secp256k1/-/secp256k1-4.0.2.tgz#20c29a87149d980f64464e56539bf4810fdb5d1d"

package.json

@@ -3,13 +3,15 @@
   "version": "1.0.0",
   "author": "Optimism PBC",
   "license": "MIT",
-  "workspaces": [
-    "packages/*",
-    "l2geth",
-    "integration-tests",
-    "specs",
-    "examples/*"
-  ],
+  "workspaces": {
+      "packages": [
+          "packages/*",
+          "l2geth",
+          "integration-tests",
+          "specs"
+      ],
+        "nohoist": ["examples/*"]
+  },
   "private": true,
   "devDependencies": {
     "lerna": "^4.0.0",

yarn.lock

@@ -817,21 +817,6 @@
   resolved "https://registry.yarnpkg.com/@ensdomains/resolver/-/resolver-0.2.4.tgz#c10fe28bf5efbf49bff4666d909aed0265efbc89"
   integrity sha512-bvaTH34PMCbv6anRa9I/0zjLJgY4EuznbEMgbV77JBCQ9KNC46rzi0avuxpOfu+xDjPEtSFGqVEOr5GlUSGudA==
 
-"@eth-optimism/solc@0.7.6-alpha.1":
-  version "0.7.6-alpha.1"
-  resolved "https://registry.yarnpkg.com/@eth-optimism/solc/-/solc-0.7.6-alpha.1.tgz#f503073161fdc0029dbc1dae6fae28eeb046b559"
-  integrity sha512-tVYeBtjwNRUDmaTdJNlKI0lTM0yV1hez0jPFOtACoepBwBEZOuuFLBgQLBOWPaR95UU2ke1YjqB7rrpkE3oRDg==
-  dependencies:
-    command-exists "^1.2.8"
-    commander "3.0.2"
-    follow-redirects "^1.12.1"
-    fs-extra "^0.30.0"
-    js-sha3 "0.8.0"
-    memorystream "^0.3.1"
-    require-from-string "^2.0.0"
-    semver "^5.5.0"
-    tmp "0.0.33"
-
 "@eth-optimism/solc@^0.6.12-alpha.1":
   version "0.6.12-alpha.1"
   resolved "https://registry.yarnpkg.com/@eth-optimism/solc/-/solc-0.6.12-alpha.1.tgz#041876f83b34c6afe2f19dfe9626568df6ed8590"
@@ -1022,7 +1007,7 @@
     "@ethersproject/properties" "^5.1.0"
     "@ethersproject/strings" "^5.1.0"
 
-"@ethersproject/abi@5.1.2", "@ethersproject/abi@^5.0.0-beta.146":
+"@ethersproject/abi@^5.0.0-beta.146":
   version "5.1.2"
   resolved "https://registry.yarnpkg.com/@ethersproject/abi/-/abi-5.1.2.tgz#a8e75cd0455e6dc9e4861c3d1c22bbe436c1d775"
   integrity sha512-uMhoQVPX0UtfzTpekYQSEUcJGDgsJ25ifz+SV6PDETWaUFhcR8RNgb1QPTASP13inW8r6iy0/Xdq9D5hK2pNvA==
@@ -1135,22 +1120,6 @@
     "@ethersproject/properties" "^5.1.0"
     "@ethersproject/transactions" "^5.1.0"
 
-"@ethersproject/contracts@5.1.1":
-  version "5.1.1"
-  resolved "https://registry.yarnpkg.com/@ethersproject/contracts/-/contracts-5.1.1.tgz#c66cb6d618fcbd73e20a6b808e8f768b2b781d0b"
-  integrity sha512-6WwktLJ0DFWU8pDkgH4IGttQHhQN4SnwKFu9h+QYVe48VGWtbDu4W8/q/7QA1u/HWlWMrKxqawPiZUJj0UMvOw==
-  dependencies:
-    "@ethersproject/abi" "^5.1.0"
-    "@ethersproject/abstract-provider" "^5.1.0"
-    "@ethersproject/abstract-signer" "^5.1.0"
-    "@ethersproject/address" "^5.1.0"
-    "@ethersproject/bignumber" "^5.1.0"
-    "@ethersproject/bytes" "^5.1.0"
-    "@ethersproject/constants" "^5.1.0"
-    "@ethersproject/logger" "^5.1.0"
-    "@ethersproject/properties" "^5.1.0"
-    "@ethersproject/transactions" "^5.1.0"
-
 "@ethersproject/hardware-wallets@^5.0.8":
   version "5.1.0"
   resolved "https://registry.yarnpkg.com/@ethersproject/hardware-wallets/-/hardware-wallets-5.1.0.tgz#588d318f7232e02eaf4fa64374002ef3f53842e7"
@@ -1274,31 +1243,6 @@
     bech32 "1.1.4"
     ws "7.2.3"
 
-"@ethersproject/providers@5.1.2":
-  version "5.1.2"
-  resolved "https://registry.yarnpkg.com/@ethersproject/providers/-/providers-5.1.2.tgz#4e4459698903f911402fe91aa7544eb07f3921ed"
-  integrity sha512-GqsS8rd+eyd4eNkcNgzZ4l9IRULBPUZa7JPnv22k4MHflMobUseyhfbVnmoN5bVNNkOxjV1IPTw9i0sV1hwdpg==
-  dependencies:
-    "@ethersproject/abstract-provider" "^5.1.0"
-    "@ethersproject/abstract-signer" "^5.1.0"
-    "@ethersproject/address" "^5.1.0"
-    "@ethersproject/basex" "^5.1.0"
-    "@ethersproject/bignumber" "^5.1.0"
-    "@ethersproject/bytes" "^5.1.0"
-    "@ethersproject/constants" "^5.1.0"
-    "@ethersproject/hash" "^5.1.0"
-    "@ethersproject/logger" "^5.1.0"
-    "@ethersproject/networks" "^5.1.0"
-    "@ethersproject/properties" "^5.1.0"
-    "@ethersproject/random" "^5.1.0"
-    "@ethersproject/rlp" "^5.1.0"
-    "@ethersproject/sha2" "^5.1.0"
-    "@ethersproject/strings" "^5.1.0"
-    "@ethersproject/transactions" "^5.1.0"
-    "@ethersproject/web" "^5.1.0"
-    bech32 "1.1.4"
-    ws "7.2.3"
-
 "@ethersproject/random@5.1.0", "@ethersproject/random@^5.0.0", "@ethersproject/random@^5.1.0":
   version "5.1.0"
   resolved "https://registry.yarnpkg.com/@ethersproject/random/-/random-5.1.0.tgz#0bdff2554df03ebc5f75689614f2d58ea0d9a71f"
@@ -1370,21 +1314,6 @@
     "@ethersproject/rlp" "^5.1.0"
     "@ethersproject/signing-key" "^5.1.0"
 
-"@ethersproject/transactions@5.1.1":
-  version "5.1.1"
-  resolved "https://registry.yarnpkg.com/@ethersproject/transactions/-/transactions-5.1.1.tgz#5a6bbb25fb062c3cc75eb0db12faefcdd3870813"
-  integrity sha512-Nwgbp09ttIVN0OoUBatCXaHxR7grWPHbozJN8v7AXDLrl6nnOIBEMDh+yJTnosSQlFhcyjfTGGN+Mx6R8HdvMw==
-  dependencies:
-    "@ethersproject/address" "^5.1.0"
-    "@ethersproject/bignumber" "^5.1.0"
-    "@ethersproject/bytes" "^5.1.0"
-    "@ethersproject/constants" "^5.1.0"
-    "@ethersproject/keccak256" "^5.1.0"
-    "@ethersproject/logger" "^5.1.0"
-    "@ethersproject/properties" "^5.1.0"
-    "@ethersproject/rlp" "^5.1.0"
-    "@ethersproject/signing-key" "^5.1.0"
-
 "@ethersproject/units@5.1.0", "@ethersproject/units@^5.0.0":
   version "5.1.0"
   resolved "https://registry.yarnpkg.com/@ethersproject/units/-/units-5.1.0.tgz#b6ab3430ebc22adc3cb4839516496f167bee3ad5"
@@ -6531,7 +6460,7 @@ chai-as-promised@^7.1.1:
   dependencies:
     check-error "^1.0.2"
 
-chai@4.3.4, chai@^4.2.0, chai@^4.3.0, chai@^4.3.1, chai@^4.3.3, chai@^4.3.4:
+chai@^4.2.0, chai@^4.3.0, chai@^4.3.1, chai@^4.3.3, chai@^4.3.4:
   version "4.3.4"
   resolved "https://registry.yarnpkg.com/chai/-/chai-4.3.4.tgz#b55e655b31e1eac7099be4c08c21964fce2e6c49"
   integrity sha512-yS5H68VYOCtN1cjfwumDSuzn/9c+yza4f3reKXlE5rUg7SFcCEy90gJvydNgOYtblyf4Zi6jIWRnXOgErta0KA==
@@ -8665,7 +8594,7 @@ ethereum-waffle@3.0.0:
     "@ethereum-waffle/provider" "^3.0.0"
     ethers "^5.0.1"
 
-ethereum-waffle@^3.0.0, ethereum-waffle@^3.3.0:
+ethereum-waffle@^3.3.0:
   version "3.3.0"
   resolved "https://registry.yarnpkg.com/ethereum-waffle/-/ethereum-waffle-3.3.0.tgz#166a0cc1d3b2925f117b20ef0951b3fe72e38e79"
   integrity sha512-4xm3RWAPCu5LlaVxYEg0tG3L7g5ovBw1GY/UebrzZ+OTx22vcPjI+bvelFlGBpkdnO5yOIFXjH2eK59tNAe9IA==
@@ -8997,42 +8926,6 @@ ethers@^5.0.0, ethers@^5.0.1, ethers@^5.0.2, ethers@^5.0.26, ethers@^5.0.31, eth
     "@ethersproject/web" "5.1.0"
     "@ethersproject/wordlists" "5.1.0"
 
-ethers@^5.1.4:
-  version "5.1.4"
-  resolved "https://registry.yarnpkg.com/ethers/-/ethers-5.1.4.tgz#8ae973705ed962f8f41dc59693704002a38dd18b"
-  integrity sha512-EAPQ/fgGRu0PoR/VNFnHTMOtG/IZ0AItdW55C9T8ffmVu0rnyllZL404eBF66elJehOLz2kxnUrhXpE7TCpW7g==
-  dependencies:
-    "@ethersproject/abi" "5.1.2"
-    "@ethersproject/abstract-provider" "5.1.0"
-    "@ethersproject/abstract-signer" "5.1.0"
-    "@ethersproject/address" "5.1.0"
-    "@ethersproject/base64" "5.1.0"
-    "@ethersproject/basex" "5.1.0"
-    "@ethersproject/bignumber" "5.1.1"
-    "@ethersproject/bytes" "5.1.0"
-    "@ethersproject/constants" "5.1.0"
-    "@ethersproject/contracts" "5.1.1"
-    "@ethersproject/hash" "5.1.0"
-    "@ethersproject/hdnode" "5.1.0"
-    "@ethersproject/json-wallets" "5.1.0"
-    "@ethersproject/keccak256" "5.1.0"
-    "@ethersproject/logger" "5.1.0"
-    "@ethersproject/networks" "5.1.0"
-    "@ethersproject/pbkdf2" "5.1.0"
-    "@ethersproject/properties" "5.1.0"
-    "@ethersproject/providers" "5.1.2"
-    "@ethersproject/random" "5.1.0"
-    "@ethersproject/rlp" "5.1.0"
-    "@ethersproject/sha2" "5.1.0"
-    "@ethersproject/signing-key" "5.1.0"
-    "@ethersproject/solidity" "5.1.0"
-    "@ethersproject/strings" "5.1.0"
-    "@ethersproject/transactions" "5.1.1"
-    "@ethersproject/units" "5.1.0"
-    "@ethersproject/wallet" "5.1.0"
-    "@ethersproject/web" "5.1.0"
-    "@ethersproject/wordlists" "5.1.0"
-
 ethjs-unit@0.1.6:
   version "0.1.6"
   resolved "https://registry.yarnpkg.com/ethjs-unit/-/ethjs-unit-0.1.6.tgz#c665921e476e87bce2a9d588a6fe0405b2c41699"
@@ -10485,32 +10378,6 @@ hardhat-deploy@^0.7.4:
     murmur-128 "^0.2.1"
     qs "^6.9.4"
 
-hardhat-deploy@^0.7.5:
-  version "0.7.5"
-  resolved "https://registry.yarnpkg.com/hardhat-deploy/-/hardhat-deploy-0.7.5.tgz#d31edcca709e9a8314efeaecb9a35792c295bc77"
-  integrity sha512-b+raIZBhrlw3lzkj7La8wyfczgxRsSWo8IHQM4STY4VUw0I/zjjeMm1naIvtGuebdrW/63ADLsucXZUZ8yVLkQ==
-  dependencies:
-    "@ethersproject/abi" "^5.0.0"
-    "@ethersproject/abstract-signer" "^5.0.0"
-    "@ethersproject/address" "^5.0.0"
-    "@ethersproject/bignumber" "^5.0.0"
-    "@ethersproject/bytes" "^5.0.0"
-    "@ethersproject/contracts" "^5.0.0"
-    "@ethersproject/providers" "^5.0.0"
-    "@ethersproject/solidity" "^5.0.0"
-    "@ethersproject/transactions" "^5.0.0"
-    "@ethersproject/wallet" "^5.0.0"
-    "@types/qs" "^6.9.4"
-    axios "^0.21.1"
-    chalk "^4.1.0"
-    chokidar "^3.4.0"
-    debug "^4.1.1"
-    form-data "^3.0.0"
-    fs-extra "^9.0.0"
-    match-all "^1.2.6"
-    murmur-128 "^0.2.1"
-    qs "^6.9.4"
-
 hardhat-gas-reporter@^1.0.4:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/hardhat-gas-reporter/-/hardhat-gas-reporter-1.0.4.tgz#59e3137e38e0dfeac2e4f90d5c74160b50ad4829"
@@ -10519,7 +10386,7 @@ hardhat-gas-reporter@^1.0.4:
     eth-gas-reporter "^0.2.20"
     sha1 "^1.1.1"
 
-hardhat@^2.2.0, hardhat@^2.2.1:
+hardhat@^2.2.1:
   version "2.2.1"
   resolved "https://registry.yarnpkg.com/hardhat/-/hardhat-2.2.1.tgz#bef0031b994e3f60a88d428f2097195c58cf9ed2"
   integrity sha512-8s7MtGXdh0NDwQKdlA8m8QdloVIN1+hv5aFpn0G5Ljj9vfNY9kUoc0a9pMboeGbd9WrS+XrZs5YlsPgQjaW/Tg==
@@ -13684,7 +13551,7 @@ mocha@^6.1.4:
     yargs-parser "13.1.2"
     yargs-unparser "1.6.0"
 
-mocha@^7.0.1, mocha@^7.1.1, mocha@^7.1.2:
+mocha@^7.1.1, mocha@^7.1.2:
   version "7.2.0"
   resolved "https://registry.yarnpkg.com/mocha/-/mocha-7.2.0.tgz#01cc227b00d875ab1eed03a75106689cfed5a604"
   integrity sha512-O9CIypScywTVpNaRrCAgoUnJgozpIofjKUYmJhiCIJMiuYnLI6otcb1/kpW9/n/tJODHGZ7i8aLQoDVsMtOKQQ==
@@ -13714,7 +13581,7 @@ mocha@^7.0.1, mocha@^7.1.1, mocha@^7.1.2:
     yargs-parser "13.1.2"
     yargs-unparser "1.6.0"
 
-mocha@^8.2.1, mocha@^8.3.0, mocha@^8.3.1, mocha@^8.3.2:
+mocha@^8.3.0, mocha@^8.3.1, mocha@^8.3.2:
   version "8.3.2"
   resolved "https://registry.yarnpkg.com/mocha/-/mocha-8.3.2.tgz#53406f195fa86fbdebe71f8b1c6fb23221d69fcc"
   integrity sha512-UdmISwr/5w+uXLPKspgoV7/RXZwKRTiTjJ2/AC5ZiEztIoOYdfKb19+9jNmEInzx5pBsCyJQzarAxqIGBNYJhg==
@@ -17414,21 +17281,6 @@ solc@0.7.3:
     semver "^5.5.0"
     tmp "0.0.33"
 
-solc@0.7.6:
-  version "0.7.6"
-  resolved "https://registry.yarnpkg.com/solc/-/solc-0.7.6.tgz#21fc5dc11b85fcc518c181578b454f3271c27252"
-  integrity sha512-WsR/W7CXwh2VnmZapB4JrsDeLlshoKBz5Pz/zYNulB6LBsOEHI2Zj/GeKLMFcvv57OHiXHvxq5ZOQB+EdqxlxQ==
-  dependencies:
-    command-exists "^1.2.8"
-    commander "3.0.2"
-    follow-redirects "^1.12.1"
-    fs-extra "^0.30.0"
-    js-sha3 "0.8.0"
-    memorystream "^0.3.1"
-    require-from-string "^2.0.0"
-    semver "^5.5.0"
-    tmp "0.0.33"
-
 solc@^0.4.20:
   version "0.4.26"
   resolved "https://registry.yarnpkg.com/solc/-/solc-0.4.26.tgz#5390a62a99f40806b86258c737c1cf653cc35cb5"