@atomiqlabs/sdk 8.8.3 → 8.9.0

package/dist/types/SwapExecutionStep.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Execution step describing destination-side setup required before the swap can continue.
+ *
+ * @category Swap Steps
+ */
+export type SwapExecutionStepSetup<Chain extends string = string> = {
+    type: "Setup";
+    side: "destination";
+    chain: Chain;
+    title: string;
+    description: string;
+    /**
+     * Current status of the setup step.
+     *
+     * - `awaiting`: The setup transaction or action still needs to be performed.
+     * - `completed`: The setup was already completed successfully.
+     * - `soft_expired`: The setup should be treated as expired by the user, but it may still progress because of in-flight or background processing.
+     * - `expired`: The setup can no longer be performed because the swap expired.
+     */
+    status: "awaiting" | "completed" | "soft_expired" | "expired";
+    setupTxId?: string;
+};
+/**
+ * Type guard for {@link SwapExecutionStepSetup}
+ *
+ * @category Swap Steps
+ */
+export declare function isSwapExecutionStepSetup<Chain extends string = string>(obj: any, chain?: Chain): obj is SwapExecutionStepSetup<Chain>;
+/**
+ * Execution step describing the user payment that initiates or funds the swap.
+ *
+ * @category Swap Steps
+ */
+export type SwapExecutionStepPayment<Chain extends string = string> = {
+    type: "Payment";
+    side: "source";
+    chain: Chain;
+    title: string;
+    description: string;
+    /**
+     * Current status of the payment step.
+     *
+     * - `inactive`: The payment step is not yet active because a previous step must complete first.
+     * - `awaiting`: The payment is expected, but no payment transaction is known yet.
+     * - `received`: A payment transaction is known, but it is not yet fully confirmed.
+     * - `confirmed`: The payment was confirmed and fully satisfies the swap requirements.
+     * - `soft_expired`: The payment should be treated as expired by the user, but it may still progress because of in-flight or background processing.
+     * - `expired`: The payment step can no longer be completed because the swap expired.
+     */
+    status: "inactive" | "awaiting" | "received" | "confirmed" | "soft_expired" | "expired";
+    /**
+     * Optional confirmation progress for Bitcoin on-chain payments.
+     */
+    confirmations?: {
+        /**
+         * Number of confirmations currently observed for the payment.
+         */
+        current: number;
+        /**
+         * Number of confirmations required before the payment is considered final.
+         */
+        target: number;
+        /**
+         * Estimated remaining time in seconds until the target confirmation count is reached.
+         *
+         * Can be `-1` if the estimate is not available.
+         */
+        etaSeconds: number;
+    };
+    initTxId?: string;
+    settleTxId?: string;
+};
+/**
+ * Type guard for {@link SwapExecutionStepPayment}
+ *
+ * @category Swap Steps
+ */
+export declare function isSwapExecutionStepPayment<Chain extends string = string>(obj: any, chain?: Chain): obj is SwapExecutionStepPayment<Chain>;
+/**
+ * Execution step describing payout or settlement on the destination side of the swap.
+ *
+ * @category Swap Steps
+ */
+export type SwapExecutionStepSettlement<Chain extends string = string, AdditionalStatuses extends "awaiting_automatic" | "awaiting_manual" | "soft_settled" = "awaiting_automatic" | "awaiting_manual" | "soft_settled"> = {
+    type: "Settlement";
+    side: "destination";
+    chain: Chain;
+    title: string;
+    description: string;
+    /**
+     * Current status of the settlement step.
+     *
+     * - `inactive`: The settlement step is not yet active because a previous step must complete first.
+     * - `waiting_lp`: The swap is waiting for the intermediary (LP) to create or process the destination-side payout.
+     * - `awaiting_automatic`: The swap is waiting for automatic settlement by watchtowers.
+     * - `awaiting_manual`: The swap is ready for manual destination-side settlement by the user.
+     * - `soft_settled`: The user already received the payout, but the swap is not yet fully finalized on the source side.
+     * - `soft_expired`: The settlement should be treated as expired by the user, but it may still progress because of in-flight or background processing.
+     * - `settled`: The settlement completed successfully.
+     * - `expired`: Settlement is no longer possible because the swap expired or failed.
+     */
+    status: "inactive" | "waiting_lp" | "soft_expired" | "settled" | "expired" | AdditionalStatuses;
+    initTxId?: string;
+    settleTxId?: string;
+};
+/**
+ * Type guard for {@link SwapExecutionStepSettlement}
+ *
+ * @category Swap Steps
+ */
+export declare function isSwapExecutionStepSettlement<Chain extends string = string>(obj: any, chain?: Chain): obj is SwapExecutionStepSettlement<Chain>;
+/**
+ * Execution step describing a source-side refund path after a failed swap.
+ *
+ * @category Swap Steps
+ */
+export type SwapExecutionStepRefund<Chain extends string = string> = {
+    type: "Refund";
+    side: "source";
+    chain: Chain;
+    title: string;
+    description: string;
+    /**
+     * Current status of the refund step.
+     *
+     * - `inactive`: The refund path is not currently available.
+     * - `awaiting`: The swap can be refunded and the user may perform the refund action.
+     * - `refunded`: The refund was completed successfully.
+     */
+    status: "inactive" | "awaiting" | "refunded";
+    refundTxId?: string;
+};
+/**
+ * Type guard for {@link SwapExecutionStepRefund}
+ *
+ * @category Swap Steps
+ */
+export declare function isSwapExecutionStepRefund<Chain extends string = string>(obj: any, chain?: Chain): obj is SwapExecutionStepRefund<Chain>;
+/**
+ * Union of all supported swap execution step variants.
+ *
+ * @category Swap Steps
+ */
+export type SwapExecutionStep = SwapExecutionStepSetup | SwapExecutionStepPayment | SwapExecutionStepSettlement | SwapExecutionStepRefund;

package/dist/types/SwapExecutionStep.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSwapExecutionStepRefund = exports.isSwapExecutionStepSettlement = exports.isSwapExecutionStepPayment = exports.isSwapExecutionStepSetup = void 0;
+/**
+ * Type guard for {@link SwapExecutionStepSetup}
+ *
+ * @category Swap Steps
+ */
+function isSwapExecutionStepSetup(obj, chain) {
+    return typeof (obj) === "object" &&
+        obj.type === "Setup" &&
+        obj.side === "destination" &&
+        typeof (obj.chain) === "string" &&
+        (chain == null || obj.chain === chain) &&
+        typeof (obj.title) === "string" &&
+        typeof (obj.description) === "string" &&
+        (obj.status === "awaiting" ||
+            obj.status === "completed" ||
+            obj.status === "soft_expired" ||
+            obj.status === "expired");
+}
+exports.isSwapExecutionStepSetup = isSwapExecutionStepSetup;
+/**
+ * Type guard for {@link SwapExecutionStepPayment}
+ *
+ * @category Swap Steps
+ */
+function isSwapExecutionStepPayment(obj, chain) {
+    return typeof (obj) === "object" &&
+        obj.type === "Payment" &&
+        obj.side === "source" &&
+        typeof (obj.chain) === "string" &&
+        (chain == null || obj.chain === chain) &&
+        typeof (obj.title) === "string" &&
+        typeof (obj.description) === "string" &&
+        (obj.status === "inactive" ||
+            obj.status === "awaiting" ||
+            obj.status === "received" ||
+            obj.status === "confirmed" ||
+            obj.status === "soft_expired" ||
+            obj.status === "expired") &&
+        (obj.confirmations == null ||
+            (typeof (obj.confirmations) === "object" &&
+                typeof (obj.confirmations.current) === "number" &&
+                typeof (obj.confirmations.target) === "number" &&
+                typeof (obj.confirmations.etaSeconds) === "number"));
+}
+exports.isSwapExecutionStepPayment = isSwapExecutionStepPayment;
+/**
+ * Type guard for {@link SwapExecutionStepSettlement}
+ *
+ * @category Swap Steps
+ */
+function isSwapExecutionStepSettlement(obj, chain) {
+    return typeof (obj) === "object" &&
+        obj.type === "Settlement" &&
+        obj.side === "destination" &&
+        typeof (obj.chain) === "string" &&
+        (chain == null || obj.chain === chain) &&
+        typeof (obj.title) === "string" &&
+        typeof (obj.description) === "string" &&
+        (obj.status === "inactive" ||
+            obj.status === "waiting_lp" ||
+            obj.status === "awaiting_automatic" ||
+            obj.status === "awaiting_manual" ||
+            obj.status === "soft_settled" ||
+            obj.status === "soft_expired" ||
+            obj.status === "settled" ||
+            obj.status === "expired");
+}
+exports.isSwapExecutionStepSettlement = isSwapExecutionStepSettlement;
+/**
+ * Type guard for {@link SwapExecutionStepRefund}
+ *
+ * @category Swap Steps
+ */
+function isSwapExecutionStepRefund(obj, chain) {
+    return typeof (obj) === "object" &&
+        obj.type === "Refund" &&
+        obj.side === "source" &&
+        typeof (obj.chain) === "string" &&
+        (chain == null || obj.chain === chain) &&
+        typeof (obj.title) === "string" &&
+        typeof (obj.description) === "string" &&
+        (obj.status === "inactive" || obj.status === "awaiting" || obj.status === "refunded");
+}
+exports.isSwapExecutionStepRefund = isSwapExecutionStepRefund;

package/dist/types/TokenAmount.d.ts

@@ -60,6 +60,12 @@ export type TokenAmount<T extends Token = Token, Known extends boolean = boolean
      */
     isUnknown: Known extends true ? false : true;
 };
+/**
+ * Type guard for {@link TokenAmount}
+ *
+ * @category Tokens
+ */
+export declare function isTokenAmount<T extends Token = Token, Known extends boolean = boolean>(obj: any, token?: T, known?: Known): obj is TokenAmount<T, Known>;
 /**
  * Factory function to create a TokenAmount
  *

package/dist/types/TokenAmount.js

@@ -1,7 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toTokenAmount = void 0;
+exports.toTokenAmount = exports.isTokenAmount = void 0;
+const Token_1 = require("./Token");
 const Utils_1 = require("../utils/Utils");
+/**
+ * Type guard for {@link TokenAmount}
+ *
+ * @category Tokens
+ */
+function isTokenAmount(obj, token, known) {
+    const hasExpectedKnownState = known == null
+        ? ((typeof (obj?.rawAmount) === "bigint" && obj?.isUnknown === false) ||
+            (obj?.rawAmount === undefined && obj?.isUnknown === true))
+        : known
+            ? typeof (obj?.rawAmount) === "bigint" && obj?.isUnknown === false
+            : obj?.rawAmount === undefined && obj?.isUnknown === true;
+    return obj != null &&
+        typeof (obj) === "object" &&
+        typeof (obj.amount) === "string" &&
+        typeof (obj._amount) === "number" &&
+        (token == null ? (0, Token_1.isToken)(obj.token) : token.equals(obj.token)) &&
+        typeof (obj.currentUsdValue) === "function" &&
+        typeof (obj.usdValue) === "function" &&
+        (obj.pastUsdValue == null || typeof (obj.pastUsdValue) === "number") &&
+        typeof (obj.toString) === "function" &&
+        hasExpectedKnownState;
+}
+exports.isTokenAmount = isTokenAmount;
 /**
  * Factory function to create a TokenAmount
  *

package/dist/utils/BitcoinUtils.d.ts

@@ -14,3 +14,5 @@ export declare function getDummyAddress(network: BTC_NETWORK, type: CoinselectAd
  * @param _psbt
  */
 export declare function parsePsbtTransaction(_psbt: Transaction | string): Transaction;
+export declare function getVoutIndex(psbt: Transaction, network: BTC_NETWORK, address: string, amount: bigint): number | undefined;
+export declare function getSenderAddress(psbt: Transaction, network: BTC_NETWORK, inputIndex?: number): string | undefined;

package/dist/utils/BitcoinUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsePsbtTransaction = exports.getDummyAddress = exports.getDummyOutputScript = exports.toCoinselectAddressType = exports.toOutputScript = exports.fromOutputScript = void 0;
+exports.getSenderAddress = exports.getVoutIndex = exports.parsePsbtTransaction = exports.getDummyAddress = exports.getDummyOutputScript = exports.toCoinselectAddressType = exports.toOutputScript = exports.fromOutputScript = void 0;
 const utils_1 = require("@scure/btc-signer/utils");
 const buffer_1 = require("buffer");
 const btc_signer_1 = require("@scure/btc-signer");
@@ -139,3 +139,36 @@ function parsePsbtTransaction(_psbt) {
     }
 }
 exports.parsePsbtTransaction = parsePsbtTransaction;
+function getVoutIndex(psbt, network, address, amount) {
+    const script = toOutputScript(network, address);
+    for (let i = 0; i < psbt.outputsLength; i++) {
+        const output = psbt.getOutput(i);
+        if (output.amount === amount &&
+            output.script != null &&
+            script.equals(buffer_1.Buffer.from(output.script))) {
+            return i;
+        }
+    }
+}
+exports.getVoutIndex = getVoutIndex;
+function getSenderAddress(psbt, network, inputIndex = 0) {
+    if (psbt.inputsLength <= inputIndex)
+        return undefined;
+    const input = psbt.getInput(inputIndex);
+    let script;
+    if (input.witnessUtxo?.script != null) {
+        script = input.witnessUtxo.script;
+    }
+    else if (input.nonWitnessUtxo != null && input.index != null) {
+        script = input.nonWitnessUtxo.outputs[input.index]?.script;
+    }
+    if (script == null)
+        return undefined;
+    try {
+        return (0, btc_signer_1.Address)(network).encode(btc_signer_1.OutScript.decode(script));
+    }
+    catch (e) {
+        return buffer_1.Buffer.from(script).toString("hex");
+    }
+}
+exports.getSenderAddress = getSenderAddress;

package/dist/utils/Utils.d.ts

@@ -51,8 +51,10 @@ export declare function mapToArray<K, V, Output>(map: Map<K, V>, translator: (ke
  * Creates a new abort controller that will abort if the passed abort signal aborts
  *
  * @param abortSignal
+ * @param timeoutSeconds
+ * @param timeoutMessage
  */
-export declare function extendAbortController(abortSignal?: AbortSignal): AbortController;
+export declare function extendAbortController(abortSignal?: AbortSignal, timeoutSeconds?: number, timeoutMessage?: string): AbortController;
 export declare function bigIntMin(a: bigint, b: bigint): bigint;
 export declare function bigIntMin(a?: bigint, b?: bigint): bigint | undefined;
 export declare function bigIntMax(a: bigint, b: bigint): bigint;

package/dist/utils/Utils.js

@@ -96,13 +96,19 @@ exports.mapToArray = mapToArray;
  * Creates a new abort controller that will abort if the passed abort signal aborts
  *
  * @param abortSignal
+ * @param timeoutSeconds
+ * @param timeoutMessage
  */
-function extendAbortController(abortSignal) {
+function extendAbortController(abortSignal, timeoutSeconds, timeoutMessage) {
     const _abortController = new AbortController();
     if (abortSignal != null) {
         abortSignal.throwIfAborted();
         abortSignal.onabort = () => _abortController.abort(abortSignal.reason);
     }
+    if (timeoutSeconds != null) {
+        const timeout = setTimeout(() => _abortController.abort(new Error(timeoutMessage ?? "Timed out")), timeoutSeconds * 1000);
+        _abortController.signal.addEventListener("abort", () => clearTimeout(timeout));
+    }
     return _abortController;
 }
 exports.extendAbortController = extendAbortController;

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "@atomiqlabs/sdk",
-  "version": "8.8.3",
+  "version": "8.9.0",
   "description": "atomiq labs SDK for cross-chain swaps between smart chains and bitcoin",
   "main": "./dist/index.js",
   "types:": "./dist/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build:ts4": "npx -p typescript@4.9 tsc --noEmit",
-    "build:ts5": "npx -p typescript@5.9 tsc --noEmit"
+    "build": "npx -y -p typescript@4.9 tsc",
+    "build:ts4": "npx -y -p typescript@4.9 tsc --noEmit",
+    "build:ts5": "npx -y -p typescript@5.9 tsc --noEmit"
   },
   "files": [
     "/dist",
-    "/src"
+    "/src",
+    "/api"
   ],
   "keywords": [
     "Bitcoin",
@@ -28,6 +30,7 @@
     "@atomiqlabs/btc-mempool": "^1.0.4",
     "@atomiqlabs/messenger-nostr": "^2.0.0",
     "@noble/ciphers": "^1.2.1",
+    "@noble/curves": "^1.9.7",
     "@noble/hashes": "^1.7.1",
     "@scure/base": "^1.2.4",
     "@scure/bip32": "^2.0.1",