@human-protocol/sdk 4.0.3-beta → 4.1.0

package/dist/escrow.d.ts

@@ -1,9 +1,9 @@
 import { ContractRunner, Overrides } from 'ethers';
 import { BaseEthersClient } from './base';
-import { ChainId, OrderDirection } from './enums';
+import { ChainId } from './enums';
 import { EscrowData, StatusEvent } from './graphql';
-import { IEscrowConfig, IEscrowsFilter } from './interfaces';
-import { EscrowCancel, EscrowStatus, EscrowWithdraw, NetworkData, TransactionLikeWithNonce } from './types';
+import { IEscrowConfig, IEscrowsFilter, IPayoutFilter, IStatusEventFilter } from './interfaces';
+import { EscrowCancel, EscrowStatus, EscrowWithdraw, NetworkData, TransactionLikeWithNonce, Payout } from './types';
 /**
  * ## Introduction
  *
@@ -895,14 +895,7 @@ export declare class EscrowUtils {
      * };
      * ```
      *
-     * @param {ChainId} chainId - List of network IDs to query for status events.
-     * @param {EscrowStatus[]} [statuses] - Optional array of statuses to query for. If not provided, queries for all statuses.
-     * @param {Date} [from] - Optional start date to filter events.
-     * @param {Date} [to] - Optional end date to filter events.
-     * @param {string} [launcher] - Optional launcher address to filter events. Must be a valid Ethereum address.
-     * @param {number} [first] - Optional number of transactions per page. Default is 10.
-     * @param {number} [skip] - Optional number of transactions to skip. Default is 0.
-     * @param {OrderDirection} [orderDirection] - Optional order of the results. Default is DESC.
+     * @param {IStatusEventFilter} filter Filter parameters.
      * @returns {Promise<StatusEvent[]>} - Array of status events with their corresponding statuses.
      *
      * **Code example**
@@ -913,16 +906,43 @@ export declare class EscrowUtils {
      * (async () => {
      *   const fromDate = new Date('2023-01-01');
      *   const toDate = new Date('2023-12-31');
-     *   const statusEvents = await EscrowUtils.getStatusEvents(
-     *     [ChainId.POLYGON, ChainId.MAINNET],
-     *     [EscrowStatus.Pending, EscrowStatus.Complete],
-     *     fromDate,
-     *     toDate
-     *   );
+     *   const statusEvents = await EscrowUtils.getStatusEvents({
+     *     chainId: ChainId.POLYGON,
+     *     statuses: [EscrowStatus.Pending, EscrowStatus.Complete],
+     *     from: fromDate,
+     *     to: toDate
+     *   });
      *   console.log(statusEvents);
      * })();
      * ```
      */
-    static getStatusEvents(chainId: ChainId, statuses?: EscrowStatus[], from?: Date, to?: Date, launcher?: string, first?: number, skip?: number, orderDirection?: OrderDirection): Promise<StatusEvent[]>;
+    static getStatusEvents(filter: IStatusEventFilter): Promise<StatusEvent[]>;
+    /**
+     * This function returns the payouts for a given set of networks.
+     *
+     * > This uses Subgraph
+     *
+     * **Input parameters**
+     * Fetch payouts from the subgraph.
+     *
+     * @param {IPayoutFilter} filter Filter parameters.
+     * @returns {Promise<Payout[]>} List of payouts matching the filters.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
+     *
+     * const payouts = await EscrowUtils.getPayouts({
+     *   chainId: ChainId.POLYGON,
+     *   escrowAddress: '0x1234567890123456789012345678901234567890',
+     *   recipient: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
+     *   from: new Date('2023-01-01'),
+     *   to: new Date('2023-12-31')
+     * });
+     * console.log(payouts);
+     * ```
+     */
+    static getPayouts(filter: IPayoutFilter): Promise<Payout[]>;
 }
 //# sourceMappingURL=escrow.d.ts.map

package/dist/escrow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,cAAc,EAAY,SAAS,EAAkB,MAAM,QAAQ,CAAC;AAE7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AA0BlD,OAAO,EACL,UAAU,EAIV,WAAW,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,WAAW,EACX,wBAAwB,EACzB,MAAM,SAAS,CAAC;AAQjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,OAAO,CAAC,qBAAqB,CAAgB;IAE7C;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAiBxE;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,EACtB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,EAC3B,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA+EhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,EACxB,IAAI,EAAE,MAAM,EACZ,aAAa,UAAQ,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA6ChB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,YAAY,CAAC;IAsDxB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,EACzB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,cAAc,CAAC;IA0D1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IAEG,2BAA2B,CAC/B,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,EACxB,IAAI,EAAE,MAAM,EACZ,aAAa,UAAQ,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,wBAAwB,CAAC;YAuDtB,4BAA4B;IA6D1C;;;;;;;;;;;;;;;;;;;OAmBG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAwBxD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB5D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBnE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBtE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBhE;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+FG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC;IA2DxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,UAAU,CAAC;IAoBtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;WAEiB,eAAe,CACjC,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,YAAY,EAAE,EACzB,IAAI,CAAC,EAAE,IAAI,EACX,EAAE,CAAC,EAAE,IAAI,EACT,QAAQ,CAAC,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,cAAc,GAC9B,OAAO,CAAC,WAAW,EAAE,CAAC;CAuD1B"}
+{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,cAAc,EAAY,SAAS,EAAkB,MAAM,QAAQ,CAAC;AAE7E,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AA0BlD,OAAO,EACL,UAAU,EAKV,WAAW,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,aAAa,EACb,cAAc,EACd,aAAa,EACb,kBAAkB,EACnB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,WAAW,EACX,wBAAwB,EACxB,MAAM,EACP,MAAM,SAAS,CAAC;AAQjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,OAAO,CAAC,qBAAqB,CAAgB;IAE7C;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAiBxE;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,EACtB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,EAC3B,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA+EhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,EACxB,IAAI,EAAE,MAAM,EACZ,aAAa,UAAQ,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA6ChB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,YAAY,CAAC;IAsDxB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,EACzB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,cAAc,CAAC;IA0D1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IAEG,2BAA2B,CAC/B,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,EACxB,IAAI,EAAE,MAAM,EACZ,aAAa,UAAQ,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,wBAAwB,CAAC;YAuDtB,4BAA4B;IA6D1C;;;;;;;;;;;;;;;;;;;OAmBG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAwBxD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB5D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBnE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBtE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBhE;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+FG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC;IA2DxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwDG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,UAAU,CAAC;IAoBtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;WACiB,eAAe,CACjC,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,WAAW,EAAE,CAAC;IA+DzB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,UAAU,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAiCzE"}

package/dist/escrow.js

@@ -1536,14 +1536,7 @@ class EscrowUtils {
      * };
      * ```
      *
-     * @param {ChainId} chainId - List of network IDs to query for status events.
-     * @param {EscrowStatus[]} [statuses] - Optional array of statuses to query for. If not provided, queries for all statuses.
-     * @param {Date} [from] - Optional start date to filter events.
-     * @param {Date} [to] - Optional end date to filter events.
-     * @param {string} [launcher] - Optional launcher address to filter events. Must be a valid Ethereum address.
-     * @param {number} [first] - Optional number of transactions per page. Default is 10.
-     * @param {number} [skip] - Optional number of transactions to skip. Default is 0.
-     * @param {OrderDirection} [orderDirection] - Optional order of the results. Default is DESC.
+     * @param {IStatusEventFilter} filter Filter parameters.
      * @returns {Promise<StatusEvent[]>} - Array of status events with their corresponding statuses.
      *
      * **Code example**
@@ -1554,23 +1547,25 @@ class EscrowUtils {
      * (async () => {
      *   const fromDate = new Date('2023-01-01');
      *   const toDate = new Date('2023-12-31');
-     *   const statusEvents = await EscrowUtils.getStatusEvents(
-     *     [ChainId.POLYGON, ChainId.MAINNET],
-     *     [EscrowStatus.Pending, EscrowStatus.Complete],
-     *     fromDate,
-     *     toDate
-     *   );
+     *   const statusEvents = await EscrowUtils.getStatusEvents({
+     *     chainId: ChainId.POLYGON,
+     *     statuses: [EscrowStatus.Pending, EscrowStatus.Complete],
+     *     from: fromDate,
+     *     to: toDate
+     *   });
      *   console.log(statusEvents);
      * })();
      * ```
      */
-    static async getStatusEvents(chainId, statuses, from, to, launcher, first, skip, orderDirection) {
+    static async getStatusEvents(filter) {
+        const { chainId, statuses, from, to, launcher, first = 10, skip = 0, orderDirection = enums_1.OrderDirection.DESC, } = filter;
         if (launcher && !ethers_1.ethers.isAddress(launcher)) {
             throw error_1.ErrorInvalidAddress;
         }
-        first = first !== undefined ? Math.min(first, 1000) : 10;
-        skip = skip || 0;
-        orderDirection = orderDirection || enums_1.OrderDirection.DESC;
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
         // If statuses are not provided, use all statuses except Launched
         const effectiveStatuses = statuses ?? [
             types_1.EscrowStatus.Launched,
@@ -1580,19 +1575,15 @@ class EscrowUtils {
             types_1.EscrowStatus.Complete,
             types_1.EscrowStatus.Cancelled,
         ];
-        const networkData = constants_1.NETWORKS[chainId];
-        if (!networkData) {
-            throw error_1.ErrorUnsupportedChainID;
-        }
         const statusNames = effectiveStatuses.map((status) => types_1.EscrowStatus[status]);
         const data = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, graphql_1.GET_STATUS_UPDATES_QUERY)(from, to, launcher), {
             status: statusNames,
             from: from ? (0, utils_1.getUnixTimestamp)(from) : undefined,
             to: to ? (0, utils_1.getUnixTimestamp)(to) : undefined,
             launcher: launcher || undefined,
-            orderDirection: orderDirection,
-            first: first,
-            skip: skip,
+            orderDirection,
+            first: Math.min(first, 1000),
+            skip,
         });
         if (!data || !data['escrowStatusEvents']) {
             return [];
@@ -1604,5 +1595,56 @@ class EscrowUtils {
         }));
         return eventsWithChainId;
     }
+    /**
+     * This function returns the payouts for a given set of networks.
+     *
+     * > This uses Subgraph
+     *
+     * **Input parameters**
+     * Fetch payouts from the subgraph.
+     *
+     * @param {IPayoutFilter} filter Filter parameters.
+     * @returns {Promise<Payout[]>} List of payouts matching the filters.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
+     *
+     * const payouts = await EscrowUtils.getPayouts({
+     *   chainId: ChainId.POLYGON,
+     *   escrowAddress: '0x1234567890123456789012345678901234567890',
+     *   recipient: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
+     *   from: new Date('2023-01-01'),
+     *   to: new Date('2023-12-31')
+     * });
+     * console.log(payouts);
+     * ```
+     */
+    static async getPayouts(filter) {
+        const networkData = constants_1.NETWORKS[filter.chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        if (filter.escrowAddress && !ethers_1.ethers.isAddress(filter.escrowAddress)) {
+            throw error_1.ErrorInvalidAddress;
+        }
+        if (filter.recipient && !ethers_1.ethers.isAddress(filter.recipient)) {
+            throw error_1.ErrorInvalidAddress;
+        }
+        const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+        const skip = filter.skip || 0;
+        const orderDirection = filter.orderDirection || enums_1.OrderDirection.DESC;
+        const { payouts } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, graphql_1.GET_PAYOUTS_QUERY)(filter), {
+            escrowAddress: filter.escrowAddress?.toLowerCase(),
+            recipient: filter.recipient?.toLowerCase(),
+            from: filter.from ? (0, utils_1.getUnixTimestamp)(filter.from) : undefined,
+            to: filter.to ? (0, utils_1.getUnixTimestamp)(filter.to) : undefined,
+            first: Math.min(first, 1000),
+            skip,
+            orderDirection,
+        });
+        return payouts || [];
+    }
 }
 exports.EscrowUtils = EscrowUtils;

package/dist/graphql/queries/payout.d.ts

@@ -1,3 +1,3 @@
-import { IPayoutFilter } from '../../interfaces';
+import { IPayoutFilter } from 'src/interfaces';
 export declare const GET_PAYOUTS_QUERY: (filter: IPayoutFilter) => import("graphql").DocumentNode;
 //# sourceMappingURL=payout.d.ts.map

package/dist/graphql/queries/payout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payout.d.ts","sourceRoot":"","sources":["../../../src/graphql/queries/payout.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAYjD,eAAO,MAAM,iBAAiB,WAAY,aAAa,mCAiCtD,CAAC"}
+{"version":3,"file":"payout.d.ts","sourceRoot":"","sources":["../../../src/graphql/queries/payout.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAY/C,eAAO,MAAM,iBAAiB,WAAY,aAAa,mCAkCtD,CAAC"}

package/dist/graphql/queries/payout.js

@@ -23,9 +23,6 @@ const GET_PAYOUTS_QUERY = (filter) => {
       ${from ? `createdAt_gte: $from` : ''}
       ${to ? `createdAt_lt: $to` : ''}
     }
-  `;
-    const LIMIT_CLAUSE = `
-    first: 1000
   `;
     return (0, graphql_tag_1.default) `
     query getPayouts(
@@ -33,12 +30,16 @@ const GET_PAYOUTS_QUERY = (filter) => {
       $recipient: String
       $from: Int
       $to: Int
+      $first: Int
+      $skip: Int
+      $orderDirection: String
     ) {
       payouts(
         ${WHERE_CLAUSE}
         orderBy: createdAt,
-        orderDirection: desc,
-        ${LIMIT_CLAUSE}
+        orderDirection: $orderDirection,
+        first: $first,
+        skip: $skip
       ) {
         ...PayoutFields
       }

package/dist/graphql/queries/worker.d.ts

@@ -0,0 +1,4 @@
+import { IWorkersFilter } from '../../interfaces';
+export declare const GET_WORKER_QUERY: import("graphql").DocumentNode;
+export declare const GET_WORKERS_QUERY: (filter: IWorkersFilter) => import("graphql").DocumentNode;
+//# sourceMappingURL=worker.d.ts.map

package/dist/graphql/queries/worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../../../src/graphql/queries/worker.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,eAAO,MAAM,gBAAgB,gCAS5B,CAAC;AAEF,eAAO,MAAM,iBAAiB,WAAY,cAAc,mCA0BvD,CAAC"}

package/dist/graphql/queries/worker.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GET_WORKERS_QUERY = exports.GET_WORKER_QUERY = void 0;
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+exports.GET_WORKER_QUERY = (0, graphql_tag_1.default) `
+  query GetWorker($address: String!) {
+    worker(id: $address) {
+      id
+      address
+      totalAmountReceived
+      payoutCount
+    }
+  }
+`;
+const GET_WORKERS_QUERY = (filter) => {
+    const { address } = filter;
+    return (0, graphql_tag_1.default) `
+  query GetWorkers(
+    $address: String
+    $first: Int
+    $skip: Int
+    $orderBy: String
+    $orderDirection: String
+  ) {
+    workers(
+      where: {
+        ${address ? 'address: $address,' : ''}
+      }
+      first: $first
+      skip: $skip
+      orderBy: $orderBy
+      orderDirection: $orderDirection
+    ) {
+      id
+      address
+      totalAmountReceived
+      payoutCount
+    }
+  }`;
+};
+exports.GET_WORKERS_QUERY = GET_WORKERS_QUERY;

package/dist/index.d.ts

@@ -6,9 +6,10 @@ import { StatisticsClient } from './statistics';
 import { Encryption, EncryptionUtils } from './encryption';
 import { OperatorUtils } from './operator';
 import { TransactionUtils } from './transaction';
+import { WorkerUtils } from './worker';
 export * from './constants';
 export * from './types';
 export * from './enums';
 export * from './interfaces';
-export { StakingClient, StorageClient, KVStoreClient, KVStoreUtils, EscrowClient, EscrowUtils, StatisticsClient, Encryption, EncryptionUtils, OperatorUtils, TransactionUtils, };
+export { StakingClient, StorageClient, KVStoreClient, KVStoreUtils, EscrowClient, EscrowUtils, StatisticsClient, Encryption, EncryptionUtils, OperatorUtils, TransactionUtils, WorkerUtils, };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEjD,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAE7B,OAAO,EACL,aAAa,EACb,aAAa,EACb,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,aAAa,EACb,gBAAgB,GACjB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAE7B,OAAO,EACL,aAAa,EACb,aAAa,EACb,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,WAAW,GACZ,CAAC"}

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransactionUtils = exports.OperatorUtils = exports.EncryptionUtils = exports.Encryption = exports.StatisticsClient = exports.EscrowUtils = exports.EscrowClient = exports.KVStoreUtils = exports.KVStoreClient = exports.StorageClient = exports.StakingClient = void 0;
+exports.WorkerUtils = exports.TransactionUtils = exports.OperatorUtils = exports.EncryptionUtils = exports.Encryption = exports.StatisticsClient = exports.EscrowUtils = exports.EscrowClient = exports.KVStoreUtils = exports.KVStoreClient = exports.StorageClient = exports.StakingClient = void 0;
 const staking_1 = require("./staking");
 Object.defineProperty(exports, "StakingClient", { enumerable: true, get: function () { return staking_1.StakingClient; } });
 const storage_1 = require("./storage");
@@ -34,6 +34,8 @@ const operator_1 = require("./operator");
 Object.defineProperty(exports, "OperatorUtils", { enumerable: true, get: function () { return operator_1.OperatorUtils; } });
 const transaction_1 = require("./transaction");
 Object.defineProperty(exports, "TransactionUtils", { enumerable: true, get: function () { return transaction_1.TransactionUtils; } });
+const worker_1 = require("./worker");
+Object.defineProperty(exports, "WorkerUtils", { enumerable: true, get: function () { return worker_1.WorkerUtils; } });
 __exportStar(require("./constants"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./enums"), exports);

package/dist/interfaces.d.ts

@@ -90,7 +90,8 @@ export interface IStatisticsFilter extends IPagination {
 export interface IHMTHoldersParams extends IPagination {
     address?: string;
 }
-export interface IPayoutFilter {
+export interface IPayoutFilter extends IPagination {
+    chainId: ChainId;
     escrowAddress?: string;
     recipient?: string;
     from?: Date;
@@ -142,4 +143,22 @@ export interface StakerInfo {
     lockedUntil: bigint;
     withdrawableAmount: bigint;
 }
+export interface IStatusEventFilter extends IPagination {
+    chainId: ChainId;
+    statuses?: EscrowStatus[];
+    from?: Date;
+    to?: Date;
+    launcher?: string;
+}
+export interface IWorker {
+    id: string;
+    address: string;
+    totalAmountReceived: number;
+    payoutCount: number;
+}
+export interface IWorkersFilter extends IPagination {
+    chainId: ChainId;
+    address?: string;
+    orderBy?: string;
+}
 //# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBACf,SAAQ,IAAI,CAAC,SAAS,EAAE,UAAU,GAAG,oBAAoB,GAAG,SAAS,CAAC;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,0BACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAC7C,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,MAAM,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBACf,SAAQ,IAAI,CAAC,SAAS,EAAE,UAAU,GAAG,oBAAoB,GAAG,SAAS,CAAC;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,0BACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC;IAC7C,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB,EAAE,mBAAmB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types.d.ts

@@ -163,6 +163,31 @@ export type EscrowWithdraw = {
      */
     amountWithdrawn: 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;
+};
 export type TransactionLikeWithNonce = TransactionLike & {
     nonce: number;
 };

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;CACV;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;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,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;CACV;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;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/worker.d.ts

@@ -0,0 +1,63 @@
+import { ChainId } from './enums';
+import { IWorker, IWorkersFilter } from './interfaces';
+export declare class WorkerUtils {
+    /**
+     * This function returns the worker data for the given address.
+     *
+     * @param {ChainId} chainId The chain ID.
+     * @param {string} address The worker address.
+     * @returns {Promise<IWorker>} Returns the worker details.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const worker = await WorkerUtils.getWorker(ChainId.POLYGON, '0x1234567890abcdef1234567890abcdef12345678');
+     * ```
+     */
+    static getWorker(chainId: ChainId, address: string): Promise<IWorker | null>;
+    /**
+     * This function returns all worker details based on the provided filter.
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * interface IWorkersFilter {
+     *   chainId: ChainId; // List of chain IDs to query.
+     *   address?: string; // (Optional) The worker address to filter by.
+     *   orderBy?: string; // (Optional) The field to order by. Default is 'payoutCount'.
+     *   orderDirection?: OrderDirection; // (Optional) The direction of the order. Default is 'DESC'.
+     *   first?: number; // (Optional) Number of workers per page. Default is 10.
+     *   skip?: number; // (Optional) Number of workers to skip. Default is 0.
+     * }
+     * ```
+     *
+     * ```ts
+     * type IWorker = {
+     *   id: string;
+     *   address: string;
+     *   totalAmountReceived: string;
+     *   payoutCount: number;
+     * };
+     * ```
+     *
+     * @param {IWorkersFilter} filter Filter for the workers.
+     * @returns {Promise<IWorker[]>} Returns an array with all the worker details.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const filter: IWorkersFilter = {
+     *   chainId: ChainId.POLYGON,
+     *   first: 10,
+     *   skip: 0,
+     * };
+     * const workers = await WorkerUtils.getWorkers(filter);
+     * ```
+     */
+    static getWorkers(filter: IWorkersFilter): Promise<IWorker[]>;
+}
+//# sourceMappingURL=worker.d.ts.map

package/dist/worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../src/worker.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAkB,MAAM,SAAS,CAAC;AAGlD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAIvD,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAmB1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;WACiB,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CA+B3E"}

package/dist/worker.js

@@ -0,0 +1,109 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkerUtils = void 0;
+const graphql_request_1 = __importDefault(require("graphql-request"));
+const constants_1 = require("./constants");
+const enums_1 = require("./enums");
+const error_1 = require("./error");
+const worker_1 = require("./graphql/queries/worker");
+const utils_1 = require("./utils");
+const ethers_1 = require("ethers");
+class WorkerUtils {
+    /**
+     * This function returns the worker data for the given address.
+     *
+     * @param {ChainId} chainId The chain ID.
+     * @param {string} address The worker address.
+     * @returns {Promise<IWorker>} Returns the worker details.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const worker = await WorkerUtils.getWorker(ChainId.POLYGON, '0x1234567890abcdef1234567890abcdef12345678');
+     * ```
+     */
+    static async getWorker(chainId, address) {
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        if (!ethers_1.ethers.isAddress(address)) {
+            throw error_1.ErrorInvalidAddress;
+        }
+        const { worker } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), worker_1.GET_WORKER_QUERY, {
+            address: address.toLowerCase(),
+        });
+        return worker || null;
+    }
+    /**
+     * This function returns all worker details based on the provided filter.
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * interface IWorkersFilter {
+     *   chainId: ChainId; // List of chain IDs to query.
+     *   address?: string; // (Optional) The worker address to filter by.
+     *   orderBy?: string; // (Optional) The field to order by. Default is 'payoutCount'.
+     *   orderDirection?: OrderDirection; // (Optional) The direction of the order. Default is 'DESC'.
+     *   first?: number; // (Optional) Number of workers per page. Default is 10.
+     *   skip?: number; // (Optional) Number of workers to skip. Default is 0.
+     * }
+     * ```
+     *
+     * ```ts
+     * type IWorker = {
+     *   id: string;
+     *   address: string;
+     *   totalAmountReceived: string;
+     *   payoutCount: number;
+     * };
+     * ```
+     *
+     * @param {IWorkersFilter} filter Filter for the workers.
+     * @returns {Promise<IWorker[]>} Returns an array with all the worker details.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const filter: IWorkersFilter = {
+     *   chainId: ChainId.POLYGON,
+     *   first: 10,
+     *   skip: 0,
+     * };
+     * const workers = await WorkerUtils.getWorkers(filter);
+     * ```
+     */
+    static async getWorkers(filter) {
+        const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+        const skip = filter.skip || 0;
+        const orderBy = filter.orderBy || 'payoutCount';
+        const orderDirection = filter.orderDirection || enums_1.OrderDirection.DESC;
+        const networkData = constants_1.NETWORKS[filter.chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        if (filter.address && !ethers_1.ethers.isAddress(filter.address)) {
+            throw error_1.ErrorInvalidAddress;
+        }
+        const { workers } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, worker_1.GET_WORKERS_QUERY)(filter), {
+            address: filter?.address?.toLowerCase(),
+            first: first,
+            skip: skip,
+            orderBy: orderBy,
+            orderDirection: orderDirection,
+        });
+        if (!workers) {
+            return [];
+        }
+        return workers;
+    }
+}
+exports.WorkerUtils = WorkerUtils;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "4.0.3-beta",
+  "version": "4.1.0",
   "files": [
     "src",
     "dist"
@@ -47,7 +47,7 @@
     "minio": "7.1.3",
     "openpgp": "^5.11.2",
     "secp256k1": "^5.0.1",
-    "vitest": "^1.6.0"
+    "vitest": "^3.0.9"
   },
   "devDependencies": {
     "typedoc": "^0.27.5",

package/src/escrow.ts

@@ -44,16 +44,23 @@ import {
   EscrowData,
   GET_ESCROWS_QUERY,
   GET_ESCROW_BY_ADDRESS_QUERY,
+  GET_PAYOUTS_QUERY,
   GET_STATUS_UPDATES_QUERY,
   StatusEvent,
 } from './graphql';
-import { IEscrowConfig, IEscrowsFilter } from './interfaces';
+import {
+  IEscrowConfig,
+  IEscrowsFilter,
+  IPayoutFilter,
+  IStatusEventFilter,
+} from './interfaces';
 import {
   EscrowCancel,
   EscrowStatus,
   EscrowWithdraw,
   NetworkData,
   TransactionLikeWithNonce,
+  Payout,
 } from './types';
 import {
   getSubgraphUrl,
@@ -1828,14 +1835,7 @@ export class EscrowUtils {
    * };
    * ```
    *
-   * @param {ChainId} chainId - List of network IDs to query for status events.
-   * @param {EscrowStatus[]} [statuses] - Optional array of statuses to query for. If not provided, queries for all statuses.
-   * @param {Date} [from] - Optional start date to filter events.
-   * @param {Date} [to] - Optional end date to filter events.
-   * @param {string} [launcher] - Optional launcher address to filter events. Must be a valid Ethereum address.
-   * @param {number} [first] - Optional number of transactions per page. Default is 10.
-   * @param {number} [skip] - Optional number of transactions to skip. Default is 0.
-   * @param {OrderDirection} [orderDirection] - Optional order of the results. Default is DESC.
+   * @param {IStatusEventFilter} filter Filter parameters.
    * @returns {Promise<StatusEvent[]>} - Array of status events with their corresponding statuses.
    *
    * **Code example**
@@ -1846,34 +1846,38 @@ export class EscrowUtils {
    * (async () => {
    *   const fromDate = new Date('2023-01-01');
    *   const toDate = new Date('2023-12-31');
-   *   const statusEvents = await EscrowUtils.getStatusEvents(
-   *     [ChainId.POLYGON, ChainId.MAINNET],
-   *     [EscrowStatus.Pending, EscrowStatus.Complete],
-   *     fromDate,
-   *     toDate
-   *   );
+   *   const statusEvents = await EscrowUtils.getStatusEvents({
+   *     chainId: ChainId.POLYGON,
+   *     statuses: [EscrowStatus.Pending, EscrowStatus.Complete],
+   *     from: fromDate,
+   *     to: toDate
+   *   });
    *   console.log(statusEvents);
    * })();
    * ```
    */
-
   public static async getStatusEvents(
-    chainId: ChainId,
-    statuses?: EscrowStatus[],
-    from?: Date,
-    to?: Date,
-    launcher?: string,
-    first?: number,
-    skip?: number,
-    orderDirection?: OrderDirection
+    filter: IStatusEventFilter
   ): Promise<StatusEvent[]> {
+    const {
+      chainId,
+      statuses,
+      from,
+      to,
+      launcher,
+      first = 10,
+      skip = 0,
+      orderDirection = OrderDirection.DESC,
+    } = filter;
+
     if (launcher && !ethers.isAddress(launcher)) {
       throw ErrorInvalidAddress;
     }
 
-    first = first !== undefined ? Math.min(first, 1000) : 10;
-    skip = skip || 0;
-    orderDirection = orderDirection || OrderDirection.DESC;
+    const networkData = NETWORKS[chainId];
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
 
     // If statuses are not provided, use all statuses except Launched
     const effectiveStatuses = statuses ?? [
@@ -1885,11 +1889,6 @@ export class EscrowUtils {
       EscrowStatus.Cancelled,
     ];
 
-    const networkData = NETWORKS[chainId];
-    if (!networkData) {
-      throw ErrorUnsupportedChainID;
-    }
-
     const statusNames = effectiveStatuses.map((status) => EscrowStatus[status]);
 
     const data = await gqlFetch<{
@@ -1902,9 +1901,9 @@ export class EscrowUtils {
         from: from ? getUnixTimestamp(from) : undefined,
         to: to ? getUnixTimestamp(to) : undefined,
         launcher: launcher || undefined,
-        orderDirection: orderDirection,
-        first: first,
-        skip: skip,
+        orderDirection,
+        first: Math.min(first, 1000),
+        skip,
       }
     );
 
@@ -1921,4 +1920,64 @@ export class EscrowUtils {
 
     return eventsWithChainId;
   }
+
+  /**
+   * This function returns the payouts for a given set of networks.
+   *
+   * > This uses Subgraph
+   *
+   * **Input parameters**
+   * Fetch payouts from the subgraph.
+   *
+   * @param {IPayoutFilter} filter Filter parameters.
+   * @returns {Promise<Payout[]>} List of payouts matching the filters.
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
+   *
+   * const payouts = await EscrowUtils.getPayouts({
+   *   chainId: ChainId.POLYGON,
+   *   escrowAddress: '0x1234567890123456789012345678901234567890',
+   *   recipient: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
+   *   from: new Date('2023-01-01'),
+   *   to: new Date('2023-12-31')
+   * });
+   * console.log(payouts);
+   * ```
+   */
+  public static async getPayouts(filter: IPayoutFilter): Promise<Payout[]> {
+    const networkData = NETWORKS[filter.chainId];
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
+    if (filter.escrowAddress && !ethers.isAddress(filter.escrowAddress)) {
+      throw ErrorInvalidAddress;
+    }
+    if (filter.recipient && !ethers.isAddress(filter.recipient)) {
+      throw ErrorInvalidAddress;
+    }
+
+    const first =
+      filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+    const skip = filter.skip || 0;
+    const orderDirection = filter.orderDirection || OrderDirection.DESC;
+
+    const { payouts } = await gqlFetch<{ payouts: Payout[] }>(
+      getSubgraphUrl(networkData),
+      GET_PAYOUTS_QUERY(filter),
+      {
+        escrowAddress: filter.escrowAddress?.toLowerCase(),
+        recipient: filter.recipient?.toLowerCase(),
+        from: filter.from ? getUnixTimestamp(filter.from) : undefined,
+        to: filter.to ? getUnixTimestamp(filter.to) : undefined,
+        first: Math.min(first, 1000),
+        skip,
+        orderDirection,
+      }
+    );
+
+    return payouts || [];
+  }
 }

package/src/graphql/queries/payout.ts

@@ -1,5 +1,5 @@
 import gql from 'graphql-tag';
-import { IPayoutFilter } from '../../interfaces';
+import { IPayoutFilter } from 'src/interfaces';
 
 const PAYOUT_FRAGMENT = gql`
   fragment PayoutFields on Payout {
@@ -22,9 +22,6 @@ export const GET_PAYOUTS_QUERY = (filter: IPayoutFilter) => {
       ${to ? `createdAt_lt: $to` : ''}
     }
   `;
-  const LIMIT_CLAUSE = `
-    first: 1000
-  `;
 
   return gql`
     query getPayouts(
@@ -32,12 +29,16 @@ export const GET_PAYOUTS_QUERY = (filter: IPayoutFilter) => {
       $recipient: String
       $from: Int
       $to: Int
+      $first: Int
+      $skip: Int
+      $orderDirection: String
     ) {
       payouts(
         ${WHERE_CLAUSE}
         orderBy: createdAt,
-        orderDirection: desc,
-        ${LIMIT_CLAUSE}
+        orderDirection: $orderDirection,
+        first: $first,
+        skip: $skip
       ) {
         ...PayoutFields
       }

package/src/graphql/queries/worker.ts

@@ -0,0 +1,41 @@
+import gql from 'graphql-tag';
+import { IWorkersFilter } from '../../interfaces';
+
+export const GET_WORKER_QUERY = gql`
+  query GetWorker($address: String!) {
+    worker(id: $address) {
+      id
+      address
+      totalAmountReceived
+      payoutCount
+    }
+  }
+`;
+
+export const GET_WORKERS_QUERY = (filter: IWorkersFilter) => {
+  const { address } = filter;
+
+  return gql`
+  query GetWorkers(
+    $address: String
+    $first: Int
+    $skip: Int
+    $orderBy: String
+    $orderDirection: String
+  ) {
+    workers(
+      where: {
+        ${address ? 'address: $address,' : ''}
+      }
+      first: $first
+      skip: $skip
+      orderBy: $orderBy
+      orderDirection: $orderDirection
+    ) {
+      id
+      address
+      totalAmountReceived
+      payoutCount
+    }
+  }`;
+};

package/src/index.ts

@@ -6,6 +6,7 @@ import { StatisticsClient } from './statistics';
 import { Encryption, EncryptionUtils } from './encryption';
 import { OperatorUtils } from './operator';
 import { TransactionUtils } from './transaction';
+import { WorkerUtils } from './worker';
 
 export * from './constants';
 export * from './types';
@@ -24,4 +25,5 @@ export {
   EncryptionUtils,
   OperatorUtils,
   TransactionUtils,
+  WorkerUtils,
 };

package/src/interfaces.ts

@@ -103,7 +103,8 @@ export interface IHMTHoldersParams extends IPagination {
   address?: string;
 }
 
-export interface IPayoutFilter {
+export interface IPayoutFilter extends IPagination {
+  chainId: ChainId;
   escrowAddress?: string;
   recipient?: string;
   from?: Date;
@@ -161,3 +162,24 @@ export interface StakerInfo {
   lockedUntil: bigint;
   withdrawableAmount: bigint;
 }
+
+export interface IStatusEventFilter extends IPagination {
+  chainId: ChainId;
+  statuses?: EscrowStatus[];
+  from?: Date;
+  to?: Date;
+  launcher?: string;
+}
+
+export interface IWorker {
+  id: string;
+  address: string;
+  totalAmountReceived: number;
+  payoutCount: number;
+}
+
+export interface IWorkersFilter extends IPagination {
+  chainId: ChainId;
+  address?: string;
+  orderBy?: string;
+}

package/src/types.ts

@@ -171,4 +171,30 @@ export type EscrowWithdraw = {
   amountWithdrawn: 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;
+};
+
 export type TransactionLikeWithNonce = TransactionLike & { nonce: number };

package/src/worker.ts

@@ -0,0 +1,120 @@
+import gqlFetch from 'graphql-request';
+import { NETWORKS } from './constants';
+import { ChainId, OrderDirection } from './enums';
+import { ErrorInvalidAddress, ErrorUnsupportedChainID } from './error';
+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 {
+  /**
+   * This function returns the worker data for the given address.
+   *
+   * @param {ChainId} chainId The chain ID.
+   * @param {string} address The worker address.
+   * @returns {Promise<IWorker>} Returns the worker details.
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
+   *
+   * const worker = await WorkerUtils.getWorker(ChainId.POLYGON, '0x1234567890abcdef1234567890abcdef12345678');
+   * ```
+   */
+  public static async getWorker(
+    chainId: ChainId,
+    address: string
+  ): Promise<IWorker | null> {
+    const networkData = NETWORKS[chainId];
+
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
+    if (!ethers.isAddress(address)) {
+      throw ErrorInvalidAddress;
+    }
+
+    const { worker } = await gqlFetch<{
+      worker: IWorker;
+    }>(getSubgraphUrl(networkData), GET_WORKER_QUERY, {
+      address: address.toLowerCase(),
+    });
+
+    return worker || null;
+  }
+
+  /**
+   * This function returns all worker details based on the provided filter.
+   *
+   * **Input parameters**
+   *
+   * ```ts
+   * interface IWorkersFilter {
+   *   chainId: ChainId; // List of chain IDs to query.
+   *   address?: string; // (Optional) The worker address to filter by.
+   *   orderBy?: string; // (Optional) The field to order by. Default is 'payoutCount'.
+   *   orderDirection?: OrderDirection; // (Optional) The direction of the order. Default is 'DESC'.
+   *   first?: number; // (Optional) Number of workers per page. Default is 10.
+   *   skip?: number; // (Optional) Number of workers to skip. Default is 0.
+   * }
+   * ```
+   *
+   * ```ts
+   * type IWorker = {
+   *   id: string;
+   *   address: string;
+   *   totalAmountReceived: string;
+   *   payoutCount: number;
+   * };
+   * ```
+   *
+   * @param {IWorkersFilter} filter Filter for the workers.
+   * @returns {Promise<IWorker[]>} Returns an array with all the worker details.
+   *
+   * **Code example**
+   *
+   * ```ts
+   * import { WorkerUtils, ChainId } from '@human-protocol/sdk';
+   *
+   * const filter: IWorkersFilter = {
+   *   chainId: ChainId.POLYGON,
+   *   first: 10,
+   *   skip: 0,
+   * };
+   * const workers = await WorkerUtils.getWorkers(filter);
+   * ```
+   */
+  public static async getWorkers(filter: IWorkersFilter): Promise<IWorker[]> {
+    const first =
+      filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+    const skip = filter.skip || 0;
+    const orderBy = filter.orderBy || 'payoutCount';
+    const orderDirection = filter.orderDirection || OrderDirection.DESC;
+
+    const networkData = NETWORKS[filter.chainId];
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
+    if (filter.address && !ethers.isAddress(filter.address)) {
+      throw ErrorInvalidAddress;
+    }
+
+    const { workers } = await gqlFetch<{
+      workers: IWorker[];
+    }>(getSubgraphUrl(networkData), GET_WORKERS_QUERY(filter), {
+      address: filter?.address?.toLowerCase(),
+      first: first,
+      skip: skip,
+      orderBy: orderBy,
+      orderDirection: orderDirection,
+    });
+
+    if (!workers) {
+      return [];
+    }
+
+    return workers;
+  }
+}