downloader

Documentation

Overview

Package downloader contains the manual full chain synchronisation.

Index

• Constants
• type DoneEvent
• type Downloader
  • func New(stateDb ethdb.Database, mux *event.TypeMux, hasHeader headerCheckFn, ...) *Downloader
  • func (d *Downloader) DeliverBodies(id string, transactions [][]*types.Transaction, uncles [][]*types.Header) (err error)
  • func (d *Downloader) DeliverHeaders(id string, headers []*types.Header) (err error)
  • func (d *Downloader) DeliverNodeData(id string, data [][]byte) (err error)
  • func (d *Downloader) DeliverReceipts(id string, receipts [][]*types.Receipt) (err error)
  • func (d *Downloader) GetMode() SyncMode
  • func (d *Downloader) GetPeers() *peerSet
  • func (d *Downloader) Progress() (uint64, uint64, uint64, uint64, uint64)
  • func (d *Downloader) Qos() (rtt time.Duration, ttl time.Duration, conf float64)
  • func (d *Downloader) RegisterPeer(id string, version int, name string, currentHead currentHeadRetrievalFn, ...) error
  • func (d *Downloader) Synchronise(id string, head common.Hash, td *big.Int, mode SyncMode) bool
  • func (d *Downloader) Synchronising() bool
  • func (d *Downloader) Terminate()
  • func (d *Downloader) UnregisterPeer(id string) error
• type FailedEvent
• type Progress
• type PublicDownloaderAPI
  • func NewPublicDownloaderAPI(d *Downloader, m *event.TypeMux) *PublicDownloaderAPI
  • func (api *PublicDownloaderAPI) Syncing(ctx context.Context) (rpc.Subscription, error)
• type StartEvent
• type SyncMode
  • func (m SyncMode) String() string
• type SyncingResult

Constants

const (
	MaxHashFetch    = 512 // Amount of hashes to be fetched per retrieval request
	MaxBlockFetch   = 128 // Amount of blocks to be fetched per retrieval request
	MaxHeaderFetch  = 192 // Amount of block headers to be fetched per retrieval request
	MaxSkeletonSize = 128 // Number of header fetches to need for a skeleton assembly
	MaxBodyFetch    = 128 // Amount of block bodies to be fetched per retrieval request
	MaxReceiptFetch = 256 // Amount of transaction receipts to allow fetching per request
	MaxStateFetch   = 384 // Amount of node state values to allow fetching per request

	EpochDuration   = 30000             // Duration between proof-of-work epochs
	MaxForkAncestry = 3 * EpochDuration // Maximum chain reorganisation
)

Types

type DoneEvent

type DoneEvent struct {
	Peer *peer
	Hash common.Hash
	TD   *big.Int
}

type Downloader

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

func New

func New(stateDb ethdb.Database, mux *event.TypeMux, hasHeader headerCheckFn, hasBlockAndState blockAndStateCheckFn,
	getHeader headerRetrievalFn, getBlock blockRetrievalFn, headHeader headHeaderRetrievalFn, headBlock headBlockRetrievalFn,
	headFastBlock headFastBlockRetrievalFn, commitHeadBlock headBlockCommitterFn, getTd tdRetrievalFn, insertHeaders headerChainInsertFn,
	insertBlocks blockChainInsertFn, insertReceipts receiptChainInsertFn, rollback chainRollbackFn, dropPeer peerDropFn) *Downloader

New creates a new downloader to fetch hashes and blocks from remote peers.

func (*Downloader) DeliverBodies

func (d *Downloader) DeliverBodies(id string, transactions [][]*types.Transaction, uncles [][]*types.Header) (err error)

DeliverBodies injects a new batch of block bodies received from a remote node.

func (*Downloader) DeliverHeaders

func (d *Downloader) DeliverHeaders(id string, headers []*types.Header) (err error)

DeliverHeaders injects a new batch of block headers received from a remote node into the download schedule.

func (*Downloader) DeliverNodeData

func (d *Downloader) DeliverNodeData(id string, data [][]byte) (err error)

DeliverNodeData injects a new batch of node state data received from a remote node.

func (*Downloader) DeliverReceipts

func (d *Downloader) DeliverReceipts(id string, receipts [][]*types.Receipt) (err error)

DeliverReceipts injects a new batch of receipts received from a remote node.

func (*Downloader) GetMode

func (d *Downloader) GetMode() SyncMode

Experimental getter functions for new logging.

func (*Downloader) GetPeers

func (d *Downloader) GetPeers() *peerSet

func (*Downloader) Progress

func (d *Downloader) Progress() (uint64, uint64, uint64, uint64, uint64)

Progress retrieves the synchronisation boundaries, specifically the origin block where synchronisation started at (may have failed/suspended); the block or header sync is currently at; and the latest known block which the sync targets.

In addition, during the state download phase of fast synchronisation the number of processed and the total number of known states are also returned. Otherwise these are zero.

func (*Downloader) Qos

func (d *Downloader) Qos() (rtt time.Duration, ttl time.Duration, conf float64)

func (*Downloader) RegisterPeer

func (d *Downloader) RegisterPeer(id string, version int, name string, currentHead currentHeadRetrievalFn,
	getRelHeaders relativeHeaderFetcherFn, getAbsHeaders absoluteHeaderFetcherFn, getBlockBodies blockBodyFetcherFn,
	getReceipts receiptFetcherFn, getNodeData stateFetcherFn) error

RegisterPeer injects a new download peer into the set of block source to be used for fetching hashes and blocks from.

func (*Downloader) Synchronise

func (d *Downloader) Synchronise(id string, head common.Hash, td *big.Int, mode SyncMode) bool

Synchronise tries to sync up our local block chain with a remote peer, both adding various sanity checks as well as wrapping it with various log entries.

func (*Downloader) Synchronising

func (d *Downloader) Synchronising() bool

Synchronising returns whether the downloader is currently retrieving blocks.

func (*Downloader) Terminate

func (d *Downloader) Terminate()

Terminate interrupts the downloader, canceling all pending operations. The downloader cannot be reused after calling Terminate.

func (*Downloader) UnregisterPeer

func (d *Downloader) UnregisterPeer(id string) error

UnregisterPeer remove a peer from the known list, preventing any action from the specified peer. An effort is also made to return any pending fetches into the queue.

type FailedEvent

type FailedEvent struct {
	Peer *peer
	Err  error
}

type Progress

type Progress struct {
	Origin  uint64 `json:"startingBlock"`
	Current uint64 `json:"currentBlock"`
	Height  uint64 `json:"highestBlock"`
	Pulled  uint64 `json:"pulledStates"`
	Known   uint64 `json:"knownStates"`
}

Progress gives progress indications when the node is synchronising with the Ethereum network.

type PublicDownloaderAPI

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

PublicDownloaderAPI provides an API which gives information about the current synchronisation status. It offers only methods that operates on data that can be available to anyone without security risks.

func NewPublicDownloaderAPI

func NewPublicDownloaderAPI(d *Downloader, m *event.TypeMux) *PublicDownloaderAPI

NewPublicDownloaderAPI create a new PublicDownloaderAPI.

func (*PublicDownloaderAPI) Syncing

func (api *PublicDownloaderAPI) Syncing(ctx context.Context) (rpc.Subscription, error)

Syncing provides information when this nodes starts synchronising with the Ethereum network and when it's finished.

type StartEvent

type StartEvent struct {
	Peer *peer
	Hash common.Hash
	TD   *big.Int
}

type SyncMode

type SyncMode int

SyncMode represents the synchronisation mode of the downloader.

const (
	FullSync  SyncMode = iota // Synchronise the entire blockchain history from full blocks
	FastSync                  // Quickly download the headers, full sync only at the chain head
	LightSync                 // Download only the headers and terminate afterwards
)

func (SyncMode) String

func (m SyncMode) String() string

type SyncingResult

type SyncingResult struct {
	Syncing bool     `json:"syncing"`
	Status  Progress `json:"status"`
}

SyncingResult provides information about the current synchronisation status for this node.