pezkuwi-sdk/pezkuwi/node/network/collator-protocol/src/lib.rs

// Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute
// This file is part of Pezkuwi.

// Pezkuwi 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.

// Pezkuwi 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 Pezkuwi.  If not, see <http://www.gnu.org/licenses/>.

//! The Collator Protocol allows collators and validators talk to each other.
//! This subsystem implements both sides of the collator protocol.

#![deny(missing_docs)]
#![deny(unused_crate_dependencies)]
#![recursion_limit = "256"]

use std::{
	collections::HashSet,
	time::{Duration, Instant},
};

use futures::{
	stream::{FusedStream, StreamExt},
	FutureExt, TryFutureExt,
};

use pezkuwi_node_subsystem_util::reputation::ReputationAggregator;
use pezsp_keystore::KeystorePtr;

use pezkuwi_node_network_protocol::{
	request_response::{v2 as protocol_v2, IncomingRequestReceiver},
	PeerId, UnifiedReputationChange as Rep,
};
use pezkuwi_primitives::CollatorPair;

use pezkuwi_node_subsystem::{errors::SubsystemError, overseer, DummySubsystem, SpawnedSubsystem};

mod collator_side;
mod validator_side;
#[cfg(feature = "experimental-collator-protocol")]
mod validator_side_experimental;

const LOG_TARGET: &'static str = "teyrchain::collator-protocol";
const LOG_TARGET_STATS: &'static str = "teyrchain::collator-protocol::stats";

/// A collator eviction policy - how fast to evict collators which are inactive.
#[derive(Debug, Clone, Copy)]
pub struct CollatorEvictionPolicy {
	/// How fast to evict collators who are inactive.
	pub inactive_collator: Duration,
	/// How fast to evict peers which don't declare their para.
	pub undeclared: Duration,
}

impl Default for CollatorEvictionPolicy {
	fn default() -> Self {
		CollatorEvictionPolicy {
			inactive_collator: Duration::from_secs(24),
			undeclared: Duration::from_secs(1),
		}
	}
}

/// What side of the collator protocol is being engaged
pub enum ProtocolSide {
	/// Validators operate on the relay chain.
	Validator {
		/// The keystore holding validator keys.
		keystore: KeystorePtr,
		/// An eviction policy for inactive peers or validators.
		eviction_policy: CollatorEvictionPolicy,
		/// Prometheus metrics for validators.
		metrics: validator_side::Metrics,
		/// List of invulnerable collators which is handled with a priority.
		invulnerables: HashSet<PeerId>,
		/// Override for `HOLD_OFF_DURATION` constant .
		collator_protocol_hold_off: Option<Duration>,
	},
	/// Experimental variant of the validator side. Do not use in production.
	#[cfg(feature = "experimental-collator-protocol")]
	ValidatorExperimental {
		/// The keystore holding validator keys.
		keystore: KeystorePtr,
		/// Prometheus metrics for validators.
		metrics: validator_side_experimental::Metrics,
	},
	/// Collators operate on a teyrchain.
	Collator {
		/// Local peer id.
		peer_id: PeerId,
		/// Teyrchain collator pair.
		collator_pair: CollatorPair,
		/// Receiver for v2 collation fetching requests.
		request_receiver_v2: IncomingRequestReceiver<protocol_v2::CollationFetchingRequest>,
		/// Metrics.
		metrics: collator_side::Metrics,
	},
	/// No protocol side, just disable it.
	None,
}

/// The collator protocol subsystem.
pub struct CollatorProtocolSubsystem {
	protocol_side: ProtocolSide,
}

#[overseer::contextbounds(CollatorProtocol, prefix = self::overseer)]
impl CollatorProtocolSubsystem {
	/// Start the collator protocol.
	/// If `id` is `Some` this is a collator side of the protocol.
	/// If `id` is `None` this is a validator side of the protocol.
	/// Caller must provide a registry for prometheus metrics.
	pub fn new(protocol_side: ProtocolSide) -> Self {
		Self { protocol_side }
	}
}

#[overseer::subsystem(CollatorProtocol, error=SubsystemError, prefix=self::overseer)]
impl<Context> CollatorProtocolSubsystem {
	fn start(self, ctx: Context) -> SpawnedSubsystem {
		let future = match self.protocol_side {
			ProtocolSide::Validator {
				keystore,
				eviction_policy,
				metrics,
				invulnerables,
				collator_protocol_hold_off,
			} => {
				gum::trace!(
					target: LOG_TARGET,
					?invulnerables,
					?collator_protocol_hold_off,
					"AH collator protocol params",
				);
				validator_side::run(
					ctx,
					keystore,
					eviction_policy,
					metrics,
					invulnerables,
					collator_protocol_hold_off,
				)
				.map_err(|e| SubsystemError::with_origin("collator-protocol", e))
				.boxed()
			},
			#[cfg(feature = "experimental-collator-protocol")]
			ProtocolSide::ValidatorExperimental { keystore, metrics } => {
				validator_side_experimental::run(ctx, keystore, metrics)
					.map_err(|e| SubsystemError::with_origin("collator-protocol", e))
					.boxed()
			},
			ProtocolSide::Collator { peer_id, collator_pair, request_receiver_v2, metrics } => {
				collator_side::run(ctx, peer_id, collator_pair, request_receiver_v2, metrics)
					.map_err(|e| SubsystemError::with_origin("collator-protocol", e))
					.boxed()
			},
			ProtocolSide::None => return DummySubsystem.start(ctx),
		};

		SpawnedSubsystem { name: "collator-protocol-subsystem", future }
	}
}

/// Modify the reputation of a peer based on its behavior.
async fn modify_reputation(
	reputation: &mut ReputationAggregator,
	sender: &mut impl overseer::CollatorProtocolSenderTrait,
	peer: PeerId,
	rep: Rep,
) {
	gum::trace!(
		target: LOG_TARGET,
		rep = ?rep,
		peer_id = %peer,
		"reputation change for peer",
	);

	reputation.modify(sender, peer, rep).await;
}

/// Wait until tick and return the timestamp for the following one.
async fn wait_until_next_tick(last_poll: Instant, period: Duration) -> Instant {
	let now = Instant::now();
	let next_poll = last_poll + period;

	if next_poll > now {
		futures_timer::Delay::new(next_poll - now).await
	}

	Instant::now()
}

/// Returns an infinite stream that yields with an interval of `period`.
fn tick_stream(period: Duration) -> impl FusedStream<Item = ()> {
	futures::stream::unfold(Instant::now(), move |next_check| async move {
		Some(((), wait_until_next_tick(next_check, period).await))
	})
	.fuse()
}