@atomiqlabs/sdk 8.9.0 → 8.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (366) hide show
  1. package/LICENSE +201 -201
  2. package/README.md +1760 -1760
  3. package/api/index.d.ts +1 -1
  4. package/api/index.js +3 -3
  5. package/dist/ApiList.d.ts +37 -37
  6. package/dist/ApiList.js +30 -30
  7. package/dist/SmartChainAssets.d.ts +181 -181
  8. package/dist/SmartChainAssets.js +181 -181
  9. package/dist/api/ApiEndpoints.d.ts +393 -393
  10. package/dist/api/ApiEndpoints.js +2 -2
  11. package/dist/api/ApiParser.d.ts +10 -10
  12. package/dist/api/ApiParser.js +134 -134
  13. package/dist/api/ApiTypes.d.ts +157 -157
  14. package/dist/api/ApiTypes.js +75 -75
  15. package/dist/api/SerializedAction.d.ts +40 -40
  16. package/dist/api/SerializedAction.js +59 -59
  17. package/dist/api/SwapperApi.d.ts +50 -50
  18. package/dist/api/SwapperApi.js +431 -431
  19. package/dist/api/index.d.ts +5 -5
  20. package/dist/api/index.js +24 -24
  21. package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
  22. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  23. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
  24. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  25. package/dist/bitcoin/coinselect2/index.d.ts +20 -20
  26. package/dist/bitcoin/coinselect2/index.js +69 -69
  27. package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
  28. package/dist/bitcoin/coinselect2/utils.js +158 -158
  29. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
  30. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
  31. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
  32. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  33. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
  34. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
  35. package/dist/enums/FeeType.d.ts +15 -15
  36. package/dist/enums/FeeType.js +19 -19
  37. package/dist/enums/SwapAmountType.d.ts +15 -15
  38. package/dist/enums/SwapAmountType.js +19 -19
  39. package/dist/enums/SwapDirection.d.ts +15 -15
  40. package/dist/enums/SwapDirection.js +19 -19
  41. package/dist/enums/SwapSide.d.ts +15 -15
  42. package/dist/enums/SwapSide.js +19 -19
  43. package/dist/enums/SwapType.d.ts +75 -75
  44. package/dist/enums/SwapType.js +79 -79
  45. package/dist/errors/IntermediaryError.d.ts +13 -13
  46. package/dist/errors/IntermediaryError.js +27 -27
  47. package/dist/errors/RequestError.d.ts +32 -32
  48. package/dist/errors/RequestError.js +54 -54
  49. package/dist/errors/UserError.d.ts +8 -8
  50. package/dist/errors/UserError.js +16 -16
  51. package/dist/events/UnifiedSwapEventListener.d.ts +24 -24
  52. package/dist/events/UnifiedSwapEventListener.js +138 -138
  53. package/dist/http/HttpUtils.d.ts +29 -29
  54. package/dist/http/HttpUtils.js +97 -97
  55. package/dist/http/paramcoders/IParamReader.d.ts +8 -8
  56. package/dist/http/paramcoders/IParamReader.js +2 -2
  57. package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
  58. package/dist/http/paramcoders/ParamDecoder.js +137 -137
  59. package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
  60. package/dist/http/paramcoders/ParamEncoder.js +36 -36
  61. package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
  62. package/dist/http/paramcoders/SchemaVerifier.js +145 -145
  63. package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
  64. package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
  65. package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
  66. package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
  67. package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +17 -17
  68. package/dist/http/paramcoders/client/StreamingFetchPromise.js +175 -175
  69. package/dist/index.d.ts +86 -86
  70. package/dist/index.js +159 -159
  71. package/dist/intermediaries/Intermediary.d.ts +178 -178
  72. package/dist/intermediaries/Intermediary.js +166 -166
  73. package/dist/intermediaries/IntermediaryDiscovery.d.ts +216 -216
  74. package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
  75. package/dist/intermediaries/apis/IntermediaryAPI.d.ts +607 -607
  76. package/dist/intermediaries/apis/IntermediaryAPI.js +764 -764
  77. package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
  78. package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
  79. package/dist/intermediaries/auth/SignedKeyBasedAuth.d.ts +14 -14
  80. package/dist/intermediaries/auth/SignedKeyBasedAuth.js +68 -68
  81. package/dist/lnurl/LNURL.d.ts +102 -102
  82. package/dist/lnurl/LNURL.js +321 -321
  83. package/dist/prices/RedundantSwapPrice.d.ts +110 -110
  84. package/dist/prices/RedundantSwapPrice.js +222 -222
  85. package/dist/prices/SingleSwapPrice.d.ts +34 -34
  86. package/dist/prices/SingleSwapPrice.js +44 -44
  87. package/dist/prices/SwapPriceWithChain.d.ts +107 -107
  88. package/dist/prices/SwapPriceWithChain.js +128 -128
  89. package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
  90. package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
  91. package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
  92. package/dist/prices/abstract/IPriceProvider.js +74 -74
  93. package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
  94. package/dist/prices/abstract/ISwapPrice.js +279 -279
  95. package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
  96. package/dist/prices/providers/BinancePriceProvider.js +30 -30
  97. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
  98. package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
  99. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
  100. package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
  101. package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
  102. package/dist/prices/providers/CustomPriceProvider.js +35 -35
  103. package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
  104. package/dist/prices/providers/KrakenPriceProvider.js +45 -45
  105. package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
  106. package/dist/prices/providers/OKXPriceProvider.js +29 -29
  107. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
  108. package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
  109. package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
  110. package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
  111. package/dist/storage/IUnifiedStorage.d.ts +127 -127
  112. package/dist/storage/IUnifiedStorage.js +2 -2
  113. package/dist/storage/UnifiedSwapStorage.d.ts +120 -120
  114. package/dist/storage/UnifiedSwapStorage.js +154 -154
  115. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
  116. package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
  117. package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
  118. package/dist/storage-browser/LocalStorageManager.js +93 -93
  119. package/dist/swapper/Swapper.d.ts +765 -765
  120. package/dist/swapper/Swapper.js +1749 -1749
  121. package/dist/swapper/SwapperFactory.d.ts +135 -135
  122. package/dist/swapper/SwapperFactory.js +162 -162
  123. package/dist/swapper/SwapperUtils.d.ts +222 -222
  124. package/dist/swapper/SwapperUtils.js +519 -519
  125. package/dist/swapper/SwapperWithChain.d.ts +404 -404
  126. package/dist/swapper/SwapperWithChain.js +469 -469
  127. package/dist/swapper/SwapperWithSigner.d.ts +322 -322
  128. package/dist/swapper/SwapperWithSigner.js +318 -318
  129. package/dist/swaps/IAddressSwap.d.ts +22 -22
  130. package/dist/swaps/IAddressSwap.js +14 -14
  131. package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
  132. package/dist/swaps/IBTCWalletSwap.js +18 -18
  133. package/dist/swaps/IClaimableSwap.d.ts +49 -49
  134. package/dist/swaps/IClaimableSwap.js +15 -15
  135. package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
  136. package/dist/swaps/IClaimableSwapWrapper.js +2 -2
  137. package/dist/swaps/IRefundableSwap.d.ts +43 -43
  138. package/dist/swaps/IRefundableSwap.js +14 -14
  139. package/dist/swaps/ISwap.d.ts +453 -453
  140. package/dist/swaps/ISwap.js +371 -371
  141. package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
  142. package/dist/swaps/ISwapWithGasDrop.js +12 -12
  143. package/dist/swaps/ISwapWrapper.d.ts +295 -295
  144. package/dist/swaps/ISwapWrapper.js +373 -373
  145. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
  146. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
  147. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
  148. package/dist/swaps/escrow_swaps/IEscrowSwap.js +172 -172
  149. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +129 -129
  150. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
  151. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +107 -107
  152. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +130 -130
  153. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
  154. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
  155. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
  156. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
  157. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +547 -547
  158. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1419 -1419
  159. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +192 -192
  160. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
  161. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +650 -650
  162. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1577 -1577
  163. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +237 -237
  164. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
  165. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +491 -491
  166. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1463 -1463
  167. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +204 -204
  168. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
  169. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +446 -446
  170. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +1097 -1097
  171. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
  172. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
  173. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
  174. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
  175. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +252 -252
  176. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +535 -535
  177. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
  178. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
  179. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +134 -134
  180. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
  181. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +694 -694
  182. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1687 -1687
  183. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +259 -259
  184. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
  185. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +302 -302
  186. package/dist/swaps/trusted/ln/LnForGasSwap.js +625 -625
  187. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
  188. package/dist/swaps/trusted/ln/LnForGasWrapper.js +82 -82
  189. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +343 -343
  190. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +698 -698
  191. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +71 -71
  192. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
  193. package/dist/types/AmountData.d.ts +10 -10
  194. package/dist/types/AmountData.js +2 -2
  195. package/dist/types/CustomPriceFunction.d.ts +11 -11
  196. package/dist/types/CustomPriceFunction.js +2 -2
  197. package/dist/types/PriceInfoType.d.ts +28 -28
  198. package/dist/types/PriceInfoType.js +57 -57
  199. package/dist/types/SwapExecutionAction.d.ts +195 -195
  200. package/dist/types/SwapExecutionAction.js +106 -106
  201. package/dist/types/SwapExecutionStep.d.ts +144 -144
  202. package/dist/types/SwapExecutionStep.js +87 -87
  203. package/dist/types/SwapStateInfo.d.ts +5 -5
  204. package/dist/types/SwapStateInfo.js +2 -2
  205. package/dist/types/SwapWithSigner.d.ts +17 -17
  206. package/dist/types/SwapWithSigner.js +43 -43
  207. package/dist/types/Token.d.ts +99 -99
  208. package/dist/types/Token.js +76 -76
  209. package/dist/types/TokenAmount.d.ts +75 -75
  210. package/dist/types/TokenAmount.js +85 -85
  211. package/dist/types/fees/Fee.d.ts +50 -50
  212. package/dist/types/fees/Fee.js +2 -2
  213. package/dist/types/fees/FeeBreakdown.d.ts +11 -11
  214. package/dist/types/fees/FeeBreakdown.js +2 -2
  215. package/dist/types/fees/PercentagePPM.d.ts +17 -17
  216. package/dist/types/fees/PercentagePPM.js +18 -18
  217. package/dist/types/lnurl/LNURLPay.d.ts +61 -61
  218. package/dist/types/lnurl/LNURLPay.js +31 -31
  219. package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
  220. package/dist/types/lnurl/LNURLWithdraw.js +27 -27
  221. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
  222. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
  223. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
  224. package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
  225. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
  226. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
  227. package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
  228. package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
  229. package/dist/utils/BitcoinUtils.d.ts +18 -18
  230. package/dist/utils/BitcoinUtils.js +174 -174
  231. package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
  232. package/dist/utils/BitcoinWalletUtils.js +14 -14
  233. package/dist/utils/Logger.d.ts +7 -7
  234. package/dist/utils/Logger.js +12 -12
  235. package/dist/utils/RetryUtils.d.ts +22 -22
  236. package/dist/utils/RetryUtils.js +67 -67
  237. package/dist/utils/SwapUtils.d.ts +88 -88
  238. package/dist/utils/SwapUtils.js +72 -72
  239. package/dist/utils/TimeoutUtils.d.ts +17 -17
  240. package/dist/utils/TimeoutUtils.js +55 -55
  241. package/dist/utils/TokenUtils.d.ts +19 -19
  242. package/dist/utils/TokenUtils.js +37 -37
  243. package/dist/utils/TypeUtils.d.ts +7 -7
  244. package/dist/utils/TypeUtils.js +2 -2
  245. package/dist/utils/Utils.d.ts +69 -69
  246. package/dist/utils/Utils.js +214 -214
  247. package/package.json +46 -46
  248. package/src/SmartChainAssets.ts +186 -186
  249. package/src/api/ApiEndpoints.ts +427 -427
  250. package/src/api/ApiParser.ts +138 -138
  251. package/src/api/ApiTypes.ts +229 -229
  252. package/src/api/SerializedAction.ts +97 -97
  253. package/src/api/SwapperApi.ts +545 -545
  254. package/src/api/index.ts +5 -5
  255. package/src/bitcoin/coinselect2/accumulative.ts +69 -69
  256. package/src/bitcoin/coinselect2/blackjack.ts +50 -50
  257. package/src/bitcoin/coinselect2/index.ts +93 -93
  258. package/src/bitcoin/coinselect2/utils.ts +236 -236
  259. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
  260. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
  261. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
  262. package/src/enums/FeeType.ts +15 -15
  263. package/src/enums/SwapAmountType.ts +16 -16
  264. package/src/enums/SwapDirection.ts +15 -15
  265. package/src/enums/SwapSide.ts +16 -16
  266. package/src/enums/SwapType.ts +75 -75
  267. package/src/errors/IntermediaryError.ts +28 -28
  268. package/src/errors/RequestError.ts +64 -64
  269. package/src/errors/UserError.ts +15 -15
  270. package/src/events/UnifiedSwapEventListener.ts +181 -181
  271. package/src/http/HttpUtils.ts +97 -97
  272. package/src/http/paramcoders/IParamReader.ts +9 -9
  273. package/src/http/paramcoders/ParamDecoder.ts +145 -145
  274. package/src/http/paramcoders/ParamEncoder.ts +40 -40
  275. package/src/http/paramcoders/SchemaVerifier.ts +153 -153
  276. package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
  277. package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
  278. package/src/http/paramcoders/client/StreamingFetchPromise.ts +194 -194
  279. package/src/index.ts +141 -141
  280. package/src/intermediaries/Intermediary.ts +280 -280
  281. package/src/intermediaries/IntermediaryDiscovery.ts +548 -548
  282. package/src/intermediaries/apis/IntermediaryAPI.ts +1247 -1247
  283. package/src/intermediaries/auth/SignedKeyBasedAuth.ts +69 -69
  284. package/src/lnurl/LNURL.ts +402 -402
  285. package/src/prices/RedundantSwapPrice.ts +264 -264
  286. package/src/prices/SingleSwapPrice.ts +50 -50
  287. package/src/prices/SwapPriceWithChain.ts +194 -194
  288. package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
  289. package/src/prices/abstract/IPriceProvider.ts +127 -127
  290. package/src/prices/abstract/ISwapPrice.ts +390 -390
  291. package/src/prices/providers/BinancePriceProvider.ts +48 -48
  292. package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
  293. package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
  294. package/src/prices/providers/CustomPriceProvider.ts +40 -40
  295. package/src/prices/providers/KrakenPriceProvider.ts +83 -83
  296. package/src/prices/providers/OKXPriceProvider.ts +59 -59
  297. package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
  298. package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
  299. package/src/storage/IUnifiedStorage.ts +136 -136
  300. package/src/storage/UnifiedSwapStorage.ts +175 -175
  301. package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
  302. package/src/storage-browser/LocalStorageManager.ts +106 -106
  303. package/src/swapper/Swapper.ts +2557 -2557
  304. package/src/swapper/SwapperFactory.ts +307 -307
  305. package/src/swapper/SwapperUtils.ts +610 -610
  306. package/src/swapper/SwapperWithChain.ts +707 -707
  307. package/src/swapper/SwapperWithSigner.ts +511 -511
  308. package/src/swaps/IAddressSwap.ts +30 -30
  309. package/src/swaps/IBTCWalletSwap.ts +92 -92
  310. package/src/swaps/IClaimableSwap.ts +65 -65
  311. package/src/swaps/IClaimableSwapWrapper.ts +17 -17
  312. package/src/swaps/IRefundableSwap.ts +58 -58
  313. package/src/swaps/ISwap.ts +775 -775
  314. package/src/swaps/ISwapWithGasDrop.ts +25 -25
  315. package/src/swaps/ISwapWrapper.ts +564 -564
  316. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
  317. package/src/swaps/escrow_swaps/IEscrowSwap.ts +271 -271
  318. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +284 -284
  319. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +172 -172
  320. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
  321. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
  322. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1670 -1671
  323. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +603 -603
  324. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1883 -1883
  325. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +752 -752
  326. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1753 -1753
  327. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +612 -612
  328. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1327 -1327
  329. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
  330. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
  331. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +787 -787
  332. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
  333. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +403 -403
  334. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +2148 -2148
  335. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1238 -1238
  336. package/src/swaps/trusted/ln/LnForGasSwap.ts +753 -753
  337. package/src/swaps/trusted/ln/LnForGasWrapper.ts +90 -90
  338. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +843 -843
  339. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +133 -133
  340. package/src/types/AmountData.ts +9 -9
  341. package/src/types/CustomPriceFunction.ts +11 -11
  342. package/src/types/PriceInfoType.ts +66 -66
  343. package/src/types/SwapExecutionAction.ts +323 -323
  344. package/src/types/SwapExecutionStep.ts +224 -224
  345. package/src/types/SwapStateInfo.ts +6 -6
  346. package/src/types/SwapWithSigner.ts +61 -61
  347. package/src/types/Token.ts +163 -163
  348. package/src/types/TokenAmount.ts +167 -167
  349. package/src/types/fees/Fee.ts +56 -56
  350. package/src/types/fees/FeeBreakdown.ts +11 -11
  351. package/src/types/fees/PercentagePPM.ts +26 -26
  352. package/src/types/lnurl/LNURLPay.ts +79 -79
  353. package/src/types/lnurl/LNURLWithdraw.ts +61 -61
  354. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
  355. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
  356. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
  357. package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
  358. package/src/utils/BitcoinUtils.ts +164 -164
  359. package/src/utils/BitcoinWalletUtils.ts +15 -15
  360. package/src/utils/Logger.ts +14 -14
  361. package/src/utils/RetryUtils.ts +78 -78
  362. package/src/utils/SwapUtils.ts +99 -99
  363. package/src/utils/TimeoutUtils.ts +49 -49
  364. package/src/utils/TokenUtils.ts +33 -33
  365. package/src/utils/TypeUtils.ts +8 -8
  366. package/src/utils/Utils.ts +221 -221
@@ -1,612 +1,612 @@
1
- import {IFromBTCWrapper} from "../IFromBTCWrapper";
2
- import {FromBTCSwap, FromBTCSwapInit, FromBTCSwapState} from "./FromBTCSwap";
3
- import {
4
- ChainSwapType,
5
- ChainType,
6
- ClaimEvent,
7
- InitializeEvent,
8
- RefundEvent,
9
- RelaySynchronizer,
10
- SwapData,
11
- BtcRelay, BitcoinRpcWithAddressIndex, SwapCommitState
12
- } from "@atomiqlabs/base";
13
- import {EventEmitter} from "events";
14
- import {Intermediary} from "../../../../intermediaries/Intermediary";
15
- import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
16
- import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
17
- import {Buffer} from "buffer";
18
- import {IntermediaryError} from "../../../../errors/IntermediaryError";
19
- import {SwapType} from "../../../../enums/SwapType";
20
- import {
21
- extendAbortController, mapArrayToObject,
22
- randomBytes,
23
- throwIfUndefined
24
- } from "../../../../utils/Utils";
25
- import { toOutputScript} from "../../../../utils/BitcoinUtils";
26
- import {FromBTCResponseType, IntermediaryAPI} from "../../../../intermediaries/apis/IntermediaryAPI";
27
- import {RequestError} from "../../../../errors/RequestError";
28
- import {BTC_NETWORK, TEST_NETWORK} from "@scure/btc-signer/utils";
29
- import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
30
- import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
31
- import {ISwap} from "../../../ISwap";
32
- import {IClaimableSwapWrapper} from "../../../IClaimableSwapWrapper";
33
- import {IFromBTCSelfInitDefinition} from "../IFromBTCSelfInitSwap";
34
- import {AmountData} from "../../../../types/AmountData";
35
- import {tryWithRetries} from "../../../../utils/RetryUtils";
36
- import {AllOptional} from "../../../../utils/TypeUtils";
37
- import {UserError} from "../../../../errors/UserError";
38
-
39
- export type FromBTCOptions = {
40
- /**
41
- * A flag to attach 0 watchtower fee to the swap, this would make the settlement unattractive for the watchtowers
42
- * and therefore automatic settlement for such swaps will not be possible, you will have to settle manually
43
- * with {@link FromBTCLNSwap.claim} or {@link FromBTCLNSwap.txsClaim} functions.
44
- */
45
- unsafeZeroWatchtowerFee?: boolean,
46
- /**
47
- * A safety factor to use when estimating the watchtower fee to attach to the swap (this has to cover the gas fee
48
- * of watchtowers settling the swap). A higher multiple here would mean that a swap is more attractive for
49
- * watchtowers to settle automatically.
50
- *
51
- * Uses a `1.5` multiple by default (i.e. the current network fee is multiplied by 1.5 and then used to estimate
52
- * the settlement gas fee cost).
53
- *
54
- * Also accepts `bigint` for legacy reasons.
55
- */
56
- feeSafetyFactor?: number | bigint,
57
-
58
- /**
59
- * @deprecated Removed as it is deemed not necessary
60
- */
61
- blockSafetyFactor?: number
62
- };
63
-
64
- export type FromBTCWrapperOptions = ISwapWrapperOptions & {
65
- safetyFactor: number,
66
- blocksTillTxConfirms: number,
67
- maxConfirmations: number,
68
- minSendWindow: number,
69
- bitcoinNetwork: BTC_NETWORK,
70
- bitcoinBlocktime: number
71
- };
72
-
73
- export type FromBTCDefinition<T extends ChainType> = IFromBTCSelfInitDefinition<T, FromBTCWrapper<T>, FromBTCSwap<T>>;
74
-
75
- /**
76
- * Legacy escrow (PrTLC) based swap for Bitcoin -> Smart chains, requires manual initiation
77
- * of the swap escrow on the destination chain.
78
- *
79
- * @category Swaps/Legacy/Bitcoin → Smart chain
80
- */
81
- export class FromBTCWrapper<
82
- T extends ChainType
83
- > extends IFromBTCWrapper<T, FromBTCDefinition<T>, FromBTCWrapperOptions> implements IClaimableSwapWrapper<FromBTCSwap<T>> {
84
- public readonly TYPE: SwapType.FROM_BTC = SwapType.FROM_BTC;
85
-
86
- /**
87
- * @internal
88
- */
89
- protected readonly tickSwapState = [FromBTCSwapState.PR_CREATED, FromBTCSwapState.CLAIM_COMMITED, FromBTCSwapState.EXPIRED];
90
-
91
- /**
92
- * @internal
93
- */
94
- readonly _pendingSwapStates = [
95
- FromBTCSwapState.PR_CREATED,
96
- FromBTCSwapState.QUOTE_SOFT_EXPIRED,
97
- FromBTCSwapState.CLAIM_COMMITED,
98
- FromBTCSwapState.BTC_TX_CONFIRMED,
99
- FromBTCSwapState.EXPIRED
100
- ];
101
- /**
102
- * @internal
103
- */
104
- readonly _claimableSwapStates = [FromBTCSwapState.BTC_TX_CONFIRMED];
105
- /**
106
- * @internal
107
- */
108
- readonly _swapDeserializer = FromBTCSwap;
109
- /**
110
- * @internal
111
- */
112
- readonly _synchronizer: (version?: string) => RelaySynchronizer<any, T["TX"], any> = (version?: string) => {
113
- const _version = version ?? "v1";
114
- const data = this.versionedSynchronizer[_version];
115
- if(data==null) throw new Error(`Invalid contract version ${_version} requested`);
116
- return data.synchronizer;
117
- };
118
-
119
- /**
120
- * @internal
121
- */
122
- readonly _btcRpc: BitcoinRpcWithAddressIndex<any>;
123
-
124
- private readonly btcRelay: (version?: string) => BtcRelay<any, T["TX"], any> = (version?: string) => {
125
- const _version = version ?? "v1";
126
- const data = this.versionedBtcRelay[_version];
127
- if(data==null) throw new Error(`Invalid contract version ${_version} requested`);
128
- return data.btcRelay;
129
- };
130
-
131
- private readonly versionedBtcRelay: {
132
- [version: string]: {
133
- btcRelay: BtcRelay<any, T["TX"], any>
134
- }
135
- }= {};
136
-
137
- private readonly versionedSynchronizer: {
138
- [version: string]: {
139
- synchronizer: RelaySynchronizer<any, T["TX"], any>
140
- }
141
- }= {};
142
-
143
- /**
144
- * @param chainIdentifier
145
- * @param unifiedStorage Storage interface for the current environment
146
- * @param unifiedChainEvents On-chain event listener
147
- * @param chain
148
- * @param prices Pricing to use
149
- * @param tokens
150
- * @param versionedContracts
151
- * @param versionedSynchronizer
152
- * @param btcRpc Bitcoin RPC which also supports getting transactions by txoHash
153
- * @param lpApi
154
- * @param options
155
- * @param events Instance to use for emitting events
156
- */
157
- constructor(
158
- chainIdentifier: string,
159
- unifiedStorage: UnifiedSwapStorage<T>,
160
- unifiedChainEvents: UnifiedSwapEventListener<T>,
161
- chain: T["ChainInterface"],
162
- prices: ISwapPrice,
163
- tokens: WrapperCtorTokens,
164
- versionedContracts: {
165
- [version: string]: {
166
- swapContract: T["Contract"],
167
- swapDataConstructor: new (data: any) => T["Data"],
168
- btcRelay: BtcRelay<any, T["TX"], any>
169
- }
170
- },
171
- versionedSynchronizer: {
172
- [version: string]: {
173
- synchronizer: RelaySynchronizer<any, T["TX"], any>
174
- }
175
- },
176
- btcRpc: BitcoinRpcWithAddressIndex<any>,
177
- lpApi: IntermediaryAPI,
178
- options?: AllOptional<FromBTCWrapperOptions>,
179
- events?: EventEmitter<{swapState: [ISwap]}>
180
- ) {
181
- super(
182
- chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, lpApi,
183
- {
184
- ...options,
185
- bitcoinNetwork: options?.bitcoinNetwork ?? TEST_NETWORK,
186
- safetyFactor: options?.safetyFactor ?? 2,
187
- blocksTillTxConfirms: options?.blocksTillTxConfirms ?? 12,
188
- maxConfirmations: options?.maxConfirmations ?? 6,
189
- minSendWindow: options?.minSendWindow ?? 30*60, //Minimum time window for user to send in the on-chain funds for From BTC swap
190
- bitcoinBlocktime: options?.bitcoinBlocktime ?? 10*60
191
- },
192
- versionedContracts,
193
- events
194
- );
195
- this._btcRpc = btcRpc;
196
- this.versionedBtcRelay = versionedContracts;
197
- this.versionedSynchronizer = versionedSynchronizer;
198
- }
199
-
200
- /**
201
- * @inheritDoc
202
- * @internal
203
- */
204
- protected processEventInitialize(swap: FromBTCSwap<T>, event: InitializeEvent<T["Data"]>): Promise<boolean> {
205
- if(swap._state===FromBTCSwapState.PR_CREATED || swap._state===FromBTCSwapState.QUOTE_SOFT_EXPIRED) {
206
- swap._state = FromBTCSwapState.CLAIM_COMMITED;
207
- return Promise.resolve(true);
208
- }
209
- return Promise.resolve(false);
210
- }
211
-
212
- /**
213
- * @inheritDoc
214
- * @internal
215
- */
216
- protected async processEventClaim(swap: FromBTCSwap<T>, event: ClaimEvent<T["Data"]>): Promise<boolean> {
217
- if(swap._state!==FromBTCSwapState.FAILED && swap._state!==FromBTCSwapState.CLAIM_CLAIMED) {
218
- await swap._setBitcoinTxId(Buffer.from(event.result, "hex").reverse().toString("hex")).catch(e => {
219
- this.logger.warn("processEventClaim(): Error setting bitcoin txId: ", e);
220
- });
221
- swap._state = FromBTCSwapState.CLAIM_CLAIMED;
222
- return true;
223
- }
224
- return false;
225
- }
226
-
227
- /**
228
- * @inheritDoc
229
- * @internal
230
- */
231
- protected processEventRefund(swap: FromBTCSwap<T>, event: RefundEvent<T["Data"]>): Promise<boolean> {
232
- if(swap._state!==FromBTCSwapState.CLAIM_CLAIMED && swap._state!==FromBTCSwapState.FAILED) {
233
- swap._state = FromBTCSwapState.FAILED;
234
- return Promise.resolve(true);
235
- }
236
- return Promise.resolve(false);
237
- }
238
-
239
- /**
240
- * Returns the swap expiry, leaving enough time for the user to send a transaction and for it to confirm
241
- *
242
- * @param data Swap data
243
- * @param requiredConfirmations Confirmations required on the bitcoin side to settle the swap
244
- *
245
- * @internal
246
- */
247
- _getOnchainSendTimeout(data: SwapData, requiredConfirmations: number): bigint {
248
- const tsDelta = (this._options.blocksTillTxConfirms + requiredConfirmations) * this._options.bitcoinBlocktime * this._options.safetyFactor;
249
- return data.getExpiry() - BigInt(tsDelta);
250
- }
251
-
252
- /**
253
- * Pre-fetches claimer (watchtower) bounty data for the swap. Doesn't throw, instead returns null and aborts the
254
- * provided abortController
255
- *
256
- * @param signer Smartchain signer address initiating the swap
257
- * @param amountData
258
- * @param options Options as passed to the swap creation function
259
- * @param abortController
260
- * @param contractVersion
261
- *
262
- * @private
263
- */
264
- private async preFetchClaimerBounty(
265
- signer: string,
266
- amountData: AmountData,
267
- options: {
268
- feeSafetyFactorPPM: bigint,
269
- blockSafetyFactor: bigint,
270
- unsafeZeroWatchtowerFee: boolean
271
- },
272
- abortController: AbortController,
273
- contractVersion: string
274
- ): Promise<{
275
- feePerBlock: bigint,
276
- safetyFactor: bigint,
277
- startTimestamp: bigint,
278
- addBlock: bigint,
279
- addFee: bigint
280
- } | undefined> {
281
- const startTimestamp = BigInt(Math.floor(Date.now()/1000));
282
-
283
- if(options.unsafeZeroWatchtowerFee) {
284
- return {
285
- feePerBlock: 0n,
286
- safetyFactor: options.blockSafetyFactor,
287
- startTimestamp: startTimestamp,
288
- addBlock: 0n,
289
- addFee: 0n
290
- }
291
- }
292
-
293
- const dummyAmount = BigInt(Math.floor(Math.random()* 0x1000000));
294
- const dummySwapData = await this._contract(contractVersion).createSwapData(
295
- ChainSwapType.CHAIN, signer, signer, amountData.token,
296
- dummyAmount, this._contract(contractVersion).getHashForOnchain(randomBytes(20), dummyAmount, 3).toString("hex"),
297
- this.getRandomSequence(), startTimestamp, false, true,
298
- BigInt(Math.floor(Math.random() * 0x10000)), BigInt(Math.floor(Math.random() * 0x10000))
299
- );
300
-
301
- try {
302
- const [feePerBlock, btcRelayData, currentBtcBlock, claimFeeRate] = await Promise.all([
303
- this.btcRelay(contractVersion).getFeePerBlock(),
304
- this.btcRelay(contractVersion).getTipData(),
305
- this._btcRpc.getTipHeight(),
306
- this._contract(contractVersion).getClaimFee(signer, dummySwapData)
307
- ]);
308
-
309
- if(btcRelayData==null) throw new Error("Btc relay not initialized!");
310
-
311
- const currentBtcRelayBlock = btcRelayData.blockheight;
312
- const addBlock = Math.max(currentBtcBlock-currentBtcRelayBlock, 0);
313
- return {
314
- feePerBlock: feePerBlock * options.feeSafetyFactorPPM / 1_000_000n,
315
- safetyFactor: options.blockSafetyFactor,
316
- startTimestamp: startTimestamp,
317
- addBlock: BigInt(addBlock),
318
- addFee: claimFeeRate * options.feeSafetyFactorPPM / 1_000_000n
319
- }
320
- } catch (e) {
321
- abortController.abort(e);
322
- return undefined;
323
- }
324
- }
325
-
326
- /**
327
- * Returns calculated claimer bounty calculated from the claimer bounty data as fetched from preFetchClaimerBounty()
328
- *
329
- * @param data Parsed swap data returned from the intermediary
330
- * @param options Options as passed to the swap creation function
331
- * @param claimerBounty Claimer bounty data as fetched from {@link preFetchClaimerBounty} function
332
- *
333
- * @private
334
- */
335
- private getClaimerBounty(
336
- data: T["Data"],
337
- options: {
338
- blockSafetyFactor: bigint
339
- },
340
- claimerBounty: {
341
- feePerBlock: bigint,
342
- safetyFactor: bigint,
343
- startTimestamp: bigint,
344
- addBlock: bigint,
345
- addFee: bigint
346
- }
347
- ) : bigint {
348
- const tsDelta = data.getExpiry() - claimerBounty.startTimestamp;
349
- const blocksDelta = tsDelta / BigInt(this._options.bitcoinBlocktime) * options.blockSafetyFactor;
350
- const totalBlock = blocksDelta + claimerBounty.addBlock;
351
- return claimerBounty.addFee + (totalBlock * claimerBounty.feePerBlock);
352
- }
353
-
354
- /**
355
- * Verifies response returned from intermediary
356
- *
357
- * @param signer
358
- * @param resp Response as returned by the intermediary
359
- * @param amountData
360
- * @param lp Intermediary
361
- * @param options Options as passed to the swap creation function
362
- * @param data Parsed swap data returned by the intermediary
363
- * @param sequence Required swap sequence
364
- * @param claimerBounty Claimer bount data as returned from the preFetchClaimerBounty() pre-fetch promise
365
- * @param depositToken
366
- *
367
- * @throws {IntermediaryError} in case the response is invalid
368
- *
369
- * @private
370
- */
371
- private verifyReturnedData(
372
- signer: string,
373
- resp: FromBTCResponseType,
374
- amountData: AmountData,
375
- lp: Intermediary,
376
- options: {
377
- blockSafetyFactor: bigint
378
- },
379
- data: T["Data"],
380
- sequence: bigint,
381
- claimerBounty: {
382
- feePerBlock: bigint,
383
- safetyFactor: bigint,
384
- startTimestamp: bigint,
385
- addBlock: bigint,
386
- addFee: bigint
387
- },
388
- depositToken: string
389
- ): void {
390
- if(amountData.exactIn) {
391
- if(resp.amount !== amountData.amount) throw new IntermediaryError("Invalid amount returned");
392
- } else {
393
- if(resp.total !== amountData.amount) throw new IntermediaryError("Invalid total returned");
394
- }
395
-
396
- const requiredConfirmations = resp.confirmations;
397
- if(requiredConfirmations>this._options.maxConfirmations) throw new IntermediaryError("Requires too many confirmations");
398
-
399
- const totalClaimerBounty = this.getClaimerBounty(data, options, claimerBounty);
400
-
401
- if(
402
- data.getClaimerBounty() !== totalClaimerBounty ||
403
- data.getType()!=ChainSwapType.CHAIN ||
404
- data.getSequence() !== sequence ||
405
- data.getAmount() !== resp.total ||
406
- data.isPayIn() ||
407
- !data.isToken(amountData.token) ||
408
- !data.isOfferer(lp.getAddress(this.chainIdentifier)) ||
409
- !data.isClaimer(signer) ||
410
- !data.isDepositToken(depositToken) ||
411
- data.hasSuccessAction()
412
- ) {
413
- throw new IntermediaryError("Invalid data returned");
414
- }
415
-
416
- //Check that we have enough time to send the TX and for it to confirm
417
- const expiry = this._getOnchainSendTimeout(data, requiredConfirmations);
418
- const currentTimestamp = BigInt(Math.floor(Date.now()/1000));
419
- if((expiry - currentTimestamp) < BigInt(this._options.minSendWindow)) {
420
- throw new IntermediaryError("Send window too low");
421
- }
422
-
423
- const version = lp.getContractVersion(this.chainIdentifier);
424
-
425
- const lockingScript = toOutputScript(this._options.bitcoinNetwork, resp.btcAddress);
426
- const desiredExtraData = this._contract(version).getExtraData(lockingScript, resp.amount, requiredConfirmations);
427
- const desiredClaimHash = this._contract(version).getHashForOnchain(lockingScript, resp.amount, requiredConfirmations);
428
- if(!desiredClaimHash.equals(Buffer.from(data.getClaimHash(), "hex"))) {
429
- throw new IntermediaryError("Invalid claim hash returned!");
430
- }
431
- const extraData = data.getExtraData();
432
- if(extraData==null || !desiredExtraData.equals(Buffer.from(extraData, "hex"))) {
433
- throw new IntermediaryError("Invalid extra data returned!");
434
- }
435
- }
436
-
437
- /**
438
- * Returns a newly created legacy Bitcoin -> Smart chain swap using the PrTLC based escrow swap protocol,
439
- * with the passed amount.
440
- *
441
- * @param recipient Smart chain signer's address on the destination chain
442
- * @param amountData Amount, token and exact input/output data for to swap
443
- * @param lps An array of intermediaries (LPs) to get the quotes from
444
- * @param options Optional additional quote options
445
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
446
- * @param abortSignal Abort signal
447
- */
448
- create(
449
- recipient: string,
450
- amountData: AmountData,
451
- lps: Intermediary[],
452
- options?: FromBTCOptions,
453
- additionalParams?: Record<string, any>,
454
- abortSignal?: AbortSignal
455
- ): {
456
- quote: Promise<FromBTCSwap<T>>,
457
- intermediary: Intermediary
458
- }[] {
459
- let feeSafetyFactorPPM: bigint = 1_500_000n;
460
- if(typeof(options?.feeSafetyFactor)==="bigint") {
461
- feeSafetyFactorPPM = options.feeSafetyFactor * 1_000_000n;
462
- } else if(typeof(options?.feeSafetyFactor)==="number") {
463
- feeSafetyFactorPPM = BigInt(Math.floor(options.feeSafetyFactor * 1_000_000));
464
- }
465
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
466
-
467
- const _options = {
468
- blockSafetyFactor: options?.blockSafetyFactor!=null ? BigInt(options.blockSafetyFactor) : 1n,
469
- feeSafetyFactorPPM,
470
- unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false
471
- };
472
-
473
- const sequence: bigint = this.getRandomSequence();
474
-
475
- const _abortController = extendAbortController(abortSignal);
476
- const pricePrefetchPromise: Promise<bigint | undefined> = this.preFetchPrice(amountData, _abortController.signal);
477
- const usdPricePrefetchPromise: Promise<number | undefined> = this.preFetchUsdPrice(_abortController.signal);
478
- const claimerBountyPrefetchPromise = mapArrayToObject(lpVersions, (contractVersion: string) => {
479
- return this.preFetchClaimerBounty(recipient, amountData, _options, _abortController, contractVersion);
480
- });
481
- const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
482
- const feeRatePromise = this.preFetchFeeRate(recipient, amountData, undefined, _abortController, lpVersions);
483
-
484
- const _signDataPromise = mapArrayToObject(lpVersions, (contractVersion: string) => {
485
- return this._contract(contractVersion).preFetchBlockDataForSignatures == null ?
486
- this.preFetchSignData(Promise.resolve(true), contractVersion) :
487
- undefined;
488
- });
489
-
490
- return lps.map(lp => {
491
- return {
492
- intermediary: lp,
493
- quote: (async () => {
494
- if(lp.services[SwapType.FROM_BTC]==null) throw new Error("LP service for processing from btc swaps not found!");
495
- const version = lp.getContractVersion(this.chainIdentifier);
496
-
497
- const abortController = extendAbortController(_abortController.signal);
498
- const liquidityPromise: Promise<bigint | undefined> = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
499
-
500
- try {
501
- const {signDataPromise, resp} = await tryWithRetries(async(retryCount: number) => {
502
- const {signDataPrefetch, response} = this._lpApi.initFromBTC(
503
- this.chainIdentifier, lp.url, nativeTokenAddress,
504
- {
505
- claimer: recipient,
506
- amount: amountData.amount,
507
- token: amountData.token.toString(),
508
-
509
- exactOut: !amountData.exactIn,
510
- sequence,
511
-
512
- claimerBounty: throwIfUndefined(claimerBountyPrefetchPromise[version], "Watchtower fee pre-fetch failed!"),
513
- feeRate: throwIfUndefined(feeRatePromise[version], "Network fee rate pre-fetch failed!"),
514
- additionalParams
515
- },
516
- this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined
517
- );
518
-
519
- let signDataPromise = _signDataPromise[version];
520
- if(signDataPromise==null) {
521
- signDataPromise = this.preFetchSignData(signDataPrefetch, version);
522
- } else signDataPrefetch.catch(() => {});
523
-
524
- return {
525
- signDataPromise,
526
- resp: await response
527
- };
528
- }, undefined, e => e instanceof RequestError, abortController.signal);
529
-
530
- const data: T["Data"] = new (this._swapDataDeserializer(version))(resp.data);
531
- data.setClaimer(recipient);
532
-
533
- const swapFeeBtc = resp.swapFee * resp.amount / (data.getAmount() + resp.swapFee);
534
-
535
- this.verifyReturnedData(recipient, resp, amountData, lp, _options, data, sequence, (await claimerBountyPrefetchPromise[version])!, nativeTokenAddress);
536
- const [pricingInfo, signatureExpiry] = await Promise.all([
537
- //Get intermediary's liquidity
538
- this.verifyReturnedPrice(
539
- lp.services[SwapType.FROM_BTC], false, resp.amount, resp.total,
540
- amountData.token, {swapFeeBtc}, pricePrefetchPromise, usdPricePrefetchPromise, abortController.signal
541
- ),
542
- this.verifyReturnedSignature(recipient, data, resp, feeRatePromise[version], signDataPromise, version, abortController.signal),
543
- this.verifyIntermediaryLiquidity(data.getAmount(), throwIfUndefined(liquidityPromise, "LP liquidity pre-fetch failed!")),
544
- ]);
545
-
546
- const quote = new FromBTCSwap<T>(this, {
547
- pricingInfo,
548
- url: lp.url,
549
- expiry: signatureExpiry,
550
- swapFee: resp.swapFee,
551
- swapFeeBtc,
552
- feeRate: (await feeRatePromise[version])!,
553
- signatureData: resp,
554
- data,
555
- address: resp.btcAddress,
556
- amount: resp.amount,
557
- exactIn: amountData.exactIn ?? true,
558
- requiredConfirmations: resp.confirmations,
559
- contractVersion: version
560
- } as FromBTCSwapInit<T["Data"]>);
561
- return quote;
562
- } catch (e) {
563
- abortController.abort(e);
564
- throw e;
565
- }
566
- })()
567
- }
568
- });
569
- }
570
-
571
- /**
572
- * @inheritDoc
573
- */
574
- async recoverFromSwapDataAndState(
575
- init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
576
- state: SwapCommitState,
577
- contractVersion: string,
578
- lp?: Intermediary
579
- ): Promise<FromBTCSwap<T> | null> {
580
- const data = init.data;
581
-
582
- const swapInit: FromBTCSwapInit<T["Data"]> = {
583
- pricingInfo: {
584
- isValid: true,
585
- satsBaseFee: 0n,
586
- swapPriceUSatPerToken: 100_000_000_000_000n,
587
- realPriceUSatPerToken: 100_000_000_000_000n,
588
- differencePPM: 0n,
589
- feePPM: 0n,
590
- },
591
- url: lp?.url,
592
- expiry: 0,
593
- swapFee: 0n,
594
- swapFeeBtc: 0n,
595
- feeRate: "",
596
- signatureData: undefined,
597
- data,
598
- exactIn: false,
599
- contractVersion
600
- }
601
- const swap = new FromBTCSwap(this, swapInit);
602
- swap._commitTxId = await init.getInitTxId();
603
- const blockData = await init.getTxBlock();
604
- swap.createdAt = blockData.blockTime * 1000;
605
- swap._setInitiated();
606
- swap._state = FromBTCSwapState.CLAIM_COMMITED;
607
- await swap._sync(false, false, state);
608
- await swap._save();
609
- return swap;
610
- }
611
-
612
- }
1
+ import {IFromBTCWrapper} from "../IFromBTCWrapper";
2
+ import {FromBTCSwap, FromBTCSwapInit, FromBTCSwapState} from "./FromBTCSwap";
3
+ import {
4
+ ChainSwapType,
5
+ ChainType,
6
+ ClaimEvent,
7
+ InitializeEvent,
8
+ RefundEvent,
9
+ RelaySynchronizer,
10
+ SwapData,
11
+ BtcRelay, BitcoinRpcWithAddressIndex, SwapCommitState
12
+ } from "@atomiqlabs/base";
13
+ import {EventEmitter} from "events";
14
+ import {Intermediary} from "../../../../intermediaries/Intermediary";
15
+ import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
16
+ import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
17
+ import {Buffer} from "buffer";
18
+ import {IntermediaryError} from "../../../../errors/IntermediaryError";
19
+ import {SwapType} from "../../../../enums/SwapType";
20
+ import {
21
+ extendAbortController, mapArrayToObject,
22
+ randomBytes,
23
+ throwIfUndefined
24
+ } from "../../../../utils/Utils";
25
+ import { toOutputScript} from "../../../../utils/BitcoinUtils";
26
+ import {FromBTCResponseType, IntermediaryAPI} from "../../../../intermediaries/apis/IntermediaryAPI";
27
+ import {RequestError} from "../../../../errors/RequestError";
28
+ import {BTC_NETWORK, TEST_NETWORK} from "@scure/btc-signer/utils";
29
+ import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
30
+ import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
31
+ import {ISwap} from "../../../ISwap";
32
+ import {IClaimableSwapWrapper} from "../../../IClaimableSwapWrapper";
33
+ import {IFromBTCSelfInitDefinition} from "../IFromBTCSelfInitSwap";
34
+ import {AmountData} from "../../../../types/AmountData";
35
+ import {tryWithRetries} from "../../../../utils/RetryUtils";
36
+ import {AllOptional} from "../../../../utils/TypeUtils";
37
+ import {UserError} from "../../../../errors/UserError";
38
+
39
+ export type FromBTCOptions = {
40
+ /**
41
+ * A flag to attach 0 watchtower fee to the swap, this would make the settlement unattractive for the watchtowers
42
+ * and therefore automatic settlement for such swaps will not be possible, you will have to settle manually
43
+ * with {@link FromBTCLNSwap.claim} or {@link FromBTCLNSwap.txsClaim} functions.
44
+ */
45
+ unsafeZeroWatchtowerFee?: boolean,
46
+ /**
47
+ * A safety factor to use when estimating the watchtower fee to attach to the swap (this has to cover the gas fee
48
+ * of watchtowers settling the swap). A higher multiple here would mean that a swap is more attractive for
49
+ * watchtowers to settle automatically.
50
+ *
51
+ * Uses a `1.5` multiple by default (i.e. the current network fee is multiplied by 1.5 and then used to estimate
52
+ * the settlement gas fee cost).
53
+ *
54
+ * Also accepts `bigint` for legacy reasons.
55
+ */
56
+ feeSafetyFactor?: number | bigint,
57
+
58
+ /**
59
+ * @deprecated Removed as it is deemed not necessary
60
+ */
61
+ blockSafetyFactor?: number
62
+ };
63
+
64
+ export type FromBTCWrapperOptions = ISwapWrapperOptions & {
65
+ safetyFactor: number,
66
+ blocksTillTxConfirms: number,
67
+ maxConfirmations: number,
68
+ minSendWindow: number,
69
+ bitcoinNetwork: BTC_NETWORK,
70
+ bitcoinBlocktime: number
71
+ };
72
+
73
+ export type FromBTCDefinition<T extends ChainType> = IFromBTCSelfInitDefinition<T, FromBTCWrapper<T>, FromBTCSwap<T>>;
74
+
75
+ /**
76
+ * Legacy escrow (PrTLC) based swap for Bitcoin -> Smart chains, requires manual initiation
77
+ * of the swap escrow on the destination chain.
78
+ *
79
+ * @category Swaps/Legacy/Bitcoin → Smart chain
80
+ */
81
+ export class FromBTCWrapper<
82
+ T extends ChainType
83
+ > extends IFromBTCWrapper<T, FromBTCDefinition<T>, FromBTCWrapperOptions> implements IClaimableSwapWrapper<FromBTCSwap<T>> {
84
+ public readonly TYPE: SwapType.FROM_BTC = SwapType.FROM_BTC;
85
+
86
+ /**
87
+ * @internal
88
+ */
89
+ protected readonly tickSwapState = [FromBTCSwapState.PR_CREATED, FromBTCSwapState.CLAIM_COMMITED, FromBTCSwapState.EXPIRED];
90
+
91
+ /**
92
+ * @internal
93
+ */
94
+ readonly _pendingSwapStates = [
95
+ FromBTCSwapState.PR_CREATED,
96
+ FromBTCSwapState.QUOTE_SOFT_EXPIRED,
97
+ FromBTCSwapState.CLAIM_COMMITED,
98
+ FromBTCSwapState.BTC_TX_CONFIRMED,
99
+ FromBTCSwapState.EXPIRED
100
+ ];
101
+ /**
102
+ * @internal
103
+ */
104
+ readonly _claimableSwapStates = [FromBTCSwapState.BTC_TX_CONFIRMED];
105
+ /**
106
+ * @internal
107
+ */
108
+ readonly _swapDeserializer = FromBTCSwap;
109
+ /**
110
+ * @internal
111
+ */
112
+ readonly _synchronizer: (version?: string) => RelaySynchronizer<any, T["TX"], any> = (version?: string) => {
113
+ const _version = version ?? "v1";
114
+ const data = this.versionedSynchronizer[_version];
115
+ if(data==null) throw new Error(`Invalid contract version ${_version} requested`);
116
+ return data.synchronizer;
117
+ };
118
+
119
+ /**
120
+ * @internal
121
+ */
122
+ readonly _btcRpc: BitcoinRpcWithAddressIndex<any>;
123
+
124
+ private readonly btcRelay: (version?: string) => BtcRelay<any, T["TX"], any> = (version?: string) => {
125
+ const _version = version ?? "v1";
126
+ const data = this.versionedBtcRelay[_version];
127
+ if(data==null) throw new Error(`Invalid contract version ${_version} requested`);
128
+ return data.btcRelay;
129
+ };
130
+
131
+ private readonly versionedBtcRelay: {
132
+ [version: string]: {
133
+ btcRelay: BtcRelay<any, T["TX"], any>
134
+ }
135
+ }= {};
136
+
137
+ private readonly versionedSynchronizer: {
138
+ [version: string]: {
139
+ synchronizer: RelaySynchronizer<any, T["TX"], any>
140
+ }
141
+ }= {};
142
+
143
+ /**
144
+ * @param chainIdentifier
145
+ * @param unifiedStorage Storage interface for the current environment
146
+ * @param unifiedChainEvents On-chain event listener
147
+ * @param chain
148
+ * @param prices Pricing to use
149
+ * @param tokens
150
+ * @param versionedContracts
151
+ * @param versionedSynchronizer
152
+ * @param btcRpc Bitcoin RPC which also supports getting transactions by txoHash
153
+ * @param lpApi
154
+ * @param options
155
+ * @param events Instance to use for emitting events
156
+ */
157
+ constructor(
158
+ chainIdentifier: string,
159
+ unifiedStorage: UnifiedSwapStorage<T>,
160
+ unifiedChainEvents: UnifiedSwapEventListener<T>,
161
+ chain: T["ChainInterface"],
162
+ prices: ISwapPrice,
163
+ tokens: WrapperCtorTokens,
164
+ versionedContracts: {
165
+ [version: string]: {
166
+ swapContract: T["Contract"],
167
+ swapDataConstructor: new (data: any) => T["Data"],
168
+ btcRelay: BtcRelay<any, T["TX"], any>
169
+ }
170
+ },
171
+ versionedSynchronizer: {
172
+ [version: string]: {
173
+ synchronizer: RelaySynchronizer<any, T["TX"], any>
174
+ }
175
+ },
176
+ btcRpc: BitcoinRpcWithAddressIndex<any>,
177
+ lpApi: IntermediaryAPI,
178
+ options?: AllOptional<FromBTCWrapperOptions>,
179
+ events?: EventEmitter<{swapState: [ISwap]}>
180
+ ) {
181
+ super(
182
+ chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, lpApi,
183
+ {
184
+ ...options,
185
+ bitcoinNetwork: options?.bitcoinNetwork ?? TEST_NETWORK,
186
+ safetyFactor: options?.safetyFactor ?? 2,
187
+ blocksTillTxConfirms: options?.blocksTillTxConfirms ?? 12,
188
+ maxConfirmations: options?.maxConfirmations ?? 6,
189
+ minSendWindow: options?.minSendWindow ?? 30*60, //Minimum time window for user to send in the on-chain funds for From BTC swap
190
+ bitcoinBlocktime: options?.bitcoinBlocktime ?? 10*60
191
+ },
192
+ versionedContracts,
193
+ events
194
+ );
195
+ this._btcRpc = btcRpc;
196
+ this.versionedBtcRelay = versionedContracts;
197
+ this.versionedSynchronizer = versionedSynchronizer;
198
+ }
199
+
200
+ /**
201
+ * @inheritDoc
202
+ * @internal
203
+ */
204
+ protected processEventInitialize(swap: FromBTCSwap<T>, event: InitializeEvent<T["Data"]>): Promise<boolean> {
205
+ if(swap._state===FromBTCSwapState.PR_CREATED || swap._state===FromBTCSwapState.QUOTE_SOFT_EXPIRED) {
206
+ swap._state = FromBTCSwapState.CLAIM_COMMITED;
207
+ return Promise.resolve(true);
208
+ }
209
+ return Promise.resolve(false);
210
+ }
211
+
212
+ /**
213
+ * @inheritDoc
214
+ * @internal
215
+ */
216
+ protected async processEventClaim(swap: FromBTCSwap<T>, event: ClaimEvent<T["Data"]>): Promise<boolean> {
217
+ if(swap._state!==FromBTCSwapState.FAILED && swap._state!==FromBTCSwapState.CLAIM_CLAIMED) {
218
+ await swap._setBitcoinTxId(Buffer.from(event.result, "hex").reverse().toString("hex")).catch(e => {
219
+ this.logger.warn("processEventClaim(): Error setting bitcoin txId: ", e);
220
+ });
221
+ swap._state = FromBTCSwapState.CLAIM_CLAIMED;
222
+ return true;
223
+ }
224
+ return false;
225
+ }
226
+
227
+ /**
228
+ * @inheritDoc
229
+ * @internal
230
+ */
231
+ protected processEventRefund(swap: FromBTCSwap<T>, event: RefundEvent<T["Data"]>): Promise<boolean> {
232
+ if(swap._state!==FromBTCSwapState.CLAIM_CLAIMED && swap._state!==FromBTCSwapState.FAILED) {
233
+ swap._state = FromBTCSwapState.FAILED;
234
+ return Promise.resolve(true);
235
+ }
236
+ return Promise.resolve(false);
237
+ }
238
+
239
+ /**
240
+ * Returns the swap expiry, leaving enough time for the user to send a transaction and for it to confirm
241
+ *
242
+ * @param data Swap data
243
+ * @param requiredConfirmations Confirmations required on the bitcoin side to settle the swap
244
+ *
245
+ * @internal
246
+ */
247
+ _getOnchainSendTimeout(data: SwapData, requiredConfirmations: number): bigint {
248
+ const tsDelta = (this._options.blocksTillTxConfirms + requiredConfirmations) * this._options.bitcoinBlocktime * this._options.safetyFactor;
249
+ return data.getExpiry() - BigInt(tsDelta);
250
+ }
251
+
252
+ /**
253
+ * Pre-fetches claimer (watchtower) bounty data for the swap. Doesn't throw, instead returns null and aborts the
254
+ * provided abortController
255
+ *
256
+ * @param signer Smartchain signer address initiating the swap
257
+ * @param amountData
258
+ * @param options Options as passed to the swap creation function
259
+ * @param abortController
260
+ * @param contractVersion
261
+ *
262
+ * @private
263
+ */
264
+ private async preFetchClaimerBounty(
265
+ signer: string,
266
+ amountData: AmountData,
267
+ options: {
268
+ feeSafetyFactorPPM: bigint,
269
+ blockSafetyFactor: bigint,
270
+ unsafeZeroWatchtowerFee: boolean
271
+ },
272
+ abortController: AbortController,
273
+ contractVersion: string
274
+ ): Promise<{
275
+ feePerBlock: bigint,
276
+ safetyFactor: bigint,
277
+ startTimestamp: bigint,
278
+ addBlock: bigint,
279
+ addFee: bigint
280
+ } | undefined> {
281
+ const startTimestamp = BigInt(Math.floor(Date.now()/1000));
282
+
283
+ if(options.unsafeZeroWatchtowerFee) {
284
+ return {
285
+ feePerBlock: 0n,
286
+ safetyFactor: options.blockSafetyFactor,
287
+ startTimestamp: startTimestamp,
288
+ addBlock: 0n,
289
+ addFee: 0n
290
+ }
291
+ }
292
+
293
+ const dummyAmount = BigInt(Math.floor(Math.random()* 0x1000000));
294
+ const dummySwapData = await this._contract(contractVersion).createSwapData(
295
+ ChainSwapType.CHAIN, signer, signer, amountData.token,
296
+ dummyAmount, this._contract(contractVersion).getHashForOnchain(randomBytes(20), dummyAmount, 3).toString("hex"),
297
+ this.getRandomSequence(), startTimestamp, false, true,
298
+ BigInt(Math.floor(Math.random() * 0x10000)), BigInt(Math.floor(Math.random() * 0x10000))
299
+ );
300
+
301
+ try {
302
+ const [feePerBlock, btcRelayData, currentBtcBlock, claimFeeRate] = await Promise.all([
303
+ this.btcRelay(contractVersion).getFeePerBlock(),
304
+ this.btcRelay(contractVersion).getTipData(),
305
+ this._btcRpc.getTipHeight(),
306
+ this._contract(contractVersion).getClaimFee(signer, dummySwapData)
307
+ ]);
308
+
309
+ if(btcRelayData==null) throw new Error("Btc relay not initialized!");
310
+
311
+ const currentBtcRelayBlock = btcRelayData.blockheight;
312
+ const addBlock = Math.max(currentBtcBlock-currentBtcRelayBlock, 0);
313
+ return {
314
+ feePerBlock: feePerBlock * options.feeSafetyFactorPPM / 1_000_000n,
315
+ safetyFactor: options.blockSafetyFactor,
316
+ startTimestamp: startTimestamp,
317
+ addBlock: BigInt(addBlock),
318
+ addFee: claimFeeRate * options.feeSafetyFactorPPM / 1_000_000n
319
+ }
320
+ } catch (e) {
321
+ abortController.abort(e);
322
+ return undefined;
323
+ }
324
+ }
325
+
326
+ /**
327
+ * Returns calculated claimer bounty calculated from the claimer bounty data as fetched from preFetchClaimerBounty()
328
+ *
329
+ * @param data Parsed swap data returned from the intermediary
330
+ * @param options Options as passed to the swap creation function
331
+ * @param claimerBounty Claimer bounty data as fetched from {@link preFetchClaimerBounty} function
332
+ *
333
+ * @private
334
+ */
335
+ private getClaimerBounty(
336
+ data: T["Data"],
337
+ options: {
338
+ blockSafetyFactor: bigint
339
+ },
340
+ claimerBounty: {
341
+ feePerBlock: bigint,
342
+ safetyFactor: bigint,
343
+ startTimestamp: bigint,
344
+ addBlock: bigint,
345
+ addFee: bigint
346
+ }
347
+ ) : bigint {
348
+ const tsDelta = data.getExpiry() - claimerBounty.startTimestamp;
349
+ const blocksDelta = tsDelta / BigInt(this._options.bitcoinBlocktime) * options.blockSafetyFactor;
350
+ const totalBlock = blocksDelta + claimerBounty.addBlock;
351
+ return claimerBounty.addFee + (totalBlock * claimerBounty.feePerBlock);
352
+ }
353
+
354
+ /**
355
+ * Verifies response returned from intermediary
356
+ *
357
+ * @param signer
358
+ * @param resp Response as returned by the intermediary
359
+ * @param amountData
360
+ * @param lp Intermediary
361
+ * @param options Options as passed to the swap creation function
362
+ * @param data Parsed swap data returned by the intermediary
363
+ * @param sequence Required swap sequence
364
+ * @param claimerBounty Claimer bount data as returned from the preFetchClaimerBounty() pre-fetch promise
365
+ * @param depositToken
366
+ *
367
+ * @throws {IntermediaryError} in case the response is invalid
368
+ *
369
+ * @private
370
+ */
371
+ private verifyReturnedData(
372
+ signer: string,
373
+ resp: FromBTCResponseType,
374
+ amountData: AmountData,
375
+ lp: Intermediary,
376
+ options: {
377
+ blockSafetyFactor: bigint
378
+ },
379
+ data: T["Data"],
380
+ sequence: bigint,
381
+ claimerBounty: {
382
+ feePerBlock: bigint,
383
+ safetyFactor: bigint,
384
+ startTimestamp: bigint,
385
+ addBlock: bigint,
386
+ addFee: bigint
387
+ },
388
+ depositToken: string
389
+ ): void {
390
+ if(amountData.exactIn) {
391
+ if(resp.amount !== amountData.amount) throw new IntermediaryError("Invalid amount returned");
392
+ } else {
393
+ if(resp.total !== amountData.amount) throw new IntermediaryError("Invalid total returned");
394
+ }
395
+
396
+ const requiredConfirmations = resp.confirmations;
397
+ if(requiredConfirmations>this._options.maxConfirmations) throw new IntermediaryError("Requires too many confirmations");
398
+
399
+ const totalClaimerBounty = this.getClaimerBounty(data, options, claimerBounty);
400
+
401
+ if(
402
+ data.getClaimerBounty() !== totalClaimerBounty ||
403
+ data.getType()!=ChainSwapType.CHAIN ||
404
+ data.getSequence() !== sequence ||
405
+ data.getAmount() !== resp.total ||
406
+ data.isPayIn() ||
407
+ !data.isToken(amountData.token) ||
408
+ !data.isOfferer(lp.getAddress(this.chainIdentifier)) ||
409
+ !data.isClaimer(signer) ||
410
+ !data.isDepositToken(depositToken) ||
411
+ data.hasSuccessAction()
412
+ ) {
413
+ throw new IntermediaryError("Invalid data returned");
414
+ }
415
+
416
+ //Check that we have enough time to send the TX and for it to confirm
417
+ const expiry = this._getOnchainSendTimeout(data, requiredConfirmations);
418
+ const currentTimestamp = BigInt(Math.floor(Date.now()/1000));
419
+ if((expiry - currentTimestamp) < BigInt(this._options.minSendWindow)) {
420
+ throw new IntermediaryError("Send window too low");
421
+ }
422
+
423
+ const version = lp.getContractVersion(this.chainIdentifier);
424
+
425
+ const lockingScript = toOutputScript(this._options.bitcoinNetwork, resp.btcAddress);
426
+ const desiredExtraData = this._contract(version).getExtraData(lockingScript, resp.amount, requiredConfirmations);
427
+ const desiredClaimHash = this._contract(version).getHashForOnchain(lockingScript, resp.amount, requiredConfirmations);
428
+ if(!desiredClaimHash.equals(Buffer.from(data.getClaimHash(), "hex"))) {
429
+ throw new IntermediaryError("Invalid claim hash returned!");
430
+ }
431
+ const extraData = data.getExtraData();
432
+ if(extraData==null || !desiredExtraData.equals(Buffer.from(extraData, "hex"))) {
433
+ throw new IntermediaryError("Invalid extra data returned!");
434
+ }
435
+ }
436
+
437
+ /**
438
+ * Returns a newly created legacy Bitcoin -> Smart chain swap using the PrTLC based escrow swap protocol,
439
+ * with the passed amount.
440
+ *
441
+ * @param recipient Smart chain signer's address on the destination chain
442
+ * @param amountData Amount, token and exact input/output data for to swap
443
+ * @param lps An array of intermediaries (LPs) to get the quotes from
444
+ * @param options Optional additional quote options
445
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
446
+ * @param abortSignal Abort signal
447
+ */
448
+ create(
449
+ recipient: string,
450
+ amountData: AmountData,
451
+ lps: Intermediary[],
452
+ options?: FromBTCOptions,
453
+ additionalParams?: Record<string, any>,
454
+ abortSignal?: AbortSignal
455
+ ): {
456
+ quote: Promise<FromBTCSwap<T>>,
457
+ intermediary: Intermediary
458
+ }[] {
459
+ let feeSafetyFactorPPM: bigint = 1_500_000n;
460
+ if(typeof(options?.feeSafetyFactor)==="bigint") {
461
+ feeSafetyFactorPPM = options.feeSafetyFactor * 1_000_000n;
462
+ } else if(typeof(options?.feeSafetyFactor)==="number") {
463
+ feeSafetyFactorPPM = BigInt(Math.floor(options.feeSafetyFactor * 1_000_000));
464
+ }
465
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
466
+
467
+ const _options = {
468
+ blockSafetyFactor: options?.blockSafetyFactor!=null ? BigInt(options.blockSafetyFactor) : 1n,
469
+ feeSafetyFactorPPM,
470
+ unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false
471
+ };
472
+
473
+ const sequence: bigint = this.getRandomSequence();
474
+
475
+ const _abortController = extendAbortController(abortSignal);
476
+ const pricePrefetchPromise: Promise<bigint | undefined> = this.preFetchPrice(amountData, _abortController.signal);
477
+ const usdPricePrefetchPromise: Promise<number | undefined> = this.preFetchUsdPrice(_abortController.signal);
478
+ const claimerBountyPrefetchPromise = mapArrayToObject(lpVersions, (contractVersion: string) => {
479
+ return this.preFetchClaimerBounty(recipient, amountData, _options, _abortController, contractVersion);
480
+ });
481
+ const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
482
+ const feeRatePromise = this.preFetchFeeRate(recipient, amountData, undefined, _abortController, lpVersions);
483
+
484
+ const _signDataPromise = mapArrayToObject(lpVersions, (contractVersion: string) => {
485
+ return this._contract(contractVersion).preFetchBlockDataForSignatures == null ?
486
+ this.preFetchSignData(Promise.resolve(true), contractVersion) :
487
+ undefined;
488
+ });
489
+
490
+ return lps.map(lp => {
491
+ return {
492
+ intermediary: lp,
493
+ quote: (async () => {
494
+ if(lp.services[SwapType.FROM_BTC]==null) throw new Error("LP service for processing from btc swaps not found!");
495
+ const version = lp.getContractVersion(this.chainIdentifier);
496
+
497
+ const abortController = extendAbortController(_abortController.signal);
498
+ const liquidityPromise: Promise<bigint | undefined> = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
499
+
500
+ try {
501
+ const {signDataPromise, resp} = await tryWithRetries(async(retryCount: number) => {
502
+ const {signDataPrefetch, response} = this._lpApi.initFromBTC(
503
+ this.chainIdentifier, lp.url, nativeTokenAddress,
504
+ {
505
+ claimer: recipient,
506
+ amount: amountData.amount,
507
+ token: amountData.token.toString(),
508
+
509
+ exactOut: !amountData.exactIn,
510
+ sequence,
511
+
512
+ claimerBounty: throwIfUndefined(claimerBountyPrefetchPromise[version], "Watchtower fee pre-fetch failed!"),
513
+ feeRate: throwIfUndefined(feeRatePromise[version], "Network fee rate pre-fetch failed!"),
514
+ additionalParams
515
+ },
516
+ this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined
517
+ );
518
+
519
+ let signDataPromise = _signDataPromise[version];
520
+ if(signDataPromise==null) {
521
+ signDataPromise = this.preFetchSignData(signDataPrefetch, version);
522
+ } else signDataPrefetch.catch(() => {});
523
+
524
+ return {
525
+ signDataPromise,
526
+ resp: await response
527
+ };
528
+ }, undefined, e => e instanceof RequestError, abortController.signal);
529
+
530
+ const data: T["Data"] = new (this._swapDataDeserializer(version))(resp.data);
531
+ data.setClaimer(recipient);
532
+
533
+ const swapFeeBtc = resp.swapFee * resp.amount / (data.getAmount() + resp.swapFee);
534
+
535
+ this.verifyReturnedData(recipient, resp, amountData, lp, _options, data, sequence, (await claimerBountyPrefetchPromise[version])!, nativeTokenAddress);
536
+ const [pricingInfo, signatureExpiry] = await Promise.all([
537
+ //Get intermediary's liquidity
538
+ this.verifyReturnedPrice(
539
+ lp.services[SwapType.FROM_BTC], false, resp.amount, resp.total,
540
+ amountData.token, {swapFeeBtc}, pricePrefetchPromise, usdPricePrefetchPromise, abortController.signal
541
+ ),
542
+ this.verifyReturnedSignature(recipient, data, resp, feeRatePromise[version], signDataPromise, version, abortController.signal),
543
+ this.verifyIntermediaryLiquidity(data.getAmount(), throwIfUndefined(liquidityPromise, "LP liquidity pre-fetch failed!")),
544
+ ]);
545
+
546
+ const quote = new FromBTCSwap<T>(this, {
547
+ pricingInfo,
548
+ url: lp.url,
549
+ expiry: signatureExpiry,
550
+ swapFee: resp.swapFee,
551
+ swapFeeBtc,
552
+ feeRate: (await feeRatePromise[version])!,
553
+ signatureData: resp,
554
+ data,
555
+ address: resp.btcAddress,
556
+ amount: resp.amount,
557
+ exactIn: amountData.exactIn ?? true,
558
+ requiredConfirmations: resp.confirmations,
559
+ contractVersion: version
560
+ } as FromBTCSwapInit<T["Data"]>);
561
+ return quote;
562
+ } catch (e) {
563
+ abortController.abort(e);
564
+ throw e;
565
+ }
566
+ })()
567
+ }
568
+ });
569
+ }
570
+
571
+ /**
572
+ * @inheritDoc
573
+ */
574
+ async recoverFromSwapDataAndState(
575
+ init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
576
+ state: SwapCommitState,
577
+ contractVersion: string,
578
+ lp?: Intermediary
579
+ ): Promise<FromBTCSwap<T> | null> {
580
+ const data = init.data;
581
+
582
+ const swapInit: FromBTCSwapInit<T["Data"]> = {
583
+ pricingInfo: {
584
+ isValid: true,
585
+ satsBaseFee: 0n,
586
+ swapPriceUSatPerToken: 100_000_000_000_000n,
587
+ realPriceUSatPerToken: 100_000_000_000_000n,
588
+ differencePPM: 0n,
589
+ feePPM: 0n,
590
+ },
591
+ url: lp?.url,
592
+ expiry: 0,
593
+ swapFee: 0n,
594
+ swapFeeBtc: 0n,
595
+ feeRate: "",
596
+ signatureData: undefined,
597
+ data,
598
+ exactIn: false,
599
+ contractVersion
600
+ }
601
+ const swap = new FromBTCSwap(this, swapInit);
602
+ swap._commitTxId = await init.getInitTxId();
603
+ const blockData = await init.getTxBlock();
604
+ swap.createdAt = blockData.blockTime * 1000;
605
+ swap._setInitiated();
606
+ swap._state = FromBTCSwapState.CLAIM_COMMITED;
607
+ await swap._sync(false, false, state);
608
+ await swap._save();
609
+ return swap;
610
+ }
611
+
612
+ }