Struct NodeCommand

pub struct NodeCommand<C: ChainSpecParser = EthereumChainSpecParser, Ext: Args + Debug = NoArgs> {

    pub config: Option<PathBuf>,
    pub chain: Arc<C::ChainSpec>,
    pub metrics: Option<SocketAddr>,
    pub instance: u16,
    pub with_unused_ports: bool,
    pub datadir: DatadirArgs,
    pub network: NetworkArgs,
    pub rpc: RpcServerArgs,
    pub txpool: TxPoolArgs,
    pub builder: PayloadBuilderArgs,
    pub debug: DebugArgs,
    pub db: DatabaseArgs,
    pub dev: DevArgs,
    pub pruning: PruningArgs,
    pub ext: Ext,
}

Start the node

Fields

config: Option<PathBuf>

The path to the configuration file to use.

chain: Arc<C::ChainSpec>

The chain this node is running.

Possible values are either a built-in chain or the path to a chain specification file.

metrics: Option<SocketAddr>

Enable Prometheus metrics.

The metrics will be served at the given interface and port.

instance: u16

Add a new instance of a node.

Configures the ports of the node to avoid conflicts with the defaults. This is useful for running multiple nodes on the same machine.

Max number of instances is 200. It is chosen in a way so that it’s not possible to have port numbers that conflict with each other.

Changes to the following port numbers:

• DISCOVERY_PORT: default + instance - 1
• AUTH_PORT: default + instance * 100 - 100
• HTTP_RPC_PORT: default - instance + 1
• WS_RPC_PORT: default + instance * 2 - 2

with_unused_ports: bool

Sets all ports to unused, allowing the OS to choose random unused ports when sockets are bound.

Mutually exclusive with --instance.

datadir: DatadirArgs

All datadir related arguments

network: NetworkArgs

All networking related arguments

rpc: RpcServerArgs

All rpc related arguments

txpool: TxPoolArgs

All txpool related arguments with –txpool prefix

builder: PayloadBuilderArgs

All payload builder related arguments

debug: DebugArgs

All debug related arguments with –debug prefix

db: DatabaseArgs

All database related arguments

dev: DevArgs

All dev related arguments with –dev prefix

pruning: PruningArgs

All pruning related arguments

ext: Ext

Additional cli arguments

Implementations

impl<C: ChainSpecParser> NodeCommand<C>

pub fn parse_args() -> Self

Parsers only the default CLI arguments

pub fn try_parse_args_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parsers only the default NodeCommand arguments from the given iterator

impl<C: ChainSpecParser<ChainSpec: EthChainSpec + EthereumHardforks>, Ext: Args + Debug> NodeCommand<C, Ext>

pub async fn execute<L, Fut>(self, ctx: CliContext, launcher: L) -> Result<()>

where L: FnOnce(WithLaunchContext<NodeBuilder<Arc<DatabaseEnv>, C::ChainSpec>>, Ext) -> Fut, Fut: Future<Output = Result<()>>,

Launches the node

This transforms the node command into a node config and launches the node using the given closure.

Trait Implementations

impl<C: ChainSpecParser, Ext: Args + Debug> Args for NodeCommand<C, Ext>

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl<C: ChainSpecParser, Ext: Args + Debug> CommandFactory for NodeCommand<C, Ext>

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl<C: Debug + ChainSpecParser, Ext: Debug + Args + Debug> Debug for NodeCommand<C, Ext>

where C::ChainSpec: Debug,

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

Formats the value using the given formatter.

impl<C: ChainSpecParser, Ext: Args + Debug> FromArgMatches for NodeCommand<C, Ext>

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl<C: ChainSpecParser, Ext: Args + Debug> Parser for NodeCommand<C, Ext>

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.