@atomiqlabs/sdk 8.1.8 → 8.3.5

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 (261) hide show
  1. package/dist/bitcoin/coinselect2/utils.d.ts +6 -0
  2. package/dist/bitcoin/wallet/BitcoinWallet.d.ts +41 -5
  3. package/dist/bitcoin/wallet/BitcoinWallet.js +36 -1
  4. package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +52 -2
  5. package/dist/bitcoin/wallet/IBitcoinWallet.js +2 -1
  6. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +42 -7
  7. package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +36 -1
  8. package/dist/enums/FeeType.d.ts +8 -1
  9. package/dist/enums/FeeType.js +8 -1
  10. package/dist/enums/SwapAmountType.d.ts +7 -0
  11. package/dist/enums/SwapAmountType.js +7 -0
  12. package/dist/enums/SwapDirection.d.ts +7 -0
  13. package/dist/enums/SwapDirection.js +7 -0
  14. package/dist/enums/SwapType.d.ts +62 -1
  15. package/dist/enums/SwapType.js +62 -1
  16. package/dist/errors/IntermediaryError.d.ts +4 -0
  17. package/dist/errors/IntermediaryError.js +1 -0
  18. package/dist/errors/RequestError.d.ts +15 -1
  19. package/dist/errors/RequestError.js +8 -0
  20. package/dist/errors/UserError.d.ts +1 -0
  21. package/dist/errors/UserError.js +1 -0
  22. package/dist/index.d.ts +5 -5
  23. package/dist/index.js +7 -6
  24. package/dist/intermediaries/Intermediary.d.ts +61 -14
  25. package/dist/intermediaries/Intermediary.js +38 -11
  26. package/dist/intermediaries/IntermediaryDiscovery.d.ts +62 -29
  27. package/dist/intermediaries/IntermediaryDiscovery.js +39 -24
  28. package/dist/prices/RedundantSwapPrice.d.ts +26 -5
  29. package/dist/prices/RedundantSwapPrice.js +22 -2
  30. package/dist/prices/SingleSwapPrice.d.ts +10 -7
  31. package/dist/prices/SingleSwapPrice.js +11 -8
  32. package/dist/prices/SwapPriceWithChain.d.ts +56 -19
  33. package/dist/prices/SwapPriceWithChain.js +62 -25
  34. package/dist/prices/abstract/IPriceProvider.d.ts +4 -4
  35. package/dist/prices/abstract/IPriceProvider.js +1 -1
  36. package/dist/prices/abstract/ISwapPrice.d.ts +95 -46
  37. package/dist/prices/abstract/ISwapPrice.js +104 -56
  38. package/dist/prices/providers/BinancePriceProvider.d.ts +8 -1
  39. package/dist/prices/providers/BinancePriceProvider.js +8 -1
  40. package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +7 -1
  41. package/dist/prices/providers/CoinGeckoPriceProvider.js +7 -1
  42. package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +7 -1
  43. package/dist/prices/providers/CoinPaprikaPriceProvider.js +7 -1
  44. package/dist/prices/providers/CustomPriceProvider.d.ts +12 -1
  45. package/dist/prices/providers/CustomPriceProvider.js +12 -1
  46. package/dist/prices/providers/KrakenPriceProvider.d.ts +10 -1
  47. package/dist/prices/providers/KrakenPriceProvider.js +10 -1
  48. package/dist/prices/providers/OKXPriceProvider.d.ts +7 -1
  49. package/dist/prices/providers/OKXPriceProvider.js +7 -1
  50. package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +3 -0
  51. package/dist/prices/providers/abstract/ExchangePriceProvider.js +3 -0
  52. package/dist/storage/IUnifiedStorage.d.ts +19 -7
  53. package/dist/storage/UnifiedSwapStorage.d.ts +33 -3
  54. package/dist/storage/UnifiedSwapStorage.js +29 -1
  55. package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +31 -7
  56. package/dist/storage-browser/IndexedDBUnifiedStorage.js +29 -6
  57. package/dist/storage-browser/LocalStorageManager.d.ts +25 -1
  58. package/dist/storage-browser/LocalStorageManager.js +25 -1
  59. package/dist/swapper/Swapper.d.ts +380 -226
  60. package/dist/swapper/Swapper.js +383 -349
  61. package/dist/swapper/SwapperFactory.d.ts +66 -18
  62. package/dist/swapper/SwapperFactory.js +24 -3
  63. package/dist/swapper/SwapperUtils.d.ts +75 -28
  64. package/dist/swapper/SwapperUtils.js +107 -60
  65. package/dist/swapper/SwapperWithChain.d.ts +286 -91
  66. package/dist/swapper/SwapperWithChain.js +218 -64
  67. package/dist/swapper/SwapperWithSigner.d.ts +229 -80
  68. package/dist/swapper/SwapperWithSigner.js +190 -44
  69. package/dist/swaps/IAddressSwap.d.ts +12 -3
  70. package/dist/swaps/IAddressSwap.js +3 -2
  71. package/dist/swaps/IBTCWalletSwap.d.ts +26 -8
  72. package/dist/swaps/IBTCWalletSwap.js +3 -2
  73. package/dist/swaps/IClaimableSwap.d.ts +38 -6
  74. package/dist/swaps/IClaimableSwap.js +3 -2
  75. package/dist/swaps/IClaimableSwapWrapper.d.ts +11 -1
  76. package/dist/swaps/IRefundableSwap.d.ts +31 -5
  77. package/dist/swaps/IRefundableSwap.js +3 -2
  78. package/dist/swaps/ISwap.d.ts +162 -24
  79. package/dist/swaps/ISwap.js +92 -35
  80. package/dist/swaps/ISwapWithGasDrop.d.ts +8 -2
  81. package/dist/swaps/ISwapWithGasDrop.js +2 -1
  82. package/dist/swaps/ISwapWrapper.d.ts +161 -52
  83. package/dist/swaps/ISwapWrapper.js +131 -73
  84. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +51 -6
  85. package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +22 -12
  86. package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +65 -12
  87. package/dist/swaps/escrow_swaps/IEscrowSwap.js +38 -19
  88. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +39 -9
  89. package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +30 -21
  90. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +31 -15
  91. package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +33 -18
  92. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +97 -28
  93. package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +91 -27
  94. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +22 -9
  95. package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +24 -11
  96. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +278 -60
  97. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +519 -241
  98. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +77 -26
  99. package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +132 -50
  100. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +313 -52
  101. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +544 -194
  102. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +87 -26
  103. package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +147 -58
  104. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +222 -55
  105. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +462 -244
  106. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +77 -23
  107. package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +116 -46
  108. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +195 -58
  109. package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +324 -191
  110. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +30 -5
  111. package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +44 -19
  112. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +61 -20
  113. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +75 -32
  114. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +76 -50
  115. package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +106 -101
  116. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +37 -14
  117. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +66 -20
  118. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +46 -17
  119. package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +82 -27
  120. package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +350 -88
  121. package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +482 -215
  122. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +76 -24
  123. package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +247 -124
  124. package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +148 -20
  125. package/dist/swaps/trusted/ln/LnForGasSwap.js +175 -45
  126. package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +29 -10
  127. package/dist/swaps/trusted/ln/LnForGasWrapper.js +30 -11
  128. package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +202 -49
  129. package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +232 -80
  130. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +34 -12
  131. package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +33 -14
  132. package/dist/types/AmountData.d.ts +2 -1
  133. package/dist/types/CustomPriceFunction.d.ts +8 -2
  134. package/dist/types/PriceInfoType.d.ts +4 -4
  135. package/dist/types/PriceInfoType.js +3 -3
  136. package/dist/types/SwapExecutionAction.d.ts +85 -4
  137. package/dist/types/SwapWithSigner.d.ts +5 -2
  138. package/dist/types/SwapWithSigner.js +5 -2
  139. package/dist/types/Token.d.ts +11 -5
  140. package/dist/types/Token.js +6 -3
  141. package/dist/types/TokenAmount.d.ts +3 -0
  142. package/dist/types/TokenAmount.js +2 -0
  143. package/dist/types/fees/Fee.d.ts +3 -2
  144. package/dist/types/fees/FeeBreakdown.d.ts +3 -2
  145. package/dist/types/fees/PercentagePPM.d.ts +4 -2
  146. package/dist/types/fees/PercentagePPM.js +2 -1
  147. package/dist/types/lnurl/LNURLPay.d.ts +20 -12
  148. package/dist/types/lnurl/LNURLPay.js +8 -4
  149. package/dist/types/lnurl/LNURLWithdraw.d.ts +17 -10
  150. package/dist/types/lnurl/LNURLWithdraw.js +8 -4
  151. package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -0
  152. package/dist/types/wallets/LightningInvoiceCreateService.js +15 -0
  153. package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +3 -1
  154. package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +4 -2
  155. package/dist/utils/BitcoinUtils.d.ts +1 -0
  156. package/dist/utils/BitcoinUtils.js +5 -1
  157. package/dist/utils/SwapUtils.d.ts +58 -1
  158. package/dist/utils/SwapUtils.js +55 -1
  159. package/dist/utils/TokenUtils.d.ts +10 -2
  160. package/dist/utils/TokenUtils.js +12 -4
  161. package/package.json +3 -3
  162. package/src/bitcoin/coinselect2/utils.ts +6 -0
  163. package/src/bitcoin/wallet/BitcoinWallet.ts +41 -5
  164. package/src/bitcoin/wallet/IBitcoinWallet.ts +57 -2
  165. package/src/bitcoin/wallet/SingleAddressBitcoinWallet.ts +42 -6
  166. package/src/enums/FeeType.ts +8 -1
  167. package/src/enums/SwapAmountType.ts +7 -0
  168. package/src/enums/SwapDirection.ts +7 -0
  169. package/src/enums/SwapType.ts +62 -2
  170. package/src/errors/IntermediaryError.ts +4 -0
  171. package/src/errors/RequestError.ts +15 -1
  172. package/src/errors/UserError.ts +1 -0
  173. package/src/index.ts +12 -5
  174. package/src/intermediaries/Intermediary.ts +61 -14
  175. package/src/intermediaries/IntermediaryDiscovery.ts +69 -34
  176. package/src/prices/RedundantSwapPrice.ts +26 -6
  177. package/src/prices/SingleSwapPrice.ts +11 -8
  178. package/src/prices/SwapPriceWithChain.ts +63 -26
  179. package/src/prices/abstract/IPriceProvider.ts +4 -4
  180. package/src/prices/abstract/ISwapPrice.ts +115 -66
  181. package/src/prices/providers/BinancePriceProvider.ts +8 -1
  182. package/src/prices/providers/CoinGeckoPriceProvider.ts +7 -1
  183. package/src/prices/providers/CoinPaprikaPriceProvider.ts +7 -1
  184. package/src/prices/providers/CustomPriceProvider.ts +12 -1
  185. package/src/prices/providers/KrakenPriceProvider.ts +10 -1
  186. package/src/prices/providers/OKXPriceProvider.ts +7 -1
  187. package/src/prices/providers/abstract/ExchangePriceProvider.ts +3 -0
  188. package/src/storage/IUnifiedStorage.ts +19 -7
  189. package/src/storage/UnifiedSwapStorage.ts +33 -3
  190. package/src/storage-browser/IndexedDBUnifiedStorage.ts +31 -8
  191. package/src/storage-browser/LocalStorageManager.ts +25 -1
  192. package/src/swapper/Swapper.ts +599 -390
  193. package/src/swapper/SwapperFactory.ts +73 -24
  194. package/src/swapper/SwapperUtils.ts +107 -60
  195. package/src/swapper/SwapperWithChain.ts +320 -81
  196. package/src/swapper/SwapperWithSigner.ts +263 -56
  197. package/src/swaps/IAddressSwap.ts +13 -3
  198. package/src/swaps/IBTCWalletSwap.ts +26 -10
  199. package/src/swaps/IClaimableSwap.ts +41 -6
  200. package/src/swaps/IClaimableSwapWrapper.ts +11 -2
  201. package/src/swaps/IRefundableSwap.ts +34 -5
  202. package/src/swaps/ISwap.ts +224 -85
  203. package/src/swaps/ISwapWithGasDrop.ts +8 -2
  204. package/src/swaps/ISwapWrapper.ts +216 -98
  205. package/src/swaps/escrow_swaps/IEscrowSelfInitSwap.ts +64 -18
  206. package/src/swaps/escrow_swaps/IEscrowSwap.ts +83 -37
  207. package/src/swaps/escrow_swaps/IEscrowSwapWrapper.ts +61 -30
  208. package/src/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.ts +37 -19
  209. package/src/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.ts +123 -50
  210. package/src/swaps/escrow_swaps/frombtc/IFromBTCWrapper.ts +24 -11
  211. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts +562 -258
  212. package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.ts +156 -62
  213. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts +592 -227
  214. package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts +177 -74
  215. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts +483 -245
  216. package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.ts +141 -59
  217. package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts +350 -195
  218. package/src/swaps/escrow_swaps/tobtc/IToBTCWrapper.ts +48 -23
  219. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.ts +87 -40
  220. package/src/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.ts +110 -110
  221. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.ts +89 -34
  222. package/src/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.ts +101 -31
  223. package/src/swaps/spv_swaps/SpvFromBTCSwap.ts +556 -259
  224. package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +292 -148
  225. package/src/swaps/trusted/ln/LnForGasSwap.ts +186 -47
  226. package/src/swaps/trusted/ln/LnForGasWrapper.ts +34 -15
  227. package/src/swaps/trusted/onchain/OnchainForGasSwap.ts +262 -88
  228. package/src/swaps/trusted/onchain/OnchainForGasWrapper.ts +41 -19
  229. package/src/types/AmountData.ts +2 -1
  230. package/src/types/CustomPriceFunction.ts +8 -2
  231. package/src/types/PriceInfoType.ts +4 -4
  232. package/src/types/SwapExecutionAction.ts +97 -5
  233. package/src/types/SwapWithSigner.ts +8 -4
  234. package/src/types/Token.ts +12 -5
  235. package/src/types/TokenAmount.ts +3 -0
  236. package/src/types/fees/Fee.ts +3 -2
  237. package/src/types/fees/FeeBreakdown.ts +3 -2
  238. package/src/types/fees/PercentagePPM.ts +4 -2
  239. package/src/types/lnurl/LNURLPay.ts +20 -12
  240. package/src/types/lnurl/LNURLWithdraw.ts +17 -10
  241. package/src/types/wallets/LightningInvoiceCreateService.ts +30 -0
  242. package/src/types/wallets/MinimalBitcoinWalletInterface.ts +3 -1
  243. package/src/types/wallets/MinimalLightningNetworkWalletInterface.ts +4 -2
  244. package/src/utils/BitcoinUtils.ts +5 -0
  245. package/src/utils/SwapUtils.ts +63 -1
  246. package/src/utils/TokenUtils.ts +12 -4
  247. package/dist/bitcoin/BitcoinRpcWithAddressIndex.d.ts +0 -68
  248. package/dist/bitcoin/BitcoinRpcWithAddressIndex.js +0 -2
  249. package/dist/bitcoin/LightningNetworkApi.d.ts +0 -12
  250. package/dist/bitcoin/LightningNetworkApi.js +0 -2
  251. package/dist/bitcoin/mempool/MempoolApi.d.ts +0 -350
  252. package/dist/bitcoin/mempool/MempoolApi.js +0 -311
  253. package/dist/bitcoin/mempool/MempoolBitcoinBlock.d.ts +0 -44
  254. package/dist/bitcoin/mempool/MempoolBitcoinBlock.js +0 -48
  255. package/dist/bitcoin/mempool/MempoolBitcoinRpc.d.ts +0 -119
  256. package/dist/bitcoin/mempool/MempoolBitcoinRpc.js +0 -361
  257. package/dist/bitcoin/mempool/synchronizer/MempoolBtcRelaySynchronizer.d.ts +0 -22
  258. package/dist/bitcoin/mempool/synchronizer/MempoolBtcRelaySynchronizer.js +0 -105
  259. package/dist/errors/PaymentAuthError.d.ts +0 -11
  260. package/dist/errors/PaymentAuthError.js +0 -23
  261. package/src/errors/PaymentAuthError.ts +0 -26
@@ -14,22 +14,73 @@ import { TokenAmount } from "../../types/TokenAmount";
14
14
  import { BtcToken, SCToken } from "../../types/Token";
15
15
  import { LoggerType } from "../../utils/Logger";
16
16
  import { PriceInfoType } from "../../types/PriceInfoType";
17
+ import { SwapExecutionActionBitcoin } from "../../types/SwapExecutionAction";
17
18
  /**
18
- * State enum for SPV FromBTC swaps
19
- * @category Swaps
19
+ * State enum for SPV vault (UTXO-controlled vault) based swaps
20
+ * @category Swaps/Bitcoin → Smart chain
20
21
  */
21
22
  export declare enum SpvFromBTCSwapState {
23
+ /**
24
+ * Catastrophic failure has occurred when processing the swap on the smart chain side,
25
+ * this implies a bug in the smart contract code or the user and intermediary deliberately
26
+ * creating a bitcoin transaction with invalid format unparsable by the smart contract.
27
+ */
22
28
  CLOSED = -5,
29
+ /**
30
+ * Some of the bitcoin swap transaction inputs were double-spent, this means the swap
31
+ * has failed and no BTC was sent
32
+ */
23
33
  FAILED = -4,
34
+ /**
35
+ * The intermediary (LP) declined to co-sign the submitted PSBT, hence the swap failed
36
+ */
24
37
  DECLINED = -3,
38
+ /**
39
+ * Swap has expired for good and there is no way how it can be executed anymore
40
+ */
25
41
  QUOTE_EXPIRED = -2,
42
+ /**
43
+ * A swap is almost expired, and it should be presented to the user as expired, though
44
+ * there is still a chance that it will be processed
45
+ */
26
46
  QUOTE_SOFT_EXPIRED = -1,
47
+ /**
48
+ * Swap was created, use the {@link SpvFromBTCSwap.getFundedPsbt} or {@link SpvFromBTCSwap.getPsbt} functions
49
+ * to get the bitcoin swap PSBT that should be signed by the user's wallet and then submitted via the
50
+ * {@link SpvFromBTCSwap.submitPsbt} function.
51
+ */
27
52
  CREATED = 0,
53
+ /**
54
+ * Swap bitcoin PSBT was submitted by the client to the SDK
55
+ */
28
56
  SIGNED = 1,
57
+ /**
58
+ * Swap bitcoin PSBT sent to the intermediary (LP), waiting for the intermediary co-sign
59
+ * it and broadcast. You can use the {@link SpvFromBTCSwap.waitTillClaimedOrFronted}
60
+ * function to wait till the intermediary broadcasts the transaction and the transaction
61
+ * confirms.
62
+ */
29
63
  POSTED = 2,
64
+ /**
65
+ * Intermediary (LP) has co-signed and broadcasted the bitcoin transaction. You can use the
66
+ * {@link SpvFromBTCSwap.waitTillClaimedOrFronted} function to wait till the transaction
67
+ * confirms.
68
+ */
30
69
  BROADCASTED = 3,
70
+ /**
71
+ * Settlement on the destination smart chain was fronted and funds were already received
72
+ * by the user, even before the final settlement.
73
+ */
31
74
  FRONTED = 4,
75
+ /**
76
+ * Bitcoin transaction confirmed with necessary amount of confirmations, wait for automatic
77
+ * settlement by the watchtower with the {@link waitTillClaimedOrFronted} function, or settle manually
78
+ * using the {@link FromBTCSwap.claim} or {@link FromBTCSwap.txsClaim} function.
79
+ */
32
80
  BTC_TX_CONFIRMED = 5,
81
+ /**
82
+ * Swap settled on the smart chain and funds received
83
+ */
33
84
  CLAIMED = 6
34
85
  }
35
86
  export type SpvFromBTCSwapInit = ISwapInit & {
@@ -60,70 +111,209 @@ export type SpvFromBTCSwapInit = ISwapInit & {
60
111
  gasPricingInfo?: PriceInfoType;
61
112
  };
62
113
  export declare function isSpvFromBTCSwapInit(obj: any): obj is SpvFromBTCSwapInit;
114
+ /**
115
+ * New spv vault (UTXO-controlled vault) based swaps for Bitcoin -> Smart chain swaps not requiring
116
+ * any initiation on the destination chain, and with the added possibility for the user to receive
117
+ * a native token on the destination chain as part of the swap (a "gas drop" feature).
118
+ *
119
+ * @category Swaps/Bitcoin → Smart chain
120
+ */
63
121
  export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFromBTCTypeDefinition<T>> implements IBTCWalletSwap, ISwapWithGasDrop<T>, IClaimableSwap<T, SpvFromBTCTypeDefinition<T>, SpvFromBTCSwapState> {
64
- readonly TYPE = SwapType.SPV_VAULT_FROM_BTC;
122
+ readonly TYPE: SwapType.SPV_VAULT_FROM_BTC;
123
+ /**
124
+ * @inheritDoc
125
+ * @internal
126
+ */
65
127
  protected readonly logger: LoggerType;
66
- readonly quoteId: string;
67
- readonly recipient: string;
68
- readonly vaultOwner: string;
69
- readonly vaultId: bigint;
70
- readonly vaultRequiredConfirmations: number;
71
- readonly vaultTokenMultipliers: bigint[];
72
- readonly vaultBtcAddress: string;
73
- readonly vaultUtxo: string;
74
- readonly vaultUtxoValue: bigint;
75
- readonly btcDestinationAddress: string;
76
- readonly btcAmount: bigint;
77
- readonly btcAmountSwap: bigint;
78
- readonly btcAmountGas: bigint;
128
+ private readonly quoteId;
129
+ private readonly recipient;
130
+ private readonly vaultOwner;
131
+ private readonly vaultId;
132
+ private readonly vaultRequiredConfirmations;
133
+ private readonly vaultTokenMultipliers;
134
+ private readonly vaultBtcAddress;
135
+ private readonly vaultUtxo;
136
+ private readonly vaultUtxoValue;
137
+ private readonly btcDestinationAddress;
138
+ private readonly btcAmount;
139
+ private readonly btcAmountSwap;
140
+ private readonly btcAmountGas;
141
+ private readonly outputTotalSwap;
142
+ private readonly outputSwapToken;
143
+ private readonly outputTotalGas;
144
+ private readonly outputGasToken;
145
+ private readonly gasSwapFeeBtc;
146
+ private readonly gasSwapFee;
147
+ private readonly callerFeeShare;
148
+ private readonly frontingFeeShare;
149
+ private readonly executionFeeShare;
150
+ private readonly gasPricingInfo?;
151
+ /**
152
+ * @internal
153
+ */
154
+ readonly _genesisSmartChainBlockHeight: number;
155
+ /**
156
+ * @internal
157
+ */
158
+ _senderAddress?: string;
159
+ /**
160
+ * @internal
161
+ */
162
+ _claimTxId?: string;
163
+ /**
164
+ * @internal
165
+ */
166
+ _frontTxId?: string;
167
+ /**
168
+ * @internal
169
+ */
170
+ _data?: T["SpvVaultWithdrawalData"];
171
+ /**
172
+ * Minimum fee rate in sats/vB that the input bitcoin transaction needs to pay
173
+ */
79
174
  readonly minimumBtcFeeRate: number;
80
- readonly outputTotalSwap: bigint;
81
- readonly outputSwapToken: string;
82
- readonly outputTotalGas: bigint;
83
- readonly outputGasToken: string;
84
- readonly gasSwapFeeBtc: bigint;
85
- readonly gasSwapFee: bigint;
86
- readonly callerFeeShare: bigint;
87
- readonly frontingFeeShare: bigint;
88
- readonly executionFeeShare: bigint;
89
- readonly genesisSmartChainBlockHeight: number;
90
- gasPricingInfo?: PriceInfoType;
91
- senderAddress?: string;
92
- claimTxId?: string;
93
- frontTxId?: string;
94
- data?: T["SpvVaultWithdrawalData"];
95
175
  constructor(wrapper: SpvFromBTCWrapper<T>, init: SpvFromBTCSwapInit);
96
176
  constructor(wrapper: SpvFromBTCWrapper<T>, obj: any);
177
+ /**
178
+ * @inheritDoc
179
+ * @internal
180
+ */
97
181
  protected upgradeVersion(): void;
98
182
  /**
99
- * In case swapFee in BTC is not supplied it recalculates it based on swap price
100
- * @protected
183
+ * @inheritDoc
184
+ * @internal
101
185
  */
102
186
  protected tryCalculateSwapFee(): void;
187
+ /**
188
+ * @inheritDoc
189
+ */
103
190
  refreshPriceData(): Promise<void>;
191
+ /**
192
+ * @inheritDoc
193
+ * @internal
194
+ */
104
195
  _getInitiator(): string;
196
+ /**
197
+ * @inheritDoc
198
+ * @internal
199
+ */
105
200
  _getEscrowHash(): string | null;
201
+ /**
202
+ * @inheritDoc
203
+ */
106
204
  getId(): string;
205
+ /**
206
+ * @inheritDoc
207
+ */
107
208
  getQuoteExpiry(): number;
108
- verifyQuoteValid(): Promise<boolean>;
209
+ /**
210
+ * @inheritDoc
211
+ * @internal
212
+ */
213
+ _verifyQuoteDefinitelyExpired(): Promise<boolean>;
214
+ /**
215
+ * @inheritDoc
216
+ * @internal
217
+ */
218
+ _verifyQuoteValid(): Promise<boolean>;
219
+ /**
220
+ * @inheritDoc
221
+ */
109
222
  getOutputAddress(): string | null;
223
+ /**
224
+ * @inheritDoc
225
+ */
110
226
  getOutputTxId(): string | null;
227
+ /**
228
+ * @inheritDoc
229
+ */
111
230
  getInputAddress(): string | null;
231
+ /**
232
+ * @inheritDoc
233
+ */
112
234
  getInputTxId(): string | null;
235
+ /**
236
+ * @inheritDoc
237
+ */
113
238
  requiresAction(): boolean;
239
+ /**
240
+ * @inheritDoc
241
+ */
114
242
  isFinished(): boolean;
243
+ /**
244
+ * @inheritDoc
245
+ */
115
246
  isClaimable(): boolean;
247
+ /**
248
+ * @inheritDoc
249
+ */
116
250
  isSuccessful(): boolean;
251
+ /**
252
+ * @inheritDoc
253
+ */
117
254
  isFailed(): boolean;
255
+ /**
256
+ * @inheritDoc
257
+ */
118
258
  isQuoteExpired(): boolean;
259
+ /**
260
+ * @inheritDoc
261
+ */
119
262
  isQuoteSoftExpired(): boolean;
263
+ /**
264
+ * Returns the data about used spv vault (UTXO-controlled vault) to perform the swap
265
+ */
266
+ getSpvVaultData(): {
267
+ owner: string;
268
+ vaultId: bigint;
269
+ utxo: string;
270
+ };
271
+ /**
272
+ * Returns the input BTC amount in sats without any fees
273
+ *
274
+ * @internal
275
+ */
120
276
  protected getInputSwapAmountWithoutFee(): bigint;
277
+ /**
278
+ * Returns the input gas BTC amount in sats without any fees
279
+ *
280
+ * @internal
281
+ */
121
282
  protected getInputGasAmountWithoutFee(): bigint;
283
+ /**
284
+ * Returns to total input BTC amount in sats without any fees (this is BTC amount for the swap + BTC amount
285
+ * for the gas drop).
286
+ *
287
+ * @internal
288
+ */
122
289
  protected getInputAmountWithoutFee(): bigint;
290
+ /**
291
+ * Returns the swap output amount without any fees, this value is therefore always higher than
292
+ * the actual received output.
293
+ *
294
+ * @internal
295
+ */
123
296
  protected getOutputWithoutFee(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
297
+ /**
298
+ * Returns the swap fee charged by the intermediary (LP) on this swap
299
+ *
300
+ * @internal
301
+ */
124
302
  protected getSwapFee(): Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>>;
303
+ /**
304
+ * Returns the fee to be paid to watchtowers on the destination chain to automatically
305
+ * process and settle this swap without requiring any user interaction
306
+ *
307
+ * @internal
308
+ */
125
309
  protected getWatchtowerFee(): Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>>;
310
+ /**
311
+ * @inheritDoc
312
+ */
126
313
  getFee(): Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>>;
314
+ /**
315
+ * @inheritDoc
316
+ */
127
317
  getFeeBreakdown(): [
128
318
  {
129
319
  type: FeeType.SWAP;
@@ -134,13 +324,38 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
134
324
  fee: Fee<T["ChainId"], BtcToken<false>, SCToken<T["ChainId"]>>;
135
325
  }
136
326
  ];
327
+ /**
328
+ * @inheritDoc
329
+ */
137
330
  getOutputToken(): SCToken<T["ChainId"]>;
331
+ /**
332
+ * @inheritDoc
333
+ */
138
334
  getOutput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
335
+ /**
336
+ * @inheritDoc
337
+ */
139
338
  getGasDropOutput(): TokenAmount<T["ChainId"], SCToken<T["ChainId"]>, true>;
339
+ /**
340
+ * @inheritDoc
341
+ */
140
342
  getInputWithoutFee(): TokenAmount<T["ChainId"], BtcToken<false>, true>;
343
+ /**
344
+ * @inheritDoc
345
+ */
141
346
  getInputToken(): BtcToken<false>;
347
+ /**
348
+ * @inheritDoc
349
+ */
142
350
  getInput(): TokenAmount<T["ChainId"], BtcToken<false>, true>;
351
+ /**
352
+ * @inheritDoc
353
+ */
143
354
  getRequiredConfirmationsCount(): number;
355
+ /**
356
+ * Returns raw transaction details that can be used to manually create a swap PSBT. It is better to use
357
+ * the {@link getPsbt} or {@link getFundedPsbt} function retrieve an already prepared PSBT.
358
+ */
144
359
  getTransactionDetails(): Promise<{
145
360
  in0txid: string;
146
361
  in0vout: number;
@@ -154,9 +369,9 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
154
369
  locktime: number;
155
370
  }>;
156
371
  /**
157
- * Returns the raw PSBT (not funded), the wallet should fund the PSBT (add its inputs), set the nSequence field of the
158
- * 2nd input (input 1 - indexing from 0) to the value returned in `in1sequence`, sign the PSBT and then pass
159
- * it back to the SDK with `swap.submitPsbt()`
372
+ * Returns the raw PSBT (not funded), the wallet should fund the PSBT (add its inputs) and importantly **set the nSequence field of the
373
+ * 2nd input** (input 1 - indexing from 0) to the value returned in `in1sequence`, sign the PSBT and then pass
374
+ * it back to the swap with {@link submitPsbt} function.
160
375
  */
161
376
  getPsbt(): Promise<{
162
377
  psbt: Transaction;
@@ -167,10 +382,13 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
167
382
  /**
168
383
  * Returns the PSBT that is already funded with wallet's UTXOs (runs a coin-selection algorithm to choose UTXOs to use),
169
384
  * also returns inputs indices that need to be signed by the wallet before submitting the PSBT back to the SDK with
170
- * `swap.submitPsbt()`
385
+ * {@link submitPsbt}
386
+ *
387
+ * @remarks
388
+ * Note that when passing the `feeRate` argument, the fee must be at least {@link minimumBtcFeeRate} sats/vB.
171
389
  *
172
390
  * @param _bitcoinWallet Sender's bitcoin wallet
173
- * @param feeRate Optional fee rate for the transaction, needs to be at least as big as {minimumBtcFeeRate} field
391
+ * @param feeRate Optional fee rate in sats/vB for the transaction
174
392
  * @param additionalOutputs additional outputs to add to the PSBT - can be used to collect fees from users
175
393
  */
176
394
  getFundedPsbt(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number, additionalOutputs?: ({
@@ -186,22 +404,27 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
186
404
  signInputs: number[];
187
405
  }>;
188
406
  /**
189
- * Submits a PSBT signed by the wallet back to the SDK
190
- *
191
- * @param _psbt A psbt - either a Transaction object or a hex or base64 encoded PSBT string
407
+ * @inheritDoc
192
408
  */
193
409
  submitPsbt(_psbt: Transaction | string): Promise<string>;
410
+ /**
411
+ * @inheritDoc
412
+ */
194
413
  estimateBitcoinFee(_bitcoinWallet: IBitcoinWallet | MinimalBitcoinWalletInterface, feeRate?: number): Promise<TokenAmount<any, BtcToken<false>, true> | null>;
414
+ /**
415
+ * @inheritDoc
416
+ */
195
417
  sendBitcoinTransaction(wallet: IBitcoinWallet | MinimalBitcoinWalletInterfaceWithSigner, feeRate?: number): Promise<string>;
196
418
  /**
197
- * Executes the swap with the provided bitcoin wallet,
419
+ * Executes the swap with the provided bitcoin wallet
198
420
  *
199
421
  * @param wallet Bitcoin wallet to use to sign the bitcoin transaction
200
422
  * @param callbacks Callbacks to track the progress of the swap
201
423
  * @param options Optional options for the swap like feeRate, AbortSignal, and timeouts/intervals
202
424
  *
203
425
  * @returns {boolean} Whether a swap was settled automatically by swap watchtowers or requires manual claim by the
204
- * user, in case `false` is returned the user should call `swap.claim()` to settle the swap on the destination manually
426
+ * user, in case `false` is returned the user should call the {@link claim} function to settle the swap on the
427
+ * destination manually
205
428
  */
206
429
  execute(wallet: IBitcoinWallet | MinimalBitcoinWalletInterfaceWithSigner, callbacks?: {
207
430
  onSourceTransactionSent?: (sourceTxId: string) => void;
@@ -214,28 +437,22 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
214
437
  btcTxCheckIntervalSeconds?: number;
215
438
  maxWaitTillAutomaticSettlementSeconds?: number;
216
439
  }): Promise<boolean>;
440
+ /**
441
+ * @inheritDoc
442
+ *
443
+ * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
444
+ * if not provided a raw PSBT is returned instead which necessitates the implementor to manually add
445
+ * inputs to the bitcoin transaction and **set the nSequence field of the 2nd input** (input 1 -
446
+ * indexing from 0) to the value returned in `in1sequence`
447
+ */
217
448
  txsExecute(options?: {
218
449
  bitcoinWallet?: MinimalBitcoinWalletInterface;
219
- }): Promise<{
220
- name: "Payment";
221
- description: string;
222
- chain: string;
223
- txs: ({
224
- type: string;
225
- psbt: Transaction;
226
- psbtHex: string;
227
- psbtBase64: string;
228
- in1sequence: number;
229
- } | {
230
- type: string;
231
- psbt: Transaction;
232
- psbtHex: string;
233
- psbtBase64: string;
234
- signInputs: number[];
235
- })[];
236
- }[]>;
450
+ }): Promise<[
451
+ SwapExecutionActionBitcoin<"RAW_PSBT" | "FUNDED_PSBT">
452
+ ]>;
237
453
  /**
238
454
  * Checks whether a bitcoin payment was already made, returns the payment or null when no payment has been made.
455
+ * @internal
239
456
  */
240
457
  protected getBitcoinPayment(): Promise<{
241
458
  txId: string;
@@ -244,72 +461,117 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
244
461
  inputAddresses?: string[];
245
462
  } | null>;
246
463
  /**
247
- * Waits till the bitcoin transaction confirms and swap becomes claimable
464
+ * @inheritDoc
248
465
  *
249
- * @param updateCallback Callback called when txId is found, and also called with subsequent confirmations
250
- * @param checkIntervalSeconds How often to check the bitcoin transaction
251
- * @param abortSignal Abort signal
252
- * @throws {Error} if in invalid state (must be CLAIM_COMMITED)
466
+ * @throws {Error} if in invalid state (must be {@link SpvFromBTCSwapState.POSTED} or
467
+ * {@link SpvFromBTCSwapState.BROADCASTED} states)
253
468
  */
254
469
  waitForBitcoinTransaction(updateCallback?: (txId?: string, confirmations?: number, targetConfirmations?: number, txEtaMs?: number) => void, checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<string>;
255
470
  /**
256
- * Returns transactions required to claim the swap on-chain (and possibly also sync the bitcoin light client)
257
- * after a bitcoin transaction was sent and confirmed
471
+ * Returns transactions for settling (claiming) the swap if the swap requires manual settlement, you can check so
472
+ * with isClaimable. After sending the transaction manually be sure to call the waitTillClaimed function to wait
473
+ * till the claim transaction is observed, processed by the SDK and state of the swap properly updated.
474
+ *
475
+ * @remarks
476
+ * Might also return transactions necessary to sync the bitcoin light client.
477
+ *
478
+ * @param _signer Address of the signer to create the claim transactions for, can also be different to the recipient
258
479
  *
259
- * @throws {Error} If the swap is in invalid state (must be BTC_TX_CONFIRMED)
480
+ * @throws {Error} If the swap is in invalid state (must be {@link SpvFromBTCSwapState.BTC_TX_CONFIRMED})
260
481
  */
261
482
  txsClaim(_signer?: string | T["Signer"] | T["NativeSigner"]): Promise<T["TX"][]>;
262
483
  /**
263
- * Claims and finishes the swap
484
+ * Settles the swap by claiming the funds on the destination chain if the swap requires manual settlement, you can
485
+ * check so with isClaimable.
486
+ *
487
+ * @remarks
488
+ * Might also sync the bitcoin light client during the process.
489
+ *
490
+ * @param _signer Signer to use for signing the settlement transactions, can also be different to the recipient
491
+ * @param abortSignal Abort signal
492
+ * @param onBeforeTxSent Optional callback triggered before the claim transaction is broadcasted
264
493
  *
265
- * @param _signer Signer to sign the transactions with, can also be different to the initializer
266
- * @param abortSignal Abort signal to stop waiting for transaction confirmation
494
+ * @throws {Error} If the swap is in invalid state (must be {@link SpvFromBTCSwapState.BTC_TX_CONFIRMED})
267
495
  */
268
- claim(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal): Promise<string>;
496
+ claim(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal, onBeforeTxSent?: (txId: string) => void): Promise<string>;
269
497
  /**
270
498
  * Periodically checks the chain to see whether the swap was finished (claimed or refunded)
271
499
  *
272
500
  * @param abortSignal
273
501
  * @param interval How often to check (in seconds), default to 5s
274
- * @protected
502
+ * @internal
275
503
  */
276
504
  protected watchdogWaitTillResult(abortSignal?: AbortSignal, interval?: number): Promise<SpvWithdrawalClaimedState | SpvWithdrawalFrontedState | SpvWithdrawalClosedState>;
277
505
  /**
278
- * Waits till the swap is successfully executed
506
+ * Waits till the swap is successfully settled (claimed), should be called after sending the claim (settlement)
507
+ * transactions manually to wait till the SDK processes the settlement and updates the swap state accordingly.
508
+ *
509
+ * @remarks
510
+ * This is an alias for the {@link waitTillClaimedOrFronted} function and will also resolve if the swap has
511
+ * been fronted (not necessarily claimed)
512
+ *
513
+ * @param maxWaitTimeSeconds – Maximum time in seconds to wait for the swap to be settled
514
+ * @param abortSignal – AbortSignal
515
+ *
516
+ * @returns Whether the swap was claimed in time or not
517
+ */
518
+ waitTillClaimed(maxWaitTimeSeconds?: number, abortSignal?: AbortSignal): Promise<boolean>;
519
+ /**
520
+ * Waits till the swap is successfully fronted or settled on the destination chain
521
+ *
522
+ * @param maxWaitTimeSeconds Maximum time in seconds to wait for the swap to be settled (by default
523
+ * it waits indefinitely)
524
+ * @param abortSignal Abort signal
279
525
  *
280
- * @param maxWaitTimeSeconds Maximum time in seconds to wait for the swap to be settled
281
- * @param abortSignal
282
- * @throws {Error} If swap is in invalid state (must be BTC_TX_CONFIRMED)
283
- * @throws {Error} If the LP refunded sooner than we were able to claim
284
526
  * @returns {boolean} whether the swap was claimed or fronted automatically or not, if the swap was not claimed
285
- * the user can claim manually through `swap.claim()`
527
+ * the user can claim manually through the {@link claim} function
286
528
  */
287
529
  waitTillClaimedOrFronted(maxWaitTimeSeconds?: number, abortSignal?: AbortSignal): Promise<boolean>;
288
530
  /**
289
- * Waits till the bitcoin transaction confirms and swap is claimed
531
+ * Waits till the bitcoin transaction confirms and swap settled on the destination chain
290
532
  *
291
- * @param abortSignal Abort signal
292
- * @param checkIntervalSeconds How often to check the bitcoin transaction
293
533
  * @param updateCallback Callback called when txId is found, and also called with subsequent confirmations
294
- * @throws {Error} if in invalid state (must be CLAIM_COMMITED)
534
+ * @param checkIntervalSeconds How often to check the bitcoin transaction (5 seconds by default)
535
+ * @param abortSignal Abort signal
536
+ *
537
+ * @throws {Error} if in invalid state (must be {@link SpvFromBTCSwapState.POSTED} or
538
+ * {@link SpvFromBTCSwapState.BROADCASTED} states)
295
539
  */
296
540
  waitTillExecuted(updateCallback?: (txId?: string, confirmations?: number, targetConfirmations?: number, txEtaMs?: number) => void, checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<void>;
541
+ /**
542
+ * @inheritDoc
543
+ */
297
544
  serialize(): any;
298
545
  /**
299
- * For internal use! Used to set the txId of the bitcoin payment from the on-chain events listener
546
+ * Used to set the txId of the bitcoin payment from the on-chain events listener
300
547
  *
301
548
  * @param txId
549
+ * @internal
302
550
  */
303
551
  _setBitcoinTxId(txId: string): Promise<void>;
552
+ /**
553
+ * @internal
554
+ */
304
555
  _syncStateFromBitcoin(save?: boolean): Promise<boolean>;
305
556
  /**
306
557
  * Checks the swap's state on-chain and compares it to its internal state, updates/changes it according to on-chain
307
558
  * data
308
- *
309
- * @private
310
559
  */
311
560
  private syncStateFromChain;
561
+ /**
562
+ * @inheritDoc
563
+ * @internal
564
+ */
312
565
  _sync(save?: boolean): Promise<boolean>;
566
+ /**
567
+ * @inheritDoc
568
+ * @internal
569
+ */
313
570
  _tick(save?: boolean): Promise<boolean>;
571
+ /**
572
+ * Checks whether an on-chain withdrawal state should be fetched for this specific swap
573
+ *
574
+ * @internal
575
+ */
314
576
  _shouldCheckWithdrawalState(frontingAddress?: string | null, vaultDataUtxo?: string | null): Promise<boolean>;
315
577
  }