Merge pull request #452 from near/view-state

Implement account.viewState which allows querying contract state directly
near · Nov 20, 2020 · 67400fa · 67400fa
2 parents 8807885 + 47e6b81
commit 67400fa
Show file tree

Hide file tree

Showing 9 changed files with 99 additions and 13 deletions.
diff --git a/lib/account.d.ts b/lib/account.d.ts
diff --git a/lib/account.js b/lib/account.js
diff --git a/lib/providers/json-rpc-provider.d.ts b/lib/providers/json-rpc-provider.d.ts
diff --git a/lib/providers/json-rpc-provider.js b/lib/providers/json-rpc-provider.js
diff --git a/lib/providers/provider.d.ts b/lib/providers/provider.d.ts
diff --git a/src/account.ts b/src/account.ts
@@ -18,6 +18,7 @@ import {
     SignedTransaction
 } from './transaction';
 import { FinalExecutionOutcome, TypedError, ErrorContext } from './providers';
+import { Finality, BlockId } from './providers/provider';
 import { Connection } from './connection';
 import {base_decode, base_encode} from './utils/serialize';
 import { PublicKey } from './utils/key_pair';
@@ -379,6 +380,31 @@ export class Account {
         return result.result && result.result.length > 0 && parse(Buffer.from(result.result));
     }
 
+    /**
+     * See https://docs.near.org/docs/api/rpc#view-contract-state
+     *
+     * Returns the state (key value pairs) of this account's contract based on the key prefix.
+     * Pass an empty string for prefix if you would like to return the entire state.
+     *
+     * @param prefix allows to filter which keys should be returned. Empty prefix means all keys. String prefix is utf-8 encoded.
+     * @param blockQuery specifies which block to query state at. By default returns last "optimistic" block (i.e. not necessarily finalized).
+     */
+    async viewState(prefix: string | Uint8Array, blockQuery: { blockId: BlockId } | { finality: Finality } ): Promise<Array<{ key: Buffer, value: Buffer}>> {
+        const { blockId, finality } = blockQuery as any || {};
+        const { values } = await this.connection.provider.query({
+            request_type: 'view_state',
+            block_id: blockId,
+            finality: blockId ? undefined : finality || 'optimistic',
+            account_id: this.accountId,
+            prefix_base64: Buffer.from(prefix).toString('base64')
+        });
+
+        return values.map(({key, value}) => ({
+            key: Buffer.from(key, 'base64'),
+            value: Buffer.from(value, 'base64')
+        }))
+    }
+
     /**
      * @returns array of {access_key: AccessKey, public_key: PublicKey} items.
      */

diff --git a/src/providers/json-rpc-provider.ts b/src/providers/json-rpc-provider.ts
@@ -68,13 +68,17 @@ export class JsonRpcProvider extends Provider {
 
     /**
      * Query the RPC as [shown in the docs](https://docs.nearprotocol.com/docs/interaction/rpc#query)
-     * @param path Path parameter for the RPC (ex. "contract/my_token")
-     * @param data Data parameter (ex. "", "AQ4", or whatever is needed)
      */
-    async query(path: string, data: string): Promise<any> {
-        const result = await this.sendJsonRpc('query', [path, data]);
+    async query(...args: any[]): Promise<any> {
+        let result;
+        if (args.length === 1) {
+            result = await this.sendJsonRpc('query', args[0]);
+        } else {
+            const [path, data] = args;
+            result = await this.sendJsonRpc('query', [path, data]);
+        }
         if (result && result.error) {
-            throw new Error(`Querying ${path} failed: ${result.error}.\n${JSON.stringify(result, null, 2)}`);
+            throw new Error(`Querying ${args} failed: ${result.error}.\n${JSON.stringify(result, null, 2)}`);
         }
         return result;
     }

diff --git a/src/providers/provider.ts b/src/providers/provider.ts
@@ -241,6 +241,7 @@ export abstract class Provider {
 
     abstract async sendTransaction(signedTransaction: SignedTransaction): Promise<FinalExecutionOutcome>;
     abstract async txStatus(txHash: Uint8Array, accountId: string): Promise<FinalExecutionOutcome>;
+    abstract async query(params: object): Promise<any>;
     abstract async query(path: string, data: string): Promise<any>;
     abstract async block(blockId: BlockId): Promise<BlockResult>;
     abstract async chunk(chunkId: ChunkId): Promise<ChunkResult>;

diff --git a/test/account.test.js b/test/account.test.js
@@ -142,6 +142,15 @@ describe('with deploy contract', () => {
         expect(await workingAccount.viewFunction(contractId, 'getValue', {})).toEqual(setCallValue);
     });
 
+    test('view contract state', async() => {
+        const setCallValue = testUtils.generateUniqueString('setCallPrefix');
+        await workingAccount.functionCall(contractId, 'setValue', { value: setCallValue });
+
+        const contractAccount = await nearjs.account(contractId);
+        const state = (await contractAccount.viewState('')).map(({ key, value }) => [key.toString('utf-8'), value.toString('utf-8')]);
+        expect(state).toEqual([['name', setCallValue]]);
+    });
+
     test('make function calls via account with custom parser', async() => {
         const result = await workingAccount.viewFunction(
             contractId,