@aztec/foundation 0.0.0-test.0

package/src/config/env_var.ts

@@ -0,0 +1,207 @@
+export type EnvVar =
+  | 'ACVM_BINARY_PATH'
+  | 'ACVM_WORKING_DIRECTORY'
+  | 'GOVERNANCE_CONTRACT_ADDRESS'
+  | 'API_KEY'
+  | 'API_PREFIX'
+  | 'ARCHIVER_MAX_LOGS'
+  | 'ARCHIVER_POLLING_INTERVAL_MS'
+  | 'ARCHIVER_URL'
+  | 'ARCHIVER_VIEM_POLLING_INTERVAL_MS'
+  | 'ARCHIVER_BATCH_SIZE'
+  | 'ASSUME_PROVEN_THROUGH_BLOCK_NUMBER'
+  | 'AZTEC_NODE_URL'
+  | 'AZTEC_PORT'
+  | 'BB_BINARY_PATH'
+  | 'BB_SKIP_CLEANUP'
+  | 'BB_WORKING_DIRECTORY'
+  | 'BOOTSTRAP_NODES'
+  | 'BLOB_SINK_ARCHIVE_API_URL'
+  | 'BLOB_SINK_PORT'
+  | 'BLOB_SINK_URL'
+  | 'BOT_DA_GAS_LIMIT'
+  | 'BOT_FEE_PAYMENT_METHOD'
+  | 'BOT_FLUSH_SETUP_TRANSACTIONS'
+  | 'BOT_FOLLOW_CHAIN'
+  | 'BOT_L2_GAS_LIMIT'
+  | 'BOT_MAX_PENDING_TXS'
+  | 'BOT_NO_START'
+  | 'BOT_NO_WAIT_FOR_TRANSFERS'
+  | 'BOT_L1_MNEMONIC'
+  | 'BOT_L1_PRIVATE_KEY'
+  | 'BOT_PRIVATE_KEY'
+  | 'BOT_PRIVATE_TRANSFERS_PER_TX'
+  | 'BOT_PUBLIC_TRANSFERS_PER_TX'
+  | 'BOT_PXE_URL'
+  | 'BOT_RECIPIENT_ENCRYPTION_SECRET'
+  | 'BOT_SKIP_PUBLIC_SIMULATION'
+  | 'BOT_TOKEN_CONTRACT'
+  | 'BOT_TOKEN_SALT'
+  | 'BOT_TX_INTERVAL_SECONDS'
+  | 'BOT_TX_MINED_WAIT_SECONDS'
+  | 'BOT_MAX_CONSECUTIVE_ERRORS'
+  | 'BOT_STOP_WHEN_UNHEALTHY'
+  | 'COINBASE'
+  | 'DATA_DIRECTORY'
+  | 'DATA_STORE_MAP_SIZE_KB'
+  | 'DEBUG'
+  | 'DEBUG_P2P_DISABLE_COLOCATION_PENALTY'
+  | 'DEPLOY_AZTEC_CONTRACTS_SALT'
+  | 'DEPLOY_AZTEC_CONTRACTS'
+  | 'ENFORCE_FEES'
+  | 'ETHEREUM_HOSTS'
+  | 'FEE_JUICE_CONTRACT_ADDRESS'
+  | 'FEE_JUICE_PORTAL_CONTRACT_ADDRESS'
+  | 'FEE_RECIPIENT'
+  | 'FORCE_COLOR'
+  | 'GOVERNANCE_PROPOSER_CONTRACT_ADDRESS'
+  | 'GOVERNANCE_PROPOSER_PAYLOAD_ADDRESS'
+  | 'INBOX_CONTRACT_ADDRESS'
+  | 'L1_CHAIN_ID'
+  | 'L1_CONSENSUS_HOST_URL'
+  | 'L1_CONSENSUS_HOST_API_KEY'
+  | 'L1_CONSENSUS_HOST_API_KEY_HEADER'
+  | 'L1_PRIVATE_KEY'
+  | 'LOG_JSON'
+  | 'LOG_MULTILINE'
+  | 'LOG_LEVEL'
+  | 'MNEMONIC'
+  | 'NETWORK_NAME'
+  | 'NETWORK'
+  | 'NO_PXE'
+  | 'COIN_ISSUER_CONTRACT_ADDRESS'
+  | 'USE_GCLOUD_LOGGING'
+  | 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT'
+  | 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'
+  | 'OTEL_EXPORTER_OTLP_LOGS_ENDPOINT'
+  | 'OTEL_COLLECT_INTERVAL_MS'
+  | 'OTEL_EXCLUDE_METRICS'
+  | 'OTEL_EXPORT_TIMEOUT_MS'
+  | 'OUTBOX_CONTRACT_ADDRESS'
+  | 'P2P_BLOCK_CHECK_INTERVAL_MS'
+  | 'P2P_BLOCK_REQUEST_BATCH_SIZE'
+  | 'P2P_BOOTSTRAP_NODE_ENR_VERSION_CHECK'
+  | 'P2P_BOOTSTRAP_NODES_AS_FULL_PEERS'
+  | 'P2P_ENABLED'
+  | 'P2P_GOSSIPSUB_D'
+  | 'P2P_GOSSIPSUB_DHI'
+  | 'P2P_GOSSIPSUB_DLO'
+  | 'P2P_GOSSIPSUB_DLAZY'
+  | 'P2P_GOSSIPSUB_FLOOD_PUBLISH'
+  | 'P2P_GOSSIPSUB_INTERVAL_MS'
+  | 'P2P_GOSSIPSUB_MCACHE_GOSSIP'
+  | 'P2P_GOSSIPSUB_MCACHE_LENGTH'
+  | 'P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_DECAY'
+  | 'P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_WEIGHT'
+  | 'P2P_GOSSIPSUB_TX_TOPIC_WEIGHT'
+  | 'P2P_L2_QUEUE_SIZE'
+  | 'P2P_MAX_PEERS'
+  | 'P2P_PEER_CHECK_INTERVAL_MS'
+  | 'P2P_PEER_PENALTY_VALUES'
+  | 'P2P_QUERY_FOR_IP'
+  | 'P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS'
+  | 'P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS'
+  | 'P2P_DOUBLE_SPEND_SEVERE_PEER_PENALTY_WINDOW'
+  | 'P2P_TCP_LISTEN_ADDR'
+  | 'P2P_TCP_ANNOUNCE_ADDR'
+  | 'P2P_TX_POOL_KEEP_PROVEN_FOR'
+  | 'P2P_ATTESTATION_POOL_KEEP_FOR'
+  | 'P2P_UDP_ANNOUNCE_ADDR'
+  | 'P2P_UDP_LISTEN_ADDR'
+  | 'P2P_ARCHIVED_TX_LIMIT'
+  | 'PEER_ID_PRIVATE_KEY'
+  | 'PROVER_AGENT_CONCURRENCY'
+  | 'PROVER_AGENT_COUNT'
+  | 'PROVER_AGENT_PROOF_TYPES'
+  | 'PROVER_AGENT_POLL_INTERVAL_MS'
+  | 'PROVER_BROKER_HOST'
+  | 'PROVER_BROKER_ENABLED'
+  | 'PROVER_BROKER_JOB_TIMEOUT_MS'
+  | 'PROVER_BROKER_POLL_INTERVAL_MS'
+  | 'PROVER_BROKER_JOB_MAX_RETRIES'
+  | 'PROVER_BROKER_BATCH_INTERVAL_MS'
+  | 'PROVER_BROKER_BATCH_SIZE'
+  | 'PROVER_BROKER_MAX_EPOCHS_TO_KEEP_RESULTS_FOR'
+  | 'PROVER_COORDINATION_NODE_URL'
+  | 'PROVER_FAILED_PROOF_STORE'
+  | 'PROVER_ID'
+  | 'PROVER_JOB_TIMEOUT_MS'
+  | 'PROVER_NODE_POLLING_INTERVAL_MS'
+  | 'PROVER_NODE_MAX_PENDING_JOBS'
+  | 'PROVER_NODE_MAX_PARALLEL_BLOCKS_PER_EPOCH'
+  | 'PROVER_NODE_TX_GATHERING_TIMEOUT_MS'
+  | 'PROVER_NODE_TX_GATHERING_INTERVAL_MS'
+  | 'PROVER_NODE_TX_GATHERING_MAX_PARALLEL_REQUESTS'
+  | 'PROVER_PUBLISH_RETRY_INTERVAL_MS'
+  | 'PROVER_PUBLISHER_PRIVATE_KEY'
+  | 'PROVER_REAL_PROOFS'
+  | 'PROVER_TEST_DELAY_FACTOR'
+  | 'PROVER_TEST_DELAY_MS'
+  | 'PROVER_TEST_DELAY_TYPE'
+  | 'PXE_L2_STARTING_BLOCK'
+  | 'PXE_PROVER_ENABLED'
+  | 'REGISTRY_CONTRACT_ADDRESS'
+  | 'ROLLUP_CONTRACT_ADDRESS'
+  | 'SEQ_ALLOWED_SETUP_FN'
+  | 'SEQ_MAX_BLOCK_SIZE_IN_BYTES'
+  | 'SEQ_MAX_TX_PER_BLOCK'
+  | 'SEQ_MIN_TX_PER_BLOCK'
+  | 'SEQ_MAX_DA_BLOCK_GAS'
+  | 'SEQ_MAX_L2_BLOCK_GAS'
+  | 'SEQ_PUBLISH_RETRY_INTERVAL_MS'
+  | 'SEQ_PUBLISHER_PRIVATE_KEY'
+  | 'SEQ_TX_POLLING_INTERVAL_MS'
+  | 'SEQ_ENFORCE_TIME_TABLE'
+  | 'SEQ_MAX_L1_TX_INCLUSION_TIME_INTO_SLOT'
+  | 'SLASH_FACTORY_CONTRACT_ADDRESS'
+  | 'STAKING_ASSET_CONTRACT_ADDRESS'
+  | 'REWARD_DISTRIBUTOR_CONTRACT_ADDRESS'
+  | 'TELEMETRY'
+  | 'TEST_ACCOUNTS'
+  | 'TX_GOSSIP_VERSION'
+  | 'TXE_PORT'
+  | 'VALIDATOR_ATTESTATIONS_POLLING_INTERVAL_MS'
+  | 'VALIDATOR_DISABLED'
+  | 'VALIDATOR_PRIVATE_KEY'
+  | 'VALIDATOR_REEXECUTE'
+  | 'VERSION'
+  | 'WS_BLOCK_CHECK_INTERVAL_MS'
+  | 'WS_PROVEN_BLOCKS_ONLY'
+  | 'WS_BLOCK_REQUEST_BATCH_SIZE'
+  | 'VERIFIER_VIEM_POLLING_INTERVAL_MS'
+  | 'L1_READER_VIEM_POLLING_INTERVAL_MS'
+  | 'PROVER_VIEM_POLLING_INTERVAL_MS'
+  | 'SEQ_VIEM_POLLING_INTERVAL_MS'
+  | 'WS_DB_MAP_SIZE_KB'
+  | 'WS_DATA_DIRECTORY'
+  | 'WS_NUM_HISTORIC_BLOCKS'
+  | 'ETHEREUM_SLOT_DURATION'
+  | 'AZTEC_SLOT_DURATION'
+  | 'AZTEC_EPOCH_DURATION'
+  | 'AZTEC_TARGET_COMMITTEE_SIZE'
+  | 'AZTEC_PROOF_SUBMISSION_WINDOW'
+  | 'AZTEC_MINIMUM_STAKE'
+  | 'AZTEC_SLASHING_QUORUM'
+  | 'AZTEC_SLASHING_ROUND_SIZE'
+  | 'AZTEC_GOVERNANCE_PROPOSER_QUORUM'
+  | 'AZTEC_GOVERNANCE_PROPOSER_ROUND_SIZE'
+  | 'L1_GAS_LIMIT_BUFFER_PERCENTAGE'
+  | 'L1_GAS_PRICE_MIN'
+  | 'L1_GAS_PRICE_MAX'
+  | 'L1_BLOB_FEE_PER_GAS_MAX'
+  | 'L1_PRIORITY_FEE_BUMP_PERCENTAGE'
+  | 'L1_PRIORITY_FEE_RETRY_BUMP_PERCENTAGE'
+  | 'L1_FIXED_PRIORITY_FEE_PER_GAS'
+  | 'L1_TX_MONITOR_MAX_ATTEMPTS'
+  | 'L1_TX_MONITOR_CHECK_INTERVAL_MS'
+  | 'L1_TX_MONITOR_STALL_TIME_MS'
+  | 'L1_TX_MONITOR_TX_TIMEOUT_MS'
+  | 'L1_TX_PROPAGATION_MAX_QUERY_ATTEMPTS'
+  | 'FAUCET_MNEMONIC_ACCOUNT_INDEX'
+  | 'FAUCET_ETH_AMOUNT'
+  | 'FAUCET_INTERVAL_MS'
+  | 'FAUCET_L1_ASSETS'
+  | 'K8S_POD_NAME'
+  | 'K8S_POD_UID'
+  | 'K8S_NAMESPACE_NAME'
+  | 'CUSTOM_FORWARDER_CONTRACT_ADDRESS';

package/src/config/index.ts

@@ -0,0 +1,167 @@
+import type { EnvVar } from './env_var.js';
+
+export { type EnvVar } from './env_var.js';
+
+export interface ConfigMapping {
+  env?: EnvVar;
+  parseEnv?: (val: string) => any;
+  defaultValue?: any;
+  printDefault?: (val: any) => string;
+  description: string;
+  isBoolean?: boolean;
+  nested?: Record<string, ConfigMapping>;
+}
+
+export function isBooleanConfigValue<T>(obj: T, key: keyof T): boolean {
+  return typeof obj[key] === 'boolean';
+}
+
+export type ConfigMappingsType<T> = Record<keyof T, ConfigMapping>;
+
+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];
+    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;
+      }
+    }
+  }
+
+  return config;
+}
+
+/**
+ * Filters out a service's config mappings to exclude certain keys.
+ * @param configMappings - The service's config mappings
+ * @param keysToFilter - The keys to filter out
+ * @returns The filtered config mappings
+ */
+export function omitConfigMappings<T, K extends keyof T>(
+  configMappings: ConfigMappingsType<T>,
+  keysToFilter: K[],
+): ConfigMappingsType<Omit<T, K>> {
+  return Object.fromEntries(
+    Object.entries(configMappings).filter(([key]) => !keysToFilter.includes(key as K)),
+  ) as ConfigMappingsType<Omit<T, K>>;
+}
+
+/**
+ * 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 numberConfigHelper(defaultVal: number): Pick<ConfigMapping, 'parseEnv' | 'defaultValue'> {
+  return {
+    parseEnv: (val: string) => safeParseNumber(val, defaultVal),
+    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
+ * @returns Object with parseEnv and default values for a numerical config value
+ */
+export function bigintConfigHelper(defaultVal?: bigint): Pick<ConfigMapping, 'parseEnv' | 'defaultValue'> {
+  return {
+    parseEnv: (val: string) => {
+      if (val === '') {
+        return defaultVal;
+      }
+      return BigInt(val);
+    },
+    defaultValue: defaultVal,
+  };
+}
+
+/**
+ * Generates parseEnv for an optional numerical config value.
+ */
+export function optionalNumberConfigHelper(): Pick<ConfigMapping, 'parseEnv'> {
+  return {
+    parseEnv: (val: string | undefined) => {
+      if (val !== undefined && val.length > 0) {
+        const parsedValue = parseInt(val);
+        return Number.isSafeInteger(parsedValue) ? parsedValue : undefined;
+      }
+      return undefined;
+    },
+  };
+}
+
+/**
+ * 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
+ * @returns Object with parseEnv and default values for a boolean config value
+ */
+export function booleanConfigHelper(
+  defaultVal = false,
+): Required<Pick<ConfigMapping, 'parseEnv' | 'defaultValue' | 'isBoolean'> & { parseVal: (val: string) => boolean }> {
+  const parse = (val: string | boolean) => (typeof val === 'boolean' ? val : parseBooleanEnv(val));
+  return {
+    parseEnv: parse,
+    parseVal: parse,
+    defaultValue: defaultVal,
+    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);
+}
+
+/**
+ * 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.
+ * @param value - The string value to parse
+ * @param defaultValue - The default value to return
+ * @returns Either parsed value or default value
+ */
+function safeParseNumber(value: string, defaultValue: number): number {
+  const parsedValue = parseInt(value, 10);
+  return Number.isSafeInteger(parsedValue) ? parsedValue : defaultValue;
+}
+
+/**
+ * Picks specific keys from the given configuration mappings.
+ *
+ * @template T - The type of the full configuration object.
+ * @template K - The keys to pick from the configuration object.
+ * @param {ConfigMappingsType<T>} configMappings - The full configuration mappings object.
+ * @param {K[]} keys - The keys to pick from the configuration mappings.
+ * @returns {ConfigMappingsType<Pick<T, K>>} - A new configuration mappings object containing only the specified keys.
+ */
+export function pickConfigMappings<T, K extends keyof T>(
+  configMappings: ConfigMappingsType<T>,
+  keys: K[],
+): ConfigMappingsType<Pick<T, K>> {
+  return Object.fromEntries(keys.map(key => [key, configMappings[key]])) as ConfigMappingsType<Pick<T, K>>;
+}
+
+/**
+ * Extracts the default configuration values from the given configuration mappings.
+ *
+ * @template T - The type of the configuration object.
+ * @param {ConfigMappingsType<T>} configMappings - The configuration mappings object.
+ * @returns {T} - The configuration object with default values.
+ */
+export function getDefaultConfig<T>(configMappings: ConfigMappingsType<T>): T {
+  const defaultConfig = {} as T;
+
+  for (const key in configMappings) {
+    if (configMappings[key] && configMappings[key].defaultValue !== undefined) {
+      (defaultConfig as any)[key] = configMappings[key].defaultValue;
+    }
+  }
+
+  return defaultConfig;
+}

package/src/crypto/aes128/index.ts

@@ -0,0 +1,59 @@
+import { BarretenbergSync, RawBuffer } from '@aztec/bb.js';
+
+import { Buffer } from 'buffer';
+
+/**
+ * AES-128-CBC encryption/decryption.
+ */
+export class Aes128 {
+  /**
+   * Encrypt a buffer using AES-128-CBC.
+   * @param data - Data to encrypt.
+   * @param iv - AES initialization vector.
+   * @param key - Key to encrypt with.
+   * @returns Encrypted data.
+   */
+  public async encryptBufferCBC(data: Uint8Array, iv: Uint8Array, key: Uint8Array) {
+    const rawLength = data.length;
+    const numPaddingBytes = 16 - (rawLength % 16);
+    const paddingBuffer = Buffer.alloc(numPaddingBytes);
+    // input num bytes needs to be a multiple of 16 and at least 1 byte
+    // node uses PKCS#7-Padding scheme, where padding byte value = the number of padding bytes
+    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),
+    );
+  }
+
+  /**
+   * Decrypt a buffer using AES-128-CBC.
+   * We keep the padding in the returned buffer.
+   * @param data - Data to decrypt.
+   * @param iv - AES initialization vector.
+   * @param key - Key to decrypt with.
+   * @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;
+  }
+
+  /**
+   * Decrypt a buffer using AES-128-CBC.
+   * @param data - Data to decrypt.
+   * @param iv - AES initialization vector.
+   * @param key - Key to decrypt with.
+   * @returns Decrypted data.
+   */
+  public async decryptBufferCBC(data: Uint8Array, iv: Uint8Array, key: Uint8Array) {
+    const paddedBuffer = await this.decryptBufferCBCKeepPadding(data, iv, key);
+    const paddingToRemove = paddedBuffer[paddedBuffer.length - 1];
+    return paddedBuffer.subarray(0, paddedBuffer.length - paddingToRemove);
+  }
+}

package/src/crypto/ecdsa/index.ts

@@ -0,0 +1,70 @@
+import { BarretenbergSync } from '@aztec/bb.js';
+import { numToInt32BE } from '@aztec/foundation/serialize';
+
+import { concatenateUint8Arrays } from '../serialize.js';
+import { EcdsaSignature } from './signature.js';
+
+export * from './signature.js';
+
+/**
+ * ECDSA signature construction and helper operations.
+ * TODO: Replace with codegen api on bb.js.
+ */
+export class Ecdsa {
+  /**
+   * Computes a secp256k1 public key from a private key.
+   * @param privateKey - Secp256k1 private key.
+   * @returns A secp256k1 public key.
+   */
+  public async computePublicKey(privateKey: Buffer): Promise<Buffer> {
+    const api = await BarretenbergSync.initSingleton(process.env.BB_WASM_PATH);
+    const [result] = api.getWasm().callWasmExport('ecdsa__compute_public_key', [privateKey], [64]);
+    return Buffer.from(result);
+  }
+
+  /**
+   * Constructs an ECDSA signature given a msg and a private key.
+   * @param msg - Message over which the signature is constructed.
+   * @param privateKey - The secp256k1 private key of the signer.
+   * @returns An ECDSA signature of the form (r, s, v).
+   */
+  public async constructSignature(msg: Uint8Array, privateKey: Buffer) {
+    const api = await BarretenbergSync.initSingleton(process.env.BB_WASM_PATH);
+    const messageArray = concatenateUint8Arrays([numToInt32BE(msg.length), msg]);
+    const [r, s, v] = api
+      .getWasm()
+      .callWasmExport('ecdsa__construct_signature_', [messageArray, privateKey], [32, 32, 1]);
+    return new EcdsaSignature(Buffer.from(r), Buffer.from(s), Buffer.from(v));
+  }
+
+  /**
+   * Recovers a secp256k1 public key from an ECDSA signature (similar to ecrecover).
+   * @param msg - Message over which the signature was constructed.
+   * @param sig - The ECDSA signature.
+   * @returns The secp256k1 public key of the signer.
+   */
+  public async recoverPublicKey(msg: Uint8Array, sig: EcdsaSignature): Promise<Buffer> {
+    const api = await BarretenbergSync.initSingleton(process.env.BB_WASM_PATH);
+    const messageArray = concatenateUint8Arrays([numToInt32BE(msg.length), msg]);
+    const [result] = api
+      .getWasm()
+      .callWasmExport('ecdsa__recover_public_key_from_signature_', [messageArray, sig.r, sig.s, sig.v], [64]);
+    return Buffer.from(result);
+  }
+
+  /**
+   * Verifies and ECDSA signature given a secp256k1 public key.
+   * @param msg - Message over which the signature was constructed.
+   * @param pubKey - The secp256k1 public key of the signer.
+   * @param sig - The ECDSA signature.
+   * @returns True or false.
+   */
+  public async verifySignature(msg: Uint8Array, pubKey: Buffer, sig: EcdsaSignature) {
+    const api = await BarretenbergSync.initSingleton(process.env.BB_WASM_PATH);
+    const messageArray = concatenateUint8Arrays([numToInt32BE(msg.length), msg]);
+    const [result] = api
+      .getWasm()
+      .callWasmExport('ecdsa__verify_signature_', [messageArray, pubKey, sig.r, sig.s, sig.v], [1]);
+    return result[0] === 1;
+  }
+}

package/src/crypto/ecdsa/signature.ts

@@ -0,0 +1,100 @@
+import { toBufferBE } from '@aztec/foundation/bigint-buffer';
+import { randomBytes } from '@aztec/foundation/crypto';
+import { Fr } from '@aztec/foundation/fields';
+import { mapTuple } from '@aztec/foundation/serialize';
+
+import type { Signature } from '../signature/index.js';
+
+/**
+ * ECDSA signature used for transactions.
+ * @see cpp/barretenberg/cpp/src/barretenberg/crypto/ecdsa/ecdsa.hpp
+ */
+export class EcdsaSignature implements Signature {
+  constructor(
+    /**
+     * The r byte-array (32 bytes) in an ECDSA signature.
+     */
+    public r: Buffer,
+    /**
+     * The s byte-array (32 bytes) in an ECDSA signature.
+     */
+    public s: Buffer,
+    /**
+     * The recovery id (1 byte) in an ECDSA signature.
+     */
+    public v: Buffer,
+  ) {
+    if (r.length != 32) {
+      throw new Error(`Invalid length of 'r' in ECDSA signature. Expected 32, got ${s.length}`);
+    }
+    if (s.length != 32) {
+      throw new Error(`Invalid length of 's' in ECDSA signature. Expected 32, got ${r.length}`);
+    }
+    if (v.length != 1) {
+      throw new Error(`Invalid length of 'v' in ECDSA signature. Expected 1, got ${v.length}`);
+    }
+  }
+
+  /**
+   * Converts an ECDSA signature to a buffer.
+   * @returns A buffer.
+   */
+  toBuffer() {
+    return Buffer.concat([this.r, this.s, this.v]);
+  }
+
+  /**
+   * Deserializes the signature from a buffer.
+   * @param buffer - The buffer from which to deserialize the signature.
+   * @returns The ECDSA signature
+   */
+  public static fromBuffer(buffer: Buffer) {
+    return new EcdsaSignature(buffer.subarray(0, 32), buffer.subarray(32, 64), buffer.subarray(64, 65));
+  }
+
+  /**
+   * Creates a new instance from bigint r and s values.
+   * @param r - r.
+   * @param s - s.
+   * @param v - v.
+   * @returns The resulting signature.
+   */
+  public static fromBigInts(r: bigint, s: bigint, v: number) {
+    return new EcdsaSignature(toBufferBE(r, 32), toBufferBE(s, 32), Buffer.from([v]));
+  }
+
+  /**
+   * Generate a random ECDSA signature for testing.
+   * @returns A randomly generated ECDSA signature (not a valid one).
+   */
+  public static random() {
+    return new EcdsaSignature(randomBytes(32), randomBytes(32), Buffer.from([27]));
+  }
+
+  /**
+   * Convert an ECDSA signature to a buffer.
+   * @returns A 65-character string of the form 0x<r><s><v>.
+   */
+  toString() {
+    return `0x${this.toBuffer().toString('hex')}`;
+  }
+
+  /**
+   * Converts the signature to an array of fields.
+   * @param includeV - Determines whether the 'v' term is included
+   * @returns The signature components as an array of fields
+   */
+  toFields(includeV = false): Fr[] {
+    const sig = this.toBuffer();
+
+    const buf1 = Buffer.alloc(32);
+    const buf2 = Buffer.alloc(32);
+    const buf3 = Buffer.alloc(32);
+
+    sig.copy(buf1, 1, 0, 31);
+    sig.copy(buf2, 1, 31, 62);
+    sig.copy(buf3, 1, 62, includeV ? 65 : 64);
+
+    return mapTuple([buf1, buf2, buf3], Fr.fromBuffer);
+  }
+}