Enum RootCommand

pub enum RootCommand {
    Start {
        home: Option<PathBuf>,
        abci_bind: SocketAddr,
        grpc_bind: Option<SocketAddr>,
        grpc_auto_https: Option<String>,
        acme_staging: bool,
        metrics_bind: SocketAddr,
        cometbft_addr: Url,
        enable_expensive_rpc: bool,
    },
    Network {
        network_dir: Option<PathBuf>,
        net_cmd: NetworkCommand,
    },
    Export {
        home: PathBuf,
        export_directory: PathBuf,
        export_archive: Option<PathBuf>,
        prune: bool,
    },
    Migrate {
        home: Option<PathBuf>,
        comet_home: Option<PathBuf>,
        force: bool,
        ready_to_start: bool,
    },
}

Variants

Start

Starts the Penumbra daemon.

Fields

home: Option<PathBuf>

The path used to store all pd-related data and configuration. If unset, defaults to ~/.penumbra/network_data/node0/pd.

abci_bind: SocketAddr

Bind the ABCI server to this socket.

The ABCI server is used by Tendermint to drive the application state.

grpc_bind: Option<SocketAddr>

Bind the gRPC server to this socket.

The gRPC server supports both grpc (HTTP/2) and grpc-web (HTTP/1.1) clients.

If grpc_auto_https is set, this defaults to 0.0.0.0:443 and uses HTTPS.

If grpc_auto_https is not set, this defaults to 127.0.0.1:8080 without HTTPS.

grpc_auto_https: Option<String>

If set, serve gRPC using auto-managed HTTPS with this domain name.

NOTE: This option automatically provisions TLS certificates from Let’s Encrypt and caches them in the home directory. The production LE CA has rate limits, so be careful using this option with pd network unsafe-reset-all, which will delete the certificates and force re-issuance, possibly hitting the rate limit. See the --acme-staging option.

acme_staging: bool

Enable use of the LetsEncrypt ACME staging API (https://letsencrypt.org/docs/staging-environment/), which is more forgiving of ratelimits. Set this option to true if you’re trying out the --grpc-auto-https option for the first time, to validate your configuration, before subjecting yourself to production ratelimits. This option has no effect if --grpc-auto-https is not set.

metrics_bind: SocketAddr

Bind the metrics endpoint to this socket.

cometbft_addr: Url

The JSON-RPC address of the CometBFT node driving this pd instance.

This is used to proxy requests from the gRPC server to CometBFT, so clients only need to connect to one endpoint and don’t need to worry about the peculiarities of CometBFT’s JSON-RPC encoding format.

enable_expensive_rpc: bool

Enable expensive RPCs, currently a no-op.

Network

Generate, join, or reset a network.

Fields

network_dir: Option<PathBuf>

Path to directory to store output in. Must not exist. Defaults to ~/.penumbra/network_data“.

net_cmd: NetworkCommand

Export

Export the storage state the full node.

Fields

home: PathBuf

The home directory of the full node.

export_directory: PathBuf

The directory where the exported node state will be written.

export_archive: Option<PathBuf>

An optional filepath for a compressed archive containing the exported node state, e.g. ~/pd-backup.tar.gz.

prune: bool

Whether to prune the JMT tree.

Migrate

Run a migration before resuming post-upgrade.

Fields

home: Option<PathBuf>

The home directory of the full node.

Migration is performed in-place on the home directory.

comet_home: Option<PathBuf>

If set, also migrate the CometBFT state located in this home directory. If both --home and --comet-home are unset, will attempt to migrate CometBFT state alongside the auto-located pd state.

force: bool

If set, force a migration to occur even if the chain is not halted. Will not override a detected mismatch in state versions.

ready_to_start: bool

If set, edit local state to permit the node to start, despite a pre-existing halt order, e.g. via governance. This option can be useful for relayer operators, to run a temporary archive node across upgrade boundaries.

Trait Implementations

impl Debug for RootCommand

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

Formats the value using the given formatter.

impl FromArgMatches for RootCommand

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for RootCommand

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

Append to [Command] so it can instantiate Self.

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

Append to [Command] so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand