@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,541 +1,541 @@
1
- import {Intermediary, ServicesType} from "./Intermediary";
2
- import {SwapType} from "../enums/SwapType";
3
- import {SpvVaultContract, SwapContract} from "@atomiqlabs/base";
4
- import {EventEmitter} from "events";
5
- import {Buffer} from "buffer";
6
- import {bigIntMax, bigIntMin, extendAbortController} from "../utils/Utils";
7
- import {IntermediaryAPI} from "./apis/IntermediaryAPI";
8
- import {getLogger} from "../utils/Logger";
9
- import {httpGet} from "../http/HttpUtils";
10
- import {tryWithRetries} from "../utils/RetryUtils";
11
-
12
- /**
13
- * Swap handler type mapping for intermediary communication
14
- *
15
- * @category LPs
16
- */
17
- export enum SwapHandlerType {
18
- TO_BTC = "TO_BTC",
19
- FROM_BTC = "FROM_BTC",
20
- TO_BTCLN = "TO_BTCLN",
21
- FROM_BTCLN = "FROM_BTCLN",
22
- FROM_BTC_TRUSTED = "FROM_BTC_TRUSTED",
23
- FROM_BTCLN_TRUSTED = "FROM_BTCLN_TRUSTED",
24
- FROM_BTC_SPV = "FROM_BTC_SPV",
25
- FROM_BTCLN_AUTO = "FROM_BTCLN_AUTO"
26
- }
27
-
28
- /**
29
- * Swap handler information type
30
- *
31
- * @category LPs
32
- */
33
- export type SwapHandlerInfoType = {
34
- swapFeePPM: number,
35
- swapBaseFee: number,
36
- min: number,
37
- max: number,
38
- tokens: string[],
39
- chainTokens?: {[chainId: string]: string[]};
40
- data?: any,
41
- };
42
-
43
- type InfoHandlerResponseEnvelope = {
44
- nonce: string,
45
- services: {
46
- [key in SwapHandlerType]?: SwapHandlerInfoType
47
- }
48
- };
49
-
50
- /**
51
- * Token bounds (min/max) for swaps
52
- *
53
- * @category LPs
54
- */
55
- export type TokenBounds = {
56
- [token: string]: {
57
- min: bigint,
58
- max: bigint
59
- }
60
- }
61
-
62
- /**
63
- * Multi-chain token bounds (min/max) for swaps
64
- *
65
- * @category LPs
66
- */
67
- export type MultichainTokenBounds = {
68
- [chainId: string]: TokenBounds
69
- }
70
-
71
- /**
72
- * Swap bounds by swap protocol type
73
- *
74
- * @category LPs
75
- */
76
- export type SwapBounds = {
77
- [key in SwapType]?: TokenBounds
78
- }
79
-
80
- /**
81
- * Multi-chain swap bounds
82
- *
83
- * @category LPs
84
- */
85
- export type MultichainSwapBounds = {
86
- [key in SwapType]?: MultichainTokenBounds
87
- }
88
-
89
- /**
90
- * Converts SwapHandlerType (represented as string & used in REST API communication with intermediaries) to regular
91
- * {@link SwapType}
92
- *
93
- * @param swapHandlerType
94
- */
95
- function swapHandlerTypeToSwapType(swapHandlerType: SwapHandlerType): SwapType {
96
- switch (swapHandlerType) {
97
- case SwapHandlerType.FROM_BTC:
98
- return SwapType.FROM_BTC;
99
- case SwapHandlerType.TO_BTC:
100
- return SwapType.TO_BTC;
101
- case SwapHandlerType.FROM_BTCLN:
102
- return SwapType.FROM_BTCLN;
103
- case SwapHandlerType.TO_BTCLN:
104
- return SwapType.TO_BTCLN;
105
- case SwapHandlerType.FROM_BTC_TRUSTED:
106
- return SwapType.TRUSTED_FROM_BTC;
107
- case SwapHandlerType.FROM_BTCLN_TRUSTED:
108
- return SwapType.TRUSTED_FROM_BTCLN;
109
- case SwapHandlerType.FROM_BTC_SPV:
110
- return SwapType.SPV_VAULT_FROM_BTC;
111
- case SwapHandlerType.FROM_BTCLN_AUTO:
112
- return SwapType.FROM_BTCLN_AUTO;
113
- default:
114
- return SwapType.TRUSTED_FROM_BTCLN;
115
- }
116
- }
117
-
118
- /**
119
- * A default intermediary comparator, only takes the announced fee into consideration
120
- *
121
- * @param swapType
122
- * @param tokenAddress
123
- * @param swapAmount
124
- */
125
- function getIntermediaryComparator(swapType: SwapType, tokenAddress: string, swapAmount?: bigint) {
126
-
127
- if(swapType===SwapType.TO_BTC) {
128
- //TODO: Also take reputation into account
129
- }
130
-
131
- return (a: Intermediary, b: Intermediary): number => {
132
- const aService = a.services[swapType];
133
- const bService = b.services[swapType];
134
- if(aService==null && bService==null) return 0;
135
- if(aService==null) return 1;
136
- if(bService==null) return -1;
137
-
138
- if(swapAmount==null) {
139
- return aService.swapFeePPM - bService.swapFeePPM;
140
- } else {
141
- const feeA = BigInt(aService.swapBaseFee) + (swapAmount * BigInt(aService.swapFeePPM) / 1000000n);
142
- const feeB = BigInt(bService.swapBaseFee) + (swapAmount * BigInt(bService.swapFeePPM) / 1000000n);
143
-
144
- return feeA - feeB > 0n ? 1 : feeA === feeB ? 0 : -1;
145
- }
146
- }
147
-
148
- }
149
-
150
- const logger = getLogger("IntermediaryDiscovery: ");
151
-
152
- const REGISTRY_URL = "https://api.github.com/repos/adambor/SolLightning-registry/contents/registry.json?ref=main";
153
-
154
- //To allow for legacy responses from not-yet updated LPs
155
- const DEFAULT_CHAIN = "SOLANA";
156
-
157
- /**
158
- * Discovery service for available intermediaries (liquidity providers)
159
- *
160
- * @category LPs
161
- */
162
- export class IntermediaryDiscovery extends EventEmitter {
163
-
164
- /**
165
- * A current list of active intermediaries
166
- */
167
- intermediaries: Intermediary[] = [];
168
-
169
- /**
170
- * Swap contracts for checking intermediary signatures
171
- */
172
- swapContracts: {[chainIdentifier: string]: {[contractVersion: string]: {swapContract: SwapContract, spvVaultContract: SpvVaultContract}}};
173
- /**
174
- * Registry URL used as a source for the list of intermediaries, this should be a link to a
175
- * github-hosted JSON file
176
- */
177
- registryUrl: string;
178
-
179
- /**
180
- * Timeout for the HTTP handshake (/info) requests sent to the intermediaries
181
- */
182
- httpRequestTimeout?: number;
183
- /**
184
- * Maximum time (in millis) to wait for other intermediary's responses after the first one was founds
185
- */
186
- maxWaitForOthersTimeout?: number;
187
-
188
- /**
189
- * The intermediary URLs passed in the constructor, to be used instead of querying the registry
190
- *
191
- * @private
192
- */
193
- private overrideNodeUrls?: string[];
194
-
195
- constructor(
196
- swapContracts: {[chainIdentifier: string]: {[contractVersion: string]: {swapContract: SwapContract, spvVaultContract: SpvVaultContract}}},
197
- registryUrl: string = REGISTRY_URL,
198
- nodeUrls?: string[],
199
- httpRequestTimeout?: number,
200
- maxWaitForOthersTimeout?: number
201
- ) {
202
- super();
203
- this.swapContracts = swapContracts;
204
- this.registryUrl = registryUrl;
205
- this.overrideNodeUrls = nodeUrls;
206
- this.httpRequestTimeout = httpRequestTimeout;
207
- this.maxWaitForOthersTimeout = maxWaitForOthersTimeout;
208
- }
209
-
210
- /**
211
- * Fetches the URLs of swap intermediaries from registry or from a pre-defined array of node urls
212
- *
213
- * @param abortSignal
214
- */
215
- private async getIntermediaryUrls(abortSignal?: AbortSignal): Promise<string[]> {
216
- if(this.overrideNodeUrls!=null && this.overrideNodeUrls.length>0) {
217
- return this.overrideNodeUrls;
218
- }
219
-
220
- const response = await tryWithRetries(
221
- () => httpGet<{content: string}>(this.registryUrl, this.httpRequestTimeout, abortSignal),
222
- {maxRetries: 3, delay: 100, exponential: true}
223
- );
224
-
225
- const content = response.content.replace(new RegExp("\\n", "g"), "");
226
-
227
- return JSON.parse(Buffer.from(content, "base64").toString()) as string[];
228
- }
229
-
230
- /**
231
- * Returns data as reported by a specific node (as identified by its URL). This function is specifically made
232
- * in a way, that in case the abortSignal fires AFTER the LP response was received (and during signature checking),
233
- * it proceeds with the addresses it was able to verify already. Hence after calling abort, this function is guaranteed
234
- * to either reject or resolve instantly.
235
- *
236
- * @param url
237
- * @param abortSignal
238
- */
239
- private async getNodeInfo(url: string, abortSignal?: AbortSignal) : Promise<{
240
- addresses: {[chainIdentifier: string]: string},
241
- contractVersions: {[chainIdentifier: string]: string},
242
- info: InfoHandlerResponseEnvelope
243
- }> {
244
- const response = await tryWithRetries(
245
- () => IntermediaryAPI.getIntermediaryInfo(url, this.httpRequestTimeout, abortSignal),
246
- {maxRetries: 3, delay: 100, exponential: true},
247
- undefined,
248
- abortSignal,
249
- "debug"
250
- );
251
- abortSignal?.throwIfAborted();
252
-
253
- const promises: Promise<void>[] = [];
254
- const addresses: {[chainIdentifier: string]: string} = {};
255
- const contractVersions: {[chainIdentifier: string]: string} = {};
256
- for(let chain in response.chains) {
257
- if(this.swapContracts[chain]!=null) {
258
- const {signature, address, contractVersion} = response.chains[chain];
259
- const _contractVersion = contractVersion ?? "v1";
260
- const contract = this.swapContracts[chain][_contractVersion];
261
- if(contract==null) {
262
- logger.warn("getNodeInfo(): Unknown chain contract version "+_contractVersion+" for "+chain+" reported by intermediary: "+url);
263
- continue;
264
- }
265
- promises.push((async () => {
266
- try {
267
- await contract.swapContract.isValidDataSignature(Buffer.from(response.envelope), signature, address);
268
- addresses[chain] = address;
269
- contractVersions[chain] = _contractVersion;
270
- } catch (e) {
271
- logger.warn("getNodeInfo(): Failed to verify "+chain+" signature for intermediary: "+url);
272
- }
273
- })());
274
- }
275
- }
276
-
277
- if(abortSignal!=null) {
278
- await Promise.race([
279
- Promise.all(promises),
280
- new Promise(resolve => abortSignal.addEventListener("abort", resolve))
281
- ]);
282
- } else {
283
- await Promise.all(promises);
284
- }
285
-
286
- //Handle legacy responses
287
- const info: InfoHandlerResponseEnvelope = JSON.parse(response.envelope);
288
- for(let swapType in info.services) {
289
- const serviceData: SwapHandlerInfoType = info.services[swapType as SwapHandlerType]!;
290
- if(serviceData.chainTokens==null) serviceData.chainTokens = {
291
- [DEFAULT_CHAIN]: serviceData.tokens
292
- };
293
- for(let chain in serviceData.chainTokens) {
294
- if(addresses[chain]==null) delete serviceData.chainTokens[chain];
295
- }
296
- }
297
-
298
- return {
299
- addresses,
300
- contractVersions,
301
- info
302
- };
303
- }
304
-
305
- /**
306
- * Inherits abort signal logic from `getNodeInfo()`, check those function docs to better understand
307
- *
308
- * @param url
309
- * @param abortSignal
310
- * @private
311
- */
312
- private async loadIntermediary(url: string, abortSignal?: AbortSignal): Promise<Intermediary | null> {
313
- try {
314
- const nodeInfo = await this.getNodeInfo(url, abortSignal);
315
- const services: ServicesType = {};
316
- for(let key in nodeInfo.info.services) {
317
- services[swapHandlerTypeToSwapType(key as SwapHandlerType)] = nodeInfo.info.services[key as SwapHandlerType];
318
- }
319
- return new Intermediary(url, nodeInfo.addresses, services, undefined, nodeInfo.contractVersions);
320
- } catch (e: any) {
321
- logger.warn("fetchIntermediaries(): Intermediary "+url+` is unreachable due to ${e.name ?? e.message} error, skipping...`);
322
- logger.debug("fetchIntermediaries(): Error contacting intermediary "+url+": ", e);
323
- return null;
324
- }
325
- }
326
-
327
- /**
328
- * Returns the intermediary at the provided URL, either from the already fetched list of LPs
329
- * or fetches the data on-demand, by sending the handshake HTTP request (/info) to the LP.
330
- *
331
- * Doesn't save the fetched intermediary to the list of intermediaries if it isn't already
332
- * part of the known intermediaries
333
- *
334
- * @param url Base URL of the intermediary, which accepts HTTP requests
335
- * @param abortSignal
336
- */
337
- getIntermediary(url: string, abortSignal?: AbortSignal): Promise<Intermediary | null> {
338
- const foundLp = this.intermediaries.find(lp => lp.url===url);
339
- if(foundLp!=null) return Promise.resolve(foundLp);
340
- return this.loadIntermediary(url, abortSignal);
341
- }
342
-
343
- /**
344
- * Reloads the saves a list of intermediaries
345
- *
346
- * @param abortSignal
347
- */
348
- async reloadIntermediaries(abortSignal?: AbortSignal): Promise<void> {
349
- //Get LP urls
350
- const urls = await this.getIntermediaryUrls(abortSignal);
351
-
352
- logger.debug("reloadIntermediaries(): Pinging intermediaries: ", urls.join());
353
-
354
- const abortController = extendAbortController(abortSignal);
355
- let timer: any;
356
- const intermediaries = await Promise.all(urls.map(url => this.loadIntermediary(url, abortController.signal).then(lp => {
357
- if(lp!=null && timer==null) timer = setTimeout(() => {
358
- //Trigger abort through the abort controller, such that all underlying promises resolve instantly
359
- abortController.abort();
360
- }, this.maxWaitForOthersTimeout ?? 5*1000);
361
- return lp;
362
- })));
363
- if(timer!=null) clearTimeout(timer);
364
-
365
- const activeNodes: Intermediary[] = intermediaries.filter(intermediary => intermediary!=null) as Intermediary[];
366
- if(activeNodes.length===0) logger.error("reloadIntermediaries(): No online intermediary found! Swaps might not be possible!");
367
-
368
- this.intermediaries = activeNodes;
369
- this.emit("added", activeNodes);
370
-
371
- logger.info("reloadIntermediaries(): Using active intermediaries: ", activeNodes.map(lp => lp.url).join());
372
- }
373
-
374
- /**
375
- * Initializes the discovery by fetching/reloading intermediaries
376
- *
377
- * @param abortSignal
378
- */
379
- init(abortSignal?: AbortSignal): Promise<void> {
380
- logger.info("init(): Initializing with registryUrl: "+this.registryUrl+" intermediary array: "+(this.overrideNodeUrls || []).join());
381
- return this.reloadIntermediaries(abortSignal);
382
- }
383
-
384
- /**
385
- * Returns known swap bounds (in satoshis - BTC) by aggregating values from all known intermediaries
386
- */
387
- getMultichainSwapBounds(): MultichainSwapBounds {
388
- const bounds: MultichainSwapBounds = {};
389
-
390
- this.intermediaries.forEach(intermediary => {
391
- for(let _swapType in intermediary.services) {
392
- const swapType = parseInt(_swapType) as SwapType;
393
- const swapService: SwapHandlerInfoType = intermediary.services[swapType]!;
394
- const multichainBounds: MultichainTokenBounds = (bounds[swapType] ??= {});
395
- for(let chainId in swapService.chainTokens) {
396
- multichainBounds[chainId] ??= {};
397
- const tokenBounds: TokenBounds = multichainBounds[chainId];
398
-
399
- for(let token of swapService.chainTokens[chainId]) {
400
- const tokenMinMax = tokenBounds[token];
401
- if(tokenMinMax==null) {
402
- tokenBounds[token] = {
403
- min: BigInt(swapService.min),
404
- max: BigInt(swapService.max)
405
- }
406
- } else {
407
- tokenMinMax.min = bigIntMin(tokenMinMax.min, BigInt(swapService.min));
408
- tokenMinMax.max = bigIntMax(tokenMinMax.max, BigInt(swapService.max));
409
- }
410
- }
411
- }
412
- }
413
- });
414
-
415
- return bounds;
416
- }
417
-
418
- /**
419
- * Returns aggregate swap bounds (in satoshis - BTC) as indicated by the intermediaries
420
- */
421
- getSwapBounds(chainIdentifier: string): SwapBounds {
422
- const bounds: SwapBounds = {};
423
-
424
- this.intermediaries.forEach(intermediary => {
425
- for(let _swapType in intermediary.services) {
426
- const swapType = parseInt(_swapType) as SwapType;
427
- const swapService: SwapHandlerInfoType = intermediary.services[swapType]!;
428
- const tokenBounds: TokenBounds = (bounds[swapType] ??= {});
429
- if(swapService.chainTokens!=null && swapService.chainTokens[chainIdentifier]!=null) {
430
- for(let token of swapService.chainTokens[chainIdentifier]) {
431
- const tokenMinMax = tokenBounds[token];
432
- if(tokenMinMax==null) {
433
- tokenBounds[token] = {
434
- min: BigInt(swapService.min),
435
- max: BigInt(swapService.max)
436
- }
437
- } else {
438
- tokenMinMax.min = bigIntMin(tokenMinMax.min, BigInt(swapService.min));
439
- tokenMinMax.max = bigIntMax(tokenMinMax.max, BigInt(swapService.max));
440
- }
441
- }
442
- }
443
- }
444
- });
445
-
446
- return bounds;
447
- }
448
-
449
- /**
450
- * Returns the aggregate swap minimum (in satoshis - BTC) for a specific swap type & token
451
- * as indicated by the intermediaries
452
- *
453
- * @param chainIdentifier Chain identifier of the smart chain
454
- * @param swapType Swap protocol type
455
- * @param tokenAddress Token address
456
- */
457
- getSwapMinimum(chainIdentifier: string, swapType: SwapType, tokenAddress: string): number | null {
458
- const tokenStr = tokenAddress.toString();
459
- return this.intermediaries.reduce<number | null>((prevMin: number | null, intermediary: Intermediary) => {
460
- const swapService = intermediary.services[swapType];
461
- if(swapService==null) return prevMin;
462
- const chainTokens = swapService.chainTokens?.[chainIdentifier];
463
- if(chainTokens==null) return prevMin;
464
- if(!chainTokens.includes(tokenStr)) return prevMin;
465
- return prevMin==null ? swapService.min : Math.min(prevMin, swapService.min);
466
- }, null);
467
- }
468
-
469
- /**
470
- * Returns the aggregate swap maximum (in satoshis - BTC) for a specific swap type & token
471
- * as indicated by the intermediaries
472
- *
473
- * @param chainIdentifier Chain identifier of the smart chain
474
- * @param swapType Swap protocol type
475
- * @param tokenAddress Token address
476
- */
477
- getSwapMaximum(chainIdentifier: string, swapType: SwapType, tokenAddress: string): number | null {
478
- const tokenStr = tokenAddress.toString();
479
- return this.intermediaries.reduce<number | null>((prevMax: number | null, intermediary: Intermediary) => {
480
- const swapService = intermediary.services[swapType];
481
- if(swapService==null) return prevMax;
482
- const chainTokens = swapService.chainTokens?.[chainIdentifier];
483
- if(chainTokens==null) return prevMax;
484
- if(!chainTokens.includes(tokenStr)) return prevMax;
485
- return prevMax==null ? swapService.max : Math.max(prevMax, swapService.max);
486
- }, null);
487
- }
488
-
489
- /**
490
- * Returns swap candidates for a specific swap type & token address
491
- *
492
- * @remark Also filters the LPs based on supported swap versions
493
- *
494
- * @param chainIdentifier Chain identifier of the smart chain
495
- * @param swapType Swap protocol type
496
- * @param tokenAddress Token address
497
- * @param amount Amount to be swapped in sats - BTC
498
- * @param count How many intermediaries to return at most
499
- */
500
- getSwapCandidates(chainIdentifier: string, swapType: SwapType, tokenAddress: string, amount?: bigint, count?: number): Intermediary[] {
501
- const candidates = this.intermediaries.filter(e => {
502
- const swapService = e.services[swapType];
503
- if(swapService==null) return false;
504
- if(amount!=null && amount < BigInt(swapService.min)) return false;
505
- if(amount!=null && amount > BigInt(swapService.max)) return false;
506
- if(swapService.chainTokens==null) return false;
507
- if(swapService.chainTokens[chainIdentifier]==null) return false;
508
- if(!swapService.chainTokens[chainIdentifier].includes(tokenAddress.toString())) return false;
509
- const contracts = this.swapContracts[chainIdentifier][e.getContractVersion(chainIdentifier) ?? "v1"];
510
- if(contracts==null) return false;
511
- if(swapType===SwapType.FROM_BTCLN_AUTO && !contracts.swapContract?.supportsInitWithoutClaimer) return false;
512
- if(swapType===SwapType.SPV_VAULT_FROM_BTC && contracts.spvVaultContract==null) return false;
513
- return true;
514
- });
515
-
516
- candidates.sort(getIntermediaryComparator(swapType, tokenAddress, amount));
517
-
518
- if(count==null) {
519
- return candidates;
520
- } else {
521
- return candidates.slice(0, count);
522
- }
523
- }
524
-
525
- /**
526
- * Removes a specific intermediary from the list of active intermediaries (used for blacklisting)
527
- *
528
- * @param intermediary
529
- */
530
- removeIntermediary(intermediary: Intermediary): boolean {
531
- const index = this.intermediaries.indexOf(intermediary);
532
- if(index>=0) {
533
- logger.info("removeIntermediary(): Removing intermediary: "+intermediary.url);
534
- this.intermediaries.splice(index, 1);
535
- this.emit("removed", [intermediary]);
536
- return true;
537
- }
538
- return false;
539
- }
540
-
541
- }
1
+ import {Intermediary, ServicesType} from "./Intermediary";
2
+ import {SwapType} from "../enums/SwapType";
3
+ import {SpvVaultContract, SwapContract} from "@atomiqlabs/base";
4
+ import {EventEmitter} from "events";
5
+ import {Buffer} from "buffer";
6
+ import {bigIntMax, bigIntMin, extendAbortController} from "../utils/Utils";
7
+ import {IntermediaryAPI} from "./apis/IntermediaryAPI";
8
+ import {getLogger} from "../utils/Logger";
9
+ import {httpGet} from "../http/HttpUtils";
10
+ import {tryWithRetries} from "../utils/RetryUtils";
11
+
12
+ /**
13
+ * Swap handler type mapping for intermediary communication
14
+ *
15
+ * @category LPs
16
+ */
17
+ export enum SwapHandlerType {
18
+ TO_BTC = "TO_BTC",
19
+ FROM_BTC = "FROM_BTC",
20
+ TO_BTCLN = "TO_BTCLN",
21
+ FROM_BTCLN = "FROM_BTCLN",
22
+ FROM_BTC_TRUSTED = "FROM_BTC_TRUSTED",
23
+ FROM_BTCLN_TRUSTED = "FROM_BTCLN_TRUSTED",
24
+ FROM_BTC_SPV = "FROM_BTC_SPV",
25
+ FROM_BTCLN_AUTO = "FROM_BTCLN_AUTO"
26
+ }
27
+
28
+ /**
29
+ * Swap handler information type
30
+ *
31
+ * @category LPs
32
+ */
33
+ export type SwapHandlerInfoType = {
34
+ swapFeePPM: number,
35
+ swapBaseFee: number,
36
+ min: number,
37
+ max: number,
38
+ tokens: string[],
39
+ chainTokens?: {[chainId: string]: string[]};
40
+ data?: any,
41
+ };
42
+
43
+ type InfoHandlerResponseEnvelope = {
44
+ nonce: string,
45
+ services: {
46
+ [key in SwapHandlerType]?: SwapHandlerInfoType
47
+ }
48
+ };
49
+
50
+ /**
51
+ * Token bounds (min/max) for swaps
52
+ *
53
+ * @category LPs
54
+ */
55
+ export type TokenBounds = {
56
+ [token: string]: {
57
+ min: bigint,
58
+ max: bigint
59
+ }
60
+ }
61
+
62
+ /**
63
+ * Multi-chain token bounds (min/max) for swaps
64
+ *
65
+ * @category LPs
66
+ */
67
+ export type MultichainTokenBounds = {
68
+ [chainId: string]: TokenBounds
69
+ }
70
+
71
+ /**
72
+ * Swap bounds by swap protocol type
73
+ *
74
+ * @category LPs
75
+ */
76
+ export type SwapBounds = {
77
+ [key in SwapType]?: TokenBounds
78
+ }
79
+
80
+ /**
81
+ * Multi-chain swap bounds
82
+ *
83
+ * @category LPs
84
+ */
85
+ export type MultichainSwapBounds = {
86
+ [key in SwapType]?: MultichainTokenBounds
87
+ }
88
+
89
+ /**
90
+ * Converts SwapHandlerType (represented as string & used in REST API communication with intermediaries) to regular
91
+ * {@link SwapType}
92
+ *
93
+ * @param swapHandlerType
94
+ */
95
+ function swapHandlerTypeToSwapType(swapHandlerType: SwapHandlerType): SwapType {
96
+ switch (swapHandlerType) {
97
+ case SwapHandlerType.FROM_BTC:
98
+ return SwapType.FROM_BTC;
99
+ case SwapHandlerType.TO_BTC:
100
+ return SwapType.TO_BTC;
101
+ case SwapHandlerType.FROM_BTCLN:
102
+ return SwapType.FROM_BTCLN;
103
+ case SwapHandlerType.TO_BTCLN:
104
+ return SwapType.TO_BTCLN;
105
+ case SwapHandlerType.FROM_BTC_TRUSTED:
106
+ return SwapType.TRUSTED_FROM_BTC;
107
+ case SwapHandlerType.FROM_BTCLN_TRUSTED:
108
+ return SwapType.TRUSTED_FROM_BTCLN;
109
+ case SwapHandlerType.FROM_BTC_SPV:
110
+ return SwapType.SPV_VAULT_FROM_BTC;
111
+ case SwapHandlerType.FROM_BTCLN_AUTO:
112
+ return SwapType.FROM_BTCLN_AUTO;
113
+ default:
114
+ return SwapType.TRUSTED_FROM_BTCLN;
115
+ }
116
+ }
117
+
118
+ /**
119
+ * A default intermediary comparator, only takes the announced fee into consideration
120
+ *
121
+ * @param swapType
122
+ * @param tokenAddress
123
+ * @param swapAmount
124
+ */
125
+ function getIntermediaryComparator(swapType: SwapType, tokenAddress: string, swapAmount?: bigint) {
126
+
127
+ if(swapType===SwapType.TO_BTC) {
128
+ //TODO: Also take reputation into account
129
+ }
130
+
131
+ return (a: Intermediary, b: Intermediary): number => {
132
+ const aService = a.services[swapType];
133
+ const bService = b.services[swapType];
134
+ if(aService==null && bService==null) return 0;
135
+ if(aService==null) return 1;
136
+ if(bService==null) return -1;
137
+
138
+ if(swapAmount==null) {
139
+ return aService.swapFeePPM - bService.swapFeePPM;
140
+ } else {
141
+ const feeA = BigInt(aService.swapBaseFee) + (swapAmount * BigInt(aService.swapFeePPM) / 1000000n);
142
+ const feeB = BigInt(bService.swapBaseFee) + (swapAmount * BigInt(bService.swapFeePPM) / 1000000n);
143
+
144
+ return feeA - feeB > 0n ? 1 : feeA === feeB ? 0 : -1;
145
+ }
146
+ }
147
+
148
+ }
149
+
150
+ const logger = getLogger("IntermediaryDiscovery: ");
151
+
152
+ const REGISTRY_URL = "https://api.github.com/repos/adambor/SolLightning-registry/contents/registry.json?ref=main";
153
+
154
+ //To allow for legacy responses from not-yet updated LPs
155
+ const DEFAULT_CHAIN = "SOLANA";
156
+
157
+ /**
158
+ * Discovery service for available intermediaries (liquidity providers)
159
+ *
160
+ * @category LPs
161
+ */
162
+ export class IntermediaryDiscovery extends EventEmitter {
163
+
164
+ /**
165
+ * A current list of active intermediaries
166
+ */
167
+ intermediaries: Intermediary[] = [];
168
+
169
+ /**
170
+ * Swap contracts for checking intermediary signatures
171
+ */
172
+ swapContracts: {[chainIdentifier: string]: {[contractVersion: string]: {swapContract: SwapContract, spvVaultContract: SpvVaultContract}}};
173
+ /**
174
+ * Registry URL used as a source for the list of intermediaries, this should be a link to a
175
+ * github-hosted JSON file
176
+ */
177
+ registryUrl: string;
178
+
179
+ /**
180
+ * Timeout for the HTTP handshake (/info) requests sent to the intermediaries
181
+ */
182
+ httpRequestTimeout?: number;
183
+ /**
184
+ * Maximum time (in millis) to wait for other intermediary's responses after the first one was founds
185
+ */
186
+ maxWaitForOthersTimeout?: number;
187
+
188
+ /**
189
+ * The intermediary URLs passed in the constructor, to be used instead of querying the registry
190
+ *
191
+ * @private
192
+ */
193
+ private overrideNodeUrls?: string[];
194
+
195
+ constructor(
196
+ swapContracts: {[chainIdentifier: string]: {[contractVersion: string]: {swapContract: SwapContract, spvVaultContract: SpvVaultContract}}},
197
+ registryUrl: string = REGISTRY_URL,
198
+ nodeUrls?: string[],
199
+ httpRequestTimeout?: number,
200
+ maxWaitForOthersTimeout?: number
201
+ ) {
202
+ super();
203
+ this.swapContracts = swapContracts;
204
+ this.registryUrl = registryUrl;
205
+ this.overrideNodeUrls = nodeUrls;
206
+ this.httpRequestTimeout = httpRequestTimeout;
207
+ this.maxWaitForOthersTimeout = maxWaitForOthersTimeout;
208
+ }
209
+
210
+ /**
211
+ * Fetches the URLs of swap intermediaries from registry or from a pre-defined array of node urls
212
+ *
213
+ * @param abortSignal
214
+ */
215
+ private async getIntermediaryUrls(abortSignal?: AbortSignal): Promise<string[]> {
216
+ if(this.overrideNodeUrls!=null && this.overrideNodeUrls.length>0) {
217
+ return this.overrideNodeUrls;
218
+ }
219
+
220
+ const response = await tryWithRetries(
221
+ () => httpGet<{content: string}>(this.registryUrl, this.httpRequestTimeout, abortSignal),
222
+ {maxRetries: 3, delay: 100, exponential: true}
223
+ );
224
+
225
+ const content = response.content.replace(new RegExp("\\n", "g"), "");
226
+
227
+ return JSON.parse(Buffer.from(content, "base64").toString()) as string[];
228
+ }
229
+
230
+ /**
231
+ * Returns data as reported by a specific node (as identified by its URL). This function is specifically made
232
+ * in a way, that in case the abortSignal fires AFTER the LP response was received (and during signature checking),
233
+ * it proceeds with the addresses it was able to verify already. Hence after calling abort, this function is guaranteed
234
+ * to either reject or resolve instantly.
235
+ *
236
+ * @param url
237
+ * @param abortSignal
238
+ */
239
+ private async getNodeInfo(url: string, abortSignal?: AbortSignal) : Promise<{
240
+ addresses: {[chainIdentifier: string]: string},
241
+ contractVersions: {[chainIdentifier: string]: string},
242
+ info: InfoHandlerResponseEnvelope
243
+ }> {
244
+ const response = await tryWithRetries(
245
+ () => IntermediaryAPI.getIntermediaryInfo(url, this.httpRequestTimeout, abortSignal),
246
+ {maxRetries: 3, delay: 100, exponential: true},
247
+ undefined,
248
+ abortSignal,
249
+ "debug"
250
+ );
251
+ abortSignal?.throwIfAborted();
252
+
253
+ const promises: Promise<void>[] = [];
254
+ const addresses: {[chainIdentifier: string]: string} = {};
255
+ const contractVersions: {[chainIdentifier: string]: string} = {};
256
+ for(let chain in response.chains) {
257
+ if(this.swapContracts[chain]!=null) {
258
+ const {signature, address, contractVersion} = response.chains[chain];
259
+ const _contractVersion = contractVersion ?? "v1";
260
+ const contract = this.swapContracts[chain][_contractVersion];
261
+ if(contract==null) {
262
+ logger.warn("getNodeInfo(): Unknown chain contract version "+_contractVersion+" for "+chain+" reported by intermediary: "+url);
263
+ continue;
264
+ }
265
+ promises.push((async () => {
266
+ try {
267
+ await contract.swapContract.isValidDataSignature(Buffer.from(response.envelope), signature, address);
268
+ addresses[chain] = address;
269
+ contractVersions[chain] = _contractVersion;
270
+ } catch (e) {
271
+ logger.warn("getNodeInfo(): Failed to verify "+chain+" signature for intermediary: "+url);
272
+ }
273
+ })());
274
+ }
275
+ }
276
+
277
+ if(abortSignal!=null) {
278
+ await Promise.race([
279
+ Promise.all(promises),
280
+ new Promise(resolve => abortSignal.addEventListener("abort", resolve))
281
+ ]);
282
+ } else {
283
+ await Promise.all(promises);
284
+ }
285
+
286
+ //Handle legacy responses
287
+ const info: InfoHandlerResponseEnvelope = JSON.parse(response.envelope);
288
+ for(let swapType in info.services) {
289
+ const serviceData: SwapHandlerInfoType = info.services[swapType as SwapHandlerType]!;
290
+ if(serviceData.chainTokens==null) serviceData.chainTokens = {
291
+ [DEFAULT_CHAIN]: serviceData.tokens
292
+ };
293
+ for(let chain in serviceData.chainTokens) {
294
+ if(addresses[chain]==null) delete serviceData.chainTokens[chain];
295
+ }
296
+ }
297
+
298
+ return {
299
+ addresses,
300
+ contractVersions,
301
+ info
302
+ };
303
+ }
304
+
305
+ /**
306
+ * Inherits abort signal logic from `getNodeInfo()`, check those function docs to better understand
307
+ *
308
+ * @param url
309
+ * @param abortSignal
310
+ * @private
311
+ */
312
+ private async loadIntermediary(url: string, abortSignal?: AbortSignal): Promise<Intermediary | null> {
313
+ try {
314
+ const nodeInfo = await this.getNodeInfo(url, abortSignal);
315
+ const services: ServicesType = {};
316
+ for(let key in nodeInfo.info.services) {
317
+ services[swapHandlerTypeToSwapType(key as SwapHandlerType)] = nodeInfo.info.services[key as SwapHandlerType];
318
+ }
319
+ return new Intermediary(url, nodeInfo.addresses, services, undefined, nodeInfo.contractVersions);
320
+ } catch (e: any) {
321
+ logger.warn("fetchIntermediaries(): Intermediary "+url+` is unreachable due to ${e.name ?? e.message} error, skipping...`);
322
+ logger.debug("fetchIntermediaries(): Error contacting intermediary "+url+": ", e);
323
+ return null;
324
+ }
325
+ }
326
+
327
+ /**
328
+ * Returns the intermediary at the provided URL, either from the already fetched list of LPs
329
+ * or fetches the data on-demand, by sending the handshake HTTP request (/info) to the LP.
330
+ *
331
+ * Doesn't save the fetched intermediary to the list of intermediaries if it isn't already
332
+ * part of the known intermediaries
333
+ *
334
+ * @param url Base URL of the intermediary, which accepts HTTP requests
335
+ * @param abortSignal
336
+ */
337
+ getIntermediary(url: string, abortSignal?: AbortSignal): Promise<Intermediary | null> {
338
+ const foundLp = this.intermediaries.find(lp => lp.url===url);
339
+ if(foundLp!=null) return Promise.resolve(foundLp);
340
+ return this.loadIntermediary(url, abortSignal);
341
+ }
342
+
343
+ /**
344
+ * Reloads the saves a list of intermediaries
345
+ *
346
+ * @param abortSignal
347
+ */
348
+ async reloadIntermediaries(abortSignal?: AbortSignal): Promise<void> {
349
+ //Get LP urls
350
+ const urls = await this.getIntermediaryUrls(abortSignal);
351
+
352
+ logger.debug("reloadIntermediaries(): Pinging intermediaries: ", urls.join());
353
+
354
+ const abortController = extendAbortController(abortSignal);
355
+ let timer: any;
356
+ const intermediaries = await Promise.all(urls.map(url => this.loadIntermediary(url, abortController.signal).then(lp => {
357
+ if(lp!=null && timer==null) timer = setTimeout(() => {
358
+ //Trigger abort through the abort controller, such that all underlying promises resolve instantly
359
+ abortController.abort();
360
+ }, this.maxWaitForOthersTimeout ?? 5*1000);
361
+ return lp;
362
+ })));
363
+ if(timer!=null) clearTimeout(timer);
364
+
365
+ const activeNodes: Intermediary[] = intermediaries.filter(intermediary => intermediary!=null) as Intermediary[];
366
+ if(activeNodes.length===0) logger.error("reloadIntermediaries(): No online intermediary found! Swaps might not be possible!");
367
+
368
+ this.intermediaries = activeNodes;
369
+ this.emit("added", activeNodes);
370
+
371
+ logger.info("reloadIntermediaries(): Using active intermediaries: ", activeNodes.map(lp => lp.url).join());
372
+ }
373
+
374
+ /**
375
+ * Initializes the discovery by fetching/reloading intermediaries
376
+ *
377
+ * @param abortSignal
378
+ */
379
+ init(abortSignal?: AbortSignal): Promise<void> {
380
+ logger.info("init(): Initializing with registryUrl: "+this.registryUrl+" intermediary array: "+(this.overrideNodeUrls || []).join());
381
+ return this.reloadIntermediaries(abortSignal);
382
+ }
383
+
384
+ /**
385
+ * Returns known swap bounds (in satoshis - BTC) by aggregating values from all known intermediaries
386
+ */
387
+ getMultichainSwapBounds(): MultichainSwapBounds {
388
+ const bounds: MultichainSwapBounds = {};
389
+
390
+ this.intermediaries.forEach(intermediary => {
391
+ for(let _swapType in intermediary.services) {
392
+ const swapType = parseInt(_swapType) as SwapType;
393
+ const swapService: SwapHandlerInfoType = intermediary.services[swapType]!;
394
+ const multichainBounds: MultichainTokenBounds = (bounds[swapType] ??= {});
395
+ for(let chainId in swapService.chainTokens) {
396
+ multichainBounds[chainId] ??= {};
397
+ const tokenBounds: TokenBounds = multichainBounds[chainId];
398
+
399
+ for(let token of swapService.chainTokens[chainId]) {
400
+ const tokenMinMax = tokenBounds[token];
401
+ if(tokenMinMax==null) {
402
+ tokenBounds[token] = {
403
+ min: BigInt(swapService.min),
404
+ max: BigInt(swapService.max)
405
+ }
406
+ } else {
407
+ tokenMinMax.min = bigIntMin(tokenMinMax.min, BigInt(swapService.min));
408
+ tokenMinMax.max = bigIntMax(tokenMinMax.max, BigInt(swapService.max));
409
+ }
410
+ }
411
+ }
412
+ }
413
+ });
414
+
415
+ return bounds;
416
+ }
417
+
418
+ /**
419
+ * Returns aggregate swap bounds (in satoshis - BTC) as indicated by the intermediaries
420
+ */
421
+ getSwapBounds(chainIdentifier: string): SwapBounds {
422
+ const bounds: SwapBounds = {};
423
+
424
+ this.intermediaries.forEach(intermediary => {
425
+ for(let _swapType in intermediary.services) {
426
+ const swapType = parseInt(_swapType) as SwapType;
427
+ const swapService: SwapHandlerInfoType = intermediary.services[swapType]!;
428
+ const tokenBounds: TokenBounds = (bounds[swapType] ??= {});
429
+ if(swapService.chainTokens!=null && swapService.chainTokens[chainIdentifier]!=null) {
430
+ for(let token of swapService.chainTokens[chainIdentifier]) {
431
+ const tokenMinMax = tokenBounds[token];
432
+ if(tokenMinMax==null) {
433
+ tokenBounds[token] = {
434
+ min: BigInt(swapService.min),
435
+ max: BigInt(swapService.max)
436
+ }
437
+ } else {
438
+ tokenMinMax.min = bigIntMin(tokenMinMax.min, BigInt(swapService.min));
439
+ tokenMinMax.max = bigIntMax(tokenMinMax.max, BigInt(swapService.max));
440
+ }
441
+ }
442
+ }
443
+ }
444
+ });
445
+
446
+ return bounds;
447
+ }
448
+
449
+ /**
450
+ * Returns the aggregate swap minimum (in satoshis - BTC) for a specific swap type & token
451
+ * as indicated by the intermediaries
452
+ *
453
+ * @param chainIdentifier Chain identifier of the smart chain
454
+ * @param swapType Swap protocol type
455
+ * @param tokenAddress Token address
456
+ */
457
+ getSwapMinimum(chainIdentifier: string, swapType: SwapType, tokenAddress: string): number | null {
458
+ const tokenStr = tokenAddress.toString();
459
+ return this.intermediaries.reduce<number | null>((prevMin: number | null, intermediary: Intermediary) => {
460
+ const swapService = intermediary.services[swapType];
461
+ if(swapService==null) return prevMin;
462
+ const chainTokens = swapService.chainTokens?.[chainIdentifier];
463
+ if(chainTokens==null) return prevMin;
464
+ if(!chainTokens.includes(tokenStr)) return prevMin;
465
+ return prevMin==null ? swapService.min : Math.min(prevMin, swapService.min);
466
+ }, null);
467
+ }
468
+
469
+ /**
470
+ * Returns the aggregate swap maximum (in satoshis - BTC) for a specific swap type & token
471
+ * as indicated by the intermediaries
472
+ *
473
+ * @param chainIdentifier Chain identifier of the smart chain
474
+ * @param swapType Swap protocol type
475
+ * @param tokenAddress Token address
476
+ */
477
+ getSwapMaximum(chainIdentifier: string, swapType: SwapType, tokenAddress: string): number | null {
478
+ const tokenStr = tokenAddress.toString();
479
+ return this.intermediaries.reduce<number | null>((prevMax: number | null, intermediary: Intermediary) => {
480
+ const swapService = intermediary.services[swapType];
481
+ if(swapService==null) return prevMax;
482
+ const chainTokens = swapService.chainTokens?.[chainIdentifier];
483
+ if(chainTokens==null) return prevMax;
484
+ if(!chainTokens.includes(tokenStr)) return prevMax;
485
+ return prevMax==null ? swapService.max : Math.max(prevMax, swapService.max);
486
+ }, null);
487
+ }
488
+
489
+ /**
490
+ * Returns swap candidates for a specific swap type & token address
491
+ *
492
+ * @remark Also filters the LPs based on supported swap versions
493
+ *
494
+ * @param chainIdentifier Chain identifier of the smart chain
495
+ * @param swapType Swap protocol type
496
+ * @param tokenAddress Token address
497
+ * @param amount Amount to be swapped in sats - BTC
498
+ * @param count How many intermediaries to return at most
499
+ */
500
+ getSwapCandidates(chainIdentifier: string, swapType: SwapType, tokenAddress: string, amount?: bigint, count?: number): Intermediary[] {
501
+ const candidates = this.intermediaries.filter(e => {
502
+ const swapService = e.services[swapType];
503
+ if(swapService==null) return false;
504
+ if(amount!=null && amount < BigInt(swapService.min)) return false;
505
+ if(amount!=null && amount > BigInt(swapService.max)) return false;
506
+ if(swapService.chainTokens==null) return false;
507
+ if(swapService.chainTokens[chainIdentifier]==null) return false;
508
+ if(!swapService.chainTokens[chainIdentifier].includes(tokenAddress.toString())) return false;
509
+ const contracts = this.swapContracts[chainIdentifier][e.getContractVersion(chainIdentifier) ?? "v1"];
510
+ if(contracts==null) return false;
511
+ if(swapType===SwapType.FROM_BTCLN_AUTO && !contracts.swapContract?.supportsInitWithoutClaimer) return false;
512
+ if(swapType===SwapType.SPV_VAULT_FROM_BTC && contracts.spvVaultContract==null) return false;
513
+ return true;
514
+ });
515
+
516
+ candidates.sort(getIntermediaryComparator(swapType, tokenAddress, amount));
517
+
518
+ if(count==null) {
519
+ return candidates;
520
+ } else {
521
+ return candidates.slice(0, count);
522
+ }
523
+ }
524
+
525
+ /**
526
+ * Removes a specific intermediary from the list of active intermediaries (used for blacklisting)
527
+ *
528
+ * @param intermediary
529
+ */
530
+ removeIntermediary(intermediary: Intermediary): boolean {
531
+ const index = this.intermediaries.indexOf(intermediary);
532
+ if(index>=0) {
533
+ logger.info("removeIntermediary(): Removing intermediary: "+intermediary.url);
534
+ this.intermediaries.splice(index, 1);
535
+ this.emit("removed", [intermediary]);
536
+ return true;
537
+ }
538
+ return false;
539
+ }
540
+
541
+ }