Pallet assets-vesting

Cargo.toml

@@ -318,6 +318,7 @@ members = [
 	"substrate/frame/asset-rewards",
 	"substrate/frame/assets",
 	"substrate/frame/assets-freezer",
+	"substrate/frame/assets-vesting",
 	"substrate/frame/atomic-swap",
 	"substrate/frame/aura",
 	"substrate/frame/authority-discovery",
@@ -899,6 +900,7 @@ pallet-asset-rewards = { path = "substrate/frame/asset-rewards", default-feature
 pallet-asset-tx-payment = { path = "substrate/frame/transaction-payment/asset-tx-payment", default-features = false }
 pallet-assets = { path = "substrate/frame/assets", default-features = false }
 pallet-assets-freezer = { path = "substrate/frame/assets-freezer", default-features = false }
+pallet-assets-vesting = { path = "substrate/frame/assets-vesting", default-features = false }
 pallet-atomic-swap = { default-features = false, path = "substrate/frame/atomic-swap" }
 pallet-aura = { path = "substrate/frame/aura", default-features = false }
 pallet-authority-discovery = { path = "substrate/frame/authority-discovery", default-features = false }

cumulus/parachains/runtimes/assets/asset-hub-rococo/Cargo.toml

@@ -33,6 +33,7 @@ pallet-asset-conversion-tx-payment = { workspace = true }
 pallet-asset-rewards = { workspace = true }
 pallet-assets = { workspace = true }
 pallet-assets-freezer = { workspace = true }
+pallet-assets-vesting = { workspace = true }
 pallet-aura = { workspace = true }
 pallet-authorship = { workspace = true }
 pallet-balances = { workspace = true }
@@ -63,7 +64,11 @@ sp-version = { workspace = true }
 sp-weights = { workspace = true }
 
 # num-traits feature needed for dex integer sq root:
-primitive-types = { features = ["codec", "num-traits", "scale-info"], workspace = true }
+primitive-types = { features = [
+	"codec",
+	"num-traits",
+	"scale-info",
+], workspace = true }
 
 # Polkadot
 pallet-xcm = { workspace = true }
@@ -126,6 +131,7 @@ runtime-benchmarks = [
 	"pallet-asset-conversion/runtime-benchmarks",
 	"pallet-asset-rewards/runtime-benchmarks",
 	"pallet-assets-freezer/runtime-benchmarks",
+	"pallet-assets-vesting/runtime-benchmarks",
 	"pallet-assets/runtime-benchmarks",
 	"pallet-balances/runtime-benchmarks",
 	"pallet-collator-selection/runtime-benchmarks",
@@ -166,6 +172,7 @@ try-runtime = [
 	"pallet-asset-conversion/try-runtime",
 	"pallet-asset-rewards/try-runtime",
 	"pallet-assets-freezer/try-runtime",
+	"pallet-assets-vesting/try-runtime",
 	"pallet-assets/try-runtime",
 	"pallet-aura/try-runtime",
 	"pallet-authorship/try-runtime",
@@ -217,6 +224,7 @@ std = [
 	"pallet-asset-conversion/std",
 	"pallet-asset-rewards/std",
 	"pallet-assets-freezer/std",
+	"pallet-assets-vesting/std",
 	"pallet-assets/std",
 	"pallet-aura/std",
 	"pallet-authorship/std",

cumulus/parachains/runtimes/assets/asset-hub-rococo/src/lib.rs

@@ -113,7 +113,7 @@ use xcm_runtime_apis::{
 
 #[cfg(feature = "runtime-benchmarks")]
 use frame_support::traits::PalletInfoAccess;
-
+use sp_runtime::traits::ConvertInto;
 use weights::{BlockExecutionWeight, ExtrinsicBaseWeight, RocksDbWeight};
 
 impl_opaque_keys! {
@@ -290,6 +290,25 @@ impl pallet_assets_freezer::Config<AssetsFreezerInstance> for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 }
 
+parameter_types! {
+	pub const TrustBackedMinVestedTransfer: Balance = 100 * CENTS;
+}
+
+pub type TrustBackedAssetsVestingInstance = pallet_assets_vesting::Instance1;
+
+impl pallet_assets_vesting::Config<TrustBackedAssetsVestingInstance> for Runtime {
+	type RuntimeEvent = RuntimeEvent;
+	type ForceOrigin = EnsureRoot<AccountId>;
+	type Assets = Assets;
+	type Freezer = AssetsFreezer;
+	type BlockNumberToBalance = ConvertInto;
+	type RuntimeFreezeReason = RuntimeFreezeReason;
+	type WeightInfo = ();
+	type MinVestedTransfer = TrustBackedMinVestedTransfer;
+	type BlockNumberProvider = System;
+	const MAX_VESTING_SCHEDULES: u32 = 28;
+}
+
 parameter_types! {
 	pub const AssetConversionPalletId: PalletId = PalletId(*b"py/ascon");
 	pub const LiquidityWithdrawalFee: Permill = Permill::from_percent(0);
@@ -511,6 +530,25 @@ impl pallet_assets_freezer::Config<ForeignAssetsFreezerInstance> for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 }
 
+parameter_types! {
+	pub const ForeignMinVestedTransfer: Balance = 1;
+}
+
+pub type ForeignAssetsVestingInstance = pallet_assets_vesting::Instance2;
+
+impl pallet_assets_vesting::Config<ForeignAssetsVestingInstance> for Runtime {
+	type RuntimeEvent = RuntimeEvent;
+	type ForceOrigin = EnsureRoot<AccountId>;
+	type Assets = ForeignAssets;
+	type Freezer = ForeignAssetsFreezer;
+	type BlockNumberToBalance = ConvertInto;
+	type RuntimeFreezeReason = RuntimeFreezeReason;
+	type WeightInfo = ();
+	type MinVestedTransfer = ForeignMinVestedTransfer;
+	type BlockNumberProvider = System;
+	const MAX_VESTING_SCHEDULES: u32 = 28;
+}
+
 parameter_types! {
 	// One storage item; key size is 32; value is size 4+4+16+32 bytes = 56 bytes.
 	pub const DepositBase: Balance = deposit(1, 88);
@@ -1107,6 +1145,9 @@ construct_runtime!(
 		ForeignAssetsFreezer: pallet_assets_freezer::<Instance2> = 58,
 		PoolAssetsFreezer: pallet_assets_freezer::<Instance3> = 59,
 
+		AssetsVesting: pallet_assets_vesting::<Instance1> = 80,
+		ForeignAssetsVesting: pallet_assets_vesting::<Instance2> = 81,
+
 		AssetRewards: pallet_asset_rewards = 60,
 
 		// TODO: the pallet instance should be removed once all pools have migrated
@@ -1299,6 +1340,8 @@ mod benches {
 		[pallet_assets, Local]
 		[pallet_assets, Foreign]
 		[pallet_assets, Pool]
+		[pallet_assets_vesting, LocalVesting]
+		[pallet_assets_vesting, ForeignVesting]
 		[pallet_asset_conversion, AssetConversion]
 		[pallet_asset_rewards, AssetRewards]
 		[pallet_asset_conversion_tx_payment, AssetTxPayment]
@@ -1670,6 +1713,9 @@ impl_runtime_apis! {
 			type Foreign = pallet_assets::Pallet::<Runtime, ForeignAssetsInstance>;
 			type Pool = pallet_assets::Pallet::<Runtime, PoolAssetsInstance>;
 
+			type LocalVesting = pallet_assets::Pallet::<Runtime, TrustBackedAssetsVestingInstance>;
+			type ForeignVesting = pallet_assets::Pallet::<Runtime, ForeignAssetsVestingInstance>;
+
 			type ToWestend = XcmBridgeHubRouterBench<Runtime, ToWestendXcmRouterInstance>;
 
 			let mut list = Vec::<BenchmarkList>::new();
@@ -1975,6 +2021,9 @@ impl_runtime_apis! {
 			type Foreign = pallet_assets::Pallet::<Runtime, ForeignAssetsInstance>;
 			type Pool = pallet_assets::Pallet::<Runtime, PoolAssetsInstance>;
 
+			type LocalVesting = pallet_assets::Pallet::<Runtime, TrustBackedAssetsVestingInstance>;
+			type ForeignVesting = pallet_assets::Pallet::<Runtime, ForeignAssetsVestingInstance>;
+
 			type ToWestend = XcmBridgeHubRouterBench<Runtime, ToWestendXcmRouterInstance>;
 
 			use frame_support::traits::WhitelistedStorageKeys;

cumulus/parachains/runtimes/assets/asset-hub-westend/Cargo.toml

@@ -33,6 +33,7 @@ pallet-asset-conversion-tx-payment = { workspace = true }
 pallet-asset-rewards = { workspace = true }
 pallet-assets = { workspace = true }
 pallet-assets-freezer = { workspace = true }
+pallet-assets-vesting = { workspace = true }
 pallet-aura = { workspace = true }
 pallet-authorship = { workspace = true }
 pallet-balances = { workspace = true }
@@ -66,7 +67,11 @@ sp-transaction-pool = { workspace = true }
 sp-version = { workspace = true }
 
 # num-traits feature needed for dex integer sq root:
-primitive-types = { features = ["codec", "num-traits", "scale-info"], workspace = true }
+primitive-types = { features = [
+	"codec",
+	"num-traits",
+	"scale-info",
+], workspace = true }
 
 # Polkadot
 pallet-xcm = { workspace = true }
@@ -130,6 +135,7 @@ runtime-benchmarks = [
 	"pallet-asset-conversion/runtime-benchmarks",
 	"pallet-asset-rewards/runtime-benchmarks",
 	"pallet-assets-freezer/runtime-benchmarks",
+	"pallet-assets-vesting/runtime-benchmarks",
 	"pallet-assets/runtime-benchmarks",
 	"pallet-balances/runtime-benchmarks",
 	"pallet-collator-selection/runtime-benchmarks",
@@ -173,6 +179,7 @@ try-runtime = [
 	"pallet-asset-conversion/try-runtime",
 	"pallet-asset-rewards/try-runtime",
 	"pallet-assets-freezer/try-runtime",
+	"pallet-assets-vesting/try-runtime",
 	"pallet-assets/try-runtime",
 	"pallet-aura/try-runtime",
 	"pallet-authorship/try-runtime",
@@ -227,6 +234,7 @@ std = [
 	"pallet-asset-conversion/std",
 	"pallet-asset-rewards/std",
 	"pallet-assets-freezer/std",
+	"pallet-assets-vesting/std",
 	"pallet-assets/std",
 	"pallet-aura/std",
 	"pallet-authorship/std",

cumulus/parachains/runtimes/assets/asset-hub-westend/src/lib.rs

@@ -105,7 +105,7 @@ use xcm::{
 
 #[cfg(feature = "runtime-benchmarks")]
 use frame_support::traits::PalletInfoAccess;
-
+use sp_runtime::traits::ConvertInto;
 #[cfg(feature = "runtime-benchmarks")]
 use xcm::latest::prelude::{
 	Asset, Assets as XcmAssets, Fungible, Here, InteriorLocation, Junction, Junction::*, Location,
@@ -294,6 +294,25 @@ impl pallet_assets_freezer::Config<AssetsFreezerInstance> for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 }
 
+parameter_types! {
+	pub const TrustBackedMinVestedTransfer: Balance = 100 * CENTS;
+}
+
+pub type TrustBackedAssetsVestingInstance = pallet_assets_vesting::Instance1;
+
+impl pallet_assets_vesting::Config<TrustBackedAssetsVestingInstance> for Runtime {
+	type RuntimeEvent = RuntimeEvent;
+	type ForceOrigin = EnsureRoot<AccountId>;
+	type Assets = Assets;
+	type Freezer = AssetsFreezer;
+	type BlockNumberToBalance = ConvertInto;
+	type RuntimeFreezeReason = RuntimeFreezeReason;
+	type WeightInfo = ();
+	type MinVestedTransfer = TrustBackedMinVestedTransfer;
+	type BlockNumberProvider = System;
+	const MAX_VESTING_SCHEDULES: u32 = 28;
+}
+
 parameter_types! {
 	pub const AssetConversionPalletId: PalletId = PalletId(*b"py/ascon");
 	pub const LiquidityWithdrawalFee: Permill = Permill::from_percent(0);
@@ -563,6 +582,25 @@ impl pallet_assets_freezer::Config<ForeignAssetsFreezerInstance> for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 }
 
+parameter_types! {
+	pub const ForeignMinVestedTransfer: Balance = 1;
+}
+
+pub type ForeignAssetsVestingInstance = pallet_assets_vesting::Instance2;
+
+impl pallet_assets_vesting::Config<ForeignAssetsVestingInstance> for Runtime {
+	type RuntimeEvent = RuntimeEvent;
+	type ForceOrigin = EnsureRoot<AccountId>;
+	type Assets = ForeignAssets;
+	type Freezer = ForeignAssetsFreezer;
+	type BlockNumberToBalance = ConvertInto;
+	type RuntimeFreezeReason = RuntimeFreezeReason;
+	type WeightInfo = ();
+	type MinVestedTransfer = ForeignMinVestedTransfer;
+	type BlockNumberProvider = System;
+	const MAX_VESTING_SCHEDULES: u32 = 28;
+}
+
 parameter_types! {
 	// One storage item; key size is 32; value is size 4+4+16+32 bytes = 56 bytes.
 	pub const DepositBase: Balance = deposit(1, 88);
@@ -1168,6 +1206,10 @@ construct_runtime!(
 		AssetsFreezer: pallet_assets_freezer::<Instance1> = 57,
 		ForeignAssetsFreezer: pallet_assets_freezer::<Instance2> = 58,
 		PoolAssetsFreezer: pallet_assets_freezer::<Instance3> = 59,
+
+		AssetsVesting: pallet_assets_vesting::<Instance1> = 80,
+		ForeignAssetsVesting: pallet_assets_vesting::<Instance2> = 81,
+
 		Revive: pallet_revive = 60,
 
 		AssetRewards: pallet_asset_rewards = 61,
@@ -1446,8 +1488,9 @@ mod benches {
 		[frame_system, SystemBench::<Runtime>]
 		[frame_system_extensions, SystemExtensionsBench::<Runtime>]
 		[pallet_assets, Local]
-		[pallet_assets, Foreign]
 		[pallet_assets, Pool]
+		[pallet_assets_vesting, LocalVesting]
+		[pallet_assets_vesting, ForeignVesting]
 		[pallet_asset_conversion, AssetConversion]
 		[pallet_asset_rewards, AssetRewards]
 		[pallet_asset_conversion_tx_payment, AssetTxPayment]
@@ -1866,6 +1909,9 @@ impl_runtime_apis! {
 			type Foreign = pallet_assets::Pallet::<Runtime, ForeignAssetsInstance>;
 			type Pool = pallet_assets::Pallet::<Runtime, PoolAssetsInstance>;
 
+			type LocalVesting = pallet_assets::Pallet::<Runtime, TrustBackedAssetsVestingInstance>;
+			type ForeignVesting = pallet_assets::Pallet::<Runtime, ForeignAssetsVestingInstance>;
+
 			type ToRococo = XcmBridgeHubRouterBench<Runtime, ToRococoXcmRouterInstance>;
 
 			let mut list = Vec::<BenchmarkList>::new();
@@ -2171,6 +2217,9 @@ impl_runtime_apis! {
 			type Foreign = pallet_assets::Pallet::<Runtime, ForeignAssetsInstance>;
 			type Pool = pallet_assets::Pallet::<Runtime, PoolAssetsInstance>;
 
+			type LocalVesting = pallet_assets::Pallet::<Runtime, TrustBackedAssetsVestingInstance>;
+			type ForeignVesting = pallet_assets::Pallet::<Runtime, ForeignAssetsVestingInstance>;
+
 			type ToRococo = XcmBridgeHubRouterBench<Runtime, ToRococoXcmRouterInstance>;
 
 			use frame_support::traits::WhitelistedStorageKeys;

prdoc/pr_7404.prdoc

@@ -0,0 +1,16 @@
+title: Bridges small nits/improvements
+doc:
+- audience: Runtime Dev
+  description: |
+    This Pull Request introduces `pallet-assets-vesting`, allowing runtimes to add vesting schedules to assets.
+crates:
+- name: asset-hub-rococo-runtime
+  bump: minor
+- name: asset-hub-westend-runtime
+  bump: minor
+- name: frame-support
+  bump: minor
+- name: pallet-assets-vesting
+  bump: major
+- name: polkadot-sdk
+  bump: minor