@aztec/sequencer-client 0.0.1-commit.6d63667d → 0.0.1-commit.7b97ef96e

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 (51) hide show
  1. package/dest/client/sequencer-client.d.ts +12 -7
  2. package/dest/client/sequencer-client.d.ts.map +1 -1
  3. package/dest/client/sequencer-client.js +15 -4
  4. package/dest/config.d.ts +3 -4
  5. package/dest/config.d.ts.map +1 -1
  6. package/dest/config.js +17 -12
  7. package/dest/global_variable_builder/global_builder.d.ts +2 -4
  8. package/dest/global_variable_builder/global_builder.d.ts.map +1 -1
  9. package/dest/publisher/config.d.ts +31 -17
  10. package/dest/publisher/config.d.ts.map +1 -1
  11. package/dest/publisher/config.js +101 -42
  12. package/dest/publisher/sequencer-publisher-factory.d.ts +11 -3
  13. package/dest/publisher/sequencer-publisher-factory.d.ts.map +1 -1
  14. package/dest/publisher/sequencer-publisher-factory.js +13 -2
  15. package/dest/publisher/sequencer-publisher.d.ts +16 -7
  16. package/dest/publisher/sequencer-publisher.d.ts.map +1 -1
  17. package/dest/publisher/sequencer-publisher.js +41 -21
  18. package/dest/sequencer/checkpoint_proposal_job.d.ts +1 -1
  19. package/dest/sequencer/checkpoint_proposal_job.d.ts.map +1 -1
  20. package/dest/sequencer/checkpoint_proposal_job.js +32 -10
  21. package/dest/sequencer/metrics.d.ts +17 -5
  22. package/dest/sequencer/metrics.d.ts.map +1 -1
  23. package/dest/sequencer/metrics.js +86 -15
  24. package/dest/sequencer/sequencer.d.ts +15 -7
  25. package/dest/sequencer/sequencer.d.ts.map +1 -1
  26. package/dest/sequencer/sequencer.js +24 -25
  27. package/dest/sequencer/timetable.d.ts +1 -4
  28. package/dest/sequencer/timetable.d.ts.map +1 -1
  29. package/dest/sequencer/timetable.js +1 -4
  30. package/dest/test/index.d.ts +3 -5
  31. package/dest/test/index.d.ts.map +1 -1
  32. package/dest/test/mock_checkpoint_builder.d.ts +5 -3
  33. package/dest/test/mock_checkpoint_builder.d.ts.map +1 -1
  34. package/dest/test/mock_checkpoint_builder.js +6 -4
  35. package/dest/test/utils.d.ts +3 -3
  36. package/dest/test/utils.d.ts.map +1 -1
  37. package/dest/test/utils.js +5 -4
  38. package/package.json +28 -28
  39. package/src/client/sequencer-client.ts +25 -7
  40. package/src/config.ts +26 -19
  41. package/src/global_variable_builder/global_builder.ts +1 -1
  42. package/src/publisher/config.ts +112 -43
  43. package/src/publisher/sequencer-publisher-factory.ts +23 -6
  44. package/src/publisher/sequencer-publisher.ts +63 -28
  45. package/src/sequencer/checkpoint_proposal_job.ts +46 -9
  46. package/src/sequencer/metrics.ts +92 -18
  47. package/src/sequencer/sequencer.ts +32 -30
  48. package/src/sequencer/timetable.ts +6 -5
  49. package/src/test/index.ts +2 -4
  50. package/src/test/mock_checkpoint_builder.ts +12 -1
  51. package/src/test/utils.ts +5 -2
@@ -12,7 +12,7 @@ import type { DateProvider } from '@aztec/foundation/timer';
12
12
  import type { TypedEventEmitter } from '@aztec/foundation/types';
13
13
  import type { P2P } from '@aztec/p2p';
14
14
  import type { SlasherClientInterface } from '@aztec/slasher';
15
- import type { L2Block, L2BlockSink, L2BlockSource, ValidateCheckpointResult } from '@aztec/stdlib/block';
15
+ import type { BlockData, L2BlockSink, L2BlockSource, ValidateCheckpointResult } from '@aztec/stdlib/block';
16
16
  import type { Checkpoint } from '@aztec/stdlib/checkpoint';
17
17
  import { getSlotAtTimestamp, getSlotStartBuildTimestamp } from '@aztec/stdlib/epoch-helpers';
18
18
  import {
@@ -25,7 +25,7 @@ import type { L1ToL2MessageSource } from '@aztec/stdlib/messaging';
25
25
  import { pickFromSchema } from '@aztec/stdlib/schemas';
26
26
  import { MerkleTreeId } from '@aztec/stdlib/trees';
27
27
  import { Attributes, type TelemetryClient, type Tracer, getTelemetryClient, trackSpan } from '@aztec/telemetry-client';
28
- import { FullNodeCheckpointsBuilder, type ValidatorClient } from '@aztec/validator-client';
28
+ import { FullNodeCheckpointsBuilder, NodeKeystoreAdapter, type ValidatorClient } from '@aztec/validator-client';
29
29
 
30
30
  import EventEmitter from 'node:events';
31
31
 
@@ -75,14 +75,6 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
75
75
  /** The maximum number of seconds that the sequencer can be into a slot to transition to a particular state. */
76
76
  protected timetable!: SequencerTimetable;
77
77
 
78
- // This shouldn't be here as this gets re-created each time we build/propose a block.
79
- // But we have a number of tests that abuse/rely on this class having a permanent publisher.
80
- // As long as those tests only configure a single publisher they will continue to work.
81
- // This will get re-assigned every time the sequencer goes to build a new block to a publisher that is valid
82
- // for the block proposer.
83
- // TODO(palla/mbps): Remove this field and fix tests
84
- protected publisher: SequencerPublisher | undefined;
85
-
86
78
  /** Config for the sequencer */
87
79
  protected config: ResolvedSequencerConfig = DefaultSequencerConfig;
88
80
 
@@ -134,10 +126,9 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
134
126
  );
135
127
  }
136
128
 
137
- /** Initializes the sequencer (precomputes tables and creates a publisher). Takes about 3s. */
138
- public async init() {
129
+ /** Initializes the sequencer (precomputes tables). Takes about 3s. */
130
+ public init() {
139
131
  getKzg();
140
- this.publisher = (await this.publisherFactory.create(undefined)).publisher;
141
132
  }
142
133
 
143
134
  /** Starts the sequencer and moves to IDLE state. */
@@ -156,7 +147,7 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
156
147
  public async stop(): Promise<void> {
157
148
  this.log.info(`Stopping sequencer`);
158
149
  this.setState(SequencerState.STOPPING, undefined, { force: true });
159
- this.publisher?.interrupt();
150
+ this.publisherFactory.interruptAll();
160
151
  await this.runningPromise?.stop();
161
152
  this.setState(SequencerState.STOPPED, undefined, { force: true });
162
153
  this.log.info('Stopped sequencer');
@@ -169,7 +160,6 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
169
160
  } catch (err) {
170
161
  this.emit('checkpoint-error', { error: err as Error });
171
162
  if (err instanceof SequencerTooSlowError) {
172
- // TODO(palla/mbps): Add missing states
173
163
  // Log as warn only if we had to abort halfway through the block proposal
174
164
  const logLvl = [SequencerState.INITIALIZING_CHECKPOINT, SequencerState.PROPOSER_CHECK].includes(
175
165
  err.proposedState,
@@ -310,12 +300,12 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
310
300
  }
311
301
 
312
302
  // Check that the slot is not taken by a block already (should never happen, since only us can propose for this slot)
313
- if (syncedTo.block && syncedTo.block.header.getSlot() >= slot) {
303
+ if (syncedTo.blockData && syncedTo.blockData.header.getSlot() >= slot) {
314
304
  this.log.warn(
315
305
  `Cannot propose block at next L2 slot ${slot} since that slot was taken by block ${syncedTo.blockNumber}`,
316
- { ...logCtx, block: syncedTo.block.header.toInspect() },
306
+ { ...logCtx, block: syncedTo.blockData.header.toInspect() },
317
307
  );
318
- this.metrics.recordBlockProposalPrecheckFailed('slot_already_taken');
308
+ this.metrics.recordCheckpointPrecheckFailed('slot_already_taken');
319
309
  return undefined;
320
310
  }
321
311
 
@@ -326,7 +316,6 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
326
316
  const proposerForPublisher = this.config.fishermanMode ? undefined : proposer;
327
317
  const { attestorAddress, publisher } = await this.publisherFactory.create(proposerForPublisher);
328
318
  this.log.verbose(`Created publisher at address ${publisher.getSenderAddress()} for attestor ${attestorAddress}`);
329
- this.publisher = publisher;
330
319
 
331
320
  // In fisherman mode, set the actual proposer's address for simulations
332
321
  if (this.config.fishermanMode && proposer) {
@@ -351,7 +340,7 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
351
340
  logCtx,
352
341
  );
353
342
  this.emit('proposer-rollup-check-failed', { reason: 'Rollup contract check failed', slot });
354
- this.metrics.recordBlockProposalPrecheckFailed('rollup_contract_check_failed');
343
+ this.metrics.recordCheckpointPrecheckFailed('rollup_contract_check_failed');
355
344
  return undefined;
356
345
  }
357
346
 
@@ -361,7 +350,7 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
361
350
  { ...logCtx, rollup: canProposeCheck, expectedSlot: slot },
362
351
  );
363
352
  this.emit('proposer-rollup-check-failed', { reason: 'Slot mismatch', slot });
364
- this.metrics.recordBlockProposalPrecheckFailed('slot_mismatch');
353
+ this.metrics.recordCheckpointPrecheckFailed('slot_mismatch');
365
354
  return undefined;
366
355
  }
367
356
 
@@ -371,11 +360,12 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
371
360
  { ...logCtx, rollup: canProposeCheck, expectedSlot: slot },
372
361
  );
373
362
  this.emit('proposer-rollup-check-failed', { reason: 'Block mismatch', slot });
374
- this.metrics.recordBlockProposalPrecheckFailed('block_number_mismatch');
363
+ this.metrics.recordCheckpointPrecheckFailed('block_number_mismatch');
375
364
  return undefined;
376
365
  }
377
366
 
378
367
  this.lastSlotForCheckpointProposalJob = slot;
368
+ await this.p2pClient.prepareForSlot(slot);
379
369
  this.log.info(`Preparing checkpoint proposal ${checkpointNumber} at slot ${slot}`, { ...logCtx, proposer });
380
370
 
381
371
  // Create and return the checkpoint proposal job
@@ -432,6 +422,13 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
432
422
  );
433
423
  }
434
424
 
425
+ /**
426
+ * Returns the current sequencer state.
427
+ */
428
+ public getState(): SequencerState {
429
+ return this.state;
430
+ }
431
+
435
432
  /**
436
433
  * Internal helper for setting the sequencer state and checks if we have enough time left in the slot to transition to the new state.
437
434
  * @param proposedState - The new state to transition to.
@@ -532,18 +529,18 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
532
529
  };
533
530
  }
534
531
 
535
- const block = await this.l2BlockSource.getL2Block(blockNumber);
536
- if (!block) {
532
+ const blockData = await this.l2BlockSource.getBlockData(blockNumber);
533
+ if (!blockData) {
537
534
  // this shouldn't really happen because a moment ago we checked that all components were in sync
538
- this.log.error(`Failed to get L2 block ${blockNumber} from the archiver with all components in sync`);
535
+ this.log.error(`Failed to get L2 block data ${blockNumber} from the archiver with all components in sync`);
539
536
  return undefined;
540
537
  }
541
538
 
542
539
  return {
543
- block,
544
- blockNumber: block.number,
545
- checkpointNumber: block.checkpointNumber,
546
- archive: block.archive.root,
540
+ blockData,
541
+ blockNumber: blockData.header.getBlockNumber(),
542
+ checkpointNumber: blockData.checkpointNumber,
543
+ archive: blockData.archive.root,
547
544
  l1Timestamp,
548
545
  pendingChainValidationStatus,
549
546
  };
@@ -866,6 +863,11 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
866
863
  return this.validatorClient?.getValidatorAddresses();
867
864
  }
868
865
 
866
+ /** Updates the publisher factory's node keystore adapter after a keystore reload. */
867
+ public updatePublisherNodeKeyStore(adapter: NodeKeystoreAdapter): void {
868
+ this.publisherFactory.updateNodeKeyStore(adapter);
869
+ }
870
+
869
871
  public getConfig() {
870
872
  return this.config;
871
873
  }
@@ -876,7 +878,7 @@ export class Sequencer extends (EventEmitter as new () => TypedEventEmitter<Sequ
876
878
  }
877
879
 
878
880
  type SequencerSyncCheckResult = {
879
- block?: L2Block;
881
+ blockData?: BlockData;
880
882
  checkpointNumber: CheckpointNumber;
881
883
  blockNumber: BlockNumber;
882
884
  archive: Fr;
@@ -1,14 +1,15 @@
1
1
  import { createLogger } from '@aztec/aztec.js/log';
2
+ import {
3
+ CHECKPOINT_ASSEMBLE_TIME,
4
+ CHECKPOINT_INITIALIZATION_TIME,
5
+ DEFAULT_P2P_PROPAGATION_TIME,
6
+ MIN_EXECUTION_TIME,
7
+ } from '@aztec/stdlib/timetable';
2
8
 
3
- import { DEFAULT_ATTESTATION_PROPAGATION_TIME as DEFAULT_P2P_PROPAGATION_TIME } from '../config.js';
4
9
  import { SequencerTooSlowError } from './errors.js';
5
10
  import type { SequencerMetrics } from './metrics.js';
6
11
  import { SequencerState } from './utils.js';
7
12
 
8
- export const MIN_EXECUTION_TIME = 2;
9
- export const CHECKPOINT_INITIALIZATION_TIME = 1;
10
- export const CHECKPOINT_ASSEMBLE_TIME = 1;
11
-
12
13
  export class SequencerTimetable {
13
14
  /**
14
15
  * How late into the slot can we be to start working. Computed as the total time needed for assembling and publishing a block,
package/src/test/index.ts CHANGED
@@ -1,18 +1,16 @@
1
- import type { L1TxUtilsWithBlobs } from '@aztec/ethereum/l1-tx-utils-with-blobs';
1
+ import type { L1TxUtils } from '@aztec/ethereum/l1-tx-utils';
2
2
  import type { PublisherManager } from '@aztec/ethereum/publisher-manager';
3
3
  import type { PublicProcessorFactory } from '@aztec/simulator/server';
4
4
  import type { FullNodeCheckpointsBuilder, ValidatorClient } from '@aztec/validator-client';
5
5
 
6
6
  import { SequencerClient } from '../client/sequencer-client.js';
7
7
  import type { SequencerPublisherFactory } from '../publisher/sequencer-publisher-factory.js';
8
- import type { SequencerPublisher } from '../publisher/sequencer-publisher.js';
9
8
  import { Sequencer } from '../sequencer/sequencer.js';
10
9
  import type { SequencerTimetable } from '../sequencer/timetable.js';
11
10
 
12
11
  class TestSequencer_ extends Sequencer {
13
12
  declare public publicProcessorFactory: PublicProcessorFactory;
14
13
  declare public timetable: SequencerTimetable;
15
- declare public publisher: SequencerPublisher;
16
14
  declare public publisherFactory: SequencerPublisherFactory;
17
15
  declare public validatorClient: ValidatorClient;
18
16
  declare public checkpointsBuilder: FullNodeCheckpointsBuilder;
@@ -22,7 +20,7 @@ export type TestSequencer = TestSequencer_;
22
20
 
23
21
  class TestSequencerClient_ extends SequencerClient {
24
22
  declare public sequencer: TestSequencer;
25
- declare public publisherManager: PublisherManager<L1TxUtilsWithBlobs>;
23
+ declare public publisherManager: PublisherManager<L1TxUtils>;
26
24
  }
27
25
 
28
26
  export type TestSequencerClient = TestSequencerClient_;
@@ -205,6 +205,7 @@ export class MockCheckpointsBuilder implements ICheckpointsBuilder {
205
205
  constants: CheckpointGlobalVariables;
206
206
  l1ToL2Messages: Fr[];
207
207
  previousCheckpointOutHashes: Fr[];
208
+ feeAssetPriceModifier: bigint;
208
209
  }> = [];
209
210
  public openCheckpointCalls: Array<{
210
211
  checkpointNumber: CheckpointNumber;
@@ -212,6 +213,7 @@ export class MockCheckpointsBuilder implements ICheckpointsBuilder {
212
213
  l1ToL2Messages: Fr[];
213
214
  previousCheckpointOutHashes: Fr[];
214
215
  existingBlocks: L2Block[];
216
+ feeAssetPriceModifier: bigint;
215
217
  }> = [];
216
218
  public updateConfigCalls: Array<Partial<FullNodeBlockBuilderConfig>> = [];
217
219
 
@@ -257,11 +259,18 @@ export class MockCheckpointsBuilder implements ICheckpointsBuilder {
257
259
  startCheckpoint(
258
260
  checkpointNumber: CheckpointNumber,
259
261
  constants: CheckpointGlobalVariables,
262
+ feeAssetPriceModifier: bigint,
260
263
  l1ToL2Messages: Fr[],
261
264
  previousCheckpointOutHashes: Fr[],
262
265
  _fork: MerkleTreeWriteOperations,
263
266
  ): Promise<ICheckpointBlockBuilder> {
264
- this.startCheckpointCalls.push({ checkpointNumber, constants, l1ToL2Messages, previousCheckpointOutHashes });
267
+ this.startCheckpointCalls.push({
268
+ checkpointNumber,
269
+ constants,
270
+ l1ToL2Messages,
271
+ previousCheckpointOutHashes,
272
+ feeAssetPriceModifier,
273
+ });
265
274
 
266
275
  if (!this.checkpointBuilder) {
267
276
  // Auto-create a builder if none was set
@@ -274,6 +283,7 @@ export class MockCheckpointsBuilder implements ICheckpointsBuilder {
274
283
  openCheckpoint(
275
284
  checkpointNumber: CheckpointNumber,
276
285
  constants: CheckpointGlobalVariables,
286
+ feeAssetPriceModifier: bigint,
277
287
  l1ToL2Messages: Fr[],
278
288
  previousCheckpointOutHashes: Fr[],
279
289
  _fork: MerkleTreeWriteOperations,
@@ -285,6 +295,7 @@ export class MockCheckpointsBuilder implements ICheckpointsBuilder {
285
295
  l1ToL2Messages,
286
296
  previousCheckpointOutHashes,
287
297
  existingBlocks,
298
+ feeAssetPriceModifier,
288
299
  });
289
300
 
290
301
  if (!this.checkpointBuilder) {
package/src/test/utils.ts CHANGED
@@ -56,6 +56,7 @@ export async function makeBlock(txs: Tx[], globalVariables: GlobalVariables): Pr
56
56
  export function mockPendingTxs(p2p: MockProxy<P2P>, txs: Tx[]): void {
57
57
  p2p.getPendingTxCount.mockResolvedValue(txs.length);
58
58
  p2p.iteratePendingTxs.mockImplementation(() => mockTxIterator(Promise.resolve(txs)));
59
+ p2p.iterateEligiblePendingTxs.mockImplementation(() => mockTxIterator(Promise.resolve(txs)));
59
60
  }
60
61
 
61
62
  /**
@@ -118,10 +119,11 @@ export function createCheckpointProposal(
118
119
  block: L2Block,
119
120
  checkpointSignature: Signature,
120
121
  blockSignature?: Signature,
122
+ feeAssetPriceModifier: bigint = 0n,
121
123
  ): CheckpointProposal {
122
124
  const txHashes = block.body.txEffects.map(tx => tx.txHash);
123
125
  const checkpointHeader = createCheckpointHeaderFromBlock(block);
124
- return new CheckpointProposal(checkpointHeader, block.archive.root, checkpointSignature, {
126
+ return new CheckpointProposal(checkpointHeader, block.archive.root, feeAssetPriceModifier, checkpointSignature, {
125
127
  blockHeader: block.header,
126
128
  indexWithinCheckpoint: block.indexWithinCheckpoint,
127
129
  txHashes,
@@ -138,9 +140,10 @@ export function createCheckpointAttestation(
138
140
  block: L2Block,
139
141
  signature: Signature,
140
142
  sender: EthAddress,
143
+ feeAssetPriceModifier: bigint = 0n,
141
144
  ): CheckpointAttestation {
142
145
  const checkpointHeader = createCheckpointHeaderFromBlock(block);
143
- const payload = new ConsensusPayload(checkpointHeader, block.archive.root);
146
+ const payload = new ConsensusPayload(checkpointHeader, block.archive.root, feeAssetPriceModifier);
144
147
  const attestation = new CheckpointAttestation(payload, signature, signature);
145
148
  // Set sender directly for testing (bypasses signature recovery)
146
149
  (attestation as any).sender = sender;