@human-protocol/sdk 1.1.5 → 1.1.7

package/dist/queries.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RAW_LAUNCHED_ESCROWS_FILTERED_QUERY = exports.RAW_LAUNCHED_ESCROWS_QUERY = exports.RAW_REWARDS_QUERY = void 0;
+const types_1 = require("./types");
 const RAW_REWARDS_QUERY = (slasherAddress) => `{
     rewardAddedEvents(id: "${slasherAddress}") {
       escrow,
@@ -8,15 +9,11 @@ const RAW_REWARDS_QUERY = (slasherAddress) => `{
     }
   }`;
 exports.RAW_REWARDS_QUERY = RAW_REWARDS_QUERY;
-const RAW_LAUNCHED_ESCROWS_QUERY = () => `{
-    launchedEscrows(where: { from: $address }) {
+const RAW_LAUNCHED_ESCROWS_QUERY = (requesterAddress) => `{
+    launchedEscrows(where: { from: ${requesterAddress} }) {
       id
     }
   }`;
 exports.RAW_LAUNCHED_ESCROWS_QUERY = RAW_LAUNCHED_ESCROWS_QUERY;
-const RAW_LAUNCHED_ESCROWS_FILTERED_QUERY = () => `{
-    launchedEscrows(where: { from: $address, status: $status, timestamp_gte: $from, timestamp_lte: $to }) {
-      id
-    }
-  }`;
+const RAW_LAUNCHED_ESCROWS_FILTERED_QUERY = (address, status, from, to) => `{ launchedEscrows(where: { ${address ? 'from: "' + address + '", ' : ''}${status ? 'status: "' + types_1.EscrowStatus[status] + '", ' : ''}${from ? 'timestamp_gte: "' + from?.valueOf() + '", ' : ''}${to ? 'timestamp_lte: "' + to?.valueOf() + '"' : ''}}) { id }}`;
 exports.RAW_LAUNCHED_ESCROWS_FILTERED_QUERY = RAW_LAUNCHED_ESCROWS_FILTERED_QUERY;

package/dist/staking.d.ts

@@ -1,21 +1,30 @@
 import { Provider } from '@ethersproject/abstract-provider';
-import { HMToken, Staking, EscrowFactory } from '@human-protocol/core/typechain-types';
+import { EscrowFactory, HMToken, Staking } from '@human-protocol/core/typechain-types';
 import { BigNumber, Signer } from 'ethers';
+import { IAllocation, IReward, IStaker } from './interfaces';
 import { NetworkData } from './types';
-import { IAllocation, IClientParams, IReward, IStaker } from './interfaces';
-export default class StakingClient {
-    readonly clientParams: IClientParams;
+export declare class StakingClient {
     signerOrProvider: Signer | Provider;
     network: NetworkData;
     tokenContract: HMToken;
     stakingContract: Staking;
     escrowFactoryContract: EscrowFactory;
     /**
-     * **Staking constructor**
+     * **StakingClient constructor**
      *
-     * @param {IClientParams} clientParams - Init client parameters
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {NetworkData} network - The network information required to connect to the Staking contract
      */
-    constructor(clientParams: IClientParams);
+    constructor(signerOrProvider: Signer | Provider, network: NetworkData);
+    /**
+     * Creates an instance of StakingClient from a Signer or Provider.
+     *
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @returns {Promise<StakingClient>} - An instance of StakingClient
+     * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
+     * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
+     */
+    static build(signerOrProvider: Signer | Provider): Promise<StakingClient>;
     /**
      * **Approves the staking contract to transfer a specified amount of tokens when the user stakes.
      * **It increases the allowance for the staking contract.*
@@ -97,7 +106,7 @@ export default class StakingClient {
     /**
      * **Returns the staking information about all stakers of the protocol.*
      *
-     * @returns {Promise<IStakerInfo>} - Return an array with all stakers information
+     * @returns {Promise<IStaker[]>} - Return an array with all stakers information
      * @throws {Error} - An error object if an error occurred, results otherwise
      */
     getAllStakers(): Promise<IStaker[]>;

package/dist/staking.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../src/staking.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAGL,OAAO,EACP,OAAO,EAGP,aAAa,EAEd,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAU,MAAM,EAAE,MAAM,QAAQ,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAc5E,MAAM,CAAC,OAAO,OAAO,aAAa;IAYpB,QAAQ,CAAC,YAAY,EAAE,aAAa;IAXzC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,aAAa,CAAC;IAE5C;;;;OAIG;gBACkB,YAAY,EAAE,aAAa;IAoBhD;;;;;;;OAOG;IAEU,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB3D;;;;;;OAMG;IAEU,KAAK,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBpD;;;;;;;OAOG;IAEU,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtD;;;;;OAKG;IAEU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAStC;;;;;;;;;;OAUG;IAEU,KAAK,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;;;OAOG;IAEU,QAAQ,CACnB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC;IAyBhB;;;;;;OAMG;IAEU,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBlE;;;;;;OAMG;IAEU,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBpE;;;;;;OAMG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA6BxD;;;;;OAKG;IACU,aAAa,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IA+BhD;;;;;;OAMG;IACU,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAiBvE;;;;;;OAMG;IACU,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAqBpE"}
+{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../src/staking.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAE5D,OAAO,EACL,aAAa,EAEb,OAAO,EAIP,OAAO,EAER,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAenD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGtC,qBAAa,aAAa;IACjB,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,aAAa,EAAE,OAAO,CAAC;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,aAAa,CAAC;IAE5C;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM,GAAG,QAAQ,EAAE,OAAO,EAAE,WAAW;IAoBrE;;;;;;;OAOG;WACiB,KAAK,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ;IAsB7D;;;;;;;OAOG;IAEU,YAAY,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB3D;;;;;;OAMG;IAEU,KAAK,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBpD;;;;;;;OAOG;IAEU,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtD;;;;;OAKG;IAEU,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAStC;;;;;;;;;;OAUG;IAEU,KAAK,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;;;OAOG;IAEU,QAAQ,CACnB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,IAAI,CAAC;IAyBhB;;;;;;OAMG;IAEU,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBlE;;;;;;OAMG;IAEU,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBpE;;;;;;OAMG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA8BxD;;;;;OAKG;IACU,aAAa,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAgChD;;;;;;OAMG;IACU,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAiBvE;;;;;;OAMG;IACU,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAqBpE"}

package/dist/staking.js

@@ -9,25 +9,53 @@ var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.StakingClient = void 0;
 const typechain_types_1 = require("@human-protocol/core/typechain-types");
 const ethers_1 = require("ethers");
+const constants_1 = require("./constants");
+const decorators_1 = require("./decorators");
 const error_1 = require("./error");
-const utils_1 = require("./utils");
 const queries_1 = require("./queries");
-const decorators_1 = require("./decorators");
+const utils_1 = require("./utils");
 class StakingClient {
     /**
-     * **Staking constructor**
+     * **StakingClient constructor**
+     *
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @param {NetworkData} network - The network information required to connect to the Staking contract
+     */
+    constructor(signerOrProvider, network) {
+        this.stakingContract = typechain_types_1.Staking__factory.connect(network.stakingAddress, signerOrProvider);
+        this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(network.factoryAddress, signerOrProvider);
+        this.tokenContract = typechain_types_1.HMToken__factory.connect(network.hmtAddress, signerOrProvider);
+        this.signerOrProvider = signerOrProvider;
+        this.network = network;
+    }
+    /**
+     * Creates an instance of StakingClient from a Signer or Provider.
      *
-     * @param {IClientParams} clientParams - Init client parameters
+     * @param {Signer | Provider} signerOrProvider - The Signer or Provider object to interact with the Ethereum network
+     * @returns {Promise<StakingClient>} - An instance of StakingClient
+     * @throws {ErrorProviderDoesNotExist} - Thrown if the provider does not exist for the provided Signer
+     * @throws {ErrorUnsupportedChainID} - Thrown if the network's chainId is not supported
      */
-    constructor(clientParams) {
-        this.clientParams = clientParams;
-        this.signerOrProvider = clientParams.signerOrProvider;
-        this.network = clientParams.network;
-        this.stakingContract = typechain_types_1.Staking__factory.connect(this.network.stakingAddress, this.signerOrProvider);
-        this.escrowFactoryContract = typechain_types_1.EscrowFactory__factory.connect(this.network.factoryAddress, this.signerOrProvider);
-        this.tokenContract = typechain_types_1.HMToken__factory.connect(this.network.hmtAddress, this.signerOrProvider);
+    static async build(signerOrProvider) {
+        let network;
+        if (ethers_1.Signer.isSigner(signerOrProvider)) {
+            if (!signerOrProvider.provider) {
+                throw error_1.ErrorProviderDoesNotExist;
+            }
+            network = await signerOrProvider.provider.getNetwork();
+        }
+        else {
+            network = await signerOrProvider.getNetwork();
+        }
+        const chainId = network.chainId;
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
+        }
+        return new StakingClient(signerOrProvider, networkData);
     }
     /**
      * **Approves the staking contract to transfer a specified amount of tokens when the user stakes.
@@ -242,6 +270,7 @@ class StakingClient {
                 .sub(tokensAllocated)
                 .sub(tokensLocked);
             return {
+                staker,
                 tokensStaked,
                 tokensAllocated,
                 tokensLocked,
@@ -256,7 +285,7 @@ class StakingClient {
     /**
      * **Returns the staking information about all stakers of the protocol.*
      *
-     * @returns {Promise<IStakerInfo>} - Return an array with all stakers information
+     * @returns {Promise<IStaker[]>} - Return an array with all stakers information
      * @throws {Error} - An error object if an error occurred, results otherwise
      */
     async getAllStakers() {
@@ -265,12 +294,13 @@ class StakingClient {
             if (result[1].length === 0) {
                 throw error_1.ErrorStakingGetStakers;
             }
-            return result[1].map((staker) => {
+            return result[1].map((staker, index) => {
                 const tokensStaked = ethers_1.BigNumber.from(staker.tokensStaked), tokensAllocated = ethers_1.BigNumber.from(staker.tokensAllocated), tokensLocked = ethers_1.BigNumber.from(staker.tokensLocked), tokensLockedUntil = ethers_1.BigNumber.from(staker.tokensLockedUntil);
                 const tokensAvailable = tokensStaked
                     .sub(tokensAllocated)
                     .sub(tokensLocked);
                 return {
+                    staker: result[0][index],
                     tokensStaked,
                     tokensAllocated,
                     tokensLocked,
@@ -378,4 +408,4 @@ __decorate([
     __metadata("design:paramtypes", [String]),
     __metadata("design:returntype", Promise)
 ], StakingClient.prototype, "distributeRewards", null);
-exports.default = StakingClient;
+exports.StakingClient = StakingClient;

package/dist/storage.d.ts

@@ -1,6 +1,7 @@
 import { UploadFile, StorageCredentials, StorageParams } from './types';
-export default class StorageClient {
+export declare class StorageClient {
     private client;
+    private clientParams;
     /**
      * **Storage client constructor**
      *

package/dist/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAIxE,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,OAAO,CAAC,MAAM,CAAe;IAE7B;;;;;OAKG;gBACS,WAAW,EAAE,kBAAkB,EAAE,MAAM,EAAE,aAAa;IAYlE;;;;;OAKG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAoB1E;;;;;OAKG;WACiB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBlE;;;;;;OAMG;IACU,WAAW,CACtB,KAAK,EAAE,GAAG,EAAE,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,EAAE,CAAC;IA0BxB;;;;;OAKG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3D;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB5D"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAIxE,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,YAAY,CAAgB;IAEpC;;;;;OAKG;gBACS,WAAW,EAAE,kBAAkB,EAAE,MAAM,EAAE,aAAa;IAclE;;;;;OAKG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAoB1E;;;;;OAKG;WACiB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBlE;;;;;;OAMG;IACU,WAAW,CACtB,KAAK,EAAE,GAAG,EAAE,EACZ,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,UAAU,EAAE,CAAC;IAkCxB;;;;;OAKG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3D;;;;;OAKG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqB5D"}

package/dist/storage.js

@@ -26,6 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.StorageClient = void 0;
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const axios_1 = __importDefault(require("axios"));
 const crypto_1 = __importDefault(require("crypto"));
@@ -42,6 +43,7 @@ class StorageClient {
      */
     constructor(credentials, params) {
         try {
+            this.clientParams = params;
             this.client = new Minio.Client({
                 ...params,
                 accessKey: credentials.accessKey,
@@ -114,12 +116,16 @@ class StorageClient {
         return Promise.all(files.map(async (file) => {
             const content = JSON.stringify(file);
             const hash = crypto_1.default.createHash('sha1').update(content).digest('hex');
-            const key = hash;
+            const key = `s3${hash}.json`;
             try {
                 await this.client.putObject(bucket, key, content, {
                     'Content-Type': 'application/json',
                 });
-                return { key, hash };
+                return {
+                    key,
+                    url: `${this.clientParams.useSSL ? 'https' : 'http'}://${this.clientParams.endPoint}${this.clientParams.port ? `:${this.clientParams.port}` : ''}/${bucket}/${key}`,
+                    hash,
+                };
             }
             catch (e) {
                 throw error_1.ErrorStorageFileNotUploaded;
@@ -162,4 +168,4 @@ class StorageClient {
         }
     }
 }
-exports.default = StorageClient;
+exports.StorageClient = StorageClient;

package/dist/types.d.ts

@@ -70,6 +70,10 @@ export type UploadFile = {
      * Uploaded object key
      */
     key: string;
+    /**
+     * Uploaded object URL
+     */
+    url: string;
     /**
      * Hash of uploaded object key
      */
@@ -103,6 +107,10 @@ export type NetworkData = {
      * Staking contract address
      */
     stakingAddress: string;
+    /**
+     * RewardPool contract address
+     */
+    rewardPoolAddress: string;
     /**
      * KVStore contract address
      */

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;;;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"}
+{"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,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"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "files": [
     "src",
     "dist"
@@ -10,6 +10,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "clean": "rm -rf ./dist",
+    "prebuild": "yarn workspace @human-protocol/core build",
     "build": "npm run clean && tsc",
     "prepublish": "npm run build",
     "test": "vitest -u",

package/src/constants.ts

@@ -58,6 +58,7 @@ export const NETWORKS: {
     factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
     hmtAddress: '0xd1ba9BAC957322D6e8c07a160a3A8dA11A0d2867',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
+    rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mainnet-v1',
@@ -71,6 +72,7 @@ export const NETWORKS: {
     factoryAddress: '0x925B24444511c86F4d4E63141D8Be0A025E2dca4',
     hmtAddress: '0x4dCf5ac4509888714dd43A5cCc46d7ab389D9c23',
     stakingAddress: '',
+    rewardPoolAddress: '',
     kvstoreAddress: '',
     subgraphUrl: '',
     oldSubgraphUrl: '',
@@ -83,6 +85,7 @@ export const NETWORKS: {
     factoryAddress: '0x87469B4f2Fcf37cBd34E54244c0BD4Fa0603664c',
     hmtAddress: '0xd3A31D57FDD790725d0F6B78095F62E8CD4ab317',
     stakingAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
+    rewardPoolAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
     kvstoreAddress: '0xc9Fe39c4b6e1d7A2991355Af159956982DADf842',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/goerli-v1',
@@ -94,11 +97,11 @@ export const NETWORKS: {
     chainId: ChainId.BSC_MAINNET,
     title: 'Binance Smart Chain',
     scanUrl: 'https://bscscan.com',
-    factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
-    hmtAddress: '0x0d501B743F22b641B8C8dfe00F1AAb881D57DDC7',
-    stakingAddress: '0xC2163A0928034e020f0d31e1171Ba0D6d9AfFB6c',
-    kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
-
+    factoryAddress: '0x92FD968AcBd521c232f5fB8c33b342923cC72714',
+    hmtAddress: '0x711Fd6ab6d65A98904522d4e3586F492B989c527',
+    stakingAddress: '0xdFbB79dC35a3A53741be54a2C9b587d6BafAbd1C',
+    rewardPoolAddress: '0xf376443BCc6d4d4D63eeC086bc4A9E4a83878e0e',
+    kvstoreAddress: '0x2B95bEcb6EBC4589f64CB000dFCF716b4aeF8aA6',
     subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc-v1',
     oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
     oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
@@ -110,6 +113,7 @@ export const NETWORKS: {
     factoryAddress: '0x2bfA592DBDaF434DDcbb893B1916120d181DAD18',
     hmtAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
     stakingAddress: '0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18',
+    rewardPoolAddress: '0xB0A0500103eCEc431b73F6BAd923F0a2774E6e29',
     kvstoreAddress: '0x3aD4B091E054f192a822D1406f4535eAd38580e4',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest-v1',
@@ -124,6 +128,7 @@ export const NETWORKS: {
     factoryAddress: '0xBDBfD2cC708199C5640C6ECdf3B0F4A4C67AdfcB',
     hmtAddress: '0xc748B2A084F8eFc47E086ccdDD9b7e67aEb571BF',
     stakingAddress: '0xcbAd56bE3f504E98bd70875823d3CC0242B7bB29',
+    rewardPoolAddress: '0xa8e32d777a3839440cc7c24D591A64B9481753B3',
     kvstoreAddress: '0x35Cf4beBD58F9C8D75B9eA2599479b6C173d406F',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon-v1',
@@ -138,6 +143,7 @@ export const NETWORKS: {
     factoryAddress: '0xA8D927C4DA17A6b71675d2D49dFda4E9eBE58f2d',
     hmtAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
     stakingAddress: '0x7Fd3dF914E7b6Bd96B4c744Df32183b51368Bfac',
+    rewardPoolAddress: '0xf0145eD99AC3c4f877aDa7dA4D1E059ec9116BAE',
     kvstoreAddress: '0xD7F61E812e139a5a02eDae9Dfec146E1b8eA3807',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mumbai-v1',
@@ -152,6 +158,7 @@ export const NETWORKS: {
     factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
     hmtAddress: '0x3b25BC1dC591D24d60560d0135D6750A561D4764',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
+    rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbeam-v1',
@@ -166,6 +173,7 @@ export const NETWORKS: {
     factoryAddress: '0x5e622FF522D81aa426f082bDD95210BC25fCA7Ed',
     hmtAddress: '0x2dd72db2bBA65cE663e476bA8b84A1aAF802A8e3',
     stakingAddress: '0xBFC7009F3371F93F3B54DdC8caCd02914a37495c',
+    rewardPoolAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
     kvstoreAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbase-alpha-v1',
@@ -179,6 +187,7 @@ export const NETWORKS: {
     factoryAddress: '0xfb4469201951C3B9a7F1996c477cb7BDBEcE0A88',
     hmtAddress: '0x9406d5c635AD22b0d76c75E52De57A2177919ca3',
     stakingAddress: '',
+    rewardPoolAddress: '',
     kvstoreAddress: '0xd232c1426CF0653cE8a71DC98bCfDf10c471c114',
 
     subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/fuji',
@@ -192,6 +201,7 @@ export const NETWORKS: {
     factoryAddress: '0x9767a578ba7a5FA1563c8229943cB01cd8446BB4',
     hmtAddress: '0x12365293cb6477d4fc2686e46BB97E3Fb64f1550',
     stakingAddress: '',
+    rewardPoolAddress: '',
     kvstoreAddress: '0x4B79eaD28F52eD5686bf0e379717e85fc7aD10Df',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/avalanche',
@@ -205,6 +215,7 @@ export const NETWORKS: {
     factoryAddress: '0x319070b49C8d1cC015915D1E7Eb5fd8e22833885',
     hmtAddress: '0x6E5FF61Ea88270F6142E0E0eC8cbe9d67476CbCd',
     stakingAddress: '0x79F37FB9C210910733c16228AC4D14a8e32C11BD',
+    rewardPoolAddress: '0x881218246c25C6898aE96145259584340153aDA2',
     kvstoreAddress: '0xE1055607327b1be2080D31211dCDC4D9338CaF4A',
     subgraphUrl:
       'https://graph-skale.humanprotocol.org/subgraphs/name/skale-human',
@@ -218,9 +229,17 @@ export const NETWORKS: {
     factoryAddress: '0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9',
     hmtAddress: '0x5FbDB2315678afecb367f032d93F642f64180aa3',
     stakingAddress: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
+    rewardPoolAddress: '0xa513E6E4b8f2a923D98304ec87F64353C4D5C853',
     kvstoreAddress: '0x5FC8d32690cc91D4c39d9d3abcBD16989F875707',
     subgraphUrl: '',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
 };
+
+export const KVStoreKeys = {
+  role: 'role',
+  webhook_url: 'webhook_url',
+  fee: 'fee',
+  public_key: 'public_key',
+};

package/src/encryption.ts

@@ -0,0 +1,223 @@
+import * as openpgp from 'openpgp';
+import { IKeyPair } from './interfaces';
+/**
+ * Class for encryption and decryption operations.
+ */
+export class Encryption {
+  private privateKey: openpgp.PrivateKey;
+
+  /**
+   * Constructor for the Encryption class.
+   *
+   * @param {PrivateKey} privateKey - The private key.
+   */
+  constructor(privateKey: openpgp.PrivateKey) {
+    this.privateKey = privateKey;
+  }
+
+  /**
+   * Builds an Encryption instance by decrypting the private key from an encrypted private key and passphrase.
+   *
+   * @param {string} privateKeyArmored - The encrypted private key in armored format.
+   * @param {string} passphrase - Optional: The passphrase for the private key.
+   * @returns {Promise<Encryption>} - The Encryption instance.
+   */
+  public static async build(
+    privateKeyArmored: string,
+    passphrase?: string
+  ): Promise<Encryption> {
+    const options = {
+      armoredKey: privateKeyArmored,
+    };
+
+    if (!passphrase) {
+      return new Encryption(await openpgp.readPrivateKey(options));
+    }
+
+    const privateKey = await openpgp.readPrivateKey(options);
+    return new Encryption(
+      await openpgp.decryptKey({
+        privateKey,
+        passphrase,
+      })
+    );
+  }
+
+  /**
+   * Signs and encrypts a message using the specified public keys.
+   *
+   * @param {string} message - The message to encrypt.
+   * @param {string[]} publicKeys - The public keys in armored format.
+   * @returns {Promise<string>} - The encrypted message.
+   */
+  public async signAndEncrypt(
+    message: string,
+    publicKeys: string[]
+  ): Promise<string> {
+    const plaintext = message;
+
+    const pgpPublicKeys = await Promise.all(
+      publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey }))
+    );
+
+    const pgpMessage = await openpgp.createMessage({ text: plaintext });
+    const encrypted = await openpgp.encrypt({
+      message: pgpMessage,
+      encryptionKeys: pgpPublicKeys,
+      signingKeys: this.privateKey,
+    });
+
+    return encrypted as string;
+  }
+
+  /**
+   * Decrypts an encrypted message using the private key.
+   *
+   * @param {string} message - The encrypted message.
+   * @param {string} publicKey - Optional: The public key in armored format for signature verification.
+   * @returns {Promise<string>} - The decrypted message.
+   */
+  public async decrypt(message: string, publicKey?: string): Promise<string> {
+    const pgpMessage = await openpgp.readMessage({ armoredMessage: message });
+
+    const decryptionOptions: openpgp.DecryptOptions = {
+      message: pgpMessage,
+      decryptionKeys: this.privateKey,
+      expectSigned: !!publicKey,
+    };
+
+    if (publicKey) {
+      const pgpPublicKey = await openpgp.readKey({ armoredKey: publicKey });
+      decryptionOptions.verificationKeys = pgpPublicKey;
+    }
+
+    const { data: decrypted } = await openpgp.decrypt(decryptionOptions);
+
+    return decrypted as string;
+  }
+
+  /**
+   * Signs a message using the private key.
+   *
+   * @param {string} message - The message to sign.
+   * @returns {Promise<string>} - The signed message.
+   */
+  public async sign(message: string): Promise<string> {
+    const unsignedMessage = await openpgp.createCleartextMessage({
+      text: message,
+    });
+    const cleartextMessage = await openpgp.sign({
+      message: unsignedMessage,
+      signingKeys: this.privateKey,
+      format: 'armored',
+    });
+
+    return cleartextMessage;
+  }
+}
+
+/**
+ * Utility class for encryption-related operations.
+ */
+export class EncryptionUtils {
+  /**
+   * Verifies the signature of a signed message using the public key.
+   *
+   * @param {string} message - The signed message.
+   * @param {string} publicKey - The public key in armored format.
+   * @returns {Promise<boolean>} - A boolean indicating if the signature is valid.
+   */
+  public static async verify(
+    message: string,
+    publicKey: string
+  ): Promise<boolean> {
+    const pgpPublicKey = await openpgp.readKey({ armoredKey: publicKey });
+    const signedMessage = await openpgp.readCleartextMessage({
+      cleartextMessage: message,
+    });
+
+    const verificationResult = await signedMessage.verify([pgpPublicKey]);
+    const { verified } = verificationResult[0];
+
+    try {
+      return await verified;
+    } catch {
+      return false;
+    }
+  }
+
+  /**
+   * Gets the signed data from a signed message.
+   *
+   * @param {string} message - The signed message.
+   * @returns {Promise<string>} - The signed data.
+   * @throws {Error} - An error object if an error occurred.
+   */
+  public static async getSignedData(message: string): Promise<string> {
+    const signedMessage = await openpgp.readCleartextMessage({
+      cleartextMessage: message,
+    });
+
+    try {
+      return signedMessage.getText();
+    } catch (e) {
+      throw new Error('Could not get data: ' + e.message);
+    }
+  }
+
+  /**
+   * Generates a key pair for encryption and decryption.
+   *
+   * @param {string} name - The name for the key pair.
+   * @param {string} email - The email for the key pair.
+   * @param {string} passphrase - The passphrase used to encrypt the private key.
+   * @returns {Promise<IKeyPair>} - The generated key pair.
+   */
+  public static async generateKeyPair(
+    name: string,
+    email: string,
+    passphrase = ''
+  ): Promise<IKeyPair> {
+    const { privateKey, publicKey, revocationCertificate } =
+      await openpgp.generateKey({
+        type: 'ecc',
+        curve: 'ed25519',
+        userIDs: [{ name: name, email: email }],
+        passphrase: passphrase,
+        format: 'armored',
+      });
+
+    return {
+      passphrase: passphrase,
+      privateKey,
+      publicKey,
+      revocationCertificate,
+    };
+  }
+
+  /**
+   * Encrypts a message using the specified public keys.
+   *
+   * @param {string} message - The message to encrypt.
+   * @param {string[]} publicKeys - The public keys in armored format.
+   * @returns {Promise<string>} - The encrypted message.
+   */
+  public static async encrypt(
+    message: string,
+    publicKeys: string[]
+  ): Promise<string> {
+    const plaintext = message;
+
+    const pgpPublicKeys = await Promise.all(
+      publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey }))
+    );
+
+    const pgpMessage = await openpgp.createMessage({ text: plaintext });
+    const encrypted = await openpgp.encrypt({
+      message: pgpMessage,
+      encryptionKeys: pgpPublicKeys,
+    });
+
+    return encrypted as string;
+  }
+}

package/src/error.ts

@@ -141,14 +141,12 @@ export const ErrorHMTokenAmountNotApproved = new Error('Amount not approved');
 /**
  * @constant {Error} - Init provider does not exists.
  */
-export const ErrorInitProviderDoesNotExist = new Error(
-  'Provider does not exist'
-);
+export const ErrorProviderDoesNotExist = new Error('Provider does not exist');
 
 /**
  * @constant {Error} - Init with unsupported chain ID.
  */
-export const ErrorInitUnsupportedChainID = new Error('Unsupported chain ID');
+export const ErrorUnsupportedChainID = new Error('Unsupported chain ID');
 
 /**
  * @constant {Error} - Sending a transaction requires a signer.