Feat/dynamic context validation in sdk

contracts/package.json

@@ -102,6 +102,7 @@
     "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@kleros/vea-contracts": "^0.4.0"
+    "@kleros/vea-contracts": "^0.4.0",
+    "viem": "^2.21.26"
   }
 }

contracts/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@kleros/kleros-v2-tsconfig/base.json",
+  "extends": "@kleros/kleros-v2-tsconfig/base18.json",
   "include": [
     "./src",
     "./scripts",

kleros-sdk/.gitignore

@@ -0,0 +1,24 @@
+node_modules
+
+# vite
+development
+build
+dist
+lib
+
+# misc
+.eslintcache
+.DS_Store
+.env
+.env.test
+.env.testnet
+.env.devnet
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

kleros-sdk/README.md

@@ -1,4 +1,4 @@
-# @kleros/kleros-v2-sdk
+# @kleros/kleros-sdk
 
 _Archon's successor_
 

kleros-sdk/package.json

@@ -1,15 +1,17 @@
 {
   "name": "@kleros/kleros-sdk",
-  "version": "0.1.0",
+  "version": "2.1.7",
   "description": "SDK for Kleros version 2",
-  "main": "index.ts",
   "repository": "git@github.com:kleros/kleros-v2.git",
   "author": "Kleros",
   "license": "MIT",
-  "alias": {
-    "src": "./src",
-    "dataMappings": "./src/dataMappings"
-  },
+  "main": "./lib/src/index.js",
+  "types": "./lib/src/index.d.ts",
+  "module": "./lib/src/index.js",
+  "files": [
+    "lib/**/*",
+    "!lib/**/test/*"
+  ],
   "packageManager": "yarn@4.0.2+sha256.825003a0f561ad09a3b1ac4a3b3ea6207af2796d54f62a9420520915721f5186",
   "engines": {
     "node": ">=16.0.0"
@@ -18,24 +20,34 @@
   "volta": {
     "node": "20.11.0"
   },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
   "scripts": {
-    "build": "your-build-script",
+    "clean": "rimraf lib",
+    "build": "yarn clean && tsc",
     "test": "vitest",
     "test:ui": "vitest --ui",
-    "test:run": "vitest run"
+    "test:run": "vitest run",
+    "release:patch": "scripts/publish.sh patch",
+    "release:minor": "scripts/publish.sh minor",
+    "release:major": "scripts/publish.sh major"
   },
   "devDependencies": {
     "@types/mustache": "^4.2.5",
     "@vitest/ui": "^1.1.3",
     "mocha": "^10.2.0",
+    "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3",
     "vitest": "^1.1.3"
   },
   "dependencies": {
-    "@kleros/kleros-v2-contracts": "workspace:^",
     "@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/scripts/publish.sh

@@ -0,0 +1,42 @@
+#!/bin/bash
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+#--------------------------------------
+# Error handling
+#--------------------------------------
+
+set -Ee
+function _catch {
+    # Don't propagate to outer shell
+    exit 0 
+}
+function _finally {
+    # TODO: rollback version bump
+    rm -rf $SCRIPT_DIR/../dist
+}
+trap _catch ERR
+trap _finally EXIT
+
+#--------------------------------------
+
+# Check if any tracked files are currently changed, ignoring untracked files
+if [ -n "$(git status --porcelain -uno)" ]; then
+    echo "Error: There are uncommitted changes in tracked files. Please commit or stash them before publishing."
+    exit 1
+fi
+
+yarn version $1
+
+version=$(cat package.json | jq -r .version)
+echo "Publishing version $version"
+
+git add package.json
+git commit -m "chore(sdk): release @kleros/kleros-sdk@$version"
+git tag "@kleros/kleros-sdk@$version" -m "@kleros/kleros-sdk@$version"
+git push
+git push --tags
+
+yarn clean
+yarn build
+yarn npm publish

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

@@ -1,19 +1,23 @@
 import { parseAbiItem } from "viem";
-import { AbiCallMapping } from "src/dataMappings/utils/actionTypes";
-import { createResultObject } from "src/dataMappings/utils/createResultObject";
-import { configureSDK, getPublicClient } from "src/sdk";
+import { AbiCallMapping } from "../utils/actionTypes";
+import { createResultObject } from "../utils/createResultObject";
+import { getPublicClient } from "../../sdk";
+import { SdkNotConfiguredError } from "../../errors";
 
-export const callAction = async (mapping: AbiCallMapping, alchemyApiKey: string) => {
-  configureSDK({ apiKey: alchemyApiKey });
+export const callAction = async (mapping: AbiCallMapping) => {
   const publicClient = getPublicClient();
 
-  const { abi: source, address, args, seek, populate } = mapping;
+  if (!publicClient) {
+    throw new SdkNotConfiguredError();
+  }
+
+  const { abi: source, address, functionName, args, seek, populate } = mapping;
   const parsedAbi = typeof source === "string" ? parseAbiItem(source) : source;
 
   const data = await publicClient.readContract({
     address,
     abi: [parsedAbi],
-    functionName: "TODO: FIX ME",
+    functionName,
     args,
   });
 

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

@@ -1,22 +1,25 @@
-import { parseAbiItem } from "viem";
-import { type AbiEvent } from "abitype";
-import { AbiEventMapping } from "src/dataMappings/utils/actionTypes";
-import { createResultObject } from "src/dataMappings/utils/createResultObject";
-import { configureSDK, getPublicClient } from "src/sdk";
+import { parseAbiItem, type AbiEvent } from "viem";
+import { AbiEventMapping } from "../utils/actionTypes";
+import { createResultObject } from "../utils/createResultObject";
+import { getPublicClient } from "../../sdk";
+import { SdkNotConfiguredError } from "../../errors";
 
-export const eventAction = async (mapping: AbiEventMapping, alchemyApiKey: string) => {
-  configureSDK({ apiKey: alchemyApiKey });
+export const eventAction = async (mapping: AbiEventMapping) => {
   const publicClient = getPublicClient();
 
+  if (!publicClient) {
+    throw new SdkNotConfiguredError();
+  }
+
   const { abi: source, address, eventFilter, seek, populate } = mapping;
   const parsedAbi = parseAbiItem(source) as AbiEvent;
 
   const filter = await publicClient.createEventFilter({
     address,
     event: parsedAbi,
     args: eventFilter.args,
-    fromBlock: eventFilter.fromBlock ? BigInt(eventFilter.fromBlock.toString()) : undefined,
-    toBlock: eventFilter.toBlock ? BigInt(eventFilter.toBlock.toString()) : undefined,
+    fromBlock: eventFilter.fromBlock,
+    toBlock: eventFilter.toBlock,
   });
 
   const contractEvent = await publicClient.getFilterLogs({ filter });

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

@@ -1,6 +1,7 @@
-import { FetchIpfsJsonMapping } from "src/dataMappings/utils/actionTypes";
-import { createResultObject } from "src/dataMappings/utils/createResultObject";
-import { MAX_BYTE_SIZE } from "src/consts";
+import { MAX_BYTE_SIZE } from "../../consts";
+import { RequestError } from "../../errors";
+import { FetchIpfsJsonMapping } from "../utils/actionTypes";
+import { createResultObject } from "../utils/createResultObject";
 
 export const fetchIpfsJsonAction = async (mapping: FetchIpfsJsonMapping) => {
   const { ipfsUri, seek, populate } = mapping;
@@ -13,26 +14,26 @@ export const fetchIpfsJsonAction = async (mapping: FetchIpfsJsonMapping) => {
   } else if (!ipfsUri.startsWith("http")) {
     httpUri = `https://ipfs.io/ipfs/${ipfsUri}`;
   } else {
-    throw new Error("Invalid IPFS URI format");
+    throw new RequestError("Invalid IPFS URI format", httpUri);
   }
 
   const response = await fetch(httpUri, { method: "GET" });
 
   if (!response.ok) {
-    throw new Error("Failed to fetch data from IPFS");
+    throw new RequestError("Failed to fetch data from IPFS", httpUri);
   }
 
   const contentLength = response.headers.get("content-length");
   if (contentLength && parseInt(contentLength) > MAX_BYTE_SIZE) {
-    throw new Error("Response size is too large");
+    throw new RequestError("Response size is too large", httpUri);
   }
 
   const contentType = response.headers.get("content-type");
   if (!contentType || !contentType.includes("application/json")) {
-    throw new Error("Fetched data is not JSON");
+    throw new RequestError("Fetched data is not JSON", httpUri);
   }
 
-  const data = await response.json();
+  const data = (await response.json()) as any;
 
   return createResultObject(data, seek, populate);
 };

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

@@ -1,5 +1,5 @@
 import { JsonMapping } from "../utils/actionTypes";
-import { createResultObject } from "src/dataMappings/utils/createResultObject";
+import { createResultObject } from "../utils/createResultObject";
 
 export const jsonAction = (mapping: JsonMapping) => {
   const { value, seek, populate } = mapping;

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

@@ -1,5 +1,5 @@
 import { SubgraphMapping } from "../utils/actionTypes";
-import { createResultObject } from "src/dataMappings/utils/createResultObject";
+import { createResultObject } from "../utils/createResultObject";
 
 export const subgraphAction = async (mapping: SubgraphMapping) => {
   const { endpoint, query, variables, seek, populate } = mapping;
@@ -13,7 +13,7 @@ export const subgraphAction = async (mapping: SubgraphMapping) => {
     body: JSON.stringify({ query, variables }),
   });
 
-  const { data } = await response.json();
+  const { data } = (await response.json()) as any;
 
   return createResultObject(data, seek, populate);
 };