@aztec/aztec.js 0.0.0-test.1 → 0.0.1-commit.0b941701

package/dest/contract/contract_base.d.ts

@@ -1,6 +1,6 @@
-import { type ContractArtifact, type ContractNote, type FieldLayout, FunctionSelector } from '@aztec/stdlib/abi';
-import { type ContractInstanceWithAddress } from '@aztec/stdlib/contract';
-import type { Wallet } from '../account/index.js';
+import { type ContractArtifact, type FieldLayout, FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { Wallet } from '../wallet/wallet.js';
 import { ContractFunctionInteraction } from './contract_function_interaction.js';
 /**
  * Type representing a contract method that returns a ContractFunctionInteraction instance
@@ -18,18 +18,12 @@ export type ContractMethod = ((...args: any[]) => ContractFunctionInteraction) &
 export type ContractStorageLayout<T extends string> = {
     [K in T]: FieldLayout;
 };
-/**
- * Type representing the notes used in a contract.
- */
-export type ContractNotes<T extends string> = {
-    [K in T]: ContractNote;
-};
 /**
  * Abstract implementation of a contract extended by the Contract class and generated contract types.
  */
 export declare class ContractBase {
-    /** The deployed contract instance definition. */
-    readonly instance: ContractInstanceWithAddress;
+    /** The contract's address. */
+    readonly address: AztecAddress;
     /** The Application Binary Interface for the contract. */
     readonly artifact: ContractArtifact;
     /** The wallet used for interacting with this contract. */
@@ -41,16 +35,12 @@ export declare class ContractBase {
         [name: string]: ContractMethod;
     };
     protected constructor(
-    /** The deployed contract instance definition. */
-    instance: ContractInstanceWithAddress, 
+    /** The contract's address. */
+    address: AztecAddress, 
     /** The Application Binary Interface for the contract. */
     artifact: ContractArtifact, 
     /** The wallet used for interacting with this contract. */
     wallet: Wallet);
-    /** Address of the contract. */
-    get address(): import("@aztec/stdlib/aztec-address").AztecAddress;
-    /** Partial address of the contract. */
-    get partialAddress(): Promise<import("@aztec/foundation/schemas").Fr>;
     /**
      * Creates a new instance of the contract wrapper attached to a different wallet.
      * @param wallet - Wallet to use for sending txs.
@@ -58,4 +48,4 @@ export declare class ContractBase {
      */
     withWallet(wallet: Wallet): this;
 }
-//# sourceMappingURL=contract_base.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3RfYmFzZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbnRyYWN0L2NvbnRyYWN0X2Jhc2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUNMLEtBQUssZ0JBQWdCLEVBQ3JCLEtBQUssV0FBVyxFQUVoQixnQkFBZ0IsRUFFakIsTUFBTSxtQkFBbUIsQ0FBQztBQUMzQixPQUFPLEtBQUssRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUVoRSxPQUFPLEtBQUssRUFBRSxNQUFNLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUNsRCxPQUFPLEVBQUUsMkJBQTJCLEVBQUUsTUFBTSxvQ0FBb0MsQ0FBQztBQUVqRjs7O0dBR0c7QUFDSCxNQUFNLE1BQU0sY0FBYyxHQUFHLENBQUMsQ0FBQyxHQUFHLElBQUksRUFBRSxHQUFHLEVBQUUsS0FBSywyQkFBMkIsQ0FBQyxHQUFHO0lBQy9FOztPQUVHO0lBQ0gsUUFBUSxFQUFFLE1BQU0sT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUM7Q0FDM0MsQ0FBQztBQUVGOztHQUVHO0FBQ0gsTUFBTSxNQUFNLHFCQUFxQixDQUFDLENBQUMsU0FBUyxNQUFNLElBQUk7S0FDbkQsQ0FBQyxJQUFJLENBQUMsR0FBRyxXQUFXO0NBQ3RCLENBQUM7QUFFRjs7R0FFRztBQUNILHFCQUFhLFlBQVk7SUFPckIsOEJBQThCO2FBQ2QsT0FBTyxFQUFFLFlBQVk7SUFDckMseURBQXlEO2FBQ3pDLFFBQVEsRUFBRSxnQkFBZ0I7SUFDMUMsMERBQTBEO0lBQ25ELE1BQU0sRUFBRSxNQUFNO0lBWHZCOztPQUVHO0lBQ0ksT0FBTyxFQUFFO1FBQUUsQ0FBQyxJQUFJLEVBQUUsTUFBTSxHQUFHLGNBQWMsQ0FBQTtLQUFFLENBQU07SUFFeEQsU0FBUztJQUNQLDhCQUE4QjtJQUNkLE9BQU8sRUFBRSxZQUFZO0lBQ3JDLHlEQUF5RDtJQUN6QyxRQUFRLEVBQUUsZ0JBQWdCO0lBQzFDLDBEQUEwRDtJQUNuRCxNQUFNLEVBQUUsTUFBTSxFQWlCdEI7SUFFRDs7OztPQUlHO0lBQ0ksVUFBVSxDQUFDLE1BQU0sRUFBRSxNQUFNLEdBQUcsSUFBSSxDQUV0QztDQUNGIn0=

package/dest/contract/contract_base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contract_base.d.ts","sourceRoot":"","sources":["../../src/contract/contract_base.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,YAAY,EACjB,KAAK,WAAW,EAEhB,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,KAAK,2BAA2B,EAAyB,MAAM,wBAAwB,CAAC;AAEjG,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,2BAA2B,CAAC,GAAG;IAC/E;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,MAAM,IAAI;KACnD,CAAC,IAAI,CAAC,GAAG,WAAW;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI;KAC3C,CAAC,IAAI,CAAC,GAAG,YAAY;CACvB,CAAC;AAEF;;GAEG;AACH,qBAAa,YAAY;IAOrB,iDAAiD;aACjC,QAAQ,EAAE,2BAA2B;IACrD,yDAAyD;aACzC,QAAQ,EAAE,gBAAgB;IAC1C,0DAA0D;IACnD,MAAM,EAAE,MAAM;IAXvB;;OAEG;IACI,OAAO,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,CAAM;IAExD,SAAS;IACP,iDAAiD;IACjC,QAAQ,EAAE,2BAA2B;IACrD,yDAAyD;IACzC,QAAQ,EAAE,gBAAgB;IAC1C,0DAA0D;IACnD,MAAM,EAAE,MAAM;IAmBvB,+BAA+B;IAC/B,IAAW,OAAO,uDAEjB;IAED,uCAAuC;IACvC,IAAW,cAAc,oDAExB;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAGxC"}
+{"version":3,"file":"contract_base.d.ts","sourceRoot":"","sources":["../../src/contract/contract_base.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,WAAW,EAEhB,gBAAgB,EAEjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEjF;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,2BAA2B,CAAC,GAAG;IAC/E;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,MAAM,IAAI;KACnD,CAAC,IAAI,CAAC,GAAG,WAAW;CACtB,CAAC;AAEF;;GAEG;AACH,qBAAa,YAAY;IAOrB,8BAA8B;aACd,OAAO,EAAE,YAAY;IACrC,yDAAyD;aACzC,QAAQ,EAAE,gBAAgB;IAC1C,0DAA0D;IACnD,MAAM,EAAE,MAAM;IAXvB;;OAEG;IACI,OAAO,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;KAAE,CAAM;IAExD,SAAS;IACP,8BAA8B;IACd,OAAO,EAAE,YAAY;IACrC,yDAAyD;IACzC,QAAQ,EAAE,gBAAgB;IAC1C,0DAA0D;IACnD,MAAM,EAAE,MAAM,EAiBtB;IAED;;;;OAIG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAEtC;CACF"}

package/dest/contract/contract_base.js

@@ -1,23 +1,22 @@
-import { FunctionSelector } from '@aztec/stdlib/abi';
-import { computePartialAddress } from '@aztec/stdlib/contract';
+import { FunctionSelector, getAllFunctionAbis } from '@aztec/stdlib/abi';
 import { ContractFunctionInteraction } from './contract_function_interaction.js';
 /**
  * Abstract implementation of a contract extended by the Contract class and generated contract types.
  */ export class ContractBase {
-    instance;
+    address;
     artifact;
     wallet;
     /**
    * An object containing contract methods mapped to their respective names.
    */ methods;
-    constructor(/** The deployed contract instance definition. */ instance, /** The Application Binary Interface for the contract. */ artifact, /** The wallet used for interacting with this contract. */ wallet){
-        this.instance = instance;
+    constructor(/** The contract's address. */ address, /** The Application Binary Interface for the contract. */ artifact, /** The wallet used for interacting with this contract. */ wallet){
+        this.address = address;
         this.artifact = artifact;
         this.wallet = wallet;
         this.methods = {};
-        artifact.functions.forEach((f)=>{
+        getAllFunctionAbis(artifact).forEach((f)=>{
             const interactionFunction = (...args)=>{
-                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, {
                 /**
@@ -29,17 +28,11 @@ import { ContractFunctionInteraction } from './contract_function_interaction.js'
             });
         });
     }
-    /** Address of the contract. */ get address() {
-        return this.instance.address;
-    }
-    /** Partial address of the contract. */ 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.
    */ withWallet(wallet) {
-        return new ContractBase(this.instance, this.artifact, wallet);
+        return new ContractBase(this.address, this.artifact, wallet);
     }
 }

package/dest/contract/contract_function_interaction.d.ts

@@ -1,30 +1,11 @@
-import { type FunctionAbi, FunctionCall } from '@aztec/stdlib/abi';
+import { type FunctionAbi, FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
+import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { PrivateKernelProverProfileResult } from '@aztec/stdlib/kernel';
-import type { TxExecutionRequest } from '@aztec/stdlib/tx';
-import type { Wallet } from '../account/wallet.js';
-import { BaseContractInteraction, type SendMethodOptions } from './base_contract_interaction.js';
-export type { SendMethodOptions };
-/**
- * Represents the options for simulating a contract function interaction.
- * Allows specifying the address from which the view method should be called.
- * Disregarded for simulation of public functions
- */
-export type SimulateMethodOptions = Pick<SendMethodOptions, 'fee'> & {
-    /** The sender's Aztec address. */
-    from?: AztecAddress;
-    /** Simulate without checking for the validity of the resulting transaction, e.g. whether it emits any existing nullifiers. */
-    skipTxValidation?: boolean;
-    /** Whether to ensure the fee payer is not empty and has enough balance to pay for the fee. */
-    skipFeeEnforcement?: boolean;
-};
-/**
- * The result of a profile() call.
- */
-export type ProfileResult = PrivateKernelProverProfileResult & {
-    /** The result of the transaction as returned by the contract function. */
-    returnValues: any;
-};
+import { type Capsule, type HashedValues, type TxProfileResult } from '@aztec/stdlib/tx';
+import { ExecutionPayload } from '@aztec/stdlib/tx';
+import type { Wallet } from '../wallet/wallet.js';
+import { BaseContractInteraction } from './base_contract_interaction.js';
+import { type ProfileInteractionOptions, type RequestInteractionOptions, type SimulateInteractionOptions, type SimulationReturn } from './interaction_options.js';
 /**
  * This is the class that is returned when calling e.g. `contract.methods.myMethod(arg0, arg1)`.
  * It contains available interactions one can call on a method, including view.
@@ -33,36 +14,63 @@ export declare class ContractFunctionInteraction extends BaseContractInteraction
     protected contractAddress: AztecAddress;
     protected functionDao: FunctionAbi;
     protected args: any[];
-    constructor(wallet: Wallet, contractAddress: AztecAddress, functionDao: FunctionAbi, args: any[]);
+    private extraHashedArgs;
+    constructor(wallet: Wallet, contractAddress: AztecAddress, functionDao: FunctionAbi, args: any[], authWitnesses?: AuthWitness[], capsules?: Capsule[], extraHashedArgs?: HashedValues[]);
     /**
-     * Create a transaction execution request that represents this call, encoded and authenticated by the
-     * user's wallet, ready to be simulated.
-     * @param opts - An optional object containing additional configuration for the transaction.
-     * @returns A Promise that resolves to a transaction instance.
+     * Returns the encoded function call wrapped by this interaction
+     * Useful when generating authwits
+     * @returns An encoded function call
      */
-    create(opts?: SendMethodOptions): Promise<TxExecutionRequest>;
+    getFunctionCall(): Promise<{
+        name: string;
+        args: import("@aztec/foundation/schemas").Fr[];
+        selector: FunctionSelector;
+        type: FunctionType;
+        to: AztecAddress;
+        isStatic: boolean;
+        hideMsgSender: boolean; /** Only set to `true` for enqueued public function calls */
+        returnTypes: import("@aztec/stdlib/abi").AbiType[];
+    }>;
     /**
-     * Returns an execution request that represents this operation. Useful as a building
-     * block for constructing batch requests.
-     * @returns An execution request wrapped in promise.
+     * Returns the execution payload that allows this operation to happen on chain.
+     * @param options - Configuration options.
+     * @returns The execution payload for this operation
      */
-    request(): Promise<FunctionCall>;
+    request(options?: RequestInteractionOptions): Promise<ExecutionPayload>;
     /**
-     * Simulate a transaction and get its return values
+     * Simulate a transaction and get information from its execution.
      * 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
+     * 1. It returns the values of the function execution, plus additional metadata if requested
+     * 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.
+     * @param options - An optional object containing additional configuration for the simulation.
+     * @returns Depending on the simulation options, this method directly returns the result value of the executed
+     * function or a rich object containing extra metadata, such as estimated gas costs (if requested via options),
+     * execution statistics and emitted offchain effects
      */
-    simulate(options?: SimulateMethodOptions): Promise<any>;
+    simulate<T extends SimulateInteractionOptions>(options: T): Promise<SimulationReturn<Exclude<T['fee'], undefined>['estimateGas']>>;
+    simulate<T extends SimulateInteractionOptions>(options: T): Promise<SimulationReturn<T['includeMetadata']>>;
     /**
      * Simulate a transaction and profile the gate count for each function in the transaction.
-     * @param options - Same options as `simulate`.
+     * @param options - Same options as `simulate`, plus profiling method
      *
      * @returns An object containing the function return value and profile result.
      */
-    simulateWithProfile(options?: SimulateMethodOptions): Promise<ProfileResult>;
+    profile(options: ProfileInteractionOptions): Promise<TxProfileResult>;
+    /**
+     * Augments this ContractFunctionInteraction with additional metadata, such as authWitnesses, capsules, and extraHashedArgs.
+     * This is useful when creating a "batteries included" interaction, such as registering a contract class with its associated
+     * capsule instead of having the user provide them externally.
+     * @param options - An object containing the metadata to add to the interaction
+     * @returns A new ContractFunctionInteraction with the added metadata, but calling the same original function in the same manner
+     */
+    with({ authWitnesses, capsules, extraHashedArgs }: {
+        /** The authWitnesses to add to the interaction */
+        authWitnesses?: AuthWitness[];
+        /** The capsules to add to the interaction */
+        capsules?: Capsule[];
+        /** The extra hashed args to add to the interaction */
+        extraHashedArgs?: HashedValues[];
+    }): ContractFunctionInteraction;
 }
-//# sourceMappingURL=contract_function_interaction.d.ts.map
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udHJhY3RfZnVuY3Rpb25faW50ZXJhY3Rpb24uZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb250cmFjdC9jb250cmFjdF9mdW5jdGlvbl9pbnRlcmFjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsS0FBSyxXQUFXLEVBQUUsZ0JBQWdCLEVBQUUsWUFBWSxFQUFrQyxNQUFNLG1CQUFtQixDQUFDO0FBQ3JILE9BQU8sS0FBSyxFQUFFLFdBQVcsRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBQzlELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSw2QkFBNkIsQ0FBQztBQUMzRCxPQUFPLEVBQUUsS0FBSyxPQUFPLEVBQUUsS0FBSyxZQUFZLEVBQUUsS0FBSyxlQUFlLEVBQTBCLE1BQU0sa0JBQWtCLENBQUM7QUFDakgsT0FBTyxFQUFFLGdCQUFnQixFQUEwQixNQUFNLGtCQUFrQixDQUFDO0FBRTVFLE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBQ2xELE9BQU8sRUFBRSx1QkFBdUIsRUFBRSxNQUFNLGdDQUFnQyxDQUFDO0FBRXpFLE9BQU8sRUFDTCxLQUFLLHlCQUF5QixFQUM5QixLQUFLLHlCQUF5QixFQUM5QixLQUFLLDBCQUEwQixFQUMvQixLQUFLLGdCQUFnQixFQUd0QixNQUFNLDBCQUEwQixDQUFDO0FBRWxDOzs7R0FHRztBQUNILHFCQUFhLDJCQUE0QixTQUFRLHVCQUF1QjtJQUdwRSxTQUFTLENBQUMsZUFBZSxFQUFFLFlBQVk7SUFDdkMsU0FBUyxDQUFDLFdBQVcsRUFBRSxXQUFXO0lBQ2xDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsR0FBRyxFQUFFO0lBR3JCLE9BQU8sQ0FBQyxlQUFlO0lBUHpCLFlBQ0UsTUFBTSxFQUFFLE1BQU0sRUFDSixlQUFlLEVBQUUsWUFBWSxFQUM3QixXQUFXLEVBQUUsV0FBVyxFQUN4QixJQUFJLEVBQUUsR0FBRyxFQUFFLEVBQ3JCLGFBQWEsR0FBRSxXQUFXLEVBQU8sRUFDakMsUUFBUSxHQUFFLE9BQU8sRUFBTyxFQUNoQixlQUFlLEdBQUUsWUFBWSxFQUFPLEVBTTdDO0lBRUQ7Ozs7T0FJRztJQUNVLGVBQWU7Ozs7Ozs7Z0NBU0gsNERBQTREOztPQUdwRjtJQUVEOzs7O09BSUc7SUFDbUIsT0FBTyxDQUFDLE9BQU8sR0FBRSx5QkFBOEIsR0FBRyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FnQmhHO0lBR0Q7Ozs7Ozs7Ozs7T0FVRztJQUNVLFFBQVEsQ0FBQyxDQUFDLFNBQVMsMEJBQTBCLEVBQ3hELE9BQU8sRUFBRSxDQUFDLEdBQ1QsT0FBTyxDQUFDLGdCQUFnQixDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLEVBQUUsU0FBUyxDQUFDLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBRTdELFFBQVEsQ0FBQyxDQUFDLFNBQVMsMEJBQTBCLEVBQ3hELE9BQU8sRUFBRSxDQUFDLEdBQ1QsT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUMsQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQTJEbkQ7Ozs7O09BS0c7SUFDVSxPQUFPLENBQUMsT0FBTyxFQUFFLHlCQUF5QixHQUFHLE9BQU8sQ0FBQyxlQUFlLENBQUMsQ0FPakY7SUFFRDs7Ozs7O09BTUc7SUFDSSxJQUFJLENBQUMsRUFDVixhQUFrQixFQUNsQixRQUFhLEVBQ2IsZUFBb0IsRUFDckIsRUFBRTtRQUNELGtEQUFrRDtRQUNsRCxhQUFhLENBQUMsRUFBRSxXQUFXLEVBQUUsQ0FBQztRQUM5Qiw2Q0FBNkM7UUFDN0MsUUFBUSxDQUFDLEVBQUUsT0FBTyxFQUFFLENBQUM7UUFDckIsc0RBQXNEO1FBQ3RELGVBQWUsQ0FBQyxFQUFFLFlBQVksRUFBRSxDQUFDO0tBQ2xDLEdBQUcsMkJBQTJCLENBVTlCO0NBQ0YifQ==

package/dest/contract/contract_function_interaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"contract_function_interaction.d.ts","sourceRoot":"","sources":["../../src/contract/contract_function_interaction.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,EAChB,YAAY,EAKb,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAEnD,OAAO,EAAE,uBAAuB,EAAE,KAAK,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAEjG,YAAY,EAAE,iBAAiB,EAAE,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,iBAAiB,EAAE,KAAK,CAAC,GAAG;IACnE,kCAAkC;IAClC,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,8HAA8H;IAC9H,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,8FAA8F;IAC9F,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,gCAAgC,GAAG;IAC7D,0EAA0E;IAC1E,YAAY,EAAE,GAAG,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,uBAAuB;IAGpE,SAAS,CAAC,eAAe,EAAE,YAAY;IACvC,SAAS,CAAC,WAAW,EAAE,WAAW;IAClC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE;gBAHrB,MAAM,EAAE,MAAM,EACJ,eAAe,EAAE,YAAY,EAC7B,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,GAAG,EAAE;IASvB;;;;;OAKG;IACU,MAAM,CAAC,IAAI,GAAE,iBAAsB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAa9E;;;;OAIG;IACU,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC;IAe7C;;;;;;;;OAQG;IACU,QAAQ,CAAC,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,GAAG,CAAC;IAkCxE;;;;;OAKG;IACU,mBAAmB,CAAC,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,aAAa,CAAC;CA0B9F"}
+{"version":3,"file":"contract_function_interaction.d.ts","sourceRoot":"","sources":["../../src/contract/contract_function_interaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,gBAAgB,EAAE,YAAY,EAAkC,MAAM,mBAAmB,CAAC;AACrH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,eAAe,EAA0B,MAAM,kBAAkB,CAAC;AACjH,OAAO,EAAE,gBAAgB,EAA0B,MAAM,kBAAkB,CAAC;AAE5E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAEzE,OAAO,EACL,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,gBAAgB,EAGtB,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,uBAAuB;IAGpE,SAAS,CAAC,eAAe,EAAE,YAAY;IACvC,SAAS,CAAC,WAAW,EAAE,WAAW;IAClC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE;IAGrB,OAAO,CAAC,eAAe;IAPzB,YACE,MAAM,EAAE,MAAM,EACJ,eAAe,EAAE,YAAY,EAC7B,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,GAAG,EAAE,EACrB,aAAa,GAAE,WAAW,EAAO,EACjC,QAAQ,GAAE,OAAO,EAAO,EAChB,eAAe,GAAE,YAAY,EAAO,EAM7C;IAED;;;;OAIG;IACU,eAAe;;;;;;;gCASH,4DAA4D;;OAGpF;IAED;;;;OAIG;IACmB,OAAO,CAAC,OAAO,GAAE,yBAA8B,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAgBhG;IAGD;;;;;;;;;;OAUG;IACU,QAAQ,CAAC,CAAC,SAAS,0BAA0B,EACxD,OAAO,EAAE,CAAC,GACT,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAE7D,QAAQ,CAAC,CAAC,SAAS,0BAA0B,EACxD,OAAO,EAAE,CAAC,GACT,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IA2DnD;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC,CAOjF;IAED;;;;;;OAMG;IACI,IAAI,CAAC,EACV,aAAkB,EAClB,QAAa,EACb,eAAoB,EACrB,EAAE;QACD,kDAAkD;QAClD,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;QAC9B,6CAA6C;QAC7C,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;QACrB,sDAAsD;QACtD,eAAe,CAAC,EAAE,YAAY,EAAE,CAAC;KAClC,GAAG,2BAA2B,CAU9B;CACF"}

package/dest/contract/contract_function_interaction.js

@@ -1,7 +1,9 @@
 import { FunctionSelector, FunctionType, decodeFromAbi, encodeArguments } from '@aztec/stdlib/abi';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { FeeJuicePaymentMethod } from '../fee/fee_juice_payment_method.js';
+import { collectOffchainEffects } from '@aztec/stdlib/tx';
+import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
 import { BaseContractInteraction } from './base_contract_interaction.js';
+import { getGasLimits } from './get_gas_limits.js';
+import { toProfileOptions, toSimulateOptions } from './interaction_options.js';
 /**
  * This is the class that is returned when calling e.g. `contract.methods.myMethod(arg0, arg1)`.
  * It contains available interactions one can call on a method, including view.
@@ -9,48 +11,18 @@ import { BaseContractInteraction } from './base_contract_interaction.js';
     contractAddress;
     functionDao;
     args;
-    constructor(wallet, contractAddress, functionDao, args){
-        super(wallet), this.contractAddress = contractAddress, this.functionDao = functionDao, this.args = args;
+    extraHashedArgs;
+    constructor(wallet, contractAddress, functionDao, args, authWitnesses = [], capsules = [], extraHashedArgs = []){
+        super(wallet, authWitnesses, capsules), this.contractAddress = contractAddress, this.functionDao = functionDao, this.args = args, this.extraHashedArgs = extraHashedArgs;
         if (args.some((arg)=>arg === undefined || arg === null)) {
-            throw new Error('All function interaction arguments must be defined and not null. Received: ' + args);
+            throw new Error(`All function interaction arguments must be defined and not null. Received: ${args}`);
         }
     }
-    // docs:start:create
     /**
-   * Create a transaction execution request that represents this call, encoded and authenticated by the
-   * user's wallet, ready to be simulated.
-   * @param opts - An optional object containing additional configuration for the transaction.
-   * @returns A Promise that resolves to a transaction instance.
-   */ async create(opts = {}) {
-        // docs:end:create
-        if (this.functionDao.functionType === FunctionType.UNCONSTRAINED) {
-            throw new Error("Can't call `create` on an unconstrained function.");
-        }
-        const calls = [
-            await this.request()
-        ];
-        const capsules = this.getCapsules();
-        const fee = await this.getFeeOptions({
-            calls,
-            capsules,
-            ...opts
-        });
-        const { nonce, cancellable } = opts;
-        return await this.wallet.createTxExecutionRequest({
-            calls,
-            fee,
-            nonce,
-            cancellable,
-            capsules
-        });
-    }
-    // docs:start:request
-    /**
-   * Returns an execution request that represents this operation. Useful as a building
-   * block for constructing batch requests.
-   * @returns An execution request wrapped in promise.
-   */ async request() {
-        // docs:end:request
+   * Returns the encoded function call wrapped by this interaction
+   * Useful when generating authwits
+   * @returns An encoded function call
+   */ async getFunctionCall() {
         const args = encodeArguments(this.functionDao, this.args);
         return {
             name: this.functionDao.name,
@@ -59,30 +31,46 @@ import { BaseContractInteraction } from './base_contract_interaction.js';
             type: this.functionDao.functionType,
             to: this.contractAddress,
             isStatic: this.functionDao.isStatic,
+            hideMsgSender: false,
             returnTypes: this.functionDao.returnTypes
         };
     }
-    // docs:start:simulate
     /**
-   * 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
-   *
-   * @param options - An optional object containing additional configuration for the transaction.
-   * @returns The result of the transaction as returned by the contract function.
-   */ async simulate(options = {}) {
+   * Returns the execution payload that allows this operation to happen on chain.
+   * @param options - Configuration options.
+   * @returns The execution payload for this operation
+   */ async request(options = {}) {
+        const calls = [
+            await this.getFunctionCall()
+        ];
+        const { authWitnesses, capsules } = options;
+        const feeExecutionPayload = options.fee?.paymentMethod ? await options.fee.paymentMethod.getExecutionPayload() : undefined;
+        const functionExecutionPayload = new ExecutionPayload(calls, this.authWitnesses.concat(authWitnesses ?? []), this.capsules.concat(capsules ?? []), this.extraHashedArgs);
+        const finalExecutionPayload = feeExecutionPayload ? mergeExecutionPayloads([
+            feeExecutionPayload,
+            functionExecutionPayload
+        ]) : functionExecutionPayload;
+        return finalExecutionPayload;
+    }
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    async simulate(options) {
         // docs:end:simulate
-        if (this.functionDao.functionType == FunctionType.UNCONSTRAINED) {
-            return this.wallet.simulateUnconstrained(this.functionDao.name, this.args, this.contractAddress, options?.from);
+        if (this.functionDao.functionType == FunctionType.UTILITY) {
+            const call = await this.getFunctionCall();
+            const utilityResult = await this.wallet.simulateUtility(call, 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: returnValue
+                };
+            } else {
+                return returnValue;
+            }
         }
-        const fee = options.fee ?? {
-            paymentMethod: new FeeJuicePaymentMethod(AztecAddress.ZERO)
-        };
-        const txRequest = await this.create({
-            fee
-        });
-        const simulatedTx = await this.wallet.simulateTx(txRequest, true, options.from, options.skipTxValidation, options.skipFeeEnforcement ?? true);
+        const executionPayload = await this.request(options);
+        const simulatedTx = await this.wallet.simulateTx(executionPayload, toSimulateOptions(options));
         let rawReturnValues;
         if (this.functionDao.functionType == FunctionType.PRIVATE) {
             if (simulatedTx.getPrivateReturnValues().nested.length > 0) {
@@ -95,28 +83,44 @@ import { BaseContractInteraction } from './base_contract_interaction.js';
             }
         } else {
             // For public functions we retrieve the first values directly from the public output.
-            rawReturnValues = simulatedTx.getPublicReturnValues()?.[0].values;
+            rawReturnValues = simulatedTx.getPublicReturnValues()?.[0]?.values;
+        }
+        const returnValue = rawReturnValues ? decodeFromAbi(this.functionDao.returnTypes, rawReturnValues) : [];
+        if (options.includeMetadata || options.fee?.estimateGas) {
+            const { gasLimits, teardownGasLimits } = getGasLimits(simulatedTx, options.fee?.estimatedGasPadding);
+            this.log.verbose(`Estimated gas limits for tx: DA=${gasLimits.daGas} L2=${gasLimits.l2Gas} teardownDA=${teardownGasLimits.daGas} teardownL2=${teardownGasLimits.l2Gas}`);
+            return {
+                stats: simulatedTx.stats,
+                offchainEffects: collectOffchainEffects(simulatedTx.privateExecutionResult),
+                result: returnValue,
+                estimatedGas: {
+                    gasLimits,
+                    teardownGasLimits
+                }
+            };
+        } else {
+            return returnValue;
         }
-        return rawReturnValues ? decodeFromAbi(this.functionDao.returnTypes, rawReturnValues) : [];
     }
     /**
    * Simulate a transaction and profile the gate count for each function in the transaction.
-   * @param options - Same options as `simulate`.
+   * @param options - Same options as `simulate`, plus profiling method
    *
    * @returns An object containing the function return value and profile result.
-   */ async simulateWithProfile(options = {}) {
-        if (this.functionDao.functionType == FunctionType.UNCONSTRAINED) {
-            throw new Error("Can't profile an unconstrained function.");
+   */ async profile(options) {
+        if (this.functionDao.functionType == FunctionType.UTILITY) {
+            throw new Error("Can't profile a utility function.");
         }
-        const txRequest = await this.create({
-            fee: options.fee
-        });
-        const simulatedTx = await this.wallet.simulateTx(txRequest, true, options?.from, options?.skipTxValidation, undefined, true);
-        const rawReturnValues = this.functionDao.functionType == FunctionType.PRIVATE ? simulatedTx.getPrivateReturnValues().nested?.[0].values : simulatedTx.getPublicReturnValues()?.[0].values;
-        const rawReturnValuesDecoded = rawReturnValues ? decodeFromAbi(this.functionDao.returnTypes, rawReturnValues) : [];
-        return {
-            returnValues: rawReturnValuesDecoded,
-            gateCounts: simulatedTx.profileResult.gateCounts
-        };
+        const executionPayload = await this.request(options);
+        return await this.wallet.profileTx(executionPayload, toProfileOptions(options));
+    }
+    /**
+   * Augments this ContractFunctionInteraction with additional metadata, such as authWitnesses, capsules, and extraHashedArgs.
+   * This is useful when creating a "batteries included" interaction, such as registering a contract class with its associated
+   * capsule instead of having the user provide them externally.
+   * @param options - An object containing the metadata to add to the interaction
+   * @returns A new ContractFunctionInteraction with the added metadata, but calling the same original function in the same manner
+   */ with({ authWitnesses = [], capsules = [], extraHashedArgs = [] }) {
+        return new ContractFunctionInteraction(this.wallet, this.contractAddress, this.functionDao, this.args, this.authWitnesses.concat(authWitnesses), this.capsules.concat(capsules), this.extraHashedArgs.concat(extraHashedArgs));
     }
 }