Module options

Source

Structsยง

BuildOptions
Compiler Options wrapper for Build command. Also used by other commands which require Build command output as their input.
EnvOptions
Overrides for the .env file.
ExtraOptions
Additional options that are common across a number of commands.
FeeOptions
The fee options for the transactions.
TransactionAction
What to do with a transaction produced by the CLI.

Functionsยง

check_consensus_version_mismatch
A helper function to check for a consensus version mismatch against the network.
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_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.
number_to_consensus_version
parse_amount ๐Ÿ”’
parse_fee_options
parse_record ๐Ÿ”’
Parses the record string. If the string is a ciphertext, then attempt to decrypt it. Lifted from snarkOS.
parse_record_string ๐Ÿ”’
validate_consensus_heights
Validates a vector of heights as consensus heights.