@aztec/ethereum 0.0.1-commit.6d63667d → 0.0.1-commit.7ac86ea28

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 (86) hide show
  1. package/dest/config.d.ts +1 -1
  2. package/dest/config.d.ts.map +1 -1
  3. package/dest/config.js +5 -3
  4. package/dest/contracts/empire_base.d.ts +3 -1
  5. package/dest/contracts/empire_base.d.ts.map +1 -1
  6. package/dest/contracts/empire_slashing_proposer.d.ts +3 -1
  7. package/dest/contracts/empire_slashing_proposer.d.ts.map +1 -1
  8. package/dest/contracts/empire_slashing_proposer.js +9 -0
  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/index.d.ts +2 -1
  17. package/dest/contracts/index.d.ts.map +1 -1
  18. package/dest/contracts/index.js +1 -0
  19. package/dest/contracts/rollup.d.ts +2 -1
  20. package/dest/contracts/rollup.d.ts.map +1 -1
  21. package/dest/contracts/rollup.js +5 -3
  22. package/dest/deploy_aztec_l1_contracts.d.ts +2 -3
  23. package/dest/deploy_aztec_l1_contracts.d.ts.map +1 -1
  24. package/dest/deploy_aztec_l1_contracts.js +33 -19
  25. package/dest/deploy_l1_contract.js +3 -3
  26. package/dest/l1_artifacts.d.ts +1051 -42
  27. package/dest/l1_artifacts.d.ts.map +1 -1
  28. package/dest/l1_tx_utils/config.d.ts +7 -1
  29. package/dest/l1_tx_utils/config.d.ts.map +1 -1
  30. package/dest/l1_tx_utils/config.js +14 -1
  31. package/dest/l1_tx_utils/factory.d.ts +18 -10
  32. package/dest/l1_tx_utils/factory.d.ts.map +1 -1
  33. package/dest/l1_tx_utils/factory.js +17 -7
  34. package/dest/l1_tx_utils/fee-strategies/p75_competitive.js +1 -1
  35. package/dest/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.js +1 -1
  36. package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts +15 -15
  37. package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts.map +1 -1
  38. package/dest/l1_tx_utils/forwarder_l1_tx_utils.js +9 -15
  39. package/dest/l1_tx_utils/index-blobs.d.ts +3 -3
  40. package/dest/l1_tx_utils/index-blobs.d.ts.map +1 -1
  41. package/dest/l1_tx_utils/index-blobs.js +2 -2
  42. package/dest/l1_tx_utils/index.d.ts +2 -1
  43. package/dest/l1_tx_utils/index.d.ts.map +1 -1
  44. package/dest/l1_tx_utils/index.js +1 -0
  45. package/dest/l1_tx_utils/l1_tx_utils.d.ts +15 -5
  46. package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
  47. package/dest/l1_tx_utils/l1_tx_utils.js +41 -7
  48. package/dest/l1_tx_utils/tx_delayer.d.ts +56 -0
  49. package/dest/l1_tx_utils/tx_delayer.d.ts.map +1 -0
  50. package/dest/{test → l1_tx_utils}/tx_delayer.js +62 -34
  51. package/dest/test/index.d.ts +1 -3
  52. package/dest/test/index.d.ts.map +1 -1
  53. package/dest/test/index.js +0 -2
  54. package/dest/test/upgrade_utils.js +2 -2
  55. package/package.json +5 -5
  56. package/src/config.ts +3 -2
  57. package/src/contracts/empire_base.ts +2 -0
  58. package/src/contracts/empire_slashing_proposer.ts +6 -0
  59. package/src/contracts/fee_asset_price_oracle.ts +280 -0
  60. package/src/contracts/governance.ts +3 -3
  61. package/src/contracts/governance_proposer.ts +6 -0
  62. package/src/contracts/index.ts +1 -0
  63. package/src/contracts/rollup.ts +11 -7
  64. package/src/deploy_aztec_l1_contracts.ts +56 -29
  65. package/src/deploy_l1_contract.ts +3 -3
  66. package/src/l1_tx_utils/config.ts +20 -0
  67. package/src/l1_tx_utils/factory.ts +31 -31
  68. package/src/l1_tx_utils/fee-strategies/p75_competitive.ts +1 -1
  69. package/src/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.ts +1 -1
  70. package/src/l1_tx_utils/forwarder_l1_tx_utils.ts +43 -54
  71. package/src/l1_tx_utils/index-blobs.ts +2 -2
  72. package/src/l1_tx_utils/index.ts +1 -0
  73. package/src/l1_tx_utils/l1_tx_utils.ts +46 -11
  74. package/src/{test → l1_tx_utils}/tx_delayer.ts +78 -50
  75. package/src/test/index.ts +0 -2
  76. package/src/test/upgrade_utils.ts +2 -2
  77. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts +0 -26
  78. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts.map +0 -1
  79. package/dest/l1_tx_utils/l1_tx_utils_with_blobs.js +0 -26
  80. package/dest/test/delayed_tx_utils.d.ts +0 -13
  81. package/dest/test/delayed_tx_utils.d.ts.map +0 -1
  82. package/dest/test/delayed_tx_utils.js +0 -28
  83. package/dest/test/tx_delayer.d.ts +0 -36
  84. package/dest/test/tx_delayer.d.ts.map +0 -1
  85. package/src/l1_tx_utils/l1_tx_utils_with_blobs.ts +0 -77
  86. package/src/test/delayed_tx_utils.ts +0 -52
@@ -5,6 +5,7 @@ import {
5
5
  getConfigFromMappings,
6
6
  getDefaultConfig,
7
7
  numberConfigHelper,
8
+ optionalNumberConfigHelper,
8
9
  } from '@aztec/foundation/config';
9
10
 
10
11
  export interface L1TxUtilsConfig {
@@ -60,6 +61,12 @@ export interface L1TxUtilsConfig {
60
61
  * How long a tx nonce can be unseen in the mempool before considering it dropped
61
62
  */
62
63
  txUnseenConsideredDroppedMs?: number;
64
+ /** Enable tx delayer. When true, wraps the viem client to intercept and delay txs. Test-only. */
65
+ enableDelayer?: boolean;
66
+ /** Max seconds into an L1 slot for tx inclusion. Txs sent later are deferred to next slot. Only used when enableDelayer is true. */
67
+ txDelayerMaxInclusionTimeIntoSlot?: number;
68
+ /** How many seconds an L1 slot lasts. */
69
+ ethereumSlotDuration?: number;
63
70
  }
64
71
 
65
72
  export const l1TxUtilsConfigMappings: ConfigMappingsType<L1TxUtilsConfig> = {
@@ -142,6 +149,19 @@ export const l1TxUtilsConfigMappings: ConfigMappingsType<L1TxUtilsConfig> = {
142
149
  env: 'L1_TX_MONITOR_TX_UNSEEN_CONSIDERED_DROPPED_MS',
143
150
  ...numberConfigHelper(6 * 12 * 1000), // 6 L1 blocks
144
151
  },
152
+ enableDelayer: {
153
+ description: 'Enable tx delayer for testing.',
154
+ ...booleanConfigHelper(false),
155
+ },
156
+ txDelayerMaxInclusionTimeIntoSlot: {
157
+ description: 'Max seconds into L1 slot for tx inclusion when delayer is enabled.',
158
+ ...optionalNumberConfigHelper(),
159
+ },
160
+ ethereumSlotDuration: {
161
+ env: 'ETHEREUM_SLOT_DURATION',
162
+ description: 'How many seconds an L1 slot lasts.',
163
+ ...numberConfigHelper(12),
164
+ },
145
165
  };
146
166
 
147
167
  // We abuse the fact that all mappings above have a non null default value and force-type this to Required
@@ -1,64 +1,64 @@
1
+ import type { BlobKzgInstance } from '@aztec/blob-lib/types';
1
2
  import { EthAddress } from '@aztec/foundation/eth-address';
2
3
  import type { Logger } from '@aztec/foundation/log';
3
4
  import { DateProvider } from '@aztec/foundation/timer';
4
5
 
5
- import type { TransactionSerializable } from 'viem';
6
-
7
6
  import type { EthSigner } from '../eth-signer/eth-signer.js';
8
7
  import type { ExtendedViemWalletClient, ViemClient } from '../types.js';
9
8
  import type { L1TxUtilsConfig } from './config.js';
10
9
  import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
11
10
  import { L1TxUtils } from './l1_tx_utils.js';
12
11
  import { createViemSigner } from './signer.js';
12
+ import { Delayer } from './tx_delayer.js';
13
13
  import type { SigningCallback } from './types.js';
14
14
 
15
- export function createL1TxUtilsFromViemWallet(
16
- client: ExtendedViemWalletClient,
17
- deps?: {
18
- logger?: Logger;
19
- dateProvider?: DateProvider;
20
- store?: IL1TxStore;
21
- metrics?: IL1TxMetrics;
22
- },
23
- config?: Partial<L1TxUtilsConfig> & { debugMaxGasLimit?: boolean },
24
- ): L1TxUtils {
25
- return new L1TxUtils(
15
+ /** Source of signing capability: either a wallet client or a separate client + signer. */
16
+ export type L1SignerSource = ExtendedViemWalletClient | { client: ViemClient; signer: EthSigner };
17
+
18
+ export function resolveSignerSource(source: L1SignerSource): {
19
+ client: ViemClient;
20
+ address: EthAddress;
21
+ signingCallback: SigningCallback;
22
+ } {
23
+ if ('account' in source && source.account) {
24
+ return {
25
+ client: source as ExtendedViemWalletClient,
26
+ address: EthAddress.fromString((source as ExtendedViemWalletClient).account.address),
27
+ signingCallback: createViemSigner(source as ExtendedViemWalletClient),
28
+ };
29
+ }
30
+ const { client, signer } = source as { client: ViemClient; signer: EthSigner };
31
+ return {
26
32
  client,
27
- EthAddress.fromString(client.account.address),
28
- createViemSigner(client),
29
- deps?.logger,
30
- deps?.dateProvider,
31
- config,
32
- config?.debugMaxGasLimit ?? false,
33
- deps?.store,
34
- deps?.metrics,
35
- );
33
+ address: signer.address,
34
+ signingCallback: async (tx, _addr) => (await signer.signTransaction(tx)).toViemTransactionSignature(),
35
+ };
36
36
  }
37
37
 
38
- export function createL1TxUtilsFromEthSigner(
39
- client: ViemClient,
40
- signer: EthSigner,
38
+ export function createL1TxUtils(
39
+ source: L1SignerSource,
41
40
  deps?: {
42
41
  logger?: Logger;
43
42
  dateProvider?: DateProvider;
44
43
  store?: IL1TxStore;
45
44
  metrics?: IL1TxMetrics;
45
+ kzg?: BlobKzgInstance;
46
+ delayer?: Delayer;
46
47
  },
47
48
  config?: Partial<L1TxUtilsConfig> & { debugMaxGasLimit?: boolean },
48
49
  ): L1TxUtils {
49
- const callback: SigningCallback = async (transaction: TransactionSerializable, _signingAddress) => {
50
- return (await signer.signTransaction(transaction)).toViemTransactionSignature();
51
- };
52
-
50
+ const { client, address, signingCallback } = resolveSignerSource(source);
53
51
  return new L1TxUtils(
54
52
  client,
55
- signer.address,
56
- callback,
53
+ address,
54
+ signingCallback,
57
55
  deps?.logger,
58
56
  deps?.dateProvider,
59
57
  config,
60
58
  config?.debugMaxGasLimit ?? false,
61
59
  deps?.store,
62
60
  deps?.metrics,
61
+ deps?.kzg,
62
+ deps?.delayer,
63
63
  );
64
64
  }
@@ -134,7 +134,7 @@ export const P75AllTxsPriorityFeeStrategy: PriorityFeeStrategy = {
134
134
  // Sanity check: cap competitive fee at 100x network estimate to avoid using unrealistic fees
135
135
  const maxReasonableFee = networkEstimate * 100n;
136
136
  if (competitiveFee > maxReasonableFee && networkEstimate > 0n) {
137
- logger?.warn('Competitive fee exceeds sanity cap, using capped value', {
137
+ logger?.debug('Competitive fee exceeds sanity cap, using capped value', {
138
138
  competitiveFee: formatGwei(competitiveFee),
139
139
  networkEstimate: formatGwei(networkEstimate),
140
140
  cappedTo: formatGwei(maxReasonableFee),
@@ -207,7 +207,7 @@ export const P75BlobTxsOnlyPriorityFeeStrategy: PriorityFeeStrategy = {
207
207
 
208
208
  // Debug: Log suspicious fees from history
209
209
  if (medianHistoricalFee > 100n * WEI_CONST) {
210
- logger?.warn('Suspicious high fee in history', {
210
+ logger?.debug('Suspicious high fee in history', {
211
211
  historicalMedian: formatGwei(medianHistoricalFee),
212
212
  allP75Fees: percentile75Fees.map(f => formatGwei(f)),
213
213
  });
@@ -1,25 +1,27 @@
1
+ import type { BlobKzgInstance } from '@aztec/blob-lib/types';
1
2
  import { EthAddress } from '@aztec/foundation/eth-address';
2
3
  import type { Logger } from '@aztec/foundation/log';
3
4
  import type { DateProvider } from '@aztec/foundation/timer';
4
5
 
5
6
  import { type Hex, encodeFunctionData } from 'viem';
6
7
 
7
- import type { EthSigner } from '../eth-signer/eth-signer.js';
8
8
  import { FORWARDER_ABI } from '../forwarder_proxy.js';
9
- import type { ExtendedViemWalletClient, ViemClient } from '../types.js';
9
+ import type { ViemClient } from '../types.js';
10
10
  import type { L1TxUtilsConfig } from './config.js';
11
+ import type { L1SignerSource } from './factory.js';
12
+ import { resolveSignerSource } from './factory.js';
11
13
  import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
12
- import { L1TxUtilsWithBlobs } from './l1_tx_utils_with_blobs.js';
13
- import { createViemSigner } from './signer.js';
14
+ import { L1TxUtils } from './l1_tx_utils.js';
15
+ import { Delayer } from './tx_delayer.js';
14
16
  import type { L1BlobInputs, L1TxConfig, L1TxRequest, SigningCallback } from './types.js';
15
17
 
16
18
  /**
17
- * Extends L1TxUtilsWithBlobs to wrap all transactions through a forwarder contract.
19
+ * Extends L1TxUtils to wrap all transactions through a forwarder contract.
18
20
  * This is mainly used for testing the archiver's ability to decode transactions that go through proxies.
19
21
  */
20
- export class ForwarderL1TxUtils extends L1TxUtilsWithBlobs {
22
+ export class ForwarderL1TxUtils extends L1TxUtils {
21
23
  constructor(
22
- client: ViemClient | ExtendedViemWalletClient,
24
+ client: ViemClient,
23
25
  senderAddress: EthAddress,
24
26
  signingCallback: SigningCallback,
25
27
  logger: Logger | undefined,
@@ -28,9 +30,23 @@ export class ForwarderL1TxUtils extends L1TxUtilsWithBlobs {
28
30
  debugMaxGasLimit: boolean,
29
31
  store: IL1TxStore | undefined,
30
32
  metrics: IL1TxMetrics | undefined,
33
+ kzg: BlobKzgInstance | undefined,
34
+ delayer: Delayer | undefined,
31
35
  private readonly forwarderAddress: EthAddress,
32
36
  ) {
33
- super(client, senderAddress, signingCallback, logger, dateProvider, config, debugMaxGasLimit, store, metrics);
37
+ super(
38
+ client,
39
+ senderAddress,
40
+ signingCallback,
41
+ logger,
42
+ dateProvider,
43
+ config,
44
+ debugMaxGasLimit,
45
+ store,
46
+ metrics,
47
+ kzg,
48
+ delayer,
49
+ );
34
50
  }
35
51
 
36
52
  /**
@@ -61,59 +77,32 @@ export class ForwarderL1TxUtils extends L1TxUtilsWithBlobs {
61
77
  }
62
78
  }
63
79
 
64
- export function createForwarderL1TxUtilsFromViemWallet(
65
- client: ExtendedViemWalletClient,
80
+ export function createForwarderL1TxUtils(
81
+ source: L1SignerSource,
66
82
  forwarderAddress: EthAddress,
67
- deps: {
83
+ deps?: {
68
84
  logger?: Logger;
69
85
  dateProvider?: DateProvider;
70
86
  store?: IL1TxStore;
71
87
  metrics?: IL1TxMetrics;
72
- } = {},
73
- config: Partial<L1TxUtilsConfig> = {},
74
- debugMaxGasLimit: boolean = false,
75
- ) {
88
+ kzg?: BlobKzgInstance;
89
+ delayer?: Delayer;
90
+ },
91
+ config?: Partial<L1TxUtilsConfig> & { debugMaxGasLimit?: boolean },
92
+ ): ForwarderL1TxUtils {
93
+ const { client, address, signingCallback } = resolveSignerSource(source);
76
94
  return new ForwarderL1TxUtils(
77
95
  client,
78
- EthAddress.fromString(client.account.address),
79
- createViemSigner(client),
80
- deps.logger,
81
- deps.dateProvider,
82
- config,
83
- debugMaxGasLimit,
84
- deps.store,
85
- deps.metrics,
86
- forwarderAddress,
87
- );
88
- }
89
-
90
- export function createForwarderL1TxUtilsFromEthSigner(
91
- client: ViemClient,
92
- signer: EthSigner,
93
- forwarderAddress: EthAddress,
94
- deps: {
95
- logger?: Logger;
96
- dateProvider?: DateProvider;
97
- store?: IL1TxStore;
98
- metrics?: IL1TxMetrics;
99
- } = {},
100
- config: Partial<L1TxUtilsConfig> = {},
101
- debugMaxGasLimit: boolean = false,
102
- ) {
103
- const callback: SigningCallback = async (transaction, _signingAddress) => {
104
- return (await signer.signTransaction(transaction)).toViemTransactionSignature();
105
- };
106
-
107
- return new ForwarderL1TxUtils(
108
- client,
109
- signer.address,
110
- callback,
111
- deps.logger,
112
- deps.dateProvider,
113
- config,
114
- debugMaxGasLimit,
115
- deps.store,
116
- deps.metrics,
96
+ address,
97
+ signingCallback,
98
+ deps?.logger,
99
+ deps?.dateProvider,
100
+ config ?? {},
101
+ config?.debugMaxGasLimit ?? false,
102
+ deps?.store,
103
+ deps?.metrics,
104
+ deps?.kzg,
105
+ deps?.delayer,
117
106
  forwarderAddress,
118
107
  );
119
108
  }
@@ -1,2 +1,2 @@
1
- export * from './forwarder_l1_tx_utils.js';
2
- export * from './l1_tx_utils_with_blobs.js';
1
+ export { createForwarderL1TxUtils, ForwarderL1TxUtils } from './forwarder_l1_tx_utils.js';
2
+ export { createL1TxUtils, type L1SignerSource, resolveSignerSource } from './factory.js';
@@ -8,6 +8,7 @@ export * from './l1_tx_utils.js';
8
8
  export * from './readonly_l1_tx_utils.js';
9
9
  export * from './signer.js';
10
10
  export * from './types.js';
11
+ export * from './tx_delayer.js';
11
12
  export * from './utils.js';
12
13
 
13
14
  // Note: We intentionally do not export l1_tx_utils_with_blobs.js
@@ -1,8 +1,9 @@
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';
6
7
  import { retryUntil } from '@aztec/foundation/retry';
7
8
  import { sleep } from '@aztec/foundation/sleep';
8
9
  import { DateProvider } from '@aztec/foundation/timer';
@@ -30,6 +31,7 @@ import { type L1TxUtilsConfig, l1TxUtilsConfigMappings } from './config.js';
30
31
  import { MAX_L1_TX_LIMIT } from './constants.js';
31
32
  import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
32
33
  import { ReadOnlyL1TxUtils } from './readonly_l1_tx_utils.js';
34
+ import { Delayer, createDelayer, wrapClientWithDelayer } from './tx_delayer.js';
33
35
  import {
34
36
  DroppedTransactionError,
35
37
  type L1BlobInputs,
@@ -47,6 +49,10 @@ const MAX_L1_TX_STATES = 32;
47
49
  export class L1TxUtils extends ReadOnlyL1TxUtils {
48
50
  protected nonceManager: NonceManager;
49
51
  protected txs: L1TxState[] = [];
52
+ /** Tx delayer for testing. Only set when enableDelayer config is true. */
53
+ public delayer?: Delayer;
54
+ /** KZG instance for blob operations. */
55
+ protected kzg?: BlobKzgInstance;
50
56
 
51
57
  constructor(
52
58
  public override client: ViemClient,
@@ -58,9 +64,26 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
58
64
  debugMaxGasLimit: boolean = false,
59
65
  protected store?: IL1TxStore,
60
66
  protected metrics?: IL1TxMetrics,
67
+ kzg?: BlobKzgInstance,
68
+ delayer?: Delayer,
61
69
  ) {
62
70
  super(client, logger, dateProvider, config, debugMaxGasLimit);
63
71
  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() {
@@ -221,6 +244,16 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
221
244
  throw new InterruptError(`Transaction sending is interrupted`);
222
245
  }
223
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
+
224
257
  const nonce = await this.nonceManager.consume({
225
258
  client: this.client,
226
259
  address: account,
@@ -230,13 +263,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
230
263
  const baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
231
264
  const txData = this.makeTxData(baseState, { isCancelTx: false });
232
265
 
233
- const now = new Date(await this.getL1Timestamp());
234
- if (gasConfig.txTimeoutAt && now > gasConfig.txTimeoutAt) {
235
- throw new TimeoutError(
236
- `Transaction timed out before sending (now ${now.toISOString()} > timeoutAt ${gasConfig.txTimeoutAt.toISOString()})`,
237
- );
238
- }
239
-
240
266
  // Send the new tx
241
267
  const signedRequest = await this.prepareSignedTransaction(txData);
242
268
  const txHash = await this.client.sendRawTransaction({ serializedTransaction: signedRequest });
@@ -731,8 +757,17 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
731
757
  return Number(timestamp) * 1000;
732
758
  }
733
759
 
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');
760
+ /** Makes empty blob inputs for the cancellation tx. */
761
+ protected makeEmptyBlobInputs(maxFeePerBlobGas: bigint): Required<L1BlobInputs> {
762
+ if (!this.kzg) {
763
+ throw new Error('Cannot make empty blob inputs for cancellation without kzg');
764
+ }
765
+ const blobData = new Uint8Array(131072).fill(0);
766
+ return { blobs: [blobData], kzg: this.kzg, maxFeePerBlobGas };
767
+ }
768
+
769
+ /** Creates a new delayer instance. */
770
+ protected createDelayer(opts: { ethereumSlotDuration: bigint | number }, bindings: LoggerBindings): Delayer {
771
+ return createDelayer(this.dateProvider, opts, bindings);
737
772
  }
738
773
  }
@@ -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
  /**
package/src/test/index.ts CHANGED
@@ -1,8 +1,6 @@
1
- export * from './delayed_tx_utils.js';
2
1
  export * from './eth_cheat_codes.js';
3
2
  export * from './eth_cheat_codes_with_state.js';
4
3
  export * from './start_anvil.js';
5
- export * from './tx_delayer.js';
6
4
  export * from './upgrade_utils.js';
7
5
  export * from './chain_monitor.js';
8
6
  export * from './rollup_cheat_codes.js';