beignet 0.0.21 → 0.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (273) hide show
  1. package/dist/electrum/index.js +105 -42
  2. package/dist/electrum/index.js.map +1 -1
  3. package/dist/types/electrum/index.d.ts +11 -4
  4. package/dist/types/electrum.js +8 -1
  5. package/dist/types/electrum.js.map +1 -1
  6. package/dist/types/types/electrum.d.ts +6 -0
  7. package/dist/types/types/transaction.d.ts +4 -0
  8. package/dist/types/types/wallet.d.ts +7 -1
  9. package/dist/types/utils/helpers.d.ts +2 -0
  10. package/dist/types/utils/wallet.d.ts +19 -1
  11. package/dist/types/wallet/constants.d.ts +0 -5
  12. package/dist/types/wallet/index.d.ts +14 -3
  13. package/dist/types/wallet.js.map +1 -1
  14. package/dist/utils/helpers.js +11 -1
  15. package/dist/utils/helpers.js.map +1 -1
  16. package/dist/utils/wallet.js +48 -1
  17. package/dist/utils/wallet.js.map +1 -1
  18. package/dist/wallet/constants.js +1 -7
  19. package/dist/wallet/constants.js.map +1 -1
  20. package/dist/wallet/index.js +181 -86
  21. package/dist/wallet/index.js.map +1 -1
  22. package/docs/html/assets/search.js +1 -1
  23. package/docs/html/classes/Electrum.html +79 -70
  24. package/docs/html/classes/Transaction.html +59 -28
  25. package/docs/html/classes/Wallet.html +224 -174
  26. package/docs/html/enums/EAddressType.html +22 -7
  27. package/docs/html/enums/EAvailableNetworks.html +19 -11
  28. package/docs/html/enums/EBoostType.html +14 -6
  29. package/docs/html/enums/EElectrumNetworks.html +15 -7
  30. package/docs/html/enums/EFeeId.html +17 -9
  31. package/docs/html/enums/EPaymentType.html +14 -6
  32. package/docs/html/enums/EProtocol.html +14 -6
  33. package/docs/html/enums/EUnit.html +15 -7
  34. package/docs/html/functions/availableNetworks.html +12 -4
  35. package/docs/html/functions/constructByteCountParam.html +12 -4
  36. package/docs/html/functions/decodeOpReturnMessage.html +12 -4
  37. package/docs/html/functions/decodeRawTransaction.html +12 -4
  38. package/docs/html/functions/err.html +12 -4
  39. package/docs/html/functions/formatKeyDerivationPath.html +12 -4
  40. package/docs/html/functions/formatPeerData.html +12 -4
  41. package/docs/html/functions/generateMnemonic.html +12 -4
  42. package/docs/html/functions/generateWalletId.html +12 -4
  43. package/docs/html/functions/getAddressFromKeyPair.html +222 -0
  44. package/docs/html/functions/getAddressFromScriptPubKey.html +12 -4
  45. package/docs/html/functions/getAddressTypeFromPath.html +12 -4
  46. package/docs/html/functions/getAddressesFromPrivateKey.html +222 -0
  47. package/docs/html/functions/getByteCount.html +12 -4
  48. package/docs/html/functions/getDataFallback.html +12 -4
  49. package/docs/html/functions/getDefaultPort.html +12 -4
  50. package/docs/html/functions/getDefaultWalletData.html +12 -4
  51. package/docs/html/functions/getDefaultWalletDataKeys.html +12 -4
  52. package/docs/html/functions/getElectrumNetwork.html +216 -0
  53. package/docs/html/functions/getHighestUsedIndexFromTxHashes.html +12 -4
  54. package/docs/html/functions/getKeyDerivationPath.html +12 -4
  55. package/docs/html/functions/getKeyDerivationPathObject.html +12 -4
  56. package/docs/html/functions/getKeyDerivationPathString.html +12 -4
  57. package/docs/html/functions/getKeyValue.html +12 -4
  58. package/docs/html/functions/getPeers.html +12 -4
  59. package/docs/html/functions/getProtocolForPort.html +12 -4
  60. package/docs/html/functions/getScriptHash.html +12 -4
  61. package/docs/html/functions/getSeed.html +12 -4
  62. package/docs/html/functions/getSeedHash.html +12 -4
  63. package/docs/html/functions/getSha256.html +12 -4
  64. package/docs/html/functions/getStorageKeyValues.html +12 -4
  65. package/docs/html/{variables/mostUsedExchangeTickers.html → functions/getTapRootAddressFromPublicKey.html} +74 -97
  66. package/docs/html/functions/getTxFee.html +12 -4
  67. package/docs/html/functions/getWalletDataStorageKey.html +12 -4
  68. package/docs/html/functions/isP2trPrefix.html +217 -0
  69. package/docs/html/functions/isValidBech32mEncodedString.html +12 -4
  70. package/docs/html/functions/objectKeys-1.html +12 -4
  71. package/docs/html/functions/objectsMatch.html +12 -4
  72. package/docs/html/functions/ok.html +12 -4
  73. package/docs/html/functions/parseOnChainPaymentRequest.html +12 -4
  74. package/docs/html/functions/reduceValue.html +12 -4
  75. package/docs/html/functions/removeDustOutputs.html +12 -4
  76. package/docs/html/functions/setReplaceByFee.html +12 -4
  77. package/docs/html/functions/shuffleArray.html +12 -4
  78. package/docs/html/functions/{getExchangeRates.html → sleep.html} +22 -12
  79. package/docs/html/functions/validateAddress.html +12 -4
  80. package/docs/html/functions/validateMnemonic.html +12 -4
  81. package/docs/html/functions/validateTransaction.html +12 -4
  82. package/docs/html/index.html +22 -6
  83. package/docs/html/interfaces/IAddInput.html +16 -8
  84. package/docs/html/interfaces/IAddress.html +17 -9
  85. package/docs/html/interfaces/IAddressData.html +15 -7
  86. package/docs/html/interfaces/IAddressType.html +12 -4
  87. package/docs/html/interfaces/IAddressTypeData.html +18 -10
  88. package/docs/html/interfaces/IAddresses.html +12 -4
  89. package/docs/html/interfaces/IBoostedTransaction.html +16 -8
  90. package/docs/html/interfaces/IBoostedTransactions.html +12 -4
  91. package/docs/html/interfaces/ICreateTransaction.html +14 -6
  92. package/docs/html/interfaces/ICustomGetAddress.html +15 -7
  93. package/docs/html/interfaces/ICustomGetScriptHash.html +14 -6
  94. package/docs/html/interfaces/IElectrumGetAddressBalanceRes.html +15 -7
  95. package/docs/html/interfaces/IFormattedPeerData.html +17 -9
  96. package/docs/html/interfaces/IFormattedTransaction.html +31 -23
  97. package/docs/html/interfaces/IFormattedTransactions.html +12 -4
  98. package/docs/html/interfaces/IGenerateAddresses.html +19 -11
  99. package/docs/html/interfaces/IGenerateAddressesResponse.html +14 -6
  100. package/docs/html/interfaces/IGetAddress.html +15 -7
  101. package/docs/html/interfaces/IGetAddressBalanceRes.html +14 -6
  102. package/docs/html/interfaces/IGetAddressByPath.html +14 -6
  103. package/docs/html/interfaces/IGetAddressHistoryResponse.html +19 -11
  104. package/docs/html/interfaces/IGetAddressResponse.html +15 -7
  105. package/docs/html/interfaces/IGetAddressScriptHashBalances.html +17 -9
  106. package/docs/html/interfaces/IGetAddressScriptHashesHistoryResponse.html +17 -9
  107. package/docs/html/interfaces/{IExchangeRates.html → IGetAddressesFromKeyPair.html} +45 -23
  108. package/docs/html/interfaces/IGetAddressesFromPrivateKey.html +234 -0
  109. package/docs/html/interfaces/IGetDerivationPath.html +18 -10
  110. package/docs/html/interfaces/IGetFeeEstimatesResponse.html +16 -8
  111. package/docs/html/interfaces/IGetHeaderResponse.html +17 -9
  112. package/docs/html/interfaces/IGetNextAvailableAddressResponse.html +16 -8
  113. package/docs/html/interfaces/IGetTransactions.html +17 -9
  114. package/docs/html/interfaces/IGetTransactionsFromInputs.html +17 -9
  115. package/docs/html/interfaces/IGetUtxosResponse.html +14 -6
  116. package/docs/html/interfaces/IHeader.html +15 -7
  117. package/docs/html/interfaces/IIndexes.html +16 -8
  118. package/docs/html/interfaces/IKeyDerivationPath.html +17 -9
  119. package/docs/html/interfaces/IKeyDerivationPathData.html +14 -6
  120. package/docs/html/interfaces/INewBlock.html +14 -6
  121. package/docs/html/interfaces/IOnchainFees.html +17 -9
  122. package/docs/html/interfaces/IOutput.html +15 -7
  123. package/docs/html/interfaces/IPeerData.html +15 -7
  124. package/docs/html/interfaces/IPrivateKeyInfo.html +248 -0
  125. package/docs/html/interfaces/IRbfData.html +18 -10
  126. package/docs/html/interfaces/ISend.html +14 -6
  127. package/docs/html/interfaces/ISendTransaction.html +28 -20
  128. package/docs/html/interfaces/ISendTx.html +15 -7
  129. package/docs/html/interfaces/ISetupTransaction.html +17 -9
  130. package/docs/html/interfaces/ISubscribeToAddress.html +16 -8
  131. package/docs/html/interfaces/ISubscribeToHeader.html +16 -8
  132. package/docs/html/interfaces/ISweepPrivateKey.html +255 -0
  133. package/docs/html/interfaces/ISweepPrivateKeyRes.html +241 -0
  134. package/docs/html/interfaces/ITargets.html +16 -8
  135. package/docs/html/interfaces/ITransaction.html +17 -9
  136. package/docs/html/interfaces/ITxHash.html +13 -5
  137. package/docs/html/interfaces/ITxHashes.html +15 -7
  138. package/docs/html/interfaces/IUtxo.html +27 -21
  139. package/docs/html/interfaces/IVin.html +17 -9
  140. package/docs/html/interfaces/IVout.html +15 -7
  141. package/docs/html/interfaces/IWallet.html +53 -20
  142. package/docs/html/interfaces/IWalletData.html +30 -29
  143. package/docs/html/types/ElectrumConnectionPubSub.html +12 -4
  144. package/docs/html/types/ElectrumConnectionSubscription.html +13 -5
  145. package/docs/html/types/InputData.html +12 -4
  146. package/docs/html/types/ObjectKeys.html +12 -4
  147. package/docs/html/types/Result.html +12 -4
  148. package/docs/html/types/TAddressIndexInfo.html +12 -4
  149. package/docs/html/types/TAddressLabel.html +12 -4
  150. package/docs/html/types/TAddressType.html +12 -4
  151. package/docs/html/types/TAddressTypeContent.html +12 -4
  152. package/docs/html/types/TAddressTypes.html +12 -4
  153. package/docs/html/types/TAvailableNetworks.html +12 -4
  154. package/docs/html/types/TConnectToElectrumRes.html +12 -4
  155. package/docs/html/types/TDecodeRawTx.html +12 -4
  156. package/docs/html/types/TElectrumNetworks.html +12 -4
  157. package/docs/html/types/TGetAddressHistory.html +12 -4
  158. package/docs/html/types/TGetByteCountInput.html +12 -4
  159. package/docs/html/types/TGetByteCountInputs.html +12 -4
  160. package/docs/html/types/TGetByteCountOutput.html +12 -4
  161. package/docs/html/types/TGetByteCountOutputs.html +12 -4
  162. package/docs/html/types/TGetData.html +12 -4
  163. package/docs/html/types/TGetTotalFeeObj.html +12 -4
  164. package/docs/html/types/TKeyDerivationAccount.html +12 -4
  165. package/docs/html/types/TKeyDerivationChange.html +12 -4
  166. package/docs/html/types/TKeyDerivationCoinType.html +12 -4
  167. package/docs/html/types/TKeyDerivationIndex.html +12 -4
  168. package/docs/html/types/TKeyDerivationPurpose.html +12 -4
  169. package/docs/html/types/TMessageDataMap.html +12 -4
  170. package/docs/html/types/TMessageKeys.html +12 -4
  171. package/docs/html/types/TOnMessage.html +12 -4
  172. package/docs/html/types/TProcessUnconfirmedTransactions.html +12 -4
  173. package/docs/html/types/TProtocol.html +12 -4
  174. package/docs/html/types/TServer.html +12 -4
  175. package/docs/html/types/TSetData.html +12 -4
  176. package/docs/html/types/TSetupTransactionResponse.html +12 -4
  177. package/docs/html/types/TStorage.html +12 -4
  178. package/docs/html/types/TSubscribedReceive.html +12 -4
  179. package/docs/html/types/TTransactionMessage.html +12 -4
  180. package/docs/html/types/TTxResponse.html +12 -4
  181. package/docs/html/types/TTxResult.html +12 -4
  182. package/docs/html/types/TUnspentAddressScriptHashData.html +12 -4
  183. package/docs/html/types/TWalletDataKeys.html +12 -4
  184. package/docs/html/variables/defaultElectrumPorts.html +12 -4
  185. package/docs/html/variables/electrumConnection.html +12 -4
  186. package/docs/markdown/README.md +224 -128
  187. package/docs/markdown/classes/Electrum.md +74 -72
  188. package/docs/markdown/classes/Transaction.md +48 -23
  189. package/docs/markdown/classes/Wallet.md +240 -181
  190. package/docs/markdown/enums/EAddressType.md +14 -3
  191. package/docs/markdown/enums/EAvailableNetworks.md +7 -7
  192. package/docs/markdown/enums/EBoostType.md +2 -2
  193. package/docs/markdown/enums/EElectrumNetworks.md +3 -3
  194. package/docs/markdown/enums/EFeeId.md +5 -5
  195. package/docs/markdown/enums/EPaymentType.md +2 -2
  196. package/docs/markdown/enums/EProtocol.md +2 -2
  197. package/docs/markdown/enums/EUnit.md +3 -3
  198. package/docs/markdown/interfaces/IAddInput.md +4 -4
  199. package/docs/markdown/interfaces/IAddress.md +5 -5
  200. package/docs/markdown/interfaces/IAddressData.md +3 -3
  201. package/docs/markdown/interfaces/IAddressTypeData.md +6 -6
  202. package/docs/markdown/interfaces/IBoostedTransaction.md +4 -4
  203. package/docs/markdown/interfaces/ICreateTransaction.md +2 -2
  204. package/docs/markdown/interfaces/ICustomGetAddress.md +3 -3
  205. package/docs/markdown/interfaces/ICustomGetScriptHash.md +2 -2
  206. package/docs/markdown/interfaces/IElectrumGetAddressBalanceRes.md +3 -3
  207. package/docs/markdown/interfaces/IFormattedPeerData.md +5 -5
  208. package/docs/markdown/interfaces/IFormattedTransaction.md +19 -19
  209. package/docs/markdown/interfaces/IGenerateAddresses.md +7 -7
  210. package/docs/markdown/interfaces/IGenerateAddressesResponse.md +2 -2
  211. package/docs/markdown/interfaces/IGetAddress.md +3 -3
  212. package/docs/markdown/interfaces/IGetAddressBalanceRes.md +2 -2
  213. package/docs/markdown/interfaces/IGetAddressByPath.md +2 -2
  214. package/docs/markdown/interfaces/IGetAddressHistoryResponse.md +7 -7
  215. package/docs/markdown/interfaces/IGetAddressResponse.md +3 -3
  216. package/docs/markdown/interfaces/IGetAddressScriptHashBalances.md +5 -5
  217. package/docs/markdown/interfaces/IGetAddressScriptHashesHistoryResponse.md +5 -5
  218. package/docs/markdown/interfaces/IGetAddressesFromKeyPair.md +30 -0
  219. package/docs/markdown/interfaces/IGetAddressesFromPrivateKey.md +30 -0
  220. package/docs/markdown/interfaces/IGetDerivationPath.md +6 -6
  221. package/docs/markdown/interfaces/IGetFeeEstimatesResponse.md +4 -4
  222. package/docs/markdown/interfaces/IGetHeaderResponse.md +5 -5
  223. package/docs/markdown/interfaces/IGetNextAvailableAddressResponse.md +4 -4
  224. package/docs/markdown/interfaces/IGetTransactions.md +5 -5
  225. package/docs/markdown/interfaces/IGetTransactionsFromInputs.md +5 -5
  226. package/docs/markdown/interfaces/IGetUtxosResponse.md +2 -2
  227. package/docs/markdown/interfaces/IHeader.md +3 -3
  228. package/docs/markdown/interfaces/IIndexes.md +4 -4
  229. package/docs/markdown/interfaces/IKeyDerivationPath.md +5 -5
  230. package/docs/markdown/interfaces/IKeyDerivationPathData.md +2 -2
  231. package/docs/markdown/interfaces/INewBlock.md +2 -2
  232. package/docs/markdown/interfaces/IOnchainFees.md +5 -5
  233. package/docs/markdown/interfaces/IOutput.md +3 -3
  234. package/docs/markdown/interfaces/IPeerData.md +3 -3
  235. package/docs/markdown/interfaces/IPrivateKeyInfo.md +52 -0
  236. package/docs/markdown/interfaces/IRbfData.md +6 -6
  237. package/docs/markdown/interfaces/ISend.md +2 -2
  238. package/docs/markdown/interfaces/ISendTransaction.md +16 -16
  239. package/docs/markdown/interfaces/ISendTx.md +3 -3
  240. package/docs/markdown/interfaces/ISetupTransaction.md +5 -5
  241. package/docs/markdown/interfaces/ISubscribeToAddress.md +4 -4
  242. package/docs/markdown/interfaces/ISubscribeToHeader.md +4 -4
  243. package/docs/markdown/interfaces/ISweepPrivateKey.md +63 -0
  244. package/docs/markdown/interfaces/ISweepPrivateKeyRes.md +41 -0
  245. package/docs/markdown/interfaces/ITargets.md +4 -4
  246. package/docs/markdown/interfaces/ITransaction.md +5 -5
  247. package/docs/markdown/interfaces/ITxHash.md +1 -1
  248. package/docs/markdown/interfaces/ITxHashes.md +3 -3
  249. package/docs/markdown/interfaces/IUtxo.md +18 -23
  250. package/docs/markdown/interfaces/IVin.md +5 -5
  251. package/docs/markdown/interfaces/IVout.md +3 -3
  252. package/docs/markdown/interfaces/IWallet.md +50 -15
  253. package/docs/markdown/interfaces/IWalletData.md +18 -29
  254. package/package.json +3 -3
  255. package/src/electrum/index.ts +147 -60
  256. package/src/types/electrum.ts +7 -0
  257. package/src/types/transaction.ts +5 -0
  258. package/src/types/wallet.ts +7 -1
  259. package/src/utils/helpers.ts +14 -0
  260. package/src/utils/wallet.ts +73 -0
  261. package/src/wallet/constants.ts +0 -8
  262. package/src/wallet/index.ts +262 -118
  263. package/tests/wallet.test.ts +71 -1
  264. package/dist/mempool/index.js +0 -28
  265. package/dist/mempool/index.js.map +0 -1
  266. package/dist/types/mempool/index.d.ts +0 -15
  267. package/dist/types/mempool.js +0 -3
  268. package/dist/types/mempool.js.map +0 -1
  269. package/dist/types/types/mempool.d.ts +0 -16
  270. package/dist/types/utils/exchange-rate.d.ts +0 -30
  271. package/dist/utils/exchange-rate.js +0 -49
  272. package/dist/utils/exchange-rate.js.map +0 -1
  273. package/docs/markdown/interfaces/IExchangeRates.md +0 -7
@@ -35,7 +35,6 @@ beignet
35
35
  - [ICustomGetAddress](interfaces/ICustomGetAddress.md)
36
36
  - [ICustomGetScriptHash](interfaces/ICustomGetScriptHash.md)
37
37
  - [IElectrumGetAddressBalanceRes](interfaces/IElectrumGetAddressBalanceRes.md)
38
- - [IExchangeRates](interfaces/IExchangeRates.md)
39
38
  - [IFormattedPeerData](interfaces/IFormattedPeerData.md)
40
39
  - [IFormattedTransaction](interfaces/IFormattedTransaction.md)
41
40
  - [IFormattedTransactions](interfaces/IFormattedTransactions.md)
@@ -48,6 +47,8 @@ beignet
48
47
  - [IGetAddressResponse](interfaces/IGetAddressResponse.md)
49
48
  - [IGetAddressScriptHashBalances](interfaces/IGetAddressScriptHashBalances.md)
50
49
  - [IGetAddressScriptHashesHistoryResponse](interfaces/IGetAddressScriptHashesHistoryResponse.md)
50
+ - [IGetAddressesFromKeyPair](interfaces/IGetAddressesFromKeyPair.md)
51
+ - [IGetAddressesFromPrivateKey](interfaces/IGetAddressesFromPrivateKey.md)
51
52
  - [IGetDerivationPath](interfaces/IGetDerivationPath.md)
52
53
  - [IGetFeeEstimatesResponse](interfaces/IGetFeeEstimatesResponse.md)
53
54
  - [IGetHeaderResponse](interfaces/IGetHeaderResponse.md)
@@ -63,6 +64,7 @@ beignet
63
64
  - [IOnchainFees](interfaces/IOnchainFees.md)
64
65
  - [IOutput](interfaces/IOutput.md)
65
66
  - [IPeerData](interfaces/IPeerData.md)
67
+ - [IPrivateKeyInfo](interfaces/IPrivateKeyInfo.md)
66
68
  - [IRbfData](interfaces/IRbfData.md)
67
69
  - [ISend](interfaces/ISend.md)
68
70
  - [ISendTransaction](interfaces/ISendTransaction.md)
@@ -70,6 +72,8 @@ beignet
70
72
  - [ISetupTransaction](interfaces/ISetupTransaction.md)
71
73
  - [ISubscribeToAddress](interfaces/ISubscribeToAddress.md)
72
74
  - [ISubscribeToHeader](interfaces/ISubscribeToHeader.md)
75
+ - [ISweepPrivateKey](interfaces/ISweepPrivateKey.md)
76
+ - [ISweepPrivateKeyRes](interfaces/ISweepPrivateKeyRes.md)
73
77
  - [ITargets](interfaces/ITargets.md)
74
78
  - [ITransaction](interfaces/ITransaction.md)
75
79
  - [ITxHash](interfaces/ITxHash.md)
@@ -128,7 +132,6 @@ beignet
128
132
 
129
133
  - [defaultElectrumPorts](README.md#defaultelectrumports)
130
134
  - [electrumConnection](README.md#electrumconnection)
131
- - [mostUsedExchangeTickers](README.md#mostusedexchangetickers)
132
135
 
133
136
  ### Functions
134
137
 
@@ -141,14 +144,16 @@ beignet
141
144
  - [formatPeerData](README.md#formatpeerdata)
142
145
  - [generateMnemonic](README.md#generatemnemonic)
143
146
  - [generateWalletId](README.md#generatewalletid)
147
+ - [getAddressFromKeyPair](README.md#getaddressfromkeypair)
144
148
  - [getAddressFromScriptPubKey](README.md#getaddressfromscriptpubkey)
145
149
  - [getAddressTypeFromPath](README.md#getaddresstypefrompath)
150
+ - [getAddressesFromPrivateKey](README.md#getaddressesfromprivatekey)
146
151
  - [getByteCount](README.md#getbytecount)
147
152
  - [getDataFallback](README.md#getdatafallback)
148
153
  - [getDefaultPort](README.md#getdefaultport)
149
154
  - [getDefaultWalletData](README.md#getdefaultwalletdata)
150
155
  - [getDefaultWalletDataKeys](README.md#getdefaultwalletdatakeys)
151
- - [getExchangeRates](README.md#getexchangerates)
156
+ - [getElectrumNetwork](README.md#getelectrumnetwork)
152
157
  - [getHighestUsedIndexFromTxHashes](README.md#gethighestusedindexfromtxhashes)
153
158
  - [getKeyDerivationPath](README.md#getkeyderivationpath)
154
159
  - [getKeyDerivationPathObject](README.md#getkeyderivationpathobject)
@@ -161,8 +166,10 @@ beignet
161
166
  - [getSeedHash](README.md#getseedhash)
162
167
  - [getSha256](README.md#getsha256)
163
168
  - [getStorageKeyValues](README.md#getstoragekeyvalues)
169
+ - [getTapRootAddressFromPublicKey](README.md#gettaprootaddressfrompublickey)
164
170
  - [getTxFee](README.md#gettxfee)
165
171
  - [getWalletDataStorageKey](README.md#getwalletdatastoragekey)
172
+ - [isP2trPrefix](README.md#isp2trprefix)
166
173
  - [isValidBech32mEncodedString](README.md#isvalidbech32mencodedstring)
167
174
  - [objectKeys](README.md#objectkeys-1)
168
175
  - [objectsMatch](README.md#objectsmatch)
@@ -172,6 +179,7 @@ beignet
172
179
  - [removeDustOutputs](README.md#removedustoutputs)
173
180
  - [setReplaceByFee](README.md#setreplacebyfee)
174
181
  - [shuffleArray](README.md#shufflearray)
182
+ - [sleep](README.md#sleep)
175
183
  - [validateAddress](README.md#validateaddress)
176
184
  - [validateMnemonic](README.md#validatemnemonic)
177
185
  - [validateTransaction](README.md#validatetransaction)
@@ -191,7 +199,7 @@ beignet
191
199
 
192
200
  #### Defined in
193
201
 
194
- [types/electrum.ts:151](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L151)
202
+ [types/electrum.ts:151](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L151)
195
203
 
196
204
  ___
197
205
 
@@ -207,7 +215,7 @@ ___
207
215
 
208
216
  #### Defined in
209
217
 
210
- [types/electrum.ts:158](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L158)
218
+ [types/electrum.ts:158](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L158)
211
219
 
212
220
  ___
213
221
 
@@ -221,7 +229,7 @@ ___
221
229
 
222
230
  #### Defined in
223
231
 
224
- [types/wallet.ts:380](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L380)
232
+ [types/wallet.ts:376](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L376)
225
233
 
226
234
  ___
227
235
 
@@ -237,7 +245,7 @@ ___
237
245
 
238
246
  #### Defined in
239
247
 
240
- [types/wallet.ts:453](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L453)
248
+ [types/wallet.ts:449](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L449)
241
249
 
242
250
  ___
243
251
 
@@ -255,7 +263,7 @@ Represents a result that can be successful (Ok) or contain an error (Err).
255
263
 
256
264
  #### Defined in
257
265
 
258
- [utils/result.ts:4](https://github.com/synonymdev/beignet/blob/583604f/src/utils/result.ts#L4)
266
+ [utils/result.ts:4](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/result.ts#L4)
259
267
 
260
268
  ___
261
269
 
@@ -274,7 +282,7 @@ ___
274
282
 
275
283
  #### Defined in
276
284
 
277
- [types/wallet.ts:474](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L474)
285
+ [types/wallet.ts:470](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L470)
278
286
 
279
287
  ___
280
288
 
@@ -284,7 +292,7 @@ ___
284
292
 
285
293
  #### Defined in
286
294
 
287
- [types/wallet.ts:15](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L15)
295
+ [types/wallet.ts:17](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L17)
288
296
 
289
297
  ___
290
298
 
@@ -294,7 +302,7 @@ ___
294
302
 
295
303
  #### Defined in
296
304
 
297
- [types/wallet.ts:14](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L14)
305
+ [types/wallet.ts:16](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L16)
298
306
 
299
307
  ___
300
308
 
@@ -310,7 +318,7 @@ ___
310
318
 
311
319
  #### Defined in
312
320
 
313
- [types/wallet.ts:46](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L46)
321
+ [types/wallet.ts:48](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L48)
314
322
 
315
323
  ___
316
324
 
@@ -320,7 +328,7 @@ ___
320
328
 
321
329
  #### Defined in
322
330
 
323
- [types/wallet.ts:21](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L21)
331
+ [types/wallet.ts:23](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L23)
324
332
 
325
333
  ___
326
334
 
@@ -330,7 +338,7 @@ ___
330
338
 
331
339
  #### Defined in
332
340
 
333
- [types/wallet.ts:13](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L13)
341
+ [types/wallet.ts:15](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L15)
334
342
 
335
343
  ___
336
344
 
@@ -340,7 +348,7 @@ ___
340
348
 
341
349
  #### Defined in
342
350
 
343
- [types/electrum.ts:15](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L15)
351
+ [types/electrum.ts:15](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L15)
344
352
 
345
353
  ___
346
354
 
@@ -364,7 +372,7 @@ ___
364
372
 
365
373
  #### Defined in
366
374
 
367
- [types/transaction.ts:42](https://github.com/synonymdev/beignet/blob/583604f/src/types/transaction.ts#L42)
375
+ [types/transaction.ts:43](https://github.com/synonymdev/beignet/blob/05d5011/src/types/transaction.ts#L43)
368
376
 
369
377
  ___
370
378
 
@@ -374,7 +382,7 @@ ___
374
382
 
375
383
  #### Defined in
376
384
 
377
- [types/electrum.ts:9](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L9)
385
+ [types/electrum.ts:9](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L9)
378
386
 
379
387
  ___
380
388
 
@@ -391,7 +399,7 @@ ___
391
399
 
392
400
  #### Defined in
393
401
 
394
- [types/electrum.ts:162](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L162)
402
+ [types/electrum.ts:162](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L162)
395
403
 
396
404
  ___
397
405
 
@@ -401,7 +409,7 @@ ___
401
409
 
402
410
  #### Defined in
403
411
 
404
- [types/wallet.ts:395](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L395)
412
+ [types/wallet.ts:391](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L391)
405
413
 
406
414
  ___
407
415
 
@@ -411,7 +419,7 @@ ___
411
419
 
412
420
  #### Defined in
413
421
 
414
- [types/wallet.ts:387](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L387)
422
+ [types/wallet.ts:383](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L383)
415
423
 
416
424
  ___
417
425
 
@@ -421,7 +429,7 @@ ___
421
429
 
422
430
  #### Defined in
423
431
 
424
- [types/wallet.ts:409](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L409)
432
+ [types/wallet.ts:405](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L405)
425
433
 
426
434
  ___
427
435
 
@@ -431,7 +439,7 @@ ___
431
439
 
432
440
  #### Defined in
433
441
 
434
- [types/wallet.ts:391](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L391)
442
+ [types/wallet.ts:387](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L387)
435
443
 
436
444
  ___
437
445
 
@@ -461,7 +469,7 @@ ___
461
469
 
462
470
  #### Defined in
463
471
 
464
- [types/wallet.ts:173](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L173)
472
+ [types/wallet.ts:175](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L175)
465
473
 
466
474
  ___
467
475
 
@@ -480,7 +488,7 @@ ___
480
488
 
481
489
  #### Defined in
482
490
 
483
- [types/transaction.ts:54](https://github.com/synonymdev/beignet/blob/583604f/src/types/transaction.ts#L54)
491
+ [types/transaction.ts:55](https://github.com/synonymdev/beignet/blob/05d5011/src/types/transaction.ts#L55)
484
492
 
485
493
  ___
486
494
 
@@ -490,7 +498,7 @@ ___
490
498
 
491
499
  #### Defined in
492
500
 
493
- [types/wallet.ts:18](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L18)
501
+ [types/wallet.ts:20](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L20)
494
502
 
495
503
  ___
496
504
 
@@ -500,7 +508,7 @@ ___
500
508
 
501
509
  #### Defined in
502
510
 
503
- [types/wallet.ts:19](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L19)
511
+ [types/wallet.ts:21](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L21)
504
512
 
505
513
  ___
506
514
 
@@ -510,7 +518,7 @@ ___
510
518
 
511
519
  #### Defined in
512
520
 
513
- [types/wallet.ts:17](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L17)
521
+ [types/wallet.ts:19](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L19)
514
522
 
515
523
  ___
516
524
 
@@ -520,7 +528,7 @@ ___
520
528
 
521
529
  #### Defined in
522
530
 
523
- [types/wallet.ts:20](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L20)
531
+ [types/wallet.ts:22](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L22)
524
532
 
525
533
  ___
526
534
 
@@ -530,7 +538,7 @@ ___
530
538
 
531
539
  #### Defined in
532
540
 
533
- [types/wallet.ts:16](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L16)
541
+ [types/wallet.ts:18](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L18)
534
542
 
535
543
  ___
536
544
 
@@ -552,7 +560,7 @@ ___
552
560
 
553
561
  #### Defined in
554
562
 
555
- [types/wallet.ts:436](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L436)
563
+ [types/wallet.ts:432](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L432)
556
564
 
557
565
  ___
558
566
 
@@ -562,7 +570,7 @@ ___
562
570
 
563
571
  #### Defined in
564
572
 
565
- [types/wallet.ts:461](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L461)
573
+ [types/wallet.ts:457](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L457)
566
574
 
567
575
  ___
568
576
 
@@ -593,7 +601,7 @@ ___
593
601
 
594
602
  #### Defined in
595
603
 
596
- [types/wallet.ts:456](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L456)
604
+ [types/wallet.ts:452](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L452)
597
605
 
598
606
  ___
599
607
 
@@ -611,7 +619,7 @@ ___
611
619
 
612
620
  #### Defined in
613
621
 
614
- [types/wallet.ts:358](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L358)
622
+ [types/wallet.ts:364](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L364)
615
623
 
616
624
  ___
617
625
 
@@ -621,7 +629,7 @@ ___
621
629
 
622
630
  #### Defined in
623
631
 
624
- [types/electrum.ts:27](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L27)
632
+ [types/electrum.ts:27](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L27)
625
633
 
626
634
  ___
627
635
 
@@ -640,7 +648,7 @@ ___
640
648
 
641
649
  #### Defined in
642
650
 
643
- [types/electrum.ts:21](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L21)
651
+ [types/electrum.ts:21](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L21)
644
652
 
645
653
  ___
646
654
 
@@ -671,7 +679,7 @@ ___
671
679
 
672
680
  #### Defined in
673
681
 
674
- [types/wallet.ts:176](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L176)
682
+ [types/wallet.ts:178](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L178)
675
683
 
676
684
  ___
677
685
 
@@ -681,7 +689,7 @@ ___
681
689
 
682
690
  #### Defined in
683
691
 
684
- [types/transaction.ts:40](https://github.com/synonymdev/beignet/blob/583604f/src/types/transaction.ts#L40)
692
+ [types/transaction.ts:41](https://github.com/synonymdev/beignet/blob/05d5011/src/types/transaction.ts#L41)
685
693
 
686
694
  ___
687
695
 
@@ -698,7 +706,7 @@ ___
698
706
 
699
707
  #### Defined in
700
708
 
701
- [types/wallet.ts:481](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L481)
709
+ [types/wallet.ts:477](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L477)
702
710
 
703
711
  ___
704
712
 
@@ -708,7 +716,7 @@ ___
708
716
 
709
717
  #### Defined in
710
718
 
711
- [types/electrum.ts:135](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L135)
719
+ [types/electrum.ts:135](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L135)
712
720
 
713
721
  ___
714
722
 
@@ -724,7 +732,7 @@ ___
724
732
 
725
733
  #### Defined in
726
734
 
727
- [types/wallet.ts:446](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L446)
735
+ [types/wallet.ts:442](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L442)
728
736
 
729
737
  ___
730
738
 
@@ -744,7 +752,7 @@ ___
744
752
 
745
753
  #### Defined in
746
754
 
747
- [types/electrum.ts:55](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L55)
755
+ [types/electrum.ts:55](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L55)
748
756
 
749
757
  ___
750
758
 
@@ -761,7 +769,7 @@ ___
761
769
 
762
770
  #### Defined in
763
771
 
764
- [types/electrum.ts:42](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L42)
772
+ [types/electrum.ts:42](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L42)
765
773
 
766
774
  ___
767
775
 
@@ -775,7 +783,7 @@ ___
775
783
 
776
784
  #### Defined in
777
785
 
778
- [types/electrum.ts:38](https://github.com/synonymdev/beignet/blob/583604f/src/types/electrum.ts#L38)
786
+ [types/electrum.ts:38](https://github.com/synonymdev/beignet/blob/05d5011/src/types/electrum.ts#L38)
779
787
 
780
788
  ___
781
789
 
@@ -785,7 +793,7 @@ ___
785
793
 
786
794
  #### Defined in
787
795
 
788
- [types/wallet.ts:171](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L171)
796
+ [types/wallet.ts:173](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L173)
789
797
 
790
798
  ## Variables
791
799
 
@@ -795,7 +803,7 @@ ___
795
803
 
796
804
  #### Defined in
797
805
 
798
- [utils/electrum.ts:14](https://github.com/synonymdev/beignet/blob/583604f/src/utils/electrum.ts#L14)
806
+ [utils/electrum.ts:15](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/electrum.ts#L15)
799
807
 
800
808
  ___
801
809
 
@@ -810,42 +818,7 @@ If connection was lost this will try to reconnect in the specified interval
810
818
 
811
819
  #### Defined in
812
820
 
813
- [utils/electrum.ts:133](https://github.com/synonymdev/beignet/blob/583604f/src/utils/electrum.ts#L133)
814
-
815
- ___
816
-
817
- ### mostUsedExchangeTickers
818
-
819
- • `Const` **mostUsedExchangeTickers**: `Object`
820
-
821
- #### Type declaration
822
-
823
- | Name | Type |
824
- | :------ | :------ |
825
- | `CAD` | { `currencySymbol`: `string` = '$'; `quote`: `string` = 'CAD'; `quoteName`: `string` = 'Canadian Dollar' } |
826
- | `CAD.currencySymbol` | `string` |
827
- | `CAD.quote` | `string` |
828
- | `CAD.quoteName` | `string` |
829
- | `CNY` | { `currencySymbol`: `string` = '¥'; `quote`: `string` = 'CNY'; `quoteName`: `string` = 'Chinese Yuan Renminbi' } |
830
- | `CNY.currencySymbol` | `string` |
831
- | `CNY.quote` | `string` |
832
- | `CNY.quoteName` | `string` |
833
- | `EUR` | { `currencySymbol`: `string` = '€'; `quote`: `string` = 'EUR'; `quoteName`: `string` = 'Euro' } |
834
- | `EUR.currencySymbol` | `string` |
835
- | `EUR.quote` | `string` |
836
- | `EUR.quoteName` | `string` |
837
- | `GBP` | { `currencySymbol`: `string` = '£'; `quote`: `string` = 'GBP'; `quoteName`: `string` = 'Great British Pound' } |
838
- | `GBP.currencySymbol` | `string` |
839
- | `GBP.quote` | `string` |
840
- | `GBP.quoteName` | `string` |
841
- | `USD` | { `currencySymbol`: `string` = '$'; `quote`: `string` = 'USD'; `quoteName`: `string` = 'US Dollar' } |
842
- | `USD.currencySymbol` | `string` |
843
- | `USD.quote` | `string` |
844
- | `USD.quoteName` | `string` |
845
-
846
- #### Defined in
847
-
848
- [utils/exchange-rate.ts:5](https://github.com/synonymdev/beignet/blob/583604f/src/utils/exchange-rate.ts#L5)
821
+ [utils/electrum.ts:134](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/electrum.ts#L134)
849
822
 
850
823
  ## Functions
851
824
 
@@ -861,7 +834,7 @@ Returns an array of all available networks from the networks object.
861
834
 
862
835
  #### Defined in
863
836
 
864
- [utils/wallet.ts:207](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L207)
837
+ [utils/wallet.ts:207](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L207)
865
838
 
866
839
  ___
867
840
 
@@ -886,7 +859,7 @@ y
886
859
 
887
860
  #### Defined in
888
861
 
889
- [utils/transaction.ts:147](https://github.com/synonymdev/beignet/blob/583604f/src/utils/transaction.ts#L147)
862
+ [utils/transaction.ts:145](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/transaction.ts#L145)
890
863
 
891
864
  ___
892
865
 
@@ -906,7 +879,7 @@ ___
906
879
 
907
880
  #### Defined in
908
881
 
909
- [utils/wallet.ts:262](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L262)
882
+ [utils/wallet.ts:262](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L262)
910
883
 
911
884
  ___
912
885
 
@@ -930,7 +903,7 @@ Source: https://github.com/bitcoinjs/bitcoinjs-lib/issues/1606#issuecomment-6647
930
903
 
931
904
  #### Defined in
932
905
 
933
- [utils/transaction.ts:376](https://github.com/synonymdev/beignet/blob/583604f/src/utils/transaction.ts#L376)
906
+ [utils/transaction.ts:378](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/transaction.ts#L378)
934
907
 
935
908
  ___
936
909
 
@@ -960,7 +933,7 @@ An Err result containing the given error.
960
933
 
961
934
  #### Defined in
962
935
 
963
- [utils/result.ts:74](https://github.com/synonymdev/beignet/blob/583604f/src/utils/result.ts#L74)
936
+ [utils/result.ts:74](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/result.ts#L74)
964
937
 
965
938
  ___
966
939
 
@@ -990,7 +963,7 @@ Derivation Path Data
990
963
 
991
964
  #### Defined in
992
965
 
993
- [utils/wallet.ts:75](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L75)
966
+ [utils/wallet.ts:75](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L75)
994
967
 
995
968
  ___
996
969
 
@@ -1014,7 +987,7 @@ Result<IFormattedPeerData>
1014
987
 
1015
988
  #### Defined in
1016
989
 
1017
- [utils/electrum.ts:59](https://github.com/synonymdev/beignet/blob/583604f/src/utils/electrum.ts#L59)
990
+ [utils/electrum.ts:60](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/electrum.ts#L60)
1018
991
 
1019
992
  ___
1020
993
 
@@ -1038,7 +1011,7 @@ Extends bip39's generateMnemonic function.
1038
1011
 
1039
1012
  #### Defined in
1040
1013
 
1041
- [utils/helpers.ts:150](https://github.com/synonymdev/beignet/blob/583604f/src/utils/helpers.ts#L150)
1014
+ [utils/helpers.ts:160](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L160)
1042
1015
 
1043
1016
  ___
1044
1017
 
@@ -1058,7 +1031,32 @@ ___
1058
1031
 
1059
1032
  #### Defined in
1060
1033
 
1061
- [utils/wallet.ts:310](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L310)
1034
+ [utils/wallet.ts:310](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L310)
1035
+
1036
+ ___
1037
+
1038
+ ### getAddressFromKeyPair
1039
+
1040
+ ▸ **getAddressFromKeyPair**(`«destructured»`): [`Result`](README.md#result)<[`IGetAddressesFromKeyPair`](interfaces/IGetAddressesFromKeyPair.md)\>
1041
+
1042
+ Get address from key pair.
1043
+
1044
+ #### Parameters
1045
+
1046
+ | Name | Type |
1047
+ | :------ | :------ |
1048
+ | `«destructured»` | `Object` |
1049
+ | › `addressType` | [`EAddressType`](enums/EAddressType.md) |
1050
+ | › `keyPair` | `BIP32Interface` \| `ECPairInterface` |
1051
+ | › `network` | `Network` |
1052
+
1053
+ #### Returns
1054
+
1055
+ [`Result`](README.md#result)<[`IGetAddressesFromKeyPair`](interfaces/IGetAddressesFromKeyPair.md)\>
1056
+
1057
+ #### Defined in
1058
+
1059
+ [utils/helpers.ts:210](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L210)
1062
1060
 
1063
1061
  ___
1064
1062
 
@@ -1081,7 +1079,7 @@ Get address for a given scriptPubKey.
1081
1079
 
1082
1080
  #### Defined in
1083
1081
 
1084
- [utils/helpers.ts:16](https://github.com/synonymdev/beignet/blob/583604f/src/utils/helpers.ts#L16)
1082
+ [utils/helpers.ts:26](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L26)
1085
1083
 
1086
1084
  ___
1087
1085
 
@@ -1103,7 +1101,32 @@ Returns the address type from the specified derivation path.
1103
1101
 
1104
1102
  #### Defined in
1105
1103
 
1106
- [utils/derivation-path.ts:147](https://github.com/synonymdev/beignet/blob/583604f/src/utils/derivation-path.ts#L147)
1104
+ [utils/derivation-path.ts:147](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/derivation-path.ts#L147)
1105
+
1106
+ ___
1107
+
1108
+ ### getAddressesFromPrivateKey
1109
+
1110
+ ▸ **getAddressesFromPrivateKey**(`«destructured»`): [`Result`](README.md#result)<[`IGetAddressesFromPrivateKey`](interfaces/IGetAddressesFromPrivateKey.md)\>
1111
+
1112
+ Get addresses from a private key.
1113
+
1114
+ #### Parameters
1115
+
1116
+ | Name | Type |
1117
+ | :------ | :------ |
1118
+ | `«destructured»` | `Object` |
1119
+ | › `addrTypes?` | [`EAddressType`](enums/EAddressType.md)[] |
1120
+ | › `network?` | `Network` |
1121
+ | › `privateKey` | `string` |
1122
+
1123
+ #### Returns
1124
+
1125
+ [`Result`](README.md#result)<[`IGetAddressesFromPrivateKey`](interfaces/IGetAddressesFromPrivateKey.md)\>
1126
+
1127
+ #### Defined in
1128
+
1129
+ [utils/helpers.ts:298](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L298)
1107
1130
 
1108
1131
  ___
1109
1132
 
@@ -1126,7 +1149,7 @@ ___
1126
1149
 
1127
1150
  #### Defined in
1128
1151
 
1129
- [utils/transaction.ts:182](https://github.com/synonymdev/beignet/blob/583604f/src/utils/transaction.ts#L182)
1152
+ [utils/transaction.ts:180](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/transaction.ts#L180)
1130
1153
 
1131
1154
  ___
1132
1155
 
@@ -1152,7 +1175,7 @@ ___
1152
1175
 
1153
1176
  #### Defined in
1154
1177
 
1155
- [types/wallet.ts:173](https://github.com/synonymdev/beignet/blob/583604f/src/types/wallet.ts#L173)
1178
+ [types/wallet.ts:175](https://github.com/synonymdev/beignet/blob/05d5011/src/types/wallet.ts#L175)
1156
1179
 
1157
1180
  ___
1158
1181
 
@@ -1175,7 +1198,7 @@ Returns the default port for the given network and protocol.
1175
1198
 
1176
1199
  #### Defined in
1177
1200
 
1178
- [utils/electrum.ts:22](https://github.com/synonymdev/beignet/blob/583604f/src/utils/electrum.ts#L22)
1201
+ [utils/electrum.ts:23](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/electrum.ts#L23)
1179
1202
 
1180
1203
  ___
1181
1204
 
@@ -1191,7 +1214,7 @@ Returns the default wallet data object.
1191
1214
 
1192
1215
  #### Defined in
1193
1216
 
1194
- [utils/wallet.ts:34](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L34)
1217
+ [utils/wallet.ts:34](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L34)
1195
1218
 
1196
1219
  ___
1197
1220
 
@@ -1207,23 +1230,29 @@ keyof [`IWalletData`](interfaces/IWalletData.md)[]
1207
1230
 
1208
1231
  #### Defined in
1209
1232
 
1210
- [utils/wallet.ts:42](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L42)
1233
+ [utils/wallet.ts:42](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L42)
1211
1234
 
1212
1235
  ___
1213
1236
 
1214
- ### getExchangeRates
1237
+ ### getElectrumNetwork
1238
+
1239
+ ▸ **getElectrumNetwork**(`network?`): [`EElectrumNetworks`](enums/EElectrumNetworks.md)
1215
1240
 
1216
- ▸ **getExchangeRates**(): `Promise`<[`Result`](README.md#result)<[`IExchangeRates`](interfaces/IExchangeRates.md)\>\>
1241
+ Returns the network string for use with Electrum methods.
1217
1242
 
1218
- Returns the exchange rate for the given currency
1243
+ #### Parameters
1244
+
1245
+ | Name | Type |
1246
+ | :------ | :------ |
1247
+ | `network?` | [`EAvailableNetworks`](enums/EAvailableNetworks.md) |
1219
1248
 
1220
1249
  #### Returns
1221
1250
 
1222
- `Promise`<[`Result`](README.md#result)<[`IExchangeRates`](interfaces/IExchangeRates.md)\>\>
1251
+ [`EElectrumNetworks`](enums/EElectrumNetworks.md)
1223
1252
 
1224
1253
  #### Defined in
1225
1254
 
1226
- [utils/exchange-rate.ts:45](https://github.com/synonymdev/beignet/blob/583604f/src/utils/exchange-rate.ts#L45)
1255
+ [utils/electrum.ts:196](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/electrum.ts#L196)
1227
1256
 
1228
1257
  ___
1229
1258
 
@@ -1250,7 +1279,7 @@ Returns the highest used index from the provided txHashes.
1250
1279
 
1251
1280
  #### Defined in
1252
1281
 
1253
- [utils/wallet.ts:133](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L133)
1282
+ [utils/wallet.ts:133](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L133)
1254
1283
 
1255
1284
  ___
1256
1285
 
@@ -1276,7 +1305,7 @@ Result<IKeyDerivationPath>
1276
1305
 
1277
1306
  #### Defined in
1278
1307
 
1279
- [utils/helpers.ts:98](https://github.com/synonymdev/beignet/blob/583604f/src/utils/helpers.ts#L98)
1308
+ [utils/helpers.ts:108](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L108)
1280
1309
 
1281
1310
  ___
1282
1311
 
@@ -1303,7 +1332,7 @@ Parses a key derivation path in string format Ex: "m/84'/0'/0'/0/0" and returns
1303
1332
 
1304
1333
  #### Defined in
1305
1334
 
1306
- [utils/derivation-path.ts:22](https://github.com/synonymdev/beignet/blob/583604f/src/utils/derivation-path.ts#L22)
1335
+ [utils/derivation-path.ts:22](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/derivation-path.ts#L22)
1307
1336
 
1308
1337
  ___
1309
1338
 
@@ -1332,7 +1361,7 @@ Parses a key derivation path object and returns it in string format. Ex: "m/84'/
1332
1361
 
1333
1362
  #### Defined in
1334
1363
 
1335
- [utils/derivation-path.ts:80](https://github.com/synonymdev/beignet/blob/583604f/src/utils/derivation-path.ts#L80)
1364
+ [utils/derivation-path.ts:80](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/derivation-path.ts#L80)
1336
1365
 
1337
1366
  ___
1338
1367
 
@@ -1354,7 +1383,7 @@ Returns last value between hyphens in a string.
1354
1383
 
1355
1384
  #### Defined in
1356
1385
 
1357
- [utils/wallet.ts:51](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L51)
1386
+ [utils/wallet.ts:51](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L51)
1358
1387
 
1359
1388
  ___
1360
1389
 
@@ -1380,7 +1409,7 @@ Promise<Result<IFormattedPeerData[]>>
1380
1409
 
1381
1410
  #### Defined in
1382
1411
 
1383
- [utils/electrum.ts:95](https://github.com/synonymdev/beignet/blob/583604f/src/utils/electrum.ts#L95)
1412
+ [utils/electrum.ts:96](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/electrum.ts#L96)
1384
1413
 
1385
1414
  ___
1386
1415
 
@@ -1403,7 +1432,7 @@ Returns the protocol for the given network and default port.
1403
1432
 
1404
1433
  #### Defined in
1405
1434
 
1406
- [utils/electrum.ts:39](https://github.com/synonymdev/beignet/blob/583604f/src/utils/electrum.ts#L39)
1435
+ [utils/electrum.ts:40](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/electrum.ts#L40)
1407
1436
 
1408
1437
  ___
1409
1438
 
@@ -1427,7 +1456,7 @@ Get scriptHash for a given address
1427
1456
 
1428
1457
  #### Defined in
1429
1458
 
1430
- [utils/helpers.ts:125](https://github.com/synonymdev/beignet/blob/583604f/src/utils/helpers.ts#L125)
1459
+ [utils/helpers.ts:135](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L135)
1431
1460
 
1432
1461
  ___
1433
1462
 
@@ -1450,7 +1479,7 @@ Returns the seed for a given mnemonic and passphrase.
1450
1479
 
1451
1480
  #### Defined in
1452
1481
 
1453
- [utils/wallet.ts:295](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L295)
1482
+ [utils/wallet.ts:295](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L295)
1454
1483
 
1455
1484
  ___
1456
1485
 
@@ -1472,7 +1501,7 @@ Returns the seed hash for a given mnemonic and passphrase.
1472
1501
 
1473
1502
  #### Defined in
1474
1503
 
1475
- [utils/wallet.ts:304](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L304)
1504
+ [utils/wallet.ts:304](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L304)
1476
1505
 
1477
1506
  ___
1478
1507
 
@@ -1494,7 +1523,7 @@ Get sha256 hash of a given string.
1494
1523
 
1495
1524
  #### Defined in
1496
1525
 
1497
- [utils/helpers.ts:32](https://github.com/synonymdev/beignet/blob/583604f/src/utils/helpers.ts#L32)
1526
+ [utils/helpers.ts:42](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L42)
1498
1527
 
1499
1528
  ___
1500
1529
 
@@ -1520,7 +1549,31 @@ ___
1520
1549
 
1521
1550
  #### Defined in
1522
1551
 
1523
- [utils/wallet.ts:324](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L324)
1552
+ [utils/wallet.ts:324](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L324)
1553
+
1554
+ ___
1555
+
1556
+ ### getTapRootAddressFromPublicKey
1557
+
1558
+ ▸ **getTapRootAddressFromPublicKey**(`«destructured»`): [`Result`](README.md#result)<{ `address`: `string` ; `internalPubkey`: `Buffer` ; `output`: `Buffer` }\>
1559
+
1560
+ Returns taproot address information from the provided public key.
1561
+
1562
+ #### Parameters
1563
+
1564
+ | Name | Type |
1565
+ | :------ | :------ |
1566
+ | `«destructured»` | `Object` |
1567
+ | › `network` | `Network` |
1568
+ | › `publicKey` | `Buffer` |
1569
+
1570
+ #### Returns
1571
+
1572
+ [`Result`](README.md#result)<{ `address`: `string` ; `internalPubkey`: `Buffer` ; `output`: `Buffer` }\>
1573
+
1574
+ #### Defined in
1575
+
1576
+ [utils/helpers.ts:271](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L271)
1524
1577
 
1525
1578
  ___
1526
1579
 
@@ -1544,7 +1597,7 @@ Returns the total fee in sats for a transaction at a given size (transactionByte
1544
1597
 
1545
1598
  #### Defined in
1546
1599
 
1547
- [utils/wallet.ts:345](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L345)
1600
+ [utils/wallet.ts:345](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L345)
1548
1601
 
1549
1602
  ___
1550
1603
 
@@ -1566,7 +1619,30 @@ ___
1566
1619
 
1567
1620
  #### Defined in
1568
1621
 
1569
- [utils/wallet.ts:316](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L316)
1622
+ [utils/wallet.ts:316](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L316)
1623
+
1624
+ ___
1625
+
1626
+ ### isP2trPrefix
1627
+
1628
+ ▸ **isP2trPrefix**(`address`): `boolean`
1629
+
1630
+ Quickly attempts to determine if the provided address is a valid p2tr/taproot address prefix.
1631
+ For a more robust check, use isValidBech32mEncodedString.
1632
+
1633
+ #### Parameters
1634
+
1635
+ | Name | Type |
1636
+ | :------ | :------ |
1637
+ | `address` | `string` |
1638
+
1639
+ #### Returns
1640
+
1641
+ `boolean`
1642
+
1643
+ #### Defined in
1644
+
1645
+ [utils/transaction.ts:430](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/transaction.ts#L430)
1570
1646
 
1571
1647
  ___
1572
1648
 
@@ -1593,7 +1669,7 @@ Returns if the provided string is a valid Bech32m encoded string (taproot/p2tr a
1593
1669
 
1594
1670
  #### Defined in
1595
1671
 
1596
- [utils/wallet.ts:185](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L185)
1672
+ [utils/wallet.ts:185](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L185)
1597
1673
 
1598
1674
  ___
1599
1675
 
@@ -1621,7 +1697,7 @@ Returns the keys of a given object.
1621
1697
 
1622
1698
  #### Defined in
1623
1699
 
1624
- [utils/wallet.ts:62](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L62)
1700
+ [utils/wallet.ts:62](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L62)
1625
1701
 
1626
1702
  ___
1627
1703
 
@@ -1646,7 +1722,7 @@ boolean
1646
1722
 
1647
1723
  #### Defined in
1648
1724
 
1649
- [utils/helpers.ts:177](https://github.com/synonymdev/beignet/blob/583604f/src/utils/helpers.ts#L177)
1725
+ [utils/helpers.ts:187](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L187)
1650
1726
 
1651
1727
  ___
1652
1728
 
@@ -1676,7 +1752,7 @@ An Ok result containing the given value.
1676
1752
 
1677
1753
  #### Defined in
1678
1754
 
1679
- [utils/result.ts:67](https://github.com/synonymdev/beignet/blob/583604f/src/utils/result.ts#L67)
1755
+ [utils/result.ts:67](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/result.ts#L67)
1680
1756
 
1681
1757
  ___
1682
1758
 
@@ -1697,7 +1773,7 @@ ___
1697
1773
 
1698
1774
  #### Defined in
1699
1775
 
1700
- [utils/transaction.ts:64](https://github.com/synonymdev/beignet/blob/583604f/src/utils/transaction.ts#L64)
1776
+ [utils/transaction.ts:62](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/transaction.ts#L62)
1701
1777
 
1702
1778
  ___
1703
1779
 
@@ -1727,7 +1803,7 @@ Sum a specific value in an array of objects.
1727
1803
 
1728
1804
  #### Defined in
1729
1805
 
1730
- [utils/wallet.ts:216](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L216)
1806
+ [utils/wallet.ts:216](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L216)
1731
1807
 
1732
1808
  ___
1733
1809
 
@@ -1749,7 +1825,7 @@ Removes outputs that are below the dust limit.
1749
1825
 
1750
1826
  #### Defined in
1751
1827
 
1752
- [utils/transaction.ts:296](https://github.com/synonymdev/beignet/blob/583604f/src/utils/transaction.ts#L296)
1828
+ [utils/transaction.ts:298](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/transaction.ts#L298)
1753
1829
 
1754
1830
  ___
1755
1831
 
@@ -1773,7 +1849,7 @@ Sets RBF for the provided psbt.
1773
1849
 
1774
1850
  #### Defined in
1775
1851
 
1776
- [utils/transaction.ts:28](https://github.com/synonymdev/beignet/blob/583604f/src/utils/transaction.ts#L28)
1852
+ [utils/transaction.ts:26](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/transaction.ts#L26)
1777
1853
 
1778
1854
  ___
1779
1855
 
@@ -1801,7 +1877,27 @@ Shuffles a given array.
1801
1877
 
1802
1878
  #### Defined in
1803
1879
 
1804
- [utils/wallet.ts:242](https://github.com/synonymdev/beignet/blob/583604f/src/utils/wallet.ts#L242)
1880
+ [utils/wallet.ts:242](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/wallet.ts#L242)
1881
+
1882
+ ___
1883
+
1884
+ ### sleep
1885
+
1886
+ ▸ **sleep**(`ms`): `Promise`<`void`\>
1887
+
1888
+ #### Parameters
1889
+
1890
+ | Name | Type |
1891
+ | :------ | :------ |
1892
+ | `ms` | `any` |
1893
+
1894
+ #### Returns
1895
+
1896
+ `Promise`<`void`\>
1897
+
1898
+ #### Defined in
1899
+
1900
+ [utils/helpers.ts:329](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L329)
1805
1901
 
1806
1902
  ___
1807
1903
 
@@ -1831,7 +1927,7 @@ If no address is provided, it will attempt to validate the address for all avail
1831
1927
 
1832
1928
  #### Defined in
1833
1929
 
1834
- [utils/helpers.ts:45](https://github.com/synonymdev/beignet/blob/583604f/src/utils/helpers.ts#L45)
1930
+ [utils/helpers.ts:55](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L55)
1835
1931
 
1836
1932
  ___
1837
1933
 
@@ -1853,7 +1949,7 @@ Attempts to validate the provided mnemonic.
1853
1949
 
1854
1950
  #### Defined in
1855
1951
 
1856
- [utils/helpers.ts:163](https://github.com/synonymdev/beignet/blob/583604f/src/utils/helpers.ts#L163)
1952
+ [utils/helpers.ts:173](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/helpers.ts#L173)
1857
1953
 
1858
1954
  ___
1859
1955
 
@@ -1875,4 +1971,4 @@ Used to validate transaction form data.
1875
1971
 
1876
1972
  #### Defined in
1877
1973
 
1878
- [utils/transaction.ts:307](https://github.com/synonymdev/beignet/blob/583604f/src/utils/transaction.ts#L307)
1974
+ [utils/transaction.ts:309](https://github.com/synonymdev/beignet/blob/05d5011/src/utils/transaction.ts#L309)