@human-protocol/sdk 3.0.8 → 4.0.1

package/src/statistics.ts

@@ -20,26 +20,21 @@ import {
 } from './graphql';
 import { IHMTHoldersParams, IStatisticsFilter } from './interfaces';
 import { NetworkData } from './types';
-import { getSubgraphUrl, throwError } from './utils';
+import { getSubgraphUrl, getUnixTimestamp, throwError } from './utils';
 import { OrderDirection } from './enums';
 
 /**
  * ## Introduction
  *
- * This client enables to obtain statistical information from the subgraph.
+ * This client enables obtaining statistical information from the subgraph.
  *
- * Unlikely from the other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
- * We just need to create client object using relevant network data.
+ * Unlike other SDK clients, `StatisticsClient` does not require `signer` or `provider` to be provided.
+ * We just need to create a client object using relevant network data.
  *
  * ```ts
  * constructor(network: NetworkData)
  * ```
  *
- * 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
@@ -77,7 +72,6 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of escrows.
    *
-   *
    * **Input parameters**
    *
    * ```ts
@@ -106,10 +100,8 @@ export class StatisticsClient {
    * };
    * ```
    *
-   *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {EscrowStatistics} Escrow statistics data.
-   *
+   * @returns {Promise<EscrowStatistics>} Escrow statistics data.
    *
    * **Code example**
    *
@@ -141,8 +133,8 @@ export class StatisticsClient {
       const { eventDayDatas } = await gqlFetch<{
         eventDayDatas: EventDayData[];
       }>(this.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(filter), {
-        from: filter.from ? filter.from.getTime() / 1000 : undefined,
-        to: filter.to ? filter.to.getTime() / 1000 : undefined,
+        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
         orderDirection: orderDirection,
         first: first,
         skip: skip,
@@ -169,7 +161,6 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of workers.
    *
-   *
    * **Input parameters**
    *
    * ```ts
@@ -193,10 +184,8 @@ export class StatisticsClient {
    * };
    * ```
    *
-   *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {WorkerStatistics} Worker statistics data.
-   *
+   * @returns {Promise<WorkerStatistics>} Worker statistics data.
    *
    * **Code example**
    *
@@ -224,8 +213,8 @@ export class StatisticsClient {
       const { eventDayDatas } = await gqlFetch<{
         eventDayDatas: EventDayData[];
       }>(this.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(filter), {
-        from: filter.from ? filter.from.getTime() / 1000 : undefined,
-        to: filter.to ? filter.to.getTime() / 1000 : undefined,
+        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
         orderDirection: orderDirection,
         first: first,
         skip: skip,
@@ -245,7 +234,6 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of payments.
    *
-   *
    * **Input parameters**
    *
    * ```ts
@@ -271,10 +259,8 @@ export class StatisticsClient {
    * };
    * ```
    *
-   *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {PaymentStatistics} Payment statistics data.
-   *
+   * @returns {Promise<PaymentStatistics>} Payment statistics data.
    *
    * **Code example**
    *
@@ -323,8 +309,8 @@ export class StatisticsClient {
       const { eventDayDatas } = await gqlFetch<{
         eventDayDatas: EventDayData[];
       }>(this.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(filter), {
-        from: filter.from ? filter.from.getTime() / 1000 : undefined,
-        to: filter.to ? filter.to.getTime() / 1000 : undefined,
+        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
         orderDirection: orderDirection,
         first: first,
         skip: skip,
@@ -350,7 +336,7 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of HMToken.
    *
-   *
+   * ```ts
    * type HMTStatistics = {
    *   totalTransferAmount: BigNumber;
    *   totalTransferCount: BigNumber;
@@ -358,9 +344,7 @@ export class StatisticsClient {
    * };
    * ```
    *
-   *
-   * @returns {HMTStatistics} HMToken statistics data.
-   *
+   * @returns {Promise<HMTStatistics>} HMToken statistics data.
    *
    * **Code example**
    *
@@ -401,7 +385,7 @@ export class StatisticsClient {
    * **Input parameters**
    *
    * @param {IHMTHoldersParams} params HMT Holders params with filters and ordering
-   * @returns {HMTHolder[]} List of HMToken holders.
+   * @returns {Promise<HMTHolder[]>} List of HMToken holders.
    *
    * **Code example**
    *
@@ -447,7 +431,6 @@ export class StatisticsClient {
   /**
    * This function returns the statistical data of HMToken day by day.
    *
-   *
    * **Input parameters**
    *
    * ```ts
@@ -470,10 +453,8 @@ export class StatisticsClient {
    * }
    * ```
    *
-   *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {DailyHMTData[]} Daily HMToken statistics data.
-   *
+   * @returns {Promise<DailyHMTData[]>} Daily HMToken statistics data.
    *
    * **Code example**
    *
@@ -506,8 +487,8 @@ export class StatisticsClient {
       const { eventDayDatas } = await gqlFetch<{
         eventDayDatas: EventDayData[];
       }>(this.subgraphUrl, GET_EVENT_DAY_DATA_QUERY(filter), {
-        from: filter.from ? filter.from.getTime() / 1000 : undefined,
-        to: filter.to ? filter.to.getTime() / 1000 : undefined,
+        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
         orderDirection: orderDirection,
         first: first,
         skip: skip,

package/src/storage.ts

@@ -19,7 +19,7 @@ import { HttpStatus } from './constants';
  *
  * ## Introduction
  *
- * This client enables to interact with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage and others.
+ * This client enables interacting with S3 cloud storage services like Amazon S3 Bucket, Google Cloud Storage, and others.
  *
  * The instance creation of `StorageClient` should be made using its constructor:
  *
@@ -27,7 +27,7 @@ import { HttpStatus } from './constants';
  * constructor(params: StorageParams, credentials?: StorageCredentials)
  * ```
  *
- * > If credentials is not provided, it uses an anonymous access to the bucket for downloading files.
+ * > If credentials are not provided, it uses anonymous access to the bucket for downloading files.
  *
  * ## Installation
  *
@@ -68,7 +68,7 @@ export class StorageClient {
    * **Storage client constructor**
    *
    * @param {StorageParams} params - Cloud storage params
-   * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials is not provided - use an anonymous access to the bucket
+   * @param {StorageCredentials} credentials - Optional. Cloud storage access data. If credentials are not provided - use anonymous access to the bucket
    */
   constructor(params: StorageParams, credentials?: StorageCredentials) {
     try {
@@ -89,8 +89,7 @@ export class StorageClient {
    *
    * @param {string[]} keys Array of filenames to download.
    * @param {string} bucket Bucket name.
-   * @returns {any[]} Returns an array of json files downloaded and parsed into objects.
-   *
+   * @returns {Promise<any[]>} Returns an array of JSON files downloaded and parsed into objects.
    *
    * **Code example**
    *
@@ -131,18 +130,17 @@ export class StorageClient {
   }
 
   /**
-   * This function downloads files from a Url.
-   *
-   * @param {string} url Url of the file to download.
-   * @returns {any} Returns the JSON file downloaded and parsed into object.
+   * This function downloads files from a URL.
    *
+   * @param {string} url URL of the file to download.
+   * @returns {Promise<any>} Returns the JSON file downloaded and parsed into an object.
    *
    * **Code example**
    *
    * ```ts
    * import { StorageClient } from '@human-protocol/sdk';
    *
-   * const file = await storageClient.downloadFileFromUrl('http://localhost/file.json');
+   * const file = await StorageClient.downloadFileFromUrl('http://localhost/file.json');
    * ```
    */
   public static async downloadFileFromUrl(url: string): Promise<any> {
@@ -170,10 +168,9 @@ export class StorageClient {
   /**
    * This function uploads files to a bucket.
    *
-   * @param {any[]} files Array of objects to upload serialized into json.
+   * @param {any[]} files Array of objects to upload serialized into JSON.
    * @param {string} bucket Bucket name.
-   * @returns {UploadFile[]} Returns an array of json files downloaded and parsed into objects.
-   *
+   * @returns {Promise<UploadFile[]>} Returns an array of uploaded file metadata.
    *
    * **Code example**
    *
@@ -240,8 +237,7 @@ export class StorageClient {
    * This function checks if a bucket exists.
    *
    * @param {string} bucket Bucket name.
-   * @returns {boolean} Returns `true` if exists, `false` if it doesn't.
-   *
+   * @returns {Promise<boolean>} Returns `true` if exists, `false` if it doesn't.
    *
    * **Code example**
    *
@@ -268,11 +264,10 @@ export class StorageClient {
   }
 
   /**
-   * This function list all file names contained in the bucket.
+   * This function lists all file names contained in the bucket.
    *
    * @param {string} bucket Bucket name.
-   * @returns {boolean} Returns the list of file names contained in the bucket.
-   *
+   * @returns {Promise<string[]>} Returns the list of file names contained in the bucket.
    *
    * **Code example**
    *

package/src/transaction.ts

@@ -5,7 +5,7 @@ import { NETWORKS } from './constants';
 import { ChainId, OrderDirection } from './enums';
 import {
   ErrorCannotUseDateAndBlockSimultaneously,
-  ErrorInvalidHahsProvided,
+  ErrorInvalidHashProvided,
   ErrorUnsupportedChainID,
 } from './error';
 import {
@@ -13,7 +13,7 @@ import {
   GET_TRANSACTION_QUERY,
 } from './graphql/queries/transaction';
 import { ITransaction, ITransactionsFilter } from './interfaces';
-import { getSubgraphUrl } from './utils';
+import { getSubgraphUrl, getUnixTimestamp } from './utils';
 
 export class TransactionUtils {
   /**
@@ -36,7 +36,7 @@ export class TransactionUtils {
     hash: string
   ): Promise<ITransaction> {
     if (!ethers.isHexString(hash)) {
-      throw ErrorInvalidHahsProvided;
+      throw ErrorInvalidHashProvided;
     }
     const networkData = NETWORKS[chainId];
 
@@ -132,11 +132,9 @@ export class TransactionUtils {
       fromAddress: filter?.fromAddress,
       toAddress: filter?.toAddress,
       startDate: filter?.startDate
-        ? Math.floor(filter?.startDate.getTime() / 1000)
-        : undefined,
-      endDate: filter.endDate
-        ? Math.floor(filter.endDate.getTime() / 1000)
+        ? getUnixTimestamp(filter?.startDate)
         : undefined,
+      endDate: filter.endDate ? getUnixTimestamp(filter.endDate) : undefined,
       startBlock: filter.startBlock ? filter.startBlock : undefined,
       endBlock: filter.endBlock ? filter.endBlock : undefined,
       orderDirection: orderDirection,

package/src/types.ts

@@ -1,3 +1,5 @@
+import { TransactionLike } from 'ethers';
+
 /**
  * Enum for escrow statuses.
  * @readonly
@@ -21,7 +23,7 @@ export enum EscrowStatus {
    */
   Paid,
   /**
-   * Escrow is finished..
+   * Escrow is finished.
    */
   Complete,
   /**
@@ -124,7 +126,7 @@ export type NetworkData = {
    */
   subgraphUrl: string;
   /**
-   * Subgraph URL
+   * Subgraph URL API key
    */
   subgraphUrlApiKey: string;
   /**
@@ -168,3 +170,5 @@ export type EscrowWithdraw = {
    */
   amountWithdrawn: bigint;
 };
+
+export type TransactionLikeWithNonce = TransactionLike & { nonce: number };

package/src/utils.ts

@@ -57,7 +57,6 @@ export const isValidUrl = (url: string) => {
  * **Get the subgraph URL.*
  *
  * @param {NetworkData} networkData
- * @param {string} apiKey
  * @returns
  */
 export const getSubgraphUrl = (networkData: NetworkData) => {
@@ -74,3 +73,13 @@ export const getSubgraphUrl = (networkData: NetworkData) => {
 
   return subgraphUrl;
 };
+
+/**
+ * **Convert a date to Unix timestamp (seconds since epoch).*
+ *
+ * @param {Date} date
+ * @returns {number}
+ */
+export const getUnixTimestamp = (date: Date): number => {
+  return Math.floor(date.getTime() / 1000);
+};