beignet 0.0.1

package/docs/markdown/classes/Wallet.md

@@ -0,0 +1,2189 @@
+[beignet](../README.md) / Wallet
+
+# Class: Wallet
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Wallet.md#constructor)
+
+### Properties
+
+- [\_customGetAddress](Wallet.md#_customgetaddress)
+- [\_customGetScriptHash](Wallet.md#_customgetscripthash)
+- [\_data](Wallet.md#_data)
+- [\_getData](Wallet.md#_getdata)
+- [\_mnemonic](Wallet.md#_mnemonic)
+- [\_network](Wallet.md#_network)
+- [\_passphrase](Wallet.md#_passphrase)
+- [\_root](Wallet.md#_root)
+- [\_seed](Wallet.md#_seed)
+- [\_setData](Wallet.md#_setdata)
+- [electrum](Wallet.md#electrum)
+- [electrumOptions](Wallet.md#electrumoptions)
+- [exchangeRates](Wallet.md#exchangerates)
+- [feeEstimates](Wallet.md#feeestimates)
+- [id](Wallet.md#id)
+- [isSwitchingNetworks](Wallet.md#isswitchingnetworks)
+- [name](Wallet.md#name)
+- [onMessage](Wallet.md#onmessage)
+- [rbf](Wallet.md#rbf)
+- [selectedFeeId](Wallet.md#selectedfeeid)
+- [transaction](Wallet.md#transaction)
+
+### Accessors
+
+- [data](Wallet.md#data)
+- [network](Wallet.md#network)
+
+### Methods
+
+- [\_getAddress](Wallet.md#_getaddress)
+- [addAddresses](Wallet.md#addaddresses)
+- [addBoostedTransaction](Wallet.md#addboostedtransaction)
+- [addGhostTransaction](Wallet.md#addghosttransaction)
+- [addTxInput](Wallet.md#addtxinput)
+- [addTxTag](Wallet.md#addtxtag)
+- [addUnconfirmedTransactions](Wallet.md#addunconfirmedtransactions)
+- [blockHeightToConfirmations](Wallet.md#blockheighttoconfirmations)
+- [checkElectrumConnection](Wallet.md#checkelectrumconnection)
+- [checkUnconfirmedTransactions](Wallet.md#checkunconfirmedtransactions)
+- [clearAddresses](Wallet.md#clearaddresses)
+- [clearTransactions](Wallet.md#cleartransactions)
+- [clearUtxos](Wallet.md#clearutxos)
+- [confirmationsToBlockHeight](Wallet.md#confirmationstoblockheight)
+- [connectToElectrum](Wallet.md#connecttoelectrum)
+- [deleteOnChainTransactionById](Wallet.md#deleteonchaintransactionbyid)
+- [formatTransactions](Wallet.md#formattransactions)
+- [generateAddresses](Wallet.md#generateaddresses)
+- [generateNewReceiveAddress](Wallet.md#generatenewreceiveaddress)
+- [getAddress](Wallet.md#getaddress)
+- [getAddressBalance](Wallet.md#getaddressbalance)
+- [getAddressByPath](Wallet.md#getaddressbypath)
+- [getAddressFromScriptHash](Wallet.md#getaddressfromscripthash)
+- [getAddressIndexInfo](Wallet.md#getaddressindexinfo)
+- [getAddressesBalance](Wallet.md#getaddressesbalance)
+- [getBalance](Wallet.md#getbalance)
+- [getBip32Interface](Wallet.md#getbip32interface)
+- [getBitcoinNetwork](Wallet.md#getbitcoinnetwork)
+- [getBoostableTransactions](Wallet.md#getboostabletransactions)
+- [getBoostedTransactionParents](Wallet.md#getboostedtransactionparents)
+- [getBoostedTransactions](Wallet.md#getboostedtransactions)
+- [getChangeAddress](Wallet.md#getchangeaddress)
+- [getExchangeRate](Wallet.md#getexchangerate)
+- [getFeeEstimates](Wallet.md#getfeeestimates)
+- [getFeeInfo](Wallet.md#getfeeinfo)
+- [getGapLimit](Wallet.md#getgaplimit)
+- [getHighestStoredAddressIndex](Wallet.md#gethigheststoredaddressindex)
+- [getInputData](Wallet.md#getinputdata)
+- [getNextAvailableAddress](Wallet.md#getnextavailableaddress)
+- [getPrivateKey](Wallet.md#getprivatekey)
+- [getRbfData](Wallet.md#getrbfdata)
+- [getReceiveAddress](Wallet.md#getreceiveaddress)
+- [getScriptHash](Wallet.md#getscripthash)
+- [getScriptHashBalance](Wallet.md#getscripthashbalance)
+- [getUnconfirmedTransactions](Wallet.md#getunconfirmedtransactions)
+- [getUtxos](Wallet.md#getutxos)
+- [getWalletData](Wallet.md#getwalletdata)
+- [getWalletDataKey](Wallet.md#getwalletdatakey)
+- [isValid](Wallet.md#isvalid)
+- [listUtxos](Wallet.md#listutxos)
+- [processUnconfirmedTransactions](Wallet.md#processunconfirmedtransactions)
+- [refreshWallet](Wallet.md#refreshwallet)
+- [removeDuplicateAddresses](Wallet.md#removeduplicateaddresses)
+- [removeTxInput](Wallet.md#removetxinput)
+- [removeTxTag](Wallet.md#removetxtag)
+- [rescanAddresses](Wallet.md#rescanaddresses)
+- [resetAddressIndexes](Wallet.md#resetaddressindexes)
+- [resetSendTransaction](Wallet.md#resetsendtransaction)
+- [saveWalletData](Wallet.md#savewalletdata)
+- [send](Wallet.md#send)
+- [sendMany](Wallet.md#sendmany)
+- [setWalletData](Wallet.md#setwalletdata)
+- [setZeroIndexAddresses](Wallet.md#setzeroindexaddresses)
+- [setupFeeForOnChainTransaction](Wallet.md#setupfeeforonchaintransaction)
+- [setupTransaction](Wallet.md#setuptransaction)
+- [storageIdCheck](Wallet.md#storageidcheck)
+- [switchNetwork](Wallet.md#switchnetwork)
+- [updateAddressIndex](Wallet.md#updateaddressindex)
+- [updateAddressIndexes](Wallet.md#updateaddressindexes)
+- [updateAddressType](Wallet.md#updateaddresstype)
+- [updateAndSaveWalletData](Wallet.md#updateandsavewalletdata)
+- [updateExchangeRates](Wallet.md#updateexchangerates)
+- [updateFeeEstimates](Wallet.md#updatefeeestimates)
+- [updateGhostTransactions](Wallet.md#updateghosttransactions)
+- [updateHeader](Wallet.md#updateheader)
+- [updateTransactionHeights](Wallet.md#updatetransactionheights)
+- [updateTransactions](Wallet.md#updatetransactions)
+- [updateWalletBalance](Wallet.md#updatewalletbalance)
+- [validateAddress](Wallet.md#validateaddress)
+- [create](Wallet.md#create)
+
+## Constructors
+
+### constructor
+
+• `Private` **new Wallet**(`«destructured»`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | [`IWallet`](../interfaces/IWallet.md) |
+
+#### Defined in
+
+[wallet/index.ts:129](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L129)
+
+## Properties
+
+### \_customGetAddress
+
+• `Private` `Optional` **\_customGetAddress**: (`data`: [`ICustomGetAddress`](../interfaces/ICustomGetAddress.md)) => `Promise`\<[`Result`](../README.md#result)\<[`IGetAddressResponse`](../interfaces/IGetAddressResponse.md)\>\>
+
+#### Type declaration
+
+▸ (`data`): `Promise`\<[`Result`](../README.md#result)\<[`IGetAddressResponse`](../interfaces/IGetAddressResponse.md)\>\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`ICustomGetAddress`](../interfaces/ICustomGetAddress.md) |
+
+##### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGetAddressResponse`](../interfaces/IGetAddressResponse.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:107](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L107)
+
+___
+
+### \_customGetScriptHash
+
+• `Private` `Optional` **\_customGetScriptHash**: (`data`: [`ICustomGetScriptHash`](../interfaces/ICustomGetScriptHash.md)) => `Promise`\<`string`\>
+
+#### Type declaration
+
+▸ (`data`): `Promise`\<`string`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`ICustomGetScriptHash`](../interfaces/ICustomGetScriptHash.md) |
+
+##### Returns
+
+`Promise`\<`string`\>
+
+#### Defined in
+
+[wallet/index.ts:110](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L110)
+
+___
+
+### \_data
+
+• `Private` **\_data**: [`IWalletData`](../interfaces/IWalletData.md)
+
+#### Defined in
+
+[wallet/index.ts:104](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L104)
+
+___
+
+### \_getData
+
+• `Private` **\_getData**: [`TGetData`](../README.md#tgetdata)
+
+#### Defined in
+
+[wallet/index.ts:105](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L105)
+
+___
+
+### \_mnemonic
+
+• `Private` `Readonly` **\_mnemonic**: `string`
+
+#### Defined in
+
+[wallet/index.ts:100](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L100)
+
+___
+
+### \_network
+
+• `Private` **\_network**: [`EAvailableNetworks`](../enums/EAvailableNetworks.md)
+
+#### Defined in
+
+[wallet/index.ts:99](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L99)
+
+___
+
+### \_passphrase
+
+• `Private` `Readonly` **\_passphrase**: `string`
+
+#### Defined in
+
+[wallet/index.ts:101](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L101)
+
+___
+
+### \_root
+
+• `Private` `Readonly` **\_root**: `BIP32Interface`
+
+#### Defined in
+
+[wallet/index.ts:103](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L103)
+
+___
+
+### \_seed
+
+• `Private` `Readonly` **\_seed**: `Buffer`
+
+#### Defined in
+
+[wallet/index.ts:102](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L102)
+
+___
+
+### \_setData
+
+• `Private` `Optional` **\_setData**: [`TSetData`](../README.md#tsetdata)
+
+#### Defined in
+
+[wallet/index.ts:106](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L106)
+
+___
+
+### electrum
+
+• **electrum**: [`Electrum`](Electrum.md)
+
+#### Defined in
+
+[wallet/index.ts:122](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L122)
+
+___
+
+### electrumOptions
+
+• `Optional` **electrumOptions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `net?` | `Server` |
+| `servers?` | [`TServer`](../README.md#tserver) \| [`TServer`](../README.md#tserver)[] |
+| `tls?` | `TLSSocket` |
+
+#### Defined in
+
+[wallet/index.ts:117](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L117)
+
+___
+
+### exchangeRates
+
+• **exchangeRates**: [`IExchangeRates`](../interfaces/IExchangeRates.md)
+
+#### Defined in
+
+[wallet/index.ts:123](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L123)
+
+___
+
+### feeEstimates
+
+• **feeEstimates**: [`IOnchainFees`](../interfaces/IOnchainFees.md)
+
+#### Defined in
+
+[wallet/index.ts:126](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L126)
+
+___
+
+### id
+
+• `Readonly` **id**: `string`
+
+#### Defined in
+
+[wallet/index.ts:115](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L115)
+
+___
+
+### isSwitchingNetworks
+
+• **isSwitchingNetworks**: `boolean`
+
+#### Defined in
+
+[wallet/index.ts:114](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L114)
+
+___
+
+### name
+
+• `Readonly` **name**: `string`
+
+#### Defined in
+
+[wallet/index.ts:116](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L116)
+
+___
+
+### onMessage
+
+• `Optional` **onMessage**: [`TOnMessage`](../README.md#tonmessage)
+
+#### Defined in
+
+[wallet/index.ts:124](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L124)
+
+___
+
+### rbf
+
+• **rbf**: `boolean`
+
+#### Defined in
+
+[wallet/index.ts:127](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L127)
+
+___
+
+### selectedFeeId
+
+• **selectedFeeId**: [`EFeeId`](../enums/EFeeId.md)
+
+#### Defined in
+
+[wallet/index.ts:128](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L128)
+
+___
+
+### transaction
+
+• **transaction**: [`Transaction`](Transaction.md)
+
+#### Defined in
+
+[wallet/index.ts:125](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L125)
+
+## Accessors
+
+### data
+
+• `get` **data**(): [`IWalletData`](../interfaces/IWalletData.md)
+
+#### Returns
+
+[`IWalletData`](../interfaces/IWalletData.md)
+
+#### Defined in
+
+[wallet/index.ts:181](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L181)
+
+___
+
+### network
+
+• `get` **network**(): [`EAvailableNetworks`](../enums/EAvailableNetworks.md)
+
+#### Returns
+
+[`EAvailableNetworks`](../enums/EAvailableNetworks.md)
+
+#### Defined in
+
+[wallet/index.ts:185](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L185)
+
+## Methods
+
+### \_getAddress
+
+▸ `Private` **_getAddress**(`path`, `addressType`): `Promise`\<[`IGetAddressResponse`](../interfaces/IGetAddressResponse.md)\>
+
+Returns the address for the specified path and address type.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+| `addressType` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+`Promise`\<[`IGetAddressResponse`](../interfaces/IGetAddressResponse.md)\>
+
+#### Defined in
+
+[wallet/index.ts:444](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L444)
+
+___
+
+### addAddresses
+
+▸ `Private` **addAddresses**(`«destructured»?`): `Promise`\<[`Result`](../README.md#result)\<[`IGenerateAddressesResponse`](../interfaces/IGenerateAddressesResponse.md)\>\>
+
+This method will generate addresses as specified and return an object of filtered addresses to ensure no duplicates are returned.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | [`IGenerateAddresses`](../interfaces/IGenerateAddresses.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGenerateAddressesResponse`](../interfaces/IGenerateAddressesResponse.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1171](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1171)
+
+___
+
+### addBoostedTransaction
+
+▸ **addBoostedTransaction**(`«destructured»`): `Promise`\<[`Result`](../README.md#result)\<[`IBoostedTransaction`](../interfaces/IBoostedTransaction.md)\>\>
+
+Adds a boosted transaction id to the boostedTransactions object.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `fee` | `number` |
+| › `newTxId` | `string` |
+| › `oldTxId` | `string` |
+| › `type?` | [`EBoostType`](../enums/EBoostType.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IBoostedTransaction`](../interfaces/IBoostedTransaction.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:2960](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2960)
+
+___
+
+### addGhostTransaction
+
+▸ **addGhostTransaction**(`txid`): `Promise`\<`void`\>
+
+Sets "exists" to false for a given on-chain transaction id.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `txid` | `Object` |
+| `txid.txid` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[wallet/index.ts:2945](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2945)
+
+___
+
+### addTxInput
+
+▸ **addTxInput**(`input`): [`Result`](../README.md#result)\<[`IUtxo`](../interfaces/IUtxo.md)[]\>
+
+Adds a specified input to the current transaction.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | `Object` |
+| `input.input` | [`IUtxo`](../interfaces/IUtxo.md) |
+
+#### Returns
+
+[`Result`](../README.md#result)\<[`IUtxo`](../interfaces/IUtxo.md)[]\>
+
+#### Defined in
+
+[wallet/index.ts:3073](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3073)
+
+___
+
+### addTxTag
+
+▸ **addTxTag**(`tag`): [`Result`](../README.md#result)\<`string`\>
+
+Adds a specified tag to the current transaction.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tag` | `Object` |
+| `tag.tag` | `string` |
+
+#### Returns
+
+[`Result`](../README.md#result)\<`string`\>
+
+#### Defined in
+
+[wallet/index.ts:3121](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3121)
+
+___
+
+### addUnconfirmedTransactions
+
+▸ `Private` **addUnconfirmedTransactions**(`transactions`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Parses and adds unconfirmed transactions to the store.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `transactions` | `Object` |
+| `transactions.transactions` | [`IFormattedTransactions`](../interfaces/IFormattedTransactions.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2070](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2070)
+
+___
+
+### blockHeightToConfirmations
+
+▸ **blockHeightToConfirmations**(`«destructured»`): `number`
+
+Returns the number of confirmations for a given block height.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `blockHeight?` | `number` |
+| › `currentHeight?` | `number` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[wallet/index.ts:2112](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2112)
+
+___
+
+### checkElectrumConnection
+
+▸ **checkElectrumConnection**(): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Ensures the connection to Electrum is still available.
+Will attempt to reconnect if not initially available.
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+#### Defined in
+
+[wallet/index.ts:809](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L809)
+
+___
+
+### checkUnconfirmedTransactions
+
+▸ `Private` **checkUnconfirmedTransactions**(): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Checks existing unconfirmed transactions that have been received and removes any that have >= 6 confirmations.
+If the tx is reorg'd or bumped from the mempool and no longer exists, the transaction
+will be removed from the store and updated in the activity list.
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1773](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1773)
+
+___
+
+### clearAddresses
+
+▸ `Private` **clearAddresses**(): `Promise`\<`string`\>
+
+Clears the addresses and changeAddresses object for a given wallet and network.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2030](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2030)
+
+___
+
+### clearTransactions
+
+▸ `Private` **clearTransactions**(): `Promise`\<`string`\>
+
+Clears the transactions object for a given wallet and network from storage.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+#### Defined in
+
+[wallet/index.ts:2018](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2018)
+
+___
+
+### clearUtxos
+
+▸ `Private` **clearUtxos**(): `Promise`\<`string`\>
+
+Clears the UTXO array and balance from storage.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2003](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2003)
+
+___
+
+### confirmationsToBlockHeight
+
+▸ **confirmationsToBlockHeight**(`«destructured»`): `number`
+
+Returns the block height for a given number of confirmations from storage.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `confirmations` | `number` |
+| › `currentHeight?` | `number` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[wallet/index.ts:1898](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1898)
+
+___
+
+### connectToElectrum
+
+▸ **connectToElectrum**(`servers?`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Attempts to connect to the specified Electrum server(s).
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `servers?` | [`TServer`](../README.md#tserver) \| [`TServer`](../README.md#tserver)[] |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+#### Defined in
+
+[wallet/index.ts:570](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L570)
+
+___
+
+### deleteOnChainTransactionById
+
+▸ **deleteOnChainTransactionById**(`txid`): `Promise`\<`void`\>
+
+Deletes a given on-chain transaction by id.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `txid` | `Object` |
+| `txid.txid` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[wallet/index.ts:2929](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2929)
+
+___
+
+### formatTransactions
+
+▸ **formatTransactions**(`transactions`): `Promise`\<[`Result`](../README.md#result)\<[`IFormattedTransactions`](../interfaces/IFormattedTransactions.md)\>\>
+
+Formats the provided transaction.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `transactions` | `Object` |
+| `transactions.transactions` | [`ITransaction`](../interfaces/ITransaction.md)\<[`IUtxo`](../interfaces/IUtxo.md)\>[] |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IFormattedTransactions`](../interfaces/IFormattedTransactions.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2138](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2138)
+
+___
+
+### generateAddresses
+
+▸ **generateAddresses**(`«destructured»`): `Promise`\<[`Result`](../README.md#result)\<[`IGenerateAddressesResponse`](../interfaces/IGenerateAddressesResponse.md)\>\>
+
+Generates a series of addresses based on the specified params.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | [`IGenerateAddresses`](../interfaces/IGenerateAddresses.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGenerateAddressesResponse`](../interfaces/IGenerateAddressesResponse.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:701](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L701)
+
+___
+
+### generateNewReceiveAddress
+
+▸ **generateNewReceiveAddress**(`«destructured»`): `Promise`\<[`Result`](../README.md#result)\<[`IAddress`](../interfaces/IAddress.md)\>\>
+
+Generate a new receive address for the provided addresstype up to the set gap limit.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `addressType?` | [`EAddressType`](../enums/EAddressType.md) |
+| › `keyDerivationPath?` | [`IKeyDerivationPath`](../interfaces/IKeyDerivationPath.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IAddress`](../interfaces/IAddress.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1455](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1455)
+
+___
+
+### getAddress
+
+▸ **getAddress**(`«destructured»?`): `Promise`\<`string`\>
+
+Returns a single Bitcoin address based on the provided address type,
+index and whether it is a change address.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | [`IGetAddress`](../interfaces/IGetAddress.md) |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+#### Defined in
+
+[wallet/index.ts:510](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L510)
+
+___
+
+### getAddressBalance
+
+▸ **getAddressBalance**(`address`): `Promise`\<[`Result`](../README.md#result)\<[`IGetAddressBalanceRes`](../interfaces/IGetAddressBalanceRes.md)\>\>
+
+Returns the address balance for the specified address.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `string` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGetAddressBalanceRes`](../interfaces/IGetAddressBalanceRes.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:591](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L591)
+
+___
+
+### getAddressByPath
+
+▸ **getAddressByPath**(`«destructured»`): `Promise`\<[`Result`](../README.md#result)\<[`IGetAddressResponse`](../interfaces/IGetAddressResponse.md)\>\>
+
+Get address for a given keyPair, network and type.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | [`IGetAddressByPath`](../interfaces/IGetAddressByPath.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGetAddressResponse`](../interfaces/IGetAddressResponse.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:544](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L544)
+
+___
+
+### getAddressFromScriptHash
+
+▸ **getAddressFromScriptHash**(`scriptHash`): `undefined` \| [`IAddress`](../interfaces/IAddress.md)
+
+Returns the address from a provided script hash in storage.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `scriptHash` | `string` |
+
+#### Returns
+
+`undefined` \| [`IAddress`](../interfaces/IAddress.md)
+
+#### Defined in
+
+[wallet/index.ts:2589](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2589)
+
+___
+
+### getAddressIndexInfo
+
+▸ **getAddressIndexInfo**(): [`TAddressIndexInfo`](../README.md#taddressindexinfo)
+
+Returns current address index information.
+
+#### Returns
+
+[`TAddressIndexInfo`](../README.md#taddressindexinfo)
+
+#### Defined in
+
+[wallet/index.ts:2677](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2677)
+
+___
+
+### getAddressesBalance
+
+▸ **getAddressesBalance**(`addresses?`): `Promise`\<[`Result`](../README.md#result)\<`number`\>\>
+
+Returns combined balance of provided addresses.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `addresses` | `string`[] | `[]` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`number`\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:609](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L609)
+
+___
+
+### getBalance
+
+▸ **getBalance**(): `number`
+
+Returns the known balance from storage.
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[wallet/index.ts:685](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L685)
+
+___
+
+### getBip32Interface
+
+▸ **getBip32Interface**(): `Promise`\<[`Result`](../README.md#result)\<`BIP32Interface`\>\>
+
+Creates a BIP32Interface from the selected wallet's mnemonic and passphrase
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`BIP32Interface`\>\>
+
+#### Defined in
+
+[wallet/index.ts:3061](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3061)
+
+___
+
+### getBitcoinNetwork
+
+▸ `Private` **getBitcoinNetwork**(`network?`): `Network`
+
+Returns the Network object of the currently selected network (bitcoin or testnet).
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `network?` | [`TAvailableNetworks`](../README.md#tavailablenetworks) |
+
+#### Returns
+
+`Network`
+
+#### Defined in
+
+[wallet/index.ts:423](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L423)
+
+___
+
+### getBoostableTransactions
+
+▸ **getBoostableTransactions**(): `Object`
+
+Returns an array of transactions that can be boosted with cpfp and rbf.
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `cpfp` | [`IFormattedTransaction`](../interfaces/IFormattedTransaction.md)[] |
+| `rbf` | [`IFormattedTransaction`](../interfaces/IFormattedTransaction.md)[] |
+
+#### Defined in
+
+[wallet/index.ts:3044](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3044)
+
+___
+
+### getBoostedTransactionParents
+
+▸ **getBoostedTransactionParents**(`«destructured»`): `string`[]
+
+Returns an array of parents for a boosted transaction id.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `boostedTransactions?` | [`IBoostedTransactions`](../interfaces/IBoostedTransactions.md) |
+| › `txid` | `string` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+[wallet/index.ts:3007](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3007)
+
+___
+
+### getBoostedTransactions
+
+▸ **getBoostedTransactions**(): [`IBoostedTransactions`](../interfaces/IBoostedTransactions.md)
+
+Returns boosted transactions object.
+
+#### Returns
+
+[`IBoostedTransactions`](../interfaces/IBoostedTransactions.md)
+
+#### Defined in
+
+[wallet/index.ts:3028](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3028)
+
+___
+
+### getChangeAddress
+
+▸ **getChangeAddress**(`addressType?`): `Promise`\<[`Result`](../README.md#result)\<[`IAddress`](../interfaces/IAddress.md)\>\>
+
+Retrieves the next available change address data.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `addressType?` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IAddress`](../interfaces/IAddress.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2371](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2371)
+
+___
+
+### getExchangeRate
+
+▸ **getExchangeRate**(`currency?`): `number`
+
+Returns exchange rate data from storage.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `currency` | `string` | `'EUR'` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[wallet/index.ts:2345](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2345)
+
+___
+
+### getFeeEstimates
+
+▸ **getFeeEstimates**(`network?`): `Promise`\<[`IOnchainFees`](../interfaces/IOnchainFees.md)\>
+
+Returns the current fee estimates for the provided network.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `network` | [`EAvailableNetworks`](../enums/EAvailableNetworks.md) |
+
+#### Returns
+
+`Promise`\<[`IOnchainFees`](../interfaces/IOnchainFees.md)\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2404](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2404)
+
+___
+
+### getFeeInfo
+
+▸ **getFeeInfo**(`«destructured»?`): [`Result`](../README.md#result)\<[`TGetTotalFeeObj`](../README.md#tgettotalfeeobj)\>
+
+Returns a fee object for the current transaction.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `fundingLightning?` | `boolean` |
+| › `message?` | `string` |
+| › `satsPerByte?` | `number` |
+| › `transaction?` | `Partial`\<[`ISendTransaction`](../interfaces/ISendTransaction.md)\> |
+
+#### Returns
+
+[`Result`](../README.md#result)\<[`TGetTotalFeeObj`](../README.md#tgettotalfeeobj)\>
+
+#### Defined in
+
+[wallet/index.ts:2453](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2453)
+
+___
+
+### getGapLimit
+
+▸ `Private` **getGapLimit**(`addressType?`): [`Result`](../README.md#result)\<\{ `addressDelta`: `number` ; `changeAddressDelta`: `number`  }\>
+
+Returns the difference between the current address index and the last used address index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `addressType?` | `Object` |
+| `addressType.addressType?` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+[`Result`](../README.md#result)\<\{ `addressDelta`: `number` ; `changeAddressDelta`: `number`  }\>
+
+#### Defined in
+
+[wallet/index.ts:1543](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1543)
+
+___
+
+### getHighestStoredAddressIndex
+
+▸ **getHighestStoredAddressIndex**(`addressType`): [`Result`](../README.md#result)\<\{ `addressIndex`: [`IAddress`](../interfaces/IAddress.md) ; `changeAddressIndex`: [`IAddress`](../interfaces/IAddress.md)  }\>
+
+Returns the highest address and change address index stored in the app for the specified wallet and network.
+Retrives the highest stored address index for the provided address type.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `addressType` | `Object` |
+| `addressType.addressType` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+[`Result`](../README.md#result)\<\{ `addressIndex`: [`IAddress`](../interfaces/IAddress.md) ; `changeAddressIndex`: [`IAddress`](../interfaces/IAddress.md)  }\>
+
+#### Defined in
+
+[wallet/index.ts:1132](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1132)
+
+___
+
+### getInputData
+
+▸ **getInputData**(`inputs`): `Promise`\<[`Result`](../README.md#result)\<[`InputData`](../README.md#inputdata)\>\>
+
+Returns formatted input data from the inputs array.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `inputs` | `Object` |
+| `inputs.inputs` | \{ `tx_hash`: `string` ; `vout`: `number`  }[] |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`InputData`](../README.md#inputdata)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2304](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2304)
+
+___
+
+### getNextAvailableAddress
+
+▸ **getNextAvailableAddress**(`addressType?`): `Promise`\<[`Result`](../README.md#result)\<[`IGetNextAvailableAddressResponse`](../interfaces/IGetNextAvailableAddressResponse.md)\>\>
+
+Returns the next available address for the given addresstype.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `addressType?` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGetNextAvailableAddressResponse`](../interfaces/IGetNextAvailableAddressResponse.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:825](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L825)
+
+___
+
+### getPrivateKey
+
+▸ **getPrivateKey**(`path`): `string`
+
+Returns private key for the provided path.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[wallet/index.ts:663](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L663)
+
+___
+
+### getRbfData
+
+▸ **getRbfData**(`txHash`): `Promise`\<[`Result`](../README.md#result)\<[`IRbfData`](../interfaces/IRbfData.md)\>\>
+
+Using a tx_hash this method will return the necessary data to create a
+replace-by-fee transaction for any 0-conf, RBF-enabled tx.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `txHash` | `Object` |
+| `txHash.txHash` | [`ITxHash`](../interfaces/ITxHash.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IRbfData`](../interfaces/IRbfData.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:2747](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2747)
+
+___
+
+### getReceiveAddress
+
+▸ **getReceiveAddress**(`addressType?`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Returns the next available receive address.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `addressType?` | `Object` |
+| `addressType.addressType?` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+#### Defined in
+
+[wallet/index.ts:2699](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2699)
+
+___
+
+### getScriptHash
+
+▸ **getScriptHash**(`«destructured»`): `Promise`\<`string`\>
+
+Get scriptHash for a given address
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `address` | `string` |
+| › `network` | [`EAvailableNetworks`](../enums/EAvailableNetworks.md) |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+#### Defined in
+
+[wallet/index.ts:644](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L644)
+
+___
+
+### getScriptHashBalance
+
+▸ **getScriptHashBalance**(`scriptHash`): `Promise`\<[`Result`](../README.md#result)\<[`IGetAddressBalanceRes`](../interfaces/IGetAddressBalanceRes.md)\>\>
+
+Returns the balance for the specified scriptHash.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `scriptHash` | `string` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGetAddressBalanceRes`](../interfaces/IGetAddressBalanceRes.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:673](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L673)
+
+___
+
+### getUnconfirmedTransactions
+
+▸ **getUnconfirmedTransactions**(): [`IFormattedTransactions`](../interfaces/IFormattedTransactions.md)
+
+Returns the current wallet's unconfirmed transactions from storage.
+
+#### Returns
+
+[`IFormattedTransactions`](../interfaces/IFormattedTransactions.md)
+
+#### Defined in
+
+[wallet/index.ts:1886](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1886)
+
+___
+
+### getUtxos
+
+▸ **getUtxos**(`scanAllAddresses`): `Promise`\<[`Result`](../README.md#result)\<[`IGetUtxosResponse`](../interfaces/IGetUtxosResponse.md)\>\>
+
+Retrieves and sets UTXO's for the current wallet from Electrum.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `scanAllAddresses` | `Object` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGetUtxosResponse`](../interfaces/IGetUtxosResponse.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:1579](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1579)
+
+___
+
+### getWalletData
+
+▸ **getWalletData**(): `Promise`\<[`Result`](../README.md#result)\<[`IWalletData`](../interfaces/IWalletData.md)\>\>
+
+Gets the wallet data object from storage if able.
+Otherwise, it falls back to the default wallet data object.
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IWalletData`](../interfaces/IWalletData.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:339](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L339)
+
+___
+
+### getWalletDataKey
+
+▸ **getWalletDataKey**(`key`): `string`
+
+Returns the key used for storing wallet data in the key/value pair.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | keyof [`IWalletData`](../interfaces/IWalletData.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[wallet/index.ts:330](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L330)
+
+___
+
+### isValid
+
+▸ **isValid**(`mnemonic`): `boolean`
+
+Ensures the provided mnemonic matches the one stored in the wallet and is valid.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mnemonic` | `any` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[wallet/index.ts:433](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L433)
+
+___
+
+### listUtxos
+
+▸ **listUtxos**(): [`IUtxo`](../interfaces/IUtxo.md)[]
+
+Returns the current wallet's UTXO's from storage.
+
+#### Returns
+
+[`IUtxo`](../interfaces/IUtxo.md)[]
+
+#### Defined in
+
+[wallet/index.ts:1603](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1603)
+
+___
+
+### processUnconfirmedTransactions
+
+▸ `Private` **processUnconfirmedTransactions**(): `Promise`\<[`Result`](../README.md#result)\<[`TProcessUnconfirmedTransactions`](../README.md#tprocessunconfirmedtransactions)\>\>
+
+This method processes all transactions with less than 6 confirmations and returns the following:
+1. Transactions that still have less than 6 confirmations and can be considered unconfirmed. (unconfirmedTxs)
+2. Transactions that have fewer confirmations than before due to a reorg. (outdatedTxs)
+3. Transactions that have been removed from the mempool. (ghostTxs)
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`TProcessUnconfirmedTransactions`](../README.md#tprocessunconfirmedtransactions)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1816](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1816)
+
+___
+
+### refreshWallet
+
+▸ **refreshWallet**(`«destructured»?`): `Promise`\<[`Result`](../README.md#result)\<[`IWalletData`](../interfaces/IWalletData.md)\>\>
+
+Refreshes/Syncs the wallet data.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `scanAllAddresses` | `undefined` \| `boolean` |
+| › `updateAllAddressTypes` | `undefined` \| `boolean` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IWalletData`](../interfaces/IWalletData.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:255](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L255)
+
+___
+
+### removeDuplicateAddresses
+
+▸ `Private` **removeDuplicateAddresses**(`«destructured»`): `Promise`\<[`Result`](../README.md#result)\<[`IGenerateAddressesResponse`](../interfaces/IGenerateAddressesResponse.md)\>\>
+
+This method will compare a set of specified addresses to the currently stored addresses and remove any duplicates.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `addresses?` | [`IAddresses`](../interfaces/IAddresses.md) |
+| › `changeAddresses?` | [`IAddresses`](../interfaces/IAddresses.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IGenerateAddressesResponse`](../interfaces/IGenerateAddressesResponse.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1242](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1242)
+
+___
+
+### removeTxInput
+
+▸ **removeTxInput**(`input`): [`Result`](../README.md#result)\<[`IUtxo`](../interfaces/IUtxo.md)[]\>
+
+Removes the specified input from the current transaction.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `input` | `Object` |
+| `input.input` | [`IUtxo`](../interfaces/IUtxo.md) |
+
+#### Returns
+
+[`Result`](../README.md#result)\<[`IUtxo`](../interfaces/IUtxo.md)[]\>
+
+#### Defined in
+
+[wallet/index.ts:3095](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3095)
+
+___
+
+### removeTxTag
+
+▸ **removeTxTag**(`tag`): [`Result`](../README.md#result)\<`string`\>
+
+Removes a specified tag from the current transaction.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `tag` | `Object` |
+| `tag.tag` | `string` |
+
+#### Returns
+
+[`Result`](../README.md#result)\<`string`\>
+
+#### Defined in
+
+[wallet/index.ts:3144](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3144)
+
+___
+
+### rescanAddresses
+
+▸ **rescanAddresses**(`«destructured»?`): `Promise`\<[`Result`](../README.md#result)\<[`IWalletData`](../interfaces/IWalletData.md)\>\>
+
+This method will clear the utxo array for each address type and reset the
+address indexes back to the original/default app values. Once cleared & reset
+the app will rescan the wallet's addresses from index zero.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `shouldClearAddresses?` | `boolean` |
+| › `shouldClearTransactions?` | `boolean` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IWalletData`](../interfaces/IWalletData.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1975](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1975)
+
+___
+
+### resetAddressIndexes
+
+▸ `Private` **resetAddressIndexes**(): `Promise`\<`void`\>
+
+Resets address indexes back to the app's default/original state.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[wallet/index.ts:1427](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1427)
+
+___
+
+### resetSendTransaction
+
+▸ **resetSendTransaction**(): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+This completely resets the send transaction state.
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+#### Defined in
+
+[wallet/index.ts:3036](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3036)
+
+___
+
+### saveWalletData
+
+▸ `Private` **saveWalletData**\<`K`\>(`key`, `data`): `Promise`\<`void`\>
+
+Saves the wallet data object to storage if able.
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends keyof [`IWalletData`](../interfaces/IWalletData.md) |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | keyof [`IWalletData`](../interfaces/IWalletData.md) |
+| `data` | [`IWalletData`](../interfaces/IWalletData.md)[`K`] |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1615](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1615)
+
+___
+
+### send
+
+▸ **send**(`«destructured»`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Sets up and creates a transaction to a single output/recipient.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `address` | `string` |
+| › `amount` | `number` |
+| › `broadcast?` | `boolean` |
+| › `message?` | `string` |
+| › `rbf?` | `boolean` |
+| › `satsPerByte?` | `number` |
+| › `shuffleOutputs?` | `boolean` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2558](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2558)
+
+___
+
+### sendMany
+
+▸ **sendMany**(`«destructured»`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Sets up and creates a transaction to multiple outputs.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `broadcast?` | `boolean` |
+| › `rbf?` | `boolean` |
+| › `satsPerByte?` | `number` |
+| › `shuffleOutputs?` | `boolean` |
+| › `txs` | [`ISendTx`](../interfaces/ISendTx.md)[] |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+#### Defined in
+
+[wallet/index.ts:2481](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2481)
+
+___
+
+### setWalletData
+
+▸ `Private` **setWalletData**(): `Promise`\<[`Result`](../README.md#result)\<`boolean`\>\>
+
+Sets the wallet data object.
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`boolean`\>\>
+
+#### Defined in
+
+[wallet/index.ts:282](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L282)
+
+___
+
+### setZeroIndexAddresses
+
+▸ `Private` **setZeroIndexAddresses**(): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Will ensure that both address and change address indexes are set at index 0.
+Will also generate and store address and changeAddress at index 0.
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2609](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2609)
+
+___
+
+### setupFeeForOnChainTransaction
+
+▸ **setupFeeForOnChainTransaction**(`«destructured»?`): [`Result`](../README.md#result)\<`string`\>
+
+Updates the fee rate for the current transaction to the preferred value if none set.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `satsPerByte?` | `number` |
+| › `selectedFeeId?` | [`EFeeId`](../enums/EFeeId.md) |
+
+#### Returns
+
+[`Result`](../README.md#result)\<`string`\>
+
+#### Defined in
+
+[wallet/index.ts:3169](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3169)
+
+___
+
+### setupTransaction
+
+▸ **setupTransaction**(`params?`): `Promise`\<[`TSetupTransactionResponse`](../README.md#tsetuptransactionresponse)\>
+
+Sets up the transaction object with existing inputs and change address information
+@async.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`ISetupTransaction`](../interfaces/ISetupTransaction.md) |
+
+#### Returns
+
+`Promise`\<[`TSetupTransactionResponse`](../README.md#tsetuptransactionresponse)\>
+
+#### Defined in
+
+[wallet/index.ts:2439](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2439)
+
+___
+
+### storageIdCheck
+
+▸ `Private` **storageIdCheck**(`id`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Ensure we are not overwriting wallet data of a different wallet by checking that the wallet id's match.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | `string` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:305](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L305)
+
+___
+
+### switchNetwork
+
+▸ **switchNetwork**(`network`, `servers?`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `network` | [`EAvailableNetworks`](../enums/EAvailableNetworks.md) |
+| `servers?` | [`TServer`](../README.md#tserver) \| [`TServer`](../README.md#tserver)[] |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+#### Defined in
+
+[wallet/index.ts:204](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L204)
+
+___
+
+### updateAddressIndex
+
+▸ `Private` **updateAddressIndex**(`addressType`, `isChangeAddress`, `index?`): `Promise`\<`void`\>
+
+Updates the address index for a given address type.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `addressType` | [`EAddressType`](../enums/EAddressType.md) | `undefined` |
+| `isChangeAddress` | `boolean` | `undefined` |
+| `index?` | `number` | `0` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2651](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2651)
+
+___
+
+### updateAddressIndexes
+
+▸ `Private` **updateAddressIndexes**(`addressType?`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+This method updates the next available (zero-balance) address & changeAddress index.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `addressType?` | `Object` |
+| `addressType.addressType?` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1292](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1292)
+
+___
+
+### updateAddressType
+
+▸ **updateAddressType**(`addressType`): `Promise`\<`void`\>
+
+Updates the address type for the current wallet.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `addressType` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[wallet/index.ts:243](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L243)
+
+___
+
+### updateAndSaveWalletData
+
+▸ `Private` **updateAndSaveWalletData**(`key`, `data`, `addressType?`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | keyof [`IWalletData`](../interfaces/IWalletData.md) |
+| `data` | [`IWalletData`](../interfaces/IWalletData.md) |
+| `addressType?` | [`EAddressType`](../enums/EAddressType.md) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[wallet/index.ts:1626](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1626)
+
+___
+
+### updateExchangeRates
+
+▸ **updateExchangeRates**(): `Promise`\<[`Result`](../README.md#result)\<[`IExchangeRates`](../interfaces/IExchangeRates.md)\>\>
+
+Updates the exchange rates for the current network.
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IExchangeRates`](../interfaces/IExchangeRates.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:3221](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3221)
+
+___
+
+### updateFeeEstimates
+
+▸ **updateFeeEstimates**(`forceUpdate?`): `Promise`\<[`Result`](../README.md#result)\<[`IOnchainFees`](../interfaces/IOnchainFees.md)\>\>
+
+Updates the fee estimates for the current network.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `forceUpdate?` | `boolean` | `false` | Ignores the timestamp if set true and forces the update |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`IOnchainFees`](../interfaces/IOnchainFees.md)\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:3236](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3236)
+
+___
+
+### updateGhostTransactions
+
+▸ `Private` **updateGhostTransactions**(`txIds`): `Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+Removes transactions from the store and activity list.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `txIds` | `Object` |
+| `txIds.txIds` | `string`[] |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`string`\>\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:1932](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1932)
+
+___
+
+### updateHeader
+
+▸ **updateHeader**(`headerData`): `Promise`\<`void`\>
+
+Updates & Saves header information to storage.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `headerData` | [`IHeader`](../interfaces/IHeader.md) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Defined in
+
+[wallet/index.ts:1920](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1920)
+
+___
+
+### updateTransactionHeights
+
+▸ `Private` **updateTransactionHeights**(`txs`): `Promise`\<`string`\>
+
+Updates the confirmation state of activity item transactions that were reorg'd out.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `txs` | [`IUtxo`](../interfaces/IUtxo.md)[] |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+**`Async`**
+
+#### Defined in
+
+[wallet/index.ts:2047](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2047)
+
+___
+
+### updateTransactions
+
+▸ **updateTransactions**(`«destructured»?`): `Promise`\<[`Result`](../README.md#result)\<`undefined` \| `string`\>\>
+
+Retrieves, formats & stores the transaction history for the selected wallet/network.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `replaceStoredTransactions?` | `boolean` |
+| › `scanAllAddresses?` | `boolean` |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<`undefined` \| `string`\>\>
+
+#### Defined in
+
+[wallet/index.ts:1647](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L1647)
+
+___
+
+### updateWalletBalance
+
+▸ **updateWalletBalance**(`balance`): [`Result`](../README.md#result)\<`string`\>
+
+Used to temporarily update the balance until the Electrum server catches up after sending a transaction.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `balance` | `Object` |
+| `balance.balance` | `number` |
+
+#### Returns
+
+[`Result`](../README.md#result)\<`string`\>
+
+#### Defined in
+
+[wallet/index.ts:3205](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L3205)
+
+___
+
+### validateAddress
+
+▸ **validateAddress**(`address`): `boolean`
+
+Attempts to validate a given address.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[wallet/index.ts:2361](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L2361)
+
+___
+
+### create
+
+▸ `Static` **create**(`params`): `Promise`\<[`Result`](../README.md#result)\<[`Wallet`](Wallet.md)\>\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | [`IWallet`](../interfaces/IWallet.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](../README.md#result)\<[`Wallet`](Wallet.md)\>\>
+
+#### Defined in
+
+[wallet/index.ts:189](https://github.com/synonymdev/beignet/blob/7c83290/src/wallet/index.ts#L189)