@human-protocol/sdk 1.1.5 → 1.1.7

package/dist/escrow.d.ts

@@ -1,18 +1,28 @@
-import { BigNumber } from 'ethers';
-import { IClientParams, IEscrowConfig, IEscrowsFilter, ILauncherEscrowsResult } from './interfaces';
+import { Provider } from '@ethersproject/abstract-provider';
+import { BigNumber, Signer } from 'ethers';
+import { IEscrowConfig, IEscrowsFilter } from './interfaces';
 import { EscrowStatus, NetworkData } from './types';
-export default class EscrowClient {
-    readonly clientParams: IClientParams;
+export declare class EscrowClient {
     private escrowFactoryContract;
     private escrowContract?;
     private signerOrProvider;
     network: NetworkData;
     /**
-     * **Escrow constructor**
+     * **EscrowClient constructor**
      *
-     *   * @param {IClientParams} clientParams - Init client parameters
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {NetworkData} network - The network information required to connect to the Escrow contract
      */
-    constructor(clientParams: IClientParams);
+    constructor(signerOrProvider: Signer | Provider, network: NetworkData);
+    /**
+     * Creates an instance of EscrowClient from a Signer or Provider.
+     *
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @returns {Promise<EscrowClient>} - An instance of EscrowClient
+     * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
+     * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
+     */
+    static build(signerOrProvider: Signer | Provider): Promise<EscrowClient>;
     /**
      * Creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
      *
@@ -131,6 +141,14 @@ export default class EscrowClient {
      * @throws {Error} - An error object if an error occurred.
      */
     getResultsUrl(escrowAddress: string): Promise<string>;
+    /**
+     * Returns the intermediate results file URL.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getIntermediateResultsUrl(escrowAddress: string): Promise<string>;
     /**
      * Returns the value for a specified key and address
      *
@@ -148,22 +166,21 @@ export default class EscrowClient {
      */
     getStatus(escrowAddress: string): Promise<EscrowStatus>;
     /**
-     * Returns the current status of the escrow.
+     * Returns the escrow addresses created by a job requester.
      *
      * @param {IEscrowsFilter} requesterAddress - Address of the requester.
-     * @returns {Promise<void>}
+     * @returns {Promise<string[]>}
      * @throws {Error} - An error object if an error occurred.
      */
-    getLaunchedEscrows(requesterAddress: string): Promise<ILauncherEscrowsResult[]>;
+    getLaunchedEscrows(requesterAddress: string): Promise<string[]>;
     /**
-     * Returns the escrows addresses created by a job requester.
+     * Returns the escrow addresses based on a specified filter.
      *
-     * @param {string} escrowAddress - Address of the escrow.
-     * @param {IEscrowsFilter} filer - Filter parameters.
-     * @returns {Promise<void>}
+     * @param {IEscrowsFilter} filter - Filter parameters.
+     * @returns {Promise<string[]>}
      * @throws {Error} - An error object if an error occurred.
      */
-    getEscrowsFiltered(escrowAddress: string, filter: IEscrowsFilter): Promise<ILauncherEscrowsResult[]>;
+    getEscrowsFiltered(filter: IEscrowsFilter): Promise<string[]>;
     /**
      * Returns the recording oracle address of given escrow
      *
@@ -172,6 +189,14 @@ export default class EscrowClient {
      * @throws {Error} - An error object if an error occurred.
      */
     getRecordingOracleAddress(escrowAddress: string): Promise<string>;
+    /**
+     * Returns the job launcher address of given escrow
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<string>} - Address of the job launcher.
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getJobLauncherAddress(escrowAddress: string): Promise<string>;
     /**
      * Returns the reputation oracle address of given escrow
      *
@@ -180,5 +205,13 @@ export default class EscrowClient {
      * @throws {Error} - An error object if an error occurred.
      */
     getReputationOracleAddress(escrowAddress: string): Promise<string>;
+    /**
+     * Returns the escrow factory address of given escrow
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<string>} - Address of the escrow factory.
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getFactoryAddress(escrowAddress: string): Promise<string>;
 }
 //# sourceMappingURL=escrow.d.ts.map

package/dist/escrow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAmC,MAAM,QAAQ,CAAC;AAsBpE,OAAO,EACL,aAAa,EACb,aAAa,EACb,cAAc,EACd,sBAAsB,EACvB,MAAM,cAAc,CAAC;AAOtB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGpD,MAAM,CAAC,OAAO,OAAO,YAAY;IAWnB,QAAQ,CAAC,YAAY,EAAE,aAAa;IAVhD,OAAO,CAAC,qBAAqB,CAAgB;IAC7C,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,gBAAgB,CAAoB;IACrC,OAAO,EAAE,WAAW,CAAC;IAE5B;;;;OAIG;gBACkB,YAAY,EAAE,aAAa;IAUhD;;;;;;;OAOG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,MAAM,CAAC;IAiClB;;;;;;;OAOG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC;IAkEhB;;;;;;;;;OASG;IAEG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,MAAM,CAAC;IAelB;;;;;;;OAOG;IAEG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCnE;;;;;;;;;OASG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;;OAMG;IAEG,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBpD;;;;;;;;;;OAUG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,SAAS,EAAE,EACpB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAqEhB;;;;;;OAMG;IAEG,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBlD;;;;;;OAMG;IAEG,KAAK,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjD;;;;;;;OAOG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;OAMG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAoB3D;;;;;;OAMG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB5D;;;;;;OAMG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB3D;;;;;;OAMG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB7D;;;;;;OAMG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB7D;;;;;;OAMG;IACG,kBAAkB,CACtB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAoBpC;;;;;;;OAOG;IACG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,sBAAsB,EAAE,CAAC;IA2BpC;;;;;;OAMG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBvE;;;;;;OAMG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAmBzE"}
+{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAU5D,OAAO,EAAE,SAAS,EAAmB,MAAM,EAAU,MAAM,QAAQ,CAAC;AA0BpE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAK7D,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGpD,qBAAa,YAAY;IACvB,OAAO,CAAC,qBAAqB,CAAgB;IAC7C,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,gBAAgB,CAAoB;IACrC,OAAO,EAAE,WAAW,CAAC;IAE5B;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EAAE,OAAO,EAAE,WAAW;IASrE;;;;;;;OAOG;WACiB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ;IAsB7D;;;;;;;OAOG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,MAAM,CAAC;IAiClB;;;;;;;OAOG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC;IAkEhB;;;;;;;;;OASG;IAEG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,MAAM,CAAC;IAelB;;;;;;;OAOG;IAEG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCnE;;;;;;;;;OASG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;;OAMG;IAEG,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBpD;;;;;;;;;;OAUG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,SAAS,EAAE,EACpB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAqEhB;;;;;;OAMG;IAEG,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBlD;;;;;;OAMG;IAEG,KAAK,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjD;;;;;;;OAOG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;OAMG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAoB3D;;;;;;OAMG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB5D;;;;;;OAMG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB3D;;;;;;OAMG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBvE;;;;;;OAMG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB7D;;;;;;OAMG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB7D;;;;;;OAMG;IACG,kBAAkB,CAAC,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAiBrE;;;;;;OAMG;IACG,kBAAkB,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAsBnE;;;;;;OAMG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBvE;;;;;;OAMG;IACG,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBnE;;;;;;OAMG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBxE;;;;;;OAMG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAmBhE"}

package/dist/escrow.js

@@ -9,25 +9,51 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/no-explicit-any */
+exports.EscrowClient = void 0;
 const typechain_types_1 = require("@human-protocol/core/typechain-types");
 const ethers_1 = require("ethers");
-const error_1 = require("./error");
-const utils_1 = require("./utils");
 const constants_1 = require("./constants");
-const queries_1 = require("./queries");
 const decorators_1 = require("./decorators");
+const error_1 = require("./error");
+const queries_1 = require("./queries");
+const utils_1 = require("./utils");
 class EscrowClient {
     /**
-     * **Escrow constructor**
+     * **EscrowClient constructor**
+     *
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {NetworkData} network - The network information required to connect to the Escrow contract
+     */
+    constructor(signerOrProvider, network) {
+        this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(network.factoryAddress, signerOrProvider);
+        this.network = network;
+        this.signerOrProvider = signerOrProvider;
+    }
+    /**
+     * Creates an instance of EscrowClient from a Signer or Provider.
      *
-     *   * @param {IClientParams} clientParams - Init client parameters
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @returns {Promise<EscrowClient>} - An instance of EscrowClient
+     * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
+     * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
      */
-    constructor(clientParams) {
-        this.clientParams = clientParams;
-        this.network = clientParams.network;
-        this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(clientParams.network.factoryAddress, clientParams.signerOrProvider);
-        this.signerOrProvider = clientParams.signerOrProvider;
+    static async build(signerOrProvider) {
+        let network;
+        if (ethers_1.Signer.isSigner(signerOrProvider)) {
+            if (!signerOrProvider.provider) {
+                throw error_1.ErrorProviderDoesNotExist;
+            }
+            network = await signerOrProvider.provider.getNetwork();
+        }
+        else {
+            network = await signerOrProvider.getNetwork();
+        }
+        const chainId = network.chainId;
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        return new EscrowClient(signerOrProvider, networkData);
     }
     /**
      * Creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
@@ -67,7 +93,7 @@ class EscrowClient {
      * @throws {Error} - An error object if an error occurred.
      */
     async setup(escrowAddress, escrowConfig) {
-        const { recordingOracle, reputationOracle, recordingOracleFee, reputationOracleFee, manifestUrl, hash, } = escrowConfig;
+        const { recordingOracle, reputationOracle, recordingOracleFee, reputationOracleFee, manifestUrl, manifestHash, } = escrowConfig;
         if (!ethers_1.ethers.utils.isAddress(recordingOracle)) {
             throw error_1.ErrorInvalidRecordingOracleAddressProvided;
         }
@@ -89,7 +115,7 @@ class EscrowClient {
         if (!(0, utils_1.isValidUrl)(manifestUrl)) {
             throw error_1.ErrorInvalidUrl;
         }
-        if (!hash) {
+        if (!manifestHash) {
             throw error_1.ErrorHashIsEmptyString;
         }
         if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
@@ -97,7 +123,7 @@ class EscrowClient {
         }
         try {
             this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
-            await this.escrowContract.setup(recordingOracle, reputationOracle, recordingOracleFee, reputationOracleFee, manifestUrl, hash);
+            await this.escrowContract.setup(reputationOracle, recordingOracle, reputationOracleFee, recordingOracleFee, manifestUrl, manifestHash);
             return;
         }
         catch (e) {
@@ -413,6 +439,28 @@ class EscrowClient {
             return (0, utils_1.throwError)(e);
         }
     }
+    /**
+     * Returns the intermediate results file URL.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    async getIntermediateResultsUrl(escrowAddress) {
+        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
+            throw error_1.ErrorInvalidEscrowAddressProvided;
+        }
+        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
+            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
+        }
+        try {
+            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
+            return this.escrowContract.intermediateResultsUrl();
+        }
+        catch (e) {
+            return (0, utils_1.throwError)(e);
+        }
+    }
     /**
      * Returns the value for a specified key and address
      *
@@ -458,10 +506,10 @@ class EscrowClient {
         }
     }
     /**
-     * Returns the current status of the escrow.
+     * Returns the escrow addresses created by a job requester.
      *
      * @param {IEscrowsFilter} requesterAddress - Address of the requester.
-     * @returns {Promise<void>}
+     * @returns {Promise<string[]>}
      * @throws {Error} - An error object if an error occurred.
      */
     async getLaunchedEscrows(requesterAddress) {
@@ -469,38 +517,27 @@ class EscrowClient {
             throw error_1.ErrorInvalidAddress;
         }
         try {
-            const { data } = await (0, utils_1.gqlFetch)(this.network.subgraphUrl, (0, queries_1.RAW_LAUNCHED_ESCROWS_QUERY)(), {
-                address: requesterAddress,
-            });
-            return data;
+            const { data } = await (0, utils_1.gqlFetch)(this.network.subgraphUrl, (0, queries_1.RAW_LAUNCHED_ESCROWS_QUERY)(requesterAddress));
+            return data.data.launchedEscrows.map((escrow) => escrow.id);
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
         }
     }
     /**
-     * Returns the escrows addresses created by a job requester.
+     * Returns the escrow addresses based on a specified filter.
      *
-     * @param {string} escrowAddress - Address of the escrow.
-     * @param {IEscrowsFilter} filer - Filter parameters.
-     * @returns {Promise<void>}
+     * @param {IEscrowsFilter} filter - Filter parameters.
+     * @returns {Promise<string[]>}
      * @throws {Error} - An error object if an error occurred.
      */
-    async getEscrowsFiltered(escrowAddress, filter) {
-        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
+    async getEscrowsFiltered(filter) {
+        if (filter?.address && !ethers_1.ethers.utils.isAddress(filter?.address)) {
             throw error_1.ErrorInvalidAddress;
         }
-        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
-            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
-        }
         try {
-            const { data } = await (0, utils_1.gqlFetch)(this.network.subgraphUrl, (0, queries_1.RAW_LAUNCHED_ESCROWS_FILTERED_QUERY)(), {
-                address: filter.address,
-                status: filter.status,
-                from: filter.from,
-                tro: filter.to,
-            });
-            return data;
+            const { data } = await (0, utils_1.gqlFetch)(this.network.subgraphUrl, (0, queries_1.RAW_LAUNCHED_ESCROWS_FILTERED_QUERY)(filter.address, filter.status, filter.from, filter.to));
+            return data.data.launchedEscrows.map((escrow) => escrow.id);
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -528,6 +565,28 @@ class EscrowClient {
             return (0, utils_1.throwError)(e);
         }
     }
+    /**
+     * Returns the job launcher address of given escrow
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<string>} - Address of the job launcher.
+     * @throws {Error} - An error object if an error occurred.
+     */
+    async getJobLauncherAddress(escrowAddress) {
+        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
+            throw error_1.ErrorInvalidEscrowAddressProvided;
+        }
+        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
+            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
+        }
+        try {
+            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
+            return this.escrowContract.launcher();
+        }
+        catch (e) {
+            return (0, utils_1.throwError)(e);
+        }
+    }
     /**
      * Returns the reputation oracle address of given escrow
      *
@@ -550,6 +609,28 @@ class EscrowClient {
             return (0, utils_1.throwError)(e);
         }
     }
+    /**
+     * Returns the escrow factory address of given escrow
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<string>} - Address of the escrow factory.
+     * @throws {Error} - An error object if an error occurred.
+     */
+    async getFactoryAddress(escrowAddress) {
+        if (!ethers_1.ethers.utils.isAddress(escrowAddress)) {
+            throw error_1.ErrorInvalidEscrowAddressProvided;
+        }
+        if (!(await this.escrowFactoryContract.hasEscrow(escrowAddress))) {
+            throw error_1.ErrorEscrowAddressIsNotProvidedByFactory;
+        }
+        try {
+            this.escrowContract = typechain_types_1.Escrow__factory.connect(escrowAddress, this.signerOrProvider);
+            return this.escrowContract.escrowFactory();
+        }
+        catch (e) {
+            return (0, utils_1.throwError)(e);
+        }
+    }
 }
 __decorate([
     decorators_1.requiresSigner,
@@ -611,4 +692,4 @@ __decorate([
     __metadata("design:paramtypes", [String, Array]),
     __metadata("design:returntype", Promise)
 ], EscrowClient.prototype, "addTrustedHandlers", null);
-exports.default = EscrowClient;
+exports.EscrowClient = EscrowClient;

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import InitClient from './init';
-import StakingClient from './staking';
-import StorageClient from './storage';
-import KVStoreClient from './kvstore';
-import EscrowClient from './escrow';
+import { StakingClient } from './staking';
+import { StorageClient } from './storage';
+import { KVStoreClient } from './kvstore';
+import { EscrowClient } from './escrow';
 export * from './constants';
 export * from './types';
 export * from './enums';
-export { InitClient, StakingClient, StorageClient, KVStoreClient, EscrowClient, };
+export * from './interfaces';
+export { StakingClient, StorageClient, KVStoreClient, EscrowClient };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,QAAQ,CAAC;AAChC,OAAO,aAAa,MAAM,WAAW,CAAC;AACtC,OAAO,aAAa,MAAM,WAAW,CAAC;AACtC,OAAO,aAAa,MAAM,WAAW,CAAC;AACtC,OAAO,YAAY,MAAM,UAAU,CAAC;AAEpC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAExB,OAAO,EACL,UAAU,EACV,aAAa,EACb,aAAa,EACb,aAAa,EACb,YAAY,GACb,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAE7B,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC"}

package/dist/index.js

@@ -13,21 +13,17 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EscrowClient = exports.KVStoreClient = exports.StorageClient = exports.StakingClient = exports.InitClient = void 0;
-const init_1 = __importDefault(require("./init"));
-exports.InitClient = init_1.default;
-const staking_1 = __importDefault(require("./staking"));
-exports.StakingClient = staking_1.default;
-const storage_1 = __importDefault(require("./storage"));
-exports.StorageClient = storage_1.default;
-const kvstore_1 = __importDefault(require("./kvstore"));
-exports.KVStoreClient = kvstore_1.default;
-const escrow_1 = __importDefault(require("./escrow"));
-exports.EscrowClient = escrow_1.default;
+exports.EscrowClient = exports.KVStoreClient = exports.StorageClient = exports.StakingClient = void 0;
+const staking_1 = require("./staking");
+Object.defineProperty(exports, "StakingClient", { enumerable: true, get: function () { return staking_1.StakingClient; } });
+const storage_1 = require("./storage");
+Object.defineProperty(exports, "StorageClient", { enumerable: true, get: function () { return storage_1.StorageClient; } });
+const kvstore_1 = require("./kvstore");
+Object.defineProperty(exports, "KVStoreClient", { enumerable: true, get: function () { return kvstore_1.KVStoreClient; } });
+const escrow_1 = require("./escrow");
+Object.defineProperty(exports, "EscrowClient", { enumerable: true, get: function () { return escrow_1.EscrowClient; } });
 __exportStar(require("./constants"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./enums"), exports);
+__exportStar(require("./interfaces"), exports);

package/dist/interfaces.d.ts

@@ -1,10 +1,5 @@
-import { BigNumber, Signer } from 'ethers';
-import { Provider } from '@ethersproject/abstract-provider';
-import { NetworkData } from './types';
-export interface IClientParams {
-    signerOrProvider: Signer | Provider;
-    network: NetworkData;
-}
+import { BigNumber } from 'ethers';
+import { EscrowStatus } from './types';
 export interface IAllocation {
     escrowAddress: string;
     staker: string;
@@ -17,6 +12,7 @@ export interface IReward {
     amount: BigNumber;
 }
 export interface IStaker {
+    staker: string;
     tokensStaked: BigNumber;
     tokensAllocated: BigNumber;
     tokensLocked: BigNumber;
@@ -24,9 +20,9 @@ export interface IStaker {
     tokensAvailable: BigNumber;
 }
 export interface IEscrowsFilter {
-    address: string;
+    address?: string;
     role?: number;
-    status?: number;
+    status?: EscrowStatus;
     from?: Date;
     to?: Date;
 }
@@ -36,9 +32,12 @@ export interface IEscrowConfig {
     recordingOracleFee: BigNumber;
     reputationOracleFee: BigNumber;
     manifestUrl: string;
-    hash: string;
+    manifestHash: string;
 }
-export interface ILauncherEscrowsResult {
-    id: string;
+export interface IKeyPair {
+    privateKey: string;
+    publicKey: string;
+    passphrase: string;
+    revocationCertificate?: string;
 }
 //# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IACpC,OAAO,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,YAAY,EAAE,SAAS,CAAC;IACxB,eAAe,EAAE,SAAS,CAAC;IAC3B,YAAY,EAAE,SAAS,CAAC;IACxB,iBAAiB,EAAE,SAAS,CAAC;IAC7B,eAAe,EAAE,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,mBAAmB,EAAE,SAAS,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;CACZ"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,SAAS,CAAC;IACxB,eAAe,EAAE,SAAS,CAAC;IAC3B,YAAY,EAAE,SAAS,CAAC;IACxB,iBAAiB,EAAE,SAAS,CAAC;IAC7B,eAAe,EAAE,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,mBAAmB,EAAE,SAAS,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC"}

package/dist/kvstore.d.ts

@@ -1,14 +1,25 @@
-import { IClientParams } from './interfaces';
-export default class KVStoreClient {
-    readonly clientParams: IClientParams;
+import { Provider } from '@ethersproject/abstract-provider';
+import { Signer } from 'ethers';
+import { NetworkData } from './types';
+export declare class KVStoreClient {
     private contract;
     private signerOrProvider;
     /**
-     * **KVStore constructor**
+     * **KVStoreClient constructor**
      *
-     *   * @param {IClientParams} clientParams - Init client parameters
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {NetworkData} network - The network information required to connect to the KVStore contract
      */
-    constructor(clientParams: IClientParams);
+    constructor(signerOrProvider: Signer | Provider, network: NetworkData);
+    /**
+     * Creates an instance of KVStoreClient from a Signer or Provider.
+     *
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @returns {Promise<KVStoreClient>} - An instance of KVStoreClient
+     * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
+     * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
+     */
+    static build(signerOrProvider: Signer | Provider): Promise<KVStoreClient>;
     /**
      * Sets a key-value pair in the contract
      *
@@ -32,9 +43,9 @@ export default class KVStoreClient {
      *
      * @param {string} address - The Ethereum address associated with the key-value pair
      * @param {string} key - The key of the key-value pair to get
-     * @returns {string} - The value of the key-value pair if it exists
+     * @returns {Promise<string>} - The value of the key-value pair if it exists
      * @throws {Error} - An error object if an error occurred
      */
-    get(address: string, key: string): Promise<string | undefined>;
+    get(address: string, key: string): Promise<string>;
 }
 //# sourceMappingURL=kvstore.d.ts.map

package/dist/kvstore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,MAAM,CAAC,OAAO,OAAO,aAAa;IASpB,QAAQ,CAAC,YAAY,EAAE,aAAa;IARhD,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,gBAAgB,CAAoB;IAE5C;;;;OAIG;gBACkB,YAAY,EAAE,aAAa;IAQhD;;;;;;;OAOG;IAEU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAU3C;;;;;;;OAOG;IAEU,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;IAarD;;;;;;;OAOG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;CAW9C"}
+{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAM5D,OAAO,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAYxC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,gBAAgB,CAAoB;IAE5C;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EAAE,OAAO,EAAE,WAAW;IAQrE;;;;;;;OAOG;WACiB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ;IAsB7D;;;;;;;OAOG;IAEU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3D;;;;;;;OAOG;IAEU,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAarE;;;;;;;OAOG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYhE"}

package/dist/kvstore.js

@@ -9,20 +9,48 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.KVStoreClient = void 0;
 const typechain_types_1 = require("@human-protocol/core/typechain-types");
 const ethers_1 = require("ethers");
-const error_1 = require("./error");
+const constants_1 = require("./constants");
 const decorators_1 = require("./decorators");
+const error_1 = require("./error");
 class KVStoreClient {
     /**
-     * **KVStore constructor**
+     * **KVStoreClient constructor**
      *
-     *   * @param {IClientParams} clientParams - Init client parameters
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {NetworkData} network - The network information required to connect to the KVStore contract
      */
-    constructor(clientParams) {
-        this.clientParams = clientParams;
-        this.contract = typechain_types_1.KVStore__factory.connect(clientParams.network.kvstoreAddress, clientParams.signerOrProvider);
-        this.signerOrProvider = clientParams.signerOrProvider;
+    constructor(signerOrProvider, network) {
+        this.contract = typechain_types_1.KVStore__factory.connect(network.factoryAddress, signerOrProvider);
+        this.signerOrProvider = signerOrProvider;
+    }
+    /**
+     * Creates an instance of KVStoreClient from a Signer or Provider.
+     *
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @returns {Promise<KVStoreClient>} - An instance of KVStoreClient
+     * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
+     * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
+     */
+    static async build(signerOrProvider) {
+        let network;
+        if (ethers_1.Signer.isSigner(signerOrProvider)) {
+            if (!signerOrProvider.provider) {
+                throw error_1.ErrorProviderDoesNotExist;
+            }
+            network = await signerOrProvider.provider.getNetwork();
+        }
+        else {
+            network = await signerOrProvider.getNetwork();
+        }
+        const chainId = network.chainId;
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        return new KVStoreClient(signerOrProvider, networkData);
     }
     /**
      * Sets a key-value pair in the contract
@@ -73,7 +101,7 @@ class KVStoreClient {
      *
      * @param {string} address - The Ethereum address associated with the key-value pair
      * @param {string} key - The key of the key-value pair to get
-     * @returns {string} - The value of the key-value pair if it exists
+     * @returns {Promise<string>} - The value of the key-value pair if it exists
      * @throws {Error} - An error object if an error occurred
      */
     async get(address, key) {
@@ -88,6 +116,7 @@ class KVStoreClient {
         catch (e) {
             if (e instanceof Error)
                 throw Error(`Failed to get value: ${e.message}`);
+            return e;
         }
     }
 }
@@ -103,4 +132,4 @@ __decorate([
     __metadata("design:paramtypes", [Array, Array]),
     __metadata("design:returntype", Promise)
 ], KVStoreClient.prototype, "setBulk", null);
-exports.default = KVStoreClient;
+exports.KVStoreClient = KVStoreClient;

package/dist/queries.d.ts

@@ -1,4 +1,5 @@
+import { EscrowStatus } from './types';
 export declare const RAW_REWARDS_QUERY: (slasherAddress: string) => string;
-export declare const RAW_LAUNCHED_ESCROWS_QUERY: () => string;
-export declare const RAW_LAUNCHED_ESCROWS_FILTERED_QUERY: () => string;
+export declare const RAW_LAUNCHED_ESCROWS_QUERY: (requesterAddress: string) => string;
+export declare const RAW_LAUNCHED_ESCROWS_FILTERED_QUERY: (address?: string, status?: EscrowStatus, from?: Date, to?: Date) => string;
 //# sourceMappingURL=queries.d.ts.map

package/dist/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,mBAAoB,MAAM,WAKpD,CAAC;AAEL,eAAO,MAAM,0BAA0B,cAInC,CAAC;AAEL,eAAO,MAAM,mCAAmC,cAI5C,CAAC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,eAAO,MAAM,iBAAiB,mBAAoB,MAAM,WAKpD,CAAC;AAEL,eAAO,MAAM,0BAA0B,qBAAsB,MAAM,WAI/D,CAAC;AAEL,eAAO,MAAM,mCAAmC,aACpC,MAAM,WACP,YAAY,SACd,IAAI,OACN,IAAI,WAMG,CAAC"}