@xchainjs/xchain-thorchain 0.19.2 → 0.20.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# v.0.20.0 (2021-12-29)
+
+## Breaking change
+
+- Add stagenet environment handling for `Network` and `BaseXChainClient` to client
+
+# 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

@@ -191,6 +191,8 @@ var getPrefix = function (network) {
     switch (network) {
         case Network.Mainnet:
             return 'thor';
+        case Network.Stagenet:
+            return 'sthor';
         case Network.Testnet:
             return 'tthor';
     }
@@ -352,8 +354,12 @@ var getDefaultClientUrl = function () {
             node: 'https://testnet.thornode.thorchain.info',
             rpc: 'https://testnet.rpc.thorchain.info',
         },
+        _a[Network.Stagenet] = {
+            node: 'https://stagenet-thornode.ninerealms.com',
+            rpc: 'https://stagenet-rpc.ninerealms.com',
+        },
         _a[Network.Mainnet] = {
-            node: 'https://thornode.thorchain.info',
+            node: 'https://thornode.ninerealms.com',
             rpc: 'https://rpc.thorchain.info',
         },
         _a;
@@ -368,16 +374,19 @@ var getDefaultExplorerUrls = function () {
     var _a, _b, _c;
     var root = (_a = {},
         _a[Network.Testnet] = DEFAULT_EXPLORER_URL + "?network=testnet",
+        _a[Network.Stagenet] = DEFAULT_EXPLORER_URL + "?network=stagenet",
         _a[Network.Mainnet] = DEFAULT_EXPLORER_URL,
         _a);
     var txUrl = DEFAULT_EXPLORER_URL + "/tx";
     var tx = (_b = {},
         _b[Network.Testnet] = txUrl,
+        _b[Network.Stagenet] = txUrl,
         _b[Network.Mainnet] = txUrl,
         _b);
     var addressUrl = DEFAULT_EXPLORER_URL + "/address";
     var address = (_c = {},
         _c[Network.Testnet] = addressUrl,
+        _c[Network.Stagenet] = addressUrl,
         _c[Network.Mainnet] = addressUrl,
         _c);
     return {
@@ -411,6 +420,8 @@ var getExplorerAddressUrl = function (_a) {
     switch (network) {
         case Network.Mainnet:
             return url;
+        case Network.Stagenet:
+            return url + "?network=stagenet";
         case Network.Testnet:
             return url + "?network=testnet";
     }
@@ -429,6 +440,8 @@ var getExplorerTxUrl = function (_a) {
     switch (network) {
         case Network.Mainnet:
             return url;
+        case Network.Stagenet:
+            return url + "?network=stagenet";
         case Network.Testnet:
             return url + "?network=testnet";
     }
@@ -453,6 +466,7 @@ var Client = /** @class */ (function () {
         var _this = this;
         var _c = _a.network, network = _c === void 0 ? Network.Testnet : _c, phrase = _a.phrase, clientUrl = _a.clientUrl, explorerUrls = _a.explorerUrls, _d = _a.rootDerivationPaths, rootDerivationPaths = _d === void 0 ? (_b = {},
             _b[Network.Mainnet] = "44'/931'/0'/0/",
+            _b[Network.Stagenet] = "44'/931'/0'/0/",
             _b[Network.Testnet] = "44'/931'/0'/0/",
             _b) : _d;
         this.phrase = '';
@@ -653,18 +667,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 +839,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 +872,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 +893,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

@@ -199,6 +199,8 @@ var getPrefix = function (network) {
     switch (network) {
         case xchainClient.Network.Mainnet:
             return 'thor';
+        case xchainClient.Network.Stagenet:
+            return 'sthor';
         case xchainClient.Network.Testnet:
             return 'tthor';
     }
@@ -360,8 +362,12 @@ var getDefaultClientUrl = function () {
             node: 'https://testnet.thornode.thorchain.info',
             rpc: 'https://testnet.rpc.thorchain.info',
         },
+        _a[xchainClient.Network.Stagenet] = {
+            node: 'https://stagenet-thornode.ninerealms.com',
+            rpc: 'https://stagenet-rpc.ninerealms.com',
+        },
         _a[xchainClient.Network.Mainnet] = {
-            node: 'https://thornode.thorchain.info',
+            node: 'https://thornode.ninerealms.com',
             rpc: 'https://rpc.thorchain.info',
         },
         _a;
@@ -376,16 +382,19 @@ var getDefaultExplorerUrls = function () {
     var _a, _b, _c;
     var root = (_a = {},
         _a[xchainClient.Network.Testnet] = DEFAULT_EXPLORER_URL + "?network=testnet",
+        _a[xchainClient.Network.Stagenet] = DEFAULT_EXPLORER_URL + "?network=stagenet",
         _a[xchainClient.Network.Mainnet] = DEFAULT_EXPLORER_URL,
         _a);
     var txUrl = DEFAULT_EXPLORER_URL + "/tx";
     var tx = (_b = {},
         _b[xchainClient.Network.Testnet] = txUrl,
+        _b[xchainClient.Network.Stagenet] = txUrl,
         _b[xchainClient.Network.Mainnet] = txUrl,
         _b);
     var addressUrl = DEFAULT_EXPLORER_URL + "/address";
     var address = (_c = {},
         _c[xchainClient.Network.Testnet] = addressUrl,
+        _c[xchainClient.Network.Stagenet] = addressUrl,
         _c[xchainClient.Network.Mainnet] = addressUrl,
         _c);
     return {
@@ -419,6 +428,8 @@ var getExplorerAddressUrl = function (_a) {
     switch (network) {
         case xchainClient.Network.Mainnet:
             return url;
+        case xchainClient.Network.Stagenet:
+            return url + "?network=stagenet";
         case xchainClient.Network.Testnet:
             return url + "?network=testnet";
     }
@@ -437,6 +448,8 @@ var getExplorerTxUrl = function (_a) {
     switch (network) {
         case xchainClient.Network.Mainnet:
             return url;
+        case xchainClient.Network.Stagenet:
+            return url + "?network=stagenet";
         case xchainClient.Network.Testnet:
             return url + "?network=testnet";
     }
@@ -461,6 +474,7 @@ var Client = /** @class */ (function () {
         var _this = this;
         var _c = _a.network, network = _c === void 0 ? xchainClient.Network.Testnet : _c, phrase = _a.phrase, clientUrl = _a.clientUrl, explorerUrls = _a.explorerUrls, _d = _a.rootDerivationPaths, rootDerivationPaths = _d === void 0 ? (_b = {},
             _b[xchainClient.Network.Mainnet] = "44'/931'/0'/0/",
+            _b[xchainClient.Network.Stagenet] = "44'/931'/0'/0/",
             _b[xchainClient.Network.Testnet] = "44'/931'/0'/0/",
             _b) : _d;
         this.phrase = '';
@@ -661,18 +675,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 +847,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 +880,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 +901,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/lib/util.d.ts

@@ -59,7 +59,7 @@ export declare const isBroadcastSuccess: (response: unknown) => boolean;
  * @returns {string} The address prefix based on the network.
  *
  **/
-export declare const getPrefix: (network: Network) => "thor" | "tthor";
+export declare const getPrefix: (network: Network) => "thor" | "sthor" | "tthor";
 /**
  * Get the chain id.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-thorchain",
-  "version": "0.19.2",
+  "version": "0.20.0",
   "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.11.0",
+    "@xchainjs/xchain-cosmos": "^0.15.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.11.0",
+    "@xchainjs/xchain-cosmos": "^0.15.0",
     "@xchainjs/xchain-crypto": "^0.2.4",
     "@xchainjs/xchain-util": "^0.3.0",
     "axios": "^0.21.0",