Expand and correct documentation

This commit is contained in:
Luke Parker
2022-09-29 05:25:29 -04:00
parent 19cd609cba
commit ca091a5f04
18 changed files with 137 additions and 118 deletions

View File

@@ -11,35 +11,35 @@ pub struct Cli {
#[derive(Debug, clap::Subcommand)]
pub enum Subcommand {
/// Key management CLI utilities
// Key management CLI utilities
#[clap(subcommand)]
Key(sc_cli::KeySubcommand),
/// Build a chain specification
// Build a chain specification
BuildSpec(sc_cli::BuildSpecCmd),
/// Validate blocks
// Validate blocks
CheckBlock(sc_cli::CheckBlockCmd),
/// Export blocks
// Export blocks
ExportBlocks(sc_cli::ExportBlocksCmd),
/// Export the state of a given block into a chain spec
// Export the state of a given block into a chain spec
ExportState(sc_cli::ExportStateCmd),
/// Import blocks
// Import blocks
ImportBlocks(sc_cli::ImportBlocksCmd),
/// Remove the entire chain
// Remove the entire chain
PurgeChain(sc_cli::PurgeChainCmd),
/// Revert the chain to a previous state
// Revert the chain to a previous state
Revert(sc_cli::RevertCmd),
/// Sub-commands concerned with benchmarking
// Sub-commands concerned with benchmarking
#[clap(subcommand)]
Benchmark(frame_benchmarking_cli::BenchmarkCmd),
/// DB meta columns information
// DB meta columns information
ChainInfo(sc_cli::ChainInfoCmd),
}

View File

@@ -31,23 +31,23 @@ pub use pallet_balances::Call as BalancesCall;
use pallet_transaction_payment::CurrencyAdapter;
use pallet_contracts::{migration, DefaultContractAccessWeight};
/// An index to a block
/// An index to a block.
pub type BlockNumber = u32;
/// Alias to 512-bit hash when used in the context of a transaction signature on the chain
/// Alias to 512-bit hash when used in the context of a transaction signature on the chain.
pub type Signature = MultiSignature;
/// Some way of identifying an account on the chain. We intentionally make it equivalent
/// to the public key of our transaction signing scheme
/// to the public key of our transaction signing scheme.
pub type AccountId = <<Signature as Verify>::Signer as IdentifyAccount>::AccountId;
/// Balance of an account
/// Balance of an account.
pub type Balance = u64;
/// Index of a transaction in the chain, for a given account
/// Index of a transaction in the chain, for a given account.
pub type Index = u32;
/// A hash of some data used by the chain
/// A hash of some data used by the chain.
pub type Hash = sp_core::H256;
pub mod opaque {
@@ -79,7 +79,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
pub const MILLISECS_PER_BLOCK: u64 = 6000;
pub const SLOT_DURATION: u64 = MILLISECS_PER_BLOCK;
/// Measured in blocks
/// Measured in blocks.
pub const MINUTES: BlockNumber = 60_000 / (MILLISECS_PER_BLOCK as BlockNumber);
pub const HOURS: BlockNumber = MINUTES * 60;
pub const DAYS: BlockNumber = HOURS * 24;