@atomiqlabs/sdk 8.8.3 → 8.8.4

package/src/types/SwapWithSigner.ts

@@ -1,61 +1,61 @@
-import {ISwap} from "../swaps/ISwap";
-import {ChainType} from "@atomiqlabs/base";
-import {IToBTCSwap} from "../swaps/escrow_swaps/tobtc/IToBTCSwap";
-import {IFromBTCSelfInitSwap} from "../swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap";
-import {FromBTCLNSwap} from "../swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap";
-import {FromBTCLNAutoSwap} from "../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap";
-import {SpvFromBTCSwap} from "../swaps/spv_swaps/SpvFromBTCSwap";
-
-/**
- * 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 function wrapSwapWithSigner<C extends ChainType, T extends ISwap<C>>(swap: T, signer: C["Signer"]): SwapWithSigner<T> {
-    return new Proxy(swap, {
-        get: (target, prop, receiver) => {
-            if (prop === "commit") {
-                if(swap instanceof IToBTCSwap || swap instanceof IFromBTCSelfInitSwap) {
-                    return (abortSignal?: AbortSignal, skipChecks?: boolean) =>
-                        swap.commit(signer, abortSignal, skipChecks);
-                }
-            }
-            if (prop === "refund") {
-                if(swap instanceof IToBTCSwap) {
-                    return (abortSignal?: AbortSignal) =>
-                        swap.refund(signer, abortSignal);
-                }
-            }
-            if (prop === "claim") {
-                if(swap instanceof IFromBTCSelfInitSwap || swap instanceof FromBTCLNAutoSwap || swap instanceof SpvFromBTCSwap) {
-                    return (abortSignal?: AbortSignal) =>
-                        swap.claim(signer, abortSignal);
-                }
-            }
-            if (prop === "commitAndClaim") {
-                if(swap instanceof FromBTCLNSwap) {
-                    return (abortSignal?: AbortSignal, skipChecks?: boolean) =>
-                        swap.commitAndClaim(signer, abortSignal, skipChecks);
-                }
-            }
-
-            // Delegate other properties and methods to the original instance
-            return Reflect.get(target, prop, receiver);
-        }
-    }) as SwapWithSigner<T>;
-}
+import {ISwap} from "../swaps/ISwap";
+import {ChainType} from "@atomiqlabs/base";
+import {IToBTCSwap} from "../swaps/escrow_swaps/tobtc/IToBTCSwap";
+import {IFromBTCSelfInitSwap} from "../swaps/escrow_swaps/frombtc/IFromBTCSelfInitSwap";
+import {FromBTCLNSwap} from "../swaps/escrow_swaps/frombtc/ln/FromBTCLNSwap";
+import {FromBTCLNAutoSwap} from "../swaps/escrow_swaps/frombtc/ln_auto/FromBTCLNAutoSwap";
+import {SpvFromBTCSwap} from "../swaps/spv_swaps/SpvFromBTCSwap";
+
+/**
+ * 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 function wrapSwapWithSigner<C extends ChainType, T extends ISwap<C>>(swap: T, signer: C["Signer"]): SwapWithSigner<T> {
+    return new Proxy(swap, {
+        get: (target, prop, receiver) => {
+            if (prop === "commit") {
+                if(swap instanceof IToBTCSwap || swap instanceof IFromBTCSelfInitSwap) {
+                    return (abortSignal?: AbortSignal, skipChecks?: boolean) =>
+                        swap.commit(signer, abortSignal, skipChecks);
+                }
+            }
+            if (prop === "refund") {
+                if(swap instanceof IToBTCSwap) {
+                    return (abortSignal?: AbortSignal) =>
+                        swap.refund(signer, abortSignal);
+                }
+            }
+            if (prop === "claim") {
+                if(swap instanceof IFromBTCSelfInitSwap || swap instanceof FromBTCLNAutoSwap || swap instanceof SpvFromBTCSwap) {
+                    return (abortSignal?: AbortSignal) =>
+                        swap.claim(signer, abortSignal);
+                }
+            }
+            if (prop === "commitAndClaim") {
+                if(swap instanceof FromBTCLNSwap) {
+                    return (abortSignal?: AbortSignal, skipChecks?: boolean) =>
+                        swap.commitAndClaim(signer, abortSignal, skipChecks);
+                }
+            }
+
+            // Delegate other properties and methods to the original instance
+            return Reflect.get(target, prop, receiver);
+        }
+    }) as SwapWithSigner<T>;
+}

package/src/types/Token.ts

@@ -1,163 +1,163 @@
-/**
- * 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 compatibility
-    /**
-     * 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,
-
-    // helpers
-    /**
-     * 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 function isToken(obj: any): obj is Token {
-    return typeof (obj) === "object" &&
-      (obj.chain === "SC" || obj.chain === "BTC") &&
-      typeof (obj.ticker) === "string" &&
-      typeof (obj.decimals) === "number" &&
-      typeof (obj.name) === "string";
-}
-
-/**
- * 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: "",
-
-    // legacy compatibility
-    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 function isBtcToken(obj: any): obj is BtcToken {
-    return typeof (obj) === "object" &&
-        obj.chain === "BTC" &&
-        typeof (obj.lightning) === "boolean" &&
-        typeof (obj.ticker) === "string" &&
-        typeof (obj.decimals) === "number" &&
-        typeof (obj.name) === "string";
-}
-
-/**
- * Predefined Bitcoin token constants
- *
- * @category Tokens
- */
-export const BitcoinTokens: {
-    BTC: BtcToken<false>,
-    BTCLN: BtcToken<true>
-} = {
-    BTC: {
-        chain: "BTC",
-        chainId: "BITCOIN",
-        lightning: false,
-        ticker: "BTC",
-        decimals: 8,
-        displayDecimals: 8,
-        name: "Bitcoin (on-chain L1)",
-        address: "",
-        equals: (other: Token) => other.chainId==="BITCOIN" && other.ticker==="BTC",
-        toString: () => "BTC"
-    },
-    BTCLN: {
-        chain: "BTC",
-        chainId: "LIGHTNING",
-        lightning: true,
-        ticker: "BTC",
-        decimals: 8,
-        displayDecimals: 8,
-        name: "Bitcoin (lightning L2)",
-        address: "",
-        equals: (other: Token) => other.chainId==="LIGHTNING" && other.ticker==="BTC",
-        toString: () => "BTC-LN"
-    }
-};
-
-/**
- * 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 function isSCToken<ChainIdentifier extends string = string>(obj: any, chainIdentifier?: ChainIdentifier[]): obj is SCToken<ChainIdentifier> {
-    return typeof (obj) === "object" &&
-        obj.chain === "SC" &&
-        typeof (obj.chainId) === "string" &&
-        (chainIdentifier==null || chainIdentifier.includes(obj.chainId)) &&
-        typeof (obj.address) === "string" &&
-        typeof (obj.ticker) === "string" &&
-        typeof (obj.decimals) === "number" &&
-        typeof (obj.name) === "string";
-}
+/**
+ * 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 compatibility
+    /**
+     * 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,
+
+    // helpers
+    /**
+     * 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 function isToken(obj: any): obj is Token {
+    return typeof (obj) === "object" &&
+      (obj.chain === "SC" || obj.chain === "BTC") &&
+      typeof (obj.ticker) === "string" &&
+      typeof (obj.decimals) === "number" &&
+      typeof (obj.name) === "string";
+}
+
+/**
+ * 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: "",
+
+    // legacy compatibility
+    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 function isBtcToken(obj: any): obj is BtcToken {
+    return typeof (obj) === "object" &&
+        obj.chain === "BTC" &&
+        typeof (obj.lightning) === "boolean" &&
+        typeof (obj.ticker) === "string" &&
+        typeof (obj.decimals) === "number" &&
+        typeof (obj.name) === "string";
+}
+
+/**
+ * Predefined Bitcoin token constants
+ *
+ * @category Tokens
+ */
+export const BitcoinTokens: {
+    BTC: BtcToken<false>,
+    BTCLN: BtcToken<true>
+} = {
+    BTC: {
+        chain: "BTC",
+        chainId: "BITCOIN",
+        lightning: false,
+        ticker: "BTC",
+        decimals: 8,
+        displayDecimals: 8,
+        name: "Bitcoin (on-chain L1)",
+        address: "",
+        equals: (other: Token) => other.chainId==="BITCOIN" && other.ticker==="BTC",
+        toString: () => "BTC"
+    },
+    BTCLN: {
+        chain: "BTC",
+        chainId: "LIGHTNING",
+        lightning: true,
+        ticker: "BTC",
+        decimals: 8,
+        displayDecimals: 8,
+        name: "Bitcoin (lightning L2)",
+        address: "",
+        equals: (other: Token) => other.chainId==="LIGHTNING" && other.ticker==="BTC",
+        toString: () => "BTC-LN"
+    }
+};
+
+/**
+ * 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 function isSCToken<ChainIdentifier extends string = string>(obj: any, chainIdentifier?: ChainIdentifier[]): obj is SCToken<ChainIdentifier> {
+    return typeof (obj) === "object" &&
+        obj.chain === "SC" &&
+        typeof (obj.chainId) === "string" &&
+        (chainIdentifier==null || chainIdentifier.includes(obj.chainId)) &&
+        typeof (obj.address) === "string" &&
+        typeof (obj.ticker) === "string" &&
+        typeof (obj.decimals) === "number" &&
+        typeof (obj.name) === "string";
+}