feat: initialize Kurdistan SDK - independent fork of Polkadot SDK

pezkuwi/runtime/teyrchains/src/util.rs

@@ -0,0 +1,136 @@
+// Copyright (C) Parity Technologies (UK) Ltd.
+// 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/>.
+
+//! Utilities that don't belong to any particular module but may draw
+//! on all modules.
+
+use alloc::{collections::btree_set::BTreeSet, vec::Vec};
+use frame_system::pallet_prelude::BlockNumberFor;
+use pezkuwi_primitives::{HeadData, Id as ParaId, PersistedValidationData, ValidatorIndex};
+
+use crate::{configuration, hrmp, paras};
+
+/// Make the persisted validation data for a particular teyrchain, a specified relay-parent and it's
+/// storage root.
+///
+/// This ties together the storage of several modules.
+pub fn make_persisted_validation_data<T: paras::Config + hrmp::Config>(
+	para_id: ParaId,
+	relay_parent_number: BlockNumberFor<T>,
+	relay_parent_storage_root: T::Hash,
+) -> Option<PersistedValidationData<T::Hash, BlockNumberFor<T>>> {
+	let config = configuration::ActiveConfig::<T>::get();
+
+	Some(PersistedValidationData {
+		parent_head: paras::Heads::<T>::get(&para_id)?,
+		relay_parent_number,
+		relay_parent_storage_root,
+		max_pov_size: config.max_pov_size,
+	})
+}
+
+/// Make the persisted validation data for a particular teyrchain, a specified relay-parent, its
+/// storage root and parent head data.
+pub fn make_persisted_validation_data_with_parent<T: configuration::Config>(
+	relay_parent_number: BlockNumberFor<T>,
+	relay_parent_storage_root: T::Hash,
+	parent_head: HeadData,
+) -> PersistedValidationData<T::Hash, BlockNumberFor<T>> {
+	let config = configuration::ActiveConfig::<T>::get();
+
+	PersistedValidationData {
+		parent_head,
+		relay_parent_number,
+		relay_parent_storage_root,
+		max_pov_size: config.max_pov_size,
+	}
+}
+
+/// Take an active subset of a set containing all validators.
+///
+/// First item in pair will be all items in set have indices found in the `active` indices set (in
+/// the order of the `active` vec, the second item will contain the rest, in the original order.
+///
+/// ```ignore
+/// 		split_active_subset(active, all).0 == take_active_subset(active, all)
+/// ```
+pub fn split_active_subset<T: Clone>(active: &[ValidatorIndex], all: &[T]) -> (Vec<T>, Vec<T>) {
+	let active_set: BTreeSet<_> = active.iter().cloned().collect();
+	// active result has ordering of active set.
+	let active_result = take_active_subset(active, all);
+	// inactive result preserves original ordering of `all`.
+	let inactive_result = all
+		.iter()
+		.enumerate()
+		.filter(|(i, _)| !active_set.contains(&ValidatorIndex(*i as _)))
+		.map(|(_, v)| v)
+		.cloned()
+		.collect();
+
+	if active_result.len() != active.len() {
+		log::warn!(
+			target: "runtime::teyrchains",
+			"Took active validators from set with wrong size.",
+		);
+	}
+
+	(active_result, inactive_result)
+}
+
+/// Uses `split_active_subset` and concatenates the inactive to the active vec.
+///
+/// ```ignore
+/// 		split_active_subset(active, all)[0..active.len()]) == take_active_subset(active, all)
+/// ```
+pub fn take_active_subset_and_inactive<T: Clone>(active: &[ValidatorIndex], all: &[T]) -> Vec<T> {
+	let (mut a, mut i) = split_active_subset(active, all);
+	a.append(&mut i);
+	a
+}
+
+/// Take the active subset of a set containing all validators.
+pub fn take_active_subset<T: Clone>(active: &[ValidatorIndex], set: &[T]) -> Vec<T> {
+	let subset: Vec<_> = active.iter().filter_map(|i| set.get(i.0 as usize)).cloned().collect();
+
+	if subset.len() != active.len() {
+		log::warn!(
+			target: "runtime::teyrchains",
+			"Took active validators from set with wrong size",
+		);
+	}
+
+	subset
+}
+
+#[cfg(test)]
+mod tests {
+
+	use alloc::vec::Vec;
+
+	use crate::util::{split_active_subset, take_active_subset};
+	use pezkuwi_primitives::ValidatorIndex;
+
+	#[test]
+	fn take_active_subset_is_compatible_with_split_active_subset() {
+		let active: Vec<_> = vec![ValidatorIndex(1), ValidatorIndex(7), ValidatorIndex(3)];
+		let validators = vec![9, 1, 6, 7, 4, 5, 2, 3, 0, 8];
+		let (selected, unselected) = split_active_subset(&active, &validators);
+		let selected2 = take_active_subset(&active, &validators);
+		assert_eq!(selected, selected2);
+		assert_eq!(unselected, vec![9, 6, 4, 5, 2, 0, 8]);
+		assert_eq!(selected, vec![1, 3, 7]);
+	}
+}