@atomiqlabs/sdk 8.9.0 → 8.9.2

package/dist/intermediaries/IntermediaryDiscovery.d.ts

@@ -1,216 +1,216 @@
-/// <reference types="node" />
-import { Intermediary } from "./Intermediary";
-import { SwapType } from "../enums/SwapType";
-import { SpvVaultContract, SwapContract } from "@atomiqlabs/base";
-import { EventEmitter } from "events";
-import { IntermediaryAPI } from "./apis/IntermediaryAPI";
-/**
- * Swap handler type mapping for intermediary communication
- *
- * @category LPs
- */
-export declare enum SwapHandlerType {
-    TO_BTC = "TO_BTC",
-    FROM_BTC = "FROM_BTC",
-    TO_BTCLN = "TO_BTCLN",
-    FROM_BTCLN = "FROM_BTCLN",
-    FROM_BTC_TRUSTED = "FROM_BTC_TRUSTED",
-    FROM_BTCLN_TRUSTED = "FROM_BTCLN_TRUSTED",
-    FROM_BTC_SPV = "FROM_BTC_SPV",
-    FROM_BTCLN_AUTO = "FROM_BTCLN_AUTO"
-}
-/**
- * Swap handler information type
- *
- * @category LPs
- */
-export type SwapHandlerInfoType = {
-    swapFeePPM: number;
-    swapBaseFee: number;
-    min: number;
-    max: number;
-    tokens: string[];
-    chainTokens?: {
-        [chainId: string]: string[];
-    };
-    data?: any;
-};
-/**
- * Token bounds (min/max) for swaps
- *
- * @category LPs
- */
-export type TokenBounds = {
-    [token: string]: {
-        min: bigint;
-        max: bigint;
-    };
-};
-/**
- * Multi-chain token bounds (min/max) for swaps
- *
- * @category LPs
- */
-export type MultichainTokenBounds = {
-    [chainId: string]: TokenBounds;
-};
-/**
- * Swap bounds by swap protocol type
- *
- * @category LPs
- */
-export type SwapBounds = {
-    [key in SwapType]?: TokenBounds;
-};
-/**
- * Multi-chain swap bounds
- *
- * @category LPs
- */
-export type MultichainSwapBounds = {
-    [key in SwapType]?: MultichainTokenBounds;
-};
-/**
- * Discovery service for available intermediaries (liquidity providers)
- *
- * @category LPs
- */
-export declare class IntermediaryDiscovery extends EventEmitter {
-    /**
-     * A current list of active intermediaries
-     */
-    intermediaries: Intermediary[];
-    /**
-     * Swap contracts for checking intermediary signatures
-     */
-    swapContracts: {
-        [chainIdentifier: string]: {
-            [contractVersion: string]: {
-                swapContract: SwapContract;
-                spvVaultContract: SpvVaultContract;
-            };
-        };
-    };
-    /**
-     * Registry URL used as a source for the list of intermediaries, this should be a link to a
-     *  github-hosted JSON file
-     */
-    registryUrl: string;
-    /**
-     * Timeout for the HTTP handshake (/info) requests sent to the intermediaries
-     */
-    httpRequestTimeout?: number;
-    /**
-     * Maximum time (in millis) to wait for other intermediary's responses after the first one was founds
-     */
-    maxWaitForOthersTimeout?: number;
-    /**
-     * The intermediary URLs passed in the constructor, to be used instead of querying the registry
-     *
-     * @private
-     */
-    private overrideNodeUrls?;
-    /**
-     * @private
-     */
-    private lpApi;
-    constructor(swapContracts: {
-        [chainIdentifier: string]: {
-            [contractVersion: string]: {
-                swapContract: SwapContract;
-                spvVaultContract: SpvVaultContract;
-            };
-        };
-    }, lpApi: IntermediaryAPI, registryUrl?: string, nodeUrls?: string[], httpRequestTimeout?: number, maxWaitForOthersTimeout?: number);
-    /**
-     * Fetches the URLs of swap intermediaries from registry or from a pre-defined array of node urls
-     *
-     * @param abortSignal
-     */
-    private getIntermediaryUrls;
-    /**
-     * Returns data as reported by a specific node (as identified by its URL). This function is specifically made
-     *  in a way, that in case the abortSignal fires AFTER the LP response was received (and during signature checking),
-     *  it proceeds with the addresses it was able to verify already. Hence after calling abort, this function is guaranteed
-     *  to either reject or resolve instantly.
-     *
-     * @param url
-     * @param abortSignal
-     */
-    private getNodeInfo;
-    /**
-     * Inherits abort signal logic from `getNodeInfo()`, check those function docs to better understand
-     *
-     * @param url
-     * @param abortSignal
-     * @private
-     */
-    private loadIntermediary;
-    /**
-     * Returns the intermediary at the provided URL, either from the already fetched list of LPs
-     *  or fetches the data on-demand, by sending the handshake HTTP request (/info) to the LP.
-     *
-     * Doesn't save the fetched intermediary to the list of intermediaries if it isn't already
-     *  part of the known intermediaries
-     *
-     * @param url Base URL of the intermediary, which accepts HTTP requests
-     * @param abortSignal
-     */
-    getIntermediary(url: string, abortSignal?: AbortSignal): Promise<Intermediary | null>;
-    /**
-     * Reloads the saves a list of intermediaries
-     *
-     * @param abortSignal
-     */
-    reloadIntermediaries(abortSignal?: AbortSignal): Promise<void>;
-    /**
-     * Initializes the discovery by fetching/reloading intermediaries
-     *
-     * @param abortSignal
-     */
-    init(abortSignal?: AbortSignal): Promise<void>;
-    /**
-     * Returns known swap bounds (in satoshis - BTC) by aggregating values from all known intermediaries
-     */
-    getMultichainSwapBounds(): MultichainSwapBounds;
-    /**
-     * Returns aggregate swap bounds (in satoshis - BTC) as indicated by the intermediaries
-     */
-    getSwapBounds(chainIdentifier: string): SwapBounds;
-    /**
-     * Returns the aggregate swap minimum (in satoshis - BTC) for a specific swap type & token
-     *  as indicated by the intermediaries
-     *
-     * @param chainIdentifier Chain identifier of the smart chain
-     * @param swapType Swap protocol type
-     * @param tokenAddress Token address
-     */
-    getSwapMinimum(chainIdentifier: string, swapType: SwapType, tokenAddress: string): number | null;
-    /**
-     * Returns the aggregate swap maximum (in satoshis - BTC) for a specific swap type & token
-     *  as indicated by the intermediaries
-     *
-     * @param chainIdentifier Chain identifier of the smart chain
-     * @param swapType Swap protocol type
-     * @param tokenAddress Token address
-     */
-    getSwapMaximum(chainIdentifier: string, swapType: SwapType, tokenAddress: string): number | null;
-    /**
-     * Returns swap candidates for a specific swap type & token address
-     *
-     * @remarks Also filters the LPs based on supported swap versions
-     *
-     * @param chainIdentifier Chain identifier of the smart chain
-     * @param swapType Swap protocol type
-     * @param tokenAddress Token address
-     * @param amount Amount to be swapped in sats - BTC
-     * @param count How many intermediaries to return at most
-     */
-    getSwapCandidates(chainIdentifier: string, swapType: SwapType, tokenAddress: string, amount?: bigint, count?: number): Intermediary[];
-    /**
-     * Removes a specific intermediary from the list of active intermediaries (used for blacklisting)
-     *
-     * @param intermediary
-     */
-    removeIntermediary(intermediary: Intermediary): boolean;
-}
+/// <reference types="node" />
+import { Intermediary } from "./Intermediary";
+import { SwapType } from "../enums/SwapType";
+import { SpvVaultContract, SwapContract } from "@atomiqlabs/base";
+import { EventEmitter } from "events";
+import { IntermediaryAPI } from "./apis/IntermediaryAPI";
+/**
+ * Swap handler type mapping for intermediary communication
+ *
+ * @category LPs
+ */
+export declare enum SwapHandlerType {
+    TO_BTC = "TO_BTC",
+    FROM_BTC = "FROM_BTC",
+    TO_BTCLN = "TO_BTCLN",
+    FROM_BTCLN = "FROM_BTCLN",
+    FROM_BTC_TRUSTED = "FROM_BTC_TRUSTED",
+    FROM_BTCLN_TRUSTED = "FROM_BTCLN_TRUSTED",
+    FROM_BTC_SPV = "FROM_BTC_SPV",
+    FROM_BTCLN_AUTO = "FROM_BTCLN_AUTO"
+}
+/**
+ * Swap handler information type
+ *
+ * @category LPs
+ */
+export type SwapHandlerInfoType = {
+    swapFeePPM: number;
+    swapBaseFee: number;
+    min: number;
+    max: number;
+    tokens: string[];
+    chainTokens?: {
+        [chainId: string]: string[];
+    };
+    data?: any;
+};
+/**
+ * Token bounds (min/max) for swaps
+ *
+ * @category LPs
+ */
+export type TokenBounds = {
+    [token: string]: {
+        min: bigint;
+        max: bigint;
+    };
+};
+/**
+ * Multi-chain token bounds (min/max) for swaps
+ *
+ * @category LPs
+ */
+export type MultichainTokenBounds = {
+    [chainId: string]: TokenBounds;
+};
+/**
+ * Swap bounds by swap protocol type
+ *
+ * @category LPs
+ */
+export type SwapBounds = {
+    [key in SwapType]?: TokenBounds;
+};
+/**
+ * Multi-chain swap bounds
+ *
+ * @category LPs
+ */
+export type MultichainSwapBounds = {
+    [key in SwapType]?: MultichainTokenBounds;
+};
+/**
+ * Discovery service for available intermediaries (liquidity providers)
+ *
+ * @category LPs
+ */
+export declare class IntermediaryDiscovery extends EventEmitter {
+    /**
+     * A current list of active intermediaries
+     */
+    intermediaries: Intermediary[];
+    /**
+     * Swap contracts for checking intermediary signatures
+     */
+    swapContracts: {
+        [chainIdentifier: string]: {
+            [contractVersion: string]: {
+                swapContract: SwapContract;
+                spvVaultContract: SpvVaultContract;
+            };
+        };
+    };
+    /**
+     * Registry URL used as a source for the list of intermediaries, this should be a link to a
+     *  github-hosted JSON file
+     */
+    registryUrl: string;
+    /**
+     * Timeout for the HTTP handshake (/info) requests sent to the intermediaries
+     */
+    httpRequestTimeout?: number;
+    /**
+     * Maximum time (in millis) to wait for other intermediary's responses after the first one was founds
+     */
+    maxWaitForOthersTimeout?: number;
+    /**
+     * The intermediary URLs passed in the constructor, to be used instead of querying the registry
+     *
+     * @private
+     */
+    private overrideNodeUrls?;
+    /**
+     * @private
+     */
+    private lpApi;
+    constructor(swapContracts: {
+        [chainIdentifier: string]: {
+            [contractVersion: string]: {
+                swapContract: SwapContract;
+                spvVaultContract: SpvVaultContract;
+            };
+        };
+    }, lpApi: IntermediaryAPI, registryUrl?: string, nodeUrls?: string[], httpRequestTimeout?: number, maxWaitForOthersTimeout?: number);
+    /**
+     * Fetches the URLs of swap intermediaries from registry or from a pre-defined array of node urls
+     *
+     * @param abortSignal
+     */
+    private getIntermediaryUrls;
+    /**
+     * Returns data as reported by a specific node (as identified by its URL). This function is specifically made
+     *  in a way, that in case the abortSignal fires AFTER the LP response was received (and during signature checking),
+     *  it proceeds with the addresses it was able to verify already. Hence after calling abort, this function is guaranteed
+     *  to either reject or resolve instantly.
+     *
+     * @param url
+     * @param abortSignal
+     */
+    private getNodeInfo;
+    /**
+     * Inherits abort signal logic from `getNodeInfo()`, check those function docs to better understand
+     *
+     * @param url
+     * @param abortSignal
+     * @private
+     */
+    private loadIntermediary;
+    /**
+     * Returns the intermediary at the provided URL, either from the already fetched list of LPs
+     *  or fetches the data on-demand, by sending the handshake HTTP request (/info) to the LP.
+     *
+     * Doesn't save the fetched intermediary to the list of intermediaries if it isn't already
+     *  part of the known intermediaries
+     *
+     * @param url Base URL of the intermediary, which accepts HTTP requests
+     * @param abortSignal
+     */
+    getIntermediary(url: string, abortSignal?: AbortSignal): Promise<Intermediary | null>;
+    /**
+     * Reloads the saves a list of intermediaries
+     *
+     * @param abortSignal
+     */
+    reloadIntermediaries(abortSignal?: AbortSignal): Promise<void>;
+    /**
+     * Initializes the discovery by fetching/reloading intermediaries
+     *
+     * @param abortSignal
+     */
+    init(abortSignal?: AbortSignal): Promise<void>;
+    /**
+     * Returns known swap bounds (in satoshis - BTC) by aggregating values from all known intermediaries
+     */
+    getMultichainSwapBounds(): MultichainSwapBounds;
+    /**
+     * Returns aggregate swap bounds (in satoshis - BTC) as indicated by the intermediaries
+     */
+    getSwapBounds(chainIdentifier: string): SwapBounds;
+    /**
+     * Returns the aggregate swap minimum (in satoshis - BTC) for a specific swap type & token
+     *  as indicated by the intermediaries
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     * @param swapType Swap protocol type
+     * @param tokenAddress Token address
+     */
+    getSwapMinimum(chainIdentifier: string, swapType: SwapType, tokenAddress: string): number | null;
+    /**
+     * Returns the aggregate swap maximum (in satoshis - BTC) for a specific swap type & token
+     *  as indicated by the intermediaries
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     * @param swapType Swap protocol type
+     * @param tokenAddress Token address
+     */
+    getSwapMaximum(chainIdentifier: string, swapType: SwapType, tokenAddress: string): number | null;
+    /**
+     * Returns swap candidates for a specific swap type & token address
+     *
+     * @remarks Also filters the LPs based on supported swap versions
+     *
+     * @param chainIdentifier Chain identifier of the smart chain
+     * @param swapType Swap protocol type
+     * @param tokenAddress Token address
+     * @param amount Amount to be swapped in sats - BTC
+     * @param count How many intermediaries to return at most
+     */
+    getSwapCandidates(chainIdentifier: string, swapType: SwapType, tokenAddress: string, amount?: bigint, count?: number): Intermediary[];
+    /**
+     * Removes a specific intermediary from the list of active intermediaries (used for blacklisting)
+     *
+     * @param intermediary
+     */
+    removeIntermediary(intermediary: Intermediary): boolean;
+}