@atomiqlabs/lp-lib 16.2.0 → 16.2.1

package/src/swaps/escrow/FromBtcBaseSwapHandler.ts

@@ -1,287 +1,287 @@
-import {SwapData} from "@atomiqlabs/base";
-import {MultichainData, SwapBaseConfig} from "../SwapHandler";
-import {IParamReader} from "../../utils/paramcoders/IParamReader";
-import {FieldTypeEnum} from "../../utils/paramcoders/SchemaVerifier";
-import {Request} from "express";
-import {EscrowHandler} from "./EscrowHandler";
-import {FromBtcBaseSwap} from "./FromBtcBaseSwap";
-import {FromBtcAmountAssertions} from "../assertions/FromBtcAmountAssertions";
-import {IIntermediaryStorage} from "../../storage/IIntermediaryStorage";
-import {ISwapPrice} from "../../prices/ISwapPrice";
-
-const secondsInYear = BigInt(365*24*60*60);
-
-export type FromBtcBaseConfig = SwapBaseConfig & {
-    securityDepositAPY: number
-};
-
-export abstract class FromBtcBaseSwapHandler<V extends FromBtcBaseSwap<SwapData, S>, S> extends EscrowHandler<V, S> {
-
-    abstract config: FromBtcBaseConfig;
-
-    readonly AmountAssertions: FromBtcAmountAssertions;
-
-    constructor(
-        storageDirectory: IIntermediaryStorage<V>,
-        path: string,
-        chainsData: MultichainData,
-        swapPricing: ISwapPrice,
-        config: FromBtcBaseConfig
-    ) {
-        super(storageDirectory, path, chainsData, swapPricing);
-        this.AmountAssertions = new FromBtcAmountAssertions(config, swapPricing);
-    }
-
-    /**
-     * Starts a pre-fetch for swap price & security deposit price
-     *
-     * @param chainIdentifier
-     * @param useToken
-     * @param depositToken
-     * @param abortController
-     */
-    protected getFromBtcPricePrefetches(chainIdentifier: string, useToken: string, depositToken: string, abortController: AbortController): {
-        pricePrefetchPromise: Promise<bigint>,
-        gasTokenPricePrefetchPromise: Promise<bigint>,
-        depositTokenPricePrefetchPromise: Promise<bigint>
-    } {
-        const pricePrefetchPromise: Promise<bigint> = this.swapPricing.preFetchPrice(useToken, chainIdentifier).catch(e => {
-            this.logger.error("getFromBtcPricePrefetches(): pricePrefetch error: ", e);
-            abortController.abort(e);
-            return null;
-        });
-        const {chainInterface} = this.getChain(chainIdentifier);
-        const gasTokenPricePrefetchPromise: Promise<bigint> = useToken.toString()===chainInterface.getNativeCurrencyAddress().toString() ?
-            pricePrefetchPromise :
-            this.swapPricing.preFetchPrice(chainInterface.getNativeCurrencyAddress(), chainIdentifier).catch(e => {
-                this.logger.error("getFromBtcPricePrefetches(): gasTokenPricePrefetchPromise error: ", e);
-                abortController.abort(e);
-                return null;
-            });
-        const depositTokenPricePrefetchPromise: Promise<bigint> = depositToken===chainInterface.getNativeCurrencyAddress() ?
-            gasTokenPricePrefetchPromise :
-            this.swapPricing.preFetchPrice(depositToken, chainIdentifier).catch(e => {
-                this.logger.error("getFromBtcPricePrefetches(): depositTokenPricePrefetchPromise error: ", e);
-                abortController.abort(e);
-                return null;
-            });
-        return {pricePrefetchPromise, gasTokenPricePrefetchPromise, depositTokenPricePrefetchPromise};
-    }
-
-    /**
-     * Starts a pre-fetch for base security deposit (transaction fee for refunding transaction on our side)
-     *
-     * @param chainIdentifier
-     * @param dummySwapData
-     * @param depositToken
-     * @param gasTokenPricePrefetchPromise
-     * @param depositTokenPricePrefetchPromise
-     * @param abortController
-     */
-    protected async getBaseSecurityDepositPrefetch(
-        chainIdentifier: string, dummySwapData: SwapData, depositToken: string,
-        gasTokenPricePrefetchPromise: Promise<bigint>, depositTokenPricePrefetchPromise: Promise<bigint>,
-        abortController: AbortController
-    ): Promise<bigint> {
-        //Solana workaround
-        const {swapContract, chainInterface, signer} = this.getChain(chainIdentifier);
-        let feeResult: bigint;
-        const gasToken = chainInterface.getNativeCurrencyAddress();
-        if (swapContract.getRawRefundFee != null) {
-            try {
-                feeResult = await swapContract.getRawRefundFee(signer.getAddress(), dummySwapData);
-            } catch (e) {
-                this.logger.error("getBaseSecurityDepositPrefetch(): pre-fetch error: ", e);
-                abortController.abort(e);
-                return null;
-            }
-        } else {
-            try {
-                feeResult = await swapContract.getRefundFee(signer.getAddress(), dummySwapData);
-            } catch (e1) {
-                this.logger.error("getBaseSecurityDepositPrefetch(): pre-fetch error: ", e1);
-                abortController.abort(e1);
-                return null;
-            }
-        }
-        feeResult = feeResult * 2n;
-        if(gasToken===depositToken) return feeResult;
-        const btcValue = await this.swapPricing.getToBtcSwapAmount(feeResult, gasToken, chainIdentifier, true, gasTokenPricePrefetchPromise);
-        return await this.swapPricing.getFromBtcSwapAmount(btcValue, depositToken, chainIdentifier, true, depositTokenPricePrefetchPromise);
-    }
-
-    /**
-     * Starts a pre-fetch for vault balance
-     *
-     * @param chainIdentifier
-     * @param useToken
-     * @param abortController
-     * @param inContract
-     */
-    protected async getBalancePrefetch(chainIdentifier: string, useToken: string, abortController: AbortController, inContract: boolean = true): Promise<bigint> {
-        const {swapContract, signer} = this.getChain(chainIdentifier);
-        try {
-            return await swapContract.getBalance(signer.getAddress(), useToken, inContract);
-        } catch (e) {
-            this.logger.error("getBalancePrefetch(): balancePrefetch error: ", e);
-            abortController.abort(e);
-            return null;
-        }
-    }
-
-    /**
-     * Checks if we have enough balance of the token in the swap vault
-     *
-     * @param totalInToken
-     * @param balancePrefetch
-     * @param signal
-     * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
-     */
-    protected async checkBalance(totalInToken: bigint, balancePrefetch: Promise<bigint>, signal: AbortSignal | null): Promise<void> {
-        if(totalInToken===0n) return;
-
-        const balance = await balancePrefetch;
-        if(signal!=null) signal.throwIfAborted();
-
-        if(balance==null || balance < totalInToken) {
-            throw {
-                code: 20002,
-                msg: "Not enough liquidity"
-            };
-        }
-    }
-
-    /**
-     * Checks if the specified token is allowed as a deposit token
-     *
-     * @param chainIdentifier
-     * @param depositToken
-     * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
-     */
-    protected checkAllowedDepositToken(chainIdentifier: string, depositToken: string): void {
-        const {chainInterface, allowedDepositTokens} = this.getChain(chainIdentifier);
-        if(allowedDepositTokens==null) {
-            if(depositToken!==chainInterface.getNativeCurrencyAddress()) throw {
-                code: 20190,
-                msg: "Unsupported deposit token"
-            };
-        } else {
-            if(!allowedDepositTokens.includes(depositToken)) throw {
-                code: 20190,
-                msg: "Unsupported deposit token"
-            };
-        }
-    }
-
-    /**
-     * Signs the created swap
-     *
-     * @param chainIdentifier
-     * @param swapObject
-     * @param req
-     * @param abortSignal
-     * @param signDataPrefetchPromise
-     */
-    protected async getFromBtcSignatureData(
-        chainIdentifier: string,
-        swapObject: SwapData,
-        req: Request & {paramReader: IParamReader},
-        abortSignal: AbortSignal,
-        signDataPrefetchPromise?: Promise<any>
-    ): Promise<{
-        prefix: string,
-        timeout: string,
-        signature: string,
-        feeRate: string
-    }> {
-        const {swapContract, signer} = this.getChain(chainIdentifier);
-
-        const prefetchedSignData = signDataPrefetchPromise!=null ? await signDataPrefetchPromise : null;
-        if(prefetchedSignData!=null) this.logger.debug("getFromBtcSignatureData(): pre-fetched signature data: ", prefetchedSignData);
-        abortSignal.throwIfAborted();
-
-        const feeRateObj = await req.paramReader.getParams({
-            feeRate: FieldTypeEnum.String
-        }).catch(() => null);
-        abortSignal.throwIfAborted();
-
-        const feeRate = feeRateObj?.feeRate!=null && typeof(feeRateObj.feeRate)==="string" ? feeRateObj.feeRate : null;
-        this.logger.debug("getFromBtcSignatureData(): using fee rate from client: ", feeRate);
-        const sigData = await swapContract.getInitSignature(
-            signer,
-            swapObject,
-            this.getInitAuthorizationTimeout(chainIdentifier),
-            prefetchedSignData,
-            feeRate
-        );
-        abortSignal.throwIfAborted();
-
-        return {
-            ...sigData,
-            feeRate
-        };
-    }
-
-    /**
-     * Calculates the required security deposit
-     *
-     * @param chainIdentifier
-     * @param amountBD
-     * @param swapFee
-     * @param expiryTimeout
-     * @param baseSecurityDepositPromise
-     * @param depositToken
-     * @param depositTokenPricePrefetchPromise
-     * @param securityDepositData
-     * @param signal
-     * @param metadata
-     */
-    protected async getSecurityDeposit(
-        chainIdentifier: string,
-        amountBD: bigint,
-        swapFee: bigint,
-        expiryTimeout: bigint,
-        baseSecurityDepositPromise: Promise<bigint>,
-        depositToken: string,
-        depositTokenPricePrefetchPromise: Promise<bigint>,
-        securityDepositData: {
-            securityDepositApyPPM?: bigint,
-            securityDepositBaseMultiplierPPM?: bigint,
-        },
-        signal: AbortSignal,
-        metadata: any
-    ): Promise<bigint> {
-        let baseSD: bigint = await baseSecurityDepositPromise;
-        if(securityDepositData.securityDepositBaseMultiplierPPM!=null)
-            baseSD = baseSD * securityDepositData.securityDepositBaseMultiplierPPM / 1_000_000n;
-
-        signal.throwIfAborted();
-
-        metadata.times.refundFeeFetched = Date.now();
-
-        const swapValueInDepositToken = await this.swapPricing.getFromBtcSwapAmount(
-            amountBD - swapFee,
-            depositToken,
-            chainIdentifier,
-            true,
-            depositTokenPricePrefetchPromise
-        );
-
-        signal.throwIfAborted();
-
-        const apyPPM = securityDepositData.securityDepositApyPPM ?? BigInt(Math.floor(this.config.securityDepositAPY*1000000));
-        const variableSD = swapValueInDepositToken * apyPPM * expiryTimeout / 1000000n / secondsInYear;
-
-        this.logger.debug(
-            "getSecurityDeposit(): base security deposit: "+baseSD.toString(10)+
-            " deposit token: "+depositToken+
-            " swap output in deposit token: "+swapValueInDepositToken.toString(10)+
-            " apy ppm: "+apyPPM.toString(10)+
-            " expiry timeout: "+expiryTimeout.toString(10)+
-            " variable security deposit: "+variableSD.toString(10)
-        );
-
-        return baseSD + variableSD;
-    }
-
+import {SwapData} from "@atomiqlabs/base";
+import {MultichainData, SwapBaseConfig} from "../SwapHandler";
+import {IParamReader} from "../../utils/paramcoders/IParamReader";
+import {FieldTypeEnum} from "../../utils/paramcoders/SchemaVerifier";
+import {Request} from "express";
+import {EscrowHandler} from "./EscrowHandler";
+import {FromBtcBaseSwap} from "./FromBtcBaseSwap";
+import {FromBtcAmountAssertions} from "../assertions/FromBtcAmountAssertions";
+import {IIntermediaryStorage} from "../../storage/IIntermediaryStorage";
+import {ISwapPrice} from "../../prices/ISwapPrice";
+
+const secondsInYear = BigInt(365*24*60*60);
+
+export type FromBtcBaseConfig = SwapBaseConfig & {
+    securityDepositAPY: number
+};
+
+export abstract class FromBtcBaseSwapHandler<V extends FromBtcBaseSwap<SwapData, S>, S> extends EscrowHandler<V, S> {
+
+    abstract config: FromBtcBaseConfig;
+
+    readonly AmountAssertions: FromBtcAmountAssertions;
+
+    constructor(
+        storageDirectory: IIntermediaryStorage<V>,
+        path: string,
+        chainsData: MultichainData,
+        swapPricing: ISwapPrice,
+        config: FromBtcBaseConfig
+    ) {
+        super(storageDirectory, path, chainsData, swapPricing);
+        this.AmountAssertions = new FromBtcAmountAssertions(config, swapPricing);
+    }
+
+    /**
+     * Starts a pre-fetch for swap price & security deposit price
+     *
+     * @param chainIdentifier
+     * @param useToken
+     * @param depositToken
+     * @param abortController
+     */
+    protected getFromBtcPricePrefetches(chainIdentifier: string, useToken: string, depositToken: string, abortController: AbortController): {
+        pricePrefetchPromise: Promise<bigint>,
+        gasTokenPricePrefetchPromise: Promise<bigint>,
+        depositTokenPricePrefetchPromise: Promise<bigint>
+    } {
+        const pricePrefetchPromise: Promise<bigint> = this.swapPricing.preFetchPrice(useToken, chainIdentifier).catch(e => {
+            this.logger.error("getFromBtcPricePrefetches(): pricePrefetch error: ", e);
+            abortController.abort(e);
+            return null;
+        });
+        const {chainInterface} = this.getChain(chainIdentifier);
+        const gasTokenPricePrefetchPromise: Promise<bigint> = useToken.toString()===chainInterface.getNativeCurrencyAddress().toString() ?
+            pricePrefetchPromise :
+            this.swapPricing.preFetchPrice(chainInterface.getNativeCurrencyAddress(), chainIdentifier).catch(e => {
+                this.logger.error("getFromBtcPricePrefetches(): gasTokenPricePrefetchPromise error: ", e);
+                abortController.abort(e);
+                return null;
+            });
+        const depositTokenPricePrefetchPromise: Promise<bigint> = depositToken===chainInterface.getNativeCurrencyAddress() ?
+            gasTokenPricePrefetchPromise :
+            this.swapPricing.preFetchPrice(depositToken, chainIdentifier).catch(e => {
+                this.logger.error("getFromBtcPricePrefetches(): depositTokenPricePrefetchPromise error: ", e);
+                abortController.abort(e);
+                return null;
+            });
+        return {pricePrefetchPromise, gasTokenPricePrefetchPromise, depositTokenPricePrefetchPromise};
+    }
+
+    /**
+     * Starts a pre-fetch for base security deposit (transaction fee for refunding transaction on our side)
+     *
+     * @param chainIdentifier
+     * @param dummySwapData
+     * @param depositToken
+     * @param gasTokenPricePrefetchPromise
+     * @param depositTokenPricePrefetchPromise
+     * @param abortController
+     */
+    protected async getBaseSecurityDepositPrefetch(
+        chainIdentifier: string, dummySwapData: SwapData, depositToken: string,
+        gasTokenPricePrefetchPromise: Promise<bigint>, depositTokenPricePrefetchPromise: Promise<bigint>,
+        abortController: AbortController
+    ): Promise<bigint> {
+        //Solana workaround
+        const {swapContract, chainInterface, signer} = this.getChain(chainIdentifier);
+        let feeResult: bigint;
+        const gasToken = chainInterface.getNativeCurrencyAddress();
+        if (swapContract.getRawRefundFee != null) {
+            try {
+                feeResult = await swapContract.getRawRefundFee(signer.getAddress(), dummySwapData);
+            } catch (e) {
+                this.logger.error("getBaseSecurityDepositPrefetch(): pre-fetch error: ", e);
+                abortController.abort(e);
+                return null;
+            }
+        } else {
+            try {
+                feeResult = await swapContract.getRefundFee(signer.getAddress(), dummySwapData);
+            } catch (e1) {
+                this.logger.error("getBaseSecurityDepositPrefetch(): pre-fetch error: ", e1);
+                abortController.abort(e1);
+                return null;
+            }
+        }
+        feeResult = feeResult * 2n;
+        if(gasToken===depositToken) return feeResult;
+        const btcValue = await this.swapPricing.getToBtcSwapAmount(feeResult, gasToken, chainIdentifier, true, gasTokenPricePrefetchPromise);
+        return await this.swapPricing.getFromBtcSwapAmount(btcValue, depositToken, chainIdentifier, true, depositTokenPricePrefetchPromise);
+    }
+
+    /**
+     * Starts a pre-fetch for vault balance
+     *
+     * @param chainIdentifier
+     * @param useToken
+     * @param abortController
+     * @param inContract
+     */
+    protected async getBalancePrefetch(chainIdentifier: string, useToken: string, abortController: AbortController, inContract: boolean = true): Promise<bigint> {
+        const {swapContract, signer} = this.getChain(chainIdentifier);
+        try {
+            return await swapContract.getBalance(signer.getAddress(), useToken, inContract);
+        } catch (e) {
+            this.logger.error("getBalancePrefetch(): balancePrefetch error: ", e);
+            abortController.abort(e);
+            return null;
+        }
+    }
+
+    /**
+     * Checks if we have enough balance of the token in the swap vault
+     *
+     * @param totalInToken
+     * @param balancePrefetch
+     * @param signal
+     * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
+     */
+    protected async checkBalance(totalInToken: bigint, balancePrefetch: Promise<bigint>, signal: AbortSignal | null): Promise<void> {
+        if(totalInToken===0n) return;
+
+        const balance = await balancePrefetch;
+        if(signal!=null) signal.throwIfAborted();
+
+        if(balance==null || balance < totalInToken) {
+            throw {
+                code: 20002,
+                msg: "Not enough liquidity"
+            };
+        }
+    }
+
+    /**
+     * Checks if the specified token is allowed as a deposit token
+     *
+     * @param chainIdentifier
+     * @param depositToken
+     * @throws {DefinedRuntimeError} will throw an error if there are not enough funds in the vault
+     */
+    protected checkAllowedDepositToken(chainIdentifier: string, depositToken: string): void {
+        const {chainInterface, allowedDepositTokens} = this.getChain(chainIdentifier);
+        if(allowedDepositTokens==null) {
+            if(depositToken!==chainInterface.getNativeCurrencyAddress()) throw {
+                code: 20190,
+                msg: "Unsupported deposit token"
+            };
+        } else {
+            if(!allowedDepositTokens.includes(depositToken)) throw {
+                code: 20190,
+                msg: "Unsupported deposit token"
+            };
+        }
+    }
+
+    /**
+     * Signs the created swap
+     *
+     * @param chainIdentifier
+     * @param swapObject
+     * @param req
+     * @param abortSignal
+     * @param signDataPrefetchPromise
+     */
+    protected async getFromBtcSignatureData(
+        chainIdentifier: string,
+        swapObject: SwapData,
+        req: Request & {paramReader: IParamReader},
+        abortSignal: AbortSignal,
+        signDataPrefetchPromise?: Promise<any>
+    ): Promise<{
+        prefix: string,
+        timeout: string,
+        signature: string,
+        feeRate: string
+    }> {
+        const {swapContract, signer} = this.getChain(chainIdentifier);
+
+        const prefetchedSignData = signDataPrefetchPromise!=null ? await signDataPrefetchPromise : null;
+        if(prefetchedSignData!=null) this.logger.debug("getFromBtcSignatureData(): pre-fetched signature data: ", prefetchedSignData);
+        abortSignal.throwIfAborted();
+
+        const feeRateObj = await req.paramReader.getParams({
+            feeRate: FieldTypeEnum.String
+        }).catch(() => null);
+        abortSignal.throwIfAborted();
+
+        const feeRate = feeRateObj?.feeRate!=null && typeof(feeRateObj.feeRate)==="string" ? feeRateObj.feeRate : null;
+        this.logger.debug("getFromBtcSignatureData(): using fee rate from client: ", feeRate);
+        const sigData = await swapContract.getInitSignature(
+            signer,
+            swapObject,
+            this.getInitAuthorizationTimeout(chainIdentifier),
+            prefetchedSignData,
+            feeRate
+        );
+        abortSignal.throwIfAborted();
+
+        return {
+            ...sigData,
+            feeRate
+        };
+    }
+
+    /**
+     * Calculates the required security deposit
+     *
+     * @param chainIdentifier
+     * @param amountBD
+     * @param swapFee
+     * @param expiryTimeout
+     * @param baseSecurityDepositPromise
+     * @param depositToken
+     * @param depositTokenPricePrefetchPromise
+     * @param securityDepositData
+     * @param signal
+     * @param metadata
+     */
+    protected async getSecurityDeposit(
+        chainIdentifier: string,
+        amountBD: bigint,
+        swapFee: bigint,
+        expiryTimeout: bigint,
+        baseSecurityDepositPromise: Promise<bigint>,
+        depositToken: string,
+        depositTokenPricePrefetchPromise: Promise<bigint>,
+        securityDepositData: {
+            securityDepositApyPPM?: bigint,
+            securityDepositBaseMultiplierPPM?: bigint,
+        },
+        signal: AbortSignal,
+        metadata: any
+    ): Promise<bigint> {
+        let baseSD: bigint = await baseSecurityDepositPromise;
+        if(securityDepositData.securityDepositBaseMultiplierPPM!=null)
+            baseSD = baseSD * securityDepositData.securityDepositBaseMultiplierPPM / 1_000_000n;
+
+        signal.throwIfAborted();
+
+        metadata.times.refundFeeFetched = Date.now();
+
+        const swapValueInDepositToken = await this.swapPricing.getFromBtcSwapAmount(
+            amountBD - swapFee,
+            depositToken,
+            chainIdentifier,
+            true,
+            depositTokenPricePrefetchPromise
+        );
+
+        signal.throwIfAborted();
+
+        const apyPPM = securityDepositData.securityDepositApyPPM ?? BigInt(Math.floor(this.config.securityDepositAPY*1000000));
+        const variableSD = swapValueInDepositToken * apyPPM * expiryTimeout / 1000000n / secondsInYear;
+
+        this.logger.debug(
+            "getSecurityDeposit(): base security deposit: "+baseSD.toString(10)+
+            " deposit token: "+depositToken+
+            " swap output in deposit token: "+swapValueInDepositToken.toString(10)+
+            " apy ppm: "+apyPPM.toString(10)+
+            " expiry timeout: "+expiryTimeout.toString(10)+
+            " variable security deposit: "+variableSD.toString(10)
+        );
+
+        return baseSD + variableSD;
+    }
+
 }