Documentation ¶
Overview ¶
Package downloader contains the manual full chain synchronisation.
Index ¶
- Constants
- Variables
- type BlockChain
- type BlockChainWrapper
- func (bw *BlockChainWrapper) CurrentBlock() *types.Block
- func (bw *BlockChainWrapper) CurrentFastBlock() *types.Block
- func (bw *BlockChainWrapper) CurrentHeader() *types.Header
- func (bw *BlockChainWrapper) FastSyncCommitHead(hash common.Hash) error
- func (bw *BlockChainWrapper) GetBlockByHash(hash common.Hash) *types.Block
- func (bw *BlockChainWrapper) GetHeaderByHash(hash common.Hash) *types.Header
- func (bw *BlockChainWrapper) HasBlock(hash common.Hash, number uint64) bool
- func (bw *BlockChainWrapper) HasHeader(hash common.Hash, number uint64) bool
- func (bw *BlockChainWrapper) InsertChain(blocks types.Blocks) (int, error)
- func (bw *BlockChainWrapper) InsertHeaderChain(headers []*types.Header, checkFreq int) (int, error)
- func (bw *BlockChainWrapper) InsertReceiptChain(blocks types.Blocks, receipts []types.Receipts) (int, error)
- func (bw *BlockChainWrapper) Rollback(chain []common.Hash)
- type DoneEvent
- type Downloader
- func (d *Downloader) Cancel()
- func (d *Downloader) DeliverBodies(id string, transactions [][]*types.Transaction, extraData [][]byte) (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) DeliverOriginAndPivot(id string, headers []*types.Header) (err error)
- func (d *Downloader) DeliverPposInfo(id string, latest, pivot *types.Header) (err error)
- func (d *Downloader) DeliverPposStorage(id string, kvs []PPOSStorageKV, last bool, kvNum uint64) (err error)
- func (d *Downloader) DeliverReceipts(id string, receipts [][]*types.Receipt) (err error)
- func (d *Downloader) IsRunning() bool
- func (d *Downloader) Progress() ethereum.SyncProgress
- func (d *Downloader) RegisterLightPeer(id string, version int, peer LightPeer) error
- func (d *Downloader) RegisterPeer(id string, version int, peer Peer) error
- func (d *Downloader) Synchronise(id string, head common.Hash, bn *big.Int, mode SyncMode) error
- func (d *Downloader) Synchronising() bool
- func (d *Downloader) Terminate()
- func (d *Downloader) UnregisterPeer(id string) error
- type FailedEvent
- type FakePeer
- func (p *FakePeer) Head() (common.Hash, *big.Int)
- func (p *FakePeer) RequestBodies(hashes []common.Hash) error
- func (p *FakePeer) RequestHeadersByHash(hash common.Hash, amount int, skip int, reverse bool) error
- func (p *FakePeer) RequestHeadersByNumber(number uint64, amount int, skip int, reverse bool) error
- func (p *FakePeer) RequestNodeData(hashes []common.Hash) error
- func (p *FakePeer) RequestOriginAndPivotByCurrent(m uint64) error
- func (p *FakePeer) RequestPPOSStorage() error
- func (p *FakePeer) RequestReceipts(hashes []common.Hash) error
- type LightChain
- type LightPeer
- type PPOSStorageKV
- type Peer
- type PublicDownloaderAPI
- type StartEvent
- type SyncMode
- type SyncStatusSubscription
- type SyncingResult
Constants ¶
const (
PPOSStorageKVSizeFetch = 100 // the kv size send to peer
)
Variables ¶
var ( 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 MaxForkAncestry = 3 * params.EpochDuration // Maximum chain reorganisation )
Functions ¶
This section is empty.
Types ¶
type BlockChain ¶
type BlockChain interface { LightChain // HasBlock verifies a block's presence in the local chain. HasBlock(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.Block // CurrentFastBlock retrieves the head fast block from the local chain. CurrentFastBlock() *types.Block // FastSyncCommitHead directly commits the head block to a certain entity. FastSyncCommitHead(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) (int, error) }
BlockChain encapsulates functions required to sync a (full or fast) blockchain.
type BlockChainWrapper ¶
type BlockChainWrapper struct {
// contains filtered or unexported fields
}
BlockChainWrapper wrap functions required to sync a (full or fast) blockchain.
func NewBlockChainWrapper ¶
func NewBlockChainWrapper(chain BlockChain, engine consensus.Engine) *BlockChainWrapper
NewBlockChainWrapper create a BlockChainWrapper.
func (*BlockChainWrapper) CurrentBlock ¶
func (bw *BlockChainWrapper) CurrentBlock() *types.Block
CurrentBlock retrieves the head block from the local chain.
func (*BlockChainWrapper) CurrentFastBlock ¶
func (bw *BlockChainWrapper) CurrentFastBlock() *types.Block
CurrentFastBlock retrieves the head fast block from the local chain.
func (*BlockChainWrapper) CurrentHeader ¶
func (bw *BlockChainWrapper) CurrentHeader() *types.Header
CurrentHeader retrieves the head header from the local chain.
func (*BlockChainWrapper) FastSyncCommitHead ¶
func (bw *BlockChainWrapper) FastSyncCommitHead(hash common.Hash) error
FastSyncCommitHead directly commits the head block to a certain entity.
func (*BlockChainWrapper) GetBlockByHash ¶
func (bw *BlockChainWrapper) GetBlockByHash(hash common.Hash) *types.Block
GetBlockByHash retrieves a block from the local chain.
func (*BlockChainWrapper) GetHeaderByHash ¶
func (bw *BlockChainWrapper) GetHeaderByHash(hash common.Hash) *types.Header
GetHeaderByHash retrieves the head header from the local chain.
func (*BlockChainWrapper) HasBlock ¶
func (bw *BlockChainWrapper) HasBlock(hash common.Hash, number uint64) bool
HasBlock verifies a block's presence in the local chain.
func (*BlockChainWrapper) HasHeader ¶
func (bw *BlockChainWrapper) HasHeader(hash common.Hash, number uint64) bool
HasHeader verifies a header's presence in the local chain.
func (*BlockChainWrapper) InsertChain ¶
func (bw *BlockChainWrapper) InsertChain(blocks types.Blocks) (int, error)
InsertChain inserts a batch of blocks into the local chain.
func (*BlockChainWrapper) InsertHeaderChain ¶
InsertHeaderChain inserts a batch of headers into the local chain.
func (*BlockChainWrapper) InsertReceiptChain ¶
func (bw *BlockChainWrapper) InsertReceiptChain(blocks types.Blocks, receipts []types.Receipts) (int, error)
InsertReceiptChain inserts a batch of receipts into the local chain.
func (*BlockChainWrapper) Rollback ¶
func (bw *BlockChainWrapper) Rollback(chain []common.Hash)
Rollback removes a few recently added elements from the local chain.
type Downloader ¶
type Downloader struct {
// contains filtered or unexported fields
}
func New ¶
func New(mode SyncMode, stateDb ethdb.Database, snapshotDB snapshotdb.DB, mux *event.TypeMux, chain BlockChain, lightchain LightChain, dropPeer peerDropFn) *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) DeliverBodies ¶
func (d *Downloader) DeliverBodies(id string, transactions [][]*types.Transaction, extraData [][]byte) (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) DeliverOriginAndPivot ¶
func (d *Downloader) DeliverOriginAndPivot(id string, headers []*types.Header) (err error)
func (*Downloader) DeliverPposInfo ¶
func (d *Downloader) DeliverPposInfo(id string, latest, pivot *types.Header) (err error)
DeliverPposStorage injects a new batch of ppos storage received from a remote node.
func (*Downloader) DeliverPposStorage ¶
func (d *Downloader) DeliverPposStorage(id string, kvs []PPOSStorageKV, last bool, kvNum uint64) (err error)
DeliverPposStorage injects a new batch of ppos storage 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) IsRunning ¶
func (d *Downloader) IsRunning() bool
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 fast synchronisation the number of processed and the total number of known states are also returned. Otherwise these are zero.
func (*Downloader) RegisterLightPeer ¶
func (d *Downloader) RegisterLightPeer(id string, version int, peer LightPeer) error
RegisterLightPeer injects a light client peer, wrapping it so it appears as a regular peer.
func (*Downloader) RegisterPeer ¶
func (d *Downloader) RegisterPeer(id string, version int, 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) Synchronise ¶
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{ Err error }
type FakePeer ¶
type FakePeer struct {
// contains filtered or unexported fields
}
FakePeer is a mock downloader peer that operates on a local database instance instead of being an actual live node. It's useful for testing and to implement sync commands from an existing local database.
func NewFakePeer ¶
func NewFakePeer(id string, db ethdb.Database, sdb snapshotdb.DB, hc *core.HeaderChain, dl *Downloader) *FakePeer
NewFakePeer creates a new mock downloader peer with the given data sources.
func (*FakePeer) Head ¶
Head implements downloader.Peer, returning the current head hash and number of the best known header.
func (*FakePeer) RequestBodies ¶
RequestBodies implements downloader.Peer, returning a batch of block bodies corresponding to the specified block hashes.
func (*FakePeer) RequestHeadersByHash ¶
RequestHeadersByHash implements downloader.Peer, returning a batch of headers defined by the origin hash and the associated query parameters.
func (*FakePeer) RequestHeadersByNumber ¶
RequestHeadersByNumber implements downloader.Peer, returning a batch of headers defined by the origin number and the associated query parameters.
func (*FakePeer) RequestNodeData ¶
RequestNodeData implements downloader.Peer, returning a batch of state trie nodes corresponding to the specified trie hashes.
func (*FakePeer) RequestOriginAndPivotByCurrent ¶
func (*FakePeer) RequestPPOSStorage ¶
type LightChain ¶
type LightChain 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 // InsertHeaderChain inserts a batch of headers into the local chain. InsertHeaderChain([]*types.Header, int) (int, error) // Rollback removes a few recently added elements from the local chain. Rollback([]common.Hash) }
LightChain encapsulates functions required to synchronise a light chain.
type LightPeer ¶
type LightPeer interface { Head() (common.Hash, *big.Int) RequestHeadersByHash(common.Hash, int, int, bool) error RequestHeadersByNumber(uint64, int, int, bool) error }
LightPeer encapsulates the methods required to synchronise with a remote light peer.
type PPOSStorageKV ¶
type PPOSStorageKV [2][]byte
type Peer ¶
type Peer interface { LightPeer RequestBodies([]common.Hash) error RequestReceipts([]common.Hash) error RequestNodeData([]common.Hash) error RequestPPOSStorage() error RequestOriginAndPivotByCurrent(uint64) error }
Peer encapsulates the methods required to synchronise with a remote full peer.
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. 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 (*PublicDownloaderAPI) SubscribeSyncStatus ¶
func (api *PublicDownloaderAPI) 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 (*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{}
type SyncMode ¶
type SyncMode int
SyncMode represents the synchronisation mode of the downloader.
func (SyncMode) MarshalText ¶
func (*SyncMode) UnmarshalText ¶
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.