mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-07 09:38:02 +00:00
Aaro Altonen
e71c484d5b
This commit introduces a new concept called `NotificationService` which allows Polkadot protocols to communicate with the underlying notification protocol implementation directly, without routing events through `NetworkWorker`. This implies that each protocol has its own service which it uses to communicate with remote peers and that each `NotificationService` is unique with respect to the underlying notification protocol, meaning `NotificationService` for the transaction protocol can only be used to send and receive transaction-related notifications. The `NotificationService` concept introduces two additional benefits: * allow protocols to start using custom handshakes * allow protocols to accept/reject inbound peers Previously the validation of inbound connections was solely the responsibility of `ProtocolController`. This caused issues with light peers and `SyncingEngine` as `ProtocolController` would accept more peers than `SyncingEngine` could accept which caused peers to have differing views of their own states. `SyncingEngine` would reject excess peers but these rejections were not properly communicated to those peers causing them to assume that they were accepted. With `NotificationService`, the local handshake is not sent to remote peer if peer is rejected which allows it to detect that it was rejected. This commit also deprecates the use of `NetworkEventStream` for all notification-related events and going forward only DHT events are provided through `NetworkEventStream`. If protocols wish to follow each other's events, they must introduce additional abtractions, as is done for GRANDPA and transactions protocols by following the syncing protocol through `SyncEventStream`. Fixes https://github.com/paritytech/polkadot-sdk/issues/512 Fixes https://github.com/paritytech/polkadot-sdk/issues/514 Fixes https://github.com/paritytech/polkadot-sdk/issues/515 Fixes https://github.com/paritytech/polkadot-sdk/issues/554 Fixes https://github.com/paritytech/polkadot-sdk/issues/556 --- These changes are transferred from https://github.com/paritytech/substrate/pull/14197 but there are no functional changes compared to that PR --------- Co-authored-by: Dmitry Markin <dmitry@markin.tech> Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com>
88 lines
2.8 KiB
Rust
88 lines
2.8 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//! Substrate network possible errors.
|
|
|
|
use crate::{config::TransportConfig, types::ProtocolName};
|
|
|
|
use libp2p::{Multiaddr, PeerId};
|
|
|
|
use std::fmt;
|
|
|
|
/// Result type alias for the network.
|
|
pub type Result<T> = std::result::Result<T, Error>;
|
|
|
|
/// Error type for the network.
|
|
#[derive(thiserror::Error)]
|
|
pub enum Error {
|
|
/// Io error
|
|
#[error(transparent)]
|
|
Io(#[from] std::io::Error),
|
|
|
|
/// Client error
|
|
#[error(transparent)]
|
|
Client(#[from] Box<sp_blockchain::Error>),
|
|
/// The same bootnode (based on address) is registered with two different peer ids.
|
|
#[error(
|
|
"The same bootnode (`{address}`) is registered with two different peer ids: `{first_id}` and `{second_id}`"
|
|
)]
|
|
DuplicateBootnode {
|
|
/// The address of the bootnode.
|
|
address: Multiaddr,
|
|
/// The first peer id that was found for the bootnode.
|
|
first_id: PeerId,
|
|
/// The second peer id that was found for the bootnode.
|
|
second_id: PeerId,
|
|
},
|
|
/// Prometheus metrics error.
|
|
#[error(transparent)]
|
|
Prometheus(#[from] prometheus_endpoint::PrometheusError),
|
|
/// The network addresses are invalid because they don't match the transport.
|
|
#[error(
|
|
"The following addresses are invalid because they don't match the transport: {addresses:?}"
|
|
)]
|
|
AddressesForAnotherTransport {
|
|
/// Transport used.
|
|
transport: TransportConfig,
|
|
/// The invalid addresses.
|
|
addresses: Vec<Multiaddr>,
|
|
},
|
|
/// The same request-response protocol has been registered multiple times.
|
|
#[error("Request-response protocol registered multiple times: {protocol}")]
|
|
DuplicateRequestResponseProtocol {
|
|
/// Name of the protocol registered multiple times.
|
|
protocol: ProtocolName,
|
|
},
|
|
/// Peer does not exist.
|
|
#[error("Peer `{0}` does not exist.")]
|
|
PeerDoesntExist(PeerId),
|
|
/// Channel closed.
|
|
#[error("Channel closed")]
|
|
ChannelClosed,
|
|
/// Connection closed.
|
|
#[error("Connection closed")]
|
|
ConnectionClosed,
|
|
}
|
|
|
|
// Make `Debug` use the `Display` implementation.
|
|
impl fmt::Debug for Error {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
fmt::Display::fmt(self, f)
|
|
}
|
|
}
|