Struct polkadot_omni_node_lib::cli::RelayChainCli

pub struct RelayChainCli<Config: CliConfig> {
    pub base: RunCmd,
    pub chain_id: Option<String>,
    pub base_path: Option<PathBuf>,
    /* private fields */
}

The relay chain CLI flags. These are passed in after a -- at the end.

Fields

base: RunCmd

The actual relay chain cli object.

chain_id: Option<String>

Optional chain id that should be passed to the relay chain.

base_path: Option<PathBuf>

The base path that should be used by the relay chain.

Implementations

impl<Config: CliConfig> RelayChainCli<Config>

pub fn new<'a>( para_config: &Configuration, relay_chain_args: impl Iterator<Item = &'a String>, ) -> Self

Parse the relay chain CLI parameters using the parachain Configuration.

Trait Implementations

impl<Config: CliConfig> CliConfiguration<RelayChainCli<Config>> for RelayChainCli<Config>

fn shared_params(&self) -> &SharedParams

Get the SharedParams for this object

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

Get the ImportParams for this object

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

Get the NetworkParams for this object

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

Get the KeystoreParams for this object

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

Get the base path of the configuration (if any)

fn rpc_addr(&self, default_listen_port: u16) -> Result<Option<Vec<RpcEndpoint>>>

Get the RPC address.

fn prometheus_config( &self, default_listen_port: u16, chain_spec: &Box<dyn ChainSpec>, ) -> Result<Option<PrometheusConfig>>

Get the prometheus configuration (None if disabled)

fn init<F>( &self, _support_url: &String, _impl_version: &String, _logger_hook: F, ) -> Result<()>

where F: FnOnce(&mut LoggerBuilder),

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

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

Get the chain ID (string).

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

Gets the role

fn transaction_pool(&self, is_dev: bool) -> Result<TransactionPoolOptions>

Get the transaction pool options

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

Get the trie cache maximum size.

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

Returns the RPC method set to expose.

fn rpc_max_connections(&self) -> Result<u32>

Get the maximum number of RPC server connections.

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

Get the RPC cors (None if disabled)

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

Get the default value for heap pages

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 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 telemetry_endpoints( &self, chain_spec: &Box<dyn ChainSpec>, ) -> Result<Option<TelemetryEndpoints>>

Get the telemetry endpoints (if any)

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

Get the name of the node.

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

Get the PruningParams 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 is_dev(&self) -> Result<bool, Error>

Returns true if the node is for development or not

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

Get the network configuration

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

Get the keystore configuration.

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

Get the database cache size.

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

Get the database backend variant.

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

Get the database configuration object for the parameters provided

fn state_pruning(&self) -> Result<Option<PruningMode>, Error>

Get the state pruning mode.

fn blocks_pruning(&self) -> Result<BlocksPruning, Error>

Get the block pruning mode.

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

Get the WASM execution method.

fn wasm_runtime_overrides(&self) -> Option<PathBuf>

Get the path where WASM overrides live.

fn rpc_max_request_size(&self) -> Result<u32, Error>

Get maximum RPC request payload size.

fn rpc_max_response_size(&self) -> Result<u32, Error>

Get maximum RPC response payload size.

fn rpc_max_subscriptions_per_connection(&self) -> Result<u32, Error>

Get maximum number of subscriptions per connection.

fn rpc_buffer_capacity_per_connection(&self) -> Result<u32, Error>

The number of messages the RPC server is allowed to keep in memory per connection.

fn rpc_batch_config(&self) -> Result<BatchRequestConfig, Error>

RPC server batch request configuration.

fn rpc_rate_limit(&self) -> Result<Option<NonZero<u32>>, Error>

RPC rate limit configuration.

fn rpc_rate_limit_whitelisted_ips(&self) -> Result<Vec<IpNetwork>, Error>

RPC rate limit whitelisted ip addresses.

fn rpc_rate_limit_trust_proxy_headers(&self) -> Result<bool, Error>

RPC rate limit trust proxy headers.

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

Returns an offchain worker config wrapped in Ok(_)

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

Get the development key seed from the current object

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

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

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

Get the TracingReceiver value from the current object

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

Get the node key from the current object

fn runtime_cache_size(&self) -> Result<u8, Error>

Get maximum different runtimes in cache

fn create_configuration<C>( &self, cli: &C, tokio_handle: Handle, ) -> Result<Configuration, Error>

where C: SubstrateCli,

Create a Configuration object from the current object

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

Get the filters for the logging.

fn detailed_log_output(&self) -> Result<bool, Error>

Should the detailed log output be enabled.

fn enable_log_reloading(&self) -> Result<bool, Error>

Is log reloading enabled?

fn disable_log_color(&self) -> Result<bool, Error>

Should the log color output be disabled?

impl<Config: Debug + CliConfig> Debug for RelayChainCli<Config>

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

Formats the value using the given formatter.

impl<Config: CliConfig> DefaultConfigurationValues for RelayChainCli<Config>

fn p2p_listen_port() -> u16

The port Substrate should listen on for p2p connections.

fn rpc_listen_port() -> u16

The port Substrate should listen on for JSON-RPC connections.

fn prometheus_listen_port() -> u16

The port Substrate should listen on for prometheus connections.

impl<Config: CliConfig> SubstrateCli for RelayChainCli<Config>

fn impl_name() -> String

Implementation name.

fn impl_version() -> String

Implementation version.

fn description() -> String

Executable file description.

fn author() -> String

Executable file author.

fn support_url() -> String

Support URL.

fn copyright_start_year() -> i32

Copyright starting year (x-current year)

fn load_spec(&self, id: &str) -> Result<Box<dyn ChainSpec>, String>

Chain spec factory

fn executable_name() -> String

Executable file name.

fn client_id() -> String

Returns the client ID: {impl_name}/v{impl_version}

fn create_configuration<T, DVC>( &self, command: &T, tokio_handle: Handle, ) -> Result<Configuration, Error>

where T: CliConfiguration<DVC>, DVC: DefaultConfigurationValues,

Only create a Configuration for the command provided in argument

fn create_runner<T, DVC>(&self, command: &T) -> Result<Runner<Self>, Error>

where T: CliConfiguration<DVC>, DVC: DefaultConfigurationValues,

Create a runner for the command provided in argument. This will create a Configuration and a tokio runtime

fn create_runner_with_logger_hook<T, DVC, F>( &self, command: &T, logger_hook: F, ) -> Result<Runner<Self>, Error>

where T: CliConfiguration<DVC>, DVC: DefaultConfigurationValues, F: FnOnce(&mut LoggerBuilder, &Configuration),

Create a runner for the command provided in argument. The logger_hook can be used to setup a custom profiler or update the logger configuration before it is initialized.