@xchainjs/xchain-bitcoin 0.15.12 → 0.17.1

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v.0.17.1 (2022-02-04)
+
+## Update
+
+- xchain-util@0.5.1
+- xchain-client@0.11.1
+
+# v.0.17.0 (2022-01-05)
+
+## Breaking change
+
+- Make `haskoinUrl` configurable (change default haskoin url back to `https://api.haskoin.com/btc`)
+- `haskoinUrl` needs to be passed as parameter into misc. `utils` functions
+
+# v.0.16.0 (2021-12-29)
+
+## Breaking change
+
+- Add stagenet environment handling for `Network` and `BaseXChainClient` changes client to default to mainnet values until stagenet is configured.
+
+# v.0.15.13 (2021-11-12)
+
+- updated haskoin api URL
+
 # v.0.15.12 (2021-09-03)
 
 - updated to the latest dependencies

package/lib/client.d.ts

@@ -1,7 +1,9 @@
 import { Address, Balance, Fee, FeeRate, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, UTXOClient, XChainClientParams } from '@xchainjs/xchain-client';
+import { ClientUrl } from './types/client-types';
 export declare type BitcoinClientParams = XChainClientParams & {
     sochainUrl?: string;
     blockstreamUrl?: string;
+    haskoinUrl?: ClientUrl;
 };
 /**
  * Custom Bitcoin client
@@ -9,13 +11,14 @@ export declare type BitcoinClientParams = XChainClientParams & {
 declare class Client extends UTXOClient {
     private sochainUrl;
     private blockstreamUrl;
+    private haskoinUrl;
     /**
      * Constructor
      * Client is initialised with network type
      *
      * @param {BitcoinClientParams} params
      */
-    constructor({ network, sochainUrl, blockstreamUrl, rootDerivationPaths, phrase, }: BitcoinClientParams);
+    constructor({ network, sochainUrl, blockstreamUrl, haskoinUrl, rootDerivationPaths, phrase, }: BitcoinClientParams);
     /**
      * Set/Update the sochain url.
      *

package/lib/haskoin-api.d.ts

@@ -14,6 +14,15 @@ export declare type BalanceData = {
     txs: number;
     received: number;
 };
-export declare const getBalance: (address: string) => Promise<BaseAmount>;
-export declare const getUnspentTxs: (address: string) => Promise<UtxoData[]>;
-export declare const getConfirmedUnspentTxs: (address: string) => Promise<UtxoData[]>;
+export declare const getBalance: ({ haskoinUrl, address, }: {
+    haskoinUrl: string;
+    address: string;
+}) => Promise<BaseAmount>;
+export declare const getUnspentTxs: ({ haskoinUrl, address, }: {
+    haskoinUrl: string;
+    address: string;
+}) => Promise<UtxoData[]>;
+export declare const getConfirmedUnspentTxs: ({ haskoinUrl, address, }: {
+    haskoinUrl: string;
+    address: string;
+}) => Promise<UtxoData[]>;

package/lib/index.esm.js

@@ -85118,6 +85118,7 @@ var DEFAULT_SUGGESTED_TRANSACTION_FEE = 127;
 var toSochainNetwork = function (network) {
     switch (network) {
         case Network.Mainnet:
+        case Network.Stagenet:
             return 'BTC';
         case Network.Testnet:
             return 'BTCTEST';
@@ -85480,6 +85481,7 @@ var broadcastTx = function (_a) {
                     url = (function () {
                         switch (network) {
                             case Network.Mainnet:
+                            case Network.Stagenet:
                                 return blockstreamUrl + "/api/tx";
                             case Network.Testnet:
                                 return blockstreamUrl + "/testnet/api/tx";
@@ -85494,64 +85496,72 @@ var broadcastTx = function (_a) {
     });
 };
 
-var HASKOIN_API_URL = 'https://api.haskoin.com/btc';
 var SOCHAIN_API_URL = 'https://sochain.com/api/v2';
-var getBalance$1 = function (address) { return __awaiter(void 0, void 0, void 0, function () {
-    var _a, confirmed, unconfirmed, confirmedAmount, unconfirmedAmount;
-    return __generator(this, function (_b) {
-        switch (_b.label) {
-            case 0: return [4 /*yield*/, axios.get(HASKOIN_API_URL + "/address/" + address + "/balance")];
-            case 1:
-                _a = (_b.sent()).data, confirmed = _a.confirmed, unconfirmed = _a.unconfirmed;
-                confirmedAmount = baseAmount(confirmed, BTC_DECIMAL);
-                unconfirmedAmount = baseAmount(unconfirmed, BTC_DECIMAL);
-                return [2 /*return*/, confirmedAmount.plus(unconfirmedAmount)];
-        }
+var getBalance$1 = function (_a) {
+    var haskoinUrl = _a.haskoinUrl, address = _a.address;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var _b, confirmed, unconfirmed, confirmedAmount, unconfirmedAmount;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0: return [4 /*yield*/, axios.get(haskoinUrl + "/address/" + address + "/balance")];
+                case 1:
+                    _b = (_c.sent()).data, confirmed = _b.confirmed, unconfirmed = _b.unconfirmed;
+                    confirmedAmount = baseAmount(confirmed, BTC_DECIMAL);
+                    unconfirmedAmount = baseAmount(unconfirmed, BTC_DECIMAL);
+                    return [2 /*return*/, confirmedAmount.plus(unconfirmedAmount)];
+            }
+        });
     });
-}); };
-var getUnspentTxs$1 = function (address) { return __awaiter(void 0, void 0, void 0, function () {
-    var response;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, axios.get(HASKOIN_API_URL + "/address/" + address + "/unspent")];
-            case 1:
-                response = (_a.sent()).data;
-                return [2 /*return*/, response];
-        }
+};
+var getUnspentTxs$1 = function (_a) {
+    var haskoinUrl = _a.haskoinUrl, address = _a.address;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var response;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, axios.get(haskoinUrl + "/address/" + address + "/unspent")];
+                case 1:
+                    response = (_b.sent()).data;
+                    return [2 /*return*/, response];
+            }
+        });
     });
-}); };
-var getConfirmedUnspentTxs$1 = function (address) { return __awaiter(void 0, void 0, void 0, function () {
-    var allUtxos, confirmedUTXOs;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, getUnspentTxs$1(address)];
-            case 1:
-                allUtxos = _a.sent();
-                confirmedUTXOs = [];
-                return [4 /*yield*/, Promise.all(allUtxos.map(function (tx) { return __awaiter(void 0, void 0, void 0, function () {
-                        var isTxConfirmed;
-                        return __generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0: return [4 /*yield*/, getIsTxConfirmed({
-                                        sochainUrl: SOCHAIN_API_URL,
-                                        network: Network.Mainnet,
-                                        hash: tx.txid,
-                                    })];
-                                case 1:
-                                    isTxConfirmed = (_a.sent()).is_confirmed;
-                                    if (isTxConfirmed) {
-                                        confirmedUTXOs.push(tx);
-                                    }
-                                    return [2 /*return*/];
-                            }
-                        });
-                    }); }))];
-            case 2:
-                _a.sent();
-                return [2 /*return*/, confirmedUTXOs];
-        }
+};
+var getConfirmedUnspentTxs$1 = function (_a) {
+    var haskoinUrl = _a.haskoinUrl, address = _a.address;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var allUtxos, confirmedUTXOs;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, getUnspentTxs$1({ haskoinUrl: haskoinUrl, address: address })];
+                case 1:
+                    allUtxos = _b.sent();
+                    confirmedUTXOs = [];
+                    return [4 /*yield*/, Promise.all(allUtxos.map(function (tx) { return __awaiter(void 0, void 0, void 0, function () {
+                            var isTxConfirmed;
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, getIsTxConfirmed({
+                                            sochainUrl: SOCHAIN_API_URL,
+                                            network: Network.Mainnet,
+                                            hash: tx.txid,
+                                        })];
+                                    case 1:
+                                        isTxConfirmed = (_a.sent()).is_confirmed;
+                                        if (isTxConfirmed) {
+                                            confirmedUTXOs.push(tx);
+                                        }
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); }))];
+                case 2:
+                    _b.sent();
+                    return [2 /*return*/, confirmedUTXOs];
+            }
+        });
     });
-}); };
+};
 
 var TX_EMPTY_SIZE$1 = 4 + 1 + 1 + 4; //10
 var TX_INPUT_BASE$1 = 32 + 4 + 1 + 4; // 41
@@ -85603,6 +85613,7 @@ var getFee = function (inputs, feeRate, data) {
 var btcNetwork = function (network) {
     switch (network) {
         case Network.Mainnet:
+        case Network.Stagenet:
             return src_5$1.bitcoin;
         case Network.Testnet:
             return src_5$1.testnet;
@@ -85616,7 +85627,7 @@ var btcNetwork = function (network) {
  * @param {Address} address
  * @returns {Balance[]} The balances of the given address.
  */
-var getBalance$2 = function (params) { return __awaiter(void 0, void 0, void 0, function () {
+var getBalance$2 = function (params, haskoinUrl) { return __awaiter(void 0, void 0, void 0, function () {
     var _a;
     var _b, _c;
     return __generator(this, function (_d) {
@@ -85625,6 +85636,7 @@ var getBalance$2 = function (params) { return __awaiter(void 0, void 0, void 0,
                 _a = params.network;
                 switch (_a) {
                     case Network.Mainnet: return [3 /*break*/, 1];
+                    case Network.Stagenet: return [3 /*break*/, 1];
                     case Network.Testnet: return [3 /*break*/, 3];
                 }
                 return [3 /*break*/, 5];
@@ -85632,7 +85644,7 @@ var getBalance$2 = function (params) { return __awaiter(void 0, void 0, void 0,
                 _b = {
                     asset: AssetBTC
                 };
-                return [4 /*yield*/, getBalance$1(params.address)];
+                return [4 /*yield*/, getBalance$1({ haskoinUrl: haskoinUrl, address: params.address })];
             case 2: return [2 /*return*/, [
                     (_b.amount = _d.sent(),
                         _b)
@@ -85675,7 +85687,7 @@ var validateAddress = function (address, network) {
  * @returns {UTXO[]} The UTXOs of the given address.
  */
 var scanUTXOs = function (_a) {
-    var sochainUrl = _a.sochainUrl, network = _a.network, address = _a.address, _b = _a.confirmedOnly, confirmedOnly = _b === void 0 ? true : _b;
+    var sochainUrl = _a.sochainUrl, haskoinUrl = _a.haskoinUrl, network = _a.network, address = _a.address, _b = _a.confirmedOnly, confirmedOnly = _b === void 0 ? true : _b;
     return __awaiter(void 0, void 0, void 0, function () {
         var _c, utxos, addressParam, utxos;
         return __generator(this, function (_d) {
@@ -85685,6 +85697,7 @@ var scanUTXOs = function (_a) {
                     switch (_c) {
                         case Network.Testnet: return [3 /*break*/, 1];
                         case Network.Mainnet: return [3 /*break*/, 6];
+                        case Network.Stagenet: return [3 /*break*/, 6];
                     }
                     return [3 /*break*/, 11];
                 case 1:
@@ -85717,11 +85730,11 @@ var scanUTXOs = function (_a) {
                 case 6:
                     utxos = [];
                     if (!confirmedOnly) return [3 /*break*/, 8];
-                    return [4 /*yield*/, getConfirmedUnspentTxs$1(address)];
+                    return [4 /*yield*/, getConfirmedUnspentTxs$1({ address: address, haskoinUrl: haskoinUrl })];
                 case 7:
                     utxos = _d.sent();
                     return [3 /*break*/, 10];
-                case 8: return [4 /*yield*/, getUnspentTxs$1(address)];
+                case 8: return [4 /*yield*/, getUnspentTxs$1({ address: address, haskoinUrl: haskoinUrl })];
                 case 9:
                     utxos = _d.sent();
                     _d.label = 10;
@@ -85748,14 +85761,14 @@ var scanUTXOs = function (_a) {
  * @returns {Transaction}
  */
 var buildTx = function (_a) {
-    var amount = _a.amount, recipient = _a.recipient, memo = _a.memo, feeRate = _a.feeRate, sender = _a.sender, network = _a.network, sochainUrl = _a.sochainUrl, _b = _a.spendPendingUTXO, spendPendingUTXO = _b === void 0 ? false : _b;
+    var amount = _a.amount, recipient = _a.recipient, memo = _a.memo, feeRate = _a.feeRate, sender = _a.sender, network = _a.network, sochainUrl = _a.sochainUrl, haskoinUrl = _a.haskoinUrl, _b = _a.spendPendingUTXO, spendPendingUTXO = _b === void 0 ? false : _b;
     return __awaiter(void 0, void 0, void 0, function () {
         var confirmedOnly, utxos, feeRateWhole, compiledMemo, targetOutputs, _c, inputs, outputs, psbt;
         return __generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
                     confirmedOnly = !spendPendingUTXO;
-                    return [4 /*yield*/, scanUTXOs({ sochainUrl: sochainUrl, network: network, address: sender, confirmedOnly: confirmedOnly })];
+                    return [4 /*yield*/, scanUTXOs({ sochainUrl: sochainUrl, haskoinUrl: haskoinUrl, network: network, address: sender, confirmedOnly: confirmedOnly })];
                 case 1:
                     utxos = _d.sent();
                     if (utxos.length === 0)
@@ -85871,6 +85884,7 @@ var getDefaultFees = function () {
 var getPrefix = function (network) {
     switch (network) {
         case Network.Mainnet:
+        case Network.Stagenet:
             return 'bc1';
         case Network.Testnet:
             return 'tb1';
@@ -85889,16 +85903,22 @@ var Client = /** @class */ (function (_super) {
      * @param {BitcoinClientParams} params
      */
     function Client(_a) {
-        var _b;
-        var _c = _a.network, network = _c === void 0 ? Network.Testnet : _c, _d = _a.sochainUrl, sochainUrl = _d === void 0 ? 'https://sochain.com/api/v2' : _d, _e = _a.blockstreamUrl, blockstreamUrl = _e === void 0 ? 'https://blockstream.info' : _e, _f = _a.rootDerivationPaths, rootDerivationPaths = _f === void 0 ? (_b = {},
-            _b[Network.Mainnet] = "84'/0'/0'/0/",
-            _b[Network.Testnet] = "84'/1'/0'/0/",
-            _b) : _f, _g = _a.phrase, phrase = _g === void 0 ? '' : _g;
+        var _b, _c;
+        var _d = _a.network, network = _d === void 0 ? Network.Testnet : _d, _e = _a.sochainUrl, sochainUrl = _e === void 0 ? 'https://sochain.com/api/v2' : _e, _f = _a.blockstreamUrl, blockstreamUrl = _f === void 0 ? 'https://blockstream.info' : _f, _g = _a.haskoinUrl, haskoinUrl = _g === void 0 ? (_b = {},
+            _b[Network.Testnet] = 'https://api.haskoin.com/btctest',
+            _b[Network.Mainnet] = 'https://api.haskoin.com/btc',
+            _b[Network.Stagenet] = 'https://api.haskoin.com/btc',
+            _b) : _g, _h = _a.rootDerivationPaths, rootDerivationPaths = _h === void 0 ? (_c = {},
+            _c[Network.Mainnet] = "84'/0'/0'/0/",
+            _c[Network.Testnet] = "84'/1'/0'/0/",
+            _c[Network.Stagenet] = "84'/0'/0'/0/",
+            _c) : _h, _j = _a.phrase, phrase = _j === void 0 ? '' : _j;
         var _this = _super.call(this, Chain.Bitcoin, { network: network, rootDerivationPaths: rootDerivationPaths, phrase: phrase }) || this;
         _this.sochainUrl = '';
         _this.blockstreamUrl = '';
         _this.setSochainUrl(sochainUrl);
         _this.setBlockstreamUrl(blockstreamUrl);
+        _this.haskoinUrl = haskoinUrl;
         return _this;
     }
     /**
@@ -85927,6 +85947,7 @@ var Client = /** @class */ (function (_super) {
     Client.prototype.getExplorerUrl = function () {
         switch (this.network) {
             case Network.Mainnet:
+            case Network.Stagenet:
                 return 'https://blockstream.info';
             case Network.Testnet:
                 return 'https://blockstream.info/testnet';
@@ -86023,7 +86044,7 @@ var Client = /** @class */ (function (_super) {
                         sochainUrl: this.sochainUrl,
                         network: this.network,
                         address: address,
-                    })];
+                    }, this.haskoinUrl[this.network])];
             });
         });
     };
@@ -86165,7 +86186,7 @@ var Client = /** @class */ (function (_super) {
                     case 2:
                         feeRate = _a;
                         spendPendingUTXO = params.memo ? false : true;
-                        return [4 /*yield*/, buildTx(__assign(__assign({}, params), { feeRate: feeRate, sender: this.getAddress(fromAddressIndex), sochainUrl: this.sochainUrl, network: this.network, spendPendingUTXO: spendPendingUTXO }))];
+                        return [4 /*yield*/, buildTx(__assign(__assign({}, params), { feeRate: feeRate, sender: this.getAddress(fromAddressIndex), sochainUrl: this.sochainUrl, haskoinUrl: this.haskoinUrl[this.network], network: this.network, spendPendingUTXO: spendPendingUTXO }))];
                     case 3:
                         psbt = (_b.sent()).psbt;
                         btcKeys = this.getBtcKeys(this.phrase, fromAddressIndex);