feat(cactus-example-discounted-asset-trade): use openapi sawtooth con…

…nector - Refactor discounted asset trade sample to use openapi sawtooth connector instead of sawtooth-socketio. - Remove sawtooth-socketio connector since it's not used any more. Depends on: hyperledger-cacti#2825 Signed-off-by: Michal Bajer <[email protected]>
outSH · Nov 2, 2023 · 0617217 · 0617217
1 parent 63e5702
commit 0617217
Show file tree

Hide file tree

Showing 30 changed files with 186 additions and 1,380 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -162,7 +162,6 @@
         "**/src/main/typescript/generated/**",
         "packages/cactus-plugin-verifier-cc/**",
         "packages/cactus-cmd-socketio-server/**",
-        "packages/cactus-plugin-ledger-connector-sawtooth-socketio/**",
         "packages/cactus-plugin-ledger-connector-go-ethereum-socketio/**",
         "packages/cactus-plugin-ledger-connector-*-socketio/**"
     ]

diff --git a/.eslintignore b/.eslintignore
@@ -5,7 +5,6 @@
 packages/cactus-verifier/src/main/typescript/
 
 packages/cactus-cmd-socketio-server/**
-packages/cactus-plugin-ledger-connector-sawtooth-socketio/**
 packages/cactus-plugin-ledger-connector-go-ethereum-socketio/**
 packages/cactus-plugin-ledger-connector-*-socketio/**
 

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1359,32 +1359,6 @@ jobs:
         with:
           node-version: v16.14.2
       - uses: actions/[email protected]
-      - id: yarn-cache
-        name: Restore Yarn Cache
-        uses: actions/[email protected]
-        with:
-          key: ${{ runner.os }}-yarn-${{ hashFiles('./yarn.lock') }}
-          path: ./.yarn/
-          restore-keys: |
-            ${{ runner.os }}-yarn-${{ hashFiles('./yarn.lock') }}
-      - run: ./tools/ci.sh
-  cactus-plugin-ledger-connector-sawtooth-socketio:
-    continue-on-error: false
-    env:
-      DEV_BUILD_DISABLED: false
-      FULL_BUILD_DISABLED: true
-      JEST_TEST_PATTERN: packages/cactus-plugin-ledger-connector-sawtooth-socketio/src/test/typescript/(unit|integration|benchmark)/.*/*.test.ts
-      JEST_TEST_RUNNER_DISABLED: true
-      TAPE_TEST_RUNNER_DISABLED: true
-    needs: build-dev
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Use Node.js v16.14.2
-        uses: actions/[email protected]
-        with:
-          node-version: v16.14.2
-      - uses: actions/[email protected]
-
       - id: yarn-cache
         name: Restore Yarn Cache
         uses: actions/[email protected]

diff --git a/examples/cactus-example-electricity-trade/BusinessLogicElectricityTrade.ts b/examples/cactus-example-electricity-trade/BusinessLogicElectricityTrade.ts
@@ -10,42 +10,25 @@ import { RequestInfo } from "./RequestInfo";
 import { MeterManagement } from "./MeterManagement";
 import { MeterInfo } from "./MeterInfo";
 import {
-  TradeInfo,
-  routesTransactionManagement,
   BusinessLogicBase,
   LedgerEvent,
   json2str,
   ConfigUtil,
-  LPInfoHolder,
 } from "@hyperledger/cactus-cmd-socketio-server";
 import { sendEthereumTransaction } from "./TransactionEthereum";
 
 const config: any = ConfigUtil.getConfig() as any;
 import { getLogger } from "log4js";
+import { getSawtoothApiClient } from "./sawtooth-connector";
 import {
-  VerifierFactory,
-  VerifierFactoryConfig,
-} from "@hyperledger/cactus-verifier-client";
+  isWatchBlocksV1CactiTransactionsResponse,
+  WatchBlocksV1ListenerType,
+  WatchBlocksV1Progress,
+} from "@hyperledger/cactus-plugin-ledger-connector-sawtooth";
 
 const moduleName = "BusinessLogicElectricityTrade";
 const logger = getLogger(`${moduleName}`);
 logger.level = config.logLevel;
-const connectInfo = new LPInfoHolder();
-const routesVerifierFactory = new VerifierFactory(
-  connectInfo.ledgerPluginInfo as VerifierFactoryConfig,
-  config.logLevel,
-);
-
-interface SawtoothEventData {
-  status: number | string;
-  blockData: [];
-}
-
-interface SawtoothBlockDataData {
-  header_signature: string;
-  hash: string;
-  payload_decoded: { Verb: string; Name: string; Value: string }[];
-}
 
 export class BusinessLogicElectricityTrade extends BusinessLogicBase {
   businessLogicID: string;
@@ -71,39 +54,54 @@ export class BusinessLogicElectricityTrade extends BusinessLogicBase {
     // set TradeID
     requestInfo.setTradeID(tradeID);
 
-    // Create trade information
-    const tradeInfo: TradeInfo = new TradeInfo(
-      requestInfo.businessLogicID,
-      requestInfo.tradeID,
-    );
-
-    this.startMonitor(tradeInfo);
+    this.startSawtoothMonitor();
   }
 
-  startMonitor(tradeInfo: TradeInfo): void {
-    // Get Verifier Instance
-    logger.debug(
-      `##startMonitor(): businessLogicID: ${tradeInfo.businessLogicID}`,
-    );
-    const useValidator = JSON.parse(
-      routesTransactionManagement.getValidatorToUse(tradeInfo.businessLogicID),
-    );
-    logger.debug(
-      `filterKey: ${config.electricityTradeInfo.sawtooth.filterKey}`,
-    );
-    const options = {
-      filterKey: config.electricityTradeInfo.sawtooth.filterKey,
-    };
-    //        const verifierSawtooth = transactionManagement.getVerifier(useValidator['validatorID'][0], options);
-    const verifierSawtooth = routesVerifierFactory.getVerifier(
-      useValidator["validatorID"][0],
-    );
-    verifierSawtooth.startMonitor(
-      "BusinessLogicElectricityTrade",
-      options,
-      routesTransactionManagement,
-    );
-    logger.debug("getVerifierSawtooth");
+  startSawtoothMonitor(): void {
+    // Start monitoring
+    const sawtoothApiClient = getSawtoothApiClient();
+    const watchObservable = sawtoothApiClient.watchBlocksV1({
+      type: WatchBlocksV1ListenerType.CactiTransactions,
+      txFilterBy: {
+        family_name: config.electricityTradeInfo.sawtooth.filterKey,
+      },
+    });
+    watchObservable.subscribe({
+      next: (event: WatchBlocksV1Progress) => {
+        logger.debug(`##in onEventSawtooth()`);
+
+        if (!isWatchBlocksV1CactiTransactionsResponse(event)) {
+          logger.error("Wrong input block format!", event);
+          return;
+        }
+
+        for (const tx of event.cactiTransactionsEvents) {
+          try {
+            const txId = tx.header_signature;
+            logger.debug(`##txId = ${txId}`);
+
+            const txPayload = tx.payload_decoded[0];
+            if (txPayload && txPayload.Verb !== "set") {
+              this.remittanceTransaction({
+                Name: txPayload.Name,
+                Value: txPayload.Value,
+                Verb: txPayload.Verb,
+              });
+            }
+          } catch (err) {
+            logger.error(
+              `##onEventSawtooth(): onEvent, err: ${err}, event: ${JSON.stringify(
+                tx,
+              )}`,
+              tx,
+            );
+          }
+        }
+      },
+      error(err: unknown) {
+        logger.error("Sawtooth watchBlocksV1() error:", err);
+      },
+    });
   }
 
   remittanceTransaction(transactionSubset: Record<string, string>): void {
@@ -144,158 +142,17 @@ export class BusinessLogicElectricityTrade extends BusinessLogicBase {
   }
 
   onEvent(ledgerEvent: LedgerEvent, targetIndex: number): void {
-    logger.debug(`##in BLP:onEvent()`);
-    logger.debug(
-      `##onEvent(): ${json2str(ledgerEvent["data"]["blockData"][targetIndex])}`,
+    logger.error(
+      "onEvent() ERROR - No monitors are running, should not be called!",
     );
-
-    switch (ledgerEvent.verifierId) {
-      case config.electricityTradeInfo.sawtooth.validatorID:
-        this.onEventSawtooth(ledgerEvent.data, targetIndex);
-        break;
-      default:
-        logger.error(
-          `##onEvent(), invalid verifierId: ${ledgerEvent.verifierId}`,
-        );
-        return;
-    }
-  }
-
-  onEventSawtooth(event: SawtoothEventData, targetIndex: number): void {
-    logger.debug(`##in onEventSawtooth()`);
-    const tx = this.getTransactionFromSawtoothEvent(event, targetIndex);
-    if (tx == null) {
-      logger.error(`##onEventSawtooth(): invalid event: ${json2str(event)}`);
-      return;
-    }
-
-    try {
-      const txId = tx["header_signature"];
-      logger.debug(`##txId = ${txId}`);
-
-      if (tx["payload_decoded"][0].Verb !== "set") {
-        const transactionSubset = {
-          Name: tx["payload_decoded"][0].Name,
-          Value: tx["payload_decoded"][0].Value,
-          Verb: tx["payload_decoded"][0].Verb,
-        };
-        this.remittanceTransaction(transactionSubset);
-      }
-    } catch (err) {
-      logger.error(
-        `##onEventSawtooth(): err: ${err}, event: ${json2str(event)}`,
-      );
-    }
-  }
-
-  getTransactionFromSawtoothEvent(
-    event: SawtoothEventData,
-    targetIndex: number | string,
-  ): SawtoothBlockDataData | undefined {
-    try {
-      if (typeof targetIndex === "number") {
-        const retTransaction = event["blockData"][targetIndex];
-
-        logger.debug(
-          `##getTransactionFromSawtoothEvent(), retTransaction: ${retTransaction}`,
-        );
-        return retTransaction;
-      }
-    } catch (err) {
-      logger.error(
-        `##getTransactionFromSawtoothEvent(): invalid even, err:${err}, event:${event}`,
-      );
-    }
+    return;
   }
 
   getOperationStatus(): Record<string, unknown> {
     logger.debug(`##in getOperationStatus()`);
     return {};
   }
 
-  getTxIDFromEvent(
-    ledgerEvent: LedgerEvent,
-    targetIndex: number,
-  ): string | null {
-    logger.debug(`##in getTxIDFromEvent`);
-    //        logger.debug(`##event: ${json2str(ledgerEvent)}`);
-
-    switch (ledgerEvent.verifierId) {
-      case config.electricityTradeInfo.sawtooth.validatorID:
-        return this.getTxIDFromEventSawtooth(ledgerEvent.data, targetIndex);
-      default:
-        logger.error(
-          `##getTxIDFromEvent(): invalid verifierId: ${ledgerEvent.verifierId}`,
-        );
-    }
-    return null;
-  }
-
-  getTxIDFromEventSawtooth(
-    event: SawtoothEventData,
-    targetIndex: number | string,
-  ): string | null {
-    logger.debug(`##in getTxIDFromEventSawtooth()`);
-    const tx = this.getTransactionFromSawtoothEvent(event, targetIndex);
-    if (tx == null) {
-      logger.warn(`#getTxIDFromEventSawtooth(): skip(not found tx)`);
-      return null;
-    }
-
-    try {
-      const txId = tx["header_signature"];
-
-      if (typeof txId !== "string") {
-        logger.warn(
-          `#getTxIDFromEventSawtooth(): skip(invalid block, not found txId.), event: ${json2str(
-            event,
-          )}`,
-        );
-        return null;
-      }
-
-      logger.debug(`###getTxIDFromEventSawtooth(): txId: ${txId}`);
-      return txId;
-    } catch (err) {
-      logger.error(
-        `##getTxIDFromEventSawtooth(): err: ${err}, event: ${json2str(event)}`,
-      );
-      return null;
-    }
-  }
-
-  getEventDataNum(ledgerEvent: LedgerEvent): number {
-    logger.debug(
-      `##in BLP:getEventDataNum(), ledgerEvent.verifierId: ${ledgerEvent.verifierId}`,
-    );
-    const event = ledgerEvent.data;
-    let retEventNum = 0;
-
-    try {
-      logger.error(ledgerEvent.data);
-
-      switch (ledgerEvent.verifierId) {
-        case config.electricityTradeInfo.sawtooth.validatorID:
-          retEventNum = event["blockData"].length;
-          break;
-        default:
-          logger.error(
-            `##getEventDataNum(): invalid verifierId: ${ledgerEvent.verifierId}`,
-          );
-          break;
-      }
-      logger.debug(
-        `##getEventDataNum(): retEventNum: ${retEventNum}, verifierId: ${ledgerEvent.verifierId}`,
-      );
-      return retEventNum;
-    } catch (err) {
-      logger.error(
-        `##getEventDataNum(): invalid even, err: ${err}, event: ${event}`,
-      );
-      return 0;
-    }
-  }
-
   getAccountInfo(
     transactionSubset: Record<string, string>,
   ): Record<string, string> {

diff --git a/examples/cactus-example-electricity-trade/README.md b/examples/cactus-example-electricity-trade/README.md
@@ -16,10 +16,6 @@ In this example, we use the Sawtooth intkey transaction processor as an applicat
 
 ## Prerequisites
 
-- Available ports:
-  - `5034`: the port of `cactus-cmd-socketio-server`
-  - `5140`: the port of `cactus-plugin-ledger-connector-sawtooth-socketio`
-  - You can modify port exported to the host in `./docker-compose.yml`
 - Available directory (This directory must be empty):
   - `./etc/cactus`: the directory for storing the config files of `cactus-cmd-socketio-server`, will be mounted by the containers.
 
@@ -59,11 +55,6 @@ In this example, we use the Sawtooth intkey transaction processor as an applicat
    ```
    cmd-socketio-base-dummy    | OK - Exit
    cmd-socketio-base-dummy exited with code 0
-   cactus-example-electricity-trade-sawtooth-validator |
-   cactus-example-electricity-trade-sawtooth-validator | > @hyperledger/[email protected] start /root/cactus
-   cactus-example-electricity-trade-sawtooth-validator | > cd ./dist && node common/core/bin/www.js
-   cactus-example-electricity-trade-sawtooth-validator |
-   cactus-example-electricity-trade-sawtooth-validator | listening on *:5140
    cactus-example-electricity-trade-blp      | [2022-02-14T15:47:47.312] [INFO] www - Using BLP with id = h40Q9eMD
    cactus-example-electricity-trade-blp      | start Dynamic loading.
    cactus-example-electricity-trade-blp      | path: /api/v1/bl/cactus-example-electricity-trade/, routerJs: /root/cactus/dist/cactus-example-electricity-trade.js
@@ -77,8 +68,6 @@ For development purposes, it might be useful to run the sample application outsi
 
 1. Configure cactus and start the ledgers as described above.
 1. Run `./script-dockerless-config-patch.sh` from `cactus-example-electricity-trade/` directory. This will patch the configs and copy it to global location.
-1. Start sawtooth validators (in separate cmd window, ethereum connector started as part of BLP).
-   1. `cd packages/cactus-plugin-ledger-connector-sawtooth-socketio/ && npm run start`
 1. Start electricity-trade: `npm run start-dockerless`
 
 ## How to use this application

diff --git a/examples/cactus-example-electricity-trade/config/usersetting.yaml b/examples/cactus-example-electricity-trade/config/usersetting.yaml
@@ -2,7 +2,7 @@
 blpRegistry:
   -
     businessLogicID: h40Q9eMD
-    validatorID: [sUr7d10R]
+    validatorID: []
 
 logLevel: debug
 
@@ -24,10 +24,9 @@ appRouters:
 # BLP Config
 electricityTradeInfo:
   sawtooth:
-    validatorID: sUr7d10R
     filterKey: intkey
+    restApiURL: http://localhost:8008
   ethereum:
-    validatorID: 84jUisrs
     gethURL: ws://localhost:8546
     chainName: geth1
     networkID: 10