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

Commit f8b14ad

Browse files
committed
feat: kurtosis instructions
1 parent f28e422 commit f8b14ad

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ To use EOF-enabled foundry, use [forge-eof](https://github.com/paradigmxyz/forge
4848

4949
### Running AlphaNet
5050

51-
⚠️ AlphaNet does not yet have a running testnet, please use the local development instructions above! ⚠️
51+
> [!WARNING]
52+
>
53+
> AlphaNet does not yet have a running testnet, please use the local development instructions above!
5254
5355
Running AlphaNet will require running additional infrastructure for the archival L1 node. These instructions are a guide for
5456
running the AlphaNet OP-stack node only.
@@ -89,6 +91,39 @@ op-node \
8991
--l1.trustrpc
9092
```
9193

94+
### Running AlphaNet with Kurtosis
95+
96+
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`.
97+
98+
To get started, follow [these instructions](https://docs.kurtosis.com/install/) to install Kurtosis.
99+
100+
Next, clone and build the modified `optimism-contract-deployer` image:
101+
102+
```bash
103+
git clone git@github.com:rkrasiuk/optimism-package.git
104+
cd optimism-package
105+
docker build . -t ethpandaops/optimism-contract-deployer:latest --progress plain
106+
```
107+
108+
> [!NOTE]
109+
>
110+
> The image may fail to build if you have not allocated enough memory for Docker.
111+
112+
Finally, run start a Kurtosis enclave (ensure you are still in `optimism-package`):
113+
114+
```bash
115+
kurtosis run --enclave op-devnet . \
116+
--args-file https://raw.githubusercontent.com/paradigmxyz/alphanet/main/etc/kurtosis.yaml
117+
```
118+
119+
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`.
120+
121+
> [!NOTE]
122+
>
123+
> If you want to use a custom build of AlphaNet, simply build an AlphaNet image with `docker build -t ghcr.io/paradigmxyz/alphanet:latest .`
124+
125+
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.
126+
92127
### Security
93128

94129
See [SECURITY.md](SECURITY.md).

0 commit comments

Comments
 (0)