forked from ethereum-optimism/optimism
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
op-node: cleanup readme (ethereum-optimism#10679)
* op-node: cleanup readme The readme hasn't been updated in some time, this updates the readme with the latest information as a lot of the information has been deprecated. This will make it more intuitive for how to use the `op-node` to generate the L2 genesis for a network. Also adds a simple `doctoc` recipe to the `Makefile` as other `README` files in the repo do the same thing. * readme: update
- Loading branch information
Showing
2 changed files
with
62 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,105 @@ | ||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* | ||
|
|
||
| - [op-node](#op-node) | ||
| - [Compiling](#compiling) | ||
| - [Testing](#testing) | ||
| - [Running](#running) | ||
| - [L2 Genesis Generation](#l2-genesis-generation) | ||
| - [L1 Devnet Genesis Generation](#l1-devnet-genesis-generation) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| # op-node | ||
|
|
||
| This is the reference implementation of the [rollup-node spec](https://github.com/ethereum-optimism/specs/blob/main/specs/protocol/rollup-node.md). | ||
| It can be thought of like the consensus layer client of an OP Stack chain where it must run with an OP Stack execution layer client | ||
| like [op-geth](https://github.com/ethereum-optimism/op-geth). | ||
|
|
||
| ## Compiling | ||
|
|
||
| Compile a binary: | ||
|
|
||
| ```shell | ||
| cd op-node | ||
| go build -o bin/op-node ./cmd | ||
| make op-node | ||
| ``` | ||
|
|
||
| ## Testing | ||
|
|
||
| Run op-node unit tests: | ||
| ```shell | ||
| cd op-node | ||
| go test ./... | ||
| ``` | ||
|
|
||
| Run end-to-end tests: | ||
| ```shell | ||
| cd op-e2e | ||
| go test ./... | ||
| make test | ||
| ``` | ||
|
|
||
| ## Running | ||
|
|
||
| Options can be reviewed with: | ||
| Configuration options can be reviewed with: | ||
|
|
||
| ```shell | ||
| ./bin/op-node --help | ||
| ``` | ||
|
|
||
| [eth-json-rpc-spec]: https://ethereum.github.io/execution-apis/api-documentation | ||
|
|
||
| To start syncing the rollup: | ||
|
|
||
| Connect to at least one L1 RPC and L2 execution engine: | ||
| Connect to one L1 Execution Client that supports the [Ethereum JSON-RPC spec][eth-json-rpc-spec], | ||
| an L1 Consensus Client that supports the [Beacon Node API](https://ethereum.github.io/beacon-APIs) and | ||
| an OP Stack based Execution Client that supports the [Ethereum JSON-RPC spec][eth-json-rpc-spec]: | ||
|
|
||
| - L1: use any L1 node / RPC (websocket connection path may differ) | ||
| - L2: run the Optimism fork of geth: [`op-geth`](https://github.com/ethereum-optimism/op-geth) | ||
| - L1: use any L1 client, RPC, websocket, or IPC (connection config may differ) | ||
| - L2: use any OP Stack Execution Client like [`op-geth`](https://github.com/ethereum-optimism/op-geth) | ||
|
|
||
| Note that websockets or IPC preferred for event notifications to improve sync, http RPC works with adaptive polling. | ||
|
|
||
| ```shell | ||
| # websockets or IPC preferred for event notifications to improve sync, http RPC works with adaptive polling. | ||
| op \ | ||
| --l1=ws://localhost:8546 --l2=ws//localhost:9001 \ | ||
| ./bin/op-node \ | ||
| --l1=ws://localhost:8546 \ | ||
| --l1.beacon=http://localhost:4000 \ | ||
| --l2=ws://localhost:9001 \ | ||
| --rollup.config=./path-to-network-config/rollup.json \ | ||
| --rpc.addr=127.0.0.1 \ | ||
| --rpc.port=7000 | ||
| ``` | ||
|
|
||
| ## Devnet Genesis Generation | ||
| ## L2 Genesis Generation | ||
|
|
||
| The `op-node` can generate geth compatible `genesis.json` files. These files | ||
| can be used with `geth init` to initialize the `StateDB` with accounts, storage, | ||
| code and balances. The L2 state must be initialized with predeploy contracts | ||
| that exist in the state and act as system level contracts. The `op-node` can | ||
| generate a genesis file with these predeploys configured correctly given | ||
| hardhat compilation artifacts, hardhat deployment artifacts, a L1 RPC URL | ||
| and a deployment config. | ||
| an L1 RPC URL, a deploy config, L2 genesis allocs and a L1 deployments artifact. | ||
|
|
||
| The deploy config contains all of the config required to deploy the | ||
| system. Examples can be found in `packages/contracts-bedrock/deploy-config`. Each | ||
| deploy config file is a JSON file. The L2 allocs can be generated using a forge script | ||
| in the `contracts-bedrock` package and the L1 deployments are a JSON file that is the | ||
| output of doing a L1 contracts deployment. | ||
|
|
||
| The hardhat compilation artifacts are produced by `hardhat compile`. The native | ||
| hardhat compiler toolchain produces them by default and the | ||
| `@foundry-rs/hardhat` plugin can also produce them when using the foundry | ||
| compiler toolchain. They can usually be found in an `artifacts` directory. | ||
| Example usage: | ||
|
|
||
| The hardhat deployment artifacts are produced by running `hardhat deploy`. These | ||
| exist to make it easy to track deployments of smart contract systems over time. | ||
| They can usually be found in a `deployments` directory. | ||
| ```bash | ||
| $ ./bin/op-node genesis l2 \ | ||
| --l1-rpc $ETH_RPC_URL \ | ||
| --deploy-config <PATH_TO_MY_DEPLOY_CONFIG> \ | ||
| --l2-allocs <PATH_TO_L2_ALLOCS> \ | ||
| --l1-deployments <PATH_TO_L1_DEPLOY_ARTIFACT> \ | ||
| --outfile.l2 <PATH_TO_WRITE_L2_GENESIS> \ | ||
| --outfile.rollup <PATH_TO_WRITE_OP_NODE_CONFIG> | ||
| ``` | ||
|
|
||
| The deployment config contains all of the information required to deploy the | ||
| system. It can be found in `packages/contracts-bedrock/deploy-config`. Each | ||
| deploy config file can be JSON or TypeScript, although only JSON files are | ||
| supported by the `op-node`. The network name must match the name of the file | ||
| in the deploy config directory. | ||
| ## L1 Devnet Genesis Generation | ||
|
|
||
| Example usage: | ||
| It is also possible to generate a devnet L1 `genesis.json` file. The L1 allocs can | ||
| be generated with the foundry L1 contracts deployment script if the extra parameter | ||
| `--sig 'runWithStateDump()` is added to the deployment command. | ||
|
|
||
| ```bash | ||
| $ op-node genesis devnet-l2 \ | ||
| --artifacts $CONTRACTS_BEDROCK/artifacts \ | ||
| --network $NETWORK \ | ||
| --deployments $CONTRACTS_BEDROCK/deployments \ | ||
| $ ./bin/op-node genesis l1 \ | ||
| --deploy-config $CONTRACTS_BEDROCK/deploy-config \ | ||
| --rpc-url http://localhost:8545 \ | ||
| --l1-deployments <PATH_TO_L1_DEPLOY_ARTIFACT> \ | ||
| --l1-allocs <PATH_TO_L1_ALLOCS> | ||
| ``` |