@gnolang/tm2-js-client 1.3.1 → 1.3.2

package/bin/provider/jsonrpc/jsonrpc.d.ts

@@ -1,6 +1,6 @@
 import { Tx } from '../../proto';
 import { Provider } from '../provider';
-import { BlockInfo, BlockResult, BroadcastTransactionMap, ConsensusParams, NetworkInfo, Status, TxResult } from '../types';
+import { ABCIAccount, BlockInfo, BlockResult, BroadcastTransactionMap, ConsensusParams, NetworkInfo, Status, TxResult } from '../types';
 /**
  * Provider based on JSON-RPC HTTP requests
  */
@@ -21,6 +21,7 @@ export declare class JSONRPCProvider implements Provider {
     getNetwork(): Promise<NetworkInfo>;
     getAccountSequence(address: string, height?: number): Promise<number>;
     getAccountNumber(address: string, height?: number): Promise<number>;
+    getAccount(address: string, height?: number): Promise<ABCIAccount>;
     getStatus(): Promise<Status>;
     getTransaction(hash: string): Promise<TxResult>;
     sendTransaction<K extends keyof BroadcastTransactionMap>(tx: string, endpoint: K): Promise<BroadcastTransactionMap[K]['result']>;

package/bin/provider/jsonrpc/jsonrpc.js

@@ -203,6 +203,26 @@ var JSONRPCProvider = /** @class */ (function () {
             });
         });
     };
+    JSONRPCProvider.prototype.getAccount = function (address, height) {
+        return __awaiter(this, void 0, void 0, function () {
+            var abciResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, services_1.RestService.post(this.baseURL, {
+                            request: (0, utility_1.newRequest)(endpoints_1.ABCIEndpoint.ABCI_QUERY, [
+                                "auth/accounts/".concat(address),
+                                '',
+                                '0', // Height; not supported > 0 for now
+                                false,
+                            ]),
+                        })];
+                    case 1:
+                        abciResponse = _a.sent();
+                        return [2 /*return*/, (0, utility_1.extractAccountFromResponse)(abciResponse.response.ResponseBase.Data)];
+                }
+            });
+        });
+    };
     JSONRPCProvider.prototype.getStatus = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {

package/bin/provider/jsonrpc/jsonrpc.test.js

@@ -437,4 +437,52 @@ describe('JSON-RPC Provider', function () {
             });
         }); });
     });
+    describe('getAccount', function () {
+        var validAccount = {
+            BaseAccount: {
+                address: 'random address',
+                coins: '',
+                public_key: { '@type': 'pktype', value: 'pk' },
+                account_number: '10',
+                sequence: '42',
+            },
+        };
+        test.each([
+            [JSON.stringify(validAccount), validAccount], // account exists
+            ['null', null], // account doesn't exist
+        ])('case %#', function (response, expected) { return __awaiter(void 0, void 0, void 0, function () {
+            var mockABCIResponse, provider, account, e_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        mockABCIResponse = (0, jest_mock_extended_1.mock)();
+                        mockABCIResponse.response.ResponseBase = {
+                            Log: '',
+                            Info: '',
+                            Data: (0, utility_1.stringToBase64)(response),
+                            Error: null,
+                            Events: null,
+                        };
+                        mockedAxios.post.mockResolvedValue({
+                            data: (0, utility_1.newResponse)(mockABCIResponse),
+                        });
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        provider = new jsonrpc_1.JSONRPCProvider(mockURL);
+                        return [4 /*yield*/, provider.getAccount('address')];
+                    case 2:
+                        account = _a.sent();
+                        expect(axios_1.default.post).toHaveBeenCalled();
+                        expect(account).toStrictEqual(expected);
+                        return [3 /*break*/, 4];
+                    case 3:
+                        e_3 = _a.sent();
+                        expect(e_3.message).toContain('account is not initialized');
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        }); });
+    });
 });

package/bin/provider/provider.d.ts

@@ -1,4 +1,4 @@
-import { BlockInfo, BlockResult, BroadcastAsGeneric, BroadcastTransactionMap, ConsensusParams, NetworkInfo, Status } from './types';
+import { ABCIAccount, BlockInfo, BlockResult, BroadcastAsGeneric, BroadcastTransactionMap, ConsensusParams, NetworkInfo, Status } from './types';
 import { Tx } from '../proto';
 /**
  * Read-only abstraction for accessing blockchain data
@@ -17,6 +17,7 @@ export interface Provider {
      * @param {string} address the bech32 address of the account
      * @param {number} [height=0] the height for querying.
      * If omitted, the latest height is used.
+     * @deprecated use {@link getAccount} instead
      */
     getAccountSequence(address: string, height?: number): Promise<number>;
     /**
@@ -25,8 +26,17 @@ export interface Provider {
      * @param {string} address the bech32 address of the account
      * @param {number} [height=0] the height for querying.
      * If omitted, the latest height is used
+     * @deprecated use {@link getAccount} instead
      */
     getAccountNumber(address: string, height?: number): Promise<number>;
+    /**
+     * Fetches the account. Errors out if the account
+     * is not initialized
+     * @param {string} address the bech32 address of the account
+     * @param {number} [height=0] the height for querying.
+     * If omitted, the latest height is used
+     */
+    getAccount(address: string, height?: number): Promise<ABCIAccount>;
     /**
      * Fetches the block at the specific height, if any
      * @param {number} height the height for querying

package/bin/provider/utility/provider.utility.d.ts

@@ -1,7 +1,7 @@
 import { Tx } from '../../proto';
 import { ResponseDeliverTx } from '../../proto/tm2/abci';
 import { Provider } from '../provider';
-import { ABCIResponse } from '../types';
+import { ABCIAccount, ABCIResponse } from '../types';
 /**
  * Extracts the specific balance denomination from the ABCI response
  * @param {string | null} abciData the base64-encoded ABCI data
@@ -18,6 +18,11 @@ export declare const extractSequenceFromResponse: (abciData: string | null) => n
  * @param {string | null} abciData the base64-encoded ABCI data
  */
 export declare const extractAccountNumberFromResponse: (abciData: string | null) => number;
+/**
+ * Extracts the account from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ */
+export declare const extractAccountFromResponse: (abciData: string | null) => ABCIAccount;
 /**
  * Extracts the simulate transaction response from the ABCI response value
  * @param {string | null} abciData the base64-encoded ResponseDeliverTx proto message

package/bin/provider/utility/provider.utility.js

@@ -36,7 +36,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForTransaction = exports.extractSimulateFromResponse = exports.extractAccountNumberFromResponse = exports.extractSequenceFromResponse = exports.extractBalanceFromResponse = void 0;
+exports.waitForTransaction = exports.extractSimulateFromResponse = exports.extractAccountFromResponse = exports.extractAccountNumberFromResponse = exports.extractSequenceFromResponse = exports.extractBalanceFromResponse = void 0;
 var crypto_1 = require("@cosmjs/crypto");
 var proto_1 = require("../../proto");
 var abci_1 = require("../../proto/tm2/abci");
@@ -115,6 +115,25 @@ var extractAccountNumberFromResponse = function (abciData) {
     }
 };
 exports.extractAccountNumberFromResponse = extractAccountNumberFromResponse;
+/**
+ * Extracts the account from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ */
+var extractAccountFromResponse = function (abciData) {
+    // Make sure the response is initialized
+    if (!abciData) {
+        throw new Error('account is not initialized');
+    }
+    try {
+        // Parse the account
+        var account = (0, requests_utility_1.parseABCI)(abciData);
+        return account;
+    }
+    catch (e) {
+        throw new Error('account is not initialized');
+    }
+};
+exports.extractAccountFromResponse = extractAccountFromResponse;
 /**
  * Extracts the simulate transaction response from the ABCI response value
  * @param {string | null} abciData the base64-encoded ResponseDeliverTx proto message

package/bin/provider/websocket/ws.d.ts

@@ -1,6 +1,6 @@
 import { Tx } from '../../proto';
 import { Provider } from '../provider';
-import { BlockInfo, BlockResult, BroadcastTransactionMap, ConsensusParams, NetworkInfo, RPCRequest, RPCResponse, Status, TxResult } from '../types';
+import { ABCIAccount, BlockInfo, BlockResult, BroadcastTransactionMap, ConsensusParams, NetworkInfo, RPCRequest, RPCResponse, Status, TxResult } from '../types';
 /**
  * Provider based on WS JSON-RPC HTTP requests
  */
@@ -48,6 +48,7 @@ export declare class WSProvider implements Provider {
     getNetwork(): Promise<NetworkInfo>;
     getAccountSequence(address: string, height?: number): Promise<number>;
     getAccountNumber(address: string, height?: number): Promise<number>;
+    getAccount(address: string, height?: number): Promise<ABCIAccount>;
     getStatus(): Promise<Status>;
     getTransaction(hash: string): Promise<TxResult>;
     sendTransaction<K extends keyof BroadcastTransactionMap>(tx: string, endpoint: K): Promise<BroadcastTransactionMap[K]['result']>;

package/bin/provider/websocket/ws.js

@@ -296,6 +296,25 @@ var WSProvider = /** @class */ (function () {
             });
         });
     };
+    WSProvider.prototype.getAccount = function (address, height) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response, abciResponse;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.sendRequest((0, utility_1.newRequest)(endpoints_1.ABCIEndpoint.ABCI_QUERY, [
+                            "auth/accounts/".concat(address),
+                            '',
+                            '0', // Height; not supported > 0 for now
+                            false,
+                        ]))];
+                    case 1:
+                        response = _a.sent();
+                        abciResponse = this.parseResponse(response);
+                        return [2 /*return*/, (0, utility_1.extractAccountFromResponse)(abciResponse.response.ResponseBase.Data)];
+                }
+            });
+        });
+    };
     WSProvider.prototype.getStatus = function () {
         return __awaiter(this, void 0, void 0, function () {
             var response;

package/bin/provider/websocket/ws.test.js

@@ -336,6 +336,47 @@ describe('WS Provider', function () {
             });
         }); });
     });
+    describe('getAccount', function () {
+        var validAccount = {
+            BaseAccount: {
+                address: 'random address',
+                coins: '',
+                public_key: null,
+                account_number: '10',
+                sequence: '0',
+            },
+        };
+        test.each([
+            [JSON.stringify(validAccount), validAccount], // account exists
+            ['null', null], // account doesn't exist
+        ])('case %#', function (response, expected) { return __awaiter(void 0, void 0, void 0, function () {
+            var mockResponse, account, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        mockResponse = mockABCIResponse(response);
+                        // Set the response
+                        return [4 /*yield*/, setHandler(mockResponse)];
+                    case 1:
+                        // Set the response
+                        _a.sent();
+                        _a.label = 2;
+                    case 2:
+                        _a.trys.push([2, 4, , 5]);
+                        return [4 /*yield*/, wsProvider.getAccount('address')];
+                    case 3:
+                        account = _a.sent();
+                        expect(account).toStrictEqual(expected);
+                        return [3 /*break*/, 5];
+                    case 4:
+                        e_2 = _a.sent();
+                        expect(e_2.message).toContain('account is not initialized');
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
+                }
+            });
+        }); });
+    });
     describe('getBalance', function () {
         var denomination = 'atom';
         test.each([
@@ -405,7 +446,7 @@ describe('WS Provider', function () {
             [validResult, validResult.hash, '', ''], // no error
             [invalidResult, invalidResult.hash, messages_1.UnauthorizedErrorMessage, mockLog], // error out
         ])('case %#', function (response, expectedHash, expectedErr, expectedLog) { return __awaiter(void 0, void 0, void 0, function () {
-            var tx, e_2;
+            var tx, e_3;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, setHandler(response)];
@@ -423,9 +464,9 @@ describe('WS Provider', function () {
                         }
                         return [3 /*break*/, 5];
                     case 4:
-                        e_2 = _a.sent();
-                        expect(e_2.message).toBe(expectedErr);
-                        expect(e_2.log).toBe(expectedLog);
+                        e_3 = _a.sent();
+                        expect(e_3.message).toBe(expectedErr);
+                        expect(e_3.log).toBe(expectedLog);
                         return [3 /*break*/, 5];
                     case 5: return [2 /*return*/];
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gnolang/tm2-js-client",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "description": "Tendermint2 JS / TS Client",
   "main": "./bin/index.js",
   "repository": {