hare3

Documentation

Overview

nolint

Index

• type Body
  • func (t *Body) DecodeScale(dec *scale.Decoder) (total int, err error)
  • func (t *Body) EncodeScale(enc *scale.Encoder) (total int, err error)
• type Config
  • func DefaultConfig() Config
  • func (cfg *Config) MarshalLogObject(encoder zapcore.ObjectEncoder) error
  • func (cfg *Config) Validate(zdist time.Duration) error
• type ConsensusOutput
• type Hare
  • func New(nodeclock nodeclock, pubsub pubsub.PublishSubsciber, db *datastore.CachedDB, ...) *Hare
  • func (h *Hare) Coins() <-chan WeakCoinOutput
  • func (h *Hare) Handler(ctx context.Context, peer p2p.Peer, buf []byte) error
  • func (h *Hare) Register(signer *signing.EdSigner)
  • func (h *Hare) Results() <-chan ConsensusOutput
  • func (h *Hare) Running() int
  • func (h *Hare) Start()
  • func (h *Hare) Stop()
• type IterRound
  • func (ir IterRound) Absolute() uint32
  • func (t *IterRound) DecodeScale(dec *scale.Decoder) (total int, err error)
  • func (ir IterRound) Delay(since IterRound) uint32
  • func (t *IterRound) EncodeScale(enc *scale.Encoder) (total int, err error)
  • func (ir IterRound) Grade(since IterRound) grade
  • func (ir IterRound) IsMessageRound() bool
• type Message
  • func (t *Message) DecodeScale(dec *scale.Decoder) (total int, err error)
  • func (t *Message) EncodeScale(enc *scale.Encoder) (total int, err error)
  • func (m *Message) MarshalLogObject(encoder zapcore.ObjectEncoder) error
  • func (m *Message) ToBytes() []byte
  • func (m *Message) ToHash() types.Hash32
  • func (m *Message) ToMalfeasanceProof() types.HareProofMsg
  • func (m *Message) ToMetadata() types.HareMetadata
  • func (m *Message) Validate() error
• type Opt
  • func WithConfig(cfg Config) Opt
  • func WithLogger(logger *zap.Logger) Opt
  • func WithTracer(tracer Tracer) Opt
  • func WithWallclock(clock clockwork.Clock) Opt
• type Round
  • func (r Round) String() string
• type Tracer
• type Value
  • func (t *Value) DecodeScale(dec *scale.Decoder) (total int, err error)
  • func (t *Value) EncodeScale(enc *scale.Encoder) (total int, err error)
• type WeakCoinOutput

Types

type Body

type Body struct {
	Layer types.LayerID
	IterRound
	Value       Value
	Eligibility types.HareEligibility
}

func (*Body) DecodeScale

func (t *Body) DecodeScale(dec *scale.Decoder) (total int, err error)

func (*Body) EncodeScale

func (t *Body) EncodeScale(enc *scale.Encoder) (total int, err error)

type Config

type Config struct {
	Enable          bool          `mapstructure:"enable"`
	EnableLayer     types.LayerID `mapstructure:"enable-layer"`
	DisableLayer    types.LayerID `mapstructure:"disable-layer"`
	Committee       uint16        `mapstructure:"committee"`
	Leaders         uint16        `mapstructure:"leaders"`
	IterationsLimit uint8         `mapstructure:"iterations-limit"`
	PreroundDelay   time.Duration `mapstructure:"preround-delay"`
	RoundDuration   time.Duration `mapstructure:"round-duration"`
	// LogStats if true will log iteration statistics with INFO level at the start of the next iteration.
	// This requires additional computation and should be used for debugging only.
	LogStats     bool `mapstructure:"log-stats"`
	ProtocolName string
}

func DefaultConfig

func DefaultConfig() Config

func (*Config) MarshalLogObject

func (cfg *Config) MarshalLogObject(encoder zapcore.ObjectEncoder) error

func (*Config) Validate

func (cfg *Config) Validate(zdist time.Duration) error

type ConsensusOutput

type ConsensusOutput struct {
	Layer     types.LayerID
	Proposals []types.ProposalID
}

type Hare

type Hare struct {
	// contains filtered or unexported fields
}

func New

func New(
	nodeclock nodeclock,
	pubsub pubsub.PublishSubsciber,
	db *datastore.CachedDB,
	verifier *signing.EdVerifier,
	oracle oracle,
	sync system.SyncStateProvider,
	patrol *layerpatrol.LayerPatrol,
	opts ...Opt,
) *Hare

func (*Hare) Coins

func (h *Hare) Coins() <-chan WeakCoinOutput

func (*Hare) Handler

func (h *Hare) Handler(ctx context.Context, peer p2p.Peer, buf []byte) error

func (*Hare) Register

func (h *Hare) Register(signer *signing.EdSigner)

func (*Hare) Results

func (h *Hare) Results() <-chan ConsensusOutput

func (*Hare) Running

func (h *Hare) Running() int

func (*Hare) Start

func (h *Hare) Start()

func (*Hare) Stop

func (h *Hare) Stop()

type IterRound

type IterRound struct {
	Iter  uint8
	Round Round
}

func (IterRound) Absolute

func (ir IterRound) Absolute() uint32

func (*IterRound) DecodeScale

func (t *IterRound) DecodeScale(dec *scale.Decoder) (total int, err error)

func (IterRound) Delay

func (ir IterRound) Delay(since IterRound) uint32

Delay returns number of network delays since specified iterround.

func (*IterRound) EncodeScale

func (t *IterRound) EncodeScale(enc *scale.Encoder) (total int, err error)

func (IterRound) Grade

func (ir IterRound) Grade(since IterRound) grade

func (IterRound) IsMessageRound

func (ir IterRound) IsMessageRound() bool

type Message

type Message struct {
	Body
	Sender    types.NodeID
	Signature types.EdSignature
}

func (*Message) DecodeScale

func (t *Message) DecodeScale(dec *scale.Decoder) (total int, err error)

func (*Message) EncodeScale

func (t *Message) EncodeScale(enc *scale.Encoder) (total int, err error)

func (*Message) MarshalLogObject

func (m *Message) MarshalLogObject(encoder zapcore.ObjectEncoder) error

func (*Message) ToBytes

func (m *Message) ToBytes() []byte

func (*Message) ToHash

func (m *Message) ToHash() types.Hash32

func (*Message) ToMalfeasanceProof

func (m *Message) ToMalfeasanceProof() types.HareProofMsg

func (*Message) ToMetadata

func (m *Message) ToMetadata() types.HareMetadata

func (*Message) Validate

func (m *Message) Validate() error

type Opt

type Opt func(*Hare)

func WithConfig

func WithConfig(cfg Config) Opt

func WithLogger

func WithLogger(logger *zap.Logger) Opt

func WithTracer

func WithTracer(tracer Tracer) Opt

func WithWallclock

func WithWallclock(clock clockwork.Clock) Opt

type Round

type Round uint8

func (Round) String

func (r Round) String() string

type Tracer

type Tracer interface {
	OnStart(types.LayerID)
	OnStop(types.LayerID)
	OnActive([]*types.HareEligibility)
	OnMessageSent(*Message)
	OnMessageReceived(*Message)
}

type Value

type Value struct {
	// Proposals is set in messages for preround and propose rounds.
	Proposals []types.ProposalID `scale:"max=500"`
	// Reference is set in messages for commit and notify rounds.
	Reference *types.Hash32
}

func (*Value) DecodeScale

func (t *Value) DecodeScale(dec *scale.Decoder) (total int, err error)

func (*Value) EncodeScale

func (t *Value) EncodeScale(enc *scale.Encoder) (total int, err error)

type WeakCoinOutput

type WeakCoinOutput struct {
	Layer types.LayerID
	Coin  bool
}