@xchainjs/xchain-thorchain 0.19.3 → 0.19.4

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v.0.19.4 (2021-11-22)
+
+## Add
+
+- Provide `getPubKey` method to access public key
+
+## Change
+
+- Make `getPrivKey` method `public` to access private key
+
 # v.0.19.3 (2021-10-31)
 
 ## Update

package/README.md

@@ -48,7 +48,17 @@ const client = new Client({ network: Network.Testnet, phrase: 'my secret phrase'
 
 // get address
 const address = client.getAddress()
-console.log('address:', client.getAddress()) // address: tthor13gym97tmw3axj3hpewdggy2cr288d3qffr8skg
+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`
 
 // get balances
 const balances = await client.getBalance(address)

package/lib/client.d.ts

@@ -1,6 +1,7 @@
 import { Address, Balance, 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 { ClientUrl, DepositParam, ExplorerUrls, NodeUrl, ThorchainClientParams } from './types';
 /**
  * Interface for custom Thorchain client
@@ -118,15 +119,26 @@ declare class Client implements ThorchainClient, XChainClient {
      */
     getFullDerivationPath(index: number): string;
     /**
-     * @private
-     * Get private key.
+     * Get private key
      *
+     * @param {number} index the HD wallet index (optional)
      * @returns {PrivKey} The private key generated from the given phrase
      *
      * @throws {"Phrase not set"}
      * Throws an error if phrase has not been set before
      * */
-    private getPrivateKey;
+    getPrivKey(index?: number): PrivKey;
+    /**
+     * Get public key
+     *
+     * @param {number} index the HD wallet index (optional)
+     *
+     * @returns {PubKey} The public key generated from the given phrase
+     *
+     * @throws {"Phrase not set"}
+     * Throws an error if phrase has not been set before
+     **/
+    getPubKey(index?: number): PubKey;
     /**
      * Get the current address.
      *

package/lib/index.esm.js

@@ -653,18 +653,32 @@ var Client = /** @class */ (function () {
         return this.rootDerivationPaths[this.network] + ("" + index);
     };
     /**
-     * @private
-     * Get private key.
+     * Get private key
      *
+     * @param {number} index the HD wallet index (optional)
      * @returns {PrivKey} The private key generated from the given phrase
      *
      * @throws {"Phrase not set"}
      * Throws an error if phrase has not been set before
      * */
-    Client.prototype.getPrivateKey = function (index) {
+    Client.prototype.getPrivKey = function (index) {
         if (index === void 0) { index = 0; }
         return this.cosmosClient.getPrivKeyFromMnemonic(this.phrase, this.getFullDerivationPath(index));
     };
+    /**
+     * Get public key
+     *
+     * @param {number} index the HD wallet index (optional)
+     *
+     * @returns {PubKey} The public key generated from the given phrase
+     *
+     * @throws {"Phrase not set"}
+     * Throws an error if phrase has not been set before
+     **/
+    Client.prototype.getPubKey = function (index) {
+        if (index === void 0) { index = 0; }
+        return this.getPrivKey(index).getPubKey();
+    };
     /**
      * Get the current address.
      *
@@ -811,7 +825,7 @@ var Client = /** @class */ (function () {
                         return [4 /*yield*/, buildDepositTx(msgNativeTx, this.getClientUrl().node)];
                     case 2:
                         unsignedStdTx = _f.sent();
-                        privateKey = this.getPrivateKey(walletIndex);
+                        privateKey = this.getPrivKey(walletIndex);
                         accAddress = AccAddress.fromBech32(signer);
                         return [4 /*yield*/, this.cosmosClient.signAndBroadcast(unsignedStdTx, privateKey, accAddress)];
                     case 3: return [2 /*return*/, (_c = (_b = (_f.sent())) === null || _b === void 0 ? void 0 : _b.txhash) !== null && _c !== void 0 ? _c : ''];
@@ -844,7 +858,7 @@ var Client = /** @class */ (function () {
                             throw new Error('insufficient funds');
                         }
                         return [4 /*yield*/, this.cosmosClient.transfer({
-                                privkey: this.getPrivateKey(walletIndex),
+                                privkey: this.getPrivKey(walletIndex),
                                 from: this.getAddress(walletIndex),
                                 to: recipient,
                                 amount: amount.amount().toString(),

package/lib/index.js

@@ -661,18 +661,32 @@ var Client = /** @class */ (function () {
         return this.rootDerivationPaths[this.network] + ("" + index);
     };
     /**
-     * @private
-     * Get private key.
+     * Get private key
      *
+     * @param {number} index the HD wallet index (optional)
      * @returns {PrivKey} The private key generated from the given phrase
      *
      * @throws {"Phrase not set"}
      * Throws an error if phrase has not been set before
      * */
-    Client.prototype.getPrivateKey = function (index) {
+    Client.prototype.getPrivKey = function (index) {
         if (index === void 0) { index = 0; }
         return this.cosmosClient.getPrivKeyFromMnemonic(this.phrase, this.getFullDerivationPath(index));
     };
+    /**
+     * Get public key
+     *
+     * @param {number} index the HD wallet index (optional)
+     *
+     * @returns {PubKey} The public key generated from the given phrase
+     *
+     * @throws {"Phrase not set"}
+     * Throws an error if phrase has not been set before
+     **/
+    Client.prototype.getPubKey = function (index) {
+        if (index === void 0) { index = 0; }
+        return this.getPrivKey(index).getPubKey();
+    };
     /**
      * Get the current address.
      *
@@ -819,7 +833,7 @@ var Client = /** @class */ (function () {
                         return [4 /*yield*/, buildDepositTx(msgNativeTx, this.getClientUrl().node)];
                     case 2:
                         unsignedStdTx = _f.sent();
-                        privateKey = this.getPrivateKey(walletIndex);
+                        privateKey = this.getPrivKey(walletIndex);
                         accAddress = cosmosClient.AccAddress.fromBech32(signer);
                         return [4 /*yield*/, this.cosmosClient.signAndBroadcast(unsignedStdTx, privateKey, accAddress)];
                     case 3: return [2 /*return*/, (_c = (_b = (_f.sent())) === null || _b === void 0 ? void 0 : _b.txhash) !== null && _c !== void 0 ? _c : ''];
@@ -852,7 +866,7 @@ var Client = /** @class */ (function () {
                             throw new Error('insufficient funds');
                         }
                         return [4 /*yield*/, this.cosmosClient.transfer({
-                                privkey: this.getPrivateKey(walletIndex),
+                                privkey: this.getPrivKey(walletIndex),
                                 from: this.getAddress(walletIndex),
                                 to: recipient,
                                 amount: amount.amount().toString(),

package/package.json

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