Skip to content

Commit

Permalink
chore: update readme (#30)
Browse files Browse the repository at this point in the history
  • Loading branch information
lesterli authored Nov 2, 2024
1 parent 1dd78c6 commit b379fde
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 6 deletions.
7 changes: 4 additions & 3 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ BATCH_INBOX_ADDRESS=0xff00000000000000000000000000000000042069
FINALIZATION_PERIOD_SECONDS=12
ENABLE_GOVERNANCE=false

# Finality gadget RPC
# note: use external host address to avoid cross-container calls
BBN_FINALITY_GADGET_RPC=11.22.33.44:50051
# Finality gadget gRPC
# note: set it after the Finality Gadget is up
# example value: 11.22.33.44:50051
BBN_FINALITY_GADGET_RPC=

## mnemonic "test test test test test test test test test test test junk"

Expand Down
64 changes: 61 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ Then update environment variables in the `.env` files.

### Setup the network parameters

```
```bash
make l1-configure
```

**Note:** It will generate a new wallet `configs/l1/l1-prefund-wallet.json` and update the `configs/l1/network_params.yaml` file with the address to use for the prefunded account. You can update the `configs/l1/network_params.yaml` file manually to use an existing wallet.

### Launch with kurtosis and ethereum-package

```
```bash
make l1-launch
```

### Remove the local L1 chain

```
```bash
make l1-remove
```

Expand All @@ -43,3 +43,61 @@ make l1-remove
- Update the `L1_CHAIN_ID` with the value of the `network_id` in the `network_params` section
- Update the `L1_RPC_URL` to `http://localhost:<EL_PORT_START + 2>`, where `EL_PORT_START` is the value of `public_port_start` in the `el` section
- Update the `L1_BEACON_URL` to `http://localhost:<CL_PORT_START + 1>`, where `CL_PORT_START` is the value of `public_port_start` in the `cl` section

## Launch OP Stack L2

### Set the environment variables

```bash
cp .env.example .env
cp .env.explorer.example .env.explorer
cp .env.bridge.example .env.bridge
```

For the local L1, the L1 chain ID and pre-funded account private key can be retrieved from the L1 server (see steps above).
- `L1_CHAIN_ID`
- `L1_FUNDED_PRIVATE_KEY`

Please update this value after the Finality Gadget is up, and restart the L2 op-node.
- `BBN_FINALITY_GADGET_RPC`

### Launch L2

```bash
make l2-launch
```

after it's up, you can test with:

```bash
make l2-verify # on the L2 server
cast block latest --rpc-url http://<l2-server-ip>:9545 # from anywhere (with foundry installed)
```

You can also access the explorer at http://<l2-server-ip>:3001/ and bridge UI at http://<l2-server-ip>:3002/

### Restart L2

only restart l2 op-node

```bash
make l2-op-node-restart
```

restart all l2 components

```bash
make l2-restart
```

restart l2 explorer

```bash
make l2-explorer-restart
```

restart l2 bridge

```bash
make l2-bridge-restart
```

0 comments on commit b379fde

Please sign in to comment.