@human-protocol/sdk 3.0.7 → 4.0.0

package/dist/storage.d.ts

@@ -5,7 +5,7 @@ import { UploadFile, StorageCredentials, StorageParams } from './types';
  *
  * ## Introduction
  *
- * This client enables to interact with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage and others.
+ * This client enables interacting with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage, and others.
  *
  * The instance creation of `StorageClient` should be made using its constructor:
  *
@@ -13,7 +13,7 @@ import { UploadFile, StorageCredentials, StorageParams } from './types';
  * constructor(params: StorageParams, credentials?: StorageCredentials)
  * ```
  *
- * > If credentials is not provided, it uses an anonymous access to the bucket for downloading files.
+ * > If credentials are not provided, it uses anonymous access to the bucket for downloading files.
  *
  * ## Installation
  *
@@ -53,7 +53,7 @@ export declare class StorageClient {
      * **Storage client constructor**
      *
      * @param {StorageParams} params - Cloud storage params
-     * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket
+     * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials are not provided - use anonymous access to the bucket
      */
     constructor(params: StorageParams, credentials?: StorageCredentials);
     /**
@@ -61,8 +61,7 @@ export declare class StorageClient {
      *
      * @param {string[]} keys Array of filenames to download.
      * @param {string} bucket Bucket name.
-     * @returns {any[]} Returns an array of json files downloaded and parsed into objects.
-     *
+     * @returns {Promise<any[]>} Returns an array of JSON files downloaded and parsed into objects.
      *
      * **Code example**
      *
@@ -84,28 +83,26 @@ export declare class StorageClient {
      */
     downloadFiles(keys: string[], bucket: string): Promise<any[]>;
     /**
-     * This function downloads files from a Url.
-     *
-     * @param {string} url Url of the file to download.
-     * @returns {any} Returns the JSON file downloaded and parsed into object.
+     * This function downloads files from a URL.
      *
+     * @param {string} url URL of the file to download.
+     * @returns {Promise<any>} Returns the JSON file downloaded and parsed into an object.
      *
      * **Code example**
      *
      * ```ts
      * import { StorageClient } from '@human-protocol/sdk';
      *
-     * const file = await storageClient.downloadFileFromUrl('http://localhost/file.json');
+     * const file = await StorageClient.downloadFileFromUrl('http://localhost/file.json');
      * ```
      */
     static downloadFileFromUrl(url: string): Promise<any>;
     /**
      * This function uploads files to a bucket.
      *
-     * @param {any[]} files Array of objects to upload serialized into json.
+     * @param {any[]} files Array of objects to upload serialized into JSON.
      * @param {string} bucket Bucket name.
-     * @returns {UploadFile[]} Returns an array of json files downloaded and parsed into objects.
-     *
+     * @returns {Promise<UploadFile[]>} Returns an array of uploaded file metadata.
      *
      * **Code example**
      *
@@ -135,8 +132,7 @@ export declare class StorageClient {
      * This function checks if a bucket exists.
      *
      * @param {string} bucket Bucket name.
-     * @returns {boolean} Returns `true` if exists, `false` if it doesn't.
-     *
+     * @returns {Promise<boolean>} Returns `true` if exists, `false` if it doesn't.
      *
      * **Code example**
      *
@@ -160,11 +156,10 @@ export declare class StorageClient {
      */
     bucketExists(bucket: string): Promise<boolean>;
     /**
-     * This function list all file names contained in the bucket.
+     * This function lists all file names contained in the bucket.
      *
      * @param {string} bucket Bucket name.
-     * @returns {boolean} Returns the list of file names contained in the bucket.
-     *
+     * @returns {Promise<string[]>} Returns the list of file names contained in the bucket.
      *
      * **Code example**
      *

package/dist/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAIxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;OAKG;gBACS,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,kBAAkB;IAcnE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAoB1E;;;;;;;;;;;;;;OAcG;WACiB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,WAAW,CACtB,KAAK,EAAE,GAAG,EAAE,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,EAAE,CAAC;IAmCxB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB5D"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAIxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;OAKG;gBACS,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE,kBAAkB;IAcnE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAoB1E;;;;;;;;;;;;;OAaG;WACiB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACU,WAAW,CACtB,KAAK,EAAE,GAAG,EAAE,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,EAAE,CAAC;IAmCxB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB5D"}

package/dist/storage.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -40,7 +50,7 @@ const constants_1 = require("./constants");
  *
  * ## Introduction
  *
- * This client enables to interact with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage and others.
+ * This client enables interacting with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage, and others.
  *
  * The instance creation of `StorageClient` should be made using its constructor:
  *
@@ -48,7 +58,7 @@ const constants_1 = require("./constants");
  * constructor(params: StorageParams, credentials?: StorageCredentials)
  * ```
  *
- * > If credentials is not provided, it uses an anonymous access to the bucket for downloading files.
+ * > If credentials are not provided, it uses anonymous access to the bucket for downloading files.
  *
  * ## Installation
  *
@@ -86,7 +96,7 @@ class StorageClient {
      * **Storage client constructor**
      *
      * @param {StorageParams} params - Cloud storage params
-     * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket
+     * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials are not provided - use anonymous access to the bucket
      */
     constructor(params, credentials) {
         try {
@@ -106,8 +116,7 @@ class StorageClient {
      *
      * @param {string[]} keys Array of filenames to download.
      * @param {string} bucket Bucket name.
-     * @returns {any[]} Returns an array of json files downloaded and parsed into objects.
-     *
+     * @returns {Promise<any[]>} Returns an array of JSON files downloaded and parsed into objects.
      *
      * **Code example**
      *
@@ -144,18 +153,17 @@ class StorageClient {
         }));
     }
     /**
-     * This function downloads files from a Url.
-     *
-     * @param {string} url Url of the file to download.
-     * @returns {any} Returns the JSON file downloaded and parsed into object.
+     * This function downloads files from a URL.
      *
+     * @param {string} url URL of the file to download.
+     * @returns {Promise<any>} Returns the JSON file downloaded and parsed into an object.
      *
      * **Code example**
      *
      * ```ts
      * import { StorageClient } from '@human-protocol/sdk';
      *
-     * const file = await storageClient.downloadFileFromUrl('http://localhost/file.json');
+     * const file = await StorageClient.downloadFileFromUrl('http://localhost/file.json');
      * ```
      */
     static async downloadFileFromUrl(url) {
@@ -180,10 +188,9 @@ class StorageClient {
     /**
      * This function uploads files to a bucket.
      *
-     * @param {any[]} files Array of objects to upload serialized into json.
+     * @param {any[]} files Array of objects to upload serialized into JSON.
      * @param {string} bucket Bucket name.
-     * @returns {UploadFile[]} Returns an array of json files downloaded and parsed into objects.
-     *
+     * @returns {Promise<UploadFile[]>} Returns an array of uploaded file metadata.
      *
      * **Code example**
      *
@@ -237,8 +244,7 @@ class StorageClient {
      * This function checks if a bucket exists.
      *
      * @param {string} bucket Bucket name.
-     * @returns {boolean} Returns `true` if exists, `false` if it doesn't.
-     *
+     * @returns {Promise<boolean>} Returns `true` if exists, `false` if it doesn't.
      *
      * **Code example**
      *
@@ -264,11 +270,10 @@ class StorageClient {
         return this.client.bucketExists(bucket);
     }
     /**
-     * This function list all file names contained in the bucket.
+     * This function lists all file names contained in the bucket.
      *
      * @param {string} bucket Bucket name.
-     * @returns {boolean} Returns the list of file names contained in the bucket.
-     *
+     * @returns {Promise<string[]>} Returns the list of file names contained in the bucket.
      *
      * **Code example**
      *

package/dist/transaction.js

@@ -30,7 +30,7 @@ class TransactionUtils {
      */
     static async getTransaction(chainId, hash) {
         if (!ethers_1.ethers.isHexString(hash)) {
-            throw error_1.ErrorInvalidHahsProvided;
+            throw error_1.ErrorInvalidHashProvided;
         }
         const networkData = constants_1.NETWORKS[chainId];
         if (!networkData) {

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { TransactionLike } from 'ethers';
 /**
  * Enum for escrow statuses.
  * @readonly
@@ -21,7 +22,7 @@ export declare enum EscrowStatus {
      */
     Paid = 3,
     /**
-     * Escrow is finished..
+     * Escrow is finished.
      */
     Complete = 4,
     /**
@@ -111,10 +112,6 @@ export type NetworkData = {
      * Staking contract address
      */
     stakingAddress: string;
-    /**
-     * RewardPool contract address
-     */
-    rewardPoolAddress: string;
     /**
      * KVStore contract address
      */
@@ -124,7 +121,7 @@ export type NetworkData = {
      */
     subgraphUrl: string;
     /**
-     * Subgraph URL
+     * Subgraph URL API key
      */
     subgraphUrlApiKey: string;
     /**
@@ -149,4 +146,24 @@ export type EscrowCancel = {
      */
     amountRefunded: bigint;
 };
+/**
+ * Represents the response data for an escrow withdrawal.
+ */
+export type EscrowWithdraw = {
+    /**
+     * The hash of the transaction associated with the escrow withdrawal.
+     */
+    txHash: string;
+    /**
+     * The address of the token used for the withdrawal.
+     */
+    tokenAddress: string;
+    /**
+     * The amount withdrawn from the escrow.
+     */
+    amountWithdrawn: bigint;
+};
+export type TransactionLikeWithNonce = TransactionLike & {
+    nonce: number;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;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;CACV;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,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;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,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC"}
+{"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;CACV;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;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/types.js

@@ -25,7 +25,7 @@ var EscrowStatus;
      */
     EscrowStatus[EscrowStatus["Paid"] = 3] = "Paid";
     /**
-     * Escrow is finished..
+     * Escrow is finished.
      */
     EscrowStatus[EscrowStatus["Complete"] = 4] = "Complete";
     /**

package/dist/utils.d.ts

@@ -17,7 +17,6 @@ export declare const isValidUrl: (url: string) => boolean;
  * **Get the subgraph URL.*
  *
  * @param {NetworkData} networkData
- * @param {string} apiKey
  * @returns
  */
 export declare const getSubgraphUrl: (networkData: NetworkData) => string;

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;GAKG;AACH,eAAO,MAAM,UAAU,MAAO,GAAG,UAgBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,YAOrC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,gBAAiB,WAAW,WAatD,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;GAKG;AACH,eAAO,MAAM,UAAU,MAAO,GAAG,UAgBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,YAOrC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,gBAAiB,WAAW,WAatD,CAAC"}

package/dist/utils.js

@@ -55,7 +55,6 @@ exports.isValidUrl = isValidUrl;
  * **Get the subgraph URL.*
  *
  * @param {NetworkData} networkData
- * @param {string} apiKey
  * @returns
  */
 const getSubgraphUrl = (networkData) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "3.0.7",
+  "version": "4.0.0",
   "files": [
     "src",
     "dist"
@@ -46,11 +46,11 @@
     "graphql-tag": "^2.12.6",
     "minio": "7.1.3",
     "openpgp": "^5.11.2",
-    "secp256k1": "^4.0.3",
+    "secp256k1": "^5.0.1",
     "vitest": "^1.6.0"
   },
   "devDependencies": {
-    "typedoc": "^0.26.5",
+    "typedoc": "^0.27.5",
     "typedoc-plugin-markdown": "^4.2.3"
   },
   "typedocOptions": {
@@ -63,7 +63,11 @@
       "./src/staking.ts",
       "./src/storage.ts",
       "./src/statistics.ts",
-      "./src/transaction.ts"
+      "./src/transaction.ts",
+      "./src/enums.ts",
+      "./src/graphql/types.ts",
+      "./src/interfaces.ts",
+      "./src/types.ts"
     ]
   }
 }

package/src/constants.ts

@@ -1,39 +1,16 @@
 import { ChainId } from './enums';
 import { NetworkData } from './types';
 
-/**
- * @constant Default public bucket name
- */
 export const DEFAULT_PUBLIC_BUCKET = 'escrow-public-results';
 
-/**
- * @constant Default storage endpoint
- */
 export const DEFAULT_ENDPOINT = 'localhost';
 
-/**
- * @constant Default storage region
- */
 export const DEFAULT_REGION = 'eu';
 
-/**
- * @constant Default storage port
- */
 export const DEFAULT_PORT = 9000;
 
-/**
- * @constant Default storage port
- */
 export const DEFAULT_USE_SSL = false;
 
-/**
- * @constant Default tx Id
- */
-export const DEFAULT_TX_ID = 1;
-
-/**
- * @constant Default Enum for escrow statuses.
- */
 export enum HttpStatus {
   OK = 200,
   CREATED = 201,
@@ -45,9 +22,6 @@ export enum HttpStatus {
   INTERNAL_SERVER_ERROR = 500,
 }
 
-/**
- * @constant Default network parameters
- */
 export const NETWORKS: {
   [chainId in ChainId]?: NetworkData;
 } = {
@@ -57,13 +31,12 @@ export const NETWORKS: {
     scanUrl: 'https://etherscan.io',
     factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
     hmtAddress: '0xd1ba9BAC957322D6e8c07a160a3A8dA11A0d2867',
-    stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
-    rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
+    stakingAddress: '0xEf6Da3aB52c33925Be3F84038193a7e1331F51E6',
     kvstoreAddress: '0xB6d36B1CDaD50302BCB3DB43bAb0D349458e1b8D',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/ethereum/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmaTcYR8NCzZuxwY7tBkMJAo1Q64BMqNNSzqjxd7FH9s2p',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmNTdYHpQLW4sbrCxihXNdQwhxa2zdyu1yPkCUuTbqESba',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -74,7 +47,6 @@ export const NETWORKS: {
     factoryAddress: '0x925B24444511c86F4d4E63141D8Be0A025E2dca4',
     hmtAddress: '0x4dCf5ac4509888714dd43A5cCc46d7ab389D9c23',
     stakingAddress: '',
-    rewardPoolAddress: '',
     kvstoreAddress: '',
     subgraphUrl: '',
     subgraphUrlApiKey: '',
@@ -88,7 +60,6 @@ export const NETWORKS: {
     factoryAddress: '0x87469B4f2Fcf37cBd34E54244c0BD4Fa0603664c',
     hmtAddress: '0xd3A31D57FDD790725d0F6B78095F62E8CD4ab317',
     stakingAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
-    rewardPoolAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
     kvstoreAddress: '0x19Fc3e859C1813ac9427a7a78BeB9ae102CE96d3',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/goerli-v2',
@@ -101,15 +72,14 @@ export const NETWORKS: {
     chainId: ChainId.SEPOLIA,
     title: 'Ethereum Sepolia',
     scanUrl: 'https://sepolia.etherscan.io/',
-    factoryAddress: '0xD6D347ba6987519B4e42EcED43dF98eFf5465a23',
+    factoryAddress: '0x5987A5558d961ee674efe4A8c8eB7B1b5495D3bf',
     hmtAddress: '0x792abbcC99c01dbDec49c9fa9A828a186Da45C33',
-    stakingAddress: '0x2B9C5EC6220BA8Ad08CB51A60FFdbC6a6235B203',
-    rewardPoolAddress: '0xAFf5a986A530ff839d49325A5dF69F96627E8D29',
+    stakingAddress: '0x2163e3A40032Af1C359ac731deaB48258b317890',
     kvstoreAddress: '0xCc0AF0635aa19fE799B6aFDBe28fcFAeA7f00a60',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/sepolia/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmadNQBBzcfJHTmzLezZGbwvLux7HmnmfByBHubS2cmLUr',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmXVFVCLm2XxupxdKgnLRzvmkPJnpRbcoe4RNXoTqSRHsg',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -119,13 +89,12 @@ export const NETWORKS: {
     scanUrl: 'https://bscscan.com',
     factoryAddress: '0x92FD968AcBd521c232f5fB8c33b342923cC72714',
     hmtAddress: '0x711Fd6ab6d65A98904522d4e3586F492B989c527',
-    stakingAddress: '0xdFbB79dC35a3A53741be54a2C9b587d6BafAbd1C',
-    rewardPoolAddress: '0xf376443BCc6d4d4D63eeC086bc4A9E4a83878e0e',
+    stakingAddress: '0xE24e5C08E28331D24758b69A5E9f383D2bDD1c98',
     kvstoreAddress: '0x21A0C4CED7aE447fCf87D9FE3A29FA9B3AB20Ff1',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/bsc/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmXZ4QJMi8kyfXDEJwtdizyKf5JdJui89iYCLCE79N8Xf5',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmPMS6G5evLm5ZpbnmpCfUy8bHJPwzPkZTv9DgfNdFfrCM',
     oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
     oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
   },
@@ -135,13 +104,12 @@ export const NETWORKS: {
     scanUrl: 'https://testnet.bscscan.com',
     factoryAddress: '0x2bfA592DBDaF434DDcbb893B1916120d181DAD18',
     hmtAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
-    stakingAddress: '0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18',
-    rewardPoolAddress: '0xB0A0500103eCEc431b73F6BAd923F0a2774E6e29',
+    stakingAddress: '0xD6D347ba6987519B4e42EcED43dF98eFf5465a23',
     kvstoreAddress: '0x32e27177BA6Ea91cf28dfd91a0Da9822A4b74EcF',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/bsc-testnet/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/Qmdq449rn4WKDf7NLvRZgt7CedZRrvpDzPqcvSmhvuu16D',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmW6JqXvhDnhRVHU6ixKVSD65U1GKWUf3xwJo8E6mTBsAu',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest',
     oldFactoryAddress: '0xaae6a2646c1f88763e62e0cd08ad050ea66ac46f',
@@ -152,13 +120,12 @@ export const NETWORKS: {
     scanUrl: 'https://polygonscan.com',
     factoryAddress: '0xBDBfD2cC708199C5640C6ECdf3B0F4A4C67AdfcB',
     hmtAddress: '0xc748B2A084F8eFc47E086ccdDD9b7e67aEb571BF',
-    stakingAddress: '0xcbAd56bE3f504E98bd70875823d3CC0242B7bB29',
-    rewardPoolAddress: '0xa8e32d777a3839440cc7c24D591A64B9481753B3',
+    stakingAddress: '0x01D115E9E8bF0C58318793624CC662a030D07F1D',
     kvstoreAddress: '0xbcB28672F826a50B03EE91B28145EAbddA73B2eD',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/polygon/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmNdsofT4Cj2KRwr8vgyKgCWpZNmrMN41zUdygRz7eSGC9',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmTyCQMQd5QtogeTEuiqxnGQZa2PtgpUBsWLYwPCCFPbUe',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon',
     oldFactoryAddress: '0x45eBc3eAE6DA485097054ae10BA1A0f8e8c7f794',
@@ -170,7 +137,6 @@ export const NETWORKS: {
     factoryAddress: '0xA8D927C4DA17A6b71675d2D49dFda4E9eBE58f2d',
     hmtAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
     stakingAddress: '0x7Fd3dF914E7b6Bd96B4c744Df32183b51368Bfac',
-    rewardPoolAddress: '0xf0145eD99AC3c4f877aDa7dA4D1E059ec9116BAE',
     kvstoreAddress: '0xD96158c7267Ea658a4688F4aEf1c85659851625d',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mumbai-v2',
@@ -185,13 +151,12 @@ export const NETWORKS: {
     scanUrl: 'https://amoy.polygonscan.com/',
     factoryAddress: '0xAFf5a986A530ff839d49325A5dF69F96627E8D29',
     hmtAddress: '0x792abbcC99c01dbDec49c9fa9A828a186Da45C33',
-    stakingAddress: '0xCc0AF0635aa19fE799B6aFDBe28fcFAeA7f00a60',
-    rewardPoolAddress: '0xd866bCEFf6D0F77E1c3EAE28230AE6C79b03fDa7',
+    stakingAddress: '0xffE496683F842a923110415b7278ded3F265f2C5',
     kvstoreAddress: '0x724AeFC243EdacCA27EAB86D3ec5a76Af4436Fc7',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/amoy/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/Qmbwio5UnvDn5GQRJ5kLJfK27fqHK9nkEh4YXXYKWCc9rH',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmawobiPUYsGNK9chtb5PvicUtaa8Jsjpwvv8dNyMVXQ9r',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -202,7 +167,6 @@ export const NETWORKS: {
     factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
     hmtAddress: '0x3b25BC1dC591D24d60560d0135D6750A561D4764',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
-    rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0x2B95bEcb6EBC4589f64CB000dFCF716b4aeF8aA6',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/moonbeam/version/latest',
@@ -218,13 +182,12 @@ export const NETWORKS: {
     scanUrl: 'https://moonbase.moonscan.io/',
     factoryAddress: '0x5e622FF522D81aa426f082bDD95210BC25fCA7Ed',
     hmtAddress: '0x2dd72db2bBA65cE663e476bA8b84A1aAF802A8e3',
-    stakingAddress: '0xBFC7009F3371F93F3B54DdC8caCd02914a37495c',
-    rewardPoolAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
+    stakingAddress: '0xbA537fEF2442cD48f60686FE1Bbbe40F964a7940',
     kvstoreAddress: '0xcC561f4482f4Ff051D2Dcc65c2cE1A0f291bbA46',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/moonbase-alpha/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmeC4JrotcrXWJtJU519RX3KkxE5879wveRJJ58EheH3j1',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmSDPbm5xxMvYVSJzHFVsRiMekvJVYSJ7UfZw17DhPMdaH',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -234,13 +197,12 @@ export const NETWORKS: {
     scanUrl: 'https://testnet.snowtrace.io',
     factoryAddress: '0x56C2ba540726ED4f46E7a134b6b9Ee9C867FcF92',
     hmtAddress: '0x9406d5c635AD22b0d76c75E52De57A2177919ca3',
-    stakingAddress: '0x9890473B0b93E24d6D1a8Dfb739D577C6f25FFd3',
-    rewardPoolAddress: '0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18',
+    stakingAddress: '0xbA537fEF2442cD48f60686FE1Bbbe40F964a7940',
     kvstoreAddress: '0x3aD4B091E054f192a822D1406f4535eAd38580e4',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/fuji/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmcFhecY6w3AhKGSg8XeidXwwuXCV9DAQ5SYGE1sTzydgR',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmYXwNPwC5DcitK1SLVUR6gPANmEn3UsVvGeTbjCv1tTb2',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/fuji',
     oldFactoryAddress: '0xfb4469201951C3B9a7F1996c477cb7BDBEcE0A88',
@@ -252,7 +214,6 @@ export const NETWORKS: {
     factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
     hmtAddress: '0x12365293cb6477d4fc2686e46BB97E3Fb64f1550',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
-    rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0x9Bc7bff35B2Be2413708d48c3B0aEF5c43646728',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/avalanche/version/latest',
@@ -269,7 +230,6 @@ export const NETWORKS: {
     factoryAddress: '0x86Af9f6Cd34B69Db1B202223C6d6D109f2491569',
     hmtAddress: '0x2736B33455A872dC478E1E004106D04c35472468',
     stakingAddress: '0x003548Df34be8836cF0F9673403a1E40ba449a0F',
-    rewardPoolAddress: '0xA9545C2530BD5bdb464d5E274F59ACceAa73eD86',
     kvstoreAddress: '0x938335006ea6F9Eb0e8020969cFF94404425e298',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/celo-alfajores/version/latest',
@@ -285,7 +245,6 @@ export const NETWORKS: {
     factoryAddress: '0xc90B43a5d576D9d8026c48904dfbaED50C15Fa08',
     hmtAddress: '0x19Ead835951493A763c96910255d5eeF147E914F',
     stakingAddress: '0x34cD3Bd6B16c559f321799b516dE61E12017fFd1',
-    rewardPoolAddress: '0xb9344bAD98E3d26a4d83900922baf395a2Ec154c',
     kvstoreAddress: '0x86Af9f6Cd34B69Db1B202223C6d6D109f2491569',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/celo/version/latest',
@@ -301,7 +260,6 @@ export const NETWORKS: {
     factoryAddress: '0x4949C9DFFD83F0D5Ab0AB24C57C4D403D5c20C15',
     hmtAddress: '0x10acbe3b9e6a2ff7f341e5cbf4b6617741ff44aa',
     stakingAddress: '0x01D115E9E8bF0C58318793624CC662a030D07F1D',
-    rewardPoolAddress: '0x7ABa5F75b2b530cB0c8927C86591c21dF44f06b6',
     kvstoreAddress: '0x6512d894cc3d3FE93Da9d0420430136fA889FaB9',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/xlayer/version/latest',
@@ -316,13 +274,12 @@ export const NETWORKS: {
     scanUrl: 'https://www.okx.com/explorer/xlayer-test',
     factoryAddress: '0x6Cd3ecAD36ee88E9ef3665CF381D9dAE0FE0a32e',
     hmtAddress: '0x792abbcC99c01dbDec49c9fa9A828a186Da45C33',
-    stakingAddress: '0x819069fEd50581587fAB9E583b5488fc2D33B7ea',
-    rewardPoolAddress: '0x6daccd1f3a68945f8a7ac6d20260953f7a97fae4',
+    stakingAddress: '0xeF9849a904dF0d494D69ac0B0a6860a3A7936114',
     kvstoreAddress: '0xdE8BE9E3C12E9F546309A429cd88d026a25EaF8C',
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/xlayer-testnet/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-testnet-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmQrTmq89ZCdVABsFpLHtQUWuyyVzbcARoan9eztHd21oP',
+      'https://gateway-testnet-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmNoRyqZtJTRrkbKAmWMZQUHuah7YSs8U9R3nzPu8WEhtY',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -330,11 +287,10 @@ export const NETWORKS: {
     chainId: ChainId.LOCALHOST,
     title: 'Localhost',
     scanUrl: '',
-    factoryAddress: '0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9',
+    factoryAddress: '0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9',
     hmtAddress: '0x5FbDB2315678afecb367f032d93F642f64180aa3',
-    stakingAddress: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
-    rewardPoolAddress: '0xa513E6E4b8f2a923D98304ec87F64353C4D5C853',
-    kvstoreAddress: '0x5FC8d32690cc91D4c39d9d3abcBD16989F875707',
+    stakingAddress: '0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512',
+    kvstoreAddress: '0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9',
     subgraphUrl: 'http://localhost:8000/subgraphs/name/humanprotocol/localhost',
     subgraphUrlApiKey: '',
     oldSubgraphUrl: '',
@@ -347,6 +303,7 @@ export const KVStoreKeys = {
   fee: 'fee',
   publicKey: 'public_key',
   webhookUrl: 'webhook_url',
+  website: 'website',
   url: 'url',
   jobTypes: 'job_types',
   registrationNeeded: 'registration_needed',
@@ -361,3 +318,5 @@ export const Role = {
 };
 
 export const SUBGRAPH_API_KEY_PLACEHOLDER = '[SUBGRAPH_API_KEY]';
+
+export const ESCROW_BULK_PAYOUT_MAX_ITEMS = 99;