fetcher

Documentation

Overview

Package fetcher contains the block announcement based synchronisation.

Index

• type Fetcher
  • func New(getBlock blockRetrievalFn, verifyHeader headerVerifierFn, ...) *Fetcher
  • func (f *Fetcher) Enqueue(peer libp2p.ID, block *types.Block) error
  • func (f *Fetcher) FilterBodies(peer libp2p.ID, transactions [][]*types.Transaction, time time.Time) [][]*types.Transaction
  • func (f *Fetcher) FilterHeaders(peer libp2p.ID, headers []*types.Header, time time.Time) []*types.Header
  • func (f *Fetcher) Notify(peer libp2p.ID, hash common.Hash, number uint64, time time.Time, ...) error
  • func (f *Fetcher) Start()
  • func (f *Fetcher) Stop()

Types

type Fetcher

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

Fetcher is responsible for accumulating block announcements from various peers and scheduling them for retrieval.

func New

func New(getBlock blockRetrievalFn, verifyHeader headerVerifierFn, broadcastBlock blockBroadcasterFn, chainHeight chainHeightFn, insertChain chainInsertFn, dropPeer peerDropFn) *Fetcher

New creates a block fetcher to retrieve blocks based on hash announcements.

func (*Fetcher) Enqueue

func (f *Fetcher) Enqueue(peer libp2p.ID, block *types.Block) error

Enqueue tries to fill gaps the the fetcher's future import queue.

func (*Fetcher) FilterBodies

func (f *Fetcher) FilterBodies(peer libp2p.ID, transactions [][]*types.Transaction, time time.Time) [][]*types.Transaction

FilterBodies extracts all the block bodies that were explicitly requested by the fetcher, returning those that should be handled differently.

func (*Fetcher) FilterHeaders

func (f *Fetcher) FilterHeaders(peer libp2p.ID, headers []*types.Header, time time.Time) []*types.Header

FilterHeaders extracts all the headers that were explicitly requested by the fetcher, returning those that should be handled differently.

func (*Fetcher) Notify

func (f *Fetcher) Notify(peer libp2p.ID, hash common.Hash, number uint64, time time.Time,
	headerFetcher headerRequesterFn, bodyFetcher bodyRequesterFn) error

Notify announces the fetcher of the potential availability of a new block in the network.

func (*Fetcher) Start

func (f *Fetcher) Start()

Start boots up the announcement based synchroniser, accepting and processing hash notifications and block fetches until termination requested.

func (*Fetcher) Stop

func (f *Fetcher) Stop()

Stop terminates the announcement based synchroniser, canceling all pending operations.