@atomiqlabs/sdk 8.3.6 → 8.4.4

package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.ts

@@ -40,22 +40,67 @@ import {
     serializePriceInfoType
 } from "../../../../types/PriceInfoType";
 import {sha256} from "@noble/hashes/sha2";
+import {SwapExecutionAction} from "../../../../types/SwapExecutionAction";
 
 /**
  * State enum for FromBTCLNAuto swaps
  * @category Swaps/Lightning → Smart chain
  */
 export enum FromBTCLNAutoSwapState {
+    /**
+     * Swap has failed as the user didn't settle the HTLC on the destination before expiration
+     */
     FAILED = -4,
+    /**
+     * Swap has expired for good and there is no way how it can be executed anymore
+     */
     QUOTE_EXPIRED = -3,
+    /**
+     * A swap is almost expired, and it should be presented to the user as expired, though
+     *  there is still a chance that it will be processed
+     */
     QUOTE_SOFT_EXPIRED = -2,
+    /**
+     * Swap HTLC on the destination chain has expired, it is not safe anymore to settle (claim) the
+     *  swap on the destination smart chain.
+     */
     EXPIRED = -1,
+    /**
+     * Swap quote was created, use {@link FromBTCLNAutoSwap.getAddress} or {@link FromBTCLNAutoSwap.getHyperlink}
+     *  to get the bolt11 lightning network invoice to pay to initiate the swap, then use the
+     *  {@link FromBTCLNAutoSwap.waitForPayment} to wait till the lightning network payment is received
+     *  by the intermediary (LP) and the destination HTLC escrow is created
+     */
     PR_CREATED = 0,
+    /**
+     * Lightning network payment has been received by the intermediary (LP), but the destination chain
+     *  HTLC escrow hasn't been created yet. Use {@link FromBTCLNAutoSwap.waitForPayment} to continue waiting
+     *  till the destination HTLC escrow is created.
+     */
     PR_PAID = 1,
+    /**
+     * Swap escrow HTLC has been created on the destination chain, wait for automatic settlement by the watchtowers
+     *  using the {@link FromBTCLNAutoSwap.waitTillClaimed} function or settle manually using the
+     *  {@link FromBTCLNAutoSwap.claim} or {@link FromBTCLNAutoSwap.txsClaim} function.
+     */
     CLAIM_COMMITED = 2,
+    /**
+     * Swap successfully settled and funds received on the destination chain
+     */
     CLAIM_CLAIMED = 3
 }
 
+const FromBTCLNAutoSwapStateDescription = {
+    [FromBTCLNAutoSwapState.FAILED]: "Swap has failed as the user didn't settle the HTLC on the destination before expiration",
+    [FromBTCLNAutoSwapState.QUOTE_EXPIRED]: "Swap has expired for good and there is no way how it can be executed anymore",
+    [FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED]: "A swap is expired, though there is still a chance that it will be processed",
+    [FromBTCLNAutoSwapState.EXPIRED]: "Swap HTLC on the destination chain has expired, it is not safe anymore to settle (claim) the swap on the destination smart chain.",
+    [FromBTCLNAutoSwapState.PR_CREATED]: "Swap quote was created, pay the bolt11 lightning network invoice to initiate the swap, then wait till the lightning network payment is received by the intermediary (LP) and the destination HTLC escrow is created",
+    [FromBTCLNAutoSwapState.PR_PAID]: "Lightning network payment has been received by the intermediary (LP), but the destination chain HTLC escrow hasn't been created yet. Continue waiting till the destination HTLC escrow is created.",
+    [FromBTCLNAutoSwapState.CLAIM_COMMITED]: "Swap escrow HTLC has been created on the destination chain, wait for automatic settlement by the watchtowers or settle manually.",
+    [FromBTCLNAutoSwapState.CLAIM_CLAIMED]: "Swap successfully settled and funds received on the destination chain"
+};
+
 export type FromBTCLNAutoSwapInit<T extends SwapData> = IEscrowSwapInit<T> & {
     pr?: string,
     secret?: string,
@@ -100,6 +145,14 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
     implements IAddressSwap, ISwapWithGasDrop<T>, IClaimableSwap<T, FromBTCLNAutoDefinition<T>, FromBTCLNAutoSwapState> {
 
     protected readonly TYPE: SwapType.FROM_BTCLN_AUTO = SwapType.FROM_BTCLN_AUTO;
+    /**
+     * @internal
+     */
+    protected readonly swapStateName = (state: number) => FromBTCLNAutoSwapState[state];
+    /**
+     * @internal
+     */
+    protected readonly swapStateDescription = FromBTCLNAutoSwapStateDescription;
     /**
      * @internal
      */
@@ -109,6 +162,12 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
      */
     protected readonly inputToken: BtcToken<true> = BitcoinTokens.BTCLN;
 
+    /**
+     * Timestamp at which the HTLC was commited on the smart chain side
+     * @internal
+     */
+    _commitedAt?: number;
+
     private readonly lnurlFailSignal: AbortController = new AbortController();
     private readonly usesClaimHashAsId: boolean;
     private readonly initialSwapData: T["Data"];
@@ -135,7 +194,7 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
     private lnurlCallback?: string;
     private prPosted?: boolean = false;
 
-    private broadcastTickCounter: number = 0;
+    private broadcastTickCounter: number = 0
 
     /**
      * Sets the LNURL data for the swap
@@ -188,6 +247,7 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
 
             this._commitTxId = initOrObject.commitTxId;
             this._claimTxId = initOrObject.claimTxId;
+            this._commitedAt = initOrObject.commitedAt;
 
             this.lnurl = initOrObject.lnurl;
             this.lnurlK1 = initOrObject.lnurlK1;
@@ -410,6 +470,16 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
         return this._state===FromBTCLNAutoSwapState.FAILED || this._state===FromBTCLNAutoSwapState.EXPIRED;
     }
 
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean {
+        return (this._state===FromBTCLNAutoSwapState.PR_CREATED && this.initiated) ||
+            (this._state===FromBTCLNAutoSwapState.QUOTE_SOFT_EXPIRED && this.initiated) ||
+            this._state===FromBTCLNAutoSwapState.PR_PAID ||
+            this._state===FromBTCLNAutoSwapState.CLAIM_COMMITED;
+    }
+
     /**
      * @inheritDoc
      */
@@ -662,6 +732,25 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
         return this.getSwapData().getClaimHash()===claimHash;
     }
 
+    /**
+     * Sets the secret preimage for the swap, in case it is not known already
+     *
+     * @param secret Secret preimage that matches the expected payment hash
+     *
+     * @throws {Error} If an invalid secret preimage is provided
+     */
+    setSecretPreimage(secret: string) {
+        if(!this.isValidSecretPreimage(secret)) throw new Error("Invalid secret preimage provided, hash doesn't match!");
+        this.secret = secret;
+    }
+
+    /**
+     * Returns whether the secret preimage for this swap is known
+     */
+    hasSecretPreimage(): boolean {
+        return this.secret != null;
+    }
+
 
     //////////////////////////////
     //// Execution
@@ -672,8 +761,8 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
      * @param walletOrLnurlWithdraw Bitcoin lightning wallet to use to pay the lightning network invoice, or an LNURL-withdraw
      *  link, wallet is not required and the LN invoice can be paid externally as well (just pass null or undefined here)
      * @param callbacks Callbacks to track the progress of the swap
-     * @param options Optional options for the swap like feeRate, AbortSignal, and timeouts/intervals
-     * @param secret A swap secret to broadcast to watchtowers, generally only needed if the swap
+     * @param options Optional options for the swap like AbortSignal, and timeouts/intervals
+     * @param options.secret A swap secret to broadcast to watchtowers, generally only needed if the swap
      *  was recovered from on-chain data, or the pre-image was generated outside the SDK
      *
      * @returns {boolean} Whether a swap was settled automatically by swap watchtowers or requires manual claim by the
@@ -688,9 +777,9 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
         options?: {
             abortSignal?: AbortSignal,
             lightningTxCheckIntervalSeconds?: number,
-            maxWaitTillAutomaticSettlementSeconds?: number
-        },
-        secret?: string
+            maxWaitTillAutomaticSettlementSeconds?: number,
+            secret?: string
+        }
     ): Promise<boolean> {
         if(this._state===FromBTCLNAutoSwapState.FAILED) throw new Error("Swap failed!");
         if(this._state===FromBTCLNAutoSwapState.EXPIRED) throw new Error("Swap HTLC expired!");
@@ -725,9 +814,9 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
         if((this._state as FromBTCLNAutoSwapState)===FromBTCLNAutoSwapState.CLAIM_CLAIMED) return true;
 
         if(this._state===FromBTCLNAutoSwapState.CLAIM_COMMITED) {
-            if(this.secret==null && secret==null)
+            if(this.secret==null && options?.secret==null)
                 throw new Error("Tried to wait till settlement, but no secret pre-image is known, please pass the secret pre-image as an argument!");
-            const success = await this.waitTillClaimed(options?.maxWaitTillAutomaticSettlementSeconds ?? 60, options?.abortSignal, secret);
+            const success = await this.waitTillClaimed(options?.maxWaitTillAutomaticSettlementSeconds ?? 60, options?.abortSignal, options?.secret);
             if (success && callbacks?.onSwapSettled != null) callbacks.onSwapSettled(this.getOutputTxId()!);
             return success;
         }
@@ -760,6 +849,42 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED");
     }
 
+    /**
+     *
+     * @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)
+     * @param options.secret A swap secret to broadcast to watchtowers, generally only needed if the swap
+     *  was recovered from on-chain data, or the pre-image was generated outside the SDK
+     */
+    async getCurrentActions(options?: {
+        manualSettlementSmartChainSigner?: string | T["Signer"] | T["NativeSigner"],
+        maxWaitTillAutomaticSettlementSeconds?: number,
+        secret?: string
+    }): Promise<SwapExecutionAction<T>[]> {
+        if(options?.secret!=null) this.setSecretPreimage(options.secret);
+        if (this._state === FromBTCLNAutoSwapState.PR_CREATED) {
+            try {
+                return await this.txsExecute();
+            } catch (e) {}
+        }
+        if(this.isClaimable()) {
+            if(
+                this._commitedAt==null ||
+                options?.maxWaitTillAutomaticSettlementSeconds===0 ||
+                (Date.now() - this._commitedAt) > (options?.maxWaitTillAutomaticSettlementSeconds ?? 60)*1000
+            ) {
+                return [{
+                    name: "Claim" as const,
+                    description: "Manually settle (claim) the swap on the destination smart chain",
+                    chain: this.chainIdentifier,
+                    txs: await this.txsClaim(options?.manualSettlementSmartChainSigner)
+                }];
+            }
+        }
+        return [];
+    }
+
 
     //////////////////////////////
     //// Payment
@@ -993,6 +1118,7 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
         if(
             this._state===FromBTCLNAutoSwapState.PR_PAID
         ) {
+            this._commitedAt ??= Date.now();
             await this._saveAndEmit(FromBTCLNAutoSwapState.CLAIM_COMMITED);
         }
 
@@ -1207,6 +1333,7 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
             data: this._data==null ? null : this._data.serialize(),
             commitTxId: this._commitTxId,
             claimTxId: this._claimTxId,
+            commitedAt: this._commitedAt,
             btcAmountSwap: this.btcAmountSwap==null ? null : this.btcAmountSwap.toString(10),
             btcAmountGas: this.btcAmountGas==null ? null : this.btcAmountGas.toString(10),
             gasSwapFeeBtc: this.gasSwapFeeBtc==null ? null : this.gasSwapFeeBtc.toString(10),
@@ -1355,6 +1482,7 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
                 return true;
             case SwapCommitStateType.COMMITED:
                 if(this._state!==FromBTCLNAutoSwapState.CLAIM_COMMITED && this._state!==FromBTCLNAutoSwapState.EXPIRED) {
+                    this._commitedAt ??= Date.now();
                     this._state = FromBTCLNAutoSwapState.CLAIM_COMMITED;
                     return true;
                 }
@@ -1440,4 +1568,4 @@ export class FromBTCLNAutoSwap<T extends ChainType = ChainType>
         }
     }
 
-}
+}

package/src/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoWrapper.ts

@@ -37,6 +37,8 @@ import {AllOptional} from "../../../../utils/TypeUtils";
 import {sha256} from "@noble/hashes/sha2";
 
 export type FromBTCLNAutoOptions = {
+    paymentHash?: Buffer,
+    description?: string,
     descriptionHash?: Buffer,
     unsafeSkipLnNodeCheck?: boolean,
     gasAmount?: bigint,
@@ -167,6 +169,7 @@ export class FromBTCLNAutoWrapper<
             }
 
             swap._commitTxId = event.meta?.txId;
+            swap._commitedAt ??= Date.now();
             swap._state = FromBTCLNAutoSwapState.CLAIM_COMMITED;
             swap._broadcastSecret().catch(e => {
                 this.logger.error("processEventInitialize("+swap.getId()+"): Error when broadcasting swap secret: ", e);
@@ -257,7 +260,7 @@ export class FromBTCLNAutoWrapper<
         resp: FromBTCLNAutoResponseType,
         amountData: AmountData,
         lp: Intermediary,
-        options: {gasAmount: bigint, descriptionHash?: Buffer},
+        options: {gasAmount: bigint, description?: string, descriptionHash?: Buffer},
         decodedPr: PaymentRequestObject & {tagsObject: TagsObject},
         paymentHash: Buffer,
         claimerBounty: bigint
@@ -267,6 +270,9 @@ export class FromBTCLNAutoWrapper<
         if(options.descriptionHash!=null && decodedPr.tagsObject.purpose_commit_hash!==options.descriptionHash.toString("hex"))
             throw new IntermediaryError("Invalid pr returned - description hash");
 
+        if(options.description!=null && decodedPr.tagsObject.description!==options.description)
+            throw new IntermediaryError("Invalid pr returned - description");
+
         if(
             decodedPr.tagsObject.payment_hash==null ||
             !Buffer.from(decodedPr.tagsObject.payment_hash, "hex").equals(paymentHash)
@@ -317,20 +323,36 @@ export class FromBTCLNAutoWrapper<
         quote: Promise<FromBTCLNAutoSwap<T>>,
         intermediary: Intermediary
     }[] {
+        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, //No need to add much of a margin, since the claim should happen rather soon
             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("Invalid payment hash length, must be exactly 32 bytes!");
 
         if(_options.descriptionHash!=null && _options.descriptionHash.length!==32)
             throw new UserError("Invalid description hash length");
 
-        const {secret, paymentHash} = this.getSecretAndHash();
+        if(_options.description!=null && Buffer.byteLength(_options.description, "utf8") > 500)
+            throw new UserError("Invalid description length");
+
+        if(preFetches==null) preFetches = {};
+
+        let secret: Buffer | undefined;
+        let paymentHash: Buffer;
+        if(_options?.paymentHash!=null) {
+            paymentHash = _options.paymentHash;
+        } else {
+            ({secret, paymentHash} = this.getSecretAndHash());
+        }
         const claimHash = this._contract.getHashForHtlc(paymentHash);
 
         const nativeTokenAddress = this._chain.getNativeCurrencyAddress();
@@ -363,6 +385,7 @@ export class FromBTCLNAutoWrapper<
                                 amount: amountData.amount,
                                 claimer: recipient,
                                 token: amountData.token.toString(),
+                                description: _options.description,
                                 descriptionHash: _options.descriptionHash,
                                 exactOut: !amountData.exactIn,
                                 additionalParams,
@@ -427,7 +450,7 @@ export class FromBTCLNAutoWrapper<
                                 _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<T>(this, swapInit);
@@ -471,14 +494,21 @@ export class FromBTCLNAutoWrapper<
         quote: Promise<FromBTCLNAutoSwap<T>>,
         intermediary: Intermediary
     }[]> {
+        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, //No need to add much of a margin, since the claim should happen rather soon
             unsafeZeroWatchtowerFee: options?.unsafeZeroWatchtowerFee ?? false,
+            description: options?.description,
             descriptionHash: options?.descriptionHash
         };
 
+        if(_options.paymentHash!=null && _options.paymentHash.length!==32)
+            throw new UserError("Invalid payment hash length, must be exactly 32 bytes!");
+
         const abortController = extendAbortController(abortSignal);
         const preFetches = {
             pricePrefetchPromise: this.preFetchPrice(amountData, abortController.signal),
@@ -641,6 +671,7 @@ export class FromBTCLNAutoWrapper<
         swap._commitTxId = await init.getInitTxId();
         const blockData = await init.getTxBlock();
         swap.createdAt = blockData.blockTime * 1000;
+        swap._commitedAt = blockData.blockTime * 1000;
         swap._setInitiated();
         swap._state = FromBTCLNAutoSwapState.CLAIM_COMMITED;
         await swap._sync(false, false, state);

package/src/swaps/escrow_swaps/frombtc/onchain/FromBTCSwap.ts

@@ -34,6 +34,7 @@ import {TokenAmount, toTokenAmount} from "../../../../types/TokenAmount";
 import {BitcoinTokens, BtcToken, SCToken} from "../../../../types/Token";
 import {getLogger, LoggerType} from "../../../../utils/Logger";
 import {toBitcoinWallet} from "../../../../utils/BitcoinWalletUtils";
+import {SwapExecutionAction} from "../../../../types/SwapExecutionAction";
 
 /**
  * State enum for legacy escrow based Bitcoin -> Smart chain swaps.
@@ -73,9 +74,9 @@ export 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,
     /**
@@ -84,6 +85,17 @@ export enum FromBTCSwapState {
     CLAIM_CLAIMED = 3
 }
 
+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"
+};
+
 export type FromBTCSwapInit<T extends SwapData> = IEscrowSelfInitSwapInit<T> & {
     data: T;
     address?: string;
@@ -110,7 +122,14 @@ export class FromBTCSwap<T extends ChainType = ChainType>
     implements IBTCWalletSwap, IClaimableSwap<T, FromBTCDefinition<T>, FromBTCSwapState>, IAddressSwap {
 
     protected readonly TYPE: SwapType.FROM_BTC = SwapType.FROM_BTC;
-
+    /**
+     * @internal
+     */
+    protected readonly swapStateName = (state: number) => FromBTCSwapState[state];
+    /**
+     * @internal
+     */
+    protected readonly swapStateDescription = FromBTCSwapStateDescription;
     /**
      * @internal
      */
@@ -137,6 +156,8 @@ export class FromBTCSwap<T extends ChainType = ChainType>
     private txId?: string;
     private vout?: number;
 
+    private btcTxConfirmedAt?: number;
+
     constructor(wrapper: FromBTCWrapper<T>, init: FromBTCSwapInit<T["Data"]>);
     constructor(wrapper: FromBTCWrapper<T>, obj: any);
     constructor(wrapper: FromBTCWrapper<T>, initOrObject: FromBTCSwapInit<T["Data"]> | any) {
@@ -156,6 +177,7 @@ export class FromBTCSwap<T extends ChainType = ChainType>
             this.txId = initOrObject.txId;
             this.vout = initOrObject.vout;
             this.requiredConfirmations = initOrObject.requiredConfirmations ?? this._data.getConfirmationsHint();
+            this.btcTxConfirmedAt = initOrObject.btcTxConfirmedAt;
         }
         this.tryRecomputeSwapPrice();
         this.logger = getLogger("FromBTC("+this.getIdentifierHashString()+"): ");
@@ -285,6 +307,14 @@ export class FromBTCSwap<T extends ChainType = ChainType>
         return this._state===FromBTCSwapState.FAILED || this._state===FromBTCSwapState.EXPIRED;
     }
 
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean {
+        return this._state===FromBTCSwapState.CLAIM_COMMITED ||
+            this._state===FromBTCSwapState.BTC_TX_CONFIRMED;
+    }
+
     /**
      * @inheritDoc
      */
@@ -519,6 +549,7 @@ export class FromBTCSwap<T extends ChainType = ChainType>
             (this._state as FromBTCSwapState)!==FromBTCSwapState.CLAIM_CLAIMED &&
             (this._state as FromBTCSwapState)!==FromBTCSwapState.FAILED
         ) {
+            this.btcTxConfirmedAt ??= Date.now();
             this._state = FromBTCSwapState.BTC_TX_CONFIRMED;
         }
 
@@ -737,6 +768,7 @@ export class FromBTCSwap<T extends ChainType = ChainType>
     /**
      * @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
@@ -746,6 +778,7 @@ export class FromBTCSwap<T extends ChainType = ChainType>
      * @throws {Error} if the swap or quote is expired, or if triggered in invalid state
      */
     async txsExecute(options?: {
+        bitcoinFeeRate?: number,
         bitcoinWallet?: MinimalBitcoinWalletInterface,
         skipChecks?: boolean
     }) {
@@ -803,6 +836,47 @@ export class FromBTCSwap<T extends ChainType = ChainType>
         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?: {
+        bitcoinFeeRate?: number,
+        bitcoinWallet?: MinimalBitcoinWalletInterface,
+        skipChecks?: boolean,
+        manualSettlementSmartChainSigner?: string | T["Signer"] | T["NativeSigner"],
+        maxWaitTillAutomaticSettlementSeconds?: number
+    }): Promise<SwapExecutionAction<T>[]> {
+        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" as const,
+                    description: "Manually settle (claim) the swap on the destination smart chain",
+                    chain: this.chainIdentifier,
+                    txs: await this.txsClaim(options?.manualSettlementSmartChainSigner)
+                }];
+            }
+        }
+        return[];
+    }
 
     //////////////////////////////
     //// Commit
@@ -1047,7 +1121,8 @@ export class FromBTCSwap<T extends ChainType = ChainType>
             requiredConfirmations: this.requiredConfirmations,
             senderAddress: this.senderAddress,
             txId: this.txId,
-            vout: this.vout
+            vout: this.vout,
+            btcTxConfirmedAt: this.btcTxConfirmedAt
         };
     }
 
@@ -1156,6 +1231,7 @@ export class FromBTCSwap<T extends ChainType = ChainType>
                         save = true;
                     }
                     if(this.requiredConfirmations!=null && res.confirmations>=this.requiredConfirmations) {
+                        this.btcTxConfirmedAt ??= Date.now();
                         this._state = FromBTCSwapState.BTC_TX_CONFIRMED;
                         save = true;
                     }
@@ -1198,6 +1274,7 @@ export class FromBTCSwap<T extends ChainType = ChainType>
                                 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();
                                 shouldSave = true;
@@ -1215,4 +1292,4 @@ export class FromBTCSwap<T extends ChainType = ChainType>
         return false;
     }
 
-}
+}