@walletmesh/aztec-rpc-wallet 0.1.0 → 0.2.0

package/src/serializers/contract.ts

@@ -1,15 +1,14 @@
 import type { AztecWalletMethodMap } from '../types.js';
-import type { JSONRPCSerializedData, JSONRPCSerializer } from './types.js';
-import { encodeBase64, decodeBase64 } from './types.js';
-import { aztecAddressSerializer, frSerializer } from './core.js';
-import { SerializableContractInstance } from '@aztec/circuits.js';
+import type { JSONRPCSerializedData, JSONRPCSerializer } from '@walletmesh/jsonrpc';
+import { SerializableContractInstance, ContractClassWithIdSchema } from '@aztec/circuits.js';
 import { ContractArtifactSchema } from '@aztec/foundation/abi';
-import { serializeContractClassWithId, deserializeContractClassWithId } from './contract-utils.js';
+import { AztecAddress, Fr } from '@aztec/aztec.js';
+import type { ContractInstanceWithAddress } from '@aztec/aztec.js';
+import { jsonStringify, jsonParseWithSchema } from '@aztec/foundation/json-rpc';
 
 /**
  * Serializer for the aztec_getContractInstance RPC method.
  * Handles serialization of contract instance queries and results between JSON-RPC format and native Aztec types.
- * Used to retrieve deployed contract instances by their address.
  */
 export class AztecGetContractInstanceSerializer
   implements
@@ -28,25 +27,17 @@ export class AztecGetContractInstanceSerializer
     serialize: (
       method: string,
       value: AztecWalletMethodMap['aztec_getContractInstance']['params'],
-    ): JSONRPCSerializedData => {
-      const { address } = value;
-      return {
-        method,
-        serialized: encodeBase64(aztecAddressSerializer.serialize(address)),
-      };
-    },
-    /**
-     * Deserializes contract instance query parameters from RPC transport.
-     * @param method - The RPC method name
-     * @param data - The serialized address data
-     * @returns Deserialized query parameters
-     */
+    ): JSONRPCSerializedData => ({
+      method,
+      serialized: jsonStringify(value.address),
+    }),
     deserialize: (
-      method: string,
+      _method: string,
       data: JSONRPCSerializedData,
     ): AztecWalletMethodMap['aztec_getContractInstance']['params'] => {
-      const address = aztecAddressSerializer.deserialize(decodeBase64(data.serialized));
-      return { address };
+      return {
+        address: jsonParseWithSchema(data.serialized, AztecAddress.schema),
+      };
     },
   };
 
@@ -57,37 +48,18 @@ export class AztecGetContractInstanceSerializer
      * @param value - The contract instance data including address and state
      * @returns Serialized contract instance data
      */
-    serialize: (
-      method: string,
-      value: AztecWalletMethodMap['aztec_getContractInstance']['result'],
-    ): JSONRPCSerializedData => {
-      const serializable = new SerializableContractInstance(value);
-      const { address } = value;
-
-      return {
-        method,
-        serialized: encodeBase64(
-          JSON.stringify({
-            instance: serializable.toBuffer().toString('hex'),
-            address: aztecAddressSerializer.serialize(address),
-          }),
-        ),
-      };
-    },
-    /**
-     * Deserializes the contract instance query result.
-     * @param method - The RPC method name
-     * @param data - The serialized contract instance data
-     * @returns Deserialized contract instance
-     */
-    deserialize: (
-      method: string,
-      data: JSONRPCSerializedData,
-    ): AztecWalletMethodMap['aztec_getContractInstance']['result'] => {
-      const { instance, address } = JSON.parse(decodeBase64(data.serialized));
-      const baseInstance = SerializableContractInstance.fromBuffer(Buffer.from(instance, 'hex'));
-      const deserializedAddress = aztecAddressSerializer.deserialize(address);
-      return baseInstance.withAddress(deserializedAddress);
+    serialize: (method: string, value: ContractInstanceWithAddress): JSONRPCSerializedData => ({
+      method,
+      serialized: JSON.stringify({
+        serializableContractInstance: new SerializableContractInstance(value).toBuffer(),
+        address: jsonStringify(value.address),
+      }),
+    }),
+    deserialize: (_method: string, data: JSONRPCSerializedData): ContractInstanceWithAddress => {
+      const parsed = JSON.parse(data.serialized);
+      return SerializableContractInstance.fromBuffer(
+        Buffer.from(parsed.serializableContractInstance),
+      ).withAddress(jsonParseWithSchema(parsed.address, AztecAddress.schema));
     },
   };
 }
@@ -95,7 +67,6 @@ export class AztecGetContractInstanceSerializer
 /**
  * Serializer for the aztec_getContractClass RPC method.
  * Handles serialization of contract class queries and results between JSON-RPC format and native Aztec types.
- * Used to retrieve contract class definitions by their ID.
  */
 export class AztecGetContractClassSerializer
   implements
@@ -114,25 +85,18 @@ export class AztecGetContractClassSerializer
     serialize: (
       method: string,
       value: AztecWalletMethodMap['aztec_getContractClass']['params'],
-    ): JSONRPCSerializedData => {
-      const { id } = value;
-      return {
-        method,
-        serialized: encodeBase64(frSerializer.serialize(id)),
-      };
-    },
-    /**
-     * Deserializes contract class query parameters from RPC transport.
-     * @param method - The RPC method name
-     * @param data - The serialized class ID data
-     * @returns Deserialized query parameters
-     */
+    ): JSONRPCSerializedData => ({
+      method,
+      serialized: JSON.stringify({
+        id: value.id.toString(),
+      }),
+    }),
     deserialize: (
-      method: string,
+      _method: string,
       data: JSONRPCSerializedData,
     ): AztecWalletMethodMap['aztec_getContractClass']['params'] => {
-      const id = frSerializer.deserialize(decodeBase64(data.serialized));
-      return { id };
+      const { id } = JSON.parse(data.serialized);
+      return { id: Fr.fromString(id) };
     },
   };
 
@@ -146,25 +110,16 @@ export class AztecGetContractClassSerializer
     serialize: (
       method: string,
       value: AztecWalletMethodMap['aztec_getContractClass']['result'],
-    ): JSONRPCSerializedData => {
-      const serialized = serializeContractClassWithId(value);
-      return {
-        method,
-        serialized: encodeBase64(JSON.stringify(serialized)),
-      };
-    },
-    /**
-     * Deserializes the contract class query result.
-     * @param method - The RPC method name
-     * @param data - The serialized contract class data
-     * @returns Deserialized contract class with ID
-     */
+    ): JSONRPCSerializedData => ({
+      method,
+      serialized: JSON.stringify(value),
+    }),
     deserialize: (
-      method: string,
+      _method: string,
       data: JSONRPCSerializedData,
     ): AztecWalletMethodMap['aztec_getContractClass']['result'] => {
-      const parsed = JSON.parse(decodeBase64(data.serialized));
-      return deserializeContractClassWithId(parsed);
+      const parsed = JSON.parse(data.serialized);
+      return ContractClassWithIdSchema.parse(parsed);
     },
   };
 }
@@ -172,7 +127,6 @@ export class AztecGetContractClassSerializer
 /**
  * Serializer for the aztec_getContractArtifact RPC method.
  * Handles serialization of contract artifact queries and results between JSON-RPC format and native Aztec types.
- * Used to retrieve contract artifacts (ABI, bytecode, etc.) by their ID.
  */
 export class AztecGetContractArtifactSerializer
   implements
@@ -191,25 +145,18 @@ export class AztecGetContractArtifactSerializer
     serialize: (
       method: string,
       value: AztecWalletMethodMap['aztec_getContractArtifact']['params'],
-    ): JSONRPCSerializedData => {
-      const { id } = value;
-      return {
-        method,
-        serialized: encodeBase64(frSerializer.serialize(id)),
-      };
-    },
-    /**
-     * Deserializes contract artifact query parameters from RPC transport.
-     * @param method - The RPC method name
-     * @param data - The serialized artifact ID data
-     * @returns Deserialized query parameters
-     */
+    ): JSONRPCSerializedData => ({
+      method,
+      serialized: JSON.stringify({
+        id: value.id.toString(),
+      }),
+    }),
     deserialize: (
-      method: string,
+      _method: string,
       data: JSONRPCSerializedData,
     ): AztecWalletMethodMap['aztec_getContractArtifact']['params'] => {
-      const id = frSerializer.deserialize(decodeBase64(data.serialized));
-      return { id };
+      const { id } = JSON.parse(data.serialized);
+      return { id: Fr.fromString(id) };
     },
   };
 
@@ -223,32 +170,21 @@ export class AztecGetContractArtifactSerializer
     serialize: (
       method: string,
       value: AztecWalletMethodMap['aztec_getContractArtifact']['result'],
-    ): JSONRPCSerializedData => {
-      return {
-        method,
-        serialized: encodeBase64(JSON.stringify(value)),
-      };
-    },
-    /**
-     * Deserializes the contract artifact query result.
-     * @param method - The RPC method name
-     * @param data - The serialized artifact data
-     * @returns Deserialized contract artifact
-     * @throws If the data doesn't match the contract artifact schema
-     */
+    ): JSONRPCSerializedData => ({
+      method,
+      serialized: JSON.stringify(ContractArtifactSchema.parse(value)),
+    }),
     deserialize: (
-      method: string,
+      _method: string,
       data: JSONRPCSerializedData,
-    ): AztecWalletMethodMap['aztec_getContractArtifact']['result'] => {
-      return ContractArtifactSchema.parse(JSON.parse(decodeBase64(data.serialized)));
-    },
+    ): AztecWalletMethodMap['aztec_getContractArtifact']['result'] =>
+      ContractArtifactSchema.parse(JSON.parse(data.serialized)),
   };
 }
 
 /**
  * Serializer for the aztec_registerContract RPC method.
  * Handles serialization of contract registration requests between JSON-RPC format and native Aztec types.
- * Used to register new contract instances with optional artifacts.
  */
 export class AztecRegisterContractSerializer
   implements
@@ -267,44 +203,24 @@ export class AztecRegisterContractSerializer
     serialize: (
       method: string,
       value: AztecWalletMethodMap['aztec_registerContract']['params'],
-    ): JSONRPCSerializedData => {
-      const { instance, artifact } = value;
-      const serializable = new SerializableContractInstance(instance);
-
-      const serializedInstance = {
-        instance: Buffer.from(serializable.toBuffer()).toString('base64'),
-        address: aztecAddressSerializer.serialize(instance.address),
-      };
-
-      const serializedArtifact = artifact ? JSON.stringify(artifact) : undefined;
-
-      return {
-        method,
-        serialized: encodeBase64(
-          JSON.stringify({
-            instance: serializedInstance,
-            artifact: serializedArtifact,
-          }),
-        ),
-      };
-    },
-    /**
-     * Deserializes contract registration parameters from RPC transport.
-     * @param method - The RPC method name
-     * @param data - The serialized registration data
-     * @returns Deserialized registration parameters
-     */
+    ): JSONRPCSerializedData => ({
+      method,
+      serialized: JSON.stringify({
+        serializableContractInstance: new SerializableContractInstance(value.instance).toBuffer(),
+        address: value.instance.address.toString(),
+        artifact: value.artifact ? ContractArtifactSchema.parse(value.artifact) : undefined,
+      }),
+    }),
     deserialize: (
-      method: string,
+      _method: string,
       data: JSONRPCSerializedData,
     ): AztecWalletMethodMap['aztec_registerContract']['params'] => {
-      const { instance, artifact } = JSON.parse(decodeBase64(data.serialized));
-      const { instance: instanceBuffer, address } = instance;
-      const baseInstance = SerializableContractInstance.fromBuffer(Buffer.from(instanceBuffer, 'base64'));
-      const deserializedAddress = aztecAddressSerializer.deserialize(address);
+      const { serializableContractInstance, address, artifact } = JSON.parse(data.serialized);
       return {
-        instance: baseInstance.withAddress(deserializedAddress),
-        artifact: artifact ? JSON.parse(artifact) : undefined,
+        instance: SerializableContractInstance.fromBuffer(
+          Buffer.from(serializableContractInstance),
+        ).withAddress(AztecAddress.fromString(address)),
+        artifact: artifact ? ContractArtifactSchema.parse(artifact) : undefined,
       };
     },
   };
@@ -319,24 +235,14 @@ export class AztecRegisterContractSerializer
     serialize: (
       method: string,
       value: AztecWalletMethodMap['aztec_registerContract']['result'],
-    ): JSONRPCSerializedData => {
-      return {
-        method,
-        serialized: encodeBase64(JSON.stringify(value)),
-      };
-    },
-    /**
-     * Deserializes the contract registration result.
-     * @param method - The RPC method name
-     * @param data - The serialized result data
-     * @returns Boolean indicating success
-     */
+    ): JSONRPCSerializedData => ({
+      method,
+      serialized: JSON.stringify(value),
+    }),
     deserialize: (
-      method: string,
+      _method: string,
       data: JSONRPCSerializedData,
-    ): AztecWalletMethodMap['aztec_registerContract']['result'] => {
-      return JSON.parse(decodeBase64(data.serialized));
-    },
+    ): AztecWalletMethodMap['aztec_registerContract']['result'] => JSON.parse(data.serialized),
   };
 }
 

package/src/serializers/index.test.ts

@@ -2,6 +2,7 @@ import { describe, expect, it, beforeEach, vi } from 'vitest';
 import { AztecWalletSerializer } from './index.js';
 import { AztecAddress, Tx } from '@aztec/aztec.js';
 import type { JSONRPCSerializer } from './types.js';
+import type { AztecWalletMethodMap } from '../types.js';
 
 describe('AztecWalletSerializer', () => {
   // Test known method (using aztec_setScopes as an example)
@@ -14,8 +15,8 @@ describe('AztecWalletSerializer', () => {
   const resultSerializer = (AztecWalletSerializer as Required<JSONRPCSerializer<unknown, unknown>>).result;
 
   describe('params', () => {
-    it('should serialize params for known methods', () => {
-      const params = { scopes: [AztecAddress.random()] };
+    it('should serialize params for known methods', async () => {
+      const params = { scopes: [await AztecAddress.random()] };
       const result = AztecWalletSerializer.params.serialize(knownMethod, params);
       expect(result).toBeDefined();
       expect(result.method).toBe(knownMethod);
@@ -97,26 +98,37 @@ describe('AztecWalletSerializer', () => {
   });
 
   describe('integration', () => {
-    it('should handle contract methods', () => {
+    it('should handle contract methods', async () => {
       const method = 'aztec_getContractInstance';
-      const params = { address: AztecAddress.random() };
+      const params = { address: await AztecAddress.random() };
 
       const serializedParams = AztecWalletSerializer.params.serialize(method, params);
       expect(serializedParams).toBeDefined();
       expect(serializedParams.method).toBe(method);
       expect(typeof serializedParams.serialized).toBe('string');
+
+      const deserializedParams = AztecWalletSerializer.params.deserialize(
+        method,
+        serializedParams,
+      ) as AztecWalletMethodMap['aztec_getContractInstance']['params'];
+      expect(deserializedParams.address.toString()).toBe(params.address.toString());
     });
 
-    it('should handle transaction methods', () => {
+    it('should handle transaction methods', async () => {
       const method = 'aztec_sendTx';
-      const params = {
-        tx: Tx.random(),
-      };
+      const tx = await Tx.random();
+      const params = { tx };
 
       const serializedParams = AztecWalletSerializer.params.serialize(method, params);
       expect(serializedParams).toBeDefined();
       expect(serializedParams.method).toBe(method);
       expect(typeof serializedParams.serialized).toBe('string');
+
+      const deserializedParams = AztecWalletSerializer.params.deserialize(
+        method,
+        serializedParams,
+      ) as AztecWalletMethodMap['aztec_sendTx']['params'];
+      expect(deserializedParams.tx.toBuffer().toString('hex')).toBe(tx.toBuffer().toString('hex'));
     });
   });
 });

package/src/serializers/index.ts

@@ -1,13 +1,10 @@
 import type { AztecWalletMethodMap } from '../types.js';
-import type { JSONRPCSerializer, JSONRPCSerializedData } from './types.js';
-import { encodeBase64 } from './types.js';
+import type { JSONRPCSerializedData, JSONRPCSerializer } from '@walletmesh/jsonrpc';
 
 /**
  * Re-export all serializer types and implementations.
  * This provides a single entry point for importing any serializer functionality.
  */
-export * from './types.js';
-export * from './core.js';
 export * from './account.js';
 export * from './contract.js';
 export * from './transaction.js';
@@ -32,16 +29,15 @@ import {
   aztecProveTxSerializer,
   aztecSendTxSerializer,
   aztecGetTxReceiptSerializer,
+  aztecGetTxEffectSerializer,
+  aztecSimulateTxSerializer,
 } from './transaction.js';
+import { aztecGetNotesSerializer, aztecAddNoteSerializer, aztecAddNullifiedNoteSerializer } from './note.js';
 import {
-  aztecGetIncomingNotesSerializer,
-  aztecAddNoteSerializer,
-  aztecAddNullifiedNoteSerializer,
-} from './note.js';
-import {
-  aztecGetUnencryptedLogsSerializer,
-  aztecGetEncryptedEventsSerializer,
-  aztecGetUnencryptedEventsSerializer,
+  aztecGetPublicLogsSerializer,
+  aztecGetContractClassLogsSerializer,
+  aztecGetPrivateEventsSerializer,
+  aztecGetPublicEventsSerializer,
 } from './log.js';
 
 /**
@@ -50,18 +46,6 @@ import {
  */
 type AztecMethodName = keyof AztecWalletMethodMap;
 
-/**
- * Type helper for extracting parameter types for a given method.
- * @typeParam T - The method name to get parameters for
- */
-type AztecMethodParams<T extends AztecMethodName> = AztecWalletMethodMap[T]['params'];
-
-/**
- * Type helper for extracting result types for a given method.
- * @typeParam T - The method name to get result type for
- */
-type AztecMethodResult<T extends AztecMethodName> = AztecWalletMethodMap[T]['result'];
-
 /**
  * Registry of all available method serializers.
  * Maps each RPC method name to its corresponding serializer implementation.
@@ -86,16 +70,19 @@ const methodSerializers: Record<AztecMethodName, JSONRPCSerializer<unknown, unkn
   aztec_proveTx: aztecProveTxSerializer,
   aztec_sendTx: aztecSendTxSerializer,
   aztec_getTxReceipt: aztecGetTxReceiptSerializer,
+  aztec_getTxEffect: aztecGetTxEffectSerializer,
+  aztec_simulateTx: aztecSimulateTxSerializer,
 
   // Note methods
-  aztec_getIncomingNotes: aztecGetIncomingNotesSerializer,
+  aztec_getNotes: aztecGetNotesSerializer,
   aztec_addNote: aztecAddNoteSerializer,
   aztec_addNullifiedNote: aztecAddNullifiedNoteSerializer,
 
   // Log methods
-  aztec_getUnencryptedLogs: aztecGetUnencryptedLogsSerializer,
-  aztec_getEncryptedEvents: aztecGetEncryptedEventsSerializer,
-  aztec_getUnencryptedEvents: aztecGetUnencryptedEventsSerializer,
+  aztec_getPublicLogs: aztecGetPublicLogsSerializer,
+  aztec_getContractClassLogs: aztecGetContractClassLogsSerializer,
+  aztec_getPrivateEvents: aztecGetPrivateEventsSerializer,
+  aztec_getPublicEvents: aztecGetPublicEventsSerializer,
 };
 
 /**
@@ -109,7 +96,7 @@ const methodSerializers: Record<AztecMethodName, JSONRPCSerializer<unknown, unkn
 function wrapUnknownValue(method: string, value: unknown): JSONRPCSerializedData {
   return {
     method,
-    serialized: encodeBase64(JSON.stringify(value)),
+    serialized: JSON.stringify(value),
   };
 }
 
@@ -208,6 +195,3 @@ export const AztecWalletSerializer: JSONRPCSerializer<unknown, unknown> = {
     },
   },
 };
-
-// Export the main serializer interface
-export type { JSONRPCSerializer } from './types.js';