Enum WalletSubcommands

pub enum WalletSubcommands {
    New {
        path: Option<String>,
        account_name: Option<String>,
        password: bool,
        unsafe_password: Option<String>,
        number: u32,
    },
    NewMnemonic {
        words: usize,
        accounts: u8,
        entropy: Option<String>,
    },
    Vanity(VanityArgs),
    Address {
        private_key_override: Option<String>,
        wallet: WalletOpts,
    },
    Sign {
        message: String,
        data: bool,
        from_file: bool,
        no_hash: bool,
        wallet: WalletOpts,
    },
    SignAuth {
        address: Address,
        rpc: RpcOpts,
        nonce: Option<u64>,
        chain: Option<Chain>,
        wallet: WalletOpts,
    },
    Verify {
        message: String,
        signature: PrimitiveSignature,
        address: Address,
    },
    Import {
        account_name: String,
        keystore_dir: Option<String>,
        unsafe_password: Option<String>,
        raw_wallet_options: RawWalletOpts,
    },
    List(ListArgs),
    Remove {
        name: String,
        dir: Option<String>,
        unsafe_password: Option<String>,
    },
    PrivateKey {
        mnemonic_override: Option<String>,
        mnemonic_index_or_derivation_path_override: Option<String>,
        wallet: WalletOpts,
    },
    PublicKey {
        private_key_override: Option<String>,
        wallet: WalletOpts,
    },
    DecryptKeystore {
        account_name: String,
        keystore_dir: Option<String>,
        unsafe_password: Option<String>,
    },
    ChangePassword {
        account_name: String,
        keystore_dir: Option<String>,
        unsafe_password: Option<String>,
        unsafe_new_password: Option<String>,
    },
}

CLI arguments for cast wallet.

Variants

New

Create a new random keypair.

Fields

path: Option<String>

If provided, then keypair will be written to an encrypted JSON keystore.

account_name: Option<String>

Account name for the keystore file. If provided, the keystore file will be named using this account name.

password: bool

Triggers a hidden password prompt for the JSON keystore.

Deprecated: prompting for a hidden password is now the default.

unsafe_password: Option<String>

Password for the JSON keystore in cleartext.

This is UNSAFE to use and we recommend using the –password.

number: u32

Number of wallets to generate.

NewMnemonic

Generates a random BIP39 mnemonic phrase

Fields

words: usize

Number of words for the mnemonic

accounts: u8

Number of accounts to display

entropy: Option<String>

Entropy to use for the mnemonic

Vanity(VanityArgs)

Generate a vanity address.

Address

Convert a private key to an address.

Fields

private_key_override: Option<String>

If provided, the address will be derived from the specified private key.

wallet: WalletOpts

Sign

Sign a message or typed data.

Fields

message: String

The message, typed data, or hash to sign.

Messages starting with 0x are expected to be hex encoded, which get decoded before being signed.

The message will be prefixed with the Ethereum Signed Message header and hashed before signing, unless --no-hash is provided.

Typed data can be provided as a json string or a file name. Use –data flag to denote the message is a string of typed data. Use –data –from-file to denote the message is a file name containing typed data. The data will be combined and hashed using the EIP712 specification before signing. The data should be formatted as JSON.

data: bool

Treat the message as JSON typed data.

from_file: bool

Treat the message as a file containing JSON typed data. Requires --data.

no_hash: bool

Treat the message as a raw 32-byte hash and sign it directly without hashing it again.

wallet: WalletOpts

SignAuth

EIP-7702 sign authorization.

Fields

address: Address

Address to sign authorization for.

rpc: RpcOpts

nonce: Option<u64>

chain: Option<Chain>

wallet: WalletOpts

Verify

Verify the signature of a message.

Fields

message: String

The original message.

signature: PrimitiveSignature

The signature to verify.

address: Address

The address of the message signer.

Import

Import a private key into an encrypted keystore.

Fields

account_name: String

The name for the account in the keystore.

keystore_dir: Option<String>

If provided, keystore will be saved here instead of the default keystores directory (~/.foundry/keystores)

unsafe_password: Option<String>

Password for the JSON keystore in cleartext This is unsafe, we recommend using the default hidden password prompt

raw_wallet_options: RawWalletOpts

List(ListArgs)

List all the accounts in the keystore default directory

Remove

Remove a wallet from the keystore.

This command requires the wallet alias and will prompt for a password to ensure that only an authorized user can remove the wallet.

Fields

name: String

The alias (or name) of the wallet to remove.

dir: Option<String>

Optionally provide the keystore directory if not provided. default directory will be used (~/.foundry/keystores).

unsafe_password: Option<String>

Password for the JSON keystore in cleartext This is unsafe, we recommend using the default hidden password prompt

PrivateKey

Derives private key from mnemonic

Fields

mnemonic_override: Option<String>

If provided, the private key will be derived from the specified menomonic phrase.

mnemonic_index_or_derivation_path_override: Option<String>

If provided, the private key will be derived using the specified mnemonic index (if integer) or derivation path.

wallet: WalletOpts

PublicKey

Get the public key for the given private key.

Fields

private_key_override: Option<String>

If provided, the public key will be derived from the specified private key.

wallet: WalletOpts

DecryptKeystore

Decrypt a keystore file to get the private key

Fields

account_name: String

The name for the account in the keystore.

keystore_dir: Option<String>

If not provided, keystore will try to be located at the default keystores directory (~/.foundry/keystores)

unsafe_password: Option<String>

Password for the JSON keystore in cleartext This is unsafe, we recommend using the default hidden password prompt

ChangePassword

Change the password of a keystore file

Fields

account_name: String

The name for the account in the keystore.

keystore_dir: Option<String>

If not provided, keystore will try to be located at the default keystores directory (~/.foundry/keystores)

unsafe_password: Option<String>

Current password for the JSON keystore in cleartext This is unsafe, we recommend using the default hidden password prompt

unsafe_new_password: Option<String>

New password for the JSON keystore in cleartext This is unsafe, we recommend using the default hidden password prompt

Implementations

impl WalletSubcommands

pub async fn run(self) -> Result<()>

fn recover_address_from_message( message: &str, signature: &Signature, ) -> Result<Address>

Recovers an address from the specified message and signature

fn hex_str_to_bytes(s: &str) -> Result<Vec<u8>>

Trait Implementations

impl CommandFactory for WalletSubcommands

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 Debug for WalletSubcommands

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

Formats the value using the given formatter.

impl FromArgMatches for WalletSubcommands

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 Parser for WalletSubcommands

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.

impl Subcommand for WalletSubcommands

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

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 384 bytes

Size for each variant:

• New: 88 bytes
• NewMnemonic: 48 bytes
• Vanity: 96 bytes
• Address: 264 bytes
• Sign: 272 bytes
• SignAuth: 384 bytes
• Verify: 128 bytes
• Import: 184 bytes
• List: 56 bytes
• Remove: 80 bytes
• PrivateKey: 288 bytes
• PublicKey: 264 bytes
• DecryptKeystore: 80 bytes
• ChangePassword: 104 bytes