@atomiqlabs/sdk 8.9.1 → 8.9.3

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 (366) hide show
  1. package/LICENSE +201 -201
  2. package/README.md +1760 -1760
  3. package/api/index.d.ts +1 -1
  4. package/api/index.js +3 -3
  5. package/dist/ApiList.d.ts +37 -37
  6. package/dist/ApiList.js +30 -30
  7. package/dist/SmartChainAssets.d.ts +181 -181
  8. package/dist/SmartChainAssets.js +181 -181
  9. package/dist/api/ApiEndpoints.d.ts +393 -393
  10. package/dist/api/ApiEndpoints.js +2 -2
  11. package/dist/api/ApiParser.d.ts +10 -10
  12. package/dist/api/ApiParser.js +134 -134
  13. package/dist/api/ApiTypes.d.ts +157 -157
  14. package/dist/api/ApiTypes.js +75 -75
  15. package/dist/api/SerializedAction.d.ts +40 -40
  16. package/dist/api/SerializedAction.js +59 -59
  17. package/dist/api/SwapperApi.d.ts +50 -50
  18. package/dist/api/SwapperApi.js +431 -431
  19. package/dist/api/index.d.ts +5 -5
  20. package/dist/api/index.js +24 -24
  21. package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
  22. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  23. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
  24. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  25. package/dist/bitcoin/coinselect2/index.d.ts +20 -20
  26. package/dist/bitcoin/coinselect2/index.js +69 -69
  27. package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
  28. package/dist/bitcoin/coinselect2/utils.js +158 -158
  29. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
  30. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
  31. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
  32. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  33. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
  34. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
  35. package/dist/enums/FeeType.d.ts +15 -15
  36. package/dist/enums/FeeType.js +19 -19
  37. package/dist/enums/SwapAmountType.d.ts +15 -15
  38. package/dist/enums/SwapAmountType.js +19 -19
  39. package/dist/enums/SwapDirection.d.ts +15 -15
  40. package/dist/enums/SwapDirection.js +19 -19
  41. package/dist/enums/SwapSide.d.ts +15 -15
  42. package/dist/enums/SwapSide.js +19 -19
  43. package/dist/enums/SwapType.d.ts +75 -75
  44. package/dist/enums/SwapType.js +79 -79
  45. package/dist/errors/IntermediaryError.d.ts +13 -13
  46. package/dist/errors/IntermediaryError.js +27 -27
  47. package/dist/errors/RequestError.d.ts +32 -32
  48. package/dist/errors/RequestError.js +54 -54
  49. package/dist/errors/UserError.d.ts +8 -8
  50. package/dist/errors/UserError.js +16 -16
  51. package/dist/events/UnifiedSwapEventListener.d.ts +24 -24
  52. package/dist/events/UnifiedSwapEventListener.js +138 -138
  53. package/dist/http/HttpUtils.d.ts +29 -29
  54. package/dist/http/HttpUtils.js +97 -97
  55. package/dist/http/paramcoders/IParamReader.d.ts +8 -8
  56. package/dist/http/paramcoders/IParamReader.js +2 -2
  57. package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
  58. package/dist/http/paramcoders/ParamDecoder.js +137 -137
  59. package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
  60. package/dist/http/paramcoders/ParamEncoder.js +36 -36
  61. package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
  62. package/dist/http/paramcoders/SchemaVerifier.js +145 -145
  63. package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
  64. package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
  65. package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
  66. package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
  67. package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +17 -17
  68. package/dist/http/paramcoders/client/StreamingFetchPromise.js +175 -175
  69. package/dist/index.d.ts +86 -86
  70. package/dist/index.js +159 -159
  71. package/dist/intermediaries/Intermediary.d.ts +178 -178
  72. package/dist/intermediaries/Intermediary.js +166 -166
  73. package/dist/intermediaries/IntermediaryDiscovery.d.ts +216 -216
  74. package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
  75. package/dist/intermediaries/apis/IntermediaryAPI.d.ts +607 -607
  76. package/dist/intermediaries/apis/IntermediaryAPI.js +764 -764
  77. package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
  78. package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
  79. package/dist/intermediaries/auth/SignedKeyBasedAuth.d.ts +14 -14
  80. package/dist/intermediaries/auth/SignedKeyBasedAuth.js +68 -68
  81. package/dist/lnurl/LNURL.d.ts +102 -102
  82. package/dist/lnurl/LNURL.js +321 -321
  83. package/dist/prices/RedundantSwapPrice.d.ts +110 -110
  84. package/dist/prices/RedundantSwapPrice.js +222 -222
  85. package/dist/prices/SingleSwapPrice.d.ts +34 -34
  86. package/dist/prices/SingleSwapPrice.js +44 -44
  87. package/dist/prices/SwapPriceWithChain.d.ts +107 -107
  88. package/dist/prices/SwapPriceWithChain.js +128 -128
  89. package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
  90. package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
  91. package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
  92. package/dist/prices/abstract/IPriceProvider.js +74 -74
  93. package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
  94. package/dist/prices/abstract/ISwapPrice.js +279 -279
  95. package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
  96. package/dist/prices/providers/BinancePriceProvider.js +30 -30
  97. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
  98. package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
  99. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
  100. package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
  101. package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
  102. package/dist/prices/providers/CustomPriceProvider.js +35 -35
  103. package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
  104. package/dist/prices/providers/KrakenPriceProvider.js +45 -45
  105. package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
  106. package/dist/prices/providers/OKXPriceProvider.js +29 -29
  107. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
  108. package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
  109. package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
  110. package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
  111. package/dist/storage/IUnifiedStorage.d.ts +127 -127
  112. package/dist/storage/IUnifiedStorage.js +2 -2
  113. package/dist/storage/UnifiedSwapStorage.d.ts +120 -120
  114. package/dist/storage/UnifiedSwapStorage.js +154 -154
  115. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
  116. package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
  117. package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
  118. package/dist/storage-browser/LocalStorageManager.js +93 -93
  119. package/dist/swapper/Swapper.d.ts +770 -770
  120. package/dist/swapper/Swapper.js +1758 -1758
  121. package/dist/swapper/SwapperFactory.d.ts +135 -135
  122. package/dist/swapper/SwapperFactory.js +162 -162
  123. package/dist/swapper/SwapperUtils.d.ts +222 -222
  124. package/dist/swapper/SwapperUtils.js +519 -519
  125. package/dist/swapper/SwapperWithChain.d.ts +404 -404
  126. package/dist/swapper/SwapperWithChain.js +469 -469
  127. package/dist/swapper/SwapperWithSigner.d.ts +322 -322
  128. package/dist/swapper/SwapperWithSigner.js +318 -318
  129. package/dist/swaps/IAddressSwap.d.ts +22 -22
  130. package/dist/swaps/IAddressSwap.js +14 -14
  131. package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
  132. package/dist/swaps/IBTCWalletSwap.js +18 -18
  133. package/dist/swaps/IClaimableSwap.d.ts +49 -49
  134. package/dist/swaps/IClaimableSwap.js +15 -15
  135. package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
  136. package/dist/swaps/IClaimableSwapWrapper.js +2 -2
  137. package/dist/swaps/IRefundableSwap.d.ts +43 -43
  138. package/dist/swaps/IRefundableSwap.js +14 -14
  139. package/dist/swaps/ISwap.d.ts +453 -453
  140. package/dist/swaps/ISwap.js +371 -371
  141. package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
  142. package/dist/swaps/ISwapWithGasDrop.js +12 -12
  143. package/dist/swaps/ISwapWrapper.d.ts +295 -295
  144. package/dist/swaps/ISwapWrapper.js +373 -373
  145. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
  146. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
  147. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
  148. package/dist/swaps/escrow_swaps/IEscrowSwap.js +172 -172
  149. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +129 -129
  150. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
  151. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +107 -107
  152. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +130 -130
  153. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
  154. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
  155. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
  156. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
  157. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +547 -547
  158. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1419 -1419
  159. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +192 -192
  160. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
  161. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +650 -650
  162. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1577 -1577
  163. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +237 -237
  164. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
  165. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +491 -491
  166. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1463 -1463
  167. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +204 -204
  168. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
  169. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +446 -446
  170. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +1097 -1097
  171. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
  172. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
  173. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
  174. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
  175. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +252 -252
  176. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +535 -535
  177. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
  178. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
  179. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +134 -134
  180. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
  181. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +694 -694
  182. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1687 -1687
  183. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +259 -259
  184. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
  185. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +302 -302
  186. package/dist/swaps/trusted/ln/LnForGasSwap.js +625 -625
  187. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
  188. package/dist/swaps/trusted/ln/LnForGasWrapper.js +82 -82
  189. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +343 -343
  190. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +698 -698
  191. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +71 -71
  192. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
  193. package/dist/types/AmountData.d.ts +10 -10
  194. package/dist/types/AmountData.js +2 -2
  195. package/dist/types/CustomPriceFunction.d.ts +11 -11
  196. package/dist/types/CustomPriceFunction.js +2 -2
  197. package/dist/types/PriceInfoType.d.ts +28 -28
  198. package/dist/types/PriceInfoType.js +57 -57
  199. package/dist/types/SwapExecutionAction.d.ts +195 -195
  200. package/dist/types/SwapExecutionAction.js +106 -106
  201. package/dist/types/SwapExecutionStep.d.ts +144 -144
  202. package/dist/types/SwapExecutionStep.js +87 -87
  203. package/dist/types/SwapStateInfo.d.ts +5 -5
  204. package/dist/types/SwapStateInfo.js +2 -2
  205. package/dist/types/SwapWithSigner.d.ts +17 -17
  206. package/dist/types/SwapWithSigner.js +43 -43
  207. package/dist/types/Token.d.ts +99 -99
  208. package/dist/types/Token.js +76 -76
  209. package/dist/types/TokenAmount.d.ts +75 -75
  210. package/dist/types/TokenAmount.js +85 -85
  211. package/dist/types/fees/Fee.d.ts +50 -50
  212. package/dist/types/fees/Fee.js +2 -2
  213. package/dist/types/fees/FeeBreakdown.d.ts +11 -11
  214. package/dist/types/fees/FeeBreakdown.js +2 -2
  215. package/dist/types/fees/PercentagePPM.d.ts +17 -17
  216. package/dist/types/fees/PercentagePPM.js +18 -18
  217. package/dist/types/lnurl/LNURLPay.d.ts +61 -61
  218. package/dist/types/lnurl/LNURLPay.js +31 -31
  219. package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
  220. package/dist/types/lnurl/LNURLWithdraw.js +27 -27
  221. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
  222. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
  223. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
  224. package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
  225. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
  226. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
  227. package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
  228. package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
  229. package/dist/utils/BitcoinUtils.d.ts +18 -18
  230. package/dist/utils/BitcoinUtils.js +174 -174
  231. package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
  232. package/dist/utils/BitcoinWalletUtils.js +14 -14
  233. package/dist/utils/Logger.d.ts +7 -7
  234. package/dist/utils/Logger.js +12 -12
  235. package/dist/utils/RetryUtils.d.ts +22 -22
  236. package/dist/utils/RetryUtils.js +67 -67
  237. package/dist/utils/SwapUtils.d.ts +88 -88
  238. package/dist/utils/SwapUtils.js +72 -72
  239. package/dist/utils/TimeoutUtils.d.ts +17 -17
  240. package/dist/utils/TimeoutUtils.js +55 -55
  241. package/dist/utils/TokenUtils.d.ts +19 -19
  242. package/dist/utils/TokenUtils.js +37 -37
  243. package/dist/utils/TypeUtils.d.ts +7 -7
  244. package/dist/utils/TypeUtils.js +2 -2
  245. package/dist/utils/Utils.d.ts +69 -69
  246. package/dist/utils/Utils.js +214 -214
  247. package/package.json +46 -46
  248. package/src/SmartChainAssets.ts +186 -186
  249. package/src/api/ApiEndpoints.ts +427 -427
  250. package/src/api/ApiParser.ts +138 -138
  251. package/src/api/ApiTypes.ts +229 -229
  252. package/src/api/SerializedAction.ts +97 -97
  253. package/src/api/SwapperApi.ts +545 -545
  254. package/src/api/index.ts +5 -5
  255. package/src/bitcoin/coinselect2/accumulative.ts +69 -69
  256. package/src/bitcoin/coinselect2/blackjack.ts +50 -50
  257. package/src/bitcoin/coinselect2/index.ts +93 -93
  258. package/src/bitcoin/coinselect2/utils.ts +236 -236
  259. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
  260. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
  261. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
  262. package/src/enums/FeeType.ts +15 -15
  263. package/src/enums/SwapAmountType.ts +16 -16
  264. package/src/enums/SwapDirection.ts +15 -15
  265. package/src/enums/SwapSide.ts +16 -16
  266. package/src/enums/SwapType.ts +75 -75
  267. package/src/errors/IntermediaryError.ts +28 -28
  268. package/src/errors/RequestError.ts +64 -64
  269. package/src/errors/UserError.ts +15 -15
  270. package/src/events/UnifiedSwapEventListener.ts +181 -181
  271. package/src/http/HttpUtils.ts +97 -97
  272. package/src/http/paramcoders/IParamReader.ts +9 -9
  273. package/src/http/paramcoders/ParamDecoder.ts +145 -145
  274. package/src/http/paramcoders/ParamEncoder.ts +40 -40
  275. package/src/http/paramcoders/SchemaVerifier.ts +153 -153
  276. package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
  277. package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
  278. package/src/http/paramcoders/client/StreamingFetchPromise.ts +194 -194
  279. package/src/index.ts +141 -141
  280. package/src/intermediaries/Intermediary.ts +280 -280
  281. package/src/intermediaries/IntermediaryDiscovery.ts +548 -548
  282. package/src/intermediaries/apis/IntermediaryAPI.ts +1247 -1247
  283. package/src/intermediaries/auth/SignedKeyBasedAuth.ts +69 -69
  284. package/src/lnurl/LNURL.ts +402 -402
  285. package/src/prices/RedundantSwapPrice.ts +264 -264
  286. package/src/prices/SingleSwapPrice.ts +50 -50
  287. package/src/prices/SwapPriceWithChain.ts +194 -194
  288. package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
  289. package/src/prices/abstract/IPriceProvider.ts +127 -127
  290. package/src/prices/abstract/ISwapPrice.ts +390 -390
  291. package/src/prices/providers/BinancePriceProvider.ts +48 -48
  292. package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
  293. package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
  294. package/src/prices/providers/CustomPriceProvider.ts +40 -40
  295. package/src/prices/providers/KrakenPriceProvider.ts +83 -83
  296. package/src/prices/providers/OKXPriceProvider.ts +59 -59
  297. package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
  298. package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
  299. package/src/storage/IUnifiedStorage.ts +136 -136
  300. package/src/storage/UnifiedSwapStorage.ts +175 -175
  301. package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
  302. package/src/storage-browser/LocalStorageManager.ts +106 -106
  303. package/src/swapper/Swapper.ts +2570 -2570
  304. package/src/swapper/SwapperFactory.ts +307 -307
  305. package/src/swapper/SwapperUtils.ts +610 -610
  306. package/src/swapper/SwapperWithChain.ts +707 -707
  307. package/src/swapper/SwapperWithSigner.ts +511 -511
  308. package/src/swaps/IAddressSwap.ts +30 -30
  309. package/src/swaps/IBTCWalletSwap.ts +92 -92
  310. package/src/swaps/IClaimableSwap.ts +65 -65
  311. package/src/swaps/IClaimableSwapWrapper.ts +17 -17
  312. package/src/swaps/IRefundableSwap.ts +58 -58
  313. package/src/swaps/ISwap.ts +775 -775
  314. package/src/swaps/ISwapWithGasDrop.ts +25 -25
  315. package/src/swaps/ISwapWrapper.ts +564 -564
  316. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
  317. package/src/swaps/escrow_swaps/IEscrowSwap.ts +271 -271
  318. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +284 -284
  319. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +172 -172
  320. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
  321. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
  322. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1670 -1671
  323. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +603 -603
  324. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1883 -1883
  325. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +752 -752
  326. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1753 -1753
  327. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +612 -612
  328. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1327 -1327
  329. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
  330. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
  331. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +787 -787
  332. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
  333. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +403 -403
  334. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +2148 -2148
  335. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1238 -1238
  336. package/src/swaps/trusted/ln/LnForGasSwap.ts +753 -753
  337. package/src/swaps/trusted/ln/LnForGasWrapper.ts +90 -90
  338. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +843 -843
  339. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +133 -133
  340. package/src/types/AmountData.ts +9 -9
  341. package/src/types/CustomPriceFunction.ts +11 -11
  342. package/src/types/PriceInfoType.ts +66 -66
  343. package/src/types/SwapExecutionAction.ts +323 -323
  344. package/src/types/SwapExecutionStep.ts +224 -224
  345. package/src/types/SwapStateInfo.ts +6 -6
  346. package/src/types/SwapWithSigner.ts +61 -61
  347. package/src/types/Token.ts +163 -163
  348. package/src/types/TokenAmount.ts +167 -167
  349. package/src/types/fees/Fee.ts +56 -56
  350. package/src/types/fees/FeeBreakdown.ts +11 -11
  351. package/src/types/fees/PercentagePPM.ts +26 -26
  352. package/src/types/lnurl/LNURLPay.ts +79 -79
  353. package/src/types/lnurl/LNURLWithdraw.ts +61 -61
  354. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
  355. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
  356. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
  357. package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
  358. package/src/utils/BitcoinUtils.ts +164 -164
  359. package/src/utils/BitcoinWalletUtils.ts +15 -15
  360. package/src/utils/Logger.ts +14 -14
  361. package/src/utils/RetryUtils.ts +78 -78
  362. package/src/utils/SwapUtils.ts +99 -99
  363. package/src/utils/TimeoutUtils.ts +49 -49
  364. package/src/utils/TokenUtils.ts +33 -33
  365. package/src/utils/TypeUtils.ts +8 -8
  366. package/src/utils/Utils.ts +221 -221
@@ -1,390 +1,390 @@
1
- import {ChainIds, MultiChain} from "../../swapper/Swapper";
2
- import {Token} from "../../types/Token";
3
- import {PriceInfoType} from "../../types/PriceInfoType";
4
-
5
- /**
6
- * Abstract base class for swap pricing implementations
7
- *
8
- * @category Pricing
9
- */
10
- export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
11
-
12
- maxAllowedFeeDifferencePPM: bigint;
13
-
14
- protected constructor(maxAllowedFeeDifferencePPM: bigint) {
15
- this.maxAllowedFeeDifferencePPM = maxAllowedFeeDifferencePPM;
16
- }
17
-
18
- /**
19
- * Gets the decimal places for a given token, returns `-1` if token should be ignored & `null` if token is not found
20
- *
21
- * @param chainIdentifier Chain identifier of the smart chain
22
- * @param tokenAddress Token address
23
- * @protected
24
- */
25
- protected abstract getDecimals<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): number | null;
26
-
27
- /**
28
- * Returns the price of the token in BTC uSats (microSats)
29
- *
30
- * @param chainIdentifier Chain identifier of the smart chain
31
- * @param tokenAddress Token address
32
- * @param abortSignal
33
- * @protected
34
- */
35
- protected abstract getPrice<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string, abortSignal?: AbortSignal): Promise<bigint>;
36
-
37
- /**
38
- * Returns the price of bitcoin in USD (sats/USD)
39
- *
40
- * @param abortSignal
41
- * @protected
42
- */
43
- protected abstract getUsdPrice(abortSignal?: AbortSignal): Promise<number>;
44
-
45
- /**
46
- * Gets the decimal places for a given token, returns `-1` if token should be ignored & throws if token is not found
47
- *
48
- * @param chainIdentifier Chain identifier of the smart chain
49
- * @param tokenAddress Token address
50
- * @throws {Error} When token is not known
51
- * @protected
52
- */
53
- protected getDecimalsThrowing<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): number {
54
- const decimals = this.getDecimals(chainIdentifier, tokenAddress);
55
- if(decimals==null) throw new Error(`Cannot get decimal count for token ${chainIdentifier}:${tokenAddress}!`);
56
- return decimals;
57
- }
58
-
59
- /**
60
- * Recomputes pricing info without fetching the current price
61
- *
62
- * @param chainIdentifier Chain identifier of the smart chain
63
- * @param amountSats Amount of sats (BTC) to be received from the swap
64
- * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
65
- * @param feePPM PPM fee rate as reported by the intermediary
66
- * @param paidToken Amount of token to be paid to the swap
67
- * @param tokenAddress Token address to be paid
68
- */
69
- public recomputePriceInfoSend<C extends ChainIds<T>>(
70
- chainIdentifier: C,
71
- amountSats: bigint,
72
- satsBaseFee: bigint,
73
- feePPM: bigint,
74
- paidToken: bigint,
75
- tokenAddress: string
76
- ): PriceInfoType {
77
- const totalSats = (amountSats * (1000000n + feePPM) / 1000000n)
78
- + satsBaseFee;
79
- const totalUSats = totalSats * 1000000n;
80
- const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / paidToken;
81
-
82
- return {
83
- isValid: true,
84
- differencePPM: 0n,
85
- satsBaseFee,
86
- feePPM,
87
- realPriceUSatPerToken: this.shouldIgnore(chainIdentifier, tokenAddress) ? undefined : swapPriceUSatPerToken,
88
- swapPriceUSatPerToken
89
- };
90
- }
91
-
92
- /**
93
- * Checks whether the swap amounts are valid given the current market rate for a given pair
94
- *
95
- * @param chainIdentifier Chain identifier of the smart chain
96
- * @param amountSats Amount of sats (BTC) to be received from the swap
97
- * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
98
- * @param feePPM PPM fee rate as reported by the intermediary
99
- * @param paidToken Amount of token to be paid to the swap
100
- * @param tokenAddress Token address to be paid
101
- * @param abortSignal
102
- * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
103
- * @param realSwapFeeSats
104
- */
105
- public async isValidAmountSend<C extends ChainIds<T>>(
106
- chainIdentifier: C,
107
- amountSats: bigint,
108
- satsBaseFee: bigint,
109
- feePPM: bigint,
110
- paidToken: bigint,
111
- tokenAddress: string,
112
- abortSignal?: AbortSignal,
113
- preFetchedPrice?: bigint | null,
114
- realSwapFeeSats?: bigint
115
- ): Promise<PriceInfoType> {
116
- if(realSwapFeeSats!=undefined && realSwapFeeSats<0) throw new Error("Invalid swap fee! Swap fee cannot be negative!");
117
- const totalSats = realSwapFeeSats!=undefined
118
- ? amountSats + realSwapFeeSats
119
- : (amountSats * (1000000n + feePPM) / 1000000n) + satsBaseFee;
120
- const totalUSats = totalSats * 1000000n;
121
-
122
- const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / paidToken;
123
-
124
- if(this.shouldIgnore(chainIdentifier, tokenAddress)) return {
125
- isValid: true,
126
- differencePPM: 0n,
127
- satsBaseFee,
128
- feePPM,
129
- realPriceUSatPerToken: undefined,
130
- swapPriceUSatPerToken
131
- };
132
-
133
- const calculatedAmtInToken = await this.getFromBtcSwapAmount(chainIdentifier, totalSats, tokenAddress, abortSignal, preFetchedPrice);
134
- const realPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / calculatedAmtInToken;
135
-
136
- const difference = paidToken - calculatedAmtInToken; //Will be >0 if we need to pay more than we should've
137
- const differencePPM = difference * 1000000n / calculatedAmtInToken;
138
-
139
- return {
140
- isValid: differencePPM <= this.maxAllowedFeeDifferencePPM,
141
- differencePPM,
142
- satsBaseFee,
143
- feePPM,
144
- realPriceUSatPerToken,
145
- swapPriceUSatPerToken
146
- };
147
- }
148
-
149
- /**
150
- * Recomputes pricing info without fetching the current price
151
- *
152
- * @param chainIdentifier Chain identifier of the smart chain
153
- * @param amountSats Amount of sats (BTC) to be paid to the swap
154
- * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
155
- * @param feePPM PPM fee rate as reported by the intermediary
156
- * @param receiveToken Amount of token to be received from the swap
157
- * @param tokenAddress Token address to be received
158
- */
159
- public recomputePriceInfoReceive<C extends ChainIds<T>>(
160
- chainIdentifier: C,
161
- amountSats: bigint,
162
- satsBaseFee: bigint,
163
- feePPM: bigint,
164
- receiveToken: bigint,
165
- tokenAddress: string,
166
- ): PriceInfoType {
167
- const totalSats = (amountSats * (1000000n - feePPM) / 1000000n)
168
- - satsBaseFee;
169
- const totalUSats = totalSats * 1000000n;
170
- const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / receiveToken;
171
-
172
- return {
173
- isValid: true,
174
- differencePPM: 0n,
175
- satsBaseFee,
176
- feePPM,
177
- realPriceUSatPerToken: this.shouldIgnore(chainIdentifier, tokenAddress) ? undefined : swapPriceUSatPerToken,
178
- swapPriceUSatPerToken
179
- };
180
- }
181
-
182
- /**
183
- * Checks whether the swap amounts are valid given the current market rate for a given pair
184
- *
185
- * @param chainIdentifier Chain identifier of the smart chain
186
- * @param amountSats Amount of sats (BTC) to be paid to the swap
187
- * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
188
- * @param feePPM PPM fee rate as reported by the intermediary
189
- * @param receiveToken Amount of token to be received from the swap
190
- * @param tokenAddress Token address to be received
191
- * @param abortSignal
192
- * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
193
- * @param realSwapFeeSats
194
- */
195
- public async isValidAmountReceive<C extends ChainIds<T>>(
196
- chainIdentifier: C,
197
- amountSats: bigint,
198
- satsBaseFee: bigint,
199
- feePPM: bigint,
200
- receiveToken: bigint,
201
- tokenAddress: string,
202
- abortSignal?: AbortSignal,
203
- preFetchedPrice?: bigint | null,
204
- realSwapFeeSats?: bigint
205
- ): Promise<PriceInfoType> {
206
- if(realSwapFeeSats!=undefined) {
207
- if(realSwapFeeSats>=amountSats) throw new Error("Invalid swap fee! Larger than or equal to total output amount!");
208
- if(realSwapFeeSats<0) throw new Error("Invalid swap fee! Must be non-negative!");
209
- }
210
- const totalSats = realSwapFeeSats!=undefined
211
- ? amountSats - realSwapFeeSats
212
- : (amountSats * (1000000n - feePPM) / 1000000n) - satsBaseFee;
213
- const totalUSats = totalSats * 1000000n;
214
-
215
- const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / receiveToken;
216
-
217
- if(this.shouldIgnore(chainIdentifier, tokenAddress)) return {
218
- isValid: true,
219
- differencePPM: 0n,
220
- satsBaseFee,
221
- feePPM,
222
- realPriceUSatPerToken: undefined,
223
- swapPriceUSatPerToken
224
- };
225
-
226
- const calculatedAmtInToken = await this.getFromBtcSwapAmount(chainIdentifier, totalSats, tokenAddress, abortSignal, preFetchedPrice);
227
- const realPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / calculatedAmtInToken;
228
-
229
- const difference = calculatedAmtInToken - receiveToken; //Will be >0 if we receive less than we should've
230
- const differencePPM = difference * 100000n / calculatedAmtInToken;
231
-
232
- return {
233
- isValid: differencePPM <= this.maxAllowedFeeDifferencePPM,
234
- differencePPM,
235
- satsBaseFee,
236
- feePPM,
237
- realPriceUSatPerToken,
238
- swapPriceUSatPerToken
239
- };
240
- }
241
-
242
- /**
243
- * Pre-fetches the pricing data for a given token, such that further calls to {@link isValidAmountReceive} or
244
- * {@link isValidAmountSend} are quicker and don't need to wait for the price fetch
245
- *
246
- * @param chainIdentifier Chain identifier of the smart chain
247
- * @param tokenAddress Token address
248
- * @param abortSignal
249
- */
250
- public preFetchPrice<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string, abortSignal?: AbortSignal): Promise<bigint> {
251
- return this.getPrice(chainIdentifier, tokenAddress, abortSignal);
252
- }
253
-
254
- /**
255
- * Pre-fetches the Bitcoin USD price data, such that further calls to {@link getBtcUsdValue},
256
- * {@link getTokenUsdValue} or {@link getUsdValue} are quicker and don't need to wait for the price fetch
257
- *
258
- * @param abortSignal
259
- */
260
- public preFetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
261
- return this.getUsdPrice(abortSignal);
262
- }
263
-
264
- /**
265
- * Returns amount of `toToken` that is equivalent to `fromAmount` satoshis
266
- *
267
- * @param chainIdentifier Chain identifier string for the smart chain
268
- * @param fromAmount Amount of satoshis
269
- * @param toToken Token address
270
- * @param abortSignal
271
- * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
272
- * @throws {Error} when token is not found
273
- */
274
- public async getFromBtcSwapAmount<C extends ChainIds<T>>(
275
- chainIdentifier: C,
276
- fromAmount: bigint,
277
- toToken: string,
278
- abortSignal?: AbortSignal,
279
- preFetchedPrice?: bigint | null
280
- ): Promise<bigint> {
281
- if(this.getDecimals(chainIdentifier, toToken.toString())==null) throw new Error("Token not found!");
282
-
283
- const price = preFetchedPrice || await this.getPrice(chainIdentifier, toToken, abortSignal);
284
-
285
- return fromAmount
286
- * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, toToken.toString())))
287
- * (1000000n) //To usat
288
- / (price);
289
- }
290
-
291
- /**
292
- * Returns amount of satoshis that are equivalent to `fromAmount` of `fromToken`
293
- *
294
- * @param chainIdentifier Chain identifier string for the smart chain
295
- * @param fromAmount Amount of the token
296
- * @param fromToken Token address
297
- * @param abortSignal
298
- * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
299
- * @throws {Error} when token is not found
300
- */
301
- public async getToBtcSwapAmount<C extends ChainIds<T>>(
302
- chainIdentifier: C,
303
- fromAmount: bigint,
304
- fromToken: string,
305
- abortSignal?: AbortSignal,
306
- preFetchedPrice?: bigint
307
- ): Promise<bigint> {
308
- if(this.getDecimals(chainIdentifier, fromToken.toString())==null) throw new Error("Token not found");
309
-
310
- const price = preFetchedPrice || await this.getPrice(chainIdentifier, fromToken, abortSignal);
311
-
312
- return fromAmount
313
- * price
314
- / 1000000n
315
- / (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, fromToken.toString())));
316
- }
317
-
318
- /**
319
- * Returns whether the token should be ignored and pricing for it not calculated
320
- *
321
- * @param chainIdentifier Chain identifier string for the smart chain
322
- * @param tokenAddress Token address
323
- * @throws {Error} if token is not found
324
- */
325
- public shouldIgnore<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): boolean {
326
- const coin = this.getDecimals(chainIdentifier, tokenAddress.toString());
327
- if(coin==null) throw new Error("Token not found");
328
- return coin===-1;
329
- }
330
-
331
- /**
332
- * Returns the USD value of the bitcoin amount
333
- *
334
- * @param btcSats Bitcoin amount in satoshis
335
- * @param abortSignal
336
- * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
337
- */
338
- public async getBtcUsdValue(
339
- btcSats: bigint,
340
- abortSignal?: AbortSignal,
341
- preFetchedUsdPrice?: number
342
- ): Promise<number> {
343
- return Number(btcSats)*(preFetchedUsdPrice || await this.getUsdPrice(abortSignal));
344
- }
345
-
346
- /**
347
- * Returns the USD value of the smart chain token amount
348
- *
349
- * @param chainIdentifier Chain identifier string for the smart chain
350
- * @param tokenAmount Amount of the token in base units
351
- * @param tokenAddress Token address
352
- * @param abortSignal
353
- * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
354
- */
355
- public async getTokenUsdValue<C extends ChainIds<T>>(
356
- chainIdentifier: C,
357
- tokenAmount: bigint,
358
- tokenAddress: string,
359
- abortSignal?: AbortSignal,
360
- preFetchedUsdPrice?: number
361
- ): Promise<number> {
362
- const [btcAmount, usdPrice] = await Promise.all([
363
- this.getToBtcSwapAmount(chainIdentifier, tokenAmount, tokenAddress, abortSignal),
364
- preFetchedUsdPrice==null ? this.preFetchUsdPrice(abortSignal) : Promise.resolve(preFetchedUsdPrice)
365
- ]);
366
- return Number(btcAmount)*usdPrice;
367
- }
368
-
369
- /**
370
- * Returns the USD value of the token amount
371
- *
372
- * @param amount Amount in base units of the token
373
- * @param token Token to fetch the usd price for
374
- * @param abortSignal
375
- * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
376
- */
377
- public getUsdValue<C extends ChainIds<T>>(
378
- amount: bigint,
379
- token: Token<C>,
380
- abortSignal?: AbortSignal,
381
- preFetchedUsdPrice?: number
382
- ): Promise<number> {
383
- if(token.chain==="BTC") {
384
- return this.getBtcUsdValue(amount, abortSignal, preFetchedUsdPrice);
385
- } else {
386
- return this.getTokenUsdValue(token.chainId, amount, token.address, abortSignal, preFetchedUsdPrice);
387
- }
388
- }
389
-
390
- }
1
+ import {ChainIds, MultiChain} from "../../swapper/Swapper";
2
+ import {Token} from "../../types/Token";
3
+ import {PriceInfoType} from "../../types/PriceInfoType";
4
+
5
+ /**
6
+ * Abstract base class for swap pricing implementations
7
+ *
8
+ * @category Pricing
9
+ */
10
+ export abstract class ISwapPrice<T extends MultiChain = MultiChain> {
11
+
12
+ maxAllowedFeeDifferencePPM: bigint;
13
+
14
+ protected constructor(maxAllowedFeeDifferencePPM: bigint) {
15
+ this.maxAllowedFeeDifferencePPM = maxAllowedFeeDifferencePPM;
16
+ }
17
+
18
+ /**
19
+ * Gets the decimal places for a given token, returns `-1` if token should be ignored & `null` if token is not found
20
+ *
21
+ * @param chainIdentifier Chain identifier of the smart chain
22
+ * @param tokenAddress Token address
23
+ * @protected
24
+ */
25
+ protected abstract getDecimals<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): number | null;
26
+
27
+ /**
28
+ * Returns the price of the token in BTC uSats (microSats)
29
+ *
30
+ * @param chainIdentifier Chain identifier of the smart chain
31
+ * @param tokenAddress Token address
32
+ * @param abortSignal
33
+ * @protected
34
+ */
35
+ protected abstract getPrice<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string, abortSignal?: AbortSignal): Promise<bigint>;
36
+
37
+ /**
38
+ * Returns the price of bitcoin in USD (sats/USD)
39
+ *
40
+ * @param abortSignal
41
+ * @protected
42
+ */
43
+ protected abstract getUsdPrice(abortSignal?: AbortSignal): Promise<number>;
44
+
45
+ /**
46
+ * Gets the decimal places for a given token, returns `-1` if token should be ignored & throws if token is not found
47
+ *
48
+ * @param chainIdentifier Chain identifier of the smart chain
49
+ * @param tokenAddress Token address
50
+ * @throws {Error} When token is not known
51
+ * @protected
52
+ */
53
+ protected getDecimalsThrowing<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): number {
54
+ const decimals = this.getDecimals(chainIdentifier, tokenAddress);
55
+ if(decimals==null) throw new Error(`Cannot get decimal count for token ${chainIdentifier}:${tokenAddress}!`);
56
+ return decimals;
57
+ }
58
+
59
+ /**
60
+ * Recomputes pricing info without fetching the current price
61
+ *
62
+ * @param chainIdentifier Chain identifier of the smart chain
63
+ * @param amountSats Amount of sats (BTC) to be received from the swap
64
+ * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
65
+ * @param feePPM PPM fee rate as reported by the intermediary
66
+ * @param paidToken Amount of token to be paid to the swap
67
+ * @param tokenAddress Token address to be paid
68
+ */
69
+ public recomputePriceInfoSend<C extends ChainIds<T>>(
70
+ chainIdentifier: C,
71
+ amountSats: bigint,
72
+ satsBaseFee: bigint,
73
+ feePPM: bigint,
74
+ paidToken: bigint,
75
+ tokenAddress: string
76
+ ): PriceInfoType {
77
+ const totalSats = (amountSats * (1000000n + feePPM) / 1000000n)
78
+ + satsBaseFee;
79
+ const totalUSats = totalSats * 1000000n;
80
+ const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / paidToken;
81
+
82
+ return {
83
+ isValid: true,
84
+ differencePPM: 0n,
85
+ satsBaseFee,
86
+ feePPM,
87
+ realPriceUSatPerToken: this.shouldIgnore(chainIdentifier, tokenAddress) ? undefined : swapPriceUSatPerToken,
88
+ swapPriceUSatPerToken
89
+ };
90
+ }
91
+
92
+ /**
93
+ * Checks whether the swap amounts are valid given the current market rate for a given pair
94
+ *
95
+ * @param chainIdentifier Chain identifier of the smart chain
96
+ * @param amountSats Amount of sats (BTC) to be received from the swap
97
+ * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
98
+ * @param feePPM PPM fee rate as reported by the intermediary
99
+ * @param paidToken Amount of token to be paid to the swap
100
+ * @param tokenAddress Token address to be paid
101
+ * @param abortSignal
102
+ * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
103
+ * @param realSwapFeeSats
104
+ */
105
+ public async isValidAmountSend<C extends ChainIds<T>>(
106
+ chainIdentifier: C,
107
+ amountSats: bigint,
108
+ satsBaseFee: bigint,
109
+ feePPM: bigint,
110
+ paidToken: bigint,
111
+ tokenAddress: string,
112
+ abortSignal?: AbortSignal,
113
+ preFetchedPrice?: bigint | null,
114
+ realSwapFeeSats?: bigint
115
+ ): Promise<PriceInfoType> {
116
+ if(realSwapFeeSats!=undefined && realSwapFeeSats<0) throw new Error("Invalid swap fee! Swap fee cannot be negative!");
117
+ const totalSats = realSwapFeeSats!=undefined
118
+ ? amountSats + realSwapFeeSats
119
+ : (amountSats * (1000000n + feePPM) / 1000000n) + satsBaseFee;
120
+ const totalUSats = totalSats * 1000000n;
121
+
122
+ const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / paidToken;
123
+
124
+ if(this.shouldIgnore(chainIdentifier, tokenAddress)) return {
125
+ isValid: true,
126
+ differencePPM: 0n,
127
+ satsBaseFee,
128
+ feePPM,
129
+ realPriceUSatPerToken: undefined,
130
+ swapPriceUSatPerToken
131
+ };
132
+
133
+ const calculatedAmtInToken = await this.getFromBtcSwapAmount(chainIdentifier, totalSats, tokenAddress, abortSignal, preFetchedPrice);
134
+ const realPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / calculatedAmtInToken;
135
+
136
+ const difference = paidToken - calculatedAmtInToken; //Will be >0 if we need to pay more than we should've
137
+ const differencePPM = difference * 1000000n / calculatedAmtInToken;
138
+
139
+ return {
140
+ isValid: differencePPM <= this.maxAllowedFeeDifferencePPM,
141
+ differencePPM,
142
+ satsBaseFee,
143
+ feePPM,
144
+ realPriceUSatPerToken,
145
+ swapPriceUSatPerToken
146
+ };
147
+ }
148
+
149
+ /**
150
+ * Recomputes pricing info without fetching the current price
151
+ *
152
+ * @param chainIdentifier Chain identifier of the smart chain
153
+ * @param amountSats Amount of sats (BTC) to be paid to the swap
154
+ * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
155
+ * @param feePPM PPM fee rate as reported by the intermediary
156
+ * @param receiveToken Amount of token to be received from the swap
157
+ * @param tokenAddress Token address to be received
158
+ */
159
+ public recomputePriceInfoReceive<C extends ChainIds<T>>(
160
+ chainIdentifier: C,
161
+ amountSats: bigint,
162
+ satsBaseFee: bigint,
163
+ feePPM: bigint,
164
+ receiveToken: bigint,
165
+ tokenAddress: string,
166
+ ): PriceInfoType {
167
+ const totalSats = (amountSats * (1000000n - feePPM) / 1000000n)
168
+ - satsBaseFee;
169
+ const totalUSats = totalSats * 1000000n;
170
+ const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / receiveToken;
171
+
172
+ return {
173
+ isValid: true,
174
+ differencePPM: 0n,
175
+ satsBaseFee,
176
+ feePPM,
177
+ realPriceUSatPerToken: this.shouldIgnore(chainIdentifier, tokenAddress) ? undefined : swapPriceUSatPerToken,
178
+ swapPriceUSatPerToken
179
+ };
180
+ }
181
+
182
+ /**
183
+ * Checks whether the swap amounts are valid given the current market rate for a given pair
184
+ *
185
+ * @param chainIdentifier Chain identifier of the smart chain
186
+ * @param amountSats Amount of sats (BTC) to be paid to the swap
187
+ * @param satsBaseFee Base fee in sats (BTC) as reported by the intermediary
188
+ * @param feePPM PPM fee rate as reported by the intermediary
189
+ * @param receiveToken Amount of token to be received from the swap
190
+ * @param tokenAddress Token address to be received
191
+ * @param abortSignal
192
+ * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
193
+ * @param realSwapFeeSats
194
+ */
195
+ public async isValidAmountReceive<C extends ChainIds<T>>(
196
+ chainIdentifier: C,
197
+ amountSats: bigint,
198
+ satsBaseFee: bigint,
199
+ feePPM: bigint,
200
+ receiveToken: bigint,
201
+ tokenAddress: string,
202
+ abortSignal?: AbortSignal,
203
+ preFetchedPrice?: bigint | null,
204
+ realSwapFeeSats?: bigint
205
+ ): Promise<PriceInfoType> {
206
+ if(realSwapFeeSats!=undefined) {
207
+ if(realSwapFeeSats>=amountSats) throw new Error("Invalid swap fee! Larger than or equal to total output amount!");
208
+ if(realSwapFeeSats<0) throw new Error("Invalid swap fee! Must be non-negative!");
209
+ }
210
+ const totalSats = realSwapFeeSats!=undefined
211
+ ? amountSats - realSwapFeeSats
212
+ : (amountSats * (1000000n - feePPM) / 1000000n) - satsBaseFee;
213
+ const totalUSats = totalSats * 1000000n;
214
+
215
+ const swapPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / receiveToken;
216
+
217
+ if(this.shouldIgnore(chainIdentifier, tokenAddress)) return {
218
+ isValid: true,
219
+ differencePPM: 0n,
220
+ satsBaseFee,
221
+ feePPM,
222
+ realPriceUSatPerToken: undefined,
223
+ swapPriceUSatPerToken
224
+ };
225
+
226
+ const calculatedAmtInToken = await this.getFromBtcSwapAmount(chainIdentifier, totalSats, tokenAddress, abortSignal, preFetchedPrice);
227
+ const realPriceUSatPerToken = totalUSats * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, tokenAddress))) / calculatedAmtInToken;
228
+
229
+ const difference = calculatedAmtInToken - receiveToken; //Will be >0 if we receive less than we should've
230
+ const differencePPM = difference * 100000n / calculatedAmtInToken;
231
+
232
+ return {
233
+ isValid: differencePPM <= this.maxAllowedFeeDifferencePPM,
234
+ differencePPM,
235
+ satsBaseFee,
236
+ feePPM,
237
+ realPriceUSatPerToken,
238
+ swapPriceUSatPerToken
239
+ };
240
+ }
241
+
242
+ /**
243
+ * Pre-fetches the pricing data for a given token, such that further calls to {@link isValidAmountReceive} or
244
+ * {@link isValidAmountSend} are quicker and don't need to wait for the price fetch
245
+ *
246
+ * @param chainIdentifier Chain identifier of the smart chain
247
+ * @param tokenAddress Token address
248
+ * @param abortSignal
249
+ */
250
+ public preFetchPrice<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string, abortSignal?: AbortSignal): Promise<bigint> {
251
+ return this.getPrice(chainIdentifier, tokenAddress, abortSignal);
252
+ }
253
+
254
+ /**
255
+ * Pre-fetches the Bitcoin USD price data, such that further calls to {@link getBtcUsdValue},
256
+ * {@link getTokenUsdValue} or {@link getUsdValue} are quicker and don't need to wait for the price fetch
257
+ *
258
+ * @param abortSignal
259
+ */
260
+ public preFetchUsdPrice(abortSignal?: AbortSignal): Promise<number> {
261
+ return this.getUsdPrice(abortSignal);
262
+ }
263
+
264
+ /**
265
+ * Returns amount of `toToken` that is equivalent to `fromAmount` satoshis
266
+ *
267
+ * @param chainIdentifier Chain identifier string for the smart chain
268
+ * @param fromAmount Amount of satoshis
269
+ * @param toToken Token address
270
+ * @param abortSignal
271
+ * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
272
+ * @throws {Error} when token is not found
273
+ */
274
+ public async getFromBtcSwapAmount<C extends ChainIds<T>>(
275
+ chainIdentifier: C,
276
+ fromAmount: bigint,
277
+ toToken: string,
278
+ abortSignal?: AbortSignal,
279
+ preFetchedPrice?: bigint | null
280
+ ): Promise<bigint> {
281
+ if(this.getDecimals(chainIdentifier, toToken.toString())==null) throw new Error("Token not found!");
282
+
283
+ const price = preFetchedPrice || await this.getPrice(chainIdentifier, toToken, abortSignal);
284
+
285
+ return fromAmount
286
+ * (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, toToken.toString())))
287
+ * (1000000n) //To usat
288
+ / (price);
289
+ }
290
+
291
+ /**
292
+ * Returns amount of satoshis that are equivalent to `fromAmount` of `fromToken`
293
+ *
294
+ * @param chainIdentifier Chain identifier string for the smart chain
295
+ * @param fromAmount Amount of the token
296
+ * @param fromToken Token address
297
+ * @param abortSignal
298
+ * @param preFetchedPrice An optional price pre-fetched with {@link preFetchPrice}
299
+ * @throws {Error} when token is not found
300
+ */
301
+ public async getToBtcSwapAmount<C extends ChainIds<T>>(
302
+ chainIdentifier: C,
303
+ fromAmount: bigint,
304
+ fromToken: string,
305
+ abortSignal?: AbortSignal,
306
+ preFetchedPrice?: bigint
307
+ ): Promise<bigint> {
308
+ if(this.getDecimals(chainIdentifier, fromToken.toString())==null) throw new Error("Token not found");
309
+
310
+ const price = preFetchedPrice || await this.getPrice(chainIdentifier, fromToken, abortSignal);
311
+
312
+ return fromAmount
313
+ * price
314
+ / 1000000n
315
+ / (10n ** BigInt(this.getDecimalsThrowing(chainIdentifier, fromToken.toString())));
316
+ }
317
+
318
+ /**
319
+ * Returns whether the token should be ignored and pricing for it not calculated
320
+ *
321
+ * @param chainIdentifier Chain identifier string for the smart chain
322
+ * @param tokenAddress Token address
323
+ * @throws {Error} if token is not found
324
+ */
325
+ public shouldIgnore<C extends ChainIds<T>>(chainIdentifier: C, tokenAddress: string): boolean {
326
+ const coin = this.getDecimals(chainIdentifier, tokenAddress.toString());
327
+ if(coin==null) throw new Error("Token not found");
328
+ return coin===-1;
329
+ }
330
+
331
+ /**
332
+ * Returns the USD value of the bitcoin amount
333
+ *
334
+ * @param btcSats Bitcoin amount in satoshis
335
+ * @param abortSignal
336
+ * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
337
+ */
338
+ public async getBtcUsdValue(
339
+ btcSats: bigint,
340
+ abortSignal?: AbortSignal,
341
+ preFetchedUsdPrice?: number
342
+ ): Promise<number> {
343
+ return Number(btcSats)*(preFetchedUsdPrice || await this.getUsdPrice(abortSignal));
344
+ }
345
+
346
+ /**
347
+ * Returns the USD value of the smart chain token amount
348
+ *
349
+ * @param chainIdentifier Chain identifier string for the smart chain
350
+ * @param tokenAmount Amount of the token in base units
351
+ * @param tokenAddress Token address
352
+ * @param abortSignal
353
+ * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
354
+ */
355
+ public async getTokenUsdValue<C extends ChainIds<T>>(
356
+ chainIdentifier: C,
357
+ tokenAmount: bigint,
358
+ tokenAddress: string,
359
+ abortSignal?: AbortSignal,
360
+ preFetchedUsdPrice?: number
361
+ ): Promise<number> {
362
+ const [btcAmount, usdPrice] = await Promise.all([
363
+ this.getToBtcSwapAmount(chainIdentifier, tokenAmount, tokenAddress, abortSignal),
364
+ preFetchedUsdPrice==null ? this.preFetchUsdPrice(abortSignal) : Promise.resolve(preFetchedUsdPrice)
365
+ ]);
366
+ return Number(btcAmount)*usdPrice;
367
+ }
368
+
369
+ /**
370
+ * Returns the USD value of the token amount
371
+ *
372
+ * @param amount Amount in base units of the token
373
+ * @param token Token to fetch the usd price for
374
+ * @param abortSignal
375
+ * @param preFetchedUsdPrice An optional price pre-fetched with {@link preFetchUsdPrice}
376
+ */
377
+ public getUsdValue<C extends ChainIds<T>>(
378
+ amount: bigint,
379
+ token: Token<C>,
380
+ abortSignal?: AbortSignal,
381
+ preFetchedUsdPrice?: number
382
+ ): Promise<number> {
383
+ if(token.chain==="BTC") {
384
+ return this.getBtcUsdValue(amount, abortSignal, preFetchedUsdPrice);
385
+ } else {
386
+ return this.getTokenUsdValue(token.chainId, amount, token.address, abortSignal, preFetchedUsdPrice);
387
+ }
388
+ }
389
+
390
+ }