@xchainjs/xchain-thorchain 0.24.0-alpha.1 → 0.24.1

package/CHANGELOG.md

@@ -1,4 +1,15 @@
-# v0.24.0 (2022-03-15)
+# v0.24.1 (2022-04-23)
+
+## Fix
+
+- Increase `DEFAULT_GAS_VALUE` to `4000000` (before `3000000`)
+
+# v0.24.0 (2022-03-23)
+
+## Update
+
+- upgraded to "@cosmos-client/core": "0.45.1"
+- client now extend BaseXChainClient
 
 ## Breaking Changes
 

package/README.md

@@ -11,17 +11,20 @@ yarn add @xchainjs/xchain-thorchain
 Following peer dependencies have to be installed into your project. These are not included in `@xchainjs/xchain-thorchain`.
 
 ```
-yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util @xchainjs/xchain-cosmos axios cosmos-client bech32-buffer
+yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util @xchainjs/xchain-cosmos axios @cosmos-client/core bech32-buffer
 ```
 
 Important note: Make sure to install same version of `@cosmos-client/core` as `xchain-thorchain` is using (currently `@cosmos-client/core@0.45.1` ). In other case things might break.
 
-## Thorchain Client Testing
 
-```
-yarn install
-yarn test
-```
+## Documentation
+
+### [`xchain thorchain`](http://docs.xchainjs.org/xchain-client/xchain-thorchain/)
+[`How xchain-thorchain works`](http://docs.xchainjs.org/xchain-client/xchain-thorchain/how-it-works.html)\
+[`How to use xchain-thorchain`](http://docs.xchainjs.org/xchain-client/xchain-thorchain/how-to-use.html)
+
+
+For more examples check out tests in `./__tests__/client.test.ts`
 
 ## Service Providers
 
@@ -37,33 +40,7 @@ This package uses the following service providers:
 
 Rate limits: No
 
-## Examples
-
-```ts
-// import `xchain-thorchain`
-import { Client } from '@xchainjs/xchain-thorchain'
-
-// Create a `Client`
-const client = new Client({ network: Network.Testnet, phrase: 'my secret phrase' })
-
-// get address
-const address = client.getAddress()
-console.log('address:', client.getAddress()) // address: tthor13gym97tmw3axj3hpewdggy2cr288d3qffr8skg
-
-// get balances
-const balances = await client.getBalance(address)
-console.log('balances:', balances[0].amount.amount().toString()) // balance: 6968080395099
-
-// get transactions
-const txs = await client.getTransactions({ address })
-console.log('txs total:', txs.total) // txs total: 100
-
-// get transaction details
-const tx = await client.getTransactionData('any-tx-hash', address)
-console.log('tx asset:', tx.asset) // tx asset: { chain: 'THOR', symbol: 'RUNE', ticker: 'RUNE' }
-```
-
-For more examples check out tests in `./__tests__/client.test.ts`
+## Extras
 
 ## Creating protobuffer typescript bindings
 

package/lib/index.esm.js

@@ -5376,7 +5376,7 @@ $root.cosmos = (function() {
 var MsgCompiled = $root;
 
 const DECIMAL = 8;
-const DEFAULT_GAS_VALUE = '3000000';
+const DEFAULT_GAS_VALUE = '4000000';
 const DEPOSIT_GAS_VALUE = '500000000';
 const MAX_TX_COUNT = 100;
 /**
@@ -5439,21 +5439,17 @@ const getPrefix = (network) => {
     }
 };
 /**
- * Register Codecs based on the prefix.
- *
- * @param {string} prefix
+ * Register type for encoding `MsgDeposit` messages
  */
-const registerDespositCodecs = () => __awaiter(void 0, void 0, void 0, function* () {
+const registerDepositCodecs = () => {
     cosmosclient.codec.register('/types.MsgDeposit', MsgCompiled.types.MsgDeposit);
-});
+};
 /**
- * Register Codecs based on the prefix.
- *
- * @param {string} prefix
+ * Register type for encoding `MsgSend` messages
  */
-const registerSendCodecs = () => __awaiter(void 0, void 0, void 0, function* () {
+const registerSendCodecs = () => {
     cosmosclient.codec.register('/types.MsgSend', MsgCompiled.types.MsgSend);
-});
+};
 /**
  * Parse transaction data from event logs
  *
@@ -5817,6 +5813,8 @@ class Client extends BaseXChainClient {
         this.clientUrl = clientUrl || getDefaultClientUrl();
         this.explorerUrls = explorerUrls || getDefaultExplorerUrls();
         this.chainIds = chainIds;
+        registerSendCodecs();
+        registerDepositCodecs();
         this.cosmosClient = new CosmosSDKClient({
             server: this.getClientUrl().node,
             chainId: this.getChainId(network),
@@ -6048,7 +6046,6 @@ class Client extends BaseXChainClient {
     deposit({ walletIndex = 0, asset = AssetRuneNative, amount, memo }) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
-            yield registerDespositCodecs();
             const balances = yield this.getBalance(this.getAddress(walletIndex));
             const runeBalance = (_b = (_a = balances.filter(({ asset }) => isAssetRuneNative(asset))[0]) === null || _a === void 0 ? void 0 : _a.amount) !== null && _b !== void 0 ? _b : baseAmount(0, DECIMAL);
             const assetBalance = (_d = (_c = balances.filter(({ asset: assetInList }) => assetToString(assetInList) === assetToString(asset))[0]) === null || _c === void 0 ? void 0 : _c.amount) !== null && _d !== void 0 ? _d : baseAmount(0, DECIMAL);
@@ -6103,7 +6100,6 @@ class Client extends BaseXChainClient {
     transfer({ walletIndex = 0, asset = AssetRuneNative, amount, recipient, memo }) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
-            yield registerSendCodecs();
             const balances = yield this.getBalance(this.getAddress(walletIndex));
             const runeBalance = (_b = (_a = balances.filter(({ asset }) => isAssetRuneNative(asset))[0]) === null || _a === void 0 ? void 0 : _a.amount) !== null && _b !== void 0 ? _b : baseAmount(0, DECIMAL);
             const assetBalance = (_d = (_c = balances.filter(({ asset: assetInList }) => assetToString(assetInList) === assetToString(asset))[0]) === null || _c === void 0 ? void 0 : _c.amount) !== null && _d !== void 0 ? _d : baseAmount(0, DECIMAL);
@@ -6226,4 +6222,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, registerDespositCodecs, registerSendCodecs };
+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 };

package/lib/index.js

@@ -5384,7 +5384,7 @@ $root.cosmos = (function() {
 var MsgCompiled = $root;
 
 const DECIMAL = 8;
-const DEFAULT_GAS_VALUE = '3000000';
+const DEFAULT_GAS_VALUE = '4000000';
 const DEPOSIT_GAS_VALUE = '500000000';
 const MAX_TX_COUNT = 100;
 /**
@@ -5447,21 +5447,17 @@ const getPrefix = (network) => {
     }
 };
 /**
- * Register Codecs based on the prefix.
- *
- * @param {string} prefix
+ * Register type for encoding `MsgDeposit` messages
  */
-const registerDespositCodecs = () => __awaiter(void 0, void 0, void 0, function* () {
+const registerDepositCodecs = () => {
     core.cosmosclient.codec.register('/types.MsgDeposit', MsgCompiled.types.MsgDeposit);
-});
+};
 /**
- * Register Codecs based on the prefix.
- *
- * @param {string} prefix
+ * Register type for encoding `MsgSend` messages
  */
-const registerSendCodecs = () => __awaiter(void 0, void 0, void 0, function* () {
+const registerSendCodecs = () => {
     core.cosmosclient.codec.register('/types.MsgSend', MsgCompiled.types.MsgSend);
-});
+};
 /**
  * Parse transaction data from event logs
  *
@@ -5825,6 +5821,8 @@ class Client extends xchainClient.BaseXChainClient {
         this.clientUrl = clientUrl || getDefaultClientUrl();
         this.explorerUrls = explorerUrls || getDefaultExplorerUrls();
         this.chainIds = chainIds;
+        registerSendCodecs();
+        registerDepositCodecs();
         this.cosmosClient = new xchainCosmos.CosmosSDKClient({
             server: this.getClientUrl().node,
             chainId: this.getChainId(network),
@@ -6056,7 +6054,6 @@ class Client extends xchainClient.BaseXChainClient {
     deposit({ walletIndex = 0, asset = xchainUtil.AssetRuneNative, amount, memo }) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
-            yield registerDespositCodecs();
             const balances = yield this.getBalance(this.getAddress(walletIndex));
             const runeBalance = (_b = (_a = balances.filter(({ asset }) => isAssetRuneNative(asset))[0]) === null || _a === void 0 ? void 0 : _a.amount) !== null && _b !== void 0 ? _b : xchainUtil.baseAmount(0, DECIMAL);
             const assetBalance = (_d = (_c = balances.filter(({ asset: assetInList }) => xchainUtil.assetToString(assetInList) === xchainUtil.assetToString(asset))[0]) === null || _c === void 0 ? void 0 : _c.amount) !== null && _d !== void 0 ? _d : xchainUtil.baseAmount(0, DECIMAL);
@@ -6111,7 +6108,6 @@ class Client extends xchainClient.BaseXChainClient {
     transfer({ walletIndex = 0, asset = xchainUtil.AssetRuneNative, amount, recipient, memo }) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
-            yield registerSendCodecs();
             const balances = yield this.getBalance(this.getAddress(walletIndex));
             const runeBalance = (_b = (_a = balances.filter(({ asset }) => isAssetRuneNative(asset))[0]) === null || _a === void 0 ? void 0 : _a.amount) !== null && _b !== void 0 ? _b : xchainUtil.baseAmount(0, DECIMAL);
             const assetBalance = (_d = (_c = balances.filter(({ asset: assetInList }) => xchainUtil.assetToString(assetInList) === xchainUtil.assetToString(asset))[0]) === null || _c === void 0 ? void 0 : _c.amount) !== null && _d !== void 0 ? _d : xchainUtil.baseAmount(0, DECIMAL);
@@ -6260,5 +6256,5 @@ exports.getTxType = getTxType;
 exports.isAssetRuneNative = isAssetRuneNative;
 exports.isBroadcastSuccess = isBroadcastSuccess;
 exports.msgNativeTxFromJson = msgNativeTxFromJson;
-exports.registerDespositCodecs = registerDespositCodecs;
+exports.registerDepositCodecs = registerDepositCodecs;
 exports.registerSendCodecs = registerSendCodecs;

package/lib/util.d.ts

@@ -5,7 +5,7 @@ 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 = "3000000";
+export declare const DEFAULT_GAS_VALUE = "4000000";
 export declare const DEPOSIT_GAS_VALUE = "500000000";
 export declare const MAX_TX_COUNT = 100;
 /**
@@ -45,17 +45,13 @@ export declare const isBroadcastSuccess: (response: unknown) => boolean;
  **/
 export declare const getPrefix: (network: Network) => "thor" | "sthor" | "tthor";
 /**
- * Register Codecs based on the prefix.
- *
- * @param {string} prefix
+ * Register type for encoding `MsgDeposit` messages
  */
-export declare const registerDespositCodecs: () => Promise<void>;
+export declare const registerDepositCodecs: () => void;
 /**
- * Register Codecs based on the prefix.
- *
- * @param {string} prefix
+ * Register type for encoding `MsgSend` messages
  */
-export declare const registerSendCodecs: () => Promise<void>;
+export declare const registerSendCodecs: () => void;
 /**
  * Parse transaction data from event logs
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain",
-  "version": "0.24.0-alpha.1",
+  "version": "0.24.1",
   "description": "Custom Thorchain client and utilities used by XChainJS clients",
   "keywords": [
     "THORChain",
@@ -37,7 +37,7 @@
     "@cosmos-client/core": "^0.45.1",
     "@types/big.js": "^6.0.0",
     "@xchainjs/xchain-client": "^0.11.1",
-    "@xchainjs/xchain-cosmos": "^0.17.0-alpha.1",
+    "@xchainjs/xchain-cosmos": "^0.17.0",
     "@xchainjs/xchain-crypto": "^0.2.4",
     "@xchainjs/xchain-util": "^0.5.1",
     "axios": "^0.25.0",
@@ -56,4 +56,4 @@
     "axios": "^0.25.0",
     "bech32-buffer": "^0.2.0"
   }
-}
+}