@atomiqlabs/lp-lib 10.3.11 → 11.0.0

package/dist/utils/coinselect2/utils.js

@@ -1,121 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.utils = void 0;
-// baseline estimates, used to improve performance
-const TX_EMPTY_SIZE = 4 + 1 + 1 + 4;
-const TX_INPUT_BASE = 32 + 4 + 1 + 4;
-const WITNESS_OVERHEAD = 2 / 4;
-const P2WPKH_WITNESS = (1 + 1 + 72 + 1 + 33) / 4;
-const P2TR_WITNESS = (1 + 1 + 65) / 4;
-const TX_INPUT_PUBKEYHASH = 107;
-const TX_INPUT_P2SH_P2WPKH = 23 + P2WPKH_WITNESS + 1;
-const TX_INPUT_P2WPKH = 0 + P2WPKH_WITNESS;
-const TX_INPUT_P2WSH = 0 + (1 + 1 + 64) / 4;
-const TX_INPUT_P2TR = 0 + P2TR_WITNESS;
-const TX_OUTPUT_BASE = 8 + 1;
-const TX_OUTPUT_PUBKEYHASH = 25;
-const TX_OUTPUT_P2SH_P2WPKH = 23;
-const TX_OUTPUT_P2WPKH = 22;
-const TX_OUTPUT_P2WSH = 34;
-const TX_OUTPUT_P2TR = 34;
-const INPUT_BYTES = {
-    "p2sh-p2wpkh": TX_INPUT_P2SH_P2WPKH,
-    "p2wpkh": TX_INPUT_P2WPKH,
-    "p2tr": TX_INPUT_P2TR,
-    "p2pkh": TX_INPUT_PUBKEYHASH,
-    "p2wsh": TX_INPUT_P2WSH
-};
-function inputBytes(input) {
-    var _a, _b;
-    if (input.script == null && input.witness == null) {
-        return { length: TX_INPUT_BASE + INPUT_BYTES[input.type], isWitness: input.type !== "p2pkh" };
-    }
-    return {
-        length: TX_INPUT_BASE + (((_a = input.script) === null || _a === void 0 ? void 0 : _a.length) || 0) + ((((_b = input.witness) === null || _b === void 0 ? void 0 : _b.length) || 0) / 4),
-        isWitness: input.witness != null
-    };
-}
-const OUTPUT_BYTES = {
-    "p2sh-p2wpkh": TX_OUTPUT_P2SH_P2WPKH,
-    "p2wpkh": TX_OUTPUT_P2WPKH,
-    "p2tr": TX_OUTPUT_P2TR,
-    "p2pkh": TX_OUTPUT_PUBKEYHASH,
-    "p2wsh": TX_OUTPUT_P2WSH
-};
-function outputBytes(output) {
-    return TX_OUTPUT_BASE + (output.script ? output.script.length : OUTPUT_BYTES[output.type]);
-}
-const DUST_THRESHOLDS = {
-    "p2sh-p2wpkh": 540,
-    "p2wpkh": 294,
-    "p2tr": 330,
-    "p2pkh": 546,
-    "p2wsh": 330
-};
-function dustThreshold(output) {
-    return DUST_THRESHOLDS[output.type];
-}
-function transactionBytes(inputs, outputs, changeType) {
-    let size = TX_EMPTY_SIZE;
-    let isSegwit = false;
-    if (changeType !== "p2pkh") {
-        size += WITNESS_OVERHEAD;
-        let isSegwit = true;
-    }
-    for (let input of inputs) {
-        const { length, isWitness } = inputBytes(input);
-        size += length;
-        if (!isSegwit && isWitness) {
-            isSegwit = true;
-            size += WITNESS_OVERHEAD;
-        }
-    }
-    for (let output of outputs) {
-        size += outputBytes(output);
-    }
-    return Math.ceil(size);
-}
-function uintOrNaN(v) {
-    if (typeof v !== 'number')
-        return NaN;
-    if (!isFinite(v))
-        return NaN;
-    if (Math.floor(v) !== v)
-        return NaN;
-    if (v < 0)
-        return NaN;
-    return v;
-}
-function sumForgiving(range) {
-    return range.reduce((a, x) => a + (isFinite(x.value) ? x.value : 0), 0);
-}
-function sumOrNaN(range) {
-    return range.reduce((a, x) => a + uintOrNaN(x.value), 0);
-}
-function finalize(inputs, outputs, feeRate, changeType) {
-    const bytesAccum = transactionBytes(inputs, outputs, changeType);
-    const feeAfterExtraOutput = feeRate * (bytesAccum + outputBytes({ type: changeType }));
-    const remainderAfterExtraOutput = sumOrNaN(inputs) - (sumOrNaN(outputs) + feeAfterExtraOutput);
-    // is it worth a change output?
-    if (remainderAfterExtraOutput >= dustThreshold({ type: changeType })) {
-        outputs = outputs.concat({ value: remainderAfterExtraOutput, type: changeType });
-    }
-    const fee = sumOrNaN(inputs) - sumOrNaN(outputs);
-    if (!isFinite(fee))
-        return { fee: feeRate * bytesAccum };
-    return {
-        inputs: inputs,
-        outputs: outputs,
-        fee: fee
-    };
-}
-exports.utils = {
-    dustThreshold: dustThreshold,
-    finalize: finalize,
-    inputBytes: inputBytes,
-    outputBytes: outputBytes,
-    sumOrNaN: sumOrNaN,
-    sumForgiving: sumForgiving,
-    transactionBytes: transactionBytes,
-    uintOrNaN: uintOrNaN
-};

package/src/fees/OneDollarFeeEstimator.ts

@@ -1,95 +0,0 @@
-import {IBtcFeeEstimator} from "./IBtcFeeEstimator";
-import {getLogger} from "../utils/Utils";
-const dynamicImport = new Function('specifier', 'return import(specifier)');
-const importPromise = dynamicImport('one-dollar-fee-estimator-failover');
-
-const logger = getLogger("OneDollarFeeEstimator: ")
-
-export class OneDollarFeeEstimator implements IBtcFeeEstimator {
-
-    estimator: any;
-
-    receivedFee: [number, number, number, number];
-    iterations: number = 0;
-
-    host: string;
-    port: number;
-    username: string;
-    password: string;
-
-    addFee: number;
-    feeMultiplier: number;
-
-    startFeeEstimator() {
-        logger.info("startFeeEstimator(): starting fee estimator worker");
-
-        importPromise.then(({FeeEstimator}) => {
-            this.estimator = new FeeEstimator({
-                mode: 'bundles', // 'txs' | 'bundles' - optional, default 'txs'
-                refresh: 30, // optional, default 30 - interval in seconds, setting too low can cause unexpected errors
-                rpcOptions: {
-                    host: this.host,
-                    port: this.port,
-                    username: this.username,
-                    password: this.password
-                }
-            });
-
-            this.estimator.on('error', (err) => {
-                logger.error("on(error): fee estimator error", err);
-                if(err.message.startsWith("FeeEstimator worker stopped")) {
-                    logger.info("on(error): restarting fee estimator worker");
-                    this.receivedFee = null;
-                    this.iterations = 0;
-                    this.startFeeEstimator();
-                }
-            });
-
-            // receive live fee rate updates from the FeeEstimator
-            this.estimator.on('fees', (fees) => {
-                this.receivedFee = fees;
-                this.iterations++;
-            });
-        });
-    }
-
-    constructor(
-        host: string,
-        port: number,
-        username: string,
-        password: string,
-        addFee?: number,
-        feeMultiplier?: number
-    ) {
-        this.host = host;
-        this.port = port;
-        this.username = username;
-        this.password = password;
-        this.addFee = addFee;
-        this.feeMultiplier = feeMultiplier;
-        this.startFeeEstimator();
-
-        process.on('exit', () => {
-            logger.info("process(exit): process exiting, stopping estimator");
-            if(this.estimator!=null) this.estimator.stop();
-        });
-
-        process.on('SIGINT', () => {
-            logger.info("process(SIGINT): process exiting, stopping estimator");
-            if(this.estimator!=null) this.estimator.stop();
-            process.exit();
-        });
-    }
-
-    getFee(): number {
-        let fee = this.receivedFee[3];
-        if(this.feeMultiplier!=null) fee *= this.feeMultiplier;
-        if(this.addFee!=null) fee += this.addFee;
-        return fee;
-    }
-
-    estimateFee(): Promise<number | null> {
-        return Promise.resolve(this.iterations<=1 ? null : this.getFee());
-    }
-
-}

package/src/utils/coinselect2/accumulative.js

@@ -1,32 +0,0 @@
-import { utils } from "./utils";
-// add inputs until we reach or surpass the target value (or deplete)
-// worst-case: O(n)
-export function accumulative(utxos, outputs, feeRate, type) {
-    if (!isFinite(utils.uintOrNaN(feeRate)))
-        return null;
-    let bytesAccum = utils.transactionBytes([], outputs, type);
-    let inAccum = 0;
-    const inputs = [];
-    const outAccum = utils.sumOrNaN(outputs);
-    for (let i = 0; i < utxos.length; ++i) {
-        const utxo = utxos[i];
-        const utxoBytes = utils.inputBytes(utxo);
-        const utxoFee = feeRate * utxoBytes;
-        const utxoValue = utils.uintOrNaN(utxo.value);
-        // skip detrimental input
-        if (utxoFee > utxo.value) {
-            if (i === utxos.length - 1)
-                return { fee: feeRate * (bytesAccum + utxoBytes) };
-            continue;
-        }
-        bytesAccum += utxoBytes;
-        inAccum += utxoValue;
-        inputs.push(utxo);
-        const fee = feeRate * bytesAccum;
-        // go again?
-        if (inAccum < outAccum + fee)
-            continue;
-        return utils.finalize(inputs, outputs, feeRate, type);
-    }
-    return { fee: feeRate * bytesAccum };
-}

package/src/utils/coinselect2/accumulative.ts

@@ -1,58 +0,0 @@
-import {CoinselectAddressTypes, CoinselectTxInput, CoinselectTxOutput, utils} from "./utils";
-
-// add inputs until we reach or surpass the target value (or deplete)
-// worst-case: O(n)
-export function accumulative (
-    utxos: CoinselectTxInput[],
-    outputs: CoinselectTxOutput[],
-    feeRate: number,
-    type: CoinselectAddressTypes,
-    requiredInputs?: CoinselectTxInput[]
-): {
-    inputs?: CoinselectTxInput[],
-    outputs?: CoinselectTxOutput[],
-    fee: number
-} {
-    if (!isFinite(utils.uintOrNaN(feeRate))) return null;
-
-    let bytesAccum = utils.transactionBytes([], outputs, type);
-    let inAccum = 0;
-    const inputs = [];
-
-    if(requiredInputs!=null) for(let utxo of requiredInputs) {
-        const {length: utxoBytes} = utils.inputBytes(utxo);
-        const utxoValue = utils.uintOrNaN(utxo.value);
-
-        bytesAccum += utxoBytes;
-        inAccum += utxoValue;
-        inputs.push(utxo);
-    }
-
-    const outAccum = utils.sumOrNaN(outputs);
-
-    for (let i = 0; i < utxos.length; ++i) {
-        const utxo = utxos[i];
-        const {length: utxoBytes} = utils.inputBytes(utxo);
-        const utxoFee = feeRate * utxoBytes;
-        const utxoValue = utils.uintOrNaN(utxo.value);
-
-        // skip detrimental input
-        if (utxoFee > utxo.value) {
-            if (i === utxos.length - 1) return { fee: feeRate * (bytesAccum + utxoBytes) };
-            continue
-        }
-
-        bytesAccum += utxoBytes;
-        inAccum += utxoValue;
-        inputs.push(utxo);
-
-        const fee = feeRate * bytesAccum;
-
-        // go again?
-        if (inAccum < outAccum + fee) continue;
-
-        return utils.finalize(inputs, outputs, feeRate, type);
-    }
-
-    return { fee: feeRate * bytesAccum };
-}

package/src/utils/coinselect2/blackjack.js

@@ -1,29 +0,0 @@
-import { utils } from "./utils";
-// add inputs until we reach or surpass the target value (or deplete)
-// worst-case: O(n)
-export function blackjack(utxos, outputs, feeRate, type) {
-    if (!isFinite(utils.uintOrNaN(feeRate)))
-        return null;
-    let bytesAccum = utils.transactionBytes([], outputs, type);
-    let inAccum = 0;
-    const inputs = [];
-    const outAccum = utils.sumOrNaN(outputs);
-    const threshold = utils.dustThreshold({ type });
-    for (let i = 0; i < utxos.length; ++i) {
-        const input = utxos[i];
-        const inputBytes = utils.inputBytes(input);
-        const fee = feeRate * (bytesAccum + inputBytes);
-        const inputValue = utils.uintOrNaN(input.value);
-        // would it waste value?
-        if ((inAccum + inputValue) > (outAccum + fee + threshold))
-            continue;
-        bytesAccum += inputBytes;
-        inAccum += inputValue;
-        inputs.push(input);
-        // go again?
-        if (inAccum < outAccum + fee)
-            continue;
-        return utils.finalize(inputs, outputs, feeRate, type);
-    }
-    return { fee: feeRate * bytesAccum };
-}

package/src/utils/coinselect2/blackjack.ts

@@ -1,54 +0,0 @@
-import {CoinselectAddressTypes, CoinselectTxInput, CoinselectTxOutput, utils} from "./utils";
-
-// add inputs until we reach or surpass the target value (or deplete)
-// worst-case: O(n)
-export function blackjack (
-    utxos: CoinselectTxInput[],
-    outputs: CoinselectTxOutput[],
-    feeRate: number,
-    type: CoinselectAddressTypes,
-    requiredInputs?: CoinselectTxInput[]
-): {
-    inputs?: CoinselectTxInput[],
-    outputs?: CoinselectTxOutput[],
-    fee: number
-} {
-    if (!isFinite(utils.uintOrNaN(feeRate))) return null;
-
-    let bytesAccum = utils.transactionBytes([], outputs, type);
-    let inAccum = 0;
-    const inputs = [];
-
-    if(requiredInputs!=null) for(let utxo of requiredInputs) {
-        const {length: utxoBytes} = utils.inputBytes(utxo);
-        const utxoValue = utils.uintOrNaN(utxo.value);
-
-        bytesAccum += utxoBytes;
-        inAccum += utxoValue;
-        inputs.push(utxo);
-    }
-
-    const outAccum = utils.sumOrNaN(outputs);
-    const threshold = utils.dustThreshold({type});
-
-    for (let i = 0; i < utxos.length; ++i) {
-        const input = utxos[i];
-        const {length: inputBytes} = utils.inputBytes(input);
-        const fee = feeRate * (bytesAccum + inputBytes);
-        const inputValue = utils.uintOrNaN(input.value);
-
-        // would it waste value?
-        if ((inAccum + inputValue) > (outAccum + fee + threshold)) continue;
-
-        bytesAccum += inputBytes;
-        inAccum += inputValue;
-        inputs.push(input);
-
-        // go again?
-        if (inAccum < outAccum + fee) continue;
-
-        return utils.finalize(inputs, outputs, feeRate, type);
-    }
-
-    return { fee: feeRate * bytesAccum };
-}

package/src/utils/coinselect2/index.js

@@ -1,16 +0,0 @@
-import { accumulative } from "./accumulative";
-import { blackjack } from "./blackjack";
-import { utils } from "./utils";
-// order by descending value, minus the inputs approximate fee
-function utxoScore(x, feeRate) {
-    return x.value - (feeRate * utils.inputBytes(x));
-}
-export function coinSelect(utxos, outputs, feeRate, type) {
-    utxos = utxos.sort((a, b) => utxoScore(b, feeRate) - utxoScore(a, feeRate));
-    // attempt to use the blackjack strategy first (no change output)
-    const base = blackjack(utxos, outputs, feeRate, type);
-    if (base.inputs)
-        return base;
-    // else, try the accumulative strategy
-    return accumulative(utxos, outputs, feeRate, type);
-}

package/src/utils/coinselect2/index.ts

@@ -1,50 +0,0 @@
-import {accumulative} from "./accumulative"
-import {blackjack} from "./blackjack"
-import {CoinselectAddressTypes, CoinselectTxInput, CoinselectTxOutput, utils} from "./utils"
-import * as BN from "bn.js";
-import {shuffle} from "../Utils";
-
-// order by descending value, minus the inputs approximate fee
-function utxoScore (x, feeRate) {
-    return x.value - (feeRate * utils.inputBytes(x).length)
-}
-
-function utxoFeePPM(utxo: CoinselectTxInput, feeRate: number): number {
-    return new BN(utxo.value).mul(new BN(1000000)).div(new BN(Math.ceil(feeRate * utils.inputBytes(utxo).length))).toNumber();
-}
-
-/**
- * Runs a coinselection algorithm on given inputs, outputs and fee rate
- *
- * @param utxos Utxo pool to select additional inputs from
- * @param outputs Outputs of the transaction
- * @param feeRate Feerate in sats/vB
- * @param changeType Change address type
- * @param requiredInputs Utxos that need to be included as inputs to the transaction
- * @param randomize Randomize the UTXO order before running the coinselection algorithm
- */
-export function coinSelect (
-    utxos: CoinselectTxInput[],
-    outputs: CoinselectTxOutput[],
-    feeRate: number,
-    changeType: CoinselectAddressTypes,
-    requiredInputs?: CoinselectTxInput[],
-    randomize?: boolean
-): {
-    inputs?: CoinselectTxInput[],
-    outputs?: CoinselectTxOutput[],
-    fee: number
-} {
-    if(randomize) {
-        shuffle(utxos);
-    } else {
-        utxos.sort((a, b) => utxoScore(b, feeRate) - utxoScore(a, feeRate));
-    }
-
-    // attempt to use the blackjack strategy first (no change output)
-    let base = blackjack(utxos, outputs, feeRate, changeType, requiredInputs);
-    if (base.inputs) return base;
-
-    // else, try the accumulative strategy
-    return accumulative(utxos, outputs, feeRate, changeType, requiredInputs);
-}

package/src/utils/coinselect2/utils.js

@@ -1,110 +0,0 @@
-// baseline estimates, used to improve performance
-const TX_EMPTY_SIZE = 4 + 1 + 1 + 4;
-const TX_INPUT_BASE = 32 + 4 + 1 + 4;
-const WITNESS_OVERHEAD = 2 / 4;
-const P2WPKH_WITNESS = (1 + 1 + 72 + 1 + 33) / 4;
-const P2TR_WITNESS = (1 + 1 + 65) / 4;
-const TX_INPUT_PUBKEYHASH = 107;
-const TX_INPUT_P2SH_P2WPKH = 23 + P2WPKH_WITNESS + 1;
-const TX_INPUT_P2WPKH = 0 + P2WPKH_WITNESS;
-const TX_INPUT_P2WSH = 0 + (1 + 1 + 64) / 4;
-const TX_INPUT_P2TR = 0 + P2TR_WITNESS;
-const TX_OUTPUT_BASE = 8 + 1;
-const TX_OUTPUT_PUBKEYHASH = 25;
-const TX_OUTPUT_P2SH_P2WPKH = 23;
-const TX_OUTPUT_P2WPKH = 22;
-const TX_OUTPUT_P2WSH = 34;
-const TX_OUTPUT_P2TR = 34;
-const INPUT_BYTES = {
-    "p2sh-p2wpkh": TX_INPUT_P2SH_P2WPKH,
-    "p2wpkh": TX_INPUT_P2WPKH,
-    "p2tr": TX_INPUT_P2TR,
-    "p2pkh": TX_INPUT_PUBKEYHASH,
-    "p2wsh": TX_INPUT_P2WSH
-};
-function inputBytes(input) {
-    return TX_INPUT_BASE + (input.script ? input.script.length : INPUT_BYTES[input.type]);
-}
-const OUTPUT_BYTES = {
-    "p2sh-p2wpkh": TX_OUTPUT_P2SH_P2WPKH,
-    "p2wpkh": TX_OUTPUT_P2WPKH,
-    "p2tr": TX_OUTPUT_P2TR,
-    "p2pkh": TX_OUTPUT_PUBKEYHASH,
-    "p2wsh": TX_OUTPUT_P2WSH
-};
-function outputBytes(output) {
-    return TX_OUTPUT_BASE + (output.script ? output.script.length : OUTPUT_BYTES[output.type]);
-}
-const DUST_THRESHOLDS = {
-    "p2sh-p2wpkh": 540,
-    "p2wpkh": 294,
-    "p2tr": 330,
-    "p2pkh": 546,
-    "p2wsh": 330
-};
-function dustThreshold(output) {
-    return DUST_THRESHOLDS[output.type];
-}
-function transactionBytes(inputs, outputs, changeType) {
-    let size = TX_EMPTY_SIZE;
-    let isSegwit = false;
-    if (changeType !== "p2pkh") {
-        size += WITNESS_OVERHEAD;
-        let isSegwit = true;
-    }
-    for (let input of inputs) {
-        if (!isSegwit && (input.type !== "p2pkh")) {
-            isSegwit = true;
-            size += WITNESS_OVERHEAD;
-        }
-        size += inputBytes(input);
-    }
-    for (let output of outputs) {
-        size += outputBytes(output);
-    }
-    return Math.ceil(size);
-}
-function uintOrNaN(v) {
-    if (typeof v !== 'number')
-        return NaN;
-    if (!isFinite(v))
-        return NaN;
-    if (Math.floor(v) !== v)
-        return NaN;
-    if (v < 0)
-        return NaN;
-    return v;
-}
-function sumForgiving(range) {
-    return range.reduce((a, x) => a + (isFinite(x.value) ? x.value : 0), 0);
-}
-function sumOrNaN(range) {
-    return range.reduce((a, x) => a + uintOrNaN(x.value), 0);
-}
-function finalize(inputs, outputs, feeRate, changeType) {
-    const bytesAccum = transactionBytes(inputs, outputs, changeType);
-    const feeAfterExtraOutput = feeRate * (bytesAccum + outputBytes({ type: changeType }));
-    const remainderAfterExtraOutput = sumOrNaN(inputs) - (sumOrNaN(outputs) + feeAfterExtraOutput);
-    // is it worth a change output?
-    if (remainderAfterExtraOutput >= dustThreshold({ type: changeType })) {
-        outputs = outputs.concat({ value: remainderAfterExtraOutput, type: changeType });
-    }
-    const fee = sumOrNaN(inputs) - sumOrNaN(outputs);
-    if (!isFinite(fee))
-        return { fee: feeRate * bytesAccum };
-    return {
-        inputs: inputs,
-        outputs: outputs,
-        fee: fee
-    };
-}
-export const utils = {
-    dustThreshold: dustThreshold,
-    finalize: finalize,
-    inputBytes: inputBytes,
-    outputBytes: outputBytes,
-    sumOrNaN: sumOrNaN,
-    sumForgiving: sumForgiving,
-    transactionBytes: transactionBytes,
-    uintOrNaN: uintOrNaN
-};