@xchainjs/xchain-thorchain 0.22.0 → 0.23.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# v0.23.0 (2022-03-08)
+
+## Add
+
+- Helpers `getChainId` + `getChainIds`
+
+## Breaking change
+
+- `chainIds: ChainIds` is required to initialize `Client`
+
+## Fix
+
+- Request fees from THORChain and use `defaultFees` in case of server errors only
+- Fix `defaultFees` to be 0.02 RUNE
+
+# v0.22.2 (2022-02-17)
+
+## Fix
+
+- Request fees from THORChain and use `defaultFees` in case of server errors only
+- Fix `defaultFees` to be 0.02 RUNE
+
+# v0.22.1 (2022-02-16)
+
+## Fix
+
+- Increase limit for `DEFAULT_GAS_VALUE` from 2000000 to 3000000 to accommodate recent increases in gas used that go above the old limit
+
 # v0.22.0 (2022-02-06)
 
 ## Add

package/README.md

@@ -44,7 +44,9 @@ Rate limits: No
 import { Client } from '@xchainjs/xchain-thorchain'
 
 // Create a `Client`
-const client = new Client({ network: Network.Testnet, phrase: 'my secret phrase' })
+// Note: `chainIds` are required
+const chainIds = getChainIds(getDefaultClientUrl()) // instead of `getDefaultClientUrl` you can pass custom API endpoints
+const client = new Client({ network: Network.Testnet, phrase: 'my secret phrase', chainIds })
 
 // get address
 const address = client.getAddress()

package/lib/client.d.ts

@@ -232,7 +232,7 @@ declare class Client implements ThorchainClient, XChainClient {
      */
     transferOffline({ walletIndex, asset, amount, recipient, memo, from_rune_balance, from_asset_balance, from_account_number, from_sequence, }: TxOfflineParams): Promise<StdTx>;
     /**
-     * Get the fees.
+     * Gets fees from Node
      *
      * @returns {Fees}
      */

package/lib/index.esm.js

@@ -1,7 +1,7 @@
 import { Network, TxType, singleFee, FeeType } from '@xchainjs/xchain-client';
 import { CosmosSDKClient } from '@xchainjs/xchain-cosmos';
 import { validatePhrase } from '@xchainjs/xchain-crypto';
-import { assetToString, AssetRuneNative, isSynthAsset, assetFromString, baseAmount } from '@xchainjs/xchain-util';
+import { assetToString, AssetRuneNative, isSynthAsset, assetFromString, baseAmount, assetToBase, assetAmount } from '@xchainjs/xchain-util';
 import axios from 'axios';
 import { AccAddress, Msg, codec } from 'cosmos-client';
 import { StdTx } from 'cosmos-client/x/auth';
@@ -115,7 +115,7 @@ var msgNativeTxFromJson = function (value) {
 };
 
 var DECIMAL = 8;
-var DEFAULT_GAS_VALUE = '2000000';
+var DEFAULT_GAS_VALUE = '3000000';
 var DEPOSIT_GAS_VALUE = '500000000';
 var MAX_TX_COUNT = 100;
 /**
@@ -259,7 +259,7 @@ var getDepositTxDataFromLogs = function (logs, address) {
  * @returns {Fees} The default fee.
  */
 var getDefaultFees = function () {
-    var fee = baseAmount(DEFAULT_GAS_VALUE, DECIMAL);
+    var fee = assetToBase(assetAmount(0.02 /* 0.02 RUNE */, DECIMAL));
     return singleFee(FeeType.FlatFee, fee);
 };
 /**
@@ -272,6 +272,42 @@ var getDefaultFees = function () {
 var getTxType = function (txData, encoding) {
     return Buffer.from(txData, encoding).toString().slice(4);
 };
+/**
+ * Helper to get THORChain's chain id
+ * @param {string} nodeUrl THORNode url
+ */
+var getChainId = function (nodeUrl) { return __awaiter(void 0, void 0, void 0, function () {
+    var data;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, axios.get(nodeUrl + "/cosmos/base/tendermint/v1beta1/node_info")];
+            case 1:
+                data = (_b.sent()).data;
+                return [2 /*return*/, ((_a = data === null || data === void 0 ? void 0 : data.default_node_info) === null || _a === void 0 ? void 0 : _a.network) || Promise.reject('Could not parse chain id')];
+        }
+    });
+}); };
+/**
+ * Helper to get all THORChain's chain id
+ * @param {ClientUrl} client urls (use `getDefaultClientUrl()` if you don't need to use custom urls)
+ */
+var getChainIds = function (client) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, Promise.all([
+                getChainId(client[Network.Testnet].node),
+                getChainId(client[Network.Stagenet].node),
+                getChainId(client[Network.Mainnet].node),
+            ]).then(function (_a) {
+                var testnetId = _a[0], stagenetId = _a[1], mainnetId = _a[2];
+                return ({
+                    testnet: testnetId,
+                    stagenet: stagenetId,
+                    mainnet: mainnetId,
+                });
+            })];
+    });
+}); };
 /**
  * Structure StdTx from MsgNativeTx.
  *
@@ -286,14 +322,13 @@ var getTxType = function (txData, encoding) {
 var buildDepositTx = function (_a) {
     var msgNativeTx = _a.msgNativeTx, nodeUrl = _a.nodeUrl, chainId = _a.chainId;
     return __awaiter(void 0, void 0, void 0, function () {
-        var data, networkChainId, response, fee, unsignedStdTx;
+        var networkChainId, response, fee, unsignedStdTx;
         var _b, _c;
         return __generator(this, function (_d) {
             switch (_d.label) {
-                case 0: return [4 /*yield*/, axios.get(nodeUrl + "/cosmos/base/tendermint/v1beta1/node_info")];
+                case 0: return [4 /*yield*/, getChainId(nodeUrl)];
                 case 1:
-                    data = (_d.sent()).data;
-                    networkChainId = data.default_node_info.network;
+                    networkChainId = _d.sent();
                     if (!networkChainId || chainId !== networkChainId)
                         throw new Error("Invalid network (asked: " + chainId + " / returned: " + networkChainId);
                     return [4 /*yield*/, axios.post(nodeUrl + "/thorchain/deposit", {
@@ -469,17 +504,13 @@ var Client = /** @class */ (function () {
      * @throws {"Invalid phrase"} Thrown if the given phase is invalid.
      */
     function Client(_a) {
-        var _b, _c;
+        var _b;
         var _this = this;
-        var _d = _a.network, network = _d === void 0 ? Network.Testnet : _d, phrase = _a.phrase, clientUrl = _a.clientUrl, explorerUrls = _a.explorerUrls, _e = _a.rootDerivationPaths, rootDerivationPaths = _e === void 0 ? (_b = {},
+        var _c = _a.network, network = _c === void 0 ? Network.Testnet : _c, phrase = _a.phrase, clientUrl = _a.clientUrl, explorerUrls = _a.explorerUrls, _d = _a.rootDerivationPaths, rootDerivationPaths = _d === void 0 ? (_b = {},
             _b[Network.Mainnet] = "44'/931'/0'/0/",
             _b[Network.Stagenet] = "44'/931'/0'/0/",
             _b[Network.Testnet] = "44'/931'/0'/0/",
-            _b) : _e, _f = _a.chainIds, chainIds = _f === void 0 ? (_c = {},
-            _c[Network.Mainnet] = 'thorchain',
-            _c[Network.Stagenet] = 'thorchain-stagenet',
-            _c[Network.Testnet] = 'thorchain-v1',
-            _c) : _f;
+            _b) : _d, chainIds = _a.chainIds;
         this.phrase = '';
         /**
          * Get transaction history of a given address with pagination options.
@@ -864,7 +895,9 @@ var Client = /** @class */ (function () {
                             var assetInList = _a.asset;
                             return assetToString(assetInList) === assetToString(asset);
                         })[0]) === null || _d === void 0 ? void 0 : _d.amount) !== null && _e !== void 0 ? _e : baseAmount(0, DECIMAL);
-                        fee = baseAmount(DEFAULT_GAS_VALUE, DECIMAL);
+                        return [4 /*yield*/, this.getFees()];
+                    case 2:
+                        fee = (_k.sent()).average;
                         if (isAssetRuneNative(asset)) {
                             // amount + fee < runeBalance
                             if (runeBalance.lt(amount.plus(fee))) {
@@ -893,12 +926,12 @@ var Client = /** @class */ (function () {
                                 nodeUrl: this.getClientUrl().node,
                                 chainId: this.getChainId(),
                             })];
-                    case 2:
+                    case 3:
                         unsignedStdTx = _k.sent();
                         privateKey = this.getPrivKey(walletIndex);
                         accAddress = AccAddress.fromBech32(signer);
                         return [4 /*yield*/, this.cosmosClient.signAndBroadcast(unsignedStdTx, privateKey, accAddress)];
-                    case 3: return [2 /*return*/, (_g = (_f = (_k.sent())) === null || _f === void 0 ? void 0 : _f.txhash) !== null && _g !== void 0 ? _g : ''];
+                    case 4: return [2 /*return*/, (_g = (_f = (_k.sent())) === null || _f === void 0 ? void 0 : _f.txhash) !== null && _g !== void 0 ? _g : ''];
                 }
             });
         });
@@ -1017,18 +1050,35 @@ var Client = /** @class */ (function () {
         });
     };
     /**
-     * Get the fees.
+     * Gets fees from Node
      *
      * @returns {Fees}
      */
     Client.prototype.getFees = function () {
         return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, getDefaultFees()];
+            var fee, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _b.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, axios.get(this.getClientUrl().node + "/thorchain/constants")
+                            // validate data
+                        ];
+                    case 1:
+                        fee = (_b.sent()).data.int_64_values.NativeTransactionFee;
+                        // validate data
+                        if (!fee || isNaN(fee) || fee < 0)
+                            throw Error("Invalid fee: " + fee.toString());
+                        return [2 /*return*/, singleFee(FeeType.FlatFee, baseAmount(fee))];
+                    case 2:
+                        _a = _b.sent();
+                        return [2 /*return*/, getDefaultFees()];
+                    case 3: return [2 /*return*/];
+                }
             });
         });
     };
     return Client;
 }());
 
-export { Client, DECIMAL, DEFAULT_GAS_VALUE, DEPOSIT_GAS_VALUE, MAX_TX_COUNT, MsgNativeTx, assetFromDenom, buildDepositTx, getBalance, getDefaultClientUrl, getDefaultExplorerUrls, getDefaultFees, getDenom, getDepositTxDataFromLogs, getExplorerAddressUrl, getExplorerTxUrl, getExplorerUrl, getPrefix, getTxType, isAssetRuneNative, isBroadcastSuccess, isMsgMultiSend, isMsgSend, msgNativeTxFromJson, registerCodecs };
+export { Client, DECIMAL, DEFAULT_GAS_VALUE, DEPOSIT_GAS_VALUE, MAX_TX_COUNT, MsgNativeTx, assetFromDenom, buildDepositTx, getBalance, getChainId, getChainIds, getDefaultClientUrl, getDefaultExplorerUrls, getDefaultFees, getDenom, getDepositTxDataFromLogs, getExplorerAddressUrl, getExplorerTxUrl, getExplorerUrl, getPrefix, getTxType, isAssetRuneNative, isBroadcastSuccess, isMsgMultiSend, isMsgSend, msgNativeTxFromJson, registerCodecs };

package/lib/index.js

@@ -123,7 +123,7 @@ var msgNativeTxFromJson = function (value) {
 };
 
 var DECIMAL = 8;
-var DEFAULT_GAS_VALUE = '2000000';
+var DEFAULT_GAS_VALUE = '3000000';
 var DEPOSIT_GAS_VALUE = '500000000';
 var MAX_TX_COUNT = 100;
 /**
@@ -267,7 +267,7 @@ var getDepositTxDataFromLogs = function (logs, address) {
  * @returns {Fees} The default fee.
  */
 var getDefaultFees = function () {
-    var fee = xchainUtil.baseAmount(DEFAULT_GAS_VALUE, DECIMAL);
+    var fee = xchainUtil.assetToBase(xchainUtil.assetAmount(0.02 /* 0.02 RUNE */, DECIMAL));
     return xchainClient.singleFee(xchainClient.FeeType.FlatFee, fee);
 };
 /**
@@ -280,6 +280,42 @@ var getDefaultFees = function () {
 var getTxType = function (txData, encoding) {
     return Buffer.from(txData, encoding).toString().slice(4);
 };
+/**
+ * Helper to get THORChain's chain id
+ * @param {string} nodeUrl THORNode url
+ */
+var getChainId = function (nodeUrl) { return __awaiter(void 0, void 0, void 0, function () {
+    var data;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, axios__default['default'].get(nodeUrl + "/cosmos/base/tendermint/v1beta1/node_info")];
+            case 1:
+                data = (_b.sent()).data;
+                return [2 /*return*/, ((_a = data === null || data === void 0 ? void 0 : data.default_node_info) === null || _a === void 0 ? void 0 : _a.network) || Promise.reject('Could not parse chain id')];
+        }
+    });
+}); };
+/**
+ * Helper to get all THORChain's chain id
+ * @param {ClientUrl} client urls (use `getDefaultClientUrl()` if you don't need to use custom urls)
+ */
+var getChainIds = function (client) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        return [2 /*return*/, Promise.all([
+                getChainId(client[xchainClient.Network.Testnet].node),
+                getChainId(client[xchainClient.Network.Stagenet].node),
+                getChainId(client[xchainClient.Network.Mainnet].node),
+            ]).then(function (_a) {
+                var testnetId = _a[0], stagenetId = _a[1], mainnetId = _a[2];
+                return ({
+                    testnet: testnetId,
+                    stagenet: stagenetId,
+                    mainnet: mainnetId,
+                });
+            })];
+    });
+}); };
 /**
  * Structure StdTx from MsgNativeTx.
  *
@@ -294,14 +330,13 @@ var getTxType = function (txData, encoding) {
 var buildDepositTx = function (_a) {
     var msgNativeTx = _a.msgNativeTx, nodeUrl = _a.nodeUrl, chainId = _a.chainId;
     return __awaiter(void 0, void 0, void 0, function () {
-        var data, networkChainId, response, fee, unsignedStdTx;
+        var networkChainId, response, fee, unsignedStdTx;
         var _b, _c;
         return __generator(this, function (_d) {
             switch (_d.label) {
-                case 0: return [4 /*yield*/, axios__default['default'].get(nodeUrl + "/cosmos/base/tendermint/v1beta1/node_info")];
+                case 0: return [4 /*yield*/, getChainId(nodeUrl)];
                 case 1:
-                    data = (_d.sent()).data;
-                    networkChainId = data.default_node_info.network;
+                    networkChainId = _d.sent();
                     if (!networkChainId || chainId !== networkChainId)
                         throw new Error("Invalid network (asked: " + chainId + " / returned: " + networkChainId);
                     return [4 /*yield*/, axios__default['default'].post(nodeUrl + "/thorchain/deposit", {
@@ -477,17 +512,13 @@ var Client = /** @class */ (function () {
      * @throws {"Invalid phrase"} Thrown if the given phase is invalid.
      */
     function Client(_a) {
-        var _b, _c;
+        var _b;
         var _this = this;
-        var _d = _a.network, network = _d === void 0 ? xchainClient.Network.Testnet : _d, phrase = _a.phrase, clientUrl = _a.clientUrl, explorerUrls = _a.explorerUrls, _e = _a.rootDerivationPaths, rootDerivationPaths = _e === void 0 ? (_b = {},
+        var _c = _a.network, network = _c === void 0 ? xchainClient.Network.Testnet : _c, phrase = _a.phrase, clientUrl = _a.clientUrl, explorerUrls = _a.explorerUrls, _d = _a.rootDerivationPaths, rootDerivationPaths = _d === void 0 ? (_b = {},
             _b[xchainClient.Network.Mainnet] = "44'/931'/0'/0/",
             _b[xchainClient.Network.Stagenet] = "44'/931'/0'/0/",
             _b[xchainClient.Network.Testnet] = "44'/931'/0'/0/",
-            _b) : _e, _f = _a.chainIds, chainIds = _f === void 0 ? (_c = {},
-            _c[xchainClient.Network.Mainnet] = 'thorchain',
-            _c[xchainClient.Network.Stagenet] = 'thorchain-stagenet',
-            _c[xchainClient.Network.Testnet] = 'thorchain-v1',
-            _c) : _f;
+            _b) : _d, chainIds = _a.chainIds;
         this.phrase = '';
         /**
          * Get transaction history of a given address with pagination options.
@@ -872,7 +903,9 @@ var Client = /** @class */ (function () {
                             var assetInList = _a.asset;
                             return xchainUtil.assetToString(assetInList) === xchainUtil.assetToString(asset);
                         })[0]) === null || _d === void 0 ? void 0 : _d.amount) !== null && _e !== void 0 ? _e : xchainUtil.baseAmount(0, DECIMAL);
-                        fee = xchainUtil.baseAmount(DEFAULT_GAS_VALUE, DECIMAL);
+                        return [4 /*yield*/, this.getFees()];
+                    case 2:
+                        fee = (_k.sent()).average;
                         if (isAssetRuneNative(asset)) {
                             // amount + fee < runeBalance
                             if (runeBalance.lt(amount.plus(fee))) {
@@ -901,12 +934,12 @@ var Client = /** @class */ (function () {
                                 nodeUrl: this.getClientUrl().node,
                                 chainId: this.getChainId(),
                             })];
-                    case 2:
+                    case 3:
                         unsignedStdTx = _k.sent();
                         privateKey = this.getPrivKey(walletIndex);
                         accAddress = cosmosClient.AccAddress.fromBech32(signer);
                         return [4 /*yield*/, this.cosmosClient.signAndBroadcast(unsignedStdTx, privateKey, accAddress)];
-                    case 3: return [2 /*return*/, (_g = (_f = (_k.sent())) === null || _f === void 0 ? void 0 : _f.txhash) !== null && _g !== void 0 ? _g : ''];
+                    case 4: return [2 /*return*/, (_g = (_f = (_k.sent())) === null || _f === void 0 ? void 0 : _f.txhash) !== null && _g !== void 0 ? _g : ''];
                 }
             });
         });
@@ -1025,14 +1058,31 @@ var Client = /** @class */ (function () {
         });
     };
     /**
-     * Get the fees.
+     * Gets fees from Node
      *
      * @returns {Fees}
      */
     Client.prototype.getFees = function () {
         return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, getDefaultFees()];
+            var fee, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _b.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, axios__default['default'].get(this.getClientUrl().node + "/thorchain/constants")
+                            // validate data
+                        ];
+                    case 1:
+                        fee = (_b.sent()).data.int_64_values.NativeTransactionFee;
+                        // validate data
+                        if (!fee || isNaN(fee) || fee < 0)
+                            throw Error("Invalid fee: " + fee.toString());
+                        return [2 /*return*/, xchainClient.singleFee(xchainClient.FeeType.FlatFee, xchainUtil.baseAmount(fee))];
+                    case 2:
+                        _a = _b.sent();
+                        return [2 /*return*/, getDefaultFees()];
+                    case 3: return [2 /*return*/];
+                }
             });
         });
     };
@@ -1048,6 +1098,8 @@ exports.MsgNativeTx = MsgNativeTx;
 exports.assetFromDenom = assetFromDenom;
 exports.buildDepositTx = buildDepositTx;
 exports.getBalance = getBalance;
+exports.getChainId = getChainId;
+exports.getChainIds = getChainIds;
 exports.getDefaultClientUrl = getDefaultClientUrl;
 exports.getDefaultExplorerUrls = getDefaultExplorerUrls;
 exports.getDefaultFees = getDefaultFees;

package/lib/types/client-types.d.ts

@@ -16,7 +16,7 @@ export declare type ChainIds = Record<Network, ChainId>;
 export declare type ThorchainClientParams = {
     clientUrl?: ClientUrl;
     explorerUrls?: ExplorerUrls;
-    chainIds?: ChainIds;
+    chainIds: ChainIds;
 };
 export declare type DepositParam = {
     walletIndex?: number;
@@ -38,3 +38,20 @@ export declare type TxOfflineParams = TxParams & {
     from_account_number: string;
     from_sequence: string;
 };
+/**
+ * Response from `thorchain/constants` endpoint
+ */
+export declare type ThorchainConstantsResponse = {
+    int_64_values: {
+        NativeTransactionFee: number;
+    };
+};
+/**
+ * Response of `/cosmos/base/tendermint/v1beta1/node_info`
+ * Note: We are interested in `network` (aka chain id) only
+ */
+export declare type NodeInfoResponse = {
+    default_node_info: {
+        network: string;
+    };
+};

package/lib/util.d.ts

@@ -4,10 +4,10 @@ import { Asset } from '@xchainjs/xchain-util';
 import { Msg } from 'cosmos-client';
 import { StdTx } from 'cosmos-client/x/auth';
 import { MsgMultiSend, MsgSend } from 'cosmos-client/x/bank';
-import { ChainId, ClientUrl, ExplorerUrls, TxData } from './types';
+import { ChainId, ChainIds, ClientUrl, ExplorerUrls, TxData } from './types';
 import { MsgNativeTx } from './types/messages';
 export declare const DECIMAL = 8;
-export declare const DEFAULT_GAS_VALUE = "2000000";
+export declare const DEFAULT_GAS_VALUE = "3000000";
 export declare const DEPOSIT_GAS_VALUE = "500000000";
 export declare const MAX_TX_COUNT = 100;
 /**
@@ -88,6 +88,16 @@ export declare const getDefaultFees: () => Fees;
  * @returns {string} the transaction type.
  */
 export declare const getTxType: (txData: string, encoding: 'base64' | 'hex') => string;
+/**
+ * Helper to get THORChain's chain id
+ * @param {string} nodeUrl THORNode url
+ */
+export declare const getChainId: (nodeUrl: string) => Promise<ChainId>;
+/**
+ * Helper to get all THORChain's chain id
+ * @param {ClientUrl} client urls (use `getDefaultClientUrl()` if you don't need to use custom urls)
+ */
+export declare const getChainIds: (client: ClientUrl) => Promise<ChainIds>;
 /**
  * Structure StdTx from MsgNativeTx.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "Custom Thorchain client and utilities used by XChainJS clients",
   "keywords": [
     "THORChain",