@human-protocol/sdk 1.0.2 → 1.0.3

package/dist/error.js

@@ -0,0 +1,229 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionReplaced = exports.NonceExpired = exports.NumericFault = exports.ReplacementUnderpriced = exports.UnpredictableGasLimit = exports.OutOfGasError = exports.InvalidArgumentError = exports.EthereumError = exports.ErrorHashIsEmptyString = exports.ErrorLaunchedEventIsNotEmitted = exports.ErrorRecipientAndAmountsMustBeSameLength = exports.ErrorAmountsCannotBeEmptyArray = exports.ErrorEscrowDoesNotHaveEnoughBalance = exports.ErrorAmountMustBeGreaterThanZero = exports.ErrorRecipientCannotBeEmptyArray = exports.ErrorTotalFeeMustBeLessThanHundred = exports.ErrorFeeMustBeBetweenZeroAndHundred = exports.ErrorNoURLprovided = exports.ErrorListOfHandlersCannotBeEmpty = exports.ErrorUrlIsEmptyString = exports.ErrorInvalidUrl = exports.ErrorStorageClientDoesNotExist = exports.ErrorManifestFileDoesNotExist = exports.ErrorEscrowAddressIsNotProvidedByFactory = exports.ErrorSigner = exports.ErrorInitUnsupportedChainID = exports.ErrorInitProviderDoesNotExist = exports.ErrorHMTokenAmountNotApproved = exports.ErrorFailedToCheckAllowance = exports.ErrorFailedToApproveStakingAmountSignerDoesNotExist = exports.ErrorStakingGetStakers = exports.ErrorInvalidEscrowAddressProvided = exports.ErrorInvalidStakerAddressProvided = exports.ErrorInvalidSlasherAddressProvided = exports.ErrorInvalidStakingValueSign = exports.ErrorInvalidStakingValueType = exports.ErrorStakingValueMustBePositive = exports.ErrorInvalidReputationOracleAddressProvided = exports.ErrorInvalidRecordingOracleAddressProvided = exports.ErrorInvalidTokenAddress = exports.ErrorInvalidAddress = exports.ErrorKVStoreArrayLength = exports.ErrorKVStoreEmptyKey = exports.ErrorStorageFileNotUploaded = exports.ErrorStorageFileNotFound = exports.ErrorStorageBucketNotFound = exports.ErrorStorageCredentialsMissing = exports.ErrorStorageClientNotExists = exports.ErrorStorageClientNotInitialized = exports.ErrorStakingMissing = void 0;
+exports.InvalidEthereumAddressError = exports.ContractExecutionError = void 0;
+/**
+ * @constant {Error} - The Staking contract is missing.
+ */
+exports.ErrorStakingMissing = new Error('Staking contract is missing');
+/**
+ * @constant {Error} - The Storage client not initialised.
+ */
+exports.ErrorStorageClientNotInitialized = new Error('Storage client not initialized');
+/**
+ * @constant {Error} - The Storage does not exists.
+ */
+exports.ErrorStorageClientNotExists = new Error('Storage client does not exists');
+/**
+ * @constant {Error} - The Storage credentials is missing.
+ */
+exports.ErrorStorageCredentialsMissing = new Error('Storage credentials is missing');
+/**
+ * @constant {Error} - The Storage bucket not found.
+ */
+exports.ErrorStorageBucketNotFound = new Error('Bucket not found');
+/**
+ * @constant {Error} - The Storage file not found.
+ */
+exports.ErrorStorageFileNotFound = new Error('File not found');
+/**
+ * @constant {Error} - The Storage file not uploaded.
+ */
+exports.ErrorStorageFileNotUploaded = new Error('File not uploaded');
+/**
+ * @constant {Error} - The KVStore key can not be empty.
+ */
+exports.ErrorKVStoreEmptyKey = new Error('Key can not be empty');
+/**
+ * @constant {Error} - The KVStore arrays must have the same length.
+ */
+exports.ErrorKVStoreArrayLength = new Error('Arrays must have the same length');
+/**
+ * @constant {Error} - The Address sent is invalid.
+ */
+exports.ErrorInvalidAddress = new Error('Invalid address');
+/**
+ * @constant {Error} - The token address sent is invalid.
+ */
+exports.ErrorInvalidTokenAddress = new Error('Invalid token address');
+/**
+ * @constant {Error} - Invalid recording oracle address provided.
+ */
+exports.ErrorInvalidRecordingOracleAddressProvided = new Error('Invalid recording oracle address provided');
+/**
+ * @constant {Error} - Invalid reputation oracle address provided.
+ */
+exports.ErrorInvalidReputationOracleAddressProvided = new Error('Invalid reputation oracle address provided');
+/**
+ * @constant {Error} - The Staking value must be positive.
+ */
+exports.ErrorStakingValueMustBePositive = new Error('Value must be positive');
+/**
+ * @constant {Error} - Invalid staking value: amount must be a BigNumber.
+ */
+exports.ErrorInvalidStakingValueType = new Error('Invalid staking value: amount must be a BigNumber');
+/**
+ * @constant {Error} - Invalid staking value: amount must be positive.
+ */
+exports.ErrorInvalidStakingValueSign = new Error('Invalid staking value: amount must be positive');
+/**
+ * @constant {Error} - Invalid slasher address provided.
+ */
+exports.ErrorInvalidSlasherAddressProvided = new Error('Invalid slasher address provided');
+/**
+ * @constant {Error} - Invalid staker address provided.
+ */
+exports.ErrorInvalidStakerAddressProvided = new Error('Invalid staker address provided');
+/**
+ * @constant {Error} - Invalid escrow address provided.
+ */
+exports.ErrorInvalidEscrowAddressProvided = new Error('Invalid escrow address provided');
+/**
+ * @constant {Error} - Error getting stakers data.
+ */
+exports.ErrorStakingGetStakers = new Error('Error getting stakers data');
+/**
+ * @constant {Error} - Failed to approve staking amount: signerOrProvider is not a Signer instance.
+ */
+exports.ErrorFailedToApproveStakingAmountSignerDoesNotExist = new Error('Failed to approve staking amount: signerOrProvider is not a Signer instance');
+exports.ErrorFailedToCheckAllowance = new Error('Failed to check allowance');
+/**
+ * @constant {Error} - The HMToken amount not approved.
+ */
+exports.ErrorHMTokenAmountNotApproved = new Error('Amount not approved');
+/**
+ * @constant {Error} - Init provider does not exists.
+ */
+exports.ErrorInitProviderDoesNotExist = new Error('Provider does not exist');
+/**
+ * @constant {Error} - Init with unsupported chain ID.
+ */
+exports.ErrorInitUnsupportedChainID = new Error('Unsupported chain ID');
+/**
+ * @constant {Error} - Sending a transaction requires a signer.
+ */
+exports.ErrorSigner = new Error('Signer required');
+/**
+ * @constant {Error} - Escrow address is not provided by the factory.
+ */
+exports.ErrorEscrowAddressIsNotProvidedByFactory = new Error('Escrow address is not provided by the factory');
+/**
+ * @constant {Error} - Manifest file does not exist.
+ */
+exports.ErrorManifestFileDoesNotExist = new Error('Manifest file does not exist');
+/**
+ * @constant {Error} - Storage client does not exist.
+ */
+exports.ErrorStorageClientDoesNotExist = new Error('Storage client does not exist');
+/**
+ * @constant {Error} - Invalid URL string.
+ */
+exports.ErrorInvalidUrl = new Error('Invalid URL string');
+/**
+ * @constant {Error} - URL is an empty string.
+ */
+exports.ErrorUrlIsEmptyString = new Error('URL is an empty string');
+/**
+ * @constant {Error} - List of handlers cannot be empty.
+ */
+exports.ErrorListOfHandlersCannotBeEmpty = new Error('List of handlers cannot be empty');
+/**
+ * @constant {Error} - No URL provided.
+ */
+exports.ErrorNoURLprovided = new Error('No URL provided');
+/**
+ * @constant {Error} - Fee must be between 0 and 100.
+ */
+exports.ErrorFeeMustBeBetweenZeroAndHundred = new Error('Fee must be between 0 and 100');
+/**
+ * @constant {Error} - Total fee must be less than 100.
+ */
+exports.ErrorTotalFeeMustBeLessThanHundred = new Error('Total fee must be less than 100');
+/**
+ * @constant {Error} - Recipient cannot be an empty array.
+ */
+exports.ErrorRecipientCannotBeEmptyArray = new Error('Recipient cannot be an empty array');
+/**
+ * @constant {Error} - Amount must be greater than zero..
+ */
+exports.ErrorAmountMustBeGreaterThanZero = new Error('Amount must be greater than zero');
+/**
+ * @constant {Error} - Escrow does not have enough balance.
+ */
+exports.ErrorEscrowDoesNotHaveEnoughBalance = new Error('Escrow does not have enough balance');
+/**
+ * @constant {Error} - Amounts cannot be an empty array.
+ */
+exports.ErrorAmountsCannotBeEmptyArray = new Error('Amounts cannot be an empty array');
+/**
+ * @constant {Error} - Recipient and amounts must be the same length.
+ */
+exports.ErrorRecipientAndAmountsMustBeSameLength = new Error('Recipient and amounts must be the same length');
+/**
+ * @constant {Error} - Launched event is not emitted.
+ */
+exports.ErrorLaunchedEventIsNotEmitted = new Error('Launched event is not emitted');
+/**
+ * @constant {Error} - Hash is an empty string.
+ */
+exports.ErrorHashIsEmptyString = new Error('Hash is an empty string');
+class EthereumError extends Error {
+    constructor(message) {
+        super(`An error occurred while interacting with Ethereum: ${message}`);
+    }
+}
+exports.EthereumError = EthereumError;
+class InvalidArgumentError extends EthereumError {
+    constructor(message) {
+        super(`Invalid argument: ${message}`);
+    }
+}
+exports.InvalidArgumentError = InvalidArgumentError;
+class OutOfGasError extends EthereumError {
+    constructor(message) {
+        super(`Out of gas: ${message}`);
+    }
+}
+exports.OutOfGasError = OutOfGasError;
+class UnpredictableGasLimit extends EthereumError {
+    constructor(message) {
+        super(`Unpredictable gas limit: ${message}`);
+    }
+}
+exports.UnpredictableGasLimit = UnpredictableGasLimit;
+class ReplacementUnderpriced extends EthereumError {
+    constructor(message) {
+        super(`Replacement underpriced: ${message}`);
+    }
+}
+exports.ReplacementUnderpriced = ReplacementUnderpriced;
+class NumericFault extends EthereumError {
+    constructor(message) {
+        super(`Numeric fault: ${message}`);
+    }
+}
+exports.NumericFault = NumericFault;
+class NonceExpired extends EthereumError {
+    constructor(message) {
+        super(`Nonce expired: ${message}`);
+    }
+}
+exports.NonceExpired = NonceExpired;
+class TransactionReplaced extends EthereumError {
+    constructor(message) {
+        super(`Transaction replaced: ${message}`);
+    }
+}
+exports.TransactionReplaced = TransactionReplaced;
+class ContractExecutionError extends EthereumError {
+    constructor(reason) {
+        super(`Contract execution error: ${reason}`);
+    }
+}
+exports.ContractExecutionError = ContractExecutionError;
+class InvalidEthereumAddressError extends Error {
+    constructor(address) {
+        super(`Invalid ethereum address error: ${address}`);
+    }
+}
+exports.InvalidEthereumAddressError = InvalidEthereumAddressError;

package/dist/escrow.d.ts

@@ -0,0 +1,176 @@
+import { BigNumber } from 'ethers';
+import { IClientParams, IEscrowConfig, IEscrowsFilter, ILauncherEscrowsResult } from './interfaces';
+import { EscrowStatus, NetworkData } from './types';
+export default class EscrowClient {
+    readonly clientParams: IClientParams;
+    private escrowFactoryContract;
+    private escrowContract?;
+    private signerOrProvider;
+    network: NetworkData;
+    /**
+     * **Escrow constructor**
+     *
+     *   * @param {IClientParams} clientParams - Init client parameters
+     */
+    constructor(clientParams: IClientParams);
+    /**
+     * Creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
+     *
+     * @param {string} tokenAddress - Token address to use for pay outs.
+     * @param {string[]} trustedHandlers - Array of addresses that can perform actions on the contract.
+     * @returns {Promise<string>} - Return the address of the escrow created.
+     * @throws {Error} - An error object if an error occurred.
+     */
+    createEscrow(tokenAddress: string, trustedHandlers: string[]): Promise<string>;
+    /**
+     * Sets up the parameters of the escrow.
+     *
+     * @param {string} escrowAddress - Address of the escrow to set up.
+     * @param {IEscrowConfig} escrowConfig - Configuration object with escrow settings.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    setup(escrowAddress: string, escrowConfig: IEscrowConfig): Promise<void>;
+    /**
+     * **Creates an escrow contract that uses the token passed to pay oracle fees and reward workers.*
+     * **Sets up the parameters of the escrow.*
+     *
+     * @param {string} tokenAddress - Token address to use for pay outs.
+     * @param {string[]} trustedHandlers - Array of addresses that can perform actions on the contract.
+     * @param {IEscrowConfig} escrowConfig - Configuration object with escrow settings.
+     * @returns {Promise<string>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    createAndSetupEscrow(tokenAddress: string, trustedHandlers: string[], escrowConfig: IEscrowConfig): Promise<string>;
+    /**
+     * **Adds funds of the chosen token to the escrow.*
+     *
+     * @param {string} escrowAddress - Address of the escrow to fund.
+     * @param {BigNumber} amount - Amount to be added as funds.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    fund(escrowAddress: string, amount: BigNumber): Promise<void>;
+    /**
+     * **Stores the results.*
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @param {string} sender - Address of the sender.
+     * @param {string} url - Results file url.
+     * @param {string} hash - Results file hash.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    storeResults(escrowAddress: string, url: string, hash: string): Promise<void>;
+    /**
+     * **Sets the status of an escrow to completed.*
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    complete(escrowAddress: string): Promise<void>;
+    /**
+     * Pays out the amounts specified to the workers and sets the URL of the final results file.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @param {string[]} recipients - Array of recipient addresses.
+     * @param {BigNumber[]} amounts - Array of amounts the recipients will receive.
+     * @param {string} finalResultsUrl - Final results file url.
+     * @param {string} finalResultsHash - Final results file hash.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    bulkPayOut(escrowAddress: string, recipients: string[], amounts: BigNumber[], finalResultsUrl: string, finalResultsHash: string): Promise<void>;
+    /**
+     * Cancels the specified escrow and sends the balance to the canceler.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    cancel(escrowAddress: string): Promise<void>;
+    /**
+     * Cancels the specified escrow, sends the balance to the canceler and selfdestructs the escrow contract.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    abort(escrowAddress: string): Promise<void>;
+    /**
+     * Adds an array of addresses to the trusted handlers list.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @param {string[]} trustedHandlers - List of trusted handler addresses.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    addTrustedHandlers(escrowAddress: string, trustedHandlers: string[]): Promise<void>;
+    /**
+     * Returns the balance for a specified escrow address.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<BigNumber>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getBalance(escrowAddress: string): Promise<BigNumber>;
+    /**
+     * Returns the manifest file URL.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getManifestUrl(escrowAddress: string): Promise<string>;
+    /**
+     * Returns the results file URL.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getResultsUrl(escrowAddress: string): Promise<string>;
+    /**
+     * Returns the value for a specified key and address
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getTokenAddress(escrowAddress: string): Promise<string>;
+    /**
+     * Returns the current status of the escrow.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getStatus(escrowAddress: string): Promise<EscrowStatus>;
+    /**
+     * Returns the current status of the escrow.
+     *
+     * @param {IEscrowsFilter} requesterAddress - Address of the requester.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getLaunchedEscrows(requesterAddress: string): Promise<ILauncherEscrowsResult[]>;
+    /**
+     * Returns the escrows addresses created by a job requester.
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @param {IEscrowsFilter} filer - Filter parameters.
+     * @returns {Promise<void>}
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getEscrowsFiltered(escrowAddress: string, filter: IEscrowsFilter): Promise<ILauncherEscrowsResult[]>;
+    /**
+     * Returns the recording oracle address of given escrow
+     *
+     * @param {string} escrowAddress - Address of the escrow.
+     * @returns {Promise<string>} - Address of the recording oracle.
+     * @throws {Error} - An error object if an error occurred.
+     */
+    getRecordingOracleAddress(escrowAddress: string): Promise<string>;
+}
+//# sourceMappingURL=escrow.d.ts.map

package/dist/escrow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAA8C,MAAM,QAAQ,CAAC;AAuB/E,OAAO,EACL,aAAa,EACb,aAAa,EACb,cAAc,EACd,sBAAsB,EACvB,MAAM,cAAc,CAAC;AAOtB,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGpD,MAAM,CAAC,OAAO,OAAO,YAAY;IAWnB,QAAQ,CAAC,YAAY,EAAE,aAAa;IAVhD,OAAO,CAAC,qBAAqB,CAAgB;IAC7C,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,gBAAgB,CAAoB;IACrC,OAAO,EAAE,WAAW,CAAC;IAE5B;;;;OAIG;gBACkB,YAAY,EAAE,aAAa;IAUhD;;;;;;;OAOG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,MAAM,CAAC;IA6BlB;;;;;;;OAOG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,IAAI,CAAC;IAkEhB;;;;;;;;;OASG;IAEG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,MAAM,CAAC;IAelB;;;;;;;OAOG;IAEG,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCnE;;;;;;;;;OASG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;;OAMG;IAEG,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBpD;;;;;;;;;;OAUG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,SAAS,EAAE,EACpB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC;IAqEhB;;;;;;OAMG;IAEG,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBlD;;;;;;OAMG;IAEG,KAAK,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjD;;;;;;;OAOG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;OAMG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAoB3D;;;;;;OAMG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB5D;;;;;;OAMG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB3D;;;;;;OAMG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAoB7D;;;;;;OAMG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAoB7D;;;;;;OAMG;IACG,kBAAkB,CACtB,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAoBpC;;;;;;;OAOG;IACG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,sBAAsB,EAAE,CAAC;IA2BpC;;;;;;OAMG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAmBxE"}