|
1 | 1 |
|
2 | 2 |
|
3 | | -# Setup & Deployment |
4 | | - |
5 | | -First, lets navigate back to the working directory we created earlier, `~/cdk-validium` |
6 | | - |
7 | | -```bash |
8 | | -cd ~/cdk-validium |
9 | | -``` |
10 | | - |
11 | | -For this setup, we will also need our information from `deploy_output.json` inside `~/cdk-validium/cdk-validium-contracts-0.0.2/deployment`. Navigate back to `~/cdk-validium/cdk-validium-contracts-0.0.2/deployment` and run the following script to fill the required parameters into the `/tmp/cdk/.env` we created in the previous steps: |
12 | | - |
13 | | -```bash |
14 | | -cd ~/cdk-validium/cdk-validium-contracts-0.0.2/deployment |
15 | | -echo "GEN_BLOCK_NUMBER=$(jq -r '.deploymentBlockNumber' deploy_output.json)" >> /tmp/cdk/.env |
16 | | -echo "CDK_VALIDIUM_ADDRESS=$(jq -r '.cdkValidiumAddress' deploy_output.json)" >> /tmp/cdk/.env |
17 | | -echo "POLYGON_ZKEVM_BRIDGE_ADDRESS=$(jq -r '.polygonZkEVMBridgeAddress' deploy_output.json)" >> /tmp/cdk/.env |
18 | | -echo "POLYGON_ZKEVM_GLOBAL_EXIT_ROOT_ADDRESS=$(jq -r '.polygonZkEVMGlobalExitRootAddress' deploy_output.json)" >> /tmp/cdk/.env |
19 | | -echo "CDK_DATA_COMMITTEE_CONTRACT_ADDRESS=$(jq -r '.cdkDataCommitteeContract' deploy_output.json)" >> /tmp/cdk/.env |
20 | | -echo "MATIC_TOKEN_ADDRESS=$(jq -r '.maticTokenAddress' deploy_output.json)" >> /tmp/cdk/.env |
21 | | -``` |
22 | | - |
23 | | -Source our new environment and navigate back to `~/cdk-validium`: |
24 | | - |
25 | | -```bash |
26 | | -source /tmp/cdk/.env |
27 | | -cd ~/cdk-validium |
28 | | -``` |
29 | | - |
30 | | -## 1. Downloading cdk-validium-node, cdk-data-availability, and cdk-bridge-service |
31 | | - |
32 | | -Now clone the `0.0.3` release of `cdk-validium-node`. |
33 | | - |
34 | | -```bash |
35 | | -git clone --depth 1 --branch v0.0.3 https://github.com/0xPolygon/cdk-validium-node.git |
36 | | -``` |
37 | | - |
38 | | -We also must download and extract version `0.0.3` of `cdk-data-availability.` The release file is available here: |
39 | | - |
40 | | -[Untitled Database](https://www.notion.so/b329e3b1511943ae979cc2b4c73a35e8?pvs=21) |
41 | | - |
42 | | -Downloading `cdk-validium-contracts` as a ***`tar.gz`*** and extracting |
43 | | - |
44 | | -```bash |
45 | | -~/cdk-validium % curl -L -o cdk-data-availability.tar.gz https://github.com/0xPolygon/cdk-data-availability/archive/refs/tags/v0.0.3.tar.gz |
46 | | -\tar -xzf cdk-data-availability.tar.gz |
47 | | -``` |
48 | | - |
49 | | -Finally, the `cdk-bridge-service` release `0.3.1`. The release file can be found here: |
50 | | - |
51 | | -```bash |
52 | | -curl -L -o cdk-bridge-service.tar.gz https://github.com/0xPolygonHermez/zkevm-bridge-service/archive/refs/tags/v0.3.1.tar.gz |
53 | | -\tar -xzf cdk-bridge-service.tar.gz |
54 | | - |
55 | | -``` |
56 | | -Now we have three new directories in *`cdk-validium/`* named ***`cdk-data-availability-0.0.3`, `cdk-validium-node` and `zkevm-bridge-service-0.3.1`*** |
57 | | - |
58 | | -## 2. Preparing the environment |
59 | | - |
60 | | -We will begin our setup in the node directory. |
61 | | - |
62 | | -Navigate into the node directory we cloned from the previous step***`cdk-validium-node/`*** |
63 | | - |
64 | | -```bash |
65 | | -~/cdk-validium % cd cdk-validium-node/ |
66 | | -``` |
67 | | - |
68 | | -### Setup the database |
69 | | - |
70 | | -Run the docker command 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. |
71 | | - |
72 | | -```bash |
73 | | -docker run -e POSTGRES_USER=cdk_user -e POSTGRES_PASSWORD=cdk_password -e POSTGRES_DB=postgres -p 5432:5432 postgres:15 |
74 | | -``` |
75 | | - |
76 | | -*note: if you are unable to start the process because port is in use, check the processes occupying the port then kill the processes* |
77 | | - |
78 | | -```bash |
79 | | -sudo lsof -t -i:5432 |
80 | | -kill -9 <PID> |
81 | | -``` |
82 | | - |
83 | | -Once you have postgres running, validate you have the following setup correctly: |
84 | | - |
85 | | -- an admin account called: `cdk_user` with a password of `cdk_password` |
86 | | -- postgres server running on `localhost:5432` |
87 | | - |
88 | | -You can use the following command to validate the steps, `\q` to exit: |
89 | | - |
90 | | -```bash |
91 | | -PGPASSWORD=cdk_password psql -h localhost -U cdk_user -d postgres -p 5432 |
92 | | -#=> \q |
93 | | -``` |
94 | | - |
95 | | -### Provision the database |
96 | | - |
97 | | -The `cdk-validium-node` directory contains a script called `single_db_server.sql` that provisions all the databases required for the prover, state, and pool to operate. Run the script to provision all the necessary databases and schemas that will be used for both the prover and node: |
98 | | - |
99 | | -```bash |
100 | | -~/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 |
101 | | -``` |
102 | | - |
103 | | -In addition to the provisions required for the prover and node, another provision is needed for the Data Availability Committee (DAC). We can set this up now for use later. |
104 | | - |
105 | | -```bash |
106 | | -PGPASSWORD=cdk_password psql -h localhost -U cdk_user -d postgres -p 5432 -c "CREATE DATABASE committee_db;" |
107 | | -``` |
108 | | - |
109 | | -Finally, we will provision a database for our bridge service, which we will setup last in this guide. |
110 | | - |
111 | | -```bash |
112 | | -PGPASSWORD=cdk_password psql -h localhost -U cdk_user -d postgres -p 5432 -c "CREATE DATABASE bridge_db;" |
113 | | -``` |
114 | | - |
115 | 3 | ### Configure the prover |
116 | 4 |
|
117 | 5 | To configure our prover, lets copy and modify the contents of `test.prover.config.json` inside `~/cdk-validium/cdk-validium-node/test/config/` to our `/tmp/cdk/` directory we created earlier using the following jq command: |
|
0 commit comments