Add Simplex Messages To p2p.proto (#3976)

Signed-off-by: Maximilian Hubert <[email protected]>
Signed-off-by: rodrigo <[email protected]>
Signed-off-by: Elvis <[email protected]>
Co-authored-by: Maximilian Hubert <[email protected]>
Co-authored-by: Stephen Buttolph <[email protected]>
Co-authored-by: Quentin McGaw <[email protected]>
Co-authored-by: Michael Kaplan <[email protected]>
Co-authored-by: Rodrigo Villar <[email protected]>
Co-authored-by: rodrigo <[email protected]>
Co-authored-by: Elvis <[email protected]>
Co-authored-by: yacovm <[email protected]>

Author: 8 people

message/fields.go

@@ -32,6 +32,7 @@ var (
 	_ chainIDGetter = (*p2p.AppRequest)(nil)
 	_ chainIDGetter = (*p2p.AppResponse)(nil)
 	_ chainIDGetter = (*p2p.AppGossip)(nil)
+	_ chainIDGetter = (*p2p.Simplex)(nil)
 
 	_ requestIDGetter = (*p2p.GetStateSummaryFrontier)(nil)
 	_ requestIDGetter = (*p2p.StateSummaryFrontier)(nil)

message/inbound_msg_builder.go

@@ -314,6 +314,19 @@ func InboundAppResponse(
 	}
 }
 
+// NewInboundSimplexMessage creates a new InboundMessage for simplex messages.
+func InboundSimplexMessage(
+	nodeID ids.NodeID,
+	msg *p2p.Simplex,
+) InboundMessage {
+	return &inboundMessage{
+		nodeID:     nodeID,
+		op:         SimplexOp,
+		message:    msg,
+		expiration: mockable.MaxTime,
+	}
+}
+
 func encodeIDs(ids []ids.ID, result [][]byte) {
 	for i, id := range ids {
 		result[i] = id[:]

message/messages_test.go

@@ -629,6 +629,26 @@ func TestMessage(t *testing.T) {
 			bypassThrottling: true,
 			bytesSaved:       true,
 		},
+		{
+			desc: "simplex message with no compression",
+			op:   SimplexOp,
+			msg: &p2p.Message{
+				Message: &p2p.Message_Simplex{
+					Simplex: &p2p.Simplex{
+						ChainId: testID[:],
+						Message: &p2p.Simplex_ReplicationRequest{
+							ReplicationRequest: &p2p.ReplicationRequest{
+								Seqs:        []uint64{1, 2, 3},
+								LatestRound: 1,
+							},
+						},
+					},
+				},
+			},
+			compressionType:  compression.TypeNone,
+			bypassThrottling: true,
+			bytesSaved:       false,
+		},
 	}
 
 	for _, tv := range tests {

message/ops.go

@@ -59,6 +59,8 @@ const (
 	DisconnectedOp
 	NotifyOp
 	GossipRequestOp
+	// Simplex
+	SimplexOp
 )
 
 var (
@@ -76,6 +78,7 @@ var (
 		AppGossipOp,
 		GetStateSummaryFrontierOp,
 		GetAcceptedStateSummaryOp,
+		SimplexOp,
 	)
 	// FailedToResponseOps maps response failure messages to their successful
 	// counterparts.
@@ -171,6 +174,9 @@ func (op Op) String() string {
 		return "notify"
 	case GossipRequestOp:
 		return "gossip_request"
+	// Simplex
+	case SimplexOp:
+		return "simplex"
 	default:
 		return "unknown"
 	}
@@ -231,6 +237,9 @@ func Unwrap(m *p2p.Message) (fmt.Stringer, error) {
 		return msg.AppError, nil
 	case *p2p.Message_AppGossip:
 		return msg.AppGossip, nil
+	// Simplex
+	case *p2p.Message_Simplex:
+		return msg.Simplex, nil
 	default:
 		return nil, fmt.Errorf("%w: %T", errUnknownMessageType, msg)
 	}
@@ -286,6 +295,8 @@ func ToOp(m *p2p.Message) (Op, error) {
 		return AppErrorOp, nil
 	case *p2p.Message_AppGossip:
 		return AppGossipOp, nil
+	case *p2p.Message_Simplex:
+		return SimplexOp, nil
 	default:
 		return 0, fmt.Errorf("%w: %T", errUnknownMessageType, msg)
 	}

proto/p2p/p2p.proto

@@ -9,7 +9,7 @@ option go_package = "github.com/ava-labs/avalanchego/proto/pb/p2p";
 // Only one type can be non-null.
 message Message {
   reserved 1; // Until E upgrade is activated.
-  reserved 36; // Next unused field number.
+  reserved 37; // Next unused field number.
   // NOTES
   // Use "oneof" for each message type and set rest to null if not used.
   // That is because when the compression is enabled, we don't want to include uncompressed fields.
@@ -55,6 +55,9 @@ message Message {
     AppResponse app_response = 31;
     AppGossip app_gossip = 32;
     AppError app_error = 34;
+
+    // Simplex messages:
+    Simplex simplex = 36;
   }
 }
 
@@ -419,3 +422,91 @@ message AppGossip {
   // Message body
   bytes app_bytes = 2;
 }
+
+message Simplex {
+  bytes chain_id = 1;
+
+  oneof message {
+    BlockProposal block_proposal = 2;
+    Vote vote = 3;
+    EmptyVote empty_vote = 4;
+    Vote finalize_vote = 5;
+    QuorumCertificate notarization = 6;
+    EmptyNotarization empty_notarization = 7;
+    QuorumCertificate finalization = 8;
+    ReplicationRequest replication_request = 9;
+    ReplicationResponse replication_response = 10;
+  }
+}
+
+message BlockProposal {
+  bytes block = 1;
+  Vote vote = 2;
+}
+
+message ProtocolMetadata {
+  // Version defines the version of the protocol this block was created with.
+  uint32 version = 1;
+  // Epoch returns the epoch in which the block was proposed
+  uint64 epoch = 2;
+  // Round returns the round number in which the block was proposed.
+  // Can also be an empty block.
+  uint64 round = 3;
+  // Seq is the order of the block among all blocks in the blockchain.
+  // Cannot correspond to an empty block.
+  uint64 seq = 4;
+  // Prev returns the digest of the previous data block
+  bytes prev = 5;
+}
+
+message BlockHeader {
+  ProtocolMetadata metadata = 1;
+  // digest is the short representation of the inner block's bytes
+  bytes digest = 2;
+}
+
+message Signature {
+  // Signer identifies who the signature came from.
+  bytes signer = 1;
+  // Value is the actual cryptographic signature.
+  bytes value = 2;
+}
+
+message Vote {
+  BlockHeader vote = 1;
+  Signature signature = 2;
+}
+
+message EmptyVote {
+  ProtocolMetadata vote = 1;
+  Signature signature = 2;
+}
+
+message QuorumCertificate {
+  BlockHeader finalization = 1;
+  bytes quorum_certificate = 2;
+}
+
+message EmptyNotarization {
+  ProtocolMetadata empty_vote = 1;
+  bytes quorum_certificate = 2;
+}
+
+message ReplicationRequest {
+  repeated uint64 seqs = 1; // sequences we are requesting
+  uint64 latest_round = 2; // latest round that we are aware of
+}
+
+message ReplicationResponse {
+  repeated QuorumRound data = 1; // requested seqs. not required to be in particular order
+  QuorumRound latest_round = 2; // latest round the responding node is aware of
+}
+
+// QuorumRound represents a round that has acheived quorum on either
+// (empty notarization), (block & notarization), or (block, finalization certificate)
+message QuorumRound {
+  bytes block = 1;
+  QuorumCertificate notarization = 2;
+  EmptyNotarization empty_notarization = 3;
+  QuorumCertificate finalization = 4;
+}