@human-protocol/sdk 1.1.14 → 1.1.16

package/dist/encryption.d.ts

@@ -1,7 +1,45 @@
 import * as openpgp from 'openpgp';
 import { IKeyPair } from './interfaces';
 /**
- * Class for encryption and decryption operations.
+ * ## Introduction
+ *
+ * Class for sign and decrypt messages.
+ *
+ * The algorithm includes the implementation of the [PGP encryption algorithm](https://github.com/openpgpjs/openpgpjs) multi-public key encryption on typescript.
+ * Using the vanilla [ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) implementation Schnorr signatures for signature and [curve25519](https://en.wikipedia.org/wiki/Curve25519) for encryption. [Learn more](https://wiki.polkadot.network/docs/learn-cryptography).
+ *
+ * To get an instance of this class, is recommended to initialize it using the static `build` method.
+ *
+ * ```ts
+ * static async build(privateKeyArmored: string, passphrase?: string): Promise<Encryption>
+ * ```
+ *
+ * ## Installation
+ *
+ * ### npm
+ * ```bash
+ * npm install @human-protocol/sdk
+ * ```
+ *
+ * ### yarn
+ * ```bash
+ * yarn install @human-protocol/sdk
+ * ```
+ *
+ * ## Input parameters
+ *
+ * - `privateKeyArmored` - The encrypted private key in armored format.
+ * - `passphrase` - The passphrase for the private key.
+ *
+ * ## Code example
+ *
+ * ```ts
+ * import { Encryption } from '@human-protocol/sdk';
+ *
+ * const privateKey = 'Armored_priv_key';
+ * const passphrase = 'example_passphrase';
+ * const encription = await Encryption.build(privateKey, passphrase);
+ * ```
  */
 export declare class Encryption {
     private privateKey;
@@ -20,64 +58,242 @@ export declare class Encryption {
      */
     static build(privateKeyArmored: string, passphrase?: string): Promise<Encryption>;
     /**
-     * Signs and encrypts a message using the specified public keys.
+     * This function signs and encrypts a message using the private key used to initialize the client and 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.
+     * @param {string} message Message to sign and encrypt.
+     * @param {string[]} publicKeys Array of public keys to use for encryption.
+     * @returns {Promise<string>} Message signed and encrypted.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { Encryption } from '@human-protocol/sdk';
+     * import { EscrowClient } from '@human-protocol/sdk';
+     *
+     * const privateKey = 'Armored_priv_key';
+     * const passphrase = 'example_passphrase';
+     * const encription = await Encryption.build(privateKey, passphrase);
+     * const publicKey1 = `-----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 publicKey2 = `-----BEGIN PGP PUBLIC KEY BLOCK-----
+     * xjMEZKQEMxYJKwYBBAHaRw8BAQdAG6h+E+6T/RV2tIHer3FP/jKThAyGcoVx
+     * FzhnP0hncPzNFEh1bWFuIDxodW1hbkBobXQuYWk+wowEEBYKAD4FAmSkBDME
+     * CwkHCAkQPIq5xLhlTYkDFQgKBBYAAgECGQECGwMCHgEWIQTcxtMgul/AeUvH
+     * bio8irnEuGVNiQAA/HsBANpfFkxNYixpsBk8LlaaCaPy5f1/cWNPgODM9uzo
+     * ciSTAQDtAYynu4dSJO9GbMuDuc0FaUHRWJK3mS6JkvedYL4oBM44BGSkBDMS
+     * CisGAQQBl1UBBQEBB0DWbEG7DMhkeSc8ZPzrH8XNSCqS3t9y/oQidFR+xN3Z
+     * bAMBCAfCeAQYFggAKgUCZKQEMwkQPIq5xLhlTYkCGwwWIQTcxtMgul/AeUvH
+     * bio8irnEuGVNiQAAqt8BAM/4Lw0RVOb0L5Ki9CyxO/6AKvRg4ra3Q3WR+duP
+     * s/88AQCDErzvn+SOX4s3gvZcM3Vr4wh4Q2syHV8Okgx8STYPDg===DsVk
+     * -----END PGP PUBLIC KEY BLOCK-----`;
+     *
+     * const publicKeys = [publicKey1, publicKey2];
+     * const resultMessage = await encription.signAndEncrypt('message', publicKeys);
+     * ```
      */
     signAndEncrypt(message: string, publicKeys: string[]): Promise<string>;
     /**
-     * Decrypts an encrypted message using the private key.
+     * This function decrypt message message using the private key. In addition, the public key can be added for signature verification.
+     *
+     * @param {string} message Message to decrypt.
+     * @param {string} publicKey Public key used to verify signature if needed. Optional.
+     * @returns {Promise<string>} Message decrypted.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { Encryption } from '@human-protocol/sdk';
      *
-     * @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.
+     * const privateKey = 'Armored_priv_key';
+     * const passphrase = 'example_passphrase';
+     * const encription = await Encryption.build(privateKey, passphrase);
+     *
+     * 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 resultMessage = await encription.decrypt('message');
+     * ```
      */
     decrypt(message: string, publicKey?: string): Promise<string>;
     /**
-     * Signs a message using the private key.
+     * This function signs a message using the private key used to initialize the client.
+     *
+     * @param {string} message Message to sign.
+     * @returns {Promise<string>} Message signed.
+     *
+     * **Code example**
      *
-     * @param {string} message - The message to sign.
-     * @returns {Promise<string>} - The signed message.
+     * ```ts
+     * import { Encryption } from '@human-protocol/sdk';
+     *
+     * const privateKey = 'Armored_priv_key';
+     * const passphrase = 'example_passphrase';
+     * const encription = await Encryption.build(privateKey, passphrase);
+     *
+     * const resultMessage = await encription.sign('message');
+     * ```
      */
     sign(message: string): Promise<string>;
 }
 /**
+ * ## Introduction
+ *
  * Utility class for encryption-related operations.
+ *
+ * ## Installation
+ *
+ * ### npm
+ * ```bash
+ * npm install @human-protocol/sdk
+ * ```
+ *
+ * ### yarn
+ * ```bash
+ * yarn install @human-protocol/sdk
+ * ```
+ *
+ * ## Code example
+ *
+ * ```ts
+ * import { EncryptionUtils } from '@human-protocol/sdk';
+ *
+ * const keyPair = await EncryptionUtils.generateKeyPair('Human', 'human@hmt.ai');
+ * ```
  */
 export declare class EncryptionUtils {
     /**
-     * Verifies the signature of a signed message using the public key.
+     * 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.
+     * @returns {Promise<boolean>} True if verified. False if not verified.
      *
-     * @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.
+     * **Code example**
+     *
+     * ```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 result = await EncriptionUtils.verify('message', publicKey);
+     * ```
      */
     static verify(message: string, publicKey: string): Promise<boolean>;
     /**
-     * Gets the signed data from a signed message.
+     * This function gets signed data from a signed message.
+     *
+     * @param {string} message Message.
+     * @returns {Promise<string>} Signed data.
      *
-     * @param {string} message - The signed message.
-     * @returns {Promise<string>} - The signed data.
-     * @throws {Error} - An error object if an error occurred.
+     * **Code example**
+     *
+     * ```ts
+     * import { EncryptionUtils } from '@human-protocol/sdk';
+     *
+     * const signedData = await EncriptionUtils.getSignedData('message');
+     * ```
      */
     static getSignedData(message: string): Promise<string>;
     /**
-     * Generates a key pair for encryption and decryption.
+     * This function generates a key pair for encryption and decryption.
+     *
+     * @param {string} name Name for the key pair.
+     * @param {string} email Email for the key pair.
+     * @param {string} passphrase Passphrase to encrypt the private key. Optional.
+     * @returns {Promise<IKeyPair>} Key pair generated.
+     *
+     * **Code example**
      *
-     * @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.
+     * ```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);
+     * ```
      */
     static generateKeyPair(name: string, email: string, passphrase?: string): Promise<IKeyPair>;
     /**
-     * Encrypts a message using the specified public keys.
+     * 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.
+     * @returns {Promise<string>} Message encrypted.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { EncryptionUtils } from '@human-protocol/sdk';
+     *
+     * const publicKey1 = `-----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 publicKey2 = `-----BEGIN PGP PUBLIC KEY BLOCK-----
+     * xjMEZKQEMxYJKwYBBAHaRw8BAQdAG6h+E+6T/RV2tIHer3FP/jKThAyGcoVx
+     * FzhnP0hncPzNFEh1bWFuIDxodW1hbkBobXQuYWk+wowEEBYKAD4FAmSkBDME
+     * CwkHCAkQPIq5xLhlTYkDFQgKBBYAAgECGQECGwMCHgEWIQTcxtMgul/AeUvH
+     * bio8irnEuGVNiQAA/HsBANpfFkxNYixpsBk8LlaaCaPy5f1/cWNPgODM9uzo
+     * ciSTAQDtAYynu4dSJO9GbMuDuc0FaUHRWJK3mS6JkvedYL4oBM44BGSkBDMS
+     * CisGAQQBl1UBBQEBB0DWbEG7DMhkeSc8ZPzrH8XNSCqS3t9y/oQidFR+xN3Z
+     * bAMBCAfCeAQYFggAKgUCZKQEMwkQPIq5xLhlTYkCGwwWIQTcxtMgul/AeUvH
+     * bio8irnEuGVNiQAAqt8BAM/4Lw0RVOb0L5Ki9CyxO/6AKvRg4ra3Q3WR+duP
+     * s/88AQCDErzvn+SOX4s3gvZcM3Vr4wh4Q2syHV8Okgx8STYPDg===DsVk
+     * -----END PGP PUBLIC KEY BLOCK-----`;
      *
-     * @param {string} message - The message to encrypt.
-     * @param {string[]} publicKeys - The public keys in armored format.
-     * @returns {Promise<string>} - The encrypted message.
+     * const publicKeys = [publicKey1, publicKey2]
+     * const result = await EncriptionUtils.encrypt('message', publicKeys);
+     * ```
      */
     static encrypt(message: string, publicKeys: string[]): Promise<string>;
 }

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;AACxC;;GAEG;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;;;;;;OAMG;IACU,cAAc,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;OAMG;IACU,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB1E;;;;;OAKG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYpD;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B;;;;;;OAMG;WACiB,MAAM,CACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;OAMG;WACiB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAYnE;;;;;;;OAOG;WACiB,eAAe,CACjC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,UAAU,SAAK,GACd,OAAO,CAAC,QAAQ,CAAC;IAkBpB;;;;;;OAMG;WACiB,OAAO,CACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;CAenB"}
+{"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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;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,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB1E;;;;;;;;;;;;;;;;;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,MAAM,EACf,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;CAenB"}

package/dist/encryption.js

@@ -26,7 +26,45 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EncryptionUtils = exports.Encryption = void 0;
 const openpgp = __importStar(require("openpgp"));
 /**
- * Class for encryption and decryption operations.
+ * ## Introduction
+ *
+ * Class for sign and decrypt messages.
+ *
+ * The algorithm includes the implementation of the [PGP encryption algorithm](https://github.com/openpgpjs/openpgpjs) multi-public key encryption on typescript.
+ * Using the vanilla [ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) implementation Schnorr signatures for signature and [curve25519](https://en.wikipedia.org/wiki/Curve25519) for encryption. [Learn more](https://wiki.polkadot.network/docs/learn-cryptography).
+ *
+ * To get an instance of this class, is recommended to initialize it using the static `build` method.
+ *
+ * ```ts
+ * static async build(privateKeyArmored: string, passphrase?: string): Promise<Encryption>
+ * ```
+ *
+ * ## Installation
+ *
+ * ### npm
+ * ```bash
+ * npm install @human-protocol/sdk
+ * ```
+ *
+ * ### yarn
+ * ```bash
+ * yarn install @human-protocol/sdk
+ * ```
+ *
+ * ## Input parameters
+ *
+ * - `privateKeyArmored` - The encrypted private key in armored format.
+ * - `passphrase` - The passphrase for the private key.
+ *
+ * ## Code example
+ *
+ * ```ts
+ * import { Encryption } from '@human-protocol/sdk';
+ *
+ * const privateKey = 'Armored_priv_key';
+ * const passphrase = 'example_passphrase';
+ * const encription = await Encryption.build(privateKey, passphrase);
+ * ```
  */
 class Encryption {
     /**
@@ -58,11 +96,48 @@ class Encryption {
         }));
     }
     /**
-     * Signs and encrypts a message using the specified public keys.
+     * This function signs and encrypts a message using the private key used to initialize the client and 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.
+     * @param {string} message Message to sign and encrypt.
+     * @param {string[]} publicKeys Array of public keys to use for encryption.
+     * @returns {Promise<string>} Message signed and encrypted.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { Encryption } from '@human-protocol/sdk';
+     * import { EscrowClient } from '@human-protocol/sdk';
+     *
+     * const privateKey = 'Armored_priv_key';
+     * const passphrase = 'example_passphrase';
+     * const encription = await Encryption.build(privateKey, passphrase);
+     * const publicKey1 = `-----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 publicKey2 = `-----BEGIN PGP PUBLIC KEY BLOCK-----
+     * xjMEZKQEMxYJKwYBBAHaRw8BAQdAG6h+E+6T/RV2tIHer3FP/jKThAyGcoVx
+     * FzhnP0hncPzNFEh1bWFuIDxodW1hbkBobXQuYWk+wowEEBYKAD4FAmSkBDME
+     * CwkHCAkQPIq5xLhlTYkDFQgKBBYAAgECGQECGwMCHgEWIQTcxtMgul/AeUvH
+     * bio8irnEuGVNiQAA/HsBANpfFkxNYixpsBk8LlaaCaPy5f1/cWNPgODM9uzo
+     * ciSTAQDtAYynu4dSJO9GbMuDuc0FaUHRWJK3mS6JkvedYL4oBM44BGSkBDMS
+     * CisGAQQBl1UBBQEBB0DWbEG7DMhkeSc8ZPzrH8XNSCqS3t9y/oQidFR+xN3Z
+     * bAMBCAfCeAQYFggAKgUCZKQEMwkQPIq5xLhlTYkCGwwWIQTcxtMgul/AeUvH
+     * bio8irnEuGVNiQAAqt8BAM/4Lw0RVOb0L5Ki9CyxO/6AKvRg4ra3Q3WR+duP
+     * s/88AQCDErzvn+SOX4s3gvZcM3Vr4wh4Q2syHV8Okgx8STYPDg===DsVk
+     * -----END PGP PUBLIC KEY BLOCK-----`;
+     *
+     * const publicKeys = [publicKey1, publicKey2];
+     * const resultMessage = await encription.signAndEncrypt('message', publicKeys);
+     * ```
      */
     async signAndEncrypt(message, publicKeys) {
         const plaintext = message;
@@ -76,11 +151,35 @@ class Encryption {
         return encrypted;
     }
     /**
-     * Decrypts an encrypted message using the private key.
+     * This function decrypt message message using the private key. In addition, the public key can be added for signature verification.
+     *
+     * @param {string} message Message to decrypt.
+     * @param {string} publicKey Public key used to verify signature if needed. Optional.
+     * @returns {Promise<string>} Message decrypted.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { Encryption } from '@human-protocol/sdk';
      *
-     * @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.
+     * const privateKey = 'Armored_priv_key';
+     * const passphrase = 'example_passphrase';
+     * const encription = await Encryption.build(privateKey, passphrase);
+     *
+     * 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 resultMessage = await encription.decrypt('message');
+     * ```
      */
     async decrypt(message, publicKey) {
         const pgpMessage = await openpgp.readMessage({ armoredMessage: message });
@@ -97,10 +196,22 @@ class Encryption {
         return decrypted;
     }
     /**
-     * Signs a message using the private key.
+     * This function signs a message using the private key used to initialize the client.
+     *
+     * @param {string} message Message to sign.
+     * @returns {Promise<string>} Message signed.
+     *
+     * **Code example**
      *
-     * @param {string} message - The message to sign.
-     * @returns {Promise<string>} - The signed message.
+     * ```ts
+     * import { Encryption } from '@human-protocol/sdk';
+     *
+     * const privateKey = 'Armored_priv_key';
+     * const passphrase = 'example_passphrase';
+     * const encription = await Encryption.build(privateKey, passphrase);
+     *
+     * const resultMessage = await encription.sign('message');
+     * ```
      */
     async sign(message) {
         const unsignedMessage = await openpgp.createCleartextMessage({
@@ -116,15 +227,57 @@ class Encryption {
 }
 exports.Encryption = Encryption;
 /**
+ * ## Introduction
+ *
  * Utility class for encryption-related operations.
+ *
+ * ## Installation
+ *
+ * ### npm
+ * ```bash
+ * npm install @human-protocol/sdk
+ * ```
+ *
+ * ### yarn
+ * ```bash
+ * yarn install @human-protocol/sdk
+ * ```
+ *
+ * ## Code example
+ *
+ * ```ts
+ * import { EncryptionUtils } from '@human-protocol/sdk';
+ *
+ * const keyPair = await EncryptionUtils.generateKeyPair('Human', 'human@hmt.ai');
+ * ```
  */
 class EncryptionUtils {
     /**
-     * Verifies the signature of a signed message using the public key.
+     * 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.
+     * @returns {Promise<boolean>} True if verified. False if not verified.
      *
-     * @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.
+     * **Code example**
+     *
+     * ```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 result = await EncriptionUtils.verify('message', publicKey);
+     * ```
      */
     static async verify(message, publicKey) {
         const pgpPublicKey = await openpgp.readKey({ armoredKey: publicKey });
@@ -141,11 +294,18 @@ class EncryptionUtils {
         }
     }
     /**
-     * Gets the signed data from a signed message.
+     * This function gets signed data from a signed message.
+     *
+     * @param {string} message Message.
+     * @returns {Promise<string>} Signed data.
      *
-     * @param {string} message - The signed message.
-     * @returns {Promise<string>} - The signed data.
-     * @throws {Error} - An error object if an error occurred.
+     * **Code example**
+     *
+     * ```ts
+     * import { EncryptionUtils } from '@human-protocol/sdk';
+     *
+     * const signedData = await EncriptionUtils.getSignedData('message');
+     * ```
      */
     static async getSignedData(message) {
         const signedMessage = await openpgp.readCleartextMessage({
@@ -159,12 +319,35 @@ class EncryptionUtils {
         }
     }
     /**
-     * Generates a key pair for encryption and decryption.
+     * This function generates a key pair for encryption and decryption.
+     *
+     * @param {string} name Name for the key pair.
+     * @param {string} email Email for the key pair.
+     * @param {string} passphrase Passphrase to encrypt the private key. Optional.
+     * @returns {Promise<IKeyPair>} Key pair generated.
+     *
+     * **Code example**
      *
-     * @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.
+     * ```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);
+     * ```
      */
     static async generateKeyPair(name, email, passphrase = '') {
         const { privateKey, publicKey, revocationCertificate } = await openpgp.generateKey({
@@ -182,11 +365,44 @@ class EncryptionUtils {
         };
     }
     /**
-     * Encrypts a message using the specified public keys.
+     * 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.
+     * @returns {Promise<string>} Message encrypted.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { EncryptionUtils } from '@human-protocol/sdk';
+     *
+     * const publicKey1 = `-----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 publicKey2 = `-----BEGIN PGP PUBLIC KEY BLOCK-----
+     * xjMEZKQEMxYJKwYBBAHaRw8BAQdAG6h+E+6T/RV2tIHer3FP/jKThAyGcoVx
+     * FzhnP0hncPzNFEh1bWFuIDxodW1hbkBobXQuYWk+wowEEBYKAD4FAmSkBDME
+     * CwkHCAkQPIq5xLhlTYkDFQgKBBYAAgECGQECGwMCHgEWIQTcxtMgul/AeUvH
+     * bio8irnEuGVNiQAA/HsBANpfFkxNYixpsBk8LlaaCaPy5f1/cWNPgODM9uzo
+     * ciSTAQDtAYynu4dSJO9GbMuDuc0FaUHRWJK3mS6JkvedYL4oBM44BGSkBDMS
+     * CisGAQQBl1UBBQEBB0DWbEG7DMhkeSc8ZPzrH8XNSCqS3t9y/oQidFR+xN3Z
+     * bAMBCAfCeAQYFggAKgUCZKQEMwkQPIq5xLhlTYkCGwwWIQTcxtMgul/AeUvH
+     * bio8irnEuGVNiQAAqt8BAM/4Lw0RVOb0L5Ki9CyxO/6AKvRg4ra3Q3WR+duP
+     * s/88AQCDErzvn+SOX4s3gvZcM3Vr4wh4Q2syHV8Okgx8STYPDg===DsVk
+     * -----END PGP PUBLIC KEY BLOCK-----`;
      *
-     * @param {string} message - The message to encrypt.
-     * @param {string[]} publicKeys - The public keys in armored format.
-     * @returns {Promise<string>} - The encrypted message.
+     * const publicKeys = [publicKey1, publicKey2]
+     * const result = await EncriptionUtils.encrypt('message', publicKeys);
+     * ```
      */
     static async encrypt(message, publicKeys) {
         const plaintext = message;