@human-protocol/sdk 2.1.3 → 3.0.0

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH,eAAO,MAAM,UAAU,MAAO,GAAG,UAgBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,YAOrC,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC;;;;;GAKG;AACH,eAAO,MAAM,UAAU,MAAO,GAAG,UAgBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,YAOrC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,gBAAiB,WAAW,WAatD,CAAC"}

package/dist/utils.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidUrl = exports.throwError = void 0;
+exports.getSubgraphUrl = exports.isValidUrl = exports.throwError = void 0;
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const ethers_1 = require("ethers");
 const error_1 = require("./error");
+const constants_1 = require("./constants");
 /**
  * **Handle and throw the error.*
  *
@@ -50,3 +51,22 @@ const isValidUrl = (url) => {
     }
 };
 exports.isValidUrl = isValidUrl;
+/**
+ * **Get the subgraph URL.*
+ *
+ * @param {NetworkData} networkData
+ * @param {string} apiKey
+ * @returns
+ */
+const getSubgraphUrl = (networkData) => {
+    let subgraphUrl = networkData.subgraphUrl;
+    if (process.env.SUBGRAPH_API_KEY) {
+        subgraphUrl = networkData.subgraphUrlApiKey.replace(constants_1.SUBGRAPH_API_KEY_PLACEHOLDER, process.env.SUBGRAPH_API_KEY);
+    }
+    else {
+        // eslint-disable-next-line no-console
+        console.warn(error_1.WarnSubgraphApiKeyNotProvided);
+    }
+    return subgraphUrl;
+};
+exports.getSubgraphUrl = getSubgraphUrl;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "2.1.3",
+  "version": "3.0.0",
   "files": [
     "src",
     "dist"
@@ -45,15 +45,15 @@
     "graphql": "^16.8.1",
     "graphql-request": "^6.1.0",
     "graphql-tag": "^2.12.6",
-    "minio": "^7.0.32",
+    "minio": "7.1.3",
     "openpgp": "^5.11.1",
     "secp256k1": "^4.0.3",
-    "vitest": "^0.30.1",
+    "vitest": "^1.6.0",
     "winston": "^3.13.0"
   },
   "devDependencies": {
     "typedoc": "^0.25.1",
-    "typedoc-plugin-markdown": "^3.16.0"
+    "typedoc-plugin-markdown": "^4.0.3"
   },
   "typedocOptions": {
     "entryPoints": [

package/src/constants.ts

@@ -61,7 +61,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0xB6d36B1CDaD50302BCB3DB43bAb0D349458e1b8D',
     subgraphUrl:
-      'https://api.thegraph.com/subgraphs/name/humanprotocol/mainnet-v2',
+      'https://api.studio.thegraph.com/query/74256/ethereum/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/BtC96WCK6ZpZ35v94MK6rZNiBzDEZYHFzDmhMYyZ369D',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -75,6 +77,7 @@ export const NETWORKS: {
     rewardPoolAddress: '',
     kvstoreAddress: '',
     subgraphUrl: '',
+    subgraphUrlApiKey: '',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -89,6 +92,7 @@ export const NETWORKS: {
     kvstoreAddress: '0x19Fc3e859C1813ac9427a7a78BeB9ae102CE96d3',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/goerli-v2',
+    subgraphUrlApiKey: '',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/goerli',
     oldFactoryAddress: '0xaAe6a2646C1F88763E62e0cD08aD050Ea66AC46F',
@@ -103,7 +107,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0xAFf5a986A530ff839d49325A5dF69F96627E8D29',
     kvstoreAddress: '0xCc0AF0635aa19fE799B6aFDBe28fcFAeA7f00a60',
     subgraphUrl:
-      'https://subgraph.satsuma-prod.com/8d51f9873a51/team--2543/humanprotocol-sepolia/api',
+      'https://api.studio.thegraph.com/query/74256/sepolia/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/UMLaZHtLE9LxzDyvBLBgfWj4erzYzYMeGUbQtxtyMaE',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -116,7 +122,10 @@ export const NETWORKS: {
     stakingAddress: '0xdFbB79dC35a3A53741be54a2C9b587d6BafAbd1C',
     rewardPoolAddress: '0xf376443BCc6d4d4D63eeC086bc4A9E4a83878e0e',
     kvstoreAddress: '0x21A0C4CED7aE447fCf87D9FE3A29FA9B3AB20Ff1',
-    subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc-v2',
+    subgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/bsc/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/JBJPC3YmRSNjyjRTTpazhhSX5CCZ4CeBx6ptRsM8PCBb',
     oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
     oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
   },
@@ -130,7 +139,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0xB0A0500103eCEc431b73F6BAd923F0a2774E6e29',
     kvstoreAddress: '0x32e27177BA6Ea91cf28dfd91a0Da9822A4b74EcF',
     subgraphUrl:
-      'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest-v2',
+      'https://api.studio.thegraph.com/query/74256/bsc-testnet/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/BnaC4CDqgdbGvcgM7KoZ6d7Yeebsm7NvLFrr61Lxg6Ao',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest',
     oldFactoryAddress: '0xaae6a2646c1f88763e62e0cd08ad050ea66ac46f',
@@ -145,7 +156,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0xa8e32d777a3839440cc7c24D591A64B9481753B3',
     kvstoreAddress: '0xbcB28672F826a50B03EE91B28145EAbddA73B2eD',
     subgraphUrl:
-      'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon-v2',
+      'https://api.studio.thegraph.com/query/74256/polygon/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/HHYwCHBvDrjckpNB4jbB8k63pSot6rGtBYLBygGji3vD',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon',
     oldFactoryAddress: '0x45eBc3eAE6DA485097054ae10BA1A0f8e8c7f794',
@@ -161,6 +174,7 @@ export const NETWORKS: {
     kvstoreAddress: '0xD96158c7267Ea658a4688F4aEf1c85659851625d',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mumbai-v2',
+    subgraphUrlApiKey: '',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mumbai',
     oldFactoryAddress: '0x558cd800f9F0B02f3B149667bDe003284c867E94',
@@ -175,7 +189,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0xd866bCEFf6D0F77E1c3EAE28230AE6C79b03fDa7',
     kvstoreAddress: '0x724AeFC243EdacCA27EAB86D3ec5a76Af4436Fc7',
     subgraphUrl:
-      'https://subgraph.satsuma-prod.com/8d51f9873a51/team--2543/humanprotocol-amoy/api',
+      'https://api.studio.thegraph.com/query/74256/amoy/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/FmdCVzHV3bB4abPVYtBALtBHr7ZRZmZ67m5c432S7GZH',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -189,7 +205,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0x2B95bEcb6EBC4589f64CB000dFCF716b4aeF8aA6',
     subgraphUrl:
-      'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbeam-v2',
+      'https://api.studio.thegraph.com/query/74256/moonbeam/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/BH5Sm6exn76o5frV5VeCufChB43DCfMXCQsdtWt4AuQP',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbeam',
     oldFactoryAddress: '0x98108c28B7767a52BE38B4860832dd4e11A7ecad',
@@ -204,7 +222,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
     kvstoreAddress: '0xcC561f4482f4Ff051D2Dcc65c2cE1A0f291bbA46',
     subgraphUrl:
-      'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbase-alpha-v2',
+      'https://api.studio.thegraph.com/query/74256/moonbase-alpha/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/AmmRkJszUbjfUwHubcRkU6CfG1Q9psRWRbbHADVmsLjE',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -218,7 +238,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18',
     kvstoreAddress: '0x3aD4B091E054f192a822D1406f4535eAd38580e4',
     subgraphUrl:
-      'https://api.thegraph.com/subgraphs/name/humanprotocol/fuji-v2',
+      'https://api.studio.thegraph.com/query/74256/fuji/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/CnZCDsWziQF3jNoqgQMkmJbF9frof5osM3hN5eUgyL5u',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/fuji',
     oldFactoryAddress: '0xfb4469201951C3B9a7F1996c477cb7BDBEcE0A88',
@@ -233,7 +255,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0x9Bc7bff35B2Be2413708d48c3B0aEF5c43646728',
     subgraphUrl:
-      'https://api.thegraph.com/subgraphs/name/humanprotocol/avalanche-v2',
+      'https://api.studio.thegraph.com/query/74256/avalanche/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/FweDaDWZ6ZDcsA63wsjnWgdgw4aCbkiVQYMYvtcP5p2u',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/avalanche',
     oldFactoryAddress: '0x9767a578ba7a5FA1563c8229943cB01cd8446BB4',
@@ -248,7 +272,9 @@ export const NETWORKS: {
     rewardPoolAddress: '0xA9545C2530BD5bdb464d5E274F59ACceAa73eD86',
     kvstoreAddress: '0x938335006ea6F9Eb0e8020969cFF94404425e298',
     subgraphUrl:
-      'https://api.thegraph.com/subgraphs/name/humanprotocol/celo-alfajores',
+      'https://api.studio.thegraph.com/query/74256/celo-alfajores/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/EGWCWuzBNkbypW8ipRKuyGwq8azoCy6LKKosGgSPMGRD',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -261,23 +287,44 @@ export const NETWORKS: {
     stakingAddress: '0x34cD3Bd6B16c559f321799b516dE61E12017fFd1',
     rewardPoolAddress: '0xb9344bAD98E3d26a4d83900922baf395a2Ec154c',
     kvstoreAddress: '0x86Af9f6Cd34B69Db1B202223C6d6D109f2491569',
-    subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/celo',
+    subgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/celo/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/HTgMnYWGsdsw41o8dyph1bwhotuXh6va3L8r8DGgLjsA',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
-  [ChainId.SKALE]: {
-    chainId: ChainId.SKALE,
-    title: 'SKALE Human Protocol Chain',
-    scanUrl: 'https://wan-red-ain.explorer.mainnet.skalenodes.com/',
-    factoryAddress: '0x319070b49C8d1cC015915D1E7Eb5fd8e22833885',
-    hmtAddress: '0x6E5FF61Ea88270F6142E0E0eC8cbe9d67476CbCd',
-    stakingAddress: '0x79F37FB9C210910733c16228AC4D14a8e32C11BD',
-    rewardPoolAddress: '0x881218246c25C6898aE96145259584340153aDA2',
-    kvstoreAddress: '0xE1055607327b1be2080D31211dCDC4D9338CaF4A',
+  [ChainId.XLAYER]: {
+    chainId: ChainId.XLAYER,
+    title: 'XLayer',
+    scanUrl: 'https://www.oklink.com/xlayer',
+    factoryAddress: '0x4949C9DFFD83F0D5Ab0AB24C57C4D403D5c20C15',
+    hmtAddress: '0x10acbe3b9e6a2ff7f341e5cbf4b6617741ff44aa',
+    stakingAddress: '0x01D115E9E8bF0C58318793624CC662a030D07F1D',
+    rewardPoolAddress: '0x7ABa5F75b2b530cB0c8927C86591c21dF44f06b6',
+    kvstoreAddress: '0x6512d894cc3d3FE93Da9d0420430136fA889FaB9',
     subgraphUrl:
-      'https://graph-skale.humanprotocol.org/subgraphs/name/skale-human',
+      'https://api.studio.thegraph.com/query/74256/xlayer/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/CrratkbjCraj1BZLgJmck1GGxbMb2Y2iPZiW4Lh5DdcX',
     oldSubgraphUrl: '',
-    oldFactoryAddress: '0x27B423cE73d1dBdB48d2dd351398b5Ce8223117c',
+    oldFactoryAddress: '',
+  },
+  [ChainId.XLAYER_TESTNET]: {
+    chainId: ChainId.XLAYER_TESTNET,
+    title: 'XLayer Testnet',
+    scanUrl: 'https://www.okx.com/explorer/xlayer-test',
+    factoryAddress: '0x6Cd3ecAD36ee88E9ef3665CF381D9dAE0FE0a32e',
+    hmtAddress: '0x792abbcC99c01dbDec49c9fa9A828a186Da45C33',
+    stakingAddress: '0x819069fEd50581587fAB9E583b5488fc2D33B7ea',
+    rewardPoolAddress: '0x6daccd1f3a68945f8a7ac6d20260953f7a97fae4',
+    kvstoreAddress: '0xdE8BE9E3C12E9F546309A429cd88d026a25EaF8C',
+    subgraphUrl:
+      'https://api.studio.thegraph.com/query/74256/xlayer-testnet/version/latest',
+    subgraphUrlApiKey:
+      'https://gateway-testnet-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/subgraphs/id/9zd1LcywWjuSUtde4ofC8oyyzpawPwGUiPsvqTq247xk',
+    oldSubgraphUrl: '',
+    oldFactoryAddress: '',
   },
   [ChainId.LOCALHOST]: {
     chainId: ChainId.LOCALHOST,
@@ -289,6 +336,7 @@ export const NETWORKS: {
     rewardPoolAddress: '0xa513E6E4b8f2a923D98304ec87F64353C4D5C853',
     kvstoreAddress: '0x5FC8d32690cc91D4c39d9d3abcBD16989F875707',
     subgraphUrl: 'http://localhost:8000/subgraphs/name/humanprotocol/localhost',
+    subgraphUrlApiKey: '',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -309,3 +357,5 @@ export const Role = {
   ReputationOracle: 'Reputation Oracle',
   RecordingOracle: 'Recording Oracle',
 };
+
+export const SUBGRAPH_API_KEY_PLACEHOLDER = '[SUBGRAPH_API_KEY]';

package/src/enums.ts

@@ -13,8 +13,9 @@ export enum ChainId {
   MOONBASE_ALPHA = 1287,
   AVALANCHE_TESTNET = 43113,
   AVALANCHE = 43114,
-  SKALE = 1273227453,
   CELO = 42220,
   CELO_ALFAJORES = 44787,
+  XLAYER_TESTNET = 195,
   LOCALHOST = 1338,
+  XLAYER = 196,
 }

package/src/error.ts

@@ -117,6 +117,18 @@ export const ErrorInvalidStakerAddressProvided = new Error(
   'Invalid staker address provided'
 );
 
+/**
+ * @constant {Error} - Invalid hash provided.
+ */
+export const ErrorInvalidHahsProvided = new Error('Invalid hash provided');
+
+/**
+ * @constant {Error} - Cannot use both date and block filters simultaneously.
+ */
+export const ErrorCannotUseDateAndBlockSimultaneously = new Error(
+  'Cannot use both date and block filters simultaneously'
+);
+
 /**
  * @constant {Error} - Invalid escrow address provided.
  */
@@ -322,3 +334,6 @@ export class InvalidEthereumAddressError extends Error {
  * @constant {Error} - The Hash does not match
  */
 export const ErrorInvalidHash = new Error('Invalid hash');
+
+export const WarnSubgraphApiKeyNotProvided =
+  '"SUBGRAPH_API_KEY" is not being provided. It might cause issues with the subgraph.';

package/src/escrow.ts

@@ -44,7 +44,7 @@ import {
 } from './graphql';
 import { IEscrowConfig, IEscrowsFilter } from './interfaces';
 import { EscrowCancel, EscrowStatus, NetworkData } from './types';
-import { isValidUrl, throwError } from './utils';
+import { getSubgraphUrl, isValidUrl, throwError } from './utils';
 
 /**
  * ## Introduction
@@ -1441,7 +1441,7 @@ export class EscrowUtils {
    *   AVALANCHE_TESTNET = 43113,
    *   CELO = 42220,
    *   CELO_ALFAJORES = 44787,
-   *   SKALE = 1273227453,
+   *    = 1273227453,
    *   LOCALHOST = 1338,
    * }
    * ```
@@ -1534,7 +1534,7 @@ export class EscrowUtils {
         }
 
         const { escrows } = await gqlFetch<{ escrows: EscrowData[] }>(
-          networkData.subgraphUrl,
+          getSubgraphUrl(networkData),
           GET_ESCROWS_QUERY(filter),
           {
             ...filter,
@@ -1586,7 +1586,6 @@ export class EscrowUtils {
    *   AVALANCHE_TESTNET = 43113,
    *   CELO = 42220,
    *   CELO_ALFAJORES = 44787,
-   *   SKALE = 1273227453,
    *   LOCALHOST = 1338,
    * }
    * ```
@@ -1647,7 +1646,7 @@ export class EscrowUtils {
 
     try {
       const { escrow } = await gqlFetch<{ escrow: EscrowData }>(
-        networkData.subgraphUrl,
+        getSubgraphUrl(networkData),
         GET_ESCROW_BY_ADDRESS_QUERY(),
         { escrowAddress: escrowAddress.toLowerCase() }
       );

package/src/graphql/queries/kvstore.ts

@@ -0,0 +1,23 @@
+import gql from 'graphql-tag';
+
+const KVSTORE_FRAGMENT = gql`
+  fragment KVStoreFields on KVStore {
+    id
+    block
+    timestamp
+    address
+    key
+    value
+  }
+`;
+
+export const GET_KVSTORE_BY_ADDRESS_QUERY = () => {
+  return gql`
+    query getKVStoreData($address: String!) {
+      kvstores(where: { address: $address }) {
+        ...KVStoreFields
+      }
+    }
+    ${KVSTORE_FRAGMENT}
+  `;
+};

package/src/graphql/queries/transaction.ts

@@ -0,0 +1,59 @@
+import gql from 'graphql-tag';
+import { ITransactionsFilter } from '../../../src/interfaces';
+
+const TRANSACTION_FRAGMENT = gql`
+  fragment TransactionFields on Transaction {
+    block
+    txHash
+    from
+    to
+    timestamp
+    value
+    method
+  }
+`;
+
+export const GET_TRANSACTIONS_QUERY = (filter: ITransactionsFilter) => {
+  const { startDate, endDate, startBlock, endBlock, fromAddress, toAddress } =
+    filter;
+
+  const WHERE_CLAUSE = `
+    where: {
+      ${fromAddress ? `from: $fromAddress` : ''}
+      ${toAddress ? `to: $toAddress` : ''}
+      ${startDate ? `timestamp_gte: $startDate` : ''}
+      ${endDate ? `timestamp_lte: $endDate` : ''}
+      ${startBlock ? `block_gte: $startBlock` : ''}
+      ${endBlock ? `block_lte: $endBlock` : ''}
+    }
+  `;
+
+  return gql`
+    query getTransactions(
+        $fromAddress: String
+        $toAddress: String
+        $startDate: Int
+        $endDate: Int
+        $startBlock: Int
+        $endBlock: Int
+    ) {
+      transactions(
+        ${WHERE_CLAUSE}
+        orderBy: timestamp,
+        orderDirection: asc,
+      ) {
+        ...TransactionFields
+      }
+    }
+    ${TRANSACTION_FRAGMENT}
+  `;
+};
+
+export const GET_TRANSACTION_QUERY = gql`
+  query getTransaction($hash: String!) {
+    transaction(id: $hash) {
+      ...TransactionFields
+    }
+  }
+  ${TRANSACTION_FRAGMENT}
+`;

package/src/graphql/types.ts

@@ -155,3 +155,12 @@ export type DailyTaskData = {
 export type TaskStatistics = {
   dailyTasksData: DailyTaskData[];
 };
+
+export type KVStoreData = {
+  id: string;
+  address: string;
+  key: string;
+  value: string;
+  timestamp: Date;
+  block: number;
+};

package/src/interfaces.ts

@@ -40,7 +40,7 @@ export interface ILeaderSubgraph extends Omit<ILeader, 'jobTypes'> {
 }
 
 export interface ILeadersFilter {
-  networks: ChainId[];
+  chainId: ChainId;
   role?: string;
 }
 
@@ -108,3 +108,28 @@ export interface IPayoutFilter {
   from?: Date;
   to?: Date;
 }
+
+export interface IKVStore {
+  key: string;
+  value: string;
+}
+
+export interface ITransaction {
+  block: bigint;
+  hash: string;
+  from: string;
+  to: string;
+  timestamp: bigint;
+  value: string;
+  method: string;
+}
+
+export interface ITransactionsFilter {
+  networks: ChainId[];
+  startBlock?: number;
+  endBlock?: number;
+  startDate?: Date;
+  endDate?: Date;
+  fromAddress?: string;
+  toAddress?: string;
+}

package/src/kvstore.ts

@@ -16,8 +16,12 @@ import {
   ErrorProviderDoesNotExist,
   ErrorUnsupportedChainID,
 } from './error';
+import gqlFetch from 'graphql-request';
 import { NetworkData } from './types';
-import { isValidUrl } from './utils';
+import { getSubgraphUrl, isValidUrl } from './utils';
+import { GET_KVSTORE_BY_ADDRESS_QUERY } from './graphql/queries/kvstore';
+import { KVStoreData } from './graphql';
+import { IKVStore } from './interfaces';
 /**
  * ## Introduction
  *
@@ -410,3 +414,112 @@ export class KVStoreClient extends BaseEthersClient {
     return publicKey;
   }
 }
+
+/**
+ * ## 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 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);
+   * ```
+   */
+  public static async getKVStoreData(
+    chainId: ChainId,
+    address: string
+  ): Promise<IKVStore[]> {
+    const networkData = NETWORKS[chainId];
+
+    if (!networkData) {
+      throw ErrorUnsupportedChainID;
+    }
+
+    if (address && !ethers.isAddress(address)) {
+      throw ErrorInvalidAddress;
+    }
+
+    const { kvstores } = await gqlFetch<{ kvstores: KVStoreData[] }>(
+      getSubgraphUrl(networkData),
+      GET_KVSTORE_BY_ADDRESS_QUERY(),
+      { address: address.toLowerCase() }
+    );
+
+    const kvStoreData = kvstores.map((item) => ({
+      key: item.key,
+      value: item.value,
+    }));
+
+    return kvStoreData || [];
+  }
+}