Skip to content
This repository has been archived by the owner on Nov 25, 2024. It is now read-only.

Commit

Permalink
feat: kurtosis instructions (#110)
Browse files Browse the repository at this point in the history
* feat: kurtosis instructions

* feat: kurtosis config
  • Loading branch information
onbjerg authored Sep 2, 2024
1 parent f28e422 commit 5045bf9
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ To use EOF-enabled foundry, use [forge-eof](https://github.com/paradigmxyz/forge

### Running AlphaNet

⚠️ AlphaNet does not yet have a running testnet, please use the local development instructions above! ⚠️
> [!WARNING]
>
> AlphaNet does not yet have a running testnet, please use the local development instructions above!
Running AlphaNet will require running additional infrastructure for the archival L1 node. These instructions are a guide for
running the AlphaNet OP-stack node only.
Expand Down Expand Up @@ -89,6 +91,40 @@ op-node \
--l1.trustrpc
```

### Running AlphaNet with Kurtosis

Running a local network with a full AlphaNet OP stack with Kurtosis requires some extra setup, since AlphaNet uses a forked version of `op-node`.

To get started, follow [these instructions](https://docs.kurtosis.com/install/) to install Kurtosis.

Next, clone and build the modified `optimism-contract-deployer` image:

```bash
git clone git@github.com:paradigmxyz/optimism-package.git
cd optimism-package
git switch alphanet
docker build . -t ethpandaops/optimism-contract-deployer:latest --progress plain
```

> [!NOTE]
>
> The image may fail to build if you have not allocated enough memory for Docker.
Finally, run start a Kurtosis enclave (ensure you are still in `optimism-package`):

```bash
kurtosis run --enclave op-devnet github.com/paradigmxyz/optimism-package@alphanet \
--args-file https://raw.githubusercontent.com/paradigmxyz/alphanet/main/etc/kurtosis.yaml
```

This will start an enclave named `op-devnet`. You can tear down the enclave with `kurtosis enclave rm --force op-devnet`, or tear down all enclaves using `kurtosis clean -a`.

> [!NOTE]
>
> If you want to use a custom build of AlphaNet, simply build an AlphaNet image with `docker build . -t ghcr.io/paradigmxyz/alphanet:latest`.
Consult the [Kurtosis OP package](https://github.com/ethpandaops/optimism-package) repository for instructions on how to adjust the args file to spin up additional services, like a block exporer.

### Security

See [SECURITY.md](SECURITY.md).
Expand Down
8 changes: 8 additions & 0 deletions etc/kurtosis.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ethereum_package:
participants:
- el_type: reth
cl_type: lighthouse
optimism_package:
participants:
- el_type: op-reth
el_image: ghcr.io/paradigmxyz/alphanet:latest

0 comments on commit 5045bf9

Please sign in to comment.