@aztec/foundation 0.55.1 → 0.57.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/foundation",
-  "version": "0.55.1",
+  "version": "0.57.0",
   "packageManager": "yarn@3.4.1",
   "type": "module",
   "main": "./dest/index.js",
@@ -15,8 +15,10 @@
     "./collection": "./dest/collection/index.js",
     "./config": "./dest/config/index.js",
     "./crypto": "./dest/crypto/index.js",
+    "./decorators": "./dest/decorators/index.js",
     "./error": "./dest/error/index.js",
     "./eth-address": "./dest/eth-address/index.js",
+    "./eth-signature": "./dest/eth-signature/index.js",
     "./queue": "./dest/queue/index.js",
     "./fs": "./dest/fs/index.js",
     "./buffer": "./dest/buffer/index.js",
@@ -67,6 +69,9 @@
             "parser": {
               "syntax": "typescript",
               "decorators": true
+            },
+            "transform": {
+              "decoratorVersion": "2022-03"
             }
           }
         }
@@ -90,7 +95,7 @@
     ]
   },
   "dependencies": {
-    "@aztec/bb.js": "0.55.1",
+    "@aztec/bb.js": "0.57.0",
     "@koa/cors": "^5.0.0",
     "@noble/curves": "^1.2.0",
     "bn.js": "^5.2.1",
@@ -144,7 +149,8 @@
     "prettier": "^2.7.1",
     "supertest": "^6.3.3",
     "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "typescript": "^5.0.4",
+    "viem": "^2.7.15"
   },
   "files": [
     "dest",

package/src/abi/abi.ts

@@ -309,6 +309,20 @@ export type ContractNote = {
    * Type of the note (e.g., 'TransparentNote')
    */
   typ: string;
+  /**
+   * Fields of the note.
+   */
+  fields: NoteField[];
+};
+
+/** Type representing a field of a note (e.g. `amount` in `TokenNote`). */
+export type NoteField = {
+  /** Name of the field (e.g. `amount`). */
+  name: string;
+  /** Index where the note field starts in the serialized note array. */
+  index: number;
+  /** Whether the field can be unset when creating the note (in the partial notes flow). */
+  nullable: boolean;
 };
 
 /**

package/src/abi/decoder.ts

@@ -6,21 +6,21 @@ import { isAztecAddressStruct } from './utils.js';
 /**
  * The type of our decoded ABI.
  */
-export type DecodedReturn = bigint | boolean | AztecAddress | DecodedReturn[] | { [key: string]: DecodedReturn };
+export type AbiDecoded = bigint | boolean | AztecAddress | AbiDecoded[] | { [key: string]: AbiDecoded };
 
 /**
- * Decodes return values from a function call.
- * Missing support for integer and string.
+ * Decodes values using a provided ABI.
+ * Missing support for signed integer.
  */
-class ReturnValuesDecoder {
-  constructor(private returnTypes: AbiType[], private flattened: Fr[]) {}
+class AbiDecoder {
+  constructor(private types: AbiType[], private flattened: Fr[]) {}
 
   /**
    * Decodes a single return value from field to the given type.
    * @param abiType - The type of the return value.
    * @returns The decoded return value.
    */
-  private decodeReturn(abiType: AbiType): DecodedReturn {
+  private decodeNext(abiType: AbiType): AbiDecoded {
     switch (abiType.kind) {
       case 'field':
         return this.getNextField().toBigInt();
@@ -34,18 +34,18 @@ class ReturnValuesDecoder {
       case 'array': {
         const array = [];
         for (let i = 0; i < abiType.length; i += 1) {
-          array.push(this.decodeReturn(abiType.type));
+          array.push(this.decodeNext(abiType.type));
         }
         return array;
       }
       case 'struct': {
-        const struct: { [key: string]: DecodedReturn } = {};
+        const struct: { [key: string]: AbiDecoded } = {};
         if (isAztecAddressStruct(abiType)) {
           return new AztecAddress(this.getNextField().toBuffer());
         }
 
         for (const field of abiType.fields) {
-          struct[field.name] = this.decodeReturn(field.type);
+          struct[field.name] = this.decodeNext(field.type);
         }
         return struct;
       }
@@ -59,7 +59,7 @@ class ReturnValuesDecoder {
       case 'tuple': {
         const array = [];
         for (const tupleAbiType of abiType.fields) {
-          array.push(this.decodeReturn(tupleAbiType));
+          array.push(this.decodeNext(tupleAbiType));
         }
         return array;
       }
@@ -69,8 +69,8 @@ class ReturnValuesDecoder {
   }
 
   /**
-   * Gets the next field in the flattened return values.
-   * @returns The next field in the flattened return values.
+   * Gets the next field in the flattened buffer.
+   * @returns The next field in the flattened buffer.
    */
   private getNextField(): Fr {
     const field = this.flattened.shift();
@@ -81,30 +81,29 @@ class ReturnValuesDecoder {
   }
 
   /**
-   * Decodes all the return values for the given function ABI.
-   * Aztec.nr support only single return value
-   * The return value can however be simple types, structs or arrays
+   * Decodes all the values for the given ABI.
+   * The decided value can be simple types, structs or arrays
    * @returns The decoded return values.
    */
-  public decode(): DecodedReturn {
-    if (this.returnTypes.length > 1) {
-      throw new Error('Multiple return values not supported');
+  public decode(): AbiDecoded {
+    if (this.types.length > 1) {
+      throw new Error('Multiple types not supported');
     }
-    if (this.returnTypes.length === 0) {
+    if (this.types.length === 0) {
       return [];
     }
-    return this.decodeReturn(this.returnTypes[0]);
+    return this.decodeNext(this.types[0]);
   }
 }
 
 /**
- * Decodes return values from a function call.
- * @param abi - The ABI entry of the function.
- * @param returnValues - The decoded return values.
+ * Decodes values in a flattened Field array using a provided ABI.
+ * @param abi - The ABI to use as reference.
+ * @param buffer - The flattened Field array to decode.
  * @returns
  */
-export function decodeReturnValues(returnTypes: AbiType[], returnValues: Fr[]) {
-  return new ReturnValuesDecoder(returnTypes, returnValues.slice()).decode();
+export function decodeFromAbi(typ: AbiType[], buffer: Fr[]) {
+  return new AbiDecoder(typ, buffer.slice()).decode();
 }
 
 /**

package/src/buffer/buffer32.ts

@@ -112,7 +112,25 @@ export class Buffer32 {
    * @param str - The TX hash in string format.
    * @returns A new Buffer32 object.
    */
+  public static fromStringUnchecked(str: string): Buffer32 {
+    return new Buffer32(Buffer.from(str, 'hex'));
+  }
+
+  /**
+   * Converts a string into a Buffer32 object.
+   * NOTE: this method includes checks for the 0x prefix and the length of the string.
+   *       if you dont need this checks, use fromStringUnchecked instead.
+   *
+   * @param str - The TX hash in string format.
+   * @returns A new Buffer32 object.
+   */
   public static fromString(str: string): Buffer32 {
+    if (str.startsWith('0x')) {
+      str = str.slice(2);
+    }
+    if (str.length !== 64) {
+      throw new Error(`Expected string to be 64 characters long, but was ${str.length}`);
+    }
     return new Buffer32(Buffer.from(str, 'hex'));
   }
 

package/src/collection/array.ts

@@ -100,3 +100,18 @@ export function unique<T>(arr: T[]): T[] {
 export function compactArray<T>(arr: (T | undefined)[]): T[] {
   return arr.filter((x: T | undefined): x is T => x !== undefined);
 }
+
+/**
+ * Returns whether two arrays are equal. The arrays are equal if they have the same length and all elements are equal.
+ */
+export function areArraysEqual<T>(a: T[], b: T[], eq: (a: T, b: T) => boolean = (a: T, b: T) => a === b): boolean {
+  if (a.length !== b.length) {
+    return false;
+  }
+  for (let i = 0; i < a.length; i++) {
+    if (!eq(a[i], b[i])) {
+      return false;
+    }
+  }
+  return true;
+}

package/src/config/env_var.ts

@@ -1,132 +1,141 @@
 export type EnvVar =
+  | 'ACVM_BINARY_PATH'
+  | 'ACVM_WORKING_DIRECTORY'
+  | 'API_KEY'
+  | 'API_PREFIX'
+  | 'ARCHIVER_MAX_LOGS'
+  | 'ARCHIVER_POLLING_INTERVAL_MS'
+  | 'ARCHIVER_URL'
+  | 'ARCHIVER_VIEM_POLLING_INTERVAL_MS'
+  | 'ASSUME_PROVEN_THROUGH_BLOCK_NUMBER'
+  | 'AZTEC_NODE_URL'
   | 'AZTEC_PORT'
-  | 'ASSUME_PROVEN_UNTIL_BLOCK_NUMBER'
-  | 'TEST_ACCOUNTS'
+  | 'BB_BINARY_PATH'
+  | 'BB_SKIP_CLEANUP'
+  | 'BB_WORKING_DIRECTORY'
+  | 'BOOTSTRAP_NODES'
+  | '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_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'
+  | 'COINBASE'
+  | 'DATA_DIRECTORY'
+  | 'DEBUG'
+  | 'DEPLOY_AZTEC_CONTRACTS_SALT'
+  | 'DEPLOY_AZTEC_CONTRACTS'
   | 'ENABLE_GAS'
-  | 'API_PREFIX'
+  | 'ENFORCE_FEES'
   | 'ETHEREUM_HOST'
-  | 'L1_CHAIN_ID'
-  | 'MNEMONIC'
-  | 'ROLLUP_CONTRACT_ADDRESS'
-  | 'REGISTRY_CONTRACT_ADDRESS'
-  | 'INBOX_CONTRACT_ADDRESS'
-  | 'OUTBOX_CONTRACT_ADDRESS'
   | 'FEE_JUICE_CONTRACT_ADDRESS'
   | 'FEE_JUICE_PORTAL_CONTRACT_ADDRESS'
-  | 'ARCHIVER_URL'
-  | 'DEPLOY_AZTEC_CONTRACTS'
-  | 'DEPLOY_AZTEC_CONTRACTS_SALT'
+  | 'FEE_RECIPIENT'
+  | 'INBOX_CONTRACT_ADDRESS'
+  | 'L1_CHAIN_ID'
   | 'L1_PRIVATE_KEY'
   | 'L2_QUEUE_SIZE'
-  | 'WS_BLOCK_CHECK_INTERVAL_MS'
-  | 'P2P_ENABLED'
+  | 'LOG_JSON'
+  | 'LOG_LEVEL'
+  | 'MNEMONIC'
+  | 'NETWORK_NAME'
+  | 'NETWORK'
+  | 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT'
+  | 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'
+  | 'OTEL_SERVICE_NAME'
+  | 'OUTBOX_CONTRACT_ADDRESS'
   | 'P2P_BLOCK_CHECK_INTERVAL_MS'
-  | 'P2P_PEER_CHECK_INTERVAL_MS'
-  | 'P2P_L2_QUEUE_SIZE'
-  | 'TCP_LISTEN_ADDR'
-  | 'UDP_LISTEN_ADDR'
-  | 'P2P_TCP_ANNOUNCE_ADDR'
-  | 'P2P_UDP_ANNOUNCE_ADDR'
-  | 'PEER_ID_PRIVATE_KEY'
-  | 'BOOTSTRAP_NODES'
-  | 'P2P_TX_PROTOCOL'
-  | 'P2P_MIN_PEERS'
-  | 'P2P_MAX_PEERS'
-  | 'DATA_DIRECTORY'
-  | 'TX_GOSSIP_VERSION'
-  | 'P2P_QUERY_FOR_IP'
-  | 'P2P_TX_POOL_KEEP_PROVEN_FOR'
-  | 'P2P_GOSSIPSUB_INTERVAL_MS'
+  | 'P2P_ENABLED'
   | 'P2P_GOSSIPSUB_D'
-  | 'P2P_GOSSIPSUB_DLO'
   | 'P2P_GOSSIPSUB_DHI'
-  | 'P2P_GOSSIPSUB_MCACHE_LENGTH'
+  | 'P2P_GOSSIPSUB_DLO'
+  | 'P2P_GOSSIPSUB_INTERVAL_MS'
   | 'P2P_GOSSIPSUB_MCACHE_GOSSIP'
-  | 'P2P_SEVERE_PEER_PENALTY_BLOCK_LENGTH'
-  | 'P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS'
-  | 'P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS'
-  | 'P2P_GOSSIPSUB_TX_TOPIC_WEIGHT'
-  | 'P2P_GOSSIPSUB_TX_INVALID_MESSAGE_DELIVERIES_WEIGHT'
+  | '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_MIN_PEERS'
+  | 'P2P_PEER_CHECK_INTERVAL_MS'
   | 'P2P_PEER_PENALTY_VALUES'
-  | 'TELEMETRY'
-  | 'OTEL_SERVICE_NAME'
-  | 'OTEL_EXPORTER_OTLP_METRICS_ENDPOINT'
-  | 'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'
-  | 'NETWORK_NAME'
-  | 'NETWORK'
-  | 'API_KEY'
-  | 'AZTEC_NODE_URL'
-  | 'ARCHIVER_POLLING_INTERVAL_MS'
-  | 'ARCHIVER_VIEM_POLLING_INTERVAL_MS'
-  | 'ARCHIVER_MAX_LOGS'
-  | 'SEQ_TX_POLLING_INTERVAL_MS'
-  | 'SEQ_MAX_TX_PER_BLOCK'
-  | 'SEQ_MIN_TX_PER_BLOCK'
-  | 'SEQ_MIN_SECONDS_BETWEEN_BLOCKS'
-  | 'SEQ_MAX_SECONDS_BETWEEN_BLOCKS'
-  | 'COINBASE'
-  | 'FEE_RECIPIENT'
-  | 'ACVM_WORKING_DIRECTORY'
-  | 'ACVM_BINARY_PATH'
-  | 'SEQ_ALLOWED_SETUP_FN'
-  | 'SEQ_ALLOWED_TEARDOWN_FN'
-  | 'SEQ_MAX_BLOCK_SIZE_IN_BYTES'
-  | 'ENFORCE_FEES'
-  | 'SEQ_PUBLISHER_PRIVATE_KEY'
-  | 'SEQ_REQUIRED_CONFIRMATIONS'
-  | 'SEQ_PUBLISH_RETRY_INTERVAL_MS'
-  | 'VERSION'
-  | 'SEQ_DISABLED'
-  | 'PROVER_DISABLED'
-  | 'PROVER_REAL_PROOFS'
+  | 'P2P_QUERY_FOR_IP'
+  | 'P2P_REQRESP_INDIVIDUAL_REQUEST_TIMEOUT_MS'
+  | 'P2P_REQRESP_OVERALL_REQUEST_TIMEOUT_MS'
+  | 'P2P_SEVERE_PEER_PENALTY_BLOCK_LENGTH'
+  | 'P2P_TCP_ANNOUNCE_ADDR'
+  | 'P2P_TX_POOL_KEEP_PROVEN_FOR'
+  | 'P2P_TX_PROTOCOL'
+  | 'P2P_UDP_ANNOUNCE_ADDR'
+  | 'PEER_ID_PRIVATE_KEY'
+  | 'PROOF_VERIFIER_L1_START_BLOCK'
+  | 'PROOF_VERIFIER_POLL_INTERVAL_MS'
+  | 'PROVER_AGENT_CONCURRENCY'
   | 'PROVER_AGENT_ENABLED'
   | 'PROVER_AGENT_POLL_INTERVAL_MS'
-  | 'PROVER_AGENT_CONCURRENCY'
-  | 'PROVER_JOB_TIMEOUT_MS'
-  | 'PROVER_JOB_POLL_INTERVAL_MS'
+  | 'PROVER_COORDINATION_NODE_URL'
+  | 'PROVER_DISABLED'
   | 'PROVER_ID'
-  | 'WS_L2_BLOCK_QUEUE_SIZE'
-  | 'WS_PROVEN_BLOCKS_ONLY'
+  | 'PROVER_JOB_POLL_INTERVAL_MS'
+  | 'PROVER_JOB_TIMEOUT_MS'
+  | 'PROVER_NODE_POLLING_INTERVAL_MS'
+  | 'PROVER_NODE_MAX_PENDING_JOBS'
   | 'PROVER_PUBLISH_RETRY_INTERVAL_MS'
   | 'PROVER_PUBLISHER_PRIVATE_KEY'
+  | 'PROVER_REAL_PROOFS'
   | 'PROVER_REQUIRED_CONFIRMATIONS'
   | 'PROVER_TEST_DELAY_MS'
-  | 'TX_PROVIDER_NODE_URL'
-  | 'TXE_PORT'
-  | 'LOG_JSON'
-  | 'BOT_PXE_URL'
-  | 'BOT_PRIVATE_KEY'
-  | 'BOT_RECIPIENT_ENCRYPTION_SECRET'
-  | 'BOT_TOKEN_SALT'
-  | 'BOT_TX_INTERVAL_SECONDS'
-  | 'BOT_PRIVATE_TRANSFERS_PER_TX'
-  | 'BOT_PUBLIC_TRANSFERS_PER_TX'
-  | 'BOT_FEE_PAYMENT_METHOD'
-  | 'BOT_NO_START'
-  | 'BOT_TX_MINED_WAIT_SECONDS'
-  | 'BOT_NO_WAIT_FOR_TRANSFERS'
-  | 'BOT_MAX_PENDING_TXS'
-  | 'BOT_SKIP_PUBLIC_SIMULATION'
-  | 'BOT_L2_GAS_LIMIT'
-  | 'BOT_DA_GAS_LIMIT'
   | 'PXE_BLOCK_POLLING_INTERVAL_MS'
-  | 'PXE_L2_STARTING_BLOCK'
   | 'PXE_DATA_DIRECTORY'
-  | 'BB_BINARY_PATH'
-  | 'BB_WORKING_DIRECTORY'
-  | 'BB_SKIP_CLEANUP'
+  | 'PXE_L2_STARTING_BLOCK'
   | 'PXE_PROVER_ENABLED'
-  | 'BOT_FOLLOW_CHAIN'
-  | 'BOT_FLUSH_SETUP_TRANSACTIONS'
-  | 'BOT_TOKEN_CONTRACT'
-  | 'VALIDATOR_PRIVATE_KEY'
-  | 'VALIDATOR_DISABLED'
-  | 'VALIDATOR_ATTESTATIONS_WAIT_TIMEOUT_MS'
+  | 'QUOTE_PROVIDER_BASIS_POINT_FEE'
+  | 'QUOTE_PROVIDER_BOND_AMOUNT'
+  | 'QUOTE_PROVIDER_URL'
+  | 'PROVER_TARGET_STAKE_AMOUNT'
+  | 'PROVER_MINIMUM_STAKE_AMOUNT'
+  | 'REGISTRY_CONTRACT_ADDRESS'
+  | 'ROLLUP_CONTRACT_ADDRESS'
+  | 'SEQ_ALLOWED_SETUP_FN'
+  | 'SEQ_ALLOWED_TEARDOWN_FN'
+  | 'SEQ_DISABLED'
+  | 'SEQ_MAX_BLOCK_SIZE_IN_BYTES'
+  | 'SEQ_MAX_SECONDS_BETWEEN_BLOCKS'
+  | 'SEQ_MAX_TX_PER_BLOCK'
+  | 'SEQ_MIN_SECONDS_BETWEEN_BLOCKS'
+  | 'SEQ_MIN_TX_PER_BLOCK'
+  | 'SEQ_PUBLISH_RETRY_INTERVAL_MS'
+  | 'SEQ_PUBLISHER_PRIVATE_KEY'
+  | 'SEQ_REQUIRED_CONFIRMATIONS'
+  | 'SEQ_TX_POLLING_INTERVAL_MS'
+  | 'TCP_LISTEN_ADDR'
+  | 'TELEMETRY'
+  | 'TEST_ACCOUNTS'
+  | 'TX_GOSSIP_VERSION'
+  | 'TXE_PORT'
+  | 'UDP_LISTEN_ADDR'
   | 'VALIDATOR_ATTESTATIONS_POOLING_INTERVAL_MS'
-  | 'PROVER_NODE_DISABLE_AUTOMATIC_PROVING'
-  | 'PROVER_NODE_MAX_PENDING_JOBS'
-  | 'PROOF_VERIFIER_POLL_INTERVAL_MS'
-  | 'PROOF_VERIFIER_L1_START_BLOCK'
-  | 'LOG_LEVEL'
-  | 'DEBUG';
+  | 'VALIDATOR_ATTESTATIONS_WAIT_TIMEOUT_MS'
+  | 'VALIDATOR_DISABLED'
+  | 'VALIDATOR_PRIVATE_KEY'
+  | 'VERSION'
+  | 'WS_BLOCK_CHECK_INTERVAL_MS'
+  | 'WS_L2_BLOCK_QUEUE_SIZE'
+  | 'WS_PROVEN_BLOCKS_ONLY'
+  | 'VERIFIER_VIEM_POLLING_INTERVAL_MS'
+  | 'L1_READER_VIEM_POLLING_INTERVAL_MS'
+  | 'PROVER_VIEM_POLLING_INTERVAL_MS'
+  | 'SEQ_VIEM_POLLING_INTERVAL_MS';

package/src/config/index.ts

@@ -67,6 +67,18 @@ 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 bigintConfigHelper(defaultVal?: bigint): Pick<ConfigMapping, 'parseEnv' | 'defaultValue'> {
+  return {
+    parseEnv: (val: string) => BigInt(val),
+    defaultValue: defaultVal,
+  };
+}
+
 /**
  * Generates parseEnv for an optional numerical config value.
  */

package/src/crypto/index.ts

@@ -6,6 +6,7 @@ export * from './sha256/index.js';
 export * from './sha512/index.js';
 export * from './pedersen/index.js';
 export * from './poseidon/index.js';
+export * from './secp256k1-signer/index.js';
 
 /**
  * Init the bb singleton. This constructs (if not already) the barretenberg sync api within bb.js itself.

package/src/crypto/keccak/index.ts

@@ -1,12 +1,17 @@
 import { Keccak } from 'sha3';
 
+import { Buffer32 } from '../../buffer/buffer32.js';
+
 /**
  * Computes the Keccak-256 hash of the given input buffer.
  *
  * @param input - The input buffer to be hashed.
  * @returns The computed Keccak-256 hash as a Buffer.
  */
-export function keccak256(input: Buffer) {
+export function keccak256(input: Buffer | Buffer32) {
+  if (input instanceof Buffer32) {
+    input = input.buffer;
+  }
   const hash = new Keccak(256);
   return hash.update(input).digest();
 }

package/src/crypto/secp256k1-signer/index.ts

@@ -0,0 +1,2 @@
+export * from './secp256k1_signer.js';
+export * from './utils.js';

package/src/crypto/secp256k1-signer/secp256k1_signer.ts

@@ -0,0 +1,38 @@
+import { Buffer32 } from '@aztec/foundation/buffer';
+import { type EthAddress } from '@aztec/foundation/eth-address';
+import { type Signature } from '@aztec/foundation/eth-signature';
+
+import { addressFromPrivateKey, makeEthSignDigest, signMessage } from './utils.js';
+
+/**
+ * Secp256k1Signer
+ *
+ * A class for signing messages using a secp256k1 private key.
+ * - This is a slim drop in replacement for an Ethereum signer, so it can be used in the same way.
+ * - See `utils.ts` for functions that enable recovering addresses and public keys from signatures.
+ */
+export class Secp256k1Signer {
+  public readonly address: EthAddress;
+
+  constructor(private privateKey: Buffer32) {
+    this.address = addressFromPrivateKey(privateKey.buffer);
+  }
+
+  sign(message: Buffer32): Signature {
+    return signMessage(message, this.privateKey.buffer);
+  }
+
+  /**
+   * Sign a message using the same method as eth_sign
+   * @param message - The message to sign.
+   * @returns The signature.
+   */
+  signMessage(message: Buffer32): Signature {
+    const digest = makeEthSignDigest(message);
+    return this.sign(digest);
+  }
+
+  static random(): Secp256k1Signer {
+    return new Secp256k1Signer(Buffer32.random());
+  }
+}

package/src/crypto/secp256k1-signer/utils.ts

@@ -0,0 +1,99 @@
+import { secp256k1 } from '@noble/curves/secp256k1';
+
+import { Buffer32 } from '../../buffer/buffer32.js';
+import { EthAddress } from '../../eth-address/index.js';
+import { Signature } from '../../eth-signature/eth_signature.js';
+import { keccak256 } from '../keccak/index.js';
+
+const ETH_SIGN_PREFIX = '\x19Ethereum Signed Message:\n32';
+
+// We just hash the message to make it easier to work with in the smart contract.
+export function makeEthSignDigest(message: Buffer32): Buffer32 {
+  const prefix = Buffer.from(ETH_SIGN_PREFIX);
+  return Buffer32.fromBuffer(keccak256(Buffer.concat([prefix, message.buffer])));
+}
+
+/**
+ * Converts a public key to an address.
+ * @param publicKey - The public key to convert.
+ * @returns The address.
+ */
+function publicKeyToAddress(publicKey: Buffer): EthAddress {
+  const hash = keccak256(publicKey.subarray(1));
+  return new EthAddress(hash.subarray(12));
+}
+
+/**
+ * Converts a private key to a public key.
+ * @param privateKey - The private key to convert.
+ * @returns The public key.
+ */
+export function publicKeyFromPrivateKey(privateKey: Buffer): Buffer {
+  return Buffer.from(secp256k1.getPublicKey(privateKey, false));
+}
+
+/**
+ * Converts a private key to an address.
+ * @param privateKey - The private key to convert.
+ * @returns The address.
+ */
+export function addressFromPrivateKey(privateKey: Buffer): EthAddress {
+  const publicKey = publicKeyFromPrivateKey(privateKey);
+  return publicKeyToAddress(publicKey);
+}
+
+/**
+ * Recovers an address from a hash and a signature.
+ * @param hash - The hash to recover the address from.
+ * @param signature - The signature to recover the address from.
+ * @returns The address.
+ */
+export function recoverAddress(hash: Buffer32, signature: Signature): EthAddress {
+  const publicKey = recoverPublicKey(hash, signature);
+  return publicKeyToAddress(publicKey);
+}
+
+/**
+ * @attribution - viem
+ * Converts a yParityOrV value to a recovery bit.
+ * @param yParityOrV - The yParityOrV value to convert.
+ * @returns The recovery bit.
+ */
+function toRecoveryBit(yParityOrV: number) {
+  if (yParityOrV === 0 || yParityOrV === 1) {
+    return yParityOrV;
+  }
+  if (yParityOrV === 27) {
+    return 0;
+  }
+  if (yParityOrV === 28) {
+    return 1;
+  }
+  throw new Error('Invalid yParityOrV value');
+}
+
+/**
+ * Signs a message using ecdsa over the secp256k1 curve.
+ * @param message - The message to sign.
+ * @param privateKey - The private key to sign the message with.
+ * @returns The signature.
+ */
+export function signMessage(message: Buffer32, privateKey: Buffer) {
+  const { r, s, recovery } = secp256k1.sign(message.buffer, privateKey);
+  return new Signature(Buffer32.fromBigInt(r), Buffer32.fromBigInt(s), recovery ? 28 : 27);
+}
+
+/**
+ * Recovers a public key from a hash and a signature.
+ * @param hash - The hash to recover the public key from.
+ * @param signature - The signature to recover the public key from.
+ * @returns The public key.
+ */
+export function recoverPublicKey(hash: Buffer32, signature: Signature): Buffer {
+  const { r, s, v } = signature;
+  const recoveryBit = toRecoveryBit(v);
+  const sig = new secp256k1.Signature(r.toBigInt(), s.toBigInt()).addRecoveryBit(recoveryBit);
+
+  const publicKey = sig.recoverPublicKey(hash.buffer).toHex(false);
+  return Buffer.from(publicKey, 'hex');
+}