@atomicfinance/bitcoin-utils 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @atomicfinance/bitcoin-utils
+
+## 3.0.0
+
+### Major Changes
+
+- a06082e: Create unified standalone `bitcoin-abstraction-layer` package
+
+### Patch Changes
+
+- Updated dependencies [a06082e]
+  - @atomicfinance/types@3.0.0
+  - @atomicfinance/crypto@3.0.0
+  - @atomicfinance/errors@3.0.0
+  - @atomicfinance/utils@3.0.0

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+import { Address, bitcoin as bT, Transaction } from '@atomicfinance/types';
+import { BitcoinNetwork } from 'bitcoin-networks';
+declare const AddressTypes: string[];
+declare function calculateFee(numInputs: number, numOutputs: number, feePerByte: number): number;
+/**
+ * Get compressed pubKey from pubKey.
+ * @param {!string} pubKey - 65 byte string with prefix, x, y.
+ * @return {string} Returns the compressed pubKey of uncompressed pubKey.
+ */
+declare function compressPubKey(pubKey: string): string;
+/**
+ * Get a network object from an address
+ * @param {string} address The bitcoin address
+ * @return {Network}
+ */
+declare function getAddressNetwork(address: string): BitcoinNetwork;
+declare type CoinSelectTarget = {
+    value: number;
+    script?: Buffer;
+    id?: string;
+};
+declare function selectCoins(utxos: bT.UTXO[], targets: CoinSelectTarget[], feePerByte: number, fixedInputs?: bT.UTXO[]): {
+    inputs: bT.UTXO[];
+    outputs: CoinSelectTarget[];
+    fee: number;
+    change: any;
+};
+declare function decodeRawTransaction(hex: string, network: BitcoinNetwork): bT.Transaction;
+declare function normalizeTransactionObject(tx: bT.Transaction, fee: number, block?: {
+    number: number;
+    hash: string;
+}): Transaction<bT.Transaction>;
+declare function witnessStackToScriptWitness(witness: Buffer[]): Buffer;
+declare function getPubKeyHash(address: string, network: BitcoinNetwork): Buffer;
+declare function validateAddress(_address: Address | string, network: BitcoinNetwork): void;
+export { calculateFee, compressPubKey, getAddressNetwork, CoinSelectTarget, selectCoins, decodeRawTransaction, normalizeTransactionObject, witnessStackToScriptWitness, AddressTypes, getPubKeyHash, validateAddress, };

package/dist/index.js

@@ -0,0 +1,239 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateAddress = exports.getPubKeyHash = exports.AddressTypes = exports.witnessStackToScriptWitness = exports.normalizeTransactionObject = exports.decodeRawTransaction = exports.selectCoins = exports.getAddressNetwork = exports.compressPubKey = exports.calculateFee = void 0;
+const crypto_1 = require("@atomicfinance/crypto");
+const errors_1 = require("@atomicfinance/errors");
+const types_1 = require("@atomicfinance/types");
+const utils_1 = require("@atomicfinance/utils");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const varuint = __importStar(require("bip174/src/lib/converter/varint"));
+const bitcoin_networks_1 = require("bitcoin-networks");
+const bitcoin = __importStar(require("bitcoinjs-lib"));
+const classify = __importStar(require("bitcoinjs-lib/src/classify"));
+const coinselect_1 = __importDefault(require("coinselect"));
+const accumulative_1 = __importDefault(require("coinselect/accumulative"));
+const lodash_1 = require("lodash");
+const AddressTypes = ['legacy', 'p2sh-segwit', 'bech32'];
+exports.AddressTypes = AddressTypes;
+function calculateFee(numInputs, numOutputs, feePerByte) {
+    return (numInputs * 148 + numOutputs * 34 + 10) * feePerByte;
+}
+exports.calculateFee = calculateFee;
+/**
+ * Get compressed pubKey from pubKey.
+ * @param {!string} pubKey - 65 byte string with prefix, x, y.
+ * @return {string} Returns the compressed pubKey of uncompressed pubKey.
+ */
+function compressPubKey(pubKey) {
+    const x = pubKey.substring(2, 66);
+    const y = pubKey.substring(66, 130);
+    const even = parseInt(y.substring(62, 64), 16) % 2 === 0;
+    const prefix = even ? '02' : '03';
+    return prefix + x;
+}
+exports.compressPubKey = compressPubKey;
+/**
+ * Get a network object from an address
+ * @param {string} address The bitcoin address
+ * @return {Network}
+ */
+function getAddressNetwork(address) {
+    // TODO: can this be simplified using just bitcoinjs-lib??
+    let networkKey;
+    // bech32
+    networkKey = lodash_1.findKey(bitcoin_networks_1.BitcoinNetworks, (network) => address.startsWith(network.bech32));
+    // base58
+    if (!networkKey) {
+        const prefix = crypto_1.base58.decode(address).toString('hex').substring(0, 2);
+        networkKey = lodash_1.findKey(bitcoin_networks_1.BitcoinNetworks, (network) => {
+            const pubKeyHashPrefix = crypto_1.padHexStart(network.pubKeyHash.toString(16), 1);
+            const scriptHashPrefix = crypto_1.padHexStart(network.scriptHash.toString(16), 1);
+            return [pubKeyHashPrefix, scriptHashPrefix].includes(prefix);
+        });
+    }
+    return bitcoin_networks_1.BitcoinNetworks[networkKey];
+}
+exports.getAddressNetwork = getAddressNetwork;
+function selectCoins(utxos, targets, feePerByte, fixedInputs = []) {
+    let selectUtxos = utxos;
+    // Default coinselect won't accumulate some inputs
+    // TODO: does coinselect need to be modified to ABSOLUTELY not skip an input?
+    const coinselectStrat = fixedInputs.length
+        ? accumulative_1.default
+        : coinselect_1.default;
+    if (fixedInputs.length) {
+        selectUtxos = [
+            // Order fixed inputs to the start of the list so they are used
+            ...fixedInputs,
+            ...utxos.filter((utxo) => !fixedInputs.find((input) => input.vout === utxo.vout && input.txid === utxo.txid)),
+        ];
+    }
+    const { inputs, outputs, fee } = coinselectStrat(selectUtxos, targets, Math.ceil(feePerByte));
+    let change;
+    if (inputs && outputs) {
+        change = outputs.find((output) => output.id !== 'main');
+    }
+    return { inputs, outputs, fee, change };
+}
+exports.selectCoins = selectCoins;
+const OUTPUT_TYPES_MAP = {
+    [classify.types.P2WPKH]: 'witness_v0_keyhash',
+    [classify.types.P2WSH]: 'witness_v0_scripthash',
+};
+function decodeRawTransaction(hex, network) {
+    const bjsTx = bitcoin.Transaction.fromHex(hex);
+    const vin = bjsTx.ins.map((input) => {
+        return {
+            txid: Buffer.from(input.hash).reverse().toString('hex'),
+            vout: input.index,
+            scriptSig: {
+                asm: bitcoin.script.toASM(input.script),
+                hex: input.script.toString('hex'),
+            },
+            txinwitness: input.witness.map((w) => w.toString('hex')),
+            sequence: input.sequence,
+        };
+    });
+    const vout = bjsTx.outs.map((output, n) => {
+        const type = classify.output(output.script);
+        const vout = {
+            value: output.value / 1e8,
+            n,
+            scriptPubKey: {
+                asm: bitcoin.script.toASM(output.script),
+                hex: output.script.toString('hex'),
+                reqSigs: 1,
+                type: OUTPUT_TYPES_MAP[type] || type,
+                addresses: [],
+            },
+        };
+        try {
+            const address = bitcoin.address.fromOutputScript(output.script, network);
+            vout.scriptPubKey.addresses.push(address);
+        }
+        catch (e) {
+            /** If output script is not parasable, we just skip it */
+        }
+        return vout;
+    });
+    return {
+        txid: bjsTx.getHash(false).reverse().toString('hex'),
+        hash: bjsTx.getHash(true).reverse().toString('hex'),
+        version: bjsTx.version,
+        locktime: bjsTx.locktime,
+        size: bjsTx.byteLength(),
+        vsize: bjsTx.virtualSize(),
+        weight: bjsTx.weight(),
+        vin,
+        vout,
+        hex,
+    };
+}
+exports.decodeRawTransaction = decodeRawTransaction;
+function normalizeTransactionObject(tx, fee, block) {
+    const value = tx.vout.reduce((p, n) => p.plus(new bignumber_js_1.default(n.value).times(1e8)), new bignumber_js_1.default(0));
+    const result = {
+        hash: tx.txid,
+        value: value.toNumber(),
+        _raw: tx,
+        confirmations: 0,
+        status: tx.confirmations > 0 ? types_1.TxStatus.Success : types_1.TxStatus.Pending,
+    };
+    if (fee) {
+        const feePrice = Math.round(fee / tx.vsize);
+        Object.assign(result, {
+            fee,
+            feePrice,
+        });
+    }
+    if (block) {
+        Object.assign(result, {
+            blockHash: block.hash,
+            blockNumber: block.number,
+            confirmations: tx.confirmations,
+        });
+    }
+    return result;
+}
+exports.normalizeTransactionObject = normalizeTransactionObject;
+// TODO: This is copy pasta because it's not exported from bitcoinjs-lib
+// https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/csv.spec.ts#L477
+function witnessStackToScriptWitness(witness) {
+    let buffer = Buffer.allocUnsafe(0);
+    function writeSlice(slice) {
+        buffer = Buffer.concat([buffer, Buffer.from(slice)]);
+    }
+    function writeVarInt(i) {
+        const currentLen = buffer.length;
+        const varintLen = varuint.encodingLength(i);
+        buffer = Buffer.concat([buffer, Buffer.allocUnsafe(varintLen)]);
+        varuint.encode(i, buffer, currentLen);
+    }
+    function writeVarSlice(slice) {
+        writeVarInt(slice.length);
+        writeSlice(slice);
+    }
+    function writeVector(vector) {
+        writeVarInt(vector.length);
+        vector.forEach(writeVarSlice);
+    }
+    writeVector(witness);
+    return buffer;
+}
+exports.witnessStackToScriptWitness = witnessStackToScriptWitness;
+function getPubKeyHash(address, network) {
+    const outputScript = bitcoin.address.toOutputScript(address, network);
+    const type = classify.output(outputScript);
+    if (![classify.types.P2PKH, classify.types.P2WPKH].includes(type)) {
+        throw new Error(`Bitcoin swap doesn't support the address ${address} type of ${type}. Not possible to derive public key hash.`);
+    }
+    try {
+        const bech32 = bitcoin.address.fromBech32(address);
+        return bech32.data;
+    }
+    catch (e) {
+        const base58 = bitcoin.address.fromBase58Check(address);
+        return base58.hash;
+    }
+}
+exports.getPubKeyHash = getPubKeyHash;
+function validateAddress(_address, network) {
+    const address = utils_1.addressToString(_address);
+    if (typeof address !== 'string') {
+        throw new errors_1.InvalidAddressError(`Invalid address: ${address}`);
+    }
+    let pubKeyHash;
+    try {
+        pubKeyHash = getPubKeyHash(address, network);
+    }
+    catch (e) {
+        throw new errors_1.InvalidAddressError(`Invalid Address. Failed to parse: ${address}`);
+    }
+    if (!pubKeyHash) {
+        throw new errors_1.InvalidAddressError(`Invalid Address: ${address}`);
+    }
+}
+exports.validateAddress = validateAddress;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA4D;AAC5D,kDAA4D;AAC5D,gDAK8B;AAC9B,gDAAuD;AACvD,gEAAqC;AACrC,yEAA2D;AAC3D,uDAAmE;AACnE,uDAAyC;AACzC,qEAAuD;AACvD,4DAAoC;AACpC,2EAA6D;AAC7D,mCAAiC;AAEjC,MAAM,YAAY,GAAG,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;AA8RvD,oCAAY;AA5Rd,SAAS,YAAY,CACnB,SAAiB,EACjB,UAAkB,EAClB,UAAkB;IAElB,OAAO,CAAC,SAAS,GAAG,GAAG,GAAG,UAAU,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC;AAC/D,CAAC;AA8QC,oCAAY;AA5Qd;;;;GAIG;AACH,SAAS,cAAc,CAAC,MAAc;IACpC,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAClC,MAAM,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAElC,OAAO,MAAM,GAAG,CAAC,CAAC;AACpB,CAAC;AAiQC,wCAAc;AA/PhB;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,OAAe;IACxC,0DAA0D;IAC1D,IAAI,UAAU,CAAC;IACf,SAAS;IACT,UAAU,GAAG,gBAAO,CAAC,kCAAe,EAAE,CAAC,OAAO,EAAE,EAAE,CAChD,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CACnC,CAAC;IACF,SAAS;IACT,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,MAAM,GAAG,eAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACtE,UAAU,GAAG,gBAAO,CAAC,kCAAe,EAAE,CAAC,OAAO,EAAE,EAAE;YAChD,MAAM,gBAAgB,GAAG,oBAAW,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YACzE,MAAM,gBAAgB,GAAG,oBAAW,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YACzE,OAAO,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;KACJ;IACD,OAAQ,kCAAqD,CAAC,UAAU,CAAC,CAAC;AAC5E,CAAC;AA0OC,8CAAiB;AArNnB,SAAS,WAAW,CAClB,KAAgB,EAChB,OAA2B,EAC3B,UAAkB,EAClB,cAAyB,EAAE;IAE3B,IAAI,WAAW,GAAG,KAAK,CAAC;IAExB,kDAAkD;IAClD,6EAA6E;IAC7E,MAAM,eAAe,GAAuB,WAAW,CAAC,MAAM;QAC5D,CAAC,CAAC,sBAAsB;QACxB,CAAC,CAAC,oBAAU,CAAC;IACf,IAAI,WAAW,CAAC,MAAM,EAAE;QACtB,WAAW,GAAG;YACZ,+DAA+D;YAC/D,GAAG,WAAW;YACd,GAAG,KAAK,CAAC,MAAM,CACb,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,WAAW,CAAC,IAAI,CACf,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAChE,CACJ;SACF,CAAC;KACH;IAED,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,eAAe,CAC9C,WAAW,EACX,OAAO,EACP,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CACtB,CAAC;IAEF,IAAI,MAAM,CAAC;IACX,IAAI,MAAM,IAAI,OAAO,EAAE;QACrB,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;KACzD;IAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;AAC1C,CAAC;AAiLC,kCAAW;AA/Kb,MAAM,gBAAgB,GAAG;IACvB,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,oBAAoB;IAC7C,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,uBAAuB;CAChD,CAAC;AAEF,SAAS,oBAAoB,CAC3B,GAAW,EACX,OAAuB;IAEvB,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAE/C,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAClC,OAAiB;YACf,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;YACvD,IAAI,EAAE,KAAK,CAAC,KAAK;YACjB,SAAS,EAAE;gBACT,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;gBACvC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;aAClC;YACD,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACxD,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACxC,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,IAAI,GAAc;YACtB,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,GAAG;YACzB,CAAC;YACD,YAAY,EAAE;gBACZ,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;gBACxC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAClC,OAAO,EAAE,CAAC;gBACV,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,IAAI;gBACpC,SAAS,EAAE,EAAE;aACd;SACF,CAAC;QAEF,IAAI;YACF,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YACzE,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC3C;QAAC,OAAO,CAAC,EAAE;YACV,yDAAyD;SAC1D;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;QACpD,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;QACnD,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE;QACxB,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE;QAC1B,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE;QACtB,GAAG;QACH,IAAI;QACJ,GAAG;KACJ,CAAC;AACJ,CAAC;AAmHC,oDAAoB;AAjHtB,SAAS,0BAA0B,CACjC,EAAkB,EAClB,GAAW,EACX,KAAwC;IAExC,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAC1B,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,sBAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EACnD,IAAI,sBAAS,CAAC,CAAC,CAAC,CACjB,CAAC;IACF,MAAM,MAAM,GAAG;QACb,IAAI,EAAE,EAAE,CAAC,IAAI;QACb,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;QACvB,IAAI,EAAE,EAAE;QACR,aAAa,EAAE,CAAC;QAChB,MAAM,EAAE,EAAE,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,gBAAQ,CAAC,OAAO;KACnE,CAAC;IAEF,IAAI,GAAG,EAAE;QACP,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;YACpB,GAAG;YACH,QAAQ;SACT,CAAC,CAAC;KACJ;IAED,IAAI,KAAK,EAAE;QACT,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;YACpB,SAAS,EAAE,KAAK,CAAC,IAAI;YACrB,WAAW,EAAE,KAAK,CAAC,MAAM;YACzB,aAAa,EAAE,EAAE,CAAC,aAAa;SAChC,CAAC,CAAC;KACJ;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAgFC,gEAA0B;AA9E5B,wEAAwE;AACxE,2FAA2F;AAC3F,SAAS,2BAA2B,CAAC,OAAiB;IACpD,IAAI,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAEnC,SAAS,UAAU,CAAC,KAAa;QAC/B,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,SAAS,WAAW,CAAC,CAAS;QAC5B,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC;QACjC,MAAM,SAAS,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QAE5C,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAChE,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IACxC,CAAC;IAED,SAAS,aAAa,CAAC,KAAa;QAClC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1B,UAAU,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,SAAS,WAAW,CAAC,MAAgB;QACnC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAChC,CAAC;IAED,WAAW,CAAC,OAAO,CAAC,CAAC;IAErB,OAAO,MAAM,CAAC;AAChB,CAAC;AAiDC,kEAA2B;AA/C7B,SAAS,aAAa,CAAC,OAAe,EAAE,OAAuB;IAC7D,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACtE,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC3C,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACjE,MAAM,IAAI,KAAK,CACb,4CAA4C,OAAO,YAAY,IAAI,2CAA2C,CAC/G,CAAC;KACH;IAED,IAAI;QACF,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,MAAM,CAAC,IAAI,CAAC;KACpB;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC,IAAI,CAAC;KACpB;AACH,CAAC;AAiCC,sCAAa;AA/Bf,SAAS,eAAe,CAAC,QAA0B,EAAE,OAAuB;IAC1E,MAAM,OAAO,GAAG,uBAAe,CAAC,QAAQ,CAAC,CAAC;IAE1C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,MAAM,IAAI,4BAAmB,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;KAC9D;IAED,IAAI,UAAU,CAAC;IACf,IAAI;QACF,UAAU,GAAG,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;KAC9C;IAAC,OAAO,CAAC,EAAE;QACV,MAAM,IAAI,4BAAmB,CAC3B,qCAAqC,OAAO,EAAE,CAC/C,CAAC;KACH;IAED,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,4BAAmB,CAAC,oBAAoB,OAAO,EAAE,CAAC,CAAC;KAC9D;AACH,CAAC;AAaC,0CAAe"}

package/lib/bitcoinjs-lib-classify.d.ts

@@ -0,0 +1 @@
+declare module 'bitcoinjs-lib/src/classify'

package/lib/coinselect-accumulative.d.ts

@@ -0,0 +1 @@
+declare module 'coinselect/accumulative'

package/lib/coinselect.d.ts

@@ -0,0 +1 @@
+declare module 'coinselect'

package/lib/index.ts

@@ -0,0 +1,308 @@
+import { base58, padHexStart } from '@atomicfinance/crypto';
+import { InvalidAddressError } from '@atomicfinance/errors';
+import {
+  Address,
+  bitcoin as bT,
+  Transaction,
+  TxStatus,
+} from '@atomicfinance/types';
+import { addressToString } from '@atomicfinance/utils';
+import BigNumber from 'bignumber.js';
+import * as varuint from 'bip174/src/lib/converter/varint';
+import { BitcoinNetwork, BitcoinNetworks } from 'bitcoin-networks';
+import * as bitcoin from 'bitcoinjs-lib';
+import * as classify from 'bitcoinjs-lib/src/classify';
+import coinselect from 'coinselect';
+import coinselectAccumulative from 'coinselect/accumulative';
+import { findKey } from 'lodash';
+
+const AddressTypes = ['legacy', 'p2sh-segwit', 'bech32'];
+
+function calculateFee(
+  numInputs: number,
+  numOutputs: number,
+  feePerByte: number,
+) {
+  return (numInputs * 148 + numOutputs * 34 + 10) * feePerByte;
+}
+
+/**
+ * Get compressed pubKey from pubKey.
+ * @param {!string} pubKey - 65 byte string with prefix, x, y.
+ * @return {string} Returns the compressed pubKey of uncompressed pubKey.
+ */
+function compressPubKey(pubKey: string) {
+  const x = pubKey.substring(2, 66);
+  const y = pubKey.substring(66, 130);
+  const even = parseInt(y.substring(62, 64), 16) % 2 === 0;
+  const prefix = even ? '02' : '03';
+
+  return prefix + x;
+}
+
+/**
+ * Get a network object from an address
+ * @param {string} address The bitcoin address
+ * @return {Network}
+ */
+function getAddressNetwork(address: string) {
+  // TODO: can this be simplified using just bitcoinjs-lib??
+  let networkKey;
+  // bech32
+  networkKey = findKey(BitcoinNetworks, (network) =>
+    address.startsWith(network.bech32),
+  );
+  // base58
+  if (!networkKey) {
+    const prefix = base58.decode(address).toString('hex').substring(0, 2);
+    networkKey = findKey(BitcoinNetworks, (network) => {
+      const pubKeyHashPrefix = padHexStart(network.pubKeyHash.toString(16), 1);
+      const scriptHashPrefix = padHexStart(network.scriptHash.toString(16), 1);
+      return [pubKeyHashPrefix, scriptHashPrefix].includes(prefix);
+    });
+  }
+  return (BitcoinNetworks as { [key: string]: BitcoinNetwork })[networkKey];
+}
+
+type CoinSelectTarget = {
+  value: number;
+  script?: Buffer;
+  id?: string;
+};
+
+type CoinSelectResponse = {
+  inputs: bT.UTXO[];
+  outputs: CoinSelectTarget[];
+  change: CoinSelectTarget;
+  fee: number;
+};
+
+type CoinSelectFunction = (
+  utxos: bT.UTXO[],
+  targets: CoinSelectTarget[],
+  feePerByte: number,
+) => CoinSelectResponse;
+
+function selectCoins(
+  utxos: bT.UTXO[],
+  targets: CoinSelectTarget[],
+  feePerByte: number,
+  fixedInputs: bT.UTXO[] = [],
+) {
+  let selectUtxos = utxos;
+
+  // Default coinselect won't accumulate some inputs
+  // TODO: does coinselect need to be modified to ABSOLUTELY not skip an input?
+  const coinselectStrat: CoinSelectFunction = fixedInputs.length
+    ? coinselectAccumulative
+    : coinselect;
+  if (fixedInputs.length) {
+    selectUtxos = [
+      // Order fixed inputs to the start of the list so they are used
+      ...fixedInputs,
+      ...utxos.filter(
+        (utxo) =>
+          !fixedInputs.find(
+            (input) => input.vout === utxo.vout && input.txid === utxo.txid,
+          ),
+      ),
+    ];
+  }
+
+  const { inputs, outputs, fee } = coinselectStrat(
+    selectUtxos,
+    targets,
+    Math.ceil(feePerByte),
+  );
+
+  let change;
+  if (inputs && outputs) {
+    change = outputs.find((output) => output.id !== 'main');
+  }
+
+  return { inputs, outputs, fee, change };
+}
+
+const OUTPUT_TYPES_MAP = {
+  [classify.types.P2WPKH]: 'witness_v0_keyhash',
+  [classify.types.P2WSH]: 'witness_v0_scripthash',
+};
+
+function decodeRawTransaction(
+  hex: string,
+  network: BitcoinNetwork,
+): bT.Transaction {
+  const bjsTx = bitcoin.Transaction.fromHex(hex);
+
+  const vin = bjsTx.ins.map((input) => {
+    return <bT.Input>{
+      txid: Buffer.from(input.hash).reverse().toString('hex'),
+      vout: input.index,
+      scriptSig: {
+        asm: bitcoin.script.toASM(input.script),
+        hex: input.script.toString('hex'),
+      },
+      txinwitness: input.witness.map((w) => w.toString('hex')),
+      sequence: input.sequence,
+    };
+  });
+
+  const vout = bjsTx.outs.map((output, n) => {
+    const type = classify.output(output.script);
+
+    const vout: bT.Output = {
+      value: output.value / 1e8,
+      n,
+      scriptPubKey: {
+        asm: bitcoin.script.toASM(output.script),
+        hex: output.script.toString('hex'),
+        reqSigs: 1, // TODO: not sure how to derive this
+        type: OUTPUT_TYPES_MAP[type] || type,
+        addresses: [],
+      },
+    };
+
+    try {
+      const address = bitcoin.address.fromOutputScript(output.script, network);
+      vout.scriptPubKey.addresses.push(address);
+    } catch (e) {
+      /** If output script is not parasable, we just skip it */
+    }
+
+    return vout;
+  });
+
+  return {
+    txid: bjsTx.getHash(false).reverse().toString('hex'),
+    hash: bjsTx.getHash(true).reverse().toString('hex'),
+    version: bjsTx.version,
+    locktime: bjsTx.locktime,
+    size: bjsTx.byteLength(),
+    vsize: bjsTx.virtualSize(),
+    weight: bjsTx.weight(),
+    vin,
+    vout,
+    hex,
+  };
+}
+
+function normalizeTransactionObject(
+  tx: bT.Transaction,
+  fee: number,
+  block?: { number: number; hash: string },
+): Transaction<bT.Transaction> {
+  const value = tx.vout.reduce(
+    (p, n) => p.plus(new BigNumber(n.value).times(1e8)),
+    new BigNumber(0),
+  );
+  const result = {
+    hash: tx.txid,
+    value: value.toNumber(),
+    _raw: tx,
+    confirmations: 0,
+    status: tx.confirmations > 0 ? TxStatus.Success : TxStatus.Pending,
+  };
+
+  if (fee) {
+    const feePrice = Math.round(fee / tx.vsize);
+    Object.assign(result, {
+      fee,
+      feePrice,
+    });
+  }
+
+  if (block) {
+    Object.assign(result, {
+      blockHash: block.hash,
+      blockNumber: block.number,
+      confirmations: tx.confirmations,
+    });
+  }
+
+  return result;
+}
+
+// TODO: This is copy pasta because it's not exported from bitcoinjs-lib
+// https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/test/integration/csv.spec.ts#L477
+function witnessStackToScriptWitness(witness: Buffer[]): Buffer {
+  let buffer = Buffer.allocUnsafe(0);
+
+  function writeSlice(slice: Buffer): void {
+    buffer = Buffer.concat([buffer, Buffer.from(slice)]);
+  }
+
+  function writeVarInt(i: number): void {
+    const currentLen = buffer.length;
+    const varintLen = varuint.encodingLength(i);
+
+    buffer = Buffer.concat([buffer, Buffer.allocUnsafe(varintLen)]);
+    varuint.encode(i, buffer, currentLen);
+  }
+
+  function writeVarSlice(slice: Buffer): void {
+    writeVarInt(slice.length);
+    writeSlice(slice);
+  }
+
+  function writeVector(vector: Buffer[]): void {
+    writeVarInt(vector.length);
+    vector.forEach(writeVarSlice);
+  }
+
+  writeVector(witness);
+
+  return buffer;
+}
+
+function getPubKeyHash(address: string, network: BitcoinNetwork) {
+  const outputScript = bitcoin.address.toOutputScript(address, network);
+  const type = classify.output(outputScript);
+  if (![classify.types.P2PKH, classify.types.P2WPKH].includes(type)) {
+    throw new Error(
+      `Bitcoin swap doesn't support the address ${address} type of ${type}. Not possible to derive public key hash.`,
+    );
+  }
+
+  try {
+    const bech32 = bitcoin.address.fromBech32(address);
+    return bech32.data;
+  } catch (e) {
+    const base58 = bitcoin.address.fromBase58Check(address);
+    return base58.hash;
+  }
+}
+
+function validateAddress(_address: Address | string, network: BitcoinNetwork) {
+  const address = addressToString(_address);
+
+  if (typeof address !== 'string') {
+    throw new InvalidAddressError(`Invalid address: ${address}`);
+  }
+
+  let pubKeyHash;
+  try {
+    pubKeyHash = getPubKeyHash(address, network);
+  } catch (e) {
+    throw new InvalidAddressError(
+      `Invalid Address. Failed to parse: ${address}`,
+    );
+  }
+
+  if (!pubKeyHash) {
+    throw new InvalidAddressError(`Invalid Address: ${address}`);
+  }
+}
+
+export {
+  calculateFee,
+  compressPubKey,
+  getAddressNetwork,
+  CoinSelectTarget,
+  selectCoins,
+  decodeRawTransaction,
+  normalizeTransactionObject,
+  witnessStackToScriptWitness,
+  AddressTypes,
+  getPubKeyHash,
+  validateAddress,
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@atomicfinance/bitcoin-utils",
+  "version": "3.0.0",
+  "description": "",
+  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "directories": {
+    "dist": "dist",
+    "src": "lib"
+  },
+  "files": [
+    "dist",
+    "lib"
+  ],
+  "scripts": {
+    "build": "../../node_modules/.bin/tsc --project tsconfig.json",
+    "lint": "../../node_modules/.bin/eslint --ignore-path ../../.eslintignore  -c ../../.eslintrc.js .",
+    "lint:fix": "../../node_modules/.bin/eslint --fix --ignore-path ../../.eslintignore  -c ../../.eslintrc.js .",
+    "test": "../../node_modules/.bin/nyc --reporter=lcov --reporter=text --extension=.ts ../../node_modules/.bin/mocha --recursive \"tests/**/*.test.*\""
+  },
+  "author": "Atomic Finance <info@atomic.finance>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=14"
+  },
+  "dependencies": {
+    "@atomicfinance/crypto": "^3.0.0",
+    "@atomicfinance/errors": "^3.0.0",
+    "@atomicfinance/types": "^3.0.0",
+    "@atomicfinance/utils": "^3.0.0",
+    "@babel/runtime": "^7.12.1",
+    "bignumber.js": "^9.0.0",
+    "bip174": "^2.0.1",
+    "bitcoin-networks": "^1.0.0",
+    "bitcoinjs-lib": "^5.2.0",
+    "coinselect": "^3.1.11",
+    "lodash": "^4.17.20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/bitcoinjs-lib": "^5.0.0",
+    "@types/lodash": "^4.14.168",
+    "@types/node": "16.10.3"
+  },
+  "sideEffects": false
+}