@aztec/ethereum 0.0.1-commit.934299a21 → 0.0.1-commit.936cb2cae

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 (57) hide show
  1. package/dest/client.d.ts +10 -2
  2. package/dest/client.d.ts.map +1 -1
  3. package/dest/client.js +13 -7
  4. package/dest/config.d.ts +3 -1
  5. package/dest/config.d.ts.map +1 -1
  6. package/dest/config.js +6 -0
  7. package/dest/contracts/multicall.d.ts +51 -2
  8. package/dest/contracts/multicall.d.ts.map +1 -1
  9. package/dest/contracts/multicall.js +85 -0
  10. package/dest/contracts/registry.d.ts +3 -1
  11. package/dest/contracts/registry.d.ts.map +1 -1
  12. package/dest/contracts/registry.js +30 -1
  13. package/dest/contracts/rollup.d.ts +18 -4
  14. package/dest/contracts/rollup.d.ts.map +1 -1
  15. package/dest/contracts/rollup.js +58 -12
  16. package/dest/generated/l1-contracts-defaults.d.ts +1 -1
  17. package/dest/generated/l1-contracts-defaults.js +1 -1
  18. package/dest/l1_artifacts.d.ts +69 -69
  19. package/dest/l1_reader.d.ts +3 -1
  20. package/dest/l1_reader.d.ts.map +1 -1
  21. package/dest/l1_reader.js +6 -1
  22. package/dest/l1_tx_utils/l1_tx_utils.d.ts +6 -3
  23. package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
  24. package/dest/l1_tx_utils/l1_tx_utils.js +40 -50
  25. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts +1 -1
  26. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts.map +1 -1
  27. package/dest/l1_tx_utils/readonly_l1_tx_utils.js +8 -4
  28. package/dest/publisher_manager.d.ts +21 -7
  29. package/dest/publisher_manager.d.ts.map +1 -1
  30. package/dest/publisher_manager.js +81 -7
  31. package/dest/test/chain_monitor.d.ts +22 -3
  32. package/dest/test/chain_monitor.d.ts.map +1 -1
  33. package/dest/test/chain_monitor.js +33 -2
  34. package/dest/test/eth_cheat_codes.d.ts +6 -4
  35. package/dest/test/eth_cheat_codes.d.ts.map +1 -1
  36. package/dest/test/eth_cheat_codes.js +6 -4
  37. package/dest/test/start_anvil.d.ts +23 -3
  38. package/dest/test/start_anvil.d.ts.map +1 -1
  39. package/dest/test/start_anvil.js +143 -29
  40. package/dest/utils.d.ts +1 -1
  41. package/dest/utils.d.ts.map +1 -1
  42. package/dest/utils.js +16 -12
  43. package/package.json +5 -7
  44. package/src/client.ts +10 -2
  45. package/src/config.ts +12 -0
  46. package/src/contracts/multicall.ts +65 -1
  47. package/src/contracts/registry.ts +31 -1
  48. package/src/contracts/rollup.ts +66 -19
  49. package/src/generated/l1-contracts-defaults.ts +1 -1
  50. package/src/l1_reader.ts +13 -1
  51. package/src/l1_tx_utils/l1_tx_utils.ts +30 -27
  52. package/src/l1_tx_utils/readonly_l1_tx_utils.ts +8 -4
  53. package/src/publisher_manager.ts +105 -10
  54. package/src/test/chain_monitor.ts +60 -3
  55. package/src/test/eth_cheat_codes.ts +6 -4
  56. package/src/test/start_anvil.ts +177 -29
  57. package/src/utils.ts +17 -14
@@ -4,6 +4,7 @@ import { Fr } from '@aztec/foundation/curves/bn254';
4
4
  import { memoize } from '@aztec/foundation/decorators';
5
5
  import { EthAddress } from '@aztec/foundation/eth-address';
6
6
  import type { ViemSignature } from '@aztec/foundation/eth-signature';
7
+ import { createLogger } from '@aztec/foundation/log';
7
8
  import { makeBackoff, retry } from '@aztec/foundation/retry';
8
9
  import { EscapeHatchAbi } from '@aztec/l1-artifacts/EscapeHatchAbi';
9
10
  import { RollupAbi } from '@aztec/l1-artifacts/RollupAbi';
@@ -134,6 +135,14 @@ export type L1FeeData = {
134
135
  blobFee: bigint;
135
136
  };
136
137
 
138
+ /** Components of the minimum fee per mana, as returned by the L1 rollup contract. */
139
+ export type ManaMinFeeComponents = {
140
+ sequencerCost: bigint;
141
+ proverCost: bigint;
142
+ congestionCost: bigint;
143
+ congestionMultiplier: bigint;
144
+ };
145
+
137
146
  /**
138
147
  * Reward configuration for the rollup
139
148
  */
@@ -204,6 +213,7 @@ export type CheckpointProposedLog = L1EventLog<CheckpointProposedArgs>;
204
213
 
205
214
  export class RollupContract {
206
215
  private readonly rollup: GetContractReturnType<typeof RollupAbi, ViemClient>;
216
+ private readonly logger = createLogger('ethereum:rollup');
207
217
 
208
218
  private static cachedStfStorageSlot: Hex | undefined;
209
219
  private cachedEscapeHatch?: {
@@ -379,6 +389,20 @@ export class RollupContract {
379
389
  return Fr.fromString(await this.rollup.read.archiveAt([0n]));
380
390
  }
381
391
 
392
+ @memoize
393
+ async getVkTreeRoot(): Promise<Fr> {
394
+ const slot = BigInt(RollupContract.stfStorageSlot) + 3n;
395
+ const value = await this.client.getStorageAt({ address: this.address, slot: `0x${slot.toString(16)}` });
396
+ return Fr.fromString(value ?? '0x0');
397
+ }
398
+
399
+ @memoize
400
+ async getProtocolContractsHash(): Promise<Fr> {
401
+ const slot = BigInt(RollupContract.stfStorageSlot) + 4n;
402
+ const value = await this.client.getStorageAt({ address: this.address, slot: `0x${slot.toString(16)}` });
403
+ return Fr.fromString(value ?? '0x0');
404
+ }
405
+
382
406
  /**
383
407
  * Returns rollup constants used for epoch queries.
384
408
  * Return type is `L1RollupConstants` which is defined in stdlib,
@@ -392,16 +416,25 @@ export class RollupContract {
392
416
  epochDuration: number;
393
417
  proofSubmissionEpochs: number;
394
418
  targetCommitteeSize: number;
419
+ rollupManaLimit: number;
395
420
  }> {
396
- const [l1StartBlock, l1GenesisTime, slotDuration, epochDuration, proofSubmissionEpochs, targetCommitteeSize] =
397
- await Promise.all([
398
- this.getL1StartBlock(),
399
- this.getL1GenesisTime(),
400
- this.getSlotDuration(),
401
- this.getEpochDuration(),
402
- this.getProofSubmissionEpochs(),
403
- this.getTargetCommitteeSize(),
404
- ]);
421
+ const [
422
+ l1StartBlock,
423
+ l1GenesisTime,
424
+ slotDuration,
425
+ epochDuration,
426
+ proofSubmissionEpochs,
427
+ targetCommitteeSize,
428
+ rollupManaLimit,
429
+ ] = await Promise.all([
430
+ this.getL1StartBlock(),
431
+ this.getL1GenesisTime(),
432
+ this.getSlotDuration(),
433
+ this.getEpochDuration(),
434
+ this.getProofSubmissionEpochs(),
435
+ this.getTargetCommitteeSize(),
436
+ this.getManaLimit(),
437
+ ]);
405
438
  return {
406
439
  l1StartBlock,
407
440
  l1GenesisTime,
@@ -409,6 +442,7 @@ export class RollupContract {
409
442
  epochDuration: Number(epochDuration),
410
443
  proofSubmissionEpochs: Number(proofSubmissionEpochs),
411
444
  targetCommitteeSize,
445
+ rollupManaLimit: Number(rollupManaLimit),
412
446
  };
413
447
  }
414
448
 
@@ -463,7 +497,11 @@ export class RollupContract {
463
497
 
464
498
  const [isOpen] = await escapeHatch.read.isHatchOpen([BigInt(epoch)]);
465
499
  return isOpen;
466
- } catch {
500
+ } catch (err) {
501
+ this.logger.warn('isEscapeHatchOpen failed (treating as closed); RPC or contract error may cause liveness risk', {
502
+ epoch: Number(epoch),
503
+ error: err,
504
+ });
467
505
  return false;
468
506
  }
469
507
  }
@@ -503,8 +541,9 @@ export class RollupContract {
503
541
  return CheckpointNumber.fromBigInt(await this.rollup.read.getPendingCheckpointNumber());
504
542
  }
505
543
 
506
- async getProvenCheckpointNumber(): Promise<CheckpointNumber> {
507
- return CheckpointNumber.fromBigInt(await this.rollup.read.getProvenCheckpointNumber());
544
+ async getProvenCheckpointNumber(options?: { blockNumber?: bigint }): Promise<CheckpointNumber> {
545
+ await checkBlockTag(options?.blockNumber, this.client);
546
+ return CheckpointNumber.fromBigInt(await this.rollup.read.getProvenCheckpointNumber(options));
508
547
  }
509
548
 
510
549
  async getSlotNumber(): Promise<SlotNumber> {
@@ -745,14 +784,13 @@ export class RollupContract {
745
784
  * timestamp of the next L1 block
746
785
  * @throws otherwise
747
786
  */
748
- public async canProposeAtNextEthBlock(
787
+ public async canProposeAt(
749
788
  archive: Buffer,
750
789
  account: `0x${string}` | Account,
751
- slotDuration: number,
790
+ timestamp: bigint,
752
791
  opts: { forcePendingCheckpointNumber?: CheckpointNumber } = {},
753
792
  ): Promise<{ slot: SlotNumber; checkpointNumber: CheckpointNumber; timeOfNextL1Slot: bigint }> {
754
- const latestBlock = await this.client.getBlock();
755
- const timeOfNextL1Slot = latestBlock.timestamp + BigInt(slotDuration);
793
+ const timeOfNextL1Slot = timestamp;
756
794
  const who = typeof account === 'string' ? account : account.address;
757
795
 
758
796
  try {
@@ -852,6 +890,16 @@ export class RollupContract {
852
890
  return this.rollup.read.getManaMinFeeAt([timestamp, inFeeAsset]);
853
891
  }
854
892
 
893
+ async getManaMinFeeComponentsAt(timestamp: bigint, inFeeAsset: boolean): Promise<ManaMinFeeComponents> {
894
+ const result = await this.rollup.read.getManaMinFeeComponentsAt([timestamp, inFeeAsset]);
895
+ return {
896
+ sequencerCost: result.sequencerCost,
897
+ proverCost: result.proverCost,
898
+ congestionCost: result.congestionCost,
899
+ congestionMultiplier: result.congestionMultiplier,
900
+ };
901
+ }
902
+
855
903
  async getSlotAt(timestamp: bigint): Promise<SlotNumber> {
856
904
  return SlotNumber.fromBigInt(await this.rollup.read.getSlotAt([timestamp]));
857
905
  }
@@ -895,11 +943,10 @@ export class RollupContract {
895
943
  return this.rollup.read.getSpecificProverRewardsForEpoch([epoch, prover]);
896
944
  }
897
945
 
898
- async getAttesters(): Promise<EthAddress[]> {
946
+ async getAttesters(timestamp?: bigint): Promise<EthAddress[]> {
899
947
  const attesterSize = await this.getActiveAttesterCount();
900
948
  const gse = new GSEContract(this.client, await this.getGSE());
901
- const ts = (await this.client.getBlock()).timestamp;
902
-
949
+ const ts = timestamp ?? (await this.client.getBlock()).timestamp;
903
950
  const indices = Array.from({ length: attesterSize }, (_, i) => BigInt(i));
904
951
  const chunks = chunk(indices, 1000);
905
952
 
@@ -4,7 +4,7 @@
4
4
  /** Default L1 contracts configuration values from network-defaults.yml */
5
5
  export const l1ContractsDefaultEnv = {
6
6
  ETHEREUM_SLOT_DURATION: 12,
7
- AZTEC_SLOT_DURATION: 36,
7
+ AZTEC_SLOT_DURATION: 72,
8
8
  AZTEC_EPOCH_DURATION: 32,
9
9
  AZTEC_TARGET_COMMITTEE_SIZE: 48,
10
10
  AZTEC_LAG_IN_EPOCHS_FOR_VALIDATOR_SET: 2,
package/src/l1_reader.ts CHANGED
@@ -1,4 +1,9 @@
1
- import { type ConfigMappingsType, getConfigFromMappings, numberConfigHelper } from '@aztec/foundation/config';
1
+ import {
2
+ type ConfigMappingsType,
3
+ getConfigFromMappings,
4
+ numberConfigHelper,
5
+ optionalNumberConfigHelper,
6
+ } from '@aztec/foundation/config';
2
7
 
3
8
  import { type L1ContractAddresses, l1ContractAddressesMapping } from './l1_contract_addresses.js';
4
9
 
@@ -14,6 +19,8 @@ export interface L1ReaderConfig {
14
19
  l1Contracts: L1ContractAddresses;
15
20
  /** The polling interval viem uses in ms */
16
21
  viemPollingIntervalMS: number;
22
+ /** Timeout for HTTP requests to the L1 RPC node in ms. */
23
+ l1HttpTimeoutMS?: number;
17
24
  }
18
25
 
19
26
  export const l1ReaderConfigMappings: ConfigMappingsType<L1ReaderConfig> = {
@@ -43,6 +50,11 @@ export const l1ReaderConfigMappings: ConfigMappingsType<L1ReaderConfig> = {
43
50
  description: 'The polling interval viem uses in ms',
44
51
  ...numberConfigHelper(1_000),
45
52
  },
53
+ l1HttpTimeoutMS: {
54
+ env: 'ETHEREUM_HTTP_TIMEOUT_MS',
55
+ description: 'Timeout for HTTP requests to the L1 RPC node in ms.',
56
+ ...optionalNumberConfigHelper(),
57
+ },
46
58
  };
47
59
 
48
60
  export function getL1ReaderConfigFromEnv(): L1ReaderConfig {
@@ -4,6 +4,7 @@ import { merge, pick } from '@aztec/foundation/collection';
4
4
  import { InterruptError, TimeoutError } from '@aztec/foundation/error';
5
5
  import { EthAddress } from '@aztec/foundation/eth-address';
6
6
  import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
7
+ import { Semaphore } from '@aztec/foundation/queue';
7
8
  import { retryUntil } from '@aztec/foundation/retry';
8
9
  import { sleep } from '@aztec/foundation/sleep';
9
10
  import { DateProvider } from '@aztec/foundation/timer';
@@ -14,16 +15,13 @@ import {
14
15
  type Abi,
15
16
  type BlockOverrides,
16
17
  type Hex,
17
- type NonceManager,
18
18
  type PrepareTransactionRequestRequest,
19
19
  type StateOverride,
20
20
  type TransactionReceipt,
21
21
  type TransactionSerializable,
22
- createNonceManager,
23
22
  formatGwei,
24
23
  serializeTransaction,
25
24
  } from 'viem';
26
- import { jsonRpc } from 'viem/nonce';
27
25
 
28
26
  import type { ViemClient } from '../types.js';
29
27
  import { formatViemError } from '../utils.js';
@@ -47,8 +45,11 @@ import {
47
45
  const MAX_L1_TX_STATES = 32;
48
46
 
49
47
  export class L1TxUtils extends ReadOnlyL1TxUtils {
50
- protected nonceManager: NonceManager;
51
48
  protected txs: L1TxState[] = [];
49
+ /** Last nonce successfully sent to the chain. Used as a lower bound when a fallback RPC node returns a stale count. */
50
+ private lastSentNonce: number | undefined;
51
+ /** Mutex to prevent concurrent sendTransaction calls from racing on the same nonce. */
52
+ private readonly sendMutex = new Semaphore(1);
52
53
  /** Tx delayer for testing. Only set when enableDelayer config is true. */
53
54
  public delayer?: Delayer;
54
55
  /** KZG instance for blob operations. */
@@ -68,7 +69,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
68
69
  delayer?: Delayer,
69
70
  ) {
70
71
  super(client, logger, dateProvider, config, debugMaxGasLimit);
71
- this.nonceManager = createNonceManager({ source: jsonRpc() });
72
72
  this.kzg = kzg;
73
73
 
74
74
  // Set up delayer: use provided one or create new
@@ -110,6 +110,11 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
110
110
  this.metrics?.recordMinedTx(l1TxState, new Date(l1Timestamp));
111
111
  } else if (newState === TxUtilsState.NOT_MINED) {
112
112
  this.metrics?.recordDroppedTx(l1TxState);
113
+ // The tx was dropped: the chain nonce reverted to l1TxState.nonce, so our lower bound is
114
+ // no longer valid. Clear it so the next send fetches the real nonce from the chain.
115
+ if (this.lastSentNonce === l1TxState.nonce) {
116
+ this.lastSentNonce = undefined;
117
+ }
113
118
  }
114
119
 
115
120
  // Update state in the store
@@ -244,9 +249,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
244
249
  throw new InterruptError(`Transaction sending is interrupted`);
245
250
  }
246
251
 
247
- // Check timeout before consuming nonce to avoid leaking a nonce that was never sent.
248
- // A leaked nonce creates a gap (e.g. nonce 107 consumed but unsent), so all subsequent
249
- // transactions (108, 109, ...) can never be mined since the chain expects 107 first.
250
252
  const now = new Date(await this.getL1Timestamp());
251
253
  if (gasConfig.txTimeoutAt && now > gasConfig.txTimeoutAt) {
252
254
  throw new TimeoutError(
@@ -254,18 +256,27 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
254
256
  );
255
257
  }
256
258
 
257
- const nonce = await this.nonceManager.consume({
258
- client: this.client,
259
- address: account,
260
- chainId: this.client.chain.id,
261
- });
262
-
263
- const baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
264
- const txData = this.makeTxData(baseState, { isCancelTx: false });
259
+ let txHash: Hex;
260
+ let nonce: number;
261
+ let baseState: Pick<L1TxState, 'request' | 'gasLimit' | 'blobInputs' | 'gasPrice' | 'nonce'>;
265
262
 
266
- // Send the new tx
267
- const signedRequest = await this.prepareSignedTransaction(txData);
268
- const txHash = await this.client.sendRawTransaction({ serializedTransaction: signedRequest });
263
+ await this.sendMutex.acquire();
264
+ try {
265
+ const chainNonce = await this.client.getTransactionCount({ address: account, blockTag: 'pending' });
266
+ // If a fallback RPC node returns a stale count (lower than what we last sent), use our
267
+ // local lower bound to avoid sending a duplicate of an already-pending transaction.
268
+ nonce =
269
+ this.lastSentNonce !== undefined && chainNonce <= this.lastSentNonce ? this.lastSentNonce + 1 : chainNonce;
270
+
271
+ baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
272
+ const txData = this.makeTxData(baseState, { isCancelTx: false });
273
+
274
+ const signedRequest = await this.prepareSignedTransaction(txData);
275
+ txHash = await this.client.sendRawTransaction({ serializedTransaction: signedRequest });
276
+ this.lastSentNonce = nonce;
277
+ } finally {
278
+ this.sendMutex.release();
279
+ }
269
280
 
270
281
  // Create the new state for monitoring
271
282
  const l1TxState: L1TxState = {
@@ -449,7 +460,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
449
460
  { nonce, account, pendingNonce, timePassed },
450
461
  );
451
462
  await this.updateState(state, TxUtilsState.NOT_MINED);
452
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
453
463
  throw new DroppedTransactionError(nonce, account);
454
464
  }
455
465
 
@@ -541,12 +551,7 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
541
551
 
542
552
  // Oh no, the transaction has timed out!
543
553
  if (isCancelTx || !gasConfig.cancelTxOnTimeout) {
544
- // If this was already a cancellation tx, or we are configured to not cancel txs, we just mark it as NOT_MINED
545
- // and reset the nonce manager, so the next tx that comes along can reuse the nonce if/when this tx gets dropped.
546
- // This is the nastiest scenario for us, since the new tx could acquire the next nonce, but then this tx is dropped,
547
- // and the new tx would never get mined. Eventually, the new tx would also drop.
548
554
  await this.updateState(state, TxUtilsState.NOT_MINED);
549
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
550
555
  } else {
551
556
  // Otherwise we fire the cancellation without awaiting to avoid blocking the caller,
552
557
  // and monitor it in the background so we can speed it up as needed.
@@ -685,7 +690,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
685
690
  { nonce, account },
686
691
  );
687
692
  await this.updateState(state, TxUtilsState.NOT_MINED);
688
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
689
693
  return;
690
694
  }
691
695
 
@@ -697,7 +701,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
697
701
  { nonce, account, currentNonce },
698
702
  );
699
703
  await this.updateState(state, TxUtilsState.NOT_MINED);
700
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
701
704
  return;
702
705
  }
703
706
 
@@ -130,9 +130,10 @@ export class ReadOnlyL1TxUtils {
130
130
  const numBlocks = Math.ceil(gasConfig.stallTimeMs! / BLOCK_TIME_MS);
131
131
  for (let i = 0; i < numBlocks; i++) {
132
132
  // each block can go up 12.5% from previous baseFee
133
- maxFeePerGas = (maxFeePerGas * (1_000n + 125n)) / 1_000n;
133
+ // ceil, (a+b-1)/b, to avoid truncation at small values (e.g. 1 wei blob base fee)
134
+ maxFeePerGas = (maxFeePerGas * (1_000n + 125n) + 999n) / 1_000n;
134
135
  // same for blob gas fee
135
- maxFeePerBlobGas = (maxFeePerBlobGas * (1_000n + 125n)) / 1_000n;
136
+ maxFeePerBlobGas = (maxFeePerBlobGas * (1_000n + 125n) + 999n) / 1_000n;
136
137
  }
137
138
 
138
139
  if (attempt > 0) {
@@ -242,13 +243,16 @@ export class ReadOnlyL1TxUtils {
242
243
  const gasConfig = { ...this.config, ..._gasConfig };
243
244
  let initialEstimate = 0n;
244
245
  if (_blobInputs) {
245
- // @note requests with blobs also require maxFeePerBlobGas to be set
246
+ // @note requests with blobs also require maxFeePerBlobGas to be set.
247
+ // Use 2x buffer for maxFeePerBlobGas to avoid stale fees and to pass EIP-4844 validation (even if it is a gas estimation call).
248
+ // 1. maxFeePerBlobGas >= blobBaseFee
249
+ // 2. account balance >= gas * maxFeePerGas + maxFeePerBlobGas * blobCount + value
246
250
  const gasPrice = await this.getGasPrice(gasConfig, true, 0);
247
251
  initialEstimate = await this.client.estimateGas({
248
252
  account,
249
253
  ...request,
250
254
  ..._blobInputs,
251
- maxFeePerBlobGas: gasPrice.maxFeePerBlobGas!,
255
+ maxFeePerBlobGas: gasPrice.maxFeePerBlobGas! * 2n,
252
256
  gas: MAX_L1_TX_LIMIT,
253
257
  blockTag: 'latest',
254
258
  });
@@ -1,6 +1,8 @@
1
1
  import { pick } from '@aztec/foundation/collection';
2
2
  import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
3
+ import { RunningPromise } from '@aztec/foundation/running-promise';
3
4
 
5
+ import { Multicall3 } from './contracts/multicall.js';
4
6
  import { L1TxUtils, TxUtilsState } from './l1_tx_utils/index.js';
5
7
 
6
8
  // Defines the order in which we prioritise publishers based on their state (first is better)
@@ -27,24 +29,72 @@ const busyStates: TxUtilsState[] = [
27
29
 
28
30
  export type PublisherFilter<UtilsType extends L1TxUtils> = (utils: UtilsType) => boolean;
29
31
 
32
+ /** Config accepted by PublisherManager. */
33
+ type PublisherManagerConfig = {
34
+ publisherAllowInvalidStates?: boolean;
35
+ publisherFundingThreshold?: bigint;
36
+ publisherFundingAmount?: bigint;
37
+ };
38
+
30
39
  export class PublisherManager<UtilsType extends L1TxUtils = L1TxUtils> {
31
40
  private log: Logger;
32
- private config: { publisherAllowInvalidStates?: boolean };
41
+ private config: PublisherManagerConfig;
42
+ private static readonly FUNDING_CHECK_INTERVAL_MS = 2 * 60 * 1000;
43
+ private funder?: UtilsType;
44
+ private fundingPromise?: RunningPromise;
33
45
 
34
46
  constructor(
35
47
  private publishers: UtilsType[],
36
- config: { publisherAllowInvalidStates?: boolean },
37
- bindings?: LoggerBindings,
48
+ config: PublisherManagerConfig,
49
+ opts?: { bindings?: LoggerBindings; funder?: UtilsType },
38
50
  ) {
39
- this.log = createLogger('publisher:manager', bindings);
51
+ this.funder = opts?.funder;
52
+ this.log = createLogger('publisher:manager', opts?.bindings);
40
53
  this.log.info(`PublisherManager initialized with ${publishers.length} publishers.`);
41
54
  this.publishers = publishers;
42
- this.config = pick(config, 'publisherAllowInvalidStates');
55
+ this.config = pick(config, 'publisherAllowInvalidStates', 'publisherFundingThreshold', 'publisherFundingAmount');
56
+
57
+ const hasThreshold = this.config.publisherFundingThreshold !== undefined;
58
+ const hasAmount = this.config.publisherFundingAmount !== undefined;
59
+ if (hasThreshold !== hasAmount) {
60
+ this.log.warn(`Incomplete funding config: both publisherFundingThreshold and publisherFundingAmount must be set`);
61
+ }
62
+
63
+ if (this.funder) {
64
+ const funderAddress = this.funder.getSenderAddress();
65
+ if (publishers.some(p => p.getSenderAddress().equals(funderAddress))) {
66
+ this.log.error(`Funding account ${funderAddress} is also a publisher, disabling funding to avoid self-funding`);
67
+ this.funder = undefined;
68
+ }
69
+ }
43
70
  }
44
71
 
45
- /** Loads the state of all publishers and resumes monitoring any pending txs */
46
- public async loadState(): Promise<void> {
47
- await Promise.all(this.publishers.map(pub => pub.loadStateAndResumeMonitoring()));
72
+ /** Loads the state of all publishers and the funder, and starts periodic funding checks. */
73
+ public async start(): Promise<void> {
74
+ await Promise.all([
75
+ ...this.publishers.map(pub => pub.loadStateAndResumeMonitoring()),
76
+ this.funder?.loadStateAndResumeMonitoring(),
77
+ ]);
78
+
79
+ if (
80
+ this.funder &&
81
+ this.config.publisherFundingThreshold !== undefined &&
82
+ this.config.publisherFundingAmount !== undefined
83
+ ) {
84
+ this.fundingPromise = new RunningPromise(
85
+ () => this.triggerFundingIfNeeded(),
86
+ this.log,
87
+ PublisherManager.FUNDING_CHECK_INTERVAL_MS,
88
+ );
89
+ this.fundingPromise.start();
90
+ }
91
+ }
92
+
93
+ /** Stops the funding loop and interrupts all publishers. */
94
+ public async stop(): Promise<void> {
95
+ await this.fundingPromise?.stop();
96
+ this.publishers.forEach(pub => pub.interrupt());
97
+ this.funder?.interrupt();
48
98
  }
49
99
 
50
100
  // Finds and prioritises available publishers based on
@@ -102,7 +152,52 @@ export class PublisherManager<UtilsType extends L1TxUtils = L1TxUtils> {
102
152
  return sortedPublishers[0].publisher;
103
153
  }
104
154
 
105
- public interrupt() {
106
- this.publishers.forEach(pub => pub.interrupt());
155
+ /** Check all publisher balances and fund those below threshold. */
156
+ private async triggerFundingIfNeeded(): Promise<void> {
157
+ const { funder, config } = this;
158
+ if (!funder || config.publisherFundingThreshold === undefined || config.publisherFundingAmount === undefined) {
159
+ return;
160
+ }
161
+
162
+ const allBalances = await Promise.all(
163
+ this.publishers.map(async pub => ({ balance: await pub.getSenderBalance(), publisher: pub })),
164
+ );
165
+ const lowBalance = allBalances.filter(p => p.balance < config.publisherFundingThreshold!);
166
+ if (lowBalance.length === 0) {
167
+ return;
168
+ }
169
+
170
+ const fundingAmount = config.publisherFundingAmount!;
171
+ const funderBalance = await funder.getSenderBalance();
172
+
173
+ if (funderBalance < 10n * fundingAmount) {
174
+ this.log.warn(`Funding account balance is low`, { funderBalance, threshold: 10n * fundingAmount });
175
+ }
176
+ const affordableCount = Number(funderBalance / fundingAmount);
177
+ if (affordableCount === 0) {
178
+ this.log.error(`Funding account balance too low to fund any publisher`, { funderBalance, fundingAmount });
179
+ return;
180
+ }
181
+ if (affordableCount < lowBalance.length) {
182
+ this.log.warn(`Funder can only afford ${affordableCount}/${lowBalance.length} publishers`, {
183
+ funderBalance,
184
+ fundingAmount,
185
+ });
186
+ }
187
+
188
+ const toFund = lowBalance.slice(0, affordableCount).map(p => p.publisher);
189
+ await this.fundPublishers(toFund);
190
+ }
191
+
192
+ /** Fund publishers via a single Multicall3 aggregate3Value transaction. */
193
+ private async fundPublishers(publishers: UtilsType[]): Promise<void> {
194
+ const fundingAmount = this.config.publisherFundingAmount!;
195
+ const calls = publishers.map(pub => ({
196
+ to: pub.getSenderAddress().toString(),
197
+ value: fundingAmount,
198
+ }));
199
+
200
+ await Multicall3.forwardValue(calls, this.funder!, this.log);
201
+ this.log.info(`Funded ${publishers.length} publishers`);
107
202
  }
108
203
  }
@@ -1,4 +1,4 @@
1
- import type { RollupContract } from '@aztec/ethereum/contracts';
1
+ import type { ManaMinFeeComponents, RollupContract } from '@aztec/ethereum/contracts';
2
2
  import { InboxContract } from '@aztec/ethereum/contracts';
3
3
  import { CheckpointNumber, EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
4
4
  import { EthAddress } from '@aztec/foundation/eth-address';
@@ -10,6 +10,20 @@ import { EventEmitter } from 'events';
10
10
 
11
11
  import type { ViemClient } from '../types.js';
12
12
 
13
+ /** L2 fee data reported by the chain monitor. */
14
+ export type L2FeeData = ManaMinFeeComponents & {
15
+ /** Total minimum fee per mana in Fee Juice (sum of sequencerCost + proverCost + congestionCost). */
16
+ minFeePerMana: bigint;
17
+ /** L1 base fee observed by the oracle. */
18
+ l1BaseFee: bigint;
19
+ /** L1 blob fee observed by the oracle. */
20
+ l1BlobFee: bigint;
21
+ /** ETH per fee asset exchange rate (1e12 precision). */
22
+ ethPerFeeAsset: bigint;
23
+ /** Mana target per checkpoint. */
24
+ manaTarget: bigint;
25
+ };
26
+
13
27
  export type ChainMonitorEventMap = {
14
28
  'l1-block': [{ l1BlockNumber: number; timestamp: bigint }];
15
29
  checkpoint: [
@@ -19,6 +33,7 @@ export type ChainMonitorEventMap = {
19
33
  'l2-messages': [{ totalL2Messages: number; l1BlockNumber: number }];
20
34
  'l2-epoch': [{ l2EpochNumber: EpochNumber; timestamp: bigint; committee: EthAddress[] | undefined }];
21
35
  'l2-slot': [{ l2SlotNumber: SlotNumber; timestamp: bigint }];
36
+ 'l2-fees': [L2FeeData];
22
37
  };
23
38
 
24
39
  /** Utility class that polls the chain on quick intervals and logs new L1 blocks, L2 blocks, and L2 proofs. */
@@ -45,6 +60,8 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
45
60
  public l2EpochNumber!: EpochNumber;
46
61
  /** Current L2 slot number */
47
62
  public l2SlotNumber!: SlotNumber;
63
+ /** Current L2 fee data (components of the minimum fee per mana). */
64
+ public l2FeeData!: L2FeeData;
48
65
 
49
66
  constructor(
50
67
  private readonly rollup: RollupContract,
@@ -77,7 +94,7 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
77
94
  }
78
95
  }
79
96
 
80
- private async getInbox() {
97
+ protected async getInbox() {
81
98
  if (!this.inbox) {
82
99
  const { inboxAddress } = await this.rollup.getRollupAddresses();
83
100
  this.inbox = new InboxContract(this.l1Client, inboxAddress);
@@ -158,7 +175,7 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
158
175
  this.l2EpochNumber = l2Epoch;
159
176
  committee = await this.rollup.getCurrentEpochCommittee();
160
177
  this.emit('l2-epoch', { l2EpochNumber: l2Epoch, timestamp, committee });
161
- msg += ` starting new epoch ${this.l2EpochNumber} `;
178
+ msg += ` starting new epoch ${this.l2EpochNumber}`;
162
179
  }
163
180
 
164
181
  if (l2SlotNumber !== this.l2SlotNumber) {
@@ -166,6 +183,13 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
166
183
  this.emit('l2-slot', { l2SlotNumber, timestamp });
167
184
  }
168
185
 
186
+ const feeData = await this.fetchFeeData(timestamp);
187
+ if (this.hasFeeDataChanged(feeData)) {
188
+ msg += ` with L2 min fee ${feeData.minFeePerMana}`;
189
+ this.l2FeeData = feeData;
190
+ this.emit('l2-fees', feeData);
191
+ }
192
+
169
193
  this.logger.info(msg, {
170
194
  currentTimestamp: this.dateProvider.nowInSeconds(),
171
195
  l1Timestamp: timestamp,
@@ -176,6 +200,7 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
176
200
  provenCheckpointNumber: this.provenCheckpointNumber,
177
201
  totalL2Messages: this.totalL2Messages,
178
202
  committee,
203
+ ...this.l2FeeData,
179
204
  });
180
205
 
181
206
  return this;
@@ -242,4 +267,36 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
242
267
  this.on('checkpoint', listener);
243
268
  });
244
269
  }
270
+
271
+ private async fetchFeeData(timestamp: bigint): Promise<L2FeeData> {
272
+ const [components, minFeePerMana, l1Fees, ethPerFeeAsset, manaTarget] = await Promise.all([
273
+ this.rollup.getManaMinFeeComponentsAt(timestamp, true),
274
+ this.rollup.getManaMinFeeAt(timestamp, true),
275
+ this.rollup.getL1FeesAt(timestamp),
276
+ this.rollup.getEthPerFeeAsset(),
277
+ this.rollup.getManaTarget(),
278
+ ]);
279
+ return {
280
+ ...components,
281
+ minFeePerMana,
282
+ l1BaseFee: l1Fees.baseFee,
283
+ l1BlobFee: l1Fees.blobFee,
284
+ ethPerFeeAsset,
285
+ manaTarget,
286
+ };
287
+ }
288
+
289
+ private hasFeeDataChanged(newData: L2FeeData): boolean {
290
+ if (!this.l2FeeData) {
291
+ return true;
292
+ }
293
+ return (
294
+ this.l2FeeData.sequencerCost !== newData.sequencerCost ||
295
+ this.l2FeeData.proverCost !== newData.proverCost ||
296
+ this.l2FeeData.congestionCost !== newData.congestionCost ||
297
+ this.l2FeeData.l1BaseFee !== newData.l1BaseFee ||
298
+ this.l2FeeData.l1BlobFee !== newData.l1BlobFee ||
299
+ this.l2FeeData.ethPerFeeAsset !== newData.ethPerFeeAsset
300
+ );
301
+ }
245
302
  }
@@ -85,10 +85,12 @@ export class EthCheatCodes {
85
85
  }
86
86
 
87
87
  /**
88
- * Get the current timestamp
89
- * @returns The current timestamp
88
+ * Get the timestamp of the latest mined L1 block.
89
+ * Note: this is NOT the current time — it's the discrete timestamp of the last block.
90
+ * Between blocks, the actual chain time advances but no new block reflects it.
91
+ * @returns The latest block timestamp in seconds
90
92
  */
91
- public async timestamp(): Promise<number> {
93
+ public async lastBlockTimestamp(): Promise<number> {
92
94
  const res = await this.doRpcCall('eth_getBlockByNumber', ['latest', true]);
93
95
  return parseInt(res.timestamp, 16);
94
96
  }
@@ -552,7 +554,7 @@ export class EthCheatCodes {
552
554
  }
553
555
 
554
556
  public async syncDateProvider() {
555
- const timestamp = await this.timestamp();
557
+ const timestamp = await this.lastBlockTimestamp();
556
558
  if ('setTime' in this.dateProvider) {
557
559
  this.dateProvider.setTime(timestamp * 1000);
558
560
  }