@aztec/foundation 0.0.1-commit.fce3e4f → 0.0.1-commit.fffb133c

package/src/config/index.ts

@@ -1,6 +1,8 @@
-import { Fq, Fr } from '../fields/fields.js';
+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 { parseBooleanEnv } from './parse-env.js';
 import { SecretValue } from './secret_value.js';
 
 export { SecretValue, getActiveNetworkName };
@@ -17,6 +19,11 @@ export interface ConfigMapping {
   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 {
@@ -72,12 +79,24 @@ export function getConfigFromMappings<T>(configMappings: ConfigMappingsType<T>):
   const config = {} as T;
 
   for (const key in configMappings) {
-    const { env, parseEnv, defaultValue, nested, fallback } = configMappings[key];
+    const { env, parseEnv, defaultValue, nested, fallback, deprecatedFallback } = configMappings[key];
     if (nested) {
       (config as any)[key] = getConfigFromMappings(nested);
     } else {
       // 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 });
+          }
+        }
+      }
     }
   }
 
@@ -130,6 +149,23 @@ export function floatConfigHelper(
   };
 }
 
+/**
+ * Parses an environment variable to a 0-1 percentage value
+ */
+export function percentageConfigHelper(defaultVal: number): Pick<ConfigMapping, 'parseEnv' | 'defaultValue'> {
+  return {
+    parseEnv: (val: string): number => {
+      const parsed = safeParseFloat(val, defaultVal);
+      if (parsed < 0 || parsed > 1) {
+        throw new TypeError(`Invalid percentage value: ${parsed} should be between 0 and 1`);
+      }
+
+      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
@@ -213,10 +249,7 @@ export function secretValueConfigHelper<T>(parse: (val: string | undefined) => T
   };
 }
 
-/** 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 { parseBooleanEnv } from './parse-env.js';
 
 export function secretStringConfigHelper(): Required<
   Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & {

package/src/config/network_config.ts

@@ -4,9 +4,11 @@ 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
 

package/src/config/parse-env.ts

@@ -0,0 +1,4 @@
+/** 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);
+}

package/src/crypto/bls/bn254_keystore.ts

@@ -1,4 +1,4 @@
-import { randomBytes } from '@aztec/foundation/crypto';
+import { randomBytes } from '@aztec/foundation/crypto/random';
 
 import { createCipheriv, createDecipheriv, createHash, pbkdf2Sync, randomUUID } from 'crypto';
 import { readFileSync } from 'fs';

package/src/crypto/bls/index.ts

@@ -1,4 +1,4 @@
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import type { Hex } from '@aztec/foundation/string';
 
 import { mod } from '@noble/curves/abstract/modular';

package/src/crypto/bn254/index.ts

@@ -1,173 +1,64 @@
-import {
-  BN254_G1_GENERATOR,
-  BN254_G2_GENERATOR,
-  BarretenbergSync,
-  type Bn254G1Point as BbApiBn254G1Point,
-  type Bn254G2Point as BbApiBn254G2Point,
-} from '@aztec/bb.js';
-
-import { Fq, Fr } from '../../fields/fields.js';
+import { Fr } from '../../curves/bn254/field.js';
+import { Bn254G1Point, Bn254G2Point } from '../../curves/bn254/point.js';
 
 /**
- * BN254 G1 point using foundation field classes.
- * Represents a point on the BN254 elliptic curve in affine coordinates.
+ * BN254 utility functions for point operations.
+ * Provides compression, decompression, and public key generation for the BN254 curve.
+ * Uses the bb.js Barretenberg backend for point operations.
  */
-export class Bn254G1Point {
-  constructor(
-    public readonly x: Fq,
-    public readonly y: Fq,
-  ) {}
-
-  private toBbApiPoint(): BbApiBn254G1Point {
-    return {
-      x: this.x.toBuffer(),
-      y: this.y.toBuffer(),
-    };
-  }
-
-  private static fromBbApiPoint(point: BbApiBn254G1Point): Bn254G1Point {
-    return new Bn254G1Point(Fq.fromBuffer(Buffer.from(point.x)), Fq.fromBuffer(Buffer.from(point.y)));
-  }
-
-  async isOnCurve(): Promise<boolean> {
-    await BarretenbergSync.initSingleton();
-    const api = BarretenbergSync.getSingleton();
-
-    const apiPoint = this.toBbApiPoint();
-    const response = api.bn254G1IsOnCurve({ point: apiPoint });
-    return response.isOnCurve;
-  }
-
-  /**
-   * Get the generator point for BN254 G1, or perform scalar multiplication.
-   * When called without arguments, returns the base generator point.
-   * When called with a scalar, returns scalar * generator (useful for public key derivation).
-   */
-  static async generator(scalar?: Fr): Promise<Bn254G1Point> {
-    if (!scalar) {
-      return new Bn254G1Point(
-        Fq.fromBuffer(Buffer.from(BN254_G1_GENERATOR.x)),
-        Fq.fromBuffer(Buffer.from(BN254_G1_GENERATOR.y)),
-      );
-    }
-
-    await BarretenbergSync.initSingleton();
-    const api = BarretenbergSync.getSingleton();
-
-    const response = api.bn254G1Mul({
-      point: BN254_G1_GENERATOR,
-      scalar: scalar.toBuffer(),
-    });
-
-    return Bn254G1Point.fromBbApiPoint(response.point);
-  }
-
-  /**
-   * Decompress a BN254 G1 point from compressed form (32 bytes).
-   * The compressed format encodes the x-coordinate and the sign bit of the y-coordinate
-   * in the most significant bit.
-   */
-  static async fromCompressed(compressed: Buffer): Promise<Bn254G1Point> {
-    if (compressed.length !== 32) {
-      throw new Error('Invalid compressed point length');
-    }
-    await BarretenbergSync.initSingleton();
-    const api = BarretenbergSync.getSingleton();
-
-    const response = api.bn254G1FromCompressed({
-      compressed: new Uint8Array(compressed),
-    });
-
-    return Bn254G1Point.fromBbApiPoint(response.point);
-  }
 
-  /**
-   * Compress this BN254 G1 point to 32 bytes.
-   * The compressed format encodes the x-coordinate and the sign bit of the y-coordinate
-   * in the most significant bit (bit 255).
-   */
-  compress(): Buffer {
-    const xBytes = this.x.toBuffer();
-    // Get the least significant bit of y to determine the sign
-    const yLsb = this.y.toBigInt() & 1n;
-    // If y is odd, set the most significant bit (bit 255) of the output
-    if (yLsb === 1n) {
-      xBytes[0] |= 0x80;
-    }
-    return xBytes;
-  }
+/**
+ * Generate a compressed BN254 G1 public key from a private key.
+ *
+ * @param privateKeyHex - Private key as 0x-prefixed hex string
+ * @returns Compressed G1 point (32 bytes with sign bit in MSB)
+ */
+export async function computeBn254G1PublicKeyCompressed(privateKeyHex: string): Promise<string> {
+  const sk = BigInt(privateKeyHex);
+  const skReduced = sk % Fr.MODULUS;
 
-  equals(other: Bn254G1Point): boolean {
-    return this.x.equals(other.x) && this.y.equals(other.y);
-  }
+  // Generate G1 point on BN254 curve using bb.js
+  const scalar = Fr.fromString(skReduced.toString());
+  const pk1 = await Bn254G1Point.generator(scalar);
 
-  toString(): string {
-    return `Bn254G1Point(x: ${this.x.toString()}, y: ${this.y.toString()})`;
-  }
+  // Compress the point using the primitive method
+  return '0x' + pk1.compress().toString('hex');
 }
 
 /**
- * BN254 G2 point using foundation field classes.
- * Represents a point on the BN254 G2 curve (twist curve) in affine coordinates.
- * G2 points use extension field coordinates (Fq2).
+ * Generate uncompressed BN254 G1 public key from a private key.
+ *
+ * @param privateKeyHex - Private key as 0x-prefixed hex string
+ * @returns G1 point in affine coordinates
  */
-export class Bn254G2Point {
-  constructor(
-    public readonly x: [Fq, Fq],
-    public readonly y: [Fq, Fq],
-  ) {}
-
-  private toBbApiPoint(): BbApiBn254G2Point {
-    return {
-      x: [this.x[0].toBuffer(), this.x[1].toBuffer()],
-      y: [this.y[0].toBuffer(), this.y[1].toBuffer()],
-    };
-  }
-
-  private static fromBbApiPoint(point: BbApiBn254G2Point): Bn254G2Point {
-    return new Bn254G2Point(
-      [Fq.fromBuffer(Buffer.from(point.x[0])), Fq.fromBuffer(Buffer.from(point.x[1]))],
-      [Fq.fromBuffer(Buffer.from(point.y[0])), Fq.fromBuffer(Buffer.from(point.y[1]))],
-    );
-  }
-
-  /**
-   * Get the generator point for BN254 G2, or perform scalar multiplication.
-   * When called without arguments, returns the base generator point.
-   * When called with a scalar, returns scalar * generator.
-   */
-  static async generator(scalar?: Fr): Promise<Bn254G2Point> {
-    if (!scalar) {
-      return new Bn254G2Point(
-        [Fq.fromBuffer(Buffer.from(BN254_G2_GENERATOR.x[0])), Fq.fromBuffer(Buffer.from(BN254_G2_GENERATOR.x[1]))],
-        [Fq.fromBuffer(Buffer.from(BN254_G2_GENERATOR.y[0])), Fq.fromBuffer(Buffer.from(BN254_G2_GENERATOR.y[1]))],
-      );
-    }
-
-    await BarretenbergSync.initSingleton();
-    const api = BarretenbergSync.getSingleton();
+export async function computeBn254G1PublicKey(privateKeyHex: string): Promise<{ x: bigint; y: bigint }> {
+  const sk = BigInt(privateKeyHex);
+  const skReduced = sk % Fr.MODULUS;
 
-    const response = api.bn254G2Mul({
-      point: BN254_G2_GENERATOR as BbApiBn254G2Point,
-      scalar: scalar.toBuffer(),
-    });
+  const scalar = Fr.fromString(skReduced.toString());
+  const pk1 = await Bn254G1Point.generator(scalar);
 
-    return Bn254G2Point.fromBbApiPoint(response.point);
-  }
-
-  equals(other: Bn254G2Point): boolean {
-    return (
-      this.x[0].equals(other.x[0]) &&
-      this.x[1].equals(other.x[1]) &&
-      this.y[0].equals(other.y[0]) &&
-      this.y[1].equals(other.y[1])
-    );
-  }
-
-  toString(): string {
-    return `Bn254G2Point(x: (${this.x[0].toString()}, ${this.x[1].toString()}), y: (${this.y[0].toString()}, ${this.y[1].toString()}))`;
-  }
+  return { x: pk1.x.toBigInt(), y: pk1.y.toBigInt() };
 }
 
-// Re-export BN254 point utility functions
-export { computeBn254G1PublicKeyCompressed, computeBn254G1PublicKey, computeBn254G2PublicKey } from './bn254_utils.js';
+/**
+ * Generate BN254 G2 public key from a private key.
+ *
+ * @param privateKeyHex - Private key as 0x-prefixed hex string
+ * @returns G2 point in affine coordinates
+ */
+export async function computeBn254G2PublicKey(privateKeyHex: string): Promise<{
+  x: { c0: bigint; c1: bigint };
+  y: { c0: bigint; c1: bigint };
+}> {
+  const sk = BigInt(privateKeyHex);
+  const skReduced = sk % Fr.MODULUS;
+
+  const scalar = Fr.fromString(skReduced.toString());
+  const pk2 = await Bn254G2Point.generator(scalar);
+
+  return {
+    x: { c0: pk2.x[0].toBigInt(), c1: pk2.x[1].toBigInt() },
+    y: { c0: pk2.y[0].toBigInt(), c1: pk2.y[1].toBigInt() },
+  };
+}

package/src/crypto/ecdsa/signature.ts

@@ -1,6 +1,6 @@
 import { toBufferBE } from '@aztec/foundation/bigint-buffer';
-import { randomBytes } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
+import { randomBytes } from '@aztec/foundation/crypto/random';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { mapTuple } from '@aztec/foundation/serialize';
 
 import type { Signature } from '../signature/index.js';

package/src/crypto/grumpkin/index.ts

@@ -1,5 +1,7 @@
 import { BarretenbergSync } from '@aztec/bb.js';
-import { Fr, type GrumpkinScalar, Point } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import type { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
+import { Point } from '@aztec/foundation/curves/grumpkin';
 
 /**
  * Grumpkin elliptic curve operations.

package/src/crypto/keys/index.ts

@@ -1,6 +1,6 @@
 import { BarretenbergSync } from '@aztec/bb.js';
 
-import { Fr } from '../../fields/fields.js';
+import { Fr } from '../../curves/bn254/field.js';
 
 export async function vkAsFieldsMegaHonk(input: Buffer): Promise<Fr[]> {
   await BarretenbergSync.initSingleton();

package/src/crypto/pedersen/pedersen.wasm.ts

@@ -1,6 +1,6 @@
 import { BarretenbergSync } from '@aztec/bb.js';
 
-import { Fr } from '../../fields/fields.js';
+import { Fr } from '../../curves/bn254/field.js';
 import { type Fieldable, serializeToFields } from '../../serialize/serialize.js';
 
 /**

package/src/crypto/poseidon/index.ts

@@ -1,6 +1,6 @@
 import { BarretenbergSync } from '@aztec/bb.js';
 
-import { Fr } from '../../fields/fields.js';
+import { Fr } from '../../curves/bn254/field.js';
 import { type Fieldable, serializeToFields } from '../../serialize/serialize.js';
 
 /**
@@ -35,16 +35,6 @@ export async function poseidon2HashWithSeparator(input: Fieldable[], separator:
   return Fr.fromBuffer(Buffer.from(response.hash));
 }
 
-export async function poseidon2HashAccumulate(input: Fieldable[]): Promise<Fr> {
-  const inputFields = serializeToFields(input);
-  await BarretenbergSync.initSingleton();
-  const api = BarretenbergSync.getSingleton();
-  const response = api.poseidon2HashAccumulate({
-    inputs: inputFields.map(i => i.toBuffer()),
-  });
-  return Fr.fromBuffer(Buffer.from(response.hash));
-}
-
 /**
  * Runs a Poseidon2 permutation.
  * @param input the input state. Expected to be of size 4.

package/src/crypto/random/randomness_singleton.ts

@@ -12,11 +12,9 @@ export class RandomnessSingleton {
   private static instance: RandomnessSingleton;
 
   private counter = 0;
+  private readonly log = createLogger('foundation:randomness_singleton');
 
-  private constructor(
-    private readonly seed?: number,
-    private readonly log = createLogger('foundation:randomness_singleton'),
-  ) {
+  private constructor(private readonly seed?: number) {
     if (seed !== undefined) {
       this.log.debug(`Using pseudo-randomness with seed: ${seed}`);
       this.counter = seed;

package/src/crypto/schnorr/index.ts

@@ -1,5 +1,6 @@
 import { BarretenbergSync } from '@aztec/bb.js';
-import { type GrumpkinScalar, Point } from '@aztec/foundation/fields';
+import type { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
+import { Point } from '@aztec/foundation/curves/grumpkin';
 
 import { SchnorrSignature } from './signature.js';
 

package/src/crypto/schnorr/signature.ts

@@ -1,5 +1,5 @@
-import { randomBytes } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
+import { randomBytes } from '@aztec/foundation/crypto/random';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader, mapTuple } from '@aztec/foundation/serialize';
 
 import type { Signature } from '../signature/index.js';

package/src/crypto/sha256/index.ts

@@ -1,7 +1,7 @@
 /* eslint-disable camelcase */
 import { default as hash } from 'hash.js';
 
-import { Fr } from '../../fields/fields.js';
+import { Fr } from '../../curves/bn254/field.js';
 import { truncateAndPad } from '../../serialize/free_funcs.js';
 import { type Bufferable, serializeToBuffer } from '../../serialize/serialize.js';
 import type { Hasher } from '../../trees/hasher.js';

package/src/crypto/sha512/index.ts

@@ -1,6 +1,6 @@
 import { default as hash } from 'hash.js';
 
-import { GrumpkinScalar } from '../../fields/fields.js';
+import { GrumpkinScalar } from '../../curves/grumpkin/index.js';
 import { type Bufferable, serializeToBuffer } from '../../serialize/serialize.js';
 
 export const sha512 = (data: Buffer) => Buffer.from(hash.sha512().update(data).digest());

package/src/crypto/signature/index.ts

@@ -1,4 +1,4 @@
-import type { Fr } from '@aztec/foundation/fields';
+import type { Fr } from '@aztec/foundation/curves/bn254';
 
 /**
  * Interface to represent a signature.

package/src/crypto/sync/pedersen/index.ts

@@ -1,6 +1,6 @@
 import { BarretenbergSync } from '@aztec/bb.js';
 
-import { Fr } from '../../../fields/fields.js';
+import { Fr } from '../../../curves/bn254/field.js';
 import { type Fieldable, serializeToFields } from '../../../serialize/serialize.js';
 
 /**

package/src/crypto/sync/poseidon/index.ts

@@ -1,6 +1,6 @@
 import { BarretenbergSync } from '@aztec/bb.js';
 
-import { Fr } from '../../../fields/fields.js';
+import { Fr } from '../../../curves/bn254/field.js';
 import { type Fieldable, serializeToFields } from '../../../serialize/serialize.js';
 
 /**
@@ -34,15 +34,6 @@ export function poseidon2HashWithSeparator(input: Fieldable[], separator: number
   return Fr.fromBuffer(Buffer.from(response.hash));
 }
 
-export function poseidon2HashAccumulate(input: Fieldable[]): Fr {
-  const inputFields = serializeToFields(input);
-  const api = BarretenbergSync.getSingleton();
-  const response = api.poseidon2HashAccumulate({
-    inputs: inputFields.map(i => i.toBuffer()),
-  });
-  return Fr.fromBuffer(Buffer.from(response.hash));
-}
-
 /**
  * Runs a Poseidon2 permutation.
  * @param input the input state. Expected to be of size 4.

package/src/{fields/bls12_fields.ts → curves/bls12/field.ts}

@@ -2,12 +2,12 @@
 import { bls12_381 } from '@noble/curves/bls12-381';
 import { inspect } from 'util';
 
-import { toBigIntBE, toBufferBE } from '../bigint-buffer/index.js';
-import { randomBytes } from '../crypto/random/index.js';
-import { hexSchemaFor } from '../schemas/utils.js';
-import { BufferReader } from '../serialize/buffer_reader.js';
-import { TypeRegistry } from '../serialize/type_registry.js';
-import { Fr } from './fields.js';
+import { toBigIntBE, toBufferBE } from '../../bigint-buffer/index.js';
+import { randomBytes } from '../../crypto/random/index.js';
+import { hexSchemaFor } from '../../schemas/utils.js';
+import { BufferReader } from '../../serialize/buffer_reader.js';
+import { TypeRegistry } from '../../serialize/type_registry.js';
+import { Fr } from '../bn254/field.js';
 
 /**
  * Represents a field derived from BLS12Field.

package/src/curves/bls12/index.ts

@@ -0,0 +1,2 @@
+export * from './field.js';
+export * from './point.js';

package/src/{fields/bls12_point.ts → curves/bls12/point.ts}

@@ -3,13 +3,13 @@ import type { ProjPointType } from '@noble/curves/abstract/weierstrass';
 import { bls12_381 } from '@noble/curves/bls12-381';
 import { inspect } from 'util';
 
-import { toBufferBE } from '../bigint-buffer/index.js';
-import { randomBoolean } from '../crypto/random/index.js';
-import { hexSchemaFor } from '../schemas/utils.js';
-import { BufferReader, serializeToBuffer } from '../serialize/index.js';
-import { bufferToHex, hexToBuffer } from '../string/index.js';
-import { BLS12Fq, BLS12Fr } from './bls12_fields.js';
-import { Fr } from './fields.js';
+import { toBufferBE } from '../../bigint-buffer/index.js';
+import { randomBoolean } from '../../crypto/random/index.js';
+import { hexSchemaFor } from '../../schemas/utils.js';
+import { BufferReader, serializeToBuffer } from '../../serialize/index.js';
+import { bufferToHex, hexToBuffer } from '../../string/index.js';
+import { Fr } from '../bn254/field.js';
+import { BLS12Fq, BLS12Fr } from './field.js';
 
 /**
  * Represents a Point on an elliptic curve with x and y coordinates.