chore: Refactor serialisation functions and sibling paths (#3980)

This PR moves some serialisation functions from circuits.js to
foundation and sibling path to types.

yarn-project/acir-simulator/src/client/private_execution.test.ts

@@ -4,7 +4,6 @@ import {
   CallContext,
   CompleteAddress,
   ContractDeploymentData,
-  FieldsOf,
   FunctionData,
   L1_TO_L2_MSG_TREE_HEIGHT,
   MAX_NEW_COMMITMENTS_PER_CALL,
@@ -29,6 +28,7 @@ import { pedersenHash } from '@aztec/foundation/crypto';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr, GrumpkinScalar } from '@aztec/foundation/fields';
 import { DebugLogger, createDebugLogger } from '@aztec/foundation/log';
+import { FieldsOf } from '@aztec/foundation/types';
 import { AppendOnlyTree, Pedersen, StandardTree, newTree } from '@aztec/merkle-tree';
 import {
   ChildContractArtifact,

yarn-project/archiver/src/archiver/eth_log_handlers.ts

@@ -1,5 +1,4 @@
 import {
-  BufferReader,
   CancelledL1ToL2Message,
   ContractData,
   EncodedContractFunction,
@@ -13,6 +12,7 @@ import {
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr, Point } from '@aztec/foundation/fields';
+import { BufferReader } from '@aztec/foundation/serialize';
 import { ContractDeploymentEmitterAbi, InboxAbi, RollupAbi } from '@aztec/l1-artifacts';
 
 import { Hex, Log, PublicClient, decodeFunctionData, getAbiItem, getAddress, hexToBytes } from 'viem';

yarn-project/aztec-node/package.json

@@ -43,6 +43,7 @@
     "@aztec/merkle-tree": "workspace:^",
     "@aztec/p2p": "workspace:^",
     "@aztec/sequencer-client": "workspace:^",
+    "@aztec/types": "workspace:^",
     "@aztec/world-state": "workspace:^",
     "koa": "^2.14.2",
     "koa-router": "^12.0.0",

yarn-project/aztec-node/src/aztec-node/http_rpc_server.ts

@@ -8,7 +8,6 @@ import {
   L2BlockL2Logs,
   L2Tx,
   LogId,
-  SiblingPath,
   Tx,
   TxHash,
 } from '@aztec/circuit-types';
@@ -17,6 +16,7 @@ import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
 import { JsonRpcServer } from '@aztec/foundation/json-rpc/server';
+import { SiblingPath } from '@aztec/types/membership';
 
 /**
  * Wrap an AztecNode instance with a JSON RPC HTTP server.

yarn-project/aztec-node/src/aztec-node/server.ts

@@ -19,7 +19,6 @@ import {
   NullifierMembershipWitness,
   PublicDataWitness,
   SequencerConfig,
-  SiblingPath,
   Tx,
   TxHash,
 } from '@aztec/circuit-types';
@@ -48,6 +47,7 @@ import {
   SequencerClient,
   getGlobalVariableBuilder,
 } from '@aztec/sequencer-client';
+import { SiblingPath } from '@aztec/types/membership';
 import {
   MerkleTrees,
   ServerWorldStateSynchronizer,

yarn-project/aztec-node/tsconfig.json

@@ -36,6 +36,9 @@
     {
       "path": "../sequencer-client"
     },
+    {
+      "path": "../types"
+    },
     {
       "path": "../world-state"
     }

yarn-project/aztec.js/src/account_manager/deploy_account_sent_tx.ts

@@ -1,5 +1,5 @@
 import { TxHash, TxReceipt } from '@aztec/circuit-types';
-import { FieldsOf } from '@aztec/circuits.js';
+import { FieldsOf } from '@aztec/foundation/types';
 
 import { Wallet } from '../account/index.js';
 import { DefaultWaitOpts, SentTx, WaitOpts } from '../contract/index.js';

yarn-project/aztec.js/src/contract/deploy_sent_tx.ts

@@ -1,5 +1,6 @@
 import { PXE, TxHash, TxReceipt } from '@aztec/circuit-types';
-import { AztecAddress, CompleteAddress, FieldsOf } from '@aztec/circuits.js';
+import { AztecAddress, CompleteAddress } from '@aztec/circuits.js';
+import { FieldsOf } from '@aztec/foundation/types';
 
 import { Wallet } from '../account/index.js';
 import { type Contract } from './contract.js';

yarn-project/aztec.js/src/contract/sent_tx.ts

@@ -1,6 +1,6 @@
 import { ExtendedNote, GetUnencryptedLogsResponse, PXE, TxHash, TxReceipt, TxStatus } from '@aztec/circuit-types';
-import { FieldsOf } from '@aztec/circuits.js';
 import { retryUntil } from '@aztec/foundation/retry';
+import { FieldsOf } from '@aztec/foundation/types';
 
 /** Options related to waiting for a tx. */
 export type WaitOpts = {

yarn-project/circuit-types/src/auth_witness.ts

@@ -1,6 +1,6 @@
 import { Vector } from '@aztec/circuits.js';
-import { BufferReader, serializeToBuffer } from '@aztec/circuits.js/utils';
 import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 /**
  * An authentication witness. Used to authorize an action by a user.

yarn-project/circuit-types/src/aztec_node/rpc/aztec_node_client.ts

@@ -4,14 +4,14 @@ import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
 import { createJsonRpcClient, defaultFetch } from '@aztec/foundation/json-rpc/client';
+import { SiblingPath } from '@aztec/types/membership';
 
 import { ContractData, ExtendedContractData } from '../../contract_data.js';
 import { AztecNode } from '../../interfaces/index.js';
 import { L1ToL2MessageAndIndex } from '../../l1_to_l2_message.js';
 import { L2Block } from '../../l2_block.js';
 import { L2Tx } from '../../l2_tx.js';
 import { ExtendedUnencryptedL2Log, L2BlockL2Logs, LogId } from '../../logs/index.js';
-import { SiblingPath } from '../../sibling_path.js';
 import { Tx, TxHash } from '../../tx/index.js';
 
 /**

yarn-project/circuit-types/src/contract_dao.ts

@@ -9,9 +9,9 @@ import {
   getFunctionDebugMetadata,
 } from '@aztec/foundation/abi';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { prefixBufferWithLength } from '@aztec/foundation/serialize';
+import { BufferReader, prefixBufferWithLength } from '@aztec/foundation/serialize';
 
-import { BufferReader, EncodedContractFunction } from './contract_data.js';
+import { EncodedContractFunction } from './contract_data.js';
 
 /**
  * A contract Data Access Object (DAO).

yarn-project/circuit-types/src/contract_data.ts

@@ -7,13 +7,15 @@ import {
   Point,
   PublicKey,
 } from '@aztec/circuits.js';
-import { BufferReader, serializeToBuffer } from '@aztec/circuits.js/utils';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { randomBytes } from '@aztec/foundation/crypto';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { numToInt32BE, serializeBufferArrayToVector } from '@aztec/foundation/serialize';
-
-export { BufferReader } from '@aztec/circuits.js/utils';
+import {
+  BufferReader,
+  numToInt32BE,
+  serializeBufferArrayToVector,
+  serializeToBuffer,
+} from '@aztec/foundation/serialize';
 
 /**
  * Used for retrieval of contract data (A3 address, portal contract address, bytecode).

yarn-project/circuit-types/src/index.ts

@@ -20,7 +20,6 @@ export * from './tx/index.js';
 export * from './tx_execution_request.js';
 export * from './packed_arguments.js';
 export * from './interfaces/index.js';
-export * from './sibling_path.js';
 export * from './auth_witness.js';
 export * from './aztec_node/rpc/index.js';
 export { CompleteAddress, PublicKey, PartialAddress, GrumpkinPrivateKey } from '@aztec/circuits.js';

yarn-project/circuit-types/src/interfaces/index.ts

@@ -1,5 +1,4 @@
 export * from './state_info_provider.js';
-export * from './hasher.js';
 export * from './aztec-node.js';
 export * from './pxe.js';
 export * from './deployed-contract.js';

yarn-project/circuit-types/src/interfaces/nullifier_tree.ts

@@ -1,6 +1,5 @@
 import { Fr, NULLIFIER_TREE_HEIGHT, NullifierLeafPreimage } from '@aztec/circuits.js';
-
-import { SiblingPath } from '../sibling_path.js';
+import { SiblingPath } from '@aztec/types/membership';
 
 /**
  * Nullifier membership witness.

yarn-project/circuit-types/src/interfaces/public_data_tree.ts

@@ -1,6 +1,5 @@
 import { Fr, PUBLIC_DATA_TREE_HEIGHT, PublicDataTreeLeafPreimage } from '@aztec/circuits.js';
-
-import { SiblingPath } from '../sibling_path.js';
+import { SiblingPath } from '@aztec/types/membership';
 
 /**
  * Public data witness.

yarn-project/circuit-types/src/interfaces/state_info_provider.ts

@@ -7,11 +7,11 @@ import {
   NULLIFIER_TREE_HEIGHT,
   PUBLIC_DATA_TREE_HEIGHT,
 } from '@aztec/circuits.js';
+import { SiblingPath } from '@aztec/types/membership';
 
 import { L1ToL2MessageAndIndex } from '../l1_to_l2_message.js';
 import { L2Block } from '../l2_block.js';
 import { MerkleTreeId } from '../merkle_tree_id.js';
-import { SiblingPath } from '../sibling_path.js';
 import { NullifierMembershipWitness } from './nullifier_tree.js';
 import { PublicDataWitness } from './public_data_tree.js';
 

yarn-project/circuit-types/src/l1_to_l2_message.ts

@@ -1,8 +1,8 @@
-import { BufferReader, serializeToBuffer } from '@aztec/circuits.js/utils';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { toBigIntBE, toBufferBE } from '@aztec/foundation/bigint-buffer';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 /**
  * Interface of classes allowing for the retrieval of L1 to L2 messages.

yarn-project/circuit-types/src/l2_block.ts

@@ -13,10 +13,10 @@ import {
   StateReference,
 } from '@aztec/circuits.js';
 import { makeAppendOnlyTreeSnapshot, makeGlobalVariables, makeHeader } from '@aztec/circuits.js/factories';
-import { BufferReader, serializeToBuffer } from '@aztec/circuits.js/utils';
 import { keccak, sha256 } from '@aztec/foundation/crypto';
 import { Fr } from '@aztec/foundation/fields';
 import { createDebugLogger } from '@aztec/foundation/log';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import times from 'lodash.times';
 

yarn-project/circuit-types/src/logs/l1_note_payload/l1_note_payload.ts

@@ -1,8 +1,7 @@
 import { AztecAddress, GrumpkinPrivateKey, PublicKey } from '@aztec/circuits.js';
 import { Grumpkin } from '@aztec/circuits.js/barretenberg';
-import { serializeToBuffer } from '@aztec/circuits.js/utils';
 import { Fr, GrumpkinScalar } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import { decryptBuffer, encryptBuffer } from './encrypt_buffer.js';
 import { Note } from './note.js';

yarn-project/circuit-types/src/packed_arguments.ts

@@ -1,6 +1,7 @@
-import { FieldsOf, Fr, Vector } from '@aztec/circuits.js';
+import { Fr, Vector } from '@aztec/circuits.js';
 import { computeVarArgsHash } from '@aztec/circuits.js/abis';
-import { BufferReader, serializeToBuffer } from '@aztec/circuits.js/utils';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+import { FieldsOf } from '@aztec/foundation/types';
 
 /**
  * Packs a set of arguments into a hash.

yarn-project/circuit-types/src/public_data_write.ts

@@ -1,7 +1,6 @@
 import { STRING_ENCODING } from '@aztec/circuits.js';
-import { serializeToBuffer } from '@aztec/circuits.js/utils';
 import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 /**
  * Write operations on the public state tree.

yarn-project/circuit-types/src/tx/tx.ts

@@ -1,7 +1,6 @@
 import { MAX_NEW_CONTRACTS_PER_TX, PrivateKernelPublicInputsFinal, Proof, PublicCallRequest } from '@aztec/circuits.js';
-import { serializeToBuffer } from '@aztec/circuits.js/utils';
 import { arrayNonEmptyLength } from '@aztec/foundation/collection';
-import { BufferReader, Tuple } from '@aztec/foundation/serialize';
+import { BufferReader, Tuple, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import { ExtendedContractData } from '../contract_data.js';
 import { GetUnencryptedLogsResponse } from '../logs/get_unencrypted_logs_response.js';

yarn-project/circuit-types/src/tx_execution_request.ts

@@ -1,5 +1,6 @@
-import { AztecAddress, FieldsOf, Fr, FunctionData, TxContext, TxRequest, Vector } from '@aztec/circuits.js';
-import { BufferReader, serializeToBuffer } from '@aztec/circuits.js/utils';
+import { AztecAddress, Fr, FunctionData, TxContext, TxRequest, Vector } from '@aztec/circuits.js';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+import { FieldsOf } from '@aztec/foundation/types';
 
 import { AuthWitness } from './auth_witness.js';
 import { PackedArguments } from './packed_arguments.js';

yarn-project/circuits.js/src/abis/abis.ts

@@ -2,7 +2,7 @@ import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { padArrayEnd } from '@aztec/foundation/collection';
 import { keccak, pedersenHash, pedersenHashBuffer } from '@aztec/foundation/crypto';
 import { Fr } from '@aztec/foundation/fields';
-import { numToUInt8, numToUInt16BE, numToUInt32BE } from '@aztec/foundation/serialize';
+import { boolToBuffer, numToUInt8, numToUInt16BE, numToUInt32BE } from '@aztec/foundation/serialize';
 
 import { Buffer } from 'buffer';
 import chunk from 'lodash.chunk';
@@ -35,7 +35,6 @@ import {
   VerificationKey,
 } from '../structs/index.js';
 import { PublicKey } from '../types/index.js';
-import { boolToBuffer } from '../utils/serialize.js';
 import { MerkleTreeCalculator } from './merkle_tree_calculator.js';
 
 /**

yarn-project/circuits.js/src/index.ts

@@ -1,5 +1,4 @@
 export * from './structs/index.js';
-export * from './utils/jsUtils.js';
 export * from './contract/index.js';
 export * from './types/index.js';
 export * from './constants.gen.js';

yarn-project/circuits.js/src/structs/aggregation_object.ts

@@ -1,9 +1,8 @@
 import { Fq, Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import times from 'lodash.times';
 
-import { serializeToBuffer } from '../utils/serialize.js';
 import { UInt32, Vector } from './shared.js';
 import { G1AffineElement } from './verification_key.js';
 

yarn-project/circuits.js/src/structs/call_context.ts

@@ -1,9 +1,8 @@
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+import { FieldsOf } from '@aztec/foundation/types';
 
-import { FieldsOf } from '../utils/jsUtils.js';
-import { serializeToBuffer } from '../utils/serialize.js';
 import { Fr, FunctionSelector } from './index.js';
 
 /**

yarn-project/circuits.js/src/structs/call_request.ts

@@ -1,10 +1,8 @@
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 import { FieldsOf } from '@aztec/foundation/types';
 
-import { serializeToBuffer } from '../utils/serialize.js';
-
 /**
  * Caller context.
  */

yarn-project/circuits.js/src/structs/call_stack_item.ts

@@ -1,9 +1,8 @@
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import { computePrivateCallStackItemHash, computePublicCallStackItemHash } from '../abis/abis.js';
-import { serializeToBuffer } from '../utils/serialize.js';
 import { CallRequest, CallerContext } from './call_request.js';
 import { FunctionData } from './function_data.js';
 import { PrivateCircuitPublicInputs } from './private_circuit_public_inputs.js';

yarn-project/circuits.js/src/structs/function_data.ts

@@ -1,8 +1,7 @@
 import { FunctionAbi, FunctionSelector, FunctionType } from '@aztec/foundation/abi';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import { ContractFunctionDao } from '../index.js';
-import { serializeToBuffer } from '../utils/serialize.js';
 
 /**
  * Function description for circuit.

yarn-project/circuits.js/src/structs/function_leaf_preimage.ts

@@ -1,8 +1,6 @@
 import { FunctionSelector } from '@aztec/foundation/abi';
 import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
-
-import { serializeToBuffer } from '../utils/serialize.js';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 /**
  * A class representing the "preimage" of a function tree leaf.

yarn-project/circuits.js/src/structs/global_variables.ts

@@ -1,9 +1,7 @@
 import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 import { FieldsOf } from '@aztec/foundation/types';
 
-import { serializeToBuffer } from '../utils/index.js';
-
 /**
  * Global variables of the L2 block.
  */

yarn-project/circuits.js/src/structs/header.ts

@@ -1,8 +1,7 @@
 import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import { NUM_FIELDS_PER_SHA256 } from '../constants.gen.js';
-import { serializeToBuffer } from '../utils/serialize.js';
 import { GlobalVariables } from './global_variables.js';
 import { AppendOnlyTreeSnapshot } from './rollup/append_only_tree_snapshot.js';
 import { StateReference } from './state_reference.js';

yarn-project/circuits.js/src/structs/kernel/block_header.ts

@@ -1,8 +1,6 @@
 import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
-
-import { FieldsOf } from '../../utils/jsUtils.js';
-import { serializeToBuffer } from '../../utils/serialize.js';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+import { FieldsOf } from '@aztec/foundation/types';
 
 /**
  * The string encoding used for serializing BlockHeader objects.