@human-protocol/sdk 3.0.8 → 4.0.0

package/dist/graphql/queries/operator.js

@@ -29,20 +29,28 @@ const LEADER_FRAGMENT = (0, graphql_tag_1.default) `
   }
 `;
 const GET_LEADERS_QUERY = (filter) => {
-    const { role } = filter;
+    const { roles, minAmountStaked } = filter;
     const WHERE_CLAUSE = `
     where: {
-      ${role ? `role: $role` : ''}
+      ${minAmountStaked ? `amountStaked_gte: $minAmountStaked` : ''}
+      ${roles ? `role_in: $roles` : ''}
     }
   `;
     return (0, graphql_tag_1.default) `
     query getLeaders(
-      $role: String
+      $minAmountStaked: Int,
+      $roles: [String!]
+      $first: Int
+      $skip: Int
+      $orderBy: String
+      $orderDirection: String
     ) {
       leaders(
         ${WHERE_CLAUSE}
-        orderBy: amountStaked,
-        orderDirection: desc,
+        first: $first
+        skip: $skip
+        orderBy: $orderBy
+        orderDirection: $orderDirection
       ) {
         ...LeaderFields
       }

package/dist/interfaces.d.ts

@@ -32,9 +32,11 @@ export interface ILeaderSubgraph extends Omit<ILeader, 'jobTypes' | 'reputationN
         address: string;
     }[];
 }
-export interface ILeadersFilter {
+export interface ILeadersFilter extends IPagination {
     chainId: ChainId;
-    role?: string;
+    roles?: string[];
+    minAmountStaked?: number;
+    orderBy?: string;
 }
 export interface IReputationNetwork {
     id: string;
@@ -135,4 +137,10 @@ export interface IPagination {
     skip?: number;
     orderDirection?: OrderDirection;
 }
+export interface StakerInfo {
+    stakedAmount: bigint;
+    lockedAmount: bigint;
+    lockedUntil: bigint;
+    withdrawableAmount: bigint;
+}
 //# 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,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAElD,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,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,oBAAoB,GAAG,SAAS,CAAC;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,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,0BACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAC7C,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,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,OAAO,EAAE,OAAO,CAAC;CAClB;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,iBAAkB,SAAQ,WAAW;IACpD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;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;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC"}
+{"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,cAAc,EAAE,MAAM,SAAS,CAAC;AAElD,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,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,oBAAoB,GAAG,SAAS,CAAC;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,0BACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAC7C,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC;IACpE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,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,OAAO,EAAE,OAAO,CAAC;CAClB;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,iBAAkB,SAAQ,WAAW;IACpD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;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;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}

package/dist/kvstore.d.ts

@@ -6,19 +6,19 @@ import { IKVStore } from './interfaces';
 /**
  * ## Introduction
  *
- * This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.
+ * This client enables performing actions on KVStore contract and obtaining information from both the contracts and subgraph.
  *
  * 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(runner: ContractRunner);
+ * static async build(runner: ContractRunner): Promise<KVStoreClient>;
  * ```
  *
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
  *
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
+ * - **Signer**: when the user wants to use this model to send transactions calling the contract functions.
+ * - **Provider**: when the user wants to use this model to get information from the contracts or subgraph.
  *
  * ## Installation
  *
@@ -36,21 +36,21 @@ import { IKVStore } from './interfaces';
  *
  * ### Signer
  *
- * **Using private key(backend)**
+ * **Using private key (backend)**
  *
  * ```ts
  * import { KVStoreClient } from '@human-protocol/sdk';
  * import { Wallet, providers } from 'ethers';
  *
  * const rpcUrl = 'YOUR_RPC_URL';
- * const privateKey = 'YOUR_PRIVATE_KEY'
+ * const privateKey = 'YOUR_PRIVATE_KEY';
  *
  * const provider = new providers.JsonRpcProvider(rpcUrl);
  * const signer = new Wallet(privateKey, provider);
  * const kvstoreClient = await KVStoreClient.build(signer);
  * ```
  *
- * **Using Wagmi(frontend)**
+ * **Using Wagmi (frontend)**
  *
  * ```ts
  * import { useSigner, useChainId } from 'wagmi';
@@ -69,7 +69,7 @@ import { IKVStore } from './interfaces';
  * const rpcUrl = 'YOUR_RPC_URL';
  *
  * const provider = new providers.JsonRpcProvider(rpcUrl);
- * const kvstoreClient = await KVStoreClient.build(signer);
+ * const kvstoreClient = await KVStoreClient.build(provider);
  * ```
  */
 export declare class KVStoreClient extends BaseEthersClient {
@@ -109,7 +109,7 @@ export declare class KVStoreClient extends BaseEthersClient {
      * import { KVStoreClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -137,7 +137,7 @@ export declare class KVStoreClient extends BaseEthersClient {
      * import { KVStoreClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -145,7 +145,7 @@ export declare class KVStoreClient extends BaseEthersClient {
      *
      * const keys = ['role', 'webhook_url'];
      * const values = ['RecordingOracle', 'http://localhost'];
-     * await kvstoreClient.set(keys, values);
+     * await kvstoreClient.setBulk(keys, values);
      * ```
      */
     setBulk(keys: string[], values: string[], txOptions?: Overrides): Promise<void>;
@@ -165,14 +165,14 @@ export declare class KVStoreClient extends BaseEthersClient {
      * import { KVStoreClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
      * await kvstoreClient.setFileUrlAndHash('example.com');
-     * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
+     * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url');
      * ```
      */
     setFileUrlAndHash(url: string, urlKey?: string, txOptions?: Overrides): Promise<void>;
@@ -203,9 +203,9 @@ export declare class KVStoreClient extends BaseEthersClient {
  * ```ts
  * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
  *
- * const KVStoreAddresses = new KVStoreUtils.getKVStoreData({
+ * const KVStoreAddresses = await KVStoreUtils.getKVStoreData(
  *   ChainId.POLYGON_AMOY,
- *   "0x1234567890123456789012345678901234567890",
+ *   "0x1234567890123456789012345678901234567890"
  * );
  * ```
  */

package/dist/kvstore.d.ts.map

@@ -1 +1 @@
-{"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;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAYlC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAOtC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAEH,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;CAuBjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,YAAY;IACvB;;;;;;;;;;;;;;;;;OAiBG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,QAAQ,EAAE,CAAC;IAyBtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,GAAG,CACrB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC;IAuBlB;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,uBAAuB,CACzC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,SAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;OAkBG;WACiB,YAAY,CAC9B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;CAenB"}
+{"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;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAYlC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAOtC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAEH,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,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBzE;;;;;;;;;;;;;;;;;;;;;;;;;;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;CAuBjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAAa,YAAY;IACvB;;;;;;;;;;;;;;;;;OAiBG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,QAAQ,EAAE,CAAC;IAyBtB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACiB,GAAG,CACrB,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC;IAuBlB;;;;;;;;;;;;;;;;;;;OAmBG;WACiB,uBAAuB,CACzC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,SAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;OAkBG;WACiB,YAAY,CAC9B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;CAenB"}

package/dist/kvstore.js

@@ -25,19 +25,19 @@ const kvstore_1 = require("./graphql/queries/kvstore");
 /**
  * ## Introduction
  *
- * This client enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph.
+ * This client enables performing actions on KVStore contract and obtaining information from both the contracts and subgraph.
  *
  * 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(runner: ContractRunner);
+ * static async build(runner: ContractRunner): Promise<KVStoreClient>;
  * ```
  *
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
  *
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
+ * - **Signer**: when the user wants to use this model to send transactions calling the contract functions.
+ * - **Provider**: when the user wants to use this model to get information from the contracts or subgraph.
  *
  * ## Installation
  *
@@ -55,21 +55,21 @@ const kvstore_1 = require("./graphql/queries/kvstore");
  *
  * ### Signer
  *
- * **Using private key(backend)**
+ * **Using private key (backend)**
  *
  * ```ts
  * import { KVStoreClient } from '@human-protocol/sdk';
  * import { Wallet, providers } from 'ethers';
  *
  * const rpcUrl = 'YOUR_RPC_URL';
- * const privateKey = 'YOUR_PRIVATE_KEY'
+ * const privateKey = 'YOUR_PRIVATE_KEY';
  *
  * const provider = new providers.JsonRpcProvider(rpcUrl);
  * const signer = new Wallet(privateKey, provider);
  * const kvstoreClient = await KVStoreClient.build(signer);
  * ```
  *
- * **Using Wagmi(frontend)**
+ * **Using Wagmi (frontend)**
  *
  * ```ts
  * import { useSigner, useChainId } from 'wagmi';
@@ -88,7 +88,7 @@ const kvstore_1 = require("./graphql/queries/kvstore");
  * const rpcUrl = 'YOUR_RPC_URL';
  *
  * const provider = new providers.JsonRpcProvider(rpcUrl);
- * const kvstoreClient = await KVStoreClient.build(signer);
+ * const kvstoreClient = await KVStoreClient.build(provider);
  * ```
  */
 class KVStoreClient extends base_1.BaseEthersClient {
@@ -141,7 +141,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * import { KVStoreClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -179,7 +179,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * import { KVStoreClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -187,7 +187,7 @@ class KVStoreClient extends base_1.BaseEthersClient {
      *
      * const keys = ['role', 'webhook_url'];
      * const values = ['RecordingOracle', 'http://localhost'];
-     * await kvstoreClient.set(keys, values);
+     * await kvstoreClient.setBulk(keys, values);
      * ```
      */
     async setBulk(keys, values, txOptions = {}) {
@@ -219,14 +219,14 @@ class KVStoreClient extends base_1.BaseEthersClient {
      * import { KVStoreClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
      * const kvstoreClient = await KVStoreClient.build(signer);
      *
      * await kvstoreClient.setFileUrlAndHash('example.com');
-     * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url);
+     * await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url');
      * ```
      */
     async setFileUrlAndHash(url, urlKey = 'url', txOptions = {}) {
@@ -290,9 +290,9 @@ __decorate([
  * ```ts
  * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
  *
- * const KVStoreAddresses = new KVStoreUtils.getKVStoreData({
+ * const KVStoreAddresses = await KVStoreUtils.getKVStoreData(
  *   ChainId.POLYGON_AMOY,
- *   "0x1234567890123456789012345678901234567890",
+ *   "0x1234567890123456789012345678901234567890"
  * );
  * ```
  */

package/dist/operator.d.ts

@@ -4,9 +4,9 @@ export declare class OperatorUtils {
     /**
      * This function returns the leader data for the given address.
      *
+     * @param {ChainId} chainId Network in which the leader is deployed
      * @param {string} address Leader address.
-     * @returns {ILeader} Returns the leader details.
-     *
+     * @returns {Promise<ILeader>} Returns the leader details.
      *
      * **Code example**
      *
@@ -21,13 +21,12 @@ export declare class OperatorUtils {
      * 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.
-     *
+     * @returns {Promise<ILeader[]>} Returns an array with all the leader details.
      *
      * **Code example**
      *
      * ```ts
-     * import { OperatorUtils } from '@human-protocol/sdk';
+     * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
      *
      * const filter: ILeadersFilter = {
      *  chainId: ChainId.POLYGON
@@ -39,12 +38,14 @@ export declare class OperatorUtils {
     /**
      * Retrieves the reputation network operators of the specified address.
      *
-     * @param {string} address - Address of the reputation oracle.
+     * @param {ChainId} chainId Network in which the reputation network is deployed
+     * @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
+     * **Code example**
+     *
+     * ```ts
      * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
      *
      * const operators = await OperatorUtils.getReputationNetworkOperators(ChainId.POLYGON_AMOY, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
@@ -54,9 +55,9 @@ export declare class OperatorUtils {
     /**
      * This function returns information about the rewards for a given slasher address.
      *
+     * @param {ChainId} chainId Network in which the rewards are deployed
      * @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.
-     *
+     * @returns {Promise<IReward[]>} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
      *
      * **Code example**
      *

package/dist/operator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EAEP,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;IA2CnB;;;;;;;;;;;;;;;;;OAiBG;WACiB,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAkD1E;;;;;;;;;;;;;OAaG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IA+BvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CAyBtB"}
+{"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EAEP,cAAc,EACd,SAAS,EAET,OAAO,EACR,MAAM,cAAc,CAAC;AAetB,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAGlD,qBAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IA2CnB;;;;;;;;;;;;;;;;OAgBG;WACiB,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IA+D1E;;;;;;;;;;;;;;;OAeG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IA+BvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CAyBtB"}

package/dist/operator.js

@@ -11,14 +11,15 @@ const operator_1 = require("./graphql/queries/operator");
 const ethers_1 = require("ethers");
 const error_1 = require("./error");
 const utils_1 = require("./utils");
+const enums_1 = require("./enums");
 const constants_1 = require("./constants");
 class OperatorUtils {
     /**
      * This function returns the leader data for the given address.
      *
+     * @param {ChainId} chainId Network in which the leader is deployed
      * @param {string} address Leader address.
-     * @returns {ILeader} Returns the leader details.
-     *
+     * @returns {Promise<ILeader>} Returns the leader details.
      *
      * **Code example**
      *
@@ -64,13 +65,12 @@ class OperatorUtils {
      * 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.
-     *
+     * @returns {Promise<ILeader[]>} Returns an array with all the leader details.
      *
      * **Code example**
      *
      * ```ts
-     * import { OperatorUtils } from '@human-protocol/sdk';
+     * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
      *
      * const filter: ILeadersFilter = {
      *  chainId: ChainId.POLYGON
@@ -80,12 +80,22 @@ class OperatorUtils {
      */
     static async getLeaders(filter) {
         let leaders_data = [];
+        const first = filter.first !== undefined && filter.first > 0
+            ? Math.min(filter.first, 1000)
+            : 10;
+        const skip = filter.skip !== undefined && filter.skip >= 0 ? filter.skip : 0;
+        const orderDirection = filter.orderDirection || enums_1.OrderDirection.DESC;
         const networkData = constants_1.NETWORKS[filter.chainId];
         if (!networkData) {
             throw error_1.ErrorUnsupportedChainID;
         }
         const { leaders } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, operator_1.GET_LEADERS_QUERY)(filter), {
-            role: filter?.role,
+            minAmountStaked: filter?.minAmountStaked,
+            roles: filter?.roles,
+            orderBy: filter?.orderBy,
+            orderDirection: orderDirection,
+            first: first,
+            skip: skip,
         });
         if (!leaders) {
             return [];
@@ -115,12 +125,14 @@ class OperatorUtils {
     /**
      * Retrieves the reputation network operators of the specified address.
      *
-     * @param {string} address - Address of the reputation oracle.
+     * @param {ChainId} chainId Network in which the reputation network is deployed
+     * @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
+     * **Code example**
+     *
+     * ```ts
      * import { OperatorUtils, ChainId } from '@human-protocol/sdk';
      *
      * const operators = await OperatorUtils.getReputationNetworkOperators(ChainId.POLYGON_AMOY, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
@@ -154,9 +166,9 @@ class OperatorUtils {
     /**
      * This function returns information about the rewards for a given slasher address.
      *
+     * @param {ChainId} chainId Network in which the rewards are deployed
      * @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.
-     *
+     * @returns {Promise<IReward[]>} Returns an array of Reward objects that contain the rewards earned by the user through slashing other users.
      *
      * **Code example**
      *

package/dist/staking.d.ts

@@ -2,22 +2,23 @@ import { EscrowFactory, HMToken, Staking } from '@human-protocol/core/typechain-
 import { ContractRunner, Overrides } from 'ethers';
 import { BaseEthersClient } from './base';
 import { NetworkData } from './types';
+import { StakerInfo } from './interfaces';
 /**
  * ## Introduction
  *
- * This client enables to perform actions on staking contracts and obtain staking information from both the contracts and subgraph.
+ * This client enables performing actions on staking contracts and obtaining staking information from both the contracts and subgraph.
  *
  * 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(runner: ContractRunner);
+ * static async build(runner: ContractRunner): Promise<StakingClient>;
  * ```
  *
  * A `Signer` or a `Provider` should be passed depending on the use case of this module:
  *
- * - **Signer**: when the user wants to use this model in order to send transactions caling the contract functions.
- * - **Provider**: when the user wants to use this model in order to get information from the contracts or subgraph.
+ * - **Signer**: when the user wants to use this model to send transactions calling the contract functions.
+ * - **Provider**: when the user wants to use this model to get information from the contracts or subgraph.
  *
  * ## Installation
  *
@@ -35,21 +36,21 @@ import { NetworkData } from './types';
  *
  * ### Signer
  *
- * **Using private key(backend)**
+ * **Using private key (backend)**
  *
  * ```ts
  * import { StakingClient } from '@human-protocol/sdk';
  * import { Wallet, providers } from 'ethers';
  *
  * const rpcUrl = 'YOUR_RPC_URL';
- * const privateKey = 'YOUR_PRIVATE_KEY'
+ * const privateKey = 'YOUR_PRIVATE_KEY';
  *
  * const provider = new providers.JsonRpcProvider(rpcUrl);
  * const signer = new Wallet(privateKey, provider);
  * const stakingClient = await StakingClient.build(signer);
  * ```
  *
- * **Using Wagmi(frontend)**
+ * **Using Wagmi (frontend)**
  *
  * ```ts
  * import { useSigner, useChainId } from 'wagmi';
@@ -105,7 +106,6 @@ export declare class StakingClient extends BaseEthersClient {
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -113,7 +113,7 @@ export declare class StakingClient extends BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -133,7 +133,6 @@ export declare class StakingClient extends BaseEthersClient {
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -141,7 +140,7 @@ export declare class StakingClient extends BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -149,7 +148,7 @@ export declare class StakingClient extends BaseEthersClient {
      *
      * const amount = ethers.parseUnits(5, 'ether'); //convert from ETH to WEI
      * await stakingClient.approveStake(amount); // if it was already approved before, this is not necessary
-     * await stakingClient.approveStake(amount);
+     * await stakingClient.stake(amount);
      * ```
      */
     stake(amount: bigint, txOptions?: Overrides): Promise<void>;
@@ -162,7 +161,6 @@ export declare class StakingClient extends BaseEthersClient {
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -170,7 +168,7 @@ export declare class StakingClient extends BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -182,14 +180,13 @@ export declare class StakingClient extends BaseEthersClient {
      */
     unstake(amount: bigint, txOptions?: Overrides): Promise<void>;
     /**
-     * This function withdraws unstaked and non locked tokens form staking contract to the user wallet.
+     * This function withdraws unstaked and non-locked tokens from staking contract to the user wallet.
      *
      * > Must have tokens available to withdraw
      *
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -197,7 +194,7 @@ export declare class StakingClient extends BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -208,16 +205,15 @@ export declare class StakingClient extends BaseEthersClient {
      */
     withdraw(txOptions?: Overrides): Promise<void>;
     /**
-     * This function reduces the allocated amount by an staker in an escrow and transfers those tokens to the reward pool. This allows the slasher to claim them later.
+     * This function reduces the allocated amount by a staker in an escrow and transfers those tokens to the reward pool. This allows the slasher to claim them later.
      *
      * @param {string} slasher Wallet address from who requested the slash
      * @param {string} staker Wallet address from who is going to be slashed
      * @param {string} escrowAddress Address of the escrow that the slash is made
+     * @param {bigint} amount Amount in WEI of tokens to slash.
      * @param {Overrides} [txOptions] - Additional transaction parameters (optional, defaults to an empty object).
-     * @param {bigint} amount Amount in WEI of tokens to unstake.
      * @returns Returns void if successful. Throws error if any.
      *
-     *
      * **Code example**
      *
      * ```ts
@@ -225,7 +221,7 @@ export declare class StakingClient extends BaseEthersClient {
      * import { StakingClient } from '@human-protocol/sdk';
      *
      * const rpcUrl = 'YOUR_RPC_URL';
-     * const privateKey = 'YOUR_PRIVATE_KEY'
+     * const privateKey = 'YOUR_PRIVATE_KEY';
      *
      * const provider = new providers.JsonRpcProvider(rpcUrl);
      * const signer = new Wallet(privateKey, provider);
@@ -236,5 +232,26 @@ export declare class StakingClient extends BaseEthersClient {
      * ```
      */
     slash(slasher: string, staker: string, escrowAddress: string, amount: bigint, txOptions?: Overrides): Promise<void>;
+    /**
+     * Retrieves comprehensive staking information for a staker.
+     *
+     * @param {string} stakerAddress - The address of the staker.
+     * @returns {Promise<StakerInfo>}
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { StakingClient } from '@human-protocol/sdk';
+     *
+     * const rpcUrl = 'YOUR_RPC_URL';
+     *
+     * const provider = new providers.JsonRpcProvider(rpcUrl);
+     * const stakingClient = await StakingClient.build(provider);
+     *
+     * const stakingInfo = await stakingClient.getStakerInfo('0xYourStakerAddress');
+     * console.log(stakingInfo.tokensStaked);
+     * ```
+     */
+    getStakerInfo(stakerAddress: string): Promise<StakerInfo>;
 }
 //# sourceMappingURL=staking.d.ts.map