feat: new pallets into runtime (#784)

Part of KILTprotocol/ticket#3650, built on top
of #782.

I left a few comments on the review to help the reviewer understanding
the context of this changeset.

## Checklist

- [x] Add dotnames pallet to both runtimes
- [x] Add second linking deployment with unique linking to both runtimes
- [ ] ~Add new runtime API for batch resolution to both runtimes~ ->
will do in a separate PR along with a new runtime API for unique linking
resolution

Author: ntn-x2

pallets/pallet-migration/src/benchmarking.rs

@@ -66,6 +66,7 @@ benchmarks! {
 		<T as did::Config>::Currency: ReservableCurrency<AccountIdOf<T>, Balance = <<T as did::Config>::Currency as Inspect<AccountIdOf<T>>>::Balance>,
 		<T as pallet_did_lookup::Config>::Currency: ReservableCurrency<AccountIdOf<T>,Balance = <<T as pallet_did_lookup::Config>::Currency as Inspect<AccountIdOf<T>>>::Balance>,
 		<T as pallet_web3_names::Config>::Currency: ReservableCurrency<AccountIdOf<T>, Balance = <<T as pallet_web3_names::Config>::Currency as Inspect<AccountIdOf<T>>>::Balance>,
+		<<T as pallet_web3_names::Config>::Web3Name as TryFrom<Vec<u8>>>::Error: Into<pallet_web3_names::Error<T>>,
 		<T as public_credentials::Config>::Currency: ReservableCurrency<AccountIdOf<T>, Balance = <<T as public_credentials::Config>::Currency as Inspect<AccountIdOf<T>>>::Balance>,
 		<T as did::Config>::DidIdentifier: From<AccountId32>,
 		<T as frame_system::Config>::AccountId: From<AccountId32>,
@@ -188,7 +189,9 @@ benchmarks! {
 		pallet_balances::Pallet::<T>::set_balance(&sender, KILT.saturated_into());
 		pallet_web3_names::Pallet::<T>::claim(origin, web3_name_input.clone()).expect("Should register the claimed web3 name.");
 		kilt_support::migration::translate_holds_to_reserve::<T>(pallet_web3_names::HoldReason::Deposit.into());
-		let web3_name = Web3NameOf::<T>::try_from(web3_name_input.to_vec()).unwrap();
+		let Ok(web3_name) = Web3NameOf::<T>::try_from(web3_name_input.to_vec()) else {
+			panic!();
+		};
 
 		let entries_to_migrate = EntriesToMigrate {
 			w3n: BoundedVec::try_from(vec![web3_name]).expect("Vector initialization should not fail."),

pallets/pallet-web3-names/src/benchmarking.rs

@@ -34,7 +34,7 @@ use sp_std::{vec, vec::Vec};
 use kilt_support::{traits::GenerateBenchmarkOrigin, Deposit};
 
 use crate::{
-	mock::insert_raw_w3n, AccountIdOf, Banned, Call, Config, CurrencyOf, Names, Owner, Pallet, Web3NameOf,
+	mock::insert_raw_w3n, AccountIdOf, Banned, Call, Config, CurrencyOf, Error, Names, Owner, Pallet, Web3NameOf,
 	Web3NameOwnerOf,
 };
 
@@ -64,6 +64,7 @@ benchmarks_instance_pallet! {
 		T::Web3NameOwner: From<T::AccountId>,
 		T::OwnerOrigin: GenerateBenchmarkOrigin<T::RuntimeOrigin, T::AccountId, T::Web3NameOwner>,
 		T::BanOrigin: EnsureOrigin<T::RuntimeOrigin>,
+		<<T as Config<I>>::Web3Name as TryFrom<Vec<u8>>>::Error: Into<Error<T, I>>,
 		<T as Config<I>>::Currency: Mutate<T::AccountId>,
 	}
 
@@ -78,7 +79,9 @@ benchmarks_instance_pallet! {
 		make_free_for_did::<T, I>(&caller);
 	}: _<T::RuntimeOrigin>(origin, web3_name_input_clone)
 	verify {
-		let web3_name = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()).unwrap();
+		let Ok(web3_name) = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()) else {
+			panic!();
+		};
 		assert!(Names::<T, I>::get(&owner).is_some());
 		assert!(Owner::<T, I>::get(&web3_name).is_some());
 	}
@@ -93,7 +96,9 @@ benchmarks_instance_pallet! {
 		Pallet::<T, I>::claim(origin.clone(), web3_name_input.clone()).expect("Should register the claimed web3 name.");
 	}: _<T::RuntimeOrigin>(origin)
 	verify {
-		let web3_name = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()).unwrap();
+		let Ok(web3_name) = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()) else {
+			panic!();
+		};
 		assert!(Names::<T, I>::get(&owner).is_none());
 		assert!(Owner::<T, I>::get(&web3_name).is_none());
 	}
@@ -111,7 +116,9 @@ benchmarks_instance_pallet! {
 		Pallet::<T, I>::claim(did_origin, web3_name_input.clone()).expect("Should register the claimed web3 name.");
 	}: _(signed_origin, web3_name_input_clone)
 	verify {
-		let web3_name = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()).unwrap();
+		let Ok(web3_name) = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()) else {
+			panic!();
+		};
 		assert!(Names::<T, I>::get(&owner).is_none());
 		assert!(Owner::<T, I>::get(&web3_name).is_none());
 	}
@@ -129,7 +136,9 @@ benchmarks_instance_pallet! {
 		Pallet::<T, I>::claim(did_origin, web3_name_input.clone()).expect("Should register the claimed web3 name.");
 	}: _(ban_origin, web3_name_input_clone)
 	verify {
-		let web3_name = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()).unwrap();
+		let Ok(web3_name) = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()) else {
+			panic!();
+		};
 		assert!(Names::<T, I>::get(&owner).is_none());
 		assert!(Owner::<T, I>::get(&web3_name).is_none());
 		assert!(Banned::<T, I>::get(&web3_name).is_some());
@@ -147,7 +156,9 @@ benchmarks_instance_pallet! {
 		Pallet::<T, I>::ban(ban_origin.clone().into(), web3_name_input.clone()).expect("Should ban the web3 name.");
 	}: _(ban_origin, web3_name_input_clone)
 	verify {
-		let web3_name = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()).unwrap();
+		let Ok(web3_name) = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()) else {
+			panic!();
+		};
 		assert!(Names::<T, I>::get(&owner).is_none());
 		assert!(Owner::<T, I>::get(&web3_name).is_none());
 		assert!(Banned::<T, I>::get(&web3_name).is_none());
@@ -170,7 +181,9 @@ benchmarks_instance_pallet! {
 		let origin = T::OwnerOrigin::generate_origin(deposit_owner_new.clone(), owner);
 	}: _<T::RuntimeOrigin>(origin)
 	verify {
-		let web3_name = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()).unwrap();
+		let Ok(web3_name) = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()) else {
+			panic!();
+		};
 		assert_eq!(Owner::<T, I>::get(&web3_name).expect("w3n should exists").deposit, Deposit {
 			owner: deposit_owner_new,
 			amount: <T as Config<I>>::Deposit::get(),
@@ -183,7 +196,9 @@ benchmarks_instance_pallet! {
 		let web3_name_input: BoundedVec<u8, T::MaxNameLength> = BoundedVec::try_from(
 			generate_web3_name_input(T::MaxNameLength::get().saturated_into())
 		).expect("BoundedVec creation should not fail.");
-		let web3_name = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()).unwrap();
+		let Ok(web3_name) = Web3NameOf::<T, I>::try_from(web3_name_input.to_vec()) else {
+			panic!();
+		};
 
 		make_free_for_did::<T, I>(&deposit_owner);
 		insert_raw_w3n::<T, I>(

pallets/pallet-web3-names/src/lib.rs

@@ -141,14 +141,7 @@ pub mod pallet {
 		// FIXME: Refactor the definition of AsciiWeb3Name so that we don't need to
 		// require `Ord` here
 		/// The type of a name.
-		type Web3Name: FullCodec
-			+ Debug
-			+ PartialEq
-			+ Clone
-			+ TypeInfo
-			+ TryFrom<Vec<u8>, Error = Error<Self, I>>
-			+ MaxEncodedLen
-			+ Ord;
+		type Web3Name: FullCodec + Debug + PartialEq + Clone + TypeInfo + TryFrom<Vec<u8>> + MaxEncodedLen + Ord;
 		/// The type of a name owner.
 		type Web3NameOwner: Parameter + MaxEncodedLen;
 		/// Weight information for extrinsics in this pallet.
@@ -225,7 +218,11 @@ pub mod pallet {
 	}
 
 	#[pallet::call]
-	impl<T: Config<I>, I: 'static> Pallet<T, I> {
+	impl<T: Config<I>, I: 'static> Pallet<T, I>
+	where
+		// We introduce this trait bound instead of adding one more generic.
+		<<T as Config<I>>::Web3Name as TryFrom<Vec<u8>>>::Error: Into<Error<T, I>>,
+	{
 		/// Assign the specified name to the owner as specified in the
 		/// origin.
 		///
@@ -399,7 +396,8 @@ pub mod pallet {
 		#[pallet::weight(<T as Config<I>>::WeightInfo::update_deposit())]
 		pub fn update_deposit(origin: OriginFor<T>, name_input: Web3NameInput<T, I>) -> DispatchResult {
 			let source = ensure_signed(origin)?;
-			let name = Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(DispatchError::from)?;
+			let name =
+				Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(|e| DispatchError::from(e.into()))?;
 			let w3n_entry = Owner::<T, I>::get(&name).ok_or(Error::<T, I>::NotFound)?;
 			ensure!(w3n_entry.deposit.owner == source, Error::<T, I>::NotAuthorized);
 
@@ -409,7 +407,10 @@ pub mod pallet {
 		}
 	}
 
-	impl<T: Config<I>, I: 'static> Pallet<T, I> {
+	impl<T: Config<I>, I: 'static> Pallet<T, I>
+	where
+		<<T as Config<I>>::Web3Name as TryFrom<Vec<u8>>>::Error: Into<Error<T, I>>,
+	{
 		/// Verify that the claiming preconditions are verified. Specifically:
 		/// - The name input data can be decoded as a valid name
 		/// - The name does not already exist
@@ -421,7 +422,8 @@ pub mod pallet {
 			owner: &Web3NameOwnerOf<T, I>,
 			deposit_payer: &AccountIdOf<T>,
 		) -> Result<Web3NameOf<T, I>, DispatchError> {
-			let name = Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(DispatchError::from)?;
+			let name =
+				Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(|e| DispatchError::from(e.into()))?;
 
 			ensure!(!Names::<T, I>::contains_key(owner), Error::<T, I>::OwnerAlreadyExists);
 			ensure!(!Owner::<T, I>::contains_key(&name), Error::<T, I>::AlreadyExists);
@@ -487,7 +489,8 @@ pub mod pallet {
 			name_input: Web3NameInput<T, I>,
 			caller: &AccountIdOf<T>,
 		) -> Result<Web3NameOf<T, I>, DispatchError> {
-			let name = Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(DispatchError::from)?;
+			let name =
+				Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(|e| DispatchError::from(e.into()))?;
 			let Web3NameOwnership { deposit, .. } = Owner::<T, I>::get(&name).ok_or(Error::<T, I>::NotFound)?;
 
 			ensure!(caller == &deposit.owner, Error::<T, I>::NotAuthorized);
@@ -534,7 +537,8 @@ pub mod pallet {
 		fn check_banning_preconditions(
 			name_input: Web3NameInput<T, I>,
 		) -> Result<(Web3NameOf<T, I>, bool), DispatchError> {
-			let name = Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(DispatchError::from)?;
+			let name =
+				Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(|e| DispatchError::from(e.into()))?;
 
 			ensure!(!Banned::<T, I>::contains_key(&name), Error::<T, I>::AlreadyBanned);
 
@@ -555,7 +559,8 @@ pub mod pallet {
 		/// - The name input data can be decoded as a valid name
 		/// - The name must have already been banned
 		fn check_unbanning_preconditions(name_input: Web3NameInput<T, I>) -> Result<Web3NameOf<T, I>, DispatchError> {
-			let name = Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(DispatchError::from)?;
+			let name =
+				Web3NameOf::<T, I>::try_from(name_input.into_inner()).map_err(|e| DispatchError::from(e.into()))?;
 
 			ensure!(Banned::<T, I>::contains_key(&name), Error::<T, I>::NotBanned);
 

runtimes/common/src/constants.rs

@@ -507,6 +507,29 @@ pub mod web3_names {
 	}
 }
 
+pub mod dot_names {
+	use super::*;
+
+	const MIN_NAME_LENGTH: u32 = 3;
+	const MAX_NAME_LENGTH: u32 = 28;
+	const DOT_NAME_SUFFIX: &str = ".dot";
+
+	#[allow(clippy::as_conversions)]
+	pub const MIN_LENGTH: u32 = MIN_NAME_LENGTH + DOT_NAME_SUFFIX.len() as u32;
+	#[allow(clippy::as_conversions)]
+	pub const MAX_LENGTH: u32 = MAX_NAME_LENGTH + DOT_NAME_SUFFIX.len() as u32;
+
+	/// The size is checked in the runtime by a test.
+	pub const MAX_NAME_BYTE_LENGTH: u32 = 121;
+	pub const DEPOSIT: Balance = deposit(2, MAX_NAME_BYTE_LENGTH);
+
+	parameter_types! {
+		pub const Web3NameDeposit: Balance = DEPOSIT;
+		pub const MinNameLength: u32 = MIN_LENGTH;
+		pub const MaxNameLength: u32 = MAX_LENGTH;
+	}
+}
+
 pub mod preimage {
 	use super::*;
 	parameter_types! {

runtimes/common/src/dip/did/mod.rs

@@ -177,6 +177,8 @@ where
 		+ pallet_balances::Config,
 	<Runtime as frame_system::Config>::AccountId:
 		Into<LinkableAccountId> + From<sp_core::sr25519::Public> + AsRef<[u8; 32]> + From<[u8; 32]>,
+	<<Runtime as pallet_web3_names::Config>::Web3Name as TryFrom<Vec<u8>>>::Error:
+		Into<pallet_web3_names::Error<Runtime>>,
 {
 	type Output = Self;
 
@@ -238,11 +240,15 @@ where
 		let web3_name_input: BoundedVec<u8, <Runtime as pallet_web3_names::Config>::MaxNameLength> =
 			BoundedVec::try_from(vec![b'1'; max_name_length]).expect("BoundedVec creation should not fail.");
 
-		let web3_name = pallet_web3_names::Web3NameOf::<Runtime>::try_from(web3_name_input.to_vec())
-			.expect("Creation of w3n from w3n input should not fail.");
+		let Ok(web3_name) = pallet_web3_names::Web3NameOf::<Runtime>::try_from(web3_name_input.to_vec()) else {
+			panic!("Creation of w3n from w3n input should not fail.");
+		};
 
-		pallet_web3_names::Pallet::<Runtime>::register_name(web3_name.clone(), did.clone(), submitter.clone())
-			.expect("Inserting w3n into storage should not fail.");
+		let Ok(_) =
+			pallet_web3_names::Pallet::<Runtime>::register_name(web3_name.clone(), did.clone(), submitter.clone())
+		else {
+			panic!("Inserting w3n into storage should not fail.");
+		};
 
 		let web3_name_details = Some(RevealedWeb3Name {
 			web3_name,

runtimes/common/src/dot_names/mod.rs

@@ -0,0 +1,74 @@
+// KILT Blockchain – https://botlabs.org
+// Copyright (C) 2019-2024 BOTLabs GmbH
+
+// The KILT Blockchain 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.
+
+// The KILT Blockchain 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 this program.  If not, see <https://www.gnu.org/licenses/>.
+
+// If you feel like getting in touch with us, you can do so at [email protected]
+
+use frame_support::ensure;
+use parity_scale_codec::{Decode, Encode, MaxEncodedLen};
+use scale_info::TypeInfo;
+use sp_core::{ConstU32, RuntimeDebug};
+use sp_runtime::{BoundedVec, SaturatedConversion};
+use sp_std::vec::Vec;
+
+use pallet_web3_names::{Config, Error};
+
+#[cfg(test)]
+mod tests;
+
+#[derive(Debug, Eq, PartialEq)]
+pub enum DotNameValidationError {
+	TooShort,
+	TooLong,
+	InvalidCharacter,
+}
+
+impl<T, I> From<DotNameValidationError> for Error<T, I>
+where
+	T: Config<I>,
+	I: 'static,
+{
+	fn from(value: DotNameValidationError) -> Self {
+		match value {
+			DotNameValidationError::TooLong => Self::TooLong,
+			DotNameValidationError::TooShort => Self::TooShort,
+			DotNameValidationError::InvalidCharacter => Self::InvalidCharacter,
+		}
+	}
+}
+
+#[derive(Encode, Decode, RuntimeDebug, TypeInfo, MaxEncodedLen, PartialEq, Eq, PartialOrd, Ord, Clone)]
+pub struct DotName<const MIN_LENGTH: u32, const MAX_LENGTH: u32>(BoundedVec<u8, ConstU32<MAX_LENGTH>>);
+
+impl<const MIN_LENGTH: u32, const MAX_LENGTH: u32> TryFrom<Vec<u8>> for DotName<MIN_LENGTH, MAX_LENGTH> {
+	type Error = DotNameValidationError;
+
+	fn try_from(value: Vec<u8>) -> Result<Self, Self::Error> {
+		ensure!(value.len() >= MIN_LENGTH.saturated_into(), Self::Error::TooShort);
+		let bounded_vec: BoundedVec<u8, ConstU32<MAX_LENGTH>> =
+			BoundedVec::try_from(value).map_err(|_| Self::Error::TooLong)?;
+		ensure!(is_valid_dot_name(&bounded_vec), Self::Error::InvalidCharacter);
+		Ok(Self(bounded_vec))
+	}
+}
+fn is_valid_dot_name(input: &[u8]) -> bool {
+	let Some(dot_name_without_suffix) = input.strip_suffix(b".dot") else {
+		return false;
+	};
+	// Char validation logic taken from https://github.com/paritytech/polkadot-sdk/blob/657b5503a04e97737696fa7344641019350fb521/substrate/frame/identity/src/lib.rs#L1435
+	dot_name_without_suffix
+		.iter()
+		.all(|c| c.is_ascii_digit() || c.is_ascii_lowercase())
+}