Feature/forwards compatibility

examples/nodejs/client/getBlockItemStatus.ts

@@ -1,4 +1,4 @@
-import { BlockItemStatus, CcdAmount, TransactionHash } from '@concordium/web-sdk';
+import { BlockItemStatus, CcdAmount, TransactionHash, knownOrError } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
@@ -77,8 +77,7 @@ const client = new ConcordiumGRPCNodeClient(
     if (blockItemStatus.status === 'finalized') {
         console.log('blockItemStatus is "finalized" and therefore there is exactly one outcome \n');
 
-        const { summary } = blockItemStatus.outcome;
-
+        const summary = knownOrError(blockItemStatus.outcome.summary, 'unknown outcome encountered');
         if (summary.type === 'accountTransaction') {
             console.log('The block item is an account transaction');
 
@@ -95,7 +94,7 @@ const client = new ConcordiumGRPCNodeClient(
                     const { failedTransactionType, rejectReason } = summary;
                     console.log(
                         'Transaction of type "' + failedTransactionType + '" failed because:',
-                        rejectReason.tag
+                        rejectReason?.tag ?? 'unknown'
                     );
                     break;
                 default:

examples/nodejs/client/getBlockSpecialEvents.ts

@@ -1,4 +1,4 @@
-import { BlockHash, BlockSpecialEvent } from '@concordium/web-sdk';
+import { BlockHash, BlockSpecialEvent, Upward, isKnown } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
@@ -50,10 +50,14 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
 (async () => {
     // #region documentation-snippet
     const blockHash = cli.flags.block === undefined ? undefined : BlockHash.fromHexString(cli.flags.block);
-    const events: AsyncIterable<BlockSpecialEvent> = client.getBlockSpecialEvents(blockHash);
+    const events: AsyncIterable<Upward<BlockSpecialEvent>> = client.getBlockSpecialEvents(blockHash);
     // #endregion documentation-snippet
 
     for await (const event of events) {
-        console.dir(event, { depth: null, colors: true });
+        if (!isKnown(event)) {
+            console.warn('Unknown event encountered');
+        } else {
+            console.dir(event, { depth: null, colors: true });
+        }
     }
 })();

examples/nodejs/client/getBlockTransactionEvents.ts

@@ -1,4 +1,4 @@
-import { BlockHash, BlockItemSummary } from '@concordium/web-sdk';
+import { BlockHash, BlockItemSummary, Upward, isKnown } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
@@ -48,10 +48,14 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
 (async () => {
     // #region documentation-snippet
     const blockHash = cli.flags.block === undefined ? undefined : BlockHash.fromHexString(cli.flags.block);
-    const events: AsyncIterable<BlockItemSummary> = client.getBlockTransactionEvents(blockHash);
+    const events: AsyncIterable<Upward<BlockItemSummary>> = client.getBlockTransactionEvents(blockHash);
     // #endregion documentation-snippet
 
     for await (const event of events) {
-        console.dir(event, { depth: null, colors: true });
+        if (isKnown(event)) {
+            console.dir(event, { depth: null, colors: true });
+        } else {
+            console.warn('Encountered unknown event');
+        }
     }
 })();

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);

examples/nodejs/client/invokeContract.ts

@@ -9,6 +9,7 @@ import {
     Parameter,
     ReceiveName,
     ReturnValue,
+    Upward,
 } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
 import { credentials } from '@grpc/grpc-js';
@@ -124,7 +125,7 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
             console.log('The return value of the invoked method:', ReturnValue.toHexString(returnValue));
         }
 
-        const events: ContractTraceEvent[] = result.events;
+        const events: Upward<ContractTraceEvent>[] = result.events;
         console.log('A list of effects that the update would have:');
         console.dir(events, { depth: null, colors: true });
     }

examples/nodejs/composed-examples/findAccountCreationBlock.ts

@@ -1,4 +1,4 @@
-import { AccountAddress, isRpcError } from '@concordium/web-sdk';
+import { AccountAddress, isKnown, isRpcError } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
@@ -75,6 +75,9 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
 
     // If account is not a genesis account print account creation transaction hash
     for await (const summary of summaries) {
+        if (!isKnown(summary)) {
+            continue;
+        }
         if (summary.type === 'accountCreation' && AccountAddress.equals(summary.address, account)) {
             console.log('Hash of transaction that created the account:', summary.hash);
         }

examples/nodejs/composed-examples/initAndUpdateContract.ts

@@ -17,6 +17,8 @@ import {
     affectedContracts,
     buildAccountSigner,
     deserializeReceiveReturnValue,
+    isKnown,
+    knownOrError,
     parseWallet,
     serializeInitContractParameters,
     serializeUpdateContractParameters,
@@ -118,7 +120,14 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
     const initStatus = await client.waitForTransactionFinalization(initTrxHash);
     console.dir(initStatus, { depth: null, colors: true });
 
-    const contractAddress = affectedContracts(initStatus.summary)[0];
+    if (!isKnown(initStatus.summary)) {
+        throw new Error('Unexpected transaction outcome');
+    }
+
+    const contractAddress = knownOrError(
+        affectedContracts(initStatus.summary)[0],
+        'Expected contract init event to be known'
+    );
 
     // #endregion documentation-snippet-init-contract
 

examples/nodejs/composed-examples/listInitialAccounts.ts

@@ -1,4 +1,4 @@
-import { unwrap } from '@concordium/web-sdk';
+import { isKnown, unwrap } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
@@ -71,6 +71,9 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
         // Get transactions for block
         const trxStream = client.getBlockTransactionEvents(block.hash);
         for await (const trx of trxStream) {
+            if (!isKnown(trx)) {
+                continue;
+            }
             if (trx.type === 'accountCreation' && trx.credentialType === 'initial') {
                 initAccounts.push(trx.address);
             }

examples/nodejs/composed-examples/listNumberAccountTransactions.ts

@@ -1,4 +1,4 @@
-import { AccountAddress, isTransferLikeSummary, unwrap } from '@concordium/web-sdk';
+import { AccountAddress, isKnown, isTransferLikeSummary, unwrap } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
@@ -75,6 +75,9 @@ const client = new ConcordiumGRPCNodeClient(address, Number(port), credentials.c
 
         // For each transaction in the block:
         trxLoop: for await (const trx of trxStream) {
+            if (!isKnown(trx)) {
+                continue;
+            }
             if (isTransferLikeSummary(trx)) {
                 const trxAcc = trx.sender;
 

examples/nodejs/plt/modify-list.ts

@@ -5,6 +5,7 @@ import {
     TransactionEventTag,
     TransactionKindString,
     TransactionSummaryType,
+    isKnown,
     serializeAccountTransactionPayload,
 } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
@@ -17,6 +18,7 @@ import {
     TokenOperation,
     TokenOperationType,
     createTokenUpdatePayload,
+    parseTokenModuleEvent,
 } from '@concordium/web-sdk/plt';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
@@ -137,22 +139,26 @@ const client = new ConcordiumGRPCNodeClient(
             const result = await client.waitForTransactionFinalization(transaction);
             console.log('Transaction finalized:', result);
 
+            if (!isKnown(result.summary)) {
+                throw new Error('Unexpected transaction outcome');
+            }
+
             if (result.summary.type !== TransactionSummaryType.AccountTransaction) {
                 throw new Error('Unexpected transaction type: ' + result.summary.type);
             }
 
             switch (result.summary.transactionType) {
                 case TransactionKindString.TokenUpdate:
-                    result.summary.events.forEach((e) => {
+                    result.summary.events.filter(isKnown).forEach((e) => {
                         if (e.tag !== TransactionEventTag.TokenModuleEvent) {
                             throw new Error('Unexpected event type: ' + e.tag);
                         }
-                        console.log('Token module event:', e, Cbor.decode(e.details, 'TokenListUpdateEventDetails'));
+                        console.log('Token module event:', parseTokenModuleEvent(e));
                     });
                     break;
                 case TransactionKindString.Failed:
-                    if (result.summary.rejectReason.tag !== RejectReasonTag.TokenUpdateTransactionFailed) {
-                        throw new Error('Unexpected reject reason tag: ' + result.summary.rejectReason.tag);
+                    if (result.summary.rejectReason?.tag !== RejectReasonTag.TokenUpdateTransactionFailed) {
+                        throw new Error('Unexpected reject reason tag: ' + result.summary.rejectReason?.tag);
                     }
                     const details = Cbor.decode(result.summary.rejectReason.contents.details);
                     console.error(result.summary.rejectReason.contents, details);

examples/nodejs/plt/pause.ts

@@ -4,10 +4,18 @@ import {
     TransactionEventTag,
     TransactionKindString,
     TransactionSummaryType,
+    isKnown,
     serializeAccountTransactionPayload,
 } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
-import { Cbor, Token, TokenId, TokenOperation, createTokenUpdatePayload } from '@concordium/web-sdk/plt';
+import {
+    Cbor,
+    Token,
+    TokenId,
+    TokenOperation,
+    createTokenUpdatePayload,
+    parseTokenModuleEvent,
+} from '@concordium/web-sdk/plt';
 import { credentials } from '@grpc/grpc-js';
 import meow from 'meow';
 
@@ -102,22 +110,26 @@ const client = new ConcordiumGRPCNodeClient(
             const result = await client.waitForTransactionFinalization(transaction);
             console.log('Transaction finalized:', result);
 
+            if (!isKnown(result.summary)) {
+                throw new Error('Unexpected transaction outcome');
+            }
+
             if (result.summary.type !== TransactionSummaryType.AccountTransaction) {
                 throw new Error('Unexpected transaction type: ' + result.summary.type);
             }
 
             switch (result.summary.transactionType) {
                 case TransactionKindString.TokenUpdate:
-                    result.summary.events.forEach((e) => {
+                    result.summary.events.filter(isKnown).forEach((e) => {
                         if (e.tag !== TransactionEventTag.TokenModuleEvent) {
                             throw new Error('Unexpected event type: ' + e.tag);
                         }
-                        console.log('Token module event:', e, Cbor.decode(e.details, 'TokenPauseEventDetails'));
+                        console.log('Token module event:', parseTokenModuleEvent(e));
                     });
                     break;
                 case TransactionKindString.Failed:
-                    if (result.summary.rejectReason.tag !== RejectReasonTag.TokenUpdateTransactionFailed) {
-                        throw new Error('Unexpected reject reason tag: ' + result.summary.rejectReason.tag);
+                    if (result.summary.rejectReason?.tag !== RejectReasonTag.TokenUpdateTransactionFailed) {
+                        throw new Error('Unexpected reject reason tag: ' + result.summary.rejectReason?.tag);
                     }
                     const details = Cbor.decode(result.summary.rejectReason.contents.details);
                     console.error(result.summary.rejectReason.contents, details);

examples/nodejs/plt/transfer.ts

@@ -4,6 +4,7 @@ import {
     RejectReasonTag,
     TransactionKindString,
     TransactionSummaryType,
+    isKnown,
     serializeAccountTransactionPayload,
 } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
@@ -116,6 +117,9 @@ const client = new ConcordiumGRPCNodeClient(
             const result = await client.waitForTransactionFinalization(transaction);
             console.log('Transaction finalized:', result);
 
+            if (!isKnown(result.summary)) {
+                throw new Error('Unexpected transaction outcome');
+            }
             if (result.summary.type !== TransactionSummaryType.AccountTransaction) {
                 throw new Error('Unexpected transaction type: ' + result.summary.type);
             }
@@ -125,8 +129,8 @@ const client = new ConcordiumGRPCNodeClient(
                     result.summary.events.forEach((e) => console.log(e));
                     break;
                 case TransactionKindString.Failed:
-                    if (result.summary.rejectReason.tag !== RejectReasonTag.TokenUpdateTransactionFailed) {
-                        throw new Error('Unexpected reject reason tag: ' + result.summary.rejectReason.tag);
+                    if (result.summary.rejectReason?.tag !== RejectReasonTag.TokenUpdateTransactionFailed) {
+                        throw new Error('Unexpected reject reason tag: ' + result.summary.rejectReason?.tag);
                     }
                     const details = Cbor.decode(result.summary.rejectReason.contents.details);
                     console.error(result.summary.rejectReason.contents, details);

examples/nodejs/plt/update-supply.ts

@@ -3,6 +3,7 @@ import {
     RejectReasonTag,
     TransactionKindString,
     TransactionSummaryType,
+    isKnown,
     serializeAccountTransactionPayload,
 } from '@concordium/web-sdk';
 import { ConcordiumGRPCNodeClient } from '@concordium/web-sdk/nodejs';
@@ -110,6 +111,9 @@ const client = new ConcordiumGRPCNodeClient(addr, Number(port), credentials.crea
             const result = await client.waitForTransactionFinalization(transaction);
             console.log('Transaction finalized:', result);
 
+            if (!isKnown(result.summary)) {
+                throw new Error('Unexpected transaction outcome');
+            }
             if (result.summary.type !== TransactionSummaryType.AccountTransaction) {
                 throw new Error('Unexpected transaction type: ' + result.summary.type);
             }
@@ -119,8 +123,8 @@ const client = new ConcordiumGRPCNodeClient(addr, Number(port), credentials.crea
                     result.summary.events.forEach((e) => console.log(e));
                     break;
                 case TransactionKindString.Failed:
-                    if (result.summary.rejectReason.tag !== RejectReasonTag.TokenUpdateTransactionFailed) {
-                        throw new Error('Unexpected reject reason tag: ' + result.summary.rejectReason.tag);
+                    if (result.summary.rejectReason?.tag !== RejectReasonTag.TokenUpdateTransactionFailed) {
+                        throw new Error('Unexpected reject reason tag: ' + result.summary.rejectReason?.tag);
                     }
                     const details = Cbor.decode(result.summary.rejectReason.contents.details);
                     console.error(result.summary.rejectReason.contents, details);

examples/wallet/src/CreateAccount.tsx

@@ -1,5 +1,5 @@
 import {
-    CredentialDeploymentTransaction,
+    CredentialDeploymentPayload,
     CredentialInputNoSeed,
     IdentityObjectV1,
     getAccountAddress,
@@ -43,7 +43,7 @@ export function CreateAccount({ identity }: { identity: IdentityObjectV1 }) {
             return;
         }
 
-        const listener = (worker.onmessage = async (e: MessageEvent<CredentialDeploymentTransaction>) => {
+        const listener = (worker.onmessage = async (e: MessageEvent<CredentialDeploymentPayload>) => {
             worker.removeEventListener('message', listener);
             const credentialDeploymentTransaction = e.data;
             const signingKey = getAccountSigningKey(seedPhrase, credentialDeploymentTransaction.unsignedCdi.ipIdentity);

examples/wallet/src/account-worker.ts

@@ -1,8 +1,8 @@
-import { createCredentialTransactionNoSeed } from '@concordium/web-sdk';
+import { createCredentialPayloadNoSeed } from '@concordium/web-sdk';
 
 import { AccountWorkerInput } from './types';
 
 self.onmessage = (e: MessageEvent<AccountWorkerInput>) => {
-    const credentialTransaction = createCredentialTransactionNoSeed(e.data.credentialInput, e.data.expiry);
+    const credentialTransaction = createCredentialPayloadNoSeed(e.data.credentialInput, e.data.expiry);
     self.postMessage(credentialTransaction);
 };