@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,786 +1,786 @@
1
- import {decode as bolt11Decode, PaymentRequestObject, TagsObject} from "@atomiqlabs/bolt11";
2
- import {ToBTCLNSwap, ToBTCLNSwapInit} from "./ToBTCLNSwap";
3
- import {IToBTCDefinition, IToBTCWrapper} from "../IToBTCWrapper";
4
- import {UserError} from "../../../../errors/UserError";
5
- import {ChainSwapType, ChainType, SwapCommitState, SwapCommitStateType} from "@atomiqlabs/base";
6
- import {Intermediary} from "../../../../intermediaries/Intermediary";
7
- import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
8
- import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
9
- import {EventEmitter} from "events";
10
- import {IntermediaryError} from "../../../../errors/IntermediaryError";
11
- import {SwapType} from "../../../../enums/SwapType";
12
- import {extendAbortController, mapArrayToObject, throwIfUndefined} from "../../../../utils/Utils";
13
- import {IntermediaryAPI, ToBTCLNResponseType} from "../../../../intermediaries/apis/IntermediaryAPI";
14
- import {RequestError} from "../../../../errors/RequestError";
15
- import {LNURL, LNURLPaySuccessAction} from "../../../../lnurl/LNURL";
16
- import {IToBTCSwapInit, ToBTCSwapState} from "../IToBTCSwap";
17
- import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
18
- import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
19
- import {ISwap} from "../../../ISwap";
20
- import {sha256} from "@noble/hashes/sha2";
21
- import {AmountData} from "../../../../types/AmountData";
22
- import {LNURLPayParamsWithUrl} from "../../../../types/lnurl/LNURLPay";
23
- import {tryWithRetries} from "../../../../utils/RetryUtils";
24
- import {AllOptional} from "../../../../utils/TypeUtils";
25
- import {LightningInvoiceCreateService} from "../../../../types/wallets/LightningInvoiceCreateService";
26
-
27
- export type ToBTCLNOptions = {
28
- /**
29
- * HTLC expiration timeout in seconds to use when offering the HTLC to the LP. Larger expirations mean that more
30
- * lightning network payment paths can be considered (every hop in the lightning network payment adds additional
31
- * timeout requirement). On the other side, larger expiration also means that user's funds are locked for longer
32
- * in case of a non-cooperative LP.
33
- *
34
- * Uses 5 days as default.
35
- */
36
- expirySeconds?: number,
37
- /**
38
- * Maximum fee for routing the swap output payment through the lightning network. Higher fee percentages means that
39
- * more payment routes can be considered (every hop in the lightning network payment adds additional fee
40
- * requirements).
41
- *
42
- * The fee is express as percentage of the swap value, uses `0.2` by default which means the maximum
43
- * routing fee is capped at 0.2% of the swap value.
44
- *
45
- * The full fee also contains the base component (set by `maxRoutingBaseFee` option), the resulting maximum routing
46
- * fee rate is:
47
- *
48
- * `maxRoutingFee` = `maxRoutingBaseFee` sats + `value` * `maxRoutingFeePercentage`%
49
- */
50
- maxRoutingFeePercentage?: number,
51
- /**
52
- *
53
- * Maximum base fee (in sats) for routing the swap output payment through the lightning network. Higher fee
54
- * percentages means that more payment routes can be considered (every hop in the lightning network payment adds additional fee
55
- * requirements).
56
- *
57
- * Uses 10 sats as a default.
58
- *
59
- * The full fee also contains the value percentage component (set by `maxRoutingFeePercentage` option), the
60
- * resulting maximum routing fee rate is:
61
- *
62
- * `maxRoutingFee` = `maxRoutingBaseFee` sats + (`value` * `maxRoutingFeePercentage`%)
63
- */
64
- maxRoutingBaseFee?: bigint,
65
-
66
- /**
67
- * @deprecated Use `maxRoutingFeePercentage` and express the routing fee in percentage instead!
68
- */
69
- maxRoutingPPM?: bigint,
70
- /**
71
- * @deprecated Adjust fee with `maxRoutingFeePercentage` & `maxRoutingBaseFee` params!
72
- */
73
- maxFee?: bigint | Promise<bigint>,
74
- /**
75
- * @deprecated Pass desired HTLC expiration timeout as `expirySeconds`
76
- */
77
- expiryTimestamp?: bigint
78
- }
79
-
80
- export type ToBTCLNWrapperOptions = ISwapWrapperOptions & {
81
- lightningBaseFee: number,
82
- lightningFeePPM: number,
83
- paymentTimeoutSeconds: number
84
- };
85
-
86
- export type ToBTCLNDefinition<T extends ChainType> = IToBTCDefinition<T, ToBTCLNWrapper<T>, ToBTCLNSwap<T>>;
87
-
88
- /**
89
- * Escrow based (HTLC) swap for Smart chains -> Bitcoin lightning
90
- *
91
- * @category Swaps/Smart chain → Lightning
92
- */
93
- export class ToBTCLNWrapper<T extends ChainType> extends IToBTCWrapper<T, ToBTCLNDefinition<T>, ToBTCLNWrapperOptions> {
94
- public readonly TYPE: SwapType.TO_BTCLN = SwapType.TO_BTCLN;
95
- /**
96
- * @internal
97
- */
98
- readonly _swapDeserializer = ToBTCLNSwap;
99
-
100
- constructor(
101
- chainIdentifier: string,
102
- unifiedStorage: UnifiedSwapStorage<T>,
103
- unifiedChainEvents: UnifiedSwapEventListener<T>,
104
- chain: T["ChainInterface"],
105
- prices: ISwapPrice,
106
- tokens: WrapperCtorTokens,
107
- versionedContracts: {
108
- [version: string]: {
109
- swapContract: T["Contract"],
110
- swapDataConstructor: new (data: any) => T["Data"]
111
- }
112
- },
113
- options?: AllOptional<ToBTCLNWrapperOptions>,
114
- events?: EventEmitter<{swapState: [ISwap]}>
115
- ) {
116
- super(
117
- chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens,
118
- {
119
- ...options,
120
- paymentTimeoutSeconds: options?.paymentTimeoutSeconds ?? 5*24*60*60,
121
- lightningBaseFee: options?.lightningBaseFee ?? 10,
122
- lightningFeePPM: options?.lightningFeePPM ?? 2000
123
- },
124
- versionedContracts,
125
- events
126
- );
127
- }
128
-
129
- private toRequiredSwapOptions(amountData: AmountData, options?: ToBTCLNOptions, pricePreFetchPromise?: Promise<bigint | undefined>, abortSignal?: AbortSignal) {
130
- const expirySeconds = options?.expirySeconds ?? this._options.paymentTimeoutSeconds;
131
- const maxRoutingBaseFee = options?.maxRoutingBaseFee ?? BigInt(this._options.lightningBaseFee);
132
- const maxRoutingPPM = options?.maxRoutingFeePercentage!=null
133
- ? BigInt(Math.floor(options.maxRoutingFeePercentage * 10_000))
134
- : options?.maxRoutingPPM ?? BigInt(this._options.lightningFeePPM);
135
-
136
- let maxFee: bigint | Promise<bigint>;
137
- if(options?.maxFee!=null) {
138
- maxFee = options.maxFee;
139
- } else if(amountData.exactIn) {
140
- if(pricePreFetchPromise!=null) {
141
- maxFee = pricePreFetchPromise
142
- .then(val => this._prices.getFromBtcSwapAmount(this.chainIdentifier, maxRoutingBaseFee, amountData.token, abortSignal, val))
143
- .then(_maxBaseFee => this.calculateFeeForAmount(amountData.amount, _maxBaseFee, maxRoutingPPM))
144
- } else {
145
- maxFee = this._prices.getFromBtcSwapAmount(this.chainIdentifier, maxRoutingBaseFee, amountData.token, abortSignal)
146
- .then(_maxBaseFee => this.calculateFeeForAmount(amountData.amount, _maxBaseFee, maxRoutingPPM))
147
- }
148
- } else {
149
- maxFee = this.calculateFeeForAmount(amountData.amount, maxRoutingBaseFee, maxRoutingPPM)
150
- }
151
-
152
- return {
153
- expiryTimestamp: options?.expiryTimestamp ?? BigInt(Math.floor(Date.now()/1000)+expirySeconds),
154
- maxFee
155
- }
156
- }
157
-
158
- /**
159
- * Verifies whether a given payment hash was already paid by checking the local
160
- * storage of known swaps
161
- *
162
- * @param paymentHash Payment hash to check
163
- *
164
- * @private
165
- */
166
- private async checkPaymentHashWasPaid(paymentHash: string) {
167
- const swaps = await this.unifiedStorage.query(
168
- [[{key: "type", value: this.TYPE}, {key: "paymentHash", value: paymentHash}]],
169
- (obj: any) => new this._swapDeserializer(this, obj)
170
- );
171
-
172
- for(let value of swaps) {
173
- if(value._state===ToBTCSwapState.CLAIMED || value._state===ToBTCSwapState.SOFT_CLAIMED)
174
- throw new UserError("Lightning invoice was already paid!");
175
- }
176
- }
177
-
178
- /**
179
- * Calculates maximum lightning network routing fee based on amount
180
- *
181
- * @param amount BTC amount of the swap in satoshis
182
- * @param overrideBaseFee Override wrapper's default base fee
183
- * @param overrideFeePPM Override wrapper's default PPM
184
- *
185
- * @returns Maximum lightning routing fee in sats
186
- *
187
- * @private
188
- */
189
- private calculateFeeForAmount(amount: bigint, overrideBaseFee?: bigint, overrideFeePPM?: bigint) : bigint {
190
- return BigInt(overrideBaseFee ?? this._options.lightningBaseFee)
191
- + (amount * BigInt(overrideFeePPM ?? this._options.lightningFeePPM) / 1000000n);
192
- }
193
-
194
- /**
195
- * Verifies returned LP data
196
- *
197
- * @param signer
198
- * @param resp Response as returned by the LP
199
- * @param parsedPr Parsed bolt11 lightning invoice
200
- * @param token Smart chain token to be used in the swap
201
- * @param lp
202
- * @param calculatedOptions Swap options computed from the swap create options
203
- * @param data Parsed swap data returned by the LP
204
- * @param requiredTotal Required total to be paid on the input (for exactIn swaps)
205
- *
206
- * @throws {IntermediaryError} In case the response is not valid
207
- *
208
- * @private
209
- */
210
- private async verifyReturnedData(
211
- signer: string,
212
- resp: ToBTCLNResponseType,
213
- parsedPr: PaymentRequestObject & {tagsObject: TagsObject},
214
- token: string,
215
- lp: Intermediary,
216
- calculatedOptions: {
217
- maxFee: bigint | Promise<bigint>,
218
- expiryTimestamp: bigint
219
- },
220
- data: T["Data"],
221
- requiredTotal?: bigint
222
- ): Promise<void> {
223
- if(resp.routingFeeSats > await calculatedOptions.maxFee) throw new IntermediaryError("Invalid max fee sats returned");
224
-
225
- if(requiredTotal!=null && resp.total !== requiredTotal)
226
- throw new IntermediaryError("Invalid data returned - total amount");
227
-
228
- if(parsedPr.tagsObject.payment_hash==null) throw new Error("Swap invoice doesn't contain payment hash field!");
229
- const claimHash = this._contract(lp.getContractVersion(this.chainIdentifier)).getHashForHtlc(Buffer.from(parsedPr.tagsObject.payment_hash, "hex"));
230
-
231
- if(
232
- data.getAmount() !== resp.total ||
233
- !Buffer.from(data.getClaimHash(), "hex").equals(claimHash) ||
234
- data.getExpiry() !== calculatedOptions.expiryTimestamp ||
235
- data.getType()!==ChainSwapType.HTLC ||
236
- !data.isPayIn() ||
237
- !data.isToken(token) ||
238
- !data.isClaimer(lp.getAddress(this.chainIdentifier)) ||
239
- !data.isOfferer(signer) ||
240
- data.getTotalDeposit() !== 0n
241
- ) {
242
- throw new IntermediaryError("Invalid data returned");
243
- }
244
- }
245
-
246
- /**
247
- * Returns the quote/swap from a given intermediary
248
- *
249
- * @param signer Smartchain signer initiating the swap
250
- * @param amountData
251
- * @param lp Intermediary
252
- * @param pr bolt11 lightning network invoice
253
- * @param parsedPr Parsed bolt11 lightning network invoice
254
- * @param calculatedOptions Swap options computed from the swap create options
255
- * @param preFetches
256
- * @param abort Abort signal or controller, if AbortController is passed it is used as-is, when AbortSignal is passed
257
- * it is extended with extendAbortController and then used
258
- * @param additionalParams Additional params that should be sent to the LP
259
- *
260
- * @private
261
- */
262
- private async getIntermediaryQuote(
263
- signer: string,
264
- amountData: Omit<AmountData, "amount">,
265
- lp: Intermediary,
266
- pr: string,
267
- parsedPr: PaymentRequestObject & {tagsObject: TagsObject},
268
- calculatedOptions: {
269
- maxFee: bigint | Promise<bigint>,
270
- expiryTimestamp: bigint
271
- },
272
- preFetches: {
273
- feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
274
- pricePreFetchPromise: Promise<bigint | undefined>,
275
- usdPricePrefetchPromise: Promise<number | undefined>,
276
- signDataPrefetchPromise?: {[contractVersion: string]: Promise<T["PreFetchVerification"] | undefined> | undefined}
277
- },
278
- abort: AbortSignal | AbortController,
279
- additionalParams?: Record<string, any>,
280
- ) {
281
- if(lp.services[SwapType.TO_BTCLN]==null) throw new Error("LP service for processing to btcln swaps not found!");
282
- const version = lp.getContractVersion(this.chainIdentifier);
283
-
284
- const abortController = abort instanceof AbortController ? abort : extendAbortController(abort);
285
- const reputationPromise = this.preFetchIntermediaryReputation(amountData, lp, abortController, version);
286
-
287
- try {
288
- const {signDataPromise, resp} = await tryWithRetries(async(retryCount: number) => {
289
- const {signDataPrefetch, response} = IntermediaryAPI.initToBTCLN(this.chainIdentifier, lp.url, {
290
- offerer: signer,
291
- pr,
292
- maxFee: await calculatedOptions.maxFee,
293
- expiryTimestamp: calculatedOptions.expiryTimestamp,
294
- token: amountData.token,
295
- feeRate: throwIfUndefined(preFetches.feeRatePromise[version]),
296
- additionalParams
297
- }, this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined);
298
-
299
- let signDataPromise = preFetches.signDataPrefetchPromise?.[version];
300
- if(signDataPromise==null) {
301
- signDataPromise = this.preFetchSignData(signDataPrefetch, version);
302
- } else signDataPrefetch.catch(() => {});
303
-
304
- return {
305
- signDataPromise,
306
- resp: await response
307
- };
308
- }, undefined, e => e instanceof RequestError, abortController.signal);
309
-
310
- if(parsedPr.millisatoshis==null) throw new Error("Swap invoice doesn't have msat amount field!");
311
- const amountOut: bigint = (BigInt(parsedPr.millisatoshis) + 999n) / 1000n;
312
- const totalFee: bigint = resp.swapFee + resp.maxFee;
313
- const data: T["Data"] = new (this._swapDataDeserializer(version))(resp.data);
314
- data.setOfferer(signer);
315
-
316
- await this.verifyReturnedData(signer, resp, parsedPr, amountData.token, lp, calculatedOptions, data);
317
-
318
- const swapFeeBtc = resp.swapFee * amountOut / (data.getAmount() - totalFee);
319
-
320
- const [pricingInfo, signatureExpiry, reputation] = await Promise.all([
321
- this.verifyReturnedPrice(
322
- lp.services[SwapType.TO_BTCLN], true, amountOut, data.getAmount(),
323
- amountData.token, {networkFee: resp.maxFee, swapFeeBtc},
324
- preFetches.pricePreFetchPromise, preFetches.usdPricePrefetchPromise, abortController.signal
325
- ),
326
- this.verifyReturnedSignature(
327
- signer, data, resp, preFetches.feeRatePromise[version], signDataPromise, version, abortController.signal
328
- ),
329
- reputationPromise
330
- ]);
331
- abortController.signal.throwIfAborted();
332
-
333
- if(reputation!=null) lp.reputation[amountData.token.toString()] = reputation;
334
-
335
- const quote = new ToBTCLNSwap<T>(this, {
336
- pricingInfo,
337
- url: lp.url,
338
- expiry: signatureExpiry,
339
- swapFee: resp.swapFee,
340
- swapFeeBtc,
341
- feeRate: (await preFetches.feeRatePromise[version])!,
342
- signatureData: resp,
343
- data,
344
- networkFee: resp.maxFee,
345
- networkFeeBtc: resp.routingFeeSats,
346
- confidence: resp.confidence,
347
- pr,
348
- exactIn: false,
349
- contractVersion: version
350
- } as IToBTCSwapInit<T["Data"]>);
351
- return quote;
352
- } catch (e) {
353
- abortController.abort(e);
354
- throw e;
355
- }
356
- }
357
-
358
- /**
359
- * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol,
360
- * the amount is parsed from the provided lightning network payment request (bolt11 invoice)
361
- *
362
- * @param signer Source chain signer address initiating the swap
363
- * @param recipient BOLT11 payment request (bitcoin lightning invoice) you wish to pay
364
- * @param amountData Token to swap
365
- * @param lps An array of intermediaries (LPs) to get the quotes from
366
- * @param options Optional additional quote options
367
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
368
- * @param abortSignal Abort signal
369
- * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
370
- */
371
- async create(
372
- signer: string,
373
- recipient: string,
374
- amountData: Omit<AmountData, "amount"> & {exactIn: false},
375
- lps: Intermediary[],
376
- options?: ToBTCLNOptions,
377
- additionalParams?: Record<string, any>,
378
- abortSignal?: AbortSignal,
379
- preFetches?: {
380
- feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
381
- pricePreFetchPromise: Promise<bigint | undefined>,
382
- usdPricePrefetchPromise: Promise<number | undefined>,
383
- signDataPrefetchPromise?: {[contractVersion: string]: Promise<T["PreFetchVerification"] | undefined> | undefined}
384
- }
385
- ): Promise<{
386
- quote: Promise<ToBTCLNSwap<T>>,
387
- intermediary: Intermediary
388
- }[]> {
389
- const parsedPr = bolt11Decode(recipient);
390
- if(parsedPr.millisatoshis==null) throw new UserError("Must be an invoice with amount");
391
- const amountOut: bigint = (BigInt(parsedPr.millisatoshis) + 999n) / 1000n;
392
-
393
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
394
-
395
- const _options = this.toRequiredSwapOptions({...amountData, amount: amountOut}, options);
396
-
397
- if(parsedPr.tagsObject.payment_hash==null) throw new Error("Provided lightning invoice doesn't contain payment hash field!");
398
- await this.checkPaymentHashWasPaid(parsedPr.tagsObject.payment_hash);
399
-
400
- const _hash = mapArrayToObject(lpVersions, (contractVersion: string) => {
401
- return this._contract(contractVersion).getHashForHtlc(Buffer.from(parsedPr.tagsObject.payment_hash!, "hex")).toString("hex");
402
- });
403
-
404
- const _abortController = extendAbortController(abortSignal);
405
- const _preFetches = preFetches ?? {
406
- pricePreFetchPromise: this.preFetchPrice(amountData, _abortController.signal),
407
- feeRatePromise: this.preFetchFeeRate(signer, amountData, _hash, _abortController, lpVersions),
408
- usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
409
- signDataPrefetchPromise: mapArrayToObject(lpVersions, (contractVersion: string) => {
410
- return this._contract(contractVersion).preFetchBlockDataForSignatures==null ?
411
- this.preFetchSignData(Promise.resolve(true), contractVersion) :
412
- undefined;
413
- })
414
- };
415
-
416
- return lps.map(lp => {
417
- return {
418
- intermediary: lp,
419
- quote: this.getIntermediaryQuote(signer, amountData, lp, recipient, parsedPr, _options, _preFetches, _abortController.signal, additionalParams)
420
- }
421
- });
422
- }
423
-
424
- /**
425
- * Parses and fetches lnurl pay params from the specified lnurl
426
- *
427
- * @param lnurl LNURL to be parsed and fetched
428
- * @param abortSignal Abort signal
429
- * @throws {UserError} if the LNURL is invalid or if it's not a LNURL-pay
430
- *
431
- * @private
432
- */
433
- private async getLNURLPay(lnurl: string | LNURLPayParamsWithUrl, abortSignal: AbortSignal): Promise<LNURLPayParamsWithUrl> {
434
- if(typeof(lnurl)!=="string") return lnurl;
435
-
436
- const res = await LNURL.getLNURL(lnurl, true, this._options.getRequestTimeout, abortSignal);
437
- if(res==null) throw new UserError("Invalid LNURL");
438
- if(res.tag!=="payRequest") throw new UserError("Not a LNURL-pay");
439
- return res;
440
- }
441
-
442
- /**
443
- * Returns the quote/swap from the given LP
444
- *
445
- * @param signer Source chain signer address initiating the swap
446
- * @param amountData Token to swap
447
- * @param invoiceCreateService Service for creating fixed amount invoices
448
- * @param lp Intermediary (LPs) to get the quote from
449
- * @param dummyPr Dummy minimum value bolt11 lightning invoice returned from the LNURL-pay, used to estimate
450
- * network fees for an actual invoice
451
- * @param calculatedOptions Swap options computed from the swap create options
452
- * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
453
- * @param abortSignal Abort signal
454
- * @param additionalParams Additional params to be sent to the intermediary
455
- *
456
- * @private
457
- */
458
- private async getIntermediaryQuoteExactIn(
459
- signer: string,
460
- amountData: AmountData,
461
- invoiceCreateService: LightningInvoiceCreateService,
462
- lp: Intermediary,
463
- dummyPr: string,
464
- calculatedOptions: {
465
- maxFee: bigint | Promise<bigint>,
466
- expiryTimestamp: bigint
467
- },
468
- preFetches: {
469
- feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
470
- pricePreFetchPromise: Promise<bigint | undefined>,
471
- usdPricePrefetchPromise: Promise<number | undefined>
472
- },
473
- abortSignal: AbortSignal,
474
- additionalParams?: Record<string, any>,
475
- ) {
476
- if(lp.services[SwapType.TO_BTCLN]==null) throw new Error("LP service for processing to btcln swaps not found!");
477
- const version = lp.getContractVersion(this.chainIdentifier);
478
-
479
- const abortController = extendAbortController(abortSignal);
480
- const reputationPromise = this.preFetchIntermediaryReputation(amountData, lp, abortController, version);
481
-
482
- try {
483
- const {signDataPromise, prepareResp} = await tryWithRetries(async(retryCount: number) => {
484
- const {signDataPrefetch, response} = IntermediaryAPI.prepareToBTCLNExactIn(this.chainIdentifier, lp.url, {
485
- token: amountData.token,
486
- offerer: signer,
487
- pr: dummyPr,
488
- amount: amountData.amount,
489
- maxFee: await calculatedOptions.maxFee,
490
- expiryTimestamp: calculatedOptions.expiryTimestamp,
491
- additionalParams
492
- }, this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined);
493
-
494
- return {
495
- signDataPromise: this.preFetchSignData(signDataPrefetch, version),
496
- prepareResp: await response
497
- };
498
- }, undefined, e => e instanceof RequestError, abortController.signal);
499
-
500
- if(prepareResp.amount <= 0n)
501
- throw new IntermediaryError("Invalid amount returned (zero or negative)");
502
-
503
- if(invoiceCreateService.minMsats!=null) {
504
- if(prepareResp.amount < invoiceCreateService.minMsats / 1000n) throw new UserError("Amount less than minimum");
505
- }
506
- if(invoiceCreateService.maxMSats!=null) {
507
- if(prepareResp.amount > invoiceCreateService.maxMSats / 1000n) throw new UserError("Amount more than maximum");
508
- }
509
-
510
- const invoice = await invoiceCreateService.getInvoice(Number(prepareResp.amount), abortController.signal);
511
- const parsedInvoice = bolt11Decode(invoice);
512
-
513
- const resp = await tryWithRetries(
514
- (retryCount: number) => IntermediaryAPI.initToBTCLNExactIn(lp.url, {
515
- pr: invoice,
516
- reqId: prepareResp.reqId,
517
- feeRate: throwIfUndefined(preFetches.feeRatePromise[version]),
518
- additionalParams
519
- }, this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined),
520
- undefined, RequestError, abortController.signal
521
- );
522
-
523
- if(parsedInvoice.millisatoshis==null) throw new Error("Swap invoice doesn't have msat amount field!");
524
- const amountOut: bigint = (BigInt(parsedInvoice.millisatoshis) + 999n) / 1000n;
525
- const totalFee: bigint = resp.swapFee + resp.maxFee;
526
- const data: T["Data"] = new (this._swapDataDeserializer(version))(resp.data);
527
- data.setOfferer(signer);
528
-
529
- await this.verifyReturnedData(signer, resp, parsedInvoice, amountData.token, lp, calculatedOptions, data, amountData.amount);
530
-
531
- const swapFeeBtc = resp.swapFee * amountOut / (data.getAmount() - totalFee);
532
-
533
- const [pricingInfo, signatureExpiry, reputation] = await Promise.all([
534
- this.verifyReturnedPrice(
535
- lp.services[SwapType.TO_BTCLN], true, prepareResp.amount, data.getAmount(),
536
- amountData.token, {networkFee: resp.maxFee, swapFeeBtc},
537
- preFetches.pricePreFetchPromise, preFetches.usdPricePrefetchPromise, abortSignal
538
- ),
539
- this.verifyReturnedSignature(
540
- signer, data, resp, preFetches.feeRatePromise[version], signDataPromise, version, abortController.signal
541
- ),
542
- reputationPromise
543
- ]);
544
- abortController.signal.throwIfAborted();
545
-
546
- if(reputation!=null) lp.reputation[amountData.token.toString()] = reputation;
547
-
548
- const quote = new ToBTCLNSwap<T>(this, {
549
- pricingInfo,
550
- url: lp.url,
551
- expiry: signatureExpiry,
552
- swapFee: resp.swapFee,
553
- swapFeeBtc,
554
- feeRate: (await preFetches.feeRatePromise[version])!,
555
- signatureData: resp,
556
- data,
557
- networkFee: resp.maxFee,
558
- networkFeeBtc: resp.routingFeeSats,
559
- confidence: resp.confidence,
560
- pr: invoice,
561
- exactIn: true,
562
- contractVersion: version
563
- } as IToBTCSwapInit<T["Data"]>);
564
- return quote;
565
- } catch (e) {
566
- abortController.abort(e);
567
- throw e;
568
- }
569
- }
570
-
571
- /**
572
- * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol via
573
- * invoice creation service. This allows exactIn swaps by requesting the desired fixed amount lightning
574
- * network invoice from the service.
575
- *
576
- * @param signer Source chain signer address initiating the swap
577
- * @param invoiceCreateServicePromise Service to request destination lightning network invoices from
578
- * @param amountData Amount, token and exact input/output data for to swap
579
- * @param lps An array of intermediaries (LPs) to get the quotes from
580
- * @param options Optional additional quote options
581
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
582
- * @param abortSignal Abort signal
583
- */
584
- async createViaInvoiceCreateService(
585
- signer: string,
586
- invoiceCreateServicePromise: Promise<LightningInvoiceCreateService>,
587
- amountData: AmountData,
588
- lps: Intermediary[],
589
- options?: ToBTCLNOptions,
590
- additionalParams?: Record<string, any>,
591
- abortSignal?: AbortSignal
592
- ): Promise<{
593
- quote: Promise<ToBTCLNSwap<T>>,
594
- intermediary: Intermediary
595
- }[]> {
596
- if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
597
-
598
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
599
-
600
- const _abortController = extendAbortController(abortSignal);
601
- const pricePreFetchPromise: Promise<bigint | undefined> = this.preFetchPrice(amountData, _abortController.signal);
602
- const usdPricePrefetchPromise: Promise<number | undefined> = this.preFetchUsdPrice(_abortController.signal);
603
- const feeRatePromise = this.preFetchFeeRate(signer, amountData, undefined, _abortController, lpVersions);
604
- const signDataPrefetchPromise = mapArrayToObject(lpVersions, (contractVersion: string) => {
605
- return this._contract(contractVersion).preFetchBlockDataForSignatures==null ?
606
- this.preFetchSignData(Promise.resolve(true), contractVersion) :
607
- undefined;
608
- });
609
-
610
- const _options = this.toRequiredSwapOptions(amountData, options, pricePreFetchPromise, _abortController.signal);
611
-
612
- try {
613
- const invoiceCreateService = await invoiceCreateServicePromise;
614
-
615
- if(amountData.exactIn) {
616
- const dummyInvoice = await invoiceCreateService.getInvoice(
617
- invoiceCreateService.minMsats==null ? 1 : Number(invoiceCreateService.minMsats/1000n),
618
- _abortController.signal
619
- );
620
-
621
- return lps.map(lp => {
622
- return {
623
- quote: this.getIntermediaryQuoteExactIn(signer, amountData, invoiceCreateService, lp, dummyInvoice, _options, {
624
- pricePreFetchPromise,
625
- usdPricePrefetchPromise,
626
- feeRatePromise
627
- }, _abortController.signal, additionalParams),
628
- intermediary: lp
629
- }
630
- })
631
- } else {
632
- if(invoiceCreateService.minMsats!=null) {
633
- if(amountData.amount < invoiceCreateService.minMsats / 1000n) throw new UserError("Amount less than minimum");
634
- }
635
- if(invoiceCreateService.maxMSats!=null) {
636
- if(amountData.amount > invoiceCreateService.maxMSats / 1000n) throw new UserError("Amount more than maximum");
637
- }
638
-
639
- const invoice = await invoiceCreateService.getInvoice(Number(amountData.amount), _abortController.signal);
640
-
641
- return (await this.create(signer, invoice, {...amountData, exactIn: false}, lps, options, additionalParams, _abortController.signal, {
642
- feeRatePromise,
643
- pricePreFetchPromise,
644
- usdPricePrefetchPromise,
645
- signDataPrefetchPromise
646
- }));
647
- }
648
- } catch (e) {
649
- _abortController.abort(e);
650
- throw e;
651
- }
652
- }
653
-
654
- /**
655
- * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol. Pays to
656
- * an LNURL-pay link. This allows exactIn swaps by requesting the desired fixed amount lightning
657
- * network invoice from the LNURL service.
658
- *
659
- * @param signer Source chain signer address initiating the swap
660
- * @param lnurl LNURL-pay link of the recipient
661
- * @param amountData Amount, token and exact input/output data for to swap
662
- * @param lps An array of intermediaries (LPs) to get the quotes from
663
- * @param options Optional additional quote options
664
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
665
- * @param abortSignal Abort signal
666
- */
667
- async createViaLNURL(
668
- signer: string,
669
- lnurl: string | LNURLPayParamsWithUrl,
670
- amountData: AmountData,
671
- lps: Intermediary[],
672
- options?: ToBTCLNOptions & {comment?: string},
673
- additionalParams?: Record<string, any>,
674
- abortSignal?: AbortSignal
675
- ): Promise<{
676
- quote: Promise<ToBTCLNSwap<T>>,
677
- intermediary: Intermediary
678
- }[]> {
679
- let successActions: {[pr: string]: LNURLPaySuccessAction} = {};
680
-
681
- const _abortController = extendAbortController(abortSignal);
682
- const invoiceCreateService = (async() => {
683
- let payRequest: LNURLPayParamsWithUrl = await this.getLNURLPay(lnurl, _abortController.signal);
684
-
685
- if(
686
- options?.comment!=null &&
687
- (payRequest.commentAllowed==null || options.comment.length>payRequest.commentAllowed)
688
- ) throw new UserError("Comment not allowed or too long");
689
-
690
- return {
691
- getInvoice: async (amountSats: number, abortSignal?: AbortSignal) => {
692
- const {invoice, successAction} = await LNURL.useLNURLPay(
693
- payRequest, BigInt(amountSats), options?.comment,
694
- this._options.getRequestTimeout, abortSignal
695
- );
696
- if(successAction!=null) successActions[invoice] = successAction;
697
- return invoice;
698
- },
699
- minMsats: BigInt(payRequest.minSendable),
700
- maxMsats: BigInt(payRequest.maxSendable),
701
- url: payRequest.url
702
- }
703
- })();
704
-
705
- const quotes = await this.createViaInvoiceCreateService(
706
- signer,
707
- invoiceCreateService,
708
- amountData,
709
- lps,
710
- options,
711
- additionalParams,
712
- _abortController.signal
713
- );
714
- _abortController.signal.throwIfAborted();
715
-
716
- const resolved = await invoiceCreateService;
717
- _abortController.signal.throwIfAborted();
718
-
719
- return quotes.map(value => ({
720
- quote: value.quote.then(quote => {
721
- let _successAction: LNURLPaySuccessAction | undefined;
722
- const quoteAddress = quote.getOutputAddress();
723
- if(quoteAddress!=null) {
724
- const successAction = successActions[quoteAddress];
725
- if(successAction!=null) _successAction = successAction;
726
- }
727
- quote._setLNURLData(resolved.url, _successAction);
728
- return quote;
729
- }),
730
- intermediary: value.intermediary
731
- }));
732
- }
733
-
734
- /**
735
- * @inheritDoc
736
- */
737
- async recoverFromSwapDataAndState(
738
- init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
739
- state: SwapCommitState,
740
- contractVersion: string,
741
- lp?: Intermediary
742
- ): Promise<ToBTCLNSwap<T> | null> {
743
- const data = init.data;
744
-
745
- let paymentHash = data.getHTLCHashHint();
746
- let secret: string | undefined;
747
- if(state.type===SwapCommitStateType.PAID) {
748
- secret = await state.getClaimResult();
749
- paymentHash = Buffer.from(sha256(Buffer.from(secret, "hex"))).toString("hex");
750
- }
751
-
752
- const swapInit: ToBTCLNSwapInit<T["Data"]> = {
753
- pricingInfo: {
754
- isValid: true,
755
- satsBaseFee: 0n,
756
- swapPriceUSatPerToken: 100_000_000_000_000n,
757
- realPriceUSatPerToken: 100_000_000_000_000n,
758
- differencePPM: 0n,
759
- feePPM: 0n,
760
- },
761
- url: lp?.url,
762
- expiry: 0,
763
- swapFee: 0n,
764
- swapFeeBtc: 0n,
765
- feeRate: "",
766
- signatureData: undefined,
767
- data,
768
- networkFee: 0n,
769
- networkFeeBtc: 0n,
770
- confidence: 0,
771
- pr: paymentHash ?? undefined,
772
- exactIn: false,
773
- contractVersion
774
- };
775
- const swap = new ToBTCLNSwap(this, swapInit);
776
- swap._commitTxId = await init.getInitTxId();
777
- const blockData = await init.getTxBlock();
778
- swap.createdAt = blockData.blockTime * 1000;
779
- swap._setInitiated();
780
- swap._state = ToBTCSwapState.COMMITED;
781
- await swap._sync(false, false, state);
782
- await swap._save();
783
- return swap;
784
- }
785
-
786
- }
1
+ import {decode as bolt11Decode, PaymentRequestObject, TagsObject} from "@atomiqlabs/bolt11";
2
+ import {ToBTCLNSwap, ToBTCLNSwapInit} from "./ToBTCLNSwap";
3
+ import {IToBTCDefinition, IToBTCWrapper} from "../IToBTCWrapper";
4
+ import {UserError} from "../../../../errors/UserError";
5
+ import {ChainSwapType, ChainType, SwapCommitState, SwapCommitStateType} from "@atomiqlabs/base";
6
+ import {Intermediary} from "../../../../intermediaries/Intermediary";
7
+ import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
8
+ import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
9
+ import {EventEmitter} from "events";
10
+ import {IntermediaryError} from "../../../../errors/IntermediaryError";
11
+ import {SwapType} from "../../../../enums/SwapType";
12
+ import {extendAbortController, mapArrayToObject, throwIfUndefined} from "../../../../utils/Utils";
13
+ import {IntermediaryAPI, ToBTCLNResponseType} from "../../../../intermediaries/apis/IntermediaryAPI";
14
+ import {RequestError} from "../../../../errors/RequestError";
15
+ import {LNURL, LNURLPaySuccessAction} from "../../../../lnurl/LNURL";
16
+ import {IToBTCSwapInit, ToBTCSwapState} from "../IToBTCSwap";
17
+ import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
18
+ import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
19
+ import {ISwap} from "../../../ISwap";
20
+ import {sha256} from "@noble/hashes/sha2";
21
+ import {AmountData} from "../../../../types/AmountData";
22
+ import {LNURLPayParamsWithUrl} from "../../../../types/lnurl/LNURLPay";
23
+ import {tryWithRetries} from "../../../../utils/RetryUtils";
24
+ import {AllOptional} from "../../../../utils/TypeUtils";
25
+ import {LightningInvoiceCreateService} from "../../../../types/wallets/LightningInvoiceCreateService";
26
+
27
+ export type ToBTCLNOptions = {
28
+ /**
29
+ * HTLC expiration timeout in seconds to use when offering the HTLC to the LP. Larger expirations mean that more
30
+ * lightning network payment paths can be considered (every hop in the lightning network payment adds additional
31
+ * timeout requirement). On the other side, larger expiration also means that user's funds are locked for longer
32
+ * in case of a non-cooperative LP.
33
+ *
34
+ * Uses 5 days as default.
35
+ */
36
+ expirySeconds?: number,
37
+ /**
38
+ * Maximum fee for routing the swap output payment through the lightning network. Higher fee percentages means that
39
+ * more payment routes can be considered (every hop in the lightning network payment adds additional fee
40
+ * requirements).
41
+ *
42
+ * The fee is express as percentage of the swap value, uses `0.2` by default which means the maximum
43
+ * routing fee is capped at 0.2% of the swap value.
44
+ *
45
+ * The full fee also contains the base component (set by `maxRoutingBaseFee` option), the resulting maximum routing
46
+ * fee rate is:
47
+ *
48
+ * `maxRoutingFee` = `maxRoutingBaseFee` sats + `value` * `maxRoutingFeePercentage`%
49
+ */
50
+ maxRoutingFeePercentage?: number,
51
+ /**
52
+ *
53
+ * Maximum base fee (in sats) for routing the swap output payment through the lightning network. Higher fee
54
+ * percentages means that more payment routes can be considered (every hop in the lightning network payment adds additional fee
55
+ * requirements).
56
+ *
57
+ * Uses 10 sats as a default.
58
+ *
59
+ * The full fee also contains the value percentage component (set by `maxRoutingFeePercentage` option), the
60
+ * resulting maximum routing fee rate is:
61
+ *
62
+ * `maxRoutingFee` = `maxRoutingBaseFee` sats + (`value` * `maxRoutingFeePercentage`%)
63
+ */
64
+ maxRoutingBaseFee?: bigint,
65
+
66
+ /**
67
+ * @deprecated Use `maxRoutingFeePercentage` and express the routing fee in percentage instead!
68
+ */
69
+ maxRoutingPPM?: bigint,
70
+ /**
71
+ * @deprecated Adjust fee with `maxRoutingFeePercentage` & `maxRoutingBaseFee` params!
72
+ */
73
+ maxFee?: bigint | Promise<bigint>,
74
+ /**
75
+ * @deprecated Pass desired HTLC expiration timeout as `expirySeconds`
76
+ */
77
+ expiryTimestamp?: bigint
78
+ }
79
+
80
+ export type ToBTCLNWrapperOptions = ISwapWrapperOptions & {
81
+ lightningBaseFee: number,
82
+ lightningFeePPM: number,
83
+ paymentTimeoutSeconds: number
84
+ };
85
+
86
+ export type ToBTCLNDefinition<T extends ChainType> = IToBTCDefinition<T, ToBTCLNWrapper<T>, ToBTCLNSwap<T>>;
87
+
88
+ /**
89
+ * Escrow based (HTLC) swap for Smart chains -> Bitcoin lightning
90
+ *
91
+ * @category Swaps/Smart chain → Lightning
92
+ */
93
+ export class ToBTCLNWrapper<T extends ChainType> extends IToBTCWrapper<T, ToBTCLNDefinition<T>, ToBTCLNWrapperOptions> {
94
+ public readonly TYPE: SwapType.TO_BTCLN = SwapType.TO_BTCLN;
95
+ /**
96
+ * @internal
97
+ */
98
+ readonly _swapDeserializer = ToBTCLNSwap;
99
+
100
+ constructor(
101
+ chainIdentifier: string,
102
+ unifiedStorage: UnifiedSwapStorage<T>,
103
+ unifiedChainEvents: UnifiedSwapEventListener<T>,
104
+ chain: T["ChainInterface"],
105
+ prices: ISwapPrice,
106
+ tokens: WrapperCtorTokens,
107
+ versionedContracts: {
108
+ [version: string]: {
109
+ swapContract: T["Contract"],
110
+ swapDataConstructor: new (data: any) => T["Data"]
111
+ }
112
+ },
113
+ options?: AllOptional<ToBTCLNWrapperOptions>,
114
+ events?: EventEmitter<{swapState: [ISwap]}>
115
+ ) {
116
+ super(
117
+ chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens,
118
+ {
119
+ ...options,
120
+ paymentTimeoutSeconds: options?.paymentTimeoutSeconds ?? 5*24*60*60,
121
+ lightningBaseFee: options?.lightningBaseFee ?? 10,
122
+ lightningFeePPM: options?.lightningFeePPM ?? 2000
123
+ },
124
+ versionedContracts,
125
+ events
126
+ );
127
+ }
128
+
129
+ private toRequiredSwapOptions(amountData: AmountData, options?: ToBTCLNOptions, pricePreFetchPromise?: Promise<bigint | undefined>, abortSignal?: AbortSignal) {
130
+ const expirySeconds = options?.expirySeconds ?? this._options.paymentTimeoutSeconds;
131
+ const maxRoutingBaseFee = options?.maxRoutingBaseFee ?? BigInt(this._options.lightningBaseFee);
132
+ const maxRoutingPPM = options?.maxRoutingFeePercentage!=null
133
+ ? BigInt(Math.floor(options.maxRoutingFeePercentage * 10_000))
134
+ : options?.maxRoutingPPM ?? BigInt(this._options.lightningFeePPM);
135
+
136
+ let maxFee: bigint | Promise<bigint>;
137
+ if(options?.maxFee!=null) {
138
+ maxFee = options.maxFee;
139
+ } else if(amountData.exactIn) {
140
+ if(pricePreFetchPromise!=null) {
141
+ maxFee = pricePreFetchPromise
142
+ .then(val => this._prices.getFromBtcSwapAmount(this.chainIdentifier, maxRoutingBaseFee, amountData.token, abortSignal, val))
143
+ .then(_maxBaseFee => this.calculateFeeForAmount(amountData.amount, _maxBaseFee, maxRoutingPPM))
144
+ } else {
145
+ maxFee = this._prices.getFromBtcSwapAmount(this.chainIdentifier, maxRoutingBaseFee, amountData.token, abortSignal)
146
+ .then(_maxBaseFee => this.calculateFeeForAmount(amountData.amount, _maxBaseFee, maxRoutingPPM))
147
+ }
148
+ } else {
149
+ maxFee = this.calculateFeeForAmount(amountData.amount, maxRoutingBaseFee, maxRoutingPPM)
150
+ }
151
+
152
+ return {
153
+ expiryTimestamp: options?.expiryTimestamp ?? BigInt(Math.floor(Date.now()/1000)+expirySeconds),
154
+ maxFee
155
+ }
156
+ }
157
+
158
+ /**
159
+ * Verifies whether a given payment hash was already paid by checking the local
160
+ * storage of known swaps
161
+ *
162
+ * @param paymentHash Payment hash to check
163
+ *
164
+ * @private
165
+ */
166
+ private async checkPaymentHashWasPaid(paymentHash: string) {
167
+ const swaps = await this.unifiedStorage.query(
168
+ [[{key: "type", value: this.TYPE}, {key: "paymentHash", value: paymentHash}]],
169
+ (obj: any) => new this._swapDeserializer(this, obj)
170
+ );
171
+
172
+ for(let value of swaps) {
173
+ if(value._state===ToBTCSwapState.CLAIMED || value._state===ToBTCSwapState.SOFT_CLAIMED)
174
+ throw new UserError("Lightning invoice was already paid!");
175
+ }
176
+ }
177
+
178
+ /**
179
+ * Calculates maximum lightning network routing fee based on amount
180
+ *
181
+ * @param amount BTC amount of the swap in satoshis
182
+ * @param overrideBaseFee Override wrapper's default base fee
183
+ * @param overrideFeePPM Override wrapper's default PPM
184
+ *
185
+ * @returns Maximum lightning routing fee in sats
186
+ *
187
+ * @private
188
+ */
189
+ private calculateFeeForAmount(amount: bigint, overrideBaseFee?: bigint, overrideFeePPM?: bigint) : bigint {
190
+ return BigInt(overrideBaseFee ?? this._options.lightningBaseFee)
191
+ + (amount * BigInt(overrideFeePPM ?? this._options.lightningFeePPM) / 1000000n);
192
+ }
193
+
194
+ /**
195
+ * Verifies returned LP data
196
+ *
197
+ * @param signer
198
+ * @param resp Response as returned by the LP
199
+ * @param parsedPr Parsed bolt11 lightning invoice
200
+ * @param token Smart chain token to be used in the swap
201
+ * @param lp
202
+ * @param calculatedOptions Swap options computed from the swap create options
203
+ * @param data Parsed swap data returned by the LP
204
+ * @param requiredTotal Required total to be paid on the input (for exactIn swaps)
205
+ *
206
+ * @throws {IntermediaryError} In case the response is not valid
207
+ *
208
+ * @private
209
+ */
210
+ private async verifyReturnedData(
211
+ signer: string,
212
+ resp: ToBTCLNResponseType,
213
+ parsedPr: PaymentRequestObject & {tagsObject: TagsObject},
214
+ token: string,
215
+ lp: Intermediary,
216
+ calculatedOptions: {
217
+ maxFee: bigint | Promise<bigint>,
218
+ expiryTimestamp: bigint
219
+ },
220
+ data: T["Data"],
221
+ requiredTotal?: bigint
222
+ ): Promise<void> {
223
+ if(resp.routingFeeSats > await calculatedOptions.maxFee) throw new IntermediaryError("Invalid max fee sats returned");
224
+
225
+ if(requiredTotal!=null && resp.total !== requiredTotal)
226
+ throw new IntermediaryError("Invalid data returned - total amount");
227
+
228
+ if(parsedPr.tagsObject.payment_hash==null) throw new Error("Swap invoice doesn't contain payment hash field!");
229
+ const claimHash = this._contract(lp.getContractVersion(this.chainIdentifier)).getHashForHtlc(Buffer.from(parsedPr.tagsObject.payment_hash, "hex"));
230
+
231
+ if(
232
+ data.getAmount() !== resp.total ||
233
+ !Buffer.from(data.getClaimHash(), "hex").equals(claimHash) ||
234
+ data.getExpiry() !== calculatedOptions.expiryTimestamp ||
235
+ data.getType()!==ChainSwapType.HTLC ||
236
+ !data.isPayIn() ||
237
+ !data.isToken(token) ||
238
+ !data.isClaimer(lp.getAddress(this.chainIdentifier)) ||
239
+ !data.isOfferer(signer) ||
240
+ data.getTotalDeposit() !== 0n
241
+ ) {
242
+ throw new IntermediaryError("Invalid data returned");
243
+ }
244
+ }
245
+
246
+ /**
247
+ * Returns the quote/swap from a given intermediary
248
+ *
249
+ * @param signer Smartchain signer initiating the swap
250
+ * @param amountData
251
+ * @param lp Intermediary
252
+ * @param pr bolt11 lightning network invoice
253
+ * @param parsedPr Parsed bolt11 lightning network invoice
254
+ * @param calculatedOptions Swap options computed from the swap create options
255
+ * @param preFetches
256
+ * @param abort Abort signal or controller, if AbortController is passed it is used as-is, when AbortSignal is passed
257
+ * it is extended with extendAbortController and then used
258
+ * @param additionalParams Additional params that should be sent to the LP
259
+ *
260
+ * @private
261
+ */
262
+ private async getIntermediaryQuote(
263
+ signer: string,
264
+ amountData: Omit<AmountData, "amount">,
265
+ lp: Intermediary,
266
+ pr: string,
267
+ parsedPr: PaymentRequestObject & {tagsObject: TagsObject},
268
+ calculatedOptions: {
269
+ maxFee: bigint | Promise<bigint>,
270
+ expiryTimestamp: bigint
271
+ },
272
+ preFetches: {
273
+ feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
274
+ pricePreFetchPromise: Promise<bigint | undefined>,
275
+ usdPricePrefetchPromise: Promise<number | undefined>,
276
+ signDataPrefetchPromise?: {[contractVersion: string]: Promise<T["PreFetchVerification"] | undefined> | undefined}
277
+ },
278
+ abort: AbortSignal | AbortController,
279
+ additionalParams?: Record<string, any>,
280
+ ) {
281
+ if(lp.services[SwapType.TO_BTCLN]==null) throw new Error("LP service for processing to btcln swaps not found!");
282
+ const version = lp.getContractVersion(this.chainIdentifier);
283
+
284
+ const abortController = abort instanceof AbortController ? abort : extendAbortController(abort);
285
+ const reputationPromise = this.preFetchIntermediaryReputation(amountData, lp, abortController, version);
286
+
287
+ try {
288
+ const {signDataPromise, resp} = await tryWithRetries(async(retryCount: number) => {
289
+ const {signDataPrefetch, response} = IntermediaryAPI.initToBTCLN(this.chainIdentifier, lp.url, {
290
+ offerer: signer,
291
+ pr,
292
+ maxFee: await calculatedOptions.maxFee,
293
+ expiryTimestamp: calculatedOptions.expiryTimestamp,
294
+ token: amountData.token,
295
+ feeRate: throwIfUndefined(preFetches.feeRatePromise[version]),
296
+ additionalParams
297
+ }, this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined);
298
+
299
+ let signDataPromise = preFetches.signDataPrefetchPromise?.[version];
300
+ if(signDataPromise==null) {
301
+ signDataPromise = this.preFetchSignData(signDataPrefetch, version);
302
+ } else signDataPrefetch.catch(() => {});
303
+
304
+ return {
305
+ signDataPromise,
306
+ resp: await response
307
+ };
308
+ }, undefined, e => e instanceof RequestError, abortController.signal);
309
+
310
+ if(parsedPr.millisatoshis==null) throw new Error("Swap invoice doesn't have msat amount field!");
311
+ const amountOut: bigint = (BigInt(parsedPr.millisatoshis) + 999n) / 1000n;
312
+ const totalFee: bigint = resp.swapFee + resp.maxFee;
313
+ const data: T["Data"] = new (this._swapDataDeserializer(version))(resp.data);
314
+ data.setOfferer(signer);
315
+
316
+ await this.verifyReturnedData(signer, resp, parsedPr, amountData.token, lp, calculatedOptions, data);
317
+
318
+ const swapFeeBtc = resp.swapFee * amountOut / (data.getAmount() - totalFee);
319
+
320
+ const [pricingInfo, signatureExpiry, reputation] = await Promise.all([
321
+ this.verifyReturnedPrice(
322
+ lp.services[SwapType.TO_BTCLN], true, amountOut, data.getAmount(),
323
+ amountData.token, {networkFee: resp.maxFee, swapFeeBtc},
324
+ preFetches.pricePreFetchPromise, preFetches.usdPricePrefetchPromise, abortController.signal
325
+ ),
326
+ this.verifyReturnedSignature(
327
+ signer, data, resp, preFetches.feeRatePromise[version], signDataPromise, version, abortController.signal
328
+ ),
329
+ reputationPromise
330
+ ]);
331
+ abortController.signal.throwIfAborted();
332
+
333
+ if(reputation!=null) lp.reputation[amountData.token.toString()] = reputation;
334
+
335
+ const quote = new ToBTCLNSwap<T>(this, {
336
+ pricingInfo,
337
+ url: lp.url,
338
+ expiry: signatureExpiry,
339
+ swapFee: resp.swapFee,
340
+ swapFeeBtc,
341
+ feeRate: (await preFetches.feeRatePromise[version])!,
342
+ signatureData: resp,
343
+ data,
344
+ networkFee: resp.maxFee,
345
+ networkFeeBtc: resp.routingFeeSats,
346
+ confidence: resp.confidence,
347
+ pr,
348
+ exactIn: false,
349
+ contractVersion: version
350
+ } as IToBTCSwapInit<T["Data"]>);
351
+ return quote;
352
+ } catch (e) {
353
+ abortController.abort(e);
354
+ throw e;
355
+ }
356
+ }
357
+
358
+ /**
359
+ * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol,
360
+ * the amount is parsed from the provided lightning network payment request (bolt11 invoice)
361
+ *
362
+ * @param signer Source chain signer address initiating the swap
363
+ * @param recipient BOLT11 payment request (bitcoin lightning invoice) you wish to pay
364
+ * @param amountData Token to swap
365
+ * @param lps An array of intermediaries (LPs) to get the quotes from
366
+ * @param options Optional additional quote options
367
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
368
+ * @param abortSignal Abort signal
369
+ * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
370
+ */
371
+ async create(
372
+ signer: string,
373
+ recipient: string,
374
+ amountData: Omit<AmountData, "amount"> & {exactIn: false},
375
+ lps: Intermediary[],
376
+ options?: ToBTCLNOptions,
377
+ additionalParams?: Record<string, any>,
378
+ abortSignal?: AbortSignal,
379
+ preFetches?: {
380
+ feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
381
+ pricePreFetchPromise: Promise<bigint | undefined>,
382
+ usdPricePrefetchPromise: Promise<number | undefined>,
383
+ signDataPrefetchPromise?: {[contractVersion: string]: Promise<T["PreFetchVerification"] | undefined> | undefined}
384
+ }
385
+ ): Promise<{
386
+ quote: Promise<ToBTCLNSwap<T>>,
387
+ intermediary: Intermediary
388
+ }[]> {
389
+ const parsedPr = bolt11Decode(recipient);
390
+ if(parsedPr.millisatoshis==null) throw new UserError("Must be an invoice with amount");
391
+ const amountOut: bigint = (BigInt(parsedPr.millisatoshis) + 999n) / 1000n;
392
+
393
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
394
+
395
+ const _options = this.toRequiredSwapOptions({...amountData, amount: amountOut}, options);
396
+
397
+ if(parsedPr.tagsObject.payment_hash==null) throw new Error("Provided lightning invoice doesn't contain payment hash field!");
398
+ await this.checkPaymentHashWasPaid(parsedPr.tagsObject.payment_hash);
399
+
400
+ const _hash = mapArrayToObject(lpVersions, (contractVersion: string) => {
401
+ return this._contract(contractVersion).getHashForHtlc(Buffer.from(parsedPr.tagsObject.payment_hash!, "hex")).toString("hex");
402
+ });
403
+
404
+ const _abortController = extendAbortController(abortSignal);
405
+ const _preFetches = preFetches ?? {
406
+ pricePreFetchPromise: this.preFetchPrice(amountData, _abortController.signal),
407
+ feeRatePromise: this.preFetchFeeRate(signer, amountData, _hash, _abortController, lpVersions),
408
+ usdPricePrefetchPromise: this.preFetchUsdPrice(_abortController.signal),
409
+ signDataPrefetchPromise: mapArrayToObject(lpVersions, (contractVersion: string) => {
410
+ return this._contract(contractVersion).preFetchBlockDataForSignatures==null ?
411
+ this.preFetchSignData(Promise.resolve(true), contractVersion) :
412
+ undefined;
413
+ })
414
+ };
415
+
416
+ return lps.map(lp => {
417
+ return {
418
+ intermediary: lp,
419
+ quote: this.getIntermediaryQuote(signer, amountData, lp, recipient, parsedPr, _options, _preFetches, _abortController.signal, additionalParams)
420
+ }
421
+ });
422
+ }
423
+
424
+ /**
425
+ * Parses and fetches lnurl pay params from the specified lnurl
426
+ *
427
+ * @param lnurl LNURL to be parsed and fetched
428
+ * @param abortSignal Abort signal
429
+ * @throws {UserError} if the LNURL is invalid or if it's not a LNURL-pay
430
+ *
431
+ * @private
432
+ */
433
+ private async getLNURLPay(lnurl: string | LNURLPayParamsWithUrl, abortSignal: AbortSignal): Promise<LNURLPayParamsWithUrl> {
434
+ if(typeof(lnurl)!=="string") return lnurl;
435
+
436
+ const res = await LNURL.getLNURL(lnurl, true, this._options.getRequestTimeout, abortSignal);
437
+ if(res==null) throw new UserError("Invalid LNURL");
438
+ if(res.tag!=="payRequest") throw new UserError("Not a LNURL-pay");
439
+ return res;
440
+ }
441
+
442
+ /**
443
+ * Returns the quote/swap from the given LP
444
+ *
445
+ * @param signer Source chain signer address initiating the swap
446
+ * @param amountData Token to swap
447
+ * @param invoiceCreateService Service for creating fixed amount invoices
448
+ * @param lp Intermediary (LPs) to get the quote from
449
+ * @param dummyPr Dummy minimum value bolt11 lightning invoice returned from the LNURL-pay, used to estimate
450
+ * network fees for an actual invoice
451
+ * @param calculatedOptions Swap options computed from the swap create options
452
+ * @param preFetches Optional existing pre-fetch promises for the swap (only used internally for LNURL swaps)
453
+ * @param abortSignal Abort signal
454
+ * @param additionalParams Additional params to be sent to the intermediary
455
+ *
456
+ * @private
457
+ */
458
+ private async getIntermediaryQuoteExactIn(
459
+ signer: string,
460
+ amountData: AmountData,
461
+ invoiceCreateService: LightningInvoiceCreateService,
462
+ lp: Intermediary,
463
+ dummyPr: string,
464
+ calculatedOptions: {
465
+ maxFee: bigint | Promise<bigint>,
466
+ expiryTimestamp: bigint
467
+ },
468
+ preFetches: {
469
+ feeRatePromise: {[contractVersion: string]: Promise<string | undefined>},
470
+ pricePreFetchPromise: Promise<bigint | undefined>,
471
+ usdPricePrefetchPromise: Promise<number | undefined>
472
+ },
473
+ abortSignal: AbortSignal,
474
+ additionalParams?: Record<string, any>,
475
+ ) {
476
+ if(lp.services[SwapType.TO_BTCLN]==null) throw new Error("LP service for processing to btcln swaps not found!");
477
+ const version = lp.getContractVersion(this.chainIdentifier);
478
+
479
+ const abortController = extendAbortController(abortSignal);
480
+ const reputationPromise = this.preFetchIntermediaryReputation(amountData, lp, abortController, version);
481
+
482
+ try {
483
+ const {signDataPromise, prepareResp} = await tryWithRetries(async(retryCount: number) => {
484
+ const {signDataPrefetch, response} = IntermediaryAPI.prepareToBTCLNExactIn(this.chainIdentifier, lp.url, {
485
+ token: amountData.token,
486
+ offerer: signer,
487
+ pr: dummyPr,
488
+ amount: amountData.amount,
489
+ maxFee: await calculatedOptions.maxFee,
490
+ expiryTimestamp: calculatedOptions.expiryTimestamp,
491
+ additionalParams
492
+ }, this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined);
493
+
494
+ return {
495
+ signDataPromise: this.preFetchSignData(signDataPrefetch, version),
496
+ prepareResp: await response
497
+ };
498
+ }, undefined, e => e instanceof RequestError, abortController.signal);
499
+
500
+ if(prepareResp.amount <= 0n)
501
+ throw new IntermediaryError("Invalid amount returned (zero or negative)");
502
+
503
+ if(invoiceCreateService.minMsats!=null) {
504
+ if(prepareResp.amount < invoiceCreateService.minMsats / 1000n) throw new UserError("Amount less than minimum");
505
+ }
506
+ if(invoiceCreateService.maxMSats!=null) {
507
+ if(prepareResp.amount > invoiceCreateService.maxMSats / 1000n) throw new UserError("Amount more than maximum");
508
+ }
509
+
510
+ const invoice = await invoiceCreateService.getInvoice(Number(prepareResp.amount), abortController.signal);
511
+ const parsedInvoice = bolt11Decode(invoice);
512
+
513
+ const resp = await tryWithRetries(
514
+ (retryCount: number) => IntermediaryAPI.initToBTCLNExactIn(lp.url, {
515
+ pr: invoice,
516
+ reqId: prepareResp.reqId,
517
+ feeRate: throwIfUndefined(preFetches.feeRatePromise[version]),
518
+ additionalParams
519
+ }, this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined),
520
+ undefined, RequestError, abortController.signal
521
+ );
522
+
523
+ if(parsedInvoice.millisatoshis==null) throw new Error("Swap invoice doesn't have msat amount field!");
524
+ const amountOut: bigint = (BigInt(parsedInvoice.millisatoshis) + 999n) / 1000n;
525
+ const totalFee: bigint = resp.swapFee + resp.maxFee;
526
+ const data: T["Data"] = new (this._swapDataDeserializer(version))(resp.data);
527
+ data.setOfferer(signer);
528
+
529
+ await this.verifyReturnedData(signer, resp, parsedInvoice, amountData.token, lp, calculatedOptions, data, amountData.amount);
530
+
531
+ const swapFeeBtc = resp.swapFee * amountOut / (data.getAmount() - totalFee);
532
+
533
+ const [pricingInfo, signatureExpiry, reputation] = await Promise.all([
534
+ this.verifyReturnedPrice(
535
+ lp.services[SwapType.TO_BTCLN], true, prepareResp.amount, data.getAmount(),
536
+ amountData.token, {networkFee: resp.maxFee, swapFeeBtc},
537
+ preFetches.pricePreFetchPromise, preFetches.usdPricePrefetchPromise, abortSignal
538
+ ),
539
+ this.verifyReturnedSignature(
540
+ signer, data, resp, preFetches.feeRatePromise[version], signDataPromise, version, abortController.signal
541
+ ),
542
+ reputationPromise
543
+ ]);
544
+ abortController.signal.throwIfAborted();
545
+
546
+ if(reputation!=null) lp.reputation[amountData.token.toString()] = reputation;
547
+
548
+ const quote = new ToBTCLNSwap<T>(this, {
549
+ pricingInfo,
550
+ url: lp.url,
551
+ expiry: signatureExpiry,
552
+ swapFee: resp.swapFee,
553
+ swapFeeBtc,
554
+ feeRate: (await preFetches.feeRatePromise[version])!,
555
+ signatureData: resp,
556
+ data,
557
+ networkFee: resp.maxFee,
558
+ networkFeeBtc: resp.routingFeeSats,
559
+ confidence: resp.confidence,
560
+ pr: invoice,
561
+ exactIn: true,
562
+ contractVersion: version
563
+ } as IToBTCSwapInit<T["Data"]>);
564
+ return quote;
565
+ } catch (e) {
566
+ abortController.abort(e);
567
+ throw e;
568
+ }
569
+ }
570
+
571
+ /**
572
+ * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol via
573
+ * invoice creation service. This allows exactIn swaps by requesting the desired fixed amount lightning
574
+ * network invoice from the service.
575
+ *
576
+ * @param signer Source chain signer address initiating the swap
577
+ * @param invoiceCreateServicePromise Service to request destination lightning network invoices from
578
+ * @param amountData Amount, token and exact input/output data for to swap
579
+ * @param lps An array of intermediaries (LPs) to get the quotes from
580
+ * @param options Optional additional quote options
581
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
582
+ * @param abortSignal Abort signal
583
+ */
584
+ async createViaInvoiceCreateService(
585
+ signer: string,
586
+ invoiceCreateServicePromise: Promise<LightningInvoiceCreateService>,
587
+ amountData: AmountData,
588
+ lps: Intermediary[],
589
+ options?: ToBTCLNOptions,
590
+ additionalParams?: Record<string, any>,
591
+ abortSignal?: AbortSignal
592
+ ): Promise<{
593
+ quote: Promise<ToBTCLNSwap<T>>,
594
+ intermediary: Intermediary
595
+ }[]> {
596
+ if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
597
+
598
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
599
+
600
+ const _abortController = extendAbortController(abortSignal);
601
+ const pricePreFetchPromise: Promise<bigint | undefined> = this.preFetchPrice(amountData, _abortController.signal);
602
+ const usdPricePrefetchPromise: Promise<number | undefined> = this.preFetchUsdPrice(_abortController.signal);
603
+ const feeRatePromise = this.preFetchFeeRate(signer, amountData, undefined, _abortController, lpVersions);
604
+ const signDataPrefetchPromise = mapArrayToObject(lpVersions, (contractVersion: string) => {
605
+ return this._contract(contractVersion).preFetchBlockDataForSignatures==null ?
606
+ this.preFetchSignData(Promise.resolve(true), contractVersion) :
607
+ undefined;
608
+ });
609
+
610
+ const _options = this.toRequiredSwapOptions(amountData, options, pricePreFetchPromise, _abortController.signal);
611
+
612
+ try {
613
+ const invoiceCreateService = await invoiceCreateServicePromise;
614
+
615
+ if(amountData.exactIn) {
616
+ const dummyInvoice = await invoiceCreateService.getInvoice(
617
+ invoiceCreateService.minMsats==null ? 1 : Number(invoiceCreateService.minMsats/1000n),
618
+ _abortController.signal
619
+ );
620
+
621
+ return lps.map(lp => {
622
+ return {
623
+ quote: this.getIntermediaryQuoteExactIn(signer, amountData, invoiceCreateService, lp, dummyInvoice, _options, {
624
+ pricePreFetchPromise,
625
+ usdPricePrefetchPromise,
626
+ feeRatePromise
627
+ }, _abortController.signal, additionalParams),
628
+ intermediary: lp
629
+ }
630
+ })
631
+ } else {
632
+ if(invoiceCreateService.minMsats!=null) {
633
+ if(amountData.amount < invoiceCreateService.minMsats / 1000n) throw new UserError("Amount less than minimum");
634
+ }
635
+ if(invoiceCreateService.maxMSats!=null) {
636
+ if(amountData.amount > invoiceCreateService.maxMSats / 1000n) throw new UserError("Amount more than maximum");
637
+ }
638
+
639
+ const invoice = await invoiceCreateService.getInvoice(Number(amountData.amount), _abortController.signal);
640
+
641
+ return (await this.create(signer, invoice, {...amountData, exactIn: false}, lps, options, additionalParams, _abortController.signal, {
642
+ feeRatePromise,
643
+ pricePreFetchPromise,
644
+ usdPricePrefetchPromise,
645
+ signDataPrefetchPromise
646
+ }));
647
+ }
648
+ } catch (e) {
649
+ _abortController.abort(e);
650
+ throw e;
651
+ }
652
+ }
653
+
654
+ /**
655
+ * Returns a newly created Smart chain -> Lightning swap using the HTLC based escrow swap protocol. Pays to
656
+ * an LNURL-pay link. This allows exactIn swaps by requesting the desired fixed amount lightning
657
+ * network invoice from the LNURL service.
658
+ *
659
+ * @param signer Source chain signer address initiating the swap
660
+ * @param lnurl LNURL-pay link of the recipient
661
+ * @param amountData Amount, token and exact input/output data for to swap
662
+ * @param lps An array of intermediaries (LPs) to get the quotes from
663
+ * @param options Optional additional quote options
664
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
665
+ * @param abortSignal Abort signal
666
+ */
667
+ async createViaLNURL(
668
+ signer: string,
669
+ lnurl: string | LNURLPayParamsWithUrl,
670
+ amountData: AmountData,
671
+ lps: Intermediary[],
672
+ options?: ToBTCLNOptions & {comment?: string},
673
+ additionalParams?: Record<string, any>,
674
+ abortSignal?: AbortSignal
675
+ ): Promise<{
676
+ quote: Promise<ToBTCLNSwap<T>>,
677
+ intermediary: Intermediary
678
+ }[]> {
679
+ let successActions: {[pr: string]: LNURLPaySuccessAction} = {};
680
+
681
+ const _abortController = extendAbortController(abortSignal);
682
+ const invoiceCreateService = (async() => {
683
+ let payRequest: LNURLPayParamsWithUrl = await this.getLNURLPay(lnurl, _abortController.signal);
684
+
685
+ if(
686
+ options?.comment!=null &&
687
+ (payRequest.commentAllowed==null || options.comment.length>payRequest.commentAllowed)
688
+ ) throw new UserError("Comment not allowed or too long");
689
+
690
+ return {
691
+ getInvoice: async (amountSats: number, abortSignal?: AbortSignal) => {
692
+ const {invoice, successAction} = await LNURL.useLNURLPay(
693
+ payRequest, BigInt(amountSats), options?.comment,
694
+ this._options.getRequestTimeout, abortSignal
695
+ );
696
+ if(successAction!=null) successActions[invoice] = successAction;
697
+ return invoice;
698
+ },
699
+ minMsats: BigInt(payRequest.minSendable),
700
+ maxMsats: BigInt(payRequest.maxSendable),
701
+ url: payRequest.url
702
+ }
703
+ })();
704
+
705
+ const quotes = await this.createViaInvoiceCreateService(
706
+ signer,
707
+ invoiceCreateService,
708
+ amountData,
709
+ lps,
710
+ options,
711
+ additionalParams,
712
+ _abortController.signal
713
+ );
714
+ _abortController.signal.throwIfAborted();
715
+
716
+ const resolved = await invoiceCreateService;
717
+ _abortController.signal.throwIfAborted();
718
+
719
+ return quotes.map(value => ({
720
+ quote: value.quote.then(quote => {
721
+ let _successAction: LNURLPaySuccessAction | undefined;
722
+ const quoteAddress = quote.getOutputAddress();
723
+ if(quoteAddress!=null) {
724
+ const successAction = successActions[quoteAddress];
725
+ if(successAction!=null) _successAction = successAction;
726
+ }
727
+ quote._setLNURLData(resolved.url, _successAction);
728
+ return quote;
729
+ }),
730
+ intermediary: value.intermediary
731
+ }));
732
+ }
733
+
734
+ /**
735
+ * @inheritDoc
736
+ */
737
+ async recoverFromSwapDataAndState(
738
+ init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
739
+ state: SwapCommitState,
740
+ contractVersion: string,
741
+ lp?: Intermediary
742
+ ): Promise<ToBTCLNSwap<T> | null> {
743
+ const data = init.data;
744
+
745
+ let paymentHash = data.getHTLCHashHint();
746
+ let secret: string | undefined;
747
+ if(state.type===SwapCommitStateType.PAID) {
748
+ secret = await state.getClaimResult();
749
+ paymentHash = Buffer.from(sha256(Buffer.from(secret, "hex"))).toString("hex");
750
+ }
751
+
752
+ const swapInit: ToBTCLNSwapInit<T["Data"]> = {
753
+ pricingInfo: {
754
+ isValid: true,
755
+ satsBaseFee: 0n,
756
+ swapPriceUSatPerToken: 100_000_000_000_000n,
757
+ realPriceUSatPerToken: 100_000_000_000_000n,
758
+ differencePPM: 0n,
759
+ feePPM: 0n,
760
+ },
761
+ url: lp?.url,
762
+ expiry: 0,
763
+ swapFee: 0n,
764
+ swapFeeBtc: 0n,
765
+ feeRate: "",
766
+ signatureData: undefined,
767
+ data,
768
+ networkFee: 0n,
769
+ networkFeeBtc: 0n,
770
+ confidence: 0,
771
+ pr: paymentHash ?? undefined,
772
+ exactIn: false,
773
+ contractVersion
774
+ };
775
+ const swap = new ToBTCLNSwap(this, swapInit);
776
+ swap._commitTxId = await init.getInitTxId();
777
+ const blockData = await init.getTxBlock();
778
+ swap.createdAt = blockData.blockTime * 1000;
779
+ swap._setInitiated();
780
+ swap._state = ToBTCSwapState.COMMITED;
781
+ await swap._sync(false, false, state);
782
+ await swap._save();
783
+ return swap;
784
+ }
785
+
786
+ }