@aztec/ethereum 0.0.1-commit.9d2bcf6d → 0.0.1-commit.9ee6fcc6
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/client.d.ts +10 -2
- package/dest/client.d.ts.map +1 -1
- package/dest/client.js +13 -7
- package/dest/config.d.ts +3 -1
- package/dest/config.d.ts.map +1 -1
- package/dest/config.js +11 -3
- package/dest/contracts/empire_base.d.ts +3 -1
- package/dest/contracts/empire_base.d.ts.map +1 -1
- package/dest/contracts/empire_slashing_proposer.d.ts +3 -1
- package/dest/contracts/empire_slashing_proposer.d.ts.map +1 -1
- package/dest/contracts/empire_slashing_proposer.js +9 -0
- package/dest/contracts/fee_asset_price_oracle.d.ts +101 -0
- package/dest/contracts/fee_asset_price_oracle.d.ts.map +1 -0
- package/dest/contracts/fee_asset_price_oracle.js +651 -0
- package/dest/contracts/governance.js +3 -3
- package/dest/contracts/governance_proposer.d.ts +3 -1
- package/dest/contracts/governance_proposer.d.ts.map +1 -1
- package/dest/contracts/governance_proposer.js +9 -0
- package/dest/contracts/index.d.ts +2 -1
- package/dest/contracts/index.d.ts.map +1 -1
- package/dest/contracts/index.js +1 -0
- package/dest/contracts/multicall.d.ts +51 -2
- package/dest/contracts/multicall.d.ts.map +1 -1
- package/dest/contracts/multicall.js +85 -0
- package/dest/contracts/registry.d.ts +3 -1
- package/dest/contracts/registry.d.ts.map +1 -1
- package/dest/contracts/registry.js +30 -1
- package/dest/contracts/rollup.d.ts +22 -8
- package/dest/contracts/rollup.d.ts.map +1 -1
- package/dest/contracts/rollup.js +64 -12
- package/dest/deploy_aztec_l1_contracts.d.ts +2 -3
- package/dest/deploy_aztec_l1_contracts.d.ts.map +1 -1
- package/dest/deploy_aztec_l1_contracts.js +33 -19
- package/dest/deploy_l1_contract.js +3 -3
- package/dest/generated/l1-contracts-defaults.d.ts +1 -1
- package/dest/generated/l1-contracts-defaults.js +1 -1
- package/dest/l1_artifacts.d.ts +1051 -42
- package/dest/l1_artifacts.d.ts.map +1 -1
- package/dest/l1_reader.d.ts +3 -1
- package/dest/l1_reader.d.ts.map +1 -1
- package/dest/l1_reader.js +6 -1
- package/dest/l1_tx_utils/config.d.ts +7 -1
- package/dest/l1_tx_utils/config.d.ts.map +1 -1
- package/dest/l1_tx_utils/config.js +14 -1
- package/dest/l1_tx_utils/factory.d.ts +18 -10
- package/dest/l1_tx_utils/factory.d.ts.map +1 -1
- package/dest/l1_tx_utils/factory.js +17 -7
- package/dest/l1_tx_utils/fee-strategies/p75_competitive.js +1 -1
- package/dest/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.js +1 -1
- package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts +15 -15
- package/dest/l1_tx_utils/forwarder_l1_tx_utils.d.ts.map +1 -1
- package/dest/l1_tx_utils/forwarder_l1_tx_utils.js +9 -15
- package/dest/l1_tx_utils/index-blobs.d.ts +3 -3
- package/dest/l1_tx_utils/index-blobs.d.ts.map +1 -1
- package/dest/l1_tx_utils/index-blobs.js +2 -2
- package/dest/l1_tx_utils/index.d.ts +2 -1
- package/dest/l1_tx_utils/index.d.ts.map +1 -1
- package/dest/l1_tx_utils/index.js +1 -0
- package/dest/l1_tx_utils/l1_tx_utils.d.ts +18 -7
- package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
- package/dest/l1_tx_utils/l1_tx_utils.js +52 -36
- package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts +1 -1
- package/dest/l1_tx_utils/readonly_l1_tx_utils.d.ts.map +1 -1
- package/dest/l1_tx_utils/readonly_l1_tx_utils.js +8 -4
- package/dest/l1_tx_utils/tx_delayer.d.ts +56 -0
- package/dest/l1_tx_utils/tx_delayer.d.ts.map +1 -0
- package/dest/{test → l1_tx_utils}/tx_delayer.js +62 -34
- package/dest/publisher_manager.d.ts +21 -7
- package/dest/publisher_manager.d.ts.map +1 -1
- package/dest/publisher_manager.js +81 -7
- package/dest/test/chain_monitor.d.ts +22 -3
- package/dest/test/chain_monitor.d.ts.map +1 -1
- package/dest/test/chain_monitor.js +33 -2
- package/dest/test/eth_cheat_codes.d.ts +6 -4
- package/dest/test/eth_cheat_codes.d.ts.map +1 -1
- package/dest/test/eth_cheat_codes.js +6 -4
- package/dest/test/index.d.ts +1 -3
- package/dest/test/index.d.ts.map +1 -1
- package/dest/test/index.js +0 -2
- package/dest/test/start_anvil.d.ts +23 -3
- package/dest/test/start_anvil.d.ts.map +1 -1
- package/dest/test/start_anvil.js +143 -29
- package/dest/test/upgrade_utils.js +2 -2
- package/dest/utils.d.ts +1 -1
- package/dest/utils.d.ts.map +1 -1
- package/dest/utils.js +16 -12
- package/package.json +5 -7
- package/src/client.ts +10 -2
- package/src/config.ts +15 -2
- package/src/contracts/empire_base.ts +2 -0
- package/src/contracts/empire_slashing_proposer.ts +6 -0
- package/src/contracts/fee_asset_price_oracle.ts +280 -0
- package/src/contracts/governance.ts +3 -3
- package/src/contracts/governance_proposer.ts +6 -0
- package/src/contracts/index.ts +1 -0
- package/src/contracts/multicall.ts +65 -1
- package/src/contracts/registry.ts +31 -1
- package/src/contracts/rollup.ts +75 -16
- package/src/deploy_aztec_l1_contracts.ts +56 -29
- package/src/deploy_l1_contract.ts +3 -3
- package/src/generated/l1-contracts-defaults.ts +1 -1
- package/src/l1_reader.ts +13 -1
- package/src/l1_tx_utils/config.ts +20 -0
- package/src/l1_tx_utils/factory.ts +31 -31
- package/src/l1_tx_utils/fee-strategies/p75_competitive.ts +1 -1
- package/src/l1_tx_utils/fee-strategies/p75_competitive_blob_txs_only.ts +1 -1
- package/src/l1_tx_utils/forwarder_l1_tx_utils.ts +43 -54
- package/src/l1_tx_utils/index-blobs.ts +2 -2
- package/src/l1_tx_utils/index.ts +1 -0
- package/src/l1_tx_utils/l1_tx_utils.ts +54 -26
- package/src/l1_tx_utils/readonly_l1_tx_utils.ts +8 -4
- package/src/{test → l1_tx_utils}/tx_delayer.ts +78 -50
- package/src/publisher_manager.ts +105 -10
- package/src/test/chain_monitor.ts +60 -3
- package/src/test/eth_cheat_codes.ts +6 -4
- package/src/test/index.ts +0 -2
- package/src/test/start_anvil.ts +177 -29
- package/src/test/upgrade_utils.ts +2 -2
- package/src/utils.ts +17 -14
- package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts +0 -26
- package/dest/l1_tx_utils/l1_tx_utils_with_blobs.d.ts.map +0 -1
- package/dest/l1_tx_utils/l1_tx_utils_with_blobs.js +0 -26
- package/dest/test/delayed_tx_utils.d.ts +0 -13
- package/dest/test/delayed_tx_utils.d.ts.map +0 -1
- package/dest/test/delayed_tx_utils.js +0 -28
- package/dest/test/tx_delayer.d.ts +0 -36
- package/dest/test/tx_delayer.d.ts.map +0 -1
- package/src/l1_tx_utils/l1_tx_utils_with_blobs.ts +0 -77
- package/src/test/delayed_tx_utils.ts +0 -52
|
@@ -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';
|
|
@@ -13,16 +14,13 @@ import {
|
|
|
13
14
|
type Abi,
|
|
14
15
|
type BlockOverrides,
|
|
15
16
|
type Hex,
|
|
16
|
-
type NonceManager,
|
|
17
17
|
type PrepareTransactionRequestRequest,
|
|
18
18
|
type StateOverride,
|
|
19
19
|
type TransactionReceipt,
|
|
20
20
|
type TransactionSerializable,
|
|
21
|
-
createNonceManager,
|
|
22
21
|
formatGwei,
|
|
23
22
|
serializeTransaction,
|
|
24
23
|
} from 'viem';
|
|
25
|
-
import { jsonRpc } from 'viem/nonce';
|
|
26
24
|
|
|
27
25
|
import type { ViemClient } from '../types.js';
|
|
28
26
|
import { formatViemError } from '../utils.js';
|
|
@@ -30,6 +28,7 @@ import { type L1TxUtilsConfig, l1TxUtilsConfigMappings } from './config.js';
|
|
|
30
28
|
import { MAX_L1_TX_LIMIT } from './constants.js';
|
|
31
29
|
import type { IL1TxMetrics, IL1TxStore } from './interfaces.js';
|
|
32
30
|
import { ReadOnlyL1TxUtils } from './readonly_l1_tx_utils.js';
|
|
31
|
+
import { Delayer, createDelayer, wrapClientWithDelayer } from './tx_delayer.js';
|
|
33
32
|
import {
|
|
34
33
|
DroppedTransactionError,
|
|
35
34
|
type L1BlobInputs,
|
|
@@ -45,8 +44,13 @@ import {
|
|
|
45
44
|
const MAX_L1_TX_STATES = 32;
|
|
46
45
|
|
|
47
46
|
export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
48
|
-
protected nonceManager: NonceManager;
|
|
49
47
|
protected txs: L1TxState[] = [];
|
|
48
|
+
/** Last nonce successfully sent to the chain. Used as a lower bound when a fallback RPC node returns a stale count. */
|
|
49
|
+
private lastSentNonce: number | undefined;
|
|
50
|
+
/** Tx delayer for testing. Only set when enableDelayer config is true. */
|
|
51
|
+
public delayer?: Delayer;
|
|
52
|
+
/** KZG instance for blob operations. */
|
|
53
|
+
protected kzg?: BlobKzgInstance;
|
|
50
54
|
|
|
51
55
|
constructor(
|
|
52
56
|
public override client: ViemClient,
|
|
@@ -58,9 +62,25 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
58
62
|
debugMaxGasLimit: boolean = false,
|
|
59
63
|
protected store?: IL1TxStore,
|
|
60
64
|
protected metrics?: IL1TxMetrics,
|
|
65
|
+
kzg?: BlobKzgInstance,
|
|
66
|
+
delayer?: Delayer,
|
|
61
67
|
) {
|
|
62
68
|
super(client, logger, dateProvider, config, debugMaxGasLimit);
|
|
63
|
-
this.
|
|
69
|
+
this.kzg = kzg;
|
|
70
|
+
|
|
71
|
+
// Set up delayer: use provided one or create new
|
|
72
|
+
if (config?.enableDelayer && config?.ethereumSlotDuration) {
|
|
73
|
+
this.delayer =
|
|
74
|
+
delayer ?? this.createDelayer({ ethereumSlotDuration: config.ethereumSlotDuration }, logger.getBindings());
|
|
75
|
+
this.client = wrapClientWithDelayer(this.client, this.delayer);
|
|
76
|
+
if (config.txDelayerMaxInclusionTimeIntoSlot !== undefined) {
|
|
77
|
+
this.delayer.setMaxInclusionTimeIntoSlot(config.txDelayerMaxInclusionTimeIntoSlot);
|
|
78
|
+
}
|
|
79
|
+
} else if (delayer) {
|
|
80
|
+
// Delayer provided but enableDelayer not set — just store it without wrapping
|
|
81
|
+
logger.warn('Delayer provided but enableDelayer config is not set; delayer will not be used');
|
|
82
|
+
this.delayer = delayer;
|
|
83
|
+
}
|
|
64
84
|
}
|
|
65
85
|
|
|
66
86
|
public get state() {
|
|
@@ -87,6 +107,11 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
87
107
|
this.metrics?.recordMinedTx(l1TxState, new Date(l1Timestamp));
|
|
88
108
|
} else if (newState === TxUtilsState.NOT_MINED) {
|
|
89
109
|
this.metrics?.recordDroppedTx(l1TxState);
|
|
110
|
+
// The tx was dropped: the chain nonce reverted to l1TxState.nonce, so our lower bound is
|
|
111
|
+
// no longer valid. Clear it so the next send fetches the real nonce from the chain.
|
|
112
|
+
if (this.lastSentNonce === l1TxState.nonce) {
|
|
113
|
+
this.lastSentNonce = undefined;
|
|
114
|
+
}
|
|
90
115
|
}
|
|
91
116
|
|
|
92
117
|
// Update state in the store
|
|
@@ -221,15 +246,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
221
246
|
throw new InterruptError(`Transaction sending is interrupted`);
|
|
222
247
|
}
|
|
223
248
|
|
|
224
|
-
const nonce = await this.nonceManager.consume({
|
|
225
|
-
client: this.client,
|
|
226
|
-
address: account,
|
|
227
|
-
chainId: this.client.chain.id,
|
|
228
|
-
});
|
|
229
|
-
|
|
230
|
-
const baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
|
|
231
|
-
const txData = this.makeTxData(baseState, { isCancelTx: false });
|
|
232
|
-
|
|
233
249
|
const now = new Date(await this.getL1Timestamp());
|
|
234
250
|
if (gasConfig.txTimeoutAt && now > gasConfig.txTimeoutAt) {
|
|
235
251
|
throw new TimeoutError(
|
|
@@ -237,9 +253,20 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
237
253
|
);
|
|
238
254
|
}
|
|
239
255
|
|
|
256
|
+
const chainNonce = await this.client.getTransactionCount({ address: account, blockTag: 'pending' });
|
|
257
|
+
// If a fallback RPC node returns a stale count (lower than what we last sent), use our
|
|
258
|
+
// local lower bound to avoid sending a duplicate of an already-pending transaction.
|
|
259
|
+
const nonce =
|
|
260
|
+
this.lastSentNonce !== undefined && chainNonce <= this.lastSentNonce ? this.lastSentNonce + 1 : chainNonce;
|
|
261
|
+
|
|
262
|
+
const baseState = { request, gasLimit, blobInputs, gasPrice, nonce };
|
|
263
|
+
const txData = this.makeTxData(baseState, { isCancelTx: false });
|
|
264
|
+
|
|
240
265
|
// Send the new tx
|
|
241
266
|
const signedRequest = await this.prepareSignedTransaction(txData);
|
|
242
267
|
const txHash = await this.client.sendRawTransaction({ serializedTransaction: signedRequest });
|
|
268
|
+
// Update after tx is sent successfully
|
|
269
|
+
this.lastSentNonce = nonce;
|
|
243
270
|
|
|
244
271
|
// Create the new state for monitoring
|
|
245
272
|
const l1TxState: L1TxState = {
|
|
@@ -423,7 +450,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
423
450
|
{ nonce, account, pendingNonce, timePassed },
|
|
424
451
|
);
|
|
425
452
|
await this.updateState(state, TxUtilsState.NOT_MINED);
|
|
426
|
-
this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
|
|
427
453
|
throw new DroppedTransactionError(nonce, account);
|
|
428
454
|
}
|
|
429
455
|
|
|
@@ -515,12 +541,7 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
515
541
|
|
|
516
542
|
// Oh no, the transaction has timed out!
|
|
517
543
|
if (isCancelTx || !gasConfig.cancelTxOnTimeout) {
|
|
518
|
-
// If this was already a cancellation tx, or we are configured to not cancel txs, we just mark it as NOT_MINED
|
|
519
|
-
// and reset the nonce manager, so the next tx that comes along can reuse the nonce if/when this tx gets dropped.
|
|
520
|
-
// This is the nastiest scenario for us, since the new tx could acquire the next nonce, but then this tx is dropped,
|
|
521
|
-
// and the new tx would never get mined. Eventually, the new tx would also drop.
|
|
522
544
|
await this.updateState(state, TxUtilsState.NOT_MINED);
|
|
523
|
-
this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
|
|
524
545
|
} else {
|
|
525
546
|
// Otherwise we fire the cancellation without awaiting to avoid blocking the caller,
|
|
526
547
|
// and monitor it in the background so we can speed it up as needed.
|
|
@@ -659,7 +680,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
659
680
|
{ nonce, account },
|
|
660
681
|
);
|
|
661
682
|
await this.updateState(state, TxUtilsState.NOT_MINED);
|
|
662
|
-
this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
|
|
663
683
|
return;
|
|
664
684
|
}
|
|
665
685
|
|
|
@@ -671,7 +691,6 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
671
691
|
{ nonce, account, currentNonce },
|
|
672
692
|
);
|
|
673
693
|
await this.updateState(state, TxUtilsState.NOT_MINED);
|
|
674
|
-
this.nonceManager.reset({ address: account, chainId: this.client.chain.id });
|
|
675
694
|
return;
|
|
676
695
|
}
|
|
677
696
|
|
|
@@ -731,8 +750,17 @@ export class L1TxUtils extends ReadOnlyL1TxUtils {
|
|
|
731
750
|
return Number(timestamp) * 1000;
|
|
732
751
|
}
|
|
733
752
|
|
|
734
|
-
/** Makes empty blob inputs for the cancellation tx.
|
|
735
|
-
protected makeEmptyBlobInputs(
|
|
736
|
-
|
|
753
|
+
/** Makes empty blob inputs for the cancellation tx. */
|
|
754
|
+
protected makeEmptyBlobInputs(maxFeePerBlobGas: bigint): Required<L1BlobInputs> {
|
|
755
|
+
if (!this.kzg) {
|
|
756
|
+
throw new Error('Cannot make empty blob inputs for cancellation without kzg');
|
|
757
|
+
}
|
|
758
|
+
const blobData = new Uint8Array(131072).fill(0);
|
|
759
|
+
return { blobs: [blobData], kzg: this.kzg, maxFeePerBlobGas };
|
|
760
|
+
}
|
|
761
|
+
|
|
762
|
+
/** Creates a new delayer instance. */
|
|
763
|
+
protected createDelayer(opts: { ethereumSlotDuration: bigint | number }, bindings: LoggerBindings): Delayer {
|
|
764
|
+
return createDelayer(this.dateProvider, opts, bindings);
|
|
737
765
|
}
|
|
738
766
|
}
|
|
@@ -130,9 +130,10 @@ export class ReadOnlyL1TxUtils {
|
|
|
130
130
|
const numBlocks = Math.ceil(gasConfig.stallTimeMs! / BLOCK_TIME_MS);
|
|
131
131
|
for (let i = 0; i < numBlocks; i++) {
|
|
132
132
|
// each block can go up 12.5% from previous baseFee
|
|
133
|
-
|
|
133
|
+
// ceil, (a+b-1)/b, to avoid truncation at small values (e.g. 1 wei blob base fee)
|
|
134
|
+
maxFeePerGas = (maxFeePerGas * (1_000n + 125n) + 999n) / 1_000n;
|
|
134
135
|
// same for blob gas fee
|
|
135
|
-
maxFeePerBlobGas = (maxFeePerBlobGas * (1_000n + 125n)) / 1_000n;
|
|
136
|
+
maxFeePerBlobGas = (maxFeePerBlobGas * (1_000n + 125n) + 999n) / 1_000n;
|
|
136
137
|
}
|
|
137
138
|
|
|
138
139
|
if (attempt > 0) {
|
|
@@ -242,13 +243,16 @@ export class ReadOnlyL1TxUtils {
|
|
|
242
243
|
const gasConfig = { ...this.config, ..._gasConfig };
|
|
243
244
|
let initialEstimate = 0n;
|
|
244
245
|
if (_blobInputs) {
|
|
245
|
-
// @note requests with blobs also require maxFeePerBlobGas to be set
|
|
246
|
+
// @note requests with blobs also require maxFeePerBlobGas to be set.
|
|
247
|
+
// Use 2x buffer for maxFeePerBlobGas to avoid stale fees and to pass EIP-4844 validation (even if it is a gas estimation call).
|
|
248
|
+
// 1. maxFeePerBlobGas >= blobBaseFee
|
|
249
|
+
// 2. account balance >= gas * maxFeePerGas + maxFeePerBlobGas * blobCount + value
|
|
246
250
|
const gasPrice = await this.getGasPrice(gasConfig, true, 0);
|
|
247
251
|
initialEstimate = await this.client.estimateGas({
|
|
248
252
|
account,
|
|
249
253
|
...request,
|
|
250
254
|
..._blobInputs,
|
|
251
|
-
maxFeePerBlobGas: gasPrice.maxFeePerBlobGas
|
|
255
|
+
maxFeePerBlobGas: gasPrice.maxFeePerBlobGas! * 2n,
|
|
252
256
|
gas: MAX_L1_TX_LIMIT,
|
|
253
257
|
blockTag: 'latest',
|
|
254
258
|
});
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { omit } from '@aztec/foundation/collection';
|
|
2
|
-
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
2
|
+
import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
|
|
3
3
|
import { retryUntil } from '@aztec/foundation/retry';
|
|
4
4
|
import type { DateProvider } from '@aztec/foundation/timer';
|
|
5
5
|
|
|
@@ -9,14 +9,16 @@ import {
|
|
|
9
9
|
type Hex,
|
|
10
10
|
type PublicClient,
|
|
11
11
|
type TransactionSerializableEIP4844,
|
|
12
|
+
type TransactionSerialized,
|
|
12
13
|
keccak256,
|
|
13
14
|
parseTransaction,
|
|
14
15
|
publicActions,
|
|
16
|
+
recoverTransactionAddress,
|
|
15
17
|
serializeTransaction,
|
|
16
18
|
walletActions,
|
|
17
19
|
} from 'viem';
|
|
18
20
|
|
|
19
|
-
import {
|
|
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
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
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
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
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
|
-
*
|
|
137
|
-
*
|
|
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
|
|
141
|
-
client: T,
|
|
141
|
+
export function createDelayer(
|
|
142
142
|
dateProvider: DateProvider,
|
|
143
143
|
opts: { ethereumSlotDuration: bigint | number },
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
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
|
-
|
|
149
|
-
const delayer = new DelayerImpl(dateProvider, opts);
|
|
158
|
+
}
|
|
150
159
|
|
|
151
|
-
|
|
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
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
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
|
|
277
|
+
return extended as T;
|
|
250
278
|
}
|
|
251
279
|
|
|
252
280
|
/**
|
package/src/publisher_manager.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { pick } from '@aztec/foundation/collection';
|
|
2
2
|
import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
|
|
3
|
+
import { RunningPromise } from '@aztec/foundation/running-promise';
|
|
3
4
|
|
|
5
|
+
import { Multicall3 } from './contracts/multicall.js';
|
|
4
6
|
import { L1TxUtils, TxUtilsState } from './l1_tx_utils/index.js';
|
|
5
7
|
|
|
6
8
|
// Defines the order in which we prioritise publishers based on their state (first is better)
|
|
@@ -27,24 +29,72 @@ const busyStates: TxUtilsState[] = [
|
|
|
27
29
|
|
|
28
30
|
export type PublisherFilter<UtilsType extends L1TxUtils> = (utils: UtilsType) => boolean;
|
|
29
31
|
|
|
32
|
+
/** Config accepted by PublisherManager. */
|
|
33
|
+
type PublisherManagerConfig = {
|
|
34
|
+
publisherAllowInvalidStates?: boolean;
|
|
35
|
+
publisherFundingThreshold?: bigint;
|
|
36
|
+
publisherFundingAmount?: bigint;
|
|
37
|
+
};
|
|
38
|
+
|
|
30
39
|
export class PublisherManager<UtilsType extends L1TxUtils = L1TxUtils> {
|
|
31
40
|
private log: Logger;
|
|
32
|
-
private config:
|
|
41
|
+
private config: PublisherManagerConfig;
|
|
42
|
+
private static readonly FUNDING_CHECK_INTERVAL_MS = 2 * 60 * 1000;
|
|
43
|
+
private funder?: UtilsType;
|
|
44
|
+
private fundingPromise?: RunningPromise;
|
|
33
45
|
|
|
34
46
|
constructor(
|
|
35
47
|
private publishers: UtilsType[],
|
|
36
|
-
config:
|
|
37
|
-
bindings?: LoggerBindings,
|
|
48
|
+
config: PublisherManagerConfig,
|
|
49
|
+
opts?: { bindings?: LoggerBindings; funder?: UtilsType },
|
|
38
50
|
) {
|
|
39
|
-
this.
|
|
51
|
+
this.funder = opts?.funder;
|
|
52
|
+
this.log = createLogger('publisher:manager', opts?.bindings);
|
|
40
53
|
this.log.info(`PublisherManager initialized with ${publishers.length} publishers.`);
|
|
41
54
|
this.publishers = publishers;
|
|
42
|
-
this.config = pick(config, 'publisherAllowInvalidStates');
|
|
55
|
+
this.config = pick(config, 'publisherAllowInvalidStates', 'publisherFundingThreshold', 'publisherFundingAmount');
|
|
56
|
+
|
|
57
|
+
const hasThreshold = this.config.publisherFundingThreshold !== undefined;
|
|
58
|
+
const hasAmount = this.config.publisherFundingAmount !== undefined;
|
|
59
|
+
if (hasThreshold !== hasAmount) {
|
|
60
|
+
this.log.warn(`Incomplete funding config: both publisherFundingThreshold and publisherFundingAmount must be set`);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
if (this.funder) {
|
|
64
|
+
const funderAddress = this.funder.getSenderAddress();
|
|
65
|
+
if (publishers.some(p => p.getSenderAddress().equals(funderAddress))) {
|
|
66
|
+
this.log.error(`Funding account ${funderAddress} is also a publisher, disabling funding to avoid self-funding`);
|
|
67
|
+
this.funder = undefined;
|
|
68
|
+
}
|
|
69
|
+
}
|
|
43
70
|
}
|
|
44
71
|
|
|
45
|
-
/** Loads the state of all publishers and
|
|
46
|
-
public async
|
|
47
|
-
await Promise.all(
|
|
72
|
+
/** Loads the state of all publishers and the funder, and starts periodic funding checks. */
|
|
73
|
+
public async start(): Promise<void> {
|
|
74
|
+
await Promise.all([
|
|
75
|
+
...this.publishers.map(pub => pub.loadStateAndResumeMonitoring()),
|
|
76
|
+
this.funder?.loadStateAndResumeMonitoring(),
|
|
77
|
+
]);
|
|
78
|
+
|
|
79
|
+
if (
|
|
80
|
+
this.funder &&
|
|
81
|
+
this.config.publisherFundingThreshold !== undefined &&
|
|
82
|
+
this.config.publisherFundingAmount !== undefined
|
|
83
|
+
) {
|
|
84
|
+
this.fundingPromise = new RunningPromise(
|
|
85
|
+
() => this.triggerFundingIfNeeded(),
|
|
86
|
+
this.log,
|
|
87
|
+
PublisherManager.FUNDING_CHECK_INTERVAL_MS,
|
|
88
|
+
);
|
|
89
|
+
this.fundingPromise.start();
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
/** Stops the funding loop and interrupts all publishers. */
|
|
94
|
+
public async stop(): Promise<void> {
|
|
95
|
+
await this.fundingPromise?.stop();
|
|
96
|
+
this.publishers.forEach(pub => pub.interrupt());
|
|
97
|
+
this.funder?.interrupt();
|
|
48
98
|
}
|
|
49
99
|
|
|
50
100
|
// Finds and prioritises available publishers based on
|
|
@@ -102,7 +152,52 @@ export class PublisherManager<UtilsType extends L1TxUtils = L1TxUtils> {
|
|
|
102
152
|
return sortedPublishers[0].publisher;
|
|
103
153
|
}
|
|
104
154
|
|
|
105
|
-
|
|
106
|
-
|
|
155
|
+
/** Check all publisher balances and fund those below threshold. */
|
|
156
|
+
private async triggerFundingIfNeeded(): Promise<void> {
|
|
157
|
+
const { funder, config } = this;
|
|
158
|
+
if (!funder || config.publisherFundingThreshold === undefined || config.publisherFundingAmount === undefined) {
|
|
159
|
+
return;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
const allBalances = await Promise.all(
|
|
163
|
+
this.publishers.map(async pub => ({ balance: await pub.getSenderBalance(), publisher: pub })),
|
|
164
|
+
);
|
|
165
|
+
const lowBalance = allBalances.filter(p => p.balance < config.publisherFundingThreshold!);
|
|
166
|
+
if (lowBalance.length === 0) {
|
|
167
|
+
return;
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
const fundingAmount = config.publisherFundingAmount!;
|
|
171
|
+
const funderBalance = await funder.getSenderBalance();
|
|
172
|
+
|
|
173
|
+
if (funderBalance < 10n * fundingAmount) {
|
|
174
|
+
this.log.warn(`Funding account balance is low`, { funderBalance, threshold: 10n * fundingAmount });
|
|
175
|
+
}
|
|
176
|
+
const affordableCount = Number(funderBalance / fundingAmount);
|
|
177
|
+
if (affordableCount === 0) {
|
|
178
|
+
this.log.error(`Funding account balance too low to fund any publisher`, { funderBalance, fundingAmount });
|
|
179
|
+
return;
|
|
180
|
+
}
|
|
181
|
+
if (affordableCount < lowBalance.length) {
|
|
182
|
+
this.log.warn(`Funder can only afford ${affordableCount}/${lowBalance.length} publishers`, {
|
|
183
|
+
funderBalance,
|
|
184
|
+
fundingAmount,
|
|
185
|
+
});
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
const toFund = lowBalance.slice(0, affordableCount).map(p => p.publisher);
|
|
189
|
+
await this.fundPublishers(toFund);
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/** Fund publishers via a single Multicall3 aggregate3Value transaction. */
|
|
193
|
+
private async fundPublishers(publishers: UtilsType[]): Promise<void> {
|
|
194
|
+
const fundingAmount = this.config.publisherFundingAmount!;
|
|
195
|
+
const calls = publishers.map(pub => ({
|
|
196
|
+
to: pub.getSenderAddress().toString(),
|
|
197
|
+
value: fundingAmount,
|
|
198
|
+
}));
|
|
199
|
+
|
|
200
|
+
await Multicall3.forwardValue(calls, this.funder!, this.log);
|
|
201
|
+
this.log.info(`Funded ${publishers.length} publishers`);
|
|
107
202
|
}
|
|
108
203
|
}
|