@atomiqlabs/lp-lib 14.0.0-dev.3 → 14.0.0-dev.30

package/dist/swaps/escrow/frombtcln_autoinit/FromBtcLnAutoSwap.d.ts

@@ -0,0 +1,55 @@
+import { SwapData } from "@atomiqlabs/base";
+import { FromBtcBaseSwap } from "../FromBtcBaseSwap";
+export declare enum FromBtcLnAutoSwapState {
+    REFUNDED = -2,
+    CANCELED = -1,
+    CREATED = 0,
+    RECEIVED = 1,
+    TXS_SENT = 2,
+    COMMITED = 3,
+    CLAIMED = 4,
+    SETTLED = 5
+}
+export declare class FromBtcLnAutoSwap<T extends SwapData = SwapData> extends FromBtcBaseSwap<T, FromBtcLnAutoSwapState> {
+    readonly pr: string;
+    readonly lnPaymentHash: string;
+    readonly claimHash: string;
+    readonly claimer: string;
+    readonly token: string;
+    readonly gasToken: string;
+    readonly amountToken: bigint;
+    readonly amountGasToken: bigint;
+    readonly tokenSwapFee: bigint;
+    readonly tokenSwapFeeInToken: bigint;
+    readonly gasSwapFee: bigint;
+    readonly gasSwapFeeInToken: bigint;
+    readonly claimerBounty: bigint;
+    secret: string;
+    constructor(chainIdentifier: string, pr: string, lnPaymentHash: string, claimHash: string, amountMtokens: bigint, claimer: string, token: string, gasToken: string, amountToken: bigint, amountGasToken: bigint, tokenSwapFee: bigint, tokenSwapFeeInToken: bigint, gasSwapFee: bigint, gasSwapFeeInToken: bigint, claimerBounty: bigint);
+    constructor(obj: any);
+    serialize(): any;
+    getClaimHash(): string;
+    getIdentifierHash(): string;
+    getOutputGasAmount(): bigint;
+    getOutputAmount(): bigint;
+    getTotalOutputAmount(): bigint;
+    getTotalOutputGasAmount(): bigint;
+    getSequence(): bigint;
+    getSwapFee(): {
+        inInputToken: bigint;
+        inOutputToken: bigint;
+    };
+    getTokenSwapFee(): {
+        inInputToken: bigint;
+        inOutputToken: bigint;
+    };
+    getGasSwapFee(): {
+        inInputToken: bigint;
+        inOutputToken: bigint;
+    };
+    getToken(): string;
+    getGasToken(): string;
+    isInitiated(): boolean;
+    isFailed(): boolean;
+    isSuccess(): boolean;
+}

package/dist/swaps/escrow/frombtcln_autoinit/FromBtcLnAutoSwap.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FromBtcLnAutoSwap = exports.FromBtcLnAutoSwapState = void 0;
+const index_1 = require("../../../index");
+const FromBtcBaseSwap_1 = require("../FromBtcBaseSwap");
+const Utils_1 = require("../../../utils/Utils");
+var FromBtcLnAutoSwapState;
+(function (FromBtcLnAutoSwapState) {
+    FromBtcLnAutoSwapState[FromBtcLnAutoSwapState["REFUNDED"] = -2] = "REFUNDED";
+    FromBtcLnAutoSwapState[FromBtcLnAutoSwapState["CANCELED"] = -1] = "CANCELED";
+    FromBtcLnAutoSwapState[FromBtcLnAutoSwapState["CREATED"] = 0] = "CREATED";
+    FromBtcLnAutoSwapState[FromBtcLnAutoSwapState["RECEIVED"] = 1] = "RECEIVED";
+    FromBtcLnAutoSwapState[FromBtcLnAutoSwapState["TXS_SENT"] = 2] = "TXS_SENT";
+    FromBtcLnAutoSwapState[FromBtcLnAutoSwapState["COMMITED"] = 3] = "COMMITED";
+    FromBtcLnAutoSwapState[FromBtcLnAutoSwapState["CLAIMED"] = 4] = "CLAIMED";
+    FromBtcLnAutoSwapState[FromBtcLnAutoSwapState["SETTLED"] = 5] = "SETTLED";
+})(FromBtcLnAutoSwapState = exports.FromBtcLnAutoSwapState || (exports.FromBtcLnAutoSwapState = {}));
+class FromBtcLnAutoSwap extends FromBtcBaseSwap_1.FromBtcBaseSwap {
+    constructor(chainIdOrObj, pr, lnPaymentHash, claimHash, amountMtokens, claimer, token, gasToken, amountToken, amountGasToken, tokenSwapFee, tokenSwapFeeInToken, gasSwapFee, gasSwapFeeInToken, claimerBounty) {
+        if (typeof (chainIdOrObj) === "string") {
+            super(chainIdOrObj, (amountMtokens + 999n) / 1000n, tokenSwapFee + gasSwapFee, tokenSwapFeeInToken);
+            this.state = FromBtcLnAutoSwapState.CREATED;
+            this.pr = pr;
+            this.lnPaymentHash = lnPaymentHash;
+            this.claimHash = claimHash;
+            this.claimer = claimer;
+            this.token = token;
+            this.gasToken = gasToken;
+            this.amountToken = amountToken;
+            this.amountGasToken = amountGasToken;
+            this.tokenSwapFee = tokenSwapFee;
+            this.tokenSwapFeeInToken = tokenSwapFeeInToken;
+            this.gasSwapFee = gasSwapFee;
+            this.gasSwapFeeInToken = gasSwapFeeInToken;
+            this.claimerBounty = claimerBounty;
+        }
+        else {
+            super(chainIdOrObj);
+            this.pr = chainIdOrObj.pr;
+            this.lnPaymentHash = chainIdOrObj.lnPaymentHash;
+            this.claimHash = chainIdOrObj.claimHash;
+            this.claimer = chainIdOrObj.claimer;
+            this.token = chainIdOrObj.token;
+            this.gasToken = chainIdOrObj.gasToken;
+            this.amountToken = (0, Utils_1.deserializeBN)(chainIdOrObj.amountToken);
+            this.amountGasToken = (0, Utils_1.deserializeBN)(chainIdOrObj.amountGasToken);
+            this.tokenSwapFee = (0, Utils_1.deserializeBN)(chainIdOrObj.tokenSwapFee);
+            this.tokenSwapFeeInToken = (0, Utils_1.deserializeBN)(chainIdOrObj.tokenSwapFeeInToken);
+            this.gasSwapFee = (0, Utils_1.deserializeBN)(chainIdOrObj.gasSwapFee);
+            this.gasSwapFeeInToken = (0, Utils_1.deserializeBN)(chainIdOrObj.gasSwapFeeInToken);
+            this.claimerBounty = (0, Utils_1.deserializeBN)(chainIdOrObj.claimerBounty);
+            this.secret = chainIdOrObj.secret;
+        }
+        this.type = index_1.SwapHandlerType.FROM_BTCLN_AUTO;
+    }
+    serialize() {
+        const partialSerialized = super.serialize();
+        partialSerialized.pr = this.pr;
+        partialSerialized.secret = this.secret;
+        partialSerialized.lnPaymentHash = this.lnPaymentHash;
+        partialSerialized.claimHash = this.claimHash;
+        partialSerialized.claimer = this.claimer;
+        partialSerialized.token = this.token;
+        partialSerialized.gasToken = this.gasToken;
+        partialSerialized.amountToken = (0, Utils_1.serializeBN)(this.amountToken);
+        partialSerialized.amountGasToken = (0, Utils_1.serializeBN)(this.amountGasToken);
+        partialSerialized.tokenSwapFee = (0, Utils_1.serializeBN)(this.tokenSwapFee);
+        partialSerialized.tokenSwapFeeInToken = (0, Utils_1.serializeBN)(this.tokenSwapFeeInToken);
+        partialSerialized.gasSwapFee = (0, Utils_1.serializeBN)(this.gasSwapFee);
+        partialSerialized.gasSwapFeeInToken = (0, Utils_1.serializeBN)(this.gasSwapFeeInToken);
+        partialSerialized.claimerBounty = (0, Utils_1.serializeBN)(this.claimerBounty);
+        return partialSerialized;
+    }
+    getClaimHash() {
+        return this.claimHash;
+    }
+    getIdentifierHash() {
+        return this.lnPaymentHash;
+    }
+    getOutputGasAmount() {
+        return this.amountGasToken;
+    }
+    getOutputAmount() {
+        return this.amountToken;
+    }
+    getTotalOutputAmount() {
+        return this.amountToken;
+    }
+    getTotalOutputGasAmount() {
+        return this.amountGasToken + this.claimerBounty;
+    }
+    getSequence() {
+        return 0n;
+    }
+    getSwapFee() {
+        return { inInputToken: this.swapFee, inOutputToken: this.swapFeeInToken };
+    }
+    getTokenSwapFee() {
+        return { inInputToken: this.tokenSwapFee, inOutputToken: this.tokenSwapFeeInToken };
+    }
+    getGasSwapFee() {
+        return { inInputToken: this.gasSwapFee, inOutputToken: this.gasSwapFeeInToken };
+    }
+    getToken() {
+        return this.token;
+    }
+    getGasToken() {
+        return this.gasToken;
+    }
+    isInitiated() {
+        return this.state !== FromBtcLnAutoSwapState.CREATED;
+    }
+    isFailed() {
+        return this.state === FromBtcLnAutoSwapState.CANCELED || this.state === FromBtcLnAutoSwapState.REFUNDED;
+    }
+    isSuccess() {
+        return this.state === FromBtcLnAutoSwapState.SETTLED;
+    }
+}
+exports.FromBtcLnAutoSwap = FromBtcLnAutoSwap;

package/dist/swaps/escrow/tobtc_abstract/ToBtcAbs.d.ts

@@ -1,171 +1,171 @@
-import { Express } from "express";
-import { ToBtcSwapAbs, ToBtcSwapState } from "./ToBtcSwapAbs";
-import { MultichainData, SwapHandlerType } from "../../SwapHandler";
-import { ISwapPrice } from "../../../prices/ISwapPrice";
-import { BtcTx, ChainSwapType, ClaimEvent, InitializeEvent, RefundEvent, SwapData, BitcoinRpc, BtcBlock } from "@atomiqlabs/base";
-import { IIntermediaryStorage } from "../../../storage/IIntermediaryStorage";
-import { ToBtcBaseConfig, ToBtcBaseSwapHandler } from "../ToBtcBaseSwapHandler";
-import { PromiseQueue } from "promise-queue-ts";
-import { IBitcoinWallet } from "../../../wallets/IBitcoinWallet";
-export type ToBtcConfig = ToBtcBaseConfig & {
-    sendSafetyFactor: bigint;
-    minChainCltv: bigint;
-    networkFeeMultiplier: number;
-    minConfirmations: number;
-    maxConfirmations: number;
-    maxConfTarget: number;
-    minConfTarget: number;
-    txCheckInterval: number;
-};
-export type ToBtcRequestType = {
-    address: string;
-    amount: bigint;
-    confirmationTarget: number;
-    confirmations: number;
-    nonce: bigint;
-    token: string;
-    offerer: string;
-    exactIn?: boolean;
-};
-/**
- * Handler for to BTC swaps, utilizing PTLCs (proof-time locked contracts) using btc relay (on-chain bitcoin SPV)
- */
-export declare class ToBtcAbs extends ToBtcBaseSwapHandler<ToBtcSwapAbs, ToBtcSwapState> {
-    readonly type = SwapHandlerType.TO_BTC;
-    readonly swapType = ChainSwapType.CHAIN_NONCED;
-    activeSubscriptions: {
-        [txId: string]: ToBtcSwapAbs;
-    };
-    bitcoinRpc: BitcoinRpc<BtcBlock>;
-    bitcoin: IBitcoinWallet;
-    sendBtcQueue: PromiseQueue;
-    readonly config: ToBtcConfig;
-    constructor(storageDirectory: IIntermediaryStorage<ToBtcSwapAbs>, path: string, chainData: MultichainData, bitcoin: IBitcoinWallet, swapPricing: ISwapPrice, bitcoinRpc: BitcoinRpc<BtcBlock>, config: ToBtcConfig);
-    /**
-     * Returns the payment hash of the swap, takes swap nonce into account. Payment hash is chain-specific.
-     *
-     * @param chainIdentifier
-     * @param address
-     * @param confirmations
-     * @param nonce
-     * @param amount
-     */
-    private getHash;
-    /**
-     * Tries to claim the swap after our transaction was confirmed
-     *
-     * @param tx
-     * @param swap
-     * @param vout
-     */
-    private tryClaimSwap;
-    protected processPastSwap(swap: ToBtcSwapAbs): Promise<void>;
-    /**
-     * Checks past swaps, deletes ones that are already expired.
-     */
-    protected processPastSwaps(): Promise<void>;
-    protected processBtcTx(swap: ToBtcSwapAbs, tx: BtcTx): Promise<boolean>;
-    /**
-     * Checks active sent out bitcoin transactions
-     */
-    private processBtcTxs;
-    /**
-     * Subscribes to and periodically checks txId used to send out funds for the swap for enough confirmations
-     *
-     * @param payment
-     */
-    protected subscribeToPayment(payment: ToBtcSwapAbs): void;
-    protected unsubscribePayment(payment: ToBtcSwapAbs): void;
-    /**
-     * Checks if expiry time on the swap leaves us enough room to send a transaction and for the transaction to confirm
-     *
-     * @param swap
-     * @private
-     * @throws DefinedRuntimeError will throw an error in case there isn't enough time for us to send a BTC payout tx
-     */
-    protected checkExpiresTooSoon(swap: ToBtcSwapAbs): void;
-    /**
-     * Checks if the actual fee for the swap is no higher than the quoted estimate
-     *
-     * @param quotedSatsPerVbyte
-     * @param actualSatsPerVbyte
-     * @private
-     * @throws DefinedRuntimeError will throw an error in case the actual fee is higher than quoted fee
-     */
-    protected checkCalculatedTxFee(quotedSatsPerVbyte: bigint, actualSatsPerVbyte: bigint): void;
-    /**
-     * Sends a bitcoin transaction to payout BTC for a swap
-     *
-     * @param swap
-     * @private
-     * @throws DefinedRuntimeError will throw an error in case the payment cannot be initiated
-     */
-    private sendBitcoinPayment;
-    /**
-     * Called after swap was successfully committed, will check if bitcoin tx is already sent, if not tries to send it and subscribes to it
-     *
-     * @param swap
-     */
-    private processInitialized;
-    protected processInitializeEvent(chainIdentifier: string, swap: ToBtcSwapAbs, event: InitializeEvent<SwapData>): Promise<void>;
-    protected processClaimEvent(chainIdentifier: string, swap: ToBtcSwapAbs, event: ClaimEvent<SwapData>): Promise<void>;
-    protected processRefundEvent(chainIdentifier: string, swap: ToBtcSwapAbs, event: RefundEvent<SwapData>): Promise<void>;
-    /**
-     * Returns required expiry delta for swap params
-     *
-     * @param confirmationTarget
-     * @param confirmations
-     */
-    protected getExpiryFromCLTV(confirmationTarget: number, confirmations: number): bigint;
-    /**
-     * Checks if the requested nonce is valid
-     *
-     * @param nonce
-     * @throws {DefinedRuntimeError} will throw an error if the nonce is invalid
-     */
-    private checkNonceValid;
-    /**
-     * Checks if confirmation target is within configured bounds
-     *
-     * @param confirmationTarget
-     * @throws {DefinedRuntimeError} will throw an error if the confirmationTarget is out of bounds
-     */
-    protected checkConfirmationTarget(confirmationTarget: number): void;
-    /**
-     * Checks if the required confirmations are within configured bounds
-     *
-     * @param confirmations
-     * @throws {DefinedRuntimeError} will throw an error if the confirmations are out of bounds
-     */
-    protected checkRequiredConfirmations(confirmations: number): void;
-    /**
-     * Checks the validity of the provided address, also checks if the resulting output script isn't too large
-     *
-     * @param address
-     * @throws {DefinedRuntimeError} will throw an error if the address is invalid
-     */
-    protected checkAddress(address: string): void;
-    /**
-     * Checks if the swap is expired, taking into consideration on-chain time skew
-     *
-     * @param swap
-     * @throws {DefinedRuntimeError} will throw an error if the swap is expired
-     */
-    protected checkExpired(swap: ToBtcSwapAbs): Promise<void>;
-    /**
-     * Checks & returns the network fee needed for a transaction
-     *
-     * @param address
-     * @param amount
-     * @throws {DefinedRuntimeError} will throw an error if there are not enough BTC funds
-     */
-    private checkAndGetNetworkFee;
-    startRestServer(restServer: Express): void;
-    /**
-     * Starts watchdog checking sent bitcoin transactions
-     */
-    protected startTxTimer(): Promise<void>;
-    startWatchdog(): Promise<void>;
-    init(): Promise<void>;
-    getInfoData(): any;
-}
+import { Express } from "express";
+import { ToBtcSwapAbs, ToBtcSwapState } from "./ToBtcSwapAbs";
+import { MultichainData, SwapHandlerType } from "../../SwapHandler";
+import { ISwapPrice } from "../../../prices/ISwapPrice";
+import { BtcTx, ChainSwapType, ClaimEvent, InitializeEvent, RefundEvent, SwapData, BitcoinRpc, BtcBlock } from "@atomiqlabs/base";
+import { IIntermediaryStorage } from "../../../storage/IIntermediaryStorage";
+import { ToBtcBaseConfig, ToBtcBaseSwapHandler } from "../ToBtcBaseSwapHandler";
+import { PromiseQueue } from "promise-queue-ts";
+import { IBitcoinWallet } from "../../../wallets/IBitcoinWallet";
+export type ToBtcConfig = ToBtcBaseConfig & {
+    sendSafetyFactor: bigint;
+    minChainCltv: bigint;
+    networkFeeMultiplier: number;
+    minConfirmations: number;
+    maxConfirmations: number;
+    maxConfTarget: number;
+    minConfTarget: number;
+    txCheckInterval: number;
+};
+export type ToBtcRequestType = {
+    address: string;
+    amount: bigint;
+    confirmationTarget: number;
+    confirmations: number;
+    nonce: bigint;
+    token: string;
+    offerer: string;
+    exactIn?: boolean;
+};
+/**
+ * Handler for to BTC swaps, utilizing PTLCs (proof-time locked contracts) using btc relay (on-chain bitcoin SPV)
+ */
+export declare class ToBtcAbs extends ToBtcBaseSwapHandler<ToBtcSwapAbs, ToBtcSwapState> {
+    readonly type = SwapHandlerType.TO_BTC;
+    readonly swapType = ChainSwapType.CHAIN_NONCED;
+    activeSubscriptions: {
+        [txId: string]: ToBtcSwapAbs;
+    };
+    bitcoinRpc: BitcoinRpc<BtcBlock>;
+    bitcoin: IBitcoinWallet;
+    sendBtcQueue: PromiseQueue;
+    readonly config: ToBtcConfig;
+    constructor(storageDirectory: IIntermediaryStorage<ToBtcSwapAbs>, path: string, chainData: MultichainData, bitcoin: IBitcoinWallet, swapPricing: ISwapPrice, bitcoinRpc: BitcoinRpc<BtcBlock>, config: ToBtcConfig);
+    /**
+     * Returns the payment hash of the swap, takes swap nonce into account. Payment hash is chain-specific.
+     *
+     * @param chainIdentifier
+     * @param address
+     * @param confirmations
+     * @param nonce
+     * @param amount
+     */
+    private getHash;
+    /**
+     * Tries to claim the swap after our transaction was confirmed
+     *
+     * @param tx
+     * @param swap
+     * @param vout
+     */
+    private tryClaimSwap;
+    protected processPastSwap(swap: ToBtcSwapAbs): Promise<void>;
+    /**
+     * Checks past swaps, deletes ones that are already expired.
+     */
+    protected processPastSwaps(): Promise<void>;
+    protected processBtcTx(swap: ToBtcSwapAbs, tx: BtcTx): Promise<boolean>;
+    /**
+     * Checks active sent out bitcoin transactions
+     */
+    private processBtcTxs;
+    /**
+     * Subscribes to and periodically checks txId used to send out funds for the swap for enough confirmations
+     *
+     * @param payment
+     */
+    protected subscribeToPayment(payment: ToBtcSwapAbs): void;
+    protected unsubscribePayment(payment: ToBtcSwapAbs): void;
+    /**
+     * Checks if expiry time on the swap leaves us enough room to send a transaction and for the transaction to confirm
+     *
+     * @param swap
+     * @private
+     * @throws DefinedRuntimeError will throw an error in case there isn't enough time for us to send a BTC payout tx
+     */
+    protected checkExpiresTooSoon(swap: ToBtcSwapAbs): void;
+    /**
+     * Checks if the actual fee for the swap is no higher than the quoted estimate
+     *
+     * @param quotedSatsPerVbyte
+     * @param actualSatsPerVbyte
+     * @private
+     * @throws DefinedRuntimeError will throw an error in case the actual fee is higher than quoted fee
+     */
+    protected checkCalculatedTxFee(quotedSatsPerVbyte: bigint, actualSatsPerVbyte: bigint): void;
+    /**
+     * Sends a bitcoin transaction to payout BTC for a swap
+     *
+     * @param swap
+     * @private
+     * @throws DefinedRuntimeError will throw an error in case the payment cannot be initiated
+     */
+    private sendBitcoinPayment;
+    /**
+     * Called after swap was successfully committed, will check if bitcoin tx is already sent, if not tries to send it and subscribes to it
+     *
+     * @param swap
+     */
+    private processInitialized;
+    protected processInitializeEvent(chainIdentifier: string, swap: ToBtcSwapAbs, event: InitializeEvent<SwapData>): Promise<void>;
+    protected processClaimEvent(chainIdentifier: string, swap: ToBtcSwapAbs, event: ClaimEvent<SwapData>): Promise<void>;
+    protected processRefundEvent(chainIdentifier: string, swap: ToBtcSwapAbs, event: RefundEvent<SwapData>): Promise<void>;
+    /**
+     * Returns required expiry delta for swap params
+     *
+     * @param confirmationTarget
+     * @param confirmations
+     */
+    protected getExpiryFromCLTV(confirmationTarget: number, confirmations: number): bigint;
+    /**
+     * Checks if the requested nonce is valid
+     *
+     * @param nonce
+     * @throws {DefinedRuntimeError} will throw an error if the nonce is invalid
+     */
+    private checkNonceValid;
+    /**
+     * Checks if confirmation target is within configured bounds
+     *
+     * @param confirmationTarget
+     * @throws {DefinedRuntimeError} will throw an error if the confirmationTarget is out of bounds
+     */
+    protected checkConfirmationTarget(confirmationTarget: number): void;
+    /**
+     * Checks if the required confirmations are within configured bounds
+     *
+     * @param confirmations
+     * @throws {DefinedRuntimeError} will throw an error if the confirmations are out of bounds
+     */
+    protected checkRequiredConfirmations(confirmations: number): void;
+    /**
+     * Checks the validity of the provided address, also checks if the resulting output script isn't too large
+     *
+     * @param address
+     * @throws {DefinedRuntimeError} will throw an error if the address is invalid
+     */
+    protected checkAddress(address: string): void;
+    /**
+     * Checks if the swap is expired, taking into consideration on-chain time skew
+     *
+     * @param swap
+     * @throws {DefinedRuntimeError} will throw an error if the swap is expired
+     */
+    protected checkExpired(swap: ToBtcSwapAbs): Promise<void>;
+    /**
+     * Checks & returns the network fee needed for a transaction
+     *
+     * @param address
+     * @param amount
+     * @throws {DefinedRuntimeError} will throw an error if there are not enough BTC funds
+     */
+    private checkAndGetNetworkFee;
+    startRestServer(restServer: Express): void;
+    /**
+     * Starts watchdog checking sent bitcoin transactions
+     */
+    protected startTxTimer(): Promise<void>;
+    startWatchdog(): Promise<void>;
+    init(): Promise<void>;
+    getInfoData(): any;
+}