@atomiqlabs/lp-lib 15.0.14 → 16.0.0

package/dist/wallets/IBitcoinWallet.d.ts

@@ -1,67 +1,74 @@
-/// <reference types="node" />
-import { BtcTx } from "@atomiqlabs/base";
-import { Command } from "@atomiqlabs/server-base";
-import { Transaction } from "@scure/btc-signer";
-export type BitcoinUtxo = {
-    address: string;
-    type: "p2wpkh" | "p2sh-p2wpkh" | "p2tr";
-    confirmations: number;
-    outputScript: Buffer;
-    value: number;
-    txId: string;
-    vout: number;
-};
-export type SignPsbtResponse = {
-    psbt: Transaction;
-    tx: Transaction;
-    raw: string;
-    txId: string;
-    networkFee: number;
-};
-export interface IBitcoinWallet {
-    init(): Promise<void>;
-    isReady(): boolean;
-    getStatus(): string;
-    getStatusInfo(): Promise<Record<string, string>>;
-    getCommands(): Command<any>[];
-    toOutputScript(address: string): Buffer;
-    getAddressType(): "p2wpkh" | "p2sh-p2wpkh" | "p2tr";
-    /**
-     * Returns an unused address suitable for receiving
-     */
-    getAddress(): Promise<string>;
-    /**
-     * Adds previously returned address (with getAddress call), to the pool of unused addresses
-     * @param address
-     */
-    addUnusedAddress(address: string): Promise<void>;
-    getUtxos(): Promise<BitcoinUtxo[]>;
-    getBalance(): Promise<{
-        confirmed: number;
-        unconfirmed: number;
-    }>;
-    /**
-     * Returns required reserve amount that needs to be kept in the wallet (for e.g. lightning anchor channels)
-     */
-    getRequiredReserve(): Promise<number>;
-    getWalletTransactions(startHeight?: number): Promise<BtcTx[]>;
-    getWalletTransaction(txId: string): Promise<BtcTx | null>;
-    subscribeToWalletTransactions(callback: (tx: BtcTx) => void, abortSignal?: AbortSignal): void;
-    fundPsbt(psbt: Transaction, feeRate?: number): Promise<Transaction>;
-    signPsbt(psbt: Transaction): Promise<SignPsbtResponse>;
-    sendRawTransaction(tx: string): Promise<void>;
-    getSignedTransaction(destination: string, amount: number, feeRate?: number, nonce?: bigint, maxAllowedFeeRate?: number): Promise<SignPsbtResponse>;
-    getSignedMultiTransaction(destinations: {
-        address: string;
-        amount: number;
-    }[], feeRate?: number, nonce?: bigint, maxAllowedFeeRate?: number): Promise<SignPsbtResponse>;
-    estimateFee(destination: string, amount: number, feeRate?: number, feeRateMultiplier?: number): Promise<{
-        satsPerVbyte: number;
-        networkFee: number;
-    }>;
-    drainAll(destination: string | Buffer, inputs: Omit<BitcoinUtxo, "address">[], feeRate?: number): Promise<SignPsbtResponse>;
-    burnAll(inputs: Omit<BitcoinUtxo, "address">[]): Promise<SignPsbtResponse>;
-    parsePsbt(psbt: Transaction): Promise<BtcTx>;
-    getBlockheight(): Promise<number>;
-    getFeeRate(): Promise<number>;
-}
+/// <reference types="node" />
+import { BtcTx } from "@atomiqlabs/base";
+import { Command } from "@atomiqlabs/server-base";
+import { Transaction } from "@scure/btc-signer";
+export type BitcoinUtxo = {
+    address: string;
+    type: "p2wpkh" | "p2sh-p2wpkh" | "p2tr";
+    confirmations: number;
+    outputScript: Buffer;
+    value: number;
+    txId: string;
+    vout: number;
+};
+export type SignPsbtResponse = {
+    psbt: Transaction;
+    tx: Transaction;
+    raw: string;
+    txId: string;
+    networkFee: number;
+};
+export interface IBitcoinWallet {
+    init(): Promise<void>;
+    isReady(): boolean;
+    getStatus(): string;
+    getStatusInfo(): Promise<Record<string, string>>;
+    getCommands(): Command<any>[];
+    toOutputScript(address: string): Buffer;
+    getAddressType(): "p2wpkh" | "p2sh-p2wpkh" | "p2tr";
+    /**
+     * Returns an unused address suitable for receiving
+     */
+    getAddress(): Promise<string>;
+    /**
+     * Adds previously returned address (with getAddress call), to the pool of unused addresses
+     * @param address
+     */
+    addUnusedAddress(address: string): Promise<void>;
+    getUtxos(): Promise<BitcoinUtxo[]>;
+    getBalance(): Promise<{
+        confirmed: number;
+        unconfirmed: number;
+    }>;
+    /**
+     * Returns required reserve amount that needs to be kept in the wallet (for e.g. lightning anchor channels)
+     */
+    getRequiredReserve(): Promise<number>;
+    getWalletTransactions(startHeight?: number): Promise<BtcTx[]>;
+    getWalletTransaction(txId: string): Promise<BtcTx | null>;
+    subscribeToWalletTransactions(callback: (tx: BtcTx) => void, abortSignal?: AbortSignal): void;
+    fundPsbt(psbt: Transaction, feeRate?: number): Promise<Transaction>;
+    signPsbt(psbt: Transaction): Promise<SignPsbtResponse>;
+    sendRawTransaction(tx: string): Promise<void>;
+    getSignedTransaction(destination: string, amount: number, feeRate?: number, nonce?: bigint, maxAllowedFeeRate?: number): Promise<SignPsbtResponse>;
+    getSignedMultiTransaction(destinations: {
+        address: string;
+        amount: number;
+    }[], feeRate?: number, nonce?: bigint, maxAllowedFeeRate?: number): Promise<SignPsbtResponse>;
+    estimateFee(destination: string, amount: number, feeRate?: number, feeRateMultiplier?: number): Promise<{
+        satsPerVbyte: number;
+        networkFee: number;
+    }>;
+    drainAll(destination: string | Buffer, inputs: Omit<BitcoinUtxo, "address">[], feeRate?: number): Promise<SignPsbtResponse>;
+    burnAll(inputs: Omit<BitcoinUtxo, "address">[]): Promise<SignPsbtResponse>;
+    parsePsbt(psbt: Transaction): Promise<BtcTx>;
+    getBlockheight(): Promise<number>;
+    getFeeRate(): Promise<number>;
+    /**
+     * Post a task to be executed on the sequential thread of the wallet, this makes sure the UTXOs stay consistent during
+     *  operation, it is recommended to use this approach when spending wallet UTXOs
+     *
+     * @param executor
+     */
+    execute(executor: () => Promise<void>): Promise<void>;
+}

package/dist/wallets/IBitcoinWallet.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/wallets/ILightningWallet.d.ts

@@ -1,117 +1,117 @@
-import { Command } from "@atomiqlabs/server-base";
-export type IncomingLightningNetworkPayment = {
-    createdAt: number;
-    confirmedAt: number;
-    createdHeight: number;
-    timeout: number;
-    status: "held" | "canceled" | "confirmed";
-    mtokens: bigint;
-};
-export type LightningNetworkInvoice = {
-    id: string;
-    request: string;
-    secret?: string;
-    cltvDelta: number;
-    mtokens: bigint;
-    createdAt: number;
-    expiresAt: number;
-    description: string;
-    descriptionHash?: string;
-    payments: IncomingLightningNetworkPayment[];
-    status: "unpaid" | "held" | "canceled" | "confirmed";
-};
-export type OutgoingLightningNetworkPayment = {
-    failedReason?: "insufficient_balance" | "invalid_payment" | "pathfinding_timeout" | "route_not_found";
-    status: "confirmed" | "failed" | "pending";
-    secret?: string;
-    feeMtokens?: bigint;
-};
-export type LightningNetworkChannel = {
-    id: string;
-    capacity: bigint;
-    isActive: boolean;
-    localBalance: bigint;
-    localReserve: bigint;
-    remoteBalance: bigint;
-    remoteReserve: bigint;
-    unsettledBalance: bigint;
-    transactionId: string;
-    transactionVout: number;
-};
-export type InvoiceInit = {
-    mtokens: bigint;
-    descriptionHash?: string;
-    description?: string;
-    cltvDelta?: number;
-    expiresAt?: number;
-};
-export type HodlInvoiceInit = {
-    description: string;
-    cltvDelta: number;
-    expiresAt: number;
-    id: string;
-    mtokens: bigint;
-    descriptionHash?: string;
-};
-export type LNRoutes = {
-    publicKey: string;
-    feeRate?: number;
-    cltvDelta?: number;
-    channel?: string;
-    baseFeeMtokens?: bigint;
-}[][];
-export type ParsedPaymentRequest = {
-    id: string;
-    mtokens: bigint;
-    expiryEpochMillis: number;
-    destination: string;
-    cltvDelta: number;
-    description: string;
-    routes: LNRoutes;
-};
-export type LightningPaymentInit = {
-    request: string;
-    maxFeeMtokens?: bigint;
-    maxTimeoutHeight?: number;
-};
-export type LightningBalanceResponse = {
-    localBalance: bigint;
-    remoteBalance: bigint;
-    unsettledBalance: bigint;
-};
-export type ProbeAndRouteInit = {
-    request: string;
-    amountMtokens: bigint;
-    maxFeeMtokens: bigint;
-    maxTimeoutHeight: number;
-};
-export type ProbeAndRouteResponse = {
-    confidence: number;
-    feeMtokens: bigint;
-    destination: string;
-    privateRoutes: LNRoutes;
-};
-export declare function routesMatch(routesA: LNRoutes, routesB: LNRoutes): boolean;
-export interface ILightningWallet {
-    init(): Promise<void>;
-    isReady(): boolean;
-    getStatus(): string;
-    getStatusInfo(): Promise<Record<string, string>>;
-    getCommands(): Command<any>[];
-    createInvoice(init: InvoiceInit): Promise<LightningNetworkInvoice>;
-    createHodlInvoice(init: HodlInvoiceInit): Promise<LightningNetworkInvoice>;
-    getInvoice(paymentHash: string): Promise<LightningNetworkInvoice | null>;
-    cancelHodlInvoice(paymentHash: string): Promise<void>;
-    settleHodlInvoice(secret: string): Promise<void>;
-    waitForInvoice(paymentHash: string, abortSignal?: AbortSignal): Promise<LightningNetworkInvoice>;
-    pay(init: LightningPaymentInit): Promise<void>;
-    getPayment(paymentHash: string): Promise<OutgoingLightningNetworkPayment | null>;
-    waitForPayment(paymentHash: string, abortSignal?: AbortSignal): Promise<OutgoingLightningNetworkPayment>;
-    probe(init: ProbeAndRouteInit): Promise<ProbeAndRouteResponse | null>;
-    route(init: ProbeAndRouteInit): Promise<ProbeAndRouteResponse | null>;
-    parsePaymentRequest(request: string): Promise<ParsedPaymentRequest>;
-    getBlockheight(): Promise<number>;
-    getChannels(activeOnly?: boolean): Promise<LightningNetworkChannel[]>;
-    getLightningBalance(): Promise<LightningBalanceResponse>;
-    getIdentityPublicKey(): Promise<string>;
-}
+import { Command } from "@atomiqlabs/server-base";
+export type IncomingLightningNetworkPayment = {
+    createdAt: number;
+    confirmedAt: number;
+    createdHeight: number;
+    timeout: number;
+    status: "held" | "canceled" | "confirmed";
+    mtokens: bigint;
+};
+export type LightningNetworkInvoice = {
+    id: string;
+    request: string;
+    secret?: string;
+    cltvDelta: number;
+    mtokens: bigint;
+    createdAt: number;
+    expiresAt: number;
+    description: string;
+    descriptionHash?: string;
+    payments: IncomingLightningNetworkPayment[];
+    status: "unpaid" | "held" | "canceled" | "confirmed";
+};
+export type OutgoingLightningNetworkPayment = {
+    failedReason?: "insufficient_balance" | "invalid_payment" | "pathfinding_timeout" | "route_not_found";
+    status: "confirmed" | "failed" | "pending";
+    secret?: string;
+    feeMtokens?: bigint;
+};
+export type LightningNetworkChannel = {
+    id: string;
+    capacity: bigint;
+    isActive: boolean;
+    localBalance: bigint;
+    localReserve: bigint;
+    remoteBalance: bigint;
+    remoteReserve: bigint;
+    unsettledBalance: bigint;
+    transactionId: string;
+    transactionVout: number;
+};
+export type InvoiceInit = {
+    mtokens: bigint;
+    descriptionHash?: string;
+    description?: string;
+    cltvDelta?: number;
+    expiresAt?: number;
+};
+export type HodlInvoiceInit = {
+    description: string;
+    cltvDelta: number;
+    expiresAt: number;
+    id: string;
+    mtokens: bigint;
+    descriptionHash?: string;
+};
+export type LNRoutes = {
+    publicKey: string;
+    feeRate?: number;
+    cltvDelta?: number;
+    channel?: string;
+    baseFeeMtokens?: bigint;
+}[][];
+export type ParsedPaymentRequest = {
+    id: string;
+    mtokens: bigint;
+    expiryEpochMillis: number;
+    destination: string;
+    cltvDelta: number;
+    description: string;
+    routes: LNRoutes;
+};
+export type LightningPaymentInit = {
+    request: string;
+    maxFeeMtokens?: bigint;
+    maxTimeoutHeight?: number;
+};
+export type LightningBalanceResponse = {
+    localBalance: bigint;
+    remoteBalance: bigint;
+    unsettledBalance: bigint;
+};
+export type ProbeAndRouteInit = {
+    request: string;
+    amountMtokens: bigint;
+    maxFeeMtokens: bigint;
+    maxTimeoutHeight: number;
+};
+export type ProbeAndRouteResponse = {
+    confidence: number;
+    feeMtokens: bigint;
+    destination: string;
+    privateRoutes: LNRoutes;
+};
+export declare function routesMatch(routesA: LNRoutes, routesB: LNRoutes): boolean;
+export interface ILightningWallet {
+    init(): Promise<void>;
+    isReady(): boolean;
+    getStatus(): string;
+    getStatusInfo(): Promise<Record<string, string>>;
+    getCommands(): Command<any>[];
+    createInvoice(init: InvoiceInit): Promise<LightningNetworkInvoice>;
+    createHodlInvoice(init: HodlInvoiceInit): Promise<LightningNetworkInvoice>;
+    getInvoice(paymentHash: string): Promise<LightningNetworkInvoice | null>;
+    cancelHodlInvoice(paymentHash: string): Promise<void>;
+    settleHodlInvoice(secret: string): Promise<void>;
+    waitForInvoice(paymentHash: string, abortSignal?: AbortSignal): Promise<LightningNetworkInvoice>;
+    pay(init: LightningPaymentInit): Promise<void>;
+    getPayment(paymentHash: string): Promise<OutgoingLightningNetworkPayment | null>;
+    waitForPayment(paymentHash: string, abortSignal?: AbortSignal): Promise<OutgoingLightningNetworkPayment>;
+    probe(init: ProbeAndRouteInit): Promise<ProbeAndRouteResponse | null>;
+    route(init: ProbeAndRouteInit): Promise<ProbeAndRouteResponse | null>;
+    parsePaymentRequest(request: string): Promise<ParsedPaymentRequest>;
+    getBlockheight(): Promise<number>;
+    getChannels(activeOnly?: boolean): Promise<LightningNetworkChannel[]>;
+    getLightningBalance(): Promise<LightningBalanceResponse>;
+    getIdentityPublicKey(): Promise<string>;
+}

package/dist/wallets/ILightningWallet.js

@@ -1,37 +1,37 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.routesMatch = void 0;
-function routesMatch(routesA, routesB) {
-    if (routesA === routesB)
-        return true;
-    if (routesA == null || routesB == null) {
-        return false;
-    }
-    if (routesA.length !== routesB.length)
-        return false;
-    for (let i = 0; i < routesA.length; i++) {
-        if (routesA[i] === routesB[i])
-            continue;
-        if (routesA[i] == null || routesB[i] == null) {
-            return false;
-        }
-        if (routesA[i].length !== routesB[i].length)
-            return false;
-        for (let e = 0; e < routesA[i].length; e++) {
-            if (routesA[i][e] === routesB[i][e])
-                continue;
-            if (routesA[i][e] == null || routesB[i][e] == null) {
-                return false;
-            }
-            if (routesA[i][e].publicKey !== routesB[i][e].publicKey ||
-                routesA[i][e].baseFeeMtokens !== routesB[i][e].baseFeeMtokens ||
-                routesA[i][e].channel !== routesB[i][e].channel ||
-                routesA[i][e].cltvDelta !== routesB[i][e].cltvDelta ||
-                routesA[i][e].feeRate !== routesB[i][e].feeRate) {
-                return false;
-            }
-        }
-    }
-    return true;
-}
-exports.routesMatch = routesMatch;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.routesMatch = void 0;
+function routesMatch(routesA, routesB) {
+    if (routesA === routesB)
+        return true;
+    if (routesA == null || routesB == null) {
+        return false;
+    }
+    if (routesA.length !== routesB.length)
+        return false;
+    for (let i = 0; i < routesA.length; i++) {
+        if (routesA[i] === routesB[i])
+            continue;
+        if (routesA[i] == null || routesB[i] == null) {
+            return false;
+        }
+        if (routesA[i].length !== routesB[i].length)
+            return false;
+        for (let e = 0; e < routesA[i].length; e++) {
+            if (routesA[i][e] === routesB[i][e])
+                continue;
+            if (routesA[i][e] == null || routesB[i][e] == null) {
+                return false;
+            }
+            if (routesA[i][e].publicKey !== routesB[i][e].publicKey ||
+                routesA[i][e].baseFeeMtokens !== routesB[i][e].baseFeeMtokens ||
+                routesA[i][e].channel !== routesB[i][e].channel ||
+                routesA[i][e].cltvDelta !== routesB[i][e].cltvDelta ||
+                routesA[i][e].feeRate !== routesB[i][e].feeRate) {
+                return false;
+            }
+        }
+    }
+    return true;
+}
+exports.routesMatch = routesMatch;

package/dist/wallets/ISpvVaultSigner.d.ts

@@ -1,7 +1,7 @@
-import { Transaction } from "@scure/btc-signer";
-export interface ISpvVaultSigner {
-    init(): Promise<void>;
-    getAddressType(): "p2wpkh" | "p2tr";
-    getAddress(chainId: string, vaultId: bigint): Promise<string>;
-    signPsbt(chainId: string, vaultId: bigint, psbt: Transaction, inputs: number[]): Promise<Transaction>;
-}
+import { Transaction } from "@scure/btc-signer";
+export interface ISpvVaultSigner {
+    init(): Promise<void>;
+    getAddressType(): "p2wpkh" | "p2tr";
+    getAddress(chainId: string, vaultId: bigint): Promise<string>;
+    signPsbt(chainId: string, vaultId: bigint, psbt: Transaction, inputs: number[]): Promise<Transaction>;
+}

package/dist/wallets/ISpvVaultSigner.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,36 +1,36 @@
-{
-  "name": "@atomiqlabs/lp-lib",
-  "version": "15.0.14",
-  "description": "Main functionality implementation for atomiq LP node",
-  "main": "./dist/index.js",
-  "types:": "./dist/index.d.ts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "files": [
-    "/dist",
-    "/src"
-  ],
-  "keywords": [
-    "Solana",
-    "Bitcoin",
-    "Cross-chain",
-    "Cryptocurrency",
-    "Bridge",
-    "Trustless"
-  ],
-  "author": "adambor",
-  "license": "ISC",
-  "dependencies": {
-    "@atomiqlabs/base": "^11.0.0",
-    "@atomiqlabs/server-base": "^3.0.0",
-    "@scure/btc-signer": "1.6.0",
-    "express": "4.21.1",
-    "promise-queue-ts": "0.0.1"
-  },
-  "devDependencies": {
-    "@types/express": "4.17.21",
-    "@types/node": "18.15.11",
-    "typescript": "4.9.5"
-  }
-}
+{
+  "name": "@atomiqlabs/lp-lib",
+  "version": "16.0.0",
+  "description": "Main functionality implementation for atomiq LP node",
+  "main": "./dist/index.js",
+  "types:": "./dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "files": [
+    "/dist",
+    "/src"
+  ],
+  "keywords": [
+    "Solana",
+    "Bitcoin",
+    "Cross-chain",
+    "Cryptocurrency",
+    "Bridge",
+    "Trustless"
+  ],
+  "author": "adambor",
+  "license": "ISC",
+  "dependencies": {
+    "@atomiqlabs/base": "^12.0.0",
+    "@atomiqlabs/server-base": "^3.0.0",
+    "@scure/btc-signer": "1.6.0",
+    "express": "4.21.1",
+    "promise-queue-ts": "1.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "4.17.21",
+    "@types/node": "18.15.11",
+    "typescript": "4.9.5"
+  }
+}

package/src/fees/IBtcFeeEstimator.ts

@@ -1,7 +1,7 @@
-
-export interface IBtcFeeEstimator {
-
-    //Returns estimated fee in sats/vB
-    estimateFee(): Promise<number | null>;
-
+
+export interface IBtcFeeEstimator {
+
+    //Returns estimated fee in sats/vB
+    estimateFee(): Promise<number | null>;
+
 }