@aztec/ethereum 3.0.0-nightly.20251212 → 3.0.0-nightly.20251214

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/src/config.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  type ConfigMappingsType,
3
- type NetworkNames,
3
+ // type NetworkNames,
4
4
  bigintConfigHelper,
5
5
  booleanConfigHelper,
6
6
  enumConfigHelper,
@@ -10,7 +10,7 @@ import {
10
10
  } from '@aztec/foundation/config';
11
11
  import { EthAddress } from '@aztec/foundation/eth-address';
12
12
 
13
- import { type L1TxUtilsConfig, l1TxUtilsConfigMappings } from './l1_tx_utils/index.js';
13
+ import { type L1TxUtilsConfig, l1TxUtilsConfigMappings } from './l1_tx_utils/config.js';
14
14
 
15
15
  export type GenesisStateConfig = {
16
16
  /** Whether to populate the genesis state with initial fee juice for the test accounts */
@@ -101,208 +101,6 @@ export const DefaultL1ContractsConfig = {
101
101
  slashingDisableDuration: 5 * 24 * 60 * 60, // 5 days in seconds
102
102
  } satisfies L1ContractsConfig;
103
103
 
104
- const LocalGovernanceConfiguration = {
105
- proposeConfig: {
106
- lockDelay: 60n * 60n * 24n * 30n,
107
- lockAmount: 1n * 10n ** 24n,
108
- },
109
- votingDelay: 60n,
110
- votingDuration: 60n * 60n,
111
- executionDelay: 60n,
112
- gracePeriod: 60n * 60n * 24n * 7n,
113
- quorum: 1n * 10n ** 17n, // 10%
114
- requiredYeaMargin: 4n * 10n ** 16n, // 4%
115
- minimumVotes: 400n * 10n ** 18n,
116
- };
117
-
118
- const StagingPublicGovernanceConfiguration = {
119
- proposeConfig: {
120
- lockDelay: 60n * 60n * 24n * 30n,
121
- lockAmount: DefaultL1ContractsConfig.activationThreshold * 100n,
122
- },
123
- votingDelay: 60n,
124
- votingDuration: 60n * 60n,
125
- executionDelay: 60n,
126
- gracePeriod: 60n * 60n * 24n * 7n,
127
- quorum: 3n * 10n ** 17n, // 30%
128
- requiredYeaMargin: 4n * 10n ** 16n, // 4%
129
- minimumVotes: DefaultL1ContractsConfig.ejectionThreshold * 200n, // >= 200 validators must vote
130
- };
131
-
132
- const TestnetGovernanceConfiguration = {
133
- proposeConfig: {
134
- lockDelay: 10n * 365n * 24n * 60n * 60n,
135
- lockAmount: 1250n * 200_000n * 10n ** 18n,
136
- },
137
-
138
- votingDelay: 12n * 60n * 60n, // 12 hours
139
- votingDuration: 1n * 24n * 60n * 60n, // 1 day
140
- executionDelay: 12n * 60n * 60n, // 12 hours
141
- gracePeriod: 1n * 24n * 60n * 60n, // 1 day
142
- quorum: 2n * 10n ** 17n, // 20%
143
- requiredYeaMargin: 1n * 10n ** 17n, // 10%
144
- minimumVotes: 100n * 200_000n * 10n ** 18n,
145
- };
146
-
147
- const StagingIgnitionGovernanceConfiguration = {
148
- proposeConfig: {
149
- lockDelay: 10n * 365n * 24n * 60n * 60n,
150
- lockAmount: 1250n * 200_000n * 10n ** 18n,
151
- },
152
-
153
- votingDelay: 7n * 24n * 60n * 60n,
154
- votingDuration: 7n * 24n * 60n * 60n,
155
- executionDelay: 30n * 24n * 60n * 60n,
156
- gracePeriod: 7n * 24n * 60n * 60n,
157
- quorum: 2n * 10n ** 17n, // 20%
158
- requiredYeaMargin: 1n * 10n ** 17n, // 10%
159
- minimumVotes: 1250n * 200_000n * 10n ** 18n,
160
- };
161
-
162
- const MainnetGovernanceConfiguration = {
163
- proposeConfig: {
164
- lockDelay: 90n * 24n * 60n * 60n,
165
- lockAmount: 258_750_000n * 10n ** 18n,
166
- },
167
-
168
- votingDelay: 3n * 24n * 60n * 60n,
169
- votingDuration: 7n * 24n * 60n * 60n,
170
- executionDelay: 7n * 24n * 60n * 60n,
171
- gracePeriod: 7n * 24n * 60n * 60n,
172
- quorum: 2n * 10n ** 17n, // 20%
173
- requiredYeaMargin: 33n * 10n ** 16n, // 33%
174
- minimumVotes: 1000n * 200_000n * 10n ** 18n,
175
- };
176
-
177
- export const getGovernanceConfiguration = (networkName: NetworkNames) => {
178
- switch (networkName) {
179
- case 'local':
180
- return LocalGovernanceConfiguration;
181
- case 'next-net':
182
- return LocalGovernanceConfiguration;
183
- case 'devnet':
184
- return LocalGovernanceConfiguration;
185
- case 'staging-public':
186
- return StagingPublicGovernanceConfiguration;
187
- case 'testnet':
188
- return TestnetGovernanceConfiguration;
189
- case 'staging-ignition':
190
- return StagingIgnitionGovernanceConfiguration;
191
- case 'mainnet':
192
- return MainnetGovernanceConfiguration;
193
- default:
194
- throw new Error(`Unrecognized network name: ${networkName}`);
195
- }
196
- };
197
-
198
- // Making a default config here as we are only using it thought the deployment
199
- // and do not expect to be using different setups, so having environment variables
200
- // for it seems overkill
201
-
202
- const DefaultRewardConfig = {
203
- sequencerBps: 8000,
204
- rewardDistributor: EthAddress.ZERO.toString(),
205
- booster: EthAddress.ZERO.toString(),
206
- checkpointReward: 500n * 10n ** 18n,
207
- };
208
-
209
- const MainnetRewardConfig = {
210
- sequencerBps: 7_000,
211
- rewardDistributor: EthAddress.ZERO.toString(),
212
- booster: EthAddress.ZERO.toString(),
213
- checkpointReward: 400n * 10n ** 18n,
214
- };
215
-
216
- export const getRewardConfig = (networkName: NetworkNames) => {
217
- switch (networkName) {
218
- case 'local':
219
- case 'devnet':
220
- case 'next-net':
221
- case 'staging-public':
222
- case 'testnet':
223
- case 'staging-ignition':
224
- return DefaultRewardConfig;
225
- case 'mainnet':
226
- return MainnetRewardConfig;
227
- default:
228
- throw new Error(`Unrecognized network name: ${networkName}`);
229
- }
230
- };
231
-
232
- export const getRewardBoostConfig = () => {
233
- // The reward configuration is specified with a precision of 1e5, and we use the same across
234
- // all networks.
235
- return {
236
- increment: 125_000, // 1.25
237
- maxScore: 15_000_000, // 150
238
- a: 1_000, // 0.01
239
- k: 1_000_000, // 10
240
- minimum: 100_000, // 1
241
- };
242
- };
243
-
244
- // Similar to the above, no need for environment variables for this.
245
- const LocalEntryQueueConfig = {
246
- bootstrapValidatorSetSize: 0n,
247
- bootstrapFlushSize: 0n,
248
- normalFlushSizeMin: 48n,
249
- normalFlushSizeQuotient: 2n,
250
- maxQueueFlushSize: 48n,
251
- };
252
-
253
- const StagingPublicEntryQueueConfig = {
254
- bootstrapValidatorSetSize: 48n,
255
- bootstrapFlushSize: 48n,
256
- normalFlushSizeMin: 1n,
257
- normalFlushSizeQuotient: 2475n,
258
- maxQueueFlushSize: 32n, // Limited to 32 so flush cost are kept below 15M gas.
259
- };
260
-
261
- const TestnetEntryQueueConfig = {
262
- bootstrapValidatorSetSize: 256n,
263
- bootstrapFlushSize: 256n,
264
- normalFlushSizeMin: 4n,
265
- normalFlushSizeQuotient: 2048n,
266
- maxQueueFlushSize: 8n,
267
- };
268
-
269
- const StagingIgnitionEntryQueueConfig = {
270
- bootstrapValidatorSetSize: 48n,
271
- bootstrapFlushSize: 48n,
272
- normalFlushSizeMin: 1n,
273
- normalFlushSizeQuotient: 2048n,
274
- maxQueueFlushSize: 24n,
275
- };
276
-
277
- const MainnetEntryQueueConfig = {
278
- bootstrapValidatorSetSize: 1_000n,
279
- bootstrapFlushSize: 1_000n,
280
- normalFlushSizeMin: 1n,
281
- normalFlushSizeQuotient: 2_048n,
282
- maxQueueFlushSize: 8n,
283
- };
284
-
285
- export const getEntryQueueConfig = (networkName: NetworkNames) => {
286
- switch (networkName) {
287
- case 'local':
288
- return LocalEntryQueueConfig;
289
- case 'next-net':
290
- return LocalEntryQueueConfig;
291
- case 'devnet':
292
- return LocalEntryQueueConfig;
293
- case 'staging-public':
294
- return StagingPublicEntryQueueConfig;
295
- case 'testnet':
296
- return TestnetEntryQueueConfig;
297
- case 'staging-ignition':
298
- return StagingIgnitionEntryQueueConfig;
299
- case 'mainnet':
300
- return MainnetEntryQueueConfig;
301
- default:
302
- throw new Error(`Unrecognized network name: ${networkName}`);
303
- }
304
- };
305
-
306
104
  export const l1ContractsConfigMappings: ConfigMappingsType<L1ContractsConfig> = {
307
105
  ethereumSlotDuration: {
308
106
  env: 'ETHEREUM_SLOT_DURATION',
@@ -460,205 +258,3 @@ export function getL1ContractsConfigEnvVars(): L1ContractsConfig {
460
258
  export function getGenesisStateConfigEnvVars(): GenesisStateConfig {
461
259
  return getConfigFromMappings(genesisStateConfigMappings);
462
260
  }
463
-
464
- /**
465
- * Validates the L1 contracts configuration to ensure all requirements enforced by L1 contracts
466
- * during construction are satisfied before deployment.
467
- * Accumulates all validation errors and throws an exception listing them all if any are found.
468
- */
469
- export function validateConfig(config: Omit<L1ContractsConfig, keyof L1TxUtilsConfig>): void {
470
- const errors: string[] = [];
471
-
472
- // RollupCore constructor validation: normalFlushSizeMin > 0
473
- // From: require(_config.stakingQueueConfig.normalFlushSizeMin > 0, Errors.Staking__InvalidStakingQueueConfig());
474
- const entryQueueConfig = getEntryQueueConfig('testnet'); // Get config to check normalFlushSizeMin
475
- if (entryQueueConfig.normalFlushSizeMin <= 0n) {
476
- errors.push('normalFlushSizeMin must be greater than 0');
477
- }
478
-
479
- // TimeLib initialization validation: aztecSlotDuration should be a multiple of ethereumSlotDuration
480
- // While not explicitly required in constructor, this is a common validation for time-based systems
481
- if (config.aztecSlotDuration % config.ethereumSlotDuration !== 0) {
482
- errors.push(
483
- `aztecSlotDuration (${config.aztecSlotDuration}) must be a multiple of ethereumSlotDuration (${config.ethereumSlotDuration})`,
484
- );
485
- }
486
-
487
- // EmpireBase constructor validations for governance/slashing proposers
488
- // From: require(QUORUM_SIZE > ROUND_SIZE / 2, Errors.EmpireBase__InvalidQuorumAndRoundSize(QUORUM_SIZE, ROUND_SIZE));
489
- const { governanceProposerQuorum, governanceProposerRoundSize } = config;
490
- if (
491
- governanceProposerQuorum !== undefined &&
492
- governanceProposerQuorum <= Math.floor(governanceProposerRoundSize / 2)
493
- ) {
494
- errors.push(
495
- `governanceProposerQuorum (${governanceProposerQuorum}) must be greater than half of governanceProposerRoundSize (${Math.floor(governanceProposerRoundSize / 2)})`,
496
- );
497
- }
498
-
499
- // From: require(QUORUM_SIZE <= ROUND_SIZE, Errors.EmpireBase__QuorumCannotBeLargerThanRoundSize(QUORUM_SIZE, ROUND_SIZE));
500
- if (governanceProposerQuorum !== undefined && governanceProposerQuorum > governanceProposerRoundSize) {
501
- errors.push(
502
- `governanceProposerQuorum (${governanceProposerQuorum}) cannot be larger than governanceProposerRoundSize (${governanceProposerRoundSize})`,
503
- );
504
- }
505
-
506
- // Slashing quorum validations (similar to governance quorum)
507
- const slashingRoundSize = config.slashingRoundSizeInEpochs * config.aztecEpochDuration;
508
- const { slashingQuorum } = config;
509
- if (slashingQuorum !== undefined && slashingQuorum <= Math.floor(slashingRoundSize / 2)) {
510
- errors.push(
511
- `slashingQuorum (${slashingQuorum}) must be greater than half of slashingRoundSizeInEpochs (${Math.floor(slashingRoundSize / 2)})`,
512
- );
513
- }
514
-
515
- if (slashingQuorum !== undefined && slashingQuorum > slashingRoundSize) {
516
- errors.push(
517
- `slashingQuorum (${slashingQuorum}) cannot be larger than slashingRoundSizeInEpochs (${slashingRoundSize})`,
518
- );
519
- }
520
-
521
- // EmpireBase and TallySlashingProposer lifetime and execution delay validation
522
- // From: require(LIFETIME_IN_ROUNDS > EXECUTION_DELAY_IN_ROUNDS);
523
- if (config.slashingLifetimeInRounds <= config.slashingExecutionDelayInRounds) {
524
- errors.push(
525
- `slashingLifetimeInRounds (${config.slashingLifetimeInRounds}) must be greater than slashingExecutionDelayInRounds (${config.slashingExecutionDelayInRounds})`,
526
- );
527
- }
528
-
529
- // Staking asset validation: activationThreshold > ejectionThreshold
530
- if (config.activationThreshold < config.ejectionThreshold) {
531
- errors.push(
532
- `activationThreshold (${config.activationThreshold}) must be greater than ejectionThreshold (${config.ejectionThreshold})`,
533
- );
534
- }
535
-
536
- // TallySlashingProposer constructor validations
537
- if (config.slasherFlavor === 'tally') {
538
- validateTallySlasherConfig(config, errors);
539
- }
540
-
541
- // Epoch and slot duration validations
542
- if (config.aztecSlotDuration <= 0) {
543
- errors.push('aztecSlotDuration must be greater than 0');
544
- }
545
-
546
- if (config.ethereumSlotDuration <= 0) {
547
- errors.push('ethereumSlotDuration must be greater than 0');
548
- }
549
-
550
- if (config.aztecEpochDuration <= 0) {
551
- errors.push('aztecEpochDuration must be greater than 0');
552
- }
553
-
554
- // Committee size validation
555
- if (config.aztecTargetCommitteeSize < 0) {
556
- errors.push('aztecTargetCommitteeSize cannot be negative');
557
- }
558
-
559
- // Proof submission epochs validation
560
- if (config.aztecProofSubmissionEpochs < 0) {
561
- errors.push('aztecProofSubmissionEpochs cannot be negative');
562
- }
563
-
564
- // Exit delay validation
565
- if (config.exitDelaySeconds < 0) {
566
- errors.push('exitDelaySeconds cannot be negative');
567
- }
568
-
569
- // Mana validation
570
- if (config.manaTarget < 0n) {
571
- errors.push('manaTarget cannot be negative');
572
- }
573
-
574
- if (config.provingCostPerMana < 0n) {
575
- errors.push('provingCostPerMana cannot be negative');
576
- }
577
-
578
- // If any errors were found, throw an exception with all of them
579
- if (errors.length > 0) {
580
- throw new Error(
581
- `L1 contracts configuration validation failed with ${errors.length} error(s):\n${errors.map((error, index) => `${index + 1}. ${error}`).join('\n')}`,
582
- );
583
- }
584
- }
585
-
586
- function validateTallySlasherConfig(config: L1ContractsConfig, errors: string[]) {
587
- if (config.slasherFlavor !== 'tally') {
588
- return;
589
- }
590
-
591
- // From: require(SLASH_OFFSET_IN_ROUNDS > 0, Errors.TallySlashingProposer__SlashOffsetMustBeGreaterThanZero(...));
592
- if (config.slashingOffsetInRounds <= 0) {
593
- errors.push(`slashingOffsetInRounds (${config.slashingOffsetInRounds}) must be greater than 0`);
594
- }
595
-
596
- // From: require(ROUND_SIZE_IN_EPOCHS * _epochDuration == ROUND_SIZE, Errors.TallySlashingProposer__RoundSizeMustBeMultipleOfEpochDuration(...));
597
- const roundSizeInSlots = config.slashingRoundSizeInEpochs * config.aztecEpochDuration;
598
-
599
- // From: require(QUORUM > 0, Errors.TallySlashingProposer__QuorumMustBeGreaterThanZero());
600
- const { slashingQuorum } = config;
601
- if (slashingQuorum !== undefined && slashingQuorum <= 0) {
602
- errors.push(`slashingQuorum (${slashingQuorum}) must be greater than 0`);
603
- }
604
-
605
- // From: require(ROUND_SIZE > 1, Errors.TallySlashingProposer__InvalidQuorumAndRoundSize(QUORUM, ROUND_SIZE));
606
- if (roundSizeInSlots <= 1) {
607
- errors.push(`slashing round size in slots (${roundSizeInSlots}) must be greater than 1`);
608
- }
609
-
610
- // From: require(_slashAmounts[0] <= _slashAmounts[1], Errors.TallySlashingProposer__InvalidSlashAmounts(_slashAmounts));
611
- if (config.slashAmountSmall > config.slashAmountMedium) {
612
- errors.push(
613
- `slashAmountSmall (${config.slashAmountSmall}) must be less than or equal to slashAmountMedium (${config.slashAmountMedium})`,
614
- );
615
- }
616
-
617
- // From: require(_slashAmounts[1] <= _slashAmounts[2], Errors.TallySlashingProposer__InvalidSlashAmounts(_slashAmounts));
618
- if (config.slashAmountMedium > config.slashAmountLarge) {
619
- errors.push(
620
- `slashAmountMedium (${config.slashAmountMedium}) must be less than or equal to slashAmountLarge (${config.slashAmountLarge})`,
621
- );
622
- }
623
-
624
- // From: require(LIFETIME_IN_ROUNDS < ROUNDABOUT_SIZE, Errors.TallySlashingProposer__LifetimeMustBeLessThanRoundabout(...));
625
- const ROUNDABOUT_SIZE = 128; // Constant from TallySlashingProposer
626
- if (config.slashingLifetimeInRounds >= ROUNDABOUT_SIZE) {
627
- errors.push(`slashingLifetimeInRounds (${config.slashingLifetimeInRounds}) must be less than ${ROUNDABOUT_SIZE}`);
628
- }
629
-
630
- // From: require(ROUND_SIZE_IN_EPOCHS > 0, Errors.TallySlashingProposer__RoundSizeInEpochsMustBeGreaterThanZero(...));
631
- if (config.slashingRoundSizeInEpochs <= 0) {
632
- errors.push(`slashingRoundSizeInEpochs (${config.slashingRoundSizeInEpochs}) must be greater than 0`);
633
- }
634
-
635
- // From: require(ROUND_SIZE < MAX_ROUND_SIZE, Errors.TallySlashingProposer__RoundSizeTooLarge(ROUND_SIZE, MAX_ROUND_SIZE));
636
- const MAX_ROUND_SIZE = 1024; // Constant from TallySlashingProposer
637
- if (roundSizeInSlots >= MAX_ROUND_SIZE) {
638
- errors.push(`slashing round size in slots (${roundSizeInSlots}) must be less than ${MAX_ROUND_SIZE}`);
639
- }
640
-
641
- // From: require(COMMITTEE_SIZE > 0, Errors.TallySlashingProposer__CommitteeSizeMustBeGreaterThanZero(COMMITTEE_SIZE));
642
- if (config.aztecTargetCommitteeSize <= 0) {
643
- errors.push(`aztecTargetCommitteeSize (${config.aztecTargetCommitteeSize}) must be greater than 0`);
644
- }
645
-
646
- // From: require(voteSize <= 128, Errors.TallySlashingProposer__VoteSizeTooBig(voteSize, 128));
647
- // voteSize = COMMITTEE_SIZE * ROUND_SIZE_IN_EPOCHS / 4
648
- const voteSize = (config.aztecTargetCommitteeSize * config.slashingRoundSizeInEpochs) / 4;
649
- if (voteSize > 128) {
650
- errors.push(`vote size (${voteSize}) must be <= 128 (committee size * round size in epochs / 4)`);
651
- }
652
-
653
- // From: require(COMMITTEE_SIZE * ROUND_SIZE_IN_EPOCHS % 4 == 0, Errors.TallySlashingProposer__InvalidCommitteeAndRoundSize(...));
654
- if ((config.aztecTargetCommitteeSize * config.slashingRoundSizeInEpochs) % 4 !== 0) {
655
- errors.push(
656
- `aztecTargetCommitteeSize * slashingRoundSizeInEpochs (${config.aztecTargetCommitteeSize * config.slashingRoundSizeInEpochs}) must be divisible by 4`,
657
- );
658
- }
659
-
660
- // Slashing offset validation: should be positive to allow proper slashing timing
661
- if (config.slashingOffsetInRounds < 0) {
662
- errors.push('slashingOffsetInRounds cannot be negative');
663
- }
664
- }
@@ -5,7 +5,7 @@ import { InboxAbi } from '@aztec/l1-artifacts/InboxAbi';
5
5
  import { type BlockTag, type GetContractReturnType, type Hex, getContract } from 'viem';
6
6
 
7
7
  import { getPublicClient } from '../client.js';
8
- import type { DeployL1ContractsReturnType } from '../deploy_l1_contracts.js';
8
+ import type { DeployAztecL1ContractsReturnType } from '../deploy_aztec_l1_contracts.js';
9
9
  import type { L1ReaderConfig } from '../l1_reader.js';
10
10
  import type { ViemClient } from '../types.js';
11
11
  import { checkBlockTag } from './utils.js';
@@ -13,7 +13,7 @@ import { checkBlockTag } from './utils.js';
13
13
  export class InboxContract {
14
14
  private readonly inbox: GetContractReturnType<typeof InboxAbi, ViemClient>;
15
15
 
16
- static getFromL1ContractsValues(deployL1ContractsValues: DeployL1ContractsReturnType) {
16
+ static getFromL1ContractsValues(deployL1ContractsValues: DeployAztecL1ContractsReturnType) {
17
17
  const {
18
18
  l1Client,
19
19
  l1ContractAddresses: { inboxAddress },
@@ -19,7 +19,7 @@ import {
19
19
  } from 'viem';
20
20
 
21
21
  import { getPublicClient } from '../client.js';
22
- import type { DeployL1ContractsReturnType } from '../deploy_l1_contracts.js';
22
+ import type { DeployAztecL1ContractsReturnType } from '../deploy_aztec_l1_contracts.js';
23
23
  import type { L1ContractAddresses } from '../l1_contract_addresses.js';
24
24
  import type { L1ReaderConfig } from '../l1_reader.js';
25
25
  import type { L1TxRequest, L1TxUtils } from '../l1_tx_utils/index.js';
@@ -106,7 +106,7 @@ export class RollupContract {
106
106
  return (RollupContract.cachedStfStorageSlot ??= keccak256(Buffer.from('aztec.stf.storage', 'utf-8')));
107
107
  }
108
108
 
109
- static getFromL1ContractsValues(deployL1ContractsValues: DeployL1ContractsReturnType) {
109
+ static getFromL1ContractsValues(deployL1ContractsValues: DeployAztecL1ContractsReturnType) {
110
110
  const {
111
111
  l1Client,
112
112
  l1ContractAddresses: { rollupAddress },