@human-protocol/sdk 2.1.3 → 3.0.0

package/dist/kvstore.d.ts

@@ -1,6 +1,8 @@
 import { ContractRunner, Overrides } from 'ethers';
 import { BaseEthersClient } from './base';
+import { ChainId } from './enums';
 import { NetworkData } from './types';
+import { IKVStore } from './interfaces';
 /**
  * ## Introduction
  *
@@ -249,4 +251,86 @@ export declare class KVStoreClient extends BaseEthersClient {
      */
     getPublicKey(address: string): Promise<string>;
 }
+/**
+ * ## Introduction
+ *
+ * Utility class for KVStore-related operations.
+ *
+ * ## Installation
+ *
+ * ### npm
+ * ```bash
+ * npm install @human-protocol/sdk
+ * ```
+ *
+ * ### yarn
+ * ```bash
+ * yarn install @human-protocol/sdk
+ * ```
+ *
+ * ## Code example
+ *
+ * ### Signer
+ *
+ * **Using private key (backend)**
+ *
+ * ```ts
+ * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
+ *
+ * const KVStoreAddresses = new KVStoreUtils.getData({
+ *   networks: [ChainId.POLYGON_AMOY]
+ * });
+ * ```
+ */
+export declare class KVStoreUtils {
+    /**
+     * This function returns the KVStore data for a given address.
+     *
+     * > This uses Subgraph
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * enum ChainId {
+     *   ALL = -1,
+     *   MAINNET = 1,
+     *   RINKEBY = 4,
+     *   GOERLI = 5,
+     *   BSC_MAINNET = 56,
+     *   BSC_TESTNET = 97,
+     *   POLYGON = 137,
+     *   POLYGON_MUMBAI = 80001,
+     *   POLYGON_AMOY = 80002,
+     *   MOONBEAM = 1284,
+     *   MOONBASE_ALPHA = 1287,
+     *   AVALANCHE = 43114,
+     *   AVALANCHE_TESTNET = 43113,
+     *   CELO = 42220,
+     *   CELO_ALFAJORES = 44787,
+     *   LOCALHOST = 1338,
+     * }
+     * ```
+     *
+     * ```ts
+     * interface IKVStore {
+     *   key: string;
+     *   value: string;
+     * }
+     * ```
+     *
+     * @param {ChainId} chainId Network in which the KVStore is deployed
+     * @param {string} address Address of the KVStore
+     * @returns {Promise<IKVStore[]>} KVStore data
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
+     *
+     * const kvStoreData = await KVStoreUtils.getKVStoreData(ChainId.POLYGON_AMOY, "0x1234567890123456789012345678901234567890");
+     * console.log(kvStoreData);
+     * ```
+     */
+    static getKVStoreData(chainId: ChainId, address: string): Promise<IKVStore[]>;
+}
 //# sourceMappingURL=kvstore.d.ts.map

package/dist/kvstore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAU,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAa1C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAEH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc;IAiBhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,GAAG,CACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IAEU,OAAO,CAClB,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,MAAM,EAAE,EAChB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,iBAAiB,CAC5B,GAAG,EAAE,MAAM,EACX,MAAM,SAAQ,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,MAAM,SAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAkClB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAc5D"}
+{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAU,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAWlC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAEH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAU;IAE1B;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc;IAiBhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IAEU,GAAG,CACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IAEU,OAAO,CAClB,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,MAAM,EAAE,EAChB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEU,iBAAiB,CAC5B,GAAG,EAAE,MAAM,EACX,MAAM,SAAQ,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAa/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,uBAAuB,CAClC,OAAO,EAAE,MAAM,EACf,MAAM,SAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAkClB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAc5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,YAAY;IACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,QAAQ,EAAE,CAAC;CAwBvB"}

package/dist/kvstore.js

@@ -8,15 +8,20 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KVStoreClient = void 0;
+exports.KVStoreUtils = exports.KVStoreClient = void 0;
 const typechain_types_1 = require("@human-protocol/core/typechain-types");
 const ethers_1 = require("ethers");
 const base_1 = require("./base");
 const constants_1 = require("./constants");
 const decorators_1 = require("./decorators");
 const error_1 = require("./error");
+const graphql_request_1 = __importDefault(require("graphql-request"));
 const utils_1 = require("./utils");
+const kvstore_1 = require("./graphql/queries/kvstore");
 /**
  * ## Introduction
  *
@@ -383,3 +388,100 @@ __decorate([
     __metadata("design:returntype", Promise)
 ], KVStoreClient.prototype, "setFileUrlAndHash", null);
 exports.KVStoreClient = KVStoreClient;
+/**
+ * ## Introduction
+ *
+ * Utility class for KVStore-related operations.
+ *
+ * ## Installation
+ *
+ * ### npm
+ * ```bash
+ * npm install @human-protocol/sdk
+ * ```
+ *
+ * ### yarn
+ * ```bash
+ * yarn install @human-protocol/sdk
+ * ```
+ *
+ * ## Code example
+ *
+ * ### Signer
+ *
+ * **Using private key (backend)**
+ *
+ * ```ts
+ * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
+ *
+ * const KVStoreAddresses = new KVStoreUtils.getData({
+ *   networks: [ChainId.POLYGON_AMOY]
+ * });
+ * ```
+ */
+class KVStoreUtils {
+    /**
+     * This function returns the KVStore data for a given address.
+     *
+     * > This uses Subgraph
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * enum ChainId {
+     *   ALL = -1,
+     *   MAINNET = 1,
+     *   RINKEBY = 4,
+     *   GOERLI = 5,
+     *   BSC_MAINNET = 56,
+     *   BSC_TESTNET = 97,
+     *   POLYGON = 137,
+     *   POLYGON_MUMBAI = 80001,
+     *   POLYGON_AMOY = 80002,
+     *   MOONBEAM = 1284,
+     *   MOONBASE_ALPHA = 1287,
+     *   AVALANCHE = 43114,
+     *   AVALANCHE_TESTNET = 43113,
+     *   CELO = 42220,
+     *   CELO_ALFAJORES = 44787,
+     *   LOCALHOST = 1338,
+     * }
+     * ```
+     *
+     * ```ts
+     * interface IKVStore {
+     *   key: string;
+     *   value: string;
+     * }
+     * ```
+     *
+     * @param {ChainId} chainId Network in which the KVStore is deployed
+     * @param {string} address Address of the KVStore
+     * @returns {Promise<IKVStore[]>} KVStore data
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { ChainId, KVStoreUtils } from '@human-protocol/sdk';
+     *
+     * const kvStoreData = await KVStoreUtils.getKVStoreData(ChainId.POLYGON_AMOY, "0x1234567890123456789012345678901234567890");
+     * console.log(kvStoreData);
+     * ```
+     */
+    static async getKVStoreData(chainId, address) {
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        if (address && !ethers_1.ethers.isAddress(address)) {
+            throw error_1.ErrorInvalidAddress;
+        }
+        const { kvstores } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, kvstore_1.GET_KVSTORE_BY_ADDRESS_QUERY)(), { address: address.toLowerCase() });
+        const kvStoreData = kvstores.map((item) => ({
+            key: item.key,
+            value: item.value,
+        }));
+        return kvStoreData || [];
+    }
+}
+exports.KVStoreUtils = KVStoreUtils;

package/dist/operator.d.ts

@@ -29,10 +29,13 @@ export declare class OperatorUtils {
      * ```ts
      * import { OperatorUtils } from '@human-protocol/sdk';
      *
-     * const leaders = await OperatorUtils.getLeaders();
+     * const filter: ILeadersFilter = {
+     *  chainId: ChainId.POLYGON
+     * };
+     * const leaders = await OperatorUtils.getLeaders(filter);
      * ```
      */
-    static getLeaders(filter?: ILeadersFilter): Promise<ILeader[]>;
+    static getLeaders(filter: ILeadersFilter): Promise<ILeader[]>;
     /**
      * Retrieves the reputation network operators of the specified address.
      *

package/dist/operator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EAEP,cAAc,EACd,SAAS,EAET,OAAO,EACR,MAAM,cAAc,CAAC;AAetB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,qBAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IA0BnB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,MAAM,GAAE,cAAqD,GAC5D,OAAO,CAAC,OAAO,EAAE,CAAC;IA4BrB;;;;;;;;;;;;;OAaG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IAuBvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CA2BtB"}
+{"version":3,"file":"operator.d.ts","sourceRoot":"","sources":["../src/operator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,OAAO,EAEP,cAAc,EACd,SAAS,EAET,OAAO,EACR,MAAM,cAAc,CAAC;AAetB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAGlC,qBAAa,aAAa;IACxB;;;;;;;;;;;;;;OAcG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,CAAC;IAkCnB;;;;;;;;;;;;;;;;;OAiBG;WACiB,UAAU,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IA0C1E;;;;;;;;;;;;;OAaG;WACiB,6BAA6B,CAC/C,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IAiCvB;;;;;;;;;;;;;;OAcG;WACiB,UAAU,CAC5B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,OAAO,EAAE,CAAC;CA2BtB"}

package/dist/operator.js

@@ -11,7 +11,6 @@ const operator_1 = require("./graphql/queries/operator");
 const ethers_1 = require("ethers");
 const error_1 = require("./error");
 const utils_1 = require("./utils");
-const enums_1 = require("./enums");
 const constants_1 = require("./constants");
 class OperatorUtils {
     /**
@@ -38,12 +37,19 @@ class OperatorUtils {
             throw error_1.ErrorUnsupportedChainID;
         }
         try {
-            const { leader } = await (0, graphql_request_1.default)(networkData.subgraphUrl, operator_1.GET_LEADER_QUERY, {
+            const { leader } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), operator_1.GET_LEADER_QUERY, {
                 address: address.toLowerCase(),
             });
+            let jobTypes = [];
+            if (typeof leader.jobTypes === 'string') {
+                jobTypes = leader.jobTypes.split(',');
+            }
+            else if (Array.isArray(leader.jobTypes)) {
+                jobTypes = leader.jobTypes;
+            }
             return {
                 ...leader,
-                jobTypes: leader.jobTypes?.split(','),
+                jobTypes,
             };
         }
         catch (e) {
@@ -62,25 +68,38 @@ class OperatorUtils {
      * ```ts
      * import { OperatorUtils } from '@human-protocol/sdk';
      *
-     * const leaders = await OperatorUtils.getLeaders();
+     * const filter: ILeadersFilter = {
+     *  chainId: ChainId.POLYGON
+     * };
+     * const leaders = await OperatorUtils.getLeaders(filter);
      * ```
      */
-    static async getLeaders(filter = { networks: [enums_1.ChainId.POLYGON_AMOY] }) {
+    static async getLeaders(filter) {
         try {
             let leaders_data = [];
-            for (const chainId of filter.networks) {
-                const networkData = constants_1.NETWORKS[chainId];
-                if (!networkData) {
-                    throw error_1.ErrorUnsupportedChainID;
+            const networkData = constants_1.NETWORKS[filter.chainId];
+            if (!networkData) {
+                throw error_1.ErrorUnsupportedChainID;
+            }
+            const { leaders } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, operator_1.GET_LEADERS_QUERY)(filter), {
+                role: filter?.role,
+            });
+            if (!leaders) {
+                return [];
+            }
+            leaders_data = leaders_data.concat(leaders.map((leader) => {
+                let jobTypes = [];
+                if (typeof leader.jobTypes === 'string') {
+                    jobTypes = leader.jobTypes.split(',');
+                }
+                else if (Array.isArray(leader.jobTypes)) {
+                    jobTypes = leader.jobTypes;
                 }
-                const { leaders } = await (0, graphql_request_1.default)(networkData.subgraphUrl, (0, operator_1.GET_LEADERS_QUERY)(filter), {
-                    role: filter.role,
-                });
-                leaders_data = leaders_data.concat(leaders.map((leader) => ({
+                return {
                     ...leader,
-                    jobTypes: leader.jobTypes?.split(','),
-                })));
-            }
+                    jobTypes,
+                };
+            }));
             return leaders_data;
         }
         catch (e) {
@@ -107,14 +126,23 @@ class OperatorUtils {
             throw error_1.ErrorUnsupportedChainID;
         }
         try {
-            const { reputationNetwork } = await (0, graphql_request_1.default)(networkData.subgraphUrl, (0, operator_1.GET_REPUTATION_NETWORK_QUERY)(role), {
+            const { reputationNetwork } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, operator_1.GET_REPUTATION_NETWORK_QUERY)(role), {
                 address: address.toLowerCase(),
                 role: role,
             });
-            return reputationNetwork.operators.map((operator) => ({
-                ...operator,
-                jobTypes: operator.jobTypes?.split(','),
-            }));
+            return reputationNetwork.operators.map((operator) => {
+                let jobTypes = [];
+                if (typeof operator.jobTypes === 'string') {
+                    jobTypes = operator.jobTypes.split(',');
+                }
+                else if (Array.isArray(operator.jobTypes)) {
+                    jobTypes = operator.jobTypes;
+                }
+                return {
+                    ...operator,
+                    jobTypes,
+                };
+            });
         }
         catch (e) {
             return (0, utils_1.throwError)(e);
@@ -144,7 +172,7 @@ class OperatorUtils {
             throw error_1.ErrorUnsupportedChainID;
         }
         try {
-            const { rewardAddedEvents } = await (0, graphql_request_1.default)(networkData.subgraphUrl, reward_1.GET_REWARD_ADDED_EVENTS_QUERY, {
+            const { rewardAddedEvents } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), reward_1.GET_REWARD_ADDED_EVENTS_QUERY, {
                 slasherAddress: slasherAddress.toLowerCase(),
             });
             return rewardAddedEvents.map((reward) => {

package/dist/statistics.d.ts

@@ -40,6 +40,7 @@ import { NetworkData } from './types';
  */
 export declare class StatisticsClient {
     networkData: NetworkData;
+    subgraphUrl: string;
     /**
      * **StatisticsClient constructor**
      *

package/dist/statistics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":"AAIA,OAAO,EAKL,gBAAgB,EAGhB,aAAa,EAEb,iBAAiB,EACjB,gBAAgB,EAEjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,gBAAgB;IACpB,WAAW,EAAE,WAAW,CAAC;IAEhC;;;;OAIG;gBACS,WAAW,EAAE,WAAW;IAIpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA6B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAoB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IA0B7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgFG;IACG,gBAAgB,CACpB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,aAAa,CAAC;CAuC1B"}
+{"version":3,"file":"statistics.d.ts","sourceRoot":"","sources":["../src/statistics.ts"],"names":[],"mappings":"AAIA,OAAO,EAKL,gBAAgB,EAGhB,aAAa,EAEb,iBAAiB,EACjB,gBAAgB,EAEjB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,gBAAgB;IACpB,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;gBACS,WAAW,EAAE,WAAW;IAKpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IA6B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACG,mBAAmB,CACvB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,gBAAgB,CAAC;IAoB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,oBAAoB,CACxB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;IA0B7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgFG;IACG,gBAAgB,CACpB,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,aAAa,CAAC;CAuC1B"}

package/dist/statistics.js

@@ -54,6 +54,7 @@ class StatisticsClient {
      */
     constructor(networkData) {
         this.networkData = networkData;
+        this.subgraphUrl = (0, utils_1.getSubgraphUrl)(networkData);
     }
     /**
      * This function returns the statistical data of escrows.
@@ -106,8 +107,8 @@ class StatisticsClient {
      */
     async getEscrowStatistics(params = {}) {
         try {
-            const { escrowStatistics } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, graphql_1.GET_ESCROW_STATISTICS_QUERY);
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
+            const { escrowStatistics } = await (0, graphql_request_1.default)(this.subgraphUrl, graphql_1.GET_ESCROW_STATISTICS_QUERY);
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
                 from: params.from ? params.from.getTime() / 1000 : undefined,
                 to: params.to ? params.to.getTime() / 1000 : undefined,
             });
@@ -173,7 +174,7 @@ class StatisticsClient {
      */
     async getWorkerStatistics(params = {}) {
         try {
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
                 from: params.from ? params.from.getTime() / 1000 : undefined,
                 to: params.to ? params.to.getTime() / 1000 : undefined,
             });
@@ -257,7 +258,7 @@ class StatisticsClient {
      */
     async getPaymentStatistics(params = {}) {
         try {
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
                 from: params.from ? params.from.getTime() / 1000 : undefined,
                 to: params.to ? params.to.getTime() / 1000 : undefined,
             });
@@ -360,9 +361,9 @@ class StatisticsClient {
      */
     async getHMTStatistics(params = {}) {
         try {
-            const { hmtokenStatistics } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, graphql_1.GET_HMTOKEN_STATISTICS_QUERY);
-            const { holders } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, graphql_1.GET_HOLDERS_QUERY);
-            const { eventDayDatas } = await (0, graphql_request_1.default)(this.networkData.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
+            const { hmtokenStatistics } = await (0, graphql_request_1.default)(this.subgraphUrl, graphql_1.GET_HMTOKEN_STATISTICS_QUERY);
+            const { holders } = await (0, graphql_request_1.default)(this.subgraphUrl, graphql_1.GET_HOLDERS_QUERY);
+            const { eventDayDatas } = await (0, graphql_request_1.default)(this.subgraphUrl, (0, graphql_1.GET_EVENT_DAY_DATA_QUERY)(params), {
                 from: params.from ? params.from.getTime() / 1000 : undefined,
                 to: params.to ? params.to.getTime() / 1000 : undefined,
             });

package/dist/transaction.d.ts

@@ -0,0 +1,69 @@
+import { ChainId } from './enums';
+import { ITransaction, ITransactionsFilter } from './interfaces';
+export declare class TransactionUtils {
+    /**
+     * This function returns the transaction data for the given hash.
+     *
+     * @param {ChainId} chainId The chain ID.
+     * @param {string} hash The transaction hash.
+     * @returns {Promise<ITransaction>} Returns the transaction details.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { TransactionUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const transaction = await TransactionUtils.getTransaction(ChainId.POLYGON, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * ```
+     */
+    static getTransaction(chainId: ChainId, hash: string): Promise<ITransaction>;
+    /**
+     * This function returns all transaction details based on the provided filter.
+     *
+     * > This uses Subgraph
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * interface ITransactionsFilter {
+     *   networks: ChainId[]; // List of chain IDs to query.
+     *   fromAddress?: string; // (Optional) The address from which transactions are sent.
+     *   toAddress?: string; // (Optional) The address to which transactions are sent.
+     *   startDate?: Date; // (Optional) The start date to filter transactions (inclusive).
+     *   endDate?: Date; // (Optional) The end date to filter transactions (inclusive).
+     *   startBlock?: number; // (Optional) The start block number to filter transactions (inclusive).
+     *   endBlock?: number; // (Optional) The end block number to filter transactions (inclusive).
+     * }
+     * ```
+     *
+     * ```ts
+     * type ITransaction = {
+     *   block: number;
+     *   txHash: string;
+     *   from: string;
+     *   to: string;
+     *   timestamp: number;
+     *   value: string;
+     *   method: string;
+     * };
+     * ```
+     *
+     * @param {ITransactionsFilter} filter Filter for the transactions.
+     * @returns {Promise<ITransaction[]>} Returns an array with all the transaction details.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { TransactionUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const filter: ITransactionsFilter = {
+     *   networks: [ChainId.POLYGON],
+     *   startDate: new Date('2022-01-01'),
+     *   endDate: new Date('2022-12-31')
+     * };
+     * const transactions = await TransactionUtils.getTransactions(filter);
+     * ```
+     */
+    static getTransactions(filter: ITransactionsFilter): Promise<ITransaction[]>;
+}
+//# sourceMappingURL=transaction.d.ts.map

package/dist/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../src/transaction.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAUlC,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAGjE,qBAAa,gBAAgB;IAC3B;;;;;;;;;;;;;;OAcG;WACiB,cAAc,CAChC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,YAAY,CAAC;IAmBxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;WACiB,eAAe,CACjC,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,YAAY,EAAE,CAAC;CAqC3B"}

package/dist/transaction.js

@@ -0,0 +1,121 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionUtils = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const ethers_1 = require("ethers");
+const graphql_request_1 = __importDefault(require("graphql-request"));
+const constants_1 = require("./constants");
+const error_1 = require("./error");
+const transaction_1 = require("./graphql/queries/transaction");
+const utils_1 = require("./utils");
+class TransactionUtils {
+    /**
+     * This function returns the transaction data for the given hash.
+     *
+     * @param {ChainId} chainId The chain ID.
+     * @param {string} hash The transaction hash.
+     * @returns {Promise<ITransaction>} Returns the transaction details.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { TransactionUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const transaction = await TransactionUtils.getTransaction(ChainId.POLYGON, '0x62dD51230A30401C455c8398d06F85e4EaB6309f');
+     * ```
+     */
+    static async getTransaction(chainId, hash) {
+        if (!ethers_1.ethers.isHexString(hash)) {
+            throw error_1.ErrorInvalidHahsProvided;
+        }
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        const { transaction } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), transaction_1.GET_TRANSACTION_QUERY, {
+            hash: hash.toLowerCase(),
+        });
+        return transaction;
+    }
+    /**
+     * This function returns all transaction details based on the provided filter.
+     *
+     * > This uses Subgraph
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * interface ITransactionsFilter {
+     *   networks: ChainId[]; // List of chain IDs to query.
+     *   fromAddress?: string; // (Optional) The address from which transactions are sent.
+     *   toAddress?: string; // (Optional) The address to which transactions are sent.
+     *   startDate?: Date; // (Optional) The start date to filter transactions (inclusive).
+     *   endDate?: Date; // (Optional) The end date to filter transactions (inclusive).
+     *   startBlock?: number; // (Optional) The start block number to filter transactions (inclusive).
+     *   endBlock?: number; // (Optional) The end block number to filter transactions (inclusive).
+     * }
+     * ```
+     *
+     * ```ts
+     * type ITransaction = {
+     *   block: number;
+     *   txHash: string;
+     *   from: string;
+     *   to: string;
+     *   timestamp: number;
+     *   value: string;
+     *   method: string;
+     * };
+     * ```
+     *
+     * @param {ITransactionsFilter} filter Filter for the transactions.
+     * @returns {Promise<ITransaction[]>} Returns an array with all the transaction details.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { TransactionUtils, ChainId } from '@human-protocol/sdk';
+     *
+     * const filter: ITransactionsFilter = {
+     *   networks: [ChainId.POLYGON],
+     *   startDate: new Date('2022-01-01'),
+     *   endDate: new Date('2022-12-31')
+     * };
+     * const transactions = await TransactionUtils.getTransactions(filter);
+     * ```
+     */
+    static async getTransactions(filter) {
+        if ((!!filter.startDate || !!filter.endDate) &&
+            (!!filter.startBlock || !!filter.endBlock)) {
+            throw error_1.ErrorCannotUseDateAndBlockSimultaneously;
+        }
+        const transactions_data = [];
+        for (const chainId of filter.networks) {
+            const networkData = constants_1.NETWORKS[chainId];
+            if (!networkData) {
+                throw error_1.ErrorUnsupportedChainID;
+            }
+            const { transactions } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, transaction_1.GET_TRANSACTIONS_QUERY)(filter), {
+                fromAddress: filter?.fromAddress,
+                toAddress: filter?.toAddress,
+                startDate: filter?.startDate
+                    ? Math.floor(filter?.startDate.getTime() / 1000)
+                    : undefined,
+                endDate: filter.endDate
+                    ? Math.floor(filter.endDate.getTime() / 1000)
+                    : undefined,
+                startBlock: filter.startBlock ? filter.startBlock : undefined,
+                endBlock: filter.endBlock ? filter.endBlock : undefined,
+            });
+            if (!transactions) {
+                continue;
+            }
+            transactions_data.push(...transactions);
+        }
+        return transactions_data;
+    }
+}
+exports.TransactionUtils = TransactionUtils;

package/dist/types.d.ts

@@ -123,6 +123,10 @@ export type NetworkData = {
      * Subgraph URL
      */
     subgraphUrl: string;
+    /**
+     * Subgraph URL
+     */
+    subgraphUrlApiKey: string;
     /**
      * Old subgraph URL
      */

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;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,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;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,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;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"}

package/dist/utils.d.ts

@@ -1,3 +1,4 @@
+import { NetworkData } from './types';
 /**
  * **Handle and throw the error.*
  *
@@ -12,4 +13,12 @@ export declare const throwError: (e: any) => never;
  * @returns
  */
 export declare const isValidUrl: (url: string) => boolean;
+/**
+ * **Get the subgraph URL.*
+ *
+ * @param {NetworkData} networkData
+ * @param {string} apiKey
+ * @returns
+ */
+export declare const getSubgraphUrl: (networkData: NetworkData) => string;
 //# sourceMappingURL=utils.d.ts.map