Enum Account

pub enum Account {
    New {
        seed: Option<u64>,
        write: bool,
        discreet: bool,
        network: NetworkName,
        endpoint: String,
    },
    Import {
        private_key: Option<String>,
        write: bool,
        discreet: bool,
        network: NetworkName,
        endpoint: String,
    },
    Sign {
        private_key: Option<String>,
        private_key_file: Option<String>,
        message: String,
        raw: bool,
        network: NetworkName,
    },
    Verify {
        address: String,
        signature: String,
        message: String,
        raw: bool,
        network: NetworkName,
    },
    Decrypt {
        key: Option<String>,
        key_file: Option<String>,
        ciphertext: String,
        network: NetworkName,
    },
}

Commands to manage Aleo accounts.

Variants

New

Generates a new Aleo account

Fields

seed: Option<u64>

Seed the RNG with a numeric value.

write: bool

Write the private key to the .env file in the current directory.

discreet: bool

Print sensitive information (such as private key) discreetly to an alternate screen

network: NetworkName

endpoint: String

Import

Derive an Aleo account from a private key.

Fields

private_key: Option<String>

Private key plaintext

write: bool

Write the private key to the .env file in the current directory.

discreet: bool

Print sensitive information (such as private key) discreetly to an alternate screen

network: NetworkName

endpoint: String

Sign

Sign a message using your Aleo private key.

Fields

private_key: Option<String>

Specify the account private key

private_key_file: Option<String>

Specify the path to a file containing the account private key

message: String

Message (Aleo value) to sign

raw: bool

When enabled, parses the message as bytes instead of Aleo literals

network: NetworkName

Verify

Verify a message from an Aleo address.

Fields

address: String

Address to use for verification

signature: String

Signature to verify

message: String

Message (Aleo value) to verify the signature against

raw: bool

When enabled, parses the message as bytes instead of Aleo literals

network: NetworkName

Decrypt

Decrupt record ciphertext using your Aleo private key or view key.

Fields

key: Option<String>

Specify the account key

key_file: Option<String>

Specify the path to a file containing the account private key

ciphertext: String

The ciphertext to decrypt

network: NetworkName

Trait Implementations

impl Command for Account

type Input = ()

If the current command requires running another command beforehand and needs its output result, this is where the result type is defined. Example: type Input: ::Out

type Output = ()

Defines the output of this command, which may be used as Input for another command. If this command is not used as a prelude for another command, this field may be left empty.

fn prelude(&self, _: Context) -> Result<Self::Input>

where Self: Sized,

Runs the prelude and returns the Input of the current command.

fn apply(self, ctx: Context, _: Self::Input) -> Result<Self::Output>

where Self: Sized,

Runs the main operation of this command. This function is run within context of ‘execute’ function, which sets logging and timers.

fn log_span(&self) -> Span

Adds a span to the logger via tracing::span. Because of the specifics of the macro implementation, it is not possible to set the span name with a non-literal i.e. a dynamic variable even if this variable is a &’static str.

fn execute(self, context: Context) -> Result<Self::Output>

where Self: Sized,

A wrapper around the apply method. This function sets up tracing, timing, and the context.

fn try_execute(self, context: Context) -> Result<()>

where Self: Sized,

Executes command but empty the result. Comes in handy where there’s a need to make match arms compatible while keeping implementation-specific output possible. Errors however are all of the type Error

impl CommandFactory for Account

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 Account

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

Formats the value using the given formatter.

impl FromArgMatches for Account

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 Account

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 Account

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