feat[message-relayer]: relay tx generator (#952)

* feat[message-relayer]: relay tx generator

* whoops, I burned our infura key

* fix minor bug

* add comments

* add more comments and clean stuff up

* add empty test descriptions

* add tests

* move smock to dev deps

* chore: add changeset

* minor cleanup to merkle tree proof function

* use bignumber math to avoid nested await

* use a better interface

* minor fixes and simplifications

.changeset/sharp-files-knock.md

+---
+'@eth-optimism/message-relayer': patch
+---
+
+Adds a new set of tools for generating messages to be relayed and their proofs

packages/message-relayer/hardhat.config.ts

+import { HardhatUserConfig } from 'hardhat/config'
+
+import '@nomiclabs/hardhat-ethers'
+import '@nomiclabs/hardhat-waffle'
+
+const config: HardhatUserConfig = {
+  paths: {
+    sources: './test/test-contracts',
+  },
+  solidity: {
+    version: '0.7.6',
+  },
+}
+
+export default config

packages/message-relayer/package.json

@@ -14,7 +14,8 @@
     "clean": "rimraf  dist/ ./tsconfig.build.tsbuildinfo",
     "lint": "yarn lint:fix && yarn lint:check",
     "lint:fix": "prettier --config .prettierrc.json --write \"{src,exec,test}/**/*.ts\"",
-    "lint:check": "tslint --format stylish --project ."
+    "lint:check": "tslint --format stylish --project .",
+    "test": "hardhat test --show-stack-traces"
   },
   "keywords": [
     "optimism",
@@ -30,9 +31,9 @@
   },
   "dependencies": {
     "@eth-optimism/common-ts": "^0.1.2",
-    "bcfg": "^0.1.6",
     "@eth-optimism/contracts": "^0.3.3",
     "@eth-optimism/core-utils": "^0.4.3",
+    "bcfg": "^0.1.6",
     "dotenv": "^8.2.0",
     "ethers": "^5.1.0",
     "google-spreadsheet": "^3.1.15",
@@ -40,6 +41,18 @@
     "rlp": "^2.2.6"
   },
   "devDependencies": {
+    "@eth-optimism/smock": "^1.1.4",
+    "@nomiclabs/hardhat-ethers": "^2.0.2",
+    "@nomiclabs/hardhat-waffle": "^2.0.1",
+    "@types/chai": "^4.2.18",
+    "@types/chai-as-promised": "^7.1.4",
+    "@types/mocha": "^8.2.2",
+    "chai": "^4.3.4",
+    "chai-as-promised": "^7.1.1",
+    "ethereum-waffle": "^3.3.0",
+    "hardhat": "^2.3.0",
+    "lodash": "^4.17.21",
+    "mocha": "^8.4.0",
     "prettier": "^2.2.1",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",

packages/message-relayer/src/index.ts

+export * from './relay-tx'

packages/message-relayer/test/setup.ts

+/* External Imports */
+import chai = require('chai')
+import Mocha from 'mocha'
+import { solidity } from 'ethereum-waffle'
+import chaiAsPromised from 'chai-as-promised'
+
+chai.use(solidity)
+chai.use(chaiAsPromised)
+const should = chai.should()
+const expect = chai.expect
+
+export { should, expect, Mocha }

packages/message-relayer/test/test-contracts/MockL2CrossDomainMessenger.sol

+// SPDX-License-Identifier: MIT
+pragma solidity >0.7.0 <0.9.0;
+pragma experimental ABIEncoderV2;
+
+contract MockL2CrossDomainMessenger {
+    struct MessageData {
+        address target;
+        address sender;
+        bytes message;
+        uint256 messageNonce;
+    }
+
+    event SentMessage(bytes message);
+
+    function emitSentMessageEvent(
+        MessageData memory _message
+    )
+        public
+    {
+        emit SentMessage(
+            abi.encodeWithSignature(
+                "relayMessage(address,address,bytes,uint256)",
+                _message.target,
+                _message.sender,
+                _message.message,
+                _message.messageNonce
+            )
+        );
+    }
+
+    function emitMultipleSentMessageEvents(
+        MessageData[] memory _messages
+    )
+        public
+    {
+        for (uint256 i = 0; i < _messages.length; i++) {
+            emitSentMessageEvent(
+                _messages[i]
+            );
+        }
+    }
+
+    function doNothing() public {}
+}

yarn.lock

@@ -2248,6 +2248,13 @@
   dependencies:
     "@types/chai" "*"
 
+"@types/chai-as-promised@^7.1.4":
+  version "7.1.4"
+  resolved "https://registry.yarnpkg.com/@types/chai-as-promised/-/chai-as-promised-7.1.4.tgz#caf64e76fb056b8c8ced4b761ed499272b737601"
+  integrity sha512-1y3L1cHePcIm5vXkh1DSGf/zQq5n5xDKG1fpCvf18+uOkpce0Z1ozNFPkyWsVswK7ntN1sZBw3oU6gmN+pDUcA==
+  dependencies:
+    "@types/chai" "*"
+
 "@types/chai@*", "@types/chai@^4.1.7":
   version "4.2.16"
   resolved "https://registry.yarnpkg.com/@types/chai/-/chai-4.2.16.tgz#f09cc36e18d28274f942e7201147cce34d97e8c8"
@@ -7178,6 +7185,57 @@ hardhat@^2.2.1:
     uuid "^3.3.2"
     ws "^7.2.1"
 
+hardhat@^2.3.0:
+  version "2.3.0"
+  resolved "https://registry.yarnpkg.com/hardhat/-/hardhat-2.3.0.tgz#5c29f8b4d08155c3dc8c908af9713fd5079522d5"
+  integrity sha512-nc4ro2bM4wPaA6/0Y22o5F5QrifQk2KCyPUUKLPUeFFZoGNGYB8vmeW/k9gV9DdMukdWTzfYlKc2Jn4bfb6tDQ==
+  dependencies:
+    "@ethereumjs/block" "^3.2.1"
+    "@ethereumjs/blockchain" "^5.2.1"
+    "@ethereumjs/common" "^2.2.0"
+    "@ethereumjs/tx" "^3.1.3"
+    "@ethereumjs/vm" "^5.3.2"
+    "@sentry/node" "^5.18.1"
+    "@solidity-parser/parser" "^0.11.0"
+    "@types/bn.js" "^5.1.0"
+    "@types/lru-cache" "^5.1.0"
+    abort-controller "^3.0.0"
+    adm-zip "^0.4.16"
+    ansi-escapes "^4.3.0"
+    chalk "^2.4.2"
+    chokidar "^3.4.0"
+    ci-info "^2.0.0"
+    debug "^4.1.1"
+    enquirer "^2.3.0"
+    env-paths "^2.2.0"
+    eth-sig-util "^2.5.2"
+    ethereum-cryptography "^0.1.2"
+    ethereumjs-abi "^0.6.8"
+    ethereumjs-util "^7.0.10"
+    find-up "^2.1.0"
+    fp-ts "1.19.3"
+    fs-extra "^7.0.1"
+    glob "^7.1.3"
+    immutable "^4.0.0-rc.12"
+    io-ts "1.10.4"
+    lodash "^4.17.11"
+    merkle-patricia-tree "^4.1.0"
+    mnemonist "^0.38.0"
+    mocha "^7.1.2"
+    node-fetch "^2.6.0"
+    qs "^6.7.0"
+    raw-body "^2.4.1"
+    resolve "1.17.0"
+    semver "^6.3.0"
+    slash "^3.0.0"
+    solc "0.7.3"
+    source-map-support "^0.5.13"
+    stacktrace-parser "^0.1.10"
+    "true-case-path" "^2.2.1"
+    tsort "0.0.1"
+    uuid "^3.3.2"
+    ws "^7.2.1"
+
 has-ansi@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/has-ansi/-/has-ansi-2.0.0.tgz#34f5049ce1ecdf2b0649af3ef24e45ed35416d91"