stateroot

Documentation

Index

• Constants
• type Ledger
• type Message
  • func NewMessage(typ MessageType, p io.Serializable) *Message
  • func (m *Message) DecodeBinary(r *io.BinReader)
  • func (m *Message) EncodeBinary(w *io.BinWriter)
• type MessageType
• type RelayCallback
• type Service
  • func New(cfg config.StateRoot, sm *stateroot.Module, log *zap.Logger, bc Ledger, ...) (Service, error)
• type Vote
  • func (p *Vote) DecodeBinary(r *io.BinReader)
  • func (p *Vote) EncodeBinary(w *io.BinWriter)

Constants

const (
	// Category is a message category for extensible payloads.
	Category = "StateService"
)

Types

type Ledger

type Ledger interface {
	GetConfig() config.ProtocolConfiguration
	HeaderHeight() uint32
	SubscribeForBlocks(ch chan<- *block.Block)
	UnsubscribeFromBlocks(ch chan<- *block.Block)
}

Ledger is an interface to Blockchain sufficient for Service.

type Message

type Message struct {
	Type    MessageType
	Payload io.Serializable
}

Message represents a state-root related message.

func NewMessage

func NewMessage(typ MessageType, p io.Serializable) *Message

NewMessage creates a new message of the specified type.

func (*Message) DecodeBinary

func (m *Message) DecodeBinary(r *io.BinReader)

DecodeBinary implements the io.Serializable interface.

func (*Message) EncodeBinary

func (m *Message) EncodeBinary(w *io.BinWriter)

EncodeBinary implements the io.Serializable interface.

type MessageType

type MessageType byte

MessageType represents message type.

const (
	VoteT MessageType = 0
	RootT MessageType = 1
)

Various message types.

type RelayCallback

type RelayCallback = func(*payload.Extensible)

RelayCallback represents callback for sending validated state roots.

type Service

type Service interface {
	Name() string
	OnPayload(p *payload.Extensible) error
	AddSignature(height uint32, validatorIndex int32, sig []byte) error
	GetConfig() config.StateRoot
	// Start runs service instance in a separate goroutine.
	// The service only starts once, subsequent calls to Start are no-op.
	Start()
	// Shutdown stops the service. It can only be called once, subsequent calls
	// to Shutdown on the same instance are no-op. The instance that was stopped can
	// not be started again by calling Start (use a new instance if needed).
	Shutdown()
}

Service represents a state root service.

func New

func New(cfg config.StateRoot, sm *stateroot.Module, log *zap.Logger, bc Ledger, cb RelayCallback) (Service, error)

New returns a new state root service instance using the underlying module.

type Vote

type Vote struct {
	ValidatorIndex int32
	Height         uint32
	Signature      []byte
}

Vote represents a vote message.

func (*Vote) DecodeBinary

func (p *Vote) DecodeBinary(r *io.BinReader)

DecodeBinary implements the io.Serializable interface.

func (*Vote) EncodeBinary

func (p *Vote) EncodeBinary(w *io.BinWriter)

EncodeBinary implements the io.Serializable interface.