Skip to content

Commit ec3b0aa

Browse files
authored
Merge pull request 0xPolygon#2486 from 0xPolygon/CDK-554-local-deployment-guide-pp-specifics
Update local-deployment.md with PP config
2 parents 758a64c + 21393f2 commit ec3b0aa

File tree

1 file changed

+34
-7
lines changed

1 file changed

+34
-7
lines changed

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

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,19 @@ And, optionally, for submitting transactions and interacting with the environmen
3131
- [jq](https://stedolan.github.io/jq/)
3232
- [polyon-cli](https://github.com/0xPolygon/polygon-cli)
3333

34-
## Set up the Kurtosis environment
34+
## Quick setup
35+
36+
After installing the requirements you can launch a CDK chains with a oneliner:
37+
38+
### Pesimistic Proof
39+
40+
kurtosis run --enclave cdk --args-file "https://raw.githubusercontent.com/0xPolygon/kurtosis-cdk/refs/heads/main/.github/tests/fork12-pessimistic.yml" github.com/0xPolygon/kurtosis-cdk
41+
42+
### FEP
43+
44+
kurtosis run --enclave cdk github.com/0xPolygon/kurtosis-cdk
45+
46+
## Extended Kurtosis environment setup
3547

3648
### Understanding the deployment steps
3749

@@ -64,13 +76,13 @@ It defines the following steps for the deployment process:
6476

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

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

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

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

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

7587
## Run the chain locally
7688

@@ -102,20 +114,35 @@ You can modify each of these parameters to customize the chain to your specific
102114
103115
```
104116

105-
The default deployment includes `cdk-erigon` as the sequencer, and `cdk-node` functioning as the sequence sender and aggregator.
117+
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.
106118
107119
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`.
108120
109121
3. Customize the chain
110122
111-
To make customizations to the CDK environment, clone this repo, make any desired configuration changes, and then run:
123+
To make customizations to the CDK environment create a kurtosis configuration file with your desired environment, for example:
124+
125+
### Configure a CDK Sovereign chain
126+
127+
```yaml
128+
args:
129+
consensus_contract_type: pessimistic
130+
sequencer_type: erigon
131+
erigon_strict_mode: false
132+
agglayer_prover_sp1_key: REDACTED
133+
enable_normalcy: true
134+
```
135+
136+
Save this config to `params.yml` file, and then run:
112137
113138
```sh
114139
# Delete all stop and clean all currently running enclaves
115140
kurtosis clean --all
116141
142+
143+
117144
# Run this command from the root of the repository to start the network
118-
kurtosis run --enclave cdk .
145+
kurtosis run --enclave cdk --args-file ./params.yml github.com/0xPolygon/kurtosis-cdk
119146
```
120147
121148
4. Inspect the chain

0 commit comments

Comments
 (0)