@atomiqlabs/sdk 8.6.4 → 8.6.6

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

@@ -1,115 +1,114 @@
-/// <reference types="node" />
-import { ISwapWrapper, ISwapWrapperOptions, SwapTypeDefinition, WrapperCtorTokens } from "../ISwapWrapper";
-import { ChainType, ClaimEvent, InitializeEvent, RefundEvent, SignatureData, SwapCommitState, SwapEvent } from "@atomiqlabs/base";
-import { ISwap } from "../ISwap";
-import { UnifiedSwapStorage } from "../../storage/UnifiedSwapStorage";
-import { UnifiedSwapEventListener } from "../../events/UnifiedSwapEventListener";
-import { ISwapPrice } from "../../prices/abstract/ISwapPrice";
-import { EventEmitter } from "events";
-import { SwapType } from "../../enums/SwapType";
-import { IEscrowSwap } from "./IEscrowSwap";
-import { Intermediary } from "../../intermediaries/Intermediary";
-export type IEscrowSwapDefinition<T extends ChainType, W extends IEscrowSwapWrapper<T, any>, S extends IEscrowSwap<T>> = SwapTypeDefinition<T, W, S>;
-/**
- * Base class for wrappers of escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)
- *
- * @category Swaps/Abstract
- */
-export declare abstract class IEscrowSwapWrapper<T extends ChainType, D extends IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, D>, IEscrowSwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> extends ISwapWrapper<T, D, O> {
-    readonly abstract TYPE: SwapType;
-    /**
-     * @internal
-     */
-    readonly _contract: T["Contract"];
-    /**
-     * @internal
-     */
-    readonly _swapDataDeserializer: new (data: any) => T["Data"];
-    constructor(chainIdentifier: string, unifiedStorage: UnifiedSwapStorage<T>, unifiedChainEvents: UnifiedSwapEventListener<T>, chain: T["ChainInterface"], contract: T["Contract"], prices: ISwapPrice, tokens: WrapperCtorTokens, swapDataDeserializer: new (data: any) => T["Data"], options: O, events?: EventEmitter<{
-        swapState: [ISwap];
-    }>);
-    /**
-     * Pre-fetches signature verification data from the server's pre-sent promise, doesn't throw, instead returns null
-     *
-     * @param signDataPrefetch Promise that resolves when we receive "signDataPrefetch" from the LP in streaming mode
-     * @returns Pre-fetched signature verification data or null if failed
-     *
-     * @internal
-     */
-    protected preFetchSignData(signDataPrefetch: Promise<any | null>): Promise<T["PreFetchVerification"] | undefined>;
-    /**
-     * Verifies swap initialization signature returned by the intermediary
-     *
-     * @param initiator A smart chain account initiating the swap
-     * @param data Parsed swap data from the intermediary
-     * @param signature Response of the intermediary
-     * @param feeRatePromise Pre-fetched fee rate promise
-     * @param preFetchSignatureVerificationData Pre-fetched signature verification data
-     * @param abortSignal
-     * @returns Swap initialization signature expiry
-     * @throws {SignatureVerificationError} when swap init signature is invalid
-     *
-     * @internal
-     */
-    protected verifyReturnedSignature(initiator: string, data: T["Data"], signature: SignatureData, feeRatePromise: Promise<any>, preFetchSignatureVerificationData: Promise<any>, abortSignal?: AbortSignal): Promise<number>;
-    /**
-     * Processes InitializeEvent for a given swap
-     * @param swap
-     * @param event
-     * @returns Whether the swap was updated/changed
-     *
-     * @internal
-     */
-    protected abstract processEventInitialize(swap: D["Swap"], event: InitializeEvent<T["Data"]>): Promise<boolean>;
-    /**
-     * Processes ClaimEvent for a given swap
-     * @param swap
-     * @param event
-     * @returns Whether the swap was updated/changed
-     *
-     * @internal
-     */
-    protected abstract processEventClaim(swap: D["Swap"], event: ClaimEvent<T["Data"]>): Promise<boolean>;
-    /**
-     * Processes RefundEvent for a given swap
-     * @param swap
-     * @param event
-     * @returns Whether the swap was updated/changed
-     *
-     * @internal
-     */
-    protected abstract processEventRefund(swap: D["Swap"], event: RefundEvent<T["Data"]>): Promise<boolean>;
-    /**
-     * Processes a single SC on-chain event
-     * @param event
-     * @param swap
-     *
-     * @internal
-     */
-    protected processEvent(event: SwapEvent<T["Data"]>, swap: D["Swap"]): Promise<void>;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    protected _checkPastSwaps(pastSwaps: D["Swap"][]): Promise<{
-        changedSwaps: D["Swap"][];
-        removeSwaps: D["Swap"][];
-    }>;
-    /**
-     * Recovers a swap from smart chain on-chain data, please note that not all values for the recovered
-     *  swaps might be populated, as some data is purely off-chain and can never be recovered purely
-     *  from on-chain data.
-     *
-     * @param init Swap escrow initialization transaction and swap data
-     * @param state Current on-chain state of the swap
-     * @param lp Intermediary (LP) used as a counterparty for the swap
-     */
-    abstract recoverFromSwapDataAndState(init: {
-        data: T["Data"];
-        getInitTxId: () => Promise<string>;
-        getTxBlock: () => Promise<{
-            blockTime: number;
-            blockHeight: number;
-        }>;
-    }, state: SwapCommitState, lp?: Intermediary): Promise<D["Swap"] | null>;
-}
+import { ISwapWrapper, ISwapWrapperOptions, SwapTypeDefinition, WrapperCtorTokens } from "../ISwapWrapper";
+import { ChainType, ClaimEvent, InitializeEvent, RefundEvent, SignatureData, SwapCommitState, SwapEvent } from "@atomiqlabs/base";
+import { ISwap } from "../ISwap";
+import { UnifiedSwapStorage } from "../../storage/UnifiedSwapStorage";
+import { UnifiedSwapEventListener } from "../../events/UnifiedSwapEventListener";
+import { ISwapPrice } from "../../prices/abstract/ISwapPrice";
+import { EventEmitter } from "events";
+import { SwapType } from "../../enums/SwapType";
+import { IEscrowSwap } from "./IEscrowSwap";
+import { Intermediary } from "../../intermediaries/Intermediary";
+export type IEscrowSwapDefinition<T extends ChainType, W extends IEscrowSwapWrapper<T, any>, S extends IEscrowSwap<T>> = SwapTypeDefinition<T, W, S>;
+/**
+ * Base class for wrappers of escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)
+ *
+ * @category Swaps/Abstract
+ */
+export declare abstract class IEscrowSwapWrapper<T extends ChainType, D extends IEscrowSwapDefinition<T, IEscrowSwapWrapper<T, D>, IEscrowSwap<T, D>>, O extends ISwapWrapperOptions = ISwapWrapperOptions> extends ISwapWrapper<T, D, O> {
+    readonly abstract TYPE: SwapType;
+    /**
+     * @internal
+     */
+    readonly _contract: T["Contract"];
+    /**
+     * @internal
+     */
+    readonly _swapDataDeserializer: new (data: any) => T["Data"];
+    constructor(chainIdentifier: string, unifiedStorage: UnifiedSwapStorage<T>, unifiedChainEvents: UnifiedSwapEventListener<T>, chain: T["ChainInterface"], contract: T["Contract"], prices: ISwapPrice, tokens: WrapperCtorTokens, swapDataDeserializer: new (data: any) => T["Data"], options: O, events?: EventEmitter<{
+        swapState: [ISwap];
+    }>);
+    /**
+     * Pre-fetches signature verification data from the server's pre-sent promise, doesn't throw, instead returns null
+     *
+     * @param signDataPrefetch Promise that resolves when we receive "signDataPrefetch" from the LP in streaming mode
+     * @returns Pre-fetched signature verification data or null if failed
+     *
+     * @internal
+     */
+    protected preFetchSignData(signDataPrefetch: Promise<any | null>): Promise<T["PreFetchVerification"] | undefined>;
+    /**
+     * Verifies swap initialization signature returned by the intermediary
+     *
+     * @param initiator A smart chain account initiating the swap
+     * @param data Parsed swap data from the intermediary
+     * @param signature Response of the intermediary
+     * @param feeRatePromise Pre-fetched fee rate promise
+     * @param preFetchSignatureVerificationData Pre-fetched signature verification data
+     * @param abortSignal
+     * @returns Swap initialization signature expiry
+     * @throws {SignatureVerificationError} when swap init signature is invalid
+     *
+     * @internal
+     */
+    protected verifyReturnedSignature(initiator: string, data: T["Data"], signature: SignatureData, feeRatePromise: Promise<any>, preFetchSignatureVerificationData: Promise<any>, abortSignal?: AbortSignal): Promise<number>;
+    /**
+     * Processes InitializeEvent for a given swap
+     * @param swap
+     * @param event
+     * @returns Whether the swap was updated/changed
+     *
+     * @internal
+     */
+    protected abstract processEventInitialize(swap: D["Swap"], event: InitializeEvent<T["Data"]>): Promise<boolean>;
+    /**
+     * Processes ClaimEvent for a given swap
+     * @param swap
+     * @param event
+     * @returns Whether the swap was updated/changed
+     *
+     * @internal
+     */
+    protected abstract processEventClaim(swap: D["Swap"], event: ClaimEvent<T["Data"]>): Promise<boolean>;
+    /**
+     * Processes RefundEvent for a given swap
+     * @param swap
+     * @param event
+     * @returns Whether the swap was updated/changed
+     *
+     * @internal
+     */
+    protected abstract processEventRefund(swap: D["Swap"], event: RefundEvent<T["Data"]>): Promise<boolean>;
+    /**
+     * Processes a single SC on-chain event
+     * @param event
+     * @param swap
+     *
+     * @internal
+     */
+    protected processEvent(event: SwapEvent<T["Data"]>, swap: D["Swap"]): Promise<void>;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    protected _checkPastSwaps(pastSwaps: D["Swap"][]): Promise<{
+        changedSwaps: D["Swap"][];
+        removeSwaps: D["Swap"][];
+    }>;
+    /**
+     * Recovers a swap from smart chain on-chain data, please note that not all values for the recovered
+     *  swaps might be populated, as some data is purely off-chain and can never be recovered purely
+     *  from on-chain data.
+     *
+     * @param init Swap escrow initialization transaction and swap data
+     * @param state Current on-chain state of the swap
+     * @param lp Intermediary (LP) used as a counterparty for the swap
+     */
+    abstract recoverFromSwapDataAndState(init: {
+        data: T["Data"];
+        getInitTxId: () => Promise<string>;
+        getTxBlock: () => Promise<{
+            blockTime: number;
+            blockHeight: number;
+        }>;
+    }, state: SwapCommitState, lp?: Intermediary): Promise<D["Swap"] | null>;
+}

package/dist/swaps/escrow_swaps/IEscrowSwapWrapper.js

@@ -1,134 +1,134 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IEscrowSwapWrapper = void 0;
-const ISwapWrapper_1 = require("../ISwapWrapper");
-const base_1 = require("@atomiqlabs/base");
-/**
- * Base class for wrappers of escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)
- *
- * @category Swaps/Abstract
- */
-class IEscrowSwapWrapper extends ISwapWrapper_1.ISwapWrapper {
-    constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, contract, prices, tokens, swapDataDeserializer, options, events) {
-        super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, options, events);
-        this._swapDataDeserializer = swapDataDeserializer;
-        this._contract = contract;
-    }
-    /**
-     * Pre-fetches signature verification data from the server's pre-sent promise, doesn't throw, instead returns null
-     *
-     * @param signDataPrefetch Promise that resolves when we receive "signDataPrefetch" from the LP in streaming mode
-     * @returns Pre-fetched signature verification data or null if failed
-     *
-     * @internal
-     */
-    preFetchSignData(signDataPrefetch) {
-        if (this._contract.preFetchForInitSignatureVerification == null) {
-            // Catch promise rejections, should they happen
-            signDataPrefetch.catch(() => { });
-            return Promise.resolve(undefined);
-        }
-        return signDataPrefetch.then(obj => {
-            if (obj == null)
-                return undefined;
-            return this._contract.preFetchForInitSignatureVerification(obj);
-        }).catch(e => {
-            this.logger.error("preFetchSignData(): Error: ", e);
-        });
-    }
-    /**
-     * Verifies swap initialization signature returned by the intermediary
-     *
-     * @param initiator A smart chain account initiating the swap
-     * @param data Parsed swap data from the intermediary
-     * @param signature Response of the intermediary
-     * @param feeRatePromise Pre-fetched fee rate promise
-     * @param preFetchSignatureVerificationData Pre-fetched signature verification data
-     * @param abortSignal
-     * @returns Swap initialization signature expiry
-     * @throws {SignatureVerificationError} when swap init signature is invalid
-     *
-     * @internal
-     */
-    async verifyReturnedSignature(initiator, data, signature, feeRatePromise, preFetchSignatureVerificationData, abortSignal) {
-        const [feeRate, preFetchedSignatureData] = await Promise.all([feeRatePromise, preFetchSignatureVerificationData]);
-        await this._contract.isValidInitAuthorization(initiator, data, signature, feeRate, preFetchedSignatureData);
-        return await this._contract.getInitAuthorizationExpiry(data, signature, preFetchedSignatureData);
-    }
-    /**
-     * Processes a single SC on-chain event
-     * @param event
-     * @param swap
-     *
-     * @internal
-     */
-    async processEvent(event, swap) {
-        if (swap == null)
-            return;
-        let swapChanged = false;
-        if (event instanceof base_1.InitializeEvent) {
-            swapChanged = await this.processEventInitialize(swap, event);
-            if (event.meta?.txId != null && swap._commitTxId !== event.meta.txId) {
-                swap._commitTxId = event.meta.txId;
-                swapChanged ||= true;
-            }
-        }
-        if (event instanceof base_1.ClaimEvent) {
-            swapChanged = await this.processEventClaim(swap, event);
-            if (event.meta?.txId != null && swap._claimTxId !== event.meta.txId) {
-                swap._claimTxId = event.meta.txId;
-                swapChanged ||= true;
-            }
-        }
-        if (event instanceof base_1.RefundEvent) {
-            swapChanged = await this.processEventRefund(swap, event);
-            if (event.meta?.txId != null && swap._refundTxId !== event.meta.txId) {
-                swap._refundTxId = event.meta.txId;
-                swapChanged ||= true;
-            }
-        }
-        this.logger.info("processEvents(): " + event.constructor.name + " processed for " + swap.getId() + " swap: ", swap);
-        if (swapChanged) {
-            await swap._saveAndEmit();
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    async _checkPastSwaps(pastSwaps) {
-        const changedSwaps = [];
-        const removeSwaps = [];
-        const swapExpiredStatus = {};
-        const checkStatusSwaps = [];
-        for (let pastSwap of pastSwaps) {
-            if (pastSwap._shouldFetchExpiryStatus()) {
-                //Check expiry
-                swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
-            }
-            if (pastSwap._shouldFetchOnchainState()) {
-                //Add to swaps for which status should be checked
-                if (pastSwap._data != null)
-                    checkStatusSwaps.push(pastSwap);
-            }
-        }
-        const swapStatuses = await this._contract.getCommitStatuses(checkStatusSwaps.map(val => ({ signer: val._getInitiator(), swapData: val._data })));
-        for (let pastSwap of checkStatusSwaps) {
-            const escrowHash = pastSwap.getEscrowHash();
-            const shouldSave = await pastSwap._sync(false, swapExpiredStatus[pastSwap.getId()], escrowHash == null ? undefined : swapStatuses[escrowHash]);
-            if (shouldSave) {
-                if (pastSwap.isQuoteExpired()) {
-                    removeSwaps.push(pastSwap);
-                }
-                else {
-                    changedSwaps.push(pastSwap);
-                }
-            }
-        }
-        return {
-            changedSwaps,
-            removeSwaps
-        };
-    }
-}
-exports.IEscrowSwapWrapper = IEscrowSwapWrapper;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IEscrowSwapWrapper = void 0;
+const ISwapWrapper_1 = require("../ISwapWrapper");
+const base_1 = require("@atomiqlabs/base");
+/**
+ * Base class for wrappers of escrow-based swaps (i.e. swaps utilizing PrTLC and HTLC primitives)
+ *
+ * @category Swaps/Abstract
+ */
+class IEscrowSwapWrapper extends ISwapWrapper_1.ISwapWrapper {
+    constructor(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, contract, prices, tokens, swapDataDeserializer, options, events) {
+        super(chainIdentifier, unifiedStorage, unifiedChainEvents, chain, prices, tokens, options, events);
+        this._swapDataDeserializer = swapDataDeserializer;
+        this._contract = contract;
+    }
+    /**
+     * Pre-fetches signature verification data from the server's pre-sent promise, doesn't throw, instead returns null
+     *
+     * @param signDataPrefetch Promise that resolves when we receive "signDataPrefetch" from the LP in streaming mode
+     * @returns Pre-fetched signature verification data or null if failed
+     *
+     * @internal
+     */
+    preFetchSignData(signDataPrefetch) {
+        if (this._contract.preFetchForInitSignatureVerification == null) {
+            // Catch promise rejections, should they happen
+            signDataPrefetch.catch(() => { });
+            return Promise.resolve(undefined);
+        }
+        return signDataPrefetch.then(obj => {
+            if (obj == null)
+                return undefined;
+            return this._contract.preFetchForInitSignatureVerification(obj);
+        }).catch(e => {
+            this.logger.error("preFetchSignData(): Error: ", e);
+        });
+    }
+    /**
+     * Verifies swap initialization signature returned by the intermediary
+     *
+     * @param initiator A smart chain account initiating the swap
+     * @param data Parsed swap data from the intermediary
+     * @param signature Response of the intermediary
+     * @param feeRatePromise Pre-fetched fee rate promise
+     * @param preFetchSignatureVerificationData Pre-fetched signature verification data
+     * @param abortSignal
+     * @returns Swap initialization signature expiry
+     * @throws {SignatureVerificationError} when swap init signature is invalid
+     *
+     * @internal
+     */
+    async verifyReturnedSignature(initiator, data, signature, feeRatePromise, preFetchSignatureVerificationData, abortSignal) {
+        const [feeRate, preFetchedSignatureData] = await Promise.all([feeRatePromise, preFetchSignatureVerificationData]);
+        await this._contract.isValidInitAuthorization(initiator, data, signature, feeRate, preFetchedSignatureData);
+        return await this._contract.getInitAuthorizationExpiry(data, signature, preFetchedSignatureData);
+    }
+    /**
+     * Processes a single SC on-chain event
+     * @param event
+     * @param swap
+     *
+     * @internal
+     */
+    async processEvent(event, swap) {
+        if (swap == null)
+            return;
+        let swapChanged = false;
+        if (event instanceof base_1.InitializeEvent) {
+            swapChanged = await this.processEventInitialize(swap, event);
+            if (event.meta?.txId != null && swap._commitTxId !== event.meta.txId) {
+                swap._commitTxId = event.meta.txId;
+                swapChanged ||= true;
+            }
+        }
+        if (event instanceof base_1.ClaimEvent) {
+            swapChanged = await this.processEventClaim(swap, event);
+            if (event.meta?.txId != null && swap._claimTxId !== event.meta.txId) {
+                swap._claimTxId = event.meta.txId;
+                swapChanged ||= true;
+            }
+        }
+        if (event instanceof base_1.RefundEvent) {
+            swapChanged = await this.processEventRefund(swap, event);
+            if (event.meta?.txId != null && swap._refundTxId !== event.meta.txId) {
+                swap._refundTxId = event.meta.txId;
+                swapChanged ||= true;
+            }
+        }
+        this.logger.info("processEvents(): " + event.constructor.name + " processed for " + swap.getId() + " swap: ", swap);
+        if (swapChanged) {
+            await swap._saveAndEmit();
+        }
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    async _checkPastSwaps(pastSwaps) {
+        const changedSwaps = [];
+        const removeSwaps = [];
+        const swapExpiredStatus = {};
+        const checkStatusSwaps = [];
+        for (let pastSwap of pastSwaps) {
+            if (pastSwap._shouldFetchExpiryStatus()) {
+                //Check expiry
+                swapExpiredStatus[pastSwap.getId()] = await pastSwap._verifyQuoteDefinitelyExpired();
+            }
+            if (pastSwap._shouldFetchOnchainState()) {
+                //Add to swaps for which status should be checked
+                if (pastSwap._data != null)
+                    checkStatusSwaps.push(pastSwap);
+            }
+        }
+        const swapStatuses = await this._contract.getCommitStatuses(checkStatusSwaps.map(val => ({ signer: val._getInitiator(), swapData: val._data })));
+        for (let pastSwap of checkStatusSwaps) {
+            const escrowHash = pastSwap.getEscrowHash();
+            const shouldSave = await pastSwap._sync(false, swapExpiredStatus[pastSwap.getId()], escrowHash == null ? undefined : swapStatuses[escrowHash]);
+            if (shouldSave) {
+                if (pastSwap.isQuoteExpired()) {
+                    removeSwaps.push(pastSwap);
+                }
+                else {
+                    changedSwaps.push(pastSwap);
+                }
+            }
+        }
+        return {
+            changedSwaps,
+            removeSwaps
+        };
+    }
+}
+exports.IEscrowSwapWrapper = IEscrowSwapWrapper;