feat(plugin-validator-besu): generate signature of simple asset

Signed-off-by: suyukuoacn <su-yu.kuo@accenture.com>
hyperledger · Oct 2, 2020 · 4c5c253 · 4c5c253
1 parent ff7b21b
commit 4c5c253
Show file tree

Hide file tree

Showing 29 changed files with 8,037 additions and 0 deletions.
diff --git a/packages/cactus-core-api/src/main/typescript/plugin/plugin-aspect.ts b/packages/cactus-core-api/src/main/typescript/plugin/plugin-aspect.ts
@@ -4,4 +4,5 @@ export enum PluginAspect {
   KV_STORAGE = "KV_STORAGE",
   WEB_SERVICE = "WEB_SERVICE",
   CONSORTIUM = "CONSORTIUM",
+  VALIDATOR = "VALIDATOR",
 }
diff --git a/packages/cactus-plugin-validator-besu/.gitignore b/packages/cactus-plugin-validator-besu/.gitignore
@@ -0,0 +1 @@
+cactus-openapi-spec-plugin-validator-besu.json
diff --git a/packages/cactus-plugin-validator-besu/cactus-openapi-spec-plugin-validator-besu.json b/packages/cactus-plugin-validator-besu/cactus-openapi-spec-plugin-validator-besu.json
@@ -0,0 +1,96 @@
+{
+    "openapi": "3.0.3",
+    "info": {
+        "title": "Hyperledger Cactus Plugin - Validator Besu Web Service",
+        "description": "Obtain signatures of ledger state from Cactus nodes through the API .",
+        "version": "0.0.1"
+    },
+    "servers": [
+        {
+            "url": "https://www.cactus.stream/{basePath}",
+            "description": "Public test instance",
+            "variables": {
+                "basePath": {
+                    "default": ""
+                }
+            }
+        },
+        {
+            "url": "http://localhost:4000/{basePath}",
+            "description": "Local test instance",
+            "variables": {
+                "basePath": {
+                    "default": ""
+                }
+            }
+        }
+    ],
+    "components": {
+        "schemas": {
+            "SignTransactionRequest": {
+                "type": "object",
+                "required": [
+                    "transactionHash"
+                ],
+                "properties": {
+                    "transactionHash": {
+                        "description": "The transaction hash of ledger will be used to fetch the contain.",
+                        "type": "string",
+                        "minLength": 0,
+                        "maxLength": 2048,
+                        "nullable": false
+                    }
+                }
+            },
+            "SignTransactionResponse": {
+                "type": "object",
+                "required": [
+                    "signature"
+                ],
+                "properties": {
+                    "signature": {
+                        "description": "The signatures of ledger from the corresponding transaction hash.",
+                        "type": "string",
+                        "minLength": 0,
+                        "maxLength": 2048,
+                        "nullable": false
+                    }
+                }
+            }
+        }
+    },
+    "paths": {
+        "/api/v1/plugins/@hyperledger/cactus-plugin-validator-besu/sign-transaction": {
+            "post": {
+                "summary": "Obtain signatures of ledger from the corresponding transaction hash.",
+                "description": "Obtain signatures of ledger from the corresponding transaction hash.",
+                "parameters": [],
+                "requestBody": {
+                    "required": true,
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/SignTransactionRequest"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/SignTransactionResponse"
+                                }
+                            }
+                        }
+                    },
+                    "404": {
+                        "description": "Not able to find the corresponding tranaction from the transaction hash"
+                    }
+                }
+            }
+        }
+    }
+}