feat(ccmodel-hepheastus): add Hepheastus plugin

packages/cactus-plugin-ccmodel-hephaestus/.gitignore

@@ -0,0 +1,4 @@
+cactus-openapi-spec-plugin-consortium-manual.json
+src/main/typescript/generated/openapi/typescript-axios/.npmignore
+src/test/csv
+src/test/json

packages/cactus-plugin-ccmodel-hephaestus/README.md

@@ -0,0 +1,124 @@
+# `@hyperledger/cactus-plugin-ccmodel-hephaestus`
+
+The package provides `Hyperledger Cacti` a way to generate process models from arbitrary cross-chain use cases. The implementation follows the paper [Hephaestus](https://www.techrxiv.org/doi/full/10.36227/techrxiv.20718058.v3).
+
+With this plugin it will be possible to generate cross-chain models from local transactions in different ledgers (currently supports Besu, Ethereum, and Fabric), realizing arbitrary cross-chain use cases and allowing operators to monitor their applications.
+Through monitoring, errors like outliers and malicious behavior can be identified, which can enable programmatically stopping attacks (circuit breaker), including bridge hacks.
+
+## Summary
+
+- [`@hyperledger/cactus-plugin-ccmodel-hephaestus`](#hyperledgercactus-plugin-ccmodel-hephaestus)
+  - [Summary](#summary)
+  - [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+  - [Architecture](#architecture)
+    - [RxJS Transaction Monitoring](#rxjs-transaction-monitoring)
+    - [Cross-Chain Model Pipeline](#cross-chain-model-pipeline)
+    - [PM4Py Overview](#pm4py-overview)
+  - [Running the tests](#running-the-tests)
+  - [Usage](#usage)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+
+## Getting Started
+
+Clone the git repository on your local machine. Follow these instructions that will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+### Prerequisites
+
+In the root of the project to install the dependencies execute the command:
+```sh
+npm run configure
+```
+
+Know how to use the following plugins of the project:
+
+  - [cactus-plugin-ledger-connector-besu](https://github.com/hyperledger/cactus/tree/main/packages/cactus-plugin-ledger-connector-besu)
+  - [cactus-plugin-ledger-connector-ethereum](https://github.com/hyperledger/cactus/tree/main/packages/cactus-plugin-ledger-connector-ethereum)
+  - [cactus-plugin-ledger-connector-fabric](https://github.com/hyperledger/cactus/tree/main/packages/cactus-plugin-ledger-connector-fabric)
+
+
+## Architecture
+
+### RxJS Transaction Monitoring
+
+This plugin utilizes RxJS (Reactive Extensions for JavaScript) to monitor transactions issued in Hyperledger Besu, Hyperledger Ethereum, and Hyperledger Fabric connectors.
+
+RxJS provides a powerful framework for asynchronous or callback-based code, each connector maintains an RxJS `ReplaySubject`, named `txSubject`, which acts as a message bus for emitting transaction data.
+
+- When a transaction is issued in a connector, the `ReplaySubject` stores the value it observes in an internal buffer. This observation is achieved by passing the value to its `next` method.
+- When a new subscriber subscribes to the `txSubject`, it synchronously emits all values in its buffer in a First-In-First-Out (FIFO) manner. This ensures that subscribers receive the most recent transactional data, regardless of when they subscribe.
+- The transactional data emitted includes essential information such as the transaction ID, timestamp, and other parameters, which are necessary for creating transaction receipts within the plugin.
+
+### Cross-Chain Model Pipeline
+
+The plugin employs a structured pipeline to create a cross-chain model from monitored connector transactions:
+
+1. **Transaction Emission**: Connectors issue local transactions against their respective target blockchains. Each transaction's data is emitted by the `txSubject` to the subscribers within our plugin.
+
+2. **Receipt Polling**: Upon receiving of transactional data, the plugin processes it into transaction receipts. This step involves precessing transactional information received such as transaction IDs, timestamps, and other parameters.
+
+3. **Cross-Chain Event Logging**: Processed receipts information can then be used to create cross-chain events, forming a cross-chain event log.
+
+4. **Cross-Chain Model**: The plugin uses the cross chain event log to create the cross-chain model with the information received from the connectors, using the Process Mining for Python (PM4PY) library. This model can then be used to verify new and unmodeled transactional information received from the connectors.
+
+### PM4Py Overview
+
+[PM4Py](https://pm4py.fit.fraunhofer.de/) is an open-source library designed for process mining, that provides tools to analyze and visualize business processes.
+With it we can generate process models from the event logs created from transactional data and compare event logs with process models to identify deviations.
+
+## Running the tests
+  - **monitor-4-besu-events.test.ts**: Tests the plugin's ability to monitor, capture, and process the transactional data from besu connectors, and exports transactional data, in both CSV and JSON formats, as cross-chain event logs.
+  - **monitor-4-ethereum-events.test.ts**: Tests the plugin's ability to monitor, capture, and process the transactional data from ethereum connectors, and exports transactional data, in both CSV and JSON formats, as cross-chain event logs.
+  - **monitor-4-fabric-events.test.ts**: Tests the plugin's ability to monitor, capture, and process the transactional data from fabric connectors, and exports transactional data, in both CSV and JSON formats, as cross-chain event logs.
+  - **cross-chain-model-serialization.test.ts**: Tests the plugin's ability to create the cross-chain model using the PM4PY (Process Mining for Python) library and save it serialized.
+  - **cross-chain-model-conformance-checking.test.ts**: Tests the plugin's ability to check the conformity of unmodeled transactions against the cross-chain model using the PM4PY (Process Mining for Python) library.
+  - **besu-ethereum-asset-transfer.test.ts**: Tests the plugin's ability to detect non-conformance in asset transactions across two ledgers. 
+  - **ethereum-fabric-asset-transfer.test.ts**: Tests the plugin's ability to detect non-conformance in asset transactions across two ledgers.
+  - **fabric-besu-asset-transfer.test.ts**: Tests the plugin's ability to detect non-conformance in asset transactions across two ledgers.
+
+## Usage
+Let us consider two conectors: one connected to Hyperledger Besu and, and another connected to Hyperledger Ethereum. To monitor cross-chain transactions and create a cross-chain model we should follow the next steps.
+
+After instantiating the connectors, we instantiate the plugin as follows:
+```typescript
+let hephaestusOptions: IPluginCcModelHephaestusOptions;
+
+hephaestusOptions = {
+  instanceId: randomUUID(),
+  logLevel: logLevel,
+  besuTxObservable: besuConnector.getTxSubjectObservable(),
+  ethereumTxObservable: ethereumConnector.getTxSubjectObservable(),
+  sourceLedger: LedgerType.Besu2X,
+  targetLedger: LedgerType.Ethereum,
+};
+hephaestus = new CcModelHephaestus(hephaestusOptions);
+```
+
+We set the desired caseID and start monitoring transactions. These are then processed into cross-chain events when received and added to the cross-chain event log:
+
+```typescript
+hephaestus.setCaseId("Desired_CaseID");
+hephaestus.monitorTransactions();
+```
+
+We can create the cross-chain model with events created from the transactional data captured:
+
+```typescript
+await hephaestus.createModel();
+```
+
+After creating a model with the desired event logs, we can turn off modeling so that newly received transactional data will be compared against the model through a conformance check:
+
+```typescript
+hephaestus.setIsModeling(false);
+```
+
+## Contributing
+We welcome contributions to Hyperledger Cactus in many forms, and there’s always plenty to do!
+
+Please review [CONTIRBUTING.md](https://github.com/hyperledger/cactus/blob/main/CONTRIBUTING.md "CONTIRBUTING.md") to get started.
+
+## License
+This distribution is published under the Apache License Version 2.0 found in the [LICENSE ](https://github.com/hyperledger/cactus/blob/main/LICENSE "LICENSE ")file.

packages/cactus-plugin-ccmodel-hephaestus/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "@hyperledger/cactus-plugin-ccmodel-hephaestus",
+  "version": "2.0.0",
+  "description": "A web service plugin that provides management capabilities on cross-chain transactions visualization.",
+  "keywords": [
+    "Hyperledger",
+    "Cactus",
+    "Integration",
+    "Blockchain",
+    "Distributed Ledger Technology"
+  ],
+  "homepage": "https://github.com/hyperledger/cactus#readme",
+  "bugs": {
+    "url": "https://github.com/hyperledger/cactus/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hyperledger/cactus.git"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Hyperledger Cactus Contributors",
+    "email": "[email protected]",
+    "url": "https://www.hyperledger.org/use/cactus"
+  },
+  "contributors": [
+    {
+      "name": "Please add yourself to the list of contributors",
+      "email": "[email protected]",
+      "url": "https://example.com"
+    },
+    {
+      "name": "Iulia Mihaiu"
+    },
+    {
+      "name": "Sabrina Scuri"
+    },
+    {
+      "name": "Rafael Belchior"
+    },
+    {
+      "name": "Bruno Mateus"
+    }
+  ],
+  "main": "dist/lib/main/typescript/index.js",
+  "module": "dist/lib/main/typescript/index.js",
+  "browser": "dist/cactus-plugin-ccmodel-hephaestus.web.umd.js",
+  "types": "dist/types/main/typescript/index.d.ts",
+  "files": [
+    "dist/*"
+  ],
+  "scripts": {
+    "build": "npm run tsc",
+    "tsc": "tsc --project ./tsconfig.json",
+    "watch": "npm-watch",
+    "webpack": "npm-run-all webpack:dev webpack:prod",
+    "webpack:dev": "npm-run-all webpack:dev:node webpack:dev:web",
+    "webpack:dev:node": "webpack --env=dev --target=node --config ../../webpack.config.js",
+    "webpack:dev:web": "webpack --env=dev --target=web --config ../../webpack.config.js",
+    "webpack:prod": "npm-run-all webpack:prod:node webpack:prod:web",
+    "webpack:prod:node": "webpack --env=prod --target=node --config ../../webpack.config.js",
+    "webpack:prod:web": "webpack --env=prod --target=web --config ../../webpack.config.js"
+  },
+  "dependencies": {
+    "@hyperledger/cactus-common": "2.0.0",
+    "@hyperledger/cactus-core": "2.0.0",
+    "@hyperledger/cactus-core-api": "2.0.0",
+    "@hyperledger/cactus-plugin-ledger-connector-besu": "2.0.0",
+    "@hyperledger/cactus-plugin-ledger-connector-ethereum": "2.0.0",
+    "@hyperledger/cactus-plugin-ledger-connector-fabric": "2.0.0",
+    "express": "4.21.0",
+    "run-time-error-cjs": "1.4.0",
+    "rxjs": "7.8.1",
+    "typescript-optional": "2.0.1",
+    "uuid": "10.0.0"
+  },
+  "devDependencies": {
+    "@hyperledger/cactus-plugin-keychain-memory": "2.0.0",
+    "@hyperledger/cactus-test-geth-ledger": "2.0.0",
+    "@hyperledger/cactus-test-tooling": "2.0.0",
+    "@types/express": "5.0.0",
+    "@types/uuid": "10.0.0",
+    "body-parser": "1.20.3",
+    "fabric-network": "2.2.20",
+    "socket.io": "4.6.2",
+    "uuid": "10.0.0",
+    "web3": "1.6.1",
+    "web3-core": "1.6.1"
+  },
+  "engines": {
+    "node": ">=10",
+    "npm": ">=6"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "browserMinified": "dist/cactus-plugin-ccmodel-hephaestus.web.umd.min.js",
+  "mainMinified": "dist/cactus-plugin-ccmodel-hephaestus.node.umd.min.js"
+}

packages/cactus-plugin-ccmodel-hephaestus/src/main/typescript/index.ts

@@ -0,0 +1 @@
+export * from "./public-api";

packages/cactus-plugin-ccmodel-hephaestus/src/main/typescript/index.web.ts

@@ -0,0 +1 @@
+export {};

packages/cactus-plugin-ccmodel-hephaestus/src/main/typescript/models/carbon-footprint.ts

@@ -0,0 +1,40 @@
+import { LedgerType } from "@hyperledger/cactus-core-api";
+
+export function calculateGasPriceEth(
+  gasUsed: number,
+  effectiveGasPrice: string | undefined,
+): number {
+  if (!gasUsed || !effectiveGasPrice) {
+    return 0;
+  }
+  const gasPrice = parseFloat(effectiveGasPrice);
+  return gasUsed * gasPrice;
+}
+
+export function calculateCarbonFootPrintFabric(
+  peers: string[] | undefined,
+): number {
+  if (!peers) {
+    return 0;
+  }
+  return peers.length * CarbonFootPrintConstants(LedgerType.Fabric2);
+}
+export function calculateCarbonFootPrintBesu(): number {
+  return CarbonFootPrintConstants(LedgerType.Besu2X);
+}
+
+export const CarbonFootPrintConstants = (ledger: LedgerType): number => {
+  switch (ledger) {
+    case LedgerType.Besu2X:
+      return 0.00018;
+
+    case LedgerType.Besu1X:
+      return 0.00018;
+
+    case LedgerType.Fabric2:
+      return 0.00018;
+
+    default:
+      return 0;
+  }
+};

packages/cactus-plugin-ccmodel-hephaestus/src/main/typescript/models/cross-chain-event.ts

@@ -0,0 +1,78 @@
+import { LedgerType } from "@hyperledger/cactus-core-api";
+
+export type CrossChainEvent = {
+  caseID: string;
+  receiptID: string;
+  timestamp: string;
+  blockchainID: LedgerType;
+  invocationType: string;
+  methodName: string;
+  parameters: string[];
+  identity: string;
+  cost?: number | string;
+  carbonFootprint?: number | string;
+  latency?: number;
+};
+
+export interface ICrossChainEventLog {
+  name: string;
+}
+
+export class CrossChainEventLog {
+  private crossChainEvents: CrossChainEvent[] = [];
+  private creationDate: Date;
+  private lastUpdateDate: Date;
+  public readonly logName: string;
+  //TODO: add a pause boolean?
+
+  constructor(options: ICrossChainEventLog) {
+    this.creationDate = new Date();
+    this.lastUpdateDate = new Date();
+    this.logName = options.name;
+  }
+
+  get logEntries(): CrossChainEvent[] {
+    return this.crossChainEvents;
+  }
+
+  public numberEvents(): number {
+    return this.crossChainEvents.length;
+  }
+  public getCreationDate(): Date {
+    return this.creationDate;
+  }
+
+  public getLastUpdateDate(): Date {
+    return this.lastUpdateDate;
+  }
+
+  public purgeLogs(): void {
+    this.crossChainEvents = [];
+  }
+
+  public addCrossChainEvent(event: CrossChainEvent): void {
+    this.crossChainEvents.push(event);
+    this.lastUpdateDate = new Date();
+  }
+
+  public removeLastEvent(): void {
+    this.crossChainEvents.pop();
+    this.lastUpdateDate = new Date();
+  }
+
+  public getCrossChainLogAttributes(): string[] {
+    return [
+      "caseID",
+      "receiptID",
+      "timestamp",
+      "blockchainID",
+      "invocationType",
+      "methodName",
+      "parameters",
+      "identity",
+      "cost",
+      "carbonFootprint",
+      "latency",
+    ];
+  }
+}