Coretime auto-renew

cumulus/parachains/runtimes/coretime/coretime-rococo/Cargo.toml

@@ -58,6 +58,7 @@ pallet-xcm = { path = "../../../../../polkadot/xcm/pallet-xcm", default-features
 pallet-xcm-benchmarks = { path = "../../../../../polkadot/xcm/pallet-xcm-benchmarks", default-features = false, optional = true }
 polkadot-parachain-primitives = { path = "../../../../../polkadot/parachain", default-features = false }
 polkadot-runtime-common = { path = "../../../../../polkadot/runtime/common", default-features = false }
+polkadot-runtime-parachains = { path = "../../../../../polkadot/runtime/parachains", default-features = false }
 rococo-runtime-constants = { path = "../../../../../polkadot/runtime/rococo/constants", default-features = false }
 xcm = { package = "staging-xcm", path = "../../../../../polkadot/xcm", default-features = false }
 xcm-builder = { package = "staging-xcm-builder", path = "../../../../../polkadot/xcm/xcm-builder", default-features = false }

cumulus/parachains/runtimes/coretime/coretime-rococo/src/coretime.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Cumulus.  If not, see <http://www.gnu.org/licenses/>.
 
-use crate::*;
+use crate::{xcm_config::LocationToAccountId, *};
 use codec::{Decode, Encode};
 use cumulus_pallet_parachain_system::RelaychainDataProvider;
 use cumulus_primitives_core::relay_chain;
@@ -25,9 +25,15 @@ use frame_support::{
 		OnUnbalanced,
 	},
 };
-use pallet_broker::{CoreAssignment, CoreIndex, CoretimeInterface, PartsOf57600, RCBlockNumberOf};
+use pallet_broker::{
+	CoreAssignment, CoreIndex, CoretimeInterface, PartsOf57600, RCBlockNumberOf,
+	TaskAccountInterface, TaskId,
+};
 use parachains_common::{AccountId, Balance, BlockNumber};
+use polkadot_runtime_parachains::{ensure_parachain, origin, Origin as ParaOrigin};
+use sp_runtime::traits::BadOrigin;
 use xcm::latest::prelude::*;
+use xcm_executor::traits::ConvertLocation;
 
 pub struct CreditToCollatorPot;
 impl OnUnbalanced<Credit<AccountId, Balances>> for CreditToCollatorPot {
@@ -217,6 +223,28 @@ impl CoretimeInterface for CoretimeAllocator {
 	}
 }
 
+impl origin::Config for Runtime {}
+
+pub struct TaskSovereignAccount;
+impl TaskAccountInterface for TaskSovereignAccount {
+	type AccountId = AccountId;
+	type OuterOrigin = RuntimeOrigin;
+	type TaskOrigin = ParaOrigin;
+
+	fn ensure_task_sovereign_account(o: RuntimeOrigin) -> Result<TaskId, BadOrigin> {
+		match ensure_parachain(o) {
+			Ok(para_id) => Ok(para_id.into()),
+			Err(e) => Err(e),
+		}
+	}
+
+	fn sovereign_account(id: TaskId) -> Option<AccountId> {
+		// Currently all tasks are parachains.
+		let location = Location::new(1, [Parachain(id)]);
+		LocationToAccountId::convert_location(&location)
+	}
+}
+
 impl pallet_broker::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type Currency = Balances;
@@ -233,4 +261,6 @@ impl pallet_broker::Config for Runtime {
 	type PalletId = BrokerPalletId;
 	type AdminOrigin = EnsureRoot<AccountId>;
 	type PriceAdapter = pallet_broker::Linear;
+	type SovereignAccountOf = TaskSovereignAccount;
+	type MaxAutoRenewals = ConstU32<50>;
 }

cumulus/parachains/runtimes/coretime/coretime-rococo/src/lib.rs

@@ -56,6 +56,7 @@ use parachains_common::{
 	AVERAGE_ON_INITIALIZE_RATIO, NORMAL_DISPATCH_RATIO,
 };
 use polkadot_runtime_common::{BlockHashCount, SlowAdjustingFeeUpdate};
+use polkadot_runtime_parachains::origin;
 use sp_api::impl_runtime_apis;
 use sp_core::{crypto::KeyTypeId, OpaqueMetadata};
 #[cfg(any(feature = "std", test))]
@@ -462,6 +463,7 @@ construct_runtime!(
 		// Handy utilities.
 		Utility: pallet_utility = 40,
 		Multisig: pallet_multisig = 41,
+		ParachainsOrigin: origin = 42,
 
 		// The main stage.
 		Broker: pallet_broker = 50,

cumulus/parachains/runtimes/coretime/coretime-westend/Cargo.toml

@@ -57,6 +57,7 @@ pallet-xcm = { path = "../../../../../polkadot/xcm/pallet-xcm", default-features
 pallet-xcm-benchmarks = { path = "../../../../../polkadot/xcm/pallet-xcm-benchmarks", default-features = false, optional = true }
 polkadot-parachain-primitives = { path = "../../../../../polkadot/parachain", default-features = false }
 polkadot-runtime-common = { path = "../../../../../polkadot/runtime/common", default-features = false }
+polkadot-runtime-parachains = { path = "../../../../../polkadot/runtime/parachains", default-features = false }
 westend-runtime-constants = { path = "../../../../../polkadot/runtime/westend/constants", default-features = false }
 xcm = { package = "staging-xcm", path = "../../../../../polkadot/xcm", default-features = false }
 xcm-builder = { package = "staging-xcm-builder", path = "../../../../../polkadot/xcm/xcm-builder", default-features = false }

cumulus/parachains/runtimes/coretime/coretime-westend/src/coretime.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Cumulus.  If not, see <http://www.gnu.org/licenses/>.
 
-use crate::*;
+use crate::{xcm_config::LocationToAccountId, *};
 use codec::{Decode, Encode};
 use cumulus_pallet_parachain_system::RelaychainDataProvider;
 use cumulus_primitives_core::relay_chain;
@@ -25,9 +25,15 @@ use frame_support::{
 		OnUnbalanced,
 	},
 };
-use pallet_broker::{CoreAssignment, CoreIndex, CoretimeInterface, PartsOf57600, RCBlockNumberOf};
+use pallet_broker::{
+	CoreAssignment, CoreIndex, CoretimeInterface, PartsOf57600, RCBlockNumberOf,
+	TaskAccountInterface, TaskId,
+};
 use parachains_common::{AccountId, Balance, BlockNumber};
+use polkadot_runtime_parachains::{ensure_parachain, origin, Origin as ParaOrigin};
+use sp_runtime::traits::BadOrigin;
 use xcm::latest::prelude::*;
+use xcm_executor::traits::ConvertLocation;
 
 pub struct CreditToCollatorPot;
 impl OnUnbalanced<Credit<AccountId, Balances>> for CreditToCollatorPot {
@@ -229,6 +235,28 @@ impl CoretimeInterface for CoretimeAllocator {
 	}
 }
 
+impl origin::Config for Runtime {}
+
+pub struct TaskSovereignAccount;
+impl TaskAccountInterface for TaskSovereignAccount {
+	type AccountId = AccountId;
+	type OuterOrigin = RuntimeOrigin;
+	type TaskOrigin = ParaOrigin;
+
+	fn ensure_task_sovereign_account(o: RuntimeOrigin) -> Result<TaskId, BadOrigin> {
+		match ensure_parachain(o) {
+			Ok(para_id) => Ok(para_id.into()),
+			Err(e) => Err(e),
+		}
+	}
+
+	fn sovereign_account(id: TaskId) -> Option<AccountId> {
+		// Currently all tasks are parachains.
+		let location = Location::new(1, [Parachain(id)]);
+		LocationToAccountId::convert_location(&location)
+	}
+}
+
 impl pallet_broker::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type Currency = Balances;
@@ -246,4 +274,6 @@ impl pallet_broker::Config for Runtime {
 	type PalletId = BrokerPalletId;
 	type AdminOrigin = EnsureRoot<AccountId>;
 	type PriceAdapter = pallet_broker::Linear;
+	type SovereignAccountOf = TaskSovereignAccount;
+	type MaxAutoRenewals = ConstU32<10>;
 }

cumulus/parachains/runtimes/coretime/coretime-westend/src/lib.rs

@@ -56,6 +56,7 @@ use parachains_common::{
 	AVERAGE_ON_INITIALIZE_RATIO, NORMAL_DISPATCH_RATIO,
 };
 use polkadot_runtime_common::{BlockHashCount, SlowAdjustingFeeUpdate};
+use polkadot_runtime_parachains::origin;
 use sp_api::impl_runtime_apis;
 use sp_core::{crypto::KeyTypeId, OpaqueMetadata};
 #[cfg(any(feature = "std", test))]
@@ -457,6 +458,7 @@ construct_runtime!(
 		// Handy utilities.
 		Utility: pallet_utility = 40,
 		Multisig: pallet_multisig = 41,
+		ParachainsOrigin: origin = 42,
 
 		// The main stage.
 		Broker: pallet_broker = 50,

substrate/bin/node/runtime/src/lib.rs

@@ -73,6 +73,7 @@ use pallet_nis::WithMaximumOf;
 use pallet_session::historical as pallet_session_historical;
 // Can't use `FungibleAdapter` here until Treasury pallet migrates to fungibles
 // <https://github.com/paritytech/polkadot-sdk/issues/226>
+use pallet_broker::{TaskAccountInterface, TaskId};
 #[allow(deprecated)]
 pub use pallet_transaction_payment::{CurrencyAdapter, Multiplier, TargetedFeeAdjustment};
 use pallet_transaction_payment::{FeeDetails, RuntimeDispatchInfo};
@@ -91,8 +92,8 @@ use sp_runtime::{
 	curve::PiecewiseLinear,
 	generic, impl_opaque_keys,
 	traits::{
-		self, AccountIdConversion, BlakeTwo256, Block as BlockT, Bounded, ConvertInto, NumberFor,
-		OpaqueKeys, SaturatedConversion, StaticLookup,
+		self, AccountIdConversion, BadOrigin, BlakeTwo256, Block as BlockT, Bounded, ConvertInto,
+		NumberFor, OpaqueKeys, SaturatedConversion, StaticLookup,
 	},
 	transaction_validity::{TransactionPriority, TransactionSource, TransactionValidity},
 	ApplyExtrinsicResult, FixedPointNumber, FixedU128, Perbill, Percent, Permill, Perquintill,
@@ -2126,6 +2127,21 @@ impl CoretimeInterface for CoretimeProvider {
 	}
 }
 
+pub struct TaskSovereignAccount;
+// Dummy implementation which converts `TaskId` to `AccountId`.
+impl TaskAccountInterface for TaskSovereignAccount {
+	type AccountId = AccountId;
+	type OuterOrigin = RuntimeOrigin;
+	type TaskOrigin = frame_system::RawOrigin<AccountId>;
+
+	fn ensure_task_sovereign_account(_o: RuntimeOrigin) -> Result<TaskId, BadOrigin> {
+		Err(BadOrigin)
+	}
+
+	fn sovereign_account(_task: TaskId) -> Option<AccountId> {
+		None
+	}
+}
 impl pallet_broker::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type Currency = Balances;
@@ -2139,6 +2155,8 @@ impl pallet_broker::Config for Runtime {
 	type PalletId = BrokerPalletId;
 	type AdminOrigin = EnsureRoot<AccountId>;
 	type PriceAdapter = pallet_broker::Linear;
+	type SovereignAccountOf = TaskSovereignAccount;
+	type MaxAutoRenewals = ConstU32<5>;
 }
 
 parameter_types! {

substrate/frame/broker/src/coretime_interface.rs

@@ -22,7 +22,7 @@ use frame_support::Parameter;
 use scale_info::TypeInfo;
 use sp_arithmetic::traits::AtLeast32BitUnsigned;
 use sp_core::RuntimeDebug;
-use sp_runtime::traits::BlockNumberProvider;
+use sp_runtime::traits::{BadOrigin, BlockNumberProvider};
 use sp_std::vec::Vec;
 
 /// Index of a Polkadot Core.
@@ -146,3 +146,25 @@ impl CoretimeInterface for () {
 	#[cfg(feature = "runtime-benchmarks")]
 	fn ensure_notify_revenue_info(_when: RCBlockNumberOf<Self>, _revenue: Self::Balance) {}
 }
+
+/// Trait for getting the associated account and origin of a task.
+///
+/// For parachains, this is the sovereign account, which is controlled by the parachain
+/// itself.
+pub trait TaskAccountInterface {
+	/// The type for representing accounts.
+	type AccountId;
+
+	/// The overarching origin type.
+	type OuterOrigin: Into<Result<Self::TaskOrigin, Self::OuterOrigin>>;
+
+	/// The custom task origin. Given that all tasks on Polkadot are parachains this will most
+	/// likely be the `Parachain` origin.
+	type TaskOrigin;
+
+	/// Ensures that the origin is a task origin and returns the associated `TaskId`.
+	fn ensure_task_sovereign_account(o: Self::OuterOrigin) -> Result<TaskId, BadOrigin>;
+
+	/// Returns the associated account of a task.
+	fn sovereign_account(task: TaskId) -> Option<Self::AccountId>;
+}

substrate/frame/broker/src/dispatchable_impls.rs

@@ -469,6 +469,81 @@ impl<T: Config> Pallet<T> {
 		Ok(())
 	}
 
+	pub(crate) fn do_enable_auto_renew(
+		task: TaskId,
+		core: CoreIndex,
+		workload_end_hint: Option<Timeslice>,
+	) -> DispatchResult {
+		let sale = SaleInfo::<T>::get().ok_or(Error::<T>::NoSales)?;
+		let Some(sovereign_account) = T::SovereignAccountOf::sovereign_account(task) else {
+			return Err(Error::<T>::SovereignAccountNotFound.into());
+		};
+
+		let record = if let Some(workload_end) = workload_end_hint {
+			AllowedRenewals::<T>::get(AllowedRenewalId { core, when: workload_end })
+				.ok_or(Error::<T>::NotAllowed)?
+		} else {
+			// If the core hasn't been renewed yet we will renew it now.
+			if let Some(record) =
+				AllowedRenewals::<T>::get(AllowedRenewalId { core, when: sale.region_begin })
+			{
+				Self::do_renew(sovereign_account.clone(), core)?;
+				record
+			} else {
+				// If we couldn't find the renewal record for the current bulk period we should
+				// be able to find it for the upcoming bulk period.
+				//
+				// If not the core is not eligable for renewal.
+				AllowedRenewals::<T>::get(AllowedRenewalId { core, when: sale.region_end })
+					.ok_or(Error::<T>::NotAllowed)?
+			}
+		};
+
+		let workload =
+			record.completion.drain_complete().ok_or(Error::<T>::IncompleteAssignment)?;
+
+		// Given that only non-interlaced cores can be renewed, there should be only one
+		// assignment in the core's workload.
+		ensure!(workload.len() == 1, Error::<T>::IncompleteAssignment);
+		let Some(schedule_item) = workload.get(0) else {
+			return Err(Error::<T>::NotAllowed.into())
+		};
+
+		if let CoreAssignment::Task(core_task) = schedule_item.assignment {
+			// Sovereign account of a task can only enable auto renewal for its own core.
+			ensure!(task == core_task, Error::<T>::NoPermission);
+		} else {
+			return Err(Error::<T>::NonTaskAutoRenewal.into())
+		};
+
+		// We are keeping the auto-renewals sorted by `CoreIndex`.
+		AutoRenewals::<T>::try_mutate(|renewals| {
+			let pos = renewals
+				.binary_search_by(|r: &(CoreIndex, TaskId)| r.0.cmp(&core))
+				.unwrap_or_else(|e| e);
+			renewals.try_insert(pos, (core, task))
+		})
+		.map_err(|_| Error::<T>::TooManyAutoRenewals)?;
+
+		Self::deposit_event(Event::AutoRenewalEnabled { core, task });
+		Ok(())
+	}
+
+	pub(crate) fn do_disable_auto_renew(task: TaskId, core: CoreIndex) -> DispatchResult {
+		AutoRenewals::<T>::try_mutate(|renewals| -> DispatchResult {
+			let pos = renewals
+				.binary_search_by(|r: &(CoreIndex, TaskId)| r.0.cmp(&core))
+				.map_err(|_| Error::<T>::AutoRenewalNotEnabled)?;
+
+			ensure!(Some(&(core, task)) == renewals.get(pos), Error::<T>::NoPermission);
+			renewals.remove(pos);
+			Ok(())
+		})?;
+
+		Self::deposit_event(Event::AutoRenewalDisabled { core, task });
+		Ok(())
+	}
+
 	pub(crate) fn ensure_cores_for_sale(
 		status: &StatusRecord,
 		sale: &SaleInfoRecordOf<T>,