Fit adjustment escrowable tx

documentation.swagger.json

@@ -269,6 +269,22 @@
         }
       }
     },
+    "/v1/escrow/PostEscrowApprovalRequest": {
+      "post": {
+        "tags": [
+          "EscrowTransactionService"
+        ],
+        "operationId": "PostApprovalEscrowTransaction",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/modelTransaction"
+            }
+          }
+        }
+      }
+    },
     "/v1/host/GetHostInfo": {
       "get": {
         "tags": [
@@ -965,6 +981,57 @@
     "modelEmptyTransactionBody": {
       "type": "object"
     },
+    "modelEscrow": {
+      "type": "object",
+      "properties": {
+        "Amount": {
+          "type": "string",
+          "format": "int64"
+        },
+        "ApproverAddress": {
+          "type": "string"
+        },
+        "BlockHeight": {
+          "type": "integer",
+          "format": "int64"
+        },
+        "Commission": {
+          "type": "string",
+          "format": "int64"
+        },
+        "ID": {
+          "type": "string",
+          "format": "int64"
+        },
+        "Latest": {
+          "type": "boolean",
+          "format": "boolean"
+        },
+        "RecipientAddress": {
+          "type": "string"
+        },
+        "SenderAddress": {
+          "type": "string"
+        },
+        "Status": {
+          "$ref": "#/definitions/modelEscrowStatus"
+        },
+        "Timeout": {
+          "type": "string",
+          "format": "uint64",
+          "title": "Timeout is BlockHeight gap"
+        }
+      }
+    },
+    "modelEscrowStatus": {
+      "type": "string",
+      "default": "Approved",
+      "enum": [
+        "Approved",
+        "Rejected",
+        "Expired"
+      ]
+    },
     "modelEventType": {
       "type": "string",
       "default": "EventAny",
@@ -1324,6 +1391,9 @@
           "type": "integer",
           "format": "int64"
         },
+        "Escrow": {
+          "$ref": "#/definitions/modelEscrow"
+        },
         "FeePerByte": {
           "type": "string",
           "format": "int64"
@@ -1734,6 +1804,10 @@
           "type": "string",
           "format": "int64"
         },
+        "Escrow": {
+          "title": "nullable",
+          "$ref": "#/definitions/modelEscrow"
+        },
         "Fee": {
           "type": "string",
           "format": "int64"

model/escrow.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+
+package model;
+option go_package = "github.com/zoobc/zoobc-core/common/model";
+
+message Escrow {
+    int64 ID = 1 [ jstype = JS_STRING ];
+    string SenderAddress = 2;
+    string RecipientAddress = 3;
+    string ApproverAddress = 4;
+    int64 Amount = 5 [ jstype = JS_STRING ];
+    int64 Commission = 6 [ jstype = JS_STRING ];
+    // Timeout is BlockHeight gap 
+    uint64 Timeout = 7 [ jstype = JS_STRING ];
+    EscrowStatus Status = 8;
+    uint32 BlockHeight = 9;
+    bool Latest = 10;
+}
+enum EscrowStatus {
+    Approved = 0;
+    Rejected = 1;
+    Expired = 2;
+}
+
+enum EscrowApproval {
+    Approve = 0;
+    Reject = 1;
+}
+// PostEscrowApprovalRequest message for approval transaction escrow
+message PostEscrowApprovalRequest {
+    // ApprovalBytes format: [EscrowApproval][int64 TransactionID]
+    bytes ApprovalBytes = 1;
+}

model/mempool.proto

@@ -4,7 +4,7 @@ package model;
 option go_package = "github.com/zoobc/zoobc-core/common/model";
 
 import "model/pagination.proto";
-
+import "model/escrow.proto";
 // Mempool represent the mempool data structure stored in the database
 message MempoolTransaction {
     int64 ID = 1 [jstype = JS_STRING];
@@ -14,6 +14,8 @@ message MempoolTransaction {
     bytes TransactionBytes = 5;
     string SenderAccountAddress = 6;
     string RecipientAccountAddress = 7;
+    Escrow Escrow = 8;
+
 }
 
 message GetMempoolTransactionRequest {

model/transaction.proto

@@ -7,6 +7,7 @@ import "model/proofOfOwnership.proto";
 import "model/pagination.proto";
 import "model/batchReceipt.proto";
 import "model/nodeRegistration.proto";
+import "model/escrow.proto";
 
 // Transaction represent the transaction data structure stored in the database
 message Transaction {
@@ -35,6 +36,8 @@ message Transaction {
         RemoveAccountDatasetTransactionBody removeAccountDatasetTransactionBody = 21;
     }
     bytes Signature = 22;
+    // nullable
+    Escrow Escrow = 23;
 }
 
 enum TransactionType {

service/escrow.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+package service;
+option go_package = "github.com/zoobc/zoobc-core/common/service";
+
+import "model/transaction.proto";
+import "model/escrow.proto";
+import "google/api/annotations.proto";
+
+service EscrowTransactionService {
+    rpc PostApprovalEscrowTransaction(model.PostEscrowApprovalRequest) returns (model.Transaction) {
+        option (google.api.http) = {
+            post: "/v1/escrow/PostEscrowApprovalRequest"
+        };
+    }
+}