@atomiqlabs/sdk 8.8.3 → 8.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (339) hide show
  1. package/LICENSE +201 -201
  2. package/README.md +1760 -1760
  3. package/dist/SmartChainAssets.d.ts +181 -181
  4. package/dist/SmartChainAssets.js +181 -181
  5. package/dist/bitcoin/coinselect2/accumulative.d.ts +7 -7
  6. package/dist/bitcoin/coinselect2/accumulative.js +52 -52
  7. package/dist/bitcoin/coinselect2/blackjack.d.ts +7 -7
  8. package/dist/bitcoin/coinselect2/blackjack.js +38 -38
  9. package/dist/bitcoin/coinselect2/index.d.ts +20 -20
  10. package/dist/bitcoin/coinselect2/index.js +69 -69
  11. package/dist/bitcoin/coinselect2/utils.d.ts +82 -82
  12. package/dist/bitcoin/coinselect2/utils.js +158 -158
  13. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +113 -113
  14. package/dist/bitcoin/wallet/BitcoinWallet.js +335 -335
  15. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +116 -116
  16. package/dist/bitcoin/wallet/IBitcoinWallet.js +21 -21
  17. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +106 -106
  18. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +196 -196
  19. package/dist/enums/FeeType.d.ts +15 -15
  20. package/dist/enums/FeeType.js +19 -19
  21. package/dist/enums/SwapAmountType.d.ts +15 -15
  22. package/dist/enums/SwapAmountType.js +19 -19
  23. package/dist/enums/SwapDirection.d.ts +15 -15
  24. package/dist/enums/SwapDirection.js +19 -19
  25. package/dist/enums/SwapSide.d.ts +15 -15
  26. package/dist/enums/SwapSide.js +19 -19
  27. package/dist/enums/SwapType.d.ts +75 -75
  28. package/dist/enums/SwapType.js +79 -79
  29. package/dist/errors/IntermediaryError.d.ts +13 -13
  30. package/dist/errors/IntermediaryError.js +27 -27
  31. package/dist/errors/RequestError.d.ts +32 -32
  32. package/dist/errors/RequestError.js +54 -54
  33. package/dist/errors/UserError.d.ts +8 -8
  34. package/dist/errors/UserError.js +16 -16
  35. package/dist/events/UnifiedSwapEventListener.d.ts +23 -23
  36. package/dist/events/UnifiedSwapEventListener.js +132 -132
  37. package/dist/http/HttpUtils.d.ts +27 -27
  38. package/dist/http/HttpUtils.js +91 -91
  39. package/dist/http/paramcoders/IParamReader.d.ts +8 -8
  40. package/dist/http/paramcoders/IParamReader.js +2 -2
  41. package/dist/http/paramcoders/ParamDecoder.d.ts +44 -44
  42. package/dist/http/paramcoders/ParamDecoder.js +137 -137
  43. package/dist/http/paramcoders/ParamEncoder.d.ts +20 -20
  44. package/dist/http/paramcoders/ParamEncoder.js +36 -36
  45. package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
  46. package/dist/http/paramcoders/SchemaVerifier.js +145 -145
  47. package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
  48. package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
  49. package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +13 -13
  50. package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
  51. package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +16 -16
  52. package/dist/http/paramcoders/client/StreamingFetchPromise.js +174 -174
  53. package/dist/index.d.ts +85 -85
  54. package/dist/index.js +158 -158
  55. package/dist/intermediaries/Intermediary.d.ts +178 -178
  56. package/dist/intermediaries/Intermediary.js +166 -166
  57. package/dist/intermediaries/IntermediaryDiscovery.d.ts +211 -211
  58. package/dist/intermediaries/IntermediaryDiscovery.js +424 -424
  59. package/dist/intermediaries/apis/IntermediaryAPI.d.ts +450 -450
  60. package/dist/intermediaries/apis/IntermediaryAPI.js +618 -618
  61. package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
  62. package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
  63. package/dist/lnurl/LNURL.d.ts +102 -102
  64. package/dist/lnurl/LNURL.js +321 -321
  65. package/dist/prices/RedundantSwapPrice.d.ts +110 -110
  66. package/dist/prices/RedundantSwapPrice.js +222 -222
  67. package/dist/prices/SingleSwapPrice.d.ts +34 -34
  68. package/dist/prices/SingleSwapPrice.js +44 -44
  69. package/dist/prices/SwapPriceWithChain.d.ts +107 -107
  70. package/dist/prices/SwapPriceWithChain.js +128 -128
  71. package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
  72. package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
  73. package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
  74. package/dist/prices/abstract/IPriceProvider.js +74 -74
  75. package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
  76. package/dist/prices/abstract/ISwapPrice.js +279 -279
  77. package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
  78. package/dist/prices/providers/BinancePriceProvider.js +30 -30
  79. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
  80. package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
  81. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
  82. package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
  83. package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
  84. package/dist/prices/providers/CustomPriceProvider.js +35 -35
  85. package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
  86. package/dist/prices/providers/KrakenPriceProvider.js +45 -45
  87. package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
  88. package/dist/prices/providers/OKXPriceProvider.js +29 -29
  89. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
  90. package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
  91. package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
  92. package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
  93. package/dist/storage/IUnifiedStorage.d.ts +85 -85
  94. package/dist/storage/IUnifiedStorage.js +2 -2
  95. package/dist/storage/UnifiedSwapStorage.d.ts +114 -114
  96. package/dist/storage/UnifiedSwapStorage.js +116 -116
  97. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
  98. package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
  99. package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
  100. package/dist/storage-browser/LocalStorageManager.js +93 -93
  101. package/dist/swapper/Swapper.d.ts +732 -732
  102. package/dist/swapper/Swapper.js +1713 -1713
  103. package/dist/swapper/SwapperFactory.d.ts +135 -135
  104. package/dist/swapper/SwapperFactory.js +162 -162
  105. package/dist/swapper/SwapperUtils.d.ts +206 -206
  106. package/dist/swapper/SwapperUtils.js +481 -481
  107. package/dist/swapper/SwapperWithChain.d.ts +404 -404
  108. package/dist/swapper/SwapperWithChain.js +469 -469
  109. package/dist/swapper/SwapperWithSigner.d.ts +322 -322
  110. package/dist/swapper/SwapperWithSigner.js +318 -318
  111. package/dist/swaps/IAddressSwap.d.ts +22 -22
  112. package/dist/swaps/IAddressSwap.js +14 -14
  113. package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
  114. package/dist/swaps/IBTCWalletSwap.js +18 -18
  115. package/dist/swaps/IClaimableSwap.d.ts +49 -49
  116. package/dist/swaps/IClaimableSwap.js +15 -15
  117. package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
  118. package/dist/swaps/IClaimableSwapWrapper.js +2 -2
  119. package/dist/swaps/IRefundableSwap.d.ts +43 -43
  120. package/dist/swaps/IRefundableSwap.js +14 -14
  121. package/dist/swaps/ISwap.d.ts +392 -392
  122. package/dist/swaps/ISwap.js +349 -349
  123. package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
  124. package/dist/swaps/ISwapWithGasDrop.js +12 -12
  125. package/dist/swaps/ISwapWrapper.d.ts +285 -285
  126. package/dist/swaps/ISwapWrapper.js +353 -353
  127. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
  128. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
  129. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +139 -139
  130. package/dist/swaps/escrow_swaps/IEscrowSwap.js +170 -170
  131. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +128 -128
  132. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +167 -167
  133. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +105 -105
  134. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +129 -129
  135. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
  136. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
  137. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +64 -64
  138. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +82 -82
  139. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +531 -531
  140. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1285 -1285
  141. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +190 -190
  142. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +432 -432
  143. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +583 -583
  144. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1371 -1371
  145. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +235 -235
  146. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +525 -525
  147. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +458 -458
  148. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1126 -1126
  149. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +202 -202
  150. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +406 -406
  151. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +403 -403
  152. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +924 -924
  153. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +68 -68
  154. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +117 -117
  155. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +127 -127
  156. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
  157. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +251 -251
  158. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +536 -536
  159. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
  160. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
  161. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +132 -132
  162. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +286 -286
  163. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +637 -637
  164. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1448 -1448
  165. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +257 -257
  166. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +947 -947
  167. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +261 -261
  168. package/dist/swaps/trusted/ln/LnForGasSwap.js +511 -511
  169. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
  170. package/dist/swaps/trusted/ln/LnForGasWrapper.js +83 -83
  171. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +342 -342
  172. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +715 -715
  173. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +69 -69
  174. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +93 -93
  175. package/dist/types/AmountData.d.ts +10 -10
  176. package/dist/types/AmountData.js +2 -2
  177. package/dist/types/CustomPriceFunction.d.ts +11 -11
  178. package/dist/types/CustomPriceFunction.js +2 -2
  179. package/dist/types/PriceInfoType.d.ts +28 -28
  180. package/dist/types/PriceInfoType.js +57 -57
  181. package/dist/types/SwapExecutionAction.d.ts +88 -88
  182. package/dist/types/SwapExecutionAction.js +2 -2
  183. package/dist/types/SwapStateInfo.d.ts +5 -5
  184. package/dist/types/SwapStateInfo.js +2 -2
  185. package/dist/types/SwapWithSigner.d.ts +17 -17
  186. package/dist/types/SwapWithSigner.js +43 -43
  187. package/dist/types/Token.d.ts +99 -99
  188. package/dist/types/Token.js +76 -76
  189. package/dist/types/TokenAmount.d.ts +69 -69
  190. package/dist/types/TokenAmount.js +60 -60
  191. package/dist/types/fees/Fee.d.ts +50 -50
  192. package/dist/types/fees/Fee.js +2 -2
  193. package/dist/types/fees/FeeBreakdown.d.ts +11 -11
  194. package/dist/types/fees/FeeBreakdown.js +2 -2
  195. package/dist/types/fees/PercentagePPM.d.ts +17 -17
  196. package/dist/types/fees/PercentagePPM.js +18 -18
  197. package/dist/types/lnurl/LNURLPay.d.ts +61 -61
  198. package/dist/types/lnurl/LNURLPay.js +31 -31
  199. package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
  200. package/dist/types/lnurl/LNURLWithdraw.js +27 -27
  201. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
  202. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -15
  203. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
  204. package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
  205. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
  206. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
  207. package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
  208. package/dist/utils/AutomaticClockDriftCorrection.js +70 -70
  209. package/dist/utils/BitcoinUtils.d.ts +16 -16
  210. package/dist/utils/BitcoinUtils.js +141 -141
  211. package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
  212. package/dist/utils/BitcoinWalletUtils.js +14 -14
  213. package/dist/utils/Logger.d.ts +7 -7
  214. package/dist/utils/Logger.js +12 -12
  215. package/dist/utils/RetryUtils.d.ts +22 -22
  216. package/dist/utils/RetryUtils.js +67 -67
  217. package/dist/utils/SwapUtils.d.ts +88 -88
  218. package/dist/utils/SwapUtils.js +72 -72
  219. package/dist/utils/TimeoutUtils.d.ts +17 -17
  220. package/dist/utils/TimeoutUtils.js +55 -55
  221. package/dist/utils/TokenUtils.d.ts +19 -19
  222. package/dist/utils/TokenUtils.js +37 -37
  223. package/dist/utils/TypeUtils.d.ts +7 -7
  224. package/dist/utils/TypeUtils.js +2 -2
  225. package/dist/utils/Utils.d.ts +67 -67
  226. package/dist/utils/Utils.js +208 -208
  227. package/package.json +43 -43
  228. package/src/SmartChainAssets.ts +186 -186
  229. package/src/bitcoin/coinselect2/accumulative.ts +69 -69
  230. package/src/bitcoin/coinselect2/blackjack.ts +50 -50
  231. package/src/bitcoin/coinselect2/index.ts +93 -93
  232. package/src/bitcoin/coinselect2/utils.ts +236 -236
  233. package/src/bitcoin/wallet/BitcoinWallet.ts +439 -439
  234. package/src/bitcoin/wallet/IBitcoinWallet.ts +140 -140
  235. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +225 -225
  236. package/src/enums/FeeType.ts +15 -15
  237. package/src/enums/SwapAmountType.ts +16 -16
  238. package/src/enums/SwapDirection.ts +15 -15
  239. package/src/enums/SwapSide.ts +16 -16
  240. package/src/enums/SwapType.ts +75 -75
  241. package/src/errors/IntermediaryError.ts +28 -28
  242. package/src/errors/RequestError.ts +64 -64
  243. package/src/errors/UserError.ts +15 -15
  244. package/src/events/UnifiedSwapEventListener.ts +173 -173
  245. package/src/http/HttpUtils.ts +91 -91
  246. package/src/http/paramcoders/IParamReader.ts +9 -9
  247. package/src/http/paramcoders/ParamDecoder.ts +145 -145
  248. package/src/http/paramcoders/ParamEncoder.ts +40 -40
  249. package/src/http/paramcoders/SchemaVerifier.ts +153 -153
  250. package/src/http/paramcoders/client/ResponseParamDecoder.ts +57 -57
  251. package/src/http/paramcoders/client/StreamParamEncoder.ts +28 -28
  252. package/src/http/paramcoders/client/StreamingFetchPromise.ts +192 -192
  253. package/src/index.ts +140 -140
  254. package/src/intermediaries/Intermediary.ts +280 -280
  255. package/src/intermediaries/IntermediaryDiscovery.ts +541 -541
  256. package/src/intermediaries/apis/IntermediaryAPI.ts +963 -963
  257. package/src/intermediaries/apis/TrustedIntermediaryAPI.ts +257 -257
  258. package/src/lnurl/LNURL.ts +402 -402
  259. package/src/prices/RedundantSwapPrice.ts +264 -264
  260. package/src/prices/SingleSwapPrice.ts +50 -50
  261. package/src/prices/SwapPriceWithChain.ts +194 -194
  262. package/src/prices/abstract/ICachedSwapPrice.ts +85 -85
  263. package/src/prices/abstract/IPriceProvider.ts +127 -127
  264. package/src/prices/abstract/ISwapPrice.ts +390 -390
  265. package/src/prices/providers/BinancePriceProvider.ts +48 -48
  266. package/src/prices/providers/CoinGeckoPriceProvider.ts +46 -46
  267. package/src/prices/providers/CoinPaprikaPriceProvider.ts +49 -49
  268. package/src/prices/providers/CustomPriceProvider.ts +40 -40
  269. package/src/prices/providers/KrakenPriceProvider.ts +83 -83
  270. package/src/prices/providers/OKXPriceProvider.ts +59 -59
  271. package/src/prices/providers/abstract/ExchangePriceProvider.ts +31 -31
  272. package/src/prices/providers/abstract/HttpPriceProvider.ts +14 -14
  273. package/src/storage/IUnifiedStorage.ts +95 -95
  274. package/src/storage/UnifiedSwapStorage.ts +141 -141
  275. package/src/storage-browser/IndexedDBUnifiedStorage.ts +350 -350
  276. package/src/storage-browser/LocalStorageManager.ts +106 -106
  277. package/src/swapper/Swapper.ts +2488 -2488
  278. package/src/swapper/SwapperFactory.ts +307 -307
  279. package/src/swapper/SwapperUtils.ts +570 -570
  280. package/src/swapper/SwapperWithChain.ts +707 -707
  281. package/src/swapper/SwapperWithSigner.ts +511 -511
  282. package/src/swaps/IAddressSwap.ts +30 -30
  283. package/src/swaps/IBTCWalletSwap.ts +92 -92
  284. package/src/swaps/IClaimableSwap.ts +65 -65
  285. package/src/swaps/IClaimableSwapWrapper.ts +17 -17
  286. package/src/swaps/IRefundableSwap.ts +58 -58
  287. package/src/swaps/ISwap.ts +703 -703
  288. package/src/swaps/ISwapWithGasDrop.ts +25 -25
  289. package/src/swaps/ISwapWrapper.ts +539 -539
  290. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +217 -217
  291. package/src/swaps/escrow_swaps/IEscrowSwap.ts +269 -269
  292. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +282 -282
  293. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +169 -169
  294. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +300 -300
  295. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +107 -107
  296. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +1473 -1474
  297. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +601 -601
  298. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +1582 -1582
  299. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +750 -750
  300. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +1299 -1299
  301. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +610 -610
  302. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +1096 -1096
  303. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +138 -138
  304. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +304 -304
  305. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +786 -786
  306. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +206 -206
  307. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +401 -401
  308. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +1812 -1812
  309. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +1236 -1236
  310. package/src/swaps/trusted/ln/LnForGasSwap.ts +589 -589
  311. package/src/swaps/trusted/ln/LnForGasWrapper.ts +91 -91
  312. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +862 -862
  313. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +131 -131
  314. package/src/types/AmountData.ts +9 -9
  315. package/src/types/CustomPriceFunction.ts +11 -11
  316. package/src/types/PriceInfoType.ts +66 -66
  317. package/src/types/SwapExecutionAction.ts +99 -99
  318. package/src/types/SwapStateInfo.ts +6 -6
  319. package/src/types/SwapWithSigner.ts +61 -61
  320. package/src/types/Token.ts +163 -163
  321. package/src/types/TokenAmount.ts +132 -132
  322. package/src/types/fees/Fee.ts +56 -56
  323. package/src/types/fees/FeeBreakdown.ts +11 -11
  324. package/src/types/fees/PercentagePPM.ts +26 -26
  325. package/src/types/lnurl/LNURLPay.ts +79 -79
  326. package/src/types/lnurl/LNURLWithdraw.ts +61 -61
  327. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -30
  328. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +21 -21
  329. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +9 -9
  330. package/src/utils/AutomaticClockDriftCorrection.ts +71 -71
  331. package/src/utils/BitcoinUtils.ts +132 -132
  332. package/src/utils/BitcoinWalletUtils.ts +15 -15
  333. package/src/utils/Logger.ts +14 -14
  334. package/src/utils/RetryUtils.ts +78 -78
  335. package/src/utils/SwapUtils.ts +99 -99
  336. package/src/utils/TimeoutUtils.ts +49 -49
  337. package/src/utils/TokenUtils.ts +33 -33
  338. package/src/utils/TypeUtils.ts +8 -8
  339. package/src/utils/Utils.ts +212 -212
@@ -1,862 +1,862 @@
1
- import {SwapType} from "../../../enums/SwapType";
2
- import {ChainType} from "@atomiqlabs/base";
3
- import {toBigInt} from "../../../utils/Utils";
4
- import {parsePsbtTransaction, toOutputScript} from "../../../utils/BitcoinUtils";
5
- import {isISwapInit, ISwap, ISwapInit} from "../../ISwap";
6
- import {AddressStatusResponseCodes, TrustedIntermediaryAPI} from "../../../intermediaries/apis/TrustedIntermediaryAPI";
7
- import {OnchainForGasSwapTypeDefinition, OnchainForGasWrapper} from "./OnchainForGasWrapper";
8
- import {Fee} from "../../../types/fees/Fee";
9
- import {IBitcoinWallet, isIBitcoinWallet} from "../../../bitcoin/wallet/IBitcoinWallet";
10
- import {IAddressSwap} from "../../IAddressSwap";
11
- import {IBTCWalletSwap} from "../../IBTCWalletSwap";
12
- import {Transaction} from "@scure/btc-signer";
13
- import {SingleAddressBitcoinWallet} from "../../../bitcoin/wallet/SingleAddressBitcoinWallet";
14
- import {Buffer} from "buffer";
15
- import {
16
- MinimalBitcoinWalletInterface,
17
- MinimalBitcoinWalletInterfaceWithSigner
18
- } from "../../../types/wallets/MinimalBitcoinWalletInterface";
19
- import {FeeType} from "../../../enums/FeeType";
20
- import {ppmToPercentage} from "../../../types/fees/PercentagePPM";
21
- import {TokenAmount, toTokenAmount} from "../../../types/TokenAmount";
22
- import {BitcoinTokens, BtcToken, SCToken} from "../../../types/Token";
23
- import {getLogger, LoggerType} from "../../../utils/Logger";
24
- import {timeoutPromise} from "../../../utils/TimeoutUtils";
25
- import {toBitcoinWallet} from "../../../utils/BitcoinWalletUtils";
26
- import {SwapExecutionAction, SwapExecutionActionBitcoin} from "../../../types/SwapExecutionAction";
27
-
28
- /**
29
- * State enum for trusted on-chain gas swaps
30
- *
31
- * @category Swaps/Trusted Gas Swaps
32
- */
33
- export enum OnchainForGasSwapState {
34
- /**
35
- * The swap quote expired without user sending in the BTC
36
- */
37
- EXPIRED = -3,
38
- /**
39
- * The swap has failed after the intermediary already received the BTC on the source chain
40
- */
41
- FAILED = -2,
42
- /**
43
- * Swap was refunded and BTC returned to the user's refund address
44
- */
45
- REFUNDED = -1,
46
- /**
47
- * Swap was created, send the BTC to the swap address
48
- */
49
- PR_CREATED = 0,
50
- /**
51
- * The swap is finished after the intermediary sent funds on the destination chain
52
- */
53
- FINISHED = 1,
54
- /**
55
- * Swap is refundable because the intermediary cannot honor the swap request on the destination chain
56
- */
57
- REFUNDABLE = 2
58
- }
59
-
60
- const OnchainForGasSwapStateDescription: Record<OnchainForGasSwapState, string> = {
61
- [OnchainForGasSwapState.EXPIRED]:
62
- "The swap quote expired without user sending in the BTC",
63
- [OnchainForGasSwapState.FAILED]:
64
- "The swap has failed after the intermediary already received the BTC on the source chain",
65
- [OnchainForGasSwapState.REFUNDED]:
66
- "Swap was refunded and BTC returned to the user's refund address",
67
- [OnchainForGasSwapState.PR_CREATED]:
68
- "Swap was created, send the BTC to the swap address",
69
- [OnchainForGasSwapState.FINISHED]:
70
- "The swap is finished after the intermediary sent funds on the destination chain",
71
- [OnchainForGasSwapState.REFUNDABLE]:
72
- "Swap is refundable because the intermediary cannot honor the swap request on the destination chain",
73
- };
74
-
75
- export type OnchainForGasSwapInit = ISwapInit & {
76
- paymentHash: string;
77
- sequence: bigint;
78
- address: string;
79
- inputAmount: bigint;
80
- outputAmount: bigint;
81
- recipient: string;
82
- token: string;
83
- refundAddress?: string;
84
- };
85
-
86
- export function isOnchainForGasSwapInit(obj: any): obj is OnchainForGasSwapInit {
87
- return typeof(obj.paymentHash)==="string" &&
88
- typeof(obj.sequence)==="bigint" &&
89
- typeof(obj.address)==="string" &&
90
- typeof(obj.inputAmount)==="bigint" &&
91
- typeof(obj.outputAmount)==="bigint" &&
92
- typeof(obj.recipient)==="string" &&
93
- typeof(obj.token)==="string" &&
94
- (obj.refundAddress==null || typeof(obj.refundAddress)==="string") &&
95
- isISwapInit(obj);
96
- }
97
-
98
- /**
99
- * Trusted swap for Bitcoin -> Smart chains, to be used for minor amounts to get gas tokens on the
100
- * destination chain, which is only needed for Solana, which still uses legacy swaps
101
- *
102
- * @category Swaps/Trusted Gas Swaps
103
- */
104
- export class OnchainForGasSwap<T extends ChainType = ChainType> extends ISwap<T, OnchainForGasSwapTypeDefinition<T>, OnchainForGasSwapState> implements IAddressSwap, IBTCWalletSwap {
105
- protected readonly TYPE: SwapType.TRUSTED_FROM_BTC = SwapType.TRUSTED_FROM_BTC;
106
-
107
- /**
108
- * @internal
109
- */
110
- protected readonly swapStateDescription = OnchainForGasSwapStateDescription;
111
- /**
112
- * @internal
113
- */
114
- protected readonly swapStateName = (state: number) => OnchainForGasSwapState[state];
115
-
116
- /**
117
- * @internal
118
- */
119
- protected readonly logger: LoggerType;
120
-
121
- //State: PR_CREATED
122
- private readonly paymentHash: string;
123
- private readonly sequence: bigint;
124
- private readonly address: string;
125
- private readonly recipient: string;
126
- private readonly token: string;
127
- private inputAmount: bigint;
128
- private outputAmount: bigint;
129
- private refundAddress?: string;
130
-
131
- //State: FINISHED
132
- /**
133
- * Destination transaction ID on the smart chain side
134
- * @private
135
- */
136
- private scTxId?: string;
137
- /**
138
- * Source transaction ID on the source (bitcoin) side
139
- * @private
140
- */
141
- private txId?: string;
142
-
143
- //State: REFUNDED
144
- /**
145
- * Transaction ID on the source (bitcoin) side used for refunding the funds back to the user
146
- * @private
147
- */
148
- private refundTxId?: string;
149
-
150
- /**
151
- * @internal
152
- */
153
- protected readonly wrapper: OnchainForGasWrapper<T>;
154
-
155
- constructor(wrapper: OnchainForGasWrapper<T>, init: OnchainForGasSwapInit);
156
- constructor(wrapper: OnchainForGasWrapper<T>, obj: any);
157
- constructor(
158
- wrapper: OnchainForGasWrapper<T>,
159
- initOrObj: OnchainForGasSwapInit | any
160
- ) {
161
- if(isOnchainForGasSwapInit(initOrObj) && initOrObj.url!=null) initOrObj.url += "/frombtc_trusted";
162
- super(wrapper, initOrObj);
163
- this.wrapper = wrapper;
164
- if(isOnchainForGasSwapInit(initOrObj)) {
165
- this.paymentHash = initOrObj.paymentHash;
166
- this.sequence = initOrObj.sequence;
167
- this.address = initOrObj.address;
168
- this.inputAmount = initOrObj.inputAmount;
169
- this.outputAmount = initOrObj.outputAmount;
170
- this.recipient = initOrObj.recipient;
171
- this.token = initOrObj.token;
172
- this.refundAddress = initOrObj.refundAddress;
173
- this._state = OnchainForGasSwapState.PR_CREATED;
174
- } else {
175
- this.paymentHash = initOrObj.paymentHash;
176
- this.sequence = toBigInt(initOrObj.sequence);
177
- this.address = initOrObj.address;
178
- this.inputAmount = toBigInt(initOrObj.inputAmount);
179
- this.outputAmount = toBigInt(initOrObj.outputAmount);
180
- this.recipient = initOrObj.recipient;
181
- this.token = initOrObj.token;
182
- this.refundAddress = initOrObj.refundAddress;
183
- this.scTxId = initOrObj.scTxId;
184
- this.txId = initOrObj.txId;
185
- this.refundTxId = initOrObj.refundTxId;
186
- }
187
- this.logger = getLogger("OnchainForGas("+this.getId()+"): ");
188
- this.tryRecomputeSwapPrice();
189
- }
190
-
191
- /**
192
- * @inheritDoc
193
- * @internal
194
- */
195
- protected upgradeVersion() {
196
- if(this.version == null) {
197
- //Noop
198
- this.version = 1;
199
- }
200
- }
201
-
202
- /**
203
- * @inheritDoc
204
- * @internal
205
- */
206
- protected tryRecomputeSwapPrice() {
207
- if(this.swapFeeBtc==null && this.swapFee!=null) {
208
- this.swapFeeBtc = this.swapFee * this.getInput().rawAmount / this.getOutAmountWithoutFee();
209
- }
210
- super.tryRecomputeSwapPrice();
211
- }
212
-
213
-
214
- //////////////////////////////
215
- //// Getters & utils
216
-
217
- /**
218
- * @inheritDoc
219
- * @internal
220
- */
221
- _getEscrowHash(): string {
222
- return this.paymentHash;
223
- }
224
-
225
- /**
226
- * @inheritDoc
227
- */
228
- getOutputAddress(): string | null {
229
- return this.recipient;
230
- }
231
-
232
- /**
233
- * @inheritDoc
234
- */
235
- getInputAddress(): string | null {
236
- //TODO: Fuck this, it's not used anyway
237
- return null;
238
- }
239
-
240
- /**
241
- * @inheritDoc
242
- */
243
- getInputTxId(): string | null {
244
- return this.txId ?? null;
245
- }
246
-
247
- /**
248
- * @inheritDoc
249
- */
250
- getOutputTxId(): string | null {
251
- return this.scTxId ?? null;
252
- }
253
-
254
- /**
255
- * @inheritDoc
256
- */
257
- getId(): string {
258
- return this.paymentHash;
259
- }
260
-
261
- /**
262
- * @inheritDoc
263
- */
264
- getAddress(): string {
265
- return this.address;
266
- }
267
-
268
- /**
269
- * @inheritDoc
270
- */
271
- getHyperlink(): string {
272
- return "bitcoin:"+this.address+"?amount="+encodeURIComponent((Number(this.inputAmount)/100000000).toString(10));
273
- }
274
-
275
- /**
276
- * @inheritDoc
277
- */
278
- requiresAction(): boolean {
279
- return this._state===OnchainForGasSwapState.REFUNDABLE;
280
- }
281
-
282
- /**
283
- * @inheritDoc
284
- */
285
- isFinished(): boolean {
286
- return this._state===OnchainForGasSwapState.FINISHED || this._state===OnchainForGasSwapState.FAILED || this._state===OnchainForGasSwapState.EXPIRED || this._state===OnchainForGasSwapState.REFUNDED;
287
- }
288
-
289
- /**
290
- * @inheritDoc
291
- */
292
- isQuoteExpired(): boolean {
293
- return this._state===OnchainForGasSwapState.EXPIRED;
294
- }
295
-
296
- /**
297
- * @inheritDoc
298
- */
299
- isQuoteSoftExpired(): boolean {
300
- return this.expiry<Date.now();
301
- }
302
-
303
- /**
304
- * @inheritDoc
305
- */
306
- isFailed(): boolean {
307
- return this._state===OnchainForGasSwapState.FAILED;
308
- }
309
-
310
- /**
311
- * @inheritDoc
312
- */
313
- isSuccessful(): boolean {
314
- return this._state===OnchainForGasSwapState.FINISHED;
315
- }
316
-
317
- /**
318
- * @inheritDoc
319
- */
320
- isInProgress(): boolean {
321
- return (this._state===OnchainForGasSwapState.PR_CREATED && this.txId!=null) ||
322
- (this._state===OnchainForGasSwapState.REFUNDABLE && this.refundAddress!=null);
323
- }
324
-
325
- /**
326
- * @inheritDoc
327
- * @internal
328
- */
329
- _verifyQuoteDefinitelyExpired(): Promise<boolean> {
330
- return Promise.resolve(this.expiry<Date.now());
331
- }
332
-
333
- /**
334
- * @inheritDoc
335
- * @internal
336
- */
337
- _verifyQuoteValid(): Promise<boolean> {
338
- return Promise.resolve(this.expiry>Date.now());
339
- }
340
-
341
-
342
- //////////////////////////////
343
- //// Amounts & fees
344
-
345
- /**
346
- * Returns an output amount in base units without a swap fee included, hence this value
347
- * is larger than the actual output amount
348
- *
349
- * @internal
350
- */
351
- protected getOutAmountWithoutFee(): bigint {
352
- return this.outputAmount + (this.swapFee ?? 0n);
353
- }
354
-
355
- /**
356
- * @inheritDoc
357
- */
358
- getOutputToken(): SCToken<T["ChainId"]> {
359
- return this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()];
360
- }
361
-
362
- /**
363
- * @inheritDoc
364
- */
365
- getOutput(): TokenAmount<SCToken<T["ChainId"]>, true> {
366
- return toTokenAmount(
367
- this.outputAmount, this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()],
368
- this.wrapper._prices, this.pricingInfo
369
- );
370
- }
371
-
372
- /**
373
- * @inheritDoc
374
- */
375
- getInputToken(): BtcToken<false> {
376
- return BitcoinTokens.BTC;
377
- }
378
-
379
- /**
380
- * @inheritDoc
381
- */
382
- getInput(): TokenAmount<BtcToken<false>, true> {
383
- return toTokenAmount(this.inputAmount, BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo);
384
- }
385
-
386
- /**
387
- * @inheritDoc
388
- */
389
- getInputWithoutFee(): TokenAmount<BtcToken<false>, true> {
390
- return toTokenAmount(
391
- this.inputAmount - (this.swapFeeBtc ?? 0n), BitcoinTokens.BTC,
392
- this.wrapper._prices, this.pricingInfo
393
- );
394
- }
395
-
396
- /**
397
- * Returns the swap fee charged by the intermediary (LP) on this swap
398
- *
399
- * @internal
400
- */
401
- protected getSwapFee(): Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>> {
402
- if(this.pricingInfo==null) throw new Error("No pricing info known!");
403
- const feeWithoutBaseFee = this.swapFeeBtc==null ? 0n : this.swapFeeBtc - this.pricingInfo.satsBaseFee;
404
- const swapFeePPM = feeWithoutBaseFee * 1000000n / this.getInputWithoutFee().rawAmount;
405
-
406
- const amountInSrcToken = toTokenAmount(
407
- this.swapFeeBtc ?? 0n, BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo
408
- );
409
- return {
410
- amountInSrcToken,
411
- amountInDstToken: toTokenAmount(
412
- this.swapFee ?? 0n, this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()],
413
- this.wrapper._prices, this.pricingInfo
414
- ),
415
- currentUsdValue: amountInSrcToken.currentUsdValue,
416
- usdValue: amountInSrcToken.usdValue,
417
- pastUsdValue: amountInSrcToken.pastUsdValue,
418
- composition: {
419
- base: toTokenAmount(this.pricingInfo.satsBaseFee, BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo),
420
- percentage: ppmToPercentage(swapFeePPM)
421
- }
422
- };
423
- }
424
-
425
- /**
426
- * @inheritDoc
427
- */
428
- getFee(): Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>> {
429
- return this.getSwapFee();
430
- }
431
-
432
- /**
433
- * @inheritDoc
434
- */
435
- getFeeBreakdown(): [{type: FeeType.SWAP, fee: Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>>}] {
436
- return [{
437
- type: FeeType.SWAP,
438
- fee: this.getSwapFee()
439
- }];
440
- }
441
-
442
- /**
443
- * @inheritDoc
444
- */
445
- getRequiredConfirmationsCount(): number {
446
- return 1;
447
- }
448
-
449
- /**
450
- * @inheritDoc
451
- */
452
- async getFundedPsbt(
453
- _bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface,
454
- feeRate?: number,
455
- additionalOutputs?: ({amount: bigint, outputScript: Uint8Array} | {amount: bigint, address: string})[]
456
- ): Promise<{psbt: Transaction, psbtHex: string, psbtBase64: string, signInputs: number[]}> {
457
- if(this._state!==OnchainForGasSwapState.PR_CREATED)
458
- throw new Error("Swap already paid for!");
459
-
460
- let bitcoinWallet: IBitcoinWallet;
461
- if(isIBitcoinWallet(_bitcoinWallet)) {
462
- bitcoinWallet = _bitcoinWallet;
463
- } else {
464
- bitcoinWallet = new SingleAddressBitcoinWallet(this.wrapper._btcRpc, this.wrapper._options.bitcoinNetwork, _bitcoinWallet);
465
- }
466
- //TODO: Maybe re-introduce fee rate check here if passed from the user
467
- if(feeRate==null) {
468
- feeRate = await bitcoinWallet.getFeeRate();
469
- }
470
-
471
- const basePsbt = new Transaction({
472
- allowUnknownOutputs: true,
473
- allowLegacyWitnessUtxo: true
474
- });
475
- basePsbt.addOutput({
476
- amount: this.outputAmount,
477
- script: toOutputScript(this.wrapper._options.bitcoinNetwork, this.address)
478
- });
479
- if(additionalOutputs!=null) additionalOutputs.forEach(output => {
480
- basePsbt.addOutput({
481
- amount: output.amount,
482
- script: (output as {outputScript: Uint8Array}).outputScript ?? toOutputScript(this.wrapper._options.bitcoinNetwork, (output as {address: string}).address)
483
- });
484
- });
485
-
486
- const psbt = await bitcoinWallet.fundPsbt(basePsbt, feeRate);
487
- //Sign every input
488
- const signInputs: number[] = [];
489
- for(let i=0;i<psbt.inputsLength;i++) {
490
- signInputs.push(i);
491
- }
492
- const serializedPsbt = Buffer.from(psbt.toPSBT());
493
- return {
494
- psbt,
495
- psbtHex: serializedPsbt.toString("hex"),
496
- psbtBase64: serializedPsbt.toString("base64"),
497
- signInputs
498
- };
499
- }
500
-
501
- /**
502
- * @inheritDoc
503
- */
504
- async submitPsbt(_psbt: Transaction | string): Promise<string> {
505
- const psbt = parsePsbtTransaction(_psbt);
506
- if(this._state!==OnchainForGasSwapState.PR_CREATED)
507
- throw new Error("Swap already paid for!");
508
-
509
- //Ensure not expired
510
- if(this.expiry<Date.now()) {
511
- throw new Error("Swap expired!");
512
- }
513
-
514
- const output0 = psbt.getOutput(0);
515
- if(output0.amount!==this.outputAmount)
516
- throw new Error("PSBT output amount invalid, expected: "+this.outputAmount+" got: "+output0.amount);
517
- const expectedOutputScript = toOutputScript(this.wrapper._options.bitcoinNetwork, this.address);
518
- if(output0.script==null || !expectedOutputScript.equals(output0.script))
519
- throw new Error("PSBT output script invalid!");
520
-
521
- if(!psbt.isFinal) psbt.finalize();
522
-
523
- return await this.wrapper._btcRpc.sendRawTransaction(Buffer.from(psbt.toBytes(true, true)).toString("hex"));
524
- }
525
-
526
- /**
527
- * @inheritDoc
528
- */
529
- async estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<BtcToken<false>, true> | null> {
530
- const bitcoinWallet: IBitcoinWallet = toBitcoinWallet(_bitcoinWallet, this.wrapper._btcRpc, this.wrapper._options.bitcoinNetwork);
531
- const txFee = await bitcoinWallet.getTransactionFee(this.address, this.inputAmount, feeRate);
532
- if(txFee==null) return null;
533
- return toTokenAmount(BigInt(txFee), BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo);
534
- }
535
-
536
- /**
537
- * @inheritDoc
538
- */
539
- async sendBitcoinTransaction(wallet: IBitcoinWallet | MinimalBitcoinWalletInterfaceWithSigner, feeRate?: number): Promise<string> {
540
- if(this._state!==OnchainForGasSwapState.PR_CREATED)
541
- throw new Error("Swap already paid for!");
542
-
543
- //Ensure not expired
544
- if(this.expiry<Date.now()) {
545
- throw new Error("Swap expired!");
546
- }
547
-
548
- if(isIBitcoinWallet(wallet)) {
549
- return await wallet.sendTransaction(this.address, this.inputAmount, feeRate);
550
- } else {
551
- const {psbt, psbtHex, psbtBase64, signInputs} = await this.getFundedPsbt(wallet, feeRate);
552
- const signedPsbt = await wallet.signPsbt({
553
- psbt, psbtHex, psbtBase64
554
- }, signInputs);
555
- return await this.submitPsbt(signedPsbt);
556
- }
557
- }
558
-
559
- /**
560
- * @inheritDoc
561
- *
562
- * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
563
- * if not provided an address is returned instead.
564
- */
565
- async txsExecute(options?: {
566
- bitcoinWallet?: MinimalBitcoinWalletInterface
567
- }): Promise<[
568
- SwapExecutionActionBitcoin<"ADDRESS" | "FUNDED_PSBT">
569
- ]> {
570
- if(this._state===OnchainForGasSwapState.PR_CREATED) {
571
- if(!await this._verifyQuoteValid()) throw new Error("Quote already expired or close to expiry!");
572
- return [
573
- {
574
- name: "Payment" as const,
575
- description: "Send funds to the bitcoin swap address",
576
- chain: "BITCOIN",
577
- txs: [
578
- options?.bitcoinWallet==null ? {
579
- address: this.address,
580
- amount: Number(this.inputAmount),
581
- hyperlink: this.getHyperlink(),
582
- type: "ADDRESS"
583
- } : {
584
- ...await this.getFundedPsbt(options.bitcoinWallet),
585
- type: "FUNDED_PSBT"
586
- }
587
- ]
588
- }
589
- ];
590
- }
591
-
592
- throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED or CLAIM_COMMITED");
593
- }
594
-
595
- /**
596
- * @remark Not supported
597
- */
598
- async execute(): Promise<boolean> {
599
- throw new Error("Not supported");
600
- }
601
-
602
- /**
603
- * @inheritDoc
604
- *
605
- * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
606
- * if not provided an address is returned instead.
607
- */
608
- async getCurrentActions(options?: {
609
- bitcoinWallet?: MinimalBitcoinWalletInterface
610
- }): Promise<SwapExecutionAction<T>[]> {
611
- try {
612
- return await this.txsExecute(options);
613
- } catch (e) {
614
- return [];
615
- }
616
- }
617
-
618
- //////////////////////////////
619
- //// Payment
620
-
621
- /**
622
- * Queries the intermediary (LP) node for the state of the swap
623
- *
624
- * @param save Whether the save the result or not
625
- *
626
- * @returns Whether the swap was successful as `boolean` or `null` if the swap is still pending
627
- * @internal
628
- */
629
- protected async checkAddress(save: boolean = true): Promise<boolean | null> {
630
- if(
631
- this._state===OnchainForGasSwapState.FAILED ||
632
- this._state===OnchainForGasSwapState.EXPIRED ||
633
- this._state===OnchainForGasSwapState.REFUNDED
634
- ) return false;
635
- if(this._state===OnchainForGasSwapState.FINISHED) return false;
636
- if(this.url==null) return false;
637
-
638
- const response = await TrustedIntermediaryAPI.getAddressStatus(
639
- this.url, this.paymentHash, this.sequence, this.wrapper._options.getRequestTimeout
640
- );
641
- switch(response.code) {
642
- case AddressStatusResponseCodes.AWAIT_PAYMENT:
643
- if(this.txId!=null) {
644
- this.txId = undefined;
645
- if(save) await this._save();
646
- return true;
647
- }
648
- return false;
649
- case AddressStatusResponseCodes.AWAIT_CONFIRMATION:
650
- case AddressStatusResponseCodes.PENDING:
651
- case AddressStatusResponseCodes.TX_SENT:
652
- const inputAmount = BigInt(response.data.adjustedAmount);
653
- const outputAmount = BigInt(response.data.adjustedTotal);
654
- const adjustedFee = response.data.adjustedFee==null ? null : BigInt(response.data.adjustedFee);
655
- const adjustedFeeSats = response.data.adjustedFeeSats==null ? null : BigInt(response.data.adjustedFeeSats);
656
- const txId = response.data.txId;
657
- if(
658
- this.txId!=txId ||
659
- this.inputAmount !== inputAmount ||
660
- this.outputAmount !== outputAmount
661
- ) {
662
- this.txId = txId;
663
- this.inputAmount = inputAmount;
664
- this.outputAmount = outputAmount;
665
- if(adjustedFee!=null) this.swapFee = adjustedFee;
666
- if(adjustedFeeSats!=null) this.swapFeeBtc = adjustedFeeSats;
667
- if(save) await this._save();
668
- return true;
669
- }
670
- return false;
671
- case AddressStatusResponseCodes.PAID:
672
- const txStatus = await this.wrapper._chain.getTxIdStatus(response.data.txId);
673
- if(txStatus==="success") {
674
- this._state = OnchainForGasSwapState.FINISHED;
675
- this.scTxId = response.data.txId;
676
- if(save) await this._saveAndEmit();
677
- return true;
678
- }
679
- return false;
680
- case AddressStatusResponseCodes.EXPIRED:
681
- this._state = OnchainForGasSwapState.EXPIRED;
682
- if(save) await this._saveAndEmit();
683
- return true;
684
- case AddressStatusResponseCodes.REFUNDABLE:
685
- if(this._state===OnchainForGasSwapState.REFUNDABLE) return null;
686
- this._state = OnchainForGasSwapState.REFUNDABLE;
687
- if(save) await this._saveAndEmit();
688
- return true;
689
- case AddressStatusResponseCodes.REFUNDED:
690
- this._state = OnchainForGasSwapState.REFUNDED;
691
- this.refundTxId = response.data.txId;
692
- if(save) await this._saveAndEmit();
693
- return true;
694
- default:
695
- this._state = OnchainForGasSwapState.FAILED;
696
- if(save) await this._saveAndEmit();
697
- return true;
698
- }
699
- }
700
-
701
- /**
702
- * Sets the bitcoin address used for possible refunds in case something goes wrong with the swap
703
- *
704
- * @param refundAddress Bitcoin address to receive the refund to
705
- * @internal
706
- */
707
- protected async setRefundAddress(refundAddress: string): Promise<void> {
708
- if(this.refundAddress!=null) {
709
- if(this.refundAddress!==refundAddress) throw new Error("Different refund address already set!");
710
- return;
711
- }
712
- if(this.url==null) throw new Error("LP URL not known, cannot set refund address!");
713
- await TrustedIntermediaryAPI.setRefundAddress(
714
- this.url, this.paymentHash, this.sequence, refundAddress, this.wrapper._options.getRequestTimeout
715
- );
716
- this.refundAddress = refundAddress;
717
- }
718
-
719
- /**
720
- * @inheritDoc
721
- */
722
- async waitForBitcoinTransaction(
723
- updateCallback?: (txId?: string, confirmations?: number, targetConfirmations?: number, txEtaMs?: number) => void,
724
- checkIntervalSeconds: number = 5,
725
- abortSignal?: AbortSignal
726
- ): Promise<string> {
727
- if(this._state!==OnchainForGasSwapState.PR_CREATED) throw new Error("Must be in PR_CREATED state!");
728
-
729
- if(!this.initiated) {
730
- this.initiated = true;
731
- await this._saveAndEmit();
732
- }
733
-
734
- while(
735
- !abortSignal?.aborted &&
736
- this._state===OnchainForGasSwapState.PR_CREATED
737
- ) {
738
- await this.checkAddress(true);
739
- if(this.txId!=null && updateCallback!=null) {
740
- const res = await this.wrapper._btcRpc.getTransaction(this.txId);
741
- if(res==null) {
742
- updateCallback();
743
- } else if(res.confirmations!=null && res.confirmations>0) {
744
- updateCallback(res.txid, res.confirmations, 1, 0);
745
- } else {
746
- const delay = await this.wrapper._btcRpc.getConfirmationDelay(res, 1);
747
- updateCallback(res.txid, 0, 1, delay ?? undefined);
748
- }
749
- }
750
- if(this._state===OnchainForGasSwapState.PR_CREATED)
751
- await timeoutPromise(checkIntervalSeconds*1000, abortSignal);
752
- }
753
-
754
- if(
755
- (this._state as OnchainForGasSwapState)===OnchainForGasSwapState.REFUNDABLE ||
756
- (this._state as OnchainForGasSwapState)===OnchainForGasSwapState.REFUNDED
757
- ) return this.txId!;
758
- if(this.isQuoteExpired()) throw new Error("Swap expired");
759
- if(this.isFailed()) throw new Error("Swap failed");
760
- return this.txId!;
761
- }
762
-
763
- /**
764
- * Waits till the LP processes a refund for a failed swap. The swap must be in
765
- * {@link OnchainForGasSwapState.REFUNDABLE} state
766
- *
767
- * @param checkIntervalSeconds How often to check (default 5 seconds)
768
- * @param abortSignal Abort signal
769
- */
770
- async waitTillRefunded(
771
- checkIntervalSeconds?: number,
772
- abortSignal?: AbortSignal
773
- ): Promise<void> {
774
- checkIntervalSeconds ??= 5;
775
- if(this._state===OnchainForGasSwapState.REFUNDED) return;
776
- if(this._state!==OnchainForGasSwapState.REFUNDABLE) throw new Error("Must be in REFUNDABLE state!");
777
-
778
- while(
779
- !abortSignal?.aborted &&
780
- this._state===OnchainForGasSwapState.REFUNDABLE
781
- ) {
782
- await this.checkAddress(true);
783
- if(this._state===OnchainForGasSwapState.REFUNDABLE)
784
- await timeoutPromise(checkIntervalSeconds*1000, abortSignal);
785
- }
786
- if(this.isQuoteExpired()) throw new Error("Swap expired");
787
- if(this.isFailed()) throw new Error("Swap failed");
788
- }
789
-
790
- /**
791
- * Requests a refund after the swap failed, this also waits till the refund is actually sent by the
792
- * intermediary (LP). The swap must be in {@link OnchainForGasSwapState.REFUNDABLE} state
793
- *
794
- * @param refundAddress Bitcoin address to receive the refund to
795
- * @param abortSignal Abort signal
796
- */
797
- async requestRefund(refundAddress?: string, abortSignal?: AbortSignal): Promise<void> {
798
- if(refundAddress!=null) await this.setRefundAddress(refundAddress);
799
- await this.waitTillRefunded(undefined, abortSignal);
800
- }
801
-
802
-
803
- //////////////////////////////
804
- //// Storage
805
-
806
- /**
807
- * @inheritDoc
808
- */
809
- serialize(): any{
810
- return {
811
- ...super.serialize(),
812
- paymentHash: this.paymentHash,
813
- sequence: this.sequence==null ? null : this.sequence.toString(10),
814
- address: this.address,
815
- inputAmount: this.inputAmount==null ? null : this.inputAmount.toString(10),
816
- outputAmount: this.outputAmount==null ? null : this.outputAmount.toString(10),
817
- recipient: this.recipient,
818
- token: this.token,
819
- refundAddress: this.refundAddress,
820
- scTxId: this.scTxId,
821
- txId: this.txId,
822
- refundTxId: this.refundTxId,
823
- };
824
- }
825
-
826
- /**
827
- * @inheritDoc
828
- * @internal
829
- */
830
- _getInitiator(): string {
831
- return this.recipient;
832
- }
833
-
834
-
835
- //////////////////////////////
836
- //// Swap ticks & sync
837
-
838
- /**
839
- * @inheritDoc
840
- * @internal
841
- */
842
- async _sync(save?: boolean): Promise<boolean> {
843
- if(this._state===OnchainForGasSwapState.PR_CREATED) {
844
- //Check if it's maybe already paid
845
- const result = await this.checkAddress(false);
846
- if(result) {
847
- if(save) await this._saveAndEmit();
848
- return true;
849
- }
850
- }
851
- return false;
852
- }
853
-
854
- /**
855
- * @inheritDoc
856
- * @internal
857
- */
858
- _tick(save?: boolean): Promise<boolean> {
859
- return Promise.resolve(false);
860
- }
861
-
862
- }
1
+ import {SwapType} from "../../../enums/SwapType";
2
+ import {ChainType} from "@atomiqlabs/base";
3
+ import {toBigInt} from "../../../utils/Utils";
4
+ import {parsePsbtTransaction, toOutputScript} from "../../../utils/BitcoinUtils";
5
+ import {isISwapInit, ISwap, ISwapInit} from "../../ISwap";
6
+ import {AddressStatusResponseCodes, TrustedIntermediaryAPI} from "../../../intermediaries/apis/TrustedIntermediaryAPI";
7
+ import {OnchainForGasSwapTypeDefinition, OnchainForGasWrapper} from "./OnchainForGasWrapper";
8
+ import {Fee} from "../../../types/fees/Fee";
9
+ import {IBitcoinWallet, isIBitcoinWallet} from "../../../bitcoin/wallet/IBitcoinWallet";
10
+ import {IAddressSwap} from "../../IAddressSwap";
11
+ import {IBTCWalletSwap} from "../../IBTCWalletSwap";
12
+ import {Transaction} from "@scure/btc-signer";
13
+ import {SingleAddressBitcoinWallet} from "../../../bitcoin/wallet/SingleAddressBitcoinWallet";
14
+ import {Buffer} from "buffer";
15
+ import {
16
+ MinimalBitcoinWalletInterface,
17
+ MinimalBitcoinWalletInterfaceWithSigner
18
+ } from "../../../types/wallets/MinimalBitcoinWalletInterface";
19
+ import {FeeType} from "../../../enums/FeeType";
20
+ import {ppmToPercentage} from "../../../types/fees/PercentagePPM";
21
+ import {TokenAmount, toTokenAmount} from "../../../types/TokenAmount";
22
+ import {BitcoinTokens, BtcToken, SCToken} from "../../../types/Token";
23
+ import {getLogger, LoggerType} from "../../../utils/Logger";
24
+ import {timeoutPromise} from "../../../utils/TimeoutUtils";
25
+ import {toBitcoinWallet} from "../../../utils/BitcoinWalletUtils";
26
+ import {SwapExecutionAction, SwapExecutionActionBitcoin} from "../../../types/SwapExecutionAction";
27
+
28
+ /**
29
+ * State enum for trusted on-chain gas swaps
30
+ *
31
+ * @category Swaps/Trusted Gas Swaps
32
+ */
33
+ export enum OnchainForGasSwapState {
34
+ /**
35
+ * The swap quote expired without user sending in the BTC
36
+ */
37
+ EXPIRED = -3,
38
+ /**
39
+ * The swap has failed after the intermediary already received the BTC on the source chain
40
+ */
41
+ FAILED = -2,
42
+ /**
43
+ * Swap was refunded and BTC returned to the user's refund address
44
+ */
45
+ REFUNDED = -1,
46
+ /**
47
+ * Swap was created, send the BTC to the swap address
48
+ */
49
+ PR_CREATED = 0,
50
+ /**
51
+ * The swap is finished after the intermediary sent funds on the destination chain
52
+ */
53
+ FINISHED = 1,
54
+ /**
55
+ * Swap is refundable because the intermediary cannot honor the swap request on the destination chain
56
+ */
57
+ REFUNDABLE = 2
58
+ }
59
+
60
+ const OnchainForGasSwapStateDescription: Record<OnchainForGasSwapState, string> = {
61
+ [OnchainForGasSwapState.EXPIRED]:
62
+ "The swap quote expired without user sending in the BTC",
63
+ [OnchainForGasSwapState.FAILED]:
64
+ "The swap has failed after the intermediary already received the BTC on the source chain",
65
+ [OnchainForGasSwapState.REFUNDED]:
66
+ "Swap was refunded and BTC returned to the user's refund address",
67
+ [OnchainForGasSwapState.PR_CREATED]:
68
+ "Swap was created, send the BTC to the swap address",
69
+ [OnchainForGasSwapState.FINISHED]:
70
+ "The swap is finished after the intermediary sent funds on the destination chain",
71
+ [OnchainForGasSwapState.REFUNDABLE]:
72
+ "Swap is refundable because the intermediary cannot honor the swap request on the destination chain",
73
+ };
74
+
75
+ export type OnchainForGasSwapInit = ISwapInit & {
76
+ paymentHash: string;
77
+ sequence: bigint;
78
+ address: string;
79
+ inputAmount: bigint;
80
+ outputAmount: bigint;
81
+ recipient: string;
82
+ token: string;
83
+ refundAddress?: string;
84
+ };
85
+
86
+ export function isOnchainForGasSwapInit(obj: any): obj is OnchainForGasSwapInit {
87
+ return typeof(obj.paymentHash)==="string" &&
88
+ typeof(obj.sequence)==="bigint" &&
89
+ typeof(obj.address)==="string" &&
90
+ typeof(obj.inputAmount)==="bigint" &&
91
+ typeof(obj.outputAmount)==="bigint" &&
92
+ typeof(obj.recipient)==="string" &&
93
+ typeof(obj.token)==="string" &&
94
+ (obj.refundAddress==null || typeof(obj.refundAddress)==="string") &&
95
+ isISwapInit(obj);
96
+ }
97
+
98
+ /**
99
+ * Trusted swap for Bitcoin -> Smart chains, to be used for minor amounts to get gas tokens on the
100
+ * destination chain, which is only needed for Solana, which still uses legacy swaps
101
+ *
102
+ * @category Swaps/Trusted Gas Swaps
103
+ */
104
+ export class OnchainForGasSwap<T extends ChainType = ChainType> extends ISwap<T, OnchainForGasSwapTypeDefinition<T>, OnchainForGasSwapState> implements IAddressSwap, IBTCWalletSwap {
105
+ protected readonly TYPE: SwapType.TRUSTED_FROM_BTC = SwapType.TRUSTED_FROM_BTC;
106
+
107
+ /**
108
+ * @internal
109
+ */
110
+ protected readonly swapStateDescription = OnchainForGasSwapStateDescription;
111
+ /**
112
+ * @internal
113
+ */
114
+ protected readonly swapStateName = (state: number) => OnchainForGasSwapState[state];
115
+
116
+ /**
117
+ * @internal
118
+ */
119
+ protected readonly logger: LoggerType;
120
+
121
+ //State: PR_CREATED
122
+ private readonly paymentHash: string;
123
+ private readonly sequence: bigint;
124
+ private readonly address: string;
125
+ private readonly recipient: string;
126
+ private readonly token: string;
127
+ private inputAmount: bigint;
128
+ private outputAmount: bigint;
129
+ private refundAddress?: string;
130
+
131
+ //State: FINISHED
132
+ /**
133
+ * Destination transaction ID on the smart chain side
134
+ * @private
135
+ */
136
+ private scTxId?: string;
137
+ /**
138
+ * Source transaction ID on the source (bitcoin) side
139
+ * @private
140
+ */
141
+ private txId?: string;
142
+
143
+ //State: REFUNDED
144
+ /**
145
+ * Transaction ID on the source (bitcoin) side used for refunding the funds back to the user
146
+ * @private
147
+ */
148
+ private refundTxId?: string;
149
+
150
+ /**
151
+ * @internal
152
+ */
153
+ protected readonly wrapper: OnchainForGasWrapper<T>;
154
+
155
+ constructor(wrapper: OnchainForGasWrapper<T>, init: OnchainForGasSwapInit);
156
+ constructor(wrapper: OnchainForGasWrapper<T>, obj: any);
157
+ constructor(
158
+ wrapper: OnchainForGasWrapper<T>,
159
+ initOrObj: OnchainForGasSwapInit | any
160
+ ) {
161
+ if(isOnchainForGasSwapInit(initOrObj) && initOrObj.url!=null) initOrObj.url += "/frombtc_trusted";
162
+ super(wrapper, initOrObj);
163
+ this.wrapper = wrapper;
164
+ if(isOnchainForGasSwapInit(initOrObj)) {
165
+ this.paymentHash = initOrObj.paymentHash;
166
+ this.sequence = initOrObj.sequence;
167
+ this.address = initOrObj.address;
168
+ this.inputAmount = initOrObj.inputAmount;
169
+ this.outputAmount = initOrObj.outputAmount;
170
+ this.recipient = initOrObj.recipient;
171
+ this.token = initOrObj.token;
172
+ this.refundAddress = initOrObj.refundAddress;
173
+ this._state = OnchainForGasSwapState.PR_CREATED;
174
+ } else {
175
+ this.paymentHash = initOrObj.paymentHash;
176
+ this.sequence = toBigInt(initOrObj.sequence);
177
+ this.address = initOrObj.address;
178
+ this.inputAmount = toBigInt(initOrObj.inputAmount);
179
+ this.outputAmount = toBigInt(initOrObj.outputAmount);
180
+ this.recipient = initOrObj.recipient;
181
+ this.token = initOrObj.token;
182
+ this.refundAddress = initOrObj.refundAddress;
183
+ this.scTxId = initOrObj.scTxId;
184
+ this.txId = initOrObj.txId;
185
+ this.refundTxId = initOrObj.refundTxId;
186
+ }
187
+ this.logger = getLogger("OnchainForGas("+this.getId()+"): ");
188
+ this.tryRecomputeSwapPrice();
189
+ }
190
+
191
+ /**
192
+ * @inheritDoc
193
+ * @internal
194
+ */
195
+ protected upgradeVersion() {
196
+ if(this.version == null) {
197
+ //Noop
198
+ this.version = 1;
199
+ }
200
+ }
201
+
202
+ /**
203
+ * @inheritDoc
204
+ * @internal
205
+ */
206
+ protected tryRecomputeSwapPrice() {
207
+ if(this.swapFeeBtc==null && this.swapFee!=null) {
208
+ this.swapFeeBtc = this.swapFee * this.getInput().rawAmount / this.getOutAmountWithoutFee();
209
+ }
210
+ super.tryRecomputeSwapPrice();
211
+ }
212
+
213
+
214
+ //////////////////////////////
215
+ //// Getters & utils
216
+
217
+ /**
218
+ * @inheritDoc
219
+ * @internal
220
+ */
221
+ _getEscrowHash(): string {
222
+ return this.paymentHash;
223
+ }
224
+
225
+ /**
226
+ * @inheritDoc
227
+ */
228
+ getOutputAddress(): string | null {
229
+ return this.recipient;
230
+ }
231
+
232
+ /**
233
+ * @inheritDoc
234
+ */
235
+ getInputAddress(): string | null {
236
+ //TODO: Fuck this, it's not used anyway
237
+ return null;
238
+ }
239
+
240
+ /**
241
+ * @inheritDoc
242
+ */
243
+ getInputTxId(): string | null {
244
+ return this.txId ?? null;
245
+ }
246
+
247
+ /**
248
+ * @inheritDoc
249
+ */
250
+ getOutputTxId(): string | null {
251
+ return this.scTxId ?? null;
252
+ }
253
+
254
+ /**
255
+ * @inheritDoc
256
+ */
257
+ getId(): string {
258
+ return this.paymentHash;
259
+ }
260
+
261
+ /**
262
+ * @inheritDoc
263
+ */
264
+ getAddress(): string {
265
+ return this.address;
266
+ }
267
+
268
+ /**
269
+ * @inheritDoc
270
+ */
271
+ getHyperlink(): string {
272
+ return "bitcoin:"+this.address+"?amount="+encodeURIComponent((Number(this.inputAmount)/100000000).toString(10));
273
+ }
274
+
275
+ /**
276
+ * @inheritDoc
277
+ */
278
+ requiresAction(): boolean {
279
+ return this._state===OnchainForGasSwapState.REFUNDABLE;
280
+ }
281
+
282
+ /**
283
+ * @inheritDoc
284
+ */
285
+ isFinished(): boolean {
286
+ return this._state===OnchainForGasSwapState.FINISHED || this._state===OnchainForGasSwapState.FAILED || this._state===OnchainForGasSwapState.EXPIRED || this._state===OnchainForGasSwapState.REFUNDED;
287
+ }
288
+
289
+ /**
290
+ * @inheritDoc
291
+ */
292
+ isQuoteExpired(): boolean {
293
+ return this._state===OnchainForGasSwapState.EXPIRED;
294
+ }
295
+
296
+ /**
297
+ * @inheritDoc
298
+ */
299
+ isQuoteSoftExpired(): boolean {
300
+ return this.expiry<Date.now();
301
+ }
302
+
303
+ /**
304
+ * @inheritDoc
305
+ */
306
+ isFailed(): boolean {
307
+ return this._state===OnchainForGasSwapState.FAILED;
308
+ }
309
+
310
+ /**
311
+ * @inheritDoc
312
+ */
313
+ isSuccessful(): boolean {
314
+ return this._state===OnchainForGasSwapState.FINISHED;
315
+ }
316
+
317
+ /**
318
+ * @inheritDoc
319
+ */
320
+ isInProgress(): boolean {
321
+ return (this._state===OnchainForGasSwapState.PR_CREATED && this.txId!=null) ||
322
+ (this._state===OnchainForGasSwapState.REFUNDABLE && this.refundAddress!=null);
323
+ }
324
+
325
+ /**
326
+ * @inheritDoc
327
+ * @internal
328
+ */
329
+ _verifyQuoteDefinitelyExpired(): Promise<boolean> {
330
+ return Promise.resolve(this.expiry<Date.now());
331
+ }
332
+
333
+ /**
334
+ * @inheritDoc
335
+ * @internal
336
+ */
337
+ _verifyQuoteValid(): Promise<boolean> {
338
+ return Promise.resolve(this.expiry>Date.now());
339
+ }
340
+
341
+
342
+ //////////////////////////////
343
+ //// Amounts & fees
344
+
345
+ /**
346
+ * Returns an output amount in base units without a swap fee included, hence this value
347
+ * is larger than the actual output amount
348
+ *
349
+ * @internal
350
+ */
351
+ protected getOutAmountWithoutFee(): bigint {
352
+ return this.outputAmount + (this.swapFee ?? 0n);
353
+ }
354
+
355
+ /**
356
+ * @inheritDoc
357
+ */
358
+ getOutputToken(): SCToken<T["ChainId"]> {
359
+ return this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()];
360
+ }
361
+
362
+ /**
363
+ * @inheritDoc
364
+ */
365
+ getOutput(): TokenAmount<SCToken<T["ChainId"]>, true> {
366
+ return toTokenAmount(
367
+ this.outputAmount, this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()],
368
+ this.wrapper._prices, this.pricingInfo
369
+ );
370
+ }
371
+
372
+ /**
373
+ * @inheritDoc
374
+ */
375
+ getInputToken(): BtcToken<false> {
376
+ return BitcoinTokens.BTC;
377
+ }
378
+
379
+ /**
380
+ * @inheritDoc
381
+ */
382
+ getInput(): TokenAmount<BtcToken<false>, true> {
383
+ return toTokenAmount(this.inputAmount, BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo);
384
+ }
385
+
386
+ /**
387
+ * @inheritDoc
388
+ */
389
+ getInputWithoutFee(): TokenAmount<BtcToken<false>, true> {
390
+ return toTokenAmount(
391
+ this.inputAmount - (this.swapFeeBtc ?? 0n), BitcoinTokens.BTC,
392
+ this.wrapper._prices, this.pricingInfo
393
+ );
394
+ }
395
+
396
+ /**
397
+ * Returns the swap fee charged by the intermediary (LP) on this swap
398
+ *
399
+ * @internal
400
+ */
401
+ protected getSwapFee(): Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>> {
402
+ if(this.pricingInfo==null) throw new Error("No pricing info known!");
403
+ const feeWithoutBaseFee = this.swapFeeBtc==null ? 0n : this.swapFeeBtc - this.pricingInfo.satsBaseFee;
404
+ const swapFeePPM = feeWithoutBaseFee * 1000000n / this.getInputWithoutFee().rawAmount;
405
+
406
+ const amountInSrcToken = toTokenAmount(
407
+ this.swapFeeBtc ?? 0n, BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo
408
+ );
409
+ return {
410
+ amountInSrcToken,
411
+ amountInDstToken: toTokenAmount(
412
+ this.swapFee ?? 0n, this.wrapper._tokens[this.wrapper._chain.getNativeCurrencyAddress()],
413
+ this.wrapper._prices, this.pricingInfo
414
+ ),
415
+ currentUsdValue: amountInSrcToken.currentUsdValue,
416
+ usdValue: amountInSrcToken.usdValue,
417
+ pastUsdValue: amountInSrcToken.pastUsdValue,
418
+ composition: {
419
+ base: toTokenAmount(this.pricingInfo.satsBaseFee, BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo),
420
+ percentage: ppmToPercentage(swapFeePPM)
421
+ }
422
+ };
423
+ }
424
+
425
+ /**
426
+ * @inheritDoc
427
+ */
428
+ getFee(): Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>> {
429
+ return this.getSwapFee();
430
+ }
431
+
432
+ /**
433
+ * @inheritDoc
434
+ */
435
+ getFeeBreakdown(): [{type: FeeType.SWAP, fee: Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>>}] {
436
+ return [{
437
+ type: FeeType.SWAP,
438
+ fee: this.getSwapFee()
439
+ }];
440
+ }
441
+
442
+ /**
443
+ * @inheritDoc
444
+ */
445
+ getRequiredConfirmationsCount(): number {
446
+ return 1;
447
+ }
448
+
449
+ /**
450
+ * @inheritDoc
451
+ */
452
+ async getFundedPsbt(
453
+ _bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface,
454
+ feeRate?: number,
455
+ additionalOutputs?: ({amount: bigint, outputScript: Uint8Array} | {amount: bigint, address: string})[]
456
+ ): Promise<{psbt: Transaction, psbtHex: string, psbtBase64: string, signInputs: number[]}> {
457
+ if(this._state!==OnchainForGasSwapState.PR_CREATED)
458
+ throw new Error("Swap already paid for!");
459
+
460
+ let bitcoinWallet: IBitcoinWallet;
461
+ if(isIBitcoinWallet(_bitcoinWallet)) {
462
+ bitcoinWallet = _bitcoinWallet;
463
+ } else {
464
+ bitcoinWallet = new SingleAddressBitcoinWallet(this.wrapper._btcRpc, this.wrapper._options.bitcoinNetwork, _bitcoinWallet);
465
+ }
466
+ //TODO: Maybe re-introduce fee rate check here if passed from the user
467
+ if(feeRate==null) {
468
+ feeRate = await bitcoinWallet.getFeeRate();
469
+ }
470
+
471
+ const basePsbt = new Transaction({
472
+ allowUnknownOutputs: true,
473
+ allowLegacyWitnessUtxo: true
474
+ });
475
+ basePsbt.addOutput({
476
+ amount: this.outputAmount,
477
+ script: toOutputScript(this.wrapper._options.bitcoinNetwork, this.address)
478
+ });
479
+ if(additionalOutputs!=null) additionalOutputs.forEach(output => {
480
+ basePsbt.addOutput({
481
+ amount: output.amount,
482
+ script: (output as {outputScript: Uint8Array}).outputScript ?? toOutputScript(this.wrapper._options.bitcoinNetwork, (output as {address: string}).address)
483
+ });
484
+ });
485
+
486
+ const psbt = await bitcoinWallet.fundPsbt(basePsbt, feeRate);
487
+ //Sign every input
488
+ const signInputs: number[] = [];
489
+ for(let i=0;i<psbt.inputsLength;i++) {
490
+ signInputs.push(i);
491
+ }
492
+ const serializedPsbt = Buffer.from(psbt.toPSBT());
493
+ return {
494
+ psbt,
495
+ psbtHex: serializedPsbt.toString("hex"),
496
+ psbtBase64: serializedPsbt.toString("base64"),
497
+ signInputs
498
+ };
499
+ }
500
+
501
+ /**
502
+ * @inheritDoc
503
+ */
504
+ async submitPsbt(_psbt: Transaction | string): Promise<string> {
505
+ const psbt = parsePsbtTransaction(_psbt);
506
+ if(this._state!==OnchainForGasSwapState.PR_CREATED)
507
+ throw new Error("Swap already paid for!");
508
+
509
+ //Ensure not expired
510
+ if(this.expiry<Date.now()) {
511
+ throw new Error("Swap expired!");
512
+ }
513
+
514
+ const output0 = psbt.getOutput(0);
515
+ if(output0.amount!==this.outputAmount)
516
+ throw new Error("PSBT output amount invalid, expected: "+this.outputAmount+" got: "+output0.amount);
517
+ const expectedOutputScript = toOutputScript(this.wrapper._options.bitcoinNetwork, this.address);
518
+ if(output0.script==null || !expectedOutputScript.equals(output0.script))
519
+ throw new Error("PSBT output script invalid!");
520
+
521
+ if(!psbt.isFinal) psbt.finalize();
522
+
523
+ return await this.wrapper._btcRpc.sendRawTransaction(Buffer.from(psbt.toBytes(true, true)).toString("hex"));
524
+ }
525
+
526
+ /**
527
+ * @inheritDoc
528
+ */
529
+ async estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<BtcToken<false>, true> | null> {
530
+ const bitcoinWallet: IBitcoinWallet = toBitcoinWallet(_bitcoinWallet, this.wrapper._btcRpc, this.wrapper._options.bitcoinNetwork);
531
+ const txFee = await bitcoinWallet.getTransactionFee(this.address, this.inputAmount, feeRate);
532
+ if(txFee==null) return null;
533
+ return toTokenAmount(BigInt(txFee), BitcoinTokens.BTC, this.wrapper._prices, this.pricingInfo);
534
+ }
535
+
536
+ /**
537
+ * @inheritDoc
538
+ */
539
+ async sendBitcoinTransaction(wallet: IBitcoinWallet | MinimalBitcoinWalletInterfaceWithSigner, feeRate?: number): Promise<string> {
540
+ if(this._state!==OnchainForGasSwapState.PR_CREATED)
541
+ throw new Error("Swap already paid for!");
542
+
543
+ //Ensure not expired
544
+ if(this.expiry<Date.now()) {
545
+ throw new Error("Swap expired!");
546
+ }
547
+
548
+ if(isIBitcoinWallet(wallet)) {
549
+ return await wallet.sendTransaction(this.address, this.inputAmount, feeRate);
550
+ } else {
551
+ const {psbt, psbtHex, psbtBase64, signInputs} = await this.getFundedPsbt(wallet, feeRate);
552
+ const signedPsbt = await wallet.signPsbt({
553
+ psbt, psbtHex, psbtBase64
554
+ }, signInputs);
555
+ return await this.submitPsbt(signedPsbt);
556
+ }
557
+ }
558
+
559
+ /**
560
+ * @inheritDoc
561
+ *
562
+ * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
563
+ * if not provided an address is returned instead.
564
+ */
565
+ async txsExecute(options?: {
566
+ bitcoinWallet?: MinimalBitcoinWalletInterface
567
+ }): Promise<[
568
+ SwapExecutionActionBitcoin<"ADDRESS" | "FUNDED_PSBT">
569
+ ]> {
570
+ if(this._state===OnchainForGasSwapState.PR_CREATED) {
571
+ if(!await this._verifyQuoteValid()) throw new Error("Quote already expired or close to expiry!");
572
+ return [
573
+ {
574
+ name: "Payment" as const,
575
+ description: "Send funds to the bitcoin swap address",
576
+ chain: "BITCOIN",
577
+ txs: [
578
+ options?.bitcoinWallet==null ? {
579
+ address: this.address,
580
+ amount: Number(this.inputAmount),
581
+ hyperlink: this.getHyperlink(),
582
+ type: "ADDRESS"
583
+ } : {
584
+ ...await this.getFundedPsbt(options.bitcoinWallet),
585
+ type: "FUNDED_PSBT"
586
+ }
587
+ ]
588
+ }
589
+ ];
590
+ }
591
+
592
+ throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED or CLAIM_COMMITED");
593
+ }
594
+
595
+ /**
596
+ * @remark Not supported
597
+ */
598
+ async execute(): Promise<boolean> {
599
+ throw new Error("Not supported");
600
+ }
601
+
602
+ /**
603
+ * @inheritDoc
604
+ *
605
+ * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
606
+ * if not provided an address is returned instead.
607
+ */
608
+ async getCurrentActions(options?: {
609
+ bitcoinWallet?: MinimalBitcoinWalletInterface
610
+ }): Promise<SwapExecutionAction<T>[]> {
611
+ try {
612
+ return await this.txsExecute(options);
613
+ } catch (e) {
614
+ return [];
615
+ }
616
+ }
617
+
618
+ //////////////////////////////
619
+ //// Payment
620
+
621
+ /**
622
+ * Queries the intermediary (LP) node for the state of the swap
623
+ *
624
+ * @param save Whether the save the result or not
625
+ *
626
+ * @returns Whether the swap was successful as `boolean` or `null` if the swap is still pending
627
+ * @internal
628
+ */
629
+ protected async checkAddress(save: boolean = true): Promise<boolean | null> {
630
+ if(
631
+ this._state===OnchainForGasSwapState.FAILED ||
632
+ this._state===OnchainForGasSwapState.EXPIRED ||
633
+ this._state===OnchainForGasSwapState.REFUNDED
634
+ ) return false;
635
+ if(this._state===OnchainForGasSwapState.FINISHED) return false;
636
+ if(this.url==null) return false;
637
+
638
+ const response = await TrustedIntermediaryAPI.getAddressStatus(
639
+ this.url, this.paymentHash, this.sequence, this.wrapper._options.getRequestTimeout
640
+ );
641
+ switch(response.code) {
642
+ case AddressStatusResponseCodes.AWAIT_PAYMENT:
643
+ if(this.txId!=null) {
644
+ this.txId = undefined;
645
+ if(save) await this._save();
646
+ return true;
647
+ }
648
+ return false;
649
+ case AddressStatusResponseCodes.AWAIT_CONFIRMATION:
650
+ case AddressStatusResponseCodes.PENDING:
651
+ case AddressStatusResponseCodes.TX_SENT:
652
+ const inputAmount = BigInt(response.data.adjustedAmount);
653
+ const outputAmount = BigInt(response.data.adjustedTotal);
654
+ const adjustedFee = response.data.adjustedFee==null ? null : BigInt(response.data.adjustedFee);
655
+ const adjustedFeeSats = response.data.adjustedFeeSats==null ? null : BigInt(response.data.adjustedFeeSats);
656
+ const txId = response.data.txId;
657
+ if(
658
+ this.txId!=txId ||
659
+ this.inputAmount !== inputAmount ||
660
+ this.outputAmount !== outputAmount
661
+ ) {
662
+ this.txId = txId;
663
+ this.inputAmount = inputAmount;
664
+ this.outputAmount = outputAmount;
665
+ if(adjustedFee!=null) this.swapFee = adjustedFee;
666
+ if(adjustedFeeSats!=null) this.swapFeeBtc = adjustedFeeSats;
667
+ if(save) await this._save();
668
+ return true;
669
+ }
670
+ return false;
671
+ case AddressStatusResponseCodes.PAID:
672
+ const txStatus = await this.wrapper._chain.getTxIdStatus(response.data.txId);
673
+ if(txStatus==="success") {
674
+ this._state = OnchainForGasSwapState.FINISHED;
675
+ this.scTxId = response.data.txId;
676
+ if(save) await this._saveAndEmit();
677
+ return true;
678
+ }
679
+ return false;
680
+ case AddressStatusResponseCodes.EXPIRED:
681
+ this._state = OnchainForGasSwapState.EXPIRED;
682
+ if(save) await this._saveAndEmit();
683
+ return true;
684
+ case AddressStatusResponseCodes.REFUNDABLE:
685
+ if(this._state===OnchainForGasSwapState.REFUNDABLE) return null;
686
+ this._state = OnchainForGasSwapState.REFUNDABLE;
687
+ if(save) await this._saveAndEmit();
688
+ return true;
689
+ case AddressStatusResponseCodes.REFUNDED:
690
+ this._state = OnchainForGasSwapState.REFUNDED;
691
+ this.refundTxId = response.data.txId;
692
+ if(save) await this._saveAndEmit();
693
+ return true;
694
+ default:
695
+ this._state = OnchainForGasSwapState.FAILED;
696
+ if(save) await this._saveAndEmit();
697
+ return true;
698
+ }
699
+ }
700
+
701
+ /**
702
+ * Sets the bitcoin address used for possible refunds in case something goes wrong with the swap
703
+ *
704
+ * @param refundAddress Bitcoin address to receive the refund to
705
+ * @internal
706
+ */
707
+ protected async setRefundAddress(refundAddress: string): Promise<void> {
708
+ if(this.refundAddress!=null) {
709
+ if(this.refundAddress!==refundAddress) throw new Error("Different refund address already set!");
710
+ return;
711
+ }
712
+ if(this.url==null) throw new Error("LP URL not known, cannot set refund address!");
713
+ await TrustedIntermediaryAPI.setRefundAddress(
714
+ this.url, this.paymentHash, this.sequence, refundAddress, this.wrapper._options.getRequestTimeout
715
+ );
716
+ this.refundAddress = refundAddress;
717
+ }
718
+
719
+ /**
720
+ * @inheritDoc
721
+ */
722
+ async waitForBitcoinTransaction(
723
+ updateCallback?: (txId?: string, confirmations?: number, targetConfirmations?: number, txEtaMs?: number) => void,
724
+ checkIntervalSeconds: number = 5,
725
+ abortSignal?: AbortSignal
726
+ ): Promise<string> {
727
+ if(this._state!==OnchainForGasSwapState.PR_CREATED) throw new Error("Must be in PR_CREATED state!");
728
+
729
+ if(!this.initiated) {
730
+ this.initiated = true;
731
+ await this._saveAndEmit();
732
+ }
733
+
734
+ while(
735
+ !abortSignal?.aborted &&
736
+ this._state===OnchainForGasSwapState.PR_CREATED
737
+ ) {
738
+ await this.checkAddress(true);
739
+ if(this.txId!=null && updateCallback!=null) {
740
+ const res = await this.wrapper._btcRpc.getTransaction(this.txId);
741
+ if(res==null) {
742
+ updateCallback();
743
+ } else if(res.confirmations!=null && res.confirmations>0) {
744
+ updateCallback(res.txid, res.confirmations, 1, 0);
745
+ } else {
746
+ const delay = await this.wrapper._btcRpc.getConfirmationDelay(res, 1);
747
+ updateCallback(res.txid, 0, 1, delay ?? undefined);
748
+ }
749
+ }
750
+ if(this._state===OnchainForGasSwapState.PR_CREATED)
751
+ await timeoutPromise(checkIntervalSeconds*1000, abortSignal);
752
+ }
753
+
754
+ if(
755
+ (this._state as OnchainForGasSwapState)===OnchainForGasSwapState.REFUNDABLE ||
756
+ (this._state as OnchainForGasSwapState)===OnchainForGasSwapState.REFUNDED
757
+ ) return this.txId!;
758
+ if(this.isQuoteExpired()) throw new Error("Swap expired");
759
+ if(this.isFailed()) throw new Error("Swap failed");
760
+ return this.txId!;
761
+ }
762
+
763
+ /**
764
+ * Waits till the LP processes a refund for a failed swap. The swap must be in
765
+ * {@link OnchainForGasSwapState.REFUNDABLE} state
766
+ *
767
+ * @param checkIntervalSeconds How often to check (default 5 seconds)
768
+ * @param abortSignal Abort signal
769
+ */
770
+ async waitTillRefunded(
771
+ checkIntervalSeconds?: number,
772
+ abortSignal?: AbortSignal
773
+ ): Promise<void> {
774
+ checkIntervalSeconds ??= 5;
775
+ if(this._state===OnchainForGasSwapState.REFUNDED) return;
776
+ if(this._state!==OnchainForGasSwapState.REFUNDABLE) throw new Error("Must be in REFUNDABLE state!");
777
+
778
+ while(
779
+ !abortSignal?.aborted &&
780
+ this._state===OnchainForGasSwapState.REFUNDABLE
781
+ ) {
782
+ await this.checkAddress(true);
783
+ if(this._state===OnchainForGasSwapState.REFUNDABLE)
784
+ await timeoutPromise(checkIntervalSeconds*1000, abortSignal);
785
+ }
786
+ if(this.isQuoteExpired()) throw new Error("Swap expired");
787
+ if(this.isFailed()) throw new Error("Swap failed");
788
+ }
789
+
790
+ /**
791
+ * Requests a refund after the swap failed, this also waits till the refund is actually sent by the
792
+ * intermediary (LP). The swap must be in {@link OnchainForGasSwapState.REFUNDABLE} state
793
+ *
794
+ * @param refundAddress Bitcoin address to receive the refund to
795
+ * @param abortSignal Abort signal
796
+ */
797
+ async requestRefund(refundAddress?: string, abortSignal?: AbortSignal): Promise<void> {
798
+ if(refundAddress!=null) await this.setRefundAddress(refundAddress);
799
+ await this.waitTillRefunded(undefined, abortSignal);
800
+ }
801
+
802
+
803
+ //////////////////////////////
804
+ //// Storage
805
+
806
+ /**
807
+ * @inheritDoc
808
+ */
809
+ serialize(): any{
810
+ return {
811
+ ...super.serialize(),
812
+ paymentHash: this.paymentHash,
813
+ sequence: this.sequence==null ? null : this.sequence.toString(10),
814
+ address: this.address,
815
+ inputAmount: this.inputAmount==null ? null : this.inputAmount.toString(10),
816
+ outputAmount: this.outputAmount==null ? null : this.outputAmount.toString(10),
817
+ recipient: this.recipient,
818
+ token: this.token,
819
+ refundAddress: this.refundAddress,
820
+ scTxId: this.scTxId,
821
+ txId: this.txId,
822
+ refundTxId: this.refundTxId,
823
+ };
824
+ }
825
+
826
+ /**
827
+ * @inheritDoc
828
+ * @internal
829
+ */
830
+ _getInitiator(): string {
831
+ return this.recipient;
832
+ }
833
+
834
+
835
+ //////////////////////////////
836
+ //// Swap ticks & sync
837
+
838
+ /**
839
+ * @inheritDoc
840
+ * @internal
841
+ */
842
+ async _sync(save?: boolean): Promise<boolean> {
843
+ if(this._state===OnchainForGasSwapState.PR_CREATED) {
844
+ //Check if it's maybe already paid
845
+ const result = await this.checkAddress(false);
846
+ if(result) {
847
+ if(save) await this._saveAndEmit();
848
+ return true;
849
+ }
850
+ }
851
+ return false;
852
+ }
853
+
854
+ /**
855
+ * @inheritDoc
856
+ * @internal
857
+ */
858
+ _tick(save?: boolean): Promise<boolean> {
859
+ return Promise.resolve(false);
860
+ }
861
+
862
+ }