@aztec/foundation 0.0.0-test.1 → 0.0.1-commit.03f7ef2

package/src/config/index.ts

@@ -1,6 +1,13 @@
+import { Fq, Fr } from '../curves/bn254/field.js';
+import { createConsoleLogger } from '../log/console.js';
 import type { EnvVar } from './env_var.js';
+import { type NetworkNames, getActiveNetworkName } from './network_name.js';
+import { SecretValue } from './secret_value.js';
 
-export { type EnvVar } from './env_var.js';
+export { SecretValue, getActiveNetworkName };
+export type { EnvVar, NetworkNames };
+export type { NetworkConfig, NetworkConfigMap } from './network_config.js';
+export { NetworkConfigMapSchema, NetworkConfigSchema } from './network_config.js';
 
 export interface ConfigMapping {
   env?: EnvVar;
@@ -10,6 +17,12 @@ export interface ConfigMapping {
   description: string;
   isBoolean?: boolean;
   nested?: Record<string, ConfigMapping>;
+  fallback?: EnvVar[];
+  /**
+   * List of deprecated env vars that are still supported but will log a warning.
+   * These should also be included in the fallback array for parsing.
+   */
+  deprecatedFallback?: { env: EnvVar; message?: string }[];
 }
 
 export function isBooleanConfigValue<T>(obj: T, key: keyof T): boolean {
@@ -18,19 +31,70 @@ export function isBooleanConfigValue<T>(obj: T, key: keyof T): boolean {
 
 export type ConfigMappingsType<T> = Record<keyof T, ConfigMapping>;
 
+/**
+ * Shared utility function to get a value from environment variables with fallback support.
+ * This can be used by both getConfigFromMappings and CLI utilities.
+ *
+ * @param env - The primary environment variable name
+ * @param fallback - Optional array of fallback environment variable names
+ * @param parseFunc - Optional function to parse the environment variable value
+ * @param defaultValue - Optional default value to use if no environment variable is set
+ * @returns The parsed value from environment variables or the default value
+ */
+export function getValueFromEnvWithFallback<T>(
+  env: EnvVar | undefined,
+  parseFunc: ((val: string) => T) | undefined,
+  defaultValue: T | undefined,
+  fallback?: EnvVar[],
+): T | undefined {
+  let value: string | undefined;
+
+  // Try primary env var
+  if (env) {
+    value = process.env[env];
+  }
+
+  // If primary not found, try fallbacks
+  if (value === undefined && fallback && fallback.length > 0) {
+    for (const fallbackEnv of fallback) {
+      const fallbackVal = process.env[fallbackEnv];
+      if (fallbackVal !== undefined) {
+        value = fallbackVal;
+        break;
+      }
+    }
+  }
+
+  // Parse the value if needed
+  if (value !== undefined) {
+    return parseFunc ? parseFunc(value) : (value as unknown as T);
+  }
+
+  // Return default if no env var found
+  return defaultValue;
+}
+
 export function getConfigFromMappings<T>(configMappings: ConfigMappingsType<T>): T {
   const config = {} as T;
 
   for (const key in configMappings) {
-    const { env, parseEnv, defaultValue: def, nested } = configMappings[key];
+    const { env, parseEnv, defaultValue, nested, fallback, deprecatedFallback } = configMappings[key];
     if (nested) {
       (config as any)[key] = getConfigFromMappings(nested);
     } else {
-      const val = env ? process.env[env] : undefined;
-      if (val !== undefined) {
-        (config as any)[key] = parseEnv ? parseEnv(val) : val;
-      } else if (def !== undefined) {
-        (config as any)[key] = def;
+      // Use the shared utility function
+      (config as any)[key] = getValueFromEnvWithFallback(env, parseEnv, defaultValue, fallback);
+
+      // Check for deprecated env vars and warn if logger is set
+      if (deprecatedFallback?.length) {
+        const userLog = createConsoleLogger('[DEPRECATED]');
+        for (const { env: deprecatedEnv, message } of deprecatedFallback) {
+          if (process.env[deprecatedEnv]) {
+            const warningMessage =
+              message ?? `Environment variable ${deprecatedEnv} is deprecated. Please use ${env} instead.`;
+            userLog(warningMessage, { deprecatedEnvVar: deprecatedEnv, newEnvVar: env });
+          }
+        }
       }
     }
   }
@@ -65,6 +129,25 @@ export function numberConfigHelper(defaultVal: number): Pick<ConfigMapping, 'par
   };
 }
 
+/**
+ * Generates parseEnv and default values for a numerical config value.
+ * @param defaultVal - The default numerical value to use if the environment variable is not set or is invalid
+ * @returns Object with parseEnv and default values for a numerical config value
+ */
+export function floatConfigHelper(
+  defaultVal: number,
+  validationFn?: (val: number) => void,
+): Pick<ConfigMapping, 'parseEnv' | 'defaultValue'> {
+  return {
+    parseEnv: (val: string): number => {
+      const parsed = safeParseFloat(val, defaultVal);
+      validationFn?.(parsed);
+      return parsed;
+    },
+    defaultValue: defaultVal,
+  };
+}
+
 /**
  * Generates parseEnv and default values for a numerical config value.
  * @param defaultVal - The default numerical value to use if the environment variable is not set or is invalid
@@ -97,6 +180,26 @@ export function optionalNumberConfigHelper(): Pick<ConfigMapping, 'parseEnv'> {
   };
 }
 
+/** Generates parseEnv for an enum-like config value. */
+export function enumConfigHelper<T extends string>(
+  values: T[],
+  defaultValue?: NoInfer<T>,
+): Pick<ConfigMapping, 'parseEnv' | 'defaultValue'> {
+  return {
+    parseEnv: (val: string) => {
+      const sanitizedVal = (val ?? '').trim().toLowerCase();
+      if (values.includes(sanitizedVal as T)) {
+        return sanitizedVal as T;
+      }
+      if (!val && defaultValue) {
+        return defaultValue;
+      }
+      throw new Error(`Invalid config value '${val}' (must be one of ${values.join(', ')})`);
+    },
+    defaultValue,
+  };
+}
+
 /**
  * Generates parseEnv and default values for a boolean config value.
  * @param defaultVal - The default value to use if the environment variable is not set or is invalid
@@ -114,11 +217,97 @@ export function booleanConfigHelper(
   };
 }
 
+export function secretValueConfigHelper<T>(parse: (val: string | undefined) => T): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<T>;
+  }
+> {
+  const wrap = (val: string) => new SecretValue(parse(val));
+  return {
+    parseEnv: wrap,
+    parseVal: wrap,
+    defaultValue: new SecretValue(parse(undefined)),
+    isBoolean: true,
+  };
+}
+
 /** Parses an env var as boolean. Returns true only if value is 1, true, or TRUE. */
 export function parseBooleanEnv(val: string | undefined): boolean {
   return val !== undefined && ['1', 'true', 'TRUE'].includes(val);
 }
 
+export function secretStringConfigHelper(): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<string | undefined>;
+  }
+>;
+export function secretStringConfigHelper(defaultValue: string): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<string>;
+  }
+>;
+export function secretStringConfigHelper(defaultValue?: string): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<string | typeof defaultValue>;
+  }
+> {
+  const parse = (val: string) => new SecretValue(val);
+  return {
+    parseEnv: parse,
+    parseVal: parse,
+    defaultValue: defaultValue !== undefined ? new SecretValue(defaultValue) : undefined,
+    isBoolean: true,
+  };
+}
+
+export function secretFrConfigHelper(): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<Fr | undefined>;
+  }
+>;
+export function secretFrConfigHelper(defaultValue: Fr): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<Fr>;
+  }
+>;
+export function secretFrConfigHelper(defaultValue?: Fr): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<Fr | typeof defaultValue>;
+  }
+> {
+  const parse = (val: string) => new SecretValue(Fr.fromHexString(val));
+  return {
+    parseEnv: parse,
+    parseVal: parse,
+    defaultValue: defaultValue !== undefined ? new SecretValue(defaultValue) : undefined,
+    isBoolean: true,
+  };
+}
+
+export function secretFqConfigHelper(defaultValue: Fq): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<Fq>;
+  }
+>;
+export function secretFqConfigHelper(): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<Fq | undefined>;
+  }
+>;
+export function secretFqConfigHelper(defaultValue?: Fq): Required<
+  Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {
+    parseVal: (val: string) => SecretValue<Fq | typeof defaultValue>;
+  }
+> {
+  const parse = (val: string) => new SecretValue(Fq.fromHexString(val));
+  return {
+    parseEnv: parse,
+    parseVal: parse,
+    defaultValue: typeof defaultValue !== 'undefined' ? new SecretValue(defaultValue) : undefined,
+    isBoolean: true,
+  };
+}
+
 /**
  * Safely parses a number from a string.
  * If the value is not a number or is not a safe integer, the default value is returned.
@@ -131,6 +320,18 @@ function safeParseNumber(value: string, defaultValue: number): number {
   return Number.isSafeInteger(parsedValue) ? parsedValue : defaultValue;
 }
 
+/**
+ * Safely parses a floating point number from a string.
+ * If the value is not a number, the default value is returned.
+ * @param value - The string value to parse
+ * @param defaultValue - The default value to return
+ * @returns Either parsed value or default value
+ */
+function safeParseFloat(value: string, defaultValue: number): number {
+  const parsedValue = parseFloat(value);
+  return Number.isNaN(parsedValue) ? defaultValue : parsedValue;
+}
+
 /**
  * Picks specific keys from the given configuration mappings.
  *

package/src/config/network_config.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+
+export const NetworkConfigSchema = z
+  .object({
+    bootnodes: z.array(z.string()),
+    snapshots: z.array(z.string()),
+    blobFileStoreUrls: z.array(z.string()).optional(),
+    registryAddress: z.string(),
+    feeAssetHandlerAddress: z.string().optional(),
+    l1ChainId: z.number(),
+    blockDurationMs: z.number().positive().optional(),
+  })
+  .passthrough(); // Allow additional unknown fields to pass through
+
+export const NetworkConfigMapSchema = z.record(z.string(), NetworkConfigSchema);
+
+export type NetworkConfig = z.infer<typeof NetworkConfigSchema>;
+export type NetworkConfigMap = z.infer<typeof NetworkConfigMapSchema>;

package/src/config/network_name.ts

@@ -0,0 +1,28 @@
+export type NetworkNames =
+  | 'local'
+  | 'staging-ignition'
+  | 'staging-public'
+  | 'testnet'
+  | 'mainnet'
+  | 'next-net'
+  | 'devnet';
+
+export function getActiveNetworkName(name?: string): NetworkNames {
+  const network = name || process.env.NETWORK;
+  if (!network || network === '' || network === 'local') {
+    return 'local';
+  } else if (network === 'staging-ignition') {
+    return network;
+  } else if (network === 'staging-public') {
+    return network;
+  } else if (network === 'testnet' || network === 'alpha-testnet') {
+    return 'testnet';
+  } else if (network === 'mainnet') {
+    return 'mainnet';
+  } else if (network === 'next-net') {
+    return 'next-net';
+  } else if (network === 'devnet') {
+    return 'devnet';
+  }
+  throw new Error(`Unknown network: ${network}`);
+}

package/src/config/secret_value.ts

@@ -0,0 +1,49 @@
+import { inspect } from 'util';
+import type { ZodType } from 'zod';
+
+/**
+ * A class wrapping a secret value to protect it from accidently being leaked in logs
+ */
+export class SecretValue<T> {
+  /** The secret value. Use a private member field so that it's not visible to the outside */
+  #value: T;
+
+  constructor(
+    value: T,
+    private readonly redactedValue = '[Redacted]',
+  ) {
+    this.#value = value;
+  }
+
+  /**
+   * Returns the wrapped value
+   */
+  public getValue(): T {
+    return this.#value;
+  }
+
+  /**
+   * Returns a redacted string representation of the value
+   */
+  public toString(): string {
+    return this.redactedValue;
+  }
+
+  /**
+   * Returns a redacted string representation of the value
+   */
+  public toJSON(): string {
+    return this.redactedValue;
+  }
+
+  public [inspect.custom]() {
+    return this.toString();
+  }
+
+  /**
+   * Returns a Zod schema
+   */
+  static schema<O>(valueSchema: ZodType<O, any, any>): ZodType<SecretValue<O>, any, any> {
+    return valueSchema.transform(value => new SecretValue<O>(value));
+  }
+}

package/src/crypto/aes128/index.ts

@@ -1,4 +1,4 @@
-import { BarretenbergSync, RawBuffer } from '@aztec/bb.js';
+import { BarretenbergSync } from '@aztec/bb.js';
 
 import { Buffer } from 'buffer';
 
@@ -22,10 +22,15 @@ export class Aes128 {
     paddingBuffer.fill(numPaddingBytes);
     const input = Buffer.concat([data, paddingBuffer]);
 
-    const api = await BarretenbergSync.initSingleton(process.env.BB_WASM_PATH);
-    return Buffer.from(
-      api.aesEncryptBufferCbc(new RawBuffer(input), new RawBuffer(iv), new RawBuffer(key), input.length),
-    );
+    await BarretenbergSync.initSingleton();
+    const api = BarretenbergSync.getSingleton();
+    const response = api.aesEncrypt({
+      plaintext: input,
+      iv,
+      key,
+      length: input.length,
+    });
+    return Buffer.from(response.ciphertext);
   }
 
   /**
@@ -37,11 +42,15 @@ export class Aes128 {
    * @returns Decrypted data.
    */
   public async decryptBufferCBCKeepPadding(data: Uint8Array, iv: Uint8Array, key: Uint8Array): Promise<Buffer> {
-    const api = await BarretenbergSync.initSingleton(process.env.BB_WASM_PATH);
-    const paddedBuffer = Buffer.from(
-      api.aesDecryptBufferCbc(new RawBuffer(data), new RawBuffer(iv), new RawBuffer(key), data.length),
-    );
-    return paddedBuffer;
+    await BarretenbergSync.initSingleton();
+    const api = BarretenbergSync.getSingleton();
+    const response = api.aesDecrypt({
+      ciphertext: data,
+      iv,
+      key,
+      length: data.length,
+    });
+    return Buffer.from(response.plaintext);
   }
 
   /**