You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/docs/run_node/guides/run_nodes/how_to_run_sequencer_draft.md
+39-40
Original file line number
Diff line number
Diff line change
@@ -56,11 +56,11 @@ Once you connect and begin to see gossiped messages such as attestations, propos
56
56
57
57
The `aztec-spartan.sh` script will set the following required variables on your behalf. You can ofcourse override the variables set by the script by simply changing the `.env` file directly and re-running `./aztec-spartan.sh`
58
58
59
-
| Variable | Description |
60
-
| ----- | ----- |
61
-
| ETHEREUM_HOST | URL to the Ethereum node your validator will connect to. For as long as we're on private networks, please use the value in `aztec-spartan.sh`|
62
-
| BOOTNODE_URL | URL to a bootnode that supplies L1 contract addresses and the ENR of the bootstrap nodes. |
| ETHEREUM_HOST | URL to the Ethereum node your validator will connect to. For as long as we're on private networks, please use the value in `aztec-spartan.sh`|
62
+
| BOOTNODE_URL | URL to a bootnode that supplies L1 contract addresses and the ENR of the bootstrap nodes.|
63
+
| IMAGE | The docker image to run|
64
64
65
65
In addition, the user is prompted to enter 1) an IP Address and a P2P port to be used for the TCP and UDP addresses (defaults to 40400) 2) A port for your node (8080) 3) an Ethereum private key 4) `COINBASE` which is the Ethereum address associated with the private key and 5) a path to a local directory to store node data if you don't opt for a named volume.
66
66
@@ -72,33 +72,33 @@ The Publisher is the main node component that interacts with the Ethereum L1, fo
72
72
73
73
The Archiver's primary functions are data storage and retrieval (i.e. L1->L2 messages), state synchronization and re-org handling.
74
74
75
-
|Variable| Description|
76
-
|----|-----|
77
-
|ETHEREUM_HOST| This is the URL to the L1 node your validator will connect to. For as long as we're on private networks, please use the value in `aztec-spartan.sh`|
78
-
|L1_CHAIN_ID | Chain ID of the L1 |
79
-
| DATA_DIRECTORY | Optional dir to store archiver and world state data. If omitted will store in memory |
80
-
| ARCHIVER_POLLING_INTERVAL_MS | The polling interval in ms for retrieving new L2 blocks and encrypted logs
81
-
| SEQ_PUBLISHER_PRIVATE_KEY | This should be the same as your validator private key |
82
-
|SEQ_PUBLISH_RETRY_INTERVAL_MS | The interval to wait between publish retries|
83
-
| SEQ_VIEM_POLLING_INTERVAL_TIME | The polling interval viem uses in ms |
|ETHEREUM_HOST| This is the URL to the L1 node your validator will connect to. For as long as we're on private networks, please use the value in `aztec-spartan.sh`|
78
+
|L1_CHAIN_ID | Chain ID of the L1|
79
+
| DATA_DIRECTORY | Optional dir to store archiver and world state data. If omitted will store in memory|
80
+
| ARCHIVER_POLLING_INTERVAL_MS | The polling interval in ms for retrieving new L2 blocks and encrypted logs|
81
+
| SEQ_PUBLISHER_PRIVATE_KEY | This should be the same as your validator private key|
82
+
|SEQ_PUBLISH_RETRY_INTERVAL_MS | The interval to wait between publish retries|
83
+
| SEQ_VIEM_POLLING_INTERVAL_TIME | The polling interval viem uses in ms |
84
84
85
85
### Sequencer Config
86
86
87
87
The Sequencer Client is a criticial component that coordinates tx validation, L2 block creation, collecting attestations and block submission (through the Publisher).
88
88
89
-
|Variable| Description|
90
-
|----|-----|
91
-
| VALIDATOR_DISABLED | If this is True, the client won't perform any validator duties. |
92
-
|VALIDATOR_ATTESTATIONS_WAIT_TIMEOUT_MS | Wait for attestations timeout. After this, client throws an error and does not propose a block for that slot. |
93
-
| VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS | If not enough attestations, sleep for this long and check again |
94
-
|GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS | To nominate proposals for voting, you must set this variable to the Ethereum address of the `proposal` payload. You must edit this to vote on a governance upgrade.|
95
-
| SEQ_ENFORCE_TIME_TABLE | Whether to enforce strict timeliness requirement when building blocks. Refer [here](#sequencer-timeliness-requirements) for more on the timetable |
96
-
| SEQ_MAX_TX_PER_BLOCK | Increase this to make larger blocks |
97
-
| SEQ_MIN_TX_PER_BLOCK | Increase this to require making larger blocks |
98
-
| SEQ_MIN_SECONDS_BETWEEN_BLOCKS | If greater than zero, the sequencer will not propose a block until this much time has passed since the last L2 block was published to L1 |
99
-
| SEQ_MAX_SECONDS_BETWEEN_BLOCKS | Sequencer will ignore the minTxPerBlock if this many seconds have passed since the last L2 block.|
100
-
| COINBASE | This is the Ethereum address that will receive the validator's share of block rewards. It defaults to your validator address. |
101
-
| FEE_RECIPIENT | This is the Aztec address that will receive the validator's share of transaction fees. Also defaults to your validator's address (but on Aztec L2). |
| VALIDATOR_DISABLED | If this is True, the client won't perform any validator duties.|
92
+
|VALIDATOR_ATTESTATIONS_WAIT_TIMEOUT_MS | Wait for attestations timeout. After this, client throws an error and does not propose a block for that slot.|
93
+
| VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS | If not enough attestations, sleep for this long and check again |
94
+
|GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS | To nominate proposals for voting, you must set this variable to the Ethereum address of the `proposal` payload. You must edit this to vote on a governance upgrade.|
95
+
| SEQ_ENFORCE_TIME_TABLE | Whether to enforce strict timeliness requirement when building blocks. Refer [here](#sequencer-timeliness-requirements) for more on the timetable|
96
+
| SEQ_MAX_TX_PER_BLOCK | Increase this to make larger blocks|
97
+
| SEQ_MIN_TX_PER_BLOCK | Increase this to require making larger blocks|
98
+
| SEQ_MIN_SECONDS_BETWEEN_BLOCKS | If greater than zero, the sequencer will not propose a block until this much time has passed since the last L2 block was published to L1|
99
+
| SEQ_MAX_SECONDS_BETWEEN_BLOCKS | Sequencer will ignore the minTxPerBlock if this many seconds have passed since the last L2 block.|
100
+
| COINBASE | This is the Ethereum address that will receive the validator's share of block rewards. It defaults to your validator address.|
101
+
| FEE_RECIPIENT | This is the Aztec address that will receive the validator's share of transaction fees. Also defaults to your validator's address (but on Aztec L2).|
102
102
103
103
#### Sequencer Timeliness Requirements
104
104
@@ -114,18 +114,17 @@ Currently the default timetable values are hardcoded in [sequencer.ts](https://g
114
114
115
115
The P2P client coordinates peer-to-peer communication between Nodes.
116
116
117
-
| Variable | Description |
118
-
| ---- | ------|
119
-
| BOOTSTRAP_NODES | A list of bootstrap peer ENRs to connect to. Separated by commas. |
| P2P_TCP_LISTEN_ADDR | Format: `<IP_ADDRESS>:<TCP_PORT>` or can use `0.0.0.0:<TCP_PORT>` to listen on all interfaces|
123
-
| P2P_UDP_LISTEN_ADDR |Format: `<IP_ADDRESS>:<TCP_PORT>` or can use `0.0.0.0:<UDP_PORT>` to listen on all interfaces |
124
-
| P2P_QUERY_FOR_IP | Useful in dynamic environments where your IP is not known in advance. Set this to True, and only supply `:TCP_PORT` and `:UDP_PORT` for the `ANNOUNCE_ADDR` variables. If you know your public IP address in advance, set this to False or just provide the full announce addresses.
125
-
| P2P_ENABLED | Whether to run the P2P module. Defaults to False, so make sure to set to True |
126
-
| P2P_MIN_PEERS | The min number of peers to connect to. |
127
-
| P2P_MAX_PEERS | The max number of peers to connect to. |
128
-
| P2P_BLOCK_CHECK_INTERVAL_MS | How milliseconds to wait between each check for new L2 blocks. |
| P2P_TCP_LISTEN_ADDR | Format: `<IP_ADDRESS>:<TCP_PORT>` or can use `0.0.0.0:<TCP_PORT>` to listen on all interfaces |
123
+
| P2P_UDP_LISTEN_ADDR | Format: `<IP_ADDRESS>:<TCP_PORT>` or can use `0.0.0.0:<UDP_PORT>` to listen on all interfaces |
124
+
| P2P_QUERY_FOR_IP | Useful in dynamic environments where your IP is not known in advance. Set this to True, and only supply `:TCP_PORT` and `:UDP_PORT` for the `ANNOUNCE_ADDR` variables. If you know your public IP address in advance, set this to False or just provide the full announce addresses. |
125
+
| P2P_ENABLED | Whether to run the P2P module. Defaults to False, so make sure to set to True |
126
+
| P2P_MAX_PEERS | The max number of peers to connect to. |
127
+
| P2P_BLOCK_CHECK_INTERVAL_MS | How milliseconds to wait between each check for new L2 blocks. |
129
128
130
129
### Prover Config
131
130
@@ -156,4 +155,4 @@ Some issues are fairly light, the group and ourselves can help you within 60 min
156
155
**Steps to Reproduce (if known)**: If there’s a clear way to reproduce the error, please describe it.
157
156
**System Information**: Share details like your system’s operating system, hardware specs, and any other relevant environment information.
158
157
159
-
That way we can dedicate more time to troubleshoot and open Github issues if no known fix.
158
+
That way we can dedicate more time to troubleshoot and open Github issues if no known fix.
0 commit comments