Merge pull request #1897 from ethereum-optimism/develop

Develop -> Master Release PR

.changeset/bright-lobsters-press.md

+---
+'@eth-optimism/integration-tests': patch
+---
+
+Remove sync-tests as coverage lives in itests now

.changeset/famous-sheep-bathe.md

+---
+'@eth-optimism/contracts': patch
+---
+
+Add config checks to validation script

.changeset/five-pandas-reflect.md

+---
+'@eth-optimism/contracts': patch
+---
+
+Copy the deployments directory into the deployer docker image

.changeset/odd-crews-approve.md

+---
+'@eth-optimism/proxyd': minor
+---
+
+Allows string RPC ids on proxyd

.changeset/pretty-dogs-hope.md

+---
+'@eth-optimism/integration-tests': patch
+---
+
+Enforce fees in docker-compose setup and test cases for fee too low and fee too high

.changeset/rich-suits-drive.md

+---
+'@eth-optimism/hardhat-node': patch
+---
+
+Add fork mode config to ethereumoptimism/hardhat docker image

.changeset/rotten-hornets-call.md

+---
+'@eth-optimism/integration-tests': patch
+---
+
+Pass through starting block height to dtl

.changeset/six-shrimps-flash.md

+---
+'@eth-optimism/op-exporter': patch
+---
+
+Cleanup op-exporter CI, renamed package

.changeset/unlucky-drinks-laugh.md

+---
+'@eth-optimism/hardhat-node': patch
+---
+
+Update to hardhat@2.7.0

.github/workflows/publish-canary.yml

@@ -27,6 +27,7 @@ jobs:
       canary-docker-tag: ${{ steps.docker-image-name.outputs.canary-docker-tag }}
       proxyd: ${{ steps.packages.outputs.proxyd }}
       rpc-proxy : ${{ steps.packages.outputs.rpc-proxy }}
+      op-exporter : ${{ steps.packages.outputs.op-exporter }}
 
     steps:
       - name: Check out source code
@@ -405,6 +406,43 @@ jobs:
             GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
             GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
 
+  op-exporter:
+    name: Publish op-exporter Version ${{ needs.canary-publish.outputs.canary-docker-tag }}
+    needs: canary-publish
+    if: needs.canary-publish.outputs.op-exporter != ''
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_SECRET }}
+
+      - name: Set build args
+        id: build_args
+        run: |
+          echo ::set-output name=GITDATE::"$(date +%d-%m-%Y)"
+          echo ::set-output name=GITVERSION::$(jq -r .version ./go/op-exporter/package.json)
+          echo ::set-output name=GITCOMMIT::"$GITHUB_SHA"
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./ops/docker/Dockerfile.op-exporter
+          push: true
+          tags: ethereumoptimism/op-exporter:${{ needs.canary-publish.outputs.op-exporter }}
+          build-args: |
+            GITDATE=${{ steps.build_args.outputs.GITDATE }}
+            GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
+            GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
+
   rpc-proxy:
     name: Publish rpc-proxy Version ${{ needs.canary-publish.outputs.canary-docker-tag }}
     needs: canary-publish

.github/workflows/release.yml

@@ -23,6 +23,7 @@ jobs:
       proxyd: ${{ steps.packages.outputs.proxyd }}
       rpc-proxy: ${{ steps.packages.outputs.rpc-proxy }}
       hardhat-node: ${{ steps.packages.outputs.hardhat-node }}
+      op-exporter : ${{ steps.packages.outputs.op-exporter }}
 
     steps:
       - name: Checkout Repo
@@ -98,14 +99,6 @@ jobs:
           push: true
           tags: ethereumoptimism/l2geth:${{ needs.release.outputs.l2geth }},ethereumoptimism/l2geth:latest
 
-      - name: Publish op_exporter
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./ops/docker/Dockerfile.op_exporter
-          push: true
-          tags: ethereumoptimism/op_exporter:${{ needs.release.outputs.l2geth }}
-
       - name: Publish rpc-proxy
         uses: docker/build-push-action@v2
         with:
@@ -203,6 +196,43 @@ jobs:
             GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
             GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
 
+  op-exporter:
+    name: Publish op-exporter Version ${{ needs.release.outputs.canary-docker-tag }}
+    needs: release
+    if: needs.release.outputs.op-exporter != ''
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_SECRET }}
+
+      - name: Set build args
+        id: build_args
+        run: |
+          echo ::set-output name=GITDATE::"$(date +%d-%m-%Y)"
+          echo ::set-output name=GITVERSION::$(jq -r .version ./go/op-exporter/package.json)
+          echo ::set-output name=GITCOMMIT::"$GITHUB_SHA"
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./ops/docker/Dockerfile.op-exporter
+          push: true
+          tags: ethereumoptimism/op-exporter:${{ needs.canary-publish.outputs.op-exporter }}
+          build-args: |
+            GITDATE=${{ steps.build_args.outputs.GITDATE }}
+            GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
+            GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
+
   rpc-proxy:
     name: Publish rpc-proxy Version ${{ needs.release.outputs.rpc-proxy }}
     needs: release

go/op_exporter/go.mod → go/op-exporter/go.mod

-module github.com/ethereum-optimism/optimism/go/op_exporter
+module github.com/ethereum-optimism/optimism/go/op-exporter
 
 go 1.16
 
 require (
+	github.com/ethereum-optimism/optimism/go/op_exporter v0.0.0-20211207210647-c5a8db939ad4
 	github.com/ethereum/go-ethereum v1.10.4
 	github.com/prometheus/client_golang v1.4.0
 	github.com/sirupsen/logrus v1.4.2
 	github.com/ybbus/jsonrpc v2.1.2+incompatible
 	gopkg.in/alecthomas/kingpin.v2 v2.2.6
-	k8s.io/apimachinery v0.21.2 // indirect
+	k8s.io/apimachinery v0.21.2
 	k8s.io/client-go v0.21.2
 )

go/op_exporter/go.sum → go/op-exporter/go.sum

@@ -124,6 +124,8 @@ github.com/elazarl/goproxy v0.0.0-20180725130230-947c36da3153/go.mod h1:/Zj4wYkg
 github.com/emicklei/go-restful v0.0.0-20170410110728-ff4f55a20633/go.mod h1:otzb+WCGbkyDHkqmQmT5YD2WR4BBwUdeQoFo8l/7tVs=
 github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
+github.com/ethereum-optimism/optimism/go/op_exporter v0.0.0-20211207210647-c5a8db939ad4 h1:tTFuDWKAWayPWkqWd8CPwSfDoO4tMVScZgM5nhXs2+c=
+github.com/ethereum-optimism/optimism/go/op_exporter v0.0.0-20211207210647-c5a8db939ad4/go.mod h1:w2HqYJpeDcqB6ZpPDsD7NmkvJCDAs23uNW7YHTn4g0M=
 github.com/ethereum/go-ethereum v1.10.4 h1:JPZPL2MHbegfFStcaOrrggMVIcf57OQHQ0J3UhjQ+xQ=
 github.com/ethereum/go-ethereum v1.10.4/go.mod h1:nEE0TP5MtxGzOMd7egIrbPJMQBnhVU3ELNxhBglIzhg=
 github.com/evanphx/json-patch v4.9.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
@@ -276,6 +278,7 @@ github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfn
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/pty v1.1.5/go.mod h1:9r2w37qlBe7rQ6e1fg1S/9xpWHSnaqNdHD3WcMdbPDA=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
 github.com/leanovate/gopter v0.2.9/go.mod h1:U2L/78B+KVFIx2VmW6onHJQzXtFb+p5y3y2Sh+Jxxv8=
@@ -308,6 +311,7 @@ github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRW
 github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f/go.mod h1:ZdcZmHo+o7JKHSa8/e818NopupXU1YMK5fe1lsApnBw=
 github.com/naoina/go-stringutil v0.1.0/go.mod h1:XJ2SJL9jCtBh+P9q5btrd/Ylo8XwT/h1USek5+NqSA0=
 github.com/naoina/toml v0.1.2-0.20170918210437-9fafd6967416/go.mod h1:NBIhNtsFMo3G2szEBne+bO4gS192HuIYRqfvOWb4i1E=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
 github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
@@ -322,6 +326,7 @@ github.com/onsi/gomega v0.0.0-20170829124025-dcabb60a477c/go.mod h1:C1qb7wdrVGGV
 github.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY=
 github.com/onsi/gomega v1.7.0/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY=
 github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY=
+github.com/onsi/gomega v1.10.1 h1:o0+MgICZLuZ7xjH7Vx6zS/zcu93/BEp1VwkIW1mEXCE=
 github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo=
 github.com/opentracing/opentracing-go v1.0.2/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
 github.com/opentracing/opentracing-go v1.0.3-0.20180606204148-bd9c31933947/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
@@ -336,6 +341,7 @@ github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINE
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/term v0.0.0-20180730021639-bffc007b7fd5/go.mod h1:eCbImbZ95eXtAUIbLAuAVnBnwf83mjf6QIVH8SHYwqQ=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
 github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo=
@@ -377,6 +383,7 @@ github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkU
 github.com/spf13/cobra v0.0.3/go.mod h1:1l0Ry5zgKvJasoi3XT1TypsSe7PqH0Sj9dhYf7v3XqQ=
 github.com/spf13/pflag v0.0.0-20170130214245-9ff6c6923cff/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
 github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/status-im/keycard-go v0.0.0-20190316090335-8537d3370df4/go.mod h1:RZLeN1LMWmRsyYjvAu+I6Dm9QmlDaIIt+Y+4Kd7Tp+Q=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
@@ -387,6 +394,7 @@ github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXf
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/syndtr/goleveldb v1.0.1-0.20210305035536-64b5b1c73954/go.mod h1:u2MKkTVTVJWe5D1rCvame8WqhBd88EuIwODJZ1VHCPM=
 github.com/tinylib/msgp v1.0.2/go.mod h1:+d+yLhGm8mzTaHzB+wgMYrodPfmZrzkirds8fDWklFE=
@@ -536,7 +544,6 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210316164454-77fc1eacc6aa/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210324051608-47abb6519492/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.0.0-20210420205809-ac73e9fd8988 h1:EjgCl+fVlIaPJSori0ikSz3uV0DOHKWOJFpv1sAAhBM=
 golang.org/x/sys v0.0.0-20210420205809-ac73e9fd8988/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210426230700-d19ff857e887 h1:dXfMednGJh/SUUFjTLsWJz3P+TQt9qnR11GgeI3vWKs=
 golang.org/x/sys v0.0.0-20210426230700-d19ff857e887/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
@@ -599,6 +606,7 @@ golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gonum.org/v1/gonum v0.0.0-20180816165407-929014505bf4/go.mod h1:Y+Yx5eoAFn32cQvJDxZx5Dpnq+c3wtXuadVZAcxbbBo=
 gonum.org/v1/gonum v0.0.0-20181121035319-3f7ecaa7e8ca/go.mod h1:Y+Yx5eoAFn32cQvJDxZx5Dpnq+c3wtXuadVZAcxbbBo=
@@ -656,7 +664,6 @@ google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQ
 google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE=
 google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
 google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
-google.golang.org/protobuf v1.23.0 h1:4MY060fB1DLGMB/7MBTLnwQUY6+F09GEiz6SsrNqyzM=
 google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
 google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
 google.golang.org/protobuf v1.25.0 h1:Ejskq+SyPohKW+1uil0JJMtmHCgJPJ/qWTxr8qp+R4c=
@@ -666,6 +673,7 @@ gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLks
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
 gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
@@ -684,6 +692,7 @@ gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

go/op-exporter/package.json

+{
+  "name": "@eth-optimism/op-exporter",
+  "version": "0.5.0",
+  "private": true,
+  "devDependencies": {}
+}

go/proxyd/backend.go

@@ -25,11 +25,6 @@ const (
 )
 
 var (
-	ErrInvalidRequest = &RPCErr{
-		Code:          -32601,
-		Message:       "invalid request",
-		HTTPErrorCode: 400,
-	}
 	ErrParseErr = &RPCErr{
 		Code:          -32700,
 		Message:       "parse error",
@@ -67,6 +62,14 @@ var (
 	}
 )
 
+func ErrInvalidRequest(msg string) *RPCErr {
+	return &RPCErr{
+		Code:          -32601,
+		Message:       msg,
+		HTTPErrorCode: 400,
+	}
+}
+
 type Backend struct {
 	Name                 string
 	rpcURL               string
@@ -498,7 +501,7 @@ func (w *WSProxier) clientPump(ctx context.Context, errC chan error) {
 		// just handle them here.
 		req, err := w.prepareClientMsg(msg)
 		if err != nil {
-			var id *int
+			var id json.RawMessage
 			method := MethodUnknown
 			if req != nil {
 				id = req.ID
@@ -555,7 +558,7 @@ func (w *WSProxier) backendPump(ctx context.Context, errC chan error) {
 
 		res, err := w.parseBackendMsg(msg)
 		if err != nil {
-			var id *int
+			var id json.RawMessage
 			if res != nil {
 				id = res.ID
 			}

go/proxyd/rpc.go

@@ -4,20 +4,21 @@ import (
 	"encoding/json"
 	"io"
 	"io/ioutil"
+	"strings"
 )
 
 type RPCReq struct {
 	JSONRPC string          `json:"jsonrpc"`
 	Method  string          `json:"method"`
 	Params  json.RawMessage `json:"params"`
-	ID      *int            `json:"id"`
+	ID      json.RawMessage `json:"id"`
 }
 
 type RPCRes struct {
-	JSONRPC string      `json:"jsonrpc"`
-	Result  interface{} `json:"result,omitempty"`
-	Error   *RPCErr     `json:"error,omitempty"`
-	ID      *int        `json:"id"`
+	JSONRPC string          `json:"jsonrpc"`
+	Result  interface{}     `json:"result,omitempty"`
+	Error   *RPCErr         `json:"error,omitempty"`
+	ID      json.RawMessage `json:"id"`
 }
 
 func (r *RPCRes) IsError() bool {
@@ -34,6 +35,17 @@ func (r *RPCErr) Error() string {
 	return r.Message
 }
 
+func IsValidID(id json.RawMessage) bool {
+	// handle the case where the ID is a string
+	if strings.HasPrefix(string(id), "\"") && strings.HasSuffix(string(id), "\"") {
+		return len(id) > 2
+	}
+
+	// technically allows a boolean/null ID, but so does Geth
+	// https://github.com/ethereum/go-ethereum/blob/master/rpc/json.go#L72
+	return len(id) > 0 && id[0] != '{' && id[0] != '['
+}
+
 func ParseRPCReq(r io.Reader) (*RPCReq, error) {
 	body, err := ioutil.ReadAll(r)
 	if err != nil {
@@ -46,11 +58,15 @@ func ParseRPCReq(r io.Reader) (*RPCReq, error) {
 	}
 
 	if req.JSONRPC != JSONRPCVersion {
-		return nil, ErrInvalidRequest
+		return nil, ErrInvalidRequest("invalid JSON-RPC version")
 	}
 
 	if req.Method == "" {
-		return nil, ErrInvalidRequest
+		return nil, ErrInvalidRequest("no method specified")
+	}
+
+	if !IsValidID(req.ID) {
+		return nil, ErrInvalidRequest("invalid ID")
 	}
 
 	return req, nil
@@ -70,7 +86,7 @@ func ParseRPCRes(r io.Reader) (*RPCRes, error) {
 	return res, nil
 }
 
-func NewRPCErrorRes(id *int, err error) *RPCRes {
+func NewRPCErrorRes(id json.RawMessage, err error) *RPCRes {
 	var rpcErr *RPCErr
 	if rr, ok := err.(*RPCErr); ok {
 		rpcErr = rr

go/proxyd/server.go

@@ -232,7 +232,7 @@ func (s *Server) populateContext(w http.ResponseWriter, r *http.Request) context
 	)
 }
 
-func writeRPCError(w http.ResponseWriter, id *int, err error) {
+func writeRPCError(w http.ResponseWriter, id json.RawMessage, err error) {
 	var res *RPCRes
 	if r, ok := err.(*RPCErr); ok {
 		res = NewRPCErrorRes(id, r)

integration-tests/package.json

@@ -11,7 +11,6 @@
     "test:integration": "hardhat --network optimism test",
     "test:actor": "IS_LIVE_NETWORK=true ts-node actor-tests/lib/runner.ts",
     "test:integration:live": "NO_NETWORK=true IS_LIVE_NETWORK=true hardhat --network optimism test",
-    "test:sync": "hardhat --network optimism test sync-tests/*.spec.ts --no-compile",
     "clean": "rimraf cache artifacts",
     "pre-commit": "lint-staged"
   },

integration-tests/sync-tests/1-sync-verifier.spec.ts

-import { expect } from 'chai'
-import { Wallet, BigNumber, providers } from 'ethers'
-import { injectL2Context } from '@eth-optimism/core-utils'
-
-import {
-  sleep,
-  l2Provider,
-  verifierProvider,
-  waitForL2Geth,
-} from '../test/shared/utils'
-import { OptimismEnv } from '../test/shared/env'
-import { DockerComposeNetwork } from '../test/shared/docker-compose'
-
-describe('Syncing a verifier', () => {
-  let env: OptimismEnv
-  let wallet: Wallet
-  let verifier: DockerComposeNetwork
-  let provider: providers.JsonRpcProvider
-
-  const sequencerProvider = injectL2Context(l2Provider)
-
-  /* Helper functions */
-
-  const waitForBatchSubmission = async (
-    totalElementsBefore: BigNumber
-  ): Promise<BigNumber> => {
-    // Wait for batch submission to happen by watching the CTC
-    let totalElementsAfter = (await env.ctc.getTotalElements()) as BigNumber
-    while (totalElementsBefore.eq(totalElementsAfter)) {
-      await sleep(500)
-      totalElementsAfter = (await env.ctc.getTotalElements()) as BigNumber
-    }
-    return totalElementsAfter
-  }
-
-  const startVerifier = async () => {
-    // Bring up new verifier
-    verifier = new DockerComposeNetwork(['verifier'])
-    await verifier.up({ commandOptions: ['--scale', 'verifier=1'] })
-
-    provider = await waitForL2Geth(verifierProvider)
-  }
-
-  const syncVerifier = async (sequencerBlockNumber: number) => {
-    // Wait until verifier has caught up to the sequencer
-    let latestVerifierBlock = (await provider.getBlock('latest')) as any
-    while (latestVerifierBlock.number < sequencerBlockNumber) {
-      await sleep(500)
-      latestVerifierBlock = (await provider.getBlock('latest')) as any
-    }
-
-    return provider.getBlock(sequencerBlockNumber)
-  }
-
-  before(async () => {
-    env = await OptimismEnv.new()
-    wallet = env.l2Wallet
-  })
-
-  describe('Basic transactions', () => {
-    after(async () => {
-      await verifier.stop('verifier')
-      await verifier.rm()
-    })
-
-    it('should sync dummy transaction', async () => {
-      const totalElementsBefore =
-        (await env.ctc.getTotalElements()) as BigNumber
-
-      const tx = {
-        to: '0x' + '1234'.repeat(10),
-        gasLimit: 4000000,
-        gasPrice: 0,
-        data: '0x',
-        value: 0,
-      }
-      const result = await wallet.sendTransaction(tx)
-      await result.wait()
-
-      const totalElementsAfter = await waitForBatchSubmission(
-        totalElementsBefore
-      )
-      expect(totalElementsAfter.gt(totalElementsAfter))
-
-      const latestSequencerBlock = (await sequencerProvider.getBlock(
-        'latest'
-      )) as any
-
-      await startVerifier()
-
-      const matchingVerifierBlock = (await syncVerifier(
-        latestSequencerBlock.number
-      )) as any
-
-      expect(matchingVerifierBlock.stateRoot).to.eq(
-        latestSequencerBlock.stateRoot
-      )
-    })
-
-    it('should have matching block data', async () => {
-      const sequencerTip = await sequencerProvider.getBlock('latest')
-      const verifierTip = await provider.getBlock('latest')
-
-      expect(sequencerTip.number).to.deep.eq(verifierTip.number)
-      expect(sequencerTip.hash).to.deep.eq(verifierTip.hash)
-    })
-  })
-})

integration-tests/sync-tests/2-sync-replica.spec.ts

-import { expect } from 'chai'
-import { Wallet, Contract, ContractFactory, providers } from 'ethers'
-import { ethers } from 'hardhat'
-import { injectL2Context } from '@eth-optimism/core-utils'
-
-import {
-  sleep,
-  l2Provider,
-  replicaProvider,
-  waitForL2Geth,
-} from '../test/shared/utils'
-import { OptimismEnv } from '../test/shared/env'
-import { DockerComposeNetwork } from '../test/shared/docker-compose'
-
-describe('Syncing a replica', () => {
-  let env: OptimismEnv
-  let wallet: Wallet
-  let replica: DockerComposeNetwork
-  let provider: providers.JsonRpcProvider
-
-  const sequencerProvider = injectL2Context(l2Provider)
-
-  /* Helper functions */
-
-  const startReplica = async () => {
-    // Bring up new replica
-    replica = new DockerComposeNetwork(['replica'])
-    await replica.up({
-      commandOptions: ['--scale', 'replica=1'],
-    })
-
-    provider = await waitForL2Geth(replicaProvider)
-  }
-
-  const syncReplica = async (sequencerBlockNumber: number) => {
-    // Wait until replica has caught up to the sequencer
-    let latestReplicaBlock = (await provider.getBlock('latest')) as any
-    while (latestReplicaBlock.number < sequencerBlockNumber) {
-      await sleep(500)
-      latestReplicaBlock = (await provider.getBlock('latest')) as any
-    }
-
-    return provider.getBlock(sequencerBlockNumber)
-  }
-
-  before(async () => {
-    env = await OptimismEnv.new()
-    wallet = env.l2Wallet
-  })
-
-  after(async () => {
-    await replica.stop('replica')
-    await replica.rm()
-  })
-
-  describe('Basic transactions and ERC20s', () => {
-    const initialAmount = 1000
-    const tokenName = 'OVM Test'
-    const tokenDecimals = 8
-    const TokenSymbol = 'OVM'
-
-    let other: Wallet
-    let Factory__ERC20: ContractFactory
-    let ERC20: Contract
-
-    before(async () => {
-      other = Wallet.createRandom().connect(ethers.provider)
-      Factory__ERC20 = await ethers.getContractFactory('ERC20', wallet)
-    })
-
-    it('should sync dummy transaction', async () => {
-      const tx = {
-        to: '0x' + '1234'.repeat(10),
-        gasLimit: 4000000,
-        gasPrice: 0,
-        data: '0x',
-        value: 0,
-      }
-      const result = await wallet.sendTransaction(tx)
-      await result.wait()
-
-      const latestSequencerBlock = (await sequencerProvider.getBlock(
-        'latest'
-      )) as any
-
-      await startReplica()
-
-      const matchingReplicaBlock = (await syncReplica(
-        latestSequencerBlock.number
-      )) as any
-
-      expect(matchingReplicaBlock.stateRoot).to.eq(
-        latestSequencerBlock.stateRoot
-      )
-    })
-
-    it('should sync ERC20 deployment and transfer', async () => {
-      ERC20 = await Factory__ERC20.deploy(
-        initialAmount,
-        tokenName,
-        tokenDecimals,
-        TokenSymbol
-      )
-
-      const transfer = await ERC20.transfer(other.address, 100)
-      await transfer.wait()
-
-      const latestSequencerBlock = (await provider.getBlock('latest')) as any
-
-      const matchingReplicaBlock = (await syncReplica(
-        latestSequencerBlock.number
-      )) as any
-
-      expect(matchingReplicaBlock.stateRoot).to.eq(
-        latestSequencerBlock.stateRoot
-      )
-    })
-  })
-})

integration-tests/test/fee-payment.spec.ts

@@ -8,7 +8,7 @@ import { serialize } from '@ethersproject/transactions'
 import { predeploys, getContractFactory } from '@eth-optimism/contracts'
 
 /* Imports: Internal */
-import { gasPriceForL2, isLiveNetwork } from './shared/utils'
+import { isLiveNetwork } from './shared/utils'
 import { OptimismEnv } from './shared/env'
 import { Direction } from './shared/watcher-utils'
 
@@ -173,10 +173,7 @@ describe('Fee Payment Integration Tests', async () => {
       env.sequencerFeeVault.address
     )
 
-    // Submit the withdrawal.
-    const withdrawTx = await env.sequencerFeeVault.withdraw({
-      gasPrice: await gasPriceForL2(env), // Will be zero on HH
-    })
+    const withdrawTx = await env.sequencerFeeVault.withdraw()
 
     // Wait for the withdrawal to be relayed to L1.
     await withdrawTx.wait()

integration-tests/test/rpc.spec.ts

@@ -140,6 +140,45 @@ describe('Basic RPC tests', () => {
         'gas required exceeds allowance'
       )
     })
+
+    it('should reject a transaction with too low of a fee', async () => {
+      if (isLiveNetwork()) {
+        console.log('Skipping too low of a fee test on live network')
+        return
+      }
+
+      const gasPrice = await env.gasPriceOracle.gasPrice()
+      await env.gasPriceOracle.setGasPrice(1000)
+
+      const tx = {
+        ...defaultTransactionFactory(),
+        gasPrice: 1,
+      }
+
+      await expect(env.l2Wallet.sendTransaction(tx)).to.be.rejectedWith(
+        `gas price too low: 1 wei, use at least tx.gasPrice = 1000 wei`
+      )
+      // Reset the gas price to its original price
+      await env.gasPriceOracle.setGasPrice(gasPrice)
+    })
+
+    it('should reject a transaction with too high of a fee', async () => {
+      if (isLiveNetwork()) {
+        console.log('Skpping too high of a fee test on live network')
+        return
+      }
+
+      const gasPrice = await env.gasPriceOracle.gasPrice()
+      const largeGasPrice = gasPrice.mul(10)
+      const tx = {
+        ...defaultTransactionFactory(),
+        gasPrice: largeGasPrice,
+      }
+      await expect(env.l2Wallet.sendTransaction(tx)).to.be.rejectedWith(
+        `gas price too high: ${largeGasPrice.toString()} wei, use at most ` +
+          `tx.gasPrice = ${gasPrice.toString()} wei`
+      )
+    })
   })
 
   describe('eth_call', () => {

integration-tests/test/shared/env.ts

@@ -13,6 +13,7 @@ import {
   replicaProvider,
   l1Wallet,
   l2Wallet,
+  gasPriceOracleWallet,
   fundUser,
   getOvmEth,
   getL1Bridge,
@@ -100,7 +101,7 @@ export class OptimismEnv {
       .attach(ctcAddress)
 
     const gasPriceOracle = getContractFactory('OVM_GasPriceOracle')
-      .connect(l2Wallet)
+      .connect(gasPriceOracleWallet)
       .attach(predeploys.OVM_GasPriceOracle)
 
     const sccAddress = await addressManager.getAddress('StateCommitmentChain')

integration-tests/test/shared/utils.ts

@@ -47,6 +47,10 @@ const env = cleanEnv(process.env, {
   ADDRESS_MANAGER: str({
     default: '0x5FbDB2315678afecb367f032d93F642f64180aa3',
   }),
+  GAS_PRICE_ORACLE_PRIVATE_KEY: str({
+    default:
+      '0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba',
+  }),
   L2_CHAINID: num({ default: 420 }),
   IS_LIVE_NETWORK: bool({ default: false }),
 })
@@ -77,6 +81,12 @@ export const l1Wallet = new Wallet(env.PRIVATE_KEY, l1Provider)
 // if it's using non-0 gas price
 export const l2Wallet = l1Wallet.connect(l2Provider)
 
+// The owner of the GasPriceOracle on L2
+export const gasPriceOracleWallet = new Wallet(
+  env.GAS_PRICE_ORACLE_PRIVATE_KEY,
+  l2Provider
+)
+
 // Predeploys
 export const PROXY_SEQUENCER_ENTRYPOINT_ADDRESS =
   '0x4200000000000000000000000000000000000004'
@@ -182,14 +192,17 @@ export const waitForL2Geth = async (
 
 // eslint-disable-next-line @typescript-eslint/no-shadow
 export const gasPriceForL2 = async (env: OptimismEnv) => {
-  if (await isMainnet(env)) {
+  // The integration tests enforce fees on L2
+  // which run against hardhat on L1. Update if
+  // geth --dev is adopted for L1
+  const chainId = await env.l1Wallet.getChainId()
+  if ((await isMainnet(env)) || chainId === 31337) {
     return env.l2Wallet.getGasPrice()
   }
 
   if (isLiveNetwork()) {
     return Promise.resolve(BigNumber.from(10000))
   }
-
   return Promise.resolve(BigNumber.from(0))
 }
 

ops/docker-compose.yml

@@ -7,6 +7,8 @@ services:
     build:
       context: ./docker/hardhat
       dockerfile: Dockerfile
+    env_file:
+      -  ./envs/l1_chain.env
     ports:
         # expose the service to the host for integration testing
       - ${L1CHAIN_HTTP_PORT:-9545}:8545
@@ -26,12 +28,13 @@ services:
         DEPLOYER_PRIVATE_KEY: "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
         SEQUENCER_PRIVATE_KEY: "0x59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d"
         PROPOSER_PRIVATE_KEY: "0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a"
-        GAS_PRICE_ORACLE_OWNER: "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
+        # Default hardhat account 5
+        GAS_PRICE_ORACLE_OWNER: "0x9965507d1a55bcc2695c58ba16fb37d819b0a4dc"
         # setting the whitelist owner to address(0) disables the whitelist
         WHITELIST_OWNER: "0x0000000000000000000000000000000000000000"
         L1_FEE_WALLET_ADDRESS: "0x391716d440c151c42cdf1c95c1d83a5427bca52c"
         L2_CHAIN_ID: 420
-        L2_BLOCK_GAS_LIMIT: 11000000
+        L2_BLOCK_GAS_LIMIT: 15000000
         BLOCK_SIGNER_ADDRESS: "0x00000398232E2064F896018496b4b44b3D62751F"
         GAS_PRICE_ORACLE_OVERHEAD: "2750"
         GAS_PRICE_ORACLE_SCALAR: "1500000"
@@ -212,4 +215,5 @@ services:
     entrypoint: ./gas-oracle.sh
     environment:
       GAS_PRICE_ORACLE_ETHEREUM_HTTP_URL: http://l2geth:8545
-      GAS_PRICE_ORACLE_PRIVATE_KEY: "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
+      # Default hardhat account 5
+      GAS_PRICE_ORACLE_PRIVATE_KEY: "0x8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba"

ops/docker/Dockerfile.deployer

@@ -19,6 +19,7 @@ COPY --from=builder /optimism/packages/core-utils/dist ./packages/core-utils/dis
 WORKDIR /opt/optimism/packages/contracts
 COPY --from=builder /optimism/packages/contracts/dist ./dist
 COPY --from=builder /optimism/packages/contracts/*.json ./
+COPY --from=builder /optimism/packages/contracts/deployments ./deployments
 COPY --from=builder /optimism/packages/contracts/node_modules ./node_modules
 COPY --from=builder /optimism/packages/contracts/artifacts ./artifacts
 COPY --from=builder /optimism/packages/contracts/src ./src

ops/docker/Dockerfile.op_exporter → ops/docker/Dockerfile.op-exporter

 FROM golang:1.16 as builder
 
-ADD ./go/op_exporter /app/
+ADD ./go/op-exporter /app/
 WORKDIR /app/
 RUN make build
 
 FROM alpine:latest
 RUN apk --no-cache add ca-certificates
 WORKDIR /root/
-COPY --from=builder /app/op_exporter /usr/local/bin/
-ENTRYPOINT ["op_exporter"]
+COPY --from=builder /app/op-exporter /usr/local/bin/
+ENTRYPOINT ["op-exporter"]
 CMD ["--help"]

ops/docker/hardhat/hardhat.config.js

-module.exports = {
+const isForkModeEnabled = !!process.env.FORK_URL
+const forkUrl = process.env.FORK_URL
+const forkStartingBlock = parseInt(process.env.FORK_STARTING_BLOCK) || undefined
+const gasPrice = parseInt(process.env.GAS_PRICE) || 0
+
+const config = {
   networks: {
     hardhat: {
-      gasPrice: 0,
+      gasPrice,
       initialBaseFeePerGas: 0
     },
   },
   analytics: { enabled: false },
 }
+
+if (isForkModeEnabled) {
+  console.log(`Running hardhat in a fork mode! URL: ${forkUrl}`)
+  if (forkStartingBlock) {
+    console.log(`Starting block: ${forkStartingBlock}`)
+  }
+  config.networks.hardhat.forking = {
+    url: forkUrl,
+    blockNumber: forkStartingBlock,
+  }
+} else {
+  console.log('Running with a fresh state...')
+}
+
+module.exports = config

ops/docker/hardhat/package.json

@@ -6,6 +6,6 @@
   },
   "license": "MIT",
   "dependencies": {
-    "hardhat": "^2.6.5"
+    "hardhat": "^2.7.0"
   }
 }

ops/envs/dtl.env

@@ -8,6 +8,7 @@ DATA_TRANSPORT_LAYER__POLLING_INTERVAL=100
 DATA_TRANSPORT_LAYER__LOGS_PER_POLLING_INTERVAL=2000
 DATA_TRANSPORT_LAYER__DANGEROUSLY_CATCH_ALL_ERRORS=true
 DATA_TRANSPORT_LAYER__SERVER_HOSTNAME=0.0.0.0
+DATA_TRANSPORT_LAYER__L1_START_HEIGHT=1
 
 DATA_TRANSPORT_LAYER__ADDRESS_MANAGER=
 DATA_TRANSPORT_LAYER__L1_RPC_ENDPOINT=

ops/envs/geth.env

@@ -6,7 +6,7 @@ ETH1_CONFIRMATION_DEPTH=0
 ROLLUP_CLIENT_HTTP=
 ROLLUP_POLL_INTERVAL_FLAG=500ms
 ROLLUP_ENABLE_L2_GAS_POLLING=true
-# ROLLUP_ENFORCE_FEES=
+ROLLUP_ENFORCE_FEES=true
 
 RPC_ENABLE=true
 RPC_ADDR=0.0.0.0
@@ -36,3 +36,6 @@ BLOCK_SIGNER_KEY=6587ae678cf4fc9a33000cdbf9f35226b71dcc6a4684a31203241f9bcfd55d2
 BLOCK_SIGNER_ADDRESS=0x00000398232E2064F896018496b4b44b3D62751F
 
 L2_BLOCK_GAS_LIMIT=15000000
+
+ROLLUP_FEE_THRESHOLD_DOWN=0.9
+ROLLUP_FEE_THRESHOLD_UP=1.1

ops/envs/l1_chain.env

+FORK_URL=
+FORK_STARTING_BLOCK=

package.json

@@ -12,6 +12,7 @@
       "go/gas-oracle",
       "go/batch-submitter",
       "go/proxyd",
+      "go/op-exporter",
       "ops/docker/rpc-proxy",
       "ops/docker/hardhat"
     ],

packages/contracts/src/validation-utils.ts

@@ -30,9 +30,9 @@ export const color = Object.fromEntries(
   ])
 )
 
-export const getArtifact = (name: string) => {
-  // Paths to artifacts relative to artifacts/contracts
-  const locations = {
+// helper for finding the right artifact from the deployed name
+const locateArtifact = (name: string) => {
+  return {
     'ChainStorageContainer-CTC-batches':
       'L1/rollup/ChainStorageContainer.sol/ChainStorageContainer.json',
     'ChainStorageContainer-SCC-batches':
@@ -48,9 +48,12 @@ export const getArtifact = (name: string) => {
       'libraries/resolver/Lib_ResolvedDelegateProxy.sol/Lib_ResolvedDelegateProxy.json',
     Proxy__OVM_L1StandardBridge:
       'chugsplash/L1ChugSplashProxy.sol/L1ChugSplashProxy.json',
-  }
+  }[name]
+}
+
+export const getArtifactFromManagedName = (name: string) => {
   // eslint-disable-next-line @typescript-eslint/no-var-requires
-  return require(`../artifacts/contracts/${locations[name]}`)
+  return require(`../artifacts/contracts/${locateArtifact(name)}`)
 }
 
 export const getEtherscanUrl = (network, address: string) => {
@@ -63,26 +66,32 @@ const truncateLongString = (value: string): string => {
   return value.length > 66 ? `${value.slice(0, 66)}...` : value
 }
 
+export const printSectionHead = (msg: string) => {
+  console.log(color.cyan(msg))
+  console.log(
+    color.cyan('='.repeat(Math.max(...msg.split('\n').map((s) => s.length))))
+  )
+}
+
 export const printComparison = (
   action: string,
   description: string,
-  expected: { name: string; value: string },
-  deployed: { name: string; value: string }
+  expected: { name: string; value: any },
+  deployed: { name: string; value: any }
 ) => {
-  console.log(action + ':')
+  console.log(`\n${action}:`)
   if (hexStringEquals(expected.value, deployed.value)) {
     console.log(
-      color.green(
-        `${expected.name}: ${truncateLongString(expected.value)}
-      matches
-${deployed.name}: ${truncateLongString(deployed.value)}`
-      )
+      color.green(`${expected.name}: ${truncateLongString(expected.value)}`)
+    )
+    console.log('matches')
+    console.log(
+      color.green(`${deployed.name}: ${truncateLongString(deployed.value)}`)
     )
     console.log(color.green(`${description} looks good! 😎`))
   } else {
-    throw new Error(`${description} looks wrong.
-    ${expected.value}\ndoes not match\n${deployed.value}.
-    `)
+    throw new Error(
+      `${description} looks wrong. ${expected.value}\ndoes not match\n${deployed.value}.`
+    )
   }
-  console.log() // Add some whitespace
 }

packages/contracts/tasks/validate-address-dictator.ts

@@ -4,13 +4,15 @@ import { ethers } from 'ethers'
 import { task } from 'hardhat/config'
 import * as types from 'hardhat/internal/core/params/argumentTypes'
 import { hexStringEquals } from '@eth-optimism/core-utils'
-import { getContractFactory } from '../src/contract-defs'
+import { getContractFactory, getContractDefinition } from '../src/contract-defs'
+import { names } from '../src/address-names'
 
 import {
   getInput,
   color as c,
-  getArtifact,
+  getArtifactFromManagedName,
   getEtherscanUrl,
+  printSectionHead,
   printComparison,
 } from '../src/validation-utils'
 
@@ -49,7 +51,7 @@ task('validate:address-dictator')
 
     const network = await provider.getNetwork()
     console.log()
-    console.log(c.cyan("First make sure you're on the right chain:"))
+    printSectionHead("First make sure you're on the right chain:")
     console.log(
       `Reading from the ${c.red(network.name)} network (Chain ID: ${c.red(
         '' + network.chainId
@@ -57,16 +59,14 @@ task('validate:address-dictator')
     )
     await getInput(c.yellow('OK? Hit enter to continue.'))
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const dictatorArtifact = require('../artifacts/contracts/L1/deployment/AddressDictator.sol/AddressDictator.json')
+    const dictatorArtifact = getContractDefinition('AddressDictator')
     const dictatorCode = await provider.getCode(args.dictator)
-    console.log(
-      c.cyan(`
-Now validating the Address Dictator deployment at\n${getEtherscanUrl(
-        network,
-        args.dictator
-      )}`)
-    )
+    printSectionHead(`
+Validate the Address Dictator deployment at\n${getEtherscanUrl(
+      network,
+      args.dictator
+    )}`)
+
     printComparison(
       'Comparing deployed AddressDictator bytecode against local build artifacts',
       'Deployed AddressDictator code',
@@ -87,12 +87,12 @@ Now validating the Address Dictator deployment at\n${getEtherscanUrl(
       { name: 'finalOwner      ', value: finalOwner }
     )
 
-    const manager = await dictatorContract.manager()
+    const deployedManager = await dictatorContract.manager()
     printComparison(
       'Validating the AddressManager address in the AddressDictator',
       'addressManager',
-      { name: 'manager', value: args.manager },
-      { name: 'Address Manager', value: manager }
+      { name: 'manager        ', value: args.manager },
+      { name: 'Address Manager', value: deployedManager }
     )
     await getInput(c.yellow('OK? Hit enter to continue.'))
 
@@ -107,15 +107,20 @@ Now validating the Address Dictator deployment at\n${getEtherscanUrl(
 
     // Now we loop over those and compare the addresses/deployedBytecode to deployment artifacts.
     for (const pair of namedAddresses) {
+      if (pair.name === 'L2CrossDomainMessenger') {
+        console.log('L2CrossDomainMessenger is set to:', pair.addr)
+        await getInput(c.yellow('OK? Hit enter to continue.'))
+        // This is an L2 predeploy, so we skip bytecode and config validation.
+        continue
+      }
       const currentAddress = await managerContract.getAddress(pair.name)
-      const artifact = getArtifact(pair.name)
+      const artifact = getArtifactFromManagedName(pair.name)
       const addressChanged = !hexStringEquals(currentAddress, pair.addr)
       if (addressChanged) {
-        console.log(
-          c.cyan(`
-Now validating the ${pair.name} deployment.
+        printSectionHead(
+          `Validate the ${pair.name} deployment.
 Current address: ${getEtherscanUrl(network, currentAddress)}
-Upgraded address ${getEtherscanUrl(network, pair.addr)}`)
+Upgraded address ${getEtherscanUrl(network, pair.addr)}`
         )
 
         const code = await provider.getCode(pair.addr)
@@ -144,12 +149,138 @@ Upgraded address ${getEtherscanUrl(network, pair.addr)}`)
               `Verifying ${pair.name} has the correct AddressManager address`,
               `The AddressManager address in ${pair.name}`,
               { name: 'Deployed value', value: libAddressManager },
-              { name: 'Expected value', value: manager }
+              { name: 'Expected value', value: deployedManager }
             )
+            await getInput(c.yellow('OK? Hit enter to continue.'))
           }
         }
       }
-      await getInput(c.yellow('OK? Hit enter to continue.'))
+      await validateDeployedConfig(provider, network, args.manager, pair)
     }
-    console.log(c.green('AddressManager Validation complete!'))
+    console.log(c.green('\nAddressManager Validation complete!'))
   })
+
+/**
+ * Validates that the deployed contracts have the expected storage variables.
+ *
+ * @param {*} provider
+ * @param {{ name: string; addr: string }} pair The contract name and address
+ */
+const validateDeployedConfig = async (
+  provider,
+  network,
+  manager,
+  pair: { name: string; addr: string }
+) => {
+  printSectionHead(`
+Ensure that the ${pair.name} at\n${getEtherscanUrl(
+    network,
+    pair.addr
+  )} is configured correctly`)
+  if (pair.name === names.managed.contracts.StateCommitmentChain) {
+    const scc = getContractFactory(pair.name)
+      .attach(pair.addr)
+      .connect(provider)
+    //  --scc-fraud-proof-window 604800 \
+    const fraudProofWindow = await scc.FRAUD_PROOF_WINDOW()
+    printComparison(
+      'Checking the fraudProofWindow of the StateCommitmentChain',
+      'StateCommitmentChain.fraudProofWindow',
+      {
+        name: 'Configured fraudProofWindow',
+        value: ethers.BigNumber.from(604_800).toHexString(),
+      },
+      {
+        name: 'Deployed fraudProofWindow  ',
+        value: ethers.BigNumber.from(fraudProofWindow).toHexString(),
+      }
+    )
+    await getInput(c.yellow('OK? Hit enter to continue.'))
+
+    //  --scc-sequencer-publish-window 12592000 \
+    const sequencerPublishWindow = await scc.SEQUENCER_PUBLISH_WINDOW()
+    printComparison(
+      'Checking the sequencerPublishWindow of the StateCommitmentChain',
+      'StateCommitmentChain.sequencerPublishWindow',
+      {
+        name: 'Configured sequencerPublishWindow  ',
+        value: ethers.BigNumber.from(12592000).toHexString(),
+      },
+      {
+        name: 'Deployed sequencerPublishWindow',
+        value: ethers.BigNumber.from(sequencerPublishWindow).toHexString(),
+      }
+    )
+    await getInput(c.yellow('OK? Hit enter to continue.'))
+  } else if (pair.name === names.managed.contracts.CanonicalTransactionChain) {
+    const ctc = getContractFactory(pair.name)
+      .attach(pair.addr)
+      .connect(provider)
+
+    //  --ctc-max-transaction-gas-limit 15000000 \
+    const maxTransactionGasLimit = await ctc.maxTransactionGasLimit()
+    printComparison(
+      'Checking the maxTransactionGasLimit of the CanonicalTransactionChain',
+      'CanonicalTransactionChain.maxTransactionGasLimit',
+      {
+        name: 'Configured maxTransactionGasLimit',
+        value: ethers.BigNumber.from(15_000_000).toHexString(),
+      },
+      {
+        name: 'Deployed maxTransactionGasLimit  ',
+        value: ethers.BigNumber.from(maxTransactionGasLimit).toHexString(),
+      }
+    )
+    await getInput(c.yellow('OK? Hit enter to continue.'))
+    //  --ctc-l2-gas-discount-divisor 32 \
+    const l2GasDiscountDivisor = await ctc.l2GasDiscountDivisor()
+    printComparison(
+      'Checking the l2GasDiscountDivisor of the CanonicalTransactionChain',
+      'CanonicalTransactionChain.l2GasDiscountDivisor',
+      {
+        name: 'Configured l2GasDiscountDivisor',
+        value: ethers.BigNumber.from(32).toHexString(),
+      },
+      {
+        name: 'Deployed l2GasDiscountDivisor  ',
+        value: ethers.BigNumber.from(l2GasDiscountDivisor).toHexString(),
+      }
+    )
+    await getInput(c.yellow('OK? Hit enter to continue.'))
+    //  --ctc-enqueue-gas-cost 60000 \
+    const enqueueGasCost = await ctc.enqueueGasCost()
+    printComparison(
+      'Checking the enqueueGasCost of the CanonicalTransactionChain',
+      'CanonicalTransactionChain.enqueueGasCost',
+      {
+        name: 'Configured enqueueGasCost',
+        value: ethers.BigNumber.from(60000).toHexString(),
+      },
+      {
+        name: 'Deployed enqueueGasCost  ',
+        value: ethers.BigNumber.from(enqueueGasCost).toHexString(),
+      }
+    )
+    await getInput(c.yellow('OK? Hit enter to continue.'))
+  } else if (pair.name === names.managed.contracts.OVM_L1CrossDomainMessenger) {
+    const messengerManager = await getContractFactory('L1CrossDomainMessenger')
+      .attach(pair.addr)
+      .connect(provider)
+      .libAddressManager()
+    printComparison(
+      'Ensure that the L1CrossDomainMessenger (implementation) is initialized with a non-zero Address Manager variable',
+      "L1CrossDomainMessenger's Lib_AddressManager",
+      {
+        name: 'Configured Lib_AddressManager',
+        value: messengerManager,
+      },
+      {
+        name: 'Deployed Lib_AddressManager  ',
+        value: manager,
+      }
+    )
+  } else {
+    console.log(c.green(`${pair.name} has no config to check`))
+    await getInput(c.yellow('OK? Hit enter to continue.'))
+  }
+}

packages/contracts/tasks/validate-chugsplash-dictator.ts

@@ -3,13 +3,14 @@
 import { ethers } from 'ethers'
 import { task } from 'hardhat/config'
 import * as types from 'hardhat/internal/core/params/argumentTypes'
-import { getContractFactory } from '../src/contract-defs'
+import { getContractFactory, getContractDefinition } from '../src/contract-defs'
 
 import {
   getInput,
   color as c,
   getEtherscanUrl,
   printComparison,
+  printSectionHead,
 } from '../src/validation-utils'
 
 task('validate:chugsplash-dictator')
@@ -54,24 +55,24 @@ task('validate:chugsplash-dictator')
       )})`
     )
     await getInput(c.yellow('OK? Hit enter to continue.'))
+    console.log()
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const dictatorArtifact = require('../artifacts/contracts/L1/deployment/ChugSplashDictator.sol/ChugSplashDictator.json')
+    const dictatorArtifact = getContractDefinition('ChugSplashDictator')
     const dictatorCode = await provider.getCode(args.dictator)
-    console.log(
-      c.cyan(`
-Now validating the Chugsplash Dictator deployment at\n${getEtherscanUrl(
+    printSectionHead(
+      `Validate the Chugsplash Dictator deployment at\n${getEtherscanUrl(
         network,
         args.dictator
-      )}`)
+      )}`
     )
     printComparison(
-      'Comparing deployed ChugSplashDictator bytecode against local build artifacts',
+      'Compare the deployed ChugSplashDictator bytecode against local build artifacts',
       'Deployed ChugSplashDictator code',
       { name: 'Compiled bytecode', value: dictatorArtifact.deployedBytecode },
       { name: 'Deployed bytecode', value: dictatorCode }
     )
     await getInput(c.yellow('OK? Hit enter to continue.'))
+    console.log()
 
     console.log(
       c.cyan("The next 4 checks will validate the ChugSplashDictator's config")
@@ -82,12 +83,13 @@ Now validating the Chugsplash Dictator deployment at\n${getEtherscanUrl(
       .connect(provider)
     const finalOwner = await dictatorContract.finalOwner()
     printComparison(
-      '1. Comparing the finalOwner address in the ChugSplashDictator to the multisig address',
+      'Compare the finalOwner address in the ChugSplashDictator to the multisig address',
       'finalOwner',
       { name: 'multisig address', value: args.multisig },
       { name: 'finalOwner      ', value: finalOwner }
     )
     await getInput(c.yellow('OK? Hit enter to continue.'))
+    console.log()
 
     const dictatorMessengerSlotKey = await dictatorContract.messengerSlotKey()
     const dictatorMessengerSlotVal = await dictatorContract.messengerSlotVal()
@@ -96,7 +98,7 @@ Now validating the Chugsplash Dictator deployment at\n${getEtherscanUrl(
       dictatorMessengerSlotKey
     )
     printComparison(
-      '2. Comparing the messenger slot key/value to be set, with the current values in the proxy',
+      'Compare the Messenger slot key/value to be set, with the current values in the proxy',
       `Storage slot key ${dictatorMessengerSlotKey}`,
       {
         name: `Value in the proxy at slot key\n${dictatorMessengerSlotKey}`,
@@ -108,6 +110,7 @@ Now validating the Chugsplash Dictator deployment at\n${getEtherscanUrl(
       }
     )
     await getInput(c.yellow('OK? Hit enter to continue.'))
+    console.log()
 
     const dictatorBridgeSlotKey = await dictatorContract.bridgeSlotKey()
     const dictatorBridgeSlotVal = await dictatorContract.bridgeSlotVal()
@@ -116,7 +119,7 @@ Now validating the Chugsplash Dictator deployment at\n${getEtherscanUrl(
       dictatorBridgeSlotKey
     )
     printComparison(
-      '3. Comparing the _Bridge_ slot key/value to be set, with the current values in the proxy',
+      'Compare the Bridge slot key/value to be set, with the current values in the proxy',
       `Storage slot key ${dictatorBridgeSlotKey}`,
       {
         name: `Value currently in the proxy at slot key\n${dictatorBridgeSlotKey}`,
@@ -128,15 +131,15 @@ Now validating the Chugsplash Dictator deployment at\n${getEtherscanUrl(
       }
     )
     await getInput(c.yellow('OK? Hit enter to continue.'))
+    console.log()
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const bridgeArtifact = require('../artifacts/contracts/L1/messaging/L1StandardBridge.sol/L1StandardBridge.json')
+    const bridgeArtifact = getContractDefinition('L1StandardBridge')
     const expectedCodeHash = ethers.utils.keccak256(
       bridgeArtifact.deployedBytecode
     )
     const actualCodeHash = await dictatorContract.codeHash()
     printComparison(
-      "4. Comparing the Dictator's codeHash against hash of the local L1StandardBridge build artifacts",
+      "Compare the Dictator's codeHash against hash of the local L1StandardBridge build artifacts",
       "Dictator's codeHash",
       {
         name: 'Expected codeHash',
@@ -148,5 +151,6 @@ Now validating the Chugsplash Dictator deployment at\n${getEtherscanUrl(
       }
     )
     await getInput(c.yellow('OK? Hit enter to continue.'))
+    console.log()
     console.log(c.green('Chugsplash Dictator Validation complete!'))
   })

packages/sdk/.eslintrc.js

+module.exports = {
+  extends: '../../.eslintrc.js',
+}

packages/sdk/.gitignore

+node_modules/
+build/

packages/sdk/.lintstagedrc.yml

+"*.{ts,js}":
+  - eslint

packages/sdk/.prettierrc.js

+module.exports = {
+  ...require('../../.prettierrc.js'),
+};
\ No newline at end of file

packages/sdk/LICENSE

+(The MIT License)
+
+Copyright 2020-2021 Optimism
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/sdk/README.md

+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=sdk)](https://codecov.io/gh/ethereum-optimism/optimism)
+
+# @eth-optimism/sdk
+
+The `@eth-optimism/sdk` package provides a set of tools for interacting with Optimistic Ethereum.
+
+## Installation
+
+```
+npm install @eth-optimism/sdk
+```
+
+## API
+
+TODO: Fill this in once the initial package version is finished.

packages/sdk/package.json

+{
+  "name": "@eth-optimism/sdk",
+  "version": "0.0.1",
+  "description": "[Optimism] Tools for working with Optimistic Ethereum",
+  "main": "dist/index",
+  "types": "dist/index",
+  "files": [
+    "dist/index"
+  ],
+  "scripts": {
+    "all": "yarn clean && yarn build && yarn test && yarn lint:fix && yarn lint",
+    "build": "tsc -p tsconfig.build.json",
+    "clean": "rimraf dist/ ./tsconfig.build.tsbuildinfo",
+    "lint": "yarn lint:fix && yarn lint:check",
+    "lint:check": "eslint .",
+    "lint:fix": "yarn lint:check --fix",
+    "pre-commit": "lint-staged"
+  },
+  "keywords": [
+    "optimism",
+    "ethereum",
+    "sdk"
+  ],
+  "homepage": "https://github.com/ethereum-optimism/optimism-monorepo/tree/master/packages/sdk#readme",
+  "license": "MIT",
+  "author": "Optimism PBC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ethereum-optimism/optimism-monorepo.git"
+  },
+  "devDependencies": {
+    "@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",
+    "@typescript-eslint/eslint-plugin": "^4.26.0",
+    "@typescript-eslint/parser": "^4.26.0",
+    "babel-eslint": "^10.1.0",
+    "chai": "^4.3.4",
+    "chai-as-promised": "^7.1.1",
+    "eslint": "^7.27.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-ban": "^1.5.2",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-jsdoc": "^35.1.2",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-react": "^7.24.0",
+    "eslint-plugin-unicorn": "^32.0.1",
+    "ethereum-waffle": "^3.4.0",
+    "hardhat": "^2.3.0",
+    "lint-staged": "11.0.0",
+    "mocha": "^8.4.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.3.1",
+    "ts-mocha": "^8.0.0",
+    "typescript": "^4.3.5"
+  },
+  "dependencies": {
+    "@eth-optimism/contracts": "0.5.5",
+    "@eth-optimism/core-utils": "0.7.3",
+    "@ethersproject/abstract-provider": "^5.5.1",
+    "@ethersproject/abstract-signer": "^5.5.0",
+    "ethers": "^5.5.2"
+  }
+}

packages/sdk/src/index.ts

+export * from './interfaces'

packages/sdk/src/interfaces/cross-chain-provider.ts

+import { BigNumber } from 'ethers'
+import { Provider, BlockTag } from '@ethersproject/abstract-provider'
+import {
+  MessageLike,
+  TransactionLike,
+  AddressLike,
+  NumberLike,
+  CrossChainMessage,
+  MessageDirection,
+  MessageStatus,
+  TokenBridgeMessage,
+  OEContracts,
+  MessageReceipt,
+} from './types'
+
+/**
+ * Represents the L1/L2 connection. Only handles read requests. If you want to send messages, use
+ * the CrossChainMessenger contract which takes a CrossChainProvider and a signer as inputs.
+ */
+export interface ICrossChainProvider {
+  /**
+   * Provider connected to the L1 chain.
+   */
+  l1Provider: Provider
+
+  /**
+   * Provider connected to the L2 chain.
+   */
+  l2Provider: Provider
+
+  /**
+   * Chain ID for the L1 network.
+   */
+  l1ChainId: number
+
+  /**
+   * Chain ID for the L2 network.
+   */
+  l2ChainId: number
+
+  /**
+   * Contract objects attached to their respective providers and addresses.
+   */
+  contracts: OEContracts
+
+  /**
+   * Retrieves all cross chain messages sent within a given transaction.
+   *
+   * @param transaction Transaction hash or receipt to find messages from.
+   * @param opts Options object.
+   * @param opts.direction Direction to search for messages in. If not provided, will attempt to
+   * automatically search both directions under the assumption that a transaction hash will only
+   * exist on one chain. If the hash exists on both chains, will throw an error.
+   * @returns All cross chain messages sent within the transaction.
+   */
+  getMessagesByTransaction(
+    transaction: TransactionLike,
+    opts?: {
+      direction?: MessageDirection
+    }
+  ): Promise<CrossChainMessage[]>
+
+  /**
+   * Retrieves all cross chain messages sent by a particular address.
+   *
+   * @param address Address to search for messages from.
+   * @param opts Options object.
+   * @param opts.direction Direction to search for messages in. If not provided, will attempt to
+   * find all messages in both directions.
+   * @param opts.fromBlock Block to start searching for messages from. If not provided, will start
+   * from the first block (block #0).
+   * @param opts.toBlock Block to stop searching for messages at. If not provided, will stop at the
+   * latest known block ("latest").
+   * @returns All cross chain messages sent by the particular address.
+   */
+  getMessagesByAddress(
+    address: AddressLike,
+    opts?: {
+      direction?: MessageDirection
+      fromBlock?: NumberLike
+      toBlock?: NumberLike
+    }
+  ): Promise<CrossChainMessage[]>
+
+  /**
+   * Finds all cross chain messages that correspond to token deposits or withdrawals sent by a
+   * particular address. Useful for finding deposits/withdrawals because the sender of the message
+   * will appear to be the StandardBridge contract and not the actual end user. Returns
+   *
+   * @param address Address to search for messages from.
+   * @param opts Options object.
+   * @param opts.direction Direction to search for messages in. If not provided, will attempt to
+   * find all messages in both directions.
+   * @param opts.fromBlock Block to start searching for messages from. If not provided, will start
+   * from the first block (block #0).
+   * @param opts.toBlock Block to stop searching for messages at. If not provided, will stop at the
+   * latest known block ("latest").
+   * @returns All token bridge messages sent by the given address.
+   */
+  getTokenBridgeMessagesByAddress(
+    address: AddressLike,
+    opts?: {
+      direction?: MessageDirection
+      fromBlock?: BlockTag
+      toBlock?: BlockTag
+    }
+  ): Promise<TokenBridgeMessage[]>
+
+  /**
+   * Retrieves the status of a particular message as an enum.
+   *
+   * @param message Cross chain message to check the status of.
+   * @returns Status of the message.
+   */
+  getMessageStatus(message: MessageLike): Promise<MessageStatus>
+
+  /**
+   * Finds the receipt of the transaction that executed a particular cross chain message.
+   *
+   * @param message Message to find the receipt of.
+   * @returns CrossChainMessage receipt including receipt of the transaction that relayed the
+   * given message.
+   */
+  getMessageReceipt(message: MessageLike): Promise<MessageReceipt>
+
+  /**
+   * Waits for a message to be executed and returns the receipt of the transaction that executed
+   * the given message.
+   *
+   * @param message Message to wait for.
+   * @param opts Options to pass to the waiting function.
+   * - `confirmations` (number): Number of transaction confirmations to wait for before returning.
+   * - `pollIntervalMs` (number): Number of milliseconds to wait between polling for the receipt.
+   * - `loopsBeforeTimeout` (number): Number of times to poll before timing out.
+   * @returns CrossChainMessage receipt including receipt of the transaction that relayed the
+   * given message.
+   */
+  waitForMessageReciept(
+    message: MessageLike,
+    opts?: {
+      confirmations?: number
+      pollIntervalMs?: number
+      loopsBeforeTimeout?: number
+    }
+  ): Promise<MessageReceipt>
+
+  /**
+   * Estimates the amount of gas required to fully execute a given message. Behavior of this
+   * function depends on the direction of the message. If the message is an L1 to L2 message,
+   * then this will estimate the amount of gas required to execute the message on L2. If the
+   * message is an L2 to L1 message, then this estimate will also include the amount of gas
+   * required to execute the Merkle Patricia Trie proof on L1.
+   *
+   * @param message Message get a gas estimate for.
+   */
+  estimateMessageExecutionGas(message: MessageLike): Promise<BigNumber>
+
+  /**
+   * Returns the estimated amount of time before the message can be executed. When this is a
+   * message being sent to L1, this will return the estimated time until the message will complete
+   * its challenge period. When this is a message being sent to L2, this will return the estimated
+   * amount of time until the message will be picked up and executed on L2.
+   *
+   * @param message Message to estimate the time remaining for.
+   * @returns Estimated amount of time remaining (in seconds) before the message can be executed.
+   */
+  estimateMessageWaitTimeSeconds(message: MessageLike): Promise<number>
+
+  /**
+   * Returns the estimated amount of time before the message can be executed (in L1 blocks).
+   * When this is a message being sent to L1, this will return the estimated time until the message
+   * will complete its challenge period. When this is a message being sent to L2, this will return
+   * the estimated amount of time until the message will be picked up and executed on L2.
+   *
+   * @param message Message to estimate the time remaining for.
+   * @returns Estimated amount of time remaining (in blocks) before the message can be executed.
+   */
+  estimateMessageWaitTimeBlocks(message: MessageLike): Promise<number>
+}

packages/sdk/src/interfaces/index.ts

+export * from './cross-chain-messenger'
+export * from './cross-chain-provider'
+export * from './l2-provider'
+export * from './types'

packages/sdk/src/interfaces/l2-provider.ts

+import { Provider, TransactionRequest } from '@ethersproject/abstract-provider'
+import { BigNumber } from 'ethers'
+
+/**
+ * Represents an extended version of an normal ethers Provider that returns additional L2 info and
+ * has special functions for L2-specific interactions.
+ */
+export interface L2Provider extends Provider {
+  /**
+   * Gets the current L1 (data) gas price.
+   *
+   * @returns Current L1 data gas price in wei.
+   */
+  getL1GasPrice(): Promise<BigNumber>
+
+  /**
+   * Estimates the L1 (data) gas required for a transaction.
+   *
+   * @param tx Transaction to estimate L1 gas for.
+   * @returns Estimated L1 gas.
+   */
+  estimateL1Gas(tx: TransactionRequest): Promise<BigNumber>
+
+  /**
+   * Estimates the L1 (data) gas cost for a transaction in wei by multiplying the estimated L1 gas
+   * cost by the current L1 gas price.
+   *
+   * @param tx Transaction to estimate L1 gas cost for.
+   * @returns Estimated L1 gas cost.
+   */
+  estimateL1GasCost(tx: TransactionRequest): Promise<BigNumber>
+
+  /**
+   * Estimates the L2 (execution) gas cost for a transaction in wei by multiplying the estimated L1
+   * gas cost by the current L2 gas price. This is a simple multiplication of the result of
+   * getGasPrice and estimateGas for the given transaction request.
+   *
+   * @param tx Transaction to estimate L2 gas cost for.
+   * @returns Estimated L2 gas cost.
+   */
+  estimateL2GasCost(tx: TransactionRequest): Promise<BigNumber>
+
+  /**
+   * Estimates the total gas cost for a transaction in wei by adding the estimated the L1 gas cost
+   * and the estimated L2 gas cost.
+   *
+   * @param tx Transaction to estimate total gas cost for.
+   * @returns Estimated total gas cost.
+   */
+  estimateTotalGasCost(tx: TransactionRequest): Promise<BigNumber>
+}

packages/sdk/src/interfaces/types.ts

+import {
+  Provider,
+  TransactionReceipt,
+  TransactionResponse,
+} from '@ethersproject/abstract-provider'
+import { Signer } from '@ethersproject/abstract-signer'
+import { Contract, BigNumber, Overrides } from 'ethers'
+
+/**
+ * Represents Optimistic Ethereum contracts, assumed to be connected to their appropriate
+ * providers and addresses.
+ */
+export interface OEContracts {
+  /**
+   * L1 contract references.
+   */
+  l1: {
+    AddressManager: Contract
+    L1CrossDomainMessenger: Contract
+    L1StandardBridge: Contract
+    StateCommitmentChain: Contract
+    CanonicalTransactionChain: Contract
+    BondManager: Contract
+  }
+
+  /**
+   * L2 contract references.
+   */
+  l2: {
+    L2CrossDomainMessenger: Contract
+    L2StandardBridge: Contract
+    OVM_L1BlockNumber: Contract
+    OVM_L2ToL1MessagePasser: Contract
+    OVM_DeployerWhitelist: Contract
+    OVM_ETH: Contract
+    OVM_GasPriceOracle: Contract
+    OVM_SequencerFeeVault: Contract
+    WETH: Contract
+  }
+}
+
+/**
+ * Enum describing the status of a message.
+ */
+export enum MessageStatus {
+  /**
+   * Message is an L1 to L2 message and has not been processed by the L2.
+   */
+  UNCONFIRMED_L1_TO_L2_MESSAGE,
+
+  /**
+   * Message is an L2 to L1 message and no state root has been published yet.
+   */
+  STATE_ROOT_NOT_PUBLISHED,
+
+  /**
+   * Message is an L2 to L1 message and awaiting the challenge period.
+   */
+  IN_CHALLENGE_PERIOD,
+
+  /**
+   * Message is ready to be relayed.
+   */
+  READY_FOR_RELAY,
+
+  /**
+   * Message has been relayed.
+   */
+  RELAYED,
+}
+
+/**
+ * Enum describing the direction of a message.
+ */
+export enum MessageDirection {
+  L1_TO_L2,
+  L2_TO_L1,
+}
+
+/**
+ * Partial message that needs to be signed and executed by a specific signer.
+ */
+export interface CrossChainMessageRequest {
+  direction: MessageDirection
+  target: string
+  message: string
+  l2GasLimit: NumberLike
+}
+
+/**
+ * Describes a message that is sent between L1 and L2. Direction determines where the message was
+ * sent from and where it's being sent to.
+ */
+export interface CrossChainMessage {
+  direction: MessageDirection
+  sender: string
+  target: string
+  message: string
+  messageNonce: number
+}
+
+/**
+ * Describes a token withdrawal or deposit, along with the underlying raw cross chain message
+ * behind the deposit or withdrawal.
+ */
+export interface TokenBridgeMessage {
+  direction: MessageDirection
+  from: string
+  to: string
+  l1Token: string
+  l2Token: string
+  amount: BigNumber
+  raw: CrossChainMessage
+}
+
+/**
+ * Enum describing the status of a CrossDomainMessage message receipt.
+ */
+export enum MessageReceiptStatus {
+  RELAYED_SUCCEEDED,
+  RELAYED_FAILED,
+}
+
+/**
+ * CrossDomainMessage receipt.
+ */
+export interface MessageReceipt {
+  messageHash: string
+  receiptStatus: MessageReceiptStatus
+  transactionReceipt: TransactionReceipt
+}
+
+/**
+ * Header for a state root batch.
+ */
+export interface StateRootBatchHeader {
+  batchIndex: BigNumber
+  batchRoot: string
+  batchSize: BigNumber
+  prevTotalElements: BigNumber
+  extraData: string
+}
+
+/**
+ * State root batch, including header and actual state roots.
+ */
+export interface StateRootBatch {
+  header: StateRootBatchHeader
+  stateRoots: string[]
+}
+
+/**
+ * Utility type for deep partials.
+ */
+export type DeepPartial<T> = {
+  [P in keyof T]?: DeepPartial<T[P]>
+}
+
+/**
+ * Extended Ethers overrides object with an l2GasLimit field.
+ * Only meant to be used for L1 to L2 messages, since L2 to L1 messages don't have a specified gas
+ * limit field (gas used depends on the amount of gas provided).
+ */
+export type L1ToL2Overrides = Overrides & {
+  l2GasLimit: NumberLike
+}
+
+/**
+ * Stuff that can be coerced into a transaction.
+ */
+export type TransactionLike = string | TransactionReceipt | TransactionResponse
+
+/**
+ * Stuff that can be coerced into a message.
+ */
+export type MessageLike =
+  | CrossChainMessage
+  | TransactionLike
+  | TokenBridgeMessage
+
+/**
+ * Stuff that can be coerced into a provider.
+ */
+export type ProviderLike = string | Provider
+
+/**
+ * Stuff that can be coerced into a signer.
+ */
+export type SignerLike = string | Signer
+
+/**
+ * Stuff that can be coerced into a signer or provider.
+ */
+export type SignerOrProviderLike = SignerLike | ProviderLike
+
+/**
+ * Stuff that can be coerced into an address.
+ */
+export type AddressLike = string | Contract
+
+/**
+ * Stuff that can be coerced into a number.
+ */
+export type NumberLike = string | number | BigNumber

packages/sdk/test/setup.ts

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

packages/sdk/tsconfig.build.json

+{
+  "extends": "../../tsconfig.build.json",
+
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+
+  "include": [
+    "src/**/*"
+  ]
+}

packages/sdk/tsconfig.json

+{
+  "extends": "../../tsconfig.json"
+}