snow

Documentation

Index

• type Context
  • func DefaultContextTest() *Context
  • func (ctx *Context) Bootstrapped()
  • func (ctx *Context) Epoch() uint32
  • func (ctx *Context) IsBootstrapped() bool
  • func (ctx *Context) IsValidatorOnly() bool
  • func (ctx *Context) SetValidatorOnly()
• type ContextInitializable
• type EventDispatcher
• type SubnetLookup

Types

type Context

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

	XChainID    ids.ID
	DJTXAssetID ids.ID

	Log                 logging.Logger
	DecisionDispatcher  EventDispatcher
	ConsensusDispatcher EventDispatcher
	Lock                sync.RWMutex
	Keystore            keystore.BlockchainKeystore
	SharedMemory        atomic.SharedMemory
	BCLookup            ids.AliaserReader
	SNLookup            SubnetLookup
	Namespace           string
	Metrics             prometheus.Registerer

	// Epoch management
	EpochFirstTransition time.Time
	EpochDuration        time.Duration
	Clock                mockable.Clock

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

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

func (*Context) Bootstrapped

func (ctx *Context) Bootstrapped()

Bootstrapped marks this chain as done bootstrapping

func (*Context) Epoch

func (ctx *Context) Epoch() uint32

Epoch this context thinks it's in based on the wall clock time.

func (*Context) IsBootstrapped

func (ctx *Context) IsBootstrapped() bool

IsBootstrapped returns true iff this chain is done bootstrapping

func (*Context) IsValidatorOnly

func (ctx *Context) IsValidatorOnly() bool

IsValidatorOnly returns true iff this chain is available only to validators

func (*Context) SetValidatorOnly

func (ctx *Context) SetValidatorOnly()

SetValidatorOnly marks this chain as available only to validators

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 {
	Issue(ctx *Context, containerID ids.ID, container []byte) error
	// 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.
	Accept(ctx *Context, containerID ids.ID, container []byte) error
	Reject(ctx *Context, containerID ids.ID, container []byte) error
}

type SubnetLookup

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