snow

README

Flow of a Single Blockchain

graph LR
    A[P2P] --> B[Chain Router]
    B --> C[Handler]
    C --> D[Consensus Engine]
    D --> E[Consensus]
    D --> F[VM]
    D --> G[DB]
    D --> I[Sender]
    F --> G
    I --> A
    I --> B 

Intro

The Avalanche network consists of 3 built-in blockchains: X-Chain, C-Chain, and P-Chain. The X-Chain is used to manage assets and uses the Avalanche consensus protocol. The C-Chain is used to create and interact with smart contracts and uses the Snowman consensus protocol. The P-Chain is used to coordinate validators and stake and also uses the Snowman consensus protocol. At the time of writing, the Avalanche network has ~1200 validators. A set of validators makes up a subnet. Subnets can validate 1 or more chains. It is a common misconception that 1 subnet = 1 chain and this is shown by the primary subnet of Avalanche which is made up of the X-Chain, C-Chain, and P-Chain.

A node in the Avalanche network can either be a validator or a non-validator. A validator stakes AVAX tokens and participates in consensus to earn rewards. A non-validator does not participate in consensus or have any AVAX staked but is used as a public API. Both validators and non-validator need to have their own copy of the chain and to know the current state of the mempool. At the time of writing, there are ~1200 validators and ~1800 non-validator.

Each blockchain on Avalanche has several components: the virtual machine, database, consensus engine, sender, and handler. These components help the chain run smoothly. Blockchains also interact with the P2P layer and the chain router to send and receive messages.

P2P

Outbound Messages

The OutboundMsgBuilder interface specifies methods that build messages of type OutboundMessage. Nodes communicate to other nodes by sending OutboundMessage messages.

All messaging functions in OutboundMsgBuilder can be categorized as follows:

• Handshake
  • Nodes need to be on a certain version before they can be accepted into the network.
• State Sync
  • A new node can ask other nodes for the current state of the network. It only syncs the required state for a specific block.
• Bootstrapping
  • Nodes can ask other nodes for blocks to build their own copy of the chain. A node can fetch all blocks from the locally last accepted block to the current last accepted block in the network.
• Consensus
  • Once a node is up to tip they can participate in consensus! During consensus, a node conducts a poll to several different small random samples of the validator set. They can communicate decisons on whether or not they have accepted/rejected a block.
• App
  • VMs communicate application-specific messages to other nodes through app messages. A common example is mempool gossiping.

Currently, Avalanchego implements its own message serialization to communicate. In the future, Avalanchego will use protocol buffers to communicate.

Network

The networking interface is shared across all chains. It implements functions from the ExternalSender interface. The two functions it implements are Send and Gossip. Send sends a message of type OutboundMessage to a specific set of nodes (specified by an array of NodeIDs). Gossip sends a message of type OutboundMessage to a random group of nodes in a subnet (can be a validator or a non-validator). Gossipping is used to push transactions across the network. The networking protocol uses TLS to pass messages between peers.

Along with sending and gossiping, the networking library is also responsible for making connections and maintaining connections. Any node whether they are a validator or non-validator will attempt to connect to the primary network.

Router

The ChainRouter routes all incoming messages to its respective blockchain using ChainID. It does this by pushing all the messages onto the respective Chain handler’s queue. The ChainRouter references all existing chains on the network such as the X-chain, C-chain, P-chain and possibly any other chain. The ChainRouter handles timeouts as well. When sending messages on the P2P layer, timeouts are registered on the sender and cleared on the ChainRouter side when a response is received. If no response is received, then we trigger a timeout. Because we handle timeouts on the ChainRouter side, the handler is reliable. Peers not responding means timeouts trigger and the ChainRouter will still notify the handler of failure cases. The timeout manager within ChainRouter is also adaptive. If the network is experiencing long latencies, timeouts will then be adjusted as well.

Handler

The main function of the Handler is to pass messages from the network to the consensus engine. It receives these messages from the ChainRouter. It passes messages by pushing them onto a sync or async queue (depends on message type). Messages are then popped from the queue, parsed, and routed to the correct function in consensus engine. This can be one of the following.

• State sync message (sync queue)
• Bootstrapping message (sync queue)
• Consensus message (sync queue)
• App message (async queue)

Sender

The main role of the sender is to build and send outbound messages. It is actually a very thin wrapper around the normal networking code. The main difference here is that sender registers timeouts and tells the [router] to expect a response message. The timer starts on the sender side. If there is no response, sender will send a failed response to the [router]. If a node is repeatedly unresponsive, that node will get benched and sender will immediately start marking those messages as failed. If a sufficient amount of network deems the node benched, it might not get rewards (as a validator).

Consensus Engine

Consensus is defined as getting a group of distributed systems to agree on an outcome. In the case of the Avalanche network, consensus is achieved when validators are in agreement with the state of the blockchain. The novel consensus algorithm is documented in the white paper. There are two main consensus algorithms: Avalanche and Snowman. The engine is responsible for adding proposing a new block to consensus, repeatedly polling the network for decisions (accept/reject), and communicating that decision to the Sender.

Blockchain Creation

The Manager is what kickstarts everything in regards to blockchain creation, starting with the P-Chain. Once the P-Chain finishes bootstrapping, it will kickstart C-Chain and X-Chain and any other chain. The Manager’s job is not done yet, if a create chain transaction is seen by a validator, a whole new process to create a chain will be started by the Manager. This can happen dynamically, long after the original 3 chains are created and bootstrapped.

Documentation

Index

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

func (*AcceptorTracker) IsAccepted

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

type ConsensusContext

type ConsensusContext struct {
	*Context

	Registerer 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 avalanche, was accepted.
	DecisionAcceptor Acceptor

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

	XChainID    ids.ID
	CChainID    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
	StakingBLSKey     *bls.SecretKey    // bls signer

	// Chain-specific directory where arbitrary data can be written
	ChainDataDir string
}

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 Registerer

type Registerer interface {
	prometheus.Registerer
	prometheus.Gatherer
}

Expose gatherer interface for unit testing.

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)
}