@human-protocol/sdk 5.2.0 → 6.1.0

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { TransactionLike } from 'ethers';
+import { Overrides, TransactionLike } from 'ethers';
 /**
  * Enum for escrow statuses.
  * @readonly
@@ -34,60 +34,6 @@ export declare enum EscrowStatus {
      */
     ToCancel = 6
 }
-/**
- * AWS/GCP cloud storage access data
- * @readonly
- * @deprecated StorageClient is deprecated. Use Minio.Client directly.
- */
-export type StorageCredentials = {
-    /**
-     * Access Key
-     */
-    accessKey: string;
-    /**
-     * Secret Key
-     */
-    secretKey: string;
-};
-/**
- * @deprecated StorageClient is deprecated. Use Minio.Client directly.
- */
-export type StorageParams = {
-    /**
-     * Request endPoint
-     */
-    endPoint: string;
-    /**
-     * Enable secure (HTTPS) access. Default value set to false
-     */
-    useSSL: boolean;
-    /**
-     * Region
-     */
-    region?: string;
-    /**
-     * TCP/IP port number. Default value set to 80 for HTTP and 443 for HTTPs
-     */
-    port?: number;
-};
-/**
- * Upload file data
- * @readonly
- */
-export type UploadFile = {
-    /**
-     * Uploaded object key
-     */
-    key: string;
-    /**
-     * Uploaded object URL
-     */
-    url: string;
-    /**
-     * Hash of uploaded object key
-     */
-    hash: string;
-};
 /**
  * Network data
  */
@@ -137,6 +83,19 @@ export type NetworkData = {
      */
     oldFactoryAddress: string;
 };
+/**
+ * Options that configure how long to wait for transaction confirmations.
+ */
+export type WaitOptions = {
+    /** Number of block confirmations to wait for. */
+    confirmations?: number;
+    /** Milliseconds to wait before aborting `tx.wait()`. */
+    timeoutMs?: number;
+};
+/**
+ * Extends ethers overrides with `wait()` options that control confirmation count and timeout.
+ */
+export type TransactionOverrides = Overrides & WaitOptions;
 export type TransactionLikeWithNonce = TransactionLike & {
     nonce: number;
 };

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEzC;;;;GAIG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,SAAS,IAAA;IACT;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEpD;;;;GAIG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,SAAS,IAAA;IACT;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,iDAAiD;IACjD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,WAAW,CAAC;AAE3D,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/utils.d.ts

@@ -1,44 +1,58 @@
-import { NetworkData } from './types';
 import { SubgraphOptions } from './interfaces';
+import { NetworkData } from './types';
 /**
- * **Handle and throw the error.*
+ * Handles and throws appropriate error types based on the Ethereum error.
  *
- * @param {any} e
- * @returns
+ * @param e - The error to handle
+ * @throws {InvalidArgumentError} If the error is an invalid argument error
+ * @throws {ContractExecutionError} If the error is a contract execution error
+ * @throws {TransactionReplaced} If the transaction was replaced
+ * @throws {ReplacementUnderpriced} If the replacement transaction was underpriced
+ * @throws {NumericFault} If there's a numeric fault
+ * @throws {NonceExpired} If the nonce has expired
+ * @throws {EthereumError} For any other Ethereum-related error
  */
 export declare const throwError: (e: any) => never;
 /**
- * **URL validation.*
+ * Validates if a string is a valid URL.
  *
- * @param {string} url
- * @returns
+ * @param url - The URL string to validate
+ * @returns True if the URL is valid, false otherwise
  */
 export declare const isValidUrl: (url: string) => boolean;
 /**
- * **Check if a string is a valid JSON.*
+ * Checks if a string is valid JSON.
  *
- * @param {string} input
- * @returns {boolean}
+ * @param input - The string to check
+ * @returns True if the string is valid JSON, false otherwise
  */
 export declare const isValidJson: (input: string) => boolean;
 /**
- * **Get the subgraph URL.*
+ * Gets the subgraph URL for the given network, using API key if available.
  *
- * @param {NetworkData} networkData
- * @returns
+ * @param networkData - The network data containing subgraph URLs
+ * @returns The subgraph URL with API key if available
  */
 export declare const getSubgraphUrl: (networkData: NetworkData) => string;
 /**
- * **Convert a date to Unix timestamp (seconds since epoch).*
+ * Converts a Date object to Unix timestamp (seconds since epoch).
  *
- * @param {Date} date
- * @returns {number}
+ * @param date - The date to convert
+ * @returns Unix timestamp in seconds
  */
 export declare const getUnixTimestamp: (date: Date) => number;
 export declare const isIndexerError: (error: any) => boolean;
 /**
- * Execute a GraphQL request with automatic retry logic for bad indexer errors.
- * Only retries if options is provided.
+ * Executes a GraphQL request with automatic retry logic for bad indexer errors.
+ * Only retries if options is provided with maxRetries and baseDelay.
+ *
+ * @param url - The GraphQL endpoint URL
+ * @param query - The GraphQL query to execute
+ * @param variables - Variables for the GraphQL query (optional)
+ * @param options - Optional configuration for subgraph requests including retry logic
+ * @returns The response data from the GraphQL query
+ * @throws ErrorRetryParametersMissing If only one of maxRetries or baseDelay is provided
+ * @throws ErrorRoutingRequestsToIndexerRequiresApiKey If indexerId is provided without API key
  */
 export declare const customGqlFetch: <T = any>(url: string, query: any, variables?: any, options?: SubgraphOptions) => Promise<T>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C;;;;;GAKG;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,WAatD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,IAAI,KAAG,MAE7C,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,OAAO,GAAG,KAAG,OAS3C,CAAC;AAaF;;;GAGG;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":"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"}

package/dist/utils.js

@@ -8,14 +8,19 @@ exports.customGqlFetch = exports.isIndexerError = exports.getUnixTimestamp = exp
 const ethers_1 = require("ethers");
 const graphql_request_1 = __importDefault(require("graphql-request"));
 const validator_1 = require("validator");
-const constants_1 = require("./constants");
 const enums_1 = require("./enums");
 const error_1 = require("./error");
 /**
- * **Handle and throw the error.*
+ * Handles and throws appropriate error types based on the Ethereum error.
  *
- * @param {any} e
- * @returns
+ * @param e - The error to handle
+ * @throws {InvalidArgumentError} If the error is an invalid argument error
+ * @throws {ContractExecutionError} If the error is a contract execution error
+ * @throws {TransactionReplaced} If the transaction was replaced
+ * @throws {ReplacementUnderpriced} If the replacement transaction was underpriced
+ * @throws {NumericFault} If there's a numeric fault
+ * @throws {NonceExpired} If the nonce has expired
+ * @throws {EthereumError} For any other Ethereum-related error
  */
 const throwError = (e) => {
     if (ethers_1.ethers.isError(e, 'INVALID_ARGUMENT')) {
@@ -42,10 +47,10 @@ const throwError = (e) => {
 };
 exports.throwError = throwError;
 /**
- * **URL validation.*
+ * Validates if a string is a valid URL.
  *
- * @param {string} url
- * @returns
+ * @param url - The URL string to validate
+ * @returns True if the URL is valid, false otherwise
  */
 const isValidUrl = (url) => {
     return (0, validator_1.isURL)(url, {
@@ -56,10 +61,10 @@ const isValidUrl = (url) => {
 };
 exports.isValidUrl = isValidUrl;
 /**
- * **Check if a string is a valid JSON.*
+ * Checks if a string is valid JSON.
  *
- * @param {string} input
- * @returns {boolean}
+ * @param input - The string to check
+ * @returns True if the string is valid JSON, false otherwise
  */
 const isValidJson = (input) => {
     try {
@@ -72,15 +77,15 @@ const isValidJson = (input) => {
 };
 exports.isValidJson = isValidJson;
 /**
- * **Get the subgraph URL.*
+ * Gets the subgraph URL for the given network, using API key if available.
  *
- * @param {NetworkData} networkData
- * @returns
+ * @param networkData - The network data containing subgraph URLs
+ * @returns The subgraph URL with API key if available
  */
 const getSubgraphUrl = (networkData) => {
     let subgraphUrl = networkData.subgraphUrl;
     if (process.env.SUBGRAPH_API_KEY) {
-        subgraphUrl = networkData.subgraphUrlApiKey.replace(constants_1.SUBGRAPH_API_KEY_PLACEHOLDER, process.env.SUBGRAPH_API_KEY);
+        subgraphUrl = networkData.subgraphUrlApiKey;
     }
     else if (networkData.chainId !== enums_1.ChainId.LOCALHOST) {
         // eslint-disable-next-line no-console
@@ -90,10 +95,10 @@ const getSubgraphUrl = (networkData) => {
 };
 exports.getSubgraphUrl = getSubgraphUrl;
 /**
- * **Convert a date to Unix timestamp (seconds since epoch).*
+ * Converts a Date object to Unix timestamp (seconds since epoch).
  *
- * @param {Date} date
- * @returns {number}
+ * @param date - The date to convert
+ * @returns Unix timestamp in seconds
  */
 const getUnixTimestamp = (date) => {
     return Math.floor(date.getTime() / 1000);
@@ -119,8 +124,16 @@ const buildIndexerUrl = (baseUrl, indexerId) => {
     return `${baseUrl}/indexers/id/${indexerId}`;
 };
 /**
- * Execute a GraphQL request with automatic retry logic for bad indexer errors.
- * Only retries if options is provided.
+ * Executes a GraphQL request with automatic retry logic for bad indexer errors.
+ * Only retries if options is provided with maxRetries and baseDelay.
+ *
+ * @param url - The GraphQL endpoint URL
+ * @param query - The GraphQL query to execute
+ * @param variables - Variables for the GraphQL query (optional)
+ * @param options - Optional configuration for subgraph requests including retry logic
+ * @returns The response data from the GraphQL query
+ * @throws ErrorRetryParametersMissing If only one of maxRetries or baseDelay is provided
+ * @throws ErrorRoutingRequestsToIndexerRequiresApiKey If indexerId is provided without API key
  */
 const customGqlFetch = async (url, query, variables, options) => {
     const apiKey = process.env.SUBGRAPH_API_KEY;

package/dist/worker.d.ts

@@ -1,20 +1,39 @@
 import { ChainId } from './enums';
 import { IWorker, IWorkersFilter, SubgraphOptions } from './interfaces';
+/**
+ * Utility class for worker-related operations.
+ *
+ * @example
+ * ```ts
+ * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
+ *
+ * const worker = await WorkerUtils.getWorker(
+ *   ChainId.POLYGON_AMOY,
+ *   '0x1234567890abcdef1234567890abcdef12345678'
+ * );
+ * console.log('Worker:', worker);
+ * ```
+ */
 export declare class WorkerUtils {
     /**
      * This function returns the worker data for the given address.
      *
-     * @param {ChainId} chainId The chain ID.
-     * @param {string} address The worker address.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IWorker | null>} - Returns the worker details or null if not found.
-     *
-     * **Code example**
+     * @param chainId - The chain ID.
+     * @param address - The worker address.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Returns the worker details or null if not found.
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
+     * @throws ErrorInvalidAddress If the address is invalid
      *
+     * @example
      * ```ts
      * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
      *
-     * const worker = await WorkerUtils.getWorker(ChainId.POLYGON, '0x1234567890abcdef1234567890abcdef12345678');
+     * const worker = await WorkerUtils.getWorker(
+     *   ChainId.POLYGON_AMOY,
+     *   '0x1234567890abcdef1234567890abcdef12345678'
+     * );
+     * console.log('Worker:', worker);
      * ```
      */
     static getWorker(chainId: ChainId, address: string, options?: SubgraphOptions): Promise<IWorker | null>;
@@ -43,21 +62,23 @@ export declare class WorkerUtils {
      * };
      * ```
      *
-     * @param {IWorkersFilter} filter Filter for the workers.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IWorker[]>} Returns an array with all the worker details.
-     *
-     * **Code example**
+     * @param filter - Filter for the workers.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Returns an array with all the worker details.
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
+     * @throws ErrorInvalidAddress If the filter address is invalid
      *
+     * @example
      * ```ts
      * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
      *
-     * const filter: IWorkersFilter = {
-     *   chainId: ChainId.POLYGON,
+     * const filter = {
+     *   chainId: ChainId.POLYGON_AMOY,
      *   first: 10,
      *   skip: 0,
      * };
      * const workers = await WorkerUtils.getWorkers(filter);
+     * console.log('Workers:', workers.length);
      * ```
      */
     static getWorkers(filter: IWorkersFilter, options?: SubgraphOptions): Promise<IWorker[]>;

package/dist/worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAIlD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAGxE,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;;OAeG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IA0B1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,OAAO,EAAE,CAAC;CAoCtB"}
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAIlD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAGxE;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,OAAO,EAAE,CAAC;CAoCtB"}

package/dist/worker.js

@@ -7,21 +7,40 @@ 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.
+ *
+ * @example
+ * ```ts
+ * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
+ *
+ * const worker = await WorkerUtils.getWorker(
+ *   ChainId.POLYGON_AMOY,
+ *   '0x1234567890abcdef1234567890abcdef12345678'
+ * );
+ * console.log('Worker:', worker);
+ * ```
+ */
 class WorkerUtils {
     /**
      * This function returns the worker data for the given address.
      *
-     * @param {ChainId} chainId The chain ID.
-     * @param {string} address The worker address.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IWorker | null>} - Returns the worker details or null if not found.
-     *
-     * **Code example**
+     * @param chainId - The chain ID.
+     * @param address - The worker address.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Returns the worker details or null if not found.
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
+     * @throws ErrorInvalidAddress If the address is invalid
      *
+     * @example
      * ```ts
      * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
      *
-     * const worker = await WorkerUtils.getWorker(ChainId.POLYGON, '0x1234567890abcdef1234567890abcdef12345678');
+     * const worker = await WorkerUtils.getWorker(
+     *   ChainId.POLYGON_AMOY,
+     *   '0x1234567890abcdef1234567890abcdef12345678'
+     * );
+     * console.log('Worker:', worker);
      * ```
      */
     static async getWorker(chainId, address, options) {
@@ -64,21 +83,23 @@ class WorkerUtils {
      * };
      * ```
      *
-     * @param {IWorkersFilter} filter Filter for the workers.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IWorker[]>} Returns an array with all the worker details.
-     *
-     * **Code example**
+     * @param filter - Filter for the workers.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Returns an array with all the worker details.
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
+     * @throws ErrorInvalidAddress If the filter address is invalid
      *
+     * @example
      * ```ts
      * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
      *
-     * const filter: IWorkersFilter = {
-     *   chainId: ChainId.POLYGON,
+     * const filter = {
+     *   chainId: ChainId.POLYGON_AMOY,
      *   first: 10,
      *   skip: 0,
      * };
      * const workers = await WorkerUtils.getWorkers(filter);
+     * console.log('Workers:', workers.length);
      * ```
      */
     static async getWorkers(filter, options) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "5.2.0",
+  "version": "6.1.0",
   "files": [
     "src",
     "dist"
@@ -10,9 +10,9 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "clean": "tsc --build --clean && rm -rf ./dist",
-    "clean:doc": "rm -rf ../../../../docs/sdk/typescript/",
     "build": "yarn clean && tsc --build",
-    "build:doc": "yarn clean:doc && typedoc --plugin typedoc-plugin-markdown --out ../../../../docs/sdk/typescript/",
+    "docs:post": "ts-node scripts/postprocess-docs.ts",
+    "build:doc": "typedoc && yarn docs:post",
     "test": "vitest -u",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
@@ -44,7 +44,6 @@
     "graphql": "^16.8.1",
     "graphql-request": "^7.3.4",
     "graphql-tag": "^2.12.6",
-    "minio": "7.1.3",
     "openpgp": "^6.2.2",
     "secp256k1": "^5.0.1",
     "validator": "^13.12.0",
@@ -54,28 +53,12 @@
     "@types/validator": "^13.15.4",
     "eslint": "^9.39.1",
     "eslint-plugin-jest": "^28.9.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "prettier": "^3.4.2",
+    "eslint-plugin-prettier": "^5.5.5",
+    "glob": "^13.0.0",
+    "prettier": "^3.7.4",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.2.3",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.8.3"
-  },
-  "typedocOptions": {
-    "entryPoints": [
-      "./src/base.ts",
-      "./src/encryption.ts",
-      "./src/escrow.ts",
-      "./src/kvstore.ts",
-      "./src/operator.ts",
-      "./src/staking.ts",
-      "./src/storage.ts",
-      "./src/statistics.ts",
-      "./src/transaction.ts",
-      "./src/enums.ts",
-      "./src/graphql/types.ts",
-      "./src/interfaces.ts",
-      "./src/types.ts"
-    ]
   }
 }

package/src/base.ts

@@ -1,11 +1,15 @@
-import { ContractRunner } from 'ethers';
-import { NetworkData } from './types';
+import {
+  ContractRunner,
+  ContractTransactionReceipt,
+  ContractTransactionResponse,
+  Overrides,
+} from 'ethers';
+import { NetworkData, TransactionOverrides, WaitOptions } from './types';
 
 /**
- * ## Introduction
- *
- * This class is used as a base class for other clients making on-chain calls.
+ * Base class for clients making on-chain calls.
  *
+ * This class provides common functionality for interacting with Ethereum contracts.
  */
 export abstract class BaseEthersClient {
   protected runner: ContractRunner;
@@ -14,11 +18,42 @@ export abstract class BaseEthersClient {
   /**
    * **BaseClient constructor**
    *
-   * @param {ContractRunner} runner The Signer or Provider object to interact with the Ethereum network
-   * @param {NetworkData} networkData The network information required to connect to the contracts
+   * @param runner - The Signer or Provider object to interact with the Ethereum network
+   * @param networkData - The network information required to connect to the contracts
    */
   constructor(runner: ContractRunner, networkData: NetworkData) {
     this.networkData = networkData;
     this.runner = runner;
   }
+
+  protected normalizeTxOptions(
+    txOptions?: TransactionOverrides
+  ): [Overrides, WaitOptions] {
+    const options = txOptions ?? {};
+    const {
+      confirmations: waitConfirmations,
+      timeoutMs: waitTimeoutMs,
+      ...overrides
+    } = options;
+
+    const waitOptions: WaitOptions = {
+      confirmations: waitConfirmations,
+      timeoutMs: waitTimeoutMs,
+    };
+
+    return [overrides as Overrides, waitOptions];
+  }
+
+  protected async sendTxAndWait(
+    executeTx: (overrides: Overrides) => Promise<ContractTransactionResponse>,
+    txOptions?: TransactionOverrides
+  ): Promise<ContractTransactionReceipt | null> {
+    const [overrides, waitOptions] = this.normalizeTxOptions(txOptions);
+    const transactionResponse = await executeTx(overrides);
+
+    return transactionResponse.wait(
+      waitOptions.confirmations,
+      waitOptions.timeoutMs
+    );
+  }
 }

package/src/constants.ts

@@ -36,7 +36,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/ethereum/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmXGmcjEtwwEgB83KE2ECjjYY38kLMqzaq4ip8GWY7A6zz',
+      'https://gateway.thegraph.com/api/deployments/id/QmNhLQEfBJQ46fngBh4YCttk8kNkveFy5uvAeUmyAdX1kD',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -51,7 +51,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/sepolia/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmT4xNvZh8ymarrk1zdytjLhCW59iuTavsd4JgHS4LbCVB',
+      'https://gateway.thegraph.com/api/deployments/id/QmQghdr7hxqrjFde8DN15TzfrJLCfwvzmUH9RzWwH1mKzk',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -66,7 +66,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/bsc/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmdVdpm9NnFz5B8QyzhW1bW1nNfRWemTiFn2MrhYZGTSQD',
+      'https://gateway.thegraph.com/api/deployments/id/QmTioC9Z1HzKSCnEKL3BP9iHqbgZt1ceLU2VE4Mv6sxNkd',
     oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
     oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
   },
@@ -81,7 +81,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/bsc-testnet/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmZjYMktZe8RAz7W7qL33VZBV6AC57xsLyE1cEfv6NABdZ',
+      'https://gateway.thegraph.com/api/deployments/id/QmPyUYRjAvzDdeenXMGHcCRD2v4qwZbKMEkVkY3Jq6VLwn',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest',
     oldFactoryAddress: '0xaae6a2646c1f88763e62e0cd08ad050ea66ac46f',
@@ -97,7 +97,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/polygon/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmUt9mmfNjtC5ZnQNiWHRbFG3k5zfngMuoTyky9jhXYqG2',
+      'https://gateway.thegraph.com/api/deployments/id/QmQNkWNE5FPtqbtSkdtR6AEBJz9N7WDz1X7pfvQqYAcUZJ',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon',
     oldFactoryAddress: '0x45eBc3eAE6DA485097054ae10BA1A0f8e8c7f794',
@@ -113,7 +113,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/amoy/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmWRUFWpWoRRUh7Ec1HUJEwxc84DkP4iFTfLLsoVngJAPa',
+      'https://gateway.thegraph.com/api/deployments/id/QmcLwLMw3UzCSbNbjegrpNu6PB3kAd67xquuyaVWvc5Q7Q',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -154,6 +154,4 @@ export const Role = {
   RecordingOracle: 'recording_oracle',
 };
 
-export const SUBGRAPH_API_KEY_PLACEHOLDER = '[SUBGRAPH_API_KEY]';
-
 export const ESCROW_BULK_PAYOUT_MAX_ITEMS = 99;