feat: integrate parachain collator pallet with session and cumulus aura (#113)

* chore(deps): update substrate cumulus polkadot deps

* chore(deps): use latest polkadot release branch

* fix: breaking changes from latest relase branch

* use chainlink master

* update polkadot deps

* use compact Cargo.toml fromat everywhere

* update to master

* update tests

* add sp-runtime as optional dependency

* update chainlink

* switch to polkadot v0.9.4 branches

* update runtime

* revert new pallet balances types

* revert config name change

* add license header

* revert naming conventions

* feat: add collator selection pallet

* configure session authorship collator selection

* configure cumulus aura

* chore: rustfmt

* use cumulus collator selection

* use correct keys

Author: mattsse

Cargo.lock

@@ -170,6 +170,7 @@ polkadot-node-core-pvf = { git = "https://github.com/paritytech//polkadot", rev
 cumulus-primitives-core = { git = "https://github.com/paritytech//cumulus", rev = "08b7bcfe21b2ce2a26dcdaa664bf8c016f7c93ae" }
 cumulus-pallet-parachain-system = { git = "https://github.com/paritytech//cumulus", rev = "08b7bcfe21b2ce2a26dcdaa664bf8c016f7c93ae" }
 cumulus-pallet-aura-ext = { git = "https://github.com/paritytech//cumulus", rev = "08b7bcfe21b2ce2a26dcdaa664bf8c016f7c93ae" }
+pallet-collator-selection = { git = "https://github.com/paritytech//cumulus", rev = "08b7bcfe21b2ce2a26dcdaa664bf8c016f7c93ae" }
 parachain-info = { git = "https://github.com/paritytech//cumulus", rev = "08b7bcfe21b2ce2a26dcdaa664bf8c016f7c93ae" }
 cumulus-client-cli = { git = "https://github.com/paritytech//cumulus", rev = "08b7bcfe21b2ce2a26dcdaa664bf8c016f7c93ae" }
 cumulus-client-collator = { git = "https://github.com/paritytech//cumulus", rev = "08b7bcfe21b2ce2a26dcdaa664bf8c016f7c93ae" }

Cargo.toml

@@ -7,7 +7,7 @@ use sc_chain_spec::{ChainSpecExtension, ChainSpecGroup};
 use sc_service::ChainType;
 use serde::{Deserialize, Serialize};
 use sp_core::{sr25519, Pair, Public};
-use sp_runtime::traits::{IdentifyAccount, Verify};
+use sp_runtime::traits::{IdentifyAccount, Verify, Zero};
 
 /// Specialized `ChainSpec` for the normal parachain runtime.
 pub type ChainSpec = sc_service::GenericChainSpec<parachain_runtime::GenesisConfig, Extensions>;
@@ -19,6 +19,13 @@ pub fn get_from_seed<TPublic: Public>(seed: &str) -> <TPublic::Pair as Pair>::Pu
         .public()
 }
 
+/// Generate collator keys from seed.
+///
+/// This function's return type must always match the session keys of the chain in tuple format.
+pub fn get_collator_keys_from_seed(seed: &str) -> AuraId {
+    get_from_seed::<AuraId>(seed)
+}
+
 /// The extensions for the [`ChainSpec`].
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecGroup, ChainSpecExtension)]
 #[serde(deny_unknown_fields)]
@@ -56,10 +63,11 @@ pub fn pint_development_config(id: ParaId) -> ChainSpec {
         move || {
             pint_testnet_genesis(
                 get_account_id_from_seed::<sr25519::Public>("Alice"),
-                vec![
-                    get_from_seed::<AuraId>("Alice"),
-                    get_from_seed::<AuraId>("Bob"),
-                ],
+                // initial collators.
+                vec![(
+                    get_account_id_from_seed::<sr25519::Public>("Alice"),
+                    get_collator_keys_from_seed("Alice"),
+                )],
                 vec![
                     get_account_id_from_seed::<sr25519::Public>("Alice"),
                     get_account_id_from_seed::<sr25519::Public>("Bob"),
@@ -96,9 +104,16 @@ pub fn pint_local_config(id: ParaId) -> ChainSpec {
         move || {
             pint_testnet_genesis(
                 get_account_id_from_seed::<sr25519::Public>("Alice"),
+                // initial collators.
                 vec![
-                    get_from_seed::<AuraId>("Alice"),
-                    get_from_seed::<AuraId>("Bob"),
+                    (
+                        get_account_id_from_seed::<sr25519::Public>("Alice"),
+                        get_collator_keys_from_seed("Alice"),
+                    ),
+                    (
+                        get_account_id_from_seed::<sr25519::Public>("Bob"),
+                        get_collator_keys_from_seed("Bob"),
+                    ),
                 ],
                 vec![
                     get_account_id_from_seed::<sr25519::Public>("Alice"),
@@ -136,7 +151,7 @@ pub fn pint_local_config(id: ParaId) -> ChainSpec {
 
 fn pint_testnet_genesis(
     root_key: AccountId,
-    _initial_authorities: Vec<AuraId>,
+    initial_authorities: Vec<(AccountId, AuraId)>,
     endowed_accounts: Vec<AccountId>,
     council_members: Vec<AccountId>,
     id: ParaId,
@@ -161,6 +176,28 @@ fn pint_testnet_genesis(
         },
         pallet_sudo: parachain_runtime::SudoConfig { key: root_key },
         parachain_info: parachain_runtime::ParachainInfoConfig { parachain_id: id },
+        pallet_collator_selection: parachain_runtime::CollatorSelectionConfig {
+            invulnerables: initial_authorities
+                .iter()
+                .cloned()
+                .map(|(acc, _)| acc)
+                .collect(),
+            candidacy_bond: Zero::zero(),
+            ..Default::default()
+        },
+        pallet_session: parachain_runtime::SessionConfig {
+            keys: initial_authorities
+                .iter()
+                .cloned()
+                .map(|(acc, aura)| {
+                    (
+                        acc.clone(),                                     // account id
+                        acc,                                             // validator id
+                        parachain_runtime::opaque::SessionKeys { aura }, // session keys
+                    )
+                })
+                .collect(),
+        },
         // no need to pass anything to aura, in fact it will panic if we do. Session will take care
         // of this.
         pallet_aura: Default::default(),

node/src/chain_spec.rs

@@ -54,7 +54,7 @@ pub struct ExportGenesisStateCommand {
     /// Id of the parachain this state is for.
     ///
     /// Default: 100
-    #[structopt(long, conflicts_with = "chain")]
+    #[structopt(long)]
     pub parachain_id: Option<u32>,
 
     /// Write output in binary. Default is to write in hex.

node/src/cli.rs

@@ -32,6 +32,7 @@ sp-runtime = { git = 'https://github.com/paritytech/substrate', branch = 'polkad
 sp-session = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
 sp-std = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
 sp-transaction-pool = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
+frame-try-runtime = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false, optional = true }
 sp-version = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
 
 ## Substrate FRAME Dependencies
@@ -44,14 +45,17 @@ frame-system-rpc-runtime-api = { git = 'https://github.com/paritytech/substrate'
 
 ## Substrate Pallet Dependencies
 pallet-aura = { git = 'https://github.com/paritytech/substrate', default-features = false, branch = 'master' }
+pallet-authorship = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false}
 pallet-balances = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
 pallet-randomness-collective-flip = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
+pallet-session = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false, features = ['historical'] }
 pallet-sudo = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
 pallet-timestamp = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
 pallet-transaction-payment = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
 pallet-transaction-payment-rpc-runtime-api = { git = 'https://github.com/paritytech/substrate', branch = 'polkadot-v0.9.4', default-features = false }
 
 # Cumulus Dependencies
+pallet-collator-selection = { git = 'https://github.com/paritytech/cumulus', branch = 'polkadot-v0.9.4', default-features = false }
 cumulus-pallet-aura-ext = { git = 'https://github.com/paritytech/cumulus', branch = 'polkadot-v0.9.4', default-features = false }
 cumulus-pallet-parachain-system = { git = 'https://github.com/paritytech/cumulus', branch = 'polkadot-v0.9.4', default-features = false }
 cumulus-pallet-dmp-queue = { git = 'https://github.com/paritytech/cumulus', branch = 'polkadot-v0.9.4', default-features = false }
@@ -81,8 +85,8 @@ xcm-calls = {path = '../primitives/xcm-calls', default-features = false }
 pallet-chainlink-feed = { git = 'https://github.com/ChainSafe/chainlink-polkadot', branch = 'upgrade-substrate-master', default-features = false }
 
 [dev-dependencies]
-hex-literal = "0.3.1"
-hex = "0.4.3"
+hex-literal = '0.3.1'
+hex = '0.4.3'
 
 [features]
 default = ['std']
@@ -94,6 +98,7 @@ runtime-benchmarks = [
 	'frame-system-benchmarking',
 	'frame-system/runtime-benchmarks',
 	'xcm-builder/runtime-benchmarks',
+	'pallet-collator-selection/runtime-benchmarks',
 	'pallet-balances/runtime-benchmarks',
 	'pallet-timestamp/runtime-benchmarks',
     'pallet-asset-depository/runtime-benchmarks',
@@ -111,9 +116,16 @@ std = [
 	'codec/std',
 	'serde',
 	'log/std',
+	
+	'frame-support/std',
+	'frame-executive/std',
+	'frame-system/std',
+	'frame-try-runtime/std',
+	
 	'sp-api/std',
 	'sp-std/std',
 	'sp-io/std',
+	'sp-consensus-aura/std',
 	'sp-core/std',
 	'sp-runtime/std',
 	'sp-version/std',
@@ -122,13 +134,12 @@ std = [
 	'sp-block-builder/std',
 	'sp-transaction-pool/std',
 	'sp-inherents/std',
-	'frame-support/std',
-	'frame-executive/std',
-	'frame-system/std',
+	'pallet-authorship/std',
 	'pallet-balances/std',
 	'pallet-randomness-collective-flip/std',
 	'pallet-timestamp/std',
 	'pallet-sudo/std',
+	'pallet-session/std',
 	'pallet-transaction-payment/std',
 	'parachain-info/std',
 	'cumulus-pallet-aura-ext/std',
@@ -141,9 +152,9 @@ std = [
 	'xcm-builder/std',
 	'xcm-executor/std',
 	'pallet-aura/std',
-	'sp-consensus-aura/std',
 	'pallet-asset-depository/std',
 	'pallet-asset-index/std',
+	"pallet-collator-selection/std",
 	'pallet-committee/std',
 	'pallet-local-treasury/std',
 	'pallet-price-feed/std',

runtime/Cargo.toml

@@ -467,6 +467,56 @@ impl pallet_aura::Config for Runtime {
     type AuthorityId = AuraId;
 }
 
+parameter_types! {
+    pub const UncleGenerations: u32 = 0;
+}
+
+impl pallet_authorship::Config for Runtime {
+    type FindAuthor = pallet_session::FindAccountFromAuthorIndex<Self, Aura>;
+    type UncleGenerations = UncleGenerations;
+    type FilterUncle = ();
+    type EventHandler = CollatorSelection;
+}
+
+parameter_types! {
+    pub const DisabledValidatorsThreshold: Perbill = Perbill::from_percent(33);
+    pub const Period: u32 = 6 * HOURS;
+    pub const Offset: BlockNumber = 0;
+}
+
+impl pallet_session::Config for Runtime {
+    type Event = Event;
+    type ValidatorId = <Self as frame_system::Config>::AccountId;
+    // we don't have stash and controller, thus we don't need the convert as well.
+    type ValidatorIdOf = pallet_collator_selection::IdentityCollator;
+    type ShouldEndSession = pallet_session::PeriodicSessions<Period, Offset>;
+    type NextSessionRotation = pallet_session::PeriodicSessions<Period, Offset>;
+    type SessionManager = CollatorSelection;
+    // Essentially just Aura, but lets be pedantic.
+    type SessionHandler =
+        <opaque::SessionKeys as sp_runtime::traits::OpaqueKeys>::KeyTypeIdProviders;
+    type Keys = opaque::SessionKeys;
+    type DisabledValidatorsThreshold = DisabledValidatorsThreshold;
+    type WeightInfo = ();
+}
+
+parameter_types! {
+    pub const PotId: PalletId = PalletId(*b"PotStake");
+    pub const MaxCandidates: u32 = 200;
+    pub const MaxInvulnerables: u32 = 50;
+}
+
+impl pallet_collator_selection::Config for Runtime {
+    type Event = Event;
+    type Currency = Balances;
+    type UpdateOrigin = EnsureApprovedByCommittee;
+    type PotId = PotId;
+    type MaxCandidates = MaxCandidates;
+    type MaxInvulnerables = MaxInvulnerables;
+    type KickThreshold = Period;
+    type WeightInfo = ();
+}
+
 parameter_types! {
     pub const TreasuryPalletId: PalletId = PalletId(*b"12345678");
 }
@@ -726,7 +776,9 @@ construct_runtime!(
         ParachainInfo: parachain_info::{Pallet, Storage, Config},
 
         // Collator. The order of the 4 below are important and shall not change.
-        // TODO authorship, collatorselection
+        Authorship: pallet_authorship::{Pallet, Call, Storage},
+        CollatorSelection: pallet_collator_selection::{Pallet, Call, Storage, Event<T>, Config<T>},
+        Session: pallet_session::{Pallet, Call, Storage, Event, Config<T>},
         Aura: pallet_aura::{Pallet, Config<T>},
         AuraExt: cumulus_pallet_aura_ext::{Pallet, Config},
 
@@ -779,6 +831,7 @@ pub type Executive = frame_executive::Executive<
     frame_system::ChainContext<Runtime>,
     Runtime,
     AllPallets,
+    (),
 >;
 
 impl_runtime_apis! {
@@ -929,4 +982,7 @@ impl_runtime_apis! {
     }
 }
 
-cumulus_pallet_parachain_system::register_validate_block!(Runtime, Executive);
+cumulus_pallet_parachain_system::register_validate_block!(
+    Runtime,
+    cumulus_pallet_aura_ext::BlockExecutor::<Runtime, Executive>
+);