From 1f2aaf3f988023118c085e562a98ea570f6b947e Mon Sep 17 00:00:00 2001 From: Michael Vines Date: Wed, 4 Mar 2020 17:44:30 -0700 Subject: [PATCH] Generate CLI usage (#8637) * Generate CLI usage * Apply review feedback --- .gitignore | 1 + docs/makefile | 8 +- docs/src/cli/usage.md | 2160 ----------------------------------------- 3 files changed, 8 insertions(+), 2161 deletions(-) delete mode 100644 docs/src/cli/usage.md diff --git a/.gitignore b/.gitignore index b19013084..9af47b9ea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ /docs/html/ /docs/src/tests.ok +/docs/src/cli/usage.md /docs/src/.gitbook/assets/*.svg /farf/ /solana-release/ diff --git a/docs/makefile b/docs/makefile index 89967d1d4..5943e98fb 100644 --- a/docs/makefile +++ b/docs/makefile @@ -1,6 +1,6 @@ BOB_SRCS=$(wildcard art/*.bob) MSC_SRCS=$(wildcard art/*.msc) -MD_SRCS=$(wildcard src/*.md src/*/*.md) +MD_SRCS=$(wildcard src/*.md src/*/*.md) src/cli/usage.md SVG_IMGS=$(BOB_SRCS:art/%.bob=src/.gitbook/assets/%.svg) $(MSC_SRCS:art/%.msc=src/.gitbook/assets/%.svg) @@ -27,6 +27,12 @@ src/.gitbook/assets/%.svg: art/%.msc @mkdir -p $(@D) mscgen -T svg -i $< -o $@ +../target/debug/solana: + cd ../cli && cargo build + +src/cli/usage.md: build-cli-usage.sh ../target/debug/solana + ./$< + src/%.md: %.md @mkdir -p $(@D) @cp $< $@ diff --git a/docs/src/cli/usage.md b/docs/src/cli/usage.md deleted file mode 100644 index 78a7c4b29..000000000 --- a/docs/src/cli/usage.md +++ /dev/null @@ -1,2160 +0,0 @@ -# solana CLI - -The [solana-cli crate](https://crates.io/crates/solana-cli) provides a command-line interface tool for Solana - -## Examples - -### Get Pubkey - -```bash -// Command -$ solana address - -// Return - -``` - -### Airdrop SOL/Lamports - -```bash -// Command -$ solana airdrop 2 - -// Return -"2.00000000 SOL" -``` - -### Get Balance - -```bash -// Command -$ solana balance - -// Return -"3.00050001 SOL" -``` - -### Confirm Transaction - -```bash -// Command -$ solana confirm - -// Return -"Confirmed" / "Not found" / "Transaction failed with error " -``` - -### Deploy program - -```bash -// Command -$ solana deploy - -// Return - -``` - -### Unconditional Immediate Transfer - -```bash -// Command -$ solana pay 123 - -// Return - -``` - -### Post-Dated Transfer - -```bash -// Command -$ solana pay 123 \ - --after 2018-12-24T23:59:00 --require-timestamp-from - -// Return -{signature: , processId: } -``` - -_`require-timestamp-from` is optional. If not provided, the transaction will expect a timestamp signed by this wallet's private key_ - -### Authorized Transfer - -A third party must send a signature to unlock the lamports. - -```bash -// Command -$ solana pay 123 \ - --require-signature-from - -// Return -{signature: , processId: } -``` - -### Post-Dated and Authorized Transfer - -```bash -// Command -$ solana pay 123 \ - --after 2018-12-24T23:59 --require-timestamp-from \ - --require-signature-from - -// Return -{signature: , processId: } -``` - -### Multiple Witnesses - -```bash -// Command -$ solana pay 123 \ - --require-signature-from \ - --require-signature-from - -// Return -{signature: , processId: } -``` - -### Cancelable Transfer - -```bash -// Command -$ solana pay 123 \ - --require-signature-from \ - --cancelable - -// Return -{signature: , processId: } -``` - -### Cancel Transfer - -```bash -// Command -$ solana cancel - -// Return - -``` - -### Send Signature - -```bash -// Command -$ solana send-signature - -// Return - -``` - -### Indicate Elapsed Time - -Use the current system time: - -```bash -// Command -$ solana send-timestamp - -// Return - -``` - -Or specify some other arbitrary timestamp: - -```bash -// Command -$ solana send-timestamp --date 2018-12-24T23:59:00 - -// Return - -``` - -## Usage -### solana-cli -```text -solana-cli 1.1.0 [channel=unknown commit=unknown] -Blockchain, Rebuilt for Scale - -USAGE: - solana [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana 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-production Show information about block production - block-time Get estimated production time of a block - cancel Cancel a transfer - catchup Wait for a validator to catch up to the cluster - claim-storage-reward Redeem storage reward credits - cluster-version Get the version of the cluster entrypoint - config Solana command-line tool configuration settings - confirm Confirm transaction by signature - create-address-with-seed Generate a derived account address with a seed - create-archiver-storage-account Create an archiver storage account - create-nonce-account Create a nonce account - create-stake-account Create a stake account - create-validator-storage-account Create a validator storage account - create-vote-account Create a vote account - deactivate-stake Deactivate the delegated stake from the stake account - delegate-stake Delegate stake to a vote account - deploy Deploy a program - epoch-info Get information about the current epoch - fees Display current cluster fees - 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) - leader-schedule Display leader schedule - live-slots Show information about the current slot progression - 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 - pay Send a payment - ping Submit transactions sequentially - send-signature Send a signature to authorize a transfer - send-timestamp Send a timestamp to unlock a transfer - slot Get current slot - split-stake Split a stake account - stake-account Show the contents of a stake account - stake-authorize-staker Authorize a new stake signing keypair for the given stake account - stake-authorize-withdrawer Authorize a new withdraw 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 - storage-account Show the contents of a storage account - transaction-count Get current transaction count - transfer Transfer funds between system accounts - validator-info Publish/get Validator info on Solana - 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-validator Update the vote account's validator identity - withdraw-from-nonce-account Withdraw lamports from the nonce account - withdraw-stake Withdraw the unstaked lamports from the stake account -``` - -#### solana-account -```text -solana-account -Show the contents of an account - -USAGE: - solana account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --lamports Display balance in lamports instead of SOL - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - -o, --output Write the account data to this file - --ws WebSocket URL for the solana cluster - -ARGS: - Account pubkey -``` - -#### solana-address -```text -solana-address -Get your public key - -USAGE: - solana address [FLAGS] [OPTIONS] - -FLAGS: - --confirm-key Confirm key on device; only relevant if using remote wallet - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-airdrop -```text -solana-airdrop -Request lamports - -USAGE: - solana airdrop [FLAGS] [OPTIONS] [PUBKEY] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --faucet-host Faucet host to use [default: the --url host] - --faucet-port Faucet port to use [default: 9900] - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - The airdrop amount to request, in SOL - The pubkey of airdrop recipient -``` - -#### solana-authorize-nonce-account -```text -solana-authorize-nonce-account -Assign account authority to a new entity - -USAGE: - solana authorize-nonce-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --seed - Seed for address generation; if specified, the resulting account will be at a derived address of the - NONCE_ACCOUNT pubkey - --ws WebSocket URL for the solana cluster - -ARGS: - Address of the nonce account - Account to be granted authority of the nonce account -``` - -#### solana-balance -```text -solana-balance -Get your balance - -USAGE: - solana balance [FLAGS] [OPTIONS] [PUBKEY] - -FLAGS: - -h, --help Prints help information - --lamports Display balance in lamports instead of SOL - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - The public key of the balance to check -``` - -#### solana-block-production -```text -solana-block-production -Show information about block production - -USAGE: - solana block-production [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --epoch Epoch to show block production for [default: current epoch] - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --slot-limit - Limit results to this many slots from the end of the epoch [default: full epoch] - - --ws WebSocket URL for the solana cluster -``` - -#### solana-block-time -```text -solana-block-time -Get estimated production time of a block - -USAGE: - solana block-time [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Slot number of the block to query -``` - -#### solana-cancel -```text -solana-cancel -Cancel a transfer - -USAGE: - solana cancel [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - The process id of the transfer to cancel -``` - -#### solana-catchup -```text -solana-catchup -Wait for a validator to catch up to the cluster - -USAGE: - solana catchup [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Identity pubkey of the validator -``` - -#### solana-claim-storage-reward -```text -solana-claim-storage-reward -Redeem storage reward credits - -USAGE: - solana claim-storage-reward [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - The node account to credit the rewards to - Storage account address to redeem credits for -``` - -#### solana-cluster-version -```text -solana-cluster-version -Get the version of the cluster entrypoint - -USAGE: - solana cluster-version [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-config -```text -solana-config -Solana command-line tool configuration settings - -USAGE: - solana config [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -SUBCOMMANDS: - get Get current config settings - help Prints this message or the help of the given subcommand(s) - set Set a config setting -``` - -#### solana-confirm -```text -solana-confirm -Confirm transaction by signature - -USAGE: - solana confirm [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - The transaction signature to confirm -``` - -#### solana-create-address-with-seed -```text -solana-create-address-with-seed -Generate a derived account address with a seed - -USAGE: - solana create-address-with-seed [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --from From (base) key, defaults to client keypair. - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - The seed. Must not take more than 32 bytes to encode as utf-8 - The program_id that the address will ultimately be used for, - or one of STAKE, VOTE, and STORAGE keywords -``` - -#### solana-create-archiver-storage-account -```text -solana-create-archiver-storage-account -Create an archiver storage account - -USAGE: - solana create-archiver-storage-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - - -``` - -#### solana-create-nonce-account -```text -solana-create-nonce-account -Create a nonce account - -USAGE: - solana create-nonce-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce-authority Assign noncing authority to another entity - --ws WebSocket URL for the solana cluster - -ARGS: - Keypair of the nonce account to fund - The amount to load the nonce account with, in SOL -``` - -#### solana-create-stake-account -```text -solana-create-stake-account -Create a stake account - -USAGE: - solana create-stake-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --custodian - Identity of the custodian (can withdraw before lockup expires) - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 - Source account of funds (if different from client local account) - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --lockup-date - The date and time at which this account will be available for withdrawal - - --lockup-epoch - The epoch height at which this account will be available for withdrawal - - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --seed - Seed for address generation; if specified, the resulting account will be at a derived address of the STAKE - ACCOUNT pubkey - --signer ... - Provide a public-key/signature pair for the transaction - - --stake-authority - Public key of authorized staker (defaults to cli config pubkey) - - --ws WebSocket URL for the solana cluster - --withdraw-authority - Public key of authorized withdrawer (defaults to cli config pubkey) - - -ARGS: - Signing authority of the stake address to fund - The amount of send to the vote account, in SOL -``` - -#### solana-create-validator-storage-account -```text -solana-create-validator-storage-account -Create a validator storage account - -USAGE: - solana create-validator-storage-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - - -``` - -#### solana-create-vote-account -```text -solana-create-vote-account -Create a vote account - -USAGE: - solana create-vote-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --authorized-voter Public key of the authorized voter (defaults to vote account) - --authorized-withdrawer - Public key of the authorized withdrawer (defaults to cli config pubkey) - - --commission - The commission taken on reward redemption (0-100) [default: 100] - - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --seed - Seed for address generation; if specified, the resulting account will be at a derived address of the VOTE - ACCOUNT pubkey - --ws WebSocket URL for the solana cluster - -ARGS: - Vote account keypair to fund - Validator that will vote with this account -``` - -#### solana-deactivate-stake -```text -solana-deactivate-stake -Deactivate the delegated stake from the stake account - -USAGE: - solana deactivate-stake [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --signer ... - Provide a public-key/signature pair for the transaction - - --stake-authority - Public key of authorized staker (defaults to cli config pubkey) - - --ws WebSocket URL for the solana cluster - -ARGS: - Stake account to be deactivated. -``` - -#### solana-delegate-stake -```text -solana-delegate-stake -Delegate stake to a vote account - -USAGE: - solana delegate-stake [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --signer ... - Provide a public-key/signature pair for the transaction - - --stake-authority - Public key of authorized staker (defaults to cli config pubkey) - - --ws WebSocket URL for the solana cluster - -ARGS: - Stake account to delegate - The vote account to which the stake will be delegated -``` - -#### solana-deploy -```text -solana-deploy -Deploy a program - -USAGE: - solana deploy [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - /path/to/program.o -``` - -#### solana-epoch-info -```text -solana-epoch-info -Get information about the current epoch - -USAGE: - solana epoch-info [FLAGS] [OPTIONS] - -FLAGS: - --confirmed Return information at maximum-lockout commitment level - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-fees -```text -solana-fees -Display current cluster fees - -USAGE: - solana fees [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-genesis-hash -```text -solana-genesis-hash -Get the genesis hash - -USAGE: - solana genesis-hash [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-gossip -```text -solana-gossip -Show the current gossip network nodes - -USAGE: - solana gossip [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-help -```text -solana-help -Prints this message or the help of the given subcommand(s) - -USAGE: - solana help [subcommand]... - -ARGS: - ... The subcommand whose help message to display -``` - -#### solana-leader-schedule -```text -solana-leader-schedule -Display leader schedule - -USAGE: - solana leader-schedule [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-live-slots -```text -solana-live-slots -Show information about the current slot progression - -USAGE: - solana live-slots [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-new-nonce -```text -solana-new-nonce -Generate a new nonce, rendering the existing nonce useless - -USAGE: - solana new-nonce [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --ws WebSocket URL for the solana cluster - -ARGS: - Address of the nonce account -``` - -#### solana-nonce -```text -solana-nonce -Get the current nonce value - -USAGE: - solana nonce [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Address of the nonce account to display -``` - -#### solana-nonce-account -```text -solana-nonce-account -Show the contents of a nonce account - -USAGE: - solana nonce-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --lamports Display balance in lamports instead of SOL - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Address of the nonce account to display -``` - -#### solana-pay -```text -solana-pay -Send a payment - -USAGE: - solana pay [FLAGS] [OPTIONS] - -FLAGS: - --cancelable - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --signer ... - Provide a public-key/signature pair for the transaction - - --after A timestamp after which transaction will execute - --require-timestamp-from Require timestamp from this third party - --ws WebSocket URL for the solana cluster - --require-signature-from ... - Any third party signatures required to unlock the lamports - - -ARGS: - The pubkey of recipient - The amount to send, in SOL -``` - -#### solana-ping -```text -solana-ping -Submit transactions sequentially - -USAGE: - solana ping [FLAGS] [OPTIONS] - -FLAGS: - --confirmed Wait until the transaction is confirmed at maximum-lockout commitment level - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - -c, --count Stop after submitting count transactions - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -i, --interval - Wait interval seconds between submitting the next transaction [default: 2] - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --lamports - Number of lamports to transfer for each transaction [default: 1] - - -t, --timeout - Wait up to timeout seconds for transaction confirmation [default: 15] - - --ws WebSocket URL for the solana cluster -``` - -#### solana-send-signature -```text -solana-send-signature -Send a signature to authorize a transfer - -USAGE: - solana send-signature [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - The pubkey of recipient - The process id of the transfer to authorize -``` - -#### solana-send-timestamp -```text -solana-send-timestamp -Send a timestamp to unlock a transfer - -USAGE: - solana send-timestamp [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --date Optional arbitrary timestamp to apply - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - The pubkey of recipient - The process id of the transfer to unlock -``` - -#### solana-slot -```text -solana-slot -Get current slot - -USAGE: - solana slot [FLAGS] [OPTIONS] - -FLAGS: - --confirmed Return slot at maximum-lockout commitment level - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-split-stake -```text -solana-split-stake -Split a stake account - -USAGE: - solana split-stake [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --seed - Seed for address generation; if specified, the resulting account will be at a derived address of the SPLIT - STAKE ACCOUNT pubkey - --signer ... - Provide a public-key/signature pair for the transaction - - --stake-authority - Public key of authorized staker (defaults to cli config pubkey) - - --ws WebSocket URL for the solana cluster - -ARGS: - Stake account to be split - Keypair of the new stake account to split funds into - The amount to move into the new stake account, in unit SOL -``` - -#### solana-stake-account -```text -solana-stake-account -Show the contents of a stake account - -USAGE: - solana stake-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --lamports Display balance in lamports instead of SOL - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Address of the stake account to display -``` - -#### solana-stake-authorize-staker -```text -solana-stake-authorize-staker -Authorize a new stake signing keypair for the given stake account - -USAGE: - solana stake-authorize-staker [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --signer ... - Provide a public-key/signature pair for the transaction - - --stake-authority - Public key of authorized staker (defaults to cli config pubkey) - - --ws WebSocket URL for the solana cluster - -ARGS: - Stake account in which to set the authorized staker - New authorized staker -``` - -#### solana-stake-authorize-withdrawer -```text -solana-stake-authorize-withdrawer -Authorize a new withdraw signing keypair for the given stake account - -USAGE: - solana stake-authorize-withdrawer [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --signer ... - Provide a public-key/signature pair for the transaction - - --ws WebSocket URL for the solana cluster - --withdraw-authority - Public key of authorized withdrawer (defaults to cli config pubkey) - - -ARGS: - Stake account in which to set the authorized withdrawer - New authorized withdrawer -``` - -#### solana-stake-history -```text -solana-stake-history -Show the stake history - -USAGE: - solana stake-history [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --lamports Display balance in lamports instead of SOL - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-stake-set-lockup -```text -solana-stake-set-lockup -Set Lockup for the stake account - -USAGE: - solana stake-set-lockup [FLAGS] [OPTIONS] <--lockup-epoch |--lockup-date |--new-custodian > - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --custodian - Public key of signing custodian (defaults to cli config pubkey) - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --lockup-date - The date and time at which this account will be available for withdrawal - - --lockup-epoch - The epoch height at which this account will be available for withdrawal - - --new-custodian - Identity of the new lockup custodian (can withdraw before lockup expires) - - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --signer ... - Provide a public-key/signature pair for the transaction - - --ws WebSocket URL for the solana cluster - -ARGS: - Stake account for which to set Lockup -``` - -#### solana-stakes -```text -solana-stakes -Show stake account information - -USAGE: - solana stakes [FLAGS] [OPTIONS] [VOTE ACCOUNT PUBKEYS]... - -FLAGS: - -h, --help Prints help information - --lamports Display balance in lamports instead of SOL - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - ... Only show stake accounts delegated to the provided vote accounts -``` - -#### solana-storage-account -```text -solana-storage-account -Show the contents of a storage account - -USAGE: - solana storage-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Storage account pubkey -``` - -#### solana-transaction-count -```text -solana-transaction-count -Get current transaction count - -USAGE: - solana transaction-count [FLAGS] [OPTIONS] - -FLAGS: - --confirmed Return count at maximum-lockout commitment level - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-transfer -```text -solana-transfer -Transfer funds between system accounts - -USAGE: - solana transfer [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 - Source account of funds (if different from client local account) - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --signer ... - Provide a public-key/signature pair for the transaction - - --ws WebSocket URL for the solana cluster - -ARGS: - The pubkey of recipient - The amount to send, in SOL -``` - -#### solana-validator-info -```text -solana-validator-info -Publish/get Validator info on Solana - -USAGE: - solana validator-info [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -SUBCOMMANDS: - get Get and parse Solana Validator info - help Prints this message or the help of the given subcommand(s) - publish Publish Validator info on Solana -``` - -#### solana-validators -```text -solana-validators -Show summary information about the current validators - -USAGE: - solana validators [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --lamports Display balance in lamports instead of SOL - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster -``` - -#### solana-vote-account -```text -solana-vote-account -Show the contents of a vote account - -USAGE: - solana vote-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --lamports Display balance in lamports instead of SOL - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Vote account pubkey -``` - -#### solana-vote-authorize-voter -```text -solana-vote-authorize-voter -Authorize a new vote signing keypair for the given vote account - -USAGE: - solana vote-authorize-voter [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Vote account in which to set the authorized voter - New vote signer to authorize -``` - -#### solana-vote-authorize-withdrawer -```text -solana-vote-authorize-withdrawer -Authorize a new withdraw signing keypair for the given vote account - -USAGE: - solana vote-authorize-withdrawer [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Vote account in which to set the authorized withdrawer - New withdrawer to authorize -``` - -#### solana-vote-update-validator -```text -solana-vote-update-validator -Update the vote account's validator identity - -USAGE: - solana vote-update-validator [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --ws WebSocket URL for the solana cluster - -ARGS: - Vote account to update - New validator that will vote with this account - Authorized voter keypair -``` - -#### solana-withdraw-from-nonce-account -```text -solana-withdraw-from-nonce-account -Withdraw lamports from the nonce account - -USAGE: - solana withdraw-from-nonce-account [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - -u, --url JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --ws WebSocket URL for the solana cluster - -ARGS: - Nonce account from to withdraw from - The account to which the lamports should be transferred - The amount to withdraw from the nonce account, in SOL -``` - -#### solana-withdraw-stake -```text -solana-withdraw-stake -Withdraw the unstaked lamports from the stake account - -USAGE: - solana withdraw-stake [FLAGS] [OPTIONS] - -FLAGS: - -h, --help Prints help information - --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 extra information header - -OPTIONS: - --blockhash Use the supplied blockhash - -C, --config - Configuration file to use [default: ~/.config/solana/cli/config.yml] - - --derivation-path - Derivation path to use: m/44'/501'/ACCOUNT'/CHANGE'; default key is device base pubkey: m/44'/501'/0' - - --fee-payer - 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 JSON RPC URL for the solana cluster - -k, --keypair /path/to/id.json or usb://remote/wallet/path - --nonce - 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.solana.com/offline-signing/durable-nonce - --nonce-authority - Provide the nonce authority keypair to use when signing a nonced transaction - - --signer ... - Provide a public-key/signature pair for the transaction - - --ws WebSocket URL for the solana cluster - --withdraw-authority - Public key of authorized withdrawer (defaults to cli config pubkey) - - -ARGS: - Stake account from which to withdraw - The account to which the lamports should be transferred - The amount to withdraw from the stake account, in SOL -``` -