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,52 @@
1
+ [beignet](../README.md) / IIndexes
2
+
3
+ # Interface: IIndexes
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [addressIndex](IIndexes.md#addressindex)
10
+ - [changeAddressIndex](IIndexes.md#changeaddressindex)
11
+ - [foundAddressIndex](IIndexes.md#foundaddressindex)
12
+ - [foundChangeAddressIndex](IIndexes.md#foundchangeaddressindex)
13
+
14
+ ## Properties
15
+
16
+ ### addressIndex
17
+
18
+ • **addressIndex**: [`IAddress`](IAddress.md)
19
+
20
+ #### Defined in
21
+
22
+ [types/wallet.ts:303](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L303)
23
+
24
+ ___
25
+
26
+ ### changeAddressIndex
27
+
28
+ • **changeAddressIndex**: [`IAddress`](IAddress.md)
29
+
30
+ #### Defined in
31
+
32
+ [types/wallet.ts:304](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L304)
33
+
34
+ ___
35
+
36
+ ### foundAddressIndex
37
+
38
+ • **foundAddressIndex**: `boolean`
39
+
40
+ #### Defined in
41
+
42
+ [types/wallet.ts:305](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L305)
43
+
44
+ ___
45
+
46
+ ### foundChangeAddressIndex
47
+
48
+ • **foundChangeAddressIndex**: `boolean`
49
+
50
+ #### Defined in
51
+
52
+ [types/wallet.ts:306](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L306)
@@ -0,0 +1,69 @@
1
+ [beignet](../README.md) / IKeyDerivationPath
2
+
3
+ # Interface: IKeyDerivationPath
4
+
5
+ ## Hierarchy
6
+
7
+ - **`IKeyDerivationPath`**
8
+
9
+ ↳ [`IGetDerivationPath`](IGetDerivationPath.md)
10
+
11
+ ## Table of contents
12
+
13
+ ### Properties
14
+
15
+ - [account](IKeyDerivationPath.md#account)
16
+ - [change](IKeyDerivationPath.md#change)
17
+ - [coinType](IKeyDerivationPath.md#cointype)
18
+ - [index](IKeyDerivationPath.md#index)
19
+ - [purpose](IKeyDerivationPath.md#purpose)
20
+
21
+ ## Properties
22
+
23
+ ### account
24
+
25
+ • `Optional` **account**: `string`
26
+
27
+ #### Defined in
28
+
29
+ [types/wallet.ts:219](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L219)
30
+
31
+ ___
32
+
33
+ ### change
34
+
35
+ • `Optional` **change**: [`TKeyDerivationChange`](../README.md#tkeyderivationchange)
36
+
37
+ #### Defined in
38
+
39
+ [types/wallet.ts:220](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L220)
40
+
41
+ ___
42
+
43
+ ### coinType
44
+
45
+ • `Optional` **coinType**: `string`
46
+
47
+ #### Defined in
48
+
49
+ [types/wallet.ts:218](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L218)
50
+
51
+ ___
52
+
53
+ ### index
54
+
55
+ • `Optional` **index**: `string`
56
+
57
+ #### Defined in
58
+
59
+ [types/wallet.ts:221](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L221)
60
+
61
+ ___
62
+
63
+ ### purpose
64
+
65
+ • `Optional` **purpose**: `string`
66
+
67
+ #### Defined in
68
+
69
+ [types/wallet.ts:217](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L217)
@@ -0,0 +1,30 @@
1
+ [beignet](../README.md) / IKeyDerivationPathData
2
+
3
+ # Interface: IKeyDerivationPathData
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [pathObject](IKeyDerivationPathData.md#pathobject)
10
+ - [pathString](IKeyDerivationPathData.md#pathstring)
11
+
12
+ ## Properties
13
+
14
+ ### pathObject
15
+
16
+ • **pathObject**: [`IKeyDerivationPath`](IKeyDerivationPath.md)
17
+
18
+ #### Defined in
19
+
20
+ [types/wallet.ts:277](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L277)
21
+
22
+ ___
23
+
24
+ ### pathString
25
+
26
+ • **pathString**: `string`
27
+
28
+ #### Defined in
29
+
30
+ [types/wallet.ts:276](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L276)
@@ -0,0 +1,30 @@
1
+ [beignet](../README.md) / INewBlock
2
+
3
+ # Interface: INewBlock
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [height](INewBlock.md#height)
10
+ - [hex](INewBlock.md#hex)
11
+
12
+ ## Properties
13
+
14
+ ### height
15
+
16
+ • **height**: `number`
17
+
18
+ #### Defined in
19
+
20
+ [types/electrum.ts:68](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L68)
21
+
22
+ ___
23
+
24
+ ### hex
25
+
26
+ • **hex**: `string`
27
+
28
+ #### Defined in
29
+
30
+ [types/electrum.ts:69](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L69)
@@ -0,0 +1,63 @@
1
+ [beignet](../README.md) / IOnchainFees
2
+
3
+ # Interface: IOnchainFees
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [fast](IOnchainFees.md#fast)
10
+ - [minimum](IOnchainFees.md#minimum)
11
+ - [normal](IOnchainFees.md#normal)
12
+ - [slow](IOnchainFees.md#slow)
13
+ - [timestamp](IOnchainFees.md#timestamp)
14
+
15
+ ## Properties
16
+
17
+ ### fast
18
+
19
+ • **fast**: `number`
20
+
21
+ #### Defined in
22
+
23
+ [types/wallet.ts:428](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L428)
24
+
25
+ ___
26
+
27
+ ### minimum
28
+
29
+ • **minimum**: `number`
30
+
31
+ #### Defined in
32
+
33
+ [types/wallet.ts:431](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L431)
34
+
35
+ ___
36
+
37
+ ### normal
38
+
39
+ • **normal**: `number`
40
+
41
+ #### Defined in
42
+
43
+ [types/wallet.ts:429](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L429)
44
+
45
+ ___
46
+
47
+ ### slow
48
+
49
+ • **slow**: `number`
50
+
51
+ #### Defined in
52
+
53
+ [types/wallet.ts:430](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L430)
54
+
55
+ ___
56
+
57
+ ### timestamp
58
+
59
+ • **timestamp**: `number`
60
+
61
+ #### Defined in
62
+
63
+ [types/wallet.ts:432](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L432)
@@ -0,0 +1,41 @@
1
+ [beignet](../README.md) / IOutput
2
+
3
+ # Interface: IOutput
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [address](IOutput.md#address)
10
+ - [index](IOutput.md#index)
11
+ - [value](IOutput.md#value)
12
+
13
+ ## Properties
14
+
15
+ ### address
16
+
17
+ • **address**: `string`
18
+
19
+ #### Defined in
20
+
21
+ [types/wallet.ts:108](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L108)
22
+
23
+ ___
24
+
25
+ ### index
26
+
27
+ • **index**: `number`
28
+
29
+ #### Defined in
30
+
31
+ [types/wallet.ts:110](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L110)
32
+
33
+ ___
34
+
35
+ ### value
36
+
37
+ • **value**: `number`
38
+
39
+ #### Defined in
40
+
41
+ [types/wallet.ts:109](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L109)
@@ -0,0 +1,41 @@
1
+ [beignet](../README.md) / IPeerData
2
+
3
+ # Interface: IPeerData
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [host](IPeerData.md#host)
10
+ - [port](IPeerData.md#port)
11
+ - [protocol](IPeerData.md#protocol)
12
+
13
+ ## Properties
14
+
15
+ ### host
16
+
17
+ • **host**: `string`
18
+
19
+ #### Defined in
20
+
21
+ [types/electrum.ts:123](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L123)
22
+
23
+ ___
24
+
25
+ ### port
26
+
27
+ • **port**: `string`
28
+
29
+ #### Defined in
30
+
31
+ [types/electrum.ts:124](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L124)
32
+
33
+ ___
34
+
35
+ ### protocol
36
+
37
+ • **protocol**: [`TProtocol`](../README.md#tprotocol)
38
+
39
+ #### Defined in
40
+
41
+ [types/electrum.ts:125](https://github.com/synonymdev/beignet/blob/7c83290/src/types/electrum.ts#L125)
@@ -0,0 +1,74 @@
1
+ [beignet](../README.md) / IRbfData
2
+
3
+ # Interface: IRbfData
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [addressType](IRbfData.md#addresstype)
10
+ - [balance](IRbfData.md#balance)
11
+ - [fee](IRbfData.md#fee)
12
+ - [inputs](IRbfData.md#inputs)
13
+ - [message](IRbfData.md#message)
14
+ - [outputs](IRbfData.md#outputs)
15
+
16
+ ## Properties
17
+
18
+ ### addressType
19
+
20
+ • **addressType**: [`EAddressType`](../enums/EAddressType.md)
21
+
22
+ #### Defined in
23
+
24
+ [types/wallet.ts:488](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L488)
25
+
26
+ ___
27
+
28
+ ### balance
29
+
30
+ • **balance**: `number`
31
+
32
+ #### Defined in
33
+
34
+ [types/wallet.ts:487](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L487)
35
+
36
+ ___
37
+
38
+ ### fee
39
+
40
+ • **fee**: `number`
41
+
42
+ #### Defined in
43
+
44
+ [types/wallet.ts:489](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L489)
45
+
46
+ ___
47
+
48
+ ### inputs
49
+
50
+ • **inputs**: [`IUtxo`](IUtxo.md)[]
51
+
52
+ #### Defined in
53
+
54
+ [types/wallet.ts:490](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L490)
55
+
56
+ ___
57
+
58
+ ### message
59
+
60
+ • **message**: `string`
61
+
62
+ #### Defined in
63
+
64
+ [types/wallet.ts:491](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L491)
65
+
66
+ ___
67
+
68
+ ### outputs
69
+
70
+ • **outputs**: [`IOutput`](IOutput.md)[]
71
+
72
+ #### Defined in
73
+
74
+ [types/wallet.ts:486](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L486)
@@ -0,0 +1,30 @@
1
+ [beignet](../README.md) / ISend
2
+
3
+ # Interface: ISend
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [satsPerByte](ISend.md#satsperbyte)
10
+ - [txs](ISend.md#txs)
11
+
12
+ ## Properties
13
+
14
+ ### satsPerByte
15
+
16
+ • `Optional` **satsPerByte**: `number`
17
+
18
+ #### Defined in
19
+
20
+ [types/wallet.ts:470](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L470)
21
+
22
+ ___
23
+
24
+ ### txs
25
+
26
+ • **txs**: [`ISendTx`](ISendTx.md) \| [`ISendTx`](ISendTx.md)[]
27
+
28
+ #### Defined in
29
+
30
+ [types/wallet.ts:469](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L469)
@@ -0,0 +1,184 @@
1
+ [beignet](../README.md) / ISendTransaction
2
+
3
+ # Interface: ISendTransaction
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [boostType](ISendTransaction.md#boosttype)
10
+ - [changeAddress](ISendTransaction.md#changeaddress)
11
+ - [fee](ISendTransaction.md#fee)
12
+ - [fiatAmount](ISendTransaction.md#fiatamount)
13
+ - [inputs](ISendTransaction.md#inputs)
14
+ - [label](ISendTransaction.md#label)
15
+ - [lightningInvoice](ISendTransaction.md#lightninginvoice)
16
+ - [max](ISendTransaction.md#max)
17
+ - [message](ISendTransaction.md#message)
18
+ - [minFee](ISendTransaction.md#minfee)
19
+ - [outputs](ISendTransaction.md#outputs)
20
+ - [rbf](ISendTransaction.md#rbf)
21
+ - [satsPerByte](ISendTransaction.md#satsperbyte)
22
+ - [selectedFeeId](ISendTransaction.md#selectedfeeid)
23
+ - [slashTagsUrl](ISendTransaction.md#slashtagsurl)
24
+ - [tags](ISendTransaction.md#tags)
25
+
26
+ ## Properties
27
+
28
+ ### boostType
29
+
30
+ • **boostType**: [`EBoostType`](../enums/EBoostType.md)
31
+
32
+ #### Defined in
33
+
34
+ [types/wallet.ts:129](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L129)
35
+
36
+ ___
37
+
38
+ ### changeAddress
39
+
40
+ • **changeAddress**: `string`
41
+
42
+ #### Defined in
43
+
44
+ [types/wallet.ts:121](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L121)
45
+
46
+ ___
47
+
48
+ ### fee
49
+
50
+ • **fee**: `number`
51
+
52
+ #### Defined in
53
+
54
+ [types/wallet.ts:123](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L123)
55
+
56
+ ___
57
+
58
+ ### fiatAmount
59
+
60
+ • **fiatAmount**: `number`
61
+
62
+ #### Defined in
63
+
64
+ [types/wallet.ts:122](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L122)
65
+
66
+ ___
67
+
68
+ ### inputs
69
+
70
+ • **inputs**: [`IUtxo`](IUtxo.md)[]
71
+
72
+ #### Defined in
73
+
74
+ [types/wallet.ts:120](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L120)
75
+
76
+ ___
77
+
78
+ ### label
79
+
80
+ • **label**: `string`
81
+
82
+ #### Defined in
83
+
84
+ [types/wallet.ts:127](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L127)
85
+
86
+ ___
87
+
88
+ ### lightningInvoice
89
+
90
+ • `Optional` **lightningInvoice**: `string`
91
+
92
+ #### Defined in
93
+
94
+ [types/wallet.ts:134](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L134)
95
+
96
+ ___
97
+
98
+ ### max
99
+
100
+ • **max**: `boolean`
101
+
102
+ #### Defined in
103
+
104
+ [types/wallet.ts:131](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L131)
105
+
106
+ ___
107
+
108
+ ### message
109
+
110
+ • **message**: `string`
111
+
112
+ #### Defined in
113
+
114
+ [types/wallet.ts:126](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L126)
115
+
116
+ ___
117
+
118
+ ### minFee
119
+
120
+ • **minFee**: `number`
121
+
122
+ #### Defined in
123
+
124
+ [types/wallet.ts:130](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L130)
125
+
126
+ ___
127
+
128
+ ### outputs
129
+
130
+ • **outputs**: [`IOutput`](IOutput.md)[]
131
+
132
+ #### Defined in
133
+
134
+ [types/wallet.ts:119](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L119)
135
+
136
+ ___
137
+
138
+ ### rbf
139
+
140
+ • **rbf**: `boolean`
141
+
142
+ #### Defined in
143
+
144
+ [types/wallet.ts:128](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L128)
145
+
146
+ ___
147
+
148
+ ### satsPerByte
149
+
150
+ • **satsPerByte**: `number`
151
+
152
+ #### Defined in
153
+
154
+ [types/wallet.ts:124](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L124)
155
+
156
+ ___
157
+
158
+ ### selectedFeeId
159
+
160
+ • **selectedFeeId**: [`EFeeId`](../enums/EFeeId.md)
161
+
162
+ #### Defined in
163
+
164
+ [types/wallet.ts:125](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L125)
165
+
166
+ ___
167
+
168
+ ### slashTagsUrl
169
+
170
+ • `Optional` **slashTagsUrl**: `string`
171
+
172
+ #### Defined in
173
+
174
+ [types/wallet.ts:133](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L133)
175
+
176
+ ___
177
+
178
+ ### tags
179
+
180
+ • **tags**: `string`[]
181
+
182
+ #### Defined in
183
+
184
+ [types/wallet.ts:132](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L132)
@@ -0,0 +1,41 @@
1
+ [beignet](../README.md) / ISendTx
2
+
3
+ # Interface: ISendTx
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [address](ISendTx.md#address)
10
+ - [amount](ISendTx.md#amount)
11
+ - [message](ISendTx.md#message)
12
+
13
+ ## Properties
14
+
15
+ ### address
16
+
17
+ • **address**: `string`
18
+
19
+ #### Defined in
20
+
21
+ [types/wallet.ts:463](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L463)
22
+
23
+ ___
24
+
25
+ ### amount
26
+
27
+ • **amount**: `number`
28
+
29
+ #### Defined in
30
+
31
+ [types/wallet.ts:464](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L464)
32
+
33
+ ___
34
+
35
+ ### message
36
+
37
+ • `Optional` **message**: `string`
38
+
39
+ #### Defined in
40
+
41
+ [types/wallet.ts:465](https://github.com/synonymdev/beignet/blob/7c83290/src/types/wallet.ts#L465)
@@ -0,0 +1,52 @@
1
+ [beignet](../README.md) / ISetupTransaction
2
+
3
+ # Interface: ISetupTransaction
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [inputTxHashes](ISetupTransaction.md#inputtxhashes)
10
+ - [rbf](ISetupTransaction.md#rbf)
11
+ - [satsPerByte](ISetupTransaction.md#satsperbyte)
12
+ - [utxos](ISetupTransaction.md#utxos)
13
+
14
+ ## Properties
15
+
16
+ ### inputTxHashes
17
+
18
+ • `Optional` **inputTxHashes**: `string`[]
19
+
20
+ #### Defined in
21
+
22
+ [types/transaction.ts:25](https://github.com/synonymdev/beignet/blob/7c83290/src/types/transaction.ts#L25)
23
+
24
+ ___
25
+
26
+ ### rbf
27
+
28
+ • `Optional` **rbf**: `boolean`
29
+
30
+ #### Defined in
31
+
32
+ [types/transaction.ts:27](https://github.com/synonymdev/beignet/blob/7c83290/src/types/transaction.ts#L27)
33
+
34
+ ___
35
+
36
+ ### satsPerByte
37
+
38
+ • `Optional` **satsPerByte**: `number`
39
+
40
+ #### Defined in
41
+
42
+ [types/transaction.ts:28](https://github.com/synonymdev/beignet/blob/7c83290/src/types/transaction.ts#L28)
43
+
44
+ ___
45
+
46
+ ### utxos
47
+
48
+ • `Optional` **utxos**: [`IUtxo`](IUtxo.md)[]
49
+
50
+ #### Defined in
51
+
52
+ [types/transaction.ts:26](https://github.com/synonymdev/beignet/blob/7c83290/src/types/transaction.ts#L26)