snow

Documentation

Index

• Constants
• Variables
• type Acceptor
• type AcceptorGroup
  • func NewAcceptorGroup(log logging.Logger) AcceptorGroup
• type AcceptorTracker
  • func NewAcceptorTracker() *AcceptorTracker
  • func (a *AcceptorTracker) Accept(ctx *ConsensusContext, containerID ids.ID, container []byte) error
  • func (a *AcceptorTracker) IsAccepted(containerID ids.ID) (int, bool)
• type AllychainLookup
• 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 State
  • func (st State) String() string

Constants

const (
	Initializing = iota
	StateSyncing
	Bootstrapping
	NormalOp
)

Variables

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

Types

type Acceptor

type Acceptor interface {
	// Accept must be called before [containerID] is committed to the VM as
	// accepted.
	//
	// 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(ctx *ConsensusContext, containerID ids.ID, container []byte) error
}

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

type AcceptorGroup

type AcceptorGroup interface {
	// Calling Accept() calls all of the registered acceptors for the relevant
	// chain.
	Acceptor

	// RegisterAcceptor causes [acceptor] to be called every time an operation
	// is accepted on chain [chainID].
	// If [dieOnError], chain [chainID] stops if Accept returns a non-nil error.
	RegisterAcceptor(chainID ids.ID, acceptorName string, acceptor Acceptor, dieOnError bool) error

	// DeregisterAcceptor removes an acceptor from the group.
	DeregisterAcceptor(chainID ids.ID, acceptorName string) error
}

func NewAcceptorGroup

func NewAcceptorGroup(log logging.Logger) AcceptorGroup

type AcceptorTracker

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

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

func NewAcceptorTracker

func NewAcceptorTracker() *AcceptorTracker

func (*AcceptorTracker) Accept

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

func (*AcceptorTracker) IsAccepted

func (a *AcceptorTracker) IsAccepted(containerID ids.ID) (int, bool)

type AllychainLookup

type AllychainLookup interface {
	AllychainID(chainID ids.ID) (ids.ID, error)
}

type ConsensusContext

type ConsensusContext struct {
	*Context

	Registerer prometheus.Registerer

	// DecisionAcceptor is the callback that will be fired whenever a VM is
	// notified that their object, either a block in snowman or a transaction
	// in axia, was accepted.
	DecisionAcceptor Acceptor

	// ConsensusAcceptor is the callback that will be fired whenever a
	// container, either a block in snowman or a vertex in axia, was
	// accepted.
	ConsensusAcceptor Acceptor
	// 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
	AllychainID ids.ID
	ChainID     ids.ID
	NodeID      ids.NodeID

	SwapChainID ids.ID
	AXCAssetID  ids.ID

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

	// snowman++ attributes
	ValidatorState    validators.State  // interface for CoreChain 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 State

type State uint8

func (State) String

func (st State) String() string