Merge pull request #1635 from kleros/feat/more-robust-type-validations-in-sdk

feat(sdk): use zod directly for validating dispute templates

Author: jaybuidl

kleros-sdk/src/dataMappings/executeActions.ts

@@ -31,7 +31,7 @@ export const executeAction = async (mapping: ActionMapping, context: Record<stri
       return await fetchIpfsJsonAction(validateFetchIpfsJsonMapping(mapping));
     case "reality":
       mapping = validateRealityMapping(mapping);
-      return await retrieveRealityData(mapping.realityQuestionID, context.arbitrable);
+      return await retrieveRealityData(mapping.realityQuestionID, context.arbitrableAddress);
     default:
       throw new Error(`Unsupported action type: ${mapping.type}`);
   }

kleros-sdk/src/dataMappings/utils/DisputeDetailsValidator.ts

@@ -2,6 +2,13 @@ import { z } from "zod";
 import { isAddress } from "viem";
 import { normalize } from "viem/ens";
 
+const isHexAddress = (str: string): boolean => /^0x[a-fA-F0-9]{40}$/.test(str);
+const isHexId = (str: string): boolean => /^0x[a-fA-F0-9]{1,64}$/.test(str);
+const isMultiaddr = (str: string): boolean =>
+  /^\/(?:ip4|ip6|dns4|dns6|dnsaddr|tcp|udp|utp|tls|ws|wss|p2p-circuit|p2p-webrtc-star|p2p-webrtc-direct|p2p-websocket-star|onion|ipfs)(\/[^\s\/]+)+$|^ipfs:\/\/[a-zA-Z0-9]+\/[a-zA-Z0-9]+(\.[a-zA-Z0-9]+)?$/.test(
+    str
+  );
+
 export const ethAddressSchema = z.string().refine((value) => isAddress(value), {
   message: "Provided address is invalid.",
 });
@@ -26,40 +33,41 @@ export enum QuestionType {
 export const QuestionTypeSchema = z.nativeEnum(QuestionType);
 
 export const AnswerSchema = z.object({
-  id: z.string().regex(/^0x[0-9a-fA-F]+$/), // should be a bigint
+  id: z
+    .string()
+    .regex(/^0x[0-9a-fA-F]+$/)
+    .optional(),
   title: z.string(),
   description: z.string(),
-  reserved: z.boolean(),
+  reserved: z.boolean().optional(),
 });
 
 export const AttachmentSchema = z.object({
   label: z.string(),
   uri: z.string(),
 });
 
-export const AliasSchema = z.object({
-  id: z.string().optional(),
-  name: z.string(),
-  address: ethAddressOrEnsNameSchema,
-});
+export const AliasSchema = z.record(ethAddressOrEnsNameSchema);
+
+const MetadataSchema = z.record(z.unknown());
 
 const DisputeDetailsSchema = z.object({
   title: z.string(),
   description: z.string(),
   question: z.string(),
-  type: QuestionTypeSchema,
   answers: z.array(AnswerSchema),
-  policyURI: z.string(),
-  attachment: AttachmentSchema,
-  frontendUrl: z.string(),
-  arbitrableChainID: z.string(),
-  arbitrableAddress: ethAddressSchema,
+  policyURI: z.string().refine((value) => isMultiaddr(value), {
+    message: "Provided policy URI is not a valid multiaddr.",
+  }),
+  attachment: AttachmentSchema.optional(),
+  frontendUrl: z.string().optional(),
+  metadata: MetadataSchema.optional(),
   arbitratorChainID: z.string(),
   arbitratorAddress: ethAddressSchema,
-  category: z.string(),
-  lang: z.string(),
-  specification: z.string(),
-  aliases: z.array(AliasSchema).optional(),
+  category: z.string().optional(),
+  lang: z.string().optional(),
+  specification: z.string().optional(),
+  aliases: AliasSchema.optional(),
   version: z.string(),
 });
 

kleros-sdk/src/dataMappings/utils/disputeDetailsSchema.ts

@@ -1,15 +1,17 @@
 import mustache from "mustache";
 import { DisputeDetails } from "./disputeDetailsTypes";
-import { validate } from "./DisputeDetailsValidator";
+import DisputeDetailsSchema from "./disputeDetailsSchema";
 
 export const populateTemplate = (mustacheTemplate: string, data: any): DisputeDetails => {
   const render = mustache.render(mustacheTemplate, data);
   const dispute = JSON.parse(render);
 
-  // TODO: the validation below is too strict, it should be fixed, disabled for now, FIXME
-  if (!validate(dispute)) {
-    //   throw new Error(`Invalid dispute details format: ${JSON.stringify(dispute)}`);
+  const validation = DisputeDetailsSchema.safeParse(dispute);
+  if (!validation.success) {
+    console.error("Validation errors:", validation.error.errors, "\n\nDispute details:", `${JSON.stringify(dispute)}`);
+    throw new Error("Invalid dispute details format");
   }
+  console.log(dispute);
 
   return dispute;
 };

kleros-sdk/src/dataMappings/utils/populateTemplate.ts

@@ -12,6 +12,7 @@ import { iArbitrableV2Abi } from "hooks/contracts/generated";
 import { useEvidenceGroup } from "queries/useEvidenceGroup";
 import { debounceErrorToast } from "utils/debounceErrorToast";
 import { isUndefined } from "utils/index";
+import { DEFAULT_CHAIN } from "consts/chains";
 
 import { graphql } from "src/graphql";
 
@@ -64,7 +65,8 @@ export const usePopulatedDisputeData = (disputeID?: string, arbitrableAddress?:
 
           const initialContext = {
             disputeID: disputeID,
-            arbitrable: arbitrableAddress,
+            arbitrableAddress: arbitrableAddress,
+            arbitrableChainID: isCrossChainDispute ? crossChainData.crossChainId.toString() : DEFAULT_CHAIN.toString(),
             graphApiKey: import.meta.env.REACT_APP_GRAPH_API_KEY,
             alchemyApiKey: import.meta.env.ALCHEMY_API_KEY,
             externalDisputeID: externalDisputeID,

web/src/hooks/queries/usePopulatedDisputeData.ts

@@ -166,8 +166,8 @@ const DisputeTemplateView = () => {
 
         setTimeout(() => {
           const initialContext = {
-            arbitrator: debouncedParams._arbitrator,
-            arbitrable: debouncedParams._arbitrable,
+            arbitratorAddress: debouncedParams._arbitrator,
+            arbitrableAddress: debouncedParams._arbitrable,
             arbitrableDisputeID: debouncedParams._arbitrableDisputeID,
             externalDisputeID: debouncedParams._externalDisputeID,
             templateID: debouncedParams._templateId,