CLI Usage Reference
The solana-cli crate provides a command-line interface tool for Velas
Examples
Get Pubkey
// Command
$ velas-keygen pubkey
// Return
<PUBKEY>
Airdrop VLX/Lamports
// Command
velas airdrop 2
// Return
"2.00000000 VLX"
Get Balance
// Command
velas balance
// Return
"3.00050001 VLX"
Confirm Transaction
// Command
velas confirm <TX_SIGNATURE>
// Return
"Confirmed" / "Not found" / "Transaction failed with error <ERR>"
Deploy program
// Command
velas deploy <PATH>
// Return
<PROGRAM_ID>
Usage
velas-cli
velas-cli 0.3.6 (src:9e42883d; feat:2960423209)
Blockchain, Rebuilt for Scale
USAGE:
velas [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
SUBCOMMANDS:
account Show the contents of an account
address Get your public key
airdrop Request lamports
authorize-nonce-account Assign account authority to a new entity
balance Get your balance
block Get a confirmed block
block-height Get current block height
block-production Show information about block production
block-time Get estimated production time of a block
catchup Wait for a validator to catch up to the cluster
cluster-date Get current cluster date, computed from genesis creation time and network time
cluster-version Get the version of the cluster entrypoint
config Velas command-line tool configuration settings
confirm Confirm transaction by signature
create-address-with-seed Generate a derived account address with a seed
create-nonce-account Create a nonce account
create-stake-account Create a stake account
create-vote-account Create a vote account
deactivate-stake Deactivate the delegated stake from the stake account
decode-transaction Decode a serialized transaction
delegate-stake Delegate stake to a vote account
deploy Deploy a program
epoch Get current epoch
epoch-info Get information about the current epoch
feature Runtime feature management
fees Display current cluster fees
first-available-block Get the first available block in the storage
genesis-hash Get the genesis hash
gossip Show the current gossip network nodes
help Prints this message or the help of the given subcommand(s)
inflation Show inflation information
largest-accounts Get addresses of largest cluster accounts
leader-schedule Display leader schedule
live-slots Show information about the current slot progression
logs Stream transaction logs
merge-stake Merges one stake account into another
new-nonce Generate a new nonce, rendering the existing nonce useless
nonce Get the current nonce value
nonce-account Show the contents of a nonce account
ping Submit transactions sequentially
program Program management
rent Calculate per-epoch and rent-exempt-minimum values for a given account data
length.
resolve-signer Checks that a signer is valid, and returns its specific path; useful for signers
that may be specified generally, eg. usb://ledger
slot Get current slot
split-stake Duplicate a stake account, splitting the tokens between the two
stake-account Show the contents of a stake account
stake-authorize Authorize a new signing keypair for the given stake account
stake-history Show the stake history
stake-set-lockup Set Lockup for the stake account
stakes Show stake account information
supply Get information about the cluster supply of VLX
transaction-count Get current transaction count
transaction-history Show historical transactions affecting the given address from newest to oldest
transfer Transfer funds between system accounts
validator-info Publish/get Validator info on Velas
validators Show summary information about the current validators
vote-account Show the contents of a vote account
vote-authorize-voter Authorize a new vote signing keypair for the given vote account
vote-authorize-withdrawer Authorize a new withdraw signing keypair for the given vote account
vote-update-commission Update the vote account's commission
vote-update-validator Update the vote account's validator identity
wait-for-max-stake Wait for the max stake of any one node to drop below a percentage of total.
withdraw-from-nonce-account Withdraw VLX from the nonce account
withdraw-from-vote-account Withdraw lamports from a vote account into a specified account
withdraw-stake Withdraw the unstaked VLX from the stake account
velas-account
velas-account
Show the contents of an account
USAGE:
velas account [FLAGS] [OPTIONS] <ACCOUNT_ADDRESS>
FLAGS:
-h, --help Prints help information
--lamports Display balance in lamports instead of VLX
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
-o, --output-file <FILEPATH> Write the account data to this file
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<ACCOUNT_ADDRESS> Account key URI. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-address
velas-address
Get your public key
USAGE:
velas address [FLAGS] [OPTIONS]
FLAGS:
--confirm-key Confirm key on device; only relevant if using remote wallet
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-airdrop
velas-airdrop
Request lamports
USAGE:
velas airdrop [FLAGS] [OPTIONS] <AMOUNT> [RECIPIENT_ADDRESS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--faucet-host <URL> Faucet host to use [default: the --url host]
--faucet-port <PORT_NUMBER> Faucet port to use [default: 9900]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<AMOUNT> The airdrop amount to request, in VLX
<RECIPIENT_ADDRESS> The account address of airdrop recipient. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-authorize-nonce-account
velas-authorize-nonce-account
Assign account authority to a new entity
USAGE:
velas authorize-nonce-account [FLAGS] [OPTIONS] <NONCE_ACCOUNT_ADDRESS> <AUTHORITY_PUBKEY>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<NONCE_ACCOUNT_ADDRESS> Address of the nonce account. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<AUTHORITY_PUBKEY> Account to be granted authority of the nonce account. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-balance
velas-balance
Get your balance
USAGE:
velas balance [FLAGS] [OPTIONS] [ACCOUNT_ADDRESS]
FLAGS:
-h, --help Prints help information
--lamports Display balance in lamports instead of VLX
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<ACCOUNT_ADDRESS> The account address of the balance to check. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-block
velas-block
Get a confirmed block
USAGE:
velas block [FLAGS] [OPTIONS] [SLOT]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<SLOT>
velas-block-height
velas-block-height
Get current block height
USAGE:
velas block-height [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-block-production
velas-block-production
Show information about block production
USAGE:
velas block-production [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--epoch <epoch> Epoch to show block production for [default: current epoch]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--slot-limit <slot_limit> Limit results to this many slots from the end of the epoch [default: full
epoch]
--ws <URL> WebSocket URL for the velas cluster
velas-block-time
velas-block-time
Get estimated production time of a block
USAGE:
velas block-time [FLAGS] [OPTIONS] [SLOT]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<SLOT> Slot number of the block to query
velas-catchup
velas-catchup
Wait for a validator to catch up to the cluster
USAGE:
velas catchup [FLAGS] [OPTIONS] [ARGS]
FLAGS:
--follow Continue reporting progress even after the validator has caught up
-h, --help Prints help information
--log Don't update the progress inplace; instead show updates with its own new lines
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--our-localhost <PORT> Guess Identity pubkey and validator rpc node assuming local (possibly
private) validator [default: 8899]
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<OUR_VALIDATOR_PUBKEY> Identity pubkey of the validator, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<OUR_URL> JSON RPC URL for validator, which is useful for validators with a private RPC service
velas-cluster-date
velas-cluster-date
Get current cluster date, computed from genesis creation time and network time
USAGE:
velas cluster-date [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-cluster-version
velas-cluster-version
Get the version of the cluster entrypoint
USAGE:
velas cluster-version [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-config
velas-config
Velas command-line tool configuration settings
USAGE:
velas config [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
SUBCOMMANDS:
export-address-labels Export the current address labels
get Get current config settings
help Prints this message or the help of the given subcommand(s)
import-address-labels Import a list of address labels
set Set a config setting
velas-confirm
velas-confirm
Confirm transaction by signature
USAGE:
velas confirm [FLAGS] [OPTIONS] <TRANSACTION_SIGNATURE>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<TRANSACTION_SIGNATURE> The transaction signature to confirm
Note: This will show more detailed information for finalized transactions with verbose mode (-v/--verbose).
Account modes:
|srwx|
s: signed
r: readable (always true)
w: writable
x: program account (inner instructions excluded)
velas-create-address-with-seed
velas-create-address-with-seed
Generate a derived account address with a seed
USAGE:
velas create-address-with-seed [FLAGS] [OPTIONS] <SEED_STRING> <PROGRAM_ID>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--from <FROM_PUBKEY> From (base) key, [default: cli config keypair]. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<SEED_STRING> The seed. Must not take more than 32 bytes to encode as utf-8
<PROGRAM_ID> The program_id that the address will ultimately be used for,
or one of NONCE, STAKE, and VOTE keywords
velas-create-nonce-account
velas-create-nonce-account
Create a nonce account
USAGE:
velas create-nonce-account [FLAGS] [OPTIONS] <ACCOUNT_KEYPAIR> <AMOUNT>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce-authority <PUBKEY> Assign noncing authority to another entity. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--seed <STRING> Seed for address generation; if specified, the resulting account will be at a
derived address of the NONCE_ACCOUNT pubkey
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<ACCOUNT_KEYPAIR> Keypair of the nonce account to fund
<AMOUNT> The amount to load the nonce account with, in VLX; accepts keyword ALL
velas-create-stake-account
velas-create-stake-account
Create a stake account
USAGE:
velas create-stake-account [FLAGS] [OPTIONS] <STAKE_ACCOUNT_KEYPAIR> <AMOUNT>
FLAGS:
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--custodian <PUBKEY> Authority to modify lockups. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer
argument
is also passed. Defaults to the client keypair.
--from <KEYPAIR> Source account of funds [default: cli config keypair]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--lockup-date <RFC3339 DATETIME> The date and time at which this account will be available for withdrawal
--lockup-epoch <NUMBER> The epoch height at which this account will be available for withdrawal
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--seed <STRING> Seed for address generation; if specified, the resulting account will be at
a derived address of the STAKE_ACCOUNT_KEYPAIR pubkey
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--stake-authority <PUBKEY> Authorized staker [default: cli config keypair]
--ws <URL> WebSocket URL for the velas cluster
--withdraw-authority <PUBKEY> Authorized withdrawer [default: cli config keypair]
ARGS:
<STAKE_ACCOUNT_KEYPAIR> Stake account to create (or base of derived address if --seed is used)
<AMOUNT> The amount to send to the stake account, in VLX; accepts keyword ALL
velas-create-vote-account
velas-create-vote-account
Create a vote account
USAGE:
velas create-vote-account [FLAGS] [OPTIONS] <ACCOUNT_KEYPAIR> <IDENTITY_KEYPAIR>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--authorized-voter <VOTER_PUBKEY>
Public key of the authorized voter [default: validator identity pubkey]. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
--authorized-withdrawer <WITHDRAWER_PUBKEY>
Public key of the authorized withdrawer [default: validator identity pubkey]. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
--commission <PERCENTAGE> The commission taken on reward redemption (0-100) [default: 100]
--commitment <COMMITMENT_LEVEL>
Return information at the selected commitment level [possible values: processed, confirmed, finalized]
-C, --config <FILEPATH>
Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER>
URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta, testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--with-memo <MEMO> Specify a memo string to include in the transaction.
--output <FORMAT>
Return information in specified output format [possible values: json, json-compact]
--seed <STRING>
Seed for address generation; if specified, the resulting account will be at a derived address of the VOTE
ACCOUNT pubkey
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<ACCOUNT_KEYPAIR> Vote account keypair to create
<IDENTITY_KEYPAIR> Keypair of validator that will vote with this account
velas-deactivate-stake
velas-deactivate-stake
Deactivate the delegated stake from the stake account
USAGE:
velas deactivate-stake [FLAGS] [OPTIONS] <STAKE_ACCOUNT_ADDRESS>
FLAGS:
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer argument
is also passed. Defaults to the client keypair.
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--seed <STRING> Seed for address generation; if specified, the resulting account will be at a
derived address of STAKE_ACCOUNT_ADDRESS
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--stake-authority <KEYPAIR> Authorized staker [default: cli config keypair]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<STAKE_ACCOUNT_ADDRESS> Stake account to be deactivated (or base of derived address if --seed is used). , one
of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-decode-transaction
velas-decode-transaction
Decode a serialized transaction
USAGE:
velas decode-transaction [FLAGS] [OPTIONS] <TRANSACTION> <ENCODING>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<TRANSACTION> transaction to decode
<ENCODING> transaction encoding [default: base58] [possible values: base58, base64]
velas-delegate-stake
velas-delegate-stake
Delegate stake to a vote account
USAGE:
velas delegate-stake [FLAGS] [OPTIONS] <STAKE_ACCOUNT_ADDRESS> <VOTE_ACCOUNT_ADDRESS>
FLAGS:
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer argument
is also passed. Defaults to the client keypair.
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--stake-authority <KEYPAIR> Authorized staker [default: cli config keypair]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<STAKE_ACCOUNT_ADDRESS> Stake account to delegate, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<VOTE_ACCOUNT_ADDRESS> The vote account to which the stake will be delegated, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-deploy
velas-deploy
Deploy a program
USAGE:
velas deploy [FLAGS] [OPTIONS] <PROGRAM_FILEPATH> [PROGRAM_ADDRESS_SIGNER]
FLAGS:
--allow-excessive-deploy-account-balance
Use the designated program id, even if the account already holds a large balance of VLX
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation
Skip validation of seed phrases. Use this if your phrase does not use the BIP39 official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<PROGRAM_FILEPATH> /path/to/program.o
<PROGRAM_ADDRESS_SIGNER> The signer for the desired address of the program [default: new random address]
velas-epoch
velas-epoch
Get current epoch
USAGE:
velas epoch [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-epoch-info
velas-epoch-info
Get information about the current epoch
USAGE:
velas epoch-info [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-feature
velas-feature
Runtime feature management
USAGE:
velas feature [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
SUBCOMMANDS:
activate Activate a runtime feature
help Prints this message or the help of the given subcommand(s)
status Query runtime feature status
velas-fees
velas-fees
Display current cluster fees
USAGE:
velas fees [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Query fees for BLOCKHASH instead of the the most recent blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-first-available-block
velas-first-available-block
Get the first available block in the storage
USAGE:
velas first-available-block [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-genesis-hash
velas-genesis-hash
Get the genesis hash
USAGE:
velas genesis-hash [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-gossip
velas-gossip
Show the current gossip network nodes
USAGE:
velas gossip [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-help
velas-help
Prints this message or the help of the given subcommand(s)
USAGE:
velas help [subcommand]...
ARGS:
<subcommand>... The subcommand whose help message to display
velas-inflation
velas-inflation
Show inflation information
USAGE:
velas inflation [FLAGS] [OPTIONS] [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
rewards Show inflation rewards for a set of addresses
velas-largest-accounts
velas-largest-accounts
Get addresses of largest cluster accounts
USAGE:
velas largest-accounts [FLAGS] [OPTIONS]
FLAGS:
--circulating Filter address list to only circulating accounts
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--non-circulating Filter address list to only non-circulating accounts
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-leader-schedule
velas-leader-schedule
Display leader schedule
USAGE:
velas leader-schedule [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--epoch <EPOCH> Epoch to show leader schedule for. (default: current)
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-live-slots
velas-live-slots
Show information about the current slot progression
USAGE:
velas live-slots [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-logs
velas-logs
Stream transaction logs
USAGE:
velas logs [FLAGS] [OPTIONS] [ADDRESS]
FLAGS:
-h, --help Prints help information
--include-votes Include vote transactions when monitoring all transactions
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<ADDRESS> Account address to monitor [default: monitor all transactions except for votes] , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-merge-stake
velas-merge-stake
Merges one stake account into another
USAGE:
velas merge-stake [FLAGS] [OPTIONS] <STAKE_ACCOUNT_ADDRESS> <SOURCE_STAKE_ACCOUNT_ADDRESS>
FLAGS:
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer argument
is also passed. Defaults to the client keypair.
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--stake-authority <KEYPAIR> Authorized staker [default: cli config keypair]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<STAKE_ACCOUNT_ADDRESS> Stake account to merge into, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<SOURCE_STAKE_ACCOUNT_ADDRESS> Source stake account for the merge. If successful, this stake account will no
longer exist after the merge, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-new-nonce
velas-new-nonce
Generate a new nonce, rendering the existing nonce useless
USAGE:
velas new-nonce [FLAGS] [OPTIONS] <NONCE_ACCOUNT_ADDRESS>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<NONCE_ACCOUNT_ADDRESS> Address of the nonce account. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-nonce
velas-nonce
Get the current nonce value
USAGE:
velas nonce [FLAGS] [OPTIONS] <NONCE_ACCOUNT_ADDRESS>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<NONCE_ACCOUNT_ADDRESS> Address of the nonce account to display. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-nonce-account
velas-nonce-account
Show the contents of a nonce account
USAGE:
velas nonce-account [FLAGS] [OPTIONS] <NONCE_ACCOUNT_ADDRESS>
FLAGS:
-h, --help Prints help information
--lamports Display balance in lamports instead of VLX
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<NONCE_ACCOUNT_ADDRESS> Address of the nonce account to display. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-ping
velas-ping
Submit transactions sequentially
USAGE:
velas ping [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
-D, --print-timestamp Print timestamp (unix time + microseconds as in gettimeofday) before each line
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-c, --count <NUMBER> Stop after submitting count transactions
-i, --interval <SECONDS> Wait interval seconds between submitting the next transaction [default: 2]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--lamports <NUMBER> Number of lamports to transfer for each transaction [default: 1]
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
-t, --timeout <SECONDS> Wait up to timeout seconds for transaction confirmation [default: 15]
--ws <URL> WebSocket URL for the velas cluster
velas-program
velas-program
Program management
USAGE:
velas program [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
SUBCOMMANDS:
close Close an acount and withdraw all lamports
deploy Deploy a program
dump Write the program data to a file
help Prints this message or the help of the given subcommand(s)
set-buffer-authority Set a new buffer authority
set-upgrade-authority Set a new program authority
show Display information about a buffer or program
write-buffer Writes a program into a buffer account
velas-rent
velas-rent
Calculate per-epoch and rent-exempt-minimum values for a given account data length.
USAGE:
velas rent [FLAGS] [OPTIONS] <DATA_LENGTH_OR_MONIKER>
FLAGS:
-h, --help Prints help information
--lamports Display rent in lamports instead of VLX
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<DATA_LENGTH_OR_MONIKER> Length of data in the account to calculate rent for, or moniker: [nonce, stake,
system, vote]
velas-resolve-signer
velas-resolve-signer
Checks that a signer is valid, and returns its specific path; useful for signers that may be specified generally, eg.
usb://ledger
USAGE:
velas resolve-signer [FLAGS] [OPTIONS] <SIGNER_KEYPAIR>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<SIGNER_KEYPAIR> The signer path to resolve
velas-slot
velas-slot
Get current slot
USAGE:
velas slot [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-split-stake
velas-split-stake
Duplicate a stake account, splitting the tokens between the two
USAGE:
velas split-stake [FLAGS] [OPTIONS] <STAKE_ACCOUNT_ADDRESS> <SPLIT_STAKE_ACCOUNT> <AMOUNT>
FLAGS:
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer argument
is also passed. Defaults to the client keypair.
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--seed <STRING> Seed for address generation; if specified, the resulting account will be at a
derived address of SPLIT_STAKE_ACCOUNT
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--stake-authority <KEYPAIR> Authorized staker [default: cli config keypair]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<STAKE_ACCOUNT_ADDRESS> Stake account to split (or base of derived address if --seed is used). , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<SPLIT_STAKE_ACCOUNT> Keypair of the new stake account
<AMOUNT> The amount to move into the new stake account, in VLX
velas-stake-account
velas-stake-account
Show the contents of a stake account
USAGE:
velas stake-account [FLAGS] [OPTIONS] <STAKE_ACCOUNT_ADDRESS>
FLAGS:
-h, --help Prints help information
--lamports Display balance in lamports instead of VLX
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
--with-rewards Display inflation rewards
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--num-rewards-epochs <NUM> Display rewards for NUM recent epochs, max 10 [default: latest epoch only]
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<STAKE_ACCOUNT_ADDRESS> The stake account to display. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-stake-authorize
velas-stake-authorize
Authorize a new signing keypair for the given stake account
USAGE:
velas stake-authorize [FLAGS] [OPTIONS] <STAKE_ACCOUNT_ADDRESS> --new-stake-authority <PUBKEY> --new-withdraw-authority <PUBKEY>
FLAGS:
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--custodian <KEYPAIR> Authority to override account lockup
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer
argument
is also passed. Defaults to the client keypair.
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-
beta, testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--new-stake-authority <PUBKEY> New authorized staker, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
--new-withdraw-authority <PUBKEY> New authorized withdrawer. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced
transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--stake-authority <KEYPAIR> Authorized staker [default: cli config keypair]
--ws <URL> WebSocket URL for the velas cluster
--withdraw-authority <KEYPAIR> Authorized withdrawer [default: cli config keypair]
ARGS:
<STAKE_ACCOUNT_ADDRESS> Stake account in which to set a new authority. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-stake-history
velas-stake-history
Show the stake history
USAGE:
velas stake-history [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--lamports Display balance in lamports instead of VLX
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--limit <NUM> Display NUM recent epochs worth of stake history in text mode. 0 for all
[default: 10]
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-stake-set-lockup
velas-stake-set-lockup
Set Lockup for the stake account
USAGE:
velas stake-set-lockup [FLAGS] [OPTIONS] <STAKE_ACCOUNT_ADDRESS> <--lockup-epoch <NUMBER>|--lockup-date <RFC3339 DATETIME>|--new-custodian <PUBKEY>>
FLAGS:
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--custodian <KEYPAIR> Keypair of the existing custodian [default: cli config pubkey]
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer
argument
is also passed. Defaults to the client keypair.
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--lockup-date <RFC3339 DATETIME> The date and time at which this account will be available for withdrawal
--lockup-epoch <NUMBER> The epoch height at which this account will be available for withdrawal
--new-custodian <PUBKEY> Identity of a new lockup custodian. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<STAKE_ACCOUNT_ADDRESS> Stake account for which to set lockup parameters. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-stakes
velas-stakes
Show stake account information
USAGE:
velas stakes [FLAGS] [OPTIONS] [VOTE_ACCOUNT_PUBKEYS]...
FLAGS:
-h, --help Prints help information
--lamports Display balance in lamports instead of VLX
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<VOTE_ACCOUNT_PUBKEYS>... Only show stake accounts delegated to the provided vote accounts. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-supply
velas-supply
Get information about the cluster supply of VLX
USAGE:
velas supply [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--print-accounts Print list of non-circualting account addresses
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-transaction-count
velas-transaction-count
Get current transaction count
USAGE:
velas transaction-count [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
velas-transaction-history
velas-transaction-history
Show historical transactions affecting the given address from newest to oldest
USAGE:
velas transaction-history [FLAGS] [OPTIONS] <ADDRESS>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--show-transactions Display the full transactions
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--before <TRANSACTION_SIGNATURE> Start with the first signature older than this one
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--limit <LIMIT> Maximum number of transaction signatures to return [default: 1000]
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<ADDRESS> Account address, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-transfer
velas-transfer
Transfer funds between system accounts
USAGE:
velas transfer [FLAGS] [OPTIONS] <RECIPIENT_ADDRESS> <AMOUNT>
FLAGS:
--allow-unfunded-recipient Complete the transfer even if the recipient address is not funded
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--no-wait Return signature immediately after submitting the transaction, instead of
waiting for confirmations
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer argument
is also passed. Defaults to the client keypair.
--from <FROM_ADDRESS> Source account of funds (if different from client local account). , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--with-memo <MEMO> Specify a memo string to include in the transaction.
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<RECIPIENT_ADDRESS> The account address of recipient. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<AMOUNT> The amount to send, in VLX; accepts keyword ALL
velas-validator-info
velas-validator-info
Publish/get Validator info on Velas
USAGE:
velas validator-info [FLAGS] [OPTIONS] <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
SUBCOMMANDS:
get Get and parse Velas Validator info
help Prints this message or the help of the given subcommand(s)
publish Publish Validator info on Velas
velas-validators
velas-validators
Show summary information about the current validators
USAGE:
velas validators [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--lamports Display balance in lamports instead of VLX
--no-address-labels Do not use address labels in the output
-n, --number Number the validators
-r, --reverse Reverse order while sorting
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--sort <sort> Sort order (does not affect JSON output) [default: stake] [possible values:
delinquent, commission, credits, identity, last-vote, root, skip-rate, stake,
vote-account]
--ws <URL> WebSocket URL for the velas cluster
velas-vote-account
velas-vote-account
Show the contents of a vote account
USAGE:
velas vote-account [FLAGS] [OPTIONS] <VOTE_ACCOUNT_ADDRESS>
FLAGS:
-h, --help Prints help information
--lamports Display balance in lamports instead of VLX
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
--with-rewards Display inflation rewards
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--num-rewards-epochs <NUM> Display rewards for NUM recent epochs, max 10 [default: latest epoch only]
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<VOTE_ACCOUNT_ADDRESS> Vote account pubkey. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-vote-authorize-voter
velas-vote-authorize-voter
Authorize a new vote signing keypair for the given vote account
USAGE:
velas vote-authorize-voter [FLAGS] [OPTIONS] <VOTE_ACCOUNT_ADDRESS> <AUTHORIZED_KEYPAIR> <NEW_AUTHORIZED_PUBKEY>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--with-memo <MEMO> Specify a memo string to include in the transaction.
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<VOTE_ACCOUNT_ADDRESS> Vote account in which to set the authorized voter. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<AUTHORIZED_KEYPAIR> Current authorized vote signer.
<NEW_AUTHORIZED_PUBKEY> New authorized vote signer. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-vote-authorize-withdrawer
velas-vote-authorize-withdrawer
Authorize a new withdraw signing keypair for the given vote account
USAGE:
velas vote-authorize-withdrawer [FLAGS] [OPTIONS] <VOTE_ACCOUNT_ADDRESS> <AUTHORIZED_KEYPAIR> <AUTHORIZED_PUBKEY>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--with-memo <MEMO> Specify a memo string to include in the transaction.
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<VOTE_ACCOUNT_ADDRESS> Vote account in which to set the authorized withdrawer. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<AUTHORIZED_KEYPAIR> Current authorized withdrawer.
<AUTHORIZED_PUBKEY> New authorized withdrawer. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
velas-vote-update-commission
velas-vote-update-commission
Update the vote account's commission
USAGE:
velas vote-update-commission [FLAGS] [OPTIONS] <VOTE_ACCOUNT_ADDRESS> <PERCENTAGE> <AUTHORIZED_KEYPAIR>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--with-memo <MEMO> Specify a memo string to include in the transaction.
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<VOTE_ACCOUNT_ADDRESS> Vote account to update. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<PERCENTAGE> The new commission
<AUTHORIZED_KEYPAIR> Authorized withdrawer keypair
velas-vote-update-validator
velas-vote-update-validator
Update the vote account's validator identity
USAGE:
velas vote-update-validator [FLAGS] [OPTIONS] <VOTE_ACCOUNT_ADDRESS> <IDENTITY_KEYPAIR> <AUTHORIZED_KEYPAIR>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--with-memo <MEMO> Specify a memo string to include in the transaction.
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<VOTE_ACCOUNT_ADDRESS> Vote account to update. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<IDENTITY_KEYPAIR> Keypair of new validator that will vote with this account
<AUTHORIZED_KEYPAIR> Authorized withdrawer keypair
velas-wait-for-max-stake
velas-wait-for-max-stake
Wait for the max stake of any one node to drop below a percentage of total.
USAGE:
velas wait-for-max-stake [FLAGS] [OPTIONS] [PERCENT]
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<PERCENT>
velas-withdraw-from-nonce-account
velas-withdraw-from-nonce-account
Withdraw VLX from the nonce account
USAGE:
velas withdraw-from-nonce-account [FLAGS] [OPTIONS] <NONCE_ACCOUNT_ADDRESS> <RECIPIENT_ADDRESS> <AMOUNT>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<NONCE_ACCOUNT_ADDRESS> Nonce account to withdraw from. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<RECIPIENT_ADDRESS> The account to which the VLX should be transferred. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<AMOUNT> The amount to withdraw from the nonce account, in VLX
velas-withdraw-from-vote-account
velas-withdraw-from-vote-account
Withdraw lamports from a vote account into a specified account
USAGE:
velas withdraw-from-vote-account [FLAGS] [OPTIONS] <VOTE_ACCOUNT_ADDRESS> <RECIPIENT_ADDRESS> <AMOUNT>
FLAGS:
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--authorized-withdrawer <AUTHORIZED_KEYPAIR> Authorized withdrawer [default: cli config keypair]
--commitment <COMMITMENT_LEVEL>
Return information at the selected commitment level [possible values: processed, confirmed, finalized]
-C, --config <FILEPATH>
Configuration file to use [default: ~/.config/velas/cli/config.yml]
-u, --url <URL_OR_MONIKER>
URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta, testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--with-memo <MEMO> Specify a memo string to include in the transaction.
--output <FORMAT>
Return information in specified output format [possible values: json, json-compact]
--ws <URL> WebSocket URL for the velas cluster
ARGS:
<VOTE_ACCOUNT_ADDRESS> Vote account from which to withdraw. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<RECIPIENT_ADDRESS> The recipient of withdrawn VLX. , one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<AMOUNT> The amount to withdraw, in VLX; accepts keyword ALL
velas-withdraw-stake
velas-withdraw-stake
Withdraw the unstaked VLX from the stake account
USAGE:
velas withdraw-stake [FLAGS] [OPTIONS] <STAKE_ACCOUNT_ADDRESS> <RECIPIENT_ADDRESS> <AMOUNT>
FLAGS:
--dump-transaction-message Display the base64 encoded binary transaction message in sign-only mode
-h, --help Prints help information
--no-address-labels Do not use address labels in the output
--sign-only Sign the transaction offline
--skip-seed-phrase-validation Skip validation of seed phrases. Use this if your phrase does not use the BIP39
official English word list
-V, --version Prints version information
-v, --verbose Show additional information
OPTIONS:
--blockhash <BLOCKHASH> Use the supplied blockhash
--commitment <COMMITMENT_LEVEL> Return information at the selected commitment level [possible values:
processed, confirmed, finalized]
-C, --config <FILEPATH> Configuration file to use [default: ~/.config/velas/cli/config.yml]
--custodian <KEYPAIR> Authority to override account lockup
--fee-payer <KEYPAIR> Specify the fee-payer account. This may be a keypair file, the ASK keyword
or the pubkey of an offline signer, provided an appropriate --signer argument
is also passed. Defaults to the client keypair.
-u, --url <URL_OR_MONIKER> URL for Velas' JSON RPC or moniker (or their first letter): [mainnet-beta,
testnet, devnet, localhost]
-k, --keypair <KEYPAIR> Filepath or URL to a keypair
--nonce <PUBKEY> Provide the nonce account to use when creating a nonced
transaction. Nonced transactions are useful when a transaction
requires a lengthy signing process. Learn more about nonced
transactions at https://docs.velas.com/cli/durable-nonce/
--nonce-authority <KEYPAIR> Provide the nonce authority keypair to use when signing a nonced transaction
--output <FORMAT> Return information in specified output format [possible values: json, json-
compact]
--seed <STRING> Seed for address generation; if specified, the resulting account will be at a
derived address of STAKE_ACCOUNT_ADDRESS
--signer <PUBKEY=SIGNATURE>... Provide a public-key/signature pair for the transaction
--ws <URL> WebSocket URL for the velas cluster
--withdraw-authority <KEYPAIR> Authorized withdrawer [default: cli config keypair]
ARGS:
<STAKE_ACCOUNT_ADDRESS> Stake account from which to withdraw (or base of derived address if --seed is used).
, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<RECIPIENT_ADDRESS> Recipient of withdrawn VLX, one of:
* a base58-encoded public key
* a path to a keypair file
* a hyphen; signals a JSON-encoded keypair on stdin
* the 'ASK' keyword; to recover a keypair via its seed phrase
* a hardware wallet keypair URL (i.e. usb://ledger)
<AMOUNT> The amount to withdraw from the stake account, in VLX; accepts keyword ALL