@aztec/ethereum 0.0.1-commit.f2ce05ee → 0.0.1-commit.f5d02921e
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 +10 -2
- 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 +45 -9
- package/dest/contracts/rollup.d.ts.map +1 -1
- package/dest/contracts/rollup.js +209 -17
- 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 +20 -7
- package/dest/l1_tx_utils/l1_tx_utils.d.ts.map +1 -1
- package/dest/l1_tx_utils/l1_tx_utils.js +74 -50
- 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 +14 -1
- 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 +244 -29
- 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 +67 -29
- 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,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
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { RollupContract } from '@aztec/ethereum/contracts';
|
|
1
|
+
import type { ManaMinFeeComponents, RollupContract } from '@aztec/ethereum/contracts';
|
|
2
2
|
import { InboxContract } from '@aztec/ethereum/contracts';
|
|
3
3
|
import { CheckpointNumber, EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
|
|
4
4
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
@@ -10,6 +10,20 @@ import { EventEmitter } from 'events';
|
|
|
10
10
|
|
|
11
11
|
import type { ViemClient } from '../types.js';
|
|
12
12
|
|
|
13
|
+
/** L2 fee data reported by the chain monitor. */
|
|
14
|
+
export type L2FeeData = ManaMinFeeComponents & {
|
|
15
|
+
/** Total minimum fee per mana in Fee Juice (sum of sequencerCost + proverCost + congestionCost). */
|
|
16
|
+
minFeePerMana: bigint;
|
|
17
|
+
/** L1 base fee observed by the oracle. */
|
|
18
|
+
l1BaseFee: bigint;
|
|
19
|
+
/** L1 blob fee observed by the oracle. */
|
|
20
|
+
l1BlobFee: bigint;
|
|
21
|
+
/** ETH per fee asset exchange rate (1e12 precision). */
|
|
22
|
+
ethPerFeeAsset: bigint;
|
|
23
|
+
/** Mana target per checkpoint. */
|
|
24
|
+
manaTarget: bigint;
|
|
25
|
+
};
|
|
26
|
+
|
|
13
27
|
export type ChainMonitorEventMap = {
|
|
14
28
|
'l1-block': [{ l1BlockNumber: number; timestamp: bigint }];
|
|
15
29
|
checkpoint: [
|
|
@@ -19,6 +33,7 @@ export type ChainMonitorEventMap = {
|
|
|
19
33
|
'l2-messages': [{ totalL2Messages: number; l1BlockNumber: number }];
|
|
20
34
|
'l2-epoch': [{ l2EpochNumber: EpochNumber; timestamp: bigint; committee: EthAddress[] | undefined }];
|
|
21
35
|
'l2-slot': [{ l2SlotNumber: SlotNumber; timestamp: bigint }];
|
|
36
|
+
'l2-fees': [L2FeeData];
|
|
22
37
|
};
|
|
23
38
|
|
|
24
39
|
/** Utility class that polls the chain on quick intervals and logs new L1 blocks, L2 blocks, and L2 proofs. */
|
|
@@ -45,6 +60,8 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
|
|
|
45
60
|
public l2EpochNumber!: EpochNumber;
|
|
46
61
|
/** Current L2 slot number */
|
|
47
62
|
public l2SlotNumber!: SlotNumber;
|
|
63
|
+
/** Current L2 fee data (components of the minimum fee per mana). */
|
|
64
|
+
public l2FeeData!: L2FeeData;
|
|
48
65
|
|
|
49
66
|
constructor(
|
|
50
67
|
private readonly rollup: RollupContract,
|
|
@@ -77,7 +94,7 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
|
|
|
77
94
|
}
|
|
78
95
|
}
|
|
79
96
|
|
|
80
|
-
|
|
97
|
+
protected async getInbox() {
|
|
81
98
|
if (!this.inbox) {
|
|
82
99
|
const { inboxAddress } = await this.rollup.getRollupAddresses();
|
|
83
100
|
this.inbox = new InboxContract(this.l1Client, inboxAddress);
|
|
@@ -158,7 +175,7 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
|
|
|
158
175
|
this.l2EpochNumber = l2Epoch;
|
|
159
176
|
committee = await this.rollup.getCurrentEpochCommittee();
|
|
160
177
|
this.emit('l2-epoch', { l2EpochNumber: l2Epoch, timestamp, committee });
|
|
161
|
-
msg += ` starting new epoch ${this.l2EpochNumber}
|
|
178
|
+
msg += ` starting new epoch ${this.l2EpochNumber}`;
|
|
162
179
|
}
|
|
163
180
|
|
|
164
181
|
if (l2SlotNumber !== this.l2SlotNumber) {
|
|
@@ -166,6 +183,13 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
|
|
|
166
183
|
this.emit('l2-slot', { l2SlotNumber, timestamp });
|
|
167
184
|
}
|
|
168
185
|
|
|
186
|
+
const feeData = await this.fetchFeeData(timestamp);
|
|
187
|
+
if (this.hasFeeDataChanged(feeData)) {
|
|
188
|
+
msg += ` with L2 min fee ${feeData.minFeePerMana}`;
|
|
189
|
+
this.l2FeeData = feeData;
|
|
190
|
+
this.emit('l2-fees', feeData);
|
|
191
|
+
}
|
|
192
|
+
|
|
169
193
|
this.logger.info(msg, {
|
|
170
194
|
currentTimestamp: this.dateProvider.nowInSeconds(),
|
|
171
195
|
l1Timestamp: timestamp,
|
|
@@ -176,6 +200,7 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
|
|
|
176
200
|
provenCheckpointNumber: this.provenCheckpointNumber,
|
|
177
201
|
totalL2Messages: this.totalL2Messages,
|
|
178
202
|
committee,
|
|
203
|
+
...this.l2FeeData,
|
|
179
204
|
});
|
|
180
205
|
|
|
181
206
|
return this;
|
|
@@ -242,4 +267,36 @@ export class ChainMonitor extends EventEmitter<ChainMonitorEventMap> {
|
|
|
242
267
|
this.on('checkpoint', listener);
|
|
243
268
|
});
|
|
244
269
|
}
|
|
270
|
+
|
|
271
|
+
private async fetchFeeData(timestamp: bigint): Promise<L2FeeData> {
|
|
272
|
+
const [components, minFeePerMana, l1Fees, ethPerFeeAsset, manaTarget] = await Promise.all([
|
|
273
|
+
this.rollup.getManaMinFeeComponentsAt(timestamp, true),
|
|
274
|
+
this.rollup.getManaMinFeeAt(timestamp, true),
|
|
275
|
+
this.rollup.getL1FeesAt(timestamp),
|
|
276
|
+
this.rollup.getEthPerFeeAsset(),
|
|
277
|
+
this.rollup.getManaTarget(),
|
|
278
|
+
]);
|
|
279
|
+
return {
|
|
280
|
+
...components,
|
|
281
|
+
minFeePerMana,
|
|
282
|
+
l1BaseFee: l1Fees.baseFee,
|
|
283
|
+
l1BlobFee: l1Fees.blobFee,
|
|
284
|
+
ethPerFeeAsset,
|
|
285
|
+
manaTarget,
|
|
286
|
+
};
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
private hasFeeDataChanged(newData: L2FeeData): boolean {
|
|
290
|
+
if (!this.l2FeeData) {
|
|
291
|
+
return true;
|
|
292
|
+
}
|
|
293
|
+
return (
|
|
294
|
+
this.l2FeeData.sequencerCost !== newData.sequencerCost ||
|
|
295
|
+
this.l2FeeData.proverCost !== newData.proverCost ||
|
|
296
|
+
this.l2FeeData.congestionCost !== newData.congestionCost ||
|
|
297
|
+
this.l2FeeData.l1BaseFee !== newData.l1BaseFee ||
|
|
298
|
+
this.l2FeeData.l1BlobFee !== newData.l1BlobFee ||
|
|
299
|
+
this.l2FeeData.ethPerFeeAsset !== newData.ethPerFeeAsset
|
|
300
|
+
);
|
|
301
|
+
}
|
|
245
302
|
}
|
|
@@ -85,10 +85,12 @@ export class EthCheatCodes {
|
|
|
85
85
|
}
|
|
86
86
|
|
|
87
87
|
/**
|
|
88
|
-
* Get the
|
|
89
|
-
*
|
|
88
|
+
* Get the timestamp of the latest mined L1 block.
|
|
89
|
+
* Note: this is NOT the current time — it's the discrete timestamp of the last block.
|
|
90
|
+
* Between blocks, the actual chain time advances but no new block reflects it.
|
|
91
|
+
* @returns The latest block timestamp in seconds
|
|
90
92
|
*/
|
|
91
|
-
public async
|
|
93
|
+
public async lastBlockTimestamp(): Promise<number> {
|
|
92
94
|
const res = await this.doRpcCall('eth_getBlockByNumber', ['latest', true]);
|
|
93
95
|
return parseInt(res.timestamp, 16);
|
|
94
96
|
}
|
|
@@ -552,7 +554,7 @@ export class EthCheatCodes {
|
|
|
552
554
|
}
|
|
553
555
|
|
|
554
556
|
public async syncDateProvider() {
|
|
555
|
-
const timestamp = await this.
|
|
557
|
+
const timestamp = await this.lastBlockTimestamp();
|
|
556
558
|
if ('setTime' in this.dateProvider) {
|
|
557
559
|
this.dateProvider.setTime(timestamp * 1000);
|
|
558
560
|
}
|
package/src/test/index.ts
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
export * from './delayed_tx_utils.js';
|
|
2
1
|
export * from './eth_cheat_codes.js';
|
|
3
2
|
export * from './eth_cheat_codes_with_state.js';
|
|
4
3
|
export * from './start_anvil.js';
|
|
5
|
-
export * from './tx_delayer.js';
|
|
6
4
|
export * from './upgrade_utils.js';
|
|
7
5
|
export * from './chain_monitor.js';
|
|
8
6
|
export * from './rollup_cheat_codes.js';
|