[SHARED][CLI] adds message routing type field to debug messages and CLI commands (#561)

## Description

Adds a `MessageRoutingType` field for distinguishing debug message [routing types](https://en.wikipedia.org/wiki/Routing) in the debug CLI.

## Issue

Fixes #344

## Type of change

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [x] Code health or cleanup
- [ ] Major breaking change
- [ ] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

- Adds a RoutingType field to the DebugMessage
- Distinguishes the routing types of each message in the Debug CLI

## Testing

- [x] `make develop_test`
- [x] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README`

## Required Checklist

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have tested my changes using the available tooling
- [x] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added, or updated, [mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding README(s)
- [ ] I have added, or updated, documentation and [mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*` if I updated `shared/*`README(s)

Author: dylanlott

app/client/cli/debug.go

@@ -24,15 +24,13 @@ import (
 
 // TECHDEBT: Lowercase variables / constants that do not need to be exported.
 const (
-	PromptResetToGenesis      string = "ResetToGenesis"
-	PromptPrintNodeState      string = "PrintNodeState"
-	PromptTriggerNextView     string = "TriggerNextView"
-	PromptTogglePacemakerMode string = "TogglePacemakerMode"
-
-	PromptShowLatestBlockInStore string = "ShowLatestBlockInStore"
-
-	PromptSendMetadataRequest string = "MetadataRequest"
-	PromptSendBlockRequest    string = "BlockRequest"
+	PromptResetToGenesis         string = "ResetToGenesis (broadcast)"
+	PromptPrintNodeState         string = "PrintNodeState (broadcast)"
+	PromptTriggerNextView        string = "TriggerNextView (broadcast)"
+	PromptTogglePacemakerMode    string = "TogglePacemakerMode (broadcast)"
+	PromptShowLatestBlockInStore string = "ShowLatestBlockInStore (anycast)"
+	PromptSendMetadataRequest    string = "MetadataRequest (broadcast)"
+	PromptSendBlockRequest       string = "BlockRequest (broadcast)"
 )
 
 var (
@@ -155,42 +153,50 @@ func handleSelect(cmd *cobra.Command, selection string) {
 	case PromptResetToGenesis:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_RESET_TO_GENESIS,
+			Type:    messaging.DebugMessageRoutingType_DEBUG_MESSAGE_TYPE_BROADCAST,
 			Message: nil,
 		}
 		broadcastDebugMessage(cmd, m)
 	case PromptPrintNodeState:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_PRINT_NODE_STATE,
+			Type:    messaging.DebugMessageRoutingType_DEBUG_MESSAGE_TYPE_BROADCAST,
 			Message: nil,
 		}
 		broadcastDebugMessage(cmd, m)
 	case PromptTriggerNextView:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_TRIGGER_NEXT_VIEW,
+			Type:    messaging.DebugMessageRoutingType_DEBUG_MESSAGE_TYPE_BROADCAST,
 			Message: nil,
 		}
 		broadcastDebugMessage(cmd, m)
 	case PromptTogglePacemakerMode:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_TOGGLE_PACE_MAKER_MODE,
+			Type:    messaging.DebugMessageRoutingType_DEBUG_MESSAGE_TYPE_BROADCAST,
 			Message: nil,
 		}
 		broadcastDebugMessage(cmd, m)
 	case PromptShowLatestBlockInStore:
 		m := &messaging.DebugMessage{
-			Action:  messaging.DebugMessageAction_DEBUG_SHOW_LATEST_BLOCK_IN_STORE,
+			Action: messaging.DebugMessageAction_DEBUG_SHOW_LATEST_BLOCK_IN_STORE,
+			// NB: Anycast because we technically accept any node but we arbitrarily choose the first in our address book.
+			Type:    messaging.DebugMessageRoutingType_DEBUG_MESSAGE_TYPE_ANYCAST,
 			Message: nil,
 		}
 		sendDebugMessage(cmd, m)
 	case PromptSendMetadataRequest:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_SEND_METADATA_REQ,
+			Type:    messaging.DebugMessageRoutingType_DEBUG_MESSAGE_TYPE_BROADCAST,
 			Message: nil,
 		}
 		broadcastDebugMessage(cmd, m)
 	case PromptSendBlockRequest:
 		m := &messaging.DebugMessage{
 			Action:  messaging.DebugMessageAction_DEBUG_CONSENSUS_SEND_BLOCK_REQ,
+			Type:    messaging.DebugMessageRoutingType_DEBUG_MESSAGE_TYPE_BROADCAST,
 			Message: nil,
 		}
 		broadcastDebugMessage(cmd, m)

app/docs/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.3] - 2023-03-20
+
+- Adds message routing type field labels to debug CLI actions
+
 ## [0.0.0.2] - 2023-03-14
 
 - Simplifies the debug CLI tooling by embedding private-keys.yaml manifest

shared/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.0.40] - 2023-03-20
+
+- Adds enum DebugMessageType for distinguishing message routing behavior
+
 ## [0.0.0.39] - 2023-03-09
 
 - Fix diagrams in SLIP documentation to be in the correct order

shared/messaging/proto/debug_message.proto

@@ -22,12 +22,20 @@ enum DebugMessageAction {
 
 	DEBUG_PERSISTENCE_CLEAR_STATE = 8;
 	DEBUG_PERSISTENCE_RESET_TO_GENESIS = 9;
-	
-
-
 }
 
 message DebugMessage {
   DebugMessageAction action = 1;
-  google.protobuf.Any message = 2;
+  DebugMessageRoutingType type = 2;
+  google.protobuf.Any message = 3;
 }
+
+// NB: See https://en.wikipedia.org/wiki/Routing for more info on routing and delivery schemes.
+enum DebugMessageRoutingType {
+	DEBUG_MESSAGE_TYPE_UNKNOWN = 0;
+
+	DEBUG_MESSAGE_TYPE_ANYCAST = 1;
+	DEBUG_MESSAGE_TYPE_MULTICAST = 2;
+	DEBUG_MESSAGE_TYPE_BROADCAST = 3;
+	DEBUG_MESSAGE_TYPE_UNICAST = 4;
+}