@aztec/sequencer-client 0.0.1-commit.343b43af6 → 0.0.1-commit.350e0a4d
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 +281 -21
- package/dest/client/sequencer-client.d.ts +23 -16
- package/dest/client/sequencer-client.d.ts.map +1 -1
- package/dest/client/sequencer-client.js +49 -94
- package/dest/config.d.ts +10 -2
- package/dest/config.d.ts.map +1 -1
- package/dest/config.js +61 -25
- 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 +138 -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 +80 -0
- package/dest/global_variable_builder/global_builder.d.ts +13 -26
- package/dest/global_variable_builder/global_builder.d.ts.map +1 -1
- package/dest/global_variable_builder/global_builder.js +9 -66
- 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/publisher/config.d.ts +19 -3
- package/dest/publisher/config.d.ts.map +1 -1
- package/dest/publisher/config.js +30 -5
- package/dest/publisher/l1_to_l2_messaging.d.ts +21 -0
- package/dest/publisher/l1_to_l2_messaging.d.ts.map +1 -0
- package/dest/publisher/l1_to_l2_messaging.js +70 -0
- package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts +50 -11
- package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts.map +1 -1
- package/dest/publisher/l1_tx_failed_store/failed_tx_store.js +68 -1
- package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.d.ts +2 -2
- package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.d.ts.map +1 -1
- package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.js +4 -2
- package/dest/publisher/l1_tx_failed_store/index.d.ts +2 -2
- package/dest/publisher/l1_tx_failed_store/index.d.ts.map +1 -1
- package/dest/publisher/l1_tx_failed_store/index.js +1 -0
- 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 +2 -3
- package/dest/publisher/sequencer-publisher.d.ts +103 -67
- package/dest/publisher/sequencer-publisher.d.ts.map +1 -1
- package/dest/publisher/sequencer-publisher.js +621 -525
- package/dest/publisher/write_json.d.ts +11 -0
- package/dest/publisher/write_json.d.ts.map +1 -0
- package/dest/publisher/write_json.js +57 -0
- package/dest/sequencer/automine/automine_factory.d.ts +56 -0
- package/dest/sequencer/automine/automine_factory.d.ts.map +1 -0
- package/dest/sequencer/automine/automine_factory.js +85 -0
- package/dest/sequencer/automine/automine_sequencer.d.ts +189 -0
- package/dest/sequencer/automine/automine_sequencer.d.ts.map +1 -0
- package/dest/sequencer/automine/automine_sequencer.js +690 -0
- package/dest/sequencer/automine/index.d.ts +3 -0
- package/dest/sequencer/automine/index.d.ts.map +1 -0
- package/dest/sequencer/automine/index.js +2 -0
- package/dest/sequencer/checkpoint_proposal_job.d.ts +75 -17
- package/dest/sequencer/checkpoint_proposal_job.d.ts.map +1 -1
- package/dest/sequencer/checkpoint_proposal_job.js +795 -239
- 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 +62 -5
- package/dest/sequencer/events.d.ts.map +1 -1
- 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/requests_tracker.d.ts +22 -0
- package/dest/sequencer/requests_tracker.d.ts.map +1 -0
- package/dest/sequencer/requests_tracker.js +33 -0
- package/dest/sequencer/sequencer.d.ts +159 -35
- package/dest/sequencer/sequencer.d.ts.map +1 -1
- package/dest/sequencer/sequencer.js +585 -188
- package/dest/sequencer/types.d.ts +2 -2
- package/dest/sequencer/types.d.ts.map +1 -1
- package/dest/test/index.d.ts +3 -3
- package/dest/test/index.d.ts.map +1 -1
- package/dest/test/mock_checkpoint_builder.d.ts +4 -4
- package/dest/test/mock_checkpoint_builder.d.ts.map +1 -1
- package/dest/test/utils.d.ts +15 -1
- package/dest/test/utils.d.ts.map +1 -1
- package/dest/test/utils.js +25 -7
- package/package.json +30 -29
- package/src/client/sequencer-client.ts +70 -124
- package/src/config.ts +71 -22
- package/src/global_variable_builder/README.md +44 -0
- package/src/global_variable_builder/fee_predictor.ts +182 -0
- package/src/global_variable_builder/fee_provider.ts +97 -0
- package/src/global_variable_builder/global_builder.ts +19 -88
- package/src/global_variable_builder/index.ts +3 -1
- package/src/publisher/config.ts +62 -7
- package/src/publisher/l1_to_l2_messaging.ts +85 -0
- package/src/publisher/l1_tx_failed_store/failed_tx_store.ts +117 -8
- package/src/publisher/l1_tx_failed_store/file_store_failed_tx_store.ts +4 -3
- package/src/publisher/l1_tx_failed_store/index.ts +1 -1
- package/src/publisher/sequencer-bundle-simulator.ts +254 -0
- package/src/publisher/sequencer-publisher-factory.ts +3 -6
- package/src/publisher/sequencer-publisher.ts +720 -600
- package/src/publisher/write_json.ts +78 -0
- package/src/sequencer/README.md +162 -450
- package/src/sequencer/automine/README.md +60 -0
- package/src/sequencer/automine/automine_factory.ts +152 -0
- package/src/sequencer/automine/automine_sequencer.ts +796 -0
- package/src/sequencer/automine/index.ts +6 -0
- package/src/sequencer/checkpoint_proposal_job.ts +958 -265
- package/src/sequencer/checkpoint_proposal_job_metrics.ts +128 -0
- package/src/sequencer/checkpoint_voter.ts +1 -12
- package/src/sequencer/events.ts +66 -5
- package/src/sequencer/metrics.ts +57 -24
- package/src/sequencer/requests_tracker.ts +43 -0
- package/src/sequencer/sequencer.ts +690 -209
- package/src/sequencer/types.ts +1 -1
- package/src/test/index.ts +2 -2
- package/src/test/mock_checkpoint_builder.ts +3 -3
- package/src/test/utils.ts +61 -10
- package/dest/sequencer/timetable.d.ts +0 -88
- package/dest/sequencer/timetable.d.ts.map +0 -1
- package/dest/sequencer/timetable.js +0 -222
- package/src/sequencer/timetable.ts +0 -283
|
@@ -1,19 +1,14 @@
|
|
|
1
1
|
import { MAX_PROCESSABLE_DA_GAS_PER_CHECKPOINT } from '@aztec/constants';
|
|
2
2
|
import { EpochCache } from '@aztec/epoch-cache';
|
|
3
|
-
import { isAnvilTestChain } from '@aztec/ethereum/chain';
|
|
4
3
|
import { getPublicClient } from '@aztec/ethereum/client';
|
|
5
4
|
import { GovernanceProposerContract, RollupContract } from '@aztec/ethereum/contracts';
|
|
6
5
|
import { PublisherManager } from '@aztec/ethereum/publisher-manager';
|
|
7
|
-
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
8
6
|
import { createLogger } from '@aztec/foundation/log';
|
|
9
|
-
import { SlashFactoryContract } from '@aztec/stdlib/l1-contracts';
|
|
10
7
|
import { L1Metrics } from '@aztec/telemetry-client';
|
|
11
8
|
import { NodeKeystoreAdapter } from '@aztec/validator-client';
|
|
12
|
-
import {
|
|
13
|
-
import { GlobalVariableBuilder } from '../global_variable_builder/index.js';
|
|
9
|
+
import { getPublisherConfigFromSequencerConfig } from '../config.js';
|
|
14
10
|
import { SequencerPublisherFactory } from '../publisher/sequencer-publisher-factory.js';
|
|
15
11
|
import { Sequencer } from '../sequencer/index.js';
|
|
16
|
-
import { SequencerTimetable } from '../sequencer/timetable.js';
|
|
17
12
|
/**
|
|
18
13
|
* Encapsulates the full sequencer and publisher.
|
|
19
14
|
*/ export class SequencerClient {
|
|
@@ -49,16 +44,18 @@ import { SequencerTimetable } from '../sequencer/timetable.js';
|
|
|
49
44
|
const publicClient = getPublicClient(config);
|
|
50
45
|
const l1TxUtils = deps.l1TxUtils;
|
|
51
46
|
const l1Metrics = new L1Metrics(telemetryClient.getMeter('L1PublisherMetrics'), publicClient, l1TxUtils.map((x)=>x.getSenderAddress()));
|
|
52
|
-
const publisherManager = new PublisherManager(l1TxUtils, getPublisherConfigFromSequencerConfig(config),
|
|
53
|
-
|
|
54
|
-
|
|
47
|
+
const publisherManager = new PublisherManager(l1TxUtils, getPublisherConfigFromSequencerConfig(config), {
|
|
48
|
+
bindings: log.getBindings(),
|
|
49
|
+
funder: deps.funderL1TxUtils
|
|
50
|
+
});
|
|
51
|
+
const rollupContract = new RollupContract(publicClient, config.rollupAddress.toString());
|
|
52
|
+
const [l1GenesisTime, slotDuration, rollupManaLimit] = await Promise.all([
|
|
55
53
|
rollupContract.getL1GenesisTime(),
|
|
56
54
|
rollupContract.getSlotDuration(),
|
|
57
|
-
rollupContract.getVersion(),
|
|
58
55
|
rollupContract.getManaLimit().then(Number)
|
|
59
56
|
]);
|
|
60
|
-
const governanceProposerContract = new GovernanceProposerContract(publicClient, config.
|
|
61
|
-
const epochCache = deps.epochCache ?? await EpochCache.create(config.
|
|
57
|
+
const governanceProposerContract = new GovernanceProposerContract(publicClient, config.governanceProposerAddress.toString());
|
|
58
|
+
const epochCache = deps.epochCache ?? await EpochCache.create(config.rollupAddress, {
|
|
62
59
|
l1RpcUrls: rpcUrls,
|
|
63
60
|
l1ChainId: chainId,
|
|
64
61
|
viemPollingIntervalMS: config.viemPollingIntervalMS,
|
|
@@ -66,13 +63,11 @@ import { SequencerTimetable } from '../sequencer/timetable.js';
|
|
|
66
63
|
}, {
|
|
67
64
|
dateProvider: deps.dateProvider
|
|
68
65
|
});
|
|
69
|
-
const slashFactoryContract = new SlashFactoryContract(publicClient, config.l1Contracts.slashFactoryAddress?.toString() ?? EthAddress.ZERO.toString());
|
|
70
66
|
const publisherFactory = deps.publisherFactory ?? new SequencerPublisherFactory(config, {
|
|
71
67
|
telemetry: telemetryClient,
|
|
72
68
|
blobClient: deps.blobClient,
|
|
73
69
|
epochCache,
|
|
74
70
|
governanceProposerContract,
|
|
75
|
-
slashFactoryContract,
|
|
76
71
|
rollupContract,
|
|
77
72
|
dateProvider: deps.dateProvider,
|
|
78
73
|
publisherManager,
|
|
@@ -80,30 +75,17 @@ import { SequencerTimetable } from '../sequencer/timetable.js';
|
|
|
80
75
|
logger: log
|
|
81
76
|
});
|
|
82
77
|
const ethereumSlotDuration = config.ethereumSlotDuration;
|
|
83
|
-
const globalsBuilder =
|
|
84
|
-
|
|
85
|
-
l1GenesisTime,
|
|
86
|
-
slotDuration: Number(slotDuration),
|
|
87
|
-
ethereumSlotDuration,
|
|
88
|
-
rollupVersion
|
|
89
|
-
});
|
|
90
|
-
// When running in anvil, assume we can post a tx up until one second before the end of an L1 slot.
|
|
91
|
-
// Otherwise, we need the full L1 slot duration for publishing to ensure inclusion.
|
|
92
|
-
// In theory, the L1 slot has an initial 4s phase where the block is propagated, so we could
|
|
93
|
-
// reduce the publishing time allowance. However, we prefer being conservative.
|
|
94
|
-
// See https://www.blocknative.com/blog/anatomy-of-a-slot#7 for more info.
|
|
95
|
-
const l1PublishingTimeBasedOnChain = isAnvilTestChain(config.l1ChainId) ? 1 : ethereumSlotDuration;
|
|
96
|
-
const l1PublishingTime = config.l1PublishingTime ?? l1PublishingTimeBasedOnChain;
|
|
97
|
-
const { maxL2BlockGas, maxDABlockGas, maxTxsPerBlock } = computeBlockLimits(config, rollupManaLimit, l1PublishingTime, log);
|
|
78
|
+
const globalsBuilder = deps.globalVariableBuilder;
|
|
79
|
+
const { maxL2BlockGas, maxDABlockGas, maxTxsPerBlock } = capPerBlockLimits(config, rollupManaLimit, log);
|
|
98
80
|
const l1Constants = {
|
|
99
81
|
l1GenesisTime,
|
|
100
82
|
slotDuration: Number(slotDuration),
|
|
101
83
|
ethereumSlotDuration,
|
|
102
|
-
rollupManaLimit
|
|
84
|
+
rollupManaLimit,
|
|
85
|
+
epochDuration: config.aztecEpochDuration
|
|
103
86
|
};
|
|
104
87
|
const sequencer = new Sequencer(publisherFactory, validatorClient, globalsBuilder, p2pClient, worldStateSynchronizer, slasherClient, l2BlockSource, l1ToL2MessageSource, checkpointsBuilder, l1Constants, deps.dateProvider, epochCache, rollupContract, {
|
|
105
88
|
...config,
|
|
106
|
-
l1PublishingTime,
|
|
107
89
|
maxL2BlockGas,
|
|
108
90
|
maxDABlockGas,
|
|
109
91
|
maxTxsPerBlock
|
|
@@ -121,20 +103,37 @@ import { SequencerTimetable } from '../sequencer/timetable.js';
|
|
|
121
103
|
this.checkpointsBuilder.updateConfig(config);
|
|
122
104
|
this.validatorClient?.updateConfig(config);
|
|
123
105
|
}
|
|
124
|
-
/**
|
|
106
|
+
/**
|
|
107
|
+
* Starts (or resumes) the sequencer, validator, publishers, and metrics. Each underlying start is
|
|
108
|
+
* idempotent, so this is safe to call after a previous {@link pause} to resume building and publishing.
|
|
109
|
+
* The publisher manager is started before the sequencer's poll loop so publishing is ready before the
|
|
110
|
+
* sequencer first tries to publish to L1.
|
|
111
|
+
*/ async start() {
|
|
125
112
|
await this.validatorClient?.start();
|
|
113
|
+
await this.publisherManager.start();
|
|
126
114
|
this.sequencer.start();
|
|
127
115
|
this.l1Metrics?.start();
|
|
128
|
-
await this.publisherManager.loadState();
|
|
129
116
|
}
|
|
130
117
|
/**
|
|
131
|
-
* Stops the sequencer
|
|
118
|
+
* Stops the sequencer, validator, publishers, and metrics for good, draining in-flight work. This is the
|
|
119
|
+
* final teardown path: stopping the validator client closes its slashing-protection database. For a
|
|
120
|
+
* restartable pause (e.g. around a test clock warp) use {@link pause} instead.
|
|
132
121
|
*/ async stop() {
|
|
133
122
|
await this.sequencer.stop();
|
|
134
123
|
await this.validatorClient?.stop();
|
|
135
|
-
this.publisherManager.
|
|
124
|
+
await this.publisherManager.stop();
|
|
136
125
|
this.l1Metrics?.stop();
|
|
137
126
|
}
|
|
127
|
+
/**
|
|
128
|
+
* Gracefully pauses block production, waiting for in-flight work to finish rather than interrupting it,
|
|
129
|
+
* while leaving the validator, publishers, and metrics running so the sequencer can be resumed with
|
|
130
|
+
* {@link start}. Used by tests that pause sequencers around an L1 clock warp.
|
|
131
|
+
*/ async pause() {
|
|
132
|
+
await this.sequencer.pause();
|
|
133
|
+
}
|
|
134
|
+
/** Triggers an immediate run of the sequencer, bypassing the polling interval. */ trigger() {
|
|
135
|
+
return this.sequencer.trigger();
|
|
136
|
+
}
|
|
138
137
|
getSequencer() {
|
|
139
138
|
return this.sequencer;
|
|
140
139
|
}
|
|
@@ -152,68 +151,24 @@ import { SequencerTimetable } from '../sequencer/timetable.js';
|
|
|
152
151
|
}
|
|
153
152
|
}
|
|
154
153
|
/**
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
l1PublishingTime,
|
|
163
|
-
p2pPropagationTime: config.attestationPropagationTime,
|
|
164
|
-
blockDurationMs: config.blockDurationMs,
|
|
165
|
-
enforce: config.enforceTimeTable ?? DefaultSequencerConfig.enforceTimeTable
|
|
166
|
-
}).maxNumberOfBlocks;
|
|
167
|
-
const multiplier = config.perBlockAllocationMultiplier ?? DefaultSequencerConfig.perBlockAllocationMultiplier;
|
|
168
|
-
// Compute maxL2BlockGas
|
|
169
|
-
let maxL2BlockGas;
|
|
170
|
-
if (config.maxL2BlockGas !== undefined) {
|
|
171
|
-
if (config.maxL2BlockGas > rollupManaLimit) {
|
|
172
|
-
log.warn(`Provided MAX_L2_BLOCK_GAS ${config.maxL2BlockGas} exceeds L1 rollup mana limit ${rollupManaLimit} (capping)`);
|
|
173
|
-
maxL2BlockGas = rollupManaLimit;
|
|
174
|
-
} else {
|
|
175
|
-
maxL2BlockGas = config.maxL2BlockGas;
|
|
176
|
-
}
|
|
177
|
-
} else {
|
|
178
|
-
maxL2BlockGas = Math.min(rollupManaLimit, Math.ceil(rollupManaLimit / maxNumberOfBlocks * multiplier));
|
|
154
|
+
* Caps operator-provided per-block limits at checkpoint-level limits.
|
|
155
|
+
* Returns undefined for any limit the operator didn't set — the checkpoint builder handles redistribution.
|
|
156
|
+
*/ function capPerBlockLimits(config, rollupManaLimit, log) {
|
|
157
|
+
let maxL2BlockGas = config.maxL2BlockGas;
|
|
158
|
+
if (maxL2BlockGas !== undefined && maxL2BlockGas > rollupManaLimit) {
|
|
159
|
+
log.warn(`Provided MAX_L2_BLOCK_GAS ${maxL2BlockGas} exceeds rollup mana limit ${rollupManaLimit} (capping)`);
|
|
160
|
+
maxL2BlockGas = rollupManaLimit;
|
|
179
161
|
}
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
if (config.maxDABlockGas > daCheckpointLimit) {
|
|
185
|
-
log.warn(`Provided MAX_DA_BLOCK_GAS ${config.maxDABlockGas} exceeds DA checkpoint limit ${daCheckpointLimit} (capping)`);
|
|
186
|
-
maxDABlockGas = daCheckpointLimit;
|
|
187
|
-
} else {
|
|
188
|
-
maxDABlockGas = config.maxDABlockGas;
|
|
189
|
-
}
|
|
190
|
-
} else {
|
|
191
|
-
maxDABlockGas = Math.min(daCheckpointLimit, Math.ceil(daCheckpointLimit / maxNumberOfBlocks * multiplier));
|
|
162
|
+
let maxDABlockGas = config.maxDABlockGas;
|
|
163
|
+
if (maxDABlockGas !== undefined && maxDABlockGas > MAX_PROCESSABLE_DA_GAS_PER_CHECKPOINT) {
|
|
164
|
+
log.warn(`Provided MAX_DA_BLOCK_GAS ${maxDABlockGas} exceeds DA checkpoint limit ${MAX_PROCESSABLE_DA_GAS_PER_CHECKPOINT} (capping)`);
|
|
165
|
+
maxDABlockGas = MAX_PROCESSABLE_DA_GAS_PER_CHECKPOINT;
|
|
192
166
|
}
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
if (config.maxTxsPerCheckpoint !== undefined && config.maxTxsPerBlock > config.maxTxsPerCheckpoint) {
|
|
198
|
-
log.warn(`Provided MAX_TX_PER_BLOCK ${config.maxTxsPerBlock} exceeds MAX_TX_PER_CHECKPOINT ${config.maxTxsPerCheckpoint} (capping)`);
|
|
199
|
-
maxTxsPerBlock = config.maxTxsPerCheckpoint;
|
|
200
|
-
} else {
|
|
201
|
-
maxTxsPerBlock = config.maxTxsPerBlock;
|
|
202
|
-
}
|
|
203
|
-
} else if (config.maxTxsPerCheckpoint !== undefined) {
|
|
204
|
-
maxTxsPerBlock = Math.min(config.maxTxsPerCheckpoint, Math.ceil(config.maxTxsPerCheckpoint / maxNumberOfBlocks * multiplier));
|
|
205
|
-
} else {
|
|
206
|
-
maxTxsPerBlock = defaultMaxTxsPerBlock;
|
|
167
|
+
let maxTxsPerBlock = config.maxTxsPerBlock;
|
|
168
|
+
if (maxTxsPerBlock !== undefined && config.maxTxsPerCheckpoint !== undefined && maxTxsPerBlock > config.maxTxsPerCheckpoint) {
|
|
169
|
+
log.warn(`Provided MAX_TX_PER_BLOCK ${maxTxsPerBlock} exceeds MAX_TX_PER_CHECKPOINT ${config.maxTxsPerCheckpoint} (capping)`);
|
|
170
|
+
maxTxsPerBlock = config.maxTxsPerCheckpoint;
|
|
207
171
|
}
|
|
208
|
-
log.info(`Computed block limits L2=${maxL2BlockGas} DA=${maxDABlockGas} maxTxs=${maxTxsPerBlock}`, {
|
|
209
|
-
maxL2BlockGas,
|
|
210
|
-
maxDABlockGas,
|
|
211
|
-
maxTxsPerBlock,
|
|
212
|
-
rollupManaLimit,
|
|
213
|
-
daCheckpointLimit,
|
|
214
|
-
maxNumberOfBlocks,
|
|
215
|
-
multiplier
|
|
216
|
-
});
|
|
217
172
|
return {
|
|
218
173
|
maxL2BlockGas,
|
|
219
174
|
maxDABlockGas,
|
package/dest/config.d.ts
CHANGED
|
@@ -18,20 +18,28 @@ export declare const DefaultSequencerConfig: {
|
|
|
18
18
|
buildCheckpointIfEmpty: false;
|
|
19
19
|
publishTxsWithProposals: false;
|
|
20
20
|
perBlockAllocationMultiplier: number;
|
|
21
|
-
|
|
21
|
+
perBlockDAAllocationMultiplier: number;
|
|
22
|
+
redistributeCheckpointBudget: true;
|
|
23
|
+
blockDurationMs: number;
|
|
24
|
+
l1PublishingTime: number;
|
|
25
|
+
checkpointProposalSyncGraceSeconds: number;
|
|
22
26
|
attestationPropagationTime: number;
|
|
23
27
|
secondsBeforeInvalidatingBlockAsCommitteeMember: number;
|
|
24
28
|
secondsBeforeInvalidatingBlockAsNonCommitteeMember: number;
|
|
25
29
|
skipCollectingAttestations: false;
|
|
26
30
|
skipInvalidateBlockAsProposer: false;
|
|
31
|
+
skipWaitForValidParentCheckpointOnL1: false;
|
|
27
32
|
broadcastInvalidBlockProposal: false;
|
|
33
|
+
broadcastInvalidCheckpointProposalOnly: false;
|
|
28
34
|
injectFakeAttestation: false;
|
|
29
35
|
injectHighSValueAttestation: false;
|
|
30
36
|
injectUnrecoverableSignatureAttestation: false;
|
|
37
|
+
injectYParityAttestation: false;
|
|
31
38
|
fishermanMode: false;
|
|
32
39
|
shuffleAttestationOrdering: false;
|
|
33
40
|
skipPushProposedBlocksToArchiver: false;
|
|
34
41
|
skipPublishingCheckpointsPercent: number;
|
|
42
|
+
maxBlocksPerCheckpoint: number;
|
|
35
43
|
};
|
|
36
44
|
/**
|
|
37
45
|
* Configuration settings for the SequencerClient.
|
|
@@ -43,4 +51,4 @@ export declare const sequencerClientConfigMappings: ConfigMappingsType<Sequencer
|
|
|
43
51
|
* Creates an instance of SequencerClientConfig out of environment variables using sensible defaults for integration testing if not set.
|
|
44
52
|
*/
|
|
45
53
|
export declare function getConfigEnvVars(): SequencerClientConfig;
|
|
46
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
54
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvY29uZmlnLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxLQUFLLGlCQUFpQixFQUE2QixNQUFNLHdCQUF3QixDQUFDO0FBQzNGLE9BQU8sRUFBRSxLQUFLLGNBQWMsRUFBMEIsTUFBTSwyQkFBMkIsQ0FBQztBQUN4RixPQUFPLEVBQ0wsS0FBSyxrQkFBa0IsRUFPeEIsTUFBTSwwQkFBMEIsQ0FBQztBQUVsQyxPQUFPLEVBQUUsS0FBSyxjQUFjLEVBQTBCLE1BQU0sNkJBQTZCLENBQUM7QUFDMUYsT0FBTyxFQUFFLEtBQUssU0FBUyxFQUFxQixNQUFNLG1CQUFtQixDQUFDO0FBRXRFLE9BQU8sRUFDTCxLQUFLLFdBQVcsRUFHaEIsS0FBSyxlQUFlLEVBR3JCLE1BQU0sc0JBQXNCLENBQUM7QUFJOUIsT0FBTyxFQUFFLEtBQUsscUJBQXFCLEVBQWlDLE1BQU0sZ0NBQWdDLENBQUM7QUFFM0csT0FBTyxFQUNMLEtBQUssd0JBQXdCLEVBQzdCLEtBQUssdUJBQXVCLEVBRzdCLE1BQU0sdUJBQXVCLENBQUM7QUFFL0IsY0FBYyx1QkFBdUIsQ0FBQztBQUN0QyxZQUFZLEVBQUUsZUFBZSxFQUFFLENBQUM7QUFFaEM7OztHQUdHO0FBQ0gsZUFBTyxNQUFNLHNCQUFzQjs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztDQTRCQSxDQUFDO0FBRXBDOztHQUVHO0FBQ0gsTUFBTSxNQUFNLHFCQUFxQixHQUFHLHdCQUF3QixHQUMxRCxjQUFjLEdBQ2QscUJBQXFCLEdBQ3JCLHVCQUF1QixHQUN2QixlQUFlLEdBQ2YsY0FBYyxHQUNkLFdBQVcsR0FDWCxJQUFJLENBQUMsU0FBUyxFQUFFLDhCQUE4QixDQUFDLEdBQy9DLElBQUksQ0FBQyxpQkFBaUIsRUFBRSxzQkFBc0IsR0FBRyxtQkFBbUIsR0FBRyxvQkFBb0IsQ0FBQyxDQUFDO0FBRS9GLGVBQU8sTUFBTSx1QkFBdUIsRUFBRSxrQkFBa0IsQ0FBQyxlQUFlLENBOEx2RSxDQUFDO0FBRUYsZUFBTyxNQUFNLDZCQUE2QixFQUFFLGtCQUFrQixDQUFDLHFCQUFxQixDQVNuRixDQUFDO0FBRUY7O0dBRUc7QUFDSCx3QkFBZ0IsZ0JBQWdCLElBQUkscUJBQXFCLENBRXhEIn0=
|
package/dest/config.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAA6B,MAAM,wBAAwB,CAAC;AAC3F,OAAO,EAAE,KAAK,cAAc,EAA0B,MAAM,2BAA2B,CAAC;AACxF,OAAO,EACL,KAAK,kBAAkB,
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAA6B,MAAM,wBAAwB,CAAC;AAC3F,OAAO,EAAE,KAAK,cAAc,EAA0B,MAAM,2BAA2B,CAAC;AACxF,OAAO,EACL,KAAK,kBAAkB,EAOxB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,KAAK,cAAc,EAA0B,MAAM,6BAA6B,CAAC;AAC1F,OAAO,EAAE,KAAK,SAAS,EAAqB,MAAM,mBAAmB,CAAC;AAEtE,OAAO,EACL,KAAK,WAAW,EAGhB,KAAK,eAAe,EAGrB,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAAE,KAAK,qBAAqB,EAAiC,MAAM,gCAAgC,CAAC;AAE3G,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAG7B,MAAM,uBAAuB,CAAC;AAE/B,cAAc,uBAAuB,CAAC;AACtC,YAAY,EAAE,eAAe,EAAE,CAAC;AAEhC;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BA,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,wBAAwB,GAC1D,cAAc,GACd,qBAAqB,GACrB,uBAAuB,GACvB,eAAe,GACf,cAAc,GACd,WAAW,GACX,IAAI,CAAC,SAAS,EAAE,8BAA8B,CAAC,GAC/C,IAAI,CAAC,iBAAiB,EAAE,sBAAsB,GAAG,mBAAmB,GAAG,oBAAoB,CAAC,CAAC;AAE/F,eAAO,MAAM,uBAAuB,EAAE,kBAAkB,CAAC,eAAe,CA8LvE,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,kBAAkB,CAAC,qBAAqB,CASnF,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,qBAAqB,CAExD"}
|
package/dest/config.js
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import { l1ContractsConfigMappings } from '@aztec/ethereum/config';
|
|
2
2
|
import { l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
|
|
3
|
-
import { booleanConfigHelper, getConfigFromMappings, numberConfigHelper, pickConfigMappings } from '@aztec/foundation/config';
|
|
3
|
+
import { booleanConfigHelper, floatConfigHelper, getConfigFromMappings, numberConfigHelper, optionalNumberConfigHelper, pickConfigMappings } from '@aztec/foundation/config';
|
|
4
4
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
5
5
|
import { keyStoreConfigMappings } from '@aztec/node-keystore/config';
|
|
6
6
|
import { p2pConfigMappings } from '@aztec/p2p/config';
|
|
7
7
|
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
8
|
-
import { chainConfigMappings, sharedSequencerConfigMappings } from '@aztec/stdlib/config';
|
|
8
|
+
import { DEFAULT_BLOCK_DURATION_MS, DEFAULT_MAX_BLOCKS_PER_CHECKPOINT, chainConfigMappings, sharedSequencerConfigMappings } from '@aztec/stdlib/config';
|
|
9
|
+
import { MIN_PER_BLOCK_ALLOCATION_MULTIPLIER, MIN_PER_BLOCK_DA_ALLOCATION_MULTIPLIER } from '@aztec/stdlib/gas';
|
|
9
10
|
import { DEFAULT_P2P_PROPAGATION_TIME } from '@aztec/stdlib/timetable';
|
|
10
11
|
import { validatorClientConfigMappings } from '@aztec/validator-client/config';
|
|
11
12
|
import { sequencerPublisherConfigMappings, sequencerTxSenderConfigMappings } from './publisher/config.js';
|
|
@@ -18,21 +19,29 @@ export * from './publisher/config.js';
|
|
|
18
19
|
minTxsPerBlock: 1,
|
|
19
20
|
buildCheckpointIfEmpty: false,
|
|
20
21
|
publishTxsWithProposals: false,
|
|
21
|
-
perBlockAllocationMultiplier:
|
|
22
|
-
|
|
22
|
+
perBlockAllocationMultiplier: MIN_PER_BLOCK_ALLOCATION_MULTIPLIER,
|
|
23
|
+
perBlockDAAllocationMultiplier: MIN_PER_BLOCK_DA_ALLOCATION_MULTIPLIER,
|
|
24
|
+
redistributeCheckpointBudget: true,
|
|
25
|
+
blockDurationMs: DEFAULT_BLOCK_DURATION_MS,
|
|
26
|
+
l1PublishingTime: 12,
|
|
27
|
+
checkpointProposalSyncGraceSeconds: 2 * (DEFAULT_BLOCK_DURATION_MS / 1000),
|
|
23
28
|
attestationPropagationTime: DEFAULT_P2P_PROPAGATION_TIME,
|
|
24
29
|
secondsBeforeInvalidatingBlockAsCommitteeMember: 144,
|
|
25
30
|
secondsBeforeInvalidatingBlockAsNonCommitteeMember: 432,
|
|
26
31
|
skipCollectingAttestations: false,
|
|
27
32
|
skipInvalidateBlockAsProposer: false,
|
|
33
|
+
skipWaitForValidParentCheckpointOnL1: false,
|
|
28
34
|
broadcastInvalidBlockProposal: false,
|
|
35
|
+
broadcastInvalidCheckpointProposalOnly: false,
|
|
29
36
|
injectFakeAttestation: false,
|
|
30
37
|
injectHighSValueAttestation: false,
|
|
31
38
|
injectUnrecoverableSignatureAttestation: false,
|
|
39
|
+
injectYParityAttestation: false,
|
|
32
40
|
fishermanMode: false,
|
|
33
41
|
shuffleAttestationOrdering: false,
|
|
34
42
|
skipPushProposedBlocksToArchiver: false,
|
|
35
|
-
skipPublishingCheckpointsPercent: 0
|
|
43
|
+
skipPublishingCheckpointsPercent: 0,
|
|
44
|
+
maxBlocksPerCheckpoint: DEFAULT_MAX_BLOCKS_PER_CHECKPOINT
|
|
36
45
|
};
|
|
37
46
|
export const sequencerConfigMappings = {
|
|
38
47
|
sequencerPollingIntervalMS: {
|
|
@@ -43,7 +52,7 @@ export const sequencerConfigMappings = {
|
|
|
43
52
|
maxTxsPerCheckpoint: {
|
|
44
53
|
env: 'SEQ_MAX_TX_PER_CHECKPOINT',
|
|
45
54
|
description: 'The maximum number of txs across all blocks in a checkpoint.',
|
|
46
|
-
|
|
55
|
+
...optionalNumberConfigHelper()
|
|
47
56
|
},
|
|
48
57
|
minTxsPerBlock: {
|
|
49
58
|
env: 'SEQ_MIN_TX_PER_BLOCK',
|
|
@@ -61,26 +70,36 @@ export const sequencerConfigMappings = {
|
|
|
61
70
|
maxL2BlockGas: {
|
|
62
71
|
env: 'SEQ_MAX_L2_BLOCK_GAS',
|
|
63
72
|
description: 'The maximum L2 block gas.',
|
|
64
|
-
|
|
73
|
+
...optionalNumberConfigHelper()
|
|
65
74
|
},
|
|
66
75
|
maxDABlockGas: {
|
|
67
76
|
env: 'SEQ_MAX_DA_BLOCK_GAS',
|
|
68
77
|
description: 'The maximum DA block gas.',
|
|
69
|
-
|
|
78
|
+
...optionalNumberConfigHelper()
|
|
70
79
|
},
|
|
71
80
|
perBlockAllocationMultiplier: {
|
|
72
81
|
env: 'SEQ_PER_BLOCK_ALLOCATION_MULTIPLIER',
|
|
73
82
|
description: 'Per-block gas budget multiplier for both L2 and DA gas. Budget per block is (checkpointLimit / maxBlocks) * multiplier.' + ' Values greater than one allow early blocks to use more than their even share, relying on checkpoint-level capping for later blocks.',
|
|
74
|
-
...
|
|
83
|
+
...floatConfigHelper(DefaultSequencerConfig.perBlockAllocationMultiplier)
|
|
84
|
+
},
|
|
85
|
+
perBlockDAAllocationMultiplier: {
|
|
86
|
+
env: 'SEQ_PER_BLOCK_DA_ALLOCATION_MULTIPLIER',
|
|
87
|
+
description: 'Per-block budget multiplier applied to DA gas and blob fields in place of perBlockAllocationMultiplier.' + ' Defaults higher than the general multiplier so the largest contract class deploy fits a single block.',
|
|
88
|
+
...floatConfigHelper(DefaultSequencerConfig.perBlockDAAllocationMultiplier)
|
|
89
|
+
},
|
|
90
|
+
redistributeCheckpointBudget: {
|
|
91
|
+
env: 'SEQ_REDISTRIBUTE_CHECKPOINT_BUDGET',
|
|
92
|
+
description: 'Redistribute remaining checkpoint budget evenly across remaining blocks instead of allowing a single block to consume the entire remaining budget.',
|
|
93
|
+
...booleanConfigHelper(DefaultSequencerConfig.redistributeCheckpointBudget)
|
|
75
94
|
},
|
|
76
95
|
coinbase: {
|
|
77
96
|
env: 'COINBASE',
|
|
78
|
-
parseEnv: (val)=>
|
|
97
|
+
parseEnv: (val)=>EthAddress.fromString(val),
|
|
79
98
|
description: 'Recipient of block reward.'
|
|
80
99
|
},
|
|
81
100
|
feeRecipient: {
|
|
82
101
|
env: 'FEE_RECIPIENT',
|
|
83
|
-
parseEnv: (val)=>AztecAddress.
|
|
102
|
+
parseEnv: (val)=>AztecAddress.fromStringUnsafe(val),
|
|
84
103
|
description: 'Address to receive fees.'
|
|
85
104
|
},
|
|
86
105
|
acvmWorkingDirectory: {
|
|
@@ -91,11 +110,6 @@ export const sequencerConfigMappings = {
|
|
|
91
110
|
env: 'ACVM_BINARY_PATH',
|
|
92
111
|
description: 'The path to the ACVM binary'
|
|
93
112
|
},
|
|
94
|
-
enforceTimeTable: {
|
|
95
|
-
env: 'SEQ_ENFORCE_TIME_TABLE',
|
|
96
|
-
description: 'Whether to enforce the time table when building blocks',
|
|
97
|
-
...booleanConfigHelper(DefaultSequencerConfig.enforceTimeTable)
|
|
98
|
-
},
|
|
99
113
|
governanceProposerPayload: {
|
|
100
114
|
env: 'GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS',
|
|
101
115
|
description: 'The address of the payload for the governanceProposer',
|
|
@@ -103,13 +117,8 @@ export const sequencerConfigMappings = {
|
|
|
103
117
|
},
|
|
104
118
|
l1PublishingTime: {
|
|
105
119
|
env: 'SEQ_L1_PUBLISHING_TIME_ALLOWANCE_IN_SLOT',
|
|
106
|
-
description: 'How much time
|
|
107
|
-
|
|
108
|
-
},
|
|
109
|
-
attestationPropagationTime: {
|
|
110
|
-
env: 'SEQ_ATTESTATION_PROPAGATION_TIME',
|
|
111
|
-
description: 'How many seconds it takes for proposals and attestations to travel across the p2p layer (one-way)',
|
|
112
|
-
...numberConfigHelper(DefaultSequencerConfig.attestationPropagationTime)
|
|
120
|
+
description: 'How much time in seconds to allow in the slot for publishing the L1 transaction.',
|
|
121
|
+
...numberConfigHelper(DefaultSequencerConfig.l1PublishingTime)
|
|
113
122
|
},
|
|
114
123
|
fakeProcessingDelayPerTxMs: {
|
|
115
124
|
description: 'Used for testing to introduce a fake delay after processing each tx'
|
|
@@ -135,10 +144,22 @@ export const sequencerConfigMappings = {
|
|
|
135
144
|
description: 'Do not invalidate the previous block if invalid when we are the proposer (for testing only)',
|
|
136
145
|
...booleanConfigHelper(DefaultSequencerConfig.skipInvalidateBlockAsProposer)
|
|
137
146
|
},
|
|
147
|
+
skipWaitForValidParentCheckpointOnL1: {
|
|
148
|
+
description: 'Bypass the parent checkpoint validity check before submitting a pipelined checkpoint, ' + 'allowing the proposer to publish even when the parent landed on L1 with invalid attestations (for testing only)',
|
|
149
|
+
...booleanConfigHelper(DefaultSequencerConfig.skipWaitForValidParentCheckpointOnL1)
|
|
150
|
+
},
|
|
138
151
|
broadcastInvalidBlockProposal: {
|
|
139
152
|
description: 'Broadcast invalid block proposals with corrupted state (for testing only)',
|
|
140
153
|
...booleanConfigHelper(DefaultSequencerConfig.broadcastInvalidBlockProposal)
|
|
141
154
|
},
|
|
155
|
+
invalidBlockProposalIndexWithinCheckpoint: {
|
|
156
|
+
description: 'Broadcast an invalid block proposal only at this indexWithinCheckpoint (for testing only)',
|
|
157
|
+
...optionalNumberConfigHelper()
|
|
158
|
+
},
|
|
159
|
+
broadcastInvalidCheckpointProposalOnly: {
|
|
160
|
+
description: 'Broadcast invalid checkpoint proposals while keeping the underlying block proposals valid (for testing only). When unset, the checkpoint follows broadcastInvalidBlockProposal.',
|
|
161
|
+
...booleanConfigHelper(DefaultSequencerConfig.broadcastInvalidCheckpointProposalOnly)
|
|
162
|
+
},
|
|
142
163
|
injectFakeAttestation: {
|
|
143
164
|
description: 'Inject a fake attestation (for testing only)',
|
|
144
165
|
...booleanConfigHelper(DefaultSequencerConfig.injectFakeAttestation)
|
|
@@ -151,6 +172,10 @@ export const sequencerConfigMappings = {
|
|
|
151
172
|
description: 'Inject an attestation with an unrecoverable signature (for testing only)',
|
|
152
173
|
...booleanConfigHelper(DefaultSequencerConfig.injectUnrecoverableSignatureAttestation)
|
|
153
174
|
},
|
|
175
|
+
injectYParityAttestation: {
|
|
176
|
+
description: 'Inject a non-proposer attestation slot in yParity form in the packed L1 tuple (for testing only)',
|
|
177
|
+
...booleanConfigHelper(DefaultSequencerConfig.injectYParityAttestation)
|
|
178
|
+
},
|
|
154
179
|
fishermanMode: {
|
|
155
180
|
env: 'FISHERMAN_MODE',
|
|
156
181
|
description: 'Whether to run in fisherman mode: builds blocks on every slot for validation without publishing to L1',
|
|
@@ -167,7 +192,7 @@ export const sequencerConfigMappings = {
|
|
|
167
192
|
...booleanConfigHelper(DefaultSequencerConfig.buildCheckpointIfEmpty)
|
|
168
193
|
},
|
|
169
194
|
skipPushProposedBlocksToArchiver: {
|
|
170
|
-
description: 'Skip pushing proposed blocks to archiver (
|
|
195
|
+
description: 'Skip pushing proposed blocks to archiver (test only)',
|
|
171
196
|
...booleanConfigHelper(DefaultSequencerConfig.skipPushProposedBlocksToArchiver)
|
|
172
197
|
},
|
|
173
198
|
minBlocksForCheckpoint: {
|
|
@@ -178,18 +203,29 @@ export const sequencerConfigMappings = {
|
|
|
178
203
|
description: 'Percent probability (0 - 100) of sequencer skipping checkpoint publishing (testing only)',
|
|
179
204
|
...numberConfigHelper(DefaultSequencerConfig.skipPublishingCheckpointsPercent)
|
|
180
205
|
},
|
|
206
|
+
skipBroadcastProposals: {
|
|
207
|
+
description: 'Skip broadcasting checkpoint and block proposals via gossipsub when proposer (for testing only)',
|
|
208
|
+
...booleanConfigHelper(false)
|
|
209
|
+
},
|
|
210
|
+
skipBroadcastCheckpointProposal: {
|
|
211
|
+
description: 'Skip broadcasting only the CheckpointProposal via gossipsub when proposer; the held last block is broadcast ' + 'standalone instead so peers still receive it as a proposed-but-uncheckpointed tip (for testing only)',
|
|
212
|
+
...booleanConfigHelper(false)
|
|
213
|
+
},
|
|
214
|
+
pauseProposingForSlots: {
|
|
215
|
+
description: 'List of slots for which the sequencer will not produce a proposal (for testing only). Attestation paths are unaffected.'
|
|
216
|
+
},
|
|
181
217
|
...pickConfigMappings(p2pConfigMappings, [
|
|
182
218
|
'txPublicSetupAllowListExtend'
|
|
183
219
|
])
|
|
184
220
|
};
|
|
185
221
|
export const sequencerClientConfigMappings = {
|
|
222
|
+
...chainConfigMappings,
|
|
186
223
|
...validatorClientConfigMappings,
|
|
187
224
|
...sequencerConfigMappings,
|
|
188
225
|
...keyStoreConfigMappings,
|
|
189
226
|
...l1ReaderConfigMappings,
|
|
190
227
|
...sequencerTxSenderConfigMappings,
|
|
191
228
|
...sequencerPublisherConfigMappings,
|
|
192
|
-
...chainConfigMappings,
|
|
193
229
|
...pickConfigMappings(l1ContractsConfigMappings, [
|
|
194
230
|
'ethereumSlotDuration',
|
|
195
231
|
'aztecSlotDuration',
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { type RollupContract } from '@aztec/ethereum/contracts';
|
|
2
|
+
import type { DateProvider } from '@aztec/foundation/timer';
|
|
3
|
+
import { GasFees, ManaUsageEstimate } from '@aztec/stdlib/gas';
|
|
4
|
+
/**
|
|
5
|
+
* Predicts min fees for LAG upcoming slots based on the L1 oracle state.
|
|
6
|
+
* A new oracle update can activate at startSlot + LAG, so only the first LAG entries
|
|
7
|
+
* are guaranteed stable. Caches L1 queries per L1 block and recomputes predictions
|
|
8
|
+
* for each mana usage estimate.
|
|
9
|
+
*/
|
|
10
|
+
export declare class FeePredictor {
|
|
11
|
+
private readonly rollupContract;
|
|
12
|
+
private readonly publicClient;
|
|
13
|
+
private readonly dateProvider;
|
|
14
|
+
private cachedState;
|
|
15
|
+
private cachedL1BlockNumber;
|
|
16
|
+
private readonly slotDuration;
|
|
17
|
+
private readonly l1GenesisTime;
|
|
18
|
+
private readonly ethereumSlotDuration;
|
|
19
|
+
constructor(rollupContract: RollupContract, publicClient: {
|
|
20
|
+
getBlockNumber: (opts?: {
|
|
21
|
+
cacheTime?: number;
|
|
22
|
+
}) => Promise<bigint>;
|
|
23
|
+
}, dateProvider: DateProvider, config: {
|
|
24
|
+
slotDuration: number;
|
|
25
|
+
l1GenesisTime: bigint;
|
|
26
|
+
ethereumSlotDuration: number;
|
|
27
|
+
});
|
|
28
|
+
/** Returns predicted min fees for each slot in the prediction window. */
|
|
29
|
+
getPredictedMinFees(manaUsage: ManaUsageEstimate): Promise<GasFees[]>;
|
|
30
|
+
private getState;
|
|
31
|
+
private fetchState;
|
|
32
|
+
/** Computes per-slot fee predictions given cached state and a mana usage assumption. */
|
|
33
|
+
private computePredictions;
|
|
34
|
+
private getAssumedManaUsed;
|
|
35
|
+
private computeGasFees;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZmVlX3ByZWRpY3Rvci5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2dsb2JhbF92YXJpYWJsZV9idWlsZGVyL2ZlZV9wcmVkaWN0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFvRCxLQUFLLGNBQWMsRUFBRSxNQUFNLDJCQUEyQixDQUFDO0FBR2xILE9BQU8sS0FBSyxFQUFFLFlBQVksRUFBRSxNQUFNLHlCQUF5QixDQUFDO0FBRTVELE9BQU8sRUFFTCxPQUFPLEVBRVAsaUJBQWlCLEVBR2xCLE1BQU0sbUJBQW1CLENBQUM7QUFlM0I7Ozs7O0dBS0c7QUFDSCxxQkFBYSxZQUFZO0lBU3JCLE9BQU8sQ0FBQyxRQUFRLENBQUMsY0FBYztJQUMvQixPQUFPLENBQUMsUUFBUSxDQUFDLFlBQVk7SUFDN0IsT0FBTyxDQUFDLFFBQVEsQ0FBQyxZQUFZO0lBVi9CLE9BQU8sQ0FBQyxXQUFXLENBQXNDO0lBQ3pELE9BQU8sQ0FBQyxtQkFBbUIsQ0FBcUI7SUFFaEQsT0FBTyxDQUFDLFFBQVEsQ0FBQyxZQUFZLENBQVM7SUFDdEMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxhQUFhLENBQVM7SUFDdkMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxvQkFBb0IsQ0FBUztJQUU5QyxZQUNtQixjQUFjLEVBQUUsY0FBYyxFQUM5QixZQUFZLEVBQUU7UUFBRSxjQUFjLEVBQUUsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUFFLFNBQVMsQ0FBQyxFQUFFLE1BQU0sQ0FBQTtTQUFFLEtBQUssT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0tBQUUsRUFDcEYsWUFBWSxFQUFFLFlBQVksRUFDM0MsTUFBTSxFQUFFO1FBQUUsWUFBWSxFQUFFLE1BQU0sQ0FBQztRQUFDLGFBQWEsRUFBRSxNQUFNLENBQUM7UUFBQyxvQkFBb0IsRUFBRSxNQUFNLENBQUE7S0FBRSxFQUt0RjtJQUVELHlFQUF5RTtJQUNuRSxtQkFBbUIsQ0FBQyxTQUFTLEVBQUUsaUJBQWlCLEdBQUcsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFDLENBRzFFO1lBR2EsUUFBUTtZQW1CUixVQUFVO0lBaUR4Qix3RkFBd0Y7SUFDeEYsT0FBTyxDQUFDLGtCQUFrQjtJQXVCMUIsT0FBTyxDQUFDLGtCQUFrQjtJQVcxQixPQUFPLENBQUMsY0FBYztDQW1CdkIifQ==
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fee_predictor.d.ts","sourceRoot":"","sources":["../../src/global_variable_builder/fee_predictor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoD,KAAK,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAGlH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAE5D,OAAO,EAEL,OAAO,EAEP,iBAAiB,EAGlB,MAAM,mBAAmB,CAAC;AAe3B;;;;;GAKG;AACH,qBAAa,YAAY;IASrB,OAAO,CAAC,QAAQ,CAAC,cAAc;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAV/B,OAAO,CAAC,WAAW,CAAsC;IACzD,OAAO,CAAC,mBAAmB,CAAqB;IAEhD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAE9C,YACmB,cAAc,EAAE,cAAc,EAC9B,YAAY,EAAE;QAAE,cAAc,EAAE,CAAC,IAAI,CAAC,EAAE;YAAE,SAAS,CAAC,EAAE,MAAM,CAAA;SAAE,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;KAAE,EACpF,YAAY,EAAE,YAAY,EAC3C,MAAM,EAAE;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAC;QAAC,oBAAoB,EAAE,MAAM,CAAA;KAAE,EAKtF;IAED,yEAAyE;IACnE,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAG1E;YAGa,QAAQ;YAmBR,UAAU;IAiDxB,wFAAwF;IACxF,OAAO,CAAC,kBAAkB;IAuB1B,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,cAAc;CAmBvB"}
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { MAX_FEE_ASSET_PRICE_MODIFIER_BPS } from '@aztec/ethereum/contracts';
|
|
2
|
+
import { SlotNumber } from '@aztec/foundation/branded-types';
|
|
3
|
+
import { times } from '@aztec/foundation/collection';
|
|
4
|
+
import { getSlotAtNextL1Block, getTimestampForSlot } from '@aztec/stdlib/epoch-helpers';
|
|
5
|
+
import { FEE_ORACLE_LAG, GasFees, MIN_ETH_PER_FEE_ASSET, ManaUsageEstimate, computeExcessMana, computeManaMinFee } from '@aztec/stdlib/gas';
|
|
6
|
+
/**
|
|
7
|
+
* Predicts min fees for LAG upcoming slots based on the L1 oracle state.
|
|
8
|
+
* A new oracle update can activate at startSlot + LAG, so only the first LAG entries
|
|
9
|
+
* are guaranteed stable. Caches L1 queries per L1 block and recomputes predictions
|
|
10
|
+
* for each mana usage estimate.
|
|
11
|
+
*/ export class FeePredictor {
|
|
12
|
+
rollupContract;
|
|
13
|
+
publicClient;
|
|
14
|
+
dateProvider;
|
|
15
|
+
cachedState;
|
|
16
|
+
cachedL1BlockNumber;
|
|
17
|
+
slotDuration;
|
|
18
|
+
l1GenesisTime;
|
|
19
|
+
ethereumSlotDuration;
|
|
20
|
+
constructor(rollupContract, publicClient, dateProvider, config){
|
|
21
|
+
this.rollupContract = rollupContract;
|
|
22
|
+
this.publicClient = publicClient;
|
|
23
|
+
this.dateProvider = dateProvider;
|
|
24
|
+
this.slotDuration = config.slotDuration;
|
|
25
|
+
this.l1GenesisTime = config.l1GenesisTime;
|
|
26
|
+
this.ethereumSlotDuration = config.ethereumSlotDuration;
|
|
27
|
+
}
|
|
28
|
+
/** Returns predicted min fees for each slot in the prediction window. */ async getPredictedMinFees(manaUsage) {
|
|
29
|
+
const state = await this.getState();
|
|
30
|
+
return this.computePredictions(state, manaUsage);
|
|
31
|
+
}
|
|
32
|
+
/** Fetches and caches rollup state. Refreshes when L1 block number advances. */ async getState() {
|
|
33
|
+
const blockNumber = await this.publicClient.getBlockNumber({
|
|
34
|
+
cacheTime: 0
|
|
35
|
+
});
|
|
36
|
+
if (this.cachedL1BlockNumber === undefined || blockNumber > this.cachedL1BlockNumber) {
|
|
37
|
+
this.cachedL1BlockNumber = blockNumber;
|
|
38
|
+
// Reset the cached block number on failure so a transient L1 RPC error does not leave a
|
|
39
|
+
// rejected promise cached for this block, which would replay the same rejection on every
|
|
40
|
+
// subsequent call until the next L1 block arrives. Only clear it if it still points at the
|
|
41
|
+
// block this attempt was for, so a stale rejection from an older block cannot wipe a marker
|
|
42
|
+
// a newer call already advanced (which would also defeat the monotonic block-number guard).
|
|
43
|
+
this.cachedState = this.fetchState(blockNumber).catch((err)=>{
|
|
44
|
+
if (this.cachedL1BlockNumber === blockNumber) {
|
|
45
|
+
this.cachedL1BlockNumber = undefined;
|
|
46
|
+
}
|
|
47
|
+
throw err;
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
return this.cachedState;
|
|
51
|
+
}
|
|
52
|
+
async fetchState(blockNumber) {
|
|
53
|
+
// Pin all non-constant queries to this L1 block number for a consistent snapshot.
|
|
54
|
+
const opts = {
|
|
55
|
+
blockNumber
|
|
56
|
+
};
|
|
57
|
+
// Cached constants don't need pinning
|
|
58
|
+
const [manaTarget, manaLimit, provingCostPerManaEth, epochDuration] = await Promise.all([
|
|
59
|
+
this.rollupContract.getManaTarget(),
|
|
60
|
+
this.rollupContract.getManaLimit(),
|
|
61
|
+
this.rollupContract.getProvingCostPerMana(),
|
|
62
|
+
this.rollupContract.getEpochDuration()
|
|
63
|
+
]);
|
|
64
|
+
// First, compute the earliest possible nextSlot independently of the checkpoint, so we can
|
|
65
|
+
// evaluate pruneability at the prediction start timestamp instead of the current L1 block time.
|
|
66
|
+
// This avoids an epoch-boundary edge case where the effective parent differs between now and nextSlot.
|
|
67
|
+
const slotConfig = {
|
|
68
|
+
slotDuration: this.slotDuration,
|
|
69
|
+
l1GenesisTime: this.l1GenesisTime
|
|
70
|
+
};
|
|
71
|
+
const currentSlot = await this.rollupContract.getSlotNumber(opts);
|
|
72
|
+
const slotAtNextL1Block = getSlotAtNextL1Block(BigInt(this.dateProvider.nowInSeconds()), {
|
|
73
|
+
l1GenesisTime: this.l1GenesisTime,
|
|
74
|
+
slotDuration: this.slotDuration,
|
|
75
|
+
ethereumSlotDuration: this.ethereumSlotDuration
|
|
76
|
+
});
|
|
77
|
+
const preliminaryNextSlot = SlotNumber(Math.max(currentSlot, slotAtNextL1Block));
|
|
78
|
+
const nextSlotTimestamp = getTimestampForSlot(preliminaryNextSlot, slotConfig);
|
|
79
|
+
// Resolve the effective checkpoint at the prediction start timestamp
|
|
80
|
+
const lastCheckpoint = await this.rollupContract.getEffectivePendingCheckpoint(nextSlotTimestamp, opts);
|
|
81
|
+
const lastSlot = lastCheckpoint.slotNumber;
|
|
82
|
+
// Refine nextSlot: also account for the slot after the last checkpoint
|
|
83
|
+
const nextSlot = SlotNumber(Math.max(SlotNumber.add(lastSlot, 1), preliminaryNextSlot));
|
|
84
|
+
const feeHeader = lastCheckpoint.feeHeader;
|
|
85
|
+
const slotCount = FEE_ORACLE_LAG;
|
|
86
|
+
const timestamps = times(slotCount, (i)=>getTimestampForSlot(SlotNumber.add(nextSlot, i), slotConfig));
|
|
87
|
+
const l1FeesBySlot = await Promise.all(timestamps.map((ts)=>this.rollupContract.getL1FeesAt(ts, opts)));
|
|
88
|
+
return {
|
|
89
|
+
lastSlot,
|
|
90
|
+
excessMana: computeExcessMana(feeHeader.excessMana, feeHeader.manaUsed, manaTarget),
|
|
91
|
+
ethPerFeeAsset: feeHeader.ethPerFeeAsset,
|
|
92
|
+
manaTarget,
|
|
93
|
+
manaLimit,
|
|
94
|
+
provingCostPerManaEth,
|
|
95
|
+
epochDuration: BigInt(epochDuration),
|
|
96
|
+
l1FeesBySlot
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
/** Computes per-slot fee predictions given cached state and a mana usage assumption. */ computePredictions(state, manaUsage) {
|
|
100
|
+
const assumedManaUsed = this.getAssumedManaUsed(state, manaUsage);
|
|
101
|
+
const result = [];
|
|
102
|
+
let { excessMana } = state;
|
|
103
|
+
let { ethPerFeeAsset } = state;
|
|
104
|
+
// Slot 0: current state (next available slot after last checkpoint)
|
|
105
|
+
result.push(this.computeGasFees(state, excessMana, ethPerFeeAsset, state.l1FeesBySlot[0]));
|
|
106
|
+
// Slots 1..LAG-1: advance excessMana with the assumed mana usage per checkpoint,
|
|
107
|
+
// and decay ethPerFeeAsset by MAX_FEE_ASSET_PRICE_MODIFIER_BPS per slot for conservative estimates.
|
|
108
|
+
// Lower ethPerFeeAsset means higher fees in fee asset terms.
|
|
109
|
+
for(let i = 1; i < state.l1FeesBySlot.length; i++){
|
|
110
|
+
excessMana = computeExcessMana(excessMana, assumedManaUsed, state.manaTarget);
|
|
111
|
+
const decayed = ethPerFeeAsset * (10000n - MAX_FEE_ASSET_PRICE_MODIFIER_BPS) / 10000n;
|
|
112
|
+
ethPerFeeAsset = decayed < MIN_ETH_PER_FEE_ASSET ? MIN_ETH_PER_FEE_ASSET : decayed;
|
|
113
|
+
result.push(this.computeGasFees(state, excessMana, ethPerFeeAsset, state.l1FeesBySlot[i]));
|
|
114
|
+
}
|
|
115
|
+
return result;
|
|
116
|
+
}
|
|
117
|
+
getAssumedManaUsed(state, manaUsage) {
|
|
118
|
+
switch(manaUsage){
|
|
119
|
+
case ManaUsageEstimate.None:
|
|
120
|
+
return 0n;
|
|
121
|
+
case ManaUsageEstimate.Target:
|
|
122
|
+
return state.manaTarget;
|
|
123
|
+
case ManaUsageEstimate.Limit:
|
|
124
|
+
return state.manaLimit;
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
computeGasFees(state, excessMana, ethPerFeeAsset, l1Fees) {
|
|
128
|
+
return new GasFees(0, computeManaMinFee({
|
|
129
|
+
l1BaseFee: l1Fees.baseFee,
|
|
130
|
+
l1BlobFee: l1Fees.blobFee,
|
|
131
|
+
manaTarget: state.manaTarget,
|
|
132
|
+
epochDuration: state.epochDuration,
|
|
133
|
+
provingCostPerManaEth: state.provingCostPerManaEth,
|
|
134
|
+
excessMana,
|
|
135
|
+
ethPerFeeAsset
|
|
136
|
+
}));
|
|
137
|
+
}
|
|
138
|
+
}
|