feat(kleros-sdk): get-dispute-function

Author: tractorss

kleros-sdk/package.json

@@ -35,6 +35,7 @@
   "dependencies": {
     "@kleros/kleros-v2-contracts": "workspace:^",
     "@reality.eth/reality-eth-lib": "^3.2.30",
+    "graphql-request": "^7.1.0",
     "mustache": "^4.2.0",
     "zod": "^3.22.4"
   }

kleros-sdk/src/dataMappings/executeActions.ts

@@ -37,7 +37,7 @@ export const executeAction = async (mapping: ActionMapping, context: Record<stri
   }
 };
 
-export const executeActions = async (mappings, initialContext = {}) => {
+export const executeActions = async (mappings, initialContext: Record<string, any> = {}) => {
   const context = { ...initialContext };
 
   for (const mapping of mappings) {

kleros-sdk/src/requests/fetchDisputeDetails.ts

@@ -0,0 +1,40 @@
+import { request } from "graphql-request";
+
+type DisputeDetailsQueryResponse = {
+  dispute: {
+    arbitrated: {
+      id: string;
+    };
+    arbitrableChainId: number;
+    externalDisputeId: number;
+    templateId: number;
+  };
+};
+
+const fetchDisputeDetails = (endpoint: string, id: number) => {
+  const query = `
+    query DisputeDetails {
+    dispute(id: ${id}) {
+        arbitrated {
+            id
+        }
+        arbitrableChainId
+        externalDisputeId
+        templateId
+    }
+  }
+`;
+
+  try {
+    return request<DisputeDetailsQueryResponse>(endpoint, query)
+      .then((res) => res)
+      .catch((err) => {
+        throw new Error(`Error querying Dispute Details , endpoint : ${endpoint}, message : ${err?.message}`);
+      });
+  } catch (error: any) {
+    console.log(`Query Error : ${error?.message}`);
+    return undefined;
+  }
+};
+
+export default fetchDisputeDetails;

kleros-sdk/src/requests/fetchDisputeTemplateFromId.ts

@@ -0,0 +1,32 @@
+import { request } from "graphql-request";
+
+type DisputeTemplateQueryResponse = {
+  disputeTemplate: {
+    templateData: string;
+    templateDataMappings: string;
+  };
+};
+
+const fetchDisputeTemplateFromId = (endpoint: string, id: number) => {
+  const query = `
+    query DisputeTemplate {
+        disputeTemplate(id: ${id}) {
+            templateData
+            templateDataMappings
+        }
+    }
+`;
+
+  try {
+    return request<DisputeTemplateQueryResponse>(endpoint, query)
+      .then((res) => res)
+      .catch((err) => {
+        throw new Error(`Error querying Dispute Template Registry , endpoint : ${endpoint}, message : ${err?.message}`);
+      });
+  } catch (error: any) {
+    console.log(`Query Error : ${error?.message}`);
+    return undefined;
+  }
+};
+
+export default fetchDisputeTemplateFromId;

kleros-sdk/src/sdk.ts

@@ -1,20 +1,15 @@
-import { createPublicClient, webSocket } from "viem";
-import { arbitrumSepolia } from "viem/chains";
+import { createPublicClient, type PublicClient } from "viem";
+import { SdkConfig } from "./types";
 
-let publicClient;
+let publicClient: PublicClient | undefined;
 
-export const configureSDK = (config: { apiKey?: string }) => {
-  if (config.apiKey) {
-    const ALCHEMY_API_KEY = config.apiKey;
-    const transport = webSocket(`wss://arb-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}`);
-    publicClient = createPublicClient({
-      chain: arbitrumSepolia,
-      transport,
-    });
+export const configureSDK = (config: SdkConfig) => {
+  if (config.client) {
+    publicClient = createPublicClient(config.client);
   }
 };
 
-export const getPublicClient = () => {
+export const getPublicClient = (): PublicClient | undefined => {
   if (!publicClient) {
     throw new Error("SDK not configured. Please call `configureSDK` before using.");
   }

kleros-sdk/src/types/index.ts

@@ -0,0 +1,17 @@
+import { PublicClientConfig } from "viem";
+
+export type SdkConfig = {
+  client: PublicClientConfig;
+};
+
+type GetDisputeParametersOptions = {
+  sdkConfig: SdkConfig;
+  additionalContext: Record<string, any>;
+};
+
+export type GetDisputeParameters = {
+  disputeId: number;
+  coreSubgraph: string;
+  dtrSubgraph: string;
+  options: GetDisputeParametersOptions | undefined;
+};

kleros-sdk/src/utils/getDispute.ts

@@ -0,0 +1,46 @@
+import { type GetDisputeParameters } from "src/types";
+import { configureSDK } from "src/sdk";
+import fetchDisputeDetails from "src/requests/fetchDisputeDetails";
+import fetchDisputeTemplateFromId from "src/requests/fetchDisputeTemplateFromId";
+import { executeActions } from "dataMappings/executeActions";
+import { populateTemplate } from "dataMappings/utils/populateTemplate";
+import { DisputeDetails } from "dataMappings/utils/disputeDetailsTypes";
+
+/**
+ * Retrieves dispute parameters based on the provided dispute ID and subgraph endpoints.
+ *
+ * @param {GetDisputeParameters} disputeParameters - The parameters required to get the dispute.
+ * @param {number} disputeParameters.disputeId - A unique numeric identifier of the dispute in the Kleros Core contract.
+ * @param {string} disputeParameters.coreSubgraph - Endpoint for the Kleros core subgraph to use.
+ * @param {string} disputeParameters.dtrSubgraph - Endpoint for the Kleros dispute template registry subgraph.
+ * @param {GetDisputeParametersOptions | undefined} disputeParameters.options - Optional parameters to configure the SDK and provide additional context, if not configured already.
+ */
+export const getDispute = async (disputeParameters: GetDisputeParameters): Promise<DisputeDetails | undefined> => {
+  if (disputeParameters.options?.sdkConfig) {
+    configureSDK(disputeParameters.options.sdkConfig);
+  }
+  const { disputeId, dtrSubgraph, coreSubgraph, options } = disputeParameters;
+
+  const disputeDetails = await fetchDisputeDetails(coreSubgraph, disputeId);
+
+  if (!disputeDetails || !disputeDetails.dispute) return;
+
+  const template = await fetchDisputeTemplateFromId(dtrSubgraph, disputeDetails.dispute.templateId);
+
+  if (!template) return;
+
+  const { templateData, templateDataMappings } = template.disputeTemplate;
+
+  const initialContext = {
+    arbitrableAddress: disputeDetails.dispute.arbitrated.id,
+    arbitrableChainID: disputeDetails.dispute.arbitrableChainId,
+    externalDisputeID: disputeDetails.dispute.externalDisputeId,
+    ...options?.additionalContext,
+  };
+
+  const data = templateDataMappings ? await executeActions(JSON.parse(templateDataMappings), initialContext) : {};
+
+  const populatedTemplate = populateTemplate(templateData, data);
+
+  return populatedTemplate;
+};

yarn.lock

@@ -6437,6 +6437,7 @@ __metadata:
     "@reality.eth/reality-eth-lib": "npm:^3.2.30"
     "@types/mustache": "npm:^4.2.5"
     "@vitest/ui": "npm:^1.1.3"
+    graphql-request: "npm:^7.1.0"
     mocha: "npm:^10.2.0"
     mustache: "npm:^4.2.0"
     ts-node: "npm:^10.9.2"
@@ -7334,6 +7335,34 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@molt/command@npm:^0.9.0":
+  version: 0.9.0
+  resolution: "@molt/command@npm:0.9.0"
+  dependencies:
+    "@molt/types": "npm:0.2.0"
+    alge: "npm:0.8.1"
+    chalk: "npm:^5.3.0"
+    lodash.camelcase: "npm:^4.3.0"
+    lodash.snakecase: "npm:^4.1.1"
+    readline-sync: "npm:^1.4.10"
+    string-length: "npm:^6.0.0"
+    strip-ansi: "npm:^7.1.0"
+    ts-toolbelt: "npm:^9.6.0"
+    type-fest: "npm:^4.3.1"
+    zod: "npm:^3.22.2"
+  checksum: e6ec7c6c2c6a64a1b28e09074196e5aa891bdcbff4129e54c59b902e1b6f4151033fd92c8535666be32267163d04ce3ce454ca0df0a4d5669a8506817131984e
+  languageName: node
+  linkType: hard
+
+"@molt/types@npm:0.2.0":
+  version: 0.2.0
+  resolution: "@molt/types@npm:0.2.0"
+  dependencies:
+    ts-toolbelt: "npm:^9.6.0"
+  checksum: 0c7eab1dda0d689fda7025b4e4b37ffc290a7e2f7bfb0463a8bffc5834c30af66ab92d63bc2f71dc515cdd0121fc3587596690353a7e1c40d530395135540063
+  languageName: node
+  linkType: hard
+
 "@motionone/animation@npm:^10.15.1":
   version: 10.15.1
   resolution: "@motionone/animation@npm:10.15.1"
@@ -13031,6 +13060,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"alge@npm:0.8.1":
+  version: 0.8.1
+  resolution: "alge@npm:0.8.1"
+  dependencies:
+    lodash.ismatch: "npm:^4.4.0"
+    remeda: "npm:^1.0.0"
+    ts-toolbelt: "npm:^9.6.0"
+    zod: "npm:^3.17.3"
+  checksum: 11483523289bc7750b6462698a2b61c816bf3c7eada2ade206bc02b964679b6bf4b298cc561ae267f382573668b68ff311a0aec60c5ae011aecde491932240e8
+  languageName: node
+  linkType: hard
+
 "amdefine@npm:>=0.0.4":
   version: 1.0.1
   resolution: "amdefine@npm:1.0.1"
@@ -15089,7 +15130,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"chalk@npm:5.3.0":
+"chalk@npm:5.3.0, chalk@npm:^5.3.0":
   version: 5.3.0
   resolution: "chalk@npm:5.3.0"
   checksum: 6373caaab21bd64c405bfc4bd9672b145647fc9482657b5ea1d549b3b2765054e9d3d928870cdf764fb4aad67555f5061538ff247b8310f110c5c888d92397ea
@@ -21343,6 +21384,31 @@ __metadata:
   languageName: node
   linkType: hard
 
+"graphql-request@npm:^7.1.0":
+  version: 7.1.0
+  resolution: "graphql-request@npm:7.1.0"
+  dependencies:
+    "@graphql-typed-document-node/core": "npm:^3.2.0"
+    "@molt/command": "npm:^0.9.0"
+    zod: "npm:^3.23.8"
+  peerDependencies:
+    "@dprint/formatter": ^0.3.0
+    "@dprint/typescript": ^0.91.1
+    dprint: ^0.46.2
+    graphql: 14 - 16
+  peerDependenciesMeta:
+    "@dprint/formatter":
+      optional: true
+    "@dprint/typescript":
+      optional: true
+    dprint:
+      optional: true
+  bin:
+    graffle: build/cli/generate.js
+  checksum: 6e61cd8200f9842569a657b0fdc0cb45a8433d8afa730ace911fa9a09318fb3cae3ccd9396a9ab2e1795bf9ccbce976fc90fb0bfac9dfe2fc821e74845be57d9
+  languageName: node
+  linkType: hard
+
 "graphql-tag@npm:^2.11.0":
   version: 2.12.6
   resolution: "graphql-tag@npm:2.12.6"
@@ -31351,6 +31417,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"readline-sync@npm:^1.4.10":
+  version: 1.4.10
+  resolution: "readline-sync@npm:1.4.10"
+  checksum: 5eb6465f5c5391e32cb525022a307a910a565828cd53da87ac05fca291607df54099dd65bc9c7a513ac53a5eb4e11454d48f0dcf4ad54126d36dec5fcec4a8f0
+  languageName: node
+  linkType: hard
+
 "real-require@npm:^0.1.0":
   version: 0.1.0
   resolution: "real-require@npm:0.1.0"
@@ -31598,6 +31671,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"remeda@npm:^1.0.0":
+  version: 1.61.0
+  resolution: "remeda@npm:1.61.0"
+  checksum: 0b0ec8688e340c7525a8788e99701b174ddca2eaf230d47f9e087d9aaccd54c7181a1f58bf4f95cb9c12bc1d26f03b17e3d3d9046a59225074a7ac3fa1356da3
+  languageName: node
+  linkType: hard
+
 "remedial@npm:^1.0.7":
   version: 1.0.8
   resolution: "remedial@npm:1.0.8"
@@ -33913,6 +33993,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"string-length@npm:^6.0.0":
+  version: 6.0.0
+  resolution: "string-length@npm:6.0.0"
+  dependencies:
+    strip-ansi: "npm:^7.1.0"
+  checksum: b171e9e193ec292ad71f8b2a36e20478bf1bac8cd5beec062fb126942d627dfd9311959e271e9ab7b0a383d16b85b9e25a183d15786e30f22104d152e7627f99
+  languageName: node
+  linkType: hard
+
 "string-natural-compare@npm:^3.0.1":
   version: 3.0.1
   resolution: "string-natural-compare@npm:3.0.1"
@@ -34128,7 +34217,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"strip-ansi@npm:^7.0.1":
+"strip-ansi@npm:^7.0.1, strip-ansi@npm:^7.1.0":
   version: 7.1.0
   resolution: "strip-ansi@npm:7.1.0"
   dependencies:
@@ -35300,6 +35389,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"ts-toolbelt@npm:^9.6.0":
+  version: 9.6.0
+  resolution: "ts-toolbelt@npm:9.6.0"
+  checksum: 2c2dea2631dbd7372a79cccc6d09a377a6ca2f319f767fd239d2e312cd1d9165a90f8c1777a047227bfdcda6aeba3addbadce88fdfc7f43caf4534d385a43c82
+  languageName: node
+  linkType: hard
+
 "tsconfck@npm:^3.0.3":
   version: 3.0.3
   resolution: "tsconfck@npm:3.0.3"
@@ -35509,6 +35605,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"type-fest@npm:^4.3.1":
+  version: 4.26.1
+  resolution: "type-fest@npm:4.26.1"
+  checksum: b82676194f80af228cb852e320d2ea8381c89d667d2e4d9f2bdfc8f254bccc039c7741a90c53617a4de0c9fdca8265ed18eb0888cd628f391c5c381c33a9f94b
+  languageName: node
+  linkType: hard
+
 "type-is@npm:~1.6.18":
   version: 1.6.18
   resolution: "type-is@npm:1.6.18"
@@ -38133,6 +38236,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"zod@npm:^3.17.3, zod@npm:^3.23.8":
+  version: 3.23.8
+  resolution: "zod@npm:3.23.8"
+  checksum: 846fd73e1af0def79c19d510ea9e4a795544a67d5b34b7e1c4d0425bf6bfd1c719446d94cdfa1721c1987d891321d61f779e8236fde517dc0e524aa851a6eff1
+  languageName: node
+  linkType: hard
+
 "zod@npm:^3.21.4":
   version: 3.21.4
   resolution: "zod@npm:3.21.4"