fix(#1687): fix building metadata body

IntersectMBO · Aug 7, 2024 · ea8609d · ea8609d
1 parent cfd5b11
commit ea8609d
Show file tree

Hide file tree

Showing 10 changed files with 7,398 additions and 2,790 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ changes.
 ### Fixed
 
 - Incorrect copy on DRep votes + other minor copy spelling mistakes
+- Remove incorrect @value property to fix validating the metadata body [Issue 1687](https://github.com/IntersectMBO/govtool/issues/1687)
 
 ### Changed
 

diff --git a/govtool/frontend/junit-report.xml b/govtool/frontend/junit-report.xml
diff --git a/govtool/frontend/src/consts/CIP100Context.ts b/govtool/frontend/src/consts/CIP100Context.ts
@@ -1,5 +1,4 @@
 export const CIP_100_CONTEXT = {
-  "@language": "en-us",
   CIP100:
     "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#",
   hashAlgorithm: "CIP100:hashAlgorithm",

diff --git a/govtool/frontend/src/consts/dRepActions/jsonContext.ts b/govtool/frontend/src/consts/dRepActions/jsonContext.ts
@@ -2,7 +2,6 @@ export const CIP_QQQ =
   "https://github.com/cardano-foundation/CIPs/blob/master/CIP-QQQ/README.md#";
 
 export const DREP_CONTEXT = {
-  "@language": "en-us",
   CIP100:
     "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#",
   CIPQQQ: CIP_QQQ,

diff --git a/govtool/frontend/src/consts/governanceAction/fields.ts b/govtool/frontend/src/consts/governanceAction/fields.ts
@@ -126,7 +126,6 @@ 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:

diff --git a/govtool/frontend/src/context/governanceAction.test.tsx b/govtool/frontend/src/context/governanceAction.test.tsx
@@ -7,29 +7,17 @@ import {
 } from "./governanceAction";
 
 const resultMetadataBody = {
-  abstract: {
-    "@value": "Test",
-  },
-  motivation: {
-    "@value": "Test",
-  },
-  rationale: {
-    "@value": "Test",
-  },
+  abstract: "Test",
+  motivation: "Test",
+  rationale: "Test",
   references: [
     {
       "@type": "Other",
-      label: {
-        "@value": "Test",
-      },
-      uri: {
-        "@value": "http://example.com",
-      },
+      label: "Test",
+      uri: "http://example.com",
     },
   ],
-  title: {
-    "@value": "Test",
-  },
+  title: "Test",
 };
 
 describe("GovernanceActionProvider", () => {
@@ -92,7 +80,7 @@ describe("GovernanceActionProvider", () => {
           const hash = await createHash(jsonld!);
           expect(hash).toBeDefined();
           expect(hash).toBe(
-            "b84e9890a34d6e59a983cf8f695214162893de5fc5310b12b75f4fe3dab0d7ab",
+            "bbdbbe163d1b8e4d6c10180df515cc7d58109412d90a42e898fc66850b3fc98c",
           );
         };
         test();

diff --git a/govtool/frontend/src/utils/tests/canonizeJSON.test.ts b/govtool/frontend/src/utils/tests/canonizeJSON.test.ts
@@ -3,7 +3,6 @@ import { canonizeJSON } from "..";
 
 const exampleJson = {
   "@context": {
-    "@language": "en-us",
     CIP100:
       "https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#",
     CIP108:

diff --git a/govtool/frontend/yarn.lock b/govtool/frontend/yarn.lock
diff --git a/govtool/metadata-validation/src/schemas/cipStandardSchema.test.ts b/govtool/metadata-validation/src/schemas/cipStandardSchema.test.ts
@@ -4,7 +4,6 @@ import { cipStandardSchema } from './cipStandardSchema';
 
 const validCIP108Data = {
   '@context': {
-    '@language': 'en',
     CIP100:
       'https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#',
     CIP108:
@@ -38,7 +37,6 @@ const validCIP108Data = {
 
 const validCIPQQQData = {
   '@context': {
-    '@language': 'en',
     CIP100:
       'https://github.com/cardano-foundation/CIPs/blob/master/CIP-0100/README.md#',
     CIPQQQ:

diff --git a/govtool/metadata-validation/src/schemas/cipStandardSchema.ts b/govtool/metadata-validation/src/schemas/cipStandardSchema.ts
@@ -17,36 +17,25 @@ export const cipStandardSchema: StandardSpecification = {
   // Source of CIP-108: https://github.com/Ryun1/CIPs/blob/governance-metadata-actions/CIP-0108/README.md
   [MetadataStandard.CIP108]: Joi.object({
     '@context': Joi.object({
-      '@language': Joi.string().required(),
       CIP100: Joi.string().valid(CIP100_URL).required(),
       CIP108: Joi.string().valid(CIP108_URL).required(),
       hashAlgorithm: Joi.string().valid('CIP100:hashAlgorithm').required(),
       body: Joi.object(),
       authors: Joi.object(),
     }),
     authors: Joi.array(),
-    hashAlgorithm: Joi.object({
-      '@value': Joi.string().valid('blake2b-256').required(),
-    }),
+    hashAlgorithm: Joi.string().valid('blake2b-256').required(),
     body: Joi.object({
-      title: Joi.object({
-        '@value': Joi.string().max(80).required(),
-      }).required(),
-      abstract: Joi.object({
-        '@value': Joi.string().max(2500).required(),
-      }).required(),
-      motivation: Joi.object({ '@value': Joi.string().required() }).required(),
-      rationale: Joi.object({ '@value': Joi.string().required() }).required(),
+      title: Joi.string().max(80).required(),
+      abstract: Joi.string().max(2500).required(),
+      motivation: Joi.string().required(),
+      rationale: Joi.string().required(),
       references: Joi.array()
         .items(
           Joi.object({
             '@type': Joi.string().required(),
-            label: Joi.object({
-              '@value': Joi.string().required(),
-            }).required(),
-            uri: Joi.object({
-              '@value': Joi.string().required(),
-            }).required(),
+            label: Joi.string().required(),
+            uri: Joi.string().required(),
             referenceHash: Joi.object({
               hashDigest: Joi.string().required(),
               hashAlgorithm: Joi.string().required(),
@@ -58,31 +47,24 @@ export const cipStandardSchema: StandardSpecification = {
   }),
   [MetadataStandard.CIPQQQ]: Joi.object({
     '@context': Joi.object({
-      '@language': Joi.string().required(),
       CIP100: Joi.string().valid(CIP100_URL).required(),
       CIPQQQ: Joi.string().valid(CIPQQQ_URL).required(),
       hashAlgorithm: Joi.string().valid('CIP100:hashAlgorithm').required(),
       body: Joi.object(),
       authors: Joi.object(),
     }),
     authors: Joi.array(),
-    hashAlgorithm: Joi.object({
-      '@value': Joi.string().valid('blake2b-256').required(),
-    }),
+    hashAlgorithm: Joi.string().valid('blake2b-256').required(),
     body: Joi.object({
-      bio: Joi.object({ '@value': Joi.string().allow('') }).required(),
-      dRepName: Joi.object({ '@value': Joi.string().allow('') }).required(),
-      email: Joi.object({ '@value': Joi.string().allow('') }).required(),
+      bio: Joi.string().allow(''),
+      dRepName: Joi.string().allow(''),
+      email: Joi.string().allow('').required(),
       references: Joi.array()
         .items(
           Joi.object({
             '@type': Joi.string(),
-            label: Joi.object({
-              '@value': Joi.string().allow('').required(),
-            }).required(),
-            uri: Joi.object({
-              '@value': Joi.string().required(),
-            }).required(),
+            label: Joi.string().allow('').required(),
+            uri: Joi.string().required(),
             referenceHash: Joi.object({
               hashDigest: Joi.string().required(),
               hashAlgorithm: Joi.string().required(),