@human-protocol/sdk 1.1.5 → 1.1.7

package/src/staking.ts

@@ -1,18 +1,20 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { Provider } from '@ethersproject/abstract-provider';
+import { Network } from '@ethersproject/networks';
 import {
-  Staking__factory,
-  HMToken__factory,
-  HMToken,
-  Staking,
-  RewardPool__factory,
-  RewardPool,
   EscrowFactory,
   EscrowFactory__factory,
+  HMToken,
+  HMToken__factory,
+  RewardPool,
+  RewardPool__factory,
+  Staking,
+  Staking__factory,
 } from '@human-protocol/core/typechain-types';
-import { BigNumber, ethers, Signer } from 'ethers';
-import { NetworkData } from './types';
-import { IAllocation, IClientParams, IReward, IStaker } from './interfaces';
+import { BigNumber, Signer, ethers } from 'ethers';
+import { NETWORKS } from './constants';
+import { requiresSigner } from './decorators';
+import { ChainId } from './enums';
 import {
   ErrorEscrowAddressIsNotProvidedByFactory,
   ErrorInvalidEscrowAddressProvided,
@@ -20,13 +22,16 @@ import {
   ErrorInvalidStakerAddressProvided,
   ErrorInvalidStakingValueSign,
   ErrorInvalidStakingValueType,
+  ErrorProviderDoesNotExist,
   ErrorStakingGetStakers,
+  ErrorUnsupportedChainID,
 } from './error';
-import { gqlFetch, throwError } from './utils';
+import { IAllocation, IReward, IStaker } from './interfaces';
 import { RAW_REWARDS_QUERY } from './queries';
-import { requiresSigner } from './decorators';
+import { NetworkData } from './types';
+import { gqlFetch, throwError } from './utils';
 
-export default class StakingClient {
+export class StakingClient {
   public signerOrProvider: Signer | Provider;
   public network: NetworkData;
   public tokenContract: HMToken;
@@ -34,28 +39,59 @@ export default class StakingClient {
   public escrowFactoryContract: EscrowFactory;
 
   /**
-   * **Staking constructor**
+   * **StakingClient 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 Staking contract
    */
-  constructor(readonly clientParams: IClientParams) {
-    this.signerOrProvider = clientParams.signerOrProvider;
-    this.network = clientParams.network;
-
+  constructor(signerOrProvider: Signer | Provider, network: NetworkData) {
     this.stakingContract = Staking__factory.connect(
-      this.network.stakingAddress,
-      this.signerOrProvider
+      network.stakingAddress,
+      signerOrProvider
     );
 
     this.escrowFactoryContract = EscrowFactory__factory.connect(
-      this.network.factoryAddress,
-      this.signerOrProvider
+      network.factoryAddress,
+      signerOrProvider
     );
 
     this.tokenContract = HMToken__factory.connect(
-      this.network.hmtAddress,
-      this.signerOrProvider
+      network.hmtAddress,
+      signerOrProvider
     );
+
+    this.signerOrProvider = signerOrProvider;
+    this.network = network;
+  }
+
+  /**
+   * Creates an instance of StakingClient from a Signer or Provider.
+   *
+   * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+   * @returns {Promise<StakingClient>} - An instance of StakingClient
+   * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
+   * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
+   */
+  public static async build(signerOrProvider: Signer | Provider) {
+    let network: Network;
+    if (Signer.isSigner(signerOrProvider)) {
+      if (!signerOrProvider.provider) {
+        throw ErrorProviderDoesNotExist;
+      }
+
+      network = await signerOrProvider.provider.getNetwork();
+    } else {
+      network = await signerOrProvider.getNetwork();
+    }
+
+    const chainId: ChainId = network.chainId;
+    const networkData = NETWORKS[chainId];
+
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
+
+    return new StakingClient(signerOrProvider, networkData);
   }
 
   /**
@@ -319,6 +355,7 @@ export default class StakingClient {
         .sub(tokensLocked);
 
       return {
+        staker,
         tokensStaked,
         tokensAllocated,
         tokensLocked,
@@ -333,7 +370,7 @@ export default class StakingClient {
   /**
    * **Returns the staking information about all stakers of the protocol.*
    *
-   * @returns {Promise<IStakerInfo>} - Return an array with all stakers information
+   * @returns {Promise<IStaker[]>} - Return an array with all stakers information
    * @throws {Error} - An error object if an error occurred, results otherwise
    */
   public async getAllStakers(): Promise<IStaker[]> {
@@ -344,7 +381,7 @@ export default class StakingClient {
         throw ErrorStakingGetStakers;
       }
 
-      return result[1].map((staker: any) => {
+      return result[1].map((staker: any, index: number) => {
         const tokensStaked = BigNumber.from(staker.tokensStaked),
           tokensAllocated = BigNumber.from(staker.tokensAllocated),
           tokensLocked = BigNumber.from(staker.tokensLocked),
@@ -355,6 +392,7 @@ export default class StakingClient {
           .sub(tokensLocked);
 
         return {
+          staker: result[0][index],
           tokensStaked,
           tokensAllocated,
           tokensLocked,

package/src/storage.ts

@@ -13,8 +13,9 @@ import { UploadFile, StorageCredentials, StorageParams } from './types';
 import { isValidUrl } from './utils';
 import { HttpStatus } from './constants';
 
-export default class StorageClient {
+export class StorageClient {
   private client: Minio.Client;
+  private clientParams: StorageParams;
 
   /**
    * **Storage client constructor**
@@ -24,6 +25,8 @@ export default class StorageClient {
    */
   constructor(credentials: StorageCredentials, params: StorageParams) {
     try {
+      this.clientParams = params;
+
       this.client = new Minio.Client({
         ...params,
         accessKey: credentials.accessKey,
@@ -109,14 +112,22 @@ export default class StorageClient {
         const content = JSON.stringify(file);
 
         const hash = crypto.createHash('sha1').update(content).digest('hex');
-        const key = hash;
+        const key = `s3${hash}.json`;
 
         try {
           await this.client.putObject(bucket, key, content, {
             'Content-Type': 'application/json',
           });
 
-          return { key, hash };
+          return {
+            key,
+            url: `${this.clientParams.useSSL ? 'https' : 'http'}://${
+              this.clientParams.endPoint
+            }${
+              this.clientParams.port ? `:${this.clientParams.port}` : ''
+            }/${bucket}/${key}`,
+            hash,
+          };
         } catch (e) {
           throw ErrorStorageFileNotUploaded;
         }

package/src/types.ts

@@ -73,6 +73,10 @@ export type UploadFile = {
    * Uploaded object key
    */
   key: string;
+  /**
+   * Uploaded object URL
+   */
+  url: string;
   /**
    * Hash of uploaded object key
    */
@@ -107,6 +111,10 @@ export type NetworkData = {
    * Staking contract address
    */
   stakingAddress: string;
+  /**
+   * RewardPool contract address
+   */
+  rewardPoolAddress: string;
   /**
    * KVStore contract address
    */

package/dist/init.d.ts

@@ -1,13 +0,0 @@
-import { Provider } from '@ethersproject/abstract-provider';
-import { Signer } from 'ethers';
-import { IClientParams } from './interfaces';
-export default class InitClient {
-    /**
-     * **Get init client parameters**
-     *
-     * @param {Signer | Provider} providerOrSigner - Ethereum signer or provider
-     * @returns {Promise<IClientParams>} - Init client parameters
-     */
-    static getParams(signerOrProvider: Signer | Provider): Promise<IClientParams>;
-}
-//# sourceMappingURL=init.d.ts.map

package/dist/init.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAE5D,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAO7C,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B;;;;;OAKG;WACU,SAAS,CACpB,gBAAgB,EAAE,MAAM,GAAG,QAAQ,GAClC,OAAO,CAAC,aAAa,CAAC;CAwB1B"}

package/dist/init.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ethers_1 = require("ethers");
-const constants_1 = require("./constants");
-const error_1 = require("./error");
-class InitClient {
-    /**
-     * **Get init client parameters**
-     *
-     * @param {Signer | Provider} providerOrSigner - Ethereum signer or provider
-     * @returns {Promise<IClientParams>} - Init client parameters
-     */
-    static async getParams(signerOrProvider) {
-        let network;
-        if (signerOrProvider instanceof ethers_1.Signer) {
-            if (!signerOrProvider.provider) {
-                throw error_1.ErrorInitProviderDoesNotExist;
-            }
-            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.ErrorInitUnsupportedChainID;
-        }
-        return {
-            signerOrProvider: signerOrProvider,
-            network: networkData,
-        };
-    }
-}
-exports.default = InitClient;

package/src/init.ts

@@ -1,45 +0,0 @@
-import { Provider } from '@ethersproject/abstract-provider';
-import { Network } from '@ethersproject/networks';
-import { Signer } from 'ethers';
-import { NETWORKS } from './constants';
-import { IClientParams } from './interfaces';
-import {
-  ErrorInitProviderDoesNotExist,
-  ErrorInitUnsupportedChainID,
-} from './error';
-import { ChainId } from './enums';
-
-export default class InitClient {
-  /**
-   * **Get init client parameters**
-   *
-   * @param {Signer | Provider} providerOrSigner - Ethereum signer or provider
-   * @returns {Promise<IClientParams>} - Init client parameters
-   */
-  static async getParams(
-    signerOrProvider: Signer | Provider
-  ): Promise<IClientParams> {
-    let network: Network;
-    if (signerOrProvider instanceof Signer) {
-      if (!signerOrProvider.provider) {
-        throw ErrorInitProviderDoesNotExist;
-      }
-
-      network = await signerOrProvider.provider.getNetwork();
-    } else {
-      network = await signerOrProvider.getNetwork();
-    }
-
-    const chainId: ChainId = network.chainId;
-    const networkData = NETWORKS[chainId];
-
-    if (!networkData) {
-      throw ErrorInitUnsupportedChainID;
-    }
-
-    return {
-      signerOrProvider: signerOrProvider,
-      network: networkData,
-    };
-  }
-}