Skip to content

Commit d1788e1

Browse files
author
Esau
committed
fix
1 parent d7f76a1 commit d1788e1

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

docs/versioned_docs/version-v1.2.0/the_aztec_network/guides/run_nodes/how_to_run_sequencer_new.md

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,13 @@ Next you will need to define some environment variables that set important confi
105105
These include:
106106

107107
- `DATA_DIRECTORY`: the folder where the data of the sequencer is stored
108-
- `KEY_STORE_DIRECTORY`: the folder containing the `keystore.json` file created above
108+
- `KEY_STORE_DIRECTORY`: can be a path to the file or directory where keystores are located. In our case it is the path to the folder containing the `keystore.json` file created above
109109
- `LOG_LEVEL`: the desired level of logging for the sequencer. It defaults to info.
110110
- `ETHEREUM_HOSTS`: The execution RPC endpoints
111111
- `L1_CONSENSUS_HOST_URLS`: The consensus RPC endpoints
112112
- `P2P_IP`: The IP address of this sequencer
113+
- `P2P_PORT`: The port that P2P communication happens on
114+
- `AZTEC_PORT`: The port that the sequencer node API is exposed on
113115

114116
Please paste this sample `.env` file into the empty one currently residing in your `aztec-sequencer` folder. Please note that we are assuming you are using the default ports of 8080 for the sequencer itself, and 40400 for p2p connectivity. If this is not the case, please overwrite the defaults below.
115117

@@ -119,10 +121,17 @@ KEY_STORE_DIRECTORY=./keys
119121
LOG_LEVEL=info
120122
ETHEREUM_HOSTS=<your L1 execution endpoint, or a comma separated list if you have multiple>
121123
L1_CONSENSUS_HOST_URLS=<your L1 consensus endpoint, or a comma separated list if you have multiple>
122-
AZTEC_NODE_RPC_PORT=8080
123-
AZTEC_NODE_P2P_PORT=40400
124+
P2P_IP=<your external IP address>
125+
P2P_PORT=40400
126+
AZTEC_PORT=8080
124127
```
125128
129+
:::tip
130+
You MUST forward your ports. Your router must send UDP and TCP traffic on the port specified by `AZTEC_NODE_P2P_PORT` to your IP address on your local network.
131+
132+
If you are unable to determine your public ip. Running the command `curl ipv4.icanhazip.com` can retrieve it for you.
133+
:::
134+
126135
### Ensure auto-update / auto-restart is enabled
127136
128137
It is imperative that the built in auto-updating functionality of the sequencer is not disabled. The update-checker is a background module in the Aztec node that enables global coordination of updates. It allows the protocol team to:
@@ -136,9 +145,7 @@ This module ensures that upgrades and fixes propagate smoothly without requiring
136145
137146
Please ensure environment variables:
138147
139-
`AUTO_UPDATE_URL` remains unset, and
140-
141-
add `AUTO_UPDATE=config-and-version` to your `.env` file.
148+
`AUTO_UPDATE_URL` and `AUTO_UPDATE` remain unset, as to take their default values (which are the s3 bucket being used to host the update information, and `config-and-version` respectively).
142149
143150
Because docker-compose does not respect pull policies on container restarts, to handle updates properly, add Watchtower to your stack by running:
144151
@@ -159,26 +166,28 @@ services:
159166
image: "aztecprotocol/aztec:1.2.1"
160167
container_name: "aztec-sequencer"
161168
ports:
162-
- ${AZTEC_NODE_RPC_PORT}$:8080
163-
- ${AZTEC_NODE_P2P_PORT}$:40400
164-
- ${AZTEC_NODE_P2P_PORT}$:40400/udp
169+
- ${AZTEC_PORT}:${AZTEC_PORT}
170+
- ${P2P_PORT}:${P2P_PORT}
171+
- ${P2P_PORT}:${P2P_PORT}/udp
165172
volumes:
166-
- ${DATA_DIRECTORY}:/var/lib/data
167-
- ${KEY_STORE_DIRECTORY}:/var/lib/keystore
173+
- ${DATA_DIRECTORY}:/var/lib/data
174+
- ${KEY_STORE_DIRECTORY}:/var/lib/keystore
168175
environment:
169-
KEY_STORE_DIRECTORY: /var/lib/keystore
170-
DATA_DIRECTORY: /var/lib/data
171-
LOG_LEVEL: ${LOG_LEVEL}
172-
ETHEREUM_HOSTS: ${ETHEREUM_HOSTS}
173-
L1_CONSENSUS_HOST_URLS: ${L1_CONSENSUS_HOST_URLS}
174-
P2P_IP: ${P2P_IP}
176+
KEY_STORE_DIRECTORY: /var/lib/keystore
177+
DATA_DIRECTORY: /var/lib/data
178+
LOG_LEVEL: ${LOG_LEVEL}
179+
ETHEREUM_HOSTS: ${ETHEREUM_HOSTS}
180+
L1_CONSENSUS_HOST_URLS: ${L1_CONSENSUS_HOST_URLS}
181+
P2P_IP: ${P2P_IP}
182+
P2P_PORT: ${P2P_PORT}
183+
AZTEC_PORT: ${AZTEC_PORT}
175184
entrypoint: node /usr/src/yarn-project/aztec/dest/bin/index.js
176185
command: >-
177-
start
178-
--network alpha-testnet
179-
--node
180-
--archiver
181-
--sequencer
186+
start
187+
--network alpha-testnet
188+
--node
189+
--archiver
190+
--sequencer
182191
networks:
183192
- aztec
184193
restart: always
@@ -188,7 +197,7 @@ networks:
188197
name: aztec
189198
```
190199
191-
Please note that we are setting only the necessary configuration for running this sequencer. The full list of settings and flags can be explored here at the (cli reference)[deadlink]. A lot of these options are preset to defaults by the `--network` flag above. This downloads defaults for the specified network and applies them to the node.
200+
Please note that we are setting only the necessary configuration for running this sequencer. The full list of settings and flags can be explored here at the [cli reference](../../reference/cli_reference.md). A lot of these options are preset to defaults by the `--network` flag above. This downloads defaults for the specified network and applies them to the node.
192201
193202
Now, you can run `docker compose up` inside your `aztec-sequencer` folder to start the sequencer !
194203

0 commit comments

Comments
 (0)