Skip to content

Commit 3f0917d

Browse files
updating and clarifying from review
Signed-off-by: kmurphypolygon <kmurphy@polygon.technology>
1 parent fcdece1 commit 3f0917d

File tree

7 files changed

+46
-10
lines changed

7 files changed

+46
-10
lines changed

docs/cdk/get-started/deploy-rollup/configure-node-deployment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
3. Go to the `zkevm/zkevm-config` directory and create an `.env` file and open it for editing.
2121

2222
```sh
23-
cd ../zkevm-config/
23+
cd ~/zkevm/zkevm-config/
2424
nano .env
2525
```
2626

@@ -32,7 +32,7 @@
3232
ZKEVM_NODE_POOLDB_DATA_DIR = "~/zkevm/data/pooldb"
3333
```
3434

35-
!!! warning
35+
!!! warning "Workaround if you have configuration issues"
3636
- You may have to hardcode these variables into the `mainnet/docker-compose.yaml` file.
3737
- Also, the `ZKEVM_NETWORK` variable which you can set to `mainnet`.
3838
- Note, there are more than one references to hardcode in.
@@ -90,7 +90,7 @@
9090
Add the missing parameters in the `~/zkevm/mainnet/config/environments/mainnet/public.node.config.toml` file.
9191

9292
!!! warning
93-
Rename the file if necessary.
93+
Rename the file from `node.config.toml` to `public.node.config.toml` if necessary.
9494

9595
- `ApiKey` # for Etherscan
9696
- `URL` # for Goerli node, under [ETHERMAN]

docs/cdk/get-started/deploy-rollup/create-wallets.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ npm i
6464
2. Set the following variables.
6565
6666
```sh
67-
`MNEMONIC`="..." # from wallets.txt Deployment Address mnemonic
68-
`INFURA_API_KEY`="..." # your API Key from Infura account
69-
`ETHERSCAN_API_KEY`="..." # your Etherscan API key
67+
MNEMONIC="..." # from wallets.txt Deployment Address mnemonic
68+
INFURA_API_KEY="..." # your API Key from Infura account
69+
ETHERSCAN_API_KEY="..." # your Etherscan API key
7070
```
7171
7272
3. Send 0.5 GöETH to the deployment address wallet listed in `wallets.txt`.
@@ -88,7 +88,8 @@ npm i
8888
- `admin`: deployment address in `wallets.txt`.
8989
- `zkEVMOwner`: deployment address in `wallets.txt`.
9090
- `timelockAddress`: deployment address in `wallets.txt`.
91-
- `initialZkEVMDeployer`: deployment address in `wallets.txt`.
91+
- `initialZkEVMDeployerAddress`: deployment address in `wallets.txt`.
92+
- `zkEVMDeployerAddress`: deployment address in `wallets.txt`.
9293
9394
## Deploy contracts
9495

docs/cdk/get-started/deploy-rollup/intro.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,6 @@ The process is split into the following sections:
1818

1919
6. [Configure prover](configure-prover.md): Configure the prover database and the prover service.
2020

21-
7. [Start services](start-services.md): Start the services.
21+
7. [Start node](start-node.md): Start the node.
22+
23+
8. [Start services](start-services.md): Start the services.

docs/cdk/get-started/deploy-rollup/prerequisites.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ The commands on the [install dependencies page](install-dependencies.md) fulfill
1717
!!! info
1818
The mock prover is a light resource by skipping validation and instead adding a `Valid ✅` checkmark to every batch.
1919

20+
21+
<!-- TODO: Add link to full prover instructions -->
22+
2023
- 4-core CPU
2124
- 8GB RAM (16GB recommended)
2225

docs/cdk/get-started/deploy-rollup/start-node.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,26 @@ This command spins up the following services:
1414
- Pool DB
1515
- Mock prover
1616

17+
### Configuration issues
18+
19+
If you have errors related to configuration issues, see the warning at step 4 in the [configure node deployment](configure-node-deployment.md#set-up) section.
20+
21+
### Process binding issue
22+
23+
If you need to restart, make sure you kill any db processes hanging with the following commands.
24+
25+
```sh
26+
sudo lsof -t -i:5432
27+
kill -9 <PID>
28+
```
29+
30+
### Kill all Docker containers and images
31+
32+
```sh
33+
docker rm $(docker ps -aq)
34+
docker rmi $(docker images -q)
35+
```
36+
1737
## Log sample
1838

1939
??? "Logs sample"

docs/cdk/get-started/quickstart-validium.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
This quick start guide shows you how to set up a CDK validium on your local machine.
1+
This quick start guide shows you how to set up a CDK validium on your local machine that sets up and runs the following components:
2+
3+
- zkEVM databases: data node, event, explorer L1 and L2, pool, state, and bridge service
4+
- zkEVM node components: aggregator, approve service, sequencer and sequence sender, sync
5+
- L1 network (mock)
6+
- Prover
7+
- Explorers L1, L2
8+
- JSON RPC explorer
9+
- L2 gas pricer
10+
- DAC: data availability service, dac setup committee
11+
- zkEVM bridge service and UI
212

313
!!! note
414
- The documentation describes standard deployments.

docs/cdk/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ hide:
1313
<div class="hero-image"><img src="../img/cdk/cdk.svg" loading="lazy" class="hero-image" style="width: 40%; float: right;"></div>
1414
<div class="hero-left">
1515
<h1 class="hero-heading">Polygon CDK</h1>
16-
<p class="hero-subtext">Polygon Chain Development Kit (CDK) is a modular, open source software toolkit for blockchain developers to launch new L2 chains on Ethereum.</p>
16+
<p class="hero-subtext">Polygon Chain Development Kit (CDK) is a modular, open source software toolkit allowing blockchain developers to launch new zero-knowledge proof (zkEVM plus optional validium) L2 chains chains on Ethereum.</p>
1717
</div>
1818
</br>
1919
</div>

0 commit comments

Comments
 (0)