Enum NetworkCommand

pub enum NetworkCommand {
    Generate {

        timeout_commit: Option<Timeout>,
        epoch_duration: Option<u64>,
        unbonding_delay: Option<u64>,
        active_validator_limit: Option<u64>,
        preserve_chain_id: bool,
        allocations_input_file: Option<PathBuf>,
        allocation_address: Option<Address>,
        validators_input_file: Option<PathBuf>,
        chain_id: Option<String>,
        proposal_voting_blocks: Option<u64>,
        gas_price_simple: Option<u64>,
        peer_address_template: Option<String>,
        external_addresses: Option<String>,
    
},
    Join {
        node: Url,
        archive_url: Option<Url>,
        moniker: Option<String>,
        external_address: Option<SocketAddr>,
        tendermint_rpc_bind: SocketAddr,
        tendermint_p2p_bind: SocketAddr,
        leave_archive: bool,
    },
    UnsafeResetAll {},
}

Variants

Generate

Generates a directory structure containing necessary files to create a new network config from genesis, based on input configuration.

Fields

timeout_commit: Option<Timeout>

The timeout_commit parameter (block interval) to configure Tendermint with.

epoch_duration: Option<u64>

Number of blocks per epoch.

unbonding_delay: Option<u64>

Number of blocks that must elapse before unbonding stake is released.

active_validator_limit: Option<u64>

Maximum number of validators in the consensus set.

preserve_chain_id: bool

Whether to preserve the chain ID (useful for public networks) or append a random suffix (useful for dev/testing).

allocations_input_file: Option<PathBuf>

Path to CSV file containing initial allocations [default: latest testnet].

allocation_address: Option<Address>

Penumbra wallet address to include in genesis allocations. Intended to make dev experience nicer on first run: generate a wallet, view its address, then generate a devnet with that address included in the base allocations.

validators_input_file: Option<PathBuf>

Path to JSON file containing initial validator configs [default: latest testnet].

chain_id: Option<String>

Testnet name [default: latest testnet].

proposal_voting_blocks: Option<u64>

The duration, in number of blocks, that a governance proposal can be voted on.

gas_price_simple: Option<u64>

The fixed gas price for all transactions on the network. Described as “simple” because the single value will be reused for all gas price types: block space, compact block space, verification, and execution. The numeric value is one-thousandths of the base unit of the fee token, so --gas-price-simple=1000 means all resources will have a cost of 1upenumbra.

peer_address_template: Option<String>

Base hostname for a validator’s p2p service. If multiple validators exist in the genesis, e.g. via --validators-input-file, then numeric suffixes are automatically added, e.g. “-0”, “-1”, etc. Helpful for when you know the validator DNS names ahead of time, e.g. in Kubernetes service addresses. These option is most useful to provide peering on a private network setup. If you plan to expose the validator P2P services to the internet, see the --external-addresses option.

external_addresses: Option<String>

Public addresses and ports for the Tendermint P2P services of the genesis validator. Accepts comma-separated values, to support multiple validators. If --validators-input-file is used to increase the number of validators, and the --external-addresses flag is set, then the number of external addresses must equal the number of validators. See the --peer-address-template flag if you don’t plan to expose the network to public peers.

Join

Like network generate, but joins the network to which the specified node belongs. Requires a URL for the CometBFT RPC for the bootstrap node.

Fields

node: Url

URL of the remote CometBFT RPC endpoint for bootstrapping connection.

archive_url: Option<Url>

Optional URL of archived node state in .tar.gz format. The archive will be downloaded and extracted locally, allowing the node to join a network at a block height higher than 0. Supports loading the archive from a local file, if set with file scheme explicitly, e.g. file:///path/to/archive.tar.gz.

moniker: Option<String>

Human-readable name to identify node on network

external_address: Option<SocketAddr>

Public URL to advertise for this node’s Tendermint P2P service. Setting this option will instruct other nodes on the network to connect to yours. Must be in the form of a socket, e.g. “1.2.3.4:26656”.

tendermint_rpc_bind: SocketAddr

When generating Tendermint config, use this socket to bind the Tendermint RPC service.

tendermint_p2p_bind: SocketAddr

When generating Tendermint config, use this socket to bind the Tendermint P2P service.

leave_archive: bool

Leave the downloaded archive file on disk after extraction.

UnsafeResetAll

Reset all pd network state. This is a destructive action!

Trait Implementations

impl Debug for NetworkCommand

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

Formats the value using the given formatter.

impl FromArgMatches for NetworkCommand

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 NetworkCommand

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