feat: kurtosis

book/advanced/kurtosis.md

@@ -0,0 +1,35 @@
+# Kurtosis
+
+To test `op-succinct` on a local devnet, you can use Kurtosis.
+
+First, install Kurtosis: https://docs.kurtosis.com/install/
+
+https://github.com/ethpandaops/optimism-package/tree/main/.github/tests
+
+Then, configure the `op-network.yaml` file to use the Kurtosis engine:
+
+```yaml
+optimism_package:
+  chains:
+    - participants:
+        - el_type: op-geth
+          cl_type: op-node
+      network_params:
+        fjord_time_offset: 0
+        granite_time_offset: 0
+        holocene_time_offset: 0
+      additional_services:
+        - blockscout
+ethereum_package:
+  participants:
+    - el_type: geth
+    - el_type: reth
+  network_params:
+    preset: minimal
+  additional_services:
+    - blockscout
+```
+
+Run the testnet: `kurtosis run --enclave my-testnet github.com/ethpandaops/optimism-package --args-file op-network.yaml --image-download always`
+
+Remove the testnet: `kurtosis clean -a`

op-network.yaml

@@ -0,0 +1,69 @@
+optimism_package:
+  chains:
+    - participants:
+      - el_type: op-geth
+        el_image: ""
+        el_log_level: ""
+        el_extra_env_vars: {}
+        el_extra_labels: {}
+        el_extra_params: []
+        el_tolerations: []
+        el_volume_size: 0
+        el_min_cpu: 0
+        el_max_cpu: 0
+        el_min_mem: 0
+        el_max_mem: 0
+        cl_type: op-node
+        cl_image: ""
+        cl_log_level: ""
+        cl_extra_env_vars: {}
+        cl_extra_labels: {}
+        cl_extra_params: []
+        cl_tolerations: []
+        cl_volume_size: 0
+        cl_min_cpu: 0
+        cl_max_cpu: 0
+        cl_min_mem: 0
+        cl_max_mem: 0
+        node_selectors: {}
+        tolerations: []
+        count: 1
+      network_params:
+        network: "kurtosis"
+        network_id: "2151908"
+        seconds_per_slot: 2
+        name: "op-kurtosis"
+        fjord_time_offset: 0
+        granite_time_offset: 0
+        holocene_time_offset: 0
+        fund_dev_accounts: true
+      batcher_params:
+        image: ""
+        # The number of L1 blocks to wait before sending a batch. Currently configured to 10 L1 blocks.
+        extra_params: ["--batch-type=1"]
+      additional_services:
+        - blockscout
+  op_contract_deployer_params:
+    image: us-docker.pkg.dev/oplabs-tools-artifacts/images/op-deployer:v0.0.6
+    l1_artifacts_locator: tag://op-contracts/v1.6.0
+    l2_artifacts_locator: tag://op-contracts/v1.7.0-beta.1+l2-contracts
+  global_log_level: "info"
+  global_node_selectors: {}
+  global_tolerations: []
+  persistent: false
+ethereum_package:
+  network_params:
+    preset: minimal
+    genesis_delay: 5
+    additional_preloaded_contracts: '
+      {
+        "0x4e59b44847b379578588920cA78FbF26c0B4956C": {
+          "balance": "0ETH",
+          "code": "0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe03601600081602082378035828234f58015156039578182fd5b8082525050506014600cf3",
+          "storage": {},
+          "nonce": "1"
+        }
+      }
+    '
+  additional_services:
+    - blockscout