@human-protocol/sdk 6.0.0 → 6.1.0

package/dist/staking.js

@@ -158,7 +158,7 @@ class StakingClient extends base_1.BaseEthersClient {
             throw error_1.ErrorInvalidStakingValueSign;
         }
         try {
-            await (await this.tokenContract.approve(await this.stakingContract.getAddress(), amount, txOptions)).wait();
+            await this.sendTxAndWait(async (overrides) => this.tokenContract.approve(await this.stakingContract.getAddress(), amount, overrides), txOptions);
             return;
         }
         catch (e) {
@@ -194,7 +194,7 @@ class StakingClient extends base_1.BaseEthersClient {
             throw error_1.ErrorInvalidStakingValueSign;
         }
         try {
-            await (await this.stakingContract.stake(amount, txOptions)).wait();
+            await this.sendTxAndWait((overrides) => this.stakingContract.stake(amount, overrides), txOptions);
             return;
         }
         catch (e) {
@@ -229,7 +229,7 @@ class StakingClient extends base_1.BaseEthersClient {
             throw error_1.ErrorInvalidStakingValueSign;
         }
         try {
-            await (await this.stakingContract.unstake(amount, txOptions)).wait();
+            await this.sendTxAndWait((overrides) => this.stakingContract.unstake(amount, overrides), txOptions);
             return;
         }
         catch (e) {
@@ -251,7 +251,7 @@ class StakingClient extends base_1.BaseEthersClient {
      */
     async withdraw(txOptions = {}) {
         try {
-            await (await this.stakingContract.withdraw(txOptions)).wait();
+            await this.sendTxAndWait((overrides) => this.stakingContract.withdraw(overrides), txOptions);
             return;
         }
         catch (e) {
@@ -302,7 +302,7 @@ class StakingClient extends base_1.BaseEthersClient {
         }
         await this.checkValidEscrow(escrowAddress);
         try {
-            await (await this.stakingContract.slash(slasher, staker, escrowAddress, amount, txOptions)).wait();
+            await this.sendTxAndWait((overrides) => this.stakingContract.slash(slasher, staker, escrowAddress, amount, overrides), txOptions);
             return;
         }
         catch (e) {

package/dist/transaction.d.ts

@@ -82,8 +82,8 @@ export declare class TransactionUtils {
      *   token?: string; // (Optional) The token address to filter transactions.
      *   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).
+     *   startBlock?: bigint | number; // (Optional) The start block to filter transactions (inclusive).
+     *   endBlock?: bigint | number; // (Optional) The end block to filter transactions (inclusive).
      *   first?: number; // (Optional) Number of transactions per page. Default is 10.
      *   skip?: number; // (Optional) Number of transactions to skip. Default is 0.
      *   orderDirection?: OrderDirection; // (Optional) Order of the results. Default is DESC.

package/dist/transaction.js

@@ -103,8 +103,8 @@ class TransactionUtils {
      *   token?: string; // (Optional) The token address to filter transactions.
      *   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).
+     *   startBlock?: bigint | number; // (Optional) The start block to filter transactions (inclusive).
+     *   endBlock?: bigint | number; // (Optional) The end block to filter transactions (inclusive).
      *   first?: number; // (Optional) Number of transactions per page. Default is 10.
      *   skip?: number; // (Optional) Number of transactions to skip. Default is 0.
      *   orderDirection?: OrderDirection; // (Optional) Order of the results. Default is DESC.
@@ -180,8 +180,8 @@ class TransactionUtils {
                 ? (0, utils_1.getUnixTimestamp)(filter?.startDate)
                 : undefined,
             endDate: filter.endDate ? (0, utils_1.getUnixTimestamp)(filter.endDate) : undefined,
-            startBlock: filter.startBlock ? filter.startBlock : undefined,
-            endBlock: filter.endBlock ? filter.endBlock : undefined,
+            startBlock: filter.startBlock ? Number(filter.startBlock) : undefined,
+            endBlock: filter.endBlock ? Number(filter.endBlock) : undefined,
             method: filter.method ? filter.method : undefined,
             escrow: filter.escrow ? filter.escrow : undefined,
             token: filter.token ? filter.token : undefined,

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { TransactionLike } from 'ethers';
+import { Overrides, TransactionLike } from 'ethers';
 /**
  * Enum for escrow statuses.
  * @readonly
@@ -83,6 +83,19 @@ export type NetworkData = {
      */
     oldFactoryAddress: string;
 };
+/**
+ * Options that configure how long to wait for transaction confirmations.
+ */
+export type WaitOptions = {
+    /** Number of block confirmations to wait for. */
+    confirmations?: number;
+    /** Milliseconds to wait before aborting `tx.wait()`. */
+    timeoutMs?: number;
+};
+/**
+ * Extends ethers overrides with `wait()` options that control confirmation count and timeout.
+ */
+export type TransactionOverrides = Overrides & WaitOptions;
 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;IACT;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAEpD;;;;GAIG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,SAAS,IAAA;IACT;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,iDAAiD;IACjD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,WAAW,CAAC;AAE3D,MAAM,MAAM,wBAAwB,GAAG,eAAe,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
-import { NetworkData } from './types';
 import { SubgraphOptions } from './interfaces';
+import { NetworkData } from './types';
 /**
  * Handles and throws appropriate error types based on the Ethereum error.
  *

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,GAAG,UAgBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,OAMxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,OAO3C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,aAAa,WAAW,WAatD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,IAAI,KAAG,MAE7C,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,OAAO,GAAG,KAAG,OAS3C,CAAC;AAaF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GAAU,CAAC,GAAG,GAAG,EAC1C,KAAK,MAAM,EACX,OAAO,GAAG,EACV,YAAY,GAAG,EACf,UAAU,eAAe,KACxB,OAAO,CAAC,CAAC,CA4CX,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAI,GAAG,GAAG,UAgBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,MAAM,KAAG,OAMxC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,KAAG,OAO3C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,aAAa,WAAW,WAUtD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,IAAI,KAAG,MAE7C,CAAC;AAEF,eAAO,MAAM,cAAc,GAAI,OAAO,GAAG,KAAG,OAS3C,CAAC;AAaF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GAAU,CAAC,GAAG,GAAG,EAC1C,KAAK,MAAM,EACX,OAAO,GAAG,EACV,YAAY,GAAG,EACf,UAAU,eAAe,KACxB,OAAO,CAAC,CAAC,CA4CX,CAAC"}

package/dist/utils.js

@@ -8,7 +8,6 @@ exports.customGqlFetch = exports.isIndexerError = exports.getUnixTimestamp = exp
 const ethers_1 = require("ethers");
 const graphql_request_1 = __importDefault(require("graphql-request"));
 const validator_1 = require("validator");
-const constants_1 = require("./constants");
 const enums_1 = require("./enums");
 const error_1 = require("./error");
 /**
@@ -86,7 +85,7 @@ exports.isValidJson = isValidJson;
 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);
+        subgraphUrl = networkData.subgraphUrlApiKey;
     }
     else if (networkData.chainId !== enums_1.ChainId.LOCALHOST) {
         // eslint-disable-next-line no-console

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "6.0.0",
+  "version": "6.1.0",
   "files": [
     "src",
     "dist"
@@ -53,7 +53,7 @@
     "@types/validator": "^13.15.4",
     "eslint": "^9.39.1",
     "eslint-plugin-jest": "^28.9.0",
-    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-prettier": "^5.5.5",
     "glob": "^13.0.0",
     "prettier": "^3.7.4",
     "ts-node": "^10.9.2",

package/src/base.ts

@@ -1,5 +1,10 @@
-import { ContractRunner } from 'ethers';
-import { NetworkData } from './types';
+import {
+  ContractRunner,
+  ContractTransactionReceipt,
+  ContractTransactionResponse,
+  Overrides,
+} from 'ethers';
+import { NetworkData, TransactionOverrides, WaitOptions } from './types';
 
 /**
  * Base class for clients making on-chain calls.
@@ -20,4 +25,35 @@ export abstract class BaseEthersClient {
     this.networkData = networkData;
     this.runner = runner;
   }
+
+  protected normalizeTxOptions(
+    txOptions?: TransactionOverrides
+  ): [Overrides, WaitOptions] {
+    const options = txOptions ?? {};
+    const {
+      confirmations: waitConfirmations,
+      timeoutMs: waitTimeoutMs,
+      ...overrides
+    } = options;
+
+    const waitOptions: WaitOptions = {
+      confirmations: waitConfirmations,
+      timeoutMs: waitTimeoutMs,
+    };
+
+    return [overrides as Overrides, waitOptions];
+  }
+
+  protected async sendTxAndWait(
+    executeTx: (overrides: Overrides) => Promise<ContractTransactionResponse>,
+    txOptions?: TransactionOverrides
+  ): Promise<ContractTransactionReceipt | null> {
+    const [overrides, waitOptions] = this.normalizeTxOptions(txOptions);
+    const transactionResponse = await executeTx(overrides);
+
+    return transactionResponse.wait(
+      waitOptions.confirmations,
+      waitOptions.timeoutMs
+    );
+  }
 }

package/src/constants.ts

@@ -36,7 +36,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/ethereum/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmeCB3KX49nRAkzgqancc3yL3VMJvt65YtL1zrLCFgr2n5',
+      'https://gateway.thegraph.com/api/deployments/id/QmNhLQEfBJQ46fngBh4YCttk8kNkveFy5uvAeUmyAdX1kD',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -51,7 +51,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/sepolia/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmcMntqZSTh8wJddxgp2hYcdw78wZFU86LHTHzJ1bTVUDc',
+      'https://gateway.thegraph.com/api/deployments/id/QmQghdr7hxqrjFde8DN15TzfrJLCfwvzmUH9RzWwH1mKzk',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -66,7 +66,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/bsc/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmRexbu8eLZ1iE7ZLMtKxAr9GJnQ1JVrXhybKq6JkJ9XLE',
+      'https://gateway.thegraph.com/api/deployments/id/QmTioC9Z1HzKSCnEKL3BP9iHqbgZt1ceLU2VE4Mv6sxNkd',
     oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
     oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
   },
@@ -81,7 +81,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/bsc-testnet/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmfFBXsAP7nbckFx34XYcNq2hRnfoVNrfqCvuk7hmAtYJT',
+      'https://gateway.thegraph.com/api/deployments/id/QmPyUYRjAvzDdeenXMGHcCRD2v4qwZbKMEkVkY3Jq6VLwn',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest',
     oldFactoryAddress: '0xaae6a2646c1f88763e62e0cd08ad050ea66ac46f',
@@ -97,7 +97,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/polygon/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmUwHMDjnDHDB5cowGqd96SRJ1sZegoAPanjxBWUyLZghv',
+      'https://gateway.thegraph.com/api/deployments/id/QmQNkWNE5FPtqbtSkdtR6AEBJz9N7WDz1X7pfvQqYAcUZJ',
     oldSubgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon',
     oldFactoryAddress: '0x45eBc3eAE6DA485097054ae10BA1A0f8e8c7f794',
@@ -113,7 +113,7 @@ export const NETWORKS: {
     subgraphUrl:
       'https://api.studio.thegraph.com/query/74256/amoy/version/latest',
     subgraphUrlApiKey:
-      'https://gateway.thegraph.com/api/deployments/id/QmTJfcvVVmw8fe5CwRP6tZD5FzE2ESrm3ryygS1YZMYhM7',
+      'https://gateway.thegraph.com/api/deployments/id/QmcLwLMw3UzCSbNbjegrpNu6PB3kAd67xquuyaVWvc5Q7Q',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
@@ -154,6 +154,4 @@ export const Role = {
   RecordingOracle: 'recording_oracle',
 };
 
-export const SUBGRAPH_API_KEY_PLACEHOLDER = '[SUBGRAPH_API_KEY]';
-
 export const ESCROW_BULK_PAYOUT_MAX_ITEMS = 99;