@aztec/epoch-cache 0.0.0-test.1 → 0.0.1-commit.017a351

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.
@@ -1,105 +1,331 @@
1
- import { RollupContract, createEthereumChain } from '@aztec/ethereum';
1
+ import { createEthereumChain } from '@aztec/ethereum/chain';
2
+ import { makeL1HttpTransport } from '@aztec/ethereum/client';
3
+ import { NoCommitteeError, RollupContract } from '@aztec/ethereum/contracts';
4
+ import { getFinalizedL1Block } from '@aztec/ethereum/queries';
5
+ import { SlotNumber } from '@aztec/foundation/branded-types';
2
6
  import { EthAddress } from '@aztec/foundation/eth-address';
3
7
  import { createLogger } from '@aztec/foundation/log';
4
8
  import { DateProvider } from '@aztec/foundation/timer';
5
- import { EmptyL1RollupConstants, getEpochNumberAtTimestamp, getSlotAtTimestamp } from '@aztec/stdlib/epoch-helpers';
6
- import { EventEmitter } from 'node:events';
7
- import { createPublicClient, encodeAbiParameters, fallback, http, keccak256 } from 'viem';
9
+ import { getEpochAtSlot, getEpochNumberAtTimestamp, getNextL1SlotTimestamp, getSlotAtNextL1Block, getSlotAtTimestamp, getSlotRangeForEpoch, getStartTimestampForEpoch, getTimestampForSlot } from '@aztec/stdlib/epoch-helpers';
10
+ import { createPublicClient, encodeAbiParameters, keccak256 } from 'viem';
8
11
  import { getEpochCacheConfigEnvVars } from './config.js';
12
+ /** The proposer pipelines by building one slot ahead. */ export const PROPOSER_PIPELINING_SLOT_OFFSET = 1;
9
13
  /**
10
14
  * Epoch cache
11
15
  *
12
16
  * This class is responsible for managing traffic to the l1 node, by caching the validator set.
17
+ * Keeps the last N epochs in cache.
13
18
  * It also provides a method to get the current or next proposer, and to check who is in the current slot.
14
19
  *
15
- * If the epoch changes, then we update the stored validator set.
16
- *
17
20
  * Note: This class is very dependent on the system clock being in sync.
18
- */ export class EpochCache extends EventEmitter {
21
+ */ export class EpochCache {
19
22
  rollup;
20
23
  l1constants;
21
24
  dateProvider;
22
- committee;
23
- cachedEpoch;
24
- cachedSampleSeed;
25
+ config;
26
+ /**
27
+ * Single map holding both resolved entries and in-flight promises.
28
+ * A `Promise` value means a fetch is in progress; concurrent callers await it.
29
+ */ cache;
30
+ allValidators;
31
+ lastValidatorRefresh;
25
32
  log;
26
- constructor(rollup, initialValidators = [], initialSampleSeed = 0n, l1constants = EmptyL1RollupConstants, dateProvider = new DateProvider()){
27
- super(), this.rollup = rollup, this.l1constants = l1constants, this.dateProvider = dateProvider, this.log = createLogger('epoch-cache');
28
- this.committee = initialValidators;
29
- this.cachedSampleSeed = initialSampleSeed;
30
- this.log.debug(`Initialized EpochCache with constants and validators`, {
31
- l1constants,
32
- initialValidators
33
+ constructor(rollup, l1constants, dateProvider = new DateProvider(), config = {
34
+ cacheSize: 12,
35
+ validatorRefreshIntervalSeconds: 60
36
+ }){
37
+ this.rollup = rollup;
38
+ this.l1constants = l1constants;
39
+ this.dateProvider = dateProvider;
40
+ this.config = config;
41
+ this.cache = new Map();
42
+ this.allValidators = new Set();
43
+ this.lastValidatorRefresh = 0;
44
+ this.log = createLogger('epoch-cache');
45
+ this.log.debug(`Initialized EpochCache`, {
46
+ l1constants
33
47
  });
34
- this.cachedEpoch = getEpochNumberAtTimestamp(this.nowInSeconds(), this.l1constants);
35
48
  }
36
- static async create(rollupAddress, config, deps = {}) {
49
+ static async create(rollupOrAddress, config, deps = {}) {
37
50
  config = config ?? getEpochCacheConfigEnvVars();
38
- const chain = createEthereumChain(config.l1RpcUrls, config.l1ChainId);
39
- const publicClient = createPublicClient({
40
- chain: chain.chainInfo,
41
- transport: fallback(config.l1RpcUrls.map((url)=>http(url))),
42
- pollingInterval: config.viemPollingIntervalMS
43
- });
44
- const rollup = new RollupContract(publicClient, rollupAddress.toString());
45
- const [l1StartBlock, l1GenesisTime, initialValidators, sampleSeed] = await Promise.all([
51
+ // Load the rollup contract if we were given an address
52
+ let rollup;
53
+ if ('address' in rollupOrAddress) {
54
+ rollup = rollupOrAddress;
55
+ } else {
56
+ const chain = createEthereumChain(config.l1RpcUrls, config.l1ChainId);
57
+ const publicClient = createPublicClient({
58
+ chain: chain.chainInfo,
59
+ transport: makeL1HttpTransport(config.l1RpcUrls, {
60
+ timeout: config.l1HttpTimeoutMS
61
+ }),
62
+ pollingInterval: config.viemPollingIntervalMS
63
+ });
64
+ rollup = new RollupContract(publicClient, rollupOrAddress.toString());
65
+ }
66
+ const [l1StartBlock, l1GenesisTime, proofSubmissionEpochs, slotDuration, epochDuration, lagInEpochsForValidatorSet, lagInEpochsForRandao, targetCommitteeSize, rollupManaLimit] = await Promise.all([
46
67
  rollup.getL1StartBlock(),
47
68
  rollup.getL1GenesisTime(),
48
- rollup.getCurrentEpochCommittee(),
49
- rollup.getCurrentSampleSeed()
69
+ rollup.getProofSubmissionEpochs(),
70
+ rollup.getSlotDuration(),
71
+ rollup.getEpochDuration(),
72
+ rollup.getLagInEpochsForValidatorSet(),
73
+ rollup.getLagInEpochsForRandao(),
74
+ rollup.getTargetCommitteeSize(),
75
+ rollup.getManaLimit()
50
76
  ]);
51
77
  const l1RollupConstants = {
52
78
  l1StartBlock,
53
79
  l1GenesisTime,
54
- slotDuration: config.aztecSlotDuration,
55
- epochDuration: config.aztecEpochDuration,
56
- ethereumSlotDuration: config.ethereumSlotDuration
80
+ proofSubmissionEpochs: Number(proofSubmissionEpochs),
81
+ slotDuration: Number(slotDuration),
82
+ epochDuration: Number(epochDuration),
83
+ ethereumSlotDuration: config.ethereumSlotDuration,
84
+ lagInEpochsForValidatorSet: Number(lagInEpochsForValidatorSet),
85
+ lagInEpochsForRandao: Number(lagInEpochsForRandao),
86
+ targetCommitteeSize: Number(targetCommitteeSize),
87
+ rollupManaLimit: Number(rollupManaLimit)
57
88
  };
58
- return new EpochCache(rollup, initialValidators.map((v)=>EthAddress.fromString(v)), sampleSeed, l1RollupConstants, deps.dateProvider);
89
+ return new EpochCache(rollup, l1RollupConstants, deps.dateProvider, {
90
+ cacheSize: 12,
91
+ validatorRefreshIntervalSeconds: 60
92
+ });
93
+ }
94
+ getL1Constants() {
95
+ return this.l1constants;
96
+ }
97
+ getSlotNow() {
98
+ return this.getEpochAndSlotNow().slot;
99
+ }
100
+ getTargetSlot() {
101
+ const slotNow = this.getSlotNow();
102
+ const offset = PROPOSER_PIPELINING_SLOT_OFFSET;
103
+ return SlotNumber(slotNow + offset);
104
+ }
105
+ getEpochNow() {
106
+ return this.getEpochAndSlotNow().epoch;
59
107
  }
60
- nowInSeconds() {
61
- return BigInt(Math.floor(this.dateProvider.now() / 1000));
108
+ getTargetEpoch() {
109
+ return getEpochAtSlot(this.getTargetSlot(), this.l1constants);
62
110
  }
63
111
  getEpochAndSlotNow() {
64
- return this.getEpochAndSlotAtTimestamp(this.nowInSeconds());
112
+ const nowMs = BigInt(this.dateProvider.now());
113
+ const nowSeconds = nowMs / 1000n;
114
+ return {
115
+ ...this.getEpochAndSlotAtTimestamp(nowSeconds),
116
+ nowMs
117
+ };
118
+ }
119
+ getEpochAndSlotAtSlot(slot) {
120
+ return this.getEpochAndSlotAtTimestamp(getTimestampForSlot(slot, this.l1constants));
121
+ }
122
+ getEpochAndSlotInNextL1Slot() {
123
+ const nowSeconds = this.dateProvider.nowInSeconds();
124
+ const nextSlotTs = getNextL1SlotTimestamp(nowSeconds, this.l1constants);
125
+ return {
126
+ ...this.getEpochAndSlotAtTimestamp(nextSlotTs),
127
+ nowSeconds: BigInt(nowSeconds)
128
+ };
65
129
  }
66
- getEpochAndSlotInNextSlot() {
67
- const nextSlotTs = this.nowInSeconds() + BigInt(this.l1constants.slotDuration);
68
- return this.getEpochAndSlotAtTimestamp(nextSlotTs);
130
+ getTargetEpochAndSlotInNextL1Slot() {
131
+ const result = this.getEpochAndSlotInNextL1Slot();
132
+ const offset = PROPOSER_PIPELINING_SLOT_OFFSET;
133
+ const targetSlot = SlotNumber(result.slot + offset);
134
+ return {
135
+ ...result,
136
+ slot: targetSlot,
137
+ epoch: getEpochAtSlot(targetSlot, this.l1constants)
138
+ };
69
139
  }
70
140
  getEpochAndSlotAtTimestamp(ts) {
141
+ const slot = getSlotAtTimestamp(ts, this.l1constants);
142
+ const epoch = getEpochNumberAtTimestamp(ts, this.l1constants);
71
143
  return {
72
- epoch: getEpochNumberAtTimestamp(ts, this.l1constants),
73
- slot: getSlotAtTimestamp(ts, this.l1constants),
74
- ts
144
+ slot,
145
+ epoch,
146
+ ts: getTimestampForSlot(slot, this.l1constants)
75
147
  };
76
148
  }
149
+ getCommitteeForEpoch(epoch) {
150
+ const [startSlot] = getSlotRangeForEpoch(epoch, this.l1constants);
151
+ return this.getCommittee(startSlot);
152
+ }
153
+ /** Returns whether the escape hatch is open for the given epoch. */ async isEscapeHatchOpen(epoch) {
154
+ const info = await this.getCommitteeForEpoch(epoch);
155
+ return info.isEscapeHatchOpen;
156
+ }
77
157
  /**
78
- * Get the current validator set
158
+ * Returns whether the escape hatch is open for the epoch containing the given slot.
79
159
  *
80
- * @param nextSlot - If true, get the validator set for the next slot.
81
- * @returns The current validator set.
82
- */ async getCommittee(nextSlot = false) {
83
- // If the current epoch has changed, then we need to make a request to update the validator set
84
- const { epoch: calculatedEpoch, ts } = nextSlot ? this.getEpochAndSlotInNextSlot() : this.getEpochAndSlotNow();
85
- if (calculatedEpoch !== this.cachedEpoch) {
86
- this.log.debug(`Updating validator set for new epoch ${calculatedEpoch}`, {
87
- epoch: calculatedEpoch,
88
- previousEpoch: this.cachedEpoch
89
- });
90
- const [committeeAtTs, sampleSeedAtTs] = await Promise.all([
91
- this.rollup.getCommitteeAt(ts),
92
- this.rollup.getSampleSeedAt(ts)
93
- ]);
94
- this.committee = committeeAtTs.map((v)=>EthAddress.fromString(v));
95
- this.cachedEpoch = calculatedEpoch;
96
- this.cachedSampleSeed = sampleSeedAtTs;
97
- this.log.debug(`Updated validator set for epoch ${calculatedEpoch}`, {
98
- commitee: this.committee
99
- });
100
- this.emit('committeeChanged', this.committee, calculatedEpoch);
160
+ * This is a lightweight helper intended for callers that already have a slot number and only
161
+ * need the escape hatch flag (without pulling full committee info).
162
+ */ async isEscapeHatchOpenAtSlot(slot = 'now') {
163
+ const epoch = slot === 'now' ? this.getEpochNow() : slot === 'next' ? this.getEpochAndSlotInNextL1Slot().epoch : getEpochAtSlot(slot, this.l1constants);
164
+ return await this.isEscapeHatchOpen(epoch);
165
+ }
166
+ /**
167
+ * Get the current validator set.
168
+ *
169
+ * Returns cached data if the entry is finalized or still fresh (queried less than one
170
+ * Ethereum slot ago). Stale non-finalized entries are re-queried, and concurrent callers
171
+ * coalesce on the same in-flight promise so the L1 query happens only once.
172
+ */ async getCommittee(slot = 'now') {
173
+ const { epoch, ts } = this.getEpochAndTimestamp(slot);
174
+ const cached = this.cache.get(epoch);
175
+ // In-flight promise: another caller is already fetching this epoch — just await it.
176
+ if (cached instanceof Promise) {
177
+ return (await cached).data;
178
+ }
179
+ // Resolved entry: return it if finalized or still fresh.
180
+ if (cached && (cached.finalized || !this.isStale(cached))) {
181
+ return cached.data;
182
+ }
183
+ // Stale non-finalized entry: do a lightweight refresh first (check block hash + finalized ts).
184
+ // Only fall back to a full re-fetch if the L1 block was reorged.
185
+ if (cached) {
186
+ const promise = this.refreshStaleEntry(cached, epoch, ts);
187
+ this.cache.set(epoch, promise);
188
+ try {
189
+ return (await promise).data;
190
+ } catch (err) {
191
+ this.cache.set(epoch, cached);
192
+ throw err;
193
+ }
194
+ }
195
+ // No entry at all: full fetch.
196
+ const promise = this.fetchAndCache(epoch, ts);
197
+ this.cache.set(epoch, promise);
198
+ try {
199
+ return (await promise).data;
200
+ } catch (err) {
201
+ this.cache.delete(epoch);
202
+ throw err;
203
+ }
204
+ }
205
+ getEpochAndTimestamp(slot = 'now') {
206
+ if (slot === 'now') {
207
+ return this.getEpochAndSlotNow();
208
+ } else if (slot === 'next') {
209
+ return this.getEpochAndSlotInNextL1Slot();
210
+ } else {
211
+ return this.getEpochAndSlotAtSlot(slot);
212
+ }
213
+ }
214
+ /** Evicts oldest cache entries (resolved or in-flight) beyond cacheSize. */ purgeCache() {
215
+ if (this.cache.size <= this.config.cacheSize) {
216
+ return;
217
+ }
218
+ const toPurge = Array.from(this.cache.keys()).sort((a, b)=>Number(b - a)).slice(this.config.cacheSize);
219
+ toPurge.forEach((key)=>this.cache.delete(key));
220
+ }
221
+ /** Returns true if a non-finalized cache entry is older than one Ethereum slot. */ isStale(entry) {
222
+ const nowSeconds = BigInt(this.dateProvider.nowInSeconds());
223
+ return nowSeconds - entry.lastRefreshL1Timestamp >= BigInt(this.l1constants.ethereumSlotDuration);
224
+ }
225
+ /** Whether a cached epoch entry has been marked as finalized. Returns undefined if not cached or still in-flight. */ isFinalized(epoch) {
226
+ const entry = this.cache.get(epoch);
227
+ if (!entry || entry instanceof Promise) {
228
+ return undefined;
229
+ }
230
+ return entry.finalized;
231
+ }
232
+ /** Returns the latest L1 timestamp stored in the cached entry. Undefined if not cached or in-flight. */ getCachedLastRefreshL1Timestamp(epoch) {
233
+ const entry = this.cache.get(epoch);
234
+ if (!entry || entry instanceof Promise) {
235
+ return undefined;
101
236
  }
102
- return this.committee;
237
+ return entry.lastRefreshL1Timestamp;
238
+ }
239
+ /** Computes the sampling timestamp for an epoch's committee data. */ getSamplingTimestamp(epoch) {
240
+ const { lagInEpochsForRandao, epochDuration, slotDuration } = this.l1constants;
241
+ const epochStartTs = getStartTimestampForEpoch(epoch, this.l1constants);
242
+ return epochStartTs - BigInt(lagInEpochsForRandao) * BigInt(epochDuration) * BigInt(slotDuration);
243
+ }
244
+ /**
245
+ * Lightweight refresh for a stale non-finalized entry. Queries only the block hash at
246
+ * the original block number and the finalized block timestamp — avoids the expensive
247
+ * getCommitteeAt and getSampleSeedAt calls on the rollup contract.
248
+ *
249
+ * If the block hash still matches (no L1 reorg), we keep the existing data and just
250
+ * update the provenance timestamp. If the finalized block has caught up, we promote the
251
+ * entry to finalized. If there was a reorg (hash mismatch), we fall back to a full fetch.
252
+ */ async refreshStaleEntry(stale, epoch, ts) {
253
+ const [blockAtOriginal, l1FinalizedBlock, latestBlock] = await Promise.all([
254
+ this.rollup.client.getBlock({
255
+ blockNumber: stale.lastQueryL1BlockNumber,
256
+ includeTransactions: false
257
+ }),
258
+ getFinalizedL1Block(this.rollup.client),
259
+ this.rollup.client.getBlock({
260
+ includeTransactions: false
261
+ })
262
+ ]);
263
+ if (blockAtOriginal.hash === stale.lastQueryL1BlockHash) {
264
+ // No reorg: the data is still valid. Check if we can now mark it as finalized.
265
+ const samplingTs = this.getSamplingTimestamp(epoch);
266
+ const finalized = !!(stale.data.committee && stale.data.committee.length > 0) && l1FinalizedBlock !== undefined && samplingTs <= l1FinalizedBlock.timestamp;
267
+ const refreshed = {
268
+ ...stale,
269
+ lastRefreshL1Timestamp: latestBlock.timestamp,
270
+ finalized
271
+ };
272
+ this.cache.set(epoch, refreshed);
273
+ return refreshed;
274
+ }
275
+ // Reorg detected: block hash mismatch. Do a full re-fetch.
276
+ // Pass the already-fetched block timestamps to avoid redundant queries.
277
+ this.log.warn(`L1 reorg detected for epoch ${epoch}: block ${stale.lastQueryL1BlockNumber} hash changed`, {
278
+ epoch,
279
+ expectedHash: stale.lastQueryL1BlockHash,
280
+ actualHash: blockAtOriginal.hash
281
+ });
282
+ return this.fetchAndCache(epoch, ts, {
283
+ latestBlock,
284
+ finalizedBlock: l1FinalizedBlock
285
+ });
286
+ }
287
+ /**
288
+ * Fetches committee data from L1, determines finalization status, and stores in the cache.
289
+ *
290
+ * Uses `lagInEpochsForRandao` (the binding constraint, always <= lagInEpochsForValidatorSet)
291
+ * and computes the sampling timestamp from the epoch start to match the L1 contract's logic.
292
+ *
293
+ * When called from refreshStaleEntry after a reorg, the latest and finalized blocks are
294
+ * passed in to avoid redundant L1 queries.
295
+ */ async fetchAndCache(epoch, ts, prefetched) {
296
+ const [committee, seedBuffer, latestBlock, finalizedBlock, isEscapeHatchOpen] = await Promise.all([
297
+ this.rollup.getCommitteeAt(ts),
298
+ this.rollup.getSampleSeedAt(ts),
299
+ prefetched?.latestBlock ?? this.rollup.client.getBlock({
300
+ includeTransactions: false
301
+ }),
302
+ prefetched !== undefined ? prefetched.finalizedBlock : getFinalizedL1Block(this.rollup.client),
303
+ this.rollup.isEscapeHatchOpen(epoch)
304
+ ]);
305
+ const samplingTs = this.getSamplingTimestamp(epoch);
306
+ if (samplingTs > latestBlock.timestamp) {
307
+ throw new Error(`Cannot query committee for future epoch ${epoch}: ` + `sampling timestamp ${samplingTs} is beyond latest L1 block at ${latestBlock.timestamp}. ` + `Check your Ethereum node is synced.`);
308
+ }
309
+ // Empty committees are never marked finalized so they always get re-queried after TTL.
310
+ // If L1 has no finalized block yet (devnet startup), entries stay unfinalized.
311
+ const hasCommittee = !!(committee && committee.length > 0);
312
+ const finalized = hasCommittee && finalizedBlock !== undefined && samplingTs <= finalizedBlock.timestamp;
313
+ const data = {
314
+ committee,
315
+ seed: seedBuffer.toBigInt(),
316
+ epoch,
317
+ isEscapeHatchOpen
318
+ };
319
+ const entry = {
320
+ data,
321
+ lastQueryL1BlockNumber: latestBlock.number,
322
+ lastQueryL1BlockHash: latestBlock.hash,
323
+ lastRefreshL1Timestamp: latestBlock.timestamp,
324
+ finalized
325
+ };
326
+ this.cache.set(epoch, entry);
327
+ this.purgeCache();
328
+ return entry;
103
329
  }
104
330
  /**
105
331
  * Get the ABI encoding of the proposer index - see ValidatorSelectionLib.sol computeProposerIndex
@@ -118,47 +344,101 @@ import { getEpochCacheConfigEnvVars } from './config.js';
118
344
  name: 'seed'
119
345
  }
120
346
  ], [
121
- epoch,
122
- slot,
347
+ BigInt(epoch),
348
+ BigInt(slot),
123
349
  seed
124
350
  ]);
125
351
  }
126
352
  computeProposerIndex(slot, epoch, seed, size) {
353
+ // if committe size is 0, then mod 1 is 0
354
+ if (size === 0n) {
355
+ return 0n;
356
+ }
127
357
  return BigInt(keccak256(this.getProposerIndexEncoding(epoch, slot, seed))) % size;
128
358
  }
129
- /**
130
- * Returns the current and next proposer
131
- *
132
- * We return the next proposer as the node will check if it is the proposer at the next ethereum block, which
133
- * can be the next slot. If this is the case, then it will send proposals early.
134
- *
135
- * If we are at an epoch boundary, then we can update the cache for the next epoch, this is the last check
136
- * we do in the validator client, so we can update the cache here.
137
- */ async getProposerInCurrentOrNextSlot() {
138
- // Validators are sorted by their index in the committee, and getValidatorSet will cache
139
- const committee = await this.getCommittee();
140
- const { slot: currentSlot, epoch: currentEpoch } = this.getEpochAndSlotNow();
141
- const { slot: nextSlot, epoch: nextEpoch } = this.getEpochAndSlotInNextSlot();
142
- // Compute the proposer in this and the next slot
143
- const proposerIndex = this.computeProposerIndex(currentSlot, this.cachedEpoch, this.cachedSampleSeed, BigInt(committee.length));
144
- // Check if the next proposer is in the next epoch
145
- if (nextEpoch !== currentEpoch) {
146
- await this.getCommittee(/*next slot*/ true);
147
- }
148
- const nextProposerIndex = this.computeProposerIndex(nextSlot, this.cachedEpoch, this.cachedSampleSeed, BigInt(committee.length));
149
- const currentProposer = committee[Number(proposerIndex)];
150
- const nextProposer = committee[Number(nextProposerIndex)];
359
+ /** Returns the current and next L2 slot in next eth L1 Slot. */ getCurrentAndNextSlot() {
360
+ const currentSlot = this.getSlotNow();
361
+ const next = this.getEpochAndSlotInNextL1Slot();
151
362
  return {
152
- currentProposer,
153
- nextProposer,
154
363
  currentSlot,
364
+ nextSlot: next.slot
365
+ };
366
+ }
367
+ /** Returns the target and next L2 slot in the next L1 slot. */ getTargetAndNextSlot() {
368
+ const nowSeconds = BigInt(this.dateProvider.nowInSeconds());
369
+ const offset = PROPOSER_PIPELINING_SLOT_OFFSET;
370
+ const currentSlot = getSlotAtTimestamp(nowSeconds, this.l1constants);
371
+ const targetSlot = SlotNumber(currentSlot + offset);
372
+ const nextL2SlotOnL1 = getSlotAtNextL1Block(nowSeconds, this.l1constants);
373
+ const nextSlot = SlotNumber(nextL2SlotOnL1 + offset);
374
+ return {
375
+ targetSlot,
155
376
  nextSlot
156
377
  };
157
378
  }
158
379
  /**
159
- * Check if a validator is in the current epoch's committee
160
- */ async isInCommittee(validator) {
161
- const committee = await this.getCommittee();
380
+ * Get the proposer attester address in the given L2 slot
381
+ * @returns The proposer attester address. If the committee does not exist, we throw a NoCommitteeError.
382
+ * If the committee is empty (i.e. target committee size is 0, and anyone can propose), we return undefined.
383
+ */ getProposerAttesterAddressInSlot(slot) {
384
+ const epochAndSlot = this.getEpochAndSlotAtSlot(slot);
385
+ return this.getProposerAttesterAddressAt(epochAndSlot);
386
+ }
387
+ /**
388
+ * Get the proposer attester address in the next slot
389
+ * @returns The proposer attester address. If the committee does not exist, we throw a NoCommitteeError.
390
+ * If the committee is empty (i.e. target committee size is 0, and anyone can propose), we return undefined.
391
+ */ getProposerAttesterAddressInNextSlot() {
392
+ const epochAndSlot = this.getEpochAndSlotInNextL1Slot();
393
+ return this.getProposerAttesterAddressAt(epochAndSlot);
394
+ }
395
+ /**
396
+ * Get the proposer attester address at a given epoch and slot
397
+ * @param when - The epoch and slot to get the proposer attester address at
398
+ * @returns The proposer attester address. If the committee does not exist, we throw a NoCommitteeError.
399
+ * If the committee is empty (i.e. target committee size is 0, and anyone can propose), we return undefined.
400
+ */ async getProposerAttesterAddressAt(when) {
401
+ const { epoch, slot } = when;
402
+ const { committee, seed } = await this.getCommittee(slot);
403
+ if (!committee) {
404
+ throw new NoCommitteeError();
405
+ } else if (committee.length === 0) {
406
+ return undefined;
407
+ }
408
+ const proposerIndex = this.computeProposerIndex(slot, epoch, seed, BigInt(committee.length));
409
+ return committee[Number(proposerIndex)];
410
+ }
411
+ getProposerFromEpochCommittee(epochCommitteeInfo, slot) {
412
+ if (!epochCommitteeInfo.committee || epochCommitteeInfo.committee.length === 0) {
413
+ return undefined;
414
+ }
415
+ const proposerIndex = this.computeProposerIndex(slot, epochCommitteeInfo.epoch, epochCommitteeInfo.seed, BigInt(epochCommitteeInfo.committee.length));
416
+ return epochCommitteeInfo.committee[Number(proposerIndex)];
417
+ }
418
+ /** Check if a validator is in the given slot's committee */ async isInCommittee(slot, validator) {
419
+ const { committee } = await this.getCommittee(slot);
420
+ if (!committee) {
421
+ return false;
422
+ }
162
423
  return committee.some((v)=>v.equals(validator));
163
424
  }
425
+ /** From the set of given addresses, return all that are on the committee for the given slot */ async filterInCommittee(slot, validators) {
426
+ const { committee } = await this.getCommittee(slot);
427
+ if (!committee) {
428
+ return [];
429
+ }
430
+ const committeeSet = new Set(committee.map((v)=>v.toString()));
431
+ return validators.filter((v)=>committeeSet.has(v.toString()));
432
+ }
433
+ async getRegisteredValidators() {
434
+ const validatorRefreshIntervalMs = this.config.validatorRefreshIntervalSeconds * 1000;
435
+ const validatorRefreshTime = this.lastValidatorRefresh + validatorRefreshIntervalMs;
436
+ const now = this.dateProvider.now();
437
+ if (validatorRefreshTime < now) {
438
+ const currentSet = await this.rollup.getAttesters(BigInt(Math.floor(now / 1000)));
439
+ this.allValidators = new Set(currentSet.map((v)=>v.toString()));
440
+ this.lastValidatorRefresh = now;
441
+ }
442
+ return Array.from(this.allValidators.keys()).map((v)=>EthAddress.fromString(v));
443
+ }
164
444
  }
package/dest/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  export * from './epoch_cache.js';
2
2
  export * from './config.js';
3
- //# sourceMappingURL=index.d.ts.map
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsYUFBYSxDQUFDIn0=
@@ -0,0 +1,2 @@
1
+ export * from './test_epoch_cache.js';
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90ZXN0L2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsdUJBQXVCLENBQUMifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC"}
@@ -0,0 +1 @@
1
+ export * from './test_epoch_cache.js';
@@ -0,0 +1,88 @@
1
+ import { EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
2
+ import { EthAddress } from '@aztec/foundation/eth-address';
3
+ import type { L1RollupConstants } from '@aztec/stdlib/epoch-helpers';
4
+ import { type EpochAndSlot, type EpochCacheInterface, type EpochCommitteeInfo, type SlotTag } from '../epoch_cache.js';
5
+ /**
6
+ * A test implementation of EpochCacheInterface that allows manual configuration
7
+ * of committee, proposer, slot, and escape hatch state for use in tests.
8
+ *
9
+ * Unlike the real EpochCache, this class doesn't require any RPC connections
10
+ * or mock setup. Simply use the setter methods to configure the test state.
11
+ */
12
+ export declare class TestEpochCache implements EpochCacheInterface {
13
+ private committee;
14
+ private proposerAddress;
15
+ private currentSlot;
16
+ private escapeHatchOpen;
17
+ private seed;
18
+ private registeredValidators;
19
+ private l1Constants;
20
+ constructor(l1Constants?: Partial<L1RollupConstants>);
21
+ /**
22
+ * Sets the committee members. Used in validation and attestation flows.
23
+ * @param committee - Array of committee member addresses.
24
+ */
25
+ setCommittee(committee: EthAddress[]): this;
26
+ /**
27
+ * Sets the proposer address returned by getProposerAttesterAddressInSlot.
28
+ * @param proposer - The address of the current proposer.
29
+ */
30
+ setProposer(proposer: EthAddress | undefined): this;
31
+ /**
32
+ * Sets the current slot number.
33
+ * @param slot - The slot number to set.
34
+ */
35
+ setCurrentSlot(slot: SlotNumber): this;
36
+ /**
37
+ * Sets whether the escape hatch is open.
38
+ * @param open - True if escape hatch should be open.
39
+ */
40
+ setEscapeHatchOpen(open: boolean): this;
41
+ /**
42
+ * Sets the randomness seed used for proposer selection.
43
+ * @param seed - The seed value.
44
+ */
45
+ setSeed(seed: bigint): this;
46
+ /**
47
+ * Sets the list of registered validators (all validators, not just committee).
48
+ * @param validators - Array of validator addresses.
49
+ */
50
+ setRegisteredValidators(validators: EthAddress[]): this;
51
+ /**
52
+ * Sets the L1 constants used for epoch/slot calculations.
53
+ * @param constants - Partial constants to override defaults.
54
+ */
55
+ setL1Constants(constants: Partial<L1RollupConstants>): this;
56
+ getL1Constants(): L1RollupConstants;
57
+ getCommittee(_slot?: SlotTag): Promise<EpochCommitteeInfo>;
58
+ getSlotNow(): SlotNumber;
59
+ getTargetSlot(): SlotNumber;
60
+ getEpochNow(): EpochNumber;
61
+ getTargetEpoch(): EpochNumber;
62
+ getEpochAndSlotNow(): EpochAndSlot & {
63
+ nowMs: bigint;
64
+ };
65
+ getEpochAndSlotInNextL1Slot(): EpochAndSlot & {
66
+ nowSeconds: bigint;
67
+ };
68
+ getTargetEpochAndSlotInNextL1Slot(): EpochAndSlot & {
69
+ nowSeconds: bigint;
70
+ };
71
+ getProposerIndexEncoding(epoch: EpochNumber, slot: SlotNumber, seed: bigint): `0x${string}`;
72
+ computeProposerIndex(slot: SlotNumber, _epoch: EpochNumber, _seed: bigint, size: bigint): bigint;
73
+ getCurrentAndNextSlot(): {
74
+ currentSlot: SlotNumber;
75
+ nextSlot: SlotNumber;
76
+ };
77
+ getTargetAndNextSlot(): {
78
+ targetSlot: SlotNumber;
79
+ nextSlot: SlotNumber;
80
+ };
81
+ getProposerAttesterAddressInSlot(_slot: SlotNumber): Promise<EthAddress | undefined>;
82
+ getRegisteredValidators(): Promise<EthAddress[]>;
83
+ isInCommittee(_slot: SlotTag, validator: EthAddress): Promise<boolean>;
84
+ filterInCommittee(_slot: SlotTag, validators: EthAddress[]): Promise<EthAddress[]>;
85
+ isEscapeHatchOpen(_epoch: EpochNumber): Promise<boolean>;
86
+ isEscapeHatchOpenAtSlot(_slot?: SlotTag): Promise<boolean>;
87
+ }
88
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdF9lcG9jaF9jYWNoZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3Rlc3QvdGVzdF9lcG9jaF9jYWNoZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsV0FBVyxFQUFFLFVBQVUsRUFBRSxNQUFNLGlDQUFpQyxDQUFDO0FBQzFFLE9BQU8sRUFBRSxVQUFVLEVBQUUsTUFBTSwrQkFBK0IsQ0FBQztBQUMzRCxPQUFPLEtBQUssRUFBRSxpQkFBaUIsRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBR3JFLE9BQU8sRUFDTCxLQUFLLFlBQVksRUFDakIsS0FBSyxtQkFBbUIsRUFDeEIsS0FBSyxrQkFBa0IsRUFFdkIsS0FBSyxPQUFPLEVBQ2IsTUFBTSxtQkFBbUIsQ0FBQztBQWMzQjs7Ozs7O0dBTUc7QUFDSCxxQkFBYSxjQUFlLFlBQVcsbUJBQW1CO0lBQ3hELE9BQU8sQ0FBQyxTQUFTLENBQW9CO0lBQ3JDLE9BQU8sQ0FBQyxlQUFlLENBQXlCO0lBQ2hELE9BQU8sQ0FBQyxXQUFXLENBQTZCO0lBQ2hELE9BQU8sQ0FBQyxlQUFlLENBQWtCO0lBQ3pDLE9BQU8sQ0FBQyxJQUFJLENBQWM7SUFDMUIsT0FBTyxDQUFDLG9CQUFvQixDQUFvQjtJQUNoRCxPQUFPLENBQUMsV0FBVyxDQUFvQjtJQUV2QyxZQUFZLFdBQVcsR0FBRSxPQUFPLENBQUMsaUJBQWlCLENBQU0sRUFFdkQ7SUFFRDs7O09BR0c7SUFDSCxZQUFZLENBQUMsU0FBUyxFQUFFLFVBQVUsRUFBRSxHQUFHLElBQUksQ0FHMUM7SUFFRDs7O09BR0c7SUFDSCxXQUFXLENBQUMsUUFBUSxFQUFFLFVBQVUsR0FBRyxTQUFTLEdBQUcsSUFBSSxDQUdsRDtJQUVEOzs7T0FHRztJQUNILGNBQWMsQ0FBQyxJQUFJLEVBQUUsVUFBVSxHQUFHLElBQUksQ0FHckM7SUFFRDs7O09BR0c7SUFDSCxrQkFBa0IsQ0FBQyxJQUFJLEVBQUUsT0FBTyxHQUFHLElBQUksQ0FHdEM7SUFFRDs7O09BR0c7SUFDSCxPQUFPLENBQUMsSUFBSSxFQUFFLE1BQU0sR0FBRyxJQUFJLENBRzFCO0lBRUQ7OztPQUdHO0lBQ0gsdUJBQXVCLENBQUMsVUFBVSxFQUFFLFVBQVUsRUFBRSxHQUFHLElBQUksQ0FHdEQ7SUFFRDs7O09BR0c7SUFDSCxjQUFjLENBQUMsU0FBUyxFQUFFLE9BQU8sQ0FBQyxpQkFBaUIsQ0FBQyxHQUFHLElBQUksQ0FHMUQ7SUFFRCxjQUFjLElBQUksaUJBQWlCLENBRWxDO0lBRUQsWUFBWSxDQUFDLEtBQUssQ0FBQyxFQUFFLE9BQU8sR0FBRyxPQUFPLENBQUMsa0JBQWtCLENBQUMsQ0FRekQ7SUFFRCxVQUFVLElBQUksVUFBVSxDQUV2QjtJQUVELGFBQWEsSUFBSSxVQUFVLENBRTFCO0lBRUQsV0FBVyxJQUFJLFdBQVcsQ0FFekI7SUFFRCxjQUFjLElBQUksV0FBVyxDQUU1QjtJQUVELGtCQUFrQixJQUFJLFlBQVksR0FBRztRQUFFLEtBQUssRUFBRSxNQUFNLENBQUE7S0FBRSxDQVNyRDtJQUVELDJCQUEyQixJQUFJLFlBQVksR0FBRztRQUFFLFVBQVUsRUFBRSxNQUFNLENBQUE7S0FBRSxDQVluRTtJQUVELGlDQUFpQyxJQUFJLFlBQVksR0FBRztRQUFFLFVBQVUsRUFBRSxNQUFNLENBQUE7S0FBRSxDQUt6RTtJQUVELHdCQUF3QixDQUFDLEtBQUssRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFLFVBQVUsRUFBRSxJQUFJLEVBQUUsTUFBTSxHQUFHLEtBQUssTUFBTSxFQUFFLENBRzFGO0lBRUQsb0JBQW9CLENBQUMsSUFBSSxFQUFFLFVBQVUsRUFBRSxNQUFNLEVBQUUsV0FBVyxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLE1BQU0sR0FBRyxNQUFNLENBSy9GO0lBRUQscUJBQXFCLElBQUk7UUFBRSxXQUFXLEVBQUUsVUFBVSxDQUFDO1FBQUMsUUFBUSxFQUFFLFVBQVUsQ0FBQTtLQUFFLENBUXpFO0lBRUQsb0JBQW9CLElBQUk7UUFBRSxVQUFVLEVBQUUsVUFBVSxDQUFDO1FBQUMsUUFBUSxFQUFFLFVBQVUsQ0FBQTtLQUFFLENBUXZFO0lBRUQsZ0NBQWdDLENBQUMsS0FBSyxFQUFFLFVBQVUsR0FBRyxPQUFPLENBQUMsVUFBVSxHQUFHLFNBQVMsQ0FBQyxDQUVuRjtJQUVELHVCQUF1QixJQUFJLE9BQU8sQ0FBQyxVQUFVLEVBQUUsQ0FBQyxDQUUvQztJQUVELGFBQWEsQ0FBQyxLQUFLLEVBQUUsT0FBTyxFQUFFLFNBQVMsRUFBRSxVQUFVLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUVyRTtJQUVELGlCQUFpQixDQUFDLEtBQUssRUFBRSxPQUFPLEVBQUUsVUFBVSxFQUFFLFVBQVUsRUFBRSxHQUFHLE9BQU8sQ0FBQyxVQUFVLEVBQUUsQ0FBQyxDQUdqRjtJQUVELGlCQUFpQixDQUFDLE1BQU0sRUFBRSxXQUFXLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxDQUV2RDtJQUVELHVCQUF1QixDQUFDLEtBQUssQ0FBQyxFQUFFLE9BQU8sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBRXpEO0NBQ0YifQ==
@@ -0,0 +1 @@
1
+ {"version":3,"file":"test_epoch_cache.d.ts","sourceRoot":"","sources":["../../src/test/test_epoch_cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAGrE,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EAEvB,KAAK,OAAO,EACb,MAAM,mBAAmB,CAAC;AAc3B;;;;;;GAMG;AACH,qBAAa,cAAe,YAAW,mBAAmB;IACxD,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,eAAe,CAAyB;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,IAAI,CAAc;IAC1B,OAAO,CAAC,oBAAoB,CAAoB;IAChD,OAAO,CAAC,WAAW,CAAoB;IAEvC,YAAY,WAAW,GAAE,OAAO,CAAC,iBAAiB,CAAM,EAEvD;IAED;;;OAGG;IACH,YAAY,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAG1C;IAED;;;OAGG;IACH,WAAW,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,CAGlD;IAED;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,CAGrC;IAED;;;OAGG;IACH,kBAAkB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAGtC;IAED;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAG1B;IAED;;;OAGG;IACH,uBAAuB,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,IAAI,CAGtD;IAED;;;OAGG;IACH,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAG1D;IAED,cAAc,IAAI,iBAAiB,CAElC;IAED,YAAY,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAQzD;IAED,UAAU,IAAI,UAAU,CAEvB;IAED,aAAa,IAAI,UAAU,CAE1B;IAED,WAAW,IAAI,WAAW,CAEzB;IAED,cAAc,IAAI,WAAW,CAE5B;IAED,kBAAkB,IAAI,YAAY,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CASrD;IAED,2BAA2B,IAAI,YAAY,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAYnE;IAED,iCAAiC,IAAI,YAAY,GAAG;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,CAKzE;IAED,wBAAwB,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,MAAM,EAAE,CAG1F;IAED,oBAAoB,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAK/F;IAED,qBAAqB,IAAI;QAAE,WAAW,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,CAQzE;IAED,oBAAoB,IAAI;QAAE,UAAU,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,CAQvE;IAED,gCAAgC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAEnF;IAED,uBAAuB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAE/C;IAED,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAErE;IAED,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAGjF;IAED,iBAAiB,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAEvD;IAED,uBAAuB,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAEzD;CACF"}