@walletmesh/aztec-rpc-wallet 0.4.1 → 0.5.4

package/src/wallet/handlers/transaction.test.ts

@@ -1,19 +1,27 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { createTransactionHandlers } from './transaction.js';
-import type { AccountWallet, PXE, AztecAddress, TxHash, AuthWitness } from '@aztec/aztec.js';
-import type { TxExecutionRequest, Tx, TxReceipt } from '@aztec/aztec.js';
-// import type { FeeOptions, TxExecutionOptions } from '@aztec/entrypoints/interfaces'; // Unused
-// import type { ExecutionPayload } from '@aztec/entrypoints/payload'; // Unused
-import type { AztecHandlerContext } from './index.js';
-import type { ContractArtifactCache } from '../../contractArtifactCache.js';
+import type {
+  AccountWallet,
+  AuthWitness,
+  AztecAddress,
+  PXE,
+  Tx,
+  TxExecutionRequest,
+  TxHash,
+  TxReceipt,
+} from '@aztec/aztec.js';
 import { Fr } from '@aztec/aztec.js';
 import type {
   PrivateExecutionResult,
+  TxProfileResult,
   TxProvingResult,
   TxSimulationResult,
-  TxProfileResult,
   UtilitySimulationResult,
 } from '@aztec/stdlib/tx';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import type { ContractArtifactCache } from '../../contractArtifactCache.js';
+// import type { FeeOptions, TxExecutionOptions } from '@aztec/entrypoints/interfaces'; // Unused
+// import type { ExecutionPayload } from '@aztec/entrypoints/payload'; // Unused
+import type { AztecHandlerContext } from './index.js';
+import { createTransactionHandlers } from './transaction.js';
 
 // Mock dependencies
 const createMockWallet = () =>
@@ -175,7 +183,6 @@ describe('Transaction Handlers', () => {
         txRequest: { exec: { calls: [] } },
       } as unknown as TxExecutionRequest;
       const simulatePublic = true;
-      const msgSender = '0x1234567890abcdef' as unknown as AztecAddress;
       const skipTxValidation = true;
       const skipFeeEnforcement = true;
 
@@ -190,7 +197,6 @@ describe('Transaction Handlers', () => {
       const result = await handlers.aztec_simulateTx(context, [
         txRequest,
         simulatePublic,
-        msgSender,
         skipTxValidation,
         skipFeeEnforcement,
       ]);
@@ -198,9 +204,9 @@ describe('Transaction Handlers', () => {
       expect(mockWallet.simulateTx).toHaveBeenCalledWith(
         txRequest,
         simulatePublic,
-        msgSender,
         skipTxValidation,
         skipFeeEnforcement,
+        undefined
       );
       expect(result).toBe(expectedSimulation);
     });
@@ -226,7 +232,7 @@ describe('Transaction Handlers', () => {
         undefined,
       ]);
 
-      expect(mockWallet.simulateTx).toHaveBeenCalledWith(txRequest, false, undefined, undefined, false);
+      expect(mockWallet.simulateTx).toHaveBeenCalledWith(txRequest, false, undefined, false, undefined);
       expect(result).toBe(expectedSimulation);
     });
 

package/src/wallet/handlers/transaction.ts

@@ -1,6 +1,6 @@
-import type { AztecHandlerContext } from './index.js';
-import type { AztecWalletMethodMap } from '../../types.js';
 import { createLogger } from '@aztec/foundation/log';
+import type { AztecWalletMethodMap } from '../../types.js';
+import type { AztecHandlerContext } from './index.js';
 
 const logger = createLogger('aztec-rpc-wallet:transaction');
 
@@ -139,9 +139,10 @@ export function createTransactionHandlers() {
      *                      Defined by {@link AztecWalletMethodMap.aztec_simulateTx.params}.
      * @param paramsTuple.0 - The {@link TxExecutionRequest} to simulate.
      * @param paramsTuple.1 - Optional: Boolean indicating whether to simulate public parts of the transaction. Defaults to `false`.
-     * @param paramsTuple.2 - Optional: The {@link AztecAddress} of the message sender for simulation context.
-     * @param paramsTuple.3 - Optional: Boolean flag to skip transaction validation during simulation.
-     * @param paramsTuple.4 - Optional: Boolean flag to skip fee enforcement during simulation.
+     * @param paramsTuple.2 - Optional: Boolean flag to skip transaction validation during simulation.
+     * @param paramsTuple.3 - Optional: Boolean flag to skip fee enforcement during simulation.
+     * @param paramsTuple.4 - Optional: {@link SimulationOverrides} for simulation context (includes msgSender).
+     * @param paramsTuple.5 - Optional: Array of {@link AztecAddress} scopes for the simulation.
      * @returns A promise that resolves to the {@link TxSimulationResult}.
      *          Type defined by {@link AztecWalletMethodMap.aztec_simulateTx.result}.
      * @throws {Error} If the `txRequest` parameter is missing or invalid.
@@ -153,9 +154,9 @@ export function createTransactionHandlers() {
       const [
         txRequest,
         simulatePublicInput, // simulatePublic is optional in PXE interface
-        msgSender,
         skipTxValidation,
         skipFeeEnforcementInput, // skipFeeEnforcement is optional in PXE interface
+        overrides, // SimulationOverrides which may contain msgSender
       ] = paramsTuple;
       // Handle optional params with defaults if necessary, matching PXE behavior
       const simulatePublic = simulatePublicInput === undefined ? false : simulatePublicInput;
@@ -166,12 +167,14 @@ export function createTransactionHandlers() {
         // txRequest is mandatory
         throw new Error('Invalid txRequest parameter received in tuple');
       }
+
+      // Call with the parameters that the underlying wallet expects
       return await ctx.wallet.simulateTx(
         txRequest,
         simulatePublic,
-        msgSender,
         skipTxValidation,
         skipFeeEnforcement,
+        overrides,
       );
     },
 

package/src/wallet/serializers.test.ts

@@ -1,12 +1,11 @@
-import { describe, it, expect } from 'vitest';
-import { AztecAddress, Fr, AuthWitness } from '@aztec/aztec.js';
 import type { ContractArtifact } from '@aztec/aztec.js';
-import { FunctionSelector } from '@aztec/stdlib/abi';
-import { FunctionType } from '@aztec/stdlib/abi';
-import { Capsule, HashedValues } from '@aztec/stdlib/tx';
+import { AuthWitness, AztecAddress, Fr } from '@aztec/aztec.js';
 import { ExecutionPayload } from '@aztec/entrypoints/payload';
+import { emptyFunctionArtifact, FunctionCall, FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
+import { randomContractArtifact } from '@aztec/stdlib/testing';
+import { Capsule, HashedValues } from '@aztec/stdlib/tx';
+import { describe, expect, it } from 'vitest';
 import { AztecWalletSerializer } from './serializers.js';
-import { FunctionCall } from '@aztec/stdlib/abi';
 
 describe('ExecutionPayload Serialization', () => {
   it('should serialize and deserialize ExecutionPayload correctly', async () => {
@@ -97,40 +96,15 @@ describe('ExecutionPayload Serialization', () => {
 describe('DeployContract Serialization', () => {
   it('should serialize and deserialize aztec_wmDeployContract params correctly', async () => {
     // Create a minimal valid ContractArtifact
-    const artifact: ContractArtifact = {
-      name: 'TestContract',
-      functions: [
-        {
-          name: 'constructor',
-          functionType: FunctionType.PRIVATE,
-          isInternal: false,
-          isStatic: false,
-          isInitializer: true,
-          parameters: [
-            {
-              name: 'owner',
-              type: { kind: 'field' },
-              visibility: 'private',
-            },
-          ],
-          returnTypes: [],
-          errorTypes: {},
-          bytecode: Buffer.from('test'),
-          debugSymbols: '',
-        },
-      ],
-      nonDispatchPublicFunctions: [],
-      outputs: {
-        structs: {},
-        globals: {},
-      },
-      storageLayout: {},
-      notes: {},
-      fileMap: {},
-    };
+    const artifact: ContractArtifact = await randomContractArtifact();
 
     const args = [AztecAddress.random().toString(), '12345'];
     const constructorName = 'constructor';
+    const functionArtifact = emptyFunctionArtifact();
+    functionArtifact.name = constructorName;
+    functionArtifact.functionType = FunctionType.PUBLIC;
+    functionArtifact.isInitializer = true;
+    artifact.functions.push(functionArtifact);
 
     // Test params serialization
     const params = { artifact, args, constructorName };
@@ -153,9 +127,10 @@ describe('DeployContract Serialization', () => {
       constructorName?: string;
     };
 
+
     // Verify the artifact structure
     expect(result.artifact).toBeDefined();
-    expect(result.artifact.name).toBe('TestContract');
+    expect(result.artifact.name).toBe(artifact.name);
     expect(result.artifact.functions).toHaveLength(1);
     expect(result.artifact.functions[0]?.name).toBe('constructor');
     expect(result.artifact.functions[0]?.isInitializer).toBe(true);
@@ -168,18 +143,7 @@ describe('DeployContract Serialization', () => {
   });
 
   it('should handle aztec_wmDeployContract without constructorName', async () => {
-    const artifact: ContractArtifact = {
-      name: 'TestContract',
-      functions: [],
-      nonDispatchPublicFunctions: [],
-      outputs: {
-        structs: {},
-        globals: {},
-      },
-      storageLayout: {},
-      notes: {},
-      fileMap: {},
-    };
+    const artifact: ContractArtifact = await randomContractArtifact();
 
     const args: unknown[] = [];
 
@@ -220,18 +184,7 @@ describe('DeployContract Serialization', () => {
   });
 
   it('should validate args array in aztec_wmDeployContract', async () => {
-    const artifact: ContractArtifact = {
-      name: 'TestContract',
-      functions: [],
-      nonDispatchPublicFunctions: [],
-      outputs: {
-        structs: {},
-        globals: {},
-      },
-      storageLayout: {},
-      notes: {},
-      fileMap: {},
-    };
+    const artifact: ContractArtifact = await randomContractArtifact();
 
     // Test with various types in args array
     const args = ['string value', 123, true, { nested: 'object' }, ['array', 'of', 'values'], null];

package/src/wallet/serializers.ts

@@ -19,33 +19,23 @@
  *   to reconstruct complex Aztec objects from their JSON representations.
  */
 
-import type { AztecWalletMethodMap } from '../types.js';
-
-import type {
-  JSONRPCNode,
-  JSONRPCSerializer,
-  JSONRPCSerializedData,
-  JSONRPCParams,
-} from '@walletmesh/jsonrpc';
-import { JSONRPCError } from '@walletmesh/jsonrpc';
-
+import type { NodeInfo } from '@aztec/aztec.js';
 import {
+  AuthWitness,
   AztecAddress,
   CompleteAddress,
-  TxExecutionRequest,
   Fr,
   Tx,
+  TxExecutionRequest,
   TxHash,
-  AuthWitness,
 } from '@aztec/aztec.js';
-import type { NodeInfo } from '@aztec/aztec.js';
-
 import type { IntentAction, IntentInnerHash } from '@aztec/aztec.js/utils';
+import { jsonStringify } from '@aztec/foundation/json-rpc';
+import { createLogger } from '@aztec/foundation/log';
+import type { ZodFor } from '@aztec/foundation/schemas';
 
 import { AbiTypeSchema, ContractArtifactSchema, FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
-import { schemas } from '@aztec/stdlib/schemas';
-
-import type { PXEInfo, ContractMetadata, ContractClassMetadata } from '@aztec/stdlib/interfaces/client';
+import { L2Block } from '@aztec/stdlib/block';
 import {
   ContractClassWithIdSchema,
   ContractInstanceWithAddressSchema,
@@ -53,7 +43,8 @@ import {
   ProtocolContractAddressesSchema,
 } from '@aztec/stdlib/contract';
 import { GasFees } from '@aztec/stdlib/gas';
-import { L2Block } from '@aztec/stdlib/block';
+import type { ContractClassMetadata, ContractMetadata, PXEInfo } from '@aztec/stdlib/interfaces/client';
+import { schemas } from '@aztec/stdlib/schemas';
 import {
   Capsule,
   HashedValues,
@@ -64,18 +55,21 @@ import {
   TxSimulationResult,
   UtilitySimulationResult,
 } from '@aztec/stdlib/tx';
-
-import { jsonStringify, jsonParseWithSchema } from '@aztec/foundation/json-rpc';
-import { createLogger } from '@aztec/foundation/log';
-import type { ZodFor } from '@aztec/foundation/schemas';
-
-import { z, type ZodTypeAny } from 'zod';
+import type {
+  JSONRPCNode,
+  JSONRPCParams,
+  JSONRPCSerializedData,
+  JSONRPCSerializer,
+} from '@walletmesh/jsonrpc';
+import { JSONRPCError } from '@walletmesh/jsonrpc';
+import { type ZodTypeAny, z } from 'zod';
+import type { AztecWalletMethodMap } from '../types.js';
 
 // These aren't exported by @aztec/stdlib/interfaces/client, we've copied them here
 const ContractMetadataSchema = z.object({
   contractInstance: z.union([ContractInstanceWithAddressSchema, z.undefined()]),
   isContractInitialized: z.boolean(),
-  isContractPubliclyDeployed: z.boolean(),
+  isContractPublished: z.boolean(),
 }) satisfies ZodFor<ContractMetadata>;
 
 const ContractClassMetadataSchema = z.object({
@@ -128,13 +122,17 @@ const DeployContractResultSchema = z.object({
 
 const logger = createLogger('aztec-rpc-wallet:serializers');
 
+async function jsonParseWithSchemaAsync<T>(json: string, schema: ZodTypeAny): Promise<T> {
+  return schema.parseAsync(JSON.parse(json));
+}
+
 function createResultSerializer<R>(resultSchema?: ZodTypeAny): Pick<JSONRPCSerializer<unknown, R>, 'result'> {
   return {
     result: {
       serialize: async (method: string, value: R) => ({ method, serialized: jsonStringify(value) }),
       deserialize: async (method: string, data: JSONRPCSerializedData) => {
         if (resultSchema) {
-          return await jsonParseWithSchema(data.serialized, resultSchema);
+          return await jsonParseWithSchemaAsync(data.serialized, resultSchema);
         }
         // If no schema is provided, parse as JSON
         logger.debug(`Deserializing result for method without schema: ${method}`);
@@ -383,13 +381,13 @@ export const AztecWalletSerializer: JSONRPCSerializer<JSONRPCParams, unknown> =
         case 'aztec_registerContract': {
           const instanceRaw = ensureParam<Record<string, unknown>>(dAppParams, 'instance');
           const artifactRaw = getOptionalParam<Record<string, unknown>>(dAppParams, 'artifact');
-          const instance = ContractInstanceWithAddressSchema.parse(instanceRaw);
-          const artifact = artifactRaw ? ContractArtifactSchema.parse(artifactRaw) : undefined;
+          const instance = await ContractInstanceWithAddressSchema.parseAsync(instanceRaw);
+          const artifact = artifactRaw ? await ContractArtifactSchema.parseAsync(artifactRaw) : undefined;
           return [instance, artifact];
         }
         case 'aztec_registerContractClass': {
           const artifactRaw = ensureParam<Record<string, unknown>>(dAppParams, 'artifact');
-          const artifact = ContractArtifactSchema.parse(artifactRaw);
+          const artifact = await ContractArtifactSchema.parseAsync(artifactRaw);
           return [artifact];
         }
         case 'aztec_proveTx': {
@@ -400,16 +398,16 @@ export const AztecWalletSerializer: JSONRPCSerializer<JSONRPCParams, unknown> =
             dAppParams,
             'privateExecutionResult',
           );
-          const txRequest = TxExecutionRequest.schema.parse(txRequestRaw);
+          const txRequest = await TxExecutionRequest.schema.parseAsync(txRequestRaw);
           // Conditionally parse if privateExecutionResultRaw is present
           const privateExecutionResult = privateExecutionResultRaw
-            ? PrivateExecutionResult.schema.parse(privateExecutionResultRaw)
+            ? await PrivateExecutionResult.schema.parseAsync(privateExecutionResultRaw)
             : undefined;
           return [txRequest, privateExecutionResult];
         }
         case 'aztec_sendTx': {
           const txRaw = ensureParam<Record<string, unknown>>(dAppParams, 'tx');
-          const tx = Tx.schema.parse(txRaw);
+          const tx = await Tx.schema.parseAsync(txRaw);
           return [tx];
         }
         case 'aztec_getTxReceipt': {
@@ -419,7 +417,7 @@ export const AztecWalletSerializer: JSONRPCSerializer<JSONRPCParams, unknown> =
         }
         case 'aztec_simulateTx': {
           const txRequestRaw = ensureParam<Record<string, unknown>>(dAppParams, 'txRequest');
-          const txRequest = TxExecutionRequest.schema.parse(txRequestRaw);
+          const txRequest = await TxExecutionRequest.schema.parseAsync(txRequestRaw);
           const simulatePublic = getOptionalParam<boolean>(dAppParams, 'simulatePublic', 'boolean');
           const msgSenderStr = getOptionalParam<string>(dAppParams, 'msgSender', 'string');
           const msgSender = msgSenderStr ? AztecAddress.fromString(msgSenderStr) : undefined;
@@ -431,7 +429,7 @@ export const AztecWalletSerializer: JSONRPCSerializer<JSONRPCParams, unknown> =
         }
         case 'aztec_profileTx': {
           const txRequestRaw = ensureParam<Record<string, unknown>>(dAppParams, 'txRequest');
-          const txRequest = TxExecutionRequest.schema.parse(txRequestRaw);
+          const txRequest = await TxExecutionRequest.schema.parseAsync(txRequestRaw);
           const profileMode = getOptionalParam<'gates' | 'execution-steps' | 'full'>(
             dAppParams,
             'profileMode',
@@ -448,7 +446,7 @@ export const AztecWalletSerializer: JSONRPCSerializer<JSONRPCParams, unknown> =
           const toStr = ensureParam<string>(dAppParams, 'to', 'string');
           const to = AztecAddress.fromString(toStr);
           const authWitsRaw = getOptionalParam<Record<string, unknown>[]>(dAppParams, 'authWits');
-          const authWits = authWitsRaw?.map((aw) => AuthWitness.schema.parse(aw)); // Use AuthWitness from @aztec/aztec.js
+          const authWits = await authWitsRaw?.map((aw) => AuthWitness.schema.parseAsync(aw)); // Use AuthWitness from @aztec/aztec.js
           const fromStr = getOptionalParam<string>(dAppParams, 'from', 'string');
           const from = fromStr ? AztecAddress.fromString(fromStr) : undefined;
           return [functionName, args, to, authWits, from];
@@ -457,7 +455,10 @@ export const AztecWalletSerializer: JSONRPCSerializer<JSONRPCParams, unknown> =
           const contractAddressStr = ensureParam<string>(dAppParams, 'contractAddress', 'string');
           const contractAddress = AztecAddress.fromString(contractAddressStr);
           const eventMetadataRaw = ensureParam<string>(dAppParams, 'eventMetadata');
-          const eventMetadata = jsonParseWithSchema(eventMetadataRaw, EventMetadataDefinitionSchema);
+          const eventMetadata = await jsonParseWithSchemaAsync(
+            eventMetadataRaw,
+            EventMetadataDefinitionSchema,
+          );
           const fromBlock = ensureParam<number>(dAppParams, 'from', 'number');
           const numBlocks = ensureParam<number>(dAppParams, 'numBlocks', 'number');
           const recipientsRaw = ensureParam<string[]>(dAppParams, 'recipients');
@@ -466,23 +467,26 @@ export const AztecWalletSerializer: JSONRPCSerializer<JSONRPCParams, unknown> =
         }
         case 'aztec_getPublicEvents': {
           const eventMetadataRaw = ensureParam<string>(dAppParams, 'eventMetadata');
-          const eventMetadata = jsonParseWithSchema(eventMetadataRaw, EventMetadataDefinitionSchema);
+          const eventMetadata = await jsonParseWithSchemaAsync(
+            eventMetadataRaw,
+            EventMetadataDefinitionSchema,
+          );
           const fromBlock = ensureParam<number>(dAppParams, 'from', 'number');
           const limit = ensureParam<number>(dAppParams, 'limit', 'number');
           return [eventMetadata, fromBlock, limit];
         }
         case 'aztec_wmExecuteTx': {
           const executionPayloadRaw = ensureParam<Record<string, unknown>>(dAppParams, 'executionPayload');
-          const executionPayload = ExecutionPayloadSchema.parse(executionPayloadRaw);
+          const executionPayload = await ExecutionPayloadSchema.parseAsync(executionPayloadRaw);
           return [executionPayload];
         }
         case 'aztec_wmSimulateTx': {
           const executionPayloadRaw = ensureParam<Record<string, unknown>>(dAppParams, 'executionPayload');
-          const executionPayload = ExecutionPayloadSchema.parse(executionPayloadRaw);
+          const executionPayload = await ExecutionPayloadSchema.parseAsync(executionPayloadRaw);
           return [executionPayload];
         }
         case 'aztec_wmDeployContract': {
-          const deployParams = DeployContractParamsSchema.parse(dAppParams);
+          const deployParams = await DeployContractParamsSchema.parseAsync(dAppParams);
           return [deployParams];
         }
         case 'wm_getSupportedMethods':