Skip to content

Commit 18c3775

Browse files
kmurphypolygonkmurphypolygon
committed
commit new page
1 parent b38395a commit 18c3775

File tree

4 files changed

+116
-113
lines changed

4 files changed

+116
-113
lines changed

‎docs/cdk/get-started/deploy-validium/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
This quick start takes you through the process of deploying a full CDK validium, EVM-compatible network on Sepolia.
22

3-
The process requires two separate steps with different software requirements. For this reason, these instructions have two distinct sections.
3+
The process requires two separate flows with different software requirements. For this reason, these instructions have two distinct sections.
44

5-
1. Deploying the contracts.
6-
2. Deploying the node and services.
5+
1. [Deploying the contracts](contracts/prerequisites.md).
6+
2. [Deploying the node and services]().
77

88
!!! warning
99
- The instructions are subject to frequent updates as the software remains at an early development stage.

‎docs/cdk/get-started/deploy-validium/node/deploy-node.md‎

Lines changed: 1 addition & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1,4 @@
1-
| Repo | Version |
2-
| --- | --- |
3-
| https://github.com/0xPolygon/cdk-validium-contracts/releases/tag/v0.0.2 | v0.0.2 |
4-
| https://github.com/0xPolygon/cdk-validium-node/releases/tag/v0.0.3 | v0.0.3 |
5-
| https://github.com/0xPolygonHermez/zkevm-prover | v3.0.2 |
6-
| https://github.com/0xPolygon/cdk-data-availability.git | v0.0.3 |
7-
| https://github.com/0xPolygonHermez/zkevm-bridge-service | v0.3.1 |
8-
9-
The listed version may not be the most recent, but this will give a general idea of how the deployment process works.
10-
11-
# Prerequisites
12-
13-
### Minimum Requirements:
14-
15-
| Minimum Disk Size | vCPUs | Memory (GB) | CPU Type | Architecture | OS |
16-
| --- | --- | --- | --- | --- | --- |
17-
| 32GB | 2 | 8 | Intel or AMD | x86/64 | Ubuntu 22.04 |
18-
19-
Your operating system should be Linux-based (preferably Ubuntu 22.04), and it must have an AMD or Intel chip.
20-
21-
Lastly, make sure you have at least `~0.3 Sepolia ETH` ready for deploying contracts and various contract calls.
22-
23-
## Dependency Checking
24-
25-
| Dependency | Version | Installation links |
26-
| --- | --- | --- |
27-
| git | 2.18.0 | https://git-scm.com/book/en/v2/Getting-Started-Installing-Git |
28-
| node | 16.0.0 | https://nodejs.org/en/download |
29-
| npm | 6.0.0 | https://docs.npmjs.com/downloading-and-installing-node-js-and-npm |
30-
| golang | 1.18.0 | https://go.dev/doc/install |
31-
| cast | 0.2.0 | https://book.getfoundry.sh/getting-started/installation |
32-
| jq | 1.0 | https://jqlang.github.io/jq/download/ |
33-
| tomlq | 3.0.0 | https://kislyuk.github.io/yq/#installation |
34-
| postgres | 15 | https://www.postgresql.org/download/ |
35-
| psql | 15.0 | https://www.postgresql.org/download/ |
36-
| make | 3.80.0 | https://www.gnu.org/software/make/ |
37-
| docker | 24.0.0 | https://docs.docker.com/engine/install/ |
38-
| pip3 | 20.0.0 | https://pip.pypa.io/en/stable/installation/ |
39-
| [For Testing] python3 | 3.8.0 | https://www.python.org/downloads/ |
40-
| [For Testing] polycli | 0.1.39 | https://github.com/maticnetwork/polygon-cli/tree/main |
41-
- You can run the following script to validate that dependency requirements are met:
42-
43-
```bash
44-
#!/bin/bash
45-
46-
declare -A commands
47-
commands["git"]="2.18.0"
48-
commands["node"]="16.0.0"
49-
commands["npm"]="6.0.0"
50-
commands["go"]="1.18.0"
51-
commands["cast"]="0.2.0"
52-
commands["jq"]="1.0"
53-
commands["tomlq"]="3.0.0"
54-
commands["psql"]="15.0"
55-
commands["make"]="3.80.0"
56-
commands["docker"]="24.0.0"
57-
commands["pip3"]="20.0.2"
58-
commands["python3"]="3.8.0"
59-
commands["polycli"]="0.1.39"
60-
61-
# Function to check command version
62-
check_version() {
63-
local command=$1
64-
local min_version=$2
65-
local version
66-
local status
67-
68-
if ! command -v "$command" &> /dev/null; then
69-
printf "| %-15s | %-20s | %-20s |\n" "$command" "Not Found" "$min_version"
70-
return
71-
fi
72-
73-
case "$command" in
74-
git) version=$(git --version | awk '{print $3}') ;;
75-
node) version=$(node --version | cut -d v -f 2) ;;
76-
npm) version=$(npm --version) ;;
77-
go) version=$(go version | awk '{print $3}' | cut -d 'o' -f 2) ;;
78-
cast) version=$(cast --version | awk '{print $2}') ;;
79-
jq) version=$(jq --version | cut -d '-' -f 2) ;;
80-
tomlq) version=$(tomlq --version | awk '{print $2}') ;;
81-
psql) version=$(psql --version | awk '{print $3}') ;;
82-
make) version=$(make --version | head -n 1 | awk '{print $3}') ;;
83-
docker) version=$(docker --version | awk '{print $3}' | cut -d ',' -f 1) ;;
84-
pip3) version=$(pip3 --version | awk '{print $2}') ;;
85-
python3) version=$(python3 --version | awk '{print $2}') ;;
86-
polycli) version=$(polycli version | awk '{print $4}' | cut -d '-' -f 1 | sed 's/v//') ;;
87-
*) version="Found" ;;
88-
esac
89-
90-
printf "| %-15s | %-20s | %-20s |\n" "$command" "$version" "$min_version"
91-
}
92-
93-
echo "+-----------------+----------------------+----------------------+"
94-
printf "| %-15s | %-20s | %-20s |\n" "CLI Command" "Found Version" "Minimum Version"
95-
echo "+-----------------+----------------------+----------------------+"
96-
97-
for cmd in "${!commands[@]}"; do
98-
check_version "$cmd" "${commands[$cmd]}"
99-
echo "+-----------------+----------------------+----------------------+"
100-
done
101-
```
102-
103-
You can create a `version-check.sh` file, then copy and paste the script into that file. Then run the following to execute the script:
104-
105-
```bash
106-
chmod +x version-check.sh
107-
./version-check.sh
108-
```
109-
1+
1102

1113
# Setup & Deployment
1124

‎docs/cdk/get-started/deploy-validium/node/prerequisites.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
| Repo | Version |
2+
| --- | --- |
3+
| https://github.com/0xPolygon/cdk-validium-contracts/releases/tag/v0.0.2 | v0.0.2 |
4+
| https://github.com/0xPolygon/cdk-validium-node/releases/tag/v0.0.3 | v0.0.3 |
5+
| https://github.com/0xPolygonHermez/zkevm-prover | v3.0.2 |
6+
| https://github.com/0xPolygon/cdk-data-availability.git | v0.0.3 |
7+
| https://github.com/0xPolygonHermez/zkevm-bridge-service | v0.3.1 |
8+
9+
The listed version may not be the most recent, but this will give a general idea of how the deployment process works.
10+
11+
# Prerequisites
12+
13+
### Minimum Requirements:
14+
15+
| Minimum Disk Size | vCPUs | Memory (GB) | CPU Type | Architecture | OS |
16+
| --- | --- | --- | --- | --- | --- |
17+
| 32GB | 2 | 8 | Intel or AMD | x86/64 | Ubuntu 22.04 |
18+
19+
Your operating system should be Linux-based (preferably Ubuntu 22.04), and it must have an AMD or Intel chip.
20+
21+
Lastly, make sure you have at least `~0.3 Sepolia ETH` ready for deploying contracts and various contract calls.
22+
23+
## Dependency Checking
24+
25+
| Dependency | Version | Installation links |
26+
| --- | --- | --- |
27+
| git | 2.18.0 | https://git-scm.com/book/en/v2/Getting-Started-Installing-Git |
28+
| node | 16.0.0 | https://nodejs.org/en/download |
29+
| npm | 6.0.0 | https://docs.npmjs.com/downloading-and-installing-node-js-and-npm |
30+
| golang | 1.18.0 | https://go.dev/doc/install |
31+
| cast | 0.2.0 | https://book.getfoundry.sh/getting-started/installation |
32+
| jq | 1.0 | https://jqlang.github.io/jq/download/ |
33+
| tomlq | 3.0.0 | https://kislyuk.github.io/yq/#installation |
34+
| postgres | 15 | https://www.postgresql.org/download/ |
35+
| psql | 15.0 | https://www.postgresql.org/download/ |
36+
| make | 3.80.0 | https://www.gnu.org/software/make/ |
37+
| docker | 24.0.0 | https://docs.docker.com/engine/install/ |
38+
| pip3 | 20.0.0 | https://pip.pypa.io/en/stable/installation/ |
39+
| [For Testing] python3 | 3.8.0 | https://www.python.org/downloads/ |
40+
| [For Testing] polycli | 0.1.39 | https://github.com/maticnetwork/polygon-cli/tree/main |
41+
- You can run the following script to validate that dependency requirements are met:
42+
43+
```bash
44+
#!/bin/bash
45+
46+
declare -A commands
47+
commands["git"]="2.18.0"
48+
commands["node"]="16.0.0"
49+
commands["npm"]="6.0.0"
50+
commands["go"]="1.18.0"
51+
commands["cast"]="0.2.0"
52+
commands["jq"]="1.0"
53+
commands["tomlq"]="3.0.0"
54+
commands["psql"]="15.0"
55+
commands["make"]="3.80.0"
56+
commands["docker"]="24.0.0"
57+
commands["pip3"]="20.0.2"
58+
commands["python3"]="3.8.0"
59+
commands["polycli"]="0.1.39"
60+
61+
# Function to check command version
62+
check_version() {
63+
local command=$1
64+
local min_version=$2
65+
local version
66+
local status
67+
68+
if ! command -v "$command" &> /dev/null; then
69+
printf "| %-15s | %-20s | %-20s |\n" "$command" "Not Found" "$min_version"
70+
return
71+
fi
72+
73+
case "$command" in
74+
git) version=$(git --version | awk '{print $3}') ;;
75+
node) version=$(node --version | cut -d v -f 2) ;;
76+
npm) version=$(npm --version) ;;
77+
go) version=$(go version | awk '{print $3}' | cut -d 'o' -f 2) ;;
78+
cast) version=$(cast --version | awk '{print $2}') ;;
79+
jq) version=$(jq --version | cut -d '-' -f 2) ;;
80+
tomlq) version=$(tomlq --version | awk '{print $2}') ;;
81+
psql) version=$(psql --version | awk '{print $3}') ;;
82+
make) version=$(make --version | head -n 1 | awk '{print $3}') ;;
83+
docker) version=$(docker --version | awk '{print $3}' | cut -d ',' -f 1) ;;
84+
pip3) version=$(pip3 --version | awk '{print $2}') ;;
85+
python3) version=$(python3 --version | awk '{print $2}') ;;
86+
polycli) version=$(polycli version | awk '{print $4}' | cut -d '-' -f 1 | sed 's/v//') ;;
87+
*) version="Found" ;;
88+
esac
89+
90+
printf "| %-15s | %-20s | %-20s |\n" "$command" "$version" "$min_version"
91+
}
92+
93+
echo "+-----------------+----------------------+----------------------+"
94+
printf "| %-15s | %-20s | %-20s |\n" "CLI Command" "Found Version" "Minimum Version"
95+
echo "+-----------------+----------------------+----------------------+"
96+
97+
for cmd in "${!commands[@]}"; do
98+
check_version "$cmd" "${commands[$cmd]}"
99+
echo "+-----------------+----------------------+----------------------+"
100+
done
101+
```
102+
103+
You can create a `version-check.sh` file, then copy and paste the script into that file. Then run the following to execute the script:
104+
105+
```bash
106+
chmod +x version-check.sh
107+
./version-check.sh
108+
```
109+

‎mkdocs.yml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,11 @@ nav:
5050
- Introduction: cdk/get-started/deploy-validium/index.md
5151
- Deploy contracts:
5252
- Prerequisites: cdk/get-started/deploy-validium/contracts/prerequisites.md
53-
- Environment overview: cdk/get-started/deploy-validium/contracts/environment-overview.md
5453
- Set up: cdk/get-started/deploy-validium/contracts/set-up.md
5554
- Deploy contracts: cdk/get-started/deploy-validium/contracts/deploy-contracts.md
55+
- Deploy node:
56+
- Prerequisites: cdk/get-started/deploy-validium/node/prerequisites.md
57+
- Deploy node: cdk/get-started/deploy-validium/node/deploy-node.md
5658
- Rollup:
5759
- Introduction: cdk/get-started/deploy-rollup/intro.md
5860
- Environment overview: cdk/get-started/deploy-rollup/environment-overview.md

0 commit comments

Comments
 (0)