@atomiqlabs/sdk 8.7.7 → 8.8.4

package/dist/types/SwapExecutionAction.d.ts

@@ -1,88 +1,88 @@
-import { ChainType } from "@atomiqlabs/base";
-import { Transaction } from "@scure/btc-signer";
-/**
- * Swap execution action requiring a payment of the provided bolt11 lightning network invoice
- *
- * @category Swap Actions
- */
-export type SwapExecutionActionLightning = {
-    name: "Payment";
-    description: string;
-    chain: "LIGHTNING";
-    txs: {
-        type: "BOLT11_PAYMENT_REQUEST";
-        address: string;
-        hyperlink: string;
-    }[];
-};
-/**
- * Swap execution action on on-chain Bitcoin, has following types:
- * - `"ADDRESS"` - Destination bitcoin address and BTC amount to be sent
- * - `"FUNDED_PSBT"` - A ready to sign PSBT with the inputs populated from the provided bitcoin wallet address
- * - `"RAW_PSBT"` - Raw PSBT without the inputs, the implementor needs to add the input UTXOs before signing
- *  the transaction
- *
- * @category Swap Actions
- */
-export type SwapExecutionActionBitcoin<T extends "ADDRESS" | "FUNDED_PSBT" | "RAW_PSBT" = "ADDRESS" | "FUNDED_PSBT" | "RAW_PSBT"> = {
-    name: "Payment";
-    description: string;
-    chain: "BITCOIN";
-    txs: (T extends "ADDRESS" ? {
-        type: "ADDRESS";
-        amount: number;
-        address: string;
-        hyperlink: string;
-    } : T extends "FUNDED_PSBT" ? {
-        type: "FUNDED_PSBT";
-        psbt: Transaction;
-        psbtHex: string;
-        psbtBase64: string;
-        signInputs: number[];
-    } : {
-        type: "RAW_PSBT";
-        psbt: Transaction;
-        psbtHex: string;
-        psbtBase64: string;
-        in1sequence: number;
-    })[];
-};
-/**
- * Swap execution action for committing (initiating) the escrow on the smart chain side
- *
- * @category Swap Actions
- */
-export type SwapExecutionActionCommit<T extends ChainType> = {
-    name: "Commit";
-    description: string;
-    chain: T["ChainId"];
-    txs: T["TX"][];
-};
-/**
- * Swap execution action for claiming (settling) the swap on the smart chain side
- *
- * @category Swap Actions
- */
-export type SwapExecutionActionClaim<T extends ChainType> = {
-    name: "Claim";
-    description: string;
-    chain: T["ChainId"];
-    txs: T["TX"][];
-};
-/**
- * Swap execution action for refunding the swap on the smart chain side after it fails
- *
- * @category Swap Actions
- */
-export type SwapExecutionActionRefund<T extends ChainType> = {
-    name: "Refund";
-    description: string;
-    chain: T["ChainId"];
-    txs: T["TX"][];
-};
-/**
- * Swap execution action, a single step in the swapping process
- *
- * @category Swap Actions
- */
-export type SwapExecutionAction<T extends ChainType> = SwapExecutionActionLightning | SwapExecutionActionBitcoin | SwapExecutionActionCommit<T> | SwapExecutionActionClaim<T> | SwapExecutionActionRefund<T>;
+import { ChainType } from "@atomiqlabs/base";
+import { Transaction } from "@scure/btc-signer";
+/**
+ * Swap execution action requiring a payment of the provided bolt11 lightning network invoice
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionLightning = {
+    name: "Payment";
+    description: string;
+    chain: "LIGHTNING";
+    txs: {
+        type: "BOLT11_PAYMENT_REQUEST";
+        address: string;
+        hyperlink: string;
+    }[];
+};
+/**
+ * Swap execution action on on-chain Bitcoin, has following types:
+ * - `"ADDRESS"` - Destination bitcoin address and BTC amount to be sent
+ * - `"FUNDED_PSBT"` - A ready to sign PSBT with the inputs populated from the provided bitcoin wallet address
+ * - `"RAW_PSBT"` - Raw PSBT without the inputs, the implementor needs to add the input UTXOs before signing
+ *  the transaction
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionBitcoin<T extends "ADDRESS" | "FUNDED_PSBT" | "RAW_PSBT" = "ADDRESS" | "FUNDED_PSBT" | "RAW_PSBT"> = {
+    name: "Payment";
+    description: string;
+    chain: "BITCOIN";
+    txs: (T extends "ADDRESS" ? {
+        type: "ADDRESS";
+        amount: number;
+        address: string;
+        hyperlink: string;
+    } : T extends "FUNDED_PSBT" ? {
+        type: "FUNDED_PSBT";
+        psbt: Transaction;
+        psbtHex: string;
+        psbtBase64: string;
+        signInputs: number[];
+    } : {
+        type: "RAW_PSBT";
+        psbt: Transaction;
+        psbtHex: string;
+        psbtBase64: string;
+        in1sequence: number;
+    })[];
+};
+/**
+ * Swap execution action for committing (initiating) the escrow on the smart chain side
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionCommit<T extends ChainType> = {
+    name: "Commit";
+    description: string;
+    chain: T["ChainId"];
+    txs: T["TX"][];
+};
+/**
+ * Swap execution action for claiming (settling) the swap on the smart chain side
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionClaim<T extends ChainType> = {
+    name: "Claim";
+    description: string;
+    chain: T["ChainId"];
+    txs: T["TX"][];
+};
+/**
+ * Swap execution action for refunding the swap on the smart chain side after it fails
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionActionRefund<T extends ChainType> = {
+    name: "Refund";
+    description: string;
+    chain: T["ChainId"];
+    txs: T["TX"][];
+};
+/**
+ * Swap execution action, a single step in the swapping process
+ *
+ * @category Swap Actions
+ */
+export type SwapExecutionAction<T extends ChainType> = SwapExecutionActionLightning | SwapExecutionActionBitcoin | SwapExecutionActionCommit<T> | SwapExecutionActionClaim<T> | SwapExecutionActionRefund<T>;

package/dist/types/SwapExecutionAction.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/SwapStateInfo.d.ts

@@ -1,5 +1,5 @@
-export type SwapStateInfo<S extends number> = {
-    state: S;
-    name: string;
-    description: string;
-};
+export type SwapStateInfo<S extends number> = {
+    state: S;
+    name: string;
+    description: string;
+};

package/dist/types/SwapStateInfo.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/SwapWithSigner.d.ts

@@ -1,17 +1,17 @@
-import { ISwap } from "../swaps/ISwap";
-import { ChainType } from "@atomiqlabs/base";
-/**
- * Proxy type that auto-injects a smart chain signer into swap methods
- *
- * @category Swaps/Base
- */
-export type SwapWithSigner<T extends ISwap> = {
-    [K in keyof T]: K extends "commit" ? (abortSignal?: AbortSignal, skipChecks?: boolean) => Promise<string> : K extends "refund" ? (abortSignal?: AbortSignal) => Promise<string> : K extends "claim" ? (abortSignal?: AbortSignal) => Promise<string> : K extends "commitAndClaim" ? (abortSignal?: AbortSignal, skipChecks?: boolean) => Promise<string> : T[K];
-};
-/**
- * Wraps a swap with automatic signer injection for methods like commit, refund, and claim
- *
- * @category Swaps
- * @internal
- */
-export declare function wrapSwapWithSigner<C extends ChainType, T extends ISwap<C>>(swap: T, signer: C["Signer"]): SwapWithSigner<T>;
+import { ISwap } from "../swaps/ISwap";
+import { ChainType } from "@atomiqlabs/base";
+/**
+ * Proxy type that auto-injects a smart chain signer into swap methods
+ *
+ * @category Swaps/Base
+ */
+export type SwapWithSigner<T extends ISwap> = {
+    [K in keyof T]: K extends "commit" ? (abortSignal?: AbortSignal, skipChecks?: boolean) => Promise<string> : K extends "refund" ? (abortSignal?: AbortSignal) => Promise<string> : K extends "claim" ? (abortSignal?: AbortSignal) => Promise<string> : K extends "commitAndClaim" ? (abortSignal?: AbortSignal, skipChecks?: boolean) => Promise<string> : T[K];
+};
+/**
+ * Wraps a swap with automatic signer injection for methods like commit, refund, and claim
+ *
+ * @category Swaps
+ * @internal
+ */
+export declare function wrapSwapWithSigner<C extends ChainType, T extends ISwap<C>>(swap: T, signer: C["Signer"]): SwapWithSigner<T>;

package/dist/types/SwapWithSigner.js

@@ -1,43 +1,43 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapSwapWithSigner = void 0;
-const IToBTCSwap_1 = require("../swaps/escrow_swaps/tobtc/IToBTCSwap");
-const IFromBTCSelfInitSwap_1 = require("../swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap");
-const FromBTCLNSwap_1 = require("../swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap");
-const FromBTCLNAutoSwap_1 = require("../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap");
-const SpvFromBTCSwap_1 = require("../swaps/spv_swaps/SpvFromBTCSwap");
-/**
- * Wraps a swap with automatic signer injection for methods like commit, refund, and claim
- *
- * @category Swaps
- * @internal
- */
-function wrapSwapWithSigner(swap, signer) {
-    return new Proxy(swap, {
-        get: (target, prop, receiver) => {
-            if (prop === "commit") {
-                if (swap instanceof IToBTCSwap_1.IToBTCSwap || swap instanceof IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap) {
-                    return (abortSignal, skipChecks) => swap.commit(signer, abortSignal, skipChecks);
-                }
-            }
-            if (prop === "refund") {
-                if (swap instanceof IToBTCSwap_1.IToBTCSwap) {
-                    return (abortSignal) => swap.refund(signer, abortSignal);
-                }
-            }
-            if (prop === "claim") {
-                if (swap instanceof IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap || swap instanceof FromBTCLNAutoSwap_1.FromBTCLNAutoSwap || swap instanceof SpvFromBTCSwap_1.SpvFromBTCSwap) {
-                    return (abortSignal) => swap.claim(signer, abortSignal);
-                }
-            }
-            if (prop === "commitAndClaim") {
-                if (swap instanceof FromBTCLNSwap_1.FromBTCLNSwap) {
-                    return (abortSignal, skipChecks) => swap.commitAndClaim(signer, abortSignal, skipChecks);
-                }
-            }
-            // Delegate other properties and methods to the original instance
-            return Reflect.get(target, prop, receiver);
-        }
-    });
-}
-exports.wrapSwapWithSigner = wrapSwapWithSigner;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapSwapWithSigner = void 0;
+const IToBTCSwap_1 = require("../swaps/escrow_swaps/tobtc/IToBTCSwap");
+const IFromBTCSelfInitSwap_1 = require("../swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap");
+const FromBTCLNSwap_1 = require("../swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap");
+const FromBTCLNAutoSwap_1 = require("../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap");
+const SpvFromBTCSwap_1 = require("../swaps/spv_swaps/SpvFromBTCSwap");
+/**
+ * Wraps a swap with automatic signer injection for methods like commit, refund, and claim
+ *
+ * @category Swaps
+ * @internal
+ */
+function wrapSwapWithSigner(swap, signer) {
+    return new Proxy(swap, {
+        get: (target, prop, receiver) => {
+            if (prop === "commit") {
+                if (swap instanceof IToBTCSwap_1.IToBTCSwap || swap instanceof IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap) {
+                    return (abortSignal, skipChecks) => swap.commit(signer, abortSignal, skipChecks);
+                }
+            }
+            if (prop === "refund") {
+                if (swap instanceof IToBTCSwap_1.IToBTCSwap) {
+                    return (abortSignal) => swap.refund(signer, abortSignal);
+                }
+            }
+            if (prop === "claim") {
+                if (swap instanceof IFromBTCSelfInitSwap_1.IFromBTCSelfInitSwap || swap instanceof FromBTCLNAutoSwap_1.FromBTCLNAutoSwap || swap instanceof SpvFromBTCSwap_1.SpvFromBTCSwap) {
+                    return (abortSignal) => swap.claim(signer, abortSignal);
+                }
+            }
+            if (prop === "commitAndClaim") {
+                if (swap instanceof FromBTCLNSwap_1.FromBTCLNSwap) {
+                    return (abortSignal, skipChecks) => swap.commitAndClaim(signer, abortSignal, skipChecks);
+                }
+            }
+            // Delegate other properties and methods to the original instance
+            return Reflect.get(target, prop, receiver);
+        }
+    });
+}
+exports.wrapSwapWithSigner = wrapSwapWithSigner;

package/dist/types/Token.d.ts

@@ -1,99 +1,99 @@
-/**
- * Type for all token types (BTC or smart chain)
- *
- * @category Tokens
- */
-export type Token<ChainIdentifier extends string = string> = {
-    /**
-     * Chain identifier for the token's chain
-     */
-    chainId: ChainIdentifier | "BITCOIN" | "LIGHTNING";
-    /**
-     * Ticker of the token
-     */
-    ticker: string;
-    /**
-     * Full name of the token
-     */
-    name: string;
-    /**
-     * Actual decimal places of the tokens
-     */
-    decimals: number;
-    /**
-     * The decimal places that should be rendered and displayed to the user
-     */
-    displayDecimals?: number;
-    /**
-     * Address of the token contract, or `""` for Bitcoin
-     */
-    address: string;
-    /**
-     * Legacy chain identifier distinguishing between Smart Chain and Bitcoin tokens
-     */
-    chain: "SC" | "BTC";
-    /**
-     * Legacy lightning flag, determines whether a Bitcoin token is an Lightning or on-chain one
-     */
-    lightning?: boolean;
-    /**
-     * Equality check between tokens
-     */
-    equals: (other: Token) => boolean;
-    /**
-     * Returns the
-     */
-    toString: () => string;
-};
-/**
- * Type guard for a {@link Token} type, encompassing all tokens (BTC or smart chain)
- *
- * @category Tokens
- */
-export declare function isToken(obj: any): obj is Token;
-/**
- * Bitcoin token type (BTC on on-chain or lightning)
- *
- * @category Tokens
- */
-export type BtcToken<L = boolean> = Token & {
-    chainId: L extends true ? "LIGHTNING" : "BITCOIN";
-    ticker: "BTC";
-    name: L extends true ? "Bitcoin (lightning L2)" : "Bitcoin (on-chain L1)";
-    decimals: 8;
-    displayDecimals: 8;
-    address: "";
-    chain: "BTC";
-    lightning: L;
-    toString: () => L extends true ? "BTC-LN" : "BTC";
-};
-/**
- * Type guard for {@link BtcToken} (token on the bitcoin network - lightning or on-chain)
- *
- * @category Tokens
- */
-export declare function isBtcToken(obj: any): obj is BtcToken;
-/**
- * Predefined Bitcoin token constants
- *
- * @category Tokens
- */
-export declare const BitcoinTokens: {
-    BTC: BtcToken<false>;
-    BTCLN: BtcToken<true>;
-};
-/**
- * Token on the smart chain
- *
- * @category Tokens
- */
-export type SCToken<ChainIdentifier extends string = string> = Token<ChainIdentifier> & {
-    chainId: ChainIdentifier;
-    chain: "SC";
-    toString: () => `${ChainIdentifier}-${string}`;
-};
-/**
- * Type guard for {@link SCToken} (token on the smart chain)
- * @category Tokens
- */
-export declare function isSCToken<ChainIdentifier extends string = string>(obj: any, chainIdentifier?: ChainIdentifier[]): obj is SCToken<ChainIdentifier>;
+/**
+ * Type for all token types (BTC or smart chain)
+ *
+ * @category Tokens
+ */
+export type Token<ChainIdentifier extends string = string> = {
+    /**
+     * Chain identifier for the token's chain
+     */
+    chainId: ChainIdentifier | "BITCOIN" | "LIGHTNING";
+    /**
+     * Ticker of the token
+     */
+    ticker: string;
+    /**
+     * Full name of the token
+     */
+    name: string;
+    /**
+     * Actual decimal places of the tokens
+     */
+    decimals: number;
+    /**
+     * The decimal places that should be rendered and displayed to the user
+     */
+    displayDecimals?: number;
+    /**
+     * Address of the token contract, or `""` for Bitcoin
+     */
+    address: string;
+    /**
+     * Legacy chain identifier distinguishing between Smart Chain and Bitcoin tokens
+     */
+    chain: "SC" | "BTC";
+    /**
+     * Legacy lightning flag, determines whether a Bitcoin token is an Lightning or on-chain one
+     */
+    lightning?: boolean;
+    /**
+     * Equality check between tokens
+     */
+    equals: (other: Token) => boolean;
+    /**
+     * Returns the
+     */
+    toString: () => string;
+};
+/**
+ * Type guard for a {@link Token} type, encompassing all tokens (BTC or smart chain)
+ *
+ * @category Tokens
+ */
+export declare function isToken(obj: any): obj is Token;
+/**
+ * Bitcoin token type (BTC on on-chain or lightning)
+ *
+ * @category Tokens
+ */
+export type BtcToken<L = boolean> = Token & {
+    chainId: L extends true ? "LIGHTNING" : "BITCOIN";
+    ticker: "BTC";
+    name: L extends true ? "Bitcoin (lightning L2)" : "Bitcoin (on-chain L1)";
+    decimals: 8;
+    displayDecimals: 8;
+    address: "";
+    chain: "BTC";
+    lightning: L;
+    toString: () => L extends true ? "BTC-LN" : "BTC";
+};
+/**
+ * Type guard for {@link BtcToken} (token on the bitcoin network - lightning or on-chain)
+ *
+ * @category Tokens
+ */
+export declare function isBtcToken(obj: any): obj is BtcToken;
+/**
+ * Predefined Bitcoin token constants
+ *
+ * @category Tokens
+ */
+export declare const BitcoinTokens: {
+    BTC: BtcToken<false>;
+    BTCLN: BtcToken<true>;
+};
+/**
+ * Token on the smart chain
+ *
+ * @category Tokens
+ */
+export type SCToken<ChainIdentifier extends string = string> = Token<ChainIdentifier> & {
+    chainId: ChainIdentifier;
+    chain: "SC";
+    toString: () => `${ChainIdentifier}-${string}`;
+};
+/**
+ * Type guard for {@link SCToken} (token on the smart chain)
+ * @category Tokens
+ */
+export declare function isSCToken<ChainIdentifier extends string = string>(obj: any, chainIdentifier?: ChainIdentifier[]): obj is SCToken<ChainIdentifier>;