feat(provider): add getAccount method (#231)

* feat(provider): add getAccount method

Signed-off-by: Norman <[email protected]>

* chore: improve jsdoc format

Signed-off-by: Norman <[email protected]>

* chore: prettier

Signed-off-by: Norman <[email protected]>

---------

Signed-off-by: Norman <[email protected]>

Author: n0izn0iz

src/provider/jsonrpc/jsonrpc.test.ts

@@ -374,4 +374,45 @@ describe('JSON-RPC Provider', () => {
       }
     });
   });
+
+  describe('getAccount', () => {
+    const validAccount: ABCIAccount = {
+      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 %#', async (response, expected) => {
+      const mockABCIResponse: ABCIResponse = mock<ABCIResponse>();
+      mockABCIResponse.response.ResponseBase = {
+        Log: '',
+        Info: '',
+        Data: stringToBase64(response),
+        Error: null,
+        Events: null,
+      };
+
+      mockedAxios.post.mockResolvedValue({
+        data: newResponse<ABCIResponse>(mockABCIResponse),
+      });
+
+      try {
+        // Create the provider
+        const provider = new JSONRPCProvider(mockURL);
+        const account = await provider.getAccount('address');
+
+        expect(axios.post).toHaveBeenCalled();
+        expect(account).toStrictEqual(expected);
+      } catch (e) {
+        expect((e as Error).message).toContain('account is not initialized');
+      }
+    });
+  });
 });

src/provider/jsonrpc/jsonrpc.ts

@@ -9,6 +9,7 @@ import {
 } from '../endpoints';
 import { Provider } from '../provider';
 import {
+  ABCIAccount,
   ABCIErrorKey,
   ABCIResponse,
   BlockInfo,
@@ -23,6 +24,7 @@ import {
   TxResult,
 } from '../types';
 import {
+  extractAccountFromResponse,
   extractAccountNumberFromResponse,
   extractBalanceFromResponse,
   extractSequenceFromResponse,
@@ -160,6 +162,22 @@ export class JSONRPCProvider implements Provider {
     );
   }
 
+  async getAccount(address: string, height?: number): Promise<ABCIAccount> {
+    const abciResponse: ABCIResponse = await RestService.post<ABCIResponse>(
+      this.baseURL,
+      {
+        request: newRequest(ABCIEndpoint.ABCI_QUERY, [
+          `auth/accounts/${address}`,
+          '',
+          '0', // Height; not supported > 0 for now
+          false,
+        ]),
+      }
+    );
+
+    return extractAccountFromResponse(abciResponse.response.ResponseBase.Data);
+  }
+
   async getStatus(): Promise<Status> {
     return await RestService.post<Status>(this.baseURL, {
       request: newRequest(CommonEndpoint.STATUS),

src/provider/provider.ts

@@ -1,4 +1,5 @@
 import {
+  ABCIAccount,
   BlockInfo,
   BlockResult,
   BroadcastAsGeneric,
@@ -33,6 +34,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>;
 
@@ -42,9 +44,19 @@ 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

src/provider/utility/provider.utility.ts

@@ -96,6 +96,28 @@ export const extractAccountNumberFromResponse = (
   }
 };
 
+/**
+ * Extracts the account from the ABCI response
+ * @param {string | null} abciData the base64-encoded ABCI data
+ */
+export const extractAccountFromResponse = (
+  abciData: string | null
+): ABCIAccount => {
+  // Make sure the response is initialized
+  if (!abciData) {
+    throw new Error('account is not initialized');
+  }
+
+  try {
+    // Parse the account
+    const account: ABCIAccount = parseABCI<ABCIAccount>(abciData);
+
+    return account;
+  } catch (e) {
+    throw new Error('account is not initialized');
+  }
+};
+
 /**
  * Extracts the simulate transaction response from the ABCI response value
  * @param {string | null} abciData the base64-encoded ResponseDeliverTx proto message

src/provider/websocket/ws.test.ts

@@ -260,6 +260,35 @@ describe('WS Provider', () => {
     });
   });
 
+  describe('getAccount', () => {
+    const validAccount: ABCIAccount = {
+      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 %#', async (response, expected) => {
+      const mockResponse: ABCIResponse = mockABCIResponse(response);
+
+      // Set the response
+      await setHandler<ABCIResponse>(mockResponse);
+
+      try {
+        const account: ABCIAccount = await wsProvider.getAccount('address');
+        expect(account).toStrictEqual(expected);
+      } catch (e) {
+        expect((e as Error).message).toContain('account is not initialized');
+      }
+    });
+  });
+
   describe('getBalance', () => {
     const denomination = 'atom';
     test.each([

src/provider/websocket/ws.ts

@@ -8,6 +8,7 @@ import {
 } from '../endpoints';
 import { Provider } from '../provider';
 import {
+  ABCIAccount,
   ABCIErrorKey,
   ABCIResponse,
   BlockInfo,
@@ -23,6 +24,7 @@ import {
   TxResult,
 } from '../types';
 import {
+  extractAccountFromResponse,
   extractAccountNumberFromResponse,
   extractBalanceFromResponse,
   extractSequenceFromResponse,
@@ -274,6 +276,22 @@ export class WSProvider implements Provider {
     );
   }
 
+  async getAccount(address: string, height?: number): Promise<ABCIAccount> {
+    const response = await this.sendRequest<ABCIResponse>(
+      newRequest(ABCIEndpoint.ABCI_QUERY, [
+        `auth/accounts/${address}`,
+        '',
+        '0', // Height; not supported > 0 for now
+        false,
+      ])
+    );
+
+    // Parse the response
+    const abciResponse = this.parseResponse<ABCIResponse>(response);
+
+    return extractAccountFromResponse(abciResponse.response.ResponseBase.Data);
+  }
+
   async getStatus(): Promise<Status> {
     const response = await this.sendRequest<Status>(
       newRequest(CommonEndpoint.STATUS)