@human-protocol/sdk 5.2.0 → 6.0.0

package/dist/statistics.js

@@ -1,52 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatisticsClient = void 0;
+exports.StatisticsUtils = void 0;
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const enums_1 = require("./enums");
 const graphql_1 = require("./graphql");
 const utils_1 = require("./utils");
 /**
- * ## Introduction
+ * Utility class for statistics-related queries.
  *
- * This client enables obtaining statistical information from the subgraph.
- *
- * 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)
- * ```
- *
- * ## Installation
- *
- * ### npm
- * ```bash
- * npm install @human-protocol/sdk
- * ```
- *
- * ### yarn
- * ```bash
- * yarn install @human-protocol/sdk
- * ```
- *
- * ## Code example
+ * Unlike other SDK clients, `StatisticsUtils` does not require `signer` or `provider` to be provided.
+ * We just need to pass the network data to each static method.
  *
+ * @example
  * ```ts
- * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
+ * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
  *
- * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
+ * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+ * const escrowStats = await StatisticsUtils.getEscrowStatistics(networkData);
+ * console.log('Total escrows:', escrowStats.totalEscrows);
  * ```
  */
-class StatisticsClient {
-    /**
-     * **StatisticsClient constructor**
-     *
-     * @param {NetworkData} networkData - The network information required to connect to the Statistics contract
-     */
-    constructor(networkData) {
-        this.networkData = networkData;
-        this.subgraphUrl = (0, utils_1.getSubgraphUrl)(networkData);
-    }
+class StatisticsUtils {
     /**
      * This function returns the statistical data of escrows.
      *
@@ -78,31 +52,37 @@ class StatisticsClient {
      * };
      * ```
      *
-     * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IEscrowStatistics>} Escrow statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param filter - Statistics params with duration data
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Escrow statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const escrowStatistics = await statisticsClient.getEscrowStatistics();
-     * const escrowStatisticsApril = await statisticsClient.getEscrowStatistics({
-     *    from: new Date('2021-04-01'),
-     *    to: new Date('2021-04-30'),
-     * });
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
+     *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const escrowStats = await StatisticsUtils.getEscrowStatistics(networkData);
+     * console.log('Total escrows:', escrowStats.totalEscrows);
+     *
+     * const escrowStatsApril = await StatisticsUtils.getEscrowStatistics(
+     *   networkData,
+     *   {
+     *     from: new Date('2021-04-01'),
+     *     to: new Date('2021-04-30'),
+     *   }
+     * );
+     * console.log('April escrows:', escrowStatsApril.totalEscrows);
      * ```
      */
-    async getEscrowStatistics(filter = {}, options) {
+    static async getEscrowStatistics(networkData, filter = {}, options) {
         try {
+            const subgraphUrl = (0, utils_1.getSubgraphUrl)(networkData);
             const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
             const skip = filter.skip || 0;
             const orderDirection = filter.orderDirection || enums_1.OrderDirection.ASC;
-            const { escrowStatistics } = await (0, utils_1.customGqlFetch)(this.subgraphUrl, graphql_1.GET_ESCROW_STATISTICS_QUERY, options);
-            const { eventDayDatas } = await (0, utils_1.customGqlFetch)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
+            const { escrowStatistics } = await (0, utils_1.customGqlFetch)(subgraphUrl, graphql_1.GET_ESCROW_STATISTICS_QUERY, options);
+            const { eventDayDatas } = await (0, utils_1.customGqlFetch)(subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
                 from: filter.from ? (0, utils_1.getUnixTimestamp)(filter.from) : undefined,
                 to: filter.to ? (0, utils_1.getUnixTimestamp)(filter.to) : undefined,
                 orderDirection: orderDirection,
@@ -153,30 +133,36 @@ class StatisticsClient {
      * };
      * ```
      *
-     * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IWorkerStatistics>} Worker statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param filter - Statistics params with duration data
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Worker statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const workerStatistics = await statisticsClient.getWorkerStatistics();
-     * const workerStatisticsApril = await statisticsClient.getWorkerStatistics({
-     *    from: new Date('2021-04-01'),
-     *    to: new Date('2021-04-30'),
-     * });
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
+     *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const workerStats = await StatisticsUtils.getWorkerStatistics(networkData);
+     * console.log('Daily workers data:', workerStats.dailyWorkersData);
+     *
+     * const workerStatsApril = await StatisticsUtils.getWorkerStatistics(
+     *   networkData,
+     *   {
+     *     from: new Date('2021-04-01'),
+     *     to: new Date('2021-04-30'),
+     *   }
+     * );
+     * console.log('April workers:', workerStatsApril.dailyWorkersData.length);
      * ```
      */
-    async getWorkerStatistics(filter = {}, options) {
+    static async getWorkerStatistics(networkData, filter = {}, options) {
         try {
+            const subgraphUrl = (0, utils_1.getSubgraphUrl)(networkData);
             const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
             const skip = filter.skip || 0;
             const orderDirection = filter.orderDirection || enums_1.OrderDirection.ASC;
-            const { eventDayDatas } = await (0, utils_1.customGqlFetch)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
+            const { eventDayDatas } = await (0, utils_1.customGqlFetch)(subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
                 from: filter.from ? (0, utils_1.getUnixTimestamp)(filter.from) : undefined,
                 to: filter.to ? (0, utils_1.getUnixTimestamp)(filter.to) : undefined,
                 orderDirection: orderDirection,
@@ -222,51 +208,43 @@ class StatisticsClient {
      * };
      * ```
      *
-     * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IPaymentStatistics>} Payment statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param filter - Statistics params with duration data
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Payment statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
      *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const paymentStats = await StatisticsUtils.getPaymentStatistics(networkData);
      * console.log(
      *   'Payment statistics:',
-     *   (await statisticsClient.getPaymentStatistics()).dailyPaymentsData.map(
-     *     (p) => ({
-     *       ...p,
-     *       totalAmountPaid: p.totalAmountPaid.toString(),
-     *       averageAmountPerJob: p.averageAmountPerJob.toString(),
-     *       averageAmountPerWorker: p.averageAmountPerWorker.toString(),
-     *     })
-     *   )
-     * );
-     *
-     * console.log(
-     *   'Payment statistics from 5/8 - 6/8:',
-     *   (
-     *     await statisticsClient.getPaymentStatistics({
-     *       from: new Date(2023, 4, 8),
-     *       to: new Date(2023, 5, 8),
-     *     })
-     *   ).dailyPaymentsData.map((p) => ({
+     *   paymentStats.dailyPaymentsData.map((p) => ({
      *     ...p,
      *     totalAmountPaid: p.totalAmountPaid.toString(),
-     *     averageAmountPerJob: p.averageAmountPerJob.toString(),
      *     averageAmountPerWorker: p.averageAmountPerWorker.toString(),
      *   }))
      * );
+     *
+     * const paymentStatsRange = await StatisticsUtils.getPaymentStatistics(
+     *   networkData,
+     *   {
+     *     from: new Date(2023, 4, 8),
+     *     to: new Date(2023, 5, 8),
+     *   }
+     * );
+     * console.log('Payment statistics from 5/8 - 6/8:', paymentStatsRange.dailyPaymentsData.length);
      * ```
      */
-    async getPaymentStatistics(filter = {}, options) {
+    static async getPaymentStatistics(networkData, filter = {}, options) {
         try {
+            const subgraphUrl = (0, utils_1.getSubgraphUrl)(networkData);
             const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
             const skip = filter.skip || 0;
             const orderDirection = filter.orderDirection || enums_1.OrderDirection.ASC;
-            const { eventDayDatas } = await (0, utils_1.customGqlFetch)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
+            const { eventDayDatas } = await (0, utils_1.customGqlFetch)(subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
                 from: filter.from ? (0, utils_1.getUnixTimestamp)(filter.from) : undefined,
                 to: filter.to ? (0, utils_1.getUnixTimestamp)(filter.to) : undefined,
                 orderDirection: orderDirection,
@@ -300,27 +278,26 @@ class StatisticsClient {
      * };
      * ```
      *
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IHMTStatistics>} HMToken statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param options - Optional configuration for subgraph requests.
+     * @returns HMToken statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const hmtStatistics = await statisticsClient.getHMTStatistics();
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
      *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const hmtStats = await StatisticsUtils.getHMTStatistics(networkData);
      * console.log('HMT statistics:', {
-     *   ...hmtStatistics,
-     *   totalTransferAmount: hmtStatistics.totalTransferAmount.toString(),
+     *   ...hmtStats,
+     *   totalTransferAmount: hmtStats.totalTransferAmount.toString(),
      * });
      * ```
      */
-    async getHMTStatistics(options) {
+    static async getHMTStatistics(networkData, options) {
         try {
-            const { hmtokenStatistics } = await (0, utils_1.customGqlFetch)(this.subgraphUrl, graphql_1.GET_HMTOKEN_STATISTICS_QUERY, options);
+            const subgraphUrl = (0, utils_1.getSubgraphUrl)(networkData);
+            const { hmtokenStatistics } = await (0, utils_1.customGqlFetch)(subgraphUrl, graphql_1.GET_HMTOKEN_STATISTICS_QUERY, options);
             return {
                 totalTransferAmount: BigInt(hmtokenStatistics.totalValueTransfered),
                 totalTransferCount: +hmtokenStatistics.totalTransferEventCount,
@@ -334,34 +311,31 @@ class StatisticsClient {
     /**
      * This function returns the holders of the HMToken with optional filters and ordering.
      *
-     * **Input parameters**
-     *
-     * @param {IHMTHoldersParams} params HMT Holders params with filters and ordering
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IHMTHolder[]>} List of HMToken holders.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param params - HMT Holders params with filters and ordering
+     * @param options - Optional configuration for subgraph requests.
+     * @returns List of HMToken holders.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
      *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const hmtHolders = await statisticsClient.getHMTHolders({
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const hmtHolders = await StatisticsUtils.getHMTHolders(networkData, {
      *   orderDirection: 'asc',
      * });
-     *
      * console.log('HMT holders:', hmtHolders.map((h) => ({
      *   ...h,
      *   balance: h.balance.toString(),
      * })));
      * ```
      */
-    async getHMTHolders(params = {}, options) {
+    static async getHMTHolders(networkData, params = {}, options) {
         try {
+            const subgraphUrl = (0, utils_1.getSubgraphUrl)(networkData);
             const { address, orderDirection } = params;
             const query = (0, graphql_1.GET_HOLDERS_QUERY)(address);
-            const { holders } = await (0, utils_1.customGqlFetch)(this.subgraphUrl, query, {
+            const { holders } = await (0, utils_1.customGqlFetch)(subgraphUrl, query, {
                 address,
                 orderBy: 'balance',
                 orderDirection,
@@ -400,35 +374,36 @@ class StatisticsClient {
      * }
      * ```
      *
-     * @param {IStatisticsFilter} filter Statistics params with duration data
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<IDailyHMT[]>} Daily HMToken statistics data.
-     *
-     * **Code example**
+     * @param networkData - The network information required to connect to the subgraph
+     * @param filter - Statistics params with duration data
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Daily HMToken statistics data.
      *
+     * @example
      * ```ts
-     * import { StatisticsClient, ChainId, NETWORKS } from '@human-protocol/sdk';
-     *
-     * const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
-     *
-     * const dailyHMTStats = await statisticsClient.getHMTStatistics();
+     * import { StatisticsUtils, ChainId, NETWORKS } from '@human-protocol/sdk';
      *
+     * const networkData = NETWORKS[ChainId.POLYGON_AMOY];
+     * const dailyHMTStats = await StatisticsUtils.getHMTDailyData(networkData);
      * console.log('Daily HMT statistics:', dailyHMTStats);
      *
-     * const hmtStatisticsRange = await statisticsClient.getHMTStatistics({
-     *   from: new Date(2023, 4, 8),
-     *   to: new Date(2023, 5, 8),
-     * });
-     *
-     * console.log('HMT statistics from 5/8 - 6/8:', hmtStatisticsRange);
+     * const hmtStatsRange = await StatisticsUtils.getHMTDailyData(
+     *   networkData,
+     *   {
+     *     from: new Date(2023, 4, 8),
+     *     to: new Date(2023, 5, 8),
+     *   }
+     * );
+     * console.log('HMT statistics from 5/8 - 6/8:', hmtStatsRange.length);
      * ```
      */
-    async getHMTDailyData(filter = {}, options) {
+    static async getHMTDailyData(networkData, filter = {}, options) {
         try {
+            const subgraphUrl = (0, utils_1.getSubgraphUrl)(networkData);
             const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
             const skip = filter.skip || 0;
             const orderDirection = filter.orderDirection || enums_1.OrderDirection.ASC;
-            const { eventDayDatas } = await (0, utils_1.customGqlFetch)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
+            const { eventDayDatas } = await (0, utils_1.customGqlFetch)(subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(filter), {
                 from: filter.from ? (0, utils_1.getUnixTimestamp)(filter.from) : undefined,
                 to: filter.to ? (0, utils_1.getUnixTimestamp)(filter.to) : undefined,
                 orderDirection: orderDirection,
@@ -448,4 +423,4 @@ class StatisticsClient {
         }
     }
 }
-exports.StatisticsClient = StatisticsClient;
+exports.StatisticsUtils = StatisticsUtils;

package/dist/transaction.d.ts

@@ -1,5 +1,19 @@
 import { ChainId } from './enums';
 import { ITransaction, ITransactionsFilter, SubgraphOptions } from './interfaces';
+/**
+ * Utility class for transaction-related queries.
+ *
+ * @example
+ * ```ts
+ * import { TransactionUtils, ChainId } from '@human-protocol/sdk';
+ *
+ * const transaction = await TransactionUtils.getTransaction(
+ *   ChainId.POLYGON_AMOY,
+ *   '0x62dD51230A30401C455c8398d06F85e4EaB6309f'
+ * );
+ * console.log('Transaction:', transaction);
+ * ```
+ */
 export declare class TransactionUtils {
     /**
      * This function returns the transaction data for the given hash.
@@ -32,17 +46,22 @@ export declare class TransactionUtils {
      * };
      * ```
      *
-     * @param {ChainId} chainId The chain ID.
-     * @param {string} hash The transaction hash.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<ITransaction | null>} - Returns the transaction details or null if not found.
-     *
-     * **Code example**
+     * @param chainId - The chain ID.
+     * @param hash - The transaction hash.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Returns the transaction details or null if not found.
+     * @throws ErrorInvalidHashProvided If the hash is invalid
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
      *
+     * @example
      * ```ts
      * import { TransactionUtils, ChainId } from '@human-protocol/sdk';
      *
-     * const transaction = await TransactionUtils.getTransaction(ChainId.POLYGON, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * const transaction = await TransactionUtils.getTransaction(
+     *   ChainId.POLYGON_AMOY,
+     *   '0x62dD51230A30401C455c8398d06F85e4EaB6309f'
+     * );
+     * console.log('Transaction:', transaction);
      * ```
      */
     static getTransaction(chainId: ChainId, hash: string, options?: SubgraphOptions): Promise<ITransaction | null>;
@@ -69,7 +88,7 @@ export declare 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 = {
@@ -99,17 +118,18 @@ export declare class TransactionUtils {
      * };
      * ```
      *
-     * @param {ITransactionsFilter} filter Filter for the transactions.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<ITransaction[]>} Returns an array with all the transaction details.
-     *
-     * **Code example**
+     * @param filter - Filter for the transactions.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Returns an array with all the transaction details.
+     * @throws ErrorCannotUseDateAndBlockSimultaneously If both date and block filters are used
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
      *
+     * @example
      * ```ts
      * import { TransactionUtils, ChainId, OrderDirection } from '@human-protocol/sdk';
      *
-     * const filter: ITransactionsFilter = {
-     *   chainId: ChainId.POLYGON,
+     * const filter = {
+     *   chainId: ChainId.POLYGON_AMOY,
      *   startDate: new Date('2022-01-01'),
      *   endDate: new Date('2022-12-31'),
      *   first: 10,
@@ -117,6 +137,7 @@ export declare class TransactionUtils {
      *   orderDirection: OrderDirection.DESC,
      * };
      * const transactions = await TransactionUtils.getTransactions(filter);
+     * console.log('Transactions:', transactions.length);
      * ```
      */
     static getTransactions(filter: ITransactionsFilter, options?: SubgraphOptions): Promise<ITransaction[]>;

package/dist/transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAWlD,OAAO,EAEL,YAAY,EACZ,mBAAmB,EACnB,eAAe,EAChB,MAAM,cAAc,CAAC;AAGtB,qBAAa,gBAAgB;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAyB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwEG;WACiB,eAAe,CACjC,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,YAAY,EAAE,CAAC;CAgD3B"}
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAWlD,OAAO,EAEL,YAAY,EACZ,mBAAmB,EACnB,eAAe,EAChB,MAAM,cAAc,CAAC;AAGtB;;;;;;;;;;;;;GAaG;AACH,qBAAa,gBAAgB;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAyB/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0EG;WACiB,eAAe,CACjC,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,YAAY,EAAE,CAAC;CAgD3B"}

package/dist/transaction.js

@@ -7,6 +7,20 @@ const enums_1 = require("./enums");
 const error_1 = require("./error");
 const transaction_1 = require("./graphql/queries/transaction");
 const utils_1 = require("./utils");
+/**
+ * Utility class for transaction-related queries.
+ *
+ * @example
+ * ```ts
+ * import { TransactionUtils, ChainId } from '@human-protocol/sdk';
+ *
+ * const transaction = await TransactionUtils.getTransaction(
+ *   ChainId.POLYGON_AMOY,
+ *   '0x62dD51230A30401C455c8398d06F85e4EaB6309f'
+ * );
+ * console.log('Transaction:', transaction);
+ * ```
+ */
 class TransactionUtils {
     /**
      * This function returns the transaction data for the given hash.
@@ -39,17 +53,22 @@ class TransactionUtils {
      * };
      * ```
      *
-     * @param {ChainId} chainId The chain ID.
-     * @param {string} hash The transaction hash.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<ITransaction | null>} - Returns the transaction details or null if not found.
-     *
-     * **Code example**
+     * @param chainId - The chain ID.
+     * @param hash - The transaction hash.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Returns the transaction details or null if not found.
+     * @throws ErrorInvalidHashProvided If the hash is invalid
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
      *
+     * @example
      * ```ts
      * import { TransactionUtils, ChainId } from '@human-protocol/sdk';
      *
-     * const transaction = await TransactionUtils.getTransaction(ChainId.POLYGON, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * const transaction = await TransactionUtils.getTransaction(
+     *   ChainId.POLYGON_AMOY,
+     *   '0x62dD51230A30401C455c8398d06F85e4EaB6309f'
+     * );
+     * console.log('Transaction:', transaction);
      * ```
      */
     static async getTransaction(chainId, hash, options) {
@@ -90,7 +109,7 @@ 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 = {
@@ -120,17 +139,18 @@ class TransactionUtils {
      * };
      * ```
      *
-     * @param {ITransactionsFilter} filter Filter for the transactions.
-     * @param {SubgraphOptions} options Optional configuration for subgraph requests.
-     * @returns {Promise<ITransaction[]>} Returns an array with all the transaction details.
-     *
-     * **Code example**
+     * @param filter - Filter for the transactions.
+     * @param options - Optional configuration for subgraph requests.
+     * @returns Returns an array with all the transaction details.
+     * @throws ErrorCannotUseDateAndBlockSimultaneously If both date and block filters are used
+     * @throws ErrorUnsupportedChainID If the chain ID is not supported
      *
+     * @example
      * ```ts
      * import { TransactionUtils, ChainId, OrderDirection } from '@human-protocol/sdk';
      *
-     * const filter: ITransactionsFilter = {
-     *   chainId: ChainId.POLYGON,
+     * const filter = {
+     *   chainId: ChainId.POLYGON_AMOY,
      *   startDate: new Date('2022-01-01'),
      *   endDate: new Date('2022-12-31'),
      *   first: 10,
@@ -138,6 +158,7 @@ class TransactionUtils {
      *   orderDirection: OrderDirection.DESC,
      * };
      * const transactions = await TransactionUtils.getTransactions(filter);
+     * console.log('Transactions:', transactions.length);
      * ```
      */
     static async getTransactions(filter, options) {

package/dist/types.d.ts

@@ -34,60 +34,6 @@ export declare enum EscrowStatus {
      */
     ToCancel = 6
 }
-/**
- * AWS/GCP cloud storage access data
- * @readonly
- * @deprecated StorageClient is deprecated. Use Minio.Client directly.
- */
-export type StorageCredentials = {
-    /**
-     * Access Key
-     */
-    accessKey: string;
-    /**
-     * Secret Key
-     */
-    secretKey: string;
-};
-/**
- * @deprecated StorageClient is deprecated. Use Minio.Client directly.
- */
-export type StorageParams = {
-    /**
-     * Request endPoint
-     */
-    endPoint: string;
-    /**
-     * Enable secure (HTTPS) access. Default value set to false
-     */
-    useSSL: boolean;
-    /**
-     * Region
-     */
-    region?: string;
-    /**
-     * TCP/IP port number. Default value set to 80 for HTTP and 443 for HTTPs
-     */
-    port?: number;
-};
-/**
- * Upload file data
- * @readonly
- */
-export type UploadFile = {
-    /**
-     * Uploaded object key
-     */
-    key: string;
-    /**
-     * Uploaded object URL
-     */
-    url: string;
-    /**
-     * Hash of uploaded object key
-     */
-    hash: string;
-};
 /**
  * Network data
  */

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEzC;;;;GAIG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,SAAS,IAAA;IACT;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEzC;;;;GAIG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,SAAS,IAAA;IACT;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}