Merge pull request 0xPolygon#255 from 0xPolygon/cdk/validium-test-run

CDK/validium test run, more fixes and clarifications

Author: kmurphypolygon

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

@@ -1,13 +1,19 @@
 ## Configure deployment parameters
 
-1. Run the following `jq` script to streamline the process of replacing the fields with the `/tmp/cdk/.env` data:
+1. Navigate to the contracts deployment directory.
+
+    ```sh
+    cd ~/cdk-validium/cdk-validium-contracts-0.0.2/deployment
+    ```
+
+2. Run the following `jq` script to streamline the process of replacing the fields with the `/tmp/cdk/.env` data:
 
     ```bash
     source /tmp/cdk/.env
     jq --arg TEST_ADDRESS "$TEST_ADDRESS" '.trustedSequencerURL = "http://127.0.0.1:8123" | .trustedSequencer = $TEST_ADDRESS | .trustedAggregator = $TEST_ADDRESS | .admin = $TEST_ADDRESS | .cdkValidiumOwner = $TEST_ADDRESS | .initialCDKValidiumDeployerOwner = $TEST_ADDRESS | .timelockAddress = $TEST_ADDRESS | .forkID = 6' ./deploy_parameters.json.example > ./deploy_parameters.json
     ```
 
-2. The complete `deploy_parameters.json` should look something like this, where all the addresses are equal to the generated address except for `maticTokenAddress`:
+3. The complete `deploy_parameters.json` should look something like this, where all the addresses are equal to the generated address except for `maticTokenAddress`:
 
     ```bash
     nano ~/cdk-validium/cdk-validium-contracts-0.0.2/deployment/deploy_parameters.json
@@ -48,7 +54,7 @@ This is a factory contract that deploys the deterministic contracts required by
 
 The address of the contracts it creates depends on the salt and the `initialCDKValidiumDeployerOwner` inside `deploy_parameters.json`.
 
-1. From the same `deployment` directory, run the deploy script.
+1. From the same `deployment` directory you were already in, run the deploy script.
 
     ```bash 
     npm run deploy:deployer:CDKValidium:sepolia
@@ -137,10 +143,10 @@ If you would rather use a different node provider than Infura, modify the conten
 For example, using Alchemy:
 
 ```bash
-MNEMONIC="island debris exhaust typical clap debate exhaust little verify mean sausage entire"
-INFURA_PROJECT_ID="" # or blank if not using Infura
-ETHERSCAN_API_KEY="1234567890abcdefghijklmnopqr" # or blank if not verify contracts
-ALCHEMY_PROJECT_ID="dGPpsDzM9KpFTEnqMO44rvIXcc0fmgxr" # add this line
+MNEMONIC="test test test test test test test test test test test junk"
+INFURA_PROJECT_ID="" # leave blank when not using Infura
+ETHERSCAN_API_KEY="" # or blank if not verifying contracts
+ALCHEMY_PROJECT_ID="" # add the Alchemy data here
 ```
 
 ```bash

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

@@ -19,7 +19,7 @@ Make sure you have the following minimum software requirements.
 
 ## Access to a Sepolia node
 
-Use a node provider like Infura or Alchemy. We use Infura throughout but you can use any node provider you wish. 
+Use a node provider like Infura or Alchemy. We use Infura throughout but you can [use a different node provider](deploy-contracts.md#use-a-different-node-provider) if you want.
 
 !!! important
     We recommend running your own Sepolia node for a production set up. 
@@ -37,28 +37,13 @@ Use a public faucet to get Sepolia test ETH.
 - [Chainstack faucet](https://chainstack.com/sepolia-faucet/).
 - [Quicknode faucet](https://faucet.quicknode.com/ethereum/sepoli).
 
-## Configuration files
+## Configuration with environment variables
 
-We will be working with two separate `.env` files.
+We will be working with two separate `.env` files to manage the contracts and node configurations.
 
-- 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.
-
-```bash
-mkdir /tmp/cdk/
-```
+- One `.env` file resides in the contracts project directory. We will set this up in the [contracts environment variables set up](set-up.md#create-the-contracts-env-configuration) section.
+- Another `.env` resides in a shared system directory, `/tmp/cdk/`, which is accessible to the node and all running processes. We set this up in the [system-wide environment variables set up](set-up.md#create-the-shared-system-env-configuration) section. This shared `.env` file allows us to use `jq` and `tomlq` to easily setup the configuration for the node and running processes.
 
 !!! danger
     - Any files in the `tmp/` directory are deleted on shutdown.
-    - For this reason, we recommend that you copy this folder and paste it into your home directory once the shared configuration set up is complete. That way, you can just paste it back after the `tmp` directory empties.
-
-### Shared environment variables
-
-We will add a `.env` file to the `/tmp/cdk/` directory 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.
-
-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).
-
-!!! danger
-    Don't forget: The system removes this file on shutdown.
+    - For this reason, we recommend that you copy this folder and paste it into your home directory once the shared configuration set up is complete. That way, you can just add it back when you need to.

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

@@ -62,19 +62,16 @@ npm install
 
 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. 
+4. This is what the `.env` file looks like.
 
     ```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)
+    MNEMONIC="test test test test test test test test test test test junk"
+    INFURA_PROJECT_ID=""
+    ETHERSCAN_API_KEY=""
     ```
 
     Replace the variables as follows:
@@ -88,27 +85,29 @@ npm install
 
 ## Create the shared system `.env` configuration
 
-1.  Now create the *other* `.env` file residing in `/tmp/cdk/.env` which we created in the prerequisite steps.
+1.  Now create a new directory to store the *other* `.env` file, `cd` into it, and create the `.env` file.
 
     ```sh
-    nano /tmp/cdk/.env
+    mkdir /tmp/cdk/
+    cd ~/tmp/cdk/
+    nano .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. 
+2.  Copy and paste the data below into the file. 
 
-    ```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_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
+    ```txt
+    TEST_ADDRESS=""
+    TEST_PRIVATE_KEY="" 
+    L1_URL="https://sepolia.infura.io/v3/<YOUR_INFURA_API_KEY>" 
+    L1_WS_URL="wss://sepolia.infura.io/ws/v3/<YOUR_INFURA_API_KEY>" 
     ```
 
-    Replace the following variables:
+    Replace the variables with the following:
 
-    - `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>
+    - `TEST_ADDRESS` is the address generated by cast 
+    - `TEST_PRIVATE_KEY` is the private key generated by cast
+    - `L1_URL` is your Infura Sepolia RPC URL
+    - `L1_WS_URL` is your Infura Sepolia wss URL
 
 ## Send Sepolia
 

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

@@ -16,7 +16,7 @@ The process requires two separate flows with different software requirements. Fo
 
 ## Git repos and running order
 
-These are code bases we used to set everything up for this deployment guide, and in this order.
+These are the code bases we used to set everything up for this deployment guide, and in this order.
 
 !!! warning
     The versions below may not be the most recent.

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

@@ -31,6 +31,10 @@ jq '.aggregatorClientHost = "127.0.0.1" | .databaseURL = "postgresql://cdk_user:
 
 3. Create a file `node-config.toml` inside `/tmp/cdk/` and paste in the following content.
 
+	```bash
+	nano /tmp/cdk/node-config.toml
+	```
+
 	???     "`node-config.toml`"		
 			#/tmp/cdk/node-config.toml
 			IsTrustedSequencer = true
@@ -238,6 +242,10 @@ Now let’s configure the Data Availability Committee.
 
 1. Navigate to `~/cdk-validium/cdk-data-availability`.
 
+	```sh
+	cd ~/cdk-validium/cdk-data-availability
+	```
+
 2. Build the DAC
 
 	```bash
@@ -246,6 +254,10 @@ Now let’s configure the Data Availability Committee.
 
 3. Create a `dac-config.toml` file inside `/tmp/cdk/`. 
 
+	```bash
+	nano /tmp/cdk/dac-config.toml
+	```
+
 4. Copy and paste the following example config below into `dac-config.toml`.
 
 	```bash
@@ -327,7 +339,11 @@ Now let’s configure the Data Availability Committee.
 	make build
 	```
 
-2. Create a starter bridge config `bridge-config.toml` inside `/tmp/cdk` using the following config file:
+2. Create a starter bridge config `bridge-config.toml` inside `/tmp/cdk` and copy/paste the file below.
+
+	```bash
+	nano /tmp/cdk/bridge-config.toml
+	```
 
 	```bash
 	#/tmp/cdk/bridge-config.toml

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

@@ -65,7 +65,7 @@
 
 ## Run the DAC
 
-Open a new terminal window and run the following command.
+Navigate to the `cdk-data-availability` directory and run the following command.
 
 ```bash
 cd ~/cdk-validium/cdk-data-availability
@@ -83,4 +83,6 @@ cd ~/cdk-validium/zkevm-bridge-service-0.3.1/
 
 ## Congratulations
 
-You have now set up and deployed a full CDK validium network.
+You have now set up and deployed a full CDK validium network.
+
+Check the next section to find out how to send a test transaction.

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

@@ -1,6 +1,6 @@
 ## Set up the environment variables
 
-1. Navigate to `cdk-validium-contracts-0.0.2/deployment` and run the following script that inputs the required parameters from `deploy_output.json` into `/tmp/cdk/.env`.
+1. Navigate to `~/cdk-validium/cdk-validium-contracts-0.0.2/deployment` and run the following script that inputs the required parameters from `deploy_output.json` into `/tmp/cdk/.env`.
 
     ```bash
     cd ~/cdk-validium/cdk-validium-contracts-0.0.2/deployment
@@ -54,6 +54,15 @@
     cd cdk-validium-node/
     ```
 
+    !!! warning 
+
+        Make sure to remove all previously running Docker containers and images.
+
+        ```sh
+        docker rm $(docker ps -aq)
+        docker rmi $(docker images -q)
+        ```
+
 2. Run the docker command below to start an instance of the `psql` database. The database is used for many of the services, such as the node, prover, DAC, and bridge service.
 
     ```bash
@@ -75,7 +84,7 @@
         kill -9 <PID>
         ```
 
-3.  Use the following command to validate the setup (`\q` to exit).
+3.  In a new terminal window, use the following command to validate the setup (`\q` to exit).
 
     ```bash
     PGPASSWORD=cdk_password psql -h localhost -U cdk_user -d postgres -p 5432
@@ -93,7 +102,7 @@ The `cdk-validium-node` directory contains a script called `single_db_server.sql
 1. In a new terminal window, run the script to provision all the necessary databases and schemas used for the prover and node:
 
     ```bash
-    cd cdk-validium/cdk-validium-node
+    cd ~/cdk-validium/cdk-validium-node
     PGPASSWORD=cdk_password psql -h localhost -U cdk_user -d postgres -p 5432 -a -q -f ./db/scripts/single_db_server.sql
     ```
 

docs/cdk/get-started/deploy-validium/node/test-transaction.md

@@ -0,0 +1,31 @@
+## Test transactions
+
+Once everything is up and running you can do a quick test of the running stack by sending a zero-value transaction.
+
+Run the following command where the mnemonic is for testing and the address can be any account address.
+
+```sh
+cast send --legacy --mnemonic 'code code code code code code code code code code code quality' --value 0 --gas-price 0 --rpc-url http://127.0.0.1:8123 0x0bb7AA0b4FdC2D2862c088424260e99ed6299148
+```
+
+You should see something like this as output:
+
+```sh
+blockHash               0x5d6d45f46e54c5d0890dd8a4ede989dc8042d7d3aeada375ea11d2e77c91a298
+blockNumber             1
+contractAddress        
+cumulativeGasUsed       21000
+effectiveGasPrice       0
+from                    0x85dA99c8a7C2C95964c8EfD687E95E632Fc533D6
+gasUsed                 21000
+logs                    []
+logsBloom               0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+root                    0x97b15537641583db08f1e3db15cb1e89212ed8d147670a11f93f368d5960e72f
+status                  1
+transactionHash         0xd5443cff8dcc1147ead09d978d3abe9179615aa3eecbe4819c6768390bc467a3
+transactionIndex        0
+type                    0
+to                      0x66ec…89fd
+```
+
+Status `1` signifies a successful transaction.

mkdocs.yml

@@ -70,6 +70,7 @@ nav:
                   - Set up: cdk/get-started/deploy-validium/node/set-up.md
                   - Configure the deployment: cdk/get-started/deploy-validium/node/configure-deployment.md
                   - Run node and services: cdk/get-started/deploy-validium/node/run-node-services.md
+                  - Test transaction: cdk/get-started/deploy-validium/node/test-transaction.md
           - Rollup: 
               - Introduction: cdk/get-started/deploy-rollup/intro.md
               - Environment overview: cdk/get-started/deploy-rollup/environment-overview.md