@atomicfinance/bitcoin-rpc-provider 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# @atomicfinance/bitcoin-rpc-provider
+
+## 3.0.0
+
+### Major Changes
+
+- 2edf70f: Port over bitcoin RPC related providers
+
+### Patch Changes
+
+- Updated dependencies [2edf70f]
+- Updated dependencies [a06082e]
+  - @atomicfinance/jsonrpc-provider@3.0.0
+  - @atomicfinance/types@3.0.0
+  - @atomicfinance/bitcoin-utils@3.0.0
+  - @atomicfinance/errors@3.0.0
+  - @atomicfinance/utils@3.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Liquality
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/BitcoinRpcProvider.d.ts

@@ -0,0 +1,45 @@
+import { JsonRpcProvider } from '@atomicfinance/jsonrpc-provider';
+import { Address, BigNumber, bitcoin, BitcoinJsonRpcTypes, Block, ChainProvider, SendOptions, Transaction } from '@atomicfinance/types';
+import { BitcoinNetwork } from 'bitcoin-networks';
+interface ProviderOptions {
+    uri: string;
+    username?: string;
+    password?: string;
+    network: BitcoinNetwork;
+    feeBlockConfirmations?: number;
+    defaultFeePerByte?: number;
+}
+export default class BitcoinRpcProvider extends JsonRpcProvider implements Partial<ChainProvider> {
+    _feeBlockConfirmations: number;
+    _defaultFeePerByte: number;
+    _network: BitcoinNetwork;
+    _usedAddressCache: {
+        [key: string]: boolean;
+    };
+    constructor(options: ProviderOptions);
+    decodeRawTransaction(rawTransaction: string): Promise<bitcoin.Transaction>;
+    getFeePerByte(numberOfBlocks?: number): Promise<number>;
+    getMinRelayFee(): Promise<number>;
+    getBalance(_addresses: (string | Address)[]): Promise<BigNumber>;
+    getUnspentTransactions(_addresses: (Address | string)[]): Promise<bitcoin.UTXO[]>;
+    getAddressTransactionCounts(_addresses: (Address | string)[]): Promise<bitcoin.AddressTxCounts>;
+    getReceivedByAddress(address: string): Promise<number>;
+    importAddresses(addresses: string[]): Promise<any>;
+    getTransactionHex(transactionHash: string): Promise<string>;
+    generateBlock(numberOfBlocks: number): Promise<any>;
+    getBlockByHash(blockHash: string, includeTx?: boolean): Promise<Block>;
+    getBlockByNumber(blockNumber: number, includeTx?: boolean): Promise<Block<any>>;
+    getBlockHeight(): Promise<any>;
+    getTransactionByHash(transactionHash: string): Promise<Transaction<bitcoin.Transaction>>;
+    getTransactionFee(tx: bitcoin.Transaction): Promise<number>;
+    getParsedTransactionByHash(transactionHash: string, addFees?: boolean): Promise<Transaction<bitcoin.Transaction>>;
+    getRawTransactionByHash(transactionHash: string): Promise<string>;
+    sendRawTransaction(rawTransaction: string): Promise<string>;
+    sendBatchTransaction(transactions: SendOptions[]): Promise<Transaction<bitcoin.Transaction>>;
+    signRawTransaction(hexstring: string): Promise<any>;
+    createRawTransaction(transactions: [], outputs: {
+        [index: string]: number;
+    }): Promise<string>;
+    fundRawTransaction(hexstring: string): Promise<BitcoinJsonRpcTypes.FundRawResponse>;
+}
+export {};

package/dist/BitcoinRpcProvider.js

@@ -0,0 +1,206 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bitcoin_utils_1 = require("@atomicfinance/bitcoin-utils");
+const errors_1 = require("@atomicfinance/errors");
+const jsonrpc_provider_1 = require("@atomicfinance/jsonrpc-provider");
+const types_1 = require("@atomicfinance/types");
+const utils_1 = require("@atomicfinance/utils");
+const lodash_1 = require("lodash");
+class BitcoinRpcProvider extends jsonrpc_provider_1.JsonRpcProvider {
+    constructor(options) {
+        const { uri, username, password, network, feeBlockConfirmations = 1, defaultFeePerByte = 3, } = options;
+        super(uri, username, password);
+        this._network = network;
+        this._feeBlockConfirmations = feeBlockConfirmations;
+        this._defaultFeePerByte = defaultFeePerByte;
+        this._usedAddressCache = {};
+    }
+    async decodeRawTransaction(rawTransaction) {
+        return this.jsonrpc('decoderawtransaction', rawTransaction);
+    }
+    async getFeePerByte(numberOfBlocks = this._feeBlockConfirmations) {
+        try {
+            const { feerate } = await this.jsonrpc('estimatesmartfee', numberOfBlocks);
+            if (feerate && feerate > 0) {
+                return Math.ceil((feerate * 1e8) / 1000);
+            }
+            throw new Error('Invalid estimated fee');
+        }
+        catch (e) {
+            return this._defaultFeePerByte;
+        }
+    }
+    async getMinRelayFee() {
+        const { relayfee } = await this.jsonrpc('getnetworkinfo');
+        return (relayfee * 1e8) / 1000;
+    }
+    async getBalance(_addresses) {
+        const addresses = _addresses.map(utils_1.addressToString);
+        const _utxos = await this.getUnspentTransactions(addresses);
+        const utxos = lodash_1.flatten(_utxos);
+        return utxos.reduce((acc, utxo) => acc.plus(utxo.value), new types_1.BigNumber(0));
+    }
+    async getUnspentTransactions(_addresses) {
+        const addresses = _addresses.map(utils_1.addressToString);
+        const utxos = await this.jsonrpc('listunspent', 0, 9999999, addresses);
+        return utxos.map((utxo) => ({
+            ...utxo,
+            value: new types_1.BigNumber(utxo.amount).times(1e8).toNumber(),
+        }));
+    }
+    async getAddressTransactionCounts(_addresses) {
+        const addresses = _addresses.map(utils_1.addressToString);
+        const receivedAddresses = await this.jsonrpc('listreceivedbyaddress', 0, false, true);
+        return addresses.reduce((acc, addr) => {
+            const receivedAddress = receivedAddresses.find((receivedAddress) => receivedAddress.address === addr);
+            const transactionCount = receivedAddress
+                ? receivedAddress.txids.length
+                : 0;
+            acc[addr] = transactionCount;
+            return acc;
+        }, {});
+    }
+    async getReceivedByAddress(address) {
+        return this.jsonrpc('getreceivedbyaddress', address);
+    }
+    async importAddresses(addresses) {
+        const request = addresses.map((address) => ({
+            scriptPubKey: { address },
+            timestamp: 0,
+        }));
+        return this.jsonrpc('importmulti', request);
+    }
+    async getTransactionHex(transactionHash) {
+        return this.jsonrpc('getrawtransaction', transactionHash);
+    }
+    async generateBlock(numberOfBlocks) {
+        const miningAddressLabel = 'miningAddress';
+        let address;
+        try {
+            // Avoid creating 100s of addresses for mining
+            const labelAddresses = await this.jsonrpc('getaddressesbylabel', miningAddressLabel);
+            address = Object.keys(labelAddresses)[0];
+        }
+        catch (e) {
+            // Label does not exist
+            address = await this.jsonrpc('getnewaddress', miningAddressLabel);
+        }
+        return this.jsonrpc('generatetoaddress', numberOfBlocks, address);
+    }
+    async getBlockByHash(blockHash, includeTx = false) {
+        let data;
+        try {
+            data = await this.jsonrpc('getblock', blockHash); // TODO: This doesn't fit the interface?: https://chainquery.com/bitcoin-cli/getblock
+        }
+        catch (e) {
+            if (e.name === 'NodeError' && e.message.includes('Block not found')) {
+                const { name, message, ...attrs } = e;
+                throw new errors_1.BlockNotFoundError(`Block not found: ${blockHash}`, attrs);
+            }
+            throw e;
+        }
+        const { hash, height: number, mediantime: timestamp, difficulty, size, previousblockhash: parentHash, nonce, tx: transactionHashes, } = data;
+        let transactions = transactionHashes;
+        // TODO: Why transactions need to be retrieved individually? getblock has verbose 2 https://chainquery.com/bitcoin-cli/getblock
+        if (includeTx) {
+            const txs = transactionHashes.map((hash) => this.getTransactionByHash(hash));
+            transactions = await Promise.all(txs);
+        }
+        return {
+            hash,
+            number,
+            timestamp,
+            difficulty: parseFloat(new types_1.BigNumber(difficulty).toFixed()),
+            size,
+            parentHash,
+            nonce,
+            transactions,
+        };
+    }
+    async getBlockByNumber(blockNumber, includeTx = false) {
+        let blockHash;
+        try {
+            blockHash = await this.jsonrpc('getblockhash', blockNumber);
+        }
+        catch (e) {
+            if (e.name === 'NodeError' &&
+                e.message.includes('Block height out of range')) {
+                const { name, message, ...attrs } = e;
+                throw new errors_1.BlockNotFoundError(`Block not found: ${blockNumber}`, attrs);
+            }
+            throw e;
+        }
+        return this.getBlockByHash(blockHash, includeTx);
+    }
+    async getBlockHeight() {
+        return this.jsonrpc('getblockcount');
+    }
+    async getTransactionByHash(transactionHash) {
+        try {
+            const tx = await this.getParsedTransactionByHash(transactionHash, true);
+            return tx;
+        }
+        catch (e) {
+            if (e.name === 'NodeError' &&
+                e.message.includes('No such mempool transaction')) {
+                const { name, message, ...attrs } = e;
+                throw new errors_1.TxNotFoundError(`Transaction not found: ${transactionHash}`, attrs);
+            }
+            throw e;
+        }
+    }
+    async getTransactionFee(tx) {
+        const isCoinbaseTx = tx.vin.find((vin) => vin.coinbase);
+        if (isCoinbaseTx)
+            return; // Coinbase transactions do not have a fee
+        const inputs = tx.vin.map((vin) => ({ txid: vin.txid, vout: vin.vout }));
+        const inputTransactions = await Promise.all(inputs.map((input) => this.jsonrpc('getrawtransaction', input.txid, 1)));
+        const inputValues = inputTransactions.map((inputTx, index) => {
+            const vout = inputs[index].vout;
+            const output = inputTx.vout[vout];
+            return output.value * 1e8;
+        });
+        const inputValue = inputValues.reduce((a, b) => a.plus(new types_1.BigNumber(b)), new types_1.BigNumber(0));
+        const outputValue = tx.vout.reduce((a, b) => a.plus(new types_1.BigNumber(b.value).times(new types_1.BigNumber(1e8))), new types_1.BigNumber(0));
+        const feeValue = inputValue.minus(outputValue);
+        return feeValue.toNumber();
+    }
+    async getParsedTransactionByHash(transactionHash, addFees = false) {
+        const tx = await this.jsonrpc('getrawtransaction', transactionHash, 1);
+        return bitcoin_utils_1.normalizeTransactionObject(tx, addFees ? await this.getTransactionFee(tx) : undefined, tx.confirmations > 0
+            ? await this.getBlockByHash(tx.blockhash)
+            : undefined);
+    }
+    async getRawTransactionByHash(transactionHash) {
+        const tx = await this.jsonrpc('getrawtransaction', transactionHash, 0);
+        return tx;
+    }
+    async sendRawTransaction(rawTransaction) {
+        return this.jsonrpc('sendrawtransaction', rawTransaction);
+    }
+    async sendBatchTransaction(transactions) {
+        const outputs = {};
+        for (const tx of transactions) {
+            outputs[utils_1.addressToString(tx.to)] = new types_1.BigNumber(tx.value)
+                .dividedBy(1e8)
+                .toNumber();
+        }
+        const rawTxOutputs = await this.createRawTransaction([], outputs);
+        const rawTxFunded = await this.fundRawTransaction(rawTxOutputs);
+        const rawTxSigned = await this.signRawTransaction(rawTxFunded.hex);
+        const fee = new types_1.BigNumber(rawTxFunded.fee).times(1e8).toNumber();
+        await this.sendRawTransaction(rawTxSigned.hex);
+        return bitcoin_utils_1.normalizeTransactionObject(bitcoin_utils_1.decodeRawTransaction(rawTxSigned.hex, this._network), fee);
+    }
+    async signRawTransaction(hexstring) {
+        return this.jsonrpc('signrawtransactionwithwallet', hexstring);
+    }
+    async createRawTransaction(transactions, outputs) {
+        return this.jsonrpc('createrawtransaction', transactions, outputs);
+    }
+    async fundRawTransaction(hexstring) {
+        return this.jsonrpc('fundrawtransaction', hexstring);
+    }
+}
+exports.default = BitcoinRpcProvider;
+//# sourceMappingURL=BitcoinRpcProvider.js.map

package/dist/BitcoinRpcProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitcoinRpcProvider.js","sourceRoot":"","sources":["../lib/BitcoinRpcProvider.ts"],"names":[],"mappings":";;AAAA,gEAGsC;AACtC,kDAA4E;AAC5E,sEAAkE;AAClE,gDAS8B;AAC9B,gDAAuD;AAEvD,mCAAiC;AAiBjC,MAAqB,kBACnB,SAAQ,kCAAe;IAOvB,YAAY,OAAwB;QAClC,MAAM,EACJ,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,qBAAqB,GAAG,CAAC,EACzB,iBAAiB,GAAG,CAAC,GACtB,GAAG,OAAO,CAAC;QACZ,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,sBAAsB,GAAG,qBAAqB,CAAC;QACpD,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;QAC5C,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,cAAsB;QAEtB,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,cAAc,CAAC,CAAC;IAC9D,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,cAAc,GAAG,IAAI,CAAC,sBAAsB;QAC9D,IAAI;YACF,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CACpC,kBAAkB,EAClB,cAAc,CACf,CAAC;YAEF,IAAI,OAAO,IAAI,OAAO,GAAG,CAAC,EAAE;gBAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;aAC1C;YAED,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;SAC1C;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,IAAI,CAAC,kBAAkB,CAAC;SAChC;IACH,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC1D,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,UAAgC;QAC/C,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,uBAAe,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;QAC5D,MAAM,KAAK,GAAG,gBAAO,CAAC,MAAM,CAAC,CAAC;QAE9B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,iBAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,sBAAsB,CAC1B,UAAgC;QAEhC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,uBAAe,CAAC,CAAC;QAClD,MAAM,KAAK,GAA+B,MAAM,IAAI,CAAC,OAAO,CAC1D,aAAa,EACb,CAAC,EACD,OAAO,EACP,SAAS,CACV,CAAC;QACF,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,GAAG,IAAI;YACP,KAAK,EAAE,IAAI,iBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;SACxD,CAAC,CAAC,CAAC;IACN,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,UAAgC;QAChE,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,uBAAe,CAAC,CAAC;QAClD,MAAM,iBAAiB,GAA4C,MAAM,IAAI,CAAC,OAAO,CACnF,uBAAuB,EACvB,CAAC,EACD,KAAK,EACL,IAAI,CACL,CAAC;QACF,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,GAA4B,EAAE,IAAI,EAAE,EAAE;YAC7D,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAC5C,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAC,OAAO,KAAK,IAAI,CACtD,CAAC;YACF,MAAM,gBAAgB,GAAG,eAAe;gBACtC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,MAAM;gBAC9B,CAAC,CAAC,CAAC,CAAC;YACN,GAAG,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;YAC7B,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,OAAe;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,SAAmB;QACvC,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC1C,YAAY,EAAE,EAAE,OAAO,EAAE;YACzB,SAAS,EAAE,CAAC;SACb,CAAC,CAAC,CAAC;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,eAAuB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,cAAsB;QACxC,MAAM,kBAAkB,GAAG,eAAe,CAAC;QAC3C,IAAI,OAAO,CAAC;QACZ,IAAI;YACF,8CAA8C;YAC9C,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CACvC,qBAAqB,EACrB,kBAAkB,CACnB,CAAC;YACF,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C;QAAC,OAAO,CAAC,EAAE;YACV,uBAAuB;YACvB,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;SACnE;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,SAAiB,EAAE,SAAS,GAAG,KAAK;QACvD,IAAI,IAA+B,CAAC;QAEpC,IAAI;YACF,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,qFAAqF;SACxI;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE;gBACnE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC;gBACtC,MAAM,IAAI,2BAAkB,CAAC,oBAAoB,SAAS,EAAE,EAAE,KAAK,CAAC,CAAC;aACtE;YAED,MAAM,CAAC,CAAC;SACT;QAED,MAAM,EACJ,IAAI,EACJ,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,SAAS,EACrB,UAAU,EACV,IAAI,EACJ,iBAAiB,EAAE,UAAU,EAC7B,KAAK,EACL,EAAE,EAAE,iBAAiB,GACtB,GAAG,IAAI,CAAC;QAET,IAAI,YAAY,GAAU,iBAAiB,CAAC;QAC5C,+HAA+H;QAC/H,IAAI,SAAS,EAAE;YACb,MAAM,GAAG,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACzC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAChC,CAAC;YACF,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACvC;QAED,OAAO;YACL,IAAI;YACJ,MAAM;YACN,SAAS;YACT,UAAU,EAAE,UAAU,CAAC,IAAI,iBAAS,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC;YAC3D,IAAI;YACJ,UAAU;YACV,KAAK;YACL,YAAY;SACb,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,WAAmB,EAAE,SAAS,GAAG,KAAK;QAC3D,IAAI,SAAS,CAAC;QAEd,IAAI;YACF,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;SAC7D;QAAC,OAAO,CAAC,EAAE;YACV,IACE,CAAC,CAAC,IAAI,KAAK,WAAW;gBACtB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAC,EAC/C;gBACA,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC;gBACtC,MAAM,IAAI,2BAAkB,CAAC,oBAAoB,WAAW,EAAE,EAAE,KAAK,CAAC,CAAC;aACxE;YAED,MAAM,CAAC,CAAC;SACT;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,eAAuB;QAChD,IAAI;YACF,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YACxE,OAAO,EAAE,CAAC;SACX;QAAC,OAAO,CAAC,EAAE;YACV,IACE,CAAC,CAAC,IAAI,KAAK,WAAW;gBACtB,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAC,EACjD;gBACA,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC;gBACtC,MAAM,IAAI,wBAAe,CACvB,0BAA0B,eAAe,EAAE,EAC3C,KAAK,CACN,CAAC;aACH;YAED,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAuB;QAC7C,MAAM,YAAY,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,YAAY;YAAE,OAAO,CAAC,0CAA0C;QAEpE,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACzE,MAAM,iBAAiB,GAAG,MAAM,OAAO,CAAC,GAAG,CACzC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CACxE,CAAC;QAEF,MAAM,WAAW,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;YAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YAChC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClC,OAAO,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,CACnC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,iBAAS,CAAC,CAAC,CAAC,CAAC,EAClC,IAAI,iBAAS,CAAC,CAAC,CAAC,CACjB,CAAC;QACF,MAAM,WAAW,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,iBAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,iBAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAClE,IAAI,iBAAS,CAAC,CAAC,CAAC,CACjB,CAAC;QACF,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC/C,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,0BAA0B,CAC9B,eAAuB,EACvB,OAAO,GAAG,KAAK;QAEf,MAAM,EAAE,GAAyC,MAAM,IAAI,CAAC,OAAO,CACjE,mBAAmB,EACnB,eAAe,EACf,CAAC,CACF,CAAC;QACF,OAAO,0CAA0B,CAC/B,EAAE,EACF,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,EACtD,EAAE,CAAC,aAAa,GAAG,CAAC;YAClB,CAAC,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,SAAS,CAAC;YACzC,CAAC,CAAC,SAAS,CACd,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,eAAuB;QACnD,MAAM,EAAE,GAAW,MAAM,IAAI,CAAC,OAAO,CACnC,mBAAmB,EACnB,eAAe,EACf,CAAC,CACF,CAAC;QACF,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,cAAsB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,YAA2B;QACpD,MAAM,OAAO,GAAgC,EAAE,CAAC;QAChD,KAAK,MAAM,EAAE,IAAI,YAAY,EAAE;YAC7B,OAAO,CAAC,uBAAe,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,iBAAS,CAAC,EAAE,CAAC,KAAK,CAAC;iBACtD,SAAS,CAAC,GAAG,CAAC;iBACd,QAAQ,EAAE,CAAC;SACf;QACD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAClE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACnE,MAAM,GAAG,GAAG,IAAI,iBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QACjE,MAAM,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC/C,OAAO,0CAA0B,CAC/B,oCAAoB,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,EACpD,GAAG,CACJ,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,SAAiB;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,8BAA8B,EAAE,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,YAAgB,EAChB,OAAoC;QAEpC,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,SAAiB;QAEjB,OAAO,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAC;IACvD,CAAC;CACF;AAtTD,qCAsTC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import BitcoinRpcProvider from './BitcoinRpcProvider';
+export { BitcoinRpcProvider };

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitcoinRpcProvider = void 0;
+const BitcoinRpcProvider_1 = __importDefault(require("./BitcoinRpcProvider"));
+exports.BitcoinRpcProvider = BitcoinRpcProvider_1.default;
+//# 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,8EAAsD;AAE7C,6BAFF,4BAAkB,CAEE"}

package/lib/BitcoinRpcProvider.ts

@@ -0,0 +1,346 @@
+import {
+  decodeRawTransaction,
+  normalizeTransactionObject,
+} from '@atomicfinance/bitcoin-utils';
+import { BlockNotFoundError, TxNotFoundError } from '@atomicfinance/errors';
+import { JsonRpcProvider } from '@atomicfinance/jsonrpc-provider';
+import {
+  Address,
+  BigNumber,
+  bitcoin,
+  BitcoinJsonRpcTypes,
+  Block,
+  ChainProvider,
+  SendOptions,
+  Transaction,
+} from '@atomicfinance/types';
+import { addressToString } from '@atomicfinance/utils';
+import { BitcoinNetwork } from 'bitcoin-networks';
+import { flatten } from 'lodash';
+
+interface ProviderOptions {
+  // RPC URI
+  uri: string;
+  // Authentication username
+  username?: string;
+  // Authentication password
+  password?: string;
+  // Bitcoin network
+  network: BitcoinNetwork;
+  // Number of block confirmations to target for fee. Defaul: 1
+  feeBlockConfirmations?: number;
+  // Default fee per byte for transactions. Default: 3
+  defaultFeePerByte?: number;
+}
+
+export default class BitcoinRpcProvider
+  extends JsonRpcProvider
+  implements Partial<ChainProvider> {
+  _feeBlockConfirmations: number;
+  _defaultFeePerByte: number;
+  _network: BitcoinNetwork;
+  _usedAddressCache: { [key: string]: boolean };
+
+  constructor(options: ProviderOptions) {
+    const {
+      uri,
+      username,
+      password,
+      network,
+      feeBlockConfirmations = 1,
+      defaultFeePerByte = 3,
+    } = options;
+    super(uri, username, password);
+    this._network = network;
+    this._feeBlockConfirmations = feeBlockConfirmations;
+    this._defaultFeePerByte = defaultFeePerByte;
+    this._usedAddressCache = {};
+  }
+
+  async decodeRawTransaction(
+    rawTransaction: string,
+  ): Promise<bitcoin.Transaction> {
+    return this.jsonrpc('decoderawtransaction', rawTransaction);
+  }
+
+  async getFeePerByte(numberOfBlocks = this._feeBlockConfirmations) {
+    try {
+      const { feerate } = await this.jsonrpc(
+        'estimatesmartfee',
+        numberOfBlocks,
+      );
+
+      if (feerate && feerate > 0) {
+        return Math.ceil((feerate * 1e8) / 1000);
+      }
+
+      throw new Error('Invalid estimated fee');
+    } catch (e) {
+      return this._defaultFeePerByte;
+    }
+  }
+
+  async getMinRelayFee() {
+    const { relayfee } = await this.jsonrpc('getnetworkinfo');
+    return (relayfee * 1e8) / 1000;
+  }
+
+  async getBalance(_addresses: (string | Address)[]) {
+    const addresses = _addresses.map(addressToString);
+    const _utxos = await this.getUnspentTransactions(addresses);
+    const utxos = flatten(_utxos);
+
+    return utxos.reduce((acc, utxo) => acc.plus(utxo.value), new BigNumber(0));
+  }
+
+  async getUnspentTransactions(
+    _addresses: (Address | string)[],
+  ): Promise<bitcoin.UTXO[]> {
+    const addresses = _addresses.map(addressToString);
+    const utxos: BitcoinJsonRpcTypes.UTXO[] = await this.jsonrpc(
+      'listunspent',
+      0,
+      9999999,
+      addresses,
+    );
+    return utxos.map((utxo) => ({
+      ...utxo,
+      value: new BigNumber(utxo.amount).times(1e8).toNumber(),
+    }));
+  }
+
+  async getAddressTransactionCounts(_addresses: (Address | string)[]) {
+    const addresses = _addresses.map(addressToString);
+    const receivedAddresses: BitcoinJsonRpcTypes.ReceivedByAddress[] = await this.jsonrpc(
+      'listreceivedbyaddress',
+      0,
+      false,
+      true,
+    );
+    return addresses.reduce((acc: bitcoin.AddressTxCounts, addr) => {
+      const receivedAddress = receivedAddresses.find(
+        (receivedAddress) => receivedAddress.address === addr,
+      );
+      const transactionCount = receivedAddress
+        ? receivedAddress.txids.length
+        : 0;
+      acc[addr] = transactionCount;
+      return acc;
+    }, {});
+  }
+
+  async getReceivedByAddress(address: string): Promise<number> {
+    return this.jsonrpc('getreceivedbyaddress', address);
+  }
+
+  async importAddresses(addresses: string[]) {
+    const request = addresses.map((address) => ({
+      scriptPubKey: { address },
+      timestamp: 0,
+    }));
+    return this.jsonrpc('importmulti', request);
+  }
+
+  async getTransactionHex(transactionHash: string): Promise<string> {
+    return this.jsonrpc('getrawtransaction', transactionHash);
+  }
+
+  async generateBlock(numberOfBlocks: number) {
+    const miningAddressLabel = 'miningAddress';
+    let address;
+    try {
+      // Avoid creating 100s of addresses for mining
+      const labelAddresses = await this.jsonrpc(
+        'getaddressesbylabel',
+        miningAddressLabel,
+      );
+      address = Object.keys(labelAddresses)[0];
+    } catch (e) {
+      // Label does not exist
+      address = await this.jsonrpc('getnewaddress', miningAddressLabel);
+    }
+    return this.jsonrpc('generatetoaddress', numberOfBlocks, address);
+  }
+
+  async getBlockByHash(blockHash: string, includeTx = false): Promise<Block> {
+    let data: BitcoinJsonRpcTypes.Block;
+
+    try {
+      data = await this.jsonrpc('getblock', blockHash); // TODO: This doesn't fit the interface?: https://chainquery.com/bitcoin-cli/getblock
+    } catch (e) {
+      if (e.name === 'NodeError' && e.message.includes('Block not found')) {
+        const { name, message, ...attrs } = e;
+        throw new BlockNotFoundError(`Block not found: ${blockHash}`, attrs);
+      }
+
+      throw e;
+    }
+
+    const {
+      hash,
+      height: number,
+      mediantime: timestamp,
+      difficulty,
+      size,
+      previousblockhash: parentHash,
+      nonce,
+      tx: transactionHashes,
+    } = data;
+
+    let transactions: any[] = transactionHashes;
+    // TODO: Why transactions need to be retrieved individually? getblock has verbose 2 https://chainquery.com/bitcoin-cli/getblock
+    if (includeTx) {
+      const txs = transactionHashes.map((hash) =>
+        this.getTransactionByHash(hash),
+      );
+      transactions = await Promise.all(txs);
+    }
+
+    return {
+      hash,
+      number,
+      timestamp,
+      difficulty: parseFloat(new BigNumber(difficulty).toFixed()),
+      size,
+      parentHash,
+      nonce,
+      transactions,
+    };
+  }
+
+  async getBlockByNumber(blockNumber: number, includeTx = false) {
+    let blockHash;
+
+    try {
+      blockHash = await this.jsonrpc('getblockhash', blockNumber);
+    } catch (e) {
+      if (
+        e.name === 'NodeError' &&
+        e.message.includes('Block height out of range')
+      ) {
+        const { name, message, ...attrs } = e;
+        throw new BlockNotFoundError(`Block not found: ${blockNumber}`, attrs);
+      }
+
+      throw e;
+    }
+
+    return this.getBlockByHash(blockHash, includeTx);
+  }
+
+  async getBlockHeight() {
+    return this.jsonrpc('getblockcount');
+  }
+
+  async getTransactionByHash(transactionHash: string) {
+    try {
+      const tx = await this.getParsedTransactionByHash(transactionHash, true);
+      return tx;
+    } catch (e) {
+      if (
+        e.name === 'NodeError' &&
+        e.message.includes('No such mempool transaction')
+      ) {
+        const { name, message, ...attrs } = e;
+        throw new TxNotFoundError(
+          `Transaction not found: ${transactionHash}`,
+          attrs,
+        );
+      }
+
+      throw e;
+    }
+  }
+
+  async getTransactionFee(tx: bitcoin.Transaction) {
+    const isCoinbaseTx = tx.vin.find((vin) => vin.coinbase);
+    if (isCoinbaseTx) return; // Coinbase transactions do not have a fee
+
+    const inputs = tx.vin.map((vin) => ({ txid: vin.txid, vout: vin.vout }));
+    const inputTransactions = await Promise.all(
+      inputs.map((input) => this.jsonrpc('getrawtransaction', input.txid, 1)),
+    );
+
+    const inputValues = inputTransactions.map((inputTx, index) => {
+      const vout = inputs[index].vout;
+      const output = inputTx.vout[vout];
+      return output.value * 1e8;
+    });
+    const inputValue = inputValues.reduce(
+      (a, b) => a.plus(new BigNumber(b)),
+      new BigNumber(0),
+    );
+    const outputValue = tx.vout.reduce(
+      (a, b) => a.plus(new BigNumber(b.value).times(new BigNumber(1e8))),
+      new BigNumber(0),
+    );
+    const feeValue = inputValue.minus(outputValue);
+    return feeValue.toNumber();
+  }
+
+  async getParsedTransactionByHash(
+    transactionHash: string,
+    addFees = false,
+  ): Promise<Transaction<bitcoin.Transaction>> {
+    const tx: BitcoinJsonRpcTypes.MinedTransaction = await this.jsonrpc(
+      'getrawtransaction',
+      transactionHash,
+      1,
+    );
+    return normalizeTransactionObject(
+      tx,
+      addFees ? await this.getTransactionFee(tx) : undefined,
+      tx.confirmations > 0
+        ? await this.getBlockByHash(tx.blockhash)
+        : undefined,
+    );
+  }
+
+  async getRawTransactionByHash(transactionHash: string) {
+    const tx: string = await this.jsonrpc(
+      'getrawtransaction',
+      transactionHash,
+      0,
+    );
+    return tx;
+  }
+
+  async sendRawTransaction(rawTransaction: string): Promise<string> {
+    return this.jsonrpc('sendrawtransaction', rawTransaction);
+  }
+
+  async sendBatchTransaction(transactions: SendOptions[]) {
+    const outputs: { [index: string]: number } = {};
+    for (const tx of transactions) {
+      outputs[addressToString(tx.to)] = new BigNumber(tx.value)
+        .dividedBy(1e8)
+        .toNumber();
+    }
+    const rawTxOutputs = await this.createRawTransaction([], outputs);
+    const rawTxFunded = await this.fundRawTransaction(rawTxOutputs);
+    const rawTxSigned = await this.signRawTransaction(rawTxFunded.hex);
+    const fee = new BigNumber(rawTxFunded.fee).times(1e8).toNumber();
+    await this.sendRawTransaction(rawTxSigned.hex);
+    return normalizeTransactionObject(
+      decodeRawTransaction(rawTxSigned.hex, this._network),
+      fee,
+    );
+  }
+
+  async signRawTransaction(hexstring: string) {
+    return this.jsonrpc('signrawtransactionwithwallet', hexstring);
+  }
+
+  async createRawTransaction(
+    transactions: [],
+    outputs: { [index: string]: number },
+  ): Promise<string> {
+    return this.jsonrpc('createrawtransaction', transactions, outputs);
+  }
+
+  async fundRawTransaction(
+    hexstring: string,
+  ): Promise<BitcoinJsonRpcTypes.FundRawResponse> {
+    return this.jsonrpc('fundrawtransaction', hexstring);
+  }
+}

package/lib/index.ts

@@ -0,0 +1,3 @@
+import BitcoinRpcProvider from './BitcoinRpcProvider';
+
+export { BitcoinRpcProvider };

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@atomicfinance/bitcoin-rpc-provider",
+  "version": "3.0.0",
+  "description": "",
+  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "types": "dist/lib/index.d.ts",
+  "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/bitcoin-utils": "^3.0.0",
+    "@atomicfinance/errors": "^3.0.0",
+    "@atomicfinance/jsonrpc-provider": "^3.0.0",
+    "@atomicfinance/types": "^3.0.0",
+    "@atomicfinance/utils": "^3.0.0",
+    "@babel/runtime": "^7.12.1",
+    "bignumber.js": "^9.0.0",
+    "bitcoin-networks": "^1.0.0",
+    "lodash": "^4.17.20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.168"
+  },
+  "sideEffects": false
+}