chore(kleros-sdk): use-urql-for-gql-queries

Author: Harman-singh-waraich

kleros-sdk/package.json

@@ -43,6 +43,7 @@
   },
   "dependencies": {
     "@reality.eth/reality-eth-lib": "^3.2.30",
+    "@urql/core": "^5.0.8",
     "mustache": "^4.2.0",
     "viem": "^2.21.26",
     "zod": "^3.22.4"

kleros-sdk/src/requests/fetchDisputeDetails.ts

@@ -1,4 +1,5 @@
 import { RequestError } from "../errors";
+import { cacheExchange, Client, CombinedError, fetchExchange, gql } from "@urql/core";
 
 type DisputeDetailsQueryResponse = {
   dispute: {
@@ -11,42 +12,41 @@ type DisputeDetailsQueryResponse = {
   };
 };
 
-const fetchDisputeDetails = async (endpoint: string, id: bigint): Promise<DisputeDetailsQueryResponse> => {
-  const query = `
-    query DisputeDetails($id: ID!) {
-      dispute(id: $id) {
-        arbitrated {
-          id
-        }
-        arbitrableChainId
-        externalDisputeId
-        templateId
+const query = gql`
+  query DisputeDetails($id: ID!) {
+    dispute(id: $id) {
+      arbitrated {
+        id
       }
+      arbitrableChainId
+      externalDisputeId
+      templateId
     }
-  `;
+  }
+`;
+
+const fetchDisputeDetails = async (endpoint: string, id: bigint) => {
   const variables = { id: id.toString() };
 
   try {
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-      },
-      body: JSON.stringify({ query, variables }),
+    const client = new Client({
+      url: endpoint,
+      exchanges: [cacheExchange, fetchExchange],
     });
 
-    if (!response.ok) {
-      const errorData = (await response.json()) as any;
-      throw new RequestError(
-        `Error querying Dispute Details: ${errorData?.errors?.[0]?.message || "Unknown error"}`,
-        endpoint
-      );
-    }
-
-    const json = (await response.json()) as { data: DisputeDetailsQueryResponse };
-    return json.data;
-  } catch (error: any) {
-    if (error instanceof Error) {
+    return client
+      .query<DisputeDetailsQueryResponse>(query, variables)
+      .toPromise()
+      .then((res) => {
+        if (res?.error) {
+          throw res.error;
+        }
+        return res?.data;
+      });
+  } catch (error: unknown) {
+    if (error instanceof CombinedError) {
+      throw error;
+    } else if (error instanceof Error) {
       throw new RequestError(`Error querying Dispute Details: ${error.message}`, endpoint);
     }
     throw new RequestError("An unknown error occurred while querying Dispute Details", endpoint);

kleros-sdk/src/requests/fetchDisputeTemplateFromId.ts

@@ -1,3 +1,4 @@
+import { cacheExchange, Client, CombinedError, fetchExchange, gql } from "@urql/core";
 import { RequestError } from "../errors";
 
 type DisputeTemplateQueryResponse = {
@@ -6,40 +7,37 @@ type DisputeTemplateQueryResponse = {
     templateDataMappings: string;
   };
 };
-
-const fetchDisputeTemplateFromId = async (endpoint: string, id: number): Promise<DisputeTemplateQueryResponse> => {
-  const query = `
-    query DisputeTemplate($id: ID!) {
-      disputeTemplate(id: $id) {
-        templateData
-        templateDataMappings
-      }
+const query = gql`
+  query DisputeTemplate($id: ID!) {
+    disputeTemplate(id: $id) {
+      templateData
+      templateDataMappings
     }
-  `;
+  }
+`;
 
+const fetchDisputeTemplateFromId = async (endpoint: string, id: number) => {
   const variables = { id: id.toString() };
 
   try {
-    const response = await fetch(endpoint, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-      },
-      body: JSON.stringify({ query, variables }),
+    const client = new Client({
+      url: endpoint,
+      exchanges: [cacheExchange, fetchExchange],
     });
 
-    if (!response.ok) {
-      const errorData = (await response.json()) as any;
-      throw new RequestError(
-        `Error querying Dispute Template: ${errorData?.errors?.[0]?.message || "Unknown error"}`,
-        endpoint
-      );
-    }
-
-    const json = (await response.json()) as { data: DisputeTemplateQueryResponse };
-    return json.data;
-  } catch (error: any) {
-    if (error instanceof Error) {
+    return client
+      .query<DisputeTemplateQueryResponse>(query, variables)
+      .toPromise()
+      .then((res) => {
+        if (res?.error) {
+          throw res.error;
+        }
+        return res?.data;
+      });
+  } catch (error: unknown) {
+    if (error instanceof CombinedError) {
+      throw error;
+    } else if (error instanceof Error) {
       throw new RequestError(`Error querying Dispute Template: ${error.message}`, endpoint);
     }
     throw new RequestError("An unknown error occurred while querying Dispute Template", endpoint);

yarn.lock

@@ -5,6 +5,18 @@ __metadata:
   version: 8
   cacheKey: 10
 
+"@0no-co/graphql.web@npm:^1.0.5":
+  version: 1.0.9
+  resolution: "@0no-co/graphql.web@npm:1.0.9"
+  peerDependencies:
+    graphql: ^14.0.0 || ^15.0.0 || ^16.0.0
+  peerDependenciesMeta:
+    graphql:
+      optional: true
+  checksum: 3caf39263323ba2a51255035e92582573822d213117879e6d1b732e222a8d14fdc703828d46b4a46f86d2027ee08568196f1d64376ee74250fb58dc465698930
+  languageName: node
+  linkType: hard
+
 "@aashutoshrathi/word-wrap@npm:^1.2.3":
   version: 1.2.6
   resolution: "@aashutoshrathi/word-wrap@npm:1.2.6"
@@ -7901,6 +7913,7 @@ __metadata:
   dependencies:
     "@reality.eth/reality-eth-lib": "npm:^3.2.30"
     "@types/mustache": "npm:^4.2.5"
+    "@urql/core": "npm:^5.0.8"
     "@vitest/ui": "npm:^1.1.3"
     mocha: "npm:^10.2.0"
     mustache: "npm:^4.2.0"
@@ -13354,6 +13367,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@urql/core@npm:^5.0.8":
+  version: 5.0.8
+  resolution: "@urql/core@npm:5.0.8"
+  dependencies:
+    "@0no-co/graphql.web": "npm:^1.0.5"
+    wonka: "npm:^6.3.2"
+  checksum: c973e6e89785ae45ef447726557143ce7bc9d9f5b887297f0b315b2ff546d20bdfb814a4c899644bd5c5814761fc8d75a8ac66f67f3d57a3c2eadd3ec88adb60
+  languageName: node
+  linkType: hard
+
 "@vitest/expect@npm:1.2.1":
   version: 1.2.1
   resolution: "@vitest/expect@npm:1.2.1"
@@ -41239,6 +41262,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"wonka@npm:^6.3.2":
+  version: 6.3.4
+  resolution: "wonka@npm:6.3.4"
+  checksum: 0f102630182828268b57b54102003449b97abbc2483392239baf856a2fca7b72ae9be67c208415124a3d26a320674ed64387e9bf07a8d0badedb5f607d2ccfdc
+  languageName: node
+  linkType: hard
+
 "word-wrap@npm:^1.2.3, word-wrap@npm:~1.2.3":
   version: 1.2.3
   resolution: "word-wrap@npm:1.2.3"