Documentation
¶
Overview ¶
Package downloader contains the manual full chain synchronisation.
Index ¶
- Constants
- Variables
- type BlockChain
- type DoneEvent
- type DownloadOption
- type Downloader
- func (d *Downloader) Cancel()
- func (d *Downloader) DeliverSnapPacket(peer *snap.Peer, packet snap.Packet) error
- func (d *Downloader) LegacySync(id string, head common.Hash, name string, td *big.Int, ttd *big.Int, ...) error
- func (d *Downloader) Progress() ethereum.SyncProgress
- func (d *Downloader) RegisterPeer(id string, version uint, peer Peer) error
- func (d *Downloader) Terminate()
- func (d *Downloader) UnregisterPeer(id string) error
- type DownloaderAPI
- type FailedEvent
- type Peer
- type StartEvent
- type SyncMode
- type SyncStatusSubscription
- type SyncingResult
Constants ¶
const ( // Deprecated: use ethconfig.FullSync FullSync = ethconfig.FullSync // Deprecated: use ethconfig.SnapSync SnapSync = ethconfig.SnapSync )
Variables ¶
var ( MaxBlockFetch = 128 // Number of blocks to be fetched per retrieval request MaxHeaderFetch = 192 // Number of block headers to be fetched per retrieval request MaxSkeletonSize = 128 // Number of header fetches needed for a skeleton assembly MaxReceiptFetch = 256 // Number of transaction receipts to allow fetching per request MaxStateFetch = 384 // Number of node state values to allow fetching per request FullMaxForkAncestry uint64 = params.FullImmutabilityThreshold // Maximum chain reorganisation (locally redeclared so tests can reduce it) )
Functions ¶
This section is empty.
Types ¶
type BlockChain ¶
type BlockChain interface {
// HasHeader verifies a header's presence in the local chain.
HasHeader(common.Hash, uint64) bool
// GetHeaderByHash retrieves a header from the local chain.
GetHeaderByHash(common.Hash) *types.Header
// CurrentHeader retrieves the head header from the local chain.
CurrentHeader() *types.Header
// GetTd returns the total difficulty of a local block.
GetTd(common.Hash, uint64) *big.Int
// InsertHeaderChain inserts a batch of headers into the local chain.
InsertHeaderChain([]*types.Header) (int, error)
// SetHead rewinds the local chain to a new head.
SetHead(uint64) error
// HasBlock verifies a block's presence in the local chain.
HasBlock(common.Hash, uint64) bool
// HasFastBlock verifies a snap block's presence in the local chain.
HasFastBlock(common.Hash, uint64) bool
// GetBlockByHash retrieves a block from the local chain.
GetBlockByHash(common.Hash) *types.Block
// CurrentBlock retrieves the head block from the local chain.
CurrentBlock() *types.Header
// CurrentSnapBlock retrieves the head snap block from the local chain.
CurrentSnapBlock() *types.Header
// SnapSyncCommitHead directly commits the head block to a certain entity.
SnapSyncCommitHead(common.Hash) error
// InsertChain inserts a batch of blocks into the local chain.
InsertChain(types.Blocks) (int, error)
// InsertReceiptChain inserts a batch of receipts into the local chain.
InsertReceiptChain(types.Blocks, []types.Receipts, uint64) (int, error)
// Snapshots returns the blockchain snapshot tree to paused it during sync.
Snapshots() *snapshot.Tree
// TrieDB retrieves the low level trie database used for interacting
// with trie nodes.
TrieDB() *triedb.Database
// UpdateChasingHead update remote best chain head, used by DA check now.
UpdateChasingHead(head *types.Header)
// AncientTail retrieves the tail the ancients blocks
AncientTail() (uint64, error)
}
BlockChain encapsulates functions required to sync a (full or snap) blockchain.
type DownloadOption ¶ added in v1.0.4
type DownloadOption func(downloader *Downloader) *Downloader
type Downloader ¶
type Downloader struct {
SnapSyncer *snap.Syncer // TODO(karalabe): make private! hack for now
// contains filtered or unexported fields
}
func New ¶
func New(stateDb ethdb.Database, mux *event.TypeMux, chain BlockChain, dropPeer peerDropFn, _ func()) *Downloader
New creates a new downloader to fetch hashes and blocks from remote peers.
func (*Downloader) Cancel ¶
func (d *Downloader) Cancel()
Cancel aborts all of the operations and waits for all download goroutines to finish before returning.
func (*Downloader) DeliverSnapPacket ¶
DeliverSnapPacket is invoked from a peer's message handler when it transmits a data packet for the local node to consume.
func (*Downloader) LegacySync ¶ added in v1.0.4
func (d *Downloader) LegacySync(id string, head common.Hash, name string, td *big.Int, ttd *big.Int, mode SyncMode) error
LegacySync tries to sync up our local blockchain with a remote peer, both adding various sanity checks and wrapping it with various log entries.
func (*Downloader) Progress ¶
func (d *Downloader) Progress() ethereum.SyncProgress
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 snap synchronisation the number of processed and the total number of known states are also returned. Otherwise these are zero.
func (*Downloader) RegisterPeer ¶
func (d *Downloader) RegisterPeer(id string, version uint, peer Peer) error
RegisterPeer injects a new download peer into the set of block source to be used for fetching hashes and blocks from.
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 DownloaderAPI ¶ added in v1.0.4
type DownloaderAPI struct {
// contains filtered or unexported fields
}
DownloaderAPI 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 NewDownloaderAPI ¶ added in v1.0.4
func NewDownloaderAPI(d *Downloader, chain *core.BlockChain, m *event.TypeMux) *DownloaderAPI
NewDownloaderAPI creates a new DownloaderAPI. The API has an internal event loop that listens for events from the downloader through the global event mux. In case it receives one of these events it broadcasts it to all syncing subscriptions that are installed through the installSyncSubscription channel.
func (*DownloaderAPI) SubscribeSyncStatus ¶ added in v1.0.4
func (api *DownloaderAPI) SubscribeSyncStatus(status chan interface{}) *SyncStatusSubscription
SubscribeSyncStatus creates a subscription that will broadcast new synchronisation updates. The given channel must receive interface values, the result can either.
func (*DownloaderAPI) Syncing ¶ added in v1.0.4
func (api *DownloaderAPI) Syncing(ctx context.Context) (*rpc.Subscription, error)
Syncing provides information when this node starts synchronising with the Ethereum network and when it's finished.
type FailedEvent ¶
type FailedEvent struct{ Err error }
type Peer ¶
type Peer interface {
Head() (common.Hash, *big.Int)
MarkLagging()
RequestHeadersByHash(common.Hash, int, int, bool, chan *eth.Response) (*eth.Request, error)
RequestHeadersByNumber(uint64, int, int, bool, chan *eth.Response) (*eth.Request, error)
RequestBodies([]common.Hash, chan *eth.Response) (*eth.Request, error)
RequestReceipts([]common.Hash, chan *eth.Response) (*eth.Request, error)
}
Peer encapsulates the methods required to synchronise with a remote full peer.
type StartEvent ¶
type StartEvent struct{}
type SyncMode ¶
SyncMode defines the sync method of the downloader. Deprecated: use ethconfig.SyncMode instead
type SyncStatusSubscription ¶
type SyncStatusSubscription struct {
// contains filtered or unexported fields
}
SyncStatusSubscription represents a syncing subscription.
func (*SyncStatusSubscription) Unsubscribe ¶
func (s *SyncStatusSubscription) Unsubscribe()
Unsubscribe uninstalls the subscription from the DownloadAPI event loop. The status channel that was passed to subscribeSyncStatus isn't used anymore after this method returns.
type SyncingResult ¶
type SyncingResult struct {
Syncing bool `json:"syncing"`
Status ethereum.SyncProgress `json:"status"`
}
SyncingResult provides information about the current synchronisation status for this node.