Command-Line Help for snarkos-aot

This document contains the help content for the snarkos-aot command-line program.

Command Overview:

snarkos-aot

The different AOT commands

Usage: snarkos-aot [OPTIONS] <COMMAND>

Subcommands:
  • genesis — This command helps generate a custom genesis block given an initial private key, seed, and committee size
  • accounts — Given a seed and a count, generate a number of accounts
  • ledger — Commands for interacting with the ledger
  • auth — A command to help generate various different types of authorizations and execute them
  • program — A command to help gather information about a program, including its cost and imports
  • man — For generating cli manpages. Only with the mangen feature enabled
  • md — For generating cli markdown. Only with the clipages feature enabled
  • run — A wrapper around the snarkos node run commands that provide additional logging and configurability
Options:

  • --enable-profiling

  • --log <LOG> — The path to the log file

  • --verbosity <VERBOSITY> — The verbosity level of the logs

    Default value: 4

  • --loki <LOKI> — The optional loki url to send logs to

snarkos-aot genesis

This command helps generate a custom genesis block given an initial private key, seed, and committee size

Usage: snarkos-aot genesis [OPTIONS]

Options:

  • -g, --genesis-key <GENESIS_KEY> — The private key to use when generating the genesis block. Generates one randomly if not passed

  • -o, --output <OUTPUT> — Where to write the genesis block to

    Default value: genesis.block

  • --committee-size <COMMITTEE_SIZE> — The committee size. Not used if --bonded-balances is set

    Default value: 4

  • --committee-output <COMMITTEE_OUTPUT> — A place to optionally write out the generated committee private keys JSON

  • --additional-accounts <ADDITIONAL_ACCOUNTS> — Additional number of accounts that aren't validators to add balances to

    Default value: 0

  • --additional-accounts-balance <additional-accounts-balance> — The balance to add to the number of accounts specified by additional-accounts

    Default value: 100000000

  • --additional-accounts-record-balance <ADDITIONAL_ACCOUNTS_RECORD_BALANCE> — If --additional-accounts is passed you can additionally add an amount to give them in a record

  • --additional-accounts-output <ADDITIONAL_ACCOUNTS_OUTPUT> — A place to write out the additionally generated accounts by --additional-accounts

  • --seed <SEED> — The seed to use when generating committee private keys and the genesis block. If unpassed, uses DEVELOPMENT_MODE_RNG_SEED (1234567890u64)

  • --bonded-balance <BONDED_BALANCE> — The bonded balance each bonded address receives. Not used if --bonded-balances is passed

    Default value: 10000000000000

  • --bonded-balances <BONDED_BALANCES> — An optional map from address to bonded balance. Overrides --bonded-balance and --committee-size

  • --bonded-withdrawal <BONDED_WITHDRAWAL> — An optional to specify withdrawal addresses for the genesis committee

  • --bonded-commission <BONDED_COMMISSION> — The bonded commission each bonded address uses. Not used if --bonded-commissions is passed. Defaults to 0. Must be 100 or less

    Default value: 0

  • --bonded-commissions <BONDED_COMMISSIONS> — An optional map from address to bonded commission. Overrides --bonded-commission. Defaults to 0. Must be 100 or less

  • --ledger <LEDGER> — Optionally initialize a ledger as well

snarkos-aot accounts

Given a seed and a count, generate a number of accounts

Usage: snarkos-aot accounts [OPTIONS] [COUNT]

Arguments:

  • <COUNT> — Number of accounts to generate

    Default value: 1

Options:
  • -v, --vanity <VANITY> — Vanity prefix for addresses
  • -o, --output <OUTPUT> — Where to write the output to
  • -s, --seed <seed> — The seed to use when generating private keys If unpassed or used with --vanity, uses a random seed

snarkos-aot ledger

Commands for interacting with the ledger

Usage: snarkos-aot ledger [OPTIONS] --ledger <LEDGER> <COMMAND>

Subcommands:
  • init — Used to initialize a new ledger given a genesis block
  • view — Used to view information about the ledger
  • rewind — Rewind the ledger to a specific checkpoint
  • replay — Replays blocks from a ledger to a specific height or amount to rollback to
  • execute — A command to execute an authorization
  • query — Receive inquiries on /<network>/latest/stateRoot
  • hash — Hash the ledger
  • checkpoint — A command to interact with checkpoints
Options:

  • --enable-profiling

  • -g, --genesis <GENESIS> — A path to the genesis block to initialize the ledger from

    Default value: ./genesis.block

  • -l, --ledger <LEDGER> — The ledger from which to view a block

    Default value: ./ledger

snarkos-aot ledger init

Used to initialize a new ledger given a genesis block

Usage: snarkos-aot ledger init

snarkos-aot ledger view

Used to view information about the ledger

Usage: snarkos-aot ledger view <COMMAND>

Subcommands:
  • top — View the top block of the ledger
  • block — View a specific block in the ledger
  • balance — View the balance of an address
  • records — View records associated with a private key

snarkos-aot ledger view top

View the top block of the ledger

Usage: snarkos-aot ledger view top

snarkos-aot ledger view block

View a specific block in the ledger

Usage: snarkos-aot ledger view block <BLOCK_HEIGHT>

Arguments:
  • <BLOCK_HEIGHT> — The height of the block to view

snarkos-aot ledger view balance

View the balance of an address

Usage: snarkos-aot ledger view balance <ADDRESS>

Arguments:
  • <ADDRESS> — The address to view the balance of

snarkos-aot ledger view records

View records associated with a private key

Usage: snarkos-aot ledger view records <PRIVATE_KEY>

Arguments:
  • <PRIVATE_KEY> — The private key to view records for

snarkos-aot ledger rewind

Rewind the ledger to a specific checkpoint

Usage: snarkos-aot ledger rewind <CHECKPOINT>

Arguments:
  • <CHECKPOINT> — The checkpoint to rewind to

snarkos-aot ledger replay

Replays blocks from a ledger to a specific height or amount to rollback to

Usage: snarkos-aot ledger replay [OPTIONS]

Options:

  • --height <HEIGHT> — The height to replay to

  • --amount <AMOUNT> — The amount of blocks to rollback to

  • --skip <SKIP> — How many blocks to skip when reading

    Default value: 1

  • -c, --checkpoint — When checkpoint is enabled, checkpoints

    Default value: false

snarkos-aot ledger execute

A command to execute an authorization

Usage: snarkos-aot ledger execute [OPTIONS] --query <QUERY> [JSON]

Arguments:

  • <JSON> — Authorization flags as json

    {"auth": Program Auth, "fee_auth": Fee Auth }

    {"deployment": Deployment, "owner": Prog Owner, "fee_auth": Fee Auth }

Options:

  • -e, --exec-mode <EXEC_MODE> — The execution mode: local(local ledgr) or remote(api to another node)

    Default value: local

    Possible values: local, remote

  • -q, --query <QUERY> — Query endpoint

  • -b, --broadcast — Whether to broadcast the transaction

    Default value: false

  • -a, --auth <AUTH> — Authorization for an execution of some kind

  • -f, --fee-auth <FEE_AUTH> — The optional fee authorization for said execution

  • -o, --owner <OWNER> — The owner of the program if deploying

  • -d, --deployment <DEPLOYMENT> — The deployment of the program if deploying

  • --seed <SEED> — The seed to use for the execution

snarkos-aot ledger query

Receive inquiries on /<network>/latest/stateRoot

Usage: snarkos-aot ledger query [OPTIONS]

Options:

  • --port <PORT> — Port to listen on for incoming messages

    Default value: 3030

  • --bind <BIND>

    Default value: 0.0.0.0

  • --readonly — When true, the POST /block endpoint will not be available

  • --record — Receive messages from /<network>/transaction/broadcast and record them to the output

  • -o, --output <OUTPUT> — Path to the directory containing the stored data

    Default value: transactions.json

snarkos-aot ledger hash

Hash the ledger

Usage: snarkos-aot ledger hash

snarkos-aot ledger checkpoint

A command to interact with checkpoints

Usage: snarkos-aot ledger checkpoint <COMMAND>

Subcommands:
  • create — Create a checkpoint for the given ledger
  • apply — Apply a checkpoint to the given ledger
  • view — View the available checkpoints
  • clean — Cleanup old checkpoints

snarkos-aot ledger checkpoint create

Create a checkpoint for the given ledger

Usage: snarkos-aot ledger checkpoint create

snarkos-aot ledger checkpoint apply

Apply a checkpoint to the given ledger

Usage: snarkos-aot ledger checkpoint apply [OPTIONS] <CHECKPOINT>

Arguments:
  • <CHECKPOINT> — Checkpoint file to apply
Options:

  • -c, --clean — When present, clean up old checkpoints that are no longer applicable after applying the checkpoint

    Default value: false

snarkos-aot ledger checkpoint view

View the available checkpoints

Usage: snarkos-aot ledger checkpoint view

snarkos-aot ledger checkpoint clean

Cleanup old checkpoints

Usage: snarkos-aot ledger checkpoint clean

snarkos-aot auth

A command to help generate various different types of authorizations and execute them

Usage: snarkos-aot auth <COMMAND>

Subcommands:
  • execute — A command to execute an authorization
  • program — Authorize a program execution
  • fee — Authorize the fee for a program execution
  • id — Given an authorization (and fee), return the transaction ID
  • cost — Estimate the cost of a program execution or deployment
  • deploy — Deploy a program to the network

snarkos-aot auth execute

A command to execute an authorization

Usage: snarkos-aot auth execute [OPTIONS] --query <QUERY> [JSON]

Arguments:

  • <JSON> — Authorization flags as json

    {"auth": Program Auth, "fee_auth": Fee Auth }

    {"deployment": Deployment, "owner": Prog Owner, "fee_auth": Fee Auth }

Options:

  • -e, --exec-mode <EXEC_MODE> — The execution mode: local(local ledgr) or remote(api to another node)

    Default value: local

    Possible values: local, remote

  • -q, --query <QUERY> — Query endpoint

  • -b, --broadcast — Whether to broadcast the transaction

    Default value: false

  • -a, --auth <AUTH> — Authorization for an execution of some kind

  • -f, --fee-auth <FEE_AUTH> — The optional fee authorization for said execution

  • -o, --owner <OWNER> — The owner of the program if deploying

  • -d, --deployment <DEPLOYMENT> — The deployment of the program if deploying

  • --seed <SEED> — The seed to use for the execution

snarkos-aot auth program

Authorize a program execution

Usage: snarkos-aot auth program [OPTIONS] <--private-key <PRIVATE_KEY>|--private-key-file <PRIVATE_KEY_FILE>> <LOCATOR> [INPUTS]...

Arguments:
  • <LOCATOR> — Program ID and function name (eg. credits.aleo/transfer_public)
  • <INPUTS> — Program inputs (eg. 1u64 5field)
Options:

  • --private-key <PRIVATE_KEY> — Specify the account private key of the node

  • --private-key-file <PRIVATE_KEY_FILE> — Specify the account private key of the node

  • --fee-private-key <FEE_PRIVATE_KEY> — Specify the account private key of the node

  • --fee-private-key-file <FEE_PRIVATE_KEY_FILE> — Specify the account private key of the node

  • --skip-fee — Prevent the fee from being included in the authorization

  • --priority-fee <PRIORITY_FEE> — The priority fee in microcredits

    Default value: 0

  • --record <RECORD> — The record for a private fee

  • -q, --query <QUERY> — Query to load the program with

  • --seed <SEED> — The seed to use for the authorization generation

  • --cost-v1 — Enable cost v1 for the transaction cost estimation (v2 by default)

    Default value: false

snarkos-aot auth fee

Authorize the fee for a program execution

Usage: snarkos-aot auth fee [OPTIONS] <--private-key <PRIVATE_KEY>|--private-key-file <PRIVATE_KEY_FILE>>

Options:

  • --private-key <PRIVATE_KEY> — Specify the account private key of the node

  • --private-key-file <PRIVATE_KEY_FILE> — Specify the account private key of the node

  • --priority-fee <PRIORITY_FEE> — The priority fee in microcredits

    Default value: 0

  • --record <RECORD> — The record for a private fee

  • --query <QUERY> — The query to use for the program execution cost lookup

  • -a, --auth <AUTH> — The Authorization for the program execution

  • -d, --deployment <DEPLOYMENT> — The Authorization for a deployment

  • -i, --id <ID> — The ID of the deployment or program execution

  • -c, --cost <COST> — Estimated cost of the deployment or program execution

  • --seed <SEED> — The seed to use for the authorization generation

  • --cost-v1 — Enable cost v1 for the transaction cost estimation (v2 by default)

    Default value: false

snarkos-aot auth id

Given an authorization (and fee), return the transaction ID

Usage: snarkos-aot auth id [OPTIONS] [JSON]

Arguments:

  • <JSON> — Authorization flags as json

    {"auth": Program Auth, "fee_auth": Fee Auth }

    {"deployment": Deployment, "owner": Prog Owner, "fee_auth": Fee Auth }

Options:
  • -a, --auth <AUTH> — Authorization for an execution of some kind
  • -f, --fee-auth <FEE_AUTH> — The optional fee authorization for said execution
  • -o, --owner <OWNER> — The owner of the program if deploying
  • -d, --deployment <DEPLOYMENT> — The deployment of the program if deploying

snarkos-aot auth cost

Estimate the cost of a program execution or deployment

Usage: snarkos-aot auth cost [OPTIONS] [JSON]

Arguments:

  • <JSON> — Authorization flags as json

    {"auth": Program Auth, "fee_auth": Fee Auth }

    {"deployment": Deployment, "owner": Prog Owner, "fee_auth": Fee Auth }

Options:

  • -q, --query <QUERY> — The query to use for the program

  • -a, --auth <AUTH> — Authorization for an execution of some kind

  • -f, --fee-auth <FEE_AUTH> — The optional fee authorization for said execution

  • -o, --owner <OWNER> — The owner of the program if deploying

  • -d, --deployment <DEPLOYMENT> — The deployment of the program if deploying

  • --cost-v1 — Enable cost v1 for the transaction cost estimation (v2 by default)

    Default value: false

snarkos-aot auth deploy

Deploy a program to the network

Usage: snarkos-aot auth deploy [OPTIONS] <--private-key <PRIVATE_KEY>|--private-key-file <PRIVATE_KEY_FILE>> <PROGRAM>

Arguments:
  • <PROGRAM> — The program to deploy. This can be a file or stdin
Options:

  • --private-key <PRIVATE_KEY> — Specify the account private key of the node

  • --private-key-file <PRIVATE_KEY_FILE> — Specify the account private key of the node

  • --fee-private-key <FEE_PRIVATE_KEY> — Specify the account private key of the node

  • --fee-private-key-file <FEE_PRIVATE_KEY_FILE> — Specify the account private key of the node

  • --skip-fee — Prevent the fee from being included in the authorization

  • --priority-fee <PRIORITY_FEE> — The priority fee in microcredits

    Default value: 0

  • --record <RECORD> — The record for a private fee

  • -q, --query <QUERY> — The query to use for the program

  • --seed <SEED> — The seed to use for the authorization generation

  • --cost-v1 — Enable cost v1 for the transaction cost estimation (v2 by default)

    Default value: false

snarkos-aot program

A command to help gather information about a program, including its cost and imports

Usage: snarkos-aot program <COMMAND>

Subcommands:
  • id — Get the ID of a given program
  • functions — List the functions and their inputs/outputs of a given program
  • imports — List the inputs of a given program
  • cost — Compute the cost to execute a function in a given program

snarkos-aot program id

Get the ID of a given program

Usage: snarkos-aot program id [OPTIONS] <PROGRAM>

Arguments:
  • <PROGRAM> — Path to .aleo program to get information about, or - for stdin
Options:
  • -j, --json — Output as JSON

snarkos-aot program functions

List the functions and their inputs/outputs of a given program

Usage: snarkos-aot program functions [OPTIONS] <PROGRAM>

Arguments:
  • <PROGRAM> — Path to .aleo program to get information about, or - for stdin
Options:
  • -j, --json — Output as JSON

snarkos-aot program imports

List the inputs of a given program

Usage: snarkos-aot program imports [OPTIONS] <PROGRAM>

Arguments:
  • <PROGRAM> — Path to .aleo program to get information about, or - for stdin
Options:
  • -j, --json — Output as JSON

snarkos-aot program cost

Compute the cost to execute a function in a given program

Usage: snarkos-aot program cost [OPTIONS] <PROGRAM> [FUNCTION] [INPUTS]...

Arguments:
  • <PROGRAM> — Program to estimate the cost of
  • <FUNCTION> — Program ID and function name (eg. credits.aleo/transfer_public). When not specified, the cost of deploying the program is estimated
  • <INPUTS> — Program inputs (eg. 1u64 5field)
Options:

  • -q, --query <QUERY> — Query to load the program with

  • --cost-v1 — Enable cost v1 for the transaction cost estimation (v2 by default)

    Default value: false

snarkos-aot man

For generating cli manpages. Only with the mangen feature enabled

Usage: snarkos-aot man [DIRECTORY]

Arguments:

  • <DIRECTORY> — Directory to write manpages to

    Default value: target/man/snops-cli

snarkos-aot md

For generating cli markdown. Only with the clipages feature enabled

Usage: snarkos-aot md [DIRECTORY]

Arguments:

  • <DIRECTORY> — Directory to write markdown to

    Default value: snops_book/user_guide/clis

snarkos-aot run

A wrapper around the snarkos node run commands that provide additional logging and configurability

Usage: snarkos-aot run [OPTIONS] --ledger <LEDGER> --type <type> <--private-key <PRIVATE_KEY>|--private-key-file <PRIVATE_KEY_FILE>>

Options:

  • -g, --genesis <GENESIS> — A path to the genesis block to initialize the ledger from

  • -l, --ledger <LEDGER> — The ledger from which to view a block

    Default value: ./ledger

  • -t, --type <type> — The type of node to run: validator, prover, or client

  • --private-key <PRIVATE_KEY> — Specify the account private key of the node

  • --private-key-file <PRIVATE_KEY_FILE> — Specify the account private key of the node

  • --bind <BIND_ADDR> — Specify the IP(v4 or v6) address to bind to

    Default value: 0.0.0.0

  • --node <NODE> — Specify the IP address and port for the node server

    Default value: 4130

  • --bft <BFT> — Specify the IP address and port for the BFT

    Default value: 5000

  • --rest <REST> — Specify the IP address and port for the REST server

    Default value: 3030

  • --metrics <METRICS> — Specify the port for the metrics server

    Default value: 9000

  • --peers <PEERS> — Specify the IP address and port of the peer(s) to connect to

  • --validators <VALIDATORS> — Specify the IP address and port of the validator(s) to connect to

  • --rest-rps <REST_RPS> — Specify the requests per second (RPS) rate limit per IP for the REST server

    Default value: 1000

  • --retention-policy <RETENTION_POLICY> — The retention policy for the checkpoint manager. i.e. how often to create checkpoints

  • --agent-rpc-port <AGENT_RPC_PORT> — When present, connects to an agent RPC server on the given port

This document was generated automatically by clap-markdown.