fix: data mappings test, refactor alchemy api key parameter passing, remove dotenv from sdk

Author: kemuru

kleros-sdk/.env.example

@@ -2,11 +2,13 @@
 
 _Archon's successor_
 
-Make sure to set the environment variables first by copying the file `.env.example`, pasting it, renaming it to `.env`, and then setting the variables.
 To run the data mappings tests:
 
+1. Go into the `dataMappings.test.ts` file and pass the "alchemyApiKey" variable as second parameter when calling both the callAction() and eventAction() functions, at lines 89 and 119 of the file, respectively.
+2. At the root folder level, do:
+
 ```bash
-yarn run test-data-mappings
+yarn test
 ```
 
 🚧 ⚖️ 🚧

kleros-sdk/README.md

@@ -27,7 +27,6 @@
   "devDependencies": {
     "@types/mustache": "^4.2.5",
     "@vitest/ui": "^1.1.3",
-    "dotenv": "^16.3.1",
     "mocha": "^10.2.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",

kleros-sdk/package.json

@@ -3,8 +3,8 @@ import { AbiCallMapping } from "src/dataMappings/utils/actionTypes";
 import { createResultObject } from "src/dataMappings/utils/createResultObject";
 import { configureSDK, getPublicClient } from "src/sdk";
 
-export const callAction = async (mapping: AbiCallMapping) => {
-  configureSDK({ apiKey: process.env.ALCHEMY_API_KEY });
+export const callAction = async (mapping: AbiCallMapping, alchemyApiKey: string) => {
+  configureSDK({ apiKey: alchemyApiKey });
   const publicClient = getPublicClient();
 
   const { abi: source, address, args, seek, populate } = mapping;

kleros-sdk/src/dataMappings/actions/callAction.ts

@@ -3,8 +3,8 @@ import { AbiEventMapping } from "src/dataMappings/utils/actionTypes";
 import { createResultObject } from "src/dataMappings/utils/createResultObject";
 import { configureSDK, getPublicClient } from "src/sdk";
 
-export const eventAction = async (mapping: AbiEventMapping) => {
-  configureSDK({ apiKey: process.env.ALCHEMY_API_KEY });
+export const eventAction = async (mapping: AbiEventMapping, alchemyApiKey: string) => {
+  configureSDK({ apiKey: alchemyApiKey });
   const publicClient = getPublicClient();
 
   const { abi: source, address, eventFilter, seek, populate } = mapping;

kleros-sdk/src/dataMappings/actions/eventAction.ts

@@ -15,7 +15,7 @@ import {
 import { ActionMapping } from "./utils/actionTypes";
 import { replacePlaceholdersWithValues } from "./utils/replacePlaceholdersWithValues";
 
-export const executeAction = async (mapping: ActionMapping, context = {}) => {
+export const executeAction = async (mapping: ActionMapping, context: Record<string, unknown> = {}) => {
   mapping = replacePlaceholdersWithValues(mapping, context);
 
   switch (mapping.type) {
@@ -24,9 +24,9 @@ export const executeAction = async (mapping: ActionMapping, context = {}) => {
     case "json":
       return jsonAction(validateJsonMapping(mapping));
     case "abi/call":
-      return await callAction(validateAbiCallMapping(mapping));
+      return await callAction(validateAbiCallMapping(mapping), context.alchemyApiKey);
     case "abi/event":
-      return await eventAction(validateAbiEventMapping(mapping));
+      return await eventAction(validateAbiEventMapping(mapping), context.alchemyApiKey);
     case "fetch/ipfs/json":
       return await fetchIpfsJsonAction(validateFetchIpfsJsonMapping(mapping));
     case "reality":

kleros-sdk/src/dataMappings/executeActions.ts

@@ -1,6 +1,6 @@
 import mustache from "mustache";
 
-export const replacePlaceholdersWithValues = (mapping: any, context: any) => {
+export const replacePlaceholdersWithValues = (mapping: any, context: Record<string, unknown>) => {
   const replace = (obj) => {
     if (typeof obj === "string") {
       return mustache.render(obj, context);

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

@@ -33,7 +33,7 @@ describe("jsonAction", () => {
 
 describe("subgraphAction with variables", () => {
   it("should fetch GraphQL data with variables and return in expected format", async () => {
-    const endpoint = "https://api.thegraph.com/subgraphs/name/kemuru/escrow-v2-devnet";
+    const endpoint = "https://api.studio.thegraph.com/query/61738/escrow-v2-devnet/version/latest";
     const query = `
       query GetEscrows($buyer: Bytes!) {
         escrows(where: {buyer: $buyer}) {
@@ -72,23 +72,28 @@ describe("subgraphAction with variables", () => {
 
 describe("callAction", () => {
   it("should call the contract and return token balance", async () => {
-    const abi = "function balanceOf(address account) public view returns (uint256)";
-    const contractAddress = "0xa8e4235129258404A2ed3D36DAd20708CcB2d0b7";
-    const knownAddress = "0x0000000000000000000000000000000000000000";
+    const abi =
+      "function currentRuling(uint256 _disputeID) public view returns (uint256 ruling, bool tied, bool overridden)";
+    const contractAddress = "0xA54e7A16d7460e38a8F324eF46782FB520d58CE8";
+    const disputeId = "0";
 
     const mapping = {
       type: "abi/call",
       abi,
       address: contractAddress,
-      args: [knownAddress],
-      seek: [""],
-      populate: ["tokenBalance"],
+      args: [disputeId],
+      seek: ["0", "1", "2"],
+      populate: ["ruling", "tied", "overriden"],
     };
 
-    const result = await callAction(mapping);
+    const result = await callAction(mapping, "insertAlchemyApiKeyHere");
 
-    expect(result).to.have.property("tokenBalance");
-    expect(result.tokenBalance).to.be.a("bigint");
+    expect(result).to.have.property("ruling");
+    expect(result.ruling).to.be.a("bigint");
+    expect(result).to.have.property("tied");
+    expect(result.tied).to.be.a("boolean");
+    expect(result).to.have.property("overriden");
+    expect(result.overriden).to.be.a("boolean");
   });
 });
 
@@ -111,7 +116,7 @@ describe("eventAction", () => {
       populate: ["fromAddress", "toAddress", "transferValue"],
     };
 
-    const result = await eventAction(mapping);
+    const result = await eventAction(mapping, "insertAlchemyApiKeyHere");
 
     expect(result).to.have.property("fromAddress");
     expect(result).to.have.property("toAddress");

kleros-sdk/test/dataMappings.test.ts

@@ -66,6 +66,7 @@ export const usePopulatedDisputeData = (disputeID?: string, arbitrableAddress?:
             disputeID: disputeID,
             arbitrable: arbitrableAddress,
             graphApiKey: import.meta.env.REACT_APP_GRAPH_API_KEY,
+            alchemyApiKey: import.meta.env.ALCHEMY_API_KEY,
             externalDisputeID: externalDisputeID,
           };
 

web/src/hooks/queries/usePopulatedDisputeData.ts

@@ -172,6 +172,7 @@ const DisputeTemplateView = () => {
             externalDisputeID: debouncedParams._externalDisputeID,
             templateID: debouncedParams._templateId,
             templateUri: debouncedParams._templateUri,
+            alchemyApiKey: import.meta.env.ALCHEMY_API_KEY,
           };
 
           const fetchData = async () => {