Skip to content

Commit 91b6991

Browse files
authored
Update local-deployment.md with PP config
Update doc and especify how to PP chain
1 parent bde7888 commit 91b6991

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

docs/cdk/getting-started/local-deployment.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ It defines the following steps for the deployment process:
6464

6565
You can customize (or skip) any of the numbered steps by modifying the logic in the respective files.
6666

67-
#### 2. [`params.yml`](https://github.com/0xPolygon/kurtosis-cdk/blob/main/params.yml)
67+
#### 2. [`input_parser.star`](https://github.com/0xPolygon/kurtosis-cdk/blob/main/input_parser.star)
6868

69-
The `params.yml` file defines the parameters of the chain and the deployment process.
69+
The `input_parser.star` file defines the default parameters of the chain and the deployment process.
7070

7171
It includes configurations for simple parameters such as the chain ID and more complex configurations such as the gas token smart contract address.
7272

73-
You can modify each of these parameters to customize the chain to your specific needs.
73+
To customize the chain to your specific needs you need to create a new configuration file in your desired path, for example: `./params.yml`
7474

7575
## Run the chain locally
7676

@@ -102,20 +102,35 @@ You can modify each of these parameters to customize the chain to your specific
102102
103103
```
104104

105-
The default deployment includes `cdk-erigon` as the sequencer, and `cdk-node` functioning as the sequence sender and aggregator.
105+
The default deployment it's a **Full Execution Proofs** setup that includes `cdk-erigon` as the sequencer, and `cdk-node` functioning as the sequence sender and aggregator.
106106
107107
You can verify the default versions of these components and the default fork ID by reviewing `input_parser.star`. You can check the default versions of the deployed components and the default fork ID by looking at `input_parser.star`.
108108
109109
3. Customize the chain
110110
111-
To make customizations to the CDK environment, clone this repo, make any desired configuration changes, and then run:
111+
To make customizations to the CDK environment create a kurtosis configuration file with your desired environment, for example:
112+
113+
### Configure a Pesimistic Proof chain
114+
115+
```yaml
116+
args:
117+
consensus_contract_type: pessimistic
118+
sequencer_type: erigon
119+
erigon_strict_mode: false
120+
agglayer_prover_sp1_key: REDACTED
121+
enable_normalcy: true
122+
```
123+
124+
Save this config to `paraml.yml` file, and then run:
112125
113126
```sh
114127
# Delete all stop and clean all currently running enclaves
115128
kurtosis clean --all
116129
130+
131+
117132
# Run this command from the root of the repository to start the network
118-
kurtosis run --enclave cdk .
133+
kurtosis run --enclave cdk --args-file ./params.yml github.com/0xPolygon/kurtosis-cdk
119134
```
120135
121136
4. Inspect the chain

0 commit comments

Comments
 (0)