vapcore-sync 1.12.0

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of Tetsy Vapory.

// Tetsy Vapory 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.

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

//! When sending packets over p2p we specify both which subprotocol
//! to use and what kind of packet we are sending (through a packet id).
//! Likewise when receiving packets from other peers we decode the
//! subprotocol and the packet id. This module helps coupling both
//! pieces of information together and provides an easy mechanism
//! to convert to/from the packet id values transmitted over the
//! wire.

use crate::api::{VAP_PROTOCOL, WARP_SYNC_PROTOCOL_ID};
use self::SyncPacket::*;

use enum_primitive::{enum_from_primitive, enum_from_primitive_impl, enum_from_primitive_impl_ty};
use network::{PacketId, ProtocolId};

enum_from_primitive! {
	/// An enum that defines all known packet ids in the context of
	/// synchronization and provides a mechanism to convert from
	/// packet ids (of type PacketId or u8) directly read from the network
	/// to enum variants. This implicitly provides a mechanism to
	/// check whether a given packet id is known, and to prevent
	/// packet id clashes when defining new ids.
	#[derive(Clone, Copy, Debug, PartialEq)]
	pub enum SyncPacket {
		StatusPacket = 0x00,
		NewBlockHashesPacket = 0x01,
		TransactionsPacket = 0x02,
		GetBlockHeadersPacket = 0x03,
		BlockHeadersPacket = 0x04,
		GetBlockBodiesPacket = 0x05,
		BlockBodiesPacket = 0x06,
		NewBlockPacket = 0x07,

		GetNodeDataPacket = 0x0d,
		NodeDataPacket = 0x0e,
		GetReceiptsPacket = 0x0f,
		ReceiptsPacket = 0x10,

		GetSnapshotManifestPacket = 0x11,
		SnapshotManifestPacket = 0x12,
		GetSnapshotDataPacket = 0x13,
		SnapshotDataPacket = 0x14,
		ConsensusDataPacket = 0x15,
		PrivateTransactionPacket = 0x16,
		SignedPrivateTransactionPacket = 0x17,
		GetPrivateStatePacket = 0x18,
		PrivateStatePacket = 0x19,
	}
}


/// Provide both subprotocol and packet id information within the
/// same object.
pub trait PacketInfo {
	/// Get packet id
	fn id(&self) -> PacketId;

	/// Get protocol id
	fn protocol(&self) -> ProtocolId;
}

// The mechanism to match packet ids and protocol may be improved
// through some macro magic, but for now this works.
impl PacketInfo for SyncPacket {
	fn protocol(&self) -> ProtocolId {
		match self {
			StatusPacket |
			NewBlockHashesPacket |
			TransactionsPacket |
			GetBlockHeadersPacket |
			BlockHeadersPacket |
			GetBlockBodiesPacket |
			BlockBodiesPacket |
			NewBlockPacket |

			GetNodeDataPacket|
			NodeDataPacket |
			GetReceiptsPacket |
			ReceiptsPacket

				=> VAP_PROTOCOL,

			GetSnapshotManifestPacket|
			SnapshotManifestPacket |
			GetSnapshotDataPacket |
			SnapshotDataPacket |
			ConsensusDataPacket |
			PrivateTransactionPacket |
			SignedPrivateTransactionPacket |
			GetPrivateStatePacket |
			PrivateStatePacket

				=> WARP_SYNC_PROTOCOL_ID,
		}
	}

	fn id(&self) -> PacketId {
		(*self) as PacketId
	}
}


#[cfg(test)]
mod tests {
	use super::*;
	use enum_primitive::FromPrimitive;

	#[test]
	fn packet_ids_from_u8_when_from_primitive_zero_then_equals_status_packet() {
		assert_eq!(SyncPacket::from_u8(0x00), Some(StatusPacket));
	}

	#[test]
	fn packet_ids_from_u8_when_from_primitive_eleven_then_equals_get_snapshot_manifest_packet() {
		assert_eq!(SyncPacket::from_u8(0x11), Some(GetSnapshotManifestPacket));
	}

	#[test]
	fn packet_ids_from_u8_when_invalid_packet_id_then_none() {
		assert!(SyncPacket::from_u8(0x99).is_none());
	}

	#[test]
	fn when_status_packet_then_id_and_protocol_match() {
		assert_eq!(StatusPacket.id(), StatusPacket as PacketId);
		assert_eq!(StatusPacket.protocol(), VAP_PROTOCOL);
	}

	#[test]
	fn when_consensus_data_packet_then_id_and_protocol_match() {
		assert_eq!(ConsensusDataPacket.id(), ConsensusDataPacket as PacketId);
		assert_eq!(ConsensusDataPacket.protocol(), WARP_SYNC_PROTOCOL_ID);
	}
}