z_shieldcoinbase - Zcash 5.10.0 RPC
z_shieldcoinbase "fromaddress" "tozaddress" ( fee ) ( limit ) ( memo ) ( privacyPolicy )
Shield transparent coinbase funds by sending to a shielded zaddr. This is an asynchronous operation and utxos
selected for shielding will be locked. If there is an error, they are unlocked. The RPC call `listlockunspent`
can be used to return a list of locked utxos. The number of coinbase utxos selected for shielding can be limited
by the caller. Any limit is constrained by the consensus rule defining a maximum
transaction size of 100000 bytes before Sapling, and 2000000 bytes once Sapling activates.
Arguments:
1. "fromaddress" (string, required) The address is a taddr or "*" for all taddrs belonging to the wallet.
2. "toaddress" (string, required) The address is a zaddr.
3. fee (numeric, optional, default=null) The fee amount in ZEC to attach to this transaction. The default behavior
is to use a fee calculated according to ZIP 317.
4. limit (numeric, optional, default=50) Limit on the maximum number of utxos to shield. Set to 0 to use as many as will fit in the transaction.
5. "memo" (string, optional) Encoded as hex. This will be stored in the memo field of the new note.
6. privacyPolicy (string, optional, default="AllowRevealedSenders") Policy for what information leakage is acceptable.
This allows the same values as z_sendmany, but only "AllowRevealedSenders" and "AllowLinkingAccountAddresses"
are relevant.
Result:
{
"remainingUTXOs": xxx (numeric) Number of coinbase utxos still available for shielding.
"remainingValue": xxx (numeric) Value of coinbase utxos still available for shielding.
"shieldingUTXOs": xxx (numeric) Number of coinbase utxos being shielded.
"shieldingValue": xxx (numeric) Value of coinbase utxos being shielded.
"opid": xxx (string) An operationid to pass to z_getoperationstatus to get the result of the operation.
}
Examples:
> zcash-cli z_shieldcoinbase "t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" "ztfaW34Gj9FrnGUEf833ywDVL62NWXBM81u6EQnM6VR45eYnXhwztecW1SjxA7JrmAXKJhxhj3vDNEpVCQoSvVoSpmbhtjf"
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "z_shieldcoinbase", "params": ["t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd", "ztfaW34Gj9FrnGUEf833ywDVL62NWXBM81u6EQnM6VR45eYnXhwztecW1SjxA7JrmAXKJhxhj3vDNEpVCQoSvVoSpmbhtjf"] }' -H 'content-type: text/plain;' http://127.0.0.1:8232/
Maintained by @_garethtdavies; modified by: mdr0id;license of the docs is MIT (see zcash repo), license of the scripts and webpage is also MIT (github repo)
Note it uses a mainnet zcash node
Blockchain
Generating
Mining
Network
Rawtransactions
Wallet
addmultisigaddress
backupwallet
dumpprivkey
encryptwallet
getbalance
getnewaddress
getrawchangeaddress
getreceivedbyaddress
gettransaction
getunconfirmedbalance
getwalletinfo
importaddress
importprivkey
importpubkey
importwallet
keypoolrefill
listaddresses
listaddressgroupings
listlockunspent
listreceivedbyaddress
listsinceblock
listtransactions
listunspent
lockunspent
sendmany
sendtoaddress
settxfee
signmessage
walletconfirmbackup
z_converttex
z_exportkey
z_exportviewingkey
z_exportwallet
z_getaddressforaccount
z_getbalance
z_getbalanceforaccount
z_getbalanceforviewingkey
z_getmigrationstatus
z_getnewaccount
z_getnewaddress
z_getnotescount
z_getoperationresult
z_getoperationstatus
z_gettotalbalance
z_importkey
z_importviewingkey
z_importwallet
z_listaccounts
z_listaddresses
z_listoperationids
z_listreceivedbyaddress
z_listunifiedreceivers
z_listunspent
z_mergetoaddress
z_sendmany
z_setmigration
z_shieldcoinbase
z_viewtransaction
zcbenchmark
zcsamplejoinsplit
backupwallet
dumpprivkey
encryptwallet
getbalance
getnewaddress
getrawchangeaddress
getreceivedbyaddress
gettransaction
getunconfirmedbalance
getwalletinfo
importaddress
importprivkey
importpubkey
importwallet
keypoolrefill
listaddresses
listaddressgroupings
listlockunspent
listreceivedbyaddress
listsinceblock
listtransactions
listunspent
lockunspent
sendmany
sendtoaddress
settxfee
signmessage
walletconfirmbackup
z_converttex
z_exportkey
z_exportviewingkey
z_exportwallet
z_getaddressforaccount
z_getbalance
z_getbalanceforaccount
z_getbalanceforviewingkey
z_getmigrationstatus
z_getnewaccount
z_getnewaddress
z_getnotescount
z_getoperationresult
z_getoperationstatus
z_gettotalbalance
z_importkey
z_importviewingkey
z_importwallet
z_listaccounts
z_listaddresses
z_listoperationids
z_listreceivedbyaddress
z_listunifiedreceivers
z_listunspent
z_mergetoaddress
z_sendmany
z_setmigration
z_shieldcoinbase
z_viewtransaction
zcbenchmark
zcsamplejoinsplit