data: composed rust message & action types

Author: will-break-it

data/simulation/trace.rust.d.ts

@@ -15,22 +15,18 @@ interface RustTaskInfo {
 }
 
 // CPU Events
-type RustCpuTaskType =
-    | "PraosBlockValidated"
-    | "EndorserBlockValidated"
-    | "VoteBundleValidated"
-    | "EndorserBlockGenerated"
-    | "VoteBundleGenerated"
-    | "InputBlockValidated"
-    | "InputBlockGenerated"
-    | "TransactionValidated"
-    | "PraosBlockGenerated";
-
-type RustCpuMessageType =
-    | "CpuTaskScheduled"
-    | "CpuTaskFinished"
-    | "CpuSubtaskStarted"
-    | "CpuSubtaskFinished";
+type BlockOrTaskType =
+    | "PraosBlock"
+    | "EndorserBlock"
+    | "VoteBundle"
+    | "InputBlock"
+    | "Transaction";
+type Action = "Validated" | "Generated";
+type RustCpuTaskType = `${BlockOrTaskType}${Action}`;
+
+type CpuTaskPrefix = "CpuTask" | "CpuSubtask";
+type CpuTaskAction = "Scheduled" | "Started" | "Finished";
+type RustCpuMessageType = `${CpuTaskPrefix}${CpuTaskAction}`;
 
 interface RustCpuEvent extends Omit<RustBaseEvent, "message"> {
     message: {
@@ -52,42 +48,14 @@ interface RustBaseBlockEvent {
     recipient?: string;
 }
 
-type RustInputBlockMessageType =
-    | "InputBlockSent"
-    | "InputBlockReceived"
-    | "InputBlockLotteryWon"
-    | "InputBlockGenerated";
-
-interface RustInputBlockEvent extends Omit<RustBaseEvent, "message"> {
-    message: RustBaseBlockEvent & {
-        type: RustInputBlockMessageType;
-        index: number;
-        header_bytes?: number;
-        transactions?: string[];
-    };
-}
-
-type RustEndorserBlockMessageType =
-    | "EndorserBlockSent"
-    | "EndorserBlockReceived"
-    | "EndorserBlockLotteryWon"
-    | "EndorserBlockGenerated";
-
-interface RustEndorserBlockEvent extends Omit<RustBaseEvent, "message"> {
-    message: RustBaseBlockEvent & {
-        type: RustEndorserBlockMessageType;
-    };
-}
-
-type RustPraosBlockMessageType =
-    | "PraosBlockSent"
-    | "PraosBlockReceived"
-    | "PraosBlockLotteryWon"
-    | "PraosBlockGenerated";
+type BlockType = "Input" | "Endorser" | "Praos";
+type BlockAction = "Sent" | "Received" | "LotteryWon" | "Generated";
+type RustBlockMessageType = `${BlockType}Block${BlockAction}`;
 
-interface RustPraosBlockEvent extends Omit<RustBaseEvent, "message"> {
+interface RustBlockEvent extends Omit<RustBaseEvent, "message"> {
     message: RustBaseBlockEvent & {
-        type: RustPraosBlockMessageType;
+        type: RustBlockMessageType;
+        index?: number;
         header_bytes?: number;
         transactions?: string[];
         vrf?: number;
@@ -96,10 +64,8 @@ interface RustPraosBlockEvent extends Omit<RustBaseEvent, "message"> {
 }
 
 // Transaction Events
-type RustTransactionMessageType =
-    | "TransactionSent"
-    | "TransactionReceived"
-    | "TransactionGenerated";
+type TransactionAction = "Sent" | "Received" | "Generated";
+type RustTransactionMessageType = `Transaction${TransactionAction}`;
 
 interface RustTransactionEvent extends Omit<RustBaseEvent, "message"> {
     message: {
@@ -113,11 +79,8 @@ interface RustTransactionEvent extends Omit<RustBaseEvent, "message"> {
 }
 
 // Vote Events
-type RustVoteMessageType =
-    | "VotesReceived"
-    | "VotesSent"
-    | "VotesGenerated"
-    | "VoteLotteryWon";
+type VoteAction = "Received" | "Sent" | "Generated" | "LotteryWon";
+type RustVoteMessageType = `Votes${VoteAction}`;
 
 interface RustVoteEvent extends Omit<RustBaseEvent, "message"> {
     message: {
@@ -142,9 +105,7 @@ interface RustSlotEvent extends Omit<RustBaseEvent, "message"> {
 // Combined type
 export type RustTraceEvent =
     | RustCpuEvent
-    | RustInputBlockEvent
-    | RustEndorserBlockEvent
-    | RustPraosBlockEvent
+    | RustBlockEvent
     | RustTransactionEvent
     | RustVoteEvent
     | RustSlotEvent;

data/simulation/trace.rust.schema.json

@@ -5,13 +5,7 @@
       "$ref": "#/definitions/RustCpuEvent"
     },
     {
-      "$ref": "#/definitions/RustInputBlockEvent"
-    },
-    {
-      "$ref": "#/definitions/RustEndorserBlockEvent"
-    },
-    {
-      "$ref": "#/definitions/RustPraosBlockEvent"
+      "$ref": "#/definitions/RustBlockEvent"
     },
     {
       "$ref": "#/definitions/RustTransactionEvent"
@@ -47,93 +41,7 @@
       },
       "type": "object"
     },
-    "RustCpuEvent": {
-      "properties": {
-        "message": {
-          "properties": {
-            "extra": {
-              "type": "string"
-            },
-            "subtask_id": {
-              "type": "number"
-            },
-            "subtasks": {
-              "type": "number"
-            },
-            "task": {
-              "$ref": "#/definitions/RustTaskInfo"
-            },
-            "task_type": {
-              "$ref": "#/definitions/RustCpuTaskType"
-            },
-            "type": {
-              "$ref": "#/definitions/RustCpuMessageType"
-            }
-          },
-          "type": "object"
-        },
-        "time": {
-          "type": "number"
-        }
-      },
-      "type": "object"
-    },
-    "RustCpuMessageType": {
-      "enum": [
-        "CpuSubtaskFinished",
-        "CpuSubtaskStarted",
-        "CpuTaskFinished",
-        "CpuTaskScheduled"
-      ],
-      "type": "string"
-    },
-    "RustCpuTaskType": {
-      "enum": [
-        "EndorserBlockGenerated",
-        "EndorserBlockValidated",
-        "InputBlockGenerated",
-        "InputBlockValidated",
-        "PraosBlockGenerated",
-        "PraosBlockValidated",
-        "TransactionValidated",
-        "VoteBundleGenerated",
-        "VoteBundleValidated"
-      ],
-      "type": "string"
-    },
-    "RustEndorserBlockEvent": {
-      "properties": {
-        "message": {
-          "allOf": [
-            {
-              "$ref": "#/definitions/RustBaseBlockEvent"
-            },
-            {
-              "properties": {
-                "type": {
-                  "$ref": "#/definitions/RustEndorserBlockMessageType"
-                }
-              },
-              "type": "object"
-            }
-          ]
-        },
-        "time": {
-          "type": "number"
-        }
-      },
-      "type": "object"
-    },
-    "RustEndorserBlockMessageType": {
-      "enum": [
-        "EndorserBlockGenerated",
-        "EndorserBlockLotteryWon",
-        "EndorserBlockReceived",
-        "EndorserBlockSent"
-      ],
-      "type": "string"
-    },
-    "RustInputBlockEvent": {
+    "RustBlockEvent": {
       "properties": {
         "message": {
           "allOf": [
@@ -142,6 +50,7 @@
             },
             {
               "properties": {
+                "endorsement": {},
                 "header_bytes": {
                   "type": "number"
                 },
@@ -155,7 +64,10 @@
                   "type": "array"
                 },
                 "type": {
-                  "$ref": "#/definitions/RustInputBlockMessageType"
+                  "$ref": "#/definitions/RustBlockMessageType"
+                },
+                "vrf": {
+                  "type": "number"
                 }
               },
               "type": "object"
@@ -168,57 +80,77 @@
       },
       "type": "object"
     },
-    "RustInputBlockMessageType": {
+    "RustBlockMessageType": {
       "enum": [
+        "EndorserBlockGenerated",
+        "EndorserBlockLotteryWon",
+        "EndorserBlockReceived",
+        "EndorserBlockSent",
         "InputBlockGenerated",
         "InputBlockLotteryWon",
         "InputBlockReceived",
-        "InputBlockSent"
+        "InputBlockSent",
+        "PraosBlockGenerated",
+        "PraosBlockLotteryWon",
+        "PraosBlockReceived",
+        "PraosBlockSent"
       ],
       "type": "string"
     },
-    "RustPraosBlockEvent": {
+    "RustCpuEvent": {
       "properties": {
         "message": {
-          "allOf": [
-            {
-              "$ref": "#/definitions/RustBaseBlockEvent"
+          "properties": {
+            "extra": {
+              "type": "string"
             },
-            {
-              "properties": {
-                "endorsement": {},
-                "header_bytes": {
-                  "type": "number"
-                },
-                "transactions": {
-                  "items": {
-                    "type": "string"
-                  },
-                  "type": "array"
-                },
-                "type": {
-                  "$ref": "#/definitions/RustPraosBlockMessageType"
-                },
-                "vrf": {
-                  "type": "number"
-                }
-              },
-              "type": "object"
+            "subtask_id": {
+              "type": "number"
+            },
+            "subtasks": {
+              "type": "number"
+            },
+            "task": {
+              "$ref": "#/definitions/RustTaskInfo"
+            },
+            "task_type": {
+              "$ref": "#/definitions/RustCpuTaskType"
+            },
+            "type": {
+              "$ref": "#/definitions/RustCpuMessageType"
             }
-          ]
+          },
+          "type": "object"
         },
         "time": {
           "type": "number"
         }
       },
       "type": "object"
     },
-    "RustPraosBlockMessageType": {
+    "RustCpuMessageType": {
+      "enum": [
+        "CpuSubtaskFinished",
+        "CpuSubtaskScheduled",
+        "CpuSubtaskStarted",
+        "CpuTaskFinished",
+        "CpuTaskScheduled",
+        "CpuTaskStarted"
+      ],
+      "type": "string"
+    },
+    "RustCpuTaskType": {
       "enum": [
+        "EndorserBlockGenerated",
+        "EndorserBlockValidated",
+        "InputBlockGenerated",
+        "InputBlockValidated",
         "PraosBlockGenerated",
-        "PraosBlockLotteryWon",
-        "PraosBlockReceived",
-        "PraosBlockSent"
+        "PraosBlockValidated",
+        "TransactionGenerated",
+        "TransactionValidated",
+        "VoteBundleGenerated",
+        "VoteBundleValidated"
       ],
       "type": "string"
     },
@@ -328,8 +260,8 @@
     },
     "RustVoteMessageType": {
       "enum": [
-        "VoteLotteryWon",
         "VotesGenerated",
+        "VotesLotteryWon",
         "VotesReceived",
         "VotesSent"
       ],