Merge pull request #503 from Concordium/forward-comp/COR-1837-Reward-Status

Wrap Upward around RewardStatus

Author: rbaconcordium

examples/nodejs/client/getTokenomicsInfo.ts

@@ -1,4 +1,4 @@
-import { BlockHash } from '@concordium/web-sdk';
+import { BlockHash, isKnown } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
@@ -55,6 +55,11 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
 
     // Protocol version 4 expanded the amount of information in the response, so one should check the type to access that.
     // This information includes information about the payday and total amount of funds staked.
+    if (!isKnown(tokenomics)) {
+        console.warn('Unknown tokenomics version found');
+        return;
+    }
+
     if (tokenomics.version === 1) {
         console.log('Next payday time:', tokenomics.nextPaydayTime);
         console.log('Total staked amount by bakers and delegators', tokenomics.totalStakedCapital);

packages/sdk/CHANGELOG.md

@@ -24,6 +24,7 @@
 - `PassiveCommitteeInfo` now has been wrapped in `Upward`.
 - `NodeInfoConsensusStatus` and `NodeCatchupStatus` now have been wrapped in `Upward`.
 - `RejectReason` now has been wrapped in `Upward`
+- `RewardStatus` now has been wrapped in `Upward`
 - `Cooldown.status` now has the type `Upward<CooldownStatus>`. This affects all `AccountInfo` variants.
 - `BakerPoolInfo.openStatus` now has the type `Upward<OpenStatusText>`.
   - Affects the `AccountInfoBaker` variant of `AccountInfo`.

packages/sdk/src/grpc/GRPCClient.ts

@@ -504,7 +504,7 @@ export class ConcordiumGRPCClient {
      * @param blockHash optional block hash to get the reward status at, otherwise retrieves from last finalized block
      * @returns the reward status at the given block, or undefined it the block does not exist.
      */
-    async getTokenomicsInfo(blockHash?: BlockHash.Type): Promise<SDK.TokenomicsInfo> {
+    async getTokenomicsInfo(blockHash?: BlockHash.Type): Promise<Upward<SDK.TokenomicsInfo>> {
         const blockHashInput = getBlockHashInput(blockHash);
 
         const response = await this.client.getTokenomicsInfo(blockHashInput).response;

packages/sdk/src/grpc/translation.ts

@@ -635,7 +635,7 @@ function translateProtocolVersion(pv: GRPC.ProtocolVersion): bigint {
     return BigInt(pv + 1); // Protocol version enum indexes from 0, i.e. pv.PROTOCOL_VERSION_1 = 0.
 }
 
-export function tokenomicsInfo(info: GRPC.TokenomicsInfo): SDK.RewardStatus {
+export function tokenomicsInfo(info: GRPC.TokenomicsInfo): Upward<SDK.RewardStatus> {
     switch (info.tokenomics.oneofKind) {
         case 'v0': {
             const v0 = info.tokenomics.v0;
@@ -666,7 +666,7 @@ export function tokenomicsInfo(info: GRPC.TokenomicsInfo): SDK.RewardStatus {
             };
         }
         case undefined:
-            throw new Error('Missing tokenomics info');
+            return null;
     }
 }