@human-protocol/sdk 1.1.19 → 2.1.0

package/dist/interfaces.d.ts

@@ -1,36 +1,46 @@
-import { BigNumber } from 'ethers';
 import { EscrowStatus } from './types';
 import { ChainId } from './enums';
 export interface IAllocation {
     escrowAddress: string;
     staker: string;
-    tokens: BigNumber;
-    createdAt: BigNumber;
-    closedAt: BigNumber;
+    tokens: bigint;
+    createdAt: bigint;
+    closedAt: bigint;
 }
 export interface IReward {
     escrowAddress: string;
-    amount: BigNumber;
+    amount: bigint;
 }
 export interface ILeader {
     id: string;
+    chainId: ChainId;
     address: string;
-    amountStaked: BigNumber;
-    amountAllocated: BigNumber;
-    amountLocked: BigNumber;
-    lockedUntilTimestamp: BigNumber;
-    amountWithdrawn: BigNumber;
-    amountSlashed: BigNumber;
-    reputation: BigNumber;
-    reward: BigNumber;
-    amountJobsLaunched: BigNumber;
+    amountStaked: bigint;
+    amountAllocated: bigint;
+    amountLocked: bigint;
+    lockedUntilTimestamp: bigint;
+    amountWithdrawn: bigint;
+    amountSlashed: bigint;
+    reputation: bigint;
+    reward: bigint;
+    amountJobsLaunched: bigint;
     role?: string;
-    fee?: BigNumber;
+    fee?: bigint;
     publicKey?: string;
     webhookUrl?: string;
     url?: string;
 }
 export interface ILeadersFilter {
+    networks: ChainId[];
+    role?: string;
+}
+export interface IReputationNetwork {
+    id: string;
+    address: string;
+    operators: IOperator[];
+}
+export interface IOperator {
+    address: string;
     role?: string;
 }
 export interface IEscrowsFilter {
@@ -48,9 +58,9 @@ export interface IEscrowConfig {
     recordingOracle: string;
     reputationOracle: string;
     exchangeOracle: string;
-    recordingOracleFee: BigNumber;
-    reputationOracleFee: BigNumber;
-    exchangeOracleFee: BigNumber;
+    recordingOracleFee: bigint;
+    reputationOracleFee: bigint;
+    exchangeOracleFee: bigint;
     manifestUrl: string;
     manifestHash: string;
 }

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,QAAQ,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,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,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,SAAS,CAAC;IACxB,eAAe,EAAE,SAAS,CAAC;IAC3B,YAAY,EAAE,SAAS,CAAC;IACxB,oBAAoB,EAAE,SAAS,CAAC;IAChC,eAAe,EAAE,SAAS,CAAC;IAC3B,aAAa,EAAE,SAAS,CAAC;IACzB,UAAU,EAAE,SAAS,CAAC;IACtB,MAAM,EAAE,SAAS,CAAC;IAClB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,mBAAmB,EAAE,SAAS,CAAC;IAC/B,iBAAiB,EAAE,SAAS,CAAC;IAC7B,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;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,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;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX"}

package/dist/kvstore.d.ts

@@ -1,5 +1,4 @@
-import { Provider } from '@ethersproject/abstract-provider';
-import { Overrides, Signer } from 'ethers';
+import { ContractRunner, Overrides } from 'ethers';
 import { BaseEthersClient } from './base';
 import { NetworkData } from './types';
 /**
@@ -7,11 +6,11 @@ import { NetworkData } from './types';
  *
  * This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.
  *
- * Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
+ * Internally, the SDK will use one network or another according to the network ID of the `runner`.
  * To use this client, it is recommended to initialize it using the static `build` method.
  *
  * ```ts
- * static async build(signerOrProvider: Signer | Provider);
+ * static async build(runner: ContractRunner);
  * ```
  *
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
@@ -76,20 +75,20 @@ export declare class KVStoreClient extends BaseEthersClient {
     /**
      * **KVStoreClient constructor**
      *
-     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {ContractRunner} runner - The Runner object to interact with the Ethereum network
      * @param {NetworkData} network - The network information required to connect to the KVStore contract
      */
-    constructor(signerOrProvider: Signer | Provider, networkData: NetworkData);
+    constructor(runner: ContractRunner, networkData: NetworkData);
     /**
-     * Creates an instance of KVStoreClient from a Signer or Provider.
+     * Creates an instance of KVStoreClient from a runner.
      *
-     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {ContractRunner} runner - The Runner 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>;
+    static build(runner: ContractRunner): Promise<KVStoreClient>;
     /**
      * This function sets a key-value pair associated with the address that submits the transaction.
      *
@@ -142,14 +141,14 @@ export declare class KVStoreClient extends BaseEthersClient {
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
-     * const keys = ['role', 'webhookUrl'];
+     * const keys = ['role', 'webhook_url'];
      * const values = ['RecordingOracle', 'http://localhost'];
      * await kvstoreClient.set(keys, values);
      * ```
      */
     setBulk(keys: string[], values: string[], txOptions?: Overrides): Promise<void>;
     /**
-     * This function sets a URL value for the address that submits the transaction.
+     * Sets a URL value for the address that submits the transaction, and its hash.
      *
      * @param {string} url URL to set
      * @param {string | undefined} urlKey Configurable URL key. `url` by default.
@@ -170,13 +169,13 @@ export declare class KVStoreClient extends BaseEthersClient {
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
-     * await kvstoreClient.setURL('example.com');
-     * await kvstoreClient.setURL('linkedin.com/example', 'linkedinUrl);
+     * await kvstoreClient.setFileUrlAndHash('example.com');
+     * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
      * ```
      */
-    setURL(url: string, urlKey?: string, txOptions?: Overrides): Promise<void>;
+    setFileUrlAndHash(url: string, urlKey?: string, txOptions?: Overrides): Promise<void>;
     /**
-     * This function returns the value for a specified key and address.
+     * Gets the value of a key-value pair in the contract.
      *
      * @param {string} address Address from which to get the key value.
      * @param {string} key Key to obtain the value.
@@ -201,7 +200,7 @@ export declare class KVStoreClient extends BaseEthersClient {
      */
     get(address: string, key: string): Promise<string>;
     /**
-     * This function returns the URL value for the given entity.
+     * Gets the URL value of the given entity, and verify its hash.
      *
      * @param {string} address Address from which to get the URL value.
      * @param {string} urlKey  Configurable URL key. `url` by default.
@@ -219,13 +218,35 @@ export declare class KVStoreClient extends BaseEthersClient {
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const kvstoreClient = await KVStoreClient.build(provider);
      *
-     * const url = await kvstoreClient.getURL('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
-     * const linkedinUrl = await kvstoreClient.getURL(
+     * const url = await kvstoreClient.getFileUrlAndVerifyHash('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * const linkedinUrl = await kvstoreClient.getFileUrlAndVerifyHash(
      *    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
-     *    'linkedinUrl'
+     *    'linkedin_url'
      * );
      * ```
      */
-    getURL(address: string, urlKey?: string): Promise<string>;
+    getFileUrlAndVerifyHash(address: string, urlKey?: string): Promise<string>;
+    /**
+     * Gets the public key of the given entity, and verify its hash.
+     *
+     * @param {string} address Address from which to get the public key.
+     * @returns {string} Public key for the given address if exists, and the content is valid
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { providers } from 'ethers';
+     * import { KVStoreClient } from '@human-protocol/sdk';
+     *
+     * const rpcUrl = 'YOUR_RPC_URL';
+     *
+     * const provider = new providers.JsonRpcProvider(rpcUrl);
+     * const kvstoreClient = await KVStoreClient.build(provider);
+     *
+     * const publicKey = await kvstoreClient.getPublicKey('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * ```
+     */
+    getPublicKey(address: 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":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAM5D,OAAO,EAAE,SAAS,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAc1C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EAAE,WAAW,EAAE,WAAW;IASzE;;;;;;;;OAQG;WACiB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ;IAsB7D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,GAAG,CACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAUhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IAEU,OAAO,CAClB,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,MAAM,EAAE,EAChB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,MAAM,CACjB,GAAG,EAAE,MAAM,EACX,MAAM,SAAQ,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA8BhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;CAmCtE"}
+{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAU,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAa1C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc;IAiBhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,GAAG,CACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IAEU,OAAO,CAClB,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,MAAM,EAAE,EAChB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,iBAAiB,CAC5B,GAAG,EAAE,MAAM,EACX,MAAM,SAAQ,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,MAAM,SAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAkClB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAc5D"}

package/dist/kvstore.js

@@ -22,11 +22,11 @@ const utils_1 = require("./utils");
  *
  * This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.
  *
- * Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
+ * Internally, the SDK will use one network or another according to the network ID of the `runner`.
  * To use this client, it is recommended to initialize it using the static `build` method.
  *
  * ```ts
- * static async build(signerOrProvider: Signer | Provider);
+ * static async build(runner: ContractRunner);
  * ```
  *
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
@@ -90,39 +90,33 @@ class KVStoreClient extends base_1.BaseEthersClient {
     /**
      * **KVStoreClient constructor**
      *
-     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {ContractRunner} runner - The Runner object to interact with the Ethereum network
      * @param {NetworkData} network - The network information required to connect to the KVStore contract
      */
-    constructor(signerOrProvider, networkData) {
-        super(signerOrProvider, networkData);
-        this.contract = typechain_types_1.KVStore__factory.connect(networkData.kvstoreAddress, signerOrProvider);
+    constructor(runner, networkData) {
+        super(runner, networkData);
+        this.contract = typechain_types_1.KVStore__factory.connect(networkData.kvstoreAddress, runner);
     }
     /**
-     * Creates an instance of KVStoreClient from a Signer or Provider.
+     * Creates an instance of KVStoreClient from a runner.
      *
-     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {ContractRunner} runner - The Runner 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();
+    static async build(runner) {
+        if (!runner.provider) {
+            throw error_1.ErrorProviderDoesNotExist;
         }
-        else {
-            network = await signerOrProvider.getNetwork();
-        }
-        const chainId = network.chainId;
+        const network = await runner.provider?.getNetwork();
+        const chainId = Number(network?.chainId);
         const networkData = constants_1.NETWORKS[chainId];
         if (!networkData) {
             throw error_1.ErrorUnsupportedChainID;
         }
-        return new KVStoreClient(signerOrProvider, networkData);
+        return new KVStoreClient(runner, networkData);
     }
     /**
      * This function sets a key-value pair associated with the address that submits the transaction.
@@ -152,8 +146,6 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * ```
      */
     async set(key, value, txOptions = {}) {
-        if (!ethers_1.Signer.isSigner(this.signerOrProvider))
-            throw error_1.ErrorSigner;
         if (key === '')
             throw error_1.ErrorKVStoreEmptyKey;
         try {
@@ -188,14 +180,12 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
-     * const keys = ['role', 'webhookUrl'];
+     * const keys = ['role', 'webhook_url'];
      * const values = ['RecordingOracle', 'http://localhost'];
      * await kvstoreClient.set(keys, values);
      * ```
      */
     async setBulk(keys, values, txOptions = {}) {
-        if (!ethers_1.Signer.isSigner(this.signerOrProvider))
-            throw error_1.ErrorSigner;
         if (keys.length !== values.length)
             throw error_1.ErrorKVStoreArrayLength;
         if (keys.includes(''))
@@ -209,7 +199,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function sets a URL value for the address that submits the transaction.
+     * Sets a URL value for the address that submits the transaction, and its hash.
      *
      * @param {string} url URL to set
      * @param {string | undefined} urlKey Configurable URL key. `url` by default.
@@ -230,20 +220,17 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
-     * await kvstoreClient.setURL('example.com');
-     * await kvstoreClient.setURL('linkedin.com/example', 'linkedinUrl);
+     * await kvstoreClient.setFileUrlAndHash('example.com');
+     * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
      * ```
      */
-    async setURL(url, urlKey = 'url', txOptions = {}) {
-        if (!ethers_1.Signer.isSigner(this.signerOrProvider)) {
-            throw error_1.ErrorSigner;
-        }
+    async setFileUrlAndHash(url, urlKey = 'url', txOptions = {}) {
         if (!(0, utils_1.isValidUrl)(url)) {
             throw error_1.ErrorInvalidUrl;
         }
         const content = await fetch(url).then((res) => res.text());
-        const contentHash = ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.toUtf8Bytes(content));
-        const hashKey = urlKey + 'Hash';
+        const contentHash = ethers_1.ethers.keccak256(ethers_1.ethers.toUtf8Bytes(content));
+        const hashKey = urlKey + '_hash';
         try {
             await (await this.contract.setBulk([urlKey, hashKey], [url, contentHash], txOptions)).wait();
         }
@@ -253,7 +240,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function returns the value for a specified key and address.
+     * Gets the value of a key-value pair in the contract.
      *
      * @param {string} address Address from which to get the key value.
      * @param {string} key Key to obtain the value.
@@ -279,7 +266,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
     async get(address, key) {
         if (key === '')
             throw error_1.ErrorKVStoreEmptyKey;
-        if (!ethers_1.ethers.utils.isAddress(address))
+        if (!ethers_1.ethers.isAddress(address))
             throw error_1.ErrorInvalidAddress;
         try {
             const result = await this.contract?.get(address, key);
@@ -292,7 +279,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
         }
     }
     /**
-     * This function returns the URL value for the given entity.
+     * Gets the URL value of the given entity, and verify its hash.
      *
      * @param {string} address Address from which to get the URL value.
      * @param {string} urlKey  Configurable URL key. `url` by default.
@@ -310,17 +297,17 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const kvstoreClient = await KVStoreClient.build(provider);
      *
-     * const url = await kvstoreClient.getURL('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
-     * const linkedinUrl = await kvstoreClient.getURL(
+     * const url = await kvstoreClient.getFileUrlAndVerifyHash('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * const linkedinUrl = await kvstoreClient.getFileUrlAndVerifyHash(
      *    '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
-     *    'linkedinUrl'
+     *    'linkedin_url'
      * );
      * ```
      */
-    async getURL(address, urlKey = 'url') {
-        if (!ethers_1.ethers.utils.isAddress(address))
+    async getFileUrlAndVerifyHash(address, urlKey = 'url') {
+        if (!ethers_1.ethers.isAddress(address))
             throw error_1.ErrorInvalidAddress;
-        const hashKey = urlKey + 'Hash';
+        const hashKey = urlKey + '_hash';
         let url = '', hash = '';
         try {
             url = await this.contract?.get(address, urlKey);
@@ -341,12 +328,41 @@ class KVStoreClient extends base_1.BaseEthersClient {
                 throw Error(`Failed to get Hash: ${e.message}`);
         }
         const content = await fetch(url).then((res) => res.text());
-        const contentHash = ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.toUtf8Bytes(content));
+        const contentHash = ethers_1.ethers.keccak256(ethers_1.ethers.toUtf8Bytes(content));
         if (hash !== contentHash) {
             throw error_1.ErrorInvalidHash;
         }
         return url;
     }
+    /**
+     * Gets the public key of the given entity, and verify its hash.
+     *
+     * @param {string} address Address from which to get the public key.
+     * @returns {string} Public key for the given address if exists, and the content is valid
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { providers } from 'ethers';
+     * import { KVStoreClient } from '@human-protocol/sdk';
+     *
+     * const rpcUrl = 'YOUR_RPC_URL';
+     *
+     * const provider = new providers.JsonRpcProvider(rpcUrl);
+     * const kvstoreClient = await KVStoreClient.build(provider);
+     *
+     * const publicKey = await kvstoreClient.getPublicKey('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266');
+     * ```
+     */
+    async getPublicKey(address) {
+        const publicKeyUrl = await this.getFileUrlAndVerifyHash(address, constants_1.KVStoreKeys.publicKey);
+        if (publicKeyUrl === '') {
+            return '';
+        }
+        const publicKey = await fetch(publicKeyUrl).then((res) => res.text());
+        return publicKey;
+    }
 }
 __decorate([
     decorators_1.requiresSigner,
@@ -365,5 +381,5 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String, Object, Object]),
     __metadata("design:returntype", Promise)
-], KVStoreClient.prototype, "setURL", null);
+], KVStoreClient.prototype, "setFileUrlAndHash", null);
 exports.KVStoreClient = KVStoreClient;

package/dist/operator.d.ts

@@ -0,0 +1,68 @@
+import { ILeader, ILeadersFilter, IOperator, IReward } from './interfaces';
+import { ChainId } from './enums';
+export declare class OperatorUtils {
+    /**
+     * This function returns the leader data for the given address.
+     *
+     * @param {string} address Leader address.
+     * @returns {ILeader} Returns the leader details.
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const leader = await OperatorUtils.getLeader(ChainId.POLYGON_MUMBAI, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * ```
+     */
+    static getLeader(chainId: ChainId, address: string): Promise<ILeader>;
+    /**
+     * This function returns all the leader details of the protocol.
+     *
+     * @param {ILeadersFilter} filter Filter for the leaders.
+     * @returns {ILeader[]} Returns an array with all the leader details.
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { OperatorUtils } from '@human-protocol/sdk';
+     *
+     * const leaders = await OperatorUtils.getLeaders();
+     * ```
+     */
+    static getLeaders(filter?: ILeadersFilter): Promise<ILeader[]>;
+    /**
+     * Retrieves the reputation network operators of the specified address.
+     *
+     * @param {string} address - Address of the reputation oracle.
+     * @param {string} [role] - (Optional) Role of the operator.
+     * @returns {Promise<IOperator[]>} - Returns an array of operator details.
+     *
+     * @example
+     * ```typescript
+     * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const operators = await OperatorUtils.getReputationNetworkOperators(ChainId.POLYGON_MUMBAI, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * ```
+     */
+    static getReputationNetworkOperators(chainId: ChainId, address: string, role?: string): Promise<IOperator[]>;
+    /**
+     * This function returns information about the rewards for a given slasher address.
+     *
+     * @param {string} slasherAddress Slasher address.
+     * @returns {IReward[]} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
+     *
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const rewards = await OperatorUtils.getRewards(ChainId.POLYGON_MUMBAI, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * ```
+     */
+    static getRewards(chainId: ChainId, slasherAddress: string): Promise<IReward[]>;
+}
+//# sourceMappingURL=operator.d.ts.map

package/dist/operator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EACP,cAAc,EACd,SAAS,EAET,OAAO,EACR,MAAM,cAAc,CAAC;AAetB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,qBAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IAuBnB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,MAAM,GAAE,cAAuD,GAC9D,OAAO,CAAC,OAAO,EAAE,CAAC;IAuBrB;;;;;;;;;;;;;OAaG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IAoBvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CA2BtB"}