Expand description
Substrate CLI library.
To see a full list of commands available, see commands
.
Re-exports§
Modules§
- Definitions of [
ValueEnum
] types. - Various subcommands that can be included in a substrate-based chain’s CLI.
Macros§
- Allows for calling $method with appropriate crypto impl.
Structs§
- Wrapper type that is either a
Hash
or the number of aBlock
. - Optional flag for specifying crypto algorithm
- Parameters for database
- Execution strategies parameters.
- Wrapper type of
String
that holds an unsigned integer of arbitrary size, formatted as a decimal. - Parameters for block import.
- Parameters of the keystore
- A builder that is used to initialize the global logger.
- Params to configure how a message should be passed into a command.
- Parameters used to create the mixnet configuration.
- Parameters used to create the network configuration.
- Optional flag for specifying network scheme
- Parameters used to create the
NodeKeyConfig
, which determines the keypair used for libp2p networking. - Offchain worker related parameters.
- Optional flag for specifying output type
- Parameters used to config prometheus.
- Parameters to define the pruning mode
- Represent a single RPC endpoint with its configuration.
- Parameters of RPC.
- A Substrate CLI runtime that can be used to run a node or a command
- Parameters used to config runtime.
- 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 possiblyauthoring_version
, absolutely notimpl_version
since they change the semantics of the runtime. - Shared parameters used by all
CoreParams
. - Abstraction over OS signals to handle the shutdown of the node smoothly.
- Parameters used to config telemetry.
- Parameters used to create the pool configuration.
Enums§
- Specifies the pruning mode of the database.
- Error type for the CLI.
- Role of the local node.
- Type of transaction pool to be used
Constants§
- The default concurrent connection limit.
- The default max request size in MB.
- The default max response size in MB.
- The default max number of subscriptions per connection.
- The default number of messages the RPC server is allowed to keep in memory per connection.
- The default port.
Traits§
- Common interface of a chain specification.
- A trait that allows converting an object to a Configuration
- Default configuration values used by Substrate
- Substrate client CLI
Functions§
- Build a tokio runtime with all features.
- Generate a valid random name for the node
- Parse Ss58AddressFormat
- Log information about the node itself.
- Parse a secret string, returning a displayable error.
Type Aliases§
- Result type alias for the CLI.