Add examples for added grpc client methods

Author: soerenbf

examples/nodejs/client/getTokenInfo.ts

@@ -0,0 +1,60 @@
+import { BlockHash } from '@concordium/web-sdk';
+import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
+import { TokenId, TokenInfo } from '@concordium/web-sdk/plt';
+import { credentials } from '@grpc/grpc-js';
+import meow from 'meow';
+
+import { parseEndpoint } from '../shared/util.js';
+
+const cli = meow(
+    `
+  Usage
+    $ yarn run-example <path-to-this-file> [options]
+
+  Required
+    --token, -t  The token to query information about
+
+  Options
+    --help,         Displays this message
+    --block,    -b  A block to query from, defaults to last final block
+    --endpoint, -e  Specify endpoint of the form "address:port", defaults to localhost:20000
+`,
+    {
+        importMeta: import.meta,
+        flags: {
+            token: {
+                type: 'string',
+                alias: 't',
+                isRequired: true,
+            },
+            block: {
+                type: 'string',
+                alias: 'b',
+            },
+            endpoint: {
+                type: 'string',
+                alias: 'e',
+                default: 'localhost:20000',
+            },
+        },
+    }
+);
+
+const [address, port] = parseEndpoint(cli.flags.endpoint);
+
+const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.createInsecure());
+
+/**
+ * Retrieves information about an protocol level token (PLT). The function must be provided a
+ * token id.
+ */
+(async () => {
+    // #region documentation-snippet
+    const tokenId = TokenId.fromString(cli.flags.token);
+    const blockHash = cli.flags.block === undefined ? undefined : BlockHash.fromHexString(cli.flags.block);
+    const tokenInfo: TokenInfo = await client.getTokenInfo(tokenId, blockHash);
+
+    console.log('Total token supply:', tokenInfo.state.totalSupply);
+    console.log('Token issuer:', tokenInfo.state.issuer);
+    // #endregion documentation-snippet
+})();

examples/nodejs/client/getTokenList.ts

@@ -0,0 +1,57 @@
+import { BlockHash } from '@concordium/web-sdk';
+import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
+import { TokenId } from '@concordium/web-sdk/plt';
+import { credentials } from '@grpc/grpc-js';
+import meow from 'meow';
+
+import { parseEndpoint } from '../shared/util.js';
+
+const cli = meow(
+    `
+  Usage
+    $ yarn run-example <path-to-this-file> [options]
+
+  Options
+    --help,         Displays this message
+    --block,    -b  A block to query from, defaults to last final block
+    --endpoint, -e  Specify endpoint of the form "address:port", defaults to localhost:20000
+`,
+    {
+        importMeta: import.meta,
+        flags: {
+            block: {
+                type: 'string',
+                alias: 'b',
+            },
+            endpoint: {
+                type: 'string',
+                alias: 'e',
+                default: 'localhost:20000',
+            },
+        },
+    }
+);
+
+const [address, port] = parseEndpoint(cli.flags.endpoint);
+
+const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.createInsecure());
+
+/**
+ * Retrieves the protocol level tokens that exists at the end of a given block as an async
+ * iterable. If a blockhash is not supplied it will pick the latest finalized
+ * block. An optional abortSignal can also be provided that closes the stream.
+
+ * Note: A stream can be collected to a list with the streamToList function.
+ */
+
+(async () => {
+    // #region documentation-snippet
+    const blockHash = cli.flags.block === undefined ? undefined : BlockHash.fromHexString(cli.flags.block);
+    const tokens: AsyncIterable<TokenId.Type> = client.getTokenList(blockHash);
+    // #endregion documentation-snippet
+
+    console.log('Protocol level tokens (PLTs) that exists at the end of the given block:');
+    for await (const token of tokens) {
+        console.log(token.toString());
+    }
+})();

packages/sdk/src/grpc/GRPCClient.ts

@@ -12,13 +12,13 @@ import { getAccountTransactionHandler } from '../accountTransactions.js';
 import { DEFAULT_INVOKE_ENERGY } from '../constants.js';
 import { calculateEnergyCost } from '../energyCost.js';
 import { HealthClient } from '../grpc-api/v2/concordium/health.client.js';
+import * as GRPCKernel from '../grpc-api/v2/concordium/kernel.js';
 import { QueriesClient } from '../grpc-api/v2/concordium/service.client.js';
 import * as GRPC from '../grpc-api/v2/concordium/types.js';
-import * as GRPCKernel from '../grpc-api/v2/concordium/kernel.js';
+import * as PLT from '../plt/types.js';
 import { RawModuleSchema } from '../schemaTypes.js';
 import { serializeAccountTransactionPayload } from '../serialization.js';
 import * as SDK from '../types.js';
-import * as PLT from '../plt/types.js';
 import { HexString, isRpcError } from '../types.js';
 import * as AccountAddress from '../types/AccountAddress.js';
 import * as BlockHash from '../types/BlockHash.js';
@@ -226,7 +226,10 @@ export class ConcordiumGRPCClient {
      * @returns An object with information about the contract instance.
      * @throws An error of type `RpcError` if not found in the block.
      */
-    async getInstanceInfo(contractAddress: ContractAddress.Type, blockHash?: BlockHash.Type): Promise<SDK.InstanceInfo> {
+    async getInstanceInfo(
+        contractAddress: ContractAddress.Type,
+        blockHash?: BlockHash.Type
+    ): Promise<SDK.InstanceInfo> {
         const instanceInfoRequest: GRPC.InstanceInfoRequest = {
             blockHash: getBlockHashInput(blockHash),
             address: ContractAddress.toProto(contractAddress),
@@ -1510,11 +1513,12 @@ export class ConcordiumGRPCClient {
         }
     }
 
-    // TODO: add example snippet
     /**
      * Get information about a protocol level token (PLT) at a certain block.
      * This endpoint is only supported for protocol version 9 and onwards.
      *
+     * {@codeblock ~~:nodejs/client/getTokenInfo.ts#documentation-snippet}
+     *
      * @param tokenId the ID of the token to query information about
      * @param blockHash an optional block hash to get the info from, otherwise retrieves from last finalized block.
      * @returns {PLT.TokenInfo} information about the corresponding token.
@@ -1524,23 +1528,25 @@ export class ConcordiumGRPCClient {
         const req: GRPC.TokenInfoRequest = {
             tokenId: PLT.TokenId.toProto(tokenId),
             blockHash: blockHashInput,
-        }
+        };
         const res = await this.client.getTokenInfo(req);
         return translate.trTokenInfo(res.response);
     }
 
-    // TODO: add example snippet
     /**
      * Get all token IDs currently registered at a block.
      * This endpoint is only supported for protocol version 9 and onwards.
      *
+     * {@codeblock ~~:nodejs/client/getTokenList.ts#documentation-snippet}
+     *
      * @param blockHash optional block hash, otherwise retrieves from last finalized block.
+     * @param abortSignal an optional AbortSignal to close the stream.
      *
      * @returns All token IDs registered at a block
      */
-    getTokenList(blockHash?: BlockHash.Type): AsyncIterable<PLT.TokenId.Type> {
+    getTokenList(blockHash?: BlockHash.Type, abortSignal?: AbortSignal): AsyncIterable<PLT.TokenId.Type> {
         const blockHashInput = getBlockHashInput(blockHash);
-        const tokenIds = this.client.getTokenList(blockHashInput).responses;
+        const tokenIds = this.client.getTokenList(blockHashInput, { abort: abortSignal }).responses;
         return mapStream(tokenIds, PLT.TokenId.fromProto);
     }
 }