@human-protocol/sdk 1.1.3 → 1.1.6

package/README.md

@@ -6,4 +6,83 @@ Node.js SDK to launch/manage escrows on [Human Protocol](https://www.humanprotoc
 
 This SDK is available on [NPM](https://www.npmjs.com/package/@human-protocol/sdk).
 
-    yarn @human-protocol/sdk
+    yarn add @human-protocol/sdk
+
+## Components
+
+- InitClient
+
+  **InitClient** has one static function that returns a `Signer` or `Provider` (depending on the passed parameter), as well as a chainId associated with this parameter in an asynchronous way. Used for further passing as a constructor parameter to Web3 dependent modules.
+
+- StorageClient
+
+  **StorageClient** is used to upload/download files to the cloud storage with given credentials and params. If credentials are not provided, anonymous access will be used (for downloading files).
+
+- EscrowClient
+
+  **EscrowClient** enables to perform actions on Escrow contracts and obtain information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
+
+- KVStoreClient
+
+  **KVStoreClient** enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
+
+- StakingClient
+
+  **StakingClient** enables to perform actions on staking contracts and obtain staking information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
+
+## Example
+
+```typescript
+const {
+  EscrowClient,
+  StakingClient,
+  NETWORKS,
+  ChainId,
+} = require('@human-protocol/sdk');
+const { ethers } = require('ethers');
+
+(async () => {
+  // Hardhat Provider
+  const provider = new ethers.providers.JsonRpcProvider(
+    'http://127.0.0.1:8545/'
+  );
+
+  // Load localhost configuration
+  const network = NETWORKS[ChainId.LOCALHOST];
+
+  const signer = new ethers.Wallet(
+    '0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a',
+    provider
+  );
+
+  // Initialize StakingClient
+  const stakingClient = new StakingClient({
+    signerOrProvider: signer,
+    network,
+  });
+
+  // Stake 10 HMT
+  await stakingClient.approveStake(ethers.BigNumber.from(10));
+  await stakingClient.stake(ethers.BigNumber.from(10));
+
+  // Initialize EscrowClient
+  const escrowClient = new EscrowClient({
+    signerOrProvider: signer,
+    network,
+  });
+
+  // Create a new escrow, and setup
+  const escrowAddress = await escrowClient.createEscrow(network.hmtAddress, [
+    signer.address,
+  ]);
+
+  await escrowClient.setup(escrowAddress, {
+    recordingOracle: '0x90F79bf6EB2c4f870365E785982E1f101E93b906',
+    reputationOracle: '0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65',
+    recordingOracleFee: ethers.BigNumber.from(1),
+    reputationOracleFee: ethers.BigNumber.from(1),
+    manifestUrl: 'http://example.com',
+    hash: 'test',
+  });
+})();
+```

package/dist/constants.d.ts

@@ -0,0 +1,52 @@
+import { ChainId } from './enums';
+import { NetworkData } from './types';
+/**
+ * @constant Default public bucket name
+ */
+export declare const DEFAULT_PUBLIC_BUCKET = "escrow-public-results";
+/**
+ * @constant Default storage endpoint
+ */
+export declare const DEFAULT_ENDPOINT = "localhost";
+/**
+ * @constant Default storage region
+ */
+export declare const DEFAULT_REGION = "eu";
+/**
+ * @constant Default storage port
+ */
+export declare const DEFAULT_PORT = 9000;
+/**
+ * @constant Default storage port
+ */
+export declare const DEFAULT_USE_SSL = false;
+/**
+ * @constant Default tx Id
+ */
+export declare const DEFAULT_TX_ID = 1;
+/**
+ * @constant Default Enum for escrow statuses.
+ */
+export declare enum HttpStatus {
+    OK = 200,
+    CREATED = 201,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    INTERNAL_SERVER_ERROR = 500
+}
+/**
+ * @constant Default network parameters
+ */
+export declare const NETWORKS: {
+    [chainId in ChainId]?: NetworkData;
+};
+export declare const KVStoreKeys: {
+    role: string;
+    webhook_url: string;
+    fee: string;
+    public_key: string;
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +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;;GAEG;AACH,eAAO,MAAM,qBAAqB,0BAA0B,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,gBAAgB,cAAc,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,YAAY,OAAO,CAAC;AAEjC;;GAEG;AACH,eAAO,MAAM,eAAe,QAAQ,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B;;GAEG;AACH,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;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE;KACpB,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,WAAW;CA0LnC,CAAC;AAEF,eAAO,MAAM,WAAW;;;;;CAKvB,CAAC"}

package/dist/constants.js

@@ -0,0 +1,222 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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;
+const enums_1 = require("./enums");
+/**
+ * @constant Default public bucket name
+ */
+exports.DEFAULT_PUBLIC_BUCKET = 'escrow-public-results';
+/**
+ * @constant Default storage endpoint
+ */
+exports.DEFAULT_ENDPOINT = 'localhost';
+/**
+ * @constant Default storage region
+ */
+exports.DEFAULT_REGION = 'eu';
+/**
+ * @constant Default storage port
+ */
+exports.DEFAULT_PORT = 9000;
+/**
+ * @constant Default storage port
+ */
+exports.DEFAULT_USE_SSL = false;
+/**
+ * @constant Default tx Id
+ */
+exports.DEFAULT_TX_ID = 1;
+/**
+ * @constant Default Enum for escrow statuses.
+ */
+var HttpStatus;
+(function (HttpStatus) {
+    HttpStatus[HttpStatus["OK"] = 200] = "OK";
+    HttpStatus[HttpStatus["CREATED"] = 201] = "CREATED";
+    HttpStatus[HttpStatus["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    HttpStatus[HttpStatus["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    HttpStatus[HttpStatus["PAYMENT_REQUIRED"] = 402] = "PAYMENT_REQUIRED";
+    HttpStatus[HttpStatus["FORBIDDEN"] = 403] = "FORBIDDEN";
+    HttpStatus[HttpStatus["NOT_FOUND"] = 404] = "NOT_FOUND";
+    HttpStatus[HttpStatus["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
+})(HttpStatus = exports.HttpStatus || (exports.HttpStatus = {}));
+/**
+ * @constant Default network parameters
+ */
+exports.NETWORKS = {
+    [enums_1.ChainId.MAINNET]: {
+        chainId: enums_1.ChainId.MAINNET,
+        title: 'Ethereum',
+        scanUrl: 'https://etherscan.io',
+        factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
+        hmtAddress: '0xd1ba9BAC957322D6e8c07a160a3A8dA11A0d2867',
+        stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
+        rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
+        kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/mainnet-v1',
+        oldSubgraphUrl: '',
+        oldFactoryAddress: '',
+    },
+    [enums_1.ChainId.RINKEBY]: {
+        chainId: enums_1.ChainId.RINKEBY,
+        title: 'Ethereum Rinkeby',
+        scanUrl: 'https://rinkeby.etherscan.io',
+        factoryAddress: '0x925B24444511c86F4d4E63141D8Be0A025E2dca4',
+        hmtAddress: '0x4dCf5ac4509888714dd43A5cCc46d7ab389D9c23',
+        stakingAddress: '',
+        rewardPoolAddress: '',
+        kvstoreAddress: '',
+        subgraphUrl: '',
+        oldSubgraphUrl: '',
+        oldFactoryAddress: '',
+    },
+    [enums_1.ChainId.GOERLI]: {
+        chainId: enums_1.ChainId.GOERLI,
+        title: 'Ethereum Goerli',
+        scanUrl: 'https://goerli.etherscan.io',
+        factoryAddress: '0x87469B4f2Fcf37cBd34E54244c0BD4Fa0603664c',
+        hmtAddress: '0xd3A31D57FDD790725d0F6B78095F62E8CD4ab317',
+        stakingAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
+        rewardPoolAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
+        kvstoreAddress: '0xc9Fe39c4b6e1d7A2991355Af159956982DADf842',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/goerli-v1',
+        oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/goerli',
+        oldFactoryAddress: '0xaAe6a2646C1F88763E62e0cD08aD050Ea66AC46F',
+    },
+    [enums_1.ChainId.BSC_MAINNET]: {
+        chainId: enums_1.ChainId.BSC_MAINNET,
+        title: 'Binance Smart Chain',
+        scanUrl: 'https://bscscan.com',
+        factoryAddress: '0x92FD968AcBd521c232f5fB8c33b342923cC72714',
+        hmtAddress: '0x711Fd6ab6d65A98904522d4e3586F492B989c527',
+        stakingAddress: '0xdFbB79dC35a3A53741be54a2C9b587d6BafAbd1C',
+        rewardPoolAddress: '0xf376443BCc6d4d4D63eeC086bc4A9E4a83878e0e',
+        kvstoreAddress: '0x2B95bEcb6EBC4589f64CB000dFCF716b4aeF8aA6',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc-v1',
+        oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsc',
+        oldFactoryAddress: '0xc88bC422cAAb2ac8812de03176402dbcA09533f4',
+    },
+    [enums_1.ChainId.BSC_TESTNET]: {
+        chainId: enums_1.ChainId.BSC_TESTNET,
+        title: 'Binance Smart Chain (Testnet)',
+        scanUrl: 'https://testnet.bscscan.com',
+        factoryAddress: '0x2bfA592DBDaF434DDcbb893B1916120d181DAD18',
+        hmtAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
+        stakingAddress: '0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18',
+        rewardPoolAddress: '0xB0A0500103eCEc431b73F6BAd923F0a2774E6e29',
+        kvstoreAddress: '0x3aD4B091E054f192a822D1406f4535eAd38580e4',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest-v1',
+        oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest',
+        oldFactoryAddress: '0xaae6a2646c1f88763e62e0cd08ad050ea66ac46f',
+    },
+    [enums_1.ChainId.POLYGON]: {
+        chainId: enums_1.ChainId.POLYGON,
+        title: 'Polygon',
+        scanUrl: 'https://polygonscan.com',
+        factoryAddress: '0xBDBfD2cC708199C5640C6ECdf3B0F4A4C67AdfcB',
+        hmtAddress: '0xc748B2A084F8eFc47E086ccdDD9b7e67aEb571BF',
+        stakingAddress: '0xcbAd56bE3f504E98bd70875823d3CC0242B7bB29',
+        rewardPoolAddress: '0xa8e32d777a3839440cc7c24D591A64B9481753B3',
+        kvstoreAddress: '0x35Cf4beBD58F9C8D75B9eA2599479b6C173d406F',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon-v1',
+        oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon',
+        oldFactoryAddress: '0x45eBc3eAE6DA485097054ae10BA1A0f8e8c7f794',
+    },
+    [enums_1.ChainId.POLYGON_MUMBAI]: {
+        chainId: enums_1.ChainId.POLYGON_MUMBAI,
+        title: 'Polygon Mumbai',
+        scanUrl: 'https://mumbai.polygonscan.com',
+        factoryAddress: '0xA8D927C4DA17A6b71675d2D49dFda4E9eBE58f2d',
+        hmtAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
+        stakingAddress: '0x7Fd3dF914E7b6Bd96B4c744Df32183b51368Bfac',
+        rewardPoolAddress: '0xf0145eD99AC3c4f877aDa7dA4D1E059ec9116BAE',
+        kvstoreAddress: '0xD7F61E812e139a5a02eDae9Dfec146E1b8eA3807',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/mumbai-v1',
+        oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/mumbai',
+        oldFactoryAddress: '0x558cd800f9F0B02f3B149667bDe003284c867E94',
+    },
+    [enums_1.ChainId.MOONBEAM]: {
+        chainId: enums_1.ChainId.MOONBEAM,
+        title: 'Moonbeam',
+        scanUrl: 'https://moonbeam.moonscan.io',
+        factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
+        hmtAddress: '0x3b25BC1dC591D24d60560d0135D6750A561D4764',
+        stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
+        rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
+        kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbeam-v1',
+        oldSubgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbeam',
+        oldFactoryAddress: '0x98108c28B7767a52BE38B4860832dd4e11A7ecad',
+    },
+    [enums_1.ChainId.MOONBASE_ALPHA]: {
+        chainId: enums_1.ChainId.MOONBASE_ALPHA,
+        title: 'Moonbase Alpha',
+        scanUrl: 'https://moonbase.moonscan.io/',
+        factoryAddress: '0x5e622FF522D81aa426f082bDD95210BC25fCA7Ed',
+        hmtAddress: '0x2dd72db2bBA65cE663e476bA8b84A1aAF802A8e3',
+        stakingAddress: '0xBFC7009F3371F93F3B54DdC8caCd02914a37495c',
+        rewardPoolAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
+        kvstoreAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbase-alpha-v1',
+        oldSubgraphUrl: '',
+        oldFactoryAddress: '',
+    },
+    [enums_1.ChainId.AVALANCHE_TESTNET]: {
+        chainId: enums_1.ChainId.AVALANCHE_TESTNET,
+        title: 'Fuji C-Chain',
+        scanUrl: 'https://testnet.snowtrace.io',
+        factoryAddress: '0xfb4469201951C3B9a7F1996c477cb7BDBEcE0A88',
+        hmtAddress: '0x9406d5c635AD22b0d76c75E52De57A2177919ca3',
+        stakingAddress: '',
+        rewardPoolAddress: '',
+        kvstoreAddress: '0xd232c1426CF0653cE8a71DC98bCfDf10c471c114',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/fuji',
+        oldSubgraphUrl: '',
+        oldFactoryAddress: '',
+    },
+    [enums_1.ChainId.AVALANCHE]: {
+        chainId: enums_1.ChainId.AVALANCHE,
+        title: 'Avalanche C-Chain Mainnet',
+        scanUrl: 'https://snowtrace.io',
+        factoryAddress: '0x9767a578ba7a5FA1563c8229943cB01cd8446BB4',
+        hmtAddress: '0x12365293cb6477d4fc2686e46BB97E3Fb64f1550',
+        stakingAddress: '',
+        rewardPoolAddress: '',
+        kvstoreAddress: '0x4B79eaD28F52eD5686bf0e379717e85fc7aD10Df',
+        subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/avalanche',
+        oldSubgraphUrl: '',
+        oldFactoryAddress: '',
+    },
+    [enums_1.ChainId.SKALE]: {
+        chainId: enums_1.ChainId.SKALE,
+        title: 'SKALE Human Protocol Chain',
+        scanUrl: 'https://wan-red-ain.explorer.mainnet.skalenodes.com/',
+        factoryAddress: '0x319070b49C8d1cC015915D1E7Eb5fd8e22833885',
+        hmtAddress: '0x6E5FF61Ea88270F6142E0E0eC8cbe9d67476CbCd',
+        stakingAddress: '0x79F37FB9C210910733c16228AC4D14a8e32C11BD',
+        rewardPoolAddress: '0x881218246c25C6898aE96145259584340153aDA2',
+        kvstoreAddress: '0xE1055607327b1be2080D31211dCDC4D9338CaF4A',
+        subgraphUrl: 'https://graph-skale.humanprotocol.org/subgraphs/name/skale-human',
+        oldSubgraphUrl: '',
+        oldFactoryAddress: '0x27B423cE73d1dBdB48d2dd351398b5Ce8223117c',
+    },
+    [enums_1.ChainId.LOCALHOST]: {
+        chainId: enums_1.ChainId.LOCALHOST,
+        title: 'Localhost',
+        scanUrl: '',
+        factoryAddress: '0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9',
+        hmtAddress: '0x5FbDB2315678afecb367f032d93F642f64180aa3',
+        stakingAddress: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
+        rewardPoolAddress: '0xa513E6E4b8f2a923D98304ec87F64353C4D5C853',
+        kvstoreAddress: '0x5FC8d32690cc91D4c39d9d3abcBD16989F875707',
+        subgraphUrl: '',
+        oldSubgraphUrl: '',
+        oldFactoryAddress: '',
+    },
+};
+exports.KVStoreKeys = {
+    role: 'role',
+    webhook_url: 'webhook_url',
+    fee: 'fee',
+    public_key: 'public_key',
+};

package/dist/decorators.d.ts

@@ -0,0 +1,2 @@
+export declare function requiresSigner(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+//# sourceMappingURL=decorators.d.ts.map

package/dist/decorators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../src/decorators.ts"],"names":[],"mappings":"AAIA,wBAAgB,cAAc,CAC5B,MAAM,EAAE,GAAG,EACX,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,kBAAkB,sBAa/B"}

package/dist/decorators.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requiresSigner = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const ethers_1 = require("ethers");
+const error_1 = require("./error");
+function requiresSigner(target, propertyKey, descriptor) {
+    const originalMethod = descriptor.value;
+    descriptor.value = async function (...args) {
+        if (!ethers_1.Signer.isSigner(this.signerOrProvider)) {
+            throw error_1.ErrorSigner;
+        }
+        return originalMethod.apply(this, args);
+    };
+    return descriptor;
+}
+exports.requiresSigner = requiresSigner;

package/dist/encryption.d.ts

@@ -0,0 +1,84 @@
+import * as openpgp from 'openpgp';
+import { IKeyPair } from './interfaces';
+/**
+ * Class for encryption and decryption operations.
+ */
+export declare class Encryption {
+    private privateKey;
+    /**
+     * Constructor for the Encryption class.
+     *
+     * @param {PrivateKey} 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>;
+    /**
+     * Signs and encrypts a message using 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.
+     */
+    signAndEncrypt(message: string, publicKeys: string[]): Promise<string>;
+    /**
+     * Decrypts an encrypted message using the private key.
+     *
+     * @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.
+     */
+    decrypt(message: string, publicKey?: string): Promise<string>;
+    /**
+     * Signs a message using the private key.
+     *
+     * @param {string} message - The message to sign.
+     * @returns {Promise<string>} - The signed message.
+     */
+    sign(message: string): Promise<string>;
+}
+/**
+ * Utility class for encryption-related operations.
+ */
+export declare class EncryptionUtils {
+    /**
+     * Verifies the signature of a signed message using the public key.
+     *
+     * @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.
+     */
+    static verify(message: string, publicKey: string): Promise<boolean>;
+    /**
+     * Gets the signed data from a signed message.
+     *
+     * @param {string} message - The signed message.
+     * @returns {Promise<string>} - The signed data.
+     * @throws {Error} - An error object if an error occurred.
+     */
+    static getSignedData(message: string): Promise<string>;
+    /**
+     * Generates a key pair for encryption and decryption.
+     *
+     * @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.
+     */
+    static generateKeyPair(name: string, email: string, passphrase?: string): Promise<IKeyPair>;
+    /**
+     * Encrypts a message using 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.
+     */
+    static encrypt(message: string, publicKeys: string[]): Promise<string>;
+}
+//# sourceMappingURL=encryption.d.ts.map

package/dist/encryption.d.ts.map

@@ -0,0 +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"}

package/dist/encryption.js

@@ -0,0 +1,202 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EncryptionUtils = exports.Encryption = void 0;
+const openpgp = __importStar(require("openpgp"));
+/**
+ * Class for encryption and decryption operations.
+ */
+class Encryption {
+    /**
+     * Constructor for the Encryption class.
+     *
+     * @param {PrivateKey} privateKey - The private key.
+     */
+    constructor(privateKey) {
+        this.privateKey = 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 async build(privateKeyArmored, passphrase) {
+        const options = {
+            armoredKey: privateKeyArmored,
+        };
+        if (!passphrase) {
+            return new Encryption(await openpgp.readPrivateKey(options));
+        }
+        const privateKey = await openpgp.readPrivateKey(options);
+        return new Encryption(await openpgp.decryptKey({
+            privateKey,
+            passphrase,
+        }));
+    }
+    /**
+     * Signs and encrypts a message using 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.
+     */
+    async signAndEncrypt(message, publicKeys) {
+        const plaintext = message;
+        const pgpPublicKeys = await Promise.all(publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey })));
+        const pgpMessage = await openpgp.createMessage({ text: plaintext });
+        const encrypted = await openpgp.encrypt({
+            message: pgpMessage,
+            encryptionKeys: pgpPublicKeys,
+            signingKeys: this.privateKey,
+        });
+        return encrypted;
+    }
+    /**
+     * Decrypts an encrypted message using the private key.
+     *
+     * @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.
+     */
+    async decrypt(message, publicKey) {
+        const pgpMessage = await openpgp.readMessage({ armoredMessage: message });
+        const decryptionOptions = {
+            message: pgpMessage,
+            decryptionKeys: this.privateKey,
+            expectSigned: !!publicKey,
+        };
+        if (publicKey) {
+            const pgpPublicKey = await openpgp.readKey({ armoredKey: publicKey });
+            decryptionOptions.verificationKeys = pgpPublicKey;
+        }
+        const { data: decrypted } = await openpgp.decrypt(decryptionOptions);
+        return decrypted;
+    }
+    /**
+     * Signs a message using the private key.
+     *
+     * @param {string} message - The message to sign.
+     * @returns {Promise<string>} - The signed message.
+     */
+    async sign(message) {
+        const unsignedMessage = await openpgp.createCleartextMessage({
+            text: message,
+        });
+        const cleartextMessage = await openpgp.sign({
+            message: unsignedMessage,
+            signingKeys: this.privateKey,
+            format: 'armored',
+        });
+        return cleartextMessage;
+    }
+}
+exports.Encryption = Encryption;
+/**
+ * Utility class for encryption-related operations.
+ */
+class EncryptionUtils {
+    /**
+     * Verifies the signature of a signed message using the public key.
+     *
+     * @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.
+     */
+    static async verify(message, publicKey) {
+        const pgpPublicKey = await openpgp.readKey({ armoredKey: publicKey });
+        const signedMessage = await openpgp.readCleartextMessage({
+            cleartextMessage: message,
+        });
+        const verificationResult = await signedMessage.verify([pgpPublicKey]);
+        const { verified } = verificationResult[0];
+        try {
+            return await verified;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Gets the signed data from a signed message.
+     *
+     * @param {string} message - The signed message.
+     * @returns {Promise<string>} - The signed data.
+     * @throws {Error} - An error object if an error occurred.
+     */
+    static async getSignedData(message) {
+        const signedMessage = await openpgp.readCleartextMessage({
+            cleartextMessage: message,
+        });
+        try {
+            return signedMessage.getText();
+        }
+        catch (e) {
+            throw new Error('Could not get data: ' + e.message);
+        }
+    }
+    /**
+     * Generates a key pair for encryption and decryption.
+     *
+     * @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.
+     */
+    static async generateKeyPair(name, email, passphrase = '') {
+        const { privateKey, publicKey, revocationCertificate } = await openpgp.generateKey({
+            type: 'ecc',
+            curve: 'ed25519',
+            userIDs: [{ name: name, email: email }],
+            passphrase: passphrase,
+            format: 'armored',
+        });
+        return {
+            passphrase: passphrase,
+            privateKey,
+            publicKey,
+            revocationCertificate,
+        };
+    }
+    /**
+     * Encrypts a message using 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.
+     */
+    static async encrypt(message, publicKeys) {
+        const plaintext = message;
+        const pgpPublicKeys = await Promise.all(publicKeys.map((armoredKey) => openpgp.readKey({ armoredKey })));
+        const pgpMessage = await openpgp.createMessage({ text: plaintext });
+        const encrypted = await openpgp.encrypt({
+            message: pgpMessage,
+            encryptionKeys: pgpPublicKeys,
+        });
+        return encrypted;
+    }
+}
+exports.EncryptionUtils = EncryptionUtils;