@aztec/wallet-sdk 3.0.3 → 4.0.0-devnet.1-patch.1

package/src/base-wallet/base_wallet.ts

@@ -1,10 +1,12 @@
 import type { Account } from '@aztec/aztec.js/account';
 import type { CallIntent, IntentInnerHash } from '@aztec/aztec.js/authorization';
+import { type InteractionWaitOptions, NO_WAIT, type SendReturn } from '@aztec/aztec.js/contracts';
 import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
+import { waitForTx } from '@aztec/aztec.js/node';
 import type {
   Aliased,
+  AppCapabilities,
   BatchResults,
-  BatchableMethods,
   BatchedMethod,
   PrivateEvent,
   PrivateEventFilter,
@@ -12,6 +14,7 @@ import type {
   SendOptions,
   SimulateOptions,
   Wallet,
+  WalletCapabilities,
 } from '@aztec/aztec.js/wallet';
 import {
   GAS_ESTIMATION_DA_GAS_LIMIT,
@@ -34,27 +37,27 @@ import {
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import {
-  type ContractClassMetadata,
   type ContractInstanceWithAddress,
-  type ContractMetadata,
   computePartialAddress,
   getContractClassFromArtifact,
 } from '@aztec/stdlib/contract';
 import { SimulationError } from '@aztec/stdlib/errors';
 import { Gas, GasSettings } from '@aztec/stdlib/gas';
+import { siloNullifier } from '@aztec/stdlib/hash';
 import type { AztecNode } from '@aztec/stdlib/interfaces/client';
-import type {
-  TxExecutionRequest,
-  TxHash,
-  TxProfileResult,
-  TxReceipt,
+import {
+  BlockHeader,
+  type TxExecutionRequest,
+  type TxProfileResult,
   TxSimulationResult,
-  UtilitySimulationResult,
+  type UtilitySimulationResult,
 } from '@aztec/stdlib/tx';
 import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
 
 import { inspect } from 'util';
 
+import { buildMergedSimulationResult, extractOptimizablePublicStaticCalls, simulateViaNode } from './utils.js';
+
 /**
  * Options to configure fee payment for a transaction
  */
@@ -74,15 +77,14 @@ export type FeeOptions = {
  * A base class for Wallet implementations
  */
 export abstract class BaseWallet implements Wallet {
-  protected log = createLogger('wallet-sdk:base_wallet');
-
-  protected baseFeePadding = 0.5;
+  protected minFeePadding = 0.5;
   protected cancellableTransactions = false;
 
   // Protected because we want to force wallets to instantiate their own PXE.
   protected constructor(
     protected readonly pxe: PXE,
     protected readonly aztecNode: AztecNode,
+    protected log = createLogger('wallet-sdk:base_wallet'),
   ) {}
 
   protected abstract getAccountFromAddress(address: AztecAddress): Promise<Account>;
@@ -121,20 +123,42 @@ export abstract class BaseWallet implements Wallet {
       ? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
       : executionPayload;
     const fromAccount = await this.getAccountFromAddress(from);
-    return fromAccount.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, executionOptions);
+    const chainInfo = await this.getChainInfo();
+    return fromAccount.createTxExecutionRequest(
+      finalExecutionPayload,
+      feeOptions.gasSettings,
+      chainInfo,
+      executionOptions,
+    );
   }
 
   public async createAuthWit(
     from: AztecAddress,
-    messageHashOrIntent: Fr | IntentInnerHash | CallIntent,
+    messageHashOrIntent: IntentInnerHash | CallIntent,
   ): Promise<AuthWitness> {
     const account = await this.getAccountFromAddress(from);
-    return account.createAuthWit(messageHashOrIntent);
+    const chainInfo = await this.getChainInfo();
+    return account.createAuthWit(messageHashOrIntent, chainInfo);
   }
 
-  public async batch<const T extends readonly BatchedMethod<keyof BatchableMethods>[]>(
-    methods: T,
-  ): Promise<BatchResults<T>> {
+  /**
+   * Request capabilities from the wallet.
+   *
+   * This method is wallet-implementation-dependent and must be provided by classes extending BaseWallet.
+   * Embedded wallets typically don't support capability-based authorization (no user authorization flow),
+   * while external wallets (browser extensions, hardware wallets) implement this to reduce authorization
+   * friction by allowing apps to request permissions upfront.
+   *
+   * TODO: Consider making it abstract so implementing it is a conscious decision. Leaving it as-is
+   * while the feature stabilizes.
+   *
+   * @param _manifest - Application capability manifest declaring what operations the app needs
+   */
+  public requestCapabilities(_manifest: AppCapabilities): Promise<WalletCapabilities> {
+    throw new Error('Not implemented');
+  }
+
+  public async batch<const T extends readonly BatchedMethod[]>(methods: T): Promise<BatchResults<T>> {
     const results: any[] = [];
     for (const method of methods) {
       const { name, args } = method;
@@ -165,7 +189,7 @@ export abstract class BaseWallet implements Wallet {
     gasSettings?: Partial<FieldsOf<GasSettings>>,
   ): Promise<FeeOptions> {
     const maxFeesPerGas =
-      gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentBaseFees()).mul(1 + this.baseFeePadding);
+      gasSettings?.maxFeesPerGas ?? (await this.aztecNode.getCurrentMinFees()).mul(1 + this.minFeePadding);
     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
@@ -227,7 +251,7 @@ export abstract class BaseWallet implements Wallet {
     artifact?: ContractArtifact,
     secretKey?: Fr,
   ): Promise<ContractInstanceWithAddress> {
-    const { contractInstance: existingInstance } = await this.pxe.getContractMetadata(instance.address);
+    const existingInstance = await this.pxe.getContractInstance(instance.address);
 
     if (existingInstance) {
       // Instance already registered in the wallet
@@ -244,13 +268,12 @@ export abstract class BaseWallet implements Wallet {
       // Instance not registered yet
       if (!artifact) {
         // Try to get the artifact from the wallet's contract class storage
-        const classMetadata = await this.pxe.getContractClassMetadata(instance.currentContractClassId, true);
-        if (!classMetadata.artifact) {
+        artifact = await this.pxe.getContractArtifact(instance.currentContractClassId);
+        if (!artifact) {
           throw new Error(
             `Cannot register contract at ${instance.address.toString()}: artifact is required but not provided, and wallet does not have the artifact for contract class ${instance.currentContractClassId.toString()}`,
           );
         }
-        artifact = classMetadata.artifact;
       }
       await this.pxe.registerContract({ artifact, instance });
     }
@@ -261,26 +284,89 @@ export abstract class BaseWallet implements Wallet {
     return instance;
   }
 
+  /**
+   * Simulates calls through the standard PXE path (account entrypoint).
+   * @param executionPayload - The execution payload to simulate.
+   * @param from - The sender address.
+   * @param feeOptions - Fee options for the transaction.
+   * @param skipTxValidation - Whether to skip tx validation.
+   * @param skipFeeEnforcement - Whether to skip fee enforcement.
+   */
+  protected async simulateViaEntrypoint(
+    executionPayload: ExecutionPayload,
+    from: AztecAddress,
+    feeOptions: FeeOptions,
+    skipTxValidation?: boolean,
+    skipFeeEnforcement?: boolean,
+  ) {
+    const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, from, feeOptions);
+    return this.pxe.simulateTx(txRequest, { simulatePublic: true, skipTxValidation, skipFeeEnforcement });
+  }
+
+  /**
+   * Simulates a transaction, optimizing leading public static calls by running them directly
+   * on the node while sending the remaining calls through the standard PXE path.
+   * Return values from both paths are merged back in original call order.
+   * @param executionPayload - The execution payload to simulate.
+   * @param opts - Simulation options (from address, fee settings, etc.).
+   * @returns The merged simulation result.
+   */
   async simulateTx(executionPayload: ExecutionPayload, opts: SimulateOptions): Promise<TxSimulationResult> {
     const feeOptions = opts.fee?.estimateGas
       ? await this.completeFeeOptionsForEstimation(opts.from, executionPayload.feePayer, opts.fee?.gasSettings)
       : await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
-    const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
-    return this.pxe.simulateTx(
-      txRequest,
-      true /* simulatePublic */,
-      opts?.skipTxValidation,
-      opts?.skipFeeEnforcement ?? true,
-    );
+    const { optimizableCalls, remainingCalls } = extractOptimizablePublicStaticCalls(executionPayload);
+    const remainingPayload = { ...executionPayload, calls: remainingCalls };
+
+    const chainInfo = await this.getChainInfo();
+    let blockHeader: BlockHeader;
+    // PXE might not be synced yet, so we pull the latest header from the node
+    // To keep things consistent, we'll always try with PXE first
+    try {
+      blockHeader = await this.pxe.getSyncedBlockHeader();
+    } catch {
+      blockHeader = (await this.aztecNode.getBlockHeader())!;
+    }
+
+    const [optimizedResults, normalResult] = await Promise.all([
+      optimizableCalls.length > 0
+        ? simulateViaNode(
+            this.aztecNode,
+            optimizableCalls,
+            opts.from,
+            chainInfo,
+            feeOptions.gasSettings,
+            blockHeader,
+            opts.skipFeeEnforcement ?? true,
+          )
+        : Promise.resolve([]),
+      remainingCalls.length > 0
+        ? this.simulateViaEntrypoint(
+            remainingPayload,
+            opts.from,
+            feeOptions,
+            opts.skipTxValidation,
+            opts.skipFeeEnforcement ?? true,
+          )
+        : Promise.resolve(null),
+    ]);
+
+    return buildMergedSimulationResult(optimizedResults, normalResult);
   }
 
   async profileTx(executionPayload: ExecutionPayload, opts: ProfileOptions): Promise<TxProfileResult> {
     const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
     const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
-    return this.pxe.profileTx(txRequest, opts.profileMode, opts.skipProofGeneration ?? true);
+    return this.pxe.profileTx(txRequest, {
+      profileMode: opts.profileMode,
+      skipProofGeneration: opts.skipProofGeneration ?? true,
+    });
   }
 
-  async sendTx(executionPayload: ExecutionPayload, opts: SendOptions): Promise<TxHash> {
+  public async sendTx<W extends InteractionWaitOptions = undefined>(
+    executionPayload: ExecutionPayload,
+    opts: SendOptions<W>,
+  ): Promise<SendReturn<W>> {
     const feeOptions = await this.completeFeeOptions(opts.from, executionPayload.feePayer, opts.fee?.gasSettings);
     const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(executionPayload, opts.from, feeOptions);
     const provenTx = await this.pxe.proveTx(txRequest);
@@ -294,7 +380,15 @@ export abstract class BaseWallet implements Wallet {
       throw this.contextualizeError(err, inspect(tx));
     });
     this.log.info(`Sent transaction ${txHash}`);
-    return txHash;
+
+    // If wait is NO_WAIT, return txHash immediately
+    if (opts.wait === NO_WAIT) {
+      return txHash as SendReturn<W>;
+    }
+
+    // Otherwise, wait for the full receipt (default behavior on wait: undefined)
+    const waitOpts = typeof opts.wait === 'object' ? opts.wait : undefined;
+    return (await waitForTx(this.aztecNode, txHash, waitOpts)) as SendReturn<W>;
   }
 
   protected contextualizeError(err: Error, ...context: string[]): Error {
@@ -312,18 +406,7 @@ export abstract class BaseWallet implements Wallet {
   }
 
   simulateUtility(call: FunctionCall, authwits?: AuthWitness[]): Promise<UtilitySimulationResult> {
-    return this.pxe.simulateUtility(call, authwits);
-  }
-
-  getContractClassMetadata(id: Fr, includeArtifact: boolean = false): Promise<ContractClassMetadata> {
-    return this.pxe.getContractClassMetadata(id, includeArtifact);
-  }
-  getContractMetadata(address: AztecAddress): Promise<ContractMetadata> {
-    return this.pxe.getContractMetadata(address);
-  }
-
-  getTxReceipt(txHash: TxHash): Promise<TxReceipt> {
-    return this.aztecNode.getTxReceipt(txHash);
+    return this.pxe.simulateUtility(call, { authwits });
   }
 
   async getPrivateEvents<T>(
@@ -345,4 +428,29 @@ export abstract class BaseWallet implements Wallet {
 
     return decodedEvents;
   }
+
+  async getContractMetadata(address: AztecAddress) {
+    const instance = await this.pxe.getContractInstance(address);
+    const initNullifier = await siloNullifier(address, address.toField());
+    const publiclyRegisteredContract = await this.aztecNode.getContract(address);
+    const initNullifierMembershipWitness = await this.aztecNode.getNullifierMembershipWitness('latest', initNullifier);
+    const isContractUpdated =
+      publiclyRegisteredContract &&
+      !publiclyRegisteredContract.currentContractClassId.equals(publiclyRegisteredContract.originalContractClassId);
+    return {
+      instance: instance ?? undefined,
+      isContractInitialized: !!initNullifierMembershipWitness,
+      isContractPublished: !!publiclyRegisteredContract,
+      isContractUpdated: !!isContractUpdated,
+      updatedContractClassId: isContractUpdated ? publiclyRegisteredContract.currentContractClassId : undefined,
+    };
+  }
+
+  async getContractClassMetadata(id: Fr) {
+    const publiclyRegisteredContractClass = await this.aztecNode.getContractClass(id);
+    return {
+      isArtifactRegistered: !!(await this.pxe.getContractArtifact(id)),
+      isContractClassPubliclyRegistered: !!publiclyRegisteredContractClass,
+    };
+  }
 }

package/src/base-wallet/index.ts

@@ -1 +1,2 @@
 export { BaseWallet, type FeeOptions } from './base_wallet.js';
+export { simulateViaNode, buildMergedSimulationResult, extractOptimizablePublicStaticCalls } from './utils.js';

package/src/base-wallet/utils.ts

@@ -0,0 +1,230 @@
+import type { AztecNode } from '@aztec/aztec.js/node';
+import { MAX_ENQUEUED_CALLS_PER_CALL } from '@aztec/constants';
+import type { ChainInfo } from '@aztec/entrypoints/interfaces';
+import { makeTuple } from '@aztec/foundation/array';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import type { Tuple } from '@aztec/foundation/serialize';
+import { generateSimulatedProvingResult } from '@aztec/pxe/simulator';
+import { type FunctionCall, FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { GasSettings } from '@aztec/stdlib/gas';
+import {
+  ClaimedLengthArray,
+  CountedPublicCallRequest,
+  PrivateCircuitPublicInputs,
+  PublicCallRequest,
+} from '@aztec/stdlib/kernel';
+import { ChonkProof } from '@aztec/stdlib/proofs';
+import {
+  type BlockHeader,
+  type ExecutionPayload,
+  HashedValues,
+  PrivateCallExecutionResult,
+  PrivateExecutionResult,
+  PublicSimulationOutput,
+  Tx,
+  TxContext,
+  TxSimulationResult,
+} from '@aztec/stdlib/tx';
+
+/**
+ * Splits an execution payload into a leading prefix of public static calls
+ * (eligible for direct node simulation) and the remaining calls.
+ *
+ * Only a leading run of public static calls is eligible for optimization.
+ * Any non-public-static call may enqueue public state mutations
+ * (e.g. private calls can enqueue public calls), so all calls that follow
+ * must go through the normal simulation path to see the correct state.
+ *
+ */
+export function extractOptimizablePublicStaticCalls(payload: ExecutionPayload): {
+  /** Leading public static calls eligible for direct node simulation. */
+  optimizableCalls: FunctionCall[];
+  /** All remaining calls. */
+  remainingCalls: FunctionCall[];
+} {
+  const splitIndex = payload.calls.findIndex(call => !call.isPublicStatic());
+  const boundary = splitIndex === -1 ? payload.calls.length : splitIndex;
+  return {
+    optimizableCalls: payload.calls.slice(0, boundary),
+    remainingCalls: payload.calls.slice(boundary),
+  };
+}
+
+/**
+ * Simulates a batch of public static calls by bypassing account entrypoint and private execution,
+ * directly constructing a minimal Tx and calling node.simulatePublicCalls.
+ *
+ * @param node - The Aztec node to simulate on.
+ * @param publicStaticCalls - Array of public static function calls (max MAX_ENQUEUED_CALLS_PER_CALL).
+ * @param from - The account address making the calls.
+ * @param chainInfo - Chain information (chainId and version).
+ * @param gasSettings - Gas settings for the transaction.
+ * @param blockHeader - Block header to use as anchor.
+ * @param skipFeeEnforcement - Whether to skip fee enforcement during simulation.
+ * @returns TxSimulationResult with public return values.
+ */
+async function simulateBatchViaNode(
+  node: AztecNode,
+  publicStaticCalls: FunctionCall[],
+  from: AztecAddress,
+  chainInfo: ChainInfo,
+  gasSettings: GasSettings,
+  blockHeader: BlockHeader,
+  skipFeeEnforcement: boolean,
+): Promise<TxSimulationResult> {
+  const txContext = new TxContext(chainInfo.chainId, chainInfo.version, gasSettings);
+
+  const publicFunctionCalldata: HashedValues[] = [];
+  for (const call of publicStaticCalls) {
+    const calldata = await HashedValues.fromCalldata([call.selector.toField(), ...call.args]);
+    publicFunctionCalldata.push(calldata);
+  }
+
+  const publicCallRequests = makeTuple(MAX_ENQUEUED_CALLS_PER_CALL, i => {
+    const call = publicStaticCalls[i];
+    if (!call) {
+      return CountedPublicCallRequest.empty();
+    }
+    const publicCallRequest = new PublicCallRequest(from, call.to, call.isStatic, publicFunctionCalldata[i]!.hash);
+    // Counter starts at 1 (minRevertibleSideEffectCounter) so all calls are revertible
+    return new CountedPublicCallRequest(publicCallRequest, i + 1);
+  });
+
+  const publicCallRequestsArray: ClaimedLengthArray<CountedPublicCallRequest, typeof MAX_ENQUEUED_CALLS_PER_CALL> =
+    new ClaimedLengthArray(
+      publicCallRequests as Tuple<CountedPublicCallRequest, typeof MAX_ENQUEUED_CALLS_PER_CALL>,
+      publicStaticCalls.length,
+    );
+
+  const publicInputs = PrivateCircuitPublicInputs.from({
+    ...PrivateCircuitPublicInputs.empty(),
+    anchorBlockHeader: blockHeader,
+    txContext: txContext,
+    publicCallRequests: publicCallRequestsArray,
+    startSideEffectCounter: new Fr(0),
+    endSideEffectCounter: new Fr(publicStaticCalls.length + 1),
+  });
+
+  // Minimal entrypoint structure — no real private execution, just public call requests
+  const emptyEntrypoint = new PrivateCallExecutionResult(
+    Buffer.alloc(0),
+    Buffer.alloc(0),
+    new Map(),
+    publicInputs,
+    [],
+    new Map(),
+    [],
+    [],
+    [],
+    [],
+    [],
+  );
+
+  const privateResult = new PrivateExecutionResult(emptyEntrypoint, Fr.random(), publicFunctionCalldata);
+
+  const provingResult = await generateSimulatedProvingResult(
+    privateResult,
+    (_contractAddress: AztecAddress, _functionSelector: FunctionSelector) => Promise.resolve(''),
+    node,
+    1, // minRevertibleSideEffectCounter
+  );
+
+  provingResult.publicInputs.feePayer = from;
+
+  const tx = await Tx.create({
+    data: provingResult.publicInputs,
+    chonkProof: ChonkProof.empty(),
+    contractClassLogFields: [],
+    publicFunctionCalldata: publicFunctionCalldata,
+  });
+
+  const publicOutput = await node.simulatePublicCalls(tx, skipFeeEnforcement);
+
+  if (publicOutput.revertReason) {
+    throw publicOutput.revertReason;
+  }
+
+  return new TxSimulationResult(privateResult, provingResult.publicInputs, publicOutput, undefined);
+}
+
+/**
+ * Simulates public static calls by splitting them into batches of MAX_ENQUEUED_CALLS_PER_CALL
+ * and sending each batch directly to the node.
+ *
+ * @param node - The Aztec node to simulate on.
+ * @param publicStaticCalls - Array of public static function calls to optimize.
+ * @param from - The account address making the calls.
+ * @param chainInfo - Chain information (chainId and version).
+ * @param gasSettings - Gas settings for the transaction.
+ * @param blockHeader - Block header to use as anchor.
+ * @param skipFeeEnforcement - Whether to skip fee enforcement during simulation.
+ * @returns Array of TxSimulationResult, one per batch.
+ */
+export async function simulateViaNode(
+  node: AztecNode,
+  publicStaticCalls: FunctionCall[],
+  from: AztecAddress,
+  chainInfo: ChainInfo,
+  gasSettings: GasSettings,
+  blockHeader: BlockHeader,
+  skipFeeEnforcement: boolean = true,
+): Promise<TxSimulationResult[]> {
+  const batches: FunctionCall[][] = [];
+
+  for (let i = 0; i < publicStaticCalls.length; i += MAX_ENQUEUED_CALLS_PER_CALL) {
+    batches.push(publicStaticCalls.slice(i, i + MAX_ENQUEUED_CALLS_PER_CALL));
+  }
+
+  const results: TxSimulationResult[] = [];
+
+  for (const batch of batches) {
+    const result = await simulateBatchViaNode(
+      node,
+      batch,
+      from,
+      chainInfo,
+      gasSettings,
+      blockHeader,
+      skipFeeEnforcement,
+    );
+    results.push(result);
+  }
+
+  return results;
+}
+
+/**
+ * Merges simulation results from the optimized (public static) and normal paths.
+ * Since optimized calls are always a leading prefix, return values are simply
+ * concatenated: optimized first, then normal.
+ * Stats are taken from the normal result only (the optimized path doesn't produce them).
+ *
+ * @param optimizedResults - Results from optimized public static call batches.
+ * @param normalResult - Result from normal simulation (null if all calls were optimized).
+ * @returns A single TxSimulationResult with return values in original call order.
+ */
+export function buildMergedSimulationResult(
+  optimizedResults: TxSimulationResult[],
+  normalResult: TxSimulationResult | null,
+): TxSimulationResult {
+  const optimizedReturnValues = optimizedResults.flatMap(r => r.publicOutput?.publicReturnValues ?? []);
+  const normalReturnValues = normalResult?.publicOutput?.publicReturnValues ?? [];
+  const allReturnValues = [...optimizedReturnValues, ...normalReturnValues];
+
+  const baseResult = normalResult ?? optimizedResults[0];
+
+  const mergedPublicOutput: PublicSimulationOutput | undefined = baseResult.publicOutput
+    ? {
+        ...baseResult.publicOutput,
+        publicReturnValues: allReturnValues,
+      }
+    : undefined;
+
+  return new TxSimulationResult(
+    baseResult.privateExecutionResult,
+    baseResult.publicInputs,
+    mergedPublicOutput,
+    normalResult?.stats,
+  );
+}