@atomiqlabs/sdk 8.3.6 → 8.4.4

package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.js

@@ -100,6 +100,7 @@ class FromBTCLNAutoWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
                 return false;
             }
             swap._commitTxId = event.meta?.txId;
+            swap._commitedAt ??= Date.now();
             swap._state = FromBTCLNAutoSwap_1.FromBTCLNAutoSwapState.CLAIM_COMMITED;
             swap._broadcastSecret().catch(e => {
                 this.logger.error("processEventInitialize(" + swap.getId() + "): Error when broadcasting swap secret: ", e);
@@ -177,6 +178,8 @@ class FromBTCLNAutoWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
             throw new IntermediaryError_1.IntermediaryError("Invalid intermediary address/pubkey");
         if (options.descriptionHash != null && decodedPr.tagsObject.purpose_commit_hash !== options.descriptionHash.toString("hex"))
             throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - description hash");
+        if (options.description != null && decodedPr.tagsObject.description !== options.description)
+            throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - description");
         if (decodedPr.tagsObject.payment_hash == null ||
             !buffer_1.Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash))
             throw new IntermediaryError_1.IntermediaryError("Invalid pr returned - payment hash");
@@ -215,18 +218,33 @@ class FromBTCLNAutoWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
      * @param preFetches Optional pre-fetches for speeding up the quoting process (mainly used internally)
      */
     create(recipient, amountData, lps, options, additionalParams, abortSignal, preFetches) {
+        if (!this.isInitialized)
+            throw new Error("Not initialized, call init() first!");
         const _options = {
+            paymentHash: options?.paymentHash,
             unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck,
             gasAmount: options?.gasAmount ?? 0n,
             feeSafetyFactor: options?.feeSafetyFactor ?? 1.25,
             unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false,
+            description: options?.description,
             descriptionHash: options?.descriptionHash
         };
-        if (preFetches == null)
-            preFetches = {};
+        if (_options.paymentHash != null && _options.paymentHash.length !== 32)
+            throw new UserError_1.UserError("Invalid payment hash length, must be exactly 32 bytes!");
         if (_options.descriptionHash != null && _options.descriptionHash.length !== 32)
             throw new UserError_1.UserError("Invalid description hash length");
-        const { secret, paymentHash } = this.getSecretAndHash();
+        if (_options.description != null && buffer_1.Buffer.byteLength(_options.description, "utf8") > 500)
+            throw new UserError_1.UserError("Invalid description length");
+        if (preFetches == null)
+            preFetches = {};
+        let secret;
+        let paymentHash;
+        if (_options?.paymentHash != null) {
+            paymentHash = _options.paymentHash;
+        }
+        else {
+            ({ secret, paymentHash } = this.getSecretAndHash());
+        }
         const claimHash = this._contract.getHashForHtlc(paymentHash);
         const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
         const _abortController = (0, Utils_1.extendAbortController)(abortSignal);
@@ -252,6 +270,7 @@ class FromBTCLNAutoWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
                             amount: amountData.amount,
                             claimer: recipient,
                             token: amountData.token.toString(),
+                            description: _options.description,
                             descriptionHash: _options.descriptionHash,
                             exactOut: !amountData.exactIn,
                             additionalParams,
@@ -293,7 +312,7 @@ class FromBTCLNAutoWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
                             gasPricingInfo,
                             initialSwapData: await this._contract.createSwapData(base_1.ChainSwapType.HTLC, lp.getAddress(this.chainIdentifier), recipient, amountData.token, resp.total, claimHash.toString("hex"), this.getRandomSequence(), BigInt(Math.floor(Date.now() / 1000)), false, true, _options.gasAmount + resp.claimerBounty, resp.claimerBounty, nativeTokenAddress),
                             pr: resp.pr,
-                            secret: secret.toString("hex"),
+                            secret: secret?.toString("hex"),
                             exactIn: amountData.exactIn ?? true
                         };
                         const quote = new FromBTCLNAutoSwap_1.FromBTCLNAutoSwap(this, swapInit);
@@ -326,13 +345,19 @@ class FromBTCLNAutoWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
      * @param abortSignal Abort signal
      */
     async createViaLNURL(recipient, lnurl, amountData, lps, options, additionalParams, abortSignal) {
+        if (!this.isInitialized)
+            throw new Error("Not initialized, call init() first!");
         const _options = {
+            paymentHash: options?.paymentHash,
             unsafeSkipLnNodeCheck: options?.unsafeSkipLnNodeCheck ?? this._options.unsafeSkipLnNodeCheck,
             gasAmount: options?.gasAmount ?? 0n,
             feeSafetyFactor: options?.feeSafetyFactor ?? 1.25,
             unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false,
+            description: options?.description,
             descriptionHash: options?.descriptionHash
         };
+        if (_options.paymentHash != null && _options.paymentHash.length !== 32)
+            throw new UserError_1.UserError("Invalid payment hash length, must be exactly 32 bytes!");
         const abortController = (0, Utils_1.extendAbortController)(abortSignal);
         const preFetches = {
             pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
@@ -472,6 +497,7 @@ class FromBTCLNAutoWrapper extends IFromBTCLNWrapper_1.IFromBTCLNWrapper {
         swap._commitTxId = await init.getInitTxId();
         const blockData = await init.getTxBlock();
         swap.createdAt = blockData.blockTime * 1000;
+        swap._commitedAt = blockData.blockTime * 1000;
         swap._setInitiated();
         swap._state = FromBTCLNAutoSwap_1.FromBTCLNAutoSwapState.CLAIM_COMMITED;
         await swap._sync(false, false, state);

package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.d.ts

@@ -12,6 +12,7 @@ import { IAddressSwap } from "../../../IAddressSwap";
 import { TokenAmount } from "../../../../types/TokenAmount";
 import { BtcToken, SCToken } from "../../../../types/Token";
 import { LoggerType } from "../../../../utils/Logger";
+import { SwapExecutionAction } from "../../../../types/SwapExecutionAction";
 /**
  * State enum for legacy escrow based Bitcoin -> Smart chain swaps.
  *
@@ -50,9 +51,9 @@ export declare enum FromBTCSwapState {
      */
     CLAIM_COMMITED = 1,
     /**
-     * Input bitcoin transaction was confirmed, wait for automatic settlement by the watchtower
-     *  or settle manually using the {@link FromBTCSwap.claim} or {@link FromBTCSwap.txsClaim}
-     *  function.
+     * Input bitcoin transaction was confirmed, wait for automatic settlement by the watchtowers
+     *  using the {@link FromBTCSwap.waitTillClaimed} function or settle manually using the {@link FromBTCSwap.claim}
+     *  or {@link FromBTCSwap.txsClaim} function.
      */
     BTC_TX_CONFIRMED = 2,
     /**
@@ -75,6 +76,23 @@ export declare function isFromBTCSwapInit<T extends SwapData>(obj: any): obj is
  */
 export declare class FromBTCSwap<T extends ChainType = ChainType> extends IFromBTCSelfInitSwap<T, FromBTCDefinition<T>, FromBTCSwapState> implements IBTCWalletSwap, IClaimableSwap<T, FromBTCDefinition<T>, FromBTCSwapState>, IAddressSwap {
     protected readonly TYPE: SwapType.FROM_BTC;
+    /**
+     * @internal
+     */
+    protected readonly swapStateName: (state: number) => string;
+    /**
+     * @internal
+     */
+    protected readonly swapStateDescription: {
+        [-4]: string;
+        [-3]: string;
+        [-2]: string;
+        [-1]: string;
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+    };
     /**
      * @internal
      */
@@ -97,6 +115,7 @@ export declare class FromBTCSwap<T extends ChainType = ChainType> extends IFromB
     private senderAddress?;
     private txId?;
     private vout?;
+    private btcTxConfirmedAt?;
     constructor(wrapper: FromBTCWrapper<T>, init: FromBTCSwapInit<T["Data"]>);
     constructor(wrapper: FromBTCWrapper<T>, obj: any);
     /**
@@ -156,6 +175,10 @@ export declare class FromBTCSwap<T extends ChainType = ChainType> extends IFromB
      * @inheritDoc
      */
     isFailed(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      */
@@ -293,6 +316,7 @@ export declare class FromBTCSwap<T extends ChainType = ChainType> extends IFromB
     /**
      * @inheritDoc
      *
+     * @param options.bitcoinFeeRate Optional fee rate to use for the created Bitcoin transaction
      * @param options.bitcoinWallet Bitcoin wallet to use, when provided the function returns a funded
      *  psbt (`"FUNDED_PSBT"`), if not passed just a bitcoin receive address is returned (`"ADDRESS"`)
      * @param options.skipChecks Skip checks like making sure init signature is still valid and swap
@@ -302,6 +326,7 @@ export declare class FromBTCSwap<T extends ChainType = ChainType> extends IFromB
      * @throws {Error} if the swap or quote is expired, or if triggered in invalid state
      */
     txsExecute(options?: {
+        bitcoinFeeRate?: number;
         bitcoinWallet?: MinimalBitcoinWalletInterface;
         skipChecks?: boolean;
     }): Promise<({
@@ -329,6 +354,26 @@ export declare class FromBTCSwap<T extends ChainType = ChainType> extends IFromB
             hyperlink?: undefined;
         })[];
     })[]>;
+    /**
+     * @inheritDoc
+     *
+     * @param options.bitcoinFeeRate Optional fee rate to use for the created Bitcoin transaction
+     * @param options.bitcoinWallet Bitcoin wallet to use, when provided the function returns a funded
+     *  psbt (`"FUNDED_PSBT"`), if not passed just a bitcoin receive address is returned (`"ADDRESS"`)
+     * @param options.skipChecks Skip checks like making sure init signature is still valid and swap
+     *  wasn't commited yet (this is handled on swap creation, if you commit right after quoting, you
+     *  can use `skipChecks=true`)
+     * @param options.manualSettlementSmartChainSigner Optional smart chain signer to create a manual claim (settlement) transaction
+     * @param options.maxWaitTillAutomaticSettlementSeconds Maximum time to wait for an automatic settlement after
+     *  the bitcoin transaction is confirmed (defaults to 60 seconds)
+     */
+    getCurrentActions(options?: {
+        bitcoinFeeRate?: number;
+        bitcoinWallet?: MinimalBitcoinWalletInterface;
+        skipChecks?: boolean;
+        manualSettlementSmartChainSigner?: string | T["Signer"] | T["NativeSigner"];
+        maxWaitTillAutomaticSettlementSeconds?: number;
+    }): Promise<SwapExecutionAction<T>[]>;
     /**
      * @inheritDoc
      *

package/dist/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.js

@@ -54,9 +54,9 @@ var FromBTCSwapState;
      */
     FromBTCSwapState[FromBTCSwapState["CLAIM_COMMITED"] = 1] = "CLAIM_COMMITED";
     /**
-     * Input bitcoin transaction was confirmed, wait for automatic settlement by the watchtower
-     *  or settle manually using the {@link FromBTCSwap.claim} or {@link FromBTCSwap.txsClaim}
-     *  function.
+     * Input bitcoin transaction was confirmed, wait for automatic settlement by the watchtowers
+     *  using the {@link FromBTCSwap.waitTillClaimed} function or settle manually using the {@link FromBTCSwap.claim}
+     *  or {@link FromBTCSwap.txsClaim} function.
      */
     FromBTCSwapState[FromBTCSwapState["BTC_TX_CONFIRMED"] = 2] = "BTC_TX_CONFIRMED";
     /**
@@ -64,6 +64,16 @@ var FromBTCSwapState;
      */
     FromBTCSwapState[FromBTCSwapState["CLAIM_CLAIMED"] = 3] = "CLAIM_CLAIMED";
 })(FromBTCSwapState = exports.FromBTCSwapState || (exports.FromBTCSwapState = {}));
+const FromBTCSwapStateDescription = {
+    [FromBTCSwapState.FAILED]: "Bitcoin swap address has expired and the intermediary (LP) has already refunded its funds. No BTC should be sent anymore!",
+    [FromBTCSwapState.EXPIRED]: "Bitcoin swap address has expired, user should not send any BTC anymore! Though the intermediary (LP) hasn't refunded yet. So if there is a transaction already in-flight the swap might still succeed.",
+    [FromBTCSwapState.QUOTE_EXPIRED]: "Swap has expired for good and there is no way how it can be executed anymore",
+    [FromBTCSwapState.QUOTE_SOFT_EXPIRED]: "The swap is expired, though there is still a chance that it will be processed",
+    [FromBTCSwapState.PR_CREATED]: "Swap quote was created, initiate it by creating the swap escrow on the destination smart chain",
+    [FromBTCSwapState.CLAIM_COMMITED]: "Swap escrow was initiated (committed) on the destination chain, user can send the BTC to the Bitcoin swap address.",
+    [FromBTCSwapState.BTC_TX_CONFIRMED]: "Input bitcoin transaction was confirmed, wait for automatic settlement by the watchtower or settle manually.",
+    [FromBTCSwapState.CLAIM_CLAIMED]: "Swap successfully settled and funds received on the destination chain"
+};
 function isFromBTCSwapInit(obj) {
     return typeof (obj.data) === "object" &&
         (obj.address == null || typeof (obj.address) === "string") &&
@@ -84,6 +94,14 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
             initOrObject.url += "/frombtc";
         super(wrapper, initOrObject);
         this.TYPE = SwapType_1.SwapType.FROM_BTC;
+        /**
+         * @internal
+         */
+        this.swapStateName = (state) => FromBTCSwapState[state];
+        /**
+         * @internal
+         */
+        this.swapStateDescription = FromBTCSwapStateDescription;
         /**
          * @internal
          */
@@ -103,6 +121,7 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
             this.txId = initOrObject.txId;
             this.vout = initOrObject.vout;
             this.requiredConfirmations = initOrObject.requiredConfirmations ?? this._data.getConfirmationsHint();
+            this.btcTxConfirmedAt = initOrObject.btcTxConfirmedAt;
         }
         this.tryRecomputeSwapPrice();
         this.logger = (0, Logger_1.getLogger)("FromBTC(" + this.getIdentifierHashString() + "): ");
@@ -218,6 +237,13 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
     isFailed() {
         return this._state === FromBTCSwapState.FAILED || this._state === FromBTCSwapState.EXPIRED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return this._state === FromBTCSwapState.CLAIM_COMMITED ||
+            this._state === FromBTCSwapState.BTC_TX_CONFIRMED;
+    }
     /**
      * @inheritDoc
      */
@@ -415,6 +441,7 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
             this.senderAddress = result.tx.inputAddresses[0];
         if (this._state !== FromBTCSwapState.CLAIM_CLAIMED &&
             this._state !== FromBTCSwapState.FAILED) {
+            this.btcTxConfirmedAt ??= Date.now();
             this._state = FromBTCSwapState.BTC_TX_CONFIRMED;
         }
         await this._saveAndEmit();
@@ -598,6 +625,7 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
     /**
      * @inheritDoc
      *
+     * @param options.bitcoinFeeRate Optional fee rate to use for the created Bitcoin transaction
      * @param options.bitcoinWallet Bitcoin wallet to use, when provided the function returns a funded
      *  psbt (`"FUNDED_PSBT"`), if not passed just a bitcoin receive address is returned (`"ADDRESS"`)
      * @param options.skipChecks Skip checks like making sure init signature is still valid and swap
@@ -661,6 +689,40 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
         }
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED or CLAIM_COMMITED");
     }
+    /**
+     * @inheritDoc
+     *
+     * @param options.bitcoinFeeRate Optional fee rate to use for the created Bitcoin transaction
+     * @param options.bitcoinWallet Bitcoin wallet to use, when provided the function returns a funded
+     *  psbt (`"FUNDED_PSBT"`), if not passed just a bitcoin receive address is returned (`"ADDRESS"`)
+     * @param options.skipChecks Skip checks like making sure init signature is still valid and swap
+     *  wasn't commited yet (this is handled on swap creation, if you commit right after quoting, you
+     *  can use `skipChecks=true`)
+     * @param options.manualSettlementSmartChainSigner Optional smart chain signer to create a manual claim (settlement) transaction
+     * @param options.maxWaitTillAutomaticSettlementSeconds Maximum time to wait for an automatic settlement after
+     *  the bitcoin transaction is confirmed (defaults to 60 seconds)
+     */
+    async getCurrentActions(options) {
+        if (this._state === FromBTCSwapState.PR_CREATED || this._state === FromBTCSwapState.CLAIM_COMMITED) {
+            try {
+                return await this.txsExecute(options);
+            }
+            catch (e) { }
+        }
+        if (this.isClaimable()) {
+            if (this.btcTxConfirmedAt == null ||
+                options?.maxWaitTillAutomaticSettlementSeconds === 0 ||
+                (Date.now() - this.btcTxConfirmedAt) > (options?.maxWaitTillAutomaticSettlementSeconds ?? 60) * 1000) {
+                return [{
+                        name: "Claim",
+                        description: "Manually settle (claim) the swap on the destination smart chain",
+                        chain: this.chainIdentifier,
+                        txs: await this.txsClaim(options?.manualSettlementSmartChainSigner)
+                    }];
+            }
+        }
+        return [];
+    }
     //////////////////////////////
     //// Commit
     /**
@@ -889,7 +951,8 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
             requiredConfirmations: this.requiredConfirmations,
             senderAddress: this.senderAddress,
             txId: this.txId,
-            vout: this.vout
+            vout: this.vout,
+            btcTxConfirmedAt: this.btcTxConfirmedAt
         };
     }
     //////////////////////////////
@@ -992,6 +1055,7 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
                         save = true;
                     }
                     if (this.requiredConfirmations != null && res.confirmations >= this.requiredConfirmations) {
+                        this.btcTxConfirmedAt ??= Date.now();
                         this._state = FromBTCSwapState.BTC_TX_CONFIRMED;
                         save = true;
                     }
@@ -1037,6 +1101,7 @@ class FromBTCSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
                                     shouldSave = true;
                                 }
                                 if (this.requiredConfirmations != null && res.confirmations >= this.requiredConfirmations) {
+                                    this.btcTxConfirmedAt ??= Date.now();
                                     this._state = FromBTCSwapState.BTC_TX_CONFIRMED;
                                     if (save)
                                         await this._saveAndEmit();

package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.d.ts

@@ -7,7 +7,7 @@ import { IRefundableSwap } from "../../IRefundableSwap";
 import { FeeType } from "../../../enums/FeeType";
 import { TokenAmount } from "../../../types/TokenAmount";
 import { BtcToken, SCToken } from "../../../types/Token";
-import { SwapExecutionActionCommit } from "../../../types/SwapExecutionAction";
+import { SwapExecutionAction, SwapExecutionActionCommit } from "../../../types/SwapExecutionAction";
 export type IToBTCSwapInit<T extends SwapData> = IEscrowSelfInitSwapInit<T> & {
     signatureData?: SignatureData;
     data: T;
@@ -67,6 +67,23 @@ export declare enum ToBTCSwapState {
  * @category Swaps/Smart chain → Bitcoin
  */
 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> {
+    /**
+     * @internal
+     */
+    protected readonly swapStateDescription: {
+        [-3]: string;
+        [-2]: string;
+        [-1]: string;
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+    };
+    /**
+     * @internal
+     */
+    protected readonly swapStateName: (state: number) => string;
     /**
      * @internal
      */
@@ -155,6 +172,15 @@ export declare abstract class IToBTCSwap<T extends ChainType = ChainType, D exte
      * @inheritDoc
      */
     isFailed(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
+    /**
+     * Returns the time (in UNIX milliseconds) at which the swap expires and the user is able to unilaterally
+     *  refund it with the {@link refund} or {@link txsRefund} function.
+     */
+    getExpiry(): number;
     /**
      * @inheritDoc
      * @internal
@@ -239,6 +265,7 @@ export declare abstract class IToBTCSwap<T extends ChainType = ChainType, D exte
     }): Promise<boolean>;
     /**
      * @inheritDoc
+     *
      * @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
      *  (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
      */
@@ -247,6 +274,17 @@ export declare abstract class IToBTCSwap<T extends ChainType = ChainType, D exte
     }): Promise<[
         SwapExecutionActionCommit<T>
     ]>;
+    /**
+     * @inheritDoc
+     *
+     * @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
+     *  (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
+     * @param options.refundSmartChainSigner Optional smart chain signer to use when creating refunds transactions
+     */
+    getCurrentActions(options?: {
+        skipChecks?: boolean;
+        refundSmartChainSigner?: string | T["Signer"] | T["NativeSigner"];
+    }): Promise<SwapExecutionAction<T>[]>;
     /**
      * @inheritDoc
      *
@@ -311,7 +349,7 @@ export declare abstract class IToBTCSwap<T extends ChainType = ChainType, D exte
      * @throws {SignatureVerificationError} If intermediary returned invalid cooperative refund signature
      * @throws {Error} When state is not refundable
      */
-    txsRefund(signer?: string): Promise<T["TX"][]>;
+    txsRefund(_signer?: string | T["Signer"] | T["NativeSigner"]): Promise<T["TX"][]>;
     /**
      * @inheritDoc
      *

package/dist/swaps/escrow_swaps/tobtc/IToBTCSwap.js

@@ -68,6 +68,16 @@ var ToBTCSwapState;
      */
     ToBTCSwapState[ToBTCSwapState["REFUNDABLE"] = 4] = "REFUNDABLE";
 })(ToBTCSwapState = exports.ToBTCSwapState || (exports.ToBTCSwapState = {}));
+const ToBTCSwapStateDescription = {
+    [ToBTCSwapState.REFUNDED]: "Intermediary (LP) was unable to process the swap and the funds were refunded on the source chain",
+    [ToBTCSwapState.QUOTE_EXPIRED]: "Swap has expired for good and there is no way how it can be executed anymore",
+    [ToBTCSwapState.QUOTE_SOFT_EXPIRED]: "A swap is expired, though there is still a chance that it will be processed",
+    [ToBTCSwapState.CREATED]: "Swap was created, initiate it by creating the swap escrow on the source chain",
+    [ToBTCSwapState.COMMITED]: "Swap escrow was initiated (committed) on the source chain, the intermediary (LP) will now process the swap.",
+    [ToBTCSwapState.SOFT_CLAIMED]: "The intermediary (LP) has processed the transaction and sent out the funds on the destination chain, but hasn't yet settled the escrow on the source chain.",
+    [ToBTCSwapState.CLAIMED]: "Swap was successfully settled by the intermediary (LP) on the source chain",
+    [ToBTCSwapState.REFUNDABLE]: "Intermediary (LP) was unable to process the swap and the swap escrow on the source chain is refundable."
+};
 /**
  * Base class for escrow-based Smart chain -> Bitcoin (on-chain & lightning) swaps
  *
@@ -76,6 +86,14 @@ var ToBTCSwapState;
 class IToBTCSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
     constructor(wrapper, initOrObject) {
         super(wrapper, initOrObject);
+        /**
+         * @internal
+         */
+        this.swapStateDescription = ToBTCSwapStateDescription;
+        /**
+         * @internal
+         */
+        this.swapStateName = (state) => ToBTCSwapState[state];
         if (isIToBTCSwapInit(initOrObject)) {
             this._state = ToBTCSwapState.CREATED;
             this.networkFee = initOrObject.networkFee;
@@ -203,6 +221,19 @@ class IToBTCSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
     isFailed() {
         return this._state === ToBTCSwapState.REFUNDED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return this._state === ToBTCSwapState.COMMITED || this._state === ToBTCSwapState.SOFT_CLAIMED;
+    }
+    /**
+     * Returns the time (in UNIX milliseconds) at which the swap expires and the user is able to unilaterally
+     *  refund it with the {@link refund} or {@link txsRefund} function.
+     */
+    getExpiry() {
+        return Number(this._data.getExpiry()) * 1000;
+    }
     /**
      * @inheritDoc
      * @internal
@@ -373,6 +404,7 @@ class IToBTCSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
     }
     /**
      * @inheritDoc
+     *
      * @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
      *  (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
      */
@@ -389,6 +421,30 @@ class IToBTCSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
             }
         ];
     }
+    /**
+     * @inheritDoc
+     *
+     * @param options.skipChecks Skip checks like making sure init signature is still valid and swap wasn't commited yet
+     *  (this is handled on swap creation, if you commit right after quoting, you can use `skipChecks=true`)
+     * @param options.refundSmartChainSigner Optional smart chain signer to use when creating refunds transactions
+     */
+    async getCurrentActions(options) {
+        if (this._state === ToBTCSwapState.CREATED) {
+            try {
+                return await this.txsExecute(options);
+            }
+            catch (e) { }
+        }
+        if (this.isRefundable()) {
+            return [{
+                    name: "Refund",
+                    description: "Refund the swap after it failed to execute",
+                    chain: this.chainIdentifier,
+                    txs: await this.txsRefund(options?.refundSmartChainSigner)
+                }];
+        }
+        return [];
+    }
     //////////////////////////////
     //// Commit
     /**
@@ -623,10 +679,24 @@ class IToBTCSwap extends IEscrowSelfInitSwap_1.IEscrowSelfInitSwap {
      * @throws {SignatureVerificationError} If intermediary returned invalid cooperative refund signature
      * @throws {Error} When state is not refundable
      */
-    async txsRefund(signer) {
+    async txsRefund(_signer) {
         if (!this.isRefundable())
             throw new Error("Must be in REFUNDABLE state or expired!");
-        signer ??= this._getInitiator();
+        let signer;
+        if (_signer != null) {
+            if (typeof (_signer) === "string") {
+                signer = _signer;
+            }
+            else if ((0, base_1.isAbstractSigner)(_signer)) {
+                signer = _signer.getAddress();
+            }
+            else {
+                signer = (await this.wrapper._chain.wrapSigner(_signer)).getAddress();
+            }
+        }
+        else {
+            signer = this._getInitiator();
+        }
         if (await this.wrapper._contract.isExpired(this._getInitiator(), this._data)) {
             return await this.wrapper._contract.txsRefund(signer, this._data, true, true);
         }

package/dist/swaps/spv_swaps/SpvFromBTCSwap.d.ts

@@ -14,7 +14,7 @@ import { TokenAmount } from "../../types/TokenAmount";
 import { BtcToken, SCToken } from "../../types/Token";
 import { LoggerType } from "../../utils/Logger";
 import { PriceInfoType } from "../../types/PriceInfoType";
-import { SwapExecutionActionBitcoin } from "../../types/SwapExecutionAction";
+import { SwapExecutionAction, SwapExecutionActionBitcoin } from "../../types/SwapExecutionAction";
 /**
  * State enum for SPV vault (UTXO-controlled vault) based swaps
  * @category Swaps/Bitcoin → Smart chain
@@ -120,6 +120,27 @@ export declare function isSpvFromBTCSwapInit(obj: any): obj is SpvFromBTCSwapIni
  */
 export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFromBTCTypeDefinition<T>> implements IBTCWalletSwap, ISwapWithGasDrop<T>, IClaimableSwap<T, SpvFromBTCTypeDefinition<T>, SpvFromBTCSwapState> {
     readonly TYPE: SwapType.SPV_VAULT_FROM_BTC;
+    /**
+     * @internal
+     */
+    protected readonly swapStateDescription: {
+        [-5]: string;
+        [-4]: string;
+        [-3]: string;
+        [-2]: string;
+        [-1]: string;
+        0: string;
+        1: string;
+        2: string;
+        3: string;
+        4: string;
+        5: string;
+        6: string;
+    };
+    /**
+     * @internal
+     */
+    protected readonly swapStateName: (state: number) => string;
     /**
      * @inheritDoc
      * @internal
@@ -172,6 +193,11 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
      * Minimum fee rate in sats/vB that the input bitcoin transaction needs to pay
      */
     readonly minimumBtcFeeRate: number;
+    /**
+     * Time at which the SDK realized the bitcoin transaction was confirmed
+     * @private
+     */
+    private btcTxConfirmedAt?;
     constructor(wrapper: SpvFromBTCWrapper<T>, init: SpvFromBTCSwapInit);
     constructor(wrapper: SpvFromBTCWrapper<T>, obj: any);
     /**
@@ -252,6 +278,10 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
      * @inheritDoc
      */
     isFailed(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      */
@@ -440,16 +470,36 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
     /**
      * @inheritDoc
      *
+     * @param options.bitcoinFeeRate Optional fee rate to use for the created Bitcoin transaction
      * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
      *  if not provided a raw PSBT is returned instead which necessitates the implementor to manually add
      *  inputs to the bitcoin transaction and **set the nSequence field of the 2nd input** (input 1 -
      *  indexing from 0) to the value returned in `in1sequence`
      */
     txsExecute(options?: {
+        bitcoinFeeRate?: number;
         bitcoinWallet?: MinimalBitcoinWalletInterface;
     }): Promise<[
         SwapExecutionActionBitcoin<"RAW_PSBT" | "FUNDED_PSBT">
     ]>;
+    /**
+     * @inheritDoc
+     *
+     * @param options.bitcoinFeeRate Optional fee rate to use for the created Bitcoin transaction
+     * @param options.bitcoinWallet Optional bitcoin wallet address specification to return a funded PSBT,
+     *  if not provided a raw PSBT is returned instead which necessitates the implementor to manually add
+     *  inputs to the bitcoin transaction and **set the nSequence field of the 2nd input** (input 1 -
+     *  indexing from 0) to the value returned in `in1sequence`
+     * @param options.manualSettlementSmartChainSigner Optional smart chain signer to create a manual claim (settlement) transaction
+     * @param options.maxWaitTillAutomaticSettlementSeconds Maximum time to wait for an automatic settlement after
+     *  the bitcoin transaction is confirmed (defaults to 60 seconds)
+     */
+    getCurrentActions(options?: {
+        bitcoinFeeRate?: number;
+        bitcoinWallet?: MinimalBitcoinWalletInterface;
+        manualSettlementSmartChainSigner?: string | T["Signer"] | T["NativeSigner"];
+        maxWaitTillAutomaticSettlementSeconds?: number;
+    }): Promise<SwapExecutionAction<T>[]>;
     /**
      * Checks whether a bitcoin payment was already made, returns the payment or null when no payment has been made.
      * @internal