@aztec/sequencer-client 5.0.0-private.20260318 → 5.0.0-rc.1

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 (108) hide show
  1. package/README.md +281 -21
  2. package/dest/client/sequencer-client.d.ts +8 -15
  3. package/dest/client/sequencer-client.d.ts.map +1 -1
  4. package/dest/client/sequencer-client.js +35 -96
  5. package/dest/config.d.ts +8 -2
  6. package/dest/config.d.ts.map +1 -1
  7. package/dest/config.js +48 -26
  8. package/dest/global_variable_builder/fee_predictor.d.ts +37 -0
  9. package/dest/global_variable_builder/fee_predictor.d.ts.map +1 -0
  10. package/dest/global_variable_builder/fee_predictor.js +128 -0
  11. package/dest/global_variable_builder/fee_provider.d.ts +21 -0
  12. package/dest/global_variable_builder/fee_provider.d.ts.map +1 -0
  13. package/dest/global_variable_builder/fee_provider.js +67 -0
  14. package/dest/global_variable_builder/global_builder.d.ts +14 -14
  15. package/dest/global_variable_builder/global_builder.d.ts.map +1 -1
  16. package/dest/global_variable_builder/global_builder.js +16 -51
  17. package/dest/global_variable_builder/index.d.ts +4 -2
  18. package/dest/global_variable_builder/index.d.ts.map +1 -1
  19. package/dest/global_variable_builder/index.js +2 -0
  20. package/dest/publisher/config.d.ts +15 -3
  21. package/dest/publisher/config.d.ts.map +1 -1
  22. package/dest/publisher/config.js +19 -4
  23. package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts +3 -4
  24. package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts.map +1 -1
  25. package/dest/publisher/sequencer-bundle-simulator.d.ts +96 -0
  26. package/dest/publisher/sequencer-bundle-simulator.d.ts.map +1 -0
  27. package/dest/publisher/sequencer-bundle-simulator.js +198 -0
  28. package/dest/publisher/sequencer-publisher-factory.d.ts +3 -5
  29. package/dest/publisher/sequencer-publisher-factory.d.ts.map +1 -1
  30. package/dest/publisher/sequencer-publisher-factory.js +2 -3
  31. package/dest/publisher/sequencer-publisher.d.ts +73 -65
  32. package/dest/publisher/sequencer-publisher.d.ts.map +1 -1
  33. package/dest/publisher/sequencer-publisher.js +317 -532
  34. package/dest/sequencer/automine/automine_factory.d.ts +56 -0
  35. package/dest/sequencer/automine/automine_factory.d.ts.map +1 -0
  36. package/dest/sequencer/automine/automine_factory.js +85 -0
  37. package/dest/sequencer/automine/automine_sequencer.d.ts +184 -0
  38. package/dest/sequencer/automine/automine_sequencer.d.ts.map +1 -0
  39. package/dest/sequencer/automine/automine_sequencer.js +677 -0
  40. package/dest/sequencer/automine/index.d.ts +3 -0
  41. package/dest/sequencer/automine/index.d.ts.map +1 -0
  42. package/dest/sequencer/automine/index.js +2 -0
  43. package/dest/sequencer/chain_state_overrides.d.ts +61 -0
  44. package/dest/sequencer/chain_state_overrides.d.ts.map +1 -0
  45. package/dest/sequencer/chain_state_overrides.js +98 -0
  46. package/dest/sequencer/checkpoint_proposal_job.d.ts +77 -17
  47. package/dest/sequencer/checkpoint_proposal_job.d.ts.map +1 -1
  48. package/dest/sequencer/checkpoint_proposal_job.js +768 -209
  49. package/dest/sequencer/checkpoint_proposal_job_metrics.d.ts +34 -0
  50. package/dest/sequencer/checkpoint_proposal_job_metrics.d.ts.map +1 -0
  51. package/dest/sequencer/checkpoint_proposal_job_metrics.js +72 -0
  52. package/dest/sequencer/checkpoint_voter.d.ts +1 -2
  53. package/dest/sequencer/checkpoint_voter.d.ts.map +1 -1
  54. package/dest/sequencer/checkpoint_voter.js +2 -5
  55. package/dest/sequencer/errors.d.ts +1 -8
  56. package/dest/sequencer/errors.d.ts.map +1 -1
  57. package/dest/sequencer/errors.js +0 -9
  58. package/dest/sequencer/events.d.ts +62 -4
  59. package/dest/sequencer/events.d.ts.map +1 -1
  60. package/dest/sequencer/metrics.d.ts +13 -10
  61. package/dest/sequencer/metrics.d.ts.map +1 -1
  62. package/dest/sequencer/metrics.js +45 -20
  63. package/dest/sequencer/sequencer.d.ts +115 -30
  64. package/dest/sequencer/sequencer.d.ts.map +1 -1
  65. package/dest/sequencer/sequencer.js +506 -174
  66. package/dest/sequencer/types.d.ts +2 -2
  67. package/dest/sequencer/types.d.ts.map +1 -1
  68. package/dest/test/index.d.ts +3 -3
  69. package/dest/test/index.d.ts.map +1 -1
  70. package/dest/test/mock_checkpoint_builder.d.ts +4 -8
  71. package/dest/test/mock_checkpoint_builder.d.ts.map +1 -1
  72. package/dest/test/utils.d.ts +15 -1
  73. package/dest/test/utils.d.ts.map +1 -1
  74. package/dest/test/utils.js +23 -6
  75. package/package.json +28 -27
  76. package/src/client/sequencer-client.ts +53 -123
  77. package/src/config.ts +57 -23
  78. package/src/global_variable_builder/README.md +44 -0
  79. package/src/global_variable_builder/fee_predictor.ts +172 -0
  80. package/src/global_variable_builder/fee_provider.ts +80 -0
  81. package/src/global_variable_builder/global_builder.ts +25 -63
  82. package/src/global_variable_builder/index.ts +3 -1
  83. package/src/publisher/config.ts +40 -6
  84. package/src/publisher/l1_tx_failed_store/failed_tx_store.ts +3 -1
  85. package/src/publisher/sequencer-bundle-simulator.ts +254 -0
  86. package/src/publisher/sequencer-publisher-factory.ts +3 -6
  87. package/src/publisher/sequencer-publisher.ts +376 -577
  88. package/src/sequencer/automine/README.md +60 -0
  89. package/src/sequencer/automine/automine_factory.ts +152 -0
  90. package/src/sequencer/automine/automine_sequencer.ts +783 -0
  91. package/src/sequencer/automine/index.ts +6 -0
  92. package/src/sequencer/chain_state_overrides.ts +169 -0
  93. package/src/sequencer/checkpoint_proposal_job.ts +917 -241
  94. package/src/sequencer/checkpoint_proposal_job_metrics.ts +128 -0
  95. package/src/sequencer/checkpoint_voter.ts +1 -12
  96. package/src/sequencer/errors.ts +0 -15
  97. package/src/sequencer/events.ts +65 -4
  98. package/src/sequencer/metrics.ts +57 -24
  99. package/src/sequencer/sequencer.ts +604 -195
  100. package/src/sequencer/types.ts +1 -1
  101. package/src/test/index.ts +2 -2
  102. package/src/test/mock_checkpoint_builder.ts +3 -3
  103. package/src/test/utils.ts +59 -10
  104. package/dest/sequencer/timetable.d.ts +0 -88
  105. package/dest/sequencer/timetable.d.ts.map +0 -1
  106. package/dest/sequencer/timetable.js +0 -222
  107. package/src/sequencer/README.md +0 -531
  108. package/src/sequencer/timetable.ts +0 -283
@@ -0,0 +1,6 @@
1
+ export {
2
+ AutomineSequencer,
3
+ type AutomineSequencerConstants,
4
+ type AutomineSequencerDeps,
5
+ } from './automine_sequencer.js';
6
+ export { createAutomineSequencer, type CreateAutomineSequencerArgs } from './automine_factory.js';
@@ -0,0 +1,169 @@
1
+ import {
2
+ type FeeHeader,
3
+ RollupContract,
4
+ SimulationOverridesBuilder,
5
+ type SimulationOverridesPlan,
6
+ } from '@aztec/ethereum/contracts';
7
+ import { CheckpointNumber } from '@aztec/foundation/branded-types';
8
+ import type { Logger } from '@aztec/foundation/log';
9
+ import { type ProposedCheckpointData, computeCheckpointPayloadDigest } from '@aztec/stdlib/checkpoint';
10
+ import type { CoordinationSignatureContext } from '@aztec/stdlib/p2p';
11
+
12
+ type CheckpointSimulationOverridesPlanInput = {
13
+ /** Target rollup contract. */
14
+ rollup: RollupContract;
15
+ /** Checkpoint number to be proposed. */
16
+ checkpointNumber: CheckpointNumber;
17
+ /** Logger instance. */
18
+ log: Logger;
19
+ /**
20
+ * The proposed parent checkpoint when pipelining. Its `checkpointNumber` must equal
21
+ * `checkpointNumber - 1`; the helper enforces this. Mutually exclusive with
22
+ * `invalidateToPendingCheckpointNumber`.
23
+ */
24
+ proposedCheckpointData?: ProposedCheckpointData;
25
+ /**
26
+ * The pending checkpoint number we'll end up at after invalidation lands. Mutually exclusive
27
+ * with `proposedCheckpointData`.
28
+ */
29
+ invalidateToPendingCheckpointNumber?: CheckpointNumber;
30
+ /**
31
+ * The real on-chain pending checkpoint number (typically `syncedTo.checkpointedCheckpointNumber`).
32
+ * Used as the snapshot we pin both `pending` and `proven` to avoid prunes in simulation.
33
+ */
34
+ checkpointedCheckpointNumber: CheckpointNumber;
35
+ /**
36
+ * Chain-level consensus signature context. Used to recompute the parent's `payloadDigest` for the
37
+ * pipelined simulation override so it matches what `propose` will write into `tempCheckpointLogs[parent]`
38
+ * once the parent lands.
39
+ */
40
+ signatureContext: CoordinationSignatureContext;
41
+ };
42
+
43
+ /**
44
+ * Builds the SimulationOverridesPlan describing the simulated L1 rollup state for a checkpoint's
45
+ * enqueue-time simulations: `canProposeAt` (in Sequencer.doWork) and the propose-related sims
46
+ * (validateBlockHeader, simulateProposeTx). The plan reflects "as if our pipelined parent
47
+ * checkpoint has landed and any required invalidation has executed" — the gap that needs to be
48
+ * bridged at enqueue time.
49
+ *
50
+ * Pipelining (`proposedCheckpointData`) and invalidation (`invalidateToPendingCheckpointNumber`)
51
+ * are mutually exclusive; passing both throws.
52
+ */
53
+ export async function buildCheckpointSimulationOverridesPlan(
54
+ input: CheckpointSimulationOverridesPlanInput,
55
+ ): Promise<SimulationOverridesPlan | undefined> {
56
+ if (input.proposedCheckpointData && input.invalidateToPendingCheckpointNumber !== undefined) {
57
+ throw new Error(
58
+ 'Error in buildCheckpointSimulationOverridesPlan: proposedCheckpointData and invalidateToPendingCheckpointNumber are mutually exclusive',
59
+ );
60
+ }
61
+
62
+ const builder = new SimulationOverridesBuilder();
63
+ const pendingCheckpointNumber = derivePendingCheckpointNumber(input);
64
+
65
+ // Override the latest checkpoint number when invalidating or pipelining, so our checkpoint
66
+ // follows from it. We also override the proven chain tip so we dont need to worry about
67
+ // prunes kicking in that would break out simulation if there's a prune pending. We always
68
+ // assume that a proof will land in time. If we don't have a pending checkpoint number to force,
69
+ // we still set both tips to the current checkpoint number to avoid the prune trigger.
70
+ const overridenChainTip = pendingCheckpointNumber ?? input.checkpointedCheckpointNumber;
71
+ builder.withChainTips({ pending: overridenChainTip, proven: overridenChainTip });
72
+
73
+ if (input.proposedCheckpointData) {
74
+ const { header, archive, checkpointOutHash, feeAssetPriceModifier } = input.proposedCheckpointData;
75
+ builder.withPendingArchive(archive.root);
76
+ // Override every locally-derivable `tempCheckpointLogs[parent]` field that L1 will eventually
77
+ // write. `slotNumber` is load-bearing for `STFLib.canPruneAtTime`: without it the cell reads
78
+ // slotNumber 0, the contract treats the pending tip as belonging to an expired epoch, and
79
+ // `getEffectivePendingCheckpointNumber` silently collapses pending back to proven — producing
80
+ // a spurious `Rollup__InvalidArchive` against the on-chain genesis archive. The other fields
81
+ // (headerHash, outHash, payloadDigest) are not strictly load-bearing for `canProposeAt` /
82
+ // `validateBlockHeader`, but mirroring the full cell keeps the simulation byte-faithful with
83
+ // what the actual `propose()` send will observe, which is a defense against future reads
84
+ // taking dependencies on them.
85
+ builder.withPendingTempCheckpointLogFields({
86
+ headerHash: header.hash(),
87
+ outHash: checkpointOutHash,
88
+ slotNumber: header.slotNumber,
89
+ payloadDigest: computeCheckpointPayloadDigest({
90
+ header,
91
+ archiveRoot: archive.root,
92
+ feeAssetPriceModifier,
93
+ signatureContext: input.signatureContext,
94
+ }),
95
+ });
96
+
97
+ const feeHeader = await computePipelinedParentFeeHeader({
98
+ checkpointNumber: input.checkpointNumber,
99
+ proposedCheckpointData: input.proposedCheckpointData,
100
+ rollup: input.rollup,
101
+ log: input.log,
102
+ });
103
+ if (feeHeader) {
104
+ builder.withPendingFeeHeader(feeHeader);
105
+ }
106
+ }
107
+
108
+ return builder.build();
109
+ }
110
+
111
+ function derivePendingCheckpointNumber(input: CheckpointSimulationOverridesPlanInput): CheckpointNumber | undefined {
112
+ if (input.invalidateToPendingCheckpointNumber !== undefined) {
113
+ return input.invalidateToPendingCheckpointNumber;
114
+ }
115
+ if (!input.proposedCheckpointData) {
116
+ return undefined;
117
+ }
118
+ if (input.checkpointNumber < 1) {
119
+ throw new Error(`Cannot build simulation override for checkpoint ${input.checkpointNumber}: no parent exists`);
120
+ }
121
+ const expectedParent = CheckpointNumber(input.checkpointNumber - 1);
122
+ if (input.proposedCheckpointData.checkpointNumber !== expectedParent) {
123
+ throw new Error(
124
+ `Cannot build simulation override for checkpoint ${input.checkpointNumber}: proposedCheckpointData.checkpointNumber (${input.proposedCheckpointData.checkpointNumber}) does not match expected parent ${expectedParent}`,
125
+ );
126
+ }
127
+ return expectedParent;
128
+ }
129
+
130
+ type PipelinedParentFeeHeaderInput = {
131
+ checkpointNumber: CheckpointNumber;
132
+ proposedCheckpointData: ProposedCheckpointData;
133
+ rollup: RollupContract;
134
+ log: Logger;
135
+ };
136
+
137
+ /**
138
+ * Derives the pending parent fee header used during pipelined proposal simulation. Returns
139
+ * `undefined` only when no grandparent exists (i.e. the proposed parent is the genesis
140
+ * checkpoint); all other failure modes (missing grandparent state, missing fee header, RPC
141
+ * errors) throw so callers don't silently desync the fee-header override.
142
+ */
143
+ export async function computePipelinedParentFeeHeader(
144
+ input: PipelinedParentFeeHeaderInput,
145
+ ): Promise<FeeHeader | undefined> {
146
+ if (input.checkpointNumber < 2) {
147
+ return undefined;
148
+ }
149
+
150
+ const grandparentCheckpointNumber = CheckpointNumber(input.checkpointNumber - 2);
151
+
152
+ const [grandparentCheckpoint, manaTarget] = await Promise.all([
153
+ input.rollup.getCheckpoint(grandparentCheckpointNumber),
154
+ input.rollup.getManaTarget(),
155
+ ]);
156
+
157
+ if (!grandparentCheckpoint?.feeHeader) {
158
+ throw new Error(
159
+ `Grandparent checkpoint or feeHeader missing for checkpoint ${grandparentCheckpointNumber.toString()}`,
160
+ );
161
+ }
162
+
163
+ return RollupContract.computeChildFeeHeader(
164
+ grandparentCheckpoint.feeHeader,
165
+ input.proposedCheckpointData.totalManaUsed,
166
+ input.proposedCheckpointData.feeAssetPriceModifier,
167
+ manaTarget,
168
+ );
169
+ }