@kleros/kleros-sdk 2.3.1 → 2.4.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this package will be documented in this file.
+
+The format is based on [Common Changelog](https://common-changelog.org/).
+
+## [2.4.0] - 2026-01-09
+
+### Added
+
+- Add optional field `extraEvidences` to the dispute details model to allow some arbitrable events to be rendered as evidence. ([#2210](https://github.com/kleros/kleros-v2/pull/2210))
+
+[2.4.0]: https://github.com/kleros/kleros-v2/releases/tag/%40kleros%2Fkleros-%402.4.0

package/lib/src/dataMappings/actions/callAction.js

@@ -18,6 +18,7 @@ const callAction = async (mapping) => {
         functionName,
         args,
     });
-    return (0, createResultObject_1.createResultObject)(data, seek, populate);
+    const sourceData = typeof data !== "object" ? { value: data } : data;
+    return (0, createResultObject_1.createResultObject)(sourceData, seek, populate);
 };
 exports.callAction = callAction;

package/lib/src/dataMappings/utils/disputeDetailsSchema.d.ts

@@ -5,6 +5,7 @@ export declare const isMultiaddr: (str: string) => boolean;
 export declare const ethAddressSchema: z.ZodEffects<z.ZodString, `0x${string}`, string>;
 export declare const ensNameSchema: z.ZodEffects<z.ZodString, string, string>;
 export declare const ethAddressOrEnsNameSchema: z.ZodUnion<[z.ZodEffects<z.ZodString, `0x${string}`, string>, z.ZodEffects<z.ZodString, string, string>]>;
+export declare const TxHashSchema: z.ZodEffects<z.ZodString, string, string>;
 export declare enum QuestionType {
     Bool = "bool",
     Datetime = "datetime",
@@ -46,6 +47,31 @@ export declare const AttachmentSchema: z.ZodObject<{
     uri: string;
 }>;
 export declare const AliasSchema: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodEffects<z.ZodString, `0x${string}`, string>, z.ZodEffects<z.ZodString, string, string>]>>;
+export declare const EvidenceSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodString;
+    fileURI: z.ZodOptional<z.ZodString>;
+    fileTypeExtension: z.ZodOptional<z.ZodString>;
+    transactionHash: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    sender: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, `0x${string}`, string>, z.ZodEffects<z.ZodString, string, string>]>>;
+    timestamp: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    description: string;
+    timestamp?: number | undefined;
+    sender?: string | undefined;
+    transactionHash?: string | undefined;
+    fileURI?: string | undefined;
+    fileTypeExtension?: string | undefined;
+}, {
+    name: string;
+    description: string;
+    timestamp?: number | undefined;
+    sender?: string | undefined;
+    transactionHash?: string | undefined;
+    fileURI?: string | undefined;
+    fileTypeExtension?: string | undefined;
+}>;
 declare const DisputeDetailsSchema: z.ZodObject<{
     title: z.ZodString;
     description: z.ZodString;
@@ -85,6 +111,31 @@ declare const DisputeDetailsSchema: z.ZodObject<{
     lang: z.ZodOptional<z.ZodString>;
     specification: z.ZodOptional<z.ZodString>;
     aliases: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodEffects<z.ZodString, `0x${string}`, string>, z.ZodEffects<z.ZodString, string, string>]>>>;
+    extraEvidences: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        fileURI: z.ZodOptional<z.ZodString>;
+        fileTypeExtension: z.ZodOptional<z.ZodString>;
+        transactionHash: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        sender: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, `0x${string}`, string>, z.ZodEffects<z.ZodString, string, string>]>>;
+        timestamp: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description: string;
+        timestamp?: number | undefined;
+        sender?: string | undefined;
+        transactionHash?: string | undefined;
+        fileURI?: string | undefined;
+        fileTypeExtension?: string | undefined;
+    }, {
+        name: string;
+        description: string;
+        timestamp?: number | undefined;
+        sender?: string | undefined;
+        transactionHash?: string | undefined;
+        fileURI?: string | undefined;
+        fileTypeExtension?: string | undefined;
+    }>, "many">>;
     version: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     description: string;
@@ -99,6 +150,15 @@ declare const DisputeDetailsSchema: z.ZodObject<{
     policyURI: string;
     arbitratorChainID: string;
     arbitratorAddress: `0x${string}`;
+    extraEvidences: {
+        name: string;
+        description: string;
+        timestamp?: number | undefined;
+        sender?: string | undefined;
+        transactionHash?: string | undefined;
+        fileURI?: string | undefined;
+        fileTypeExtension?: string | undefined;
+    }[];
     version: string;
     attachment?: {
         label: string;
@@ -134,5 +194,14 @@ declare const DisputeDetailsSchema: z.ZodObject<{
     lang?: string | undefined;
     specification?: string | undefined;
     aliases?: Record<string, string> | undefined;
+    extraEvidences?: {
+        name: string;
+        description: string;
+        timestamp?: number | undefined;
+        sender?: string | undefined;
+        transactionHash?: string | undefined;
+        fileURI?: string | undefined;
+        fileTypeExtension?: string | undefined;
+    }[] | undefined;
 }>;
 export default DisputeDetailsSchema;

package/lib/src/dataMappings/utils/disputeDetailsSchema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AliasSchema = exports.AttachmentSchema = exports.RefuseToArbitrateAnswer = exports.AnswerSchema = exports.QuestionTypeSchema = exports.QuestionType = exports.ethAddressOrEnsNameSchema = exports.ensNameSchema = exports.ethAddressSchema = exports.isMultiaddr = exports.isHexId = exports.isHexAddress = void 0;
+exports.EvidenceSchema = exports.AliasSchema = exports.AttachmentSchema = exports.RefuseToArbitrateAnswer = exports.AnswerSchema = exports.QuestionTypeSchema = exports.QuestionType = exports.TxHashSchema = exports.ethAddressOrEnsNameSchema = exports.ensNameSchema = exports.ethAddressSchema = exports.isMultiaddr = exports.isHexId = exports.isHexAddress = void 0;
 const zod_1 = require("zod");
 const viem_1 = require("viem");
 const ens_1 = require("viem/ens");
@@ -21,6 +21,9 @@ exports.ensNameSchema = zod_1.z
 exports.ethAddressOrEnsNameSchema = zod_1.z.union([exports.ethAddressSchema, exports.ensNameSchema], {
     errorMap: () => ({ message: "Provided address or ENS name is invalid." }),
 });
+exports.TxHashSchema = zod_1.z.string().refine((value) => (0, exports.isHexId)(value) && value.length === 66, {
+    message: "Provided transaction hash is invalid.",
+});
 var QuestionType;
 (function (QuestionType) {
     QuestionType["Bool"] = "bool";
@@ -47,6 +50,15 @@ exports.AttachmentSchema = zod_1.z.object({
     uri: zod_1.z.string(),
 });
 exports.AliasSchema = zod_1.z.record(exports.ethAddressOrEnsNameSchema);
+exports.EvidenceSchema = zod_1.z.object({
+    name: zod_1.z.string(),
+    description: zod_1.z.string(),
+    fileURI: zod_1.z.string().optional(),
+    fileTypeExtension: zod_1.z.string().optional(),
+    transactionHash: exports.TxHashSchema.optional(),
+    sender: exports.ethAddressOrEnsNameSchema.optional(),
+    timestamp: zod_1.z.number().optional(),
+});
 const MetadataSchema = zod_1.z.record(zod_1.z.unknown());
 const DisputeDetailsSchema = zod_1.z.object({
     title: zod_1.z.string(),
@@ -65,6 +77,7 @@ const DisputeDetailsSchema = zod_1.z.object({
     lang: zod_1.z.string().optional(),
     specification: zod_1.z.string().optional(),
     aliases: exports.AliasSchema.optional(),
+    extraEvidences: zod_1.z.array(exports.EvidenceSchema).default([]),
     version: zod_1.z.string(),
 });
 exports.default = DisputeDetailsSchema;

package/lib/src/dataMappings/utils/lambdas.d.ts

@@ -0,0 +1,3 @@
+export declare const lambdas: {
+    hex: () => (text: string, render: (value: string) => string) => string;
+};

package/lib/src/dataMappings/utils/lambdas.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lambdas = void 0;
+exports.lambdas = {
+    hex: function () {
+        return function (text, render) {
+            const originalValueStr = render(text);
+            const num = parseInt(originalValueStr, 10);
+            if (!isNaN(num)) {
+                return "0x" + num.toString(16).toLowerCase();
+            }
+            return originalValueStr;
+        };
+    },
+};

package/lib/src/dataMappings/utils/populateTemplate.js

@@ -29,8 +29,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.populateTemplate = void 0;
 const mustache_1 = __importDefault(require("mustache"));
 const disputeDetailsSchema_1 = __importStar(require("./disputeDetailsSchema"));
+const lambdas_1 = require("./lambdas");
 const populateTemplate = (mustacheTemplate, data) => {
-    const render = mustache_1.default.render(mustacheTemplate, data);
+    const render = mustache_1.default.render(mustacheTemplate, { ...lambdas_1.lambdas, ...data });
     const dispute = JSON.parse(render);
     const validation = disputeDetailsSchema_1.default.safeParse(dispute);
     if (!validation.success) {

package/lib/src/requests/fetchDisputeDetails.d.ts

@@ -4,7 +4,6 @@ type DisputeDetailsQueryResponse = {
             id: string;
         };
         arbitrableChainId: number;
-        externalDisputeId: number;
         templateId: number;
     };
 };

package/lib/src/requests/fetchDisputeDetails.js

@@ -13,7 +13,6 @@ const query = (0, core_1.gql) `
         id
       }
       arbitrableChainId
-      externalDisputeId
       templateId
     }
   }

package/lib/src/utils/getDispute.js

@@ -27,7 +27,6 @@ const getDispute = async (disputeParameters) => {
     const initialContext = {
         arbitrableAddress: disputeDetails.dispute.arbitrated.id,
         arbitrableChainID: disputeDetails.dispute.arbitrableChainId,
-        externalDisputeID: disputeDetails.dispute.externalDisputeId,
         ...options?.additionalContext,
     };
     let data = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kleros/kleros-sdk",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "SDK for Kleros version 2",
   "repository": "git@github.com:kleros/kleros-v2.git",
   "homepage": "https://github.com/kleros/kleros-v2/tree/master/kleros-sdk#readme",
@@ -15,7 +15,7 @@
   ],
   "type": "commonjs",
   "volta": {
-    "node": "20.18.3"
+    "node": "20.19.5"
   },
   "publishConfig": {
     "access": "public",
@@ -33,22 +33,22 @@
   },
   "devDependencies": {
     "@types/mustache": "^4.2.5",
-    "@types/node": "^20.17.6",
-    "@vitest/ui": "^1.6.0",
+    "@types/node": "^20.19.24",
+    "@vitest/ui": "^1.6.1",
     "mocha": "^10.8.2",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3",
-    "viem": "^2.21.48",
-    "vitest": "^1.6.0"
+    "viem": "^2.24.1",
+    "vitest": "^1.6.1"
   },
   "dependencies": {
-    "@reality.eth/reality-eth-lib": "^3.2.60",
+    "@reality.eth/reality-eth-lib": "^3.4.15",
     "@urql/core": "^5.0.8",
     "mustache": "^4.2.0",
     "zod": "^3.23.8"
   },
   "peerDependencies": {
-    "viem": "^2.21.48"
+    "viem": "^2.24.1"
   }
 }