Merge pull request 0xPolygon#233 from 0xPolygon/km/more-sharon-updates

CDK deploy rollup review and updates

Author: kmurphypolygon

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

@@ -20,7 +20,7 @@
 3. Go to the `zkevm/zkevm-config` directory and create an `.env` file and open it for editing.
 
     ```sh
-    cd ../zkevm-config/
+    cd ~/zkevm/zkevm-config/
     nano .env
     ```
 
@@ -32,7 +32,7 @@
     ZKEVM_NODE_POOLDB_DATA_DIR = "~/zkevm/data/pooldb"
     ```
 
-    !!! warning
+    !!! warning "Workaround if you have configuration issues"
         - You may have to hardcode these variables into the `mainnet/docker-compose.yaml` file.
         - Also, the `ZKEVM_NETWORK` variable which you can set to `mainnet`.
         - Note, there are more than one references to hardcode in.
@@ -87,10 +87,10 @@
 
 ## Update node config
 
-Add the missing parameters in the `~/zkevm/mainnet/config/environments/mainnet/public.node.config.toml` file.
+Add the following missing parameters to the `~/zkevm/mainnet/config/environments/mainnet/public.node.config.toml` file.
 
 !!! warning
-    Rename the file if necessary.
+    If you're having trouble locating the configuration file, try looking for `node.config.toml`, since it may exist under that name in some cases. Once you've added the missing parameters, rename the file to `public.node.config.toml`.
 
 - `ApiKey`  # for Etherscan
 - `URL`     # for Goerli node, under [ETHERMAN]

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

@@ -64,9 +64,9 @@ npm i
 2. Set the following variables.
 
     ```sh
-    `MNEMONIC`="..."            # from wallets.txt Deployment Address mnemonic
-    `INFURA_API_KEY`="..."      # your API Key from Infura account
-    `ETHERSCAN_API_KEY`="..."   # your Etherscan API key
+    MNEMONIC="..."            # from wallets.txt Deployment Address mnemonic
+    INFURA_API_KEY="..."      # your API Key from Infura account
+    ETHERSCAN_API_KEY="..."   # your Etherscan API key
     ```
 
 3. Send 0.5 GöETH to the deployment address wallet listed in `wallets.txt`.
@@ -88,7 +88,8 @@ npm i
     - `admin`: deployment address in `wallets.txt`.
     - `zkEVMOwner`: deployment address in `wallets.txt`.
     - `timelockAddress`: deployment address in `wallets.txt`.
-    - `initialZkEVMDeployer`: deployment address in `wallets.txt`.  
+    - `initialZkEVMDeployerAddress`: deployment address in `wallets.txt`.  
+    - `zkEVMDeployerAddress`: deployment address in `wallets.txt`.  
 
 ## Deploy contracts
 

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

@@ -18,4 +18,6 @@ The process is split into the following sections:
 
 6. [Configure prover](configure-prover.md): Configure the prover database and the prover service.
 
-7. [Start services](start-services.md): Start the services.
+7. [Start node](start-node.md): Start the node.
+
+8. [Start services](start-services.md): Start the services.

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

@@ -17,6 +17,9 @@ The commands on the [install dependencies page](install-dependencies.md) fulfill
 !!! info
     The mock prover is a light resource by skipping validation and instead adding a `Valid ✅` checkmark to every batch.
 
+    
+<!-- TODO: Add link to full prover instructions -->
+
 - 4-core CPU
 - 8GB RAM (16GB recommended)
 

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

@@ -43,4 +43,31 @@ This command spins up the following services:
         zkevm-rpc         | /src/db/db.go:53 github.com/0xPolygonHermez/zkevm-node/db.CheckMigrations()
         zkevm-rpc         | /src/cmd/run.go:263 main.checkStateMigrations()
         zkevm-rpc         | /src/cmd/run.go:70 main.start()
-        zkevm-state-db    | 2024-01-24 13:49:21.909 UTC [78] ERROR:  relation "public.gorp_migrations" does not exist at character 22
+        zkevm-state-db    | 2024-01-24 13:49:21.909 UTC [78] ERROR:  relation "public.gorp_migrations" does not exist at character 22
+
+## Troubleshooting
+
+### Configuration issues
+
+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.
+
+### Process binding issue
+
+If you  need to restart, make sure you kill any hanging db processes with the following commands.
+
+!!! info
+    You can find the port number from the log warnings.
+
+```sh
+sudo lsof -t -i:<DB_PORT>
+kill -9 <PID>
+```
+
+### Kill all Docker containers and images 
+
+You can fix many restart issues and persistent errors by stopping and deleting all Docker containers and images.
+
+```sh
+docker rm $(docker ps -aq)
+docker rmi $(docker images -q)
+```

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

@@ -69,17 +69,13 @@ make run
 
 The `make run` command spins up the containers that run the environment, but nothing else. This means that the L2 has no data yet.
 
-### 3.2 Test with data
-
-Test a use case from the [test with sample data](#4-test-with-sample-data) section.
-
-### 3.3 Stop the environment
+### 3.2 Stop the environment
 
 ```bash
 make stop
 ```
 
-### 3.4 Restart the environment
+### 3.3 Restart the environment
 
 ```bash
 make restart

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

@@ -1,4 +1,14 @@
-This quick start guide shows you how to set up a CDK validium on your local machine.
+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:
+
+- zkEVM databases: data node, event, explorer L1 and L2, pool, state, and bridge service
+- zkEVM node components: aggregator, approve service, sequencer and sequence sender, sync
+- L1 network (mock)
+- Prover
+- Explorers L1, L2
+- JSON RPC explorer
+- L2 gas pricer
+- DAC: data availability service, dac setup committee
+- zkEVM bridge service and UI
 
 !!! note
     - The documentation describes standard deployments. 

docs/cdk/index.md

@@ -13,7 +13,7 @@ hide:
    <div class="hero-image"><img src="../img/cdk/cdk.svg" loading="lazy" class="hero-image" style="width: 40%; float: right;"></div>
    <div class="hero-left">
       <h1 class="hero-heading">Polygon CDK</h1>
-      <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>
+      <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>
    </div>
    </br>
 </div>