casper_node/

effect.rs

//! Effects subsystem.
//!
//! Effects describe things that the creator of the effect intends to happen, producing a value upon
//! completion (they actually are boxed futures).
//!
//! A pinned, boxed future returning an event is called an effect and typed as an `Effect<Ev>`,
//! where `Ev` is the event's type, as every effect must have its return value either wrapped in an
//! event through [`EffectExt::event`](EffectExt::event) or ignored using
//! [`EffectExt::ignore`](EffectExt::ignore). As an example, the
//! [`handle_event`](crate::components::Component::handle_event) function of a component always
//! returns `Effect<Self::Event>`.
//!
//! # A primer on events
//!
//! There are three distinct groups of events found around the node:
//!
//! * (unbound) events: These events are not associated with a particular reactor or component and
//!   represent information or requests by themselves. An example is the
//!   [`PeerBehaviorAnnouncement`](`crate::effect::announcements::PeerBehaviorAnnouncement`), it can
//!   be emitted through an effect by different components and contains the ID of a peer that should
//!   be shunned. It is not associated with a particular reactor or component though.
//!
//!   While the node is running, these unbound events cannot exist on their own, instead they are
//!   typically converted into a concrete reactor event by the effect builder as soon as they are
//!   created.
//!
//! * reactor events: A running reactor has a single event type that encompasses all possible
//!   unbound events that can occur during its operation and all component events of components it
//!   is made of. Usually they are implemented as one large `enum` with only newtype-variants.
//!
//! * component events: Every component defines its own set of events, typically for internal use.
//!   If the component is able to process unbound events like announcements or requests, it will
//!   have a `From` implementation that allows converting them into a suitable component event.
//!
//!   Component events are also created from the return values of effects: While effects do not
//!   return events themselves when called, their return values are turned first into component
//!   events through the [`event`](EffectExt) method. In a second step, inside the
//!   reactors routing code, `wrap_effect` will then convert from component to reactor event.
//!
//! # Using effects
//!
//! To create an effect, an `EffectBuilder` will be passed in by the calling reactor runner. For
//! example, given an effect builder `effect_builder`, we can create a `set_timeout` future and turn
//! it into an effect:
//!
//! ```ignore
//! use std::time::Duration;
//! use casper_node::effect::EffectExt;
//!
//! // Note: This is our "component" event.
//! enum Event {
//!     ThreeSecondsElapsed(Duration)
//! }
//!
//! effect_builder
//!     .set_timeout(Duration::from_secs(3))
//!     .event(Event::ThreeSecondsElapsed);
//! ```
//!
//! This example will produce an effect that, after three seconds, creates an
//! `Event::ThreeSecondsElapsed`. Note that effects do nothing on their own, they need to be passed
//! to a [`reactor`](../reactor/index.html) to be executed.
//!
//! # Arbitrary effects
//!
//! While it is technically possible to turn any future into an effect, it is in general advisable
//! to only use the methods on [`EffectBuilder`] or short, anonymous futures to create effects.
//!
//! # Announcements and requests
//!
//! Events are usually classified into either announcements or requests, although these properties
//! are not reflected in the type system.
//!
//! **Announcements** are events that are essentially "fire-and-forget"; the component that created
//! the effect resulting in the creation of the announcement will never expect an "answer".
//! Announcements are often dispatched to multiple components by the reactor; since that usually
//! involves a [`clone`](`Clone::clone`), they should be kept light.
//!
//! A good example is the arrival of a new transaction passed in by a client. Depending on the setup
//! it may be stored, buffered or, in certain testing setups, just discarded. None of this is a
//! concern of the component that talks to the client and deserializes the incoming transaction
//! though, instead it simply returns an effect that produces an announcement.
//!
//! **Requests** are complex events that are used when a component needs something from other
//! components. Typically, an effect (which uses [`EffectBuilder::make_request`] in its
//! implementation) is called resulting in the actual request being scheduled and handled. In
//! contrast to announcements, requests must always be handled by exactly one component.
//!
//! Every request has a [`Responder`]-typed field, which a handler of a request calls to produce
//! another effect that will send the return value to the original requesting component. Failing to
//! call the [`Responder::respond`] function will result in a runtime warning.

pub(crate) mod announcements;
pub(crate) mod diagnostics_port;
pub(crate) mod incoming;
pub(crate) mod requests;

use std::{
    any::type_name,
    borrow::Cow,
    collections::{BTreeMap, BTreeSet, HashMap, HashSet},
    fmt::{self, Debug, Display, Formatter},
    future::Future,
    mem,
    sync::Arc,
    time::{Duration, Instant},
};

use datasize::DataSize;
use futures::{channel::oneshot, future::BoxFuture, FutureExt};
use once_cell::sync::Lazy;
use serde::{Serialize, Serializer};
use smallvec::{smallvec, SmallVec};
use tokio::{sync::Semaphore, time};
use tracing::{debug, error, warn};

use casper_binary_port::{
    ConsensusStatus, ConsensusValidatorChanges, LastProgress, NetworkName, RecordId, Uptime,
};
use casper_storage::{
    block_store::types::ApprovalsHashes,
    data_access_layer::{
        prefixed_values::{PrefixedValuesRequest, PrefixedValuesResult},
        tagged_values::{TaggedValuesRequest, TaggedValuesResult},
        AddressableEntityResult, BalanceRequest, BalanceResult, EraValidatorsRequest,
        EraValidatorsResult, ExecutionResultsChecksumResult, PutTrieRequest, PutTrieResult,
        QueryRequest, QueryResult, SeigniorageRecipientsRequest, SeigniorageRecipientsResult,
        TrieRequest, TrieResult,
    },
    DbRawBytesSpec,
};
use casper_types::{
    execution::{Effects as ExecutionEffects, ExecutionResult},
    Approval, AvailableBlockRange, Block, BlockHash, BlockHeader, BlockSignatures,
    BlockSynchronizerStatus, BlockV2, ChainspecRawBytes, DeployHash, Digest, EntityAddr, EraId,
    ExecutionInfo, FinalitySignature, FinalitySignatureId, FinalitySignatureV2, HashAddr, Key,
    NextUpgrade, Package, PackageAddr, ProtocolUpgradeConfig, PublicKey, TimeDiff, Timestamp,
    Transaction, TransactionHash, TransactionId, Transfer, U512,
};

use crate::{
    components::{
        block_synchronizer::{
            GlobalStateSynchronizerError, GlobalStateSynchronizerResponse, TrieAccumulatorError,
            TrieAccumulatorResponse,
        },
        consensus::{ClContext, EraDump, ProposedBlock},
        contract_runtime::SpeculativeExecutionResult,
        diagnostics_port::StopAtSpec,
        fetcher::{FetchItem, FetchResult},
        gossiper::GossipItem,
        network::{blocklist::BlocklistJustification, FromIncoming, NetworkInsights},
        transaction_acceptor,
    },
    contract_runtime::ExecutionPreState,
    failpoints::FailpointActivation,
    reactor::{main_reactor::ReactorState, EventQueueHandle, QueueKind},
    types::{
        appendable_block::AppendableBlock, BlockExecutionResultsOrChunk,
        BlockExecutionResultsOrChunkId, BlockWithMetadata, ExecutableBlock, FinalizedBlock,
        InvalidProposalError, LegacyDeploy, MetaBlock, MetaBlockState, NodeId, TransactionHeader,
    },
    utils::{fmt_limit::FmtLimit, SharedFlag, Source},
};
use announcements::{
    BlockAccumulatorAnnouncement, ConsensusAnnouncement, ContractRuntimeAnnouncement,
    ControlAnnouncement, FatalAnnouncement, FetchedNewBlockAnnouncement,
    FetchedNewFinalitySignatureAnnouncement, GossiperAnnouncement, MetaBlockAnnouncement,
    PeerBehaviorAnnouncement, QueueDumpFormat, TransactionAcceptorAnnouncement,
    TransactionBufferAnnouncement, UnexecutedBlockAnnouncement, UpgradeWatcherAnnouncement,
};
use casper_storage::data_access_layer::EntryPointExistsResult;
use diagnostics_port::DumpConsensusStateRequest;
use requests::{
    AcceptTransactionRequest, BeginGossipRequest, BlockAccumulatorRequest,
    BlockSynchronizerRequest, BlockValidationRequest, ChainspecRawBytesRequest, ConsensusRequest,
    ContractRuntimeRequest, FetcherRequest, MakeBlockExecutableRequest, MarkBlockCompletedRequest,
    MetricsRequest, NetworkInfoRequest, NetworkRequest, ReactorInfoRequest, SetNodeStopRequest,
    StorageRequest, SyncGlobalStateRequest, TransactionBufferRequest, TrieAccumulatorRequest,
    UpgradeWatcherRequest,
};

/// A resource that will never be available, thus trying to acquire it will wait forever.
static UNOBTAINABLE: Lazy<Semaphore> = Lazy::new(|| Semaphore::new(0));

/// A pinned, boxed future that produces one or more events.
pub(crate) type Effect<Ev> = BoxFuture<'static, Multiple<Ev>>;

/// Multiple effects in a container.
pub(crate) type Effects<Ev> = Multiple<Effect<Ev>>;

/// A small collection of rarely more than two items.
///
/// Stored in a `SmallVec` to avoid allocations in case there are less than three items grouped. The
/// size of two items is chosen because one item is the most common use case, and large items are
/// typically boxed. In the latter case two pointers and one enum variant discriminator is almost
/// the same size as an empty vec, which is two pointers.
pub(crate) type Multiple<T> = SmallVec<[T; 2]>;

/// The type of peers that should receive the gossip message.
#[derive(Debug, Serialize, PartialEq, Eq, Hash, Copy, Clone, DataSize)]
pub(crate) enum GossipTarget {
    /// Both validators and non validators.
    Mixed(EraId),
    /// All peers.
    All,
}

impl Display for GossipTarget {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
        match self {
            GossipTarget::Mixed(era_id) => write!(formatter, "gossip target mixed for {}", era_id),
            GossipTarget::All => write!(formatter, "gossip target all"),
        }
    }
}

/// A responder satisfying a request.
#[must_use]
#[derive(DataSize)]
pub(crate) struct Responder<T> {
    /// Sender through which the response ultimately should be sent.
    sender: Option<oneshot::Sender<T>>,
    /// Reactor flag indicating shutdown.
    is_shutting_down: SharedFlag,
}

/// A responder that will automatically send a `None` on drop.
#[must_use]
#[derive(DataSize, Debug)]
pub(crate) struct AutoClosingResponder<T>(Responder<Option<T>>);

impl<T> AutoClosingResponder<T> {
    /// Creates a new auto closing responder from a responder of `Option<T>`.
    pub(crate) fn from_opt_responder(responder: Responder<Option<T>>) -> Self {
        AutoClosingResponder(responder)
    }

    /// Extracts the inner responder.
    fn into_inner(mut self) -> Responder<Option<T>> {
        let is_shutting_down = self.0.is_shutting_down;
        mem::replace(
            &mut self.0,
            Responder {
                sender: None,
                is_shutting_down,
            },
        )
    }
}

impl<T: Debug> AutoClosingResponder<T> {
    /// Send `Some(data)` to the origin of the request.
    pub(crate) async fn respond(self, data: T) {
        self.into_inner().respond(Some(data)).await;
    }

    /// Send `None` to the origin of the request.
    pub(crate) async fn respond_none(self) {
        self.into_inner().respond(None).await;
    }
}

impl<T> Drop for AutoClosingResponder<T> {
    fn drop(&mut self) {
        if let Some(sender) = self.0.sender.take() {
            debug!(
                sending_value = %self.0,
                "responding None by dropping auto-close responder"
            );
            // We still haven't answered, send an answer.
            if let Err(_unsent_value) = sender.send(None) {
                debug!(
                    unsent_value = %self.0,
                    "failed to auto-close responder, ignoring"
                );
            }
        }
    }
}

impl<T: 'static + Send> Responder<T> {
    /// Creates a new `Responder`.
    #[inline]
    fn new(sender: oneshot::Sender<T>, is_shutting_down: SharedFlag) -> Self {
        Responder {
            sender: Some(sender),
            is_shutting_down,
        }
    }

    /// Helper method for tests.
    ///
    /// Allows creating a responder manually, without observing the shutdown flag. This function
    /// should not be used, unless you are writing alternative infrastructure, e.g. for tests.
    #[cfg(test)]
    #[inline]
    pub(crate) fn without_shutdown(sender: oneshot::Sender<T>) -> Self {
        Responder::new(sender, SharedFlag::global_shared())
    }
}

impl<T: Debug> Responder<T> {
    /// Send `data` to the origin of the request.
    pub(crate) async fn respond(mut self, data: T) {
        if let Some(sender) = self.sender.take() {
            if let Err(data) = sender.send(data) {
                // If we cannot send a response down the channel, it means the original requester is
                // no longer interested in our response. This typically happens during shutdowns, or
                // in cases where an originating external request has been cancelled.

                debug!(
                    data=?FmtLimit::new(1000, &data),
                    "ignored failure to send response to request down oneshot channel"
                );
            }
        } else {
            error!(
                data=?FmtLimit::new(1000, &data),
                "tried to send a value down a responder channel, but it was already used"
            );
        }
    }
}

impl<T> Debug for Responder<T> {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
        write!(formatter, "Responder<{}>", type_name::<T>(),)
    }
}

impl<T> Display for Responder<T> {
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result {
        write!(formatter, "responder({})", type_name::<T>(),)
    }
}

impl<T> Drop for Responder<T> {
    fn drop(&mut self) {
        if self.sender.is_some() {
            if self.is_shutting_down.is_set() {
                debug!(
                    responder=?self,
                    "ignored dropping of responder during shutdown"
                );
            } else {
                // This is usually a very serious error, as another component will now be stuck.
                //
                // See the code `make_request` for more details.
                error!(
                    responder=?self,
                    "dropped without being responded to outside of shutdown"
                );
            }
        }
    }
}

impl<T> Serialize for Responder<T> {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(&format!("{:?}", self))
    }
}

impl<T> Serialize for AutoClosingResponder<T> {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        self.0.serialize(serializer)
    }
}

/// Effect extension for futures, used to convert futures into actual effects.
pub(crate) trait EffectExt: Future + Send {
    /// Finalizes a future into an effect that returns a single event.
    ///
    /// The function `f` is used to translate the returned value from an effect into an event.
    fn event<U, F>(self, f: F) -> Effects<U>
    where
        F: FnOnce(Self::Output) -> U + 'static + Send,
        U: 'static,
        Self: Sized;

    /// Finalizes a future into an effect that runs but drops the result.
    fn ignore<Ev>(self) -> Effects<Ev>;
}

/// Effect extension for futures, used to convert futures returning a `Result` into two different
/// effects.
pub(crate) trait EffectResultExt {
    /// The type the future will return if `Ok`.
    type Value;
    /// The type the future will return if `Err`.
    type Error;

    /// Finalizes a future returning a `Result` into two different effects.
    ///
    /// The function `f_ok` is used to translate the returned value from an effect into an event,
    /// while the function `f_err` does the same for a potential error.
    fn result<U, F, G>(self, f_ok: F, f_err: G) -> Effects<U>
    where
        F: FnOnce(Self::Value) -> U + 'static + Send,
        G: FnOnce(Self::Error) -> U + 'static + Send,
        U: 'static;
}

impl<T> EffectExt for T
where
    T: Future + Send + 'static + Sized,
{
    fn event<U, F>(self, f: F) -> Effects<U>
    where
        F: FnOnce(Self::Output) -> U + 'static + Send,
        U: 'static,
    {
        smallvec![self.map(f).map(|item| smallvec![item]).boxed()]
    }

    fn ignore<Ev>(self) -> Effects<Ev> {
        smallvec![self.map(|_| Multiple::new()).boxed()]
    }
}

impl<T, V, E> EffectResultExt for T
where
    T: Future<Output = Result<V, E>> + Send + 'static + Sized,
{
    type Value = V;
    type Error = E;

    fn result<U, F, G>(self, f_ok: F, f_err: G) -> Effects<U>
    where
        F: FnOnce(V) -> U + 'static + Send,
        G: FnOnce(E) -> U + 'static + Send,
        U: 'static,
    {
        smallvec![self
            .map(|result| result.map_or_else(f_err, f_ok))
            .map(|item| smallvec![item])
            .boxed()]
    }
}

/// A builder for [`Effect`](type.Effect.html)s.
///
/// Provides methods allowing the creation of effects which need to be scheduled on the reactor's
/// event queue, without giving direct access to this queue.
///
/// The `REv` type parameter indicates which reactor event effects created by this builder will
/// produce as side effects.
#[derive(Debug)]
pub(crate) struct EffectBuilder<REv: 'static> {
    /// A handle to the referenced event queue.
    event_queue: EventQueueHandle<REv>,
}

// Implement `Clone` and `Copy` manually, as `derive` will make it depend on `REv` otherwise.
impl<REv> Clone for EffectBuilder<REv> {
    fn clone(&self) -> Self {
        *self
    }
}

impl<REv> Copy for EffectBuilder<REv> {}

impl<REv> EffectBuilder<REv> {
    /// Creates a new effect builder.
    pub(crate) fn new(event_queue: EventQueueHandle<REv>) -> Self {
        EffectBuilder { event_queue }
    }

    /// Extract the event queue handle out of the effect builder.
    pub(crate) fn into_inner(self) -> EventQueueHandle<REv> {
        self.event_queue
    }

    /// Performs a request.
    ///
    /// Given a request `Q`, that when completed will yield a result of `T`, produces a future that
    /// will
    ///
    /// 1. create an event to send the request to the respective component (thus `Q: Into<REv>`),
    /// 2. wait for a response and return it.
    ///
    /// This function is usually only used internally by effects implemented on the effects builder,
    /// but IO components may also make use of it.
    ///
    /// # Cancellation safety
    ///
    /// This future is cancellation safe: If it is dropped without being polled, it indicates
    /// that the original requester is no longer interested in the result, which will be discarded.
    pub(crate) async fn make_request<T, Q, F>(self, f: F, queue_kind: QueueKind) -> T
    where
        T: Send + 'static,
        Q: Into<REv>,
        F: FnOnce(Responder<T>) -> Q,
    {
        let (event, wait_future) = self.create_request_parts(f);

        // Schedule the request before awaiting the response.
        self.event_queue.schedule(event, queue_kind).await;
        wait_future.await
    }

    /// Creates the part necessary to make a request.
    ///
    /// A request usually consists of two parts: The request event that needs to be scheduled on the
    /// reactor queue and associated future that allows waiting for the response. This function
    /// creates both of them without processing or spawning either.
    ///
    /// Usually you will want to call the higher level `make_request` function.
    pub(crate) fn create_request_parts<T, Q, F>(self, f: F) -> (REv, impl Future<Output = T>)
    where
        T: Send + 'static,
        Q: Into<REv>,
        F: FnOnce(Responder<T>) -> Q,
    {
        // Prepare a channel.
        let (sender, receiver) = oneshot::channel();

        // Create response function.
        let responder = Responder::new(sender, self.event_queue.shutdown_flag());

        // Now inject the request event into the event loop.
        let request_event = f(responder).into();

        let fut = async move {
            match receiver.await {
                Ok(value) => value,
                Err(err) => {
                    // The channel should usually not be closed except during shutdowns, as it
                    // indicates a panic or disappearance of the remote that is
                    // supposed to process the request.
                    //
                    // If it does happen, we pretend nothing happened instead of crashing.
                    if self.event_queue.shutdown_flag().is_set() {
                        debug!(%err, channel=?type_name::<T>(), "ignoring closed channel due to shutdown");
                    } else {
                        error!(%err, channel=?type_name::<T>(), "request for channel closed, this may be a bug? \
                            check if a component is stuck from now on");
                    }

                    // We cannot produce any value to satisfy the request, so we just abandon this
                    // task by waiting on a resource we can never acquire.
                    let _ = UNOBTAINABLE.acquire().await;
                    panic!("should never obtain unobtainable semaphore");
                }
            }
        };

        (request_event, fut)
    }

    /// Run and end effect immediately.
    ///
    /// Can be used to trigger events from effects when combined with `.event`. Do not use this to
    /// "do nothing", as it will still cause a task to be spawned.
    #[inline(always)]
    #[allow(clippy::manual_async_fn)]
    pub(crate) fn immediately(self) -> impl Future<Output = ()> + Send {
        // Note: This function is implemented manually without `async` sugar because the `Send`
        // inference seems to not work in all cases otherwise.
        async {}
    }

    /// Reports a fatal error.  Normally called via the `crate::fatal!()` macro.
    ///
    /// Usually causes the node to cease operations quickly and exit/crash.
    pub(crate) async fn fatal(self, file: &'static str, line: u32, msg: String)
    where
        REv: From<FatalAnnouncement>,
    {
        self.event_queue
            .schedule(FatalAnnouncement { file, line, msg }, QueueKind::Control)
            .await;
    }

    /// Sets a timeout.
    pub(crate) async fn set_timeout(self, timeout: Duration) -> Duration {
        let then = Instant::now();
        time::sleep(timeout).await;
        then.elapsed()
    }

    /// Retrieve a snapshot of the nodes current metrics formatted as string.
    ///
    /// If an error occurred producing the metrics, `None` is returned.
    pub(crate) async fn get_metrics(self) -> Option<String>
    where
        REv: From<MetricsRequest>,
    {
        self.make_request(
            |responder| MetricsRequest::RenderNodeMetricsText { responder },
            QueueKind::Api,
        )
        .await
    }

    /// Sends a network message.
    ///
    /// The message is queued and sent, but no delivery guaranteed. Will return after the message
    /// has been buffered in the outgoing kernel buffer and thus is subject to backpressure.
    pub(crate) async fn send_message<P>(self, dest: NodeId, payload: P)
    where
        REv: From<NetworkRequest<P>>,
    {
        self.make_request(
            |responder| NetworkRequest::SendMessage {
                dest: Box::new(dest),
                payload: Box::new(payload),
                respond_after_queueing: false,
                auto_closing_responder: AutoClosingResponder::from_opt_responder(responder),
            },
            QueueKind::Network,
        )
        .await;
    }

    /// Enqueues a network message.
    ///
    /// The message is queued in "fire-and-forget" fashion, there is no guarantee that the peer
    /// will receive it. Returns as soon as the message is queued inside the networking component.
    pub(crate) async fn enqueue_message<P>(self, dest: NodeId, payload: P)
    where
        REv: From<NetworkRequest<P>>,
    {
        self.make_request(
            |responder| NetworkRequest::SendMessage {
                dest: Box::new(dest),
                payload: Box::new(payload),
                respond_after_queueing: true,
                auto_closing_responder: AutoClosingResponder::from_opt_responder(responder),
            },
            QueueKind::Network,
        )
        .await;
    }

    /// Broadcasts a network message to validator peers in the given era.
    pub(crate) async fn broadcast_message_to_validators<P>(self, payload: P, era_id: EraId)
    where
        REv: From<NetworkRequest<P>>,
    {
        self.make_request(
            |responder| {
                debug!("validator broadcast for {}", era_id);
                NetworkRequest::ValidatorBroadcast {
                    payload: Box::new(payload),
                    era_id,
                    auto_closing_responder: AutoClosingResponder::from_opt_responder(responder),
                }
            },
            QueueKind::Network,
        )
        .await;
    }

    /// Gossips a network message.
    ///
    /// A low-level "gossip" function, selects `count` randomly chosen nodes on the network,
    /// excluding the indicated ones, and sends each a copy of the message.
    ///
    /// Returns the IDs of the chosen nodes.
    pub(crate) async fn gossip_message<P>(
        self,
        payload: P,
        gossip_target: GossipTarget,
        count: usize,
        exclude: HashSet<NodeId>,
    ) -> HashSet<NodeId>
    where
        REv: From<NetworkRequest<P>>,
        P: Send,
    {
        self.make_request(
            |responder| NetworkRequest::Gossip {
                payload: Box::new(payload),
                gossip_target,
                count,
                exclude,
                auto_closing_responder: AutoClosingResponder::from_opt_responder(responder),
            },
            QueueKind::Network,
        )
        .await
        .unwrap_or_default()
    }

    /// Gets a structure describing the current network status.
    pub(crate) async fn get_network_insights(self) -> NetworkInsights
    where
        REv: From<NetworkInfoRequest>,
    {
        self.make_request(
            |responder| NetworkInfoRequest::Insight { responder },
            QueueKind::Regular,
        )
        .await
    }

    /// Gets a map of the current network peers to their socket addresses.
    pub(crate) async fn network_peers(self) -> BTreeMap<NodeId, String>
    where
        REv: From<NetworkInfoRequest>,
    {
        self.make_request(
            |responder| NetworkInfoRequest::Peers { responder },
            QueueKind::Api,
        )
        .await
    }

    /// Gets up to `count` fully-connected network peers in random order.
    pub async fn get_fully_connected_peers(self, count: usize) -> Vec<NodeId>
    where
        REv: From<NetworkInfoRequest>,
    {
        self.make_request(
            |responder| NetworkInfoRequest::FullyConnectedPeers { count, responder },
            QueueKind::NetworkInfo,
        )
        .await
    }

    /// Announces which transactions have expired.
    pub(crate) async fn announce_expired_transactions(self, hashes: Vec<TransactionHash>)
    where
        REv: From<TransactionBufferAnnouncement>,
    {
        self.event_queue
            .schedule(
                TransactionBufferAnnouncement::TransactionsExpired(hashes),
                QueueKind::Validation,
            )
            .await;
    }

    /// Announces an incoming network message.
    pub(crate) async fn announce_incoming<P>(self, sender: NodeId, payload: P)
    where
        REv: FromIncoming<P>,
    {
        self.event_queue
            .schedule(
                <REv as FromIncoming<P>>::from_incoming(sender, payload),
                QueueKind::NetworkIncoming,
            )
            .await;
    }

    /// Announces that a gossiper has received a new item, where the item's ID is the complete item.
    pub(crate) async fn announce_complete_item_received_via_gossip<T: GossipItem>(self, item: T::Id)
    where
        REv: From<GossiperAnnouncement<T>>,
    {
        assert!(
            T::ID_IS_COMPLETE_ITEM,
            "{} must be an item where the ID _is_ the complete item",
            item
        );
        self.event_queue
            .schedule(
                GossiperAnnouncement::NewCompleteItem(item),
                QueueKind::Gossip,
            )
            .await;
    }

    /// Announces that a gossiper has received a full item, where the item's ID is NOT the complete
    /// item.
    pub(crate) async fn announce_item_body_received_via_gossip<T: GossipItem>(
        self,
        item: Box<T>,
        sender: NodeId,
    ) where
        REv: From<GossiperAnnouncement<T>>,
    {
        self.event_queue
            .schedule(
                GossiperAnnouncement::NewItemBody { item, sender },
                QueueKind::Gossip,
            )
            .await;
    }

    /// Announces that the block accumulator has received and stored a new finality signature.
    pub(crate) async fn announce_finality_signature_accepted(
        self,
        finality_signature: Box<FinalitySignatureV2>,
    ) where
        REv: From<BlockAccumulatorAnnouncement>,
    {
        self.event_queue
            .schedule(
                BlockAccumulatorAnnouncement::AcceptedNewFinalitySignature { finality_signature },
                QueueKind::FinalitySignature,
            )
            .await;
    }

    /// Request that a block be made executable, if able to: `ExecutableBlock`.
    ///
    /// Completion means that the block can be enqueued for processing by the execution engine via
    /// the contract_runtime component.
    pub(crate) async fn make_block_executable(
        self,
        block_hash: BlockHash,
    ) -> Option<ExecutableBlock>
    where
        REv: From<MakeBlockExecutableRequest>,
    {
        self.make_request(
            |responder| MakeBlockExecutableRequest {
                block_hash,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Request that a block with a specific height be marked completed.
    ///
    /// Completion means that the block itself (along with its header) and all of its transactions
    /// have been persisted to storage and its global state root hash is missing no dependencies
    /// in the global state.
    pub(crate) async fn mark_block_completed(self, block_height: u64) -> bool
    where
        REv: From<MarkBlockCompletedRequest>,
    {
        self.make_request(
            |responder| MarkBlockCompletedRequest {
                block_height,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Try to accept a transaction received from the JSON-RPC server.
    pub(crate) async fn try_accept_transaction(
        self,
        transaction: Transaction,
        is_speculative: bool,
    ) -> Result<(), transaction_acceptor::Error>
    where
        REv: From<AcceptTransactionRequest>,
    {
        self.make_request(
            |responder| AcceptTransactionRequest {
                transaction,
                is_speculative,
                responder,
            },
            QueueKind::Api,
        )
        .await
    }

    /// Announces that a transaction not previously stored has now been accepted and stored.
    pub(crate) fn announce_new_transaction_accepted(
        self,
        transaction: Arc<Transaction>,
        source: Source,
    ) -> impl Future<Output = ()>
    where
        REv: From<TransactionAcceptorAnnouncement>,
    {
        self.event_queue.schedule(
            TransactionAcceptorAnnouncement::AcceptedNewTransaction {
                transaction,
                source,
            },
            QueueKind::Validation,
        )
    }

    /// Announces that we have received a gossip message from this peer,
    /// implying the peer holds the indicated item.
    pub(crate) async fn announce_gossip_received<T>(self, item_id: T::Id, sender: NodeId)
    where
        REv: From<GossiperAnnouncement<T>>,
        T: GossipItem,
    {
        self.event_queue
            .schedule(
                GossiperAnnouncement::GossipReceived { item_id, sender },
                QueueKind::Gossip,
            )
            .await;
    }

    /// Announces that we have finished gossiping the indicated item.
    pub(crate) async fn announce_finished_gossiping<T>(self, item_id: T::Id)
    where
        REv: From<GossiperAnnouncement<T>>,
        T: GossipItem,
    {
        self.event_queue
            .schedule(
                GossiperAnnouncement::FinishedGossiping(item_id),
                QueueKind::Gossip,
            )
            .await;
    }

    pub(crate) fn announce_invalid_transaction(
        self,
        transaction: Transaction,
        source: Source,
    ) -> impl Future<Output = ()>
    where
        REv: From<TransactionAcceptorAnnouncement>,
    {
        self.event_queue.schedule(
            TransactionAcceptorAnnouncement::InvalidTransaction {
                transaction,
                source,
            },
            QueueKind::Validation,
        )
    }

    /// Announces upgrade activation point read.
    pub(crate) async fn upgrade_watcher_announcement(self, maybe_next_upgrade: Option<NextUpgrade>)
    where
        REv: From<UpgradeWatcherAnnouncement>,
    {
        self.event_queue
            .schedule(
                UpgradeWatcherAnnouncement(maybe_next_upgrade),
                QueueKind::Control,
            )
            .await;
    }

    /// Announces a committed Step success.
    pub(crate) async fn announce_commit_step_success(self, era_id: EraId, effects: ExecutionEffects)
    where
        REv: From<ContractRuntimeAnnouncement>,
    {
        self.event_queue
            .schedule(
                ContractRuntimeAnnouncement::CommitStepSuccess { era_id, effects },
                QueueKind::ContractRuntime,
            )
            .await;
    }

    pub(crate) async fn update_contract_runtime_state(self, new_pre_state: ExecutionPreState)
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.event_queue
            .schedule(
                ContractRuntimeRequest::UpdatePreState { new_pre_state },
                QueueKind::ContractRuntime,
            )
            .await;
    }

    /// Announces validators for upcoming era.
    pub(crate) async fn announce_upcoming_era_validators(
        self,
        era_that_is_ending: EraId,
        upcoming_era_validators: BTreeMap<EraId, BTreeMap<PublicKey, U512>>,
    ) where
        REv: From<ContractRuntimeAnnouncement>,
    {
        self.event_queue
            .schedule(
                ContractRuntimeAnnouncement::UpcomingEraValidators {
                    era_that_is_ending,
                    upcoming_era_validators,
                },
                QueueKind::ContractRuntime,
            )
            .await;
    }

    pub(crate) async fn announce_new_era_gas_price(self, era_id: EraId, next_era_gas_price: u8)
    where
        REv: From<ContractRuntimeAnnouncement>,
    {
        self.event_queue
            .schedule(
                ContractRuntimeAnnouncement::NextEraGasPrice {
                    era_id,
                    next_era_gas_price,
                },
                QueueKind::ContractRuntime,
            )
            .await;
    }

    /// Begins gossiping an item.
    pub(crate) async fn begin_gossip<T>(self, item_id: T::Id, source: Source, target: GossipTarget)
    where
        T: GossipItem,
        REv: From<BeginGossipRequest<T>>,
    {
        self.make_request(
            |responder| BeginGossipRequest {
                item_id,
                source,
                target,
                responder,
            },
            QueueKind::Gossip,
        )
        .await;
    }

    /// Puts the given block into the linear block store.
    pub(crate) async fn put_block_to_storage(self, block: Arc<Block>) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::PutBlock { block, responder },
            QueueKind::ToStorage,
        )
        .await
    }

    /// Puts the given approvals hashes into the linear block store.
    pub(crate) async fn put_approvals_hashes_to_storage(
        self,
        approvals_hashes: Box<ApprovalsHashes>,
    ) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::PutApprovalsHashes {
                approvals_hashes,
                responder,
            },
            QueueKind::ToStorage,
        )
        .await
    }

    /// Puts the given block and approvals hashes into the linear block store.
    pub(crate) async fn put_executed_block_to_storage(
        self,
        block: Arc<BlockV2>,
        approvals_hashes: Box<ApprovalsHashes>,
        execution_results: HashMap<TransactionHash, ExecutionResult>,
    ) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::PutExecutedBlock {
                block,
                approvals_hashes,
                execution_results,
                responder,
            },
            QueueKind::ToStorage,
        )
        .await
    }

    /// Gets the requested block from the linear block store.
    pub(crate) async fn get_block_from_storage(self, block_hash: BlockHash) -> Option<Block>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetBlock {
                block_hash,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn get_block_utilization(
        self,
        era_id: EraId,
        block_height: u64,
        transaction_count: u64,
    ) -> Option<(u64, u64)>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetBlockUtilizationScore {
                era_id,
                block_height,
                switch_block_utilization: transaction_count,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn is_block_stored(self, block_hash: BlockHash) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::IsBlockStored {
                block_hash,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Gets the requested `ApprovalsHashes` from storage.
    pub(crate) async fn get_approvals_hashes_from_storage(
        self,
        block_hash: BlockHash,
    ) -> Option<ApprovalsHashes>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetApprovalsHashes {
                block_hash,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn get_raw_data(
        self,
        record_id: RecordId,
        key: Vec<u8>,
    ) -> Option<DbRawBytesSpec>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetRawData {
                record_id,
                key,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Gets the requested block header from the linear block store.
    pub(crate) async fn get_block_header_from_storage(
        self,
        block_hash: BlockHash,
        only_from_available_block_range: bool,
    ) -> Option<BlockHeader>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetBlockHeader {
                block_hash,
                only_from_available_block_range,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn get_block_header_at_height_from_storage(
        self,
        block_height: u64,
        only_from_available_block_range: bool,
    ) -> Option<BlockHeader>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetBlockHeaderByHeight {
                block_height,
                only_from_available_block_range,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn get_latest_switch_block_header_from_storage(self) -> Option<BlockHeader>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetLatestSwitchBlockHeader { responder },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn get_switch_block_header_by_era_id_from_storage(
        self,
        era_id: EraId,
    ) -> Option<BlockHeader>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetSwitchBlockHeaderByEra { era_id, responder },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Gets the requested signature for a given block hash.
    pub(crate) async fn get_signature_from_storage(
        self,
        block_hash: BlockHash,
        public_key: PublicKey,
    ) -> Option<FinalitySignature>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetBlockSignature {
                block_hash,
                public_key: Box::new(public_key),
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn get_execution_results_from_storage(
        self,
        block_hash: BlockHash,
    ) -> Option<Vec<(TransactionHash, TransactionHeader, ExecutionResult)>>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetExecutionResults {
                block_hash,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Puts a block header to storage.
    pub(crate) async fn put_block_header_to_storage(self, block_header: Box<BlockHeader>) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::PutBlockHeader {
                block_header,
                responder,
            },
            QueueKind::ToStorage,
        )
        .await
    }

    /// Puts the requested block signatures into storage.
    ///
    /// If `signatures.proofs` is empty, no attempt to store will be made, an error will be logged,
    /// and this function will return `false`.
    pub(crate) async fn put_signatures_to_storage(self, signatures: BlockSignatures) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::PutBlockSignatures {
                signatures,
                responder,
            },
            QueueKind::ToStorage,
        )
        .await
    }

    pub(crate) async fn put_finality_signature_to_storage(
        self,
        signature: FinalitySignature,
    ) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::PutFinalitySignature {
                signature: Box::new(signature),
                responder,
            },
            QueueKind::ToStorage,
        )
        .await
    }

    /// Gets the requested block's transfers from storage.
    pub(crate) async fn get_block_transfers_from_storage(
        self,
        block_hash: BlockHash,
    ) -> Option<Vec<Transfer>>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetBlockTransfers {
                block_hash,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Returns the era IDs of the blocks in which the given transactions were executed.  If none
    /// of the transactions have been executed yet, an empty set will be returned.
    pub(crate) async fn get_transactions_era_ids(
        self,
        transaction_hashes: HashSet<TransactionHash>,
    ) -> HashSet<EraId>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetTransactionsEraIds {
                transaction_hashes,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Requests the highest complete block.
    pub(crate) async fn get_highest_complete_block_from_storage(self) -> Option<Block>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetHighestCompleteBlock { responder },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Requests the highest complete block header.
    pub(crate) async fn get_highest_complete_block_header_from_storage(self) -> Option<BlockHeader>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetHighestCompleteBlockHeader { responder },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Requests the height range of fully available blocks (not just block headers).
    pub(crate) async fn get_available_block_range_from_storage(self) -> AvailableBlockRange
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetAvailableBlockRange { responder },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Synchronize global state under the given root hash.
    pub(crate) async fn sync_global_state(
        self,
        block_hash: BlockHash,
        state_root_hash: Digest,
    ) -> Result<GlobalStateSynchronizerResponse, GlobalStateSynchronizerError>
    where
        REv: From<SyncGlobalStateRequest>,
    {
        self.make_request(
            |responder| SyncGlobalStateRequest {
                block_hash,
                state_root_hash,
                responder,
            },
            QueueKind::SyncGlobalState,
        )
        .await
    }

    /// Get a trie or chunk by its ID.
    pub(crate) async fn get_trie(self, request: TrieRequest) -> TrieResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetTrie { request, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    pub(crate) async fn get_reactor_state(self) -> ReactorState
    where
        REv: From<ReactorInfoRequest>,
    {
        self.make_request(
            |responder| ReactorInfoRequest::ReactorState { responder },
            QueueKind::Regular,
        )
        .await
    }

    pub(crate) async fn get_last_progress(self) -> LastProgress
    where
        REv: From<ReactorInfoRequest>,
    {
        self.make_request(
            |responder| ReactorInfoRequest::LastProgress { responder },
            QueueKind::Regular,
        )
        .await
    }

    pub(crate) async fn get_uptime(self) -> Uptime
    where
        REv: From<ReactorInfoRequest>,
    {
        self.make_request(
            |responder| ReactorInfoRequest::Uptime { responder },
            QueueKind::Regular,
        )
        .await
    }

    pub(crate) async fn get_network_name(self) -> NetworkName
    where
        REv: From<ReactorInfoRequest>,
    {
        self.make_request(
            |responder| ReactorInfoRequest::NetworkName { responder },
            QueueKind::Regular,
        )
        .await
    }

    #[allow(unused)]
    pub(crate) async fn get_balance_holds_interval(self) -> TimeDiff
    where
        REv: From<ReactorInfoRequest>,
    {
        self.make_request(
            |responder| ReactorInfoRequest::BalanceHoldsInterval { responder },
            QueueKind::Regular,
        )
        .await
    }

    pub(crate) async fn get_block_synchronizer_status(self) -> BlockSynchronizerStatus
    where
        REv: From<BlockSynchronizerRequest>,
    {
        self.make_request(
            |responder| BlockSynchronizerRequest::Status { responder },
            QueueKind::Regular,
        )
        .await
    }

    /// Puts a trie into the trie store; succeeds only if all the children of the trie are already
    /// present in the store.
    /// Returns the digest under which the trie was stored if successful.
    pub(crate) async fn put_trie_if_all_children_present(
        self,
        request: PutTrieRequest,
    ) -> PutTrieResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::PutTrie { request, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    pub(crate) async fn get_current_gas_price(self, era_id: EraId) -> Option<u8>
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetEraGasPrice { era_id, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    pub(crate) async fn put_transaction_to_storage(self, transaction: Transaction) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::PutTransaction {
                transaction: Arc::new(transaction),
                responder,
            },
            QueueKind::ToStorage,
        )
        .await
    }

    /// Gets the requested transactions from storage.
    ///
    /// Returns the "original" transactions, which are the first received by the node, along with a
    /// potentially different set of approvals used during execution of the recorded block.
    pub(crate) async fn get_transactions_from_storage(
        self,
        transaction_hashes: Vec<TransactionHash>,
    ) -> SmallVec<[Option<(Transaction, Option<BTreeSet<Approval>>)>; 1]>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetTransactions {
                transaction_hashes,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Gets the requested transaction and its execution info from storage by TransactionHash.
    pub(crate) async fn get_transaction_and_exec_info_from_storage(
        self,
        transaction_hash: TransactionHash,
        with_finalized_approvals: bool,
    ) -> Option<(Transaction, Option<ExecutionInfo>)>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetTransactionAndExecutionInfo {
                transaction_hash,
                with_finalized_approvals,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Gets the requested legacy deploy from the legacy deploy store by DeployHash only.
    ///
    /// Returns the legacy deploy containing the set of approvals used during execution of the
    /// recorded block, if known.
    pub(crate) async fn get_stored_legacy_deploy(
        self,
        deploy_hash: DeployHash,
    ) -> Option<LegacyDeploy>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetLegacyDeploy {
                deploy_hash,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Gets the requested transaction from storage by TransactionId.
    ///
    /// Returns the "original" transaction, which is the first received by the node, along with a
    /// potentially different set of approvals used during execution of the recorded block.
    pub(crate) async fn get_stored_transaction(
        self,
        transaction_id: TransactionId,
    ) -> Option<Transaction>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetTransaction {
                transaction_id,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn is_transaction_stored(self, transaction_id: TransactionId) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::IsTransactionStored {
                transaction_id,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Stores the given execution results for the transactions in the given block in the linear
    /// block store.
    pub(crate) async fn put_execution_artifacts_to_storage(
        self,
        block_hash: BlockHash,
        block_height: u64,
        era_id: EraId,
        execution_results: HashMap<TransactionHash, ExecutionResult>,
    ) where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::PutExecutionResults {
                block_hash: Box::new(block_hash),
                block_height,
                era_id,
                execution_results,
                responder,
            },
            QueueKind::ToStorage,
        )
        .await;
    }

    /// Gets the requested block and its finality signatures.
    pub(crate) async fn get_block_at_height_with_metadata_from_storage(
        self,
        block_height: u64,
        only_from_available_block_range: bool,
    ) -> Option<BlockWithMetadata>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetBlockAndMetadataByHeight {
                block_height,
                only_from_available_block_range,
                responder,
            },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn collect_past_blocks_with_metadata(
        self,
        range: std::ops::Range<u64>,
        only_from_available_block_range: bool,
    ) -> Vec<Option<BlockWithMetadata>>
    where
        REv: From<StorageRequest>,
    {
        futures::future::join_all(range.into_iter().map(|block_height| {
            self.get_block_at_height_with_metadata_from_storage(
                block_height,
                only_from_available_block_range,
            )
        }))
        .await
        .into_iter()
        .collect()
    }

    /// Gets the requested finality signature from storage.
    pub(crate) async fn get_finality_signature_from_storage(
        self,
        id: Box<FinalitySignatureId>,
    ) -> Option<FinalitySignature>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetFinalitySignature { id, responder },
            QueueKind::FromStorage,
        )
        .await
    }

    pub(crate) async fn is_finality_signature_stored(self, id: Box<FinalitySignatureId>) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::IsFinalitySignatureStored { id, responder },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Fetches an item from a fetcher.
    pub(crate) async fn fetch<T>(
        self,
        id: T::Id,
        peer: NodeId,
        validation_metadata: Box<T::ValidationMetadata>,
    ) -> FetchResult<T>
    where
        REv: From<FetcherRequest<T>>,
        T: FetchItem + 'static,
    {
        self.make_request(
            |responder| FetcherRequest {
                id,
                peer,
                validation_metadata,
                responder,
            },
            QueueKind::Fetch,
        )
        .await
    }

    pub(crate) async fn fetch_trie(
        self,
        hash: Digest,
        peers: Vec<NodeId>,
    ) -> Result<TrieAccumulatorResponse, TrieAccumulatorError>
    where
        REv: From<TrieAccumulatorRequest>,
    {
        self.make_request(
            |responder| TrieAccumulatorRequest {
                hash,
                peers,
                responder,
            },
            QueueKind::SyncGlobalState,
        )
        .await
    }

    /// Passes the timestamp of a future block for which transactions are to be proposed.
    pub(crate) async fn request_appendable_block(
        self,
        timestamp: Timestamp,
        era_id: EraId,
        request_expiry: Timestamp,
    ) -> AppendableBlock
    where
        REv: From<TransactionBufferRequest>,
    {
        self.make_request(
            |responder| TransactionBufferRequest::GetAppendableBlock {
                timestamp,
                era_id,
                request_expiry,
                responder,
            },
            QueueKind::Consensus,
        )
        .await
    }

    /// Enqueues a finalized block execution.
    pub(crate) async fn enqueue_block_for_execution(
        self,
        executable_block: ExecutableBlock,
        meta_block_state: MetaBlockState,
    ) where
        REv: From<StorageRequest> + From<ContractRuntimeRequest>,
    {
        // Get the key block height for the current protocol version's activation point, i.e. the
        // height of the final block of the previous protocol version.
        let key_block_height_for_activation_point = self
            .make_request(
                |responder| StorageRequest::GetKeyBlockHeightForActivationPoint { responder },
                QueueKind::FromStorage,
            )
            .await
            .unwrap_or_else(|| {
                warn!("key block height for current activation point unknown");
                0
            });

        self.event_queue
            .schedule(
                ContractRuntimeRequest::EnqueueBlockForExecution {
                    executable_block,
                    key_block_height_for_activation_point,
                    meta_block_state,
                },
                QueueKind::ContractRuntime,
            )
            .await;
    }

    pub(crate) async fn enqueue_protocol_upgrade(
        self,
        upgrade_config: ProtocolUpgradeConfig,
        next_block_height: u64,
        parent_hash: BlockHash,
        parent_seed: Digest,
    ) where
        REv: From<ContractRuntimeRequest>,
    {
        self.event_queue
            .schedule(
                ContractRuntimeRequest::DoProtocolUpgrade {
                    protocol_upgrade_config: upgrade_config,
                    next_block_height,
                    parent_hash,
                    parent_seed,
                },
                QueueKind::Control,
            )
            .await;
    }

    /// Checks whether the transactions included in the block exist on the network and that
    /// the block is valid.
    pub(crate) async fn validate_block(
        self,
        sender: NodeId,
        proposed_block_height: u64,
        block: ProposedBlock<ClContext>,
    ) -> Result<(), Box<InvalidProposalError>>
    where
        REv: From<BlockValidationRequest>,
    {
        self.make_request(
            |responder| BlockValidationRequest {
                proposed_block_height,
                block,
                sender,
                responder,
            },
            QueueKind::Regular,
        )
        .await
    }

    /// Announces that a block has been proposed.
    pub(crate) async fn announce_proposed_block(self, proposed_block: ProposedBlock<ClContext>)
    where
        REv: From<ConsensusAnnouncement>,
    {
        self.event_queue
            .schedule(
                ConsensusAnnouncement::Proposed(Box::new(proposed_block)),
                QueueKind::Consensus,
            )
            .await;
    }

    /// Announces that a block has been finalized.
    pub(crate) async fn announce_finalized_block(self, finalized_block: FinalizedBlock)
    where
        REv: From<ConsensusAnnouncement>,
    {
        self.event_queue
            .schedule(
                ConsensusAnnouncement::Finalized(Box::new(finalized_block)),
                QueueKind::Consensus,
            )
            .await;
    }

    /// Announces that a meta block has been created or its state has changed.
    pub(crate) async fn announce_meta_block(self, meta_block: MetaBlock)
    where
        REv: From<MetaBlockAnnouncement>,
    {
        self.event_queue
            .schedule(MetaBlockAnnouncement(meta_block), QueueKind::Regular)
            .await;
    }

    /// Announces that a finalized block has been created, but it was not
    /// executed.
    pub(crate) async fn announce_unexecuted_block(self, block_height: u64)
    where
        REv: From<UnexecutedBlockAnnouncement>,
    {
        self.event_queue
            .schedule(
                UnexecutedBlockAnnouncement(block_height),
                QueueKind::Regular,
            )
            .await;
    }

    /// An equivocation has been detected.
    pub(crate) async fn announce_fault_event(
        self,
        era_id: EraId,
        public_key: PublicKey,
        timestamp: Timestamp,
    ) where
        REv: From<ConsensusAnnouncement>,
    {
        self.event_queue
            .schedule(
                ConsensusAnnouncement::Fault {
                    era_id,
                    public_key: Box::new(public_key),
                    timestamp,
                },
                QueueKind::Consensus,
            )
            .await;
    }

    /// Blocks a specific peer due to a transgression.
    ///
    /// This function will also emit a log message for the block.
    pub(crate) async fn announce_block_peer_with_justification(
        self,
        offender: NodeId,
        justification: BlocklistJustification,
    ) where
        REv: From<PeerBehaviorAnnouncement>,
    {
        warn!(%offender, %justification, "banning peer");
        self.event_queue
            .schedule(
                PeerBehaviorAnnouncement::OffenseCommitted {
                    offender: Box::new(offender),
                    justification: Box::new(justification),
                },
                QueueKind::NetworkInfo,
            )
            .await;
    }

    /// Gets the next scheduled upgrade, if any.
    pub(crate) async fn get_next_upgrade(self) -> Option<NextUpgrade>
    where
        REv: From<UpgradeWatcherRequest> + Send,
    {
        self.make_request(UpgradeWatcherRequest, QueueKind::Control)
            .await
    }

    /// Requests a query be executed on the Contract Runtime component.
    pub(crate) async fn query_global_state(self, request: QueryRequest) -> QueryResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::Query { request, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    /// Retrieves an `AddressableEntity` from under the given entity address (or key, if the former
    /// is not found) in global state.
    pub(crate) async fn get_addressable_entity(
        self,
        state_root_hash: Digest,
        entity_addr: EntityAddr,
    ) -> AddressableEntityResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetAddressableEntity {
                state_root_hash,
                entity_addr,
                responder,
            },
            QueueKind::ContractRuntime,
        )
        .await
    }

    /// Retrieves an `EntryPointValue` from under the given key in global state if present.
    pub(crate) async fn does_entry_point_exist(
        self,
        state_root_hash: Digest,
        contract_hash: HashAddr,
        entry_point_name: String,
    ) -> EntryPointExistsResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetEntryPointExists {
                state_root_hash,
                contract_hash,
                entry_point_name,
                responder,
            },
            QueueKind::ContractRuntime,
        )
        .await
    }

    /// Retrieves a `Package` from under the given key in global state if present.
    pub(crate) async fn get_package(
        self,
        state_root_hash: Digest,
        package_addr: PackageAddr,
    ) -> Option<Box<Package>>
    where
        REv: From<ContractRuntimeRequest>,
    {
        let key = Key::Hash(package_addr);
        let query_request = QueryRequest::new(state_root_hash, key, vec![]);

        match self.query_global_state(query_request).await {
            QueryResult::RootNotFound | QueryResult::Failure(_) => None,
            QueryResult::ValueNotFound(_) => {
                let query_request =
                    QueryRequest::new(state_root_hash, Key::SmartContract(package_addr), vec![]);
                debug!("requesting under different key");
                if let QueryResult::Success { value, .. } =
                    self.query_global_state(query_request).await
                {
                    value.into_package().map(Box::new)
                } else {
                    None
                }
            }
            QueryResult::Success { value, .. } => value
                .into_contract_package()
                .map(Package::from)
                .map(Box::new),
        }
    }

    /// Requests a query be executed on the Contract Runtime component.
    pub(crate) async fn get_balance(self, request: BalanceRequest) -> BalanceResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetBalance { request, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    /// Returns a map of validators weights for all eras as known from `root_hash`.
    ///
    /// This operation is read only.
    pub(crate) async fn get_era_validators_from_contract_runtime(
        self,
        request: EraValidatorsRequest,
    ) -> EraValidatorsResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetEraValidators { request, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    pub(crate) async fn get_seigniorage_recipients_snapshot_from_contract_runtime(
        self,
        request: SeigniorageRecipientsRequest,
    ) -> SeigniorageRecipientsResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetSeigniorageRecipients { request, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    /// Requests a query be executed on the Contract Runtime component.
    pub(crate) async fn get_tagged_values(self, request: TaggedValuesRequest) -> TaggedValuesResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetTaggedValues { request, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    pub(crate) async fn get_prefixed_values(
        self,
        request: PrefixedValuesRequest,
    ) -> PrefixedValuesResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::QueryByPrefix { request, responder },
            QueueKind::ContractRuntime,
        )
        .await
    }

    /// Returns the value of the execution results checksum stored in the ChecksumRegistry for the
    /// given state root hash.
    pub(crate) async fn get_execution_results_checksum(
        self,
        state_root_hash: Digest,
    ) -> ExecutionResultsChecksumResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::GetExecutionResultsChecksum {
                state_root_hash,
                responder,
            },
            QueueKind::ContractRuntime,
        )
        .await
    }

    /// Get our public key from consensus, and if we're a validator, the next round length.
    pub(crate) async fn consensus_status(self) -> Option<ConsensusStatus>
    where
        REv: From<ConsensusRequest>,
    {
        self.make_request(ConsensusRequest::Status, QueueKind::Consensus)
            .await
    }

    /// Returns a list of validator status changes, by public key.
    pub(crate) async fn get_consensus_validator_changes(self) -> ConsensusValidatorChanges
    where
        REv: From<ConsensusRequest>,
    {
        self.make_request(ConsensusRequest::ValidatorChanges, QueueKind::Consensus)
            .await
    }

    /// Dump consensus state for a specific era, using the supplied function to serialize the
    /// output.
    pub(crate) async fn diagnostics_port_dump_consensus_state(
        self,
        era_id: Option<EraId>,
        serialize: fn(&EraDump<'_>) -> Result<Vec<u8>, Cow<'static, str>>,
    ) -> Result<Vec<u8>, Cow<'static, str>>
    where
        REv: From<DumpConsensusStateRequest>,
    {
        self.make_request(
            |responder| DumpConsensusStateRequest {
                era_id,
                serialize,
                responder,
            },
            QueueKind::Control,
        )
        .await
    }

    /// Dump the event queue contents to the diagnostics port, using the given serializer.
    pub(crate) async fn diagnostics_port_dump_queue(self, dump_format: QueueDumpFormat)
    where
        REv: From<ControlAnnouncement>,
    {
        self.make_request(
            |responder| ControlAnnouncement::QueueDumpRequest {
                dump_format,
                finished: responder,
            },
            QueueKind::Control,
        )
        .await;
    }

    /// Activates/deactivates a failpoint from a given activation.
    pub(crate) async fn activate_failpoint(self, activation: FailpointActivation)
    where
        REv: From<ControlAnnouncement>,
    {
        self.event_queue
            .schedule(
                ControlAnnouncement::ActivateFailpoint { activation },
                QueueKind::Control,
            )
            .await;
    }

    /// Announce that the node be shut down due to a request from a user.
    pub(crate) async fn announce_user_shutdown_request(self)
    where
        REv: From<ControlAnnouncement>,
    {
        self.event_queue
            .schedule(
                ControlAnnouncement::ShutdownDueToUserRequest,
                QueueKind::Control,
            )
            .await;
    }

    /// Announce that a block which wasn't previously stored on this node has been fetched and
    /// stored.
    pub(crate) async fn announce_fetched_new_block(self, block: Arc<Block>, peer: NodeId)
    where
        REv: From<FetchedNewBlockAnnouncement>,
    {
        self.event_queue
            .schedule(
                FetchedNewBlockAnnouncement { block, peer },
                QueueKind::Fetch,
            )
            .await;
    }

    /// Announce that a finality signature which wasn't previously stored on this node has been
    /// fetched and stored.
    pub(crate) async fn announce_fetched_new_finality_signature(
        self,
        finality_signature: Box<FinalitySignature>,
        peer: NodeId,
    ) where
        REv: From<FetchedNewFinalitySignatureAnnouncement>,
    {
        self.event_queue
            .schedule(
                FetchedNewFinalitySignatureAnnouncement {
                    finality_signature,
                    peer,
                },
                QueueKind::Fetch,
            )
            .await;
    }

    /// Get the bytes for the chainspec file and genesis_accounts
    /// and global_state bytes if the files are present.
    pub(crate) async fn get_chainspec_raw_bytes(self) -> Arc<ChainspecRawBytes>
    where
        REv: From<ChainspecRawBytesRequest> + Send,
    {
        self.make_request(
            ChainspecRawBytesRequest::GetChainspecRawBytes,
            QueueKind::NetworkInfo,
        )
        .await
    }

    /// Stores a set of given finalized approvals in storage.
    ///
    /// Any previously stored finalized approvals for the given hash are quietly overwritten
    pub(crate) async fn store_finalized_approvals(
        self,
        transaction_hash: TransactionHash,
        finalized_approvals: BTreeSet<Approval>,
    ) -> bool
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::StoreFinalizedApprovals {
                transaction_hash,
                finalized_approvals,
                responder,
            },
            QueueKind::ToStorage,
        )
        .await
    }

    /// Requests execution of a single transaction, without committing its effects.  Intended to be
    /// used for debugging & discovery purposes.
    pub(crate) async fn speculatively_execute(
        self,
        block_header: Box<BlockHeader>,
        transaction: Box<Transaction>,
    ) -> SpeculativeExecutionResult
    where
        REv: From<ContractRuntimeRequest>,
    {
        self.make_request(
            |responder| ContractRuntimeRequest::SpeculativelyExecute {
                block_header,
                transaction,
                responder,
            },
            QueueKind::ContractRuntime,
        )
        .await
    }

    /// Reads block execution results (or chunk) from Storage component.
    pub(crate) async fn get_block_execution_results_or_chunk_from_storage(
        self,
        id: BlockExecutionResultsOrChunkId,
    ) -> Option<BlockExecutionResultsOrChunk>
    where
        REv: From<StorageRequest>,
    {
        self.make_request(
            |responder| StorageRequest::GetBlockExecutionResultsOrChunk { id, responder },
            QueueKind::FromStorage,
        )
        .await
    }

    /// Gets peers for a given block from the block accumulator.
    pub(crate) async fn get_block_accumulated_peers(
        self,
        block_hash: BlockHash,
    ) -> Option<Vec<NodeId>>
    where
        REv: From<BlockAccumulatorRequest>,
    {
        self.make_request(
            |responder| BlockAccumulatorRequest::GetPeersForBlock {
                block_hash,
                responder,
            },
            QueueKind::NetworkInfo,
        )
        .await
    }

    /// Set a new stopping point for the node.
    ///
    /// Returns a potentially previously set stop-at spec.
    pub(crate) async fn set_node_stop_at(self, stop_at: Option<StopAtSpec>) -> Option<StopAtSpec>
    where
        REv: From<SetNodeStopRequest>,
    {
        self.make_request(
            |responder| SetNodeStopRequest { stop_at, responder },
            QueueKind::Control,
        )
        .await
    }
}

/// Construct a fatal error effect.
///
/// This macro is a convenient wrapper around `EffectBuilder::fatal` that inserts the `file!()` and
/// `line!()` number automatically.
#[macro_export]
macro_rules! fatal {
    ($effect_builder:expr, $($arg:tt)*) => {
        $effect_builder.fatal(file!(), line!(), format!($($arg)*))
    };
}