Enum Commands 

pub enum Commands {
    Version,
    Config,
    Init {
        mnemonic: Option<String>,
        account_index: u32,
        ledger: bool,
    },
    Purge {
        force: bool,
    },
    StakeTable {
        l1_block_number: Option<BlockId>,
        compact: bool,
    },
    Account,
    RegisterValidator {
        signature_args: NodeSignatureArgs,
        commission: Commission,
        metadata_uri_args: MetadataUriArgs,
    },
    UpdateConsensusKeys {
        signature_args: NodeSignatureArgs,
    },
    DeregisterValidator {},
    UpdateCommission {
        new_commission: Commission,
    },
    UpdateMetadataUri {
        metadata_uri_args: MetadataUriArgs,
    },
    Approve {
        amount: U256,
    },
    Delegate {
        validator_address: Address,
        amount: U256,
    },
    Undelegate {
        validator_address: Address,
        amount: U256,
    },
    ClaimWithdrawal {
        validator_address: Address,
    },
    ClaimValidatorExit {
        validator_address: Address,
    },
    ClaimRewards,
    UnclaimedRewards {
        address: Option<Address>,
    },
    TokenBalance {
        address: Option<Address>,
    },
    TokenAllowance {
        owner: Option<Address>,
    },
    Transfer {
        to: Address,
        amount: U256,
    },
    StakeForDemo {
        num_validators: u16,
        num_delegators_per_validator: Option<u64>,
        delegation_config: DelegationConfig,
    },
    ExportNodeSignatures {
        address: Address,
        consensus_private_key: BLSPrivKey,
        state_private_key: StateSignKey,
        output_args: OutputArgs,
    },
}

Variants

Version

Display version information of the staking-cli.

Config

Display the current configuration

Init

Initialize the config file with deployment and wallet info.

Fields

mnemonic: Option<String>

The mnemonic to use when deriving the key.

account_index: u32

The mnemonic account index to use when deriving the key.

ledger: bool

The ledger account index to use when deriving the key.

Purge

Remove the config file.

Fields

force: bool

Don’t ask for confirmation.

StakeTable

Show the stake table in the Espresso stake table contract.

Fields

l1_block_number: Option<BlockId>

The block numberto use for the stake table.

Defaults to the latest block for convenience.

compact: bool

Abbreviate the very long BLS public keys.

Account

Print the signer account address.

RegisterValidator

Register to become a validator.

Fields

signature_args: NodeSignatureArgs

commission: Commission

The commission to charge delegators

metadata_uri_args: MetadataUriArgs

UpdateConsensusKeys

Update a validators Espresso consensus signing keys.

Fields

signature_args: NodeSignatureArgs

DeregisterValidator

Deregister a validator.

UpdateCommission

Update validator commission rate.

Fields

new_commission: Commission

The new commission rate to set

UpdateMetadataUri

Update validator metadata URL.

Fields

metadata_uri_args: MetadataUriArgs

Approve

Approve stake table contract to move tokens

Fields

amount: U256

Delegate

Delegate funds to a validator.

Fields

validator_address: Address

amount: U256

Undelegate

Initiate a withdrawal of delegated funds from a validator.

Fields

validator_address: Address

amount: U256

ClaimWithdrawal

Claim withdrawal after an undelegation.

Fields

validator_address: Address

ClaimValidatorExit

Claim withdrawal after validator exit.

Fields

validator_address: Address

ClaimRewards

Claim staking rewards.

UnclaimedRewards

Check unclaimed staking rewards.

Fields

address: Option<Address>

The address to check.

TokenBalance

Check ESP token balance.

Fields

address: Option<Address>

The address to check.

TokenAllowance

Check ESP token allowance of stake table contract.

Fields

owner: Option<Address>

The address to check.

Transfer

Transfer ESP tokens

Fields

to: Address

The address to transfer to.

amount: U256

The amount to transfer

StakeForDemo

Register the validators and delegates for the local demo.

Fields

num_validators: u16

The number of validators to register.

The default (5) works for the local native and docker demos.

num_delegators_per_validator: Option<u64>

The number of delegators to create per validator.

If not specified, a random number (2-5) of delegators is created per validator. Must be <= 100,000.

delegation_config: DelegationConfig

ExportNodeSignatures

Export validator node signatures for address validation.

Fields

address: Address

The Ethereum address to sign.

consensus_private_key: BLSPrivKey

The BLS private key for signing.

state_private_key: StateSignKey

The Schnorr private key for signing.

output_args: OutputArgs

Trait Implementations

impl Clone for Commands

fn clone(&self) -> Commands

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Commands

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

Formats the value using the given formatter.

impl Default for Commands

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for Commands

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 Commands

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

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

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

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

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand