@atomiqlabs/sdk 8.8.3 → 8.8.4

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 (339) hide show
  1. package/LICENSE +201 -201
  2. package/README.md +1760 -1760
  3. package/dist/SmartChainAssets.d.ts +181 -181
  4. package/dist/SmartChainAssets.js +181 -181
  5. package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
  6. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  7. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
  8. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  9. package/dist/bitcoin/coinselect2/index.d.ts +20 -20
  10. package/dist/bitcoin/coinselect2/index.js +69 -69
  11. package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
  12. package/dist/bitcoin/coinselect2/utils.js +158 -158
  13. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
  14. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
  15. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
  16. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  17. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
  18. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
  19. package/dist/enums/FeeType.d.ts +15 -15
  20. package/dist/enums/FeeType.js +19 -19
  21. package/dist/enums/SwapAmountType.d.ts +15 -15
  22. package/dist/enums/SwapAmountType.js +19 -19
  23. package/dist/enums/SwapDirection.d.ts +15 -15
  24. package/dist/enums/SwapDirection.js +19 -19
  25. package/dist/enums/SwapSide.d.ts +15 -15
  26. package/dist/enums/SwapSide.js +19 -19
  27. package/dist/enums/SwapType.d.ts +75 -75
  28. package/dist/enums/SwapType.js +79 -79
  29. package/dist/errors/IntermediaryError.d.ts +13 -13
  30. package/dist/errors/IntermediaryError.js +27 -27
  31. package/dist/errors/RequestError.d.ts +32 -32
  32. package/dist/errors/RequestError.js +54 -54
  33. package/dist/errors/UserError.d.ts +8 -8
  34. package/dist/errors/UserError.js +16 -16
  35. package/dist/events/UnifiedSwapEventListener.d.ts +23 -23
  36. package/dist/events/UnifiedSwapEventListener.js +132 -132
  37. package/dist/http/HttpUtils.d.ts +27 -27
  38. package/dist/http/HttpUtils.js +91 -91
  39. package/dist/http/paramcoders/IParamReader.d.ts +8 -8
  40. package/dist/http/paramcoders/IParamReader.js +2 -2
  41. package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
  42. package/dist/http/paramcoders/ParamDecoder.js +137 -137
  43. package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
  44. package/dist/http/paramcoders/ParamEncoder.js +36 -36
  45. package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
  46. package/dist/http/paramcoders/SchemaVerifier.js +145 -145
  47. package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
  48. package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
  49. package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
  50. package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
  51. package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +16 -16
  52. package/dist/http/paramcoders/client/StreamingFetchPromise.js +174 -174
  53. package/dist/index.d.ts +85 -85
  54. package/dist/index.js +158 -158
  55. package/dist/intermediaries/Intermediary.d.ts +178 -178
  56. package/dist/intermediaries/Intermediary.js +166 -166
  57. package/dist/intermediaries/IntermediaryDiscovery.d.ts +211 -211
  58. package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
  59. package/dist/intermediaries/apis/IntermediaryAPI.d.ts +450 -450
  60. package/dist/intermediaries/apis/IntermediaryAPI.js +618 -618
  61. package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
  62. package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
  63. package/dist/lnurl/LNURL.d.ts +102 -102
  64. package/dist/lnurl/LNURL.js +321 -321
  65. package/dist/prices/RedundantSwapPrice.d.ts +110 -110
  66. package/dist/prices/RedundantSwapPrice.js +222 -222
  67. package/dist/prices/SingleSwapPrice.d.ts +34 -34
  68. package/dist/prices/SingleSwapPrice.js +44 -44
  69. package/dist/prices/SwapPriceWithChain.d.ts +107 -107
  70. package/dist/prices/SwapPriceWithChain.js +128 -128
  71. package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
  72. package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
  73. package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
  74. package/dist/prices/abstract/IPriceProvider.js +74 -74
  75. package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
  76. package/dist/prices/abstract/ISwapPrice.js +279 -279
  77. package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
  78. package/dist/prices/providers/BinancePriceProvider.js +30 -30
  79. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
  80. package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
  81. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
  82. package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
  83. package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
  84. package/dist/prices/providers/CustomPriceProvider.js +35 -35
  85. package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
  86. package/dist/prices/providers/KrakenPriceProvider.js +45 -45
  87. package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
  88. package/dist/prices/providers/OKXPriceProvider.js +29 -29
  89. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
  90. package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
  91. package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
  92. package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
  93. package/dist/storage/IUnifiedStorage.d.ts +85 -85
  94. package/dist/storage/IUnifiedStorage.js +2 -2
  95. package/dist/storage/UnifiedSwapStorage.d.ts +114 -114
  96. package/dist/storage/UnifiedSwapStorage.js +116 -116
  97. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
  98. package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
  99. package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
  100. package/dist/storage-browser/LocalStorageManager.js +93 -93
  101. package/dist/swapper/Swapper.d.ts +732 -732
  102. package/dist/swapper/Swapper.js +1713 -1713
  103. package/dist/swapper/SwapperFactory.d.ts +135 -135
  104. package/dist/swapper/SwapperFactory.js +162 -162
  105. package/dist/swapper/SwapperUtils.d.ts +206 -206
  106. package/dist/swapper/SwapperUtils.js +481 -481
  107. package/dist/swapper/SwapperWithChain.d.ts +404 -404
  108. package/dist/swapper/SwapperWithChain.js +469 -469
  109. package/dist/swapper/SwapperWithSigner.d.ts +322 -322
  110. package/dist/swapper/SwapperWithSigner.js +318 -318
  111. package/dist/swaps/IAddressSwap.d.ts +22 -22
  112. package/dist/swaps/IAddressSwap.js +14 -14
  113. package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
  114. package/dist/swaps/IBTCWalletSwap.js +18 -18
  115. package/dist/swaps/IClaimableSwap.d.ts +49 -49
  116. package/dist/swaps/IClaimableSwap.js +15 -15
  117. package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
  118. package/dist/swaps/IClaimableSwapWrapper.js +2 -2
  119. package/dist/swaps/IRefundableSwap.d.ts +43 -43
  120. package/dist/swaps/IRefundableSwap.js +14 -14
  121. package/dist/swaps/ISwap.d.ts +392 -392
  122. package/dist/swaps/ISwap.js +349 -349
  123. package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
  124. package/dist/swaps/ISwapWithGasDrop.js +12 -12
  125. package/dist/swaps/ISwapWrapper.d.ts +285 -285
  126. package/dist/swaps/ISwapWrapper.js +353 -353
  127. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
  128. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
  129. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
  130. package/dist/swaps/escrow_swaps/IEscrowSwap.js +170 -170
  131. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +128 -128
  132. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
  133. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +105 -105
  134. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +129 -129
  135. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
  136. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
  137. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
  138. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
  139. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +531 -531
  140. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1285 -1285
  141. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +190 -190
  142. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
  143. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +583 -583
  144. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1371 -1371
  145. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +235 -235
  146. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
  147. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +458 -458
  148. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1126 -1126
  149. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +202 -202
  150. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
  151. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +403 -403
  152. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +924 -924
  153. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
  154. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
  155. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
  156. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
  157. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +251 -251
  158. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +536 -536
  159. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
  160. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
  161. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +132 -132
  162. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
  163. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +637 -637
  164. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1448 -1448
  165. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +257 -257
  166. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
  167. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +261 -261
  168. package/dist/swaps/trusted/ln/LnForGasSwap.js +511 -511
  169. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
  170. package/dist/swaps/trusted/ln/LnForGasWrapper.js +83 -83
  171. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +342 -342
  172. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +715 -715
  173. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +69 -69
  174. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
  175. package/dist/types/AmountData.d.ts +10 -10
  176. package/dist/types/AmountData.js +2 -2
  177. package/dist/types/CustomPriceFunction.d.ts +11 -11
  178. package/dist/types/CustomPriceFunction.js +2 -2
  179. package/dist/types/PriceInfoType.d.ts +28 -28
  180. package/dist/types/PriceInfoType.js +57 -57
  181. package/dist/types/SwapExecutionAction.d.ts +88 -88
  182. package/dist/types/SwapExecutionAction.js +2 -2
  183. package/dist/types/SwapStateInfo.d.ts +5 -5
  184. package/dist/types/SwapStateInfo.js +2 -2
  185. package/dist/types/SwapWithSigner.d.ts +17 -17
  186. package/dist/types/SwapWithSigner.js +43 -43
  187. package/dist/types/Token.d.ts +99 -99
  188. package/dist/types/Token.js +76 -76
  189. package/dist/types/TokenAmount.d.ts +69 -69
  190. package/dist/types/TokenAmount.js +60 -60
  191. package/dist/types/fees/Fee.d.ts +50 -50
  192. package/dist/types/fees/Fee.js +2 -2
  193. package/dist/types/fees/FeeBreakdown.d.ts +11 -11
  194. package/dist/types/fees/FeeBreakdown.js +2 -2
  195. package/dist/types/fees/PercentagePPM.d.ts +17 -17
  196. package/dist/types/fees/PercentagePPM.js +18 -18
  197. package/dist/types/lnurl/LNURLPay.d.ts +61 -61
  198. package/dist/types/lnurl/LNURLPay.js +31 -31
  199. package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
  200. package/dist/types/lnurl/LNURLWithdraw.js +27 -27
  201. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
  202. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
  203. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
  204. package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
  205. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
  206. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
  207. package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
  208. package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
  209. package/dist/utils/BitcoinUtils.d.ts +16 -16
  210. package/dist/utils/BitcoinUtils.js +141 -141
  211. package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
  212. package/dist/utils/BitcoinWalletUtils.js +14 -14
  213. package/dist/utils/Logger.d.ts +7 -7
  214. package/dist/utils/Logger.js +12 -12
  215. package/dist/utils/RetryUtils.d.ts +22 -22
  216. package/dist/utils/RetryUtils.js +67 -67
  217. package/dist/utils/SwapUtils.d.ts +88 -88
  218. package/dist/utils/SwapUtils.js +72 -72
  219. package/dist/utils/TimeoutUtils.d.ts +17 -17
  220. package/dist/utils/TimeoutUtils.js +55 -55
  221. package/dist/utils/TokenUtils.d.ts +19 -19
  222. package/dist/utils/TokenUtils.js +37 -37
  223. package/dist/utils/TypeUtils.d.ts +7 -7
  224. package/dist/utils/TypeUtils.js +2 -2
  225. package/dist/utils/Utils.d.ts +67 -67
  226. package/dist/utils/Utils.js +208 -208
  227. package/package.json +43 -43
  228. package/src/SmartChainAssets.ts +186 -186
  229. package/src/bitcoin/coinselect2/accumulative.ts +69 -69
  230. package/src/bitcoin/coinselect2/blackjack.ts +50 -50
  231. package/src/bitcoin/coinselect2/index.ts +93 -93
  232. package/src/bitcoin/coinselect2/utils.ts +236 -236
  233. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
  234. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
  235. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
  236. package/src/enums/FeeType.ts +15 -15
  237. package/src/enums/SwapAmountType.ts +16 -16
  238. package/src/enums/SwapDirection.ts +15 -15
  239. package/src/enums/SwapSide.ts +16 -16
  240. package/src/enums/SwapType.ts +75 -75
  241. package/src/errors/IntermediaryError.ts +28 -28
  242. package/src/errors/RequestError.ts +64 -64
  243. package/src/errors/UserError.ts +15 -15
  244. package/src/events/UnifiedSwapEventListener.ts +173 -173
  245. package/src/http/HttpUtils.ts +91 -91
  246. package/src/http/paramcoders/IParamReader.ts +9 -9
  247. package/src/http/paramcoders/ParamDecoder.ts +145 -145
  248. package/src/http/paramcoders/ParamEncoder.ts +40 -40
  249. package/src/http/paramcoders/SchemaVerifier.ts +153 -153
  250. package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
  251. package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
  252. package/src/http/paramcoders/client/StreamingFetchPromise.ts +192 -192
  253. package/src/index.ts +140 -140
  254. package/src/intermediaries/Intermediary.ts +280 -280
  255. package/src/intermediaries/IntermediaryDiscovery.ts +541 -541
  256. package/src/intermediaries/apis/IntermediaryAPI.ts +963 -963
  257. package/src/intermediaries/apis/TrustedIntermediaryAPI.ts +257 -257
  258. package/src/lnurl/LNURL.ts +402 -402
  259. package/src/prices/RedundantSwapPrice.ts +264 -264
  260. package/src/prices/SingleSwapPrice.ts +50 -50
  261. package/src/prices/SwapPriceWithChain.ts +194 -194
  262. package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
  263. package/src/prices/abstract/IPriceProvider.ts +127 -127
  264. package/src/prices/abstract/ISwapPrice.ts +390 -390
  265. package/src/prices/providers/BinancePriceProvider.ts +48 -48
  266. package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
  267. package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
  268. package/src/prices/providers/CustomPriceProvider.ts +40 -40
  269. package/src/prices/providers/KrakenPriceProvider.ts +83 -83
  270. package/src/prices/providers/OKXPriceProvider.ts +59 -59
  271. package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
  272. package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
  273. package/src/storage/IUnifiedStorage.ts +95 -95
  274. package/src/storage/UnifiedSwapStorage.ts +141 -141
  275. package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
  276. package/src/storage-browser/LocalStorageManager.ts +106 -106
  277. package/src/swapper/Swapper.ts +2488 -2488
  278. package/src/swapper/SwapperFactory.ts +307 -307
  279. package/src/swapper/SwapperUtils.ts +570 -570
  280. package/src/swapper/SwapperWithChain.ts +707 -707
  281. package/src/swapper/SwapperWithSigner.ts +511 -511
  282. package/src/swaps/IAddressSwap.ts +30 -30
  283. package/src/swaps/IBTCWalletSwap.ts +92 -92
  284. package/src/swaps/IClaimableSwap.ts +65 -65
  285. package/src/swaps/IClaimableSwapWrapper.ts +17 -17
  286. package/src/swaps/IRefundableSwap.ts +58 -58
  287. package/src/swaps/ISwap.ts +703 -703
  288. package/src/swaps/ISwapWithGasDrop.ts +25 -25
  289. package/src/swaps/ISwapWrapper.ts +539 -539
  290. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
  291. package/src/swaps/escrow_swaps/IEscrowSwap.ts +269 -269
  292. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +282 -282
  293. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +169 -169
  294. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
  295. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
  296. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1473 -1474
  297. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +601 -601
  298. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1582 -1582
  299. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +750 -750
  300. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1299 -1299
  301. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +610 -610
  302. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1096 -1096
  303. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
  304. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
  305. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +786 -786
  306. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
  307. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +401 -401
  308. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +1812 -1812
  309. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1236 -1236
  310. package/src/swaps/trusted/ln/LnForGasSwap.ts +589 -589
  311. package/src/swaps/trusted/ln/LnForGasWrapper.ts +91 -91
  312. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +862 -862
  313. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +131 -131
  314. package/src/types/AmountData.ts +9 -9
  315. package/src/types/CustomPriceFunction.ts +11 -11
  316. package/src/types/PriceInfoType.ts +66 -66
  317. package/src/types/SwapExecutionAction.ts +99 -99
  318. package/src/types/SwapStateInfo.ts +6 -6
  319. package/src/types/SwapWithSigner.ts +61 -61
  320. package/src/types/Token.ts +163 -163
  321. package/src/types/TokenAmount.ts +132 -132
  322. package/src/types/fees/Fee.ts +56 -56
  323. package/src/types/fees/FeeBreakdown.ts +11 -11
  324. package/src/types/fees/PercentagePPM.ts +26 -26
  325. package/src/types/lnurl/LNURLPay.ts +79 -79
  326. package/src/types/lnurl/LNURLWithdraw.ts +61 -61
  327. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
  328. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
  329. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
  330. package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
  331. package/src/utils/BitcoinUtils.ts +132 -132
  332. package/src/utils/BitcoinWalletUtils.ts +15 -15
  333. package/src/utils/Logger.ts +14 -14
  334. package/src/utils/RetryUtils.ts +78 -78
  335. package/src/utils/SwapUtils.ts +99 -99
  336. package/src/utils/TimeoutUtils.ts +49 -49
  337. package/src/utils/TokenUtils.ts +33 -33
  338. package/src/utils/TypeUtils.ts +8 -8
  339. package/src/utils/Utils.ts +212 -212
@@ -1,601 +1,601 @@
1
- import {FromBTCLNSwap, FromBTCLNSwapInit, FromBTCLNSwapState} from "./FromBTCLNSwap";
2
- import {decode as bolt11Decode, PaymentRequestObject, TagsObject} from "@atomiqlabs/bolt11";
3
- import {
4
- ChainSwapType,
5
- ChainType,
6
- ClaimEvent,
7
- InitializeEvent, LightningNetworkApi, LNNodeLiquidity,
8
- RefundEvent, SwapCommitState, SwapCommitStateType
9
- } from "@atomiqlabs/base";
10
- import {Intermediary} from "../../../../intermediaries/Intermediary";
11
- import {Buffer} from "buffer";
12
- import {UserError} from "../../../../errors/UserError";
13
- import {IntermediaryError} from "../../../../errors/IntermediaryError";
14
- import {SwapType} from "../../../../enums/SwapType";
15
- import {
16
- extendAbortController, mapArrayToObject, parseHashValueExact32Bytes,
17
- throwIfUndefined
18
- } from "../../../../utils/Utils";
19
- import {FromBTCLNResponseType, IntermediaryAPI} from "../../../../intermediaries/apis/IntermediaryAPI";
20
- import {RequestError} from "../../../../errors/RequestError";
21
- import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
22
- import {EventEmitter} from "events";
23
- import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
24
- import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
25
- import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
26
- import {ISwap} from "../../../ISwap";
27
- import {IFromBTCLNDefinition, IFromBTCLNWrapper} from "../IFromBTCLNWrapper";
28
- import {IClaimableSwapWrapper} from "../../../IClaimableSwapWrapper";
29
- import {AmountData} from "../../../../types/AmountData";
30
- import {LNURLWithdrawParamsWithUrl} from "../../../../types/lnurl/LNURLWithdraw";
31
- import {tryWithRetries} from "../../../../utils/RetryUtils";
32
- import {AllOptional} from "../../../../utils/TypeUtils";
33
- import {sha256} from "@noble/hashes/sha2";
34
-
35
- export type FromBTCLNOptions = {
36
- /**
37
- * Instead of letting the SDK generate the preimage/paymentHash pair internally you can pass your computed
38
- * paymentHash here, this will create the swap with the provided payment hash. Note that you would then
39
- * have to reveal the preimage by passing it to the {@link FromBTCLNSwap.claim} or {@link FromBTCLNSwap.txsClaim}
40
- * functions
41
- *
42
- * Accepts both, a {@link Buffer} and a hexadecimal `string`
43
- */
44
- paymentHash?: Buffer | string,
45
- /**
46
- * Optional description to use for the swap lightning network invoice, keep the invoice length below 500 characters
47
- */
48
- description?: string,
49
- /**
50
- * Optional description hash to use for the lightning network invoice, useful when returning the invoice as part of
51
- * an LNURL-pay service endpoint.
52
- *
53
- * Accepts both, a {@link Buffer} and a hexadecimal `string`
54
- */
55
- descriptionHash?: Buffer | string,
56
- /**
57
- * A flag to skip checking whether the lightning network node of the LP has enough channel liquidity to facilitate
58
- * the swap.
59
- */
60
- unsafeSkipLnNodeCheck?: boolean
61
- };
62
-
63
- export type FromBTCLNWrapperOptions = ISwapWrapperOptions & {
64
- unsafeSkipLnNodeCheck: boolean,
65
- safetyFactor: number,
66
- bitcoinBlocktime: number
67
- };
68
-
69
- export type FromBTCLNDefinition<T extends ChainType> = IFromBTCLNDefinition<T, FromBTCLNWrapper<T>, FromBTCLNSwap<T>>;
70
-
71
- /**
72
- * Legacy escrow (HTLC) based swap for Bitcoin Lightning -> Smart chains, requires manual settlement
73
- * of the swap on the destination network once the lightning network payment is received by the LP.
74
- *
75
- * @category Swaps/Legacy/Lightning → Smart chain
76
- */
77
- export class FromBTCLNWrapper<
78
- T extends ChainType
79
- > extends IFromBTCLNWrapper<T, FromBTCLNDefinition<T>, FromBTCLNWrapperOptions> implements IClaimableSwapWrapper<FromBTCLNSwap<T>> {
80
-
81
- public readonly TYPE: SwapType.FROM_BTCLN = SwapType.FROM_BTCLN;
82
-
83
- /**
84
- * @internal
85
- */
86
- protected readonly tickSwapState = [
87
- FromBTCLNSwapState.PR_CREATED,
88
- FromBTCLNSwapState.PR_PAID,
89
- FromBTCLNSwapState.CLAIM_COMMITED
90
- ];
91
-
92
- /**
93
- * @internal
94
- */
95
- readonly _pendingSwapStates = [
96
- FromBTCLNSwapState.PR_CREATED,
97
- FromBTCLNSwapState.QUOTE_SOFT_EXPIRED,
98
- FromBTCLNSwapState.PR_PAID,
99
- FromBTCLNSwapState.CLAIM_COMMITED,
100
- FromBTCLNSwapState.EXPIRED
101
- ];
102
- /**
103
- * @internal
104
- */
105
- readonly _claimableSwapStates = [FromBTCLNSwapState.CLAIM_COMMITED];
106
- /**
107
- * @internal
108
- */
109
- readonly _swapDeserializer = FromBTCLNSwap;
110
-
111
- /**
112
- * @param chainIdentifier
113
- * @param unifiedStorage Storage interface for the current environment
114
- * @param unifiedChainEvents On-chain event listener
115
- * @param chain
116
- * @param prices Swap pricing handler
117
- * @param tokens
118
- * @param versionedContracts
119
- * @param lnApi
120
- * @param options
121
- * @param events Instance to use for emitting events
122
- */
123
- constructor(
124
- chainIdentifier: string,
125
- unifiedStorage: UnifiedSwapStorage<T>,
126
- unifiedChainEvents: UnifiedSwapEventListener<T>,
127
- chain: T["ChainInterface"],
128
- prices: ISwapPrice,
129
- tokens: WrapperCtorTokens,
130
- versionedContracts: {
131
- [version: string]: {
132
- swapContract: T["Contract"],
133
- swapDataConstructor: new (data: any) => T["Data"]
134
- }
135
- },
136
- lnApi: LightningNetworkApi,
137
- options?: AllOptional<FromBTCLNWrapperOptions>,
138
- events?: EventEmitter<{swapState: [ISwap]}>
139
- ) {
140
- super(
141
- chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi,
142
- {
143
- ...options,
144
- safetyFactor: options?.safetyFactor ?? 2,
145
- bitcoinBlocktime: options?.bitcoinBlocktime ?? 10*60,
146
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? false
147
- },
148
- events
149
- );
150
- }
151
-
152
- /**
153
- * @inheritDoc
154
- * @internal
155
- */
156
- protected processEventInitialize(swap: FromBTCLNSwap<T>, event: InitializeEvent<T["Data"]>): Promise<boolean> {
157
- if(swap._state===FromBTCLNSwapState.PR_PAID || swap._state===FromBTCLNSwapState.QUOTE_SOFT_EXPIRED) {
158
- swap._state = FromBTCLNSwapState.CLAIM_COMMITED;
159
- return Promise.resolve(true);
160
- }
161
- return Promise.resolve(false);
162
- }
163
-
164
- /**
165
- * @inheritDoc
166
- * @internal
167
- */
168
- protected processEventClaim(swap: FromBTCLNSwap<T>, event: ClaimEvent<T["Data"]>): Promise<boolean> {
169
- if(swap._state!==FromBTCLNSwapState.FAILED && swap._state!==FromBTCLNSwapState.CLAIM_CLAIMED) {
170
- swap._state = FromBTCLNSwapState.CLAIM_CLAIMED;
171
- swap._setSwapSecret(event.result);
172
- return Promise.resolve(true);
173
- }
174
- return Promise.resolve(false);
175
- }
176
-
177
- /**
178
- * @inheritDoc
179
- * @internal
180
- */
181
- protected processEventRefund(swap: FromBTCLNSwap<T>, event: RefundEvent<T["Data"]>): Promise<boolean> {
182
- if(swap._state!==FromBTCLNSwapState.CLAIM_CLAIMED && swap._state!==FromBTCLNSwapState.FAILED) {
183
- swap._state = FromBTCLNSwapState.FAILED;
184
- return Promise.resolve(true);
185
- }
186
- return Promise.resolve(false);
187
- }
188
-
189
- /**
190
- * Verifies response returned from intermediary
191
- *
192
- * @param resp Response as returned by the intermediary
193
- * @param amountData
194
- * @param lp Intermediary
195
- * @param options Options as passed to the swap creation function
196
- * @param decodedPr Decoded bolt11 lightning network invoice
197
- * @param paymentHash Expected payment hash of the bolt11 lightning network invoice
198
- *
199
- * @throws {IntermediaryError} in case the response is invalid
200
- *
201
- * @private
202
- */
203
- private verifyReturnedData(
204
- resp: FromBTCLNResponseType,
205
- amountData: AmountData,
206
- lp: Intermediary,
207
- options: {
208
- descriptionHash?: Buffer,
209
- description?: string
210
- },
211
- decodedPr: PaymentRequestObject & {tagsObject: TagsObject},
212
- paymentHash: Buffer
213
- ): void {
214
- if(lp.getAddress(this.chainIdentifier)!==resp.intermediaryKey) throw new IntermediaryError("Invalid intermediary address/pubkey");
215
-
216
- if(options.descriptionHash!=null && decodedPr.tagsObject.purpose_commit_hash!==options.descriptionHash.toString("hex"))
217
- throw new IntermediaryError("Invalid pr returned - description hash");
218
-
219
- if(options.description!=null && decodedPr.tagsObject.description!==options.description)
220
- throw new IntermediaryError("Invalid pr returned - description");
221
-
222
- if(
223
- decodedPr.tagsObject.payment_hash==null ||
224
- !Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash)
225
- ) throw new IntermediaryError("Invalid pr returned - payment hash");
226
-
227
- if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid pr returned - msat field");
228
-
229
- if(!amountData.exactIn) {
230
- if(resp.total != amountData.amount) throw new IntermediaryError("Invalid amount returned");
231
- } else {
232
- const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
233
- if(amountIn !== amountData.amount) throw new IntermediaryError("Invalid payment request returned, amount mismatch");
234
- }
235
- }
236
-
237
- /**
238
- * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
239
- * where the user needs to manually settle swap on the destination smart chain. The user has to pay
240
- * a bolt11 invoice on the input lightning network side.
241
- *
242
- * @param recipient Smart chain signer's address on the destination chain, that will have to manually
243
- * settle the swap.
244
- * @param amountData Amount, token and exact input/output data for to swap
245
- * @param lps An array of intermediaries (LPs) to get the quotes from
246
- * @param options Optional additional quote options
247
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
248
- * @param abortSignal Abort signal
249
- * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
250
- */
251
- create(
252
- recipient: string,
253
- amountData: AmountData,
254
- lps: Intermediary[],
255
- options?: FromBTCLNOptions,
256
- additionalParams?: Record<string, any>,
257
- abortSignal?: AbortSignal,
258
- preFetches?: {
259
- usdPricePrefetchPromise: Promise<number | undefined>,
260
- pricePrefetchPromise: Promise<bigint | undefined>,
261
- feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
262
- }
263
- ): {
264
- quote: Promise<FromBTCLNSwap<T>>,
265
- intermediary: Intermediary
266
- }[] {
267
- if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
268
-
269
- const _options = {
270
- paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
271
- description: options?.description,
272
- descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash"),
273
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
274
- };
275
-
276
- if(_options.description!=null && Buffer.byteLength(_options.description, "utf8") > 500)
277
- throw new UserError("Invalid description length");
278
-
279
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
280
-
281
- let secret: Buffer | undefined;
282
- let paymentHash: Buffer;
283
- if(_options.paymentHash!=null) {
284
- paymentHash = _options.paymentHash;
285
- } else {
286
- ({secret, paymentHash} = this.getSecretAndHash());
287
- }
288
- const _hash = mapArrayToObject(lpVersions, (contractVersion: string) => {
289
- return this._contract(contractVersion).getHashForHtlc(paymentHash).toString("hex");
290
- });
291
-
292
- const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
293
-
294
- const _abortController = extendAbortController(abortSignal);
295
- const _preFetches = preFetches ?? {
296
- pricePrefetchPromise: this.preFetchPrice(amountData, _abortController.signal),
297
- feeRatePromise: this.preFetchFeeRate(recipient, amountData, _hash, _abortController, lpVersions),
298
- usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
299
- }
300
-
301
- return lps.map(lp => {
302
- return {
303
- intermediary: lp,
304
- quote: (async () => {
305
- if(lp.services[SwapType.FROM_BTCLN]==null) throw new Error("LP service for processing from btcln swaps not found!");
306
- const version = lp.getContractVersion(this.chainIdentifier);
307
-
308
- const abortController = extendAbortController(_abortController.signal);
309
-
310
- const liquidityPromise: Promise<bigint | undefined> = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
311
-
312
- const {lnCapacityPromise, resp} = await tryWithRetries(async(retryCount: number) => {
313
- const {lnPublicKey, response} = IntermediaryAPI.initFromBTCLN(
314
- this.chainIdentifier, lp.url, nativeTokenAddress,
315
- {
316
- paymentHash,
317
- amount: amountData.amount,
318
- claimer: recipient,
319
- token: amountData.token.toString(),
320
- description: _options.description,
321
- descriptionHash: _options.descriptionHash,
322
- exactOut: !amountData.exactIn,
323
- feeRate: throwIfUndefined(_preFetches.feeRatePromise[version]),
324
- additionalParams
325
- },
326
- this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined
327
- );
328
-
329
- let lnCapacityPromise: Promise<LNNodeLiquidity | null> | undefined;
330
- if(!_options.unsafeSkipLnNodeCheck) {
331
- lnCapacityPromise = this.preFetchLnCapacity(lnPublicKey);
332
- } else lnPublicKey.catch(() => {});
333
-
334
- return {
335
- lnCapacityPromise,
336
- resp: await response
337
- };
338
- }, undefined, RequestError, abortController.signal);
339
-
340
- const decodedPr = bolt11Decode(resp.pr);
341
- if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid returned swap invoice, no msat amount field");
342
- if(decodedPr.timeExpireDate==null) throw new IntermediaryError("Invalid returned swap invoice, no expiry date field");
343
- const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
344
-
345
- const swapFeeBtc = resp.swapFee * amountIn / (resp.total + resp.swapFee);
346
-
347
- try {
348
- this.verifyReturnedData(resp, amountData, lp, _options, decodedPr, paymentHash);
349
- const [pricingInfo] = await Promise.all([
350
- this.verifyReturnedPrice(
351
- lp.services[SwapType.FROM_BTCLN], false, amountIn, resp.total,
352
- amountData.token, {swapFeeBtc}, _preFetches.pricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal
353
- ),
354
- this.verifyIntermediaryLiquidity(resp.total, throwIfUndefined(liquidityPromise)),
355
- lnCapacityPromise!=null ? this.verifyLnNodeCapacity(lp, decodedPr, lnCapacityPromise, abortController.signal) : Promise.resolve()
356
- ]);
357
-
358
- const quote = new FromBTCLNSwap<T>(this, {
359
- pricingInfo,
360
- url: lp.url,
361
- expiry: decodedPr.timeExpireDate*1000,
362
- swapFee: resp.swapFee,
363
- swapFeeBtc,
364
- feeRate: (await _preFetches.feeRatePromise[version])!,
365
- initialSwapData: await this._contract(version).createSwapData(
366
- ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token,
367
- resp.total, _hash[version],
368
- this.getRandomSequence(), BigInt(Math.floor(Date.now()/1000)), false, true,
369
- resp.securityDeposit, 0n, nativeTokenAddress
370
- ),
371
- pr: resp.pr,
372
- secret: secret?.toString("hex"),
373
- exactIn: amountData.exactIn ?? true,
374
- contractVersion: version
375
- } as FromBTCLNSwapInit<T["Data"]>);
376
- return quote;
377
- } catch (e) {
378
- abortController.abort(e);
379
- throw e;
380
- }
381
- })()
382
- }
383
- });
384
- }
385
-
386
- /**
387
- * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
388
- * where the user needs to manually settle swap on the destination smart chain. The swap is created
389
- * with an LNURL-withdraw link which will be used to pay the generated bolt11 invoice automatically
390
- * when {@link FromBTCLNSwap.waitForPayment} is called on the swap.
391
- *
392
- * @param recipient Smart chain signer's address on the destination chain, that will have to manually
393
- * settle the swap.
394
- * @param lnurl LNURL-withdraw link to pull the funds from
395
- * @param amountData Amount, token and exact input/output data for to swap
396
- * @param lps An array of intermediaries (LPs) to get the quotes from
397
- * @param options Optional additional quote options
398
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
399
- * @param abortSignal Abort signal
400
- */
401
- async createViaLNURL(
402
- recipient: string,
403
- lnurl: string | LNURLWithdrawParamsWithUrl,
404
- amountData: AmountData,
405
- lps: Intermediary[],
406
- options?: FromBTCLNOptions,
407
- additionalParams?: Record<string, any>,
408
- abortSignal?: AbortSignal
409
- ): Promise<{
410
- quote: Promise<FromBTCLNSwap<T>>,
411
- intermediary: Intermediary
412
- }[]> {
413
- if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
414
-
415
- const _options = {
416
- paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
417
- description: options?.description,
418
- descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash"),
419
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
420
- };
421
-
422
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
423
-
424
- const abortController = extendAbortController(abortSignal);
425
- const preFetches = {
426
- pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
427
- usdPricePrefetchPromise: this.preFetchUsdPrice(abortController.signal),
428
- feeRatePromise: this.preFetchFeeRate(recipient, amountData, undefined, abortController, lpVersions)
429
- };
430
-
431
- try {
432
- const exactOutAmountPromise: Promise<bigint | undefined> | undefined = !amountData.exactIn ? preFetches.pricePrefetchPromise.then(price =>
433
- this._prices.getToBtcSwapAmount(this.chainIdentifier, amountData.amount, amountData.token, abortController.signal, price)
434
- ).catch(e => {
435
- abortController.abort(e);
436
- return undefined;
437
- }) : undefined;
438
-
439
- const withdrawRequest = await this.getLNURLWithdraw(lnurl, abortController.signal);
440
-
441
- const min = BigInt(withdrawRequest.minWithdrawable) / 1000n;
442
- const max = BigInt(withdrawRequest.maxWithdrawable) / 1000n;
443
-
444
- if(amountData.exactIn) {
445
- if(amountData.amount < min) throw new UserError("Amount less than LNURL-withdraw minimum");
446
- if(amountData.amount > max) throw new UserError("Amount more than LNURL-withdraw maximum");
447
- } else {
448
- const amount = (await exactOutAmountPromise)!;
449
- abortController.signal.throwIfAborted();
450
-
451
- if((amount * 95n / 100n) < min) throw new UserError("Amount less than LNURL-withdraw minimum");
452
- if((amount * 105n / 100n) > max) throw new UserError("Amount more than LNURL-withdraw maximum");
453
- }
454
-
455
- return this.create(recipient, amountData, lps, _options, additionalParams, abortSignal, preFetches).map(data => {
456
- return {
457
- quote: data.quote.then(quote => {
458
- quote._setLNURLData(
459
- withdrawRequest.url,
460
- withdrawRequest.k1,
461
- withdrawRequest.callback
462
- )
463
-
464
- const amountIn = quote.getInput().rawAmount!;
465
- if(amountIn < min) throw new UserError("Amount less than LNURL-withdraw minimum");
466
- if(amountIn > max) throw new UserError("Amount more than LNURL-withdraw maximum");
467
-
468
- return quote;
469
- }),
470
- intermediary: data.intermediary
471
- }
472
- });
473
- } catch (e) {
474
- abortController.abort(e);
475
- throw e;
476
- }
477
- }
478
-
479
- /**
480
- * @inheritDoc
481
- * @internal
482
- */
483
- protected async _checkPastSwaps(pastSwaps: FromBTCLNSwap<T>[]): Promise<{
484
- changedSwaps: FromBTCLNSwap<T>[];
485
- removeSwaps: FromBTCLNSwap<T>[]
486
- }> {
487
- const changedSwapSet: Set<FromBTCLNSwap<T>> = new Set();
488
-
489
- const swapExpiredStatus: {[id: string]: boolean} = {};
490
- const checkStatusSwaps: {[contractVersion: string]: (FromBTCLNSwap<T> & {_data: T["Data"]})[]} = {};
491
-
492
- await Promise.all(pastSwaps.map(async (pastSwap) => {
493
- if(pastSwap._shouldCheckIntermediary()) {
494
- try {
495
- const result = await pastSwap._checkIntermediaryPaymentReceived(false);
496
- if(result!=null) {
497
- changedSwapSet.add(pastSwap);
498
- }
499
- } catch (e) {
500
- this.logger.error(`_checkPastSwaps(): Failed to contact LP regarding swap ${pastSwap.getId()}, error: `, e);
501
- }
502
- }
503
- if(pastSwap._shouldFetchExpiryStatus()) {
504
- //Check expiry
505
- swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
506
- }
507
- if(pastSwap._shouldFetchOnchainState()) {
508
- //Add to swaps for which status should be checked
509
- if(pastSwap._data!=null) (checkStatusSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap as (FromBTCLNSwap<T> & {_data: T["Data"]}));
510
- }
511
- }));
512
-
513
- for(let version in checkStatusSwaps) {
514
- if(this._versionedContracts[version]==null) {
515
- this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${version}! Skipping these swaps!`);
516
- continue;
517
- }
518
-
519
- const _checkStatusSwap = checkStatusSwaps[version];
520
- const swapStatuses = await this._contract(version).getCommitStatuses(_checkStatusSwap.map(val => ({signer: val._getInitiator(), swapData: val._data})));
521
-
522
- for(let pastSwap of _checkStatusSwap) {
523
- const shouldSave = await pastSwap._sync(
524
- false, swapExpiredStatus[pastSwap.getId()],
525
- swapStatuses[pastSwap.getEscrowHash()!], true
526
- );
527
- if(shouldSave) {
528
- changedSwapSet.add(pastSwap);
529
- }
530
- }
531
- }
532
-
533
- const changedSwaps: FromBTCLNSwap<T>[] = [];
534
- const removeSwaps: FromBTCLNSwap<T>[] = [];
535
- changedSwapSet.forEach(val => {
536
- if(val.isQuoteExpired()) {
537
- removeSwaps.push(val);
538
- } else {
539
- changedSwaps.push(val);
540
- }
541
- });
542
-
543
- return {
544
- changedSwaps,
545
- removeSwaps
546
- };
547
- }
548
-
549
- /**
550
- * @inheritDoc
551
- * @internal
552
- */
553
- async recoverFromSwapDataAndState(
554
- init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
555
- state: SwapCommitState,
556
- contractVersion: string,
557
- lp?: Intermediary
558
- ): Promise<FromBTCLNSwap<T> | null> {
559
- const data = init.data;
560
-
561
- let paymentHash = data.getHTLCHashHint();
562
- let secret: string | undefined;
563
- if(state.type===SwapCommitStateType.PAID) {
564
- secret = await state.getClaimResult();
565
- paymentHash = Buffer.from(sha256(Buffer.from(secret, "hex"))).toString("hex");
566
- }
567
-
568
- const swapInit: FromBTCLNSwapInit<T["Data"]> = {
569
- pricingInfo: {
570
- isValid: true,
571
- satsBaseFee: 0n,
572
- swapPriceUSatPerToken: 100_000_000_000_000n,
573
- realPriceUSatPerToken: 100_000_000_000_000n,
574
- differencePPM: 0n,
575
- feePPM: 0n,
576
- },
577
- url: lp?.url,
578
- expiry: 0,
579
- swapFee: 0n,
580
- swapFeeBtc: 0n,
581
- feeRate: "",
582
- signatureData: undefined,
583
- initialSwapData: data,
584
- data,
585
- pr: paymentHash ?? undefined,
586
- secret,
587
- exactIn: false,
588
- contractVersion
589
- }
590
- const swap = new FromBTCLNSwap(this, swapInit);
591
- swap._commitTxId = await init.getInitTxId();
592
- const blockData = await init.getTxBlock();
593
- swap.createdAt = blockData.blockTime * 1000;
594
- swap._setInitiated();
595
- swap._state = FromBTCLNSwapState.CLAIM_COMMITED;
596
- await swap._sync(false, false, state);
597
- await swap._save();
598
- return swap;
599
- }
600
-
601
- }
1
+ import {FromBTCLNSwap, FromBTCLNSwapInit, FromBTCLNSwapState} from "./FromBTCLNSwap";
2
+ import {decode as bolt11Decode, PaymentRequestObject, TagsObject} from "@atomiqlabs/bolt11";
3
+ import {
4
+ ChainSwapType,
5
+ ChainType,
6
+ ClaimEvent,
7
+ InitializeEvent, LightningNetworkApi, LNNodeLiquidity,
8
+ RefundEvent, SwapCommitState, SwapCommitStateType
9
+ } from "@atomiqlabs/base";
10
+ import {Intermediary} from "../../../../intermediaries/Intermediary";
11
+ import {Buffer} from "buffer";
12
+ import {UserError} from "../../../../errors/UserError";
13
+ import {IntermediaryError} from "../../../../errors/IntermediaryError";
14
+ import {SwapType} from "../../../../enums/SwapType";
15
+ import {
16
+ extendAbortController, mapArrayToObject, parseHashValueExact32Bytes,
17
+ throwIfUndefined
18
+ } from "../../../../utils/Utils";
19
+ import {FromBTCLNResponseType, IntermediaryAPI} from "../../../../intermediaries/apis/IntermediaryAPI";
20
+ import {RequestError} from "../../../../errors/RequestError";
21
+ import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
22
+ import {EventEmitter} from "events";
23
+ import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
24
+ import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
25
+ import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
26
+ import {ISwap} from "../../../ISwap";
27
+ import {IFromBTCLNDefinition, IFromBTCLNWrapper} from "../IFromBTCLNWrapper";
28
+ import {IClaimableSwapWrapper} from "../../../IClaimableSwapWrapper";
29
+ import {AmountData} from "../../../../types/AmountData";
30
+ import {LNURLWithdrawParamsWithUrl} from "../../../../types/lnurl/LNURLWithdraw";
31
+ import {tryWithRetries} from "../../../../utils/RetryUtils";
32
+ import {AllOptional} from "../../../../utils/TypeUtils";
33
+ import {sha256} from "@noble/hashes/sha2";
34
+
35
+ export type FromBTCLNOptions = {
36
+ /**
37
+ * Instead of letting the SDK generate the preimage/paymentHash pair internally you can pass your computed
38
+ * paymentHash here, this will create the swap with the provided payment hash. Note that you would then
39
+ * have to reveal the preimage by passing it to the {@link FromBTCLNSwap.claim} or {@link FromBTCLNSwap.txsClaim}
40
+ * functions
41
+ *
42
+ * Accepts both, a {@link Buffer} and a hexadecimal `string`
43
+ */
44
+ paymentHash?: Buffer | string,
45
+ /**
46
+ * Optional description to use for the swap lightning network invoice, keep the invoice length below 500 characters
47
+ */
48
+ description?: string,
49
+ /**
50
+ * Optional description hash to use for the lightning network invoice, useful when returning the invoice as part of
51
+ * an LNURL-pay service endpoint.
52
+ *
53
+ * Accepts both, a {@link Buffer} and a hexadecimal `string`
54
+ */
55
+ descriptionHash?: Buffer | string,
56
+ /**
57
+ * A flag to skip checking whether the lightning network node of the LP has enough channel liquidity to facilitate
58
+ * the swap.
59
+ */
60
+ unsafeSkipLnNodeCheck?: boolean
61
+ };
62
+
63
+ export type FromBTCLNWrapperOptions = ISwapWrapperOptions & {
64
+ unsafeSkipLnNodeCheck: boolean,
65
+ safetyFactor: number,
66
+ bitcoinBlocktime: number
67
+ };
68
+
69
+ export type FromBTCLNDefinition<T extends ChainType> = IFromBTCLNDefinition<T, FromBTCLNWrapper<T>, FromBTCLNSwap<T>>;
70
+
71
+ /**
72
+ * Legacy escrow (HTLC) based swap for Bitcoin Lightning -> Smart chains, requires manual settlement
73
+ * of the swap on the destination network once the lightning network payment is received by the LP.
74
+ *
75
+ * @category Swaps/Legacy/Lightning → Smart chain
76
+ */
77
+ export class FromBTCLNWrapper<
78
+ T extends ChainType
79
+ > extends IFromBTCLNWrapper<T, FromBTCLNDefinition<T>, FromBTCLNWrapperOptions> implements IClaimableSwapWrapper<FromBTCLNSwap<T>> {
80
+
81
+ public readonly TYPE: SwapType.FROM_BTCLN = SwapType.FROM_BTCLN;
82
+
83
+ /**
84
+ * @internal
85
+ */
86
+ protected readonly tickSwapState = [
87
+ FromBTCLNSwapState.PR_CREATED,
88
+ FromBTCLNSwapState.PR_PAID,
89
+ FromBTCLNSwapState.CLAIM_COMMITED
90
+ ];
91
+
92
+ /**
93
+ * @internal
94
+ */
95
+ readonly _pendingSwapStates = [
96
+ FromBTCLNSwapState.PR_CREATED,
97
+ FromBTCLNSwapState.QUOTE_SOFT_EXPIRED,
98
+ FromBTCLNSwapState.PR_PAID,
99
+ FromBTCLNSwapState.CLAIM_COMMITED,
100
+ FromBTCLNSwapState.EXPIRED
101
+ ];
102
+ /**
103
+ * @internal
104
+ */
105
+ readonly _claimableSwapStates = [FromBTCLNSwapState.CLAIM_COMMITED];
106
+ /**
107
+ * @internal
108
+ */
109
+ readonly _swapDeserializer = FromBTCLNSwap;
110
+
111
+ /**
112
+ * @param chainIdentifier
113
+ * @param unifiedStorage Storage interface for the current environment
114
+ * @param unifiedChainEvents On-chain event listener
115
+ * @param chain
116
+ * @param prices Swap pricing handler
117
+ * @param tokens
118
+ * @param versionedContracts
119
+ * @param lnApi
120
+ * @param options
121
+ * @param events Instance to use for emitting events
122
+ */
123
+ constructor(
124
+ chainIdentifier: string,
125
+ unifiedStorage: UnifiedSwapStorage<T>,
126
+ unifiedChainEvents: UnifiedSwapEventListener<T>,
127
+ chain: T["ChainInterface"],
128
+ prices: ISwapPrice,
129
+ tokens: WrapperCtorTokens,
130
+ versionedContracts: {
131
+ [version: string]: {
132
+ swapContract: T["Contract"],
133
+ swapDataConstructor: new (data: any) => T["Data"]
134
+ }
135
+ },
136
+ lnApi: LightningNetworkApi,
137
+ options?: AllOptional<FromBTCLNWrapperOptions>,
138
+ events?: EventEmitter<{swapState: [ISwap]}>
139
+ ) {
140
+ super(
141
+ chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi,
142
+ {
143
+ ...options,
144
+ safetyFactor: options?.safetyFactor ?? 2,
145
+ bitcoinBlocktime: options?.bitcoinBlocktime ?? 10*60,
146
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? false
147
+ },
148
+ events
149
+ );
150
+ }
151
+
152
+ /**
153
+ * @inheritDoc
154
+ * @internal
155
+ */
156
+ protected processEventInitialize(swap: FromBTCLNSwap<T>, event: InitializeEvent<T["Data"]>): Promise<boolean> {
157
+ if(swap._state===FromBTCLNSwapState.PR_PAID || swap._state===FromBTCLNSwapState.QUOTE_SOFT_EXPIRED) {
158
+ swap._state = FromBTCLNSwapState.CLAIM_COMMITED;
159
+ return Promise.resolve(true);
160
+ }
161
+ return Promise.resolve(false);
162
+ }
163
+
164
+ /**
165
+ * @inheritDoc
166
+ * @internal
167
+ */
168
+ protected processEventClaim(swap: FromBTCLNSwap<T>, event: ClaimEvent<T["Data"]>): Promise<boolean> {
169
+ if(swap._state!==FromBTCLNSwapState.FAILED && swap._state!==FromBTCLNSwapState.CLAIM_CLAIMED) {
170
+ swap._state = FromBTCLNSwapState.CLAIM_CLAIMED;
171
+ swap._setSwapSecret(event.result);
172
+ return Promise.resolve(true);
173
+ }
174
+ return Promise.resolve(false);
175
+ }
176
+
177
+ /**
178
+ * @inheritDoc
179
+ * @internal
180
+ */
181
+ protected processEventRefund(swap: FromBTCLNSwap<T>, event: RefundEvent<T["Data"]>): Promise<boolean> {
182
+ if(swap._state!==FromBTCLNSwapState.CLAIM_CLAIMED && swap._state!==FromBTCLNSwapState.FAILED) {
183
+ swap._state = FromBTCLNSwapState.FAILED;
184
+ return Promise.resolve(true);
185
+ }
186
+ return Promise.resolve(false);
187
+ }
188
+
189
+ /**
190
+ * Verifies response returned from intermediary
191
+ *
192
+ * @param resp Response as returned by the intermediary
193
+ * @param amountData
194
+ * @param lp Intermediary
195
+ * @param options Options as passed to the swap creation function
196
+ * @param decodedPr Decoded bolt11 lightning network invoice
197
+ * @param paymentHash Expected payment hash of the bolt11 lightning network invoice
198
+ *
199
+ * @throws {IntermediaryError} in case the response is invalid
200
+ *
201
+ * @private
202
+ */
203
+ private verifyReturnedData(
204
+ resp: FromBTCLNResponseType,
205
+ amountData: AmountData,
206
+ lp: Intermediary,
207
+ options: {
208
+ descriptionHash?: Buffer,
209
+ description?: string
210
+ },
211
+ decodedPr: PaymentRequestObject & {tagsObject: TagsObject},
212
+ paymentHash: Buffer
213
+ ): void {
214
+ if(lp.getAddress(this.chainIdentifier)!==resp.intermediaryKey) throw new IntermediaryError("Invalid intermediary address/pubkey");
215
+
216
+ if(options.descriptionHash!=null && decodedPr.tagsObject.purpose_commit_hash!==options.descriptionHash.toString("hex"))
217
+ throw new IntermediaryError("Invalid pr returned - description hash");
218
+
219
+ if(options.description!=null && decodedPr.tagsObject.description!==options.description)
220
+ throw new IntermediaryError("Invalid pr returned - description");
221
+
222
+ if(
223
+ decodedPr.tagsObject.payment_hash==null ||
224
+ !Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash)
225
+ ) throw new IntermediaryError("Invalid pr returned - payment hash");
226
+
227
+ if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid pr returned - msat field");
228
+
229
+ if(!amountData.exactIn) {
230
+ if(resp.total != amountData.amount) throw new IntermediaryError("Invalid amount returned");
231
+ } else {
232
+ const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
233
+ if(amountIn !== amountData.amount) throw new IntermediaryError("Invalid payment request returned, amount mismatch");
234
+ }
235
+ }
236
+
237
+ /**
238
+ * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
239
+ * where the user needs to manually settle swap on the destination smart chain. The user has to pay
240
+ * a bolt11 invoice on the input lightning network side.
241
+ *
242
+ * @param recipient Smart chain signer's address on the destination chain, that will have to manually
243
+ * settle the swap.
244
+ * @param amountData Amount, token and exact input/output data for to swap
245
+ * @param lps An array of intermediaries (LPs) to get the quotes from
246
+ * @param options Optional additional quote options
247
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
248
+ * @param abortSignal Abort signal
249
+ * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
250
+ */
251
+ create(
252
+ recipient: string,
253
+ amountData: AmountData,
254
+ lps: Intermediary[],
255
+ options?: FromBTCLNOptions,
256
+ additionalParams?: Record<string, any>,
257
+ abortSignal?: AbortSignal,
258
+ preFetches?: {
259
+ usdPricePrefetchPromise: Promise<number | undefined>,
260
+ pricePrefetchPromise: Promise<bigint | undefined>,
261
+ feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
262
+ }
263
+ ): {
264
+ quote: Promise<FromBTCLNSwap<T>>,
265
+ intermediary: Intermediary
266
+ }[] {
267
+ if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
268
+
269
+ const _options = {
270
+ paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
271
+ description: options?.description,
272
+ descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash"),
273
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
274
+ };
275
+
276
+ if(_options.description!=null && Buffer.byteLength(_options.description, "utf8") > 500)
277
+ throw new UserError("Invalid description length");
278
+
279
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
280
+
281
+ let secret: Buffer | undefined;
282
+ let paymentHash: Buffer;
283
+ if(_options.paymentHash!=null) {
284
+ paymentHash = _options.paymentHash;
285
+ } else {
286
+ ({secret, paymentHash} = this.getSecretAndHash());
287
+ }
288
+ const _hash = mapArrayToObject(lpVersions, (contractVersion: string) => {
289
+ return this._contract(contractVersion).getHashForHtlc(paymentHash).toString("hex");
290
+ });
291
+
292
+ const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
293
+
294
+ const _abortController = extendAbortController(abortSignal);
295
+ const _preFetches = preFetches ?? {
296
+ pricePrefetchPromise: this.preFetchPrice(amountData, _abortController.signal),
297
+ feeRatePromise: this.preFetchFeeRate(recipient, amountData, _hash, _abortController, lpVersions),
298
+ usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
299
+ }
300
+
301
+ return lps.map(lp => {
302
+ return {
303
+ intermediary: lp,
304
+ quote: (async () => {
305
+ if(lp.services[SwapType.FROM_BTCLN]==null) throw new Error("LP service for processing from btcln swaps not found!");
306
+ const version = lp.getContractVersion(this.chainIdentifier);
307
+
308
+ const abortController = extendAbortController(_abortController.signal);
309
+
310
+ const liquidityPromise: Promise<bigint | undefined> = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
311
+
312
+ const {lnCapacityPromise, resp} = await tryWithRetries(async(retryCount: number) => {
313
+ const {lnPublicKey, response} = IntermediaryAPI.initFromBTCLN(
314
+ this.chainIdentifier, lp.url, nativeTokenAddress,
315
+ {
316
+ paymentHash,
317
+ amount: amountData.amount,
318
+ claimer: recipient,
319
+ token: amountData.token.toString(),
320
+ description: _options.description,
321
+ descriptionHash: _options.descriptionHash,
322
+ exactOut: !amountData.exactIn,
323
+ feeRate: throwIfUndefined(_preFetches.feeRatePromise[version]),
324
+ additionalParams
325
+ },
326
+ this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined
327
+ );
328
+
329
+ let lnCapacityPromise: Promise<LNNodeLiquidity | null> | undefined;
330
+ if(!_options.unsafeSkipLnNodeCheck) {
331
+ lnCapacityPromise = this.preFetchLnCapacity(lnPublicKey);
332
+ } else lnPublicKey.catch(() => {});
333
+
334
+ return {
335
+ lnCapacityPromise,
336
+ resp: await response
337
+ };
338
+ }, undefined, RequestError, abortController.signal);
339
+
340
+ const decodedPr = bolt11Decode(resp.pr);
341
+ if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid returned swap invoice, no msat amount field");
342
+ if(decodedPr.timeExpireDate==null) throw new IntermediaryError("Invalid returned swap invoice, no expiry date field");
343
+ const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
344
+
345
+ const swapFeeBtc = resp.swapFee * amountIn / (resp.total + resp.swapFee);
346
+
347
+ try {
348
+ this.verifyReturnedData(resp, amountData, lp, _options, decodedPr, paymentHash);
349
+ const [pricingInfo] = await Promise.all([
350
+ this.verifyReturnedPrice(
351
+ lp.services[SwapType.FROM_BTCLN], false, amountIn, resp.total,
352
+ amountData.token, {swapFeeBtc}, _preFetches.pricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal
353
+ ),
354
+ this.verifyIntermediaryLiquidity(resp.total, throwIfUndefined(liquidityPromise)),
355
+ lnCapacityPromise!=null ? this.verifyLnNodeCapacity(lp, decodedPr, lnCapacityPromise, abortController.signal) : Promise.resolve()
356
+ ]);
357
+
358
+ const quote = new FromBTCLNSwap<T>(this, {
359
+ pricingInfo,
360
+ url: lp.url,
361
+ expiry: decodedPr.timeExpireDate*1000,
362
+ swapFee: resp.swapFee,
363
+ swapFeeBtc,
364
+ feeRate: (await _preFetches.feeRatePromise[version])!,
365
+ initialSwapData: await this._contract(version).createSwapData(
366
+ ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token,
367
+ resp.total, _hash[version],
368
+ this.getRandomSequence(), BigInt(Math.floor(Date.now()/1000)), false, true,
369
+ resp.securityDeposit, 0n, nativeTokenAddress
370
+ ),
371
+ pr: resp.pr,
372
+ secret: secret?.toString("hex"),
373
+ exactIn: amountData.exactIn ?? true,
374
+ contractVersion: version
375
+ } as FromBTCLNSwapInit<T["Data"]>);
376
+ return quote;
377
+ } catch (e) {
378
+ abortController.abort(e);
379
+ throw e;
380
+ }
381
+ })()
382
+ }
383
+ });
384
+ }
385
+
386
+ /**
387
+ * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
388
+ * where the user needs to manually settle swap on the destination smart chain. The swap is created
389
+ * with an LNURL-withdraw link which will be used to pay the generated bolt11 invoice automatically
390
+ * when {@link FromBTCLNSwap.waitForPayment} is called on the swap.
391
+ *
392
+ * @param recipient Smart chain signer's address on the destination chain, that will have to manually
393
+ * settle the swap.
394
+ * @param lnurl LNURL-withdraw link to pull the funds from
395
+ * @param amountData Amount, token and exact input/output data for to swap
396
+ * @param lps An array of intermediaries (LPs) to get the quotes from
397
+ * @param options Optional additional quote options
398
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
399
+ * @param abortSignal Abort signal
400
+ */
401
+ async createViaLNURL(
402
+ recipient: string,
403
+ lnurl: string | LNURLWithdrawParamsWithUrl,
404
+ amountData: AmountData,
405
+ lps: Intermediary[],
406
+ options?: FromBTCLNOptions,
407
+ additionalParams?: Record<string, any>,
408
+ abortSignal?: AbortSignal
409
+ ): Promise<{
410
+ quote: Promise<FromBTCLNSwap<T>>,
411
+ intermediary: Intermediary
412
+ }[]> {
413
+ if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
414
+
415
+ const _options = {
416
+ paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
417
+ description: options?.description,
418
+ descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash"),
419
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
420
+ };
421
+
422
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
423
+
424
+ const abortController = extendAbortController(abortSignal);
425
+ const preFetches = {
426
+ pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
427
+ usdPricePrefetchPromise: this.preFetchUsdPrice(abortController.signal),
428
+ feeRatePromise: this.preFetchFeeRate(recipient, amountData, undefined, abortController, lpVersions)
429
+ };
430
+
431
+ try {
432
+ const exactOutAmountPromise: Promise<bigint | undefined> | undefined = !amountData.exactIn ? preFetches.pricePrefetchPromise.then(price =>
433
+ this._prices.getToBtcSwapAmount(this.chainIdentifier, amountData.amount, amountData.token, abortController.signal, price)
434
+ ).catch(e => {
435
+ abortController.abort(e);
436
+ return undefined;
437
+ }) : undefined;
438
+
439
+ const withdrawRequest = await this.getLNURLWithdraw(lnurl, abortController.signal);
440
+
441
+ const min = BigInt(withdrawRequest.minWithdrawable) / 1000n;
442
+ const max = BigInt(withdrawRequest.maxWithdrawable) / 1000n;
443
+
444
+ if(amountData.exactIn) {
445
+ if(amountData.amount < min) throw new UserError("Amount less than LNURL-withdraw minimum");
446
+ if(amountData.amount > max) throw new UserError("Amount more than LNURL-withdraw maximum");
447
+ } else {
448
+ const amount = (await exactOutAmountPromise)!;
449
+ abortController.signal.throwIfAborted();
450
+
451
+ if((amount * 95n / 100n) < min) throw new UserError("Amount less than LNURL-withdraw minimum");
452
+ if((amount * 105n / 100n) > max) throw new UserError("Amount more than LNURL-withdraw maximum");
453
+ }
454
+
455
+ return this.create(recipient, amountData, lps, _options, additionalParams, abortSignal, preFetches).map(data => {
456
+ return {
457
+ quote: data.quote.then(quote => {
458
+ quote._setLNURLData(
459
+ withdrawRequest.url,
460
+ withdrawRequest.k1,
461
+ withdrawRequest.callback
462
+ )
463
+
464
+ const amountIn = quote.getInput().rawAmount!;
465
+ if(amountIn < min) throw new UserError("Amount less than LNURL-withdraw minimum");
466
+ if(amountIn > max) throw new UserError("Amount more than LNURL-withdraw maximum");
467
+
468
+ return quote;
469
+ }),
470
+ intermediary: data.intermediary
471
+ }
472
+ });
473
+ } catch (e) {
474
+ abortController.abort(e);
475
+ throw e;
476
+ }
477
+ }
478
+
479
+ /**
480
+ * @inheritDoc
481
+ * @internal
482
+ */
483
+ protected async _checkPastSwaps(pastSwaps: FromBTCLNSwap<T>[]): Promise<{
484
+ changedSwaps: FromBTCLNSwap<T>[];
485
+ removeSwaps: FromBTCLNSwap<T>[]
486
+ }> {
487
+ const changedSwapSet: Set<FromBTCLNSwap<T>> = new Set();
488
+
489
+ const swapExpiredStatus: {[id: string]: boolean} = {};
490
+ const checkStatusSwaps: {[contractVersion: string]: (FromBTCLNSwap<T> & {_data: T["Data"]})[]} = {};
491
+
492
+ await Promise.all(pastSwaps.map(async (pastSwap) => {
493
+ if(pastSwap._shouldCheckIntermediary()) {
494
+ try {
495
+ const result = await pastSwap._checkIntermediaryPaymentReceived(false);
496
+ if(result!=null) {
497
+ changedSwapSet.add(pastSwap);
498
+ }
499
+ } catch (e) {
500
+ this.logger.error(`_checkPastSwaps(): Failed to contact LP regarding swap ${pastSwap.getId()}, error: `, e);
501
+ }
502
+ }
503
+ if(pastSwap._shouldFetchExpiryStatus()) {
504
+ //Check expiry
505
+ swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
506
+ }
507
+ if(pastSwap._shouldFetchOnchainState()) {
508
+ //Add to swaps for which status should be checked
509
+ if(pastSwap._data!=null) (checkStatusSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap as (FromBTCLNSwap<T> & {_data: T["Data"]}));
510
+ }
511
+ }));
512
+
513
+ for(let version in checkStatusSwaps) {
514
+ if(this._versionedContracts[version]==null) {
515
+ this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${version}! Skipping these swaps!`);
516
+ continue;
517
+ }
518
+
519
+ const _checkStatusSwap = checkStatusSwaps[version];
520
+ const swapStatuses = await this._contract(version).getCommitStatuses(_checkStatusSwap.map(val => ({signer: val._getInitiator(), swapData: val._data})));
521
+
522
+ for(let pastSwap of _checkStatusSwap) {
523
+ const shouldSave = await pastSwap._sync(
524
+ false, swapExpiredStatus[pastSwap.getId()],
525
+ swapStatuses[pastSwap.getEscrowHash()!], true
526
+ );
527
+ if(shouldSave) {
528
+ changedSwapSet.add(pastSwap);
529
+ }
530
+ }
531
+ }
532
+
533
+ const changedSwaps: FromBTCLNSwap<T>[] = [];
534
+ const removeSwaps: FromBTCLNSwap<T>[] = [];
535
+ changedSwapSet.forEach(val => {
536
+ if(val.isQuoteExpired()) {
537
+ removeSwaps.push(val);
538
+ } else {
539
+ changedSwaps.push(val);
540
+ }
541
+ });
542
+
543
+ return {
544
+ changedSwaps,
545
+ removeSwaps
546
+ };
547
+ }
548
+
549
+ /**
550
+ * @inheritDoc
551
+ * @internal
552
+ */
553
+ async recoverFromSwapDataAndState(
554
+ init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
555
+ state: SwapCommitState,
556
+ contractVersion: string,
557
+ lp?: Intermediary
558
+ ): Promise<FromBTCLNSwap<T> | null> {
559
+ const data = init.data;
560
+
561
+ let paymentHash = data.getHTLCHashHint();
562
+ let secret: string | undefined;
563
+ if(state.type===SwapCommitStateType.PAID) {
564
+ secret = await state.getClaimResult();
565
+ paymentHash = Buffer.from(sha256(Buffer.from(secret, "hex"))).toString("hex");
566
+ }
567
+
568
+ const swapInit: FromBTCLNSwapInit<T["Data"]> = {
569
+ pricingInfo: {
570
+ isValid: true,
571
+ satsBaseFee: 0n,
572
+ swapPriceUSatPerToken: 100_000_000_000_000n,
573
+ realPriceUSatPerToken: 100_000_000_000_000n,
574
+ differencePPM: 0n,
575
+ feePPM: 0n,
576
+ },
577
+ url: lp?.url,
578
+ expiry: 0,
579
+ swapFee: 0n,
580
+ swapFeeBtc: 0n,
581
+ feeRate: "",
582
+ signatureData: undefined,
583
+ initialSwapData: data,
584
+ data,
585
+ pr: paymentHash ?? undefined,
586
+ secret,
587
+ exactIn: false,
588
+ contractVersion
589
+ }
590
+ const swap = new FromBTCLNSwap(this, swapInit);
591
+ swap._commitTxId = await init.getInitTxId();
592
+ const blockData = await init.getTxBlock();
593
+ swap.createdAt = blockData.blockTime * 1000;
594
+ swap._setInitiated();
595
+ swap._state = FromBTCLNSwapState.CLAIM_COMMITED;
596
+ await swap._sync(false, false, state);
597
+ await swap._save();
598
+ return swap;
599
+ }
600
+
601
+ }