feat: Configure Gas Tank for Memberships

pallets/communities-manager/Cargo.toml

@@ -12,6 +12,7 @@ version = "0.1.0"
 targets = ["x86_64-unknown-linux-gnu"]
 
 [dependencies]
+fc-traits-gas-tank.workspace = true
 fc-traits-tracks.workspace = true
 
 frame-benchmarking = { workspace = true, optional = true }
@@ -31,6 +32,7 @@ sp-runtime.workspace = true
 sp-std.workspace = true
 
 [dev-dependencies]
+fc-traits-memberships.workspace = true
 sp-core.workspace = true
 sp-io.workspace = true
 
@@ -47,6 +49,8 @@ virto-common = { workspace = true, default-features = false, features = [
 [features]
 default = ["std"]
 std = [
+	"fc-traits-gas-tank/std",
+	"fc-traits-memberships/std",
 	"fc-traits-tracks/std",
 	"frame-benchmarking?/std",
 	"frame-support/std",

pallets/communities-manager/src/benchmarking.rs

@@ -9,6 +9,14 @@ use sp_runtime::SaturatedConversion;
 
 type RuntimeEventFor<T> = <T as Config>::RuntimeEvent;
 
+// Since `periodicity` is arbitrary, we assume `DAYS` is a nominal day for 6s
+// block.
+const DAYS: u32 = 14_400;
+
+fn block_weight<T: frame_system::Config>() -> Weight {
+	<T as frame_system::Config>::BlockWeights::get().max_block
+}
+
 fn assert_has_event<T: Config>(generic_event: RuntimeEventFor<T>) {
 	frame_system::Pallet::<T>::assert_has_event(generic_event.into());
 }
@@ -22,6 +30,21 @@ where
 	Ok(())
 }
 
+fn setup_collection<T: Config>() -> Result<(), BenchmarkError> {
+	T::CreateCollection::create_collection_with_id(
+		T::MembershipsManagerCollectionId::get(),
+		&T::MembershipsManagerOwner::get(),
+		&T::MembershipsManagerOwner::get(),
+		&pallet_nfts::CollectionConfig {
+			settings: Default::default(),
+			max_supply: None,
+			mint_settings: Default::default(),
+		},
+	)?;
+
+	Ok(())
+}
+
 #[benchmarks(
 where
 	RuntimeEventFor<T>: From<pallet_communities::Event<T>>,
@@ -60,23 +83,19 @@ mod benchmarks {
 	#[benchmark]
 	fn create_memberships(q: Linear<1, 1024>) -> Result<(), BenchmarkError> {
 		// setup code
-		T::CreateCollection::create_collection_with_id(
-			T::MembershipsManagerCollectionId::get(),
-			&T::MembershipsManagerOwner::get(),
-			&T::MembershipsManagerOwner::get(),
-			&pallet_nfts::CollectionConfig {
-				settings: Default::default(),
-				max_supply: None,
-				mint_settings: Default::default(),
-			},
-		)?;
+		setup_collection::<T>()?;
 
 		#[extrinsic_call]
 		_(
 			RawOrigin::Root,
 			q.saturated_into(),
 			100u32.into(),
 			300_000_000_000u64.into(),
+			Some(u32::MAX.into()),
+			TankConfig {
+				capacity: Some(block_weight::<T>()),
+				periodicity: Some((7 * DAYS).into()),
+			},
 		);
 
 		// verification code
@@ -90,6 +109,26 @@ mod benchmarks {
 		Ok(())
 	}
 
+	#[benchmark]
+	fn set_gas_tank() -> Result<(), BenchmarkError> {
+		// Setup code
+		setup_collection::<T>()?;
+		Pallet::<T>::create_memberships(RawOrigin::Root.into(), 1, 1u32.into(), 0u64.into(), None, None)?;
+
+		#[extrinsic_call]
+		_(
+			RawOrigin::Root,
+			T::MembershipsManagerCollectionId::get(),
+			1u32.into(),
+			TankConfig {
+				capacity: Some(block_weight::<T>()),
+				periodicity: Some((7 * DAYS).into()),
+			},
+		);
+
+		Ok(())
+	}
+
 	impl_benchmark_test_suite!(
 		Pallet,
 		sp_io::TestExternalities::new(Default::default()),

pallets/communities-manager/src/lib.rs

@@ -13,6 +13,7 @@ mod tests;
 pub mod weights;
 pub use weights::*;
 
+use fc_traits_gas_tank::MakeTank;
 use fc_traits_tracks::MutateTracks;
 use frame_support::{
 	pallet_prelude::*,
@@ -37,11 +38,16 @@ use sp_runtime::{
 
 type TrackInfoOf<T> = TrackInfo<NativeBalanceOf<T>, BlockNumberFor<T>>;
 
+#[derive(Encode, Decode, Clone, PartialEq, Eq, Debug, TypeInfo)]
+pub struct TankConfig<Weight, BlockNumber> {
+	capacity: Option<Weight>,
+	periodicity: Option<BlockNumber>,
+}
+
 #[frame_support::pallet]
 pub mod pallet {
-	use parity_scale_codec::HasCompact;
-
 	use super::*;
+	use parity_scale_codec::HasCompact;
 
 	type CommunityName = BoundedVec<u8, ConstU32<25>>;
 
@@ -59,6 +65,12 @@ pub mod pallet {
 			CollectionId = CommunityIdOf<Self>,
 		>;
 
+		type MakeTank: fc_traits_gas_tank::MakeTank<
+			Gas = Weight,
+			TankId = (CommunityIdOf<Self>, <Self as Config>::MembershipId),
+			BlockNumber = BlockNumberFor<Self>,
+		>;
+
 		type Tracks: TracksInfo<NativeBalanceOf<Self>, BlockNumberFor<Self>>
 			+ MutateTracks<
 				NativeBalanceOf<Self>,
@@ -106,7 +118,7 @@ pub mod pallet {
 	#[pallet::event]
 	#[pallet::generate_deposit(pub(super) fn deposit_event)]
 	pub enum Event<T: Config> {
-		/// The community with [`CommmunityId`](pallet_communities::CommunityId)
+		/// The community with [`CommunityId`](pallet_communities::CommunityId)
 		/// has been created.
 		CommunityRegistered { id: T::CommunityId },
 		/// The
@@ -196,21 +208,35 @@ pub mod pallet {
 			amount: u16,
 			starting_at: <T as Config>::MembershipId,
 			#[pallet::compact] price: NativeBalanceOf<T>,
+			maybe_expiration: Option<BlockNumberFor<T>>,
+			tank_config: TankConfig<Weight, BlockNumberFor<T>>,
 		) -> DispatchResult {
 			ensure!(amount <= 1024u16, Error::<T>::CreatingTooManyMemberships);
-			T::CreateMembershipsOrigin::ensure_origin(origin)?;
+			T::CreateMembershipsOrigin::ensure_origin(origin.clone())?;
 
+			let collection_id = &T::MembershipsManagerCollectionId::get();
 			let mut id = starting_at.clone();
 			let mut minted = 0u32;
 			for _ in 0..amount {
 				T::CreateMemberships::mint_into(
-					&T::MembershipsManagerCollectionId::get(),
+					collection_id,
 					&id,
 					&T::MembershipsManagerOwner::get(),
 					&Default::default(),
 					true,
 				)?;
 
+				Self::set_gas_tank(origin.clone(), *collection_id, id.clone(), tank_config.clone())?;
+
+				if let Some(expiration) = maybe_expiration {
+					T::CreateMemberships::set_typed_attribute(
+						collection_id,
+						&id,
+						&b"membership_expiration",
+						&expiration,
+					)?;
+				}
+
 				T::CreateMemberships::set_price(
 					&T::MembershipsManagerCollectionId::get(),
 					&id,
@@ -232,6 +258,21 @@ pub mod pallet {
 			});
 			Ok(())
 		}
+
+		#[pallet::call_index(2)]
+		pub fn set_gas_tank(
+			origin: OriginFor<T>,
+			community_id: CommunityIdOf<T>,
+			membership_id: <T as Config>::MembershipId,
+			config: TankConfig<Weight, BlockNumberFor<T>>,
+		) -> DispatchResult {
+			T::CreateMembershipsOrigin::ensure_origin(origin)?;
+
+			let TankConfig { capacity, periodicity } = config;
+			T::MakeTank::make_tank(&(community_id, membership_id), capacity, periodicity)?;
+
+			Ok(())
+		}
 	}
 
 	impl<T: Config> Pallet<T> {

pallets/communities-manager/src/mock/mod.rs

@@ -1,7 +1,8 @@
 use super::*;
-
+use fc_traits_gas_tank::NonFungibleGasTank;
+use fc_traits_memberships::NonFungiblesMemberships;
 use frame_support::{
-	derive_impl, parameter_types,
+	assert_ok, derive_impl, parameter_types,
 	traits::{AsEnsureOriginWithArg, ConstU16, ConstU32, ConstU64, EitherOf, EqualPrivilegeOnly, VariantCountOf},
 	PalletId,
 };
@@ -26,6 +27,7 @@ mod runtime_benchmarks;
 use runtime_benchmarks::*;
 
 type Block = frame_system::mocking::MockBlock<Test>;
+pub type BlockNumber = BlockNumberFor<Test>;
 type WeightInfo = ();
 
 pub type AccountPublic = <MultiSignature as Verify>::Signer;
@@ -89,7 +91,8 @@ impl frame_system::Config for Test {
 	type RuntimeEvent = RuntimeEvent;
 }
 
-#[derive_impl(pallet_balances::config_preludes::TestDefaultConfig as pallet_balances::DefaultConfig)]
+#[derive_impl(pallet_balances::config_preludes::TestDefaultConfig as pallet_balances::DefaultConfig
+)]
 impl pallet_balances::Config for Test {
 	type AccountStore = System;
 	type FreezeIdentifier = RuntimeFreezeReason;
@@ -192,7 +195,7 @@ impl pallet_nfts::Config for Test {
 	type OffchainSignature = MultiSignature;
 	type RuntimeEvent = RuntimeEvent;
 	type StringLimit = ();
-	type ValueLimit = ConstU32<10>;
+	type ValueLimit = ConstU32<40>;
 	type WeightInfo = ();
 	#[cfg(feature = "runtime-benchmarks")]
 	type Helper = ();
@@ -206,7 +209,7 @@ impl pallet_communities::Config for Test {
 	type AssetsFreezer = AssetsFreezer;
 	type Balances = Balances;
 	type ItemConfig = pallet_nfts::ItemConfig;
-	type MemberMgmt = Memberships;
+	type MemberMgmt = NonFungiblesMemberships<Memberships>;
 	type Polls = Referenda;
 	type CreateOrigin = EnsureNever<Deposit>;
 	type AdminOrigin = EnsureCommunity<Self>;
@@ -234,11 +237,26 @@ impl Config for Test {
 	type MembershipsManagerCollectionId = MembershipsManagerCollectionId;
 	type MembershipsManagerOwner = RootAccount;
 	type CreateMemberships = Memberships;
+	type MakeTank = NonFungibleGasTank<Test, Memberships, pallet_nfts::ItemConfig>;
 
 	type WeightInfo = WeightInfo;
 }
 
-#[allow(dead_code)]
-fn new_test_ext() -> TestExternalities {
-	TestExternalities::new(Default::default())
+pub fn new_test_ext() -> TestExternalities {
+	let mut t = TestExternalities::new(Default::default());
+
+	t.execute_with(|| {
+		assert_ok!(Memberships::create_collection_with_id(
+			MembershipsManagerCollectionId::get(),
+			&RootAccount::get(),
+			&RootAccount::get(),
+			&pallet_nfts::CollectionConfig {
+				settings: Default::default(),
+				max_supply: None,
+				mint_settings: Default::default(),
+			},
+		));
+	});
+
+	t
 }

pallets/communities-manager/src/tests.rs

@@ -1,9 +1,32 @@
+use crate::mock::new_test_ext;
 use crate::{
 	mock::*,
 	weights::{SubstrateWeight, WeightInfo},
+	TankConfig,
 };
+use frame_support::assert_ok;
 use frame_support::weights::Weight;
 
+#[test]
+fn create_membership_works() {
+	new_test_ext().execute_with(|| {
+		const DAYS: u64 = 14_400;
+		let config = TankConfig {
+			capacity: Some(Weight::MAX),
+			periodicity: Some(7 * DAYS),
+		};
+
+		assert_ok!(CommunitiesManager::create_memberships(
+			RuntimeOrigin::root(),
+			1,
+			1,
+			1,
+			Some(BlockNumber::MAX),
+			config,
+		));
+	})
+}
+
 #[test]
 fn weights() {
 	let max_total_extrinsics = MAX_BLOCK_WEIGHT * NORMAL_DISPATCH_RATIO;
@@ -25,6 +48,7 @@ fn weights() {
 			"create_memberships(1024)",
 			SubstrateWeight::<Test>::create_memberships(1024),
 		),
+		("set_gas_tank", SubstrateWeight::<Test>::set_gas_tank()),
 	];
 
 	for (function, weight) in calls {

pallets/communities-manager/src/weights.rs

@@ -9,6 +9,7 @@ use core::marker::PhantomData;
 pub trait WeightInfo {
 	fn register() -> Weight;
 	fn create_memberships(q: u32, ) -> Weight;
+	fn set_gas_tank() -> Weight;
 }
 
 /// Weights for pallet_communities using the Substrate node and recommended hardware.
@@ -80,6 +81,13 @@ impl<T: frame_system::Config> WeightInfo for SubstrateWeight<T> {
 			.saturating_add(T::DbWeight::get().writes((4_u64).saturating_mul(q.into())))
 			.saturating_add(Weight::from_parts(0, 3334).saturating_mul(q.into()))
 	}
+
+	fn set_gas_tank() -> Weight {
+		Weight::from_parts(10_000_000, 0)
+			.saturating_add(Weight::from_parts(0, 102400))
+			.saturating_add(T::DbWeight::get().reads(2))
+			.saturating_add(T::DbWeight::get().writes(1))
+	}
 }
 
 impl WeightInfo for () {
@@ -149,4 +157,11 @@ impl WeightInfo for () {
 			.saturating_add(RocksDbWeight::get().writes((4_u64).saturating_mul(q.into())))
 			.saturating_add(Weight::from_parts(0, 3334).saturating_mul(q.into()))
 	}
+
+	fn set_gas_tank() -> Weight {
+		Weight::from_parts(10_000_000, 0)
+			.saturating_add(Weight::from_parts(0, 102400))
+			.saturating_add(RocksDbWeight::get().reads(2))
+			.saturating_add(RocksDbWeight::get().writes(1))
+	}
 }