fixup!: wip gateway refactoring

Signed-off-by: Rafael Belchior <rafael.belchior@tecnico.ulisboa.pt>

packages/cactus-plugin-satp-hermes/src/main/go/generated/gateway-client/.openapi-generator/FILES

@@ -1,5 +1,4 @@
 .gitignore
-.openapi-generator-ignore
 .travis.yml
 README.md
 api/openapi.yaml
@@ -119,6 +118,4 @@ model_transact_default_response.go
 model_transact_request.go
 model_transact_response.go
 response.go
-test/api_admin_test.go
-test/api_transaction_test.go
 utils.go

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

@@ -0,0 +1,9 @@
+syntax = "proto3";
+package cacti.satp.v02.common;
+import "cacti/satp/v02/common/message.proto";
+
+message HealthCheckRequest {}
+
+service HealthService {
+    rpc CheckHealth(HealthCheckRequest) returns (Ack);
+}

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

@@ -13,7 +13,7 @@ message TransferProposalRequestMessage {
   bool multiple_cancels_allowed = 6;
 }
 
-message TransferProposalReceiptRejectMessage {
+message TransferProposalReceiptMessage {
   cacti.satp.v02.common.CommonSatp common = 1;
   string hash_transfer_init_claims = 2;
   cacti.satp.v02.common.TransferClaims transfer_counter_claims = 3;
@@ -31,6 +31,6 @@ message TransferCommenceResponseMessage {
 }
 
 service SatpStage1Service {
-  rpc TransferProposal(TransferProposalRequestMessage) returns (TransferProposalReceiptRejectMessage) {}
+  rpc TransferProposal(TransferProposalRequestMessage) returns (TransferProposalReceiptMessage) {}
   rpc TransferCommence(TransferCommenceRequestMessage) returns (TransferCommenceResponseMessage) {}
 }

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

@@ -0,0 +1,33 @@
+import { v4 as uuidv4 } from "uuid";
+import { SessionData } from "../generated/proto/cacti/satp/v02/common/session_pb";
+
+
+export interface ISATPSessionOptions {
+  contextID: string;
+}
+
+export class SATPSession {
+  private static readonly CLASS_NAME = "SATPSession";
+  private sessionData: SessionData;
+
+  constructor(ops: ISATPSessionOptions) {
+    this.sessionData = new SessionData();
+    this.sessionData.transferContextId = ops.contextID;
+
+    // TODO algorithm to create session ID from context ID
+    this.sessionData.id = ops.contextID + "-" + uuidv4();
+
+  }
+
+  private initializeSessionID(): void {
+    if (this.sessionData.id === undefined) {
+      this.sessionData.id = uuidv4() + "-" + this.sessionData.transferContextId;
+    } else {
+      throw new Error("Session ID already initialized");
+    }
+  }
+
+  public getSessionData(): SessionData {
+    return this.sessionData;
+  }
+}

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

@@ -9,8 +9,11 @@ import { SATPGateway } from "../../gateway-refactor";
 import { Stage1ServerService } from "../stage-services/server/stage1-server-service";
 import { TimestampType, saveTimestamp } from "../session-utils";
 import { MessageType } from "../../generated/proto/cacti/satp/v02/common/message_pb";
+import { SATPSession } from "../satp-session";
+import { Stage1ClientService } from "../stage-services/client/stage1-client-service";
+import { ServiceType } from "@bufbuild/protobuf";
 
-export default (gateway: SATPGateway, service: Stage1ServerService) =>
+export const Stage1Handler = (session: SATPSession | undefined, serverService: Stage1ServerService, clientService: Stage1ClientService, connectClients: ServiceType[]) =>
   (router: ConnectRouter) =>
     router.service(SatpStage1Service, {
       async transferProposal(
@@ -20,8 +23,8 @@ export default (gateway: SATPGateway, service: Stage1ServerService) =>
         console.log("Received TransferProposalRequest", req, context);
         const recvTimestamp: string = Date.now().toString();
 
-        const [sessionData, reject] =
-          await service.checkTransferProposalRequestMessage(req, gateway);
+        const sessionData =
+          await serverService.checkTransferProposalRequestMessage(req, session);
 
         saveTimestamp(
           sessionData,
@@ -30,7 +33,7 @@ export default (gateway: SATPGateway, service: Stage1ServerService) =>
           recvTimestamp,
         );
 
-        const message = await service.transferProposalResponse(
+        const message = await serverService.transferProposalResponse(
           req,
           reject,
           gateway,
@@ -65,9 +68,9 @@ export default (gateway: SATPGateway, service: Stage1ServerService) =>
         console.log("Received TransferCommenceRequest", req, context);
         const recvTimestamp: string = Date.now().toString();
 
-        const sessionData = await service.checkTransferCommenceRequestMessage(
+        const sessionData = await serverService.checkTransferCommenceRequestMessage(
           req,
-          gateway,
+          session,
         );
 
         saveTimestamp(
@@ -77,7 +80,7 @@ export default (gateway: SATPGateway, service: Stage1ServerService) =>
           recvTimestamp,
         );
 
-        const message = await service.transferCommenceResponse(req, gateway);
+        const message = await serverService.transferCommenceResponse(req, session);
 
         if (!message) {
           throw new Error("No message returned from transferProposalResponse");

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

@@ -6,7 +6,7 @@ import { Stage2ServerService } from "../stage-services/server/stage2-server-serv
 import { TimestampType, saveTimestamp } from "../session-utils";
 import { MessageType } from "../../generated/proto/cacti/satp/v02/common/message_pb";
 
-export default (gateway: SATPGateway, service: Stage2ServerService) =>
+export const Stage2Handler = (gateway: SATPGateway, service: Stage2ServerService) =>
   (router: ConnectRouter) =>
     router.service(SatpStage2Service, {
       async lockAssertion(

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

@@ -11,7 +11,7 @@ import { SATPGateway } from "../../gateway-refactor";
 import { TimestampType, saveTimestamp } from "../session-utils";
 import { MessageType } from "../../generated/proto/cacti/satp/v02/common/message_pb";
 
-export default (gateway: SATPGateway, service: Stage3ServerService) =>
+export const Stage3Handler = (gateway: SATPGateway, service: Stage3ServerService) =>
   (router: ConnectRouter) =>
     router.service(SatpStage3Service, {
       async commitPreparation(

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

@@ -1,9 +1,9 @@
-import { Logger, LoggerProvider } from "@hyperledger/cactus-common";
+import { JsObjectSigner, Logger, LoggerProvider } from "@hyperledger/cactus-common";
 import { SATPGateway } from "../../../gateway-refactor";
 import {
   TransferCommenceRequestMessage,
   TransferProposalRequestMessage,
-  TransferProposalReceiptRejectMessage,
+  TransferProposalReceiptMessage,
 } from "../../../generated/proto/cacti/satp/v02/stage_1_pb";
 import {
   MessageType,
@@ -25,15 +25,20 @@ import {
   saveSignature,
   checkSessionData,
 } from "../../session-utils";
+import { SupportedGatewayImplementations } from "../../types";
+import { SATPSession } from "../../../core/satp-session";
+import { SATPService, ISATPClientServiceOptions } from "../../../types/satp-protocol";
 
-export class Stage1ClientService {
+export class Stage1ClientService implements SATPService {
   public static readonly CLASS_NAME = "Stage1Service-Client";
   private _log: Logger;
-
-  constructor() {
+  private signer: JsObjectSigner;
+
+  constructor(ops: ISATPClientServiceOptions) {
     const level = "INFO";
     const label = Stage1ClientService.CLASS_NAME;
     this._log = LoggerProvider.getOrCreate({ level, label });
+    this.signer = ops.signer;
   }
 
   public get className(): string {
@@ -46,20 +51,21 @@ export class Stage1ClientService {
 
   async transferProposalRequest(
     sessionID: string,
-    gateway: SATPGateway,
+    session: SATPSession,
+    supportedDLTs: SupportedGatewayImplementations[],
   ): Promise<void | TransferProposalRequestMessage> {
     const fnTag = `${this.className}#transferProposalRequest()`;
 
-    const sessionData = gateway.getSession(sessionID);
+    const sessionData = session.getSessionData();
 
     if (sessionData == undefined || !checkSessionData(sessionData)) {
       throw new Error(`${fnTag}, session data is not correctly initialized`);
     }
 
     if (
-      !gateway.getSupportedDltIDs().includes(sessionData.senderGatewayNetworkId)
+      !supportedDLTs.includes(sessionData.senderGatewayNetworkId as SupportedGatewayImplementations)
     ) {
-      throw new Error(
+      throw new Error( //todo change this to the transferClaims check
         `${fnTag}, recipient gateway dlt system is not supported by this gateway`,
       );
     }
@@ -170,7 +176,7 @@ export class Stage1ClientService {
 
     const messageSignature = bufArray2HexStr(
       sign(
-        gateway.gatewaySigner,
+        this.signer,
         JSON.stringify(transferProposalRequestMessage),
       ),
     );
@@ -185,29 +191,30 @@ export class Stage1ClientService {
       getHash(transferProposalRequestMessage),
     );
 
+    /*
     await storeLog(gateway, {
       sessionID: sessionID,
       type: "transferProposalRequest",
       operation: "validate",
       data: JSON.stringify(sessionData),
     });
-
+    */
     this.log.info(`${fnTag}, sending TransferProposalRequest...`);
 
     return transferProposalRequestMessage;
   }
 
   async transferCommenceRequest(
-    response: TransferProposalReceiptRejectMessage,
-    gateway: SATPGateway,
+    response: TransferProposalReceiptMessage,
+    session: SATPSession,
   ): Promise<void | TransferCommenceRequestMessage> {
     const fnTag = `${this.className}#transferCommenceRequest()`;
 
     if (!response || !response.common) {
       throw new Error("Response or response.common is undefined");
     }
 
-    const sessionData = gateway.getSession(response.common.sessionId);
+    const sessionData = session.getSessionData();
 
     if (sessionData == undefined) {
       throw new Error("Session data not loaded successfully");
@@ -239,7 +246,7 @@ export class Stage1ClientService {
 
     const messageSignature = bufArray2HexStr(
       sign(
-        gateway.gatewaySigner,
+        this.signer,
         JSON.stringify(transferCommenceRequestMessage),
       ),
     );
@@ -258,23 +265,24 @@ export class Stage1ClientService {
       getHash(transferCommenceRequestMessage),
     );
 
+    /*
     await storeLog(gateway, {
       sessionID: sessionData.id,
       type: "transferCommenceRequest",
       operation: "validate",
       data: JSON.stringify(sessionData),
     });
-
+    */
     this.log.info(`${fnTag}, sending TransferCommenceRequest...`);
 
     return transferCommenceRequestMessage;
   }
 
-  async checkTransferProposalReceiptRejectMessage(
-    response: TransferProposalReceiptRejectMessage,
-    gateway: SATPGateway,
+  async checkTransferProposalReceiptMessage(
+    response: TransferProposalReceiptMessage,
+    session: SATPSession,
   ): Promise<boolean> {
-    const fnTag = `${this.className}#checkTransferProposalReceiptRejectMessage()`;
+    const fnTag = `${this.className}#checkTransferProposalReceiptMessage()`;
 
     if (response.common == undefined) {
       throw new Error(`${fnTag}, message has no satp common body`);
@@ -291,7 +299,7 @@ export class Stage1ClientService {
 
     const sessionId = response.common.sessionId;
 
-    const sessionData = gateway.getSession(sessionId);
+    const sessionData = session.getSessionData();
 
     if (sessionData == undefined) {
       throw new Error(
@@ -356,7 +364,7 @@ export class Stage1ClientService {
 
     if (
       !verifySignature(
-        gateway.gatewaySigner,
+        this.signer,
         response,
         sessionData.serverGatewayPubkey,
       )