@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,603 +1,603 @@
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 lpApi
121
- * @param options
122
- * @param events Instance to use for emitting events
123
- */
124
- constructor(
125
- chainIdentifier: string,
126
- unifiedStorage: UnifiedSwapStorage<T>,
127
- unifiedChainEvents: UnifiedSwapEventListener<T>,
128
- chain: T["ChainInterface"],
129
- prices: ISwapPrice,
130
- tokens: WrapperCtorTokens,
131
- versionedContracts: {
132
- [version: string]: {
133
- swapContract: T["Contract"],
134
- swapDataConstructor: new (data: any) => T["Data"]
135
- }
136
- },
137
- lnApi: LightningNetworkApi,
138
- lpApi: IntermediaryAPI,
139
- options?: AllOptional<FromBTCLNWrapperOptions>,
140
- events?: EventEmitter<{swapState: [ISwap]}>
141
- ) {
142
- super(
143
- chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi, lpApi,
144
- {
145
- ...options,
146
- safetyFactor: options?.safetyFactor ?? 2,
147
- bitcoinBlocktime: options?.bitcoinBlocktime ?? 10*60,
148
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? false
149
- },
150
- events
151
- );
152
- }
153
-
154
- /**
155
- * @inheritDoc
156
- * @internal
157
- */
158
- protected processEventInitialize(swap: FromBTCLNSwap<T>, event: InitializeEvent<T["Data"]>): Promise<boolean> {
159
- if(swap._state===FromBTCLNSwapState.PR_PAID || swap._state===FromBTCLNSwapState.QUOTE_SOFT_EXPIRED) {
160
- swap._state = FromBTCLNSwapState.CLAIM_COMMITED;
161
- return Promise.resolve(true);
162
- }
163
- return Promise.resolve(false);
164
- }
165
-
166
- /**
167
- * @inheritDoc
168
- * @internal
169
- */
170
- protected processEventClaim(swap: FromBTCLNSwap<T>, event: ClaimEvent<T["Data"]>): Promise<boolean> {
171
- if(swap._state!==FromBTCLNSwapState.FAILED && swap._state!==FromBTCLNSwapState.CLAIM_CLAIMED) {
172
- swap._state = FromBTCLNSwapState.CLAIM_CLAIMED;
173
- swap._setSwapSecret(event.result);
174
- return Promise.resolve(true);
175
- }
176
- return Promise.resolve(false);
177
- }
178
-
179
- /**
180
- * @inheritDoc
181
- * @internal
182
- */
183
- protected processEventRefund(swap: FromBTCLNSwap<T>, event: RefundEvent<T["Data"]>): Promise<boolean> {
184
- if(swap._state!==FromBTCLNSwapState.CLAIM_CLAIMED && swap._state!==FromBTCLNSwapState.FAILED) {
185
- swap._state = FromBTCLNSwapState.FAILED;
186
- return Promise.resolve(true);
187
- }
188
- return Promise.resolve(false);
189
- }
190
-
191
- /**
192
- * Verifies response returned from intermediary
193
- *
194
- * @param resp Response as returned by the intermediary
195
- * @param amountData
196
- * @param lp Intermediary
197
- * @param options Options as passed to the swap creation function
198
- * @param decodedPr Decoded bolt11 lightning network invoice
199
- * @param paymentHash Expected payment hash of the bolt11 lightning network invoice
200
- *
201
- * @throws {IntermediaryError} in case the response is invalid
202
- *
203
- * @private
204
- */
205
- private verifyReturnedData(
206
- resp: FromBTCLNResponseType,
207
- amountData: AmountData,
208
- lp: Intermediary,
209
- options: {
210
- descriptionHash?: Buffer,
211
- description?: string
212
- },
213
- decodedPr: PaymentRequestObject & {tagsObject: TagsObject},
214
- paymentHash: Buffer
215
- ): void {
216
- if(lp.getAddress(this.chainIdentifier)!==resp.intermediaryKey) throw new IntermediaryError("Invalid intermediary address/pubkey");
217
-
218
- if(options.descriptionHash!=null && decodedPr.tagsObject.purpose_commit_hash!==options.descriptionHash.toString("hex"))
219
- throw new IntermediaryError("Invalid pr returned - description hash");
220
-
221
- if(options.description!=null && decodedPr.tagsObject.description!==options.description)
222
- throw new IntermediaryError("Invalid pr returned - description");
223
-
224
- if(
225
- decodedPr.tagsObject.payment_hash==null ||
226
- !Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash)
227
- ) throw new IntermediaryError("Invalid pr returned - payment hash");
228
-
229
- if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid pr returned - msat field");
230
-
231
- if(!amountData.exactIn) {
232
- if(resp.total != amountData.amount) throw new IntermediaryError("Invalid amount returned");
233
- } else {
234
- const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
235
- if(amountIn !== amountData.amount) throw new IntermediaryError("Invalid payment request returned, amount mismatch");
236
- }
237
- }
238
-
239
- /**
240
- * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
241
- * where the user needs to manually settle swap on the destination smart chain. The user has to pay
242
- * a bolt11 invoice on the input lightning network side.
243
- *
244
- * @param recipient Smart chain signer's address on the destination chain, that will have to manually
245
- * settle the swap.
246
- * @param amountData Amount, token and exact input/output data for to swap
247
- * @param lps An array of intermediaries (LPs) to get the quotes from
248
- * @param options Optional additional quote options
249
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
250
- * @param abortSignal Abort signal
251
- * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
252
- */
253
- create(
254
- recipient: string,
255
- amountData: AmountData,
256
- lps: Intermediary[],
257
- options?: FromBTCLNOptions,
258
- additionalParams?: Record<string, any>,
259
- abortSignal?: AbortSignal,
260
- preFetches?: {
261
- usdPricePrefetchPromise: Promise<number | undefined>,
262
- pricePrefetchPromise: Promise<bigint | undefined>,
263
- feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
264
- }
265
- ): {
266
- quote: Promise<FromBTCLNSwap<T>>,
267
- intermediary: Intermediary
268
- }[] {
269
- if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
270
-
271
- const _options = {
272
- paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
273
- description: options?.description,
274
- descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash"),
275
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
276
- };
277
-
278
- if(_options.description!=null && Buffer.byteLength(_options.description, "utf8") > 500)
279
- throw new UserError("Invalid description length");
280
-
281
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
282
-
283
- let secret: Buffer | undefined;
284
- let paymentHash: Buffer;
285
- if(_options.paymentHash!=null) {
286
- paymentHash = _options.paymentHash;
287
- } else {
288
- ({secret, paymentHash} = this.getSecretAndHash());
289
- }
290
- const _hash = mapArrayToObject(lpVersions, (contractVersion: string) => {
291
- return this._contract(contractVersion).getHashForHtlc(paymentHash).toString("hex");
292
- });
293
-
294
- const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
295
-
296
- const _abortController = extendAbortController(abortSignal);
297
- const _preFetches = preFetches ?? {
298
- pricePrefetchPromise: this.preFetchPrice(amountData, _abortController.signal),
299
- feeRatePromise: this.preFetchFeeRate(recipient, amountData, _hash, _abortController, lpVersions),
300
- usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
301
- }
302
-
303
- return lps.map(lp => {
304
- return {
305
- intermediary: lp,
306
- quote: (async () => {
307
- if(lp.services[SwapType.FROM_BTCLN]==null) throw new Error("LP service for processing from btcln swaps not found!");
308
- const version = lp.getContractVersion(this.chainIdentifier);
309
-
310
- const abortController = extendAbortController(_abortController.signal);
311
-
312
- const liquidityPromise: Promise<bigint | undefined> = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
313
-
314
- const {lnCapacityPromise, resp} = await tryWithRetries(async(retryCount: number) => {
315
- const {lnPublicKey, response} = this._lpApi.initFromBTCLN(
316
- this.chainIdentifier, lp.url, nativeTokenAddress,
317
- {
318
- paymentHash,
319
- amount: amountData.amount,
320
- claimer: recipient,
321
- token: amountData.token.toString(),
322
- description: _options.description,
323
- descriptionHash: _options.descriptionHash,
324
- exactOut: !amountData.exactIn,
325
- feeRate: throwIfUndefined(_preFetches.feeRatePromise[version], "Network fee rate pre-fetch failed!"),
326
- additionalParams
327
- },
328
- this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined
329
- );
330
-
331
- let lnCapacityPromise: Promise<LNNodeLiquidity | null> | undefined;
332
- if(!_options.unsafeSkipLnNodeCheck) {
333
- lnCapacityPromise = this.preFetchLnCapacity(lnPublicKey);
334
- } else lnPublicKey.catch(() => {});
335
-
336
- return {
337
- lnCapacityPromise,
338
- resp: await response
339
- };
340
- }, undefined, RequestError, abortController.signal);
341
-
342
- const decodedPr = bolt11Decode(resp.pr);
343
- if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid returned swap invoice, no msat amount field");
344
- if(decodedPr.timeExpireDate==null) throw new IntermediaryError("Invalid returned swap invoice, no expiry date field");
345
- const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
346
-
347
- const swapFeeBtc = resp.swapFee * amountIn / (resp.total + resp.swapFee);
348
-
349
- try {
350
- this.verifyReturnedData(resp, amountData, lp, _options, decodedPr, paymentHash);
351
- const [pricingInfo] = await Promise.all([
352
- this.verifyReturnedPrice(
353
- lp.services[SwapType.FROM_BTCLN], false, amountIn, resp.total,
354
- amountData.token, {swapFeeBtc}, _preFetches.pricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal
355
- ),
356
- this.verifyIntermediaryLiquidity(resp.total, throwIfUndefined(liquidityPromise, "LP liquidity pre-fetch failed!")),
357
- lnCapacityPromise!=null ? this.verifyLnNodeCapacity(lp, decodedPr, lnCapacityPromise, abortController.signal) : Promise.resolve()
358
- ]);
359
-
360
- const quote = new FromBTCLNSwap<T>(this, {
361
- pricingInfo,
362
- url: lp.url,
363
- expiry: decodedPr.timeExpireDate*1000,
364
- swapFee: resp.swapFee,
365
- swapFeeBtc,
366
- feeRate: (await _preFetches.feeRatePromise[version])!,
367
- initialSwapData: await this._contract(version).createSwapData(
368
- ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token,
369
- resp.total, _hash[version],
370
- this.getRandomSequence(), BigInt(Math.floor(Date.now()/1000)), false, true,
371
- resp.securityDeposit, 0n, nativeTokenAddress
372
- ),
373
- pr: resp.pr,
374
- secret: secret?.toString("hex"),
375
- exactIn: amountData.exactIn ?? true,
376
- contractVersion: version
377
- } as FromBTCLNSwapInit<T["Data"]>);
378
- return quote;
379
- } catch (e) {
380
- abortController.abort(e);
381
- throw e;
382
- }
383
- })()
384
- }
385
- });
386
- }
387
-
388
- /**
389
- * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
390
- * where the user needs to manually settle swap on the destination smart chain. The swap is created
391
- * with an LNURL-withdraw link which will be used to pay the generated bolt11 invoice automatically
392
- * when {@link FromBTCLNSwap.waitForPayment} is called on the swap.
393
- *
394
- * @param recipient Smart chain signer's address on the destination chain, that will have to manually
395
- * settle the swap.
396
- * @param lnurl LNURL-withdraw link to pull the funds from
397
- * @param amountData Amount, token and exact input/output data for to swap
398
- * @param lps An array of intermediaries (LPs) to get the quotes from
399
- * @param options Optional additional quote options
400
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
401
- * @param abortSignal Abort signal
402
- */
403
- async createViaLNURL(
404
- recipient: string,
405
- lnurl: string | LNURLWithdrawParamsWithUrl,
406
- amountData: AmountData,
407
- lps: Intermediary[],
408
- options?: FromBTCLNOptions,
409
- additionalParams?: Record<string, any>,
410
- abortSignal?: AbortSignal
411
- ): Promise<{
412
- quote: Promise<FromBTCLNSwap<T>>,
413
- intermediary: Intermediary
414
- }[]> {
415
- if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
416
-
417
- const _options = {
418
- paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
419
- description: options?.description,
420
- descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash"),
421
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
422
- };
423
-
424
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
425
-
426
- const abortController = extendAbortController(abortSignal);
427
- const preFetches = {
428
- pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
429
- usdPricePrefetchPromise: this.preFetchUsdPrice(abortController.signal),
430
- feeRatePromise: this.preFetchFeeRate(recipient, amountData, undefined, abortController, lpVersions)
431
- };
432
-
433
- try {
434
- const exactOutAmountPromise: Promise<bigint | undefined> | undefined = !amountData.exactIn ? preFetches.pricePrefetchPromise.then(price =>
435
- this._prices.getToBtcSwapAmount(this.chainIdentifier, amountData.amount, amountData.token, abortController.signal, price)
436
- ).catch(e => {
437
- abortController.abort(e);
438
- return undefined;
439
- }) : undefined;
440
-
441
- const withdrawRequest = await this.getLNURLWithdraw(lnurl, abortController.signal);
442
-
443
- const min = BigInt(withdrawRequest.minWithdrawable) / 1000n;
444
- const max = BigInt(withdrawRequest.maxWithdrawable) / 1000n;
445
-
446
- if(amountData.exactIn) {
447
- if(amountData.amount < min) throw new UserError("Amount less than LNURL-withdraw minimum");
448
- if(amountData.amount > max) throw new UserError("Amount more than LNURL-withdraw maximum");
449
- } else {
450
- const amount = (await exactOutAmountPromise)!;
451
- abortController.signal.throwIfAborted();
452
-
453
- if((amount * 95n / 100n) < min) throw new UserError("Amount less than LNURL-withdraw minimum");
454
- if((amount * 105n / 100n) > max) throw new UserError("Amount more than LNURL-withdraw maximum");
455
- }
456
-
457
- return this.create(recipient, amountData, lps, _options, additionalParams, abortSignal, preFetches).map(data => {
458
- return {
459
- quote: data.quote.then(quote => {
460
- quote._setLNURLData(
461
- withdrawRequest.url,
462
- withdrawRequest.k1,
463
- withdrawRequest.callback
464
- )
465
-
466
- const amountIn = quote.getInput().rawAmount!;
467
- if(amountIn < min) throw new UserError("Amount less than LNURL-withdraw minimum");
468
- if(amountIn > max) throw new UserError("Amount more than LNURL-withdraw maximum");
469
-
470
- return quote;
471
- }),
472
- intermediary: data.intermediary
473
- }
474
- });
475
- } catch (e) {
476
- abortController.abort(e);
477
- throw e;
478
- }
479
- }
480
-
481
- /**
482
- * @inheritDoc
483
- * @internal
484
- */
485
- protected async _checkPastSwaps(pastSwaps: FromBTCLNSwap<T>[]): Promise<{
486
- changedSwaps: FromBTCLNSwap<T>[];
487
- removeSwaps: FromBTCLNSwap<T>[]
488
- }> {
489
- const changedSwapSet: Set<FromBTCLNSwap<T>> = new Set();
490
-
491
- const swapExpiredStatus: {[id: string]: boolean} = {};
492
- const checkStatusSwaps: {[contractVersion: string]: (FromBTCLNSwap<T> & {_data: T["Data"]})[]} = {};
493
-
494
- await Promise.all(pastSwaps.map(async (pastSwap) => {
495
- if(pastSwap._shouldCheckIntermediary()) {
496
- try {
497
- const result = await pastSwap._checkIntermediaryPaymentReceived(false);
498
- if(result!=null) {
499
- changedSwapSet.add(pastSwap);
500
- }
501
- } catch (e) {
502
- this.logger.error(`_checkPastSwaps(): Failed to contact LP regarding swap ${pastSwap.getId()}, error: `, e);
503
- }
504
- }
505
- if(pastSwap._shouldFetchExpiryStatus()) {
506
- //Check expiry
507
- swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
508
- }
509
- if(pastSwap._shouldFetchOnchainState()) {
510
- //Add to swaps for which status should be checked
511
- if(pastSwap._data!=null) (checkStatusSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap as (FromBTCLNSwap<T> & {_data: T["Data"]}));
512
- }
513
- }));
514
-
515
- for(let version in checkStatusSwaps) {
516
- if(this._versionedContracts[version]==null) {
517
- this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${version}! Skipping these swaps!`);
518
- continue;
519
- }
520
-
521
- const _checkStatusSwap = checkStatusSwaps[version];
522
- const swapStatuses = await this._contract(version).getCommitStatuses(_checkStatusSwap.map(val => ({signer: val._getInitiator(), swapData: val._data})));
523
-
524
- for(let pastSwap of _checkStatusSwap) {
525
- const shouldSave = await pastSwap._sync(
526
- false, swapExpiredStatus[pastSwap.getId()],
527
- swapStatuses[pastSwap.getEscrowHash()!], true
528
- );
529
- if(shouldSave) {
530
- changedSwapSet.add(pastSwap);
531
- }
532
- }
533
- }
534
-
535
- const changedSwaps: FromBTCLNSwap<T>[] = [];
536
- const removeSwaps: FromBTCLNSwap<T>[] = [];
537
- changedSwapSet.forEach(val => {
538
- if(val.isQuoteExpired()) {
539
- removeSwaps.push(val);
540
- } else {
541
- changedSwaps.push(val);
542
- }
543
- });
544
-
545
- return {
546
- changedSwaps,
547
- removeSwaps
548
- };
549
- }
550
-
551
- /**
552
- * @inheritDoc
553
- * @internal
554
- */
555
- async recoverFromSwapDataAndState(
556
- init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
557
- state: SwapCommitState,
558
- contractVersion: string,
559
- lp?: Intermediary
560
- ): Promise<FromBTCLNSwap<T> | null> {
561
- const data = init.data;
562
-
563
- let paymentHash = data.getHTLCHashHint();
564
- let secret: string | undefined;
565
- if(state.type===SwapCommitStateType.PAID) {
566
- secret = await state.getClaimResult();
567
- paymentHash = Buffer.from(sha256(Buffer.from(secret, "hex"))).toString("hex");
568
- }
569
-
570
- const swapInit: FromBTCLNSwapInit<T["Data"]> = {
571
- pricingInfo: {
572
- isValid: true,
573
- satsBaseFee: 0n,
574
- swapPriceUSatPerToken: 100_000_000_000_000n,
575
- realPriceUSatPerToken: 100_000_000_000_000n,
576
- differencePPM: 0n,
577
- feePPM: 0n,
578
- },
579
- url: lp?.url,
580
- expiry: 0,
581
- swapFee: 0n,
582
- swapFeeBtc: 0n,
583
- feeRate: "",
584
- signatureData: undefined,
585
- initialSwapData: data,
586
- data,
587
- pr: paymentHash ?? undefined,
588
- secret,
589
- exactIn: false,
590
- contractVersion
591
- }
592
- const swap = new FromBTCLNSwap(this, swapInit);
593
- swap._commitTxId = await init.getInitTxId();
594
- const blockData = await init.getTxBlock();
595
- swap.createdAt = blockData.blockTime * 1000;
596
- swap._setInitiated();
597
- swap._state = FromBTCLNSwapState.CLAIM_COMMITED;
598
- await swap._sync(false, false, state);
599
- await swap._save();
600
- return swap;
601
- }
602
-
603
- }
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 lpApi
121
+ * @param options
122
+ * @param events Instance to use for emitting events
123
+ */
124
+ constructor(
125
+ chainIdentifier: string,
126
+ unifiedStorage: UnifiedSwapStorage<T>,
127
+ unifiedChainEvents: UnifiedSwapEventListener<T>,
128
+ chain: T["ChainInterface"],
129
+ prices: ISwapPrice,
130
+ tokens: WrapperCtorTokens,
131
+ versionedContracts: {
132
+ [version: string]: {
133
+ swapContract: T["Contract"],
134
+ swapDataConstructor: new (data: any) => T["Data"]
135
+ }
136
+ },
137
+ lnApi: LightningNetworkApi,
138
+ lpApi: IntermediaryAPI,
139
+ options?: AllOptional<FromBTCLNWrapperOptions>,
140
+ events?: EventEmitter<{swapState: [ISwap]}>
141
+ ) {
142
+ super(
143
+ chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi, lpApi,
144
+ {
145
+ ...options,
146
+ safetyFactor: options?.safetyFactor ?? 2,
147
+ bitcoinBlocktime: options?.bitcoinBlocktime ?? 10*60,
148
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? false
149
+ },
150
+ events
151
+ );
152
+ }
153
+
154
+ /**
155
+ * @inheritDoc
156
+ * @internal
157
+ */
158
+ protected processEventInitialize(swap: FromBTCLNSwap<T>, event: InitializeEvent<T["Data"]>): Promise<boolean> {
159
+ if(swap._state===FromBTCLNSwapState.PR_PAID || swap._state===FromBTCLNSwapState.QUOTE_SOFT_EXPIRED) {
160
+ swap._state = FromBTCLNSwapState.CLAIM_COMMITED;
161
+ return Promise.resolve(true);
162
+ }
163
+ return Promise.resolve(false);
164
+ }
165
+
166
+ /**
167
+ * @inheritDoc
168
+ * @internal
169
+ */
170
+ protected processEventClaim(swap: FromBTCLNSwap<T>, event: ClaimEvent<T["Data"]>): Promise<boolean> {
171
+ if(swap._state!==FromBTCLNSwapState.FAILED && swap._state!==FromBTCLNSwapState.CLAIM_CLAIMED) {
172
+ swap._state = FromBTCLNSwapState.CLAIM_CLAIMED;
173
+ swap._setSwapSecret(event.result);
174
+ return Promise.resolve(true);
175
+ }
176
+ return Promise.resolve(false);
177
+ }
178
+
179
+ /**
180
+ * @inheritDoc
181
+ * @internal
182
+ */
183
+ protected processEventRefund(swap: FromBTCLNSwap<T>, event: RefundEvent<T["Data"]>): Promise<boolean> {
184
+ if(swap._state!==FromBTCLNSwapState.CLAIM_CLAIMED && swap._state!==FromBTCLNSwapState.FAILED) {
185
+ swap._state = FromBTCLNSwapState.FAILED;
186
+ return Promise.resolve(true);
187
+ }
188
+ return Promise.resolve(false);
189
+ }
190
+
191
+ /**
192
+ * Verifies response returned from intermediary
193
+ *
194
+ * @param resp Response as returned by the intermediary
195
+ * @param amountData
196
+ * @param lp Intermediary
197
+ * @param options Options as passed to the swap creation function
198
+ * @param decodedPr Decoded bolt11 lightning network invoice
199
+ * @param paymentHash Expected payment hash of the bolt11 lightning network invoice
200
+ *
201
+ * @throws {IntermediaryError} in case the response is invalid
202
+ *
203
+ * @private
204
+ */
205
+ private verifyReturnedData(
206
+ resp: FromBTCLNResponseType,
207
+ amountData: AmountData,
208
+ lp: Intermediary,
209
+ options: {
210
+ descriptionHash?: Buffer,
211
+ description?: string
212
+ },
213
+ decodedPr: PaymentRequestObject & {tagsObject: TagsObject},
214
+ paymentHash: Buffer
215
+ ): void {
216
+ if(lp.getAddress(this.chainIdentifier)!==resp.intermediaryKey) throw new IntermediaryError("Invalid intermediary address/pubkey");
217
+
218
+ if(options.descriptionHash!=null && decodedPr.tagsObject.purpose_commit_hash!==options.descriptionHash.toString("hex"))
219
+ throw new IntermediaryError("Invalid pr returned - description hash");
220
+
221
+ if(options.description!=null && decodedPr.tagsObject.description!==options.description)
222
+ throw new IntermediaryError("Invalid pr returned - description");
223
+
224
+ if(
225
+ decodedPr.tagsObject.payment_hash==null ||
226
+ !Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash)
227
+ ) throw new IntermediaryError("Invalid pr returned - payment hash");
228
+
229
+ if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid pr returned - msat field");
230
+
231
+ if(!amountData.exactIn) {
232
+ if(resp.total != amountData.amount) throw new IntermediaryError("Invalid amount returned");
233
+ } else {
234
+ const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
235
+ if(amountIn !== amountData.amount) throw new IntermediaryError("Invalid payment request returned, amount mismatch");
236
+ }
237
+ }
238
+
239
+ /**
240
+ * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
241
+ * where the user needs to manually settle swap on the destination smart chain. The user has to pay
242
+ * a bolt11 invoice on the input lightning network side.
243
+ *
244
+ * @param recipient Smart chain signer's address on the destination chain, that will have to manually
245
+ * settle the swap.
246
+ * @param amountData Amount, token and exact input/output data for to swap
247
+ * @param lps An array of intermediaries (LPs) to get the quotes from
248
+ * @param options Optional additional quote options
249
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
250
+ * @param abortSignal Abort signal
251
+ * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
252
+ */
253
+ create(
254
+ recipient: string,
255
+ amountData: AmountData,
256
+ lps: Intermediary[],
257
+ options?: FromBTCLNOptions,
258
+ additionalParams?: Record<string, any>,
259
+ abortSignal?: AbortSignal,
260
+ preFetches?: {
261
+ usdPricePrefetchPromise: Promise<number | undefined>,
262
+ pricePrefetchPromise: Promise<bigint | undefined>,
263
+ feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
264
+ }
265
+ ): {
266
+ quote: Promise<FromBTCLNSwap<T>>,
267
+ intermediary: Intermediary
268
+ }[] {
269
+ if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
270
+
271
+ const _options = {
272
+ paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
273
+ description: options?.description,
274
+ descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash"),
275
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
276
+ };
277
+
278
+ if(_options.description!=null && Buffer.byteLength(_options.description, "utf8") > 500)
279
+ throw new UserError("Invalid description length");
280
+
281
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
282
+
283
+ let secret: Buffer | undefined;
284
+ let paymentHash: Buffer;
285
+ if(_options.paymentHash!=null) {
286
+ paymentHash = _options.paymentHash;
287
+ } else {
288
+ ({secret, paymentHash} = this.getSecretAndHash());
289
+ }
290
+ const _hash = mapArrayToObject(lpVersions, (contractVersion: string) => {
291
+ return this._contract(contractVersion).getHashForHtlc(paymentHash).toString("hex");
292
+ });
293
+
294
+ const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
295
+
296
+ const _abortController = extendAbortController(abortSignal);
297
+ const _preFetches = preFetches ?? {
298
+ pricePrefetchPromise: this.preFetchPrice(amountData, _abortController.signal),
299
+ feeRatePromise: this.preFetchFeeRate(recipient, amountData, _hash, _abortController, lpVersions),
300
+ usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
301
+ }
302
+
303
+ return lps.map(lp => {
304
+ return {
305
+ intermediary: lp,
306
+ quote: (async () => {
307
+ if(lp.services[SwapType.FROM_BTCLN]==null) throw new Error("LP service for processing from btcln swaps not found!");
308
+ const version = lp.getContractVersion(this.chainIdentifier);
309
+
310
+ const abortController = extendAbortController(_abortController.signal);
311
+
312
+ const liquidityPromise: Promise<bigint | undefined> = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
313
+
314
+ const {lnCapacityPromise, resp} = await tryWithRetries(async(retryCount: number) => {
315
+ const {lnPublicKey, response} = this._lpApi.initFromBTCLN(
316
+ this.chainIdentifier, lp.url, nativeTokenAddress,
317
+ {
318
+ paymentHash,
319
+ amount: amountData.amount,
320
+ claimer: recipient,
321
+ token: amountData.token.toString(),
322
+ description: _options.description,
323
+ descriptionHash: _options.descriptionHash,
324
+ exactOut: !amountData.exactIn,
325
+ feeRate: throwIfUndefined(_preFetches.feeRatePromise[version], "Network fee rate pre-fetch failed!"),
326
+ additionalParams
327
+ },
328
+ this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined
329
+ );
330
+
331
+ let lnCapacityPromise: Promise<LNNodeLiquidity | null> | undefined;
332
+ if(!_options.unsafeSkipLnNodeCheck) {
333
+ lnCapacityPromise = this.preFetchLnCapacity(lnPublicKey);
334
+ } else lnPublicKey.catch(() => {});
335
+
336
+ return {
337
+ lnCapacityPromise,
338
+ resp: await response
339
+ };
340
+ }, undefined, RequestError, abortController.signal);
341
+
342
+ const decodedPr = bolt11Decode(resp.pr);
343
+ if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid returned swap invoice, no msat amount field");
344
+ if(decodedPr.timeExpireDate==null) throw new IntermediaryError("Invalid returned swap invoice, no expiry date field");
345
+ const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
346
+
347
+ const swapFeeBtc = resp.swapFee * amountIn / (resp.total + resp.swapFee);
348
+
349
+ try {
350
+ this.verifyReturnedData(resp, amountData, lp, _options, decodedPr, paymentHash);
351
+ const [pricingInfo] = await Promise.all([
352
+ this.verifyReturnedPrice(
353
+ lp.services[SwapType.FROM_BTCLN], false, amountIn, resp.total,
354
+ amountData.token, {swapFeeBtc}, _preFetches.pricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal
355
+ ),
356
+ this.verifyIntermediaryLiquidity(resp.total, throwIfUndefined(liquidityPromise, "LP liquidity pre-fetch failed!")),
357
+ lnCapacityPromise!=null ? this.verifyLnNodeCapacity(lp, decodedPr, lnCapacityPromise, abortController.signal) : Promise.resolve()
358
+ ]);
359
+
360
+ const quote = new FromBTCLNSwap<T>(this, {
361
+ pricingInfo,
362
+ url: lp.url,
363
+ expiry: decodedPr.timeExpireDate*1000,
364
+ swapFee: resp.swapFee,
365
+ swapFeeBtc,
366
+ feeRate: (await _preFetches.feeRatePromise[version])!,
367
+ initialSwapData: await this._contract(version).createSwapData(
368
+ ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token,
369
+ resp.total, _hash[version],
370
+ this.getRandomSequence(), BigInt(Math.floor(Date.now()/1000)), false, true,
371
+ resp.securityDeposit, 0n, nativeTokenAddress
372
+ ),
373
+ pr: resp.pr,
374
+ secret: secret?.toString("hex"),
375
+ exactIn: amountData.exactIn ?? true,
376
+ contractVersion: version
377
+ } as FromBTCLNSwapInit<T["Data"]>);
378
+ return quote;
379
+ } catch (e) {
380
+ abortController.abort(e);
381
+ throw e;
382
+ }
383
+ })()
384
+ }
385
+ });
386
+ }
387
+
388
+ /**
389
+ * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
390
+ * where the user needs to manually settle swap on the destination smart chain. The swap is created
391
+ * with an LNURL-withdraw link which will be used to pay the generated bolt11 invoice automatically
392
+ * when {@link FromBTCLNSwap.waitForPayment} is called on the swap.
393
+ *
394
+ * @param recipient Smart chain signer's address on the destination chain, that will have to manually
395
+ * settle the swap.
396
+ * @param lnurl LNURL-withdraw link to pull the funds from
397
+ * @param amountData Amount, token and exact input/output data for to swap
398
+ * @param lps An array of intermediaries (LPs) to get the quotes from
399
+ * @param options Optional additional quote options
400
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
401
+ * @param abortSignal Abort signal
402
+ */
403
+ async createViaLNURL(
404
+ recipient: string,
405
+ lnurl: string | LNURLWithdrawParamsWithUrl,
406
+ amountData: AmountData,
407
+ lps: Intermediary[],
408
+ options?: FromBTCLNOptions,
409
+ additionalParams?: Record<string, any>,
410
+ abortSignal?: AbortSignal
411
+ ): Promise<{
412
+ quote: Promise<FromBTCLNSwap<T>>,
413
+ intermediary: Intermediary
414
+ }[]> {
415
+ if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
416
+
417
+ const _options = {
418
+ paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
419
+ description: options?.description,
420
+ descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash"),
421
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
422
+ };
423
+
424
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
425
+
426
+ const abortController = extendAbortController(abortSignal);
427
+ const preFetches = {
428
+ pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
429
+ usdPricePrefetchPromise: this.preFetchUsdPrice(abortController.signal),
430
+ feeRatePromise: this.preFetchFeeRate(recipient, amountData, undefined, abortController, lpVersions)
431
+ };
432
+
433
+ try {
434
+ const exactOutAmountPromise: Promise<bigint | undefined> | undefined = !amountData.exactIn ? preFetches.pricePrefetchPromise.then(price =>
435
+ this._prices.getToBtcSwapAmount(this.chainIdentifier, amountData.amount, amountData.token, abortController.signal, price)
436
+ ).catch(e => {
437
+ abortController.abort(e);
438
+ return undefined;
439
+ }) : undefined;
440
+
441
+ const withdrawRequest = await this.getLNURLWithdraw(lnurl, abortController.signal);
442
+
443
+ const min = BigInt(withdrawRequest.minWithdrawable) / 1000n;
444
+ const max = BigInt(withdrawRequest.maxWithdrawable) / 1000n;
445
+
446
+ if(amountData.exactIn) {
447
+ if(amountData.amount < min) throw new UserError("Amount less than LNURL-withdraw minimum");
448
+ if(amountData.amount > max) throw new UserError("Amount more than LNURL-withdraw maximum");
449
+ } else {
450
+ const amount = (await exactOutAmountPromise)!;
451
+ abortController.signal.throwIfAborted();
452
+
453
+ if((amount * 95n / 100n) < min) throw new UserError("Amount less than LNURL-withdraw minimum");
454
+ if((amount * 105n / 100n) > max) throw new UserError("Amount more than LNURL-withdraw maximum");
455
+ }
456
+
457
+ return this.create(recipient, amountData, lps, _options, additionalParams, abortSignal, preFetches).map(data => {
458
+ return {
459
+ quote: data.quote.then(quote => {
460
+ quote._setLNURLData(
461
+ withdrawRequest.url,
462
+ withdrawRequest.k1,
463
+ withdrawRequest.callback
464
+ )
465
+
466
+ const amountIn = quote.getInput().rawAmount!;
467
+ if(amountIn < min) throw new UserError("Amount less than LNURL-withdraw minimum");
468
+ if(amountIn > max) throw new UserError("Amount more than LNURL-withdraw maximum");
469
+
470
+ return quote;
471
+ }),
472
+ intermediary: data.intermediary
473
+ }
474
+ });
475
+ } catch (e) {
476
+ abortController.abort(e);
477
+ throw e;
478
+ }
479
+ }
480
+
481
+ /**
482
+ * @inheritDoc
483
+ * @internal
484
+ */
485
+ protected async _checkPastSwaps(pastSwaps: FromBTCLNSwap<T>[]): Promise<{
486
+ changedSwaps: FromBTCLNSwap<T>[];
487
+ removeSwaps: FromBTCLNSwap<T>[]
488
+ }> {
489
+ const changedSwapSet: Set<FromBTCLNSwap<T>> = new Set();
490
+
491
+ const swapExpiredStatus: {[id: string]: boolean} = {};
492
+ const checkStatusSwaps: {[contractVersion: string]: (FromBTCLNSwap<T> & {_data: T["Data"]})[]} = {};
493
+
494
+ await Promise.all(pastSwaps.map(async (pastSwap) => {
495
+ if(pastSwap._shouldCheckIntermediary()) {
496
+ try {
497
+ const result = await pastSwap._checkIntermediaryPaymentReceived(false);
498
+ if(result!=null) {
499
+ changedSwapSet.add(pastSwap);
500
+ }
501
+ } catch (e) {
502
+ this.logger.error(`_checkPastSwaps(): Failed to contact LP regarding swap ${pastSwap.getId()}, error: `, e);
503
+ }
504
+ }
505
+ if(pastSwap._shouldFetchExpiryStatus()) {
506
+ //Check expiry
507
+ swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
508
+ }
509
+ if(pastSwap._shouldFetchOnchainState()) {
510
+ //Add to swaps for which status should be checked
511
+ if(pastSwap._data!=null) (checkStatusSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap as (FromBTCLNSwap<T> & {_data: T["Data"]}));
512
+ }
513
+ }));
514
+
515
+ for(let version in checkStatusSwaps) {
516
+ if(this._versionedContracts[version]==null) {
517
+ this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${version}! Skipping these swaps!`);
518
+ continue;
519
+ }
520
+
521
+ const _checkStatusSwap = checkStatusSwaps[version];
522
+ const swapStatuses = await this._contract(version).getCommitStatuses(_checkStatusSwap.map(val => ({signer: val._getInitiator(), swapData: val._data})));
523
+
524
+ for(let pastSwap of _checkStatusSwap) {
525
+ const shouldSave = await pastSwap._sync(
526
+ false, swapExpiredStatus[pastSwap.getId()],
527
+ swapStatuses[pastSwap.getEscrowHash()!], true
528
+ );
529
+ if(shouldSave) {
530
+ changedSwapSet.add(pastSwap);
531
+ }
532
+ }
533
+ }
534
+
535
+ const changedSwaps: FromBTCLNSwap<T>[] = [];
536
+ const removeSwaps: FromBTCLNSwap<T>[] = [];
537
+ changedSwapSet.forEach(val => {
538
+ if(val.isQuoteExpired()) {
539
+ removeSwaps.push(val);
540
+ } else {
541
+ changedSwaps.push(val);
542
+ }
543
+ });
544
+
545
+ return {
546
+ changedSwaps,
547
+ removeSwaps
548
+ };
549
+ }
550
+
551
+ /**
552
+ * @inheritDoc
553
+ * @internal
554
+ */
555
+ async recoverFromSwapDataAndState(
556
+ init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
557
+ state: SwapCommitState,
558
+ contractVersion: string,
559
+ lp?: Intermediary
560
+ ): Promise<FromBTCLNSwap<T> | null> {
561
+ const data = init.data;
562
+
563
+ let paymentHash = data.getHTLCHashHint();
564
+ let secret: string | undefined;
565
+ if(state.type===SwapCommitStateType.PAID) {
566
+ secret = await state.getClaimResult();
567
+ paymentHash = Buffer.from(sha256(Buffer.from(secret, "hex"))).toString("hex");
568
+ }
569
+
570
+ const swapInit: FromBTCLNSwapInit<T["Data"]> = {
571
+ pricingInfo: {
572
+ isValid: true,
573
+ satsBaseFee: 0n,
574
+ swapPriceUSatPerToken: 100_000_000_000_000n,
575
+ realPriceUSatPerToken: 100_000_000_000_000n,
576
+ differencePPM: 0n,
577
+ feePPM: 0n,
578
+ },
579
+ url: lp?.url,
580
+ expiry: 0,
581
+ swapFee: 0n,
582
+ swapFeeBtc: 0n,
583
+ feeRate: "",
584
+ signatureData: undefined,
585
+ initialSwapData: data,
586
+ data,
587
+ pr: paymentHash ?? undefined,
588
+ secret,
589
+ exactIn: false,
590
+ contractVersion
591
+ }
592
+ const swap = new FromBTCLNSwap(this, swapInit);
593
+ swap._commitTxId = await init.getInitTxId();
594
+ const blockData = await init.getTxBlock();
595
+ swap.createdAt = blockData.blockTime * 1000;
596
+ swap._setInitiated();
597
+ swap._state = FromBTCLNSwapState.CLAIM_COMMITED;
598
+ await swap._sync(false, false, state);
599
+ await swap._save();
600
+ return swap;
601
+ }
602
+
603
+ }