WIP

Author: benesjan

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

@@ -10,7 +10,7 @@ import { InboxAbi } from '@aztec/l1-artifacts';
 import {
   ContractClassRegisteredEvent,
   PrivateFunctionBroadcastedEvent,
-  UnconstrainedFunctionBroadcastedEvent,
+  UtilityFunctionBroadcastedEvent,
 } from '@aztec/protocol-contracts/class-registerer';
 import {
   ContractInstanceDeployedEvent,
@@ -31,10 +31,10 @@ import {
   type ContractDataSource,
   type ContractInstanceWithAddress,
   type ExecutablePrivateFunctionWithMembershipProof,
-  type UnconstrainedFunctionWithMembershipProof,
+  type UtilityFunctionWithMembershipProof,
   computePublicBytecodeCommitment,
   isValidPrivateFunctionMembershipProof,
-  isValidUnconstrainedFunctionMembershipProof,
+  isValidUtilityFunctionMembershipProof,
 } from '@aztec/stdlib/contract';
 import {
   type L1RollupConstants,
@@ -984,7 +984,7 @@ class ArchiverStoreHelper
   }
 
   /**
-   * Stores the functions that was broadcasted individually
+   * Stores the functions that were broadcasted individually
    *
    * @dev   Beware that there is not a delete variant of this, since they are added to contract classes
    *        and will be deleted as part of the class if needed.
@@ -994,17 +994,17 @@ class ArchiverStoreHelper
    * @returns
    */
   async #storeBroadcastedIndividualFunctions(allLogs: ContractClassLog[], _blockNum: number) {
-    // Filter out private and unconstrained function broadcast events
+    // Filter out private and utility function broadcast events
     const privateFnEvents = allLogs
       .filter(log => PrivateFunctionBroadcastedEvent.isPrivateFunctionBroadcastedEvent(log))
       .map(log => PrivateFunctionBroadcastedEvent.fromLog(log));
-    const unconstrainedFnEvents = allLogs
-      .filter(log => UnconstrainedFunctionBroadcastedEvent.isUnconstrainedFunctionBroadcastedEvent(log))
-      .map(log => UnconstrainedFunctionBroadcastedEvent.fromLog(log));
+    const utilityFnEvents = allLogs
+      .filter(log => UtilityFunctionBroadcastedEvent.isUtilityFunctionBroadcastedEvent(log))
+      .map(log => UtilityFunctionBroadcastedEvent.fromLog(log));
 
     // Group all events by contract class id
     for (const [classIdString, classEvents] of Object.entries(
-      groupBy([...privateFnEvents, ...unconstrainedFnEvents], e => e.contractClassId.toString()),
+      groupBy([...privateFnEvents, ...utilityFnEvents], e => e.contractClassId.toString()),
     )) {
       const contractClassId = Fr.fromHexString(classIdString);
       const contractClass = await this.getContractClass(contractClassId);
@@ -1013,27 +1013,27 @@ class ArchiverStoreHelper
         continue;
       }
 
-      // Split private and unconstrained functions, and filter out invalid ones
+      // Split private and utility functions, and filter out invalid ones
       const allFns = classEvents.map(e => e.toFunctionWithMembershipProof());
       const privateFns = allFns.filter(
-        (fn): fn is ExecutablePrivateFunctionWithMembershipProof => 'unconstrainedFunctionsArtifactTreeRoot' in fn,
+        (fn): fn is ExecutablePrivateFunctionWithMembershipProof => 'utilityFunctionsTreeRoot' in fn,
       );
-      const unconstrainedFns = allFns.filter(
-        (fn): fn is UnconstrainedFunctionWithMembershipProof => 'privateFunctionsArtifactTreeRoot' in fn,
+      const utilityFns = allFns.filter(
+        (fn): fn is UtilityFunctionWithMembershipProof => 'privateFunctionsArtifactTreeRoot' in fn,
       );
 
       const privateFunctionsWithValidity = await Promise.all(
         privateFns.map(async fn => ({ fn, valid: await isValidPrivateFunctionMembershipProof(fn, contractClass) })),
       );
       const validPrivateFns = privateFunctionsWithValidity.filter(({ valid }) => valid).map(({ fn }) => fn);
-      const unconstrainedFunctionsWithValidity = await Promise.all(
-        unconstrainedFns.map(async fn => ({
+      const utilityFunctionsWithValidity = await Promise.all(
+        utilityFns.map(async fn => ({
           fn,
-          valid: await isValidUnconstrainedFunctionMembershipProof(fn, contractClass),
+          valid: await isValidUtilityFunctionMembershipProof(fn, contractClass),
         })),
       );
-      const validUnconstrainedFns = unconstrainedFunctionsWithValidity.filter(({ valid }) => valid).map(({ fn }) => fn);
-      const validFnCount = validPrivateFns.length + validUnconstrainedFns.length;
+      const validUtilityFns = utilityFunctionsWithValidity.filter(({ valid }) => valid).map(({ fn }) => fn);
+      const validFnCount = validPrivateFns.length + validUtilityFns.length;
       if (validFnCount !== allFns.length) {
         this.#log.warn(`Skipping ${allFns.length - validFnCount} invalid functions`);
       }
@@ -1042,7 +1042,7 @@ class ArchiverStoreHelper
       if (validFnCount > 0) {
         this.#log.verbose(`Storing ${validFnCount} functions for contract class ${contractClassId.toString()}`);
       }
-      return await this.store.addFunctions(contractClassId, validPrivateFns, validUnconstrainedFns);
+      return await this.store.addFunctions(contractClassId, validPrivateFns, validUtilityFns);
     }
     return true;
   }

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

@@ -7,7 +7,7 @@ import type {
   ContractInstanceUpdateWithAddress,
   ContractInstanceWithAddress,
   ExecutablePrivateFunctionWithMembershipProof,
-  UnconstrainedFunctionWithMembershipProof,
+  UtilityFunctionWithMembershipProof,
 } from '@aztec/stdlib/contract';
 import type { GetContractClassLogsResponse, GetPublicLogsResponse } from '@aztec/stdlib/interfaces/client';
 import type { LogFilter, PrivateLog, TxScopedL2Log } from '@aztec/stdlib/logs';
@@ -221,7 +221,7 @@ export interface ArchiverDataStore {
   addFunctions(
     contractClassId: Fr,
     privateFunctions: ExecutablePrivateFunctionWithMembershipProof[],
-    unconstrainedFunctions: UnconstrainedFunctionWithMembershipProof[],
+    utilityFunctions: UtilityFunctionWithMembershipProof[],
   ): Promise<boolean>;
 
   /**

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

@@ -22,7 +22,7 @@ import { InboxLeaf } from '@aztec/stdlib/messaging';
 import {
   makeContractClassPublic,
   makeExecutablePrivateFunctionWithMembershipProof,
-  makeUnconstrainedFunctionWithMembershipProof,
+  makeUtilityFunctionWithMembershipProof,
 } from '@aztec/stdlib/testing';
 import '@aztec/stdlib/testing/jest';
 import { TxEffect, TxHash } from '@aztec/stdlib/tx';
@@ -433,19 +433,19 @@ export function describeArchiverDataStore(
         expect(stored?.privateFunctions).toEqual(fns);
       });
 
-      it('adds new unconstrained functions', async () => {
-        const fns = times(3, makeUnconstrainedFunctionWithMembershipProof);
+      it('adds new utility functions', async () => {
+        const fns = times(3, makeUtilityFunctionWithMembershipProof);
         await store.addFunctions(contractClass.id, [], fns);
         const stored = await store.getContractClass(contractClass.id);
-        expect(stored?.unconstrainedFunctions).toEqual(fns);
+        expect(stored?.utilityFunctions).toEqual(fns);
       });
 
-      it('does not duplicate unconstrained functions', async () => {
-        const fns = times(3, makeUnconstrainedFunctionWithMembershipProof);
+      it('does not duplicate utility functions', async () => {
+        const fns = times(3, makeUtilityFunctionWithMembershipProof);
         await store.addFunctions(contractClass.id, [], fns.slice(0, 1));
         await store.addFunctions(contractClass.id, [], fns);
         const stored = await store.getContractClass(contractClass.id);
-        expect(stored?.unconstrainedFunctions).toEqual(fns);
+        expect(stored?.utilityFunctions).toEqual(fns);
       });
     });
 

yarn-project/archiver/src/archiver/kv_archiver_store/contract_class_store.ts

@@ -7,7 +7,7 @@ import type {
   ContractClassPublic,
   ContractClassPublicWithBlockNumber,
   ExecutablePrivateFunctionWithMembershipProof,
-  UnconstrainedFunctionWithMembershipProof,
+  UtilityFunctionWithMembershipProof,
 } from '@aztec/stdlib/contract';
 import { Vector } from '@aztec/stdlib/types';
 
@@ -60,7 +60,7 @@ export class ContractClassStore {
   async addFunctions(
     contractClassId: Fr,
     newPrivateFunctions: ExecutablePrivateFunctionWithMembershipProof[],
-    newUnconstrainedFunctions: UnconstrainedFunctionWithMembershipProof[],
+    newUtilityFunctions: UtilityFunctionWithMembershipProof[],
   ): Promise<boolean> {
     await this.db.transactionAsync(async () => {
       const existingClassBuffer = await this.#contractClasses.getAsync(contractClassId.toString());
@@ -69,19 +69,17 @@ export class ContractClassStore {
       }
 
       const existingClass = deserializeContractClassPublic(existingClassBuffer);
-      const { privateFunctions: existingPrivateFns, unconstrainedFunctions: existingUnconstrainedFns } = existingClass;
+      const { privateFunctions: existingPrivateFns, utilityFunctions: existingUtilityFns } = existingClass;
 
       const updatedClass: Omit<ContractClassPublicWithBlockNumber, 'id'> = {
         ...existingClass,
         privateFunctions: [
           ...existingPrivateFns,
           ...newPrivateFunctions.filter(newFn => !existingPrivateFns.some(f => f.selector.equals(newFn.selector))),
         ],
-        unconstrainedFunctions: [
-          ...existingUnconstrainedFns,
-          ...newUnconstrainedFunctions.filter(
-            newFn => !existingUnconstrainedFns.some(f => f.selector.equals(newFn.selector)),
-          ),
+        utilityFunctions: [
+          ...existingUtilityFns,
+          ...newUtilityFunctions.filter(newFn => !existingUtilityFns.some(f => f.selector.equals(newFn.selector))),
         ],
       };
       await this.#contractClasses.set(contractClassId.toString(), serializeContractClassPublic(updatedClass));
@@ -98,8 +96,8 @@ function serializeContractClassPublic(contractClass: Omit<ContractClassPublicWit
     contractClass.artifactHash,
     contractClass.privateFunctions.length,
     contractClass.privateFunctions.map(serializePrivateFunction),
-    contractClass.unconstrainedFunctions.length,
-    contractClass.unconstrainedFunctions.map(serializeUnconstrainedFunction),
+    contractClass.utilityFunctions.length,
+    contractClass.utilityFunctions.map(serializeUtilityFunction),
     contractClass.packedBytecode.length,
     contractClass.packedBytecode,
     contractClass.privateFunctionsRoot,
@@ -114,15 +112,15 @@ function serializePrivateFunction(fn: ExecutablePrivateFunctionWithMembershipPro
     fn.bytecode,
     fn.functionMetadataHash,
     fn.artifactMetadataHash,
-    fn.unconstrainedFunctionsArtifactTreeRoot,
+    fn.utilityFunctionsTreeRoot,
     new Vector(fn.privateFunctionTreeSiblingPath),
     fn.privateFunctionTreeLeafIndex,
     new Vector(fn.artifactTreeSiblingPath),
     fn.artifactTreeLeafIndex,
   );
 }
 
-function serializeUnconstrainedFunction(fn: UnconstrainedFunctionWithMembershipProof): Buffer {
+function serializeUtilityFunction(fn: UtilityFunctionWithMembershipProof): Buffer {
   return serializeToBuffer(
     fn.selector,
     fn.bytecode.length,
@@ -142,7 +140,7 @@ function deserializeContractClassPublic(buffer: Buffer): Omit<ContractClassPubli
     version: reader.readUInt8() as 1,
     artifactHash: reader.readObject(Fr),
     privateFunctions: reader.readVector({ fromBuffer: deserializePrivateFunction }),
-    unconstrainedFunctions: reader.readVector({ fromBuffer: deserializeUnconstrainedFunction }),
+    utilityFunctions: reader.readVector({ fromBuffer: deserializeUtilityFunction }),
     packedBytecode: reader.readBuffer(),
     privateFunctionsRoot: reader.readObject(Fr),
   };
@@ -156,15 +154,15 @@ function deserializePrivateFunction(buffer: Buffer | BufferReader): ExecutablePr
     bytecode: reader.readBuffer(),
     functionMetadataHash: reader.readObject(Fr),
     artifactMetadataHash: reader.readObject(Fr),
-    unconstrainedFunctionsArtifactTreeRoot: reader.readObject(Fr),
+    utilityFunctionsTreeRoot: reader.readObject(Fr),
     privateFunctionTreeSiblingPath: reader.readVector(Fr),
     privateFunctionTreeLeafIndex: reader.readNumber(),
     artifactTreeSiblingPath: reader.readVector(Fr),
     artifactTreeLeafIndex: reader.readNumber(),
   };
 }
 
-function deserializeUnconstrainedFunction(buffer: Buffer | BufferReader): UnconstrainedFunctionWithMembershipProof {
+function deserializeUtilityFunction(buffer: Buffer | BufferReader): UtilityFunctionWithMembershipProof {
   const reader = BufferReader.asReader(buffer);
   return {
     selector: reader.readObject(FunctionSelector),

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

@@ -10,7 +10,7 @@ import type {
   ContractInstanceUpdateWithAddress,
   ContractInstanceWithAddress,
   ExecutablePrivateFunctionWithMembershipProof,
-  UnconstrainedFunctionWithMembershipProof,
+  UtilityFunctionWithMembershipProof,
 } from '@aztec/stdlib/contract';
 import type { GetContractClassLogsResponse, GetPublicLogsResponse } from '@aztec/stdlib/interfaces/client';
 import { type LogFilter, PrivateLog, type TxScopedL2Log } from '@aztec/stdlib/logs';
@@ -117,9 +117,9 @@ export class KVArchiverDataStore implements ArchiverDataStore {
   addFunctions(
     contractClassId: Fr,
     privateFunctions: ExecutablePrivateFunctionWithMembershipProof[],
-    unconstrainedFunctions: UnconstrainedFunctionWithMembershipProof[],
+    utilityFunctions: UtilityFunctionWithMembershipProof[],
   ): Promise<boolean> {
-    return this.#contractClassStore.addFunctions(contractClassId, privateFunctions, unconstrainedFunctions);
+    return this.#contractClassStore.addFunctions(contractClassId, privateFunctions, utilityFunctions);
   }
 
   async addContractInstances(data: ContractInstanceWithAddress[], _blockNumber: number): Promise<boolean> {

yarn-project/archiver/src/factory.ts

@@ -74,7 +74,7 @@ async function registerProtocolContracts(store: KVArchiverDataStore) {
     const contractClassPublic: ContractClassPublic = {
       ...contract.contractClass,
       privateFunctions: [],
-      unconstrainedFunctions: [],
+      utilityFunctions: [],
     };
 
     const publicFunctionSignatures = contract.artifact.functions

yarn-project/aztec.js/src/api/deployment.ts

@@ -1,4 +1,4 @@
 export { registerContractClass } from '../deployment/register_class.js';
-export { broadcastPrivateFunction, broadcastUnconstrainedFunction } from '../deployment/broadcast_function.js';
+export { broadcastPrivateFunction, broadcastUtilityFunction } from '../deployment/broadcast_function.js';
 export { deployInstance } from '../deployment/deploy_instance.js';
 export { ContractDeployer } from '../deployment/contract_deployer.js';

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

@@ -68,7 +68,7 @@ export abstract class BaseContractInteraction {
   // docs:start:send
   /**
    * Sends a transaction to the contract function with the specified options.
-   * This function throws an error if called on an unconstrained function.
+   * This function throws an error if called on a utility function.
    * It creates and signs the transaction if necessary, and returns a SentTx instance,
    * which can be used to track the transaction status, receipt, and events.
    * @param options - An optional object containing 'from' property representing

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

@@ -47,26 +47,26 @@ export class BatchCall extends BaseContractInteraction {
    * Simulate a transaction and get its return values
    * Differs from prove in a few important ways:
    * 1. It returns the values of the function execution
-   * 2. It supports `unconstrained`, `private` and `public` functions
+   * 2. It supports `utility`, `private` and `public` functions
    *
    * @param options - An optional object containing additional configuration for the transaction.
    * @returns The result of the transaction as returned by the contract function.
    */
   public async simulate(options: SimulateMethodOptions = {}): Promise<any> {
-    const { indexedExecutionPayloads, unconstrained } = (await this.getRequests()).reduce<{
+    const { indexedExecutionPayloads, utility } = (await this.getRequests()).reduce<{
       /** Keep track of the number of private calls to retrieve the return values */
       privateIndex: 0;
       /** Keep track of the number of public calls to retrieve the return values */
       publicIndex: 0;
       /** The public and private function execution requests in the batch */
       indexedExecutionPayloads: [ExecutionPayload, number, number][];
-      /** The unconstrained function calls in the batch. */
-      unconstrained: [FunctionCall, number][];
+      /** The utility function calls in the batch. */
+      utility: [FunctionCall, number][];
     }>(
       (acc, current, index) => {
         const call = current.calls[0];
-        if (call.type === FunctionType.UNCONSTRAINED) {
-          acc.unconstrained.push([call, index]);
+        if (call.type === FunctionType.UTILITY) {
+          acc.utility.push([call, index]);
         } else {
           acc.indexedExecutionPayloads.push([
             current,
@@ -76,7 +76,7 @@ export class BatchCall extends BaseContractInteraction {
         }
         return acc;
       },
-      { indexedExecutionPayloads: [], unconstrained: [], publicIndex: 0, privateIndex: 0 },
+      { indexedExecutionPayloads: [], utility: [], publicIndex: 0, privateIndex: 0 },
     );
 
     const payloads = indexedExecutionPayloads.map(([request]) => request);
@@ -91,22 +91,22 @@ export class BatchCall extends BaseContractInteraction {
     const fee = await this.getFeeOptions(requestWithoutFee, userFee, {});
     const txRequest = await this.wallet.createTxExecutionRequest(requestWithoutFee, fee, { nonce, cancellable });
 
-    const unconstrainedCalls = unconstrained.map(
+    const utilityCalls = utility.map(
       async ([call, index]) =>
         [
-          await this.wallet.simulateUnconstrained(call.name, call.args, call.to, options?.authWitnesses, options?.from),
+          await this.wallet.simulateUtility(call.name, call.args, call.to, options?.authWitnesses, options?.from),
           index,
         ] as const,
     );
 
-    const [unconstrainedResults, simulatedTx] = await Promise.all([
-      Promise.all(unconstrainedCalls),
+    const [utilityResults, simulatedTx] = await Promise.all([
+      Promise.all(utilityCalls),
       this.wallet.simulateTx(txRequest, true, options?.from, options?.skipTxValidation),
     ]);
 
     const results: any[] = [];
 
-    unconstrainedResults.forEach(([result, index]) => {
+    utilityResults.forEach(([result, index]) => {
       results[index] = result;
     });
     indexedExecutionPayloads.forEach(([request, callIndex, resultIndex]) => {