@aztec/end-to-end 0.0.1-commit.e3c1de76 → 0.0.1-commit.e57c76e

package/src/test-wallet/test_wallet.ts

@@ -0,0 +1,376 @@
+import { EcdsaKAccountContract, EcdsaRAccountContract } from '@aztec/accounts/ecdsa';
+import { SchnorrAccountContract } from '@aztec/accounts/schnorr';
+import { StubEcdsaAccountContractArtifact, createStubEcdsaAccount } from '@aztec/accounts/stub/ecdsa';
+import { StubSchnorrAccountContractArtifact, createStubSchnorrAccount } from '@aztec/accounts/stub/schnorr';
+import { type Account, type AccountContract, NO_FROM } from '@aztec/aztec.js/account';
+import type { CompleteAddress } from '@aztec/aztec.js/addresses';
+import {
+  type CallIntent,
+  type ContractFunctionInteractionCallIntent,
+  type IntentInnerHash,
+  SetPublicAuthwitContractInteraction,
+  computeInnerAuthWitHashFromAction,
+  isContractFunctionInteractionCallIntent,
+  lookupValidity,
+} from '@aztec/aztec.js/authorization';
+import type { AztecNode } from '@aztec/aztec.js/node';
+import { AccountManager, type SendOptions } from '@aztec/aztec.js/wallet';
+import { TxSimulationResultWithAppOffset } from '@aztec/aztec.js/wallet';
+import type { DefaultAccountEntrypointOptions } from '@aztec/entrypoints/account';
+import { DefaultEntrypoint } from '@aztec/entrypoints/default';
+import { Fq, Fr } from '@aztec/foundation/curves/bn254';
+import { GrumpkinScalar } from '@aztec/foundation/curves/grumpkin';
+import type { NotesFilter } from '@aztec/pxe/client/lazy';
+import { type PXEConfig, getPXEConfig } from '@aztec/pxe/config';
+import { PXE, type PXECreationOptions, createPXE } from '@aztec/pxe/server';
+import { AuthWitness } from '@aztec/stdlib/auth-witness';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { getContractClassFromArtifact } from '@aztec/stdlib/contract';
+import { deriveSigningKey } from '@aztec/stdlib/keys';
+import type { NoteDao } from '@aztec/stdlib/note';
+import {
+  type BlockHeader,
+  type ContractOverrides,
+  SimulationOverrides,
+  type TxExecutionRequest,
+  type TxHash,
+  type TxReceipt,
+} from '@aztec/stdlib/tx';
+import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
+import { BaseWallet, type SimulateViaEntrypointOptions } from '@aztec/wallet-sdk/base-wallet';
+import type { AccountType } from '@aztec/wallets/embedded';
+
+import { DEFAULT_MIN_FEE_PADDING } from '../fixtures/fixtures.js';
+import { AztecNodeProxy, ProvenTx } from './utils.js';
+
+/**
+ * Data for generating an account.
+ */
+export interface AccountData {
+  secret: Fr;
+  salt: Fr;
+  type?: AccountType;
+  contract: AccountContract;
+}
+
+/**
+ * Wallet implementation that stores accounts in memory and provides extra debugging
+ * utilities
+ * It is intended to be used in e2e tests.
+ */
+export class TestWallet extends BaseWallet {
+  constructor(
+    pxe: PXE,
+    private readonly nodeRef: AztecNodeProxy,
+  ) {
+    super(pxe, nodeRef);
+    this.minFeePadding = DEFAULT_MIN_FEE_PADDING;
+  }
+
+  static async create(
+    node: AztecNode,
+    overridePXEConfig?: Partial<PXEConfig>,
+    options: PXECreationOptions = { loggers: {} },
+  ): Promise<TestWallet> {
+    const nodeRef = new AztecNodeProxy(node);
+    const pxeConfig = Object.assign(getPXEConfig(), {
+      proverEnabled: overridePXEConfig?.proverEnabled ?? false,
+      ...overridePXEConfig,
+    });
+    const pxe = await createPXE(nodeRef, pxeConfig, options);
+    const wallet = new TestWallet(pxe, nodeRef);
+    await wallet.initStubClasses();
+    return wallet;
+  }
+
+  /**
+   * Updates the underlying node that this wallet and its PXE communicate with.
+   * @param node - The new AztecNode to forward all calls to.
+   */
+  updateNode(node: AztecNode): void {
+    this.nodeRef.updateTargetNode(node);
+  }
+
+  createSchnorrAccount(secret: Fr, salt: Fr, signingKey?: Fq): Promise<AccountManager> {
+    signingKey = signingKey ?? deriveSigningKey(secret);
+    return this.createAccount({ secret, salt, type: 'schnorr', contract: new SchnorrAccountContract(signingKey) });
+  }
+
+  createECDSARAccount(secret: Fr, salt: Fr, signingKey: Buffer): Promise<AccountManager> {
+    return this.createAccount({
+      secret,
+      salt,
+      type: 'ecdsasecp256r1',
+      contract: new EcdsaRAccountContract(signingKey),
+    });
+  }
+
+  createECDSAKAccount(secret: Fr, salt: Fr, signingKey: Buffer): Promise<AccountManager> {
+    return this.createAccount({
+      secret,
+      salt,
+      type: 'ecdsasecp256k1',
+      contract: new EcdsaKAccountContract(signingKey),
+    });
+  }
+
+  // Stub class ids, populated on wallet startup
+  // to avoid redundant work per simulation
+  private stubClassIds = new Map<AccountType, Fr>();
+
+  /**
+   * Hashes and registers the stub class for every supported account type with PXE, populating
+   * stubClassIds. Called on wallet initialization.
+   */
+  private async initStubClasses(): Promise<void> {
+    const { id: schnorrClassId } = await getContractClassFromArtifact(StubSchnorrAccountContractArtifact);
+    await this.pxe.registerContractClass(StubSchnorrAccountContractArtifact);
+
+    // ecdsa stubs share the same class id
+    const { id: ecdsaClassId } = await getContractClassFromArtifact(StubEcdsaAccountContractArtifact);
+    await this.pxe.registerContractClass(StubEcdsaAccountContractArtifact);
+
+    this.stubClassIds.set('schnorr', schnorrClassId);
+    this.stubClassIds.set('ecdsasecp256k1', ecdsaClassId);
+    this.stubClassIds.set('ecdsasecp256r1', ecdsaClassId);
+  }
+
+  /**
+   * Builds contract overrides for all provided addresses by replacing their account contracts with stub implementations.
+   */
+  protected async buildAccountOverrides(addresses: AztecAddress[]): Promise<ContractOverrides> {
+    const accounts = await this.getAccounts();
+    const contracts: ContractOverrides = {};
+
+    const filtered = accounts.filter(acc => addresses.some(addr => addr.equals(acc.item)));
+
+    for (const account of filtered) {
+      const address = account.item;
+      const originalAccount = await this.getAccountFromAddress(address);
+      const completeAddress = originalAccount.getCompleteAddress();
+      const contractInstance = await this.pxe.getContractInstance(completeAddress.address);
+      if (!contractInstance) {
+        throw new Error(
+          `No contract instance found for address: ${completeAddress.address} during account override building. This is a bug!`,
+        );
+      }
+
+      const type = this.getTypeFor(address);
+      const stubClassId = this.stubClassIds.get(type);
+      if (!stubClassId) {
+        throw new Error(
+          `Stub class for account type '${type}' was not registered at wallet init. This is a bug — initStubClasses should cover every supported AccountType.`,
+        );
+      }
+
+      contracts[address.toString()] = {
+        instance: { ...contractInstance, currentContractClassId: stubClassId },
+      };
+    }
+
+    return contracts;
+  }
+
+  protected accounts: Map<string, { account: Account; type: AccountType }> = new Map();
+
+  private getTypeFor(address: AztecAddress): AccountType {
+    return this.accounts.get(address.toString())?.type ?? 'schnorr';
+  }
+
+  private getStubAccountFor(address: AztecAddress, completeAddress: CompleteAddress) {
+    return this.getTypeFor(address) === 'schnorr'
+      ? createStubSchnorrAccount(completeAddress)
+      : createStubEcdsaAccount(completeAddress);
+  }
+
+  /**
+   * Controls how the test wallet simulates transactions:
+   * - `kernelless`: Skips kernel circuits but uses the real account contract. Default.
+   * - `kernelless-override`: Skips kernels and replaces the account with a stub that doesn't do authwit validation.
+   * - `full`: Uses real kernel circuits and real account contracts. Slow!
+   */
+  private simulationMode: 'kernelless' | 'kernelless-override' | 'full' = 'kernelless';
+
+  setSimulationMode(mode: 'kernelless' | 'kernelless-override' | 'full') {
+    this.simulationMode = mode;
+  }
+
+  setMinFeePadding(value?: number) {
+    this.minFeePadding = value ?? DEFAULT_MIN_FEE_PADDING;
+  }
+
+  protected getAccountFromAddress(address: AztecAddress): Promise<Account> {
+    const entry = this.accounts.get(address?.toString() ?? '');
+
+    if (!entry) {
+      throw new Error(`Account not found in wallet for address: ${address}`);
+    }
+
+    return Promise.resolve(entry.account);
+  }
+
+  getAccounts() {
+    return Promise.resolve(
+      Array.from(this.accounts.values()).map(entry => ({ alias: '', item: entry.account.getAddress() })),
+    );
+  }
+
+  async createAccount(accountData?: AccountData): Promise<AccountManager> {
+    const secret = accountData?.secret ?? Fr.random();
+    const salt = accountData?.salt ?? Fr.random();
+    const type = accountData?.type ?? 'schnorr';
+    const contract = accountData?.contract ?? new SchnorrAccountContract(GrumpkinScalar.random());
+
+    const accountManager = await AccountManager.create(this, secret, contract, { salt });
+
+    const instance = accountManager.getInstance();
+    const artifact = await contract.getContractArtifact();
+
+    await this.registerContract(instance, artifact, secret);
+
+    const address = accountManager.address.toString();
+    this.accounts.set(address, { account: await accountManager.getAccount(), type });
+
+    return accountManager;
+  }
+
+  lookupValidity(
+    onBehalfOf: AztecAddress,
+    intent: IntentInnerHash | CallIntent | ContractFunctionInteractionCallIntent,
+    witness: AuthWitness,
+  ): Promise<{
+    isValidInPrivate: boolean;
+    isValidInPublic: boolean;
+  }> {
+    return lookupValidity(this, onBehalfOf, intent, witness);
+  }
+
+  public setPublicAuthWit(
+    from: AztecAddress,
+    messageHashOrIntent: Fr | IntentInnerHash | CallIntent | ContractFunctionInteractionCallIntent,
+    authorized: boolean,
+  ): Promise<SetPublicAuthwitContractInteraction> {
+    return SetPublicAuthwitContractInteraction.create(this, from, messageHashOrIntent, authorized);
+  }
+
+  public override async createAuthWit(
+    from: AztecAddress,
+    intent: IntentInnerHash | CallIntent | ContractFunctionInteractionCallIntent,
+  ): Promise<AuthWitness> {
+    const account = await this.getAccountFromAddress(from);
+    const chainInfo = await this.getChainInfo();
+    let intentInnerHash: IntentInnerHash;
+    if ('caller' in intent) {
+      const call = isContractFunctionInteractionCallIntent(intent)
+        ? await intent.action.getFunctionCall()
+        : intent.call;
+      const innerHash = await computeInnerAuthWitHashFromAction(intent.caller, call);
+      intentInnerHash = { innerHash, consumer: call.to };
+    } else {
+      intentInnerHash = intent;
+    }
+    return account.createAuthWit(intentInnerHash, chainInfo);
+  }
+
+  protected override async simulateViaEntrypoint(
+    executionPayload: ExecutionPayload,
+    opts: SimulateViaEntrypointOptions,
+  ): Promise<TxSimulationResultWithAppOffset> {
+    const { from, feeOptions, additionalScopes, skipTxValidation, skipFeeEnforcement, sendMessagesAs } = opts;
+    const scopes = this.scopesFrom(from, additionalScopes);
+    const skipKernels = this.simulationMode !== 'full';
+    const useOverride = this.simulationMode === 'kernelless-override';
+
+    const feeExecutionPayload = await feeOptions.walletFeePaymentMethod?.getExecutionPayload();
+    const finalExecutionPayload = feeExecutionPayload
+      ? mergeExecutionPayloads([feeExecutionPayload, executionPayload])
+      : executionPayload;
+    const chainInfo = await this.getChainInfo();
+
+    let overrides = opts.overrides;
+    let txRequest: TxExecutionRequest;
+    if (useOverride) {
+      const accountOverrides = await this.buildAccountOverrides(scopes);
+      overrides = new SimulationOverrides({
+        publicStorage: overrides?.publicStorage,
+        contracts: { ...overrides?.contracts, ...accountOverrides },
+      });
+    }
+
+    if (from === NO_FROM) {
+      const entrypoint = new DefaultEntrypoint();
+      txRequest = await entrypoint.createTxExecutionRequest(finalExecutionPayload, feeOptions.gasSettings, chainInfo);
+    } else {
+      let fromAccount: Account;
+      if (useOverride) {
+        const originalAccount = await this.getAccountFromAddress(from);
+        fromAccount = this.getStubAccountFor(from, originalAccount.getCompleteAddress());
+      } else {
+        fromAccount = await this.getAccountFromAddress(from);
+      }
+      const executionOptions: DefaultAccountEntrypointOptions = {
+        txNonce: Fr.random(),
+        cancellable: this.cancellableTransactions,
+        // If from is an address, feeOptions include the way the account contract should handle the fee payment
+        feePaymentMethodOptions: feeOptions.accountFeePaymentMethodOptions!,
+      };
+      txRequest = await fromAccount.createTxExecutionRequest(
+        finalExecutionPayload,
+        feeOptions.gasSettings,
+        chainInfo,
+        executionOptions,
+      );
+    }
+
+    const result = await this.pxe.simulateTx(txRequest, {
+      simulatePublic: true,
+      skipKernels,
+      skipFeeEnforcement,
+      skipTxValidation,
+      overrides,
+      scopes,
+      senderForTags: this.senderForTagsFrom(from, sendMessagesAs),
+    });
+    const appCallOffset = await this.computeAppCallOffset(from, feeOptions);
+    return TxSimulationResultWithAppOffset.fromResultAndOffset(result, appCallOffset);
+  }
+
+  async proveTx(exec: ExecutionPayload, opts: Omit<SendOptions, 'wait'>): Promise<ProvenTx> {
+    const fee = await this.completeFeeOptions({
+      from: opts.from,
+      feePayer: exec.feePayer,
+      gasSettings: opts.fee?.gasSettings,
+    });
+    const txRequest = await this.createTxExecutionRequestFromPayloadAndFee(exec, opts.from, fee);
+    const txProvingResult = await this.pxe.proveTx(txRequest, {
+      scopes: this.scopesFrom(opts.from, opts.additionalScopes),
+      senderForTags: this.senderForTagsFrom(opts.from, opts.sendMessagesAs),
+    });
+    return new ProvenTx(
+      this.aztecNode,
+      await txProvingResult.toTx(),
+      txProvingResult.getOffchainEffects(),
+      txProvingResult.stats,
+    );
+  }
+
+  getTxReceipt(txHash: TxHash): Promise<TxReceipt> {
+    return this.aztecNode.getTxReceipt(txHash);
+  }
+
+  getNotes(filter: NotesFilter): Promise<NoteDao[]> {
+    return this.pxe.debug.getNotes(filter);
+  }
+
+  getSyncedBlockHeader(): Promise<BlockHeader> {
+    return this.pxe.getSyncedBlockHeader();
+  }
+
+  sync(): Promise<void> {
+    return this.pxe.sync();
+  }
+
+  stop(): Promise<void> {
+    return this.pxe.stop();
+  }
+}

package/src/test-wallet/utils.ts

@@ -0,0 +1,108 @@
+import {
+  BatchCall,
+  ContractFunctionInteraction,
+  DeployMethod,
+  type DeployOptions,
+  NO_WAIT,
+  type NoWait,
+  type SendInteractionOptions,
+  type WaitOpts,
+  toSendOptions,
+} from '@aztec/aztec.js/contracts';
+import { type AztecNode, waitForTx } from '@aztec/aztec.js/node';
+import { SimulationError } from '@aztec/stdlib/errors';
+import { type OffchainEffect, type ProvingStats, Tx, TxHash, type TxReceipt } from '@aztec/stdlib/tx';
+
+import { inspect } from 'util';
+
+import type { TestWallet } from './test_wallet.js';
+
+export type ProvenTxSendOpts = {
+  wait?: NoWait | WaitOpts;
+};
+
+export type ProvenTxSendReturn<T extends NoWait | WaitOpts | undefined> = T extends NoWait ? TxHash : TxReceipt;
+
+export class ProvenTx extends Tx {
+  constructor(
+    private node: AztecNode,
+    tx: Tx,
+    public offchainEffects: OffchainEffect[],
+    public stats?: ProvingStats,
+  ) {
+    super(tx.getTxHash(), tx.data, tx.chonkProof, tx.contractClassLogFields, tx.publicFunctionCalldata);
+  }
+
+  send(options?: Omit<ProvenTxSendOpts, 'wait'>): Promise<TxReceipt>;
+  send<W extends ProvenTxSendOpts['wait']>(options: ProvenTxSendOpts & { wait: W }): Promise<ProvenTxSendReturn<W>>;
+  async send(options?: ProvenTxSendOpts): Promise<TxHash | TxReceipt> {
+    const txHash = this.getTxHash();
+    await this.node.sendTx(this).catch(err => {
+      throw this.contextualizeError(err, inspect(this));
+    });
+
+    if (options?.wait === NO_WAIT) {
+      return txHash;
+    }
+
+    const waitOpts = typeof options?.wait === 'object' ? options.wait : undefined;
+    return await waitForTx(this.node, txHash, waitOpts);
+  }
+
+  private contextualizeError(err: Error, ...context: string[]): Error {
+    let contextStr = '';
+    if (context.length > 0) {
+      contextStr = `\nContext:\n${context.join('\n')}`;
+    }
+    if (err instanceof SimulationError) {
+      err.setAztecContext(contextStr);
+    }
+    return err;
+  }
+}
+
+export async function proveInteraction(
+  wallet: TestWallet,
+  interaction: ContractFunctionInteraction | DeployMethod | BatchCall,
+  options: SendInteractionOptions | DeployOptions,
+) {
+  const execPayload = await interaction.request(options);
+  return wallet.proveTx(execPayload, toSendOptions(options));
+}
+
+/**
+ * Extends AztecNode via declaration merging so instances can be used wherever AztecNode is expected.
+ * The actual method forwarding is handled by a Proxy in the class constructor.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
+export interface AztecNodeProxy extends AztecNode {}
+
+/**
+ * Mutable wrapper around an AztecNode that forwards all calls to the current target.
+ * Allows swapping the underlying node at runtime via updateTargetNode, which is useful
+ * for tests that need to redirect a wallet from one node to another without recreating it.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging
+export class AztecNodeProxy {
+  constructor(private target: AztecNode) {
+    return new Proxy(this, {
+      get: (obj, prop, receiver) => {
+        // Own properties and methods (updateTargetNode, target) are served directly.
+        if (Reflect.has(obj, prop)) {
+          return Reflect.get(obj, prop, receiver);
+        }
+        // Everything else is forwarded to the current target node.
+        const val = (obj.target as unknown as Record<string | symbol, unknown>)[prop];
+        return typeof val === 'function' ? val.bind(obj.target) : val;
+      },
+    });
+  }
+
+  /**
+   * Updates the underlying node that this reference points to.
+   * @param node - The new node to forward calls to.
+   */
+  updateTargetNode(node: AztecNode): void {
+    this.target = node;
+  }
+}

package/src/test-wallet/wallet_worker_script.ts

@@ -0,0 +1,63 @@
+import { createAztecNodeClient } from '@aztec/aztec.js/node';
+import type { SendOptions } from '@aztec/aztec.js/wallet';
+import { BackendType, BarretenbergSync } from '@aztec/bb.js';
+import { jsonStringify } from '@aztec/foundation/json-rpc';
+import { createLogger } from '@aztec/foundation/log';
+import type { ApiSchema, Fr } from '@aztec/foundation/schemas';
+import { getSchemaParameters, parseWithOptionals, schemaHasMethod } from '@aztec/foundation/schemas';
+import { NodeListener, TransportServer } from '@aztec/foundation/transport';
+import { ExecutionPayload, Tx } from '@aztec/stdlib/tx';
+
+import { workerData } from 'worker_threads';
+
+import { TestWallet } from './test_wallet.js';
+import { WorkerWalletSchema } from './worker_wallet_schema.js';
+
+const logger = createLogger('e2e:test-wallet:worker');
+
+try {
+  const { nodeUrl, pxeConfig } = workerData as { nodeUrl: string; pxeConfig?: Record<string, unknown> };
+
+  logger.info('Initializing worker wallet', { nodeUrl });
+  const node = createAztecNodeClient(nodeUrl);
+  // Worker sync bb use is limited to crypto and proof serialization helpers.
+  await BarretenbergSync.initSingleton({ backend: BackendType.Wasm });
+  const wallet = await TestWallet.create(node, pxeConfig);
+  logger.info('Worker wallet initialized');
+
+  const customMethods = {
+    proveTx: async (exec: ExecutionPayload, opts: Omit<SendOptions, 'wait'>) => {
+      const provenTx = await wallet.proveTx(exec, opts);
+      return new Tx(
+        provenTx.getTxHash(),
+        provenTx.data,
+        provenTx.chonkProof,
+        provenTx.contractClassLogFields,
+        provenTx.publicFunctionCalldata,
+      );
+    },
+    registerAccount: async (secret: Fr, salt: Fr) => {
+      const manager = await wallet.createSchnorrAccount(secret, salt);
+      return manager.address;
+    },
+  };
+
+  const schema = WorkerWalletSchema as ApiSchema;
+  const listener = new NodeListener();
+  const server = new TransportServer<{ fn: string; args: string }>(listener, async msg => {
+    if (!schemaHasMethod(schema, msg.fn)) {
+      throw new Error(`Unknown method: ${msg.fn}`);
+    }
+    const jsonParams = JSON.parse(msg.args) as unknown[];
+    const args: any[] = await parseWithOptionals(jsonParams, getSchemaParameters(schema[msg.fn]));
+    // we have to erase the fn type in order to be able to spread ...args
+    const handler: ((...args: any[]) => Promise<any>) | undefined =
+      msg.fn in customMethods ? customMethods[msg.fn as keyof typeof customMethods] : undefined;
+    const result = handler ? await handler(...args) : await (wallet as any)[msg.fn](...args);
+    return jsonStringify(result);
+  });
+  server.start();
+} catch (err: unknown) {
+  logger.error('Worker wallet initialization failed', { error: err instanceof Error ? err.stack : String(err) });
+  process.exit(1);
+}