@miden-sdk/miden-wallet-adapter-base 0.13.0

package/docs/classes/WalletWindowBlockedError.md

@@ -0,0 +1,223 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletWindowBlockedError
+
+# Class: WalletWindowBlockedError
+
+## Extends
+
+- [`WalletError`](WalletError.md)
+
+## Constructors
+
+### Constructor
+
+> **new WalletWindowBlockedError**(`message?`, `error?`): `WalletWindowBlockedError`
+
+#### Parameters
+
+##### message?
+
+`string`
+
+##### error?
+
+`any`
+
+#### Returns
+
+`WalletWindowBlockedError`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`constructor`](WalletError.md#constructor)
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`cause`](WalletError.md#cause)
+
+***
+
+### error
+
+> **error**: `any`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`error`](WalletError.md#error)
+
+***
+
+### message
+
+> **message**: `string`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`message`](WalletError.md#message)
+
+***
+
+### name
+
+> **name**: `string` = `'WalletWindowBlockedError'`
+
+#### Overrides
+
+[`WalletError`](WalletError.md).[`name`](WalletError.md#name)
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`stack`](WalletError.md#stack)
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+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)`).
+
+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.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`stackTraceLimit`](WalletError.md#stacktracelimit)
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+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();
+}
+
+function b() {
+  c();
+}
+
+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
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`captureStackTrace`](WalletError.md#capturestacktrace)
+
+***
+
+### isError()
+
+> `static` **isError**(`error`): `error is Error`
+
+Indicates whether the argument provided is a built-in Error instance or not.
+
+#### Parameters
+
+##### error
+
+`unknown`
+
+#### Returns
+
+`error is Error`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`isError`](WalletError.md#iserror)
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`prepareStackTrace`](WalletError.md#preparestacktrace)

package/docs/classes/WalletWindowClosedError.md

@@ -0,0 +1,223 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletWindowClosedError
+
+# Class: WalletWindowClosedError
+
+## Extends
+
+- [`WalletError`](WalletError.md)
+
+## Constructors
+
+### Constructor
+
+> **new WalletWindowClosedError**(`message?`, `error?`): `WalletWindowClosedError`
+
+#### Parameters
+
+##### message?
+
+`string`
+
+##### error?
+
+`any`
+
+#### Returns
+
+`WalletWindowClosedError`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`constructor`](WalletError.md#constructor)
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`cause`](WalletError.md#cause)
+
+***
+
+### error
+
+> **error**: `any`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`error`](WalletError.md#error)
+
+***
+
+### message
+
+> **message**: `string`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`message`](WalletError.md#message)
+
+***
+
+### name
+
+> **name**: `string` = `'WalletWindowClosedError'`
+
+#### Overrides
+
+[`WalletError`](WalletError.md).[`name`](WalletError.md#name)
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`stack`](WalletError.md#stack)
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+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)`).
+
+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.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`stackTraceLimit`](WalletError.md#stacktracelimit)
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+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();
+}
+
+function b() {
+  c();
+}
+
+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
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`captureStackTrace`](WalletError.md#capturestacktrace)
+
+***
+
+### isError()
+
+> `static` **isError**(`error`): `error is Error`
+
+Indicates whether the argument provided is a built-in Error instance or not.
+
+#### Parameters
+
+##### error
+
+`unknown`
+
+#### Returns
+
+`error is Error`
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`isError`](WalletError.md#iserror)
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+[`WalletError`](WalletError.md).[`prepareStackTrace`](WalletError.md#preparestacktrace)

package/docs/enumerations/AllowedPrivateData.md

@@ -0,0 +1,37 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / AllowedPrivateData
+
+# Enumeration: AllowedPrivateData
+
+## Enumeration Members
+
+### All
+
+> **All**: `65535`
+
+***
+
+### Assets
+
+> **Assets**: `1`
+
+***
+
+### None
+
+> **None**: `0`
+
+***
+
+### Notes
+
+> **Notes**: `2`
+
+***
+
+### Storage
+
+> **Storage**: `4`

package/docs/enumerations/PrivateDataPermission.md

@@ -0,0 +1,19 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / PrivateDataPermission
+
+# Enumeration: PrivateDataPermission
+
+## Enumeration Members
+
+### Auto
+
+> **Auto**: `"AUTO"`
+
+***
+
+### UponRequest
+
+> **UponRequest**: `"UPON_REQUEST"`

package/docs/enumerations/TransactionType.md

@@ -0,0 +1,25 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / TransactionType
+
+# Enumeration: TransactionType
+
+## Enumeration Members
+
+### Consume
+
+> **Consume**: `"consume"`
+
+***
+
+### Custom
+
+> **Custom**: `"custom"`
+
+***
+
+### Send
+
+> **Send**: `"send"`

package/docs/enumerations/WalletAdapterNetwork.md

@@ -0,0 +1,19 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletAdapterNetwork
+
+# Enumeration: WalletAdapterNetwork
+
+## Enumeration Members
+
+### Localnet
+
+> **Localnet**: `"localnet"`
+
+***
+
+### Testnet
+
+> **Testnet**: `"testnet"`

package/docs/enumerations/WalletReadyState.md

@@ -0,0 +1,49 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletReadyState
+
+# Enumeration: WalletReadyState
+
+A wallet's readiness describes a series of states that the wallet can be in,
+depending on what kind of wallet it is. An installable wallet (eg. a browser
+extension like Phantom) might be `Installed` if we've found the Phantom API
+in the global scope, or `NotDetected` otherwise. A loadable, zero-install
+runtime (eg. Torus Wallet) might simply signal that it's `Loadable`. Use this
+metadata to personalize the wallet list for each user (eg. to show their
+installed wallets first).
+
+## Enumeration Members
+
+### Installed
+
+> **Installed**: `"Installed"`
+
+User-installable wallets can typically be detected by scanning for an API
+that they've injected into the global context. If such an API is present,
+we consider the wallet to have been installed.
+
+***
+
+### Loadable
+
+> **Loadable**: `"Loadable"`
+
+Loadable wallets are always available to you. Since you can load them at
+any time, it's meaningless to say that they have been detected.
+
+***
+
+### NotDetected
+
+> **NotDetected**: `"NotDetected"`
+
+***
+
+### Unsupported
+
+> **Unsupported**: `"Unsupported"`
+
+If a wallet is not supported on a given platform (eg. server-rendering, or
+mobile) then it will stay in the `Unsupported` state.

package/docs/functions/b64ToU8.md

@@ -0,0 +1,19 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / b64ToU8
+
+# Function: b64ToU8()
+
+> **b64ToU8**(`b64`): `Uint8Array`
+
+## Parameters
+
+### b64
+
+`string`
+
+## Returns
+
+`Uint8Array`

package/docs/functions/scopePollingDetectionStrategy.md

@@ -0,0 +1,19 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / scopePollingDetectionStrategy
+
+# Function: scopePollingDetectionStrategy()
+
+> **scopePollingDetectionStrategy**(`detect`): `void`
+
+## Parameters
+
+### detect
+
+() => `boolean`
+
+## Returns
+
+`void`

package/docs/functions/u8ToB64.md

@@ -0,0 +1,19 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / u8ToB64
+
+# Function: u8ToB64()
+
+> **u8ToB64**(`u8`): `string`
+
+## Parameters
+
+### u8
+
+`Uint8Array`
+
+## Returns
+
+`string`

package/docs/interfaces/Asset.md

@@ -0,0 +1,19 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / Asset
+
+# Interface: Asset
+
+## Properties
+
+### amount
+
+> **amount**: `string`
+
+***
+
+### faucetId
+
+> **faucetId**: `string`

package/docs/interfaces/IFailedTransactionOutput.md

@@ -0,0 +1,13 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / IFailedTransactionOutput
+
+# Interface: IFailedTransactionOutput
+
+## Properties
+
+### errorMessage
+
+> **errorMessage**: `string`