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

package/docs/classes/EventEmitter.md

@@ -0,0 +1,305 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / EventEmitter
+
+# Class: EventEmitter\<EventTypes, Context\>
+
+Minimal `EventEmitter` interface that is molded against the Node.js
+`EventEmitter` interface.
+
+## Extended by
+
+- [`BaseWalletAdapter`](BaseWalletAdapter.md)
+
+## Type Parameters
+
+### EventTypes
+
+`EventTypes` *extends* [`ValidEventTypes`](../@miden-sdk/namespaces/EventEmitter/type-aliases/ValidEventTypes.md) = `string` \| `symbol`
+
+### Context
+
+`Context` *extends* `any` = `any`
+
+## Constructors
+
+### Constructor
+
+> **new EventEmitter**\<`EventTypes`, `Context`\>(): `EventEmitter`\<`EventTypes`, `Context`\>
+
+#### Returns
+
+`EventEmitter`\<`EventTypes`, `Context`\>
+
+## Properties
+
+### prefixed
+
+> `static` **prefixed**: `string` \| `boolean`
+
+## Methods
+
+### addListener()
+
+> **addListener**\<`T`\>(`event`, `fn`, `context?`): `this`
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string` \| `symbol`
+
+#### Parameters
+
+##### event
+
+`T`
+
+##### fn
+
+[`EventListener`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md)\<`EventTypes`, `T`\>
+
+##### context?
+
+`Context`
+
+#### Returns
+
+`this`
+
+***
+
+### emit()
+
+> **emit**\<`T`\>(`event`, ...`args`): `boolean`
+
+Calls each of the listeners registered for a given event.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string` \| `symbol`
+
+#### Parameters
+
+##### event
+
+`T`
+
+##### args
+
+...`Parameters`\<[`EventListener`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md)\<`EventTypes`, `T`\>\>
+
+#### Returns
+
+`boolean`
+
+***
+
+### eventNames()
+
+> **eventNames**(): [`EventNames`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventNames.md)\<`EventTypes`\>[]
+
+Return an array listing the events for which the emitter has registered
+listeners.
+
+#### Returns
+
+[`EventNames`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventNames.md)\<`EventTypes`\>[]
+
+***
+
+### listenerCount()
+
+> **listenerCount**(`event`): `number`
+
+Return the number of listeners listening to a given event.
+
+#### Parameters
+
+##### event
+
+[`EventNames`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventNames.md)\<`EventTypes`\>
+
+#### Returns
+
+`number`
+
+***
+
+### listeners()
+
+> **listeners**\<`T`\>(`event`): [`EventListener`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md)\<`EventTypes`, `T`\>[]
+
+Return the listeners registered for a given event.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string` \| `symbol`
+
+#### Parameters
+
+##### event
+
+`T`
+
+#### Returns
+
+[`EventListener`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md)\<`EventTypes`, `T`\>[]
+
+***
+
+### off()
+
+> **off**\<`T`\>(`event`, `fn?`, `context?`, `once?`): `this`
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string` \| `symbol`
+
+#### Parameters
+
+##### event
+
+`T`
+
+##### fn?
+
+[`EventListener`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md)\<`EventTypes`, `T`\>
+
+##### context?
+
+`Context`
+
+##### once?
+
+`boolean`
+
+#### Returns
+
+`this`
+
+***
+
+### on()
+
+> **on**\<`T`\>(`event`, `fn`, `context?`): `this`
+
+Add a listener for a given event.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string` \| `symbol`
+
+#### Parameters
+
+##### event
+
+`T`
+
+##### fn
+
+[`EventListener`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md)\<`EventTypes`, `T`\>
+
+##### context?
+
+`Context`
+
+#### Returns
+
+`this`
+
+***
+
+### once()
+
+> **once**\<`T`\>(`event`, `fn`, `context?`): `this`
+
+Add a one-time listener for a given event.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string` \| `symbol`
+
+#### Parameters
+
+##### event
+
+`T`
+
+##### fn
+
+[`EventListener`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md)\<`EventTypes`, `T`\>
+
+##### context?
+
+`Context`
+
+#### Returns
+
+`this`
+
+***
+
+### removeAllListeners()
+
+> **removeAllListeners**(`event?`): `this`
+
+Remove all listeners, or those of the specified event.
+
+#### Parameters
+
+##### event?
+
+[`EventNames`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventNames.md)\<`EventTypes`\>
+
+#### Returns
+
+`this`
+
+***
+
+### removeListener()
+
+> **removeListener**\<`T`\>(`event`, `fn?`, `context?`, `once?`): `this`
+
+Remove the listeners of a given event.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `string` \| `symbol`
+
+#### Parameters
+
+##### event
+
+`T`
+
+##### fn?
+
+[`EventListener`](../@miden-sdk/namespaces/EventEmitter/type-aliases/EventListener.md)\<`EventTypes`, `T`\>
+
+##### context?
+
+`Context`
+
+##### once?
+
+`boolean`
+
+#### Returns
+
+`this`

package/docs/classes/SendTransaction.md

@@ -0,0 +1,107 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / SendTransaction
+
+# Class: SendTransaction
+
+## Implements
+
+- [`MidenSendTransaction`](../interfaces/MidenSendTransaction.md)
+
+## Constructors
+
+### Constructor
+
+> **new SendTransaction**(`sender`, `recipient`, `faucetId`, `noteType`, `amount`, `recallBlocks?`): `SendTransaction`
+
+#### Parameters
+
+##### sender
+
+`string`
+
+##### recipient
+
+`string`
+
+##### faucetId
+
+`string`
+
+##### noteType
+
+[`NoteTypeString`](../type-aliases/NoteTypeString.md)
+
+##### amount
+
+`number`
+
+##### recallBlocks?
+
+`number`
+
+#### Returns
+
+`SendTransaction`
+
+## Properties
+
+### amount
+
+> **amount**: `number`
+
+#### Implementation of
+
+[`MidenSendTransaction`](../interfaces/MidenSendTransaction.md).[`amount`](../interfaces/MidenSendTransaction.md#amount)
+
+***
+
+### faucetId
+
+> **faucetId**: `string`
+
+#### Implementation of
+
+[`MidenSendTransaction`](../interfaces/MidenSendTransaction.md).[`faucetId`](../interfaces/MidenSendTransaction.md#faucetid)
+
+***
+
+### noteType
+
+> **noteType**: [`NoteTypeString`](../type-aliases/NoteTypeString.md)
+
+#### Implementation of
+
+[`MidenSendTransaction`](../interfaces/MidenSendTransaction.md).[`noteType`](../interfaces/MidenSendTransaction.md#notetype)
+
+***
+
+### recallBlocks?
+
+> `optional` **recallBlocks**: `number`
+
+#### Implementation of
+
+[`MidenSendTransaction`](../interfaces/MidenSendTransaction.md).[`recallBlocks`](../interfaces/MidenSendTransaction.md#recallblocks)
+
+***
+
+### recipientAddress
+
+> **recipientAddress**: `string`
+
+#### Implementation of
+
+[`MidenSendTransaction`](../interfaces/MidenSendTransaction.md).[`recipientAddress`](../interfaces/MidenSendTransaction.md#recipientaddress)
+
+***
+
+### senderAddress
+
+> **senderAddress**: `string`
+
+#### Implementation of
+
+[`MidenSendTransaction`](../interfaces/MidenSendTransaction.md).[`senderAddress`](../interfaces/MidenSendTransaction.md#senderaddress)

package/docs/classes/Transaction.md

@@ -0,0 +1,151 @@
+[**@miden-sdk/miden-wallet-adapter-base**](../README.md)
+
+***
+
+[@miden-sdk/miden-wallet-adapter-base](../README.md) / Transaction
+
+# Class: Transaction
+
+## Implements
+
+- [`MidenTransaction`](../interfaces/MidenTransaction.md)
+
+## Constructors
+
+### Constructor
+
+> **new Transaction**(`type`, `payload`): `Transaction`
+
+#### Parameters
+
+##### type
+
+[`TransactionType`](../enumerations/TransactionType.md)
+
+##### payload
+
+[`TransactionPayload`](../type-aliases/TransactionPayload.md)
+
+#### Returns
+
+`Transaction`
+
+## Properties
+
+### payload
+
+> **payload**: [`TransactionPayload`](../type-aliases/TransactionPayload.md)
+
+#### Implementation of
+
+[`MidenTransaction`](../interfaces/MidenTransaction.md).[`payload`](../interfaces/MidenTransaction.md#payload)
+
+***
+
+### type
+
+> **type**: [`TransactionType`](../enumerations/TransactionType.md)
+
+#### Implementation of
+
+[`MidenTransaction`](../interfaces/MidenTransaction.md).[`type`](../interfaces/MidenTransaction.md#type)
+
+## Methods
+
+### createConsumeTransaction()
+
+> `static` **createConsumeTransaction**(`faucetId`, `noteId`, `noteType`, `amount`, `noteBytes?`): `Transaction`
+
+#### Parameters
+
+##### faucetId
+
+`string`
+
+##### noteId
+
+`string`
+
+##### noteType
+
+[`NoteTypeString`](../type-aliases/NoteTypeString.md)
+
+##### amount
+
+`number`
+
+##### noteBytes?
+
+`Uint8Array`
+
+#### Returns
+
+`Transaction`
+
+***
+
+### createCustomTransaction()
+
+> `static` **createCustomTransaction**(`address`, `recipientAddress`, `transactionRequest`, `inputNoteIds?`, `noteBytes?`): `Transaction`
+
+#### Parameters
+
+##### address
+
+`string`
+
+##### recipientAddress
+
+`string`
+
+##### transactionRequest
+
+`TransactionRequest`
+
+##### inputNoteIds?
+
+`string`[]
+
+##### noteBytes?
+
+`Uint8Array`\<`ArrayBufferLike`\>[]
+
+#### Returns
+
+`Transaction`
+
+***
+
+### createSendTransaction()
+
+> `static` **createSendTransaction**(`sender`, `recipient`, `faucetId`, `noteType`, `amount`, `recallBlocks?`): `Transaction`
+
+#### Parameters
+
+##### sender
+
+`string`
+
+##### recipient
+
+`string`
+
+##### faucetId
+
+`string`
+
+##### noteType
+
+[`NoteTypeString`](../type-aliases/NoteTypeString.md)
+
+##### amount
+
+`number`
+
+##### recallBlocks?
+
+`number`
+
+#### Returns
+
+`Transaction`