chore(connector-go-eth): upgrade web3.js to recent version

- Upgrade web3 package used by go-ethereum-socketio connector from "0.20.7" to "1.8.1" - Major cleanup and refactor of go-ethereum-socketio logic, without affecting the current functionalities. - Add safety checking of method called in web3Eth and contract functions. Add tests to check if it works. - Add websocket eth RPC support and some helper functions in openethereum-test-ledger. - Expose WS RPC in geth-testnet, use this port in sample apps (required to monitor new blocks in updated web3.js) - Change raw use of sendRawTransaction to sendSignedTransaction in sample apps in order to conform to new web3.js version. - Add safeStringifyException to cactus-common that can be used by validators to sanitize response errors. - Refactor socketio-based validators to use safeStringifyException. - Adjust connector README files. - Improve cleanup after running sample apps - Fix discounted-cartrade sample ethereum transfer and checking Closes hyperledger-cacti#2088 Depends on hyperledger-cacti#2053 Signed-off-by: Michal Bajer <michal.bajer@fujitsu.com>
RafaelAPB · Nov 26, 2022 · 9dd13cb · 9dd13cb
1 parent 43c7b40
commit 9dd13cb
Show file tree

Hide file tree

Showing 29 changed files with 1,025 additions and 659 deletions.
diff --git a/examples/cactus-example-discounted-asset-trade/README.md b/examples/cactus-example-discounted-asset-trade/README.md
@@ -179,11 +179,15 @@ For development purposes, it might be useful to run the sample application outsi
 
    ```
    # Ethereum fromAccount:
-   { status: 200, amount: 100000 }
+   { status: 200, amount: 1e+26 }
+
+   # Ethereum escrowAccount:
+   { status: 200, amount: 0 }
 
    # Ethereum toAccount:
    { status: 200, amount: 0 }
 
+
    # Fabric:
    [
        {
@@ -240,10 +244,14 @@ For development purposes, it might be useful to run the sample application outsi
 
    ```
    # Ethereum fromAccount:
-   { status: 200, amount: 99950 }
+   { status: 200, amount: 1.00000045e+26 }
+
+   # Ethereum escrowAccount:
+   { status: 200, amount: 0 }
 
    # Ethereum toAccount:
-   { status: 200, amount: 50 }
+   { status: 200, amount: 25 }
+
 
    # Fabric:
    [

diff --git a/examples/cactus-example-discounted-asset-trade/business-logic-asset-trade.ts b/examples/cactus-example-discounted-asset-trade/business-logic-asset-trade.ts
@@ -108,8 +108,6 @@ export class BusinessLogicAssetTrade extends BusinessLogicBase {
     // Register transaction information in transaction information management
     const transactionInfo: TransactionInfo = new TransactionInfo();
     transactionInfo.setRequestInfo(0, requestInfo);
-    this.transactionInfoManagement.addTransactionInfo(transactionInfo);
-
     // pricing of trade by user's status which is employee or not employee
     this.Pricing(requestInfo)
       .then((result) => {
@@ -121,6 +119,10 @@ export class BusinessLogicAssetTrade extends BusinessLogicBase {
           requestInfo.tradeID,
         );
 
+        // Save transaction value
+        transactionInfo.setRequestInfo(1, requestInfo);
+        this.transactionInfoManagement.addTransactionInfo(transactionInfo);
+
         // trade status update
         this.transactionInfoManagement.setStatus(
           tradeInfo,
@@ -352,7 +354,7 @@ export class BusinessLogicAssetTrade extends BusinessLogicBase {
     // TODO: Get address of escrow and set parameter
     const escrowAddress = config.assetTradeInfo.ethereum.escrowAddress;
 
-    // Generate parameters for// sendRawTransaction
+    // Generate parameters for// sendSignedTransaction
     const txParam: {
       fromAddress: string;
       fromAddressPkey: string;
@@ -385,7 +387,7 @@ export class BusinessLogicAssetTrade extends BusinessLogicBase {
         // Set Parameter
         logger.debug("firstTransaction data : " + JSON.stringify(result.data));
         const contract = {}; // NOTE: Since contract does not need to be specified, specify an empty object.
-        const method = { type: "web3Eth", command: "sendRawTransaction" };
+        const method = { type: "web3Eth", command: "sendSignedTransaction" };
 
         const args = { args: [result.data["serializedTx"]] };
         // Run Verifier (Ethereum)
@@ -500,7 +502,7 @@ export class BusinessLogicAssetTrade extends BusinessLogicBase {
     // TODO: get escrow secret key
     const escrowAddressPkey = config.assetTradeInfo.ethereum.escrowAddressPkey;
 
-    // Generate parameters for sendRawTransaction
+    // Generate parameters for sendSignedTransaction
     const txParam: {
       fromAddress: string;
       fromAddressPkey: string;
@@ -538,7 +540,7 @@ export class BusinessLogicAssetTrade extends BusinessLogicBase {
         // TODO: Neo!!
         // Set Parameter
         const contract = {}; // NOTE: Since contract does not need to be specified, specify an empty object.
-        const method = { type: "web3Eth", command: "sendRawTransaction" };
+        const method = { type: "web3Eth", command: "sendSignedTransaction" };
         const args = { args: [result.data["serializedTx"]] };
 
         // Run Verifier (Ethereum)

diff --git a/examples/cactus-example-discounted-asset-trade/package.json b/examples/cactus-example-discounted-asset-trade/package.json
@@ -34,7 +34,7 @@
     "shelljs": "0.8.5",
     "socket.io": "4.4.1",
     "ts-node": "8.9.1",
-    "web3": "1.7.0",
+    "web3": "1.8.1",
     "xmlhttprequest": "1.8.0"
   },
   "devDependencies": {

diff --git a/examples/cactus-example-discounted-asset-trade/read-ledger-state.js b/examples/cactus-example-discounted-asset-trade/read-ledger-state.js
@@ -3,11 +3,17 @@ const axios = require("axios");
 async function main() {
   // Read ethereum balances
   const fromAccountResponse = await axios.get(
-    "http://localhost:5034/api/v1/bl/balance/0x06fc56347d91c6ad2dae0c3ba38eb12ab0d72e97",
+    "http://localhost:5034/api/v1/bl/balance/0xec709e1774f0ce4aba47b52a499f9abaaa159f71",
   );
   console.log("\n# Ethereum fromAccount:");
   console.log(fromAccountResponse.data);
 
+  const escrowAccountResponse = await axios.get(
+    "http://localhost:5034/api/v1/bl/balance/0x36e146d5afab61ab125ee671708eeb380aea05b6",
+  );
+  console.log("\n# Ethereum escrowAccount:");
+  console.log(escrowAccountResponse.data);
+
   const toAccountResponse = await axios.get(
     "http://localhost:5034/api/v1/bl/balance/0x9d624f7995e8bd70251f8265f2f9f2b49f169c55",
   );

diff --git a/examples/cactus-example-discounted-asset-trade/script-cleanup.sh b/examples/cactus-example-discounted-asset-trade/script-cleanup.sh
@@ -7,9 +7,21 @@ rm -rf ./etc/cactus/
 
 echo ">> Stop the docker containers of Ethereum, Fabric and Indy"
 docker stop geth1 asset_trade_faio2x_testnet indy-testnet-pool
-docker rm geth1 asset_trade_faio2x_testnet indy-testnet-pool
+docker rm geth1 asset_trade_faio2x_testnet indy-testnet-pool $(docker container ls -q --all --filter name=geth-testnet_init-chain)
+docker compose rm -f
+
+echo ">> Clear docker networks"
+docker network rm geth1net geth-testnet_default fabric-all-in-one_testnet-2x geth-testnet_default indy-testnet_indy_net
+docker network rm $(docker network ls -q --filter name=cactus-example-discounted-asset-trade)
 
 echo ">> Clear indy testnet sandbox"
 pushd ../../tools/docker/indy-testnet/
 ./script-cleanup.sh
 popd
+
+echo ">> Remove geth files"
+pushd ../../tools/docker/geth-testnet/
+rm -fr ./data-geth1/geth/
+popd
+
+echo "Cleanup done."
diff --git a/examples/cactus-example-electricity-trade/BusinessLogicElectricityTrade.ts b/examples/cactus-example-electricity-trade/BusinessLogicElectricityTrade.ts
@@ -174,7 +174,7 @@ export class BusinessLogicElectricityTrade extends BusinessLogicBase {
         // Set Parameter
         logger.debug("remittanceTransaction data : " + json2str(result.data));
         const contract = {}; // NOTE: Since contract does not need to be specified, specify an empty object.
-        const method = { type: "web3Eth", command: "sendRawTransaction" };
+        const method = { type: "web3Eth", command: "sendSignedTransaction" };
         const args: RawTransationResultData = {
           args: [result.data["serializedTx"]],
         };

diff --git a/examples/cactus-example-electricity-trade/package.json b/examples/cactus-example-electricity-trade/package.json
@@ -32,7 +32,7 @@
     "shelljs": "0.8.5",
     "socket.io": "4.4.1",
     "ts-node": "8.9.1",
-    "web3": "1.7.0",
+    "web3": "1.8.1",
     "xmlhttprequest": "1.8.0"
   },
   "devDependencies": {

diff --git a/examples/cactus-example-electricity-trade/script-cleanup.sh b/examples/cactus-example-electricity-trade/script-cleanup.sh
@@ -11,7 +11,8 @@ docker rm -f sawtooth_all_in_one_ledger_1x \
                 cactus-example-electricity-trade-blp \
                 cactus-example-electricity-trade-ethereum-validator \
                 cactus-example-electricity-trade-sawtooth-validator \
-                cmd-socketio-base-dummy
+                cmd-socketio-base-dummy \
+                $(docker container ls -q --all --filter name=geth-testnet_init-chain)
 
 echo ">> Remove docker networks"
 docker network rm sawtooth_aio_testnet_1x \
@@ -20,4 +21,9 @@ docker network rm sawtooth_aio_testnet_1x \
                     geth1net \
                     geth-testnet_default
 
+echo ">> Remove geth files"
+pushd ../../tools/docker/geth-testnet/
+rm -fr ./data-geth1/geth/
+popd
+
 echo "Cleanup done."
diff --git a/examples/cactus-example-electricity-trade/tools/transferNumericAsset/package.json b/examples/cactus-example-electricity-trade/tools/transferNumericAsset/package.json
@@ -14,7 +14,7 @@
     "ethereumjs-common": "1.5.2",
     "ethereumjs-tx": "2.1.2",
     "ts-node": "9.1.1",
-    "web3": "1.7.0",
+    "web3": "1.8.1",
     "socket.io": "4.4.1"
   },
   "devDependencies": {

diff --git a/packages/cactus-common/package.json b/packages/cactus-common/package.json
@@ -50,15 +50,18 @@
     "webpack:dev:web": "webpack --env=dev --target=web --config ../../webpack.config.js"
   },
   "dependencies": {
+    "fast-safe-stringify": "2.1.1",
     "json-stable-stringify": "1.0.1",
     "key-encoder": "2.0.3",
     "loglevel": "1.7.1",
     "loglevel-plugin-prefix": "0.8.4",
     "secp256k1": "4.0.2",
+    "sanitize-html": "2.7.0",
     "sha3": "2.1.4"
   },
   "devDependencies": {
     "@types/json-stable-stringify": "1.0.33",
+    "@types/sanitize-html": "2.6.2",
     "@types/secp256k1": "4.0.3",
     "@types/uuid": "8.3.1",
     "uuid": "8.3.2"

diff --git a/packages/cactus-common/src/main/typescript/checks.ts b/packages/cactus-common/src/main/typescript/checks.ts
@@ -1,4 +1,4 @@
-import { CodedError } from "./coded-error";
+import { CodedError } from "./error-utils";
 
 export class Checks {
   /**

diff --git a/packages/cactus-common/src/main/typescript/coded-error.ts b/packages/cactus-common/src/main/typescript/coded-error.ts
diff --git a/packages/cactus-common/src/main/typescript/error-utils.ts b/packages/cactus-common/src/main/typescript/error-utils.ts
@@ -0,0 +1,32 @@
+import safeStringify from "fast-safe-stringify";
+import sanitizeHtml from "sanitize-html";
+
+/**
+ * Utility class for better exception handling by way of having a code property
+ * which is designated to uniquely identify the type of exception that was
+ * thrown, essentially acting as a discriminator property.
+ */
+export class CodedError extends Error {
+  constructor(public readonly message: string, public readonly code: string) {
+    super(message);
+  }
+
+  sameCode(codedError: CodedError): boolean {
+    return this.code === codedError?.code;
+  }
+}
+
+/**
+ * Return secure string representation of error from the input.
+ * Handles circular structures and removes HTML.
+ *
+ * @param error Any object to return as an error, preferable `Error`
+ * @returns Safe string representation of an error.
+ */
+export function safeStringifyException(error: unknown): string {
+  if (error instanceof Error) {
+    return sanitizeHtml(error.stack || error.message);
+  }
+
+  return sanitizeHtml(safeStringify(error));
+}
diff --git a/packages/cactus-common/src/main/typescript/public-api.ts b/packages/cactus-common/src/main/typescript/public-api.ts
@@ -5,7 +5,7 @@ export { Objects } from "./objects";
 export { Strings } from "./strings";
 export { Bools } from "./bools";
 export { Checks } from "./checks";
-export { CodedError } from "./coded-error";
+export { CodedError, safeStringifyException } from "./error-utils";
 
 export {
   JsObjectSigner,

diff --git a/packages/cactus-common/src/test/typescript/unit/coded-error.test.ts b/packages/cactus-common/src/test/typescript/unit/coded-error.test.ts
@@ -1,4 +1,4 @@
-import { CodedError } from "../../../main/typescript/coded-error";
+import { CodedError } from "../../../main/typescript/error-utils";
 import "jest-extended";
 
 test("Error test", async () => {

diff --git a/packages/cactus-plugin-ledger-connector-fabric-socketio/package.json b/packages/cactus-plugin-ledger-connector-fabric-socketio/package.json
@@ -16,14 +16,14 @@
   "dependencies": {
     "@types/node": "14.17.32",
     "@hyperledger/cactus-cmd-socketio-server": "1.1.2",
+    "@hyperledger/cactus-common": "1.1.2",
     "body-parser": "1.17.2",
     "cookie-parser": "1.4.6",
     "debug": "4.1.1",
     "express": "4.17.3",
     "fabric-ca-client": "1.4.19",
     "fabric-client": "1.4.19",
     "fabric-network": "1.4.19",
-    "fast-safe-stringify": "2.1.1",
     "fs-extra": "10.0.0",
     "protobufjs": "5.0.3",
     "grpc": "1.24.11",

diff --git a/...gin-ledger-connector-fabric-socketio/src/main/typescript/connector/ServerMonitorPlugin.ts b/...gin-ledger-connector-fabric-socketio/src/main/typescript/connector/ServerMonitorPlugin.ts
@@ -19,13 +19,16 @@ import FabricClient from "fabric-client";
 // IF declaration for fabric
 import { getClientAndChannel, getSubmitterAndEnroll } from "./fabricaccess";
 // config file
-import { configRead, signMessageJwt } from "@hyperledger/cactus-cmd-socketio-server";
+import {
+  configRead,
+  signMessageJwt,
+} from "@hyperledger/cactus-cmd-socketio-server";
 // Log settings
 import { getLogger } from "log4js";
 const logger = getLogger("ServerMonitorPlugin[" + process.pid + "]");
 logger.level = configRead<string>("logLevel", "info");
 // utility
-import safeStringify from "fast-safe-stringify";
+import { safeStringifyException } from "@hyperledger/cactus-common";
 
 export type MonitorCallback = (callback: {
   status: number;
@@ -152,7 +155,7 @@ export class ServerMonitorPlugin {
           logger.error(err);
           const errObj = {
             status: 504,
-            errorDetail: safeStringify(err),
+            errorDetail: safeStringifyException(err),
           };
           cb(errObj);
         });

diff --git a/...tus-plugin-ledger-connector-fabric-socketio/src/main/typescript/connector/ServerPlugin.ts b/...tus-plugin-ledger-connector-fabric-socketio/src/main/typescript/connector/ServerPlugin.ts
@@ -12,7 +12,6 @@
  */
 
 import path from "path";
-import safeStringify from "fast-safe-stringify";
 import Client, {
   Proposal,
   ProposalRequest,
@@ -37,6 +36,7 @@ const connUserName = configRead<string>("fabric.connUserName");
 
 // Log settings
 import { getLogger } from "log4js";
+import { safeStringifyException } from "@hyperledger/cactus-common";
 const logger = getLogger("ServerPlugin[" + process.pid + "]");
 logger.level = configRead<string>("logLevel", "info");
 
@@ -231,7 +231,7 @@ export class ServerPlugin {
           retObj = {
             resObj: {
               status: 504,
-              errorDetail: safeStringify(err),
+              errorDetail: safeStringifyException(err),
             },
           };
           logger.error(err);
@@ -304,7 +304,7 @@ export class ServerPlugin {
         .catch((err) => {
           retObj = {
             status: 504,
-            errorDetail: safeStringify(err),
+            errorDetail: safeStringifyException(err),
           };
           logger.error(err);
           return reject(retObj);
@@ -373,7 +373,7 @@ export class ServerPlugin {
       throw {
         resObj: {
           status: 504,
-          errorDetail: safeStringify(error),
+          errorDetail: safeStringifyException(error),
         },
       };
     }
@@ -471,7 +471,7 @@ export class ServerPlugin {
       throw {
         resObj: {
           status: 504,
-          errorDetail: safeStringify(error),
+          errorDetail: safeStringifyException(error),
         },
       };
     }
@@ -630,7 +630,7 @@ export class ServerPlugin {
       throw {
         resObj: {
           status: 504,
-          errorDetail: safeStringify(error),
+          errorDetail: safeStringifyException(error),
         },
       };
     }
@@ -693,7 +693,7 @@ export class ServerPlugin {
       throw {
         resObj: {
           status: 504,
-          errorDetail: safeStringify(error),
+          errorDetail: safeStringifyException(error),
         },
       };
     }
@@ -752,7 +752,7 @@ export class ServerPlugin {
       throw {
         resObj: {
           status: 504,
-          errorDetail: safeStringify(error),
+          errorDetail: safeStringifyException(error),
         },
       };
     }