Merge pull request #38 from ironbeer/support-granite

Support for Granite upgrade

Author: tak1827

.env.sample.mainnet

@@ -1,6 +1,7 @@
 # Layer1 settings
 L1_CHAIN_ID=248
 L1_ETH_RPC_HTTP=https://rpc.mainnet.oasys.games/
+L1_BEACON_API=https://beacon-api.mainnet.oasys.games/
 
 # Layer2 settings
 OP_CHAIN_ID=<L2 Chain ID>
@@ -68,3 +69,10 @@ OP_ENGINE_RPC=ws://op-geth:8551
 OP_ROLLUP_RPC=http://op-node:8547
 OP_ENGINE_REPLICA_RPC=ws://op-geth-replica:8551
 OP_ROLLUP_REPLICA_RPC=http://op-node-replica:8547
+
+# Block timestamps for upgrades (empty = no upgrade)
+OP_OVERRIDE_CANYON=
+OP_OVERRIDE_DELTA=
+OP_OVERRIDE_ECOTONE=
+OP_OVERRIDE_FJORD=
+OP_OVERRIDE_GRANITE=

.env.sample.private

@@ -0,0 +1,86 @@
+#################################################
+# WARNING: DO NOT USE THIS ENV FILE FOR MAINNET #
+#################################################
+
+# Layer1 settings
+L1_CHAIN_ID=12345
+L1_ETH_RPC_HTTP=http://host.docker.internal:8080/rpc
+L1_BEACON_API=http://host.docker.internal:8080/beacon-api
+
+# Layer2 settings
+OP_CHAIN_ID=4200
+# address of the `L2OutputOracleProxy` contract on L1
+OP_L2OO_ADDR=0x99C0965A4527c785c712fD25142184C346D52163
+# address of the `AddressManager` contract on L1
+OP_AM_ADDR=0x0000000000000000000000000000000000000000
+# address of the `L1CrossDomainMessengerProxy` contract on L1
+OP_L1CDM_ADDR=0xB6F91848c6eDA8E6c558bE39161DD9938ac249aa
+# address of the `L1StandardBridgeProxy` contract on L1
+OP_L1BRIDGE_ADDR=0x50FCa4b3e77E50bfA359B0110fe9900D7C85689a
+# address of the `OptimismPortalProxy` contract on L1
+OP_PORTAL_ADDR=0x28C0A2d63dA3B02da3DDAa18571F5B7Ee57d2893
+
+# `verse-verifier` settings
+VERIFIER_EXTRA_ARGS="
+--config.p2p.no_announce=
+--config.p2p.connection_filter=
+--config.p2p.bootnodes=/dns4/host.docker.internal/tcp/4101/p2p/12D3KooWGXJ4BoXZupp2wzAr7dfyspRLaoYW4qPvVGoacGAUiSh2
+--config.p2p.bootnodes=/dns4/host.docker.internal/udp/4101/quic/p2p/12D3KooWGXJ4BoXZupp2wzAr7dfyspRLaoYW4qPvVGoacGAUiSh2
+"
+
+# Wallets
+## Builder and FinalSystemOwner (Hardhat #0)
+## Address: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
+## Key    : 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+
+## `op-node` use for p2p sync with replicas
+P2P_SEQUENCER_ADDR=0xa914B9cA99677b5B9B4931D25Cd634aA9D10C537
+P2P_SEQUENCER_KEY=0xeeee8a7eebe8a995ede500b69e0c9ec0bf5989c1578d41fd1a27c0709f3dd1c6
+
+## `op-proposer` uses for state submission to the `L2OutputOracle` contract on L1
+OP_PROPOSER_ADDR=0xa8d4AcF8081A20d2EFb2229169bc52750Cb085D4
+OP_PROPOSER_KEY=0xc976cf0e2873300774d216faf1932d45d23256c54293211ea2aa0689d7667d2b
+
+## `op-batcher` uses for batch submission to the `OP_BATCH_INBOX_ADDR` on L1
+OP_BATCHER_ADDR=0xEd98afe5ED8424A251DD0b7813f67DB2833531eF
+OP_BATCHER_KEY=0xb8971409b424ef3c5bc0ca867b94d81b7fdb2dcbe5625b0906d332359b09c046
+
+## `op-message-relayer` uses for messaging from L2 to L1
+MR_PROVER_ADDR=0x99B7D33BA84b9Fab2D331509FFd4906548A681FC
+MR_PROVER_KEY=0x6c1d63f432685ac07d19058000c92aa24b393880ebb860222d1bcc870b5a84ab
+MR_FINALIZER_ADDR=0x6a9a1914b1080C0C0409565A1536B338fb1E51De
+MR_FINALIZER_KEY=0x2033aa4d6ddf71c0c486aa722e9eb10aa760a2cde2f38d505a229ed8ebc659ed
+
+## `verse-verifier` is used for submitting signatures to the L1 verification contract.
+VERIFY_SUBMITTER_ADDR=0x10478e792D994af202DBbA22503A8Fb0D33cB945
+VERIFY_SUBMITTER_KEY=0x3b0c64671c43eb66afb38fdd6a25616216a4a96820cdb919d175121f4375117e
+
+# Container published ports
+## op-geth
+OP_ETH_RPC_HTTP_PORT=18545
+OP_ETH_RPC_WS_PORT=18546
+
+## op-node
+OP_ROLLUP_RPC_PORT=8547
+OP_ROLLUP_P2P_PORT=9222
+
+## verse-verifier
+VERIFIER_P2P_PORT=4102
+
+## message-relayer
+RELAYER_HTTP_PORT=7300
+
+# internal endpointss
+OP_ETH_RPC_HTTP=http://op-geth:8545
+OP_ETH_RPC_WS=ws://op-geth:8546
+OP_ENGINE_RPC=ws://op-geth:8551
+OP_ROLLUP_RPC=http://op-node:8547
+OP_ENGINE_REPLICA_RPC=ws://op-geth-replica:8551
+OP_ROLLUP_REPLICA_RPC=http://op-node-replica:8547
+
+# Block timestamps for upgrades (empty = no upgrade)
+OP_OVERRIDE_CANYON=
+OP_OVERRIDE_DELTA=
+OP_OVERRIDE_ECOTONE=
+OP_OVERRIDE_FJORD=
+OP_OVERRIDE_GRANITE=

.env.sample.testnet

@@ -1,6 +1,7 @@
 # Layer1 settings
 L1_CHAIN_ID=9372
 L1_ETH_RPC_HTTP=https://rpc.testnet.oasys.games/
+L1_BEACON_API=https://beacon-api.testnet.oasys.games/
 
 # Layer2 settings
 OP_CHAIN_ID=<L2 Chain ID>
@@ -66,3 +67,10 @@ OP_ENGINE_RPC=ws://op-geth:8551
 OP_ROLLUP_RPC=http://op-node:8547
 OP_ENGINE_REPLICA_RPC=ws://op-geth-replica:8551
 OP_ROLLUP_REPLICA_RPC=http://op-node-replica:8547
+
+# Block timestamps for upgrades (empty = no upgrade)
+OP_OVERRIDE_CANYON=
+OP_OVERRIDE_DELTA=
+OP_OVERRIDE_ECOTONE=
+OP_OVERRIDE_FJORD=
+OP_OVERRIDE_GRANITE=

README.md

@@ -7,8 +7,21 @@ This repository offers Docker configurations for effortlessly running the Opstac
 
 Please follow the steps below to get your Verse up and running. If you encounter any issues while building, please refer to the [QA](#frequently-asked-questions) section.
 
+## About Versions
+This repository follows semantic versioning with the major version fixed at `v1`(meaning Verse V1). Minor version updates correspond to OPStack protocol upgrades(hardforks). Patch version updates are releases focused on bug fixes and parameter changes. It is strongly recommended to pin to a specific version after git cloning, as tracking the main branch would result in automatic application of upgrades.
+```shell
+git checkout <version tag>
+```
+
+Version tags to OPStack upgrades mapping:
+| Tag | Upgrade |
+| --- | --- |
+| v1.0.0 ~ | Bedrock (Includes [Regolith](https://specs.optimism.io/protocol/regolith/overview.html)) |
+| v1.1.0 ~ | [Canyon](https://specs.optimism.io/protocol/canyon/overview.html) |
+| v1.2.0 ~ | [Granite](https://specs.optimism.io/protocol/granite/overview.html) (Includes [Delta](https://specs.optimism.io/protocol/delta/overview.html), [Ecotone](https://specs.optimism.io/protocol/ecotone/overview.html), [Fjord](https://specs.optimism.io/protocol/fjord/overview.html)) |
+
 ## Steps to Launch Verse
-Before beginning, ensure that the L1 contract sets have already been deployed, and you possess the necessary configuration files (`addresses.json`, `deploy-config.json`). If not, please refer to the contract sets deployment section in our [technical documentation](https://docs.oasys.games/docs/verse-developer/how-to-build-verse/manual).
+Before beginning, ensure that the L1 contract sets have already been deployed, and you possess the necessary configuration files (`addresses.json`, `deploy-config.json`). If not, please refer to the contract sets deployment section in our [technical documentation](https://docs.oasys.games/docs/category/build-verse).
 
 ### 1. Prepare Assets and Environment
 #### Place Configuration Files
@@ -33,8 +46,13 @@ cp .env.sample.mainnet .env
 
 # Sample for testnet
 cp .env.sample.testnet .env
+
+# Sample for private
+cp .env.sample.private .env
 ```
 
+> *Related project for building a private L2: [oasys-private-l1](https://github.com/oasysgames/oasys-private-l1)*
+
 To configure the environment file with addresses sourced from `addresses.json`, use the following commands to extract the required addresses:
 ```shell
 # Retrieve OP_L2OO_ADDR from addresses.json
@@ -101,18 +119,36 @@ chown 65534:65534 ./data/{op-geth,op-node,message-relayer,message-relayer/{state
 #### Generate Chain Configurations
 Verify successful generation of configuration files. The produced files (`genesis.json` and `rollup.json`) will be placed in the assets directory:
 ```shell
-docker-compose run --rm --no-deps --user=root op-node genesis l2 \
-  --l1-rpc "$(grep L1_ETH_RPC_HTTP .env | cut -d= -f2)" \
-  --deploy-config  /assets/deploy-config.json \
-  --l1-deployments /assets/addresses.json \
-  --outfile.l2     /assets/genesis.json \
-  --outfile.rollup /assets/rollup.json
+docker run --rm -ti -u 65534:65534 -v $PWD/assets:/assets \
+  ghcr.io/oasysgames/oasys-opstack/op-node:v1.0.0 op-node genesis l2 \
+    --l1-rpc "$(grep L1_ETH_RPC_HTTP .env | cut -d= -f2)" \
+    --deploy-config  /assets/deploy-config.json \
+    --l1-deployments /assets/addresses.json \
+    --outfile.l2     /assets/genesis.json \
+    --outfile.rollup /assets/rollup.json
+```
+
+#### Add upgrade timestamps to .env
+Add the block timestamps for L2 upgrades to the `.env` file. These timestamps must be set slightly in the future as `op-node` and `op-geth` must be launched before the specified times. All timestamps can be set to the same value, but due to specification constraints, `0` cannot be used.
+```dotenv
+# Block timestamps for upgrades (empty = no upgrade)
+OP_OVERRIDE_CANYON=
+OP_OVERRIDE_DELTA=
+OP_OVERRIDE_ECOTONE=
+OP_OVERRIDE_FJORD=
+OP_OVERRIDE_GRANITE=
 ```
 
+*Example command to get timestamp 10 minutes ahead*: `expr $(date +%s) + 600`
+
+> [!IMPORTANT]
+> **Do not modify timestamps after upgrades have been applied. In particular, never re-change to a future.**
+
 #### Generate the Genesis Block
 Ensure the successful generation of the genesis block (number=0):
 ```shell
-docker-compose run --rm --no-deps op-geth init /assets/genesis.json
+docker run --rm -ti -u 65534:65534 -v $PWD/assets:/assets -v $PWD/data/op-geth:/data \
+  ghcr.io/oasysgames/oasys-op-geth:v1.0.0 --datadir /data init /assets/genesis.json
 ```
 
 

docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3'
-
 x-resident: &resident
   restart: unless-stopped
   user: nobody
@@ -12,7 +10,7 @@ x-resident: &resident
 services:
   op-geth:
     <<: *resident
-    image: ghcr.io/oasysgames/oasys-op-geth:v1.2.0
+    image: ghcr.io/oasysgames/oasys-op-geth:v1.3.0-18a5e9f31
     entrypoint: geth
     environment:
       GETH_DATADIR: /data
@@ -21,12 +19,12 @@ services:
       GETH_HTTP_VHOSTS: '*'
       GETH_HTTP_ADDR: 0.0.0.0
       GETH_HTTP_PORT: 8545
-      GETH_HTTP_API: net,eth,web3
+      GETH_HTTP_API: net,eth,web3,miner
       GETH_WS: 'true'
       GETH_WS_ORIGINS: '*'
       GETH_WS_ADDR: 0.0.0.0
       GETH_WS_PORT: 8546
-      GETH_WS_API: net,eth,web3
+      GETH_WS_API: net,eth,web3,miner
       GETH_SYNCMODE: full
       GETH_GCMODE: archive
       GETH_CACHE: 4096
@@ -39,7 +37,10 @@ services:
       GETH_AUTHRPC_JWTSECRET: /assets/jwt.txt
       GETH_TXPOOL_PRICELIMIT: 0
       GETH_ROLLUP_SUPERCHAIN_UPGRADES: 'false'
-      GETH_OVERRIDE_CANYON: null  # null = no fork
+      GETH_OVERRIDE_CANYON: $OP_OVERRIDE_CANYON
+      GETH_OVERRIDE_ECOTONE: $OP_OVERRIDE_ECOTONE
+      GETH_OVERRIDE_FJORD: $OP_OVERRIDE_FJORD
+      GETH_OVERRIDE_GRANITE: $OP_OVERRIDE_GRANITE
     volumes:
       - ./assets:/assets
       - ./data/op-geth:/data
@@ -49,10 +50,11 @@ services:
 
   op-node:
     <<: *resident
-    image: ghcr.io/oasysgames/oasys-opstack/op-node:v1.1.0
+    image: ghcr.io/oasysgames/oasys-opstack/op-node:v1.2.0-a0f55fa2d
     entrypoint: op-node
     environment:
       OP_NODE_L1_ETH_RPC: $L1_ETH_RPC_HTTP
+      OP_NODE_L1_BEACON: $L1_BEACON_API
       OP_NODE_L1_RPC_KIND: basic
       OP_NODE_L1_EPOCH_POLL_INTERVAL: 192s
       OP_NODE_L1_HTTP_POLL_INTERVAL: 6s
@@ -74,6 +76,11 @@ services:
       OP_NODE_P2P_DISCOVERY_PATH: memory
       OP_NODE_P2P_PEERSTORE_PATH: memory
       OP_NODE_P2P_NO_DISCOVERY: 'true'
+      OP_NODE_OVERRIDE_CANYON: $OP_OVERRIDE_CANYON
+      OP_NODE_OVERRIDE_DELTA: $OP_OVERRIDE_DELTA
+      OP_NODE_OVERRIDE_ECOTONE: $OP_OVERRIDE_ECOTONE
+      OP_NODE_OVERRIDE_FJORD: $OP_OVERRIDE_FJORD
+      OP_NODE_OVERRIDE_GRANITE: $OP_OVERRIDE_GRANITE
     volumes:
       - ./assets:/assets
       - ./data/op-node:/data
@@ -85,7 +92,7 @@ services:
 
   op-batcher:
     <<: *resident
-    image: ghcr.io/oasysgames/oasys-opstack/op-batcher:v1.1.0
+    image: ghcr.io/oasysgames/oasys-opstack/op-batcher:v1.2.0-a0f55fa2d
     entrypoint: op-batcher
     environment:
       OP_BATCHER_L1_ETH_RPC: $L1_ETH_RPC_HTTP
@@ -103,7 +110,7 @@ services:
 
   op-proposer:
     <<: *resident
-    image: ghcr.io/oasysgames/oasys-opstack/op-proposer:v1.1.0
+    image: ghcr.io/oasysgames/oasys-opstack/op-proposer:v1.2.0-a0f55fa2d
     entrypoint: op-proposer
     environment:
       OP_PROPOSER_L1_ETH_RPC: $L1_ETH_RPC_HTTP