@xchainjs/xchain-thorchain 0.19.2-alpha1 → 0.19.5

package/CHANGELOG.md

@@ -1,4 +1,26 @@
-# Pre-release v.0.19.2-alpha1 (2021-09-27)
+# v.0.19.5 (2021-11-22)
+
+## Add
+
+- Provide `transferOffline` method
+
+# 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
+
+- Use latest `xchain-cosmos@0.13.8` to use `sync` mode for broadcasting txs
+
+# v.0.19.2 (2021-09-27)
 
 ## Fix
 

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,8 @@
 import { Address, Balance, Fees, Network, Tx, TxHash, TxHistoryParams, TxParams, TxsPage, XChainClient, XChainClientParams } from '@xchainjs/xchain-client';
-import { CosmosSDKClient, RPCTxResult } from '@xchainjs/xchain-cosmos';
+import { CosmosSDKClient, RPCTxResult, TxOfflineParams } from '@xchainjs/xchain-cosmos';
 import { Asset } from '@xchainjs/xchain-util';
+import { PrivKey, PubKey } from 'cosmos-client';
+import { StdTx } from 'cosmos-client/x/auth';
 import { ClientUrl, DepositParam, ExplorerUrls, NodeUrl, ThorchainClientParams } from './types';
 /**
  * Interface for custom Thorchain client
@@ -118,15 +120,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.
      *
@@ -193,6 +206,13 @@ declare class Client implements ThorchainClient, XChainClient {
      * @returns {TxHash} The transaction hash.
      */
     transfer({ walletIndex, asset, amount, recipient, memo }: TxParams): Promise<TxHash>;
+    /**
+     * Transfer without broadcast balances with MsgSend
+     *
+     * @param {TxOfflineParams} params The transfer offline options.
+     * @returns {StdTx} The signed transaction.
+     */
+    transferOffline({ walletIndex, asset, amount, recipient, memo, from_balance, from_account_number, from_sequence, }: TxOfflineParams): Promise<StdTx>;
     /**
      * Get the fees.
      *

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(),
@@ -865,6 +879,48 @@ var Client = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Transfer without broadcast balances with MsgSend
+     *
+     * @param {TxOfflineParams} params The transfer offline options.
+     * @returns {StdTx} The signed transaction.
+     */
+    Client.prototype.transferOffline = function (_a) {
+        var _b = _a.walletIndex, walletIndex = _b === void 0 ? 0 : _b, _c = _a.asset, asset = _c === void 0 ? AssetRuneNative : _c, amount = _a.amount, recipient = _a.recipient, memo = _a.memo, _d = _a.from_balance, from_balance = _d === void 0 ? baseAmount('0', DECIMAL) : _d, _e = _a.from_account_number, from_account_number = _e === void 0 ? '0' : _e, _f = _a.from_sequence, from_sequence = _f === void 0 ? '0' : _f;
+        return __awaiter(this, void 0, void 0, function () {
+            var fee, result;
+            return __generator(this, function (_g) {
+                switch (_g.label) {
+                    case 0:
+                        registerCodecs(getPrefix(this.network));
+                        return [4 /*yield*/, this.getFees()];
+                    case 1:
+                        fee = _g.sent();
+                        if (from_balance === baseAmount('0', DECIMAL) ||
+                            from_balance.amount().lt(amount.amount().plus(fee[FeeOption.Average].amount()))) {
+                            throw new Error('insufficient funds');
+                        }
+                        return [4 /*yield*/, this.cosmosClient.transferSignedOffline({
+                                privkey: this.getPrivKey(walletIndex),
+                                from: this.getAddress(walletIndex),
+                                from_account_number: from_account_number,
+                                from_sequence: from_sequence,
+                                to: recipient,
+                                amount: amount.amount().toString(),
+                                asset: getDenom(asset),
+                                memo: memo,
+                                fee: {
+                                    amount: [],
+                                    gas: DEFAULT_GAS_VALUE,
+                                },
+                            })];
+                    case 2:
+                        result = _g.sent();
+                        return [2 /*return*/, JSON.parse(codec.toJSONString(result)).value];
+                }
+            });
+        });
+    };
     /**
      * Get the fees.
      *

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(),
@@ -873,6 +887,48 @@ var Client = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Transfer without broadcast balances with MsgSend
+     *
+     * @param {TxOfflineParams} params The transfer offline options.
+     * @returns {StdTx} The signed transaction.
+     */
+    Client.prototype.transferOffline = function (_a) {
+        var _b = _a.walletIndex, walletIndex = _b === void 0 ? 0 : _b, _c = _a.asset, asset = _c === void 0 ? xchainUtil.AssetRuneNative : _c, amount = _a.amount, recipient = _a.recipient, memo = _a.memo, _d = _a.from_balance, from_balance = _d === void 0 ? xchainUtil.baseAmount('0', DECIMAL) : _d, _e = _a.from_account_number, from_account_number = _e === void 0 ? '0' : _e, _f = _a.from_sequence, from_sequence = _f === void 0 ? '0' : _f;
+        return __awaiter(this, void 0, void 0, function () {
+            var fee, result;
+            return __generator(this, function (_g) {
+                switch (_g.label) {
+                    case 0:
+                        registerCodecs(getPrefix(this.network));
+                        return [4 /*yield*/, this.getFees()];
+                    case 1:
+                        fee = _g.sent();
+                        if (from_balance === xchainUtil.baseAmount('0', DECIMAL) ||
+                            from_balance.amount().lt(amount.amount().plus(fee[xchainClient.FeeOption.Average].amount()))) {
+                            throw new Error('insufficient funds');
+                        }
+                        return [4 /*yield*/, this.cosmosClient.transferSignedOffline({
+                                privkey: this.getPrivKey(walletIndex),
+                                from: this.getAddress(walletIndex),
+                                from_account_number: from_account_number,
+                                from_sequence: from_sequence,
+                                to: recipient,
+                                amount: amount.amount().toString(),
+                                asset: getDenom(asset),
+                                memo: memo,
+                                fee: {
+                                    amount: [],
+                                    gas: DEFAULT_GAS_VALUE,
+                                },
+                            })];
+                    case 2:
+                        result = _g.sent();
+                        return [2 /*return*/, JSON.parse(cosmosClient.codec.toJSONString(result)).value];
+                }
+            });
+        });
+    };
     /**
      * Get the fees.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain",
-  "version": "0.19.2-alpha1",
+  "version": "0.19.5",
   "description": "Custom Thorchain client and utilities used by XChainJS clients",
   "keywords": [
     "THORChain",
@@ -33,8 +33,8 @@
   },
   "devDependencies": {
     "@types/big.js": "^6.0.0",
-    "@xchainjs/xchain-client": "^0.10.1",
-    "@xchainjs/xchain-cosmos": "^0.13.7",
+    "@xchainjs/xchain-client": "0.10.3",
+    "@xchainjs/xchain-cosmos": "0.14.0",
     "@xchainjs/xchain-crypto": "^0.2.4",
     "@xchainjs/xchain-util": "^0.3.0",
     "axios": "^0.21.0",
@@ -45,8 +45,8 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@xchainjs/xchain-client": "^0.10.1",
-    "@xchainjs/xchain-cosmos": "^0.13.7",
+    "@xchainjs/xchain-client": "0.10.3",
+    "@xchainjs/xchain-cosmos": "0.14.0",
     "@xchainjs/xchain-crypto": "^0.2.4",
     "@xchainjs/xchain-util": "^0.3.0",
     "axios": "^0.21.0",