@atomiqlabs/lp-lib 13.0.0-beta.9 → 13.0.0

package/src/swaps/SwapHandlerSwap.ts

@@ -1,142 +1,142 @@
-import {Lockable, StorageObject, SwapData} from "@atomiqlabs/base";
-import {SwapHandlerType} from "./SwapHandler";
-import {PluginManager} from "../plugins/PluginManager";
-import {deserializeBN, serializeBN} from "../utils/Utils";
-
-function objectBigIntsToString(obj: Object) {
-    for(let key in obj) {
-        if(typeof obj[key] === "bigint") obj[key] = obj[key].toString(10);
-        if(typeof obj[key] === "object") objectBigIntsToString(obj[key]);
-    }
-    return obj;
-}
-
-export abstract class SwapHandlerSwap<S = any> extends Lockable implements StorageObject {
-    type: SwapHandlerType;
-
-    chainIdentifier: string;
-    state: S;
-
-    metadata: {
-        request: any,
-        times: {[key: string]: number},
-        [key: string]: any
-    };
-    txIds: {
-        [key: string]: string
-    } = {};
-    readonly swapFee: bigint;
-    readonly swapFeeInToken: bigint;
-
-    protected constructor(chainIdentifier: string, swapFee: bigint, swapFeeInToken: bigint);
-    protected constructor(obj: any);
-
-    protected constructor(obj?: any | string, swapFee?: bigint, swapFeeInToken?: bigint) {
-        super();
-        if(typeof(obj)==="string" && typeof(swapFee)==="bigint" && typeof(swapFeeInToken)==="bigint") {
-            this.chainIdentifier = obj;
-            this.swapFee = swapFee;
-            this.swapFeeInToken = swapFeeInToken;
-            return;
-        } else {
-            this.metadata = obj.metadata;
-            this.chainIdentifier = obj.chainIdentifier;
-            this.txIds = obj.txIds || {};
-            this.state = obj.state;
-            this.swapFee = deserializeBN(obj.swapFee);
-            this.swapFeeInToken = deserializeBN(obj.swapFeeInToken);
-        }
-    }
-
-    serialize(): any {
-        return {
-            state: this.state,
-            chainIdentifier: this.chainIdentifier,
-            metadata: objectBigIntsToString(this.metadata),
-            txIds: this.txIds,
-            swapFee: serializeBN(this.swapFee),
-            swapFeeInToken: serializeBN(this.swapFeeInToken)
-        }
-    }
-
-    /**
-     * Sets the state of the swap and also calls swap change listener on plugins
-     *
-     * @param newState
-     */
-    setState(newState: S): Promise<void> {
-        const oldState = this.state;
-        this.state = newState;
-        return PluginManager.swapStateChange(this, oldState);
-    }
-
-    /**
-     * Returns the identification hash of the swap, usually claim data hash, but can be overriden, e.g. for
-     *  lightning swaps the identifier hash is used instead of claim data hash
-     */
-    abstract getIdentifierHash(): string;
-
-    abstract getSequence(): bigint | null;
-
-    /**
-     * Returns unique identifier of the swap in the form <hash>_<sequence> or just <hash> if the swap type doesn't
-     *  use sequence number
-     */
-    getIdentifier(): string {
-        if(this.getSequence()!=null) {
-            return this.chainIdentifier+"_"+this.getIdentifierHash()+"_"+this.getSequence().toString(16);
-        }
-        return this.chainIdentifier+"_"+this.getIdentifierHash();
-    }
-
-    /**
-     * Returns the smart chain token used for the swap
-     */
-    abstract getToken(): string
-
-    /**
-     * Checks whether the swap is finished, such that it is final and either successful or failed
-     */
-    isFinished(): boolean {
-        return this.isSuccess() || this.isFailed();
-    }
-
-    /**
-     * Checks whether the swap was initiated by the user
-     */
-    abstract isInitiated(): boolean;
-
-    /**
-     * Checks whether the swap was finished and was successful
-     */
-    abstract isSuccess(): boolean;
-
-    /**
-     * Checks whether the swap was finished and was failed
-     */
-    abstract isFailed(): boolean;
-
-    /**
-     * Returns the input amount paid by the user (excluding fees)
-     */
-    getInputAmount(): bigint {
-        return this.getTotalInputAmount() - this.getSwapFee().inInputToken;
-    }
-
-    /**
-     * Returns the total input amount paid by the user (including all fees)
-     */
-    abstract getTotalInputAmount(): bigint;
-
-    /**
-     * Returns the actual output amount paid out to the user
-     */
-    abstract getOutputAmount(): bigint;
-
-    /**
-     * Returns swap fee, denominated in input & output tokens (the fee is paid only once, it is just represented here in
-     *  both denomination for ease of use)
-     */
-    abstract getSwapFee(): {inInputToken: bigint, inOutputToken: bigint};
-
+import {Lockable, StorageObject, SwapData} from "@atomiqlabs/base";
+import {SwapHandlerType} from "./SwapHandler";
+import {PluginManager} from "../plugins/PluginManager";
+import {deserializeBN, serializeBN} from "../utils/Utils";
+
+function objectBigIntsToString(obj: Object) {
+    for(let key in obj) {
+        if(typeof obj[key] === "bigint") obj[key] = obj[key].toString(10);
+        if(typeof obj[key] === "object") objectBigIntsToString(obj[key]);
+    }
+    return obj;
+}
+
+export abstract class SwapHandlerSwap<S = any> extends Lockable implements StorageObject {
+    type: SwapHandlerType;
+
+    chainIdentifier: string;
+    state: S;
+
+    metadata: {
+        request: any,
+        times: {[key: string]: number},
+        [key: string]: any
+    };
+    txIds: {
+        [key: string]: string
+    } = {};
+    readonly swapFee: bigint;
+    readonly swapFeeInToken: bigint;
+
+    protected constructor(chainIdentifier: string, swapFee: bigint, swapFeeInToken: bigint);
+    protected constructor(obj: any);
+
+    protected constructor(obj?: any | string, swapFee?: bigint, swapFeeInToken?: bigint) {
+        super();
+        if(typeof(obj)==="string" && typeof(swapFee)==="bigint" && typeof(swapFeeInToken)==="bigint") {
+            this.chainIdentifier = obj;
+            this.swapFee = swapFee;
+            this.swapFeeInToken = swapFeeInToken;
+            return;
+        } else {
+            this.metadata = obj.metadata;
+            this.chainIdentifier = obj.chainIdentifier;
+            this.txIds = obj.txIds || {};
+            this.state = obj.state;
+            this.swapFee = deserializeBN(obj.swapFee);
+            this.swapFeeInToken = deserializeBN(obj.swapFeeInToken);
+        }
+    }
+
+    serialize(): any {
+        return {
+            state: this.state,
+            chainIdentifier: this.chainIdentifier,
+            metadata: objectBigIntsToString(this.metadata),
+            txIds: this.txIds,
+            swapFee: serializeBN(this.swapFee),
+            swapFeeInToken: serializeBN(this.swapFeeInToken)
+        }
+    }
+
+    /**
+     * Sets the state of the swap and also calls swap change listener on plugins
+     *
+     * @param newState
+     */
+    setState(newState: S): Promise<void> {
+        const oldState = this.state;
+        this.state = newState;
+        return PluginManager.swapStateChange(this, oldState);
+    }
+
+    /**
+     * Returns the identification hash of the swap, usually claim data hash, but can be overriden, e.g. for
+     *  lightning swaps the identifier hash is used instead of claim data hash
+     */
+    abstract getIdentifierHash(): string;
+
+    abstract getSequence(): bigint | null;
+
+    /**
+     * Returns unique identifier of the swap in the form <hash>_<sequence> or just <hash> if the swap type doesn't
+     *  use sequence number
+     */
+    getIdentifier(): string {
+        if(this.getSequence()!=null) {
+            return this.chainIdentifier+"_"+this.getIdentifierHash()+"_"+this.getSequence().toString(16);
+        }
+        return this.chainIdentifier+"_"+this.getIdentifierHash();
+    }
+
+    /**
+     * Returns the smart chain token used for the swap
+     */
+    abstract getToken(): string
+
+    /**
+     * Checks whether the swap is finished, such that it is final and either successful or failed
+     */
+    isFinished(): boolean {
+        return this.isSuccess() || this.isFailed();
+    }
+
+    /**
+     * Checks whether the swap was initiated by the user
+     */
+    abstract isInitiated(): boolean;
+
+    /**
+     * Checks whether the swap was finished and was successful
+     */
+    abstract isSuccess(): boolean;
+
+    /**
+     * Checks whether the swap was finished and was failed
+     */
+    abstract isFailed(): boolean;
+
+    /**
+     * Returns the input amount paid by the user (excluding fees)
+     */
+    getInputAmount(): bigint {
+        return this.getTotalInputAmount() - this.getSwapFee().inInputToken;
+    }
+
+    /**
+     * Returns the total input amount paid by the user (including all fees)
+     */
+    abstract getTotalInputAmount(): bigint;
+
+    /**
+     * Returns the actual output amount paid out to the user
+     */
+    abstract getOutputAmount(): bigint;
+
+    /**
+     * Returns swap fee, denominated in input & output tokens (the fee is paid only once, it is just represented here in
+     *  both denomination for ease of use)
+     */
+    abstract getSwapFee(): {inInputToken: bigint, inOutputToken: bigint};
+
 }

package/src/swaps/assertions/AmountAssertions.ts

@@ -1,77 +1,77 @@
-import {ISwapPrice} from "../../prices/ISwapPrice";
-import {isQuoteAmountTooHigh, isQuoteAmountTooLow, isQuoteThrow} from "../../plugins/IPlugin";
-
-export type AmountAssertionsConfig = {min: bigint, max: bigint, baseFee: bigint, feePPM: bigint};
-
-export abstract class AmountAssertions {
-
-    readonly config: AmountAssertionsConfig;
-    readonly swapPricing: ISwapPrice;
-
-    constructor(config: AmountAssertionsConfig, swapPricing: ISwapPrice) {
-        this.config = config;
-        this.swapPricing = swapPricing;
-    }
-
-    /**
-     * Checks whether the bitcoin amount is within specified min/max bounds
-     *
-     * @param amount
-     * @protected
-     * @throws {DefinedRuntimeError} will throw an error if the amount is outside minimum/maximum bounds
-     */
-    protected checkBtcAmountInBounds(amount: bigint): void {
-        if (amount < this.config.min) {
-            throw {
-                code: 20003,
-                msg: "Amount too low!",
-                data: {
-                    min: this.config.min.toString(10),
-                    max: this.config.max.toString(10)
-                }
-            };
-        }
-
-        if(amount > this.config.max) {
-            throw {
-                code: 20004,
-                msg: "Amount too high!",
-                data: {
-                    min: this.config.min.toString(10),
-                    max: this.config.max.toString(10)
-                }
-            };
-        }
-    }
-
-    /**
-     * Handles and throws plugin errors
-     *
-     * @param res Response as returned from the PluginManager.onHandlePost{To,From}BtcQuote
-     * @protected
-     * @throws {DefinedRuntimeError} will throw an error if the response is an error
-     */
-    static handlePluginErrorResponses(res: any): void {
-        if(isQuoteThrow(res)) throw {
-            code: 29999,
-            msg: res.message
-        };
-        if(isQuoteAmountTooHigh(res)) throw {
-            code: 20004,
-            msg: "Amount too high!",
-            data: {
-                min: res.data.min.toString(10),
-                max: res.data.max.toString(10)
-            }
-        };
-        if(isQuoteAmountTooLow(res)) throw {
-            code: 20003,
-            msg: "Amount too low!",
-            data: {
-                min: res.data.min.toString(10),
-                max: res.data.max.toString(10)
-            }
-        };
-    }
-
+import {ISwapPrice} from "../../prices/ISwapPrice";
+import {isQuoteAmountTooHigh, isQuoteAmountTooLow, isQuoteThrow} from "../../plugins/IPlugin";
+
+export type AmountAssertionsConfig = {min: bigint, max: bigint, baseFee: bigint, feePPM: bigint};
+
+export abstract class AmountAssertions {
+
+    readonly config: AmountAssertionsConfig;
+    readonly swapPricing: ISwapPrice;
+
+    constructor(config: AmountAssertionsConfig, swapPricing: ISwapPrice) {
+        this.config = config;
+        this.swapPricing = swapPricing;
+    }
+
+    /**
+     * Checks whether the bitcoin amount is within specified min/max bounds
+     *
+     * @param amount
+     * @protected
+     * @throws {DefinedRuntimeError} will throw an error if the amount is outside minimum/maximum bounds
+     */
+    protected checkBtcAmountInBounds(amount: bigint): void {
+        if (amount < this.config.min) {
+            throw {
+                code: 20003,
+                msg: "Amount too low!",
+                data: {
+                    min: this.config.min.toString(10),
+                    max: this.config.max.toString(10)
+                }
+            };
+        }
+
+        if(amount > this.config.max) {
+            throw {
+                code: 20004,
+                msg: "Amount too high!",
+                data: {
+                    min: this.config.min.toString(10),
+                    max: this.config.max.toString(10)
+                }
+            };
+        }
+    }
+
+    /**
+     * Handles and throws plugin errors
+     *
+     * @param res Response as returned from the PluginManager.onHandlePost{To,From}BtcQuote
+     * @protected
+     * @throws {DefinedRuntimeError} will throw an error if the response is an error
+     */
+    static handlePluginErrorResponses(res: any): void {
+        if(isQuoteThrow(res)) throw {
+            code: 29999,
+            msg: res.message
+        };
+        if(isQuoteAmountTooHigh(res)) throw {
+            code: 20004,
+            msg: "Amount too high!",
+            data: {
+                min: res.data.min.toString(10),
+                max: res.data.max.toString(10)
+            }
+        };
+        if(isQuoteAmountTooLow(res)) throw {
+            code: 20003,
+            msg: "Amount too low!",
+            data: {
+                min: res.data.min.toString(10),
+                max: res.data.max.toString(10)
+            }
+        };
+    }
+
 }