mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-28 09:47:56 +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>
93 lines
3.1 KiB
Rust
93 lines
3.1 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/>.
|
|
|
|
//! Network event types. These are are not the part of the protocol, but rather
|
|
//! events that happen on the network like DHT get/put results received.
|
|
|
|
use crate::types::ProtocolName;
|
|
|
|
use bytes::Bytes;
|
|
use libp2p::{kad::record::Key, PeerId};
|
|
|
|
use sc_network_common::role::ObservedRole;
|
|
|
|
/// Events generated by DHT as a response to get_value and put_value requests.
|
|
#[derive(Debug, Clone)]
|
|
#[must_use]
|
|
pub enum DhtEvent {
|
|
/// The value was found.
|
|
ValueFound(Vec<(Key, Vec<u8>)>),
|
|
|
|
/// The requested record has not been found in the DHT.
|
|
ValueNotFound(Key),
|
|
|
|
/// The record has been successfully inserted into the DHT.
|
|
ValuePut(Key),
|
|
|
|
/// An error has occurred while putting a record into the DHT.
|
|
ValuePutFailed(Key),
|
|
}
|
|
|
|
/// Type for events generated by networking layer.
|
|
#[derive(Debug, Clone)]
|
|
#[must_use]
|
|
pub enum Event {
|
|
/// Event generated by a DHT.
|
|
Dht(DhtEvent),
|
|
|
|
/// Opened a substream with the given node with the given notifications protocol.
|
|
///
|
|
/// The protocol is always one of the notification protocols that have been registered.
|
|
NotificationStreamOpened {
|
|
/// Node we opened the substream with.
|
|
remote: PeerId,
|
|
/// The concerned protocol. Each protocol uses a different substream.
|
|
/// This is always equal to the value of
|
|
/// `sc_network::config::NonDefaultSetConfig::notifications_protocol` of one of the
|
|
/// configured sets.
|
|
protocol: ProtocolName,
|
|
/// If the negotiation didn't use the main name of the protocol (the one in
|
|
/// `notifications_protocol`), then this field contains which name has actually been
|
|
/// used.
|
|
/// Always contains a value equal to the value in
|
|
/// `sc_network::config::NonDefaultSetConfig::fallback_names`.
|
|
negotiated_fallback: Option<ProtocolName>,
|
|
/// Role of the remote.
|
|
role: ObservedRole,
|
|
/// Received handshake.
|
|
received_handshake: Vec<u8>,
|
|
},
|
|
|
|
/// Closed a substream with the given node. Always matches a corresponding previous
|
|
/// `NotificationStreamOpened` message.
|
|
NotificationStreamClosed {
|
|
/// Node we closed the substream with.
|
|
remote: PeerId,
|
|
/// The concerned protocol. Each protocol uses a different substream.
|
|
protocol: ProtocolName,
|
|
},
|
|
|
|
/// Received one or more messages from the given node using the given protocol.
|
|
NotificationsReceived {
|
|
/// Node we received the message from.
|
|
remote: PeerId,
|
|
/// Concerned protocol and associated message.
|
|
messages: Vec<(ProtocolName, Bytes)>,
|
|
},
|
|
}
|