@atomiqlabs/sdk 8.7.7 → 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 -6
  6. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  7. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -6
  8. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  9. package/dist/bitcoin/coinselect2/index.d.ts +20 -19
  10. package/dist/bitcoin/coinselect2/index.js +69 -69
  11. package/dist/bitcoin/coinselect2/utils.d.ts +82 -77
  12. package/dist/bitcoin/coinselect2/utils.js +158 -123
  13. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -130
  14. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -322
  15. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -78
  16. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  17. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -101
  18. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -190
  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 -440
  60. package/dist/intermediaries/apis/IntermediaryAPI.js +618 -603
  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 -692
  102. package/dist/swapper/Swapper.js +1713 -1657
  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 -631
  164. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1448 -1444
  165. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +257 -225
  166. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -822
  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 -14
  210. package/dist/utils/BitcoinUtils.js +141 -102
  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 -68
  230. package/src/bitcoin/coinselect2/blackjack.ts +50 -49
  231. package/src/bitcoin/coinselect2/index.ts +93 -92
  232. package/src/bitcoin/coinselect2/utils.ts +236 -195
  233. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -427
  234. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -99
  235. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -217
  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 -947
  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 -2416
  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 -1799
  309. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1236 -1060
  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 -91
  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,432 +1,432 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.FromBTCLNWrapper = void 0;
4
- const FromBTCLNSwap_1 = require("./FromBTCLNSwap");
5
- const bolt11_1 = require("@atomiqlabs/bolt11");
6
- const base_1 = require("@atomiqlabs/base");
7
- const Intermediary_1 = require("../../../../intermediaries/Intermediary");
8
- const buffer_1 = require("buffer");
9
- const UserError_1 = require("../../../../errors/UserError");
10
- const IntermediaryError_1 = require("../../../../errors/IntermediaryError");
11
- const SwapType_1 = require("../../../../enums/SwapType");
12
- const Utils_1 = require("../../../../utils/Utils");
13
- const IntermediaryAPI_1 = require("../../../../intermediaries/apis/IntermediaryAPI");
14
- const RequestError_1 = require("../../../../errors/RequestError");
15
- const IFromBTCLNWrapper_1 = require("../IFromBTCLNWrapper");
16
- const RetryUtils_1 = require("../../../../utils/RetryUtils");
17
- const sha2_1 = require("@noble/hashes/sha2");
18
- /**
19
- * Legacy escrow (HTLC) based swap for Bitcoin Lightning -> Smart chains, requires manual settlement
20
- * of the swap on the destination network once the lightning network payment is received by the LP.
21
- *
22
- * @category Swaps/Legacy/Lightning → Smart chain
23
- */
24
- class FromBTCLNWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
25
- /**
26
- * @param chainIdentifier
27
- * @param unifiedStorage Storage interface for the current environment
28
- * @param unifiedChainEvents On-chain event listener
29
- * @param chain
30
- * @param prices Swap pricing handler
31
- * @param tokens
32
- * @param versionedContracts
33
- * @param lnApi
34
- * @param options
35
- * @param events Instance to use for emitting events
36
- */
37
- constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi, options, events) {
38
- super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi, {
39
- ...options,
40
- safetyFactor: options?.safetyFactor ?? 2,
41
- bitcoinBlocktime: options?.bitcoinBlocktime ?? 10 * 60,
42
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? false
43
- }, events);
44
- this.TYPE = SwapType_1.SwapType.FROM_BTCLN;
45
- /**
46
- * @internal
47
- */
48
- this.tickSwapState = [
49
- FromBTCLNSwap_1.FromBTCLNSwapState.PR_CREATED,
50
- FromBTCLNSwap_1.FromBTCLNSwapState.PR_PAID,
51
- FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED
52
- ];
53
- /**
54
- * @internal
55
- */
56
- this._pendingSwapStates = [
57
- FromBTCLNSwap_1.FromBTCLNSwapState.PR_CREATED,
58
- FromBTCLNSwap_1.FromBTCLNSwapState.QUOTE_SOFT_EXPIRED,
59
- FromBTCLNSwap_1.FromBTCLNSwapState.PR_PAID,
60
- FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED,
61
- FromBTCLNSwap_1.FromBTCLNSwapState.EXPIRED
62
- ];
63
- /**
64
- * @internal
65
- */
66
- this._claimableSwapStates = [FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED];
67
- /**
68
- * @internal
69
- */
70
- this._swapDeserializer = FromBTCLNSwap_1.FromBTCLNSwap;
71
- }
72
- /**
73
- * @inheritDoc
74
- * @internal
75
- */
76
- processEventInitialize(swap, event) {
77
- if (swap._state === FromBTCLNSwap_1.FromBTCLNSwapState.PR_PAID || swap._state === FromBTCLNSwap_1.FromBTCLNSwapState.QUOTE_SOFT_EXPIRED) {
78
- swap._state = FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED;
79
- return Promise.resolve(true);
80
- }
81
- return Promise.resolve(false);
82
- }
83
- /**
84
- * @inheritDoc
85
- * @internal
86
- */
87
- processEventClaim(swap, event) {
88
- if (swap._state !== FromBTCLNSwap_1.FromBTCLNSwapState.FAILED && swap._state !== FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_CLAIMED) {
89
- swap._state = FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_CLAIMED;
90
- swap._setSwapSecret(event.result);
91
- return Promise.resolve(true);
92
- }
93
- return Promise.resolve(false);
94
- }
95
- /**
96
- * @inheritDoc
97
- * @internal
98
- */
99
- processEventRefund(swap, event) {
100
- if (swap._state !== FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_CLAIMED && swap._state !== FromBTCLNSwap_1.FromBTCLNSwapState.FAILED) {
101
- swap._state = FromBTCLNSwap_1.FromBTCLNSwapState.FAILED;
102
- return Promise.resolve(true);
103
- }
104
- return Promise.resolve(false);
105
- }
106
- /**
107
- * Verifies response returned from intermediary
108
- *
109
- * @param resp Response as returned by the intermediary
110
- * @param amountData
111
- * @param lp Intermediary
112
- * @param options Options as passed to the swap creation function
113
- * @param decodedPr Decoded bolt11 lightning network invoice
114
- * @param paymentHash Expected payment hash of the bolt11 lightning network invoice
115
- *
116
- * @throws {IntermediaryError} in case the response is invalid
117
- *
118
- * @private
119
- */
120
- verifyReturnedData(resp, amountData, lp, options, decodedPr, paymentHash) {
121
- if (lp.getAddress(this.chainIdentifier) !== resp.intermediaryKey)
122
- throw new IntermediaryError_1.IntermediaryError("Invalid intermediary address/pubkey");
123
- if (options.descriptionHash != null && decodedPr.tagsObject.purpose_commit_hash !== options.descriptionHash.toString("hex"))
124
- throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - description hash");
125
- if (options.description != null && decodedPr.tagsObject.description !== options.description)
126
- throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - description");
127
- if (decodedPr.tagsObject.payment_hash == null ||
128
- !buffer_1.Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash))
129
- throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - payment hash");
130
- if (decodedPr.millisatoshis == null)
131
- throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - msat field");
132
- if (!amountData.exactIn) {
133
- if (resp.total != amountData.amount)
134
- throw new IntermediaryError_1.IntermediaryError("Invalid amount returned");
135
- }
136
- else {
137
- const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
138
- if (amountIn !== amountData.amount)
139
- throw new IntermediaryError_1.IntermediaryError("Invalid payment request returned, amount mismatch");
140
- }
141
- }
142
- /**
143
- * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
144
- * where the user needs to manually settle swap on the destination smart chain. The user has to pay
145
- * a bolt11 invoice on the input lightning network side.
146
- *
147
- * @param recipient Smart chain signer's address on the destination chain, that will have to manually
148
- * settle the swap.
149
- * @param amountData Amount, token and exact input/output data for to swap
150
- * @param lps An array of intermediaries (LPs) to get the quotes from
151
- * @param options Optional additional quote options
152
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
153
- * @param abortSignal Abort signal
154
- * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
155
- */
156
- create(recipient, amountData, lps, options, additionalParams, abortSignal, preFetches) {
157
- if (!this.isInitialized)
158
- throw new Error("Not initialized, call init() first!");
159
- const _options = {
160
- paymentHash: (0, Utils_1.parseHashValueExact32Bytes)(options?.paymentHash, "payment hash"),
161
- description: options?.description,
162
- descriptionHash: (0, Utils_1.parseHashValueExact32Bytes)(options?.descriptionHash, "description hash"),
163
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
164
- };
165
- if (_options.description != null && buffer_1.Buffer.byteLength(_options.description, "utf8") > 500)
166
- throw new UserError_1.UserError("Invalid description length");
167
- const lpVersions = Intermediary_1.Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
168
- let secret;
169
- let paymentHash;
170
- if (_options.paymentHash != null) {
171
- paymentHash = _options.paymentHash;
172
- }
173
- else {
174
- ({ secret, paymentHash } = this.getSecretAndHash());
175
- }
176
- const _hash = (0, Utils_1.mapArrayToObject)(lpVersions, (contractVersion) => {
177
- return this._contract(contractVersion).getHashForHtlc(paymentHash).toString("hex");
178
- });
179
- const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
180
- const _abortController = (0, Utils_1.extendAbortController)(abortSignal);
181
- const _preFetches = preFetches ?? {
182
- pricePrefetchPromise: this.preFetchPrice(amountData, _abortController.signal),
183
- feeRatePromise: this.preFetchFeeRate(recipient, amountData, _hash, _abortController, lpVersions),
184
- usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
185
- };
186
- return lps.map(lp => {
187
- return {
188
- intermediary: lp,
189
- quote: (async () => {
190
- if (lp.services[SwapType_1.SwapType.FROM_BTCLN] == null)
191
- throw new Error("LP service for processing from btcln swaps not found!");
192
- const version = lp.getContractVersion(this.chainIdentifier);
193
- const abortController = (0, Utils_1.extendAbortController)(_abortController.signal);
194
- const liquidityPromise = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
195
- const { lnCapacityPromise, resp } = await (0, RetryUtils_1.tryWithRetries)(async (retryCount) => {
196
- const { lnPublicKey, response } = IntermediaryAPI_1.IntermediaryAPI.initFromBTCLN(this.chainIdentifier, lp.url, nativeTokenAddress, {
197
- paymentHash,
198
- amount: amountData.amount,
199
- claimer: recipient,
200
- token: amountData.token.toString(),
201
- description: _options.description,
202
- descriptionHash: _options.descriptionHash,
203
- exactOut: !amountData.exactIn,
204
- feeRate: (0, Utils_1.throwIfUndefined)(_preFetches.feeRatePromise[version]),
205
- additionalParams
206
- }, this._options.postRequestTimeout, abortController.signal, retryCount > 0 ? false : undefined);
207
- let lnCapacityPromise;
208
- if (!_options.unsafeSkipLnNodeCheck) {
209
- lnCapacityPromise = this.preFetchLnCapacity(lnPublicKey);
210
- }
211
- else
212
- lnPublicKey.catch(() => { });
213
- return {
214
- lnCapacityPromise,
215
- resp: await response
216
- };
217
- }, undefined, RequestError_1.RequestError, abortController.signal);
218
- const decodedPr = (0, bolt11_1.decode)(resp.pr);
219
- if (decodedPr.millisatoshis == null)
220
- throw new IntermediaryError_1.IntermediaryError("Invalid returned swap invoice, no msat amount field");
221
- if (decodedPr.timeExpireDate == null)
222
- throw new IntermediaryError_1.IntermediaryError("Invalid returned swap invoice, no expiry date field");
223
- const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
224
- const swapFeeBtc = resp.swapFee * amountIn / (resp.total + resp.swapFee);
225
- try {
226
- this.verifyReturnedData(resp, amountData, lp, _options, decodedPr, paymentHash);
227
- const [pricingInfo] = await Promise.all([
228
- this.verifyReturnedPrice(lp.services[SwapType_1.SwapType.FROM_BTCLN], false, amountIn, resp.total, amountData.token, { swapFeeBtc }, _preFetches.pricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal),
229
- this.verifyIntermediaryLiquidity(resp.total, (0, Utils_1.throwIfUndefined)(liquidityPromise)),
230
- lnCapacityPromise != null ? this.verifyLnNodeCapacity(lp, decodedPr, lnCapacityPromise, abortController.signal) : Promise.resolve()
231
- ]);
232
- const quote = new FromBTCLNSwap_1.FromBTCLNSwap(this, {
233
- pricingInfo,
234
- url: lp.url,
235
- expiry: decodedPr.timeExpireDate * 1000,
236
- swapFee: resp.swapFee,
237
- swapFeeBtc,
238
- feeRate: (await _preFetches.feeRatePromise[version]),
239
- initialSwapData: await this._contract(version).createSwapData(base_1.ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token, resp.total, _hash[version], this.getRandomSequence(), BigInt(Math.floor(Date.now() / 1000)), false, true, resp.securityDeposit, 0n, nativeTokenAddress),
240
- pr: resp.pr,
241
- secret: secret?.toString("hex"),
242
- exactIn: amountData.exactIn ?? true,
243
- contractVersion: version
244
- });
245
- return quote;
246
- }
247
- catch (e) {
248
- abortController.abort(e);
249
- throw e;
250
- }
251
- })()
252
- };
253
- });
254
- }
255
- /**
256
- * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
257
- * where the user needs to manually settle swap on the destination smart chain. The swap is created
258
- * with an LNURL-withdraw link which will be used to pay the generated bolt11 invoice automatically
259
- * when {@link FromBTCLNSwap.waitForPayment} is called on the swap.
260
- *
261
- * @param recipient Smart chain signer's address on the destination chain, that will have to manually
262
- * settle the swap.
263
- * @param lnurl LNURL-withdraw link to pull the funds from
264
- * @param amountData Amount, token and exact input/output data for to swap
265
- * @param lps An array of intermediaries (LPs) to get the quotes from
266
- * @param options Optional additional quote options
267
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
268
- * @param abortSignal Abort signal
269
- */
270
- async createViaLNURL(recipient, lnurl, amountData, lps, options, additionalParams, abortSignal) {
271
- if (!this.isInitialized)
272
- throw new Error("Not initialized, call init() first!");
273
- const _options = {
274
- paymentHash: (0, Utils_1.parseHashValueExact32Bytes)(options?.paymentHash, "payment hash"),
275
- description: options?.description,
276
- descriptionHash: (0, Utils_1.parseHashValueExact32Bytes)(options?.descriptionHash, "description hash"),
277
- unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
278
- };
279
- const lpVersions = Intermediary_1.Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
280
- const abortController = (0, Utils_1.extendAbortController)(abortSignal);
281
- const preFetches = {
282
- pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
283
- usdPricePrefetchPromise: this.preFetchUsdPrice(abortController.signal),
284
- feeRatePromise: this.preFetchFeeRate(recipient, amountData, undefined, abortController, lpVersions)
285
- };
286
- try {
287
- const exactOutAmountPromise = !amountData.exactIn ? preFetches.pricePrefetchPromise.then(price => this._prices.getToBtcSwapAmount(this.chainIdentifier, amountData.amount, amountData.token, abortController.signal, price)).catch(e => {
288
- abortController.abort(e);
289
- return undefined;
290
- }) : undefined;
291
- const withdrawRequest = await this.getLNURLWithdraw(lnurl, abortController.signal);
292
- const min = BigInt(withdrawRequest.minWithdrawable) / 1000n;
293
- const max = BigInt(withdrawRequest.maxWithdrawable) / 1000n;
294
- if (amountData.exactIn) {
295
- if (amountData.amount < min)
296
- throw new UserError_1.UserError("Amount less than LNURL-withdraw minimum");
297
- if (amountData.amount > max)
298
- throw new UserError_1.UserError("Amount more than LNURL-withdraw maximum");
299
- }
300
- else {
301
- const amount = (await exactOutAmountPromise);
302
- abortController.signal.throwIfAborted();
303
- if ((amount * 95n / 100n) < min)
304
- throw new UserError_1.UserError("Amount less than LNURL-withdraw minimum");
305
- if ((amount * 105n / 100n) > max)
306
- throw new UserError_1.UserError("Amount more than LNURL-withdraw maximum");
307
- }
308
- return this.create(recipient, amountData, lps, _options, additionalParams, abortSignal, preFetches).map(data => {
309
- return {
310
- quote: data.quote.then(quote => {
311
- quote._setLNURLData(withdrawRequest.url, withdrawRequest.k1, withdrawRequest.callback);
312
- const amountIn = quote.getInput().rawAmount;
313
- if (amountIn < min)
314
- throw new UserError_1.UserError("Amount less than LNURL-withdraw minimum");
315
- if (amountIn > max)
316
- throw new UserError_1.UserError("Amount more than LNURL-withdraw maximum");
317
- return quote;
318
- }),
319
- intermediary: data.intermediary
320
- };
321
- });
322
- }
323
- catch (e) {
324
- abortController.abort(e);
325
- throw e;
326
- }
327
- }
328
- /**
329
- * @inheritDoc
330
- * @internal
331
- */
332
- async _checkPastSwaps(pastSwaps) {
333
- const changedSwapSet = new Set();
334
- const swapExpiredStatus = {};
335
- const checkStatusSwaps = {};
336
- await Promise.all(pastSwaps.map(async (pastSwap) => {
337
- if (pastSwap._shouldCheckIntermediary()) {
338
- try {
339
- const result = await pastSwap._checkIntermediaryPaymentReceived(false);
340
- if (result != null) {
341
- changedSwapSet.add(pastSwap);
342
- }
343
- }
344
- catch (e) {
345
- this.logger.error(`_checkPastSwaps(): Failed to contact LP regarding swap ${pastSwap.getId()}, error: `, e);
346
- }
347
- }
348
- if (pastSwap._shouldFetchExpiryStatus()) {
349
- //Check expiry
350
- swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
351
- }
352
- if (pastSwap._shouldFetchOnchainState()) {
353
- //Add to swaps for which status should be checked
354
- if (pastSwap._data != null)
355
- (checkStatusSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap);
356
- }
357
- }));
358
- for (let version in checkStatusSwaps) {
359
- if (this._versionedContracts[version] == null) {
360
- this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${version}! Skipping these swaps!`);
361
- continue;
362
- }
363
- const _checkStatusSwap = checkStatusSwaps[version];
364
- const swapStatuses = await this._contract(version).getCommitStatuses(_checkStatusSwap.map(val => ({ signer: val._getInitiator(), swapData: val._data })));
365
- for (let pastSwap of _checkStatusSwap) {
366
- const shouldSave = await pastSwap._sync(false, swapExpiredStatus[pastSwap.getId()], swapStatuses[pastSwap.getEscrowHash()], true);
367
- if (shouldSave) {
368
- changedSwapSet.add(pastSwap);
369
- }
370
- }
371
- }
372
- const changedSwaps = [];
373
- const removeSwaps = [];
374
- changedSwapSet.forEach(val => {
375
- if (val.isQuoteExpired()) {
376
- removeSwaps.push(val);
377
- }
378
- else {
379
- changedSwaps.push(val);
380
- }
381
- });
382
- return {
383
- changedSwaps,
384
- removeSwaps
385
- };
386
- }
387
- /**
388
- * @inheritDoc
389
- * @internal
390
- */
391
- async recoverFromSwapDataAndState(init, state, contractVersion, lp) {
392
- const data = init.data;
393
- let paymentHash = data.getHTLCHashHint();
394
- let secret;
395
- if (state.type === base_1.SwapCommitStateType.PAID) {
396
- secret = await state.getClaimResult();
397
- paymentHash = buffer_1.Buffer.from((0, sha2_1.sha256)(buffer_1.Buffer.from(secret, "hex"))).toString("hex");
398
- }
399
- const swapInit = {
400
- pricingInfo: {
401
- isValid: true,
402
- satsBaseFee: 0n,
403
- swapPriceUSatPerToken: 100000000000000n,
404
- realPriceUSatPerToken: 100000000000000n,
405
- differencePPM: 0n,
406
- feePPM: 0n,
407
- },
408
- url: lp?.url,
409
- expiry: 0,
410
- swapFee: 0n,
411
- swapFeeBtc: 0n,
412
- feeRate: "",
413
- signatureData: undefined,
414
- initialSwapData: data,
415
- data,
416
- pr: paymentHash ?? undefined,
417
- secret,
418
- exactIn: false,
419
- contractVersion
420
- };
421
- const swap = new FromBTCLNSwap_1.FromBTCLNSwap(this, swapInit);
422
- swap._commitTxId = await init.getInitTxId();
423
- const blockData = await init.getTxBlock();
424
- swap.createdAt = blockData.blockTime * 1000;
425
- swap._setInitiated();
426
- swap._state = FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED;
427
- await swap._sync(false, false, state);
428
- await swap._save();
429
- return swap;
430
- }
431
- }
432
- exports.FromBTCLNWrapper = FromBTCLNWrapper;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.FromBTCLNWrapper = void 0;
4
+ const FromBTCLNSwap_1 = require("./FromBTCLNSwap");
5
+ const bolt11_1 = require("@atomiqlabs/bolt11");
6
+ const base_1 = require("@atomiqlabs/base");
7
+ const Intermediary_1 = require("../../../../intermediaries/Intermediary");
8
+ const buffer_1 = require("buffer");
9
+ const UserError_1 = require("../../../../errors/UserError");
10
+ const IntermediaryError_1 = require("../../../../errors/IntermediaryError");
11
+ const SwapType_1 = require("../../../../enums/SwapType");
12
+ const Utils_1 = require("../../../../utils/Utils");
13
+ const IntermediaryAPI_1 = require("../../../../intermediaries/apis/IntermediaryAPI");
14
+ const RequestError_1 = require("../../../../errors/RequestError");
15
+ const IFromBTCLNWrapper_1 = require("../IFromBTCLNWrapper");
16
+ const RetryUtils_1 = require("../../../../utils/RetryUtils");
17
+ const sha2_1 = require("@noble/hashes/sha2");
18
+ /**
19
+ * Legacy escrow (HTLC) based swap for Bitcoin Lightning -> Smart chains, requires manual settlement
20
+ * of the swap on the destination network once the lightning network payment is received by the LP.
21
+ *
22
+ * @category Swaps/Legacy/Lightning → Smart chain
23
+ */
24
+ class FromBTCLNWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
25
+ /**
26
+ * @param chainIdentifier
27
+ * @param unifiedStorage Storage interface for the current environment
28
+ * @param unifiedChainEvents On-chain event listener
29
+ * @param chain
30
+ * @param prices Swap pricing handler
31
+ * @param tokens
32
+ * @param versionedContracts
33
+ * @param lnApi
34
+ * @param options
35
+ * @param events Instance to use for emitting events
36
+ */
37
+ constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi, options, events) {
38
+ super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, lnApi, {
39
+ ...options,
40
+ safetyFactor: options?.safetyFactor ?? 2,
41
+ bitcoinBlocktime: options?.bitcoinBlocktime ?? 10 * 60,
42
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? false
43
+ }, events);
44
+ this.TYPE = SwapType_1.SwapType.FROM_BTCLN;
45
+ /**
46
+ * @internal
47
+ */
48
+ this.tickSwapState = [
49
+ FromBTCLNSwap_1.FromBTCLNSwapState.PR_CREATED,
50
+ FromBTCLNSwap_1.FromBTCLNSwapState.PR_PAID,
51
+ FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED
52
+ ];
53
+ /**
54
+ * @internal
55
+ */
56
+ this._pendingSwapStates = [
57
+ FromBTCLNSwap_1.FromBTCLNSwapState.PR_CREATED,
58
+ FromBTCLNSwap_1.FromBTCLNSwapState.QUOTE_SOFT_EXPIRED,
59
+ FromBTCLNSwap_1.FromBTCLNSwapState.PR_PAID,
60
+ FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED,
61
+ FromBTCLNSwap_1.FromBTCLNSwapState.EXPIRED
62
+ ];
63
+ /**
64
+ * @internal
65
+ */
66
+ this._claimableSwapStates = [FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED];
67
+ /**
68
+ * @internal
69
+ */
70
+ this._swapDeserializer = FromBTCLNSwap_1.FromBTCLNSwap;
71
+ }
72
+ /**
73
+ * @inheritDoc
74
+ * @internal
75
+ */
76
+ processEventInitialize(swap, event) {
77
+ if (swap._state === FromBTCLNSwap_1.FromBTCLNSwapState.PR_PAID || swap._state === FromBTCLNSwap_1.FromBTCLNSwapState.QUOTE_SOFT_EXPIRED) {
78
+ swap._state = FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED;
79
+ return Promise.resolve(true);
80
+ }
81
+ return Promise.resolve(false);
82
+ }
83
+ /**
84
+ * @inheritDoc
85
+ * @internal
86
+ */
87
+ processEventClaim(swap, event) {
88
+ if (swap._state !== FromBTCLNSwap_1.FromBTCLNSwapState.FAILED && swap._state !== FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_CLAIMED) {
89
+ swap._state = FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_CLAIMED;
90
+ swap._setSwapSecret(event.result);
91
+ return Promise.resolve(true);
92
+ }
93
+ return Promise.resolve(false);
94
+ }
95
+ /**
96
+ * @inheritDoc
97
+ * @internal
98
+ */
99
+ processEventRefund(swap, event) {
100
+ if (swap._state !== FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_CLAIMED && swap._state !== FromBTCLNSwap_1.FromBTCLNSwapState.FAILED) {
101
+ swap._state = FromBTCLNSwap_1.FromBTCLNSwapState.FAILED;
102
+ return Promise.resolve(true);
103
+ }
104
+ return Promise.resolve(false);
105
+ }
106
+ /**
107
+ * Verifies response returned from intermediary
108
+ *
109
+ * @param resp Response as returned by the intermediary
110
+ * @param amountData
111
+ * @param lp Intermediary
112
+ * @param options Options as passed to the swap creation function
113
+ * @param decodedPr Decoded bolt11 lightning network invoice
114
+ * @param paymentHash Expected payment hash of the bolt11 lightning network invoice
115
+ *
116
+ * @throws {IntermediaryError} in case the response is invalid
117
+ *
118
+ * @private
119
+ */
120
+ verifyReturnedData(resp, amountData, lp, options, decodedPr, paymentHash) {
121
+ if (lp.getAddress(this.chainIdentifier) !== resp.intermediaryKey)
122
+ throw new IntermediaryError_1.IntermediaryError("Invalid intermediary address/pubkey");
123
+ if (options.descriptionHash != null && decodedPr.tagsObject.purpose_commit_hash !== options.descriptionHash.toString("hex"))
124
+ throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - description hash");
125
+ if (options.description != null && decodedPr.tagsObject.description !== options.description)
126
+ throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - description");
127
+ if (decodedPr.tagsObject.payment_hash == null ||
128
+ !buffer_1.Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash))
129
+ throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - payment hash");
130
+ if (decodedPr.millisatoshis == null)
131
+ throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - msat field");
132
+ if (!amountData.exactIn) {
133
+ if (resp.total != amountData.amount)
134
+ throw new IntermediaryError_1.IntermediaryError("Invalid amount returned");
135
+ }
136
+ else {
137
+ const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
138
+ if (amountIn !== amountData.amount)
139
+ throw new IntermediaryError_1.IntermediaryError("Invalid payment request returned, amount mismatch");
140
+ }
141
+ }
142
+ /**
143
+ * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
144
+ * where the user needs to manually settle swap on the destination smart chain. The user has to pay
145
+ * a bolt11 invoice on the input lightning network side.
146
+ *
147
+ * @param recipient Smart chain signer's address on the destination chain, that will have to manually
148
+ * settle the swap.
149
+ * @param amountData Amount, token and exact input/output data for to swap
150
+ * @param lps An array of intermediaries (LPs) to get the quotes from
151
+ * @param options Optional additional quote options
152
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
153
+ * @param abortSignal Abort signal
154
+ * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
155
+ */
156
+ create(recipient, amountData, lps, options, additionalParams, abortSignal, preFetches) {
157
+ if (!this.isInitialized)
158
+ throw new Error("Not initialized, call init() first!");
159
+ const _options = {
160
+ paymentHash: (0, Utils_1.parseHashValueExact32Bytes)(options?.paymentHash, "payment hash"),
161
+ description: options?.description,
162
+ descriptionHash: (0, Utils_1.parseHashValueExact32Bytes)(options?.descriptionHash, "description hash"),
163
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
164
+ };
165
+ if (_options.description != null && buffer_1.Buffer.byteLength(_options.description, "utf8") > 500)
166
+ throw new UserError_1.UserError("Invalid description length");
167
+ const lpVersions = Intermediary_1.Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
168
+ let secret;
169
+ let paymentHash;
170
+ if (_options.paymentHash != null) {
171
+ paymentHash = _options.paymentHash;
172
+ }
173
+ else {
174
+ ({ secret, paymentHash } = this.getSecretAndHash());
175
+ }
176
+ const _hash = (0, Utils_1.mapArrayToObject)(lpVersions, (contractVersion) => {
177
+ return this._contract(contractVersion).getHashForHtlc(paymentHash).toString("hex");
178
+ });
179
+ const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
180
+ const _abortController = (0, Utils_1.extendAbortController)(abortSignal);
181
+ const _preFetches = preFetches ?? {
182
+ pricePrefetchPromise: this.preFetchPrice(amountData, _abortController.signal),
183
+ feeRatePromise: this.preFetchFeeRate(recipient, amountData, _hash, _abortController, lpVersions),
184
+ usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
185
+ };
186
+ return lps.map(lp => {
187
+ return {
188
+ intermediary: lp,
189
+ quote: (async () => {
190
+ if (lp.services[SwapType_1.SwapType.FROM_BTCLN] == null)
191
+ throw new Error("LP service for processing from btcln swaps not found!");
192
+ const version = lp.getContractVersion(this.chainIdentifier);
193
+ const abortController = (0, Utils_1.extendAbortController)(_abortController.signal);
194
+ const liquidityPromise = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
195
+ const { lnCapacityPromise, resp } = await (0, RetryUtils_1.tryWithRetries)(async (retryCount) => {
196
+ const { lnPublicKey, response } = IntermediaryAPI_1.IntermediaryAPI.initFromBTCLN(this.chainIdentifier, lp.url, nativeTokenAddress, {
197
+ paymentHash,
198
+ amount: amountData.amount,
199
+ claimer: recipient,
200
+ token: amountData.token.toString(),
201
+ description: _options.description,
202
+ descriptionHash: _options.descriptionHash,
203
+ exactOut: !amountData.exactIn,
204
+ feeRate: (0, Utils_1.throwIfUndefined)(_preFetches.feeRatePromise[version]),
205
+ additionalParams
206
+ }, this._options.postRequestTimeout, abortController.signal, retryCount > 0 ? false : undefined);
207
+ let lnCapacityPromise;
208
+ if (!_options.unsafeSkipLnNodeCheck) {
209
+ lnCapacityPromise = this.preFetchLnCapacity(lnPublicKey);
210
+ }
211
+ else
212
+ lnPublicKey.catch(() => { });
213
+ return {
214
+ lnCapacityPromise,
215
+ resp: await response
216
+ };
217
+ }, undefined, RequestError_1.RequestError, abortController.signal);
218
+ const decodedPr = (0, bolt11_1.decode)(resp.pr);
219
+ if (decodedPr.millisatoshis == null)
220
+ throw new IntermediaryError_1.IntermediaryError("Invalid returned swap invoice, no msat amount field");
221
+ if (decodedPr.timeExpireDate == null)
222
+ throw new IntermediaryError_1.IntermediaryError("Invalid returned swap invoice, no expiry date field");
223
+ const amountIn = (BigInt(decodedPr.millisatoshis) + 999n) / 1000n;
224
+ const swapFeeBtc = resp.swapFee * amountIn / (resp.total + resp.swapFee);
225
+ try {
226
+ this.verifyReturnedData(resp, amountData, lp, _options, decodedPr, paymentHash);
227
+ const [pricingInfo] = await Promise.all([
228
+ this.verifyReturnedPrice(lp.services[SwapType_1.SwapType.FROM_BTCLN], false, amountIn, resp.total, amountData.token, { swapFeeBtc }, _preFetches.pricePrefetchPromise, _preFetches.usdPricePrefetchPromise, abortController.signal),
229
+ this.verifyIntermediaryLiquidity(resp.total, (0, Utils_1.throwIfUndefined)(liquidityPromise)),
230
+ lnCapacityPromise != null ? this.verifyLnNodeCapacity(lp, decodedPr, lnCapacityPromise, abortController.signal) : Promise.resolve()
231
+ ]);
232
+ const quote = new FromBTCLNSwap_1.FromBTCLNSwap(this, {
233
+ pricingInfo,
234
+ url: lp.url,
235
+ expiry: decodedPr.timeExpireDate * 1000,
236
+ swapFee: resp.swapFee,
237
+ swapFeeBtc,
238
+ feeRate: (await _preFetches.feeRatePromise[version]),
239
+ initialSwapData: await this._contract(version).createSwapData(base_1.ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token, resp.total, _hash[version], this.getRandomSequence(), BigInt(Math.floor(Date.now() / 1000)), false, true, resp.securityDeposit, 0n, nativeTokenAddress),
240
+ pr: resp.pr,
241
+ secret: secret?.toString("hex"),
242
+ exactIn: amountData.exactIn ?? true,
243
+ contractVersion: version
244
+ });
245
+ return quote;
246
+ }
247
+ catch (e) {
248
+ abortController.abort(e);
249
+ throw e;
250
+ }
251
+ })()
252
+ };
253
+ });
254
+ }
255
+ /**
256
+ * Returns a newly created legacy Lightning -> Smart chain swap using the HTLC based escrow swap protocol,
257
+ * where the user needs to manually settle swap on the destination smart chain. The swap is created
258
+ * with an LNURL-withdraw link which will be used to pay the generated bolt11 invoice automatically
259
+ * when {@link FromBTCLNSwap.waitForPayment} is called on the swap.
260
+ *
261
+ * @param recipient Smart chain signer's address on the destination chain, that will have to manually
262
+ * settle the swap.
263
+ * @param lnurl LNURL-withdraw link to pull the funds from
264
+ * @param amountData Amount, token and exact input/output data for to swap
265
+ * @param lps An array of intermediaries (LPs) to get the quotes from
266
+ * @param options Optional additional quote options
267
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
268
+ * @param abortSignal Abort signal
269
+ */
270
+ async createViaLNURL(recipient, lnurl, amountData, lps, options, additionalParams, abortSignal) {
271
+ if (!this.isInitialized)
272
+ throw new Error("Not initialized, call init() first!");
273
+ const _options = {
274
+ paymentHash: (0, Utils_1.parseHashValueExact32Bytes)(options?.paymentHash, "payment hash"),
275
+ description: options?.description,
276
+ descriptionHash: (0, Utils_1.parseHashValueExact32Bytes)(options?.descriptionHash, "description hash"),
277
+ unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck
278
+ };
279
+ const lpVersions = Intermediary_1.Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
280
+ const abortController = (0, Utils_1.extendAbortController)(abortSignal);
281
+ const preFetches = {
282
+ pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
283
+ usdPricePrefetchPromise: this.preFetchUsdPrice(abortController.signal),
284
+ feeRatePromise: this.preFetchFeeRate(recipient, amountData, undefined, abortController, lpVersions)
285
+ };
286
+ try {
287
+ const exactOutAmountPromise = !amountData.exactIn ? preFetches.pricePrefetchPromise.then(price => this._prices.getToBtcSwapAmount(this.chainIdentifier, amountData.amount, amountData.token, abortController.signal, price)).catch(e => {
288
+ abortController.abort(e);
289
+ return undefined;
290
+ }) : undefined;
291
+ const withdrawRequest = await this.getLNURLWithdraw(lnurl, abortController.signal);
292
+ const min = BigInt(withdrawRequest.minWithdrawable) / 1000n;
293
+ const max = BigInt(withdrawRequest.maxWithdrawable) / 1000n;
294
+ if (amountData.exactIn) {
295
+ if (amountData.amount < min)
296
+ throw new UserError_1.UserError("Amount less than LNURL-withdraw minimum");
297
+ if (amountData.amount > max)
298
+ throw new UserError_1.UserError("Amount more than LNURL-withdraw maximum");
299
+ }
300
+ else {
301
+ const amount = (await exactOutAmountPromise);
302
+ abortController.signal.throwIfAborted();
303
+ if ((amount * 95n / 100n) < min)
304
+ throw new UserError_1.UserError("Amount less than LNURL-withdraw minimum");
305
+ if ((amount * 105n / 100n) > max)
306
+ throw new UserError_1.UserError("Amount more than LNURL-withdraw maximum");
307
+ }
308
+ return this.create(recipient, amountData, lps, _options, additionalParams, abortSignal, preFetches).map(data => {
309
+ return {
310
+ quote: data.quote.then(quote => {
311
+ quote._setLNURLData(withdrawRequest.url, withdrawRequest.k1, withdrawRequest.callback);
312
+ const amountIn = quote.getInput().rawAmount;
313
+ if (amountIn < min)
314
+ throw new UserError_1.UserError("Amount less than LNURL-withdraw minimum");
315
+ if (amountIn > max)
316
+ throw new UserError_1.UserError("Amount more than LNURL-withdraw maximum");
317
+ return quote;
318
+ }),
319
+ intermediary: data.intermediary
320
+ };
321
+ });
322
+ }
323
+ catch (e) {
324
+ abortController.abort(e);
325
+ throw e;
326
+ }
327
+ }
328
+ /**
329
+ * @inheritDoc
330
+ * @internal
331
+ */
332
+ async _checkPastSwaps(pastSwaps) {
333
+ const changedSwapSet = new Set();
334
+ const swapExpiredStatus = {};
335
+ const checkStatusSwaps = {};
336
+ await Promise.all(pastSwaps.map(async (pastSwap) => {
337
+ if (pastSwap._shouldCheckIntermediary()) {
338
+ try {
339
+ const result = await pastSwap._checkIntermediaryPaymentReceived(false);
340
+ if (result != null) {
341
+ changedSwapSet.add(pastSwap);
342
+ }
343
+ }
344
+ catch (e) {
345
+ this.logger.error(`_checkPastSwaps(): Failed to contact LP regarding swap ${pastSwap.getId()}, error: `, e);
346
+ }
347
+ }
348
+ if (pastSwap._shouldFetchExpiryStatus()) {
349
+ //Check expiry
350
+ swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
351
+ }
352
+ if (pastSwap._shouldFetchOnchainState()) {
353
+ //Add to swaps for which status should be checked
354
+ if (pastSwap._data != null)
355
+ (checkStatusSwaps[pastSwap._contractVersion ?? "v1"] ??= []).push(pastSwap);
356
+ }
357
+ }));
358
+ for (let version in checkStatusSwaps) {
359
+ if (this._versionedContracts[version] == null) {
360
+ this.logger.warn(`_checkPastSwaps(): No contract was found for ${this.chainIdentifier} version ${version}! Skipping these swaps!`);
361
+ continue;
362
+ }
363
+ const _checkStatusSwap = checkStatusSwaps[version];
364
+ const swapStatuses = await this._contract(version).getCommitStatuses(_checkStatusSwap.map(val => ({ signer: val._getInitiator(), swapData: val._data })));
365
+ for (let pastSwap of _checkStatusSwap) {
366
+ const shouldSave = await pastSwap._sync(false, swapExpiredStatus[pastSwap.getId()], swapStatuses[pastSwap.getEscrowHash()], true);
367
+ if (shouldSave) {
368
+ changedSwapSet.add(pastSwap);
369
+ }
370
+ }
371
+ }
372
+ const changedSwaps = [];
373
+ const removeSwaps = [];
374
+ changedSwapSet.forEach(val => {
375
+ if (val.isQuoteExpired()) {
376
+ removeSwaps.push(val);
377
+ }
378
+ else {
379
+ changedSwaps.push(val);
380
+ }
381
+ });
382
+ return {
383
+ changedSwaps,
384
+ removeSwaps
385
+ };
386
+ }
387
+ /**
388
+ * @inheritDoc
389
+ * @internal
390
+ */
391
+ async recoverFromSwapDataAndState(init, state, contractVersion, lp) {
392
+ const data = init.data;
393
+ let paymentHash = data.getHTLCHashHint();
394
+ let secret;
395
+ if (state.type === base_1.SwapCommitStateType.PAID) {
396
+ secret = await state.getClaimResult();
397
+ paymentHash = buffer_1.Buffer.from((0, sha2_1.sha256)(buffer_1.Buffer.from(secret, "hex"))).toString("hex");
398
+ }
399
+ const swapInit = {
400
+ pricingInfo: {
401
+ isValid: true,
402
+ satsBaseFee: 0n,
403
+ swapPriceUSatPerToken: 100000000000000n,
404
+ realPriceUSatPerToken: 100000000000000n,
405
+ differencePPM: 0n,
406
+ feePPM: 0n,
407
+ },
408
+ url: lp?.url,
409
+ expiry: 0,
410
+ swapFee: 0n,
411
+ swapFeeBtc: 0n,
412
+ feeRate: "",
413
+ signatureData: undefined,
414
+ initialSwapData: data,
415
+ data,
416
+ pr: paymentHash ?? undefined,
417
+ secret,
418
+ exactIn: false,
419
+ contractVersion
420
+ };
421
+ const swap = new FromBTCLNSwap_1.FromBTCLNSwap(this, swapInit);
422
+ swap._commitTxId = await init.getInitTxId();
423
+ const blockData = await init.getTxBlock();
424
+ swap.createdAt = blockData.blockTime * 1000;
425
+ swap._setInitiated();
426
+ swap._state = FromBTCLNSwap_1.FromBTCLNSwapState.CLAIM_COMMITED;
427
+ await swap._sync(false, false, state);
428
+ await swap._save();
429
+ return swap;
430
+ }
431
+ }
432
+ exports.FromBTCLNWrapper = FromBTCLNWrapper;