@aztec/wallet-sdk 0.0.1-commit.d3ec352c → 0.0.1-commit.d58ff9d0

package/src/base-wallet/get_gas_limits.ts

@@ -0,0 +1,88 @@
+import { MAX_PROCESSABLE_L2_GAS, MAX_TX_DA_GAS } from '@aztec/constants';
+import { Gas, type GasUsed } from '@aztec/stdlib/gas';
+
+/**
+ * Returns suggested total and teardown gas limits for a simulated tx, clamped to the network's per-tx
+ * admission limits.
+ *
+ * The network only admits transactions that declare up to `maxTxGasLimits` per dimension (the
+ * node-advertised `txsLimits.gas`). Wallets pass the value read from their own node info, but since node info
+ * is remote input it is defensively clamped here to the per-tx protocol maxima so a value above them is never
+ * honored. If the simulated usage already exceeds the resulting admission limits the tx can never be included,
+ * so this throws a descriptive error instead of returning a limit the node would reject. Otherwise it pads the
+ * usage and clamps each dimension to the admission limit.
+ * @param gasUsed - The gas actually consumed during simulation.
+ * @param maxTxGasLimits - The maximum gas a single tx may declare on this network (the node-advertised `txsLimits.gas`).
+ * @param pad - Fraction to pad the suggested gas limits by (as a decimal, e.g. 0.1 for 10%). The effective
+ * padding shrinks to zero as usage approaches the network limit, since the network will not admit a higher
+ * declared limit regardless of the buffer.
+ */
+export function getGasLimits(
+  gasUsed: GasUsed,
+  maxTxGasLimits: Gas,
+  pad = 0.1,
+): {
+  /**
+   * Gas limit for the tx, excluding teardown gas
+   */
+  gasLimits: Gas;
+  /**
+   * Gas limit for the teardown phase
+   */
+  teardownGasLimits: Gas;
+} {
+  const { totalGas, teardownGas } = gasUsed;
+
+  // `maxTxGasLimits` is the node-advertised admission limit. Node info is remote input, so we defensively
+  // clamp to the per-tx protocol maxima so a value above them can never be honored.
+  const maxLimits = new Gas(
+    Math.min(maxTxGasLimits.daGas, MAX_TX_DA_GAS),
+    Math.min(maxTxGasLimits.l2Gas, MAX_PROCESSABLE_L2_GAS),
+  );
+
+  // The simulated usage must fit within the admission limits, otherwise the tx can never be included.
+  if (totalGas.daGas > maxLimits.daGas) {
+    throw new Error(
+      `Transaction consumes ${totalGas.daGas} DA gas but the network only admits transactions declaring up to ${maxLimits.daGas} DA gas`,
+    );
+  }
+  if (totalGas.l2Gas > maxLimits.l2Gas) {
+    throw new Error(
+      `Transaction consumes ${totalGas.l2Gas} L2 gas but the network only admits transactions declaring up to ${maxLimits.l2Gas} L2 gas`,
+    );
+  }
+
+  // Pad the limits by the buffer, then cap each dimension at the admission limit so the buffer cannot push a
+  // declared limit past what inbound validation accepts. Teardown is part of the total, so clamping it to the
+  // admission limit is safe.
+  return {
+    gasLimits: padGas(totalGas, pad, maxLimits),
+    teardownGasLimits: padGas(teardownGas, pad, maxLimits),
+  };
+}
+
+/** Pads each gas dimension, capping it at the network admission limit. */
+function padGas(gas: Gas, pad: number, cap: Gas): Gas {
+  const padded = gas.mul(1 + pad);
+  return new Gas(Math.min(padded.daGas, cap.daGas), Math.min(padded.l2Gas, cap.l2Gas));
+}
+
+/**
+ * Validates that caller-declared gas limits do not exceed the network's per-tx admission limits, throwing a
+ * descriptive error per dimension when they do. The node's inbound validation checks declared
+ * `gasSettings.gasLimits`, so we mirror that here to surface the rejection locally before the tx is sent.
+ * @param gasLimits - The gas limits the transaction will declare.
+ * @param maxTxGasLimits - The maximum gas a single tx may declare on this network (the node-advertised `txsLimits.gas`).
+ */
+export function assertGasLimitsWithinNetworkLimits(gasLimits: Gas, maxTxGasLimits: Gas): void {
+  if (gasLimits.daGas > maxTxGasLimits.daGas) {
+    throw new Error(
+      `Declared DA gas limit (${gasLimits.daGas}) exceeds the maximum this network allows per tx (${maxTxGasLimits.daGas})`,
+    );
+  }
+  if (gasLimits.l2Gas > maxTxGasLimits.l2Gas) {
+    throw new Error(
+      `Declared L2 gas limit (${gasLimits.l2Gas}) exceeds the maximum this network allows per tx (${maxTxGasLimits.l2Gas})`,
+    );
+  }
+}

package/src/base-wallet/index.ts

@@ -1 +1,8 @@
-export { BaseWallet, type FeeOptions } from './base_wallet.js';
+export {
+  BaseWallet,
+  type CompleteFeeOptionsConfig,
+  type FeeOptions,
+  type SimulateViaEntrypointOptions,
+} from './base_wallet.js';
+export { simulateViaNode, buildMergedSimulationResult, extractOptimizablePublicStaticCalls } from './utils.js';
+export { getGasLimits, assertGasLimitsWithinNetworkLimits } from './get_gas_limits.js';

package/src/base-wallet/utils.ts

@@ -0,0 +1,248 @@
+import type { AztecNode } from '@aztec/aztec.js/node';
+import { TxSimulationResultWithAppOffset } from '@aztec/aztec.js/wallet';
+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 type { ContractNameResolver } from '@aztec/pxe/client/lazy';
+import { displayDebugLogs } from '@aztec/pxe/client/lazy';
+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,
+  type SimulationOverrides,
+  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.
+ * @param getContractName - Resolver for contract names (used for debug log display).
+ * @param overrides - Optional pre-simulation overrides applied to the ephemeral fork and contract DB.
+ * @returns TxSimulationResult with public return values.
+ */
+async function simulateBatchViaNode(
+  node: AztecNode,
+  publicStaticCalls: FunctionCall[],
+  from: AztecAddress,
+  chainInfo: ChainInfo,
+  gasSettings: GasSettings,
+  blockHeader: BlockHeader,
+  skipFeeEnforcement: boolean,
+  getContractName: ContractNameResolver,
+  overrides?: SimulationOverrides,
+): 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, overrides);
+
+  if (publicOutput.revertReason) {
+    throw publicOutput.revertReason;
+  }
+
+  // Display debug logs from the public simulation.
+  await displayDebugLogs(publicOutput.debugLogs, getContractName);
+
+  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.
+ * @param getContractName - Resolver for contract names (used for debug log display).
+ * @param overrides - Optional pre-simulation overrides applied to the ephemeral fork and contract DB.
+ * @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,
+  getContractName: ContractNameResolver,
+  overrides?: SimulationOverrides,
+): 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,
+      getContractName,
+      overrides,
+    );
+    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: TxSimulationResultWithAppOffset | null,
+): TxSimulationResultWithAppOffset {
+  const optimizedReturnValues = optimizedResults.flatMap(r => r.publicOutput?.publicReturnValues ?? []);
+  const normalReturnValues = normalResult?.publicOutput?.publicReturnValues ?? [];
+  const allReturnValues = [...optimizedReturnValues, ...normalReturnValues];
+
+  const baseResult: TxSimulationResult = normalResult ?? optimizedResults[0];
+
+  const mergedPublicOutput: PublicSimulationOutput | undefined = baseResult.publicOutput
+    ? {
+        ...baseResult.publicOutput,
+        publicReturnValues: allReturnValues,
+      }
+    : undefined;
+
+  const merged = new TxSimulationResult(
+    baseResult.privateExecutionResult,
+    baseResult.publicInputs,
+    mergedPublicOutput,
+    normalResult?.stats,
+  );
+  return TxSimulationResultWithAppOffset.fromResultAndOffset(merged, normalResult?.appCallOffset ?? 0);
+}