Unverified Commit d6e823c8 authored by Shawn Tabrizi's avatar Shawn Tabrizi Committed by GitHub
Browse files

Add Parachain Onboarding to Rococo (#2660)

* Add Parachain Onboarding Pallets to Rococo

* remove propose_parachain

* add back para sudo wrapper

* Revert "remove propose_parachain"

This reverts commit 38b7c33c

.

* turn propose_parachains into validator_manager

* Update runtime/rococo/src/lib.rs

Co-authored-by: default avatarBastian Köcher <bkchr@users.noreply.github.com>

* update origin

Co-authored-by: default avatarBastian Köcher <bkchr@users.noreply.github.com>
parent 2f57efce
Pipeline #129900 failed with stages
in 12 minutes and 3 seconds
...@@ -56,7 +56,7 @@ pub enum CallOrigin<SourceChainAccountId, TargetChainAccountPublic, TargetChainS ...@@ -56,7 +56,7 @@ pub enum CallOrigin<SourceChainAccountId, TargetChainAccountPublic, TargetChainS
/// from a derived account. /// from a derived account.
/// ///
/// The derived account represents the source Root account on the target chain. This is useful /// The derived account represents the source Root account on the target chain. This is useful
/// if the target chain needs some way of knowing that a call came from a priviledged origin on /// if the target chain needs some way of knowing that a call came from a privileged origin on
/// the source chain (maybe to allow a configuration change for example). /// the source chain (maybe to allow a configuration change for example).
SourceRoot, SourceRoot,
......
...@@ -62,9 +62,9 @@ pub type InstanceId = [u8; 4]; ...@@ -62,9 +62,9 @@ pub type InstanceId = [u8; 4];
/// Type of accounts on the source chain. /// Type of accounts on the source chain.
pub enum SourceAccount<T> { pub enum SourceAccount<T> {
/// An account that belongs to Root (priviledged origin). /// An account that belongs to Root (privileged origin).
Root, Root,
/// A non-priviledged account. /// A non-privileged account.
/// ///
/// The embedded account ID may or may not have a private key depending on the "owner" of the /// The embedded account ID may or may not have a private key depending on the "owner" of the
/// account (private key, pallet, proxy, etc.). /// account (private key, pallet, proxy, etc.).
......
...@@ -40,12 +40,12 @@ use runtime_parachains::{ ...@@ -40,12 +40,12 @@ use runtime_parachains::{
}; };
use frame_support::{ use frame_support::{
construct_runtime, parameter_types, construct_runtime, parameter_types,
traits::{EnsureOrigin, Filter, KeyOwnerProofSystem, Randomness}, traits::{Filter, KeyOwnerProofSystem, Randomness},
weights::Weight, weights::Weight,
}; };
use sp_runtime::{ use sp_runtime::{
create_runtime_str, generic, impl_opaque_keys, create_runtime_str, generic, impl_opaque_keys,
ApplyExtrinsicResult, KeyTypeId, Perbill, ApplyExtrinsicResult, KeyTypeId, Perbill, ModuleId,
transaction_validity::{TransactionValidity, TransactionSource, TransactionPriority}, transaction_validity::{TransactionValidity, TransactionSource, TransactionPriority},
traits::{ traits::{
BlakeTwo256, Block as BlockT, OpaqueKeys, AccountIdLookup, BlakeTwo256, Block as BlockT, OpaqueKeys, AccountIdLookup,
...@@ -62,8 +62,8 @@ use pallet_grandpa::{AuthorityId as GrandpaId, fg_primitives}; ...@@ -62,8 +62,8 @@ use pallet_grandpa::{AuthorityId as GrandpaId, fg_primitives};
use sp_core::OpaqueMetadata; use sp_core::OpaqueMetadata;
use sp_staking::SessionIndex; use sp_staking::SessionIndex;
use pallet_session::historical as session_historical; use pallet_session::historical as session_historical;
use frame_system::{EnsureRoot, EnsureOneOf, EnsureSigned}; use frame_system::EnsureRoot;
use runtime_common::{paras_sudo_wrapper, paras_registrar, xcm_sender}; use runtime_common::{paras_sudo_wrapper, paras_registrar, xcm_sender, auctions, crowdloan, slots};
use runtime_parachains::origin as parachains_origin; use runtime_parachains::origin as parachains_origin;
use runtime_parachains::configuration as parachains_configuration; use runtime_parachains::configuration as parachains_configuration;
...@@ -92,7 +92,7 @@ use constants::{time::*, currency::*, fee::*}; ...@@ -92,7 +92,7 @@ use constants::{time::*, currency::*, fee::*};
/// Constant values used within the runtime. /// Constant values used within the runtime.
pub mod constants; pub mod constants;
mod propose_parachain; mod validator_manager;
// Make the WASM binary available. // Make the WASM binary available.
#[cfg(feature = "std")] #[cfg(feature = "std")]
...@@ -208,14 +208,18 @@ construct_runtime! { ...@@ -208,14 +208,18 @@ construct_runtime! {
Hrmp: parachains_hrmp::{Pallet, Call, Storage, Event}, Hrmp: parachains_hrmp::{Pallet, Call, Storage, Event},
SessionInfo: parachains_session_info::{Pallet, Call, Storage}, SessionInfo: parachains_session_info::{Pallet, Call, Storage},
// Parachain Onboarding Pallets
Registrar: paras_registrar::{Pallet, Call, Storage, Event<T>}, Registrar: paras_registrar::{Pallet, Call, Storage, Event<T>},
Auctions: auctions::{Pallet, Call, Storage, Event<T>},
Crowdloan: crowdloan::{Pallet, Call, Storage, Event<T>},
Slots: slots::{Pallet, Call, Storage, Event<T>},
ParasSudoWrapper: paras_sudo_wrapper::{Pallet, Call}, ParasSudoWrapper: paras_sudo_wrapper::{Pallet, Call},
// Sudo // Sudo
Sudo: pallet_sudo::{Pallet, Call, Storage, Event<T>, Config<T>}, Sudo: pallet_sudo::{Pallet, Call, Storage, Event<T>, Config<T>},
// Propose parachain pallet. // Validator Manager pallet.
ProposeParachain: propose_parachain::{Pallet, Call, Storage, Event<T>}, ValidatorManager: validator_manager::{Pallet, Call, Storage, Event<T>},
} }
} }
...@@ -418,7 +422,7 @@ impl pallet_session::Config for Runtime { ...@@ -418,7 +422,7 @@ impl pallet_session::Config for Runtime {
type ValidatorIdOf = ValidatorIdOf; type ValidatorIdOf = ValidatorIdOf;
type ShouldEndSession = Babe; type ShouldEndSession = Babe;
type NextSessionRotation = Babe; type NextSessionRotation = Babe;
type SessionManager = pallet_session::historical::NoteHistoricalRoot<Self, ProposeParachain>; type SessionManager = pallet_session::historical::NoteHistoricalRoot<Self, ValidatorManager>;
type SessionHandler = <SessionKeys as OpaqueKeys>::KeyTypeIdProviders; type SessionHandler = <SessionKeys as OpaqueKeys>::KeyTypeIdProviders;
type Keys = SessionKeys; type Keys = SessionKeys;
type DisabledValidatorsThreshold = DisabledValidatorsThreshold; type DisabledValidatorsThreshold = DisabledValidatorsThreshold;
...@@ -600,7 +604,7 @@ impl paras_registrar::Config for Runtime { ...@@ -600,7 +604,7 @@ impl paras_registrar::Config for Runtime {
type Event = Event; type Event = Event;
type Origin = Origin; type Origin = Origin;
type Currency = Balances; type Currency = Balances;
type OnSwap = (); type OnSwap = (Crowdloan, Slots);
type ParaDeposit = ParaDeposit; type ParaDeposit = ParaDeposit;
type DataDepositPerByte = DataDepositPerByte; type DataDepositPerByte = DataDepositPerByte;
type MaxCodeSize = MaxCodeSize; type MaxCodeSize = MaxCodeSize;
...@@ -608,44 +612,60 @@ impl paras_registrar::Config for Runtime { ...@@ -608,44 +612,60 @@ impl paras_registrar::Config for Runtime {
type WeightInfo = paras_registrar::TestWeightInfo; type WeightInfo = paras_registrar::TestWeightInfo;
} }
impl pallet_sudo::Config for Runtime { parameter_types! {
type Event = Event; pub const EndingPeriod: BlockNumber = 15 * MINUTES;
type Call = Call;
} }
/// Priviledged origin used by propose parachain. impl auctions::Config for Runtime {
pub struct PriviledgedOrigin; type Event = Event;
type Leaser = Slots;
type EndingPeriod = EndingPeriod;
type Randomness = pallet_babe::RandomnessFromOneEpochAgo<Runtime>;
type InitiateOrigin = EnsureRoot<AccountId>;
type WeightInfo = auctions::TestWeightInfo;
}
impl EnsureOrigin<Origin> for PriviledgedOrigin { parameter_types! {
type Success = (); pub const LeasePeriod: BlockNumber = 1 * DAYS;
}
fn try_origin(o: Origin) -> Result<Self::Success, Origin> { impl slots::Config for Runtime {
let allowed = [ type Event = Event;
hex_literal::hex!("b44c58e50328768ac06ed44b842bfa69d86ea10f60bc36156c9ffc5e00867220"), type Currency = Balances;
hex_literal::hex!("762a6a38ba72b139cba285a39a6766e02046fb023f695f5ecf7f48b037c0dd6b") type Registrar = Registrar;
]; type LeasePeriod = LeasePeriod;
type WeightInfo = slots::TestWeightInfo;
}
let origin = o.clone(); parameter_types! {
match EnsureSigned::try_origin(o) { pub const CrowdloanId: ModuleId = ModuleId(*b"py/cfund");
Ok(who) if allowed.iter().any(|a| a == &who.as_ref()) => Ok(()), pub const SubmissionDeposit: Balance = 100 * DOLLARS;
_ => Err(origin), pub const MinContribution: Balance = 1 * DOLLARS;
} pub const RetirementPeriod: BlockNumber = 6 * HOURS;
} pub const RemoveKeysLimit: u32 = 500;
}
#[cfg(feature = "runtime-benchmarks")] impl crowdloan::Config for Runtime {
fn successful_origin() -> Origin { Origin::root() } type Event = Event;
type ModuleId = CrowdloanId;
type SubmissionDeposit = SubmissionDeposit;
type MinContribution = MinContribution;
type RetirementPeriod = RetirementPeriod;
type OrphanedFunds = ();
type RemoveKeysLimit = RemoveKeysLimit;
type Registrar = Registrar;
type Auctioneer = Auctions;
type WeightInfo = crowdloan::TestWeightInfo;
} }
parameter_types! { impl pallet_sudo::Config for Runtime {
pub const ProposeDeposit: Balance = 1000 * DOLLARS; type Event = Event;
pub const MaxNameLength: u32 = 20; type Call = Call;
} }
impl propose_parachain::Config for Runtime { impl validator_manager::Config for Runtime {
type Event = Event; type Event = Event;
type MaxNameLength = MaxNameLength; type PrivilegedOrigin = EnsureRoot<AccountId>;
type ProposeDeposit = ProposeDeposit;
type PriviledgedOrigin = EnsureOneOf<AccountId, EnsureRoot<AccountId>, PriviledgedOrigin>;
} }
#[cfg(not(feature = "disable-runtime-api"))] #[cfg(not(feature = "disable-runtime-api"))]
......
// Copyright 2020 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot 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.
// Polkadot 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 Polkadot. If not, see <http://www.gnu.org/licenses/>.
//! A pallet for proposing a parachain for Rococo.
//!
//! This pallet works as registration of parachains for Rococo. The idea is to have
//! the registration of community provides parachains being handled by this pallet.
//! People will be able to propose their parachain for registration. This proposal
//! will need to be improved by some priviledged account. After approval the workflow
//! is the following:
//!
//! 1. On start of the next session the pallet announces the new relay chain validators.
//!
//! 2. The session after announcing the new relay chain validators, they will be active. At the
//! switch to this session, the parachain will be registered and is allowed to produce blocks.
//!
//! When deregistering a parachain, we basically reverse the operations.
use frame_support::{
decl_event, decl_error, decl_module, traits::{Get, ReservableCurrency, EnsureOrigin, Currency},
decl_storage, ensure, IterableStorageMap,
};
use primitives::v1::{Id as ParaId, HeadData, ValidationCode};
use polkadot_parachain::primitives::AccountIdConversion;
use frame_system::{ensure_signed, EnsureOneOf, EnsureSigned};
use sp_runtime::Either;
use sp_staking::SessionIndex;
use sp_std::vec::Vec;
use runtime_parachains::paras::ParaGenesisArgs;
type EnsurePriviledgedOrSigned<T> = EnsureOneOf<
<T as frame_system::Config>::AccountId,
<T as Config>::PriviledgedOrigin,
EnsureSigned<<T as frame_system::Config>::AccountId>
>;
type Session<T> = pallet_session::Module<T>;
type BalanceOf<T> = <T as pallet_balances::Config>::Balance;
/// Configuration for the parachain proposer.
pub trait Config: pallet_session::Config
+ pallet_balances::Config
+ runtime_parachains::paras::Config
{
/// The overreaching event type.
type Event: From<Event<Self>> + Into<<Self as frame_system::Config>::Event>;
/// The maximum name length of a parachain.
type MaxNameLength: Get<u32>;
/// The amount that should be deposited when creating a proposal.
type ProposeDeposit: Get<BalanceOf<Self>>;
/// Priviledged origin that can approve/cancel/deregister parachain and proposals.
type PriviledgedOrigin: EnsureOrigin<<Self as frame_system::Config>::Origin>;
}
/// A proposal for adding a parachain to the relay chain.
#[derive(parity_scale_codec::Encode, parity_scale_codec::Decode)]
struct Proposal<AccountId, ValidatorId, Balance> {
/// The account that proposed this parachain.
proposer: AccountId,
/// The genesis head state of the parachain.
genesis_head: HeadData,
/// The validators for the relay chain provided by the parachain.
validators: Vec<ValidatorId>,
/// The name of the parachain.
name: Vec<u8>,
/// The balance that the parachain should receive.
balance: Balance,
}
/// Information about the registered parachain.
#[derive(parity_scale_codec::Encode, parity_scale_codec::Decode)]
struct RegisteredParachainInfo<AccountId, ValidatorId> {
/// The validators for the relay chain provided by the parachain.
validators: Vec<ValidatorId>,
/// The account that proposed the parachain.
proposer: AccountId,
}
decl_event! {
pub enum Event<T> where ValidatorId = <T as pallet_session::Config>::ValidatorId {
/// A parachain was proposed for registration.
ParachainProposed(Vec<u8>, ParaId),
/// A parachain was approved and is scheduled for being activated.
ParachainApproved(ParaId),
/// A parachain was registered and is now running.
ParachainRegistered(ParaId),
/// New validators were added to the set.
ValidatorsRegistered(Vec<ValidatorId>),
/// Validators were removed from the set.
ValidatorsDeregistered(Vec<ValidatorId>),
}
}
decl_error! {
pub enum Error for Module<T: Config> {
/// The name of the parachain is too long.
NameTooLong,
/// The requested parachain id is already registered.
ParachainIdAlreadyTaken,
/// The requested parachain id is already proposed for another parachain.
ParachainIdAlreadyProposed,
/// Could not find the parachain proposal.
ProposalNotFound,
/// Not authorized to do a certain operation.
NotAuthorized,
/// A validator is already registered in the active validator set.
ValidatorAlreadyRegistered,
/// No information about the registered parachain found.
ParachainInfoNotFound,
/// Parachain is already approved for registration.
ParachainAlreadyApproved,
/// Parachain is already scheduled for registration.
ParachainAlreadyScheduled,
/// The given WASM blob is definitley not valid.
DefinitelyNotWasm,
/// Registration requires at least one validator.
AtLeastOneValidatorRequired,
/// Couldn't schedule parachain cleanup.
CouldntCleanup,
}
}
decl_storage! {
trait Store for Module<T: Config> as ParachainProposer {
/// All the proposals.
Proposals: map hasher(twox_64_concat) ParaId => Option<Proposal<T::AccountId, T::ValidatorId, BalanceOf<T>>>;
/// The validation WASM code of the parachain.
ParachainValidationCode: map hasher(twox_64_concat) ParaId => Option<ValidationCode>;
/// Proposals that are approved.
ApprovedProposals: Vec<ParaId>;
/// Proposals that are scheduled at for a fixed session to be applied.
ScheduledProposals: map hasher(twox_64_concat) SessionIndex => Vec<ParaId>;
/// Information about the registered parachains.
ParachainInfo: map hasher(twox_64_concat) ParaId => Option<RegisteredParachainInfo<T::AccountId, T::ValidatorId>>;
/// Validators that should be retired, because their Parachain was deregistered.
ValidatorsToRetire: Vec<T::ValidatorId>;
/// Validators that should be added.
ValidatorsToAdd: Vec<T::ValidatorId>;
}
}
decl_module! {
pub struct Module<T: Config> for enum Call where origin: <T as frame_system::Config>::Origin {
type Error = Error<T>;
/// The maximum name length of a parachain.
const MaxNameLength: u32 = T::MaxNameLength::get();
/// The deposit that will be reserved when proposing a parachain.
const ProposeDeposit: BalanceOf<T> = T::ProposeDeposit::get();
fn deposit_event() = default;
/// Propose a new parachain
///
/// This requires:
/// - `para_id`: The id of the parachain.
/// - `name`: The name of the parachain.
/// - `validation_function`: The wasm runtime of the parachain.
/// - `initial_head_state`: The genesis state of the parachain.
/// - `validators`: Validators that will validate for the relay chain, needs to be at least one.
/// - `balance`: The initial balance of the parachain on the relay chain.
///
/// It will reserve a deposit from the sender account over the lifetime of the chain.
#[weight = 1_000_000]
fn propose_parachain(
origin,
para_id: ParaId,
name: Vec<u8>,
validation_code: ValidationCode,
genesis_head: HeadData,
validators: Vec<T::ValidatorId>,
balance: BalanceOf<T>,
) {
let who = ensure_signed(origin)?;
ensure!(name.len() <= T::MaxNameLength::get() as usize, Error::<T>::NameTooLong);
ensure!(validators.len() > 0, Error::<T>::AtLeastOneValidatorRequired);
ensure!(!Proposals::<T>::contains_key(&para_id), Error::<T>::ParachainIdAlreadyProposed);
ensure!(
runtime_parachains::paras::Module::<T>::lifecycle(para_id).is_none(),
Error::<T>::ParachainIdAlreadyTaken,
);
ensure!(validation_code.0.starts_with(runtime_common::WASM_MAGIC), Error::<T>::DefinitelyNotWasm);
let active_validators = Session::<T>::validators();
let validators_to_retire = ValidatorsToRetire::<T>::get();
ensure!(
validators.iter().all(|v| !active_validators.contains(v) || validators_to_retire.contains(v)),
Error::<T>::ValidatorAlreadyRegistered,
);
Proposals::<T>::iter().try_for_each(|(_, prop)|
if validators.iter().all(|v| !prop.validators.contains(v)) {
Ok(())
} else {
Err(Error::<T>::ValidatorAlreadyRegistered)
}
)?;
pallet_balances::Pallet::<T>::reserve(&who, T::ProposeDeposit::get())?;
let proposal = Proposal {
name: name.clone(),
proposer: who,
validators: validators.into(),
genesis_head,
balance,
};
Proposals::<T>::insert(para_id, proposal);
ParachainValidationCode::insert(para_id, validation_code);
Self::deposit_event(RawEvent::ParachainProposed(name, para_id));
}
/// Approve a parachain proposal.
#[weight = 100_000]
fn approve_proposal(
origin,
para_id: ParaId,
) {
T::PriviledgedOrigin::ensure_origin(origin)?;
ensure!(Proposals::<T>::contains_key(&para_id), Error::<T>::ProposalNotFound);
Self::is_approved_or_scheduled(para_id)?;
ApprovedProposals::append(para_id);
Self::deposit_event(RawEvent::ParachainApproved(para_id));
}
/// Cancel a parachain proposal.
///
/// This also unreserves the deposit.
#[weight = 100_000]
fn cancel_proposal(origin, para_id: ParaId) {
let who = match EnsurePriviledgedOrSigned::<T>::ensure_origin(origin)? {
Either::Left(_) => None,
Either::Right(who) => Some(who),
};
Self::is_approved_or_scheduled(para_id)?;
let proposal = Proposals::<T>::get(&para_id).ok_or(Error::<T>::ProposalNotFound)?;
if let Some(who) = who {
ensure!(who == proposal.proposer, Error::<T>::NotAuthorized);
}
Proposals::<T>::remove(&para_id);
ParachainValidationCode::remove(&para_id);
pallet_balances::Pallet::<T>::unreserve(&proposal.proposer, T::ProposeDeposit::get());
}
/// Deregister a parachain that was already successfully registered in the relay chain.
#[weight = 100_000]
fn deregister_parachain(origin, para_id: ParaId) {
let who = match EnsurePriviledgedOrSigned::<T>::ensure_origin(origin)? {
Either::Left(_) => None,
Either::Right(who) => Some(who),
};
let info = ParachainInfo::<T>::get(&para_id).ok_or(Error::<T>::ParachainInfoNotFound)?;
if let Some(who) = who {
ensure!(who == info.proposer, Error::<T>::NotAuthorized);
}
runtime_parachains::schedule_para_cleanup::<T>(para_id).map_err(|_| Error::<T>::CouldntCleanup)?;
ParachainInfo::<T>::remove(&para_id);
info.validators.into_iter().for_each(|v| ValidatorsToRetire::<T>::append(v));
pallet_balances::Pallet::<T>::unreserve(&info.proposer, T::ProposeDeposit::get());
}
/// Add new validators to the set.
///
/// The new validators will be active from current session + 2.
#[weight = 100_000]
fn register_validators(
origin,
validators: Vec<T::ValidatorId>,
) {
T::PriviledgedOrigin::ensure_origin(origin)?;
validators.clone().into_iter().for_each(|v| ValidatorsToAdd::<T>::append(v));
Self::deposit_event(RawEvent::ValidatorsRegistered(validators));
}
/// Remove validators from the set.
///
/// The removed validators will be deactivated from current session + 2.
#[weight = 100_000]
fn deregister_validators(
origin,
validators: Vec<T::ValidatorId>,
) {
T::PriviledgedOrigin::ensure_origin(origin)?;
validators.clone().into_iter().for_each(|v| ValidatorsToRetire::<T>::append(v));
Self::deposit_event(RawEvent::ValidatorsDeregistered(validators));
}
}
}
impl<T: Config> Module<T> {
/// Returns wether the given `para_id` approval is approved or already scheduled.
fn is_approved_or_scheduled(para_id: ParaId) -> frame_support::dispatch::DispatchResult {
if ApprovedProposals::get().iter().any(|p| *p == para_id) {
return Err(Error::<T>::ParachainAlreadyApproved.into())
}
if ScheduledProposals::get(&Session::<T>::current_index() + 1).iter().any(|p| *p == para_id) {
return Err(Error::<T>::ParachainAlreadyScheduled.into())
}
Ok(())
}
}
impl<T: Config> pallet_session::SessionManager<T::ValidatorId> for Module<T> {
fn new_session(new_index: SessionIndex) -> Option<Vec<T::ValidatorId>> {
if new_index <= 1 {
return None;
}
let proposals = ApprovedProposals::take();
let mut validators = Session::<T>::validators();
ValidatorsToRetire::<T>::take().iter().for_each(|v| {
if let Some(pos) = validators.iter().position(|r| r == v) {
validators.swap_remove(pos);
}
});
// Schedule all approved proposals
for (id, proposal) in proposals.iter().filter_map(|id| Proposals::<T>::get(&id).map(|p| (id, p))) {
ScheduledProposals::append(new_index, id);
let validation_code = ParachainValidationCode::get(&id)?;
let genesis = ParaGenesisArgs {
genesis_head: proposal.genesis_head,
validation_code,