woop/proto/common.go

package proto

import (
	"errors"
)

/*
The message structure of any message in Harmony network

----  content start -----
1 byte            - message category
                    0x00: Consensus
                    0x01: NODE...
1 byte            - message type
                    - for Consensus category
                      0x00: consensus
                      0x01: sharding ...
				    - for NODE category
                      0x00: transaction ...
n - 2 bytes       - actual message payload
----   content end  -----
*/

// The message category enum
type MessageCategory byte

//Consensus and other message categories
const (
	Consensus MessageCategory = iota
	NODE
	CLIENT
	IDENTITY
	// TODO: add more types
)

// MessageCategoryBytes is the number of bytes message category takes
const MessageCategoryBytes = 1

// MessageTypeBytes is the number of bytes message type takes
const MessageTypeBytes = 1

// Get the message category from the p2p message content
func GetMessageCategory(message []byte) (MessageCategory, error) {
	if len(message) < MessageCategoryBytes {
		return 0, errors.New("Failed to get message category: no data available.")
	}
	return MessageCategory(message[MessageCategoryBytes-1]), nil
}

// Get the message type from the p2p message content
func GetMessageType(message []byte) (byte, error) {
	if len(message) < MessageCategoryBytes+MessageTypeBytes {
		return 0, errors.New("Failed to get message type: no data available.")
	}
	return byte(message[MessageCategoryBytes+MessageTypeBytes-1]), nil
}

// Get the node message payload from the p2p message content
func GetMessagePayload(message []byte) ([]byte, error) {
	if len(message) < MessageCategoryBytes+MessageTypeBytes {
		return []byte{}, errors.New("Failed to get message payload: no data available.")
	}
	return message[MessageCategoryBytes+MessageTypeBytes:], nil
}