@atomiqlabs/sdk 8.4.3 → 8.4.4

package/dist/index.d.ts

@@ -73,6 +73,7 @@ export * from "./types/lnurl/LNURLWithdraw";
 export * from "./types/wallets/MinimalBitcoinWalletInterface";
 export * from "./types/wallets/MinimalLightningNetworkWalletInterface";
 export * from "./types/wallets/LightningInvoiceCreateService";
+export * from "./types/SwapStateInfo";
 export * from "./types/AmountData";
 export * from "./types/CustomPriceFunction";
 export * from "./types/SwapExecutionAction";

package/dist/index.js

@@ -146,6 +146,7 @@ __exportStar(require("./types/lnurl/LNURLWithdraw"), exports);
 __exportStar(require("./types/wallets/MinimalBitcoinWalletInterface"), exports);
 __exportStar(require("./types/wallets/MinimalLightningNetworkWalletInterface"), exports);
 __exportStar(require("./types/wallets/LightningInvoiceCreateService"), exports);
+__exportStar(require("./types/SwapStateInfo"), exports);
 __exportStar(require("./types/AmountData"), exports);
 __exportStar(require("./types/CustomPriceFunction"), exports);
 __exportStar(require("./types/SwapExecutionAction"), exports);

package/dist/swaps/ISwap.d.ts

@@ -156,6 +156,16 @@ export declare abstract class ISwap<T extends ChainType = ChainType, D extends S
      * @param options Additional options for executing the swap
      */
     abstract txsExecute(options?: any): Promise<SwapExecutionAction<T>[]>;
+    /**
+     * Executes the swap with the provided wallet, the exact arguments for this functions differ for various swap
+     *  types. Check the `execute()` function signature in the respective swap class to see the required arguments.
+     *
+     * @param args Execution arguments, usually contains a source wallet object, callbacks and options, for exact
+     *  syntax check the respective swap class.
+     *
+     * @returns Whether a swap was successfully executed or not, if it wasn't the user can refund or claim manually
+     */
+    abstract execute(...args: any[]): Promise<boolean>;
     /**
      * This attempts to populate missing fields in the pricing info based on the swap amounts
      *
@@ -257,6 +267,10 @@ export declare abstract class ISwap<T extends ChainType = ChainType, D extends S
      * Returns whether the swap failed (e.g. was refunded)
      */
     abstract isFailed(): boolean;
+    /**
+     * Returns whether the swap is currently being processed
+     */
+    abstract isInProgress(): boolean;
     /**
      * Whether a swap was initialized, a swap is considered initialized on first interaction with it, i.e.
      *  calling commit() on a Smart chain -> Bitcoin swaps, calling waitForPayment() or similar on the other

package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.d.ts

@@ -208,6 +208,10 @@ export declare class FromBTCLNSwap<T extends ChainType = ChainType> extends IFro
      * @inheritDoc
      */
     isFailed(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      */
@@ -282,7 +286,7 @@ export declare class FromBTCLNSwap<T extends ChainType = ChainType> extends IFro
         secret?: string;
         lightningTxCheckIntervalSeconds?: number;
         delayBetweenCommitAndClaimSeconds?: number;
-    }): Promise<void>;
+    }): Promise<boolean>;
     /**
      * @inheritDoc
      *

package/dist/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.js

@@ -321,6 +321,15 @@ class FromBTCLNSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
     isFailed() {
         return this._state === FromBTCLNSwapState.FAILED || this._state === FromBTCLNSwapState.EXPIRED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return (this._state === FromBTCLNSwapState.PR_CREATED && this.initiated) ||
+            (this._state === FromBTCLNSwapState.QUOTE_SOFT_EXPIRED && this.initiated) ||
+            this._state === FromBTCLNSwapState.PR_PAID ||
+            this._state === FromBTCLNSwapState.CLAIM_COMMITED;
+    }
     /**
      * @inheritDoc
      */
@@ -485,6 +494,7 @@ class FromBTCLNSwap extends IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap {
             if (callbacks?.onSwapSettled != null)
                 callbacks.onSwapSettled(this.getOutputTxId());
         }
+        return true;
     }
     /**
      * @inheritDoc

package/dist/swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap.d.ts

@@ -245,6 +245,10 @@ export declare class FromBTCLNAutoSwap<T extends ChainType = ChainType> extends
      * @inheritDoc
      */
     isFailed(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      */

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

@@ -352,6 +352,15 @@ class FromBTCLNAutoSwap extends IEscrowSwap_1.IEscrowSwap {
     isFailed() {
         return this._state === FromBTCLNAutoSwapState.FAILED || this._state === FromBTCLNAutoSwapState.EXPIRED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        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
      */

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

@@ -175,6 +175,10 @@ export declare class FromBTCSwap<T extends ChainType = ChainType> extends IFromB
      * @inheritDoc
      */
     isFailed(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      */

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

@@ -237,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
      */

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

@@ -172,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

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

@@ -221,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

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

@@ -278,6 +278,10 @@ export declare class SpvFromBTCSwap<T extends ChainType> extends ISwap<T, SpvFro
      * @inheritDoc
      */
     isFailed(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      */

package/dist/swaps/spv_swaps/SpvFromBTCSwap.js

@@ -346,6 +346,14 @@ class SpvFromBTCSwap extends ISwap_1.ISwap {
     isFailed() {
         return this._state === SpvFromBTCSwapState.FAILED || this._state === SpvFromBTCSwapState.DECLINED || this._state === SpvFromBTCSwapState.CLOSED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return this._state === SpvFromBTCSwapState.POSTED ||
+            this._state === SpvFromBTCSwapState.BROADCASTED ||
+            this._state === SpvFromBTCSwapState.BTC_TX_CONFIRMED;
+    }
     /**
      * @inheritDoc
      */

package/dist/swaps/trusted/ln/LnForGasSwap.d.ts

@@ -151,6 +151,10 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
      * @inheritDoc
      */
     isSuccessful(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      * @internal
@@ -209,6 +213,10 @@ export declare class LnForGasSwap<T extends ChainType = ChainType> extends ISwap
      * @inheritDoc
      */
     txsExecute(): Promise<[SwapExecutionActionLightning]>;
+    /**
+     * @remark Not supported
+     */
+    execute(): Promise<boolean>;
     /**
      * @inheritDoc
      */

package/dist/swaps/trusted/ln/LnForGasSwap.js

@@ -218,6 +218,12 @@ class LnForGasSwap extends ISwap_1.ISwap {
     isSuccessful() {
         return this._state === LnForGasSwapState.FINISHED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return (this._state === LnForGasSwapState.PR_CREATED && this.initiated) || this._state === LnForGasSwapState.PR_PAID;
+    }
     /**
      * @inheritDoc
      * @internal
@@ -347,6 +353,12 @@ class LnForGasSwap extends ISwap_1.ISwap {
         }
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED");
     }
+    /**
+     * @remark Not supported
+     */
+    async execute() {
+        throw new Error("Not supported");
+    }
     /**
      * @inheritDoc
      */

package/dist/swaps/trusted/onchain/OnchainForGasSwap.d.ts

@@ -171,6 +171,10 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
      * @inheritDoc
      */
     isSuccessful(): boolean;
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean;
     /**
      * @inheritDoc
      * @internal
@@ -267,6 +271,10 @@ export declare class OnchainForGasSwap<T extends ChainType = ChainType> extends
     }): Promise<[
         SwapExecutionActionBitcoin<"ADDRESS" | "FUNDED_PSBT">
     ]>;
+    /**
+     * @remark Not supported
+     */
+    execute(): Promise<boolean>;
     /**
      * @inheritDoc
      *

package/dist/swaps/trusted/onchain/OnchainForGasSwap.js

@@ -225,6 +225,13 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
     isSuccessful() {
         return this._state === OnchainForGasSwapState.FINISHED;
     }
+    /**
+     * @inheritDoc
+     */
+    isInProgress() {
+        return (this._state === OnchainForGasSwapState.PR_CREATED && this.txId != null) ||
+            (this._state === OnchainForGasSwapState.REFUNDABLE && this.refundAddress != null);
+    }
     /**
      * @inheritDoc
      * @internal
@@ -453,6 +460,12 @@ class OnchainForGasSwap extends ISwap_1.ISwap {
         }
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED or CLAIM_COMMITED");
     }
+    /**
+     * @remark Not supported
+     */
+    async execute() {
+        throw new Error("Not supported");
+    }
     /**
      * @inheritDoc
      *

package/dist/types/lnurl/LNURLPay.d.ts

@@ -47,7 +47,6 @@ export declare function isLNURLPayParams(obj: any): obj is LNURLPayParams;
  * Type guard for {@link LNURLPay}
  *
  * @category Lightning
- * @internal
  */
 export declare function isLNURLPay(value: any): value is LNURLPay;
 /**

package/dist/types/lnurl/LNURLPay.js

@@ -15,7 +15,6 @@ exports.isLNURLPayParams = isLNURLPayParams;
  * Type guard for {@link LNURLPay}
  *
  * @category Lightning
- * @internal
  */
 function isLNURLPay(value) {
     return (typeof value === "object" &&

package/dist/types/lnurl/LNURLWithdraw.d.ts

@@ -37,7 +37,6 @@ export type LNURLWithdraw = {
  * Type guard for {@link LNURLWithdraw}
  *
  * @category Lightning
- * @internal
  */
 export declare function isLNURLWithdraw(value: any): value is LNURLWithdraw;
 /**

package/dist/types/lnurl/LNURLWithdraw.js

@@ -5,7 +5,6 @@ exports.isLNURLWithdrawParams = exports.isLNURLWithdraw = void 0;
  * Type guard for {@link LNURLWithdraw}
  *
  * @category Lightning
- * @internal
  */
 function isLNURLWithdraw(value) {
     return (typeof value === "object" &&

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "8.4.3",
+  "version": "8.4.4",
   "description": "atomiq labs SDK for cross-chain swaps between smart chains and bitcoin",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",

package/src/index.ts

@@ -127,6 +127,7 @@ export * from "./types/wallets/MinimalBitcoinWalletInterface";
 export * from "./types/wallets/MinimalLightningNetworkWalletInterface";
 export * from "./types/wallets/LightningInvoiceCreateService";
 
+export * from "./types/SwapStateInfo";
 export * from "./types/AmountData";
 export * from "./types/CustomPriceFunction";
 export * from "./types/SwapExecutionAction";

package/src/swaps/ISwap.ts

@@ -249,6 +249,17 @@ export abstract class ISwap<
      */
     public abstract txsExecute(options?: any): Promise<SwapExecutionAction<T>[]>;
 
+    /**
+     * Executes the swap with the provided wallet, the exact arguments for this functions differ for various swap
+     *  types. Check the `execute()` function signature in the respective swap class to see the required arguments.
+     *
+     * @param args Execution arguments, usually contains a source wallet object, callbacks and options, for exact
+     *  syntax check the respective swap class.
+     *
+     * @returns Whether a swap was successfully executed or not, if it wasn't the user can refund or claim manually
+     */
+    public abstract execute(...args: any[]): Promise<boolean>;
+
     //////////////////////////////
     //// Pricing
 
@@ -460,6 +471,11 @@ export abstract class ISwap<
      */
     public abstract isFailed(): boolean;
 
+    /**
+     * Returns whether the swap is currently being processed
+     */
+    public abstract isInProgress(): boolean;
+
     /**
      * Whether a swap was initialized, a swap is considered initialized on first interaction with it, i.e.
      *  calling commit() on a Smart chain -> Bitcoin swaps, calling waitForPayment() or similar on the other

package/src/swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap.ts

@@ -385,6 +385,16 @@ export class FromBTCLNSwap<T extends ChainType = ChainType>
         return this._state===FromBTCLNSwapState.FAILED || this._state===FromBTCLNSwapState.EXPIRED;
     }
 
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean {
+        return (this._state===FromBTCLNSwapState.PR_CREATED && this.initiated) ||
+            (this._state===FromBTCLNSwapState.QUOTE_SOFT_EXPIRED && this.initiated) ||
+            this._state===FromBTCLNSwapState.PR_PAID ||
+            this._state===FromBTCLNSwapState.CLAIM_COMMITED;
+    }
+
     /**
      * @inheritDoc
      */
@@ -539,7 +549,7 @@ export class FromBTCLNSwap<T extends ChainType = ChainType>
             lightningTxCheckIntervalSeconds?: number,
             delayBetweenCommitAndClaimSeconds?: number
         }
-    ): Promise<void> {
+    ): Promise<boolean> {
         if(this._state===FromBTCLNSwapState.FAILED) throw new Error("Swap failed!");
         if(this._state===FromBTCLNSwapState.EXPIRED) throw new Error("Swap HTLC expired!");
         if(this._state===FromBTCLNSwapState.QUOTE_EXPIRED || this._state===FromBTCLNSwapState.QUOTE_SOFT_EXPIRED) throw new Error("Swap quote expired!");
@@ -585,6 +595,8 @@ export class FromBTCLNSwap<T extends ChainType = ChainType>
         if(this._state===FromBTCLNSwapState.CLAIM_CLAIMED) {
             if(callbacks?.onSwapSettled!=null) callbacks.onSwapSettled(this.getOutputTxId()!);
         }
+
+        return true;
     }
 
     /**

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

@@ -470,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
      */

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

@@ -307,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
      */

package/src/swaps/escrow_swaps/tobtc/IToBTCSwap.ts

@@ -300,6 +300,21 @@ export abstract class IToBTCSwap<
         return this._state===ToBTCSwapState.REFUNDED;
     }
 
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean {
+        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(): number {
+        return Number(this._data.getExpiry())*1000;
+    }
+
     /**
      * @inheritDoc
      * @internal

package/src/swaps/spv_swaps/SpvFromBTCSwap.ts

@@ -506,6 +506,15 @@ export class SpvFromBTCSwap<T extends ChainType>
         return this._state===SpvFromBTCSwapState.FAILED || this._state===SpvFromBTCSwapState.DECLINED || this._state===SpvFromBTCSwapState.CLOSED;
     }
 
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean {
+        return this._state===SpvFromBTCSwapState.POSTED ||
+            this._state===SpvFromBTCSwapState.BROADCASTED ||
+            this._state===SpvFromBTCSwapState.BTC_TX_CONFIRMED;
+    }
+
     /**
      * @inheritDoc
      */

package/src/swaps/trusted/ln/LnForGasSwap.ts

@@ -272,6 +272,13 @@ export class LnForGasSwap<T extends ChainType = ChainType> extends ISwap<T, LnFo
         return this._state===LnForGasSwapState.FINISHED;
     }
 
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean {
+        return (this._state===LnForGasSwapState.PR_CREATED && this.initiated) || this._state===LnForGasSwapState.PR_PAID;
+    }
+
     /**
      * @inheritDoc
      * @internal
@@ -420,6 +427,13 @@ export class LnForGasSwap<T extends ChainType = ChainType> extends ISwap<T, LnFo
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED");
     }
 
+    /**
+     * @remark Not supported
+     */
+    async execute(): Promise<boolean> {
+        throw new Error("Not supported");
+    }
+
     /**
      * @inheritDoc
      */
@@ -572,4 +586,4 @@ export class LnForGasSwap<T extends ChainType = ChainType> extends ISwap<T, LnFo
         return Promise.resolve(false);
     }
 
-}
+}

package/src/swaps/trusted/onchain/OnchainForGasSwap.ts

@@ -314,6 +314,14 @@ export class OnchainForGasSwap<T extends ChainType = ChainType> extends ISwap<T,
         return this._state===OnchainForGasSwapState.FINISHED;
     }
 
+    /**
+     * @inheritDoc
+     */
+    isInProgress(): boolean {
+        return (this._state===OnchainForGasSwapState.PR_CREATED && this.txId!=null) ||
+            (this._state===OnchainForGasSwapState.REFUNDABLE && this.refundAddress!=null);
+    }
+
     /**
      * @inheritDoc
      * @internal
@@ -584,6 +592,13 @@ export class OnchainForGasSwap<T extends ChainType = ChainType> extends ISwap<T,
         throw new Error("Invalid swap state to obtain execution txns, required PR_CREATED or CLAIM_COMMITED");
     }
 
+    /**
+     * @remark Not supported
+     */
+    async execute(): Promise<boolean> {
+        throw new Error("Not supported");
+    }
+
     /**
      * @inheritDoc
      *

package/src/types/lnurl/LNURLPay.ts

@@ -51,7 +51,6 @@ export function isLNURLPayParams(obj: any): obj is LNURLPayParams {
  * Type guard for {@link LNURLPay}
  *
  * @category Lightning
- * @internal
  */
 export function isLNURLPay(value: any): value is LNURLPay {
     return (

package/src/types/lnurl/LNURLWithdraw.ts

@@ -38,7 +38,6 @@ export type LNURLWithdraw = {
  * Type guard for {@link LNURLWithdraw}
  *
  * @category Lightning
- * @internal
  */
 export function isLNURLWithdraw(value: any): value is LNURLWithdraw {
     return (