opnode

README

opnode

This is the reference implementation of the rollup-node spec.

Compiling

From the repository root:

go build -o op ./op-node/cmd
go test ./op-node/...

Running

Options can be reviewed with:

./op --help

To start syncing the rollup:

Connect to at least one L1 RPC and L2 execution engine:

• L1: use any L1 node / RPC (websocket connection path may differ)
• L2: run the Optimism fork of geth: https://github.com/ethereum-optimism/reference-optimistic-geth

Initialize the L2 chain with a genesis.json chain spec like L1, with the Merge fork activated from genesis.

Specify genesis details:

• L1 number / hash: starting-point of L2 chain inputs
• L2 genesis hash: to confirm we are building on the correct L2 genesis

# 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 \
  --genesis.l1-num=.... --genesis.l1-hash=..... --genesis.l2-hash=....

Documentation

Index

• func NewConfig(ctx *cli.Context, log log.Logger) (*node.Config, error)
• func NewDriverConfig(ctx *cli.Context) (*driver.Config, error)
• func NewL1EndpointConfig(ctx *cli.Context) (*node.L1EndpointConfig, error)
• func NewL2EndpointConfig(ctx *cli.Context, log log.Logger) (*node.L2EndpointConfig, error)
• func NewLogConfig(ctx *cli.Context) (node.LogConfig, error)
• func NewRollupConfig(ctx *cli.Context) (*rollup.Config, error)
• func NewSnapshotLogger(ctx *cli.Context) (log.Logger, error)

Functions

func NewConfig

func NewConfig(ctx *cli.Context, log log.Logger) (*node.Config, error)

NewConfig creates a Config from the provided flags or environment variables.

func NewDriverConfig

func NewDriverConfig(ctx *cli.Context) (*driver.Config, error)

func NewL1EndpointConfig

func NewL1EndpointConfig(ctx *cli.Context) (*node.L1EndpointConfig, error)

func NewL2EndpointConfig

func NewL2EndpointConfig(ctx *cli.Context, log log.Logger) (*node.L2EndpointConfig, error)

func NewLogConfig

func NewLogConfig(ctx *cli.Context) (node.LogConfig, error)

NewLogConfig creates a log config from the provided flags or environment variables.

func NewRollupConfig

func NewRollupConfig(ctx *cli.Context) (*rollup.Config, error)

func NewSnapshotLogger

func NewSnapshotLogger(ctx *cli.Context) (log.Logger, error)