@aztec/sequencer-client 0.0.1-commit.72dcdcda8 → 0.0.1-commit.7689c7f
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/README.md +282 -21
- package/dest/client/sequencer-client.d.ts +8 -3
- package/dest/client/sequencer-client.d.ts.map +1 -1
- package/dest/client/sequencer-client.js +53 -30
- package/dest/config.d.ts +28 -5
- package/dest/config.d.ts.map +1 -1
- package/dest/config.js +62 -27
- package/dest/global_variable_builder/fee_predictor.d.ts +37 -0
- package/dest/global_variable_builder/fee_predictor.d.ts.map +1 -0
- package/dest/global_variable_builder/fee_predictor.js +128 -0
- package/dest/global_variable_builder/fee_provider.d.ts +21 -0
- package/dest/global_variable_builder/fee_provider.d.ts.map +1 -0
- package/dest/global_variable_builder/fee_provider.js +58 -0
- package/dest/global_variable_builder/global_builder.d.ts +14 -14
- package/dest/global_variable_builder/global_builder.d.ts.map +1 -1
- package/dest/global_variable_builder/global_builder.js +16 -50
- package/dest/global_variable_builder/index.d.ts +4 -2
- package/dest/global_variable_builder/index.d.ts.map +1 -1
- package/dest/global_variable_builder/index.js +2 -0
- package/dest/index.d.ts +2 -2
- package/dest/index.d.ts.map +1 -1
- package/dest/index.js +1 -1
- package/dest/publisher/config.d.ts +15 -3
- package/dest/publisher/config.d.ts.map +1 -1
- package/dest/publisher/config.js +19 -4
- package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts +3 -4
- package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts.map +1 -1
- package/dest/publisher/sequencer-bundle-simulator.d.ts +96 -0
- package/dest/publisher/sequencer-bundle-simulator.d.ts.map +1 -0
- package/dest/publisher/sequencer-bundle-simulator.js +198 -0
- package/dest/publisher/sequencer-publisher-factory.d.ts +3 -5
- package/dest/publisher/sequencer-publisher-factory.d.ts.map +1 -1
- package/dest/publisher/sequencer-publisher-factory.js +16 -3
- package/dest/publisher/sequencer-publisher.d.ts +77 -65
- package/dest/publisher/sequencer-publisher.d.ts.map +1 -1
- package/dest/publisher/sequencer-publisher.js +345 -512
- package/dest/sequencer/automine/automine_factory.d.ts +54 -0
- package/dest/sequencer/automine/automine_factory.d.ts.map +1 -0
- package/dest/sequencer/automine/automine_factory.js +84 -0
- package/dest/sequencer/automine/automine_sequencer.d.ts +151 -0
- package/dest/sequencer/automine/automine_sequencer.d.ts.map +1 -0
- package/dest/sequencer/automine/automine_sequencer.js +506 -0
- package/dest/sequencer/chain_state_overrides.d.ts +61 -0
- package/dest/sequencer/chain_state_overrides.d.ts.map +1 -0
- package/dest/sequencer/chain_state_overrides.js +98 -0
- package/dest/sequencer/checkpoint_proposal_job.d.ts +54 -11
- package/dest/sequencer/checkpoint_proposal_job.d.ts.map +1 -1
- package/dest/sequencer/checkpoint_proposal_job.js +776 -227
- package/dest/sequencer/checkpoint_proposal_job_metrics.d.ts +34 -0
- package/dest/sequencer/checkpoint_proposal_job_metrics.d.ts.map +1 -0
- package/dest/sequencer/checkpoint_proposal_job_metrics.js +72 -0
- package/dest/sequencer/checkpoint_voter.d.ts +1 -2
- package/dest/sequencer/checkpoint_voter.d.ts.map +1 -1
- package/dest/sequencer/checkpoint_voter.js +2 -5
- package/dest/sequencer/events.d.ts +47 -2
- package/dest/sequencer/events.d.ts.map +1 -1
- package/dest/sequencer/index.d.ts +3 -1
- package/dest/sequencer/index.d.ts.map +1 -1
- package/dest/sequencer/index.js +2 -0
- package/dest/sequencer/metrics.d.ts +13 -10
- package/dest/sequencer/metrics.d.ts.map +1 -1
- package/dest/sequencer/metrics.js +45 -20
- package/dest/sequencer/sequencer.d.ts +59 -16
- package/dest/sequencer/sequencer.d.ts.map +1 -1
- package/dest/sequencer/sequencer.js +333 -119
- package/dest/sequencer/timetable.d.ts +17 -3
- package/dest/sequencer/timetable.d.ts.map +1 -1
- package/dest/sequencer/timetable.js +51 -43
- package/dest/sequencer/types.d.ts +2 -2
- package/dest/sequencer/types.d.ts.map +1 -1
- package/dest/test/mock_checkpoint_builder.d.ts +7 -9
- package/dest/test/mock_checkpoint_builder.d.ts.map +1 -1
- package/dest/test/mock_checkpoint_builder.js +39 -30
- package/dest/test/utils.d.ts +1 -1
- package/dest/test/utils.d.ts.map +1 -1
- package/dest/test/utils.js +7 -6
- package/package.json +27 -28
- package/src/client/sequencer-client.ts +72 -33
- package/src/config.ts +76 -27
- package/src/global_variable_builder/README.md +44 -0
- package/src/global_variable_builder/fee_predictor.ts +172 -0
- package/src/global_variable_builder/fee_provider.ts +75 -0
- package/src/global_variable_builder/global_builder.ts +25 -62
- package/src/global_variable_builder/index.ts +3 -1
- package/src/index.ts +10 -1
- package/src/publisher/config.ts +40 -6
- package/src/publisher/l1_tx_failed_store/failed_tx_store.ts +3 -1
- package/src/publisher/sequencer-bundle-simulator.ts +254 -0
- package/src/publisher/sequencer-publisher-factory.ts +18 -6
- package/src/publisher/sequencer-publisher.ts +426 -567
- package/src/sequencer/README.md +152 -450
- package/src/sequencer/automine/README.md +46 -0
- package/src/sequencer/automine/automine_factory.ts +145 -0
- package/src/sequencer/automine/automine_sequencer.ts +592 -0
- package/src/sequencer/chain_state_overrides.ts +162 -0
- package/src/sequencer/checkpoint_proposal_job.ts +941 -256
- package/src/sequencer/checkpoint_proposal_job_metrics.ts +128 -0
- package/src/sequencer/checkpoint_voter.ts +1 -12
- package/src/sequencer/events.ts +50 -2
- package/src/sequencer/index.ts +2 -0
- package/src/sequencer/metrics.ts +57 -24
- package/src/sequencer/sequencer.ts +414 -132
- package/src/sequencer/timetable.ts +64 -52
- package/src/sequencer/types.ts +1 -1
- package/src/test/mock_checkpoint_builder.ts +51 -48
- package/src/test/utils.ts +28 -10
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { RollupContract } from '@aztec/ethereum/contracts';
|
|
2
|
+
import type { ViemPublicClient } from '@aztec/ethereum/types';
|
|
3
|
+
import { SlotNumber } from '@aztec/foundation/branded-types';
|
|
4
|
+
import type { DateProvider } from '@aztec/foundation/timer';
|
|
5
|
+
import { getNextL1SlotTimestamp } from '@aztec/stdlib/epoch-helpers';
|
|
6
|
+
import { GasFees, ManaUsageEstimate } from '@aztec/stdlib/gas';
|
|
7
|
+
import type { FeeProvider } from '@aztec/stdlib/tx';
|
|
8
|
+
|
|
9
|
+
import { FeePredictor } from './fee_predictor.js';
|
|
10
|
+
import type { GlobalVariableBuilderConfig } from './global_builder.js';
|
|
11
|
+
|
|
12
|
+
/** Provides current and predicted fee information based on on-chain state. */
|
|
13
|
+
export class FeeProviderImpl implements FeeProvider {
|
|
14
|
+
private currentMinFees: Promise<GasFees> = Promise.resolve(new GasFees(0, 0));
|
|
15
|
+
private currentL1BlockNumber: bigint | undefined = undefined;
|
|
16
|
+
|
|
17
|
+
private readonly rollupContract: RollupContract;
|
|
18
|
+
private readonly feePredictor: FeePredictor;
|
|
19
|
+
private readonly ethereumSlotDuration: number;
|
|
20
|
+
private readonly l1GenesisTime: bigint;
|
|
21
|
+
|
|
22
|
+
constructor(
|
|
23
|
+
private readonly dateProvider: DateProvider,
|
|
24
|
+
private readonly publicClient: ViemPublicClient,
|
|
25
|
+
config: GlobalVariableBuilderConfig,
|
|
26
|
+
) {
|
|
27
|
+
this.ethereumSlotDuration = config.ethereumSlotDuration;
|
|
28
|
+
this.l1GenesisTime = config.l1GenesisTime;
|
|
29
|
+
|
|
30
|
+
this.rollupContract = new RollupContract(this.publicClient, config.rollupAddress);
|
|
31
|
+
this.feePredictor = new FeePredictor(this.rollupContract, this.publicClient, this.dateProvider, {
|
|
32
|
+
slotDuration: config.slotDuration,
|
|
33
|
+
l1GenesisTime: config.l1GenesisTime,
|
|
34
|
+
ethereumSlotDuration: config.ethereumSlotDuration,
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Computes the "current" min fees, e.g., the price that you currently should pay to get include in the next block
|
|
40
|
+
* @returns Min fees for the next block
|
|
41
|
+
*/
|
|
42
|
+
private async computeCurrentMinFees(): Promise<GasFees> {
|
|
43
|
+
// Since this might be called in the middle of a slot where a block might have been published,
|
|
44
|
+
// we need to fetch the last block written, and estimate the earliest timestamp for the next block.
|
|
45
|
+
// The timestamp of that last block will act as a lower bound for the next block.
|
|
46
|
+
|
|
47
|
+
const lastCheckpoint = await this.rollupContract.getPendingCheckpoint();
|
|
48
|
+
const earliestTimestamp = await this.rollupContract.getTimestampForSlot(
|
|
49
|
+
SlotNumber.fromBigInt(BigInt(lastCheckpoint.slotNumber) + 1n),
|
|
50
|
+
);
|
|
51
|
+
const nextEthTimestamp = getNextL1SlotTimestamp(this.dateProvider.nowInSeconds(), {
|
|
52
|
+
l1GenesisTime: this.l1GenesisTime,
|
|
53
|
+
ethereumSlotDuration: this.ethereumSlotDuration,
|
|
54
|
+
});
|
|
55
|
+
const timestamp = earliestTimestamp > nextEthTimestamp ? earliestTimestamp : nextEthTimestamp;
|
|
56
|
+
|
|
57
|
+
return new GasFees(0, await this.rollupContract.getManaMinFeeAt(timestamp, true));
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
public async getCurrentMinFees(): Promise<GasFees> {
|
|
61
|
+
// Get the current block number
|
|
62
|
+
const blockNumber = await this.publicClient.getBlockNumber();
|
|
63
|
+
|
|
64
|
+
// If the L1 block number has changed then chain a new promise to get the current min fees
|
|
65
|
+
if (this.currentL1BlockNumber === undefined || blockNumber > this.currentL1BlockNumber) {
|
|
66
|
+
this.currentL1BlockNumber = blockNumber;
|
|
67
|
+
this.currentMinFees = this.currentMinFees.then(() => this.computeCurrentMinFees());
|
|
68
|
+
}
|
|
69
|
+
return this.currentMinFees;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
public getPredictedMinFees(manaUsage?: ManaUsageEstimate): Promise<GasFees[]> {
|
|
73
|
+
return this.feePredictor.getPredictedMinFees(manaUsage ?? ManaUsageEstimate.Target);
|
|
74
|
+
}
|
|
75
|
+
}
|
|
@@ -1,14 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import {
|
|
2
|
+
RollupContract,
|
|
3
|
+
type SimulationOverridesPlan,
|
|
4
|
+
buildSimulationOverridesStateOverride,
|
|
5
|
+
} from '@aztec/ethereum/contracts';
|
|
5
6
|
import type { ViemPublicClient } from '@aztec/ethereum/types';
|
|
6
7
|
import { BlockNumber, SlotNumber } from '@aztec/foundation/branded-types';
|
|
7
8
|
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
8
9
|
import type { EthAddress } from '@aztec/foundation/eth-address';
|
|
9
|
-
import {
|
|
10
|
+
import type { DateProvider } from '@aztec/foundation/timer';
|
|
10
11
|
import type { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
11
|
-
import { type L1RollupConstants, getTimestampForSlot } from '@aztec/stdlib/epoch-helpers';
|
|
12
|
+
import { type L1RollupConstants, getNextL1SlotTimestamp, getTimestampForSlot } from '@aztec/stdlib/epoch-helpers';
|
|
12
13
|
import { GasFees } from '@aztec/stdlib/gas';
|
|
13
14
|
import type {
|
|
14
15
|
CheckpointGlobalVariables,
|
|
@@ -16,18 +17,18 @@ import type {
|
|
|
16
17
|
} from '@aztec/stdlib/tx';
|
|
17
18
|
import { GlobalVariables } from '@aztec/stdlib/tx';
|
|
18
19
|
|
|
19
|
-
|
|
20
|
+
/** Configuration for the GlobalVariableBuilder (excludes L1 client config). */
|
|
21
|
+
export type GlobalVariableBuilderConfig = {
|
|
22
|
+
rollupAddress: EthAddress;
|
|
23
|
+
ethereumSlotDuration: number;
|
|
24
|
+
rollupVersion: bigint;
|
|
25
|
+
} & Pick<L1RollupConstants, 'slotDuration' | 'l1GenesisTime'>;
|
|
20
26
|
|
|
21
27
|
/**
|
|
22
28
|
* Simple global variables builder.
|
|
23
29
|
*/
|
|
24
30
|
export class GlobalVariableBuilder implements GlobalVariableBuilderInterface {
|
|
25
|
-
private log = createLogger('sequencer:global_variable_builder');
|
|
26
|
-
private currentMinFees: Promise<GasFees> = Promise.resolve(new GasFees(0, 0));
|
|
27
|
-
private currentL1BlockNumber: bigint | undefined = undefined;
|
|
28
|
-
|
|
29
31
|
private readonly rollupContract: RollupContract;
|
|
30
|
-
private readonly publicClient: ViemPublicClient;
|
|
31
32
|
private readonly ethereumSlotDuration: number;
|
|
32
33
|
private readonly aztecSlotDuration: number;
|
|
33
34
|
private readonly l1GenesisTime: bigint;
|
|
@@ -36,59 +37,18 @@ export class GlobalVariableBuilder implements GlobalVariableBuilderInterface {
|
|
|
36
37
|
private version: Fr;
|
|
37
38
|
|
|
38
39
|
constructor(
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
40
|
+
private readonly dateProvider: DateProvider,
|
|
41
|
+
private readonly publicClient: ViemPublicClient,
|
|
42
|
+
config: GlobalVariableBuilderConfig,
|
|
42
43
|
) {
|
|
43
|
-
const { l1RpcUrls, l1ChainId: chainId, l1Contracts } = config;
|
|
44
|
-
|
|
45
|
-
const chain = createEthereumChain(l1RpcUrls, chainId);
|
|
46
|
-
|
|
47
44
|
this.version = new Fr(config.rollupVersion);
|
|
48
|
-
this.chainId = new Fr(
|
|
45
|
+
this.chainId = new Fr(this.publicClient.chain!.id);
|
|
49
46
|
|
|
50
47
|
this.ethereumSlotDuration = config.ethereumSlotDuration;
|
|
51
48
|
this.aztecSlotDuration = config.slotDuration;
|
|
52
49
|
this.l1GenesisTime = config.l1GenesisTime;
|
|
53
50
|
|
|
54
|
-
this.
|
|
55
|
-
chain: chain.chainInfo,
|
|
56
|
-
transport: fallback(chain.rpcUrls.map(url => http(url, { batch: false }))),
|
|
57
|
-
pollingInterval: config.viemPollingIntervalMS,
|
|
58
|
-
});
|
|
59
|
-
|
|
60
|
-
this.rollupContract = new RollupContract(this.publicClient, l1Contracts.rollupAddress);
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
/**
|
|
64
|
-
* Computes the "current" min fees, e.g., the price that you currently should pay to get include in the next block
|
|
65
|
-
* @returns Min fees for the next block
|
|
66
|
-
*/
|
|
67
|
-
private async computeCurrentMinFees(): Promise<GasFees> {
|
|
68
|
-
// Since this might be called in the middle of a slot where a block might have been published,
|
|
69
|
-
// we need to fetch the last block written, and estimate the earliest timestamp for the next block.
|
|
70
|
-
// The timestamp of that last block will act as a lower bound for the next block.
|
|
71
|
-
|
|
72
|
-
const lastCheckpoint = await this.rollupContract.getPendingCheckpoint();
|
|
73
|
-
const earliestTimestamp = await this.rollupContract.getTimestampForSlot(
|
|
74
|
-
SlotNumber.fromBigInt(BigInt(lastCheckpoint.slotNumber) + 1n),
|
|
75
|
-
);
|
|
76
|
-
const nextEthTimestamp = BigInt((await this.publicClient.getBlock()).timestamp + BigInt(this.ethereumSlotDuration));
|
|
77
|
-
const timestamp = earliestTimestamp > nextEthTimestamp ? earliestTimestamp : nextEthTimestamp;
|
|
78
|
-
|
|
79
|
-
return new GasFees(0, await this.rollupContract.getManaMinFeeAt(timestamp, true));
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
public async getCurrentMinFees(): Promise<GasFees> {
|
|
83
|
-
// Get the current block number
|
|
84
|
-
const blockNumber = await this.publicClient.getBlockNumber();
|
|
85
|
-
|
|
86
|
-
// If the L1 block number has changed then chain a new promise to get the current min fees
|
|
87
|
-
if (this.currentL1BlockNumber === undefined || blockNumber > this.currentL1BlockNumber) {
|
|
88
|
-
this.currentL1BlockNumber = blockNumber;
|
|
89
|
-
this.currentMinFees = this.currentMinFees.then(() => this.computeCurrentMinFees());
|
|
90
|
-
}
|
|
91
|
-
return this.currentMinFees;
|
|
51
|
+
this.rollupContract = new RollupContract(this.publicClient, config.rollupAddress);
|
|
92
52
|
}
|
|
93
53
|
|
|
94
54
|
/**
|
|
@@ -108,7 +68,10 @@ export class GlobalVariableBuilder implements GlobalVariableBuilderInterface {
|
|
|
108
68
|
const slot: SlotNumber =
|
|
109
69
|
maybeSlot ??
|
|
110
70
|
(await this.rollupContract.getSlotAt(
|
|
111
|
-
|
|
71
|
+
getNextL1SlotTimestamp(this.dateProvider.nowInSeconds(), {
|
|
72
|
+
l1GenesisTime: this.l1GenesisTime,
|
|
73
|
+
ethereumSlotDuration: this.ethereumSlotDuration,
|
|
74
|
+
}),
|
|
112
75
|
));
|
|
113
76
|
|
|
114
77
|
const checkpointGlobalVariables = await this.buildCheckpointGlobalVariables(coinbase, feeRecipient, slot);
|
|
@@ -120,6 +83,7 @@ export class GlobalVariableBuilder implements GlobalVariableBuilderInterface {
|
|
|
120
83
|
coinbase: EthAddress,
|
|
121
84
|
feeRecipient: AztecAddress,
|
|
122
85
|
slotNumber: SlotNumber,
|
|
86
|
+
simulationOverridesPlan?: SimulationOverridesPlan,
|
|
123
87
|
): Promise<CheckpointGlobalVariables> {
|
|
124
88
|
const { chainId, version } = this;
|
|
125
89
|
|
|
@@ -128,9 +92,8 @@ export class GlobalVariableBuilder implements GlobalVariableBuilderInterface {
|
|
|
128
92
|
l1GenesisTime: this.l1GenesisTime,
|
|
129
93
|
});
|
|
130
94
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
const gasFees = new GasFees(0, await this.rollupContract.getManaMinFeeAt(timestamp, true));
|
|
95
|
+
const stateOverride = await buildSimulationOverridesStateOverride(this.rollupContract, simulationOverridesPlan);
|
|
96
|
+
const gasFees = new GasFees(0, await this.rollupContract.getManaMinFeeAt(timestamp, true, stateOverride));
|
|
134
97
|
|
|
135
98
|
return { chainId, version, slotNumber, timestamp, coinbase, feeRecipient, gasFees };
|
|
136
99
|
}
|
package/src/index.ts
CHANGED
|
@@ -1,7 +1,16 @@
|
|
|
1
1
|
export * from './client/index.js';
|
|
2
2
|
export * from './config.js';
|
|
3
3
|
export * from './publisher/index.js';
|
|
4
|
-
export {
|
|
4
|
+
export {
|
|
5
|
+
AutomineSequencer,
|
|
6
|
+
type AutomineSequencerConstants,
|
|
7
|
+
type AutomineSequencerDeps,
|
|
8
|
+
createAutomineSequencer,
|
|
9
|
+
type CreateAutomineSequencerArgs,
|
|
10
|
+
Sequencer,
|
|
11
|
+
SequencerState,
|
|
12
|
+
type SequencerEvents,
|
|
13
|
+
} from './sequencer/index.js';
|
|
5
14
|
|
|
6
15
|
// Used by the node to simulate public parts of transactions. Should these be moved to a shared library?
|
|
7
16
|
// ISSUE(#9832)
|
package/src/publisher/config.ts
CHANGED
|
@@ -4,6 +4,8 @@ import { type L1TxUtilsConfig, l1TxUtilsConfigMappings } from '@aztec/ethereum/l
|
|
|
4
4
|
import { type ConfigMappingsType, SecretValue, booleanConfigHelper } from '@aztec/foundation/config';
|
|
5
5
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
6
6
|
|
|
7
|
+
import { parseEther } from 'viem';
|
|
8
|
+
|
|
7
9
|
/** Configuration of the transaction publisher. */
|
|
8
10
|
export type TxSenderConfig = L1ReaderConfig & {
|
|
9
11
|
/** The private key to be used by the publisher. */
|
|
@@ -50,13 +52,37 @@ export type PublisherConfig = L1TxUtilsConfig &
|
|
|
50
52
|
publisherForwarderAddress?: EthAddress;
|
|
51
53
|
/** Store for failed L1 transaction inputs (test networks only). Format: gs://bucket/path */
|
|
52
54
|
l1TxFailedStore?: string;
|
|
55
|
+
/** Min ETH balance below which a publisher gets funded. Undefined = funding disabled. */
|
|
56
|
+
publisherFundingThreshold?: bigint;
|
|
57
|
+
/** Amount of ETH to send when funding a publisher. Undefined = funding disabled. */
|
|
58
|
+
publisherFundingAmount?: bigint;
|
|
53
59
|
};
|
|
54
60
|
|
|
61
|
+
/** Shared config mappings for publisher funding, used by both sequencer and prover publisher configs. */
|
|
62
|
+
const publisherFundingConfigMappings = {
|
|
63
|
+
publisherFundingThreshold: {
|
|
64
|
+
env: 'PUBLISHER_FUNDING_THRESHOLD' as const,
|
|
65
|
+
description:
|
|
66
|
+
'Min ETH balance below which a publisher gets funded. Specified in ether (e.g. 0.1). Unset = funding disabled.',
|
|
67
|
+
parseEnv: (val: string) => parseEther(val),
|
|
68
|
+
},
|
|
69
|
+
publisherFundingAmount: {
|
|
70
|
+
env: 'PUBLISHER_FUNDING_AMOUNT' as const,
|
|
71
|
+
description:
|
|
72
|
+
'Amount of ETH to send when funding a publisher. Specified in ether (e.g. 0.5). Unset = funding disabled.',
|
|
73
|
+
parseEnv: (val: string) => parseEther(val),
|
|
74
|
+
},
|
|
75
|
+
};
|
|
76
|
+
|
|
55
77
|
export type ProverPublisherConfig = L1TxUtilsConfig &
|
|
56
78
|
BlobClientConfig & {
|
|
57
79
|
fishermanMode?: boolean;
|
|
58
80
|
proverPublisherAllowInvalidStates?: boolean;
|
|
59
81
|
proverPublisherForwarderAddress?: EthAddress;
|
|
82
|
+
/** Min ETH balance below which a publisher gets funded. Undefined = funding disabled. */
|
|
83
|
+
publisherFundingThreshold?: bigint;
|
|
84
|
+
/** Amount of ETH to send when funding a publisher. Undefined = funding disabled. */
|
|
85
|
+
publisherFundingAmount?: bigint;
|
|
60
86
|
};
|
|
61
87
|
|
|
62
88
|
export type SequencerPublisherConfig = L1TxUtilsConfig &
|
|
@@ -66,6 +92,10 @@ export type SequencerPublisherConfig = L1TxUtilsConfig &
|
|
|
66
92
|
sequencerPublisherForwarderAddress?: EthAddress;
|
|
67
93
|
/** Store for failed L1 transaction inputs (test networks only). Format: gs://bucket/path */
|
|
68
94
|
l1TxFailedStore?: string;
|
|
95
|
+
/** Min ETH balance below which a publisher gets funded. Undefined = funding disabled. */
|
|
96
|
+
publisherFundingThreshold?: bigint;
|
|
97
|
+
/** Amount of ETH to send when funding a publisher. Undefined = funding disabled. */
|
|
98
|
+
publisherFundingAmount?: bigint;
|
|
69
99
|
};
|
|
70
100
|
|
|
71
101
|
export function getPublisherConfigFromProverConfig(config: ProverPublisherConfig): PublisherConfig {
|
|
@@ -85,12 +115,13 @@ export function getPublisherConfigFromSequencerConfig(config: SequencerPublisher
|
|
|
85
115
|
};
|
|
86
116
|
}
|
|
87
117
|
|
|
88
|
-
export const proverTxSenderConfigMappings: ConfigMappingsType<
|
|
118
|
+
export const proverTxSenderConfigMappings: ConfigMappingsType<ProverTxSenderConfig> = {
|
|
89
119
|
...l1ReaderConfigMappings,
|
|
90
120
|
proverPublisherPrivateKeys: {
|
|
91
121
|
env: `PROVER_PUBLISHER_PRIVATE_KEYS`,
|
|
92
122
|
description: 'The private keys to be used by the prover publisher.',
|
|
93
|
-
parseEnv: (val: string) =>
|
|
123
|
+
parseEnv: (val: string) =>
|
|
124
|
+
val.split(',').map(key => new SecretValue(`0x${key.replace('0x', '')}` as `0x${string}`)),
|
|
94
125
|
defaultValue: [],
|
|
95
126
|
fallback: [`PROVER_PUBLISHER_PRIVATE_KEY`],
|
|
96
127
|
},
|
|
@@ -102,12 +133,13 @@ export const proverTxSenderConfigMappings: ConfigMappingsType<Omit<ProverTxSende
|
|
|
102
133
|
},
|
|
103
134
|
};
|
|
104
135
|
|
|
105
|
-
export const sequencerTxSenderConfigMappings: ConfigMappingsType<
|
|
136
|
+
export const sequencerTxSenderConfigMappings: ConfigMappingsType<SequencerTxSenderConfig> = {
|
|
106
137
|
...l1ReaderConfigMappings,
|
|
107
138
|
sequencerPublisherPrivateKeys: {
|
|
108
139
|
env: `SEQ_PUBLISHER_PRIVATE_KEYS`,
|
|
109
140
|
description: 'The private keys to be used by the sequencer publisher.',
|
|
110
|
-
parseEnv: (val: string) =>
|
|
141
|
+
parseEnv: (val: string) =>
|
|
142
|
+
val.split(',').map(key => new SecretValue(`0x${key.replace('0x', '')}` as `0x${string}`)),
|
|
111
143
|
defaultValue: [],
|
|
112
144
|
fallback: [`SEQ_PUBLISHER_PRIVATE_KEY`],
|
|
113
145
|
},
|
|
@@ -136,12 +168,13 @@ export const sequencerPublisherConfigMappings: ConfigMappingsType<SequencerPubli
|
|
|
136
168
|
sequencerPublisherForwarderAddress: {
|
|
137
169
|
env: `SEQ_PUBLISHER_FORWARDER_ADDRESS`,
|
|
138
170
|
description: 'Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only)',
|
|
139
|
-
parseEnv: (val: string) =>
|
|
171
|
+
parseEnv: (val: string) => EthAddress.fromString(val),
|
|
140
172
|
},
|
|
141
173
|
l1TxFailedStore: {
|
|
142
174
|
env: 'L1_TX_FAILED_STORE',
|
|
143
175
|
description: 'Store for failed L1 transaction inputs (test networks only). Format: gs://bucket/path',
|
|
144
176
|
},
|
|
177
|
+
...publisherFundingConfigMappings,
|
|
145
178
|
};
|
|
146
179
|
|
|
147
180
|
export const proverPublisherConfigMappings: ConfigMappingsType<ProverPublisherConfig & L1TxUtilsConfig> = {
|
|
@@ -161,6 +194,7 @@ export const proverPublisherConfigMappings: ConfigMappingsType<ProverPublisherCo
|
|
|
161
194
|
proverPublisherForwarderAddress: {
|
|
162
195
|
env: `PROVER_PUBLISHER_FORWARDER_ADDRESS`,
|
|
163
196
|
description: 'Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only)',
|
|
164
|
-
parseEnv: (val: string) =>
|
|
197
|
+
parseEnv: (val: string) => EthAddress.fromString(val),
|
|
165
198
|
},
|
|
199
|
+
...publisherFundingConfigMappings,
|
|
166
200
|
};
|
|
@@ -1,7 +1,9 @@
|
|
|
1
|
+
import type { Branded } from '@aztec/foundation/branded-types';
|
|
2
|
+
|
|
1
3
|
import type { Hex } from 'viem';
|
|
2
4
|
|
|
3
5
|
/** URI pointing to a stored failed L1 transaction. */
|
|
4
|
-
export type FailedL1TxUri = string
|
|
6
|
+
export type FailedL1TxUri = Branded<string, 'FailedL1TxUri'>;
|
|
5
7
|
|
|
6
8
|
/** A failed L1 transaction captured for debugging and replay. */
|
|
7
9
|
export type FailedL1Tx = {
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
import type { EpochCache } from '@aztec/epoch-cache';
|
|
2
|
+
import { Multicall3, type RollupContract, buildSimulationOverridesStateOverride } from '@aztec/ethereum/contracts';
|
|
3
|
+
import { type L1TxUtils, MAX_L1_TX_LIMIT } from '@aztec/ethereum/l1-tx-utils';
|
|
4
|
+
import { formatViemError } from '@aztec/ethereum/utils';
|
|
5
|
+
import type { SlotNumber } from '@aztec/foundation/branded-types';
|
|
6
|
+
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
7
|
+
import { getLastL1SlotTimestampForL2Slot } from '@aztec/stdlib/epoch-helpers';
|
|
8
|
+
|
|
9
|
+
import type { Hex, StateOverride } from 'viem';
|
|
10
|
+
|
|
11
|
+
import type { RequestWithExpiry } from './sequencer-publisher.js';
|
|
12
|
+
|
|
13
|
+
/** A request that was dropped by bundle simulation, with the decoded revert reason. */
|
|
14
|
+
export type DroppedRequest = {
|
|
15
|
+
request: RequestWithExpiry;
|
|
16
|
+
revertReason: string | undefined;
|
|
17
|
+
returnData: Hex | undefined;
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Result of {@link SequencerBundleSimulator.simulate}.
|
|
22
|
+
*
|
|
23
|
+
* - `success`: simulation succeeded. `requests` is the filtered survivor list, `gasLimit` is
|
|
24
|
+
* the bumped gas limit derived from `gasUsed` (plus blob evaluation gas). `droppedRequests`
|
|
25
|
+
* lists the entries that were observed to revert in simulation.
|
|
26
|
+
* - `fallback`: the node does not support eth_simulateV1 (or the simulate call threw). The
|
|
27
|
+
* caller should send `requests` as-is with a safe gas limit (e.g. {@link MAX_L1_TX_LIMIT}).
|
|
28
|
+
* `droppedRequests` carries any entries that the first pass already proved reverted, so the
|
|
29
|
+
* caller does not re-include them when the second pass falls back.
|
|
30
|
+
* - `aborted`: the bundle cannot be sent. `droppedRequests` contains only entries that were
|
|
31
|
+
* actually observed to revert (so they can be reported as simulation failures); it is empty
|
|
32
|
+
* when the abort was caused by an empty input bundle.
|
|
33
|
+
*/
|
|
34
|
+
export type BundleSimulateResult =
|
|
35
|
+
| { kind: 'success'; requests: RequestWithExpiry[]; gasLimit: bigint; droppedRequests: DroppedRequest[] }
|
|
36
|
+
| { kind: 'fallback'; requests: RequestWithExpiry[]; droppedRequests: DroppedRequest[] }
|
|
37
|
+
| { kind: 'aborted'; reason: AbortReason; droppedRequests: DroppedRequest[] };
|
|
38
|
+
|
|
39
|
+
export type AbortReason = 'empty-bundle' | 'all-reverted' | 'second-pass-reverts';
|
|
40
|
+
|
|
41
|
+
type SimulatePassResult =
|
|
42
|
+
| { kind: 'decoded'; survivors: RequestWithExpiry[]; droppedRequests: DroppedRequest[]; gasUsed: bigint }
|
|
43
|
+
| { kind: 'fallback' };
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Bundle-level simulator for the aggregate3 payload that `SequencerPublisher` is about to send.
|
|
47
|
+
*
|
|
48
|
+
* Runs `eth_simulateV1` against `Multicall3.aggregate3`, drops entries that revert, and returns
|
|
49
|
+
* a gasLimit for the survivors. When `eth_simulateV1` is unavailable, signals fallback to the
|
|
50
|
+
* caller so it can send the bundle as-is with a conservative gas limit.
|
|
51
|
+
*/
|
|
52
|
+
export class SequencerBundleSimulator {
|
|
53
|
+
private readonly log: Logger;
|
|
54
|
+
|
|
55
|
+
constructor(
|
|
56
|
+
private readonly deps: {
|
|
57
|
+
getL1TxUtils: () => L1TxUtils;
|
|
58
|
+
rollupContract: RollupContract;
|
|
59
|
+
epochCache: EpochCache;
|
|
60
|
+
log?: Logger;
|
|
61
|
+
},
|
|
62
|
+
) {
|
|
63
|
+
this.log = deps.log ?? createLogger('sequencer:publisher:bundle-simulator');
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Simulates the given bundle near the end of the target slot and filters out entries
|
|
68
|
+
* that revert.
|
|
69
|
+
*
|
|
70
|
+
* - If all entries pass on the first pass, returns `success` with the gasLimit.
|
|
71
|
+
* - If some entries revert, re-simulates the survivors. If the second pass is clean, returns
|
|
72
|
+
* `success` with the survivors and dropped entries. If the second pass surfaces any revert,
|
|
73
|
+
* returns `aborted` — we refuse to send a bundle whose composition still has internal
|
|
74
|
+
* reverts after one round of filtering.
|
|
75
|
+
* - If eth_simulateV1 is unavailable, returns `fallback`. The caller is expected to send the
|
|
76
|
+
* bundle as-is with a safe gas limit.
|
|
77
|
+
*
|
|
78
|
+
* The simulation `block.timestamp` is the last L1 slot timestamp inside the target L2 slot.
|
|
79
|
+
* This still maps to the target L2 slot for propose's `validateHeader` and EIP-712 signature
|
|
80
|
+
* checks, while avoiding eth_simulateV1 rejecting a child block whose timestamp is not strictly
|
|
81
|
+
* greater than the current L1 head.
|
|
82
|
+
*
|
|
83
|
+
* Known limitation: on networks where L1 is mining behind cadence (missed L1 slots, anvil with
|
|
84
|
+
* overridden timestamps), the actual `block.timestamp` at send time can land in the prior L2
|
|
85
|
+
* slot. In that case `propose` would revert silently inside the multicall. The simulator does
|
|
86
|
+
* not detect this case because it simulates inside the target slot — the prior implementation
|
|
87
|
+
* used `min(predictedNextL1Ts, targetTimestamp)` to surface this failure mode at simulate time.
|
|
88
|
+
*/
|
|
89
|
+
public async simulate(validRequests: RequestWithExpiry[], targetSlot: SlotNumber): Promise<BundleSimulateResult> {
|
|
90
|
+
if (validRequests.length === 0) {
|
|
91
|
+
return { kind: 'aborted', reason: 'empty-bundle', droppedRequests: [] };
|
|
92
|
+
}
|
|
93
|
+
// Pin the publisher we'll use across the whole simulate call so that the publisher's rotation
|
|
94
|
+
// can't change l1TxUtils mid-flight.
|
|
95
|
+
const l1TxUtils = this.deps.getL1TxUtils();
|
|
96
|
+
|
|
97
|
+
const proposeRequest = validRequests.find(r => r.action === 'propose');
|
|
98
|
+
const simulateTimestamp = getLastL1SlotTimestampForL2Slot(targetSlot, this.deps.epochCache.getL1Constants());
|
|
99
|
+
const firstPassOverrides = await this.buildStateOverrides(!!proposeRequest);
|
|
100
|
+
|
|
101
|
+
const firstPass = await this.simulateAndDecode(l1TxUtils, validRequests, simulateTimestamp, firstPassOverrides);
|
|
102
|
+
|
|
103
|
+
if (firstPass.kind === 'fallback') {
|
|
104
|
+
this.log.warn('Bundle simulate fallback (eth_simulateV1 unavailable); caller will send bundle as-is', {
|
|
105
|
+
actions: validRequests.map(r => r.action),
|
|
106
|
+
});
|
|
107
|
+
return { kind: 'fallback', requests: validRequests, droppedRequests: [] };
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
if (firstPass.survivors.length === 0) {
|
|
111
|
+
this.log.warn('All bundle entries dropped in simulation; aborting send', {
|
|
112
|
+
actions: validRequests.map(r => r.action),
|
|
113
|
+
});
|
|
114
|
+
return { kind: 'aborted', reason: 'all-reverted', droppedRequests: firstPass.droppedRequests };
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
if (firstPass.droppedRequests.length === 0) {
|
|
118
|
+
return this.buildSuccessResult(l1TxUtils, firstPass.survivors, [], firstPass.gasUsed, proposeRequest);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
this.log.warn('Some bundle entries reverted; re-simulating reduced bundle', {
|
|
122
|
+
droppedActions: firstPass.droppedRequests.map(d => d.request.action),
|
|
123
|
+
remainingActions: firstPass.survivors.map(r => r.action),
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
// Rebuild overrides for the reduced bundle: if propose was dropped, we no longer need the blob-check override
|
|
127
|
+
const proposeSurvived = proposeRequest !== undefined && firstPass.survivors.includes(proposeRequest);
|
|
128
|
+
const secondPassOverrides = proposeSurvived ? firstPassOverrides : await this.buildStateOverrides(false);
|
|
129
|
+
const secondPass = await this.simulateAndDecode(
|
|
130
|
+
l1TxUtils,
|
|
131
|
+
firstPass.survivors,
|
|
132
|
+
simulateTimestamp,
|
|
133
|
+
secondPassOverrides,
|
|
134
|
+
);
|
|
135
|
+
|
|
136
|
+
if (secondPass.kind === 'fallback') {
|
|
137
|
+
this.log.warn(
|
|
138
|
+
'Bundle simulate errored on second pass (eth_simulateV1 unavailable); sending first-pass survivors as-is',
|
|
139
|
+
{
|
|
140
|
+
actions: firstPass.survivors.map(r => r.action),
|
|
141
|
+
droppedActions: firstPass.droppedRequests.map(d => d.request.action),
|
|
142
|
+
},
|
|
143
|
+
);
|
|
144
|
+
return { kind: 'fallback', requests: firstPass.survivors, droppedRequests: firstPass.droppedRequests };
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
// We refuse to chase reverts through repeated trimming: anything other than a clean second pass aborts the whole send
|
|
148
|
+
if (secondPass.droppedRequests.length > 0) {
|
|
149
|
+
this.log.error('Re-simulate surfaced reverts; aborting send', {
|
|
150
|
+
secondPassDroppedActions: secondPass.droppedRequests.map(d => d.request.action),
|
|
151
|
+
});
|
|
152
|
+
return {
|
|
153
|
+
kind: 'aborted',
|
|
154
|
+
reason: 'second-pass-reverts',
|
|
155
|
+
droppedRequests: [...firstPass.droppedRequests, ...secondPass.droppedRequests],
|
|
156
|
+
};
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
return this.buildSuccessResult(
|
|
160
|
+
l1TxUtils,
|
|
161
|
+
secondPass.survivors,
|
|
162
|
+
firstPass.droppedRequests,
|
|
163
|
+
secondPass.gasUsed,
|
|
164
|
+
proposeRequest,
|
|
165
|
+
);
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
private buildSuccessResult(
|
|
169
|
+
l1TxUtils: L1TxUtils,
|
|
170
|
+
survivors: RequestWithExpiry[],
|
|
171
|
+
droppedRequests: DroppedRequest[],
|
|
172
|
+
bundleGasUsed: bigint,
|
|
173
|
+
proposeRequest: RequestWithExpiry | undefined,
|
|
174
|
+
): BundleSimulateResult {
|
|
175
|
+
const proposeSurvived = proposeRequest !== undefined && survivors.includes(proposeRequest);
|
|
176
|
+
const blobEvaluationGas = proposeSurvived ? (proposeRequest?.blobEvaluationGas ?? 0n) : 0n;
|
|
177
|
+
const gasLimit = this.computeGasLimit(l1TxUtils, bundleGasUsed, blobEvaluationGas);
|
|
178
|
+
this.log.debug('Bundle simulate complete', {
|
|
179
|
+
survivingRequests: survivors.length,
|
|
180
|
+
bundleGasUsed,
|
|
181
|
+
gasLimit,
|
|
182
|
+
actions: survivors.map(r => r.action),
|
|
183
|
+
});
|
|
184
|
+
return { kind: 'success', requests: survivors, gasLimit, droppedRequests };
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* `gasLimit = bumpGasLimit(ceil(gasUsed * 64 / 63))`, plus blob evaluation gas if a propose
|
|
189
|
+
* survived, capped at the L1 block gas limit.
|
|
190
|
+
*/
|
|
191
|
+
private computeGasLimit(l1TxUtils: L1TxUtils, bundleGasUsed: bigint, blobEvaluationGas: bigint): bigint {
|
|
192
|
+
const gasUsedWithEip150 = (bundleGasUsed * 64n + 62n) / 63n;
|
|
193
|
+
const gasLimit = l1TxUtils.bumpGasLimit(gasUsedWithEip150) + blobEvaluationGas;
|
|
194
|
+
return gasLimit > MAX_L1_TX_LIMIT ? MAX_L1_TX_LIMIT : gasLimit;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* eth_simulateV1 cannot carry blob sidecar data, so disable the rollup's on-chain blob check
|
|
199
|
+
* when a propose is in the bundle.
|
|
200
|
+
*/
|
|
201
|
+
private buildStateOverrides(hasProposeAction: boolean): Promise<StateOverride> {
|
|
202
|
+
return buildSimulationOverridesStateOverride(
|
|
203
|
+
this.deps.rollupContract,
|
|
204
|
+
hasProposeAction ? { disableBlobCheck: true } : undefined,
|
|
205
|
+
);
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
private async simulateAndDecode(
|
|
209
|
+
l1TxUtils: L1TxUtils,
|
|
210
|
+
requests: RequestWithExpiry[],
|
|
211
|
+
simulateTimestamp: bigint,
|
|
212
|
+
stateOverrides: StateOverride,
|
|
213
|
+
): Promise<SimulatePassResult> {
|
|
214
|
+
let simResult: Awaited<ReturnType<typeof Multicall3.simulateAggregate3>>;
|
|
215
|
+
try {
|
|
216
|
+
simResult = await Multicall3.simulateAggregate3(
|
|
217
|
+
requests.map(r => ({ to: r.request.to! as Hex, data: r.request.data! as Hex, abi: r.request.abi })),
|
|
218
|
+
l1TxUtils,
|
|
219
|
+
{
|
|
220
|
+
blockOverrides: { time: simulateTimestamp, gasLimit: MAX_L1_TX_LIMIT * 2n },
|
|
221
|
+
stateOverrides,
|
|
222
|
+
gas: MAX_L1_TX_LIMIT,
|
|
223
|
+
fallbackGasEstimate: MAX_L1_TX_LIMIT,
|
|
224
|
+
},
|
|
225
|
+
);
|
|
226
|
+
} catch (err) {
|
|
227
|
+
this.log.warn('Bundle simulate threw; treating as fallback', {
|
|
228
|
+
err: formatViemError(err),
|
|
229
|
+
actions: requests.map(r => r.action),
|
|
230
|
+
});
|
|
231
|
+
return { kind: 'fallback' };
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
if (simResult.kind === 'fallback') {
|
|
235
|
+
return { kind: 'fallback' };
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
const survivors: RequestWithExpiry[] = [];
|
|
239
|
+
const droppedRequests: DroppedRequest[] = [];
|
|
240
|
+
for (let i = 0; i < requests.length; i++) {
|
|
241
|
+
const entry = simResult.entries[i];
|
|
242
|
+
if (entry.success) {
|
|
243
|
+
survivors.push(requests[i]);
|
|
244
|
+
continue;
|
|
245
|
+
}
|
|
246
|
+
droppedRequests.push({
|
|
247
|
+
request: requests[i],
|
|
248
|
+
revertReason: entry.revertReason,
|
|
249
|
+
returnData: entry.returnData,
|
|
250
|
+
});
|
|
251
|
+
}
|
|
252
|
+
return { kind: 'decoded', survivors, droppedRequests, gasUsed: simResult.gasUsed };
|
|
253
|
+
}
|
|
254
|
+
}
|