Skip to content

Commit 71038ca

Browse files
updates from last night in
1 parent 4166c1a commit 71038ca

File tree

1 file changed

+31
-35
lines changed

1 file changed

+31
-35
lines changed

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

Lines changed: 31 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,6 @@ And, optionally, for submitting transactions and interacting with the environmen
3333

3434
## Set up the Kurtosis environment
3535

36-
### Clone the repository
37-
38-
```bash
39-
git clone https://github.com/0xPolygon/kurtosis-cdk.git
40-
cd kurtosis-cdk
41-
```
42-
4336
### Understanding the deployment steps
4437

4538
There are two configuration files which help you understand what happens during a deployment.
@@ -81,30 +74,23 @@ You can modify each of these parameters to customize the chain to your specific
8174

8275
## Run the chain locally
8376

84-
1. Run the [kurtosis clean](https://docs.kurtosis.com/clean) to remove any existing Kurtosis environments:
77+
1. In the `kurtosis-cdk` directory, use the [kurtosis run](https://docs.kurtosis.com/run) command to deploy the chain on your local machine by executing the `main.star` script provided with the `params.yml` configuration file:
8578

8679
```bash
87-
kurtosis clean --all
80+
kurtosis run --enclave cdk github.com/0xPolygon/kurtosis-cdk
8881
```
8982

90-
2. In the `kurtosis-cdk` directory, use the [kurtosis run](https://docs.kurtosis.com/run) command to deploy the chain on your local machine by executing the `main.star` script provided with the `params.yml` configuration file:
91-
92-
```bash
93-
kurtosis run --enclave cdk .
94-
```
95-
96-
3. This command typically takes a while to complete and outputs the logs of each step in the deployment process for you to monitor the progress of the chain setup. Once the command is complete, you should see the following output:
83+
2. This command typically takes a while to complete and outputs the logs of each step in the deployment process for you to monitor the progress of the chain setup. Once the command is complete, you should see the following output:
9784

9885
```bash
9986
Starlark code successfully run. No output was returned.
10087
101-
INFO[2024-10-16T16:10:27+02:00] ============================================
102-
INFO[2024-10-16T16:10:27+02:00] || Created enclave: cdk ||
103-
INFO[2024-10-16T16:10:27+02:00] ============================================
88+
INFO[2024-10-17T10:56:06+02:00] ============================================
89+
INFO[2024-10-17T10:56:06+02:00] || Created enclave: cdk ||
90+
INFO[2024-10-17T10:56:06+02:00] ============================================
10491
Name: cdk
105-
UUID: 3e30c0e1863d
92+
UUID: 0fb1ba8e87ad
10693
Status: RUNNING
107-
Creation Time: Wed, 16 Oct 2024 16:01:48 CEST
10894
10995
========================================= Files Artifacts =========================================
11096
@@ -116,13 +102,29 @@ You can modify each of these parameters to customize the chain to your specific
116102
117103
```
118104

119-
3. Inspect the chain
105+
The default deployment includes `cdk-erigon` as the sequencer, and `cdk-node` functioning as the sequence sender and aggregator.
120106

121-
Run the following command to see the status of the enclave and the services running within it at any time.
107+
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`.
122108

123-
```sh
124-
kurtosis enclave inspect cdk
125-
```
109+
3. Customize the chain
110+
111+
To make customizations to the CDK environment, clone this repo, make any desired configuration changes, and then run:
112+
113+
```sh
114+
# Delete all stop and clean all currently running enclaves
115+
kurtosis clean --all
116+
117+
# Run this command from the root of the repository to start the network
118+
kurtosis run --enclave cdk .
119+
```
120+
121+
4. Inspect the chain
122+
123+
Get a feel for the entire network layout by running the following command:
124+
125+
```sh
126+
kurtosis enclave inspect cdk
127+
```
126128

127129
## Interacting with the chain
128130

@@ -155,19 +157,13 @@ Let's do some read and write operations and test transactions on the L2 with Fou
155157
4. Send simple transactions to the chain, such as a transfer of some ETH:
156158
157159
```bash
158-
cast send --legacy --value 0.01ether 0x0000000000000000000000000000000000000000 --private-key "0x12d7de8621a77640c9241b2595ba78ce443d05e94090365ab3bb5e19df82c625"
160+
--private-key "0x12d7de8621a77640c9241b2595ba78ce443d05e94090365ab3bb5e19df82c625"
161+
cast send --legacy --value 0.01ether 0x0000000000000000000000000000000000000000
159162
```
160163
161164
### Load testing the chain
162165
163-
1. Let's send a transaction with cast:
164-
165-
```bash
166-
export PK="0x12d7de8621a77640c9241b2595ba78ce443d05e94090365ab3bb5e19df82c625"
167-
cast send --legacy --private-key "$PK" --value 0.01ether 0x0000000000000000000000000000000000000000
168-
```
169-
170-
2. Use the [`polycli loadtest`](https://github.com/maticnetwork/polygon-cli/blob/main/doc/polycli_loadtest.md) command to send multiple transactions at once to the chain to test its performance:
166+
1. Use the [`polycli loadtest`](https://github.com/maticnetwork/polygon-cli/blob/main/doc/polycli_loadtest.md) command to send multiple transactions at once to the chain to test its performance:
171167
172168
```bash
173169
polycli loadtest --rpc-url "$ETH_RPC_URL" --legacy --private-key "$PK" --verbosity 700 --requests 50000 --rate-limit 50 --concurrency 5 --mode t

0 commit comments

Comments
 (0)