@eth-optimism/message-relayer
v0.4.0
Published
[Optimism] Service for automatically relaying L2 to L1 transactions
Downloads
261
Readme
@eth-optimism/message-relayer
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.
Although the message-relayer
is not turned on by default, it can be enabled by changing this line in docker-compose.yml 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