@human-protocol/sdk 1.0.2 → 1.0.4

package/dist/interfaces.d.ts

@@ -0,0 +1,44 @@
+import { BigNumber, Signer } from 'ethers';
+import { Provider } from '@ethersproject/abstract-provider';
+import { NetworkData } from './types';
+export interface IClientParams {
+    signerOrProvider: Signer | Provider;
+    network: NetworkData;
+}
+export interface IAllocation {
+    escrowAddress: string;
+    staker: string;
+    tokens: BigNumber;
+    createdAt: BigNumber;
+    closedAt: BigNumber;
+}
+export interface IReward {
+    escrowAddress: string;
+    amount: BigNumber;
+}
+export interface IStaker {
+    tokensStaked: BigNumber;
+    tokensAllocated: BigNumber;
+    tokensLocked: BigNumber;
+    tokensLockedUntil: BigNumber;
+    tokensAvailable: BigNumber;
+}
+export interface IEscrowsFilter {
+    address: string;
+    role?: number;
+    status?: number;
+    from?: Date;
+    to?: Date;
+}
+export interface IEscrowConfig {
+    recordingOracle: string;
+    reputationOracle: string;
+    recordingOracleFee: BigNumber;
+    reputationOracleFee: BigNumber;
+    manifestUrl: string;
+    hash: string;
+}
+export interface ILauncherEscrowsResult {
+    id: string;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,MAAM,WAAW,aAAa;IAC5B,gBAAgB,EAAE,MAAM,GAAG,QAAQ,CAAC;IACpC,OAAO,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,CAAC;IAClB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED,MAAM,WAAW,OAAO;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,SAAS,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,YAAY,EAAE,SAAS,CAAC;IACxB,eAAe,EAAE,SAAS,CAAC;IAC3B,YAAY,EAAE,SAAS,CAAC;IACxB,iBAAiB,EAAE,SAAS,CAAC;IAC7B,eAAe,EAAE,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,EAAE,CAAC,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,mBAAmB,EAAE,SAAS,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;CACZ"}

package/dist/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/kvstore.d.ts

@@ -0,0 +1,40 @@
+import { IClientParams } from './interfaces';
+export default class KVStoreClient {
+    readonly clientParams: IClientParams;
+    private contract;
+    private signerOrProvider;
+    /**
+     * **KVStore constructor**
+     *
+     *   * @param {IClientParams} clientParams - Init client parameters
+     */
+    constructor(clientParams: IClientParams);
+    /**
+     * Sets a key-value pair in the contract
+     *
+     * @param {string} key - The key of the key-value pair to set
+     * @param {string} value - The value of the key-value pair to set
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred
+     */
+    set(key: string, value: string): Promise<void>;
+    /**
+     * Sets multiple key-value pairs in the contract
+     *
+     * @param {string[]} keys - An array of keys to set
+     * @param {string[]} values - An array of values to set
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred
+     */
+    setBulk(keys: string[], values: string[]): Promise<void>;
+    /**
+     * Gets the value of a key-value pair in the contract
+     *
+     * @param {string} address - The Ethereum address associated with the key-value pair
+     * @param {string} key - The key of the key-value pair to get
+     * @returns {string} - The value of the key-value pair if it exists
+     * @throws {Error} - An error object if an error occurred
+     */
+    get(address: string, key: string): Promise<string | undefined>;
+}
+//# sourceMappingURL=kvstore.d.ts.map

package/dist/kvstore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kvstore.d.ts","sourceRoot":"","sources":["../src/kvstore.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,MAAM,CAAC,OAAO,OAAO,aAAa;IASpB,QAAQ,CAAC,YAAY,EAAE,aAAa;IARhD,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,gBAAgB,CAAoB;IAE5C;;;;OAIG;gBACkB,YAAY,EAAE,aAAa;IAQhD;;;;;;;OAOG;IAEU,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAU3C;;;;;;;OAOG;IAEU,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;IAarD;;;;;;;OAOG;IACU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;CAW9C"}

package/dist/kvstore.js

@@ -0,0 +1,106 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+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 });
+const typechain_types_1 = require("@human-protocol/core/typechain-types");
+const ethers_1 = require("ethers");
+const error_1 = require("./error");
+const decorators_1 = require("./decorators");
+class KVStoreClient {
+    /**
+     * **KVStore constructor**
+     *
+     *   * @param {IClientParams} clientParams - Init client parameters
+     */
+    constructor(clientParams) {
+        this.clientParams = clientParams;
+        this.contract = typechain_types_1.KVStore__factory.connect(clientParams.network.kvstoreAddress, clientParams.signerOrProvider);
+        this.signerOrProvider = clientParams.signerOrProvider;
+    }
+    /**
+     * Sets a key-value pair in the contract
+     *
+     * @param {string} key - The key of the key-value pair to set
+     * @param {string} value - The value of the key-value pair to set
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred
+     */
+    async set(key, value) {
+        if (!ethers_1.Signer.isSigner(this.signerOrProvider))
+            throw error_1.ErrorSigner;
+        if (key === '')
+            throw error_1.ErrorKVStoreEmptyKey;
+        try {
+            await this.contract?.set(key, value);
+        }
+        catch (e) {
+            if (e instanceof Error)
+                throw Error(`Failed to set value: ${e.message}`);
+        }
+    }
+    /**
+     * Sets multiple key-value pairs in the contract
+     *
+     * @param {string[]} keys - An array of keys to set
+     * @param {string[]} values - An array of values to set
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred
+     */
+    async setBulk(keys, values) {
+        if (!ethers_1.Signer.isSigner(this.signerOrProvider))
+            throw error_1.ErrorSigner;
+        if (keys.length !== values.length)
+            throw error_1.ErrorKVStoreArrayLength;
+        if (keys.includes(''))
+            throw error_1.ErrorKVStoreEmptyKey;
+        try {
+            await this.contract?.setBulk(keys, values);
+        }
+        catch (e) {
+            if (e instanceof Error)
+                throw Error(`Failed to set bulk values: ${e.message}`);
+        }
+    }
+    /**
+     * Gets the value of a key-value pair in the contract
+     *
+     * @param {string} address - The Ethereum address associated with the key-value pair
+     * @param {string} key - The key of the key-value pair to get
+     * @returns {string} - The value of the key-value pair if it exists
+     * @throws {Error} - An error object if an error occurred
+     */
+    async get(address, key) {
+        if (key === '')
+            throw error_1.ErrorKVStoreEmptyKey;
+        if (!ethers_1.ethers.utils.isAddress(address))
+            throw error_1.ErrorInvalidAddress;
+        try {
+            const result = await this.contract?.get(address, key);
+            return result;
+        }
+        catch (e) {
+            if (e instanceof Error)
+                throw Error(`Failed to get value: ${e.message}`);
+        }
+    }
+}
+__decorate([
+    decorators_1.requiresSigner,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String]),
+    __metadata("design:returntype", Promise)
+], KVStoreClient.prototype, "set", null);
+__decorate([
+    decorators_1.requiresSigner,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Array]),
+    __metadata("design:returntype", Promise)
+], KVStoreClient.prototype, "setBulk", null);
+exports.default = KVStoreClient;

package/dist/queries.d.ts

@@ -0,0 +1,4 @@
+export declare const RAW_REWARDS_QUERY: (slasherAddress: string) => string;
+export declare const RAW_LAUNCHED_ESCROWS_QUERY: () => string;
+export declare const RAW_LAUNCHED_ESCROWS_FILTERED_QUERY: () => string;
+//# sourceMappingURL=queries.d.ts.map

package/dist/queries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,mBAAoB,MAAM,WAKpD,CAAC;AAEL,eAAO,MAAM,0BAA0B,cAInC,CAAC;AAEL,eAAO,MAAM,mCAAmC,cAI5C,CAAC"}

package/dist/queries.js

@@ -0,0 +1,22 @@
+"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 RAW_REWARDS_QUERY = (slasherAddress) => `{
+    rewardAddedEvents(id: "${slasherAddress}") {
+      escrow,
+      amount
+    }
+  }`;
+exports.RAW_REWARDS_QUERY = RAW_REWARDS_QUERY;
+const RAW_LAUNCHED_ESCROWS_QUERY = () => `{
+    launchedEscrows(where: { from: $address }) {
+      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
+    }
+  }`;
+exports.RAW_LAUNCHED_ESCROWS_FILTERED_QUERY = RAW_LAUNCHED_ESCROWS_FILTERED_QUERY;

package/dist/staking.d.ts

@@ -0,0 +1,121 @@
+import { Provider } from '@ethersproject/abstract-provider';
+import { HMToken, Staking, EscrowFactory } from '@human-protocol/core/typechain-types';
+import { BigNumber, Signer } from 'ethers';
+import { NetworkData } from './types';
+import { IAllocation, IClientParams, IReward, IStaker } from './interfaces';
+export default class StakingClient {
+    readonly clientParams: IClientParams;
+    signerOrProvider: Signer | Provider;
+    network: NetworkData;
+    tokenContract: HMToken;
+    stakingContract: Staking;
+    escrowFactoryContract: EscrowFactory;
+    /**
+     * **Staking constructor**
+     *
+     * @param {IClientParams} clientParams - Init client parameters
+     */
+    constructor(clientParams: IClientParams);
+    /**
+     * **Approves the staking contract to transfer a specified amount of tokens when the user stakes.
+     * **It increases the allowance for the staking contract.*
+     *
+     * @param {BigNumber} amount - Amount of tokens to approve for stake
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred, void otherwise
+     */
+    approveStake(amount: BigNumber): Promise<void>;
+    /**
+     * **Stakes a specified amount of tokens on a specific network.*
+     *
+     * @param {BigNumber} amount - Amount of tokens to stake
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred, void otherwise
+     */
+    stake(amount: BigNumber): Promise<void>;
+    /**
+     * **Unstakes tokens from staking contract.
+     * **The unstaked tokens stay locked for a period of time.*
+     *
+     * @param {BigNumber} amount - Amount of tokens to unstake
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred, void otherwise
+     */
+    unstake(amount: BigNumber): Promise<void>;
+    /**
+     * **Withdraws unstaked and non locked tokens form staking contract to the user wallet.*
+     *
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred, void otherwise
+     */
+    withdraw(): Promise<void>;
+    /**
+     * **Slash the allocated amount by an staker in an escrow and transfers those tokens to the reward pool.
+     * **This allows the slasher to claim them later.*
+     *
+     * @param {string} slasher - Wallet address from who requested the slash
+     * @param {string} staker - Wallet address from who is going to be slashed
+     * @param {string} escrowAddress - Address of the escrow which allocation will be slashed
+     * @param {BigNumber} amount - Amount of tokens to slash
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred, void otherwise
+     */
+    slash(slasher: string, staker: string, escrowAddress: string, amount: BigNumber): Promise<void>;
+    /**
+     * **Allocates a portion of the staked tokens to a specific escrow.*
+     *
+     * @param {string} escrowAddress - Address of the escrow contract
+     * @param {BigNumber} amount - Amount of tokens to allocate
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred, void otherwise
+     */
+    allocate(escrowAddress: string, amount: BigNumber): Promise<void>;
+    /**
+     * **Drops the allocation from a specific escrow.*
+     *
+     * @param {string} escrowAddress - Address of the escrow contract.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred, void otherwise
+     */
+    closeAllocation(escrowAddress: string): Promise<void>;
+    /**
+     * **Pays out rewards to the slashers for the specified escrow address.*
+     *
+     * @param {string} escrowAddress - Escrow address from which rewards are distributed.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred, void otherwise
+     */
+    distributeRewards(escrowAddress: string): Promise<void>;
+    /**
+     * **Returns the staking information about an staker address.*
+     *
+     * @param {string} staker - Address of the staker
+     * @returns {Promise<IStaker>} - Return staking information of the specified address
+     * @throws {Error} - An error object if an error occurred, result otherwise
+     */
+    getStaker(staker: string): Promise<IStaker>;
+    /**
+     * **Returns the staking information about all stakers of the protocol.*
+     *
+     * @returns {Promise<IStakerInfo>} - Return an array with all stakers information
+     * @throws {Error} - An error object if an error occurred, results otherwise
+     */
+    getAllStakers(): Promise<IStaker[]>;
+    /**
+     * **Returns information about the allocation of the specified escrow.*
+     *
+     * @param {string} escrowAddress - The escrow address for the received allocation data
+     * @returns {Promise<IAllocation>} - Returns allocation info if exists
+     * @throws {Error} - An error object if an error occurred, result otherwise
+     */
+    getAllocation(escrowAddress: string): Promise<IAllocation>;
+    /**
+     * **Returns information about the rewards for a given escrow address.*
+     *
+     * @param {string} slasherAddress - Address of the slasher
+     * @returns {Promise<IReward[]>} - Returns rewards info if exists
+     * @throws {Error} - An error object if an error occurred, results otherwise
+     */
+    getRewards(slasherAddress: string): Promise<IReward[]>;
+}
+//# sourceMappingURL=staking.d.ts.map

package/dist/staking.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"staking.d.ts","sourceRoot":"","sources":["../src/staking.ts"],"names":[],"mappings":"AAAA,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"}