fix(#2509): fix nested @value in metadatas

Author: MSzalowski

CHANGELOG.md

@@ -20,6 +20,7 @@ changes.
 - Fix link and description validation [Issue 2403](https://github.com/IntersectMBO/govtool/issues/2403)
 - Revert to drep_distr for providing active voting power
 - Add rewards amount in the ada holder voting power
+- Fix nested @value in jsonld metadatas [Issue 2509](https://github.com/IntersectMBO/govtool/issues/2509)
 
 ### Changed
 

govtool/frontend/src/consts/governanceAction/fields.ts

@@ -126,6 +126,7 @@ export const GOVERNANCE_ACTION_FIELDS: GovernanceActionFields = {
 } as const;
 
 export const GOVERNANCE_ACTION_CONTEXT = {
+  "@language": "en-us",
   CIP100:
     "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#",
   CIP108:

govtool/frontend/src/context/featureFlag.tsx

@@ -127,6 +127,7 @@ const FeatureFlagProvider = ({ children }: PropsWithChildren) => {
     () => ({
       isProposalDiscussionForumEnabled:
         import.meta.env.VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED === "true" ||
+        import.meta.env.VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED === true ||
         false,
       isVotingOnGovernanceActionEnabled,
       areDRepVoteTotalsDisplayed,

govtool/frontend/src/context/governanceAction.tsx

@@ -10,7 +10,7 @@ import { NodeObject } from "jsonld";
 import { blake2bHex } from "blakejs";
 import * as Sentry from "@sentry/react";
 
-import { CIP_108, GOVERNANCE_ACTION_CONTEXT } from "@/consts";
+import { GOVERNANCE_ACTION_CONTEXT } from "@/consts";
 import { generateJsonld, generateMetadataBody } from "@/utils";
 
 type GovActionMetadata = {
@@ -53,7 +53,6 @@ const GovernanceActionProvider = ({ children }: PropsWithChildren) => {
         const metadataBody = generateMetadataBody({
           data: govActionMetadata,
           acceptedKeys: ["title", "abstract", "motivation", "rationale"],
-          standardReference: CIP_108,
         });
 
         const jsonLD = await generateJsonld(

govtool/frontend/src/hooks/forms/useCreateGovernanceActionForm.ts

@@ -7,7 +7,6 @@ import { useTranslation } from "react-i18next";
 import { NodeObject } from "jsonld";
 
 import {
-  CIP_108,
   GOVERNANCE_ACTION_CONTEXT,
   PATHS,
   storageInformationErrorModals,
@@ -104,7 +103,6 @@ export const useCreateGovernanceActionForm = (
     const body = generateMetadataBody({
       data: getValues(),
       acceptedKeys: ["title", "motivation", "abstract", "rationale"],
-      standardReference: CIP_108,
     });
 
     const jsonld = await generateJsonld(body, GOVERNANCE_ACTION_CONTEXT);

govtool/frontend/src/hooks/forms/useEditDRepInfoForm.ts

@@ -6,12 +6,7 @@ import { blake2bHex } from "blakejs";
 import * as Sentry from "@sentry/react";
 import { NodeObject } from "jsonld";
 
-import {
-  CIP_119,
-  DREP_CONTEXT,
-  PATHS,
-  storageInformationErrorModals,
-} from "@consts";
+import { DREP_CONTEXT, PATHS, storageInformationErrorModals } from "@consts";
 import { useCardano, useModal, useAppContext } from "@context";
 import { downloadJson, generateJsonld, generateMetadataBody } from "@utils";
 import { MetadataValidationStatus } from "@models";
@@ -92,13 +87,11 @@ export const useEditDRepInfoForm = (
         "motivations",
         "qualifications",
         "paymentAddress",
-        "references",
         "doNotList",
       ],
-      standardReference: CIP_119,
     });
 
-    const jsonld = await generateJsonld(body, DREP_CONTEXT, CIP_119);
+    const jsonld = await generateJsonld(body, DREP_CONTEXT);
 
     const jsonHash = blake2bHex(JSON.stringify(jsonld, null, 2), undefined, 32);
 

govtool/frontend/src/hooks/forms/useRegisterAsdRepForm.tsx

@@ -7,12 +7,7 @@ import * as Sentry from "@sentry/react";
 import { NodeObject } from "jsonld";
 import { CertificatesBuilder } from "@emurgo/cardano-serialization-lib-asmjs";
 
-import {
-  CIP_119,
-  DREP_CONTEXT,
-  PATHS,
-  storageInformationErrorModals,
-} from "@consts";
+import { DREP_CONTEXT, PATHS, storageInformationErrorModals } from "@consts";
 import { useCardano, useModal, useAppContext } from "@context";
 import { MetadataValidationStatus } from "@models";
 import {
@@ -108,12 +103,11 @@ export const useRegisterAsdRepForm = (
         "motivations",
         "qualifications",
         "paymentAddress",
-        "references",
         "doNotList",
       ],
-      standardReference: CIP_119,
     });
-    const jsonld = await generateJsonld(body, DREP_CONTEXT, CIP_119);
+
+    const jsonld = await generateJsonld(body, DREP_CONTEXT);
 
     const jsonHash = blake2bHex(JSON.stringify(jsonld, null, 2), undefined, 32);
 

govtool/frontend/src/hooks/forms/useVoteContextForm.tsx

@@ -6,7 +6,7 @@ import { NodeObject } from "jsonld";
 
 import { downloadJson, generateJsonld, generateMetadataBody } from "@utils";
 import { MetadataValidationStatus } from "@models";
-import { CIP_100, CIP_100_CONTEXT } from "@/consts";
+import { CIP_100_CONTEXT } from "@/consts";
 
 import { useValidateMutation } from "../mutations";
 
@@ -43,9 +43,8 @@ export const useVoteContextForm = (
         comment: voteContextText,
       },
       acceptedKeys: ["comment"],
-      standardReference: CIP_100,
     });
-    const jsonld = await generateJsonld(body, CIP_100_CONTEXT, CIP_100);
+    const jsonld = await generateJsonld(body, CIP_100_CONTEXT);
 
     const jsonHash = blake2bHex(JSON.stringify(jsonld, null, 2), undefined, 32);
 

govtool/frontend/src/utils/generateJsonld.ts

@@ -1,7 +1,5 @@
 import * as jsonld from "jsonld";
 
-import { CIP_100, CIP_108 } from "@/consts";
-
 /**
  * Generates a JSON-LD document by compacting the given body and context.
  *
@@ -17,12 +15,11 @@ export const generateJsonld = async <
 >(
   body: T,
   context: C,
-  bodyCip: string = CIP_108,
 ) => {
   const doc = {
-    [`${bodyCip}body`]: body,
-    [`${CIP_100}hashAlgorithm`]: "blake2b-256",
-    [`${CIP_100}authors`]: [],
+    "@context": context,
+    hashAlgorithm: "blake2b-256",
+    body,
   };
 
   const json = await jsonld.compact(doc, context);

govtool/frontend/src/utils/generateMetadataBody.ts

@@ -1,11 +1,6 @@
-import { CIP_100, CIP_108, CIP_119 } from "@/consts";
-
-type StandardReference = typeof CIP_100 | typeof CIP_108 | typeof CIP_119;
-
 type MetadataConfig = {
   data: Record<string, unknown>;
   acceptedKeys: string[];
-  standardReference: StandardReference;
 };
 
 /**
@@ -18,27 +13,25 @@ type MetadataConfig = {
 export const generateMetadataBody = ({
   data,
   acceptedKeys,
-  standardReference,
 }: MetadataConfig) => {
   const filteredData = Object.entries(data)
-    .filter(([key]) => acceptedKeys.includes(key))
-    .map(([key, value]) => [standardReference + key, value]);
+    .filter(([key, value]) => value && acceptedKeys.includes(key))
+    .map(([key, value]) => [key, value]);
 
   const references = data?.references
     ? // uri should not be optional. It is just not yet supported on govtool
       (data.references as Array<Partial<Reference>>)
         .filter((link) => link.uri)
         .map((link) => ({
           "@type": link["@type"] ?? "Other",
-          [`${CIP_100}reference-label`]: link.label || "Label",
-          [`${CIP_100}reference-uri`]: link.uri,
+          label: link.label || "Label",
+          uri: link.uri,
         }))
     : undefined;
 
   const body = Object.fromEntries(filteredData);
-
-  if (references) {
-    body[`${standardReference}references`] = references;
+  if (references?.length) {
+    body.references = references;
   }
 
   return body;