Skip to content

Commit f9bd0cd

Browse files
sklppy88critesjosh
andauthored
Apply suggestions from code review
Co-authored-by: josh crites <[email protected]>
1 parent d1788e1 commit f9bd0cd

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The sequencer node takes part in three key actions:
3232
2. Attest to correct execution of txs in the proposed block (if part of validator committee)
3333
3. Submit the successfully attested block to L1
3434

35-
When transactions are sent to the Aztec network, sequencer nodes bundles them into blocks, checking various constraints such as gas limits, block size, and transaction validity. Before a block can be published, it must be validated by a committee of other sequencer nodes (validators in this context) who re-execute public transactions and verify private function proofs so they can attest to correct execution. These validators attest to the block's validity by signing the block header, and once enough attestations are collected (two-thirds of the committee plus one), the sequencer can submit the block to L1.
35+
When transactions are sent to the Aztec network, sequencer nodes bundle them into blocks, checking various constraints such as gas limits, block size, and transaction validity. Before a block can be published, it must be validated by a committee of other sequencer nodes (validators in this context) who re-execute public transactions and verify private function proofs so they can attest to correct execution. These validators attest to the block's validity by signing the block header, and once enough attestations are collected (two-thirds of the committee plus one), the sequencer can submit the block to L1.
3636

3737
The archiver component complements this process by maintaining historical chain data. It continuously monitors L1 for new blocks, processes them, and maintains a synchronized view of the chain state. This includes managing contract data, transaction logs, and L1-to-L2 messages, making it essential for network synchronization and data availability.
3838

@@ -53,12 +53,12 @@ It also is assumed that you have installed Docker and the aztec toolchain via az
5353

5454
Furthermore, as this guide uses Docker compose, you will need to install it. Please follow [this](https://docs.docker.com/compose/install/) guide to do so.
5555

56-
Finally, this guide requires you to have endpoints of an L1 node stack of an execution and consensus client. If you do not have one set up, you see a good guide on how to do that here at (Eth Docker)[https://ethdocker.com/Usage/QuickStart].
56+
Finally, this guide requires you to have endpoints of an L1 node stack of an execution and consensus client. If you do not have one set up, you can see a good guide on how to do that [here at Eth Docker](https://ethdocker.com/Usage/QuickStart).
5757

5858

5959
## Configure the sequencer
6060

61-
There are a few important things to note when setting up a sequencer. This guide will guide you in up and running a sequencer with a standard setup using Docker compose with a .env file.
61+
There are a few important things to note when setting up a sequencer. This guide will guide you in setting up and running a sequencer with a standard setup using Docker compose with a .env file.
6262

6363
The setup of the sequencer has four important steps.
6464

@@ -67,11 +67,11 @@ The setup of the sequencer has four important steps.
6767
3. Ensure auto-update / auto-restart is enabled
6868
4. Apply your Docker compose file
6969

70-
Let's start by creating a new directory called `aztec-sequencer`, with two subdirectories, `keys`, and `data. This is where all the information used by the sequencer will be stored. Please also create an empty `.env` file in `aztec-sequencer` to define your settings before moving on to the next step.
70+
Let's start by creating a new directory called `aztec-sequencer`, with two subdirectories, `keys`, and `data`. This is where all the information used by the sequencer will be stored. Please also create an empty `.env` file in `aztec-sequencer` to define your settings before moving on to the next step.
7171

72-
### Define private keys / accounts used for sequencer duties
72+
### Define private keys / accounts
7373

74-
Due to the duties performed by the sequencer, it must hold and use private keys identifying it as a valid proposer or attester. The way this is done is by defining a keystore file.
74+
A sequencer must hold and use private keys identifying it as a valid proposer or attester. This is done is by defining a keystore file.
7575

7676
An example keystore file is below. Copy this file and save it as `keystore.json` into your `aztec-sequencer/keys` folder.
7777

@@ -98,15 +98,15 @@ The keystore defines a few important keys and addresses for sequencer operation.
9898

9999
Please set these values with the ones you want and save `keystore.json`.
100100

101-
### Set required node configuration
101+
### Node configuration
102102

103103
Next you will need to define some environment variables that set important configuration for your node.
104104

105105
These include:
106106

107107
- `DATA_DIRECTORY`: the folder where the data of the sequencer is stored
108108
- `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
109-
- `LOG_LEVEL`: the desired level of logging for the sequencer. It defaults to info.
109+
- `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
@@ -129,16 +129,16 @@ AZTEC_PORT=8080
129129
:::tip
130130
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.
131131
132-
If you are unable to determine your public ip. Running the command `curl ipv4.icanhazip.com` can retrieve it for you.
132+
Running the command `curl ipv4.icanhazip.com` can retrieve your public IP address for you.
133133
:::
134134
135-
### Ensure auto-update / auto-restart is enabled
135+
### Enable auto-update / auto-restart
136136
137137
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:
138138
139139
- Push configuration changes to all nodes
140140
- Trigger shutdowns so that nodes can pull the latest image version
141-
- Apply hotfixes quickly
141+
- Apply hot-fixes quickly
142142
- Coordinate node resets after a governance upgrade, especially when a new canonical rollup is published to the Registry
143143
144144
This module ensures that upgrades and fixes propagate smoothly without requiring manual intervention from every node operator.
@@ -199,7 +199,7 @@ networks:
199199
200200
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.
201201
202-
Now, you can run `docker compose up` inside your `aztec-sequencer` folder to start the sequencer !
202+
Now, you can run `docker compose up` inside your `aztec-sequencer` folder to start the sequencer!
203203
204204
To check if it is currently synced, which may take a few minutes, run this command and compare its output to any of the Aztec block explorers.
205205
@@ -211,7 +211,7 @@ http://localhost:8080 | jq -r ".result.proven.number"
211211
212212
## Add yourself to the testnet sequencer set
213213
214-
After setting up your node, to be included in testnet duties, you must explicitly request to be added to the sequencer set.
214+
After setting up your node you must explicitly request to be added to the sequencer set.
215215
216216
To complete this final step you have two options:
217217

0 commit comments

Comments
 (0)