./xcash-wallet-cli [options] [command]
./xcash-wallet-cli --restore-deterministic-wallet
./xcashd
./xcash-wallet-cli --generate-new-wallet XCashExampleWallet
--help
--version
xcash-wallet-cli
version to stdout. Example: X-CASH '' (v1.5.0-unknown)
(default)
--stagenet
--stagenet
as well.--testnet
--testnet
as well.--log-file
--log-level <arg>
0-4
with 0
being minimal logging and 4
being full tracing. Defaults to 0
. These are general presets and do not directly map to severity levels. For example, even with minimal 0
, you may see some most important INFO
entries.--max-log-file-size
-YYYY-MM-DD-HH-MM-SS
. In production deployments, you would probably prefer to use established solutions like logrotate instead. In that case, set --max-log-file-size 0
to prevent x-cash from managing the log files.--max-log-files
xcashd
:--daemon-address
xcashd
instance at <host>:<port>
. Example: ./xcash-wallet-cli --daemon-address xcash-stagenet.exan.tech:38081 --stagenet
--daemon-host
xcashd
instance at host <arg>
instead of localhost.--daemon-port
xcashd
instance at port <arg>
instead of 18281.--daemon-login
username[:password]
for xcashd
RPC API. It is based on HTTP Basic Auth. Mind that connections are by default un-encrypted. Authentication only makes sense if you establish a secure connection (maybe via Tor, or SSH tunneling, or reverse proxy w/ TLS).--trusted-daemon
xcashd
instance being trusted. Default for localhost connection. The trust in this context concerns preserving your privacy. Only use this flag if you do control xcashd
. Trusted daemon allows for commands like rescan_spent
, start_mining
, import_key_images
and behaviors like not warning about potential attack on transient problems with transaction sending.--untrusted-daemon
xcashd
instance being trusted. Default for a non-localhost connections. See --trusted-daemon
for more details.--do-not-relay
--allow-mismatched-daemon-version
xcashd
that uses a different RPC version.--generate-new-wallet
<arg>
file. You will be asked for a password. The password is used to encrypt the wallet file but it is unrelated to your master spend key or mnemonic seed. Generate a very strong password with your password manager (~256 bits of entropy). Example: ./xcashd-wallet-cli --stagenet --generate-new-wallet $HOME/.bitxcash/stagenet/wallets/XCashExampleStagenetWallet
--kdf-rounds
1
round of hashing. Note this is unrelated to spend key generation. The more rounds the longer you will wait to open the wallet or send transaction. But also the attacker will have it harder to brute force your wallet password. Note: You will have to remember and provide the same kdf-rounds
on every wallet access! Recommendation: Do not change the default value. Instead generate a very strong wallet password with your password manager (256 bits of entropy).--wallet-file
./xcash-wallet-cli --stagenet --wallet-file $HOME/.bitxc/stagenet/wallets/XCashExampleStagenetWallet
This is only for wallet files generated with xcash-wallet-cli
, xcash-wallet-gui
, or xcash-wallet-rpc
tools. If you have other type of wallet then see importing options.--password
--password-file
. The option also works in combination with --generate-new-wallet
.--password-file
--password
if you automate wallet access. Make sure the password file is meaningfully separated from the wallet file. Otherwise it provides no security benefit. The option also works in combination with --generate-new-wallet
.--generate-from-device
<arg>
file. Example: ./xcash-wallet-cli --stagenet --generate-from-device XCashExampleDeviceWallet --subaddress-lookahead 5:20
This is a one-time action. Next time you simply open the wallet. By default the command expects Ledger hardware connected. For Trezor hardware add --hw-device Trezor
(expected ~May 2019). It will take up to 25 minutes with default settings. This is because hardware devices are slow to pre-generate subaddresses. To mitigate use low --subaddress-lookahead 5:20
. The local wallet will not have private spend key and will not be able to spend on its own. It serves as a user interface and a bridge for low-power hardware devices. Transaction signing with a private spend key always happens on the hardware device. See the complete guide to hardware wallet setup.--generate-from-view-key
<arg>
file. The wallet is created based on a secret view key and standard address. The secret view key is meant to be pasted as hexadecimal.--generate-from-spend-key
<arg>
file. The secret spend key is meant to be pasted as hexadecimal.--restore-deterministic-wallet
--generate-from-multisig-keys
N/N
not N/M
).--restore-multisig-wallet
seed
interactive command. This only restores your part of the wallet. Other multisig participants will still be necessary to sign the transaction.--config-file
xcashd
uses because these tools accept different set of options.--subaddress-lookahead
m:n
, by default 50:200
. The first value is the number of accounts and the second value is the number of subaddresses per account. The wallet will not check for payments to subaddresses further than n
away from the last received payment. This can happen if you generated unique subaddresses for n
clients in a row but none of them paid. On the other hand the more subaddresses you set to look ahead, the longer it takes to create your wallet, because they must be pre-computed. This is normally not a concern, except for hardware wallets. On the Ledger the default value of 50:200
can take over 20 minutes (one time on wallet creation)!--max-concurrency
0
uses the number of CPU threads--mnemonic-language
english
, english_old
, esperanto
, french
, german
, italian
, japanese
, lojban
, portuguese
, russian
, spanish
. It might be a good idea to stick to default English which is by far the most popular and well tested. It also avoids potential non-ASCII characters pitfalls or bugs.--use-english-language-names
--use-english-language-names
. This can happen when X-Cash prompts for a language displaying language names in their natives alphabets.--non-deterministic
--generate-from-keys
. To restore fully you will need the .keys file.--generate-from-keys
--shared-ringdb-dir
--electrum-seed
--restore-deterministic-wallet
instead of interactively. This is not recommended b/c the seed will be saved in your command history and also visible in the process list.--generate-from-json
xcash-wallet-rpc
to use this option.--tx-notify
xcash-wallet-rpc
to use this option.--wallet-file
and similar options to control this.xcash-wallet-cli
binary. Use --log-file
to specify the location.xcash-wallet-cli
prompt.xcash-wallet-rpc
.help command_name
to learn more.help
- list all commandshelp <command>
- show help for individual commandversion
- show version of the xcash-wallet-cli binaryaccount
- total balance; list accounts with respective balancesbalance detail
- within the current account, list addresses with respective balancestransfer [<tx_privacy_settings>] [index=<N1>[,<N2>,...]] [<priority>] [<ring_size>] <address> <amount> [<payment_id>]
tx_privacy_settings
public
or private
. Defaults to private.index
priority
[0, 1, 2, 3, 4]
1x, 4x, 20x, and 166x
.ring_size
21
since 1.4.0address
XCASH
, integrated
or sub
address.amount
XCASH
.payment_id
none
.sweep_all
command with the same parameters (except the amount) as the transfer
command. If you leave sweep_all
blank with no parameters it will send a tx back to your wallet. This is helpful in reducing unspents for voting.xcash-wallet-cli
and once the wallet is fully synchronize, type the command:delegates_public_address|delegates_name
with the delegates public address
or delegates name
account
account new
account switch
account label
address all
address new
address label
status
- show if synced up to the blockchain heightfee
- show current fee-per-byte and full node's mempool (the backlog of transactions depending on the priority)wallet_info
- show wallet file path, standard address, type and networkseed
- show raw mnemonic seedencrypted_seed
- create mnemonic seed encrypted with the passphrase; you will need to remember or store the passphrase separately; restoring will not be possible without the passphrasespendkey
- show secret spend key and public spend keyviewkey
- show secret view key and public view keyget_reserve_proof
-> check_reserve_proof
- prove the balanceget_spend_proof
-> check_spend_proof
- prove you made the paymentsign <file>
-> verify <filename> <address> <signature>
- prove ownership of the address; allows to verify the file was signed by the owner of specific X-Cash addressget_tx_proof
-> check_tx_proof
prepare_multisig
make_multisig
finalize_multisig
export_multisig_info
import_multisig_info
submit_multisig
exchange_multisig_keys
export_raw_multisig_tx
r
. This was useful to create a proof of payment but got superseded by get_spend_proof
.get_tx_key <txid>
check_tx_key <txid> <txkey> <address>
set_tx_key <txid> <tx_key>
unspent_outputs
- show a list of, and a histogram of unspent outputs (indivisible pieces of your total balance)export_key_images <file>
-> import_key_images <file>
- used to inform the view-only wallet about outgoing transactions so it can calculate the real balance; normally view-only wallets only learn about incoming transactions, not outgoingexport_outputs <file>
- export a set of outputs owned by this wallet to a <file>