@atomiqlabs/sdk 8.9.1 → 8.9.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (366) hide show
  1. package/LICENSE +201 -201
  2. package/README.md +1760 -1760
  3. package/api/index.d.ts +1 -1
  4. package/api/index.js +3 -3
  5. package/dist/ApiList.d.ts +37 -37
  6. package/dist/ApiList.js +30 -30
  7. package/dist/SmartChainAssets.d.ts +181 -181
  8. package/dist/SmartChainAssets.js +181 -181
  9. package/dist/api/ApiEndpoints.d.ts +393 -393
  10. package/dist/api/ApiEndpoints.js +2 -2
  11. package/dist/api/ApiParser.d.ts +10 -10
  12. package/dist/api/ApiParser.js +134 -134
  13. package/dist/api/ApiTypes.d.ts +157 -157
  14. package/dist/api/ApiTypes.js +75 -75
  15. package/dist/api/SerializedAction.d.ts +40 -40
  16. package/dist/api/SerializedAction.js +59 -59
  17. package/dist/api/SwapperApi.d.ts +50 -50
  18. package/dist/api/SwapperApi.js +431 -431
  19. package/dist/api/index.d.ts +5 -5
  20. package/dist/api/index.js +24 -24
  21. package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
  22. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  23. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
  24. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  25. package/dist/bitcoin/coinselect2/index.d.ts +20 -20
  26. package/dist/bitcoin/coinselect2/index.js +69 -69
  27. package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
  28. package/dist/bitcoin/coinselect2/utils.js +158 -158
  29. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
  30. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
  31. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
  32. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  33. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
  34. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
  35. package/dist/enums/FeeType.d.ts +15 -15
  36. package/dist/enums/FeeType.js +19 -19
  37. package/dist/enums/SwapAmountType.d.ts +15 -15
  38. package/dist/enums/SwapAmountType.js +19 -19
  39. package/dist/enums/SwapDirection.d.ts +15 -15
  40. package/dist/enums/SwapDirection.js +19 -19
  41. package/dist/enums/SwapSide.d.ts +15 -15
  42. package/dist/enums/SwapSide.js +19 -19
  43. package/dist/enums/SwapType.d.ts +75 -75
  44. package/dist/enums/SwapType.js +79 -79
  45. package/dist/errors/IntermediaryError.d.ts +13 -13
  46. package/dist/errors/IntermediaryError.js +27 -27
  47. package/dist/errors/RequestError.d.ts +32 -32
  48. package/dist/errors/RequestError.js +54 -54
  49. package/dist/errors/UserError.d.ts +8 -8
  50. package/dist/errors/UserError.js +16 -16
  51. package/dist/events/UnifiedSwapEventListener.d.ts +24 -24
  52. package/dist/events/UnifiedSwapEventListener.js +138 -138
  53. package/dist/http/HttpUtils.d.ts +29 -29
  54. package/dist/http/HttpUtils.js +97 -97
  55. package/dist/http/paramcoders/IParamReader.d.ts +8 -8
  56. package/dist/http/paramcoders/IParamReader.js +2 -2
  57. package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
  58. package/dist/http/paramcoders/ParamDecoder.js +137 -137
  59. package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
  60. package/dist/http/paramcoders/ParamEncoder.js +36 -36
  61. package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
  62. package/dist/http/paramcoders/SchemaVerifier.js +145 -145
  63. package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
  64. package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
  65. package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
  66. package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
  67. package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +17 -17
  68. package/dist/http/paramcoders/client/StreamingFetchPromise.js +175 -175
  69. package/dist/index.d.ts +86 -86
  70. package/dist/index.js +159 -159
  71. package/dist/intermediaries/Intermediary.d.ts +178 -178
  72. package/dist/intermediaries/Intermediary.js +166 -166
  73. package/dist/intermediaries/IntermediaryDiscovery.d.ts +216 -216
  74. package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
  75. package/dist/intermediaries/apis/IntermediaryAPI.d.ts +607 -607
  76. package/dist/intermediaries/apis/IntermediaryAPI.js +764 -764
  77. package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
  78. package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
  79. package/dist/intermediaries/auth/SignedKeyBasedAuth.d.ts +14 -14
  80. package/dist/intermediaries/auth/SignedKeyBasedAuth.js +68 -68
  81. package/dist/lnurl/LNURL.d.ts +102 -102
  82. package/dist/lnurl/LNURL.js +321 -321
  83. package/dist/prices/RedundantSwapPrice.d.ts +110 -110
  84. package/dist/prices/RedundantSwapPrice.js +222 -222
  85. package/dist/prices/SingleSwapPrice.d.ts +34 -34
  86. package/dist/prices/SingleSwapPrice.js +44 -44
  87. package/dist/prices/SwapPriceWithChain.d.ts +107 -107
  88. package/dist/prices/SwapPriceWithChain.js +128 -128
  89. package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
  90. package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
  91. package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
  92. package/dist/prices/abstract/IPriceProvider.js +74 -74
  93. package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
  94. package/dist/prices/abstract/ISwapPrice.js +279 -279
  95. package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
  96. package/dist/prices/providers/BinancePriceProvider.js +30 -30
  97. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
  98. package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
  99. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
  100. package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
  101. package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
  102. package/dist/prices/providers/CustomPriceProvider.js +35 -35
  103. package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
  104. package/dist/prices/providers/KrakenPriceProvider.js +45 -45
  105. package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
  106. package/dist/prices/providers/OKXPriceProvider.js +29 -29
  107. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
  108. package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
  109. package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
  110. package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
  111. package/dist/storage/IUnifiedStorage.d.ts +127 -127
  112. package/dist/storage/IUnifiedStorage.js +2 -2
  113. package/dist/storage/UnifiedSwapStorage.d.ts +120 -120
  114. package/dist/storage/UnifiedSwapStorage.js +154 -154
  115. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
  116. package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
  117. package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
  118. package/dist/storage-browser/LocalStorageManager.js +93 -93
  119. package/dist/swapper/Swapper.d.ts +770 -770
  120. package/dist/swapper/Swapper.js +1758 -1758
  121. package/dist/swapper/SwapperFactory.d.ts +135 -135
  122. package/dist/swapper/SwapperFactory.js +162 -162
  123. package/dist/swapper/SwapperUtils.d.ts +222 -222
  124. package/dist/swapper/SwapperUtils.js +519 -519
  125. package/dist/swapper/SwapperWithChain.d.ts +404 -404
  126. package/dist/swapper/SwapperWithChain.js +469 -469
  127. package/dist/swapper/SwapperWithSigner.d.ts +322 -322
  128. package/dist/swapper/SwapperWithSigner.js +318 -318
  129. package/dist/swaps/IAddressSwap.d.ts +22 -22
  130. package/dist/swaps/IAddressSwap.js +14 -14
  131. package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
  132. package/dist/swaps/IBTCWalletSwap.js +18 -18
  133. package/dist/swaps/IClaimableSwap.d.ts +49 -49
  134. package/dist/swaps/IClaimableSwap.js +15 -15
  135. package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
  136. package/dist/swaps/IClaimableSwapWrapper.js +2 -2
  137. package/dist/swaps/IRefundableSwap.d.ts +43 -43
  138. package/dist/swaps/IRefundableSwap.js +14 -14
  139. package/dist/swaps/ISwap.d.ts +453 -453
  140. package/dist/swaps/ISwap.js +371 -371
  141. package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
  142. package/dist/swaps/ISwapWithGasDrop.js +12 -12
  143. package/dist/swaps/ISwapWrapper.d.ts +295 -295
  144. package/dist/swaps/ISwapWrapper.js +373 -373
  145. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
  146. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
  147. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
  148. package/dist/swaps/escrow_swaps/IEscrowSwap.js +172 -172
  149. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +129 -129
  150. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
  151. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +107 -107
  152. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +130 -130
  153. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
  154. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
  155. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
  156. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
  157. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +547 -547
  158. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1419 -1419
  159. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +192 -192
  160. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
  161. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +650 -650
  162. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1577 -1577
  163. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +237 -237
  164. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
  165. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +491 -491
  166. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1463 -1463
  167. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +204 -204
  168. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
  169. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +446 -446
  170. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +1097 -1097
  171. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
  172. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
  173. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
  174. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
  175. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +252 -252
  176. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +535 -535
  177. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
  178. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
  179. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +134 -134
  180. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
  181. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +694 -694
  182. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1687 -1687
  183. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +259 -259
  184. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
  185. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +302 -302
  186. package/dist/swaps/trusted/ln/LnForGasSwap.js +625 -625
  187. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
  188. package/dist/swaps/trusted/ln/LnForGasWrapper.js +82 -82
  189. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +343 -343
  190. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +698 -698
  191. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +71 -71
  192. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
  193. package/dist/types/AmountData.d.ts +10 -10
  194. package/dist/types/AmountData.js +2 -2
  195. package/dist/types/CustomPriceFunction.d.ts +11 -11
  196. package/dist/types/CustomPriceFunction.js +2 -2
  197. package/dist/types/PriceInfoType.d.ts +28 -28
  198. package/dist/types/PriceInfoType.js +57 -57
  199. package/dist/types/SwapExecutionAction.d.ts +195 -195
  200. package/dist/types/SwapExecutionAction.js +106 -106
  201. package/dist/types/SwapExecutionStep.d.ts +144 -144
  202. package/dist/types/SwapExecutionStep.js +87 -87
  203. package/dist/types/SwapStateInfo.d.ts +5 -5
  204. package/dist/types/SwapStateInfo.js +2 -2
  205. package/dist/types/SwapWithSigner.d.ts +17 -17
  206. package/dist/types/SwapWithSigner.js +43 -43
  207. package/dist/types/Token.d.ts +99 -99
  208. package/dist/types/Token.js +76 -76
  209. package/dist/types/TokenAmount.d.ts +75 -75
  210. package/dist/types/TokenAmount.js +85 -85
  211. package/dist/types/fees/Fee.d.ts +50 -50
  212. package/dist/types/fees/Fee.js +2 -2
  213. package/dist/types/fees/FeeBreakdown.d.ts +11 -11
  214. package/dist/types/fees/FeeBreakdown.js +2 -2
  215. package/dist/types/fees/PercentagePPM.d.ts +17 -17
  216. package/dist/types/fees/PercentagePPM.js +18 -18
  217. package/dist/types/lnurl/LNURLPay.d.ts +61 -61
  218. package/dist/types/lnurl/LNURLPay.js +31 -31
  219. package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
  220. package/dist/types/lnurl/LNURLWithdraw.js +27 -27
  221. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
  222. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
  223. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
  224. package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
  225. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
  226. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
  227. package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
  228. package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
  229. package/dist/utils/BitcoinUtils.d.ts +18 -18
  230. package/dist/utils/BitcoinUtils.js +174 -174
  231. package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
  232. package/dist/utils/BitcoinWalletUtils.js +14 -14
  233. package/dist/utils/Logger.d.ts +7 -7
  234. package/dist/utils/Logger.js +12 -12
  235. package/dist/utils/RetryUtils.d.ts +22 -22
  236. package/dist/utils/RetryUtils.js +67 -67
  237. package/dist/utils/SwapUtils.d.ts +88 -88
  238. package/dist/utils/SwapUtils.js +72 -72
  239. package/dist/utils/TimeoutUtils.d.ts +17 -17
  240. package/dist/utils/TimeoutUtils.js +55 -55
  241. package/dist/utils/TokenUtils.d.ts +19 -19
  242. package/dist/utils/TokenUtils.js +37 -37
  243. package/dist/utils/TypeUtils.d.ts +7 -7
  244. package/dist/utils/TypeUtils.js +2 -2
  245. package/dist/utils/Utils.d.ts +69 -69
  246. package/dist/utils/Utils.js +214 -214
  247. package/package.json +46 -46
  248. package/src/SmartChainAssets.ts +186 -186
  249. package/src/api/ApiEndpoints.ts +427 -427
  250. package/src/api/ApiParser.ts +138 -138
  251. package/src/api/ApiTypes.ts +229 -229
  252. package/src/api/SerializedAction.ts +97 -97
  253. package/src/api/SwapperApi.ts +545 -545
  254. package/src/api/index.ts +5 -5
  255. package/src/bitcoin/coinselect2/accumulative.ts +69 -69
  256. package/src/bitcoin/coinselect2/blackjack.ts +50 -50
  257. package/src/bitcoin/coinselect2/index.ts +93 -93
  258. package/src/bitcoin/coinselect2/utils.ts +236 -236
  259. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
  260. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
  261. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
  262. package/src/enums/FeeType.ts +15 -15
  263. package/src/enums/SwapAmountType.ts +16 -16
  264. package/src/enums/SwapDirection.ts +15 -15
  265. package/src/enums/SwapSide.ts +16 -16
  266. package/src/enums/SwapType.ts +75 -75
  267. package/src/errors/IntermediaryError.ts +28 -28
  268. package/src/errors/RequestError.ts +64 -64
  269. package/src/errors/UserError.ts +15 -15
  270. package/src/events/UnifiedSwapEventListener.ts +181 -181
  271. package/src/http/HttpUtils.ts +97 -97
  272. package/src/http/paramcoders/IParamReader.ts +9 -9
  273. package/src/http/paramcoders/ParamDecoder.ts +145 -145
  274. package/src/http/paramcoders/ParamEncoder.ts +40 -40
  275. package/src/http/paramcoders/SchemaVerifier.ts +153 -153
  276. package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
  277. package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
  278. package/src/http/paramcoders/client/StreamingFetchPromise.ts +194 -194
  279. package/src/index.ts +141 -141
  280. package/src/intermediaries/Intermediary.ts +280 -280
  281. package/src/intermediaries/IntermediaryDiscovery.ts +548 -548
  282. package/src/intermediaries/apis/IntermediaryAPI.ts +1247 -1247
  283. package/src/intermediaries/auth/SignedKeyBasedAuth.ts +69 -69
  284. package/src/lnurl/LNURL.ts +402 -402
  285. package/src/prices/RedundantSwapPrice.ts +264 -264
  286. package/src/prices/SingleSwapPrice.ts +50 -50
  287. package/src/prices/SwapPriceWithChain.ts +194 -194
  288. package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
  289. package/src/prices/abstract/IPriceProvider.ts +127 -127
  290. package/src/prices/abstract/ISwapPrice.ts +390 -390
  291. package/src/prices/providers/BinancePriceProvider.ts +48 -48
  292. package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
  293. package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
  294. package/src/prices/providers/CustomPriceProvider.ts +40 -40
  295. package/src/prices/providers/KrakenPriceProvider.ts +83 -83
  296. package/src/prices/providers/OKXPriceProvider.ts +59 -59
  297. package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
  298. package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
  299. package/src/storage/IUnifiedStorage.ts +136 -136
  300. package/src/storage/UnifiedSwapStorage.ts +175 -175
  301. package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
  302. package/src/storage-browser/LocalStorageManager.ts +106 -106
  303. package/src/swapper/Swapper.ts +2570 -2570
  304. package/src/swapper/SwapperFactory.ts +307 -307
  305. package/src/swapper/SwapperUtils.ts +610 -610
  306. package/src/swapper/SwapperWithChain.ts +707 -707
  307. package/src/swapper/SwapperWithSigner.ts +511 -511
  308. package/src/swaps/IAddressSwap.ts +30 -30
  309. package/src/swaps/IBTCWalletSwap.ts +92 -92
  310. package/src/swaps/IClaimableSwap.ts +65 -65
  311. package/src/swaps/IClaimableSwapWrapper.ts +17 -17
  312. package/src/swaps/IRefundableSwap.ts +58 -58
  313. package/src/swaps/ISwap.ts +775 -775
  314. package/src/swaps/ISwapWithGasDrop.ts +25 -25
  315. package/src/swaps/ISwapWrapper.ts +564 -564
  316. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
  317. package/src/swaps/escrow_swaps/IEscrowSwap.ts +271 -271
  318. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +284 -284
  319. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +172 -172
  320. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
  321. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
  322. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1670 -1671
  323. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +603 -603
  324. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1883 -1883
  325. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +752 -752
  326. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1753 -1753
  327. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +612 -612
  328. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1327 -1327
  329. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
  330. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
  331. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +787 -787
  332. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
  333. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +403 -403
  334. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +2148 -2148
  335. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1238 -1238
  336. package/src/swaps/trusted/ln/LnForGasSwap.ts +753 -753
  337. package/src/swaps/trusted/ln/LnForGasWrapper.ts +90 -90
  338. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +843 -843
  339. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +133 -133
  340. package/src/types/AmountData.ts +9 -9
  341. package/src/types/CustomPriceFunction.ts +11 -11
  342. package/src/types/PriceInfoType.ts +66 -66
  343. package/src/types/SwapExecutionAction.ts +323 -323
  344. package/src/types/SwapExecutionStep.ts +224 -224
  345. package/src/types/SwapStateInfo.ts +6 -6
  346. package/src/types/SwapWithSigner.ts +61 -61
  347. package/src/types/Token.ts +163 -163
  348. package/src/types/TokenAmount.ts +167 -167
  349. package/src/types/fees/Fee.ts +56 -56
  350. package/src/types/fees/FeeBreakdown.ts +11 -11
  351. package/src/types/fees/PercentagePPM.ts +26 -26
  352. package/src/types/lnurl/LNURLPay.ts +79 -79
  353. package/src/types/lnurl/LNURLWithdraw.ts +61 -61
  354. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
  355. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
  356. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
  357. package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
  358. package/src/utils/BitcoinUtils.ts +164 -164
  359. package/src/utils/BitcoinWalletUtils.ts +15 -15
  360. package/src/utils/Logger.ts +14 -14
  361. package/src/utils/RetryUtils.ts +78 -78
  362. package/src/utils/SwapUtils.ts +99 -99
  363. package/src/utils/TimeoutUtils.ts +49 -49
  364. package/src/utils/TokenUtils.ts +33 -33
  365. package/src/utils/TypeUtils.ts +8 -8
  366. package/src/utils/Utils.ts +221 -221
@@ -1,403 +1,403 @@
1
- import {ToBTCSwap, ToBTCSwapInit} from "./ToBTCSwap";
2
- import {IToBTCDefinition, IToBTCWrapper} from "../IToBTCWrapper";
3
- import {
4
- BigIntBufferUtils,
5
- BitcoinRpc,
6
- ChainSwapType,
7
- ChainType,
8
- SwapCommitState
9
- } from "@atomiqlabs/base";
10
- import {Intermediary, SingleChainReputationType} from "../../../../intermediaries/Intermediary";
11
- import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
12
- import {EventEmitter} from "events";
13
- import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
14
- import {Buffer} from "buffer";
15
- import {UserError} from "../../../../errors/UserError";
16
- import {IntermediaryError} from "../../../../errors/IntermediaryError";
17
- import {SwapType} from "../../../../enums/SwapType";
18
- import {
19
- extendAbortController,
20
- mapArrayToObject,
21
- randomBytes,
22
- throwIfUndefined
23
- } from "../../../../utils/Utils";
24
- import {toOutputScript} from "../../../../utils/BitcoinUtils";
25
- import {IntermediaryAPI, ToBTCResponseType} from "../../../../intermediaries/apis/IntermediaryAPI";
26
- import {RequestError} from "../../../../errors/RequestError";
27
- import {BTC_NETWORK, TEST_NETWORK} from "@scure/btc-signer/utils";
28
- import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
29
- import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
30
- import {ISwap} from "../../../ISwap";
31
- import {AmountData} from "../../../../types/AmountData";
32
- import {tryWithRetries} from "../../../../utils/RetryUtils";
33
- import {AllOptional} from "../../../../utils/TypeUtils";
34
- import {ToBTCSwapState} from "../IToBTCSwap";
35
-
36
- export type ToBTCOptions = {
37
- /**
38
- * @deprecated Ignored by the LP anyway
39
- */
40
- confirmationTarget?: number,
41
- /**
42
- * @deprecated Default 2 confirmations should be enough for any currently supported amount by atomiq
43
- */
44
- confirmations?: number
45
- }
46
-
47
- export type ToBTCWrapperOptions = ISwapWrapperOptions & {
48
- safetyFactor: number,
49
- maxConfirmations: number,
50
- bitcoinNetwork: BTC_NETWORK,
51
-
52
- bitcoinBlocktime: number,
53
-
54
- maxExpectedOnchainSendSafetyFactor: number,
55
- maxExpectedOnchainSendGracePeriodBlocks: number,
56
- };
57
-
58
- export type ToBTCDefinition<T extends ChainType> = IToBTCDefinition<T, ToBTCWrapper<T>, ToBTCSwap<T>>;
59
-
60
- /**
61
- * Escrow based (PrTLC) swap for Smart chains -> Bitcoin
62
- *
63
- * @category Swaps/Smart chain → Bitcoin
64
- */
65
- export class ToBTCWrapper<T extends ChainType> extends IToBTCWrapper<T, ToBTCDefinition<T>, ToBTCWrapperOptions> {
66
- public readonly TYPE: SwapType.TO_BTC = SwapType.TO_BTC;
67
- /**
68
- * @internal
69
- */
70
- readonly _swapDeserializer = ToBTCSwap;
71
- /**
72
- * @internal
73
- */
74
- readonly _btcRpc: BitcoinRpc<any>;
75
-
76
- /**
77
- * @param chainIdentifier
78
- * @param unifiedStorage Storage interface for the current environment
79
- * @param unifiedChainEvents Smart chain on-chain event listener
80
- * @param chain
81
- * @param versionedContracts Chain specific versioned contracts
82
- * @param prices Swap pricing handler
83
- * @param tokens
84
- * @param btcRpc Bitcoin RPC api
85
- * @param lpApi
86
- * @param options
87
- * @param events Instance to use for emitting events
88
- */
89
- constructor(
90
- chainIdentifier: string,
91
- unifiedStorage: UnifiedSwapStorage<T>,
92
- unifiedChainEvents: UnifiedSwapEventListener<T>,
93
- chain: T["ChainInterface"],
94
- prices: ISwapPrice,
95
- tokens: WrapperCtorTokens,
96
- versionedContracts: {
97
- [version: string]: {
98
- swapContract: T["Contract"],
99
- swapDataConstructor: new (data: any) => T["Data"]
100
- }
101
- },
102
- btcRpc: BitcoinRpc<any>,
103
- lpApi: IntermediaryAPI,
104
- options?: AllOptional<ToBTCWrapperOptions>,
105
- events?: EventEmitter<{swapState: [ISwap]}>
106
- ) {
107
- super(
108
- chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, lpApi,
109
- {
110
- ...options,
111
- bitcoinNetwork: options?.bitcoinNetwork ?? TEST_NETWORK,
112
- safetyFactor: options?.safetyFactor ?? 2,
113
- maxConfirmations: options?.maxConfirmations ?? 6,
114
- bitcoinBlocktime: options?.bitcoinBlocktime ?? (60*10),
115
- maxExpectedOnchainSendSafetyFactor: options?.maxExpectedOnchainSendSafetyFactor ?? 4,
116
- maxExpectedOnchainSendGracePeriodBlocks: options?.maxExpectedOnchainSendGracePeriodBlocks ?? 12,
117
- },
118
- versionedContracts,
119
- events
120
- );
121
- this._btcRpc = btcRpc;
122
- }
123
-
124
- /**
125
- * Returns randomly generated random bitcoin transaction nonce to be used for BTC on-chain swaps
126
- *
127
- * @returns Escrow nonce
128
- *
129
- * @private
130
- */
131
- private getRandomNonce(): bigint {
132
- const firstPart = BigInt(Math.floor((Date.now()/1000)) - 700000000);
133
-
134
- return (firstPart << 24n) | BigIntBufferUtils.fromBuffer(randomBytes(3));
135
- }
136
-
137
- /**
138
- * Converts bitcoin address to its corresponding output script
139
- *
140
- * @param addr Bitcoin address to get the output script for
141
- *
142
- * @returns Output script as Buffer
143
- * @throws {UserError} if invalid address is specified
144
- *
145
- * @private
146
- */
147
- private btcAddressToOutputScript(addr: string): Buffer {
148
- try {
149
- return toOutputScript(this._options.bitcoinNetwork, addr);
150
- } catch (e) {
151
- throw new UserError("Invalid address specified");
152
- }
153
- }
154
-
155
- /**
156
- * Verifies returned LP data
157
- *
158
- * @param signer
159
- * @param resp LP's response
160
- * @param amountData
161
- * @param lp
162
- * @param options Options as passed to the swap create function
163
- * @param data LP's returned parsed swap data
164
- * @param hash Payment hash of the swap
165
- *
166
- * @throws {IntermediaryError} if returned data are not correct
167
- *
168
- * @private
169
- */
170
- private verifyReturnedData(
171
- signer: string,
172
- resp: ToBTCResponseType,
173
- amountData: AmountData,
174
- lp: Intermediary,
175
- options: {
176
- confirmations: number,
177
- confirmationTarget: number
178
- },
179
- data: T["Data"],
180
- hash: string
181
- ): void {
182
- if(resp.totalFee !== (resp.swapFee + resp.networkFee)) throw new IntermediaryError("Invalid totalFee returned");
183
-
184
- if(amountData.exactIn) {
185
- if(resp.total !== amountData.amount) throw new IntermediaryError("Invalid total returned");
186
- } else {
187
- if(resp.amount !== amountData.amount) throw new IntermediaryError("Invalid amount returned");
188
- }
189
-
190
- const maxAllowedBlockDelta: bigint = BigInt(
191
- options.confirmations +
192
- options.confirmationTarget +
193
- this._options.maxExpectedOnchainSendGracePeriodBlocks
194
- );
195
- const maxAllowedExpiryDelta: bigint = maxAllowedBlockDelta
196
- * BigInt(this._options.maxExpectedOnchainSendSafetyFactor)
197
- * BigInt(this._options.bitcoinBlocktime);
198
- const currentTimestamp: bigint = BigInt(Math.floor(Date.now()/1000));
199
- const maxAllowedExpiryTimestamp: bigint = currentTimestamp + maxAllowedExpiryDelta;
200
-
201
- if(data.getExpiry() > maxAllowedExpiryTimestamp) {
202
- throw new IntermediaryError("Expiry time returned too high!");
203
- }
204
-
205
- if(
206
- data.getAmount() !== resp.total ||
207
- data.getClaimHash()!==hash ||
208
- data.getType()!==ChainSwapType.CHAIN_NONCED ||
209
- !data.isPayIn() ||
210
- !data.isToken(amountData.token) ||
211
- !data.isClaimer(lp.getAddress(this.chainIdentifier)) ||
212
- !data.isOfferer(signer) ||
213
- data.getTotalDeposit() !== 0n
214
- ) {
215
- throw new IntermediaryError("Invalid data returned");
216
- }
217
- }
218
-
219
- /**
220
- * Returns a newly created Smart chain -> Bitcoin swap using the PrTLC based escrow swap protocol,
221
- * with the passed amount.
222
- *
223
- * @param signer Source chain signer address initiating the swap
224
- * @param recipient Recipient bitcoin on-chain address
225
- * @param amountData Amount, token and exact input/output data for to swap
226
- * @param lps An array of intermediaries (LPs) to get the quotes from
227
- * @param options Optional additional quote options
228
- * @param additionalParams Optional additional parameters sent to the LP when creating the swap
229
- * @param abortSignal Abort signal
230
- */
231
- create(
232
- signer: string,
233
- recipient: string,
234
- amountData: AmountData,
235
- lps: Intermediary[],
236
- options?: ToBTCOptions,
237
- additionalParams?: Record<string, any>,
238
- abortSignal?: AbortSignal
239
- ): {
240
- quote: Promise<ToBTCSwap<T>>,
241
- intermediary: Intermediary
242
- }[] {
243
- if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
244
- const _options = {
245
- confirmationTarget: options?.confirmationTarget ?? 3,
246
- confirmations: options?.confirmations ?? 2
247
- };
248
- const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
249
-
250
- const nonce: bigint = this.getRandomNonce();
251
- const outputScript: Buffer = this.btcAddressToOutputScript(recipient);
252
- const _hash = !amountData.exactIn ?
253
- mapArrayToObject(lpVersions, (contractVersion: string) => {
254
- return this._contract(contractVersion).getHashForOnchain(outputScript, amountData.amount, _options.confirmations, nonce).toString("hex");
255
- }) :
256
- undefined;
257
-
258
- const _abortController = extendAbortController(abortSignal);
259
- const pricePreFetchPromise: Promise<bigint | undefined> = this.preFetchPrice(amountData, _abortController.signal);
260
- const usdPricePrefetchPromise: Promise<number | undefined> = this.preFetchUsdPrice(_abortController.signal);
261
- const feeRatePromise = this.preFetchFeeRate(signer, amountData, _hash, _abortController, lpVersions);
262
- const _signDataPromise = mapArrayToObject(lpVersions, (contractVersion: string) => {
263
- return this._contract(contractVersion).preFetchBlockDataForSignatures==null ?
264
- this.preFetchSignData(Promise.resolve(true), contractVersion) :
265
- undefined;
266
- });
267
-
268
- return lps.map(lp => {
269
- return {
270
- intermediary: lp,
271
- quote: (async () => {
272
- if(lp.services[SwapType.TO_BTC]==null) throw new Error("LP service for processing to btc swaps not found!");
273
- const version = lp.getContractVersion(this.chainIdentifier);
274
-
275
- const abortController = extendAbortController(_abortController.signal);
276
- const reputationPromise: Promise<SingleChainReputationType | undefined> = this.preFetchIntermediaryReputation(amountData, lp, abortController, version);
277
-
278
- try {
279
- const {signDataPromise, resp} = await tryWithRetries(async(retryCount) => {
280
- const {signDataPrefetch, response} = this._lpApi.initToBTC(this.chainIdentifier, lp.url, {
281
- btcAddress: recipient,
282
- amount: amountData.amount,
283
- confirmationTarget: _options.confirmationTarget,
284
- confirmations: _options.confirmations,
285
- nonce: nonce,
286
- token: amountData.token,
287
- offerer: signer,
288
- exactIn: amountData.exactIn,
289
- feeRate: throwIfUndefined(feeRatePromise[version], "Network fee rate pre-fetch failed!"),
290
- additionalParams
291
- }, this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined);
292
-
293
- let signDataPromise = _signDataPromise[version];
294
- if(signDataPromise==null) {
295
- signDataPromise = this.preFetchSignData(signDataPrefetch, version);
296
- } else signDataPrefetch.catch(() => {});
297
-
298
- return {
299
- signDataPromise,
300
- resp: await response
301
- };
302
- }, undefined, RequestError, abortController.signal);
303
-
304
- let hash: string = _hash?.[version] ?? this._contract(version).getHashForOnchain(outputScript, resp.amount, _options.confirmations, nonce).toString("hex");
305
-
306
- const data: T["Data"] = new (this._swapDataDeserializer(version))(resp.data);
307
- data.setOfferer(signer);
308
-
309
- const inputWithoutFees = data.getAmount() - resp.swapFee - resp.networkFee;
310
- const swapFeeBtc = resp.swapFee * resp.amount / inputWithoutFees;
311
- const networkFeeBtc = resp.networkFee * resp.amount / inputWithoutFees;
312
-
313
- this.verifyReturnedData(signer, resp, amountData, lp, _options, data, hash);
314
- const [pricingInfo, signatureExpiry, reputation] = await Promise.all([
315
- this.verifyReturnedPrice(
316
- lp.services[SwapType.TO_BTC], true, resp.amount, data.getAmount(),
317
- amountData.token, {networkFee: resp.networkFee, swapFeeBtc}, pricePreFetchPromise, usdPricePrefetchPromise, abortController.signal
318
- ),
319
- this.verifyReturnedSignature(signer, data, resp, feeRatePromise[version], signDataPromise, version, abortController.signal),
320
- reputationPromise
321
- ]);
322
- abortController.signal.throwIfAborted();
323
-
324
- if(reputation!=null) lp.reputation[amountData.token.toString()] = reputation;
325
-
326
- const quote = new ToBTCSwap<T>(this, {
327
- pricingInfo,
328
- url: lp.url,
329
- expiry: signatureExpiry,
330
- swapFee: resp.swapFee,
331
- swapFeeBtc,
332
- feeRate: (await feeRatePromise[version])!,
333
- signatureData: resp,
334
- data,
335
- networkFee: resp.networkFee,
336
- networkFeeBtc,
337
- address: recipient,
338
- amount: resp.amount,
339
- confirmationTarget: _options.confirmationTarget,
340
- satsPerVByte: Number(resp.satsPervByte),
341
- exactIn: amountData.exactIn,
342
- requiredConfirmations: _options.confirmations,
343
- nonce,
344
- contractVersion: version
345
- } as ToBTCSwapInit<T["Data"]>);
346
- return quote;
347
- } catch (e) {
348
- abortController.abort(e);
349
- throw e;
350
- }
351
- })()
352
- }
353
- });
354
- }
355
-
356
- /**
357
- * @inheritDoc
358
- */
359
- async recoverFromSwapDataAndState(
360
- init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
361
- state: SwapCommitState,
362
- contractVersion: string,
363
- lp?: Intermediary
364
- ): Promise<ToBTCSwap<T> | null> {
365
- const data = init.data;
366
-
367
- const swapInit: ToBTCSwapInit<T["Data"]> = {
368
- pricingInfo: {
369
- isValid: true,
370
- satsBaseFee: 0n,
371
- swapPriceUSatPerToken: 100_000_000_000_000n,
372
- realPriceUSatPerToken: 100_000_000_000_000n,
373
- differencePPM: 0n,
374
- feePPM: 0n,
375
- },
376
- url: lp?.url,
377
- expiry: 0,
378
- swapFee: 0n,
379
- swapFeeBtc: 0n,
380
- confirmationTarget: 1,
381
- satsPerVByte: 0,
382
- feeRate: "",
383
- signatureData: undefined,
384
- nonce: data.getNonceHint() ?? undefined,
385
- requiredConfirmations: data.getConfirmationsHint() ?? undefined,
386
- data,
387
- networkFee: 0n,
388
- networkFeeBtc: 0n,
389
- exactIn: true,
390
- contractVersion
391
- };
392
- const swap = new ToBTCSwap(this, swapInit);
393
- swap._commitTxId = await init.getInitTxId();
394
- const blockData = await init.getTxBlock();
395
- swap.createdAt = blockData.blockTime * 1000;
396
- swap._setInitiated();
397
- swap._state = ToBTCSwapState.COMMITED;
398
- await swap._sync(false, false, state);
399
- await swap._save();
400
- return swap;
401
- }
402
-
403
- }
1
+ import {ToBTCSwap, ToBTCSwapInit} from "./ToBTCSwap";
2
+ import {IToBTCDefinition, IToBTCWrapper} from "../IToBTCWrapper";
3
+ import {
4
+ BigIntBufferUtils,
5
+ BitcoinRpc,
6
+ ChainSwapType,
7
+ ChainType,
8
+ SwapCommitState
9
+ } from "@atomiqlabs/base";
10
+ import {Intermediary, SingleChainReputationType} from "../../../../intermediaries/Intermediary";
11
+ import {ISwapPrice} from "../../../../prices/abstract/ISwapPrice";
12
+ import {EventEmitter} from "events";
13
+ import {ISwapWrapperOptions, WrapperCtorTokens} from "../../../ISwapWrapper";
14
+ import {Buffer} from "buffer";
15
+ import {UserError} from "../../../../errors/UserError";
16
+ import {IntermediaryError} from "../../../../errors/IntermediaryError";
17
+ import {SwapType} from "../../../../enums/SwapType";
18
+ import {
19
+ extendAbortController,
20
+ mapArrayToObject,
21
+ randomBytes,
22
+ throwIfUndefined
23
+ } from "../../../../utils/Utils";
24
+ import {toOutputScript} from "../../../../utils/BitcoinUtils";
25
+ import {IntermediaryAPI, ToBTCResponseType} from "../../../../intermediaries/apis/IntermediaryAPI";
26
+ import {RequestError} from "../../../../errors/RequestError";
27
+ import {BTC_NETWORK, TEST_NETWORK} from "@scure/btc-signer/utils";
28
+ import {UnifiedSwapEventListener} from "../../../../events/UnifiedSwapEventListener";
29
+ import {UnifiedSwapStorage} from "../../../../storage/UnifiedSwapStorage";
30
+ import {ISwap} from "../../../ISwap";
31
+ import {AmountData} from "../../../../types/AmountData";
32
+ import {tryWithRetries} from "../../../../utils/RetryUtils";
33
+ import {AllOptional} from "../../../../utils/TypeUtils";
34
+ import {ToBTCSwapState} from "../IToBTCSwap";
35
+
36
+ export type ToBTCOptions = {
37
+ /**
38
+ * @deprecated Ignored by the LP anyway
39
+ */
40
+ confirmationTarget?: number,
41
+ /**
42
+ * @deprecated Default 2 confirmations should be enough for any currently supported amount by atomiq
43
+ */
44
+ confirmations?: number
45
+ }
46
+
47
+ export type ToBTCWrapperOptions = ISwapWrapperOptions & {
48
+ safetyFactor: number,
49
+ maxConfirmations: number,
50
+ bitcoinNetwork: BTC_NETWORK,
51
+
52
+ bitcoinBlocktime: number,
53
+
54
+ maxExpectedOnchainSendSafetyFactor: number,
55
+ maxExpectedOnchainSendGracePeriodBlocks: number,
56
+ };
57
+
58
+ export type ToBTCDefinition<T extends ChainType> = IToBTCDefinition<T, ToBTCWrapper<T>, ToBTCSwap<T>>;
59
+
60
+ /**
61
+ * Escrow based (PrTLC) swap for Smart chains -> Bitcoin
62
+ *
63
+ * @category Swaps/Smart chain → Bitcoin
64
+ */
65
+ export class ToBTCWrapper<T extends ChainType> extends IToBTCWrapper<T, ToBTCDefinition<T>, ToBTCWrapperOptions> {
66
+ public readonly TYPE: SwapType.TO_BTC = SwapType.TO_BTC;
67
+ /**
68
+ * @internal
69
+ */
70
+ readonly _swapDeserializer = ToBTCSwap;
71
+ /**
72
+ * @internal
73
+ */
74
+ readonly _btcRpc: BitcoinRpc<any>;
75
+
76
+ /**
77
+ * @param chainIdentifier
78
+ * @param unifiedStorage Storage interface for the current environment
79
+ * @param unifiedChainEvents Smart chain on-chain event listener
80
+ * @param chain
81
+ * @param versionedContracts Chain specific versioned contracts
82
+ * @param prices Swap pricing handler
83
+ * @param tokens
84
+ * @param btcRpc Bitcoin RPC api
85
+ * @param lpApi
86
+ * @param options
87
+ * @param events Instance to use for emitting events
88
+ */
89
+ constructor(
90
+ chainIdentifier: string,
91
+ unifiedStorage: UnifiedSwapStorage<T>,
92
+ unifiedChainEvents: UnifiedSwapEventListener<T>,
93
+ chain: T["ChainInterface"],
94
+ prices: ISwapPrice,
95
+ tokens: WrapperCtorTokens,
96
+ versionedContracts: {
97
+ [version: string]: {
98
+ swapContract: T["Contract"],
99
+ swapDataConstructor: new (data: any) => T["Data"]
100
+ }
101
+ },
102
+ btcRpc: BitcoinRpc<any>,
103
+ lpApi: IntermediaryAPI,
104
+ options?: AllOptional<ToBTCWrapperOptions>,
105
+ events?: EventEmitter<{swapState: [ISwap]}>
106
+ ) {
107
+ super(
108
+ chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, lpApi,
109
+ {
110
+ ...options,
111
+ bitcoinNetwork: options?.bitcoinNetwork ?? TEST_NETWORK,
112
+ safetyFactor: options?.safetyFactor ?? 2,
113
+ maxConfirmations: options?.maxConfirmations ?? 6,
114
+ bitcoinBlocktime: options?.bitcoinBlocktime ?? (60*10),
115
+ maxExpectedOnchainSendSafetyFactor: options?.maxExpectedOnchainSendSafetyFactor ?? 4,
116
+ maxExpectedOnchainSendGracePeriodBlocks: options?.maxExpectedOnchainSendGracePeriodBlocks ?? 12,
117
+ },
118
+ versionedContracts,
119
+ events
120
+ );
121
+ this._btcRpc = btcRpc;
122
+ }
123
+
124
+ /**
125
+ * Returns randomly generated random bitcoin transaction nonce to be used for BTC on-chain swaps
126
+ *
127
+ * @returns Escrow nonce
128
+ *
129
+ * @private
130
+ */
131
+ private getRandomNonce(): bigint {
132
+ const firstPart = BigInt(Math.floor((Date.now()/1000)) - 700000000);
133
+
134
+ return (firstPart << 24n) | BigIntBufferUtils.fromBuffer(randomBytes(3));
135
+ }
136
+
137
+ /**
138
+ * Converts bitcoin address to its corresponding output script
139
+ *
140
+ * @param addr Bitcoin address to get the output script for
141
+ *
142
+ * @returns Output script as Buffer
143
+ * @throws {UserError} if invalid address is specified
144
+ *
145
+ * @private
146
+ */
147
+ private btcAddressToOutputScript(addr: string): Buffer {
148
+ try {
149
+ return toOutputScript(this._options.bitcoinNetwork, addr);
150
+ } catch (e) {
151
+ throw new UserError("Invalid address specified");
152
+ }
153
+ }
154
+
155
+ /**
156
+ * Verifies returned LP data
157
+ *
158
+ * @param signer
159
+ * @param resp LP's response
160
+ * @param amountData
161
+ * @param lp
162
+ * @param options Options as passed to the swap create function
163
+ * @param data LP's returned parsed swap data
164
+ * @param hash Payment hash of the swap
165
+ *
166
+ * @throws {IntermediaryError} if returned data are not correct
167
+ *
168
+ * @private
169
+ */
170
+ private verifyReturnedData(
171
+ signer: string,
172
+ resp: ToBTCResponseType,
173
+ amountData: AmountData,
174
+ lp: Intermediary,
175
+ options: {
176
+ confirmations: number,
177
+ confirmationTarget: number
178
+ },
179
+ data: T["Data"],
180
+ hash: string
181
+ ): void {
182
+ if(resp.totalFee !== (resp.swapFee + resp.networkFee)) throw new IntermediaryError("Invalid totalFee returned");
183
+
184
+ if(amountData.exactIn) {
185
+ if(resp.total !== amountData.amount) throw new IntermediaryError("Invalid total returned");
186
+ } else {
187
+ if(resp.amount !== amountData.amount) throw new IntermediaryError("Invalid amount returned");
188
+ }
189
+
190
+ const maxAllowedBlockDelta: bigint = BigInt(
191
+ options.confirmations +
192
+ options.confirmationTarget +
193
+ this._options.maxExpectedOnchainSendGracePeriodBlocks
194
+ );
195
+ const maxAllowedExpiryDelta: bigint = maxAllowedBlockDelta
196
+ * BigInt(this._options.maxExpectedOnchainSendSafetyFactor)
197
+ * BigInt(this._options.bitcoinBlocktime);
198
+ const currentTimestamp: bigint = BigInt(Math.floor(Date.now()/1000));
199
+ const maxAllowedExpiryTimestamp: bigint = currentTimestamp + maxAllowedExpiryDelta;
200
+
201
+ if(data.getExpiry() > maxAllowedExpiryTimestamp) {
202
+ throw new IntermediaryError("Expiry time returned too high!");
203
+ }
204
+
205
+ if(
206
+ data.getAmount() !== resp.total ||
207
+ data.getClaimHash()!==hash ||
208
+ data.getType()!==ChainSwapType.CHAIN_NONCED ||
209
+ !data.isPayIn() ||
210
+ !data.isToken(amountData.token) ||
211
+ !data.isClaimer(lp.getAddress(this.chainIdentifier)) ||
212
+ !data.isOfferer(signer) ||
213
+ data.getTotalDeposit() !== 0n
214
+ ) {
215
+ throw new IntermediaryError("Invalid data returned");
216
+ }
217
+ }
218
+
219
+ /**
220
+ * Returns a newly created Smart chain -> Bitcoin swap using the PrTLC based escrow swap protocol,
221
+ * with the passed amount.
222
+ *
223
+ * @param signer Source chain signer address initiating the swap
224
+ * @param recipient Recipient bitcoin on-chain address
225
+ * @param amountData Amount, token and exact input/output data for to swap
226
+ * @param lps An array of intermediaries (LPs) to get the quotes from
227
+ * @param options Optional additional quote options
228
+ * @param additionalParams Optional additional parameters sent to the LP when creating the swap
229
+ * @param abortSignal Abort signal
230
+ */
231
+ create(
232
+ signer: string,
233
+ recipient: string,
234
+ amountData: AmountData,
235
+ lps: Intermediary[],
236
+ options?: ToBTCOptions,
237
+ additionalParams?: Record<string, any>,
238
+ abortSignal?: AbortSignal
239
+ ): {
240
+ quote: Promise<ToBTCSwap<T>>,
241
+ intermediary: Intermediary
242
+ }[] {
243
+ if(!this.isInitialized) throw new Error("Not initialized, call init() first!");
244
+ const _options = {
245
+ confirmationTarget: options?.confirmationTarget ?? 3,
246
+ confirmations: options?.confirmations ?? 2
247
+ };
248
+ const lpVersions = Intermediary.getContractVersionsForLps(this.chainIdentifier, lps);
249
+
250
+ const nonce: bigint = this.getRandomNonce();
251
+ const outputScript: Buffer = this.btcAddressToOutputScript(recipient);
252
+ const _hash = !amountData.exactIn ?
253
+ mapArrayToObject(lpVersions, (contractVersion: string) => {
254
+ return this._contract(contractVersion).getHashForOnchain(outputScript, amountData.amount, _options.confirmations, nonce).toString("hex");
255
+ }) :
256
+ undefined;
257
+
258
+ const _abortController = extendAbortController(abortSignal);
259
+ const pricePreFetchPromise: Promise<bigint | undefined> = this.preFetchPrice(amountData, _abortController.signal);
260
+ const usdPricePrefetchPromise: Promise<number | undefined> = this.preFetchUsdPrice(_abortController.signal);
261
+ const feeRatePromise = this.preFetchFeeRate(signer, amountData, _hash, _abortController, lpVersions);
262
+ const _signDataPromise = mapArrayToObject(lpVersions, (contractVersion: string) => {
263
+ return this._contract(contractVersion).preFetchBlockDataForSignatures==null ?
264
+ this.preFetchSignData(Promise.resolve(true), contractVersion) :
265
+ undefined;
266
+ });
267
+
268
+ return lps.map(lp => {
269
+ return {
270
+ intermediary: lp,
271
+ quote: (async () => {
272
+ if(lp.services[SwapType.TO_BTC]==null) throw new Error("LP service for processing to btc swaps not found!");
273
+ const version = lp.getContractVersion(this.chainIdentifier);
274
+
275
+ const abortController = extendAbortController(_abortController.signal);
276
+ const reputationPromise: Promise<SingleChainReputationType | undefined> = this.preFetchIntermediaryReputation(amountData, lp, abortController, version);
277
+
278
+ try {
279
+ const {signDataPromise, resp} = await tryWithRetries(async(retryCount) => {
280
+ const {signDataPrefetch, response} = this._lpApi.initToBTC(this.chainIdentifier, lp.url, {
281
+ btcAddress: recipient,
282
+ amount: amountData.amount,
283
+ confirmationTarget: _options.confirmationTarget,
284
+ confirmations: _options.confirmations,
285
+ nonce: nonce,
286
+ token: amountData.token,
287
+ offerer: signer,
288
+ exactIn: amountData.exactIn,
289
+ feeRate: throwIfUndefined(feeRatePromise[version], "Network fee rate pre-fetch failed!"),
290
+ additionalParams
291
+ }, this._options.postRequestTimeout, abortController.signal, retryCount>0 ? false : undefined);
292
+
293
+ let signDataPromise = _signDataPromise[version];
294
+ if(signDataPromise==null) {
295
+ signDataPromise = this.preFetchSignData(signDataPrefetch, version);
296
+ } else signDataPrefetch.catch(() => {});
297
+
298
+ return {
299
+ signDataPromise,
300
+ resp: await response
301
+ };
302
+ }, undefined, RequestError, abortController.signal);
303
+
304
+ let hash: string = _hash?.[version] ?? this._contract(version).getHashForOnchain(outputScript, resp.amount, _options.confirmations, nonce).toString("hex");
305
+
306
+ const data: T["Data"] = new (this._swapDataDeserializer(version))(resp.data);
307
+ data.setOfferer(signer);
308
+
309
+ const inputWithoutFees = data.getAmount() - resp.swapFee - resp.networkFee;
310
+ const swapFeeBtc = resp.swapFee * resp.amount / inputWithoutFees;
311
+ const networkFeeBtc = resp.networkFee * resp.amount / inputWithoutFees;
312
+
313
+ this.verifyReturnedData(signer, resp, amountData, lp, _options, data, hash);
314
+ const [pricingInfo, signatureExpiry, reputation] = await Promise.all([
315
+ this.verifyReturnedPrice(
316
+ lp.services[SwapType.TO_BTC], true, resp.amount, data.getAmount(),
317
+ amountData.token, {networkFee: resp.networkFee, swapFeeBtc}, pricePreFetchPromise, usdPricePrefetchPromise, abortController.signal
318
+ ),
319
+ this.verifyReturnedSignature(signer, data, resp, feeRatePromise[version], signDataPromise, version, abortController.signal),
320
+ reputationPromise
321
+ ]);
322
+ abortController.signal.throwIfAborted();
323
+
324
+ if(reputation!=null) lp.reputation[amountData.token.toString()] = reputation;
325
+
326
+ const quote = new ToBTCSwap<T>(this, {
327
+ pricingInfo,
328
+ url: lp.url,
329
+ expiry: signatureExpiry,
330
+ swapFee: resp.swapFee,
331
+ swapFeeBtc,
332
+ feeRate: (await feeRatePromise[version])!,
333
+ signatureData: resp,
334
+ data,
335
+ networkFee: resp.networkFee,
336
+ networkFeeBtc,
337
+ address: recipient,
338
+ amount: resp.amount,
339
+ confirmationTarget: _options.confirmationTarget,
340
+ satsPerVByte: Number(resp.satsPervByte),
341
+ exactIn: amountData.exactIn,
342
+ requiredConfirmations: _options.confirmations,
343
+ nonce,
344
+ contractVersion: version
345
+ } as ToBTCSwapInit<T["Data"]>);
346
+ return quote;
347
+ } catch (e) {
348
+ abortController.abort(e);
349
+ throw e;
350
+ }
351
+ })()
352
+ }
353
+ });
354
+ }
355
+
356
+ /**
357
+ * @inheritDoc
358
+ */
359
+ async recoverFromSwapDataAndState(
360
+ init: {data: T["Data"], getInitTxId: () => Promise<string>, getTxBlock: () => Promise<{blockTime: number, blockHeight: number}>},
361
+ state: SwapCommitState,
362
+ contractVersion: string,
363
+ lp?: Intermediary
364
+ ): Promise<ToBTCSwap<T> | null> {
365
+ const data = init.data;
366
+
367
+ const swapInit: ToBTCSwapInit<T["Data"]> = {
368
+ pricingInfo: {
369
+ isValid: true,
370
+ satsBaseFee: 0n,
371
+ swapPriceUSatPerToken: 100_000_000_000_000n,
372
+ realPriceUSatPerToken: 100_000_000_000_000n,
373
+ differencePPM: 0n,
374
+ feePPM: 0n,
375
+ },
376
+ url: lp?.url,
377
+ expiry: 0,
378
+ swapFee: 0n,
379
+ swapFeeBtc: 0n,
380
+ confirmationTarget: 1,
381
+ satsPerVByte: 0,
382
+ feeRate: "",
383
+ signatureData: undefined,
384
+ nonce: data.getNonceHint() ?? undefined,
385
+ requiredConfirmations: data.getConfirmationsHint() ?? undefined,
386
+ data,
387
+ networkFee: 0n,
388
+ networkFeeBtc: 0n,
389
+ exactIn: true,
390
+ contractVersion
391
+ };
392
+ const swap = new ToBTCSwap(this, swapInit);
393
+ swap._commitTxId = await init.getInitTxId();
394
+ const blockData = await init.getTxBlock();
395
+ swap.createdAt = blockData.blockTime * 1000;
396
+ swap._setInitiated();
397
+ swap._state = ToBTCSwapState.COMMITED;
398
+ await swap._sync(false, false, state);
399
+ await swap._save();
400
+ return swap;
401
+ }
402
+
403
+ }