smite-scenarios: log messages in name(type) format

[ekzyis]

I found this quite useful. This changes the logs like this:

-SendMessage: Some(258), 138 bytes 
+SendMessage: channel_update(258), 138 bytes

and

-expected 33, got 17
+expected accept_channel(33), got error(17)

WDYT? Concept ACK?

[erickcestari]

I like the idea to make the logs more self-describing

Concept ACK 667aae8

[morehouse]

Concept ACK. I think a much simpler way is to implement the Display trait for MessageType.

[ekzyis]

addressed feedback in a56bfc7:

• new MessageType struct with Display implementation
• use existing Display implementation for UnexpectedMessage from #[error(message)]

[ekzyis]

a56bfc7..33a0f32:

• renamed type_ to ty because I learned that ty is the Rust convention when your name conflicts with the reserved keyword type

[morehouse]

Nit: we could simplify all these panics

Suggested change

	other => panic!(
	"expected {}, got {other}",
	msg_type::MessageType(msg_type::OPEN_CHANNEL)
	),
	other => panic!("expected open_channel, got {other}"),

[morehouse]

Suggested change

	for (msg, name, ty) in cases {
	assert_eq!(msg.msg_type(), ty, "wrong type number for {name}");
	assert_eq!(msg.msg_name(), name, "wrong type name for {ty}");
	}
	for (msg, name, ty) in cases {
	assert_eq!(msg.msg_type(), ty, "wrong type number for {name}");
	assert_eq!(msg.msg_name(), name, "wrong type name for {ty}");
	assert_eq!(msg.to_string(), format!("{name}({ty})"));
	assert_eq!(msg_type::MessageType(ty).to_string(), format!("{name}({ty})"));
	}

[morehouse]

Suggested change

	write!(f, "{}({})", self.msg_name(), self.msg_type())
	write!(f, "{}", msg_type::MessageType(self.msg_type()))

[morehouse]

Nit: let's move this to just after the impl Message block below.

[morehouse]

Now we're using MessageType in some places and u16 in others. I think it would be a bit cleaner if we refactored to use MessageType everywhere. For example, the msg_type::OPEN_CHANNEL and other constants could all be MessageTypes, UnexexpectedMessage errors can contain MessageTypes, and Message::msg_type can return a MessageType.

[morehouse]

We should also be able to get rid of the msg_type module and move the constants inside an impl MessageType block.

[erickcestari]

Probably a follow-up PR, but another thing that might be useful for debugging is to log the warning and error data field as ASCII.