@aztec/foundation 0.1.0-alpha22 → 0.1.0-alpha24

package/src/abi/decoder.ts

@@ -0,0 +1,79 @@
+import { ABIType, FunctionAbi } from '@aztec/foundation/abi';
+import { Fr } from '@aztec/foundation/fields';
+
+/**
+ * The type of our decoded ABI.
+ */
+type DecodedReturn = bigint | boolean | DecodedReturn[] | { [key: string]: DecodedReturn };
+
+/**
+ * Decodes return values from a function call.
+ * Missing support for integer and string.
+ */
+class ReturnValuesDecoder {
+  constructor(private abi: FunctionAbi, 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 {
+    switch (abiType.kind) {
+      case 'field':
+        return this.getNextField().value;
+      case 'boolean':
+        return !this.getNextField().isZero();
+      case 'array': {
+        const array = [];
+        for (let i = 0; i < abiType.length; i += 1) {
+          array.push(this.decodeReturn(abiType.type));
+        }
+        return array;
+      }
+      case 'struct': {
+        const struct: { [key: string]: DecodedReturn } = {};
+        for (const field of abiType.fields) {
+          struct[field.name] = this.decodeReturn(field.type);
+        }
+        return struct;
+      }
+      default:
+        throw new Error(`Unsupported type: ${abiType.kind}`);
+    }
+  }
+
+  /**
+   * Gets the next field in the flattened return values.
+   * @returns The next field in the flattened return values.
+   */
+  private getNextField(): Fr {
+    const field = this.flattened.shift();
+    if (!field) {
+      throw new Error('Not enough return values');
+    }
+    return field;
+  }
+
+  /**
+   * Decodes all the return values for the given function ABI.
+   * @returns The decoded return values.
+   */
+  public decode() {
+    const returnValues = [];
+    for (let i = 0; i < this.abi.returnTypes.length; i += 1) {
+      returnValues.push(this.decodeReturn(this.abi.returnTypes[i]));
+    }
+    return returnValues;
+  }
+}
+
+/**
+ * Decodes return values from a function call.
+ * @param abi - The ABI entry of the function.
+ * @param returnValues - The decoded return values.
+ * @returns
+ */
+export function decodeReturnValues(abi: FunctionAbi, returnValues: Fr[]) {
+  return new ReturnValuesDecoder(abi, returnValues.slice()).decode();
+}

package/src/abi/encoder.ts

@@ -0,0 +1,79 @@
+import { ABIType, FunctionAbi } from '@aztec/foundation/abi';
+import { Fr } from '@aztec/foundation/fields';
+
+/**
+ * Encodes arguments for a function call.
+ * Missing support for integer and string.
+ */
+class ArgumentEncoder {
+  private flattened: Fr[] = [];
+
+  constructor(private abi: FunctionAbi, private args: any[]) {}
+
+  /**
+   * Encodes a single argument from the given type to field.
+   * @param abiType - The abi type of the argument.
+   * @param arg - The value to encode.
+   * @param name - Name.
+   */
+  private encodeArgument(abiType: ABIType, arg: any, name?: string) {
+    if (arg === undefined || arg == null) {
+      throw new Error(`Undefined argument ${name ?? 'unnamed'} of type ${abiType.kind}`);
+    }
+    switch (abiType.kind) {
+      case 'field':
+        if (typeof arg === 'number') {
+          this.flattened.push(new Fr(BigInt(arg)));
+        } else if (typeof arg === 'bigint') {
+          this.flattened.push(new Fr(arg));
+        } else if (typeof arg === 'object') {
+          if (typeof arg.toField === 'function') {
+            this.flattened.push(arg.toField());
+          } else {
+            this.flattened.push(arg);
+          }
+        }
+        break;
+      case 'boolean':
+        this.flattened.push(new Fr(arg ? 1n : 0n));
+        break;
+      case 'array':
+        for (let i = 0; i < abiType.length; i += 1) {
+          this.encodeArgument(abiType.type, arg[i], `${name}[${i}]`);
+        }
+        break;
+      case 'struct':
+        for (const field of abiType.fields) {
+          this.encodeArgument(field.type, arg[field.name], `${name}.${field.name}`);
+        }
+        break;
+      case 'integer':
+        this.flattened.push(new Fr(arg));
+        break;
+      default:
+        throw new Error(`Unsupported type: ${abiType.kind}`);
+    }
+  }
+
+  /**
+   * Encodes all the arguments for the given function ABI.
+   * @returns The encoded arguments.
+   */
+  public encode() {
+    for (let i = 0; i < this.abi.parameters.length; i += 1) {
+      const parameterAbi = this.abi.parameters[i];
+      this.encodeArgument(parameterAbi.type, this.args[i], parameterAbi.name);
+    }
+    return this.flattened;
+  }
+}
+
+/**
+ * Encodes all the arguments for a function call.
+ * @param abi - The function ABI entry.
+ * @param args - The arguments to encode.
+ * @returns The encoded arguments.
+ */
+export function encodeArguments(abi: FunctionAbi, args: any[]) {
+  return new ArgumentEncoder(abi, args).encode();
+}

package/src/abi/index.ts

@@ -1,147 +1,4 @@
-/**
- * A named type.
- */
-export interface ABIVariable {
-  /**
-   * The name of the variable.
-   */
-  name: string;
-  /**
-   * The type of the variable.
-   */
-  type: ABIType;
-}
-
-/**
- * Indicates whether a parameter is public or secret/private.
- */
-export enum ABIParameterVisibility {
-  PUBLIC = 'public',
-  SECRET = 'secret',
-}
-
-/**
- * A function parameter.
- */
-export interface ABIParameter extends ABIVariable {
-  /**
-   * Indicates whether a parameter is public or secret/private.
-   */
-  visibility: ABIParameterVisibility;
-}
-
-/**
- * A basic type.
- */
-export interface BasicType<T extends string> {
-  /**
-   * The kind of the type.
-   */
-  kind: T;
-}
-
-/**
- * A variable type.
- */
-export type ABIType = BasicType<'field'> | BasicType<'boolean'> | IntegerType | ArrayType | StringType | StructType;
-
-/**
- * An integer type.
- */
-export interface IntegerType extends BasicType<'integer'> {
-  /**
-   * The sign of the integer.
-   */
-  sign: string;
-  /**
-   * The width of the integer in bits.
-   */
-  width: number;
-}
-
-/**
- * An array type.
- */
-export interface ArrayType extends BasicType<'array'> {
-  /**
-   * The length of the array.
-   */
-  length: number;
-  /**
-   * The type of the array elements.
-   */
-  type: ABIType;
-}
-
-/**
- * A string type.
- */
-export interface StringType extends BasicType<'string'> {
-  /**
-   * The length of the string.
-   */
-  length: number;
-}
-
-/**
- * A struct type.
- */
-export interface StructType extends BasicType<'struct'> {
-  /**
-   * The fields of the struct.
-   */
-  fields: ABIVariable[];
-}
-
-/**
- * Noir function types.
- */
-export enum FunctionType {
-  SECRET = 'secret',
-  OPEN = 'open',
-  UNCONSTRAINED = 'unconstrained',
-}
-
-/**
- * The ABI entry of a function.
- */
-export interface FunctionAbi {
-  /**
-   * The name of the function.
-   */
-  name: string;
-  /**
-   * Whether the function is secret.
-   */
-  functionType: FunctionType;
-  /**
-   * Function parameters.
-   */
-  parameters: ABIParameter[];
-  /**
-   * The types of the return values.
-   */
-  returnTypes: ABIType[];
-  /**
-   * The ACIR bytecode of the function.
-   */
-  bytecode: string;
-  /**
-   * The verification key of the function.
-   */
-  verificationKey?: string;
-}
-
-/**
- * Defines ABI of a contract.
- */
-export interface ContractAbi {
-  /**
-   * The name of the contract.
-   */
-  name: string;
-  /**
-   * The functions of the contract.
-   */
-  functions: FunctionAbi[];
-}
+export * from './abi.js';
+export * from './abi_coder.js';
+export * from './encoder.js';
+export * from './decoder.js';

package/src/aztec-address/index.ts

@@ -65,6 +65,16 @@ export class AztecAddress {
     return new AztecAddress(buf);
   }
 
+  /**
+   * Creates an AztecAddress from a bigint.
+   * The provided value must be within the range of a field.
+   * @param address - The bigint representation of the address.
+   * @returns An AztecAddress instance.
+   */
+  static fromBigInt(address: bigint) {
+    return new AztecAddress(toBufferBE(address, AztecAddress.SIZE_IN_BYTES));
+  }
+
   /**
    * Converts the AztecAddress instance into a Buffer.
    * This method should be used when encoding the address for storage, transmission or serialization purposes.

package/src/crypto/random/index.ts

@@ -1,5 +1,5 @@
-import isNode from 'detect-node';
 import nodeCrypto from 'crypto';
+import isNode from 'detect-node';
 
 // limit of Crypto.getRandomValues()
 // https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues

package/src/crypto/sha256/index.test.ts

@@ -1,5 +1,6 @@
+import { createHash, randomBytes } from 'crypto';
+
 import { sha256 } from './index.js';
-import { randomBytes, createHash } from 'crypto';
 
 describe('sha256', () => {
   it('should correctly hash data using hash.js', () => {

package/src/crypto/sha256/index.ts

@@ -1,4 +1,5 @@
 import { default as hash } from 'hash.js';
+
 import { toBigIntBE, toBufferBE } from '../../bigint-buffer/index.js';
 import { Fr } from '../../fields/fields.js';
 

package/src/fields/fields.ts

@@ -1,6 +1,7 @@
 import { randomBytes } from 'crypto';
-import { BufferReader } from '../serialize/buffer_reader.js';
+
 import { toBigIntBE, toBufferBE, toHex } from '../bigint-buffer/index.js';
+import { BufferReader } from '../serialize/buffer_reader.js';
 
 /**
  * Fr represents a field of integers modulo the prime number MODULUS.
@@ -16,7 +17,7 @@ export class Fr {
   /**
    * The numeric value of the field element as a bigint.
    */
-  public readonly value;
+  public readonly value: bigint;
 
   constructor(value: bigint | number) {
     this.value = BigInt(value);
@@ -94,6 +95,15 @@ export class Fr {
     return toHex(this.value, padTo32);
   }
 
+  /**
+   * Retrieves the underlying bigint.
+   * This method mostly exists to match user expectations, as value is already public.
+   * @returns The underlying bigint.
+   */
+  public toBigInt(): bigint {
+    return this.value;
+  }
+
   /**
    * Returns a shortened string representation of the Fr value, formatted with '0x' prefix and ellipsis in the middle.
    * The resulting string has first 10 characters (including '0x') and last 4 characters of the full hexadecimal value.

package/src/fields/point.ts

@@ -1,5 +1,5 @@
 import { BufferReader } from '../serialize/buffer_reader.js';
-import { Coordinate } from './coordinate.js';
+import { Fr } from './fields.js';
 
 /**
  * Represents a Point on an elliptic curve with x and y coordinates.
@@ -7,7 +7,7 @@ import { Coordinate } from './coordinate.js';
  * converting instances to various output formats, and checking the equality of points.
  */
 export class Point {
-  static ZERO = new Point(Coordinate.ZERO, Coordinate.ZERO);
+  static ZERO = new Point(Fr.ZERO, Fr.ZERO);
 
   /** Used to differentiate this class from AztecAddress */
   public readonly kind = 'point';
@@ -16,11 +16,11 @@ export class Point {
     /**
      * The point's x coordinate
      */
-    public readonly x: Coordinate,
+    public readonly x: Fr,
     /**
      * The point's y coordinate
      */
-    public readonly y: Coordinate,
+    public readonly y: Fr,
   ) {}
 
   /**
@@ -30,7 +30,7 @@ export class Point {
    */
   static random() {
     // TODO is this a random point on the curve?
-    return new Point(Coordinate.random(), Coordinate.random());
+    return new Point(Fr.random(), Fr.random());
   }
 
   /**
@@ -42,17 +42,7 @@ export class Point {
    */
   static fromBuffer(buffer: Buffer | BufferReader) {
     const reader = BufferReader.asReader(buffer);
-    return new this(Coordinate.fromBuffer(reader.readBytes(32)), Coordinate.fromBuffer(reader.readBytes(32)));
-  }
-
-  /**
-   * Creates a point instance from its x and y coordinates.
-   * @param x - X coordinate.
-   * @param y - Y coordinate.
-   * @returns A Point instance.
-   */
-  static fromCoordinates(x: Coordinate, y: Coordinate) {
-    return new this(x, y);
+    return new this(Fr.fromBuffer(reader.readBytes(32)), Fr.fromBuffer(reader.readBytes(32)));
   }
 
   /**
@@ -68,22 +58,11 @@ export class Point {
   }
 
   /**
-   * Convert the Point instance to a Buffer representation of fields
-   * The output buffer's length will be (128 bytes).
-   * This method is useful for serialization and deserialization of the Point object.
-   *
-   * @returns A Buffer representation of the Point instance.
-   */
-  toFieldsBuffer() {
-    return Buffer.concat([this.x.toFieldsBuffer(), this.y.toFieldsBuffer()]);
-  }
-
-  /**
-   * Returns the contents of the point as an array of 4 fields.
-   * @returns The point as an array of 4 fields
+   * Returns the contents of the point as an array of 2 fields.
+   * @returns The point as an array of 2 fields
    */
   toFields() {
-    return this.x.toFields().concat(this.y.toFields());
+    return [this.x, this.y];
   }
 
   /**
@@ -91,11 +70,9 @@ export class Point {
    * @returns The point as BigInts
    */
   toBigInts() {
-    const x = this.x.toBigInt();
-    const y = this.y.toBigInt();
     return {
-      x,
-      y,
+      x: this.x.value,
+      y: this.y.value,
     };
   }
 

package/src/json-rpc/client/json_rpc_client.test.ts

@@ -1,6 +1,7 @@
 import request from 'supertest';
+
+import { TestNote, TestState } from '../fixtures/test_state.js';
 import { JsonRpcServer } from '../server/json_rpc_server.js';
-import { TestState, TestNote } from '../fixtures/test_state.js';
 import { createJsonRpcClient } from './json_rpc_client.js';
 
 test('test an RPC function over client', async () => {

package/src/json-rpc/client/json_rpc_client.ts

@@ -3,9 +3,10 @@
 //  This takes a {foo(): T} and makes {foo(): Promise<T>}
 //  while avoiding Promise of Promise.
 import { RemoteObject } from 'comlink';
+
 import { createDebugLogger } from '../../log/index.js';
 import { retry } from '../../retry/index.js';
-import { ClassConverter, StringClassConverterInput, JsonClassConverterInput } from '../class_converter.js';
+import { ClassConverter, JsonClassConverterInput, StringClassConverterInput } from '../class_converter.js';
 import { JsonStringify, convertFromJsonObj, convertToJsonObj } from '../convert.js';
 
 export { JsonStringify } from '../convert.js';

package/src/json-rpc/convert.test.ts

@@ -1,9 +1,9 @@
+import { Buffer } from 'buffer';
+
 import { ClassConverter } from './class_converter.js';
 import { convertFromJsonObj, convertToJsonObj } from './convert.js';
 import { TestNote } from './fixtures/test_state.js';
 
-import { Buffer } from 'buffer';
-
 const TEST_BASE64 = 'YmFzZTY0IGRlY29kZXI=';
 test('test an RPC function over client', () => {
   const cc = new ClassConverter({ TestNote });

package/src/json-rpc/convert.ts

@@ -1,6 +1,7 @@
-import { ClassConverter } from './class_converter.js';
 import { Buffer } from 'buffer';
 
+import { ClassConverter } from './class_converter.js';
+
 /**
  * Recursively looks through an object for bigints and converts them to object format.
  * @param obj - The object to convert.

package/src/json-rpc/server/json_proxy.ts

@@ -1,5 +1,5 @@
 import { createDebugLogger } from '../../log/index.js';
-import { ClassConverter, StringClassConverterInput, JsonClassConverterInput } from '../class_converter.js';
+import { ClassConverter, JsonClassConverterInput, StringClassConverterInput } from '../class_converter.js';
 import { convertFromJsonObj, convertToJsonObj } from '../convert.js';
 import { assert, hasOwnProperty } from '../js_utils.js';
 

package/src/json-rpc/server/json_rpc_server.test.ts

@@ -1,5 +1,6 @@
 import request from 'supertest';
-import { TestState, TestNote } from '../fixtures/test_state.js';
+
+import { TestNote, TestState } from '../fixtures/test_state.js';
 import { JsonRpcServer } from './json_rpc_server.js';
 
 test('test an RPC function with a primitive parameter', async () => {

package/src/json-rpc/server/json_rpc_server.ts

@@ -1,14 +1,14 @@
-import http from 'http';
-import Router from 'koa-router';
 import cors from '@koa/cors';
-import compress from 'koa-compress';
+import http from 'http';
 import Koa from 'koa';
 import bodyParser from 'koa-bodyparser';
+import compress from 'koa-compress';
+import Router from 'koa-router';
 
 import { createLogger } from '../../log/index.js';
-import { StringClassConverterInput, JsonClassConverterInput } from '../class_converter.js';
-import { JsonProxy } from './json_proxy.js';
+import { JsonClassConverterInput, StringClassConverterInput } from '../class_converter.js';
 import { convertBigintsInObj } from '../convert.js';
+import { JsonProxy } from './json_proxy.js';
 
 /**
  * JsonRpcServer.

package/src/log/log_history.test.ts

@@ -1,4 +1,5 @@
 import { jest } from '@jest/globals';
+
 import { createDebugLogger, enableLogs } from './debug.js';
 import { LogHistory } from './log_history.js';
 

package/src/mutex/mutex.test.ts

@@ -1,4 +1,5 @@
 import { jest } from '@jest/globals';
+
 import { Mutex } from './index.js';
 import { MutexDatabase } from './mutex_database.js';
 

package/src/serialize/buffer_reader.test.ts

@@ -1,8 +1,9 @@
 import { jest } from '@jest/globals';
+
+import { randomBytes } from '../crypto/index.js';
 import { Fq, Fr } from '../fields/fields.js';
 import { BufferReader } from './buffer_reader.js';
 import { serializeBufferArrayToVector } from './free_funcs.js';
-import { randomBytes } from '../crypto/index.js';
 
 const ARRAY = Array.from(Array(32)).map((_, idx) => (idx % 2 === 0 ? 0 : 1));
 const BUFFER = Buffer.from(ARRAY);

package/src/serialize/buffer_reader.ts

@@ -1,4 +1,4 @@
-import { Fr, Fq } from '../fields/fields.js';
+import { Fq, Fr } from '../fields/fields.js';
 import { Tuple } from './types.js';
 
 /**

package/src/serialize/serialize.test.ts

@@ -1,12 +1,12 @@
 import { randomBytes } from '../crypto/index.js';
 import { Fr } from '../fields/fields.js';
 import {
-  serializeBufferToVector,
+  deserializeArrayFromVector,
   deserializeBufferFromVector,
-  deserializeUInt32,
   deserializeField,
+  deserializeUInt32,
   serializeBufferArrayToVector,
-  deserializeArrayFromVector,
+  serializeBufferToVector,
 } from './index.js';
 
 describe('serialize', () => {

package/src/serialize/serializer.ts

@@ -1,4 +1,3 @@
-import { serializeBufferArrayToVector } from './index.js';
 import {
   boolToByte,
   numToInt32BE,
@@ -7,6 +6,7 @@ import {
   serializeBufferToVector,
   serializeDate,
 } from './free_funcs.js';
+import { serializeBufferArrayToVector } from './index.js';
 
 /**
  * The Serializer class provides a convenient and efficient way to serialize various data types into binary format.

package/src/transport/browser/shared_worker_listener.ts

@@ -1,4 +1,5 @@
 import EventEmitter from 'events';
+
 import { Listener } from '../interface/listener.js';
 import { MessagePortSocket } from './message_port_socket.js';
 

package/src/transport/browser/worker_listener.ts

@@ -1,4 +1,5 @@
 import EventEmitter from 'events';
+
 import { Listener } from '../interface/listener.js';
 import { MessagePortSocket } from './message_port_socket.js';
 

package/src/transport/dispatch/create_dispatch_proxy.ts

@@ -1,7 +1,8 @@
-import { DispatchMsg } from './create_dispatch_fn.js';
-import { TransportClient } from '../transport_client.js';
 import { EventEmitter } from 'events';
-import { isTransferDescriptor, TransferDescriptor } from '../interface/transferable.js';
+
+import { TransferDescriptor, isTransferDescriptor } from '../interface/transferable.js';
+import { TransportClient } from '../transport_client.js';
+import { DispatchMsg } from './create_dispatch_fn.js';
 
 /**
  * FilterOutAttributes type filters out all non-method properties of an object, leaving only the attributes

package/src/transport/interface/listener.ts

@@ -1,4 +1,5 @@
 import EventEmitter from 'events';
+
 import { Socket } from './socket.js';
 
 /**

package/src/transport/node/node_connector.ts

@@ -1,4 +1,5 @@
 import { Worker } from 'worker_threads';
+
 import { Connector } from '../interface/connector.js';
 import { NodeConnectorSocket } from './node_connector_socket.js';
 

package/src/transport/node/node_connector_socket.ts

@@ -1,4 +1,5 @@
 import { TransferListItem, Worker } from 'worker_threads';
+
 import { Socket } from '../interface/socket.js';
 
 /**