Merge branch 'feature/forwards-compatibility' into forward-comp/account-info

Author: soerenbf

examples/nodejs/client/getBlockItemStatus.ts

@@ -94,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/plt/modify-list.ts

@@ -156,8 +156,8 @@ const client = new ConcordiumGRPCNodeClient(
                     });
                     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

@@ -121,8 +121,8 @@ const client = new ConcordiumGRPCNodeClient(
                     });
                     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

@@ -129,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

@@ -123,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);

packages/sdk/CHANGELOG.md

@@ -23,6 +23,7 @@
 - `PendingUpdate.effect` now has the type `Upward<PendingUpateEffect>`.
 - `PassiveCommitteeInfo` now has been wrapped in `Upward`.
 - `NodeInfoConsensusStatus` and `NodeCatchupStatus` now have been wrapped in `Upward`.
+- `RejectReason` 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/translation.ts

@@ -1012,7 +1012,7 @@ function trDelegationEvent(
     }
 }
 
-function trRejectReason(rejectReason: GRPC.RejectReason | undefined): SDK.RejectReason {
+function trRejectReason(rejectReason: GRPC.RejectReason | undefined): Upward<SDK.RejectReason> {
     function simpleReason(tag: SDK.SimpleRejectReasonTag): SDK.RejectReason {
         return {
             tag: SDK.RejectReasonTag[tag],
@@ -1211,7 +1211,7 @@ function trRejectReason(rejectReason: GRPC.RejectReason | undefined): SDK.Reject
                 },
             };
         case undefined:
-            throw Error('Failed translating RejectReason, encountered undefined value');
+            return null;
     }
 }
 

packages/sdk/src/types.ts

@@ -1611,7 +1611,13 @@ export interface InvokeContractSuccessResult {
 export interface InvokeContractFailedResult {
     tag: 'failure';
     usedEnergy: Energy.Type;
-    reason: RejectReason;
+    /**
+     * The reject reason for the failed contract invocation.
+     *
+     * **Please note**, this can possibly be unknown if the SDK is not fully compatible with the Concordium
+     * node queried, in which case `null` is returned.
+     */
+    reason: Upward<RejectReason>;
     /**
      * Return value from smart contract call, used to provide error messages.
      * Is only defined when smart contract instance is a V1 smart contract and

packages/sdk/src/types/blockItemSummary.ts

@@ -210,7 +210,13 @@ export interface UpdateCredentialsSummary {
 export interface FailedTransactionSummary {
     transactionType: TransactionKindString.Failed;
     failedTransactionType?: TransactionKindString;
-    rejectReason: RejectReason;
+    /**
+     * The reject reason for the failed transaction
+     *
+     * **Please note**, this can possibly be unknown if the SDK is not fully compatible with the Concordium
+     * node queried, in which case `null` is returned.
+     */
+    rejectReason: Upward<RejectReason>;
 }
 
 /**
@@ -389,15 +395,15 @@ export const isSuccessTransaction = (
  *
  * @param {BlockItemSummary} summary - The block item summary to check.
  *
- * @returns {RejectReason | undfined} Reject reason if `summary` is a rejected transaction. Otherwise returns undefined.
+ * @returns {RejectReason | undefined} Reject reason if `summary` is a rejected transaction. Otherwise returns undefined.
  */
-export function getTransactionRejectReason<T extends FailedTransactionSummary>(summary: T): RejectReason;
+export function getTransactionRejectReason<T extends FailedTransactionSummary>(summary: T): Upward<RejectReason>;
 export function getTransactionRejectReason(summary: AccountCreationSummary | UpdateSummary): undefined;
 export function getTransactionRejectReason(
     summary: Exclude<AccountTransactionSummary, FailedTransactionSummary>
 ): undefined;
-export function getTransactionRejectReason(summary: BlockItemSummary): RejectReason | undefined;
-export function getTransactionRejectReason(summary: BlockItemSummary): RejectReason | undefined {
+export function getTransactionRejectReason(summary: BlockItemSummary): Upward<RejectReason> | undefined;
+export function getTransactionRejectReason(summary: BlockItemSummary): Upward<RejectReason> | undefined {
     if (!isRejectTransaction(summary)) {
         return undefined;
     }

packages/sdk/test/client/clientV2.test.ts

@@ -187,7 +187,7 @@ test.each(clients)('Failed invoke contract', async (client) => {
     }
 
     expect(result.usedEnergy.value).toBe(340n);
-    expect(result.reason.tag).toBe(v1.RejectReasonTag.RejectedReceive);
+    expect(result.reason?.tag).toBe(v1.RejectReasonTag.RejectedReceive);
 });
 
 test.each(clients)('Invoke contract on v0 contract', async (client) => {