feat(satp-hermes): bungee & ethereum bridge

* added logic for satp-bridge supporting the ethereum connector
* finished the integration with bungee
* changed common stringify for safeStableStringify across the package
* added test for the new bridge & end-to-end tests for the new features
* fabric-connector: fix bug handling empty read-write sets
* bungee: strategy fabric fix bug handling empty read-write sets
* bungee: hole package introduce safeStableStringify
* ethereum-connector: bump web3 packages versions to
    fix (web3/web3.js#6798)

Signed-off-by: Eduardo Vasques <[email protected]>

Author: eduv09

examples/cactus-example-cbdc-bridging-backend/src/main/typescript/infrastructure/cbdc-bridging-app-dummy-infrastructure.ts

@@ -76,6 +76,7 @@ import {
   AdminApi,
   TransactionApi,
 } from "@hyperledger/cactus-plugin-satp-hermes/src/main/typescript/generated/gateway-client/typescript-axios/api";
+import { ClaimFormat } from "@hyperledger/cactus-plugin-satp-hermes/src/main/typescript/generated/proto/cacti/satp/v02/common/message_pb";
 
 export interface ICbdcBridgingAppDummyInfrastructureOptions {
   logLevel?: LogLevelDesc;
@@ -439,6 +440,7 @@ export class CbdcBridgingAppDummyInfrastructure {
       contractName: CbdcBridgingAppDummyInfrastructure.SATP_WRAPPER,
       options: this.fabricConnectorBridgeOptions,
       bungeeOptions: pluginBungeeFabricOptions,
+      claimFormat: ClaimFormat.DEFAULT,
     } as FabricConfig;
 
     const besuConfig = {
@@ -454,6 +456,7 @@ export class CbdcBridgingAppDummyInfrastructure {
       options: this.besuOptions,
       bungeeOptions: pluginBungeeBesuOptions,
       gas: 999999999999999,
+      claimFormat: ClaimFormat.DEFAULT,
     };
 
     const besuGatewayOptions: SATPGatewayConfig = {

packages/cactus-plugin-ledger-connector-ethereum/package.json

@@ -82,9 +82,9 @@
     "sanitize-html": "2.12.1",
     "socket.io-client-fixed-types": "4.5.4",
     "typescript-optional": "2.0.1",
-    "web3": "4.4.0",
-    "web3-eth": "4.4.0",
-    "web3-eth-contract": "4.2.0"
+    "web3": "4.14.0",
+    "web3-eth": "4.10.0",
+    "web3-eth-contract": "4.7.0"
   },
   "devDependencies": {
     "@hyperledger/cactus-plugin-keychain-memory": "2.1.0",

packages/cactus-plugin-satp-hermes/cache/solidity-files-cache.json

@@ -120,6 +120,7 @@
     "@bufbuild/buf": "1.30.0",
     "@bufbuild/protoc-gen-es": "1.8.0",
     "@grpc/proto-loader": "0.7.13",
+    "@hyperledger/cactus-test-geth-ledger": "2.0.0-rc.7",
     "@quobix/vacuum": "0.9.16",
     "@types/body-parser": "1.19.4",
     "@types/crypto-js": "4.0.1",

packages/cactus-plugin-satp-hermes/package.json

@@ -209,46 +209,57 @@ enum Error {
     ERROR_MESSAGE_OUT_OF_SEQUENCE = 11;
 }
 
-
+enum ClaimFormat {
+    DEFAULT = 0;
+    BUNGEE = 1;
+}
+message WrapAssertionClaimFormat {
+    ClaimFormat format = 1;
+}
 message LockAssertionClaimFormat {
-
+    ClaimFormat format = 1;
 }
 
 message MintAssertionClaimFormat {
-
+    ClaimFormat format = 1;
 }
 
 message BurnAssertionClaimFormat {
-
+    ClaimFormat format = 1;
 }
 
 message AssignmentAssertionClaimFormat {
-
+    ClaimFormat format = 1;
 }
 
 message LockAssertionClaim {
     string receipt = 1;
-    string signature = 2;
+    string proof = 2;
+    string signature = 3;
 }
 
 message MintAssertionClaim {
     string receipt = 1;
-    string signature = 2;
+    string proof = 2;
+    string signature = 3;
 }
 
 message BurnAssertionClaim {
     string receipt = 1;
-    string signature = 2;
+    string proof = 2;
+    string signature = 3;
 }
 
 message AssignmentAssertionClaim {
     string receipt = 1;
-    string signature = 2;
+    string proof = 2;
+    string signature = 3;
 }
 
 message WrapAssertionClaim {
     string receipt = 1;
-    string signature = 2;
+    string proof = 2;
+    string signature = 3;
 }
 
 enum TokenType {

packages/cactus-plugin-satp-hermes/src/main/proto/cacti/satp/v02/common/message.proto

@@ -70,17 +70,31 @@ export async function GetStatusService(
       dltProtocol: "besu",
       dltSubnetworkID: "v24.4.0-RC1",
     };
-    destinationChain = {
+  } else if (sessionData.senderGatewayNetworkId === SupportedChain.FABRIC) {
+    originChain = {
       dltProtocol: "fabric",
       dltSubnetworkID: "v2.0.0",
     };
   } else {
     originChain = {
+      dltProtocol: "ethereum",
+      dltSubnetworkID: "v24.4.0-RC1",
+    };
+  }
+
+  if (sessionData.recipientGatewayNetworkId === SupportedChain.BESU) {
+    destinationChain = {
+      dltProtocol: "besu",
+      dltSubnetworkID: "v24.4.0-RC1",
+    };
+  } else if (sessionData.recipientGatewayNetworkId === SupportedChain.FABRIC) {
+    destinationChain = {
       dltProtocol: "fabric",
       dltSubnetworkID: "v2.0.0",
     };
+  } else {
     destinationChain = {
-      dltProtocol: "besu",
+      dltProtocol: "ethereum",
       dltSubnetworkID: "v24.4.0-RC1",
     };
   }

packages/cactus-plugin-satp-hermes/src/main/typescript/blo/admin/get-status-handler-service.ts

@@ -1,4 +1,6 @@
 import { v4 as uuidv4 } from "uuid";
+import { stringify as safeStableStringify } from "safe-stable-stringify";
+
 import {
   MessageStagesHashes,
   MessageStagesSignatures,
@@ -257,7 +259,7 @@ export class SATPSession {
       ) {
         throw new SessionDataNotLoadedCorrectlyError(
           tag,
-          JSON.stringify(sessionData),
+          safeStableStringify(sessionData)!,
         );
       }
       if (sessionData.version != SATP_VERSION) {
@@ -267,7 +269,7 @@ export class SATPSession {
       console.error(`${tag}, error: ${error}`);
       throw new SessionDataNotLoadedCorrectlyError(
         tag,
-        JSON.stringify(sessionData),
+        safeStableStringify(sessionData)!,
         error,
       );
     }

packages/cactus-plugin-satp-hermes/src/main/typescript/core/satp-session.ts

@@ -7,6 +7,8 @@ import {
   SATPHandlerType,
   Stage,
 } from "../../types/satp-protocol";
+import { stringify as safeStableStringify } from "safe-stable-stringify";
+
 import { ConnectRouter, HandlerContext } from "@connectrpc/connect";
 import { SatpStage0Service } from "../../generated/proto/cacti/satp/v02/stage_0_connect";
 import {
@@ -67,7 +69,7 @@ export class Stage0SATPHandler implements SATPHandler {
     try {
       this.Log.debug(`${fnTag}, New Session...`);
       this.Log.debug(
-        `${fnTag}, Request: ${JSON.stringify(req)}, Context: ${JSON.stringify(context)}`,
+        `${fnTag}, Request: ${safeStableStringify(req)}, Context: ${safeStableStringify(context)}`,
       );
 
       let session = this.sessions.get(req.sessionId);
@@ -111,7 +113,7 @@ export class Stage0SATPHandler implements SATPHandler {
     try {
       this.Log.debug(`${fnTag}, PreSATPTransfer...`);
       this.Log.debug(
-        `${fnTag}, Request: ${JSON.stringify(req)}, Context: ${JSON.stringify(context)}`,
+        `${fnTag}, Request: ${safeStableStringify(req)}, Context: ${safeStableStringify(context)}`,
       );
 
       const session = this.sessions.get(req.sessionId);

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-handlers/stage0-handler.ts

@@ -24,6 +24,7 @@ import {
 } from "../errors/satp-handler-errors";
 import { getSessionId } from "./handler-utils";
 import { PreSATPTransferResponse } from "../../generated/proto/cacti/satp/v02/stage_0_pb";
+import { stringify as safeStableStringify } from "safe-stable-stringify";
 
 export class Stage1SATPHandler implements SATPHandler {
   public static readonly CLASS_NAME = SATPHandlerType.STAGE1;
@@ -66,7 +67,7 @@ export class Stage1SATPHandler implements SATPHandler {
     try {
       this.Log.debug(`${fnTag}, Transfer Proposal...`);
       this.Log.debug(
-        `${fnTag}, Request: ${JSON.stringify(req)}, Context: ${JSON.stringify(context)}`,
+        `${fnTag}, Request: ${safeStableStringify(req)}, Context: ${safeStableStringify(context)}`,
       );
 
       const session = this.sessions.get(getSessionId(req));
@@ -86,7 +87,7 @@ export class Stage1SATPHandler implements SATPHandler {
       );
 
       this.Log.debug(
-        `${fnTag}, Returning response: ${JSON.stringify(message)}`,
+        `${fnTag}, Returning response: ${safeStableStringify(message)}`,
       );
 
       if (!message) {
@@ -107,7 +108,7 @@ export class Stage1SATPHandler implements SATPHandler {
     try {
       this.Log.debug(`${fnTag}, Transfer Commence...`);
       this.Log.debug(
-        `${fnTag}, Request: ${JSON.stringify(req)}, Context: ${JSON.stringify(context)}`,
+        `${fnTag}, Request: ${safeStableStringify(req)}, Context: ${safeStableStringify(context)}`,
       );
 
       const session = this.sessions.get(getSessionId(req));
@@ -125,7 +126,7 @@ export class Stage1SATPHandler implements SATPHandler {
       );
 
       this.Log.debug(
-        `${fnTag}, Returning response: ${JSON.stringify(message)}`,
+        `${fnTag}, Returning response: ${safeStableStringify(message)}`,
       );
 
       if (!message) {

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-handlers/stage1-handler.ts

@@ -8,6 +8,8 @@ import {
   NewSessionResponse,
   PreSATPTransferRequest,
 } from "../../../generated/proto/cacti/satp/v02/stage_0_pb";
+import { stringify as safeStableStringify } from "safe-stable-stringify";
+
 import { SATPBridgesManager } from "../../../gol/satp-bridges-manager";
 import { FailedToProcessError } from "../../errors/satp-handler-errors";
 import {
@@ -90,7 +92,7 @@ export class Stage0ClientService extends SATPService {
       sessionData.senderGatewayNetworkId;
     newSessionRequestMessage.gatewayId = thisGatewayId;
     const messageSignature = bufArray2HexStr(
-      sign(this.Signer, JSON.stringify(newSessionRequestMessage)),
+      sign(this.Signer, safeStableStringify(newSessionRequestMessage)),
     );
 
     newSessionRequestMessage.clientSignature = messageSignature;
@@ -251,7 +253,7 @@ export class Stage0ClientService extends SATPService {
     );
 
     const messageSignature = bufArray2HexStr(
-      sign(this.Signer, JSON.stringify(preSATPTransferRequest)),
+      sign(this.Signer, safeStableStringify(preSATPTransferRequest)),
     );
 
     preSATPTransferRequest.clientSignature = messageSignature;
@@ -303,7 +305,7 @@ export class Stage0ClientService extends SATPService {
       const assetId = token.tokenId;
       const amount = token.amount.toString();
 
-      this.Log.debug(`${fnTag}, Wrap: ${JSON.stringify(token)}`);
+      this.Log.debug(`${fnTag}, Wrap: ${safeStableStringify(token)}`);
 
       this.Log.debug(`${fnTag}, Wrap Asset ID: ${assetId} amount: ${amount}`);
       if (assetId == undefined) {

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-services/client/stage0-client-service.ts

@@ -16,6 +16,8 @@ import {
   saveSignature,
   SessionType,
 } from "../../session-utils";
+import { stringify as safeStableStringify } from "safe-stable-stringify";
+
 import { SupportedChain } from "../../types";
 import { SATPSession } from "../../../core/satp-session";
 import {
@@ -181,7 +183,7 @@ export class Stage1ClientService extends SATPService {
     }
 
     const messageSignature = bufArray2HexStr(
-      sign(this.Signer, JSON.stringify(transferProposalRequestMessage)),
+      sign(this.Signer, safeStableStringify(transferProposalRequestMessage)),
     );
 
     transferProposalRequestMessage.clientSignature = messageSignature;
@@ -199,7 +201,7 @@ export class Stage1ClientService extends SATPService {
       sessionID: sessionID,
       type: "transferProposalRequest",
       operation: "validate",
-      data: JSON.stringify(sessionData),
+      data: safeStableStringify(sessionData),
     });
     */
     this.Log.info(`${fnTag}, sending TransferProposalRequest...`);
@@ -248,7 +250,7 @@ export class Stage1ClientService extends SATPService {
       sessionData.hashTransferInitClaims;
 
     const messageSignature = bufArray2HexStr(
-      sign(this.Signer, JSON.stringify(transferCommenceRequestMessage)),
+      sign(this.Signer, safeStableStringify(transferCommenceRequestMessage)),
     );
 
     transferCommenceRequestMessage.clientSignature = messageSignature;
@@ -270,7 +272,7 @@ export class Stage1ClientService extends SATPService {
       sessionID: sessionData.id,
       type: "transferCommenceRequest",
       operation: "validate",
-      data: JSON.stringify(sessionData),
+      data: safeStableStringify(sessionData),
     });
     */
     this.Log.info(`${fnTag}, sending TransferCommenceRequest...`);

packages/cactus-plugin-satp-hermes/src/main/typescript/core/stage-services/client/stage1-client-service.ts

@@ -14,6 +14,8 @@ import {
   SessionType,
 } from "../../session-utils";
 import { SATPSession } from "../../../core/satp-session";
+import { stringify as safeStableStringify } from "safe-stable-stringify";
+
 import {
   SATPService,
   ISATPClientServiceOptions,
@@ -125,7 +127,7 @@ export class Stage2ClientService extends SATPService {
     }
 
     const messageSignature = bufArray2HexStr(
-      sign(this.Signer, JSON.stringify(lockAssertionRequestMessage)),
+      sign(this.Signer, safeStableStringify(lockAssertionRequestMessage)),
     );
 
     lockAssertionRequestMessage.clientSignature = messageSignature;
@@ -143,7 +145,7 @@ export class Stage2ClientService extends SATPService {
       sessionID: sessionData.id,
       type: "lockAssertionRequest",
       operation: "lock",
-      data: JSON.stringify(sessionData),
+      data: safeStableStringify(sessionData),
     });
     */
     this.Log.info(`${fnTag}, sending LockAssertionMessage...`);
@@ -228,8 +230,10 @@ export class Stage2ClientService extends SATPService {
         assetId,
         Number(amount),
       );
+      sessionData.lockAssertionClaim.proof = await bridge.getProof(assetId);
 
       sessionData.lockAssertionClaimFormat = new LockAssertionClaimFormat();
+      sessionData.lockAssertionClaimFormat.format = bridge.getReceiptFormat();
 
       sessionData.lockAssertionExpiration = BigInt(99999999999); //todo implement