@aztec/ethereum 0.0.1-commit.42ee6df9b → 0.0.1-commit.431c48d

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 (144) hide show
  1. package/dest/client.d.ts +19 -3
  2. package/dest/client.d.ts.map +1 -1
  3. package/dest/client.js +52 -3
  4. package/dest/config.d.ts +15 -6
  5. package/dest/config.d.ts.map +1 -1
  6. package/dest/config.js +29 -9
  7. package/dest/contracts/chain_state_override.d.ts +78 -0
  8. package/dest/contracts/chain_state_override.d.ts.map +1 -0
  9. package/dest/contracts/chain_state_override.js +137 -0
  10. package/dest/contracts/empire_base.d.ts +1 -3
  11. package/dest/contracts/empire_base.d.ts.map +1 -1
  12. package/dest/contracts/fee_asset_price_oracle.d.ts +6 -2
  13. package/dest/contracts/fee_asset_price_oracle.d.ts.map +1 -1
  14. package/dest/contracts/fee_asset_price_oracle.js +11 -6
  15. package/dest/contracts/governance.d.ts +135 -35
  16. package/dest/contracts/governance.d.ts.map +1 -1
  17. package/dest/contracts/governance.js +226 -15
  18. package/dest/contracts/governance_proposer.d.ts +33 -4
  19. package/dest/contracts/governance_proposer.d.ts.map +1 -1
  20. package/dest/contracts/governance_proposer.js +52 -13
  21. package/dest/contracts/gse.d.ts +4 -2
  22. package/dest/contracts/gse.d.ts.map +1 -1
  23. package/dest/contracts/gse.js +2 -2
  24. package/dest/contracts/inbox.d.ts +3 -3
  25. package/dest/contracts/inbox.d.ts.map +1 -1
  26. package/dest/contracts/inbox.js +9 -3
  27. package/dest/contracts/index.d.ts +3 -3
  28. package/dest/contracts/index.d.ts.map +1 -1
  29. package/dest/contracts/index.js +2 -2
  30. package/dest/contracts/multicall.d.ts +79 -13
  31. package/dest/contracts/multicall.d.ts.map +1 -1
  32. package/dest/contracts/multicall.js +117 -95
  33. package/dest/contracts/outbox.d.ts +27 -4
  34. package/dest/contracts/outbox.d.ts.map +1 -1
  35. package/dest/contracts/outbox.js +34 -7
  36. package/dest/contracts/rollup.d.ts +5401 -34
  37. package/dest/contracts/rollup.d.ts.map +1 -1
  38. package/dest/contracts/rollup.js +271 -119
  39. package/dest/contracts/slashing_proposer.d.ts +171 -0
  40. package/dest/contracts/slashing_proposer.d.ts.map +1 -0
  41. package/dest/contracts/slashing_proposer.js +753 -0
  42. package/dest/contracts/watch_event.d.ts +36 -0
  43. package/dest/contracts/watch_event.d.ts.map +1 -0
  44. package/dest/contracts/watch_event.js +66 -0
  45. package/dest/deploy_aztec_l1_contracts.d.ts +4 -7
  46. package/dest/deploy_aztec_l1_contracts.d.ts.map +1 -1
  47. package/dest/deploy_aztec_l1_contracts.js +15 -8
  48. package/dest/foundry_binary.d.ts +13 -0
  49. package/dest/foundry_binary.d.ts.map +1 -0
  50. package/dest/foundry_binary.js +52 -0
  51. package/dest/generated/l1-contracts-defaults.d.ts +2 -2
  52. package/dest/generated/l1-contracts-defaults.js +2 -2
  53. package/dest/l1_artifacts.d.ts +14941 -16273
  54. package/dest/l1_artifacts.d.ts.map +1 -1
  55. package/dest/l1_artifacts.js +9 -24
  56. package/dest/l1_contract_addresses.d.ts +61 -65
  57. package/dest/l1_contract_addresses.d.ts.map +1 -1
  58. package/dest/l1_contract_addresses.js +101 -82
  59. package/dest/l1_reader.d.ts +3 -5
  60. package/dest/l1_reader.d.ts.map +1 -1
  61. package/dest/l1_reader.js +3 -6
  62. package/dest/l1_tx_utils/config.js +3 -3
  63. package/dest/l1_tx_utils/l1_tx_utils.d.ts +7 -1
  64. package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
  65. package/dest/l1_tx_utils/l1_tx_utils.js +82 -29
  66. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts +1 -1
  67. package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts.map +1 -1
  68. package/dest/l1_tx_utils/readonly_l1_tx_utils.js +49 -19
  69. package/dest/l1_tx_utils/tx_delayer.d.ts +5 -3
  70. package/dest/l1_tx_utils/tx_delayer.d.ts.map +1 -1
  71. package/dest/l1_tx_utils/tx_delayer.js +7 -5
  72. package/dest/publisher_manager.d.ts +18 -6
  73. package/dest/publisher_manager.d.ts.map +1 -1
  74. package/dest/publisher_manager.js +44 -7
  75. package/dest/queries.d.ts +13 -2
  76. package/dest/queries.d.ts.map +1 -1
  77. package/dest/queries.js +62 -3
  78. package/dest/test/blob_kzg_warmup.d.ts +19 -0
  79. package/dest/test/blob_kzg_warmup.d.ts.map +1 -0
  80. package/dest/test/blob_kzg_warmup.js +64 -0
  81. package/dest/test/chain_monitor.d.ts +34 -2
  82. package/dest/test/chain_monitor.d.ts.map +1 -1
  83. package/dest/test/chain_monitor.js +76 -6
  84. package/dest/test/eth_cheat_codes.d.ts +26 -3
  85. package/dest/test/eth_cheat_codes.d.ts.map +1 -1
  86. package/dest/test/eth_cheat_codes.js +61 -40
  87. package/dest/test/index.d.ts +2 -1
  88. package/dest/test/index.d.ts.map +1 -1
  89. package/dest/test/index.js +1 -0
  90. package/dest/test/recording_rpc_server.d.ts +18 -0
  91. package/dest/test/recording_rpc_server.d.ts.map +1 -0
  92. package/dest/test/recording_rpc_server.js +68 -0
  93. package/dest/test/rollup_cheat_codes.d.ts +60 -3
  94. package/dest/test/rollup_cheat_codes.d.ts.map +1 -1
  95. package/dest/test/rollup_cheat_codes.js +86 -7
  96. package/dest/test/start_anvil.d.ts +1 -1
  97. package/dest/test/start_anvil.d.ts.map +1 -1
  98. package/dest/test/start_anvil.js +41 -5
  99. package/dest/utils.d.ts +9 -2
  100. package/dest/utils.d.ts.map +1 -1
  101. package/dest/utils.js +45 -14
  102. package/package.json +6 -6
  103. package/src/client.ts +63 -1
  104. package/src/config.ts +44 -13
  105. package/src/contracts/chain_state_override.ts +200 -0
  106. package/src/contracts/empire_base.ts +0 -2
  107. package/src/contracts/fee_asset_price_oracle.ts +10 -5
  108. package/src/contracts/governance.ts +310 -10
  109. package/src/contracts/governance_proposer.ts +56 -13
  110. package/src/contracts/gse.ts +7 -2
  111. package/src/contracts/inbox.ts +12 -4
  112. package/src/contracts/index.ts +2 -2
  113. package/src/contracts/multicall.ts +179 -105
  114. package/src/contracts/outbox.ts +42 -8
  115. package/src/contracts/rollup.ts +302 -119
  116. package/src/contracts/{tally_slashing_proposer.ts → slashing_proposer.ts} +119 -45
  117. package/src/contracts/watch_event.ts +110 -0
  118. package/src/deploy_aztec_l1_contracts.ts +19 -10
  119. package/src/foundry_binary.ts +57 -0
  120. package/src/generated/l1-contracts-defaults.ts +2 -2
  121. package/src/l1_artifacts.ts +12 -35
  122. package/src/l1_contract_addresses.ts +120 -94
  123. package/src/l1_reader.ts +4 -9
  124. package/src/l1_tx_utils/config.ts +3 -3
  125. package/src/l1_tx_utils/l1_tx_utils.ts +83 -36
  126. package/src/l1_tx_utils/readonly_l1_tx_utils.ts +49 -13
  127. package/src/l1_tx_utils/tx_delayer.ts +16 -7
  128. package/src/publisher_manager.ts +54 -18
  129. package/src/queries.ts +70 -4
  130. package/src/test/blob_kzg_warmup.ts +65 -0
  131. package/src/test/chain_monitor.ts +93 -5
  132. package/src/test/eth_cheat_codes.ts +57 -43
  133. package/src/test/index.ts +1 -0
  134. package/src/test/recording_rpc_server.ts +69 -0
  135. package/src/test/rollup_cheat_codes.ts +115 -6
  136. package/src/test/start_anvil.ts +38 -6
  137. package/src/utils.ts +41 -17
  138. package/dest/contracts/empire_slashing_proposer.d.ts +0 -69
  139. package/dest/contracts/empire_slashing_proposer.d.ts.map +0 -1
  140. package/dest/contracts/empire_slashing_proposer.js +0 -216
  141. package/dest/contracts/tally_slashing_proposer.d.ts +0 -140
  142. package/dest/contracts/tally_slashing_proposer.d.ts.map +0 -1
  143. package/dest/contracts/tally_slashing_proposer.js +0 -320
  144. package/src/contracts/empire_slashing_proposer.ts +0 -265
@@ -40,11 +40,12 @@ export class PublisherManager<UtilsType extends L1TxUtils = L1TxUtils> {
40
40
  private log: Logger;
41
41
  private config: PublisherManagerConfig;
42
42
  private static readonly FUNDING_CHECK_INTERVAL_MS = 2 * 60 * 1000;
43
- private funder?: UtilsType;
44
- private fundingPromise?: RunningPromise;
43
+ protected funder?: UtilsType;
44
+ protected readonly fundingPromise?: RunningPromise;
45
+ private started = false;
45
46
 
46
47
  constructor(
47
- private publishers: UtilsType[],
48
+ protected publishers: UtilsType[],
48
49
  config: PublisherManagerConfig,
49
50
  opts?: { bindings?: LoggerBindings; funder?: UtilsType },
50
51
  ) {
@@ -67,34 +68,60 @@ export class PublisherManager<UtilsType extends L1TxUtils = L1TxUtils> {
67
68
  this.funder = undefined;
68
69
  }
69
70
  }
71
+
72
+ if (this.funder && hasThreshold && hasAmount) {
73
+ this.fundingPromise = new RunningPromise(
74
+ () => this.triggerFundingIfNeeded(),
75
+ this.log,
76
+ PublisherManager.FUNDING_CHECK_INTERVAL_MS,
77
+ );
78
+ }
70
79
  }
71
80
 
72
- /** Loads the state of all publishers and the funder, and starts periodic funding checks. */
81
+ /**
82
+ * Clears any interrupted flag left by a previous {@link stop} so publishing works again after a restart,
83
+ * loads the state of all publishers and the funder, and starts periodic funding checks. Idempotent: a
84
+ * start while already started is a no-op, so it never re-runs `loadStateAndResumeMonitoring` (which
85
+ * would spawn a duplicate background monitor per pending nonce). Lifecycle calls are expected to be
86
+ * serialized by the caller.
87
+ */
73
88
  public async start(): Promise<void> {
89
+ if (this.started) {
90
+ this.log.debug('PublisherManager already started, ignoring start');
91
+ return;
92
+ }
93
+
94
+ // Clear the interrupted flag set by a previous stop() so a restarted manager can publish again.
95
+ // On a first start this is a no-op (the flag is already clear).
96
+ this.publishers.forEach(pub => pub.restart());
97
+ this.funder?.restart();
98
+
74
99
  await Promise.all([
75
100
  ...this.publishers.map(pub => pub.loadStateAndResumeMonitoring()),
76
101
  this.funder?.loadStateAndResumeMonitoring(),
77
102
  ]);
78
103
 
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
- }
104
+ this.fundingPromise?.start();
105
+ // Marked started only once fully up, so a start that failed to load state can be retried.
106
+ this.started = true;
91
107
  }
92
108
 
93
- /** Stops the funding loop and interrupts all publishers. */
109
+ /**
110
+ * Stops the funding loop, interrupts all publishers so no further L1 txs are sent, and waits (bounded)
111
+ * for their in-flight tx monitor loops to wind down. Idempotent, and the manager may be restarted
112
+ * afterwards via {@link start}, which clears the interrupted flag.
113
+ */
94
114
  public async stop(): Promise<void> {
115
+ this.started = false;
95
116
  await this.fundingPromise?.stop();
96
117
  this.publishers.forEach(pub => pub.interrupt());
97
118
  this.funder?.interrupt();
119
+ // Wait for in-flight tx monitor loops to observe the interrupt, so no L1 requests are still
120
+ // being issued after shutdown (e.g. against an anvil instance a test is about to tear down).
121
+ await Promise.all([
122
+ ...this.publishers.map(pub => pub.waitMonitoringStopped()),
123
+ this.funder?.waitMonitoringStopped(),
124
+ ]);
98
125
  }
99
126
 
100
127
  // Finds and prioritises available publishers based on
@@ -133,8 +160,17 @@ export class PublisherManager<UtilsType extends L1TxUtils = L1TxUtils> {
133
160
  }),
134
161
  );
135
162
 
163
+ // Discount unfunded publishers: a publisher with no ETH cannot send a tx, so it must never win
164
+ // selection regardless of how favourable its state or last-used time is. Fall back to the full
165
+ // set only if every candidate is unfunded, so behaviour is no worse than before.
166
+ let fundedPublishers = publishersWithBalance.filter(p => p.balance > 0n);
167
+ if (fundedPublishers.length === 0) {
168
+ this.log.warn(`All candidate publishers have zero balance; selecting from unfunded publishers.`);
169
+ fundedPublishers = publishersWithBalance;
170
+ }
171
+
136
172
  // Sort based on state, then balance, then time since last use
137
- const sortedPublishers = publishersWithBalance.sort((a, b) => {
173
+ const sortedPublishers = fundedPublishers.sort((a, b) => {
138
174
  const stateComparison = sortOrder.indexOf(a.publisher.state) - sortOrder.indexOf(b.publisher.state);
139
175
  if (stateComparison !== 0) {
140
176
  return stateComparison;
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],
@@ -0,0 +1,65 @@
1
+ import { getBytesPerBlob, getBytesPerCommitment, getKzg } from '@aztec/blob-lib';
2
+ import type { Logger } from '@aztec/foundation/log';
3
+
4
+ import type { ExtendedViemWalletClient } from '../types.js';
5
+
6
+ /**
7
+ * Warms both KZG trusted setups in parallel for tests against a local anvil:
8
+ * - anvil's own setup, loaded lazily when it first validates a blob sidecar in `eth_sendRawTransaction`
9
+ * - our `@crate-crypto/node-eth-kzg` singleton (`getKzg()`, a ~2.2s synchronous precomp build)
10
+ *
11
+ * Without this, the first checkpoint publish pays both serially (~4.4s). The recipe does all RPC round
12
+ * trips up front, fires a single bare raw send carrying a fake (garbage) blob sidecar that anvil rejects
13
+ * after loading its trusted setup, yields once to flush the socket write, then synchronously builds our
14
+ * own precomp tables while anvil warms in parallel. The fake tx is rejected at admission, so it never
15
+ * enters the pool, mines no block, and burns no nonce — sending it from the passed client is harmless.
16
+ *
17
+ * Best-effort: any failure is debug-logged and swallowed, leaving lazy init as the fallback. Never throws.
18
+ *
19
+ * @param l1Client - The L1 client whose account sends the (rejected) warm-up blob tx.
20
+ */
21
+ export async function warmBlobKzg(l1Client: ExtendedViemWalletClient, logger?: Logger): Promise<void> {
22
+ try {
23
+ // A pure-JS fake kzg: returns deterministic garbage of the correct lengths (commitment and proof are
24
+ // both 48 bytes). It makes viem build a syntactically valid sidecar without initializing any native
25
+ // module, so anvil loads its trusted setup to validate the (invalid) proof and then rejects the tx.
26
+ const fakeKzg = {
27
+ blobToKzgCommitment: () => {
28
+ const commitment = new Uint8Array(getBytesPerCommitment());
29
+ commitment.fill(0xab);
30
+ commitment[0] = 0xc0;
31
+ return commitment;
32
+ },
33
+ computeBlobKzgProof: () => {
34
+ const proof = new Uint8Array(getBytesPerCommitment());
35
+ proof.fill(0xcd);
36
+ proof[0] = 0xc0;
37
+ return proof;
38
+ },
39
+ };
40
+
41
+ // All RPC round trips (nonce, fees, gas) happen here, so only a single socket write remains to flush.
42
+ const prepared = await l1Client.prepareTransactionRequest({
43
+ blobs: [new Uint8Array(getBytesPerBlob())],
44
+ kzg: fakeKzg,
45
+ to: '0x0000000000000000000000000000000000000000',
46
+ value: 0n,
47
+ maxFeePerBlobGas: 1_000_000_000_000n,
48
+ });
49
+ const serialized = await l1Client.signTransaction(prepared);
50
+
51
+ // Fire the raw send without awaiting and swallow the expected rejection.
52
+ const sent = l1Client.request({ method: 'eth_sendRawTransaction', params: [serialized] }).catch(() => {});
53
+
54
+ // Flush the single socket write so anvil receives the tx and starts loading its trusted setup in its
55
+ // own process before we block the event loop below.
56
+ await new Promise(resolve => setImmediate(resolve));
57
+
58
+ // Synchronously build our precomp tables (~2.2s, event-loop-blocking); anvil warms in parallel.
59
+ getKzg();
60
+
61
+ await sent;
62
+ } catch (err) {
63
+ logger?.debug('Failed to warm blob KZG; falling back to lazy init', { err });
64
+ }
65
+ }
@@ -36,9 +36,20 @@ export type ChainMonitorEventMap = {
36
36
  'l2-fees': [L2FeeData];
37
37
  };
38
38
 
39
+ /** Options for tuning what the {@link ChainMonitor} polls on each new L1 block. */
40
+ export type ChainMonitorOptions = {
41
+ /**
42
+ * Whether to fetch L2 fee/oracle data (5 extra rollup reads per new L1 block) and emit `l2-fees`.
43
+ * Defaults to `true`. Set to `false` for tests that only care about slot/checkpoint/proven state to
44
+ * avoid the extra round-trips.
45
+ */
46
+ includeFeeData?: boolean;
47
+ };
48
+
39
49
  /** Utility class that polls the chain on quick intervals and logs new L1 blocks, L2 blocks, and L2 proofs. */
40
50
  export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
41
51
  private readonly l1Client: ViemClient;
52
+ private readonly includeFeeData: boolean;
42
53
  private inbox: InboxContract | undefined;
43
54
  private handle: NodeJS.Timeout | undefined;
44
55
  // eslint-disable-next-line aztec-custom/no-non-primitive-in-collections
@@ -68,9 +79,11 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
68
79
  private readonly dateProvider: DateProvider = new DateProvider(),
69
80
  private readonly logger = createLogger('aztecjs:utils:chain_monitor'),
70
81
  private readonly intervalMs = 200,
82
+ options: ChainMonitorOptions = {},
71
83
  ) {
72
84
  super();
73
85
  this.l1Client = rollup.client;
86
+ this.includeFeeData = options.includeFeeData ?? true;
74
87
  }
75
88
 
76
89
  start() {
@@ -183,11 +196,13 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
183
196
  this.emit('l2-slot', { l2SlotNumber, timestamp });
184
197
  }
185
198
 
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);
199
+ if (this.includeFeeData) {
200
+ const feeData = await this.fetchFeeData(timestamp);
201
+ if (this.hasFeeDataChanged(feeData)) {
202
+ msg += ` with L2 min fee ${feeData.minFeePerMana}`;
203
+ this.l2FeeData = feeData;
204
+ this.emit('l2-fees', feeData);
205
+ }
191
206
  }
192
207
 
193
208
  this.logger.info(msg, {
@@ -221,6 +236,11 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
221
236
  });
222
237
  }
223
238
 
239
+ public async waitUntilNextL2Slot(): Promise<void> {
240
+ const targetSlot = SlotNumber.add((await this.run()).l2SlotNumber, 1);
241
+ return this.waitUntilL2Slot(targetSlot);
242
+ }
243
+
224
244
  public waitUntilL1Block(block: number | bigint): Promise<void> {
225
245
  const targetBlock = typeof block === 'bigint' ? block.valueOf() : block;
226
246
  if (this.l1BlockNumber >= targetBlock) {
@@ -268,6 +288,74 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
268
288
  });
269
289
  }
270
290
 
291
+ /**
292
+ * Resolves with the first `checkpoint` event whose payload satisfies `match`. Unlike
293
+ * {@link waitUntilCheckpoint} (which waits for a target number), this lets callers wait for an
294
+ * arbitrary checkpoint property (e.g. one published in the first half of its slot). Rejects after
295
+ * `opts.timeout` ms if provided; otherwise waits indefinitely.
296
+ *
297
+ * By default this is purely event-driven and only resolves on the *next* matching checkpoint that
298
+ * arrives after the call. Set `checkCurrentCheckpoint` to also test the current checkpoint first (via
299
+ * a fresh {@link run} snapshot) and short-circuit if it already satisfies `match`. Use it only for
300
+ * latching state predicates (e.g. "checkpoint number has passed N"), where an already-satisfied
301
+ * result is valid and you want to avoid missing an advance that landed before the listener attached.
302
+ * Do NOT set it when the predicate depends on observing the checkpoint live (e.g. one published
303
+ * mid-slot that the caller then times against wall-clock), since it may return a checkpoint whose
304
+ * slot has already elapsed.
305
+ */
306
+ public async waitForCheckpoint(
307
+ match: (event: ChainMonitorEventMap['checkpoint'][0]) => boolean,
308
+ opts: { timeout?: number; checkCurrentCheckpoint?: boolean } = {},
309
+ ): Promise<ChainMonitorEventMap['checkpoint'][0]> {
310
+ if (opts.checkCurrentCheckpoint) {
311
+ await this.run();
312
+ const current: ChainMonitorEventMap['checkpoint'][0] = {
313
+ checkpointNumber: this.checkpointNumber,
314
+ l1BlockNumber: this.l1BlockNumber,
315
+ l2SlotNumber: this.l2SlotNumber,
316
+ timestamp: this.checkpointTimestamp,
317
+ };
318
+ if (match(current)) {
319
+ return current;
320
+ }
321
+ }
322
+ return new Promise((resolve, reject) => {
323
+ let timer: NodeJS.Timeout | undefined;
324
+ const listener = (event: ChainMonitorEventMap['checkpoint'][0]) => {
325
+ if (match(event)) {
326
+ if (timer) {
327
+ clearTimeout(timer);
328
+ }
329
+ this.off('checkpoint', listener);
330
+ resolve(event);
331
+ }
332
+ };
333
+ if (opts.timeout !== undefined) {
334
+ timer = setTimeout(() => {
335
+ this.off('checkpoint', listener);
336
+ reject(new Error(`Timed out after ${opts.timeout}ms waiting for a matching checkpoint`));
337
+ }, opts.timeout);
338
+ }
339
+ this.on('checkpoint', listener);
340
+ });
341
+ }
342
+
343
+ /** Resolves once the proven checkpoint number reaches `checkpointNumber`. */
344
+ public waitUntilCheckpointProven(checkpointNumber: CheckpointNumber): Promise<void> {
345
+ if (this.provenCheckpointNumber >= checkpointNumber) {
346
+ return Promise.resolve();
347
+ }
348
+ return new Promise(resolve => {
349
+ const listener = (data: { provenCheckpointNumber: CheckpointNumber; timestamp: bigint }) => {
350
+ if (data.provenCheckpointNumber >= checkpointNumber) {
351
+ this.off('checkpoint-proven', listener);
352
+ resolve();
353
+ }
354
+ };
355
+ this.on('checkpoint-proven', listener);
356
+ });
357
+ }
358
+
271
359
  private async fetchFeeData(timestamp: bigint): Promise<L2FeeData> {
272
360
  const [components, minFeePerMana, l1Fees, ethPerFeeAsset, manaTarget] = await Promise.all([
273
361
  this.rollup.getManaMinFeeComponentsAt(timestamp, true),
@@ -95,6 +95,16 @@ export class EthCheatCodes {
95
95
  return parseInt(res.timestamp, 16);
96
96
  }
97
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
+
98
108
  /**
99
109
  * Advance the chain by a number of blocks
100
110
  * @param numberOfBlocks - The number of blocks to mine
@@ -196,6 +206,22 @@ export class EthCheatCodes {
196
206
  }
197
207
  }
198
208
 
209
+ /**
210
+ * Starts interval mining from a freshly mined block and syncs the date provider to the block timestamp.
211
+ */
212
+ public async startIntervalMiningWithFreshBlock(seconds: number): Promise<void> {
213
+ if (seconds <= 0) {
214
+ throw new Error(`Interval mining requires a positive interval, got ${seconds}`);
215
+ }
216
+
217
+ await this.setAutomine(false);
218
+ await this.setIntervalMining(0, { silent: true });
219
+ await this.evmMine();
220
+ await this.syncDateProvider();
221
+ await this.setIntervalMining(seconds);
222
+ this.logger.warn(`Started L1 interval mining at ${seconds} seconds from a fresh block`);
223
+ }
224
+
199
225
  /**
200
226
  * Set the automine status of the underlying anvil chain
201
227
  * @param automine - The automine status to set
@@ -468,58 +494,46 @@ export class EthCheatCodes {
468
494
  }
469
495
 
470
496
  /**
471
- * Mines an empty block by temporarily removing all pending transactions from the mempool,
472
- * mining a block, and then re-adding the transactions back to the pool.
497
+ * Mines empty blocks while leaving any pending transactions untouched in the mempool.
498
+ *
499
+ * Never manipulates the mempool, so it is immune to the race that dropping and re-adding txs has against a
500
+ * concurrent publisher that is monitoring and re-broadcasting the same in-flight tx (with that approach the
501
+ * in-flight tx could reappear in the pool and be swept into the "empty" block, mining a proposal the caller
502
+ * expected to stay pending). Works in two steps: first the block gas limit is temporarily lowered below the
503
+ * intrinsic cost of any transaction (21000 gas) and the blocks are mined, so no pending tx is includable;
504
+ * then those blocks are reorged out and replaced with empty blocks mined at the restored gas limit. The
505
+ * reorg is needed because anvil applies a new gas limit only to future blocks: without it the just-mined
506
+ * blocks would keep the tiny gas limit, and an `eth_call` against `latest` (whose gas is capped by the
507
+ * block gas limit) would revert with "intrinsic gas too high".
473
508
  */
474
509
  public async mineEmptyBlock(blockCount: number = 1): Promise<void> {
475
510
  await this.execWithPausedAnvil(async () => {
476
- // Get all pending and queued transactions from the pool
477
- const txs = await this.getTxPoolContents();
478
-
479
- this.logger.debug(`Found ${txs.length} transactions in pool`);
480
-
481
- // Get raw transactions before dropping them
482
- const rawTxs: Hex[] = [];
483
- for (const tx of txs) {
484
- try {
485
- const rawTx = await this.doRpcCall('debug_getRawTransaction', [tx.hash]);
486
- if (rawTx) {
487
- rawTxs.push(rawTx);
488
- this.logger.debug(`Got raw tx for ${tx.hash}`);
489
- } else {
490
- this.logger.warn(`No raw tx found for ${tx.hash}`);
491
- }
492
- } catch {
493
- this.logger.warn(`Failed to get raw transaction for ${tx.hash}`);
494
- }
495
- }
496
-
497
- this.logger.debug(`Retrieved ${rawTxs.length} raw transactions`);
498
-
499
- // Drop all transactions from the mempool
500
- await this.doRpcCall('anvil_dropAllTransactions', []);
501
-
502
- // Mine an empty block
503
- await this.doMine(blockCount);
504
-
505
- // Re-add the transactions to the pool
506
- for (const rawTx of rawTxs) {
507
- try {
508
- const txHash = await this.doRpcCall('eth_sendRawTransaction', [rawTx]);
509
- this.logger.debug(`Re-added transaction ${txHash}`);
510
- } catch (err) {
511
- this.logger.warn(`Failed to re-add transaction: ${err}`);
512
- }
513
- }
514
-
515
- if (rawTxs.length !== txs.length) {
516
- this.logger.warn(`Failed to add all txs back: had ${txs.length} but re-added ${rawTxs.length}`);
511
+ const originalGasLimit = await this.getBlockGasLimit();
512
+ try {
513
+ await this.setBlockGasLimit(1n);
514
+ await this.doMine(blockCount);
515
+ } finally {
516
+ await this.setBlockGasLimit(originalGasLimit);
517
517
  }
518
+ // Replace the tiny-gas-limit blocks with empty blocks at the restored gas limit, keeping the same
519
+ // height and timestamps. The reorged-out blocks held no transactions, so nothing returns to the pool.
520
+ await this.doRpcCall('anvil_reorg', [blockCount, []]);
518
521
  });
519
522
 
520
523
  this.logger.warn(`Mined ${blockCount} empty L1 ${pluralize('block', blockCount)}`);
521
524
  }
522
525
 
526
+ /** Returns the gas limit of the latest mined L1 block. */
527
+ public async getBlockGasLimit(): Promise<bigint> {
528
+ const block = await this.doRpcCall('eth_getBlockByNumber', ['latest', false]);
529
+ return BigInt(block.gasLimit);
530
+ }
531
+
532
+ /** Sets the block gas limit applied to subsequently mined L1 blocks. */
533
+ public async setBlockGasLimit(gasLimit: bigint): Promise<void> {
534
+ await this.doRpcCall('anvil_setBlockGasLimit', [toHex(gasLimit)]);
535
+ }
536
+
523
537
  public async execWithPausedAnvil<T>(fn: () => Promise<T>): Promise<T> {
524
538
  const [blockInterval, wasAutoMining] = await Promise.all([this.getIntervalMining(), this.isAutoMining()]);
525
539
  try {
package/src/test/index.ts CHANGED
@@ -1,3 +1,4 @@
1
+ export * from './blob_kzg_warmup.js';
1
2
  export * from './eth_cheat_codes.js';
2
3
  export * from './eth_cheat_codes_with_state.js';
3
4
  export * from './start_anvil.js';
@@ -0,0 +1,69 @@
1
+ import { type Server, createServer } from 'node:http';
2
+
3
+ /** A JSON-RPC endpoint that records the method of every request it receives. */
4
+ export type RecordingRpcServer = {
5
+ /** URL the server listens on. */
6
+ url: string;
7
+ /** Methods of the JSON-RPC requests received so far, in arrival order. */
8
+ methods: string[];
9
+ /** Stops the server. */
10
+ close: () => Promise<void>;
11
+ };
12
+
13
+ /**
14
+ * Starts a JSON-RPC server that records the method of every request it receives, so tests can assert on what a
15
+ * client actually put on the wire. Requests are forwarded to `forwardTo` when given; otherwise the server answers
16
+ * `eth_chainId` with the anvil chain id and rejects anything else.
17
+ */
18
+ export async function startRecordingRpcServer(opts: { forwardTo?: string } = {}): Promise<RecordingRpcServer> {
19
+ const methods: string[] = [];
20
+
21
+ const server: Server = createServer((req, res) => {
22
+ const chunks: Buffer[] = [];
23
+ req.on('data', chunk => chunks.push(Buffer.from(chunk)));
24
+ req.on('end', () => {
25
+ void (async () => {
26
+ const body = Buffer.concat(chunks).toString();
27
+ const parsed: unknown = body.length > 0 ? JSON.parse(body) : undefined;
28
+ const requests = Array.isArray(parsed) ? parsed : [parsed];
29
+ for (const request of requests) {
30
+ const method = (request as { method?: string } | undefined)?.method;
31
+ if (typeof method === 'string') {
32
+ methods.push(method);
33
+ }
34
+ }
35
+
36
+ if (opts.forwardTo) {
37
+ const response = await fetch(opts.forwardTo, {
38
+ method: 'POST',
39
+ headers: { 'content-type': 'application/json' },
40
+ body,
41
+ });
42
+ res.writeHead(response.status, { 'content-type': 'application/json' });
43
+ res.end(await response.text());
44
+ return;
45
+ }
46
+
47
+ const id = (requests[0] as { id?: number } | undefined)?.id ?? 1;
48
+ const result =
49
+ methods[methods.length - 1] === 'eth_chainId'
50
+ ? { jsonrpc: '2.0', id, result: '0x7a69' }
51
+ : { jsonrpc: '2.0', id, error: { code: -32601, message: 'method not handled by test server' } };
52
+ res.writeHead(200, { 'content-type': 'application/json' });
53
+ res.end(JSON.stringify(result));
54
+ })();
55
+ });
56
+ });
57
+
58
+ await new Promise<void>(resolve => server.listen(0, '127.0.0.1', resolve));
59
+ const address = server.address();
60
+ if (!address || typeof address === 'string') {
61
+ throw new Error('Expected recording RPC server to listen on a TCP port');
62
+ }
63
+
64
+ return {
65
+ url: `http://127.0.0.1:${address.port}`,
66
+ methods,
67
+ close: () => new Promise<void>(resolve => server.close(() => resolve())),
68
+ };
69
+ }