@human-protocol/sdk 1.1.3 → 1.1.5

package/dist/types.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Enum for escrow statuses.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum EscrowStatus {
+    /**
+     * Escrow is launched.
+     */
+    Launched = 0,
+    /**
+     * Escrow is funded, and waiting for the results to be submitted.
+     */
+    Pending = 1,
+    /**
+     * Escrow is partially paid out.
+     */
+    Partial = 2,
+    /**
+     * Escrow is fully paid.
+     */
+    Paid = 3,
+    /**
+     * Escrow is finished..
+     */
+    Complete = 4,
+    /**
+     * Escrow is cancelled.
+     */
+    Cancelled = 5
+}
+/**
+ * AWS/GCP cloud storage access data
+ * @readonly
+ */
+export type StorageCredentials = {
+    /**
+     * Access Key
+     */
+    accessKey: string;
+    /**
+     * Secret Key
+     */
+    secretKey: string;
+};
+export type StorageParams = {
+    /**
+     * Request endPoint
+     */
+    endPoint: string;
+    /**
+     * Enable secure (HTTPS) access. Default value set to false
+     */
+    useSSL: boolean;
+    /**
+     * Region
+     */
+    region?: string;
+    /**
+     * TCP/IP port number. Default value set to 80 for HTTP and 443 for HTTPs
+     */
+    port?: number;
+};
+/**
+ * Upload file data
+ * @readonly
+ */
+export type UploadFile = {
+    /**
+     * Uploaded object key
+     */
+    key: string;
+    /**
+     * Hash of uploaded object key
+     */
+    hash: string;
+};
+/**
+ * Network data
+ */
+export type NetworkData = {
+    /**
+     * Network chain id
+     */
+    chainId: number;
+    /**
+     * Network title
+     */
+    title: string;
+    /**
+     * Network scanner URL
+     */
+    scanUrl: string;
+    /**
+     * HMT Token contract address
+     */
+    hmtAddress: string;
+    /**
+     * Escrow Factory contract address
+     */
+    factoryAddress: string;
+    /**
+     * Staking contract address
+     */
+    stakingAddress: string;
+    /**
+     * KVStore contract address
+     */
+    kvstoreAddress: string;
+    /**
+     * Subgraph URL
+     */
+    subgraphUrl: string;
+    /**
+     * Old subgraph URL
+     */
+    oldSubgraphUrl: string;
+    /**
+     * Old Escrow Factory contract address
+     */
+    oldFactoryAddress: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +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;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,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,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,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/dist/types.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EscrowStatus = void 0;
+/**
+ * Enum for escrow statuses.
+ * @readonly
+ * @enum {number}
+ */
+var EscrowStatus;
+(function (EscrowStatus) {
+    /**
+     * Escrow is launched.
+     */
+    EscrowStatus[EscrowStatus["Launched"] = 0] = "Launched";
+    /**
+     * Escrow is funded, and waiting for the results to be submitted.
+     */
+    EscrowStatus[EscrowStatus["Pending"] = 1] = "Pending";
+    /**
+     * Escrow is partially paid out.
+     */
+    EscrowStatus[EscrowStatus["Partial"] = 2] = "Partial";
+    /**
+     * Escrow is fully paid.
+     */
+    EscrowStatus[EscrowStatus["Paid"] = 3] = "Paid";
+    /**
+     * Escrow is finished..
+     */
+    EscrowStatus[EscrowStatus["Complete"] = 4] = "Complete";
+    /**
+     * Escrow is cancelled.
+     */
+    EscrowStatus[EscrowStatus["Cancelled"] = 5] = "Cancelled";
+})(EscrowStatus = exports.EscrowStatus || (exports.EscrowStatus = {}));

package/dist/utils.d.ts

@@ -0,0 +1,32 @@
+/**
+ * **Get specific error text.*
+ *
+ * @param {any} error - An error message.
+ * @returns
+ */
+export declare const getRevertReason: (error: any) => string;
+/**
+ * **Handle and throw the error.*
+ *
+ * @param {any} e
+ * @returns
+ */
+export declare const throwError: (e: any) => never;
+/**
+ * **URL validation.*
+ *
+ * @param {string} url
+ * @returns
+ */
+export declare const isValidUrl: (url: string) => boolean;
+/**
+ * **Fetching data with queries.*
+ *
+ * @param {string} url
+ * @param {string} query
+ * @param {any} variables
+ * @param {any} headers
+ * @returns
+ */
+export declare const gqlFetch: (url: string, query: string, variables?: any, headers?: any) => Promise<import("axios").AxiosResponse<any, any>>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAiBA;;;;;GAKG;AACH,eAAO,MAAM,eAAe,UAAW,GAAG,KAAG,MAO5C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,MAAO,GAAG,UAqBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,YAOrC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,QACd,MAAM,SACJ,MAAM,cACD,GAAG,YACL,GAAG,qDAYd,CAAC"}

package/dist/utils.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gqlFetch = exports.isValidUrl = exports.throwError = exports.getRevertReason = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const axios_1 = __importDefault(require("axios"));
+const ethers_1 = require("ethers");
+const error_1 = require("./error");
+/**
+ * **Get specific error text.*
+ *
+ * @param {any} error - An error message.
+ * @returns
+ */
+const getRevertReason = (error) => {
+    const prefix = "reverted with reason string '";
+    const suffix = "'";
+    const message = error.data.substring(error.data.indexOf(prefix) + prefix.length);
+    return message.substring(0, message.indexOf(suffix));
+};
+exports.getRevertReason = getRevertReason;
+/**
+ * **Handle and throw the error.*
+ *
+ * @param {any} e
+ * @returns
+ */
+const throwError = (e) => {
+    if (e.code === ethers_1.ethers.utils.Logger.errors.INVALID_ARGUMENT) {
+        throw new error_1.InvalidArgumentError(e.message);
+    }
+    else if (e.code === 'OUT_OF_GAS') {
+        throw new error_1.OutOfGasError(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.CALL_EXCEPTION) {
+        const reason = (0, exports.getRevertReason)(e.data);
+        throw new error_1.ContractExecutionError(reason);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.UNPREDICTABLE_GAS_LIMIT) {
+        throw new error_1.UnpredictableGasLimit(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.TRANSACTION_REPLACED) {
+        throw new error_1.TransactionReplaced(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.REPLACEMENT_UNDERPRICED) {
+        throw new error_1.ReplacementUnderpriced(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.NUMERIC_FAULT) {
+        throw new error_1.NumericFault(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.NONCE_EXPIRED) {
+        throw new error_1.NonceExpired(e.message);
+    }
+    else {
+        throw new error_1.EthereumError(e.message);
+    }
+};
+exports.throwError = throwError;
+/**
+ * **URL validation.*
+ *
+ * @param {string} url
+ * @returns
+ */
+const isValidUrl = (url) => {
+    try {
+        new URL(url);
+        return true;
+    }
+    catch (err) {
+        return false;
+    }
+};
+exports.isValidUrl = isValidUrl;
+/**
+ * **Fetching data with queries.*
+ *
+ * @param {string} url
+ * @param {string} query
+ * @param {any} variables
+ * @param {any} headers
+ * @returns
+ */
+const gqlFetch = (url, query, variables, headers) => {
+    if (url && url.length) {
+        return axios_1.default.post(url, JSON.stringify({ query, variables }), {
+            headers: {
+                'Content-Type': 'application/json',
+                ...headers,
+            },
+        });
+    }
+    else {
+        return Promise.reject(error_1.ErrorNoURLprovided);
+    }
+};
+exports.gqlFetch = gqlFetch;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "files": [
     "src",
     "dist"
@@ -38,8 +38,10 @@
   "dependencies": {
     "@human-protocol/core": "*",
     "aws-sdk": "^2.1255.0",
+    "axios": "^1.4.0",
     "crypto": "^1.0.1",
     "ethers": "^5.7.2",
+    "minio": "^7.0.32",
     "secp256k1": "^4.0.3",
     "vitest": "^0.30.1",
     "winston": "^3.8.2"

package/src/constants.ts

@@ -217,7 +217,7 @@ export const NETWORKS: {
     scanUrl: '',
     factoryAddress: '0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9',
     hmtAddress: '0x5FbDB2315678afecb367f032d93F642f64180aa3',
-    stakingAddress: '0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512',
+    stakingAddress: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
     kvstoreAddress: '0x5FC8d32690cc91D4c39d9d3abcBD16989F875707',
     subgraphUrl: '',
     oldSubgraphUrl: '',

package/src/escrow.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import {
   HMToken__factory,
   HMToken,
@@ -6,7 +7,7 @@ import {
   EscrowFactory__factory,
   Escrow__factory,
 } from '@human-protocol/core/typechain-types';
-import { BigNumber, ContractReceipt, Signer, ethers, providers } from 'ethers';
+import { BigNumber, ContractReceipt, Signer, ethers } from 'ethers';
 import { Provider } from '@ethersproject/abstract-provider';
 import {
   ErrorAmountMustBeGreaterThanZero,
@@ -24,7 +25,6 @@ import {
   ErrorListOfHandlersCannotBeEmpty,
   ErrorRecipientAndAmountsMustBeSameLength,
   ErrorRecipientCannotBeEmptyArray,
-  ErrorSigner,
   ErrorTotalFeeMustBeLessThanHundred,
   ErrorUrlIsEmptyString,
   InvalidEthereumAddressError,
@@ -96,11 +96,15 @@ export default class EscrowClient {
         )
       ).wait();
 
-      if (!result.events || !result.events[0] || !result.events[0].args) {
+      const event = result.events?.find(({ topics }) =>
+        topics.includes(ethers.utils.id('Launched(address,address)'))
+      )?.args;
+
+      if (!event) {
         throw ErrorLaunchedEventIsNotEmitted;
       }
 
-      return result.events[0].args[1];
+      return event.escrow;
     } catch (e: any) {
       return throwError(e);
     }

package/src/staking.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { Provider } from '@ethersproject/abstract-provider';
 import {
   Staking__factory,

package/src/storage.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import axios from 'axios';
 import crypto from 'crypto';
 import * as Minio from 'minio';