@aztec/foundation 0.41.0 → 0.43.0

package/src/fields/point.ts

@@ -23,7 +23,9 @@ export class Point {
      * The point's y coordinate
      */
     public readonly y: Fr,
-  ) {}
+  ) {
+    // TODO: Do we want to check if the point is on the curve here?
+  }
 
   /**
    * Generate a random Point instance.
@@ -44,7 +46,7 @@ export class Point {
    */
   static fromBuffer(buffer: Buffer | BufferReader) {
     const reader = BufferReader.asReader(buffer);
-    return new this(Fr.fromBuffer(reader.readBytes(32)), Fr.fromBuffer(reader.readBytes(32)));
+    return new this(Fr.fromBuffer(reader), Fr.fromBuffer(reader));
   }
 
   /**
@@ -134,6 +136,30 @@ export class Point {
   hash() {
     return poseidon2Hash(this.toFields());
   }
+
+  /**
+   * Check if this is point at infinity.
+   * Check this is consistent with how bb is encoding the point at infinity
+   */
+  public get inf() {
+    return this.x == Fr.ZERO;
+  }
+  public toFieldsWithInf() {
+    return [this.x, this.y, new Fr(this.inf)];
+  }
+
+  isOnGrumpkin() {
+    // TODO: Check this against how bb handles curve check and infinity point check
+    if (this.inf) {
+      return true;
+    }
+
+    // p.y * p.y == p.x * p.x * p.x - 17
+    const A = new Fr(17);
+    const lhs = this.y.square();
+    const rhs = this.x.square().mul(this.x).sub(A);
+    return lhs.equals(rhs);
+  }
 }
 
 /**

package/src/fs/index.ts

@@ -0,0 +1 @@
+export * from './run_in_dir.js';

package/src/fs/run_in_dir.ts

@@ -0,0 +1,23 @@
+import * as fs from 'fs/promises';
+import * as path from 'path';
+
+// Create a random directory underneath a 'base' directory
+// Calls a provided method, ensures the random directory is cleaned up afterwards
+export async function runInDirectory<T>(
+  workingDirBase: string,
+  fn: (dir: string) => Promise<T>,
+  cleanup: boolean = true,
+): Promise<T> {
+  // Create random directory to be used for temp files
+  const workingDirectory = await fs.mkdtemp(path.join(workingDirBase, 'tmp-'));
+
+  await fs.access(workingDirectory);
+
+  try {
+    return await fn(workingDirectory);
+  } finally {
+    if (cleanup) {
+      await fs.rm(workingDirectory, { recursive: true, force: true });
+    }
+  }
+}

package/src/index.ts

@@ -10,6 +10,7 @@ export * as errors from './error/index.js';
 export * as ethAddress from './eth-address/index.js';
 export * as fields from './fields/index.js';
 export * as fifo from './fifo/index.js';
+export * as fs from './fs/index.js';
 export * as jsonRpc from './json-rpc/index.js';
 export * as jsonRpcClient from './json-rpc/client/index.js';
 export * as jsonRpcServer from './json-rpc/server/index.js';

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

@@ -80,7 +80,7 @@ export function makeFetch(retries: number[], noRetry: boolean, log?: DebugLogger
       `JsonRpcClient request ${rpcMethod} to ${host}`,
       makeBackoff(retries),
       log,
-      true,
+      false,
     );
   };
 }

package/src/promise/running-promise.ts

@@ -10,7 +10,7 @@ export class RunningPromise {
   private runningPromise = Promise.resolve();
   private interruptibleSleep = new InterruptibleSleep();
 
-  constructor(private fn: () => Promise<void>, private pollingIntervalMS = 10000) {}
+  constructor(private fn: () => void | Promise<void>, private pollingIntervalMS = 10000) {}
 
   /**
    * Starts the running promise.

package/src/serialize/free_funcs.ts

@@ -194,3 +194,11 @@ export function fromTruncField(field: Fr): Buffer {
 export function fromFieldsTuple(fields: Tuple<Fr, 2>): Buffer {
   return from2Fields(fields[0], fields[1]);
 }
+
+export function toHumanReadable(buf: Buffer, maxLen?: number): string {
+  const result = buf.every(byte => byte >= 32 && byte <= 126) ? buf.toString('ascii') : `0x${buf.toString('hex')}`;
+  if (maxLen && result.length > maxLen) {
+    return result.slice(0, maxLen) + '...';
+  }
+  return result;
+}

package/src/serialize/serialize.ts

@@ -242,6 +242,8 @@ export function toFriendlyJSON(obj: object): string {
         ).toFriendlyJSON
       ) {
         return value.toFriendlyJSON();
+      } else if (value && value.type && ['Fr', 'Fq', 'AztecAddress'].includes(value.type)) {
+        return value.value;
       } else {
         return value;
       }

package/src/testing/test_data.ts

@@ -4,7 +4,7 @@ import { dirname, join, resolve } from 'path';
 import { createConsoleLogger } from '../log/console.js';
 import { fileURLToPath } from '../url/index.js';
 
-const testData: { [key: string]: { toBuffer(): Buffer }[] } = {};
+const testData: { [key: string]: unknown[] } = {};
 
 /** Returns whether test data generation is enabled */
 export function isGenerateTestDataEnabled() {
@@ -12,7 +12,7 @@ export function isGenerateTestDataEnabled() {
 }
 
 /** Pushes test data with the given name, only if test data generation is enabled. */
-export function pushTestData(itemName: string, data: { toBuffer(): Buffer }) {
+export function pushTestData<T>(itemName: string, data: T) {
   if (!isGenerateTestDataEnabled()) {
     return;
   }
@@ -31,7 +31,7 @@ export function pushTestData(itemName: string, data: { toBuffer(): Buffer }) {
 }
 
 /** Returns all instances of pushed test data with the given name, or empty if test data generation is not enabled. */
-export function getTestData(itemName: string): { toBuffer(): Buffer }[] {
+export function getTestData(itemName: string): unknown[] {
   if (!isGenerateTestDataEnabled()) {
     return [];
   }

package/src/types/index.ts

@@ -12,3 +12,6 @@ export type FunctionsOf<T> = {
 
 /** Marks a set of properties of a type as optional. */
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+/** Removes readonly modifiers for a type. */
+export type Writeable<T> = { -readonly [P in keyof T]: T[P] };