Wallet command line interface

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. 'recovery-phrase generate')

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

Available OPTIONS:
  -h | --help

Available COMMANDS:
  serve                    Serve an HTTP API that listens for commands/actions.
  recovery-phrase
    generate               Generate an English recovery phrase
  wallet
    list                   List all known wallets
    create
      from-recovery-phrase Create a new wallet using a recovery-phrase
    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.
    import                 Import a random address generated elsewhere.
  network
    information            View network information
    parameters             View network parameters
    clock                  View NTP offset
  key
    from-recovery-phrase   Convert a recovery phrase to an extended private key
    child                  Derive child keys from a parent public or private key
    public                 Get the public counterpart of 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.
  --mainnet                Use Cardano mainnet protocol
  --testnet FILE           Path to the byron genesis data in JSON format.
  --staging FILE           Path to the byron genesis data in JSON format.
  --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 on mainnet

Build cardano-node with mainnet configuration:

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

Start cardano-node for mainnet. This will create a directory called ./state-node-mainnet.
```
./mainnet-node-local
```

Start cardano-wallet (in another terminal).

cardano-wallet serve \
    --mainnet \
    --node-socket state-node-mainnet/node.socket \
    --database ./wallets-mainnet

example on testnet

Note that for testnets, a byron genesis file is required, even though the network is in the shelley era. This is because the chain is synced from the beginning of the first era.

Download byronGenesis for testnet from Cardano Configurations.

Build cardano-node with testnet configuration:

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

Start cardano-node for testnet. This will create a directory called ./state-node-testnet.
```
./testnet-node-local
```

Start cardano-wallet (in another terminal).

cardano-wallet serve \
    --testnet testnet-byron-genesis.json \
    --node-socket state-node-testnet/node.socket \
    --database ./wallets-testnet

Wallet command line interface

Commands

serve

Invocation

example on mainnet

example on testnet

Logging options for serve

example

recovery-phrase generate

wallet list

wallet create from recovery-phrase

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

address import

network information

network parameters

network clock

key from-recovery-phrase

key child

key public

key inspect

version

Clone this wiki locally