@aztec/ethereum 5.0.0-rc.2 → 5.0.0
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.
- package/dest/config.d.ts +10 -1
- package/dest/config.d.ts.map +1 -1
- package/dest/config.js +24 -0
- package/dest/deploy_aztec_l1_contracts.d.ts +2 -2
- package/dest/deploy_aztec_l1_contracts.d.ts.map +1 -1
- package/dest/deploy_aztec_l1_contracts.js +2 -0
- package/dest/l1_tx_utils/config.js +3 -3
- package/dest/l1_tx_utils/l1_tx_utils.d.ts +1 -1
- package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
- package/dest/l1_tx_utils/l1_tx_utils.js +57 -15
- package/dest/publisher_manager.d.ts +18 -6
- package/dest/publisher_manager.d.ts.map +1 -1
- package/dest/publisher_manager.js +35 -6
- package/dest/test/blob_kzg_warmup.d.ts +19 -0
- package/dest/test/blob_kzg_warmup.d.ts.map +1 -0
- package/dest/test/blob_kzg_warmup.js +64 -0
- package/dest/test/chain_monitor.d.ts +33 -2
- package/dest/test/chain_monitor.d.ts.map +1 -1
- package/dest/test/chain_monitor.js +71 -6
- package/dest/test/eth_cheat_codes.d.ts +20 -3
- package/dest/test/eth_cheat_codes.d.ts.map +1 -1
- package/dest/test/eth_cheat_codes.js +50 -40
- package/dest/test/index.d.ts +2 -1
- package/dest/test/index.d.ts.map +1 -1
- package/dest/test/index.js +1 -0
- package/dest/test/rollup_cheat_codes.d.ts +30 -1
- package/dest/test/rollup_cheat_codes.d.ts.map +1 -1
- package/dest/test/rollup_cheat_codes.js +27 -0
- package/package.json +5 -5
- package/src/config.ts +35 -0
- package/src/deploy_aztec_l1_contracts.ts +2 -1
- package/src/l1_tx_utils/config.ts +3 -3
- package/src/l1_tx_utils/l1_tx_utils.ts +52 -18
- package/src/publisher_manager.ts +44 -17
- package/src/test/blob_kzg_warmup.ts +65 -0
- package/src/test/chain_monitor.ts +88 -5
- package/src/test/eth_cheat_codes.ts +47 -43
- package/src/test/index.ts +1 -0
- package/src/test/rollup_cheat_codes.ts +51 -0
|
@@ -73,7 +73,7 @@ export const l1TxUtilsConfigMappings: ConfigMappingsType<L1TxUtilsConfig> = {
|
|
|
73
73
|
gasLimitBufferPercentage: {
|
|
74
74
|
description: 'How much to increase calculated gas limit by (percentage)',
|
|
75
75
|
env: 'L1_GAS_LIMIT_BUFFER_PERCENTAGE',
|
|
76
|
-
...
|
|
76
|
+
...floatConfigHelper(20),
|
|
77
77
|
},
|
|
78
78
|
maxGwei: {
|
|
79
79
|
description: 'Maximum gas price in gwei to be used for transactions.',
|
|
@@ -90,12 +90,12 @@ export const l1TxUtilsConfigMappings: ConfigMappingsType<L1TxUtilsConfig> = {
|
|
|
90
90
|
priorityFeeBumpPercentage: {
|
|
91
91
|
description: 'How much to increase priority fee by each attempt (percentage)',
|
|
92
92
|
env: 'L1_PRIORITY_FEE_BUMP_PERCENTAGE',
|
|
93
|
-
...
|
|
93
|
+
...floatConfigHelper(20),
|
|
94
94
|
},
|
|
95
95
|
priorityFeeRetryBumpPercentage: {
|
|
96
96
|
description: 'How much to increase priority fee by each retry attempt (percentage)',
|
|
97
97
|
env: 'L1_PRIORITY_FEE_RETRY_BUMP_PERCENTAGE',
|
|
98
|
-
...
|
|
98
|
+
...floatConfigHelper(50),
|
|
99
99
|
},
|
|
100
100
|
minimumPriorityFeePerGas: {
|
|
101
101
|
description:
|
|
@@ -5,7 +5,7 @@ import { InterruptError, TimeoutError } from '@aztec/foundation/error';
|
|
|
5
5
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
6
6
|
import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
|
|
7
7
|
import { Semaphore } from '@aztec/foundation/queue';
|
|
8
|
-
import { retryUntil } from '@aztec/foundation/retry';
|
|
8
|
+
import { makeBackoff, retry, retryUntil } from '@aztec/foundation/retry';
|
|
9
9
|
import { sleep } from '@aztec/foundation/sleep';
|
|
10
10
|
import { DateProvider } from '@aztec/foundation/timer';
|
|
11
11
|
import { RollupAbi } from '@aztec/l1-artifacts/RollupAbi';
|
|
@@ -44,6 +44,11 @@ import {
|
|
|
44
44
|
|
|
45
45
|
const MAX_L1_TX_STATES = 32;
|
|
46
46
|
|
|
47
|
+
// Backoff (in seconds) for retrying the read-only RPC calls that prepare a tx cancellation. A
|
|
48
|
+
// cancellation is fired in the background after a tx times out and is important (it frees the stuck
|
|
49
|
+
// nonce), so a transient RPC failure while reading the pending nonce or gas price must not abandon it.
|
|
50
|
+
const CANCELLATION_PREP_RETRY_BACKOFF_S = [1, 2, 4, 8];
|
|
51
|
+
|
|
47
52
|
export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
48
53
|
protected txs: L1TxState[] = [];
|
|
49
54
|
/** Last nonce successfully sent to the chain. Used as a lower bound when a fallback RPC node returns a stale count. */
|
|
@@ -431,10 +436,23 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
431
436
|
|
|
432
437
|
const initialTxHash = txHashes[0];
|
|
433
438
|
let currentTxHash = txHashes.at(-1)!;
|
|
434
|
-
let l1Timestamp
|
|
439
|
+
let l1Timestamp = 0;
|
|
435
440
|
|
|
436
441
|
while (true) {
|
|
437
|
-
|
|
442
|
+
try {
|
|
443
|
+
l1Timestamp = await this.getL1Timestamp();
|
|
444
|
+
} catch (err) {
|
|
445
|
+
// A transient RPC failure here must not abort monitoring with a rejection: callers that
|
|
446
|
+
// fire this loop in the background would surface it as an unhandled rejection (e.g. when a
|
|
447
|
+
// test tears down its L1 node while a monitor iteration is in flight). Exit quietly if we
|
|
448
|
+
// are shutting down, otherwise retry on the next interval.
|
|
449
|
+
if (this.interrupted) {
|
|
450
|
+
break;
|
|
451
|
+
}
|
|
452
|
+
this.logger.error(`Error fetching L1 timestamp while monitoring tx ${currentTxHash}`, err, { nonce, account });
|
|
453
|
+
await sleep(gasConfig.checkIntervalMs!);
|
|
454
|
+
continue;
|
|
455
|
+
}
|
|
438
456
|
|
|
439
457
|
try {
|
|
440
458
|
const timePassed = l1Timestamp - state.lastSentAtL1Ts.getTime();
|
|
@@ -706,9 +724,37 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
706
724
|
return;
|
|
707
725
|
}
|
|
708
726
|
|
|
709
|
-
//
|
|
710
|
-
|
|
711
|
-
|
|
727
|
+
// Resolve the pending nonce and cancellation gas price up front. These are read-only RPC calls, so
|
|
728
|
+
// they are safe to retry; a transient RPC failure here must not permanently abandon the cancellation
|
|
729
|
+
// (which would leave the nonce stuck and the tx state stranded short of CANCELLED). We retry with a
|
|
730
|
+
// real backoff before giving up, unlike getGasPrice's tight internal retry which can be exhausted by
|
|
731
|
+
// a brief node hiccup. The retried block performs no state-changing send, so retrying cannot
|
|
732
|
+
// double-send the cancellation tx.
|
|
733
|
+
const { currentNonce, cancelGasPrice } = await retry(
|
|
734
|
+
async () => {
|
|
735
|
+
const currentNonce = await this.client.getTransactionCount({ address: account, blockTag: 'pending' });
|
|
736
|
+
if (currentNonce >= nonce) {
|
|
737
|
+
// Get gas price with higher priority fee for cancellation
|
|
738
|
+
const cancelGasPrice = await this.getGasPrice(
|
|
739
|
+
{
|
|
740
|
+
...this.config,
|
|
741
|
+
// Use high bump for cancellation to ensure it replaces the original tx
|
|
742
|
+
priorityFeeRetryBumpPercentage: 150, // 150% bump should be enough to replace any tx
|
|
743
|
+
},
|
|
744
|
+
isBlobTx,
|
|
745
|
+
state.txHashes.length,
|
|
746
|
+
previousGasPrice,
|
|
747
|
+
);
|
|
748
|
+
return { currentNonce, cancelGasPrice };
|
|
749
|
+
}
|
|
750
|
+
return { currentNonce, cancelGasPrice: undefined };
|
|
751
|
+
},
|
|
752
|
+
`Preparing cancellation for L1 tx from account ${account} with nonce ${nonce}`,
|
|
753
|
+
makeBackoff(CANCELLATION_PREP_RETRY_BACKOFF_S),
|
|
754
|
+
this.logger,
|
|
755
|
+
);
|
|
756
|
+
|
|
757
|
+
if (cancelGasPrice === undefined) {
|
|
712
758
|
this.logger.verbose(
|
|
713
759
|
`Not sending cancellation for L1 tx from account ${account} with nonce ${nonce} as it is dropped`,
|
|
714
760
|
{ nonce, account, currentNonce },
|
|
@@ -717,18 +763,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
717
763
|
return;
|
|
718
764
|
}
|
|
719
765
|
|
|
720
|
-
// Get gas price with higher priority fee for cancellation
|
|
721
|
-
const cancelGasPrice = await this.getGasPrice(
|
|
722
|
-
{
|
|
723
|
-
...this.config,
|
|
724
|
-
// Use high bump for cancellation to ensure it replaces the original tx
|
|
725
|
-
priorityFeeRetryBumpPercentage: 150, // 150% bump should be enough to replace any tx
|
|
726
|
-
},
|
|
727
|
-
isBlobTx,
|
|
728
|
-
state.txHashes.length,
|
|
729
|
-
previousGasPrice,
|
|
730
|
-
);
|
|
731
|
-
|
|
732
766
|
const { maxFeePerGas, maxPriorityFeePerGas, maxFeePerBlobGas } = cancelGasPrice;
|
|
733
767
|
this.logger.verbose(
|
|
734
768
|
`Attempting to cancel L1 ${isBlobTx ? 'blob' : 'vanilla'} transaction from account ${account} with nonce ${nonce} after time out`,
|
package/src/publisher_manager.ts
CHANGED
|
@@ -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
|
-
|
|
44
|
-
|
|
43
|
+
protected funder?: UtilsType;
|
|
44
|
+
protected readonly fundingPromise?: RunningPromise;
|
|
45
|
+
private started = false;
|
|
45
46
|
|
|
46
47
|
constructor(
|
|
47
|
-
|
|
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
|
-
/**
|
|
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
|
-
|
|
80
|
-
|
|
81
|
-
|
|
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
|
-
/**
|
|
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
|
|
@@ -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
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
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, {
|
|
@@ -273,6 +288,74 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
|
|
|
273
288
|
});
|
|
274
289
|
}
|
|
275
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
|
+
|
|
276
359
|
private async fetchFeeData(timestamp: bigint): Promise<L2FeeData> {
|
|
277
360
|
const [components, minFeePerMana, l1Fees, ethPerFeeAsset, manaTarget] = await Promise.all([
|
|
278
361
|
this.rollup.getManaMinFeeComponentsAt(timestamp, true),
|
|
@@ -206,6 +206,22 @@ export class EthCheatCodes {
|
|
|
206
206
|
}
|
|
207
207
|
}
|
|
208
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
|
+
|
|
209
225
|
/**
|
|
210
226
|
* Set the automine status of the underlying anvil chain
|
|
211
227
|
* @param automine - The automine status to set
|
|
@@ -478,58 +494,46 @@ export class EthCheatCodes {
|
|
|
478
494
|
}
|
|
479
495
|
|
|
480
496
|
/**
|
|
481
|
-
* Mines
|
|
482
|
-
*
|
|
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".
|
|
483
508
|
*/
|
|
484
509
|
public async mineEmptyBlock(blockCount: number = 1): Promise<void> {
|
|
485
510
|
await this.execWithPausedAnvil(async () => {
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
const rawTxs: Hex[] = [];
|
|
493
|
-
for (const tx of txs) {
|
|
494
|
-
try {
|
|
495
|
-
const rawTx = await this.doRpcCall('debug_getRawTransaction', [tx.hash]);
|
|
496
|
-
if (rawTx) {
|
|
497
|
-
rawTxs.push(rawTx);
|
|
498
|
-
this.logger.debug(`Got raw tx for ${tx.hash}`);
|
|
499
|
-
} else {
|
|
500
|
-
this.logger.warn(`No raw tx found for ${tx.hash}`);
|
|
501
|
-
}
|
|
502
|
-
} catch {
|
|
503
|
-
this.logger.warn(`Failed to get raw transaction for ${tx.hash}`);
|
|
504
|
-
}
|
|
505
|
-
}
|
|
506
|
-
|
|
507
|
-
this.logger.debug(`Retrieved ${rawTxs.length} raw transactions`);
|
|
508
|
-
|
|
509
|
-
// Drop all transactions from the mempool
|
|
510
|
-
await this.doRpcCall('anvil_dropAllTransactions', []);
|
|
511
|
-
|
|
512
|
-
// Mine an empty block
|
|
513
|
-
await this.doMine(blockCount);
|
|
514
|
-
|
|
515
|
-
// Re-add the transactions to the pool
|
|
516
|
-
for (const rawTx of rawTxs) {
|
|
517
|
-
try {
|
|
518
|
-
const txHash = await this.doRpcCall('eth_sendRawTransaction', [rawTx]);
|
|
519
|
-
this.logger.debug(`Re-added transaction ${txHash}`);
|
|
520
|
-
} catch (err) {
|
|
521
|
-
this.logger.warn(`Failed to re-add transaction: ${err}`);
|
|
522
|
-
}
|
|
523
|
-
}
|
|
524
|
-
|
|
525
|
-
if (rawTxs.length !== txs.length) {
|
|
526
|
-
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);
|
|
527
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, []]);
|
|
528
521
|
});
|
|
529
522
|
|
|
530
523
|
this.logger.warn(`Mined ${blockCount} empty L1 ${pluralize('block', blockCount)}`);
|
|
531
524
|
}
|
|
532
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
|
+
|
|
533
537
|
public async execWithPausedAnvil<T>(fn: () => Promise<T>): Promise<T> {
|
|
534
538
|
const [blockInterval, wasAutoMining] = await Promise.all([this.getIntervalMining(), this.isAutoMining()]);
|
|
535
539
|
try {
|
package/src/test/index.ts
CHANGED
|
@@ -4,6 +4,7 @@ import type { ViemPublicClient } from '@aztec/ethereum/types';
|
|
|
4
4
|
import { CheckpointNumber, EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
|
|
5
5
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
6
6
|
import { createLogger } from '@aztec/foundation/log';
|
|
7
|
+
import { retryUntil } from '@aztec/foundation/retry';
|
|
7
8
|
import type { DateProvider } from '@aztec/foundation/timer';
|
|
8
9
|
import { RollupAbi } from '@aztec/l1-artifacts/RollupAbi';
|
|
9
10
|
|
|
@@ -244,6 +245,56 @@ export class RollupCheatCodes {
|
|
|
244
245
|
});
|
|
245
246
|
}
|
|
246
247
|
|
|
248
|
+
/**
|
|
249
|
+
* Polls the rollup until its current epoch reaches `epoch`. Unlike {@link advanceToEpoch} this does
|
|
250
|
+
* not warp the L1 clock; it only waits for the chain to reach `epoch` through external activity.
|
|
251
|
+
*/
|
|
252
|
+
public async waitForEpoch(epoch: EpochNumber, opts: { timeout?: number; interval?: number } = {}): Promise<void> {
|
|
253
|
+
await retryUntil(
|
|
254
|
+
async () => (await this.getEpoch()) >= epoch || undefined,
|
|
255
|
+
`rollup epoch >= ${epoch}`,
|
|
256
|
+
opts.timeout ?? 60,
|
|
257
|
+
opts.interval ?? 1,
|
|
258
|
+
);
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* Polls the rollup until its current slot reaches `slot`. Unlike {@link advanceToSlot} this does not
|
|
263
|
+
* warp the L1 clock; it only waits for the chain to reach `slot` through external activity.
|
|
264
|
+
*/
|
|
265
|
+
public async waitForSlot(slot: SlotNumber, opts: { timeout?: number; interval?: number } = {}): Promise<void> {
|
|
266
|
+
await retryUntil(
|
|
267
|
+
async () => (await this.getSlot()) >= slot || undefined,
|
|
268
|
+
`rollup slot >= ${slot}`,
|
|
269
|
+
opts.timeout ?? 60,
|
|
270
|
+
opts.interval ?? 1,
|
|
271
|
+
);
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
/**
|
|
275
|
+
* Polls the rollup until its pending checkpoint settles below `checkpoint` on a freshly mined, non-zero
|
|
276
|
+
* checkpoint, and returns that new pending checkpoint number. Reads the L1 rollup contract directly
|
|
277
|
+
* rather than a node, since a rollback lands on L1 first.
|
|
278
|
+
*
|
|
279
|
+
* A prune can momentarily drop the pending checkpoint to 0 before the post-deadline propose mines its
|
|
280
|
+
* replacement, so a caller detecting a rollback wants the new lower checkpoint, not that transient
|
|
281
|
+
* empty state — hence the non-zero guard.
|
|
282
|
+
*/
|
|
283
|
+
public async waitForCheckpointBelow(
|
|
284
|
+
checkpoint: CheckpointNumber,
|
|
285
|
+
opts: { timeout?: number; interval?: number } = {},
|
|
286
|
+
): Promise<CheckpointNumber> {
|
|
287
|
+
return await retryUntil(
|
|
288
|
+
async () => {
|
|
289
|
+
const { pending } = await this.getTips();
|
|
290
|
+
return pending > 0 && pending < checkpoint ? pending : undefined;
|
|
291
|
+
},
|
|
292
|
+
`rollup checkpoint in (0, ${checkpoint})`,
|
|
293
|
+
opts.timeout ?? 60,
|
|
294
|
+
opts.interval ?? 1,
|
|
295
|
+
);
|
|
296
|
+
}
|
|
297
|
+
|
|
247
298
|
/**
|
|
248
299
|
* Overrides the inProgress field of the Inbox contract state
|
|
249
300
|
* @param howMuch - How many checkpoints to move it forward
|