Skip to content

Commit 0fc0220

Browse files
lesterlilesterli
committed
update for comments
1 parent 69430ba commit 0fc0220

File tree

1 file changed

+36
-29
lines changed

1 file changed

+36
-29
lines changed

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

Lines changed: 36 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -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,22 +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
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
120114
zkevm-bridge-db docker-entrypoint.sh postg ... Up 0.0.0.0:5438->5432/tcp,:::5438->5432/tcp
121115
zkevm-bridge-service /bin/sh -c /app/zkevm-brid ... Up 0.0.0.0:8080->8080/tcp,:::8080->8080/tcp,
122116
0.0.0.0:9090->9090/tcp,:::9090->9090/tcp
@@ -125,16 +119,16 @@ zkevm-bridge-ui /bin/sh /app/scripts/deploy.sh Up
125119

126120
</details>
127121

128-
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:
129123

130124
```bash
131-
sudo docker-compose logs <container_name>
125+
sudo docker compose logs <container_name>
132126
```
133127

134128
!!! info
135129
Find the `<container_name>` in the log output.
136130

137-
2.4 Useful commands
131+
2.3 Useful commands
138132

139133
To stop CDK validium, use:
140134

@@ -145,7 +139,20 @@ sudo make stop
145139
To restart all services:
146140

147141
```bash
148-
sudo make restart
142+
sudo make run-resume
143+
```
144+
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 default is set to gasless. To disable gasless, use:
153+
154+
```bash
155+
sudo make gasless off
149156
```
150157

151158
!!! note

0 commit comments

Comments
 (0)