licence and basic docs

core/src/inherents/custom_idps/mod.rs

@@ -1,3 +1,20 @@
+// This file is partmilliles of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 pub mod para_parachain;
 pub mod relay_parachains;
 pub mod timestamp;

core/src/inherents/custom_idps/para_parachain.rs

@@ -1,3 +1,23 @@
+// This file is partmilliles of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Inherent data provider for the [cumulus parachin inherents](https://github.com/paritytech/polkadot-sdk/blob/master/cumulus/primitives/parachain-inherent/src/lib.rs)
+//! for empty block production on top of an existing externalities.
+
 use parity_scale_codec::{Decode, Encode};
 use polkadot_primitives::{BlockNumber, HeadData};
 use sp_consensus_babe::SlotDuration;
@@ -6,14 +26,6 @@ use sp_inherents::InherentIdentifier;
 use sp_runtime::traits::{Block as BlockT, HashingFor, NumberFor};
 use sp_state_machine::TestExternalities;
 
-pub fn is_parachain<B: BlockT>(ext: &mut TestExternalities<HashingFor<B>>) -> bool {
-    let para_id_key = [twox_128(b"ParachainInfo"), twox_128(b"ParachainId")].concat();
-
-    ext.execute_with(|| sp_io::storage::get(&para_id_key))
-        .map(|b| -> Option<u32> { Decode::decode(&mut &b[..]).ok() })
-        .is_some()
-}
-
 /// ext cannot be part of the InherentDataProvider (thread safety), so we need to make storage
 /// queries seperately
 pub fn get_para_id<B: BlockT>(ext: &mut TestExternalities<HashingFor<B>>) -> Option<u32> {

core/src/inherents/custom_idps/relay_parachains.rs

@@ -15,7 +15,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//! Relay chain parachains inherent.
+//! Inherent data provider for the [polkadot parachins inherent](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/primitives/src/v7/mod.rs)
+//! for empty block production on top of an existing externalities.
 
 use sp_inherents::InherentIdentifier;
 use sp_runtime::traits::Block as BlockT;

core/src/inherents/custom_idps/timestamp.rs

@@ -1,3 +1,23 @@
+// This file is part of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Inherent data provider for the timestamp, for empty block production on top of an existing
+//! externalities.
+
 use sp_inherents::{InherentData, InherentIdentifier};
 use sp_runtime::Digest;
 use sp_timestamp::{Timestamp, TimestampInherentData};

core/src/inherents/mod.rs

@@ -1,3 +1,20 @@
+// This file is partmilliles of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 pub mod custom_idps;
 pub mod pre_apply;
 pub mod providers;

core/src/inherents/pre_apply.rs

@@ -1,17 +1,32 @@
+// This file is partmilliles of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 use cumulus_primitives_parachain_inherent::MessageQueueChain;
 use parity_scale_codec::Encode;
 use sp_core::{twox_128, H256};
 use sp_runtime::traits::{Block as BlockT, HashingFor};
 use sp_state_machine::TestExternalities;
 
 /// Some operations must be to performed prior to inherents being applied.
+///
+/// This fn sets the last dmq mcq head value to zero to pass [this check](https://github.com/paritytech/polkadot-sdk/blob/ef114a422291b44f8973739ab7858a29a523e6a2/cumulus/pallets/parachain-system/src/lib.rs#L1162)
+///
+/// It must be called prior to attempting to apply inherents.
 pub fn pre_apply_inherents<B: BlockT>(ext: &mut TestExternalities<HashingFor<B>>) {
-    // set the last dmq mcq head value to zero to pass this check
-    // https://github.com/paritytech/polkadot-sdk/blob/ef114a422291b44f8973739ab7858a29a523e6a2/cumulus/pallets/parachain-system/src/lib.rs#L1162
-    //
-    // it would have been preferable to set it to the real value in the mock inherent
-    // provider for parachain system, but that would require the paraid which we cannot
-    // derive from the externalities.
     let last_dmq_mqc_head_key =
         [twox_128(b"ParachainSystem"), twox_128(b"LastDmqMqcHead")].concat();
     ext.insert(

core/src/inherents/providers.rs

@@ -18,23 +18,20 @@
 
 use std::{str::FromStr, time::Duration};
 
-use cumulus_primitives_parachain_inherent::MessageQueueChain;
 use itertools::Itertools;
 use parity_scale_codec::Encode;
 use sp_consensus_aura::{Slot, SlotDuration, AURA_ENGINE_ID};
 use sp_consensus_babe::{
     digests::{PreDigest, SecondaryPlainPreDigest},
     BABE_ENGINE_ID,
 };
-use sp_core::{twox_128, H256};
 use sp_inherents::InherentData;
 use sp_runtime::{
     traits::{Block as BlockT, HashingFor},
     Digest, DigestItem,
 };
 use sp_state_machine::TestExternalities;
 use sp_std::prelude::*;
-use sp_timestamp::TimestampInherentData;
 use strum::IntoEnumIterator;
 use strum_macros::{Display, EnumIter};
 
@@ -108,6 +105,14 @@ impl<B: BlockT> InherentProvider<B> for ProviderVariant {
     }
 }
 
+/// Attempts to provide inherents in a fashion that works for as many chains as possible.
+///
+/// It is currently tested for
+/// - Polkadot-based relay chains
+/// - Polkadot-ecosystem system parachains
+///
+/// If it does not work for your Substrate-based chain, [please open an issue](https://github.com/paritytech/try-runtime-cli/issues)
+/// and we will look into supporting it.
 struct SmartInherentProvider {
     blocktime: Duration,
 }