@atomiqlabs/sdk 8.6.5 → 8.6.6
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.
- package/dist/SmartChainAssets.d.ts +181 -181
- package/dist/SmartChainAssets.js +181 -181
- package/dist/bitcoin/coinselect2/accumulative.d.ts +6 -6
- package/dist/bitcoin/coinselect2/accumulative.js +51 -52
- package/dist/bitcoin/coinselect2/blackjack.d.ts +6 -6
- package/dist/bitcoin/coinselect2/blackjack.js +37 -38
- package/dist/bitcoin/coinselect2/index.d.ts +17 -19
- package/dist/bitcoin/coinselect2/index.js +69 -69
- package/dist/bitcoin/coinselect2/utils.d.ts +75 -77
- package/dist/bitcoin/coinselect2/utils.js +123 -123
- package/dist/bitcoin/wallet/BitcoinWallet.d.ts +128 -130
- package/dist/bitcoin/wallet/BitcoinWallet.js +322 -322
- package/dist/bitcoin/wallet/IBitcoinWallet.d.ts +78 -78
- package/dist/bitcoin/wallet/IBitcoinWallet.js +20 -21
- package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.d.ts +99 -101
- package/dist/bitcoin/wallet/SingleAddressBitcoinWallet.js +176 -176
- package/dist/enums/FeeType.d.ts +15 -15
- package/dist/enums/FeeType.js +19 -19
- package/dist/enums/SwapAmountType.d.ts +15 -15
- package/dist/enums/SwapAmountType.js +19 -19
- package/dist/enums/SwapDirection.d.ts +15 -15
- package/dist/enums/SwapDirection.js +19 -19
- package/dist/enums/SwapSide.d.ts +15 -15
- package/dist/enums/SwapSide.js +19 -19
- package/dist/enums/SwapType.d.ts +75 -75
- package/dist/enums/SwapType.js +79 -79
- package/dist/errors/IntermediaryError.d.ts +13 -13
- package/dist/errors/IntermediaryError.js +27 -27
- package/dist/errors/RequestError.d.ts +32 -32
- package/dist/errors/RequestError.js +54 -54
- package/dist/errors/UserError.d.ts +8 -8
- package/dist/errors/UserError.js +16 -16
- package/dist/events/UnifiedSwapEventListener.d.ts +23 -23
- package/dist/events/UnifiedSwapEventListener.js +130 -130
- package/dist/http/HttpUtils.d.ts +27 -27
- package/dist/http/HttpUtils.js +90 -91
- package/dist/http/paramcoders/IParamReader.d.ts +8 -8
- package/dist/http/paramcoders/IParamReader.js +2 -2
- package/dist/http/paramcoders/ParamDecoder.d.ts +42 -44
- package/dist/http/paramcoders/ParamDecoder.js +137 -137
- package/dist/http/paramcoders/ParamEncoder.d.ts +18 -20
- package/dist/http/paramcoders/ParamEncoder.js +36 -36
- package/dist/http/paramcoders/SchemaVerifier.d.ts +26 -26
- package/dist/http/paramcoders/SchemaVerifier.js +145 -145
- package/dist/http/paramcoders/client/ResponseParamDecoder.d.ts +11 -11
- package/dist/http/paramcoders/client/ResponseParamDecoder.js +57 -57
- package/dist/http/paramcoders/client/StreamParamEncoder.d.ts +11 -13
- package/dist/http/paramcoders/client/StreamParamEncoder.js +26 -26
- package/dist/http/paramcoders/client/StreamingFetchPromise.d.ts +16 -16
- package/dist/http/paramcoders/client/StreamingFetchPromise.js +173 -174
- package/dist/index.d.ts +85 -85
- package/dist/index.js +158 -158
- package/dist/intermediaries/Intermediary.d.ts +157 -157
- package/dist/intermediaries/Intermediary.js +142 -142
- package/dist/intermediaries/IntermediaryDiscovery.d.ts +198 -199
- package/dist/intermediaries/IntermediaryDiscovery.js +406 -406
- package/dist/intermediaries/apis/IntermediaryAPI.d.ts +437 -438
- package/dist/intermediaries/apis/IntermediaryAPI.js +603 -602
- package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts +155 -155
- package/dist/intermediaries/apis/TrustedIntermediaryAPI.js +137 -137
- package/dist/lnurl/LNURL.d.ts +102 -102
- package/dist/lnurl/LNURL.js +321 -321
- package/dist/prices/RedundantSwapPrice.d.ts +110 -110
- package/dist/prices/RedundantSwapPrice.js +222 -222
- package/dist/prices/SingleSwapPrice.d.ts +34 -34
- package/dist/prices/SingleSwapPrice.js +44 -44
- package/dist/prices/SwapPriceWithChain.d.ts +107 -107
- package/dist/prices/SwapPriceWithChain.js +128 -128
- package/dist/prices/abstract/ICachedSwapPrice.d.ts +28 -28
- package/dist/prices/abstract/ICachedSwapPrice.js +62 -62
- package/dist/prices/abstract/IPriceProvider.d.ts +81 -81
- package/dist/prices/abstract/IPriceProvider.js +74 -74
- package/dist/prices/abstract/ISwapPrice.d.ts +168 -168
- package/dist/prices/abstract/ISwapPrice.js +279 -279
- package/dist/prices/providers/BinancePriceProvider.d.ts +23 -23
- package/dist/prices/providers/BinancePriceProvider.js +30 -30
- package/dist/prices/providers/CoinGeckoPriceProvider.d.ts +23 -23
- package/dist/prices/providers/CoinGeckoPriceProvider.js +29 -29
- package/dist/prices/providers/CoinPaprikaPriceProvider.d.ts +25 -25
- package/dist/prices/providers/CoinPaprikaPriceProvider.js +29 -29
- package/dist/prices/providers/CustomPriceProvider.d.ts +24 -24
- package/dist/prices/providers/CustomPriceProvider.js +35 -35
- package/dist/prices/providers/KrakenPriceProvider.d.ts +38 -38
- package/dist/prices/providers/KrakenPriceProvider.js +45 -45
- package/dist/prices/providers/OKXPriceProvider.d.ts +34 -34
- package/dist/prices/providers/OKXPriceProvider.js +29 -29
- package/dist/prices/providers/abstract/ExchangePriceProvider.d.ts +17 -17
- package/dist/prices/providers/abstract/ExchangePriceProvider.js +21 -21
- package/dist/prices/providers/abstract/HttpPriceProvider.d.ts +7 -7
- package/dist/prices/providers/abstract/HttpPriceProvider.js +12 -12
- package/dist/storage/IUnifiedStorage.d.ts +85 -85
- package/dist/storage/IUnifiedStorage.js +2 -2
- package/dist/storage/UnifiedSwapStorage.d.ts +114 -114
- package/dist/storage/UnifiedSwapStorage.js +116 -116
- package/dist/storage-browser/IndexedDBUnifiedStorage.d.ts +63 -63
- package/dist/storage-browser/IndexedDBUnifiedStorage.js +298 -298
- package/dist/storage-browser/LocalStorageManager.d.ts +49 -49
- package/dist/storage-browser/LocalStorageManager.js +93 -93
- package/dist/swapper/Swapper.d.ts +686 -687
- package/dist/swapper/Swapper.js +1603 -1603
- package/dist/swapper/SwapperFactory.d.ts +135 -135
- package/dist/swapper/SwapperFactory.js +162 -162
- package/dist/swapper/SwapperUtils.d.ts +200 -200
- package/dist/swapper/SwapperUtils.js +467 -467
- package/dist/swapper/SwapperWithChain.d.ts +404 -404
- package/dist/swapper/SwapperWithChain.js +469 -469
- package/dist/swapper/SwapperWithSigner.d.ts +322 -322
- package/dist/swapper/SwapperWithSigner.js +318 -318
- package/dist/swaps/IAddressSwap.d.ts +22 -22
- package/dist/swaps/IAddressSwap.js +13 -14
- package/dist/swaps/IBTCWalletSwap.d.ts +73 -73
- package/dist/swaps/IBTCWalletSwap.js +17 -18
- package/dist/swaps/IClaimableSwap.d.ts +49 -49
- package/dist/swaps/IClaimableSwap.js +14 -15
- package/dist/swaps/IClaimableSwapWrapper.d.ts +15 -15
- package/dist/swaps/IClaimableSwapWrapper.js +2 -2
- package/dist/swaps/IRefundableSwap.d.ts +43 -43
- package/dist/swaps/IRefundableSwap.js +13 -14
- package/dist/swaps/ISwap.d.ts +386 -387
- package/dist/swaps/ISwap.js +346 -346
- package/dist/swaps/ISwapWithGasDrop.d.ts +21 -21
- package/dist/swaps/ISwapWithGasDrop.js +11 -12
- package/dist/swaps/ISwapWrapper.d.ts +283 -285
- package/dist/swaps/ISwapWrapper.js +353 -353
- package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts +98 -98
- package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js +126 -126
- package/dist/swaps/escrow_swaps/IEscrowSwap.d.ts +133 -135
- package/dist/swaps/escrow_swaps/IEscrowSwap.js +169 -169
- package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.d.ts +114 -115
- package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js +134 -134
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.d.ts +98 -101
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCLNWrapper.js +130 -130
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.d.ts +162 -162
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap.js +190 -190
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.d.ts +58 -58
- package/dist/swaps/escrow_swaps/frombtc/IFromBTCWrapper.js +78 -78
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts +529 -531
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js +1285 -1285
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.d.ts +181 -184
- package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNWrapper.js +418 -418
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts +581 -583
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.js +1371 -1371
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.d.ts +225 -228
- package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js +506 -506
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts +458 -458
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js +1126 -1126
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.d.ts +190 -191
- package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCWrapper.js +378 -378
- package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts +403 -403
- package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js +924 -924
- package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.d.ts +62 -62
- package/dist/swaps/escrow_swaps/tobtc/IToBTCWrapper.js +112 -112
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.d.ts +125 -127
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNSwap.js +256 -256
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.d.ts +241 -242
- package/dist/swaps/escrow_swaps/tobtc/ln/ToBTCLNWrapper.js +520 -520
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.d.ts +73 -73
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCSwap.js +155 -155
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.d.ts +127 -128
- package/dist/swaps/escrow_swaps/tobtc/onchain/ToBTCWrapper.js +278 -278
- package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts +630 -630
- package/dist/swaps/spv_swaps/SpvFromBTCSwap.js +1443 -1443
- package/dist/swaps/spv_swaps/SpvFromBTCWrapper.d.ts +213 -207
- package/dist/swaps/spv_swaps/SpvFromBTCWrapper.js +756 -755
- package/dist/swaps/trusted/ln/LnForGasSwap.d.ts +261 -261
- package/dist/swaps/trusted/ln/LnForGasSwap.js +511 -511
- package/dist/swaps/trusted/ln/LnForGasWrapper.d.ts +40 -40
- package/dist/swaps/trusted/ln/LnForGasWrapper.js +82 -82
- package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts +342 -342
- package/dist/swaps/trusted/onchain/OnchainForGasSwap.js +715 -715
- package/dist/swaps/trusted/onchain/OnchainForGasWrapper.d.ts +68 -69
- package/dist/swaps/trusted/onchain/OnchainForGasWrapper.js +92 -92
- package/dist/types/AmountData.d.ts +10 -10
- package/dist/types/AmountData.js +2 -2
- package/dist/types/CustomPriceFunction.d.ts +11 -11
- package/dist/types/CustomPriceFunction.js +2 -2
- package/dist/types/PriceInfoType.d.ts +28 -28
- package/dist/types/PriceInfoType.js +56 -57
- package/dist/types/SwapExecutionAction.d.ts +88 -88
- package/dist/types/SwapExecutionAction.js +2 -2
- package/dist/types/SwapStateInfo.d.ts +5 -5
- package/dist/types/SwapStateInfo.js +2 -2
- package/dist/types/SwapWithSigner.d.ts +17 -17
- package/dist/types/SwapWithSigner.js +42 -43
- package/dist/types/Token.d.ts +99 -99
- package/dist/types/Token.js +76 -76
- package/dist/types/TokenAmount.d.ts +69 -69
- package/dist/types/TokenAmount.js +59 -60
- package/dist/types/fees/Fee.d.ts +50 -50
- package/dist/types/fees/Fee.js +2 -2
- package/dist/types/fees/FeeBreakdown.d.ts +11 -11
- package/dist/types/fees/FeeBreakdown.js +2 -2
- package/dist/types/fees/PercentagePPM.d.ts +17 -17
- package/dist/types/fees/PercentagePPM.js +17 -18
- package/dist/types/lnurl/LNURLPay.d.ts +61 -61
- package/dist/types/lnurl/LNURLPay.js +30 -31
- package/dist/types/lnurl/LNURLWithdraw.d.ts +48 -48
- package/dist/types/lnurl/LNURLWithdraw.js +26 -27
- package/dist/types/wallets/LightningInvoiceCreateService.d.ts +24 -24
- package/dist/types/wallets/LightningInvoiceCreateService.js +14 -15
- package/dist/types/wallets/MinimalBitcoinWalletInterface.d.ts +23 -23
- package/dist/types/wallets/MinimalBitcoinWalletInterface.js +2 -2
- package/dist/types/wallets/MinimalLightningNetworkWalletInterface.d.ts +9 -9
- package/dist/types/wallets/MinimalLightningNetworkWalletInterface.js +2 -2
- package/dist/utils/AutomaticClockDriftCorrection.d.ts +1 -1
- package/dist/utils/AutomaticClockDriftCorrection.js +69 -70
- package/dist/utils/BitcoinUtils.d.ts +12 -14
- package/dist/utils/BitcoinUtils.js +101 -102
- package/dist/utils/BitcoinWalletUtils.d.ts +7 -7
- package/dist/utils/BitcoinWalletUtils.js +13 -14
- package/dist/utils/Logger.d.ts +7 -7
- package/dist/utils/Logger.js +11 -12
- package/dist/utils/RetryUtils.d.ts +22 -22
- package/dist/utils/RetryUtils.js +66 -67
- package/dist/utils/SwapUtils.d.ts +88 -88
- package/dist/utils/SwapUtils.js +72 -72
- package/dist/utils/TimeoutUtils.d.ts +17 -17
- package/dist/utils/TimeoutUtils.js +54 -55
- package/dist/utils/TokenUtils.d.ts +19 -19
- package/dist/utils/TokenUtils.js +36 -37
- package/dist/utils/TypeUtils.d.ts +7 -7
- package/dist/utils/TypeUtils.js +2 -2
- package/dist/utils/Utils.d.ts +56 -58
- package/dist/utils/Utils.js +193 -194
- package/package.json +1 -1
- package/src/intermediaries/apis/IntermediaryAPI.ts +4 -2
- package/src/swaps/spv_swaps/SpvFromBTCWrapper.ts +8 -0
|
@@ -1,403 +1,403 @@
|
|
|
1
|
-
import { IToBTCDefinition, IToBTCWrapper } from "./IToBTCWrapper";
|
|
2
|
-
import { ChainType, SignatureData, SwapCommitState, SwapData } from "@atomiqlabs/base";
|
|
3
|
-
import { RefundAuthorizationResponse } from "../../../intermediaries/apis/IntermediaryAPI";
|
|
4
|
-
import { Fee } from "../../../types/fees/Fee";
|
|
5
|
-
import { IEscrowSelfInitSwap, IEscrowSelfInitSwapInit } from "../IEscrowSelfInitSwap";
|
|
6
|
-
import { IRefundableSwap } from "../../IRefundableSwap";
|
|
7
|
-
import { FeeType } from "../../../enums/FeeType";
|
|
8
|
-
import { TokenAmount } from "../../../types/TokenAmount";
|
|
9
|
-
import { BtcToken, SCToken } from "../../../types/Token";
|
|
10
|
-
import { SwapExecutionAction, SwapExecutionActionCommit } from "../../../types/SwapExecutionAction";
|
|
11
|
-
export type IToBTCSwapInit<T extends SwapData> = IEscrowSelfInitSwapInit<T> & {
|
|
12
|
-
signatureData?: SignatureData;
|
|
13
|
-
data: T;
|
|
14
|
-
networkFee: bigint;
|
|
15
|
-
networkFeeBtc: bigint;
|
|
16
|
-
};
|
|
17
|
-
export declare function isIToBTCSwapInit<T extends SwapData>(obj: any): obj is IToBTCSwapInit<T>;
|
|
18
|
-
/**
|
|
19
|
-
* State enum for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
|
|
20
|
-
*
|
|
21
|
-
* @category Swaps/Smart chain → Bitcoin
|
|
22
|
-
*/
|
|
23
|
-
export declare enum ToBTCSwapState {
|
|
24
|
-
/**
|
|
25
|
-
* Intermediary (LP) was unable to process the swap and the funds were refunded on the
|
|
26
|
-
* source chain
|
|
27
|
-
*/
|
|
28
|
-
REFUNDED = -3,
|
|
29
|
-
/**
|
|
30
|
-
* Swap has expired for good and there is no way how it can be executed anymore
|
|
31
|
-
*/
|
|
32
|
-
QUOTE_EXPIRED = -2,
|
|
33
|
-
/**
|
|
34
|
-
* A swap is almost expired, and it should be presented to the user as expired, though
|
|
35
|
-
* there is still a chance that it will be processed
|
|
36
|
-
*/
|
|
37
|
-
QUOTE_SOFT_EXPIRED = -1,
|
|
38
|
-
/**
|
|
39
|
-
* Swap was created, use the {@link IToBTCSwap.commit} or {@link IToBTCSwap.txsCommit} to
|
|
40
|
-
* initiate it by creating the swap escrow on the source chain
|
|
41
|
-
*/
|
|
42
|
-
CREATED = 0,
|
|
43
|
-
/**
|
|
44
|
-
* Swap escrow was initiated (committed) on the source chain, the intermediary (LP) will
|
|
45
|
-
* now process the swap. You can wait till that happens with the {@link IToBTCSwap.waitForPayment}
|
|
46
|
-
* function.
|
|
47
|
-
*/
|
|
48
|
-
COMMITED = 1,
|
|
49
|
-
/**
|
|
50
|
-
* The intermediary (LP) has processed the transaction and sent out the funds on the destination chain,
|
|
51
|
-
* but hasn't yet settled the escrow on the source chain.
|
|
52
|
-
*/
|
|
53
|
-
SOFT_CLAIMED = 2,
|
|
54
|
-
/**
|
|
55
|
-
* Swap was successfully settled by the intermediary (LP) on the source chain
|
|
56
|
-
*/
|
|
57
|
-
CLAIMED = 3,
|
|
58
|
-
/**
|
|
59
|
-
* Intermediary (LP) was unable to process the swap and the swap escrow on the source chain
|
|
60
|
-
* is refundable, call {@link IToBTCSwap.refund} or {@link IToBTCSwap.txsRefund} to refund
|
|
61
|
-
*/
|
|
62
|
-
REFUNDABLE = 4
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* Base class for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
|
|
66
|
-
*
|
|
67
|
-
* @category Swaps/Smart chain → Bitcoin
|
|
68
|
-
*/
|
|
69
|
-
export declare abstract class IToBTCSwap<T extends ChainType = ChainType, D extends IToBTCDefinition<T, IToBTCWrapper<T, D>, IToBTCSwap<T, D>> = IToBTCDefinition<T, IToBTCWrapper<T, any>, IToBTCSwap<T, any>>> extends IEscrowSelfInitSwap<T, D, ToBTCSwapState> implements IRefundableSwap<T, D, ToBTCSwapState> {
|
|
70
|
-
/**
|
|
71
|
-
* @internal
|
|
72
|
-
*/
|
|
73
|
-
protected readonly swapStateDescription: {
|
|
74
|
-
[-3]: string;
|
|
75
|
-
[-2]: string;
|
|
76
|
-
[-1]: string;
|
|
77
|
-
0: string;
|
|
78
|
-
1: string;
|
|
79
|
-
2: string;
|
|
80
|
-
3: string;
|
|
81
|
-
4: string;
|
|
82
|
-
};
|
|
83
|
-
/**
|
|
84
|
-
* @internal
|
|
85
|
-
*/
|
|
86
|
-
protected readonly swapStateName: (state: number) => string;
|
|
87
|
-
/**
|
|
88
|
-
* @internal
|
|
89
|
-
*/
|
|
90
|
-
protected readonly abstract outputToken: BtcToken;
|
|
91
|
-
/**
|
|
92
|
-
* @internal
|
|
93
|
-
*/
|
|
94
|
-
protected readonly networkFee: bigint;
|
|
95
|
-
/**
|
|
96
|
-
* @internal
|
|
97
|
-
*/
|
|
98
|
-
protected networkFeeBtc: bigint;
|
|
99
|
-
/**
|
|
100
|
-
* @internal
|
|
101
|
-
*/
|
|
102
|
-
readonly _data: T["Data"];
|
|
103
|
-
protected constructor(wrapper: D["Wrapper"], serializedObject: any);
|
|
104
|
-
protected constructor(wrapper: D["Wrapper"], init: IToBTCSwapInit<T["Data"]>);
|
|
105
|
-
/**
|
|
106
|
-
* @inheritDoc
|
|
107
|
-
* @internal
|
|
108
|
-
*/
|
|
109
|
-
protected getSwapData(): T["Data"];
|
|
110
|
-
/**
|
|
111
|
-
* @inheritDoc
|
|
112
|
-
* @internal
|
|
113
|
-
*/
|
|
114
|
-
protected upgradeVersion(): void;
|
|
115
|
-
/**
|
|
116
|
-
* @inheritDoc
|
|
117
|
-
* @internal
|
|
118
|
-
*/
|
|
119
|
-
protected tryRecomputeSwapPrice(): void;
|
|
120
|
-
/**
|
|
121
|
-
* Returns the payment hash identifier to be sent to the LP for getStatus and getRefund
|
|
122
|
-
* @internal
|
|
123
|
-
*/
|
|
124
|
-
protected getLpIdentifier(): string;
|
|
125
|
-
/**
|
|
126
|
-
* Sets the payment result for the swap, optionally also checking it (checking that tx exist or swap secret is valid)
|
|
127
|
-
*
|
|
128
|
-
* @param result Result returned by the LP
|
|
129
|
-
* @param check Whether to check the passed result
|
|
130
|
-
* @returns true if check passed, false if check failed with a soft error (e.g. tx not yet found in the mempool)
|
|
131
|
-
* @throws {IntermediaryError} When the data returned by the intermediary isn't valid
|
|
132
|
-
*
|
|
133
|
-
* @internal
|
|
134
|
-
*/
|
|
135
|
-
abstract _setPaymentResult(result: {
|
|
136
|
-
secret?: string;
|
|
137
|
-
txId?: string;
|
|
138
|
-
}, check?: boolean): Promise<boolean>;
|
|
139
|
-
/**
|
|
140
|
-
* @inheritDoc
|
|
141
|
-
*/
|
|
142
|
-
getInputAddress(): string | null;
|
|
143
|
-
/**
|
|
144
|
-
* @inheritDoc
|
|
145
|
-
*/
|
|
146
|
-
getInputTxId(): string | null;
|
|
147
|
-
/**
|
|
148
|
-
* @inheritDoc
|
|
149
|
-
*/
|
|
150
|
-
requiresAction(): boolean;
|
|
151
|
-
/**
|
|
152
|
-
* @inheritDoc
|
|
153
|
-
*/
|
|
154
|
-
isFinished(): boolean;
|
|
155
|
-
/**
|
|
156
|
-
* @inheritDoc
|
|
157
|
-
*/
|
|
158
|
-
isRefundable(): boolean;
|
|
159
|
-
/**
|
|
160
|
-
* @inheritDoc
|
|
161
|
-
*/
|
|
162
|
-
isQuoteExpired(): boolean;
|
|
163
|
-
/**
|
|
164
|
-
* @inheritDoc
|
|
165
|
-
*/
|
|
166
|
-
isQuoteSoftExpired(): boolean;
|
|
167
|
-
/**
|
|
168
|
-
* @inheritDoc
|
|
169
|
-
*/
|
|
170
|
-
isSuccessful(): boolean;
|
|
171
|
-
/**
|
|
172
|
-
* @inheritDoc
|
|
173
|
-
*/
|
|
174
|
-
isFailed(): boolean;
|
|
175
|
-
/**
|
|
176
|
-
* @inheritDoc
|
|
177
|
-
*/
|
|
178
|
-
isInProgress(): boolean;
|
|
179
|
-
/**
|
|
180
|
-
* Returns the time (in UNIX milliseconds) at which the swap expires and the user is able to unilaterally
|
|
181
|
-
* refund it with the {@link refund} or {@link txsRefund} function.
|
|
182
|
-
*/
|
|
183
|
-
getExpiry(): number;
|
|
184
|
-
/**
|
|
185
|
-
* @inheritDoc
|
|
186
|
-
* @internal
|
|
187
|
-
*/
|
|
188
|
-
_getInitiator(): string;
|
|
189
|
-
/**
|
|
190
|
-
* Returns the swap fee charged by the intermediary (LP) on this swap
|
|
191
|
-
*
|
|
192
|
-
* @internal
|
|
193
|
-
*/
|
|
194
|
-
protected getSwapFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
195
|
-
/**
|
|
196
|
-
* Returns network fee for on the destination chain for the swap
|
|
197
|
-
*
|
|
198
|
-
* @internal
|
|
199
|
-
*/
|
|
200
|
-
protected getNetworkFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
201
|
-
/**
|
|
202
|
-
* @inheritDoc
|
|
203
|
-
*/
|
|
204
|
-
getFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
205
|
-
/**
|
|
206
|
-
* @inheritDoc
|
|
207
|
-
*/
|
|
208
|
-
getFeeBreakdown(): [
|
|
209
|
-
{
|
|
210
|
-
type: FeeType.SWAP;
|
|
211
|
-
fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
212
|
-
},
|
|
213
|
-
{
|
|
214
|
-
type: FeeType.NETWORK_OUTPUT;
|
|
215
|
-
fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
216
|
-
}
|
|
217
|
-
];
|
|
218
|
-
/**
|
|
219
|
-
* @inheritDoc
|
|
220
|
-
*/
|
|
221
|
-
getInputToken(): SCToken<T["ChainId"]>;
|
|
222
|
-
/**
|
|
223
|
-
* @inheritDoc
|
|
224
|
-
*/
|
|
225
|
-
getInput(): TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
226
|
-
/**
|
|
227
|
-
* @inheritDoc
|
|
228
|
-
*/
|
|
229
|
-
getInputWithoutFee(): TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
230
|
-
/**
|
|
231
|
-
* Checks if the initiator/sender on the source chain has enough balance to go through with the swap
|
|
232
|
-
*/
|
|
233
|
-
hasEnoughBalance(): Promise<{
|
|
234
|
-
enoughBalance: boolean;
|
|
235
|
-
balance: TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
236
|
-
required: TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
237
|
-
}>;
|
|
238
|
-
/**
|
|
239
|
-
* Checks if the initiator/sender on the source chain has enough native token balance
|
|
240
|
-
* to cover the transaction fee of initiating the swap
|
|
241
|
-
*/
|
|
242
|
-
hasEnoughForTxFees(): Promise<{
|
|
243
|
-
enoughBalance: boolean;
|
|
244
|
-
balance: TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
245
|
-
required: TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
246
|
-
}>;
|
|
247
|
-
/**
|
|
248
|
-
* Executes the swap with the provided smart chain wallet/signer
|
|
249
|
-
*
|
|
250
|
-
* @param signer Smart chain wallet/signer to use to sign the transaction on the source chain
|
|
251
|
-
* @param callbacks Callbacks to track the progress of the swap
|
|
252
|
-
* @param options Optional options for the swap like feeRate, AbortSignal, and timeouts/intervals
|
|
253
|
-
*
|
|
254
|
-
* @returns {boolean} Whether the swap was successfully processed by the LP, in case `false` is returned
|
|
255
|
-
* the user can refund their funds back on the source chain by calling {@link refund}
|
|
256
|
-
*/
|
|
257
|
-
execute(signer: T["Signer"] | T["NativeSigner"], callbacks?: {
|
|
258
|
-
onSourceTransactionSent?: (sourceTxId: string) => void;
|
|
259
|
-
onSourceTransactionConfirmed?: (sourceTxId: string) => void;
|
|
260
|
-
onSwapSettled?: (destinationTxId: string) => void;
|
|
261
|
-
}, options?: {
|
|
262
|
-
abortSignal?: AbortSignal;
|
|
263
|
-
paymentCheckIntervalSeconds?: number;
|
|
264
|
-
maxWaitTillSwapProcessedSeconds?: number;
|
|
265
|
-
}): Promise<boolean>;
|
|
266
|
-
/**
|
|
267
|
-
* @inheritDoc
|
|
268
|
-
*
|
|
269
|
-
* @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
|
|
270
|
-
* (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
|
|
271
|
-
*/
|
|
272
|
-
txsExecute(options?: {
|
|
273
|
-
skipChecks?: boolean;
|
|
274
|
-
}): Promise<[
|
|
275
|
-
SwapExecutionActionCommit<T>
|
|
276
|
-
]>;
|
|
277
|
-
/**
|
|
278
|
-
* @inheritDoc
|
|
279
|
-
*
|
|
280
|
-
* @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
|
|
281
|
-
* (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
|
|
282
|
-
* @param options.refundSmartChainSigner Optional smart chain signer to use when creating refunds transactions
|
|
283
|
-
*/
|
|
284
|
-
getCurrentActions(options?: {
|
|
285
|
-
skipChecks?: boolean;
|
|
286
|
-
refundSmartChainSigner?: string | T["Signer"] | T["NativeSigner"];
|
|
287
|
-
}): Promise<SwapExecutionAction<T>[]>;
|
|
288
|
-
/**
|
|
289
|
-
* @inheritDoc
|
|
290
|
-
*
|
|
291
|
-
* @throws {Error} When in invalid state (not {@link ToBTCSwapState.CREATED})
|
|
292
|
-
*/
|
|
293
|
-
txsCommit(skipChecks?: boolean): Promise<T["TX"][]>;
|
|
294
|
-
/**
|
|
295
|
-
* @inheritDoc
|
|
296
|
-
*
|
|
297
|
-
* @throws {Error} If invalid signer is provided that doesn't match the swap data
|
|
298
|
-
*/
|
|
299
|
-
commit(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal, skipChecks?: boolean, onBeforeTxSent?: (txId: string) => void): Promise<string>;
|
|
300
|
-
/**
|
|
301
|
-
* @inheritDoc
|
|
302
|
-
*
|
|
303
|
-
* @throws {Error} If swap is not in the correct state (must be {@link ToBTCSwapState.CREATED})
|
|
304
|
-
*/
|
|
305
|
-
waitTillCommited(abortSignal?: AbortSignal): Promise<void>;
|
|
306
|
-
/**
|
|
307
|
-
* Waits till the swap is processed by the intermediary (LP)
|
|
308
|
-
*
|
|
309
|
-
* @param checkIntervalSeconds How often to poll the intermediary for status (5 seconds default)
|
|
310
|
-
* @param abortSignal Abort signal
|
|
311
|
-
* @internal
|
|
312
|
-
*/
|
|
313
|
-
protected waitTillIntermediarySwapProcessed(checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<RefundAuthorizationResponse>;
|
|
314
|
-
/**
|
|
315
|
-
* Checks whether the swap was already processed by the LP and is either successful (requires proof which is
|
|
316
|
-
* either a HTLC pre-image for LN swaps or valid txId for on-chain swap) or failed and we can cooperatively
|
|
317
|
-
* refund.
|
|
318
|
-
*
|
|
319
|
-
* @param save whether to save the data
|
|
320
|
-
* @returns `true` if swap is processed, `false` if the swap is still ongoing
|
|
321
|
-
*
|
|
322
|
-
* @internal
|
|
323
|
-
*/
|
|
324
|
-
protected checkIntermediarySwapProcessed(save?: boolean): Promise<boolean>;
|
|
325
|
-
/**
|
|
326
|
-
* A blocking promise resolving when swap was concluded by the intermediary (LP),
|
|
327
|
-
* rejecting in case of failure
|
|
328
|
-
*
|
|
329
|
-
* @param maxWaitTimeSeconds Maximum time in seconds to wait for the swap to be settled, an error is thrown if the
|
|
330
|
-
* swap is taking too long to claim
|
|
331
|
-
* @param checkIntervalSeconds How often to poll the intermediary for answer
|
|
332
|
-
* @param abortSignal Abort signal
|
|
333
|
-
* @returns `true` if swap was successful, `false` if swap failed and we can refund
|
|
334
|
-
*
|
|
335
|
-
* @throws {IntermediaryError} If a swap is determined expired by the intermediary, but it is actually still valid
|
|
336
|
-
* @throws {SignatureVerificationError} If the swap should be cooperatively refundable but the intermediary returned
|
|
337
|
-
* invalid refund signature
|
|
338
|
-
* @throws {Error} When swap expires or if the swap has invalid state (must be {@link ToBTCSwapState.COMMITED})
|
|
339
|
-
*/
|
|
340
|
-
waitForPayment(maxWaitTimeSeconds?: number, checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<boolean>;
|
|
341
|
-
/**
|
|
342
|
-
* Get the estimated smart chain transaction fee of the refund transaction
|
|
343
|
-
*/
|
|
344
|
-
getRefundNetworkFee(): Promise<TokenAmount<SCToken<T["ChainId"]>, true>>;
|
|
345
|
-
/**
|
|
346
|
-
* @inheritDoc
|
|
347
|
-
*
|
|
348
|
-
* @throws {IntermediaryError} If intermediary returns invalid response in case cooperative refund should be used
|
|
349
|
-
* @throws {SignatureVerificationError} If intermediary returned invalid cooperative refund signature
|
|
350
|
-
* @throws {Error} When state is not refundable
|
|
351
|
-
*/
|
|
352
|
-
txsRefund(_signer?: string | T["Signer"] | T["NativeSigner"]): Promise<T["TX"][]>;
|
|
353
|
-
/**
|
|
354
|
-
* @inheritDoc
|
|
355
|
-
*
|
|
356
|
-
* @throws {Error} If invalid signer is provided that doesn't match the swap data
|
|
357
|
-
*/
|
|
358
|
-
refund(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal): Promise<string>;
|
|
359
|
-
/**
|
|
360
|
-
* @inheritDoc
|
|
361
|
-
*
|
|
362
|
-
* @throws {Error} When swap is not in a valid state (must be {@link ToBTCSwapState.COMMITED} or
|
|
363
|
-
* {@link ToBTCSwapState.REFUNDABLE})
|
|
364
|
-
* @throws {Error} If we tried to refund but claimer was able to claim first
|
|
365
|
-
*/
|
|
366
|
-
waitTillRefunded(abortSignal?: AbortSignal): Promise<void>;
|
|
367
|
-
/**
|
|
368
|
-
* @inheritDoc
|
|
369
|
-
*/
|
|
370
|
-
serialize(): any;
|
|
371
|
-
/**
|
|
372
|
-
* Checks the swap's state on-chain and compares it to its internal state, updates/changes it according to on-chain
|
|
373
|
-
* data
|
|
374
|
-
*
|
|
375
|
-
* @private
|
|
376
|
-
*/
|
|
377
|
-
private syncStateFromChain;
|
|
378
|
-
/**
|
|
379
|
-
* @inheritDoc
|
|
380
|
-
* @internal
|
|
381
|
-
*/
|
|
382
|
-
_shouldFetchOnchainState(): boolean;
|
|
383
|
-
/**
|
|
384
|
-
* @inheritDoc
|
|
385
|
-
* @internal
|
|
386
|
-
*/
|
|
387
|
-
_shouldFetchExpiryStatus(): boolean;
|
|
388
|
-
/**
|
|
389
|
-
* @inheritDoc
|
|
390
|
-
* @internal
|
|
391
|
-
*/
|
|
392
|
-
_sync(save?: boolean, quoteDefinitelyExpired?: boolean, commitStatus?: SwapCommitState): Promise<boolean>;
|
|
393
|
-
/**
|
|
394
|
-
* @inheritDoc
|
|
395
|
-
* @internal
|
|
396
|
-
*/
|
|
397
|
-
_forciblySetOnchainState(commitStatus: SwapCommitState): Promise<boolean>;
|
|
398
|
-
/**
|
|
399
|
-
* @inheritDoc
|
|
400
|
-
* @internal
|
|
401
|
-
*/
|
|
402
|
-
_tick(save?: boolean): Promise<boolean>;
|
|
403
|
-
}
|
|
1
|
+
import { IToBTCDefinition, IToBTCWrapper } from "./IToBTCWrapper";
|
|
2
|
+
import { ChainType, SignatureData, SwapCommitState, SwapData } from "@atomiqlabs/base";
|
|
3
|
+
import { RefundAuthorizationResponse } from "../../../intermediaries/apis/IntermediaryAPI";
|
|
4
|
+
import { Fee } from "../../../types/fees/Fee";
|
|
5
|
+
import { IEscrowSelfInitSwap, IEscrowSelfInitSwapInit } from "../IEscrowSelfInitSwap";
|
|
6
|
+
import { IRefundableSwap } from "../../IRefundableSwap";
|
|
7
|
+
import { FeeType } from "../../../enums/FeeType";
|
|
8
|
+
import { TokenAmount } from "../../../types/TokenAmount";
|
|
9
|
+
import { BtcToken, SCToken } from "../../../types/Token";
|
|
10
|
+
import { SwapExecutionAction, SwapExecutionActionCommit } from "../../../types/SwapExecutionAction";
|
|
11
|
+
export type IToBTCSwapInit<T extends SwapData> = IEscrowSelfInitSwapInit<T> & {
|
|
12
|
+
signatureData?: SignatureData;
|
|
13
|
+
data: T;
|
|
14
|
+
networkFee: bigint;
|
|
15
|
+
networkFeeBtc: bigint;
|
|
16
|
+
};
|
|
17
|
+
export declare function isIToBTCSwapInit<T extends SwapData>(obj: any): obj is IToBTCSwapInit<T>;
|
|
18
|
+
/**
|
|
19
|
+
* State enum for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
|
|
20
|
+
*
|
|
21
|
+
* @category Swaps/Smart chain → Bitcoin
|
|
22
|
+
*/
|
|
23
|
+
export declare enum ToBTCSwapState {
|
|
24
|
+
/**
|
|
25
|
+
* Intermediary (LP) was unable to process the swap and the funds were refunded on the
|
|
26
|
+
* source chain
|
|
27
|
+
*/
|
|
28
|
+
REFUNDED = -3,
|
|
29
|
+
/**
|
|
30
|
+
* Swap has expired for good and there is no way how it can be executed anymore
|
|
31
|
+
*/
|
|
32
|
+
QUOTE_EXPIRED = -2,
|
|
33
|
+
/**
|
|
34
|
+
* A swap is almost expired, and it should be presented to the user as expired, though
|
|
35
|
+
* there is still a chance that it will be processed
|
|
36
|
+
*/
|
|
37
|
+
QUOTE_SOFT_EXPIRED = -1,
|
|
38
|
+
/**
|
|
39
|
+
* Swap was created, use the {@link IToBTCSwap.commit} or {@link IToBTCSwap.txsCommit} to
|
|
40
|
+
* initiate it by creating the swap escrow on the source chain
|
|
41
|
+
*/
|
|
42
|
+
CREATED = 0,
|
|
43
|
+
/**
|
|
44
|
+
* Swap escrow was initiated (committed) on the source chain, the intermediary (LP) will
|
|
45
|
+
* now process the swap. You can wait till that happens with the {@link IToBTCSwap.waitForPayment}
|
|
46
|
+
* function.
|
|
47
|
+
*/
|
|
48
|
+
COMMITED = 1,
|
|
49
|
+
/**
|
|
50
|
+
* The intermediary (LP) has processed the transaction and sent out the funds on the destination chain,
|
|
51
|
+
* but hasn't yet settled the escrow on the source chain.
|
|
52
|
+
*/
|
|
53
|
+
SOFT_CLAIMED = 2,
|
|
54
|
+
/**
|
|
55
|
+
* Swap was successfully settled by the intermediary (LP) on the source chain
|
|
56
|
+
*/
|
|
57
|
+
CLAIMED = 3,
|
|
58
|
+
/**
|
|
59
|
+
* Intermediary (LP) was unable to process the swap and the swap escrow on the source chain
|
|
60
|
+
* is refundable, call {@link IToBTCSwap.refund} or {@link IToBTCSwap.txsRefund} to refund
|
|
61
|
+
*/
|
|
62
|
+
REFUNDABLE = 4
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Base class for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
|
|
66
|
+
*
|
|
67
|
+
* @category Swaps/Smart chain → Bitcoin
|
|
68
|
+
*/
|
|
69
|
+
export declare abstract class IToBTCSwap<T extends ChainType = ChainType, D extends IToBTCDefinition<T, IToBTCWrapper<T, D>, IToBTCSwap<T, D>> = IToBTCDefinition<T, IToBTCWrapper<T, any>, IToBTCSwap<T, any>>> extends IEscrowSelfInitSwap<T, D, ToBTCSwapState> implements IRefundableSwap<T, D, ToBTCSwapState> {
|
|
70
|
+
/**
|
|
71
|
+
* @internal
|
|
72
|
+
*/
|
|
73
|
+
protected readonly swapStateDescription: {
|
|
74
|
+
[-3]: string;
|
|
75
|
+
[-2]: string;
|
|
76
|
+
[-1]: string;
|
|
77
|
+
0: string;
|
|
78
|
+
1: string;
|
|
79
|
+
2: string;
|
|
80
|
+
3: string;
|
|
81
|
+
4: string;
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* @internal
|
|
85
|
+
*/
|
|
86
|
+
protected readonly swapStateName: (state: number) => string;
|
|
87
|
+
/**
|
|
88
|
+
* @internal
|
|
89
|
+
*/
|
|
90
|
+
protected readonly abstract outputToken: BtcToken;
|
|
91
|
+
/**
|
|
92
|
+
* @internal
|
|
93
|
+
*/
|
|
94
|
+
protected readonly networkFee: bigint;
|
|
95
|
+
/**
|
|
96
|
+
* @internal
|
|
97
|
+
*/
|
|
98
|
+
protected networkFeeBtc: bigint;
|
|
99
|
+
/**
|
|
100
|
+
* @internal
|
|
101
|
+
*/
|
|
102
|
+
readonly _data: T["Data"];
|
|
103
|
+
protected constructor(wrapper: D["Wrapper"], serializedObject: any);
|
|
104
|
+
protected constructor(wrapper: D["Wrapper"], init: IToBTCSwapInit<T["Data"]>);
|
|
105
|
+
/**
|
|
106
|
+
* @inheritDoc
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
protected getSwapData(): T["Data"];
|
|
110
|
+
/**
|
|
111
|
+
* @inheritDoc
|
|
112
|
+
* @internal
|
|
113
|
+
*/
|
|
114
|
+
protected upgradeVersion(): void;
|
|
115
|
+
/**
|
|
116
|
+
* @inheritDoc
|
|
117
|
+
* @internal
|
|
118
|
+
*/
|
|
119
|
+
protected tryRecomputeSwapPrice(): void;
|
|
120
|
+
/**
|
|
121
|
+
* Returns the payment hash identifier to be sent to the LP for getStatus and getRefund
|
|
122
|
+
* @internal
|
|
123
|
+
*/
|
|
124
|
+
protected getLpIdentifier(): string;
|
|
125
|
+
/**
|
|
126
|
+
* Sets the payment result for the swap, optionally also checking it (checking that tx exist or swap secret is valid)
|
|
127
|
+
*
|
|
128
|
+
* @param result Result returned by the LP
|
|
129
|
+
* @param check Whether to check the passed result
|
|
130
|
+
* @returns true if check passed, false if check failed with a soft error (e.g. tx not yet found in the mempool)
|
|
131
|
+
* @throws {IntermediaryError} When the data returned by the intermediary isn't valid
|
|
132
|
+
*
|
|
133
|
+
* @internal
|
|
134
|
+
*/
|
|
135
|
+
abstract _setPaymentResult(result: {
|
|
136
|
+
secret?: string;
|
|
137
|
+
txId?: string;
|
|
138
|
+
}, check?: boolean): Promise<boolean>;
|
|
139
|
+
/**
|
|
140
|
+
* @inheritDoc
|
|
141
|
+
*/
|
|
142
|
+
getInputAddress(): string | null;
|
|
143
|
+
/**
|
|
144
|
+
* @inheritDoc
|
|
145
|
+
*/
|
|
146
|
+
getInputTxId(): string | null;
|
|
147
|
+
/**
|
|
148
|
+
* @inheritDoc
|
|
149
|
+
*/
|
|
150
|
+
requiresAction(): boolean;
|
|
151
|
+
/**
|
|
152
|
+
* @inheritDoc
|
|
153
|
+
*/
|
|
154
|
+
isFinished(): boolean;
|
|
155
|
+
/**
|
|
156
|
+
* @inheritDoc
|
|
157
|
+
*/
|
|
158
|
+
isRefundable(): boolean;
|
|
159
|
+
/**
|
|
160
|
+
* @inheritDoc
|
|
161
|
+
*/
|
|
162
|
+
isQuoteExpired(): boolean;
|
|
163
|
+
/**
|
|
164
|
+
* @inheritDoc
|
|
165
|
+
*/
|
|
166
|
+
isQuoteSoftExpired(): boolean;
|
|
167
|
+
/**
|
|
168
|
+
* @inheritDoc
|
|
169
|
+
*/
|
|
170
|
+
isSuccessful(): boolean;
|
|
171
|
+
/**
|
|
172
|
+
* @inheritDoc
|
|
173
|
+
*/
|
|
174
|
+
isFailed(): boolean;
|
|
175
|
+
/**
|
|
176
|
+
* @inheritDoc
|
|
177
|
+
*/
|
|
178
|
+
isInProgress(): boolean;
|
|
179
|
+
/**
|
|
180
|
+
* Returns the time (in UNIX milliseconds) at which the swap expires and the user is able to unilaterally
|
|
181
|
+
* refund it with the {@link refund} or {@link txsRefund} function.
|
|
182
|
+
*/
|
|
183
|
+
getExpiry(): number;
|
|
184
|
+
/**
|
|
185
|
+
* @inheritDoc
|
|
186
|
+
* @internal
|
|
187
|
+
*/
|
|
188
|
+
_getInitiator(): string;
|
|
189
|
+
/**
|
|
190
|
+
* Returns the swap fee charged by the intermediary (LP) on this swap
|
|
191
|
+
*
|
|
192
|
+
* @internal
|
|
193
|
+
*/
|
|
194
|
+
protected getSwapFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
195
|
+
/**
|
|
196
|
+
* Returns network fee for on the destination chain for the swap
|
|
197
|
+
*
|
|
198
|
+
* @internal
|
|
199
|
+
*/
|
|
200
|
+
protected getNetworkFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
201
|
+
/**
|
|
202
|
+
* @inheritDoc
|
|
203
|
+
*/
|
|
204
|
+
getFee(): Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
205
|
+
/**
|
|
206
|
+
* @inheritDoc
|
|
207
|
+
*/
|
|
208
|
+
getFeeBreakdown(): [
|
|
209
|
+
{
|
|
210
|
+
type: FeeType.SWAP;
|
|
211
|
+
fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
type: FeeType.NETWORK_OUTPUT;
|
|
215
|
+
fee: Fee<T["ChainId"], SCToken<T["ChainId"]>, BtcToken>;
|
|
216
|
+
}
|
|
217
|
+
];
|
|
218
|
+
/**
|
|
219
|
+
* @inheritDoc
|
|
220
|
+
*/
|
|
221
|
+
getInputToken(): SCToken<T["ChainId"]>;
|
|
222
|
+
/**
|
|
223
|
+
* @inheritDoc
|
|
224
|
+
*/
|
|
225
|
+
getInput(): TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
226
|
+
/**
|
|
227
|
+
* @inheritDoc
|
|
228
|
+
*/
|
|
229
|
+
getInputWithoutFee(): TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
230
|
+
/**
|
|
231
|
+
* Checks if the initiator/sender on the source chain has enough balance to go through with the swap
|
|
232
|
+
*/
|
|
233
|
+
hasEnoughBalance(): Promise<{
|
|
234
|
+
enoughBalance: boolean;
|
|
235
|
+
balance: TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
236
|
+
required: TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
237
|
+
}>;
|
|
238
|
+
/**
|
|
239
|
+
* Checks if the initiator/sender on the source chain has enough native token balance
|
|
240
|
+
* to cover the transaction fee of initiating the swap
|
|
241
|
+
*/
|
|
242
|
+
hasEnoughForTxFees(): Promise<{
|
|
243
|
+
enoughBalance: boolean;
|
|
244
|
+
balance: TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
245
|
+
required: TokenAmount<SCToken<T["ChainId"]>, true>;
|
|
246
|
+
}>;
|
|
247
|
+
/**
|
|
248
|
+
* Executes the swap with the provided smart chain wallet/signer
|
|
249
|
+
*
|
|
250
|
+
* @param signer Smart chain wallet/signer to use to sign the transaction on the source chain
|
|
251
|
+
* @param callbacks Callbacks to track the progress of the swap
|
|
252
|
+
* @param options Optional options for the swap like feeRate, AbortSignal, and timeouts/intervals
|
|
253
|
+
*
|
|
254
|
+
* @returns {boolean} Whether the swap was successfully processed by the LP, in case `false` is returned
|
|
255
|
+
* the user can refund their funds back on the source chain by calling {@link refund}
|
|
256
|
+
*/
|
|
257
|
+
execute(signer: T["Signer"] | T["NativeSigner"], callbacks?: {
|
|
258
|
+
onSourceTransactionSent?: (sourceTxId: string) => void;
|
|
259
|
+
onSourceTransactionConfirmed?: (sourceTxId: string) => void;
|
|
260
|
+
onSwapSettled?: (destinationTxId: string) => void;
|
|
261
|
+
}, options?: {
|
|
262
|
+
abortSignal?: AbortSignal;
|
|
263
|
+
paymentCheckIntervalSeconds?: number;
|
|
264
|
+
maxWaitTillSwapProcessedSeconds?: number;
|
|
265
|
+
}): Promise<boolean>;
|
|
266
|
+
/**
|
|
267
|
+
* @inheritDoc
|
|
268
|
+
*
|
|
269
|
+
* @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
|
|
270
|
+
* (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
|
|
271
|
+
*/
|
|
272
|
+
txsExecute(options?: {
|
|
273
|
+
skipChecks?: boolean;
|
|
274
|
+
}): Promise<[
|
|
275
|
+
SwapExecutionActionCommit<T>
|
|
276
|
+
]>;
|
|
277
|
+
/**
|
|
278
|
+
* @inheritDoc
|
|
279
|
+
*
|
|
280
|
+
* @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
|
|
281
|
+
* (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
|
|
282
|
+
* @param options.refundSmartChainSigner Optional smart chain signer to use when creating refunds transactions
|
|
283
|
+
*/
|
|
284
|
+
getCurrentActions(options?: {
|
|
285
|
+
skipChecks?: boolean;
|
|
286
|
+
refundSmartChainSigner?: string | T["Signer"] | T["NativeSigner"];
|
|
287
|
+
}): Promise<SwapExecutionAction<T>[]>;
|
|
288
|
+
/**
|
|
289
|
+
* @inheritDoc
|
|
290
|
+
*
|
|
291
|
+
* @throws {Error} When in invalid state (not {@link ToBTCSwapState.CREATED})
|
|
292
|
+
*/
|
|
293
|
+
txsCommit(skipChecks?: boolean): Promise<T["TX"][]>;
|
|
294
|
+
/**
|
|
295
|
+
* @inheritDoc
|
|
296
|
+
*
|
|
297
|
+
* @throws {Error} If invalid signer is provided that doesn't match the swap data
|
|
298
|
+
*/
|
|
299
|
+
commit(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal, skipChecks?: boolean, onBeforeTxSent?: (txId: string) => void): Promise<string>;
|
|
300
|
+
/**
|
|
301
|
+
* @inheritDoc
|
|
302
|
+
*
|
|
303
|
+
* @throws {Error} If swap is not in the correct state (must be {@link ToBTCSwapState.CREATED})
|
|
304
|
+
*/
|
|
305
|
+
waitTillCommited(abortSignal?: AbortSignal): Promise<void>;
|
|
306
|
+
/**
|
|
307
|
+
* Waits till the swap is processed by the intermediary (LP)
|
|
308
|
+
*
|
|
309
|
+
* @param checkIntervalSeconds How often to poll the intermediary for status (5 seconds default)
|
|
310
|
+
* @param abortSignal Abort signal
|
|
311
|
+
* @internal
|
|
312
|
+
*/
|
|
313
|
+
protected waitTillIntermediarySwapProcessed(checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<RefundAuthorizationResponse>;
|
|
314
|
+
/**
|
|
315
|
+
* Checks whether the swap was already processed by the LP and is either successful (requires proof which is
|
|
316
|
+
* either a HTLC pre-image for LN swaps or valid txId for on-chain swap) or failed and we can cooperatively
|
|
317
|
+
* refund.
|
|
318
|
+
*
|
|
319
|
+
* @param save whether to save the data
|
|
320
|
+
* @returns `true` if swap is processed, `false` if the swap is still ongoing
|
|
321
|
+
*
|
|
322
|
+
* @internal
|
|
323
|
+
*/
|
|
324
|
+
protected checkIntermediarySwapProcessed(save?: boolean): Promise<boolean>;
|
|
325
|
+
/**
|
|
326
|
+
* A blocking promise resolving when swap was concluded by the intermediary (LP),
|
|
327
|
+
* rejecting in case of failure
|
|
328
|
+
*
|
|
329
|
+
* @param maxWaitTimeSeconds Maximum time in seconds to wait for the swap to be settled, an error is thrown if the
|
|
330
|
+
* swap is taking too long to claim
|
|
331
|
+
* @param checkIntervalSeconds How often to poll the intermediary for answer
|
|
332
|
+
* @param abortSignal Abort signal
|
|
333
|
+
* @returns `true` if swap was successful, `false` if swap failed and we can refund
|
|
334
|
+
*
|
|
335
|
+
* @throws {IntermediaryError} If a swap is determined expired by the intermediary, but it is actually still valid
|
|
336
|
+
* @throws {SignatureVerificationError} If the swap should be cooperatively refundable but the intermediary returned
|
|
337
|
+
* invalid refund signature
|
|
338
|
+
* @throws {Error} When swap expires or if the swap has invalid state (must be {@link ToBTCSwapState.COMMITED})
|
|
339
|
+
*/
|
|
340
|
+
waitForPayment(maxWaitTimeSeconds?: number, checkIntervalSeconds?: number, abortSignal?: AbortSignal): Promise<boolean>;
|
|
341
|
+
/**
|
|
342
|
+
* Get the estimated smart chain transaction fee of the refund transaction
|
|
343
|
+
*/
|
|
344
|
+
getRefundNetworkFee(): Promise<TokenAmount<SCToken<T["ChainId"]>, true>>;
|
|
345
|
+
/**
|
|
346
|
+
* @inheritDoc
|
|
347
|
+
*
|
|
348
|
+
* @throws {IntermediaryError} If intermediary returns invalid response in case cooperative refund should be used
|
|
349
|
+
* @throws {SignatureVerificationError} If intermediary returned invalid cooperative refund signature
|
|
350
|
+
* @throws {Error} When state is not refundable
|
|
351
|
+
*/
|
|
352
|
+
txsRefund(_signer?: string | T["Signer"] | T["NativeSigner"]): Promise<T["TX"][]>;
|
|
353
|
+
/**
|
|
354
|
+
* @inheritDoc
|
|
355
|
+
*
|
|
356
|
+
* @throws {Error} If invalid signer is provided that doesn't match the swap data
|
|
357
|
+
*/
|
|
358
|
+
refund(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal): Promise<string>;
|
|
359
|
+
/**
|
|
360
|
+
* @inheritDoc
|
|
361
|
+
*
|
|
362
|
+
* @throws {Error} When swap is not in a valid state (must be {@link ToBTCSwapState.COMMITED} or
|
|
363
|
+
* {@link ToBTCSwapState.REFUNDABLE})
|
|
364
|
+
* @throws {Error} If we tried to refund but claimer was able to claim first
|
|
365
|
+
*/
|
|
366
|
+
waitTillRefunded(abortSignal?: AbortSignal): Promise<void>;
|
|
367
|
+
/**
|
|
368
|
+
* @inheritDoc
|
|
369
|
+
*/
|
|
370
|
+
serialize(): any;
|
|
371
|
+
/**
|
|
372
|
+
* Checks the swap's state on-chain and compares it to its internal state, updates/changes it according to on-chain
|
|
373
|
+
* data
|
|
374
|
+
*
|
|
375
|
+
* @private
|
|
376
|
+
*/
|
|
377
|
+
private syncStateFromChain;
|
|
378
|
+
/**
|
|
379
|
+
* @inheritDoc
|
|
380
|
+
* @internal
|
|
381
|
+
*/
|
|
382
|
+
_shouldFetchOnchainState(): boolean;
|
|
383
|
+
/**
|
|
384
|
+
* @inheritDoc
|
|
385
|
+
* @internal
|
|
386
|
+
*/
|
|
387
|
+
_shouldFetchExpiryStatus(): boolean;
|
|
388
|
+
/**
|
|
389
|
+
* @inheritDoc
|
|
390
|
+
* @internal
|
|
391
|
+
*/
|
|
392
|
+
_sync(save?: boolean, quoteDefinitelyExpired?: boolean, commitStatus?: SwapCommitState): Promise<boolean>;
|
|
393
|
+
/**
|
|
394
|
+
* @inheritDoc
|
|
395
|
+
* @internal
|
|
396
|
+
*/
|
|
397
|
+
_forciblySetOnchainState(commitStatus: SwapCommitState): Promise<boolean>;
|
|
398
|
+
/**
|
|
399
|
+
* @inheritDoc
|
|
400
|
+
* @internal
|
|
401
|
+
*/
|
|
402
|
+
_tick(save?: boolean): Promise<boolean>;
|
|
403
|
+
}
|