@atomiqlabs/lp-lib 12.1.0 → 13.0.0-beta.1

package/src/swaps/SwapHandlerSwap.ts

@@ -11,31 +11,23 @@ function objectBigIntsToString(obj: Object) {
     return obj;
 }
 
-export abstract class SwapHandlerSwap<T extends SwapData = SwapData, S = any> extends Lockable implements StorageObject {
+export abstract class SwapHandlerSwap<S = any> extends Lockable implements StorageObject {
+    type: SwapHandlerType;
 
     chainIdentifier: string;
     state: S;
 
-    type: SwapHandlerType;
-    data: T;
     metadata: {
         request: any,
         times: {[key: string]: number},
         [key: string]: any
     };
     txIds: {
-        init?: string,
-        claim?: string,
-        refund?: string
+        [key: string]: string
     } = {};
     readonly swapFee: bigint;
     readonly swapFeeInToken: bigint;
 
-    prefix: string;
-    timeout: string;
-    signature: string;
-    feeRate: string;
-
     protected constructor(chainIdentifier: string, swapFee: bigint, swapFeeInToken: bigint);
     protected constructor(obj: any);
 
@@ -47,33 +39,23 @@ export abstract class SwapHandlerSwap<T extends SwapData = SwapData, S = any> ex
             this.swapFeeInToken = swapFeeInToken;
             return;
         } else {
-            this.data = obj.data==null ? null : SwapData.deserialize(obj.data);
             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);
-            this.prefix = obj.prefix;
-            this.timeout = obj.timeout;
-            this.signature = obj.signature;
-            this.feeRate = obj.feeRate;
         }
     }
 
     serialize(): any {
         return {
             state: this.state,
-            data: this.data==null ? null : this.data.serialize(),
             chainIdentifier: this.chainIdentifier,
             metadata: objectBigIntsToString(this.metadata),
             txIds: this.txIds,
             swapFee: serializeBN(this.swapFee),
-            swapFeeInToken: serializeBN(this.swapFeeInToken),
-            prefix: this.prefix,
-            timeout: this.timeout,
-            signature: this.signature,
-            feeRate: this.feeRate
+            swapFeeInToken: serializeBN(this.swapFeeInToken)
         }
     }
 
@@ -88,31 +70,13 @@ export abstract class SwapHandlerSwap<T extends SwapData = SwapData, S = any> ex
         return PluginManager.swapStateChange(this, oldState);
     }
 
-    /**
-     * Returns the escrow hash - i.e. hash of the escrow data
-     */
-    getEscrowHash(): string {
-        return this.data.getEscrowHash();
-    }
-
-    /**
-     * Returns the claim data hash - i.e. hash passed to the claim handler
-     */
-    getClaimHash(): string {
-        return this.data.getClaimHash();
-    }
-
     /**
      * 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
      */
-    getIdentifierHash(): string {
-        return this.getClaimHash();
-    }
+    abstract getIdentifierHash(): string;
 
-    getSequence(): bigint | null {
-        return this.data?.getSequence==null ? null : this.data.getSequence();
-    }
+    abstract getSequence(): bigint | null;
 
     /**
      * Returns unique identifier of the swap in the form <hash>_<sequence> or just <hash> if the swap type doesn't
@@ -128,9 +92,7 @@ export abstract class SwapHandlerSwap<T extends SwapData = SwapData, S = any> ex
     /**
      * Returns the smart chain token used for the swap
      */
-    getToken(): string {
-        return this.data?.getToken();
-    }
+    abstract getToken(): string
 
     /**
      * Checks whether the swap is finished, such that it is final and either successful or failed
@@ -157,7 +119,9 @@ export abstract class SwapHandlerSwap<T extends SwapData = SwapData, S = any> ex
     /**
      * Returns the input amount paid by the user (excluding fees)
      */
-    abstract getInputAmount(): bigint;
+    getInputAmount(): bigint {
+        return this.getTotalInputAmount() - this.getSwapFee().inInputToken;
+    }
 
     /**
      * Returns the total input amount paid by the user (including all fees)

package/src/swaps/assertions/AmountAssertions.ts

@@ -0,0 +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)
+            }
+        };
+    }
+
+}

package/src/swaps/assertions/FromBtcAmountAssertions.ts

@@ -0,0 +1,228 @@
+import {FromBtcLnRequestType} from "../escrow/frombtcln_abstract/FromBtcLnAbs";
+import {FromBtcRequestType} from "../escrow/frombtc_abstract/FromBtcAbs";
+import {FromBtcLnTrustedRequestType} from "../trusted/frombtcln_trusted/FromBtcLnTrusted";
+import {PluginManager} from "../../plugins/PluginManager";
+import {isPluginQuote, isQuoteSetFees} from "../../plugins/IPlugin";
+import {RequestData, SwapHandlerType} from "../SwapHandler";
+import {AmountAssertions, AmountAssertionsConfig} from "./AmountAssertions";
+import {ISwapPrice} from "../../prices/ISwapPrice";
+import {FromBtcTrustedRequestType} from "../trusted/frombtc_trusted/FromBtcTrusted";
+import {SpvVaultSwapRequestType} from "../spv_vault_swap/SpvVaultSwapHandler";
+
+export type FromBtcAmountAssertionsConfig = AmountAssertionsConfig & {
+    gasTokenMax?: {[chainId: string]: bigint}
+};
+
+export class FromBtcAmountAssertions extends AmountAssertions {
+
+    readonly config: FromBtcAmountAssertionsConfig;
+
+    constructor(config: FromBtcAmountAssertionsConfig, swapPricing: ISwapPrice) {
+        super(config, swapPricing)
+        this.config = config;
+    }
+
+    /**
+     * Checks minimums/maximums, calculates the fee & total amount
+     *
+     * @param swapType
+     * @param request
+     * @param requestedAmount
+     * @param gasAmount
+     * @throws {DefinedRuntimeError} will throw an error if the amount is outside minimum/maximum bounds
+     */
+    async preCheckFromBtcAmounts(
+        swapType: SwapHandlerType.FROM_BTCLN | SwapHandlerType.FROM_BTC | SwapHandlerType.FROM_BTCLN_TRUSTED | SwapHandlerType.FROM_BTC_TRUSTED | SwapHandlerType.FROM_BTC_SPV,
+        request: RequestData<FromBtcLnRequestType | FromBtcRequestType | FromBtcLnTrustedRequestType | FromBtcTrustedRequestType | SpvVaultSwapRequestType>,
+        requestedAmount: {input: boolean, amount: bigint, token: string},
+        gasAmount?: {input: false, amount: bigint, token: string}
+    ): Promise<{
+        baseFee: bigint,
+        feePPM: bigint,
+        securityDepositApyPPM?: bigint,
+        securityDepositBaseMultiplierPPM?: bigint,
+    }> {
+        const res = await PluginManager.onHandlePreFromBtcQuote(
+            swapType,
+            request,
+            requestedAmount,
+            request.chainIdentifier,
+            {minInBtc: this.config.min, maxInBtc: this.config.max},
+            {baseFeeInBtc: this.config.baseFee, feePPM: this.config.feePPM},
+            gasAmount
+        );
+        if(res!=null) {
+            AmountAssertions.handlePluginErrorResponses(res);
+            if(isQuoteSetFees(res)) {
+                return {
+                    baseFee: res.baseFee || this.config.baseFee,
+                    feePPM: res.feePPM || this.config.feePPM,
+                    securityDepositApyPPM: res.securityDepositApyPPM,
+                    securityDepositBaseMultiplierPPM: res.securityDepositBaseMultiplierPPM
+                }
+            }
+        }
+        if(requestedAmount.input) this.checkBtcAmountInBounds(requestedAmount.amount);
+
+        if(gasAmount!=null && gasAmount.amount!==0n) {
+            if(gasAmount.amount > (this.config.gasTokenMax?.[request.chainIdentifier] ?? 0n)) {
+                throw {
+                    code: 20504,
+                    msg: "Gas token amount too high!",
+                    data: {
+                        max: (this.config.gasTokenMax?.[request.chainIdentifier] ?? 0n).toString(10)
+                    }
+                };
+            }
+        }
+
+        return {
+            baseFee: this.config.baseFee,
+            feePPM: this.config.feePPM
+        };
+    }
+
+    /**
+     * Checks minimums/maximums, calculates the fee & total amount
+     *
+     * @param swapType
+     * @param request
+     * @param requestedAmount
+     * @param fees
+     * @param signal
+     * @param gasTokenAmount
+     * @throws {DefinedRuntimeError} will throw an error if the amount is outside minimum/maximum bounds
+     */
+    async checkFromBtcAmount(
+        swapType: SwapHandlerType.FROM_BTCLN | SwapHandlerType.FROM_BTC | SwapHandlerType.FROM_BTCLN_TRUSTED | SwapHandlerType.FROM_BTC_TRUSTED | SwapHandlerType.FROM_BTC_SPV,
+        request: RequestData<FromBtcLnRequestType | FromBtcRequestType | FromBtcLnTrustedRequestType | FromBtcTrustedRequestType | SpvVaultSwapRequestType>,
+        requestedAmount: {input: boolean, amount: bigint, token: string, pricePrefetch?: Promise<bigint>},
+        fees: {baseFee: bigint, feePPM: bigint},
+        signal: AbortSignal,
+        gasTokenAmount?: {input: false, amount: bigint, token: string, pricePrefetch?: Promise<bigint>}
+    ): Promise<{
+        amountBD: bigint,
+        swapFee: bigint, //Swap fee in BTC
+        swapFeeInToken: bigint, //Swap fee in token on top of what should be paid out to the user
+        totalInToken: bigint, //Total to be paid out to the user
+        amountBDgas?: bigint
+        gasSwapFee?: bigint
+        gasSwapFeeInToken?: bigint,
+        totalInGasToken?: bigint,
+        securityDepositApyPPM?: bigint,
+        securityDepositBaseMultiplierPPM?: bigint
+    }> {
+        const chainIdentifier = request.chainIdentifier;
+
+        let securityDepositApyPPM: bigint;
+        let securityDepositBaseMultiplierPPM: bigint;
+
+        const res = await PluginManager.onHandlePostFromBtcQuote(
+            swapType,
+            request,
+            requestedAmount,
+            chainIdentifier,
+            {minInBtc: this.config.min, maxInBtc: this.config.max},
+            {baseFeeInBtc: fees.baseFee, feePPM: fees.feePPM},
+            gasTokenAmount
+        );
+        signal.throwIfAborted();
+        if(res!=null) {
+            AmountAssertions.handlePluginErrorResponses(res);
+            if(isQuoteSetFees(res)) {
+                if(res.baseFee!=null) fees.baseFee = res.baseFee;
+                if(res.feePPM!=null) fees.feePPM = res.feePPM;
+                if(res.securityDepositApyPPM!=null) securityDepositApyPPM = res.securityDepositApyPPM;
+                if(res.securityDepositBaseMultiplierPPM!=null) securityDepositBaseMultiplierPPM = res.securityDepositBaseMultiplierPPM;
+            }
+            if(isPluginQuote(res)) {
+                if(!requestedAmount.input) {
+                    return {
+                        amountBD: res.amount.amount + res.swapFee.inInputTokens,
+                        swapFee: res.swapFee.inInputTokens,
+                        swapFeeInToken: res.swapFee.inOutputTokens,
+                        totalInToken: requestedAmount.amount
+                    }
+                } else {
+                    return {
+                        amountBD: requestedAmount.amount,
+                        swapFee: res.swapFee.inInputTokens,
+                        swapFeeInToken: res.swapFee.inOutputTokens,
+                        totalInToken: res.amount.amount
+                    }
+                }
+            }
+        }
+
+        let amountBDgas: bigint = 0n;
+        if(gasTokenAmount!=null) {
+            amountBDgas = await this.swapPricing.getToBtcSwapAmount(gasTokenAmount.amount, gasTokenAmount.token, chainIdentifier, true, gasTokenAmount.pricePrefetch);
+        }
+
+        let amountBD: bigint;
+        if(!requestedAmount.input) {
+            amountBD = await this.swapPricing.getToBtcSwapAmount(requestedAmount.amount, requestedAmount.token, chainIdentifier, true, requestedAmount.pricePrefetch);
+            signal.throwIfAborted();
+
+            // amt = (amt+base_fee)/(1-fee)
+            amountBD = (amountBD + fees.baseFee) * 1000000n / (1000000n - fees.feePPM);
+            amountBDgas = amountBDgas * 1000000n / (1000000n - fees.feePPM);
+
+            const tooLow = amountBD < (this.config.min * 95n / 100n);
+            const tooHigh = amountBD > (this.config.max * 105n / 100n);
+            if(tooLow || tooHigh) {
+                const adjustedMin = this.config.min * (1000000n - fees.feePPM) / (1000000n - fees.baseFee);
+                const adjustedMax = this.config.max * (1000000n - fees.feePPM) / (1000000n - fees.baseFee);
+                const minIn = await this.swapPricing.getFromBtcSwapAmount(
+                    adjustedMin, requestedAmount.token, chainIdentifier, null, requestedAmount.pricePrefetch
+                );
+                const maxIn = await this.swapPricing.getFromBtcSwapAmount(
+                    adjustedMax, requestedAmount.token, chainIdentifier, null, requestedAmount.pricePrefetch
+                );
+                throw {
+                    code: tooLow ? 20003 : 20004,
+                    msg: tooLow ? "Amount too low!" : "Amount too high!",
+                    data: {
+                        min: minIn.toString(10),
+                        max: maxIn.toString(10)
+                    }
+                };
+            }
+        } else {
+            amountBD = requestedAmount.amount - amountBDgas;
+            this.checkBtcAmountInBounds(amountBD);
+        }
+
+        const swapFee = fees.baseFee + (amountBD * fees.feePPM / 1000000n);
+        const swapFeeInToken = await this.swapPricing.getFromBtcSwapAmount(swapFee, requestedAmount.token, chainIdentifier, true, requestedAmount.pricePrefetch);
+        signal.throwIfAborted();
+
+        const gasSwapFee = ((amountBDgas * fees.feePPM) + 999999n) / 1000000n;
+        const gasSwapFeeInToken = gasTokenAmount==null ?
+            0n :
+            await this.swapPricing.getFromBtcSwapAmount(gasSwapFee, gasTokenAmount.token, chainIdentifier, true, gasTokenAmount.pricePrefetch);
+        signal.throwIfAborted();
+
+        let totalInToken: bigint;
+        if(!requestedAmount.input) {
+            totalInToken = requestedAmount.amount;
+        } else {
+            totalInToken = await this.swapPricing.getFromBtcSwapAmount(amountBD - swapFee - gasSwapFee, requestedAmount.token, chainIdentifier, null, requestedAmount.pricePrefetch);
+            signal.throwIfAborted();
+        }
+
+        return {
+            amountBD,
+            swapFee,
+            swapFeeInToken,
+            totalInToken,
+            amountBDgas,
+            gasSwapFee,
+            gasSwapFeeInToken,
+            totalInGasToken: gasTokenAmount?.amount,
+            securityDepositApyPPM,
+            securityDepositBaseMultiplierPPM
+        }
+    }
+
+}

package/src/swaps/assertions/LightningAssertions.ts

@@ -0,0 +1,103 @@
+import {ILightningWallet, LightningNetworkChannel} from "../../wallets/ILightningWallet";
+import {LoggerType} from "../../utils/Utils";
+import {ISwapPrice} from "../../prices/ISwapPrice";
+
+export class LightningAssertions {
+
+    protected readonly LIGHTNING_LIQUIDITY_CACHE_TIMEOUT = 5*1000;
+    lightningLiquidityCache: {
+        liquidity: bigint,
+        timestamp: number
+    };
+
+    readonly lightning: ILightningWallet;
+    readonly logger: LoggerType;
+
+    constructor(
+        logger: LoggerType,
+        lightning: ILightningWallet
+    ) {
+        this.logger = logger;
+        this.lightning = lightning;
+    }
+
+    /**
+     * Checks if the prior payment with the same paymentHash exists
+     *
+     * @param paymentHash
+     * @param abortSignal
+     * @throws {DefinedRuntimeError} will throw an error if payment already exists
+     */
+    async checkPriorPayment(paymentHash: string, abortSignal: AbortSignal): Promise<void> {
+        const payment = await this.lightning.getPayment(paymentHash);
+        if(payment!=null) throw {
+            code: 20010,
+            msg: "Already processed"
+        };
+        abortSignal.throwIfAborted();
+    }
+
+    /**
+     * Checks if the underlying LND backend has enough liquidity in channels to honor the swap
+     *
+     * @param amount
+     * @param abortSignal
+     * @param useCached Whether to use cached liquidity values
+     * @throws {DefinedRuntimeError} will throw an error if there isn't enough liquidity
+     */
+    async checkLiquidity(amount: bigint, abortSignal: AbortSignal, useCached: boolean = false): Promise<void> {
+        if(!useCached || this.lightningLiquidityCache==null || this.lightningLiquidityCache.timestamp<Date.now()-this.LIGHTNING_LIQUIDITY_CACHE_TIMEOUT) {
+            const channelBalances = await this.lightning.getLightningBalance();
+            this.lightningLiquidityCache = {
+                liquidity: channelBalances.localBalance,
+                timestamp: Date.now()
+            }
+        }
+        if(amount > this.lightningLiquidityCache.liquidity) {
+            throw {
+                code: 20002,
+                msg: "Not enough liquidity"
+            };
+        }
+        abortSignal.throwIfAborted();
+    }
+
+    /**
+     * Checks if we have enough inbound liquidity to be able to receive an LN payment (without MPP)
+     *
+     * @param amountBD
+     * @param channelsPrefetch
+     * @param signal
+     * @throws {DefinedRuntimeError} will throw an error if there isn't enough inbound liquidity to receive the LN payment
+     */
+    async checkInboundLiquidity(amountBD: bigint, channelsPrefetch: Promise<LightningNetworkChannel[]>, signal: AbortSignal) {
+        const channelsResponse = await channelsPrefetch;
+
+        signal.throwIfAborted();
+
+        let hasEnoughInboundLiquidity = false;
+        channelsResponse.forEach(channel => {
+            if(channel.remoteBalance >= amountBD) hasEnoughInboundLiquidity = true;
+        });
+        if(!hasEnoughInboundLiquidity) {
+            throw {
+                code: 20050,
+                msg: "Not enough LN inbound liquidity"
+            };
+        }
+    }
+
+    /**
+     * Starts LN channels pre-fetch
+     *
+     * @param abortController
+     */
+    getChannelsPrefetch(abortController: AbortController): Promise<LightningNetworkChannel[]> {
+        return this.lightning.getChannels(true).catch(e => {
+            this.logger.error("getChannelsPrefetch(): error", e);
+            abortController.abort(e);
+            return null;
+        });
+    }
+
+}