Module cli

Source

Modules§

check_transaction
cli 🔒
commands 🔒
context
helpers 🔒
logger
query
updater
upgrade

Structs§

BuildOptions
Compiler Options wrapper for Build command. Also used by other commands which require Build command output as their input.
CLI
CLI Arguments entry point - includes global parameters and subcommands
DependencySource
EnvOptions
Overrides for the .env file.
ExtraOptions
Additional options that are common across a number of commands.
FeeOptions
The fee options for the transactions.
LeoAdd
Add a new on-chain or local dependency to the current package.
LeoBuild
Compile and build program command.
LeoClean
Clean outputs folder command
LeoDebug
Debugs an Aleo program through the interpreter.
LeoDeploy
Deploys an Aleo program.
LeoDevnet
Launch a local devnet (validators + clients) using snarkOS.
LeoExecute
Build, Prove and Run Leo program with inputs
LeoNew
Create new Leo project
LeoQuery
Query live data from the Aleo network.
LeoRemove
Remove a dependency from the current package.
LeoRun
Run the Leo program with the given inputs, without generating a proof.
LeoTest
Test a leo program.
LeoUpdate
Update Leo to the latest version
LeoUpgrade
Upgrades an Aleo program.
TransactionAction
What to do with a transaction produced by the CLI.

Enums§

Account
Commands to manage Aleo accounts.

Traits§

Command
Base trait for the Leo CLI, see methods and their documentation for details.

Functions§

check_consensus_version_mismatch
A helper function to check for a consensus version mismatch against the network.
collect_aleo_paths
Collects paths to .aleo files that are external (non-local) dependencies.
collect_leo_paths
Collects paths to Leo source files for each program in the package.
confirm
Asks the user to confirm an action, with an optional --yes override.
confirm_fee
Asks the user to confirm a fee.
get_consensus_heights
Get the consensus heights for the current network. First check the CONSENSUS_VERSION_HEIGHTS environment variable. Otherwise, if is_devnet is true, then return the test consensus heights. Otherwise, return the consensus heights for the given network.
get_consensus_version
get_consensus_version_from_height
get_endpoint
Returns the endpoint to interact with the network. If the --endpoint options is not provided, it will default to the environment variable.
get_is_devnet
Returns whether the devnet flag is set. If the --devnet flag is not set, check if the environment variable is set, otherwise default to false.
get_latest_block_height
get_network
Returns the network name. If the --network options is not provided, it will default to the environment variable.
get_private_key
Returns the private key. If the --private-key options is not provided, it will default to the environment variable.
get_public_balance
A helper function to query the public balance of an address.
handle_broadcast
Determine if the transaction should be broadcast or displayed to user.
handle_error
load_latest_programs_from_network
Loads the latest edition of a program and all its imports from the network, using an iterative DFS.
number_to_consensus_version
parse_fee_options
parse_input
A helper function to parse an input string into a Value, handling record ciphertexts as well.
run_with_args
Run command with custom build arguments.
validate_consensus_heights
Validates a vector of heights as consensus heights.