@xchainjs/xchain-thorchain 0.24.1 → 0.25.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v0.25.0 (2022-05-10)
+
+## Fix
+
+- Before sending a transaction, gas limits are estimated
+- Helper `getEstimatedGas`
+
+## Breaking changes
+
+- Client's `transferOffline` requires `fromAccountNumber` and `fromSequence`
+- Rename parameters in `transferOffline` to keep names in camel case (not snake case)
+
 # v0.24.1 (2022-04-23)
 
 ## Fix

package/lib/client.d.ts

@@ -12,6 +12,7 @@ export interface ThorchainClient {
     setExplorerUrls(explorerUrls: ExplorerUrls): void;
     getCosmosClient(): CosmosSDKClient;
     deposit(params: DepositParam): Promise<TxHash>;
+    transferOffline(params: TxOfflineParams): Promise<string>;
 }
 /**
  * Custom Thorchain Client
@@ -197,7 +198,7 @@ declare class Client extends BaseXChainClient implements ThorchainClient, XChain
      * @param {TxOfflineParams} params The transfer offline options.
      * @returns {string} The signed transaction bytes.
      */
-    transferOffline({ walletIndex, asset, amount, recipient, memo, from_rune_balance, from_asset_balance, from_account_number, from_sequence, }: TxOfflineParams): Promise<string>;
+    transferOffline({ walletIndex, asset, amount, recipient, memo, fromRuneBalance: from_rune_balance, fromAssetBalance: from_asset_balance, fromAccountNumber, fromSequence, }: TxOfflineParams): Promise<string>;
     /**
      * Gets fees from Node
      *

package/lib/index.esm.js

@@ -1,4 +1,4 @@
-import { cosmosclient, proto } from '@cosmos-client/core';
+import { cosmosclient, proto, rest } from '@cosmos-client/core';
 import { Network, TxType, singleFee, FeeType, BaseXChainClient } from '@xchainjs/xchain-client';
 import { CosmosSDKClient } from '@xchainjs/xchain-cosmos';
 import { assetToString, AssetRuneNative, isSynthAsset, assetFromString, baseAmount, assetToBase, assetAmount, Chain } from '@xchainjs/xchain-util';
@@ -5376,8 +5376,9 @@ $root.cosmos = (function() {
 var MsgCompiled = $root;
 
 const DECIMAL = 8;
-const DEFAULT_GAS_VALUE = '4000000';
-const DEPOSIT_GAS_VALUE = '500000000';
+const DEFAULT_GAS_ADJUSTMENT = 2;
+const DEFAULT_GAS_LIMIT_VALUE = '4000000';
+const DEPOSIT_GAS_LIMIT_VALUE = '500000000';
 const MAX_TX_COUNT = 100;
 /**
  * Checks whether an asset is `AssetRuneNative`
@@ -5555,11 +5556,29 @@ const buildUnsignedTx = ({ cosmosSdk, txBody, signerPubkey, sequence, gasLimit,
         ],
         fee: {
             amount: null,
-            gas_limit: cosmosclient.Long.fromString(gasLimit),
+            gas_limit: gasLimit || null,
         },
     });
     return new cosmosclient.TxBuilder(cosmosSdk, txBody, authInfo);
 };
+const getEstimatedGas = ({ cosmosSDKClient, txBody, privKey, accountNumber, accountSequence, multiplier, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _b, _c, _d;
+    const pubKey = privKey.pubKey();
+    const txBuilder = buildUnsignedTx({
+        cosmosSdk: cosmosSDKClient.sdk,
+        txBody: txBody,
+        signerPubkey: cosmosclient.codec.packAny(pubKey),
+        sequence: accountSequence,
+    });
+    const signDocBytes = txBuilder.signDocBytes(accountNumber);
+    txBuilder.addSignature(privKey.sign(signDocBytes));
+    const resp = yield rest.tx.simulate(cosmosSDKClient.sdk, { tx_bytes: txBuilder.txBytes() });
+    const estimatedGas = (_d = (_c = (_b = resp.data) === null || _b === void 0 ? void 0 : _b.gas_info) === null || _c === void 0 ? void 0 : _c.gas_used) !== null && _d !== void 0 ? _d : null;
+    if (!estimatedGas) {
+        throw new Error('Could not get data of estimated gas');
+    }
+    return cosmosclient.Long.fromString(estimatedGas).multiply(multiplier || DEFAULT_GAS_ADJUSTMENT);
+});
 /**
  * Structure a MsgDeposit
  *
@@ -6081,11 +6100,20 @@ class Client extends BaseXChainClient {
                 chainId: this.getChainId(),
             });
             const account = yield this.getCosmosClient().getAccount(fromAddressAcc);
+            const accountSequence = account.sequence || cosmosclient.Long.ZERO;
+            const accountNumber = account.account_number || cosmosclient.Long.ZERO;
+            const gasLimit = yield getEstimatedGas({
+                cosmosSDKClient: this.getCosmosClient(),
+                txBody: depositTxBody,
+                privKey,
+                accountNumber,
+                accountSequence,
+            });
             const txBuilder = buildUnsignedTx({
                 cosmosSdk: this.getCosmosClient().sdk,
                 txBody: depositTxBody,
                 signerPubkey: cosmosclient.codec.packAny(signerPubkey),
-                gasLimit: DEPOSIT_GAS_VALUE,
+                gasLimit,
                 sequence: account.sequence || cosmosclient.Long.ZERO,
             });
             return (yield this.getCosmosClient().signAndBroadcast(txBuilder, privKey, account)) || '';
@@ -6131,12 +6159,21 @@ class Client extends BaseXChainClient {
                 nodeUrl: this.getClientUrl().node,
             });
             const account = yield this.getCosmosClient().getAccount(accAddress);
+            const accountSequence = account.sequence || cosmosclient.Long.ZERO;
+            const accountNumber = account.account_number || cosmosclient.Long.ZERO;
+            const gasLimit = yield getEstimatedGas({
+                cosmosSDKClient: this.getCosmosClient(),
+                txBody,
+                privKey,
+                accountNumber,
+                accountSequence,
+            });
             const txBuilder = buildUnsignedTx({
                 cosmosSdk: this.getCosmosClient().sdk,
                 txBody: txBody,
-                gasLimit: DEFAULT_GAS_VALUE,
+                gasLimit,
                 signerPubkey: cosmosclient.codec.packAny(signerPubkey),
-                sequence: account.sequence || cosmosclient.Long.ZERO,
+                sequence: accountSequence,
             });
             return (yield this.cosmosClient.signAndBroadcast(txBuilder, privKey, account)) || '';
         });
@@ -6147,7 +6184,7 @@ class Client extends BaseXChainClient {
      * @param {TxOfflineParams} params The transfer offline options.
      * @returns {string} The signed transaction bytes.
      */
-    transferOffline({ walletIndex = 0, asset = AssetRuneNative, amount, recipient, memo, from_rune_balance, from_asset_balance = baseAmount(0, DECIMAL), from_account_number = '0', from_sequence = '0', }) {
+    transferOffline({ walletIndex = 0, asset = AssetRuneNative, amount, recipient, memo, fromRuneBalance: from_rune_balance, fromAssetBalance: from_asset_balance = baseAmount(0, DECIMAL), fromAccountNumber = cosmosclient.Long.ZERO, fromSequence = cosmosclient.Long.ZERO, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const fee = (yield this.getFees()).average;
             if (isAssetRuneNative(asset)) {
@@ -6172,14 +6209,21 @@ class Client extends BaseXChainClient {
                 nodeUrl: this.getClientUrl().node,
             });
             const privKey = this.getPrivateKey(walletIndex);
+            const gasLimit = yield getEstimatedGas({
+                cosmosSDKClient: this.getCosmosClient(),
+                txBody,
+                privKey,
+                accountNumber: fromAccountNumber,
+                accountSequence: fromSequence,
+            });
             const txBuilder = buildUnsignedTx({
                 cosmosSdk: this.getCosmosClient().sdk,
                 txBody: txBody,
-                gasLimit: DEFAULT_GAS_VALUE,
+                gasLimit: gasLimit,
                 signerPubkey: cosmosclient.codec.packAny(privKey.pubKey()),
-                sequence: cosmosclient.Long.fromString(from_sequence) || cosmosclient.Long.ZERO,
+                sequence: fromSequence,
             });
-            const signDocBytes = txBuilder.signDocBytes(cosmosclient.Long.fromString(from_account_number));
+            const signDocBytes = txBuilder.signDocBytes(fromAccountNumber);
             txBuilder.addSignature(privKey.sign(signDocBytes));
             return txBuilder.txBytes();
         });
@@ -6222,4 +6266,4 @@ const msgNativeTxFromJson = (value) => {
     return new MsgNativeTx(value.coins, value.memo, cosmosclient.AccAddress.fromString(value.signer));
 };
 
-export { Client, DECIMAL, DEFAULT_GAS_VALUE, DEPOSIT_GAS_VALUE, MAX_TX_COUNT, MsgNativeTx, assetFromDenom, buildDepositTx, buildTransferTx, buildUnsignedTx, getBalance, getChainId, getChainIds, getDefaultClientUrl, getDefaultExplorerUrls, getDefaultFees, getDenom, getDepositTxDataFromLogs, getExplorerAddressUrl, getExplorerTxUrl, getExplorerUrl, getPrefix, getTxType, isAssetRuneNative, isBroadcastSuccess, msgNativeTxFromJson, registerDepositCodecs, registerSendCodecs };
+export { Client, DECIMAL, DEFAULT_GAS_ADJUSTMENT, DEFAULT_GAS_LIMIT_VALUE, DEPOSIT_GAS_LIMIT_VALUE, MAX_TX_COUNT, MsgNativeTx, assetFromDenom, buildDepositTx, buildTransferTx, buildUnsignedTx, getBalance, getChainId, getChainIds, getDefaultClientUrl, getDefaultExplorerUrls, getDefaultFees, getDenom, getDepositTxDataFromLogs, getEstimatedGas, getExplorerAddressUrl, getExplorerTxUrl, getExplorerUrl, getPrefix, getTxType, isAssetRuneNative, isBroadcastSuccess, msgNativeTxFromJson, registerDepositCodecs, registerSendCodecs };

package/lib/index.js

@@ -5384,8 +5384,9 @@ $root.cosmos = (function() {
 var MsgCompiled = $root;
 
 const DECIMAL = 8;
-const DEFAULT_GAS_VALUE = '4000000';
-const DEPOSIT_GAS_VALUE = '500000000';
+const DEFAULT_GAS_ADJUSTMENT = 2;
+const DEFAULT_GAS_LIMIT_VALUE = '4000000';
+const DEPOSIT_GAS_LIMIT_VALUE = '500000000';
 const MAX_TX_COUNT = 100;
 /**
  * Checks whether an asset is `AssetRuneNative`
@@ -5563,11 +5564,29 @@ const buildUnsignedTx = ({ cosmosSdk, txBody, signerPubkey, sequence, gasLimit,
         ],
         fee: {
             amount: null,
-            gas_limit: core.cosmosclient.Long.fromString(gasLimit),
+            gas_limit: gasLimit || null,
         },
     });
     return new core.cosmosclient.TxBuilder(cosmosSdk, txBody, authInfo);
 };
+const getEstimatedGas = ({ cosmosSDKClient, txBody, privKey, accountNumber, accountSequence, multiplier, }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _b, _c, _d;
+    const pubKey = privKey.pubKey();
+    const txBuilder = buildUnsignedTx({
+        cosmosSdk: cosmosSDKClient.sdk,
+        txBody: txBody,
+        signerPubkey: core.cosmosclient.codec.packAny(pubKey),
+        sequence: accountSequence,
+    });
+    const signDocBytes = txBuilder.signDocBytes(accountNumber);
+    txBuilder.addSignature(privKey.sign(signDocBytes));
+    const resp = yield core.rest.tx.simulate(cosmosSDKClient.sdk, { tx_bytes: txBuilder.txBytes() });
+    const estimatedGas = (_d = (_c = (_b = resp.data) === null || _b === void 0 ? void 0 : _b.gas_info) === null || _c === void 0 ? void 0 : _c.gas_used) !== null && _d !== void 0 ? _d : null;
+    if (!estimatedGas) {
+        throw new Error('Could not get data of estimated gas');
+    }
+    return core.cosmosclient.Long.fromString(estimatedGas).multiply(multiplier || DEFAULT_GAS_ADJUSTMENT);
+});
 /**
  * Structure a MsgDeposit
  *
@@ -6089,11 +6108,20 @@ class Client extends xchainClient.BaseXChainClient {
                 chainId: this.getChainId(),
             });
             const account = yield this.getCosmosClient().getAccount(fromAddressAcc);
+            const accountSequence = account.sequence || core.cosmosclient.Long.ZERO;
+            const accountNumber = account.account_number || core.cosmosclient.Long.ZERO;
+            const gasLimit = yield getEstimatedGas({
+                cosmosSDKClient: this.getCosmosClient(),
+                txBody: depositTxBody,
+                privKey,
+                accountNumber,
+                accountSequence,
+            });
             const txBuilder = buildUnsignedTx({
                 cosmosSdk: this.getCosmosClient().sdk,
                 txBody: depositTxBody,
                 signerPubkey: core.cosmosclient.codec.packAny(signerPubkey),
-                gasLimit: DEPOSIT_GAS_VALUE,
+                gasLimit,
                 sequence: account.sequence || core.cosmosclient.Long.ZERO,
             });
             return (yield this.getCosmosClient().signAndBroadcast(txBuilder, privKey, account)) || '';
@@ -6139,12 +6167,21 @@ class Client extends xchainClient.BaseXChainClient {
                 nodeUrl: this.getClientUrl().node,
             });
             const account = yield this.getCosmosClient().getAccount(accAddress);
+            const accountSequence = account.sequence || core.cosmosclient.Long.ZERO;
+            const accountNumber = account.account_number || core.cosmosclient.Long.ZERO;
+            const gasLimit = yield getEstimatedGas({
+                cosmosSDKClient: this.getCosmosClient(),
+                txBody,
+                privKey,
+                accountNumber,
+                accountSequence,
+            });
             const txBuilder = buildUnsignedTx({
                 cosmosSdk: this.getCosmosClient().sdk,
                 txBody: txBody,
-                gasLimit: DEFAULT_GAS_VALUE,
+                gasLimit,
                 signerPubkey: core.cosmosclient.codec.packAny(signerPubkey),
-                sequence: account.sequence || core.cosmosclient.Long.ZERO,
+                sequence: accountSequence,
             });
             return (yield this.cosmosClient.signAndBroadcast(txBuilder, privKey, account)) || '';
         });
@@ -6155,7 +6192,7 @@ class Client extends xchainClient.BaseXChainClient {
      * @param {TxOfflineParams} params The transfer offline options.
      * @returns {string} The signed transaction bytes.
      */
-    transferOffline({ walletIndex = 0, asset = xchainUtil.AssetRuneNative, amount, recipient, memo, from_rune_balance, from_asset_balance = xchainUtil.baseAmount(0, DECIMAL), from_account_number = '0', from_sequence = '0', }) {
+    transferOffline({ walletIndex = 0, asset = xchainUtil.AssetRuneNative, amount, recipient, memo, fromRuneBalance: from_rune_balance, fromAssetBalance: from_asset_balance = xchainUtil.baseAmount(0, DECIMAL), fromAccountNumber = core.cosmosclient.Long.ZERO, fromSequence = core.cosmosclient.Long.ZERO, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const fee = (yield this.getFees()).average;
             if (isAssetRuneNative(asset)) {
@@ -6180,14 +6217,21 @@ class Client extends xchainClient.BaseXChainClient {
                 nodeUrl: this.getClientUrl().node,
             });
             const privKey = this.getPrivateKey(walletIndex);
+            const gasLimit = yield getEstimatedGas({
+                cosmosSDKClient: this.getCosmosClient(),
+                txBody,
+                privKey,
+                accountNumber: fromAccountNumber,
+                accountSequence: fromSequence,
+            });
             const txBuilder = buildUnsignedTx({
                 cosmosSdk: this.getCosmosClient().sdk,
                 txBody: txBody,
-                gasLimit: DEFAULT_GAS_VALUE,
+                gasLimit: gasLimit,
                 signerPubkey: core.cosmosclient.codec.packAny(privKey.pubKey()),
-                sequence: core.cosmosclient.Long.fromString(from_sequence) || core.cosmosclient.Long.ZERO,
+                sequence: fromSequence,
             });
-            const signDocBytes = txBuilder.signDocBytes(core.cosmosclient.Long.fromString(from_account_number));
+            const signDocBytes = txBuilder.signDocBytes(fromAccountNumber);
             txBuilder.addSignature(privKey.sign(signDocBytes));
             return txBuilder.txBytes();
         });
@@ -6232,8 +6276,9 @@ const msgNativeTxFromJson = (value) => {
 
 exports.Client = Client;
 exports.DECIMAL = DECIMAL;
-exports.DEFAULT_GAS_VALUE = DEFAULT_GAS_VALUE;
-exports.DEPOSIT_GAS_VALUE = DEPOSIT_GAS_VALUE;
+exports.DEFAULT_GAS_ADJUSTMENT = DEFAULT_GAS_ADJUSTMENT;
+exports.DEFAULT_GAS_LIMIT_VALUE = DEFAULT_GAS_LIMIT_VALUE;
+exports.DEPOSIT_GAS_LIMIT_VALUE = DEPOSIT_GAS_LIMIT_VALUE;
 exports.MAX_TX_COUNT = MAX_TX_COUNT;
 exports.MsgNativeTx = MsgNativeTx;
 exports.assetFromDenom = assetFromDenom;
@@ -6248,6 +6293,7 @@ exports.getDefaultExplorerUrls = getDefaultExplorerUrls;
 exports.getDefaultFees = getDefaultFees;
 exports.getDenom = getDenom;
 exports.getDepositTxDataFromLogs = getDepositTxDataFromLogs;
+exports.getEstimatedGas = getEstimatedGas;
 exports.getExplorerAddressUrl = getExplorerAddressUrl;
 exports.getExplorerTxUrl = getExplorerTxUrl;
 exports.getExplorerUrl = getExplorerUrl;

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

@@ -1,3 +1,4 @@
+import { cosmosclient } from '@cosmos-client/core';
 import { Network, Tx, TxParams } from '@xchainjs/xchain-client';
 import { Asset, BaseAmount } from '@xchainjs/xchain-util';
 export declare type NodeUrl = {
@@ -29,14 +30,14 @@ export declare type TxOfflineParams = TxParams & {
     /**
      * Balance of Rune to send from
      */
-    from_rune_balance: BaseAmount;
+    fromRuneBalance: BaseAmount;
     /**
      * Balance of asset to send from
      * Optional: It can be ignored if asset to send from is RUNE
      */
-    from_asset_balance?: BaseAmount;
-    from_account_number: string;
-    from_sequence: string;
+    fromAssetBalance?: BaseAmount;
+    fromAccountNumber: cosmosclient.Long.Long;
+    fromSequence: cosmosclient.Long.Long;
 };
 /**
  * Response from `thorchain/constants` endpoint
@@ -55,3 +56,12 @@ export declare type NodeInfoResponse = {
         network: string;
     };
 };
+/**
+ * Response of `/cosmos/tx/v1beta1/simulateo`
+ * Note: We are interested in `network` (aka chain id) only
+ */
+export declare type SimulateResponse = {
+    gas_info: {
+        gas_used: string;
+    };
+};

package/lib/util.d.ts

@@ -5,8 +5,9 @@ import { Asset, BaseAmount } from '@xchainjs/xchain-util';
 import { ChainId, ChainIds, ClientUrl, ExplorerUrls, TxData } from './types';
 import { MsgNativeTx } from './types/messages';
 export declare const DECIMAL = 8;
-export declare const DEFAULT_GAS_VALUE = "4000000";
-export declare const DEPOSIT_GAS_VALUE = "500000000";
+export declare const DEFAULT_GAS_ADJUSTMENT = 2;
+export declare const DEFAULT_GAS_LIMIT_VALUE = "4000000";
+export declare const DEPOSIT_GAS_LIMIT_VALUE = "500000000";
 export declare const MAX_TX_COUNT = 100;
 /**
  * Checks whether an asset is `AssetRuneNative`
@@ -98,9 +99,17 @@ export declare const buildUnsignedTx: ({ cosmosSdk, txBody, signerPubkey, sequen
     cosmosSdk: cosmosclient.CosmosSDK;
     txBody: proto.cosmos.tx.v1beta1.TxBody;
     signerPubkey: proto.google.protobuf.Any;
-    sequence: cosmosclient.Long;
-    gasLimit: string;
+    sequence: cosmosclient.Long.Long;
+    gasLimit?: cosmosclient.Long.Long | undefined;
 }) => cosmosclient.TxBuilder;
+export declare const getEstimatedGas: ({ cosmosSDKClient, txBody, privKey, accountNumber, accountSequence, multiplier, }: {
+    cosmosSDKClient: CosmosSDKClient;
+    txBody: proto.cosmos.tx.v1beta1.TxBody;
+    privKey: proto.cosmos.crypto.secp256k1.PrivKey;
+    accountNumber: cosmosclient.Long.Long;
+    accountSequence: cosmosclient.Long.Long;
+    multiplier?: number | undefined;
+}) => Promise<cosmosclient.Long.Long | undefined>;
 /**
  * Structure a MsgDeposit
  *

package/package.json

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