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

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# v0.24.0 (2022-03-15)
+
+## Breaking Changes
+
+- `buildDepositTx` now returns `proto.cosmos.tx.v1beta1.TxBody` from `@cosmos-client/core`
+
+# 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

package/README.md

@@ -11,10 +11,10 @@ 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
+yarn add @xchainjs/xchain-client @xchainjs/xchain-crypto @xchainjs/xchain-util @xchainjs/xchain-cosmos axios cosmos-client bech32-buffer
 ```
 
-Important note: Make sure to install same version of `cosmos-client` as `xchain-thorchain` is using (currently `cosmos-client@0.39.2` ). In other case things might break.
+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
 
@@ -48,17 +48,7 @@ const client = new Client({ network: Network.Testnet, phrase: 'my secret phrase'
 
 // get address
 const address = client.getAddress()
-console.log('address:', address) // address: tthor13gym97tmw3axj3hpewdggy2cr288d3qffr8skg
-
-// get private key
-const privKey = client.getPrivKey()
-console.log('privKey:', privKey.toBase64()) // privKey: {your-private-key} base64 encoded
-console.log('privKey:', privKey.toBuffer()) // privKey: {your-private-key} as `Buffer`
-
-// get public key
-const pubKey = client.getPubKey()
-console.log('pubKey:', pubKey.toBase64()) // pubKey: {your-public-key} base64 encoded
-console.log('pubKey:', pubKey.toBuffer()) // pubKey: {your-public-key} as `Buffer`
+console.log('address:', client.getAddress()) // address: tthor13gym97tmw3axj3hpewdggy2cr288d3qffr8skg
 
 // get balances
 const balances = await client.getBalance(address)
@@ -74,3 +64,20 @@ console.log('tx asset:', tx.asset) // tx asset: { chain: 'THOR', symbol: 'RUNE',
 ```
 
 For more examples check out tests in `./__tests__/client.test.ts`
+
+## Creating protobuffer typescript bindings
+
+In order for this library to de/serialize proto3 structures, you can use the following to create bindings
+
+1. `git clone https://gitlab.com/thorchain/thornode`
+2. run the following (adjust the paths acordingly) to generate a typecript file for MsgDeposit
+   ```bash
+   yarn run pbjs -w commonjs  -t static-module  <path to repo>/thornode/proto/thorchain/v1/x/thorchain/types/msg_deposit.proto <path to repo>/thornode/proto/thorchain/v1/common/common.proto <path to repo>/thornode/proto/thorchain/v1/x/thorchain/types/msg_send.proto <path to repo>/thornode/third_party/proto/cosmos/base/v1beta1/coin.proto -o src/types/proto/MsgCompiled.js
+   ```
+3. run the following to generate the .d.ts file
+   ```bash
+   yarn run pbts src/types/proto/MsgCompiled.js -o src/types/proto/MsgCompiled.d.ts
+   ```
+
+Alternatively, you can run the convenience script: `genMsgs.sh`, which will overwrite the proto/js files in types/proto. This should only be done and checked in if changes were made to the upstream Msg in the THORNode repo. 
+

package/lib/client.d.ts

@@ -1,8 +1,7 @@
-import { Address, Balance, Fees, Network, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, XChainClient, XChainClientParams } from '@xchainjs/xchain-client';
+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 { PrivKey, PubKey } from 'cosmos-client';
-import { StdTx } from 'cosmos-client/x/auth';
 import { ChainId, ClientUrl, DepositParam, ExplorerUrls, NodeUrl, ThorchainClientParams, TxOfflineParams } from './types';
 /**
  * Interface for custom Thorchain client
@@ -17,13 +16,10 @@ export interface ThorchainClient {
 /**
  * Custom Thorchain Client
  */
-declare class Client implements ThorchainClient, XChainClient {
-    private network;
+declare class Client extends BaseXChainClient implements ThorchainClient, XChainClient {
     private clientUrl;
     private explorerUrls;
     private chainIds;
-    private phrase;
-    private rootDerivationPaths;
     private cosmosClient;
     /**
      * Constructor
@@ -36,12 +32,6 @@ declare class Client implements ThorchainClient, XChainClient {
      * @throws {"Invalid phrase"} Thrown if the given phase is invalid.
      */
     constructor({ network, phrase, clientUrl, explorerUrls, rootDerivationPaths, chainIds, }: XChainClientParams & ThorchainClientParams);
-    /**
-     * Purge client.
-     *
-     * @returns {void}
-     */
-    purgeClient(): void;
     /**
      * Set/update the current network.
      *
@@ -52,12 +42,6 @@ declare class Client implements ThorchainClient, XChainClient {
      * Thrown if network has not been set before.
      */
     setNetwork(network: Network): void;
-    /**
-     * Get the current network.
-     *
-     * @returns {Network}
-     */
-    getNetwork(): Network;
     /**
      * Set/update the client URL.
      *
@@ -120,23 +104,6 @@ declare class Client implements ThorchainClient, XChainClient {
      * @returns {string} The explorer url for the given transaction id.
      */
     getExplorerTxUrl(txID: string): string;
-    /**
-     * Set/update a new phrase
-     *
-     * @param {string} phrase A new phrase.
-     * @returns {Address} The address from the given phrase
-     *
-     * @throws {"Invalid phrase"}
-     * Thrown if the given phase is invalid.
-     */
-    setPhrase(phrase: string, walletIndex?: number): Address;
-    /**
-     * Get getFullDerivationPath
-     *
-     * @param {number} index the HD wallet index
-     * @returns {string} The bitcoin derivation path based on the network.
-     */
-    getFullDerivationPath(index: number): string;
     /**
      * Get private key
      *
@@ -146,7 +113,7 @@ declare class Client implements ThorchainClient, XChainClient {
      * @throws {"Phrase not set"}
      * Throws an error if phrase has not been set before
      * */
-    getPrivKey(index?: number): PrivKey;
+    getPrivateKey(index?: number): proto.cosmos.crypto.secp256k1.PrivKey;
     /**
      * Get public key
      *
@@ -157,7 +124,7 @@ declare class Client implements ThorchainClient, XChainClient {
      * @throws {"Phrase not set"}
      * Throws an error if phrase has not been set before
      **/
-    getPubKey(index?: number): PubKey;
+    getPubKey(index?: number): cosmosclient.PubKey;
     /**
      * Get the current address.
      *
@@ -228,11 +195,11 @@ declare class Client implements ThorchainClient, XChainClient {
      * Transfer without broadcast balances with MsgSend
      *
      * @param {TxOfflineParams} params The transfer offline options.
-     * @returns {StdTx} The signed transaction.
+     * @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<StdTx>;
+    transferOffline({ walletIndex, asset, amount, recipient, memo, from_rune_balance, from_asset_balance, from_account_number, from_sequence, }: TxOfflineParams): Promise<string>;
     /**
-     * Get the fees.
+     * Gets fees from Node
      *
      * @returns {Fees}
      */