@human-protocol/sdk 3.0.7 → 4.0.0

package/src/decorators.ts

@@ -10,7 +10,7 @@ export function requiresSigner(
 
   descriptor.value = async function (this: any, ...args: any[]) {
     try {
-      !this.runner.getAddress();
+      this.runner.getAddress();
     } catch {
       throw ErrorSigner;
     }

package/src/encryption.ts

@@ -1,6 +1,10 @@
 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;
 
 function makeMessageDataBinary(message: MessageDataType): Uint8Array {
@@ -48,7 +52,7 @@ function makeMessageDataBinary(message: MessageDataType): 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 class Encryption {
@@ -94,7 +98,7 @@ export 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.
    *
@@ -106,7 +110,7 @@ export 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
@@ -132,7 +136,7 @@ export 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);
    * ```
    */
   public async signAndEncrypt(
@@ -161,7 +165,7 @@ export 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**
    *
@@ -170,7 +174,7 @@ export 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
@@ -184,7 +188,7 @@ export class Encryption {
    * UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
    * -----END PGP PUBLIC KEY BLOCK-----`;
    *
-   * const resultMessage = await encription.decrypt('message');
+   * const resultMessage = await encryption.decrypt('message');
    * ```
    */
   public async decrypt(
@@ -239,9 +243,9 @@ export 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');
    * ```
    */
   public async sign(message: string): Promise<string> {
@@ -288,7 +292,7 @@ export 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**
@@ -308,7 +312,7 @@ export class EncryptionUtils {
    * UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
    * -----END PGP PUBLIC KEY BLOCK-----`;
    *
-   * const result = await EncriptionUtils.verify('message', publicKey);
+   * const result = await EncryptionUtils.verify('message', publicKey);
    * ```
    */
   public static async verify(
@@ -341,7 +345,7 @@ export class EncryptionUtils {
    * ```ts
    * import { EncryptionUtils } from '@human-protocol/sdk';
    *
-   * const signedData = await EncriptionUtils.getSignedData('message');
+   * const signedData = await EncryptionUtils.getSignedData('message');
    * ```
    */
   public static async getSignedData(message: string): Promise<string> {
@@ -369,22 +373,10 @@ export 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);
    * ```
    */
   public static async generateKeyPair(
@@ -412,8 +404,8 @@ export class EncryptionUtils {
   /**
    * This function encrypts a message using the specified public keys.
    *
-   * @param {string} message Message to encrypt.
-   * @param {string} publicKey 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**
@@ -446,7 +438,7 @@ export 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);
    * ```
    */
   public static async encrypt(
@@ -490,7 +482,7 @@ export 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/src/error.ts

@@ -4,24 +4,24 @@
 export const ErrorStakingMissing = new Error('Staking contract is missing');
 
 /**
- * @constant {Error} - The Storage client not initialised.
+ * @constant {Error} - The Storage client not initialized.
  */
 export const ErrorStorageClientNotInitialized = new Error(
   'Storage client not initialized'
 );
 
 /**
- * @constant {Error} - The Storage does not exists.
+ * @constant {Error} - The Storage client does not exist.
  */
 export const ErrorStorageClientNotExists = new Error(
-  'Storage client does not exists'
+  'Storage client does not exist'
 );
 
 /**
- * @constant {Error} - The Storage credentials is missing.
+ * @constant {Error} - The Storage credentials are missing.
  */
 export const ErrorStorageCredentialsMissing = new Error(
-  'Storage credentials is missing'
+  'Storage credentials are missing'
 );
 
 /**
@@ -40,9 +40,9 @@ export const ErrorStorageFileNotFound = new Error('File not found');
 export const ErrorStorageFileNotUploaded = new Error('File not uploaded');
 
 /**
- * @constant {Error} - The KVStore key can not be empty.
+ * @constant {Error} - The KVStore key cannot be empty.
  */
-export const ErrorKVStoreEmptyKey = new Error('Key can not be empty');
+export const ErrorKVStoreEmptyKey = new Error('Key cannot be empty');
 
 /**
  * @constant {Error} - The KVStore arrays must have the same length.
@@ -52,12 +52,12 @@ export const ErrorKVStoreArrayLength = new Error(
 );
 
 /**
- * @constant {Error} - The Address sent is invalid.
+ * @constant {Error} - The address provided is invalid.
  */
 export const ErrorInvalidAddress = new Error('Invalid address');
 
 /**
- * @constant {Error} - The token address sent is invalid.
+ * @constant {Error} - The token address provided is invalid.
  */
 export const ErrorInvalidTokenAddress = new Error('Invalid token address');
 
@@ -76,14 +76,14 @@ export const ErrorInvalidReputationOracleAddressProvided = new Error(
 );
 
 /**
- * @constant {Error} - Invalid reputation oracle address provided.
+ * @constant {Error} - Invalid exchange oracle address provided.
  */
 export const ErrorInvalidExchangeOracleAddressProvided = new Error(
   'Invalid exchange oracle address provided'
 );
 
 /**
- * @constant {Error} - The Staking value must be positive.
+ * @constant {Error} - The staking value must be positive.
  */
 export const ErrorStakingValueMustBePositive = new Error(
   'Value must be positive'
@@ -120,7 +120,7 @@ export const ErrorInvalidStakerAddressProvided = new Error(
 /**
  * @constant {Error} - Invalid hash provided.
  */
-export const ErrorInvalidHahsProvided = new Error('Invalid hash provided');
+export const ErrorInvalidHashProvided = new Error('Invalid hash provided');
 
 /**
  * @constant {Error} - Cannot use both date and block filters simultaneously.
@@ -148,6 +148,9 @@ export const ErrorFailedToApproveStakingAmountSignerDoesNotExist = new Error(
   'Failed to approve staking amount: signerOrProvider is not a Signer instance'
 );
 
+/**
+ * @constant {Error} - Failed to check allowance.
+ */
 export const ErrorFailedToCheckAllowance = new Error(
   'Failed to check allowance'
 );
@@ -158,12 +161,12 @@ export const ErrorFailedToCheckAllowance = new Error(
 export const ErrorHMTokenAmountNotApproved = new Error('Amount not approved');
 
 /**
- * @constant {Error} - Init provider does not exists.
+ * @constant {Error} - Provider does not exist.
  */
 export const ErrorProviderDoesNotExist = new Error('Provider does not exist');
 
 /**
- * @constant {Error} - Init with unsupported chain ID.
+ * @constant {Error} - Unsupported chain ID.
  */
 export const ErrorUnsupportedChainID = new Error('Unsupported chain ID');
 
@@ -193,13 +196,6 @@ export const ErrorManifestFileDoesNotExist = new Error(
   'Manifest file does not exist'
 );
 
-/**
- * @constant {Error} - Storage client does not exist.
- */
-export const ErrorStorageClientDoesNotExist = new Error(
-  'Storage client does not exist'
-);
-
 /**
  * @constant {Error} - Invalid URL string.
  */
@@ -244,7 +240,12 @@ export const ErrorRecipientCannotBeEmptyArray = new Error(
 );
 
 /**
- * @constant {Error} - Amount must be greater than zero..
+ * @constant {Error} - Too many recipients.
+ */
+export const ErrorTooManyRecipients = new Error('Too many recipients');
+
+/**
+ * @constant {Error} - Amount must be greater than zero.
  */
 export const ErrorAmountMustBeGreaterThanZero = new Error(
   'Amount must be greater than zero'
@@ -283,6 +284,22 @@ export const ErrorLaunchedEventIsNotEmitted = new Error(
  */
 export const ErrorHashIsEmptyString = new Error('Hash is an empty string');
 
+/**
+ * @constant {Error} - The hash does not match.
+ */
+export const ErrorInvalidHash = new Error('Invalid hash');
+
+/**
+ * @constant {Error} - The status is not supported.
+ */
+export const ErrorUnsupportedStatus = new Error('Unsupported status for query');
+
+/**
+ * @constant {Warning} - The SUBGRAPH_API_KEY is not being provided.
+ */
+export const WarnSubgraphApiKeyNotProvided =
+  '"SUBGRAPH_API_KEY" is not being provided. It might cause issues with the subgraph.';
+
 export class EthereumError extends Error {
   constructor(message: string) {
     super(`An error occurred while interacting with Ethereum: ${message}`);
@@ -330,21 +347,6 @@ export class InvalidEthereumAddressError extends Error {
     super(`Invalid ethereum address error: ${address}`);
   }
 }
-/**
- * @constant {Error} - The Hash does not match
- */
-export const ErrorInvalidHash = new Error('Invalid hash');
-
-/**
- * @constant {Error} - The Status is not supported
- */
-export const ErrorUnsupportedStatus = new Error('Unsupported status for query');
-
-/**
- * @constant {Error} - The SUBGRAPH_API_KEY is not being provided
- */
-export const WarnSubgraphApiKeyNotProvided =
-  '"SUBGRAPH_API_KEY" is not being provided. It might cause issues with the subgraph.';
 
 export class InvalidKeyError extends Error {
   constructor(key: string, address: string) {