Merge pull request #1663 from kleros/fix(sdk)/data-mappings-tests

fix(sdk): mocked data mappings tests, refactor alchemy api key parameter passing

Author: jaybuidl

kleros-sdk/.env.example

@@ -2,11 +2,10 @@
 
 _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:
+To run the data mappings tests, 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

@@ -5,14 +5,14 @@ export type JsonMapping = {
   populate: string[];
 };
 
-export type SubgraphMapping = {
+export interface SubgraphMapping {
   type: string;
   endpoint: string;
   query: string;
-  variables?: string[];
+  variables: { [key: string]: unknown };
   seek: string[];
   populate: string[];
-};
+}
 
 export type AbiCallMapping = {
   type: string;

kleros-sdk/src/dataMappings/utils/actionTypes.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);