chore: Stricter zodFor check for schemas (#19071)

The former `satisfies ZodFor<T>` approach didn't catch missing optional
properties of the type in the schema. This introduces a new
Claude-generated `zodFor` function that does catch them.

I suggest reviewing with whitespace diff hidden.

Author: spalladino

yarn-project/aztec.js/src/wallet/wallet.ts

@@ -20,7 +20,7 @@ import {
   type ContractMetadata,
 } from '@aztec/stdlib/contract';
 import { Gas } from '@aztec/stdlib/gas';
-import { AbiDecodedSchema, type ApiSchemaFor, type ZodFor, optional, schemas } from '@aztec/stdlib/schemas';
+import { AbiDecodedSchema, type ApiSchemaFor, optional, schemas, zodFor } from '@aztec/stdlib/schemas';
 import {
   Capsule,
   HashedValues,
@@ -281,28 +281,34 @@ export const BatchedMethodSchema = z.union([
   }),
 ]);
 
-export const ContractMetadataSchema = z.object({
-  contractInstance: z.union([ContractInstanceWithAddressSchema, z.undefined()]),
-  isContractInitialized: z.boolean(),
-  isContractPublished: z.boolean(),
-}) satisfies ZodFor<ContractMetadata>;
+export const ContractMetadataSchema = zodFor<ContractMetadata>()(
+  z.object({
+    contractInstance: z.union([ContractInstanceWithAddressSchema, z.undefined()]),
+    isContractInitialized: z.boolean(),
+    isContractPublished: z.boolean(),
+  }),
+);
 
-export const ContractClassMetadataSchema = z.object({
-  contractClass: z.union([ContractClassWithIdSchema, z.undefined()]),
-  isContractClassPubliclyRegistered: z.boolean(),
-  artifact: z.union([ContractArtifactSchema, z.undefined()]),
-}) satisfies ZodFor<ContractClassMetadata>;
+export const ContractClassMetadataSchema = zodFor<ContractClassMetadata>()(
+  z.object({
+    contractClass: z.union([ContractClassWithIdSchema, z.undefined()]),
+    isContractClassPubliclyRegistered: z.boolean(),
+    artifact: z.union([ContractArtifactSchema, z.undefined()]),
+  }),
+);
 
 export const EventMetadataDefinitionSchema = z.object({
   eventSelector: schemas.EventSelector,
   abiType: AbiTypeSchema,
   fieldNames: z.array(z.string()),
 });
 
-export const PrivateEventSchema: ZodFor<PrivateEvent<AbiDecoded>> = z.object({
-  event: AbiDecodedSchema,
-  metadata: inTxSchema(),
-});
+export const PrivateEventSchema: z.ZodType<any> = zodFor<PrivateEvent<AbiDecoded>>()(
+  z.object({
+    event: AbiDecodedSchema,
+    metadata: inTxSchema(),
+  }),
+);
 
 export const PrivateEventFilterSchema = z.object({
   contractAddress: schemas.AztecAddress,

yarn-project/blob-sink/src/archive/blobscan_archive_client.ts

@@ -1,46 +1,48 @@
 import type { BlobJson } from '@aztec/blob-lib/types';
 import { createLogger } from '@aztec/foundation/log';
 import { makeBackoff, retry } from '@aztec/foundation/retry';
-import { type ZodFor, schemas } from '@aztec/foundation/schemas';
+import { schemas, zodFor } from '@aztec/foundation/schemas';
 import { type TelemetryClient, getTelemetryClient } from '@aztec/telemetry-client';
 
 import { z } from 'zod';
 
 import { BlobArchiveClientInstrumentation } from './instrumentation.js';
 import type { BlobArchiveClient } from './interface.js';
 
-export const BlobscanBlockResponseSchema = z
-  .object({
-    hash: z.string(),
-    slot: z.number().int(),
-    number: z.number().int(),
-    transactions: z.array(
-      z.object({
-        hash: z.string(),
-        blobs: z.array(
-          z.object({
-            versionedHash: z.string(),
-            data: z.string(),
-            commitment: z.string(),
-            proof: z.string(),
-            size: z.number().int(),
-            index: z.number().int().optional(), // This is the index within the tx, not within the block!
-          }),
-        ),
-      }),
+export const BlobscanBlockResponseSchema = zodFor<BlobJson[]>()(
+  z
+    .object({
+      hash: z.string(),
+      slot: z.number().int(),
+      number: z.number().int(),
+      transactions: z.array(
+        z.object({
+          hash: z.string(),
+          blobs: z.array(
+            z.object({
+              versionedHash: z.string(),
+              data: z.string(),
+              commitment: z.string(),
+              proof: z.string(),
+              size: z.number().int(),
+              index: z.number().int().optional(), // This is the index within the tx, not within the block!
+            }),
+          ),
+        }),
+      ),
+    })
+    .transform(data =>
+      data.transactions
+        .flatMap(tx =>
+          tx.blobs.map(blob => ({
+            blob: blob.data,
+            // eslint-disable-next-line camelcase
+            kzg_commitment: blob.commitment,
+          })),
+        )
+        .map((blob, index) => ({ ...blob, index: index.toString() })),
     ),
-  })
-  .transform(data =>
-    data.transactions
-      .flatMap(tx =>
-        tx.blobs.map(blob => ({
-          blob: blob.data,
-          // eslint-disable-next-line camelcase
-          kzg_commitment: blob.commitment,
-        })),
-      )
-      .map((blob, index) => ({ ...blob, index: index.toString() })),
-  ) satisfies ZodFor<BlobJson[]>;
+);
 
 // Response from https://api.blobscan.com/blocks?sort=desc&type=canonical
 export const BlobscanBlocksResponseSchema = z.object({

yarn-project/bot/src/config.ts

@@ -14,7 +14,7 @@ import { Fr } from '@aztec/foundation/curves/bn254';
 import { type DataStoreConfig, dataConfigMappings } from '@aztec/kv-store/config';
 import { getVKTreeRoot } from '@aztec/noir-protocol-circuits-types/vk-tree';
 import { protocolContractsHash } from '@aztec/protocol-contracts';
-import { type ZodFor, schemas } from '@aztec/stdlib/schemas';
+import { schemas, zodFor } from '@aztec/stdlib/schemas';
 import type { ComponentsVersions } from '@aztec/stdlib/versioning';
 
 import { z } from 'zod';
@@ -80,50 +80,52 @@ export type BotConfig = {
   ammTxs: boolean;
 } & Pick<DataStoreConfig, 'dataDirectory' | 'dataStoreMapSizeKb'>;
 
-export const BotConfigSchema = z
-  .object({
-    nodeUrl: z.string().optional(),
-    nodeAdminUrl: z.string().optional(),
-    l1RpcUrls: z.array(z.string()).optional(),
-    l1Mnemonic: schemas.SecretValue(z.string()).optional(),
-    l1PrivateKey: schemas.SecretValue(z.string()).optional(),
-    l1ToL2MessageTimeoutSeconds: z.number(),
-    senderPrivateKey: schemas.SecretValue(schemas.Fr).optional(),
-    senderSalt: schemas.Fr.optional(),
-    tokenSalt: schemas.Fr,
-    txIntervalSeconds: z.number(),
-    privateTransfersPerTx: z.number().int().nonnegative(),
-    publicTransfersPerTx: z.number().int().nonnegative(),
-    feePaymentMethod: z.literal('fee_juice'),
-    baseFeePadding: z.number().int().nonnegative(),
-    noStart: z.boolean(),
-    txMinedWaitSeconds: z.number(),
-    followChain: z.enum(BotFollowChain),
-    maxPendingTxs: z.number().int().nonnegative(),
-    flushSetupTransactions: z.boolean(),
-    l2GasLimit: z.number().int().nonnegative().optional(),
-    daGasLimit: z.number().int().nonnegative().optional(),
-    contract: z.nativeEnum(SupportedTokenContracts),
-    maxConsecutiveErrors: z.number().int().nonnegative(),
-    stopWhenUnhealthy: z.boolean(),
-    ammTxs: z.boolean().default(false),
-    dataDirectory: z.string().optional(),
-    dataStoreMapSizeKb: z.number().optional(),
-  })
-  .transform(config => ({
-    nodeUrl: undefined,
-    nodeAdminUrl: undefined,
-    l1RpcUrls: undefined,
-    senderSalt: undefined,
-    l2GasLimit: undefined,
-    daGasLimit: undefined,
-    l1Mnemonic: undefined,
-    l1PrivateKey: undefined,
-    senderPrivateKey: undefined,
-    dataDirectory: undefined,
-    dataStoreMapSizeKb: 1_024 * 1_024,
-    ...config,
-  })) satisfies ZodFor<BotConfig>;
+export const BotConfigSchema = zodFor<BotConfig>()(
+  z
+    .object({
+      nodeUrl: z.string().optional(),
+      nodeAdminUrl: z.string().optional(),
+      l1RpcUrls: z.array(z.string()).optional(),
+      l1Mnemonic: schemas.SecretValue(z.string()).optional(),
+      l1PrivateKey: schemas.SecretValue(z.string()).optional(),
+      l1ToL2MessageTimeoutSeconds: z.number(),
+      senderPrivateKey: schemas.SecretValue(schemas.Fr).optional(),
+      senderSalt: schemas.Fr.optional(),
+      tokenSalt: schemas.Fr,
+      txIntervalSeconds: z.number(),
+      privateTransfersPerTx: z.number().int().nonnegative(),
+      publicTransfersPerTx: z.number().int().nonnegative(),
+      feePaymentMethod: z.literal('fee_juice'),
+      baseFeePadding: z.number().int().nonnegative(),
+      noStart: z.boolean(),
+      txMinedWaitSeconds: z.number(),
+      followChain: z.enum(BotFollowChain),
+      maxPendingTxs: z.number().int().nonnegative(),
+      flushSetupTransactions: z.boolean(),
+      l2GasLimit: z.number().int().nonnegative().optional(),
+      daGasLimit: z.number().int().nonnegative().optional(),
+      contract: z.nativeEnum(SupportedTokenContracts),
+      maxConsecutiveErrors: z.number().int().nonnegative(),
+      stopWhenUnhealthy: z.boolean(),
+      ammTxs: z.boolean().default(false),
+      dataDirectory: z.string().optional(),
+      dataStoreMapSizeKb: z.number().optional(),
+    })
+    .transform(config => ({
+      nodeUrl: undefined,
+      nodeAdminUrl: undefined,
+      l1RpcUrls: undefined,
+      senderSalt: undefined,
+      l2GasLimit: undefined,
+      daGasLimit: undefined,
+      l1Mnemonic: undefined,
+      l1PrivateKey: undefined,
+      senderPrivateKey: undefined,
+      dataDirectory: undefined,
+      dataStoreMapSizeKb: 1_024 * 1_024,
+      ...config,
+    })),
+);
 
 export const botConfigMappings: ConfigMappingsType<BotConfig> = {
   nodeUrl: {

yarn-project/ethereum/src/l1_contract_addresses.ts

@@ -1,6 +1,6 @@
 import type { ConfigMappingsType } from '@aztec/foundation/config';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { type ZodFor, schemas } from '@aztec/foundation/schemas';
+import { schemas, zodFor } from '@aztec/foundation/schemas';
 
 import { z } from 'zod';
 
@@ -35,25 +35,27 @@ export type L1ContractAddresses = {
   dateGatedRelayerAddress?: EthAddress | undefined;
 };
 
-export const L1ContractAddressesSchema = z.object({
-  rollupAddress: schemas.EthAddress,
-  registryAddress: schemas.EthAddress,
-  inboxAddress: schemas.EthAddress,
-  outboxAddress: schemas.EthAddress,
-  feeJuiceAddress: schemas.EthAddress,
-  stakingAssetAddress: schemas.EthAddress,
-  feeJuicePortalAddress: schemas.EthAddress,
-  coinIssuerAddress: schemas.EthAddress,
-  rewardDistributorAddress: schemas.EthAddress,
-  governanceProposerAddress: schemas.EthAddress,
-  governanceAddress: schemas.EthAddress,
-  slashFactoryAddress: schemas.EthAddress.optional(),
-  feeAssetHandlerAddress: schemas.EthAddress.optional(),
-  stakingAssetHandlerAddress: schemas.EthAddress.optional(),
-  zkPassportVerifierAddress: schemas.EthAddress.optional(),
-  gseAddress: schemas.EthAddress.optional(),
-  dateGatedRelayerAddress: schemas.EthAddress.optional(),
-}) satisfies ZodFor<L1ContractAddresses>;
+export const L1ContractAddressesSchema = zodFor<L1ContractAddresses>()(
+  z.object({
+    rollupAddress: schemas.EthAddress,
+    registryAddress: schemas.EthAddress,
+    inboxAddress: schemas.EthAddress,
+    outboxAddress: schemas.EthAddress,
+    feeJuiceAddress: schemas.EthAddress,
+    stakingAssetAddress: schemas.EthAddress,
+    feeJuicePortalAddress: schemas.EthAddress,
+    coinIssuerAddress: schemas.EthAddress,
+    rewardDistributorAddress: schemas.EthAddress,
+    governanceProposerAddress: schemas.EthAddress,
+    governanceAddress: schemas.EthAddress,
+    slashFactoryAddress: schemas.EthAddress.optional(),
+    feeAssetHandlerAddress: schemas.EthAddress.optional(),
+    stakingAssetHandlerAddress: schemas.EthAddress.optional(),
+    zkPassportVerifierAddress: schemas.EthAddress.optional(),
+    gseAddress: schemas.EthAddress.optional(),
+    dateGatedRelayerAddress: schemas.EthAddress.optional(),
+  }),
+);
 
 const parseEnv = (val: string) => EthAddress.fromString(val);
 

yarn-project/foundation/src/schemas/types.ts

@@ -1,3 +1,36 @@
 import type { ZodType } from 'zod';
 
 export type ZodFor<T> = ZodType<T, any, any>;
+
+/**
+ * Creates a schema validator that enforces all properties of type T are present in the schema.
+ * This provides compile-time safety to ensure schemas don't miss optional properties.
+ *
+ * @example
+ * ```ts
+ * interface MyConfig {
+ *   foo: string;
+ *   bar?: number;
+ * }
+ *
+ * // ✅ This will work - all keys present
+ * const schema1 = zodFor<MyConfig>()(z.object({
+ *   foo: z.string(),
+ *   bar: z.number().optional(),
+ * }));
+ *
+ * // ❌ This will error - 'bar' is missing
+ * const schema2 = zodFor<MyConfig>()(z.object({
+ *   foo: z.string(),
+ * }));
+ * ```
+ */
+export function zodFor<T>() {
+  return (schema => schema) as <S extends ZodType<any, any, any>>(
+    schema: keyof T extends keyof S['_output']
+      ? keyof S['_output'] extends keyof T
+        ? S
+        : S & { __error__: 'Schema has extra keys not in type'; __extra__: Exclude<keyof S['_output'], keyof T> }
+      : S & { __error__: 'Schema is missing keys from type'; __missing__: Exclude<keyof T, keyof S['_output']> },
+  ) => S;
+}