common

type Block interface {
	Decidable

	// Parent returns the ID of this block's parent
	Parent() ids.ID

	// Height returns the height of this block
	Height() uint64

	// Timestamp returns the time this block was created
	Timestamp() uint64

	// Verify that the state transition this block would make is valid
	Verify() error

	// Bytes returns the binary representation of this block
	Bytes() []byte
}

type Decidable interface {
	// ID returns the unique ID of this element
	ID() ids.ID

	// Accept accepts this element and changes its status to Accepted
	Accept() error

	// Reject rejects this element and changes its status to Rejected
	Reject() error

	// Status returns the current status
	Status() choices.Status
}

type Engine interface {
	// Start the engine
	Start(uint64) error

	// Stop the engine
	Stop() error

	// HealthCheck returns nil if the engine is healthy
	HealthCheck() (interface{}, error)
}

type EngineState uint32

type Handler interface {
	Engine

	// SetState sets the state of the handler
	SetState(EngineState) error

	// GetState returns the current state
	GetState() EngineState
}

type Sender interface {
	// SendGetAcceptedFrontier sends a GetAcceptedFrontier message
	SendGetAcceptedFrontier(nodeID ids.NodeID, requestID uint32)

	// SendAcceptedFrontier sends an AcceptedFrontier message
	SendAcceptedFrontier(nodeID ids.NodeID, requestID uint32, containerIDs []ids.ID)

	// SendGetAccepted sends a GetAccepted message
	SendGetAccepted(nodeID ids.NodeID, requestID uint32, containerIDs []ids.ID)

	// SendAccepted sends an Accepted message
	SendAccepted(nodeID ids.NodeID, requestID uint32, containerIDs []ids.ID)

	// SendGet sends a Get message
	SendGet(nodeID ids.NodeID, requestID uint32, containerID ids.ID)

	// SendPut sends a Put message
	SendPut(nodeID ids.NodeID, requestID uint32, container []byte)

	// SendPushQuery sends a PushQuery message
	SendPushQuery(nodeIDs []ids.NodeID, requestID uint32, container []byte)

	// SendPullQuery sends a PullQuery message
	SendPullQuery(nodeIDs []ids.NodeID, requestID uint32, containerID ids.ID)

	// SendChits sends a Chits message
	SendChits(nodeID ids.NodeID, requestID uint32, votes []ids.ID)
}

type Vertex interface {
	Decidable

	// Parents returns the IDs of this vertex's parents
	Parents() []ids.ID

	// Height returns the height of this vertex
	Height() uint64

	// Epoch returns the epoch this vertex was created in
	Epoch() uint32

	// Verify that the state transition this vertex would make is valid
	Verify() error

	// Bytes returns the binary representation of this vertex
	Bytes() []byte
}