@human-protocol/sdk 3.0.8 → 4.0.0

package/dist/constants.d.ts

@@ -5,7 +5,6 @@ export declare const DEFAULT_ENDPOINT = "localhost";
 export declare const DEFAULT_REGION = "eu";
 export declare const DEFAULT_PORT = 9000;
 export declare const DEFAULT_USE_SSL = false;
-export declare const DEFAULT_TX_ID = 1;
 export declare enum HttpStatus {
     OK = 200,
     CREATED = 201,
@@ -37,4 +36,5 @@ export declare const Role: {
     RecordingOracle: string;
 };
 export declare const SUBGRAPH_API_KEY_PLACEHOLDER = "[SUBGRAPH_API_KEY]";
+export declare const ESCROW_BULK_PAYOUT_MAX_ITEMS = 99;
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,eAAO,MAAM,qBAAqB,0BAA0B,CAAC;AAE7D,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC,eAAO,MAAM,YAAY,OAAO,CAAC;AAEjC,eAAO,MAAM,eAAe,QAAQ,CAAC;AAErC,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,oBAAY,UAAU;IACpB,EAAE,MAAM;IACR,OAAO,MAAM;IACb,WAAW,MAAM;IACjB,YAAY,MAAM;IAClB,gBAAgB,MAAM;IACtB,SAAS,MAAM;IACf,SAAS,MAAM;IACf,qBAAqB,MAAM;CAC5B;AAED,eAAO,MAAM,QAAQ,EAAE;KACpB,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,WAAW;CAiRnC,CAAC;AAEF,eAAO,MAAM,WAAW;;;;;;;;;;CAUvB,CAAC;AAEF,eAAO,MAAM,IAAI;;;;;CAKhB,CAAC;AAEF,eAAO,MAAM,4BAA4B,uBAAuB,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,eAAO,MAAM,qBAAqB,0BAA0B,CAAC;AAE7D,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC,eAAO,MAAM,YAAY,OAAO,CAAC;AAEjC,eAAO,MAAM,eAAe,QAAQ,CAAC;AAErC,oBAAY,UAAU;IACpB,EAAE,MAAM;IACR,OAAO,MAAM;IACb,WAAW,MAAM;IACjB,YAAY,MAAM;IAClB,gBAAgB,MAAM;IACtB,SAAS,MAAM;IACf,SAAS,MAAM;IACf,qBAAqB,MAAM;CAC5B;AAED,eAAO,MAAM,QAAQ,EAAE;KACpB,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,WAAW;CAiRnC,CAAC;AAEF,eAAO,MAAM,WAAW;;;;;;;;;;CAUvB,CAAC;AAEF,eAAO,MAAM,IAAI;;;;;CAKhB,CAAC;AAEF,eAAO,MAAM,4BAA4B,uBAAuB,CAAC;AAEjE,eAAO,MAAM,4BAA4B,KAAK,CAAC"}

package/dist/constants.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SUBGRAPH_API_KEY_PLACEHOLDER = exports.Role = exports.KVStoreKeys = exports.NETWORKS = exports.HttpStatus = exports.DEFAULT_TX_ID = exports.DEFAULT_USE_SSL = exports.DEFAULT_PORT = exports.DEFAULT_REGION = exports.DEFAULT_ENDPOINT = exports.DEFAULT_PUBLIC_BUCKET = void 0;
+exports.ESCROW_BULK_PAYOUT_MAX_ITEMS = exports.SUBGRAPH_API_KEY_PLACEHOLDER = exports.Role = exports.KVStoreKeys = exports.NETWORKS = exports.HttpStatus = exports.DEFAULT_USE_SSL = exports.DEFAULT_PORT = exports.DEFAULT_REGION = exports.DEFAULT_ENDPOINT = exports.DEFAULT_PUBLIC_BUCKET = void 0;
 const enums_1 = require("./enums");
 exports.DEFAULT_PUBLIC_BUCKET = 'escrow-public-results';
 exports.DEFAULT_ENDPOINT = 'localhost';
 exports.DEFAULT_REGION = 'eu';
 exports.DEFAULT_PORT = 9000;
 exports.DEFAULT_USE_SSL = false;
-exports.DEFAULT_TX_ID = 1;
 var HttpStatus;
 (function (HttpStatus) {
     HttpStatus[HttpStatus["OK"] = 200] = "OK";
@@ -273,3 +272,4 @@ exports.Role = {
     RecordingOracle: 'Recording Oracle',
 };
 exports.SUBGRAPH_API_KEY_PLACEHOLDER = '[SUBGRAPH_API_KEY]';
+exports.ESCROW_BULK_PAYOUT_MAX_ITEMS = 99;

package/dist/decorators.js

@@ -7,7 +7,7 @@ function requiresSigner(target, propertyKey, descriptor) {
     const originalMethod = descriptor.value;
     descriptor.value = async function (...args) {
         try {
-            !this.runner.getAddress();
+            this.runner.getAddress();
         }
         catch {
             throw error_1.ErrorSigner;

package/dist/encryption.d.ts

@@ -1,5 +1,9 @@
 import * as openpgp from 'openpgp';
 import { IKeyPair } from './interfaces';
+/**
+ * Type representing the data type of a message.
+ * It can be either a string or a Uint8Array.
+ */
 type MessageDataType = string | Uint8Array;
 /**
  * ## Introduction
@@ -38,7 +42,7 @@ type MessageDataType = string | Uint8Array;
  *
  * const privateKey = 'Armored_priv_key';
  * const passphrase = 'example_passphrase';
- * const encription = await Encryption.build(privateKey, passphrase);
+ * const encryption = await Encryption.build(privateKey, passphrase);
  * ```
  */
 export declare class Encryption {
@@ -60,7 +64,7 @@ export declare class Encryption {
     /**
      * This function signs and encrypts a message using the private key used to initialize the client and the specified public keys.
      *
-     * @param {string} message Message to sign and encrypt.
+     * @param {MessageDataType} message Message to sign and encrypt.
      * @param {string[]} publicKeys Array of public keys to use for encryption.
      * @returns {Promise<string>} Message signed and encrypted.
      *
@@ -72,7 +76,7 @@ export declare class Encryption {
      *
      * const privateKey = 'Armored_priv_key';
      * const passphrase = 'example_passphrase';
-     * const encription = await Encryption.build(privateKey, passphrase);
+     * const encryption = await Encryption.build(privateKey, passphrase);
      * const publicKey1 = `-----BEGIN PGP PUBLIC KEY BLOCK-----
      * xjMEZKQEMxYJKwYBBAHaRw8BAQdA5oZTq4UPlS0IXn4kEaSqQdAa9+Cq522v
      * WYxJQn3vo1/NFEh1bWFuIDxodW1hbkBobXQuYWk+wowEEBYKAD4FAmSkBDME
@@ -98,7 +102,7 @@ export declare class Encryption {
      * -----END PGP PUBLIC KEY BLOCK-----`;
      *
      * const publicKeys = [publicKey1, publicKey2];
-     * const resultMessage = await encription.signAndEncrypt('message', publicKeys);
+     * const resultMessage = await encryption.signAndEncrypt('message', publicKeys);
      * ```
      */
     signAndEncrypt(message: MessageDataType, publicKeys: string[]): Promise<string>;
@@ -107,7 +111,7 @@ export declare class Encryption {
      *
      * @param {string} message Message to decrypt.
      * @param {string} publicKey Public key used to verify signature if needed. This is optional.
-     * @returns {Promise<string>} Message decrypted.
+     * @returns {Promise<Uint8Array>} Message decrypted.
      *
      * **Code example**
      *
@@ -116,7 +120,7 @@ export declare class Encryption {
      *
      * const privateKey = 'Armored_priv_key';
      * const passphrase = 'example_passphrase';
-     * const encription = await Encryption.build(privateKey, passphrase);
+     * const encryption = await Encryption.build(privateKey, passphrase);
      *
      * const publicKey = `-----BEGIN PGP PUBLIC KEY BLOCK-----
      * xjMEZKQEMxYJKwYBBAHaRw8BAQdA5oZTq4UPlS0IXn4kEaSqQdAa9+Cq522v
@@ -130,7 +134,7 @@ export declare class Encryption {
      * UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
      * -----END PGP PUBLIC KEY BLOCK-----`;
      *
-     * const resultMessage = await encription.decrypt('message');
+     * const resultMessage = await encryption.decrypt('message');
      * ```
      */
     decrypt(message: string, publicKey?: string): Promise<Uint8Array>;
@@ -147,9 +151,9 @@ export declare class Encryption {
      *
      * const privateKey = 'Armored_priv_key';
      * const passphrase = 'example_passphrase';
-     * const encription = await Encryption.build(privateKey, passphrase);
+     * const encryption = await Encryption.build(privateKey, passphrase);
      *
-     * const resultMessage = await encription.sign('message');
+     * const resultMessage = await encryption.sign('message');
      * ```
      */
     sign(message: string): Promise<string>;
@@ -184,7 +188,7 @@ export declare class EncryptionUtils {
      * This function verifies the signature of a signed message using the public key.
      *
      * @param {string} message Message to verify.
-     * @param {string} publicKey Public key to verify that the message was sign by a specific source.
+     * @param {string} publicKey Public key to verify that the message was signed by a specific source.
      * @returns {Promise<boolean>} True if verified. False if not verified.
      *
      * **Code example**
@@ -204,7 +208,7 @@ export declare class EncryptionUtils {
      * UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
      * -----END PGP PUBLIC KEY BLOCK-----`;
      *
-     * const result = await EncriptionUtils.verify('message', publicKey);
+     * const result = await EncryptionUtils.verify('message', publicKey);
      * ```
      */
     static verify(message: string, publicKey: string): Promise<boolean>;
@@ -219,7 +223,7 @@ export declare class EncryptionUtils {
      * ```ts
      * import { EncryptionUtils } from '@human-protocol/sdk';
      *
-     * const signedData = await EncriptionUtils.getSignedData('message');
+     * const signedData = await EncryptionUtils.getSignedData('message');
      * ```
      */
     static getSignedData(message: string): Promise<string>;
@@ -236,30 +240,18 @@ export declare class EncryptionUtils {
      * ```ts
      * import { EncryptionUtils } from '@human-protocol/sdk';
      *
-     * const publicKey = `-----BEGIN PGP PUBLIC KEY BLOCK-----
-     * xjMEZKQEMxYJKwYBBAHaRw8BAQdA5oZTq4UPlS0IXn4kEaSqQdAa9+Cq522v
-     * WYxJQn3vo1/NFEh1bWFuIDxodW1hbkBobXQuYWk+wowEEBYKAD4FAmSkBDME
-     * CwkHCAkQJBFPuuhtQo4DFQgKBBYAAgECGQECGwMCHgEWIQTQ5fbVPB9CWIdf
-     * XdYkEU+66G1CjgAAKYYA/jMyDCtJtqu6hj22kq9SW6fuV1FCT2ySJ9vBhumF
-     * X8wWAP433zVFl4VECOkgGk8qFr8BgkYxaz16GOFAqYbfO6oMBc44BGSkBDMS
-     * CisGAQQBl1UBBQEBB0AKR+A48zVVYZWQvgu7Opn2IGvzI9jePB/J8pzqRhg2
-     * YAMBCAfCeAQYFggAKgUCZKQEMwkQJBFPuuhtQo4CGwwWIQTQ5fbVPB9CWIdf
-     * XdYkEU+66G1CjgAA0xgBAK4AIahFFnmWR2Mp6A3q021cZXpGklc0Xw1Hfswc
-     * UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
-     * -----END PGP PUBLIC KEY BLOCK-----`;
-     *
      * const name = 'YOUR_NAME';
      * const email = 'YOUR_EMAIL';
      * const passphrase = 'YOUR_PASSPHRASE';
-     * const result = await EncriptionUtils.generateKeyPair(name, email, passphrase);
+     * const result = await EncryptionUtils.generateKeyPair(name, email, passphrase);
      * ```
      */
     static generateKeyPair(name: string, email: string, passphrase?: string): Promise<IKeyPair>;
     /**
      * This function encrypts a message using the specified public keys.
      *
-     * @param {string} message Message to encrypt.
-     * @param {string} publicKeys Array of public keys to use for encryption.
+     * @param {MessageDataType} message Message to encrypt.
+     * @param {string[]} publicKeys Array of public keys to use for encryption.
      * @returns {Promise<string>} Message encrypted.
      *
      * **Code example**
@@ -292,7 +284,7 @@ export declare class EncryptionUtils {
      * -----END PGP PUBLIC KEY BLOCK-----`;
      *
      * const publicKeys = [publicKey1, publicKey2]
-     * const result = await EncriptionUtils.encrypt('message', publicKeys);
+     * const result = await EncryptionUtils.encrypt('message', publicKeys);
      * ```
      */
     static encrypt(message: MessageDataType, publicKeys: string[]): Promise<string>;
@@ -317,7 +309,7 @@ export declare class EncryptionUtils {
      * =tsmI
      * -----END PGP MESSAGE-----`;
      *
-     * const isEncrypted = await EncriptionUtils.isEncrypted(message);
+     * const isEncrypted = await EncryptionUtils.isEncrypted(message);
      *
      * if (isEncrypted) {
      *   console.log('The message is encrypted with OpenPGP.');

package/dist/encryption.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../src/encryption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,KAAK,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAU3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,UAAU,CAAqB;IAEvC;;;;OAIG;gBACS,UAAU,EAAE,OAAO,CAAC,UAAU;IAI1C;;;;;;OAMG;WACiB,KAAK,CACvB,iBAAiB,EAAE,MAAM,EACzB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,CAAC;IAkBtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACU,cAAc,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAkBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,OAAO,CAClB,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,UAAU,CAAC;IAoCtB;;;;;;;;;;;;;;;;;OAiBG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,eAAe;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;OAaG;WACiB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,eAAe,CACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,SAAK,GACd,OAAO,CAAC,QAAQ,CAAC;IAkBpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;WACiB,OAAO,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CASpD"}
+{"version":3,"file":"encryption.d.ts","sourceRoot":"","sources":["../src/encryption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC;;;GAGG;AACH,KAAK,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAU3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,UAAU,CAAqB;IAEvC;;;;OAIG;gBACS,UAAU,EAAE,OAAO,CAAC,UAAU;IAI1C;;;;;;OAMG;WACiB,KAAK,CACvB,iBAAiB,EAAE,MAAM,EACzB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,CAAC;IAkBtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACU,cAAc,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAkBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,OAAO,CAClB,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,UAAU,CAAC;IAoCtB;;;;;;;;;;;;;;;;;OAiBG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,eAAe;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;OAaG;WACiB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYnE;;;;;;;;;;;;;;;;;;OAkBG;WACiB,eAAe,CACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,SAAK,GACd,OAAO,CAAC,QAAQ,CAAC;IAkBpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;WACiB,OAAO,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CASpD"}

package/dist/encryption.js

@@ -78,7 +78,7 @@ function makeMessageDataBinary(message) {
  *
  * const privateKey = 'Armored_priv_key';
  * const passphrase = 'example_passphrase';
- * const encription = await Encryption.build(privateKey, passphrase);
+ * const encryption = await Encryption.build(privateKey, passphrase);
  * ```
  */
 class Encryption {
@@ -113,7 +113,7 @@ class Encryption {
     /**
      * This function signs and encrypts a message using the private key used to initialize the client and the specified public keys.
      *
-     * @param {string} message Message to sign and encrypt.
+     * @param {MessageDataType} message Message to sign and encrypt.
      * @param {string[]} publicKeys Array of public keys to use for encryption.
      * @returns {Promise<string>} Message signed and encrypted.
      *
@@ -125,7 +125,7 @@ class Encryption {
      *
      * const privateKey = 'Armored_priv_key';
      * const passphrase = 'example_passphrase';
-     * const encription = await Encryption.build(privateKey, passphrase);
+     * const encryption = await Encryption.build(privateKey, passphrase);
      * const publicKey1 = `-----BEGIN PGP PUBLIC KEY BLOCK-----
      * xjMEZKQEMxYJKwYBBAHaRw8BAQdA5oZTq4UPlS0IXn4kEaSqQdAa9+Cq522v
      * WYxJQn3vo1/NFEh1bWFuIDxodW1hbkBobXQuYWk+wowEEBYKAD4FAmSkBDME
@@ -151,7 +151,7 @@ class Encryption {
      * -----END PGP PUBLIC KEY BLOCK-----`;
      *
      * const publicKeys = [publicKey1, publicKey2];
-     * const resultMessage = await encription.signAndEncrypt('message', publicKeys);
+     * const resultMessage = await encryption.signAndEncrypt('message', publicKeys);
      * ```
      */
     async signAndEncrypt(message, publicKeys) {
@@ -172,7 +172,7 @@ class Encryption {
      *
      * @param {string} message Message to decrypt.
      * @param {string} publicKey Public key used to verify signature if needed. This is optional.
-     * @returns {Promise<string>} Message decrypted.
+     * @returns {Promise<Uint8Array>} Message decrypted.
      *
      * **Code example**
      *
@@ -181,7 +181,7 @@ class Encryption {
      *
      * const privateKey = 'Armored_priv_key';
      * const passphrase = 'example_passphrase';
-     * const encription = await Encryption.build(privateKey, passphrase);
+     * const encryption = await Encryption.build(privateKey, passphrase);
      *
      * const publicKey = `-----BEGIN PGP PUBLIC KEY BLOCK-----
      * xjMEZKQEMxYJKwYBBAHaRw8BAQdA5oZTq4UPlS0IXn4kEaSqQdAa9+Cq522v
@@ -195,7 +195,7 @@ class Encryption {
      * UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
      * -----END PGP PUBLIC KEY BLOCK-----`;
      *
-     * const resultMessage = await encription.decrypt('message');
+     * const resultMessage = await encryption.decrypt('message');
      * ```
      */
     async decrypt(message, publicKey) {
@@ -241,9 +241,9 @@ class Encryption {
      *
      * const privateKey = 'Armored_priv_key';
      * const passphrase = 'example_passphrase';
-     * const encription = await Encryption.build(privateKey, passphrase);
+     * const encryption = await Encryption.build(privateKey, passphrase);
      *
-     * const resultMessage = await encription.sign('message');
+     * const resultMessage = await encryption.sign('message');
      * ```
      */
     async sign(message) {
@@ -289,7 +289,7 @@ class EncryptionUtils {
      * This function verifies the signature of a signed message using the public key.
      *
      * @param {string} message Message to verify.
-     * @param {string} publicKey Public key to verify that the message was sign by a specific source.
+     * @param {string} publicKey Public key to verify that the message was signed by a specific source.
      * @returns {Promise<boolean>} True if verified. False if not verified.
      *
      * **Code example**
@@ -309,7 +309,7 @@ class EncryptionUtils {
      * UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
      * -----END PGP PUBLIC KEY BLOCK-----`;
      *
-     * const result = await EncriptionUtils.verify('message', publicKey);
+     * const result = await EncryptionUtils.verify('message', publicKey);
      * ```
      */
     static async verify(message, publicKey) {
@@ -337,7 +337,7 @@ class EncryptionUtils {
      * ```ts
      * import { EncryptionUtils } from '@human-protocol/sdk';
      *
-     * const signedData = await EncriptionUtils.getSignedData('message');
+     * const signedData = await EncryptionUtils.getSignedData('message');
      * ```
      */
     static async getSignedData(message) {
@@ -364,22 +364,10 @@ class EncryptionUtils {
      * ```ts
      * import { EncryptionUtils } from '@human-protocol/sdk';
      *
-     * const publicKey = `-----BEGIN PGP PUBLIC KEY BLOCK-----
-     * xjMEZKQEMxYJKwYBBAHaRw8BAQdA5oZTq4UPlS0IXn4kEaSqQdAa9+Cq522v
-     * WYxJQn3vo1/NFEh1bWFuIDxodW1hbkBobXQuYWk+wowEEBYKAD4FAmSkBDME
-     * CwkHCAkQJBFPuuhtQo4DFQgKBBYAAgECGQECGwMCHgEWIQTQ5fbVPB9CWIdf
-     * XdYkEU+66G1CjgAAKYYA/jMyDCtJtqu6hj22kq9SW6fuV1FCT2ySJ9vBhumF
-     * X8wWAP433zVFl4VECOkgGk8qFr8BgkYxaz16GOFAqYbfO6oMBc44BGSkBDMS
-     * CisGAQQBl1UBBQEBB0AKR+A48zVVYZWQvgu7Opn2IGvzI9jePB/J8pzqRhg2
-     * YAMBCAfCeAQYFggAKgUCZKQEMwkQJBFPuuhtQo4CGwwWIQTQ5fbVPB9CWIdf
-     * XdYkEU+66G1CjgAA0xgBAK4AIahFFnmWR2Mp6A3q021cZXpGklc0Xw1Hfswc
-     * UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
-     * -----END PGP PUBLIC KEY BLOCK-----`;
-     *
      * const name = 'YOUR_NAME';
      * const email = 'YOUR_EMAIL';
      * const passphrase = 'YOUR_PASSPHRASE';
-     * const result = await EncriptionUtils.generateKeyPair(name, email, passphrase);
+     * const result = await EncryptionUtils.generateKeyPair(name, email, passphrase);
      * ```
      */
     static async generateKeyPair(name, email, passphrase = '') {
@@ -400,8 +388,8 @@ class EncryptionUtils {
     /**
      * This function encrypts a message using the specified public keys.
      *
-     * @param {string} message Message to encrypt.
-     * @param {string} publicKeys Array of public keys to use for encryption.
+     * @param {MessageDataType} message Message to encrypt.
+     * @param {string[]} publicKeys Array of public keys to use for encryption.
      * @returns {Promise<string>} Message encrypted.
      *
      * **Code example**
@@ -434,7 +422,7 @@ class EncryptionUtils {
      * -----END PGP PUBLIC KEY BLOCK-----`;
      *
      * const publicKeys = [publicKey1, publicKey2]
-     * const result = await EncriptionUtils.encrypt('message', publicKeys);
+     * const result = await EncryptionUtils.encrypt('message', publicKeys);
      * ```
      */
     static async encrypt(message, publicKeys) {
@@ -470,7 +458,7 @@ class EncryptionUtils {
      * =tsmI
      * -----END PGP MESSAGE-----`;
      *
-     * const isEncrypted = await EncriptionUtils.isEncrypted(message);
+     * const isEncrypted = await EncryptionUtils.isEncrypted(message);
      *
      * if (isEncrypted) {
      *   console.log('The message is encrypted with OpenPGP.');

package/dist/error.d.ts

@@ -3,15 +3,15 @@
  */
 export declare const ErrorStakingMissing: Error;
 /**
- * @constant {Error} - The Storage client not initialised.
+ * @constant {Error} - The Storage client not initialized.
  */
 export declare const ErrorStorageClientNotInitialized: Error;
 /**
- * @constant {Error} - The Storage does not exists.
+ * @constant {Error} - The Storage client does not exist.
  */
 export declare const ErrorStorageClientNotExists: Error;
 /**
- * @constant {Error} - The Storage credentials is missing.
+ * @constant {Error} - The Storage credentials are missing.
  */
 export declare const ErrorStorageCredentialsMissing: Error;
 /**
@@ -27,7 +27,7 @@ export declare const ErrorStorageFileNotFound: Error;
  */
 export declare const ErrorStorageFileNotUploaded: Error;
 /**
- * @constant {Error} - The KVStore key can not be empty.
+ * @constant {Error} - The KVStore key cannot be empty.
  */
 export declare const ErrorKVStoreEmptyKey: Error;
 /**
@@ -35,11 +35,11 @@ export declare const ErrorKVStoreEmptyKey: Error;
  */
 export declare const ErrorKVStoreArrayLength: Error;
 /**
- * @constant {Error} - The Address sent is invalid.
+ * @constant {Error} - The address provided is invalid.
  */
 export declare const ErrorInvalidAddress: Error;
 /**
- * @constant {Error} - The token address sent is invalid.
+ * @constant {Error} - The token address provided is invalid.
  */
 export declare const ErrorInvalidTokenAddress: Error;
 /**
@@ -51,11 +51,11 @@ export declare const ErrorInvalidRecordingOracleAddressProvided: Error;
  */
 export declare const ErrorInvalidReputationOracleAddressProvided: Error;
 /**
- * @constant {Error} - Invalid reputation oracle address provided.
+ * @constant {Error} - Invalid exchange oracle address provided.
  */
 export declare const ErrorInvalidExchangeOracleAddressProvided: Error;
 /**
- * @constant {Error} - The Staking value must be positive.
+ * @constant {Error} - The staking value must be positive.
  */
 export declare const ErrorStakingValueMustBePositive: Error;
 /**
@@ -77,7 +77,7 @@ export declare const ErrorInvalidStakerAddressProvided: Error;
 /**
  * @constant {Error} - Invalid hash provided.
  */
-export declare const ErrorInvalidHahsProvided: Error;
+export declare const ErrorInvalidHashProvided: Error;
 /**
  * @constant {Error} - Cannot use both date and block filters simultaneously.
  */
@@ -94,17 +94,20 @@ export declare const ErrorStakingGetStakers: Error;
  * @constant {Error} - Failed to approve staking amount: signerOrProvider is not a Signer instance.
  */
 export declare const ErrorFailedToApproveStakingAmountSignerDoesNotExist: Error;
+/**
+ * @constant {Error} - Failed to check allowance.
+ */
 export declare const ErrorFailedToCheckAllowance: Error;
 /**
  * @constant {Error} - The HMToken amount not approved.
  */
 export declare const ErrorHMTokenAmountNotApproved: Error;
 /**
- * @constant {Error} - Init provider does not exists.
+ * @constant {Error} - Provider does not exist.
  */
 export declare const ErrorProviderDoesNotExist: Error;
 /**
- * @constant {Error} - Init with unsupported chain ID.
+ * @constant {Error} - Unsupported chain ID.
  */
 export declare const ErrorUnsupportedChainID: Error;
 /**
@@ -123,10 +126,6 @@ export declare const ErrorTransferEventNotFoundInTransactionLogs: Error;
  * @constant {Error} - Manifest file does not exist.
  */
 export declare const ErrorManifestFileDoesNotExist: Error;
-/**
- * @constant {Error} - Storage client does not exist.
- */
-export declare const ErrorStorageClientDoesNotExist: Error;
 /**
  * @constant {Error} - Invalid URL string.
  */
@@ -156,7 +155,11 @@ export declare const ErrorTotalFeeMustBeLessThanHundred: Error;
  */
 export declare const ErrorRecipientCannotBeEmptyArray: Error;
 /**
- * @constant {Error} - Amount must be greater than zero..
+ * @constant {Error} - Too many recipients.
+ */
+export declare const ErrorTooManyRecipients: Error;
+/**
+ * @constant {Error} - Amount must be greater than zero.
  */
 export declare const ErrorAmountMustBeGreaterThanZero: Error;
 /**
@@ -179,6 +182,18 @@ export declare const ErrorLaunchedEventIsNotEmitted: Error;
  * @constant {Error} - Hash is an empty string.
  */
 export declare const ErrorHashIsEmptyString: Error;
+/**
+ * @constant {Error} - The hash does not match.
+ */
+export declare const ErrorInvalidHash: Error;
+/**
+ * @constant {Error} - The status is not supported.
+ */
+export declare const ErrorUnsupportedStatus: Error;
+/**
+ * @constant {Warning} - The SUBGRAPH_API_KEY is not being provided.
+ */
+export declare const WarnSubgraphApiKeyNotProvided = "\"SUBGRAPH_API_KEY\" is not being provided. It might cause issues with the subgraph.";
 export declare class EthereumError extends Error {
     constructor(message: string);
 }
@@ -203,18 +218,6 @@ export declare class ContractExecutionError extends EthereumError {
 export declare class InvalidEthereumAddressError extends Error {
     constructor(address: string);
 }
-/**
- * @constant {Error} - The Hash does not match
- */
-export declare const ErrorInvalidHash: Error;
-/**
- * @constant {Error} - The Status is not supported
- */
-export declare const ErrorUnsupportedStatus: Error;
-/**
- * @constant {Error} - The SUBGRAPH_API_KEY is not being provided
- */
-export declare const WarnSubgraphApiKeyNotProvided = "\"SUBGRAPH_API_KEY\" is not being provided. It might cause issues with the subgraph.";
 export declare class InvalidKeyError extends Error {
     constructor(key: string, address: string);
 }

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA2C,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0BAA0B,OAAgC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAA8B,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAAiC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAoC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAEnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA+B,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,0CAA0C,OAEtD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yCAAyC,OAErD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,+BAA+B,OAE3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA0C,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,mDAAmD,OAE/D,CAAC;AAEF,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAAmC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,yBAAyB,OAAuC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAAoC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,WAAW,OAA+B,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAEzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,OAAkC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,qBAAqB,OAAsC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAA+B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAAuC,CAAC;AAE3E,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,oBAAqB,SAAQ,aAAa;gBACzC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,MAAM,EAAE,MAAM;CAG3B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAG5B;AACD;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAA4B,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA4C,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,6BAA6B,yFAC4C,CAAC;AAEvF,qBAAa,eAAgB,SAAQ,KAAK;gBAC5B,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAGzC"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA2C,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0BAA0B,OAAgC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAA8B,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAAiC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAmC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAEnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA+B,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,0CAA0C,OAEtD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yCAAyC,OAErD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,+BAA+B,OAE3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA0C,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,mDAAmD,OAE/D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAAmC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,yBAAyB,OAAuC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAAoC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,WAAW,OAA+B,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAEzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,OAAkC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,qBAAqB,OAAsC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAA+B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAAmC,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAAuC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAA4B,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA4C,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,6BAA6B,yFAC4C,CAAC;AAEvF,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,oBAAqB,SAAQ,aAAa;gBACzC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,MAAM,EAAE,MAAM;CAG3B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,eAAgB,SAAQ,KAAK;gBAC5B,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAGzC"}