@human-protocol/sdk 5.2.0 → 6.0.0

package/dist/base.d.ts

@@ -1,10 +1,9 @@
 import { ContractRunner } from 'ethers';
 import { NetworkData } from './types';
 /**
- * ## Introduction
- *
- * This class is used as a base class for other clients making on-chain calls.
+ * Base class for clients making on-chain calls.
  *
+ * This class provides common functionality for interacting with Ethereum contracts.
  */
 export declare abstract class BaseEthersClient {
     protected runner: ContractRunner;
@@ -12,8 +11,8 @@ export declare abstract class BaseEthersClient {
     /**
      * **BaseClient constructor**
      *
-     * @param {ContractRunner} runner The Signer or Provider object to interact with the Ethereum network
-     * @param {NetworkData} networkData The network information required to connect to the contracts
+     * @param runner - The Signer or Provider object to interact with the Ethereum network
+     * @param networkData - The network information required to connect to the contracts
      */
     constructor(runner: ContractRunner, networkData: NetworkData);
 }

package/dist/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;;GAKG;AACH,8BAAsB,gBAAgB;IACpC,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;IAC1B,WAAW,EAAE,WAAW,CAAC;IAEhC;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;CAI7D"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC;;;;GAIG;AACH,8BAAsB,gBAAgB;IACpC,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;IAC1B,WAAW,EAAE,WAAW,CAAC;IAEhC;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;CAI7D"}

package/dist/base.js

@@ -2,17 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseEthersClient = void 0;
 /**
- * ## Introduction
- *
- * This class is used as a base class for other clients making on-chain calls.
+ * Base class for clients making on-chain calls.
  *
+ * This class provides common functionality for interacting with Ethereum contracts.
  */
 class BaseEthersClient {
     /**
      * **BaseClient constructor**
      *
-     * @param {ContractRunner} runner The Signer or Provider object to interact with the Ethereum network
-     * @param {NetworkData} networkData The network information required to connect to the contracts
+     * @param runner - The Signer or Provider object to interact with the Ethereum network
+     * @param networkData - The network information required to connect to the contracts
      */
     constructor(runner, networkData) {
         this.networkData = networkData;

package/dist/constants.js

@@ -28,7 +28,7 @@ exports.NETWORKS = {
         stakingAddress: '0xEf6Da3aB52c33925Be3F84038193a7e1331F51E6',
         kvstoreAddress: '0xB6d36B1CDaD50302BCB3DB43bAb0D349458e1b8D',
         subgraphUrl: 'https://api.studio.thegraph.com/query/74256/ethereum/version/latest',
-        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmXGmcjEtwwEgB83KE2ECjjYY38kLMqzaq4ip8GWY7A6zz',
+        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmeCB3KX49nRAkzgqancc3yL3VMJvt65YtL1zrLCFgr2n5',
         oldSubgraphUrl: '',
         oldFactoryAddress: '',
     },
@@ -41,7 +41,7 @@ exports.NETWORKS = {
         stakingAddress: '0x2163e3A40032Af1C359ac731deaB48258b317890',
         kvstoreAddress: '0xCc0AF0635aa19fE799B6aFDBe28fcFAeA7f00a60',
         subgraphUrl: 'https://api.studio.thegraph.com/query/74256/sepolia/version/latest',
-        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmT4xNvZh8ymarrk1zdytjLhCW59iuTavsd4JgHS4LbCVB',
+        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmcMntqZSTh8wJddxgp2hYcdw78wZFU86LHTHzJ1bTVUDc',
         oldSubgraphUrl: '',
         oldFactoryAddress: '',
     },
@@ -54,7 +54,7 @@ exports.NETWORKS = {
         stakingAddress: '0xE24e5C08E28331D24758b69A5E9f383D2bDD1c98',
         kvstoreAddress: '0x21A0C4CED7aE447fCf87D9FE3A29FA9B3AB20Ff1',
         subgraphUrl: 'https://api.studio.thegraph.com/query/74256/bsc/version/latest',
-        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmdVdpm9NnFz5B8QyzhW1bW1nNfRWemTiFn2MrhYZGTSQD',
+        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmRexbu8eLZ1iE7ZLMtKxAr9GJnQ1JVrXhybKq6JkJ9XLE',
         oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
         oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
     },
@@ -67,7 +67,7 @@ exports.NETWORKS = {
         stakingAddress: '0xD6D347ba6987519B4e42EcED43dF98eFf5465a23',
         kvstoreAddress: '0x32e27177BA6Ea91cf28dfd91a0Da9822A4b74EcF',
         subgraphUrl: 'https://api.studio.thegraph.com/query/74256/bsc-testnet/version/latest',
-        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmZjYMktZe8RAz7W7qL33VZBV6AC57xsLyE1cEfv6NABdZ',
+        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmfFBXsAP7nbckFx34XYcNq2hRnfoVNrfqCvuk7hmAtYJT',
         oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest',
         oldFactoryAddress: '0xaae6a2646c1f88763e62e0cd08ad050ea66ac46f',
     },
@@ -80,7 +80,7 @@ exports.NETWORKS = {
         stakingAddress: '0x01D115E9E8bF0C58318793624CC662a030D07F1D',
         kvstoreAddress: '0xbcB28672F826a50B03EE91B28145EAbddA73B2eD',
         subgraphUrl: 'https://api.studio.thegraph.com/query/74256/polygon/version/latest',
-        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmUt9mmfNjtC5ZnQNiWHRbFG3k5zfngMuoTyky9jhXYqG2',
+        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmUwHMDjnDHDB5cowGqd96SRJ1sZegoAPanjxBWUyLZghv',
         oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon',
         oldFactoryAddress: '0x45eBc3eAE6DA485097054ae10BA1A0f8e8c7f794',
     },
@@ -93,7 +93,7 @@ exports.NETWORKS = {
         stakingAddress: '0xffE496683F842a923110415b7278ded3F265f2C5',
         kvstoreAddress: '0x724AeFC243EdacCA27EAB86D3ec5a76Af4436Fc7',
         subgraphUrl: 'https://api.studio.thegraph.com/query/74256/amoy/version/latest',
-        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmWRUFWpWoRRUh7Ec1HUJEwxc84DkP4iFTfLLsoVngJAPa',
+        subgraphUrlApiKey: 'https://gateway.thegraph.com/api/deployments/id/QmTJfcvVVmw8fe5CwRP6tZD5FzE2ESrm3ryygS1YZMYhM7',
         oldSubgraphUrl: '',
         oldFactoryAddress: '',
     },

package/dist/encryption.d.ts

@@ -3,313 +3,179 @@ import { IKeyPair } from './interfaces';
 /**
  * Type representing the data type of a message.
  * It can be either a string or a Uint8Array.
+ *
+ * @public
  */
-type MessageDataType = string | Uint8Array;
+export type MessageDataType = string | Uint8Array;
 /**
- * ## Introduction
- *
  * Class for signing and decrypting messages.
  *
  * The algorithm includes the implementation of the [PGP encryption algorithm](https://github.com/openpgpjs/openpgpjs) multi-public key encryption on typescript, and uses the vanilla [ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) implementation Schnorr signature for signatures 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, initialization is recommended 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 encryption = await Encryption.build(privateKey, passphrase);
- * ```
+ * To get an instance of this class, initialization is recommended using the static [`build`](/ts/classes/Encryption/#build) method.
  */
 export declare class Encryption {
     private privateKey;
     /**
      * Constructor for the Encryption class.
      *
-     * @param {PrivateKey} privateKey - The private key.
+     * @param privateKey - The private key.
      */
     constructor(privateKey: openpgp.PrivateKey);
     /**
      * Builds an Encryption instance by decrypting the private key from an encrypted private key and passphrase.
      *
-     * @param {string} privateKeyArmored - The encrypted private key in armored format.
-     * @param {string} passphrase - Optional: The passphrase for the private key.
-     * @returns {Promise<Encryption>} - The Encryption instance.
-     */
-    static build(privateKeyArmored: string, passphrase?: string): Promise<Encryption>;
-    /**
-     * This function signs and encrypts a message using the private key used to initialize the client and the specified public keys.
-     *
-     * @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.
-     *
-     * **Code example**
+     * @param privateKeyArmored - The encrypted private key in armored format.
+     * @param passphrase - The passphrase for the private key (optional).
+     * @returns The Encryption instance.
      *
+     * @example
      * ```ts
      * import { Encryption } from '@human-protocol/sdk';
-     * import { EscrowClient } from '@human-protocol/sdk';
      *
      * const privateKey = 'Armored_priv_key';
      * const passphrase = 'example_passphrase';
      * const encryption = 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-----`;
+     * ```
+     */
+    static build(privateKeyArmored: string, passphrase?: string): Promise<Encryption>;
+    /**
+     * This function signs and encrypts a message using the private key used to initialize the client and the specified public keys.
+     *
+     * @param message - Message to sign and encrypt.
+     * @param publicKeys - Array of public keys to use for encryption.
+     * @returns Message signed and encrypted.
      *
-     * 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-----`;
+     * @example
+     * ```ts
+     * const publicKey1 = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
+     * const publicKey2 = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
      *
      * const publicKeys = [publicKey1, publicKey2];
      * const resultMessage = await encryption.signAndEncrypt('message', publicKeys);
+     * console.log('Encrypted message:', resultMessage);
      * ```
      */
     signAndEncrypt(message: MessageDataType, publicKeys: string[]): Promise<string>;
     /**
      * This function decrypts messages 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. This is optional.
-     * @returns {Promise<Uint8Array>} Message decrypted.
-     *
-     * **Code example**
+     * @param message - Message to decrypt.
+     * @param publicKey - Public key used to verify signature if needed (optional).
+     * @returns Message decrypted.
+     * @throws Error If signature could not be verified when public key is provided
      *
+     * @example
      * ```ts
-     * import { Encryption } from '@human-protocol/sdk';
-     *
-     * const privateKey = 'Armored_priv_key';
-     * const passphrase = 'example_passphrase';
-     * const encryption = await Encryption.build(privateKey, passphrase);
+     * const publicKey = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
      *
-     * 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 encryption.decrypt('message');
+     * const resultMessage = await encryption.decrypt('message', publicKey);
+     * console.log('Decrypted message:', resultMessage);
      * ```
      */
     decrypt(message: string, publicKey?: string): Promise<Uint8Array>;
     /**
      * 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 message - Message to sign.
+     * @returns Message signed.
      *
+     * @example
      * ```ts
-     * import { Encryption } from '@human-protocol/sdk';
-     *
-     * const privateKey = 'Armored_priv_key';
-     * const passphrase = 'example_passphrase';
-     * const encryption = await Encryption.build(privateKey, passphrase);
-     *
      * const resultMessage = await encryption.sign('message');
+     * console.log('Signed message:', resultMessage);
      * ```
      */
     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 {
     /**
      * 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 signed by a specific source.
-     * @returns {Promise<boolean>} True if verified. False if not verified.
-     *
-     * **Code example**
+     * @param message - Message to verify.
+     * @param publicKey - Public key to verify that the message was signed by a specific source.
+     * @returns True if verified. False if not verified.
      *
+     * @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 publicKey = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
      * const result = await EncryptionUtils.verify('message', publicKey);
+     * console.log('Verification result:', result);
      * ```
      */
     static verify(message: string, publicKey: string): Promise<boolean>;
     /**
      * This function gets signed data from a signed message.
      *
-     * @param {string} message Message.
-     * @returns {Promise<string>} Signed data.
-     *
-     * **Code example**
+     * @param message - Message.
+     * @returns Signed data.
+     * @throws Error If data could not be extracted from the message
      *
+     * @example
      * ```ts
      * import { EncryptionUtils } from '@human-protocol/sdk';
      *
      * const signedData = await EncryptionUtils.getSignedData('message');
+     * console.log('Signed data:', signedData);
      * ```
      */
     static getSignedData(message: string): Promise<string>;
     /**
      * 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 name - Name for the key pair.
+     * @param email - Email for the key pair.
+     * @param passphrase - Passphrase to encrypt the private key (optional, defaults to empty string).
+     * @returns Key pair generated.
      *
+     * @example
      * ```ts
      * import { EncryptionUtils } from '@human-protocol/sdk';
      *
      * const name = 'YOUR_NAME';
      * const email = 'YOUR_EMAIL';
      * const passphrase = 'YOUR_PASSPHRASE';
-     * const result = await EncryptionUtils.generateKeyPair(name, email, passphrase);
+     * const keyPair = await EncryptionUtils.generateKeyPair(name, email, passphrase);
+     * console.log('Public key:', keyPair.publicKey);
      * ```
      */
     static generateKeyPair(name: string, email: string, passphrase?: string): Promise<IKeyPair>;
     /**
      * This function encrypts a message using the specified public keys.
      *
-     * @param {MessageDataType} message Message to encrypt.
-     * @param {string[]} publicKeys Array of public keys to use for encryption.
-     * @returns {Promise<string>} Message encrypted.
-     *
-     * **Code example**
+     * @param message - Message to encrypt.
+     * @param publicKeys - Array of public keys to use for encryption.
+     * @returns Message encrypted.
      *
+     * @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-----`;
-     *
-     * const publicKeys = [publicKey1, publicKey2]
-     * const result = await EncryptionUtils.encrypt('message', publicKeys);
+     * const publicKey1 = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
+     * const publicKey2 = '-----BEGIN PGP PUBLIC KEY BLOCK-----...';
+     * const publicKeys = [publicKey1, publicKey2];
+     * const encryptedMessage = await EncryptionUtils.encrypt('message', publicKeys);
+     * console.log('Encrypted message:', encryptedMessage);
      * ```
      */
     static encrypt(message: MessageDataType, publicKeys: string[]): Promise<string>;
     /**
      * Verifies if a message appears to be encrypted with OpenPGP.
      *
-     * @param {string} message Message to verify.
-     * @returns {Promise<boolean>} `true` if the message appears to be encrypted, `false` if not.
-     *
-     * **Code example:**
+     * @param message - Message to verify.
+     * @returns `true` if the message appears to be encrypted, `false` if not.
      *
+     * @example
      * ```ts
-     * const message = `-----BEGIN PGP MESSAGE-----
-     *
-     * wV4DqdeRpqH+jaISAQdAsvBFxikvjxRqC7ZlDe98cLd7/aeCEI/AcL8PpVKK
-     * mC0wKlwxNg/ADi55z9jcYFuMC4kKE+C/teM+JqiI8DO9AwassQUvKFtULnpx
-     * h2jaOjC/0sAQASjUsIFK8zbuDgk/P8T9Npn6px+GlJPg9K90iwtPWiIp0eyW
-     * 4zXamJZT51k2DyaUX/Rsc6P4PYhQRKjt0yxtH0jHPmKkLC/9eBeFf4GP0zlZ
-     * 18xMZ8uCpQCma708Gz0sJYxEz3u/eZdHD7Mc7tWQKyJG8MsTwM1P+fdK1X75
-     * L9UryJG2AY+6kKZhG4dqjNxiO4fWluiB2u7iMF+iLEyE3SQCEYorWMC+NDWi
-     * QIJZ7oQ2w7BaPo1a991gvTOSNm5v2x44KfqPI1uj859BjsQTCA==
-     * =tsmI
-     * -----END PGP MESSAGE-----`;
+     * import { EncryptionUtils } from '@human-protocol/sdk';
      *
-     * const isEncrypted = await EncryptionUtils.isEncrypted(message);
+     * const message = '-----BEGIN PGP MESSAGE-----...';
+     * const isEncrypted = EncryptionUtils.isEncrypted(message);
      *
      * if (isEncrypted) {
      *   console.log('The message is encrypted with OpenPGP.');
@@ -320,5 +186,4 @@ export declare class EncryptionUtils {
      */
     static isEncrypted(message: string): boolean;
 }
-export {};
 //# sourceMappingURL=encryption.d.ts.map

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;;;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"}
+{"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;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAUlD;;;;;;GAMG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,UAAU,CAAqB;IAEvC;;;;OAIG;gBACS,UAAU,EAAE,OAAO,CAAC,UAAU;IAI1C;;;;;;;;;;;;;;;OAeG;WACiB,KAAK,CACvB,iBAAiB,EAAE,MAAM,EACzB,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,UAAU,CAAC;IAkBtB;;;;;;;;;;;;;;;;OAgBG;IACU,cAAc,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAkBlB;;;;;;;;;;;;;;;OAeG;IACU,OAAO,CAClB,OAAO,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,UAAU,CAAC;IAoCtB;;;;;;;;;;;OAWG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAYpD;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B;;;;;;;;;;;;;;;OAeG;WACiB,MAAM,CACxB,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,OAAO,CAAC;IAgBnB;;;;;;;;;;;;;;OAcG;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;;;;;;;;;;;;;;;;;OAiBG;WACiB,OAAO,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,MAAM,EAAE,GACnB,OAAO,CAAC,MAAM,CAAC;IAiBlB;;;;;;;;;;;;;;;;;;;OAmBG;WACW,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CASpD"}