@human-protocol/sdk 5.0.0-beta.2 → 5.0.0

package/src/statistics.ts

@@ -1,27 +1,29 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { ethers } from 'ethers';
 import gqlFetch from 'graphql-request';
 
+import { OrderDirection } from './enums';
 import {
+  EscrowStatisticsData,
+  EventDayData,
   GET_ESCROW_STATISTICS_QUERY,
   GET_EVENT_DAY_DATA_QUERY,
-  GET_HOLDERS_QUERY,
   GET_HMTOKEN_STATISTICS_QUERY,
-  EscrowStatistics,
-  EscrowStatisticsData,
-  EventDayData,
-  HMTStatistics,
-  HMTStatisticsData,
-  PaymentStatistics,
-  WorkerStatistics,
+  GET_HOLDERS_QUERY,
   HMTHolderData,
-  HMTHolder,
-  DailyHMTData,
+  HMTStatisticsData,
 } from './graphql';
-import { IHMTHoldersParams, IStatisticsFilter } from './interfaces';
+import {
+  IDailyHMT,
+  IEscrowStatistics,
+  IHMTHolder,
+  IHMTHoldersParams,
+  IHMTStatistics,
+  IPaymentStatistics,
+  IStatisticsFilter,
+  IWorkerStatistics,
+} from './interfaces';
 import { NetworkData } from './types';
 import { getSubgraphUrl, getUnixTimestamp, throwError } from './utils';
-import { OrderDirection } from './enums';
 
 /**
  * ## Introduction
@@ -85,8 +87,8 @@ export class StatisticsClient {
    * ```
    *
    * ```ts
-   * type DailyEscrowsData = {
-   *   timestamp: Date;
+   * interface IDailyEscrow {
+   *   timestamp: number;
    *   escrowsTotal: number;
    *   escrowsPending: number;
    *   escrowsSolved: number;
@@ -94,14 +96,14 @@ export class StatisticsClient {
    *   escrowsCancelled: number;
    * };
    *
-   * type EscrowStatistics = {
+   * interface IEscrowStatistics {
    *   totalEscrows: number;
-   *   dailyEscrowsData: DailyEscrowsData[];
+   *   dailyEscrowsData: IDailyEscrow[];
    * };
    * ```
    *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {Promise<EscrowStatistics>} Escrow statistics data.
+   * @returns {Promise<IEscrowStatistics>} Escrow statistics data.
    *
    * **Code example**
    *
@@ -119,7 +121,7 @@ export class StatisticsClient {
    */
   async getEscrowStatistics(
     filter: IStatisticsFilter = {}
-  ): Promise<EscrowStatistics> {
+  ): Promise<IEscrowStatistics> {
     try {
       const first =
         filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
@@ -145,7 +147,7 @@ export class StatisticsClient {
           ? +escrowStatistics.totalEscrowCount
           : 0,
         dailyEscrowsData: eventDayDatas.map((eventDayData) => ({
-          timestamp: new Date(+eventDayData.timestamp * 1000),
+          timestamp: +eventDayData.timestamp * 1000,
           escrowsTotal: +eventDayData.dailyEscrowCount,
           escrowsPending: +eventDayData.dailyPendingStatusEventCount,
           escrowsSolved: +eventDayData.dailyCompletedStatusEventCount,
@@ -174,18 +176,18 @@ export class StatisticsClient {
    * ```
    *
    * ```ts
-   * type DailyWorkerData = {
-   *   timestamp: Date;
+   * interface IDailyWorker {
+   *   timestamp: number;
    *   activeWorkers: number;
    * };
    *
-   * type WorkerStatistics = {
-   *   dailyWorkersData: DailyWorkerData[];
+   * interface IWorkerStatistics {
+   *   dailyWorkersData: IDailyWorker[];
    * };
    * ```
    *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {Promise<WorkerStatistics>} Worker statistics data.
+   * @returns {Promise<IWorkerStatistics>} Worker statistics data.
    *
    * **Code example**
    *
@@ -203,7 +205,7 @@ export class StatisticsClient {
    */
   async getWorkerStatistics(
     filter: IStatisticsFilter = {}
-  ): Promise<WorkerStatistics> {
+  ): Promise<IWorkerStatistics> {
     try {
       const first =
         filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
@@ -222,7 +224,7 @@ export class StatisticsClient {
 
       return {
         dailyWorkersData: eventDayDatas.map((eventDayData) => ({
-          timestamp: new Date(+eventDayData.timestamp * 1000),
+          timestamp: +eventDayData.timestamp * 1000,
           activeWorkers: +eventDayData.dailyWorkerCount,
         })),
       };
@@ -247,20 +249,20 @@ export class StatisticsClient {
    * ```
    *
    * ```ts
-   * type DailyPaymentData = {
-   *   timestamp: Date;
-   *   totalAmountPaid: BigNumber;
+   * interface IDailyPayment {
+   *   timestamp: number;
+   *   totalAmountPaid: bigint;
    *   totalCount: number;
-   *   averageAmountPerWorker: BigNumber;
+   *   averageAmountPerWorker: bigint;
    * };
    *
-   * type PaymentStatistics = {
-   *   dailyPaymentsData: DailyPaymentData[];
+   * interface IPaymentStatistics {
+   *   dailyPaymentsData: IDailyPayment[];
    * };
    * ```
    *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {Promise<PaymentStatistics>} Payment statistics data.
+   * @returns {Promise<IPaymentStatistics>} Payment statistics data.
    *
    * **Code example**
    *
@@ -299,7 +301,7 @@ export class StatisticsClient {
    */
   async getPaymentStatistics(
     filter: IStatisticsFilter = {}
-  ): Promise<PaymentStatistics> {
+  ): Promise<IPaymentStatistics> {
     try {
       const first =
         filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
@@ -318,14 +320,14 @@ export class StatisticsClient {
 
       return {
         dailyPaymentsData: eventDayDatas.map((eventDayData) => ({
-          timestamp: new Date(+eventDayData.timestamp * 1000),
-          totalAmountPaid: ethers.toBigInt(eventDayData.dailyHMTPayoutAmount),
+          timestamp: +eventDayData.timestamp * 1000,
+          totalAmountPaid: BigInt(eventDayData.dailyHMTPayoutAmount),
           totalCount: +eventDayData.dailyPayoutCount,
           averageAmountPerWorker:
             eventDayData.dailyWorkerCount === '0'
-              ? ethers.toBigInt(0)
-              : ethers.toBigInt(eventDayData.dailyHMTPayoutAmount) /
-                ethers.toBigInt(eventDayData.dailyWorkerCount),
+              ? BigInt(0)
+              : BigInt(eventDayData.dailyHMTPayoutAmount) /
+                BigInt(eventDayData.dailyWorkerCount),
         })),
       };
     } catch (e: any) {
@@ -337,14 +339,14 @@ export class StatisticsClient {
    * This function returns the statistical data of HMToken.
    *
    * ```ts
-   * type HMTStatistics = {
-   *   totalTransferAmount: BigNumber;
-   *   totalTransferCount: BigNumber;
+   * interface IHMTStatistics {
+   *   totalTransferAmount: bigint;
+   *   totalTransferCount: number;
    *   totalHolders: number;
    * };
    * ```
    *
-   * @returns {Promise<HMTStatistics>} HMToken statistics data.
+   * @returns {Promise<IHMTStatistics>} HMToken statistics data.
    *
    * **Code example**
    *
@@ -361,17 +363,15 @@ export class StatisticsClient {
    * });
    * ```
    */
-  async getHMTStatistics(): Promise<HMTStatistics> {
+  async getHMTStatistics(): Promise<IHMTStatistics> {
     try {
       const { hmtokenStatistics } = await gqlFetch<{
         hmtokenStatistics: HMTStatisticsData;
       }>(this.subgraphUrl, GET_HMTOKEN_STATISTICS_QUERY);
 
       return {
-        totalTransferAmount: ethers.toBigInt(
-          hmtokenStatistics.totalValueTransfered
-        ),
-        totalTransferCount: Number(hmtokenStatistics.totalTransferEventCount),
+        totalTransferAmount: BigInt(hmtokenStatistics.totalValueTransfered),
+        totalTransferCount: +hmtokenStatistics.totalTransferEventCount,
         totalHolders: +hmtokenStatistics.holders,
       };
     } catch (e: any) {
@@ -385,7 +385,7 @@ export class StatisticsClient {
    * **Input parameters**
    *
    * @param {IHMTHoldersParams} params HMT Holders params with filters and ordering
-   * @returns {Promise<HMTHolder[]>} List of HMToken holders.
+   * @returns {Promise<IHMTHolder[]>} List of HMToken holders.
    *
    * **Code example**
    *
@@ -404,7 +404,7 @@ export class StatisticsClient {
    * })));
    * ```
    */
-  async getHMTHolders(params: IHMTHoldersParams = {}): Promise<HMTHolder[]> {
+  async getHMTHolders(params: IHMTHoldersParams = {}): Promise<IHMTHolder[]> {
     try {
       const { address, orderDirection } = params;
       const query = GET_HOLDERS_QUERY(address);
@@ -421,7 +421,7 @@ export class StatisticsClient {
 
       return holders.map((holder) => ({
         address: holder.address,
-        balance: ethers.toBigInt(holder.balance),
+        balance: BigInt(holder.balance),
       }));
     } catch (e: any) {
       return throwError(e);
@@ -444,8 +444,8 @@ export class StatisticsClient {
    * ```
    *
    * ```ts
-   * type DailyHMTData = {
-   *   timestamp: Date;
+   * interface IDailyHMT {
+   *   timestamp: number;
    *   totalTransactionAmount: bigint;
    *   totalTransactionCount: number;
    *   dailyUniqueSenders: number;
@@ -454,7 +454,7 @@ export class StatisticsClient {
    * ```
    *
    * @param {IStatisticsFilter} filter Statistics params with duration data
-   * @returns {Promise<DailyHMTData[]>} Daily HMToken statistics data.
+   * @returns {Promise<IDailyHMT[]>} Daily HMToken statistics data.
    *
    * **Code example**
    *
@@ -475,9 +475,7 @@ export class StatisticsClient {
    * console.log('HMT statistics from 5/8 - 6/8:', hmtStatisticsRange);
    * ```
    */
-  async getHMTDailyData(
-    filter: IStatisticsFilter = {}
-  ): Promise<DailyHMTData[]> {
+  async getHMTDailyData(filter: IStatisticsFilter = {}): Promise<IDailyHMT[]> {
     try {
       const first =
         filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
@@ -495,10 +493,8 @@ export class StatisticsClient {
       });
 
       return eventDayDatas.map((eventDayData) => ({
-        timestamp: new Date(+eventDayData.timestamp * 1000),
-        totalTransactionAmount: ethers.toBigInt(
-          eventDayData.dailyHMTTransferAmount
-        ),
+        timestamp: +eventDayData.timestamp * 1000,
+        totalTransactionAmount: BigInt(eventDayData.dailyHMTTransferAmount),
         totalTransactionCount: +eventDayData.dailyHMTTransferCount,
         dailyUniqueSenders: +eventDayData.dailyUniqueSenders,
         dailyUniqueReceivers: +eventDayData.dailyUniqueReceivers,

package/src/transaction.ts

@@ -8,11 +8,16 @@ import {
   ErrorInvalidHashProvided,
   ErrorUnsupportedChainID,
 } from './error';
+import { TransactionData } from './graphql';
 import {
-  GET_TRANSACTIONS_QUERY,
   GET_TRANSACTION_QUERY,
+  GET_TRANSACTIONS_QUERY,
 } from './graphql/queries/transaction';
-import { ITransaction, ITransactionsFilter } from './interfaces';
+import {
+  InternalTransaction,
+  ITransaction,
+  ITransactionsFilter,
+} from './interfaces';
 import { getSubgraphUrl, getUnixTimestamp } from './utils';
 
 export class TransactionUtils {
@@ -26,7 +31,7 @@ export class TransactionUtils {
    *   from: string;
    *   to: string;
    *   timestamp: bigint;
-   *   value: string;
+   *   value: bigint;
    *   method: string;
    *   receiver?: string;
    *   escrow?: string;
@@ -35,6 +40,18 @@ export class TransactionUtils {
    * };
    * ```
    *
+   * ```ts
+   * type InternalTransaction = {
+   *  from: string;
+   *  to: string;
+   *  value: bigint;
+   *  method: string;
+   *  receiver?: string;
+   *  escrow?: string;
+   *  token?: string;
+   * };
+   * ```
+   *
    * @param {ChainId} chainId The chain ID.
    * @param {string} hash The transaction hash.
    * @returns {Promise<ITransaction | null>} - Returns the transaction details or null if not found.
@@ -61,12 +78,13 @@ export class TransactionUtils {
     }
 
     const { transaction } = await gqlFetch<{
-      transaction: ITransaction;
+      transaction: TransactionData | null;
     }>(getSubgraphUrl(networkData), GET_TRANSACTION_QUERY, {
       hash: hash.toLowerCase(),
     });
+    if (!transaction) return null;
 
-    return transaction || null;
+    return mapTransaction(transaction);
   }
 
   /**
@@ -92,6 +110,18 @@ export class TransactionUtils {
    *   skip?: number; // (Optional) Number of transactions to skip. Default is 0.
    *   orderDirection?: OrderDirection; // (Optional) Order of the results. Default is DESC.
    * }
+   *
+   *
+   * ```ts
+   * type InternalTransaction = {
+   *  from: string;
+   *  to: string;
+   *  value: bigint;
+   *  method: string;
+   *  receiver?: string;
+   *  escrow?: string;
+   *  token?: string;
+   * };
    * ```
    *
    * ```ts
@@ -101,7 +131,7 @@ export class TransactionUtils {
    *   from: string;
    *   to: string;
    *   timestamp: bigint;
-   *   value: string;
+   *   value: bigint;
    *   method: string;
    *   receiver?: string;
    *   escrow?: string;
@@ -150,7 +180,7 @@ export class TransactionUtils {
     }
 
     const { transactions } = await gqlFetch<{
-      transactions: ITransaction[];
+      transactions: TransactionData[];
     }>(getSubgraphUrl(networkData), GET_TRANSACTIONS_QUERY(filter), {
       fromAddress: filter?.fromAddress,
       toAddress: filter?.toAddress,
@@ -172,6 +202,34 @@ export class TransactionUtils {
       return [];
     }
 
-    return transactions;
+    return transactions.map((transaction) => mapTransaction(transaction));
   }
 }
+
+function mapTransaction(t: TransactionData): ITransaction {
+  const internalTransactions: InternalTransaction[] = (
+    t.internalTransactions || []
+  ).map((itx) => ({
+    from: itx.from,
+    to: itx.to,
+    value: BigInt(itx.value),
+    method: itx.method,
+    receiver: itx.receiver,
+    escrow: itx.escrow,
+    token: itx.token,
+  }));
+
+  return {
+    block: BigInt(t.block),
+    txHash: t.txHash,
+    from: t.from,
+    to: t.to,
+    timestamp: Number(t.timestamp) * 1000,
+    value: BigInt(t.value),
+    method: t.method,
+    receiver: t.receiver,
+    escrow: t.escrow,
+    token: t.token,
+    internalTransactions,
+  };
+}

package/src/types.ts

@@ -143,83 +143,4 @@ export type NetworkData = {
   oldFactoryAddress: string;
 };
 
-/**
- * Represents the response data for an escrow withdrawal.
- */
-export type EscrowWithdraw = {
-  /**
-   * The hash of the transaction associated with the escrow withdrawal.
-   */
-  txHash: string;
-  /**
-   * The address of the token used for the withdrawal.
-   */
-  tokenAddress: string;
-  /**
-   * The amount withdrawn from the escrow.
-   */
-  withdrawnAmount: bigint;
-};
-
-/**
- * Represents a payout from an escrow.
- */
-export type Payout = {
-  /**
-   * Unique identifier of the payout.
-   */
-  id: string;
-  /**
-   * The address of the escrow associated with the payout.
-   */
-  escrowAddress: string;
-  /**
-   * The address of the recipient who received the payout.
-   */
-  recipient: string;
-  /**
-   * The amount paid to the recipient.
-   */
-  amount: bigint;
-  /**
-   * The timestamp when the payout was created (in UNIX format).
-   */
-  createdAt: number;
-};
-
-/**
- * Represents a cancellation refund event.
- */
-export type CancellationRefund = {
-  /**
-   * Unique identifier of the cancellation refund event.
-   */
-  id: string;
-  /**
-   * The address of the escrow associated with the cancellation refund.
-   */
-  escrowAddress: string;
-  /**
-   * The address of the receiver who received the refund.
-   */
-  receiver: string;
-  /**
-   * The amount refunded to the receiver.
-   */
-  amount: bigint;
-  /**
-   * The block number in which the cancellation refund event occurred.
-   */
-
-  block: number;
-  /**
-   * The timestamp when the cancellation refund event occurred (in UNIX format).
-   */
-  timestamp: number;
-  /**
-   * The transaction hash of the cancellation refund event.
-   */
-  txHash: string;
-};
-
 export type TransactionLikeWithNonce = TransactionLike & { nonce: number };

package/src/worker.ts

@@ -1,11 +1,12 @@
+import { ethers } from 'ethers';
 import gqlFetch from 'graphql-request';
 import { NETWORKS } from './constants';
 import { ChainId, OrderDirection } from './enums';
 import { ErrorInvalidAddress, ErrorUnsupportedChainID } from './error';
+import { WorkerData } from './graphql';
 import { GET_WORKER_QUERY, GET_WORKERS_QUERY } from './graphql/queries/worker';
 import { IWorker, IWorkersFilter } from './interfaces';
 import { getSubgraphUrl } from './utils';
-import { ethers } from 'ethers';
 
 export class WorkerUtils {
   /**
@@ -37,12 +38,14 @@ export class WorkerUtils {
     }
 
     const { worker } = await gqlFetch<{
-      worker: IWorker;
+      worker: WorkerData | null;
     }>(getSubgraphUrl(networkData), GET_WORKER_QUERY, {
       address: address.toLowerCase(),
     });
 
-    return worker || null;
+    if (!worker) return null;
+
+    return mapWorker(worker);
   }
 
   /**
@@ -65,7 +68,7 @@ export class WorkerUtils {
    * type IWorker = {
    *   id: string;
    *   address: string;
-   *   totalHMTAmountReceived: string;
+   *   totalHMTAmountReceived: bigint;
    *   payoutCount: number;
    * };
    * ```
@@ -102,7 +105,7 @@ export class WorkerUtils {
     }
 
     const { workers } = await gqlFetch<{
-      workers: IWorker[];
+      workers: WorkerData[];
     }>(getSubgraphUrl(networkData), GET_WORKERS_QUERY(filter), {
       address: filter?.address?.toLowerCase(),
       first: first,
@@ -115,6 +118,15 @@ export class WorkerUtils {
       return [];
     }
 
-    return workers;
+    return workers.map((w) => mapWorker(w));
   }
 }
+
+function mapWorker(w: WorkerData): IWorker {
+  return {
+    id: w.id,
+    address: w.address,
+    totalHMTAmountReceived: BigInt(w.totalHMTAmountReceived || 0),
+    payoutCount: Number(w.payoutCount || 0),
+  };
+}