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

package/src/wallet/wallet.ts

@@ -1,12 +1,11 @@
 import type { ChainInfo } from '@aztec/entrypoints/interfaces';
-import type { ExecutionPayload } from '@aztec/entrypoints/payload';
 import type { Fr } from '@aztec/foundation/fields';
 import {
   AbiTypeSchema,
   type ContractArtifact,
   ContractArtifactSchema,
   type EventMetadataDefinition,
-  FunctionAbiSchema,
+  type FunctionCall,
   FunctionType,
 } from '@aztec/stdlib/abi';
 import { AuthWitness } from '@aztec/stdlib/auth-witness';
@@ -16,11 +15,9 @@ import {
   ContractClassWithIdSchema,
   type ContractInstanceWithAddress,
   ContractInstanceWithAddressSchema,
-  type ContractInstantiationData,
   type ContractMetadata,
 } from '@aztec/stdlib/contract';
 import { Gas } from '@aztec/stdlib/gas';
-import { PublicKeys } from '@aztec/stdlib/keys';
 import { AbiDecodedSchema, type ApiSchemaFor, type ZodFor, optional, schemas } from '@aztec/stdlib/schemas';
 import {
   Capsule,
@@ -31,10 +28,10 @@ import {
   TxSimulationResult,
   UtilitySimulationResult,
 } from '@aztec/stdlib/tx';
+import type { ExecutionPayload } from '@aztec/stdlib/tx';
 
 import { z } from 'zod';
 
-import type { Contract } from '../contract/contract.js';
 import type {
   FeeEstimationOptions,
   GasSettingsOption,
@@ -58,22 +55,6 @@ export type Aliased<T> = {
   item: T;
 };
 
-/**
- * A reduced representation of a Contract, only including its instance and artifact
- */
-export type ContractInstanceAndArtifact = Pick<Contract, 'artifact' | 'instance'>;
-
-/**
- * Options that can be provided to the wallet for configuration of the fee payment.
- */
-export type UserFeeOptions = {
-  /**
-   * Informs the wallet that the crafted tx already contains the necessary calls to pay for its fee
-   * and who is paying
-   */
-  embeddedPaymentMethodFeePayer?: AztecAddress;
-} & GasSettingsOption;
-
 /**
  * Options for simulating interactions with the wallet. Overrides the fee settings of an interaction with
  * a simplified version that only hints at the wallet wether the interaction contains a
@@ -81,7 +62,7 @@ export type UserFeeOptions = {
  */
 export type SimulateOptions = Omit<SimulateInteractionOptions, 'fee'> & {
   /** The fee options */
-  fee?: UserFeeOptions & FeeEstimationOptions;
+  fee?: GasSettingsOption & FeeEstimationOptions;
 };
 
 /**
@@ -91,7 +72,7 @@ export type SimulateOptions = Omit<SimulateInteractionOptions, 'fee'> & {
  */
 export type ProfileOptions = Omit<ProfileInteractionOptions, 'fee'> & {
   /** The fee options */
-  fee?: UserFeeOptions;
+  fee?: GasSettingsOption;
 };
 
 /**
@@ -101,13 +82,16 @@ export type ProfileOptions = Omit<ProfileInteractionOptions, 'fee'> & {
  */
 export type SendOptions = Omit<SendInteractionOptions, 'fee'> & {
   /** The fee options */
-  fee?: UserFeeOptions;
+  fee?: GasSettingsOption;
 };
 
 /**
  * Helper type that represents all methods that can be batched.
  */
-export type BatchableMethods = Pick<Wallet, 'registerContract' | 'sendTx' | 'registerSender' | 'simulateUtility'>;
+export type BatchableMethods = Pick<
+  Wallet,
+  'registerContract' | 'sendTx' | 'registerSender' | 'simulateUtility' | 'simulateTx'
+>;
 
 /**
  * From the batchable methods, we create a type that represents a method call with its name and arguments.
@@ -164,43 +148,18 @@ export type Wallet = {
   getAddressBook(): Promise<Aliased<AztecAddress>[]>;
   getAccounts(): Promise<Aliased<AztecAddress>[]>;
   registerContract(
-    instanceData: AztecAddress | ContractInstanceWithAddress | ContractInstantiationData | ContractInstanceAndArtifact,
-  ): Promise<ContractInstanceWithAddress>;
-  // Overloaded definition to avoid zod issues
-  registerContract(
-    instanceData: AztecAddress | ContractInstanceWithAddress | ContractInstantiationData | ContractInstanceAndArtifact,
-    artifact: ContractArtifact,
-  ): Promise<ContractInstanceWithAddress>;
-  registerContract(
-    instanceData: AztecAddress | ContractInstanceWithAddress | ContractInstantiationData | ContractInstanceAndArtifact,
-    artifact: ContractArtifact | undefined,
-    secretKey: Fr | undefined,
+    instance: ContractInstanceWithAddress,
+    artifact?: ContractArtifact,
+    secretKey?: Fr,
   ): Promise<ContractInstanceWithAddress>;
   simulateTx(exec: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult>;
-  simulateUtility(
-    functionName: string,
-    args: any[],
-    to: AztecAddress,
-    authwits?: AuthWitness[],
-  ): Promise<UtilitySimulationResult>;
+  simulateUtility(call: FunctionCall, authwits?: AuthWitness[]): Promise<UtilitySimulationResult>;
   profileTx(exec: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult>;
   sendTx(exec: ExecutionPayload, opts: SendOptions): Promise<TxHash>;
-  createAuthWit(
-    from: AztecAddress,
-    messageHashOrIntent: Fr | Buffer<ArrayBuffer> | IntentInnerHash | CallIntent,
-  ): Promise<AuthWitness>;
+  createAuthWit(from: AztecAddress, messageHashOrIntent: Fr | IntentInnerHash | CallIntent): Promise<AuthWitness>;
   batch<const T extends readonly BatchedMethod<keyof BatchableMethods>[]>(methods: T): Promise<BatchResults<T>>;
 };
 
-export const ContractInstantiationDataSchema = z.object({
-  constructorArtifact: optional(z.union([FunctionAbiSchema, z.string()])),
-  constructorArgs: optional(z.array(z.any())),
-  skipArgsDecoding: optional(z.boolean()),
-  salt: schemas.Fr,
-  publicKeys: optional(PublicKeys.schema),
-  deployer: optional(schemas.AztecAddress),
-});
-
 export const FunctionCallSchema = z.object({
   name: z.string(),
   to: schemas.AztecAddress,
@@ -217,9 +176,10 @@ export const ExecutionPayloadSchema = z.object({
   authWitnesses: z.array(AuthWitness.schema),
   capsules: z.array(Capsule.schema),
   extraHashedArgs: z.array(HashedValues.schema),
+  feePayer: optional(schemas.AztecAddress),
 });
 
-export const UserFeeOptionsSchema = z.object({
+export const GasSettingsOptionSchema = z.object({
   gasSettings: optional(
     z.object({
       gasLimits: optional(Gas.schema),
@@ -228,10 +188,9 @@ export const UserFeeOptionsSchema = z.object({
       maxPriorityFeePerGas: optional(z.object({ feePerDaGas: schemas.BigInt, feePerL2Gas: schemas.BigInt })),
     }),
   ),
-  embeddedPaymentMethodFeePayer: optional(schemas.AztecAddress),
 });
 
-export const WalletSimulationFeeOptionSchema = UserFeeOptionsSchema.extend({
+export const WalletSimulationFeeOptionSchema = GasSettingsOptionSchema.extend({
   estimatedGasPadding: optional(z.number()),
   estimateGas: optional(z.boolean()),
 });
@@ -240,7 +199,7 @@ export const SendOptionsSchema = z.object({
   from: schemas.AztecAddress,
   authWitnesses: optional(z.array(AuthWitness.schema)),
   capsules: optional(z.array(Capsule.schema)),
-  fee: optional(UserFeeOptionsSchema),
+  fee: optional(GasSettingsOptionSchema),
 });
 
 export const SimulateOptionsSchema = z.object({
@@ -258,17 +217,9 @@ export const ProfileOptionsSchema = SimulateOptionsSchema.extend({
   skipProofGeneration: optional(z.boolean()),
 });
 
-export const InstanceDataSchema = z.union([
-  schemas.AztecAddress,
-  ContractInstanceWithAddressSchema,
-  ContractInstantiationDataSchema,
-  z.object({ instance: ContractInstanceWithAddressSchema, artifact: ContractArtifactSchema }),
-]);
-
 export const MessageHashOrIntentSchema = z.union([
   schemas.Fr,
-  schemas.Buffer,
-  z.object({ consumer: schemas.AztecAddress, innerHash: z.union([schemas.Buffer, schemas.Fr]) }),
+  z.object({ consumer: schemas.AztecAddress, innerHash: schemas.Fr }),
   z.object({
     caller: schemas.AztecAddress,
     call: FunctionCallSchema,
@@ -282,7 +233,7 @@ export const BatchedMethodSchema = z.union([
   }),
   z.object({
     name: z.literal('registerContract'),
-    args: z.tuple([InstanceDataSchema, optional(ContractArtifactSchema), optional(schemas.Fr)]),
+    args: z.tuple([ContractInstanceWithAddressSchema, optional(ContractArtifactSchema), optional(schemas.Fr)]),
   }),
   z.object({
     name: z.literal('sendTx'),
@@ -290,7 +241,11 @@ export const BatchedMethodSchema = z.union([
   }),
   z.object({
     name: z.literal('simulateUtility'),
-    args: z.tuple([z.string(), z.array(z.any()), schemas.AztecAddress, optional(z.array(AuthWitness.schema))]),
+    args: z.tuple([FunctionCallSchema, optional(z.array(AuthWitness.schema))]),
+  }),
+  z.object({
+    name: z.literal('simulateTx'),
+    args: z.tuple([ExecutionPayloadSchema, SimulateOptionsSchema]),
   }),
 ]);
 
@@ -335,12 +290,12 @@ export const WalletSchema: ApiSchemaFor<Wallet> = {
     .returns(z.array(z.object({ alias: z.string(), item: schemas.AztecAddress }))),
   registerContract: z
     .function()
-    .args(InstanceDataSchema, optional(ContractArtifactSchema), optional(schemas.Fr))
+    .args(ContractInstanceWithAddressSchema, optional(ContractArtifactSchema), optional(schemas.Fr))
     .returns(ContractInstanceWithAddressSchema),
   simulateTx: z.function().args(ExecutionPayloadSchema, SimulateOptionsSchema).returns(TxSimulationResult.schema),
   simulateUtility: z
     .function()
-    .args(z.string(), z.array(z.any()), schemas.AztecAddress, optional(z.array(AuthWitness.schema)))
+    .args(FunctionCallSchema, optional(z.array(AuthWitness.schema)))
     .returns(UtilitySimulationResult.schema),
   profileTx: z.function().args(ExecutionPayloadSchema, ProfileOptionsSchema).returns(TxProfileResult.schema),
   sendTx: z.function().args(ExecutionPayloadSchema, SendOptionsSchema).returns(TxHash.schema),
@@ -356,6 +311,7 @@ export const WalletSchema: ApiSchemaFor<Wallet> = {
           z.object({ name: z.literal('registerContract'), result: ContractInstanceWithAddressSchema }),
           z.object({ name: z.literal('sendTx'), result: TxHash.schema }),
           z.object({ name: z.literal('simulateUtility'), result: UtilitySimulationResult.schema }),
+          z.object({ name: z.literal('simulateTx'), result: TxSimulationResult.schema }),
         ]),
       ),
     ),

package/dest/wallet/base_wallet.d.ts

@@ -1,91 +0,0 @@
-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 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: 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>;
-    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[]>;
-}
-//# sourceMappingURL=base_wallet.d.ts.map

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

@@ -1 +0,0 @@
-{"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,238 +0,0 @@
-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;
-    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;
-        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);
-    }
-    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);
-    }
-    getContractClassMetadata(id, includeArtifact = false) {
-        return this.pxe.getContractClassMetadata(id, includeArtifact);
-    }
-    getContractMetadata(address) {
-        return this.pxe.getContractMetadata(address);
-    }
-    getTxReceipt(txHash) {
-        return this.aztecNode.getTxReceipt(txHash);
-    }
-    getPrivateEvents(contractAddress, event, from, limit, recipients = []) {
-        return this.pxe.getPrivateEvents(contractAddress, event, from, limit, recipients);
-    }
-}