refactor(config): drop nested config option, flatten l1Contracts (#23143)

- Drop the `nested` field from `ConfigMapping` and the recursive branch
in `getConfigFromMappings`. Env-var groups now have to be expressed as
flat keys.
- Flatten `l1Contracts` from every config that exposed it
(`ChainConfig`, `DataStoreConfig`, `L1ReaderConfig`, `BaseSignerConfig`,
`AztecNodeConfig`, archiver, etc.); L1 contract addresses are top-level
keys everywhere.
- Centralise the L1 address mapping in
`ethereum/src/l1_contract_addresses.ts` and add
`pickL1ContractAddressMappings`, `pickL1ContractAddressesSchema`,
`pickL1ContractAddresses`, `randomL1ContractAddresses` so other configs
can compose the addresses they need without reintroducing nesting.

Fixes
[A-986](https://linear.app/aztec-labs/issue/A-986/flatten-l1-contracts-config-remove-nested-top-level-mapping-entries)

Author: spypsy

yarn-project/archiver/src/config.ts

@@ -1,6 +1,5 @@
 import { type BlobClientConfig, blobClientConfigMapping } from '@aztec/blob-client/client/config';
 import { type L1ContractsConfig, l1ContractsConfigMappings } from '@aztec/ethereum/config';
-import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
 import { type L1ReaderConfig, l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
 import {
   type ConfigMappingsType,
@@ -87,10 +86,6 @@ export const archiverConfigMappings: ConfigMappingsType<ArchiverConfig> = {
     ...numberConfigHelper(1000),
   },
   ...l1ContractsConfigMappings,
-  l1Contracts: {
-    description: 'The deployed L1 contract addresses',
-    nested: l1ContractAddressesMapping,
-  },
 };
 
 /**

yarn-project/archiver/src/factory.ts

@@ -2,6 +2,7 @@ import { EpochCache } from '@aztec/epoch-cache';
 import { createEthereumChain } from '@aztec/ethereum/chain';
 import { makeL1HttpTransport } from '@aztec/ethereum/client';
 import { InboxContract, RollupContract } from '@aztec/ethereum/contracts';
+import { pickL1ContractAddresses } from '@aztec/ethereum/l1-contract-addresses';
 import type { ViemPublicDebugClient } from '@aztec/ethereum/types';
 import { BlockNumber } from '@aztec/foundation/branded-types';
 import { Buffer32 } from '@aztec/foundation/buffer';
@@ -80,8 +81,8 @@ export async function createArchiver(
   }) as ViemPublicDebugClient;
 
   // Create L1 contract instances
-  const rollup = new RollupContract(publicClient, config.l1Contracts.rollupAddress);
-  const inbox = new InboxContract(publicClient, config.l1Contracts.inboxAddress);
+  const rollup = new RollupContract(publicClient, config.rollupAddress);
+  const inbox = new InboxContract(publicClient, config.inboxAddress);
 
   // Fetch L1 constants from rollup contract
   const [
@@ -132,7 +133,7 @@ export async function createArchiver(
     mapArchiverConfig(config),
   );
 
-  const epochCache = deps.epochCache ?? (await EpochCache.create(config.l1Contracts.rollupAddress, config, deps));
+  const epochCache = deps.epochCache ?? (await EpochCache.create(config.rollupAddress, config, deps));
   const telemetry = deps.telemetry ?? getTelemetryClient();
   const instrumentation = await ArchiverInstrumentation.new(telemetry, () => archiverStore.db.estimateSize());
 
@@ -167,7 +168,7 @@ export async function createArchiver(
     publicClient,
     debugClient,
     rollup,
-    { ...config.l1Contracts, slashingProposerAddress },
+    { ...pickL1ContractAddresses(config), slashingProposerAddress },
     archiverStore,
     archiverConfig,
     deps.blobClient,

yarn-project/aztec-node/src/aztec-node/config.test.ts

@@ -52,7 +52,7 @@ describe('createKeyStoreForValidator', () => {
       web3SignerUrl,
       validatorAddresses: validatorAddresses.map(addr => addr),
       sequencerPublisherAddresses: publisherAddresses.map(addr => addr),
-      l1Contracts: { rollupAddress: EthAddress.random() },
+      rollupAddress: EthAddress.random(),
     } as SequencerTxSenderConfig & ValidatorClientConfig & SequencerClientConfig & SharedNodeConfig;
   };
 
@@ -72,7 +72,7 @@ describe('createKeyStoreForValidator', () => {
       sequencerPublisherPrivateKeys: undefined,
       coinbase: undefined,
       feeRecipient: undefined,
-      l1Contracts: { rollupAddress: EthAddress.random() },
+      rollupAddress: EthAddress.random(),
     } as unknown as SequencerTxSenderConfig & ValidatorClientConfig & SequencerClientConfig & SharedNodeConfig;
     const result = createKeyStoreForValidator(config);
     expect(result).toBeUndefined();

yarn-project/aztec-node/src/aztec-node/config.ts

@@ -1,6 +1,5 @@
 import { type ArchiverConfig, archiverConfigMappings } from '@aztec/archiver/config';
 import { type GenesisStateConfig, genesisStateConfigMappings } from '@aztec/ethereum/config';
-import { type L1ContractAddresses, l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
 import { type ConfigMappingsType, booleanConfigHelper, getConfigFromMappings } from '@aztec/foundation/config';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import {
@@ -53,8 +52,6 @@ export type AztecNodeConfig = ArchiverConfig &
   NodeRPCConfig &
   SlasherConfig &
   ProverNodeConfig & {
-    /** L1 contracts addresses */
-    l1Contracts: L1ContractAddresses;
     /** Whether the validator is disabled for this node */
     disableValidator: boolean;
     /** Whether to skip waiting for the archiver to be fully synced before starting other services */
@@ -81,10 +78,6 @@ export const aztecNodeConfigMappings: ConfigMappingsType<AztecNodeConfig> = {
   ...nodeRpcConfigMappings,
   ...slasherConfigMappings,
   ...specificProverNodeConfigMappings,
-  l1Contracts: {
-    description: 'The deployed L1 contract addresses',
-    nested: l1ContractAddressesMapping,
-  },
   disableValidator: {
     env: 'VALIDATOR_DISABLED',
     description: 'Whether the validator is disabled for this node.',

yarn-project/aztec-node/src/aztec-node/server.test.ts

@@ -191,13 +191,10 @@ describe('aztec node', () => {
     const nodeConfigFromEnvVars: AztecNodeConfig = getConfigEnvVars();
     nodeConfig = {
       ...nodeConfigFromEnvVars,
-      l1Contracts: {
-        ...nodeConfigFromEnvVars.l1Contracts,
-        rollupAddress: EthAddress.ZERO,
-        registryAddress: EthAddress.ZERO,
-        inboxAddress: EthAddress.ZERO,
-        outboxAddress: EthAddress.ZERO,
-      },
+      rollupAddress: EthAddress.ZERO,
+      registryAddress: EthAddress.ZERO,
+      inboxAddress: EthAddress.ZERO,
+      outboxAddress: EthAddress.ZERO,
     };
 
     // Inject a spurious config value to test that the config is correctly picked up

yarn-project/aztec-node/src/aztec-node/server.ts

@@ -8,7 +8,7 @@ import { EpochCache, type EpochCacheInterface } from '@aztec/epoch-cache';
 import { createEthereumChain } from '@aztec/ethereum/chain';
 import { getPublicClient, makeL1HttpTransport } from '@aztec/ethereum/client';
 import { RegistryContract, RollupContract } from '@aztec/ethereum/contracts';
-import type { L1ContractAddresses } from '@aztec/ethereum/l1-contract-addresses';
+import { type L1ContractAddresses, pickL1ContractAddresses } from '@aztec/ethereum/l1-contract-addresses';
 import type { L1TxUtils } from '@aztec/ethereum/l1-tx-utils';
 import { BlockNumber, CheckpointNumber, EpochNumber, SlotNumber } from '@aztec/foundation/branded-types';
 import { chunkBy, compactArray, pick, unique } from '@aztec/foundation/collection';
@@ -195,7 +195,7 @@ export class AztecNodeService implements AztecNode, AztecNodeAdmin, AztecNodeDeb
     this.tracer = telemetry.getTracer('AztecNodeService');
 
     this.log.info(`Aztec Node version: ${this.packageVersion}`);
-    this.log.info(`Aztec Node started on chain 0x${l1ChainId.toString(16)}`, config.l1Contracts);
+    this.log.info(`Aztec Node started on chain 0x${l1ChainId.toString(16)}`, pickL1ContractAddresses(config));
 
     // A defensive check that protects us against introducing a bug in the complex `createAndSync` function. We must
     // never have debugLogStore enabled when not in test mode because then we would be accumulating debug logs in
@@ -533,14 +533,13 @@ export class AztecNodeService implements AztecNode, AztecNodeAdmin, AztecNodeDeb
 
     const l1ContractsAddresses = await RegistryContract.collectAddresses(
       publicClient,
-      config.l1Contracts.registryAddress,
+      config.registryAddress,
       config.rollupVersion ?? 'canonical',
     );
 
-    // Overwrite the passed in vars.
-    config.l1Contracts = { ...config.l1Contracts, ...l1ContractsAddresses };
+    Object.assign(config, l1ContractsAddresses);
 
-    const rollupContract = new RollupContract(publicClient, config.l1Contracts.rollupAddress.toString());
+    const rollupContract = new RollupContract(publicClient, config.rollupAddress.toString());
     const [l1GenesisTime, slotDuration, rollupVersionFromRollup, rollupManaLimit] = await Promise.all([
       rollupContract.getL1GenesisTime(),
       rollupContract.getSlotDuration(),
@@ -561,7 +560,7 @@ export class AztecNodeService implements AztecNode, AztecNodeAdmin, AztecNodeDeb
     // attempt snapshot sync if possible
     await trySnapshotSync(config, log);
 
-    const epochCache = await EpochCache.create(config.l1Contracts.rollupAddress, config, { dateProvider });
+    const epochCache = await EpochCache.create(config.rollupAddress, config, { dateProvider });
 
     // Track started resources so we can clean up on partial failure during node creation.
     const started: { stop?(): Promise<void> | void }[] = [];
@@ -608,7 +607,7 @@ export class AztecNodeService implements AztecNode, AztecNodeAdmin, AztecNodeDeb
       }
 
       const globalVariableBuilderConfig = {
-        l1Contracts: config.l1Contracts,
+        rollupAddress: config.rollupAddress,
         ethereumSlotDuration: config.ethereumSlotDuration,
         rollupVersion: BigInt(config.rollupVersion),
         l1GenesisTime,
@@ -779,7 +778,7 @@ export class AztecNodeService implements AztecNode, AztecNodeAdmin, AztecNodeDeb
 
         slasherClient = await createSlasher(
           config,
-          config.l1Contracts,
+          pickL1ContractAddresses(config),
           getPublicClient(config),
           watchers,
           dateProvider,
@@ -950,7 +949,7 @@ export class AztecNodeService implements AztecNode, AztecNodeAdmin, AztecNodeDeb
    * @returns - The currently deployed L1 contract addresses.
    */
   public getL1ContractAddresses(): Promise<L1ContractAddresses> {
-    return Promise.resolve(this.config.l1Contracts);
+    return Promise.resolve(pickL1ContractAddresses(this.config));
   }
 
   public getEncodedEnr(): Promise<string | undefined> {

yarn-project/aztec-node/src/sentinel/factory.ts

@@ -15,7 +15,7 @@ export async function createSentinel(
   epochCache: EpochCache,
   archiver: L2BlockSource,
   p2p: P2PClient,
-  config: SentinelConfig & DataStoreConfig & SlasherConfig & Pick<ChainConfig, 'l1ChainId' | 'l1Contracts'>,
+  config: SentinelConfig & DataStoreConfig & SlasherConfig & Pick<ChainConfig, 'l1ChainId' | 'rollupAddress'>,
   logger = createLogger('node:sentinel'),
 ): Promise<Sentinel | undefined> {
   if (!config.sentinelEnabled) {

yarn-project/aztec-node/src/sentinel/sentinel.test.ts

@@ -56,7 +56,7 @@ describe('sentinel', () => {
     slashInactivityTargetPercentage: 0.8,
     slashInactivityConsecutiveEpochThreshold: 1,
     l1ChainId: TEST_COORDINATION_SIGNATURE_CONTEXT.chainId,
-    l1Contracts: { rollupAddress: TEST_COORDINATION_SIGNATURE_CONTEXT.rollupAddress },
+    rollupAddress: TEST_COORDINATION_SIGNATURE_CONTEXT.rollupAddress,
   };
 
   beforeEach(async () => {

yarn-project/aztec-node/src/sentinel/sentinel.ts

@@ -48,7 +48,7 @@ export type SentinelRuntimeConfig = Pick<
   SlasherConfig,
   'slashInactivityTargetPercentage' | 'slashInactivityPenalty' | 'slashInactivityConsecutiveEpochThreshold'
 > &
-  Pick<ChainConfig, 'l1ChainId' | 'l1Contracts'>;
+  Pick<ChainConfig, 'l1ChainId' | 'rollupAddress'>;
 
 /** Maps a validator status to its category: proposer or attestation. */
 function statusToCategory(status: ValidatorStatusInSlot): ValidatorStatusType {
@@ -96,7 +96,7 @@ export class Sentinel extends (EventEmitter as new () => WatcherEmitter) impleme
   private getSignatureContext(): CoordinationSignatureContext {
     return {
       chainId: this.config.l1ChainId,
-      rollupAddress: this.config.l1Contracts.rollupAddress,
+      rollupAddress: this.config.rollupAddress,
     };
   }
 

yarn-project/aztec/src/cli/cmds/standby.ts

@@ -67,7 +67,7 @@ export async function waitForCompatibleRollup(
   config: {
     l1RpcUrls: string[];
     l1ChainId: number;
-    l1Contracts: { registryAddress: EthAddress };
+    registryAddress: EthAddress;
     rollupVersion?: number;
   },
   expected: { genesisArchiveRoot: Fr; vkTreeRoot: Fr; protocolContractsHash: Fr },
@@ -77,7 +77,7 @@ export async function waitForCompatibleRollup(
   const publicClient = getPublicClient(config);
   const rollupVersion: number | 'canonical' = config.rollupVersion ?? 'canonical';
 
-  const registry = new RegistryContract(publicClient, config.l1Contracts.registryAddress);
+  const registry = new RegistryContract(publicClient, config.registryAddress);
   const rollupAddress = await registry.getRollupAddress(rollupVersion);
   const rollup = new RollupContract(publicClient, rollupAddress.toString());