cleanup: delete message-relayer

The `message-relayer` was a legacy server that
was responsible for relaying withdrawals. It has
not been maintained and is no longer used as part
of the devnet system. Keeping it around adds
additional maintainance burden for the team, especially
as things like 2 step withdrawals require it to be
refactored.

.circleci/config.yml

@@ -92,7 +92,6 @@ jobs:
             - "packages/drippie-mon/node_modules"
             - "packages/fault-detector/node_modules"
             - "packages/hardhat-deploy-config/node_modules"
-            - "packages/message-relayer/node_modules"
             - "packages/migration-data/node_modules"
             - "packages/replica-healthcheck/node_modules"
             - "packages/sdk/node_modules"
@@ -1201,13 +1200,6 @@ workflows:
           dependencies: "(common-ts|contracts|core-utils|sdk)"
           requires:
             - yarn-monorepo
-      - js-lint-test:
-          name: message-relayer-tests
-          coverage_flag: message-relayer-tests
-          package_name: message-relayer
-          dependencies: "(common-ts|core-utils|sdk)"
-          requires:
-            - yarn-monorepo
       - js-lint-test:
           name: replica-healthcheck-tests
           coverage_flag: replica-healthcheck-tests

.github/CODEOWNERS

@@ -10,7 +10,6 @@
 /packages/chain-mon             @smartcontracts
 /packages/fault-detector        @ethereum-optimism/devxpod
 /packages/hardhat-deploy-config @ethereum-optimism/legacy-reviewers
-/packages/message-relayer       @ethereum-optimism/legacy-reviewers
 /packages/migration-data        @ethereum-optimism/legacy-reviewers
 /packages/replica-healthcheck   @ethereum-optimism/legacy-reviewers
 /packages/sdk                   @ethereum-optimism/devxpod

.github/workflows/publish-canary.yml

@@ -16,7 +16,6 @@ jobs:
     # map the step outputs to job outputs
     outputs:
       l2geth: ${{ steps.packages.outputs.l2geth }}
-      message-relayer: ${{ steps.packages.outputs.message-relayer }}
       fault-detector: ${{ steps.packages.outputs.fault-detector }}
       balance-mon: ${{ steps.packages.outputs.balance-mon }}
       drippie-mon: ${{ steps.packages.outputs.drippie-mon }}
@@ -149,33 +148,6 @@ jobs:
           push: true
           tags: ethereumoptimism/hardhat-node:${{ needs.canary-publish.outputs.canary-docker-tag }}
 
-  message-relayer:
-    name: Publish Message Relayer Version ${{ needs.canary-publish.outputs.canary-docker-tag }}
-    needs: canary-publish
-    if: needs.canary-publish.outputs.message-relayer != ''
-    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: Build and push
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./ops/docker/Dockerfile.packages
-          target: message-relayer
-          push: true
-          tags: ethereumoptimism/message-relayer:${{ needs.canary-publish.outputs.canary-docker-tag }}
-
   fault-detector:
     name: Publish Fault Detector Version ${{ needs.canary-publish.outputs.canary-docker-tag }}
     needs: canary-publish

.github/workflows/release.yml

@@ -15,7 +15,6 @@ jobs:
     # map the step outputs to job outputs
     outputs:
       l2geth: ${{ steps.packages.outputs.l2geth }}
-      message-relayer: ${{ steps.packages.outputs.message-relayer }}
       fault-detector: ${{ steps.packages.outputs.fault-detector }}
       balance-mon: ${{ steps.packages.outputs.drippie-mon }}
       drippie-mon: ${{ steps.packages.outputs.drippie-mon }}
@@ -198,33 +197,6 @@ jobs:
             GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
             GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
 
-  message-relayer:
-    name: Publish Message Relayer Version ${{ needs.release.outputs.message-relayer }}
-    needs: release
-    if: needs.release.outputs.message-relayer != ''
-    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: Build and push
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./ops/docker/Dockerfile.packages
-          target: message-relayer
-          push: true
-          tags: ethereumoptimism/message-relayer:${{ needs.release.outputs.message-relayer }},ethereumoptimism/message-relayer:latest
-
   fault-detector:
     name: Publish Fault Detector Version ${{ needs.release.outputs.fault-detector }}
     needs: release

.vscode/settings.json

@@ -28,10 +28,6 @@
       "directory": "packages/chain-mon",
       "changeProcessCWD": true
     },
-    {
-      "directory": "packages/message-relayer",
-      "changeProcessCWD": true
-    },
     {
       "directory": "packages/fault-detector",
       "changeProcessCWD": true

CONTRIBUTING.md

@@ -127,7 +127,6 @@ This will build the following containers:
 * [`dtl`](https://hub.docker.com/r/ethereumoptimism/data-transport-layer): service that indexes transaction data from the L1 chain
 * [`l2geth`](https://hub.docker.com/r/ethereumoptimism/l2geth): L2 geth node running in Sequencer mode
 * [`verifier`](https://hub.docker.com/r/ethereumoptimism/go-ethereum): L2 geth node running in Verifier mode
-* [`relayer`](https://hub.docker.com/r/ethereumoptimism/message-relayer): helper process that relays messages between L1 and L2
 
 If you want to make a change to a container, you'll need to take it down and rebuild it.
 For example, if you make a change in l2geth:

README.md

@@ -57,7 +57,6 @@ Refer to the Directory Structure section below to understand which packages are
 │   ├── <a href="./packages/data-transport-layer">data-transport-layer</a>: Service for indexing Optimism-related L1 data
 │   ├── <a href="./packages/chain-mon">chain-mon</a>: Chain monitoring services
 │   ├── <a href="./packages/fault-detector">fault-detector</a>: Service for detecting Sequencer faults
-│   ├── <a href="./packages/message-relayer">message-relayer</a>: Tool for automatically relaying L1<>L2 messages in development
 │   ├── <a href="./packages/replica-healthcheck">replica-healthcheck</a>: Service for monitoring the health of a replica node
 │   └── <a href="./packages/sdk">sdk</a>: provides a set of tools for interacting with Optimism
 ├── <a href="./op-bindings">op-bindings</a>: Go bindings for Bedrock smart contracts.
@@ -86,7 +85,6 @@ Refer to the Directory Structure section below to understand which packages are
 │   ├── <a href="./packages/data-transport-layer">data-transport-layer</a>: Service for indexing Optimism-related L1 data
 │   ├── <a href="./packages/chain-mon">chain-mon</a>: Chain monitoring services
 │   ├── <a href="./packages/fault-detector">fault-detector</a>: Service for detecting Sequencer faults
-│   ├── <a href="./packages/message-relayer">message-relayer</a>: Tool for automatically relaying L1<>L2 messages in development
 │   ├── <a href="./packages/replica-healthcheck">replica-healthcheck</a>: Service for monitoring the health of a replica node
 │   └── <a href="./packages/sdk">sdk</a>: provides a set of tools for interacting with Optimism
 ├── <a href="./indexer">indexer</a>: indexes and syncs transactions

codecov.yml

@@ -39,6 +39,5 @@ flag_management:
     - name: dtl-tests
     - name: chain-mon-tests
     - name: fault-detector-tests
-    - name: message-relayer-tests
     - name: replica-healthcheck-tests
     - name: sdk-tests

ops/docker-compose.yml

-version: '3.4'
-
-x-system-addr-env: &system-addr-env
-  # private key: a6aecc98b63bafb0de3b29ae9964b14acb4086057808be29f90150214ebd4a0f
-  # OK to publish this since it will only ever be used in itests
-  SYSTEM_ADDRESS_0_DEPLOYER: '0xa961b0d6dce82db098cf70a42a14add3ee3db2d5'
-
-  # private key: 3b8d2345102cce2443acb240db6e87c8edd4bb3f821b17fab8ea2c9da08ea132
-  # OK to publish this since it will only ever be used in itests
-  SYSTEM_ADDRESS_1_DEPLOYER: '0xdfc82d475833a50de90c642770f34a9db7deb725'
-
-services:
-  # this is a helper service used because there's no official hardhat image
-  l1_chain:
-    image: ethereumoptimism/hardhat-node:${DOCKER_TAG_HARDHAT:-latest}
-    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
-
-  deployer:
-    depends_on:
-      - l1_chain
-    build:
-      context: ..
-      dockerfile: ./ops/docker/Dockerfile.packages
-      target: deployer
-    image: ethereumoptimism/deployer:${DOCKER_TAG_DEPLOYER:-latest}
-    entrypoint: ./deployer.sh
-    environment:
-      # Env vars for the deployment script.
-      CONTRACTS_RPC_URL: http://l1_chain:8545
-      CONTRACTS_DEPLOYER_KEY: 'ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80'
-      CONTRACTS_TARGET_NETWORK: 'local'
-    ports:
-      # expose the service to the host for getting the contract addrs
-      - ${DEPLOYER_PORT:-8080}:8081
-
-  dtl:
-    depends_on:
-      - l1_chain
-      - deployer
-      - l2geth
-    build:
-      context: ..
-      dockerfile: ./ops/docker/Dockerfile.packages
-      target: data-transport-layer
-    image: ethereumoptimism/data-transport-layer:${DOCKER_TAG_DATA_TRANSPORT_LAYER:-latest}
-    # override with the dtl script and the env vars required for it
-    entrypoint: ./dtl.sh
-    env_file:
-      - ./envs/dtl.env
-    # set the rest of the env vars for the network whcih do not
-    # depend on the docker-compose setup
-    environment:
-      # used for setting the address manager address
-      URL: http://deployer:8081/addresses.json
-      # connect to the 2 layers
-      DATA_TRANSPORT_LAYER__L1_RPC_ENDPOINT: http://l1_chain:8545
-      DATA_TRANSPORT_LAYER__L2_RPC_ENDPOINT: http://l2geth:8545
-      DATA_TRANSPORT_LAYER__SYNC_FROM_L2: 'true'
-      DATA_TRANSPORT_LAYER__L2_CHAIN_ID: 17
-    ports:
-      - ${DTL_PORT:-7878}:7878
-
-  l2geth:
-    depends_on:
-      - l1_chain
-      - deployer
-    build:
-      context: ..
-      dockerfile: ./l2geth/Dockerfile
-    image: ethereumoptimism/l2geth:${DOCKER_TAG_L2GETH:-latest}
-    # override with the geth script and the env vars required for it
-    entrypoint: sh ./geth.sh
-    env_file:
-      - ./envs/geth.env
-    environment:
-      <<: *system-addr-env
-      ETH1_HTTP: http://l1_chain:8545
-      ROLLUP_TIMESTAMP_REFRESH: 5s
-      ROLLUP_STATE_DUMP_PATH: http://deployer:8081/state-dump.latest.json
-      # connecting to the DTL
-      ROLLUP_CLIENT_HTTP: http://dtl:7878
-      ETH1_CTC_DEPLOYMENT_HEIGHT: 8
-      RETRIES: 60
-      # no need to keep this secret, only used internally to sign blocks
-      BLOCK_SIGNER_KEY: '6587ae678cf4fc9a33000cdbf9f35226b71dcc6a4684a31203241f9bcfd55d27'
-      BLOCK_SIGNER_ADDRESS: '0x00000398232E2064F896018496b4b44b3D62751F'
-
-      ROLLUP_ENFORCE_FEES: ${ROLLUP_ENFORCE_FEES:-true}
-      ROLLUP_FEE_THRESHOLD_DOWN: 0.9
-      ROLLUP_FEE_THRESHOLD_UP: 1.1
-    ports:
-      - ${L2GETH_HTTP_PORT:-8545}:8545
-      - ${L2GETH_WS_PORT:-8546}:8546
-
-  relayer:
-    depends_on:
-      - l1_chain
-      - l2geth
-    deploy:
-      replicas: 0
-    build:
-      context: ..
-      dockerfile: ./ops/docker/Dockerfile.packages
-      target: message-relayer
-    image: ethereumoptimism/message-relayer:${DOCKER_TAG_MESSAGE_RELAYER:-latest}
-    entrypoint: ./relayer.sh
-    environment:
-      MESSAGE_RELAYER__L1_RPC_PROVIDER: http://l1_chain:8545
-      MESSAGE_RELAYER__L2_RPC_PROVIDER: http://l2geth:8545
-      MESSAGE_RELAYER__L1_WALLET: '0xdbda1821b80551c9d65939329250298aa3472ba22feea921c0cf5d620ea67b97'
-      RETRIES: 60
-
-  fault_detector:
-    depends_on:
-      - l1_chain
-      - l2geth
-    deploy:
-      replicas: 0
-    build:
-      context: ..
-      dockerfile: ./ops/docker/Dockerfile.packages
-      target: fault-detector
-    image: ethereumoptimism/fault-detector:${DOCKER_TAG_FAULT_DETECTOR:-latest}
-    entrypoint: ./detector.sh
-    environment:
-      FAULT_DETECTOR__L1_RPC_PROVIDER: http://l1_chain:8545
-      FAULT_DETECTOR__L2_RPC_PROVIDER: http://l2geth:8545
-      RETRIES: 60
-
-  verifier:
-    depends_on:
-      - l1_chain
-      - deployer
-      - dtl
-      - l2geth
-    deploy:
-      replicas: 1
-    build:
-      context: ..
-      dockerfile: ./l2geth/Dockerfile
-    image: ethereumoptimism/l2geth:${DOCKER_TAG_L2GETH:-latest}
-    entrypoint: sh ./geth.sh
-    env_file:
-      - ./envs/geth.env
-    environment:
-      <<: *system-addr-env
-      ETH1_HTTP: http://l1_chain:8545
-      SEQUENCER_CLIENT_HTTP: http://l2geth:8545
-      ROLLUP_STATE_DUMP_PATH: http://deployer:8081/state-dump.latest.json
-      ROLLUP_CLIENT_HTTP: http://dtl:7878
-      ROLLUP_BACKEND: 'l1'
-      ETH1_CTC_DEPLOYMENT_HEIGHT: 8
-      RETRIES: 60
-      ROLLUP_VERIFIER_ENABLE: 'true'
-    ports:
-      - ${VERIFIER_HTTP_PORT:-8547}:8545
-      - ${VERIFIER_WS_PORT:-8548}:8546
-
-  replica:
-    depends_on:
-      - dtl
-      - l2geth
-    deploy:
-      replicas: 1
-    build:
-      context: ..
-      dockerfile: ./l2geth/Dockerfile
-    image: ethereumoptimism/l2geth:${DOCKER_TAG_L2GETH:-latest}
-    entrypoint: sh ./geth.sh
-    env_file:
-      - ./envs/geth.env
-    environment:
-      <<: *system-addr-env
-      ETH1_HTTP: http://l1_chain:8545
-      SEQUENCER_CLIENT_HTTP: http://l2geth:8545
-      ROLLUP_STATE_DUMP_PATH: http://deployer:8081/state-dump.latest.json
-      ROLLUP_CLIENT_HTTP: http://dtl:7878
-      ROLLUP_BACKEND: 'l2'
-      ROLLUP_VERIFIER_ENABLE: 'true'
-      ETH1_CTC_DEPLOYMENT_HEIGHT: 8
-      RETRIES: 60
-    ports:
-      - ${REPLICA_HTTP_PORT:-8549}:8545
-      - ${REPLICA_WS_PORT:-8550}:8546
-
-  replica_healthcheck:
-    depends_on:
-      - l2geth
-      - replica
-    deploy:
-      replicas: 0
-    build:
-      context: ..
-      dockerfile: ./ops/docker/Dockerfile.packages
-      target: replica-healthcheck
-    image: ethereumoptimism/replica-healthcheck:${DOCKER_TAG_REPLICA_HEALTHCHECK:-latest}
-    environment:
-      HEALTHCHECK__REFERENCE_RPC_PROVIDER: http://l2geth:8545
-      HEALTHCHECK__TARGET_RPC_PROVIDER: http://replica:8545
-    ports:
-      - ${HEALTHCHECK_HTTP_PORT:-7300}:7300

ops/docker/Dockerfile.packages

@@ -94,12 +94,6 @@ COPY ./ops/scripts/dtl.sh .
 CMD ["node", "dist/src/services/run.js"]
 
 
-FROM base as message-relayer
-WORKDIR /opt/optimism/packages/message-relayer
-COPY ./ops/scripts/relayer.sh .
-CMD ["npm", "run", "start"]
-
-
 FROM base as fault-detector
 WORKDIR /opt/optimism/packages/fault-detector
 COPY ./ops/scripts/detector.sh .

packages/message-relayer/.depcheckrc

-ignores: [
-  "@babel/eslint-parser",
-  "@typescript-eslint/parser",
-  "eslint-plugin-import",
-  "eslint-plugin-unicorn",
-  "eslint-plugin-jsdoc",
-  "eslint-plugin-prefer-arrow",
-  "eslint-plugin-react",
-  "@typescript-eslint/eslint-plugin",
-  "eslint-config-prettier",
-  "eslint-plugin-prettier",
-  "chai"
-]

packages/message-relayer/.env.example

-# URL pointing to an L1 RPC provider
-MESSAGE_RELAYER__L1_RPC_PROVIDER=
-
-# URL pointing to an L2 RPC provider
-MESSAGE_RELAYER__L2_RPC_PROVIDER=
-
-# Private key for a wallet with ETH on L1
-MESSAGE_RELAYER__L1_WALLET=
-
-# Optional, L2 block height to start relaying messages from (default is 0)
-MESSAGE_RELAYER__FROM_L2_TRANSACTION_INDEX=

packages/message-relayer/.eslintrc.js

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

packages/message-relayer/.lintstagedrc.yml

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

packages/message-relayer/.prettierrc.js

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

packages/message-relayer/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/message-relayer/README.md

-# @eth-optimism/message-relayer
-
-[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=message-relayer-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
-
-`message-relayer` is a service that automatically finalizes ("relays") messages sent from Optimism to Ethereum.
-This package is meant to be used during local development and should NOT be used on a production network.
-
-## Installation
-
-Clone, install, and build the Optimism monorepo:
-
-```
-git clone https://github.com/ethereum-optimism/optimism.git
-yarn install
-yarn build
-```
-
-## Running the relayer (Docker)
-
-The `message-relayer` can be included as part of the [local Optimism development environment](https://community.optimism.io/docs/developers/build/dev-node/).
-Although the `message-relayer` is not turned on by default, it can be enabled by [changing this line in docker-compose.yml](https://github.com/ethereum-optimism/optimism/blob/51a527b8e3fe69940fb8c0f5e4aa2e0ae8ee294c/ops/docker-compose.yml#L129) to:
-
-```
-replicas: 1
-```
-
-## Running the relayer (manual)
-
-The `message-relayer` can also be run manually.
-Copy `.env.example` into a new file named `.env`, then set the environment variables listed there.
-Once your environment variables have been set, run the relayer via:
-
-```
-yarn start
-```

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.8.9',
-    settings: {
-      optimizer: { enabled: true, runs: 200 },
-      metadata: {
-        bytecodeHash: 'none',
-      },
-      outputSelection: {
-        '*': {
-          '*': ['metadata', 'storageLayout'],
-        },
-      },
-    },
-  },
-}
-
-export default config

packages/message-relayer/package.json

-{
-  "private": true,
-  "name": "@eth-optimism/message-relayer",
-  "version": "0.5.34",
-  "description": "[Optimism] Service for automatically relaying L2 to L1 transactions",
-  "main": "dist/index",
-  "types": "dist/index",
-  "files": [
-    "dist/*"
-  ],
-  "scripts": {
-    "start": "ts-node ./src/service.ts",
-    "test:coverage": "echo 'No tests defined.'",
-    "build": "tsc -p ./tsconfig.json",
-    "clean": "rimraf  dist/ ./tsconfig.tsbuildinfo",
-    "lint": "yarn lint:fix && yarn lint:check",
-    "pre-commit": "lint-staged",
-    "lint:fix": "yarn lint:check --fix",
-    "lint:check": "eslint . --max-warnings=0"
-  },
-  "keywords": [
-    "optimism",
-    "ethereum",
-    "relayer"
-  ],
-  "homepage": "https://github.com/ethereum-optimism/optimism/tree/develop/packages/message-relayer#readme",
-  "license": "MIT",
-  "author": "Optimism PBC",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ethereum-optimism/optimism.git"
-  },
-  "dependencies": {
-    "@eth-optimism/common-ts": "0.8.1",
-    "@eth-optimism/core-utils": "0.12.0",
-    "@eth-optimism/sdk": "2.1.0",
-    "ethers": "^5.7.0"
-  },
-  "devDependencies": {
-    "@ethersproject/abstract-provider": "^5.7.0",
-    "@nomiclabs/hardhat-ethers": "^2.0.2",
-    "@nomiclabs/hardhat-waffle": "^2.0.1",
-    "ethereum-waffle": "^3.3.0",
-    "hardhat": "^2.9.6",
-    "ts-node": "^10.9.1"
-  }
-}

packages/message-relayer/src/index.ts

-export * from './service'

packages/message-relayer/src/service.ts

-/* Imports: External */
-import { Signer } from 'ethers'
-import { getChainId, sleep } from '@eth-optimism/core-utils'
-import {
-  BaseServiceV2,
-  validators,
-  Gauge,
-  Counter,
-} from '@eth-optimism/common-ts'
-import { CrossChainMessenger, MessageStatus } from '@eth-optimism/sdk'
-import { Provider } from '@ethersproject/abstract-provider'
-
-import { version } from '../package.json'
-
-type MessageRelayerOptions = {
-  l1RpcProvider: Provider
-  l2RpcProvider: Provider
-  l1Wallet: Signer
-  fromL2TransactionIndex?: number
-}
-
-type MessageRelayerMetrics = {
-  highestCheckedL2Tx: Gauge
-  highestKnownL2Tx: Gauge
-  numRelayedMessages: Counter
-}
-
-type MessageRelayerState = {
-  wallet: Signer
-  messenger: CrossChainMessenger
-  highestCheckedL2Tx: number
-  highestKnownL2Tx: number
-}
-
-export class MessageRelayerService extends BaseServiceV2<
-  MessageRelayerOptions,
-  MessageRelayerMetrics,
-  MessageRelayerState
-> {
-  constructor(options?: Partial<MessageRelayerOptions>) {
-    super({
-      version,
-      name: 'message-relayer',
-      options,
-      optionsSpec: {
-        l1RpcProvider: {
-          validator: validators.provider,
-          desc: 'Provider for interacting with L1.',
-        },
-        l2RpcProvider: {
-          validator: validators.provider,
-          desc: 'Provider for interacting with L2.',
-        },
-        l1Wallet: {
-          validator: validators.wallet,
-          desc: 'Wallet used to interact with L1.',
-        },
-        fromL2TransactionIndex: {
-          validator: validators.num,
-          desc: 'Index of the first L2 transaction to start processing from.',
-          default: 0,
-          public: true,
-        },
-      },
-      metricsSpec: {
-        highestCheckedL2Tx: {
-          type: Gauge,
-          desc: 'Highest L2 tx that has been scanned for messages',
-        },
-        highestKnownL2Tx: {
-          type: Gauge,
-          desc: 'Highest known L2 transaction',
-        },
-        numRelayedMessages: {
-          type: Counter,
-          desc: 'Number of messages relayed by the service',
-        },
-      },
-    })
-  }
-
-  protected async init(): Promise<void> {
-    this.state.wallet = this.options.l1Wallet.connect(
-      this.options.l1RpcProvider
-    )
-
-    this.state.messenger = new CrossChainMessenger({
-      l1SignerOrProvider: this.state.wallet,
-      l2SignerOrProvider: this.options.l2RpcProvider,
-      l1ChainId: await getChainId(this.state.wallet.provider),
-      l2ChainId: await getChainId(this.options.l2RpcProvider),
-    })
-
-    this.state.highestCheckedL2Tx = this.options.fromL2TransactionIndex || 1
-    this.state.highestKnownL2Tx =
-      await this.state.messenger.l2Provider.getBlockNumber()
-  }
-
-  protected async main(): Promise<void> {
-    // Update metrics
-    this.metrics.highestCheckedL2Tx.set(this.state.highestCheckedL2Tx)
-    this.metrics.highestKnownL2Tx.set(this.state.highestKnownL2Tx)
-
-    // If we're already at the tip, then update the latest tip and loop again.
-    if (this.state.highestCheckedL2Tx > this.state.highestKnownL2Tx) {
-      this.state.highestKnownL2Tx =
-        await this.state.messenger.l2Provider.getBlockNumber()
-
-      // Sleeping for 1000ms is good enough since this is meant for development and not for live
-      // networks where we might want to restrict the number of requests per second.
-      await sleep(1000)
-      return
-    }
-
-    this.logger.info(`checking L2 block ${this.state.highestCheckedL2Tx}`)
-
-    const block =
-      await this.state.messenger.l2Provider.getBlockWithTransactions(
-        this.state.highestCheckedL2Tx
-      )
-
-    // Should never happen.
-    if (block.transactions.length !== 1) {
-      throw new Error(
-        `got an unexpected number of transactions in block: ${block.number}`
-      )
-    }
-
-    const messages = await this.state.messenger.getMessagesByTransaction(
-      block.transactions[0].hash
-    )
-
-    // No messages in this transaction so we can move on to the next one.
-    if (messages.length === 0) {
-      this.state.highestCheckedL2Tx++
-      return
-    }
-
-    // Make sure that all messages sent within the transaction are finalized. If any messages
-    // are not finalized, then we're going to break the loop which will trigger the sleep and
-    // wait for a few seconds before we check again to see if this transaction is finalized.
-    let isFinalized = true
-    for (const message of messages) {
-      const status = await this.state.messenger.getMessageStatus(message)
-      if (
-        status === MessageStatus.IN_CHALLENGE_PERIOD ||
-        status === MessageStatus.STATE_ROOT_NOT_PUBLISHED
-      ) {
-        isFinalized = false
-      }
-    }
-
-    if (!isFinalized) {
-      this.logger.info(
-        `tx not yet finalized, waiting: ${this.state.highestCheckedL2Tx}`
-      )
-      return
-    } else {
-      this.logger.info(
-        `tx is finalized, relaying: ${this.state.highestCheckedL2Tx}`
-      )
-    }
-
-    // If we got here then all messages in the transaction are finalized. Now we can relay
-    // each message to L1.
-    for (const message of messages) {
-      try {
-        const tx = await this.state.messenger.finalizeMessage(message)
-        this.logger.info(`relayer sent tx: ${tx.hash}`)
-        this.metrics.numRelayedMessages.inc()
-      } catch (err) {
-        if (err.message.includes('message has already been received')) {
-          // It's fine, the message was relayed by someone else
-        } else {
-          throw err
-        }
-      }
-      await this.state.messenger.waitForMessageReceipt(message)
-    }
-
-    // All messages have been relayed so we can move on to the next block.
-    this.state.highestCheckedL2Tx++
-  }
-}
-
-if (require.main === module) {
-  const service = new MessageRelayerService()
-  service.run()
-}

packages/message-relayer/tsconfig.json

-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist"
-  },
-  "include": [
-    "package.json",
-    "src/**/*"
-  ]
-}