@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,750 +1,750 @@
1
- import {decode as bolt11Decode, PaymentRequestObject, TagsObject} from "@atomiqlabs/bolt11";
2
- import {
3
- ChainSwapType,
4
- ChainType,
5
- ClaimEvent,
6
- InitializeEvent, LightningNetworkApi, LNNodeLiquidity, Messenger,
7
- RefundEvent, SwapCommitState, SwapCommitStateType
8
- } from "@atomiqlabs/base";
9
- import {Intermediary} from "../../../../intermediaries/Intermediary";
10
- import {Buffer} from "buffer";
11
- import {UserError} from "../../../../errors/UserError";
12
- import {IntermediaryError} from "../../../../errors/IntermediaryError";
13
- import {SwapType} from "../../../../enums/SwapType";
14
- import {
15
- extendAbortController, mapArrayToObject, parseHashValueExact32Bytes,
16
- randomBytes,
17
- throwIfUndefined
18
- } from "../../../../utils/Utils";
19
- import {
20
- FromBTCLNAutoResponseType,
21
- IntermediaryAPI
22
- } from "../../../../intermediaries/apis/IntermediaryAPI";
23
- import {RequestError} from "../../../../errors/RequestError";
24
- import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
25
- import {EventEmitter} from "events";
26
- import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
27
- import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
28
- import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
29
- import {ISwap} from "../../../ISwap";
30
- import {FromBTCLNAutoSwap, FromBTCLNAutoSwapInit, FromBTCLNAutoSwapState} from "./FromBTCLNAutoSwap";
31
- import {IFromBTCLNDefinition, IFromBTCLNWrapper} from "../IFromBTCLNWrapper";
32
- import {IClaimableSwapWrapper} from "../../../IClaimableSwapWrapper";
33
- import {AmountData} from "../../../../types/AmountData";
34
- import {LNURLWithdrawParamsWithUrl} from "../../../../types/lnurl/LNURLWithdraw";
35
- import {tryWithRetries} from "../../../../utils/RetryUtils";
36
- import {AllOptional} from "../../../../utils/TypeUtils";
37
- import {sha256} from "@noble/hashes/sha2";
38
- import {fromHumanReadableString} from "../../../../utils/TokenUtils";
39
-
40
- export type FromBTCLNAutoOptions = {
41
- /**
42
- * Instead of letting the SDK generate the preimage/paymentHash pair internally you can pass your computed
43
- * paymentHash here, this will create the swap with the provided payment hash. Note that swaps created this way
44
- * won't settle automatically (as the SDK is missing the preimage). Once the HTLC towards the user is created in
45
- * the {@link FromBTCLNAutoSwapState.CLAIM_COMMITED} state, you should pass the secret preimage manually in the
46
- * {@link FromBTCLNAutoSwap.waitTillClaimed}, {@link FromBTCLNAutoSwap.claim} or {@link FromBTCLNAutoSwap.txsClaim}
47
- * functions.
48
- *
49
- * Accepts both, a {@link Buffer} and a hexadecimal `string`
50
- */
51
- paymentHash?: Buffer | string,
52
- /**
53
- * Optional description to use for the swap lightning network invoice, keep the invoice length below 500 characters
54
- */
55
- description?: string,
56
- /**
57
- * Optional description hash to use for the lightning network invoice, useful when returning the invoice as part of
58
- * an LNURL-pay service endpoint.
59
- *
60
- * Accepts both, a {@link Buffer} and a hexadecimal `string`
61
- */
62
- descriptionHash?: Buffer | string,
63
- /**
64
- * Optional additional native token to receive as an output of the swap (e.g. STRK on Starknet or cBTC on Citrea).
65
- * When passed as a `bigint` it is specified in base units of the token and in `string` it is the human readable
66
- * decimal format.
67
- */
68
- gasAmount?: bigint | string,
69
- /**
70
- * A flag to skip checking whether the lightning network node of the LP has enough channel liquidity to facilitate
71
- * the swap.
72
- */
73
- unsafeSkipLnNodeCheck?: boolean,
74
- /**
75
- * A flag to attach 0 watchtower fee to the swap, this would make the settlement unattractive for the watchtowers
76
- * and therefore automatic settlement for such swaps will not be possible, you will have to settle manually
77
- * with {@link FromBTCLNSwap.claim} or {@link FromBTCLNSwap.txsClaim} functions.
78
- */
79
- unsafeZeroWatchtowerFee?: boolean,
80
- /**
81
- * A safety factor to use when estimating the watchtower fee to attach to the swap (this has to cover the gas fee
82
- * of watchtowers settling the swap). A higher multiple here would mean that a swap is more attractive for
83
- * watchtowers to settle automatically.
84
- *
85
- * Uses a `1.25` multiple by default (i.e. the current network fee is multiplied by 1.25 and then used to estimate
86
- * the settlement gas fee cost)
87
- */
88
- feeSafetyFactor?: number
89
- };
90
-
91
- export type FromBTCLNAutoWrapperOptions = ISwapWrapperOptions & {
92
- safetyFactor: number,
93
- bitcoinBlocktime: number,
94
- unsafeSkipLnNodeCheck: boolean
95
- };
96
-
97
- export type FromBTCLNAutoDefinition<T extends ChainType> = IFromBTCLNDefinition<T, FromBTCLNAutoWrapper<T>, FromBTCLNAutoSwap<T>>;
98
-
99
- /**
100
- * New escrow based (HTLC) swaps for Bitcoin Lightning -> Smart chain swaps not requiring manual settlement on
101
- * the destination by the user, and instead letting the LP initiate the escrow. Permissionless watchtower network
102
- * handles the claiming of HTLC, with the swap secret broadcasted over Nostr. Also adds a possibility for the user
103
- * to receive a native token on the destination chain as part of the swap (a "gas drop" feature).
104
- *
105
- * @category Swaps/Lightning → Smart chain
106
- */
107
- export class FromBTCLNAutoWrapper<
108
- T extends ChainType
109
- > extends IFromBTCLNWrapper<T, FromBTCLNAutoDefinition<T>, FromBTCLNAutoWrapperOptions> implements IClaimableSwapWrapper<FromBTCLNAutoSwap<T>> {
110
-
111
- public readonly TYPE: SwapType.FROM_BTCLN_AUTO = SwapType.FROM_BTCLN_AUTO;
112
-
113
- /**
114
- * @internal
115
- */
116
- protected readonly tickSwapState = [
117
- FromBTCLNAutoSwapState.PR_CREATED,
118
- FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED,
119
- FromBTCLNAutoSwapState.PR_PAID,
120
- FromBTCLNAutoSwapState.CLAIM_COMMITED
121
- ];
122
-
123
- /**
124
- * @internal
125
- */
126
- readonly _pendingSwapStates = [
127
- FromBTCLNAutoSwapState.PR_CREATED,
128
- FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED,
129
- FromBTCLNAutoSwapState.PR_PAID,
130
- FromBTCLNAutoSwapState.CLAIM_COMMITED,
131
- FromBTCLNAutoSwapState.EXPIRED
132
- ];
133
- /**
134
- * @internal
135
- */
136
- readonly _claimableSwapStates = [FromBTCLNAutoSwapState.CLAIM_COMMITED];
137
- /**
138
- * @internal
139
- */
140
- readonly _swapDeserializer = FromBTCLNAutoSwap;
141
- /**
142
- * @internal
143
- */
144
- readonly _messenger: Messenger;
145
-
146
- /**
147
- * @param chainIdentifier
148
- * @param unifiedStorage Storage interface for the current environment
149
- * @param unifiedChainEvents On-chain event listener
150
- * @param chain
151
- * @param prices Swap pricing handler
152
- * @param tokens
153
- * @param versionedContracts
154
- * @param lnApi
155
- * @param messenger
156
- * @param options
157
- * @param events Instance to use for emitting events
158
- */
159
- constructor(
160
- chainIdentifier: string,
161
- unifiedStorage: UnifiedSwapStorage<T>,
162
- unifiedChainEvents: UnifiedSwapEventListener<T>,
163
- chain: T["ChainInterface"],
164
- prices: ISwapPrice,
165
- tokens: WrapperCtorTokens,
166
- versionedContracts: {
167
- [version: string]: {
168
- swapContract: T["Contract"],
169
- swapDataConstructor: new (data: any) => T["Data"]
170
- }
171
- },
172
- lnApi: LightningNetworkApi,
173
- messenger: Messenger,
174
- options?: AllOptional<FromBTCLNAutoWrapperOptions>,
175
- events?: EventEmitter<{swapState: [ISwap]}>
176
- ) {
177
- super(
178
- chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi,
179
- {
180
- ...options,
181
- safetyFactor: options?.safetyFactor ?? 2,
182
- bitcoinBlocktime: options?.bitcoinBlocktime ?? 10*60,
183
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? false
184
- },
185
- events
186
- );
187
- this._messenger = messenger;
188
- }
189
-
190
- /**
191
- * @inheritDoc
192
- * @internal
193
- */
194
- protected async processEventInitialize(swap: FromBTCLNAutoSwap<T>, event: InitializeEvent<T["Data"]>): Promise<boolean> {
195
- if(swap._state===FromBTCLNAutoSwapState.PR_PAID || swap._state===FromBTCLNAutoSwapState.PR_CREATED || swap._state===FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED) {
196
- if(swap._data==null) {
197
- //Obtain data from the initialize event
198
- const eventData = await event.swapData();
199
- if(eventData==null) {
200
- this.logger.error("processEventInitialize("+swap.getId()+"): Error when fetching swap data for swap, null returned!");
201
- return false;
202
- }
203
- try {
204
- await swap._saveRealSwapData(eventData, false);
205
- this.logger.info("processEventInitialize("+swap.getId()+"): Successfully taken swap data from on-chain event!");
206
- } catch (e) {
207
- this.logger.error("processEventInitialize("+swap.getId()+"): Error when saving swap data for swap: ", e);
208
- return false;
209
- }
210
- }
211
-
212
- if(swap._getEscrowHash()!==event.escrowHash) {
213
- this.logger.error("processEventInitialize("+swap.getId()+"): Error when processing event, escrow hashes don't match!");
214
- return false;
215
- }
216
-
217
- swap._commitedAt ??= Date.now();
218
- swap._state = FromBTCLNAutoSwapState.CLAIM_COMMITED;
219
- if(swap.hasSecretPreimage()) swap._broadcastSecret().catch(e => {
220
- this.logger.error("processEventInitialize("+swap.getId()+"): Error when broadcasting swap secret: ", e);
221
- });
222
- return true;
223
- }
224
- return false;
225
- }
226
-
227
- /**
228
- * @inheritDoc
229
- * @internal
230
- */
231
- protected processEventClaim(swap: FromBTCLNAutoSwap<T>, event: ClaimEvent<T["Data"]>): Promise<boolean> {
232
- if(swap._state!==FromBTCLNAutoSwapState.FAILED && swap._state!==FromBTCLNAutoSwapState.CLAIM_CLAIMED) {
233
- swap._state = FromBTCLNAutoSwapState.CLAIM_CLAIMED;
234
- swap._setSwapSecret(event.result);
235
- return Promise.resolve(true);
236
- }
237
- return Promise.resolve(false);
238
- }
239
-
240
- /**
241
- * @inheritDoc
242
- * @internal
243
- */
244
- protected processEventRefund(swap: FromBTCLNAutoSwap<T>, event: RefundEvent<T["Data"]>): Promise<boolean> {
245
- if(swap._state!==FromBTCLNAutoSwapState.CLAIM_CLAIMED && swap._state!==FromBTCLNAutoSwapState.FAILED) {
246
- swap._state = FromBTCLNAutoSwapState.FAILED;
247
- return Promise.resolve(true);
248
- }
249
- return Promise.resolve(false);
250
- }
251
-
252
- /**
253
- * Pre-fetches claimer (watchtower) bounty data for the swap. Doesn't throw, instead returns null and aborts the
254
- * provided abortController
255
- *
256
- * @param signer Smartchain signer address initiating the swap
257
- * @param amountData
258
- * @param options Options as passed to the swap creation function
259
- * @param abortController
260
- *
261
- * @param contractVersions
262
- * @private
263
- */
264
- private preFetchClaimerBounty(
265
- signer: string,
266
- amountData: AmountData,
267
- options: {feeSafetyFactor: number, unsafeZeroWatchtowerFee: boolean},
268
- abortController: AbortController,
269
- contractVersions: string[]
270
- ): {[chainVersion: string]: Promise<bigint | undefined>} {
271
- return mapArrayToObject(contractVersions, async (contractVersion) => {
272
- if(options.unsafeZeroWatchtowerFee) return 0n;
273
-
274
- const dummyAmount = BigInt(Math.floor(Math.random()* 0x1000000));
275
- const dummySwapData = await this._contract(contractVersion).createSwapData(
276
- ChainSwapType.HTLC, this._chain.randomAddress(), signer, amountData.token,
277
- dummyAmount, this._contract(contractVersion).getHashForHtlc(randomBytes(32)).toString("hex"),
278
- this.getRandomSequence(), BigInt(Math.floor(Date.now()/1000)), false, true,
279
- BigInt(Math.floor(Math.random() * 0x10000)), BigInt(Math.floor(Math.random() * 0x10000))
280
- );
281
-
282
- try {
283
- const result = await this._contract(contractVersion).getClaimFee(this._chain.randomAddress(), dummySwapData);
284
- return result * BigInt(Math.floor(options.feeSafetyFactor*1000000)) / 1_000_000n
285
- } catch (e) {
286
- abortController.abort(e);
287
- }
288
- });
289
- }
290
-
291
- /**
292
- * Verifies response returned from intermediary
293
- *
294
- * @param resp Response as returned by the intermediary
295
- * @param amountData
296
- * @param lp Intermediary
297
- * @param options Options as passed to the swap creation function
298
- * @param decodedPr Decoded bolt11 lightning network invoice
299
- * @param paymentHash Expected payment hash of the bolt11 lightning network invoice
300
- * @param claimerBounty Claimer bounty as request by the user
301
- *
302
- * @throws {IntermediaryError} in case the response is invalid
303
- *
304
- * @private
305
- */
306
- private verifyReturnedData(
307
- resp: FromBTCLNAutoResponseType,
308
- amountData: AmountData,
309
- lp: Intermediary,
310
- options: {gasAmount: bigint, description?: string, descriptionHash?: Buffer},
311
- decodedPr: PaymentRequestObject & {tagsObject: TagsObject},
312
- paymentHash: Buffer,
313
- claimerBounty: bigint
314
- ): void {
315
- if(lp.getAddress(this.chainIdentifier)!==resp.intermediaryKey) throw new IntermediaryError("Invalid intermediary address/pubkey");
316
-
317
- if(options.descriptionHash!=null && decodedPr.tagsObject.purpose_commit_hash!==options.descriptionHash.toString("hex"))
318
- throw new IntermediaryError("Invalid pr returned - description hash");
319
-
320
- if(options.description!=null && decodedPr.tagsObject.description!==options.description)
321
- throw new IntermediaryError("Invalid pr returned - description");
322
-
323
- if(
324
- decodedPr.tagsObject.payment_hash==null ||
325
- !Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash)
326
- ) throw new IntermediaryError("Invalid pr returned - payment hash");
327
-
328
- if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid pr returned - msat field");
329
-
330
- const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
331
- if(resp.btcAmountGas + resp.btcAmountSwap !== amountIn) throw new IntermediaryError("Invalid total btc returned");
332
- if(resp.gasSwapFeeBtc + resp.swapFeeBtc !== resp.totalFeeBtc) throw new IntermediaryError("Invalid total btc fee returned");
333
- if(resp.claimerBounty !== claimerBounty) throw new IntermediaryError("Invalid claimer bounty");
334
- if(resp.totalGas !== options.gasAmount) throw new IntermediaryError("Invalid total gas amount");
335
- if(!amountData.exactIn) {
336
- if(resp.total != amountData.amount) throw new IntermediaryError("Invalid amount returned");
337
- } else {
338
- if(amountIn !== amountData.amount) throw new IntermediaryError("Invalid payment request returned, amount mismatch");
339
- }
340
- }
341
-
342
- /**
343
- * Returns a newly created Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
344
- * where watchtowers handle the automatic settlement of the swap on the destination chain. Also allows
345
- * specifying additional "gas drop" native token that the receipient receives on the destination chain
346
- * in the `options` argument. The user has to pay a bolt11 invoice on the input lightning network side.
347
- *
348
- * @param recipient Recipient's address on the destination chain
349
- * @param amountData Amount, token and exact input/output data for to swap
350
- * @param lps An array of intermediaries (LPs) to get the quotes from
351
- * @param options Optional additional quote options
352
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
353
- * @param abortSignal Abort signal
354
- * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
355
- */
356
- create(
357
- recipient: string,
358
- amountData: AmountData,
359
- lps: Intermediary[],
360
- options?: FromBTCLNAutoOptions,
361
- additionalParams?: Record<string, any>,
362
- abortSignal?: AbortSignal,
363
- preFetches?: {
364
- pricePrefetchPromise: Promise<bigint | undefined>,
365
- usdPricePrefetchPromise: Promise<number | undefined>,
366
- claimerBountyPrefetch: {[contractVersion: string]: Promise<bigint | undefined>},
367
- gasTokenPricePrefetchPromise?: Promise<bigint | undefined>,
368
- }
369
- ): {
370
- quote: Promise<FromBTCLNAutoSwap<T>>,
371
- intermediary: Intermediary
372
- }[] {
373
- if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
374
-
375
- const _options = {
376
- paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
377
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck,
378
- gasAmount: this.parseGasAmount(options?.gasAmount),
379
- feeSafetyFactor: options?.feeSafetyFactor ?? 1.25, //No need to add much of a margin, since the claim should happen rather soon
380
- unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false,
381
- description: options?.description,
382
- descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash")
383
- };
384
-
385
-
386
- if(
387
- _options.gasAmount!==0n &&
388
- (
389
- this._chain.shouldGetNativeTokenDrop!=null
390
- ? !this._chain.shouldGetNativeTokenDrop(amountData.token)
391
- : amountData.token===this._chain.getNativeCurrencyAddress()
392
- )
393
- ) throw new UserError("Cannot specify `gasAmount` for swaps to a native token!");
394
-
395
- if(_options.description!=null && Buffer.byteLength(_options.description, "utf8") > 500)
396
- throw new UserError("Invalid description length");
397
-
398
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
399
-
400
- let secret: Buffer | undefined;
401
- let paymentHash: Buffer;
402
- if(_options?.paymentHash!=null) {
403
- paymentHash = _options.paymentHash;
404
- } else {
405
- ({secret, paymentHash} = this.getSecretAndHash());
406
- }
407
- const _hash = mapArrayToObject(lpVersions, (contractVersion: string) => {
408
- return this._contract(contractVersion).getHashForHtlc(paymentHash).toString("hex");
409
- });
410
-
411
- const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
412
-
413
- const _abortController = extendAbortController(abortSignal);
414
-
415
- const _preFetches = preFetches ?? {
416
- pricePrefetchPromise: this.preFetchPrice(amountData, _abortController.signal),
417
- usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
418
- claimerBountyPrefetch: this.preFetchClaimerBounty(recipient, amountData, _options, _abortController, lpVersions),
419
- gasTokenPricePrefetchPromise: _options.gasAmount!==0n || !_options.unsafeZeroWatchtowerFee ?
420
- this.preFetchPrice({token: nativeTokenAddress}, _abortController.signal) :
421
- undefined
422
- };
423
-
424
- return lps.map(lp => {
425
- return {
426
- intermediary: lp,
427
- quote: (async () => {
428
- if(lp.services[SwapType.FROM_BTCLN_AUTO]==null) throw new Error("LP service for processing from btcln auto swaps not found!");
429
- const version = lp.getContractVersion(this.chainIdentifier);
430
-
431
- const abortController = extendAbortController(_abortController.signal);
432
-
433
- const liquidityPromise: Promise<bigint | undefined> = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
434
-
435
- const {lnCapacityPromise, resp} = await tryWithRetries(async(retryCount: number) => {
436
- const {lnPublicKey, response} = IntermediaryAPI.initFromBTCLNAuto(
437
- this.chainIdentifier, lp.url,
438
- {
439
- paymentHash,
440
- amount: amountData.amount,
441
- claimer: recipient,
442
- token: amountData.token.toString(),
443
- description: _options.description,
444
- descriptionHash: _options.descriptionHash,
445
- exactOut: !amountData.exactIn,
446
- additionalParams,
447
- gasToken: this._chain.getNativeCurrencyAddress(),
448
- gasAmount: _options.gasAmount,
449
- claimerBounty: throwIfUndefined(_preFetches.claimerBountyPrefetch[version])
450
- },
451
- this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined
452
- );
453
-
454
- let lnCapacityPromise: Promise<LNNodeLiquidity | null> | undefined;
455
- if(!_options.unsafeSkipLnNodeCheck) {
456
- lnCapacityPromise = this.preFetchLnCapacity(lnPublicKey);
457
- } else lnPublicKey.catch(() => {});
458
-
459
- return {
460
- lnCapacityPromise,
461
- resp: await response
462
- };
463
- }, undefined, RequestError, abortController.signal);
464
-
465
- const decodedPr = bolt11Decode(resp.pr);
466
- if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid returned swap invoice, no msat amount field");
467
- if(decodedPr.timeExpireDate==null) throw new IntermediaryError("Invalid returned swap invoice, no expiry date field");
468
- const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
469
- const claimerBounty = (await _preFetches.claimerBountyPrefetch[version])!;
470
-
471
- try {
472
- this.verifyReturnedData(resp, amountData, lp, _options, decodedPr, paymentHash, claimerBounty);
473
- const [pricingInfo, gasPricingInfo] = await Promise.all([
474
- this.verifyReturnedPrice(
475
- lp.services[SwapType.FROM_BTCLN_AUTO],
476
- false, resp.btcAmountSwap,
477
- resp.total,
478
- amountData.token, {swapFeeBtc: resp.swapFeeBtc}, _preFetches.pricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal
479
- ),
480
- _options.gasAmount===0n ? Promise.resolve(undefined) : this.verifyReturnedPrice(
481
- {...lp.services[SwapType.FROM_BTCLN_AUTO], swapBaseFee: 0}, //Base fee should be charged only on the amount, not on gas
482
- false, resp.btcAmountGas,
483
- resp.totalGas + resp.claimerBounty,
484
- nativeTokenAddress, {swapFeeBtc: resp.gasSwapFeeBtc}, _preFetches.gasTokenPricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal
485
- ),
486
- this.verifyIntermediaryLiquidity(resp.total, throwIfUndefined(liquidityPromise)),
487
- _options.unsafeSkipLnNodeCheck ? Promise.resolve() : this.verifyLnNodeCapacity(lp, decodedPr, lnCapacityPromise, abortController.signal)
488
- ]);
489
-
490
- const swapInit: FromBTCLNAutoSwapInit<T["Data"]> = {
491
- pricingInfo,
492
- url: lp.url,
493
- expiry: decodedPr.timeExpireDate*1000,
494
-
495
- swapFee: resp.swapFee,
496
- gasSwapFee: resp.gasSwapFee,
497
-
498
- swapFeeBtc: resp.swapFeeBtc,
499
- gasSwapFeeBtc: resp.gasSwapFeeBtc,
500
-
501
- btcAmountGas: resp.btcAmountGas,
502
- btcAmountSwap: resp.btcAmountSwap,
503
-
504
- gasPricingInfo,
505
-
506
- initialSwapData: await this._contract(version).createSwapData(
507
- ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token,
508
- resp.total, _hash[version],
509
- this.getRandomSequence(), BigInt(Math.floor(Date.now()/1000)), false, true,
510
- _options.gasAmount + resp.claimerBounty, resp.claimerBounty, nativeTokenAddress
511
- ),
512
- pr: resp.pr,
513
- secret: secret?.toString("hex"),
514
- exactIn: amountData.exactIn ?? true,
515
- contractVersion: version
516
- };
517
- const quote = new FromBTCLNAutoSwap<T>(this, swapInit);
518
- return quote;
519
- } catch (e) {
520
- abortController.abort(e);
521
- throw e;
522
- }
523
- })()
524
- }
525
- });
526
- }
527
-
528
- /**
529
- * Returns a newly created Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
530
- * where watchtowers handle the automatic settlement of the swap on the destination chain. Also allows
531
- * specifying additional "gas drop" native token that the receipient receives on the destination chain
532
- * in the `options` argument. The swap is created with an LNURL-withdraw link which will be used to pay
533
- * the generated bolt11 invoice automatically when {@link FromBTCLNSwap.waitForPayment} is called on the
534
- * swap.
535
- *
536
- * @param recipient Recipient's address on the destination chain
537
- * @param lnurl LNURL-withdraw link to pull the funds from
538
- * @param amountData Amount, token and exact input/output data for to swap
539
- * @param lps An array of intermediaries (LPs) to get the quotes from
540
- * @param options Optional additional quote options
541
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
542
- * @param abortSignal Abort signal
543
- */
544
- async createViaLNURL(
545
- recipient: string,
546
- lnurl: string | LNURLWithdrawParamsWithUrl,
547
- amountData: AmountData,
548
- lps: Intermediary[],
549
- options?: FromBTCLNAutoOptions,
550
- additionalParams?: Record<string, any>,
551
- abortSignal?: AbortSignal
552
- ): Promise<{
553
- quote: Promise<FromBTCLNAutoSwap<T>>,
554
- intermediary: Intermediary
555
- }[]> {
556
- if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
557
-
558
- const _options = {
559
- paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
560
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck,
561
- gasAmount: this.parseGasAmount(options?.gasAmount),
562
- feeSafetyFactor: options?.feeSafetyFactor ?? 1.25, //No need to add much of a margin, since the claim should happen rather soon
563
- unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false,
564
- description: options?.description,
565
- descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash")
566
- };
567
-
568
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
569
-
570
- const abortController = extendAbortController(abortSignal);
571
- const preFetches = {
572
- pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
573
- usdPricePrefetchPromise: this.preFetchUsdPrice(abortController.signal),
574
- gasTokenPricePrefetchPromise: _options.gasAmount!==0n || !_options.unsafeZeroWatchtowerFee ?
575
- this.preFetchPrice({token: this._chain.getNativeCurrencyAddress()}, abortController.signal) :
576
- undefined,
577
- claimerBountyPrefetch: this.preFetchClaimerBounty(recipient, amountData, _options, abortController, lpVersions)
578
- };
579
-
580
- try {
581
- const exactOutAmountPromise: Promise<bigint | undefined> | undefined = !amountData.exactIn ? preFetches.pricePrefetchPromise.then(price =>
582
- this._prices.getToBtcSwapAmount(this.chainIdentifier, amountData.amount, amountData.token, abortController.signal, price)
583
- ).catch(e => {
584
- abortController.abort(e);
585
- return undefined;
586
- }) : undefined;
587
-
588
- const withdrawRequest = await this.getLNURLWithdraw(lnurl, abortController.signal);
589
-
590
- const min = BigInt(withdrawRequest.minWithdrawable) / 1000n;
591
- const max = BigInt(withdrawRequest.maxWithdrawable) / 1000n;
592
-
593
- if(amountData.exactIn) {
594
- if(amountData.amount < min) throw new UserError("Amount less than LNURL-withdraw minimum");
595
- if(amountData.amount > max) throw new UserError("Amount more than LNURL-withdraw maximum");
596
- } else {
597
- const amount = (await exactOutAmountPromise)!;
598
- abortController.signal.throwIfAborted();
599
-
600
- if((amount * 95n / 100n) < min) throw new UserError("Amount less than LNURL-withdraw minimum");
601
- if((amount * 105n / 100n) > max) throw new UserError("Amount more than LNURL-withdraw maximum");
602
- }
603
-
604
- return this.create(recipient, amountData, lps, _options, additionalParams, abortSignal, preFetches).map(data => {
605
- return {
606
- quote: data.quote.then(quote => {
607
- quote._setLNURLData(
608
- withdrawRequest.url,
609
- withdrawRequest.k1,
610
- withdrawRequest.callback
611
- );
612
-
613
- const amountIn = quote.getInput().rawAmount!;
614
- if(amountIn < min) throw new UserError("Amount less than LNURL-withdraw minimum");
615
- if(amountIn > max) throw new UserError("Amount more than LNURL-withdraw maximum");
616
-
617
- return quote;
618
- }),
619
- intermediary: data.intermediary
620
- }
621
- });
622
- } catch (e) {
623
- abortController.abort(e);
624
- throw e;
625
- }
626
- }
627
-
628
- /**
629
- * @inheritDoc
630
- * @internal
631
- */
632
- protected async _checkPastSwaps(pastSwaps: FromBTCLNAutoSwap<T>[]): Promise<{
633
- changedSwaps: FromBTCLNAutoSwap<T>[];
634
- removeSwaps: FromBTCLNAutoSwap<T>[]
635
- }> {
636
- const changedSwapSet: Set<FromBTCLNAutoSwap<T>> = new Set();
637
-
638
- const swapExpiredStatus: {[id: string]: boolean} = {};
639
- const checkStatusSwaps: {[contractVersion: string]: (FromBTCLNAutoSwap<T> & {_data: T["Data"]})[]} = {};
640
-
641
- await Promise.all(pastSwaps.map(async (pastSwap) => {
642
- if(pastSwap._shouldCheckIntermediary()) {
643
- try {
644
- const result = await pastSwap._checkIntermediaryPaymentReceived(false);
645
- if(result!=null) {
646
- changedSwapSet.add(pastSwap);
647
- }
648
- } catch (e) {
649
- this.logger.error(`_checkPastSwaps(): Failed to contact LP regarding swap ${pastSwap.getId()}, error: `, e);
650
- }
651
- }
652
- if(pastSwap._shouldFetchExpiryStatus()) {
653
- //Check expiry
654
- swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
655
- }
656
- if(pastSwap._shouldFetchOnchainState()) {
657
- //Add to swaps for which status should be checked
658
- if(pastSwap._data!=null) (checkStatusSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap as FromBTCLNAutoSwap<T> & {_data: T["Data"]});
659
- }
660
- }));
661
-
662
- for(let version in checkStatusSwaps) {
663
- if (this._versionedContracts[version] == null) {
664
- this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${version}! Skipping these swaps!`);
665
- continue;
666
- }
667
-
668
- const _checkStatusSwap = checkStatusSwaps[version];
669
- const swapStatuses = await this._contract(version).getCommitStatuses(_checkStatusSwap.map(val => ({signer: val._getInitiator(), swapData: val._data})));
670
-
671
- for(let pastSwap of _checkStatusSwap) {
672
- const shouldSave = await pastSwap._sync(
673
- false, swapExpiredStatus[pastSwap.getId()],
674
- swapStatuses[pastSwap.getEscrowHash()!], true
675
- );
676
- if(shouldSave) {
677
- changedSwapSet.add(pastSwap);
678
- }
679
- }
680
- }
681
-
682
- const changedSwaps: FromBTCLNAutoSwap<T>[] = [];
683
- const removeSwaps: FromBTCLNAutoSwap<T>[] = [];
684
- changedSwapSet.forEach(val => {
685
- if(val.isQuoteExpired()) {
686
- removeSwaps.push(val);
687
- } else {
688
- changedSwaps.push(val);
689
- }
690
- });
691
-
692
- return {
693
- changedSwaps,
694
- removeSwaps
695
- };
696
- }
697
-
698
- /**
699
- * @inheritDoc
700
- */
701
- async recoverFromSwapDataAndState(
702
- init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
703
- state: SwapCommitState,
704
- contractVersion: string,
705
- lp?: Intermediary
706
- ): Promise<FromBTCLNAutoSwap<T> | null> {
707
- const data = init.data;
708
-
709
- let paymentHash = data.getHTLCHashHint();
710
- let secret: string | undefined;
711
- if(state.type===SwapCommitStateType.PAID) {
712
- secret = await state.getClaimResult();
713
- paymentHash = Buffer.from(sha256(Buffer.from(secret, "hex"))).toString("hex");
714
- }
715
-
716
- const swapInit: FromBTCLNAutoSwapInit<T["Data"]> = {
717
- pricingInfo: {
718
- isValid: true,
719
- satsBaseFee: 0n,
720
- swapPriceUSatPerToken: 100_000_000_000_000n,
721
- realPriceUSatPerToken: 100_000_000_000_000n,
722
- differencePPM: 0n,
723
- feePPM: 0n,
724
- },
725
- url: lp?.url,
726
- expiry: 0,
727
- swapFee: 0n,
728
- swapFeeBtc: 0n,
729
- gasSwapFee: 0n,
730
- gasSwapFeeBtc: 0n,
731
- initialSwapData: data,
732
- data,
733
- pr: paymentHash ?? undefined,
734
- secret,
735
- exactIn: false,
736
- contractVersion
737
- }
738
- const swap = new FromBTCLNAutoSwap(this, swapInit);
739
- swap._commitTxId = await init.getInitTxId();
740
- const blockData = await init.getTxBlock();
741
- swap.createdAt = blockData.blockTime * 1000;
742
- swap._commitedAt = blockData.blockTime * 1000;
743
- swap._setInitiated();
744
- swap._state = FromBTCLNAutoSwapState.CLAIM_COMMITED;
745
- await swap._sync(false, false, state);
746
- await swap._save();
747
- return swap;
748
- }
749
-
750
- }
1
+ import {decode as bolt11Decode, PaymentRequestObject, TagsObject} from "@atomiqlabs/bolt11";
2
+ import {
3
+ ChainSwapType,
4
+ ChainType,
5
+ ClaimEvent,
6
+ InitializeEvent, LightningNetworkApi, LNNodeLiquidity, Messenger,
7
+ RefundEvent, SwapCommitState, SwapCommitStateType
8
+ } from "@atomiqlabs/base";
9
+ import {Intermediary} from "../../../../intermediaries/Intermediary";
10
+ import {Buffer} from "buffer";
11
+ import {UserError} from "../../../../errors/UserError";
12
+ import {IntermediaryError} from "../../../../errors/IntermediaryError";
13
+ import {SwapType} from "../../../../enums/SwapType";
14
+ import {
15
+ extendAbortController, mapArrayToObject, parseHashValueExact32Bytes,
16
+ randomBytes,
17
+ throwIfUndefined
18
+ } from "../../../../utils/Utils";
19
+ import {
20
+ FromBTCLNAutoResponseType,
21
+ IntermediaryAPI
22
+ } from "../../../../intermediaries/apis/IntermediaryAPI";
23
+ import {RequestError} from "../../../../errors/RequestError";
24
+ import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
25
+ import {EventEmitter} from "events";
26
+ import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
27
+ import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
28
+ import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
29
+ import {ISwap} from "../../../ISwap";
30
+ import {FromBTCLNAutoSwap, FromBTCLNAutoSwapInit, FromBTCLNAutoSwapState} from "./FromBTCLNAutoSwap";
31
+ import {IFromBTCLNDefinition, IFromBTCLNWrapper} from "../IFromBTCLNWrapper";
32
+ import {IClaimableSwapWrapper} from "../../../IClaimableSwapWrapper";
33
+ import {AmountData} from "../../../../types/AmountData";
34
+ import {LNURLWithdrawParamsWithUrl} from "../../../../types/lnurl/LNURLWithdraw";
35
+ import {tryWithRetries} from "../../../../utils/RetryUtils";
36
+ import {AllOptional} from "../../../../utils/TypeUtils";
37
+ import {sha256} from "@noble/hashes/sha2";
38
+ import {fromHumanReadableString} from "../../../../utils/TokenUtils";
39
+
40
+ export type FromBTCLNAutoOptions = {
41
+ /**
42
+ * Instead of letting the SDK generate the preimage/paymentHash pair internally you can pass your computed
43
+ * paymentHash here, this will create the swap with the provided payment hash. Note that swaps created this way
44
+ * won't settle automatically (as the SDK is missing the preimage). Once the HTLC towards the user is created in
45
+ * the {@link FromBTCLNAutoSwapState.CLAIM_COMMITED} state, you should pass the secret preimage manually in the
46
+ * {@link FromBTCLNAutoSwap.waitTillClaimed}, {@link FromBTCLNAutoSwap.claim} or {@link FromBTCLNAutoSwap.txsClaim}
47
+ * functions.
48
+ *
49
+ * Accepts both, a {@link Buffer} and a hexadecimal `string`
50
+ */
51
+ paymentHash?: Buffer | string,
52
+ /**
53
+ * Optional description to use for the swap lightning network invoice, keep the invoice length below 500 characters
54
+ */
55
+ description?: string,
56
+ /**
57
+ * Optional description hash to use for the lightning network invoice, useful when returning the invoice as part of
58
+ * an LNURL-pay service endpoint.
59
+ *
60
+ * Accepts both, a {@link Buffer} and a hexadecimal `string`
61
+ */
62
+ descriptionHash?: Buffer | string,
63
+ /**
64
+ * Optional additional native token to receive as an output of the swap (e.g. STRK on Starknet or cBTC on Citrea).
65
+ * When passed as a `bigint` it is specified in base units of the token and in `string` it is the human readable
66
+ * decimal format.
67
+ */
68
+ gasAmount?: bigint | string,
69
+ /**
70
+ * A flag to skip checking whether the lightning network node of the LP has enough channel liquidity to facilitate
71
+ * the swap.
72
+ */
73
+ unsafeSkipLnNodeCheck?: boolean,
74
+ /**
75
+ * A flag to attach 0 watchtower fee to the swap, this would make the settlement unattractive for the watchtowers
76
+ * and therefore automatic settlement for such swaps will not be possible, you will have to settle manually
77
+ * with {@link FromBTCLNSwap.claim} or {@link FromBTCLNSwap.txsClaim} functions.
78
+ */
79
+ unsafeZeroWatchtowerFee?: boolean,
80
+ /**
81
+ * A safety factor to use when estimating the watchtower fee to attach to the swap (this has to cover the gas fee
82
+ * of watchtowers settling the swap). A higher multiple here would mean that a swap is more attractive for
83
+ * watchtowers to settle automatically.
84
+ *
85
+ * Uses a `1.25` multiple by default (i.e. the current network fee is multiplied by 1.25 and then used to estimate
86
+ * the settlement gas fee cost)
87
+ */
88
+ feeSafetyFactor?: number
89
+ };
90
+
91
+ export type FromBTCLNAutoWrapperOptions = ISwapWrapperOptions & {
92
+ safetyFactor: number,
93
+ bitcoinBlocktime: number,
94
+ unsafeSkipLnNodeCheck: boolean
95
+ };
96
+
97
+ export type FromBTCLNAutoDefinition<T extends ChainType> = IFromBTCLNDefinition<T, FromBTCLNAutoWrapper<T>, FromBTCLNAutoSwap<T>>;
98
+
99
+ /**
100
+ * New escrow based (HTLC) swaps for Bitcoin Lightning -> Smart chain swaps not requiring manual settlement on
101
+ * the destination by the user, and instead letting the LP initiate the escrow. Permissionless watchtower network
102
+ * handles the claiming of HTLC, with the swap secret broadcasted over Nostr. Also adds a possibility for the user
103
+ * to receive a native token on the destination chain as part of the swap (a "gas drop" feature).
104
+ *
105
+ * @category Swaps/Lightning → Smart chain
106
+ */
107
+ export class FromBTCLNAutoWrapper<
108
+ T extends ChainType
109
+ > extends IFromBTCLNWrapper<T, FromBTCLNAutoDefinition<T>, FromBTCLNAutoWrapperOptions> implements IClaimableSwapWrapper<FromBTCLNAutoSwap<T>> {
110
+
111
+ public readonly TYPE: SwapType.FROM_BTCLN_AUTO = SwapType.FROM_BTCLN_AUTO;
112
+
113
+ /**
114
+ * @internal
115
+ */
116
+ protected readonly tickSwapState = [
117
+ FromBTCLNAutoSwapState.PR_CREATED,
118
+ FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED,
119
+ FromBTCLNAutoSwapState.PR_PAID,
120
+ FromBTCLNAutoSwapState.CLAIM_COMMITED
121
+ ];
122
+
123
+ /**
124
+ * @internal
125
+ */
126
+ readonly _pendingSwapStates = [
127
+ FromBTCLNAutoSwapState.PR_CREATED,
128
+ FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED,
129
+ FromBTCLNAutoSwapState.PR_PAID,
130
+ FromBTCLNAutoSwapState.CLAIM_COMMITED,
131
+ FromBTCLNAutoSwapState.EXPIRED
132
+ ];
133
+ /**
134
+ * @internal
135
+ */
136
+ readonly _claimableSwapStates = [FromBTCLNAutoSwapState.CLAIM_COMMITED];
137
+ /**
138
+ * @internal
139
+ */
140
+ readonly _swapDeserializer = FromBTCLNAutoSwap;
141
+ /**
142
+ * @internal
143
+ */
144
+ readonly _messenger: Messenger;
145
+
146
+ /**
147
+ * @param chainIdentifier
148
+ * @param unifiedStorage Storage interface for the current environment
149
+ * @param unifiedChainEvents On-chain event listener
150
+ * @param chain
151
+ * @param prices Swap pricing handler
152
+ * @param tokens
153
+ * @param versionedContracts
154
+ * @param lnApi
155
+ * @param messenger
156
+ * @param options
157
+ * @param events Instance to use for emitting events
158
+ */
159
+ constructor(
160
+ chainIdentifier: string,
161
+ unifiedStorage: UnifiedSwapStorage<T>,
162
+ unifiedChainEvents: UnifiedSwapEventListener<T>,
163
+ chain: T["ChainInterface"],
164
+ prices: ISwapPrice,
165
+ tokens: WrapperCtorTokens,
166
+ versionedContracts: {
167
+ [version: string]: {
168
+ swapContract: T["Contract"],
169
+ swapDataConstructor: new (data: any) => T["Data"]
170
+ }
171
+ },
172
+ lnApi: LightningNetworkApi,
173
+ messenger: Messenger,
174
+ options?: AllOptional<FromBTCLNAutoWrapperOptions>,
175
+ events?: EventEmitter<{swapState: [ISwap]}>
176
+ ) {
177
+ super(
178
+ chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi,
179
+ {
180
+ ...options,
181
+ safetyFactor: options?.safetyFactor ?? 2,
182
+ bitcoinBlocktime: options?.bitcoinBlocktime ?? 10*60,
183
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? false
184
+ },
185
+ events
186
+ );
187
+ this._messenger = messenger;
188
+ }
189
+
190
+ /**
191
+ * @inheritDoc
192
+ * @internal
193
+ */
194
+ protected async processEventInitialize(swap: FromBTCLNAutoSwap<T>, event: InitializeEvent<T["Data"]>): Promise<boolean> {
195
+ if(swap._state===FromBTCLNAutoSwapState.PR_PAID || swap._state===FromBTCLNAutoSwapState.PR_CREATED || swap._state===FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED) {
196
+ if(swap._data==null) {
197
+ //Obtain data from the initialize event
198
+ const eventData = await event.swapData();
199
+ if(eventData==null) {
200
+ this.logger.error("processEventInitialize("+swap.getId()+"): Error when fetching swap data for swap, null returned!");
201
+ return false;
202
+ }
203
+ try {
204
+ await swap._saveRealSwapData(eventData, false);
205
+ this.logger.info("processEventInitialize("+swap.getId()+"): Successfully taken swap data from on-chain event!");
206
+ } catch (e) {
207
+ this.logger.error("processEventInitialize("+swap.getId()+"): Error when saving swap data for swap: ", e);
208
+ return false;
209
+ }
210
+ }
211
+
212
+ if(swap._getEscrowHash()!==event.escrowHash) {
213
+ this.logger.error("processEventInitialize("+swap.getId()+"): Error when processing event, escrow hashes don't match!");
214
+ return false;
215
+ }
216
+
217
+ swap._commitedAt ??= Date.now();
218
+ swap._state = FromBTCLNAutoSwapState.CLAIM_COMMITED;
219
+ if(swap.hasSecretPreimage()) swap._broadcastSecret().catch(e => {
220
+ this.logger.error("processEventInitialize("+swap.getId()+"): Error when broadcasting swap secret: ", e);
221
+ });
222
+ return true;
223
+ }
224
+ return false;
225
+ }
226
+
227
+ /**
228
+ * @inheritDoc
229
+ * @internal
230
+ */
231
+ protected processEventClaim(swap: FromBTCLNAutoSwap<T>, event: ClaimEvent<T["Data"]>): Promise<boolean> {
232
+ if(swap._state!==FromBTCLNAutoSwapState.FAILED && swap._state!==FromBTCLNAutoSwapState.CLAIM_CLAIMED) {
233
+ swap._state = FromBTCLNAutoSwapState.CLAIM_CLAIMED;
234
+ swap._setSwapSecret(event.result);
235
+ return Promise.resolve(true);
236
+ }
237
+ return Promise.resolve(false);
238
+ }
239
+
240
+ /**
241
+ * @inheritDoc
242
+ * @internal
243
+ */
244
+ protected processEventRefund(swap: FromBTCLNAutoSwap<T>, event: RefundEvent<T["Data"]>): Promise<boolean> {
245
+ if(swap._state!==FromBTCLNAutoSwapState.CLAIM_CLAIMED && swap._state!==FromBTCLNAutoSwapState.FAILED) {
246
+ swap._state = FromBTCLNAutoSwapState.FAILED;
247
+ return Promise.resolve(true);
248
+ }
249
+ return Promise.resolve(false);
250
+ }
251
+
252
+ /**
253
+ * Pre-fetches claimer (watchtower) bounty data for the swap. Doesn't throw, instead returns null and aborts the
254
+ * provided abortController
255
+ *
256
+ * @param signer Smartchain signer address initiating the swap
257
+ * @param amountData
258
+ * @param options Options as passed to the swap creation function
259
+ * @param abortController
260
+ *
261
+ * @param contractVersions
262
+ * @private
263
+ */
264
+ private preFetchClaimerBounty(
265
+ signer: string,
266
+ amountData: AmountData,
267
+ options: {feeSafetyFactor: number, unsafeZeroWatchtowerFee: boolean},
268
+ abortController: AbortController,
269
+ contractVersions: string[]
270
+ ): {[chainVersion: string]: Promise<bigint | undefined>} {
271
+ return mapArrayToObject(contractVersions, async (contractVersion) => {
272
+ if(options.unsafeZeroWatchtowerFee) return 0n;
273
+
274
+ const dummyAmount = BigInt(Math.floor(Math.random()* 0x1000000));
275
+ const dummySwapData = await this._contract(contractVersion).createSwapData(
276
+ ChainSwapType.HTLC, this._chain.randomAddress(), signer, amountData.token,
277
+ dummyAmount, this._contract(contractVersion).getHashForHtlc(randomBytes(32)).toString("hex"),
278
+ this.getRandomSequence(), BigInt(Math.floor(Date.now()/1000)), false, true,
279
+ BigInt(Math.floor(Math.random() * 0x10000)), BigInt(Math.floor(Math.random() * 0x10000))
280
+ );
281
+
282
+ try {
283
+ const result = await this._contract(contractVersion).getClaimFee(this._chain.randomAddress(), dummySwapData);
284
+ return result * BigInt(Math.floor(options.feeSafetyFactor*1000000)) / 1_000_000n
285
+ } catch (e) {
286
+ abortController.abort(e);
287
+ }
288
+ });
289
+ }
290
+
291
+ /**
292
+ * Verifies response returned from intermediary
293
+ *
294
+ * @param resp Response as returned by the intermediary
295
+ * @param amountData
296
+ * @param lp Intermediary
297
+ * @param options Options as passed to the swap creation function
298
+ * @param decodedPr Decoded bolt11 lightning network invoice
299
+ * @param paymentHash Expected payment hash of the bolt11 lightning network invoice
300
+ * @param claimerBounty Claimer bounty as request by the user
301
+ *
302
+ * @throws {IntermediaryError} in case the response is invalid
303
+ *
304
+ * @private
305
+ */
306
+ private verifyReturnedData(
307
+ resp: FromBTCLNAutoResponseType,
308
+ amountData: AmountData,
309
+ lp: Intermediary,
310
+ options: {gasAmount: bigint, description?: string, descriptionHash?: Buffer},
311
+ decodedPr: PaymentRequestObject & {tagsObject: TagsObject},
312
+ paymentHash: Buffer,
313
+ claimerBounty: bigint
314
+ ): void {
315
+ if(lp.getAddress(this.chainIdentifier)!==resp.intermediaryKey) throw new IntermediaryError("Invalid intermediary address/pubkey");
316
+
317
+ if(options.descriptionHash!=null && decodedPr.tagsObject.purpose_commit_hash!==options.descriptionHash.toString("hex"))
318
+ throw new IntermediaryError("Invalid pr returned - description hash");
319
+
320
+ if(options.description!=null && decodedPr.tagsObject.description!==options.description)
321
+ throw new IntermediaryError("Invalid pr returned - description");
322
+
323
+ if(
324
+ decodedPr.tagsObject.payment_hash==null ||
325
+ !Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash)
326
+ ) throw new IntermediaryError("Invalid pr returned - payment hash");
327
+
328
+ if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid pr returned - msat field");
329
+
330
+ const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
331
+ if(resp.btcAmountGas + resp.btcAmountSwap !== amountIn) throw new IntermediaryError("Invalid total btc returned");
332
+ if(resp.gasSwapFeeBtc + resp.swapFeeBtc !== resp.totalFeeBtc) throw new IntermediaryError("Invalid total btc fee returned");
333
+ if(resp.claimerBounty !== claimerBounty) throw new IntermediaryError("Invalid claimer bounty");
334
+ if(resp.totalGas !== options.gasAmount) throw new IntermediaryError("Invalid total gas amount");
335
+ if(!amountData.exactIn) {
336
+ if(resp.total != amountData.amount) throw new IntermediaryError("Invalid amount returned");
337
+ } else {
338
+ if(amountIn !== amountData.amount) throw new IntermediaryError("Invalid payment request returned, amount mismatch");
339
+ }
340
+ }
341
+
342
+ /**
343
+ * Returns a newly created Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
344
+ * where watchtowers handle the automatic settlement of the swap on the destination chain. Also allows
345
+ * specifying additional "gas drop" native token that the receipient receives on the destination chain
346
+ * in the `options` argument. The user has to pay a bolt11 invoice on the input lightning network side.
347
+ *
348
+ * @param recipient Recipient's address on the destination chain
349
+ * @param amountData Amount, token and exact input/output data for to swap
350
+ * @param lps An array of intermediaries (LPs) to get the quotes from
351
+ * @param options Optional additional quote options
352
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
353
+ * @param abortSignal Abort signal
354
+ * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
355
+ */
356
+ create(
357
+ recipient: string,
358
+ amountData: AmountData,
359
+ lps: Intermediary[],
360
+ options?: FromBTCLNAutoOptions,
361
+ additionalParams?: Record<string, any>,
362
+ abortSignal?: AbortSignal,
363
+ preFetches?: {
364
+ pricePrefetchPromise: Promise<bigint | undefined>,
365
+ usdPricePrefetchPromise: Promise<number | undefined>,
366
+ claimerBountyPrefetch: {[contractVersion: string]: Promise<bigint | undefined>},
367
+ gasTokenPricePrefetchPromise?: Promise<bigint | undefined>,
368
+ }
369
+ ): {
370
+ quote: Promise<FromBTCLNAutoSwap<T>>,
371
+ intermediary: Intermediary
372
+ }[] {
373
+ if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
374
+
375
+ const _options = {
376
+ paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
377
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck,
378
+ gasAmount: this.parseGasAmount(options?.gasAmount),
379
+ feeSafetyFactor: options?.feeSafetyFactor ?? 1.25, //No need to add much of a margin, since the claim should happen rather soon
380
+ unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false,
381
+ description: options?.description,
382
+ descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash")
383
+ };
384
+
385
+
386
+ if(
387
+ _options.gasAmount!==0n &&
388
+ (
389
+ this._chain.shouldGetNativeTokenDrop!=null
390
+ ? !this._chain.shouldGetNativeTokenDrop(amountData.token)
391
+ : amountData.token===this._chain.getNativeCurrencyAddress()
392
+ )
393
+ ) throw new UserError("Cannot specify `gasAmount` for swaps to a native token!");
394
+
395
+ if(_options.description!=null && Buffer.byteLength(_options.description, "utf8") > 500)
396
+ throw new UserError("Invalid description length");
397
+
398
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
399
+
400
+ let secret: Buffer | undefined;
401
+ let paymentHash: Buffer;
402
+ if(_options?.paymentHash!=null) {
403
+ paymentHash = _options.paymentHash;
404
+ } else {
405
+ ({secret, paymentHash} = this.getSecretAndHash());
406
+ }
407
+ const _hash = mapArrayToObject(lpVersions, (contractVersion: string) => {
408
+ return this._contract(contractVersion).getHashForHtlc(paymentHash).toString("hex");
409
+ });
410
+
411
+ const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
412
+
413
+ const _abortController = extendAbortController(abortSignal);
414
+
415
+ const _preFetches = preFetches ?? {
416
+ pricePrefetchPromise: this.preFetchPrice(amountData, _abortController.signal),
417
+ usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
418
+ claimerBountyPrefetch: this.preFetchClaimerBounty(recipient, amountData, _options, _abortController, lpVersions),
419
+ gasTokenPricePrefetchPromise: _options.gasAmount!==0n || !_options.unsafeZeroWatchtowerFee ?
420
+ this.preFetchPrice({token: nativeTokenAddress}, _abortController.signal) :
421
+ undefined
422
+ };
423
+
424
+ return lps.map(lp => {
425
+ return {
426
+ intermediary: lp,
427
+ quote: (async () => {
428
+ if(lp.services[SwapType.FROM_BTCLN_AUTO]==null) throw new Error("LP service for processing from btcln auto swaps not found!");
429
+ const version = lp.getContractVersion(this.chainIdentifier);
430
+
431
+ const abortController = extendAbortController(_abortController.signal);
432
+
433
+ const liquidityPromise: Promise<bigint | undefined> = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
434
+
435
+ const {lnCapacityPromise, resp} = await tryWithRetries(async(retryCount: number) => {
436
+ const {lnPublicKey, response} = IntermediaryAPI.initFromBTCLNAuto(
437
+ this.chainIdentifier, lp.url,
438
+ {
439
+ paymentHash,
440
+ amount: amountData.amount,
441
+ claimer: recipient,
442
+ token: amountData.token.toString(),
443
+ description: _options.description,
444
+ descriptionHash: _options.descriptionHash,
445
+ exactOut: !amountData.exactIn,
446
+ additionalParams,
447
+ gasToken: this._chain.getNativeCurrencyAddress(),
448
+ gasAmount: _options.gasAmount,
449
+ claimerBounty: throwIfUndefined(_preFetches.claimerBountyPrefetch[version])
450
+ },
451
+ this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined
452
+ );
453
+
454
+ let lnCapacityPromise: Promise<LNNodeLiquidity | null> | undefined;
455
+ if(!_options.unsafeSkipLnNodeCheck) {
456
+ lnCapacityPromise = this.preFetchLnCapacity(lnPublicKey);
457
+ } else lnPublicKey.catch(() => {});
458
+
459
+ return {
460
+ lnCapacityPromise,
461
+ resp: await response
462
+ };
463
+ }, undefined, RequestError, abortController.signal);
464
+
465
+ const decodedPr = bolt11Decode(resp.pr);
466
+ if(decodedPr.millisatoshis==null) throw new IntermediaryError("Invalid returned swap invoice, no msat amount field");
467
+ if(decodedPr.timeExpireDate==null) throw new IntermediaryError("Invalid returned swap invoice, no expiry date field");
468
+ const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
469
+ const claimerBounty = (await _preFetches.claimerBountyPrefetch[version])!;
470
+
471
+ try {
472
+ this.verifyReturnedData(resp, amountData, lp, _options, decodedPr, paymentHash, claimerBounty);
473
+ const [pricingInfo, gasPricingInfo] = await Promise.all([
474
+ this.verifyReturnedPrice(
475
+ lp.services[SwapType.FROM_BTCLN_AUTO],
476
+ false, resp.btcAmountSwap,
477
+ resp.total,
478
+ amountData.token, {swapFeeBtc: resp.swapFeeBtc}, _preFetches.pricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal
479
+ ),
480
+ _options.gasAmount===0n ? Promise.resolve(undefined) : this.verifyReturnedPrice(
481
+ {...lp.services[SwapType.FROM_BTCLN_AUTO], swapBaseFee: 0}, //Base fee should be charged only on the amount, not on gas
482
+ false, resp.btcAmountGas,
483
+ resp.totalGas + resp.claimerBounty,
484
+ nativeTokenAddress, {swapFeeBtc: resp.gasSwapFeeBtc}, _preFetches.gasTokenPricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal
485
+ ),
486
+ this.verifyIntermediaryLiquidity(resp.total, throwIfUndefined(liquidityPromise)),
487
+ _options.unsafeSkipLnNodeCheck ? Promise.resolve() : this.verifyLnNodeCapacity(lp, decodedPr, lnCapacityPromise, abortController.signal)
488
+ ]);
489
+
490
+ const swapInit: FromBTCLNAutoSwapInit<T["Data"]> = {
491
+ pricingInfo,
492
+ url: lp.url,
493
+ expiry: decodedPr.timeExpireDate*1000,
494
+
495
+ swapFee: resp.swapFee,
496
+ gasSwapFee: resp.gasSwapFee,
497
+
498
+ swapFeeBtc: resp.swapFeeBtc,
499
+ gasSwapFeeBtc: resp.gasSwapFeeBtc,
500
+
501
+ btcAmountGas: resp.btcAmountGas,
502
+ btcAmountSwap: resp.btcAmountSwap,
503
+
504
+ gasPricingInfo,
505
+
506
+ initialSwapData: await this._contract(version).createSwapData(
507
+ ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token,
508
+ resp.total, _hash[version],
509
+ this.getRandomSequence(), BigInt(Math.floor(Date.now()/1000)), false, true,
510
+ _options.gasAmount + resp.claimerBounty, resp.claimerBounty, nativeTokenAddress
511
+ ),
512
+ pr: resp.pr,
513
+ secret: secret?.toString("hex"),
514
+ exactIn: amountData.exactIn ?? true,
515
+ contractVersion: version
516
+ };
517
+ const quote = new FromBTCLNAutoSwap<T>(this, swapInit);
518
+ return quote;
519
+ } catch (e) {
520
+ abortController.abort(e);
521
+ throw e;
522
+ }
523
+ })()
524
+ }
525
+ });
526
+ }
527
+
528
+ /**
529
+ * Returns a newly created Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
530
+ * where watchtowers handle the automatic settlement of the swap on the destination chain. Also allows
531
+ * specifying additional "gas drop" native token that the receipient receives on the destination chain
532
+ * in the `options` argument. The swap is created with an LNURL-withdraw link which will be used to pay
533
+ * the generated bolt11 invoice automatically when {@link FromBTCLNSwap.waitForPayment} is called on the
534
+ * swap.
535
+ *
536
+ * @param recipient Recipient's address on the destination chain
537
+ * @param lnurl LNURL-withdraw link to pull the funds from
538
+ * @param amountData Amount, token and exact input/output data for to swap
539
+ * @param lps An array of intermediaries (LPs) to get the quotes from
540
+ * @param options Optional additional quote options
541
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
542
+ * @param abortSignal Abort signal
543
+ */
544
+ async createViaLNURL(
545
+ recipient: string,
546
+ lnurl: string | LNURLWithdrawParamsWithUrl,
547
+ amountData: AmountData,
548
+ lps: Intermediary[],
549
+ options?: FromBTCLNAutoOptions,
550
+ additionalParams?: Record<string, any>,
551
+ abortSignal?: AbortSignal
552
+ ): Promise<{
553
+ quote: Promise<FromBTCLNAutoSwap<T>>,
554
+ intermediary: Intermediary
555
+ }[]> {
556
+ if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
557
+
558
+ const _options = {
559
+ paymentHash: parseHashValueExact32Bytes(options?.paymentHash, "payment hash"),
560
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck,
561
+ gasAmount: this.parseGasAmount(options?.gasAmount),
562
+ feeSafetyFactor: options?.feeSafetyFactor ?? 1.25, //No need to add much of a margin, since the claim should happen rather soon
563
+ unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false,
564
+ description: options?.description,
565
+ descriptionHash: parseHashValueExact32Bytes(options?.descriptionHash, "description hash")
566
+ };
567
+
568
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
569
+
570
+ const abortController = extendAbortController(abortSignal);
571
+ const preFetches = {
572
+ pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
573
+ usdPricePrefetchPromise: this.preFetchUsdPrice(abortController.signal),
574
+ gasTokenPricePrefetchPromise: _options.gasAmount!==0n || !_options.unsafeZeroWatchtowerFee ?
575
+ this.preFetchPrice({token: this._chain.getNativeCurrencyAddress()}, abortController.signal) :
576
+ undefined,
577
+ claimerBountyPrefetch: this.preFetchClaimerBounty(recipient, amountData, _options, abortController, lpVersions)
578
+ };
579
+
580
+ try {
581
+ const exactOutAmountPromise: Promise<bigint | undefined> | undefined = !amountData.exactIn ? preFetches.pricePrefetchPromise.then(price =>
582
+ this._prices.getToBtcSwapAmount(this.chainIdentifier, amountData.amount, amountData.token, abortController.signal, price)
583
+ ).catch(e => {
584
+ abortController.abort(e);
585
+ return undefined;
586
+ }) : undefined;
587
+
588
+ const withdrawRequest = await this.getLNURLWithdraw(lnurl, abortController.signal);
589
+
590
+ const min = BigInt(withdrawRequest.minWithdrawable) / 1000n;
591
+ const max = BigInt(withdrawRequest.maxWithdrawable) / 1000n;
592
+
593
+ if(amountData.exactIn) {
594
+ if(amountData.amount < min) throw new UserError("Amount less than LNURL-withdraw minimum");
595
+ if(amountData.amount > max) throw new UserError("Amount more than LNURL-withdraw maximum");
596
+ } else {
597
+ const amount = (await exactOutAmountPromise)!;
598
+ abortController.signal.throwIfAborted();
599
+
600
+ if((amount * 95n / 100n) < min) throw new UserError("Amount less than LNURL-withdraw minimum");
601
+ if((amount * 105n / 100n) > max) throw new UserError("Amount more than LNURL-withdraw maximum");
602
+ }
603
+
604
+ return this.create(recipient, amountData, lps, _options, additionalParams, abortSignal, preFetches).map(data => {
605
+ return {
606
+ quote: data.quote.then(quote => {
607
+ quote._setLNURLData(
608
+ withdrawRequest.url,
609
+ withdrawRequest.k1,
610
+ withdrawRequest.callback
611
+ );
612
+
613
+ const amountIn = quote.getInput().rawAmount!;
614
+ if(amountIn < min) throw new UserError("Amount less than LNURL-withdraw minimum");
615
+ if(amountIn > max) throw new UserError("Amount more than LNURL-withdraw maximum");
616
+
617
+ return quote;
618
+ }),
619
+ intermediary: data.intermediary
620
+ }
621
+ });
622
+ } catch (e) {
623
+ abortController.abort(e);
624
+ throw e;
625
+ }
626
+ }
627
+
628
+ /**
629
+ * @inheritDoc
630
+ * @internal
631
+ */
632
+ protected async _checkPastSwaps(pastSwaps: FromBTCLNAutoSwap<T>[]): Promise<{
633
+ changedSwaps: FromBTCLNAutoSwap<T>[];
634
+ removeSwaps: FromBTCLNAutoSwap<T>[]
635
+ }> {
636
+ const changedSwapSet: Set<FromBTCLNAutoSwap<T>> = new Set();
637
+
638
+ const swapExpiredStatus: {[id: string]: boolean} = {};
639
+ const checkStatusSwaps: {[contractVersion: string]: (FromBTCLNAutoSwap<T> & {_data: T["Data"]})[]} = {};
640
+
641
+ await Promise.all(pastSwaps.map(async (pastSwap) => {
642
+ if(pastSwap._shouldCheckIntermediary()) {
643
+ try {
644
+ const result = await pastSwap._checkIntermediaryPaymentReceived(false);
645
+ if(result!=null) {
646
+ changedSwapSet.add(pastSwap);
647
+ }
648
+ } catch (e) {
649
+ this.logger.error(`_checkPastSwaps(): Failed to contact LP regarding swap ${pastSwap.getId()}, error: `, e);
650
+ }
651
+ }
652
+ if(pastSwap._shouldFetchExpiryStatus()) {
653
+ //Check expiry
654
+ swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
655
+ }
656
+ if(pastSwap._shouldFetchOnchainState()) {
657
+ //Add to swaps for which status should be checked
658
+ if(pastSwap._data!=null) (checkStatusSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap as FromBTCLNAutoSwap<T> & {_data: T["Data"]});
659
+ }
660
+ }));
661
+
662
+ for(let version in checkStatusSwaps) {
663
+ if (this._versionedContracts[version] == null) {
664
+ this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${version}! Skipping these swaps!`);
665
+ continue;
666
+ }
667
+
668
+ const _checkStatusSwap = checkStatusSwaps[version];
669
+ const swapStatuses = await this._contract(version).getCommitStatuses(_checkStatusSwap.map(val => ({signer: val._getInitiator(), swapData: val._data})));
670
+
671
+ for(let pastSwap of _checkStatusSwap) {
672
+ const shouldSave = await pastSwap._sync(
673
+ false, swapExpiredStatus[pastSwap.getId()],
674
+ swapStatuses[pastSwap.getEscrowHash()!], true
675
+ );
676
+ if(shouldSave) {
677
+ changedSwapSet.add(pastSwap);
678
+ }
679
+ }
680
+ }
681
+
682
+ const changedSwaps: FromBTCLNAutoSwap<T>[] = [];
683
+ const removeSwaps: FromBTCLNAutoSwap<T>[] = [];
684
+ changedSwapSet.forEach(val => {
685
+ if(val.isQuoteExpired()) {
686
+ removeSwaps.push(val);
687
+ } else {
688
+ changedSwaps.push(val);
689
+ }
690
+ });
691
+
692
+ return {
693
+ changedSwaps,
694
+ removeSwaps
695
+ };
696
+ }
697
+
698
+ /**
699
+ * @inheritDoc
700
+ */
701
+ async recoverFromSwapDataAndState(
702
+ init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
703
+ state: SwapCommitState,
704
+ contractVersion: string,
705
+ lp?: Intermediary
706
+ ): Promise<FromBTCLNAutoSwap<T> | null> {
707
+ const data = init.data;
708
+
709
+ let paymentHash = data.getHTLCHashHint();
710
+ let secret: string | undefined;
711
+ if(state.type===SwapCommitStateType.PAID) {
712
+ secret = await state.getClaimResult();
713
+ paymentHash = Buffer.from(sha256(Buffer.from(secret, "hex"))).toString("hex");
714
+ }
715
+
716
+ const swapInit: FromBTCLNAutoSwapInit<T["Data"]> = {
717
+ pricingInfo: {
718
+ isValid: true,
719
+ satsBaseFee: 0n,
720
+ swapPriceUSatPerToken: 100_000_000_000_000n,
721
+ realPriceUSatPerToken: 100_000_000_000_000n,
722
+ differencePPM: 0n,
723
+ feePPM: 0n,
724
+ },
725
+ url: lp?.url,
726
+ expiry: 0,
727
+ swapFee: 0n,
728
+ swapFeeBtc: 0n,
729
+ gasSwapFee: 0n,
730
+ gasSwapFeeBtc: 0n,
731
+ initialSwapData: data,
732
+ data,
733
+ pr: paymentHash ?? undefined,
734
+ secret,
735
+ exactIn: false,
736
+ contractVersion
737
+ }
738
+ const swap = new FromBTCLNAutoSwap(this, swapInit);
739
+ swap._commitTxId = await init.getInitTxId();
740
+ const blockData = await init.getTxBlock();
741
+ swap.createdAt = blockData.blockTime * 1000;
742
+ swap._commitedAt = blockData.blockTime * 1000;
743
+ swap._setInitiated();
744
+ swap._state = FromBTCLNAutoSwapState.CLAIM_COMMITED;
745
+ await swap._sync(false, false, state);
746
+ await swap._save();
747
+ return swap;
748
+ }
749
+
750
+ }