zakura_network/peer/

handshake.rs

//! Initial [`Handshake`]s with Zebra peers over a `PeerTransport`.

use std::{
    cmp::min,
    collections::HashSet,
    fmt,
    future::Future,
    net::{IpAddr, Ipv4Addr, SocketAddr},
    panic,
    pin::Pin,
    sync::Arc,
    task::{Context, Poll},
    time::Duration,
};

use chrono::{TimeZone, Utc};
use futures::{channel::oneshot, future, pin_mut, FutureExt, SinkExt, StreamExt};
use indexmap::IndexSet;
use rand::{rngs::OsRng, RngCore};
use tokio::{
    io::{AsyncRead, AsyncWrite},
    sync::broadcast,
    task::JoinError,
    time::{error, timeout, Instant},
};
use tokio_stream::wrappers::IntervalStream;
use tokio_util::codec::Framed;
use tower::Service;
use tracing::{span, Level, Span};
use tracing_futures::Instrument;

use zakura_chain::{
    block,
    chain_tip::{ChainTip, NoChainTip},
    parameters::Network,
    serialization::{DateTime32, SerializationError},
};

use crate::{
    constants,
    meta_addr::MetaAddrChange,
    peer::{
        CancelHeartbeatTask, Client, ClientRequest, Connection, ErrorSlot, HandshakeError,
        MinimumPeerVersion, PeerError,
    },
    peer_set::{ConnectionTracker, InventoryChange},
    protocol::{
        external::{canonical_socket_addr, types::*, AddrInVersion, Codec, InventoryHash, Message},
        internal::{Request, Response},
    },
    types::MetaAddr,
    zakura::{
        P2pV2Upgrade, P2pV2UpgradeAccept, P2pV2UpgradeInit, P2pV2UpgradeReject,
        ZakuraHandshakeConfig, ZakuraLegacyNonces, ZakuraPeerId, ZakuraProtocolError,
        P2P_V2_UPGRADE_COMMAND, PRELUDE_MAGIC,
    },
    zakura::{ZakuraHandshakeConnector, ZakuraRejectReason, ZakuraUpgradeOutcome},
    BoxError, Config, PeerSocketAddr, VersionMessage,
};

#[cfg(test)]
mod tests;

/// A [`Service`] that handshakes with a remote peer and constructs a
/// client/server pair.
///
/// CORRECTNESS
///
/// To avoid hangs, each handshake (or its connector) should be:
/// - launched in a separate task, and
/// - wrapped in a timeout.
pub struct Handshake<S, C = NoChainTip>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
{
    config: Config,
    user_agent: String,
    our_services: PeerServices,
    relay: bool,

    inbound_service: S,
    address_book_updater: tokio::sync::mpsc::Sender<MetaAddrChange>,
    inv_collector: broadcast::Sender<InventoryChange>,
    minimum_peer_version: MinimumPeerVersion<C>,
    nonces: Arc<futures::lock::Mutex<IndexSet<Nonce>>>,
    zakura_handshake_connector: Option<ZakuraHandshakeConnector>,

    /// Inbound peer IPs that are exempt from the inbound-overload connection
    /// drop (operator-configured block-gossip / zcashd-compat sidecars),
    /// canonicalized for IPv4-mapped matching. Empty when unconfigured.
    protected_peer_ips: Arc<HashSet<IpAddr>>,

    parent_span: Span,
}

impl<S, C> fmt::Debug for Handshake<S, C>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
{
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        // skip the channels, they don't tell us anything useful
        f.debug_struct(std::any::type_name::<Handshake<S, C>>())
            .field("config", &self.config)
            .field("user_agent", &self.user_agent)
            .field("our_services", &self.our_services)
            .field("relay", &self.relay)
            .field("minimum_peer_version", &self.minimum_peer_version)
            .field(
                "zakura_handshake_connector",
                &self.zakura_handshake_connector,
            )
            .field("parent_span", &self.parent_span)
            .finish()
    }
}

impl<S, C> Clone for Handshake<S, C>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
{
    fn clone(&self) -> Self {
        Self {
            config: self.config.clone(),
            user_agent: self.user_agent.clone(),
            our_services: self.our_services,
            relay: self.relay,
            inbound_service: self.inbound_service.clone(),
            address_book_updater: self.address_book_updater.clone(),
            inv_collector: self.inv_collector.clone(),
            minimum_peer_version: self.minimum_peer_version.clone(),
            nonces: self.nonces.clone(),
            zakura_handshake_connector: self.zakura_handshake_connector.clone(),
            protected_peer_ips: self.protected_peer_ips.clone(),
            parent_span: self.parent_span.clone(),
        }
    }
}

impl<S, C> Handshake<S, C>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
{
    /// Returns a connection address label using this handshake's configured privacy policy.
    pub(crate) fn addr_label(&self, connected_addr: &ConnectedAddr) -> String {
        connected_addr.addr_label(self.config.expose_peer_addresses)
    }
}

/// The metadata for a peer connection.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ConnectionInfo {
    /// The connected peer address, if known.
    /// This address might not be valid for outbound connections.
    ///
    /// Peers can be connected via a transient inbound or proxy address,
    /// which will appear as the connected address to the OS and Zebra.
    pub connected_addr: ConnectedAddr,

    /// The network protocol [`VersionMessage`] sent by the remote peer.
    pub remote: VersionMessage,

    /// The network protocol [`VersionMessage`] sent by this node.
    pub local: VersionMessage,

    /// The network protocol version negotiated with the remote peer.
    ///
    /// Derived from `remote.version` and the
    /// [current `zakura_network` protocol version](constants::CURRENT_NETWORK_PROTOCOL_VERSION).
    pub negotiated_version: Version,

    /// Whether this is an inbound connection from an operator-configured
    /// protected peer (a block-gossip / zcashd-compat sidecar).
    ///
    /// Protected peers follow this node and learn the chain tip only from it,
    /// so they are exempt from the inbound-overload connection drop (their
    /// requests are still shed for backpressure, but the connection is not
    /// severed). See [`Connection::handle_inbound_overload`].
    pub is_protected_peer: bool,
}

/// Canonicalizes `ip` so an IPv4-mapped IPv6 address (`::ffff:A.B.C.D`) compares
/// equal to its plain IPv4 form, matching how inbound peer accounting keys peers.
fn canonical_ip(ip: IpAddr) -> IpAddr {
    canonical_socket_addr(SocketAddr::new(ip, 0)).ip()
}

/// The peer address that we are handshaking with.
///
/// Typically, we can rely on outbound addresses, but inbound addresses don't
/// give us enough information to reconnect to that peer.
#[derive(Copy, Clone, PartialEq, Eq)]
pub enum ConnectedAddr {
    /// The address we used to make a direct outbound connection.
    ///
    /// In an honest network, a Zcash peer is listening on this exact address
    /// and port.
    OutboundDirect {
        /// The connected outbound remote address and port.
        addr: PeerSocketAddr,
    },

    /// The address we received from the OS, when a remote peer directly
    /// connected to our Zcash listener port.
    ///
    /// In an honest network, a Zcash peer might be listening on this address,
    /// if its outbound address is the same as its listener address. But the port
    /// is an ephemeral outbound TCP port, not a listener port.
    InboundDirect {
        /// The connected inbound remote address and ephemeral port.
        ///
        /// The IP address might be the address of a Zcash peer, but the port is an ephemeral port.
        addr: PeerSocketAddr,
    },

    /// The proxy address we used to make an outbound connection.
    ///
    /// The proxy address can be used by many connections, but our own ephemeral
    /// outbound address and port can be used as an identifier for the duration
    /// of this connection.
    OutboundProxy {
        /// The remote address and port of the proxy.
        proxy_addr: SocketAddr,

        /// The local address and transient port we used to connect to the proxy.
        transient_local_addr: SocketAddr,
    },

    /// The address we received from the OS, when a remote peer connected via an
    /// inbound proxy.
    ///
    /// The proxy's ephemeral outbound address can be used as an identifier for
    /// the duration of this connection.
    InboundProxy {
        /// The local address and transient port we used to connect to the proxy.
        transient_addr: SocketAddr,
    },

    /// An isolated connection, where we deliberately don't have any connection metadata.
    Isolated,
    //
    // TODO: handle Tor onion addresses
}

/// Get an unspecified IPv4 address for `network`
pub fn get_unspecified_ipv4_addr(network: Network) -> SocketAddr {
    (Ipv4Addr::UNSPECIFIED, network.default_port()).into()
}

use ConnectedAddr::*;

impl ConnectedAddr {
    /// Returns a new outbound directly connected addr.
    pub fn new_outbound_direct(addr: PeerSocketAddr) -> ConnectedAddr {
        OutboundDirect { addr }
    }

    /// Returns a new inbound directly connected addr.
    pub fn new_inbound_direct(addr: PeerSocketAddr) -> ConnectedAddr {
        InboundDirect { addr }
    }

    /// Returns a new outbound connected addr via `proxy`.
    ///
    /// `local_addr` is the ephemeral local address of the connection.
    #[allow(unused)]
    pub fn new_outbound_proxy(proxy: SocketAddr, local_addr: SocketAddr) -> ConnectedAddr {
        OutboundProxy {
            proxy_addr: proxy,
            transient_local_addr: local_addr,
        }
    }

    /// Returns a new inbound connected addr from `proxy`.
    //
    // TODO: distinguish between direct listeners and proxy listeners in the
    //       rest of zakura-network
    #[allow(unused)]
    pub fn new_inbound_proxy(proxy: SocketAddr) -> ConnectedAddr {
        InboundProxy {
            transient_addr: proxy,
        }
    }

    /// Returns a new isolated connected addr, with no metadata.
    pub fn new_isolated() -> ConnectedAddr {
        Isolated
    }

    /// Returns a `PeerSocketAddr` that can be used to track this connection in the
    /// `AddressBook`.
    ///
    /// `None` for inbound connections, proxy connections, and isolated
    /// connections.
    ///
    /// # Correctness
    ///
    /// This address can be used for reconnection attempts, or as a permanent
    /// identifier.
    ///
    /// # Security
    ///
    /// This address must not depend on the canonical address from the `Version`
    /// message. Otherwise, malicious peers could interfere with other peers
    /// `AddressBook` state.
    ///
    /// TODO: remove the `get_` from these methods (Rust style avoids `get` prefixes)
    pub fn get_address_book_addr(&self) -> Option<PeerSocketAddr> {
        match self {
            OutboundDirect { addr } | InboundDirect { addr } => Some(*addr),
            // TODO: consider using the canonical address of the peer to track
            //       outbound proxy connections
            OutboundProxy { .. } | InboundProxy { .. } | Isolated => None,
        }
    }

    /// Returns a `PeerSocketAddr` that can be used to temporarily identify a
    /// connection.
    ///
    /// Isolated connections must not change Zebra's peer set or address book
    /// state, so they do not have an identifier.
    ///
    /// # Correctness
    ///
    /// The returned address is only valid while the original connection is
    /// open. It must not be used in the `AddressBook`, for outbound connection
    /// attempts, or as a permanent identifier.
    ///
    /// # Security
    ///
    /// This address must not depend on the canonical address from the `Version`
    /// message. Otherwise, malicious peers could interfere with other peers'
    /// `PeerSet` state.
    pub fn get_transient_addr(&self) -> Option<PeerSocketAddr> {
        match self {
            OutboundDirect { addr } => Some(*addr),
            InboundDirect { addr } => Some(*addr),
            OutboundProxy {
                transient_local_addr,
                ..
            } => Some(PeerSocketAddr::from(*transient_local_addr)),
            InboundProxy { transient_addr } => Some(PeerSocketAddr::from(*transient_addr)),
            Isolated => None,
        }
    }

    /// Returns the redacted label for this connection's address.
    pub fn get_transient_addr_label(&self) -> String {
        self.get_transient_addr()
            .map_or_else(|| "isolated".to_string(), |addr| addr.to_string())
    }

    /// Returns this connection's address using the configured privacy policy.
    pub(crate) fn addr_label(&self, expose_peer_addresses: bool) -> String {
        self.get_transient_addr().map_or_else(
            || "isolated".to_string(),
            |addr| addr.addr_label(expose_peer_addresses),
        )
    }

    /// Returns a short label for the kind of connection.
    pub fn get_short_kind_label(&self) -> &'static str {
        match self {
            OutboundDirect { .. } => "Out",
            InboundDirect { .. } => "In",
            OutboundProxy { .. } => "ProxOut",
            InboundProxy { .. } => "ProxIn",
            Isolated => "Isol",
        }
    }

    /// Returns a list of alternate remote peer addresses, which can be used for
    /// reconnection attempts.
    ///
    /// Uses the connected address, and the remote canonical address.
    ///
    /// Skips duplicates. If this is an outbound connection, also skips the
    /// remote address that we're currently connected to.
    pub fn get_alternate_addrs(
        &self,
        mut canonical_remote: PeerSocketAddr,
    ) -> impl Iterator<Item = PeerSocketAddr> {
        let addrs = match self {
            OutboundDirect { addr } => {
                // Fixup unspecified addresses and ports using known good data
                if canonical_remote.ip().is_unspecified() {
                    canonical_remote.set_ip(addr.ip());
                }
                if canonical_remote.port() == 0 {
                    canonical_remote.set_port(addr.port());
                }

                // Try the canonical remote address, if it is different from the
                // outbound address (which we already have in our address book)
                if &canonical_remote != addr {
                    vec![canonical_remote]
                } else {
                    // we didn't learn a new address from the handshake:
                    // it's the same as the outbound address, which is already in our address book
                    Vec::new()
                }
            }

            InboundDirect { addr } => {
                // Use the IP from the TCP connection, and the port the peer told us
                let maybe_addr = SocketAddr::new(addr.ip(), canonical_remote.port()).into();

                // Try both addresses, but remove one duplicate if they match
                if canonical_remote != maybe_addr {
                    vec![canonical_remote, maybe_addr]
                } else {
                    vec![canonical_remote]
                }
            }

            // Proxy addresses can't be used for reconnection attempts, but we
            // can try the canonical remote address
            OutboundProxy { .. } | InboundProxy { .. } => vec![canonical_remote],

            // Hide all metadata for isolated connections
            Isolated => Vec::new(),
        };

        addrs.into_iter()
    }

    /// Returns true if the [`ConnectedAddr`] was created for an inbound connection.
    pub fn is_inbound(&self) -> bool {
        matches!(self, InboundDirect { .. } | InboundProxy { .. })
    }

    /// Returns `true` if this is an inbound connection whose peer IP is in the
    /// operator-configured `protected_peer_ips` set (block-gossip / zcashd-compat
    /// sidecars).
    ///
    /// The peer's transient inbound IP is canonicalized (IPv4-mapped IPv6 →
    /// IPv4) before lookup, so a dual-stack `::ffff:` sidecar still matches an
    /// IPv4 configuration entry. Outbound connections are never protected: the
    /// set describes inbound sidecars that dial this node.
    pub fn is_protected_peer(&self, protected_peer_ips: &HashSet<IpAddr>) -> bool {
        if protected_peer_ips.is_empty() || !self.is_inbound() {
            return false;
        }

        self.get_transient_addr()
            .map(|addr| protected_peer_ips.contains(&canonical_ip(addr.ip())))
            .unwrap_or(false)
    }
}

impl fmt::Debug for ConnectedAddr {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let kind = self.get_short_kind_label();
        let addr = self.get_transient_addr_label();

        if matches!(self, Isolated) {
            f.write_str(kind)
        } else {
            f.debug_tuple(kind).field(&addr).finish()
        }
    }
}

/// A builder for `Handshake`.
pub struct Builder<S, C = NoChainTip>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
{
    config: Option<Config>,
    our_services: Option<PeerServices>,
    user_agent: Option<String>,
    relay: Option<bool>,

    inbound_service: Option<S>,
    address_book_updater: Option<tokio::sync::mpsc::Sender<MetaAddrChange>>,
    inv_collector: Option<broadcast::Sender<InventoryChange>>,
    zakura_handshake_connector: Option<ZakuraHandshakeConnector>,
    protected_peer_ips: Option<Arc<HashSet<IpAddr>>>,
    latest_chain_tip: C,
}

impl<S, C> Builder<S, C>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
{
    /// Provide a config.  Mandatory.
    pub fn with_config(mut self, config: Config) -> Self {
        self.config = Some(config);
        self
    }

    /// Provide a service to handle inbound requests. Mandatory.
    pub fn with_inbound_service(mut self, inbound_service: S) -> Self {
        self.inbound_service = Some(inbound_service);
        self
    }

    /// Provide a channel for registering inventory advertisements. Optional.
    ///
    /// This channel takes transient remote addresses, which the `PeerSet` uses
    /// to look up peers that have specific inventory.
    pub fn with_inventory_collector(
        mut self,
        inv_collector: broadcast::Sender<InventoryChange>,
    ) -> Self {
        self.inv_collector = Some(inv_collector);
        self
    }

    /// Provide a hook for timestamp collection. Optional.
    ///
    /// This channel takes `MetaAddr`s, permanent addresses which can be used to
    /// make outbound connections to peers.
    pub fn with_address_book_updater(
        mut self,
        address_book_updater: tokio::sync::mpsc::Sender<MetaAddrChange>,
    ) -> Self {
        self.address_book_updater = Some(address_book_updater);
        self
    }

    /// Provide the services this node advertises to other peers.  Optional.
    ///
    /// If this is unset, the node will advertise itself as a client.
    pub fn with_advertised_services(mut self, services: PeerServices) -> Self {
        self.our_services = Some(services);
        self
    }

    /// Provide this node's user agent.  Optional.
    ///
    /// This must be a valid BIP14 string.  If it is unset, the user-agent will be empty.
    pub fn with_user_agent(mut self, user_agent: String) -> Self {
        self.user_agent = Some(user_agent);
        self
    }

    /// Provide a realtime endpoint to obtain the current best chain tip block height. Optional.
    ///
    /// If this is unset, the minimum accepted protocol version for peer connections is kept
    /// constant over network upgrade activations.
    ///
    /// Use [`NoChainTip`] to explicitly provide no chain tip.
    pub fn with_latest_chain_tip<NewC>(self, latest_chain_tip: NewC) -> Builder<S, NewC>
    where
        NewC: ChainTip + Clone + Send + 'static,
    {
        Builder {
            latest_chain_tip,

            // TODO: Until Rust RFC 2528 reaches stable, we can't do `..self`
            config: self.config,
            inbound_service: self.inbound_service,
            address_book_updater: self.address_book_updater,
            our_services: self.our_services,
            user_agent: self.user_agent,
            relay: self.relay,
            inv_collector: self.inv_collector,
            zakura_handshake_connector: self.zakura_handshake_connector,
            protected_peer_ips: self.protected_peer_ips,
        }
    }

    /// Provide a handle for routing mutually capable peers to Zakura P2P v2.
    pub fn with_zakura_handshake_connector(
        mut self,
        zakura_handshake_connector: ZakuraHandshakeConnector,
    ) -> Self {
        self.zakura_handshake_connector = Some(zakura_handshake_connector);
        self
    }

    /// Provide the set of inbound peer IPs that are exempt from the
    /// inbound-overload connection drop. Optional.
    ///
    /// These are operator-configured block-gossip / zcashd-compat sidecar IPs
    /// (canonicalized for IPv4-mapped matching). If this is unset, no peer is
    /// exempted and every connection behaves exactly as before.
    pub fn with_protected_peer_ips(mut self, protected_peer_ips: Arc<HashSet<IpAddr>>) -> Self {
        self.protected_peer_ips = Some(protected_peer_ips);
        self
    }

    /// Whether to request that peers relay transactions to our node.  Optional.
    ///
    /// If this is unset, the node will not request transactions.
    pub fn want_transactions(mut self, relay: bool) -> Self {
        self.relay = Some(relay);
        self
    }

    /// Consume this builder and produce a [`Handshake`].
    ///
    /// Returns an error only if any mandatory field was unset.
    pub fn finish(self) -> Result<Handshake<S, C>, &'static str> {
        let config = self.config.ok_or("did not specify config")?;
        let inbound_service = self
            .inbound_service
            .ok_or("did not specify inbound service")?;
        let inv_collector = self.inv_collector.unwrap_or_else(|| {
            let (tx, _) = broadcast::channel(100);
            tx
        });
        let address_book_updater = self.address_book_updater.unwrap_or_else(|| {
            // No `AddressBookUpdater` for timestamp collection was passed, so create a stub
            // channel. Dropping the receiver means sends will fail, but we don't care.
            let (tx, _rx) = tokio::sync::mpsc::channel(1);
            tx
        });
        let nonces = Arc::new(futures::lock::Mutex::new(IndexSet::new()));
        let user_agent = configured_user_agent(&config, self.user_agent.unwrap_or_default());
        let our_services = configured_advertised_services(
            &config,
            self.our_services.unwrap_or_else(PeerServices::empty),
        );
        let relay = self.relay.unwrap_or(false);
        let network = config.network.clone();
        let minimum_peer_version = MinimumPeerVersion::new(self.latest_chain_tip, &network);

        Ok(Handshake {
            config,
            user_agent,
            our_services,
            relay,
            inbound_service,
            address_book_updater,
            inv_collector,
            minimum_peer_version,
            nonces,
            zakura_handshake_connector: self.zakura_handshake_connector,
            protected_peer_ips: self.protected_peer_ips.unwrap_or_default(),
            parent_span: Span::current(),
        })
    }
}

impl<S> Handshake<S, NoChainTip>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
{
    /// Create a builder that configures a [`Handshake`] service.
    pub fn builder() -> Builder<S, NoChainTip> {
        // We don't derive `Default` because the derive inserts a `where S:
        // Default` bound even though `Option<S>` implements `Default` even if
        // `S` does not.
        Builder {
            config: None,
            our_services: None,
            user_agent: None,
            relay: None,
            inbound_service: None,
            address_book_updater: None,
            inv_collector: None,
            zakura_handshake_connector: None,
            protected_peer_ips: None,
            latest_chain_tip: NoChainTip,
        }
    }
}

/// Return the services Zakura should advertise for this handshake.
fn configured_advertised_services(config: &Config, mut services: PeerServices) -> PeerServices {
    services.remove(PeerServices::NODE_P2P_V2);

    if config.v2_p2p() {
        services |= PeerServices::NODE_P2P_V2;
    }

    services
}

/// Return the user-agent Zakura should advertise for this handshake.
fn configured_user_agent(config: &Config, user_agent: String) -> String {
    if !config.v2_p2p() {
        return user_agent;
    }

    let zakura_token = format!("Zakura:{}", env!("CARGO_PKG_VERSION"));
    let trimmed_user_agent = user_agent.trim_matches('/');

    if trimmed_user_agent.is_empty() {
        format!("/{zakura_token}/")
    } else if trimmed_user_agent
        .split('/')
        .any(|token| token == zakura_token)
    {
        // The default user agent already carries the Zakura token, so
        // prepending it again would advertise `/Zakura:x/Zakura:x/`.
        format!("/{trimmed_user_agent}/")
    } else {
        format!("/{zakura_token}/{trimmed_user_agent}/")
    }
}

/// Returns true when the legacy handshake should try to route this peer to Zakura P2P v2.
fn should_attempt_zakura_upgrade(config: &Config, connection_info: &ConnectionInfo) -> bool {
    config.v2_p2p()
        && connection_info
            .remote
            .services
            .contains(PeerServices::NODE_P2P_V2)
}

/// Negotiate the Zcash network protocol version with the remote peer at `connected_addr`, using
/// the connection `peer_conn`.
///
/// We split `Handshake` into its components before calling this function, to avoid infectious
/// `Sync` bounds on the returned future.
///
/// Returns the [`VersionMessage`] sent by the remote peer, and the [`Version`] negotiated with the
/// remote peer, inside a [`ConnectionInfo`] struct.
#[allow(clippy::too_many_arguments)]
pub async fn negotiate_version<PeerTransport>(
    peer_conn: &mut Framed<PeerTransport, Codec>,
    connected_addr: &ConnectedAddr,
    config: Config,
    nonces: Arc<futures::lock::Mutex<IndexSet<Nonce>>>,
    user_agent: String,
    our_services: PeerServices,
    relay: bool,
    mut minimum_peer_version: MinimumPeerVersion<impl ChainTip>,
    is_protected_peer: bool,
) -> Result<Arc<ConnectionInfo>, HandshakeError>
where
    PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    // Create a random nonce for this connection
    let local_nonce = Nonce::default();

    // Insert the nonce for this handshake into the shared nonce set.
    // Each connection has its own connection state, and handshakes execute concurrently.
    //
    // # Correctness
    //
    // It is ok to wait for the lock here, because handshakes have a short
    // timeout, and the async mutex will be released when the task times
    // out.
    {
        let mut locked_nonces = nonces.lock().await;

        // Duplicate nonces are very rare, because they require a 64-bit random number collision,
        // and the nonce set is limited to a few hundred entries.
        let is_unique_nonce = locked_nonces.insert(local_nonce);
        if !is_unique_nonce {
            return Err(HandshakeError::LocalDuplicateNonce);
        }

        // # Security
        //
        // Limit the amount of memory used for nonces.
        // Nonces can be left in the set if the connection fails or times out between
        // the nonce being inserted, and it being removed.
        //
        // Zebra has strict connection limits, so we limit the number of nonces to
        // the configured connection limit.
        // This is a tradeoff between:
        // - avoiding memory denial of service attacks which make large numbers of connections,
        //   for example, 100 failed inbound connections takes 1 second.
        // - memory usage: 16 bytes per `Nonce`, 3.2 kB for 200 nonces
        // - collision probability: two hundred 64-bit nonces have a very low collision probability
        //   <https://en.wikipedia.org/wiki/Birthday_problem#Probability_of_a_shared_birthday_(collision)>
        while locked_nonces.len() > config.peerset_total_connection_limit() {
            locked_nonces.shift_remove_index(0);
        }

        std::mem::drop(locked_nonces);
    }

    // Don't leak our exact clock skew to our peers. On the other hand,
    // we can't deviate too much, or zcashd will get confused.
    // Inspection of the zcashd source code reveals that the timestamp
    // is only ever used at the end of parsing the version message, in
    //
    // pfrom->nTimeOffset = timeWarning.AddTimeData(pfrom->addr, nTime, GetTime());
    //
    // AddTimeData is defined in src/timedata.cpp and is a no-op as long
    // as the difference between the specified timestamp and the
    // zcashd's local time is less than TIMEDATA_WARNING_THRESHOLD, set
    // to 10 * 60 seconds (10 minutes).
    //
    // nTimeOffset is peer metadata that is never used, except for
    // statistics.
    //
    // To try to stay within the range where zcashd will ignore our clock skew,
    // truncate the timestamp to the nearest 5 minutes.
    let now = Utc::now().timestamp();
    let timestamp = Utc
        .timestamp_opt(now - now.rem_euclid(5 * 60), 0)
        .single()
        .expect("in-range number of seconds and valid nanosecond");

    let (their_addr, our_services, our_listen_addr) = match connected_addr {
        // Version messages require an address, so we use
        // an unspecified address for Isolated connections
        Isolated => {
            let unspec_ipv4 = get_unspecified_ipv4_addr(config.network);
            (unspec_ipv4.into(), PeerServices::empty(), unspec_ipv4)
        }
        _ => {
            let their_addr = connected_addr
                .get_transient_addr()
                .expect("non-Isolated connections have a remote addr");

            // Include the configured external address in our version message, if any, otherwise, include our listen address.
            let advertise_addr = match config.external_addr {
                Some(external_addr) => {
                    info!(
                        peer = %their_addr.addr_label(config.expose_peer_addresses),
                        ?config.listen_addr,
                        "using external address for Version messages"
                    );
                    external_addr
                }
                None => config.listen_addr,
            };

            (their_addr, our_services, advertise_addr)
        }
    };

    let start_height = minimum_peer_version
        .chain_tip()
        .best_tip_height()
        .unwrap_or(block::Height(0));

    let our_version = VersionMessage {
        version: constants::CURRENT_NETWORK_PROTOCOL_VERSION,
        services: our_services,
        timestamp,
        address_recv: AddrInVersion::new(their_addr, PeerServices::NODE_NETWORK),
        // TODO: detect external address (#1893)
        address_from: AddrInVersion::new(our_listen_addr, our_services),
        nonce: local_nonce,
        user_agent: user_agent.clone(),
        start_height,
        relay,
    };

    debug!(?our_version, "sending initial version message");
    if our_services.contains(PeerServices::NODE_P2P_V2) {
        metrics::counter!("zakura.p2p.handshake.service_bit.advertised").increment(1);
    }
    peer_conn.send(our_version.clone().into()).await?;

    let mut remote_msg = peer_conn
        .next()
        .await
        .ok_or(HandshakeError::ConnectionClosed)??;

    // Wait for next message if the one we got is not Version
    let remote: VersionMessage = loop {
        match remote_msg {
            Message::Version(version_message) => {
                debug!(?version_message, "got version message from remote peer");
                break version_message;
            }
            _ => {
                remote_msg = peer_conn
                    .next()
                    .await
                    .ok_or(HandshakeError::ConnectionClosed)??;
                debug!(?remote_msg, "ignoring non-version message from remote peer");
            }
        }
    };

    let remote_address_services = remote.address_from.untrusted_services();
    let addr_label = their_addr.addr_label(config.expose_peer_addresses);

    if remote_address_services != remote.services {
        info!(
            ?remote.services,
            ?remote_address_services,
            ?remote.user_agent,
            "peer with inconsistent version services and version address services",
        );
    }
    if remote.services.contains(PeerServices::NODE_P2P_V2) {
        metrics::counter!("zakura.p2p.handshake.service_bit.remote").increment(1);
    }

    // Check for nonce reuse, indicating self-connection
    //
    // # Correctness
    //
    // We must wait for the lock before we continue with the connection, to avoid
    // self-connection. If the connection times out, the async lock will be
    // released.
    //
    // # Security
    //
    // We don't remove the nonce here, because peers that observe our network traffic could
    // maliciously remove nonces, and force us to make self-connections.
    let nonce_reuse = nonces.lock().await.contains(&remote.nonce);
    if nonce_reuse {
        info!(
            peer = %addr_label,
            connection_kind = connected_addr.get_short_kind_label(),
            "rejecting self-connection attempt"
        );
        Err(HandshakeError::RemoteNonceReuse)?;
    }

    // # Security
    //
    // Reject connections to peers on old versions, because they might not know about all
    // network upgrades and could lead to chain forks or slower block propagation.
    let min_version = minimum_peer_version.current();
    if remote.version < min_version {
        debug!(
            remote_ip = %addr_label,
            ?remote.version,
            ?min_version,
            ?remote.user_agent,
            "disconnecting from peer with obsolete network protocol version",
        );

        // the value is the number of rejected handshakes, by peer IP and protocol version
        metrics::counter!(
            "zcash.net.peers.obsolete",
            "remote_ip" => addr_label.clone(),
            "remote_version" => remote.version.to_string(),
            "min_version" => min_version.to_string(),
            "user_agent" => remote.user_agent.clone(),
        )
        .increment(1);

        // the value is the remote version of the most recent rejected handshake from each peer
        metrics::gauge!(
            "zcash.net.peers.version.obsolete",
            "remote_ip" => addr_label.clone(),
        )
        .set(remote.version.0 as f64);

        // Disconnect if peer is using an obsolete version.
        return Err(HandshakeError::ObsoleteVersion(remote.version));
    }

    let negotiated_version = min(constants::CURRENT_NETWORK_PROTOCOL_VERSION, remote.version);

    // Limit containing struct size, and avoid multiple duplicates of 300+ bytes of data.
    let connection_info = Arc::new(ConnectionInfo {
        connected_addr: *connected_addr,
        remote,
        local: our_version,
        negotiated_version,
        is_protected_peer,
    });

    debug!(
        remote_ip = %addr_label,
        ?connection_info.remote.version,
        ?negotiated_version,
        ?min_version,
        ?connection_info.remote.user_agent,
        "negotiated network protocol version with peer",
    );

    // the value is the number of connected handshakes, by peer IP and protocol version
    metrics::counter!(
        "zcash.net.peers.connected",
        "remote_ip" => addr_label.clone(),
        "remote_version" => connection_info.remote.version.to_string(),
        "negotiated_version" => negotiated_version.to_string(),
        "min_version" => min_version.to_string(),
        "user_agent" => connection_info.remote.user_agent.clone(),
    )
    .increment(1);

    // the value is the remote version of the most recent connected handshake from each peer
    metrics::gauge!(
        "zcash.net.peers.version.connected",
        "remote_ip" => addr_label,
    )
    .set(connection_info.remote.version.0 as f64);

    peer_conn.send(Message::Verack).await?;

    let mut remote_msg = peer_conn
        .next()
        .await
        .ok_or(HandshakeError::ConnectionClosed)??;

    // Wait for next message if the one we got is not Verack
    loop {
        match remote_msg {
            Message::Verack => {
                debug!(?remote_msg, "got verack message from remote peer");
                break;
            }
            _ => {
                remote_msg = peer_conn
                    .next()
                    .await
                    .ok_or(HandshakeError::ConnectionClosed)??;
                debug!(?remote_msg, "ignoring non-verack message from remote peer");
            }
        }
    }

    Ok(connection_info)
}

/// Route a mutually P2P-v2-capable peer into the Zakura handshake path.
///
/// After the legacy `version`/`verack` exchange, two mutually capable peers swap
/// a bounded [`P2pV2Upgrade`] prelude over the legacy TCP stream to learn each
/// other's Zakura (iroh) node address. The TCP initiator then dials the
/// responder over QUIC; the responder's iroh router accepts that dial and
/// registers the peer. On success the caller drops the legacy stream and the
/// peers continue over Zakura. Any neutral problem (no local endpoint, malformed
/// or rejected prelude) returns [`ZakuraUpgradeOutcome::Rejected`] with
/// [`ZakuraRejectReason::TemporaryUnavailable`], so the caller keeps the legacy
/// connection instead.
async fn upgrade_to_zakura_handshake<PeerTransport>(
    peer_conn: &mut Framed<PeerTransport, Codec>,
    connection_info: &ConnectionInfo,
    connected_addr: ConnectedAddr,
    node_config: &Config,
    zakura_handshake_connector: Option<ZakuraHandshakeConnector>,
    address_book_updater: &tokio::sync::mpsc::Sender<MetaAddrChange>,
) -> Result<ZakuraUpgradeOutcome, HandshakeError>
where
    PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    let Some(connector) = zakura_handshake_connector else {
        metrics::counter!("zakura.p2p.handshake.upgrade.error").increment(1);
        return Err(HandshakeError::ZakuraUpgrade(
            crate::zakura::ZakuraUpgradeError::Unavailable,
        ));
    };

    // Handshake routing tests inject a deterministic outcome instead of running
    // the real prelude exchange over a live Zakura endpoint.
    #[cfg(test)]
    if let Some(outcome) = connector.consume_test_outcome() {
        return Ok(outcome);
    }

    // Our own iroh dial hints. Without a live Zakura endpoint we cannot upgrade,
    // so we stay on the legacy connection.
    let Some((local_node_id, local_direct_addresses)) = connector.local_iroh_hints().await else {
        return Ok(neutral_upgrade_fallback());
    };

    let addr_label = connected_addr.addr_label(node_config.expose_peer_addresses);
    let upgrade_config = ZakuraHandshakeConfig::for_network_with_dev_cohort(
        &node_config.network,
        node_config.zakura.dev_network.as_deref(),
    );
    let nonces = ZakuraLegacyNonces {
        local_zebra_nonce: connection_info.local.nonce,
        remote_zebra_nonce: connection_info.remote.nonce,
    };

    // The side that opened the legacy TCP connection initiates the prelude and
    // dials over QUIC; the accepting side responds and is dialed.
    let outcome = if connected_addr.is_inbound() {
        run_responder_upgrade(
            peer_conn,
            &connector,
            &upgrade_config,
            nonces,
            local_node_id,
            local_direct_addresses,
        )
        .await?
    } else {
        run_initiator_upgrade(
            peer_conn,
            &connector,
            &upgrade_config,
            nonces,
            local_node_id,
            local_direct_addresses,
        )
        .await?
    };

    match &outcome {
        ZakuraUpgradeOutcome::Upgraded { peer_id } => {
            // The success metric `zakura.p2p.handshake.upgraded` is incremented by
            // the supervisor when the dialed/accepted QUIC connection registers.
            info!(
                peer = %addr_label,
                connection_kind = connected_addr.get_short_kind_label(),
                ?peer_id,
                remote_services = ?connection_info.remote.services,
                "upgraded mutually P2P-v2-capable peer to Zakura",
            );
        }
        ZakuraUpgradeOutcome::Duplicate { peer_id } => {
            info!(
                peer = %addr_label,
                connection_kind = connected_addr.get_short_kind_label(),
                ?peer_id,
                "closing duplicate Zakura peer neutrally"
            );
            metrics::counter!("zakura.p2p.handshake.duplicate").increment(1);
        }
        ZakuraUpgradeOutcome::Rejected { reason } => {
            debug!(
                peer = %addr_label,
                connection_kind = connected_addr.get_short_kind_label(),
                ?reason,
                "Zakura upgrade not completed; continuing on the legacy connection",
            );
            metrics::counter!(
                "zakura.p2p.upgrade.prelude.rejected",
                "reason" => format!("{reason:?}"),
                "network" => upgrade_config.network_label(),
            )
            .increment(1);
        }
    }

    // Keep the upgraded peer's legacy address-book entry live for as long as the
    // Zakura connection is registered, so the outbound crawler treats it as
    // connected and does not re-dial it (which would re-run this upgrade and
    // churn the QUIC connection). Only the outbound side reconnects, and only
    // when we have a dialable address book entry for the peer.
    if let ZakuraUpgradeOutcome::Upgraded { peer_id }
    | ZakuraUpgradeOutcome::Duplicate { peer_id } = &outcome
    {
        if !connected_addr.is_inbound() {
            if let Some(book_addr) = connected_addr.get_address_book_addr() {
                connector.spawn_legacy_liveness_keeper(
                    peer_id.clone(),
                    book_addr,
                    address_book_updater.clone(),
                );
            }
        }
    }

    Ok(outcome)
}

/// The neutral upgrade fallback outcome: keep the legacy connection.
fn neutral_upgrade_fallback() -> ZakuraUpgradeOutcome {
    ZakuraUpgradeOutcome::Rejected {
        reason: ZakuraRejectReason::TemporaryUnavailable,
    }
}

/// The TCP initiator side of the legacy Zakura upgrade prelude exchange.
///
/// Sends our [`P2pV2UpgradeInit`], reads the responder's [`P2pV2UpgradeAccept`],
/// and dials the responder's advertised Zakura node address over QUIC.
async fn run_initiator_upgrade<PeerTransport>(
    peer_conn: &mut Framed<PeerTransport, Codec>,
    connector: &ZakuraHandshakeConnector,
    config: &ZakuraHandshakeConfig,
    nonces: ZakuraLegacyNonces,
    local_node_id: Vec<u8>,
    local_direct_addresses: Vec<Vec<u8>>,
) -> Result<ZakuraUpgradeOutcome, HandshakeError>
where
    PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    let mut upgrade_nonce = [0u8; 32];
    OsRng.fill_bytes(&mut upgrade_nonce);

    let init = P2pV2UpgradeInit {
        magic: PRELUDE_MAGIC,
        prelude_version: config.prelude_version,
        zakura_protocol_min: config.zakura_protocol_min,
        zakura_protocol_max: config.zakura_protocol_max,
        network_id: config.network_id,
        chain_id: config.chain_id,
        capabilities: config.supported_capabilities,
        local_zebra_nonce: nonces.local_zebra_nonce,
        remote_zebra_nonce: nonces.remote_zebra_nonce,
        upgrade_nonce,
        iroh_node_id: local_node_id,
        iroh_direct_addresses: local_direct_addresses,
        iroh_relay_hint: None,
        max_control_frame_bytes: config.max_control_frame_bytes,
        max_open_streams: config.max_open_streams,
    };

    let Ok(init_bytes) = P2pV2Upgrade::Init(init.clone()).encode() else {
        return Ok(neutral_upgrade_fallback());
    };
    peer_conn.send(Message::P2pV2Upgrade(init_bytes)).await?;

    let Some(P2pV2Upgrade::Accept(accept)) = read_upgrade_prelude(peer_conn).await? else {
        // A well-formed reject, an unexpected variant, or no prelude within the
        // skip window: keep the legacy connection. A malformed prelude is not
        // reached here; `read_upgrade_prelude` disconnects on the first
        // malformed upgrade message instead of falling back.
        return Ok(neutral_upgrade_fallback());
    };

    if accept.validate(config, nonces, &init).is_err() {
        return Ok(neutral_upgrade_fallback());
    }

    let Ok(peer_id) = ZakuraPeerId::new(accept.iroh_node_id.clone()) else {
        return Ok(neutral_upgrade_fallback());
    };

    // Dial the responder's Zakura endpoint over QUIC and wait for the local
    // supervisor to register a usable outbound handle before dropping the
    // legacy connection.
    if !connector
        .spawn_zakura_dial_to_hints_and_wait(
            &peer_id,
            &accept.iroh_node_id,
            &accept.iroh_direct_addresses,
        )
        .await
    {
        return Ok(neutral_upgrade_fallback());
    }

    Ok(ZakuraUpgradeOutcome::Upgraded { peer_id })
}

/// The TCP responder side of the legacy Zakura upgrade prelude exchange.
///
/// Reads the initiator's [`P2pV2UpgradeInit`] and replies with our
/// [`P2pV2UpgradeAccept`], advertising our Zakura node address so the initiator
/// can dial us. Our iroh router accepts that inbound dial separately.
async fn run_responder_upgrade<PeerTransport>(
    peer_conn: &mut Framed<PeerTransport, Codec>,
    connector: &ZakuraHandshakeConnector,
    config: &ZakuraHandshakeConfig,
    nonces: ZakuraLegacyNonces,
    local_node_id: Vec<u8>,
    local_direct_addresses: Vec<Vec<u8>>,
) -> Result<ZakuraUpgradeOutcome, HandshakeError>
where
    PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    // A well-formed unexpected variant or no prelude within the skip window: send
    // a neutral reject and keep legacy. A malformed prelude is not reached here;
    // `read_upgrade_prelude` disconnects on the first malformed upgrade message
    // instead of replying with a neutral reject and falling back.
    let Some(P2pV2Upgrade::Init(init)) = read_upgrade_prelude(peer_conn).await? else {
        send_upgrade_reject(peer_conn, config).await?;
        return Ok(neutral_upgrade_fallback());
    };

    let selected_zakura_protocol = match init.validate(config, nonces) {
        Ok(selected) => selected,
        Err(_) => {
            send_upgrade_reject(peer_conn, config).await?;
            return Ok(neutral_upgrade_fallback());
        }
    };

    let mut responder_upgrade_nonce = [0u8; 32];
    OsRng.fill_bytes(&mut responder_upgrade_nonce);

    let accept = P2pV2UpgradeAccept {
        magic: PRELUDE_MAGIC,
        prelude_version: config.prelude_version,
        selected_zakura_protocol,
        network_id: config.network_id,
        chain_id: config.chain_id,
        capabilities: config.supported_capabilities,
        initiator_upgrade_nonce: init.upgrade_nonce,
        responder_upgrade_nonce,
        local_zebra_nonce: nonces.local_zebra_nonce,
        remote_zebra_nonce: nonces.remote_zebra_nonce,
        iroh_node_id: local_node_id,
        iroh_direct_addresses: local_direct_addresses,
        iroh_relay_hint: None,
        max_control_frame_bytes: config.max_control_frame_bytes,
        max_open_streams: config.max_open_streams,
    };

    let Ok(accept_bytes) = P2pV2Upgrade::Accept(accept).encode() else {
        return Ok(neutral_upgrade_fallback());
    };
    peer_conn.send(Message::P2pV2Upgrade(accept_bytes)).await?;

    let Ok(peer_id) = ZakuraPeerId::new(init.iroh_node_id.clone()) else {
        return Ok(neutral_upgrade_fallback());
    };

    // The peer dials our advertised Zakura endpoint over QUIC after receiving
    // `Accept`, and our iroh router registers that inbound connection
    // separately. Wait for that native registration before reporting the
    // upgrade: the outer handshake drops the legacy TCP connection on
    // `Upgraded`, so without this wait an inbound peer that sends a valid `Init`
    // and then never completes the native dial would make us discard a working
    // legacy connection with no Zakura replacement. This mirrors the initiator's
    // `spawn_zakura_dial_to_hints_and_wait` hand-off wait.
    if !connector.wait_for_zakura_registration(&peer_id).await {
        return Ok(neutral_upgrade_fallback());
    }

    Ok(ZakuraUpgradeOutcome::Upgraded { peer_id })
}

/// Sends a neutral [`P2pV2UpgradeReject`] so the peer stops waiting for an accept
/// and falls back to the legacy connection.
async fn send_upgrade_reject<PeerTransport>(
    peer_conn: &mut Framed<PeerTransport, Codec>,
    config: &ZakuraHandshakeConfig,
) -> Result<(), HandshakeError>
where
    PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    let reject = P2pV2UpgradeReject {
        magic: PRELUDE_MAGIC,
        prelude_version: config.prelude_version,
        reason: ZakuraRejectReason::TemporaryUnavailable,
    };
    if let Ok(reject_bytes) = P2pV2Upgrade::Reject(reject).encode() {
        peer_conn.send(Message::P2pV2Upgrade(reject_bytes)).await?;
    }
    Ok(())
}

/// Decode a peer-controlled Zakura upgrade prelude.
///
/// A panic is terminal for this legacy connection: callers propagate the
/// returned serialization error and drop the framed transport without reusing
/// its parser state.
fn decode_upgrade_prelude(payload: &[u8]) -> Result<P2pV2Upgrade, HandshakeError> {
    decode_upgrade_prelude_with(|| P2pV2Upgrade::decode(payload))
}

/// Run the structured upgrade prelude decoder inside its panic boundary.
fn decode_upgrade_prelude_with(
    decode: impl FnOnce() -> Result<P2pV2Upgrade, ZakuraProtocolError> + panic::UnwindSafe,
) -> Result<P2pV2Upgrade, HandshakeError> {
    match panic::catch_unwind(decode) {
        Ok(Ok(prelude)) => Ok(prelude),
        Ok(Err(error)) => {
            metrics::counter!("zakura.p2p.upgrade.prelude.malformed").increment(1);
            Err(HandshakeError::ZakuraUpgradePreludeMalformed(error))
        }
        Err(_panic_payload) => {
            metrics::counter!(
                "peer.message.parse.panics",
                "parser" => "upgrade_prelude",
            )
            .increment(1);
            tracing::error!(
                command = P2P_V2_UPGRADE_COMMAND,
                "peer-controlled message parser panicked; disconnecting legacy peer"
            );
            Err(SerializationError::Parse("Zakura P2P v2 upgrade prelude parser panicked").into())
        }
    }
}

/// Reads the next legacy [`P2pV2Upgrade`] prelude from the peer.
///
/// Skips a small bounded number of unrelated messages (the overall handshake
/// timeout also applies), so a peer cannot stall the upgrade by streaming other
/// messages.
///
/// Returns `Ok(None)` only when no prelude arrives within the skip bound: a peer
/// that advertised `NODE_P2P_V2` but never frames a `p2pv2up` message is treated
/// as a neutral legacy fallback (compatibility).
///
/// In contrast, a peer that *does* frame a `p2pv2up` message whose payload fails
/// to decode has violated the upgrade protocol, so this returns
/// [`HandshakeError::ZakuraUpgradePreludeMalformed`] rather than erasing the
/// decode error to `None`. Erasing it would let a peer force a downgrade to
/// legacy by sending malformed upgrade bytes (SR-7 fail-closed); surfacing it
/// disconnects the peer on the first malformed upgrade message.
async fn read_upgrade_prelude<PeerTransport>(
    peer_conn: &mut Framed<PeerTransport, Codec>,
) -> Result<Option<P2pV2Upgrade>, HandshakeError>
where
    PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    // Bound on unrelated messages tolerated before the prelude.
    const MAX_SKIPPED_MESSAGES: usize = 4;

    for _ in 0..MAX_SKIPPED_MESSAGES {
        let message = peer_conn
            .next()
            .await
            .ok_or(HandshakeError::ConnectionClosed)??;
        if let Message::P2pV2Upgrade(payload) = message {
            return decode_upgrade_prelude(&payload).map(Some);
        }
    }

    Ok(None)
}

/// A handshake request.
/// Contains the information needed to handshake with the peer.
pub struct HandshakeRequest<PeerTransport>
where
    PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    /// The tokio [`TcpStream`](tokio::net::TcpStream) or Tor
    /// `arti_client::DataStream` to the peer.
    // Use [`arti_client::DataStream`] when #5492 is done.
    pub data_stream: PeerTransport,

    /// The address of the peer, and other related information.
    pub connected_addr: ConnectedAddr,

    /// A connection tracker that reduces the open connection count when dropped.
    ///
    /// Used to limit the number of open connections in Zebra.
    pub connection_tracker: ConnectionTracker,
}

impl<S, PeerTransport, C> Service<HandshakeRequest<PeerTransport>> for Handshake<S, C>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
    PeerTransport: AsyncRead + AsyncWrite + Unpin + Send + 'static,
{
    type Response = Client;
    type Error = BoxError;
    type Future =
        Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send + 'static>>;

    fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Poll::Ready(Ok(()))
    }

    fn call(&mut self, req: HandshakeRequest<PeerTransport>) -> Self::Future {
        let HandshakeRequest {
            data_stream,
            connected_addr,
            connection_tracker,
        } = req;

        let addr_label = connected_addr.addr_label(self.config.expose_peer_addresses);
        let negotiator_span = debug_span!(
            "negotiator",
            peer = %addr_label,
            connection_kind = connected_addr.get_short_kind_label(),
        );
        // set the peer connection span's parent to the global span, as it
        // should exist independently of its creation source (inbound
        // connection, crawler, initial peer, ...)
        let connection_span = span!(
            parent: &self.parent_span,
            Level::INFO,
            "",
            peer = %addr_label,
            connection_kind = connected_addr.get_short_kind_label(),
        );

        // Clone these upfront, so they can be moved into the future.
        let nonces = self.nonces.clone();
        let inbound_service = self.inbound_service.clone();
        let address_book_updater = self.address_book_updater.clone();
        let inv_collector = self.inv_collector.clone();
        let config = self.config.clone();
        let user_agent = self.user_agent.clone();
        let our_services = self.our_services;
        let relay = self.relay;
        let minimum_peer_version = self.minimum_peer_version.clone();
        let zakura_handshake_connector = self.zakura_handshake_connector.clone();

        // Whether this peer is exempt from the inbound-overload connection drop.
        // Computed here (not in the future) so only the resulting `bool` is moved
        // into the handshake task.
        let is_protected_peer = connected_addr.is_protected_peer(&self.protected_peer_ips);

        // # Security
        //
        // `zakura_network::init()` implements a connection timeout on this future.
        // Any code outside this future does not have a timeout.
        let fut = async move {
            debug!(
                addr = %addr_label,
                connection_kind = connected_addr.get_short_kind_label(),
                "negotiating protocol version with remote peer"
            );

            // Start timing the handshake for metrics
            let handshake_start = Instant::now();

            let mut peer_conn = Framed::new(
                data_stream,
                Codec::builder()
                    .for_network(&config.network)
                    .with_metrics_addr_label(addr_label.clone())
                    .finish(),
            );
            let mut connection_tracker = connection_tracker;

            let connection_info = match negotiate_version(
                &mut peer_conn,
                &connected_addr,
                config.clone(),
                nonces,
                user_agent,
                our_services,
                relay,
                minimum_peer_version,
                is_protected_peer,
            )
            .await
            {
                Ok(info) => {
                    // Record successful handshake duration
                    let duration = handshake_start.elapsed().as_secs_f64();
                    metrics::histogram!(
                        "zcash.net.peer.handshake.duration_seconds",
                        "result" => "success"
                    )
                    .record(duration);
                    info
                }
                Err(err) => {
                    // Record failed handshake duration and failure reason
                    let duration = handshake_start.elapsed().as_secs_f64();
                    let reason = match &err {
                        HandshakeError::UnexpectedMessage(_) => "unexpected_message",
                        HandshakeError::RemoteNonceReuse => "nonce_reuse",
                        HandshakeError::LocalDuplicateNonce => "duplicate_nonce",
                        HandshakeError::ConnectionClosed => "connection_closed",
                        HandshakeError::Io(_) => "io_error",
                        HandshakeError::Serialization(_) => "serialization",
                        HandshakeError::ObsoleteVersion(_) => "obsolete_version",
                        HandshakeError::Timeout => "timeout",
                        HandshakeError::ZakuraUpgradeSelected
                        | HandshakeError::ZakuraUpgrade(_)
                        | HandshakeError::ZakuraUpgradePreludeMalformed(_) => {
                            unreachable!("negotiate_version returns before Zakura upgrade routing")
                        }
                    };
                    metrics::histogram!(
                        "zcash.net.peer.handshake.duration_seconds",
                        "result" => "failure"
                    )
                    .record(duration);
                    metrics::counter!(
                        "zcash.net.peer.handshake.failures.total",
                        "reason" => reason
                    )
                    .increment(1);
                    return Err(err);
                }
            };

            let remote_services = connection_info.remote.services;

            if should_attempt_zakura_upgrade(&config, &connection_info) {
                match upgrade_to_zakura_handshake(
                    &mut peer_conn,
                    &connection_info,
                    connected_addr,
                    &config,
                    zakura_handshake_connector,
                    &address_book_updater,
                )
                .await
                {
                    Ok(
                        ZakuraUpgradeOutcome::Upgraded { .. }
                        | ZakuraUpgradeOutcome::Duplicate { .. },
                    ) => {
                        // Returning here drops the legacy stream and connection tracker, cleanly
                        // closing the Zebra path and releasing the connection limit exactly once.
                        return Err(HandshakeError::ZakuraUpgradeSelected);
                    }
                    Ok(ZakuraUpgradeOutcome::Rejected {
                        reason: ZakuraRejectReason::TemporaryUnavailable,
                    }) => {
                        debug!(
                            peer = %addr_label,
                            connection_kind = connected_addr.get_short_kind_label(),
                            "Zakura upgrade is temporarily unavailable; continuing legacy handshake"
                        );
                    }
                    Ok(ZakuraUpgradeOutcome::Rejected { .. }) => {
                        // Returning here drops the legacy stream and connection tracker, cleanly
                        // closing the Zebra path and releasing the connection limit exactly once.
                        return Err(HandshakeError::ZakuraUpgradeSelected);
                    }
                    Err(error) => return Err(error),
                }
            }

            // The handshake succeeded: update the peer status from AttemptPending to Responded,
            // send initial connection info, and update the active connection counter.
            connection_tracker.mark_open();
            if let Some(book_addr) = connected_addr.get_address_book_addr() {
                // the collector doesn't depend on network activity,
                // so this await should not hang
                let _ = address_book_updater
                    .send(MetaAddr::new_connected(
                        book_addr,
                        &remote_services,
                        connected_addr.is_inbound(),
                    ))
                    .await;
            }

            // Reconfigure the codec to use the negotiated version.
            //
            // TODO: The tokio documentation says not to do this while any frames are still being processed.
            // Since we don't know that here, another way might be to release the tcp
            // stream from the unversioned Framed wrapper and construct a new one with a versioned codec.
            let bare_codec = peer_conn.codec_mut();
            bare_codec.reconfigure_version(connection_info.negotiated_version);
            bare_codec.reconfigure_full_body_len();

            debug!("constructing client, spawning server");

            // These channels communicate between the inbound and outbound halves of the connection,
            // and between the different connection tasks. We create separate tasks and channels
            // for each new connection.
            let (server_tx, server_rx) = futures::channel::mpsc::channel(0);
            let (shutdown_tx, shutdown_rx) = oneshot::channel();
            let error_slot = ErrorSlot::default();

            let (peer_tx, peer_rx) = peer_conn.split();

            // Instrument the peer's rx and tx streams.

            let inner_conn_span = connection_span.clone();
            let outbound_addr_label = addr_label.clone();
            let peer_tx = peer_tx.with(move |msg: Message| {
                let span = debug_span!(parent: inner_conn_span.clone(), "outbound_metric");
                // Add a metric for outbound messages.
                metrics::counter!(
                    "zcash.net.out.messages",
                    "command" => msg.command(),
                    "addr" => outbound_addr_label.clone(),
                )
                .increment(1);
                // We need to use future::ready rather than an async block here,
                // because we need the sink to be Unpin, and the With<Fut, ...>
                // returned by .with is Unpin only if Fut is Unpin, and the
                // futures generated by async blocks are not Unpin.
                future::ready(Ok(msg)).instrument(span)
            });

            // CORRECTNESS
            //
            // Ping/Pong messages and every error must update the peer address state via
            // the inbound_ts_collector.
            //
            // The heartbeat task sends regular Ping/Pong messages,
            // and it ends the connection if the heartbeat times out.
            // So we can just track peer activity based on Ping and Pong.
            // (This significantly improves performance, by reducing time system calls.)
            let inbound_ts_collector = address_book_updater.clone();
            let inbound_inv_collector = inv_collector.clone();
            let ts_inner_conn_span = connection_span.clone();
            let inv_inner_conn_span = connection_span.clone();
            let inbound_addr_label = addr_label.clone();
            let peer_rx = peer_rx
                .then(move |msg| {
                    // Add a metric for inbound messages and errors.
                    // Fire a timestamp or failure event.
                    let inbound_ts_collector = inbound_ts_collector.clone();
                    let addr_label = inbound_addr_label.clone();
                    let span =
                        debug_span!(parent: ts_inner_conn_span.clone(), "inbound_ts_collector");

                    async move {
                        match &msg {
                            Ok(msg) => {
                                metrics::counter!(
                                    "zcash.net.in.messages",
                                    "command" => msg.command(),
                                    "addr" => addr_label.clone(),
                                )
                                .increment(1);

                                // # Security
                                //
                                // Peer messages are not rate-limited, so we can't send anything
                                // to a shared channel or do anything expensive here.
                            }
                            Err(err) => {
                                metrics::counter!(
                                    "zakura.net.in.errors",
                                    "error" => err.to_string(),
                                    "addr" => addr_label.clone(),
                                )
                                .increment(1);

                                // # Security
                                //
                                // Peer errors are rate-limited because:
                                // - opening connections is rate-limited
                                // - the number of connections is limited
                                // - after the first error, the peer is disconnected
                                if let Some(book_addr) = connected_addr.get_address_book_addr() {
                                    let _ = inbound_ts_collector
                                        .send(MetaAddr::new_errored(book_addr, remote_services))
                                        .await;
                                }
                            }
                        }
                        msg
                    }
                    .instrument(span)
                })
                .then(move |msg| {
                    let inbound_inv_collector = inbound_inv_collector.clone();
                    let span = debug_span!(parent: inv_inner_conn_span.clone(), "inventory_filter");
                    register_inventory_status(msg, connected_addr, inbound_inv_collector)
                        .instrument(span)
                })
                .boxed();

            // If we've learned potential peer addresses from the inbound connection remote address
            // or the handshake version message, add those addresses to the peer cache for this
            // peer.
            //
            // # Security
            //
            // We can't add these alternate addresses directly to the address book. If we did,
            // malicious peers could interfere with the address book state of other peers by
            // providing their addresses in `Version` messages. Or they could fill the address book
            // with fake addresses.
            //
            // These peer addresses are rate-limited because:
            // - opening connections is rate-limited
            // - these addresses are put in the peer address cache
            // - the peer address cache is only used when Zebra requests addresses from that peer
            let remote_canonical_addr = connection_info.remote.address_from.addr();
            let alternate_addrs = connected_addr
                .get_alternate_addrs(remote_canonical_addr)
                .map(|addr| {
                    // Assume the connecting node is a server node, and it's available now.
                    MetaAddr::new_gossiped_meta_addr(
                        addr,
                        PeerServices::NODE_NETWORK,
                        DateTime32::now(),
                    )
                });

            let server = Connection::new(
                inbound_service,
                server_rx,
                error_slot.clone(),
                peer_tx,
                connection_tracker,
                connection_info.clone(),
                addr_label,
                alternate_addrs.collect(),
            );

            let connection_task = tokio::spawn(
                server
                    .run(peer_rx)
                    .instrument(connection_span.clone())
                    .boxed(),
            );

            let heartbeat_task = tokio::spawn(
                send_periodic_heartbeats_with_shutdown_handle(
                    connected_addr,
                    shutdown_rx,
                    server_tx.clone(),
                    address_book_updater.clone(),
                )
                .instrument(tracing::debug_span!(parent: connection_span, "heartbeat"))
                .boxed(),
            );

            let client = Client {
                connection_info,
                shutdown_tx: Some(shutdown_tx),
                server_tx,
                inv_collector,
                error_slot,
                connection_task,
                heartbeat_task,
            };

            Ok(client)
        };

        // Correctness: As a defence-in-depth against hangs, wrap the entire handshake in a timeout.
        let fut = timeout(constants::HANDSHAKE_TIMEOUT, fut);

        // Spawn a new task to drive this handshake, forwarding panics to the calling task.
        tokio::spawn(fut.instrument(negotiator_span))
            .map(
                |join_result: Result<
                    Result<Result<Client, HandshakeError>, error::Elapsed>,
                    JoinError,
                >| {
                    match join_result {
                        Ok(Ok(Ok(connection_client))) => Ok(connection_client),
                        Ok(Ok(Err(handshake_error))) => Err(handshake_error.into()),
                        Ok(Err(timeout_error)) => Err(timeout_error.into()),
                        Err(join_error) => match join_error.try_into_panic() {
                            // Forward panics to the calling task
                            Ok(panic_reason) => panic::resume_unwind(panic_reason),
                            Err(join_error) => Err(join_error.into()),
                        },
                    }
                },
            )
            .boxed()
    }
}

/// Register any advertised or missing inventory in `msg` for `connected_addr`.
pub(crate) async fn register_inventory_status(
    msg: Result<Message, SerializationError>,
    connected_addr: ConnectedAddr,
    inv_collector: broadcast::Sender<InventoryChange>,
) -> Result<Message, SerializationError> {
    match (&msg, connected_addr.get_transient_addr()) {
        (Ok(Message::Inv(advertised)), Some(transient_addr)) => {
            // We ignore inventory messages with more than one
            // block, because they are most likely replies to a
            // query, rather than a newly gossiped block.
            //
            // (We process inventory messages with any number of
            // transactions.)
            //
            // https://zebra.zfnd.org/dev/rfcs/0003-inventory-tracking.html#inventory-monitoring
            //
            // Note: zcashd has a bug where it merges queued inv messages of
            // the same or different types. Zebra compensates by sending `notfound`
            // responses to the inv collector. (#2156, #1768)
            //
            // (We can't split `inv`s, because that fills the inventory registry
            // with useless entries that the whole network has, making it large and slow.)
            match advertised.as_slice() {
                [advertised @ InventoryHash::Block(_)] => {
                    debug!(
                        ?advertised,
                        "registering gossiped advertised block inventory for peer"
                    );

                    // The peer set and inv collector use the peer's remote
                    // address as an identifier
                    // If all receivers have been dropped, `send` returns an error.
                    // When that happens, Zebra is shutting down, so we want to ignore this error.
                    let _ = inv_collector
                        .send(InventoryChange::new_available(*advertised, transient_addr));
                }
                advertised => {
                    let advertised = advertised
                        .iter()
                        .filter(|advertised| advertised.unmined_tx_id().is_some());

                    debug!(
                        ?advertised,
                        "registering advertised unmined transaction inventory for peer",
                    );

                    if let Some(change) =
                        InventoryChange::new_available_multi(advertised, transient_addr)
                    {
                        // Ignore channel errors that should only happen during shutdown.
                        let _ = inv_collector.send(change);
                    }
                }
            }
        }

        (Ok(Message::NotFound(missing)), Some(transient_addr)) => {
            // Ignore Errors and the unsupported FilteredBlock type
            let missing = missing.iter().filter(|missing| {
                missing.unmined_tx_id().is_some() || missing.block_hash().is_some()
            });

            debug!(?missing, "registering missing inventory for peer");

            if let Some(change) = InventoryChange::new_missing_multi(missing, transient_addr) {
                let _ = inv_collector.send(change);
            }
        }
        _ => {}
    }

    msg
}

/// Send periodical heartbeats to `server_tx`, and update the peer status through
/// `heartbeat_ts_collector`.
///
/// # Correctness
///
/// To prevent hangs:
/// - every await that depends on the network must have a timeout (or interval)
/// - every error/shutdown must update the address book state and return
///
/// The address book state can be updated via `ClientRequest.tx`, or the
/// heartbeat_ts_collector.
///
/// Returning from this function terminates the connection's heartbeat task.
async fn send_periodic_heartbeats_with_shutdown_handle(
    connected_addr: ConnectedAddr,
    shutdown_rx: oneshot::Receiver<CancelHeartbeatTask>,
    server_tx: futures::channel::mpsc::Sender<ClientRequest>,
    heartbeat_ts_collector: tokio::sync::mpsc::Sender<MetaAddrChange>,
) -> Result<(), BoxError> {
    use futures::future::Either;

    let heartbeat_run_loop = send_periodic_heartbeats_run_loop(
        connected_addr,
        server_tx,
        heartbeat_ts_collector.clone(),
    );

    pin_mut!(shutdown_rx);
    pin_mut!(heartbeat_run_loop);

    // CORRECTNESS
    //
    // Currently, select prefers the first future if multiple
    // futures are ready.
    //
    // Starvation is impossible here, because interval has a
    // slow rate, and shutdown is a oneshot. If both futures
    // are ready, we want the shutdown to take priority over
    // sending a useless heartbeat.
    match future::select(shutdown_rx, heartbeat_run_loop).await {
        Either::Left((Ok(CancelHeartbeatTask), _unused_run_loop)) => {
            tracing::trace!("shutting down because Client requested shut down");
            handle_heartbeat_shutdown(
                PeerError::ClientCancelledHeartbeatTask,
                &heartbeat_ts_collector,
                &connected_addr,
            )
            .await
        }
        Either::Left((Err(oneshot::Canceled), _unused_run_loop)) => {
            tracing::trace!("shutting down because Client was dropped");
            handle_heartbeat_shutdown(
                PeerError::ClientDropped,
                &heartbeat_ts_collector,
                &connected_addr,
            )
            .await
        }
        Either::Right((result, _unused_shutdown)) => {
            tracing::trace!("shutting down due to heartbeat failure");
            // heartbeat_timeout() already send an error on the timestamp collector channel

            result
        }
    }
}

/// Send periodical heartbeats to `server_tx`, and update the peer status through
/// `heartbeat_ts_collector`.
///
/// See `send_periodic_heartbeats_with_shutdown_handle` for details.
async fn send_periodic_heartbeats_run_loop(
    connected_addr: ConnectedAddr,
    mut server_tx: futures::channel::mpsc::Sender<ClientRequest>,
    heartbeat_ts_collector: tokio::sync::mpsc::Sender<MetaAddrChange>,
) -> Result<(), BoxError> {
    // Don't send the first heartbeat immediately - we've just completed the handshake!
    let mut interval = tokio::time::interval_at(
        Instant::now() + constants::HEARTBEAT_INTERVAL,
        constants::HEARTBEAT_INTERVAL,
    );
    // If the heartbeat is delayed, also delay all future heartbeats.
    // (Shorter heartbeat intervals just add load, without any benefit.)
    interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);

    let mut interval_stream = IntervalStream::new(interval);

    while let Some(_instant) = interval_stream.next().await {
        // We've reached another heartbeat interval without
        // shutting down, so do a heartbeat request.
        let ping_sent_at = Instant::now();
        if let Some(book_addr) = connected_addr.get_address_book_addr() {
            let _ = heartbeat_ts_collector
                .send(MetaAddr::new_ping_sent(book_addr, ping_sent_at.into()))
                .await;
        }

        let heartbeat = send_one_heartbeat(&mut server_tx);
        let rtt = heartbeat_timeout(heartbeat, &heartbeat_ts_collector, &connected_addr).await?;

        // # Security
        //
        // Peer heartbeats are rate-limited because:
        // - opening connections is rate-limited
        // - the number of connections is limited
        // - Zebra initiates each heartbeat using a timer
        if let Some(book_addr) = connected_addr.get_address_book_addr() {
            if let Some(rtt) = rtt {
                // the collector doesn't depend on network activity,
                // so this await should not hang
                let _ = heartbeat_ts_collector
                    .send(MetaAddr::new_responded(book_addr, Some(rtt)))
                    .await;
            }
        }
    }

    unreachable!("unexpected IntervalStream termination")
}

/// Send one heartbeat using `server_tx`.
async fn send_one_heartbeat(
    server_tx: &mut futures::channel::mpsc::Sender<ClientRequest>,
) -> Result<Response, BoxError> {
    // We just reached a heartbeat interval, so start sending
    // a heartbeat.
    let (tx, rx) = oneshot::channel();

    // Try to send the heartbeat request
    let request = Request::Ping(Nonce::default());
    tracing::trace!(?request, "queueing heartbeat request");
    match server_tx.try_send(ClientRequest {
        request,
        tx,
        // we're not requesting inventory, so we don't need to update the registry
        inv_collector: None,
        transient_addr: None,
        span: tracing::Span::current(),
    }) {
        Ok(()) => {}
        Err(e) => {
            if e.is_disconnected() {
                Err(PeerError::ConnectionClosed)?;
            } else if e.is_full() {
                // Send the message when the Client becomes ready.
                // If sending takes too long, the heartbeat timeout will elapse
                // and close the connection, reducing our load to busy peers.
                server_tx.send(e.into_inner()).await?;
            } else {
                // we need to map unexpected error types to PeerErrors
                warn!(?e, "unexpected try_send error");
                Err(e)?;
            };
        }
    }

    // Flush the heartbeat request from the queue
    server_tx.flush().await?;
    tracing::trace!("sent heartbeat request");

    // Heartbeats are checked internally to the
    // connection logic, but we need to wait on the
    // response to avoid canceling the request.
    let response = rx.await??;
    tracing::trace!(?response, "got heartbeat response");

    Ok(response)
}

/// Wrap `fut` in a timeout, handing any inner or outer errors using
/// `handle_heartbeat_error`.
async fn heartbeat_timeout(
    fut: impl Future<Output = Result<Response, BoxError>>,
    address_book_updater: &tokio::sync::mpsc::Sender<MetaAddrChange>,
    connected_addr: &ConnectedAddr,
) -> Result<Option<Duration>, BoxError> {
    let response = match timeout(constants::HEARTBEAT_INTERVAL, fut).await {
        Ok(inner_result) => {
            handle_heartbeat_error(inner_result, address_book_updater, connected_addr).await?
        }
        Err(elapsed) => {
            handle_heartbeat_error(Err(elapsed), address_book_updater, connected_addr).await?
        }
    };

    let rtt = match response {
        Response::Pong(rtt) => Some(rtt),
        _ => None,
    };

    Ok(rtt)
}

/// If `result.is_err()`, mark `connected_addr` as failed using `address_book_updater`.
async fn handle_heartbeat_error<T, E>(
    result: Result<T, E>,
    address_book_updater: &tokio::sync::mpsc::Sender<MetaAddrChange>,
    connected_addr: &ConnectedAddr,
) -> Result<T, E>
where
    E: std::fmt::Debug,
{
    match result {
        Ok(t) => Ok(t),
        Err(err) => {
            tracing::debug!(?err, "heartbeat error, shutting down");

            // # Security
            //
            // Peer errors and shutdowns are rate-limited because:
            // - opening connections is rate-limited
            // - the number of connections is limited
            // - after the first error or shutdown, the peer is disconnected
            if let Some(book_addr) = connected_addr.get_address_book_addr() {
                let _ = address_book_updater
                    .send(MetaAddr::new_errored(book_addr, None))
                    .await;
            }
            Err(err)
        }
    }
}

/// Mark `connected_addr` as shut down using `address_book_updater`.
async fn handle_heartbeat_shutdown(
    peer_error: PeerError,
    address_book_updater: &tokio::sync::mpsc::Sender<MetaAddrChange>,
    connected_addr: &ConnectedAddr,
) -> Result<(), BoxError> {
    tracing::debug!(?peer_error, "client shutdown, shutting down heartbeat");

    if let Some(book_addr) = connected_addr.get_address_book_addr() {
        let _ = address_book_updater
            .send(MetaAddr::new_shutdown(book_addr))
            .await;
    }

    Err(peer_error.into())
}