@human-protocol/sdk 4.2.0 → 5.0.0-beta.0

package/dist/staking.js

@@ -8,15 +8,21 @@ 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.StakingClient = void 0;
+exports.StakingUtils = exports.StakingClient = void 0;
 const typechain_types_1 = require("@human-protocol/core/typechain-types");
 const ethers_1 = require("ethers");
+const graphql_request_1 = __importDefault(require("graphql-request"));
 const base_1 = require("./base");
 const constants_1 = require("./constants");
 const decorators_1 = require("./decorators");
+const enums_1 = require("./enums");
 const error_1 = require("./error");
 const utils_1 = require("./utils");
+const staking_1 = require("./graphql/queries/staking");
 /**
  * ## Introduction
  *
@@ -363,6 +369,7 @@ class StakingClient extends base_1.BaseEthersClient {
         }
         try {
             const stakerInfo = await this.stakingContract.stakes(stakerAddress);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
             const currentBlock = await this.runner.provider.getBlockNumber();
             const tokensWithdrawable = stakerInfo.tokensLockedUntil !== 0n &&
                 currentBlock >= stakerInfo.tokensLockedUntil
@@ -415,3 +422,79 @@ __decorate([
     __metadata("design:paramtypes", [String, String, String, BigInt, Object]),
     __metadata("design:returntype", Promise)
 ], StakingClient.prototype, "slash", null);
+/**
+ * Utility class for Staking-related subgraph queries.
+ */
+class StakingUtils {
+    /**
+     * Gets staking info for a staker from the subgraph.
+     *
+     * @param {ChainId} chainId Network in which the staking contract is deployed
+     * @param {string} stakerAddress Address of the staker
+     * @returns {Promise<IStaker>} Staker info from subgraph
+     */
+    static async getStaker(chainId, stakerAddress) {
+        if (!ethers_1.ethers.isAddress(stakerAddress)) {
+            throw error_1.ErrorInvalidStakerAddressProvided;
+        }
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        const { staker } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), staking_1.GET_STAKER_BY_ADDRESS_QUERY, { id: stakerAddress.toLowerCase() });
+        if (!staker) {
+            throw error_1.ErrorStakerNotFound;
+        }
+        return staker;
+    }
+    /**
+     * Gets all stakers from the subgraph with filters, pagination and ordering.
+     *
+     * @returns {Promise<IStaker[]>} Array of stakers
+     */
+    static async getStakers(filter) {
+        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 orderBy = filter.orderBy || 'lastDepositTimestamp';
+        const networkData = constants_1.NETWORKS[filter.chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        const { stakers } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, staking_1.GET_STAKERS_QUERY)(filter), {
+            minStakedAmount: filter.minStakedAmount
+                ? filter.minStakedAmount
+                : undefined,
+            maxStakedAmount: filter.maxStakedAmount
+                ? filter.maxStakedAmount
+                : undefined,
+            minLockedAmount: filter.minLockedAmount
+                ? filter.minLockedAmount
+                : undefined,
+            maxLockedAmount: filter.maxLockedAmount
+                ? filter.maxLockedAmount
+                : undefined,
+            minWithdrawnAmount: filter.minWithdrawnAmount
+                ? filter.minWithdrawnAmount
+                : undefined,
+            maxWithdrawnAmount: filter.maxWithdrawnAmount
+                ? filter.maxWithdrawnAmount
+                : undefined,
+            minSlashedAmount: filter.minSlashedAmount
+                ? filter.minSlashedAmount
+                : undefined,
+            maxSlashedAmount: filter.maxSlashedAmount
+                ? filter.maxSlashedAmount
+                : undefined,
+            orderBy: orderBy,
+            orderDirection: orderDirection,
+            first: first,
+            skip: skip,
+        });
+        if (!stakers) {
+            return [];
+        }
+        return stakers;
+    }
+}
+exports.StakingUtils = StakingUtils;

package/dist/types.d.ts

@@ -28,7 +28,11 @@ export declare enum EscrowStatus {
     /**
      * Escrow is cancelled.
      */
-    Cancelled = 5
+    Cancelled = 5,
+    /**
+     * Escrow is cancelled.
+     */
+    ToCancel = 6
 }
 /**
  * AWS/GCP cloud storage access data
@@ -133,19 +137,6 @@ export type NetworkData = {
      */
     oldFactoryAddress: string;
 };
-/**
- * Represents the response data for an escrow cancellation.
- */
-export type EscrowCancel = {
-    /**
-     * The hash of the transaction associated with the escrow cancellation.
-     */
-    txHash: string;
-    /**
-     * The amount refunded in the escrow cancellation.
-     */
-    amountRefunded: bigint;
-};
 /**
  * Represents the response data for an escrow withdrawal.
  */
@@ -161,7 +152,7 @@ export type EscrowWithdraw = {
     /**
      * The amount withdrawn from the escrow.
      */
-    amountWithdrawn: bigint;
+    withdrawnAmount: bigint;
 };
 /**
  * Represents a payout from an escrow.
@@ -188,6 +179,39 @@ export type Payout = {
      */
     createdAt: number;
 };
+/**
+ * Represents a cancellation refund event.
+ */
+export type CancellationRefund = {
+    /**
+     * Unique identifier of the cancellation refund event.
+     */
+    id: string;
+    /**
+     * The address of the escrow associated with the cancellation refund.
+     */
+    escrowAddress: string;
+    /**
+     * The address of the receiver who received the refund.
+     */
+    receiver: string;
+    /**
+     * The amount refunded to the receiver.
+     */
+    amount: bigint;
+    /**
+     * The block number in which the cancellation refund event occurred.
+     */
+    block: number;
+    /**
+     * The timestamp when the cancellation refund event occurred (in UNIX format).
+     */
+    timestamp: number;
+    /**
+     * The transaction hash of the cancellation refund event.
+     */
+    txHash: string;
+};
 export type TransactionLikeWithNonce = TransactionLike & {
     nonce: number;
 };

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

package/dist/types.js

@@ -32,4 +32,8 @@ var EscrowStatus;
      * Escrow is cancelled.
      */
     EscrowStatus[EscrowStatus["Cancelled"] = 5] = "Cancelled";
+    /**
+     * Escrow is cancelled.
+     */
+    EscrowStatus[EscrowStatus["ToCancel"] = 6] = "ToCancel";
 })(EscrowStatus || (exports.EscrowStatus = EscrowStatus = {}));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "4.2.0",
+  "version": "5.0.0-beta.0",
   "files": [
     "src",
     "dist"
@@ -40,7 +40,7 @@
   "dependencies": {
     "@human-protocol/core": "x",
     "axios": "^1.4.0",
-    "ethers": "~6.13.5",
+    "ethers": "~6.15.0",
     "graphql": "^16.8.1",
     "graphql-request": "^6.1.0",
     "graphql-tag": "^2.12.6",

package/src/constants.ts

@@ -51,7 +51,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/sepolia/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmURrhnEXimGnRzjeN3B4VMmioUeBHUBg4WJ7KZzJ7em8g',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmVYn12ZqBeZf9J9orq9RYV1C9iQ9uyWWF5vsWFJiKR68e',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -81,7 +81,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/bsc-testnet/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmZHqbiyAAwrmqsVJLhTEdejVGYJpXfJAkJXUw7C2VV1TD',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmfRiMaGaL224Z5ii4JAJjfyT64KysYM9gFFWbkDW9QwK1',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest',
     oldFactoryAddress: '0xaae6a2646c1f88763e62e0cd08ad050ea66ac46f',
@@ -113,7 +113,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/amoy/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmeeE9bVkat1mkbQg1R6SXLuLadXxoNCY5b7CEQkmu6cQi',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmRHsvZo2wW2Y3fDHz6xsHd6wBQyacbzKmFfNYQ8Zy3KLy',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -128,7 +128,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/amoy/version/latest',
     subgraphUrlApiKey:
-      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmQiLaFKusXLzKrpZvQDg7vETLhdfPgzWJN3Uxp3bE9K9W',
+      'https://gateway-arbitrum.network.thegraph.com/api/[SUBGRAPH_API_KEY]/deployments/id/QmVHYvjbsgAroR9EMgqqGTQ7aKPRFMVekY6evU6mFPUU7J',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },

package/src/error.ts

@@ -170,6 +170,11 @@ export const ErrorProviderDoesNotExist = new Error('Provider does not exist');
  */
 export const ErrorUnsupportedChainID = new Error('Unsupported chain ID');
 
+/**
+ * @constant {Error} - Staker not found.
+ */
+export const ErrorStakerNotFound = new Error('Staker not found');
+
 /**
  * @constant {Error} - Sending a transaction requires a signer.
  */
@@ -206,13 +211,6 @@ export const ErrorInvalidUrl = new Error('Invalid URL string');
  */
 export const ErrorInvalidManifest = new Error('Invalid manifest');
 
-/**
- * @constant {Error} - List of handlers cannot be empty.
- */
-export const ErrorListOfHandlersCannotBeEmpty = new Error(
-  'List of handlers cannot be empty'
-);
-
 /**
  * @constant {Error} - No URL provided.
  */
@@ -294,6 +292,26 @@ export const ErrorInvalidHash = new Error('Invalid hash');
  */
 export const ErrorUnsupportedStatus = new Error('Unsupported status for query');
 
+/**
+ * @constant {Error} - Invalid storeResults parameters for the escrow version
+ */
+export const ErrorStoreResultsVersion = new Error(
+  'Invalid storeResults parameters for the contract version of the specified escrow address'
+);
+
+/**
+ * @constant {Error} - Invalid bulkPayOut parameters for the escrow version
+ */
+export const ErrorBulkPayOutVersion = new Error(
+  'Invalid bulkPayOut parameters for the contract version of the specified escrow address'
+);
+
+/**
+ * @constant {Warning} - Possible version mismatch.
+ */
+export const WarnVersionMismatch =
+  'There may be a mismatch between the parameters passed and the expected parameters of the escrow contract version';
+
 /**
  * @constant {Warning} - The SUBGRAPH_API_KEY is not being provided.
  */