src/_zcash-cli

@@ -28,7 +28,7 @@
 # Description
 # -----------
 #
-#  Completion script for zcash-cli v6.10.0 (https://z.cash).
+#  Completion script for zcash-cli (https://z.cash).
 #
 # ------------------------------------------------------------------------------
 # Authors
@@ -38,148 +38,139 @@
 #
 # ------------------------------------------------------------------------------
 
-_zcash_cli_commands() {
+local state line curcontext="$curcontext" ret=1
-  local -a commands=(
+
-    'addmultisigaddress:Add a nrequired-to-sign transparent multisignature address to the wallet'
+_arguments -C \
-    'addnode:Attempts to add or remove a node from the addnode list'
+  '-?[display usage information]' \
-    'backupwallet:Safely copies current wallet file to destination filename'
+  -conf='[specify configuration file]:file [zcash.conf]:_files' \
-    'clearbanned:Clear all banned IPs'
+  -datadir='[specify data directory]:directory:_directories' \
-    'createmultisig:Creates a multi-signature address with n signature of m keys required'
+  -testnet'[use the test network]' \
-    'decoderawtransaction:Return a JSON object representing the serialized, hex-encoded transaction'
+  -regtest'[enter regression test mode, which uses a special chain in which blocks can be solved instantly. This is intended for regression testing tools and app development.]' \
-    'decodescript:Decode a hex-encoded script'
+  -rpcconnect='[send commands to node running on specified ip]:rpcconnect [127.0.0.1]:_hosts' \
-    'disconnectnode:Immediately disconnects from the specified node'
+  -rpcport='[connect to JSON-RPC on specified port]: :_guard "[[\:digit\:]]#" "port [8232 or testnet\: 18232]"' \
-    'dumpprivkey:Reveals the private key corresponding to "t-addr"'
+  -rpcwait'[wait for RPC server to start]' \
-    'encryptwallet:Encrypts the wallet with "passphrase"'
+  -rpcuser='[username for JSON-RPC connections]:rpcuser' \
-    'generate:Mine blocks immediately'
+  -rpcpassword='[password for JSON-RPC connections]:rpcpassword' \
-    'getaddednodeinfo:Returns information about the given added node, or all added nodes'
+  -rpcclienttimeout='[specify timeout during HTTP requests, or 0 for no timeout]: :_guard "[[\:digit\:]]#" "timeout (seconds) [900]"' \
-    'getaddressbalance:Returns the balance for addresses'
+  ':subcommand:->subcommand' && ret=0
-    'getaddressdeltas:Returns all changes for an address'
+
-    'getaddressmempool:Returns all mempool deltas for an address'
+case $state in
-    'getaddresstxids:Returns the txids for given transparent addresses within the given'
+  subcommand)
-    'getaddressutxos:Returns all unspent outputs for an address'
+    subcommands=(
-    "getbalance:Returns the wallet's available transparent balance"
+      'getbestblockhash'
-    'getbestblockhash:Returns the hash of the best (tip) block in the longest block chain'
+      'getblock'
-    'getblock:return data for the block'
+      'getblockchaininfo'
-    'getblockchaininfo:Returns an object containing various state info regarding block chain processing'
+      'getblockcount'
-    'getblockcount:Returns the height of the most recent block in the best valid block chain'
+      'getblockhash'
-    'getblockdeltas:Returns information about the given block and its transactions'
+      'getblockheader'
-    'getblockhash:Returns hash of block in best-block-chain at index provided'
+      'getchaintips'
-    'getblockhashes:Returns array of hashes of blocks within the timestamp range provided'
+      'getdifficulty'
-    'getblockheader:return block header'
+      'getmempoolinfo'
-    'getblocksubsidy:Returns block subsidy reward'
+      'getrawmempool'
-    'getblocktemplate:get block template'
+      'gettxout'
-    'getchaintips:Return information about all known tips in the block tree'
+      'gettxoutproof'
-    'getconnectioncount:Returns the number of connections to other nodes'
+      'gettxoutsetinfo'
-    'getdeprecationinfo:Returns an object containing current version and deprecation block height'
+      'verifychain'
-    'getdifficulty:Returns the proof-of-work difficulty as a multiple of the minimum difficulty'
+      'verifytxoutproof'
-    'getexperimentalfeatures:Returns enabled experimental features'
+      'getinfo'
-    'getgenerate:Return if the server is set to generate coins or not'
+      'help'
-    'getinfo:Returns an object containing various state info'
+      'stop'
-    'getlocalsolps:Returns the average local solutions per second since this node was started'
+      'generate'
-    'getmemoryinfo:Returns an object containing information about memory usage'
+      'getgenerate'
-    'getmempoolinfo:Returns details on the active state of the TX memory pool'
+      'setgenerate'
-    'getmininginfo:Returns a json object containing mining-related information'
+      'getblocksubsidy'
-    'getnettotals:Returns information about network traffic'
+      'getblocktemplate'
-    'getnetworkinfo:Returns an object containing various state info regarding P2P networking'
+      'getlocalsolps'
-    'getnetworksolps:Returns the estimated network solutions per second based on the last n blocks'
+      'getmininginfo'
-    'getnewaddress:Returns a new transparent Zcash address'
+      'getnetworkhashps'
-    'getpeerinfo:Returns data about each connected network node as a json array of objects'
+      'getnetworksolps'
-    'getrawchangeaddress:Returns a new transparent Zcash address for receiving change'
+      'prioritisetransaction'
-    'getrawmempool:Returns all transaction ids in memory pool as a json array of string transaction ids'
+      'submitblock'
-    'getrawtransaction:Return the raw transaction data'
+      'addnode'
-    'getreceivedbyaddress:Returns the total amount received by the given transparent Zcash address'
+      'clearbanned'
-    'getspentinfo:Returns the txid and index where an output is spent'
+      'disconnectnode'
-    'gettransaction:Returns detailed information about in-wallet transaction'
+      'getaddednodeinfo'
-    'gettxout:Returns details about an unspent transaction output'
+      'getconnectioncount'
-    'gettxoutproof:Returns a hex-encoded proof that "txid" was included in a block'
+      'getnettotals'
-    'gettxoutsetinfo:Returns statistics about the unspent transaction output set'
+      'getnetworkinfo'
-    "getunconfirmedbalance:Returns the server's total unconfirmed transparent balance"
+      'getpeerinfo'
-    'getwalletinfo:Returns wallet state information'
+      'listbanned'
-    'help:List all commands, or get help for a specified command'
+      'ping'
-    'importaddress:import address'
+      'setban'
-    'importprivkey:Adds a private key to your wallet'
+      'createrawtransaction'
-    'importpubkey:Adds a public key'
+      'decoderawtransaction'
-    'importwallet:Imports taddr keys from a wallet dump file'
+      'decodescript'
-    'listaddresses:Lists the addresses managed by this wallet by source'
+      'fundrawtransaction'
-    'listaddressgroupings:Lists groups of transparent addresses'
+      'getrawtransaction'
-    'listbanned:List all banned IPs/Subnets'
+      'sendrawtransaction'
-    'listlockunspent:Returns list of temporarily unspendable transparent outputs'
+      'signrawtransaction'
-    'listreceivedbyaddress:List balances by transparent receiving address'
+      'createmultisig'
-    'listsinceblock:Get all transactions in blocks'
+      'estimatefee'
-    "listtransactions:Returns up to 'count' of the most recent transactions"
+      'estimatepriority'
-    'listunspent:Returns array of unspent transparent transaction outputs'
+      'validateaddress'
-    'lockunspent:Updates list of temporarily unspendable outputs'
+      'verifymessage'
-    'ping:Requests that a ping be sent to all other nodes, to measure ping time'
+      'z_validateaddress'
-    'prioritisetransaction:Accepts the transaction into mined blocks at a higher/lower priority'
+      'addmultisigaddress'
-    'sendmany:Send to multiple transparent recipient'
+      'backupwallet'
-    'sendrawtransaction:Submits raw transaction to local node and network'
+      'dumpprivkey'
-    'sendtoaddress:Send an amount to a given transparent address'
+      'dumpwallet'
-    'setban:Attempts to add or remove an IP/Subnet from the banned list'
+      'encryptwallet'
-    'setgenerate:Set "generate" true or false to turn generation on or off'
+      'getaccount'
-    'setlogfilter:Sets the filter to be used for selecting events to log'
+      'getaccountaddress'
-    'signmessage:Sign a message with the private key of a t-addr'
+      'getaddressesbyaccount'
-    'stop:Stop Zcash server'
+      'getbalance'
-    'submitblock:Attempts to submit new block to network'
+      'getnewaddress'
-    'validateaddress:Return information about the given Zcash address'
+      'getrawchangeaddress'
-    'verifychain:Verifies blockchain database'
+      'getreceivedbyaccount'
-    'verifymessage:Verify a signed message'
+      'getreceivedbyaddress'
-    'verifytxoutproof:Verifies that a proof points to a transaction in a block'
+      'gettransaction'
-    'walletconfirmbackup:Notify the wallet that the user has backed up the emergency recovery phrase'
+      'getunconfirmedbalance'
-    'z_converttex:Converts a transparent Zcash address to a TEX address'
+      'getwalletinfo'
-    'z_exportkey:Reveals the zkey corresponding to "zaddr"'
+      'importaddress'
-    'z_exportviewingkey:Returns the full viewing key corresponding to "zaddr"'
+      'importprivkey'
-    'z_exportwallet:Exports all wallet keys, for taddr and zaddr, in a human-readable format'
+      'importwallet'
-    'z_getaddressforaccount:get address for account'
+      'keypoolrefill'
-    "z_getbalance:Returns the balance of a taddr or zaddr belonging to the node's wallet"
+      'listaccounts'
-    "z_getbalanceforaccount:Returns the account's spendable balance for each value pool"
+      'listaddressgroupings'
-    'z_getbalanceforviewingkey:Returns the balance viewable by a full viewing key'
+      'listlockunspent'
-    'z_getmigrationstatus:Returns information about the status of the Sprout to Sapling migration'
+      'listreceivedbyaccount'
-    'z_getnewaccount:Prepares and returns a new account'
+      'listreceivedbyaddress'
-    'z_getnewaddress:Returns a new shielded address for receiving payments'
+      'listsinceblock'
-    'z_getnotescount:Returns the number of notes available in the wallet for each shielded value pool'
+      'listtransactions'
-    'z_getoperationresult:Retrieve the result and status of an operation which has finished'
+      'listunspent'
-    'z_getoperationstatus:Get operation status and any associated result or error data'
+      'lockunspent'
-    'z_getpaymentdisclosure:Generate a payment disclosure for a given joinsplit output'
+      'move'
-    "z_getsubtreesbyindex:Returns roots of subtrees of the given pool's note commitment tree"
+      'sendfrom'
-    "z_gettreestate:Return information about the given block's tree state"
+      'sendmany'
-    'z_importkey:Adds a zkey (as returned by z_exportkey) to your wallet'
+      'sendtoaddress'
-    'z_importviewingkey:Adds a viewing key to your wallet'
+      'setaccount'
-    'z_importwallet:Imports taddr and zaddr keys from a wallet export file'
+      'settxfee'
-    'z_listaccounts:Returns the list of accounts created with z_getnewaccount'
+      'signmessage'
-    'z_listaddresses:Returns the list of shielded addresses belonging to the wallet'
+      'z_exportkey'
-    'z_listoperationids:Returns the list of operation ids currently known to the wallet'
+      'z_exportwallet'
-    "z_listreceivedbyaddress:Return a list of amounts received by a zaddr belonging to the node's wallet"
+      'z_getbalance'
-    'z_listunifiedreceivers:Returns a record of the individual receivers contained within the provided UA'
+      'z_getnewaddress'
-    'z_listunspent:Returns an array of unspent shielded notes'
+      'z_getoperationresult'
-    'z_mergetoaddress:Merge multiple UTXOs and notes into a single UTXO or note'
+      'z_getoperationstatus'
-    'z_sendmany:Send a transaction with multiple recipients'
+      'z_gettotalbalance'
-    "z_setmigration:attempt to migrate all funds from this wallet's Sprout addresses"
+      'z_importkey'
-    'z_shieldcoinbase:Shield transparent coinbase funds by sending to a shielded zaddr'
+      'z_importwallet'
-    'z_validateaddress:Return information about the given address'
+      'z_listaddresses'
-    'z_validatepaymentdisclosure:Validates a payment disclosure'
+      'z_listoperationids'
-    'z_viewtransaction:Get detailed shielded information about in-wallet transaction'
+      'z_listreceivedbyaddress'
-    'zcbenchmark:Runs a benchmark of the selected benchmark type samplecount times'
+      'z_sendmany'
-    'zcsamplejoinsplit:Perform a joinsplit and return the JSDescription'
+      'zcbenchmark'
+      'zcrawjoinsplit'
+      'zcrawkeygen'
+      'zcrawreceive'
+      'zcsamplejoinsplit'
     )
 
-  _describe -t commands 'command' commands "$@"
+    _describe -t subcommands 'zcash-cli subcommand' subcommands && ret=0
-}
+  ;;
+esac
 
-_arguments \
+return ret
-  '(- *)-?[display usage information]' \
-  '(- *)-version[display version and exit]' \
-  '-conf=[specify configuration file]:file [zcash.conf]:_files' \
-  '-datadir=[specify data directory]:directory:_files -/' \
-  '-testnet[use the test network]' \
-  '-regtest[enter regression test mode]' \
-  '-rpcconnect=[send commands to node running on specified ip]:rpcconnect [127.0.0.1]:_hosts' \
-  '-rpcport=[connect to JSON-RPC on specified port]: :_guard "[[\:digit\:]]#" "port [8232 or testnet\: 18232]"' \
-  '-rpcwait[wait for RPC server to start]' \
-  '-rpcuser=[username for JSON-RPC connections]:rpcuser' \
-  '-rpcpassword=[password for JSON-RPC connections]:rpcpassword' \
-  '-rpcclienttimeout=[specify timeout during HTTP requests, or 0 for no timeout]: :_guard "[[\:digit\:]]#" "timeout (seconds) [900]"' \
-  '1: :_zcash_cli_commands' \
-  '*:: :_files'
 
 # Local Variables:
 # mode: Shell-Script