@atomiqlabs/sdk 8.8.3 → 8.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (339) hide show
  1. package/LICENSE +201 -201
  2. package/README.md +1760 -1760
  3. package/dist/SmartChainAssets.d.ts +181 -181
  4. package/dist/SmartChainAssets.js +181 -181
  5. package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
  6. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  7. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
  8. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  9. package/dist/bitcoin/coinselect2/index.d.ts +20 -20
  10. package/dist/bitcoin/coinselect2/index.js +69 -69
  11. package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
  12. package/dist/bitcoin/coinselect2/utils.js +158 -158
  13. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
  14. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
  15. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
  16. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  17. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
  18. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
  19. package/dist/enums/FeeType.d.ts +15 -15
  20. package/dist/enums/FeeType.js +19 -19
  21. package/dist/enums/SwapAmountType.d.ts +15 -15
  22. package/dist/enums/SwapAmountType.js +19 -19
  23. package/dist/enums/SwapDirection.d.ts +15 -15
  24. package/dist/enums/SwapDirection.js +19 -19
  25. package/dist/enums/SwapSide.d.ts +15 -15
  26. package/dist/enums/SwapSide.js +19 -19
  27. package/dist/enums/SwapType.d.ts +75 -75
  28. package/dist/enums/SwapType.js +79 -79
  29. package/dist/errors/IntermediaryError.d.ts +13 -13
  30. package/dist/errors/IntermediaryError.js +27 -27
  31. package/dist/errors/RequestError.d.ts +32 -32
  32. package/dist/errors/RequestError.js +54 -54
  33. package/dist/errors/UserError.d.ts +8 -8
  34. package/dist/errors/UserError.js +16 -16
  35. package/dist/events/UnifiedSwapEventListener.d.ts +23 -23
  36. package/dist/events/UnifiedSwapEventListener.js +132 -132
  37. package/dist/http/HttpUtils.d.ts +27 -27
  38. package/dist/http/HttpUtils.js +91 -91
  39. package/dist/http/paramcoders/IParamReader.d.ts +8 -8
  40. package/dist/http/paramcoders/IParamReader.js +2 -2
  41. package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
  42. package/dist/http/paramcoders/ParamDecoder.js +137 -137
  43. package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
  44. package/dist/http/paramcoders/ParamEncoder.js +36 -36
  45. package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
  46. package/dist/http/paramcoders/SchemaVerifier.js +145 -145
  47. package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
  48. package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
  49. package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
  50. package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
  51. package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +16 -16
  52. package/dist/http/paramcoders/client/StreamingFetchPromise.js +174 -174
  53. package/dist/index.d.ts +85 -85
  54. package/dist/index.js +158 -158
  55. package/dist/intermediaries/Intermediary.d.ts +178 -178
  56. package/dist/intermediaries/Intermediary.js +166 -166
  57. package/dist/intermediaries/IntermediaryDiscovery.d.ts +211 -211
  58. package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
  59. package/dist/intermediaries/apis/IntermediaryAPI.d.ts +450 -450
  60. package/dist/intermediaries/apis/IntermediaryAPI.js +618 -618
  61. package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
  62. package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
  63. package/dist/lnurl/LNURL.d.ts +102 -102
  64. package/dist/lnurl/LNURL.js +321 -321
  65. package/dist/prices/RedundantSwapPrice.d.ts +110 -110
  66. package/dist/prices/RedundantSwapPrice.js +222 -222
  67. package/dist/prices/SingleSwapPrice.d.ts +34 -34
  68. package/dist/prices/SingleSwapPrice.js +44 -44
  69. package/dist/prices/SwapPriceWithChain.d.ts +107 -107
  70. package/dist/prices/SwapPriceWithChain.js +128 -128
  71. package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
  72. package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
  73. package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
  74. package/dist/prices/abstract/IPriceProvider.js +74 -74
  75. package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
  76. package/dist/prices/abstract/ISwapPrice.js +279 -279
  77. package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
  78. package/dist/prices/providers/BinancePriceProvider.js +30 -30
  79. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
  80. package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
  81. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
  82. package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
  83. package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
  84. package/dist/prices/providers/CustomPriceProvider.js +35 -35
  85. package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
  86. package/dist/prices/providers/KrakenPriceProvider.js +45 -45
  87. package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
  88. package/dist/prices/providers/OKXPriceProvider.js +29 -29
  89. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
  90. package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
  91. package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
  92. package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
  93. package/dist/storage/IUnifiedStorage.d.ts +85 -85
  94. package/dist/storage/IUnifiedStorage.js +2 -2
  95. package/dist/storage/UnifiedSwapStorage.d.ts +114 -114
  96. package/dist/storage/UnifiedSwapStorage.js +116 -116
  97. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
  98. package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
  99. package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
  100. package/dist/storage-browser/LocalStorageManager.js +93 -93
  101. package/dist/swapper/Swapper.d.ts +732 -732
  102. package/dist/swapper/Swapper.js +1713 -1713
  103. package/dist/swapper/SwapperFactory.d.ts +135 -135
  104. package/dist/swapper/SwapperFactory.js +162 -162
  105. package/dist/swapper/SwapperUtils.d.ts +206 -206
  106. package/dist/swapper/SwapperUtils.js +481 -481
  107. package/dist/swapper/SwapperWithChain.d.ts +404 -404
  108. package/dist/swapper/SwapperWithChain.js +469 -469
  109. package/dist/swapper/SwapperWithSigner.d.ts +322 -322
  110. package/dist/swapper/SwapperWithSigner.js +318 -318
  111. package/dist/swaps/IAddressSwap.d.ts +22 -22
  112. package/dist/swaps/IAddressSwap.js +14 -14
  113. package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
  114. package/dist/swaps/IBTCWalletSwap.js +18 -18
  115. package/dist/swaps/IClaimableSwap.d.ts +49 -49
  116. package/dist/swaps/IClaimableSwap.js +15 -15
  117. package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
  118. package/dist/swaps/IClaimableSwapWrapper.js +2 -2
  119. package/dist/swaps/IRefundableSwap.d.ts +43 -43
  120. package/dist/swaps/IRefundableSwap.js +14 -14
  121. package/dist/swaps/ISwap.d.ts +392 -392
  122. package/dist/swaps/ISwap.js +349 -349
  123. package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
  124. package/dist/swaps/ISwapWithGasDrop.js +12 -12
  125. package/dist/swaps/ISwapWrapper.d.ts +285 -285
  126. package/dist/swaps/ISwapWrapper.js +353 -353
  127. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
  128. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
  129. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
  130. package/dist/swaps/escrow_swaps/IEscrowSwap.js +170 -170
  131. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +128 -128
  132. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
  133. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +105 -105
  134. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +129 -129
  135. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
  136. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
  137. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
  138. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
  139. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +531 -531
  140. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1285 -1285
  141. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +190 -190
  142. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
  143. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +583 -583
  144. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1371 -1371
  145. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +235 -235
  146. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
  147. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +458 -458
  148. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1126 -1126
  149. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +202 -202
  150. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
  151. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +403 -403
  152. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +924 -924
  153. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
  154. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
  155. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
  156. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
  157. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +251 -251
  158. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +536 -536
  159. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
  160. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
  161. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +132 -132
  162. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
  163. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +637 -637
  164. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1448 -1448
  165. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +257 -257
  166. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
  167. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +261 -261
  168. package/dist/swaps/trusted/ln/LnForGasSwap.js +511 -511
  169. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
  170. package/dist/swaps/trusted/ln/LnForGasWrapper.js +83 -83
  171. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +342 -342
  172. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +715 -715
  173. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +69 -69
  174. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
  175. package/dist/types/AmountData.d.ts +10 -10
  176. package/dist/types/AmountData.js +2 -2
  177. package/dist/types/CustomPriceFunction.d.ts +11 -11
  178. package/dist/types/CustomPriceFunction.js +2 -2
  179. package/dist/types/PriceInfoType.d.ts +28 -28
  180. package/dist/types/PriceInfoType.js +57 -57
  181. package/dist/types/SwapExecutionAction.d.ts +88 -88
  182. package/dist/types/SwapExecutionAction.js +2 -2
  183. package/dist/types/SwapStateInfo.d.ts +5 -5
  184. package/dist/types/SwapStateInfo.js +2 -2
  185. package/dist/types/SwapWithSigner.d.ts +17 -17
  186. package/dist/types/SwapWithSigner.js +43 -43
  187. package/dist/types/Token.d.ts +99 -99
  188. package/dist/types/Token.js +76 -76
  189. package/dist/types/TokenAmount.d.ts +69 -69
  190. package/dist/types/TokenAmount.js +60 -60
  191. package/dist/types/fees/Fee.d.ts +50 -50
  192. package/dist/types/fees/Fee.js +2 -2
  193. package/dist/types/fees/FeeBreakdown.d.ts +11 -11
  194. package/dist/types/fees/FeeBreakdown.js +2 -2
  195. package/dist/types/fees/PercentagePPM.d.ts +17 -17
  196. package/dist/types/fees/PercentagePPM.js +18 -18
  197. package/dist/types/lnurl/LNURLPay.d.ts +61 -61
  198. package/dist/types/lnurl/LNURLPay.js +31 -31
  199. package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
  200. package/dist/types/lnurl/LNURLWithdraw.js +27 -27
  201. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
  202. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
  203. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
  204. package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
  205. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
  206. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
  207. package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
  208. package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
  209. package/dist/utils/BitcoinUtils.d.ts +16 -16
  210. package/dist/utils/BitcoinUtils.js +141 -141
  211. package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
  212. package/dist/utils/BitcoinWalletUtils.js +14 -14
  213. package/dist/utils/Logger.d.ts +7 -7
  214. package/dist/utils/Logger.js +12 -12
  215. package/dist/utils/RetryUtils.d.ts +22 -22
  216. package/dist/utils/RetryUtils.js +67 -67
  217. package/dist/utils/SwapUtils.d.ts +88 -88
  218. package/dist/utils/SwapUtils.js +72 -72
  219. package/dist/utils/TimeoutUtils.d.ts +17 -17
  220. package/dist/utils/TimeoutUtils.js +55 -55
  221. package/dist/utils/TokenUtils.d.ts +19 -19
  222. package/dist/utils/TokenUtils.js +37 -37
  223. package/dist/utils/TypeUtils.d.ts +7 -7
  224. package/dist/utils/TypeUtils.js +2 -2
  225. package/dist/utils/Utils.d.ts +67 -67
  226. package/dist/utils/Utils.js +208 -208
  227. package/package.json +43 -43
  228. package/src/SmartChainAssets.ts +186 -186
  229. package/src/bitcoin/coinselect2/accumulative.ts +69 -69
  230. package/src/bitcoin/coinselect2/blackjack.ts +50 -50
  231. package/src/bitcoin/coinselect2/index.ts +93 -93
  232. package/src/bitcoin/coinselect2/utils.ts +236 -236
  233. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
  234. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
  235. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
  236. package/src/enums/FeeType.ts +15 -15
  237. package/src/enums/SwapAmountType.ts +16 -16
  238. package/src/enums/SwapDirection.ts +15 -15
  239. package/src/enums/SwapSide.ts +16 -16
  240. package/src/enums/SwapType.ts +75 -75
  241. package/src/errors/IntermediaryError.ts +28 -28
  242. package/src/errors/RequestError.ts +64 -64
  243. package/src/errors/UserError.ts +15 -15
  244. package/src/events/UnifiedSwapEventListener.ts +173 -173
  245. package/src/http/HttpUtils.ts +91 -91
  246. package/src/http/paramcoders/IParamReader.ts +9 -9
  247. package/src/http/paramcoders/ParamDecoder.ts +145 -145
  248. package/src/http/paramcoders/ParamEncoder.ts +40 -40
  249. package/src/http/paramcoders/SchemaVerifier.ts +153 -153
  250. package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
  251. package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
  252. package/src/http/paramcoders/client/StreamingFetchPromise.ts +192 -192
  253. package/src/index.ts +140 -140
  254. package/src/intermediaries/Intermediary.ts +280 -280
  255. package/src/intermediaries/IntermediaryDiscovery.ts +541 -541
  256. package/src/intermediaries/apis/IntermediaryAPI.ts +963 -963
  257. package/src/intermediaries/apis/TrustedIntermediaryAPI.ts +257 -257
  258. package/src/lnurl/LNURL.ts +402 -402
  259. package/src/prices/RedundantSwapPrice.ts +264 -264
  260. package/src/prices/SingleSwapPrice.ts +50 -50
  261. package/src/prices/SwapPriceWithChain.ts +194 -194
  262. package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
  263. package/src/prices/abstract/IPriceProvider.ts +127 -127
  264. package/src/prices/abstract/ISwapPrice.ts +390 -390
  265. package/src/prices/providers/BinancePriceProvider.ts +48 -48
  266. package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
  267. package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
  268. package/src/prices/providers/CustomPriceProvider.ts +40 -40
  269. package/src/prices/providers/KrakenPriceProvider.ts +83 -83
  270. package/src/prices/providers/OKXPriceProvider.ts +59 -59
  271. package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
  272. package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
  273. package/src/storage/IUnifiedStorage.ts +95 -95
  274. package/src/storage/UnifiedSwapStorage.ts +141 -141
  275. package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
  276. package/src/storage-browser/LocalStorageManager.ts +106 -106
  277. package/src/swapper/Swapper.ts +2488 -2488
  278. package/src/swapper/SwapperFactory.ts +307 -307
  279. package/src/swapper/SwapperUtils.ts +570 -570
  280. package/src/swapper/SwapperWithChain.ts +707 -707
  281. package/src/swapper/SwapperWithSigner.ts +511 -511
  282. package/src/swaps/IAddressSwap.ts +30 -30
  283. package/src/swaps/IBTCWalletSwap.ts +92 -92
  284. package/src/swaps/IClaimableSwap.ts +65 -65
  285. package/src/swaps/IClaimableSwapWrapper.ts +17 -17
  286. package/src/swaps/IRefundableSwap.ts +58 -58
  287. package/src/swaps/ISwap.ts +703 -703
  288. package/src/swaps/ISwapWithGasDrop.ts +25 -25
  289. package/src/swaps/ISwapWrapper.ts +539 -539
  290. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
  291. package/src/swaps/escrow_swaps/IEscrowSwap.ts +269 -269
  292. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +282 -282
  293. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +169 -169
  294. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
  295. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
  296. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1473 -1474
  297. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +601 -601
  298. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1582 -1582
  299. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +750 -750
  300. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1299 -1299
  301. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +610 -610
  302. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1096 -1096
  303. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
  304. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
  305. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +786 -786
  306. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
  307. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +401 -401
  308. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +1812 -1812
  309. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1236 -1236
  310. package/src/swaps/trusted/ln/LnForGasSwap.ts +589 -589
  311. package/src/swaps/trusted/ln/LnForGasWrapper.ts +91 -91
  312. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +862 -862
  313. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +131 -131
  314. package/src/types/AmountData.ts +9 -9
  315. package/src/types/CustomPriceFunction.ts +11 -11
  316. package/src/types/PriceInfoType.ts +66 -66
  317. package/src/types/SwapExecutionAction.ts +99 -99
  318. package/src/types/SwapStateInfo.ts +6 -6
  319. package/src/types/SwapWithSigner.ts +61 -61
  320. package/src/types/Token.ts +163 -163
  321. package/src/types/TokenAmount.ts +132 -132
  322. package/src/types/fees/Fee.ts +56 -56
  323. package/src/types/fees/FeeBreakdown.ts +11 -11
  324. package/src/types/fees/PercentagePPM.ts +26 -26
  325. package/src/types/lnurl/LNURLPay.ts +79 -79
  326. package/src/types/lnurl/LNURLWithdraw.ts +61 -61
  327. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
  328. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
  329. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
  330. package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
  331. package/src/utils/BitcoinUtils.ts +132 -132
  332. package/src/utils/BitcoinWalletUtils.ts +15 -15
  333. package/src/utils/Logger.ts +14 -14
  334. package/src/utils/RetryUtils.ts +78 -78
  335. package/src/utils/SwapUtils.ts +99 -99
  336. package/src/utils/TimeoutUtils.ts +49 -49
  337. package/src/utils/TokenUtils.ts +33 -33
  338. package/src/utils/TypeUtils.ts +8 -8
  339. package/src/utils/Utils.ts +212 -212
@@ -1,403 +1,403 @@
1
- import { IToBTCDefinition, IToBTCWrapper } from "./IToBTCWrapper";
2
- import { ChainType, SignatureData, SwapCommitState, SwapData } from "@atomiqlabs/base";
3
- import { RefundAuthorizationResponse } from "../../../intermediaries/apis/IntermediaryAPI";
4
- import { Fee } from "../../../types/fees/Fee";
5
- import { IEscrowSelfInitSwap, IEscrowSelfInitSwapInit } from "../IEscrowSelfInitSwap";
6
- import { IRefundableSwap } from "../../IRefundableSwap";
7
- import { FeeType } from "../../../enums/FeeType";
8
- import { TokenAmount } from "../../../types/TokenAmount";
9
- import { BtcToken, SCToken } from "../../../types/Token";
10
- import { SwapExecutionAction, SwapExecutionActionCommit } from "../../../types/SwapExecutionAction";
11
- export type IToBTCSwapInit<T extends SwapData> = IEscrowSelfInitSwapInit<T> & {
12
- signatureData?: SignatureData;
13
- data: T;
14
- networkFee: bigint;
15
- networkFeeBtc: bigint;
16
- };
17
- export declare function isIToBTCSwapInit<T extends SwapData>(obj: any): obj is IToBTCSwapInit<T>;
18
- /**
19
- * State enum for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
20
- *
21
- * @category Swaps/Smart chain → Bitcoin
22
- */
23
- export declare enum ToBTCSwapState {
24
- /**
25
- * Intermediary (LP) was unable to process the swap and the funds were refunded on the
26
- * source chain
27
- */
28
- REFUNDED = -3,
29
- /**
30
- * Swap has expired for good and there is no way how it can be executed anymore
31
- */
32
- QUOTE_EXPIRED = -2,
33
- /**
34
- * A swap is almost expired, and it should be presented to the user as expired, though
35
- * there is still a chance that it will be processed
36
- */
37
- QUOTE_SOFT_EXPIRED = -1,
38
- /**
39
- * Swap was created, use the {@link IToBTCSwap.commit} or {@link IToBTCSwap.txsCommit} to
40
- * initiate it by creating the swap escrow on the source chain
41
- */
42
- CREATED = 0,
43
- /**
44
- * Swap escrow was initiated (committed) on the source chain, the intermediary (LP) will
45
- * now process the swap. You can wait till that happens with the {@link IToBTCSwap.waitForPayment}
46
- * function.
47
- */
48
- COMMITED = 1,
49
- /**
50
- * The intermediary (LP) has processed the transaction and sent out the funds on the destination chain,
51
- * but hasn't yet settled the escrow on the source chain.
52
- */
53
- SOFT_CLAIMED = 2,
54
- /**
55
- * Swap was successfully settled by the intermediary (LP) on the source chain
56
- */
57
- CLAIMED = 3,
58
- /**
59
- * Intermediary (LP) was unable to process the swap and the swap escrow on the source chain
60
- * is refundable, call {@link IToBTCSwap.refund} or {@link IToBTCSwap.txsRefund} to refund
61
- */
62
- REFUNDABLE = 4
63
- }
64
- /**
65
- * Base class for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
66
- *
67
- * @category Swaps/Smart chain → Bitcoin
68
- */
69
- export declare abstract class IToBTCSwap<T extends ChainType = ChainType, D extends IToBTCDefinition<T, IToBTCWrapper<T, D>, IToBTCSwap<T, D>> = IToBTCDefinition<T, IToBTCWrapper<T, any>, IToBTCSwap<T, any>>> extends IEscrowSelfInitSwap<T, D, ToBTCSwapState> implements IRefundableSwap<T, D, ToBTCSwapState> {
70
- /**
71
- * @internal
72
- */
73
- protected readonly swapStateDescription: {
74
- [-3]: string;
75
- [-2]: string;
76
- [-1]: string;
77
- 0: string;
78
- 1: string;
79
- 2: string;
80
- 3: string;
81
- 4: string;
82
- };
83
- /**
84
- * @internal
85
- */
86
- protected readonly swapStateName: (state: number) => string;
87
- /**
88
- * @internal
89
- */
90
- protected readonly abstract outputToken: BtcToken;
91
- /**
92
- * @internal
93
- */
94
- protected readonly networkFee: bigint;
95
- /**
96
- * @internal
97
- */
98
- protected networkFeeBtc: bigint;
99
- /**
100
- * @internal
101
- */
102
- readonly _data: T["Data"];
103
- protected constructor(wrapper: D["Wrapper"], serializedObject: any);
104
- protected constructor(wrapper: D["Wrapper"], init: IToBTCSwapInit<T["Data"]>);
105
- /**
106
- * @inheritDoc
107
- * @internal
108
- */
109
- protected getSwapData(): T["Data"];
110
- /**
111
- * @inheritDoc
112
- * @internal
113
- */
114
- protected upgradeVersion(): void;
115
- /**
116
- * @inheritDoc
117
- * @internal
118
- */
119
- protected tryRecomputeSwapPrice(): void;
120
- /**
121
- * Returns the payment hash identifier to be sent to the LP for getStatus and getRefund
122
- * @internal
123
- */
124
- protected getLpIdentifier(): string;
125
- /**
126
- * Sets the payment result for the swap, optionally also checking it (checking that tx exist or swap secret is valid)
127
- *
128
- * @param result Result returned by the LP
129
- * @param check Whether to check the passed result
130
- * @returns true if check passed, false if check failed with a soft error (e.g. tx not yet found in the mempool)
131
- * @throws {IntermediaryError} When the data returned by the intermediary isn't valid
132
- *
133
- * @internal
134
- */
135
- abstract _setPaymentResult(result: {
136
- secret?: string;
137
- txId?: string;
138
- }, check?: boolean): Promise<boolean>;
139
- /**
140
- * @inheritDoc
141
- */
142
- getInputAddress(): string | null;
143
- /**
144
- * @inheritDoc
145
- */
146
- getInputTxId(): string | null;
147
- /**
148
- * @inheritDoc
149
- */
150
- requiresAction(): boolean;
151
- /**
152
- * @inheritDoc
153
- */
154
- isFinished(): boolean;
155
- /**
156
- * @inheritDoc
157
- */
158
- isRefundable(): boolean;
159
- /**
160
- * @inheritDoc
161
- */
162
- isQuoteExpired(): boolean;
163
- /**
164
- * @inheritDoc
165
- */
166
- isQuoteSoftExpired(): boolean;
167
- /**
168
- * @inheritDoc
169
- */
170
- isSuccessful(): boolean;
171
- /**
172
- * @inheritDoc
173
- */
174
- isFailed(): boolean;
175
- /**
176
- * @inheritDoc
177
- */
178
- isInProgress(): boolean;
179
- /**
180
- * Returns the time (in UNIX milliseconds) at which the swap expires and the user is able to unilaterally
181
- * refund it with the {@link refund} or {@link txsRefund} function.
182
- */
183
- getExpiry(): number;
184
- /**
185
- * @inheritDoc
186
- * @internal
187
- */
188
- _getInitiator(): string;
189
- /**
190
- * Returns the swap fee charged by the intermediary (LP) on this swap
191
- *
192
- * @internal
193
- */
194
- protected getSwapFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
195
- /**
196
- * Returns network fee for on the destination chain for the swap
197
- *
198
- * @internal
199
- */
200
- protected getNetworkFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
201
- /**
202
- * @inheritDoc
203
- */
204
- getFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
205
- /**
206
- * @inheritDoc
207
- */
208
- getFeeBreakdown(): [
209
- {
210
- type: FeeType.SWAP;
211
- fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
212
- },
213
- {
214
- type: FeeType.NETWORK_OUTPUT;
215
- fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
216
- }
217
- ];
218
- /**
219
- * @inheritDoc
220
- */
221
- getInputToken(): SCToken<T["ChainId"]>;
222
- /**
223
- * @inheritDoc
224
- */
225
- getInput(): TokenAmount<SCToken<T["ChainId"]>, true>;
226
- /**
227
- * @inheritDoc
228
- */
229
- getInputWithoutFee(): TokenAmount<SCToken<T["ChainId"]>, true>;
230
- /**
231
- * Checks if the initiator/sender on the source chain has enough balance to go through with the swap
232
- */
233
- hasEnoughBalance(): Promise<{
234
- enoughBalance: boolean;
235
- balance: TokenAmount<SCToken<T["ChainId"]>, true>;
236
- required: TokenAmount<SCToken<T["ChainId"]>, true>;
237
- }>;
238
- /**
239
- * Checks if the initiator/sender on the source chain has enough native token balance
240
- * to cover the transaction fee of initiating the swap
241
- */
242
- hasEnoughForTxFees(): Promise<{
243
- enoughBalance: boolean;
244
- balance: TokenAmount<SCToken<T["ChainId"]>, true>;
245
- required: TokenAmount<SCToken<T["ChainId"]>, true>;
246
- }>;
247
- /**
248
- * Executes the swap with the provided smart chain wallet/signer
249
- *
250
- * @param signer Smart chain wallet/signer to use to sign the transaction on the source chain
251
- * @param callbacks Callbacks to track the progress of the swap
252
- * @param options Optional options for the swap like feeRate, AbortSignal, and timeouts/intervals
253
- *
254
- * @returns {boolean} Whether the swap was successfully processed by the LP, in case `false` is returned
255
- * the user can refund their funds back on the source chain by calling {@link refund}
256
- */
257
- execute(signer: T["Signer"] | T["NativeSigner"], callbacks?: {
258
- onSourceTransactionSent?: (sourceTxId: string) => void;
259
- onSourceTransactionConfirmed?: (sourceTxId: string) => void;
260
- onSwapSettled?: (destinationTxId: string) => void;
261
- }, options?: {
262
- abortSignal?: AbortSignal;
263
- paymentCheckIntervalSeconds?: number;
264
- maxWaitTillSwapProcessedSeconds?: number;
265
- }): Promise<boolean>;
266
- /**
267
- * @inheritDoc
268
- *
269
- * @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
270
- * (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
271
- */
272
- txsExecute(options?: {
273
- skipChecks?: boolean;
274
- }): Promise<[
275
- SwapExecutionActionCommit<T>
276
- ]>;
277
- /**
278
- * @inheritDoc
279
- *
280
- * @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
281
- * (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
282
- * @param options.refundSmartChainSigner Optional smart chain signer to use when creating refunds transactions
283
- */
284
- getCurrentActions(options?: {
285
- skipChecks?: boolean;
286
- refundSmartChainSigner?: string | T["Signer"] | T["NativeSigner"];
287
- }): Promise<SwapExecutionAction<T>[]>;
288
- /**
289
- * @inheritDoc
290
- *
291
- * @throws {Error} When in invalid state (not {@link ToBTCSwapState.CREATED})
292
- */
293
- txsCommit(skipChecks?: boolean): Promise<T["TX"][]>;
294
- /**
295
- * @inheritDoc
296
- *
297
- * @throws {Error} If invalid signer is provided that doesn't match the swap data
298
- */
299
- commit(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal, skipChecks?: boolean, onBeforeTxSent?: (txId: string) => void): Promise<string>;
300
- /**
301
- * @inheritDoc
302
- *
303
- * @throws {Error} If swap is not in the correct state (must be {@link ToBTCSwapState.CREATED})
304
- */
305
- waitTillCommited(abortSignal?: AbortSignal): Promise<void>;
306
- /**
307
- * Waits till the swap is processed by the intermediary (LP)
308
- *
309
- * @param checkIntervalSeconds How often to poll the intermediary for status (5 seconds default)
310
- * @param abortSignal Abort signal
311
- * @internal
312
- */
313
- protected waitTillIntermediarySwapProcessed(checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<RefundAuthorizationResponse>;
314
- /**
315
- * Checks whether the swap was already processed by the LP and is either successful (requires proof which is
316
- * either a HTLC pre-image for LN swaps or valid txId for on-chain swap) or failed and we can cooperatively
317
- * refund.
318
- *
319
- * @param save whether to save the data
320
- * @returns `true` if swap is processed, `false` if the swap is still ongoing
321
- *
322
- * @internal
323
- */
324
- protected checkIntermediarySwapProcessed(save?: boolean): Promise<boolean>;
325
- /**
326
- * A blocking promise resolving when swap was concluded by the intermediary (LP),
327
- * rejecting in case of failure
328
- *
329
- * @param maxWaitTimeSeconds Maximum time in seconds to wait for the swap to be settled, an error is thrown if the
330
- * swap is taking too long to claim
331
- * @param checkIntervalSeconds How often to poll the intermediary for answer
332
- * @param abortSignal Abort signal
333
- * @returns `true` if swap was successful, `false` if swap failed and we can refund
334
- *
335
- * @throws {IntermediaryError} If a swap is determined expired by the intermediary, but it is actually still valid
336
- * @throws {SignatureVerificationError} If the swap should be cooperatively refundable but the intermediary returned
337
- * invalid refund signature
338
- * @throws {Error} When swap expires or if the swap has invalid state (must be {@link ToBTCSwapState.COMMITED})
339
- */
340
- waitForPayment(maxWaitTimeSeconds?: number, checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<boolean>;
341
- /**
342
- * Get the estimated smart chain transaction fee of the refund transaction
343
- */
344
- getRefundNetworkFee(): Promise<TokenAmount<SCToken<T["ChainId"]>, true>>;
345
- /**
346
- * @inheritDoc
347
- *
348
- * @throws {IntermediaryError} If intermediary returns invalid response in case cooperative refund should be used
349
- * @throws {SignatureVerificationError} If intermediary returned invalid cooperative refund signature
350
- * @throws {Error} When state is not refundable
351
- */
352
- txsRefund(_signer?: string | T["Signer"] | T["NativeSigner"]): Promise<T["TX"][]>;
353
- /**
354
- * @inheritDoc
355
- *
356
- * @throws {Error} If invalid signer is provided that doesn't match the swap data
357
- */
358
- refund(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal): Promise<string>;
359
- /**
360
- * @inheritDoc
361
- *
362
- * @throws {Error} When swap is not in a valid state (must be {@link ToBTCSwapState.COMMITED} or
363
- * {@link ToBTCSwapState.REFUNDABLE})
364
- * @throws {Error} If we tried to refund but claimer was able to claim first
365
- */
366
- waitTillRefunded(abortSignal?: AbortSignal): Promise<void>;
367
- /**
368
- * @inheritDoc
369
- */
370
- serialize(): any;
371
- /**
372
- * Checks the swap's state on-chain and compares it to its internal state, updates/changes it according to on-chain
373
- * data
374
- *
375
- * @private
376
- */
377
- private syncStateFromChain;
378
- /**
379
- * @inheritDoc
380
- * @internal
381
- */
382
- _shouldFetchOnchainState(): boolean;
383
- /**
384
- * @inheritDoc
385
- * @internal
386
- */
387
- _shouldFetchExpiryStatus(): boolean;
388
- /**
389
- * @inheritDoc
390
- * @internal
391
- */
392
- _sync(save?: boolean, quoteDefinitelyExpired?: boolean, commitStatus?: SwapCommitState): Promise<boolean>;
393
- /**
394
- * @inheritDoc
395
- * @internal
396
- */
397
- _forciblySetOnchainState(commitStatus: SwapCommitState): Promise<boolean>;
398
- /**
399
- * @inheritDoc
400
- * @internal
401
- */
402
- _tick(save?: boolean): Promise<boolean>;
403
- }
1
+ import { IToBTCDefinition, IToBTCWrapper } from "./IToBTCWrapper";
2
+ import { ChainType, SignatureData, SwapCommitState, SwapData } from "@atomiqlabs/base";
3
+ import { RefundAuthorizationResponse } from "../../../intermediaries/apis/IntermediaryAPI";
4
+ import { Fee } from "../../../types/fees/Fee";
5
+ import { IEscrowSelfInitSwap, IEscrowSelfInitSwapInit } from "../IEscrowSelfInitSwap";
6
+ import { IRefundableSwap } from "../../IRefundableSwap";
7
+ import { FeeType } from "../../../enums/FeeType";
8
+ import { TokenAmount } from "../../../types/TokenAmount";
9
+ import { BtcToken, SCToken } from "../../../types/Token";
10
+ import { SwapExecutionAction, SwapExecutionActionCommit } from "../../../types/SwapExecutionAction";
11
+ export type IToBTCSwapInit<T extends SwapData> = IEscrowSelfInitSwapInit<T> & {
12
+ signatureData?: SignatureData;
13
+ data: T;
14
+ networkFee: bigint;
15
+ networkFeeBtc: bigint;
16
+ };
17
+ export declare function isIToBTCSwapInit<T extends SwapData>(obj: any): obj is IToBTCSwapInit<T>;
18
+ /**
19
+ * State enum for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
20
+ *
21
+ * @category Swaps/Smart chain → Bitcoin
22
+ */
23
+ export declare enum ToBTCSwapState {
24
+ /**
25
+ * Intermediary (LP) was unable to process the swap and the funds were refunded on the
26
+ * source chain
27
+ */
28
+ REFUNDED = -3,
29
+ /**
30
+ * Swap has expired for good and there is no way how it can be executed anymore
31
+ */
32
+ QUOTE_EXPIRED = -2,
33
+ /**
34
+ * A swap is almost expired, and it should be presented to the user as expired, though
35
+ * there is still a chance that it will be processed
36
+ */
37
+ QUOTE_SOFT_EXPIRED = -1,
38
+ /**
39
+ * Swap was created, use the {@link IToBTCSwap.commit} or {@link IToBTCSwap.txsCommit} to
40
+ * initiate it by creating the swap escrow on the source chain
41
+ */
42
+ CREATED = 0,
43
+ /**
44
+ * Swap escrow was initiated (committed) on the source chain, the intermediary (LP) will
45
+ * now process the swap. You can wait till that happens with the {@link IToBTCSwap.waitForPayment}
46
+ * function.
47
+ */
48
+ COMMITED = 1,
49
+ /**
50
+ * The intermediary (LP) has processed the transaction and sent out the funds on the destination chain,
51
+ * but hasn't yet settled the escrow on the source chain.
52
+ */
53
+ SOFT_CLAIMED = 2,
54
+ /**
55
+ * Swap was successfully settled by the intermediary (LP) on the source chain
56
+ */
57
+ CLAIMED = 3,
58
+ /**
59
+ * Intermediary (LP) was unable to process the swap and the swap escrow on the source chain
60
+ * is refundable, call {@link IToBTCSwap.refund} or {@link IToBTCSwap.txsRefund} to refund
61
+ */
62
+ REFUNDABLE = 4
63
+ }
64
+ /**
65
+ * Base class for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
66
+ *
67
+ * @category Swaps/Smart chain → Bitcoin
68
+ */
69
+ export declare abstract class IToBTCSwap<T extends ChainType = ChainType, D extends IToBTCDefinition<T, IToBTCWrapper<T, D>, IToBTCSwap<T, D>> = IToBTCDefinition<T, IToBTCWrapper<T, any>, IToBTCSwap<T, any>>> extends IEscrowSelfInitSwap<T, D, ToBTCSwapState> implements IRefundableSwap<T, D, ToBTCSwapState> {
70
+ /**
71
+ * @internal
72
+ */
73
+ protected readonly swapStateDescription: {
74
+ [-3]: string;
75
+ [-2]: string;
76
+ [-1]: string;
77
+ 0: string;
78
+ 1: string;
79
+ 2: string;
80
+ 3: string;
81
+ 4: string;
82
+ };
83
+ /**
84
+ * @internal
85
+ */
86
+ protected readonly swapStateName: (state: number) => string;
87
+ /**
88
+ * @internal
89
+ */
90
+ protected readonly abstract outputToken: BtcToken;
91
+ /**
92
+ * @internal
93
+ */
94
+ protected readonly networkFee: bigint;
95
+ /**
96
+ * @internal
97
+ */
98
+ protected networkFeeBtc: bigint;
99
+ /**
100
+ * @internal
101
+ */
102
+ readonly _data: T["Data"];
103
+ protected constructor(wrapper: D["Wrapper"], serializedObject: any);
104
+ protected constructor(wrapper: D["Wrapper"], init: IToBTCSwapInit<T["Data"]>);
105
+ /**
106
+ * @inheritDoc
107
+ * @internal
108
+ */
109
+ protected getSwapData(): T["Data"];
110
+ /**
111
+ * @inheritDoc
112
+ * @internal
113
+ */
114
+ protected upgradeVersion(): void;
115
+ /**
116
+ * @inheritDoc
117
+ * @internal
118
+ */
119
+ protected tryRecomputeSwapPrice(): void;
120
+ /**
121
+ * Returns the payment hash identifier to be sent to the LP for getStatus and getRefund
122
+ * @internal
123
+ */
124
+ protected getLpIdentifier(): string;
125
+ /**
126
+ * Sets the payment result for the swap, optionally also checking it (checking that tx exist or swap secret is valid)
127
+ *
128
+ * @param result Result returned by the LP
129
+ * @param check Whether to check the passed result
130
+ * @returns true if check passed, false if check failed with a soft error (e.g. tx not yet found in the mempool)
131
+ * @throws {IntermediaryError} When the data returned by the intermediary isn't valid
132
+ *
133
+ * @internal
134
+ */
135
+ abstract _setPaymentResult(result: {
136
+ secret?: string;
137
+ txId?: string;
138
+ }, check?: boolean): Promise<boolean>;
139
+ /**
140
+ * @inheritDoc
141
+ */
142
+ getInputAddress(): string | null;
143
+ /**
144
+ * @inheritDoc
145
+ */
146
+ getInputTxId(): string | null;
147
+ /**
148
+ * @inheritDoc
149
+ */
150
+ requiresAction(): boolean;
151
+ /**
152
+ * @inheritDoc
153
+ */
154
+ isFinished(): boolean;
155
+ /**
156
+ * @inheritDoc
157
+ */
158
+ isRefundable(): boolean;
159
+ /**
160
+ * @inheritDoc
161
+ */
162
+ isQuoteExpired(): boolean;
163
+ /**
164
+ * @inheritDoc
165
+ */
166
+ isQuoteSoftExpired(): boolean;
167
+ /**
168
+ * @inheritDoc
169
+ */
170
+ isSuccessful(): boolean;
171
+ /**
172
+ * @inheritDoc
173
+ */
174
+ isFailed(): boolean;
175
+ /**
176
+ * @inheritDoc
177
+ */
178
+ isInProgress(): boolean;
179
+ /**
180
+ * Returns the time (in UNIX milliseconds) at which the swap expires and the user is able to unilaterally
181
+ * refund it with the {@link refund} or {@link txsRefund} function.
182
+ */
183
+ getExpiry(): number;
184
+ /**
185
+ * @inheritDoc
186
+ * @internal
187
+ */
188
+ _getInitiator(): string;
189
+ /**
190
+ * Returns the swap fee charged by the intermediary (LP) on this swap
191
+ *
192
+ * @internal
193
+ */
194
+ protected getSwapFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
195
+ /**
196
+ * Returns network fee for on the destination chain for the swap
197
+ *
198
+ * @internal
199
+ */
200
+ protected getNetworkFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
201
+ /**
202
+ * @inheritDoc
203
+ */
204
+ getFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
205
+ /**
206
+ * @inheritDoc
207
+ */
208
+ getFeeBreakdown(): [
209
+ {
210
+ type: FeeType.SWAP;
211
+ fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
212
+ },
213
+ {
214
+ type: FeeType.NETWORK_OUTPUT;
215
+ fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
216
+ }
217
+ ];
218
+ /**
219
+ * @inheritDoc
220
+ */
221
+ getInputToken(): SCToken<T["ChainId"]>;
222
+ /**
223
+ * @inheritDoc
224
+ */
225
+ getInput(): TokenAmount<SCToken<T["ChainId"]>, true>;
226
+ /**
227
+ * @inheritDoc
228
+ */
229
+ getInputWithoutFee(): TokenAmount<SCToken<T["ChainId"]>, true>;
230
+ /**
231
+ * Checks if the initiator/sender on the source chain has enough balance to go through with the swap
232
+ */
233
+ hasEnoughBalance(): Promise<{
234
+ enoughBalance: boolean;
235
+ balance: TokenAmount<SCToken<T["ChainId"]>, true>;
236
+ required: TokenAmount<SCToken<T["ChainId"]>, true>;
237
+ }>;
238
+ /**
239
+ * Checks if the initiator/sender on the source chain has enough native token balance
240
+ * to cover the transaction fee of initiating the swap
241
+ */
242
+ hasEnoughForTxFees(): Promise<{
243
+ enoughBalance: boolean;
244
+ balance: TokenAmount<SCToken<T["ChainId"]>, true>;
245
+ required: TokenAmount<SCToken<T["ChainId"]>, true>;
246
+ }>;
247
+ /**
248
+ * Executes the swap with the provided smart chain wallet/signer
249
+ *
250
+ * @param signer Smart chain wallet/signer to use to sign the transaction on the source chain
251
+ * @param callbacks Callbacks to track the progress of the swap
252
+ * @param options Optional options for the swap like feeRate, AbortSignal, and timeouts/intervals
253
+ *
254
+ * @returns {boolean} Whether the swap was successfully processed by the LP, in case `false` is returned
255
+ * the user can refund their funds back on the source chain by calling {@link refund}
256
+ */
257
+ execute(signer: T["Signer"] | T["NativeSigner"], callbacks?: {
258
+ onSourceTransactionSent?: (sourceTxId: string) => void;
259
+ onSourceTransactionConfirmed?: (sourceTxId: string) => void;
260
+ onSwapSettled?: (destinationTxId: string) => void;
261
+ }, options?: {
262
+ abortSignal?: AbortSignal;
263
+ paymentCheckIntervalSeconds?: number;
264
+ maxWaitTillSwapProcessedSeconds?: number;
265
+ }): Promise<boolean>;
266
+ /**
267
+ * @inheritDoc
268
+ *
269
+ * @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
270
+ * (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
271
+ */
272
+ txsExecute(options?: {
273
+ skipChecks?: boolean;
274
+ }): Promise<[
275
+ SwapExecutionActionCommit<T>
276
+ ]>;
277
+ /**
278
+ * @inheritDoc
279
+ *
280
+ * @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
281
+ * (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
282
+ * @param options.refundSmartChainSigner Optional smart chain signer to use when creating refunds transactions
283
+ */
284
+ getCurrentActions(options?: {
285
+ skipChecks?: boolean;
286
+ refundSmartChainSigner?: string | T["Signer"] | T["NativeSigner"];
287
+ }): Promise<SwapExecutionAction<T>[]>;
288
+ /**
289
+ * @inheritDoc
290
+ *
291
+ * @throws {Error} When in invalid state (not {@link ToBTCSwapState.CREATED})
292
+ */
293
+ txsCommit(skipChecks?: boolean): Promise<T["TX"][]>;
294
+ /**
295
+ * @inheritDoc
296
+ *
297
+ * @throws {Error} If invalid signer is provided that doesn't match the swap data
298
+ */
299
+ commit(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal, skipChecks?: boolean, onBeforeTxSent?: (txId: string) => void): Promise<string>;
300
+ /**
301
+ * @inheritDoc
302
+ *
303
+ * @throws {Error} If swap is not in the correct state (must be {@link ToBTCSwapState.CREATED})
304
+ */
305
+ waitTillCommited(abortSignal?: AbortSignal): Promise<void>;
306
+ /**
307
+ * Waits till the swap is processed by the intermediary (LP)
308
+ *
309
+ * @param checkIntervalSeconds How often to poll the intermediary for status (5 seconds default)
310
+ * @param abortSignal Abort signal
311
+ * @internal
312
+ */
313
+ protected waitTillIntermediarySwapProcessed(checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<RefundAuthorizationResponse>;
314
+ /**
315
+ * Checks whether the swap was already processed by the LP and is either successful (requires proof which is
316
+ * either a HTLC pre-image for LN swaps or valid txId for on-chain swap) or failed and we can cooperatively
317
+ * refund.
318
+ *
319
+ * @param save whether to save the data
320
+ * @returns `true` if swap is processed, `false` if the swap is still ongoing
321
+ *
322
+ * @internal
323
+ */
324
+ protected checkIntermediarySwapProcessed(save?: boolean): Promise<boolean>;
325
+ /**
326
+ * A blocking promise resolving when swap was concluded by the intermediary (LP),
327
+ * rejecting in case of failure
328
+ *
329
+ * @param maxWaitTimeSeconds Maximum time in seconds to wait for the swap to be settled, an error is thrown if the
330
+ * swap is taking too long to claim
331
+ * @param checkIntervalSeconds How often to poll the intermediary for answer
332
+ * @param abortSignal Abort signal
333
+ * @returns `true` if swap was successful, `false` if swap failed and we can refund
334
+ *
335
+ * @throws {IntermediaryError} If a swap is determined expired by the intermediary, but it is actually still valid
336
+ * @throws {SignatureVerificationError} If the swap should be cooperatively refundable but the intermediary returned
337
+ * invalid refund signature
338
+ * @throws {Error} When swap expires or if the swap has invalid state (must be {@link ToBTCSwapState.COMMITED})
339
+ */
340
+ waitForPayment(maxWaitTimeSeconds?: number, checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<boolean>;
341
+ /**
342
+ * Get the estimated smart chain transaction fee of the refund transaction
343
+ */
344
+ getRefundNetworkFee(): Promise<TokenAmount<SCToken<T["ChainId"]>, true>>;
345
+ /**
346
+ * @inheritDoc
347
+ *
348
+ * @throws {IntermediaryError} If intermediary returns invalid response in case cooperative refund should be used
349
+ * @throws {SignatureVerificationError} If intermediary returned invalid cooperative refund signature
350
+ * @throws {Error} When state is not refundable
351
+ */
352
+ txsRefund(_signer?: string | T["Signer"] | T["NativeSigner"]): Promise<T["TX"][]>;
353
+ /**
354
+ * @inheritDoc
355
+ *
356
+ * @throws {Error} If invalid signer is provided that doesn't match the swap data
357
+ */
358
+ refund(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal): Promise<string>;
359
+ /**
360
+ * @inheritDoc
361
+ *
362
+ * @throws {Error} When swap is not in a valid state (must be {@link ToBTCSwapState.COMMITED} or
363
+ * {@link ToBTCSwapState.REFUNDABLE})
364
+ * @throws {Error} If we tried to refund but claimer was able to claim first
365
+ */
366
+ waitTillRefunded(abortSignal?: AbortSignal): Promise<void>;
367
+ /**
368
+ * @inheritDoc
369
+ */
370
+ serialize(): any;
371
+ /**
372
+ * Checks the swap's state on-chain and compares it to its internal state, updates/changes it according to on-chain
373
+ * data
374
+ *
375
+ * @private
376
+ */
377
+ private syncStateFromChain;
378
+ /**
379
+ * @inheritDoc
380
+ * @internal
381
+ */
382
+ _shouldFetchOnchainState(): boolean;
383
+ /**
384
+ * @inheritDoc
385
+ * @internal
386
+ */
387
+ _shouldFetchExpiryStatus(): boolean;
388
+ /**
389
+ * @inheritDoc
390
+ * @internal
391
+ */
392
+ _sync(save?: boolean, quoteDefinitelyExpired?: boolean, commitStatus?: SwapCommitState): Promise<boolean>;
393
+ /**
394
+ * @inheritDoc
395
+ * @internal
396
+ */
397
+ _forciblySetOnchainState(commitStatus: SwapCommitState): Promise<boolean>;
398
+ /**
399
+ * @inheritDoc
400
+ * @internal
401
+ */
402
+ _tick(save?: boolean): Promise<boolean>;
403
+ }