@walletmesh/aztec-rpc-wallet 0.1.0 → 0.2.0

package/src/serializers/core.test.ts

@@ -1,56 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { Fr, AztecAddress, CompleteAddress, AuthWitness, TxHash } from '@aztec/aztec.js';
-import {
-  frSerializer,
-  aztecAddressSerializer,
-  completeAddressSerializer,
-  authWitnessSerializer,
-  txHashSerializer,
-} from './core.js';
-
-describe('Core Serializers', () => {
-  describe('FrSerializer', () => {
-    it('should serialize and deserialize Fr values', () => {
-      const original = Fr.random();
-      const serialized = frSerializer.serialize(original);
-      const deserialized = frSerializer.deserialize(serialized);
-      expect(deserialized.toString()).toBe(original.toString());
-    });
-  });
-
-  describe('AztecAddressSerializer', () => {
-    it('should serialize and deserialize AztecAddress values', () => {
-      const original = AztecAddress.random();
-      const serialized = aztecAddressSerializer.serialize(original);
-      const deserialized = aztecAddressSerializer.deserialize(serialized);
-      expect(deserialized.toString()).toBe(original.toString());
-    });
-  });
-
-  describe('CompleteAddressSerializer', () => {
-    it('should serialize and deserialize CompleteAddress values', () => {
-      const original = CompleteAddress.random();
-      const serialized = completeAddressSerializer.serialize(original);
-      const deserialized = completeAddressSerializer.deserialize(serialized);
-      expect(deserialized.toString()).toBe(original.toString());
-    });
-  });
-
-  describe('AuthWitnessSerializer', () => {
-    it('should serialize and deserialize AuthWitness values', () => {
-      const original = AuthWitness.random();
-      const serialized = authWitnessSerializer.serialize(original);
-      const deserialized = authWitnessSerializer.deserialize(serialized);
-      expect(deserialized.toString()).toBe(original.toString());
-    });
-  });
-
-  describe('TxHashSerializer', () => {
-    it('should serialize and deserialize TxHash values', () => {
-      const original = TxHash.random();
-      const serialized = txHashSerializer.serialize(original);
-      const deserialized = txHashSerializer.deserialize(serialized);
-      expect(deserialized.toString()).toBe(original.toString());
-    });
-  });
-});

package/src/serializers/core.ts

@@ -1,141 +0,0 @@
-import { Fr, AztecAddress, CompleteAddress, AuthWitness, TxHash } from '@aztec/aztec.js';
-import { encodeBase64, decodeBase64 } from './types.js';
-import type { TypeSerializer } from './types.js';
-
-/**
- * Serializer for Fr (field element) values in the Aztec protocol.
- * Handles conversion of field elements to/from base64-encoded strings for RPC transport.
- * Field elements are fundamental to Aztec's cryptographic operations.
- */
-export class FrSerializer implements TypeSerializer<Fr> {
-  /**
-   * Converts an Fr value to a base64-encoded string.
-   * @param value - The field element to serialize
-   * @returns Base64-encoded string representation
-   */
-  serialize(value: Fr): string {
-    return encodeBase64(value.toString());
-  }
-
-  /**
-   * Reconstructs an Fr value from a base64-encoded string.
-   * @param data - The base64-encoded string to deserialize
-   * @returns Reconstructed field element
-   * @throws If the input string is not a valid field element representation
-   */
-  deserialize(data: string): Fr {
-    return Fr.fromHexString(decodeBase64(data));
-  }
-}
-
-/**
- * Serializer for Aztec protocol addresses.
- * Handles conversion of AztecAddress instances to/from base64-encoded strings.
- * Aztec addresses represent accounts and contracts in the protocol.
- */
-export class AztecAddressSerializer implements TypeSerializer<AztecAddress> {
-  /**
-   * Converts an AztecAddress to a base64-encoded string.
-   * @param value - The Aztec address to serialize
-   * @returns Base64-encoded string representation
-   */
-  serialize(value: AztecAddress): string {
-    return encodeBase64(value.toString());
-  }
-
-  /**
-   * Reconstructs an AztecAddress from a base64-encoded string.
-   * @param data - The base64-encoded string to deserialize
-   * @returns Reconstructed Aztec address
-   * @throws If the input string is not a valid address representation
-   */
-  deserialize(data: string): AztecAddress {
-    return AztecAddress.fromString(decodeBase64(data));
-  }
-}
-
-/**
- * Serializer for complete Aztec addresses that include additional metadata.
- * CompleteAddress extends AztecAddress with extra information needed for certain operations.
- */
-export class CompleteAddressSerializer implements TypeSerializer<CompleteAddress> {
-  /**
-   * Converts a CompleteAddress to a base64-encoded string.
-   * @param value - The complete address to serialize
-   * @returns Base64-encoded string representation
-   */
-  serialize(value: CompleteAddress): string {
-    return encodeBase64(value.toString());
-  }
-
-  /**
-   * Reconstructs a CompleteAddress from a base64-encoded string.
-   * @param data - The base64-encoded string to deserialize
-   * @returns Reconstructed complete address
-   * @throws If the input string is not a valid complete address representation
-   */
-  deserialize(data: string): CompleteAddress {
-    return CompleteAddress.fromString(decodeBase64(data));
-  }
-}
-
-/**
- * Serializer for authentication witnesses in the Aztec protocol.
- * AuthWitness values are used to prove transaction authorization.
- */
-export class AuthWitnessSerializer implements TypeSerializer<AuthWitness> {
-  /**
-   * Converts an AuthWitness to a base64-encoded string.
-   * @param value - The authentication witness to serialize
-   * @returns Base64-encoded string representation
-   */
-  serialize(value: AuthWitness): string {
-    return encodeBase64(value.toString());
-  }
-
-  /**
-   * Reconstructs an AuthWitness from a base64-encoded string.
-   * @param data - The base64-encoded string to deserialize
-   * @returns Reconstructed authentication witness
-   * @throws If the input string is not a valid auth witness representation
-   */
-  deserialize(data: string): AuthWitness {
-    return AuthWitness.fromString(decodeBase64(data));
-  }
-}
-
-/**
- * Serializer for transaction hashes in the Aztec protocol.
- * TxHash values uniquely identify transactions and are used for lookups and references.
- */
-export class TxHashSerializer implements TypeSerializer<TxHash> {
-  /**
-   * Converts a TxHash to a base64-encoded string.
-   * @param value - The transaction hash to serialize
-   * @returns Base64-encoded string representation
-   */
-  serialize(value: TxHash): string {
-    return encodeBase64(value.toString());
-  }
-
-  /**
-   * Reconstructs a TxHash from a base64-encoded string.
-   * @param data - The base64-encoded string to deserialize
-   * @returns Reconstructed transaction hash
-   * @throws If the input string is not a valid transaction hash representation
-   */
-  deserialize(data: string): TxHash {
-    return TxHash.fromString(decodeBase64(data));
-  }
-}
-
-/**
- * Pre-instantiated serializer instances for common Aztec types.
- * These singletons should be used instead of creating new instances
- * to ensure consistent serialization across the application.
- */
-export const frSerializer = new FrSerializer();
-export const aztecAddressSerializer = new AztecAddressSerializer();
-export const completeAddressSerializer = new CompleteAddressSerializer();
-export const authWitnessSerializer = new AuthWitnessSerializer();
-export const txHashSerializer = new TxHashSerializer();

package/src/serializers/types.ts

@@ -1,58 +0,0 @@
-import type { JSONRPCSerializedData, JSONRPCSerializer } from '@walletmesh/jsonrpc';
-
-/**
- * Base interface for type-specific serializers in the Aztec RPC wallet.
- * Provides a standardized way to convert Aztec-specific types to and from string representations
- * for network transmission. Each Aztec type (Fr, AztecAddress, etc.) implements this interface
- * to ensure consistent serialization across the RPC layer.
- *
- * @typeParam T - The Aztec type being serialized (e.g., Fr, AztecAddress, TxHash)
- */
-export interface TypeSerializer<T> {
-  /**
-   * Converts a value to its string representation for network transmission.
-   * Implementations should ensure the serialized form can be correctly deserialized
-   * back to the original type.
-   *
-   * @param value - The Aztec type value to serialize
-   * @returns A string representation suitable for network transmission
-   */
-  serialize(value: T): string;
-
-  /**
-   * Reconstructs a value from its string representation.
-   * Implementations should validate the input string and throw appropriate errors
-   * if the data cannot be correctly deserialized.
-   *
-   * @param data - The string data to deserialize, previously created by serialize()
-   * @returns The reconstructed Aztec type value
-   * @throws If the data is invalid or cannot be deserialized
-   */
-  deserialize(data: string): T;
-}
-
-// Re-export core JSON-RPC types from @walletmesh/jsonrpc
-export type { JSONRPCSerializedData, JSONRPCSerializer };
-
-/**
- * Helper function to encode data as base64 for safe network transmission.
- * Used throughout the serializers to ensure consistent encoding of binary data.
- *
- * @param data - The string data to encode
- * @returns Base64 encoded string
- */
-export function encodeBase64(data: string): string {
-  return btoa(data);
-}
-
-/**
- * Helper function to decode base64 data back to its original form.
- * Used throughout the serializers to decode data received over the network.
- *
- * @param data - The base64 encoded string to decode
- * @returns Original decoded string
- * @throws If the input is not valid base64
- */
-export function decodeBase64(data: string): string {
-  return atob(data);
-}