go-ethereum: github.com/ethereum/go-ethereum/eth/fetcher Index | Files

package fetcher

import "github.com/ethereum/go-ethereum/eth/fetcher"

Package fetcher contains the announcement based blocks or transaction synchronisation.

Index

Package Files

block_fetcher.go tx_fetcher.go

type BlockFetcher Uses

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

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

func NewBlockFetcher Uses

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

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

func (*BlockFetcher) Enqueue Uses

func (f *BlockFetcher) Enqueue(peer string, block *types.Block) error

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

func (*BlockFetcher) FilterBodies Uses

func (f *BlockFetcher) FilterBodies(peer string, transactions [][]*types.Transaction, uncles [][]*types.Header, time time.Time) ([][]*types.Transaction, [][]*types.Header)

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

func (*BlockFetcher) FilterHeaders Uses

func (f *BlockFetcher) FilterHeaders(peer string, 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 (*BlockFetcher) Notify Uses

func (f *BlockFetcher) Notify(peer string, 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 (*BlockFetcher) Start Uses

func (f *BlockFetcher) Start()

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

func (*BlockFetcher) Stop Uses

func (f *BlockFetcher) Stop()

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

type TxFetcher Uses

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

TxFetcher is responsible for retrieving new transaction based on announcements.

The fetcher operates in 3 stages:

- Transactions that are newly discovered are moved into a wait list.
- After ~500ms passes, transactions from the wait list that have not been
  broadcast to us in whole are moved into a queueing area.
- When a connected peer doesn't have in-flight retrieval requests, any
  transaction queued up (and announced by the peer) are allocated to the
  peer and moved into a fetching status until it's fulfilled or fails.

The invariants of the fetcher are:

- Each tracked transaction (hash) must only be present in one of the
  three stages. This ensures that the fetcher operates akin to a finite
  state automata and there's do data leak.
- Each peer that announced transactions may be scheduled retrievals, but
  only ever one concurrently. This ensures we can immediately know what is
  missing from a reply and reschedule it.

func NewTxFetcher Uses

func NewTxFetcher(hasTx func(common.Hash) bool, addTxs func([]*types.Transaction) []error, fetchTxs func(string, []common.Hash) error) *TxFetcher

NewTxFetcher creates a transaction fetcher to retrieve transaction based on hash announcements.

func NewTxFetcherForTests Uses

func NewTxFetcherForTests(
    hasTx func(common.Hash) bool, addTxs func([]*types.Transaction) []error, fetchTxs func(string, []common.Hash) error,
    clock mclock.Clock, rand *mrand.Rand) *TxFetcher

NewTxFetcherForTests is a testing method to mock out the realtime clock with a simulated version and the internal randomness with a deterministic one.

func (*TxFetcher) Drop Uses

func (f *TxFetcher) Drop(peer string) error

Drop should be called when a peer disconnects. It cleans up all the internal data structures of the given node.

func (*TxFetcher) Enqueue Uses

func (f *TxFetcher) Enqueue(peer string, txs []*types.Transaction, direct bool) error

Enqueue imports a batch of received transaction into the transaction pool and the fetcher. This method may be called by both transaction broadcasts and direct request replies. The differentiation is important so the fetcher can re-shedule missing transactions as soon as possible.

func (*TxFetcher) Notify Uses

func (f *TxFetcher) Notify(peer string, hashes []common.Hash) error

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

func (*TxFetcher) Start Uses

func (f *TxFetcher) Start()

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

func (*TxFetcher) Stop Uses

func (f *TxFetcher) Stop()

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

Package fetcher imports 15 packages (graph) and is imported by 193 packages. Updated 2020-05-26. Refresh now. Tools for package owners.