beignet 0.0.1

package/docs/markdown/README.md

@@ -0,0 +1,1875 @@
+beignet
+
+# beignet
+
+## Table of contents
+
+### Enumerations
+
+- [EAddressType](enums/EAddressType.md)
+- [EAvailableNetworks](enums/EAvailableNetworks.md)
+- [EBoostType](enums/EBoostType.md)
+- [EFeeId](enums/EFeeId.md)
+- [EPaymentType](enums/EPaymentType.md)
+- [EProtocol](enums/EProtocol.md)
+- [EUnit](enums/EUnit.md)
+
+### Classes
+
+- [Electrum](classes/Electrum.md)
+- [Transaction](classes/Transaction.md)
+- [Wallet](classes/Wallet.md)
+
+### Interfaces
+
+- [IAddInput](interfaces/IAddInput.md)
+- [IAddress](interfaces/IAddress.md)
+- [IAddressData](interfaces/IAddressData.md)
+- [IAddressType](interfaces/IAddressType.md)
+- [IAddressTypeData](interfaces/IAddressTypeData.md)
+- [IAddresses](interfaces/IAddresses.md)
+- [IBoostedTransaction](interfaces/IBoostedTransaction.md)
+- [IBoostedTransactions](interfaces/IBoostedTransactions.md)
+- [ICreateTransaction](interfaces/ICreateTransaction.md)
+- [ICustomGetAddress](interfaces/ICustomGetAddress.md)
+- [ICustomGetScriptHash](interfaces/ICustomGetScriptHash.md)
+- [IElectrumGetAddressBalanceRes](interfaces/IElectrumGetAddressBalanceRes.md)
+- [IExchangeRates](interfaces/IExchangeRates.md)
+- [IFormattedPeerData](interfaces/IFormattedPeerData.md)
+- [IFormattedTransaction](interfaces/IFormattedTransaction.md)
+- [IFormattedTransactions](interfaces/IFormattedTransactions.md)
+- [IGenerateAddresses](interfaces/IGenerateAddresses.md)
+- [IGenerateAddressesResponse](interfaces/IGenerateAddressesResponse.md)
+- [IGetAddress](interfaces/IGetAddress.md)
+- [IGetAddressBalanceRes](interfaces/IGetAddressBalanceRes.md)
+- [IGetAddressByPath](interfaces/IGetAddressByPath.md)
+- [IGetAddressHistoryResponse](interfaces/IGetAddressHistoryResponse.md)
+- [IGetAddressResponse](interfaces/IGetAddressResponse.md)
+- [IGetAddressScriptHashesHistoryResponse](interfaces/IGetAddressScriptHashesHistoryResponse.md)
+- [IGetDerivationPath](interfaces/IGetDerivationPath.md)
+- [IGetFeeEstimatesResponse](interfaces/IGetFeeEstimatesResponse.md)
+- [IGetHeaderResponse](interfaces/IGetHeaderResponse.md)
+- [IGetNextAvailableAddressResponse](interfaces/IGetNextAvailableAddressResponse.md)
+- [IGetTransactions](interfaces/IGetTransactions.md)
+- [IGetTransactionsFromInputs](interfaces/IGetTransactionsFromInputs.md)
+- [IGetUtxosResponse](interfaces/IGetUtxosResponse.md)
+- [IHeader](interfaces/IHeader.md)
+- [IIndexes](interfaces/IIndexes.md)
+- [IKeyDerivationPath](interfaces/IKeyDerivationPath.md)
+- [IKeyDerivationPathData](interfaces/IKeyDerivationPathData.md)
+- [INewBlock](interfaces/INewBlock.md)
+- [IOnchainFees](interfaces/IOnchainFees.md)
+- [IOutput](interfaces/IOutput.md)
+- [IPeerData](interfaces/IPeerData.md)
+- [IRbfData](interfaces/IRbfData.md)
+- [ISend](interfaces/ISend.md)
+- [ISendTransaction](interfaces/ISendTransaction.md)
+- [ISendTx](interfaces/ISendTx.md)
+- [ISetupTransaction](interfaces/ISetupTransaction.md)
+- [ISubscribeToAddress](interfaces/ISubscribeToAddress.md)
+- [ISubscribeToHeader](interfaces/ISubscribeToHeader.md)
+- [ITargets](interfaces/ITargets.md)
+- [ITransaction](interfaces/ITransaction.md)
+- [ITxHash](interfaces/ITxHash.md)
+- [ITxHashes](interfaces/ITxHashes.md)
+- [IUtxo](interfaces/IUtxo.md)
+- [IVin](interfaces/IVin.md)
+- [IVout](interfaces/IVout.md)
+- [IWallet](interfaces/IWallet.md)
+- [IWalletData](interfaces/IWalletData.md)
+
+### Type Aliases
+
+- [ElectrumConnectionPubSub](README.md#electrumconnectionpubsub)
+- [ElectrumConnectionSubscription](README.md#electrumconnectionsubscription)
+- [InputData](README.md#inputdata)
+- [ObjectKeys](README.md#objectkeys)
+- [Result](README.md#result)
+- [TAddressIndexInfo](README.md#taddressindexinfo)
+- [TAddressLabel](README.md#taddresslabel)
+- [TAddressType](README.md#taddresstype)
+- [TAddressTypeContent](README.md#taddresstypecontent)
+- [TAddressTypes](README.md#taddresstypes)
+- [TAvailableNetworks](README.md#tavailablenetworks)
+- [TConnectToElectrumRes](README.md#tconnecttoelectrumres)
+- [TDecodeRawTx](README.md#tdecoderawtx)
+- [TElectrumNetworks](README.md#telectrumnetworks)
+- [TGetAddressHistory](README.md#tgetaddresshistory)
+- [TGetByteCountInput](README.md#tgetbytecountinput)
+- [TGetByteCountInputs](README.md#tgetbytecountinputs)
+- [TGetByteCountOutput](README.md#tgetbytecountoutput)
+- [TGetByteCountOutputs](README.md#tgetbytecountoutputs)
+- [TGetData](README.md#tgetdata)
+- [TGetTotalFeeObj](README.md#tgettotalfeeobj)
+- [TKeyDerivationAccount](README.md#tkeyderivationaccount)
+- [TKeyDerivationChange](README.md#tkeyderivationchange)
+- [TKeyDerivationCoinType](README.md#tkeyderivationcointype)
+- [TKeyDerivationIndex](README.md#tkeyderivationindex)
+- [TKeyDerivationPurpose](README.md#tkeyderivationpurpose)
+- [TMessageDataMap](README.md#tmessagedatamap)
+- [TMessageKeys](README.md#tmessagekeys)
+- [TOnMessage](README.md#tonmessage)
+- [TProcessUnconfirmedTransactions](README.md#tprocessunconfirmedtransactions)
+- [TProtocol](README.md#tprotocol)
+- [TServer](README.md#tserver)
+- [TSetData](README.md#tsetdata)
+- [TSetupTransactionResponse](README.md#tsetuptransactionresponse)
+- [TStorage](README.md#tstorage)
+- [TSubscribedReceive](README.md#tsubscribedreceive)
+- [TTransactionMessage](README.md#ttransactionmessage)
+- [TTxResponse](README.md#ttxresponse)
+- [TTxResult](README.md#ttxresult)
+- [TUnspentAddressScriptHashData](README.md#tunspentaddressscripthashdata)
+- [TWalletDataKeys](README.md#twalletdatakeys)
+
+### Variables
+
+- [defaultElectrumPorts](README.md#defaultelectrumports)
+- [electrumConnection](README.md#electrumconnection)
+- [mostUsedExchangeTickers](README.md#mostusedexchangetickers)
+
+### Functions
+
+- [availableNetworks](README.md#availablenetworks)
+- [constructByteCountParam](README.md#constructbytecountparam)
+- [decodeOpReturnMessage](README.md#decodeopreturnmessage)
+- [decodeRawTransaction](README.md#decoderawtransaction)
+- [err](README.md#err)
+- [formatKeyDerivationPath](README.md#formatkeyderivationpath)
+- [formatPeerData](README.md#formatpeerdata)
+- [generateMnemonic](README.md#generatemnemonic)
+- [generateWalletId](README.md#generatewalletid)
+- [getAddressFromScriptPubKey](README.md#getaddressfromscriptpubkey)
+- [getAddressTypeFromPath](README.md#getaddresstypefrompath)
+- [getByteCount](README.md#getbytecount)
+- [getDataFallback](README.md#getdatafallback)
+- [getDefaultPort](README.md#getdefaultport)
+- [getDefaultWalletData](README.md#getdefaultwalletdata)
+- [getDefaultWalletDataKeys](README.md#getdefaultwalletdatakeys)
+- [getExchangeRates](README.md#getexchangerates)
+- [getHighestUsedIndexFromTxHashes](README.md#gethighestusedindexfromtxhashes)
+- [getKeyDerivationPath](README.md#getkeyderivationpath)
+- [getKeyDerivationPathObject](README.md#getkeyderivationpathobject)
+- [getKeyDerivationPathString](README.md#getkeyderivationpathstring)
+- [getKeyValue](README.md#getkeyvalue)
+- [getPeers](README.md#getpeers)
+- [getProtocolForPort](README.md#getprotocolforport)
+- [getScriptHash](README.md#getscripthash)
+- [getSeed](README.md#getseed)
+- [getSeedHash](README.md#getseedhash)
+- [getSha256](README.md#getsha256)
+- [getStorageKeyValues](README.md#getstoragekeyvalues)
+- [getTxFee](README.md#gettxfee)
+- [getWalletDataStorageKey](README.md#getwalletdatastoragekey)
+- [isValidBech32mEncodedString](README.md#isvalidbech32mencodedstring)
+- [objectKeys](README.md#objectkeys-1)
+- [objectsMatch](README.md#objectsmatch)
+- [ok](README.md#ok)
+- [parseOnChainPaymentRequest](README.md#parseonchainpaymentrequest)
+- [reduceValue](README.md#reducevalue)
+- [removeDustOutputs](README.md#removedustoutputs)
+- [setReplaceByFee](README.md#setreplacebyfee)
+- [shuffleArray](README.md#shufflearray)
+- [validateAddress](README.md#validateaddress)
+- [validateMnemonic](README.md#validatemnemonic)
+- [validateTransaction](README.md#validatetransaction)
+
+## Type Aliases
+
+### ElectrumConnectionPubSub
+
+Ƭ **ElectrumConnectionPubSub**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `publish` | (`isConnected`: `boolean`) => `void` |
+| `subscribe` | (`callback`: (`isConnected`: `boolean`) => `void`) => [`ElectrumConnectionSubscription`](README.md#electrumconnectionsubscription) |
+
+#### Defined in
+
+[types/electrum.ts:128](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L128)
+
+___
+
+### ElectrumConnectionSubscription
+
+Ƭ **ElectrumConnectionSubscription**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `remove` | () => `void` |
+
+#### Defined in
+
+[types/electrum.ts:135](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L135)
+
+___
+
+### InputData
+
+Ƭ **InputData**: `Object`
+
+#### Index signature
+
+▪ [key: `string`]: \{ `addresses`: `string`[] ; `value`: `number`  }
+
+#### Defined in
+
+[types/wallet.ts:379](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L379)
+
+___
+
+### ObjectKeys
+
+Ƭ **ObjectKeys**\<`T`\>: \`$\{Exclude\<keyof T, symbol\>}\`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends `object` |
+
+#### Defined in
+
+[types/wallet.ts:452](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L452)
+
+___
+
+### Result
+
+Ƭ **Result**\<`T`\>: `Ok`\<`T`\> \| `Err`\<`T`\>
+
+Represents a result that can be successful (Ok) or contain an error (Err).
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Defined in
+
+[utils/result.ts:4](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/result.ts#L4)
+
+___
+
+### TAddressIndexInfo
+
+Ƭ **TAddressIndexInfo**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `addressIndex` | [`IAddress`](interfaces/IAddress.md) |
+| `changeAddressIndex` | [`IAddress`](interfaces/IAddress.md) |
+| `lastUsedAddressIndex` | [`IAddress`](interfaces/IAddress.md) |
+| `lastUsedChangeAddressIndex` | [`IAddress`](interfaces/IAddress.md) |
+
+#### Defined in
+
+[types/wallet.ts:473](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L473)
+
+___
+
+### TAddressLabel
+
+Ƭ **TAddressLabel**: ``"bech32"`` \| ``"segwit"`` \| ``"legacy"``
+
+#### Defined in
+
+[types/wallet.ts:15](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L15)
+
+___
+
+### TAddressType
+
+Ƭ **TAddressType**: ``"p2wpkh"`` \| ``"p2sh"`` \| ``"p2pkh"``
+
+#### Defined in
+
+[types/wallet.ts:14](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L14)
+
+___
+
+### TAddressTypeContent
+
+Ƭ **TAddressTypeContent**\<`T`\>: \{ [key in EAddressType]: T }
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Defined in
+
+[types/wallet.ts:46](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L46)
+
+___
+
+### TAddressTypes
+
+Ƭ **TAddressTypes**: \{ [key in EAddressType]: Readonly\<IAddressTypeData\> }
+
+#### Defined in
+
+[types/wallet.ts:21](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L21)
+
+___
+
+### TAvailableNetworks
+
+Ƭ **TAvailableNetworks**: ``"bitcoin"`` \| ``"testnet"`` \| ``"regtest"``
+
+#### Defined in
+
+[types/wallet.ts:13](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L13)
+
+___
+
+### TConnectToElectrumRes
+
+Ƭ **TConnectToElectrumRes**: `string`
+
+#### Defined in
+
+[types/electrum.ts:11](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L11)
+
+___
+
+### TDecodeRawTx
+
+Ƭ **TDecodeRawTx**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `locktime` | `number` |
+| `size` | `number` |
+| `tx_hash` | `string` |
+| `txid` | `string` |
+| `version` | `number` |
+| `vin` | [`IVin`](interfaces/IVin.md)[] |
+| `vout` | [`IVout`](interfaces/IVout.md)[] |
+| `vsize` | `number` |
+| `weight` | `number` |
+
+#### Defined in
+
+[types/transaction.ts:41](https://github.com/synonymdev/beignet/blob/7c83290/src/types/transaction.ts#L41)
+
+___
+
+### TElectrumNetworks
+
+Ƭ **TElectrumNetworks**: ``"bitcoin"`` \| ``"bitcoinTestnet"`` \| ``"bitcoinRegtest"``
+
+#### Defined in
+
+[types/electrum.ts:9](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L9)
+
+___
+
+### TGetAddressHistory
+
+Ƭ **TGetAddressHistory**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `height` | `number` |
+| `txid` | `string` |
+
+#### Defined in
+
+[types/electrum.ts:139](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L139)
+
+___
+
+### TGetByteCountInput
+
+Ƭ **TGetByteCountInput**: \`MULTISIG-P2SH:$\{number}-$\{number}\` \| \`MULTISIG-P2WSH:$\{number}-$\{number}\` \| \`MULTISIG-P2SH-P2WSH:$\{number}-$\{number}\` \| ``"P2SH-P2WPKH"`` \| ``"P2PKH"`` \| ``"p2pkh"`` \| ``"P2WPKH"`` \| ``"p2wpkh"`` \| ``"P2SH"`` \| ``"p2sh"`` \| ``"P2TR"`` \| ``"p2tr"``
+
+#### Defined in
+
+[types/wallet.ts:394](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L394)
+
+___
+
+### TGetByteCountInputs
+
+Ƭ **TGetByteCountInputs**: \{ [key in TGetByteCountInput]?: number }
+
+#### Defined in
+
+[types/wallet.ts:386](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L386)
+
+___
+
+### TGetByteCountOutput
+
+Ƭ **TGetByteCountOutput**: ``"P2SH"`` \| ``"P2PKH"`` \| ``"P2WPKH"`` \| ``"P2WSH"`` \| ``"p2wpkh"`` \| ``"p2sh"`` \| ``"p2pkh"`` \| ``"P2TR"`` \| ``"p2tr"``
+
+#### Defined in
+
+[types/wallet.ts:408](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L408)
+
+___
+
+### TGetByteCountOutputs
+
+Ƭ **TGetByteCountOutputs**: \{ [key in TGetByteCountOutput]?: number }
+
+#### Defined in
+
+[types/wallet.ts:390](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L390)
+
+___
+
+### TGetData
+
+Ƭ **TGetData**: \<K\>(`key`: `string`) => `Promise`\<[`Result`](README.md#result)\<[`IWalletData`](interfaces/IWalletData.md)[`K`]\>\>
+
+#### Type declaration
+
+▸ \<`K`\>(`key`): `Promise`\<[`Result`](README.md#result)\<[`IWalletData`](interfaces/IWalletData.md)[`K`]\>\>
+
+##### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends keyof [`IWalletData`](interfaces/IWalletData.md) |
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+
+##### Returns
+
+`Promise`\<[`Result`](README.md#result)\<[`IWalletData`](interfaces/IWalletData.md)[`K`]\>\>
+
+#### Defined in
+
+[types/wallet.ts:173](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L173)
+
+___
+
+### TGetTotalFeeObj
+
+Ƭ **TGetTotalFeeObj**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `maxSatPerByte` | `number` |
+| `satsPerByte` | `number` |
+| `totalFee` | `number` |
+| `transactionByteCount` | `number` |
+
+#### Defined in
+
+[types/transaction.ts:53](https://github.com/synonymdev/beignet/blob/7c83290/src/types/transaction.ts#L53)
+
+___
+
+### TKeyDerivationAccount
+
+Ƭ **TKeyDerivationAccount**: ``"0"`` \| `string`
+
+#### Defined in
+
+[types/wallet.ts:18](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L18)
+
+___
+
+### TKeyDerivationChange
+
+Ƭ **TKeyDerivationChange**: ``"0"`` \| ``"1"``
+
+#### Defined in
+
+[types/wallet.ts:19](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L19)
+
+___
+
+### TKeyDerivationCoinType
+
+Ƭ **TKeyDerivationCoinType**: ``"0"`` \| ``"1"`` \| `string`
+
+#### Defined in
+
+[types/wallet.ts:17](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L17)
+
+___
+
+### TKeyDerivationIndex
+
+Ƭ **TKeyDerivationIndex**: `string`
+
+#### Defined in
+
+[types/wallet.ts:20](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L20)
+
+___
+
+### TKeyDerivationPurpose
+
+Ƭ **TKeyDerivationPurpose**: ``"84"`` \| ``"49"`` \| ``"44"`` \| `string`
+
+#### Defined in
+
+[types/wallet.ts:16](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L16)
+
+___
+
+### TMessageDataMap
+
+Ƭ **TMessageDataMap**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `connectedToElectrum` | `boolean` |
+| `newBlock` | [`INewBlock`](interfaces/INewBlock.md) |
+| `rbf` | `string`[] |
+| `reorg` | [`IUtxo`](interfaces/IUtxo.md)[] |
+| `transactionConfirmed` | [`TTransactionMessage`](README.md#ttransactionmessage) |
+| `transactionReceived` | [`TTransactionMessage`](README.md#ttransactionmessage) |
+| `transactionSent` | [`TTransactionMessage`](README.md#ttransactionmessage) |
+
+#### Defined in
+
+[types/wallet.ts:435](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L435)
+
+___
+
+### TMessageKeys
+
+Ƭ **TMessageKeys**: keyof [`TMessageDataMap`](README.md#tmessagedatamap)
+
+#### Defined in
+
+[types/wallet.ts:460](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L460)
+
+___
+
+### TOnMessage
+
+Ƭ **TOnMessage**: \<K\>(`key`: `K`, `data`: [`TMessageDataMap`](README.md#tmessagedatamap)[`K`]) => `void`
+
+#### Type declaration
+
+▸ \<`K`\>(`key`, `data`): `void`
+
+##### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends keyof [`TMessageDataMap`](README.md#tmessagedatamap) |
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `K` |
+| `data` | [`TMessageDataMap`](README.md#tmessagedatamap)[`K`] |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[types/wallet.ts:455](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L455)
+
+___
+
+### TProcessUnconfirmedTransactions
+
+Ƭ **TProcessUnconfirmedTransactions**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `ghostTxs` | `string`[] |
+| `outdatedTxs` | [`IUtxo`](interfaces/IUtxo.md)[] |
+| `unconfirmedTxs` | [`IFormattedTransactions`](interfaces/IFormattedTransactions.md) |
+
+#### Defined in
+
+[types/wallet.ts:357](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L357)
+
+___
+
+### TProtocol
+
+Ƭ **TProtocol**: ``"tcp"`` \| ``"ssl"``
+
+#### Defined in
+
+[types/electrum.ts:23](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L23)
+
+___
+
+### TServer
+
+Ƭ **TServer**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `host` | `string` |
+| `protocol` | [`EProtocol`](enums/EProtocol.md) |
+| `ssl` | `number` |
+| `tcp` | `number` |
+
+#### Defined in
+
+[types/electrum.ts:17](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L17)
+
+___
+
+### TSetData
+
+Ƭ **TSetData**: \<K\>(`key`: `string`, `value`: [`IWalletData`](interfaces/IWalletData.md)[`K`]) => `Promise`\<[`Result`](README.md#result)\<`boolean`\>\>
+
+#### Type declaration
+
+▸ \<`K`\>(`key`, `value`): `Promise`\<[`Result`](README.md#result)\<`boolean`\>\>
+
+##### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends keyof [`IWalletData`](interfaces/IWalletData.md) |
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+| `value` | [`IWalletData`](interfaces/IWalletData.md)[`K`] |
+
+##### Returns
+
+`Promise`\<[`Result`](README.md#result)\<`boolean`\>\>
+
+#### Defined in
+
+[types/wallet.ts:176](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L176)
+
+___
+
+### TSetupTransactionResponse
+
+Ƭ **TSetupTransactionResponse**: [`Result`](README.md#result)\<`Partial`\<[`ISendTransaction`](interfaces/ISendTransaction.md)\>\>
+
+#### Defined in
+
+[types/transaction.ts:39](https://github.com/synonymdev/beignet/blob/7c83290/src/types/transaction.ts#L39)
+
+___
+
+### TStorage
+
+Ƭ **TStorage**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `getData?` | [`TGetData`](README.md#tgetdata) |
+| `setData?` | [`TSetData`](README.md#tsetdata) |
+
+#### Defined in
+
+[types/wallet.ts:480](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L480)
+
+___
+
+### TSubscribedReceive
+
+Ƭ **TSubscribedReceive**: [`string`, `string`]
+
+#### Defined in
+
+[types/electrum.ts:112](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L112)
+
+___
+
+### TTransactionMessage
+
+Ƭ **TTransactionMessage**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `transaction` | [`IFormattedTransaction`](interfaces/IFormattedTransaction.md) |
+
+#### Defined in
+
+[types/wallet.ts:445](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L445)
+
+___
+
+### TTxResponse
+
+Ƭ **TTxResponse**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`IAddress`](interfaces/IAddress.md) |
+| `id` | `number` |
+| `jsonrpc` | `string` |
+| `param` | `string` |
+| `result` | [`TTxResult`](README.md#ttxresult)[] |
+
+#### Defined in
+
+[types/electrum.ts:51](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L51)
+
+___
+
+### TTxResult
+
+Ƭ **TTxResult**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `height` | `number` |
+| `tx_hash` | `string` |
+
+#### Defined in
+
+[types/electrum.ts:38](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L38)
+
+___
+
+### TUnspentAddressScriptHashData
+
+Ƭ **TUnspentAddressScriptHashData**: `Object`
+
+#### Index signature
+
+▪ [x: `string`]: [`IUtxo`](interfaces/IUtxo.md) \| [`IAddress`](interfaces/IAddress.md)
+
+#### Defined in
+
+[types/electrum.ts:34](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L34)
+
+___
+
+### TWalletDataKeys
+
+Ƭ **TWalletDataKeys**: keyof [`IWalletData`](interfaces/IWalletData.md)
+
+#### Defined in
+
+[types/wallet.ts:171](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L171)
+
+## Variables
+
+### defaultElectrumPorts
+
+• `Const` **defaultElectrumPorts**: `string`[]
+
+#### Defined in
+
+[utils/electrum.ts:14](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/electrum.ts#L14)
+
+___
+
+### electrumConnection
+
+• `Const` **electrumConnection**: [`ElectrumConnectionPubSub`](README.md#electrumconnectionpubsub)
+
+Background task that checks the connection to the Electrum server with a PubSub
+If connection was lost this will try to reconnect in the specified interval
+
+**`Param`**
+
+#### Defined in
+
+[utils/electrum.ts:133](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/electrum.ts#L133)
+
+___
+
+### mostUsedExchangeTickers
+
+• `Const` **mostUsedExchangeTickers**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `CAD` | \{ `currencySymbol`: `string` = '$'; `quote`: `string` = 'CAD'; `quoteName`: `string` = 'Canadian Dollar' } |
+| `CAD.currencySymbol` | `string` |
+| `CAD.quote` | `string` |
+| `CAD.quoteName` | `string` |
+| `CNY` | \{ `currencySymbol`: `string` = '¥'; `quote`: `string` = 'CNY'; `quoteName`: `string` = 'Chinese Yuan Renminbi' } |
+| `CNY.currencySymbol` | `string` |
+| `CNY.quote` | `string` |
+| `CNY.quoteName` | `string` |
+| `EUR` | \{ `currencySymbol`: `string` = '€'; `quote`: `string` = 'EUR'; `quoteName`: `string` = 'Euro' } |
+| `EUR.currencySymbol` | `string` |
+| `EUR.quote` | `string` |
+| `EUR.quoteName` | `string` |
+| `GBP` | \{ `currencySymbol`: `string` = '£'; `quote`: `string` = 'GBP'; `quoteName`: `string` = 'Great British Pound' } |
+| `GBP.currencySymbol` | `string` |
+| `GBP.quote` | `string` |
+| `GBP.quoteName` | `string` |
+| `USD` | \{ `currencySymbol`: `string` = '$'; `quote`: `string` = 'USD'; `quoteName`: `string` = 'US Dollar' } |
+| `USD.currencySymbol` | `string` |
+| `USD.quote` | `string` |
+| `USD.quoteName` | `string` |
+
+#### Defined in
+
+[utils/exchange-rate.ts:5](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/exchange-rate.ts#L5)
+
+## Functions
+
+### availableNetworks
+
+▸ **availableNetworks**(): [`EAvailableNetworks`](enums/EAvailableNetworks.md)[]
+
+Returns an array of all available networks from the networks object.
+
+#### Returns
+
+[`EAvailableNetworks`](enums/EAvailableNetworks.md)[]
+
+#### Defined in
+
+[utils/wallet.ts:207](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L207)
+
+___
+
+### constructByteCountParam
+
+▸ **constructByteCountParam**(`addresses`, `increaseAddressCount?`): [`TGetByteCountInputs`](README.md#tgetbytecountinputs) \| [`TGetByteCountOutputs`](README.md#tgetbytecountoutputs)
+
+Constructs the parameter for getByteCount via an array of addresses.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `addresses` | `string`[] | `undefined` |
+| `increaseAddressCount` | \{ `addrType`: [`EAddressType`](enums/EAddressType.md) ; `count`: `number`  }[] | `[]` |
+
+#### Returns
+
+[`TGetByteCountInputs`](README.md#tgetbytecountinputs) \| [`TGetByteCountOutputs`](README.md#tgetbytecountoutputs)
+
+y
+
+#### Defined in
+
+[utils/transaction.ts:147](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/transaction.ts#L147)
+
+___
+
+### decodeOpReturnMessage
+
+▸ **decodeOpReturnMessage**(`opReturn?`): `string`[]
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `opReturn` | `string` | `''` |
+
+#### Returns
+
+`string`[]
+
+#### Defined in
+
+[utils/wallet.ts:262](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L262)
+
+___
+
+### decodeRawTransaction
+
+▸ **decodeRawTransaction**(`hex`, `_network?`): [`Result`](README.md#result)\<[`TDecodeRawTx`](README.md#tdecoderawtx)\>
+
+Attempts to decode a raw tx hex.
+Source: https://github.com/bitcoinjs/bitcoinjs-lib/issues/1606#issuecomment-664740672
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `hex` | `string` |
+| `_network?` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Returns
+
+[`Result`](README.md#result)\<[`TDecodeRawTx`](README.md#tdecoderawtx)\>
+
+#### Defined in
+
+[utils/transaction.ts:373](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/transaction.ts#L373)
+
+___
+
+### err
+
+▸ **err**\<`T`\>(`error`): `Err`\<`T`\>
+
+Construct a new Err result value.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | `string` \| `Error` | The error message or Error object to be wrapped in an Err result. |
+
+#### Returns
+
+`Err`\<`T`\>
+
+An Err result containing the given error.
+
+#### Defined in
+
+[utils/result.ts:74](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/result.ts#L74)
+
+___
+
+### formatKeyDerivationPath
+
+▸ **formatKeyDerivationPath**(`«destructured»`): [`Result`](README.md#result)\<[`IKeyDerivationPathData`](interfaces/IKeyDerivationPathData.md)\>
+
+Formats and returns the provided derivation path string and object.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `addressType?` | [`EAddressType`](enums/EAddressType.md) |
+| › `changeAddress?` | `boolean` |
+| › `index?` | `string` |
+| › `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+| › `path` | `string` \| [`IKeyDerivationPath`](interfaces/IKeyDerivationPath.md) |
+| › `purpose?` | `string` |
+
+#### Returns
+
+[`Result`](README.md#result)\<[`IKeyDerivationPathData`](interfaces/IKeyDerivationPathData.md)\>
+
+Derivation Path Data
+
+#### Defined in
+
+[utils/wallet.ts:75](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L75)
+
+___
+
+### formatPeerData
+
+▸ **formatPeerData**(`data`): [`Result`](README.md#result)\<[`IFormattedPeerData`](interfaces/IFormattedPeerData.md)\>
+
+Formats the peer data response from an Electrum server.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | [`string`, `string`, [`string`, `string`, `string`]] |
+
+#### Returns
+
+[`Result`](README.md#result)\<[`IFormattedPeerData`](interfaces/IFormattedPeerData.md)\>
+
+Result<IFormattedPeerData>
+
+#### Defined in
+
+[utils/electrum.ts:59](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/electrum.ts#L59)
+
+___
+
+### generateMnemonic
+
+▸ **generateMnemonic**(`strength?`, `rng?`, `wordlist?`): `string`
+
+Extends bip39's generateMnemonic function.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `strength?` | `number` |
+| `rng?` | (`size`: `number`) => `Buffer` |
+| `wordlist?` | `string`[] |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils/helpers.ts:150](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/helpers.ts#L150)
+
+___
+
+### generateWalletId
+
+▸ **generateWalletId**(`seed`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `seed` | `Buffer` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils/wallet.ts:310](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L310)
+
+___
+
+### getAddressFromScriptPubKey
+
+▸ **getAddressFromScriptPubKey**(`scriptPubKey`, `selectedNetwork`): `string`
+
+Get address for a given scriptPubKey.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `scriptPubKey` | `string` |
+| `selectedNetwork` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils/helpers.ts:16](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/helpers.ts#L16)
+
+___
+
+### getAddressTypeFromPath
+
+▸ **getAddressTypeFromPath**(`path`): [`Result`](README.md#result)\<[`EAddressType`](enums/EAddressType.md)\>
+
+Returns the address type from the specified derivation path.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` \| [`IKeyDerivationPath`](interfaces/IKeyDerivationPath.md) |
+
+#### Returns
+
+[`Result`](README.md#result)\<[`EAddressType`](enums/EAddressType.md)\>
+
+#### Defined in
+
+[utils/derivation-path.ts:147](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/derivation-path.ts#L147)
+
+___
+
+### getByteCount
+
+▸ **getByteCount**(`inputs`, `outputs`, `message?`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `inputs` | [`TGetByteCountInputs`](README.md#tgetbytecountinputs) |
+| `outputs` | [`TGetByteCountOutputs`](README.md#tgetbytecountoutputs) |
+| `message?` | `string` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[utils/transaction.ts:181](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/transaction.ts#L181)
+
+___
+
+### getDataFallback
+
+▸ **getDataFallback**\<`K`\>(`key`): `Promise`\<[`Result`](README.md#result)\<[`IWalletData`](interfaces/IWalletData.md)[`K`]\>\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `K` | extends keyof [`IWalletData`](interfaces/IWalletData.md) |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+
+#### Returns
+
+`Promise`\<[`Result`](README.md#result)\<[`IWalletData`](interfaces/IWalletData.md)[`K`]\>\>
+
+#### Defined in
+
+[types/wallet.ts:173](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L173)
+
+___
+
+### getDefaultPort
+
+▸ **getDefaultPort**(`selectedNetwork?`, `protocol?`): `number`
+
+Returns the default port for the given network and protocol.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `selectedNetwork?` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+| `protocol?` | [`TProtocol`](README.md#tprotocol) |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[utils/electrum.ts:22](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/electrum.ts#L22)
+
+___
+
+### getDefaultWalletData
+
+▸ **getDefaultWalletData**(): [`IWalletData`](interfaces/IWalletData.md)
+
+Returns the default wallet data object.
+
+#### Returns
+
+[`IWalletData`](interfaces/IWalletData.md)
+
+#### Defined in
+
+[utils/wallet.ts:34](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L34)
+
+___
+
+### getDefaultWalletDataKeys
+
+▸ **getDefaultWalletDataKeys**(): keyof [`IWalletData`](interfaces/IWalletData.md)[]
+
+Returns the keys from the default wallet data object.
+
+#### Returns
+
+keyof [`IWalletData`](interfaces/IWalletData.md)[]
+
+#### Defined in
+
+[utils/wallet.ts:42](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L42)
+
+___
+
+### getExchangeRates
+
+▸ **getExchangeRates**(): `Promise`\<[`Result`](README.md#result)\<[`IExchangeRates`](interfaces/IExchangeRates.md)\>\>
+
+Returns the exchange rate for the given currency
+
+#### Returns
+
+`Promise`\<[`Result`](README.md#result)\<[`IExchangeRates`](interfaces/IExchangeRates.md)\>\>
+
+#### Defined in
+
+[utils/exchange-rate.ts:45](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/exchange-rate.ts#L45)
+
+___
+
+### getHighestUsedIndexFromTxHashes
+
+▸ **getHighestUsedIndexFromTxHashes**(`«destructured»`): [`Result`](README.md#result)\<[`IIndexes`](interfaces/IIndexes.md)\>
+
+Returns the highest used index from the provided txHashes.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `addressIndex` | [`IAddress`](interfaces/IAddress.md) |
+| › `addresses` | [`IAddresses`](interfaces/IAddresses.md) |
+| › `changeAddressIndex` | [`IAddress`](interfaces/IAddress.md) |
+| › `changeAddresses` | [`IAddresses`](interfaces/IAddresses.md) |
+| › `txHashes` | [`ITxHashes`](interfaces/ITxHashes.md)[] |
+
+#### Returns
+
+[`Result`](README.md#result)\<[`IIndexes`](interfaces/IIndexes.md)\>
+
+#### Defined in
+
+[utils/wallet.ts:133](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L133)
+
+___
+
+### getKeyDerivationPath
+
+▸ **getKeyDerivationPath**(`«destructured»`): [`Result`](README.md#result)\<[`IKeyDerivationPath`](interfaces/IKeyDerivationPath.md)\>
+
+Returns the derivation path object for the specified addressType and network.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `addressType` | [`EAddressType`](enums/EAddressType.md) |
+| › `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Returns
+
+[`Result`](README.md#result)\<[`IKeyDerivationPath`](interfaces/IKeyDerivationPath.md)\>
+
+Result<IKeyDerivationPath>
+
+#### Defined in
+
+[utils/helpers.ts:98](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/helpers.ts#L98)
+
+___
+
+### getKeyDerivationPathObject
+
+▸ **getKeyDerivationPathObject**(`«destructured»`): [`Result`](README.md#result)\<[`IKeyDerivationPath`](interfaces/IKeyDerivationPath.md)\>
+
+Parses a key derivation path in string format Ex: "m/84'/0'/0'/0/0" and returns IKeyDerivationPath.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `changeAddress?` | `boolean` |
+| › `index?` | `string` |
+| › `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+| › `path` | `string` |
+| › `purpose?` | `string` |
+
+#### Returns
+
+[`Result`](README.md#result)\<[`IKeyDerivationPath`](interfaces/IKeyDerivationPath.md)\>
+
+#### Defined in
+
+[utils/derivation-path.ts:22](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/derivation-path.ts#L22)
+
+___
+
+### getKeyDerivationPathString
+
+▸ **getKeyDerivationPathString**(`«destructured»`): [`Result`](README.md#result)\<`string`\>
+
+Parses a key derivation path object and returns it in string format. Ex: "m/84'/0'/0'/0/0"
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `accountType?` | `string` \| `number` |
+| › `addressType` | [`EAddressType`](enums/EAddressType.md) |
+| › `changeAddress?` | `boolean` |
+| › `index?` | `string` \| `number` |
+| › `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+| › `path?` | [`IKeyDerivationPath`](interfaces/IKeyDerivationPath.md) |
+| › `purpose?` | `string` |
+
+#### Returns
+
+[`Result`](README.md#result)\<`string`\>
+
+#### Defined in
+
+[utils/derivation-path.ts:80](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/derivation-path.ts#L80)
+
+___
+
+### getKeyValue
+
+▸ **getKeyValue**(`key`): `string`
+
+Returns last value between hyphens in a string.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `key` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils/wallet.ts:51](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L51)
+
+___
+
+### getPeers
+
+▸ **getPeers**(`selectedNetwork?`): `Promise`\<[`Result`](README.md#result)\<[`IFormattedPeerData`](interfaces/IFormattedPeerData.md)[]\>\>
+
+Returns an array of peers.
+If unable to acquire peers from an Electrum server the method will default to the hardcoded peers in peers.json.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `selectedNetwork?` | `Object` |
+| `selectedNetwork.selectedNetwork` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Returns
+
+`Promise`\<[`Result`](README.md#result)\<[`IFormattedPeerData`](interfaces/IFormattedPeerData.md)[]\>\>
+
+Promise<Result<IFormattedPeerData[]>>
+
+#### Defined in
+
+[utils/electrum.ts:95](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/electrum.ts#L95)
+
+___
+
+### getProtocolForPort
+
+▸ **getProtocolForPort**(`port?`, `network?`): `undefined` \| [`TProtocol`](README.md#tprotocol)
+
+Returns the protocol for the given network and default port.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `port?` | `string` |
+| `network?` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Returns
+
+`undefined` \| [`TProtocol`](README.md#tprotocol)
+
+#### Defined in
+
+[utils/electrum.ts:39](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/electrum.ts#L39)
+
+___
+
+### getScriptHash
+
+▸ **getScriptHash**(`«destructured»`): `string`
+
+Get scriptHash for a given address
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `address` | `string` |
+| › `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils/helpers.ts:125](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/helpers.ts#L125)
+
+___
+
+### getSeed
+
+▸ **getSeed**(`mnemonic`, `bip39Passphrase`): `Buffer`
+
+Returns the seed for a given mnemonic and passphrase.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mnemonic` | `any` |
+| `bip39Passphrase` | `any` |
+
+#### Returns
+
+`Buffer`
+
+#### Defined in
+
+[utils/wallet.ts:295](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L295)
+
+___
+
+### getSeedHash
+
+▸ **getSeedHash**(`seed`): `string`
+
+Returns the seed hash for a given mnemonic and passphrase.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `seed` | `Buffer` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils/wallet.ts:304](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L304)
+
+___
+
+### getSha256
+
+▸ **getSha256**(`str`): `string`
+
+Get sha256 hash of a given string.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `str` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils/helpers.ts:32](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/helpers.ts#L32)
+
+___
+
+### getStorageKeyValues
+
+▸ **getStorageKeyValues**(`storageKey`): `Object`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `storageKey` | `string` |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+| `value` | keyof [`IWalletData`](interfaces/IWalletData.md) |
+| `walletName` | `string` |
+
+#### Defined in
+
+[utils/wallet.ts:324](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L324)
+
+___
+
+### getTxFee
+
+▸ **getTxFee**(`«destructured»`): `number`
+
+Returns the total fee in sats for a transaction at a given size (transactionByteCount) times the desired satsPerByte.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `satsPerByte` | `number` |
+| › `transactionByteCount` | `number` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[utils/wallet.ts:345](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L345)
+
+___
+
+### getWalletDataStorageKey
+
+▸ **getWalletDataStorageKey**(`name`, `network`, `key`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+| `key` | keyof [`IWalletData`](interfaces/IWalletData.md) |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[utils/wallet.ts:316](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L316)
+
+___
+
+### isValidBech32mEncodedString
+
+▸ **isValidBech32mEncodedString**(`address`): `Object`
+
+Returns if the provided string is a valid Bech32m encoded string (taproot/p2tr address).
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `address` | `string` |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `isValid` | `boolean` |
+| `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Defined in
+
+[utils/wallet.ts:185](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L185)
+
+___
+
+### objectKeys
+
+▸ **objectKeys**\<`Type`\>(`value`): \`$\{Exclude\<keyof Type, symbol\>}\`[]
+
+Returns the keys of a given object.
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Type` | extends `object` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `value` | `Type` |
+
+#### Returns
+
+\`$\{Exclude\<keyof Type, symbol\>}\`[]
+
+#### Defined in
+
+[utils/wallet.ts:62](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L62)
+
+___
+
+### objectsMatch
+
+▸ **objectsMatch**(`obj1`, `obj2`): `boolean`
+
+Determines if the two objects passed as params match.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `obj1` | `any` |
+| `obj2` | `any` |
+
+#### Returns
+
+`boolean`
+
+boolean
+
+#### Defined in
+
+[utils/helpers.ts:177](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/helpers.ts#L177)
+
+___
+
+### ok
+
+▸ **ok**\<`T`\>(`value`): `Ok`\<`T`\>
+
+Construct a new Ok result value.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `T` | The value to be wrapped in an Ok result. |
+
+#### Returns
+
+`Ok`\<`T`\>
+
+An Ok result containing the given value.
+
+#### Defined in
+
+[utils/result.ts:67](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/result.ts#L67)
+
+___
+
+### parseOnChainPaymentRequest
+
+▸ **parseOnChainPaymentRequest**(`data`, `network?`): [`Result`](README.md#result)\<\{ `address`: `string` ; `message`: `string` ; `network`: [`EAvailableNetworks`](enums/EAvailableNetworks.md) ; `sats`: `number`  }\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `string` |
+| `network?` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Returns
+
+[`Result`](README.md#result)\<\{ `address`: `string` ; `message`: `string` ; `network`: [`EAvailableNetworks`](enums/EAvailableNetworks.md) ; `sats`: `number`  }\>
+
+#### Defined in
+
+[utils/transaction.ts:64](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/transaction.ts#L64)
+
+___
+
+### reduceValue
+
+▸ **reduceValue**\<`T`\>(`«destructured»`): [`Result`](README.md#result)\<`number`\>
+
+Sum a specific value in an array of objects.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `arr` | `T`[] |
+| › `value` | keyof `T` |
+
+#### Returns
+
+[`Result`](README.md#result)\<`number`\>
+
+#### Defined in
+
+[utils/wallet.ts:216](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L216)
+
+___
+
+### removeDustOutputs
+
+▸ **removeDustOutputs**(`outputs`): [`IOutput`](interfaces/IOutput.md)[]
+
+Removes outputs that are below the dust limit.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `outputs` | [`IOutput`](interfaces/IOutput.md)[] |
+
+#### Returns
+
+[`IOutput`](interfaces/IOutput.md)[]
+
+#### Defined in
+
+[utils/transaction.ts:293](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/transaction.ts#L293)
+
+___
+
+### setReplaceByFee
+
+▸ **setReplaceByFee**(`«destructured»`): `void`
+
+Sets RBF for the provided psbt.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `psbt` | `Psbt` |
+| › `setRbf` | `boolean` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[utils/transaction.ts:28](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/transaction.ts#L28)
+
+___
+
+### shuffleArray
+
+▸ **shuffleArray**\<`T`\>(`array`): `T`[]
+
+Shuffles a given array.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `array` | `T`[] |
+
+#### Returns
+
+`T`[]
+
+#### Defined in
+
+[utils/wallet.ts:242](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/wallet.ts#L242)
+
+___
+
+### validateAddress
+
+▸ **validateAddress**(`«destructured»`): `Object`
+
+Validate address for a given network.
+If no address is provided, it will attempt to validate the address for all available networks.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `address` | `string` |
+| › `network?` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `isValid` | `boolean` |
+| `network` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
+
+#### Defined in
+
+[utils/helpers.ts:45](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/helpers.ts#L45)
+
+___
+
+### validateMnemonic
+
+▸ **validateMnemonic**(`mnemonic?`): `boolean`
+
+Attempts to validate the provided mnemonic.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `mnemonic` | `string` | `''` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[utils/helpers.ts:163](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/helpers.ts#L163)
+
+___
+
+### validateTransaction
+
+▸ **validateTransaction**(`transaction`): [`Result`](README.md#result)\<`string`\>
+
+Used to validate transaction form data.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `transaction` | [`ISendTransaction`](interfaces/ISendTransaction.md) |
+
+#### Returns
+
+[`Result`](README.md#result)\<`string`\>
+
+#### Defined in
+
+[utils/transaction.ts:304](https://github.com/synonymdev/beignet/blob/7c83290/src/utils/transaction.ts#L304)