driver.proto

// Copyright IBM Corp. All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0

syntax = "proto3";

package driver.driver;

import "common/ack.proto";
import "common/query.proto";
import "common/events.proto";
import "common/state.proto";

option java_package = "org.hyperledger.cacti.weaver.protos.driver.driver";
option go_package = "github.com/hyperledger-cacti/cacti/weaver/common/protos-go/v2/driver";

// Data for a View processing by dest-driver
message WriteExternalStateMessage {
  common.state.ViewPayload view_payload = 1;
  common.events.ContractTransaction ctx = 2;
}

message PerformLockRequest {
  string session_id = 1;
}

message CreateAssetRequest {
  string session_id = 1;
}

message ExtinguishRequest {
  string session_id = 1;
}

message AssignAssetRequest {
  string session_id = 1;
}

service DriverCommunication {
  // Data Sharing 
  // the remote relay sends a RequestDriverState request to its driver with a
  // query defining the data it wants to receive
  rpc RequestDriverState(common.query.Query) returns (common.ack.Ack) {}
  
  // Events Subscription
  // the src-relay uses this endpoint to forward the event subscription request from dest-relay to driver
  rpc SubscribeEvent(common.events.EventSubscription) returns (common.ack.Ack) {}
  
  // Recommended to have TLS mode on for this unsafe endpoint
  // Relay uses this to get Query.requestor_signature and 
  // Query.certificate required for event subscription
  rpc RequestSignedEventSubscriptionQuery(common.events.EventSubscription) returns (common.query.Query) {}

  // Events Publication
  // the dest-relay calls the dest-driver on this end point to write the remote network state to the local ledger
  rpc WriteExternalState(WriteExternalStateMessage) returns (common.ack.Ack) {}

  // As part of SATP, the source reply (sender gateway) sends a PerformLock request to its driver
  // to lock a specific asset
  rpc PerformLock(PerformLockRequest) returns (common.ack.Ack) {}

  // As part of SATP, the destination reply (receiver gateway) sends a CreateAsset request to its driver
  // to create a specific asset
  rpc CreateAsset(CreateAssetRequest) returns (common.ack.Ack) {}

  // As part of SATP, the source reply (sender gateway) sends a Extinguish request to its driver
  // to extinguish a specific asset
  rpc Extinguish(ExtinguishRequest) returns (common.ack.Ack) {}

  // As part of SATP, the destination reply (receiver gateway) sends a AssignAsset request to its driver
  // to assign a specific asset
  rpc AssignAsset(AssignAssetRequest) returns (common.ack.Ack) {}
}