beignet 0.0.1

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 (329) hide show
  1. package/.eslintignore +4 -0
  2. package/.eslintrc +40 -0
  3. package/.prettierrc +9 -0
  4. package/LICENSE +21 -0
  5. package/README.md +166 -0
  6. package/dist/electrum/constants.js +31 -0
  7. package/dist/electrum/constants.js.map +1 -0
  8. package/dist/electrum/index.js +552 -0
  9. package/dist/electrum/index.js.map +1 -0
  10. package/dist/index.js +23 -0
  11. package/dist/index.js.map +1 -0
  12. package/dist/shapes/electrum.js +14 -0
  13. package/dist/shapes/electrum.js.map +1 -0
  14. package/dist/shapes/index.js +19 -0
  15. package/dist/shapes/index.js.map +1 -0
  16. package/dist/shapes/wallet.js +115 -0
  17. package/dist/shapes/wallet.js.map +1 -0
  18. package/dist/transaction/index.js +692 -0
  19. package/dist/transaction/index.js.map +1 -0
  20. package/dist/types/electrum/constants.d.ts +7 -0
  21. package/dist/types/electrum/index.d.ts +85 -0
  22. package/dist/types/electrum.js +9 -0
  23. package/dist/types/electrum.js.map +1 -0
  24. package/dist/types/index.d.ts +6 -0
  25. package/dist/types/index.js +20 -0
  26. package/dist/types/index.js.map +1 -0
  27. package/dist/types/shapes/electrum.d.ts +5 -0
  28. package/dist/types/shapes/index.d.ts +2 -0
  29. package/dist/types/shapes/wallet.d.ts +10 -0
  30. package/dist/types/transaction/index.d.ts +92 -0
  31. package/dist/types/transaction.js +12 -0
  32. package/dist/types/transaction.js.map +1 -0
  33. package/dist/types/types/electrum.d.ts +113 -0
  34. package/dist/types/types/index.d.ts +3 -0
  35. package/dist/types/types/transaction.d.ts +51 -0
  36. package/dist/types/types/wallet.d.ts +400 -0
  37. package/dist/types/utils/conversion.d.ts +10 -0
  38. package/dist/types/utils/derivation-path.d.ts +19 -0
  39. package/dist/types/utils/electrum.d.ts +10 -0
  40. package/dist/types/utils/exchange-rate.d.ts +30 -0
  41. package/dist/types/utils/helpers.d.ts +23 -0
  42. package/dist/types/utils/index.d.ts +7 -0
  43. package/dist/types/utils/result.d.ts +16 -0
  44. package/dist/types/utils/transaction.d.ts +21 -0
  45. package/dist/types/utils/wallet.d.ts +47 -0
  46. package/dist/types/wallet/constants.d.ts +12 -0
  47. package/dist/types/wallet/index.d.ts +214 -0
  48. package/dist/types/wallet.js +36 -0
  49. package/dist/types/wallet.js.map +1 -0
  50. package/dist/utils/conversion.js +52 -0
  51. package/dist/utils/conversion.js.map +1 -0
  52. package/dist/utils/derivation-path.js +104 -0
  53. package/dist/utils/derivation-path.js.map +1 -0
  54. package/dist/utils/electrum.js +149 -0
  55. package/dist/utils/electrum.js.map +1 -0
  56. package/dist/utils/exchange-rate.js +49 -0
  57. package/dist/utils/exchange-rate.js.map +1 -0
  58. package/dist/utils/helpers.js +137 -0
  59. package/dist/utils/helpers.js.map +1 -0
  60. package/dist/utils/index.js +24 -0
  61. package/dist/utils/index.js.map +1 -0
  62. package/dist/utils/result.js +36 -0
  63. package/dist/utils/result.js.map +1 -0
  64. package/dist/utils/transaction.js +327 -0
  65. package/dist/utils/transaction.js.map +1 -0
  66. package/dist/utils/wallet.js +227 -0
  67. package/dist/utils/wallet.js.map +1 -0
  68. package/dist/wallet/constants.js +15 -0
  69. package/dist/wallet/constants.js.map +1 -0
  70. package/dist/wallet/index.js +2113 -0
  71. package/dist/wallet/index.js.map +1 -0
  72. package/docs/html/.nojekyll +1 -0
  73. package/docs/html/assets/highlight.css +22 -0
  74. package/docs/html/assets/main.js +58 -0
  75. package/docs/html/assets/search.js +1 -0
  76. package/docs/html/assets/style.css +1367 -0
  77. package/docs/html/classes/Electrum.html +812 -0
  78. package/docs/html/classes/Transaction.html +687 -0
  79. package/docs/html/classes/Wallet.html +2030 -0
  80. package/docs/html/enums/EAddressType.html +227 -0
  81. package/docs/html/enums/EAvailableNetworks.html +255 -0
  82. package/docs/html/enums/EBoostType.html +220 -0
  83. package/docs/html/enums/EFeeId.html +241 -0
  84. package/docs/html/enums/EPaymentType.html +220 -0
  85. package/docs/html/enums/EProtocol.html +220 -0
  86. package/docs/html/enums/EUnit.html +227 -0
  87. package/docs/html/functions/availableNetworks.html +200 -0
  88. package/docs/html/functions/constructByteCountParam.html +210 -0
  89. package/docs/html/functions/decodeOpReturnMessage.html +202 -0
  90. package/docs/html/functions/decodeRawTransaction.html +210 -0
  91. package/docs/html/functions/err.html +214 -0
  92. package/docs/html/functions/formatKeyDerivationPath.html +219 -0
  93. package/docs/html/functions/formatPeerData.html +207 -0
  94. package/docs/html/functions/generateMnemonic.html +223 -0
  95. package/docs/html/functions/generateWalletId.html +202 -0
  96. package/docs/html/functions/getAddressFromScriptPubKey.html +209 -0
  97. package/docs/html/functions/getAddressTypeFromPath.html +206 -0
  98. package/docs/html/functions/getByteCount.html +206 -0
  99. package/docs/html/functions/getDataFallback.html +207 -0
  100. package/docs/html/functions/getDefaultPort.html +209 -0
  101. package/docs/html/functions/getDefaultWalletData.html +200 -0
  102. package/docs/html/functions/getDefaultWalletDataKeys.html +200 -0
  103. package/docs/html/functions/getExchangeRates.html +200 -0
  104. package/docs/html/functions/getHighestUsedIndexFromTxHashes.html +216 -0
  105. package/docs/html/functions/getKeyDerivationPath.html +211 -0
  106. package/docs/html/functions/getKeyDerivationPathObject.html +216 -0
  107. package/docs/html/functions/getKeyDerivationPathString.html +220 -0
  108. package/docs/html/functions/getKeyValue.html +206 -0
  109. package/docs/html/functions/getPeers.html +211 -0
  110. package/docs/html/functions/getProtocolForPort.html +209 -0
  111. package/docs/html/functions/getScriptHash.html +210 -0
  112. package/docs/html/functions/getSeed.html +209 -0
  113. package/docs/html/functions/getSeedHash.html +206 -0
  114. package/docs/html/functions/getSha256.html +206 -0
  115. package/docs/html/functions/getStorageKeyValues.html +209 -0
  116. package/docs/html/functions/getTxFee.html +210 -0
  117. package/docs/html/functions/getWalletDataStorageKey.html +206 -0
  118. package/docs/html/functions/isValidBech32mEncodedString.html +211 -0
  119. package/docs/html/functions/objectKeys-1.html +211 -0
  120. package/docs/html/functions/objectsMatch.html +210 -0
  121. package/docs/html/functions/ok.html +214 -0
  122. package/docs/html/functions/parseOnChainPaymentRequest.html +204 -0
  123. package/docs/html/functions/reduceValue.html +215 -0
  124. package/docs/html/functions/removeDustOutputs.html +206 -0
  125. package/docs/html/functions/setReplaceByFee.html +210 -0
  126. package/docs/html/functions/shuffleArray.html +211 -0
  127. package/docs/html/functions/validateAddress.html +216 -0
  128. package/docs/html/functions/validateMnemonic.html +206 -0
  129. package/docs/html/functions/validateTransaction.html +206 -0
  130. package/docs/html/index.html +360 -0
  131. package/docs/html/interfaces/IAddInput.html +231 -0
  132. package/docs/html/interfaces/IAddress.html +247 -0
  133. package/docs/html/interfaces/IAddressData.html +231 -0
  134. package/docs/html/interfaces/IAddressType.html +199 -0
  135. package/docs/html/interfaces/IAddressTypeData.html +252 -0
  136. package/docs/html/interfaces/IAddresses.html +199 -0
  137. package/docs/html/interfaces/IBoostedTransaction.html +238 -0
  138. package/docs/html/interfaces/IBoostedTransactions.html +199 -0
  139. package/docs/html/interfaces/ICreateTransaction.html +224 -0
  140. package/docs/html/interfaces/ICustomGetAddress.html +231 -0
  141. package/docs/html/interfaces/ICustomGetScriptHash.html +224 -0
  142. package/docs/html/interfaces/IElectrumGetAddressBalanceRes.html +235 -0
  143. package/docs/html/interfaces/IExchangeRates.html +210 -0
  144. package/docs/html/interfaces/IFormattedPeerData.html +245 -0
  145. package/docs/html/interfaces/IFormattedTransaction.html +343 -0
  146. package/docs/html/interfaces/IFormattedTransactions.html +199 -0
  147. package/docs/html/interfaces/IGenerateAddresses.html +252 -0
  148. package/docs/html/interfaces/IGenerateAddressesResponse.html +224 -0
  149. package/docs/html/interfaces/IGetAddress.html +231 -0
  150. package/docs/html/interfaces/IGetAddressBalanceRes.html +226 -0
  151. package/docs/html/interfaces/IGetAddressByPath.html +224 -0
  152. package/docs/html/interfaces/IGetAddressHistoryResponse.html +269 -0
  153. package/docs/html/interfaces/IGetAddressResponse.html +231 -0
  154. package/docs/html/interfaces/IGetAddressScriptHashesHistoryResponse.html +245 -0
  155. package/docs/html/interfaces/IGetDerivationPath.html +259 -0
  156. package/docs/html/interfaces/IGetFeeEstimatesResponse.html +238 -0
  157. package/docs/html/interfaces/IGetHeaderResponse.html +245 -0
  158. package/docs/html/interfaces/IGetNextAvailableAddressResponse.html +238 -0
  159. package/docs/html/interfaces/IGetTransactions.html +245 -0
  160. package/docs/html/interfaces/IGetTransactionsFromInputs.html +245 -0
  161. package/docs/html/interfaces/IGetUtxosResponse.html +224 -0
  162. package/docs/html/interfaces/IHeader.html +231 -0
  163. package/docs/html/interfaces/IIndexes.html +238 -0
  164. package/docs/html/interfaces/IKeyDerivationPath.html +247 -0
  165. package/docs/html/interfaces/IKeyDerivationPathData.html +224 -0
  166. package/docs/html/interfaces/INewBlock.html +224 -0
  167. package/docs/html/interfaces/IOnchainFees.html +245 -0
  168. package/docs/html/interfaces/IOutput.html +231 -0
  169. package/docs/html/interfaces/IPeerData.html +231 -0
  170. package/docs/html/interfaces/IRbfData.html +252 -0
  171. package/docs/html/interfaces/ISend.html +224 -0
  172. package/docs/html/interfaces/ISendTransaction.html +322 -0
  173. package/docs/html/interfaces/ISendTx.html +231 -0
  174. package/docs/html/interfaces/ISetupTransaction.html +238 -0
  175. package/docs/html/interfaces/ISubscribeToAddress.html +247 -0
  176. package/docs/html/interfaces/ISubscribeToHeader.html +245 -0
  177. package/docs/html/interfaces/ITargets.html +238 -0
  178. package/docs/html/interfaces/ITransaction.html +281 -0
  179. package/docs/html/interfaces/ITxHash.html +217 -0
  180. package/docs/html/interfaces/ITxHashes.html +235 -0
  181. package/docs/html/interfaces/IUtxo.html +275 -0
  182. package/docs/html/interfaces/IVin.html +252 -0
  183. package/docs/html/interfaces/IVout.html +246 -0
  184. package/docs/html/interfaces/IWallet.html +350 -0
  185. package/docs/html/interfaces/IWalletData.html +343 -0
  186. package/docs/html/types/ElectrumConnectionPubSub.html +233 -0
  187. package/docs/html/types/ElectrumConnectionSubscription.html +204 -0
  188. package/docs/html/types/InputData.html +203 -0
  189. package/docs/html/types/ObjectKeys.html +198 -0
  190. package/docs/html/types/Result.html +201 -0
  191. package/docs/html/types/TAddressIndexInfo.html +204 -0
  192. package/docs/html/types/TAddressLabel.html +193 -0
  193. package/docs/html/types/TAddressType.html +193 -0
  194. package/docs/html/types/TAddressTypeContent.html +198 -0
  195. package/docs/html/types/TAddressTypes.html +193 -0
  196. package/docs/html/types/TAvailableNetworks.html +193 -0
  197. package/docs/html/types/TConnectToElectrumRes.html +193 -0
  198. package/docs/html/types/TDecodeRawTx.html +214 -0
  199. package/docs/html/types/TElectrumNetworks.html +193 -0
  200. package/docs/html/types/TGetAddressHistory.html +200 -0
  201. package/docs/html/types/TGetByteCountInput.html +193 -0
  202. package/docs/html/types/TGetByteCountInputs.html +193 -0
  203. package/docs/html/types/TGetByteCountOutput.html +193 -0
  204. package/docs/html/types/TGetByteCountOutputs.html +193 -0
  205. package/docs/html/types/TGetData.html +211 -0
  206. package/docs/html/types/TGetTotalFeeObj.html +204 -0
  207. package/docs/html/types/TKeyDerivationAccount.html +193 -0
  208. package/docs/html/types/TKeyDerivationChange.html +193 -0
  209. package/docs/html/types/TKeyDerivationCoinType.html +193 -0
  210. package/docs/html/types/TKeyDerivationIndex.html +193 -0
  211. package/docs/html/types/TKeyDerivationPurpose.html +193 -0
  212. package/docs/html/types/TMessageDataMap.html +210 -0
  213. package/docs/html/types/TMessageKeys.html +193 -0
  214. package/docs/html/types/TOnMessage.html +213 -0
  215. package/docs/html/types/TProcessUnconfirmedTransactions.html +202 -0
  216. package/docs/html/types/TProtocol.html +193 -0
  217. package/docs/html/types/TServer.html +204 -0
  218. package/docs/html/types/TSetData.html +213 -0
  219. package/docs/html/types/TSetupTransactionResponse.html +193 -0
  220. package/docs/html/types/TStorage.html +200 -0
  221. package/docs/html/types/TSubscribedReceive.html +193 -0
  222. package/docs/html/types/TTransactionMessage.html +198 -0
  223. package/docs/html/types/TTxResponse.html +206 -0
  224. package/docs/html/types/TTxResult.html +200 -0
  225. package/docs/html/types/TUnspentAddressScriptHashData.html +198 -0
  226. package/docs/html/types/TWalletDataKeys.html +193 -0
  227. package/docs/html/variables/defaultElectrumPorts.html +193 -0
  228. package/docs/html/variables/electrumConnection.html +199 -0
  229. package/docs/html/variables/mostUsedExchangeTickers.html +241 -0
  230. package/docs/markdown/.nojekyll +1 -0
  231. package/docs/markdown/README.md +1875 -0
  232. package/docs/markdown/classes/Electrum.md +718 -0
  233. package/docs/markdown/classes/Transaction.md +536 -0
  234. package/docs/markdown/classes/Wallet.md +2189 -0
  235. package/docs/markdown/enums/EAddressType.md +41 -0
  236. package/docs/markdown/enums/EAvailableNetworks.md +85 -0
  237. package/docs/markdown/enums/EBoostType.md +30 -0
  238. package/docs/markdown/enums/EFeeId.md +63 -0
  239. package/docs/markdown/enums/EPaymentType.md +30 -0
  240. package/docs/markdown/enums/EProtocol.md +30 -0
  241. package/docs/markdown/enums/EUnit.md +41 -0
  242. package/docs/markdown/interfaces/IAddInput.md +41 -0
  243. package/docs/markdown/interfaces/IAddress.md +69 -0
  244. package/docs/markdown/interfaces/IAddressData.md +41 -0
  245. package/docs/markdown/interfaces/IAddressType.md +7 -0
  246. package/docs/markdown/interfaces/IAddressTypeData.md +74 -0
  247. package/docs/markdown/interfaces/IAddresses.md +7 -0
  248. package/docs/markdown/interfaces/IBoostedTransaction.md +52 -0
  249. package/docs/markdown/interfaces/IBoostedTransactions.md +7 -0
  250. package/docs/markdown/interfaces/ICreateTransaction.md +30 -0
  251. package/docs/markdown/interfaces/ICustomGetAddress.md +41 -0
  252. package/docs/markdown/interfaces/ICustomGetScriptHash.md +30 -0
  253. package/docs/markdown/interfaces/IElectrumGetAddressBalanceRes.md +55 -0
  254. package/docs/markdown/interfaces/IExchangeRates.md +7 -0
  255. package/docs/markdown/interfaces/IFormattedPeerData.md +63 -0
  256. package/docs/markdown/interfaces/IFormattedTransaction.md +217 -0
  257. package/docs/markdown/interfaces/IFormattedTransactions.md +7 -0
  258. package/docs/markdown/interfaces/IGenerateAddresses.md +74 -0
  259. package/docs/markdown/interfaces/IGenerateAddressesResponse.md +30 -0
  260. package/docs/markdown/interfaces/IGetAddress.md +41 -0
  261. package/docs/markdown/interfaces/IGetAddressBalanceRes.md +36 -0
  262. package/docs/markdown/interfaces/IGetAddressByPath.md +30 -0
  263. package/docs/markdown/interfaces/IGetAddressHistoryResponse.md +121 -0
  264. package/docs/markdown/interfaces/IGetAddressResponse.md +41 -0
  265. package/docs/markdown/interfaces/IGetAddressScriptHashesHistoryResponse.md +63 -0
  266. package/docs/markdown/interfaces/IGetDerivationPath.md +100 -0
  267. package/docs/markdown/interfaces/IGetFeeEstimatesResponse.md +52 -0
  268. package/docs/markdown/interfaces/IGetHeaderResponse.md +63 -0
  269. package/docs/markdown/interfaces/IGetNextAvailableAddressResponse.md +52 -0
  270. package/docs/markdown/interfaces/IGetTransactions.md +63 -0
  271. package/docs/markdown/interfaces/IGetTransactionsFromInputs.md +63 -0
  272. package/docs/markdown/interfaces/IGetUtxosResponse.md +30 -0
  273. package/docs/markdown/interfaces/IHeader.md +41 -0
  274. package/docs/markdown/interfaces/IIndexes.md +52 -0
  275. package/docs/markdown/interfaces/IKeyDerivationPath.md +69 -0
  276. package/docs/markdown/interfaces/IKeyDerivationPathData.md +30 -0
  277. package/docs/markdown/interfaces/INewBlock.md +30 -0
  278. package/docs/markdown/interfaces/IOnchainFees.md +63 -0
  279. package/docs/markdown/interfaces/IOutput.md +41 -0
  280. package/docs/markdown/interfaces/IPeerData.md +41 -0
  281. package/docs/markdown/interfaces/IRbfData.md +74 -0
  282. package/docs/markdown/interfaces/ISend.md +30 -0
  283. package/docs/markdown/interfaces/ISendTransaction.md +184 -0
  284. package/docs/markdown/interfaces/ISendTx.md +41 -0
  285. package/docs/markdown/interfaces/ISetupTransaction.md +52 -0
  286. package/docs/markdown/interfaces/ISubscribeToAddress.md +60 -0
  287. package/docs/markdown/interfaces/ISubscribeToHeader.md +59 -0
  288. package/docs/markdown/interfaces/ITargets.md +52 -0
  289. package/docs/markdown/interfaces/ITransaction.md +88 -0
  290. package/docs/markdown/interfaces/ITxHash.md +19 -0
  291. package/docs/markdown/interfaces/ITxHashes.md +55 -0
  292. package/docs/markdown/interfaces/IUtxo.md +112 -0
  293. package/docs/markdown/interfaces/IVin.md +70 -0
  294. package/docs/markdown/interfaces/IVout.md +52 -0
  295. package/docs/markdown/interfaces/IWallet.md +209 -0
  296. package/docs/markdown/interfaces/IWalletData.md +217 -0
  297. package/example/helpers.ts +76 -0
  298. package/example/index.ts +77 -0
  299. package/package.json +69 -0
  300. package/src/electrum/constants.ts +28 -0
  301. package/src/electrum/index.ts +838 -0
  302. package/src/index.ts +6 -0
  303. package/src/shapes/electrum.ts +13 -0
  304. package/src/shapes/index.ts +2 -0
  305. package/src/shapes/wallet.ts +133 -0
  306. package/src/transaction/index.ts +1078 -0
  307. package/src/types/electrum.ts +139 -0
  308. package/src/types/index.ts +3 -0
  309. package/src/types/transaction.ts +58 -0
  310. package/src/types/wallet.ts +503 -0
  311. package/src/utils/conversion.ts +88 -0
  312. package/src/utils/derivation-path.ts +171 -0
  313. package/src/utils/electrum.ts +188 -0
  314. package/src/utils/exchange-rate.ts +70 -0
  315. package/src/utils/helpers.ts +191 -0
  316. package/src/utils/index.ts +7 -0
  317. package/src/utils/result.ts +79 -0
  318. package/src/utils/transaction.ts +417 -0
  319. package/src/utils/wallet.ts +351 -0
  320. package/src/wallet/constants.ts +24 -0
  321. package/src/wallet/index.ts +3304 -0
  322. package/tests/constants.ts +9 -0
  323. package/tests/derivation.test.ts +146 -0
  324. package/tests/electrum.test.ts +137 -0
  325. package/tests/storage.test.ts +222 -0
  326. package/tests/transaction.test.ts +187 -0
  327. package/tests/wallet.test.ts +307 -0
  328. package/tsconfig.json +32 -0
  329. package/typedoc.json +5 -0
@@ -0,0 +1,30 @@
1
+ [beignet](../README.md) / ICustomGetScriptHash
2
+
3
+ # Interface: ICustomGetScriptHash
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [address](ICustomGetScriptHash.md#address)
10
+ - [selectedNetwork](ICustomGetScriptHash.md#selectednetwork)
11
+
12
+ ## Properties
13
+
14
+ ### address
15
+
16
+ • **address**: `string`
17
+
18
+ #### Defined in
19
+
20
+ [types/wallet.ts:241](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L241)
21
+
22
+ ___
23
+
24
+ ### selectedNetwork
25
+
26
+ • `Optional` **selectedNetwork**: [`TElectrumNetworks`](../README.md#telectrumnetworks)
27
+
28
+ #### Defined in
29
+
30
+ [types/wallet.ts:242](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L242)
@@ -0,0 +1,55 @@
1
+ [beignet](../README.md) / IElectrumGetAddressBalanceRes
2
+
3
+ # Interface: IElectrumGetAddressBalanceRes
4
+
5
+ ## Hierarchy
6
+
7
+ - [`IGetAddressBalanceRes`](IGetAddressBalanceRes.md)
8
+
9
+ ↳ **`IElectrumGetAddressBalanceRes`**
10
+
11
+ ## Table of contents
12
+
13
+ ### Properties
14
+
15
+ - [confirmed](IElectrumGetAddressBalanceRes.md#confirmed)
16
+ - [error](IElectrumGetAddressBalanceRes.md#error)
17
+ - [unconfirmed](IElectrumGetAddressBalanceRes.md#unconfirmed)
18
+
19
+ ## Properties
20
+
21
+ ### confirmed
22
+
23
+ • **confirmed**: `number`
24
+
25
+ #### Inherited from
26
+
27
+ [IGetAddressBalanceRes](IGetAddressBalanceRes.md).[confirmed](IGetAddressBalanceRes.md#confirmed)
28
+
29
+ #### Defined in
30
+
31
+ [types/wallet.ts:251](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L251)
32
+
33
+ ___
34
+
35
+ ### error
36
+
37
+ • **error**: `boolean`
38
+
39
+ #### Defined in
40
+
41
+ [types/electrum.ts:14](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L14)
42
+
43
+ ___
44
+
45
+ ### unconfirmed
46
+
47
+ • **unconfirmed**: `number`
48
+
49
+ #### Inherited from
50
+
51
+ [IGetAddressBalanceRes](IGetAddressBalanceRes.md).[unconfirmed](IGetAddressBalanceRes.md#unconfirmed)
52
+
53
+ #### Defined in
54
+
55
+ [types/wallet.ts:252](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L252)
@@ -0,0 +1,7 @@
1
+ [beignet](../README.md) / IExchangeRates
2
+
3
+ # Interface: IExchangeRates
4
+
5
+ ## Indexable
6
+
7
+ ▪ [key: `string`]: \{ `currencySymbol`: `string` ; `lastUpdatedAt`: `number` ; `quote`: `string` ; `quoteName`: `string` ; `rate`: `number` }
@@ -0,0 +1,63 @@
1
+ [beignet](../README.md) / IFormattedPeerData
2
+
3
+ # Interface: IFormattedPeerData
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [host](IFormattedPeerData.md#host)
10
+ - [ip](IFormattedPeerData.md#ip)
11
+ - [ssl](IFormattedPeerData.md#ssl)
12
+ - [tcp](IFormattedPeerData.md#tcp)
13
+ - [version](IFormattedPeerData.md#version)
14
+
15
+ ## Properties
16
+
17
+ ### host
18
+
19
+ • **host**: `string`
20
+
21
+ #### Defined in
22
+
23
+ [types/electrum.ts:116](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L116)
24
+
25
+ ___
26
+
27
+ ### ip
28
+
29
+ • `Optional` **ip**: `string`
30
+
31
+ #### Defined in
32
+
33
+ [types/electrum.ts:115](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L115)
34
+
35
+ ___
36
+
37
+ ### ssl
38
+
39
+ • **ssl**: `string` \| `number`
40
+
41
+ #### Defined in
42
+
43
+ [types/electrum.ts:118](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L118)
44
+
45
+ ___
46
+
47
+ ### tcp
48
+
49
+ • **tcp**: `string` \| `number`
50
+
51
+ #### Defined in
52
+
53
+ [types/electrum.ts:119](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L119)
54
+
55
+ ___
56
+
57
+ ### version
58
+
59
+ • `Optional` **version**: `string`
60
+
61
+ #### Defined in
62
+
63
+ [types/electrum.ts:117](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L117)
@@ -0,0 +1,217 @@
1
+ [beignet](../README.md) / IFormattedTransaction
2
+
3
+ # Interface: IFormattedTransaction
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [address](IFormattedTransaction.md#address)
10
+ - [confirmTimestamp](IFormattedTransaction.md#confirmtimestamp)
11
+ - [exists](IFormattedTransaction.md#exists)
12
+ - [fee](IFormattedTransaction.md#fee)
13
+ - [height](IFormattedTransaction.md#height)
14
+ - [matchedInputValue](IFormattedTransaction.md#matchedinputvalue)
15
+ - [matchedOutputValue](IFormattedTransaction.md#matchedoutputvalue)
16
+ - [messages](IFormattedTransaction.md#messages)
17
+ - [rbf](IFormattedTransaction.md#rbf)
18
+ - [satsPerByte](IFormattedTransaction.md#satsperbyte)
19
+ - [scriptHash](IFormattedTransaction.md#scripthash)
20
+ - [timestamp](IFormattedTransaction.md#timestamp)
21
+ - [totalInputValue](IFormattedTransaction.md#totalinputvalue)
22
+ - [totalOutputValue](IFormattedTransaction.md#totaloutputvalue)
23
+ - [txid](IFormattedTransaction.md#txid)
24
+ - [type](IFormattedTransaction.md#type)
25
+ - [value](IFormattedTransaction.md#value)
26
+ - [vin](IFormattedTransaction.md#vin)
27
+ - [vsize](IFormattedTransaction.md#vsize)
28
+
29
+ ## Properties
30
+
31
+ ### address
32
+
33
+ • **address**: `string`
34
+
35
+ #### Defined in
36
+
37
+ [types/wallet.ts:82](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L82)
38
+
39
+ ___
40
+
41
+ ### confirmTimestamp
42
+
43
+ • `Optional` **confirmTimestamp**: `number`
44
+
45
+ #### Defined in
46
+
47
+ [types/wallet.ts:97](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L97)
48
+
49
+ ___
50
+
51
+ ### exists
52
+
53
+ • `Optional` **exists**: `boolean`
54
+
55
+ #### Defined in
56
+
57
+ [types/wallet.ts:98](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L98)
58
+
59
+ ___
60
+
61
+ ### fee
62
+
63
+ • **fee**: `number`
64
+
65
+ #### Defined in
66
+
67
+ [types/wallet.ts:89](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L89)
68
+
69
+ ___
70
+
71
+ ### height
72
+
73
+ • **height**: `number`
74
+
75
+ #### Defined in
76
+
77
+ [types/wallet.ts:83](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L83)
78
+
79
+ ___
80
+
81
+ ### matchedInputValue
82
+
83
+ • **matchedInputValue**: `number`
84
+
85
+ #### Defined in
86
+
87
+ [types/wallet.ts:86](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L86)
88
+
89
+ ___
90
+
91
+ ### matchedOutputValue
92
+
93
+ • **matchedOutputValue**: `number`
94
+
95
+ #### Defined in
96
+
97
+ [types/wallet.ts:88](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L88)
98
+
99
+ ___
100
+
101
+ ### messages
102
+
103
+ • **messages**: `string`[]
104
+
105
+ #### Defined in
106
+
107
+ [types/wallet.ts:94](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L94)
108
+
109
+ ___
110
+
111
+ ### rbf
112
+
113
+ • `Optional` **rbf**: `boolean`
114
+
115
+ #### Defined in
116
+
117
+ [types/wallet.ts:99](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L99)
118
+
119
+ ___
120
+
121
+ ### satsPerByte
122
+
123
+ • **satsPerByte**: `number`
124
+
125
+ #### Defined in
126
+
127
+ [types/wallet.ts:90](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L90)
128
+
129
+ ___
130
+
131
+ ### scriptHash
132
+
133
+ • **scriptHash**: `string`
134
+
135
+ #### Defined in
136
+
137
+ [types/wallet.ts:84](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L84)
138
+
139
+ ___
140
+
141
+ ### timestamp
142
+
143
+ • **timestamp**: `number`
144
+
145
+ #### Defined in
146
+
147
+ [types/wallet.ts:96](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L96)
148
+
149
+ ___
150
+
151
+ ### totalInputValue
152
+
153
+ • **totalInputValue**: `number`
154
+
155
+ #### Defined in
156
+
157
+ [types/wallet.ts:85](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L85)
158
+
159
+ ___
160
+
161
+ ### totalOutputValue
162
+
163
+ • **totalOutputValue**: `number`
164
+
165
+ #### Defined in
166
+
167
+ [types/wallet.ts:87](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L87)
168
+
169
+ ___
170
+
171
+ ### txid
172
+
173
+ • **txid**: `string`
174
+
175
+ #### Defined in
176
+
177
+ [types/wallet.ts:93](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L93)
178
+
179
+ ___
180
+
181
+ ### type
182
+
183
+ • **type**: [`EPaymentType`](../enums/EPaymentType.md)
184
+
185
+ #### Defined in
186
+
187
+ [types/wallet.ts:91](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L91)
188
+
189
+ ___
190
+
191
+ ### value
192
+
193
+ • **value**: `number`
194
+
195
+ #### Defined in
196
+
197
+ [types/wallet.ts:92](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L92)
198
+
199
+ ___
200
+
201
+ ### vin
202
+
203
+ • **vin**: [`IVin`](IVin.md)[]
204
+
205
+ #### Defined in
206
+
207
+ [types/wallet.ts:95](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L95)
208
+
209
+ ___
210
+
211
+ ### vsize
212
+
213
+ • **vsize**: `number`
214
+
215
+ #### Defined in
216
+
217
+ [types/wallet.ts:100](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L100)
@@ -0,0 +1,7 @@
1
+ [beignet](../README.md) / IFormattedTransactions
2
+
3
+ # Interface: IFormattedTransactions
4
+
5
+ ## Indexable
6
+
7
+ ▪ [key: `string`]: [`IFormattedTransaction`](IFormattedTransaction.md)
@@ -0,0 +1,74 @@
1
+ [beignet](../README.md) / IGenerateAddresses
2
+
3
+ # Interface: IGenerateAddresses
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [addressAmount](IGenerateAddresses.md#addressamount)
10
+ - [addressIndex](IGenerateAddresses.md#addressindex)
11
+ - [addressType](IGenerateAddresses.md#addresstype)
12
+ - [changeAddressAmount](IGenerateAddresses.md#changeaddressamount)
13
+ - [changeAddressIndex](IGenerateAddresses.md#changeaddressindex)
14
+ - [keyDerivationPath](IGenerateAddresses.md#keyderivationpath)
15
+
16
+ ## Properties
17
+
18
+ ### addressAmount
19
+
20
+ • `Optional` **addressAmount**: `number`
21
+
22
+ #### Defined in
23
+
24
+ [types/wallet.ts:267](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L267)
25
+
26
+ ___
27
+
28
+ ### addressIndex
29
+
30
+ • `Optional` **addressIndex**: `number`
31
+
32
+ #### Defined in
33
+
34
+ [types/wallet.ts:269](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L269)
35
+
36
+ ___
37
+
38
+ ### addressType
39
+
40
+ • `Optional` **addressType**: [`EAddressType`](../enums/EAddressType.md)
41
+
42
+ #### Defined in
43
+
44
+ [types/wallet.ts:272](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L272)
45
+
46
+ ___
47
+
48
+ ### changeAddressAmount
49
+
50
+ • `Optional` **changeAddressAmount**: `number`
51
+
52
+ #### Defined in
53
+
54
+ [types/wallet.ts:268](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L268)
55
+
56
+ ___
57
+
58
+ ### changeAddressIndex
59
+
60
+ • `Optional` **changeAddressIndex**: `number`
61
+
62
+ #### Defined in
63
+
64
+ [types/wallet.ts:270](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L270)
65
+
66
+ ___
67
+
68
+ ### keyDerivationPath
69
+
70
+ • `Optional` **keyDerivationPath**: [`IKeyDerivationPath`](IKeyDerivationPath.md)
71
+
72
+ #### Defined in
73
+
74
+ [types/wallet.ts:271](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L271)
@@ -0,0 +1,30 @@
1
+ [beignet](../README.md) / IGenerateAddressesResponse
2
+
3
+ # Interface: IGenerateAddressesResponse
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [addresses](IGenerateAddressesResponse.md#addresses)
10
+ - [changeAddresses](IGenerateAddressesResponse.md#changeaddresses)
11
+
12
+ ## Properties
13
+
14
+ ### addresses
15
+
16
+ • **addresses**: [`IAddresses`](IAddresses.md)
17
+
18
+ #### Defined in
19
+
20
+ [types/wallet.ts:281](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L281)
21
+
22
+ ___
23
+
24
+ ### changeAddresses
25
+
26
+ • **changeAddresses**: [`IAddresses`](IAddresses.md)
27
+
28
+ #### Defined in
29
+
30
+ [types/wallet.ts:282](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L282)
@@ -0,0 +1,41 @@
1
+ [beignet](../README.md) / IGetAddress
2
+
3
+ # Interface: IGetAddress
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [addressType](IGetAddress.md#addresstype)
10
+ - [changeAddress](IGetAddress.md#changeaddress)
11
+ - [index](IGetAddress.md#index)
12
+
13
+ ## Properties
14
+
15
+ ### addressType
16
+
17
+ • `Optional` **addressType**: [`EAddressType`](../enums/EAddressType.md)
18
+
19
+ #### Defined in
20
+
21
+ [types/wallet.ts:231](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L231)
22
+
23
+ ___
24
+
25
+ ### changeAddress
26
+
27
+ • `Optional` **changeAddress**: `boolean`
28
+
29
+ #### Defined in
30
+
31
+ [types/wallet.ts:230](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L230)
32
+
33
+ ___
34
+
35
+ ### index
36
+
37
+ • `Optional` **index**: `string`
38
+
39
+ #### Defined in
40
+
41
+ [types/wallet.ts:229](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L229)
@@ -0,0 +1,36 @@
1
+ [beignet](../README.md) / IGetAddressBalanceRes
2
+
3
+ # Interface: IGetAddressBalanceRes
4
+
5
+ ## Hierarchy
6
+
7
+ - **`IGetAddressBalanceRes`**
8
+
9
+ ↳ [`IElectrumGetAddressBalanceRes`](IElectrumGetAddressBalanceRes.md)
10
+
11
+ ## Table of contents
12
+
13
+ ### Properties
14
+
15
+ - [confirmed](IGetAddressBalanceRes.md#confirmed)
16
+ - [unconfirmed](IGetAddressBalanceRes.md#unconfirmed)
17
+
18
+ ## Properties
19
+
20
+ ### confirmed
21
+
22
+ • **confirmed**: `number`
23
+
24
+ #### Defined in
25
+
26
+ [types/wallet.ts:251](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L251)
27
+
28
+ ___
29
+
30
+ ### unconfirmed
31
+
32
+ • **unconfirmed**: `number`
33
+
34
+ #### Defined in
35
+
36
+ [types/wallet.ts:252](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L252)
@@ -0,0 +1,30 @@
1
+ [beignet](../README.md) / IGetAddressByPath
2
+
3
+ # Interface: IGetAddressByPath
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [addressType](IGetAddressByPath.md#addresstype)
10
+ - [path](IGetAddressByPath.md#path)
11
+
12
+ ## Properties
13
+
14
+ ### addressType
15
+
16
+ • `Optional` **addressType**: [`EAddressType`](../enums/EAddressType.md)
17
+
18
+ #### Defined in
19
+
20
+ [types/wallet.ts:247](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L247)
21
+
22
+ ___
23
+
24
+ ### path
25
+
26
+ • **path**: `string`
27
+
28
+ #### Defined in
29
+
30
+ [types/wallet.ts:246](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L246)