Struct FetchClient

pub struct FetchClient<N: NetworkPrimitives = EthNetworkPrimitives> { /* private fields */ }

Front-end API for fetching data from the network.

Following diagram illustrates how a request, See [HeadersClient::get_headers] and [BodiesClient::get_block_bodies] is handled internally.

sequenceDiagram participant Client as FetchClient participant Fetcher as StateFetcher participant State as NetworkState participant Session as Active Peer Session participant Peers as PeerManager loop Send Request, retry if retriable and remaining retries Client->>Fetcher: DownloadRequest{GetHeaders, GetBodies} Note over Client,Fetcher: Request and oneshot Sender sent via `request_tx` channel loop Process buffered requests State->>Fetcher: poll action Fetcher->>Fetcher: Select Available Peer Note over Fetcher: Peer is available if it's currently idle, no inflight requests Fetcher->>State: FetchAction::BlockDownloadRequest State->>Session: Delegate Request Note over State,Session: Request and oneshot Sender sent via `to_session_tx` channel end Session->>Session: Send Request to remote Session->>Session: Enforce Request timeout Session-->>State: Send Response Result via channel State->>Fetcher: Delegate Response Fetcher-->>Client: Send Response via channel opt Bad Response Client->>Peers: Penalize Peer end Peers->>Peers: Apply Reputation Change opt reputation dropped below threshold Peers->>State: Disconnect Session State->>Session: Delegate Disconnect end end

Trait Implementations

impl<N: NetworkPrimitives> BodiesClient for FetchClient<N>

fn get_block_bodies_with_priority( &self, request: Vec<B256>, priority: Priority, ) -> Self::Output

Sends a GetBlockBodies request to an available peer.

type Body = <N as NetworkPrimitives>::BlockBody

The body type this client fetches.

type Output = Pin<Box<dyn Future<Output = Result<WithPeerId<Vec<<N as NetworkPrimitives>::BlockBody>>, RequestError>> + Send + Sync>>

The output of the request future for querying block bodies.

fn get_block_bodies(&self, hashes: Vec<FixedBytes<32>>) -> Self::Output

Fetches the block body for the requested block.

fn get_block_body( &self, hash: FixedBytes<32>, ) -> SingleBodyRequest<Self::Output>

Fetches a single block body for the requested hash.

fn get_block_body_with_priority( &self, hash: FixedBytes<32>, priority: Priority, ) -> SingleBodyRequest<Self::Output>

Fetches a single block body for the requested hash with priority

impl<N: Clone + NetworkPrimitives> Clone for FetchClient<N>

fn clone(&self) -> FetchClient<N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Debug + NetworkPrimitives> Debug for FetchClient<N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<N: NetworkPrimitives> DownloadClient for FetchClient<N>

fn report_bad_message(&self, peer_id: PeerId)

Penalize the peer for responding with a message that violates validation rules

fn num_connected_peers(&self) -> usize

Returns how many peers the network is currently connected to.

impl<N: NetworkPrimitives> HeadersClient for FetchClient<N>

fn get_headers_with_priority( &self, request: HeadersRequest, priority: Priority, ) -> Self::Output

Sends a GetBlockHeaders request to an available peer.

type Header = <N as NetworkPrimitives>::BlockHeader

The header type this client fetches.

type Output = Either<FlattenedResponse<Result<WithPeerId<Vec<<N as NetworkPrimitives>::BlockHeader>>, RequestError>>, Ready<Result<WithPeerId<Vec<<N as NetworkPrimitives>::BlockHeader>>, RequestError>>>

The headers future type

fn get_headers(&self, request: HeadersRequest) -> Self::Output

Sends the header request to the p2p network and returns the header response received from a peer.

fn get_header(&self, start: HashOrNumber) -> SingleHeaderRequest<Self::Output>

Fetches a single header for the requested number or hash.

fn get_header_with_priority( &self, start: HashOrNumber, priority: Priority, ) -> SingleHeaderRequest<Self::Output>

Fetches a single header for the requested number or hash with priority

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes