blocksync

Documentation

Index

• Constants
• func ValidateMsg(pb proto.Message) error
• type BlockPool
  • func NewBlockPool(start int64, requestsCh chan<- BlockRequest, errorsCh chan<- peerError) *BlockPool
  • func (pool *BlockPool) AddBlock(peerID p2p.ID, block *types.Block, blockSize int)
  • func (pool *BlockPool) GetStatus() (height int64, numPending int32, lenRequesters int)
  • func (pool *BlockPool) IsCaughtUp() bool
  • func (pool *BlockPool) MaxPeerHeight() int64
  • func (pool *BlockPool) OnStart() error
  • func (pool *BlockPool) PeekTwoBlocks() (first *types.Block, second *types.Block)
  • func (pool *BlockPool) PopRequest()
  • func (pool *BlockPool) RedoRequest(height int64) p2p.ID
  • func (pool *BlockPool) RemovePeer(peerID p2p.ID)
  • func (pool *BlockPool) SetPeerRange(peerID p2p.ID, base int64, height int64)
• type BlockRequest
• type Metrics
  • func NopMetrics() *Metrics
  • func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics
• type Reactor
  • func NewReactor(state sm.State, blockExec *sm.BlockExecutor, store *store.BlockStore, ...) *Reactor
  • func (bcR *Reactor) AddPeer(peer p2p.Peer)
  • func (bcR *Reactor) BroadcastStatusRequest()
  • func (bcR *Reactor) GetChannels() []*p2p.ChannelDescriptor
  • func (bcR *Reactor) OnStart() error
  • func (bcR *Reactor) OnStop()
  • func (bcR *Reactor) Receive(e p2p.Envelope)
  • func (bcR *Reactor) RemovePeer(peer p2p.Peer, reason interface{})
  • func (bcR *Reactor) SetLogger(l log.Logger)
  • func (bcR *Reactor) SwitchToBlockSync(state sm.State) error

Constants

const (
	// NOTE: keep up to date with bcproto.BlockResponse
	BlockResponseMessagePrefixSize   = 4
	BlockResponseMessageFieldKeySize = 1
	MaxMsgSize                       = types.MaxBlockSizeBytes +
		BlockResponseMessagePrefixSize +
		BlockResponseMessageFieldKeySize
)

const (
	// BlocksyncChannel is a channel for blocks and status updates (`BlockStore` height)
	BlocksyncChannel = byte(0x40)
)

const (
	// MetricsSubsystem is a subsystem shared by all metrics exposed by this
	// package.
	MetricsSubsystem = "blocksync"
)

Functions

func ValidateMsg

func ValidateMsg(pb proto.Message) error

ValidateMsg validates a message.

Types

type BlockPool

type BlockPool struct {
	service.BaseService
	// contains filtered or unexported fields
}

BlockPool keeps track of the block sync peers, block requests and block responses.

func NewBlockPool

func NewBlockPool(start int64, requestsCh chan<- BlockRequest, errorsCh chan<- peerError) *BlockPool

NewBlockPool returns a new BlockPool with the height equal to start. Block requests and errors will be sent to requestsCh and errorsCh accordingly.

func (*BlockPool) AddBlock

func (pool *BlockPool) AddBlock(peerID p2p.ID, block *types.Block, blockSize int)

AddBlock validates that the block comes from the peer it was expected from and calls the requester to store it. TODO: ensure that blocks come in order for each peer.

func (*BlockPool) GetStatus

func (pool *BlockPool) GetStatus() (height int64, numPending int32, lenRequesters int)

GetStatus returns pool's height, numPending requests and the number of requesters.

func (*BlockPool) IsCaughtUp

func (pool *BlockPool) IsCaughtUp() bool

IsCaughtUp returns true if this node is caught up, false - otherwise. TODO: relax conditions, prevent abuse.

func (*BlockPool) MaxPeerHeight

func (pool *BlockPool) MaxPeerHeight() int64

MaxPeerHeight returns the highest reported height.

func (*BlockPool) OnStart

func (pool *BlockPool) OnStart() error

OnStart implements service.Service by spawning requesters routine and recording pool's start time.

func (*BlockPool) PeekTwoBlocks

func (pool *BlockPool) PeekTwoBlocks() (first *types.Block, second *types.Block)

PeekTwoBlocks returns blocks at pool.height and pool.height+1. We need to see the second block's Commit to validate the first block. So we peek two blocks at a time. The caller will verify the commit.

func (*BlockPool) PopRequest

func (pool *BlockPool) PopRequest()

PopRequest pops the first block at pool.height. It must have been validated by 'second'.Commit from PeekTwoBlocks().

func (*BlockPool) RedoRequest

func (pool *BlockPool) RedoRequest(height int64) p2p.ID

RedoRequest invalidates the block at pool.height, Remove the peer and redo request from others. Returns the ID of the removed peer.

func (*BlockPool) RemovePeer

func (pool *BlockPool) RemovePeer(peerID p2p.ID)

RemovePeer removes the peer with peerID from the pool. If there's no peer with peerID, function is a no-op.

func (*BlockPool) SetPeerRange

func (pool *BlockPool) SetPeerRange(peerID p2p.ID, base int64, height int64)

SetPeerRange sets the peer's alleged blockchain base and height.

type BlockRequest

type BlockRequest struct {
	Height int64
	PeerID p2p.ID
}

BlockRequest stores a block request identified by the block Height and the PeerID responsible for delivering the block

type Metrics

type Metrics struct {
	// Whether or not a node is block syncing. 1 if yes, 0 if no.
	Syncing metrics.Gauge
}

Metrics contains metrics exposed by this package.

func NopMetrics

func NopMetrics() *Metrics

func PrometheusMetrics

func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics

type Reactor

type Reactor struct {
	p2p.BaseReactor
	// contains filtered or unexported fields
}

Reactor handles long-term catchup syncing.

func NewReactor

func NewReactor(state sm.State, blockExec *sm.BlockExecutor, store *store.BlockStore,
	blockSync bool, metrics *Metrics) *Reactor

NewReactor returns new reactor instance.

func (*Reactor) AddPeer

func (bcR *Reactor) AddPeer(peer p2p.Peer)

AddPeer implements Reactor by sending our state to peer.

func (*Reactor) BroadcastStatusRequest

func (bcR *Reactor) BroadcastStatusRequest()

BroadcastStatusRequest broadcasts `BlockStore` base and height.

func (*Reactor) GetChannels

func (bcR *Reactor) GetChannels() []*p2p.ChannelDescriptor

GetChannels implements Reactor

func (*Reactor) OnStart

func (bcR *Reactor) OnStart() error

OnStart implements service.Service.

func (*Reactor) OnStop

func (bcR *Reactor) OnStop()

OnStop implements service.Service.

func (*Reactor) Receive

func (bcR *Reactor) Receive(e p2p.Envelope)

Receive implements Reactor by handling 4 types of messages (look below).

func (*Reactor) RemovePeer

func (bcR *Reactor) RemovePeer(peer p2p.Peer, reason interface{})

RemovePeer implements Reactor by removing peer from the pool.

func (*Reactor) SetLogger

func (bcR *Reactor) SetLogger(l log.Logger)

SetLogger implements service.Service by setting the logger on reactor and pool.

func (*Reactor) SwitchToBlockSync

func (bcR *Reactor) SwitchToBlockSync(state sm.State) error

SwitchToBlockSync is called by the state sync reactor when switching to block sync.