@atomiqlabs/sdk 8.7.7 → 8.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (339) hide show
  1. package/LICENSE +201 -201
  2. package/README.md +1760 -1760
  3. package/dist/SmartChainAssets.d.ts +181 -181
  4. package/dist/SmartChainAssets.js +181 -181
  5. package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -6
  6. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  7. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -6
  8. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  9. package/dist/bitcoin/coinselect2/index.d.ts +20 -19
  10. package/dist/bitcoin/coinselect2/index.js +69 -69
  11. package/dist/bitcoin/coinselect2/utils.d.ts +82 -77
  12. package/dist/bitcoin/coinselect2/utils.js +158 -123
  13. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -130
  14. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -322
  15. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -78
  16. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  17. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -101
  18. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -190
  19. package/dist/enums/FeeType.d.ts +15 -15
  20. package/dist/enums/FeeType.js +19 -19
  21. package/dist/enums/SwapAmountType.d.ts +15 -15
  22. package/dist/enums/SwapAmountType.js +19 -19
  23. package/dist/enums/SwapDirection.d.ts +15 -15
  24. package/dist/enums/SwapDirection.js +19 -19
  25. package/dist/enums/SwapSide.d.ts +15 -15
  26. package/dist/enums/SwapSide.js +19 -19
  27. package/dist/enums/SwapType.d.ts +75 -75
  28. package/dist/enums/SwapType.js +79 -79
  29. package/dist/errors/IntermediaryError.d.ts +13 -13
  30. package/dist/errors/IntermediaryError.js +27 -27
  31. package/dist/errors/RequestError.d.ts +32 -32
  32. package/dist/errors/RequestError.js +54 -54
  33. package/dist/errors/UserError.d.ts +8 -8
  34. package/dist/errors/UserError.js +16 -16
  35. package/dist/events/UnifiedSwapEventListener.d.ts +23 -23
  36. package/dist/events/UnifiedSwapEventListener.js +132 -132
  37. package/dist/http/HttpUtils.d.ts +27 -27
  38. package/dist/http/HttpUtils.js +91 -91
  39. package/dist/http/paramcoders/IParamReader.d.ts +8 -8
  40. package/dist/http/paramcoders/IParamReader.js +2 -2
  41. package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
  42. package/dist/http/paramcoders/ParamDecoder.js +137 -137
  43. package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
  44. package/dist/http/paramcoders/ParamEncoder.js +36 -36
  45. package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
  46. package/dist/http/paramcoders/SchemaVerifier.js +145 -145
  47. package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
  48. package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
  49. package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
  50. package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
  51. package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +16 -16
  52. package/dist/http/paramcoders/client/StreamingFetchPromise.js +174 -174
  53. package/dist/index.d.ts +85 -85
  54. package/dist/index.js +158 -158
  55. package/dist/intermediaries/Intermediary.d.ts +178 -178
  56. package/dist/intermediaries/Intermediary.js +166 -166
  57. package/dist/intermediaries/IntermediaryDiscovery.d.ts +211 -211
  58. package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
  59. package/dist/intermediaries/apis/IntermediaryAPI.d.ts +450 -440
  60. package/dist/intermediaries/apis/IntermediaryAPI.js +618 -603
  61. package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
  62. package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
  63. package/dist/lnurl/LNURL.d.ts +102 -102
  64. package/dist/lnurl/LNURL.js +321 -321
  65. package/dist/prices/RedundantSwapPrice.d.ts +110 -110
  66. package/dist/prices/RedundantSwapPrice.js +222 -222
  67. package/dist/prices/SingleSwapPrice.d.ts +34 -34
  68. package/dist/prices/SingleSwapPrice.js +44 -44
  69. package/dist/prices/SwapPriceWithChain.d.ts +107 -107
  70. package/dist/prices/SwapPriceWithChain.js +128 -128
  71. package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
  72. package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
  73. package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
  74. package/dist/prices/abstract/IPriceProvider.js +74 -74
  75. package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
  76. package/dist/prices/abstract/ISwapPrice.js +279 -279
  77. package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
  78. package/dist/prices/providers/BinancePriceProvider.js +30 -30
  79. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
  80. package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
  81. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
  82. package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
  83. package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
  84. package/dist/prices/providers/CustomPriceProvider.js +35 -35
  85. package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
  86. package/dist/prices/providers/KrakenPriceProvider.js +45 -45
  87. package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
  88. package/dist/prices/providers/OKXPriceProvider.js +29 -29
  89. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
  90. package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
  91. package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
  92. package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
  93. package/dist/storage/IUnifiedStorage.d.ts +85 -85
  94. package/dist/storage/IUnifiedStorage.js +2 -2
  95. package/dist/storage/UnifiedSwapStorage.d.ts +114 -114
  96. package/dist/storage/UnifiedSwapStorage.js +116 -116
  97. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
  98. package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
  99. package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
  100. package/dist/storage-browser/LocalStorageManager.js +93 -93
  101. package/dist/swapper/Swapper.d.ts +732 -692
  102. package/dist/swapper/Swapper.js +1713 -1657
  103. package/dist/swapper/SwapperFactory.d.ts +135 -135
  104. package/dist/swapper/SwapperFactory.js +162 -162
  105. package/dist/swapper/SwapperUtils.d.ts +206 -206
  106. package/dist/swapper/SwapperUtils.js +481 -481
  107. package/dist/swapper/SwapperWithChain.d.ts +404 -404
  108. package/dist/swapper/SwapperWithChain.js +469 -469
  109. package/dist/swapper/SwapperWithSigner.d.ts +322 -322
  110. package/dist/swapper/SwapperWithSigner.js +318 -318
  111. package/dist/swaps/IAddressSwap.d.ts +22 -22
  112. package/dist/swaps/IAddressSwap.js +14 -14
  113. package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
  114. package/dist/swaps/IBTCWalletSwap.js +18 -18
  115. package/dist/swaps/IClaimableSwap.d.ts +49 -49
  116. package/dist/swaps/IClaimableSwap.js +15 -15
  117. package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
  118. package/dist/swaps/IClaimableSwapWrapper.js +2 -2
  119. package/dist/swaps/IRefundableSwap.d.ts +43 -43
  120. package/dist/swaps/IRefundableSwap.js +14 -14
  121. package/dist/swaps/ISwap.d.ts +392 -392
  122. package/dist/swaps/ISwap.js +349 -349
  123. package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
  124. package/dist/swaps/ISwapWithGasDrop.js +12 -12
  125. package/dist/swaps/ISwapWrapper.d.ts +285 -285
  126. package/dist/swaps/ISwapWrapper.js +353 -353
  127. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
  128. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
  129. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
  130. package/dist/swaps/escrow_swaps/IEscrowSwap.js +170 -170
  131. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +128 -128
  132. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
  133. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +105 -105
  134. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +129 -129
  135. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
  136. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
  137. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
  138. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
  139. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +531 -531
  140. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1285 -1285
  141. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +190 -190
  142. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
  143. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +583 -583
  144. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1371 -1371
  145. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +235 -235
  146. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
  147. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +458 -458
  148. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1126 -1126
  149. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +202 -202
  150. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
  151. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +403 -403
  152. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +924 -924
  153. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
  154. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
  155. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
  156. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
  157. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +251 -251
  158. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +536 -536
  159. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
  160. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
  161. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +132 -132
  162. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
  163. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +637 -631
  164. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1448 -1444
  165. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +257 -225
  166. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -822
  167. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +261 -261
  168. package/dist/swaps/trusted/ln/LnForGasSwap.js +511 -511
  169. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
  170. package/dist/swaps/trusted/ln/LnForGasWrapper.js +83 -83
  171. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +342 -342
  172. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +715 -715
  173. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +69 -69
  174. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
  175. package/dist/types/AmountData.d.ts +10 -10
  176. package/dist/types/AmountData.js +2 -2
  177. package/dist/types/CustomPriceFunction.d.ts +11 -11
  178. package/dist/types/CustomPriceFunction.js +2 -2
  179. package/dist/types/PriceInfoType.d.ts +28 -28
  180. package/dist/types/PriceInfoType.js +57 -57
  181. package/dist/types/SwapExecutionAction.d.ts +88 -88
  182. package/dist/types/SwapExecutionAction.js +2 -2
  183. package/dist/types/SwapStateInfo.d.ts +5 -5
  184. package/dist/types/SwapStateInfo.js +2 -2
  185. package/dist/types/SwapWithSigner.d.ts +17 -17
  186. package/dist/types/SwapWithSigner.js +43 -43
  187. package/dist/types/Token.d.ts +99 -99
  188. package/dist/types/Token.js +76 -76
  189. package/dist/types/TokenAmount.d.ts +69 -69
  190. package/dist/types/TokenAmount.js +60 -60
  191. package/dist/types/fees/Fee.d.ts +50 -50
  192. package/dist/types/fees/Fee.js +2 -2
  193. package/dist/types/fees/FeeBreakdown.d.ts +11 -11
  194. package/dist/types/fees/FeeBreakdown.js +2 -2
  195. package/dist/types/fees/PercentagePPM.d.ts +17 -17
  196. package/dist/types/fees/PercentagePPM.js +18 -18
  197. package/dist/types/lnurl/LNURLPay.d.ts +61 -61
  198. package/dist/types/lnurl/LNURLPay.js +31 -31
  199. package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
  200. package/dist/types/lnurl/LNURLWithdraw.js +27 -27
  201. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
  202. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
  203. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
  204. package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
  205. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
  206. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
  207. package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
  208. package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
  209. package/dist/utils/BitcoinUtils.d.ts +16 -14
  210. package/dist/utils/BitcoinUtils.js +141 -102
  211. package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
  212. package/dist/utils/BitcoinWalletUtils.js +14 -14
  213. package/dist/utils/Logger.d.ts +7 -7
  214. package/dist/utils/Logger.js +12 -12
  215. package/dist/utils/RetryUtils.d.ts +22 -22
  216. package/dist/utils/RetryUtils.js +67 -67
  217. package/dist/utils/SwapUtils.d.ts +88 -88
  218. package/dist/utils/SwapUtils.js +72 -72
  219. package/dist/utils/TimeoutUtils.d.ts +17 -17
  220. package/dist/utils/TimeoutUtils.js +55 -55
  221. package/dist/utils/TokenUtils.d.ts +19 -19
  222. package/dist/utils/TokenUtils.js +37 -37
  223. package/dist/utils/TypeUtils.d.ts +7 -7
  224. package/dist/utils/TypeUtils.js +2 -2
  225. package/dist/utils/Utils.d.ts +67 -67
  226. package/dist/utils/Utils.js +208 -208
  227. package/package.json +43 -43
  228. package/src/SmartChainAssets.ts +186 -186
  229. package/src/bitcoin/coinselect2/accumulative.ts +69 -68
  230. package/src/bitcoin/coinselect2/blackjack.ts +50 -49
  231. package/src/bitcoin/coinselect2/index.ts +93 -92
  232. package/src/bitcoin/coinselect2/utils.ts +236 -195
  233. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -427
  234. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -99
  235. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -217
  236. package/src/enums/FeeType.ts +15 -15
  237. package/src/enums/SwapAmountType.ts +16 -16
  238. package/src/enums/SwapDirection.ts +15 -15
  239. package/src/enums/SwapSide.ts +16 -16
  240. package/src/enums/SwapType.ts +75 -75
  241. package/src/errors/IntermediaryError.ts +28 -28
  242. package/src/errors/RequestError.ts +64 -64
  243. package/src/errors/UserError.ts +15 -15
  244. package/src/events/UnifiedSwapEventListener.ts +173 -173
  245. package/src/http/HttpUtils.ts +91 -91
  246. package/src/http/paramcoders/IParamReader.ts +9 -9
  247. package/src/http/paramcoders/ParamDecoder.ts +145 -145
  248. package/src/http/paramcoders/ParamEncoder.ts +40 -40
  249. package/src/http/paramcoders/SchemaVerifier.ts +153 -153
  250. package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
  251. package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
  252. package/src/http/paramcoders/client/StreamingFetchPromise.ts +192 -192
  253. package/src/index.ts +140 -140
  254. package/src/intermediaries/Intermediary.ts +280 -280
  255. package/src/intermediaries/IntermediaryDiscovery.ts +541 -541
  256. package/src/intermediaries/apis/IntermediaryAPI.ts +963 -947
  257. package/src/intermediaries/apis/TrustedIntermediaryAPI.ts +257 -257
  258. package/src/lnurl/LNURL.ts +402 -402
  259. package/src/prices/RedundantSwapPrice.ts +264 -264
  260. package/src/prices/SingleSwapPrice.ts +50 -50
  261. package/src/prices/SwapPriceWithChain.ts +194 -194
  262. package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
  263. package/src/prices/abstract/IPriceProvider.ts +127 -127
  264. package/src/prices/abstract/ISwapPrice.ts +390 -390
  265. package/src/prices/providers/BinancePriceProvider.ts +48 -48
  266. package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
  267. package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
  268. package/src/prices/providers/CustomPriceProvider.ts +40 -40
  269. package/src/prices/providers/KrakenPriceProvider.ts +83 -83
  270. package/src/prices/providers/OKXPriceProvider.ts +59 -59
  271. package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
  272. package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
  273. package/src/storage/IUnifiedStorage.ts +95 -95
  274. package/src/storage/UnifiedSwapStorage.ts +141 -141
  275. package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
  276. package/src/storage-browser/LocalStorageManager.ts +106 -106
  277. package/src/swapper/Swapper.ts +2488 -2416
  278. package/src/swapper/SwapperFactory.ts +307 -307
  279. package/src/swapper/SwapperUtils.ts +570 -570
  280. package/src/swapper/SwapperWithChain.ts +707 -707
  281. package/src/swapper/SwapperWithSigner.ts +511 -511
  282. package/src/swaps/IAddressSwap.ts +30 -30
  283. package/src/swaps/IBTCWalletSwap.ts +92 -92
  284. package/src/swaps/IClaimableSwap.ts +65 -65
  285. package/src/swaps/IClaimableSwapWrapper.ts +17 -17
  286. package/src/swaps/IRefundableSwap.ts +58 -58
  287. package/src/swaps/ISwap.ts +703 -703
  288. package/src/swaps/ISwapWithGasDrop.ts +25 -25
  289. package/src/swaps/ISwapWrapper.ts +539 -539
  290. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
  291. package/src/swaps/escrow_swaps/IEscrowSwap.ts +269 -269
  292. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +282 -282
  293. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +169 -169
  294. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
  295. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
  296. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1473 -1474
  297. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +601 -601
  298. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1582 -1582
  299. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +750 -750
  300. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1299 -1299
  301. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +610 -610
  302. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1096 -1096
  303. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
  304. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
  305. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +786 -786
  306. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
  307. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +401 -401
  308. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +1812 -1799
  309. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1236 -1060
  310. package/src/swaps/trusted/ln/LnForGasSwap.ts +589 -589
  311. package/src/swaps/trusted/ln/LnForGasWrapper.ts +91 -91
  312. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +862 -862
  313. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +131 -131
  314. package/src/types/AmountData.ts +9 -9
  315. package/src/types/CustomPriceFunction.ts +11 -11
  316. package/src/types/PriceInfoType.ts +66 -66
  317. package/src/types/SwapExecutionAction.ts +99 -99
  318. package/src/types/SwapStateInfo.ts +6 -6
  319. package/src/types/SwapWithSigner.ts +61 -61
  320. package/src/types/Token.ts +163 -163
  321. package/src/types/TokenAmount.ts +132 -132
  322. package/src/types/fees/Fee.ts +56 -56
  323. package/src/types/fees/FeeBreakdown.ts +11 -11
  324. package/src/types/fees/PercentagePPM.ts +26 -26
  325. package/src/types/lnurl/LNURLPay.ts +79 -79
  326. package/src/types/lnurl/LNURLWithdraw.ts +61 -61
  327. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
  328. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
  329. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
  330. package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
  331. package/src/utils/BitcoinUtils.ts +132 -91
  332. package/src/utils/BitcoinWalletUtils.ts +15 -15
  333. package/src/utils/Logger.ts +14 -14
  334. package/src/utils/RetryUtils.ts +78 -78
  335. package/src/utils/SwapUtils.ts +99 -99
  336. package/src/utils/TimeoutUtils.ts +49 -49
  337. package/src/utils/TokenUtils.ts +33 -33
  338. package/src/utils/TypeUtils.ts +8 -8
  339. package/src/utils/Utils.ts +212 -212
@@ -1,707 +1,707 @@
1
- import {IntermediaryDiscovery, SwapBounds} from "../intermediaries/IntermediaryDiscovery";
2
- import {SwapType} from "../enums/SwapType";
3
- import {LnForGasSwap} from "../swaps/trusted/ln/LnForGasSwap";
4
- import {ISwap} from "../swaps/ISwap";
5
- import {IToBTCSwap} from "../swaps/escrow_swaps/tobtc/IToBTCSwap";
6
- import {ChainIds, MultiChain, SupportsSwapType, Swapper} from "./Swapper";
7
- import {FromBTCLNSwap} from "../swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap";
8
- import {FromBTCSwap} from "../swaps/escrow_swaps/frombtc/onchain/FromBTCSwap";
9
- import {ToBTCLNSwap} from "../swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap";
10
- import {ToBTCSwap} from "../swaps/escrow_swaps/tobtc/onchain/ToBTCSwap";
11
- import {SwapPriceWithChain} from "../prices/SwapPriceWithChain";
12
- import {BTC_NETWORK} from "@scure/btc-signer/utils";
13
- import {ToBTCOptions} from "../swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper";
14
- import {ToBTCLNOptions} from "../swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper";
15
- import {FromBTCOptions} from "../swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper";
16
- import {FromBTCLNOptions} from "../swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper";
17
- import {SwapperUtils} from "./SwapperUtils";
18
- import {SpvFromBTCOptions} from "../swaps/spv_swaps/SpvFromBTCWrapper";
19
- import {SpvFromBTCSwap} from "../swaps/spv_swaps/SpvFromBTCSwap";
20
- import {OnchainForGasSwap} from "../swaps/trusted/onchain/OnchainForGasSwap";
21
- import {SwapperWithSigner} from "./SwapperWithSigner";
22
- import {FromBTCLNAutoOptions} from "../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper";
23
- import {FromBTCLNAutoSwap} from "../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap";
24
- import {SwapAmountType} from "../enums/SwapAmountType";
25
- import {UserError} from "../errors/UserError";
26
- import {IClaimableSwap} from "../swaps/IClaimableSwap";
27
- import {TokenAmount} from "../types/TokenAmount";
28
- import {BitcoinTokens, BtcToken, isSCToken, SCToken, Token} from "../types/Token";
29
- import {LNURLWithdraw} from "../types/lnurl/LNURLWithdraw";
30
- import {LNURLPay} from "../types/lnurl/LNURLPay";
31
- import {MempoolApi, MempoolBitcoinRpc} from "@atomiqlabs/btc-mempool";
32
- import {LightningInvoiceCreateService} from "../types/wallets/LightningInvoiceCreateService";
33
- import {Messenger} from "@atomiqlabs/base";
34
- import {Intermediary} from "../intermediaries/Intermediary";
35
- import {SwapTypeMapping} from "../utils/SwapUtils";
36
- import {SwapSide} from "../enums/SwapSide";
37
-
38
- /**
39
- * Chain-specific wrapper around Swapper for a particular blockchain
40
- *
41
- * @category Core
42
- */
43
- export class SwapperWithChain<T extends MultiChain, ChainIdentifier extends ChainIds<T>> {
44
-
45
- /**
46
- * Underlying multichain swapper instance
47
- */
48
- private readonly swapper: Swapper<T>;
49
-
50
- /**
51
- * Smart chain identifier of this swapper with chain
52
- */
53
- readonly chainIdentifier: ChainIdentifier;
54
-
55
- /**
56
- * Pricing API used by the SDK
57
- */
58
- readonly prices: SwapPriceWithChain<T, ChainIdentifier>;
59
-
60
- /**
61
- * Intermediary discovery instance
62
- */
63
- get intermediaryDiscovery(): IntermediaryDiscovery {
64
- return this.swapper.intermediaryDiscovery;
65
- }
66
- /**
67
- * Miscellaneous utility functions
68
- */
69
- get Utils(): SwapperUtils<T> {
70
- return this.swapper.Utils;
71
- }
72
- /**
73
- * Helper information about various swap protocol and their features:
74
- * - `requiresInputWallet`: Whether a swap requires a connected wallet on the input chain able to sign
75
- * arbitrary transaction
76
- * - `requiresOutputWallet`: Whether a swap requires a connected wallet on the output chain able to sign
77
- * arbitrary transactions
78
- * - `supportsGasDrop`: Whether a swap supports the "gas drop" feature, allowing to user to receive a small
79
- * amount of native token as part of the swap when swapping to smart chains
80
- *
81
- * Uses a `Record` type here, use the {@link SwapProtocolInfo} import for a literal readonly type, with
82
- * pre-filled exact values in the type.
83
- */
84
- get SwapTypeInfo() {
85
- return this.swapper.SwapTypeInfo;
86
- }
87
-
88
- constructor(swapper: Swapper<T>, chainIdentifier: ChainIdentifier) {
89
- this.swapper = swapper;
90
- this.chainIdentifier = chainIdentifier;
91
- this.prices = new SwapPriceWithChain<T, ChainIdentifier>(swapper.prices, chainIdentifier);
92
- }
93
-
94
- /**
95
- * Creates Smart chain -> Bitcoin ({@link SwapType.TO_BTC}) swap
96
- *
97
- * @param signer Signer's address on the source chain
98
- * @param tokenAddress Token address to pay with
99
- * @param address Recipient's bitcoin address
100
- * @param amount Amount to send in token based units (if `exactIn=true`) or receive in satoshis (if `exactIn=false`)
101
- * @param exactIn Whether to use exact in instead of exact out
102
- * @param additionalParams Additional parameters sent to the LP when creating the swap
103
- * @param options Additional options for the swap
104
- */
105
- createToBTCSwap(
106
- signer: string,
107
- tokenAddress: string,
108
- address: string,
109
- amount: bigint,
110
- exactIn?: boolean,
111
- additionalParams?: Record<string, any>,
112
- options?: ToBTCOptions
113
- ): Promise<ToBTCSwap<T[ChainIdentifier]>> {
114
- return this.swapper.createToBTCSwap(this.chainIdentifier, signer, tokenAddress, address, amount, exactIn, additionalParams, options);
115
- }
116
-
117
- /**
118
- * Creates Smart chain -> Bitcoin Lightning ({@link SwapType.TO_BTCLN}) swap
119
- *
120
- * @param signer Signer's address on the source chain
121
- * @param tokenAddress Token address to pay with
122
- * @param paymentRequest BOLT11 lightning network invoice to be paid (needs to have a fixed amount), and the swap
123
- * amount is taken from this fixed amount, hence only exact output swaps are supported
124
- * @param additionalParams Additional parameters sent to the LP when creating the swap
125
- * @param options Additional options for the swap
126
- */
127
- createToBTCLNSwap(
128
- signer: string,
129
- tokenAddress: string,
130
- paymentRequest: string,
131
- additionalParams?: Record<string, any>,
132
- options?: ToBTCLNOptions & {comment?: string}
133
- ): Promise<ToBTCLNSwap<T[ChainIdentifier]>> {
134
- return this.swapper.createToBTCLNSwap(this.chainIdentifier, signer, tokenAddress, paymentRequest, additionalParams, options);
135
- }
136
-
137
- /**
138
- * Creates Smart chain -> Bitcoin Lightning ({@link SwapType.TO_BTCLN}) swap via LNURL-pay link
139
- *
140
- * @param signer Signer's address on the source chain
141
- * @param tokenAddress Token address to pay with
142
- * @param lnurlPay LNURL-pay link to use for the payment
143
- * @param amount Amount to send in token based units (if `exactIn=true`) or receive in satoshis (if `exactIn=false`)
144
- * @param exactIn Whether to do an exact in swap instead of exact out
145
- * @param additionalParams Additional parameters sent to the LP when creating the swap
146
- * @param options Additional options for the swap
147
- */
148
- createToBTCLNSwapViaLNURL(
149
- signer: string,
150
- tokenAddress: string,
151
- lnurlPay: string | LNURLPay,
152
- amount: bigint,
153
- exactIn?: boolean,
154
- additionalParams?: Record<string, any>,
155
- options?: ToBTCLNOptions
156
- ): Promise<ToBTCLNSwap<T[ChainIdentifier]>> {
157
- return this.swapper.createToBTCLNSwapViaLNURL(this.chainIdentifier, signer, tokenAddress, lnurlPay, amount, exactIn, additionalParams, options);
158
- }
159
-
160
- /**
161
- * Creates Smart chain -> Bitcoin Lightning ({@link SwapType.TO_BTCLN}) swap via {@link LightningInvoiceCreateService}
162
- *
163
- * @param signer Signer's address on the source chain
164
- * @param tokenAddress Token address to pay with
165
- * @param service Invoice create service object which facilitates the creation of fixed amount LN invoices
166
- * @param amount Amount to send in token based units (if `exactIn=true`) or receive in satoshis (if `exactIn=false`)
167
- * @param exactIn Whether to do an exact in swap instead of exact out
168
- * @param additionalParams Additional parameters sent to the LP when creating the swap
169
- * @param options Additional options for the swap
170
- */
171
- createToBTCLNSwapViaInvoiceCreateService(
172
- signer: string,
173
- tokenAddress: string,
174
- service: LightningInvoiceCreateService,
175
- amount: bigint,
176
- exactIn?: boolean,
177
- additionalParams?: Record<string, any>,
178
- options?: ToBTCLNOptions
179
- ): Promise<ToBTCLNSwap<T[ChainIdentifier]>> {
180
- return this.swapper.createToBTCLNSwapViaInvoiceCreateService(this.chainIdentifier, signer, tokenAddress, service, amount, exactIn, additionalParams, options);
181
- }
182
-
183
- /**
184
- * Creates Bitcoin -> Smart chain ({@link SwapType.SPV_VAULT_FROM_BTC}) swap
185
- *
186
- * @param recipient Recipient address on the destination chain
187
- * @param tokenAddress Token address to receive
188
- * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
189
- * @param exactOut Whether to use a exact out instead of exact in
190
- * @param additionalParams Additional parameters sent to the LP when creating the swap
191
- * @param options Additional options for the swap
192
- */
193
- async createFromBTCSwapNew(
194
- recipient: string,
195
- tokenAddress: string,
196
- amount: bigint,
197
- exactOut: boolean = false,
198
- additionalParams?: Record<string, any>,
199
- options?: SpvFromBTCOptions
200
- ): Promise<SpvFromBTCSwap<T[ChainIdentifier]>> {
201
- return this.swapper.createFromBTCSwapNew(this.chainIdentifier, recipient, tokenAddress, amount, exactOut, additionalParams, options);
202
- }
203
-
204
- /**
205
- * Creates LEGACY Bitcoin -> Smart chain ({@link SwapType.FROM_BTC}) swap
206
- *
207
- * @param recipient Recipient address on the destination chain
208
- * @param tokenAddress Token address to receive
209
- * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
210
- * @param exactOut Whether to use a exact out instead of exact in
211
- * @param additionalParams Additional parameters sent to the LP when creating the swap
212
- * @param options Additional options for the swap
213
- */
214
- createFromBTCSwap(
215
- recipient: string,
216
- tokenAddress: string,
217
- amount: bigint,
218
- exactOut?: boolean,
219
- additionalParams?: Record<string, any>,
220
- options?: FromBTCOptions
221
- ): Promise<FromBTCSwap<T[ChainIdentifier]>> {
222
- return this.swapper.createFromBTCSwap(this.chainIdentifier, recipient, tokenAddress, amount, exactOut, additionalParams, options);
223
- }
224
-
225
- /**
226
- * Creates LEGACY Bitcoin Lightning -> Smart chain ({@link SwapType.FROM_BTCLN}) swap
227
- *
228
- * @param recipient Recipient address on the destination chain
229
- * @param tokenAddress Token address to receive
230
- * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
231
- * @param exactOut Whether to use a exact out instead of exact in
232
- * @param additionalParams Additional parameters sent to the LP when creating the swap
233
- * @param options Additional options for the swap
234
- */
235
- createFromBTCLNSwap(
236
- recipient: string,
237
- tokenAddress: string,
238
- amount: bigint,
239
- exactOut?: boolean,
240
- additionalParams?: Record<string, any>,
241
- options?: FromBTCLNOptions
242
- ): Promise<FromBTCLNSwap<T[ChainIdentifier]>> {
243
- return this.swapper.createFromBTCLNSwap(this.chainIdentifier, recipient, tokenAddress, amount, exactOut, additionalParams, options);
244
- }
245
-
246
- /**
247
- * Creates LEGACY Bitcoin Lightning -> Smart chain ({@link SwapType.FROM_BTCLN}) swap, withdrawing from
248
- * an LNURL-withdraw link
249
- *
250
- * @param recipient Recipient address on the destination chain
251
- * @param tokenAddress Token address to receive
252
- * @param lnurl LNURL-withdraw link to pull the funds from
253
- * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
254
- * @param exactOut Whether to use a exact out instead of exact in
255
- * @param additionalParams Additional parameters sent to the LP when creating the swap
256
- */
257
- createFromBTCLNSwapViaLNURL(
258
- recipient: string,
259
- tokenAddress: string,
260
- lnurl: string | LNURLWithdraw,
261
- amount: bigint,
262
- exactOut?: boolean,
263
- additionalParams?: Record<string, any>
264
- ): Promise<FromBTCLNSwap<T[ChainIdentifier]>> {
265
- return this.swapper.createFromBTCLNSwapViaLNURL(this.chainIdentifier, recipient, tokenAddress, lnurl, amount, exactOut, additionalParams);
266
- }
267
-
268
- /**
269
- * Creates Bitcoin Lightning -> Smart chain ({@link SwapType.FROM_BTCLN_AUTO}) swap
270
- *
271
- * @param recipient Recipient address on the destination chain
272
- * @param tokenAddress Token address to receive
273
- * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
274
- * @param exactOut Whether to use a exact out instead of exact in
275
- * @param additionalParams Additional parameters sent to the LP when creating the swap
276
- * @param options Additional options for the swap
277
- */
278
- createFromBTCLNSwapNew(
279
- recipient: string,
280
- tokenAddress: string,
281
- amount: bigint,
282
- exactOut?: boolean,
283
- additionalParams?: Record<string, any>,
284
- options?: FromBTCLNAutoOptions
285
- ): Promise<FromBTCLNAutoSwap<T[ChainIdentifier]>> {
286
- return this.swapper.createFromBTCLNSwapNew(this.chainIdentifier, recipient, tokenAddress, amount, exactOut, additionalParams, options);
287
- }
288
-
289
- /**
290
- * Creates Bitcoin Lightning -> Smart chain ({@link SwapType.FROM_BTCLN_AUTO}) swap, withdrawing from
291
- * an LNURL-withdraw link
292
- *
293
- * @param recipient Recipient address on the destination chain
294
- * @param tokenAddress Token address to receive
295
- * @param lnurl LNURL-withdraw link to pull the funds from
296
- * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
297
- * @param exactOut Whether to use a exact out instead of exact in
298
- * @param additionalParams Additional parameters sent to the LP when creating the swap
299
- * @param options Additional options for the swap
300
- */
301
- createFromBTCLNSwapNewViaLNURL(
302
- recipient: string,
303
- tokenAddress: string,
304
- lnurl: string | LNURLWithdraw,
305
- amount: bigint,
306
- exactOut?: boolean,
307
- additionalParams?: Record<string, any>,
308
- options?: FromBTCLNAutoOptions
309
- ): Promise<FromBTCLNAutoSwap<T[ChainIdentifier]>> {
310
- return this.swapper.createFromBTCLNSwapNewViaLNURL(this.chainIdentifier, recipient, tokenAddress, lnurl, amount, exactOut, additionalParams, options);
311
- }
312
-
313
- /**
314
- * Creates a trusted Bitcoin Lightning -> Smart chain ({@link SwapType.TRUSTED_FROM_BTCLN}) gas swap
315
- *
316
- * @param recipient Recipient address on the destination chain
317
- * @param amount Amount of native token to receive, in base units
318
- * @param trustedIntermediaryOrUrl URL or Intermediary object of the trusted intermediary to use, otherwise uses default
319
- * @throws {Error} If no trusted intermediary specified
320
- */
321
- createTrustedLNForGasSwap(recipient: string, amount: bigint, trustedIntermediaryOrUrl?: Intermediary | string): Promise<LnForGasSwap<T[ChainIdentifier]>> {
322
- return this.swapper.createTrustedLNForGasSwap(this.chainIdentifier, recipient, amount, trustedIntermediaryOrUrl);
323
- }
324
-
325
- /**
326
- * Creates a trusted Bitcoin -> Smart chain ({@link SwapType.TRUSTED_FROM_BTC}) gas swap
327
- *
328
- * @param recipient Recipient address on the destination chain
329
- * @param amount Amount of native token to receive, in base units
330
- * @param refundAddress Bitcoin refund address, in case the swap fails the funds are refunded here
331
- * @param trustedIntermediaryOrUrl URL or Intermediary object of the trusted intermediary to use, otherwise uses default
332
- * @throws {Error} If no trusted intermediary specified
333
- */
334
- createTrustedOnchainForGasSwap(recipient: string, amount: bigint, refundAddress?: string, trustedIntermediaryOrUrl?: Intermediary | string): Promise<OnchainForGasSwap<T[ChainIdentifier]>> {
335
- return this.swapper.createTrustedOnchainForGasSwap(this.chainIdentifier, recipient, amount, refundAddress, trustedIntermediaryOrUrl);
336
- }
337
-
338
- /**
339
- * @internal
340
- */
341
- create(signer: string, srcToken: BtcToken<true>, dstToken: SCToken<ChainIdentifier>, amount: bigint, exactIn: boolean, lnurlWithdraw?: string | LNURLWithdraw): Promise<SupportsSwapType<T[ChainIdentifier], SwapType.FROM_BTCLN_AUTO> extends true ? FromBTCLNAutoSwap<T[ChainIdentifier]> : FromBTCLNSwap<T[ChainIdentifier]>>;
342
- /**
343
- * @internal
344
- */
345
- create(signer: string, srcToken: BtcToken<false>, dstToken: SCToken<ChainIdentifier>, amount: bigint, exactIn: boolean): Promise<(SupportsSwapType<T[ChainIdentifier], SwapType.SPV_VAULT_FROM_BTC> extends true ? SpvFromBTCSwap<T[ChainIdentifier]> : FromBTCSwap<T[ChainIdentifier]>)>;
346
- /**
347
- * @internal
348
- */
349
- create(signer: string, srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<false>, amount: bigint, exactIn: boolean, address: string): Promise<ToBTCSwap<T[ChainIdentifier]>>;
350
- /**
351
- * @internal
352
- */
353
- create(signer: string, srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true>, amount: bigint, exactIn: boolean, lnurlPay: string | LNURLPay): Promise<ToBTCLNSwap<T[ChainIdentifier]>>;
354
- /**
355
- * Creates a swap from srcToken to dstToken, of a specific token amount, either specifying input amount (exactIn=true)
356
- * or output amount (exactIn=false), NOTE: For regular -> BTC-LN (lightning) swaps the passed amount is ignored and
357
- * invoice's pre-set amount is used instead.
358
- * @deprecated Use swap() instead
359
- *
360
- * @param signer Smartchain (Solana, Starknet, etc.) address of the user
361
- * @param srcToken Source token of the swap, user pays this token
362
- * @param dstToken Destination token of the swap, user receives this token
363
- * @param amount Amount of the swap
364
- * @param exactIn Whether the amount specified is an input amount (exactIn=true) or an output amount (exactIn=false)
365
- * @param addressLnurlLightningInvoice Bitcoin on-chain address, lightning invoice, LNURL-pay to pay or
366
- * LNURL-withdrawal to withdraw money from
367
- */
368
- create(signer: string, srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true>, amount: undefined, exactIn: false, addressLnurlLightningInvoice: string): Promise<ToBTCLNSwap<T[ChainIdentifier]>>;
369
- /**
370
- * Creates a swap from srcToken to dstToken, of a specific token amount, either specifying input amount (exactIn=true)
371
- * or output amount (exactIn=false), NOTE: For regular -> BTC-LN (lightning) swaps the passed amount is ignored and
372
- * invoice's pre-set amount is used instead.
373
- * @deprecated Use swap() instead
374
- *
375
- * @param signer Smartchain (Solana, Starknet, etc.) address of the user
376
- * @param srcToken Source token of the swap, user pays this token
377
- * @param dstToken Destination token of the swap, user receives this token
378
- * @param amount Amount of the swap
379
- * @param exactIn Whether the amount specified is an input amount (exactIn=true) or an output amount (exactIn=false)
380
- * @param addressLnurlLightningInvoice Bitcoin on-chain address, lightning invoice, LNURL-pay to pay or
381
- * LNURL-withdrawal to withdraw money from
382
- */
383
- create(signer: string, srcToken: Token<ChainIdentifier>, dstToken: Token<ChainIdentifier>, amount: bigint | undefined, exactIn: boolean, addressLnurlLightningInvoice?: string | LNURLWithdraw | LNURLPay): Promise<ISwap<T[ChainIdentifier]>> {
384
- return this.swapper.create(signer, srcToken, dstToken, amount, exactIn, addressLnurlLightningInvoice);
385
- }
386
-
387
- /**
388
- * @internal
389
- */
390
- swap(srcToken: BtcToken<true> | "BTCLN" | "BTC-LN" | "LIGHTNING-BTC", dstToken: SCToken<ChainIdentifier>, amount: bigint | string, exactIn: boolean | SwapAmountType, src: undefined | string | LNURLWithdraw, dstSmartchainWallet: string, options?: (SupportsSwapType<T[ChainIdentifier], SwapType.FROM_BTCLN_AUTO> extends true ? FromBTCLNAutoOptions : FromBTCLNOptions)): Promise<SupportsSwapType<T[ChainIdentifier], SwapType.FROM_BTCLN_AUTO> extends true ? FromBTCLNAutoSwap<T[ChainIdentifier]> : FromBTCLNSwap<T[ChainIdentifier]>>;
391
- /**
392
- * @internal
393
- */
394
- swap(srcToken: BtcToken<false> | "BTC" | "BITCOIN-BTC", dstToken: SCToken<ChainIdentifier>, amount: bigint | string, exactIn: boolean | SwapAmountType, src: undefined | string, dstSmartchainWallet: string, options?: (SupportsSwapType<T[ChainIdentifier], SwapType.SPV_VAULT_FROM_BTC> extends true ? SpvFromBTCOptions : FromBTCOptions)): Promise<(SupportsSwapType<T[ChainIdentifier], SwapType.SPV_VAULT_FROM_BTC> extends true ? SpvFromBTCSwap<T[ChainIdentifier]> : FromBTCSwap<T[ChainIdentifier]>)>;
395
- /**
396
- * @internal
397
- */
398
- swap(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<false> | "BTC" | "BITCOIN-BTC", amount: bigint | string, exactIn: boolean | SwapAmountType, src: string, dstAddress: string, options?: ToBTCOptions): Promise<ToBTCSwap<T[ChainIdentifier]>>;
399
- /**
400
- * @internal
401
- */
402
- swap(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true> | "BTCLN" | "BTC-LN" | "LIGHTNING-BTC", amount: bigint | string, exactIn: boolean | SwapAmountType, src: string, dstLnurlPayOrInvoiceCreateService: string | LNURLPay | LightningInvoiceCreateService, options?: ToBTCLNOptions & {comment?: string}): Promise<ToBTCLNSwap<T[ChainIdentifier]>>;
403
- /**
404
- * @internal
405
- */
406
- swap(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true> | "BTCLN" | "BTC-LN" | "LIGHTNING-BTC", amount: undefined, exactIn: false | SwapAmountType.EXACT_OUT, src: string, dstLightningInvoice: string, options?: ToBTCLNOptions): Promise<ToBTCLNSwap<T[ChainIdentifier]>>;
407
- /**
408
- * Creates a swap from srcToken to dstToken, of a specific token amount, either specifying input amount (exactIn=true)
409
- * or output amount (exactIn=false), NOTE: For regular SmartChain -> BTC-LN (lightning) swaps the passed amount is ignored and
410
- * invoice's pre-set amount is used instead, use LNURL-pay for dynamic amounts
411
- *
412
- * @param srcToken Source token of the swap, user pays this token
413
- * @param dstToken Destination token of the swap, user receives this token
414
- * @param amount Amount of the swap
415
- * @param exactIn Whether the amount specified is an input amount (exactIn=true) or an output amount (exactIn=false)
416
- * @param src Source wallet/lnurl-withdraw of the swap
417
- * @param dst Destination smart chain address, bitcoin on-chain address, lightning invoice, LNURL-pay
418
- * @param options Options for the swap
419
- */
420
- swap(srcToken: Token<ChainIdentifier> | string, dstToken: Token<ChainIdentifier> | string, amount: bigint | string | undefined, exactIn: boolean | SwapAmountType, src: undefined | string | LNURLWithdraw, dst: string | LNURLPay | LightningInvoiceCreateService, options?: FromBTCLNOptions | SpvFromBTCOptions | FromBTCOptions | ToBTCOptions | (ToBTCLNOptions & {comment?: string}) | FromBTCLNAutoOptions): Promise<ISwap<T[ChainIdentifier]>>;
421
- /**
422
- * Creates a swap from srcToken to dstToken, of a specific token amount, either specifying input amount (exactIn=true)
423
- * or output amount (exactIn=false), NOTE: For regular SmartChain -> BTC-LN (lightning) swaps the passed amount is ignored and
424
- * invoice's pre-set amount is used instead, use LNURL-pay for dynamic amounts
425
- *
426
- * @param srcToken Source token of the swap, user pays this token
427
- * @param dstToken Destination token of the swap, user receives this token
428
- * @param amount Amount of the swap
429
- * @param exactIn Whether the amount specified is an input amount (exactIn=true) or an output amount (exactIn=false)
430
- * @param src Source wallet/lnurl-withdraw of the swap
431
- * @param dst Destination smart chain address, bitcoin on-chain address, lightning invoice, LNURL-pay
432
- * @param options Options for the swap
433
- */
434
- swap(
435
- srcToken: Token<ChainIdentifier> | string,
436
- dstToken: Token<ChainIdentifier> | string,
437
- amount: bigint | string | undefined,
438
- exactIn: boolean | SwapAmountType,
439
- src: undefined | string | LNURLWithdraw,
440
- dst: string | LNURLPay | LightningInvoiceCreateService,
441
- options?: FromBTCLNOptions | SpvFromBTCOptions | FromBTCOptions | ToBTCOptions | ToBTCLNOptions | FromBTCLNAutoOptions
442
- ): Promise<ISwap<T[ChainIdentifier]>> {
443
- if(typeof(srcToken)==="string") srcToken = this.getToken(srcToken);
444
- if(typeof(dstToken)==="string") dstToken = this.getToken(dstToken);
445
- return this.swapper.swap(srcToken, dstToken, amount, exactIn, src, dst, options);
446
- }
447
-
448
- /**
449
- * Returns swaps that are in-progress and are claimable for the specific chain, optionally also for a specific signer's address
450
- */
451
- getAllSwaps(signer?: string): Promise<ISwap<T[ChainIdentifier]>[]> {
452
- return this.swapper.getAllSwaps(this.chainIdentifier, signer);
453
- }
454
-
455
- /**
456
- * Returns swaps that are in-progress and are claimable for the specific chain, optionally also for a specific signer's address
457
- */
458
- getActionableSwaps(signer?: string): Promise<ISwap<T[ChainIdentifier]>[]> {
459
- return this.swapper.getActionableSwaps(this.chainIdentifier, signer);
460
- }
461
-
462
- /**
463
- * Returns swaps that are refundable for the specific chain, optionally also for a specific signer's address
464
- */
465
- getRefundableSwaps(signer?: string): Promise<IToBTCSwap<T[ChainIdentifier]>[]> {
466
- return this.swapper.getRefundableSwaps(this.chainIdentifier, signer);
467
- }
468
-
469
- /**
470
- * Returns swaps that are due to be claimed/settled manually for the specific chain,
471
- * optionally also for a specific signer's address
472
- */
473
- getClaimableSwaps(signer?: string): Promise<IClaimableSwap<T[ChainIdentifier]>[]> {
474
- return this.swapper.getClaimableSwaps(this.chainIdentifier, signer);
475
- }
476
-
477
- /**
478
- * Returns swap with a specific id (identifier) on a specific chain and optionally with a signer
479
- */
480
- getSwapById(id: string, signer?: string): Promise<ISwap<T[ChainIdentifier]>> {
481
- return this.swapper.getSwapById(id, this.chainIdentifier, signer);
482
- }
483
-
484
- /**
485
- * Returns the swap with a proper return type, or `undefined` if not found or has wrong type
486
- *
487
- * @param id An ID of the swap ({@link ISwap.getId})
488
- * @param swapType Type of the swap
489
- * @param signer An optional required smart chain signer address to fetch the swap for
490
- */
491
- async getTypedSwapById<S extends SwapType>(id: string, swapType: S, signer?: string): Promise<SwapTypeMapping<T[ChainIdentifier]>[S] | undefined> {
492
- return this.swapper.getTypedSwapById(id, this.chainIdentifier, swapType, signer);
493
- }
494
-
495
- /**
496
- * Synchronizes swaps from on-chain, this is ran automatically when SDK is initialized, hence
497
- * should only be ran manually when `dontCheckPastSwaps=true` is passed in the swapper options,
498
- * also deletes expired quotes
499
- *
500
- * @param signer Optional signer to only run swap sync for swaps initiated by this signer
501
- */
502
- async _syncSwaps(signer?: string): Promise<void> {
503
- return this.swapper._syncSwaps<ChainIdentifier>(this.chainIdentifier, signer);
504
- }
505
-
506
- /**
507
- * Recovers swaps from on-chain historical data.
508
- *
509
- * Please note that the recovered swaps might not be complete (i.e. missing amounts or addresses), as some
510
- * of the swap data is purely off-chain and can never be recovered purely from on-chain data. This
511
- * functions tries to recover as much swap data as possible.
512
- *
513
- * @param signer Signer address to recover the swaps for
514
- * @param startBlockheight Optional starting blockheight for swap data recovery, will only check swaps
515
- * initiated after this blockheight
516
- */
517
- async recoverSwaps(signer: string, startBlockheight?: number): Promise<ISwap<T[ChainIdentifier]>[]> {
518
- return this.swapper.recoverSwaps(this.chainIdentifier, signer, startBlockheight);
519
- }
520
-
521
- getToken(ticker: "BTC" | "BITCOIN-BTC"): BtcToken<false>;
522
- getToken(ticker: "BTCLN" | "BTC-LN" | "LIGHTNING-BTC"): BtcToken<true>;
523
- getToken(ticker: `${ChainIdentifier}-${string}`): SCToken<ChainIdentifier>;
524
- getToken(tickerOrAddress: string): Token<ChainIdentifier>;
525
- /**
526
- * Returns the {@link Token} object for a given token
527
- *
528
- * @param tickerOrAddress Token to return the object for, can use multiple formats:
529
- * - a) token ticker, such as `"BTC"`, `"SOL"`, etc.
530
- * - b) token ticker prefixed with smart chain identifier, such as `"SOLANA-SOL"`, `"SOLANA-USDC"`, etc.
531
- * - c) token address
532
- */
533
- getToken(tickerOrAddress: string): Token<ChainIdentifier> {
534
- //Btc tokens - BTC, BTCLN, BTC-LN
535
- if(tickerOrAddress==="BTC" || tickerOrAddress==="BITCOIN-BTC") return BitcoinTokens.BTC;
536
- if(tickerOrAddress==="BTCLN" || tickerOrAddress==="BTC-LN" || tickerOrAddress==="LIGHTNING-BTC") return BitcoinTokens.BTCLN;
537
-
538
- //Check if the ticker is in format <chainId>-<ticker>, i.e. SOLANA-USDC, STARKNET-WBTC
539
- if(tickerOrAddress.includes("-")) {
540
- const [chainId, ticker] = tickerOrAddress.split("-");
541
- if(chainId!==this.chainIdentifier) throw new UserError(`Invalid chainId specified in ticker: ${chainId}, swapper chainId: ${this.chainIdentifier}`);
542
- const token = this.swapper._tokensByTicker[this.chainIdentifier]?.[ticker];
543
- if(token==null) throw new UserError(`Not found ticker: ${ticker} for chainId: ${chainId}`);
544
- return token as Token<ChainIdentifier>;
545
- }
546
-
547
- const chain = this.swapper._chains[this.chainIdentifier];
548
- if(chain.chainInterface.isValidToken(tickerOrAddress)) {
549
- //Try to find in known token addresses
550
- const token = this.swapper._tokens[this.chainIdentifier]?.[tickerOrAddress];
551
- if(token!=null) return token as Token<ChainIdentifier>;
552
- } else {
553
- //Check in known tickers
554
- const token = this.swapper._tokensByTicker[this.chainIdentifier]?.[tickerOrAddress];
555
- if(token!=null) return token as Token<ChainIdentifier>;
556
- }
557
-
558
- throw new UserError(`Specified token address or ticker ${tickerOrAddress} not found for chainId: ${this.chainIdentifier}!`)
559
- }
560
-
561
- /**
562
- * Returns whether the SDK supports a given swap type on this chain based on currently known LPs
563
- *
564
- * @param swapType Swap protocol type
565
- */
566
- supportsSwapType<
567
- Type extends SwapType
568
- >(swapType: Type): SupportsSwapType<T[ChainIdentifier], Type> {
569
- return this.swapper.supportsSwapType(this.chainIdentifier, swapType);
570
- }
571
-
572
- /**
573
- * @internal
574
- */
575
- getSwapType(srcToken: BtcToken<true>, dstToken: SCToken<ChainIdentifier>): (SupportsSwapType<T[ChainIdentifier], SwapType.FROM_BTCLN_AUTO> extends true ? SwapType.FROM_BTCLN_AUTO : SwapType.FROM_BTCLN);
576
- /**
577
- * @internal
578
- */
579
- getSwapType(srcToken: BtcToken<false>, dstToken: SCToken<ChainIdentifier>): (SupportsSwapType<T[ChainIdentifier], SwapType.SPV_VAULT_FROM_BTC> extends true ? SwapType.SPV_VAULT_FROM_BTC : SwapType.FROM_BTC);
580
- /**
581
- * @internal
582
- */
583
- getSwapType(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<false>): SwapType.TO_BTC;
584
- /**
585
- * @internal
586
- */
587
- getSwapType(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true>): SwapType.TO_BTCLN;
588
- /**
589
- * Returns type of the swap based on input and output tokens specified
590
- *
591
- * @param srcToken Source token
592
- * @param dstToken Destination token
593
- */
594
- getSwapType(srcToken: Token<ChainIdentifier>, dstToken: Token<ChainIdentifier>): SwapType.FROM_BTCLN_AUTO | SwapType.FROM_BTCLN | SwapType.SPV_VAULT_FROM_BTC | SwapType.FROM_BTC | SwapType.TO_BTC | SwapType.TO_BTCLN;
595
- /**
596
- * Returns type of the swap based on input and output tokens specified
597
- *
598
- * @param srcToken Source token
599
- * @param dstToken Destination token
600
- */
601
- getSwapType(srcToken: Token<ChainIdentifier>, dstToken: Token<ChainIdentifier>): SwapType.FROM_BTCLN_AUTO | SwapType.FROM_BTCLN | SwapType.SPV_VAULT_FROM_BTC | SwapType.FROM_BTC | SwapType.TO_BTC | SwapType.TO_BTCLN {
602
- return this.swapper.getSwapType(srcToken, dstToken);
603
- }
604
-
605
- /**
606
- * Returns minimum/maximum limits for inputs and outputs for a swap between given tokens
607
- *
608
- * @param srcToken Source token
609
- * @param dstToken Destination token
610
- */
611
- getSwapLimits<A extends Token<ChainIdentifier>, B extends Token<ChainIdentifier>>(srcToken: A, dstToken: B): {
612
- input: {min: TokenAmount<A>, max?: TokenAmount<A>},
613
- output: {min: TokenAmount<B>, max?: TokenAmount<B>}
614
- } {
615
- return this.swapper.getSwapLimits<ChainIdentifier, A, B>(srcToken, dstToken);
616
- }
617
-
618
- /**
619
- * Returns a set of supported tokens by all the intermediaries offering a specific swap service
620
- *
621
- * @param _swapType Swap service type to check supported tokens for
622
- */
623
- private getSupportedTokens(_swapType: SwapType): SCToken<ChainIdentifier>[] {
624
- const tokens: SCToken<ChainIdentifier>[] = [];
625
- this.intermediaryDiscovery.intermediaries.forEach(lp => {
626
- let swapType = _swapType;
627
- if(swapType===SwapType.FROM_BTCLN && this.supportsSwapType(SwapType.FROM_BTCLN_AUTO)) swapType = SwapType.FROM_BTCLN_AUTO;
628
- if(swapType===SwapType.FROM_BTC && this.supportsSwapType(SwapType.SPV_VAULT_FROM_BTC)) swapType = SwapType.SPV_VAULT_FROM_BTC;
629
- const chainTokens = lp.services[swapType]?.chainTokens?.[this.chainIdentifier];
630
- if(chainTokens==null) return;
631
- for(let tokenAddress of chainTokens) {
632
- const token = this.swapper._tokens?.[this.chainIdentifier]?.[tokenAddress];
633
- if(token!=null) tokens.push(token as SCToken<ChainIdentifier>);
634
- }
635
- });
636
- return tokens;
637
- }
638
-
639
- /**
640
- * Returns the set of supported tokens by all the intermediaries we know of offering a specific swapType service
641
- *
642
- * @param swapType Specific swap type for which to obtain supported tokens
643
- */
644
- private getSupportedTokenAddresses(swapType: SwapType): Set<string> {
645
- const set = new Set<string>();
646
- this.intermediaryDiscovery.intermediaries.forEach(lp => {
647
- const chainTokens = lp.services[swapType]?.chainTokens?.[this.chainIdentifier];
648
- if(chainTokens==null) return;
649
- chainTokens.forEach(token => set.add(token));
650
- });
651
- return set;
652
- }
653
-
654
- /**
655
- * Returns tokens that you can swap to (if input=true) from a given token,
656
- * or tokens that you can swap from (if input=false) to a given token
657
- */
658
- getSwapCounterTokens(token: Token, input: SwapSide | boolean): Token<ChainIdentifier>[] {
659
- if(isSCToken(token)) {
660
- const result: Token<ChainIdentifier>[] = [];
661
- if(input) {
662
- //TO_BTC or TO_BTCLN
663
- if(this.getSupportedTokenAddresses(SwapType.TO_BTCLN).has(token.address)) {
664
- result.push(BitcoinTokens.BTCLN);
665
- }
666
- if(this.getSupportedTokenAddresses(SwapType.TO_BTC).has(token.address)) {
667
- result.push(BitcoinTokens.BTC);
668
- }
669
- } else {
670
- //FROM_BTC or FROM_BTCLN
671
- const fromLightningSwapType = this.supportsSwapType(SwapType.FROM_BTCLN_AUTO) ? SwapType.FROM_BTCLN_AUTO : SwapType.FROM_BTCLN;
672
- if(this.getSupportedTokenAddresses(fromLightningSwapType).has(token.address)) {
673
- result.push(BitcoinTokens.BTCLN);
674
- }
675
- const fromOnchainSwapType = this.supportsSwapType(SwapType.SPV_VAULT_FROM_BTC) ? SwapType.SPV_VAULT_FROM_BTC : SwapType.FROM_BTC;
676
- if(this.getSupportedTokenAddresses(fromOnchainSwapType).has(token.address)) {
677
- result.push(BitcoinTokens.BTC);
678
- }
679
- }
680
- return result;
681
- } else {
682
- if(input) {
683
- if(token.lightning) {
684
- return this.getSupportedTokens(SwapType.FROM_BTCLN);
685
- } else {
686
- return this.getSupportedTokens(SwapType.FROM_BTC);
687
- }
688
- } else {
689
- if(token.lightning) {
690
- return this.getSupportedTokens(SwapType.TO_BTCLN);
691
- } else {
692
- return this.getSupportedTokens(SwapType.TO_BTC);
693
- }
694
- }
695
- }
696
- }
697
-
698
- /**
699
- * Creates a child swapper instance with a signer
700
- *
701
- * @param signer Signer to use for the new swapper instance
702
- */
703
- withSigner(signer: T[ChainIdentifier]["Signer"]): SwapperWithSigner<T, ChainIdentifier> {
704
- return new SwapperWithSigner<T, ChainIdentifier>(this, signer);
705
- }
706
-
707
- }
1
+ import {IntermediaryDiscovery, SwapBounds} from "../intermediaries/IntermediaryDiscovery";
2
+ import {SwapType} from "../enums/SwapType";
3
+ import {LnForGasSwap} from "../swaps/trusted/ln/LnForGasSwap";
4
+ import {ISwap} from "../swaps/ISwap";
5
+ import {IToBTCSwap} from "../swaps/escrow_swaps/tobtc/IToBTCSwap";
6
+ import {ChainIds, MultiChain, SupportsSwapType, Swapper} from "./Swapper";
7
+ import {FromBTCLNSwap} from "../swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap";
8
+ import {FromBTCSwap} from "../swaps/escrow_swaps/frombtc/onchain/FromBTCSwap";
9
+ import {ToBTCLNSwap} from "../swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap";
10
+ import {ToBTCSwap} from "../swaps/escrow_swaps/tobtc/onchain/ToBTCSwap";
11
+ import {SwapPriceWithChain} from "../prices/SwapPriceWithChain";
12
+ import {BTC_NETWORK} from "@scure/btc-signer/utils";
13
+ import {ToBTCOptions} from "../swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper";
14
+ import {ToBTCLNOptions} from "../swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper";
15
+ import {FromBTCOptions} from "../swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper";
16
+ import {FromBTCLNOptions} from "../swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper";
17
+ import {SwapperUtils} from "./SwapperUtils";
18
+ import {SpvFromBTCOptions} from "../swaps/spv_swaps/SpvFromBTCWrapper";
19
+ import {SpvFromBTCSwap} from "../swaps/spv_swaps/SpvFromBTCSwap";
20
+ import {OnchainForGasSwap} from "../swaps/trusted/onchain/OnchainForGasSwap";
21
+ import {SwapperWithSigner} from "./SwapperWithSigner";
22
+ import {FromBTCLNAutoOptions} from "../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper";
23
+ import {FromBTCLNAutoSwap} from "../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap";
24
+ import {SwapAmountType} from "../enums/SwapAmountType";
25
+ import {UserError} from "../errors/UserError";
26
+ import {IClaimableSwap} from "../swaps/IClaimableSwap";
27
+ import {TokenAmount} from "../types/TokenAmount";
28
+ import {BitcoinTokens, BtcToken, isSCToken, SCToken, Token} from "../types/Token";
29
+ import {LNURLWithdraw} from "../types/lnurl/LNURLWithdraw";
30
+ import {LNURLPay} from "../types/lnurl/LNURLPay";
31
+ import {MempoolApi, MempoolBitcoinRpc} from "@atomiqlabs/btc-mempool";
32
+ import {LightningInvoiceCreateService} from "../types/wallets/LightningInvoiceCreateService";
33
+ import {Messenger} from "@atomiqlabs/base";
34
+ import {Intermediary} from "../intermediaries/Intermediary";
35
+ import {SwapTypeMapping} from "../utils/SwapUtils";
36
+ import {SwapSide} from "../enums/SwapSide";
37
+
38
+ /**
39
+ * Chain-specific wrapper around Swapper for a particular blockchain
40
+ *
41
+ * @category Core
42
+ */
43
+ export class SwapperWithChain<T extends MultiChain, ChainIdentifier extends ChainIds<T>> {
44
+
45
+ /**
46
+ * Underlying multichain swapper instance
47
+ */
48
+ private readonly swapper: Swapper<T>;
49
+
50
+ /**
51
+ * Smart chain identifier of this swapper with chain
52
+ */
53
+ readonly chainIdentifier: ChainIdentifier;
54
+
55
+ /**
56
+ * Pricing API used by the SDK
57
+ */
58
+ readonly prices: SwapPriceWithChain<T, ChainIdentifier>;
59
+
60
+ /**
61
+ * Intermediary discovery instance
62
+ */
63
+ get intermediaryDiscovery(): IntermediaryDiscovery {
64
+ return this.swapper.intermediaryDiscovery;
65
+ }
66
+ /**
67
+ * Miscellaneous utility functions
68
+ */
69
+ get Utils(): SwapperUtils<T> {
70
+ return this.swapper.Utils;
71
+ }
72
+ /**
73
+ * Helper information about various swap protocol and their features:
74
+ * - `requiresInputWallet`: Whether a swap requires a connected wallet on the input chain able to sign
75
+ * arbitrary transaction
76
+ * - `requiresOutputWallet`: Whether a swap requires a connected wallet on the output chain able to sign
77
+ * arbitrary transactions
78
+ * - `supportsGasDrop`: Whether a swap supports the "gas drop" feature, allowing to user to receive a small
79
+ * amount of native token as part of the swap when swapping to smart chains
80
+ *
81
+ * Uses a `Record` type here, use the {@link SwapProtocolInfo} import for a literal readonly type, with
82
+ * pre-filled exact values in the type.
83
+ */
84
+ get SwapTypeInfo() {
85
+ return this.swapper.SwapTypeInfo;
86
+ }
87
+
88
+ constructor(swapper: Swapper<T>, chainIdentifier: ChainIdentifier) {
89
+ this.swapper = swapper;
90
+ this.chainIdentifier = chainIdentifier;
91
+ this.prices = new SwapPriceWithChain<T, ChainIdentifier>(swapper.prices, chainIdentifier);
92
+ }
93
+
94
+ /**
95
+ * Creates Smart chain -> Bitcoin ({@link SwapType.TO_BTC}) swap
96
+ *
97
+ * @param signer Signer's address on the source chain
98
+ * @param tokenAddress Token address to pay with
99
+ * @param address Recipient's bitcoin address
100
+ * @param amount Amount to send in token based units (if `exactIn=true`) or receive in satoshis (if `exactIn=false`)
101
+ * @param exactIn Whether to use exact in instead of exact out
102
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
103
+ * @param options Additional options for the swap
104
+ */
105
+ createToBTCSwap(
106
+ signer: string,
107
+ tokenAddress: string,
108
+ address: string,
109
+ amount: bigint,
110
+ exactIn?: boolean,
111
+ additionalParams?: Record<string, any>,
112
+ options?: ToBTCOptions
113
+ ): Promise<ToBTCSwap<T[ChainIdentifier]>> {
114
+ return this.swapper.createToBTCSwap(this.chainIdentifier, signer, tokenAddress, address, amount, exactIn, additionalParams, options);
115
+ }
116
+
117
+ /**
118
+ * Creates Smart chain -> Bitcoin Lightning ({@link SwapType.TO_BTCLN}) swap
119
+ *
120
+ * @param signer Signer's address on the source chain
121
+ * @param tokenAddress Token address to pay with
122
+ * @param paymentRequest BOLT11 lightning network invoice to be paid (needs to have a fixed amount), and the swap
123
+ * amount is taken from this fixed amount, hence only exact output swaps are supported
124
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
125
+ * @param options Additional options for the swap
126
+ */
127
+ createToBTCLNSwap(
128
+ signer: string,
129
+ tokenAddress: string,
130
+ paymentRequest: string,
131
+ additionalParams?: Record<string, any>,
132
+ options?: ToBTCLNOptions & {comment?: string}
133
+ ): Promise<ToBTCLNSwap<T[ChainIdentifier]>> {
134
+ return this.swapper.createToBTCLNSwap(this.chainIdentifier, signer, tokenAddress, paymentRequest, additionalParams, options);
135
+ }
136
+
137
+ /**
138
+ * Creates Smart chain -> Bitcoin Lightning ({@link SwapType.TO_BTCLN}) swap via LNURL-pay link
139
+ *
140
+ * @param signer Signer's address on the source chain
141
+ * @param tokenAddress Token address to pay with
142
+ * @param lnurlPay LNURL-pay link to use for the payment
143
+ * @param amount Amount to send in token based units (if `exactIn=true`) or receive in satoshis (if `exactIn=false`)
144
+ * @param exactIn Whether to do an exact in swap instead of exact out
145
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
146
+ * @param options Additional options for the swap
147
+ */
148
+ createToBTCLNSwapViaLNURL(
149
+ signer: string,
150
+ tokenAddress: string,
151
+ lnurlPay: string | LNURLPay,
152
+ amount: bigint,
153
+ exactIn?: boolean,
154
+ additionalParams?: Record<string, any>,
155
+ options?: ToBTCLNOptions
156
+ ): Promise<ToBTCLNSwap<T[ChainIdentifier]>> {
157
+ return this.swapper.createToBTCLNSwapViaLNURL(this.chainIdentifier, signer, tokenAddress, lnurlPay, amount, exactIn, additionalParams, options);
158
+ }
159
+
160
+ /**
161
+ * Creates Smart chain -> Bitcoin Lightning ({@link SwapType.TO_BTCLN}) swap via {@link LightningInvoiceCreateService}
162
+ *
163
+ * @param signer Signer's address on the source chain
164
+ * @param tokenAddress Token address to pay with
165
+ * @param service Invoice create service object which facilitates the creation of fixed amount LN invoices
166
+ * @param amount Amount to send in token based units (if `exactIn=true`) or receive in satoshis (if `exactIn=false`)
167
+ * @param exactIn Whether to do an exact in swap instead of exact out
168
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
169
+ * @param options Additional options for the swap
170
+ */
171
+ createToBTCLNSwapViaInvoiceCreateService(
172
+ signer: string,
173
+ tokenAddress: string,
174
+ service: LightningInvoiceCreateService,
175
+ amount: bigint,
176
+ exactIn?: boolean,
177
+ additionalParams?: Record<string, any>,
178
+ options?: ToBTCLNOptions
179
+ ): Promise<ToBTCLNSwap<T[ChainIdentifier]>> {
180
+ return this.swapper.createToBTCLNSwapViaInvoiceCreateService(this.chainIdentifier, signer, tokenAddress, service, amount, exactIn, additionalParams, options);
181
+ }
182
+
183
+ /**
184
+ * Creates Bitcoin -> Smart chain ({@link SwapType.SPV_VAULT_FROM_BTC}) swap
185
+ *
186
+ * @param recipient Recipient address on the destination chain
187
+ * @param tokenAddress Token address to receive
188
+ * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
189
+ * @param exactOut Whether to use a exact out instead of exact in
190
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
191
+ * @param options Additional options for the swap
192
+ */
193
+ async createFromBTCSwapNew(
194
+ recipient: string,
195
+ tokenAddress: string,
196
+ amount: bigint,
197
+ exactOut: boolean = false,
198
+ additionalParams?: Record<string, any>,
199
+ options?: SpvFromBTCOptions
200
+ ): Promise<SpvFromBTCSwap<T[ChainIdentifier]>> {
201
+ return this.swapper.createFromBTCSwapNew(this.chainIdentifier, recipient, tokenAddress, amount, exactOut, additionalParams, options);
202
+ }
203
+
204
+ /**
205
+ * Creates LEGACY Bitcoin -> Smart chain ({@link SwapType.FROM_BTC}) swap
206
+ *
207
+ * @param recipient Recipient address on the destination chain
208
+ * @param tokenAddress Token address to receive
209
+ * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
210
+ * @param exactOut Whether to use a exact out instead of exact in
211
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
212
+ * @param options Additional options for the swap
213
+ */
214
+ createFromBTCSwap(
215
+ recipient: string,
216
+ tokenAddress: string,
217
+ amount: bigint,
218
+ exactOut?: boolean,
219
+ additionalParams?: Record<string, any>,
220
+ options?: FromBTCOptions
221
+ ): Promise<FromBTCSwap<T[ChainIdentifier]>> {
222
+ return this.swapper.createFromBTCSwap(this.chainIdentifier, recipient, tokenAddress, amount, exactOut, additionalParams, options);
223
+ }
224
+
225
+ /**
226
+ * Creates LEGACY Bitcoin Lightning -> Smart chain ({@link SwapType.FROM_BTCLN}) swap
227
+ *
228
+ * @param recipient Recipient address on the destination chain
229
+ * @param tokenAddress Token address to receive
230
+ * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
231
+ * @param exactOut Whether to use a exact out instead of exact in
232
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
233
+ * @param options Additional options for the swap
234
+ */
235
+ createFromBTCLNSwap(
236
+ recipient: string,
237
+ tokenAddress: string,
238
+ amount: bigint,
239
+ exactOut?: boolean,
240
+ additionalParams?: Record<string, any>,
241
+ options?: FromBTCLNOptions
242
+ ): Promise<FromBTCLNSwap<T[ChainIdentifier]>> {
243
+ return this.swapper.createFromBTCLNSwap(this.chainIdentifier, recipient, tokenAddress, amount, exactOut, additionalParams, options);
244
+ }
245
+
246
+ /**
247
+ * Creates LEGACY Bitcoin Lightning -> Smart chain ({@link SwapType.FROM_BTCLN}) swap, withdrawing from
248
+ * an LNURL-withdraw link
249
+ *
250
+ * @param recipient Recipient address on the destination chain
251
+ * @param tokenAddress Token address to receive
252
+ * @param lnurl LNURL-withdraw link to pull the funds from
253
+ * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
254
+ * @param exactOut Whether to use a exact out instead of exact in
255
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
256
+ */
257
+ createFromBTCLNSwapViaLNURL(
258
+ recipient: string,
259
+ tokenAddress: string,
260
+ lnurl: string | LNURLWithdraw,
261
+ amount: bigint,
262
+ exactOut?: boolean,
263
+ additionalParams?: Record<string, any>
264
+ ): Promise<FromBTCLNSwap<T[ChainIdentifier]>> {
265
+ return this.swapper.createFromBTCLNSwapViaLNURL(this.chainIdentifier, recipient, tokenAddress, lnurl, amount, exactOut, additionalParams);
266
+ }
267
+
268
+ /**
269
+ * Creates Bitcoin Lightning -> Smart chain ({@link SwapType.FROM_BTCLN_AUTO}) swap
270
+ *
271
+ * @param recipient Recipient address on the destination chain
272
+ * @param tokenAddress Token address to receive
273
+ * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
274
+ * @param exactOut Whether to use a exact out instead of exact in
275
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
276
+ * @param options Additional options for the swap
277
+ */
278
+ createFromBTCLNSwapNew(
279
+ recipient: string,
280
+ tokenAddress: string,
281
+ amount: bigint,
282
+ exactOut?: boolean,
283
+ additionalParams?: Record<string, any>,
284
+ options?: FromBTCLNAutoOptions
285
+ ): Promise<FromBTCLNAutoSwap<T[ChainIdentifier]>> {
286
+ return this.swapper.createFromBTCLNSwapNew(this.chainIdentifier, recipient, tokenAddress, amount, exactOut, additionalParams, options);
287
+ }
288
+
289
+ /**
290
+ * Creates Bitcoin Lightning -> Smart chain ({@link SwapType.FROM_BTCLN_AUTO}) swap, withdrawing from
291
+ * an LNURL-withdraw link
292
+ *
293
+ * @param recipient Recipient address on the destination chain
294
+ * @param tokenAddress Token address to receive
295
+ * @param lnurl LNURL-withdraw link to pull the funds from
296
+ * @param amount Amount to send in satoshis (if `exactOut=false`) or receive in token based units (if `exactOut=true`)
297
+ * @param exactOut Whether to use a exact out instead of exact in
298
+ * @param additionalParams Additional parameters sent to the LP when creating the swap
299
+ * @param options Additional options for the swap
300
+ */
301
+ createFromBTCLNSwapNewViaLNURL(
302
+ recipient: string,
303
+ tokenAddress: string,
304
+ lnurl: string | LNURLWithdraw,
305
+ amount: bigint,
306
+ exactOut?: boolean,
307
+ additionalParams?: Record<string, any>,
308
+ options?: FromBTCLNAutoOptions
309
+ ): Promise<FromBTCLNAutoSwap<T[ChainIdentifier]>> {
310
+ return this.swapper.createFromBTCLNSwapNewViaLNURL(this.chainIdentifier, recipient, tokenAddress, lnurl, amount, exactOut, additionalParams, options);
311
+ }
312
+
313
+ /**
314
+ * Creates a trusted Bitcoin Lightning -> Smart chain ({@link SwapType.TRUSTED_FROM_BTCLN}) gas swap
315
+ *
316
+ * @param recipient Recipient address on the destination chain
317
+ * @param amount Amount of native token to receive, in base units
318
+ * @param trustedIntermediaryOrUrl URL or Intermediary object of the trusted intermediary to use, otherwise uses default
319
+ * @throws {Error} If no trusted intermediary specified
320
+ */
321
+ createTrustedLNForGasSwap(recipient: string, amount: bigint, trustedIntermediaryOrUrl?: Intermediary | string): Promise<LnForGasSwap<T[ChainIdentifier]>> {
322
+ return this.swapper.createTrustedLNForGasSwap(this.chainIdentifier, recipient, amount, trustedIntermediaryOrUrl);
323
+ }
324
+
325
+ /**
326
+ * Creates a trusted Bitcoin -> Smart chain ({@link SwapType.TRUSTED_FROM_BTC}) gas swap
327
+ *
328
+ * @param recipient Recipient address on the destination chain
329
+ * @param amount Amount of native token to receive, in base units
330
+ * @param refundAddress Bitcoin refund address, in case the swap fails the funds are refunded here
331
+ * @param trustedIntermediaryOrUrl URL or Intermediary object of the trusted intermediary to use, otherwise uses default
332
+ * @throws {Error} If no trusted intermediary specified
333
+ */
334
+ createTrustedOnchainForGasSwap(recipient: string, amount: bigint, refundAddress?: string, trustedIntermediaryOrUrl?: Intermediary | string): Promise<OnchainForGasSwap<T[ChainIdentifier]>> {
335
+ return this.swapper.createTrustedOnchainForGasSwap(this.chainIdentifier, recipient, amount, refundAddress, trustedIntermediaryOrUrl);
336
+ }
337
+
338
+ /**
339
+ * @internal
340
+ */
341
+ create(signer: string, srcToken: BtcToken<true>, dstToken: SCToken<ChainIdentifier>, amount: bigint, exactIn: boolean, lnurlWithdraw?: string | LNURLWithdraw): Promise<SupportsSwapType<T[ChainIdentifier], SwapType.FROM_BTCLN_AUTO> extends true ? FromBTCLNAutoSwap<T[ChainIdentifier]> : FromBTCLNSwap<T[ChainIdentifier]>>;
342
+ /**
343
+ * @internal
344
+ */
345
+ create(signer: string, srcToken: BtcToken<false>, dstToken: SCToken<ChainIdentifier>, amount: bigint, exactIn: boolean): Promise<(SupportsSwapType<T[ChainIdentifier], SwapType.SPV_VAULT_FROM_BTC> extends true ? SpvFromBTCSwap<T[ChainIdentifier]> : FromBTCSwap<T[ChainIdentifier]>)>;
346
+ /**
347
+ * @internal
348
+ */
349
+ create(signer: string, srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<false>, amount: bigint, exactIn: boolean, address: string): Promise<ToBTCSwap<T[ChainIdentifier]>>;
350
+ /**
351
+ * @internal
352
+ */
353
+ create(signer: string, srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true>, amount: bigint, exactIn: boolean, lnurlPay: string | LNURLPay): Promise<ToBTCLNSwap<T[ChainIdentifier]>>;
354
+ /**
355
+ * Creates a swap from srcToken to dstToken, of a specific token amount, either specifying input amount (exactIn=true)
356
+ * or output amount (exactIn=false), NOTE: For regular -> BTC-LN (lightning) swaps the passed amount is ignored and
357
+ * invoice's pre-set amount is used instead.
358
+ * @deprecated Use swap() instead
359
+ *
360
+ * @param signer Smartchain (Solana, Starknet, etc.) address of the user
361
+ * @param srcToken Source token of the swap, user pays this token
362
+ * @param dstToken Destination token of the swap, user receives this token
363
+ * @param amount Amount of the swap
364
+ * @param exactIn Whether the amount specified is an input amount (exactIn=true) or an output amount (exactIn=false)
365
+ * @param addressLnurlLightningInvoice Bitcoin on-chain address, lightning invoice, LNURL-pay to pay or
366
+ * LNURL-withdrawal to withdraw money from
367
+ */
368
+ create(signer: string, srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true>, amount: undefined, exactIn: false, addressLnurlLightningInvoice: string): Promise<ToBTCLNSwap<T[ChainIdentifier]>>;
369
+ /**
370
+ * Creates a swap from srcToken to dstToken, of a specific token amount, either specifying input amount (exactIn=true)
371
+ * or output amount (exactIn=false), NOTE: For regular -> BTC-LN (lightning) swaps the passed amount is ignored and
372
+ * invoice's pre-set amount is used instead.
373
+ * @deprecated Use swap() instead
374
+ *
375
+ * @param signer Smartchain (Solana, Starknet, etc.) address of the user
376
+ * @param srcToken Source token of the swap, user pays this token
377
+ * @param dstToken Destination token of the swap, user receives this token
378
+ * @param amount Amount of the swap
379
+ * @param exactIn Whether the amount specified is an input amount (exactIn=true) or an output amount (exactIn=false)
380
+ * @param addressLnurlLightningInvoice Bitcoin on-chain address, lightning invoice, LNURL-pay to pay or
381
+ * LNURL-withdrawal to withdraw money from
382
+ */
383
+ create(signer: string, srcToken: Token<ChainIdentifier>, dstToken: Token<ChainIdentifier>, amount: bigint | undefined, exactIn: boolean, addressLnurlLightningInvoice?: string | LNURLWithdraw | LNURLPay): Promise<ISwap<T[ChainIdentifier]>> {
384
+ return this.swapper.create(signer, srcToken, dstToken, amount, exactIn, addressLnurlLightningInvoice);
385
+ }
386
+
387
+ /**
388
+ * @internal
389
+ */
390
+ swap(srcToken: BtcToken<true> | "BTCLN" | "BTC-LN" | "LIGHTNING-BTC", dstToken: SCToken<ChainIdentifier>, amount: bigint | string, exactIn: boolean | SwapAmountType, src: undefined | string | LNURLWithdraw, dstSmartchainWallet: string, options?: (SupportsSwapType<T[ChainIdentifier], SwapType.FROM_BTCLN_AUTO> extends true ? FromBTCLNAutoOptions : FromBTCLNOptions)): Promise<SupportsSwapType<T[ChainIdentifier], SwapType.FROM_BTCLN_AUTO> extends true ? FromBTCLNAutoSwap<T[ChainIdentifier]> : FromBTCLNSwap<T[ChainIdentifier]>>;
391
+ /**
392
+ * @internal
393
+ */
394
+ swap(srcToken: BtcToken<false> | "BTC" | "BITCOIN-BTC", dstToken: SCToken<ChainIdentifier>, amount: bigint | string, exactIn: boolean | SwapAmountType, src: undefined | string, dstSmartchainWallet: string, options?: (SupportsSwapType<T[ChainIdentifier], SwapType.SPV_VAULT_FROM_BTC> extends true ? SpvFromBTCOptions : FromBTCOptions)): Promise<(SupportsSwapType<T[ChainIdentifier], SwapType.SPV_VAULT_FROM_BTC> extends true ? SpvFromBTCSwap<T[ChainIdentifier]> : FromBTCSwap<T[ChainIdentifier]>)>;
395
+ /**
396
+ * @internal
397
+ */
398
+ swap(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<false> | "BTC" | "BITCOIN-BTC", amount: bigint | string, exactIn: boolean | SwapAmountType, src: string, dstAddress: string, options?: ToBTCOptions): Promise<ToBTCSwap<T[ChainIdentifier]>>;
399
+ /**
400
+ * @internal
401
+ */
402
+ swap(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true> | "BTCLN" | "BTC-LN" | "LIGHTNING-BTC", amount: bigint | string, exactIn: boolean | SwapAmountType, src: string, dstLnurlPayOrInvoiceCreateService: string | LNURLPay | LightningInvoiceCreateService, options?: ToBTCLNOptions & {comment?: string}): Promise<ToBTCLNSwap<T[ChainIdentifier]>>;
403
+ /**
404
+ * @internal
405
+ */
406
+ swap(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true> | "BTCLN" | "BTC-LN" | "LIGHTNING-BTC", amount: undefined, exactIn: false | SwapAmountType.EXACT_OUT, src: string, dstLightningInvoice: string, options?: ToBTCLNOptions): Promise<ToBTCLNSwap<T[ChainIdentifier]>>;
407
+ /**
408
+ * Creates a swap from srcToken to dstToken, of a specific token amount, either specifying input amount (exactIn=true)
409
+ * or output amount (exactIn=false), NOTE: For regular SmartChain -> BTC-LN (lightning) swaps the passed amount is ignored and
410
+ * invoice's pre-set amount is used instead, use LNURL-pay for dynamic amounts
411
+ *
412
+ * @param srcToken Source token of the swap, user pays this token
413
+ * @param dstToken Destination token of the swap, user receives this token
414
+ * @param amount Amount of the swap
415
+ * @param exactIn Whether the amount specified is an input amount (exactIn=true) or an output amount (exactIn=false)
416
+ * @param src Source wallet/lnurl-withdraw of the swap
417
+ * @param dst Destination smart chain address, bitcoin on-chain address, lightning invoice, LNURL-pay
418
+ * @param options Options for the swap
419
+ */
420
+ swap(srcToken: Token<ChainIdentifier> | string, dstToken: Token<ChainIdentifier> | string, amount: bigint | string | undefined, exactIn: boolean | SwapAmountType, src: undefined | string | LNURLWithdraw, dst: string | LNURLPay | LightningInvoiceCreateService, options?: FromBTCLNOptions | SpvFromBTCOptions | FromBTCOptions | ToBTCOptions | (ToBTCLNOptions & {comment?: string}) | FromBTCLNAutoOptions): Promise<ISwap<T[ChainIdentifier]>>;
421
+ /**
422
+ * Creates a swap from srcToken to dstToken, of a specific token amount, either specifying input amount (exactIn=true)
423
+ * or output amount (exactIn=false), NOTE: For regular SmartChain -> BTC-LN (lightning) swaps the passed amount is ignored and
424
+ * invoice's pre-set amount is used instead, use LNURL-pay for dynamic amounts
425
+ *
426
+ * @param srcToken Source token of the swap, user pays this token
427
+ * @param dstToken Destination token of the swap, user receives this token
428
+ * @param amount Amount of the swap
429
+ * @param exactIn Whether the amount specified is an input amount (exactIn=true) or an output amount (exactIn=false)
430
+ * @param src Source wallet/lnurl-withdraw of the swap
431
+ * @param dst Destination smart chain address, bitcoin on-chain address, lightning invoice, LNURL-pay
432
+ * @param options Options for the swap
433
+ */
434
+ swap(
435
+ srcToken: Token<ChainIdentifier> | string,
436
+ dstToken: Token<ChainIdentifier> | string,
437
+ amount: bigint | string | undefined,
438
+ exactIn: boolean | SwapAmountType,
439
+ src: undefined | string | LNURLWithdraw,
440
+ dst: string | LNURLPay | LightningInvoiceCreateService,
441
+ options?: FromBTCLNOptions | SpvFromBTCOptions | FromBTCOptions | ToBTCOptions | ToBTCLNOptions | FromBTCLNAutoOptions
442
+ ): Promise<ISwap<T[ChainIdentifier]>> {
443
+ if(typeof(srcToken)==="string") srcToken = this.getToken(srcToken);
444
+ if(typeof(dstToken)==="string") dstToken = this.getToken(dstToken);
445
+ return this.swapper.swap(srcToken, dstToken, amount, exactIn, src, dst, options);
446
+ }
447
+
448
+ /**
449
+ * Returns swaps that are in-progress and are claimable for the specific chain, optionally also for a specific signer's address
450
+ */
451
+ getAllSwaps(signer?: string): Promise<ISwap<T[ChainIdentifier]>[]> {
452
+ return this.swapper.getAllSwaps(this.chainIdentifier, signer);
453
+ }
454
+
455
+ /**
456
+ * Returns swaps that are in-progress and are claimable for the specific chain, optionally also for a specific signer's address
457
+ */
458
+ getActionableSwaps(signer?: string): Promise<ISwap<T[ChainIdentifier]>[]> {
459
+ return this.swapper.getActionableSwaps(this.chainIdentifier, signer);
460
+ }
461
+
462
+ /**
463
+ * Returns swaps that are refundable for the specific chain, optionally also for a specific signer's address
464
+ */
465
+ getRefundableSwaps(signer?: string): Promise<IToBTCSwap<T[ChainIdentifier]>[]> {
466
+ return this.swapper.getRefundableSwaps(this.chainIdentifier, signer);
467
+ }
468
+
469
+ /**
470
+ * Returns swaps that are due to be claimed/settled manually for the specific chain,
471
+ * optionally also for a specific signer's address
472
+ */
473
+ getClaimableSwaps(signer?: string): Promise<IClaimableSwap<T[ChainIdentifier]>[]> {
474
+ return this.swapper.getClaimableSwaps(this.chainIdentifier, signer);
475
+ }
476
+
477
+ /**
478
+ * Returns swap with a specific id (identifier) on a specific chain and optionally with a signer
479
+ */
480
+ getSwapById(id: string, signer?: string): Promise<ISwap<T[ChainIdentifier]>> {
481
+ return this.swapper.getSwapById(id, this.chainIdentifier, signer);
482
+ }
483
+
484
+ /**
485
+ * Returns the swap with a proper return type, or `undefined` if not found or has wrong type
486
+ *
487
+ * @param id An ID of the swap ({@link ISwap.getId})
488
+ * @param swapType Type of the swap
489
+ * @param signer An optional required smart chain signer address to fetch the swap for
490
+ */
491
+ async getTypedSwapById<S extends SwapType>(id: string, swapType: S, signer?: string): Promise<SwapTypeMapping<T[ChainIdentifier]>[S] | undefined> {
492
+ return this.swapper.getTypedSwapById(id, this.chainIdentifier, swapType, signer);
493
+ }
494
+
495
+ /**
496
+ * Synchronizes swaps from on-chain, this is ran automatically when SDK is initialized, hence
497
+ * should only be ran manually when `dontCheckPastSwaps=true` is passed in the swapper options,
498
+ * also deletes expired quotes
499
+ *
500
+ * @param signer Optional signer to only run swap sync for swaps initiated by this signer
501
+ */
502
+ async _syncSwaps(signer?: string): Promise<void> {
503
+ return this.swapper._syncSwaps<ChainIdentifier>(this.chainIdentifier, signer);
504
+ }
505
+
506
+ /**
507
+ * Recovers swaps from on-chain historical data.
508
+ *
509
+ * Please note that the recovered swaps might not be complete (i.e. missing amounts or addresses), as some
510
+ * of the swap data is purely off-chain and can never be recovered purely from on-chain data. This
511
+ * functions tries to recover as much swap data as possible.
512
+ *
513
+ * @param signer Signer address to recover the swaps for
514
+ * @param startBlockheight Optional starting blockheight for swap data recovery, will only check swaps
515
+ * initiated after this blockheight
516
+ */
517
+ async recoverSwaps(signer: string, startBlockheight?: number): Promise<ISwap<T[ChainIdentifier]>[]> {
518
+ return this.swapper.recoverSwaps(this.chainIdentifier, signer, startBlockheight);
519
+ }
520
+
521
+ getToken(ticker: "BTC" | "BITCOIN-BTC"): BtcToken<false>;
522
+ getToken(ticker: "BTCLN" | "BTC-LN" | "LIGHTNING-BTC"): BtcToken<true>;
523
+ getToken(ticker: `${ChainIdentifier}-${string}`): SCToken<ChainIdentifier>;
524
+ getToken(tickerOrAddress: string): Token<ChainIdentifier>;
525
+ /**
526
+ * Returns the {@link Token} object for a given token
527
+ *
528
+ * @param tickerOrAddress Token to return the object for, can use multiple formats:
529
+ * - a) token ticker, such as `"BTC"`, `"SOL"`, etc.
530
+ * - b) token ticker prefixed with smart chain identifier, such as `"SOLANA-SOL"`, `"SOLANA-USDC"`, etc.
531
+ * - c) token address
532
+ */
533
+ getToken(tickerOrAddress: string): Token<ChainIdentifier> {
534
+ //Btc tokens - BTC, BTCLN, BTC-LN
535
+ if(tickerOrAddress==="BTC" || tickerOrAddress==="BITCOIN-BTC") return BitcoinTokens.BTC;
536
+ if(tickerOrAddress==="BTCLN" || tickerOrAddress==="BTC-LN" || tickerOrAddress==="LIGHTNING-BTC") return BitcoinTokens.BTCLN;
537
+
538
+ //Check if the ticker is in format <chainId>-<ticker>, i.e. SOLANA-USDC, STARKNET-WBTC
539
+ if(tickerOrAddress.includes("-")) {
540
+ const [chainId, ticker] = tickerOrAddress.split("-");
541
+ if(chainId!==this.chainIdentifier) throw new UserError(`Invalid chainId specified in ticker: ${chainId}, swapper chainId: ${this.chainIdentifier}`);
542
+ const token = this.swapper._tokensByTicker[this.chainIdentifier]?.[ticker];
543
+ if(token==null) throw new UserError(`Not found ticker: ${ticker} for chainId: ${chainId}`);
544
+ return token as Token<ChainIdentifier>;
545
+ }
546
+
547
+ const chain = this.swapper._chains[this.chainIdentifier];
548
+ if(chain.chainInterface.isValidToken(tickerOrAddress)) {
549
+ //Try to find in known token addresses
550
+ const token = this.swapper._tokens[this.chainIdentifier]?.[tickerOrAddress];
551
+ if(token!=null) return token as Token<ChainIdentifier>;
552
+ } else {
553
+ //Check in known tickers
554
+ const token = this.swapper._tokensByTicker[this.chainIdentifier]?.[tickerOrAddress];
555
+ if(token!=null) return token as Token<ChainIdentifier>;
556
+ }
557
+
558
+ throw new UserError(`Specified token address or ticker ${tickerOrAddress} not found for chainId: ${this.chainIdentifier}!`)
559
+ }
560
+
561
+ /**
562
+ * Returns whether the SDK supports a given swap type on this chain based on currently known LPs
563
+ *
564
+ * @param swapType Swap protocol type
565
+ */
566
+ supportsSwapType<
567
+ Type extends SwapType
568
+ >(swapType: Type): SupportsSwapType<T[ChainIdentifier], Type> {
569
+ return this.swapper.supportsSwapType(this.chainIdentifier, swapType);
570
+ }
571
+
572
+ /**
573
+ * @internal
574
+ */
575
+ getSwapType(srcToken: BtcToken<true>, dstToken: SCToken<ChainIdentifier>): (SupportsSwapType<T[ChainIdentifier], SwapType.FROM_BTCLN_AUTO> extends true ? SwapType.FROM_BTCLN_AUTO : SwapType.FROM_BTCLN);
576
+ /**
577
+ * @internal
578
+ */
579
+ getSwapType(srcToken: BtcToken<false>, dstToken: SCToken<ChainIdentifier>): (SupportsSwapType<T[ChainIdentifier], SwapType.SPV_VAULT_FROM_BTC> extends true ? SwapType.SPV_VAULT_FROM_BTC : SwapType.FROM_BTC);
580
+ /**
581
+ * @internal
582
+ */
583
+ getSwapType(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<false>): SwapType.TO_BTC;
584
+ /**
585
+ * @internal
586
+ */
587
+ getSwapType(srcToken: SCToken<ChainIdentifier>, dstToken: BtcToken<true>): SwapType.TO_BTCLN;
588
+ /**
589
+ * Returns type of the swap based on input and output tokens specified
590
+ *
591
+ * @param srcToken Source token
592
+ * @param dstToken Destination token
593
+ */
594
+ getSwapType(srcToken: Token<ChainIdentifier>, dstToken: Token<ChainIdentifier>): SwapType.FROM_BTCLN_AUTO | SwapType.FROM_BTCLN | SwapType.SPV_VAULT_FROM_BTC | SwapType.FROM_BTC | SwapType.TO_BTC | SwapType.TO_BTCLN;
595
+ /**
596
+ * Returns type of the swap based on input and output tokens specified
597
+ *
598
+ * @param srcToken Source token
599
+ * @param dstToken Destination token
600
+ */
601
+ getSwapType(srcToken: Token<ChainIdentifier>, dstToken: Token<ChainIdentifier>): SwapType.FROM_BTCLN_AUTO | SwapType.FROM_BTCLN | SwapType.SPV_VAULT_FROM_BTC | SwapType.FROM_BTC | SwapType.TO_BTC | SwapType.TO_BTCLN {
602
+ return this.swapper.getSwapType(srcToken, dstToken);
603
+ }
604
+
605
+ /**
606
+ * Returns minimum/maximum limits for inputs and outputs for a swap between given tokens
607
+ *
608
+ * @param srcToken Source token
609
+ * @param dstToken Destination token
610
+ */
611
+ getSwapLimits<A extends Token<ChainIdentifier>, B extends Token<ChainIdentifier>>(srcToken: A, dstToken: B): {
612
+ input: {min: TokenAmount<A>, max?: TokenAmount<A>},
613
+ output: {min: TokenAmount<B>, max?: TokenAmount<B>}
614
+ } {
615
+ return this.swapper.getSwapLimits<ChainIdentifier, A, B>(srcToken, dstToken);
616
+ }
617
+
618
+ /**
619
+ * Returns a set of supported tokens by all the intermediaries offering a specific swap service
620
+ *
621
+ * @param _swapType Swap service type to check supported tokens for
622
+ */
623
+ private getSupportedTokens(_swapType: SwapType): SCToken<ChainIdentifier>[] {
624
+ const tokens: SCToken<ChainIdentifier>[] = [];
625
+ this.intermediaryDiscovery.intermediaries.forEach(lp => {
626
+ let swapType = _swapType;
627
+ if(swapType===SwapType.FROM_BTCLN && this.supportsSwapType(SwapType.FROM_BTCLN_AUTO)) swapType = SwapType.FROM_BTCLN_AUTO;
628
+ if(swapType===SwapType.FROM_BTC && this.supportsSwapType(SwapType.SPV_VAULT_FROM_BTC)) swapType = SwapType.SPV_VAULT_FROM_BTC;
629
+ const chainTokens = lp.services[swapType]?.chainTokens?.[this.chainIdentifier];
630
+ if(chainTokens==null) return;
631
+ for(let tokenAddress of chainTokens) {
632
+ const token = this.swapper._tokens?.[this.chainIdentifier]?.[tokenAddress];
633
+ if(token!=null) tokens.push(token as SCToken<ChainIdentifier>);
634
+ }
635
+ });
636
+ return tokens;
637
+ }
638
+
639
+ /**
640
+ * Returns the set of supported tokens by all the intermediaries we know of offering a specific swapType service
641
+ *
642
+ * @param swapType Specific swap type for which to obtain supported tokens
643
+ */
644
+ private getSupportedTokenAddresses(swapType: SwapType): Set<string> {
645
+ const set = new Set<string>();
646
+ this.intermediaryDiscovery.intermediaries.forEach(lp => {
647
+ const chainTokens = lp.services[swapType]?.chainTokens?.[this.chainIdentifier];
648
+ if(chainTokens==null) return;
649
+ chainTokens.forEach(token => set.add(token));
650
+ });
651
+ return set;
652
+ }
653
+
654
+ /**
655
+ * Returns tokens that you can swap to (if input=true) from a given token,
656
+ * or tokens that you can swap from (if input=false) to a given token
657
+ */
658
+ getSwapCounterTokens(token: Token, input: SwapSide | boolean): Token<ChainIdentifier>[] {
659
+ if(isSCToken(token)) {
660
+ const result: Token<ChainIdentifier>[] = [];
661
+ if(input) {
662
+ //TO_BTC or TO_BTCLN
663
+ if(this.getSupportedTokenAddresses(SwapType.TO_BTCLN).has(token.address)) {
664
+ result.push(BitcoinTokens.BTCLN);
665
+ }
666
+ if(this.getSupportedTokenAddresses(SwapType.TO_BTC).has(token.address)) {
667
+ result.push(BitcoinTokens.BTC);
668
+ }
669
+ } else {
670
+ //FROM_BTC or FROM_BTCLN
671
+ const fromLightningSwapType = this.supportsSwapType(SwapType.FROM_BTCLN_AUTO) ? SwapType.FROM_BTCLN_AUTO : SwapType.FROM_BTCLN;
672
+ if(this.getSupportedTokenAddresses(fromLightningSwapType).has(token.address)) {
673
+ result.push(BitcoinTokens.BTCLN);
674
+ }
675
+ const fromOnchainSwapType = this.supportsSwapType(SwapType.SPV_VAULT_FROM_BTC) ? SwapType.SPV_VAULT_FROM_BTC : SwapType.FROM_BTC;
676
+ if(this.getSupportedTokenAddresses(fromOnchainSwapType).has(token.address)) {
677
+ result.push(BitcoinTokens.BTC);
678
+ }
679
+ }
680
+ return result;
681
+ } else {
682
+ if(input) {
683
+ if(token.lightning) {
684
+ return this.getSupportedTokens(SwapType.FROM_BTCLN);
685
+ } else {
686
+ return this.getSupportedTokens(SwapType.FROM_BTC);
687
+ }
688
+ } else {
689
+ if(token.lightning) {
690
+ return this.getSupportedTokens(SwapType.TO_BTCLN);
691
+ } else {
692
+ return this.getSupportedTokens(SwapType.TO_BTC);
693
+ }
694
+ }
695
+ }
696
+ }
697
+
698
+ /**
699
+ * Creates a child swapper instance with a signer
700
+ *
701
+ * @param signer Signer to use for the new swapper instance
702
+ */
703
+ withSigner(signer: T[ChainIdentifier]["Signer"]): SwapperWithSigner<T, ChainIdentifier> {
704
+ return new SwapperWithSigner<T, ChainIdentifier>(this, signer);
705
+ }
706
+
707
+ }