refactor: migrate runtime storage Vec, BTreeSet, BTreeMap to their bounded versions

pallets/attestation/src/default_weights.rs

@@ -19,24 +19,22 @@
 //! Autogenerated weights for attestation
 //!
 //! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 3.0.0
-//! DATE: 2021-07-21, STEPS: {{cmd.steps}}\, REPEAT: {{cmd.repeat}}\, LOW RANGE: {{cmd.lowest_range_values}}\, HIGH RANGE: {{cmd.highest_range_values}}\
+//! DATE: 2021-08-11, STEPS: {{cmd.steps}}\, REPEAT: {{cmd.repeat}}\, LOW RANGE: {{cmd.lowest_range_values}}\, HIGH RANGE: {{cmd.highest_range_values}}\
 //! EXECUTION: Some(Wasm), WASM-EXECUTION: Compiled, CHAIN: Some("dev"), DB CACHE: 128
 
 // Executed Command:
-// target/release/kilt-parachain
+// /home/willi/mashnet-node/target/release/kilt-parachain
 // benchmark
 // --chain=dev
+// --steps=50
+// --repeat=20
+// --pallet=attestation
+// --extrinsic=*
 // --execution=wasm
-// --wasm-execution=Compiled
+// --wasm-execution=compiled
 // --heap-pages=4096
-// --extrinsic=*
-// --pallet=attestation
-// --steps=1
-// --repeat=20
-// --template
-// .maintain/weight-template.hbs
-// --output
-// pallets/attestation/src/default_weights.rs
+// --output=../../pallets/attestation/src/default_weights.rs
+// --template=../../.maintain/weight-template.hbs
 
 
 #![cfg_attr(rustfmt, rustfmt_skip)]
@@ -56,14 +54,14 @@ pub trait WeightInfo {
 pub struct SubstrateWeight<T>(PhantomData<T>);
 impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
 	fn add() -> Weight {
-		(38_091_000_u64)
+		(67_918_000_u64)
 			.saturating_add(T::DbWeight::get().reads(5_u64))
 			.saturating_add(T::DbWeight::get().writes(2_u64))
 	}
 	fn revoke(d: u32, ) -> Weight {
-		(25_042_000_u64)
-			// Standard Error: 28_000
-			.saturating_add((4_866_000_u64).saturating_mul(d as Weight))
+		(46_093_000_u64)
+			// Standard Error: 202_000
+			.saturating_add((8_252_000_u64).saturating_mul(d as Weight))
 			.saturating_add(T::DbWeight::get().reads(2_u64))
 			.saturating_add(T::DbWeight::get().reads((1_u64).saturating_mul(d as Weight)))
 			.saturating_add(T::DbWeight::get().writes(1_u64))
@@ -73,14 +71,14 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
 // For backwards compatibility and tests
 impl WeightInfo for () {
 	fn add() -> Weight {
-		(38_091_000_u64)
+		(67_918_000_u64)
 			.saturating_add(RocksDbWeight::get().reads(5_u64))
 			.saturating_add(RocksDbWeight::get().writes(2_u64))
 	}
 	fn revoke(d: u32, ) -> Weight {
-		(25_042_000_u64)
-			// Standard Error: 28_000
-			.saturating_add((4_866_000_u64).saturating_mul(d as Weight))
+		(46_093_000_u64)
+			// Standard Error: 202_000
+			.saturating_add((8_252_000_u64).saturating_mul(d as Weight))
 			.saturating_add(RocksDbWeight::get().reads(2_u64))
 			.saturating_add(RocksDbWeight::get().reads((1_u64).saturating_mul(d as Weight)))
 			.saturating_add(RocksDbWeight::get().writes(1_u64))

pallets/attestation/src/lib.rs

@@ -85,16 +85,14 @@ pub mod benchmarking;
 #[cfg(test)]
 mod tests;
 
-use sp_std::vec::Vec;
-
 pub use crate::{attestations::*, default_weights::WeightInfo, pallet::*};
 
 use frame_support::traits::Get;
 
 #[frame_support::pallet]
 pub mod pallet {
 	use super::*;
-	use frame_support::pallet_prelude::*;
+	use frame_support::{pallet_prelude::*, BoundedVec};
 	use frame_system::pallet_prelude::*;
 
 	/// Type of a claim hash.
@@ -114,6 +112,11 @@ pub mod pallet {
 		type EnsureOrigin: EnsureOrigin<Success = AttesterOf<Self>, <Self as frame_system::Config>::Origin>;
 		type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
 		type WeightInfo: WeightInfo;
+
+		/// The maximum number of delegated attestations which can be made by
+		/// the same delegation.
+		#[pallet::constant]
+		type MaxDelegatedAttestations: Get<u32>;
 	}
 
 	#[pallet::pallet]
@@ -135,7 +138,12 @@ pub mod pallet {
 	/// It maps from a delegation ID to a vector of claim hashes.
 	#[pallet::storage]
 	#[pallet::getter(fn delegated_attestations)]
-	pub type DelegatedAttestations<T> = StorageMap<_, Blake2_128Concat, DelegationNodeIdOf<T>, Vec<ClaimHashOf<T>>>;
+	pub type DelegatedAttestations<T> = StorageMap<
+		_,
+		Blake2_128Concat,
+		DelegationNodeIdOf<T>,
+		BoundedVec<ClaimHashOf<T>, <T as Config>::MaxDelegatedAttestations>,
+	>;
 
 	#[pallet::event]
 	#[pallet::generate_deposit(pub(super) fn deposit_event)]
@@ -178,6 +186,10 @@ pub mod pallet {
 		/// is but it has been revoked. Only when the revoker is not the
 		/// original attester.
 		UnauthorizedRevocation,
+		/// The maximum number of delegated attestations has already been
+		/// reached for the corresponding delegation id such that another one
+		/// cannot be added.
+		MaxDelegatedAttestationsExceeded,
 	}
 
 	#[pallet::call]
@@ -244,7 +256,9 @@ pub mod pallet {
 
 				// If the attestation is based on a delegation, store separately
 				let mut delegated_attestations = <DelegatedAttestations<T>>::get(delegation_id).unwrap_or_default();
-				delegated_attestations.push(claim_hash);
+				delegated_attestations
+					.try_push(claim_hash)
+					.map_err(|_| Error::<T>::MaxDelegatedAttestationsExceeded)?;
 				<DelegatedAttestations<T>>::insert(delegation_id, delegated_attestations);
 			}
 

pallets/attestation/src/mock.rs

@@ -23,7 +23,7 @@ use crate::*;
 use ctype::mock as ctype_mock;
 
 use codec::Decode;
-use frame_support::{ensure, parameter_types, weights::constants::RocksDbWeight};
+use frame_support::{ensure, parameter_types, weights::constants::RocksDbWeight, BoundedVec};
 use frame_system::EnsureSigned;
 use sp_core::{ed25519, sr25519, Pair};
 use sp_keystore::{testing::KeyStore, KeystoreExt};
@@ -100,6 +100,8 @@ parameter_types! {
 	pub const MaxSignatureByteLength: u16 = 64;
 	pub const MaxParentChecks: u32 = 5;
 	pub const MaxRevocations: u32 = 5;
+	#[derive(Clone)]
+	pub const MaxChildren: u32 = 1000;
 }
 
 impl delegation::Config for Test {
@@ -111,13 +113,20 @@ impl delegation::Config for Test {
 	type MaxSignatureByteLength = MaxSignatureByteLength;
 	type MaxParentChecks = MaxParentChecks;
 	type MaxRevocations = MaxRevocations;
+	type MaxChildren = MaxChildren;
 	type WeightInfo = ();
 }
 
+parameter_types! {
+	// TODO: Find reasonable number
+	pub const MaxDelegatedAttestations: u32 = 1000;
+}
+
 impl Config for Test {
 	type EnsureOrigin = EnsureSigned<TestAttester>;
 	type Event = ();
 	type WeightInfo = ();
+	type MaxDelegatedAttestations = MaxDelegatedAttestations;
 }
 
 impl delegation::VerifyDelegateSignature for Test {
@@ -227,7 +236,10 @@ pub fn generate_base_attestation(attester: TestAttester) -> AttestationDetails<T
 #[derive(Clone)]
 pub struct ExtBuilder {
 	attestations_stored: Vec<(TestClaimHash, AttestationDetails<Test>)>,
-	delegated_attestations_stored: Vec<(TestDelegationNodeId, Vec<TestClaimHash>)>,
+	delegated_attestations_stored: Vec<(
+		TestDelegationNodeId,
+		BoundedVec<TestClaimHash, <Test as Config>::MaxDelegatedAttestations>,
+	)>,
 }
 
 impl Default for ExtBuilder {
@@ -247,7 +259,10 @@ impl ExtBuilder {
 
 	pub fn with_delegated_attestations(
 		mut self,
-		delegated_attestations: Vec<(TestDelegationNodeId, Vec<TestClaimHash>)>,
+		delegated_attestations: Vec<(
+			TestDelegationNodeId,
+			BoundedVec<TestClaimHash, <Test as Config>::MaxDelegatedAttestations>,
+		)>,
 	) -> Self {
 		self.delegated_attestations_stored = delegated_attestations;
 		self

pallets/delegation/src/benchmarking.rs

@@ -18,12 +18,12 @@
 
 use codec::Encode;
 use frame_benchmarking::{account, benchmarks, impl_benchmark_test_suite};
-use frame_support::dispatch::DispatchErrorWithPostInfo;
+use frame_support::{dispatch::DispatchErrorWithPostInfo, storage::bounded_btree_set::BoundedBTreeSet};
 use frame_system::RawOrigin;
 use sp_core::{offchain::KeyTypeId, sr25519};
 use sp_io::crypto::sr25519_generate;
 use sp_runtime::MultiSignature;
-use sp_std::{collections::btree_set::BTreeSet, num::NonZeroU32, vec::Vec};
+use sp_std::{num::NonZeroU32, vec::Vec};
 
 use crate::*;
 
@@ -223,7 +223,7 @@ benchmarks! {
 		let c in 1 .. T::MaxParentChecks::get();
 		let (_, hierarchy_id, leaf_acc, leaf_id) = setup_delegations::<T>(r, ONE_CHILD_PER_LEVEL.expect(">0"), Permissions::DELEGATE)?;
 		let root_node = DelegationNodes::<T>::get(hierarchy_id).expect("Root hierarchy node should be present on chain.");
-		let children: BTreeSet<T::DelegationNodeId> = root_node.children;
+		let children: BoundedBTreeSet<T::DelegationNodeId, T::MaxChildren> = root_node.children;
 		let child_id: T::DelegationNodeId = *children.iter().next().ok_or("Root should have children")?;
 		let child_delegation = DelegationNodes::<T>::get(child_id).ok_or("Child of root should have delegation id")?;
 	}: revoke_delegation(RawOrigin::Signed(child_delegation.details.owner.clone()), child_id, c, r)

pallets/delegation/src/default_weights.rs

@@ -19,24 +19,22 @@
 //! Autogenerated weights for delegation
 //!
 //! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 3.0.0
-//! DATE: 2021-07-21, STEPS: {{cmd.steps}}\, REPEAT: {{cmd.repeat}}\, LOW RANGE: {{cmd.lowest_range_values}}\, HIGH RANGE: {{cmd.highest_range_values}}\
+//! DATE: 2021-08-11, STEPS: {{cmd.steps}}\, REPEAT: {{cmd.repeat}}\, LOW RANGE: {{cmd.lowest_range_values}}\, HIGH RANGE: {{cmd.highest_range_values}}\
 //! EXECUTION: Some(Wasm), WASM-EXECUTION: Compiled, CHAIN: Some("dev"), DB CACHE: 128
 
 // Executed Command:
-// target/release/kilt-parachain
+// /home/willi/mashnet-node/target/release/kilt-parachain
 // benchmark
 // --chain=dev
+// --steps=50
+// --repeat=20
+// --pallet=delegation
+// --extrinsic=*
 // --execution=wasm
-// --wasm-execution=Compiled
+// --wasm-execution=compiled
 // --heap-pages=4096
-// --extrinsic=*
-// --pallet=delegation
-// --steps=1
-// --repeat=20
-// --template
-// .maintain/weight-template.hbs
-// --output
-// pallets/delegation/src/default_weights.rs
+// --output=../../pallets/delegation/src/default_weights.rs
+// --template=../../.maintain/weight-template.hbs
 
 
 #![cfg_attr(rustfmt, rustfmt_skip)]
@@ -58,29 +56,29 @@ pub trait WeightInfo {
 pub struct SubstrateWeight<T>(PhantomData<T>);
 impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
 	fn create_hierarchy() -> Weight {
-		(24_797_000_u64)
+		(49_402_000_u64)
 			.saturating_add(T::DbWeight::get().reads(2_u64))
 			.saturating_add(T::DbWeight::get().writes(2_u64))
 	}
 	fn add_delegation() -> Weight {
-		(80_841_000_u64)
+		(131_777_000_u64)
 			.saturating_add(T::DbWeight::get().reads(2_u64))
 			.saturating_add(T::DbWeight::get().writes(2_u64))
 	}
 	fn revoke_delegation_root_child(r: u32, _c: u32, ) -> Weight {
-		(17_804_000_u64)
-			// Standard Error: 94_000
-			.saturating_add((17_445_000_u64).saturating_mul(r as Weight))
+		(32_769_000_u64)
+			// Standard Error: 373_000
+			.saturating_add((29_614_000_u64).saturating_mul(r as Weight))
 			.saturating_add(T::DbWeight::get().reads(1_u64))
 			.saturating_add(T::DbWeight::get().reads((1_u64).saturating_mul(r as Weight)))
 			.saturating_add(T::DbWeight::get().writes((1_u64).saturating_mul(r as Weight)))
 	}
 	fn revoke_delegation_leaf(r: u32, c: u32, ) -> Weight {
-		(31_213_000_u64)
-			// Standard Error: 61_000
-			.saturating_add((327_000_u64).saturating_mul(r as Weight))
-			// Standard Error: 61_000
-			.saturating_add((5_210_000_u64).saturating_mul(c as Weight))
+		(54_214_000_u64)
+			// Standard Error: 196_000
+			.saturating_add((484_000_u64).saturating_mul(r as Weight))
+			// Standard Error: 196_000
+			.saturating_add((8_692_000_u64).saturating_mul(c as Weight))
 			.saturating_add(T::DbWeight::get().reads(2_u64))
 			.saturating_add(T::DbWeight::get().reads((1_u64).saturating_mul(c as Weight)))
 			.saturating_add(T::DbWeight::get().writes(1_u64))
@@ -90,29 +88,29 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
 // For backwards compatibility and tests
 impl WeightInfo for () {
 	fn create_hierarchy() -> Weight {
-		(24_797_000_u64)
+		(49_402_000_u64)
 			.saturating_add(RocksDbWeight::get().reads(2_u64))
 			.saturating_add(RocksDbWeight::get().writes(2_u64))
 	}
 	fn add_delegation() -> Weight {
-		(80_841_000_u64)
+		(131_777_000_u64)
 			.saturating_add(RocksDbWeight::get().reads(2_u64))
 			.saturating_add(RocksDbWeight::get().writes(2_u64))
 	}
 	fn revoke_delegation_root_child(r: u32, _c: u32, ) -> Weight {
-		(17_804_000_u64)
-			// Standard Error: 94_000
-			.saturating_add((17_445_000_u64).saturating_mul(r as Weight))
+		(32_769_000_u64)
+			// Standard Error: 373_000
+			.saturating_add((29_614_000_u64).saturating_mul(r as Weight))
 			.saturating_add(RocksDbWeight::get().reads(1_u64))
 			.saturating_add(RocksDbWeight::get().reads((1_u64).saturating_mul(r as Weight)))
 			.saturating_add(RocksDbWeight::get().writes((1_u64).saturating_mul(r as Weight)))
 	}
 	fn revoke_delegation_leaf(r: u32, c: u32, ) -> Weight {
-		(31_213_000_u64)
-			// Standard Error: 61_000
-			.saturating_add((327_000_u64).saturating_mul(r as Weight))
-			// Standard Error: 61_000
-			.saturating_add((5_210_000_u64).saturating_mul(c as Weight))
+		(54_214_000_u64)
+			// Standard Error: 196_000
+			.saturating_add((484_000_u64).saturating_mul(r as Weight))
+			// Standard Error: 196_000
+			.saturating_add((8_692_000_u64).saturating_mul(c as Weight))
 			.saturating_add(RocksDbWeight::get().reads(2_u64))
 			.saturating_add(RocksDbWeight::get().reads((1_u64).saturating_mul(c as Weight)))
 			.saturating_add(RocksDbWeight::get().writes(1_u64))

pallets/delegation/src/delegation_hierarchy.rs

@@ -19,7 +19,7 @@
 use bitflags::bitflags;
 use codec::{Decode, Encode};
 use ctype::CtypeHashOf;
-use sp_std::collections::btree_set::BTreeSet;
+use frame_support::{dispatch::DispatchResult, storage::bounded_btree_set::BoundedBTreeSet};
 
 use crate::*;
 
@@ -59,14 +59,14 @@ impl Default for Permissions {
 /// For quicker lookups of the hierarchy details, all nodes maintain a direct
 /// link to the hierarchy root node. Furthermore, all nodes have a parent except
 /// the root nodes, which point to themselves for the hierarchy root node link.
-#[derive(Clone, Debug, Encode, Decode, PartialEq)]
+#[derive(Clone, Encode, Decode, PartialEq)]
 pub struct DelegationNode<T: Config> {
 	/// The ID of the delegation hierarchy the node is part of.
 	pub hierarchy_root_id: DelegationNodeIdOf<T>,
 	/// The ID of the parent. For all but root nodes this is not None.
 	pub parent: Option<DelegationNodeIdOf<T>>,
 	/// The set of IDs of all the children nodes.
-	pub children: BTreeSet<DelegationNodeIdOf<T>>,
+	pub children: BoundedBTreeSet<DelegationNodeIdOf<T>, T::MaxChildren>,
 	/// The additional information attached to the delegation node.
 	pub details: DelegationDetails<T>,
 }
@@ -78,7 +78,7 @@ impl<T: Config> DelegationNode<T> {
 		Self {
 			hierarchy_root_id: id,
 			parent: None,
-			children: BTreeSet::new(),
+			children: BoundedBTreeSet::<DelegationNodeIdOf<T>, T::MaxChildren>::new(),
 			details,
 		}
 	}
@@ -93,14 +93,17 @@ impl<T: Config> DelegationNode<T> {
 		Self {
 			hierarchy_root_id,
 			parent: Some(parent),
-			children: BTreeSet::new(),
+			children: BoundedBTreeSet::<DelegationNodeIdOf<T>, T::MaxChildren>::new(),
 			details,
 		}
 	}
 
 	/// Adds a node by its ID to the current node's children.
-	pub fn add_child(&mut self, child_id: DelegationNodeIdOf<T>) {
-		self.children.insert(child_id);
+	pub fn try_add_child(&mut self, child_id: DelegationNodeIdOf<T>) -> DispatchResult {
+		self.children
+			.try_insert(child_id)
+			.map_err(|_| Error::<T>::MaxChildrenExceeded)?;
+		Ok(())
 	}
 }