@walletmesh/aztec-rpc-wallet 0.2.0 → 0.3.0

package/docs/classes/AztecWalletError.md

@@ -0,0 +1,213 @@
+[**@walletmesh/aztec-rpc-wallet v0.3.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletError
+
+# Class: AztecWalletError
+
+Defined in: [aztec/rpc-wallet/src/errors.ts:61](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/errors.ts#L61)
+
+Custom error class for Aztec Wallet RPC errors.
+
+## Extends
+
+- `JSONRPCError`
+
+## Constructors
+
+### new AztecWalletError()
+
+> **new AztecWalletError**(`err`, `data`?): [`AztecWalletError`](AztecWalletError.md)
+
+Defined in: [aztec/rpc-wallet/src/errors.ts:67](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/errors.ts#L67)
+
+Creates a new AztecWalletError.
+
+#### Parameters
+
+##### err
+
+`AztecWalletErrorType`
+
+The error type from AztecWalletErrorMap
+
+##### data?
+
+`string`
+
+Optional additional error data
+
+#### Returns
+
+[`AztecWalletError`](AztecWalletError.md)
+
+#### Overrides
+
+`JSONRPCError.constructor`
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+#### Inherited from
+
+`JSONRPCError.cause`
+
+***
+
+### code
+
+> **code**: `number`
+
+Defined in: core/jsonrpc/dist/error.d.ts:62
+
+The error code.
+
+#### Inherited from
+
+`JSONRPCError.code`
+
+***
+
+### data?
+
+> `optional` **data**: `string` \| `Record`\<`string`, `unknown`\>
+
+Defined in: core/jsonrpc/dist/error.d.ts:63
+
+Additional error data.
+
+#### Inherited from
+
+`JSONRPCError.data`
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+`JSONRPCError.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: core/jsonrpc/dist/error.d.ts:64
+
+#### Inherited from
+
+`JSONRPCError.name`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+`JSONRPCError.stack`
+
+***
+
+### 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
+
+`JSONRPCError.prepareStackTrace`
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node\_modules/@types/node/globals.d.ts:145
+
+#### Inherited from
+
+`JSONRPCError.stackTraceLimit`
+
+## Methods
+
+### toString()
+
+> **toString**(): `string`
+
+Defined in: core/jsonrpc/dist/error.d.ts:89
+
+Returns a string representation of an object.
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+`JSONRPCError.toString`
+
+***
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
+
+Defined in: node\_modules/@types/node/globals.d.ts:136
+
+Create .stack property on a target object
+
+#### Parameters
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`JSONRPCError.captureStackTrace`

package/docs/classes/ContractArtifactCache.md

@@ -0,0 +1,81 @@
+[**@walletmesh/aztec-rpc-wallet v0.3.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / ContractArtifactCache
+
+# Class: ContractArtifactCache
+
+Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:27](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/contractArtifactCache.ts#L27)
+
+Caches contract artifacts to optimize contract interactions.
+
+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 caching mechanism helps reduce:
+- Network requests to fetch contract data
+- Processing overhead of parsing contract artifacts
+- Memory usage by reusing existing artifacts
+
+## Constructors
+
+### new ContractArtifactCache()
+
+> **new ContractArtifactCache**(`wallet`): [`ContractArtifactCache`](ContractArtifactCache.md)
+
+Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:37](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/contractArtifactCache.ts#L37)
+
+Creates a new ContractArtifactCache instance.
+
+#### Parameters
+
+##### wallet
+
+`Wallet`
+
+Wallet instance used to fetch contract data when cache misses occur
+
+#### Returns
+
+[`ContractArtifactCache`](ContractArtifactCache.md)
+
+## Methods
+
+### getContractArtifact()
+
+> **getContractArtifact**(`contractAddress`): `Promise`\<`ContractArtifact`\>
+
+Defined in: [aztec/rpc-wallet/src/contractArtifactCache.ts:56](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/contractArtifactCache.ts#L56)
+
+Retrieves the contract artifact for a given contract address.
+First checks the cache, then falls back to fetching from the wallet if needed.
+
+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
+
+#### Parameters
+
+##### contractAddress
+
+`AztecAddress`
+
+The contract address to retrieve the artifact for
+
+#### Returns
+
+`Promise`\<`ContractArtifact`\>
+
+Promise resolving to the contract artifact
+
+#### Throws
+
+If contract instance or class not registered

package/docs/globals.md

@@ -0,0 +1,34 @@
+[**@walletmesh/aztec-rpc-wallet v0.3.0**](README.md)
+
+***
+
+# @walletmesh/aztec-rpc-wallet v0.3.0
+
+## Classes
+
+- [AztecChainProvider](classes/AztecChainProvider.md)
+- [AztecChainWallet](classes/AztecChainWallet.md)
+- [AztecProvider](classes/AztecProvider.md)
+- [AztecWalletError](classes/AztecWalletError.md)
+- [ContractArtifactCache](classes/ContractArtifactCache.md)
+
+## Interfaces
+
+- [AztecWalletBaseMethodMap](interfaces/AztecWalletBaseMethodMap.md)
+- [AztecWalletEventMap](interfaces/AztecWalletEventMap.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
+
+- [AztecWalletErrorMap](variables/AztecWalletErrorMap.md)

package/docs/interfaces/AztecWalletBaseMethodMap.md

@@ -0,0 +1,135 @@
+[**@walletmesh/aztec-rpc-wallet v0.3.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletBaseMethodMap
+
+# Interface: AztecWalletBaseMethodMap
+
+Defined in: [aztec/rpc-wallet/src/types.ts:83](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L83)
+
+A mapping of JSON-RPC methods to their parameters and return types for Aztec Wallets.
+
+This extends the base WalletMethodMap with Aztec-specific methods.
+
+## Extends
+
+- `WalletMethodMap`
+
+## Extended by
+
+- [`AztecWalletMethodMap`](AztecWalletMethodMap.md)
+
+## Indexable
+
+\[`method`: `string`\]: `object`
+
+## Properties
+
+### aztec\_connect
+
+> **aztec\_connect**: `object`
+
+Defined in: [aztec/rpc-wallet/src/types.ts:88](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L88)
+
+Connects to the Aztec network.
+
+#### result
+
+> **result**: `boolean`
+
+#### Returns
+
+A boolean indicating if the connection was successful
+
+***
+
+### aztec\_getAccount
+
+> **aztec\_getAccount**: `object`
+
+Defined in: [aztec/rpc-wallet/src/types.ts:94](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L94)
+
+Gets the account address from the wallet.
+
+#### result
+
+> **result**: `string`
+
+#### Returns
+
+The account address as a string
+
+***
+
+### aztec\_sendTransaction
+
+> **aztec\_sendTransaction**: `object`
+
+Defined in: [aztec/rpc-wallet/src/types.ts:101](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L101)
+
+Sends transactions to the Aztec network.
+
+#### params
+
+> **params**: [`TransactionParams`](../type-aliases/TransactionParams.md)
+
+#### result
+
+> **result**: `string`
+
+#### Param
+
+The transactions to execute and optional authorization witnesses
+
+#### Returns
+
+The transaction hash as a string
+
+***
+
+### aztec\_simulateTransaction
+
+> **aztec\_simulateTransaction**: `object`
+
+Defined in: [aztec/rpc-wallet/src/types.ts:111](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L111)
+
+Simulates a transaction without executing it.
+
+#### params
+
+> **params**: [`TransactionFunctionCall`](../type-aliases/TransactionFunctionCall.md)
+
+#### result
+
+> **result**: `unknown`
+
+#### Param
+
+The transaction to simulate
+
+#### Returns
+
+The simulation result
+
+***
+
+### wm\_getSupportedMethods
+
+> **wm\_getSupportedMethods**: `object`
+
+Defined in: [aztec/rpc-wallet/src/types.ts:120](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L120)
+
+Returns the list of supported methods for the wallet.
+
+#### result
+
+> **result**: `string`[]
+
+#### Returns
+
+An array of supported methods
+
+#### Overrides
+
+`WalletMethodMap.wm_getSupportedMethods`

package/docs/interfaces/AztecWalletEventMap.md

@@ -0,0 +1,17 @@
+[**@walletmesh/aztec-rpc-wallet v0.3.0**](../README.md)
+
+***
+
+[@walletmesh/aztec-rpc-wallet](../globals.md) / AztecWalletEventMap
+
+# Interface: AztecWalletEventMap
+
+Defined in: [aztec/rpc-wallet/src/types.ts:125](https://github.com/WalletMesh/walletmesh-packages/blob/937a416f9c444488735f94f0d3eb35a7feadda3e/aztec/rpc-wallet/src/types.ts#L125)
+
+## Extends
+
+- `JSONRPCEventMap`
+
+## Indexable
+
+\[`event`: `string`\]: `unknown`