@aztec/aztec.js 3.0.0-canary.a9708bd → 3.0.0-devnet.2

package/dest/wallet/account_manager.d.ts

@@ -0,0 +1,69 @@
+import { Fr } from '@aztec/foundation/fields';
+import { CompleteAddress, type ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+import type { AccountContract } from '../account/account_contract.js';
+import { AccountWithSecretKey } from '../account/account_with_secret_key.js';
+import type { Salt } from '../account/index.js';
+import type { AccountInterface } from '../account/interface.js';
+import { DeployAccountMethod } from './deploy_account_method.js';
+import type { Wallet } from './wallet.js';
+/**
+ * Manages a user account. Provides methods for calculating the account's address and other related data,
+ * plus a helper to return a preconfigured deploy method.
+ */
+export declare class AccountManager {
+    private wallet;
+    private secretKey;
+    private accountContract;
+    private instance;
+    /**
+     * Contract instantiation salt for the account contract
+     */
+    readonly salt: Salt;
+    private constructor();
+    static create(wallet: Wallet, secretKey: Fr, accountContract: AccountContract, salt?: Salt): Promise<AccountManager>;
+    protected getPublicKeys(): import("@aztec/stdlib/keys").PublicKeys;
+    protected getPublicKeysHash(): Fr | Promise<Fr>;
+    /**
+     * Returns the entrypoint for this account as defined by its account contract.
+     * @returns An entrypoint.
+     */
+    getAccountInterface(): Promise<AccountInterface>;
+    /**
+     * Gets the calculated complete address associated with this account.
+     * Does not require the account to have been published for public execution.
+     * @returns The address, partial address, and encryption public key.
+     */
+    getCompleteAddress(): Promise<CompleteAddress>;
+    /**
+     * Returns the secret key used to derive the rest of the privacy keys for this contract
+     */
+    getSecretKey(): Fr;
+    get address(): import("../api/addresses.js").AztecAddress;
+    /**
+     * Returns the contract instance definition associated with this account.
+     * Does not require the account to have been published for public execution.
+     * @returns ContractInstance instance.
+     */
+    getInstance(): ContractInstanceWithAddress;
+    /**
+     * Returns a Wallet instance associated with this account. Use it to create Contract
+     * instances to be interacted with from this account.
+     * @returns A Wallet instance.
+     */
+    getAccount(): Promise<AccountWithSecretKey>;
+    /**
+     * Returns the account contract that backs this account.
+     * @returns The account contract
+     */
+    getAccountContract(): AccountContract;
+    /**
+     * Returns a preconfigured deploy method that contains all the necessary function
+     * calls to deploy the account contract.
+     */
+    getDeployMethod(): Promise<DeployAccountMethod>;
+    /**
+     * Returns whether this account contract has an initializer function.
+     */
+    hasInitializer(): Promise<boolean>;
+}
+//# sourceMappingURL=account_manager.d.ts.map

package/dest/wallet/account_manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account_manager.d.ts","sourceRoot":"","sources":["../../src/wallet/account_manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EACL,eAAe,EACf,KAAK,2BAA2B,EAEjC,MAAM,wBAAwB,CAAC;AAGhC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C;;;GAGG;AACH,qBAAa,cAAc;IAEvB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,QAAQ;IAChB;;OAEG;aACa,IAAI,EAAE,IAAI;IAR5B,OAAO;WAWM,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,eAAe,EAAE,eAAe,EAAE,IAAI,CAAC,EAAE,IAAI;IAoBhG,SAAS,CAAC,aAAa;IAIvB,SAAS,CAAC,iBAAiB;IAI3B;;;OAGG;IACU,mBAAmB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAM7D;;;;OAIG;IACI,kBAAkB,IAAI,OAAO,CAAC,eAAe,CAAC;IAIrD;;OAEG;IACI,YAAY;IAInB,IAAI,OAAO,+CAEV;IAED;;;;OAIG;IACI,WAAW,IAAI,2BAA2B;IAIjD;;;;OAIG;IACU,UAAU,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAKxD;;;OAGG;IACH,kBAAkB,IAAI,eAAe;IAIrC;;;OAGG;IACU,eAAe,IAAI,OAAO,CAAC,mBAAmB,CAAC;IA0B5D;;OAEG;IACU,cAAc;CAG5B"}

package/dest/wallet/account_manager.js

@@ -0,0 +1,113 @@
+import { Fr } from '@aztec/foundation/fields';
+import { CompleteAddress, getContractInstanceFromInstantiationParams } from '@aztec/stdlib/contract';
+import { deriveKeys } from '@aztec/stdlib/keys';
+import { AccountWithSecretKey } from '../account/account_with_secret_key.js';
+import { Contract } from '../contract/contract.js';
+import { DeployAccountMethod } from './deploy_account_method.js';
+/**
+ * Manages a user account. Provides methods for calculating the account's address and other related data,
+ * plus a helper to return a preconfigured deploy method.
+ */ export class AccountManager {
+    wallet;
+    secretKey;
+    accountContract;
+    instance;
+    salt;
+    constructor(wallet, secretKey, accountContract, instance, /**
+     * Contract instantiation salt for the account contract
+     */ salt){
+        this.wallet = wallet;
+        this.secretKey = secretKey;
+        this.accountContract = accountContract;
+        this.instance = instance;
+        this.salt = salt;
+    }
+    static async create(wallet, secretKey, accountContract, salt) {
+        const { publicKeys } = await deriveKeys(secretKey);
+        salt = salt !== undefined ? new Fr(salt) : Fr.random();
+        const { constructorName, constructorArgs } = await accountContract.getInitializationFunctionAndArgs() ?? {
+            constructorName: undefined,
+            constructorArgs: undefined
+        };
+        const artifact = await accountContract.getContractArtifact();
+        const instance = await getContractInstanceFromInstantiationParams(artifact, {
+            constructorArtifact: constructorName,
+            constructorArgs,
+            salt: salt,
+            publicKeys
+        });
+        return new AccountManager(wallet, secretKey, accountContract, instance, salt);
+    }
+    getPublicKeys() {
+        return this.instance.publicKeys;
+    }
+    getPublicKeysHash() {
+        return this.getPublicKeys().hash();
+    }
+    /**
+   * Returns the entrypoint for this account as defined by its account contract.
+   * @returns An entrypoint.
+   */ async getAccountInterface() {
+        const chainInfo = await this.wallet.getChainInfo();
+        const completeAddress = await this.getCompleteAddress();
+        return this.accountContract.getInterface(completeAddress, chainInfo);
+    }
+    /**
+   * Gets the calculated complete address associated with this account.
+   * Does not require the account to have been published for public execution.
+   * @returns The address, partial address, and encryption public key.
+   */ getCompleteAddress() {
+        return CompleteAddress.fromSecretKeyAndInstance(this.secretKey, this.instance);
+    }
+    /**
+   * Returns the secret key used to derive the rest of the privacy keys for this contract
+   */ getSecretKey() {
+        return this.secretKey;
+    }
+    get address() {
+        return this.instance.address;
+    }
+    /**
+   * Returns the contract instance definition associated with this account.
+   * Does not require the account to have been published for public execution.
+   * @returns ContractInstance instance.
+   */ getInstance() {
+        return this.instance;
+    }
+    /**
+   * Returns a Wallet instance associated with this account. Use it to create Contract
+   * instances to be interacted with from this account.
+   * @returns A Wallet instance.
+   */ async getAccount() {
+        const accountInterface = await this.getAccountInterface();
+        return new AccountWithSecretKey(accountInterface, this.secretKey, this.salt);
+    }
+    /**
+   * Returns the account contract that backs this account.
+   * @returns The account contract
+   */ getAccountContract() {
+        return this.accountContract;
+    }
+    /**
+   * Returns a preconfigured deploy method that contains all the necessary function
+   * calls to deploy the account contract.
+   */ async getDeployMethod() {
+        const artifact = await this.accountContract.getContractArtifact();
+        if (!await this.hasInitializer()) {
+            // TODO(https://github.com/AztecProtocol/aztec-packages/issues/15576):
+            // there should be a path which enables an account contract's class & instance to be published,
+            // even if the account contract doesn't have an initializer function. This should not throw.
+            throw new Error(`Account contract ${artifact.name} does not have an initializer function to call.`);
+        }
+        const { constructorName, constructorArgs } = await this.accountContract.getInitializationFunctionAndArgs() ?? {
+            constructorName: undefined,
+            constructorArgs: undefined
+        };
+        return new DeployAccountMethod(this.getPublicKeys(), this.wallet, artifact, (address)=>Contract.at(address, artifact, this.wallet), new Fr(this.salt), constructorArgs, constructorName);
+    }
+    /**
+   * Returns whether this account contract has an initializer function.
+   */ async hasInitializer() {
+        return await this.accountContract.getInitializationFunctionAndArgs() !== undefined;
+    }
+}

package/dest/wallet/base_wallet.d.ts

@@ -1,48 +1,91 @@
-import type { FeeOptions, TxExecutionOptions } from '@aztec/entrypoints/interfaces';
-import type { ExecutionPayload } from '@aztec/entrypoints/payload';
-import type { Fr } from '@aztec/foundation/fields';
-import type { ContractArtifact } from '@aztec/stdlib/abi';
+import { AccountFeePaymentMethodOptions } from '@aztec/entrypoints/account';
+import type { ChainInfo } from '@aztec/entrypoints/interfaces';
+import { ExecutionPayload } from '@aztec/entrypoints/payload';
+import { Fr } from '@aztec/foundation/fields';
+import type { ContractArtifact, EventMetadataDefinition } from '@aztec/stdlib/abi';
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { CompleteAddress, ContractInstanceWithAddress, NodeInfo } from '@aztec/stdlib/contract';
-import type { GasFees } from '@aztec/stdlib/gas';
-import type { ContractClassMetadata, ContractMetadata, EventMetadataDefinition, PXE, PXEInfo } from '@aztec/stdlib/interfaces/client';
-import type { PrivateExecutionResult, SimulationOverrides, Tx, TxExecutionRequest, TxHash, TxProfileResult, TxProvingResult, TxReceipt, TxSimulationResult, UtilitySimulationResult } from '@aztec/stdlib/tx';
-import type { IntentAction, IntentInnerHash } from '../utils/authwit.js';
-import type { Wallet } from './wallet.js';
+import { type ContractClassMetadata, type ContractInstanceWithAddress, type ContractInstantiationData, type ContractMetadata } from '@aztec/stdlib/contract';
+import { GasSettings } from '@aztec/stdlib/gas';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { TxExecutionRequest, TxHash, TxProfileResult, TxReceipt, TxSimulationResult, UtilitySimulationResult } from '@aztec/stdlib/tx';
+import type { Account } from '../account/account.js';
+import type { FeePaymentMethod } from '../fee/fee_payment_method.js';
+import type { CallIntent, IntentInnerHash } from '../utils/authwit.js';
+import type { Aliased, BatchResults, BatchableMethods, BatchedMethod, ContractInstanceAndArtifact, ProfileOptions, SendOptions, SimulateOptions, UserFeeOptions, Wallet } from './wallet.js';
+/**
+ * Options to configure fee payment for a transaction
+ */
+export type FeeOptions = {
+    /**
+     * A wallet-provided fallback fee payment method that is used only if the transaction that is being constructed
+     * doesn't already include one
+     */
+    walletFeePaymentMethod?: FeePaymentMethod;
+    /** Configuration options for the account to properly handle the selected fee payment method */
+    accountFeePaymentMethodOptions: AccountFeePaymentMethodOptions;
+    /** The gas settings to use for the transaction */
+    gasSettings: GasSettings;
+};
 /**
  * A base class for Wallet implementations
  */
 export declare abstract class BaseWallet implements Wallet {
-    protected readonly pxe: PXE;
-    constructor(pxe: PXE);
-    abstract getCompleteAddress(): CompleteAddress;
-    abstract getChainId(): Fr;
-    abstract getVersion(): Fr;
-    abstract createTxExecutionRequest(exec: ExecutionPayload, fee: FeeOptions, options: TxExecutionOptions): Promise<TxExecutionRequest>;
-    abstract createAuthWit(intent: Fr | Buffer | IntentInnerHash | IntentAction): Promise<AuthWitness>;
-    getAddress(): AztecAddress;
-    registerSender(address: AztecAddress): Promise<AztecAddress>;
-    getSenders(): Promise<AztecAddress[]>;
-    removeSender(address: AztecAddress): Promise<void>;
-    registerContract(contract: {
-        /** Instance */ instance: ContractInstanceWithAddress;
-        /** Associated artifact */ artifact?: ContractArtifact;
-    }): Promise<void>;
-    registerContractClass(artifact: ContractArtifact): Promise<void>;
-    updateContract(contractAddress: AztecAddress, artifact: ContractArtifact): Promise<void>;
-    proveTx(txRequest: TxExecutionRequest, privateExecutionResult: PrivateExecutionResult): Promise<TxProvingResult>;
-    profileTx(txRequest: TxExecutionRequest, profileMode: 'gates' | 'execution-steps' | 'full', skipProofGeneration?: boolean, msgSender?: AztecAddress): Promise<TxProfileResult>;
-    simulateTx(txRequest: TxExecutionRequest, simulatePublic: boolean, skipTxValidation?: boolean, skipFeeEnforcement?: boolean, overrides?: SimulationOverrides): Promise<TxSimulationResult>;
-    sendTx(tx: Tx): Promise<TxHash>;
-    getCurrentBaseFees(): Promise<GasFees>;
+    protected readonly pxe: any;
+    protected readonly aztecNode: AztecNode;
+    protected log: import("@aztec/foundation/log").Logger;
+    protected baseFeePadding: number;
+    protected cancellableTransactions: boolean;
+    protected constructor(pxe: any, aztecNode: AztecNode);
+    protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
+    abstract getAccounts(): Promise<Aliased<AztecAddress>[]>;
+    /**
+     * Returns the list of aliased contacts associated with the wallet.
+     * This base implementation directly returns PXE's senders, but note that in general contacts are a superset of senders.
+     *  - Senders: Addresses we check during synching in case they sent us notes,
+     *  - Contacts: more general concept akin to a phone's contact list.
+     * @returns The aliased collection of AztecAddresses that form this wallet's address book
+     */
+    getAddressBook(): Promise<Aliased<AztecAddress>[]>;
+    getChainInfo(): Promise<ChainInfo>;
+    protected createTxExecutionRequestFromPayloadAndFee(executionPayload: ExecutionPayload, from: AztecAddress, feeOptions: FeeOptions): Promise<TxExecutionRequest>;
+    createAuthWit(from: AztecAddress, messageHashOrIntent: Fr | Buffer | IntentInnerHash | CallIntent): Promise<AuthWitness>;
+    batch<const T extends readonly BatchedMethod<keyof BatchableMethods>[]>(methods: T): Promise<BatchResults<T>>;
+    /**
+     * Returns default values for the transaction fee options
+     * if they were omitted by the user.
+     * @param from - The address where the transaction is being sent from
+     * @param userFeeOptions - User-provided fee options, which might be incomplete
+     * @returns - Populated fee options that can be used to create a transaction execution request
+     */
+    protected getDefaultFeeOptions(from: AztecAddress, userFeeOptions?: UserFeeOptions): Promise<FeeOptions>;
+    /**
+     * Returns unreasonably high gas limits in order to execute a simulation
+     * with the goal of estimating its gas cost. It will otherwise try to respect
+     * the user-specified fee options, filling the gaps with default values as needed.
+     * @param from - The address where the transaction is being sent from
+     * @param userFeeOptions - User-provided fee options to use as a basis for the fully populated `FeeOptions` type.
+     */
+    protected getFeeOptionsForGasEstimation(from: AztecAddress, userFeeOptions?: UserFeeOptions): Promise<{
+        gasSettings: GasSettings;
+        /**
+         * A wallet-provided fallback fee payment method that is used only if the transaction that is being constructed
+         * doesn't already include one
+         */
+        walletFeePaymentMethod?: FeePaymentMethod;
+        /** Configuration options for the account to properly handle the selected fee payment method */
+        accountFeePaymentMethodOptions: AccountFeePaymentMethodOptions;
+    }>;
+    registerSender(address: AztecAddress, _alias?: string): Promise<AztecAddress>;
+    registerContract(instanceData: AztecAddress | ContractInstanceWithAddress | ContractInstantiationData | ContractInstanceAndArtifact, artifact?: ContractArtifact, secretKey?: Fr): Promise<ContractInstanceWithAddress>;
+    simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult>;
+    profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult>;
+    sendTx(executionPayload: ExecutionPayload, opts: SendOptions): Promise<TxHash>;
+    protected contextualizeError(err: Error, ...context: string[]): Error;
     simulateUtility(functionName: string, args: any[], to: AztecAddress, authwits?: AuthWitness[], from?: AztecAddress): Promise<UtilitySimulationResult>;
-    getNodeInfo(): Promise<NodeInfo>;
-    getPXEInfo(): Promise<PXEInfo>;
     getContractClassMetadata(id: Fr, includeArtifact?: boolean): Promise<ContractClassMetadata>;
     getContractMetadata(address: AztecAddress): Promise<ContractMetadata>;
     getTxReceipt(txHash: TxHash): Promise<TxReceipt>;
     getPrivateEvents<T>(contractAddress: AztecAddress, event: EventMetadataDefinition, from: number, limit: number, recipients?: AztecAddress[]): Promise<T[]>;
-    getPublicEvents<T>(event: EventMetadataDefinition, from: number, limit: number): Promise<T[]>;
 }
 //# sourceMappingURL=base_wallet.d.ts.map

package/dest/wallet/base_wallet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base_wallet.d.ts","sourceRoot":"","sources":["../../src/wallet/base_wallet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACpF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,2BAA2B,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACrG,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EACV,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,GAAG,EACH,OAAO,EACR,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EACV,sBAAsB,EACtB,mBAAmB,EACnB,EAAE,EACF,kBAAkB,EAClB,MAAM,EACN,eAAe,EACf,eAAe,EACf,SAAS,EACT,kBAAkB,EAClB,uBAAuB,EACxB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C;;GAEG;AACH,8BAAsB,UAAW,YAAW,MAAM;IACpC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG;gBAAR,GAAG,EAAE,GAAG;IAEvC,QAAQ,CAAC,kBAAkB,IAAI,eAAe;IAE9C,QAAQ,CAAC,UAAU,IAAI,EAAE;IAEzB,QAAQ,CAAC,UAAU,IAAI,EAAE;IAEzB,QAAQ,CAAC,wBAAwB,CAC/B,IAAI,EAAE,gBAAgB,EACtB,GAAG,EAAE,UAAU,EACf,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,kBAAkB,CAAC;IAE9B,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,GAAG,MAAM,GAAG,eAAe,GAAG,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAElG,UAAU;IAIV,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAG5D,UAAU,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAG/B,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAGxD,gBAAgB,CAAC,QAAQ,EAAE;QACzB,eAAe,CAAC,QAAQ,EAAE,2BAA2B,CAAC;QACtD,0BAA0B,CAAC,QAAQ,CAAC,EAAE,gBAAgB,CAAC;KACxD,GAAG,OAAO,CAAC,IAAI,CAAC;IAGjB,qBAAqB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAGhE,cAAc,CAAC,eAAe,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAGxF,OAAO,CAAC,SAAS,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAGhH,SAAS,CACP,SAAS,EAAE,kBAAkB,EAC7B,WAAW,EAAE,OAAO,GAAG,iBAAiB,GAAG,MAAM,EACjD,mBAAmB,CAAC,EAAE,OAAO,EAC7B,SAAS,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,eAAe,CAAC;IAG3B,UAAU,CACR,SAAS,EAAE,kBAAkB,EAC7B,cAAc,EAAE,OAAO,EACvB,gBAAgB,CAAC,EAAE,OAAO,EAC1B,kBAAkB,CAAC,EAAE,OAAO,EAC5B,SAAS,CAAC,EAAE,mBAAmB,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAG9B,MAAM,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAG/B,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;IAGtC,eAAe,CACb,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,GAAG,EAAE,EACX,EAAE,EAAE,YAAY,EAChB,QAAQ,CAAC,EAAE,WAAW,EAAE,EACxB,IAAI,CAAC,EAAE,YAAY,GAClB,OAAO,CAAC,uBAAuB,CAAC;IAGnC,WAAW,IAAI,OAAO,CAAC,QAAQ,CAAC;IAGhC,UAAU,IAAI,OAAO,CAAC,OAAO,CAAC;IAG9B,wBAAwB,CAAC,EAAE,EAAE,EAAE,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAGlG,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIrE,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAIhD,gBAAgB,CAAC,CAAC,EAChB,eAAe,EAAE,YAAY,EAC7B,KAAK,EAAE,uBAAuB,EAC9B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,GAAE,YAAY,EAAwC,GAC/D,OAAO,CAAC,CAAC,EAAE,CAAC;IAGf,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;CAG9F"}
+{"version":3,"file":"base_wallet.d.ts","sourceRoot":"","sources":["../../src/wallet/base_wallet.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,8BAA8B,EAAwC,MAAM,4BAA4B,CAAC;AAClH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAA0B,MAAM,4BAA4B,CAAC;AACtF,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AACnF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,gBAAgB,EAItB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAO,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,KAAK,EACV,kBAAkB,EAClB,MAAM,EACN,eAAe,EACf,SAAS,EACT,kBAAkB,EAClB,uBAAuB,EACxB,MAAM,kBAAkB,CAAC;AAI1B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EACV,OAAO,EACP,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,2BAA2B,EAC3B,cAAc,EACd,WAAW,EACX,eAAe,EACf,cAAc,EACd,MAAM,EACP,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,gBAAgB,CAAC;IAC1C,+FAA+F;IAC/F,8BAA8B,EAAE,8BAA8B,CAAC;IAC/D,kDAAkD;IAClD,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,8BAAsB,UAAW,YAAW,MAAM;IAU9C,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG;IAC3B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS;IAVzC,SAAS,CAAC,GAAG,yCAAuC;IAEpD,SAAS,CAAC,cAAc,SAAO;IAC/B,SAAS,CAAC,uBAAuB,UAAS;IAG1C,SAAS,aAGY,GAAG,EAAE,GAAG,EACR,SAAS,EAAE,SAAS;IAGzC,SAAS,CAAC,QAAQ,CAAC,qBAAqB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAEjF,QAAQ,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;IAExD;;;;;;OAMG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;IAKlD,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;cAKxB,yCAAyC,CACvD,gBAAgB,EAAE,gBAAgB,EAClC,IAAI,EAAE,YAAY,EAClB,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,kBAAkB,CAAC;IAcjB,aAAa,CACxB,IAAI,EAAE,YAAY,EAClB,mBAAmB,EAAE,EAAE,GAAG,MAAM,GAAG,eAAe,GAAG,UAAU,GAC9D,OAAO,CAAC,WAAW,CAAC;IAKV,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,SAAS,aAAa,CAAC,MAAM,gBAAgB,CAAC,EAAE,EACjF,OAAO,EAAE,CAAC,GACT,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAkB3B;;;;;;OAMG;cACa,oBAAoB,CAAC,IAAI,EAAE,YAAY,EAAE,cAAc,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAyB9G;;;;;;OAMG;cACa,6BAA6B,CAAC,IAAI,EAAE,YAAY,EAAE,cAAc,CAAC,EAAE,cAAc;;QAtIjG;;;WAGG;iCACsB,gBAAgB;QACzC,+FAA+F;wCAC/D,8BAA8B;;IAmJ9D,cAAc,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,GAAE,MAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAI3E,gBAAgB,CACpB,YAAY,EAAE,YAAY,GAAG,2BAA2B,GAAG,yBAAyB,GAAG,2BAA2B,EAClH,QAAQ,CAAC,EAAE,gBAAgB,EAC3B,SAAS,CAAC,EAAE,EAAE,GACb,OAAO,CAAC,2BAA2B,CAAC;IAmDjC,UAAU,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAalG,SAAS,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAM7F,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBpF,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK;IAcrE,eAAe,CACb,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,GAAG,EAAE,EACX,EAAE,EAAE,YAAY,EAChB,QAAQ,CAAC,EAAE,WAAW,EAAE,EACxB,IAAI,CAAC,EAAE,YAAY,GAClB,OAAO,CAAC,uBAAuB,CAAC;IAInC,wBAAwB,CAAC,EAAE,EAAE,EAAE,EAAE,eAAe,GAAE,OAAe,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAGlG,mBAAmB,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIrE,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAIhD,gBAAgB,CAAC,CAAC,EAChB,eAAe,EAAE,YAAY,EAC7B,KAAK,EAAE,uBAAuB,EAC9B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,GAAE,YAAY,EAAO,GAC9B,OAAO,CAAC,CAAC,EAAE,CAAC;CAGhB"}

package/dest/wallet/base_wallet.js

@@ -1,55 +1,228 @@
+import { GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT } from '@aztec/constants';
+import { AccountFeePaymentMethodOptions } from '@aztec/entrypoints/account';
+import { mergeExecutionPayloads } from '@aztec/entrypoints/payload';
+import { Fr } from '@aztec/foundation/fields';
+import { createLogger } from '@aztec/foundation/log';
+import { computePartialAddress, getContractClassFromArtifact, getContractInstanceFromInstantiationParams } from '@aztec/stdlib/contract';
+import { SimulationError } from '@aztec/stdlib/errors';
+import { Gas, GasSettings } from '@aztec/stdlib/gas';
+import { inspect } from 'util';
 /**
  * A base class for Wallet implementations
  */ export class BaseWallet {
     pxe;
-    constructor(pxe){
+    aztecNode;
+    log;
+    baseFeePadding;
+    cancellableTransactions;
+    // Protected because we want to force wallets to instantiate their own PXE.
+    constructor(// TODO: We cannot type here pxe because we cannot import that package as that would result in a circular
+    // dependency. This will eventually get resolved by the introduction of @aztec/wallet-sdk package.
+    pxe, aztecNode){
         this.pxe = pxe;
-    }
-    getAddress() {
-        return this.getCompleteAddress().address;
-    }
-    registerSender(address) {
+        this.aztecNode = aztecNode;
+        this.log = createLogger('aztecjs:base_wallet');
+        this.baseFeePadding = 0.5;
+        this.cancellableTransactions = false;
+    }
+    /**
+   * Returns the list of aliased contacts associated with the wallet.
+   * This base implementation directly returns PXE's senders, but note that in general contacts are a superset of senders.
+   *  - Senders: Addresses we check during synching in case they sent us notes,
+   *  - Contacts: more general concept akin to a phone's contact list.
+   * @returns The aliased collection of AztecAddresses that form this wallet's address book
+   */ async getAddressBook() {
+        const senders = await this.pxe.getSenders();
+        return senders.map((sender)=>({
+                item: sender,
+                alias: ''
+            }));
+    }
+    async getChainInfo() {
+        const { l1ChainId, rollupVersion } = await this.aztecNode.getNodeInfo();
+        return {
+            chainId: new Fr(l1ChainId),
+            version: new Fr(rollupVersion)
+        };
+    }
+    async createTxExecutionRequestFromPayloadAndFee(executionPayload, from, feeOptions) {
+        const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
+        const executionOptions = {
+            txNonce: Fr.random(),
+            cancellable: this.cancellableTransactions,
+            feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions
+        };
+        const finalExecutionPayload = feeExecutionPayload ? mergeExecutionPayloads([
+            feeExecutionPayload,
+            executionPayload
+        ]) : executionPayload;
+        const fromAccount = await this.getAccountFromAddress(from);
+        return fromAccount.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, executionOptions);
+    }
+    async createAuthWit(from, messageHashOrIntent) {
+        const account = await this.getAccountFromAddress(from);
+        return account.createAuthWit(messageHashOrIntent);
+    }
+    async batch(methods) {
+        const results = [];
+        for (const method of methods){
+            const { name, args } = method;
+            // Type safety is guaranteed by the BatchedMethod type, which ensures that:
+            // 1. `name` is a valid batchable method name
+            // 2. `args` matches the parameter types of that specific method
+            // 3. The return type is correctly mapped in BatchResults<T>
+            // We use dynamic dispatch here for simplicity, but the types are enforced at the call site.
+            const fn = this[name];
+            const result = await fn.apply(this, args);
+            // Wrap result with method name for discriminated union deserialization
+            results.push({
+                name,
+                result
+            });
+        }
+        return results;
+    }
+    /**
+   * Returns default values for the transaction fee options
+   * if they were omitted by the user.
+   * @param from - The address where the transaction is being sent from
+   * @param userFeeOptions - User-provided fee options, which might be incomplete
+   * @returns - Populated fee options that can be used to create a transaction execution request
+   */ async getDefaultFeeOptions(from, userFeeOptions) {
+        const maxFeesPerGas = userFeeOptions?.gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentBaseFees()).mul(1 + this.baseFeePadding);
+        let accountFeePaymentMethodOptions;
+        // The transaction does not include a fee payment method, so we set the flag
+        // for the account to use its fee juice balance
+        if (!userFeeOptions?.embeddedPaymentMethodFeePayer) {
+            accountFeePaymentMethodOptions = AccountFeePaymentMethodOptions.PREEXISTING_FEE_JUICE;
+        } else {
+            // The transaction includes fee payment method, so we check if we are the fee payer for it
+            // (this can only happen if the embedded payment method is FeeJuiceWithClaim)
+            accountFeePaymentMethodOptions = from.equals(userFeeOptions.embeddedPaymentMethodFeePayer) ? AccountFeePaymentMethodOptions.FEE_JUICE_WITH_CLAIM : AccountFeePaymentMethodOptions.EXTERNAL;
+        }
+        const gasSettings = GasSettings.default({
+            ...userFeeOptions?.gasSettings,
+            maxFeesPerGas
+        });
+        this.log.debug(`Using L2 gas settings`, gasSettings);
+        return {
+            gasSettings,
+            walletFeePaymentMethod: undefined,
+            accountFeePaymentMethodOptions
+        };
+    }
+    /**
+   * Returns unreasonably high gas limits in order to execute a simulation
+   * with the goal of estimating its gas cost. It will otherwise try to respect
+   * the user-specified fee options, filling the gaps with default values as needed.
+   * @param from - The address where the transaction is being sent from
+   * @param userFeeOptions - User-provided fee options to use as a basis for the fully populated `FeeOptions` type.
+   */ async getFeeOptionsForGasEstimation(from, userFeeOptions) {
+        const defaultFeeOptions = await this.getDefaultFeeOptions(from, userFeeOptions);
+        const { gasSettings: { maxFeesPerGas, maxPriorityFeesPerGas } } = defaultFeeOptions;
+        // Use unrealistically high gas limits for estimation to avoid running out of gas.
+        // They will be tuned down after the simulation.
+        const gasSettingsForEstimation = new GasSettings(new Gas(GAS_ESTIMATION_DA_GAS_LIMIT, GAS_ESTIMATION_L2_GAS_LIMIT), new Gas(GAS_ESTIMATION_TEARDOWN_DA_GAS_LIMIT, GAS_ESTIMATION_TEARDOWN_L2_GAS_LIMIT), maxFeesPerGas, maxPriorityFeesPerGas);
+        return {
+            ...defaultFeeOptions,
+            gasSettings: gasSettingsForEstimation
+        };
+    }
+    registerSender(address, _alias = '') {
         return this.pxe.registerSender(address);
     }
-    getSenders() {
-        return this.pxe.getSenders();
-    }
-    async removeSender(address) {
-        await this.pxe.removeSender(address);
-    }
-    registerContract(contract) {
-        return this.pxe.registerContract(contract);
-    }
-    registerContractClass(artifact) {
-        return this.pxe.registerContractClass(artifact);
-    }
-    updateContract(contractAddress, artifact) {
-        return this.pxe.updateContract(contractAddress, artifact);
-    }
-    proveTx(txRequest, privateExecutionResult) {
-        return this.pxe.proveTx(txRequest, privateExecutionResult);
-    }
-    profileTx(txRequest, profileMode, skipProofGeneration, msgSender) {
-        return this.pxe.profileTx(txRequest, profileMode, skipProofGeneration, msgSender);
-    }
-    simulateTx(txRequest, simulatePublic, skipTxValidation, skipFeeEnforcement, overrides) {
-        return this.pxe.simulateTx(txRequest, simulatePublic, skipTxValidation, skipFeeEnforcement, overrides);
-    }
-    sendTx(tx) {
-        return this.pxe.sendTx(tx);
-    }
-    getCurrentBaseFees() {
-        return this.pxe.getCurrentBaseFees();
+    async registerContract(instanceData, artifact, secretKey) {
+        /** Determines if the provided instance data is already a contract instance with an address. */ function isInstanceWithAddress(instanceData) {
+            return instanceData.address !== undefined;
+        }
+        /** Determines if the provided instance data is contract instantiation data */ function isContractInstantiationData(instanceData) {
+            return instanceData.salt !== undefined;
+        }
+        /** Determines if the provided instance data is already a contract */ function isContractInstanceAndArtifact(instanceData) {
+            return instanceData.instance !== undefined && instanceData.artifact !== undefined;
+        }
+        let instance;
+        if (isContractInstanceAndArtifact(instanceData)) {
+            instance = instanceData.instance;
+            await this.pxe.registerContract(instanceData);
+        } else if (isInstanceWithAddress(instanceData)) {
+            instance = instanceData;
+            await this.pxe.registerContract({
+                artifact,
+                instance
+            });
+        } else if (isContractInstantiationData(instanceData)) {
+            if (!artifact) {
+                throw new Error(`Contract artifact must be provided when registering a contract using instantiation data`);
+            }
+            instance = await getContractInstanceFromInstantiationParams(artifact, instanceData);
+            await this.pxe.registerContract({
+                artifact,
+                instance
+            });
+        } else {
+            if (!artifact) {
+                throw new Error(`Contract artifact must be provided when registering a contract using an address`);
+            }
+            const { contractInstance: maybeContractInstance } = await this.pxe.getContractMetadata(instanceData);
+            if (!maybeContractInstance) {
+                throw new Error(`Contract instance at ${instanceData.toString()} has not been registered in the wallet's PXE`);
+            }
+            instance = maybeContractInstance;
+            const thisContractClass = await getContractClassFromArtifact(artifact);
+            if (!thisContractClass.id.equals(instance.currentContractClassId)) {
+                // wallet holds an outdated version of this contract
+                await this.pxe.updateContract(instance.address, artifact);
+                instance.currentContractClassId = thisContractClass.id;
+            }
+        }
+        if (secretKey) {
+            await this.pxe.registerAccount(secretKey, await computePartialAddress(instance));
+        }
+        return instance;
+    }
+    async simulateTx(executionPayload, opts) {
+        const feeOptions = opts.fee?.estimateGas ? await this.getFeeOptionsForGasEstimation(opts.from, opts.fee) : await this.getDefaultFeeOptions(opts.from, opts.fee);
+        const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
+        return this.pxe.simulateTx(txRequest, true, opts?.skipTxValidation, opts?.skipFeeEnforcement ?? true);
+    }
+    async profileTx(executionPayload, opts) {
+        const fee = await this.getDefaultFeeOptions(opts.from, opts.fee);
+        const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, fee);
+        return this.pxe.profileTx(txRequest, opts.profileMode, opts.skipProofGeneration ?? true);
+    }
+    async sendTx(executionPayload, opts) {
+        const fee = await this.getDefaultFeeOptions(opts.from, opts.fee);
+        const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, fee);
+        const provenTx = await this.pxe.proveTx(txRequest);
+        const tx = await provenTx.toTx();
+        const txHash = tx.getTxHash();
+        if (await this.aztecNode.getTxEffect(txHash)) {
+            throw new Error(`A settled tx with equal hash ${txHash.toString()} exists.`);
+        }
+        this.log.debug(`Sending transaction ${txHash}`);
+        await this.aztecNode.sendTx(tx).catch((err)=>{
+            throw this.contextualizeError(err, inspect(tx));
+        });
+        this.log.info(`Sent transaction ${txHash}`);
+        return txHash;
+    }
+    contextualizeError(err, ...context) {
+        let contextStr = '';
+        if (context.length > 0) {
+            contextStr = `\nContext:\n${context.join('\n')}`;
+        }
+        if (err instanceof SimulationError) {
+            err.setAztecContext(contextStr);
+        } else {
+            this.log.error(err.name, err);
+            this.log.debug(contextStr);
+        }
+        return err;
     }
     simulateUtility(functionName, args, to, authwits, from) {
         return this.pxe.simulateUtility(functionName, args, to, authwits, from);
     }
-    getNodeInfo() {
-        return this.pxe.getNodeInfo();
-    }
-    getPXEInfo() {
-        return this.pxe.getPXEInfo();
-    }
     getContractClassMetadata(id, includeArtifact = false) {
         return this.pxe.getContractClassMetadata(id, includeArtifact);
     }
@@ -57,14 +230,9 @@
         return this.pxe.getContractMetadata(address);
     }
     getTxReceipt(txHash) {
-        return this.pxe.getTxReceipt(txHash);
+        return this.aztecNode.getTxReceipt(txHash);
     }
-    getPrivateEvents(contractAddress, event, from, limit, recipients = [
-        this.getCompleteAddress().address
-    ]) {
+    getPrivateEvents(contractAddress, event, from, limit, recipients = []) {
         return this.pxe.getPrivateEvents(contractAddress, event, from, limit, recipients);
     }
-    getPublicEvents(event, from, limit) {
-        return this.pxe.getPublicEvents(event, from, limit);
-    }
 }