Mintlayer Wallet CLI Guide
This page lists all commands available in the interactive wallet-cli REPL. Type help inside the wallet to see the list at any time, or help <command> for details on a specific command.
Commands are grouped by function. Commands marked with (cold) are available without a node connection (using --cold-wallet).
Table of Contents
- Wallet Management
- Accounts
- Addresses
- Standalone Addresses
- Staking and Pools
- Delegations
- Tokens and NFTs
- Orders
- Transactions
- HTLC
- Challenge Signing
- Node
- REPL and Miscellaneous
Wallet Management
| Command | Description |
|---|---|
| wallet-create | (cold) Create a new wallet. This will create a new file without scanning the blockchain. |
| wallet-recover | (cold) Recover a wallet. This will create a new wallet file and scan the blockchain for associated transactions. |
| wallet-open | (cold) Open an existing wallet file. |
| wallet-close | (cold) Close the currently opened wallet file. |
| wallet-info | (cold) Obtain certain information about the wallet, such as the number of accounts and their names. |
| wallet-encrypt-private-keys | (cold) Encrypts the private keys with a new password, expects the wallet to be unlocked. |
| wallet-disable-private-keys-encryption | (cold) Completely and totally remove any existing encryption, expects the wallet to be unlocked. Warning: After this, your wallet file will be USABLE BY ANYONE without a password. |
| wallet-unlock-private-keys | (cold) Unlocks the private keys for usage. |
| wallet-lock-private-keys | (cold) Locks the private keys so they can't be used until they are unlocked again. |
| wallet-show-seed-phrase | (cold) Show the seed phrase for the loaded wallet if it has been stored. |
| wallet-purge-seed-phrase | (cold) Delete the seed phrase from the loaded wallet's database, if it has been stored. |
| wallet-set-lookahead-size | (cold) Set the lookahead size for key generation. |
| wallet-rescan | Rescan the blockchain and re-detect all operations related to the selected account in this wallet. |
| wallet-sync | Force the wallet to scan the remaining blocks from node until the tip is reached. |
Accounts
| Command | Description |
|---|---|
| account-create | Creates a new account with an optional name. |
| account-rename | Renames the selected account with an optional name. If the name is not specified, it will remove any existing name for the account. |
| account-select | Switch to a given wallet account. |
| account-balance | Get the total balance in the selected account in this wallet. See available options to include more categories, like locked coins. |
| account-utxos | Lists all the utxos owned by this account. |
| account-extended-public-key-as-hex | (cold) Shows the account's extended public key. |
| account-sign-raw-transaction | (cold) Signs transaction inputs that are not yet signed. |
Addresses
| Command | Description |
|---|---|
| address-new | (cold) Generate a new unused address. |
| address-show | (cold) Show receive-addresses with their usage state. |
| address-qrcode | (cold) Creates a QR code of the provided address. |
| address-reveal-public-key-as-hex | (cold) Reveal the public key behind the specified "public key hash" address as a hex encoded string. |
| address-reveal-public-key-as-address | (cold) Reveal the public key behind the specified "public key hash" address in address encoding. |
| address-send | Send a given coin amount to a given address. The wallet will automatically calculate the required fees. |
| address-sweep-spendable | Sweep all spendable coins or tokens from the specified (or all) addresses to the given destination address. |
| address-deposit-data | Store data on the blockchain. |
Standalone Addresses
Standalone addresses are watch-only or independently-managed addresses added to the wallet without deriving them from the wallet's seed.
| Command | Description |
|---|---|
| standalone-address-show | (cold) Show added standalone addresses with their labels. |
| standalone-address-details | (cold) Show standalone address details. |
| standalone-address-label-rename | (cold) Add, rename or delete a label to an already added standalone address. |
| standalone-add-watch-only-address | (cold) Add a new standalone watch-only address not derived from the selected account's key chain. |
| standalone-add-private-key-from-hex | (cold) Add a new standalone private key not derived from the selected account's key chain. |
| standalone-add-multisig | (cold) Add a new standalone multi-signature address. |
| standalone-multisig-utxos | Lists all the utxos owned by multisig addresses watched by this account. |
Staking and Pools
A minimum pledge of 40,000 TML is required to create a staking pool.
| Command | Description |
|---|---|
| staking-start | Start staking, assuming there are staking pools in the selected account in this wallet. |
| staking-stop | Stop staking, assuming there are staking pools staking currently in the selected account in this wallet. |
| staking-status | Show the staking status for the currently selected account in this wallet. |
| staking-pool-balance | Obtain the balance of a staking pool. |
| staking-list-pools | List ids of pools that are controlled by the selected account in this wallet. |
| staking-list-owned-pools-for-decommission | List pools that can be decommissioned by the selected account in this wallet. |
| staking-list-created-block-ids | List the blocks created by the selected account in this wallet through staking/mining/etc. |
| staking-create-pool | Create a staking pool. The pool will be capable of creating blocks and gaining rewards, as well as taking delegations from other users. |
| staking-decommission-pool | Decommission a staking pool, given its id. This assumes that the decommission key is owned by the selected account in this wallet. |
| staking-decommission-pool-request | Create a request to decommission a pool. This assumes that the decommission key is owned by another wallet. |
| staking-new-vrf-public-key | (cold) Issue a new staking VRF (Verifiable Random Function) key for this account. |
| staking-show-vrf-public-keys | (cold) Show the issued staking VRF (Verifiable Random Function) keys for this account. |
| staking-show-legacy-vrf-key | (cold) Shows the legacy VRF key that uses an abandoned derivation mechanism. |
| staking-sweep-delegation | Sweep all the coins from a delegation to a given address. The wallet will automatically calculate the required fees. |
Delegations
| Command | Description |
|---|---|
| delegation-create | Create a delegation to a given pool id and the owner address/destination. |
| delegation-list-ids | List delegation ids controlled by the selected account in this wallet, with their balances. |
| delegation-stake | Send coins to a delegation id to be staked. |
| delegation-withdraw | Send coins from a delegation id (that you own) to stop staking them. Note that stopping the delegation requires a lock period. |
Tokens and NFTs
| Command | Description |
|---|---|
| token-issue-new | Issue a new fungible token. |
| token-nft-issue-new | Issue a new non-fungible token (NFT). |
| token-change-authority | Change the authority address of a token. |
| token-change-metadata-uri | Change the metadata URI of a token. |
| token-mint | Given a token that is already issued, mint new tokens and increase the circulating supply. |
| token-unmint | Unmint existing tokens and reduce the circulating supply. |
| token-lock-supply | Lock the circulating supply for the token. THIS IS IRREVERSIBLE. |
| token-freeze | Freeze the token, which forbids any operations with it (except for the optional unfreeze). |
| token-unfreeze | Unfreeze the token, making all operations available for it again. |
| token-send | Send the given token amount to the given address. |
Orders
| Command | Description |
|---|---|
| order-create | Create an order for exchanging one currency for another. |
| order-fill | Fill an order (partially or fully) with the asked currency. |
| order-freeze | Freeze an order to prevent further fills. |
| order-conclude | Conclude an order and withdraw accumulated funds. |
| order-list-own | List orders whose conclude key is owned by the selected account. |
| order-list-all-active | List all active (non-concluded, non-frozen) orders, with optional currency filters. |
Transactions
| Command | Description |
|---|---|
| utxo-spend | Spend a specific UTXO, moving its funds to a given address. |
| transaction-compose | Compose a new transaction from the specified outputs and selected utxos. |
| transaction-abandon | Abandon an unconfirmed transaction in the wallet database, and make the consumed inputs available to be used again. |
| transaction-list-pending | List the pending transactions that can be abandoned. |
| transaction-list-by-address | List transactions owned by this account that have already been included in a block, with an optional address filter. |
| transaction-get | Get a transaction from the wallet, if present. |
| transaction-get-raw | Get a transaction from the wallet, if present, as hex encoded raw transaction. |
| transaction-get-signed-raw | Get a signed transaction from the wallet, if present, as hex encoded raw transaction. |
| transaction-create-from-cold-input | Creates a transaction that spends from a specific address, and returns the change to the same address (unless one is specified), without signature. |
| transaction-inspect | Print the summary of a transaction. |
HTLC
| Command | Description |
|---|---|
| htlc-create-transaction | Create a transaction with an HTLC output (without broadcasting). |
| htlc-generate-secret | Generate a random HTLC secret. |
| htlc-calc-secret-hash | Compute the hash of an HTLC secret. |
Challenge Signing
| Command | Description |
|---|---|
| challenge-sign-plain | (cold) Signs a challenge with a private key corresponding to the provided address. |
| challenge-verify-plain | (cold) Verifies a signed challenge against an address. |
Node
These commands interact with the connected Mintlayer node.
Info and Control
| Command | Description |
|---|---|
| node-version | Obtain the node version. |
| node-shutdown | Shutdown the node. |
| node-enable-p2p-networking | Enable or disable p2p networking in the node. |
| node-chainstate-info | Returns the current node's chainstate information (block height and more). |
| node-best-block-id | Returns the current best block id. |
| node-best-block-height | Returns the current best block height. |
| node-best-block-timestamp | Returns the current best block timestamp. |
| node-block-id | Get the block id of the block at a given height. |
| node-get-block | Get a block by its id, represented as hex encoded bytes. |
| node-submit-block | Submit a block to be included in the chain. |
| node-submit-transaction | Submits a transaction to mempool, and if it is valid, broadcasts it to the network. |
| node-generate-block | Generate a block with the given transactions to the specified reward destination. |
Peers
| Command | Description |
|---|---|
| node-peer-count | Get the number of connected peers in the node. |
| node-list-connected-peers | List connected peers in the node. |
| node-list-reserved-peers | List reserved peers in the node. |
| node-add-reserved-peer | Add a reserved peer in the node. |
| node-remove-reserved-peer | Remove a reserved peer in the node. |
| node-connect-to-peer | Connect to a remote peer in the node. |
| node-disconnect-peer | Disconnect a remote peer in the node. |
| node-list-banned-peers | List banned peers in the node. |
| node-ban-peer-address | Ban an address in the node for the specified duration. |
| node-unban-peer-address | Unban an address in the node. |
| node-list-discouraged-peers | List discouraged peers in the node. |
| node-undiscourage-peer-address | Undiscourage an address in the node. |
REPL and Miscellaneous
| Command | Description |
|---|---|
| config-broadcast | Configure broadcasting to Mempool to yes or no. When set to no, transactions are returned as hex instead of being submitted automatically; use node-submit-transaction to broadcast manually. |
| version | (cold) Print the version of the wallet software and possibly the git commit hash, if found. |
| exit | (cold) Exit the wallet. |
| rpc-shutdown-and-exit | Shutdown the RPC interface or the remote wallet it is connected to and exit the wallet. |
| history-print | (cold) Print command history in the wallet for this execution. |
| history-clear | (cold) Clear command history for this execution. |
| screen-clear | (cold) Clear screen. |
help | (cold) Print this message or the help of the given subcommand(s). |