@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,406 +1,406 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.FromBTCWrapper = void 0;
4
- const IFromBTCWrapper_1 = require("../IFromBTCWrapper");
5
- const FromBTCSwap_1 = require("./FromBTCSwap");
6
- const base_1 = require("@atomiqlabs/base");
7
- const Intermediary_1 = require("../../../../intermediaries/Intermediary");
8
- const buffer_1 = require("buffer");
9
- const IntermediaryError_1 = require("../../../../errors/IntermediaryError");
10
- const SwapType_1 = require("../../../../enums/SwapType");
11
- const Utils_1 = require("../../../../utils/Utils");
12
- const BitcoinUtils_1 = require("../../../../utils/BitcoinUtils");
13
- const IntermediaryAPI_1 = require("../../../../intermediaries/apis/IntermediaryAPI");
14
- const RequestError_1 = require("../../../../errors/RequestError");
15
- const utils_1 = require("@scure/btc-signer/utils");
16
- const RetryUtils_1 = require("../../../../utils/RetryUtils");
17
- /**
18
- * Legacy escrow (PrTLC) based swap for Bitcoin -> Smart chains, requires manual initiation
19
- * of the swap escrow on the destination chain.
20
- *
21
- * @category Swaps/Legacy/Bitcoin → Smart chain
22
- */
23
- class FromBTCWrapper extends IFromBTCWrapper_1.IFromBTCWrapper {
24
- /**
25
- * @param chainIdentifier
26
- * @param unifiedStorage Storage interface for the current environment
27
- * @param unifiedChainEvents On-chain event listener
28
- * @param chain
29
- * @param prices Pricing to use
30
- * @param tokens
31
- * @param versionedContracts
32
- * @param versionedSynchronizer
33
- * @param btcRpc Bitcoin RPC which also supports getting transactions by txoHash
34
- * @param options
35
- * @param events Instance to use for emitting events
36
- */
37
- constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, versionedSynchronizer, btcRpc, options, events) {
38
- super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, {
39
- ...options,
40
- bitcoinNetwork: options?.bitcoinNetwork ?? utils_1.TEST_NETWORK,
41
- safetyFactor: options?.safetyFactor ?? 2,
42
- blocksTillTxConfirms: options?.blocksTillTxConfirms ?? 12,
43
- maxConfirmations: options?.maxConfirmations ?? 6,
44
- minSendWindow: options?.minSendWindow ?? 30 * 60,
45
- bitcoinBlocktime: options?.bitcoinBlocktime ?? 10 * 60
46
- }, versionedContracts, events);
47
- this.TYPE = SwapType_1.SwapType.FROM_BTC;
48
- /**
49
- * @internal
50
- */
51
- this.tickSwapState = [FromBTCSwap_1.FromBTCSwapState.PR_CREATED, FromBTCSwap_1.FromBTCSwapState.CLAIM_COMMITED, FromBTCSwap_1.FromBTCSwapState.EXPIRED];
52
- /**
53
- * @internal
54
- */
55
- this._pendingSwapStates = [
56
- FromBTCSwap_1.FromBTCSwapState.PR_CREATED,
57
- FromBTCSwap_1.FromBTCSwapState.QUOTE_SOFT_EXPIRED,
58
- FromBTCSwap_1.FromBTCSwapState.CLAIM_COMMITED,
59
- FromBTCSwap_1.FromBTCSwapState.BTC_TX_CONFIRMED,
60
- FromBTCSwap_1.FromBTCSwapState.EXPIRED
61
- ];
62
- /**
63
- * @internal
64
- */
65
- this._claimableSwapStates = [FromBTCSwap_1.FromBTCSwapState.BTC_TX_CONFIRMED];
66
- /**
67
- * @internal
68
- */
69
- this._swapDeserializer = FromBTCSwap_1.FromBTCSwap;
70
- /**
71
- * @internal
72
- */
73
- this._synchronizer = (version) => {
74
- const _version = version ?? "v1";
75
- const data = this.versionedSynchronizer[_version];
76
- if (data == null)
77
- throw new Error(`Invalid contract version ${_version} requested`);
78
- return data.synchronizer;
79
- };
80
- this.btcRelay = (version) => {
81
- const _version = version ?? "v1";
82
- const data = this.versionedBtcRelay[_version];
83
- if (data == null)
84
- throw new Error(`Invalid contract version ${_version} requested`);
85
- return data.btcRelay;
86
- };
87
- this.versionedBtcRelay = {};
88
- this.versionedSynchronizer = {};
89
- this._btcRpc = btcRpc;
90
- this.versionedBtcRelay = versionedContracts;
91
- this.versionedSynchronizer = versionedSynchronizer;
92
- }
93
- /**
94
- * @inheritDoc
95
- * @internal
96
- */
97
- processEventInitialize(swap, event) {
98
- if (swap._state === FromBTCSwap_1.FromBTCSwapState.PR_CREATED || swap._state === FromBTCSwap_1.FromBTCSwapState.QUOTE_SOFT_EXPIRED) {
99
- swap._state = FromBTCSwap_1.FromBTCSwapState.CLAIM_COMMITED;
100
- return Promise.resolve(true);
101
- }
102
- return Promise.resolve(false);
103
- }
104
- /**
105
- * @inheritDoc
106
- * @internal
107
- */
108
- async processEventClaim(swap, event) {
109
- if (swap._state !== FromBTCSwap_1.FromBTCSwapState.FAILED && swap._state !== FromBTCSwap_1.FromBTCSwapState.CLAIM_CLAIMED) {
110
- await swap._setBitcoinTxId(buffer_1.Buffer.from(event.result, "hex").reverse().toString("hex")).catch(e => {
111
- this.logger.warn("processEventClaim(): Error setting bitcoin txId: ", e);
112
- });
113
- swap._state = FromBTCSwap_1.FromBTCSwapState.CLAIM_CLAIMED;
114
- return true;
115
- }
116
- return false;
117
- }
118
- /**
119
- * @inheritDoc
120
- * @internal
121
- */
122
- processEventRefund(swap, event) {
123
- if (swap._state !== FromBTCSwap_1.FromBTCSwapState.CLAIM_CLAIMED && swap._state !== FromBTCSwap_1.FromBTCSwapState.FAILED) {
124
- swap._state = FromBTCSwap_1.FromBTCSwapState.FAILED;
125
- return Promise.resolve(true);
126
- }
127
- return Promise.resolve(false);
128
- }
129
- /**
130
- * Returns the swap expiry, leaving enough time for the user to send a transaction and for it to confirm
131
- *
132
- * @param data Swap data
133
- * @param requiredConfirmations Confirmations required on the bitcoin side to settle the swap
134
- *
135
- * @internal
136
- */
137
- _getOnchainSendTimeout(data, requiredConfirmations) {
138
- const tsDelta = (this._options.blocksTillTxConfirms + requiredConfirmations) * this._options.bitcoinBlocktime * this._options.safetyFactor;
139
- return data.getExpiry() - BigInt(tsDelta);
140
- }
141
- /**
142
- * Pre-fetches claimer (watchtower) bounty data for the swap. Doesn't throw, instead returns null and aborts the
143
- * provided abortController
144
- *
145
- * @param signer Smartchain signer address initiating the swap
146
- * @param amountData
147
- * @param options Options as passed to the swap creation function
148
- * @param abortController
149
- * @param contractVersion
150
- *
151
- * @private
152
- */
153
- async preFetchClaimerBounty(signer, amountData, options, abortController, contractVersion) {
154
- const startTimestamp = BigInt(Math.floor(Date.now() / 1000));
155
- if (options.unsafeZeroWatchtowerFee) {
156
- return {
157
- feePerBlock: 0n,
158
- safetyFactor: options.blockSafetyFactor,
159
- startTimestamp: startTimestamp,
160
- addBlock: 0n,
161
- addFee: 0n
162
- };
163
- }
164
- const dummyAmount = BigInt(Math.floor(Math.random() * 0x1000000));
165
- const dummySwapData = await this._contract(contractVersion).createSwapData(base_1.ChainSwapType.CHAIN, signer, signer, amountData.token, dummyAmount, this._contract(contractVersion).getHashForOnchain((0, Utils_1.randomBytes)(20), dummyAmount, 3).toString("hex"), this.getRandomSequence(), startTimestamp, false, true, BigInt(Math.floor(Math.random() * 0x10000)), BigInt(Math.floor(Math.random() * 0x10000)));
166
- try {
167
- const [feePerBlock, btcRelayData, currentBtcBlock, claimFeeRate] = await Promise.all([
168
- this.btcRelay(contractVersion).getFeePerBlock(),
169
- this.btcRelay(contractVersion).getTipData(),
170
- this._btcRpc.getTipHeight(),
171
- this._contract(contractVersion).getClaimFee(signer, dummySwapData)
172
- ]);
173
- if (btcRelayData == null)
174
- throw new Error("Btc relay not initialized!");
175
- const currentBtcRelayBlock = btcRelayData.blockheight;
176
- const addBlock = Math.max(currentBtcBlock - currentBtcRelayBlock, 0);
177
- return {
178
- feePerBlock: feePerBlock * options.feeSafetyFactorPPM / 1000000n,
179
- safetyFactor: options.blockSafetyFactor,
180
- startTimestamp: startTimestamp,
181
- addBlock: BigInt(addBlock),
182
- addFee: claimFeeRate * options.feeSafetyFactorPPM / 1000000n
183
- };
184
- }
185
- catch (e) {
186
- abortController.abort(e);
187
- return undefined;
188
- }
189
- }
190
- /**
191
- * Returns calculated claimer bounty calculated from the claimer bounty data as fetched from preFetchClaimerBounty()
192
- *
193
- * @param data Parsed swap data returned from the intermediary
194
- * @param options Options as passed to the swap creation function
195
- * @param claimerBounty Claimer bounty data as fetched from {@link preFetchClaimerBounty} function
196
- *
197
- * @private
198
- */
199
- getClaimerBounty(data, options, claimerBounty) {
200
- const tsDelta = data.getExpiry() - claimerBounty.startTimestamp;
201
- const blocksDelta = tsDelta / BigInt(this._options.bitcoinBlocktime) * options.blockSafetyFactor;
202
- const totalBlock = blocksDelta + claimerBounty.addBlock;
203
- return claimerBounty.addFee + (totalBlock * claimerBounty.feePerBlock);
204
- }
205
- /**
206
- * Verifies response returned from intermediary
207
- *
208
- * @param signer
209
- * @param resp Response as returned by the intermediary
210
- * @param amountData
211
- * @param lp Intermediary
212
- * @param options Options as passed to the swap creation function
213
- * @param data Parsed swap data returned by the intermediary
214
- * @param sequence Required swap sequence
215
- * @param claimerBounty Claimer bount data as returned from the preFetchClaimerBounty() pre-fetch promise
216
- * @param depositToken
217
- *
218
- * @throws {IntermediaryError} in case the response is invalid
219
- *
220
- * @private
221
- */
222
- verifyReturnedData(signer, resp, amountData, lp, options, data, sequence, claimerBounty, depositToken) {
223
- if (amountData.exactIn) {
224
- if (resp.amount !== amountData.amount)
225
- throw new IntermediaryError_1.IntermediaryError("Invalid amount returned");
226
- }
227
- else {
228
- if (resp.total !== amountData.amount)
229
- throw new IntermediaryError_1.IntermediaryError("Invalid total returned");
230
- }
231
- const requiredConfirmations = resp.confirmations;
232
- if (requiredConfirmations > this._options.maxConfirmations)
233
- throw new IntermediaryError_1.IntermediaryError("Requires too many confirmations");
234
- const totalClaimerBounty = this.getClaimerBounty(data, options, claimerBounty);
235
- if (data.getClaimerBounty() !== totalClaimerBounty ||
236
- data.getType() != base_1.ChainSwapType.CHAIN ||
237
- data.getSequence() !== sequence ||
238
- data.getAmount() !== resp.total ||
239
- data.isPayIn() ||
240
- !data.isToken(amountData.token) ||
241
- !data.isOfferer(lp.getAddress(this.chainIdentifier)) ||
242
- !data.isClaimer(signer) ||
243
- !data.isDepositToken(depositToken) ||
244
- data.hasSuccessAction()) {
245
- throw new IntermediaryError_1.IntermediaryError("Invalid data returned");
246
- }
247
- //Check that we have enough time to send the TX and for it to confirm
248
- const expiry = this._getOnchainSendTimeout(data, requiredConfirmations);
249
- const currentTimestamp = BigInt(Math.floor(Date.now() / 1000));
250
- if ((expiry - currentTimestamp) < BigInt(this._options.minSendWindow)) {
251
- throw new IntermediaryError_1.IntermediaryError("Send window too low");
252
- }
253
- const version = lp.getContractVersion(this.chainIdentifier);
254
- const lockingScript = (0, BitcoinUtils_1.toOutputScript)(this._options.bitcoinNetwork, resp.btcAddress);
255
- const desiredExtraData = this._contract(version).getExtraData(lockingScript, resp.amount, requiredConfirmations);
256
- const desiredClaimHash = this._contract(version).getHashForOnchain(lockingScript, resp.amount, requiredConfirmations);
257
- if (!desiredClaimHash.equals(buffer_1.Buffer.from(data.getClaimHash(), "hex"))) {
258
- throw new IntermediaryError_1.IntermediaryError("Invalid claim hash returned!");
259
- }
260
- const extraData = data.getExtraData();
261
- if (extraData == null || !desiredExtraData.equals(buffer_1.Buffer.from(extraData, "hex"))) {
262
- throw new IntermediaryError_1.IntermediaryError("Invalid extra data returned!");
263
- }
264
- }
265
- /**
266
- * Returns a newly created legacy Bitcoin -> Smart chain swap using the PrTLC based escrow swap protocol,
267
- * with the passed amount.
268
- *
269
- * @param recipient Smart chain signer's address on the destination chain
270
- * @param amountData Amount, token and exact input/output data for to swap
271
- * @param lps An array of intermediaries (LPs) to get the quotes from
272
- * @param options Optional additional quote options
273
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
274
- * @param abortSignal Abort signal
275
- */
276
- create(recipient, amountData, lps, options, additionalParams, abortSignal) {
277
- let feeSafetyFactorPPM = 1500000n;
278
- if (typeof (options?.feeSafetyFactor) === "bigint") {
279
- feeSafetyFactorPPM = options.feeSafetyFactor * 1000000n;
280
- }
281
- else if (typeof (options?.feeSafetyFactor) === "number") {
282
- feeSafetyFactorPPM = BigInt(Math.floor(options.feeSafetyFactor * 1000000));
283
- }
284
- const lpVersions = Intermediary_1.Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
285
- const _options = {
286
- blockSafetyFactor: options?.blockSafetyFactor != null ? BigInt(options.blockSafetyFactor) : 1n,
287
- feeSafetyFactorPPM,
288
- unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false
289
- };
290
- const sequence = this.getRandomSequence();
291
- const _abortController = (0, Utils_1.extendAbortController)(abortSignal);
292
- const pricePrefetchPromise = this.preFetchPrice(amountData, _abortController.signal);
293
- const usdPricePrefetchPromise = this.preFetchUsdPrice(_abortController.signal);
294
- const claimerBountyPrefetchPromise = (0, Utils_1.mapArrayToObject)(lpVersions, (contractVersion) => {
295
- return this.preFetchClaimerBounty(recipient, amountData, _options, _abortController, contractVersion);
296
- });
297
- const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
298
- const feeRatePromise = this.preFetchFeeRate(recipient, amountData, undefined, _abortController, lpVersions);
299
- const _signDataPromise = (0, Utils_1.mapArrayToObject)(lpVersions, (contractVersion) => {
300
- return this._contract(contractVersion).preFetchBlockDataForSignatures == null ?
301
- this.preFetchSignData(Promise.resolve(true), contractVersion) :
302
- undefined;
303
- });
304
- return lps.map(lp => {
305
- return {
306
- intermediary: lp,
307
- quote: (async () => {
308
- if (lp.services[SwapType_1.SwapType.FROM_BTC] == null)
309
- throw new Error("LP service for processing from btc swaps not found!");
310
- const version = lp.getContractVersion(this.chainIdentifier);
311
- const abortController = (0, Utils_1.extendAbortController)(_abortController.signal);
312
- const liquidityPromise = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
313
- try {
314
- const { signDataPromise, resp } = await (0, RetryUtils_1.tryWithRetries)(async (retryCount) => {
315
- const { signDataPrefetch, response } = IntermediaryAPI_1.IntermediaryAPI.initFromBTC(this.chainIdentifier, lp.url, nativeTokenAddress, {
316
- claimer: recipient,
317
- amount: amountData.amount,
318
- token: amountData.token.toString(),
319
- exactOut: !amountData.exactIn,
320
- sequence,
321
- claimerBounty: (0, Utils_1.throwIfUndefined)(claimerBountyPrefetchPromise[version]),
322
- feeRate: (0, Utils_1.throwIfUndefined)(feeRatePromise[version]),
323
- additionalParams
324
- }, this._options.postRequestTimeout, abortController.signal, retryCount > 0 ? false : undefined);
325
- let signDataPromise = _signDataPromise[version];
326
- if (signDataPromise == null) {
327
- signDataPromise = this.preFetchSignData(signDataPrefetch, version);
328
- }
329
- else
330
- signDataPrefetch.catch(() => { });
331
- return {
332
- signDataPromise,
333
- resp: await response
334
- };
335
- }, undefined, e => e instanceof RequestError_1.RequestError, abortController.signal);
336
- const data = new (this._swapDataDeserializer(version))(resp.data);
337
- data.setClaimer(recipient);
338
- const swapFeeBtc = resp.swapFee * resp.amount / (data.getAmount() + resp.swapFee);
339
- this.verifyReturnedData(recipient, resp, amountData, lp, _options, data, sequence, (await claimerBountyPrefetchPromise[version]), nativeTokenAddress);
340
- const [pricingInfo, signatureExpiry] = await Promise.all([
341
- //Get intermediary's liquidity
342
- this.verifyReturnedPrice(lp.services[SwapType_1.SwapType.FROM_BTC], false, resp.amount, resp.total, amountData.token, { swapFeeBtc }, pricePrefetchPromise, usdPricePrefetchPromise, abortController.signal),
343
- this.verifyReturnedSignature(recipient, data, resp, feeRatePromise[version], signDataPromise, version, abortController.signal),
344
- this.verifyIntermediaryLiquidity(data.getAmount(), (0, Utils_1.throwIfUndefined)(liquidityPromise)),
345
- ]);
346
- const quote = new FromBTCSwap_1.FromBTCSwap(this, {
347
- pricingInfo,
348
- url: lp.url,
349
- expiry: signatureExpiry,
350
- swapFee: resp.swapFee,
351
- swapFeeBtc,
352
- feeRate: (await feeRatePromise[version]),
353
- signatureData: resp,
354
- data,
355
- address: resp.btcAddress,
356
- amount: resp.amount,
357
- exactIn: amountData.exactIn ?? true,
358
- requiredConfirmations: resp.confirmations,
359
- contractVersion: version
360
- });
361
- return quote;
362
- }
363
- catch (e) {
364
- abortController.abort(e);
365
- throw e;
366
- }
367
- })()
368
- };
369
- });
370
- }
371
- /**
372
- * @inheritDoc
373
- */
374
- async recoverFromSwapDataAndState(init, state, contractVersion, lp) {
375
- const data = init.data;
376
- const swapInit = {
377
- pricingInfo: {
378
- isValid: true,
379
- satsBaseFee: 0n,
380
- swapPriceUSatPerToken: 100000000000000n,
381
- realPriceUSatPerToken: 100000000000000n,
382
- differencePPM: 0n,
383
- feePPM: 0n,
384
- },
385
- url: lp?.url,
386
- expiry: 0,
387
- swapFee: 0n,
388
- swapFeeBtc: 0n,
389
- feeRate: "",
390
- signatureData: undefined,
391
- data,
392
- exactIn: false,
393
- contractVersion
394
- };
395
- const swap = new FromBTCSwap_1.FromBTCSwap(this, swapInit);
396
- swap._commitTxId = await init.getInitTxId();
397
- const blockData = await init.getTxBlock();
398
- swap.createdAt = blockData.blockTime * 1000;
399
- swap._setInitiated();
400
- swap._state = FromBTCSwap_1.FromBTCSwapState.CLAIM_COMMITED;
401
- await swap._sync(false, false, state);
402
- await swap._save();
403
- return swap;
404
- }
405
- }
406
- exports.FromBTCWrapper = FromBTCWrapper;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.FromBTCWrapper = void 0;
4
+ const IFromBTCWrapper_1 = require("../IFromBTCWrapper");
5
+ const FromBTCSwap_1 = require("./FromBTCSwap");
6
+ const base_1 = require("@atomiqlabs/base");
7
+ const Intermediary_1 = require("../../../../intermediaries/Intermediary");
8
+ const buffer_1 = require("buffer");
9
+ const IntermediaryError_1 = require("../../../../errors/IntermediaryError");
10
+ const SwapType_1 = require("../../../../enums/SwapType");
11
+ const Utils_1 = require("../../../../utils/Utils");
12
+ const BitcoinUtils_1 = require("../../../../utils/BitcoinUtils");
13
+ const IntermediaryAPI_1 = require("../../../../intermediaries/apis/IntermediaryAPI");
14
+ const RequestError_1 = require("../../../../errors/RequestError");
15
+ const utils_1 = require("@scure/btc-signer/utils");
16
+ const RetryUtils_1 = require("../../../../utils/RetryUtils");
17
+ /**
18
+ * Legacy escrow (PrTLC) based swap for Bitcoin -> Smart chains, requires manual initiation
19
+ * of the swap escrow on the destination chain.
20
+ *
21
+ * @category Swaps/Legacy/Bitcoin → Smart chain
22
+ */
23
+ class FromBTCWrapper extends IFromBTCWrapper_1.IFromBTCWrapper {
24
+ /**
25
+ * @param chainIdentifier
26
+ * @param unifiedStorage Storage interface for the current environment
27
+ * @param unifiedChainEvents On-chain event listener
28
+ * @param chain
29
+ * @param prices Pricing to use
30
+ * @param tokens
31
+ * @param versionedContracts
32
+ * @param versionedSynchronizer
33
+ * @param btcRpc Bitcoin RPC which also supports getting transactions by txoHash
34
+ * @param options
35
+ * @param events Instance to use for emitting events
36
+ */
37
+ constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, versionedContracts, versionedSynchronizer, btcRpc, options, events) {
38
+ super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, {
39
+ ...options,
40
+ bitcoinNetwork: options?.bitcoinNetwork ?? utils_1.TEST_NETWORK,
41
+ safetyFactor: options?.safetyFactor ?? 2,
42
+ blocksTillTxConfirms: options?.blocksTillTxConfirms ?? 12,
43
+ maxConfirmations: options?.maxConfirmations ?? 6,
44
+ minSendWindow: options?.minSendWindow ?? 30 * 60,
45
+ bitcoinBlocktime: options?.bitcoinBlocktime ?? 10 * 60
46
+ }, versionedContracts, events);
47
+ this.TYPE = SwapType_1.SwapType.FROM_BTC;
48
+ /**
49
+ * @internal
50
+ */
51
+ this.tickSwapState = [FromBTCSwap_1.FromBTCSwapState.PR_CREATED, FromBTCSwap_1.FromBTCSwapState.CLAIM_COMMITED, FromBTCSwap_1.FromBTCSwapState.EXPIRED];
52
+ /**
53
+ * @internal
54
+ */
55
+ this._pendingSwapStates = [
56
+ FromBTCSwap_1.FromBTCSwapState.PR_CREATED,
57
+ FromBTCSwap_1.FromBTCSwapState.QUOTE_SOFT_EXPIRED,
58
+ FromBTCSwap_1.FromBTCSwapState.CLAIM_COMMITED,
59
+ FromBTCSwap_1.FromBTCSwapState.BTC_TX_CONFIRMED,
60
+ FromBTCSwap_1.FromBTCSwapState.EXPIRED
61
+ ];
62
+ /**
63
+ * @internal
64
+ */
65
+ this._claimableSwapStates = [FromBTCSwap_1.FromBTCSwapState.BTC_TX_CONFIRMED];
66
+ /**
67
+ * @internal
68
+ */
69
+ this._swapDeserializer = FromBTCSwap_1.FromBTCSwap;
70
+ /**
71
+ * @internal
72
+ */
73
+ this._synchronizer = (version) => {
74
+ const _version = version ?? "v1";
75
+ const data = this.versionedSynchronizer[_version];
76
+ if (data == null)
77
+ throw new Error(`Invalid contract version ${_version} requested`);
78
+ return data.synchronizer;
79
+ };
80
+ this.btcRelay = (version) => {
81
+ const _version = version ?? "v1";
82
+ const data = this.versionedBtcRelay[_version];
83
+ if (data == null)
84
+ throw new Error(`Invalid contract version ${_version} requested`);
85
+ return data.btcRelay;
86
+ };
87
+ this.versionedBtcRelay = {};
88
+ this.versionedSynchronizer = {};
89
+ this._btcRpc = btcRpc;
90
+ this.versionedBtcRelay = versionedContracts;
91
+ this.versionedSynchronizer = versionedSynchronizer;
92
+ }
93
+ /**
94
+ * @inheritDoc
95
+ * @internal
96
+ */
97
+ processEventInitialize(swap, event) {
98
+ if (swap._state === FromBTCSwap_1.FromBTCSwapState.PR_CREATED || swap._state === FromBTCSwap_1.FromBTCSwapState.QUOTE_SOFT_EXPIRED) {
99
+ swap._state = FromBTCSwap_1.FromBTCSwapState.CLAIM_COMMITED;
100
+ return Promise.resolve(true);
101
+ }
102
+ return Promise.resolve(false);
103
+ }
104
+ /**
105
+ * @inheritDoc
106
+ * @internal
107
+ */
108
+ async processEventClaim(swap, event) {
109
+ if (swap._state !== FromBTCSwap_1.FromBTCSwapState.FAILED && swap._state !== FromBTCSwap_1.FromBTCSwapState.CLAIM_CLAIMED) {
110
+ await swap._setBitcoinTxId(buffer_1.Buffer.from(event.result, "hex").reverse().toString("hex")).catch(e => {
111
+ this.logger.warn("processEventClaim(): Error setting bitcoin txId: ", e);
112
+ });
113
+ swap._state = FromBTCSwap_1.FromBTCSwapState.CLAIM_CLAIMED;
114
+ return true;
115
+ }
116
+ return false;
117
+ }
118
+ /**
119
+ * @inheritDoc
120
+ * @internal
121
+ */
122
+ processEventRefund(swap, event) {
123
+ if (swap._state !== FromBTCSwap_1.FromBTCSwapState.CLAIM_CLAIMED && swap._state !== FromBTCSwap_1.FromBTCSwapState.FAILED) {
124
+ swap._state = FromBTCSwap_1.FromBTCSwapState.FAILED;
125
+ return Promise.resolve(true);
126
+ }
127
+ return Promise.resolve(false);
128
+ }
129
+ /**
130
+ * Returns the swap expiry, leaving enough time for the user to send a transaction and for it to confirm
131
+ *
132
+ * @param data Swap data
133
+ * @param requiredConfirmations Confirmations required on the bitcoin side to settle the swap
134
+ *
135
+ * @internal
136
+ */
137
+ _getOnchainSendTimeout(data, requiredConfirmations) {
138
+ const tsDelta = (this._options.blocksTillTxConfirms + requiredConfirmations) * this._options.bitcoinBlocktime * this._options.safetyFactor;
139
+ return data.getExpiry() - BigInt(tsDelta);
140
+ }
141
+ /**
142
+ * Pre-fetches claimer (watchtower) bounty data for the swap. Doesn't throw, instead returns null and aborts the
143
+ * provided abortController
144
+ *
145
+ * @param signer Smartchain signer address initiating the swap
146
+ * @param amountData
147
+ * @param options Options as passed to the swap creation function
148
+ * @param abortController
149
+ * @param contractVersion
150
+ *
151
+ * @private
152
+ */
153
+ async preFetchClaimerBounty(signer, amountData, options, abortController, contractVersion) {
154
+ const startTimestamp = BigInt(Math.floor(Date.now() / 1000));
155
+ if (options.unsafeZeroWatchtowerFee) {
156
+ return {
157
+ feePerBlock: 0n,
158
+ safetyFactor: options.blockSafetyFactor,
159
+ startTimestamp: startTimestamp,
160
+ addBlock: 0n,
161
+ addFee: 0n
162
+ };
163
+ }
164
+ const dummyAmount = BigInt(Math.floor(Math.random() * 0x1000000));
165
+ const dummySwapData = await this._contract(contractVersion).createSwapData(base_1.ChainSwapType.CHAIN, signer, signer, amountData.token, dummyAmount, this._contract(contractVersion).getHashForOnchain((0, Utils_1.randomBytes)(20), dummyAmount, 3).toString("hex"), this.getRandomSequence(), startTimestamp, false, true, BigInt(Math.floor(Math.random() * 0x10000)), BigInt(Math.floor(Math.random() * 0x10000)));
166
+ try {
167
+ const [feePerBlock, btcRelayData, currentBtcBlock, claimFeeRate] = await Promise.all([
168
+ this.btcRelay(contractVersion).getFeePerBlock(),
169
+ this.btcRelay(contractVersion).getTipData(),
170
+ this._btcRpc.getTipHeight(),
171
+ this._contract(contractVersion).getClaimFee(signer, dummySwapData)
172
+ ]);
173
+ if (btcRelayData == null)
174
+ throw new Error("Btc relay not initialized!");
175
+ const currentBtcRelayBlock = btcRelayData.blockheight;
176
+ const addBlock = Math.max(currentBtcBlock - currentBtcRelayBlock, 0);
177
+ return {
178
+ feePerBlock: feePerBlock * options.feeSafetyFactorPPM / 1000000n,
179
+ safetyFactor: options.blockSafetyFactor,
180
+ startTimestamp: startTimestamp,
181
+ addBlock: BigInt(addBlock),
182
+ addFee: claimFeeRate * options.feeSafetyFactorPPM / 1000000n
183
+ };
184
+ }
185
+ catch (e) {
186
+ abortController.abort(e);
187
+ return undefined;
188
+ }
189
+ }
190
+ /**
191
+ * Returns calculated claimer bounty calculated from the claimer bounty data as fetched from preFetchClaimerBounty()
192
+ *
193
+ * @param data Parsed swap data returned from the intermediary
194
+ * @param options Options as passed to the swap creation function
195
+ * @param claimerBounty Claimer bounty data as fetched from {@link preFetchClaimerBounty} function
196
+ *
197
+ * @private
198
+ */
199
+ getClaimerBounty(data, options, claimerBounty) {
200
+ const tsDelta = data.getExpiry() - claimerBounty.startTimestamp;
201
+ const blocksDelta = tsDelta / BigInt(this._options.bitcoinBlocktime) * options.blockSafetyFactor;
202
+ const totalBlock = blocksDelta + claimerBounty.addBlock;
203
+ return claimerBounty.addFee + (totalBlock * claimerBounty.feePerBlock);
204
+ }
205
+ /**
206
+ * Verifies response returned from intermediary
207
+ *
208
+ * @param signer
209
+ * @param resp Response as returned by the intermediary
210
+ * @param amountData
211
+ * @param lp Intermediary
212
+ * @param options Options as passed to the swap creation function
213
+ * @param data Parsed swap data returned by the intermediary
214
+ * @param sequence Required swap sequence
215
+ * @param claimerBounty Claimer bount data as returned from the preFetchClaimerBounty() pre-fetch promise
216
+ * @param depositToken
217
+ *
218
+ * @throws {IntermediaryError} in case the response is invalid
219
+ *
220
+ * @private
221
+ */
222
+ verifyReturnedData(signer, resp, amountData, lp, options, data, sequence, claimerBounty, depositToken) {
223
+ if (amountData.exactIn) {
224
+ if (resp.amount !== amountData.amount)
225
+ throw new IntermediaryError_1.IntermediaryError("Invalid amount returned");
226
+ }
227
+ else {
228
+ if (resp.total !== amountData.amount)
229
+ throw new IntermediaryError_1.IntermediaryError("Invalid total returned");
230
+ }
231
+ const requiredConfirmations = resp.confirmations;
232
+ if (requiredConfirmations > this._options.maxConfirmations)
233
+ throw new IntermediaryError_1.IntermediaryError("Requires too many confirmations");
234
+ const totalClaimerBounty = this.getClaimerBounty(data, options, claimerBounty);
235
+ if (data.getClaimerBounty() !== totalClaimerBounty ||
236
+ data.getType() != base_1.ChainSwapType.CHAIN ||
237
+ data.getSequence() !== sequence ||
238
+ data.getAmount() !== resp.total ||
239
+ data.isPayIn() ||
240
+ !data.isToken(amountData.token) ||
241
+ !data.isOfferer(lp.getAddress(this.chainIdentifier)) ||
242
+ !data.isClaimer(signer) ||
243
+ !data.isDepositToken(depositToken) ||
244
+ data.hasSuccessAction()) {
245
+ throw new IntermediaryError_1.IntermediaryError("Invalid data returned");
246
+ }
247
+ //Check that we have enough time to send the TX and for it to confirm
248
+ const expiry = this._getOnchainSendTimeout(data, requiredConfirmations);
249
+ const currentTimestamp = BigInt(Math.floor(Date.now() / 1000));
250
+ if ((expiry - currentTimestamp) < BigInt(this._options.minSendWindow)) {
251
+ throw new IntermediaryError_1.IntermediaryError("Send window too low");
252
+ }
253
+ const version = lp.getContractVersion(this.chainIdentifier);
254
+ const lockingScript = (0, BitcoinUtils_1.toOutputScript)(this._options.bitcoinNetwork, resp.btcAddress);
255
+ const desiredExtraData = this._contract(version).getExtraData(lockingScript, resp.amount, requiredConfirmations);
256
+ const desiredClaimHash = this._contract(version).getHashForOnchain(lockingScript, resp.amount, requiredConfirmations);
257
+ if (!desiredClaimHash.equals(buffer_1.Buffer.from(data.getClaimHash(), "hex"))) {
258
+ throw new IntermediaryError_1.IntermediaryError("Invalid claim hash returned!");
259
+ }
260
+ const extraData = data.getExtraData();
261
+ if (extraData == null || !desiredExtraData.equals(buffer_1.Buffer.from(extraData, "hex"))) {
262
+ throw new IntermediaryError_1.IntermediaryError("Invalid extra data returned!");
263
+ }
264
+ }
265
+ /**
266
+ * Returns a newly created legacy Bitcoin -> Smart chain swap using the PrTLC based escrow swap protocol,
267
+ * with the passed amount.
268
+ *
269
+ * @param recipient Smart chain signer's address on the destination chain
270
+ * @param amountData Amount, token and exact input/output data for to swap
271
+ * @param lps An array of intermediaries (LPs) to get the quotes from
272
+ * @param options Optional additional quote options
273
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
274
+ * @param abortSignal Abort signal
275
+ */
276
+ create(recipient, amountData, lps, options, additionalParams, abortSignal) {
277
+ let feeSafetyFactorPPM = 1500000n;
278
+ if (typeof (options?.feeSafetyFactor) === "bigint") {
279
+ feeSafetyFactorPPM = options.feeSafetyFactor * 1000000n;
280
+ }
281
+ else if (typeof (options?.feeSafetyFactor) === "number") {
282
+ feeSafetyFactorPPM = BigInt(Math.floor(options.feeSafetyFactor * 1000000));
283
+ }
284
+ const lpVersions = Intermediary_1.Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
285
+ const _options = {
286
+ blockSafetyFactor: options?.blockSafetyFactor != null ? BigInt(options.blockSafetyFactor) : 1n,
287
+ feeSafetyFactorPPM,
288
+ unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false
289
+ };
290
+ const sequence = this.getRandomSequence();
291
+ const _abortController = (0, Utils_1.extendAbortController)(abortSignal);
292
+ const pricePrefetchPromise = this.preFetchPrice(amountData, _abortController.signal);
293
+ const usdPricePrefetchPromise = this.preFetchUsdPrice(_abortController.signal);
294
+ const claimerBountyPrefetchPromise = (0, Utils_1.mapArrayToObject)(lpVersions, (contractVersion) => {
295
+ return this.preFetchClaimerBounty(recipient, amountData, _options, _abortController, contractVersion);
296
+ });
297
+ const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
298
+ const feeRatePromise = this.preFetchFeeRate(recipient, amountData, undefined, _abortController, lpVersions);
299
+ const _signDataPromise = (0, Utils_1.mapArrayToObject)(lpVersions, (contractVersion) => {
300
+ return this._contract(contractVersion).preFetchBlockDataForSignatures == null ?
301
+ this.preFetchSignData(Promise.resolve(true), contractVersion) :
302
+ undefined;
303
+ });
304
+ return lps.map(lp => {
305
+ return {
306
+ intermediary: lp,
307
+ quote: (async () => {
308
+ if (lp.services[SwapType_1.SwapType.FROM_BTC] == null)
309
+ throw new Error("LP service for processing from btc swaps not found!");
310
+ const version = lp.getContractVersion(this.chainIdentifier);
311
+ const abortController = (0, Utils_1.extendAbortController)(_abortController.signal);
312
+ const liquidityPromise = this.preFetchIntermediaryLiquidity(amountData, lp, abortController, version);
313
+ try {
314
+ const { signDataPromise, resp } = await (0, RetryUtils_1.tryWithRetries)(async (retryCount) => {
315
+ const { signDataPrefetch, response } = IntermediaryAPI_1.IntermediaryAPI.initFromBTC(this.chainIdentifier, lp.url, nativeTokenAddress, {
316
+ claimer: recipient,
317
+ amount: amountData.amount,
318
+ token: amountData.token.toString(),
319
+ exactOut: !amountData.exactIn,
320
+ sequence,
321
+ claimerBounty: (0, Utils_1.throwIfUndefined)(claimerBountyPrefetchPromise[version]),
322
+ feeRate: (0, Utils_1.throwIfUndefined)(feeRatePromise[version]),
323
+ additionalParams
324
+ }, this._options.postRequestTimeout, abortController.signal, retryCount > 0 ? false : undefined);
325
+ let signDataPromise = _signDataPromise[version];
326
+ if (signDataPromise == null) {
327
+ signDataPromise = this.preFetchSignData(signDataPrefetch, version);
328
+ }
329
+ else
330
+ signDataPrefetch.catch(() => { });
331
+ return {
332
+ signDataPromise,
333
+ resp: await response
334
+ };
335
+ }, undefined, e => e instanceof RequestError_1.RequestError, abortController.signal);
336
+ const data = new (this._swapDataDeserializer(version))(resp.data);
337
+ data.setClaimer(recipient);
338
+ const swapFeeBtc = resp.swapFee * resp.amount / (data.getAmount() + resp.swapFee);
339
+ this.verifyReturnedData(recipient, resp, amountData, lp, _options, data, sequence, (await claimerBountyPrefetchPromise[version]), nativeTokenAddress);
340
+ const [pricingInfo, signatureExpiry] = await Promise.all([
341
+ //Get intermediary's liquidity
342
+ this.verifyReturnedPrice(lp.services[SwapType_1.SwapType.FROM_BTC], false, resp.amount, resp.total, amountData.token, { swapFeeBtc }, pricePrefetchPromise, usdPricePrefetchPromise, abortController.signal),
343
+ this.verifyReturnedSignature(recipient, data, resp, feeRatePromise[version], signDataPromise, version, abortController.signal),
344
+ this.verifyIntermediaryLiquidity(data.getAmount(), (0, Utils_1.throwIfUndefined)(liquidityPromise)),
345
+ ]);
346
+ const quote = new FromBTCSwap_1.FromBTCSwap(this, {
347
+ pricingInfo,
348
+ url: lp.url,
349
+ expiry: signatureExpiry,
350
+ swapFee: resp.swapFee,
351
+ swapFeeBtc,
352
+ feeRate: (await feeRatePromise[version]),
353
+ signatureData: resp,
354
+ data,
355
+ address: resp.btcAddress,
356
+ amount: resp.amount,
357
+ exactIn: amountData.exactIn ?? true,
358
+ requiredConfirmations: resp.confirmations,
359
+ contractVersion: version
360
+ });
361
+ return quote;
362
+ }
363
+ catch (e) {
364
+ abortController.abort(e);
365
+ throw e;
366
+ }
367
+ })()
368
+ };
369
+ });
370
+ }
371
+ /**
372
+ * @inheritDoc
373
+ */
374
+ async recoverFromSwapDataAndState(init, state, contractVersion, lp) {
375
+ const data = init.data;
376
+ const swapInit = {
377
+ pricingInfo: {
378
+ isValid: true,
379
+ satsBaseFee: 0n,
380
+ swapPriceUSatPerToken: 100000000000000n,
381
+ realPriceUSatPerToken: 100000000000000n,
382
+ differencePPM: 0n,
383
+ feePPM: 0n,
384
+ },
385
+ url: lp?.url,
386
+ expiry: 0,
387
+ swapFee: 0n,
388
+ swapFeeBtc: 0n,
389
+ feeRate: "",
390
+ signatureData: undefined,
391
+ data,
392
+ exactIn: false,
393
+ contractVersion
394
+ };
395
+ const swap = new FromBTCSwap_1.FromBTCSwap(this, swapInit);
396
+ swap._commitTxId = await init.getInitTxId();
397
+ const blockData = await init.getTxBlock();
398
+ swap.createdAt = blockData.blockTime * 1000;
399
+ swap._setInitiated();
400
+ swap._state = FromBTCSwap_1.FromBTCSwapState.CLAIM_COMMITED;
401
+ await swap._sync(false, false, state);
402
+ await swap._save();
403
+ return swap;
404
+ }
405
+ }
406
+ exports.FromBTCWrapper = FromBTCWrapper;