@human-protocol/sdk 1.1.3 → 1.1.6

package/dist/types.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Enum for escrow statuses.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum EscrowStatus {
+    /**
+     * Escrow is launched.
+     */
+    Launched = 0,
+    /**
+     * Escrow is funded, and waiting for the results to be submitted.
+     */
+    Pending = 1,
+    /**
+     * Escrow is partially paid out.
+     */
+    Partial = 2,
+    /**
+     * Escrow is fully paid.
+     */
+    Paid = 3,
+    /**
+     * Escrow is finished..
+     */
+    Complete = 4,
+    /**
+     * Escrow is cancelled.
+     */
+    Cancelled = 5
+}
+/**
+ * AWS/GCP cloud storage access data
+ * @readonly
+ */
+export type StorageCredentials = {
+    /**
+     * Access Key
+     */
+    accessKey: string;
+    /**
+     * Secret Key
+     */
+    secretKey: string;
+};
+export type StorageParams = {
+    /**
+     * Request endPoint
+     */
+    endPoint: string;
+    /**
+     * Enable secure (HTTPS) access. Default value set to false
+     */
+    useSSL: boolean;
+    /**
+     * Region
+     */
+    region?: string;
+    /**
+     * TCP/IP port number. Default value set to 80 for HTTP and 443 for HTTPs
+     */
+    port?: number;
+};
+/**
+ * Upload file data
+ * @readonly
+ */
+export type UploadFile = {
+    /**
+     * Uploaded object key
+     */
+    key: string;
+    /**
+     * Uploaded object URL
+     */
+    url: string;
+    /**
+     * Hash of uploaded object key
+     */
+    hash: string;
+};
+/**
+ * Network data
+ */
+export type NetworkData = {
+    /**
+     * Network chain id
+     */
+    chainId: number;
+    /**
+     * Network title
+     */
+    title: string;
+    /**
+     * Network scanner URL
+     */
+    scanUrl: string;
+    /**
+     * HMT Token contract address
+     */
+    hmtAddress: string;
+    /**
+     * Escrow Factory contract address
+     */
+    factoryAddress: string;
+    /**
+     * Staking contract address
+     */
+    stakingAddress: string;
+    /**
+     * RewardPool contract address
+     */
+    rewardPoolAddress: string;
+    /**
+     * KVStore contract address
+     */
+    kvstoreAddress: string;
+    /**
+     * Subgraph URL
+     */
+    subgraphUrl: string;
+    /**
+     * Old subgraph URL
+     */
+    oldSubgraphUrl: string;
+    /**
+     * Old Escrow Factory contract address
+     */
+    oldFactoryAddress: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,YAAY;IACtB;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,IAAI,IAAA;IACJ;;OAEG;IACH,QAAQ,IAAA;IACR;;OAEG;IACH,SAAS,IAAA;CACV;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC"}

package/dist/types.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EscrowStatus = void 0;
+/**
+ * Enum for escrow statuses.
+ * @readonly
+ * @enum {number}
+ */
+var EscrowStatus;
+(function (EscrowStatus) {
+    /**
+     * Escrow is launched.
+     */
+    EscrowStatus[EscrowStatus["Launched"] = 0] = "Launched";
+    /**
+     * Escrow is funded, and waiting for the results to be submitted.
+     */
+    EscrowStatus[EscrowStatus["Pending"] = 1] = "Pending";
+    /**
+     * Escrow is partially paid out.
+     */
+    EscrowStatus[EscrowStatus["Partial"] = 2] = "Partial";
+    /**
+     * Escrow is fully paid.
+     */
+    EscrowStatus[EscrowStatus["Paid"] = 3] = "Paid";
+    /**
+     * Escrow is finished..
+     */
+    EscrowStatus[EscrowStatus["Complete"] = 4] = "Complete";
+    /**
+     * Escrow is cancelled.
+     */
+    EscrowStatus[EscrowStatus["Cancelled"] = 5] = "Cancelled";
+})(EscrowStatus = exports.EscrowStatus || (exports.EscrowStatus = {}));

package/dist/utils.d.ts

@@ -0,0 +1,32 @@
+/**
+ * **Get specific error text.*
+ *
+ * @param {any} error - An error message.
+ * @returns
+ */
+export declare const getRevertReason: (error: any) => string;
+/**
+ * **Handle and throw the error.*
+ *
+ * @param {any} e
+ * @returns
+ */
+export declare const throwError: (e: any) => never;
+/**
+ * **URL validation.*
+ *
+ * @param {string} url
+ * @returns
+ */
+export declare const isValidUrl: (url: string) => boolean;
+/**
+ * **Fetching data with queries.*
+ *
+ * @param {string} url
+ * @param {string} query
+ * @param {any} variables
+ * @param {any} headers
+ * @returns
+ */
+export declare const gqlFetch: (url: string, query: string, variables?: any, headers?: any) => Promise<import("axios").AxiosResponse<any, any>>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAiBA;;;;;GAKG;AACH,eAAO,MAAM,eAAe,UAAW,GAAG,KAAG,MAO5C,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,MAAO,GAAG,UAqBhC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAS,MAAM,YAOrC,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,QACd,MAAM,SACJ,MAAM,cACD,GAAG,YACL,GAAG,qDAYd,CAAC"}

package/dist/utils.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gqlFetch = exports.isValidUrl = exports.throwError = exports.getRevertReason = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const axios_1 = __importDefault(require("axios"));
+const ethers_1 = require("ethers");
+const error_1 = require("./error");
+/**
+ * **Get specific error text.*
+ *
+ * @param {any} error - An error message.
+ * @returns
+ */
+const getRevertReason = (error) => {
+    const prefix = "reverted with reason string '";
+    const suffix = "'";
+    const message = error.data.substring(error.data.indexOf(prefix) + prefix.length);
+    return message.substring(0, message.indexOf(suffix));
+};
+exports.getRevertReason = getRevertReason;
+/**
+ * **Handle and throw the error.*
+ *
+ * @param {any} e
+ * @returns
+ */
+const throwError = (e) => {
+    if (e.code === ethers_1.ethers.utils.Logger.errors.INVALID_ARGUMENT) {
+        throw new error_1.InvalidArgumentError(e.message);
+    }
+    else if (e.code === 'OUT_OF_GAS') {
+        throw new error_1.OutOfGasError(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.CALL_EXCEPTION) {
+        const reason = (0, exports.getRevertReason)(e.data);
+        throw new error_1.ContractExecutionError(reason);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.UNPREDICTABLE_GAS_LIMIT) {
+        throw new error_1.UnpredictableGasLimit(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.TRANSACTION_REPLACED) {
+        throw new error_1.TransactionReplaced(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.REPLACEMENT_UNDERPRICED) {
+        throw new error_1.ReplacementUnderpriced(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.NUMERIC_FAULT) {
+        throw new error_1.NumericFault(e.message);
+    }
+    else if (e.code === ethers_1.ethers.utils.Logger.errors.NONCE_EXPIRED) {
+        throw new error_1.NonceExpired(e.message);
+    }
+    else {
+        throw new error_1.EthereumError(e.message);
+    }
+};
+exports.throwError = throwError;
+/**
+ * **URL validation.*
+ *
+ * @param {string} url
+ * @returns
+ */
+const isValidUrl = (url) => {
+    try {
+        new URL(url);
+        return true;
+    }
+    catch (err) {
+        return false;
+    }
+};
+exports.isValidUrl = isValidUrl;
+/**
+ * **Fetching data with queries.*
+ *
+ * @param {string} url
+ * @param {string} query
+ * @param {any} variables
+ * @param {any} headers
+ * @returns
+ */
+const gqlFetch = (url, query, variables, headers) => {
+    if (url && url.length) {
+        return axios_1.default.post(url, JSON.stringify({ query, variables }), {
+            headers: {
+                'Content-Type': 'application/json',
+                ...headers,
+            },
+        });
+    }
+    else {
+        return Promise.reject(error_1.ErrorNoURLprovided);
+    }
+};
+exports.gqlFetch = gqlFetch;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@human-protocol/sdk",
   "description": "Human Protocol SDK",
-  "version": "1.1.3",
+  "version": "1.1.6",
   "files": [
     "src",
     "dist"
@@ -10,6 +10,7 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "clean": "rm -rf ./dist",
+    "prebuild": "yarn workspace @human-protocol/core build",
     "build": "npm run clean && tsc",
     "prepublish": "npm run build",
     "test": "vitest -u",
@@ -38,8 +39,10 @@
   "dependencies": {
     "@human-protocol/core": "*",
     "aws-sdk": "^2.1255.0",
+    "axios": "^1.4.0",
     "crypto": "^1.0.1",
     "ethers": "^5.7.2",
+    "minio": "^7.0.32",
     "secp256k1": "^4.0.3",
     "vitest": "^0.30.1",
     "winston": "^3.8.2"

package/src/constants.ts

@@ -58,6 +58,7 @@ export const NETWORKS: {
     factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
     hmtAddress: '0xd1ba9BAC957322D6e8c07a160a3A8dA11A0d2867',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
+    rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mainnet-v1',
@@ -71,6 +72,7 @@ export const NETWORKS: {
     factoryAddress: '0x925B24444511c86F4d4E63141D8Be0A025E2dca4',
     hmtAddress: '0x4dCf5ac4509888714dd43A5cCc46d7ab389D9c23',
     stakingAddress: '',
+    rewardPoolAddress: '',
     kvstoreAddress: '',
     subgraphUrl: '',
     oldSubgraphUrl: '',
@@ -83,6 +85,7 @@ export const NETWORKS: {
     factoryAddress: '0x87469B4f2Fcf37cBd34E54244c0BD4Fa0603664c',
     hmtAddress: '0xd3A31D57FDD790725d0F6B78095F62E8CD4ab317',
     stakingAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
+    rewardPoolAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
     kvstoreAddress: '0xc9Fe39c4b6e1d7A2991355Af159956982DADf842',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/goerli-v1',
@@ -94,11 +97,11 @@ export const NETWORKS: {
     chainId: ChainId.BSC_MAINNET,
     title: 'Binance Smart Chain',
     scanUrl: 'https://bscscan.com',
-    factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
-    hmtAddress: '0x0d501B743F22b641B8C8dfe00F1AAb881D57DDC7',
-    stakingAddress: '0xC2163A0928034e020f0d31e1171Ba0D6d9AfFB6c',
-    kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
-
+    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',
@@ -110,6 +113,7 @@ export const NETWORKS: {
     factoryAddress: '0x2bfA592DBDaF434DDcbb893B1916120d181DAD18',
     hmtAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
     stakingAddress: '0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18',
+    rewardPoolAddress: '0xB0A0500103eCEc431b73F6BAd923F0a2774E6e29',
     kvstoreAddress: '0x3aD4B091E054f192a822D1406f4535eAd38580e4',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/bsctest-v1',
@@ -124,6 +128,7 @@ export const NETWORKS: {
     factoryAddress: '0xBDBfD2cC708199C5640C6ECdf3B0F4A4C67AdfcB',
     hmtAddress: '0xc748B2A084F8eFc47E086ccdDD9b7e67aEb571BF',
     stakingAddress: '0xcbAd56bE3f504E98bd70875823d3CC0242B7bB29',
+    rewardPoolAddress: '0xa8e32d777a3839440cc7c24D591A64B9481753B3',
     kvstoreAddress: '0x35Cf4beBD58F9C8D75B9eA2599479b6C173d406F',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/polygon-v1',
@@ -138,6 +143,7 @@ export const NETWORKS: {
     factoryAddress: '0xA8D927C4DA17A6b71675d2D49dFda4E9eBE58f2d',
     hmtAddress: '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4',
     stakingAddress: '0x7Fd3dF914E7b6Bd96B4c744Df32183b51368Bfac',
+    rewardPoolAddress: '0xf0145eD99AC3c4f877aDa7dA4D1E059ec9116BAE',
     kvstoreAddress: '0xD7F61E812e139a5a02eDae9Dfec146E1b8eA3807',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/mumbai-v1',
@@ -152,6 +158,7 @@ export const NETWORKS: {
     factoryAddress: '0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a',
     hmtAddress: '0x3b25BC1dC591D24d60560d0135D6750A561D4764',
     stakingAddress: '0x05398211bA2046E296fBc9a9D3EB49e3F15C3123',
+    rewardPoolAddress: '0x4A5963Dd6792692e9147EdC7659936b96251917a',
     kvstoreAddress: '0x70671167176C4934204B1C7e97F5e86695857ef2',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbeam-v1',
@@ -166,6 +173,7 @@ export const NETWORKS: {
     factoryAddress: '0x5e622FF522D81aa426f082bDD95210BC25fCA7Ed',
     hmtAddress: '0x2dd72db2bBA65cE663e476bA8b84A1aAF802A8e3',
     stakingAddress: '0xBFC7009F3371F93F3B54DdC8caCd02914a37495c',
+    rewardPoolAddress: '0xf46B45Df3d956369726d8Bd93Ba33963Ab692920',
     kvstoreAddress: '0xE3D74BBFa45B4bCa69FF28891fBE392f4B4d4e4d',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/moonbase-alpha-v1',
@@ -179,6 +187,7 @@ export const NETWORKS: {
     factoryAddress: '0xfb4469201951C3B9a7F1996c477cb7BDBEcE0A88',
     hmtAddress: '0x9406d5c635AD22b0d76c75E52De57A2177919ca3',
     stakingAddress: '',
+    rewardPoolAddress: '',
     kvstoreAddress: '0xd232c1426CF0653cE8a71DC98bCfDf10c471c114',
 
     subgraphUrl: 'https://api.thegraph.com/subgraphs/name/humanprotocol/fuji',
@@ -192,6 +201,7 @@ export const NETWORKS: {
     factoryAddress: '0x9767a578ba7a5FA1563c8229943cB01cd8446BB4',
     hmtAddress: '0x12365293cb6477d4fc2686e46BB97E3Fb64f1550',
     stakingAddress: '',
+    rewardPoolAddress: '',
     kvstoreAddress: '0x4B79eaD28F52eD5686bf0e379717e85fc7aD10Df',
     subgraphUrl:
       'https://api.thegraph.com/subgraphs/name/humanprotocol/avalanche',
@@ -205,6 +215,7 @@ export const NETWORKS: {
     factoryAddress: '0x319070b49C8d1cC015915D1E7Eb5fd8e22833885',
     hmtAddress: '0x6E5FF61Ea88270F6142E0E0eC8cbe9d67476CbCd',
     stakingAddress: '0x79F37FB9C210910733c16228AC4D14a8e32C11BD',
+    rewardPoolAddress: '0x881218246c25C6898aE96145259584340153aDA2',
     kvstoreAddress: '0xE1055607327b1be2080D31211dCDC4D9338CaF4A',
     subgraphUrl:
       'https://graph-skale.humanprotocol.org/subgraphs/name/skale-human',
@@ -217,10 +228,18 @@ export const NETWORKS: {
     scanUrl: '',
     factoryAddress: '0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9',
     hmtAddress: '0x5FbDB2315678afecb367f032d93F642f64180aa3',
-    stakingAddress: '0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512',
+    stakingAddress: '0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0',
+    rewardPoolAddress: '0xa513E6E4b8f2a923D98304ec87F64353C4D5C853',
     kvstoreAddress: '0x5FC8d32690cc91D4c39d9d3abcBD16989F875707',
     subgraphUrl: '',
     oldSubgraphUrl: '',
     oldFactoryAddress: '',
   },
 };
+
+export const KVStoreKeys = {
+  role: 'role',
+  webhook_url: 'webhook_url',
+  fee: 'fee',
+  public_key: 'public_key',
+};

package/src/encryption.ts

@@ -0,0 +1,223 @@
+import * as openpgp from 'openpgp';
+import { IKeyPair } from './interfaces';
+/**
+ * Class for encryption and decryption operations.
+ */
+export class Encryption {
+  private privateKey: openpgp.PrivateKey;
+
+  /**
+   * Constructor for the Encryption class.
+   *
+   * @param {PrivateKey} privateKey - The private key.
+   */
+  constructor(privateKey: openpgp.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.
+   */
+  public static async build(
+    privateKeyArmored: string,
+    passphrase?: string
+  ): Promise<Encryption> {
+    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.
+   */
+  public async signAndEncrypt(
+    message: string,
+    publicKeys: string[]
+  ): Promise<string> {
+    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 as 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.
+   */
+  public async decrypt(message: string, publicKey?: string): Promise<string> {
+    const pgpMessage = await openpgp.readMessage({ armoredMessage: message });
+
+    const decryptionOptions: openpgp.DecryptOptions = {
+      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 as string;
+  }
+
+  /**
+   * Signs a message using the private key.
+   *
+   * @param {string} message - The message to sign.
+   * @returns {Promise<string>} - The signed message.
+   */
+  public async sign(message: string): Promise<string> {
+    const unsignedMessage = await openpgp.createCleartextMessage({
+      text: message,
+    });
+    const cleartextMessage = await openpgp.sign({
+      message: unsignedMessage,
+      signingKeys: this.privateKey,
+      format: 'armored',
+    });
+
+    return cleartextMessage;
+  }
+}
+
+/**
+ * Utility class for encryption-related operations.
+ */
+export 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.
+   */
+  public static async verify(
+    message: string,
+    publicKey: string
+  ): Promise<boolean> {
+    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.
+   */
+  public static async getSignedData(message: string): Promise<string> {
+    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.
+   */
+  public static async generateKeyPair(
+    name: string,
+    email: string,
+    passphrase = ''
+  ): Promise<IKeyPair> {
+    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.
+   */
+  public static async encrypt(
+    message: string,
+    publicKeys: string[]
+  ): Promise<string> {
+    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 as string;
+  }
+}

package/src/error.ts

@@ -141,14 +141,12 @@ export const ErrorHMTokenAmountNotApproved = new Error('Amount not approved');
 /**
  * @constant {Error} - Init provider does not exists.
  */
-export const ErrorInitProviderDoesNotExist = new Error(
-  'Provider does not exist'
-);
+export const ErrorProviderDoesNotExist = new Error('Provider does not exist');
 
 /**
  * @constant {Error} - Init with unsupported chain ID.
  */
-export const ErrorInitUnsupportedChainID = new Error('Unsupported chain ID');
+export const ErrorUnsupportedChainID = new Error('Unsupported chain ID');
 
 /**
  * @constant {Error} - Sending a transaction requires a signer.