@atomiqlabs/lp-lib 15.0.13 → 15.0.14

package/src/plugins/IPlugin.ts

@@ -1,174 +1,174 @@
-import {BitcoinRpc} from "@atomiqlabs/base";
-import {
-    FromBtcLnRequestType,
-    FromBtcRequestType, FromBtcTrustedRequestType,
-    ISwapPrice, MultichainData, RequestData, SpvVaultPostQuote, SpvVaultSwap, SpvVaultSwapRequestType,
-    SwapHandler, SwapHandlerType,
-    ToBtcLnRequestType,
-    ToBtcRequestType
-} from "..";
-import {SwapHandlerSwap} from "../swaps/SwapHandlerSwap";
-import {Command} from "@atomiqlabs/server-base";
-import {FromBtcLnTrustedRequestType} from "../swaps/trusted/frombtcln_trusted/FromBtcLnTrusted";
-import {IBitcoinWallet} from "../wallets/IBitcoinWallet";
-import {ILightningWallet} from "../wallets/ILightningWallet";
-import {SpvVault} from "../swaps/spv_vault_swap/SpvVault";
-
-export type QuoteThrow = {
-    type: "throw",
-    message: string
-}
-
-export function isQuoteThrow(obj: any): obj is QuoteThrow {
-    return obj.type==="throw" && typeof(obj.message)==="string";
-}
-
-export type QuoteSetFees = {
-    type: "fees"
-    baseFee?: bigint,
-    feePPM?: bigint,
-    securityDepositApyPPM?: bigint,
-    securityDepositBaseMultiplierPPM?: bigint
-};
-
-export function isQuoteSetFees(obj: any): obj is QuoteSetFees {
-    return obj.type==="fees" &&
-        (obj.baseFee==null || typeof(obj.baseFee) === "bigint") &&
-        (obj.feePPM==null || typeof(obj.feePPM) === "bigint") &&
-        (obj.securityDepositApyPPM==null || typeof(obj.securityDepositApyPPM) === "bigint") &&
-        (obj.securityDepositBaseMultiplierPPM==null || typeof(obj.securityDepositBaseMultiplierPPM) === "bigint");
-}
-
-export type QuoteAmountTooLow = {
-    type: "low",
-    data: { min: bigint, max: bigint }
-}
-
-export function isQuoteAmountTooLow(obj: any): obj is QuoteAmountTooLow {
-    return obj.type==="low" && typeof(obj.data)==="object" && typeof(obj.data.min)==="bigint" && typeof(obj.data.max)==="bigint";
-}
-
-export type QuoteAmountTooHigh = {
-    type: "high",
-    data: { min: bigint, max: bigint }
-}
-
-export function isQuoteAmountTooHigh(obj: any): obj is QuoteAmountTooHigh {
-    return obj.type==="high" && typeof(obj.data)==="object" && typeof(obj.data.min)==="bigint" && typeof(obj.data.max)==="bigint";
-}
-
-export type PluginQuote = {
-    type: "success",
-    amount: {input: boolean, amount: bigint},
-    swapFee: { inInputTokens: bigint, inOutputTokens: bigint }
-};
-
-export function isPluginQuote(obj: any): obj is PluginQuote {
-    return obj.type==="success" &&
-        typeof(obj.amount)==="object" && typeof(obj.amount.input)==="boolean" && typeof(obj.amount.amount)==="bigint" &&
-        typeof(obj.swapFee)==="object" && typeof(obj.swapFee.inInputTokens)==="bigint" && typeof(obj.swapFee.inOutputTokens)==="bigint";
-}
-
-export type ToBtcPluginQuote = PluginQuote & {
-    networkFee: { inInputTokens: bigint, inOutputTokens: bigint }
-}
-
-export function isToBtcPluginQuote(obj: any): obj is ToBtcPluginQuote {
-    return typeof(obj.networkFee)==="object" && typeof(obj.networkFee.inInputTokens)==="bigint" && typeof(obj.networkFee.inOutputTokens)==="bigint" &&
-        isPluginQuote(obj);
-}
-
-export interface IPlugin {
-
-    name: string;
-    author: string;
-    description: string;
-
-    //Needs to be called by implementation
-    onEnable(
-        chainsData: MultichainData,
-
-        bitcoinRpc: BitcoinRpc<any>,
-        bitcoinWallet: IBitcoinWallet,
-        lightningWallet: ILightningWallet,
-
-        swapPricing: ISwapPrice,
-        tokens: {
-            [ticker: string]: {
-                [chainId: string]: {
-                    address: string,
-                    decimals: number
-                }
-            }
-        },
-
-        directory: string
-    ): Promise<void>;
-    onDisable(): Promise<void>;
-
-    //Called in the library
-    onServiceInitialize(service: SwapHandler<any>): Promise<void>;
-
-    onHttpServerStarted?(expressServer: any): Promise<void>;
-
-    onSwapStateChange?(swap: SwapHandlerSwap): Promise<void>;
-    onSwapCreate?(swap: SwapHandlerSwap): Promise<void>;
-    onSwapRemove?(swap: SwapHandlerSwap): Promise<void>;
-
-    onHandlePreFromBtcQuote?(
-        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},
-        chainIdentifier: string,
-        constraints: {minInBtc: bigint, maxInBtc: bigint},
-        fees: {baseFeeInBtc: bigint, feePPM: bigint},
-        gasTokenAmount?: {input: false, amount: bigint, token: string}
-    ): Promise<QuoteThrow | QuoteSetFees | QuoteAmountTooLow | QuoteAmountTooHigh>;
-    onHandlePostFromBtcQuote?(
-        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>},
-        chainIdentifier: string,
-        constraints: {minInBtc: bigint, maxInBtc: bigint},
-        fees: {baseFeeInBtc: bigint, feePPM: bigint},
-        gasTokenAmount?: {input: false, amount: bigint, token: string, pricePrefetch?: Promise<bigint>}
-    ): Promise<QuoteThrow | QuoteSetFees | QuoteAmountTooLow | QuoteAmountTooHigh | PluginQuote>;
-
-    onHandlePreToBtcQuote?(
-        swapType: SwapHandlerType.TO_BTCLN | SwapHandlerType.TO_BTC,
-        request: RequestData<ToBtcLnRequestType | ToBtcRequestType>,
-        requestedAmount: {input: boolean, amount: bigint, token: string},
-        chainIdentifier: string,
-        constraints: {minInBtc: bigint, maxInBtc: bigint},
-        fees: {baseFeeInBtc: bigint, feePPM: bigint}
-    ): Promise<QuoteThrow | QuoteSetFees | QuoteAmountTooLow | QuoteAmountTooHigh>;
-    onHandlePostToBtcQuote?(
-        swapType: SwapHandlerType.TO_BTCLN | SwapHandlerType.TO_BTC,
-        request: RequestData<ToBtcLnRequestType | ToBtcRequestType>,
-        requestedAmount: {input: boolean, amount: bigint, token: string, pricePrefetch?: Promise<bigint>},
-        chainIdentifier: string,
-        constraints: {minInBtc: bigint, maxInBtc: bigint},
-        fees: {baseFeeInBtc: bigint, feePPM: bigint, networkFeeGetter: (amount: bigint) => Promise<bigint>}
-    ): Promise<QuoteThrow | QuoteSetFees | QuoteAmountTooLow | QuoteAmountTooHigh | ToBtcPluginQuote>;
-
-    onHandlePostedFromBtcQuote?(
-        swapType: SwapHandlerType.FROM_BTC_SPV,
-        request: RequestData<SpvVaultPostQuote>,
-        swap: SpvVaultSwap
-    ): Promise<QuoteThrow | null>;
-
-    onVaultSelection?(
-        chainIdentifier: string,
-        totalSats: bigint,
-        requestedAmount: {amount: bigint, token: string},
-        gasAmount: {amount: bigint, token: string}
-    ): Promise<SpvVault | QuoteThrow | QuoteAmountTooHigh | QuoteAmountTooLow | null>;
-
-    /**
-     * Returns whitelisted bitcoin txIds that are OK to spend even with 0-confs
-     */
-    getWhitelistedTxIds?(): string[];
-
-    getCommands?(): Command<any>[];
-
-}
+import {BitcoinRpc} from "@atomiqlabs/base";
+import {
+    FromBtcLnRequestType,
+    FromBtcRequestType, FromBtcTrustedRequestType,
+    ISwapPrice, MultichainData, RequestData, SpvVaultPostQuote, SpvVaultSwap, SpvVaultSwapRequestType,
+    SwapHandler, SwapHandlerType,
+    ToBtcLnRequestType,
+    ToBtcRequestType
+} from "..";
+import {SwapHandlerSwap} from "../swaps/SwapHandlerSwap";
+import {Command} from "@atomiqlabs/server-base";
+import {FromBtcLnTrustedRequestType} from "../swaps/trusted/frombtcln_trusted/FromBtcLnTrusted";
+import {IBitcoinWallet} from "../wallets/IBitcoinWallet";
+import {ILightningWallet} from "../wallets/ILightningWallet";
+import {SpvVault} from "../swaps/spv_vault_swap/SpvVault";
+
+export type QuoteThrow = {
+    type: "throw",
+    message: string
+}
+
+export function isQuoteThrow(obj: any): obj is QuoteThrow {
+    return obj.type==="throw" && typeof(obj.message)==="string";
+}
+
+export type QuoteSetFees = {
+    type: "fees"
+    baseFee?: bigint,
+    feePPM?: bigint,
+    securityDepositApyPPM?: bigint,
+    securityDepositBaseMultiplierPPM?: bigint
+};
+
+export function isQuoteSetFees(obj: any): obj is QuoteSetFees {
+    return obj.type==="fees" &&
+        (obj.baseFee==null || typeof(obj.baseFee) === "bigint") &&
+        (obj.feePPM==null || typeof(obj.feePPM) === "bigint") &&
+        (obj.securityDepositApyPPM==null || typeof(obj.securityDepositApyPPM) === "bigint") &&
+        (obj.securityDepositBaseMultiplierPPM==null || typeof(obj.securityDepositBaseMultiplierPPM) === "bigint");
+}
+
+export type QuoteAmountTooLow = {
+    type: "low",
+    data: { min: bigint, max: bigint }
+}
+
+export function isQuoteAmountTooLow(obj: any): obj is QuoteAmountTooLow {
+    return obj.type==="low" && typeof(obj.data)==="object" && typeof(obj.data.min)==="bigint" && typeof(obj.data.max)==="bigint";
+}
+
+export type QuoteAmountTooHigh = {
+    type: "high",
+    data: { min: bigint, max: bigint }
+}
+
+export function isQuoteAmountTooHigh(obj: any): obj is QuoteAmountTooHigh {
+    return obj.type==="high" && typeof(obj.data)==="object" && typeof(obj.data.min)==="bigint" && typeof(obj.data.max)==="bigint";
+}
+
+export type PluginQuote = {
+    type: "success",
+    amount: {input: boolean, amount: bigint},
+    swapFee: { inInputTokens: bigint, inOutputTokens: bigint }
+};
+
+export function isPluginQuote(obj: any): obj is PluginQuote {
+    return obj.type==="success" &&
+        typeof(obj.amount)==="object" && typeof(obj.amount.input)==="boolean" && typeof(obj.amount.amount)==="bigint" &&
+        typeof(obj.swapFee)==="object" && typeof(obj.swapFee.inInputTokens)==="bigint" && typeof(obj.swapFee.inOutputTokens)==="bigint";
+}
+
+export type ToBtcPluginQuote = PluginQuote & {
+    networkFee: { inInputTokens: bigint, inOutputTokens: bigint }
+}
+
+export function isToBtcPluginQuote(obj: any): obj is ToBtcPluginQuote {
+    return typeof(obj.networkFee)==="object" && typeof(obj.networkFee.inInputTokens)==="bigint" && typeof(obj.networkFee.inOutputTokens)==="bigint" &&
+        isPluginQuote(obj);
+}
+
+export interface IPlugin {
+
+    name: string;
+    author: string;
+    description: string;
+
+    //Needs to be called by implementation
+    onEnable(
+        chainsData: MultichainData,
+
+        bitcoinRpc: BitcoinRpc<any>,
+        bitcoinWallet: IBitcoinWallet,
+        lightningWallet: ILightningWallet,
+
+        swapPricing: ISwapPrice,
+        tokens: {
+            [ticker: string]: {
+                [chainId: string]: {
+                    address: string,
+                    decimals: number
+                }
+            }
+        },
+
+        directory: string
+    ): Promise<void>;
+    onDisable(): Promise<void>;
+
+    //Called in the library
+    onServiceInitialize(service: SwapHandler<any>): Promise<void>;
+
+    onHttpServerStarted?(expressServer: any): Promise<void>;
+
+    onSwapStateChange?(swap: SwapHandlerSwap): Promise<void>;
+    onSwapCreate?(swap: SwapHandlerSwap): Promise<void>;
+    onSwapRemove?(swap: SwapHandlerSwap): Promise<void>;
+
+    onHandlePreFromBtcQuote?(
+        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},
+        chainIdentifier: string,
+        constraints: {minInBtc: bigint, maxInBtc: bigint},
+        fees: {baseFeeInBtc: bigint, feePPM: bigint},
+        gasTokenAmount?: {input: false, amount: bigint, token: string}
+    ): Promise<QuoteThrow | QuoteSetFees | QuoteAmountTooLow | QuoteAmountTooHigh>;
+    onHandlePostFromBtcQuote?(
+        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>},
+        chainIdentifier: string,
+        constraints: {minInBtc: bigint, maxInBtc: bigint},
+        fees: {baseFeeInBtc: bigint, feePPM: bigint},
+        gasTokenAmount?: {input: false, amount: bigint, token: string, pricePrefetch?: Promise<bigint>}
+    ): Promise<QuoteThrow | QuoteSetFees | QuoteAmountTooLow | QuoteAmountTooHigh | PluginQuote>;
+
+    onHandlePreToBtcQuote?(
+        swapType: SwapHandlerType.TO_BTCLN | SwapHandlerType.TO_BTC,
+        request: RequestData<ToBtcLnRequestType | ToBtcRequestType>,
+        requestedAmount: {input: boolean, amount: bigint, token: string},
+        chainIdentifier: string,
+        constraints: {minInBtc: bigint, maxInBtc: bigint},
+        fees: {baseFeeInBtc: bigint, feePPM: bigint}
+    ): Promise<QuoteThrow | QuoteSetFees | QuoteAmountTooLow | QuoteAmountTooHigh>;
+    onHandlePostToBtcQuote?(
+        swapType: SwapHandlerType.TO_BTCLN | SwapHandlerType.TO_BTC,
+        request: RequestData<ToBtcLnRequestType | ToBtcRequestType>,
+        requestedAmount: {input: boolean, amount: bigint, token: string, pricePrefetch?: Promise<bigint>},
+        chainIdentifier: string,
+        constraints: {minInBtc: bigint, maxInBtc: bigint},
+        fees: {baseFeeInBtc: bigint, feePPM: bigint, networkFeeGetter: (amount: bigint) => Promise<bigint>}
+    ): Promise<QuoteThrow | QuoteSetFees | QuoteAmountTooLow | QuoteAmountTooHigh | ToBtcPluginQuote>;
+
+    onHandlePostedFromBtcQuote?(
+        swapType: SwapHandlerType.FROM_BTC_SPV,
+        request: RequestData<SpvVaultPostQuote>,
+        swap: SpvVaultSwap
+    ): Promise<QuoteThrow | null>;
+
+    onVaultSelection?(
+        chainIdentifier: string,
+        totalSats: bigint,
+        requestedAmount: {amount: bigint, token: string},
+        gasAmount: {amount: bigint, token: string}
+    ): Promise<SpvVault | QuoteThrow | QuoteAmountTooHigh | QuoteAmountTooLow | null>;
+
+    /**
+     * Returns whitelisted bitcoin txIds that are OK to spend even with 0-confs
+     */
+    getWhitelistedTxIds?(): string[];
+
+    getCommands?(): Command<any>[];
+
+}