@atomiqlabs/sdk 8.7.7 → 8.8.4

package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.d.ts

@@ -1,98 +1,98 @@
-import { IEscrowSwap, IEscrowSwapInit } from "./IEscrowSwap";
-import { ChainType, SignatureData, SwapData } from "@atomiqlabs/base";
-import { IEscrowSwapDefinition, IEscrowSwapWrapper } from "./IEscrowSwapWrapper";
-import { SwapTypeDefinition } from "../ISwapWrapper";
-import { TokenAmount } from "../../types/TokenAmount";
-import { SCToken } from "../../types/Token";
-export type IEscrowSelfInitSwapInit<T extends SwapData> = IEscrowSwapInit<T> & {
-    feeRate: string;
-    signatureData?: SignatureData;
-};
-export declare function isIEscrowSelfInitSwapInit<T extends SwapData>(obj: any): obj is IEscrowSelfInitSwapInit<T>;
-export type IEscrowSelfInitSwapDefinition<T extends ChainType, W extends IEscrowSwapWrapper<T, any>, S extends IEscrowSelfInitSwap<T>> = SwapTypeDefinition<T, W, S>;
-/**
- * Base class for escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives) where the
- *  user needs to initiate the escrow on the smart chain side
- *
- * @category Swaps/Abstract
- */
-export declare abstract class IEscrowSelfInitSwap<T extends ChainType = ChainType, D extends IEscrowSelfInitSwapDefinition<T, IEscrowSwapWrapper<T, D>, IEscrowSelfInitSwap<T, D, S>> = IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, any>, IEscrowSelfInitSwap<T, any, any>>, S extends number = number> extends IEscrowSwap<T, D, S> {
-    /**
-     * Fee rate to be used for the escrow initiation transaction
-     * @internal
-     */
-    protected readonly feeRate: string;
-    /**
-     * Signature data received from the intermediary (LP) allowing the user
-     *  to initiate the swap escrow
-     * @internal
-     */
-    protected signatureData?: SignatureData;
-    protected constructor(wrapper: D["Wrapper"], obj: any);
-    protected constructor(wrapper: D["Wrapper"], swapInit: IEscrowSelfInitSwapInit<T["Data"]>);
-    /**
-     * Periodically checks for init signature's expiry
-     *
-     * @param intervalSeconds How often to check (in seconds), default to 5s
-     * @param abortSignal
-     * @internal
-     */
-    protected watchdogWaitTillSignatureExpiry(intervalSeconds?: number, abortSignal?: AbortSignal): Promise<void>;
-    /**
-     * Get the estimated smart chain fee of the commit transaction
-     * @internal
-     */
-    protected getCommitFee(): Promise<bigint>;
-    /**
-     * Returns the transaction fee paid on the smart chain side to initiate the escrow
-     */
-    getSmartChainNetworkFee(): Promise<TokenAmount<SCToken<T["ChainId"]>, true>>;
-    /**
-     * Checks if the initiator/sender has enough balance on the smart chain side
-     *  to cover the transaction fee for processing the swap
-     */
-    abstract hasEnoughForTxFees(): Promise<{
-        enoughBalance: boolean;
-        balance: TokenAmount<SCToken<T["ChainId"]>, true>;
-        required: TokenAmount<SCToken<T["ChainId"]>, true>;
-    }>;
-    /**
-     * Returns transactions for initiating (committing) the escrow on the smart chain side. After sending the
-     *  transactions manually be sure to call the {@link waitTillCommited} function to wait till the initiation
-     *  transaction is observed, processed by the SDK and state of the swap properly updated.
-     *
-     * @param 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`)
-     */
-    abstract txsCommit(skipChecks?: boolean): Promise<T["TX"][]>;
-    /**
-     * Initiates (commits) the escrow on the smart chain side
-     *
-     * @param _signer Signer to sign the transactions with, must be the same as used in the initialization
-     * @param abortSignal Abort signal
-     * @param 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 onBeforeTxSent Callback called before the transactions are broadcasted
-     */
-    abstract commit(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal, skipChecks?: boolean, onBeforeTxSent?: (txId: string) => void): Promise<string>;
-    /**
-     * Waits till a swap is initiated (committed) on-chain, should be called after sending the commit
-     *  transactions ({@link txsCommit}) manually to wait till the SDK processes the escrow
-     *  initialization and updates the swap state accordingly
-     *
-     * @param abortSignal AbortSignal
-     */
-    abstract waitTillCommited(abortSignal?: AbortSignal): Promise<void>;
-    /**
-     * Checks if the swap's quote is expired for good (i.e. the swap strictly cannot be committed on-chain anymore)
-     */
-    _verifyQuoteDefinitelyExpired(): Promise<boolean>;
-    /**
-     * Checks if the swap's quote is still valid
-     */
-    _verifyQuoteValid(): Promise<boolean>;
-    /**
-     * @inheritDoc
-     */
-    serialize(): any;
-}
+import { IEscrowSwap, IEscrowSwapInit } from "./IEscrowSwap";
+import { ChainType, SignatureData, SwapData } from "@atomiqlabs/base";
+import { IEscrowSwapDefinition, IEscrowSwapWrapper } from "./IEscrowSwapWrapper";
+import { SwapTypeDefinition } from "../ISwapWrapper";
+import { TokenAmount } from "../../types/TokenAmount";
+import { SCToken } from "../../types/Token";
+export type IEscrowSelfInitSwapInit<T extends SwapData> = IEscrowSwapInit<T> & {
+    feeRate: string;
+    signatureData?: SignatureData;
+};
+export declare function isIEscrowSelfInitSwapInit<T extends SwapData>(obj: any): obj is IEscrowSelfInitSwapInit<T>;
+export type IEscrowSelfInitSwapDefinition<T extends ChainType, W extends IEscrowSwapWrapper<T, any>, S extends IEscrowSelfInitSwap<T>> = SwapTypeDefinition<T, W, S>;
+/**
+ * Base class for escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives) where the
+ *  user needs to initiate the escrow on the smart chain side
+ *
+ * @category Swaps/Abstract
+ */
+export declare abstract class IEscrowSelfInitSwap<T extends ChainType = ChainType, D extends IEscrowSelfInitSwapDefinition<T, IEscrowSwapWrapper<T, D>, IEscrowSelfInitSwap<T, D, S>> = IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, any>, IEscrowSelfInitSwap<T, any, any>>, S extends number = number> extends IEscrowSwap<T, D, S> {
+    /**
+     * Fee rate to be used for the escrow initiation transaction
+     * @internal
+     */
+    protected readonly feeRate: string;
+    /**
+     * Signature data received from the intermediary (LP) allowing the user
+     *  to initiate the swap escrow
+     * @internal
+     */
+    protected signatureData?: SignatureData;
+    protected constructor(wrapper: D["Wrapper"], obj: any);
+    protected constructor(wrapper: D["Wrapper"], swapInit: IEscrowSelfInitSwapInit<T["Data"]>);
+    /**
+     * Periodically checks for init signature's expiry
+     *
+     * @param intervalSeconds How often to check (in seconds), default to 5s
+     * @param abortSignal
+     * @internal
+     */
+    protected watchdogWaitTillSignatureExpiry(intervalSeconds?: number, abortSignal?: AbortSignal): Promise<void>;
+    /**
+     * Get the estimated smart chain fee of the commit transaction
+     * @internal
+     */
+    protected getCommitFee(): Promise<bigint>;
+    /**
+     * Returns the transaction fee paid on the smart chain side to initiate the escrow
+     */
+    getSmartChainNetworkFee(): Promise<TokenAmount<SCToken<T["ChainId"]>, true>>;
+    /**
+     * Checks if the initiator/sender has enough balance on the smart chain side
+     *  to cover the transaction fee for processing the swap
+     */
+    abstract hasEnoughForTxFees(): Promise<{
+        enoughBalance: boolean;
+        balance: TokenAmount<SCToken<T["ChainId"]>, true>;
+        required: TokenAmount<SCToken<T["ChainId"]>, true>;
+    }>;
+    /**
+     * Returns transactions for initiating (committing) the escrow on the smart chain side. After sending the
+     *  transactions manually be sure to call the {@link waitTillCommited} function to wait till the initiation
+     *  transaction is observed, processed by the SDK and state of the swap properly updated.
+     *
+     * @param 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`)
+     */
+    abstract txsCommit(skipChecks?: boolean): Promise<T["TX"][]>;
+    /**
+     * Initiates (commits) the escrow on the smart chain side
+     *
+     * @param _signer Signer to sign the transactions with, must be the same as used in the initialization
+     * @param abortSignal Abort signal
+     * @param 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 onBeforeTxSent Callback called before the transactions are broadcasted
+     */
+    abstract commit(_signer: T["Signer"] | T["NativeSigner"], abortSignal?: AbortSignal, skipChecks?: boolean, onBeforeTxSent?: (txId: string) => void): Promise<string>;
+    /**
+     * Waits till a swap is initiated (committed) on-chain, should be called after sending the commit
+     *  transactions ({@link txsCommit}) manually to wait till the SDK processes the escrow
+     *  initialization and updates the swap state accordingly
+     *
+     * @param abortSignal AbortSignal
+     */
+    abstract waitTillCommited(abortSignal?: AbortSignal): Promise<void>;
+    /**
+     * Checks if the swap's quote is expired for good (i.e. the swap strictly cannot be committed on-chain anymore)
+     */
+    _verifyQuoteDefinitelyExpired(): Promise<boolean>;
+    /**
+     * Checks if the swap's quote is still valid
+     */
+    _verifyQuoteValid(): Promise<boolean>;
+    /**
+     * @inheritDoc
+     */
+    serialize(): any;
+}

package/dist/swaps/escrow_swaps/IEscrowSelfInitSwap.js

@@ -1,126 +1,126 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IEscrowSelfInitSwap = exports.isIEscrowSelfInitSwapInit = void 0;
-const IEscrowSwap_1 = require("./IEscrowSwap");
-const base_1 = require("@atomiqlabs/base");
-const TokenAmount_1 = require("../../types/TokenAmount");
-const TimeoutUtils_1 = require("../../utils/TimeoutUtils");
-function isIEscrowSelfInitSwapInit(obj) {
-    return typeof obj === "object" &&
-        typeof (obj.feeRate) === "string" &&
-        (obj.signatureData == null || (typeof (obj.signatureData) === "object" &&
-            typeof (obj.signatureData.prefix) === "string" &&
-            typeof (obj.signatureData.timeout) === "string" &&
-            typeof (obj.signatureData.signature) === "string")) &&
-        (0, IEscrowSwap_1.isIEscrowSwapInit)(obj);
-}
-exports.isIEscrowSelfInitSwapInit = isIEscrowSelfInitSwapInit;
-/**
- * Base class for escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives) where the
- *  user needs to initiate the escrow on the smart chain side
- *
- * @category Swaps/Abstract
- */
-class IEscrowSelfInitSwap extends IEscrowSwap_1.IEscrowSwap {
-    constructor(wrapper, swapInitOrObj) {
-        super(wrapper, swapInitOrObj);
-        if (isIEscrowSelfInitSwapInit(swapInitOrObj)) {
-            this.feeRate = swapInitOrObj.feeRate;
-            this.signatureData = swapInitOrObj.signatureData;
-        }
-        else {
-            if (swapInitOrObj.signature != null)
-                this.signatureData = {
-                    prefix: swapInitOrObj.prefix,
-                    timeout: swapInitOrObj.timeout,
-                    signature: swapInitOrObj.signature
-                };
-            this.feeRate = swapInitOrObj.feeRate;
-        }
-    }
-    //////////////////////////////
-    //// Watchdogs
-    /**
-     * Periodically checks for init signature's expiry
-     *
-     * @param intervalSeconds How often to check (in seconds), default to 5s
-     * @param abortSignal
-     * @internal
-     */
-    async watchdogWaitTillSignatureExpiry(intervalSeconds, abortSignal) {
-        if (this._data == null || this.signatureData == null)
-            throw new Error("Tried to await signature expiry but data or signature is null, invalid state?");
-        intervalSeconds ??= 5;
-        let expired = false;
-        while (!expired) {
-            await (0, TimeoutUtils_1.timeoutPromise)(intervalSeconds * 1000, abortSignal);
-            try {
-                expired = await this._contract.isInitAuthorizationExpired(this._data, this.signatureData);
-            }
-            catch (e) {
-                this.logger.error("watchdogWaitTillSignatureExpiry(): Error when checking signature expiry: ", e);
-            }
-        }
-        if (abortSignal != null)
-            abortSignal.throwIfAborted();
-    }
-    //////////////////////////////
-    //// Amounts & fees
-    /**
-     * Get the estimated smart chain fee of the commit transaction
-     * @internal
-     */
-    getCommitFee() {
-        return this._contract.getCommitFee(this._getInitiator(), this.getSwapData(), this.feeRate);
-    }
-    /**
-     * Returns the transaction fee paid on the smart chain side to initiate the escrow
-     */
-    async getSmartChainNetworkFee() {
-        const swapContract = this._contract;
-        return (0, TokenAmount_1.toTokenAmount)(await (swapContract.getRawCommitFee != null ?
-            swapContract.getRawCommitFee(this._getInitiator(), this.getSwapData(), this.feeRate) :
-            swapContract.getCommitFee(this._getInitiator(), this.getSwapData(), this.feeRate)), this.wrapper._getNativeToken(), this.wrapper._prices);
-    }
-    //////////////////////////////
-    //// Quote verification
-    /**
-     * Checks if the swap's quote is expired for good (i.e. the swap strictly cannot be committed on-chain anymore)
-     */
-    async _verifyQuoteDefinitelyExpired() {
-        if (this._data == null || this.signatureData == null)
-            throw new Error("data or signature data are null!");
-        return this._contract.isInitAuthorizationExpired(this._data, this.signatureData);
-    }
-    /**
-     * Checks if the swap's quote is still valid
-     */
-    async _verifyQuoteValid() {
-        if (this._data == null || this.signatureData == null)
-            throw new Error("data or signature data are null!");
-        try {
-            await this._contract.isValidInitAuthorization(this._getInitiator(), this._data, this.signatureData, this.feeRate);
-            return true;
-        }
-        catch (e) {
-            if (e instanceof base_1.SignatureVerificationError) {
-                return false;
-            }
-            throw e;
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    serialize() {
-        return {
-            ...super.serialize(),
-            prefix: this.signatureData?.prefix,
-            timeout: this.signatureData?.timeout,
-            signature: this.signatureData?.signature,
-            feeRate: this.feeRate == null ? null : this.feeRate.toString(),
-        };
-    }
-    ;
-}
-exports.IEscrowSelfInitSwap = IEscrowSelfInitSwap;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IEscrowSelfInitSwap = exports.isIEscrowSelfInitSwapInit = void 0;
+const IEscrowSwap_1 = require("./IEscrowSwap");
+const base_1 = require("@atomiqlabs/base");
+const TokenAmount_1 = require("../../types/TokenAmount");
+const TimeoutUtils_1 = require("../../utils/TimeoutUtils");
+function isIEscrowSelfInitSwapInit(obj) {
+    return typeof obj === "object" &&
+        typeof (obj.feeRate) === "string" &&
+        (obj.signatureData == null || (typeof (obj.signatureData) === "object" &&
+            typeof (obj.signatureData.prefix) === "string" &&
+            typeof (obj.signatureData.timeout) === "string" &&
+            typeof (obj.signatureData.signature) === "string")) &&
+        (0, IEscrowSwap_1.isIEscrowSwapInit)(obj);
+}
+exports.isIEscrowSelfInitSwapInit = isIEscrowSelfInitSwapInit;
+/**
+ * Base class for escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives) where the
+ *  user needs to initiate the escrow on the smart chain side
+ *
+ * @category Swaps/Abstract
+ */
+class IEscrowSelfInitSwap extends IEscrowSwap_1.IEscrowSwap {
+    constructor(wrapper, swapInitOrObj) {
+        super(wrapper, swapInitOrObj);
+        if (isIEscrowSelfInitSwapInit(swapInitOrObj)) {
+            this.feeRate = swapInitOrObj.feeRate;
+            this.signatureData = swapInitOrObj.signatureData;
+        }
+        else {
+            if (swapInitOrObj.signature != null)
+                this.signatureData = {
+                    prefix: swapInitOrObj.prefix,
+                    timeout: swapInitOrObj.timeout,
+                    signature: swapInitOrObj.signature
+                };
+            this.feeRate = swapInitOrObj.feeRate;
+        }
+    }
+    //////////////////////////////
+    //// Watchdogs
+    /**
+     * Periodically checks for init signature's expiry
+     *
+     * @param intervalSeconds How often to check (in seconds), default to 5s
+     * @param abortSignal
+     * @internal
+     */
+    async watchdogWaitTillSignatureExpiry(intervalSeconds, abortSignal) {
+        if (this._data == null || this.signatureData == null)
+            throw new Error("Tried to await signature expiry but data or signature is null, invalid state?");
+        intervalSeconds ??= 5;
+        let expired = false;
+        while (!expired) {
+            await (0, TimeoutUtils_1.timeoutPromise)(intervalSeconds * 1000, abortSignal);
+            try {
+                expired = await this._contract.isInitAuthorizationExpired(this._data, this.signatureData);
+            }
+            catch (e) {
+                this.logger.error("watchdogWaitTillSignatureExpiry(): Error when checking signature expiry: ", e);
+            }
+        }
+        if (abortSignal != null)
+            abortSignal.throwIfAborted();
+    }
+    //////////////////////////////
+    //// Amounts & fees
+    /**
+     * Get the estimated smart chain fee of the commit transaction
+     * @internal
+     */
+    getCommitFee() {
+        return this._contract.getCommitFee(this._getInitiator(), this.getSwapData(), this.feeRate);
+    }
+    /**
+     * Returns the transaction fee paid on the smart chain side to initiate the escrow
+     */
+    async getSmartChainNetworkFee() {
+        const swapContract = this._contract;
+        return (0, TokenAmount_1.toTokenAmount)(await (swapContract.getRawCommitFee != null ?
+            swapContract.getRawCommitFee(this._getInitiator(), this.getSwapData(), this.feeRate) :
+            swapContract.getCommitFee(this._getInitiator(), this.getSwapData(), this.feeRate)), this.wrapper._getNativeToken(), this.wrapper._prices);
+    }
+    //////////////////////////////
+    //// Quote verification
+    /**
+     * Checks if the swap's quote is expired for good (i.e. the swap strictly cannot be committed on-chain anymore)
+     */
+    async _verifyQuoteDefinitelyExpired() {
+        if (this._data == null || this.signatureData == null)
+            throw new Error("data or signature data are null!");
+        return this._contract.isInitAuthorizationExpired(this._data, this.signatureData);
+    }
+    /**
+     * Checks if the swap's quote is still valid
+     */
+    async _verifyQuoteValid() {
+        if (this._data == null || this.signatureData == null)
+            throw new Error("data or signature data are null!");
+        try {
+            await this._contract.isValidInitAuthorization(this._getInitiator(), this._data, this.signatureData, this.feeRate);
+            return true;
+        }
+        catch (e) {
+            if (e instanceof base_1.SignatureVerificationError) {
+                return false;
+            }
+            throw e;
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    serialize() {
+        return {
+            ...super.serialize(),
+            prefix: this.signatureData?.prefix,
+            timeout: this.signatureData?.timeout,
+            signature: this.signatureData?.signature,
+            feeRate: this.feeRate == null ? null : this.feeRate.toString(),
+        };
+    }
+    ;
+}
+exports.IEscrowSelfInitSwap = IEscrowSelfInitSwap;