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

package/docs/classes/WalletConnectionError.md

@@ -0,0 +1,223 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletConnectionError
+
+# Class: WalletConnectionError
+
+## Extends
+
+- [`WalletError`](WalletError.md)
+
+## Constructors
+
+### Constructor
+
+> **new WalletConnectionError**(`message?`, `error?`): `WalletConnectionError`
+
+#### Parameters
+
+##### message?
+
+`string`
+
+##### error?
+
+`any`
+
+#### Returns
+
+`WalletConnectionError`
+
+#### 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` = `'WalletConnectionError'`
+
+#### 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/WalletDecryptionError.md

@@ -0,0 +1,223 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletDecryptionError
+
+# Class: WalletDecryptionError
+
+## Extends
+
+- [`WalletError`](WalletError.md)
+
+## Constructors
+
+### Constructor
+
+> **new WalletDecryptionError**(`message?`, `error?`): `WalletDecryptionError`
+
+#### Parameters
+
+##### message?
+
+`string`
+
+##### error?
+
+`any`
+
+#### Returns
+
+`WalletDecryptionError`
+
+#### 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` = `'WalletDecryptionError'`
+
+#### 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/WalletDecryptionNotAllowedError.md

@@ -0,0 +1,223 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / WalletDecryptionNotAllowedError
+
+# Class: WalletDecryptionNotAllowedError
+
+## Extends
+
+- [`WalletError`](WalletError.md)
+
+## Constructors
+
+### Constructor
+
+> **new WalletDecryptionNotAllowedError**(`message?`, `error?`): `WalletDecryptionNotAllowedError`
+
+#### Parameters
+
+##### message?
+
+`string`
+
+##### error?
+
+`any`
+
+#### Returns
+
+`WalletDecryptionNotAllowedError`
+
+#### 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` = `'WalletDecryptionNotAllowedError'`
+
+#### 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)