Crate sc_cli

Substrate CLI library.

To see a full list of commands available, see commands.

Re-exports

• pub use clap;
• pub use arg_enums::*;
• pub use commands::*;

Modules

• arg_enums
  Definitions of ValueEnum types.
• commands
  Various subcommands that can be included in a substrate-based chain’s CLI.

Macros

• with_crypto_scheme
  Allows for calling $method with appropriate crypto impl.

Structs

• BlockNumberOrHash
  Wrapper type that is either a Hash or the number of a Block.
• CryptoSchemeFlag
  Optional flag for specifying crypto algorithm
• DatabaseParams
  Parameters for database
• ExecutionStrategiesParams
  Execution strategies parameters.
• GenericNumber
  Wrapper type of String that holds an unsigned integer of arbitrary size, formatted as a decimal.
• ImportParams
  Parameters for block import.
• KeystoreParams
  Parameters of the keystore
• LoggerBuilder
  A builder that is used to initialize the global logger.
• MessageParams
  Params to configure how a message should be passed into a command.
• MixnetParams
  Parameters used to create the mixnet configuration.
• NetworkParams
  Parameters used to create the network configuration.
• NetworkSchemeFlag
  Optional flag for specifying network scheme
• NodeKeyParams
  Parameters used to create the NodeKeyConfig, which determines the keypair used for libp2p networking.
• OffchainWorkerParams
  Offchain worker related parameters.
• OutputTypeFlag
  Optional flag for specifying output type
• PrometheusParams
  Parameters used to config prometheus.
• PruningParams
  Parameters to define the pruning mode
• RpcEndpoint
  Represent a single RPC endpoint with its configuration.
• RpcParams
  Parameters of RPC.
• Runner
  A Substrate CLI runtime that can be used to run a node or a command
• RuntimeParams
  Parameters used to config runtime.
• RuntimeVersion
  Runtime version. This should not be thought of as classic Semver (major/minor/tiny). This triplet have different semantics and mis-interpretation could cause problems. In particular: bug fixes should result in an increment of spec_version and possibly authoring_version, absolutely not impl_version since they change the semantics of the runtime.
• SharedParams
  Shared parameters used by all CoreParams.
• Signals
  Abstraction over OS signals to handle the shutdown of the node smoothly.
• TelemetryParams
  Parameters used to config telemetry.
• TransactionPoolParams
  Parameters used to create the pool configuration.

Enums

• DatabasePruningMode
  Specifies the pruning mode of the database.
• Error
  Error type for the CLI.
• Role
  Role of the local node.

Constants

• RPC_DEFAULT_MAX_CONNECTIONS
  The default concurrent connection limit.
• RPC_DEFAULT_MAX_REQUEST_SIZE_MB
  The default max request size in MB.
• RPC_DEFAULT_MAX_RESPONSE_SIZE_MB
  The default max response size in MB.
• RPC_DEFAULT_MAX_SUBS_PER_CONN
  The default max number of subscriptions per connection.
• RPC_DEFAULT_MESSAGE_CAPACITY_PER_CONN
  The default number of messages the RPC server is allowed to keep in memory per connection.
• RPC_DEFAULT_PORT
  The default port.

Traits

• ChainSpec
  Common interface of a chain specification.
• CliConfiguration
  A trait that allows converting an object to a Configuration
• DefaultConfigurationValues
  Default configuration values used by Substrate
• SubstrateCli
  Substrate client CLI

Functions

• build_runtime
  Build a tokio runtime with all features.
• generate_node_name
  Generate a valid random name for the node
• parse_ss58_address_format
  Parse Ss58AddressFormat
• print_node_infos
  Log information about the node itself.
• secret_string_from_str
  Parse a secret string, returning a displayable error.

Type Aliases

• Result
  Result type alias for the CLI.