@xchainjs/xchain-thorchain 0.24.0 → 0.25.1

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+# v0.25.1 (2022-06-17)
+
+## Fix
+
+- Remove estimation of gas in `transfer` and `deposit` (introduced by #564) in favour of using `DEFAULT_GAS_LIMIT_VALUE` or `DEPOSIT_GAS_LIMIT_VALUE` (both can be overridden by users in `transfer` or `deposit`)
+- Increase `DEPOSIT_GAS_LIMIT_VALUE` to `600000000` (before `500000000`)
+
+# v0.25.0 (2022-06-16)
+
+## 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)
+- Rename `DEFAULT_GAS_VALUE` to `DEFAULT_GAS_LIMIT_VALUE`
+- Rename `DEPOSIT_GAS_VALUE` to `DEPOSIT_GAS_LIMIT_VALUE`
+
+# v0.24.1 (2022-04-23)
+
+## Fix
+
+- Increase `DEFAULT_GAS_VALUE` to `4000000` (before `3000000`)
+
 # v0.24.0 (2022-03-23)
 
 ## Update

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/client.d.ts

@@ -2,6 +2,7 @@ import { cosmosclient, proto } from '@cosmos-client/core';
 import { Address, Balance, BaseXChainClient, Fees, Network, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, XChainClient, XChainClientParams } from '@xchainjs/xchain-client';
 import { CosmosSDKClient, RPCTxResult } from '@xchainjs/xchain-cosmos';
 import { Asset } from '@xchainjs/xchain-util';
+import BigNumber from 'bignumber.js';
 import { ChainId, ClientUrl, DepositParam, ExplorerUrls, NodeUrl, ThorchainClientParams, TxOfflineParams } from './types';
 /**
  * Interface for custom Thorchain client
@@ -12,6 +13,7 @@ export interface ThorchainClient {
     setExplorerUrls(explorerUrls: ExplorerUrls): void;
     getCosmosClient(): CosmosSDKClient;
     deposit(params: DepositParam): Promise<TxHash>;
+    transferOffline(params: TxOfflineParams): Promise<string>;
 }
 /**
  * Custom Thorchain Client
@@ -181,23 +183,28 @@ declare class Client extends BaseXChainClient implements ThorchainClient, XChain
      * @returns {TxHash} The transaction hash.
      *
      * @throws {"insufficient funds"} Thrown if the wallet has insufficient funds.
-     * @throws {"failed to broadcast transaction"} Thrown if failed to broadcast transaction.
+     * @throws {"Invalid transaction hash"} Thrown by missing tx hash
      */
-    deposit({ walletIndex, asset, amount, memo }: DepositParam): Promise<TxHash>;
+    deposit({ walletIndex, asset, amount, memo, gasLimit, }: DepositParam): Promise<TxHash>;
     /**
      * Transfer balances with MsgSend
      *
      * @param {TxParams} params The transfer options.
      * @returns {TxHash} The transaction hash.
+     *
+     * @throws {"insufficient funds"} Thrown if the wallet has insufficient funds.
+     * @throws {"Invalid transaction hash"} Thrown by missing tx hash
      */
-    transfer({ walletIndex, asset, amount, recipient, memo }: TxParams): Promise<TxHash>;
+    transfer({ walletIndex, asset, amount, recipient, memo, gasLimit, }: TxParams & {
+        gasLimit?: BigNumber;
+    }): Promise<TxHash>;
     /**
      * Transfer without broadcast balances with MsgSend
      *
      * @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, gasLimit, }: TxOfflineParams): Promise<string>;
     /**
      * Gets fees from Node
      *