From 8cf3ef895da49ed3316f4c16fba3f9b2500eacf0 Mon Sep 17 00:00:00 2001 From: Trent Nelson Date: Mon, 2 Mar 2020 17:37:38 -0700 Subject: [PATCH] Prevent trailing space in CLI usage docs generation (#8578) automerge --- docs/build-cli-usage.sh | 4 +- docs/src/cli/usage.md | 279 ++++++++++++++++++++++++---------------- 2 files changed, 169 insertions(+), 114 deletions(-) diff --git a/docs/build-cli-usage.sh b/docs/build-cli-usage.sh index 8dd353401..d079ae6c3 100755 --- a/docs/build-cli-usage.sh +++ b/docs/build-cli-usage.sh @@ -3,7 +3,7 @@ set -e cd "$(dirname "$0")" -usage=$(cargo -q run -p solana-cli -- -C ~/.foo --help | sed 's|'"$HOME"'|~|g') +usage=$(cargo -q run -p solana-cli -- -C ~/.foo --help | sed -e 's|'"$HOME"'|~|g' -e 's/[[:space:]]\+$//') out=${1:-src/cli/usage.md} @@ -29,6 +29,6 @@ in_subcommands=0 while read -r subcommand rest; do [[ $subcommand == "SUBCOMMANDS:" ]] && in_subcommands=1 && continue if ((in_subcommands)); then - section "$(cargo -q run -p solana-cli -- help "$subcommand" | sed 's|'"$HOME"'|~|g')" "####" >> "$out" + section "$(cargo -q run -p solana-cli -- help "$subcommand" | sed -e 's|'"$HOME"'|~|g' -e 's/[[:space:]]\+$//')" "####" >> "$out" fi done <<<"$usage">>"$out" diff --git a/docs/src/cli/usage.md b/docs/src/cli/usage.md index fb3e5067e..78a7c4b29 100644 --- a/docs/src/cli/usage.md +++ b/docs/src/cli/usage.md @@ -193,6 +193,7 @@ OPTIONS: -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 @@ -254,7 +255,7 @@ SUBCOMMANDS: #### solana-account ```text -solana-account +solana-account Show the contents of an account USAGE: @@ -278,6 +279,7 @@ OPTIONS: -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 @@ -285,7 +287,7 @@ ARGS: #### solana-address ```text -solana-address +solana-address Get your public key USAGE: @@ -308,11 +310,12 @@ OPTIONS: -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 +solana-airdrop Request lamports USAGE: @@ -336,6 +339,7 @@ OPTIONS: --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 @@ -344,7 +348,7 @@ ARGS: #### solana-authorize-nonce-account ```text -solana-authorize-nonce-account +solana-authorize-nonce-account Assign account authority to a new entity USAGE: @@ -372,6 +376,7 @@ OPTIONS: --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 @@ -380,7 +385,7 @@ ARGS: #### solana-balance ```text -solana-balance +solana-balance Get your balance USAGE: @@ -403,6 +408,7 @@ OPTIONS: -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 @@ -410,7 +416,7 @@ ARGS: #### solana-block-production ```text -solana-block-production +solana-block-production Show information about block production USAGE: @@ -435,11 +441,13 @@ OPTIONS: -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 +solana-block-time Get estimated production time of a block USAGE: @@ -461,6 +469,7 @@ OPTIONS: -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 @@ -468,7 +477,7 @@ ARGS: #### solana-cancel ```text -solana-cancel +solana-cancel Cancel a transfer USAGE: @@ -490,6 +499,7 @@ OPTIONS: -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 @@ -497,7 +507,7 @@ ARGS: #### solana-catchup ```text -solana-catchup +solana-catchup Wait for a validator to catch up to the cluster USAGE: @@ -519,6 +529,7 @@ OPTIONS: -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 @@ -526,7 +537,7 @@ ARGS: #### solana-claim-storage-reward ```text -solana-claim-storage-reward +solana-claim-storage-reward Redeem storage reward credits USAGE: @@ -548,6 +559,7 @@ OPTIONS: -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 @@ -556,7 +568,7 @@ ARGS: #### solana-cluster-version ```text -solana-cluster-version +solana-cluster-version Get the version of the cluster entrypoint USAGE: @@ -578,11 +590,12 @@ OPTIONS: -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-config Solana command-line tool configuration settings USAGE: @@ -604,6 +617,7 @@ OPTIONS: -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 @@ -613,7 +627,7 @@ SUBCOMMANDS: #### solana-confirm ```text -solana-confirm +solana-confirm Confirm transaction by signature USAGE: @@ -635,6 +649,7 @@ OPTIONS: -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 @@ -642,7 +657,7 @@ ARGS: #### solana-create-address-with-seed ```text -solana-create-address-with-seed +solana-create-address-with-seed Generate a derived account address with a seed USAGE: @@ -665,16 +680,17 @@ OPTIONS: --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, + 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 +solana-create-archiver-storage-account Create an archiver storage account USAGE: @@ -696,15 +712,16 @@ OPTIONS: -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 +solana-create-nonce-account Create a nonce account USAGE: @@ -727,6 +744,7 @@ OPTIONS: -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 @@ -735,7 +753,7 @@ ARGS: #### solana-create-stake-account ```text -solana-create-stake-account +solana-create-stake-account Create a stake account USAGE: @@ -761,8 +779,8 @@ OPTIONS: 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 + 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) @@ -776,9 +794,9 @@ OPTIONS: 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 + 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 @@ -792,6 +810,7 @@ OPTIONS: --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) @@ -803,7 +822,7 @@ ARGS: #### solana-create-validator-storage-account ```text -solana-create-validator-storage-account +solana-create-validator-storage-account Create a validator storage account USAGE: @@ -825,15 +844,16 @@ OPTIONS: -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 +solana-create-vote-account Create a vote account USAGE: @@ -865,6 +885,7 @@ OPTIONS: --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 @@ -873,7 +894,7 @@ ARGS: #### solana-deactivate-stake ```text -solana-deactivate-stake +solana-deactivate-stake Deactivate the delegated stake from the stake account USAGE: @@ -896,15 +917,15 @@ OPTIONS: 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 + 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 + 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 @@ -915,6 +936,7 @@ OPTIONS: --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. @@ -922,7 +944,7 @@ ARGS: #### solana-delegate-stake ```text -solana-delegate-stake +solana-delegate-stake Delegate stake to a vote account USAGE: @@ -945,15 +967,15 @@ OPTIONS: 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 + 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 + 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 @@ -964,6 +986,7 @@ OPTIONS: --stake-authority Public key of authorized staker (defaults to cli config pubkey) + --ws WebSocket URL for the solana cluster ARGS: Stake account to delegate @@ -972,7 +995,7 @@ ARGS: #### solana-deploy ```text -solana-deploy +solana-deploy Deploy a program USAGE: @@ -994,6 +1017,7 @@ OPTIONS: -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 @@ -1001,7 +1025,7 @@ ARGS: #### solana-epoch-info ```text -solana-epoch-info +solana-epoch-info Get information about the current epoch USAGE: @@ -1024,11 +1048,12 @@ OPTIONS: -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 +solana-fees Display current cluster fees USAGE: @@ -1050,11 +1075,12 @@ OPTIONS: -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 +solana-genesis-hash Get the genesis hash USAGE: @@ -1076,11 +1102,12 @@ OPTIONS: -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 +solana-gossip Show the current gossip network nodes USAGE: @@ -1102,11 +1129,12 @@ OPTIONS: -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 +solana-help Prints this message or the help of the given subcommand(s) USAGE: @@ -1118,7 +1146,7 @@ ARGS: #### solana-leader-schedule ```text -solana-leader-schedule +solana-leader-schedule Display leader schedule USAGE: @@ -1140,11 +1168,12 @@ OPTIONS: -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 +solana-live-slots Show information about the current slot progression USAGE: @@ -1166,13 +1195,12 @@ OPTIONS: -u, --url JSON RPC URL for the solana cluster -k, --keypair /path/to/id.json or usb://remote/wallet/path - -w, --ws - WebSocket URL for PubSub RPC connection [default: ws://127.0.0.1:8900] + --ws WebSocket URL for the solana cluster ``` #### solana-new-nonce ```text -solana-new-nonce +solana-new-nonce Generate a new nonce, rendering the existing nonce useless USAGE: @@ -1197,6 +1225,7 @@ OPTIONS: --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 @@ -1204,7 +1233,7 @@ ARGS: #### solana-nonce ```text -solana-nonce +solana-nonce Get the current nonce value USAGE: @@ -1226,6 +1255,7 @@ OPTIONS: -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 @@ -1233,7 +1263,7 @@ ARGS: #### solana-nonce-account ```text -solana-nonce-account +solana-nonce-account Show the contents of a nonce account USAGE: @@ -1256,6 +1286,7 @@ OPTIONS: -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 @@ -1263,14 +1294,14 @@ ARGS: #### solana-pay ```text -solana-pay +solana-pay Send a payment USAGE: solana pay [FLAGS] [OPTIONS] FLAGS: - --cancelable + --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 @@ -1289,9 +1320,9 @@ OPTIONS: -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 + 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 @@ -1301,6 +1332,7 @@ OPTIONS: --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 @@ -1312,7 +1344,7 @@ ARGS: #### solana-ping ```text -solana-ping +solana-ping Submit transactions sequentially USAGE: @@ -1344,11 +1376,13 @@ OPTIONS: -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 +solana-send-signature Send a signature to authorize a transfer USAGE: @@ -1370,6 +1404,7 @@ OPTIONS: -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 @@ -1378,7 +1413,7 @@ ARGS: #### solana-send-timestamp ```text -solana-send-timestamp +solana-send-timestamp Send a timestamp to unlock a transfer USAGE: @@ -1401,6 +1436,7 @@ OPTIONS: -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 @@ -1409,7 +1445,7 @@ ARGS: #### solana-slot ```text -solana-slot +solana-slot Get current slot USAGE: @@ -1432,11 +1468,12 @@ OPTIONS: -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 +solana-split-stake Split a stake account USAGE: @@ -1459,15 +1496,15 @@ OPTIONS: 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 + 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 + 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 @@ -1481,6 +1518,7 @@ OPTIONS: --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 @@ -1490,7 +1528,7 @@ ARGS: #### solana-stake-account ```text -solana-stake-account +solana-stake-account Show the contents of a stake account USAGE: @@ -1513,6 +1551,7 @@ OPTIONS: -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 @@ -1520,7 +1559,7 @@ ARGS: #### solana-stake-authorize-staker ```text -solana-stake-authorize-staker +solana-stake-authorize-staker Authorize a new stake signing keypair for the given stake account USAGE: @@ -1543,15 +1582,15 @@ OPTIONS: 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 + 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 + 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 @@ -1562,6 +1601,7 @@ OPTIONS: --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 @@ -1570,7 +1610,7 @@ ARGS: #### solana-stake-authorize-withdrawer ```text -solana-stake-authorize-withdrawer +solana-stake-authorize-withdrawer Authorize a new withdraw signing keypair for the given stake account USAGE: @@ -1593,15 +1633,15 @@ OPTIONS: 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 + 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 + 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 @@ -1609,6 +1649,7 @@ OPTIONS: --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) @@ -1620,7 +1661,7 @@ ARGS: #### solana-stake-history ```text -solana-stake-history +solana-stake-history Show the stake history USAGE: @@ -1643,15 +1684,16 @@ OPTIONS: -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 +solana-stake-set-lockup Set Lockup for the stake account USAGE: - solana stake-set-lockup [FLAGS] [OPTIONS] + solana stake-set-lockup [FLAGS] [OPTIONS] <--lockup-epoch |--lockup-date |--new-custodian > FLAGS: -h, --help Prints help information @@ -1673,8 +1715,8 @@ OPTIONS: 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 + 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 @@ -1688,9 +1730,9 @@ OPTIONS: 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 + 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 @@ -1698,6 +1740,7 @@ OPTIONS: --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 @@ -1705,7 +1748,7 @@ ARGS: #### solana-stakes ```text -solana-stakes +solana-stakes Show stake account information USAGE: @@ -1728,6 +1771,7 @@ OPTIONS: -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 @@ -1735,7 +1779,7 @@ ARGS: #### solana-storage-account ```text -solana-storage-account +solana-storage-account Show the contents of a storage account USAGE: @@ -1757,6 +1801,7 @@ OPTIONS: -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 @@ -1764,7 +1809,7 @@ ARGS: #### solana-transaction-count ```text -solana-transaction-count +solana-transaction-count Get current transaction count USAGE: @@ -1787,11 +1832,12 @@ OPTIONS: -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 +solana-transfer Transfer funds between system accounts USAGE: @@ -1814,8 +1860,8 @@ OPTIONS: 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 + 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) @@ -1823,9 +1869,9 @@ OPTIONS: -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 + 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 @@ -1833,6 +1879,7 @@ OPTIONS: --signer ... Provide a public-key/signature pair for the transaction + --ws WebSocket URL for the solana cluster ARGS: The pubkey of recipient @@ -1841,7 +1888,7 @@ ARGS: #### solana-validator-info ```text -solana-validator-info +solana-validator-info Publish/get Validator info on Solana USAGE: @@ -1863,6 +1910,7 @@ OPTIONS: -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 @@ -1872,7 +1920,7 @@ SUBCOMMANDS: #### solana-validators ```text -solana-validators +solana-validators Show summary information about the current validators USAGE: @@ -1895,11 +1943,12 @@ OPTIONS: -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 +solana-vote-account Show the contents of a vote account USAGE: @@ -1922,6 +1971,7 @@ OPTIONS: -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 @@ -1929,7 +1979,7 @@ ARGS: #### solana-vote-authorize-voter ```text -solana-vote-authorize-voter +solana-vote-authorize-voter Authorize a new vote signing keypair for the given vote account USAGE: @@ -1951,6 +2001,7 @@ OPTIONS: -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 @@ -1959,7 +2010,7 @@ ARGS: #### solana-vote-authorize-withdrawer ```text -solana-vote-authorize-withdrawer +solana-vote-authorize-withdrawer Authorize a new withdraw signing keypair for the given vote account USAGE: @@ -1981,6 +2032,7 @@ OPTIONS: -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 @@ -1989,7 +2041,7 @@ ARGS: #### solana-vote-update-validator ```text -solana-vote-update-validator +solana-vote-update-validator Update the vote account's validator identity USAGE: @@ -2011,6 +2063,7 @@ OPTIONS: -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 @@ -2020,7 +2073,7 @@ ARGS: #### solana-withdraw-from-nonce-account ```text -solana-withdraw-from-nonce-account +solana-withdraw-from-nonce-account Withdraw lamports from the nonce account USAGE: @@ -2045,6 +2098,7 @@ OPTIONS: --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 @@ -2054,7 +2108,7 @@ ARGS: #### solana-withdraw-stake ```text -solana-withdraw-stake +solana-withdraw-stake Withdraw the unstaked lamports from the stake account USAGE: @@ -2077,15 +2131,15 @@ OPTIONS: 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 + 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 + 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 @@ -2093,6 +2147,7 @@ OPTIONS: --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)