@human-protocol/sdk 1.1.13 → 1.1.15

package/src/kvstore.ts

@@ -18,6 +18,75 @@ import {
 } from './error';
 import { NetworkData } from './types';
 
+/**
+ * ## Introduction
+ *
+ * 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`.
+ * To use this client, it is recommended to initialize it using the static `build` method.
+ *
+ * ```ts
+ * static async build(signerOrProvider: Signer | Provider);
+ * ```
+ *
+ * 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.
+ *
+ * ## Installation
+ *
+ * ### npm
+ * ```bash
+ * npm install @human-protocol/sdk
+ * ```
+ *
+ * ### yarn
+ * ```bash
+ * yarn install @human-protocol/sdk
+ * ```
+ *
+ * ## Code example
+ *
+ * ### Signer
+ *
+ * **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 provider = new providers.JsonRpcProvider(rpcUrl);
+ * const signer = new Wallet(privateKey, provider);
+ * const kvstoreClient = await KVStoreClient.build(signer);
+ * ```
+ *
+ * **Using Wagmi(frontend)**
+ *
+ * ```ts
+ * import { useSigner, useChainId } from 'wagmi';
+ * import { KVStoreClient } from '@human-protocol/sdk';
+ *
+ * const { data: signer } = useSigner();
+ * const kvstoreClient = await KVStoreClient.build(signer);
+ * ```
+ *
+ * ### Provider
+ *
+ * ```ts
+ * import { KVStoreClient } from '@human-protocol/sdk';
+ * import { providers } from 'ethers';
+ *
+ * const rpcUrl = 'YOUR_RPC_URL';
+ *
+ * const provider = new providers.JsonRpcProvider(rpcUrl);
+ * const kvstoreClient = await KVStoreClient.build(signer);
+ * ```
+ */
 export class KVStoreClient {
   private contract: KVStore;
   private signerOrProvider: Signer | Provider;
@@ -67,12 +136,30 @@ export class KVStoreClient {
   }
 
   /**
-   * Sets a key-value pair in the contract
+   * This function sets a key-value pair associated with the address that submits the transaction.
    *
-   * @param {string} key - The key of the key-value pair to set
-   * @param {string} value - The value of the key-value pair to set
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred
+   * @param {string} key Key of the key-value pair
+   * @param {string} value Value of the key-value pair
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
+   *
+   * > Need to have available stake.
+   *
+   * ```ts
+   * import { Wallet, providers } from 'ethers';
+   * import { KVStoreClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * 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.set('Role', 'RecordingOracle');
+   * ```
    */
   @requiresSigner
   public async set(key: string, value: string): Promise<void> {
@@ -86,12 +173,32 @@ export class KVStoreClient {
   }
 
   /**
-   * Sets multiple key-value pairs in the contract
+   * This function sets key-value pairs in bulk associated with the address that submits the transaction.
+   *
+   * @param {string[]} keys Array of keys (keys and value must have the same order)
+   * @param {string[]} values Array of values
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
+   *
+   * > Need to have available stake.
    *
-   * @param {string[]} keys - An array of keys to set
-   * @param {string[]} values - An array of values to set
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred
+   * ```ts
+   * import { Wallet, providers } from 'ethers';
+   * import { KVStoreClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const kvstoreClient = await KVStoreClient.build(signer);
+   *
+   * const keys = ['Role', 'Webhook_url'];
+   * const values = ['RecordingOracle', 'http://localhost'];
+   * await kvstoreClient.set(keys, values);
+   * ```
    */
   @requiresSigner
   public async setBulk(keys: string[], values: string[]): Promise<void> {
@@ -108,12 +215,28 @@ export class KVStoreClient {
   }
 
   /**
-   * Gets the value of a key-value pair in the contract
+   * This function returns the value for a specified key and address.
+   *
+   * @param {string} address Address from which to get the key value.
+   * @param {string} key Key to obtain the value.
+   * @returns {string} Value of the key.
+   *
+   *
+   * **Code example**
+   *
+   * > Need to have available stake.
+   *
+   * ```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);
    *
-   * @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 {Promise<string>} - The value of the key-value pair if it exists
-   * @throws {Error} - An error object if an error occurred
+   * const value = await kvstoreClient.get('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', 'Role');
+   * ```
    */
   public async get(address: string, key: string): Promise<string> {
     if (key === '') throw ErrorKVStoreEmptyKey;

package/src/staking.ts

@@ -33,6 +33,75 @@ import { GET_REWARD_ADDED_EVENTS_QUERY } from './graphql/queries/reward';
 import { RewardAddedEventData } from './graphql';
 import { GET_LEADER_QUERY, GET_LEADERS_QUERY } from './graphql/queries/staking';
 
+/**
+ * ## Introduction
+ *
+ * This client enables to perform actions on staking contracts and obtain staking information from both the contracts and subgraph.
+ *
+ * Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
+ * To use this client, it is recommended to initialize it using the static `build` method.
+ *
+ * ```ts
+ * static async build(signerOrProvider: Signer | Provider);
+ * ```
+ *
+ * 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.
+ *
+ * ## Installation
+ *
+ * ### npm
+ * ```bash
+ * npm install @human-protocol/sdk
+ * ```
+ *
+ * ### yarn
+ * ```bash
+ * yarn install @human-protocol/sdk
+ * ```
+ *
+ * ## Code example
+ *
+ * ### Signer
+ *
+ * **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 provider = new providers.JsonRpcProvider(rpcUrl);
+ * const signer = new Wallet(privateKey, provider);
+ * const stakingClient = await StakingClient.build(signer);
+ * ```
+ *
+ * **Using Wagmi(frontend)**
+ *
+ * ```ts
+ * import { useSigner, useChainId } from 'wagmi';
+ * import { StakingClient } from '@human-protocol/sdk';
+ *
+ * const { data: signer } = useSigner();
+ * const stakingClient = await StakingClient.build(signer);
+ * ```
+ *
+ * ### Provider
+ *
+ * ```ts
+ * import { StakingClient } from '@human-protocol/sdk';
+ * import { providers } from 'ethers';
+ *
+ * const rpcUrl = 'YOUR_RPC_URL';
+ *
+ * const provider = new providers.JsonRpcProvider(rpcUrl);
+ * const stakingClient = await StakingClient.build(provider);
+ * ```
+ */
 export class StakingClient {
   public signerOrProvider: Signer | Provider;
   public network: NetworkData;
@@ -97,12 +166,28 @@ export class StakingClient {
   }
 
   /**
-   * **Approves the staking contract to transfer a specified amount of tokens when the user stakes.
-   * **It increases the allowance for the staking contract.*
+   * This function approves the staking contract to transfer a specified amount of tokens when the user stakes. It increases the allowance for the staking contract.
    *
-   * @param {BigNumber} amount - Amount of tokens to approve for stake
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred, void otherwise
+   * @param {BigNumber} amount Amount in WEI of tokens to approve for stake.
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { ethers, Wallet, providers } from 'ethers';
+   * import { StakingClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const stakingClient = await StakingClient.build(signer);
+   *
+   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * await stakingClient.approveStake(amount);
+   * ```
    */
   @requiresSigner
   public async approveStake(amount: BigNumber): Promise<void> {
@@ -123,11 +208,31 @@ export class StakingClient {
   }
 
   /**
-   * **Stakes a specified amount of tokens on a specific network.*
+   * This function stakes a specified amount of tokens on a specific network.
+   *
+   * > `approveStake` must be called before
+   *
+   * @param {BigNumber} amount Amount in WEI of tokens to stake.
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
    *
-   * @param {BigNumber} amount - Amount of tokens to stake
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred, void otherwise
+   * ```ts
+   * import { ethers, Wallet, providers } from 'ethers';
+   * import { StakingClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const stakingClient = await StakingClient.build(signer);
+   *
+   * const amount = ethers.utils.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);
+   * ```
    */
   @requiresSigner
   public async stake(amount: BigNumber): Promise<void> {
@@ -148,12 +253,30 @@ export class StakingClient {
   }
 
   /**
-   * **Unstakes tokens from staking contract.
-   * **The unstaked tokens stay locked for a period of time.*
+   * This function unstakes tokens from staking contract. The unstaked tokens stay locked for a period of time.
+   *
+   * > Must have tokens available to unstake
+   *
+   * @param {BigNumber} amount Amount in WEI of tokens to unstake.
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { ethers, Wallet, providers } from 'ethers';
+   * import { StakingClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const stakingClient = await StakingClient.build(signer);
    *
-   * @param {BigNumber} amount - Amount of tokens to unstake
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred, void otherwise
+   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * await stakingClient.unstake(amount);
+   * ```
    */
   @requiresSigner
   public async unstake(amount: BigNumber): Promise<void> {
@@ -174,10 +297,28 @@ export class StakingClient {
   }
 
   /**
-   * **Withdraws unstaked and non locked tokens form staking contract to the user wallet.*
+   * This function withdraws unstaked and non locked tokens form staking contract to the user wallet.
    *
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred, void otherwise
+   * > Must have tokens available to withdraw
+   *
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { Wallet, providers } from 'ethers';
+   * import { StakingClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const stakingClient = await StakingClient.build(signer);
+   *
+   * await stakingClient.withdraw();
+   * ```
    */
   @requiresSigner
   public async withdraw(): Promise<void> {
@@ -190,15 +331,31 @@ export class StakingClient {
   }
 
   /**
-   * **Slash 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.*
-   *
-   * @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 which allocation will be slashed
-   * @param {BigNumber} amount - Amount of tokens to slash
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred, void otherwise
+   * 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.
+   *
+   * @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 which allocation will be slashed
+   * @param {BigNumber} amount Amount in WEI of tokens to unstake.
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { ethers, Wallet, providers } from 'ethers';
+   * import { StakingClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const stakingClient = await StakingClient.build(signer);
+   *
+   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * await stakingClient.slash('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);
+   * ```
    */
   @requiresSigner
   public async slash(
@@ -241,12 +398,31 @@ export class StakingClient {
   }
 
   /**
-   * **Allocates a portion of the staked tokens to a specific escrow.*
+   * This function allocates a portion of the staked tokens to a specific escrow.
+   *
+   * > Must have tokens staked
+   *
+   * @param {string} escrowAddress Address of the escrow contract to allocate in.
+   * @param {BigNumber} amount Amount in WEI of tokens to allocate.
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { ethers, Wallet, providers } from 'ethers';
+   * import { StakingClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
    *
-   * @param {string} escrowAddress - Address of the escrow contract
-   * @param {BigNumber} amount - Amount of tokens to allocate
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred, void otherwise
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const stakingClient = await StakingClient.build(signer);
+   *
+   * const amount = ethers.utils.parseUnits(5, 'ether'); //convert from ETH to WEI
+   * await stakingClient.allocate('0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);
+   * ```
    */
   @requiresSigner
   public async allocate(
@@ -278,11 +454,30 @@ export class StakingClient {
   }
 
   /**
-   * **Drops the allocation from a specific escrow.*
+   * This function drops the allocation from a specific escrow.
+   *
+   * > The escrow must have allocation
+   * > The escrow must be cancelled or completed.
+   *
+   * @param {string} escrowAddress Address of the escrow contract to close allocation from.
+   * @returns Returns void if successful. Throws error if any.
+   *
+   *
+   * **Code example**
    *
-   * @param {string} escrowAddress - Address of the escrow contract.
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred, void otherwise
+   * ```ts
+   * import { Wallet, providers } from 'ethers';
+   * import { StakingClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const stakingClient = await StakingClient.build(signer);
+   *
+   * await stakingClient.closeAllocation('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+   * ```
    */
   @requiresSigner
   public async closeAllocation(escrowAddress: string): Promise<void> {
@@ -303,11 +498,29 @@ export class StakingClient {
   }
 
   /**
-   * **Pays out rewards to the slashers for the specified escrow address.*
+   * This function drops the allocation from a specific escrow.
+   *
+   * > The escrow must have rewards added
+   *
+   * @param {string} escrowAddress Escrow address from which rewards are distributed.
+   * @returns Returns void if successful. Throws error if any.
    *
-   * @param {string} escrowAddress - Escrow address from which rewards are distributed.
-   * @returns {Promise<void>}
-   * @throws {Error} - An error object if an error occurred, void otherwise
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { Wallet, providers } from 'ethers';
+   * import { StakingClient } from '@human-protocol/sdk';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   * const privateKey = 'YOUR_PRIVATE_KEY'
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const signer = new Wallet(privateKey, provider);
+   * const stakingClient = await StakingClient.build(signer);
+   *
+   * await stakingClient.distributeRewards('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+   * ```
    */
   @requiresSigner
   public async distributeRewards(escrowAddress: string): Promise<void> {
@@ -333,11 +546,25 @@ export class StakingClient {
   }
 
   /**
-   * **Returns the leader details for a given address**
+   * 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 { StakingClient } from '@human-protocol/sdk';
+   * import { providers } from 'ethers';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
    *
-   * @param {string} address - Leader address
-   * @returns {Promise<ILeader>} - Return leader details
-   * @throws {Error} - An error object if an error occurred, result otherwise
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const stakingClient = await StakingClient.build(provider);
+   *
+   * const leaders = await stakingClient.getLeaders();
+   * ```
    */
   public async getLeader(address: string): Promise<ILeader> {
     if (!ethers.utils.isAddress(address)) {
@@ -358,10 +585,25 @@ export class StakingClient {
   }
 
   /**
-   * **Returns the leaders data **
+   * 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 { StakingClient } from '@human-protocol/sdk';
+   * import { providers } from 'ethers';
    *
-   * @returns {Promise<ILeader[]>} - Return an array with leaders data
-   * @throws {Error} - An error object if an error occurred, results otherwise
+   * const rpcUrl = 'YOUR_RPC_URL';
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const stakingClient = await StakingClient.build(provider);
+   *
+   * const leader = await stakingClient.getLeader('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+   * ```
    */
   public async getLeaders(filter: ILeadersFilter = {}): Promise<ILeader[]> {
     try {
@@ -378,11 +620,25 @@ export class StakingClient {
   }
 
   /**
-   * **Returns information about the allocation of the specified escrow.*
+   * This function returns information about the allocation of the specified escrow.
+   *
+   * @param {string} escrowAddress Escrow address from which we want to get allocation information.
+   * @returns {IAllocation} Returns allocation info if exists.
+   *
+   *
+   * **Code example**
    *
-   * @param {string} escrowAddress - The escrow address for the received allocation data
-   * @returns {Promise<IAllocation>} - Returns allocation info if exists
-   * @throws {Error} - An error object if an error occurred, result otherwise
+   * ```ts
+   * import { StakingClient } from '@human-protocol/sdk';
+   * import { providers } from 'ethers';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const stakingClient = await StakingClient.build(provider);
+   *
+   * const allocationInfo = await stakingClient.getAllocation('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+   * ```
    */
   public async getAllocation(escrowAddress: string): Promise<IAllocation> {
     if (!ethers.utils.isAddress(escrowAddress)) {
@@ -402,11 +658,25 @@ export class StakingClient {
   }
 
   /**
-   * **Returns information about the rewards for a given escrow address.*
+   * 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 { StakingClient } from '@human-protocol/sdk';
+   * import { providers } from 'ethers';
+   *
+   * const rpcUrl = 'YOUR_RPC_URL';
+   *
+   * const provider = new providers.JsonRpcProvider(rpcUrl);
+   * const stakingClient = await StakingClient.build(provider);
    *
-   * @param {string} slasherAddress - Address of the slasher
-   * @returns {Promise<IReward[]>} - Returns rewards info if exists
-   * @throws {Error} - An error object if an error occurred, results otherwise
+   * const rewards = await stakingClient.getRewards('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+   * ```
    */
   public async getRewards(slasherAddress: string): Promise<IReward[]> {
     if (!ethers.utils.isAddress(slasherAddress)) {