@walletmesh/aztec-rpc-wallet 0.3.0 → 0.4.0

package/src/provider.ts

@@ -1,189 +0,0 @@
-import type { JSONRPCTransport } from '@walletmesh/jsonrpc';
-import type { RouterEventMap } from '@walletmesh/router';
-import { WalletRouterProvider } from '@walletmesh/router';
-import { AztecWalletError, AztecWalletErrorType } from './errors.js';
-import type { AztecChainId, AztecWalletMethodMap, TransactionParams } from './types.js';
-
-/**
- * Provider for interacting with multiple Aztec chains through WalletMesh router.
- *
- * This class implements the client-side interface for dApps to communicate with Aztec wallets.
- * It handles:
- * - Connection management for multiple chains
- * - Session tracking
- * - Method calls with proper context
- * - Event handling for wallet state changes
- *
- * @example
- * ```typescript
- * // Create provider with transport
- * const provider = new AztecProvider(transport);
- *
- * // Connect to chains
- * await provider.connect(['aztec:testnet', 'aztec:devnet']);
- *
- * // Single operation using convenience method
- * const address = await provider.getAccount('aztec:testnet');
- *
- * // Single operation using chain builder
- * const txHash = await provider.chain('aztec:testnet')
- *   .call('aztec_sendTransaction', {
- *     functionCalls: [{
- *       contractAddress: "0x...",
- *       functionName: "transfer",
- *       args: [recipient, amount]
- *     }]
- *   })
- *   .execute();
- *
- * // Multiple operations in one call
- * const [account, contracts, blockNumber] = await provider
- *   .chain('aztec:testnet')
- *   .call('aztec_getAccount')
- *   .call('aztec_getContracts')
- *   .call('aztec_getBlockNumber')
- *   .execute();
- * ```
- */
-export class AztecProvider extends WalletRouterProvider {
-  private connectedChains: Set<AztecChainId>;
-  private requestedChains: Set<AztecChainId>;
-
-  constructor(transport: JSONRPCTransport) {
-    super(transport);
-    this.connectedChains = new Set();
-    this.requestedChains = new Set();
-
-    // Bind event handlers
-    this.handleWalletStateChanged = this.handleWalletStateChanged.bind(this);
-    this.handleSessionTerminated = this.handleSessionTerminated.bind(this);
-
-    // Register event handlers
-    this.on('wm_walletStateChanged', this.handleWalletStateChanged);
-    this.on('wm_sessionTerminated', this.handleSessionTerminated);
-  }
-
-  /**
-   * Handles wallet state change events from the router.
-   * Updates the set of connected chains based on account availability.
-   * @param params - Event parameters containing chain ID and changes
-   */
-  private handleWalletStateChanged(params: RouterEventMap['wm_walletStateChanged']): void {
-    const { chainId, changes } = params;
-    const aztecChainId = chainId as AztecChainId;
-
-    // Only handle events for requested chains
-    if (this.requestedChains.has(aztecChainId)) {
-      if (changes.accounts && changes.accounts.length > 0) {
-        this.connectedChains.add(aztecChainId);
-        console.log('Chain connected:', aztecChainId);
-      } else {
-        this.connectedChains.delete(aztecChainId);
-        console.log('Chain disconnected:', aztecChainId);
-      }
-      console.log('Connected chains:', Array.from(this.connectedChains));
-    }
-  }
-
-  /**
-   * Handles session termination events from the router.
-   * Cleans up session state and connected chains.
-   * @param params - Event parameters containing session ID
-   */
-  private handleSessionTerminated(params: RouterEventMap['wm_sessionTerminated']): void {
-    const { sessionId } = params;
-    if (sessionId === this.sessionId) {
-      this.connectedChains.clear();
-      this.requestedChains.clear();
-      console.log('Session terminated, all chains cleared');
-    }
-  }
-
-  /**
-   * Gets the list of currently connected chain IDs.
-   * @returns Array of connected chain IDs
-   */
-  public getSupportedChains(): AztecChainId[] {
-    return Array.from(this.connectedChains);
-  }
-
-  public async getAccount(chainId: AztecChainId): Promise<string> {
-    const result = await this.chain(chainId).call('aztec_getAccount').execute();
-    if (typeof result !== 'string' || !result) {
-      throw new AztecWalletError(AztecWalletErrorType.invalidResponse, 'Invalid account address returned');
-    }
-    return result;
-  }
-
-  /**
-   * Sends a transaction to the specified chain.
-   * @param chainId - ID of the chain to send transaction to
-   * @param params - Transaction parameters including function calls and optional auth witnesses
-   * @returns Transaction hash
-   * @throws {AztecWalletError} If transaction fails or response invalid
-   */
-  public async sendTransaction(chainId: AztecChainId, params: TransactionParams): Promise<string> {
-    const result = await this.chain(chainId).call('aztec_sendTransaction', params).execute();
-    if (typeof result !== 'string' || !result) {
-      throw new AztecWalletError(AztecWalletErrorType.invalidResponse, 'Invalid transaction hash returned');
-    }
-    return result;
-  }
-
-  /**
-   * Simulates a transaction without submitting it.
-   * @param chainId - ID of the chain to simulate on
-   * @param params - Transaction parameters to simulate
-   * @returns Simulation result
-   * @throws {AztecWalletError} If simulation fails
-   */
-  public async simulateTransaction(
-    chainId: AztecChainId,
-    params: TransactionParams['functionCalls'][0],
-  ): Promise<unknown> {
-    const result = await this.chain(chainId).call('aztec_simulateTransaction', params).execute();
-    if (result === undefined || result === null) {
-      throw new AztecWalletError(AztecWalletErrorType.invalidResponse, 'Invalid simulation result returned');
-    }
-    return result;
-  }
-
-  /**
-   * Registers a contract instance with the wallet.
-   * @param chainId - ID of the chain where contract is deployed
-   * @param params - Contract registration parameters
-   * @throws {AztecWalletError} If registration fails
-   */
-  public async registerContract(
-    chainId: AztecChainId,
-    params: AztecWalletMethodMap['aztec_registerContract']['params'],
-  ): Promise<void> {
-    await this.chain(chainId).call('aztec_registerContract', params).execute();
-  }
-
-  /**
-   * Registers a contract class with the wallet.
-   * @param chainId - ID of the chain to register on
-   * @param params - Contract class registration parameters
-   * @throws {AztecWalletError} If registration fails
-   */
-  public async registerContractClass(
-    chainId: AztecChainId,
-    params: AztecWalletMethodMap['aztec_registerContractClass']['params'],
-  ): Promise<void> {
-    await this.chain(chainId).call('aztec_registerContractClass', params).execute();
-  }
-
-  /**
-   * Registers a transaction sender with the wallet.
-   * @param chainId - ID of the chain to register on
-   * @param params - Sender registration parameters
-   * @throws {AztecWalletError} If registration fails
-   */
-  public async registerSender(
-    chainId: AztecChainId,
-    params: AztecWalletMethodMap['aztec_registerSender']['params'],
-  ): Promise<void> {
-    await this.chain(chainId).call('aztec_registerSender', params).execute();
-  }
-}

package/src/serializers/account.test.ts

@@ -1,125 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { Fr, AztecAddress, CompleteAddress, AuthWitness } from '@aztec/aztec.js';
-import {
-  aztecSetScopesSerializer,
-  aztecRegisterAccountSerializer,
-  aztecAddAuthWitnessSerializer,
-  aztecGetAuthWitnessSerializer,
-} from './account.js';
-import { schemas } from '@aztec/foundation/schemas';
-
-describe('Account Serializers', () => {
-  describe('aztec_setScopes', () => {
-    const METHOD = 'aztec_setScopes';
-
-    it('should serialize and deserialize params', async () => {
-      const scopes = [await AztecAddress.random(), await AztecAddress.random()];
-      const params = { scopes };
-
-      const serialized = await aztecSetScopesSerializer.params.serialize(METHOD, params);
-      expect(serialized.method).toBe(METHOD);
-
-      const deserialized = await aztecSetScopesSerializer.params.deserialize(METHOD, serialized);
-      expect(deserialized.scopes.map((s) => s.toString())).toEqual(scopes.map((s) => s.toString()));
-    });
-
-    it('should serialize and deserialize result', async () => {
-      const result = true;
-
-      const serialized = await aztecSetScopesSerializer.result.serialize(METHOD, result);
-      expect(serialized.method).toBe(METHOD);
-
-      const deserialized = await aztecSetScopesSerializer.result.deserialize(METHOD, serialized);
-      expect(deserialized).toBe(result);
-    });
-  });
-
-  describe('aztec_registerAccount', () => {
-    const METHOD = 'aztec_registerAccount';
-
-    it('should serialize and deserialize params', async () => {
-      const secretKey = await Fr.random();
-      const partialAddress = await Fr.random();
-      const params = { secretKey, partialAddress };
-
-      const serialized = await aztecRegisterAccountSerializer.params.serialize(METHOD, params);
-      expect(serialized.method).toBe(METHOD);
-
-      const deserialized = await aztecRegisterAccountSerializer.params.deserialize(METHOD, serialized);
-      expect(deserialized.secretKey.toString()).toBe(secretKey.toString());
-      expect(deserialized.partialAddress.toString()).toBe(partialAddress.toString());
-    });
-
-    it('should serialize and deserialize result', async () => {
-      const result = await CompleteAddress.random();
-
-      const serialized = await aztecRegisterAccountSerializer.result.serialize(METHOD, result);
-      expect(serialized.method).toBe(METHOD);
-
-      const deserialized = await aztecRegisterAccountSerializer.result.deserialize(METHOD, serialized);
-      expect(deserialized.toString()).toBe(result.toString());
-    });
-  });
-
-  describe('aztec_addAuthWitness', () => {
-    const METHOD = 'aztec_addAuthWitness';
-
-    it('should serialize and deserialize params', async () => {
-      const authWitness = await AuthWitness.random();
-      const params = { authWitness };
-
-      const serialized = await aztecAddAuthWitnessSerializer.params.serialize(METHOD, params);
-      expect(serialized.method).toBe(METHOD);
-
-      const deserialized = await aztecAddAuthWitnessSerializer.params.deserialize(METHOD, serialized);
-      expect(deserialized.authWitness.toString()).toBe(authWitness.toString());
-    });
-
-    it('should serialize and deserialize result', async () => {
-      const result = true;
-
-      const serialized = await aztecAddAuthWitnessSerializer.result.serialize(METHOD, result);
-      expect(serialized.method).toBe(METHOD);
-
-      const deserialized = await aztecAddAuthWitnessSerializer.result.deserialize(METHOD, serialized);
-      expect(deserialized).toBe(result);
-    });
-  });
-
-  describe('aztec_getAuthWitness', () => {
-    const METHOD = 'aztec_getAuthWitness';
-
-    it('should serialize and deserialize params', async () => {
-      const messageHash = await Fr.random();
-      const params = { messageHash };
-
-      const serialized = await aztecGetAuthWitnessSerializer.params.serialize(METHOD, params);
-      expect(serialized.method).toBe(METHOD);
-
-      const deserialized = await aztecGetAuthWitnessSerializer.params.deserialize(METHOD, serialized);
-      expect(deserialized.messageHash.toString()).toBe(messageHash.toString());
-    });
-
-    it('should serialize and deserialize result', async () => {
-      const result = [await Fr.random(), await Fr.random()];
-
-      const serialized = await aztecGetAuthWitnessSerializer.result.serialize(METHOD, result);
-      expect(serialized.method).toBe(METHOD);
-
-      const deserialized = await aztecGetAuthWitnessSerializer.result.deserialize(METHOD, serialized);
-      expect(deserialized.map((w) => w.toString())).toEqual(result.map((w) => w.toString()));
-    });
-  });
-
-  describe('Base64 encoding/decoding', () => {
-    it('should properly encode and decode data', async () => {
-      const messageHash = await Fr.random();
-
-      const serialized = await aztecGetAuthWitnessSerializer.params.serialize('aztec_getAuthWitness', {
-        messageHash,
-      });
-      const decoded = schemas.Fr.parse(JSON.parse(serialized.serialized));
-      expect(decoded.toString()).toBe(messageHash.toString());
-    });
-  });
-});

package/src/serializers/account.ts

@@ -1,301 +0,0 @@
-import type { AztecWalletMethodMap } from '../types.js';
-import type { JSONRPCSerializedData, JSONRPCSerializer } from '@walletmesh/jsonrpc';
-import type { PartialAddress } from '@aztec/aztec.js';
-import { CompleteAddress, AuthWitness, AztecAddress, Fr } from '@aztec/aztec.js';
-
-/**
- * Serializer for the aztec_setScopes RPC method.
- * Handles serialization of account scope settings between JSON-RPC format and native Aztec types.
- */
-export class AztecSetScopesSerializer
-  implements
-    JSONRPCSerializer<
-      AztecWalletMethodMap['aztec_setScopes']['params'],
-      AztecWalletMethodMap['aztec_setScopes']['result']
-    >
-{
-  params = {
-    /**
-     * Serializes scope setting parameters for RPC transport.
-     * @param method - The RPC method name
-     * @param value - The parameters containing an array of Aztec addresses representing scopes
-     * @returns Serialized scope data
-     */
-    serialize: async (
-      method: string,
-      value: AztecWalletMethodMap['aztec_setScopes']['params'],
-    ): Promise<JSONRPCSerializedData> => {
-      const { scopes } = value;
-      return Promise.resolve({
-        method,
-        serialized: JSON.stringify({
-          scopes: scopes.map((s) => s.toString()),
-        }),
-      });
-    },
-    /**
-     * Deserializes scope setting parameters from RPC transport.
-     * @param _method - The RPC method name
-     * @param data - The serialized scope data
-     * @returns Deserialized scope parameters
-     */
-    deserialize: async (
-      _method: string,
-      data: JSONRPCSerializedData,
-    ): Promise<AztecWalletMethodMap['aztec_setScopes']['params']> => {
-      const { scopes } = JSON.parse(data.serialized);
-      return Promise.resolve({
-        scopes: scopes.map((s: string) => AztecAddress.fromString(s)),
-      });
-    },
-  };
-
-  result = {
-    /**
-     * Serializes the scope setting result.
-     * @param method - The RPC method name
-     * @param value - Boolean indicating success of the scope setting operation
-     * @returns Serialized result
-     */
-    serialize: async (method: string, value: boolean): Promise<JSONRPCSerializedData> => {
-      return Promise.resolve({
-        method,
-        serialized: JSON.stringify(value),
-      });
-    },
-    /**
-     * Deserializes the scope setting result.
-     * @param _method - The RPC method name
-     * @param data - The serialized result data
-     * @returns Boolean indicating success
-     */
-    deserialize: async (_method: string, data: JSONRPCSerializedData): Promise<boolean> => {
-      return Promise.resolve(JSON.parse(data.serialized));
-    },
-  };
-}
-
-/**
- * Serializer for the aztec_registerAccount RPC method.
- * Handles serialization of account registration data between JSON-RPC format and native Aztec types.
- */
-export class AztecRegisterAccountSerializer
-  implements
-    JSONRPCSerializer<
-      AztecWalletMethodMap['aztec_registerAccount']['params'],
-      AztecWalletMethodMap['aztec_registerAccount']['result']
-    >
-{
-  params = {
-    /**
-     * Serializes account registration parameters for RPC transport.
-     * @param method - The RPC method name
-     * @param value - The parameters containing secret key and partial address
-     * @returns Serialized registration data
-     */
-    serialize: async (
-      method: string,
-      value: AztecWalletMethodMap['aztec_registerAccount']['params'],
-    ): Promise<JSONRPCSerializedData> => {
-      const { secretKey, partialAddress } = value;
-      return Promise.resolve({
-        method,
-        serialized: JSON.stringify({
-          secretKey: secretKey.toString(),
-          partialAddress: partialAddress.toString(),
-        }),
-      });
-    },
-    /**
-     * Deserializes account registration parameters from RPC transport.
-     * @param _method - The RPC method name
-     * @param data - The serialized registration data
-     * @returns Deserialized registration parameters
-     */
-    deserialize: async (
-      _method: string,
-      data: JSONRPCSerializedData,
-    ): Promise<AztecWalletMethodMap['aztec_registerAccount']['params']> => {
-      const { secretKey, partialAddress } = JSON.parse(data.serialized);
-      return Promise.resolve({
-        secretKey: Fr.fromString(secretKey),
-        partialAddress: Fr.fromString(partialAddress) as PartialAddress,
-      });
-    },
-  };
-
-  result = {
-    /**
-     * Serializes the account registration result.
-     * @param method - The RPC method name
-     * @param value - The complete address of the registered account
-     * @returns Serialized complete address
-     */
-    serialize: async (method: string, value: CompleteAddress): Promise<JSONRPCSerializedData> => {
-      return Promise.resolve({
-        method,
-        serialized: JSON.stringify(value.toString()),
-      });
-    },
-    /**
-     * Deserializes the account registration result.
-     * @param _method - The RPC method name
-     * @param data - The serialized complete address
-     * @returns Deserialized complete address
-     */
-    deserialize: async (_method: string, data: JSONRPCSerializedData): Promise<CompleteAddress> => {
-      return Promise.resolve(CompleteAddress.fromString(JSON.parse(data.serialized)));
-    },
-  };
-}
-
-/**
- * Serializer for the aztec_addAuthWitness RPC method.
- * Handles serialization of authentication witness data between JSON-RPC format and native Aztec types.
- */
-export class AztecAddAuthWitnessSerializer
-  implements
-    JSONRPCSerializer<
-      AztecWalletMethodMap['aztec_addAuthWitness']['params'],
-      AztecWalletMethodMap['aztec_addAuthWitness']['result']
-    >
-{
-  params = {
-    /**
-     * Serializes auth witness addition parameters for RPC transport.
-     * @param method - The RPC method name
-     * @param value - The parameters containing the auth witness to add
-     * @returns Serialized auth witness data
-     */
-    serialize: async (
-      method: string,
-      value: AztecWalletMethodMap['aztec_addAuthWitness']['params'],
-    ): Promise<JSONRPCSerializedData> => {
-      const { authWitness } = value;
-      return Promise.resolve({
-        method,
-        serialized: JSON.stringify(authWitness.toString()),
-      });
-    },
-    /**
-     * Deserializes auth witness addition parameters from RPC transport.
-     * @param _method - The RPC method name
-     * @param data - The serialized auth witness data
-     * @returns Deserialized auth witness parameters
-     */
-    deserialize: async (
-      _method: string,
-      data: JSONRPCSerializedData,
-    ): Promise<AztecWalletMethodMap['aztec_addAuthWitness']['params']> => {
-      const authWitness = AuthWitness.fromString(JSON.parse(data.serialized));
-      return Promise.resolve({ authWitness });
-    },
-  };
-
-  result = {
-    /**
-     * Serializes the auth witness addition result.
-     * @param method - The RPC method name
-     * @param value - Boolean indicating success of the witness addition
-     * @returns Serialized result
-     */
-    serialize: async (method: string, value: boolean): Promise<JSONRPCSerializedData> => {
-      return Promise.resolve({
-        method,
-        serialized: JSON.stringify(value),
-      });
-    },
-    /**
-     * Deserializes the auth witness addition result.
-     * @param _method - The RPC method name
-     * @param data - The serialized result data
-     * @returns Boolean indicating success
-     */
-    deserialize: async (_method: string, data: JSONRPCSerializedData): Promise<boolean> => {
-      return Promise.resolve(JSON.parse(data.serialized));
-    },
-  };
-}
-
-/**
- * Serializer for the aztec_getAuthWitness RPC method.
- * Handles serialization of authentication witness retrieval between JSON-RPC format and native Aztec types.
- */
-export class AztecGetAuthWitnessSerializer
-  implements
-    JSONRPCSerializer<
-      AztecWalletMethodMap['aztec_getAuthWitness']['params'],
-      AztecWalletMethodMap['aztec_getAuthWitness']['result']
-    >
-{
-  params = {
-    /**
-     * Serializes auth witness retrieval parameters for RPC transport.
-     * @param method - The RPC method name
-     * @param value - The parameters containing the message hash to look up
-     * @returns Serialized message hash data
-     */
-    serialize: async (
-      method: string,
-      value: AztecWalletMethodMap['aztec_getAuthWitness']['params'],
-    ): Promise<JSONRPCSerializedData> => {
-      const { messageHash } = value;
-      return Promise.resolve({
-        method,
-        serialized: JSON.stringify(messageHash.toString()),
-      });
-    },
-    /**
-     * Deserializes auth witness retrieval parameters from RPC transport.
-     * @param _method - The RPC method name
-     * @param data - The serialized message hash data
-     * @returns Deserialized message hash parameters
-     */
-    deserialize: async (
-      _method: string,
-      data: JSONRPCSerializedData,
-    ): Promise<AztecWalletMethodMap['aztec_getAuthWitness']['params']> => {
-      const messageHash = Fr.fromString(JSON.parse(data.serialized));
-      return Promise.resolve({ messageHash });
-    },
-  };
-
-  result = {
-    /**
-     * Serializes the auth witness retrieval result.
-     * @param method - The RPC method name
-     * @param value - Array of field elements representing auth witnesses
-     * @returns Serialized witness array
-     */
-    serialize: async (
-      method: string,
-      value: AztecWalletMethodMap['aztec_getAuthWitness']['result'],
-    ): Promise<JSONRPCSerializedData> => {
-      return Promise.resolve({
-        method,
-        serialized: JSON.stringify(value.map((w) => w.toString())),
-      });
-    },
-    /**
-     * Deserializes the auth witness retrieval result.
-     * @param _method - The RPC method name
-     * @param data - The serialized witness array data
-     * @returns Array of deserialized field elements
-     */
-    deserialize: async (
-      _method: string,
-      data: JSONRPCSerializedData,
-    ): Promise<AztecWalletMethodMap['aztec_getAuthWitness']['result']> => {
-      return Promise.resolve(JSON.parse(data.serialized).map((w: string) => Fr.fromString(w)));
-    },
-  };
-}
-
-/**
- * Pre-instantiated serializer instances for Aztec account-related RPC methods.
- * These instances can be used directly by the RPC handler implementation.
- */
-export const aztecSetScopesSerializer = new AztecSetScopesSerializer();
-export const aztecRegisterAccountSerializer = new AztecRegisterAccountSerializer();
-export const aztecAddAuthWitnessSerializer = new AztecAddAuthWitnessSerializer();
-export const aztecGetAuthWitnessSerializer = new AztecGetAuthWitnessSerializer();

package/src/serializers/contract.test.ts

@@ -1,24 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { aztecRegisterContractSerializer } from './contract.js';
-import { randomDeployedContract } from '@aztec/circuit-types';
-describe('Contract Serializers', () => {
-  describe('aztec_registerContract', () => {
-    it('should serialize and deserialize params', async () => {
-      const { instance, artifact } = await randomDeployedContract();
-      const serialized = await aztecRegisterContractSerializer.params.serialize('aztec_registerContract', {
-        instance,
-        artifact,
-      });
-      expect(serialized.method).toBe('aztec_registerContract');
-
-      const deserialized = await aztecRegisterContractSerializer.params.deserialize(
-        'aztec_registerContract',
-        serialized,
-      );
-      expect(deserialized.instance.address.toString()).toBe(instance.address.toString());
-      expect(deserialized.instance.contractClassId.toString()).toBe(instance.contractClassId.toString());
-      expect(deserialized.instance.deployer.toString()).toBe(instance.deployer.toString());
-      expect(deserialized.artifact).toEqual(artifact);
-    });
-  });
-});