@aztec/ethereum 0.0.1-commit.e558bd1c → 0.0.1-commit.e57c76e

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 (159) hide show
  1. package/dest/client.d.ts +25 -3
  2. package/dest/client.d.ts.map +1 -1
  3. package/dest/client.js +60 -8
  4. package/dest/config.d.ts +8 -6
  5. package/dest/config.d.ts.map +1 -1
  6. package/dest/config.js +15 -11
  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/fee_asset_price_oracle.d.ts +105 -0
  11. package/dest/contracts/fee_asset_price_oracle.d.ts.map +1 -0
  12. package/dest/contracts/fee_asset_price_oracle.js +656 -0
  13. package/dest/contracts/governance.d.ts +108 -33
  14. package/dest/contracts/governance.d.ts.map +1 -1
  15. package/dest/contracts/governance.js +196 -15
  16. package/dest/contracts/governance_proposer.d.ts +33 -1
  17. package/dest/contracts/governance_proposer.d.ts.map +1 -1
  18. package/dest/contracts/governance_proposer.js +53 -2
  19. package/dest/contracts/inbox.d.ts +3 -3
  20. package/dest/contracts/inbox.d.ts.map +1 -1
  21. package/dest/contracts/inbox.js +12 -7
  22. package/dest/contracts/index.d.ts +4 -3
  23. package/dest/contracts/index.d.ts.map +1 -1
  24. package/dest/contracts/index.js +3 -2
  25. package/dest/contracts/multicall.d.ts +127 -12
  26. package/dest/contracts/multicall.d.ts.map +1 -1
  27. package/dest/contracts/multicall.js +201 -94
  28. package/dest/contracts/outbox.d.ts +27 -4
  29. package/dest/contracts/outbox.d.ts.map +1 -1
  30. package/dest/contracts/outbox.js +34 -7
  31. package/dest/contracts/registry.d.ts +3 -1
  32. package/dest/contracts/registry.d.ts.map +1 -1
  33. package/dest/contracts/registry.js +30 -1
  34. package/dest/contracts/rollup.d.ts +5259 -29
  35. package/dest/contracts/rollup.d.ts.map +1 -1
  36. package/dest/contracts/rollup.js +388 -71
  37. package/dest/contracts/{tally_slashing_proposer.d.ts → slashing_proposer.d.ts} +3 -4
  38. package/dest/contracts/slashing_proposer.d.ts.map +1 -0
  39. package/dest/contracts/{tally_slashing_proposer.js → slashing_proposer.js} +13 -15
  40. package/dest/deploy_aztec_l1_contracts.d.ts +4 -8
  41. package/dest/deploy_aztec_l1_contracts.d.ts.map +1 -1
  42. package/dest/deploy_aztec_l1_contracts.js +35 -23
  43. package/dest/deploy_l1_contract.js +3 -3
  44. package/dest/generated/l1-contracts-defaults.d.ts +2 -2
  45. package/dest/generated/l1-contracts-defaults.js +2 -2
  46. package/dest/l1_artifacts.d.ts +14259 -15724
  47. package/dest/l1_artifacts.d.ts.map +1 -1
  48. package/dest/l1_artifacts.js +9 -24
  49. package/dest/l1_contract_addresses.d.ts +61 -65
  50. package/dest/l1_contract_addresses.d.ts.map +1 -1
  51. package/dest/l1_contract_addresses.js +101 -82
  52. package/dest/l1_reader.d.ts +5 -5
  53. package/dest/l1_reader.d.ts.map +1 -1
  54. package/dest/l1_reader.js +9 -7
  55. package/dest/l1_tx_utils/config.d.ts +7 -1
  56. package/dest/l1_tx_utils/config.d.ts.map +1 -1
  57. package/dest/l1_tx_utils/config.js +14 -1
  58. package/dest/l1_tx_utils/factory.d.ts +18 -10
  59. package/dest/l1_tx_utils/factory.d.ts.map +1 -1
  60. package/dest/l1_tx_utils/factory.js +17 -7
  61. package/dest/l1_tx_utils/fee-strategies/p75_competitive.js +1 -1
  62. package/dest/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.js +1 -1
  63. package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts +15 -15
  64. package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts.map +1 -1
  65. package/dest/l1_tx_utils/forwarder_l1_tx_utils.js +9 -15
  66. package/dest/l1_tx_utils/index-blobs.d.ts +3 -3
  67. package/dest/l1_tx_utils/index-blobs.d.ts.map +1 -1
  68. package/dest/l1_tx_utils/index-blobs.js +2 -2
  69. package/dest/l1_tx_utils/index.d.ts +2 -1
  70. package/dest/l1_tx_utils/index.d.ts.map +1 -1
  71. package/dest/l1_tx_utils/index.js +1 -0
  72. package/dest/l1_tx_utils/l1_tx_utils.d.ts +26 -7
  73. package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
  74. package/dest/l1_tx_utils/l1_tx_utils.js +95 -60
  75. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts +1 -1
  76. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts.map +1 -1
  77. package/dest/l1_tx_utils/readonly_l1_tx_utils.js +10 -5
  78. package/dest/l1_tx_utils/tx_delayer.d.ts +58 -0
  79. package/dest/l1_tx_utils/tx_delayer.d.ts.map +1 -0
  80. package/dest/{test → l1_tx_utils}/tx_delayer.js +67 -37
  81. package/dest/publisher_manager.d.ts +21 -7
  82. package/dest/publisher_manager.d.ts.map +1 -1
  83. package/dest/publisher_manager.js +81 -7
  84. package/dest/queries.d.ts +13 -2
  85. package/dest/queries.d.ts.map +1 -1
  86. package/dest/queries.js +62 -3
  87. package/dest/test/chain_monitor.d.ts +23 -3
  88. package/dest/test/chain_monitor.d.ts.map +1 -1
  89. package/dest/test/chain_monitor.js +38 -2
  90. package/dest/test/eth_cheat_codes.d.ts +12 -4
  91. package/dest/test/eth_cheat_codes.d.ts.map +1 -1
  92. package/dest/test/eth_cheat_codes.js +17 -4
  93. package/dest/test/index.d.ts +1 -3
  94. package/dest/test/index.d.ts.map +1 -1
  95. package/dest/test/index.js +0 -2
  96. package/dest/test/rollup_cheat_codes.d.ts +31 -3
  97. package/dest/test/rollup_cheat_codes.d.ts.map +1 -1
  98. package/dest/test/rollup_cheat_codes.js +59 -7
  99. package/dest/test/start_anvil.d.ts +23 -3
  100. package/dest/test/start_anvil.d.ts.map +1 -1
  101. package/dest/test/start_anvil.js +143 -29
  102. package/dest/test/upgrade_utils.js +2 -2
  103. package/dest/utils.d.ts +9 -2
  104. package/dest/utils.d.ts.map +1 -1
  105. package/dest/utils.js +48 -16
  106. package/package.json +6 -8
  107. package/src/client.ts +66 -2
  108. package/src/config.ts +24 -15
  109. package/src/contracts/chain_state_override.ts +200 -0
  110. package/src/contracts/fee_asset_price_oracle.ts +285 -0
  111. package/src/contracts/governance.ts +269 -12
  112. package/src/contracts/governance_proposer.ts +54 -1
  113. package/src/contracts/inbox.ts +13 -5
  114. package/src/contracts/index.ts +3 -2
  115. package/src/contracts/multicall.ts +243 -105
  116. package/src/contracts/outbox.ts +42 -8
  117. package/src/contracts/registry.ts +31 -1
  118. package/src/contracts/rollup.ts +439 -73
  119. package/src/contracts/{tally_slashing_proposer.ts → slashing_proposer.ts} +14 -16
  120. package/src/deploy_aztec_l1_contracts.ts +57 -34
  121. package/src/deploy_l1_contract.ts +3 -3
  122. package/src/generated/l1-contracts-defaults.ts +2 -2
  123. package/src/l1_artifacts.ts +12 -35
  124. package/src/l1_contract_addresses.ts +120 -94
  125. package/src/l1_reader.ts +17 -10
  126. package/src/l1_tx_utils/config.ts +20 -0
  127. package/src/l1_tx_utils/factory.ts +31 -31
  128. package/src/l1_tx_utils/fee-strategies/p75_competitive.ts +1 -1
  129. package/src/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.ts +1 -1
  130. package/src/l1_tx_utils/forwarder_l1_tx_utils.ts +43 -54
  131. package/src/l1_tx_utils/index-blobs.ts +2 -2
  132. package/src/l1_tx_utils/index.ts +1 -0
  133. package/src/l1_tx_utils/l1_tx_utils.ts +93 -42
  134. package/src/l1_tx_utils/readonly_l1_tx_utils.ts +10 -5
  135. package/src/{test → l1_tx_utils}/tx_delayer.ts +93 -56
  136. package/src/publisher_manager.ts +105 -10
  137. package/src/queries.ts +70 -4
  138. package/src/test/chain_monitor.ts +65 -3
  139. package/src/test/eth_cheat_codes.ts +16 -4
  140. package/src/test/index.ts +0 -2
  141. package/src/test/rollup_cheat_codes.ts +64 -6
  142. package/src/test/start_anvil.ts +177 -29
  143. package/src/test/upgrade_utils.ts +2 -2
  144. package/src/utils.ts +45 -18
  145. package/dest/contracts/empire_slashing_proposer.d.ts +0 -67
  146. package/dest/contracts/empire_slashing_proposer.d.ts.map +0 -1
  147. package/dest/contracts/empire_slashing_proposer.js +0 -207
  148. package/dest/contracts/tally_slashing_proposer.d.ts.map +0 -1
  149. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts +0 -26
  150. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts.map +0 -1
  151. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.js +0 -26
  152. package/dest/test/delayed_tx_utils.d.ts +0 -13
  153. package/dest/test/delayed_tx_utils.d.ts.map +0 -1
  154. package/dest/test/delayed_tx_utils.js +0 -28
  155. package/dest/test/tx_delayer.d.ts +0 -36
  156. package/dest/test/tx_delayer.d.ts.map +0 -1
  157. package/src/contracts/empire_slashing_proposer.ts +0 -259
  158. package/src/l1_tx_utils/l1_tx_utils_with_blobs.ts +0 -77
  159. package/src/test/delayed_tx_utils.ts +0 -52
@@ -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,102 @@ 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:
85
+ | { l1Timestamp: bigint; timeoutSeconds?: number }
86
+ | { l1BlockNumber: bigint; timeoutSeconds?: number }
87
+ | { indefinitely: true }
88
+ | undefined = undefined;
89
+ public sentTxHashes: Hex[] = [];
90
+ public cancelledTxs: Hex[] = [];
94
91
 
95
- class DelayerImpl implements Delayer {
96
- private logger = createLogger('ethereum:tx_delayer');
97
92
  constructor(
98
93
  public dateProvider: DateProvider,
99
94
  opts: { ethereumSlotDuration: bigint | number },
95
+ bindings: LoggerBindings,
100
96
  ) {
101
97
  this.ethereumSlotDuration = BigInt(opts.ethereumSlotDuration);
98
+ this.logger = createLogger('ethereum:tx_delayer', bindings);
102
99
  }
103
100
 
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[] = [];
101
+ /** Returns the logger instance used by this delayer. */
102
+ getLogger(): Logger {
103
+ return this.logger;
104
+ }
109
105
 
106
+ /** Returns the hashes of all effectively sent txs. */
110
107
  getSentTxHashes() {
111
108
  return this.sentTxHashes;
112
109
  }
113
110
 
111
+ /** Returns the raw hex for all cancelled txs. */
114
112
  getCancelledTxs(): Hex[] {
115
113
  return this.cancelledTxs;
116
114
  }
117
115
 
118
- pauseNextTxUntilBlock(l1BlockNumber: number | bigint) {
119
- this.nextWait = { l1BlockNumber: BigInt(l1BlockNumber) };
116
+ /** Delays the next tx to be sent so it lands on the given L1 block number. */
117
+ pauseNextTxUntilBlock(l1BlockNumber: number | bigint, timeoutSeconds?: number) {
118
+ this.nextWait = { l1BlockNumber: BigInt(l1BlockNumber), timeoutSeconds };
120
119
  }
121
120
 
122
- pauseNextTxUntilTimestamp(l1Timestamp: number | bigint) {
123
- this.nextWait = { l1Timestamp: BigInt(l1Timestamp) };
121
+ /** Delays the next tx to be sent so it lands on the given timestamp. */
122
+ pauseNextTxUntilTimestamp(l1Timestamp: number | bigint, timeoutSeconds?: number) {
123
+ this.nextWait = { l1Timestamp: BigInt(l1Timestamp), timeoutSeconds };
124
124
  }
125
125
 
126
+ /** Delays the next tx to be sent indefinitely. */
126
127
  cancelNextTx() {
127
128
  this.nextWait = { indefinitely: true };
128
129
  }
129
130
 
131
+ /**
132
+ * Sets max inclusion time into slot. If more than this many seconds have passed
133
+ * since the last L1 block was mined, then any tx will not be mined in the current
134
+ * L1 slot but will be deferred for the next one.
135
+ */
130
136
  setMaxInclusionTimeIntoSlot(seconds: number | undefined) {
131
137
  this.maxInclusionTimeIntoSlot = seconds;
132
138
  }
133
139
  }
134
140
 
135
141
  /**
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.
142
+ * Creates a new Delayer instance. Exposed so callers can create a single shared delayer
143
+ * and pass it to multiple `wrapClientWithDelayer` calls.
139
144
  */
140
- export function withDelayer<T extends ViemClient>(
141
- client: T,
145
+ export function createDelayer(
142
146
  dateProvider: DateProvider,
143
147
  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.');
148
+ bindings: LoggerBindings,
149
+ ): Delayer {
150
+ return new Delayer(dateProvider, opts, bindings);
151
+ }
152
+
153
+ /** Tries to recover the sender address from a serialized signed transaction. */
154
+ async function tryRecoverSender(serializedTransaction: Hex): Promise<string | undefined> {
155
+ try {
156
+ return await recoverTransactionAddress({
157
+ serializedTransaction: serializedTransaction as TransactionSerialized,
158
+ });
159
+ } catch {
160
+ return undefined;
147
161
  }
148
- const logger = createLogger('ethereum:tx_delayer');
149
- const delayer = new DelayerImpl(dateProvider, opts);
162
+ }
150
163
 
151
- const extended = client
164
+ /**
165
+ * Wraps a viem client with tx delaying logic. Returns the wrapped client.
166
+ * The delayer intercepts sendRawTransaction calls and delays them based on the delayer's state.
167
+ */
168
+ export function wrapClientWithDelayer<T extends ViemClient>(client: T, delayer: Delayer): T {
169
+ const logger = delayer.getLogger();
170
+
171
+ // Cast to ExtendedViemWalletClient for the extend chain since it has sendRawTransaction.
172
+ // The sendRawTransaction override is applied to all clients regardless of type.
173
+ const withRawTx = (client as unknown as ExtendedViemWalletClient)
152
174
  // Tweak sendRawTransaction so it uses the delay defined in the delayer.
153
175
  // Note that this will only work with local accounts (ie accounts for which we have the private key).
154
176
  // Transactions signed by the node will not be delayed since they use sendTransaction directly,
@@ -160,6 +182,7 @@ export function withDelayer<T extends ViemClient>(
160
182
 
161
183
  const { serializedTransaction } = args[0];
162
184
  const publicClient = client as unknown as PublicClient;
185
+ const sender = await tryRecoverSender(serializedTransaction);
163
186
 
164
187
  if (delayer.nextWait !== undefined) {
165
188
  // Check if we have been instructed to delay the next tx.
@@ -171,7 +194,7 @@ export function withDelayer<T extends ViemClient>(
171
194
 
172
195
  // Cancel tx outright if instructed
173
196
  if ('indefinitely' in waitUntil && waitUntil.indefinitely) {
174
- logger.info(`Cancelling tx ${txHash}`);
197
+ logger.info(`Cancelling tx ${txHash}`, { sender });
175
198
  delayer.cancelledTxs.push(serializedTransaction);
176
199
  return Promise.resolve(txHash);
177
200
  }
@@ -179,12 +202,18 @@ export function withDelayer<T extends ViemClient>(
179
202
  // Or wait until the desired block number or timestamp
180
203
  wait =
181
204
  'l1BlockNumber' in waitUntil
182
- ? waitUntilBlock(publicClient, waitUntil.l1BlockNumber - 1n, logger)
205
+ ? waitUntilBlock(publicClient, waitUntil.l1BlockNumber - 1n, logger, waitUntil.timeoutSeconds)
183
206
  : 'l1Timestamp' in waitUntil
184
- ? waitUntilL1Timestamp(publicClient, waitUntil.l1Timestamp - delayer.ethereumSlotDuration, logger)
207
+ ? waitUntilL1Timestamp(
208
+ publicClient,
209
+ waitUntil.l1Timestamp - delayer.ethereumSlotDuration,
210
+ logger,
211
+ waitUntil.timeoutSeconds,
212
+ )
185
213
  : undefined;
186
214
 
187
215
  logger.info(`Delaying tx ${txHash} until ${inspect(waitUntil)}`, {
216
+ sender,
188
217
  argsLen: args.length,
189
218
  ...omit(parseTransaction(serializedTransaction), 'data', 'sidecars'),
190
219
  });
@@ -196,6 +225,7 @@ export function withDelayer<T extends ViemClient>(
196
225
 
197
226
  txHash = computeTxHash(serializedTransaction);
198
227
  const logData = {
228
+ sender,
199
229
  ...omit(parseTransaction(serializedTransaction), 'data', 'sidecars'),
200
230
  lastBlockTimestamp,
201
231
  now,
@@ -225,28 +255,35 @@ export function withDelayer<T extends ViemClient>(
225
255
  computedTxHash: txHash,
226
256
  });
227
257
  }
228
- logger.info(`Sent previously delayed tx ${clientTxHash}`);
258
+ logger.info(`Sent previously delayed tx ${clientTxHash}`, { sender });
229
259
  delayer.sentTxHashes.push(clientTxHash);
230
260
  })
231
261
  .catch(err => logger.error(`Error sending tx after delay`, err));
232
262
  return Promise.resolve(txHash!);
233
263
  } else {
234
264
  const txHash = await client.sendRawTransaction(...args);
235
- logger.debug(`Sent tx immediately ${txHash}`);
265
+ logger.debug(`Sent tx immediately ${txHash}`, { sender });
236
266
  delayer.sentTxHashes.push(txHash);
237
267
  return txHash;
238
268
  }
239
269
  },
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;
270
+ }));
271
+
272
+ // Only re-bind wallet actions (sendTransaction, writeContract, deployContract) for wallet clients.
273
+ // This is needed for tests that use wallet actions directly rather than sendRawTransaction.
274
+ const isWalletClient = 'account' in client && client.account !== undefined;
275
+ const extended = isWalletClient
276
+ ? withRawTx
277
+ // Re-extend with sendTransaction so it uses the modified sendRawTransaction.
278
+ .extend(client => ({ sendTransaction: walletActions(client).sendTransaction }))
279
+ // And with the actions that depend on the modified sendTransaction
280
+ .extend(client => ({
281
+ writeContract: walletActions(client).writeContract,
282
+ deployContract: walletActions(client).deployContract,
283
+ }))
284
+ : withRawTx;
248
285
 
249
- return { client: extended, delayer };
286
+ return extended as T;
250
287
  }
251
288
 
252
289
  /**
@@ -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
  }
@@ -85,14 +85,26 @@ 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
  }
95
97
 
98
+ /**
99
+ * Get the timestamp of the pending L1 block — the block that anvil will mine next.
100
+ * Reflects any prior `setNextBlockTimestamp` call or the configured block interval.
101
+ * @returns The pending block timestamp in seconds.
102
+ */
103
+ public async nextBlockTimestamp(): Promise<number> {
104
+ const res = await this.doRpcCall('eth_getBlockByNumber', ['pending', false]);
105
+ return parseInt(res.timestamp, 16);
106
+ }
107
+
96
108
  /**
97
109
  * Advance the chain by a number of blocks
98
110
  * @param numberOfBlocks - The number of blocks to mine
@@ -552,7 +564,7 @@ export class EthCheatCodes {
552
564
  }
553
565
 
554
566
  public async syncDateProvider() {
555
- const timestamp = await this.timestamp();
567
+ const timestamp = await this.lastBlockTimestamp();
556
568
  if ('setTime' in this.dateProvider) {
557
569
  this.dateProvider.setTime(timestamp * 1000);
558
570
  }