@aztec/ethereum 0.0.1-commit.e2b2873ed → 0.0.1-commit.e304674f1

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 (142) 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 +8 -6
  5. package/dest/config.d.ts.map +1 -1
  6. package/dest/config.js +14 -10
  7. package/dest/contracts/empire_base.d.ts +3 -1
  8. package/dest/contracts/empire_base.d.ts.map +1 -1
  9. package/dest/contracts/fee_asset_price_oracle.d.ts +101 -0
  10. package/dest/contracts/fee_asset_price_oracle.d.ts.map +1 -0
  11. package/dest/contracts/fee_asset_price_oracle.js +651 -0
  12. package/dest/contracts/governance.js +3 -3
  13. package/dest/contracts/governance_proposer.d.ts +3 -1
  14. package/dest/contracts/governance_proposer.d.ts.map +1 -1
  15. package/dest/contracts/governance_proposer.js +9 -0
  16. package/dest/contracts/inbox.d.ts +3 -3
  17. package/dest/contracts/inbox.d.ts.map +1 -1
  18. package/dest/contracts/inbox.js +5 -6
  19. package/dest/contracts/index.d.ts +3 -3
  20. package/dest/contracts/index.d.ts.map +1 -1
  21. package/dest/contracts/index.js +2 -2
  22. package/dest/contracts/multicall.d.ts +51 -2
  23. package/dest/contracts/multicall.d.ts.map +1 -1
  24. package/dest/contracts/multicall.js +85 -0
  25. package/dest/contracts/registry.d.ts +3 -1
  26. package/dest/contracts/registry.d.ts.map +1 -1
  27. package/dest/contracts/registry.js +30 -1
  28. package/dest/contracts/rollup.d.ts +48 -18
  29. package/dest/contracts/rollup.d.ts.map +1 -1
  30. package/dest/contracts/rollup.js +213 -52
  31. package/dest/contracts/{tally_slashing_proposer.d.ts → slashing_proposer.d.ts} +3 -4
  32. package/dest/contracts/slashing_proposer.d.ts.map +1 -0
  33. package/dest/contracts/{tally_slashing_proposer.js → slashing_proposer.js} +13 -15
  34. package/dest/deploy_aztec_l1_contracts.d.ts +4 -8
  35. package/dest/deploy_aztec_l1_contracts.d.ts.map +1 -1
  36. package/dest/deploy_aztec_l1_contracts.js +35 -23
  37. package/dest/deploy_l1_contract.js +3 -3
  38. package/dest/generated/l1-contracts-defaults.d.ts +2 -2
  39. package/dest/generated/l1-contracts-defaults.js +2 -2
  40. package/dest/l1_artifacts.d.ts +9214 -15208
  41. package/dest/l1_artifacts.d.ts.map +1 -1
  42. package/dest/l1_artifacts.js +9 -24
  43. package/dest/l1_contract_addresses.d.ts +1 -5
  44. package/dest/l1_contract_addresses.d.ts.map +1 -1
  45. package/dest/l1_contract_addresses.js +0 -6
  46. package/dest/l1_reader.d.ts +3 -1
  47. package/dest/l1_reader.d.ts.map +1 -1
  48. package/dest/l1_reader.js +6 -1
  49. package/dest/l1_tx_utils/config.d.ts +7 -1
  50. package/dest/l1_tx_utils/config.d.ts.map +1 -1
  51. package/dest/l1_tx_utils/config.js +14 -1
  52. package/dest/l1_tx_utils/factory.d.ts +18 -10
  53. package/dest/l1_tx_utils/factory.d.ts.map +1 -1
  54. package/dest/l1_tx_utils/factory.js +17 -7
  55. package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts +15 -15
  56. package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts.map +1 -1
  57. package/dest/l1_tx_utils/forwarder_l1_tx_utils.js +9 -15
  58. package/dest/l1_tx_utils/index-blobs.d.ts +3 -3
  59. package/dest/l1_tx_utils/index-blobs.d.ts.map +1 -1
  60. package/dest/l1_tx_utils/index-blobs.js +2 -2
  61. package/dest/l1_tx_utils/index.d.ts +2 -1
  62. package/dest/l1_tx_utils/index.d.ts.map +1 -1
  63. package/dest/l1_tx_utils/index.js +1 -0
  64. package/dest/l1_tx_utils/l1_tx_utils.d.ts +20 -7
  65. package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
  66. package/dest/l1_tx_utils/l1_tx_utils.js +75 -51
  67. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts +1 -1
  68. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts.map +1 -1
  69. package/dest/l1_tx_utils/readonly_l1_tx_utils.js +8 -4
  70. package/dest/l1_tx_utils/tx_delayer.d.ts +56 -0
  71. package/dest/l1_tx_utils/tx_delayer.d.ts.map +1 -0
  72. package/dest/{test → l1_tx_utils}/tx_delayer.js +62 -34
  73. package/dest/publisher_manager.d.ts +21 -7
  74. package/dest/publisher_manager.d.ts.map +1 -1
  75. package/dest/publisher_manager.js +81 -7
  76. package/dest/queries.js +3 -3
  77. package/dest/test/chain_monitor.d.ts +22 -3
  78. package/dest/test/chain_monitor.d.ts.map +1 -1
  79. package/dest/test/chain_monitor.js +33 -2
  80. package/dest/test/eth_cheat_codes.d.ts +6 -4
  81. package/dest/test/eth_cheat_codes.d.ts.map +1 -1
  82. package/dest/test/eth_cheat_codes.js +6 -4
  83. package/dest/test/index.d.ts +1 -3
  84. package/dest/test/index.d.ts.map +1 -1
  85. package/dest/test/index.js +0 -2
  86. package/dest/test/start_anvil.d.ts +23 -3
  87. package/dest/test/start_anvil.d.ts.map +1 -1
  88. package/dest/test/start_anvil.js +143 -29
  89. package/dest/test/upgrade_utils.js +2 -2
  90. package/dest/utils.d.ts +1 -1
  91. package/dest/utils.d.ts.map +1 -1
  92. package/dest/utils.js +16 -12
  93. package/package.json +5 -7
  94. package/src/client.ts +10 -2
  95. package/src/config.ts +23 -14
  96. package/src/contracts/empire_base.ts +2 -0
  97. package/src/contracts/fee_asset_price_oracle.ts +280 -0
  98. package/src/contracts/governance.ts +3 -3
  99. package/src/contracts/governance_proposer.ts +6 -0
  100. package/src/contracts/inbox.ts +4 -4
  101. package/src/contracts/index.ts +2 -2
  102. package/src/contracts/multicall.ts +65 -1
  103. package/src/contracts/registry.ts +31 -1
  104. package/src/contracts/rollup.ts +250 -59
  105. package/src/contracts/{tally_slashing_proposer.ts → slashing_proposer.ts} +14 -16
  106. package/src/deploy_aztec_l1_contracts.ts +57 -34
  107. package/src/deploy_l1_contract.ts +3 -3
  108. package/src/generated/l1-contracts-defaults.ts +2 -2
  109. package/src/l1_artifacts.ts +12 -35
  110. package/src/l1_contract_addresses.ts +0 -7
  111. package/src/l1_reader.ts +13 -1
  112. package/src/l1_tx_utils/config.ts +20 -0
  113. package/src/l1_tx_utils/factory.ts +31 -31
  114. package/src/l1_tx_utils/forwarder_l1_tx_utils.ts +43 -54
  115. package/src/l1_tx_utils/index-blobs.ts +2 -2
  116. package/src/l1_tx_utils/index.ts +1 -0
  117. package/src/l1_tx_utils/l1_tx_utils.ts +68 -30
  118. package/src/l1_tx_utils/readonly_l1_tx_utils.ts +8 -4
  119. package/src/{test → l1_tx_utils}/tx_delayer.ts +78 -50
  120. package/src/publisher_manager.ts +105 -10
  121. package/src/queries.ts +3 -3
  122. package/src/test/chain_monitor.ts +60 -3
  123. package/src/test/eth_cheat_codes.ts +6 -4
  124. package/src/test/index.ts +0 -2
  125. package/src/test/start_anvil.ts +177 -29
  126. package/src/test/upgrade_utils.ts +2 -2
  127. package/src/utils.ts +17 -14
  128. package/dest/contracts/empire_slashing_proposer.d.ts +0 -67
  129. package/dest/contracts/empire_slashing_proposer.d.ts.map +0 -1
  130. package/dest/contracts/empire_slashing_proposer.js +0 -207
  131. package/dest/contracts/tally_slashing_proposer.d.ts.map +0 -1
  132. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts +0 -26
  133. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts.map +0 -1
  134. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.js +0 -26
  135. package/dest/test/delayed_tx_utils.d.ts +0 -13
  136. package/dest/test/delayed_tx_utils.d.ts.map +0 -1
  137. package/dest/test/delayed_tx_utils.js +0 -28
  138. package/dest/test/tx_delayer.d.ts +0 -36
  139. package/dest/test/tx_delayer.d.ts.map +0 -1
  140. package/src/contracts/empire_slashing_proposer.ts +0 -259
  141. package/src/l1_tx_utils/l1_tx_utils_with_blobs.ts +0 -77
  142. package/src/test/delayed_tx_utils.ts +0 -52
@@ -1,8 +1,10 @@
1
+ import type { BlobKzgInstance } from '@aztec/blob-lib/types';
1
2
  import { maxBigint } from '@aztec/foundation/bigint';
2
3
  import { merge, pick } from '@aztec/foundation/collection';
3
4
  import { InterruptError, TimeoutError } from '@aztec/foundation/error';
4
5
  import { EthAddress } from '@aztec/foundation/eth-address';
5
- import { type Logger, createLogger } from '@aztec/foundation/log';
6
+ import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
7
+ import { Semaphore } from '@aztec/foundation/queue';
6
8
  import { retryUntil } from '@aztec/foundation/retry';
7
9
  import { sleep } from '@aztec/foundation/sleep';
8
10
  import { DateProvider } from '@aztec/foundation/timer';
@@ -13,16 +15,13 @@ import {
13
15
  type Abi,
14
16
  type BlockOverrides,
15
17
  type Hex,
16
- type NonceManager,
17
18
  type PrepareTransactionRequestRequest,
18
19
  type StateOverride,
19
20
  type TransactionReceipt,
20
21
  type TransactionSerializable,
21
- createNonceManager,
22
22
  formatGwei,
23
23
  serializeTransaction,
24
24
  } from 'viem';
25
- import { jsonRpc } from 'viem/nonce';
26
25
 
27
26
  import type { ViemClient } from '../types.js';
28
27
  import { formatViemError } from '../utils.js';
@@ -30,6 +29,7 @@ import { type L1TxUtilsConfig, l1TxUtilsConfigMappings } from './config.js';
30
29
  import { MAX_L1_TX_LIMIT } from './constants.js';
31
30
  import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
32
31
  import { ReadOnlyL1TxUtils } from './readonly_l1_tx_utils.js';
32
+ import { Delayer, createDelayer, wrapClientWithDelayer } from './tx_delayer.js';
33
33
  import {
34
34
  DroppedTransactionError,
35
35
  type L1BlobInputs,
@@ -45,8 +45,15 @@ import {
45
45
  const MAX_L1_TX_STATES = 32;
46
46
 
47
47
  export class L1TxUtils extends ReadOnlyL1TxUtils {
48
- protected nonceManager: NonceManager;
49
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);
53
+ /** Tx delayer for testing. Only set when enableDelayer config is true. */
54
+ public delayer?: Delayer;
55
+ /** KZG instance for blob operations. */
56
+ protected kzg?: BlobKzgInstance;
50
57
 
51
58
  constructor(
52
59
  public override client: ViemClient,
@@ -58,9 +65,25 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
58
65
  debugMaxGasLimit: boolean = false,
59
66
  protected store?: IL1TxStore,
60
67
  protected metrics?: IL1TxMetrics,
68
+ kzg?: BlobKzgInstance,
69
+ delayer?: Delayer,
61
70
  ) {
62
71
  super(client, logger, dateProvider, config, debugMaxGasLimit);
63
- this.nonceManager = createNonceManager({ source: jsonRpc() });
72
+ this.kzg = kzg;
73
+
74
+ // Set up delayer: use provided one or create new
75
+ if (config?.enableDelayer && config?.ethereumSlotDuration) {
76
+ this.delayer =
77
+ delayer ?? this.createDelayer({ ethereumSlotDuration: config.ethereumSlotDuration }, logger.getBindings());
78
+ this.client = wrapClientWithDelayer(this.client, this.delayer);
79
+ if (config.txDelayerMaxInclusionTimeIntoSlot !== undefined) {
80
+ this.delayer.setMaxInclusionTimeIntoSlot(config.txDelayerMaxInclusionTimeIntoSlot);
81
+ }
82
+ } else if (delayer) {
83
+ // Delayer provided but enableDelayer not set — just store it without wrapping
84
+ logger.warn('Delayer provided but enableDelayer config is not set; delayer will not be used');
85
+ this.delayer = delayer;
86
+ }
64
87
  }
65
88
 
66
89
  public get state() {
@@ -87,6 +110,11 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
87
110
  this.metrics?.recordMinedTx(l1TxState, new Date(l1Timestamp));
88
111
  } else if (newState === TxUtilsState.NOT_MINED) {
89
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
+ }
90
118
  }
91
119
 
92
120
  // Update state in the store
@@ -221,15 +249,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
221
249
  throw new InterruptError(`Transaction sending is interrupted`);
222
250
  }
223
251
 
224
- const nonce = await this.nonceManager.consume({
225
- client: this.client,
226
- address: account,
227
- chainId: this.client.chain.id,
228
- });
229
-
230
- const baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
231
- const txData = this.makeTxData(baseState, { isCancelTx: false });
232
-
233
252
  const now = new Date(await this.getL1Timestamp());
234
253
  if (gasConfig.txTimeoutAt && now > gasConfig.txTimeoutAt) {
235
254
  throw new TimeoutError(
@@ -237,14 +256,32 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
237
256
  );
238
257
  }
239
258
 
240
- // Send the new tx
241
- const signedRequest = await this.prepareSignedTransaction(txData);
242
- const txHash = await this.client.sendRawTransaction({ serializedTransaction: signedRequest });
259
+ let txHash: Hex;
260
+ let nonce: number;
261
+ let baseState: Pick<L1TxState, 'request' | 'gasLimit' | 'blobInputs' | 'gasPrice' | 'nonce'>;
262
+
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
+ }
243
280
 
244
281
  // Create the new state for monitoring
245
282
  const l1TxState: L1TxState = {
246
283
  ...baseState,
247
- id: (await this.store?.consumeNextStateId(account)) ?? Math.max(...this.txs.map(tx => tx.id), 0),
284
+ id: (await this.store?.consumeNextStateId(account)) ?? Math.max(...this.txs.map(tx => tx.id), -1) + 1,
248
285
  txHashes: [txHash],
249
286
  cancelTxHashes: [],
250
287
  status: TxUtilsState.IDLE,
@@ -423,7 +460,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
423
460
  { nonce, account, pendingNonce, timePassed },
424
461
  );
425
462
  await this.updateState(state, TxUtilsState.NOT_MINED);
426
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
427
463
  throw new DroppedTransactionError(nonce, account);
428
464
  }
429
465
 
@@ -515,12 +551,7 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
515
551
 
516
552
  // Oh no, the transaction has timed out!
517
553
  if (isCancelTx || !gasConfig.cancelTxOnTimeout) {
518
- // If this was already a cancellation tx, or we are configured to not cancel txs, we just mark it as NOT_MINED
519
- // and reset the nonce manager, so the next tx that comes along can reuse the nonce if/when this tx gets dropped.
520
- // This is the nastiest scenario for us, since the new tx could acquire the next nonce, but then this tx is dropped,
521
- // and the new tx would never get mined. Eventually, the new tx would also drop.
522
554
  await this.updateState(state, TxUtilsState.NOT_MINED);
523
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
524
555
  } else {
525
556
  // Otherwise we fire the cancellation without awaiting to avoid blocking the caller,
526
557
  // and monitor it in the background so we can speed it up as needed.
@@ -659,7 +690,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
659
690
  { nonce, account },
660
691
  );
661
692
  await this.updateState(state, TxUtilsState.NOT_MINED);
662
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
663
693
  return;
664
694
  }
665
695
 
@@ -671,7 +701,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
671
701
  { nonce, account, currentNonce },
672
702
  );
673
703
  await this.updateState(state, TxUtilsState.NOT_MINED);
674
- this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
675
704
  return;
676
705
  }
677
706
 
@@ -731,8 +760,17 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
731
760
  return Number(timestamp) * 1000;
732
761
  }
733
762
 
734
- /** Makes empty blob inputs for the cancellation tx. To be overridden in L1TxUtilsWithBlobs. */
735
- protected makeEmptyBlobInputs(_maxFeePerBlobGas: bigint): Required<L1BlobInputs> {
736
- throw new Error('Cannot make empty blob inputs for cancellation');
763
+ /** Makes empty blob inputs for the cancellation tx. */
764
+ protected makeEmptyBlobInputs(maxFeePerBlobGas: bigint): Required<L1BlobInputs> {
765
+ if (!this.kzg) {
766
+ throw new Error('Cannot make empty blob inputs for cancellation without kzg');
767
+ }
768
+ const blobData = new Uint8Array(131072).fill(0);
769
+ return { blobs: [blobData], kzg: this.kzg, maxFeePerBlobGas };
770
+ }
771
+
772
+ /** Creates a new delayer instance. */
773
+ protected createDelayer(opts: { ethereumSlotDuration: bigint | number }, bindings: LoggerBindings): Delayer {
774
+ return createDelayer(this.dateProvider, opts, bindings);
737
775
  }
738
776
  }
@@ -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,5 +1,5 @@
1
1
  import { omit } from '@aztec/foundation/collection';
2
- import { type Logger, createLogger } from '@aztec/foundation/log';
2
+ import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
3
3
  import { retryUntil } from '@aztec/foundation/retry';
4
4
  import type { DateProvider } from '@aztec/foundation/timer';
5
5
 
@@ -9,14 +9,16 @@ import {
9
9
  type Hex,
10
10
  type PublicClient,
11
11
  type TransactionSerializableEIP4844,
12
+ type TransactionSerialized,
12
13
  keccak256,
13
14
  parseTransaction,
14
15
  publicActions,
16
+ recoverTransactionAddress,
15
17
  serializeTransaction,
16
18
  walletActions,
17
19
  } from 'viem';
18
20
 
19
- import { type ViemClient, isExtendedClient } from '../types.js';
21
+ import type { ExtendedViemWalletClient, ViemClient } from '../types.js';
20
22
 
21
23
  const MAX_WAIT_TIME_SECONDS = 180;
22
24
 
@@ -73,82 +75,98 @@ export function waitUntilL1Timestamp<T extends Client>(
73
75
  );
74
76
  }
75
77
 
76
- export interface Delayer {
77
- /** Returns the hashes of all effectively sent txs. */
78
- getSentTxHashes(): Hex[];
79
- /** Returns the raw hex for all cancelled txs. */
80
- getCancelledTxs(): Hex[];
81
- /** Delays the next tx to be sent so it lands on the given L1 block number. */
82
- pauseNextTxUntilBlock(l1BlockNumber: number | bigint | undefined): void;
83
- /** Delays the next tx to be sent so it lands on the given timestamp. */
84
- pauseNextTxUntilTimestamp(l1Timestamp: number | bigint | undefined): void;
85
- /** Delays the next tx to be sent indefinitely. */
86
- cancelNextTx(): void;
87
- /**
88
- * Sets max inclusion time into slot. If more than this many seconds have passed
89
- * since the last L1 block was mined, then any tx will not be mined in the current
90
- * L1 slot but will be deferred for the next one.
91
- */
92
- setMaxInclusionTimeIntoSlot(seconds: number | bigint | undefined): void;
93
- }
78
+ /** Manages tx delaying for testing, intercepting sendRawTransaction calls to delay or cancel them. */
79
+ export class Delayer {
80
+ private logger: Logger;
81
+
82
+ public maxInclusionTimeIntoSlot: number | undefined = undefined;
83
+ public ethereumSlotDuration: bigint;
84
+ public nextWait: { l1Timestamp: bigint } | { l1BlockNumber: bigint } | { indefinitely: true } | undefined = undefined;
85
+ public sentTxHashes: Hex[] = [];
86
+ public cancelledTxs: Hex[] = [];
94
87
 
95
- class DelayerImpl implements Delayer {
96
- private logger = createLogger('ethereum:tx_delayer');
97
88
  constructor(
98
89
  public dateProvider: DateProvider,
99
90
  opts: { ethereumSlotDuration: bigint | number },
91
+ bindings: LoggerBindings,
100
92
  ) {
101
93
  this.ethereumSlotDuration = BigInt(opts.ethereumSlotDuration);
94
+ this.logger = createLogger('ethereum:tx_delayer', bindings);
102
95
  }
103
96
 
104
- public maxInclusionTimeIntoSlot: number | undefined = undefined;
105
- public ethereumSlotDuration: bigint;
106
- public nextWait: { l1Timestamp: bigint } | { l1BlockNumber: bigint } | { indefinitely: true } | undefined = undefined;
107
- public sentTxHashes: Hex[] = [];
108
- public cancelledTxs: Hex[] = [];
97
+ /** Returns the logger instance used by this delayer. */
98
+ getLogger(): Logger {
99
+ return this.logger;
100
+ }
109
101
 
102
+ /** Returns the hashes of all effectively sent txs. */
110
103
  getSentTxHashes() {
111
104
  return this.sentTxHashes;
112
105
  }
113
106
 
107
+ /** Returns the raw hex for all cancelled txs. */
114
108
  getCancelledTxs(): Hex[] {
115
109
  return this.cancelledTxs;
116
110
  }
117
111
 
112
+ /** Delays the next tx to be sent so it lands on the given L1 block number. */
118
113
  pauseNextTxUntilBlock(l1BlockNumber: number | bigint) {
119
114
  this.nextWait = { l1BlockNumber: BigInt(l1BlockNumber) };
120
115
  }
121
116
 
117
+ /** Delays the next tx to be sent so it lands on the given timestamp. */
122
118
  pauseNextTxUntilTimestamp(l1Timestamp: number | bigint) {
123
119
  this.nextWait = { l1Timestamp: BigInt(l1Timestamp) };
124
120
  }
125
121
 
122
+ /** Delays the next tx to be sent indefinitely. */
126
123
  cancelNextTx() {
127
124
  this.nextWait = { indefinitely: true };
128
125
  }
129
126
 
127
+ /**
128
+ * Sets max inclusion time into slot. If more than this many seconds have passed
129
+ * since the last L1 block was mined, then any tx will not be mined in the current
130
+ * L1 slot but will be deferred for the next one.
131
+ */
130
132
  setMaxInclusionTimeIntoSlot(seconds: number | undefined) {
131
133
  this.maxInclusionTimeIntoSlot = seconds;
132
134
  }
133
135
  }
134
136
 
135
137
  /**
136
- * Returns a new client (without modifying the one passed in) with an injected tx delayer.
137
- * The delayer can be used to hold off the next tx to be sent until a given block number.
138
- * TODO(#10824): This doesn't play along well with blob txs for some reason.
138
+ * Creates a new Delayer instance. Exposed so callers can create a single shared delayer
139
+ * and pass it to multiple `wrapClientWithDelayer` calls.
139
140
  */
140
- export function withDelayer<T extends ViemClient>(
141
- client: T,
141
+ export function createDelayer(
142
142
  dateProvider: DateProvider,
143
143
  opts: { ethereumSlotDuration: bigint | number },
144
- ): { client: T; delayer: Delayer } {
145
- if (!isExtendedClient(client)) {
146
- throw new Error('withDelayer has to be instantiated with a wallet viem client.');
144
+ bindings: LoggerBindings,
145
+ ): Delayer {
146
+ return new Delayer(dateProvider, opts, bindings);
147
+ }
148
+
149
+ /** Tries to recover the sender address from a serialized signed transaction. */
150
+ async function tryRecoverSender(serializedTransaction: Hex): Promise<string | undefined> {
151
+ try {
152
+ return await recoverTransactionAddress({
153
+ serializedTransaction: serializedTransaction as TransactionSerialized,
154
+ });
155
+ } catch {
156
+ return undefined;
147
157
  }
148
- const logger = createLogger('ethereum:tx_delayer');
149
- const delayer = new DelayerImpl(dateProvider, opts);
158
+ }
150
159
 
151
- const extended = client
160
+ /**
161
+ * Wraps a viem client with tx delaying logic. Returns the wrapped client.
162
+ * The delayer intercepts sendRawTransaction calls and delays them based on the delayer's state.
163
+ */
164
+ export function wrapClientWithDelayer<T extends ViemClient>(client: T, delayer: Delayer): T {
165
+ const logger = delayer.getLogger();
166
+
167
+ // Cast to ExtendedViemWalletClient for the extend chain since it has sendRawTransaction.
168
+ // The sendRawTransaction override is applied to all clients regardless of type.
169
+ const withRawTx = (client as unknown as ExtendedViemWalletClient)
152
170
  // Tweak sendRawTransaction so it uses the delay defined in the delayer.
153
171
  // Note that this will only work with local accounts (ie accounts for which we have the private key).
154
172
  // Transactions signed by the node will not be delayed since they use sendTransaction directly,
@@ -160,6 +178,7 @@ export function withDelayer<T extends ViemClient>(
160
178
 
161
179
  const { serializedTransaction } = args[0];
162
180
  const publicClient = client as unknown as PublicClient;
181
+ const sender = await tryRecoverSender(serializedTransaction);
163
182
 
164
183
  if (delayer.nextWait !== undefined) {
165
184
  // Check if we have been instructed to delay the next tx.
@@ -171,7 +190,7 @@ export function withDelayer<T extends ViemClient>(
171
190
 
172
191
  // Cancel tx outright if instructed
173
192
  if ('indefinitely' in waitUntil && waitUntil.indefinitely) {
174
- logger.info(`Cancelling tx ${txHash}`);
193
+ logger.info(`Cancelling tx ${txHash}`, { sender });
175
194
  delayer.cancelledTxs.push(serializedTransaction);
176
195
  return Promise.resolve(txHash);
177
196
  }
@@ -185,6 +204,7 @@ export function withDelayer<T extends ViemClient>(
185
204
  : undefined;
186
205
 
187
206
  logger.info(`Delaying tx ${txHash} until ${inspect(waitUntil)}`, {
207
+ sender,
188
208
  argsLen: args.length,
189
209
  ...omit(parseTransaction(serializedTransaction), 'data', 'sidecars'),
190
210
  });
@@ -196,6 +216,7 @@ export function withDelayer<T extends ViemClient>(
196
216
 
197
217
  txHash = computeTxHash(serializedTransaction);
198
218
  const logData = {
219
+ sender,
199
220
  ...omit(parseTransaction(serializedTransaction), 'data', 'sidecars'),
200
221
  lastBlockTimestamp,
201
222
  now,
@@ -225,28 +246,35 @@ export function withDelayer<T extends ViemClient>(
225
246
  computedTxHash: txHash,
226
247
  });
227
248
  }
228
- logger.info(`Sent previously delayed tx ${clientTxHash}`);
249
+ logger.info(`Sent previously delayed tx ${clientTxHash}`, { sender });
229
250
  delayer.sentTxHashes.push(clientTxHash);
230
251
  })
231
252
  .catch(err => logger.error(`Error sending tx after delay`, err));
232
253
  return Promise.resolve(txHash!);
233
254
  } else {
234
255
  const txHash = await client.sendRawTransaction(...args);
235
- logger.debug(`Sent tx immediately ${txHash}`);
256
+ logger.debug(`Sent tx immediately ${txHash}`, { sender });
236
257
  delayer.sentTxHashes.push(txHash);
237
258
  return txHash;
238
259
  }
239
260
  },
240
- }))
241
- // Re-extend with sendTransaction so it uses the modified sendRawTransaction.
242
- .extend(client => ({ sendTransaction: walletActions(client).sendTransaction }))
243
- // And with the actions that depend on the modified sendTransaction
244
- .extend(client => ({
245
- writeContract: walletActions(client).writeContract,
246
- deployContract: walletActions(client).deployContract,
247
- })) as T;
261
+ }));
262
+
263
+ // Only re-bind wallet actions (sendTransaction, writeContract, deployContract) for wallet clients.
264
+ // This is needed for tests that use wallet actions directly rather than sendRawTransaction.
265
+ const isWalletClient = 'account' in client && client.account !== undefined;
266
+ const extended = isWalletClient
267
+ ? withRawTx
268
+ // Re-extend with sendTransaction so it uses the modified sendRawTransaction.
269
+ .extend(client => ({ sendTransaction: walletActions(client).sendTransaction }))
270
+ // And with the actions that depend on the modified sendTransaction
271
+ .extend(client => ({
272
+ writeContract: walletActions(client).writeContract,
273
+ deployContract: walletActions(client).deployContract,
274
+ }))
275
+ : withRawTx;
248
276
 
249
- return { client: extended, delayer };
277
+ return extended as T;
250
278
  }
251
279
 
252
280
  /**
@@ -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
@@ -76,8 +76,8 @@ export async function getL1ContractsConfig(
76
76
  slasherProposer?.getRoundSize() ?? 0n,
77
77
  slasherProposer?.getLifetimeInRounds() ?? 0n,
78
78
  slasherProposer?.getExecutionDelayInRounds() ?? 0n,
79
- slasherProposer?.type === 'tally' ? slasherProposer.getSlashOffsetInRounds() : 0n,
80
- slasherProposer?.type === 'tally' ? slasherProposer.getSlashingAmounts() : [0n, 0n, 0n],
79
+ slasherProposer?.getSlashOffsetInRounds() ?? 0n,
80
+ slasherProposer?.getSlashingAmounts() ?? [0n, 0n, 0n],
81
81
  slasher?.getVetoer() ?? EthAddress.ZERO,
82
82
  slasher?.getSlashingDisableDuration() ?? 0,
83
83
  rollup.getManaTarget(),
@@ -114,7 +114,7 @@ export async function getL1ContractsConfig(
114
114
  rollupVersion: Number(rollupVersion),
115
115
  genesisArchiveTreeRoot: genesisArchiveTreeRoot.toString(),
116
116
  exitDelaySeconds: Number(exitDelay),
117
- slasherFlavor: slasherProposer?.type ?? 'tally',
117
+ slasherEnabled: !!slasherProposer,
118
118
  slashingOffsetInRounds: Number(slashingOffsetInRounds),
119
119
  slashAmountSmall: slashingAmounts[0],
120
120
  slashAmountMedium: slashingAmounts[1],