feat(connector-besu): add getBlock web service #1065

fixes #1065 Signed-off-by: Tommesha Wiggins <[email protected]>
hyperledger-cacti · Jul 10, 2021 · 869c48b · 869c48b
1 parent c037ec5
commit 869c48b
Show file tree

Hide file tree

Showing 8 changed files with 627 additions and 1,647 deletions.
diff --git a/packages/cactus-plugin-ledger-connector-besu/package-lock.json b/packages/cactus-plugin-ledger-connector-besu/package-lock.json
diff --git a/packages/cactus-plugin-ledger-connector-besu/src/main/json/openapi.json b/packages/cactus-plugin-ledger-connector-besu/src/main/json/openapi.json
@@ -55,7 +55,78 @@
                     }
                 }
             },
+            "EvmBlock":{
+                "type":"object",
+                "properties":{
+                    "number":{
+                        "type":"number"
+                    },
+                    "hash":{
+                        "type":"string"
+                    },
+                    "parentHash":{
+                        "type":"string"
+                    },
+                    "nonce":{
+                        "type":"string"
+                    },
+                    "sha3Uncles":{
+                        "type":"string"
+                    },
+                    "logsBloom":{
+                        "type":"string"
+                    },
+                    "transactionsRoot":{
+                        "type":"string"
+                    },
+                    "stateRoot":{
+                        "type":"string"
+                    },
+                    "miner":{
+                        "type":"string"
+                    },
+                    "difficulty":{
+                        "type":"number"
+                    },
+                    "totalDifficulty":{
+                        "type":"number"
+                    },
+                    "extraData":{
+                        "type":"string"
+                    },
+                    "size":{
+                        "type":"number"
+                    },
+                    "gasLimit":{
+                        "type":"number"
+                    },
+                    "gasUsed":{
+                        "type":"number"
+                    },
+                    "timestamp":{
+                    },
+                    "transactions":{
+                        "type":"array",
+                        "items":{}
+                    },
+                    "uncles":{
+                        "type":"array",
+                        "items":{}
+                    }
+                }
+            },
+            "GetBlockV1Response": {
+                "type": "object",
+                "required": [
+                    "block"                    
+                ],
+                "properties": {
+                    "block": {
+                        "$ref":"#/components/schemas/EvmBlock"
+                    }
 
+                }
+            },
             "EvmTransaction":{
                 "type":"object",
                 "properties":{
@@ -98,19 +169,18 @@
                 "properties": {
                     "transaction": {
                         "$ref":"#/components/schemas/EvmTransaction"
-                        }
                     }
-
+                }
             },
             "GetTransactionV1Request": {
                 "type": "object",
                 "required": ["transactionHash"],
                 "properties": {
                     "transactionHash":{
                         "type": "string"
-                        }
                     }
-                },        
+                }
+            },       
             "GetPastLogsV1Response": {
                 "type": "object",
                 "required": [
@@ -188,6 +258,14 @@
                   }
               }
             },
+            "GetBlockV1Request": {
+                "required": ["blockHashOrBlockNumber"],
+                "type": "object",
+                "properties": {
+                    "blockHashOrBlockNumber": {
+                    }
+                }
+            },
             "WatchBlocksV1": {
                 "type": "string",
                 "enum": [
@@ -956,6 +1034,40 @@
                 }
             }
         },
+        "/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-besu/get-block": {
+            "post": {
+                "x-hyperledger-cactus": {
+                    "http": {
+                        "verbLowerCase": "post",
+                        "path": "/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-besu/get-block"
+                    }
+                },
+                "operationId": "getBlockV1",
+                "summary": "Returns a block matching the block",
+                "parameters": [],
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/GetBlockV1Request"
+                            }
+                        }
+                    }
+                },
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/GetBlockV1Response"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-besu/run-transaction": {
             "post": {
                 "x-hyperledger-cactus": {