Skip to content

Commit 64ab2bf

Browse files
hsutaiyuhsutaiyu
authored
Merge pull request 0xPolygon#337 from Snapchain/feat/update-quickstart-validium
update quickstart-validium for 0.6.4-cdk.2
2 parents 3f29a47 + bacbd90 commit 64ab2bf

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

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

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This quick start guide shows you how to set up a CDK validium on your local mach
1111
- Explorers L1, L2
1212
- JSON RPC explorer
1313
- L2 gas pricer
14-
- DAC: data availability service, dac setup committee
14+
- DAC: data availability service
1515
- zkEVM bridge service and UI
1616

1717
!!! note
@@ -51,22 +51,16 @@ cp .env.example .env
5151

5252
## 2. Launch validium locally
5353

54-
2.1 Pull the required Docker images from Docker Hub:
55-
56-
```bash
57-
sudo docker-compose pull
58-
```
59-
60-
2.2 After pulling the images, start your local CDK validium:
54+
2.1 Start your local CDK validium:
6155

6256
```bash
6357
sudo make run
6458
```
6559

66-
2.3 To ensure all services are running properly, check the status of each container:
60+
2.2 To ensure all services are running properly, check the status of each container:
6761

6862
```bash
69-
docker-compose ps
63+
docker compose ps
7064
```
7165

7266
You should see the following output:
@@ -77,14 +71,14 @@ You should see the following output:
7771
```shell
7872
Name Command State Ports
7973
----------------------------------------------------------------------------------------------------------------------------------------------
80-
cdk-validium-aggregator /bin/sh -c /app/cdk-validi ... Up 0.0.0.0:50081->50081/tcp,:::50081->50081/tcp, 8123/tcp,
74+
zkevm-aggregator /bin/sh -c /app/cdk-validi ... Up 0.0.0.0:50081->50081/tcp,:::50081->50081/tcp, 8123/tcp,
8175
0.0.0.0:9093->9091/tcp,:::9093->9091/tcp
82-
cdk-validium-approve /bin/sh -c /app/cdk-validi ... Exit 0
83-
cdk-validium-data-availability /bin/sh -c /app/cdk-data-a ... Up 0.0.0.0:8444->8444/tcp,:::8444->8444/tcp
84-
cdk-validium-data-node-db docker-entrypoint.sh postg ... Up (healthy) 0.0.0.0:5444->5432/tcp,:::5444->5432/tcp
85-
cdk-validium-eth-tx-manager /bin/sh -c /app/cdk-validi ... Up 8123/tcp, 0.0.0.0:9094->9091/tcp,:::9094->9091/tcp
86-
cdk-validium-event-db docker-entrypoint.sh postg ... Up 0.0.0.0:5435->5432/tcp,:::5435->5432/tcp
87-
cdk-validium-explorer-json-rpc /bin/sh -c /app/cdk-validi ... Up 8123/tcp, 0.0.0.0:8124->8124/tcp,:::8124->8124/tcp,
76+
zkevm-approve /bin/sh -c /app/cdk-validi ... Exit 0
77+
zkevm-data-availability /bin/sh -c /app/cdk-data-a ... Up 0.0.0.0:8444->8444/tcp,:::8444->8444/tcp
78+
zkevm-data-node-db docker-entrypoint.sh postg ... Up (healthy) 0.0.0.0:5444->5432/tcp,:::5444->5432/tcp
79+
zkevm-eth-tx-manager /bin/sh -c /app/cdk-validi ... Up 8123/tcp, 0.0.0.0:9094->9091/tcp,:::9094->9091/tcp
80+
zkevm-event-db docker-entrypoint.sh postg ... Up 0.0.0.0:5435->5432/tcp,:::5435->5432/tcp
81+
zkevm-explorer-json-rpc /bin/sh -c /app/cdk-validi ... Up 8123/tcp, 0.0.0.0:8124->8124/tcp,:::8124->8124/tcp,
8882
0.0.0.0:8134->8134/tcp,:::8134->8134/tcp
8983
explorer-sig-provider ./sig-provider-serv ... Up 0.0.0.0:8151->8050/tcp
9084
visualizer-proxy /docker-entrypoint ... Up 80/tcp, 0.0.0.0:8083->8081/tcp
@@ -101,23 +95,22 @@ explorer-stats-db-l2 docker-entrypoint.s ... Up
10195
explorer-frontend-l2 sh -c 'bin/blocksco ... Up 0.0.0.0:3001->3000/tcp
10296
explorer-backend-l2 sh -c 'bin/blocksco ... Up 0.0.0.0:4001->4000/tcp
10397
explorer-backend-l2-db docker-entrypoint.sh postg ... Up 0.0.0.0:5437->5432/tcp
104-
cdk-validium-json-rpc /bin/sh -c /app/cdk-validi ... Up 0.0.0.0:8123->8123/tcp,:::8123->8123/tcp,
98+
zkevm-json-rpc /bin/sh -c /app/cdk-validi ... Up 0.0.0.0:8123->8123/tcp,:::8123->8123/tcp,
10599
0.0.0.0:8133->8133/tcp,:::8133->8133/tcp,
106100
0.0.0.0:9091->9091/tcp,:::9091->9091/tcp
107-
cdk-validium-l2gaspricer /bin/sh -c /app/cdk-validi ... Up 8123/tcp
108-
cdk-validium-mock-l1-network geth --http --http.api adm ... Up 30303/tcp, 30303/udp,
101+
zkevm-l2gaspricer /bin/sh -c /app/cdk-validi ... Up 8123/tcp
102+
zkevm-mock-l1-network geth --http --http.api adm ... Up 30303/tcp, 30303/udp,
109103
0.0.0.0:8545->8545/tcp,:::8545->8545/tcp,
110104
0.0.0.0:8546->8546/tcp,:::8546->8546/tcp
111-
cdk-validium-pool-db docker-entrypoint.sh postg ... Up 0.0.0.0:5433->5432/tcp,:::5433->5432/tcp
112-
cdk-validium-prover zkProver -c /usr/src/app/c ... Up 0.0.0.0:50052->50052/tcp,:::50052->50052/tcp,
105+
zkevm-pool-db docker-entrypoint.sh postg ... Up 0.0.0.0:5433->5432/tcp,:::5433->5432/tcp
106+
zkevm-prover zkProver -c /usr/src/app/c ... Up 0.0.0.0:50052->50052/tcp,:::50052->50052/tcp,
113107
0.0.0.0:50061->50061/tcp,:::50061->50061/tcp,
114108
0.0.0.0:50071->50071/tcp,:::50071->50071/tcp
115-
cdk-validium-sequence-sender /bin/sh -c /app/cdk-validi ... Up 8123/tcp
116-
cdk-validium-sequencer /bin/sh -c /app/cdk-validi ... Up 0.0.0.0:6060->6060/tcp,:::6060->6060/tcp, 8123/tcp,
109+
zkevm-sequence-sender /bin/sh -c /app/cdk-validi ... Up 8123/tcp
110+
zkevm-sequencer /bin/sh -c /app/cdk-validi ... Up 0.0.0.0:6060->6060/tcp,:::6060->6060/tcp, 8123/tcp,
117111
0.0.0.0:9092->9091/tcp,:::9092->9091/tcp
118-
cdk-validium-state-db docker-entrypoint.sh postg ... Up 0.0.0.0:5432->5432/tcp,:::5432->5432/tcp
119-
cdk-validium-sync /bin/sh -c /app/cdk-validi ... Up 8123/tcp
120-
dac-setup-committee docker-entrypoint.sh npm r ... Exit 0
112+
zkevm-state-db docker-entrypoint.sh postg ... Up 0.0.0.0:5432->5432/tcp,:::5432->5432/tcp
113+
zkevm-sync /bin/sh -c /app/cdk-validi ... Up 8123/tcp
121114
zkevm-bridge-db docker-entrypoint.sh postg ... Up 0.0.0.0:5438->5432/tcp,:::5438->5432/tcp
122115
zkevm-bridge-service /bin/sh -c /app/zkevm-brid ... Up 0.0.0.0:8080->8080/tcp,:::8080->8080/tcp,
123116
0.0.0.0:9090->9090/tcp,:::9090->9090/tcp
@@ -126,16 +119,16 @@ zkevm-bridge-ui /bin/sh /app/scripts/deploy.sh Up
126119

127120
</details>
128121

129-
2.3.1 If a service isn't running (i.e. it is in `Exit 1` state), investigate further using the logs:
122+
2.2.1 If a service isn't running (i.e. it is in `Exit 1` state), investigate further using the logs:
130123

131124
```bash
132-
sudo docker-compose logs <container_name>
125+
sudo docker compose logs <container_name>
133126
```
134127

135128
!!! info
136129
Find the `<container_name>` in the log output.
137130

138-
2.4 Useful commands
131+
2.3 Useful commands
139132

140133
To stop CDK validium, use:
141134

@@ -146,9 +139,18 @@ sudo make stop
146139
To restart all services:
147140

148141
```bash
149-
sudo make restart
142+
sudo make run-resume
150143
```
151144

145+
To check all running or exited services, use:
146+
147+
```bash
148+
sudo make ps
149+
sudo make ps-exited
150+
```
151+
152+
In this guide, the L2 is launched that allows gasless transactions. To enable transaction gas, you need to first bridge fund from the L1 to the L2 under gasless mode, then run `sudo make gasless off`, stop and restart the services.
153+
152154
!!! note
153155
This local deployment runs on an L1 Geth instance.
154156

0 commit comments

Comments
 (0)