Skip to content

Commit

Permalink
docs: add missing env vars
Browse files Browse the repository at this point in the history
  • Loading branch information
parketh committed Nov 6, 2024
1 parent a164c00 commit 4d7b243
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# OP Chain Deployment (with BTC staking support)

This repo contains:

- commands to deploy an OP-Stack chain with Babylon BTC staking support.
- commands to deploy a local L1 chain to help with development.

Expand All @@ -24,8 +25,8 @@ make l1-configure

This will generate a new wallet `configs/l1/l1-prefund-wallet.json` and pre-fund it with ETH at genesis. If you don't want to use the auto-generated wallet, you can update the `configs/l1/network_params.yaml` file manually to use your own wallet address.

You can also find the L1 chain ID and RPC ports for the JSON RPC and Beacon API in the `network_params.yaml` file ([reference](https://github.com/ethpandaops/ethereum-package
)):
You can also find the L1 chain ID and RPC ports for the JSON RPC and Beacon API in the `network_params.yaml` file ([reference](https://github.com/ethpandaops/ethereum-package)):

- JSON RPC: `http://localhost:<EL_PORT_START + 2>`
- Beacon API: `http://localhost:<CL_PORT_START + 1>`

Expand Down Expand Up @@ -58,12 +59,19 @@ cp .env.bridge.example .env.bridge
```

Update the `.env` file with the correct values.

- `L1_RPC_URL`: the L1 JSON-RPC URL.
- `L1_BEACON_URL`: the L1 Beacon API that [supports blobs](https://docs.optimism.io/builders/node-operators/management/blobs) (Note: not many RPC providers support this).
- `L1_CHAIN_ID`: the L1 chain ID.
- `L1_FUNDED_PRIVATE_KEY`: this will be used to fund a few L2 admin accounts with ETH.
- `L2_CHAIN_ID`: the L2 chain ID.
- `L2_CHAIN_NAME`: the L2 chain name.
- `BATCH_INBOX_ADDRESS`: the batch inbox address, set by convention to `0xff<version_4_bytes>000...000<chain_id>` (e.g. `0xff00010000000000000000000000000000706114` for chain ID `706114` deployment version `1`).
- `L2_RPC_URL`: the L2 JSON-RPC URL, set to `http://<l2-server-ip>:9545`.
- `L2_EXPLORER_URL`: the L2 explorer URL, set to `http://<l2-server-ip>`.

Update the `.env.explorer` file with the correct values.

- `COMMON_HOST`: the IP address of the server running the L2 components.

Note that you don't need to update the `.env.bridge` file b/c it's set in `make l2-launch`.
Expand Down

0 comments on commit 4d7b243

Please sign in to comment.