@human-protocol/sdk 6.1.0 → 7.1.0

package/dist/utils.d.ts

@@ -27,6 +27,13 @@ export declare const isValidUrl: (url: string) => boolean;
  * @returns True if the string is valid JSON, false otherwise
  */
 export declare const isValidJson: (input: string) => boolean;
+/**
+ * Extracts a readable message from unknown error values.
+ *
+ * @param error - Unknown error value
+ * @returns Human-readable error message
+ */
+export declare const getErrorMessage: (error: unknown) => string;
 /**
  * Gets the subgraph URL for the given network, using API key if available.
  *
@@ -34,6 +41,14 @@ export declare const isValidJson: (input: string) => boolean;
  * @returns The subgraph URL with API key if available
  */
 export declare const getSubgraphUrl: (networkData: NetworkData) => string;
+/**
+ * Gets the HMT statistics subgraph URL for the given network.
+ * Falls back to the default subgraph URL when a dedicated HMT endpoint is not configured.
+ *
+ * @param networkData - The network data containing subgraph URLs
+ * @returns The HMT statistics subgraph URL with API key if available
+ */
+export declare const getHMTSubgraphUrl: (networkData: NetworkData) => string;
 /**
  * Converts a Date object to Unix timestamp (seconds since epoch).
  *

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,GAAG,UAgBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,OAMxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,OAO3C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,aAAa,WAAW,WAUtD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,IAAI,KAAG,MAE7C,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,OAAO,GAAG,KAAG,OAS3C,CAAC;AAaF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GAAU,CAAC,GAAG,GAAG,EAC1C,KAAK,MAAM,EACX,OAAO,GAAG,EACV,YAAY,GAAG,EACf,UAAU,eAAe,KACxB,OAAO,CAAC,CAAC,CA4CX,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,GAAG,UAgBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,OAMxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,OAO3C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,OAAO,KAAG,MAUhD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,aAAa,WAAW,WAUtD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,aAAa,WAAW,WAWzD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,IAAI,KAAG,MAE7C,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,OAAO,GAAG,KAAG,OAS3C,CAAC;AA6CF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GAAU,CAAC,GAAG,GAAG,EAC1C,KAAK,MAAM,EACX,OAAO,GAAG,EACV,YAAY,GAAG,EACf,UAAU,eAAe,KACxB,OAAO,CAAC,CAAC,CAiDX,CAAC"}

package/dist/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.customGqlFetch = exports.isIndexerError = exports.getUnixTimestamp = exports.getSubgraphUrl = exports.isValidJson = exports.isValidUrl = exports.throwError = void 0;
+exports.customGqlFetch = exports.isIndexerError = exports.getUnixTimestamp = exports.getHMTSubgraphUrl = exports.getSubgraphUrl = exports.getErrorMessage = exports.isValidJson = exports.isValidUrl = exports.throwError = void 0;
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const ethers_1 = require("ethers");
 const graphql_request_1 = __importDefault(require("graphql-request"));
@@ -76,6 +76,24 @@ const isValidJson = (input) => {
     }
 };
 exports.isValidJson = isValidJson;
+/**
+ * Extracts a readable message from unknown error values.
+ *
+ * @param error - Unknown error value
+ * @returns Human-readable error message
+ */
+const getErrorMessage = (error) => {
+    if (error instanceof Error) {
+        return error.message;
+    }
+    try {
+        return JSON.stringify(error);
+    }
+    catch {
+        return String(error);
+    }
+};
+exports.getErrorMessage = getErrorMessage;
 /**
  * Gets the subgraph URL for the given network, using API key if available.
  *
@@ -94,6 +112,26 @@ const getSubgraphUrl = (networkData) => {
     return subgraphUrl;
 };
 exports.getSubgraphUrl = getSubgraphUrl;
+/**
+ * Gets the HMT statistics subgraph URL for the given network.
+ * Falls back to the default subgraph URL when a dedicated HMT endpoint is not configured.
+ *
+ * @param networkData - The network data containing subgraph URLs
+ * @returns The HMT statistics subgraph URL with API key if available
+ */
+const getHMTSubgraphUrl = (networkData) => {
+    let subgraphUrl = networkData.hmtSubgraphUrl || networkData.subgraphUrl;
+    if (process.env.SUBGRAPH_API_KEY) {
+        subgraphUrl =
+            networkData.hmtSubgraphUrlApiKey || networkData.subgraphUrlApiKey;
+    }
+    else if (networkData.chainId !== enums_1.ChainId.LOCALHOST) {
+        // eslint-disable-next-line no-console
+        console.warn(error_1.WarnSubgraphApiKeyNotProvided);
+    }
+    return subgraphUrl;
+};
+exports.getHMTSubgraphUrl = getHMTSubgraphUrl;
 /**
  * Converts a Date object to Unix timestamp (seconds since epoch).
  *
@@ -114,6 +152,29 @@ const isIndexerError = (error) => {
     return errorMessage.toLowerCase().includes('bad indexers');
 };
 exports.isIndexerError = isIndexerError;
+const getSubgraphErrorMessage = (error) => {
+    return (error?.response?.errors?.[0]?.message ||
+        error?.message ||
+        error?.toString?.() ||
+        'Subgraph request failed');
+};
+const getSubgraphStatusCode = (error) => {
+    if (typeof error?.response?.status === 'number') {
+        return error.response.status;
+    }
+    if (typeof error?.status === 'number') {
+        return error.status;
+    }
+    return undefined;
+};
+const toSubgraphError = (error, url) => {
+    const message = getSubgraphErrorMessage(error);
+    const statusCode = getSubgraphStatusCode(error);
+    if ((0, exports.isIndexerError)(error)) {
+        return new error_1.SubgraphBadIndexerError(message, url, statusCode);
+    }
+    return new error_1.SubgraphRequestError(message, url, statusCode);
+};
 const sleep = (ms) => {
     return new Promise((resolve) => setTimeout(resolve, ms));
 };
@@ -143,7 +204,12 @@ const customGqlFetch = async (url, query, variables, options) => {
         }
         : undefined;
     if (!options) {
-        return await (0, graphql_request_1.default)(url, query, variables, headers);
+        try {
+            return await (0, graphql_request_1.default)(url, query, variables, headers);
+        }
+        catch (error) {
+            throw toSubgraphError(error, url);
+        }
     }
     const hasMaxRetries = options.maxRetries !== undefined;
     const hasBaseDelay = options.baseDelay !== undefined;
@@ -162,9 +228,10 @@ const customGqlFetch = async (url, query, variables, options) => {
             return await (0, graphql_request_1.default)(targetUrl, query, variables, headers);
         }
         catch (error) {
-            lastError = error;
+            const wrappedError = toSubgraphError(error, targetUrl);
+            lastError = wrappedError;
             if (attempt === maxRetries || !(0, exports.isIndexerError)(error)) {
-                throw error;
+                throw wrappedError;
             }
             const delay = baseDelay * attempt;
             await sleep(delay);

package/dist/worker/index.d.ts

@@ -0,0 +1,2 @@
+export { WorkerUtils } from './worker_utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/worker/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/worker/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/worker/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkerUtils = void 0;
+var worker_utils_1 = require("./worker_utils");
+Object.defineProperty(exports, "WorkerUtils", { enumerable: true, get: function () { return worker_utils_1.WorkerUtils; } });

package/dist/{worker.d.ts → worker/worker_utils.d.ts}

@@ -1,5 +1,5 @@
-import { ChainId } from './enums';
-import { IWorker, IWorkersFilter, SubgraphOptions } from './interfaces';
+import { ChainId } from '../enums';
+import { IWorker, IWorkersFilter, SubgraphOptions } from '../interfaces';
 /**
  * Utility class for worker-related operations.
  *
@@ -57,7 +57,6 @@ export declare class WorkerUtils {
      * type IWorker = {
      *   id: string;
      *   address: string;
-     *   totalHMTAmountReceived: bigint;
      *   payoutCount: number;
      * };
      * ```
@@ -83,4 +82,4 @@ export declare class WorkerUtils {
      */
     static getWorkers(filter: IWorkersFilter, options?: SubgraphOptions): Promise<IWorker[]>;
 }
-//# sourceMappingURL=worker.d.ts.map
+//# sourceMappingURL=worker_utils.d.ts.map

package/dist/worker/worker_utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker_utils.d.ts","sourceRoot":"","sources":["../../src/worker/worker_utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAkB,MAAM,UAAU,CAAC;AAInD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAGzE;;;;;;;;;;;;;GAaG;AACH,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;;;;;;;OAoBG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IA0B1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,OAAO,EAAE,CAAC;CAoCtB"}

package/dist/{worker.js → worker/worker_utils.js}

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkerUtils = void 0;
 const ethers_1 = require("ethers");
-const constants_1 = require("./constants");
-const enums_1 = require("./enums");
-const error_1 = require("./error");
-const worker_1 = require("./graphql/queries/worker");
-const utils_1 = require("./utils");
+const constants_1 = require("../constants");
+const enums_1 = require("../enums");
+const error_1 = require("../error");
+const worker_1 = require("../graphql/queries/worker");
+const utils_1 = require("../utils");
 /**
  * Utility class for worker-related operations.
  *
@@ -78,7 +78,6 @@ class WorkerUtils {
      * type IWorker = {
      *   id: string;
      *   address: string;
-     *   totalHMTAmountReceived: bigint;
      *   payoutCount: number;
      * };
      * ```
@@ -132,7 +131,6 @@ function mapWorker(w) {
     return {
         id: w.id,
         address: w.address,
-        totalHMTAmountReceived: BigInt(w.totalHMTAmountReceived || 0),
         payoutCount: Number(w.payoutCount || 0),
     };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "6.1.0",
+  "version": "7.1.0",
   "files": [
     "src",
     "dist"
@@ -38,27 +38,31 @@
     ]
   },
   "dependencies": {
-    "@human-protocol/core": "5.0.1",
+    "@human-protocol/core": "6.0.0",
     "axios": "^1.4.0",
-    "ethers": "~6.15.0",
+    "ethers": "~6.16.0",
     "graphql": "^16.8.1",
     "graphql-request": "^7.3.4",
     "graphql-tag": "^2.12.6",
     "openpgp": "^6.2.2",
     "secp256k1": "^5.0.1",
     "validator": "^13.12.0",
-    "vitest": "^3.0.9"
+    "vitest": "^4.0.18"
   },
   "devDependencies": {
+    "@eslint/js": "^10.0.1",
     "@types/validator": "^13.15.4",
-    "eslint": "^9.39.1",
-    "eslint-plugin-jest": "^28.9.0",
+    "eslint": "^10.0.3",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jest": "^29.15.0",
     "eslint-plugin-prettier": "^5.5.5",
     "glob": "^13.0.0",
-    "prettier": "^3.7.4",
+    "globals": "^16.3.0",
+    "prettier": "^3.8.1",
     "ts-node": "^10.9.2",
     "typedoc": "^0.28.15",
     "typedoc-plugin-markdown": "^4.9.0",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.57.0"
   }
 }

package/src/constants.ts

@@ -34,11 +34,15 @@ export const NETWORKS: {
     stakingAddress: '0xEf6Da3aB52c33925Be3F84038193a7e1331F51E6',
     kvstoreAddress: '0xB6d36B1CDaD50302BCB3DB43bAb0D349458e1b8D',
     subgraphUrl:
-      'https://api.studio.thegraph.com/query/74256/ethereum/version/latest',
+      'https://api.studio.thegraph.com/query/74256/human-ethereum/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmNhLQEfBJQ46fngBh4YCttk8kNkveFy5uvAeUmyAdX1kD',
+      'https://gateway.thegraph.com/api/deployments/id/QmQZ3yL1FzydDwaB56ozgTiBESciTNFsMLyTBfHXzNd1gg',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
+    hmtSubgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/hmt-stats-ethereum/version/latest',
+    hmtSubgraphUrlApiKey:
+      'https://gateway.thegraph.com/api/deployments/id/QmdcTW7XhgULq5yJZGA65mjTwQogdyzLJaZ69ttDJz5JeE',
   },
   [ChainId.SEPOLIA]: {
     chainId: ChainId.SEPOLIA,
@@ -49,11 +53,15 @@ export const NETWORKS: {
     stakingAddress: '0x2163e3A40032Af1C359ac731deaB48258b317890',
     kvstoreAddress: '0xCc0AF0635aa19fE799B6aFDBe28fcFAeA7f00a60',
     subgraphUrl:
-      'https://api.studio.thegraph.com/query/74256/sepolia/version/latest',
+      'https://api.studio.thegraph.com/query/74256/human-sepolia/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmQghdr7hxqrjFde8DN15TzfrJLCfwvzmUH9RzWwH1mKzk',
+      'https://gateway.thegraph.com/api/deployments/id/QmQEbyGSf8VG9pdskowsK6C977wkcyJSxw9q6EDctKEkUw',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
+    hmtSubgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/hmt-stats-sepolia/version/latest',
+    hmtSubgraphUrlApiKey:
+      'https://gateway.thegraph.com/api/deployments/id/QmYkPnYxbZ5ZTtKz7PTyxh6x5sK2H6yzx6vXDCrErpa9gB',
   },
   [ChainId.BSC_MAINNET]: {
     chainId: ChainId.BSC_MAINNET,
@@ -64,11 +72,15 @@ export const NETWORKS: {
     stakingAddress: '0xE24e5C08E28331D24758b69A5E9f383D2bDD1c98',
     kvstoreAddress: '0x21A0C4CED7aE447fCf87D9FE3A29FA9B3AB20Ff1',
     subgraphUrl:
-      'https://api.studio.thegraph.com/query/74256/bsc/version/latest',
+      'https://api.studio.thegraph.com/query/74256/human-bsc/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmTioC9Z1HzKSCnEKL3BP9iHqbgZt1ceLU2VE4Mv6sxNkd',
+      'https://gateway.thegraph.com/api/deployments/id/QmV3nZUM51NGt7F8RpZP9GxKPpKox3F24iJ8H1ekPb6ha4',
     oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
     oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
+    hmtSubgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/hmt-stats-bsc/version/latest',
+    hmtSubgraphUrlApiKey:
+      'https://gateway.thegraph.com/api/deployments/id/QmUnHgNShyv45S2dQ21W9jLvRA8xWT6XfeuP25fXJoNoEa',
   },
   [ChainId.BSC_TESTNET]: {
     chainId: ChainId.BSC_TESTNET,
@@ -79,12 +91,16 @@ export const NETWORKS: {
     stakingAddress: '0xD6D347ba6987519B4e42EcED43dF98eFf5465a23',
     kvstoreAddress: '0x32e27177BA6Ea91cf28dfd91a0Da9822A4b74EcF',
     subgraphUrl:
-      'https://api.studio.thegraph.com/query/74256/bsc-testnet/version/latest',
+      'https://api.studio.thegraph.com/query/74256/human-bsc-testnet/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmPyUYRjAvzDdeenXMGHcCRD2v4qwZbKMEkVkY3Jq6VLwn',
+      'https://gateway.thegraph.com/api/deployments/id/QmdQJog9vMghK2o39U9YJL8vpU9VZnkJa7jGg7wnsod7qV',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest',
     oldFactoryAddress: '0xaae6a2646c1f88763e62e0cd08ad050ea66ac46f',
+    hmtSubgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/hmt-stats-bsc-testnet/version/latest',
+    hmtSubgraphUrlApiKey:
+      'https://gateway.thegraph.com/api/deployments/id/QmPMRbrXKp7a1i5x27dzBHbomxqKYDg5eU3djv1DXB5heq',
   },
   [ChainId.POLYGON]: {
     chainId: ChainId.POLYGON,
@@ -95,12 +111,16 @@ export const NETWORKS: {
     stakingAddress: '0x01D115E9E8bF0C58318793624CC662a030D07F1D',
     kvstoreAddress: '0xbcB28672F826a50B03EE91B28145EAbddA73B2eD',
     subgraphUrl:
-      'https://api.studio.thegraph.com/query/74256/polygon/version/latest',
+      'https://api.studio.thegraph.com/query/74256/human-polygon/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmQNkWNE5FPtqbtSkdtR6AEBJz9N7WDz1X7pfvQqYAcUZJ',
+      'https://gateway.thegraph.com/api/deployments/id/QmSu7B48kgGgMgXaD6Yb4fXjbnsJNmobKAU9qZgescZXid',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon',
     oldFactoryAddress: '0x45eBc3eAE6DA485097054ae10BA1A0f8e8c7f794',
+    hmtSubgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/hmt-stats-polygon/version/latest',
+    hmtSubgraphUrlApiKey:
+      'https://gateway.thegraph.com/api/deployments/id/QmcTTTq2reYDBP5j5P2eToc5FmYbJ5ZSMhPaRB6NLriNjR',
   },
   [ChainId.POLYGON_AMOY]: {
     chainId: ChainId.POLYGON_AMOY,
@@ -111,20 +131,24 @@ export const NETWORKS: {
     stakingAddress: '0xffE496683F842a923110415b7278ded3F265f2C5',
     kvstoreAddress: '0x724AeFC243EdacCA27EAB86D3ec5a76Af4436Fc7',
     subgraphUrl:
-      'https://api.studio.thegraph.com/query/74256/amoy/version/latest',
+      'https://api.studio.thegraph.com/query/74256/human-amoy/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmcLwLMw3UzCSbNbjegrpNu6PB3kAd67xquuyaVWvc5Q7Q',
+      'https://gateway.thegraph.com/api/deployments/id/QmRx5WSi7o9FtENWnE5eEz8Dr7kYUazk4TNPRt65UZkKkB',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
+    hmtSubgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/hmt-stats-amoy/version/latest',
+    hmtSubgraphUrlApiKey:
+      'https://gateway.thegraph.com/api/deployments/id/QmZze6UWMJna8dQ183TVounSfGwc9C36RgQCGWhFzgrW3y',
   },
   [ChainId.LOCALHOST]: {
     chainId: ChainId.LOCALHOST,
     title: 'Localhost',
     scanUrl: '',
-    factoryAddress: '0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9',
+    factoryAddress: '0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9',
     hmtAddress: '0x5FbDB2315678afecb367f032d93F642f64180aa3',
     stakingAddress: '0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512',
-    kvstoreAddress: '0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9',
+    kvstoreAddress: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
     subgraphUrl: 'http://localhost:8000/subgraphs/name/humanprotocol/localhost',
     subgraphUrlApiKey: '',
     oldSubgraphUrl: '',

package/src/{encryption.ts → encryption/encryption.ts}

@@ -1,21 +1,5 @@
 import * as openpgp from 'openpgp';
-import { IKeyPair } from './interfaces';
-
-/**
- * Type representing the data type of a message.
- * It can be either a string or a Uint8Array.
- *
- * @public
- */
-export type MessageDataType = string | Uint8Array;
-
-function makeMessageDataBinary(message: MessageDataType): Uint8Array {
-  if (typeof message === 'string') {
-    return Buffer.from(message);
-  }
-
-  return message;
-}
+import { makeMessageDataBinary, MessageDataType } from './types';
 
 /**
  * Class for signing and decrypting messages.
@@ -191,179 +175,3 @@ export class Encryption {
     return cleartextMessage;
   }
 }
-
-/**
- * Utility class for encryption-related operations.
- */
-export class EncryptionUtils {
-  /**
-   * This function verifies the signature of a signed message using the public key.
-   *
-   * @param message - Message to verify.
-   * @param publicKey - Public key to verify that the message was signed by a specific source.
-   * @returns True if verified. False if not verified.
-   *
-   * @example
-   * ```ts
-   * import { EncryptionUtils } from '@human-protocol/sdk';
-   *
-   * const publicKey = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
-   * const result = await EncryptionUtils.verify('message', publicKey);
-   * console.log('Verification result:', result);
-   * ```
-   */
-  public static async verify(
-    message: string,
-    publicKey: string
-  ): Promise<boolean> {
-    const pgpPublicKey = await openpgp.readKey({ armoredKey: publicKey });
-    const signedMessage = await openpgp.readCleartextMessage({
-      cleartextMessage: message,
-    });
-
-    const verificationResult = await signedMessage.verify([pgpPublicKey]);
-    const { verified } = verificationResult[0];
-
-    try {
-      return await verified;
-    } catch {
-      return false;
-    }
-  }
-
-  /**
-   * This function gets signed data from a signed message.
-   *
-   * @param message - Message.
-   * @returns Signed data.
-   * @throws Error If data could not be extracted from the message
-   *
-   * @example
-   * ```ts
-   * import { EncryptionUtils } from '@human-protocol/sdk';
-   *
-   * const signedData = await EncryptionUtils.getSignedData('message');
-   * console.log('Signed data:', signedData);
-   * ```
-   */
-  public static async getSignedData(message: string): Promise<string> {
-    const signedMessage = await openpgp.readCleartextMessage({
-      cleartextMessage: message,
-    });
-
-    try {
-      return signedMessage.getText();
-    } catch (e) {
-      throw new Error('Could not get data: ' + e.message);
-    }
-  }
-
-  /**
-   * This function generates a key pair for encryption and decryption.
-   *
-   * @param name - Name for the key pair.
-   * @param email - Email for the key pair.
-   * @param passphrase - Passphrase to encrypt the private key (optional, defaults to empty string).
-   * @returns Key pair generated.
-   *
-   * @example
-   * ```ts
-   * import { EncryptionUtils } from '@human-protocol/sdk';
-   *
-   * const name = 'YOUR_NAME';
-   * const email = 'YOUR_EMAIL';
-   * const passphrase = 'YOUR_PASSPHRASE';
-   * const keyPair = await EncryptionUtils.generateKeyPair(name, email, passphrase);
-   * console.log('Public key:', keyPair.publicKey);
-   * ```
-   */
-  public static async generateKeyPair(
-    name: string,
-    email: string,
-    passphrase = ''
-  ): Promise<IKeyPair> {
-    const { privateKey, publicKey, revocationCertificate } =
-      await openpgp.generateKey({
-        type: 'ecc',
-        curve: 'ed25519Legacy',
-        userIDs: [{ name: name, email: email }],
-        passphrase: passphrase,
-        format: 'armored',
-      });
-
-    return {
-      passphrase: passphrase,
-      privateKey,
-      publicKey,
-      revocationCertificate,
-    };
-  }
-
-  /**
-   * This function encrypts a message using the specified public keys.
-   *
-   * @param message - Message to encrypt.
-   * @param publicKeys - Array of public keys to use for encryption.
-   * @returns Message encrypted.
-   *
-   * @example
-   * ```ts
-   * import { EncryptionUtils } from '@human-protocol/sdk';
-   *
-   * const publicKey1 = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
-   * const publicKey2 = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
-   * const publicKeys = [publicKey1, publicKey2];
-   * const encryptedMessage = await EncryptionUtils.encrypt('message', publicKeys);
-   * console.log('Encrypted message:', encryptedMessage);
-   * ```
-   */
-  public static async encrypt(
-    message: MessageDataType,
-    publicKeys: string[]
-  ): Promise<string> {
-    const pgpPublicKeys = await Promise.all(
-      publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey }))
-    );
-
-    const pgpMessage = await openpgp.createMessage({
-      binary: makeMessageDataBinary(message),
-    });
-    const encrypted = await openpgp.encrypt({
-      message: pgpMessage,
-      encryptionKeys: pgpPublicKeys,
-      format: 'armored',
-    });
-
-    return encrypted as string;
-  }
-
-  /**
-   * Verifies if a message appears to be encrypted with OpenPGP.
-   *
-   * @param message - Message to verify.
-   * @returns `true` if the message appears to be encrypted, `false` if not.
-   *
-   * @example
-   * ```ts
-   * import { EncryptionUtils } from '@human-protocol/sdk';
-   *
-   * const message = '-----BEGIN PGP MESSAGE-----...';
-   * const isEncrypted = EncryptionUtils.isEncrypted(message);
-   *
-   * if (isEncrypted) {
-   *   console.log('The message is encrypted with OpenPGP.');
-   * } else {
-   *   console.log('The message is not encrypted with OpenPGP.');
-   * }
-   * ```
-   */
-  public static isEncrypted(message: string): boolean {
-    const startMarker = '-----BEGIN PGP MESSAGE-----';
-    const endMarker = '-----END PGP MESSAGE-----';
-
-    const hasStartMarker = message.includes(startMarker);
-    const hasEndMarker = message.includes(endMarker);
-
-    return hasStartMarker && hasEndMarker;
-  }
-}