chore: Fix circulars in foundation. Also cleanup fields and optimise …

…to be buffer underlying. (#3351) * Fixes circulars imports in foundation so formatting no longer warns. * Address *some* circular imports in `acir-simulator`. * Reworks field classes Fr, Fq and GrumpkinScalar. * There is a BaseField class capturing common instance code. * There are free functions capturing common static construction code. * Fr and Fq are implemented in terms of BaseField and free functions. * Fq supports construction and output of hi/lo Fr's. * GrumpkinScalar is aliased to just be an Fq. * AztecAddress is now just an extension of Fr that enforces 32 byte buffer input. * I meddled with `ZERO` and `zero()` a bit so there are some changes around this that are noops. * Disables `guides-up-quick-start` as failing since CI fix. * JSON-RPC class converter now checks full prototype chain for methods.
AztecProtocol · Nov 19, 2023 · c4bf8d3 · c4bf8d3
1 parent 52b95f6
commit c4bf8d3
Show file tree

Hide file tree

Showing 76 changed files with 55,218 additions and 2,625 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1316,7 +1316,7 @@ workflows:
       - guides-writing-an-account-contract: *e2e_test
       - guides-dapp-testing: *e2e_test
       - guides-sample-dapp: *e2e_test
-      - guides-up-quick-start: *e2e_test
+      # - guides-up-quick-start: *e2e_test
       - bench-publish-rollup: *e2e_test
       - bench-process-history: *e2e_test
 
@@ -1350,7 +1350,7 @@ workflows:
             - guides-writing-an-account-contract
             - guides-dapp-testing
             - guides-sample-dapp
-            - guides-up-quick-start
+            # - guides-up-quick-start
           <<: *defaults
 
       - bench-summary:

diff --git a/yarn-project/acir-simulator/src/acvm/acvm.ts b/yarn-project/acir-simulator/src/acvm/acvm.ts
@@ -7,23 +7,13 @@ import {
   ForeignCallInput,
   ForeignCallOutput,
   WasmBlackBoxFunctionSolver,
-  WitnessMap,
   executeCircuitWithBlackBoxSolver,
 } from '@noir-lang/acvm_js';
 
 import { traverseCauseChain } from '../common/errors.js';
+import { ACVMWitness } from './acvm_types.js';
 import { ORACLE_NAMES } from './oracle/index.js';
 
-/**
- * The format for fields on the ACVM.
- */
-export type ACVMField = string;
-
-/**
- * The format for witnesses of the ACVM.
- */
-export type ACVMWitness = WitnessMap;
-
 /**
  * The callback interface for the ACIR.
  */

diff --git a/yarn-project/acir-simulator/src/acvm/acvm_types.ts b/yarn-project/acir-simulator/src/acvm/acvm_types.ts
@@ -0,0 +1,11 @@
+import { WitnessMap } from '@noir-lang/acvm_js';
+
+/**
+ * ACVMField
+ */
+export type ACVMField = string;
+
+/**
+ * The format for witnesses of the ACVM.
+ */
+export type ACVMWitness = WitnessMap;
diff --git a/yarn-project/acir-simulator/src/acvm/deserialize.ts b/yarn-project/acir-simulator/src/acvm/deserialize.ts
@@ -26,7 +26,7 @@ import { Tuple } from '@aztec/foundation/serialize';
 
 import { getReturnWitness } from '@noir-lang/acvm_js';
 
-import { ACVMField, ACVMWitness } from './acvm.js';
+import { ACVMField, ACVMWitness } from './acvm_types.js';
 
 /**
  * Converts an ACVM field to a Buffer.

diff --git a/yarn-project/acir-simulator/src/acvm/index.ts b/yarn-project/acir-simulator/src/acvm/index.ts
@@ -1,4 +1,5 @@
 export * from './acvm.js';
+export * from './acvm_types.js';
 export * from './deserialize.js';
 export * from './oracle/index.js';
 export * from './serialize.js';
diff --git a/yarn-project/acir-simulator/src/acvm/oracle/debug.ts b/yarn-project/acir-simulator/src/acvm/oracle/debug.ts
@@ -1,6 +1,6 @@
 import { ForeignCallInput } from '@noir-lang/acvm_js';
 
-import { ACVMField } from '../acvm.js';
+import { ACVMField } from '../acvm_types.js';
 
 /**
  * Convert an array of ACVMFields to a string.

diff --git a/yarn-project/acir-simulator/src/acvm/oracle/oracle.ts b/yarn-project/acir-simulator/src/acvm/oracle/oracle.ts
@@ -6,8 +6,8 @@ import { Fr, Point } from '@aztec/foundation/fields';
 import { createDebugLogger } from '@aztec/foundation/log';
 import { UnencryptedL2Log } from '@aztec/types';
 
-import { ACVMField } from '../acvm.js';
-import { convertACVMFieldToBuffer, fromACVMField } from '../deserialize.js';
+import { ACVMField } from '../acvm_types.js';
+import { fromACVMField } from '../deserialize.js';
 import {
   toACVMField,
   toAcvmCallPrivateStackItem,
@@ -163,7 +163,7 @@ export class Oracle {
   }
 
   emitUnencryptedLog([contractAddress]: ACVMField[], [eventSelector]: ACVMField[], message: ACVMField[]): ACVMField {
-    const logPayload = Buffer.concat(message.map(charBuffer => convertACVMFieldToBuffer(charBuffer).subarray(-1)));
+    const logPayload = Buffer.concat(message.map(charBuffer => Fr.fromString(charBuffer).toBuffer().subarray(-1)));
     const log = new UnencryptedL2Log(
       AztecAddress.fromString(contractAddress),
       FunctionSelector.fromField(fromACVMField(eventSelector)), // TODO https://github.com/AztecProtocol/aztec-packages/issues/2632

diff --git a/yarn-project/acir-simulator/src/acvm/serialize.ts b/yarn-project/acir-simulator/src/acvm/serialize.ts
@@ -12,8 +12,8 @@ import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
 
-import { ACVMField } from './acvm.js';
-import { MessageLoadOracleInputs } from './oracle/index.js';
+import { ACVMField } from './acvm_types.js';
+import { MessageLoadOracleInputs } from './oracle/typed_oracle.js';
 
 /**
  * Adapts the buffer to the field size.

diff --git a/yarn-project/acir-simulator/src/common/packed_args_cache.ts b/yarn-project/acir-simulator/src/common/packed_args_cache.ts
@@ -10,7 +10,7 @@ export class PackedArgsCache {
   constructor(initialArguments: PackedArguments[] = []) {
     this.cache = new Map();
     for (const initialArg of initialArguments) {
-      this.cache.set(initialArg.hash.value, initialArg.args);
+      this.cache.set(initialArg.hash.toBigInt(), initialArg.args);
     }
   }
 
@@ -29,7 +29,7 @@ export class PackedArgsCache {
    * @returns The unpacked arguments.
    */
   public unpack(hash: Fr): Fr[] {
-    if (hash.equals(Fr.zero())) {
+    if (hash.equals(Fr.ZERO)) {
       return [];
     }
     const packedArgs = this.cache.get(hash.value);
@@ -46,7 +46,7 @@ export class PackedArgsCache {
    */
   public pack(args: Fr[]) {
     if (args.length === 0) {
-      return Fr.zero();
+      return Fr.ZERO;
     }
     const packedArguments = PackedArguments.fromArgs(args);
     this.cache.set(packedArguments.hash.value, packedArguments.args);

diff --git a/yarn-project/acir-simulator/src/test/utils.ts b/yarn-project/acir-simulator/src/test/utils.ts
@@ -1,7 +1,7 @@
 import { AztecAddress, EthAddress, Fr } from '@aztec/circuits.js';
 import { computeSecretMessageHash } from '@aztec/circuits.js/abis';
 import { ContractArtifact, FunctionSelector, getFunctionDebugMetadata } from '@aztec/foundation/abi';
-import { sha256ToField } from '@aztec/foundation/crypto';
+import { sha256 } from '@aztec/foundation/crypto';
 import { L1Actor, L1ToL2Message, L2Actor } from '@aztec/types';
 
 import { FunctionArtifactWithDebugMetadata } from '../index.js';
@@ -24,7 +24,7 @@ export const buildL1ToL2Message = (
   const selectorBuf = Buffer.from(selector, 'hex');
 
   const contentBuf = Buffer.concat([selectorBuf, ...contentPreimage.map(field => field.toBuffer())]);
-  const content = sha256ToField(contentBuf);
+  const content = Fr.fromBufferReduce(sha256(contentBuf));
 
   const secretHash = computeSecretMessageHash(secret);
 

diff --git a/yarn-project/archiver/src/archiver/archiver.test.ts b/yarn-project/archiver/src/archiver/archiver.test.ts
@@ -49,24 +49,24 @@ describe('Archiver', () => {
     // Archiver removes such messages from pending store.
     // Also create some more messages to cancel and some that will stay pending.
 
-    const messageToCancel1 = Fr.random().toString(true);
-    const messageToCancel2 = Fr.random().toString(true);
+    const messageToCancel1 = Fr.random().toString();
+    const messageToCancel2 = Fr.random().toString();
     const l1ToL2MessagesToCancel = [messageToCancel1, messageToCancel2];
-    const messageToStayPending1 = Fr.random().toString(true);
-    const messageToStayPending2 = Fr.random().toString(true);
+    const messageToStayPending1 = Fr.random().toString();
+    const messageToStayPending2 = Fr.random().toString();
 
     const l1ToL2MessageAddedEvents = [
       makeL1ToL2MessageAddedEvents(
         100n,
-        blocks[0].newL1ToL2Messages.map(key => key.toString(true)),
+        blocks[0].newL1ToL2Messages.map(key => key.toString()),
       ),
       makeL1ToL2MessageAddedEvents(
         100n,
-        blocks[1].newL1ToL2Messages.map(key => key.toString(true)),
+        blocks[1].newL1ToL2Messages.map(key => key.toString()),
       ),
       makeL1ToL2MessageAddedEvents(
         2501n,
-        blocks[2].newL1ToL2Messages.map(key => key.toString(true)),
+        blocks[2].newL1ToL2Messages.map(key => key.toString()),
       ),
       makeL1ToL2MessageAddedEvents(2502n, [
         messageToCancel1,
@@ -105,7 +105,7 @@ describe('Archiver', () => {
       l1ToL2MessageAddedEvents[3][2].args.entryKey,
       l1ToL2MessageAddedEvents[3][3].args.entryKey,
     ];
-    const actualPendingMessageKeys = (await archiver.getPendingL1ToL2Messages(10)).map(key => key.toString(true));
+    const actualPendingMessageKeys = (await archiver.getPendingL1ToL2Messages(10)).map(key => key.toString());
     expect(expectedPendingMessageKeys).toEqual(actualPendingMessageKeys);
 
     // Expect logs to correspond to what is set by L2Block.random(...)
@@ -147,7 +147,7 @@ describe('Archiver', () => {
     expect(latestBlockNum).toEqual(0);
 
     const createL1ToL2Messages = () => {
-      return [Fr.random().toString(true), Fr.random().toString(true)];
+      return [Fr.random().toString(), Fr.random().toString()];
     };
 
     const blocks = blockNumbers.map(x => L2Block.random(x, 4, x, x + 1, x * 2, x * 3));
@@ -163,11 +163,11 @@ describe('Archiver', () => {
     const l1ToL2MessageAddedEvents = [
       makeL1ToL2MessageAddedEvents(
         100n,
-        blocks[0].newL1ToL2Messages.map(key => key.toString(true)),
+        blocks[0].newL1ToL2Messages.map(key => key.toString()),
       ),
       makeL1ToL2MessageAddedEvents(
         101n,
-        blocks[1].newL1ToL2Messages.map(key => key.toString(true)),
+        blocks[1].newL1ToL2Messages.map(key => key.toString()),
       ),
       makeL1ToL2MessageAddedEvents(102n, additionalL1ToL2MessagesBlock102),
       makeL1ToL2MessageAddedEvents(103n, additionalL1ToL2MessagesBlock103),
@@ -201,7 +201,7 @@ describe('Archiver', () => {
 
     // Check that the only pending L1 to L2 messages are those from eth bock 102
     const expectedPendingMessageKeys = additionalL1ToL2MessagesBlock102;
-    const actualPendingMessageKeys = (await archiver.getPendingL1ToL2Messages(100)).map(key => key.toString(true));
+    const actualPendingMessageKeys = (await archiver.getPendingL1ToL2Messages(100)).map(key => key.toString());
     expect(actualPendingMessageKeys).toEqual(expectedPendingMessageKeys);
 
     await archiver.stop();
@@ -234,7 +234,7 @@ describe('Archiver', () => {
       .mockResolvedValueOnce(
         makeL1ToL2MessageAddedEvents(
           100n,
-          block.newL1ToL2Messages.map(x => x.toString(true)),
+          block.newL1ToL2Messages.map(x => x.toString()),
         ),
       )
       .mockResolvedValueOnce([])
@@ -292,9 +292,9 @@ function makeContractDeploymentEvent(l1BlockNum: bigint, l2Block: L2Block) {
       aztecAddress: extendedContractData.contractData.contractAddress.toString(),
       portalAddress: extendedContractData.contractData.portalContractAddress.toString(),
       l2BlockHash: `0x${l2Block.getCalldataHash().toString('hex')}`,
-      partialAddress: extendedContractData.partialAddress.toString(true),
-      pubKeyX: extendedContractData.publicKey.x.toString(true),
-      pubKeyY: extendedContractData.publicKey.y.toString(true),
+      partialAddress: extendedContractData.partialAddress.toString(),
+      pubKeyX: extendedContractData.publicKey.x.toString(),
+      pubKeyY: extendedContractData.publicKey.y.toString(),
       acir: '0x' + acir,
     },
     transactionHash: `0x${l2Block.number}`,
@@ -316,8 +316,8 @@ function makeL1ToL2MessageAddedEvents(l1BlockNum: bigint, entryKeys: string[]) {
         senderChainId: 1n,
         recipient: AztecAddress.random().toString(),
         recipientVersion: 1n,
-        content: Fr.random().toString(true),
-        secretHash: Fr.random().toString(true),
+        content: Fr.random().toString(),
+        secretHash: Fr.random().toString(),
         deadline: 100,
         fee: 1n,
         entryKey: entryKey,