@walletmesh/aztec-rpc-wallet 0.3.1 → 0.4.0

package/docs/classes/AztecWalletError.md

@@ -1,4 +1,4 @@
-[**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
 
 ***
 
@@ -6,9 +6,23 @@
 
 # Class: AztecWalletError
 
-Defined in: [aztec/rpc-wallet/src/errors.ts:61](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/errors.ts#L61)
+Defined in: [aztec/rpc-wallet/src/errors.ts:96](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/errors.ts#L96)
 
-Custom error class for Aztec Wallet RPC errors.
+Custom error class for representing errors specific to the Aztec RPC Wallet.
+It extends the base JSONRPCError from `@walletmesh/jsonrpc` and uses
+predefined error types and messages from [AztecWalletErrorMap](../variables/AztecWalletErrorMap.md).
+
+This class allows for consistent error handling and reporting within the
+Aztec wallet system, providing both a standard JSON-RPC error code and
+a more specific Aztec error type.
+
+## Example
+
+```typescript
+if (!isConnected) {
+  throw new AztecWalletError('walletNotConnected', 'Attempted to call method while disconnected.');
+}
+```
 
 ## Extends
 
@@ -16,31 +30,34 @@ Custom error class for Aztec Wallet RPC errors.
 
 ## Constructors
 
-### new AztecWalletError()
+### Constructor
 
-> **new AztecWalletError**(`err`, `data`?): [`AztecWalletError`](AztecWalletError.md)
+> **new AztecWalletError**(`errorType`, `data?`): `AztecWalletError`
 
-Defined in: [aztec/rpc-wallet/src/errors.ts:67](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/errors.ts#L67)
+Defined in: [aztec/rpc-wallet/src/errors.ts:111](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/errors.ts#L111)
 
-Creates a new AztecWalletError.
+Creates a new `AztecWalletError` instance.
 
 #### Parameters
 
-##### err
+##### errorType
 
 `AztecWalletErrorType`
 
-The error type from AztecWalletErrorMap
+The specific AztecWalletErrorType identifying the error.
+                   This key is used to look up the code and message from [AztecWalletErrorMap](../variables/AztecWalletErrorMap.md).
 
 ##### data?
 
-`string`
+Optional additional data associated with the error. This can be a string
+              or a record, providing more context. It will be included in the `data`
+              field of the JSON-RPC error object.
 
-Optional additional error data
+`string` | `Record`\<`string`, `unknown`\>
 
 #### Returns
 
-[`AztecWalletError`](AztecWalletError.md)
+`AztecWalletError`
 
 #### Overrides
 
@@ -48,6 +65,16 @@ Optional additional error data
 
 ## Properties
 
+### aztecErrorType
+
+> `readonly` **aztecErrorType**: `AztecWalletErrorType`
+
+Defined in: [aztec/rpc-wallet/src/errors.ts:100](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/errors.ts#L100)
+
+The specific Aztec wallet error type.
+
+***
+
 ### cause?
 
 > `optional` **cause**: `unknown`
@@ -124,43 +151,21 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
 
 ***
 
-### prepareStackTrace()?
-
-> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
-
-Defined in: node\_modules/@types/node/globals.d.ts:143
-
-Optional override for formatting stack traces
-
-#### Parameters
-
-##### err
-
-`Error`
-
-##### stackTraces
-
-`CallSite`[]
-
-#### Returns
-
-`any`
-
-#### See
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-#### Inherited from
+### stackTraceLimit
 
-`JSONRPCError.prepareStackTrace`
+> `static` **stackTraceLimit**: `number`
 
-***
+Defined in: node\_modules/@types/node/globals.d.ts:161
 
-### stackTraceLimit
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
 
-> `static` **stackTraceLimit**: `number`
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
 
-Defined in: node\_modules/@types/node/globals.d.ts:145
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
 
 #### Inherited from
 
@@ -188,11 +193,53 @@ Returns a string representation of an object.
 
 ### captureStackTrace()
 
-> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/@types/node/globals.d.ts:145
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
 
-Defined in: node\_modules/@types/node/globals.d.ts:136
+function b() {
+  c();
+}
 
-Create .stack property on a target object
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
 
 #### Parameters
 
@@ -211,3 +258,33 @@ Create .stack property on a target object
 #### Inherited from
 
 `JSONRPCError.captureStackTrace`
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: node\_modules/@types/node/globals.d.ts:149
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+`JSONRPCError.prepareStackTrace`

package/docs/classes/ContractArtifactCache.md

@@ -1,4 +1,4 @@
-[**@walletmesh/aztec-rpc-wallet v0.3.1**](../README.md)
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
 
 ***
 
@@ -6,31 +6,41 @@
 
 # Class: ContractArtifactCache
 
-Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:27](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/contractArtifactCache.ts#L27)
+Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:28](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/contractArtifactCache.ts#L28)
 
-Caches contract artifacts to optimize contract interactions.
+Manages an in-memory cache for Aztec ContractArtifacts.
 
-This class maintains an in-memory cache of contract artifacts indexed by contract address.
-When a contract artifact is requested:
-1. First checks the cache for an existing artifact
-2. If not found, fetches the contract instance and its artifact from the wallet
-3. Stores the artifact in the cache for future use
-4. Returns the artifact to the caller
+This class is designed to optimize performance by reducing redundant fetches
+of contract artifacts. When an artifact is requested for a given contract address,
+the cache first checks its local store. If the artifact is not found (a cache miss),
+it uses the provided Wallet instance to retrieve the contract's metadata,
+then its class metadata (which includes the artifact), stores it in the cache,
+and finally returns it. Subsequent requests for the same artifact will be served
+directly from the cache.
 
-This caching mechanism helps reduce:
-- Network requests to fetch contract data
-- Processing overhead of parsing contract artifacts
-- Memory usage by reusing existing artifacts
+This caching strategy helps to:
+- Minimize network requests to the PXE or node for contract data.
+- Reduce processing overhead associated with fetching and parsing artifacts.
+- Conserve memory by reusing already loaded artifact instances.
+
+The cache is typically used within the `AztecHandlerContext` on the wallet-side
+to provide efficient artifact access to RPC method handlers.
+
+## See
+
+ - [AztecHandlerContext](../interfaces/AztecHandlerContext.md)
+ - Wallet
+ - ContractArtifact
 
 ## Constructors
 
-### new ContractArtifactCache()
+### Constructor
 
-> **new ContractArtifactCache**(`wallet`): [`ContractArtifactCache`](ContractArtifactCache.md)
+> **new ContractArtifactCache**(`wallet`): `ContractArtifactCache`
 
-Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:37](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/contractArtifactCache.ts#L37)
+Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:50](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/contractArtifactCache.ts#L50)
 
-Creates a new ContractArtifactCache instance.
+Creates a new `ContractArtifactCache` instance.
 
 #### Parameters
 
@@ -38,11 +48,14 @@ Creates a new ContractArtifactCache instance.
 
 `Wallet`
 
-Wallet instance used to fetch contract data when cache misses occur
+The `aztec.js` Wallet instance that will be used to
+                fetch contract metadata and artifacts if they are not found
+                in the cache. This wallet should be capable of calling
+                `getContractMetadata` and `getContractClassMetadata`.
 
 #### Returns
 
-[`ContractArtifactCache`](ContractArtifactCache.md)
+`ContractArtifactCache`
 
 ## Methods
 
@@ -50,17 +63,19 @@ Wallet instance used to fetch contract data when cache misses occur
 
 > **getContractArtifact**(`contractAddress`): `Promise`\<`ContractArtifact`\>
 
-Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:56](https://github.com/WalletMesh/walletmesh-packages/blob/65bc501d5bed45d0e6d444f53e29595da551d59e/aztec/rpc-wallet/src/contractArtifactCache.ts#L56)
+Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:73](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/contractArtifactCache.ts#L73)
 
-Retrieves the contract artifact for a given contract address.
-First checks the cache, then falls back to fetching from the wallet if needed.
+Retrieves the ContractArtifact for a given AztecAddress.
 
-The process:
-1. Check if artifact exists in cache
-2. If not, get contract instance from wallet
-3. Use instance to get contract class ID
-4. Fetch artifact using class ID
-5. Cache the artifact for future use
+This method implements a cache-aside pattern:
+1. It first checks if the artifact for the `contractAddress` is already in the cache.
+2. If found (cache hit), the cached artifact is returned immediately.
+3. If not found (cache miss):
+   a. It fetches the ContractMetadata for the `contractAddress` using the wallet.
+   b. It then fetches the ContractClassMetadata using the class ID from the contract metadata.
+      This class metadata is expected to contain the artifact.
+   c. The retrieved artifact is stored in the cache, associated with the `contractAddress`.
+   d. The artifact is then returned.
 
 #### Parameters
 
@@ -68,14 +83,16 @@ The process:
 
 `AztecAddress`
 
-The contract address to retrieve the artifact for
+The AztecAddress of the contract whose artifact is to be retrieved.
 
 #### Returns
 
 `Promise`\<`ContractArtifact`\>
 
-Promise resolving to the contract artifact
+A promise that resolves to the ContractArtifact.
 
 #### Throws
 
-If contract instance or class not registered
+if the contract instance or its class (and thus artifact)
+                           is not registered with the wallet or cannot be found.
+                           Also re-throws other errors encountered during wallet calls.

package/docs/functions/connectAztec.md

@@ -0,0 +1,62 @@
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / connectAztec
+
+# Function: connectAztec()
+
+> **connectAztec**(`provider`, `chainId`, `methods`): `Promise`\<\{ `sessionId`: `string`; `wallet`: [`AztecDappWallet`](../classes/AztecDappWallet.md); \}\>
+
+Defined in: [aztec/rpc-wallet/src/client/helpers.ts:75](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/client/helpers.ts#L75)
+
+Establishes a connection to an Aztec wallet service and creates an initialized [AztecDappWallet](../classes/AztecDappWallet.md) instance.
+This function requests permissions for the specified methods on the given Aztec chain,
+then instantiates and initializes the wallet.
+Initialization includes fetching and caching essential data like the wallet address and chain ID.
+
+By default, it requests permissions for all methods defined in [ALL\_AZTEC\_METHODS](../variables/ALL_AZTEC_METHODS.md)
+on the 'aztec:mainnet' chain.
+
+## Parameters
+
+### provider
+
+[`AztecRouterProvider`](../classes/AztecRouterProvider.md)
+
+The [AztecRouterProvider](../classes/AztecRouterProvider.md) instance to use for the connection.
+                  This provider must be configured with appropriate transport and Aztec serializers.
+
+### chainId
+
+`` `aztec:${string}` `` = `'aztec:mainnet'`
+
+The [AztecChainId](../type-aliases/AztecChainId.md) to connect to (e.g., 'aztec:mainnet', 'aztec:31337').
+                 Defaults to 'aztec:mainnet'.
+
+### methods
+
+readonly keyof [`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)[] = `ALL_AZTEC_METHODS`
+
+An array of method names for which permissions are requested.
+                 Defaults to [ALL\_AZTEC\_METHODS](../variables/ALL_AZTEC_METHODS.md).
+
+## Returns
+
+`Promise`\<\{ `sessionId`: `string`; `wallet`: [`AztecDappWallet`](../classes/AztecDappWallet.md); \}\>
+
+A promise that resolves to an object containing the `sessionId` for the connection
+         and a fully initialized [AztecDappWallet](../classes/AztecDappWallet.md) instance.
+
+## Throws
+
+If the connection or wallet initialization fails.
+
+## Example
+
+```typescript
+const provider = new AztecRouterProvider(myTransport);
+const { sessionId, wallet } = await connectAztec(provider, 'aztec:testnet');
+const address = wallet.getAddress(); // Wallet is ready to use
+console.log('Connected with session ID:', sessionId, 'Wallet address:', address.toString());
+```

package/docs/functions/createAztecWallet.md

@@ -0,0 +1,46 @@
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / createAztecWallet
+
+# Function: createAztecWallet()
+
+> **createAztecWallet**(`provider`, `chainId`): `Promise`\<[`AztecDappWallet`](../classes/AztecDappWallet.md)\>
+
+Defined in: [aztec/rpc-wallet/src/client/aztec-dapp-wallet.ts:872](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/client/aztec-dapp-wallet.ts#L872)
+
+Helper function to create and initialize an AztecDappWallet instance.
+This is the recommended way to instantiate an Aztec wallet for dApp use,
+as it ensures all necessary asynchronous setup (like fetching initial
+address and chain ID) is completed.
+
+## Parameters
+
+### provider
+
+[`AztecRouterProvider`](../classes/AztecRouterProvider.md)
+
+An [AztecRouterProvider](../classes/AztecRouterProvider.md) instance, which handles Aztec-specific type serialization.
+
+### chainId
+
+`` `aztec:${string}` `` = `'aztec:mainnet'`
+
+The Aztec chain ID (e.g., 'aztec:mainnet', 'aztec:31337') for the wallet. Defaults to 'aztec:mainnet'.
+
+## Returns
+
+`Promise`\<[`AztecDappWallet`](../classes/AztecDappWallet.md)\>
+
+A promise that resolves to a fully initialized [AztecDappWallet](../classes/AztecDappWallet.md) instance.
+
+## Example
+
+```typescript
+const dAppTransport = { send: ..., onMessage: ... }; // User-defined transport
+const provider = new AztecRouterProvider(dAppTransport);
+await provider.connect({ 'aztec:mainnet': ['aztec_getAddress'] }); // Connect first
+const wallet = await createAztecWallet(provider, 'aztec:mainnet');
+const address = wallet.getAddress(); // Now usable
+```

package/docs/functions/createAztecWalletNode.md

@@ -0,0 +1,96 @@
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / createAztecWalletNode
+
+# Function: createAztecWalletNode()
+
+> **createAztecWalletNode**(`wallet`, `pxe`, `transport`): `JSONRPCNode`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md), [`JSONRPCEventMap`](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/jsonrpc/docs/interfaces/JSONRPCEventMap.md), [`AztecHandlerContext`](../interfaces/AztecHandlerContext.md)\>
+
+Defined in: [aztec/rpc-wallet/src/wallet/create-node.ts:77](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/wallet/create-node.ts#L77)
+
+Creates and configures a JSONRPCNode to serve as an Aztec wallet endpoint.
+This node is intended to be used on the wallet-side (e.g., in a browser extension
+or a backend service managing user accounts) and can be connected to a
+WalletRouter instance.
+
+The created node is equipped with:
+- Handlers for all Aztec RPC methods defined in [AztecWalletMethodMap](../interfaces/AztecWalletMethodMap.md).
+- Serializers for Aztec-specific data types, ensuring correct data exchange
+  over JSON-RPC.
+- A context ([AztecHandlerContext](../interfaces/AztecHandlerContext.md)) providing handlers with access to the
+  necessary AccountWallet, PXE client, and a [ContractArtifactCache](../classes/ContractArtifactCache.md).
+
+## Parameters
+
+### wallet
+
+`AccountWallet`
+
+An instance of AccountWallet from `aztec.js`, representing
+                the user's Aztec account and signing capabilities.
+
+### pxe
+
+`PXE`
+
+An instance of PXE (Private Execution Environment) client from
+             `aztec.js`, used for interacting with the Aztec network (e.g., simulating
+             transactions, getting node info).
+
+### transport
+
+[`JSONRPCTransport`](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/jsonrpc/docs/interfaces/JSONRPCTransport.md)
+
+A [JSONRPCTransport](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/jsonrpc/docs/interfaces/JSONRPCTransport.md) instance that the node will use for
+                   sending and receiving JSON-RPC messages. This transport typically
+                   connects to a corresponding transport on the client/dApp side,
+                   often via the WalletRouter.
+
+## Returns
+
+`JSONRPCNode`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md), [`JSONRPCEventMap`](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/jsonrpc/docs/interfaces/JSONRPCEventMap.md), [`AztecHandlerContext`](../interfaces/AztecHandlerContext.md)\>
+
+A fully configured JSONRPCNode instance, typed with
+         [AztecWalletMethodMap](../interfaces/AztecWalletMethodMap.md) and [AztecHandlerContext](../interfaces/AztecHandlerContext.md), ready to
+         process Aztec wallet requests.
+
+## Example
+
+```typescript
+import { createAztecWalletNode } from '@walletmesh/aztec-rpc-wallet';
+import { WalletRouter, createLocalTransportPair } from '@walletmesh/router';
+import { MyAccountWallet, MyPXE, MyRouterTransport, MyPermissionManager } from './my-setup'; // User's setup
+
+// 1. Initialize Aztec AccountWallet and PXE
+const accountWallet = new MyAccountWallet();
+const pxe = new MyPXE();
+
+// 2. Create a local transport pair for communication between router and wallet node
+const [routerSideTransport, walletNodeSideTransport] = createLocalTransportPair();
+
+// 3. Create the Aztec Wallet Node
+const aztecNode = createAztecWalletNode(accountWallet, pxe, walletNodeSideTransport);
+// aztecNode will start listening for requests on walletNodeSideTransport
+
+// 4. Create and configure the WalletRouter
+const routerTransport = new MyRouterTransport(); // Transport for dApp to router communication
+const permissionManager = new MyPermissionManager();
+const router = new WalletRouter(
+  routerTransport,
+  new Map([['aztec:testnet', routerSideTransport]]), // Route 'aztec:testnet' to our node
+  permissionManager
+);
+
+// The system is now set up. DApps can connect to 'routerTransport'
+// and send requests to 'aztec:testnet', which will be handled by 'aztecNode'.
+```
+
+## See
+
+ - JSONRPCNode
+ - [AztecWalletMethodMap](../interfaces/AztecWalletMethodMap.md)
+ - [AztecHandlerContext](../interfaces/AztecHandlerContext.md)
+ - createAztecHandlers
+ - [registerAztecSerializers](registerWalletAztecSerializers.md) (wallet-side version)

package/docs/functions/registerAztecSerializers.md

@@ -0,0 +1,61 @@
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / registerAztecSerializers
+
+# Function: registerAztecSerializers()
+
+> **registerAztecSerializers**(`provider`): `void`
+
+Defined in: [aztec/rpc-wallet/src/client/register-serializers.ts:43](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/client/register-serializers.ts#L43)
+
+Registers the [AztecWalletSerializer](../variables/AztecWalletSerializer.md) for all relevant Aztec JSON-RPC methods
+on a given [WalletRouterProvider](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/router/docs/index/classes/WalletRouterProvider.md) instance.
+
+This utility function ensures that any `WalletRouterProvider` (not just the specialized
+[AztecRouterProvider](../classes/AztecRouterProvider.md)) can be configured to correctly handle serialization and
+deserialization of Aztec-specific data types (e.g., `AztecAddress`, `Fr`, `TxExecutionRequest`)
+when interacting with an Aztec wallet.
+
+It iterates through a predefined list of Aztec methods and associates them with
+the comprehensive [AztecWalletSerializer](../variables/AztecWalletSerializer.md).
+
+## Parameters
+
+### provider
+
+[`WalletRouterProvider`](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/router/docs/index/classes/WalletRouterProvider.md)
+
+The [WalletRouterProvider](https://github.com/WalletMesh/walletmesh-packages/tree/main/core/router/docs/index/classes/WalletRouterProvider.md) instance on which to register the serializers.
+                  After this function call, the provider will be equipped to handle Aztec methods.
+
+## Returns
+
+`void`
+
+## Example
+
+```typescript
+import { WalletRouterProvider } from '@walletmesh/router';
+import { registerAztecSerializers, ALL_AZTEC_METHODS } from '@walletmesh/aztec-rpc-wallet';
+import { MyCustomTransport } from './my-custom-transport';
+
+// 1. Create a generic WalletRouterProvider
+const transport = new MyCustomTransport();
+const provider = new WalletRouterProvider(transport);
+
+// 2. Register Aztec serializers on it
+registerAztecSerializers(provider);
+
+// 3. Now the provider can correctly handle Aztec methods and types
+await provider.connect({ 'aztec:testnet': ALL_AZTEC_METHODS });
+const address = await provider.call('aztec:testnet', { method: 'aztec_getAddress' });
+// 'address' will be correctly deserialized into an AztecAddress instance (or equivalent based on serializer)
+```
+
+## See
+
+ - [AztecWalletSerializer](../variables/AztecWalletSerializer.md) for the actual serialization logic.
+ - [AztecRouterProvider](../classes/AztecRouterProvider.md) for a provider that calls this automatically.
+ - [AztecWalletMethodMap](../interfaces/AztecWalletMethodMap.md) for the list of methods and their types.

package/docs/functions/registerWalletAztecSerializers.md

@@ -0,0 +1,39 @@
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / registerWalletAztecSerializers
+
+# Function: registerWalletAztecSerializers()
+
+> **registerWalletAztecSerializers**(`node`): `void`
+
+Defined in: [aztec/rpc-wallet/src/wallet/serializers.ts:548](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/wallet/serializers.ts#L548)
+
+Registers the [AztecWalletSerializer](../variables/AztecWalletSerializer.md) for all relevant Aztec JSON-RPC methods
+on a given JSONRPCNode instance.
+
+This function is typically called on the wallet-side (e.g., within
+`createAztecWalletNode`) to equip the node with the necessary serialization
+capabilities for handling Aztec methods.
+
+It iterates through a predefined list of Aztec methods and associates each
+with the `AztecWalletSerializer`.
+
+## Parameters
+
+### node
+
+`JSONRPCNode`\<[`AztecWalletMethodMap`](../interfaces/AztecWalletMethodMap.md)\>
+
+The JSONRPCNode instance on which to register the serializers.
+              This node should be typed with [AztecWalletMethodMap](../interfaces/AztecWalletMethodMap.md).
+
+## Returns
+
+`void`
+
+## See
+
+ - [createAztecWalletNode](createAztecWalletNode.md) where this function is used.
+ - [AztecWalletSerializer](../variables/AztecWalletSerializer.md) which provides the serialization logic.