@aztec/sequencer-client 0.0.1-commit.2eb6648a → 0.0.1-commit.2f68f620
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 +19 -9
- package/dest/client/sequencer-client.d.ts.map +1 -1
- package/dest/client/sequencer-client.js +65 -32
- package/dest/config.d.ts +28 -6
- package/dest/config.d.ts.map +1 -1
- package/dest/config.js +76 -37
- 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 -16
- 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 +47 -17
- package/dest/publisher/config.d.ts.map +1 -1
- package/dest/publisher/config.js +121 -42
- package/dest/publisher/index.d.ts +2 -1
- package/dest/publisher/index.d.ts.map +1 -1
- package/dest/publisher/l1_tx_failed_store/factory.d.ts +11 -0
- package/dest/publisher/l1_tx_failed_store/factory.d.ts.map +1 -0
- package/dest/publisher/l1_tx_failed_store/factory.js +22 -0
- package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts +58 -0
- package/dest/publisher/l1_tx_failed_store/failed_tx_store.d.ts.map +1 -0
- package/dest/publisher/l1_tx_failed_store/failed_tx_store.js +1 -0
- package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.d.ts +15 -0
- package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.d.ts.map +1 -0
- package/dest/publisher/l1_tx_failed_store/file_store_failed_tx_store.js +34 -0
- package/dest/publisher/l1_tx_failed_store/index.d.ts +4 -0
- package/dest/publisher/l1_tx_failed_store/index.d.ts.map +1 -0
- package/dest/publisher/l1_tx_failed_store/index.js +2 -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 +11 -5
- package/dest/publisher/sequencer-publisher-factory.d.ts.map +1 -1
- package/dest/publisher/sequencer-publisher-factory.js +27 -3
- package/dest/publisher/sequencer-publisher.d.ts +94 -67
- package/dest/publisher/sequencer-publisher.d.ts.map +1 -1
- package/dest/publisher/sequencer-publisher.js +442 -378
- 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 +509 -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 +60 -12
- package/dest/sequencer/checkpoint_proposal_job.d.ts.map +1 -1
- package/dest/sequencer/checkpoint_proposal_job.js +831 -229
- 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 +48 -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 +23 -8
- package/dest/sequencer/metrics.d.ts.map +1 -1
- package/dest/sequencer/metrics.js +117 -21
- package/dest/sequencer/sequencer.d.ts +83 -22
- package/dest/sequencer/sequencer.d.ts.map +1 -1
- package/dest/sequencer/sequencer.js +378 -139
- package/dest/sequencer/timetable.d.ts +14 -6
- package/dest/sequencer/timetable.d.ts.map +1 -1
- package/dest/sequencer/timetable.js +47 -46
- package/dest/sequencer/types.d.ts +2 -2
- package/dest/sequencer/types.d.ts.map +1 -1
- package/dest/test/index.d.ts +3 -5
- package/dest/test/index.d.ts.map +1 -1
- package/dest/test/mock_checkpoint_builder.d.ts +11 -11
- package/dest/test/mock_checkpoint_builder.d.ts.map +1 -1
- package/dest/test/mock_checkpoint_builder.js +45 -34
- package/dest/test/utils.d.ts +3 -3
- package/dest/test/utils.d.ts.map +1 -1
- package/dest/test/utils.js +10 -8
- package/package.json +27 -28
- package/src/client/sequencer-client.ts +91 -35
- package/src/config.ts +98 -46
- 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 +26 -63
- package/src/global_variable_builder/index.ts +3 -1
- package/src/index.ts +10 -1
- package/src/publisher/config.ts +157 -45
- package/src/publisher/index.ts +3 -0
- package/src/publisher/l1_tx_failed_store/factory.ts +32 -0
- package/src/publisher/l1_tx_failed_store/failed_tx_store.ts +57 -0
- package/src/publisher/l1_tx_failed_store/file_store_failed_tx_store.ts +46 -0
- package/src/publisher/l1_tx_failed_store/index.ts +3 -0
- package/src/publisher/sequencer-bundle-simulator.ts +254 -0
- package/src/publisher/sequencer-publisher-factory.ts +38 -9
- package/src/publisher/sequencer-publisher.ts +535 -469
- package/src/sequencer/README.md +162 -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 +595 -0
- package/src/sequencer/chain_state_overrides.ts +162 -0
- package/src/sequencer/checkpoint_proposal_job.ts +1004 -248
- package/src/sequencer/checkpoint_proposal_job_metrics.ts +128 -0
- package/src/sequencer/checkpoint_voter.ts +1 -12
- package/src/sequencer/events.ts +51 -2
- package/src/sequencer/index.ts +2 -0
- package/src/sequencer/metrics.ts +132 -25
- package/src/sequencer/sequencer.ts +466 -158
- package/src/sequencer/timetable.ts +62 -56
- package/src/sequencer/types.ts +1 -1
- package/src/test/index.ts +2 -4
- package/src/test/mock_checkpoint_builder.ts +63 -49
- package/src/test/utils.ts +31 -10
package/src/publisher/config.ts
CHANGED
|
@@ -1,32 +1,47 @@
|
|
|
1
1
|
import { type BlobClientConfig, blobClientConfigMapping } from '@aztec/blob-client/client/config';
|
|
2
2
|
import { type L1ReaderConfig, l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
|
|
3
3
|
import { type L1TxUtilsConfig, l1TxUtilsConfigMappings } from '@aztec/ethereum/l1-tx-utils/config';
|
|
4
|
-
import {
|
|
5
|
-
type ConfigMappingsType,
|
|
6
|
-
SecretValue,
|
|
7
|
-
booleanConfigHelper,
|
|
8
|
-
getConfigFromMappings,
|
|
9
|
-
} from '@aztec/foundation/config';
|
|
4
|
+
import { type ConfigMappingsType, SecretValue, booleanConfigHelper } from '@aztec/foundation/config';
|
|
10
5
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
11
6
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
*/
|
|
7
|
+
import { parseEther } from 'viem';
|
|
8
|
+
|
|
9
|
+
/** Configuration of the transaction publisher. */
|
|
15
10
|
export type TxSenderConfig = L1ReaderConfig & {
|
|
16
|
-
/**
|
|
17
|
-
* The private key to be used by the publisher.
|
|
18
|
-
*/
|
|
11
|
+
/** The private key to be used by the publisher. */
|
|
19
12
|
publisherPrivateKeys?: SecretValue<`0x${string}`>[];
|
|
20
13
|
|
|
21
|
-
/**
|
|
22
|
-
* Publisher addresses to be used with a remote signer
|
|
23
|
-
*/
|
|
14
|
+
/** Publisher addresses to be used with a remote signer */
|
|
24
15
|
publisherAddresses?: EthAddress[];
|
|
25
16
|
};
|
|
26
17
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
18
|
+
export type ProverTxSenderConfig = L1ReaderConfig & {
|
|
19
|
+
proverPublisherPrivateKeys?: SecretValue<`0x${string}`>[];
|
|
20
|
+
proverPublisherAddresses?: EthAddress[];
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export type SequencerTxSenderConfig = L1ReaderConfig & {
|
|
24
|
+
sequencerPublisherPrivateKeys?: SecretValue<`0x${string}`>[];
|
|
25
|
+
sequencerPublisherAddresses?: EthAddress[];
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
export function getTxSenderConfigFromProverConfig(config: ProverTxSenderConfig): TxSenderConfig {
|
|
29
|
+
return {
|
|
30
|
+
...config,
|
|
31
|
+
publisherPrivateKeys: config.proverPublisherPrivateKeys,
|
|
32
|
+
publisherAddresses: config.proverPublisherAddresses,
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export function getTxSenderConfigFromSequencerConfig(config: SequencerTxSenderConfig): TxSenderConfig {
|
|
37
|
+
return {
|
|
38
|
+
...config,
|
|
39
|
+
publisherPrivateKeys: config.sequencerPublisherPrivateKeys,
|
|
40
|
+
publisherAddresses: config.sequencerPublisherAddresses,
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/** Configuration of the L1Publisher. */
|
|
30
45
|
export type PublisherConfig = L1TxUtilsConfig &
|
|
31
46
|
BlobClientConfig & {
|
|
32
47
|
/** True to use publishers in invalid states (timed out, cancelled, etc) if no other is available */
|
|
@@ -35,37 +50,113 @@ export type PublisherConfig = L1TxUtilsConfig &
|
|
|
35
50
|
fishermanMode?: boolean;
|
|
36
51
|
/** Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only) */
|
|
37
52
|
publisherForwarderAddress?: EthAddress;
|
|
53
|
+
/** Store for failed L1 transaction inputs (test networks only). Format: gs://bucket/path */
|
|
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;
|
|
59
|
+
};
|
|
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
|
+
|
|
77
|
+
export type ProverPublisherConfig = L1TxUtilsConfig &
|
|
78
|
+
BlobClientConfig & {
|
|
79
|
+
fishermanMode?: boolean;
|
|
80
|
+
proverPublisherAllowInvalidStates?: boolean;
|
|
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;
|
|
86
|
+
};
|
|
87
|
+
|
|
88
|
+
export type SequencerPublisherConfig = L1TxUtilsConfig &
|
|
89
|
+
BlobClientConfig & {
|
|
90
|
+
fishermanMode?: boolean;
|
|
91
|
+
sequencerPublisherAllowInvalidStates?: boolean;
|
|
92
|
+
sequencerPublisherForwarderAddress?: EthAddress;
|
|
93
|
+
/** Store for failed L1 transaction inputs (test networks only). Format: gs://bucket/path */
|
|
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;
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
export function getPublisherConfigFromProverConfig(config: ProverPublisherConfig): PublisherConfig {
|
|
102
|
+
return {
|
|
103
|
+
...config,
|
|
104
|
+
publisherAllowInvalidStates: config.proverPublisherAllowInvalidStates,
|
|
105
|
+
publisherForwarderAddress: config.proverPublisherForwarderAddress,
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export function getPublisherConfigFromSequencerConfig(config: SequencerPublisherConfig): PublisherConfig {
|
|
110
|
+
return {
|
|
111
|
+
...config,
|
|
112
|
+
publisherAllowInvalidStates: config.sequencerPublisherAllowInvalidStates,
|
|
113
|
+
publisherForwarderAddress: config.sequencerPublisherForwarderAddress,
|
|
114
|
+
l1TxFailedStore: config.l1TxFailedStore,
|
|
38
115
|
};
|
|
116
|
+
}
|
|
39
117
|
|
|
40
|
-
export const
|
|
41
|
-
scope: 'PROVER' | 'SEQ',
|
|
42
|
-
) => ConfigMappingsType<Omit<TxSenderConfig, 'l1Contracts'>> = (scope: 'PROVER' | 'SEQ') => ({
|
|
118
|
+
export const proverTxSenderConfigMappings: ConfigMappingsType<ProverTxSenderConfig> = {
|
|
43
119
|
...l1ReaderConfigMappings,
|
|
44
|
-
|
|
45
|
-
env:
|
|
46
|
-
description: 'The private keys to be used by the publisher.',
|
|
47
|
-
parseEnv: (val: string) =>
|
|
120
|
+
proverPublisherPrivateKeys: {
|
|
121
|
+
env: `PROVER_PUBLISHER_PRIVATE_KEYS`,
|
|
122
|
+
description: 'The private keys to be used by the prover publisher.',
|
|
123
|
+
parseEnv: (val: string) =>
|
|
124
|
+
val.split(',').map(key => new SecretValue(`0x${key.replace('0x', '')}` as `0x${string}`)),
|
|
48
125
|
defaultValue: [],
|
|
49
|
-
fallback: [
|
|
126
|
+
fallback: [`PROVER_PUBLISHER_PRIVATE_KEY`],
|
|
50
127
|
},
|
|
51
|
-
|
|
52
|
-
env:
|
|
128
|
+
proverPublisherAddresses: {
|
|
129
|
+
env: `PROVER_PUBLISHER_ADDRESSES`,
|
|
53
130
|
description: 'The addresses of the publishers to use with remote signers',
|
|
54
131
|
parseEnv: (val: string) => val.split(',').map(address => EthAddress.fromString(address)),
|
|
55
132
|
defaultValue: [],
|
|
56
133
|
},
|
|
57
|
-
}
|
|
134
|
+
};
|
|
58
135
|
|
|
59
|
-
export
|
|
60
|
-
|
|
61
|
-
|
|
136
|
+
export const sequencerTxSenderConfigMappings: ConfigMappingsType<SequencerTxSenderConfig> = {
|
|
137
|
+
...l1ReaderConfigMappings,
|
|
138
|
+
sequencerPublisherPrivateKeys: {
|
|
139
|
+
env: `SEQ_PUBLISHER_PRIVATE_KEYS`,
|
|
140
|
+
description: 'The private keys to be used by the sequencer publisher.',
|
|
141
|
+
parseEnv: (val: string) =>
|
|
142
|
+
val.split(',').map(key => new SecretValue(`0x${key.replace('0x', '')}` as `0x${string}`)),
|
|
143
|
+
defaultValue: [],
|
|
144
|
+
fallback: [`SEQ_PUBLISHER_PRIVATE_KEY`],
|
|
145
|
+
},
|
|
146
|
+
sequencerPublisherAddresses: {
|
|
147
|
+
env: `SEQ_PUBLISHER_ADDRESSES`,
|
|
148
|
+
description: 'The addresses of the publishers to use with remote signers',
|
|
149
|
+
parseEnv: (val: string) => val.split(',').map(address => EthAddress.fromString(address)),
|
|
150
|
+
defaultValue: [],
|
|
151
|
+
},
|
|
152
|
+
};
|
|
62
153
|
|
|
63
|
-
export const
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
154
|
+
export const sequencerPublisherConfigMappings: ConfigMappingsType<SequencerPublisherConfig & L1TxUtilsConfig> = {
|
|
155
|
+
...l1TxUtilsConfigMappings,
|
|
156
|
+
...blobClientConfigMapping,
|
|
157
|
+
sequencerPublisherAllowInvalidStates: {
|
|
158
|
+
env: `SEQ_PUBLISHER_ALLOW_INVALID_STATES`,
|
|
67
159
|
description: 'True to use publishers in invalid states (timed out, cancelled, etc) if no other is available',
|
|
68
|
-
env: scope === `PROVER` ? `PROVER_PUBLISHER_ALLOW_INVALID_STATES` : `SEQ_PUBLISHER_ALLOW_INVALID_STATES`,
|
|
69
160
|
...booleanConfigHelper(true),
|
|
70
161
|
},
|
|
71
162
|
fishermanMode: {
|
|
@@ -74,15 +165,36 @@ export const getPublisherConfigMappings: (
|
|
|
74
165
|
'Whether to run in fisherman mode: builds blocks on every slot for validation without publishing to L1',
|
|
75
166
|
...booleanConfigHelper(false),
|
|
76
167
|
},
|
|
77
|
-
|
|
78
|
-
env:
|
|
168
|
+
sequencerPublisherForwarderAddress: {
|
|
169
|
+
env: `SEQ_PUBLISHER_FORWARDER_ADDRESS`,
|
|
79
170
|
description: 'Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only)',
|
|
80
|
-
parseEnv: (val: string) =>
|
|
171
|
+
parseEnv: (val: string) => EthAddress.fromString(val),
|
|
172
|
+
},
|
|
173
|
+
l1TxFailedStore: {
|
|
174
|
+
env: 'L1_TX_FAILED_STORE',
|
|
175
|
+
description: 'Store for failed L1 transaction inputs (test networks only). Format: gs://bucket/path',
|
|
81
176
|
},
|
|
177
|
+
...publisherFundingConfigMappings,
|
|
178
|
+
};
|
|
179
|
+
|
|
180
|
+
export const proverPublisherConfigMappings: ConfigMappingsType<ProverPublisherConfig & L1TxUtilsConfig> = {
|
|
82
181
|
...l1TxUtilsConfigMappings,
|
|
83
182
|
...blobClientConfigMapping,
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
}
|
|
183
|
+
proverPublisherAllowInvalidStates: {
|
|
184
|
+
env: `PROVER_PUBLISHER_ALLOW_INVALID_STATES`,
|
|
185
|
+
description: 'True to use publishers in invalid states (timed out, cancelled, etc) if no other is available',
|
|
186
|
+
...booleanConfigHelper(true),
|
|
187
|
+
},
|
|
188
|
+
fishermanMode: {
|
|
189
|
+
env: 'FISHERMAN_MODE',
|
|
190
|
+
description:
|
|
191
|
+
'Whether to run in fisherman mode: builds blocks on every slot for validation without publishing to L1',
|
|
192
|
+
...booleanConfigHelper(false),
|
|
193
|
+
},
|
|
194
|
+
proverPublisherForwarderAddress: {
|
|
195
|
+
env: `PROVER_PUBLISHER_FORWARDER_ADDRESS`,
|
|
196
|
+
description: 'Address of the forwarder contract to wrap all L1 transactions through (for testing purposes only)',
|
|
197
|
+
parseEnv: (val: string) => EthAddress.fromString(val),
|
|
198
|
+
},
|
|
199
|
+
...publisherFundingConfigMappings,
|
|
200
|
+
};
|
package/src/publisher/index.ts
CHANGED
|
@@ -3,3 +3,6 @@ export { SequencerPublisherFactory } from './sequencer-publisher-factory.js';
|
|
|
3
3
|
|
|
4
4
|
// Used for tests
|
|
5
5
|
export { SequencerPublisherMetrics } from './sequencer-publisher-metrics.js';
|
|
6
|
+
|
|
7
|
+
// Failed L1 tx store (optional, for test networks)
|
|
8
|
+
export { type FailedL1Tx, type FailedL1TxUri, type L1TxFailedStore } from './l1_tx_failed_store/index.js';
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
2
|
+
import { createFileStore } from '@aztec/stdlib/file-store';
|
|
3
|
+
|
|
4
|
+
import type { L1TxFailedStore } from './failed_tx_store.js';
|
|
5
|
+
import { FileStoreL1TxFailedStore } from './file_store_failed_tx_store.js';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Creates an L1TxFailedStore from a config string.
|
|
9
|
+
* Supports any backend that FileStore supports (GCS, S3, R2, local filesystem).
|
|
10
|
+
* @param config - Config string (e.g., 'gs://bucket/path', 's3://bucket/path', 'file:///path'). If undefined, returns undefined.
|
|
11
|
+
* @param logger - Optional logger.
|
|
12
|
+
* @returns The store instance, or undefined if config is not provided.
|
|
13
|
+
*/
|
|
14
|
+
export async function createL1TxFailedStore(
|
|
15
|
+
config: string | undefined,
|
|
16
|
+
logger: Logger = createLogger('sequencer:l1-tx-failed-store'),
|
|
17
|
+
): Promise<L1TxFailedStore | undefined> {
|
|
18
|
+
if (!config) {
|
|
19
|
+
return undefined;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
const fileStore = await createFileStore(config, logger);
|
|
23
|
+
if (!fileStore) {
|
|
24
|
+
throw new Error(
|
|
25
|
+
`Failed to create file store from config: '${config}'. ` +
|
|
26
|
+
`Supported formats: 'gs://bucket/path', 's3://bucket/path', 'file:///path'.`,
|
|
27
|
+
);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
logger.info(`Created L1 tx failed store`, { config });
|
|
31
|
+
return new FileStoreL1TxFailedStore(fileStore, logger);
|
|
32
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import type { Branded } from '@aztec/foundation/branded-types';
|
|
2
|
+
|
|
3
|
+
import type { Hex } from 'viem';
|
|
4
|
+
|
|
5
|
+
/** URI pointing to a stored failed L1 transaction. */
|
|
6
|
+
export type FailedL1TxUri = Branded<string, 'FailedL1TxUri'>;
|
|
7
|
+
|
|
8
|
+
/** A failed L1 transaction captured for debugging and replay. */
|
|
9
|
+
export type FailedL1Tx = {
|
|
10
|
+
/** Tx hash (for reverts) or keccak256(request.data) (for simulation/send failures). */
|
|
11
|
+
id: Hex;
|
|
12
|
+
/** Unix timestamp (ms) when failure occurred. */
|
|
13
|
+
timestamp: number;
|
|
14
|
+
/** Whether the failure was during simulation or after sending. */
|
|
15
|
+
failureType: 'simulation' | 'revert' | 'send-error';
|
|
16
|
+
/** The actual L1 transaction for replay (multicall-encoded for bundled txs). */
|
|
17
|
+
request: {
|
|
18
|
+
to: Hex;
|
|
19
|
+
data: Hex;
|
|
20
|
+
value?: string; // bigint as string
|
|
21
|
+
};
|
|
22
|
+
/** Raw blob data as hex for replay. */
|
|
23
|
+
blobData?: Hex[];
|
|
24
|
+
/** L1 block number at time of failure (simulation target or receipt block). */
|
|
25
|
+
l1BlockNumber: string; // bigint as string
|
|
26
|
+
/** Receipt info (present only for on-chain reverts). */
|
|
27
|
+
receipt?: {
|
|
28
|
+
transactionHash: Hex;
|
|
29
|
+
blockNumber: string; // bigint as string
|
|
30
|
+
gasUsed: string; // bigint as string
|
|
31
|
+
status: 'reverted';
|
|
32
|
+
};
|
|
33
|
+
/** Error information. */
|
|
34
|
+
error: {
|
|
35
|
+
message: string;
|
|
36
|
+
/** Decoded error name (e.g., 'Rollup__InvalidProposer'). */
|
|
37
|
+
name?: string;
|
|
38
|
+
};
|
|
39
|
+
/** Context metadata. */
|
|
40
|
+
context: {
|
|
41
|
+
/** Actions involved (e.g., ['propose', 'governance-signal']). */
|
|
42
|
+
actions: string[];
|
|
43
|
+
/** Individual request data for each action (metadata, not used for replay). */
|
|
44
|
+
requests?: Array<{ action: string; to: Hex; data: Hex }>;
|
|
45
|
+
checkpointNumber?: number;
|
|
46
|
+
slot?: number;
|
|
47
|
+
sender: Hex;
|
|
48
|
+
};
|
|
49
|
+
};
|
|
50
|
+
|
|
51
|
+
/** Store for failed L1 transactions for debugging purposes. */
|
|
52
|
+
export interface L1TxFailedStore {
|
|
53
|
+
/** Saves a failed transaction and returns its URI. */
|
|
54
|
+
saveFailedTx(tx: FailedL1Tx): Promise<FailedL1TxUri>;
|
|
55
|
+
/** Retrieves a failed transaction by its URI. */
|
|
56
|
+
getFailedTx(uri: FailedL1TxUri): Promise<FailedL1Tx>;
|
|
57
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
2
|
+
import type { FileStore } from '@aztec/stdlib/file-store';
|
|
3
|
+
|
|
4
|
+
import type { FailedL1Tx, FailedL1TxUri, L1TxFailedStore } from './failed_tx_store.js';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* L1TxFailedStore implementation using the FileStore abstraction.
|
|
8
|
+
* Supports any backend that FileStore supports (GCS, S3, R2, local filesystem).
|
|
9
|
+
*/
|
|
10
|
+
export class FileStoreL1TxFailedStore implements L1TxFailedStore {
|
|
11
|
+
private readonly log: Logger;
|
|
12
|
+
|
|
13
|
+
constructor(
|
|
14
|
+
private readonly fileStore: FileStore,
|
|
15
|
+
logger?: Logger,
|
|
16
|
+
) {
|
|
17
|
+
this.log = logger ?? createLogger('sequencer:l1-tx-failed-store');
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
public async saveFailedTx(tx: FailedL1Tx): Promise<FailedL1TxUri> {
|
|
21
|
+
const prefix = tx.receipt ? 'tx' : 'data';
|
|
22
|
+
const path = `${tx.failureType}/${prefix}-${tx.id}.json`;
|
|
23
|
+
const json = JSON.stringify(tx, null, 2);
|
|
24
|
+
|
|
25
|
+
const uri = await this.fileStore.save(path, Buffer.from(json), {
|
|
26
|
+
metadata: {
|
|
27
|
+
'content-type': 'application/json',
|
|
28
|
+
actions: tx.context.actions.join(','),
|
|
29
|
+
'failure-type': tx.failureType,
|
|
30
|
+
},
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
this.log.info(`Saved failed L1 tx to ${uri}`, {
|
|
34
|
+
id: tx.id,
|
|
35
|
+
failureType: tx.failureType,
|
|
36
|
+
actions: tx.context.actions.join(','),
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
return uri as FailedL1TxUri;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
public async getFailedTx(uri: FailedL1TxUri): Promise<FailedL1Tx> {
|
|
43
|
+
const data = await this.fileStore.read(uri);
|
|
44
|
+
return JSON.parse(data.toString()) as FailedL1Tx;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
@@ -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
|
+
}
|