feat: add lit protocol provider and capacity credits delegation

.circleci/config.yml

@@ -311,6 +311,36 @@ jobs:
           command: 'yarn workspace @requestnetwork/epk-signature run test --ci --maxWorkers=1'
       - store_test_results:
           path: packages/epk-signature/reports/
+  test-epk-cipher:
+    docker:
+      - *node_image
+    working_directory: *working_directory
+    steps:
+      - attach_workspace:
+          at: *working_directory
+      - run:
+          name: 'Build epk-cipher'
+          command: 'yarn workspace @requestnetwork/epk-cipher run build'
+      - run:
+          name: 'Test epk-cipher'
+          command: 'yarn workspace @requestnetwork/epk-cipher run test --ci --maxWorkers=1'
+      - store_test_results:
+          path: packages/epk-cipher/reports/
+  test-lit-protocol-cipher:
+    docker:
+      - *node_image
+    working_directory: *working_directory
+    steps:
+      - attach_workspace:
+          at: *working_directory
+      - run:
+          name: 'Build lit-protocol-cipher'
+          command: 'yarn workspace @requestnetwork/lit-protocol-cipher run build'
+      - run:
+          name: 'Test lit-protocol-cipher'
+          command: 'yarn workspace @requestnetwork/lit-protocol-cipher run test --ci --maxWorkers=1'
+      - store_test_results:
+          path: packages/lit-protocol-cipher/reports/
   test-epk-decryption:
     docker:
       - *node_image
@@ -558,6 +588,12 @@ workflows:
       - test-currency:
           requires:
             - build
+      - test-epk-cipher:
+          requires:
+            - build
+      - test-lit-protocol-cipher:
+          requires:
+            - build
       - test-epk-signature:
           requires:
             - build
@@ -591,6 +627,8 @@ workflows:
             - test-currency
             - test-data-access
             - test-data-format
+            - test-epk-cipher
+            - test-lit-protocol-cipher
             - test-epk-decryption
             - test-epk-signature
             - test-ethereum-storage

README.md

@@ -23,9 +23,11 @@ Join the [Request Discord][request-discord-url] to get in touch with us.
 | [`@requestnetwork/request-client.js`](/packages/request-client.js)       | [![npm](https://img.shields.io/npm/v/@requestnetwork/request-client.js.svg)](https://www.npmjs.com/package/@requestnetwork/request-client.js)       | Library to use Request nodes as servers                             |
 | [`@requestnetwork/data-access`](/packages/data-access)                   | [![npm](https://img.shields.io/npm/v/@requestnetwork/data-access.svg)](https://www.npmjs.com/package/@requestnetwork/data-access)                   | Indexing an batching of transactions                                |
 | [`@requestnetwork/data-format`](/packages/data-format)                   | [![npm](https://img.shields.io/npm/v/@requestnetwork/data-format.svg)](https://www.npmjs.com/package/@requestnetwork/data-format)                   | Standards for data stored on Request, like invoices format          |
+| [`@requestnetwork/epk-cipher`](/packages/epk-cipher)                     | [![npm](https://img.shields.io/npm/v/@requestnetwork/epk-cipher.svg)](https://www.npmjs.com/package/@requestnetwork/epk-cipher)                     | Encrypt /Decrypt requests using Ethereum private keys               |
 | [`@requestnetwork/epk-signature`](/packages/epk-signature)               | [![npm](https://img.shields.io/npm/v/@requestnetwork/epk-signature.svg)](https://www.npmjs.com/package/@requestnetwork/epk-signature)               | Sign requests using Ethereum private keys                           |
 | [`@requestnetwork/ethereum-storage`](/packages/ethereum-storage)         | [![npm](https://img.shields.io/npm/v/@requestnetwork/ethereum-storage.svg)](https://www.npmjs.com/package/@requestnetwork/ethereum-storage)         | Storage of Request data on Ethereum and IPFS, with custom indexing  |
 | [`@requestnetwork/epk-decryption`](/packages/epk-decryption)             | [![npm](https://img.shields.io/npm/v/@requestnetwork/epk-decryption.svg)](https://www.npmjs.com/package/@requestnetwork/epk-decryption)             | Decrypt encrypted requests using Ethereum private keys              |
+| [`@requestnetwork/lit-protocol-cipher`](/packages/lit-protocol-cipher)   | [![npm](https://img.shields.io/npm/v/@requestnetwork/lit-protocol-cipher.svg)](https://www.npmjs.com/package/@requestnetwork/lit-protocol-cipher)   | Encrypt / Decrypt requests using Lit Protocol                       |
 | [`@requestnetwork/payment-detection`](/packages/payment-detection)       | [![npm](https://img.shields.io/npm/v/@requestnetwork/payment-detection.svg)](https://www.npmjs.com/package/@requestnetwork/payment-detection)       | Client-side payment detection, to compute the balance.              |
 | [`@requestnetwork/payment-processor`](/packages/payment-processor)       | [![npm](https://img.shields.io/npm/v/@requestnetwork/payment-processor.svg)](https://www.npmjs.com/package/@requestnetwork/payment-processor)       | Pay a request using a web3 wallet                                   |
 | [`@requestnetwork/request-logic`](/packages/request-logic)               | [![npm](https://img.shields.io/npm/v/@requestnetwork/request-logic.svg)](https://www.npmjs.com/package/@requestnetwork/request-logic)               | The Request business logic: properties and actions of requests      |

packages/epk-cipher/.nycrc

@@ -0,0 +1,8 @@
+{
+  "extension": [".ts"],
+  "include": ["src/*.ts", "src/**/*.ts"],
+  "require": ["ts-node/register"],
+  "reporter": ["text-summary", "json", "html"],
+  "sourceMap": true,
+  "all": true
+}

packages/epk-cipher/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "mochaExplorer.files": "**/test/**/*.ts",
+  "mochaExplorer.require": "ts-node/register",
+  "mochaExplorer.cwd": "../.."
+}

packages/epk-cipher/README.md

@@ -0,0 +1,63 @@
+# @requestnetwork/epk-cipher
+
+Ethereum Private Key Cipher Provider.
+
+`@requestnetwork/epk-cipher` is a typescript library part of the [Request Network protocol](https://github.com/RequestNetwork/requestNetwork).
+
+Implementation of the cipher provider from the private keys.
+The cipher provider is used to make encryption and decryption in the Request Network Protocol (e.g.: see [Transaction Manager](/packages/transaction-manager)).
+
+It uses the Request Network Protocol concept of `Identity` described in the [request logic specification](/packages/request-logic/specs/request-logic-specification.md).
+
+## Installation
+
+```bash
+npm install @requestnetwork/epk-cipher
+```
+
+## Usage
+
+```javascript
+import { EncryptionTypes, IdentityTypes } from '@requestnetwork/types'
+
+import EthereumPrivateKeyCipherProvider from '@requestnetwork/epk-cipher'
+
+const cipherParametersExample: EncryptionTypes.ICipherParameters = {
+  key: '0xc87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3',
+  method: EncryptionTypes.METHOD.ECIES,
+};
+
+// Identity from the previous signature parameter
+const identityExample: IdentityTypes.IIdentity = {
+  type: IdentityTypes.TYPE.ETHEREUM_ADDRESS,
+  value: '0x627306090abab3a6e1400e9345bc60c78a8bef57'
+};
+
+// Construct the provider with a
+const cipherProvider = new EthereumPrivateKeyCipherProvider(cipherParametersExample);
+
+// can list the identity usable
+const listOfAvailableIdentity = cipherProvider.getAllRegisteredIdentities(); // [identityExample]
+
+// can decrypt data with identity
+const dataToDecrypt = "02....";
+const decryptedData = await cipherProvider.decrypt(dataToDecrypt, identityExample); // "Decrypted data..."
+
+// can add a new decryption parameters
+cipherProvider.addDecryptionParameters({method: EncryptionTypes.METHOD.ECIES, key: ...});
+
+// can remove a cipher parameters from its identity
+cipherProvider.removeRegisteredIdentity({type: IdentityTypes.TYPE.ETHEREUM_ADDRESS, value: ...});
+
+// can remove all cipher parameters
+cipherProvider.clearAllRegisteredIdentities();
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+[Read the contributing guide](/CONTRIBUTING.md)
+
+## License
+
+[MIT](/LICENSE)

packages/epk-cipher/jest.config.js

@@ -0,0 +1,6 @@
+const jestCommonConfig = require('../../jest.config');
+
+/** @type {import('jest').Config} */
+module.exports = {
+  ...jestCommonConfig,
+};

packages/epk-cipher/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@requestnetwork/epk-cipher",
+  "version": "0.1.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Cipher provider using ethereum private keys.",
+  "keywords": [
+    "requestnetwork",
+    "cipher-provider"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/RequestNetwork/requestNetwork.git"
+  },
+  "homepage": "https://github.com/RequestNetwork/requestNetwork/tree/master/packages/epk-cipher#readme",
+  "bugs": {
+    "url": "https://github.com/RequestNetwork/requestNetwork/issues"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "directories": {
+    "lib": "src",
+    "test": "test"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "run-s build:commonjs build:umd",
+    "build:commonjs": "tsc -b tsconfig.build.json",
+    "build:umd": "webpack",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "test": "jest",
+    "test:watch": "yarn test --watch"
+  },
+  "dependencies": {
+    "@requestnetwork/multi-format": "0.19.1",
+    "@requestnetwork/types": "0.45.1",
+    "@requestnetwork/utils": "0.45.1",
+    "tslib": "2.5.0"
+  },
+  "devDependencies": {
+    "@types/jest": "29.5.6",
+    "amd-loader": "0.0.8",
+    "crypto-browserify": "3.12.0",
+    "duplicate-package-checker-webpack-plugin": "3.0.0",
+    "jest": "29.5.0",
+    "jest-junit": "16.0.0",
+    "npm-run-all": "4.1.5",
+    "source-map-support": "0.5.19",
+    "stream-browserify": "3.0.0",
+    "terser-webpack-plugin": "4.2.3",
+    "ts-jest": "29.1.0",
+    "ts-loader": "8.4.0",
+    "ts-node": "10.9.1",
+    "typescript": "5.1.3",
+    "webpack": "5.94.0",
+    "webpack-bundle-analyzer": "4.2.0",
+    "webpack-cli": "3.3.12"
+  }
+}