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

package/dest/contract/contract_function_interaction.d.ts

@@ -1,30 +1,11 @@
-import { type FunctionAbi, FunctionCall } from '@aztec/stdlib/abi';
+import { ExecutionPayload } from '@aztec/entrypoints/payload';
+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 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

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,gBAAgB,EAA0B,MAAM,4BAA4B,CAAC;AACtF,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;AAEjH,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;gBANvB,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;IAQ9C;;;;OAIG;IACU,eAAe;;;;;;;gCASH,4DAA4D;;;IAKrF;;;;OAIG;IACmB,OAAO,CAAC,OAAO,GAAE,yBAA8B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAmBjG;;;;;;;;;;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;IAE5D,QAAQ,CAAC,CAAC,SAAS,0BAA0B,EACxD,OAAO,EAAE,CAAC,GACT,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC;IA4DlD;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC;IASlF;;;;;;OAMG;IACI,IAAI,CAAC,EACV,aAAkB,EAClB,QAAa,EACb,eAAoB,GACrB,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;CAWhC"}

package/dest/contract/contract_function_interaction.js

@@ -1,7 +1,9 @@
+import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/entrypoints/payload';
 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 { 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,43 @@ 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 utilityResult = await this.wallet.simulateUtility(this.functionDao.name, this.args, this.contractAddress, options.authWitnesses ?? []);
+            if (options.includeMetadata) {
+                return {
+                    stats: utilityResult.stats,
+                    result: utilityResult.result
+                };
+            } else {
+                return utilityResult.result;
+            }
         }
-        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, await toSimulateOptions(options));
         let rawReturnValues;
         if (this.functionDao.functionType == FunctionType.PRIVATE) {
             if (simulatedTx.getPrivateReturnValues().nested.length > 0) {
@@ -95,28 +80,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, await 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));
     }
 }

package/dest/contract/deploy_method.d.ts

@@ -1,113 +1,158 @@
-import type { Fr } from '@aztec/foundation/fields';
+import { ExecutionPayload } from '@aztec/entrypoints/payload';
+import { Fr } from '@aztec/foundation/fields';
 import { type ContractArtifact, type FunctionArtifact } from '@aztec/stdlib/abi';
+import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { type ContractInstanceWithAddress } from '@aztec/stdlib/contract';
-import type { GasSettings } from '@aztec/stdlib/gas';
 import type { PublicKeys } from '@aztec/stdlib/keys';
-import type { TxExecutionRequest } from '@aztec/stdlib/tx';
-import type { Wallet } from '../account/index.js';
-import type { ExecutionRequestInit } from '../entrypoint/entrypoint.js';
-import { BaseContractInteraction, type SendMethodOptions } from './base_contract_interaction.js';
+import { type Capsule, type TxProfileResult } from '@aztec/stdlib/tx';
+import type { Wallet } from '../wallet/wallet.js';
+import { BaseContractInteraction } from './base_contract_interaction.js';
 import type { Contract } from './contract.js';
 import type { ContractBase } from './contract_base.js';
-import { DeployProvenTx } from './deploy_proven_tx.js';
 import { DeploySentTx } from './deploy_sent_tx.js';
+import { type ProfileInteractionOptions, type RequestInteractionOptions, type SendInteractionOptions, type SimulationInteractionFeeOptions, type SimulationReturn } from './interaction_options.js';
 /**
  * Options for deploying a contract on the Aztec network.
- * Allows specifying a contract address salt, and additional send method options.
+ * Allows specifying a contract address salt and different options to tweak contract publication
+ * and initialization
  */
-export type DeployOptions = {
+export type RequestDeployOptions = RequestInteractionOptions & {
     /** An optional salt value used to deterministically calculate the contract address. */
     contractAddressSalt?: Fr;
-    /** Set to true to *not* include the sender in the address computation. */
-    universalDeploy?: boolean;
-    /** Skip contract class registration. */
-    skipClassRegistration?: boolean;
-    /** Skip public deployment, instead just privately initialize the contract. */
-    skipPublicDeployment?: boolean;
+    /**
+     * Deployer address that will be used for the deployed contract's address computation.
+     * If set to 0, the sender's address won't be mixed in
+     */
+    deployer?: AztecAddress;
+    /** Skip contract class publication. */
+    skipClassPublication?: boolean;
+    /** Skip publication, instead just privately initialize the contract. */
+    skipInstancePublication?: boolean;
     /** Skip contract initialization. */
     skipInitialization?: boolean;
-} & SendMethodOptions;
+};
+/**
+ * Extends the deployment options with the required parameters to send the transaction
+ */
+export type DeployOptions = Omit<RequestDeployOptions, 'deployer'> & {
+    /**
+     * Set to true to *not* include the sender in the address computation. This option
+     * is mutually exclusive with "deployer"
+     */
+    universalDeploy?: boolean;
+} & Pick<SendInteractionOptions, 'from' | 'fee'>;
+/**
+ * Options for simulating the deployment of a contract
+ * Allows skipping certain validations and computing gas estimations
+ */
+export type SimulateDeployOptions = Omit<DeployOptions, 'fee'> & {
+    /** The fee options for the transaction. */
+    fee?: SimulationInteractionFeeOptions;
+    /** 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;
+    /** Whether to include metadata such as offchain effects and performance statistics
+     * (e.g. timing information of the different circuits and oracles) in
+     * the simulation result, instead of just the return value of the function */
+    includeMetadata?: boolean;
+};
 /**
- * Contract interaction for deployment. Handles class registration, public instance deployment,
- * and initialization of the contract. Extends the BaseContractInteraction class.
+ * Contract interaction for deployment.
+ * Handles class publication, instance publication, and initialization of the contract.
+ *
+ * Note that for some contracts, a tx is not required as part of its "creation":
+ * If there are no public functions, and if there are no initialization functions,
+ * then technically the contract has already been "created", and all of the contract's
+ * functions (private and utility) can be interacted-with immediately, without any
+ * "deployment tx".
+ *
+ * Extends the BaseContractInteraction class.
  */
 export declare class DeployMethod<TContract extends ContractBase = Contract> extends BaseContractInteraction {
     private publicKeys;
-    private artifact;
-    private postDeployCtor;
+    protected artifact: ContractArtifact;
+    protected postDeployCtor: (address: AztecAddress, wallet: Wallet) => Promise<TContract>;
     private args;
     /** The contract instance to be deployed. */
     private instance?;
     /** Constructor function to call. */
     private constructorArtifact;
-    constructor(publicKeys: PublicKeys, wallet: Wallet, artifact: ContractArtifact, postDeployCtor: (address: AztecAddress, wallet: Wallet) => Promise<TContract>, args?: any[], constructorNameOrArtifact?: string | FunctionArtifact);
+    constructor(publicKeys: PublicKeys, wallet: Wallet, artifact: ContractArtifact, postDeployCtor: (address: AztecAddress, wallet: Wallet) => Promise<TContract>, args?: any[], constructorNameOrArtifact?: string | FunctionArtifact, authWitnesses?: AuthWitness[], capsules?: Capsule[]);
     /**
-     * Create a contract deployment transaction, given the deployment options.
-     * This function internally calls `request()` and `sign()` methods to prepare
-     * the transaction for deployment. The resulting signed transaction can be
-     * later sent using the `send()` method.
-     *
-     * @param options - An object containing optional deployment settings, contractAddressSalt, and from.
-     * @returns A Promise resolving to an object containing the signed transaction data and other relevant information.
+     * Returns the execution payload that allows this operation to happen on chain.
+     * @param options - Configuration options.
+     * @returns The execution payload for this operation
      */
-    create(options?: DeployOptions): Promise<TxExecutionRequest>;
+    request(options?: RequestDeployOptions): Promise<ExecutionPayload>;
+    convertDeployOptionsToRequestOptions(options: DeployOptions): RequestDeployOptions;
     /**
-     * Returns an array of function calls that represent this operation. Useful as a building
-     * block for constructing batch requests.
+     * Adds this contract to the wallet and returns the Contract object.
      * @param options - Deployment options.
-     * @returns An array of function calls.
-     * @remarks This method does not have the same return type as the `request` in the ContractInteraction object,
-     * it returns a promise for an array instead of a function call directly.
      */
-    request(options?: DeployOptions): Promise<ExecutionRequestInit>;
+    register(options?: RequestDeployOptions): Promise<TContract>;
     /**
-     * Register this contract in the PXE and returns the Contract object.
-     * @param options - Deployment options.
-     */
-    register(options?: DeployOptions): Promise<TContract>;
-    /**
-     * Returns calls for registration of the class and deployment of the instance, depending on the provided options.
-     * @param options - Deployment options.
-     * @returns A function call array with potentially requests to the class registerer and instance deployer.
+     * Returns an execution payload for:
+     * - publication of the contract class and
+     * - publication of the contract instance to enable public execution
+     * depending on the provided options.
+     * @param options - Contract creation options.
+     * @returns An execution payload with potentially calls (and bytecode capsule) to the class registry and instance registry.
      */
-    protected getDeploymentFunctionCalls(options?: DeployOptions): Promise<Pick<ExecutionRequestInit, 'calls' | 'authWitnesses' | 'hashedArguments' | 'capsules'>>;
+    protected getPublicationExecutionPayload(options?: RequestDeployOptions): Promise<ExecutionPayload>;
     /**
      * Returns the calls necessary to initialize the contract.
      * @param options - Deployment options.
      * @returns - An array of function calls.
      */
-    protected getInitializeFunctionCalls(options: DeployOptions): Promise<Pick<ExecutionRequestInit, 'calls' | 'authWitnesses' | 'hashedArguments' | 'capsules'>>;
+    protected getInitializationExecutionPayload(options?: RequestDeployOptions): Promise<ExecutionPayload>;
     /**
-     * Send the contract deployment transaction using the provided options.
+     * Send a contract deployment transaction (initialize and/or publish) using the provided options.
      * This function extends the 'send' method from the ContractFunctionInteraction class,
      * allowing us to send a transaction specifically for contract deployment.
      *
      * @param options - An object containing various deployment options such as contractAddressSalt and from.
      * @returns A SentTx object that returns the receipt and the deployed contract instance.
      */
-    send(options?: DeployOptions): DeploySentTx<TContract>;
+    send(options: DeployOptions): DeploySentTx<TContract>;
     /**
-     * Builds the contract instance to be deployed and returns it.
+     * Builds the contract instance and returns it.
      *
-     * @param options - An object containing various deployment options.
+     * @param options - An object containing various initialization and publication options.
      * @returns An instance object.
      */
-    getInstance(options?: DeployOptions): Promise<ContractInstanceWithAddress>;
+    getInstance(options?: RequestDeployOptions): Promise<ContractInstanceWithAddress>;
     /**
-     * Prove the request.
-     * @param options - Deployment options.
-     * @returns The proven tx.
+     * Simulate the deployment
+     *
+     * @param options - An optional object containing additional configuration for the simulation.
+     * @returns A simulation result object containing metadata of the execution, including gas
+     * estimations (if requested via options), execution statistics and emitted offchain effects
      */
-    prove(options: DeployOptions): Promise<DeployProvenTx<TContract>>;
+    simulate(options: SimulateDeployOptions): Promise<SimulationReturn<true>>;
     /**
-     * Estimates gas cost for this deployment operation.
-     * @param options - Options.
+     * Simulate a deployment and profile the gate count for each function in the transaction.
+     * @param options - Same options as `send`, plus extra profiling options.
+     *
+     * @returns An object containing the function return value and profile result.
      */
-    estimateGas(options?: Omit<DeployOptions, 'estimateGas' | 'skipPublicSimulation'>): Promise<Pick<GasSettings, 'gasLimits' | 'teardownGasLimits'>>;
+    profile(options: DeployOptions & ProfileInteractionOptions): Promise<TxProfileResult>;
     /** Return this deployment address. */
     get address(): AztecAddress | undefined;
     /** Returns the partial address for this deployment. */
     get partialAddress(): Promise<Fr> | undefined;
+    /**
+     * Augments this DeployMethod with additional metadata, such as authWitnesses and capsules.
+     * @param options - An object containing the metadata to add to the interaction
+     * @returns A new DeployMethod with the added metadata, but calling the same original function in the same manner
+     */
+    with({ authWitnesses, capsules, }: {
+        /** The authWitnesses to add to the deployment */
+        authWitnesses?: AuthWitness[];
+        /** The capsules to add to the deployment */
+        capsules?: Capsule[];
+    }): DeployMethod;
 }
 //# sourceMappingURL=deploy_method.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"deploy_method.d.ts","sourceRoot":"","sources":["../../src/contract/deploy_method.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,gBAAgB,EAAqC,MAAM,mBAAmB,CAAC;AACpH,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EACL,KAAK,2BAA2B,EAIjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,KAAK,EAAW,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEpE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAGlD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,KAAK,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACjG,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD;;;GAGG;AAEH,MAAM,MAAM,aAAa,GAAG;IAC1B,uFAAuF;IACvF,mBAAmB,CAAC,EAAE,EAAE,CAAC;IACzB,0EAA0E;IAC1E,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,wCAAwC;IACxC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,8EAA8E;IAC9E,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,oCAAoC;IACpC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,GAAG,iBAAiB,CAAC;AAItB;;;GAGG;AACH,qBAAa,YAAY,CAAC,SAAS,SAAS,YAAY,GAAG,QAAQ,CAAE,SAAQ,uBAAuB;IAQhG,OAAO,CAAC,UAAU;IAElB,OAAO,CAAC,QAAQ;IAChB,OAAO,CAAC,cAAc;IACtB,OAAO,CAAC,IAAI;IAXd,4CAA4C;IAC5C,OAAO,CAAC,QAAQ,CAAC,CAA0C;IAE3D,oCAAoC;IACpC,OAAO,CAAC,mBAAmB,CAA+B;gBAGhD,UAAU,EAAE,UAAU,EAC9B,MAAM,EAAE,MAAM,EACN,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,EAC7E,IAAI,GAAE,GAAG,EAAO,EACxB,yBAAyB,CAAC,EAAE,MAAM,GAAG,gBAAgB;IAMvD;;;;;;;;OAQG;IACU,MAAM,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAO7E;;;;;;;OAOG;IACU,OAAO,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgChF;;;OAGG;IACU,QAAQ,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;IAMtE;;;;OAIG;cACa,0BAA0B,CACxC,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,OAAO,GAAG,eAAe,GAAG,iBAAiB,GAAG,UAAU,CAAC,CAAC;IA0ClG;;;;OAIG;cACa,0BAA0B,CACxC,OAAO,EAAE,aAAa,GACrB,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,OAAO,GAAG,eAAe,GAAG,iBAAiB,GAAG,UAAU,CAAC,CAAC;IAiBlG;;;;;;;OAOG;IACa,IAAI,CAAC,OAAO,GAAE,aAAkB,GAAG,YAAY,CAAC,SAAS,CAAC;IAM1E;;;;;OAKG;IACU,WAAW,CAAC,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAa3F;;;;OAIG;IACmB,KAAK,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAOvF;;;OAGG;IACa,WAAW,CACzB,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,aAAa,GAAG,sBAAsB,CAAC,GACpE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,mBAAmB,CAAC,CAAC;IAIhE,sCAAsC;IACtC,IAAW,OAAO,6BAEjB;IAED,uDAAuD;IACvD,IAAW,cAAc,4BAExB;CACF"}
+{"version":3,"file":"deploy_method.d.ts","sourceRoot":"","sources":["../../src/contract/deploy_method.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAA0B,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,KAAK,gBAAgB,EAAoB,KAAK,gBAAgB,EAAkB,MAAM,mBAAmB,CAAC;AACnH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EACL,KAAK,2BAA2B,EAIjC,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,eAAe,EAA0B,MAAM,kBAAkB,CAAC;AAI9F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EACL,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,EAC9B,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,KAAK,gBAAgB,EAItB,MAAM,0BAA0B,CAAC;AAElC;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,yBAAyB,GAAG;IAC7D,uFAAuF;IACvF,mBAAmB,CAAC,EAAE,EAAE,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,uCAAuC;IACvC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,wEAAwE;IACxE,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,oCAAoC;IACpC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,GAAG;IACnE;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,GAAG,IAAI,CAAC,sBAAsB,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC;AAIjD;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,aAAa,EAAE,KAAK,CAAC,GAAG;IAC/D,2CAA2C;IAC3C,GAAG,CAAC,EAAE,+BAA+B,CAAC;IACtC;wDACoD;IACpD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,8FAA8F;IAC9F,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;iFAE6E;IAC7E,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,qBAAa,YAAY,CAAC,SAAS,SAAS,YAAY,GAAG,QAAQ,CAAE,SAAQ,uBAAuB;IAQhG,OAAO,CAAC,UAAU;IAElB,SAAS,CAAC,QAAQ,EAAE,gBAAgB;IACpC,SAAS,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC;IACvF,OAAO,CAAC,IAAI;IAXd,4CAA4C;IAC5C,OAAO,CAAC,QAAQ,CAAC,CAA0C;IAE3D,oCAAoC;IACpC,OAAO,CAAC,mBAAmB,CAA0B;gBAG3C,UAAU,EAAE,UAAU,EAC9B,MAAM,EAAE,MAAM,EACJ,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,EAC/E,IAAI,GAAE,GAAG,EAAO,EACxB,yBAAyB,CAAC,EAAE,MAAM,GAAG,gBAAgB,EACrD,aAAa,GAAE,WAAW,EAAO,EACjC,QAAQ,GAAE,OAAO,EAAO;IAM1B;;;;OAIG;IACU,OAAO,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAmB/E,oCAAoC,CAAC,OAAO,EAAE,aAAa,GAAG,oBAAoB;IAOlF;;;OAGG;IACU,QAAQ,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC;IAMzE;;;;;;;OAOG;cACa,8BAA8B,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0CzG;;;;OAIG;cACa,iCAAiC,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAe5G;;;;;;;OAOG;IACa,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,YAAY,CAAC,SAAS,CAAC;IAUrE;;;;;OAKG;IACU,WAAW,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAa9F;;;;;;OAMG;IACU,QAAQ,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAgBtF;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE,aAAa,GAAG,yBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC;IASlG,sCAAsC;IACtC,IAAW,OAAO,6BAEjB;IAED,uDAAuD;IACvD,IAAW,cAAc,4BAExB;IAED;;;;OAIG;IACI,IAAI,CAAC,EACV,aAAkB,EAClB,QAAa,GACd,EAAE;QACD,iDAAiD;QACjD,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;QAC9B,4CAA4C;QAC5C,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;KACtB,GAAG,YAAY;CAYjB"}