meshcore

type Acknowledgement struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	// Checksum of message timestamp, text and sender public key.
	Checksum uint32 `json:"checksum"`
}

type Advert struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	PublicKey *crypto.PublicKey `json:"public_key"`
	Time      time.Time         `json:"time"`
	Signature crypto.Signature  `json:"signature"`
	Type      NodeType          `json:"node_type"`
	Position  *Position         `json:"position,omitempty"`
	Feature1  *uint16           `json:"feature1,omitempty"`
	Feature2  *uint16           `json:"feature2,omitempty"`
	Name      string            `json:"name,omitempty"`
}

type AnonymousRequest struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	// Destination hash is the first byte of the recipient public key.
	Destination byte `json:"dst"`

	// PublicKey of the sender.
	PublicKey *crypto.PublicKey `json:"public_key"`

	// CipherMAC is the message authenticator.
	CipherMAC uint16 `json:"cipher_mac"`

	// CipherText is the encrypted message.
	CipherText []byte `json:"cipher_text"`
}

type CompanionError struct {
	Code byte
}

type Contact struct {
	Name      string
	PublicKey *crypto.PublicKey
}

type Control struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	// Type of control packet.
	Type ControlType `json:"type"`

	// Request for discovery.
	Request *ControlDiscoverRequest `json:"request,omitempty"`

	// Response for discovery.
	Response *ControlDiscoverResponse `json:"response,omitempty"`

	// Data contains the data bytes for unknown/unparsed control types.
	Data []byte `json:"data"`
}

type ControlDiscoverRequest struct {
	Flags      byte       `json:"flags"`       // upper 4 bits
	PrefixOnly bool       `json:"prefix_only"` // lower 1 bit
	TypeFilter byte       `json:"type_filter"`
	Tag        uint32     `json:"tag"`
	Since      *time.Time `json:"since,omitempty"`
}

type ControlDiscoverResponse struct {
	Flags     byte     `json:"flags"`     // upper 4 bits
	NodeType  NodeType `json:"node_type"` // lower 4 bits
	SNR       float64  `json:"snr"`
	Tag       uint32   `json:"tag"`
	PublicKey []byte   `json:"public_key"` // 8 or 32 bytes
}

type ControlType byte

type EncryptedData struct {
	// Destination hash is the first byte of the recipient public key.
	Destination byte `json:"dst"`

	// Source hash is the first byte of the sender public key.
	Source byte `json:"src"`

	// CipherMAC is the message authenticator.
	CipherMAC uint16 `json:"cipher_mac"`

	// CipherText is the encrypted message.
	CipherText []byte `json:"cipher_text"`
}

type EncryptedGroupData struct {
	// ChannelHash is the first byte of the channel public key.
	ChannelHash byte `json:"channel_hash"`

	// CipherMAC is the message authenticator.
	CipherMAC uint16 `json:"cipher_mac"`

	// CipherText is the encrypted message.
	CipherText []byte `json:"cipher_text"`
}

type Group struct {
	Name   string              `json:"name"`
	Hash   [32]byte            `json:"hash"`
	Secret crypto.SharedSecret `json:"-"`
}

type GroupData struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	EncryptedGroupData

	// Content contains the group datagram.
	Content []byte `json:"content,omitempty"`
}

type GroupText struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	EncryptedGroupData

	// Only available after successful decryption:
	Content *GroupTextContent `json:"content,omitempty"`
}

type GroupTextContent struct {
	// Group this was sent on (not part of the packet).
	Group *Group `json:"group"`

	// Time of sending.
	Time time.Time `json:"time"`

	// Flags is generally 0x00 indicating a plain text message.
	Type TextType `json:"type"`

	// Attempt is the number of retries.
	Attempt uint8 `json:"attempt"`

	// Text sent to the group. Typically contains a "<name>: " prefix.
	Text string `json:"text"`
}

type Identity struct {
	Name       string
	PrivateKey *crypto.PrivateKey
}

type Multipart struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	Remaining uint8       `json:"remaining"`
	Type      PayloadType `json:"type"`
	Data      []byte      `json:"data"`
}

type Node struct {
	OnPacket (*Packet)
	// contains filtered or unexported fields
}

type NodeType byte

type Packet struct {
	// SNR is the signal-to-noise ratio.
	SNR float64 `json:"snr"`

	// RSSI is the received signal strength indicator (in dBm).
	RSSI int8 `json:"rssi"`

	// Raw bytes (optional).
	Raw []byte `json:"raw,omitempty"`

	// RouteType is the type of route for this packet.
	RouteType RouteType `json:"route_type"`

	// PayloadType is the type of payload for this packet.
	PayloadType PayloadType `json:"payload_type"`

	// TransportCodes are set by transport route types.
	TransportCodes []uint16 `json:"transport_codes,omitempty"`

	// Path are repeater hashes.
	Path []byte `json:"path"`

	// Payload is the raw (encoded) payload.
	Payload []byte `json:"payload,omitempty"`
}

type Path struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	EncryptedData
}

type Payload interface {
	fmt.Stringer

	// Packet returns the underlying raw packet (if available, can be nil).
	Packet() *Packet

	// Marhal encodes the payload to bytes.
	Marshal() []byte

	// Unmarshal decodes the payload from bytes.
	Unmarshal([]byte) error
}

type PayloadType byte

type Position struct {
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
}

type RawCustom struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	// Data in the payload.
	Data []byte `json:"data"`
}

type Request struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	EncryptedData

	// Only available after successful decryption:
	Content *RequestContent `json:"content,omitempty"`
}

type RequestContent struct {
	// Time of sending the request.
	Time time.Time `json:"time"`

	// Type of request.
	Type RequestType `json:"type"`

	// Data is the request payload.
	Data []byte `json:"data"`
}

type RequestType byte

type Response struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	EncryptedData

	// Only available after successful decryption:
	Content *ResponseContent `json:"content,omitempty"`
}

type ResponseContent struct {
	// Tag.
	Tag uint32 `json:"tag"`

	// Content of the response.
	Content []byte `json:"content"`
}

type RouteType byte

type Text struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	EncryptedData

	// Only available after successful decryption:
	Content *TextContent `json:"content,omitempty"`
}

type TextContent struct {
	// Time of sending the message.
	Time time.Time `json:"time"`

	// Type of text.
	Type TextType `json:"type"`

	// Attempt for thie packet.
	Attempt uint8 `json:"attempt"`

	// Message contains the text message.
	Message []byte `json:"message"`
}

type TextType byte

type Trace struct {
	// Raw packet (optional).
	Raw *Packet `json:"-"`

	Tag      uint32 `json:"tag"`
	AuthCode uint32 `json:"authcode"`
	Flags    byte   `json:"flags"`
	Path     []byte `json:"path"`
}