@xchainjs/xchain-doge 0.1.2 → 0.2.0-alpha.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v.0.2.0 (2022-xx-xx)
+
+## Update
+
+- Fetch `txHex` optionally by scanning UTXOs #489
+- Cache list of `txHex`s in `getTxHexFromCache` to avoid same requests for same data #490
+- Export `buildTx` (from `utils`) and `getSendTxUrl` (from `blockcypher-api`)
+
+## Breaking change
+
+- Remove unspecific `AddressParams` type
+
 # v.0.1.2 (2022-02-04)
 
 - Use latest axios@0.25.0

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 export * from './types';
 export * from './client';
 export * from './const';
-export { broadcastTx, getDefaultFees, getDefaultFeesWithRates, validateAddress, calcFee, scanUTXOs, getPrefix, } from './utils';
+export { broadcastTx, buildTx, getDefaultFees, getDefaultFeesWithRates, validateAddress, calcFee, scanUTXOs, getPrefix, } from './utils';
+export { getSendTxUrl } from './blockcypher-api';
 export { createTxInfo } from './ledger';

package/lib/index.esm.js

@@ -64894,6 +64894,7 @@ var Chain;
     Chain["Polkadot"] = "POLKA";
     Chain["BitcoinCash"] = "BCH";
     Chain["Litecoin"] = "LTC";
+    Chain["Terra"] = "TERRA";
     Chain["Doge"] = "DOGE";
 })(Chain || (Chain = {}));
 var BNBChain = Chain.Binance;
@@ -64904,6 +64905,7 @@ var CosmosChain = Chain.Cosmos;
 var PolkadotChain = Chain.Polkadot;
 var BCHChain = Chain.BitcoinCash;
 var LTCChain = Chain.Litecoin;
+var LUNAChain = Chain.Terra;
 var DOGEChain = Chain.Doge;
 /**
  * Convert chain to string.
@@ -64924,6 +64926,7 @@ var chainToString = Object.assign(function (chainId) {
     _a[Chain.Binance] = 'Binance Chain',
     _a[Chain.Cosmos] = 'Cosmos',
     _a[Chain.Polkadot] = 'Polkadot',
+    _a[Chain.Terra] = 'Terra',
     _a[Chain.Doge] = 'Dogecoin',
     _a));
 
@@ -65053,34 +65056,40 @@ var assetToBase = function (asset) {
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetBNB = { chain: Chain.Binance, symbol: 'BNB', ticker: 'BNB' };
+var AssetBNB = { chain: Chain.Binance, symbol: 'BNB', ticker: 'BNB', synth: false };
 /**
  * Base "chain" asset on bitcoin main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetBTC = { chain: Chain.Bitcoin, symbol: 'BTC', ticker: 'BTC' };
+var AssetBTC = { chain: Chain.Bitcoin, symbol: 'BTC', ticker: 'BTC', synth: false };
 /**
  * Base "chain" asset on bitcoin cash main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetBCH = { chain: Chain.BitcoinCash, symbol: 'BCH', ticker: 'BCH' };
+var AssetBCH = { chain: Chain.BitcoinCash, symbol: 'BCH', ticker: 'BCH', synth: false };
 /**
  * Base "chain" asset on litecoin main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetLTC = { chain: Chain.Litecoin, symbol: 'LTC', ticker: 'LTC' };
+var AssetLTC = { chain: Chain.Litecoin, symbol: 'LTC', ticker: 'LTC', synth: false };
 /**
  * Dogecoin asset
  * Based on definition in Thorchain
  * @see https://gitlab.com/thorchain/thornode/-/blob/781-add-doge-chain/common/asset.go#L24
  */
-var AssetDOGE = { chain: Chain.Doge, symbol: 'DOGE', ticker: 'DOGE' };
+var AssetDOGE = { chain: Chain.Doge, symbol: 'DOGE', ticker: 'DOGE', synth: false };
+/**
+ * Luna asset
+ * Based on definition in Thorchain
+ * @see TBD
+ */
+var AssetLUNA = { chain: Chain.Terra, symbol: 'LUNA', ticker: 'LUNA', synth: false };
 var RUNE_TICKER = 'RUNE';
 /**
  * Base "chain" asset on ethereum main net.
@@ -65088,28 +65097,28 @@ var RUNE_TICKER = 'RUNE';
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetETH = { chain: Chain.Ethereum, symbol: 'ETH', ticker: 'ETH' };
+var AssetETH = { chain: Chain.Ethereum, symbol: 'ETH', ticker: 'ETH', synth: false };
 /**
  * Base "chain" asset for RUNE-67C on Binance test net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetRune67C = { chain: Chain.Binance, symbol: 'RUNE-67C', ticker: RUNE_TICKER };
+var AssetRune67C = { chain: Chain.Binance, symbol: 'RUNE-67C', ticker: RUNE_TICKER, synth: false };
 /**
  * Base "chain" asset for RUNE-B1A on Binance main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetRuneB1A = { chain: Chain.Binance, symbol: 'RUNE-B1A', ticker: RUNE_TICKER };
+var AssetRuneB1A = { chain: Chain.Binance, symbol: 'RUNE-B1A', ticker: RUNE_TICKER, synth: false };
 /**
  * Base "chain" asset on thorchain main net.
  *
  * Based on definition in Thorchain `common`
  * @see https://gitlab.com/thorchain/thornode/-/blob/master/common/asset.go#L12-24
  */
-var AssetRuneNative = { chain: Chain.THORChain, symbol: RUNE_TICKER, ticker: RUNE_TICKER };
+var AssetRuneNative = { chain: Chain.THORChain, symbol: RUNE_TICKER, ticker: RUNE_TICKER, synth: false };
 /**
  * Base "chain" asset for RUNE on ethereum main net.
  *
@@ -65120,6 +65129,7 @@ var AssetRuneERC20 = {
     chain: Chain.Ethereum,
     symbol: RUNE_TICKER + "-0x3155ba85d5f96b2d030a4966af206230e46849cb",
     ticker: RUNE_TICKER,
+    synth: false,
 };
 /**
  * Base "chain" asset for RUNE on ethereum main net.
@@ -65131,6 +65141,7 @@ var AssetRuneERC20Testnet = {
     chain: Chain.Ethereum,
     symbol: RUNE_TICKER + "-0xd601c6A3a36721320573885A8d8420746dA3d7A0",
     ticker: RUNE_TICKER,
+    synth: false,
 };
 /**
  * Currency symbols currently supported
@@ -86747,7 +86758,7 @@ var dogeNetwork = function (network) {
 /**
  * Get the balances of an address.
  *
- * @param {AddressParams} params
+ * @param params
  * @returns {Balance[]} The balances of the given address.
  */
 var getBalance$1 = function (params) { return __awaiter(void 0, void 0, void 0, function () {
@@ -86788,32 +86799,85 @@ var validateAddress = function (address, network) {
         return false;
     }
 };
+// Stores list of txHex in memory to avoid requesting same data
+var txHexMap = {};
+/**
+ * Helper to get `hex` of `Tx`
+ *
+ * It will try to get it from cache before requesting it from Sochain
+ */
+var getTxHex = function (_a) {
+    var txHash = _a.txHash, sochainUrl = _a.sochainUrl, network = _a.network;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var txHex, tx_hex;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    txHex = txHexMap[txHash];
+                    if (!!txHex)
+                        return [2 /*return*/, txHex
+                            // or get it from Sochain
+                        ];
+                    return [4 /*yield*/, getTx({ hash: txHash, sochainUrl: sochainUrl, network: network })
+                        // cache it
+                    ];
+                case 1:
+                    tx_hex = (_b.sent()).tx_hex;
+                    // cache it
+                    txHexMap[txHash] = tx_hex;
+                    return [2 /*return*/, tx_hex];
+            }
+        });
+    });
+};
 /**
  * Scan UTXOs from sochain.
  *
- * @param {AddressParams} params
+ * @param params
  * @returns {UTXO[]} The UTXOs of the given address.
  */
-var scanUTXOs = function (params) { return __awaiter(void 0, void 0, void 0, function () {
-    var unspent, utxos, _i, unspent_1, utxo;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, getUnspentTxs(params)];
-            case 1:
-                unspent = _a.sent();
-                utxos = [];
-                for (_i = 0, unspent_1 = unspent; _i < unspent_1.length; _i++) {
-                    utxo = unspent_1[_i];
-                    utxos.push({
-                        hash: utxo.txid,
-                        index: utxo.output_no,
-                        value: assetToBase(assetAmount(utxo.value, DOGE_DECIMAL)).amount().toNumber(),
-                    });
-                }
-                return [2 /*return*/, utxos];
-        }
+var scanUTXOs = function (_a) {
+    var sochainUrl = _a.sochainUrl, network = _a.network, address = _a.address, withTxHex = _a.withTxHex;
+    return __awaiter(void 0, void 0, void 0, function () {
+        var utxos;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, getUnspentTxs({
+                        sochainUrl: sochainUrl,
+                        network: network,
+                        address: address,
+                    })];
+                case 1:
+                    utxos = _b.sent();
+                    return [4 /*yield*/, Promise.all(utxos.map(function (utxo) { return __awaiter(void 0, void 0, void 0, function () {
+                            var _a;
+                            var _b;
+                            return __generator(this, function (_c) {
+                                switch (_c.label) {
+                                    case 0:
+                                        _b = {
+                                            hash: utxo.txid,
+                                            index: utxo.output_no,
+                                            value: assetToBase(assetAmount(utxo.value, DOGE_DECIMAL)).amount().toNumber()
+                                        };
+                                        if (!withTxHex) return [3 /*break*/, 2];
+                                        return [4 /*yield*/, getTxHex({ txHash: utxo.txid, sochainUrl: sochainUrl, network: network })];
+                                    case 1:
+                                        _a = _c.sent();
+                                        return [3 /*break*/, 3];
+                                    case 2:
+                                        _a = undefined;
+                                        _c.label = 3;
+                                    case 3: return [2 /*return*/, (_b.txHex = _a,
+                                            _b)];
+                                }
+                            });
+                        }); }))];
+                case 2: return [2 /*return*/, _b.sent()];
+            }
+        });
     });
-}); };
+};
 /**
  * Build transcation.
  *
@@ -86821,18 +86885,18 @@ var scanUTXOs = function (params) { return __awaiter(void 0, void 0, void 0, fun
  * @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;
+    var amount = _a.amount, recipient = _a.recipient, memo = _a.memo, feeRate = _a.feeRate, sender = _a.sender, network = _a.network, sochainUrl = _a.sochainUrl, _b = _a.withTxHex, withTxHex = _b === void 0 ? false : _b;
     return __awaiter(void 0, void 0, void 0, function () {
-        var utxos, feeRateWhole, compiledMemo, targetOutputs, _b, inputs, outputs, psbt, params, _i, inputs_1, utxo, _c, _d, _e, _f;
-        var _g;
-        return __generator(this, function (_h) {
-            switch (_h.label) {
+        var utxos, feeRateWhole, compiledMemo, targetOutputs, _c, inputs, outputs, psbt, params, _i, inputs_1, utxo, _d, _e, _f, _g;
+        var _h;
+        return __generator(this, function (_j) {
+            switch (_j.label) {
                 case 0:
                     if (!validateAddress(recipient, network))
                         throw new Error('Invalid address');
-                    return [4 /*yield*/, scanUTXOs({ sochainUrl: sochainUrl, network: network, address: sender })];
+                    return [4 /*yield*/, scanUTXOs({ sochainUrl: sochainUrl, network: network, address: sender, withTxHex: withTxHex })];
                 case 1:
-                    utxos = _h.sent();
+                    utxos = _j.sent();
                     if (utxos.length === 0)
                         throw new Error('No utxos to send');
                     feeRateWhole = Number(feeRate.toFixed(0));
@@ -86847,7 +86911,7 @@ var buildTx = function (_a) {
                     if (compiledMemo) {
                         targetOutputs.push({ script: compiledMemo, value: 0 });
                     }
-                    _b = accumulative(utxos, targetOutputs, feeRateWhole), inputs = _b.inputs, outputs = _b.outputs;
+                    _c = accumulative(utxos, targetOutputs, feeRateWhole), inputs = _c.inputs, outputs = _c.outputs;
                     // .inputs and .outputs will be undefined if no solution was found
                     if (!inputs || !outputs)
                         throw new Error('Balance insufficient for transaction');
@@ -86858,21 +86922,21 @@ var buildTx = function (_a) {
                     psbt.setMaximumFeeRate(650000);
                     params = { sochainUrl: sochainUrl, network: network, address: sender };
                     _i = 0, inputs_1 = inputs;
-                    _h.label = 2;
+                    _j.label = 2;
                 case 2:
                     if (!(_i < inputs_1.length)) return [3 /*break*/, 5];
                     utxo = inputs_1[_i];
-                    _d = (_c = psbt).addInput;
-                    _g = {
+                    _e = (_d = psbt).addInput;
+                    _h = {
                         hash: utxo.hash,
                         index: utxo.index
                     };
-                    _f = (_e = Buffer).from;
+                    _g = (_f = Buffer).from;
                     return [4 /*yield*/, getTx(__assign({ hash: utxo.hash }, params))];
                 case 3:
-                    _d.apply(_c, [(_g.nonWitnessUtxo = _f.apply(_e, [(_h.sent()).tx_hex, 'hex']),
-                            _g)]);
-                    _h.label = 4;
+                    _e.apply(_d, [(_h.nonWitnessUtxo = _g.apply(_f, [(_j.sent()).tx_hex, 'hex']),
+                            _h)]);
+                    _j.label = 4;
                 case 4:
                     _i++;
                     return [3 /*break*/, 2];
@@ -86909,7 +86973,7 @@ var broadcastTx = function (params) { return __awaiter(void 0, void 0, void 0, f
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
-                if (!(params.network === 'testnet')) return [3 /*break*/, 2];
+                if (!(params.network === Network.Testnet)) return [3 /*break*/, 2];
                 return [4 /*yield*/, broadcastTxToSochain(params)];
             case 1: return [2 /*return*/, _a.sent()];
             case 2: return [4 /*yield*/, broadcastTxToBlockCypher(params)];
@@ -87266,7 +87330,16 @@ var Client = /** @class */ (function (_super) {
                         _b.label = 2;
                     case 2:
                         feeRate = _a;
-                        return [4 /*yield*/, buildTx(__assign(__assign({}, params), { feeRate: feeRate, sender: this.getAddress(fromAddressIndex), sochainUrl: this.sochainUrl, network: this.network }))];
+                        return [4 /*yield*/, buildTx({
+                                amount: params.amount,
+                                recipient: params.recipient,
+                                memo: params.memo,
+                                feeRate: feeRate,
+                                sender: this.getAddress(fromAddressIndex),
+                                sochainUrl: this.sochainUrl,
+                                network: this.network,
+                                withTxHex: false,
+                            })];
                     case 3:
                         psbt = (_b.sent()).psbt;
                         dogeKeys = this.getDogeKeys(this.phrase, fromAddressIndex);
@@ -87278,7 +87351,6 @@ var Client = /** @class */ (function (_super) {
                             nodeUrl = getSendTxUrl$1({
                                 network: this.network,
                                 sochainUrl: this.sochainUrl,
-                                address: this.getAddress(fromAddressIndex),
                             });
                         }
                         else {
@@ -87318,5 +87390,5 @@ var createTxInfo = function (params) { return __awaiter(void 0, void 0, void 0,
     });
 }); };
 
-export { Client, DOGE_DECIMAL, MIN_TX_FEE, broadcastTx, calcFee, createTxInfo, getDefaultFees, getDefaultFeesWithRates, getPrefix, scanUTXOs, validateAddress };
+export { Client, DOGE_DECIMAL, MIN_TX_FEE, broadcastTx, buildTx, calcFee, createTxInfo, getDefaultFees, getDefaultFeesWithRates, getPrefix, getSendTxUrl, scanUTXOs, validateAddress };
 //# sourceMappingURL=index.esm.js.map