Clean interfaces and docs (paritytech#290)

* Don't re-export frame-support stuff

* Docs for GLMR constant

* Docs for modules in node crate

Co-authored-by: Amar Singh <asinghchrony@protonmail.com>

Author: JoshOrndorff

node/src/chain_spec.rs

@@ -13,6 +13,12 @@
 
 // You should have received a copy of the GNU General Public License
 // along with Moonbeam.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Moonbeam Chain Specifications and utilities for building them.
+//!
+//! Learn more about Substrate chain specifications at
+//! https://substrate.dev/docs/en/knowledgebase/integrate/chain-spec
+
 use bip39::{Language, Mnemonic, Seed};
 use cumulus_primitives::ParaId;
 use log::debug;

node/src/cli.rs

@@ -14,6 +14,11 @@
 // You should have received a copy of the GNU General Public License
 // along with Moonbeam.  If not, see <http://www.gnu.org/licenses/>.
 
+//! Moonbeam CLI Library. Built with structopt
+//!
+//! This module defines the Moonbeam node's Command Line Interface (CLI)
+//! It is built using structopt and inherits behavior from Substrate's sc_cli crate.
+
 use sp_core::H160;
 use std::path::PathBuf;
 use std::str::FromStr;

node/src/command.rs

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU General Public License
 // along with Moonbeam.  If not, see <http://www.gnu.org/licenses/>.
 
+//! This module constructs and executes the appropriate service components for the given subcommand
+
 use crate::{
 	chain_spec,
 	cli::{Cli, RelayChainCli, Subcommand},

node/src/service.rs

@@ -14,6 +14,14 @@
 // You should have received a copy of the GNU General Public License
 // along with Moonbeam.  If not, see <http://www.gnu.org/licenses/>.
 
+//! This module assembles the Moonbeam service components, executes them, and manages communication
+//! between them. This is the backbone of the client-side node implementation.
+//!
+//! This module can assemble:
+//! PartialComponents: For maintence tasks without a complete node (eg import/export blocks, purge)
+//! Full Service: A complete parachain node including the pool, rpc, network, embedded relay chain
+//! Dev Service: A leaner service without the relay chain backing.
+
 use crate::{cli::Sealing, inherents::build_inherent_data_providers};
 use async_io::Timer;
 use cumulus_network::build_block_announce_validator;

runtime/src/lib.rs

@@ -29,13 +29,12 @@
 include!(concat!(env!("OUT_DIR"), "/wasm_binary.rs"));
 
 use fp_rpc::TransactionStatus;
-pub use frame_support::{
+use frame_support::{
 	construct_runtime,
 	pallet_prelude::PhantomData,
 	parameter_types,
-	traits::{FindAuthor, Get, Randomness},
+	traits::{Get, Randomness},
 	weights::{constants::WEIGHT_PER_SECOND, IdentityFee, Weight},
-	ConsensusEngineId, StorageValue,
 };
 use frame_system::{EnsureNever, EnsureRoot, EnsureSigned};
 use pallet_ethereum::Call::transact;
@@ -52,7 +51,7 @@ use sp_runtime::{
 	create_runtime_str, generic, impl_opaque_keys,
 	traits::{BlakeTwo256, Block as BlockT, IdentifyAccount, IdentityLookup, Verify},
 	transaction_validity::{TransactionSource, TransactionValidity},
-	ApplyExtrinsicResult,
+	ApplyExtrinsicResult, Perbill,
 };
 use sp_std::{convert::TryFrom, prelude::*};
 #[cfg(feature = "std")]
@@ -61,7 +60,6 @@ use sp_version::RuntimeVersion;
 
 #[cfg(any(feature = "std", test))]
 pub use sp_runtime::BuildStorage;
-pub use sp_runtime::{Perbill, Permill};
 
 /// An index to a block.
 pub type BlockNumber = u32;
@@ -284,7 +282,7 @@ impl pallet_scheduler::Config for Runtime {
 	type WeightInfo = ();
 }
 
-pub const BLOCKS_PER_DAY: BlockNumber = 24 * 60 * 10;
+const BLOCKS_PER_DAY: BlockNumber = 24 * 60 * 10;
 
 parameter_types! {
 	pub const LaunchPeriod: BlockNumber = BLOCKS_PER_DAY;
@@ -378,7 +376,7 @@ impl cumulus_parachain_system::Config for Runtime {
 
 impl parachain_info::Config for Runtime {}
 
-// 18 decimals
+/// GLMR, the native token, uses 18 decimals of precision.
 pub const GLMR: Balance = 1_000_000_000_000_000_000;
 
 parameter_types! {