@onetokenfe/coinselect 3.1.16

package/third-party/utxo-lib/types/typeforce.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.typeforce = exports.anyOf = exports.Nil = exports.BufferN = exports.Function = exports.UInt32 = exports.UInt16 = exports.UInt8 = exports.tuple = exports.maybe = exports.Hex = exports.Buffer = exports.String = exports.Boolean = exports.Array = exports.Number = exports.Hash256bit = exports.Hash160bit = exports.Buffer256bit = void 0;
+exports.Satoshi = Satoshi;
+const tslib_1 = require("tslib");
+const typeforce_1 = tslib_1.__importDefault(require("typeforce"));
+exports.typeforce = typeforce_1.default;
+const SATOSHI_MAX = 21 * 1e14;
+function Satoshi(value) {
+    return typeforce_1.default.UInt53(value) && value <= SATOSHI_MAX;
+}
+exports.Buffer256bit = typeforce_1.default.BufferN(32);
+exports.Hash160bit = typeforce_1.default.BufferN(20);
+exports.Hash256bit = typeforce_1.default.BufferN(32);
+exports.Number = typeforce_1.default.Number, exports.Array = typeforce_1.default.Array, exports.Boolean = typeforce_1.default.Boolean, exports.String = typeforce_1.default.String, exports.Buffer = typeforce_1.default.Buffer, exports.Hex = typeforce_1.default.Hex, exports.maybe = typeforce_1.default.maybe, exports.tuple = typeforce_1.default.tuple, exports.UInt8 = typeforce_1.default.UInt8, exports.UInt16 = typeforce_1.default.UInt16, exports.UInt32 = typeforce_1.default.UInt32, exports.Function = typeforce_1.default.Function, exports.BufferN = typeforce_1.default.BufferN, exports.Nil = typeforce_1.default.Nil, exports.anyOf = typeforce_1.default.anyOf;
+//# sourceMappingURL=typeforce.js.map

package/third-party/utxo-lib/vsize.d.ts

@@ -0,0 +1,13 @@
+import type { Network } from './networks';
+export declare const getTransactionVbytesFromAddresses: (inputs: string[], outputs: string[], network: Network) => number;
+type GetTransactionVbytesParam = {
+    vin: {
+        addresses?: string[];
+    }[];
+    vout: {
+        addresses?: string[];
+    }[];
+};
+export declare const getTransactionVbytes: ({ vin, vout }: GetTransactionVbytesParam, network: Network) => number;
+export {};
+//# sourceMappingURL=vsize.d.ts.map

package/third-party/utxo-lib/vsize.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTransactionVbytes = exports.getTransactionVbytesFromAddresses = void 0;
+const tslib_1 = require("tslib");
+const BitcoinJsAddress = tslib_1.__importStar(require("./address"));
+const coinselectUtils_1 = require("./coinselect/coinselectUtils");
+const address_1 = require("./address");
+const isKnownInputAddress = (type) => type in coinselectUtils_1.INPUT_SCRIPT_LENGTH;
+const toVin = (network) => (address) => {
+    const type = (0, address_1.getAddressType)(address, network);
+    if (isKnownInputAddress(type)) {
+        return {
+            type,
+            script: { length: coinselectUtils_1.INPUT_SCRIPT_LENGTH[type] },
+        };
+    }
+    throw new Error(`Unknown input address '${address}'`);
+};
+const toVout = (network) => (address) => {
+    var _a;
+    let length;
+    try {
+        length = BitcoinJsAddress.toOutputScript(address, network).length;
+    }
+    catch (_b) {
+        const msg = (_a = address.match(/^OP_RETURN (.*)$/)) === null || _a === void 0 ? void 0 : _a.pop();
+        if (msg) {
+            length = msg.match(/^\(.*\)$/)
+                ? msg.length
+                : 2 + msg.length / 2;
+        }
+        else {
+            length = 0;
+        }
+    }
+    return { script: { length } };
+};
+const getTransactionVbytesFromAddresses = (inputs, outputs, network) => {
+    const ins = inputs.map(toVin(network));
+    const outs = outputs.map(toVout(network));
+    return (0, coinselectUtils_1.transactionBytes)(ins, outs);
+};
+exports.getTransactionVbytesFromAddresses = getTransactionVbytesFromAddresses;
+const getTransactionVbytes = ({ vin, vout }, network) => {
+    const ins = vin.map(({ addresses = [] }) => { var _a; return (_a = addresses[0]) !== null && _a !== void 0 ? _a : ''; });
+    const outs = vout.map(({ addresses = [] }) => { var _a; return (_a = addresses[0]) !== null && _a !== void 0 ? _a : ''; });
+    return (0, exports.getTransactionVbytesFromAddresses)(ins, outs, network);
+};
+exports.getTransactionVbytes = getTransactionVbytes;
+//# sourceMappingURL=vsize.js.map

package/utils.js

@@ -0,0 +1,78 @@
+// baseline estimates, used to improve performance
+var TX_EMPTY_SIZE = 4 + 1 + 1 + 4
+var TX_INPUT_BASE = 32 + 4 + 1 + 4
+var TX_INPUT_PUBKEYHASH = 107
+var TX_OUTPUT_BASE = 8 + 1
+var TX_OUTPUT_PUBKEYHASH = 25
+var OP_RETURN_OVERHEAD = 1 + 8 + 1
+
+function inputBytes (input) {
+  return TX_INPUT_BASE + (input.script ? input.script.length : TX_INPUT_PUBKEYHASH)
+}
+
+function outputBytes (output) {
+  if (output.script) {
+    return OP_RETURN_OVERHEAD + output.script.length + (output.script.length >= 74 ? 2 : 1)
+  }
+  return TX_OUTPUT_BASE + (output.script ? output.script.length : TX_OUTPUT_PUBKEYHASH)
+}
+
+function dustThreshold (output, feeRate) {
+  /* ... classify the output for input estimate  */
+  return inputBytes({}) * feeRate
+}
+
+function transactionBytes (inputs, outputs) {
+  return TX_EMPTY_SIZE +
+    inputs.reduce(function (a, x) { return a + inputBytes(x) }, 0) +
+    outputs.reduce(function (a, x) { return a + outputBytes(x) }, 0)
+}
+
+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(function (a, x) { return a + (isFinite(x.value) ? x.value : 0) }, 0)
+}
+
+function sumOrNaN (range) {
+  return range.reduce(function (a, x) { return a + uintOrNaN(x.value) }, 0)
+}
+
+var BLANK_OUTPUT = outputBytes({})
+
+function finalize (inputs, outputs, feeRate) {
+  var bytesAccum = transactionBytes(inputs, outputs)
+  var feeAfterExtraOutput = feeRate * (bytesAccum + BLANK_OUTPUT)
+  var remainderAfterExtraOutput = sumOrNaN(inputs) - (sumOrNaN(outputs) + feeAfterExtraOutput)
+
+  // is it worth a change output?
+  if (remainderAfterExtraOutput > dustThreshold({}, feeRate)) {
+    outputs = outputs.concat({ value: remainderAfterExtraOutput })
+  }
+
+  var fee = sumOrNaN(inputs) - sumOrNaN(outputs)
+  if (!isFinite(fee)) return { fee: feeRate * bytesAccum }
+
+  return {
+    inputs: inputs,
+    outputs: outputs,
+    fee: fee
+  }
+}
+
+module.exports = {
+  dustThreshold: dustThreshold,
+  finalize: finalize,
+  inputBytes: inputBytes,
+  outputBytes: outputBytes,
+  sumOrNaN: sumOrNaN,
+  sumForgiving: sumForgiving,
+  transactionBytes: transactionBytes,
+  uintOrNaN: uintOrNaN
+}

package/witness.d.ts

@@ -0,0 +1,70 @@
+export type IPaymentType = 'p2pkh' | 'p2sh' | 'p2tr' | 'p2wpkh' | 'p2wsh';
+export interface IUtxo {
+    vout: number;
+    txid: string;
+    amount: string;
+    coinbase: boolean;
+    own: boolean;
+    confirmations: number;
+    required?: boolean;
+}
+
+export interface IOutputPayment {
+    type: 'payment';
+    address: string;
+    amount: string;
+}
+
+export interface IOutputSendMax {
+    type: 'send-max'; // only one in TX request
+    address: string;
+    amount?: typeof undefined;
+}
+
+export interface IOutputOpreturn {
+    type: 'opreturn';
+    dataHex: string;
+    amount?: typeof undefined;
+    address?: typeof undefined;
+}
+export interface IOutputChange {
+    type: 'change';
+    amount: string;
+}
+
+export type IFinalOutput =
+    | ComposeOutputPayment
+    | ComposeOutputSendMax
+    | ComposeOutputOpreturn;
+
+export interface IChangeAddress {
+    address: string;
+    path: string;
+}
+
+export interface ICoinSelectParams {
+    utxos: IUtxo[];
+    outputs: IFinalOutput[];
+    feeRate: string | number;
+    changeAddress: IChangeAddress;
+    network: any;
+    txType: IPaymentType
+    baseFee?: number;
+    dustThreshold?: number;
+}
+
+export interface ICoinSelectResult {
+    type: 'final';
+    max?: string;
+    totalSpent: string;
+    fee: string;
+    feePerByte: string;
+    bytes: number;
+    inputs: IUtxo[];
+    outputs: (IFinalOutput | IOutputChange)[];
+    outputsPermutation: number[];
+}
+
+declare function coinSelect(params: ICoinSelectParams): ICoinSelectResult;
+
+export = coinSelect;

package/witness.js

@@ -0,0 +1,30 @@
+const { composeTx } = require('./third-party/utxo-lib')
+
+module.exports = function coinSelect ({
+  utxos,
+  outputs,
+  feeRate,
+  changeAddress,
+  network,
+  txType,
+  baseFee = 0,
+  dustThreshold = 546
+}) {
+  const result = composeTx({
+    utxos,
+    outputs,
+    feeRate,
+    sortingStrategy: 'random',
+    txType,
+    dustThreshold,
+    changeAddress,
+    network,
+    baseFee
+  })
+
+  if (result.type === 'error') {
+    throw new Error(result.message || result.error)
+  }
+
+  return result
+}