@aztec/aztec.js 0.0.1-commit.b655e406 → 0.0.1-commit.c0b82b2

package/src/api/wallet.ts

@@ -1,8 +1,7 @@
 export {
   type Aliased,
-  type ContractInstanceAndArtifact,
-  type UserFeeOptions,
   type SimulateOptions,
+  type ExecuteUtilityOptions,
   type ProfileOptions,
   type SendOptions,
   type BatchableMethods,
@@ -11,24 +10,68 @@ export {
   type BatchedMethodResultWrapper,
   type BatchResults,
   type Wallet,
-  ContractInstantiationDataSchema,
-  FunctionCallSchema,
+  type PrivateEvent,
+  type PrivateEventFilter,
+  type PublicEvent,
+  type PublicEventFilter,
+  type ContractMetadata,
+  type ContractClassMetadata,
+  AppCapabilitiesSchema,
+  WalletCapabilitiesSchema,
   ExecutionPayloadSchema,
-  UserFeeOptionsSchema,
+  GasSettingsOptionSchema,
   WalletSimulationFeeOptionSchema,
+  WaitOptsSchema,
   SendOptionsSchema,
   SimulateOptionsSchema,
   ProfileOptionsSchema,
-  InstanceDataSchema,
   MessageHashOrIntentSchema,
   BatchedMethodSchema,
-  ContractMetadataSchema,
-  ContractClassMetadataSchema,
   EventMetadataDefinitionSchema,
+  PrivateEventSchema,
+  PrivateEventFilterSchema,
+  PublicEventSchema,
+  PublicEventFilterSchema,
+  ContractClassMetadataSchema,
+  ContractMetadataSchema,
   WalletSchema,
+  ContractFunctionPatternSchema,
+  AccountsCapabilitySchema,
+  GrantedAccountsCapabilitySchema,
+  ContractsCapabilitySchema,
+  GrantedContractsCapabilitySchema,
+  ContractClassesCapabilitySchema,
+  GrantedContractClassesCapabilitySchema,
+  SimulationCapabilitySchema,
+  GrantedSimulationCapabilitySchema,
+  TransactionCapabilitySchema,
+  GrantedTransactionCapabilitySchema,
+  DataCapabilitySchema,
+  GrantedDataCapabilitySchema,
+  CapabilitySchema,
+  GrantedCapabilitySchema,
 } from '../wallet/wallet.js';
 
-export { type FeeOptions, BaseWallet } from '../wallet/base_wallet.js';
+export {
+  type AppCapabilities,
+  type WalletCapabilities,
+  CAPABILITY_VERSION,
+  type Capability,
+  type GrantedCapability,
+  type ContractFunctionPattern,
+  type AccountsCapability,
+  type GrantedAccountsCapability,
+  type ContractsCapability,
+  type GrantedContractsCapability,
+  type ContractClassesCapability,
+  type GrantedContractClassesCapability,
+  type SimulationCapability,
+  type GrantedSimulationCapability,
+  type TransactionCapability,
+  type GrantedTransactionCapability,
+  type DataCapability,
+  type GrantedDataCapability,
+} from '../wallet/capabilities.js';
 
 export { AccountManager } from '../wallet/account_manager.js';
 

package/src/authorization/call_authorization_request.ts

@@ -1,4 +1,4 @@
-import type { Fr } from '@aztec/foundation/fields';
+import type { Fr } from '@aztec/foundation/curves/bn254';
 import { FieldReader } from '@aztec/foundation/serialize';
 import { AuthorizationSelector, FunctionSelector } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';

package/src/contract/base_contract_interaction.ts

@@ -1,11 +1,16 @@
-import type { ExecutionPayload } from '@aztec/entrypoints/payload';
 import { createLogger } from '@aztec/foundation/log';
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
-import type { Capsule } from '@aztec/stdlib/tx';
+import type { Capsule, ExecutionPayload, TxReceipt } from '@aztec/stdlib/tx';
 
 import type { Wallet } from '../wallet/wallet.js';
-import { type RequestInteractionOptions, type SendInteractionOptions, toSendOptions } from './interaction_options.js';
-import { SentTx } from './sent_tx.js';
+import {
+  type InteractionWaitOptions,
+  type RequestInteractionOptions,
+  type SendInteractionOptions,
+  type SendInteractionOptionsWithoutWait,
+  type SendReturn,
+  toSendOptions,
+} from './interaction_options.js';
 
 /**
  * Base class for an interaction with a contract, be it a deployment, a function call, or a batch.
@@ -31,20 +36,26 @@ 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 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.
+   * By default, waits for the transaction to be mined and returns the receipt (or custom type).
    * @param options - An object containing 'from' property representing
-   * the AztecAddress of the sender and optional fee configuration
-   * @returns A SentTx instance for tracking the transaction status and information.
+   * the AztecAddress of the sender, optional fee configuration, and optional wait settings
+   * @returns TReturn (if wait is undefined/WaitOpts) or TxHash (if wait is NO_WAIT)
    */
-  public send(options: SendInteractionOptions): SentTx {
+  // Overload for when wait is not specified at all - returns TReturn
+  public send<TReturn = TxReceipt>(options: SendInteractionOptionsWithoutWait): Promise<TReturn>;
+  // Generic overload for explicit wait values
+  // eslint-disable-next-line jsdoc/require-jsdoc
+  public send<TReturn = TxReceipt, W extends InteractionWaitOptions = undefined>(
+    options: SendInteractionOptions<W>,
+  ): Promise<SendReturn<W, TReturn>>;
+  // eslint-disable-next-line jsdoc/require-jsdoc
+  public async send<TReturn = TxReceipt>(
+    options: SendInteractionOptions<InteractionWaitOptions>,
+  ): Promise<SendReturn<typeof options.wait, TReturn>> {
     // docs:end:send
-    const sendTx = async () => {
-      const executionPayload = await this.request(options);
-      const sendOptions = await toSendOptions(options);
-      return this.wallet.sendTx(executionPayload, sendOptions);
-    };
-    return new SentTx(this.wallet, sendTx);
+    const executionPayload = await this.request(options);
+    const sendOptions = toSendOptions(options);
+
+    return (await this.wallet.sendTx(executionPayload, sendOptions as any)) as SendReturn<typeof options.wait, TReturn>;
   }
 }

package/src/contract/batch_call.ts

@@ -1,7 +1,7 @@
-import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/entrypoints/payload';
 import { type FunctionCall, FunctionType, decodeFromAbi } from '@aztec/stdlib/abi';
+import { ExecutionPayload, TxSimulationResult, UtilityExecutionResult, mergeExecutionPayloads } from '@aztec/stdlib/tx';
 
-import type { Wallet } from '../wallet/wallet.js';
+import type { BatchedMethod, Wallet } from '../wallet/wallet.js';
 import { BaseContractInteraction } from './base_contract_interaction.js';
 import {
   type RequestInteractionOptions,
@@ -10,6 +10,7 @@ import {
 } from './interaction_options.js';
 
 /** A batch of function calls to be sent as a single transaction through a wallet. */
+// docs:start:batch_call_class
 export class BatchCall extends BaseContractInteraction {
   constructor(
     wallet: Wallet,
@@ -17,6 +18,7 @@ export class BatchCall extends BaseContractInteraction {
   ) {
     super(wallet);
   }
+  // docs:end:batch_call_class
 
   /**
    * Returns an execution request that represents this operation.
@@ -35,13 +37,12 @@ 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 `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.
+   * Simulates/executes the batch, supporting private, public and utility functions. Although this is a single
+   * interaction with the wallet, private and public functions will be grouped into a single ExecutionPayload
+   * that the wallet will simulate as a single transaction. Utility function calls will be executed
+   * one by one.
+   * @param options - An optional object containing additional configuration for the interaction.
+   * @returns The results of all the interactions that make up the batch
    */
   public async simulate(options: SimulateInteractionOptions): Promise<any> {
     const { indexedExecutionPayloads, utility } = (await this.getExecutionPayloads()).reduce<{
@@ -70,52 +71,65 @@ export class BatchCall extends BaseContractInteraction {
       { indexedExecutionPayloads: [], utility: [], publicIndex: 0, privateIndex: 0 },
     );
 
-    const payloads = indexedExecutionPayloads.map(([request]) => request);
-    const combinedPayload = mergeExecutionPayloads(payloads);
-    const executionPayload = new ExecutionPayload(
-      combinedPayload.calls,
-      combinedPayload.authWitnesses.concat(options.authWitnesses ?? []),
-      combinedPayload.capsules.concat(options.capsules ?? []),
-      combinedPayload.extraHashedArgs,
-    );
+    const batchRequests: BatchedMethod[] = [];
 
-    const utilityBatchPromise =
-      utility.length > 0
-        ? this.wallet.batch(
-            utility.map(([call]) => ({
-              name: 'simulateUtility' as const,
-              args: [call.name, call.args, call.to, options?.authWitnesses] as const,
-            })),
-          )
-        : Promise.resolve([]);
+    // Add utility calls to batch
+    for (const [call] of utility) {
+      batchRequests.push({
+        name: 'executeUtility' as const,
+        args: [call, { scope: options.from, authWitnesses: options.authWitnesses }],
+      });
+    }
 
-    const [utilityBatchResults, simulatedTx] = await Promise.all([
-      utilityBatchPromise,
-      indexedExecutionPayloads.length > 0
-        ? this.wallet.simulateTx(executionPayload, await toSimulateOptions(options))
-        : Promise.resolve(),
-    ]);
+    // Add tx simulation to batch if there are any private/public calls
+    if (indexedExecutionPayloads.length > 0) {
+      const payloads = indexedExecutionPayloads.map(([request]) => request);
+      const combinedPayload = mergeExecutionPayloads(payloads);
+      const executionPayload = new ExecutionPayload(
+        combinedPayload.calls,
+        combinedPayload.authWitnesses.concat(options.authWitnesses ?? []),
+        combinedPayload.capsules.concat(options.capsules ?? []),
+        combinedPayload.extraHashedArgs,
+      );
+
+      batchRequests.push({
+        name: 'simulateTx' as const,
+        args: [executionPayload, toSimulateOptions(options)],
+      });
+    }
+
+    const batchResults = batchRequests.length > 0 ? await this.wallet.batch(batchRequests) : [];
 
     const results: any[] = [];
 
-    utilityBatchResults.forEach((wrappedResult, utilityIndex) => {
-      const [, originalIndex] = utility[utilityIndex];
-      results[originalIndex] = wrappedResult.result.result;
-    });
+    // Process utility results (they come first in batch results)
+    for (let i = 0; i < utility.length; i++) {
+      const [call, resultIndex] = utility[i];
+      const wrappedResult = batchResults[i];
+      if (wrappedResult.name === 'executeUtility') {
+        const rawReturnValues = (wrappedResult.result as UtilityExecutionResult).result;
+        results[resultIndex] = rawReturnValues ? decodeFromAbi(call.returnTypes, rawReturnValues) : [];
+      }
+    }
 
-    if (simulatedTx) {
-      indexedExecutionPayloads.forEach(([request, callIndex, resultIndex]) => {
-        const call = request.calls[0];
-        // As account entrypoints are private, for private functions we retrieve the return values from the first nested call
-        // since we're interested in the first set of values AFTER the account entrypoint
-        // For public functions we retrieve the first values directly from the public output.
-        const rawReturnValues =
-          call.type == FunctionType.PRIVATE
-            ? simulatedTx.getPrivateReturnValues()?.nested?.[resultIndex].values
-            : simulatedTx.getPublicReturnValues()?.[resultIndex].values;
+    // Process tx simulation result (it comes last if present)
+    if (indexedExecutionPayloads.length > 0) {
+      const txResultWrapper = batchResults[utility.length];
+      if (txResultWrapper.name === 'simulateTx') {
+        const simulatedTx = txResultWrapper.result as TxSimulationResult;
+        indexedExecutionPayloads.forEach(([request, callIndex, resultIndex]) => {
+          const call = request.calls[0];
+          // As account entrypoints are private, for private functions we retrieve the return values from the first nested call
+          // since we're interested in the first set of values AFTER the account entrypoint
+          // For public functions we retrieve the first values directly from the public output.
+          const rawReturnValues =
+            call.type == FunctionType.PRIVATE
+              ? simulatedTx.getPrivateReturnValues()?.nested?.[resultIndex].values
+              : simulatedTx.getPublicReturnValues()?.[resultIndex].values;
 
-        results[callIndex] = rawReturnValues ? decodeFromAbi(call.returnTypes, rawReturnValues) : [];
-      });
+          results[callIndex] = rawReturnValues ? decodeFromAbi(call.returnTypes, rawReturnValues) : [];
+        });
+      }
     }
 
     return results;

package/src/contract/contract.ts

@@ -1,5 +1,6 @@
 import type { ContractArtifact } from '@aztec/stdlib/abi';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
 import { PublicKeys } from '@aztec/stdlib/keys';
 
 import type { Wallet } from '../wallet/wallet.js';
@@ -21,9 +22,8 @@ export class Contract extends ContractBase {
    * @param wallet - The wallet to use when interacting with the contract.
    * @returns A promise that resolves to a new Contract instance.
    */
-  public static async at(address: AztecAddress, artifact: ContractArtifact, wallet: Wallet): Promise<Contract> {
-    const instance = await wallet.registerContract(address, artifact);
-    return new Contract(instance, artifact, wallet);
+  public static at(address: AztecAddress, artifact: ContractArtifact, wallet: Wallet): Contract {
+    return new Contract(address, artifact, wallet);
   }
 
   /**
@@ -34,7 +34,8 @@ export class Contract extends ContractBase {
    * @param constructorName - The name of the constructor function to call.
    */
   public static deploy(wallet: Wallet, artifact: ContractArtifact, args: any[], constructorName?: string) {
-    const postDeployCtor = (address: AztecAddress, wallet: Wallet) => Contract.at(address, artifact, wallet);
+    const postDeployCtor = (instance: ContractInstanceWithAddress, wallet: Wallet) =>
+      Contract.at(instance.address, artifact, wallet);
     return new DeployMethod(PublicKeys.default(), wallet, artifact, postDeployCtor, args, constructorName);
   }
 
@@ -54,7 +55,8 @@ export class Contract extends ContractBase {
     args: any[],
     constructorName?: string,
   ) {
-    const postDeployCtor = (address: AztecAddress, wallet: Wallet) => Contract.at(address, artifact, wallet);
+    const postDeployCtor = (instance: ContractInstanceWithAddress, wallet: Wallet) =>
+      Contract.at(instance.address, artifact, wallet);
     return new DeployMethod(publicKeys, wallet, artifact, postDeployCtor, args, constructorName);
   }
 }

package/src/contract/contract_base.ts

@@ -5,7 +5,7 @@ import {
   FunctionSelector,
   getAllFunctionAbis,
 } from '@aztec/stdlib/abi';
-import { type ContractInstanceWithAddress, computePartialAddress } from '@aztec/stdlib/contract';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 
 import type { Wallet } from '../wallet/wallet.js';
 import { ContractFunctionInteraction } from './contract_function_interaction.js';
@@ -38,8 +38,8 @@ export class ContractBase {
   public methods: { [name: string]: ContractMethod } = {};
 
   protected constructor(
-    /** The deployed contract instance definition. */
-    public readonly instance: ContractInstanceWithAddress,
+    /** The contract's address. */
+    public readonly address: AztecAddress,
     /** The Application Binary Interface for the contract. */
     public readonly artifact: ContractArtifact,
     /** The wallet used for interacting with this contract. */
@@ -47,7 +47,7 @@ export class ContractBase {
   ) {
     getAllFunctionAbis(artifact).forEach((f: FunctionAbi) => {
       const interactionFunction = (...args: any[]) => {
-        return new ContractFunctionInteraction(this.wallet, this.instance.address, f, args);
+        return new ContractFunctionInteraction(this.wallet, this.address, f, args);
       };
 
       this.methods[f.name] = Object.assign(interactionFunction, {
@@ -62,22 +62,12 @@ export class ContractBase {
     });
   }
 
-  /** Address of the contract. */
-  public get address() {
-    return this.instance.address;
-  }
-
-  /** Partial address of the contract. */
-  public get partialAddress() {
-    return computePartialAddress(this.instance);
-  }
-
   /**
    * Creates a new instance of the contract wrapper attached to a different wallet.
    * @param wallet - Wallet to use for sending txs.
    * @returns A new contract instance.
    */
   public withWallet(wallet: Wallet): this {
-    return new ContractBase(this.instance, this.artifact, wallet) as this;
+    return new ContractBase(this.address, this.artifact, wallet) as this;
   }
 }

package/src/contract/contract_function_interaction.ts

@@ -1,8 +1,15 @@
-import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/entrypoints/payload';
-import { type FunctionAbi, FunctionSelector, FunctionType, decodeFromAbi, encodeArguments } from '@aztec/stdlib/abi';
+import {
+  type FunctionAbi,
+  FunctionCall,
+  FunctionSelector,
+  FunctionType,
+  decodeFromAbi,
+  encodeArguments,
+} from '@aztec/stdlib/abi';
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { type Capsule, type HashedValues, type TxProfileResult, collectOffchainEffects } from '@aztec/stdlib/tx';
+import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
 
 import type { Wallet } from '../wallet/wallet.js';
 import { BaseContractInteraction } from './base_contract_interaction.js';
@@ -43,16 +50,16 @@ export class ContractFunctionInteraction extends BaseContractInteraction {
    */
   public async getFunctionCall() {
     const args = encodeArguments(this.functionDao, this.args);
-    return {
+    return FunctionCall.from({
       name: this.functionDao.name,
-      args,
+      to: this.contractAddress,
       selector: await FunctionSelector.fromNameAndParameters(this.functionDao.name, this.functionDao.parameters),
       type: this.functionDao.functionType,
-      to: this.contractAddress,
-      isStatic: this.functionDao.isStatic,
       hideMsgSender: false /** Only set to `true` for enqueued public function calls */,
+      isStatic: this.functionDao.isStatic,
+      args,
       returnTypes: this.functionDao.returnTypes,
-    };
+    });
   }
 
   /**
@@ -103,25 +110,27 @@ export class ContractFunctionInteraction extends BaseContractInteraction {
   ): Promise<SimulationReturn<typeof options.includeMetadata>> {
     // docs:end:simulate
     if (this.functionDao.functionType == FunctionType.UTILITY) {
-      const utilityResult = await this.wallet.simulateUtility(
-        this.functionDao.name,
-        this.args,
-        this.contractAddress,
-        options.authWitnesses ?? [],
-      );
+      const call = await this.getFunctionCall();
+      const utilityResult = await this.wallet.executeUtility(call, {
+        scope: options.from,
+        authWitnesses: options.authWitnesses,
+      });
+
+      // Decode the raw field elements to the actual return type
+      const returnValue = utilityResult.result ? decodeFromAbi(this.functionDao.returnTypes, utilityResult.result) : [];
 
       if (options.includeMetadata) {
         return {
           stats: utilityResult.stats,
-          result: utilityResult.result,
+          result: returnValue,
         };
       } else {
-        return utilityResult.result;
+        return returnValue;
       }
     }
 
     const executionPayload = await this.request(options);
-    const simulatedTx = await this.wallet.simulateTx(executionPayload, await toSimulateOptions(options));
+    const simulatedTx = await this.wallet.simulateTx(executionPayload, toSimulateOptions(options));
 
     let rawReturnValues;
     if (this.functionDao.functionType == FunctionType.PRIVATE) {
@@ -168,7 +177,7 @@ export class ContractFunctionInteraction extends BaseContractInteraction {
     }
 
     const executionPayload = await this.request(options);
-    return await this.wallet.profileTx(executionPayload, await toProfileOptions(options));
+    return await this.wallet.profileTx(executionPayload, toProfileOptions(options));
   }
 
   /**