Starlight: Wire ContainerRegistrar and Registrar pallets

pallets/registrar/src/benchmarks.rs

@@ -119,7 +119,7 @@ mod benchmarks {
             create_funded_user::<T>("caller", 0, T::DepositAmount::get());
 
         #[extrinsic_call]
-        Pallet::<T>::register(RawOrigin::Signed(caller), Default::default(), storage);
+        Pallet::<T>::register(RawOrigin::Signed(caller), Default::default(), storage, None);
 
         // verification code
         assert_eq!(pending_verification_len::<T>(), 1usize);
@@ -165,6 +165,7 @@ mod benchmarks {
             proof,
             signature,
             storage,
+            None,
         );
 
         // verification code
@@ -188,6 +189,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 i.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             // Do not call mark_valid_for_collating, to ensure that the deregister call also executes the cleanup hooks
@@ -224,6 +226,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 i.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             // Call mark_valid_for_collating to ensure that the deregister call
@@ -273,6 +276,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 i.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             // Do not call mark_valid_for_collating, to ensure that the deregister call also executes the cleanup hooks
@@ -326,6 +330,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 i.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             // Call mark_valid_for_collating to ensure that the deregister call
@@ -393,6 +398,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 i.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
         }
@@ -406,6 +412,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 k.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             T::RegistrarHooks::benchmarks_ensure_valid_for_collating(k.into());
@@ -445,6 +452,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 k.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             T::RegistrarHooks::benchmarks_ensure_valid_for_collating(k.into());
@@ -461,6 +469,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 i.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             T::RegistrarHooks::benchmarks_ensure_valid_for_collating(i.into());
@@ -509,6 +518,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 k.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             T::RegistrarHooks::benchmarks_ensure_valid_for_collating(k.into());
@@ -525,6 +535,7 @@ mod benchmarks {
                 RawOrigin::Signed(caller.clone()).into(),
                 i.into(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             T::RegistrarHooks::benchmarks_ensure_valid_for_collating(i.into());
@@ -568,6 +579,7 @@ mod benchmarks {
             Default::default(),
             slot_frequency,
             storage,
+            None,
         );
 
         // verification code
@@ -596,6 +608,7 @@ mod benchmarks {
                 i.into(),
                 slot_frequency.clone(),
                 storage.clone(),
+                None,
             )
             .unwrap();
             T::RegistrarHooks::benchmarks_ensure_valid_for_collating(i.into());

pallets/registrar/src/lib.rs

@@ -43,6 +43,7 @@ pub use weights::WeightInfo;
 pub use pallet::*;
 
 use {
+    cumulus_primitives_core::relay_chain::HeadData,
     dp_chain_state_snapshot::GenericStateProof,
     dp_container_chain_genesis_data::ContainerChainGenesisData,
     frame_support::{
@@ -64,8 +65,8 @@ use {
     sp_std::{collections::btree_set::BTreeSet, prelude::*},
     tp_traits::{
         GetCurrentContainerChains, GetSessionContainerChains, GetSessionIndex, ParaId,
-        ParathreadParams as ParathreadParamsTy, RelayStorageRootProvider, SessionContainerChains,
-        SlotFrequency,
+        ParathreadParams as ParathreadParamsTy, RegistrarHandler, RelayStorageRootProvider,
+        SessionContainerChains, SlotFrequency,
     },
 };
 
@@ -175,6 +176,8 @@ pub mod pallet {
 
         type RegistrarHooks: RegistrarHooks;
 
+        type InnerRegistrar: RegistrarHandler<Self::AccountId>;
+
         type WeightInfo: WeightInfo;
     }
 
@@ -235,6 +238,27 @@ pub mod pallet {
         ValueQuery,
     >;
 
+    /// This storage aims to act as a 'buffer' for paraIds that must be deregistered at the
+    /// end of the block execution by calling 'T::InnerRegistrar::deregister()' implementation.
+    ///
+    /// We need this buffer because when we are using this pallet on a relay-chain environment
+    /// like Starlight (where 'T::InnerRegistrar' implementation is usually the
+    /// 'paras_registrar' pallet) we need to deregister (via 'paras_registrar::deregister')
+    /// the same paraIds we have in 'PendingToRemove<T>', and we need to do this deregistration
+    /// process inside 'on_finalize' hook.
+    ///
+    /// It can be the case that some paraIds need to be downgraded to a parathread before
+    /// deregistering on 'paras_registrar'. This process usually takes 2 sessions,
+    /// and the actual downgrade happens when the block finalizes.
+    ///
+    /// Therefore, if we tried to perform this relay deregistration process at the beginning
+    /// of the session/block inside ('on_initialize') initializer_on_new_session() as we do
+    /// for this pallet, it would fail due to the downgrade process could have not taken
+    /// place yet.  
+    #[pallet::storage]
+    pub type BufferedParasToDeregister<T: Config> =
+        StorageValue<_, BoundedVec<ParaId, T::MaxLengthParaIds>, ValueQuery>;
+
     pub type DepositBalanceOf<T> =
         <<T as Config>::Currency as Inspect<<T as frame_system::Config>::AccountId>>::Balance;
 
@@ -320,6 +344,17 @@ pub mod pallet {
 
     #[pallet::hooks]
     impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
+        fn on_initialize(_n: BlockNumberFor<T>) -> Weight {
+            // Account for on_finalize weight
+            let mut weight = Weight::zero().saturating_add(T::DbWeight::get().reads(1));
+
+            let buffered_paras = BufferedParasToDeregister::<T>::get();
+            for _para_id in buffered_paras {
+                weight += T::InnerRegistrar::deregister_weight();
+            }
+            weight
+        }
+
         #[cfg(feature = "try-runtime")]
         fn try_state(_n: BlockNumberFor<T>) -> Result<(), sp_runtime::TryRuntimeError> {
             use {scale_info::prelude::format, sp_std::collections::btree_set::BTreeSet};
@@ -421,6 +456,13 @@ pub mod pallet {
 
             Ok(())
         }
+
+        fn on_finalize(_: BlockNumberFor<T>) {
+            let buffered_paras = BufferedParasToDeregister::<T>::take();
+            for para_id in buffered_paras {
+                T::InnerRegistrar::deregister(para_id);
+            }
+        }
     }
 
     #[pallet::call]
@@ -432,9 +474,10 @@ pub mod pallet {
             origin: OriginFor<T>,
             para_id: ParaId,
             genesis_data: ContainerChainGenesisData,
+            head_data: Option<HeadData>,
         ) -> DispatchResult {
             let account = ensure_signed(origin)?;
-            Self::do_register(account, para_id, genesis_data)?;
+            Self::do_register(account, para_id, genesis_data, head_data)?;
             Self::deposit_event(Event::ParaIdRegistered { para_id });
 
             Ok(())
@@ -538,9 +581,10 @@ pub mod pallet {
             para_id: ParaId,
             slot_frequency: SlotFrequency,
             genesis_data: ContainerChainGenesisData,
+            head_data: Option<HeadData>,
         ) -> DispatchResult {
             let account = ensure_signed(origin)?;
-            Self::do_register(account, para_id, genesis_data)?;
+            Self::do_register(account, para_id, genesis_data, head_data)?;
             // Insert parathread params
             let params = ParathreadParamsTy { slot_frequency };
             ParathreadParams::<T>::insert(para_id, params);
@@ -605,6 +649,7 @@ pub mod pallet {
             relay_storage_proof: sp_trie::StorageProof,
             manager_signature: cumulus_primitives_core::relay_chain::Signature,
             genesis_data: ContainerChainGenesisData,
+            head_data: Option<HeadData>,
         ) -> DispatchResult {
             let account = T::RegisterWithRelayProofOrigin::ensure_origin(origin)?;
             let relay_storage_root =
@@ -633,7 +678,7 @@ pub mod pallet {
                 return Err(Error::<T>::InvalidRelayManagerSignature.into());
             }
 
-            Self::do_register(account, para_id, genesis_data)?;
+            Self::do_register(account, para_id, genesis_data, head_data)?;
             // Insert parathread params
             if let Some(parathread_params) = parathread_params {
                 ParathreadParams::<T>::insert(para_id, parathread_params);
@@ -750,7 +795,12 @@ pub mod pallet {
                     (T::Currency::minimum_balance() + T::DepositAmount::get()) * 2u32.into();
                 let account = create_funded_user::<T>("caller", 1000, new_balance).0;
                 let origin = RawOrigin::Signed(account);
-                assert_ok!(Self::register(origin.into(), *para_id, Default::default()));
+                assert_ok!(Self::register(
+                    origin.into(),
+                    *para_id,
+                    Default::default(),
+                    None
+                ));
             }
 
             let deposit_info = RegistrarDeposit::<T>::get(para_id).expect("Cannot return signed origin for a container chain that was registered by root. Try using a different para id");
@@ -767,6 +817,7 @@ pub mod pallet {
             account: T::AccountId,
             para_id: ParaId,
             genesis_data: ContainerChainGenesisData,
+            head_data: Option<HeadData>,
         ) -> DispatchResult {
             let deposit = T::DepositAmount::get();
             // Verify we can hold
@@ -805,6 +856,13 @@ pub mod pallet {
             // Hold the deposit, we verified we can do this
             T::Currency::hold(&HoldReason::RegistrarDeposit.into(), &account, deposit)?;
 
+            T::InnerRegistrar::register(
+                account.clone(),
+                para_id,
+                genesis_data.clone().storage,
+                head_data,
+            )?;
+
             // Update DepositInfo
             RegistrarDeposit::<T>::insert(
                 para_id,
@@ -828,6 +886,13 @@ pub mod pallet {
                 Self::deposit_event(Event::ParaIdDeregistered { para_id });
                 // Cleanup immediately
                 Self::cleanup_deregistered_para_id(para_id);
+                BufferedParasToDeregister::<T>::try_mutate(|v| v.try_push(para_id)).map_err(
+                    |_e| {
+                        DispatchError::Other(
+                            "Failed to add paraId to deregistration list: buffer is full",
+                        )
+                    },
+                )?;
             } else {
                 Self::schedule_paused_parachain_change(|para_ids, paused| {
                     // We have to find out where, in the sorted vec the para id is, if anywhere.
@@ -853,6 +918,7 @@ pub mod pallet {
                 })?;
                 // Mark this para id for cleanup later
                 Self::schedule_parachain_cleanup(para_id)?;
+                T::InnerRegistrar::schedule_para_downgrade(para_id)?;
                 Self::deposit_event(Event::ParaIdDeregistered { para_id });
             }
 
@@ -889,6 +955,8 @@ pub mod pallet {
 
             T::RegistrarHooks::para_marked_valid_for_collating(para_id);
 
+            T::InnerRegistrar::schedule_para_upgrade(para_id)?;
+
             Ok(())
         }
 
@@ -1168,6 +1236,15 @@ pub mod pallet {
                         for para_id in new_paras {
                             Self::cleanup_deregistered_para_id(*para_id);
                             removed_para_ids.insert(*para_id);
+                            if let Err(id) =
+                                BufferedParasToDeregister::<T>::try_mutate(|v| v.try_push(*para_id))
+                            {
+                                log::error!(
+                                    target: LOG_TARGET,
+                                    "Failed to add paraId {:?} to deregistration list",
+                                    id
+                                );
+                            }
                         }
                     }
 

pallets/registrar/src/mock.rs

@@ -148,6 +148,7 @@ impl pallet_registrar::Config for Test {
     type DepositAmount = DepositAmount;
     type RuntimeHoldReason = RuntimeHoldReason;
     type RegistrarHooks = Mock;
+    type InnerRegistrar = ();
     type WeightInfo = ();
 }