@aztec/sequencer-client 0.0.1-commit.b655e406 → 0.0.1-commit.b6e433891

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. package/dest/client/index.d.ts +1 -1
  2. package/dest/client/sequencer-client.d.ts +21 -16
  3. package/dest/client/sequencer-client.d.ts.map +1 -1
  4. package/dest/client/sequencer-client.js +75 -28
  5. package/dest/config.d.ts +35 -9
  6. package/dest/config.d.ts.map +1 -1
  7. package/dest/config.js +113 -42
  8. package/dest/global_variable_builder/global_builder.d.ts +20 -16
  9. package/dest/global_variable_builder/global_builder.d.ts.map +1 -1
  10. package/dest/global_variable_builder/global_builder.js +54 -40
  11. package/dest/global_variable_builder/index.d.ts +1 -1
  12. package/dest/index.d.ts +2 -3
  13. package/dest/index.d.ts.map +1 -1
  14. package/dest/index.js +1 -2
  15. package/dest/publisher/config.d.ts +43 -20
  16. package/dest/publisher/config.d.ts.map +1 -1
  17. package/dest/publisher/config.js +109 -34
  18. package/dest/publisher/index.d.ts +2 -1
  19. package/dest/publisher/index.d.ts.map +1 -1
  20. package/dest/publisher/l1_tx_failed_store/factory.d.ts +11 -0
  21. package/dest/publisher/l1_tx_failed_store/factory.d.ts.map +1 -0
  22. package/dest/publisher/l1_tx_failed_store/factory.js +22 -0
  23. package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts +59 -0
  24. package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts.map +1 -0
  25. package/dest/publisher/l1_tx_failed_store/failed_tx_store.js +1 -0
  26. package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.d.ts +15 -0
  27. package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.d.ts.map +1 -0
  28. package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.js +34 -0
  29. package/dest/publisher/l1_tx_failed_store/index.d.ts +4 -0
  30. package/dest/publisher/l1_tx_failed_store/index.d.ts.map +1 -0
  31. package/dest/publisher/l1_tx_failed_store/index.js +2 -0
  32. package/dest/publisher/sequencer-publisher-factory.d.ts +15 -6
  33. package/dest/publisher/sequencer-publisher-factory.d.ts.map +1 -1
  34. package/dest/publisher/sequencer-publisher-factory.js +28 -3
  35. package/dest/publisher/sequencer-publisher-metrics.d.ts +3 -3
  36. package/dest/publisher/sequencer-publisher-metrics.d.ts.map +1 -1
  37. package/dest/publisher/sequencer-publisher-metrics.js +23 -86
  38. package/dest/publisher/sequencer-publisher.d.ts +103 -69
  39. package/dest/publisher/sequencer-publisher.d.ts.map +1 -1
  40. package/dest/publisher/sequencer-publisher.js +999 -190
  41. package/dest/sequencer/checkpoint_proposal_job.d.ts +108 -0
  42. package/dest/sequencer/checkpoint_proposal_job.d.ts.map +1 -0
  43. package/dest/sequencer/checkpoint_proposal_job.js +1289 -0
  44. package/dest/sequencer/checkpoint_voter.d.ts +35 -0
  45. package/dest/sequencer/checkpoint_voter.d.ts.map +1 -0
  46. package/dest/sequencer/checkpoint_voter.js +109 -0
  47. package/dest/sequencer/config.d.ts +3 -2
  48. package/dest/sequencer/config.d.ts.map +1 -1
  49. package/dest/sequencer/errors.d.ts +1 -1
  50. package/dest/sequencer/errors.d.ts.map +1 -1
  51. package/dest/sequencer/events.d.ts +47 -0
  52. package/dest/sequencer/events.d.ts.map +1 -0
  53. package/dest/sequencer/events.js +1 -0
  54. package/dest/sequencer/index.d.ts +4 -2
  55. package/dest/sequencer/index.d.ts.map +1 -1
  56. package/dest/sequencer/index.js +3 -1
  57. package/dest/sequencer/metrics.d.ts +48 -3
  58. package/dest/sequencer/metrics.d.ts.map +1 -1
  59. package/dest/sequencer/metrics.js +243 -50
  60. package/dest/sequencer/sequencer.d.ts +127 -144
  61. package/dest/sequencer/sequencer.d.ts.map +1 -1
  62. package/dest/sequencer/sequencer.js +770 -545
  63. package/dest/sequencer/timetable.d.ts +54 -16
  64. package/dest/sequencer/timetable.d.ts.map +1 -1
  65. package/dest/sequencer/timetable.js +147 -62
  66. package/dest/sequencer/types.d.ts +3 -0
  67. package/dest/sequencer/types.d.ts.map +1 -0
  68. package/dest/sequencer/types.js +1 -0
  69. package/dest/sequencer/utils.d.ts +14 -8
  70. package/dest/sequencer/utils.d.ts.map +1 -1
  71. package/dest/sequencer/utils.js +7 -4
  72. package/dest/test/index.d.ts +6 -7
  73. package/dest/test/index.d.ts.map +1 -1
  74. package/dest/test/mock_checkpoint_builder.d.ts +95 -0
  75. package/dest/test/mock_checkpoint_builder.d.ts.map +1 -0
  76. package/dest/test/mock_checkpoint_builder.js +231 -0
  77. package/dest/test/utils.d.ts +53 -0
  78. package/dest/test/utils.d.ts.map +1 -0
  79. package/dest/test/utils.js +104 -0
  80. package/package.json +32 -30
  81. package/src/client/sequencer-client.ts +100 -52
  82. package/src/config.ts +132 -51
  83. package/src/global_variable_builder/global_builder.ts +69 -60
  84. package/src/index.ts +1 -7
  85. package/src/publisher/config.ts +139 -50
  86. package/src/publisher/index.ts +3 -0
  87. package/src/publisher/l1_tx_failed_store/factory.ts +32 -0
  88. package/src/publisher/l1_tx_failed_store/failed_tx_store.ts +55 -0
  89. package/src/publisher/l1_tx_failed_store/file_store_failed_tx_store.ts +46 -0
  90. package/src/publisher/l1_tx_failed_store/index.ts +3 -0
  91. package/src/publisher/sequencer-publisher-factory.ts +45 -11
  92. package/src/publisher/sequencer-publisher-metrics.ts +19 -71
  93. package/src/publisher/sequencer-publisher.ts +717 -248
  94. package/src/sequencer/README.md +531 -0
  95. package/src/sequencer/checkpoint_proposal_job.ts +1049 -0
  96. package/src/sequencer/checkpoint_voter.ts +130 -0
  97. package/src/sequencer/config.ts +2 -1
  98. package/src/sequencer/events.ts +27 -0
  99. package/src/sequencer/index.ts +3 -1
  100. package/src/sequencer/metrics.ts +310 -61
  101. package/src/sequencer/sequencer.ts +541 -735
  102. package/src/sequencer/timetable.ts +178 -83
  103. package/src/sequencer/types.ts +6 -0
  104. package/src/sequencer/utils.ts +18 -9
  105. package/src/test/index.ts +5 -6
  106. package/src/test/mock_checkpoint_builder.ts +323 -0
  107. package/src/test/utils.ts +167 -0
  108. package/dest/sequencer/block_builder.d.ts +0 -27
  109. package/dest/sequencer/block_builder.d.ts.map +0 -1
  110. package/dest/sequencer/block_builder.js +0 -130
  111. package/dest/tx_validator/nullifier_cache.d.ts +0 -14
  112. package/dest/tx_validator/nullifier_cache.d.ts.map +0 -1
  113. package/dest/tx_validator/nullifier_cache.js +0 -24
  114. package/dest/tx_validator/tx_validator_factory.d.ts +0 -17
  115. package/dest/tx_validator/tx_validator_factory.d.ts.map +0 -1
  116. package/dest/tx_validator/tx_validator_factory.js +0 -53
  117. package/src/sequencer/block_builder.ts +0 -218
  118. package/src/tx_validator/nullifier_cache.ts +0 -30
  119. package/src/tx_validator/tx_validator_factory.ts +0 -132
@@ -1,31 +1,25 @@
1
- import type { BlobSinkClientInterface } from '@aztec/blob-sink/client';
1
+ import type { BlobClientInterface } from '@aztec/blob-client/client';
2
+ import { MAX_PROCESSABLE_DA_GAS_PER_CHECKPOINT } from '@aztec/constants';
2
3
  import { EpochCache } from '@aztec/epoch-cache';
3
- import {
4
- GovernanceProposerContract,
5
- PublisherManager,
6
- RollupContract,
7
- getPublicClient,
8
- isAnvilTestChain,
9
- } from '@aztec/ethereum';
10
- import { L1TxUtilsWithBlobs } from '@aztec/ethereum/l1-tx-utils-with-blobs';
4
+ import { isAnvilTestChain } from '@aztec/ethereum/chain';
5
+ import { getPublicClient } from '@aztec/ethereum/client';
6
+ import { GovernanceProposerContract, RollupContract } from '@aztec/ethereum/contracts';
7
+ import { type Delayer, L1TxUtils } from '@aztec/ethereum/l1-tx-utils';
8
+ import { PublisherManager } from '@aztec/ethereum/publisher-manager';
11
9
  import { EthAddress } from '@aztec/foundation/eth-address';
12
10
  import { createLogger } from '@aztec/foundation/log';
13
11
  import type { DateProvider } from '@aztec/foundation/timer';
14
12
  import type { KeystoreManager } from '@aztec/node-keystore';
15
13
  import type { P2P } from '@aztec/p2p';
16
14
  import type { SlasherClientInterface } from '@aztec/slasher';
17
- import type { L2BlockSource } from '@aztec/stdlib/block';
18
- import type {
19
- IFullNodeBlockBuilder,
20
- ValidatorClientFullConfig,
21
- WorldStateSynchronizer,
22
- } from '@aztec/stdlib/interfaces/server';
15
+ import type { L2BlockSink, L2BlockSource } from '@aztec/stdlib/block';
16
+ import type { ValidatorClientFullConfig, WorldStateSynchronizer } from '@aztec/stdlib/interfaces/server';
23
17
  import { SlashFactoryContract } from '@aztec/stdlib/l1-contracts';
24
18
  import type { L1ToL2MessageSource } from '@aztec/stdlib/messaging';
25
19
  import { L1Metrics, type TelemetryClient } from '@aztec/telemetry-client';
26
- import { NodeKeystoreAdapter, type ValidatorClient } from '@aztec/validator-client';
20
+ import { FullNodeCheckpointsBuilder, NodeKeystoreAdapter, type ValidatorClient } from '@aztec/validator-client';
27
21
 
28
- import type { SequencerClientConfig } from '../config.js';
22
+ import { type SequencerClientConfig, getPublisherConfigFromSequencerConfig } from '../config.js';
29
23
  import { GlobalVariableBuilder } from '../global_variable_builder/index.js';
30
24
  import { SequencerPublisherFactory } from '../publisher/sequencer-publisher-factory.js';
31
25
  import { Sequencer, type SequencerConfig } from '../sequencer/index.js';
@@ -35,11 +29,12 @@ import { Sequencer, type SequencerConfig } from '../sequencer/index.js';
35
29
  */
36
30
  export class SequencerClient {
37
31
  constructor(
38
- protected publisherManager: PublisherManager<L1TxUtilsWithBlobs>,
32
+ protected publisherManager: PublisherManager<L1TxUtils>,
39
33
  protected sequencer: Sequencer,
40
- protected blockBuilder: IFullNodeBlockBuilder,
34
+ protected checkpointsBuilder: FullNodeCheckpointsBuilder,
41
35
  protected validatorClient?: ValidatorClient,
42
36
  private l1Metrics?: L1Metrics,
37
+ private delayer_?: Delayer,
43
38
  ) {}
44
39
 
45
40
  /**
@@ -57,19 +52,19 @@ export class SequencerClient {
57
52
  public static async new(
58
53
  config: SequencerClientConfig,
59
54
  deps: {
60
- validatorClient: ValidatorClient | undefined; // allowed to be undefined while we migrate
55
+ validatorClient: ValidatorClient;
61
56
  p2pClient: P2P;
62
57
  worldStateSynchronizer: WorldStateSynchronizer;
63
58
  slasherClient: SlasherClientInterface | undefined;
64
- blockBuilder: IFullNodeBlockBuilder;
65
- l2BlockSource: L2BlockSource;
59
+ checkpointsBuilder: FullNodeCheckpointsBuilder;
60
+ l2BlockSource: L2BlockSource & L2BlockSink;
66
61
  l1ToL2MessageSource: L1ToL2MessageSource;
67
62
  telemetry: TelemetryClient;
68
63
  publisherFactory?: SequencerPublisherFactory;
69
- blobSinkClient?: BlobSinkClientInterface;
64
+ blobClient: BlobClientInterface;
70
65
  dateProvider: DateProvider;
71
66
  epochCache?: EpochCache;
72
- l1TxUtils: L1TxUtilsWithBlobs[];
67
+ l1TxUtils: L1TxUtils[];
73
68
  nodeKeyStore: KeystoreManager;
74
69
  },
75
70
  ) {
@@ -78,7 +73,7 @@ export class SequencerClient {
78
73
  p2pClient,
79
74
  worldStateSynchronizer,
80
75
  slasherClient,
81
- blockBuilder,
76
+ checkpointsBuilder,
82
77
  l2BlockSource,
83
78
  l1ToL2MessageSource,
84
79
  telemetry: telemetryClient,
@@ -92,11 +87,17 @@ export class SequencerClient {
92
87
  publicClient,
93
88
  l1TxUtils.map(x => x.getSenderAddress()),
94
89
  );
95
- const publisherManager = new PublisherManager(l1TxUtils, config);
90
+ const publisherManager = new PublisherManager(
91
+ l1TxUtils,
92
+ getPublisherConfigFromSequencerConfig(config),
93
+ log.getBindings(),
94
+ );
96
95
  const rollupContract = new RollupContract(publicClient, config.l1Contracts.rollupAddress.toString());
97
- const [l1GenesisTime, slotDuration] = await Promise.all([
96
+ const [l1GenesisTime, slotDuration, rollupVersion, rollupManaLimit] = await Promise.all([
98
97
  rollupContract.getL1GenesisTime(),
99
98
  rollupContract.getSlotDuration(),
99
+ rollupContract.getVersion(),
100
+ rollupContract.getManaLimit().then(Number),
100
101
  ] as const);
101
102
 
102
103
  const governanceProposerContract = new GovernanceProposerContract(
@@ -112,6 +113,7 @@ export class SequencerClient {
112
113
  l1ChainId: chainId,
113
114
  viemPollingIntervalMS: config.viemPollingIntervalMS,
114
115
  ethereumSlotDuration: config.ethereumSlotDuration,
116
+ enableProposerPipelining: config.enableProposerPipelining,
115
117
  },
116
118
  { dateProvider: deps.dateProvider },
117
119
  ));
@@ -125,7 +127,7 @@ export class SequencerClient {
125
127
  deps.publisherFactory ??
126
128
  new SequencerPublisherFactory(config, {
127
129
  telemetry: telemetryClient,
128
- blobSinkClient: deps.blobSinkClient,
130
+ blobClient: deps.blobClient,
129
131
  epochCache,
130
132
  governanceProposerContract,
131
133
  slashFactoryContract,
@@ -135,33 +137,28 @@ export class SequencerClient {
135
137
  nodeKeyStore: NodeKeystoreAdapter.fromKeyStoreManager(deps.nodeKeyStore),
136
138
  logger: log,
137
139
  });
138
- const globalsBuilder = new GlobalVariableBuilder(config);
139
140
 
140
141
  const ethereumSlotDuration = config.ethereumSlotDuration;
141
142
 
142
- const rollupManaLimit = Number(await rollupContract.getManaLimit());
143
- let sequencerManaLimit = config.maxL2BlockGas ?? rollupManaLimit;
144
- if (sequencerManaLimit > rollupManaLimit) {
145
- log.warn(
146
- `Provided maxL2BlockGas of ${sequencerManaLimit} is greater than the maximum allowed by the L1 (${rollupManaLimit}), setting limit to ${rollupManaLimit}`,
147
- );
148
- sequencerManaLimit = rollupManaLimit;
149
- }
143
+ const globalsBuilder = new GlobalVariableBuilder({
144
+ ...config,
145
+ l1GenesisTime,
146
+ slotDuration: Number(slotDuration),
147
+ ethereumSlotDuration,
148
+ rollupVersion,
149
+ });
150
150
 
151
151
  // When running in anvil, assume we can post a tx up until one second before the end of an L1 slot.
152
- // Otherwise, assume we must have broadcasted the tx before the slot started (we use a default
153
- // maxL1TxInclusionTimeIntoSlot of zero) to get the tx into that L1 slot.
152
+ // Otherwise, we need the full L1 slot duration for publishing to ensure inclusion.
154
153
  // In theory, the L1 slot has an initial 4s phase where the block is propagated, so we could
155
- // make it with a propagation time into slot equal to 4s. However, we prefer being conservative.
154
+ // reduce the publishing time allowance. However, we prefer being conservative.
156
155
  // See https://www.blocknative.com/blog/anatomy-of-a-slot#7 for more info.
157
- const maxL1TxInclusionTimeIntoSlot =
158
- (config.maxL1TxInclusionTimeIntoSlot ?? isAnvilTestChain(config.l1ChainId)) ? ethereumSlotDuration - 1 : 0;
156
+ const l1PublishingTimeBasedOnChain = isAnvilTestChain(config.l1ChainId) ? 1 : ethereumSlotDuration;
157
+ const l1PublishingTime = config.l1PublishingTime ?? l1PublishingTimeBasedOnChain;
159
158
 
160
- const l1Constants = {
161
- l1GenesisTime,
162
- slotDuration: Number(slotDuration),
163
- ethereumSlotDuration,
164
- };
159
+ const { maxL2BlockGas, maxDABlockGas, maxTxsPerBlock } = capPerBlockLimits(config, rollupManaLimit, log);
160
+
161
+ const l1Constants = { l1GenesisTime, slotDuration: Number(slotDuration), ethereumSlotDuration, rollupManaLimit };
165
162
 
166
163
  const sequencer = new Sequencer(
167
164
  publisherFactory,
@@ -172,19 +169,22 @@ export class SequencerClient {
172
169
  slasherClient,
173
170
  l2BlockSource,
174
171
  l1ToL2MessageSource,
175
- blockBuilder,
172
+ checkpointsBuilder,
176
173
  l1Constants,
177
174
  deps.dateProvider,
178
175
  epochCache,
179
176
  rollupContract,
180
- { ...config, maxL1TxInclusionTimeIntoSlot, maxL2BlockGas: sequencerManaLimit },
177
+ { ...config, l1PublishingTime, maxL2BlockGas, maxDABlockGas, maxTxsPerBlock },
181
178
  telemetryClient,
182
179
  log,
183
180
  );
184
181
 
185
- await sequencer.init();
182
+ sequencer.init();
183
+
184
+ // Extract the shared delayer from the first L1TxUtils instance (all instances share the same delayer)
185
+ const delayer = l1TxUtils[0]?.delayer;
186
186
 
187
- return new SequencerClient(publisherManager, sequencer, blockBuilder, validatorClient, l1Metrics);
187
+ return new SequencerClient(publisherManager, sequencer, checkpointsBuilder, validatorClient, l1Metrics, delayer);
188
188
  }
189
189
 
190
190
  /**
@@ -193,7 +193,7 @@ export class SequencerClient {
193
193
  */
194
194
  public updateConfig(config: SequencerConfig & Partial<ValidatorClientFullConfig>) {
195
195
  this.sequencer.updateConfig(config);
196
- this.blockBuilder.updateConfig(config);
196
+ this.checkpointsBuilder.updateConfig(config);
197
197
  this.validatorClient?.updateConfig(config);
198
198
  }
199
199
 
@@ -219,6 +219,16 @@ export class SequencerClient {
219
219
  return this.sequencer;
220
220
  }
221
221
 
222
+ /** Updates the publisher factory's node keystore adapter after a keystore reload. */
223
+ public updatePublisherNodeKeyStore(adapter: NodeKeystoreAdapter): void {
224
+ this.sequencer.updatePublisherNodeKeyStore(adapter);
225
+ }
226
+
227
+ /** Returns the shared tx delayer for sequencer L1 txs, if enabled. Test-only. */
228
+ getDelayer(): Delayer | undefined {
229
+ return this.delayer_;
230
+ }
231
+
222
232
  get validatorAddresses(): EthAddress[] | undefined {
223
233
  return this.sequencer.getValidatorAddresses();
224
234
  }
@@ -227,3 +237,41 @@ export class SequencerClient {
227
237
  return this.sequencer.maxL2BlockGas;
228
238
  }
229
239
  }
240
+
241
+ /**
242
+ * Caps operator-provided per-block limits at checkpoint-level limits.
243
+ * Returns undefined for any limit the operator didn't set — the checkpoint builder handles redistribution.
244
+ */
245
+ function capPerBlockLimits(
246
+ config: SequencerClientConfig,
247
+ rollupManaLimit: number,
248
+ log: ReturnType<typeof createLogger>,
249
+ ): { maxL2BlockGas: number | undefined; maxDABlockGas: number | undefined; maxTxsPerBlock: number | undefined } {
250
+ let maxL2BlockGas = config.maxL2BlockGas;
251
+ if (maxL2BlockGas !== undefined && maxL2BlockGas > rollupManaLimit) {
252
+ log.warn(`Provided MAX_L2_BLOCK_GAS ${maxL2BlockGas} exceeds rollup mana limit ${rollupManaLimit} (capping)`);
253
+ maxL2BlockGas = rollupManaLimit;
254
+ }
255
+
256
+ let maxDABlockGas = config.maxDABlockGas;
257
+ if (maxDABlockGas !== undefined && maxDABlockGas > MAX_PROCESSABLE_DA_GAS_PER_CHECKPOINT) {
258
+ log.warn(
259
+ `Provided MAX_DA_BLOCK_GAS ${maxDABlockGas} exceeds DA checkpoint limit ${MAX_PROCESSABLE_DA_GAS_PER_CHECKPOINT} (capping)`,
260
+ );
261
+ maxDABlockGas = MAX_PROCESSABLE_DA_GAS_PER_CHECKPOINT;
262
+ }
263
+
264
+ let maxTxsPerBlock = config.maxTxsPerBlock;
265
+ if (
266
+ maxTxsPerBlock !== undefined &&
267
+ config.maxTxsPerCheckpoint !== undefined &&
268
+ maxTxsPerBlock > config.maxTxsPerCheckpoint
269
+ ) {
270
+ log.warn(
271
+ `Provided MAX_TX_PER_BLOCK ${maxTxsPerBlock} exceeds MAX_TX_PER_CHECKPOINT ${config.maxTxsPerCheckpoint} (capping)`,
272
+ );
273
+ maxTxsPerBlock = config.maxTxsPerCheckpoint;
274
+ }
275
+
276
+ return { maxL2BlockGas, maxDABlockGas, maxTxsPerBlock };
277
+ }
package/src/config.ts CHANGED
@@ -1,9 +1,5 @@
1
- import {
2
- type L1ContractsConfig,
3
- type L1ReaderConfig,
4
- l1ContractsConfigMappings,
5
- l1ReaderConfigMappings,
6
- } from '@aztec/ethereum';
1
+ import { type L1ContractsConfig, l1ContractsConfigMappings } from '@aztec/ethereum/config';
2
+ import { type L1ReaderConfig, l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
7
3
  import {
8
4
  type ConfigMappingsType,
9
5
  booleanConfigHelper,
@@ -12,67 +8,119 @@ import {
12
8
  pickConfigMappings,
13
9
  } from '@aztec/foundation/config';
14
10
  import { EthAddress } from '@aztec/foundation/eth-address';
15
- import { type KeyStoreConfig, keyStoreConfigMappings } from '@aztec/node-keystore';
16
- import { type P2PConfig, p2pConfigMappings } from '@aztec/p2p';
11
+ import { type KeyStoreConfig, keyStoreConfigMappings } from '@aztec/node-keystore/config';
12
+ import { type P2PConfig, p2pConfigMappings } from '@aztec/p2p/config';
17
13
  import { AztecAddress } from '@aztec/stdlib/aztec-address';
18
- import { type ChainConfig, type SequencerConfig, chainConfigMappings } from '@aztec/stdlib/config';
19
- import { type ValidatorClientConfig, validatorClientConfigMappings } from '@aztec/validator-client';
14
+ import {
15
+ type ChainConfig,
16
+ type PipelineConfig,
17
+ type SequencerConfig,
18
+ chainConfigMappings,
19
+ pipelineConfigMappings,
20
+ sharedSequencerConfigMappings,
21
+ } from '@aztec/stdlib/config';
22
+ import type { ResolvedSequencerConfig } from '@aztec/stdlib/interfaces/server';
23
+ import { DEFAULT_P2P_PROPAGATION_TIME } from '@aztec/stdlib/timetable';
24
+ import { type ValidatorClientConfig, validatorClientConfigMappings } from '@aztec/validator-client/config';
20
25
 
21
26
  import {
22
- type PublisherConfig,
23
- type TxSenderConfig,
24
- getPublisherConfigMappings,
25
- getTxSenderConfigMappings,
27
+ type SequencerPublisherConfig,
28
+ type SequencerTxSenderConfig,
29
+ sequencerPublisherConfigMappings,
30
+ sequencerTxSenderConfigMappings,
26
31
  } from './publisher/config.js';
27
32
 
28
33
  export * from './publisher/config.js';
29
34
  export type { SequencerConfig };
30
35
 
31
- export const DEFAULT_ATTESTATION_PROPAGATION_TIME = 2;
36
+ /**
37
+ * Default values for SequencerConfig.
38
+ * Centralized location for all sequencer configuration defaults.
39
+ */
40
+ export const DefaultSequencerConfig = {
41
+ sequencerPollingIntervalMS: 500,
42
+ minTxsPerBlock: 1,
43
+ buildCheckpointIfEmpty: false,
44
+ publishTxsWithProposals: false,
45
+ perBlockAllocationMultiplier: 1.2,
46
+ redistributeCheckpointBudget: true,
47
+ enforceTimeTable: true,
48
+ attestationPropagationTime: DEFAULT_P2P_PROPAGATION_TIME,
49
+ secondsBeforeInvalidatingBlockAsCommitteeMember: 144, // 12 L1 blocks
50
+ secondsBeforeInvalidatingBlockAsNonCommitteeMember: 432, // 36 L1 blocks
51
+ skipCollectingAttestations: false,
52
+ skipInvalidateBlockAsProposer: false,
53
+ broadcastInvalidBlockProposal: false,
54
+ injectFakeAttestation: false,
55
+ injectHighSValueAttestation: false,
56
+ injectUnrecoverableSignatureAttestation: false,
57
+ fishermanMode: false,
58
+ shuffleAttestationOrdering: false,
59
+ skipPushProposedBlocksToArchiver: false,
60
+ skipPublishingCheckpointsPercent: 0,
61
+ } satisfies ResolvedSequencerConfig;
32
62
 
33
63
  /**
34
64
  * Configuration settings for the SequencerClient.
35
65
  */
36
- export type SequencerClientConfig = PublisherConfig &
66
+ export type SequencerClientConfig = SequencerPublisherConfig &
37
67
  KeyStoreConfig &
38
68
  ValidatorClientConfig &
39
- TxSenderConfig &
69
+ SequencerTxSenderConfig &
40
70
  SequencerConfig &
41
71
  L1ReaderConfig &
42
72
  ChainConfig &
43
- Pick<P2PConfig, 'txPublicSetupAllowList'> &
73
+ PipelineConfig &
74
+ Pick<P2PConfig, 'txPublicSetupAllowListExtend'> &
44
75
  Pick<L1ContractsConfig, 'ethereumSlotDuration' | 'aztecSlotDuration' | 'aztecEpochDuration'>;
45
76
 
46
77
  export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
47
- transactionPollingIntervalMS: {
48
- env: 'SEQ_TX_POLLING_INTERVAL_MS',
49
- description: 'The number of ms to wait between polling for pending txs.',
50
- ...numberConfigHelper(500),
78
+ sequencerPollingIntervalMS: {
79
+ env: 'SEQ_POLLING_INTERVAL_MS',
80
+ description: 'The number of ms to wait between polling for checking to build on the next slot.',
81
+ ...numberConfigHelper(DefaultSequencerConfig.sequencerPollingIntervalMS),
51
82
  },
52
- maxTxsPerBlock: {
53
- env: 'SEQ_MAX_TX_PER_BLOCK',
54
- description: 'The maximum number of txs to include in a block.',
55
- ...numberConfigHelper(32),
83
+ maxTxsPerCheckpoint: {
84
+ env: 'SEQ_MAX_TX_PER_CHECKPOINT',
85
+ description: 'The maximum number of txs across all blocks in a checkpoint.',
86
+ parseEnv: (val: string) => (val ? parseInt(val, 10) : undefined),
56
87
  },
57
88
  minTxsPerBlock: {
58
89
  env: 'SEQ_MIN_TX_PER_BLOCK',
59
90
  description: 'The minimum number of txs to include in a block.',
60
- ...numberConfigHelper(1),
91
+ ...numberConfigHelper(DefaultSequencerConfig.minTxsPerBlock),
92
+ },
93
+ minValidTxsPerBlock: {
94
+ description:
95
+ 'The minimum number of valid txs (after execution) to include in a block. If not set, falls back to minTxsPerBlock.',
61
96
  },
62
97
  publishTxsWithProposals: {
63
98
  env: 'SEQ_PUBLISH_TXS_WITH_PROPOSALS',
64
99
  description: 'Whether to publish txs with proposals.',
65
- ...booleanConfigHelper(false),
100
+ ...booleanConfigHelper(DefaultSequencerConfig.publishTxsWithProposals),
66
101
  },
67
102
  maxL2BlockGas: {
68
103
  env: 'SEQ_MAX_L2_BLOCK_GAS',
69
104
  description: 'The maximum L2 block gas.',
70
- ...numberConfigHelper(10e9),
105
+ parseEnv: (val: string) => (val ? parseInt(val, 10) : undefined),
71
106
  },
72
107
  maxDABlockGas: {
73
108
  env: 'SEQ_MAX_DA_BLOCK_GAS',
74
109
  description: 'The maximum DA block gas.',
75
- ...numberConfigHelper(10e9),
110
+ parseEnv: (val: string) => (val ? parseInt(val, 10) : undefined),
111
+ },
112
+ perBlockAllocationMultiplier: {
113
+ env: 'SEQ_PER_BLOCK_ALLOCATION_MULTIPLIER',
114
+ description:
115
+ 'Per-block gas budget multiplier for both L2 and DA gas. Budget per block is (checkpointLimit / maxBlocks) * multiplier.' +
116
+ ' Values greater than one allow early blocks to use more than their even share, relying on checkpoint-level capping for later blocks.',
117
+ ...numberConfigHelper(DefaultSequencerConfig.perBlockAllocationMultiplier),
118
+ },
119
+ redistributeCheckpointBudget: {
120
+ env: 'SEQ_REDISTRIBUTE_CHECKPOINT_BUDGET',
121
+ description:
122
+ 'Redistribute remaining checkpoint budget evenly across remaining blocks instead of allowing a single block to consume the entire remaining budget.',
123
+ ...booleanConfigHelper(DefaultSequencerConfig.redistributeCheckpointBudget),
76
124
  },
77
125
  coinbase: {
78
126
  env: 'COINBASE',
@@ -92,68 +140,100 @@ export const sequencerConfigMappings: ConfigMappingsType<SequencerConfig> = {
92
140
  env: 'ACVM_BINARY_PATH',
93
141
  description: 'The path to the ACVM binary',
94
142
  },
95
- maxBlockSizeInBytes: {
96
- env: 'SEQ_MAX_BLOCK_SIZE_IN_BYTES',
97
- description: 'Max block size',
98
- ...numberConfigHelper(1024 * 1024),
99
- },
100
143
  enforceTimeTable: {
101
144
  env: 'SEQ_ENFORCE_TIME_TABLE',
102
145
  description: 'Whether to enforce the time table when building blocks',
103
- ...booleanConfigHelper(),
104
- defaultValue: true,
146
+ ...booleanConfigHelper(DefaultSequencerConfig.enforceTimeTable),
105
147
  },
106
148
  governanceProposerPayload: {
107
149
  env: 'GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS',
108
150
  description: 'The address of the payload for the governanceProposer',
109
151
  parseEnv: (val: string) => EthAddress.fromString(val),
110
- defaultValue: EthAddress.ZERO,
111
152
  },
112
- maxL1TxInclusionTimeIntoSlot: {
113
- env: 'SEQ_MAX_L1_TX_INCLUSION_TIME_INTO_SLOT',
114
- description: 'How many seconds into an L1 slot we can still send a tx and get it mined.',
153
+ l1PublishingTime: {
154
+ env: 'SEQ_L1_PUBLISHING_TIME_ALLOWANCE_IN_SLOT',
155
+ description: 'How much time (in seconds) we allow in the slot for publishing the L1 tx (defaults to 1 L1 slot).',
115
156
  parseEnv: (val: string) => (val ? parseInt(val, 10) : undefined),
116
157
  },
117
158
  attestationPropagationTime: {
118
159
  env: 'SEQ_ATTESTATION_PROPAGATION_TIME',
119
160
  description: 'How many seconds it takes for proposals and attestations to travel across the p2p layer (one-way)',
120
- ...numberConfigHelper(DEFAULT_ATTESTATION_PROPAGATION_TIME),
161
+ ...numberConfigHelper(DefaultSequencerConfig.attestationPropagationTime),
121
162
  },
122
163
  fakeProcessingDelayPerTxMs: {
123
164
  description: 'Used for testing to introduce a fake delay after processing each tx',
124
165
  },
166
+ fakeThrowAfterProcessingTxCount: {
167
+ description: 'Used for testing to throw an error after processing N txs',
168
+ },
125
169
  secondsBeforeInvalidatingBlockAsCommitteeMember: {
126
170
  env: 'SEQ_SECONDS_BEFORE_INVALIDATING_BLOCK_AS_COMMITTEE_MEMBER',
127
171
  description:
128
172
  'How many seconds to wait before trying to invalidate a block from the pending chain as a committee member (zero to never invalidate).' +
129
173
  ' The next proposer is expected to invalidate, so the committee acts as a fallback.',
130
- ...numberConfigHelper(144), // 12 L1 blocks
174
+ ...numberConfigHelper(DefaultSequencerConfig.secondsBeforeInvalidatingBlockAsCommitteeMember),
131
175
  },
132
176
  secondsBeforeInvalidatingBlockAsNonCommitteeMember: {
133
177
  env: 'SEQ_SECONDS_BEFORE_INVALIDATING_BLOCK_AS_NON_COMMITTEE_MEMBER',
134
178
  description:
135
179
  'How many seconds to wait before trying to invalidate a block from the pending chain as a non-committee member (zero to never invalidate).' +
136
180
  ' The next proposer is expected to invalidate, then the committee, so other sequencers act as a fallback.',
137
- ...numberConfigHelper(432), // 36 L1 blocks
181
+ ...numberConfigHelper(DefaultSequencerConfig.secondsBeforeInvalidatingBlockAsNonCommitteeMember),
138
182
  },
139
183
  skipCollectingAttestations: {
140
184
  description:
141
185
  'Whether to skip collecting attestations from validators and only use self-attestations (for testing only)',
142
- ...booleanConfigHelper(false),
186
+ ...booleanConfigHelper(DefaultSequencerConfig.skipCollectingAttestations),
143
187
  },
144
188
  skipInvalidateBlockAsProposer: {
145
189
  description: 'Do not invalidate the previous block if invalid when we are the proposer (for testing only)',
146
- ...booleanConfigHelper(false),
190
+ ...booleanConfigHelper(DefaultSequencerConfig.skipInvalidateBlockAsProposer),
147
191
  },
148
192
  broadcastInvalidBlockProposal: {
149
193
  description: 'Broadcast invalid block proposals with corrupted state (for testing only)',
150
- ...booleanConfigHelper(false),
194
+ ...booleanConfigHelper(DefaultSequencerConfig.broadcastInvalidBlockProposal),
151
195
  },
152
196
  injectFakeAttestation: {
153
197
  description: 'Inject a fake attestation (for testing only)',
154
- ...booleanConfigHelper(false),
198
+ ...booleanConfigHelper(DefaultSequencerConfig.injectFakeAttestation),
199
+ },
200
+ injectHighSValueAttestation: {
201
+ description: 'Inject a malleable attestation with a high-s value (for testing only)',
202
+ ...booleanConfigHelper(DefaultSequencerConfig.injectHighSValueAttestation),
203
+ },
204
+ injectUnrecoverableSignatureAttestation: {
205
+ description: 'Inject an attestation with an unrecoverable signature (for testing only)',
206
+ ...booleanConfigHelper(DefaultSequencerConfig.injectUnrecoverableSignatureAttestation),
207
+ },
208
+ fishermanMode: {
209
+ env: 'FISHERMAN_MODE',
210
+ description:
211
+ 'Whether to run in fisherman mode: builds blocks on every slot for validation without publishing to L1',
212
+ ...booleanConfigHelper(DefaultSequencerConfig.fishermanMode),
213
+ },
214
+ shuffleAttestationOrdering: {
215
+ description: 'Shuffle attestation ordering to create invalid ordering (for testing only)',
216
+ ...booleanConfigHelper(DefaultSequencerConfig.shuffleAttestationOrdering),
217
+ },
218
+ ...sharedSequencerConfigMappings,
219
+ buildCheckpointIfEmpty: {
220
+ env: 'SEQ_BUILD_CHECKPOINT_IF_EMPTY',
221
+ description: 'Have sequencer build and publish an empty checkpoint if there are no txs',
222
+ ...booleanConfigHelper(DefaultSequencerConfig.buildCheckpointIfEmpty),
223
+ },
224
+ skipPushProposedBlocksToArchiver: {
225
+ description: 'Skip pushing proposed blocks to archiver (default: true)',
226
+ ...booleanConfigHelper(DefaultSequencerConfig.skipPushProposedBlocksToArchiver),
227
+ },
228
+ minBlocksForCheckpoint: {
229
+ description: 'Minimum number of blocks required for a checkpoint proposal (test only)',
230
+ },
231
+ skipPublishingCheckpointsPercent: {
232
+ env: 'SEQ_SKIP_CHECKPOINT_PUBLISH_PERCENT',
233
+ description: 'Percent probability (0 - 100) of sequencer skipping checkpoint publishing (testing only)',
234
+ ...numberConfigHelper(DefaultSequencerConfig.skipPublishingCheckpointsPercent),
155
235
  },
156
- ...pickConfigMappings(p2pConfigMappings, ['txPublicSetupAllowList']),
236
+ ...pickConfigMappings(p2pConfigMappings, ['txPublicSetupAllowListExtend']),
157
237
  };
158
238
 
159
239
  export const sequencerClientConfigMappings: ConfigMappingsType<SequencerClientConfig> = {
@@ -161,9 +241,10 @@ export const sequencerClientConfigMappings: ConfigMappingsType<SequencerClientCo
161
241
  ...sequencerConfigMappings,
162
242
  ...keyStoreConfigMappings,
163
243
  ...l1ReaderConfigMappings,
164
- ...getTxSenderConfigMappings('SEQ'),
165
- ...getPublisherConfigMappings('SEQ'),
244
+ ...sequencerTxSenderConfigMappings,
245
+ ...sequencerPublisherConfigMappings,
166
246
  ...chainConfigMappings,
247
+ ...pipelineConfigMappings,
167
248
  ...pickConfigMappings(l1ContractsConfigMappings, ['ethereumSlotDuration', 'aztecSlotDuration', 'aztecEpochDuration']),
168
249
  };
169
250