snow

Documentation

Index

• Constants
• Variables
• type Acceptor
• type ConsensusContext
  • func DefaultConsensusContextTest() *ConsensusContext
  • func (ctx *ConsensusContext) Executing(b bool)
  • func (ctx *ConsensusContext) GetState() State
  • func (ctx *ConsensusContext) IsExecuting() bool
  • func (ctx *ConsensusContext) IsValidatorOnly() bool
  • func (ctx *ConsensusContext) SetState(newState State)
  • func (ctx *ConsensusContext) SetValidatorOnly()
• type Context
  • func DefaultContextTest() *Context
• type ContextInitializable
• type EventDispatcher
• type EventDispatcherTracker
  • func NewEventDispatcherTracker() *EventDispatcherTracker
  • func (evd *EventDispatcherTracker) Accept(ctx *ConsensusContext, containerID ids.ID, container []byte) error
  • func (evd *EventDispatcherTracker) IsAccepted(containerID ids.ID) (int, bool)
  • func (evd *EventDispatcherTracker) IsIssued(containerID ids.ID) (int, bool)
  • func (evd *EventDispatcherTracker) IsRejected(containerID ids.ID) (int, bool)
  • func (evd *EventDispatcherTracker) Issue(ctx *ConsensusContext, containerID ids.ID, container []byte) error
  • func (evd *EventDispatcherTracker) Reject(ctx *ConsensusContext, containerID ids.ID, container []byte) error
• type Issuer
• type Rejector
• type State
  • func (st State) String() string
• type SubnetLookup

Constants

const (
	Initializing = iota
	StateSyncing
	Bootstrapping
	NormalOp
)

Variables

var ErrUnknownState = errors.New("unknown state")

Types

type Acceptor

type Acceptor interface {
	Accept(ctx *ConsensusContext, containerID ids.ID, container []byte) error
}

Acceptor is implemented when a struct is monitoring if a message is accepted

type ConsensusContext

type ConsensusContext struct {
	*Context

	Registerer prometheus.Registerer

	DecisionDispatcher  EventDispatcher
	ConsensusDispatcher EventDispatcher
	// contains filtered or unexported fields
}

func DefaultConsensusContextTest

func DefaultConsensusContextTest() *ConsensusContext

func (*ConsensusContext) Executing

func (ctx *ConsensusContext) Executing(b bool)

Executing marks this chain as executing or not. Set to "true" if there's an ongoing transaction.

func (*ConsensusContext) GetState

func (ctx *ConsensusContext) GetState() State

func (*ConsensusContext) IsExecuting

func (ctx *ConsensusContext) IsExecuting() bool

IsExecuting returns true iff this chain is still executing transactions.

func (*ConsensusContext) IsValidatorOnly

func (ctx *ConsensusContext) IsValidatorOnly() bool

IsValidatorOnly returns true iff this chain is available only to validators

func (*ConsensusContext) SetState

func (ctx *ConsensusContext) SetState(newState State)

func (*ConsensusContext) SetValidatorOnly

func (ctx *ConsensusContext) SetValidatorOnly()

SetValidatorOnly marks this chain as available only to validators

type Context

type Context struct {
	NetworkID uint32
	SubnetID  ids.ID
	ChainID   ids.ID
	NodeID    ids.NodeID

	XChainID    ids.ID
	AVAXAssetID ids.ID

	Log          logging.Logger
	Lock         sync.RWMutex
	Keystore     keystore.BlockchainKeystore
	SharedMemory atomic.SharedMemory
	BCLookup     ids.AliaserReader
	SNLookup     SubnetLookup
	Metrics      metrics.OptionalGatherer

	// snowman++ attributes
	ValidatorState    validators.State  // interface for P-Chain validators
	StakingLeafSigner crypto.Signer     // block signer
	StakingCertLeaf   *x509.Certificate // block certificate
}

Context is information about the current execution. [NetworkID] is the ID of the network this context exists within. [ChainID] is the ID of the chain this context exists within. [NodeID] is the ID of this node

func DefaultContextTest

func DefaultContextTest() *Context

type ContextInitializable

type ContextInitializable interface {
	// InitCtx initializes an object provided a *Context object
	InitCtx(ctx *Context)
}

ContextInitializable represents an object that can be initialized given a *Context object

type EventDispatcher

type EventDispatcher interface {
	Issuer
	// If the returned error is non-nil, the chain associated with [ctx] should shut
	// down and not commit [container] or any other container to its database as accepted.
	// Accept must be called before [containerID] is committed to the VM as accepted.
	Acceptor
	Rejector
}

type EventDispatcherTracker

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

EventDispatcherTracker tracks the dispatched events by its ID and counts. Useful for testing.

func NewEventDispatcherTracker

func NewEventDispatcherTracker() *EventDispatcherTracker

func (*EventDispatcherTracker) Accept

func (evd *EventDispatcherTracker) Accept(ctx *ConsensusContext, containerID ids.ID, container []byte) error

func (*EventDispatcherTracker) IsAccepted

func (evd *EventDispatcherTracker) IsAccepted(containerID ids.ID) (int, bool)

func (*EventDispatcherTracker) IsIssued

func (evd *EventDispatcherTracker) IsIssued(containerID ids.ID) (int, bool)

func (*EventDispatcherTracker) IsRejected

func (evd *EventDispatcherTracker) IsRejected(containerID ids.ID) (int, bool)

func (*EventDispatcherTracker) Issue

func (evd *EventDispatcherTracker) Issue(ctx *ConsensusContext, containerID ids.ID, container []byte) error

func (*EventDispatcherTracker) Reject

func (evd *EventDispatcherTracker) Reject(ctx *ConsensusContext, containerID ids.ID, container []byte) error

type Issuer

type Issuer interface {
	Issue(ctx *ConsensusContext, containerID ids.ID, container []byte) error
}

Issuer is implemented when a struct is monitoring if a message is issued

type Rejector

type Rejector interface {
	Reject(ctx *ConsensusContext, containerID ids.ID, container []byte) error
}

Rejector is implemented when a struct is monitoring if a message is rejected

type State

type State uint8

func (State) String

func (st State) String() string

type SubnetLookup

type SubnetLookup interface {
	SubnetID(chainID ids.ID) (ids.ID, error)
}