Wallet Command Line Interface (cardano wallet byron)

The CLI is a proxy to the wallet server, which is required for most commands. Commands are turned into corresponding API calls, and submitted to an up-and-running server. Some commands do not require an active server and can be run "offline". (e.g. 'mnemonic generate')

Usage: cardano-wallet-byron COMMAND
  Cardano Wallet Command-Line Interface (CLI)

Available OPTIONS:
  -h | --help

Available COMMANDS:
  serve                 Serve an HTTP API that listens for commands/actions.
  mnemonic
    generate            Generate BIP-39 mnemonic words
  wallet
    list                List all known wallets
    create
      from-mnemonic     Create a new wallet using a mnemonic
    get                 Fetch a particular wallet
    utxo                Get a wallet's UTxO distribution
    update
      passphrase        Update a wallet's master passphrase
      name              Update a wallet's name
    delete              Forget a wallet and its metadata
  transaction
    create              Create a transaction from a known wallet
    fees                Estimate fees for a transaction
    list                List the transactions associated with a wallet
    submit              Submit an externally-signed transaction
    forget              Forget a pending transaction with specified id
  address
    list                List all known addresses of a wallet
    create              Create a new random address. Only available for random wallets.
                        The address index is optional, give none to let the wallet generate a random one.
  network
    information         View network information
    parameters          View network parameters
    clock               View NTP offset
  key
    root                Extract root extended private key from a mnemonic sentence.
    child               Derive child keys.
    public              Extract public key from a private key.
    inspect             Show information about a key.
  version               Show the program's current version

ℹ️ The CLI commands for wallet, transaction and address only output valid JSON on stdout. So you may redirect the output to a file with > or pipe it into utility softwares like jq!

💝 For bash/zsh auto-completion, put the following script in your /etc/bash_completion.d:

cardano-wallet.sh

_cardano-wallet()
{
   local CMDLINE
   local IFS=$'\n'
   CMDLINE=(--bash-completion-index $COMP_CWORD)

   for arg in ${COMP_WORDS[@]}; do
       CMDLINE=(${CMDLINE[@]} --bash-completion-word $arg)
   done

   COMPREPLY=( $(cardano-wallet "${CMDLINE[@]}") )
}

complete -o filenames -F _cardano-wallet cardano-wallet

Commands

serve

Serve API that listens for commands/actions. Before launching user should start cardano-node.

Invocation

cardano-wallet serve

  --help-tracing           Show help for tracing options
  --listen-address HOST    Specification of which host to the bind API server
                           to. Can be an IPv[46] address, hostname, or
                           '*'. (default: 127.0.0.1)
  --random-port            serve wallet API on any available port (conflicts
                           with --port)
  --port INT               port used for serving the wallet API. (default: 8090)
  --tls-ca-cert FILE       A x.509 Certificate Authority (CA) certificate.
  --tls-sv-cert FILE       A x.509 Server (SV) certificate.
  --tls-sv-key FILE        The RSA Server key which signed the x.509 server
                           certificate.
  --node-socket FILE       Path to the node's domain socket.
  --testnet FILE           Path to the genesis .json file.
  --database DIR           use this directory for storing wallets. Run in-memory
                           otherwise.
  --sync-tolerance DURATION
                           time duration within which we consider being synced
                           with the network. Expressed in seconds with a
                           trailing 's'. (default: 300s)
  --shutdown-handler       Enable the clean shutdown handler (exits when stdin
                           is closed)
  --log-level SEVERITY     Global minimum severity for a message to be logged.
                           Individual tracers severities still need to be
                           configured independently. Defaults to "DEBUG".
  --trace-NAME SEVERITY    Individual component severity for 'NAME'. See
                               --help-tracing for details and available tracers.

example

Start cardano-node:

git clone https://github.com/input-output-hk/cardano-node.git
cd cardano-node
nix-build -A scripts.mainnet.node -o mainnet-node-local && ./mainnet-node-local

Serve cardano-wallet-byron:

cardano-wallet serve --node-socket ~/cardano-node/state-node-mainnet/node.socket --mainnet --database /tmp/mainnet

Wallet Command Line Interface (cardano wallet byron)

Commands

serve

Invocation

example

Logging options for serve

example

mnemonic generate

wallet list

wallet create from mnemonic

wallet get

wallet utxo

wallet update name

wallet update passphrase

wallet delete

transaction create

transaction fees

transaction list

transaction submit

transaction forget

address list

address create

network information

network parameters

network clock

key root

key child

key public

key inspect

version

Clone this wiki locally