Merge branch 'develop' into regenesis/0.4.0

.changeset/calm-fans-travel.md

@@ -0,0 +1,5 @@
+---
+'@eth-optimism/contracts': patch
+---
+
+Migrated from tslint to eslint. The preference for lint exceptions is as follows: line level, block level, file level, package level.

.changeset/olive-planets-clean.md

@@ -0,0 +1,5 @@
+---
+'@eth-optimism/batch-submitter': patch
+---
+
+Add failure metrics to batch submitter

.eslintrc.js

@@ -0,0 +1,186 @@
+module.exports = {
+    "env": {
+        "browser": true,
+        "es6": true
+    },
+    "extends": [
+        "prettier",
+    ],
+    "ignorePatterns": ["dist/**/*.ts"],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "eslint-plugin-import",
+        "eslint-plugin-unicorn",
+        "eslint-plugin-jsdoc",
+        "eslint-plugin-prefer-arrow",
+        "eslint-plugin-react",
+        "@typescript-eslint",
+    ],
+    "rules": {
+        "@typescript-eslint/adjacent-overload-signatures": "error",
+        "@typescript-eslint/array-type": "off",
+        "@typescript-eslint/ban-types": "off",
+        "@typescript-eslint/consistent-type-assertions": "error",
+        "@typescript-eslint/dot-notation": "off",
+        "@typescript-eslint/indent": "off",
+        "@typescript-eslint/member-delimiter-style": [
+            "off",
+            {
+                "multiline": {
+                    "delimiter": "none",
+                    "requireLast": true
+                },
+                "singleline": {
+                    "delimiter": "semi",
+                    "requireLast": false
+                }
+            }
+        ],
+        "@typescript-eslint/member-ordering": "off",
+        "@typescript-eslint/naming-convention": "off",
+        "@typescript-eslint/no-empty-function": "error",
+        "@typescript-eslint/no-empty-interface": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-misused-new": "error",
+        "@typescript-eslint/no-namespace": "error",
+        "@typescript-eslint/no-parameter-properties": "off",
+        "@typescript-eslint/no-shadow": [
+            "error",
+            {
+                "hoist": "all"
+            }
+        ],
+        "@typescript-eslint/no-this-alias": "error",
+        "@typescript-eslint/no-unused-expressions": "off",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/no-var-requires": "error",
+        "@typescript-eslint/prefer-for-of": "error",
+        "@typescript-eslint/prefer-function-type": "error",
+        "@typescript-eslint/prefer-namespace-keyword": "error",
+        "@typescript-eslint/quotes": "off",
+        "@typescript-eslint/semi": [
+            "off",
+            null
+        ],
+        "@typescript-eslint/triple-slash-reference": [
+            "error",
+            {
+                "path": "always",
+                "types": "prefer-import",
+                "lib": "always"
+            }
+        ],
+        "@typescript-eslint/type-annotation-spacing": "off",
+        "@typescript-eslint/unified-signatures": "error",
+        "arrow-parens": [
+            "off",
+            "always"
+        ],
+        "brace-style": [
+            "off",
+            "off"
+        ],
+        "comma-dangle": "off",
+        "complexity": "off",
+        "constructor-super": "error",
+        "curly": "error",
+        "dot-notation": "off",
+        "eol-last": "off",
+        "eqeqeq": [
+            "error",
+            "smart"
+        ],
+        "guard-for-in": "error",
+        "id-blacklist": "off",
+        "id-match": "off",
+        "import/no-extraneous-dependencies": [
+            "error"
+        ],
+        "import/no-internal-modules": "off",
+        "import/order": "off",
+        "indent": "off",
+        "jsdoc/check-alignment": "error",
+        "jsdoc/check-indentation": "error",
+        "jsdoc/newline-after-description": "error",
+        "linebreak-style": "off",
+        "max-classes-per-file": "off",
+        "max-len": "off",
+        "new-parens": "off",
+        "newline-per-chained-call": "off",
+        "no-bitwise": "off",
+        "no-caller": "error",
+        "no-cond-assign": "error",
+        "no-console": "off",
+        "no-debugger": "error",
+        "no-duplicate-case": "error",
+        "no-duplicate-imports": "error",
+        "no-empty": "error",
+        "no-eval": "error",
+        "no-extra-bind": "error",
+        "no-extra-semi": "off",
+        "no-fallthrough": "off",
+        "no-invalid-this": "off",
+        "no-irregular-whitespace": "off",
+        "no-multiple-empty-lines": "off",
+        "no-new-func": "error",
+        "no-new-wrappers": "error",
+        "no-redeclare": "error",
+        "no-return-await": "error",
+        "no-sequences": "error",
+        "no-sparse-arrays": "error",
+        "no-template-curly-in-string": "error",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "off",
+        "no-undef-init": "error",
+        "no-underscore-dangle": "off",
+        "no-unsafe-finally": "error",
+        "no-unused-expressions": "off",
+        "no-unused-labels": "error",
+        "no-use-before-define": "off",
+        "no-var": "error",
+        "object-shorthand": "error",
+        "one-var": [
+            "error",
+            "never"
+        ],
+        "padded-blocks": [
+            "off",
+            {
+                "blocks": "never"
+            },
+            {
+                "allowSingleLineBlocks": true
+            }
+        ],
+        "prefer-arrow/prefer-arrow-functions": "error",
+        "prefer-const": "error",
+        "prefer-object-spread": "error",
+        "quote-props": "off",
+        "quotes": "off",
+        "radix": "error",
+        "react/jsx-curly-spacing": "off",
+        "react/jsx-equals-spacing": "off",
+        "react/jsx-tag-spacing": [
+            "off",
+            {
+                "afterOpening": "allow",
+                "closingSlash": "allow"
+            }
+        ],
+        "react/jsx-wrap-multilines": "off",
+        "semi": "off",
+        "space-before-blocks": "error",
+        "space-before-function-paren": "off",
+        "space-in-parens": [
+            "off",
+            "never"
+        ],
+        "unicorn/prefer-ternary": "off",
+        "use-isnan": "error",
+        "valid-typeof": "off"
+    }
+};

.github/workflows/sync-tests.yml

@@ -42,3 +42,21 @@ jobs:
         run: |
           yarn
           yarn test:sync
+
+      - name: Collect docker logs on failure
+        if: failure()
+        uses: jwalton/gh-docker-logs@v1
+        with:
+          images: 'ethereumoptimism/builder,ethereumoptimism/hardhat,ethereumoptimism/deployer,ethereumoptimism/data-transport-layer,ethereumoptimism/l2geth,ethereumoptimism/message-relayer,ethereumoptimism/batch-submitter,ethereumoptimism/l2geth'
+          dest: './logs'
+
+      - name: Tar logs
+        if: failure()
+        run: tar cvzf ./logs.tgz ./logs
+
+      - name: Upload logs to GitHub
+        if: failure()
+        uses: actions/upload-artifact@master
+        with:
+          name: logs.tgz
+          path: ./logs.tgz

examples/truffle/test/erc20.spec.js

@@ -211,8 +211,7 @@ contract('ERC20', (accounts) => {
     const balance02 = await token.balanceOf.call(accounts[ 0 ])
     assert.strictEqual(balance02.toNumber(), 9980)
   })
-
-  /* eslint-disable no-underscore-dangle */
+
   it('events: should fire Transfer event properly', async () => {
     const res = await token.transfer(accounts[ 1 ], '2666', { from: accounts[ 0 ], gasPrice: 0 })
     const transferLog = res.logs.find(

integration-tests/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    "extends": "../.eslintrc.js"
+}

integration-tests/package.json

@@ -8,7 +8,7 @@
   "scripts": {
     "lint": "yarn lint:fix && yarn lint:check",
     "lint:fix": "prettier --config ./.prettierrc.json --write 'test/**/*.ts'",
-    "lint:check": "tslint --format stylish --project .",
+    "lint:check": "eslint -c .eslintrc.js --ext .ts --format stylish .",
     "build:integration": "./scripts/build.sh",
     "build:contracts": "hardhat compile",
     "build:contracts:ovm": "hardhat compile --network optimism",
@@ -23,15 +23,25 @@
     "@ethersproject/providers": "^5.0.24",
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-waffle": "^2.0.1",
-    "@types/chai-as-promised": "^7.1.3",
     "@types/chai": "^4.2.17",
+    "@types/chai-as-promised": "^7.1.3",
     "@types/mocha": "^8.2.2",
     "@types/rimraf": "^3.0.0",
     "@types/shelljs": "^0.8.8",
+    "@typescript-eslint/eslint-plugin": "^4.26.0",
+    "@typescript-eslint/parser": "^4.26.0",
     "chai": "^4.3.3",
     "chai-as-promised": "^7.1.1",
     "docker-compose": "^0.23.8",
     "envalid": "^7.1.0",
+    "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-react": "^7.24.0",
+    "eslint-plugin-unicorn": "^32.0.1",
     "ethereum-waffle": "^3.3.0",
     "ethers": "^5.0.32",
     "hardhat": "^2.2.1",

integration-tests/tsconfig.json

@@ -3,6 +3,6 @@
   "compilerOptions": {
       "resolveJsonModule": true
   },
-  "include": ["./test", "sync-tests/*.ts"],
+  "include": ["./test", "sync-tests/*.ts", "./artifacts/**/*.json", "./artifacts-ovm/**/*.json"],
   "files": ["./hardhat.config.ts"]
 }

packages/batch-submitter/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    "extends": "../../.eslintrc.js"
+}

packages/batch-submitter/package.json

@@ -14,7 +14,7 @@
     "clean": "rimraf cache/ dist/ ./tsconfig.build.tsbuildinfo",
     "lint": "yarn lint:fix && yarn lint:check",
     "lint:fix": "prettier --config .prettierrc.json --write \"hardhat.config.ts\" \"{src,exec,test}/**/*.ts\"",
-    "lint:check": "tslint --format stylish --project .",
+    "lint:check": "eslint -c .eslintrc.js --ext .ts --format stylish .",
     "test": "hardhat test --show-stack-traces"
   },
   "keywords": [
@@ -57,7 +57,17 @@
     "@types/rimraf": "^3.0.0",
     "@types/sinon": "^9.0.10",
     "@types/sinon-chai": "^3.2.5",
+    "@typescript-eslint/eslint-plugin": "^4.26.0",
+    "@typescript-eslint/parser": "^4.26.0",
     "chai": "^4.2.0",
+    "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-react": "^7.24.0",
+    "eslint-plugin-unicorn": "^32.0.1",
     "ethereum-waffle": "3.0.0",
     "ganache-core": "^2.13.2",
     "hardhat": "^2.2.1",
@@ -66,10 +76,6 @@
     "rimraf": "^2.6.3",
     "sinon": "^9.2.4",
     "sinon-chai": "^3.5.0",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-no-focused-test": "^0.5.0",
-    "tslint-plugin-prettier": "^2.3.0",
     "typescript": "^4.2.3"
   },
   "resolutions": {

packages/batch-submitter/src/batch-submitter/batch-submitter.ts

@@ -1,7 +1,7 @@
 /* External Imports */
 import { Contract, Signer, utils, providers } from 'ethers'
 import { TransactionReceipt } from '@ethersproject/abstract-provider'
-import { Gauge, Histogram } from 'prom-client'
+import { Gauge, Histogram, Counter } from 'prom-client'
 import * as ynatm from '@eth-optimism/ynatm'
 import { RollupInfo } from '@eth-optimism/core-utils'
 import { Logger, Metrics } from '@eth-optimism/common-ts'
@@ -24,6 +24,9 @@ interface BatchSubmitterMetrics {
   numTxPerBatch: Histogram<string>
   submissionTimestamp: Histogram<string>
   submissionGasUsed: Histogram<string>
+  batchesSubmitted: Counter<string>
+  failedSubmissions: Counter<string>
+  malformedBatches: Counter<string>
 }
 
 export abstract class BatchSubmitter {
@@ -240,6 +243,7 @@ export abstract class BatchSubmitter {
         this.logger
       )
     } catch (err) {
+      this.metrics.failedSubmissions.inc()
       if (err.reason) {
         this.logger.error(`Transaction invalid: ${err.reason}, aborting`, {
           message: err.toString(),
@@ -259,6 +263,7 @@ export abstract class BatchSubmitter {
 
     this.logger.info('Received transaction receipt', { receipt })
     this.logger.info(successMessage)
+    this.metrics.batchesSubmitted.inc()
     this.metrics.submissionGasUsed.observe(receipt.gasUsed.toNumber())
     this.metrics.submissionTimestamp.observe(Date.now())
     return receipt
@@ -293,6 +298,21 @@ export abstract class BatchSubmitter {
         help: 'Gas used to submit each batch',
         registers: [metrics.registry],
       }),
+      batchesSubmitted: new metrics.client.Counter({
+        name: 'batches_submitted',
+        help: 'Count of batches submitted',
+        registers: [metrics.registry],
+      }),
+      failedSubmissions: new metrics.client.Counter({
+        name: 'failed_submissions',
+        help: 'Count of failed batch submissions',
+        registers: [metrics.registry],
+      }),
+      malformedBatches: new metrics.client.Counter({
+        name: 'malformed_batches',
+        help: 'Count of malformed batches',
+        registers: [metrics.registry],
+      }),
     }
   }
 }

packages/batch-submitter/src/batch-submitter/tx-batch-submitter.ts

@@ -301,6 +301,7 @@ export class TransactionBatchSubmitter extends BatchSubmitter {
     // Fix our batches if we are configured to. TODO: Remove this.
     batch = await this._fixBatch(batch)
     if (!(await this._validateBatch(batch))) {
+      this.metrics.malformedBatches.inc()
       return
     }
     let sequencerBatchParams = await this._getSequencerBatchParams(