Merge pull request 0xPolygon#227 from 0xPolygon/km/validium-deploy-review

CDK Validium deploy updates from review

Author: EmpieichO

docs/cdk/get-started/deploy-validium/contracts/prerequisites.md

@@ -37,11 +37,10 @@ Use a public faucet to get Sepolia test ETH.
 
 ## Configuration files
 
-!!! warning
-    We will be working with two separate `.env` files.
+We will be working with two separate `.env` files.
 
-    - One `.env` file resides in the contracts project directory. We will set this up in the [contract set up](set-up.md#create-the-env-configuration) section.
-    - Another `.env` resides in a shared system directory so that it is accessible to the node and all running processes. We will populate this file as we go along.
+- One `.env` file resides in the contracts project directory. We will set this up in the [contract set up](set-up.md#create-the-contracts-env-configuration) section.
+- Another `.env` resides in a shared system directory so that it is accessible to the node and all running processes.
 
 Create a folder `/tmp/cdk/` to store the shared `.env` file which will be used by all running processes.
 
@@ -57,11 +56,11 @@ mkdir /tmp/cdk/
 
 Create a `.env` file to store the environment variables that all running processes will share. This shared `.env` file allows us to use `jq` and `tomlq` to easily setup the configuration for the node and running processes.
 
-This file will be populated throughout the [deploy node](../node/prerequisites.md) instructions.
+After adding a few variables to this file in the next [set up section](set-up.md#create-the-shared-system-env-configuration), this file is populated with more environment variables during the [node set up step](../node/set-up.md) and is then accessed by the system throughout the [deploy node configuration step](../node/configure-deployment.md) and [node and services run step](../node/run-node-services.md).
 
 ```bash
 nano /tmp/cdk/.env
 ```
 
 !!! danger
-    Don't forget, the system removes this file on shutdown.
+    Don't forget: The system removes this file on shutdown.

docs/cdk/get-started/deploy-validium/contracts/set-up.md

@@ -29,15 +29,9 @@
 npm install
 ```
 
-## Create the .env configuration
+## Create the contracts `.env` configuration
 
-1. Copy the contract environment configuration example file into a new `.env` file.
-
-    ```bash
-    cp .env.example .env
-    ```
-
-2. Generate a new mnemonic using `cast`.
+1. Generate a mnemonic, address, and private key using `cast`.
 
     ```bash
     cast wallet new-mnemonic --words 12
@@ -57,27 +51,65 @@ npm install
     Private key: 0x3b01870a8449ada951f59c0275670bea1fc145954ee7cb1d46f7d21533600726
     ```
 
-3. Add the environment variables to the `.env` file.
+2. Copy the contract environment configuration example file into a new `.env` file.
+
+    !!! important
+        You should still be in the `cdk-validium-contracts-0.0.2/` directory from the previous step.
 
     ```bash
-    nano .env
-    MNEMONIC="<generated mnemonic>"  # copy/paste the generated Phrase
-    INFURA_PROJECT_ID="<INFURA_PROJECT_ID>"  # Generate a project id on [Infura](https://www.infura.io/)
+    cp .env.example .env
+    ```
+
+3. Open the `.env` file.
+
+    !!! important
+        You should still be in the `cdk-validium-contracts-0.0.2/` directory from the previous step.
+
+    ```sh
+    nano `.env`
+    ```
+
+4. This is what the `.env` file will more or less look like, although you may see actual data in there from a previous run. 
+
+    ```txt 
+    MNEMONIC="<GENERATED_MNEMONIC>"  # copy/paste the generated Phrase from cast
+    INFURA_PROJECT_ID="<YOUR_INFURA_API_KEY>"  # Generate a project id on [Infura](https://www.infura.io/)
     ETHERSCAN_API_KEY="<ETHERSCAN_API_KEY>" # Generate an API key on [Etherscan](https://etherscan.io)
     ```
 
+    Replace the variables as follows:
+
+    - `GENERATED_MNEMONIC` is the generated mnemonic phrase from the cast step above.
+    - `YOUR_INFURA_API_KEY` is a project id you have already created on Infura Sepolia.
+    - `ETHERSCAN_API_KEY` is an API key you have already generated on Etherscan. This variable is optional.    
+
     !!! info
         Check the documentation if you want to [use a different node provider](deploy-contracts.md#use-a-different-node-provider).
 
-4. Send 2 Sepolia ETH to the generated address.
+## Create the shared system `.env` configuration
 
-5. Add the following variables to the *other* `.env` file residing in `/tmp/cdk/.env`. 
+1.  Now open the *other* `.env` file residing in `/tmp/cdk/.env` which we created in the prerequisite steps.
 
-    ```bash
+    ```sh
     nano /tmp/cdk/.env
+    ```
+
+2.  Below is what the `.env` file will more or less look like, although you may see actual data in there from a previous run. 
+
+    ```sh
     TEST_ADDRESS="<the address generated by cast above>"
     TEST_PRIVATE_KEY="<the private key generated by cast above>" 
-    L1_URL="https://sepolia.infura.io/v3/<YOUR INFURA PROJECT ID>"
-    L1_WS_URL="wss://sepolia.infura.io/ws/v3/<YOUR INFURA PROJECT ID>"
+    L1_URL="https://sepolia.infura.io/v3/<YOUR_INFURA_API_KEY>" # same as in the other env file
+    L1_WS_URL="wss://sepolia.infura.io/ws/v3/<YOUR_INFURA_API_KEY>" # same as in the other env file
     ```
 
+    Replace the following variables:
+
+    - `TEST_ADDRESS` is the address generated by cast above.
+    - `TEST_PRIVATE_KEY` is the private key generated by cast above.
+    - `L1_URL` is your Infura Sepolia RPC URL, for example: https://sepolia.infura.io/v3/<YOUR_INFURA_API_KEY>  
+    - `L1_WS_URL` is your Infura Sepolia wss URL, for example: wss://sepolia.infura.io/ws/v3/<YOUR_INFURA_API_KEY>
+
+## Send Sepolia
+
+Send 2 Sepolia ETH to the cast generated address called `TEST_ADDRESS` in the shared `.env` file above.

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

@@ -249,10 +249,6 @@ jq '.aggregatorClientHost = "127.0.0.1" | .databaseURL = "postgresql://cdk_user:
 	.genesisBlockNumber = $data.deploymentBlockNumber' ~/cdk-validium/cdk-validium-contracts-0.0.2/deployment/genesis.json > /tmp/cdk/genesis.json
 	```
 
-	You should see something like this:
-
-	![DAC configuration output](../../../../img/cdk/dac-output.png)
-
 ## Configure the DAC
 
 At this point we should have setup and provisioned the psql database and configured the zk prover and node. 
@@ -334,8 +330,12 @@ Now let’s configure the Data Availability Committee.
 			$TEST_ADDRESS
 	```
 
-!!!	note
-	This can take a few minutes.
+	!!!	note
+		This can take a few minutes.
+	
+	You should see something like this:
+
+	![DAC configuration output](../../../../img/cdk/dac-output.png)
 
 ## Configure bridge service
 

docs/cdk/get-started/deploy-validium/node/run-node-services.md

@@ -1,63 +1,74 @@
-!!!	warning
-	- Use a separate terminal window to run the node and each service separately.
-	- Whenever you need to restart the process, make sure you stop and delete all running Docker containers and images.
-
 ## Run the prover
 
-Since the prover is large and compute-expensive to build, we will use a docker container.
+1. Open a new terminal window.
 
-```bash
-docker run -v "/tmp/cdk/test.prover.config.json:/usr/src/app/config.json" -p 50061:50061 -p 50071:50071 --network host hermeznetwork/zkevm-prover:v3.0.2 zkProver -c /usr/src/app/config.json
-```
+2. Since the prover is large and compute-expensive to build, we will use a docker container.
+
+	```bash
+	docker run -v "/tmp/cdk/test.prover.config.json:/usr/src/app/config.json" -p 50061:50061 -p 50071:50071 --network host hermeznetwork/zkevm-prover:v3.0.2 zkProver -c /usr/src/app/config.json
+	```
 
-!!! important
-    The database logs may output an error while they wait for a node. For example:
+	!!! important
+		The database logs may output an error while they wait for a node. For example:
 
-    ```txt
-    2024-01-31 12:18:30.329 UTC [675] ERROR:  relation "state.nodes" does not exist at character 15
-    2024-01-31 12:18:30.329 UTC [675] STATEMENT:  SELECT * FROM state.nodes WHERE hash = E'\\xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff';
-    ```
+		```txt
+		2024-01-31 12:18:30.329 UTC [675] ERROR:  relation "state.nodes" does not exist at character 15
+		2024-01-31 12:18:30.329 UTC [675] STATEMENT:  SELECT * FROM state.nodes WHERE hash = E'\\xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff';
+		```
 
-    The node log may also output an error while they wait for services to come online. For example:
+		The node log may also output an error while they wait for services to come online. For example:
 
-    ```txt
-    aggregatorClientMockThread() channel broken; will retry in 5 seconds
-    aggregatorClientMockThread() failed calling readerWriter->Read(&aggregatorMessage)
-    ```
+		```txt
+		aggregatorClientMockThread() channel broken; will retry in 5 seconds
+		aggregatorClientMockThread() failed calling readerWriter->Read(&aggregatorMessage)
+		```
 
 ## Run the node
 
-```bash
-cd ~/cdk-validium/cdk-validium-node 
-./dist/zkevm-node run --network custom --custom-network-file /tmp/cdk/genesis.json --cfg /tmp/cdk/node-config.toml \
-	--components sequencer \
-	--components sequence-sender \
-	--components aggregator \
-	--components rpc --http.api eth,net,debug,zkevm,txpool,web3 \
-	--components synchronizer \
-	--components eth-tx-manager \
-	--components l2gaspricer
-```
+1. Open a new terminal window.
+
+2. Run the following commands.
+
+	```bash
+	cd ~/cdk-validium/cdk-validium-node 
+	./dist/zkevm-node run --network custom --custom-network-file /tmp/cdk/genesis.json --cfg /tmp/cdk/node-config.toml \
+		--components sequencer \
+		--components sequence-sender \
+		--components aggregator \
+		--components rpc --http.api eth,net,debug,zkevm,txpool,web3 \
+		--components synchronizer \
+		--components eth-tx-manager \
+		--components l2gaspricer
+	```
 
 ### Run the additional approval scripts for the node
 
-```bash
-./dist/zkevm-node approve --network custom \
-	--custom-network-file /tmp/cdk/genesis.json \
-	--cfg /tmp/cdk/node-config.toml \
-	--amount 1000000000000000000000000000 \
-	--password "testonly" --yes --key-store-path /tmp/cdk/account.key
-```
+1. Open a new terminal window at the same directory as the previous step.
+
+2. Run the following commands.
+
+	```bash
+	cd ~/cdk-validium/cdk-validium-node 
+	./dist/zkevm-node approve --network custom \
+		--custom-network-file /tmp/cdk/genesis.json \
+		--cfg /tmp/cdk/node-config.toml \
+		--amount 1000000000000000000000000000 \
+		--password "testonly" --yes --key-store-path /tmp/cdk/account.key
+	```
 
 ## Run the DAC
 
+Open a new terminal window and run the following command.
+
 ```bash
 cd ~/cdk-validium/cdk-data-availability-0.0.3
 ./dist/cdk-data-availability run --cfg /tmp/cdk/dac-config.toml
 ```
 
 ## Run the bridge service
 
+Open a new terminal window and run the following command.
+
 ```bash
 cd ~/cdk-validium/zkevm-bridge-service 
 ./dist/zkevm-bridge run --cfg /tmp/cdk/bridge-config.toml