@aztec/ethereum 0.0.1-commit.7b97ef96e → 0.0.1-commit.7cbc774

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 (120) hide show
  1. package/dest/client.d.ts +16 -2
  2. package/dest/client.d.ts.map +1 -1
  3. package/dest/client.js +27 -7
  4. package/dest/config.d.ts +8 -6
  5. package/dest/config.d.ts.map +1 -1
  6. package/dest/config.js +11 -9
  7. package/dest/contracts/chain_state_override.d.ts +78 -0
  8. package/dest/contracts/chain_state_override.d.ts.map +1 -0
  9. package/dest/contracts/chain_state_override.js +137 -0
  10. package/dest/contracts/empire_base.d.ts +1 -3
  11. package/dest/contracts/empire_base.d.ts.map +1 -1
  12. package/dest/contracts/fee_asset_price_oracle.d.ts +6 -2
  13. package/dest/contracts/fee_asset_price_oracle.d.ts.map +1 -1
  14. package/dest/contracts/fee_asset_price_oracle.js +11 -6
  15. package/dest/contracts/governance.d.ts +108 -33
  16. package/dest/contracts/governance.d.ts.map +1 -1
  17. package/dest/contracts/governance.js +193 -12
  18. package/dest/contracts/governance_proposer.d.ts +33 -3
  19. package/dest/contracts/governance_proposer.d.ts.map +1 -1
  20. package/dest/contracts/governance_proposer.js +51 -9
  21. package/dest/contracts/inbox.d.ts +3 -3
  22. package/dest/contracts/inbox.d.ts.map +1 -1
  23. package/dest/contracts/inbox.js +12 -7
  24. package/dest/contracts/index.d.ts +3 -3
  25. package/dest/contracts/index.d.ts.map +1 -1
  26. package/dest/contracts/index.js +2 -2
  27. package/dest/contracts/multicall.d.ts +127 -12
  28. package/dest/contracts/multicall.d.ts.map +1 -1
  29. package/dest/contracts/multicall.js +201 -94
  30. package/dest/contracts/outbox.d.ts +21 -4
  31. package/dest/contracts/outbox.d.ts.map +1 -1
  32. package/dest/contracts/outbox.js +29 -6
  33. package/dest/contracts/registry.d.ts +3 -1
  34. package/dest/contracts/registry.d.ts.map +1 -1
  35. package/dest/contracts/registry.js +30 -1
  36. package/dest/contracts/rollup.d.ts +5258 -29
  37. package/dest/contracts/rollup.d.ts.map +1 -1
  38. package/dest/contracts/rollup.js +362 -69
  39. package/dest/contracts/{tally_slashing_proposer.d.ts → slashing_proposer.d.ts} +3 -4
  40. package/dest/contracts/slashing_proposer.d.ts.map +1 -0
  41. package/dest/contracts/{tally_slashing_proposer.js → slashing_proposer.js} +13 -15
  42. package/dest/deploy_aztec_l1_contracts.d.ts +3 -6
  43. package/dest/deploy_aztec_l1_contracts.d.ts.map +1 -1
  44. package/dest/deploy_aztec_l1_contracts.js +2 -4
  45. package/dest/generated/l1-contracts-defaults.d.ts +2 -2
  46. package/dest/generated/l1-contracts-defaults.js +2 -2
  47. package/dest/l1_artifacts.d.ts +13409 -15883
  48. package/dest/l1_artifacts.d.ts.map +1 -1
  49. package/dest/l1_artifacts.js +9 -24
  50. package/dest/l1_contract_addresses.d.ts +61 -65
  51. package/dest/l1_contract_addresses.d.ts.map +1 -1
  52. package/dest/l1_contract_addresses.js +101 -82
  53. package/dest/l1_reader.d.ts +5 -5
  54. package/dest/l1_reader.d.ts.map +1 -1
  55. package/dest/l1_reader.js +9 -7
  56. package/dest/l1_tx_utils/l1_tx_utils.d.ts +12 -3
  57. package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
  58. package/dest/l1_tx_utils/l1_tx_utils.js +61 -60
  59. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts +1 -1
  60. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts.map +1 -1
  61. package/dest/l1_tx_utils/readonly_l1_tx_utils.js +8 -4
  62. package/dest/l1_tx_utils/tx_delayer.d.ts +5 -3
  63. package/dest/l1_tx_utils/tx_delayer.d.ts.map +1 -1
  64. package/dest/l1_tx_utils/tx_delayer.js +7 -5
  65. package/dest/publisher_manager.d.ts +21 -7
  66. package/dest/publisher_manager.d.ts.map +1 -1
  67. package/dest/publisher_manager.js +81 -7
  68. package/dest/queries.d.ts +13 -2
  69. package/dest/queries.d.ts.map +1 -1
  70. package/dest/queries.js +62 -3
  71. package/dest/test/chain_monitor.d.ts +23 -3
  72. package/dest/test/chain_monitor.d.ts.map +1 -1
  73. package/dest/test/chain_monitor.js +38 -2
  74. package/dest/test/eth_cheat_codes.d.ts +12 -4
  75. package/dest/test/eth_cheat_codes.d.ts.map +1 -1
  76. package/dest/test/eth_cheat_codes.js +17 -4
  77. package/dest/test/rollup_cheat_codes.d.ts +31 -3
  78. package/dest/test/rollup_cheat_codes.d.ts.map +1 -1
  79. package/dest/test/rollup_cheat_codes.js +59 -7
  80. package/dest/test/start_anvil.d.ts +23 -3
  81. package/dest/test/start_anvil.d.ts.map +1 -1
  82. package/dest/test/start_anvil.js +143 -29
  83. package/dest/utils.d.ts +8 -1
  84. package/dest/utils.d.ts.map +1 -1
  85. package/dest/utils.js +35 -12
  86. package/package.json +6 -8
  87. package/src/client.ts +28 -2
  88. package/src/config.ts +21 -13
  89. package/src/contracts/chain_state_override.ts +200 -0
  90. package/src/contracts/empire_base.ts +0 -2
  91. package/src/contracts/fee_asset_price_oracle.ts +10 -5
  92. package/src/contracts/governance.ts +266 -9
  93. package/src/contracts/governance_proposer.ts +52 -5
  94. package/src/contracts/inbox.ts +13 -5
  95. package/src/contracts/index.ts +2 -2
  96. package/src/contracts/multicall.ts +243 -105
  97. package/src/contracts/outbox.ts +38 -8
  98. package/src/contracts/registry.ts +31 -1
  99. package/src/contracts/rollup.ts +411 -79
  100. package/src/contracts/{tally_slashing_proposer.ts → slashing_proposer.ts} +14 -16
  101. package/src/deploy_aztec_l1_contracts.ts +1 -5
  102. package/src/generated/l1-contracts-defaults.ts +2 -2
  103. package/src/l1_artifacts.ts +12 -35
  104. package/src/l1_contract_addresses.ts +120 -94
  105. package/src/l1_reader.ts +17 -10
  106. package/src/l1_tx_utils/l1_tx_utils.ts +58 -42
  107. package/src/l1_tx_utils/readonly_l1_tx_utils.ts +8 -4
  108. package/src/l1_tx_utils/tx_delayer.ts +16 -7
  109. package/src/publisher_manager.ts +105 -10
  110. package/src/queries.ts +70 -4
  111. package/src/test/chain_monitor.ts +65 -3
  112. package/src/test/eth_cheat_codes.ts +16 -4
  113. package/src/test/rollup_cheat_codes.ts +64 -6
  114. package/src/test/start_anvil.ts +177 -29
  115. package/src/utils.ts +35 -14
  116. package/dest/contracts/empire_slashing_proposer.d.ts +0 -69
  117. package/dest/contracts/empire_slashing_proposer.d.ts.map +0 -1
  118. package/dest/contracts/empire_slashing_proposer.js +0 -216
  119. package/dest/contracts/tally_slashing_proposer.d.ts.map +0 -1
  120. package/src/contracts/empire_slashing_proposer.ts +0 -265
@@ -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
@@ -126,6 +131,14 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
126
131
  );
127
132
  }
128
133
 
134
+ /**
135
+ * Clears the cached `lastSentNonce` so the next `sendTransaction` call fetches the real
136
+ * nonce from the chain. Call this after an L1 reorg to prevent stale nonce references.
137
+ */
138
+ public resetNonce(): void {
139
+ this.lastSentNonce = undefined;
140
+ }
141
+
129
142
  public getSenderAddress() {
130
143
  return this.address;
131
144
  }
@@ -208,6 +221,19 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
208
221
  return await this.signTransaction(txRequest as TransactionSerializable);
209
222
  }
210
223
 
224
+ private async checkInterruptedOrTimedOut(gasConfig: Pick<L1TxConfig, 'txTimeoutAt'>): Promise<Date> {
225
+ if (this.interrupted) {
226
+ throw new InterruptError(`Transaction sending is interrupted`);
227
+ }
228
+ const now = new Date(await this.getL1Timestamp());
229
+ if (gasConfig.txTimeoutAt && now > gasConfig.txTimeoutAt) {
230
+ throw new TimeoutError(
231
+ `Transaction timed out before sending (now ${now.toISOString()} > timeoutAt ${gasConfig.txTimeoutAt.toISOString()})`,
232
+ );
233
+ }
234
+ return now;
235
+ }
236
+
211
237
  /**
212
238
  * Sends a transaction with gas estimation and pricing
213
239
  * @param request - The transaction request (to, data, value)
@@ -220,14 +246,15 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
220
246
  blobInputs?: L1BlobInputs,
221
247
  stateChange: TxUtilsState = TxUtilsState.SENT,
222
248
  ): Promise<{ txHash: Hex; state: L1TxState }> {
223
- if (this.interrupted) {
224
- throw new InterruptError(`Transaction sending is interrupted`);
225
- }
226
-
227
249
  try {
228
250
  const gasConfig = merge(this.config, gasConfigOverrides);
229
251
  const account = this.getSenderAddress().toString();
230
252
 
253
+ // Fail fast before doing any work (gas estimation, balance check) if we've been interrupted
254
+ // or if the caller's deadline has already passed. The same check is repeated after gas
255
+ // estimation in case it took long enough to push us past the deadline.
256
+ await this.checkInterruptedOrTimedOut(gasConfig);
257
+
231
258
  let gasLimit: bigint;
232
259
  if (this.debugMaxGasLimit) {
233
260
  gasLimit = MAX_L1_TX_LIMIT;
@@ -240,37 +267,34 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
240
267
 
241
268
  const gasPrice = await this.getGasPrice(gasConfig, !!blobInputs);
242
269
 
243
- if (this.interrupted) {
244
- throw new InterruptError(`Transaction sending is interrupted`);
245
- }
246
-
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
- const now = new Date(await this.getL1Timestamp());
251
- if (gasConfig.txTimeoutAt && now > gasConfig.txTimeoutAt) {
252
- throw new TimeoutError(
253
- `Transaction timed out before sending (now ${now.toISOString()} > timeoutAt ${gasConfig.txTimeoutAt.toISOString()})`,
254
- );
255
- }
256
-
257
- const nonce = await this.nonceManager.consume({
258
- client: this.client,
259
- address: account,
260
- chainId: this.client.chain.id,
261
- });
270
+ const now = await this.checkInterruptedOrTimedOut(gasConfig);
262
271
 
263
- const baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
264
- const txData = this.makeTxData(baseState, { isCancelTx: false });
272
+ let txHash: Hex;
273
+ let nonce: number;
274
+ let baseState: Pick<L1TxState, 'request' | 'gasLimit' | 'blobInputs' | 'gasPrice' | 'nonce'>;
265
275
 
266
- // Send the new tx
267
- const signedRequest = await this.prepareSignedTransaction(txData);
268
- const txHash = await this.client.sendRawTransaction({ serializedTransaction: signedRequest });
276
+ await this.sendMutex.acquire();
277
+ try {
278
+ const chainNonce = await this.client.getTransactionCount({ address: account, blockTag: 'pending' });
279
+ // If a fallback RPC node returns a stale count (lower than what we last sent), use our
280
+ // local lower bound to avoid sending a duplicate of an already-pending transaction.
281
+ nonce =
282
+ this.lastSentNonce !== undefined && chainNonce <= this.lastSentNonce ? this.lastSentNonce + 1 : chainNonce;
283
+
284
+ baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
285
+ const txData = this.makeTxData(baseState, { isCancelTx: false });
286
+
287
+ const signedRequest = await this.prepareSignedTransaction(txData);
288
+ txHash = await this.client.sendRawTransaction({ serializedTransaction: signedRequest });
289
+ this.lastSentNonce = nonce;
290
+ } finally {
291
+ this.sendMutex.release();
292
+ }
269
293
 
270
294
  // Create the new state for monitoring
271
295
  const l1TxState: L1TxState = {
272
296
  ...baseState,
273
- id: (await this.store?.consumeNextStateId(account)) ?? Math.max(...this.txs.map(tx => tx.id), 0),
297
+ id: (await this.store?.consumeNextStateId(account)) ?? Math.max(...this.txs.map(tx => tx.id), -1) + 1,
274
298
  txHashes: [txHash],
275
299
  cancelTxHashes: [],
276
300
  status: TxUtilsState.IDLE,
@@ -449,7 +473,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
449
473
  { nonce, account, pendingNonce, timePassed },
450
474
  );
451
475
  await this.updateState(state, TxUtilsState.NOT_MINED);
452
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
453
476
  throw new DroppedTransactionError(nonce, account);
454
477
  }
455
478
 
@@ -541,12 +564,7 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
541
564
 
542
565
  // Oh no, the transaction has timed out!
543
566
  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
567
  await this.updateState(state, TxUtilsState.NOT_MINED);
549
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
550
568
  } else {
551
569
  // Otherwise we fire the cancellation without awaiting to avoid blocking the caller,
552
570
  // and monitor it in the background so we can speed it up as needed.
@@ -685,7 +703,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
685
703
  { nonce, account },
686
704
  );
687
705
  await this.updateState(state, TxUtilsState.NOT_MINED);
688
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
689
706
  return;
690
707
  }
691
708
 
@@ -697,7 +714,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
697
714
  { nonce, account, currentNonce },
698
715
  );
699
716
  await this.updateState(state, TxUtilsState.NOT_MINED);
700
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
701
717
  return;
702
718
  }
703
719
 
@@ -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
  });
@@ -81,7 +81,11 @@ export class Delayer {
81
81
 
82
82
  public maxInclusionTimeIntoSlot: number | undefined = undefined;
83
83
  public ethereumSlotDuration: bigint;
84
- public nextWait: { l1Timestamp: bigint } | { l1BlockNumber: bigint } | { indefinitely: true } | undefined = undefined;
84
+ public nextWait:
85
+ | { l1Timestamp: bigint; timeoutSeconds?: number }
86
+ | { l1BlockNumber: bigint; timeoutSeconds?: number }
87
+ | { indefinitely: true }
88
+ | undefined = undefined;
85
89
  public sentTxHashes: Hex[] = [];
86
90
  public cancelledTxs: Hex[] = [];
87
91
 
@@ -110,13 +114,13 @@ export class Delayer {
110
114
  }
111
115
 
112
116
  /** Delays the next tx to be sent so it lands on the given L1 block number. */
113
- pauseNextTxUntilBlock(l1BlockNumber: number | bigint) {
114
- this.nextWait = { l1BlockNumber: BigInt(l1BlockNumber) };
117
+ pauseNextTxUntilBlock(l1BlockNumber: number | bigint, timeoutSeconds?: number) {
118
+ this.nextWait = { l1BlockNumber: BigInt(l1BlockNumber), timeoutSeconds };
115
119
  }
116
120
 
117
121
  /** Delays the next tx to be sent so it lands on the given timestamp. */
118
- pauseNextTxUntilTimestamp(l1Timestamp: number | bigint) {
119
- this.nextWait = { l1Timestamp: BigInt(l1Timestamp) };
122
+ pauseNextTxUntilTimestamp(l1Timestamp: number | bigint, timeoutSeconds?: number) {
123
+ this.nextWait = { l1Timestamp: BigInt(l1Timestamp), timeoutSeconds };
120
124
  }
121
125
 
122
126
  /** Delays the next tx to be sent indefinitely. */
@@ -198,9 +202,14 @@ export function wrapClientWithDelayer<T extends ViemClient>(client: T, delayer:
198
202
  // Or wait until the desired block number or timestamp
199
203
  wait =
200
204
  'l1BlockNumber' in waitUntil
201
- ? waitUntilBlock(publicClient, waitUntil.l1BlockNumber - 1n, logger)
205
+ ? waitUntilBlock(publicClient, waitUntil.l1BlockNumber - 1n, logger, waitUntil.timeoutSeconds)
202
206
  : 'l1Timestamp' in waitUntil
203
- ? waitUntilL1Timestamp(publicClient, waitUntil.l1Timestamp - delayer.ethereumSlotDuration, logger)
207
+ ? waitUntilL1Timestamp(
208
+ publicClient,
209
+ waitUntil.l1Timestamp - delayer.ethereumSlotDuration,
210
+ logger,
211
+ waitUntil.timeoutSeconds,
212
+ )
204
213
  : undefined;
205
214
 
206
215
  logger.info(`Delaying tx ${txHash} until ${inspect(waitUntil)}`, {
@@ -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
  }
package/src/queries.ts CHANGED
@@ -1,11 +1,77 @@
1
1
  import { EthAddress } from '@aztec/foundation/eth-address';
2
2
 
3
+ import { BaseError, type Block } from 'viem';
4
+
3
5
  import { DefaultL1ContractsConfig, type L1ContractsConfig } from './config.js';
4
6
  import { ReadOnlyGovernanceContract } from './contracts/governance.js';
5
7
  import { GovernanceProposerContract } from './contracts/governance_proposer.js';
6
8
  import { InboxContract } from './contracts/inbox.js';
7
9
  import { RollupContract } from './contracts/rollup.js';
8
- import type { ViemPublicClient } from './types.js';
10
+ import type { ViemClient, ViemPublicClient } from './types.js';
11
+
12
+ /**
13
+ * Returns the L1 finalized block, or `undefined` if the chain does not yet have one
14
+ * (common on freshly started devnets). Rethrows any other RPC error.
15
+ */
16
+ export async function getFinalizedL1Block(client: ViemClient): Promise<Block<bigint, false, 'finalized'> | undefined> {
17
+ try {
18
+ return await client.getBlock({ blockTag: 'finalized', includeTransactions: false });
19
+ } catch (err) {
20
+ if (isFinalizedBlockTagNotFoundError(err)) {
21
+ return undefined;
22
+ }
23
+ throw err;
24
+ }
25
+ }
26
+
27
+ // Error messages returned by popular Ethereum execution clients when
28
+ // eth_getBlockByNumber / eth_call is called with blockTag "finalized" or
29
+ // "safe" and no such block has been produced yet:
30
+ //
31
+ // geth "finalized block not found"
32
+ // "safe block not found"
33
+ // reth "block not found: finalized"
34
+ // "block not found: safe"
35
+ // nethermind "Unknown block error" (same for both tags)
36
+ // besu "Unknown block"
37
+ // erigon 'block "finalized" not available (head block: N)'
38
+ // 'block "safe" not available (head block: N)'
39
+ //
40
+ // A combined regex covers all five:
41
+ const FINALIZED_BLOCK_TAG_NOT_FOUND_MESSAGE_RE =
42
+ /(finalized|safe) block not found|block not found: (finalized|safe)|unknown block|block "(finalized|safe)" not available/i;
43
+
44
+ /**
45
+ * Returns true if the error originates from an RPC call that failed because
46
+ * the "finalized" (or "safe") block tag is not yet available on the chain.
47
+ */
48
+ export function isFinalizedBlockTagNotFoundError(err: unknown): boolean {
49
+ if (!err) {
50
+ return false;
51
+ }
52
+
53
+ if (err instanceof BaseError) {
54
+ const hit = err.walk((e: any) => matchesFinalizedBlockTagNotFound(e));
55
+ if (hit) {
56
+ return true;
57
+ }
58
+ }
59
+
60
+ for (let cur: any = err, i = 0; cur && i < 10; cur = cur.cause, i++) {
61
+ if (matchesFinalizedBlockTagNotFound(cur)) {
62
+ return true;
63
+ }
64
+ }
65
+ return false;
66
+ }
67
+
68
+ function matchesFinalizedBlockTagNotFound(e: any): boolean {
69
+ if (!e) {
70
+ return false;
71
+ }
72
+ const text = `${e.details ?? ''} ${e.message ?? ''} ${e.shortMessage ?? ''}`;
73
+ return FINALIZED_BLOCK_TAG_NOT_FOUND_MESSAGE_RE.test(text);
74
+ }
9
75
 
10
76
  /** Reads the L1ContractsConfig from L1 contracts. */
11
77
  export async function getL1ContractsConfig(
@@ -76,8 +142,8 @@ export async function getL1ContractsConfig(
76
142
  slasherProposer?.getRoundSize() ?? 0n,
77
143
  slasherProposer?.getLifetimeInRounds() ?? 0n,
78
144
  slasherProposer?.getExecutionDelayInRounds() ?? 0n,
79
- slasherProposer?.type === 'tally' ? slasherProposer.getSlashOffsetInRounds() : 0n,
80
- slasherProposer?.type === 'tally' ? slasherProposer.getSlashingAmounts() : [0n, 0n, 0n],
145
+ slasherProposer?.getSlashOffsetInRounds() ?? 0n,
146
+ slasherProposer?.getSlashingAmounts() ?? [0n, 0n, 0n],
81
147
  slasher?.getVetoer() ?? EthAddress.ZERO,
82
148
  slasher?.getSlashingDisableDuration() ?? 0,
83
149
  rollup.getManaTarget(),
@@ -114,7 +180,7 @@ export async function getL1ContractsConfig(
114
180
  rollupVersion: Number(rollupVersion),
115
181
  genesisArchiveTreeRoot: genesisArchiveTreeRoot.toString(),
116
182
  exitDelaySeconds: Number(exitDelay),
117
- slasherFlavor: slasherProposer?.type ?? 'tally',
183
+ slasherEnabled: !!slasherProposer,
118
184
  slashingOffsetInRounds: Number(slashingOffsetInRounds),
119
185
  slashAmountSmall: slashingAmounts[0],
120
186
  slashAmountMedium: slashingAmounts[1],
@@ -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;
@@ -196,6 +221,11 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
196
221
  });
197
222
  }
198
223
 
224
+ public async waitUntilNextL2Slot(): Promise<void> {
225
+ const targetSlot = SlotNumber.add((await this.run()).l2SlotNumber, 1);
226
+ return this.waitUntilL2Slot(targetSlot);
227
+ }
228
+
199
229
  public waitUntilL1Block(block: number | bigint): Promise<void> {
200
230
  const targetBlock = typeof block === 'bigint' ? block.valueOf() : block;
201
231
  if (this.l1BlockNumber >= targetBlock) {
@@ -242,4 +272,36 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
242
272
  this.on('checkpoint', listener);
243
273
  });
244
274
  }
275
+
276
+ private async fetchFeeData(timestamp: bigint): Promise<L2FeeData> {
277
+ const [components, minFeePerMana, l1Fees, ethPerFeeAsset, manaTarget] = await Promise.all([
278
+ this.rollup.getManaMinFeeComponentsAt(timestamp, true),
279
+ this.rollup.getManaMinFeeAt(timestamp, true),
280
+ this.rollup.getL1FeesAt(timestamp),
281
+ this.rollup.getEthPerFeeAsset(),
282
+ this.rollup.getManaTarget(),
283
+ ]);
284
+ return {
285
+ ...components,
286
+ minFeePerMana,
287
+ l1BaseFee: l1Fees.baseFee,
288
+ l1BlobFee: l1Fees.blobFee,
289
+ ethPerFeeAsset,
290
+ manaTarget,
291
+ };
292
+ }
293
+
294
+ private hasFeeDataChanged(newData: L2FeeData): boolean {
295
+ if (!this.l2FeeData) {
296
+ return true;
297
+ }
298
+ return (
299
+ this.l2FeeData.sequencerCost !== newData.sequencerCost ||
300
+ this.l2FeeData.proverCost !== newData.proverCost ||
301
+ this.l2FeeData.congestionCost !== newData.congestionCost ||
302
+ this.l2FeeData.l1BaseFee !== newData.l1BaseFee ||
303
+ this.l2FeeData.l1BlobFee !== newData.l1BlobFee ||
304
+ this.l2FeeData.ethPerFeeAsset !== newData.ethPerFeeAsset
305
+ );
306
+ }
245
307
  }