@walletmesh/aztec-rpc-wallet 0.3.1 → 0.4.0

package/docs/globals.md

@@ -1,34 +1,36 @@
-[**@walletmesh/aztec-rpc-wallet v0.3.1**](README.md)
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](README.md)
 
 ***
 
-# @walletmesh/aztec-rpc-wallet v0.3.1
+# @walletmesh/aztec-rpc-wallet v0.4.0
 
 ## Classes
 
-- [AztecChainProvider](classes/AztecChainProvider.md)
-- [AztecChainWallet](classes/AztecChainWallet.md)
-- [AztecProvider](classes/AztecProvider.md)
+- [AztecDappWallet](classes/AztecDappWallet.md)
+- [AztecRouterProvider](classes/AztecRouterProvider.md)
 - [AztecWalletError](classes/AztecWalletError.md)
 - [ContractArtifactCache](classes/ContractArtifactCache.md)
 
 ## Interfaces
 
-- [AztecWalletBaseMethodMap](interfaces/AztecWalletBaseMethodMap.md)
-- [AztecWalletEventMap](interfaces/AztecWalletEventMap.md)
+- [AztecHandlerContext](interfaces/AztecHandlerContext.md)
+- [AztecWalletContext](interfaces/AztecWalletContext.md)
 - [AztecWalletMethodMap](interfaces/AztecWalletMethodMap.md)
 
 ## Type Aliases
 
 - [AztecChainId](type-aliases/AztecChainId.md)
-- [AztecChainWalletMiddleware](type-aliases/AztecChainWalletMiddleware.md)
-- [AztecWalletContext](type-aliases/AztecWalletContext.md)
-- [AztecWalletMethodHandler](type-aliases/AztecWalletMethodHandler.md)
-- [AztecWalletMiddleware](type-aliases/AztecWalletMiddleware.md)
-- [AztecWalletRouterClient](type-aliases/AztecWalletRouterClient.md)
-- [TransactionFunctionCall](type-aliases/TransactionFunctionCall.md)
-- [TransactionParams](type-aliases/TransactionParams.md)
 
 ## Variables
 
+- [ALL\_AZTEC\_METHODS](variables/ALL_AZTEC_METHODS.md)
 - [AztecWalletErrorMap](variables/AztecWalletErrorMap.md)
+- [AztecWalletSerializer](variables/AztecWalletSerializer.md)
+
+## Functions
+
+- [connectAztec](functions/connectAztec.md)
+- [createAztecWallet](functions/createAztecWallet.md)
+- [createAztecWalletNode](functions/createAztecWalletNode.md)
+- [registerAztecSerializers](functions/registerAztecSerializers.md)
+- [registerWalletAztecSerializers](functions/registerWalletAztecSerializers.md)

package/docs/interfaces/AztecHandlerContext.md

@@ -0,0 +1,54 @@
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / AztecHandlerContext
+
+# Interface: AztecHandlerContext
+
+Defined in: [aztec/rpc-wallet/src/wallet/handlers/index.ts:26](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/wallet/handlers/index.ts#L26)
+
+Defines the context object that is passed to all Aztec wallet JSON-RPC method handlers.
+This context provides handlers with the necessary dependencies to perform their operations.
+It extends the base JSONRPCContext with Aztec-specific instances.
+
+## Extends
+
+- `JSONRPCContext`
+
+## Indexable
+
+\[`key`: `string`\]: `unknown`
+
+## Properties
+
+### cache
+
+> **cache**: [`ContractArtifactCache`](../classes/ContractArtifactCache.md)
+
+Defined in: [aztec/rpc-wallet/src/wallet/handlers/index.ts:29](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/wallet/handlers/index.ts#L29)
+
+An instance of [ContractArtifactCache](../classes/ContractArtifactCache.md) used for caching
+                  contract artifacts to optimize performance.
+
+***
+
+### pxe
+
+> **pxe**: `PXE`
+
+Defined in: [aztec/rpc-wallet/src/wallet/handlers/index.ts:28](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/wallet/handlers/index.ts#L28)
+
+An instance of PXE (Private Execution Environment) client
+                from `aztec.js`, used for interacting with the Aztec network.
+
+***
+
+### wallet
+
+> **wallet**: `AccountWallet`
+
+Defined in: [aztec/rpc-wallet/src/wallet/handlers/index.ts:27](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/wallet/handlers/index.ts#L27)
+
+An instance of AccountWallet from `aztec.js`,
+                   representing the user's account and signing capabilities.

package/docs/interfaces/AztecWalletContext.md

@@ -0,0 +1,50 @@
+[**@walletmesh/aztec-rpc-wallet v0.4.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletContext
+
+# Interface: AztecWalletContext
+
+Defined in: [aztec/rpc-wallet/src/types.ts:72](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L72)
+
+Defines the context object provided to all Aztec wallet-side JSON-RPC method handlers.
+This context aggregates essential dependencies required by handlers to perform their operations.
+
+## See
+
+[createAztecWalletNode](../functions/createAztecWalletNode.md) where this context is constructed and provided to handlers.
+
+## Properties
+
+### cache
+
+> **cache**: [`ContractArtifactCache`](../classes/ContractArtifactCache.md)
+
+Defined in: [aztec/rpc-wallet/src/types.ts:88](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L88)
+
+An instance of [ContractArtifactCache](../classes/ContractArtifactCache.md) used for caching contract artifacts.
+This helps optimize performance by avoiding redundant fetches of artifact data.
+
+***
+
+### pxe
+
+> **pxe**: `PXE`
+
+Defined in: [aztec/rpc-wallet/src/types.ts:83](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L83)
+
+The `aztec.js` PXE (Private Execution Environment) client instance.
+This is used for interacting with the Aztec network, such as simulating transactions,
+getting node information, fetching blocks, and managing private state.
+
+***
+
+### wallet
+
+> **wallet**: `AccountWallet`
+
+Defined in: [aztec/rpc-wallet/src/types.ts:77](https://github.com/WalletMesh/walletmesh-packages/blob/cb714b71a23dbdbacd8723a799d14c589fdf51f9/aztec/rpc-wallet/src/types.ts#L77)
+
+The `aztec.js` AccountWallet instance. This wallet holds the user's account keys
+and provides methods for signing, creating transactions, and interacting with the PXE.