Struct sc_cli::BuildSyncSpecCmd

pub struct BuildSyncSpecCmd {
    pub raw: bool,
    pub sync_first: bool,
    pub disable_default_bootnode: bool,
    pub shared_params: SharedParams,
    pub network_params: NetworkParams,
}

The build-sync-spec command used to build a chain spec that contains a light client state so that light clients can sync faster.

Fields

raw: bool

Force raw genesis storage output.

sync_first: bool

Sync the chain using a full client first.

disable_default_bootnode: bool

Disable adding the default bootnode to the specification.

By default the /ip4/127.0.0.1/tcp/30333/p2p/NODE_PEER_ID bootnode is added to the specification when no bootnode exists.

shared_params: SharedParams

network_params: NetworkParams

Implementations

impl BuildSyncSpecCmd

pub async fn run<B, CL>(
    &self,
    spec: Box<dyn ChainSpec>,
    network_config: NetworkConfiguration,
    client: Arc<CL>,
    network_status_sinks: NetworkStatusSinks<B>
) -> Result<()> where
    B: BlockT,
    CL: HeaderBackend<B>, 

Run the build-sync-spec command

Trait Implementations

impl CliConfiguration<()> for BuildSyncSpecCmd

fn shared_params(&self) -> &SharedParams

Get the SharedParams for this object

fn network_params(&self) -> Option<&NetworkParams>

Get the NetworkParams for this object

fn import_params(&self) -> Option<&ImportParams>

Get the ImportParams for this object

fn pruning_params(&self) -> Option<&PruningParams>

Get the PruningParams for this object

fn keystore_params(&self) -> Option<&KeystoreParams>

Get the KeystoreParams for this object

fn offchain_worker_params(&self) -> Option<&OffchainWorkerParams>

Get a reference to OffchainWorkerParams for this object.

fn node_key_params(&self) -> Option<&NodeKeyParams>

Get the NodeKeyParams for this object

fn database_params(&self) -> Option<&DatabaseParams>

Get the DatabaseParams for this object

fn base_path(&self) -> Result<Option<BasePath>>

Get the base path of the configuration (if any)

fn is_dev(&self) -> Result<bool>

Returns true if the node is for development or not

fn role(&self, _is_dev: bool) -> Result<Role>

Gets the role

fn transaction_pool(&self) -> Result<TransactionPoolOptions>

Get the transaction pool options

fn network_config(
    &self,
    chain_spec: &Box<dyn ChainSpec>,
    is_dev: bool,
    net_config_dir: PathBuf,
    client_id: &str,
    node_name: &str,
    node_key: NodeKeyConfig,
    default_listen_port: u16
) -> Result<NetworkConfiguration>

Get the network configuration

fn keystore_config(&self, base_path: &PathBuf) -> Result<KeystoreConfig>

Get the keystore configuration.

fn database_cache_size(&self) -> Result<Option<usize>>

Get the database cache size.

fn database(&self) -> Result<Option<Database>>

Get the database backend variant.

fn database_config(
    &self,
    base_path: &PathBuf,
    cache_size: usize,
    database: Database
) -> Result<DatabaseConfig>

Get the database configuration object for the parameters provided

fn state_cache_size(&self) -> Result<usize>

Get the state cache size.

fn state_cache_child_ratio(&self) -> Result<Option<usize>>

Get the state cache child ratio (if any).

fn pruning(&self, unsafe_pruning: bool, role: &Role) -> Result<PruningMode>

Get the pruning mode.

fn chain_id(&self, is_dev: bool) -> Result<String>

Get the chain ID (string).

fn node_name(&self) -> Result<String>

Get the name of the node.

fn wasm_method(&self) -> Result<WasmExecutionMethod>

Get the WASM execution method.

fn execution_strategies(
    &self,
    is_dev: bool,
    is_validator: bool
) -> Result<ExecutionStrategies>

Get the execution strategies.

fn rpc_http(&self, _default_listen_port: u16) -> Result<Option<SocketAddr>>

Get the RPC HTTP address (None if disabled).

fn rpc_ipc(&self) -> Result<Option<String>>

Get the RPC IPC path (None if disabled).

fn rpc_ws(&self, _default_listen_port: u16) -> Result<Option<SocketAddr>>

Get the RPC websocket address (None if disabled).

fn rpc_methods(&self) -> Result<RpcMethods>

Returns the RPC method set to expose.

fn rpc_ws_max_connections(&self) -> Result<Option<usize>>

Get the RPC websockets maximum connections (None if unlimited).

fn rpc_cors(&self, _is_dev: bool) -> Result<Option<Vec<String>>>

Get the RPC cors (None if disabled)

fn prometheus_config(
    &self,
    _default_listen_port: u16
) -> Result<Option<PrometheusConfig>>

Get the prometheus configuration (None if disabled)

fn telemetry_endpoints(
    &self,
    chain_spec: &Box<dyn ChainSpec>
) -> Result<Option<TelemetryEndpoints>>

Get the telemetry endpoints (if any)

fn telemetry_external_transport(&self) -> Result<Option<ExtTransport>>

Get the telemetry external transport

fn default_heap_pages(&self) -> Result<Option<u64>>

Get the default value for heap pages

fn offchain_worker(&self, role: &Role) -> Result<OffchainWorkerConfig>

Returns an offchain worker config wrapped in Ok(_)

fn force_authoring(&self) -> Result<bool>

Returns Ok(true) if authoring should be forced

fn disable_grandpa(&self) -> Result<bool>

Returns Ok(true) if grandpa should be disabled

fn dev_key_seed(&self, _is_dev: bool) -> Result<Option<String>>

Get the development key seed from the current object

fn tracing_targets(&self) -> Result<Option<String>>

Get the tracing targets from the current object (if any)

fn tracing_receiver(&self) -> Result<TracingReceiver>

Get the TracingReceiver value from the current object

fn node_key(&self, net_config_dir: &PathBuf) -> Result<NodeKeyConfig>

Get the node key from the current object

fn max_runtime_instances(&self) -> Result<Option<usize>>

Get maximum runtime instances

fn announce_block(&self) -> Result<bool>

Activate or not the automatic announcing of blocks after import

fn create_configuration<C: SubstrateCli>(
    &self,
    cli: &C,
    task_executor: TaskExecutor
) -> Result<Configuration>

Create a Configuration object from the current object

fn log_filters(&self) -> Result<String>

Get the filters for the logging.

fn init<C: SubstrateCli>(&self) -> Result<()>

Initialize substrate. This must be done only once per process.

impl Debug for BuildSyncSpecCmd

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StructOpt for BuildSyncSpecCmd

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

pub fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

pub fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

pub fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for BuildSyncSpecCmd

fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

fn is_subcommand() -> bool

pub fn from_subcommand(
    _sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>