pezkuwi-sdk/pezcumulus/pezpallets/aura-ext/src/test.rs

// Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute
// This file is part of Pezcumulus.
// SPDX-License-Identifier: Apache-2.0

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use super::*;
use core::num::NonZeroU32;
use pezcumulus_pezpallet_teyrchain_system::{
	consensus_hook::ExpectParentIncluded, Ancestor, AnyRelayNumber, ConsensusHook,
	RelayChainStateProof, TeyrchainSetCode, UsedBandwidth,
};
use pezcumulus_primitives_core::ParaId;
use pezframe_support::{
	derive_impl, parameter_types,
	pezpallet_prelude::ConstU32,
	traits::{ConstBool, EnqueueWithOrigin, ExecuteBlock, Hooks},
	BoundedVec,
};
use pezsp_consensus_aura::{sr25519::AuthorityId, Slot};
use pezsp_core::{Blake2Hasher, Get, H256};
use pezsp_io::TestExternalities;
use pezsp_keyring::Sr25519Keyring::*;
use pezsp_runtime::{generic::Digest, traits::Block as BlockT};
use pezsp_trie::{proof_size_extension::ProofSizeExt, recorder::Recorder};
use pezsp_version::RuntimeVersion;
use rstest::rstest;
use std::cell::RefCell;

// Test pezpallet that reads storage and calls storage_proof_size
#[pezframe_support::pezpallet]
pub mod test_pallet {
	use pezframe_support::pezpallet_prelude::*;
	use pezframe_system::pezpallet_prelude::*;

	#[pezpallet::config]
	pub trait Config: pezframe_system::Config {}

	#[pezpallet::pezpallet]
	pub struct Pezpallet<T>(_);

	#[pezpallet::storage]
	pub type TestStorage<T: Config> = StorageValue<_, u64, ValueQuery>;

	#[pezpallet::hooks]
	impl<T: Config> Hooks<BlockNumberFor<T>> for Pezpallet<T> {
		fn on_initialize(_n: BlockNumberFor<T>) -> Weight {
			let proof_size =
				pezcumulus_primitives_proof_size_hostfunction::storage_proof_size::storage_proof_size(
				);
			// We need to commit the `proof_size` to ensure that the test is failing if we are
			// receiving a different proof size later on.
			TestStorage::<T>::put(proof_size);

			Weight::zero()
		}
	}
}

type Block = pezframe_system::mocking::MockBlock<Test>;

pezframe_support::construct_runtime!(
	pub enum Test {
		System: pezframe_system,
		TeyrchainSystem: pezcumulus_pezpallet_teyrchain_system,
		Aura: pezpallet_aura,
		AuraExt: crate,
		TestPallet: test_pallet,
	}
);

parameter_types! {
	pub Version: RuntimeVersion = RuntimeVersion {
		spec_name: "test".into(),
		impl_name: "system-test".into(),
		authoring_version: 1,
		spec_version: 1,
		impl_version: 1,
		apis: pezsp_version::create_apis_vec!([]),
		transaction_version: 1,
		system_version: 1,
	};
}

#[derive_impl(pezframe_system::config_preludes::TestDefaultConfig)]
impl pezframe_system::Config for Test {
	type Block = Block;
	type Version = Version;
	type OnSetCode = TeyrchainSetCode<Test>;
	type RuntimeEvent = ();
}

impl crate::Config for Test {}

impl test_pallet::Config for Test {}

std::thread_local! {
	pub static PARA_SLOT_DURATION: RefCell<u64> = RefCell::new(6000);
}

pub struct TestSlotDuration;

impl TestSlotDuration {
	pub fn set_slot_duration(slot_duration: u64) {
		PARA_SLOT_DURATION.with(|v| *v.borrow_mut() = slot_duration);
	}
}
impl Get<u64> for TestSlotDuration {
	fn get() -> u64 {
		PARA_SLOT_DURATION.with(|v| v.clone().into_inner())
	}
}

impl pezpallet_aura::Config for Test {
	type AuthorityId = pezsp_consensus_aura::sr25519::AuthorityId;
	type MaxAuthorities = ConstU32<100_000>;
	type DisabledValidators = ();
	type AllowMultipleBlocksPerSlot = ConstBool<true>;
	type SlotDuration = TestSlotDuration;
}

impl pezpallet_timestamp::Config for Test {
	type Moment = u64;
	type OnTimestampSet = ();
	type MinimumPeriod = ();
	type WeightInfo = ();
}

impl pezcumulus_pezpallet_teyrchain_system::Config for Test {
	type WeightInfo = ();
	type RuntimeEvent = ();
	type OnSystemEvent = ();
	type SelfParaId = ();
	type OutboundXcmpMessageSource = ();
	// Ignore all DMP messages by enqueueing them into `()`:
	type DmpQueue = EnqueueWithOrigin<(), pezsp_core::ConstU8<0>>;
	type ReservedDmpWeight = ();
	type XcmpMessageHandler = ();
	type ReservedXcmpWeight = ();
	type CheckAssociatedRelayNumber = AnyRelayNumber;
	type ConsensusHook = ExpectParentIncluded;
	type RelayParentOffset = ConstU32<0>;
}

fn set_ancestors() {
	let mut ancestors = Vec::new();
	for i in 0..3 {
		let mut ancestor = Ancestor::new_unchecked(UsedBandwidth::default(), None);
		ancestor.replace_para_head_hash(H256::repeat_byte(i + 1));
		ancestors.push(ancestor);
	}
	pezcumulus_pezpallet_teyrchain_system::UnincludedSegment::<Test>::put(ancestors);
}

fn new_test_ext(para_slot: u64) -> pezsp_io::TestExternalities {
	let mut ext = TestExternalities::new_empty();
	ext.execute_with(|| {
		set_ancestors();
		// Set initial teyrchain slot
		pezpallet_aura::CurrentSlot::<Test>::put(Slot::from(para_slot));
	});
	ext
}

fn set_relay_slot(slot: u64, authored: u32) {
	RelaySlotInfo::<Test>::put((Slot::from(slot), authored))
}

fn relay_chain_state_proof(relay_slot: u64) -> RelayChainStateProof {
	let mut builder = pezcumulus_test_relay_sproof_builder::RelayStateSproofBuilder::default();
	builder.current_slot = relay_slot.into();

	let (hash, state_proof) = builder.into_state_root_and_proof();

	RelayChainStateProof::new(ParaId::from(200), hash, state_proof)
		.expect("Should be able to construct state proof.")
}

fn assert_slot_info(expected_slot: u64, expected_authored: u32) {
	let (slot, authored) = pezpallet::RelaySlotInfo::<Test>::get().unwrap();
	assert_eq!(slot, Slot::from(expected_slot), "Slot stored in RelaySlotInfo is incorrect.");
	assert_eq!(
		authored, expected_authored,
		"Number of authored blocks stored in RelaySlotInfo is incorrect."
	);
}

const DEFAULT_TEST_VELOCITY: u32 = 2;

#[test]
fn test_velocity() {
	type Hook = FixedVelocityConsensusHook<Test, 6000, DEFAULT_TEST_VELOCITY, 1>;

	new_test_ext(10).execute_with(|| {
		let state_proof = relay_chain_state_proof(10);
		let (_, capacity) = Hook::on_state_proof(&state_proof);
		assert_eq!(capacity, NonZeroU32::new(1).unwrap().into());
		assert_slot_info(10, 1);

		let (_, capacity) = Hook::on_state_proof(&state_proof);
		assert_eq!(capacity, NonZeroU32::new(1).unwrap().into());
		assert_slot_info(10, 2);
	});
}

#[test]
fn test_velocity_2() {
	type Hook = FixedVelocityConsensusHook<Test, 6000, DEFAULT_TEST_VELOCITY, 3>;

	new_test_ext(10).execute_with(|| {
		let state_proof = relay_chain_state_proof(10);
		let (_, capacity) = Hook::on_state_proof(&state_proof);
		assert_eq!(capacity, NonZeroU32::new(3).unwrap().into());
		assert_slot_info(10, 1);

		let (_, capacity) = Hook::on_state_proof(&state_proof);
		assert_eq!(capacity, NonZeroU32::new(3).unwrap().into());
		assert_slot_info(10, 2);
	});
}

#[test]
#[should_panic(expected = "authored blocks limit is reached for the slot")]
fn test_exceeding_velocity_limit() {
	type Hook = FixedVelocityConsensusHook<Test, 6000, DEFAULT_TEST_VELOCITY, 1>;

	new_test_ext(10).execute_with(|| {
		let state_proof = relay_chain_state_proof(10);
		for authored in 0..=DEFAULT_TEST_VELOCITY + 1 {
			Hook::on_state_proof(&state_proof);
			assert_slot_info(10, authored + 1);
		}
	});
}

#[test]
fn test_para_slot_calculated_from_slot_duration() {
	type Hook = FixedVelocityConsensusHook<Test, 3000, DEFAULT_TEST_VELOCITY, 1>;

	new_test_ext(5).execute_with(|| {
		let state_proof = relay_chain_state_proof(10);
		Hook::on_state_proof(&state_proof);
	});
}

#[rstest]
#[case::short_para_slot_okay(2000, 30, 10)]
#[case::normal_para_slot_okay(6000, 10, 10)]
// Test boundaries for long teyrchain slots.
#[case::long_para_slot_okay(24000, 1, 7)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(2), derived_from_relay_slot=Slot(1)"
)]
#[case::long_para_slot_mismatch(24000, 2, 7)]
#[case::long_para_slot_okay(24000, 2, 8)]
#[case::long_para_slot_okay(24000, 2, 9)]
#[case::long_para_slot_okay(24000, 2, 10)]
#[case::long_para_slot_okay(24000, 2, 11)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(2), derived_from_relay_slot=Slot(3)"
)]
#[case::long_para_slot_mismatch(24000, 2, 12)]
#[case::long_para_slot_okay(24000, 3, 12)]
#[case::short_para_slot(2000, 30, 10)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(31), derived_from_relay_slot=Slot(30)"
)]
#[case::short_para_slot_mismatch(2000, 31, 10)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(32), derived_from_relay_slot=Slot(30)"
)]
#[case::short_para_slot_mismatch(2000, 32, 10)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(29), derived_from_relay_slot=Slot(30)"
)]
#[case::short_para_slot_mismatch(2000, 29, 10)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(1), derived_from_relay_slot=Slot(30)"
)]
#[case::short_para_slot_mismatch(2000, 1, 10)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(1), derived_from_relay_slot=Slot(10)"
)]
#[case::normal_para_slot_mismatch(6000, 1, 10)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(9), derived_from_relay_slot=Slot(10)"
)]
#[case::normal_para_slot_mismatch(6000, 9, 10)]
#[should_panic(
	expected = "must match relay-derived slot: teyrchain_slot=Slot(11), derived_from_relay_slot=Slot(10)"
)]
#[case::normal_para_slot_mismatch(6000, 11, 10)]
fn test_para_slot_too_high(
	#[case] para_slot_duration: u64,
	#[case] para_slot: u64,
	#[case] relay_slot: u64,
) {
	type Hook = FixedVelocityConsensusHook<Test, 6000, DEFAULT_TEST_VELOCITY, 1>;

	TestSlotDuration::set_slot_duration(para_slot_duration);
	new_test_ext(para_slot).execute_with(|| {
		let state_proof = relay_chain_state_proof(relay_slot);
		Hook::on_state_proof(&state_proof);
	});
}

#[test]
fn test_velocity_at_least_one() {
	// Even though this is 0, one block should always be allowed.
	const VELOCITY: u32 = 0;
	type Hook = FixedVelocityConsensusHook<Test, 6000, VELOCITY, 1>;

	new_test_ext(10).execute_with(|| {
		let state_proof = relay_chain_state_proof(10);
		Hook::on_state_proof(&state_proof);
	});
}

#[test]
#[should_panic(
	expected = "Teyrchain slot must match relay-derived slot: teyrchain_slot=Slot(8), derived_from_relay_slot=Slot(5) velocity=2"
)]
fn test_para_slot_calculated_from_slot_duration_2() {
	// Note: In contrast to tests below, relay chain slot duration is 3000 here.
	type Hook = FixedVelocityConsensusHook<Test, 3000, DEFAULT_TEST_VELOCITY, 1>;

	new_test_ext(8).execute_with(|| {
		let state_proof = relay_chain_state_proof(10);
		let (_, _) = Hook::on_state_proof(&state_proof);
	});
}

#[test]
fn test_velocity_resets_on_new_relay_slot() {
	type Hook = FixedVelocityConsensusHook<Test, 6000, DEFAULT_TEST_VELOCITY, 1>;

	new_test_ext(10).execute_with(|| {
		let state_proof = relay_chain_state_proof(10);
		for authored in 0..=DEFAULT_TEST_VELOCITY {
			Hook::on_state_proof(&state_proof);
			assert_slot_info(10, authored + 1);
		}

		// Change teyrchain slot to match the new relay slot
		pezpallet_aura::CurrentSlot::<Test>::put(Slot::from(11));
		let state_proof = relay_chain_state_proof(11);
		for authored in 0..=DEFAULT_TEST_VELOCITY {
			Hook::on_state_proof(&state_proof);
			assert_slot_info(11, authored + 1);
		}
	});
}

#[test]
#[should_panic(expected = "Slot moved backwards: stored_slot=Slot(10), relay_chain_slot=Slot(9)")]
fn test_backward_relay_slot_not_tolerated() {
	type Hook = FixedVelocityConsensusHook<Test, 6000, 2, 1>;

	new_test_ext(10).execute_with(|| {
		let state_proof = relay_chain_state_proof(10);
		Hook::on_state_proof(&state_proof);
		assert_slot_info(10, 1);

		// Change teyrchain slot to match what would be derived from relay slot 9
		pezpallet_aura::CurrentSlot::<Test>::put(Slot::from(9));
		let state_proof = relay_chain_state_proof(9);
		Hook::on_state_proof(&state_proof);
	});
}

#[test]
fn test_can_build_upon_true_when_empty() {
	type Hook = FixedVelocityConsensusHook<Test, 6000, DEFAULT_TEST_VELOCITY, 1>;

	new_test_ext(1).execute_with(|| {
		let hash = H256::repeat_byte(0x1);
		assert!(Hook::can_build_upon(hash, Slot::from(1)));
	});
}

#[rstest]
#[case::slot_higher_ok(10, 11, DEFAULT_TEST_VELOCITY, true)]
#[case::slot_same_ok(10, 10, DEFAULT_TEST_VELOCITY, true)]
#[case::slot_decrease_illegal(10, 9, DEFAULT_TEST_VELOCITY, false)]
#[case::velocity_small_ok(10, 10, DEFAULT_TEST_VELOCITY - 1 , true)]
#[case::velocity_small_ok(10, 10, DEFAULT_TEST_VELOCITY - 2 , true)]
#[case::velocity_too_high_illegal(10, 10, DEFAULT_TEST_VELOCITY + 1 , false)]
fn test_can_build_upon_slot_can_not_decrease(
	#[case] state_relay_slot: u64,
	#[case] test_relay_slot: u64,
	#[case] authored_in_slot: u32,
	#[case] expected_result: bool,
) {
	type Hook = FixedVelocityConsensusHook<Test, 6000, DEFAULT_TEST_VELOCITY, 10>;

	new_test_ext(1).execute_with(|| {
		let hash = H256::repeat_byte(0x1);

		set_relay_slot(state_relay_slot, authored_in_slot);
		// Slot moves backwards
		assert_eq!(Hook::can_build_upon(hash, Slot::from(test_relay_slot)), expected_result);
	});
}

#[test]
fn test_can_build_upon_unincluded_segment_size() {
	type Hook = FixedVelocityConsensusHook<Test, 6000, DEFAULT_TEST_VELOCITY, 2>;

	new_test_ext(1).execute_with(|| {
		let relay_slot = Slot::from(10);

		set_relay_slot(10, DEFAULT_TEST_VELOCITY);
		// Size after included is two, we can not build
		assert!(!Hook::can_build_upon(H256::repeat_byte(0x1), relay_slot));

		// Size after included is one, we can build
		assert!(Hook::can_build_upon(H256::repeat_byte(0x2), relay_slot));
	});
}

/// This test ensures that when we call `BlockExecutor::execute_block` in `validate_block`,
/// it doesn't change the proof size host function return values. Otherwise, it may breaks
/// logic that is fetching the proof size in `on_initialize`.
#[test]
fn block_executor_does_not_influence_proof_size_recordings() {
	fn build_block(header: <Block as BlockT>::Header) -> <Block as BlockT>::Header {
		// Initialize the block
		pezframe_system::Pezpallet::<Test>::initialize(
			&header.number,
			&header.parent_hash,
			&header.digest(),
		);

		// We omit `teyrchain-system` as it is not important here.
		<pezframe_system::Pezpallet<Test> as Hooks<_>>::on_initialize(header.number);
		<crate::Pezpallet<Test> as Hooks<_>>::on_initialize(header.number);
		<test_pallet::Pezpallet<Test> as Hooks<_>>::on_initialize(header.number);

		<test_pallet::Pezpallet<Test> as Hooks<_>>::on_finalize(header.number);
		<crate::Pezpallet<Test> as Hooks<_>>::on_finalize(header.number);
		<pezframe_system::Pezpallet<Test> as Hooks<_>>::on_finalize(header.number);

		// Finalize the block
		pezframe_system::Pezpallet::<Test>::finalize()
	}

	// Create a simple executive that calls on_initialize and on_finalize
	struct TestExecutive;
	impl ExecuteBlock<Block> for TestExecutive {
		fn verify_and_remove_seal(_: &mut <Block as BlockT>::LazyBlock) {}

		fn execute_verified_block(block: <Block as BlockT>::LazyBlock) {
			let header = block.header();

			let new_header = build_block(header.clone());

			assert_eq!(*header, new_header);
		}
	}

	let mut ext = new_test_ext(10);

	ext.execute_with(|| {
		// Let's setup some authorities
		let authority_id = AuthorityId::from(Alice.public());
		let authorities: BoundedVec<AuthorityId, ConstU32<100_000>> =
			vec![authority_id.clone()].try_into().unwrap();
		pezpallet_aura::Authorities::<Test>::put(authorities.clone());
		Authorities::<Test>::put(authorities.clone());
	});

	ext.commit_all().unwrap();

	let recorder = Recorder::<Blake2Hasher>::default();

	// Register the ProofSizeExt extension
	ext.register_extension(ProofSizeExt::new(recorder.clone()));

	let mut header = ext.execute_with_recorder(recorder.clone(), || {
		let mut digest = Digest::default();
		digest.push(CompatibleDigestItem::<()>::aura_pre_digest(10u64.into()));

		build_block(HeaderT::new(
			1,
			Default::default(),
			Default::default(),
			Default::default(),
			digest,
		))
	});

	let sig = Alice.sign(header.hash().as_ref());
	let seal = CompatibleDigestItem::aura_seal(sig);
	header.digest_mut().push(seal);

	let mut block = Block::new(header, Default::default()).into();

	ext.reset_overlay();
	ext.execute_with_recorder(recorder, || {
		BlockExecutor::<Test, TestExecutive>::verify_and_remove_seal(&mut block);
	});

	let recorder = Recorder::<Blake2Hasher>::default();

	// Register the ProofSizeExt extension again to overwrite the old one.
	ext.register_extension(ProofSizeExt::new(recorder.clone()));

	ext.reset_overlay();
	ext.execute_with_recorder(recorder, || {
		BlockExecutor::<Test, TestExecutive>::execute_verified_block(block);
	});
}