Rename app -> stack_orchestrator (#625)

2023-11-07 00:06:55 -07:00
parent e989368793
commit 4456e70c93
483 changed files with 82 additions and 81 deletions
@@ -0,0 +1,123 @@
+# fixturenet-optimism
+
+Instructions to setup and deploy an end-to-end L1+L2 stack with [fixturenet-eth](../fixturenet-eth/) (L1) and [Optimism](https://stack.optimism.io) (L2)
+
+We support running just the L2 part of stack, given an external L1 endpoint. Follow the [L2 only doc](./l2-only.md) for the same.
+
+## Setup
+
+Clone required repositories:
+
+```bash
+laconic-so --stack fixturenet-optimism setup-repositories
+
+# If this throws an error as a result of being already checked out to a branch/tag in a repo, remove the repositories mentioned below and re-run the command
+```
+
+Build the container images:
+
+```bash
+laconic-so --stack fixturenet-optimism build-containers
+
+# If redeploying with changes in the stack containers
+laconic-so --stack fixturenet-optimism build-containers --force-rebuild
+
+# If errors are thrown during build, old images used by this stack would have to be deleted
+```
+
+Note: this will take >10 mins depending on the specs of your machine, and **requires** 16GB of memory or greater.
+
+This should create the required docker images in the local image registry:
+* `cerc/go-ethereum`
+* `cerc/lighthouse`
+* `cerc/fixturenet-eth-geth`
+* `cerc/fixturenet-eth-lighthouse`
+* `cerc/foundry`
+* `cerc/optimism-contracts`
+* `cerc/optimism-l2geth`
+* `cerc/optimism-op-node`
+* `cerc/optimism-op-batcher`
+* `cerc/optimism-op-proposer`
+
+## Deploy
+
+Deploy the stack:
+
+```bash
+laconic-so --stack fixturenet-optimism deploy up
+```
+
+The `fixturenet-optimism-contracts` service takes a while to complete running as it:
+1. waits for the 'Merge' to happen on L1
+2. waits for a finalized block to exist on L1 (so that it can be taken as a starting block for roll ups)
+3. deploys the L1 contracts
+It may restart a few times after running into errors.
+
+To list and monitor the running containers:
+
+```bash
+laconic-so --stack fixturenet-optimism deploy ps
+
+# With status
+docker ps
+
+# Check logs for a container
+docker logs -f <CONTAINER_ID>
+```
+
+## Clean up
+
+Stop all services running in the background:
+
+```bash
+laconic-so --stack fixturenet-optimism deploy down 30
+```
+
+Clear volumes created by this stack:
+
+```bash
+# List all relevant volumes
+docker volume ls -q --filter "name=.*l1_deployment|.*l2_accounts|.*l2_config|.*l2_geth_data"
+
+# Remove all the listed volumes
+docker volume rm $(docker volume ls -q --filter "name=.*l1_deployment|.*l2_accounts|.*l2_config|.*l2_geth_data")
+```
+
+## Troubleshooting
+
+* If `op-geth` service aborts or is restarted, the following error might occur in the `op-node` service:
+
+  ```bash
+  WARN [02-16|21:22:02.868] Derivation process temporary error       attempts=14 err="stage 0 failed resetting: temp: failed to find the L2 Heads to start from: failed to fetch L2 block by hash 0x0000000000000000000000000000000000000000000000000000000000000000: failed to determine block-hash of hash 0x0000000000000000000000000000000000000000000000000000000000000000, could not get payload: not found"
+  ```
+
+* This means that the data directory that `op-geth` is using is corrupted and needs to be reinitialized; the containers `op-geth`, `op-node` and `op-batcher` need to be started afresh:
+
+  WARNING: This will reset the L2 chain; consequently, all the data on it will be lost
+
+  * Stop and remove the concerned containers:
+
+    ```bash
+    # List the containers
+    docker ps -f "name=op-geth|op-node|op-batcher"
+
+    # Force stop and remove the listed containers
+    docker rm -f $(docker ps -qf "name=op-geth|op-node|op-batcher")
+    ```
+
+  * Remove the concerned volume:
+
+    ```bash
+    # List the volume
+    docker volume ls -q --filter name=l2_geth_data
+
+    # Remove the listed volume
+    docker volume rm $(docker volume ls -q --filter name=l2_geth_data)
+    ```
+
+  * Re-run the deployment command used in [Deploy](#deploy) to restart the stopped containers
+
+## Known Issues
+
+* Resource requirements (memory + time) for building the `cerc/foundry` image are on the higher side
+  * `cerc/optimism-contracts` image is currently based on `cerc/foundry` (Optimism requires foundry installation)
@@ -0,0 +1,100 @@
+# fixturenet-optimism
+
+Instructions to setup and deploy L2 fixturenet using [Optimism](https://stack.optimism.io)
+
+## Setup
+
+Prerequisite: An L1 Ethereum RPC endpoint
+
+Clone required repositories:
+
+```bash
+laconic-so --stack fixturenet-optimism setup-repositories --exclude git.vdb.to/cerc-io/go-ethereum
+
+# If this throws an error as a result of being already checked out to a branch/tag in a repo, remove the repositories mentioned below and re-run the command
+```
+
+Build the container images:
+
+```bash
+laconic-so --stack fixturenet-optimism build-containers --include cerc/foundry,cerc/optimism-contracts,cerc/optimism-op-node,cerc/optimism-l2geth,cerc/optimism-op-batcher,cerc/optimism-op-proposer
+```
+
+This should create the required docker images in the local image registry:
+* `cerc/foundry`
+* `cerc/optimism-contracts`
+* `cerc/optimism-l2geth`
+* `cerc/optimism-op-node`
+* `cerc/optimism-op-batcher`
+* `cerc/optimism-op-proposer`
+
+## Deploy
+
+Create and update an env file to be used in the next step ([defaults](../../config/fixturenet-optimism/l1-params.env)):
+
+  ```bash
+  # External L1 endpoint
+  CERC_L1_CHAIN_ID=
+  CERC_L1_RPC=
+  CERC_L1_HOST=
+  CERC_L1_PORT=
+
+  # URL to get CSV with credentials for accounts on L1
+  # that are used to send balance to Optimism Proxy contract
+  # (enables them to do transactions on L2)
+  CERC_L1_ACCOUNTS_CSV_URL=
+
+  # OR
+  # Specify the required account credentials
+  CERC_L1_ADDRESS=
+  CERC_L1_PRIV_KEY=
+  CERC_L1_ADDRESS_2=
+  CERC_L1_PRIV_KEY_2=
+  ```
+
+* NOTE: If L1 is running on the host machine, use `host.docker.internal` as the hostname to access the host port
+
+Deploy the stack:
+
+```bash
+laconic-so --stack fixturenet-optimism deploy --include fixturenet-optimism --env-file <PATH_TO_ENV_FILE> up
+```
+
+The `fixturenet-optimism-contracts` service may take a while (`~15 mins`) to complete running as it:
+1. waits for the 'Merge' to happen on L1
+2. waits for a finalized block to exist on L1 (so that it can be taken as a starting block for roll ups)
+3. deploys the L1 contracts
+
+To list down and monitor the running containers:
+
+```bash
+laconic-so --stack fixturenet-optimism deploy --include fixturenet-optimism ps
+
+# With status
+docker ps
+
+# Check logs for a container
+docker logs -f <CONTAINER_ID>
+```
+
+## Clean up
+
+Stop all services running in the background:
+
+```bash
+laconic-so --stack fixturenet-optimism deploy --include fixturenet-optimism down 30
+```
+
+Clear volumes created by this stack:
+
+```bash
+# List all relevant volumes
+docker volume ls -q --filter "name=.*l1_deployment|.*l2_accounts|.*l2_config|.*l2_geth_data"
+
+# Remove all the listed volumes
+docker volume rm $(docker volume ls -q --filter "name=.*l1_deployment|.*l2_accounts|.*l2_config|.*l2_geth_data")
+```
+
+## Troubleshooting
+
+See [Troubleshooting](./README.md#troubleshooting)
@@ -0,0 +1,25 @@
+version: "1.0"
+name: fixturenet-optimism
+description: "Optimism Fixturenet"
+repos:
+  - git.vdb.to/cerc-io/go-ethereum@v1.11.6-statediff-v5
+  - git.vdb.to/cerc-io/lighthouse
+  - github.com/dboreham/foundry
+  - github.com/ethereum-optimism/optimism@v1.0.4
+  - github.com/ethereum-optimism/op-geth@v1.101105.2
+containers:
+  - cerc/go-ethereum
+  - cerc/lighthouse
+  - cerc/lighthouse-cli
+  - cerc/fixturenet-eth-genesis
+  - cerc/fixturenet-eth-geth
+  - cerc/fixturenet-eth-lighthouse
+  - cerc/foundry
+  - cerc/optimism-contracts
+  - cerc/optimism-op-node
+  - cerc/optimism-l2geth
+  - cerc/optimism-op-batcher
+  - cerc/optimism-op-proposer
+pods:
+  - fixturenet-eth
+  - fixturenet-optimism