2018-03-08 17:34:40 -08:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=1200px, shrink-to-fit=yes" >
2019-05-08 13:34:30 -07:00
< meta name = "description" content = "Zcash 2.0.5-1 RPC Docs - z_mergetoaddress" >
2018-03-08 17:34:40 -08:00
< meta name = "author" content = "" >
2019-05-08 13:34:30 -07:00
< title > z_mergetoaddress - Zcash 2.0.5-1 RPC Docs< / title >
2018-03-08 17:34:40 -08:00
< link href = "./bootstrap.min.css" rel = "stylesheet" >
< / head >
< style >
.card-body {
font-size:80%;
padding-top: 0.5em;
}
pre {
word-break: break-word;
white-space: pre-wrap;
}
< / style >
< body >
< nav class = "navbar navbar-dark bg-dark " >
2019-05-08 13:34:30 -07:00
< a class = "navbar-brand" href = "/" > Zcash 2.0.5-1 RPC docs< / a >
2018-03-08 17:34:40 -08:00
< / nav >
< main role = "main" class = "container-fluid" style = "margin-top: 1pc;" >
< div class = "row" >
2018-03-08 18:26:01 -08:00
< div class = "col-8 col-lg-9 col-xl-10" >
2019-05-08 13:34:30 -07:00
< h1 > z_mergetoaddress - Zcash 2.0.5-1 RPC< / h1 >
2018-03-09 04:16:57 -08:00
2018-06-10 07:43:39 -07:00
< pre > z_mergetoaddress [" fromaddress" , ... ] " toaddress" ( fee ) ( transparent_limit ) ( shielded_limit ) ( memo )
2018-03-08 17:34:40 -08:00
2019-05-08 13:34:30 -07:00
WARNING: z_mergetoaddress is disabled.
To enable it, restart zcashd with the -experimentalfeatures and
-zmergetoaddress commandline options, or add these two lines
to the zcash.conf file:
experimentalfeatures=1
zmergetoaddress=1
2018-06-10 07:43:39 -07:00
Merge multiple UTXOs and notes into a single UTXO or note. Coinbase UTXOs are ignored; use `z_shieldcoinbase`
to combine those into a single note.
This is an asynchronous operation, and UTXOs selected for merging 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 UTXOs and notes selected for merging can be limited by the caller. If the transparent limit
parameter is set to zero, and Overwinter is not yet active, the -mempooltxinputlimit option will determine the
2019-02-18 20:29:52 -08:00
number of UTXOs. After Overwinter has activated -mempooltxinputlimit is ignored and having a transparent
input limit of zero will mean limit the number of UTXOs based on the size of the transaction. Any limit is
constrained by the consensus rule defining a maximum transaction size of 100000 bytes before Sapling, and 2000000
bytes once Sapling activates.
2018-03-08 17:34:40 -08:00
Arguments:
2019-02-18 20:29:52 -08:00
1. fromaddresses (array, required) A JSON array with addresses.
2018-06-10 07:43:39 -07:00
The following special strings are accepted inside the array:
2019-02-18 20:29:52 -08:00
- " ANY_TADDR" : Merge UTXOs from any taddrs belonging to the wallet.
- " ANY_SPROUT" : Merge notes from any Sprout zaddrs belonging to the wallet.
- " ANY_SAPLING" : Merge notes from any Sapling zaddrs belonging to the wallet.
If a special string is given, any given addresses of that type will be counted as duplicates and cause an error.
2018-06-10 07:43:39 -07:00
[
2019-02-18 20:29:52 -08:00
" address" (string) Can be a taddr or a zaddr
2018-06-10 07:43:39 -07:00
,...
]
2019-02-18 20:29:52 -08:00
2. " toaddress" (string, required) The taddr or zaddr to send the funds to.
2018-06-10 07:43:39 -07:00
3. fee (numeric, optional, default=0.0001) The fee amount to attach to this transaction.
4. transparent_limit (numeric, optional, default=50) Limit on the maximum number of UTXOs to merge. Set to 0 to use node option -mempooltxinputlimit (before Overwinter), or as many as will fit in the transaction (after Overwinter).
2019-02-18 20:29:52 -08:00
5. shielded_limit (numeric, optional, default=20 Sprout or 200 Sapling Notes) Limit on the maximum number of notes to merge. Set to 0 to merge as many as will fit in the transaction.
6. " memo" (string, optional) Encoded as hex. When toaddress is a zaddr, this will be stored in the memo field of the new note.
2018-03-08 17:34:40 -08:00
Result:
{
2018-06-10 07:43:39 -07:00
" remainingUTXOs" : xxx (numeric) Number of UTXOs still available for merging.
" remainingTransparentValue" : xxx (numeric) Value of UTXOs still available for merging.
" remainingNotes" : xxx (numeric) Number of notes still available for merging.
" remainingShieldedValue" : xxx (numeric) Value of notes still available for merging.
" mergingUTXOs" : xxx (numeric) Number of UTXOs being merged.
" mergingTransparentValue" : xxx (numeric) Value of UTXOs being merged.
" mergingNotes" : xxx (numeric) Number of notes being merged.
" mergingShieldedValue" : xxx (numeric) Value of notes being merged.
2019-02-18 20:29:52 -08:00
" opid" : xxx (string) An operationid to pass to z_getoperationstatus to get the result of the operation.
2018-03-08 17:34:40 -08:00
}
Examples:
2019-02-18 20:29:52 -08:00
> zcash-cli z_mergetoaddress ' [" ANY_SAPLING" , " t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" ]' ztestsapling19rnyu293v44f0kvtmszhx35lpdug574twc0lwyf4s7w0umtkrdq5nfcauxrxcyfmh3m7slemqsj
> curl --user myusername --data-binary ' {" jsonrpc" : " 1.0" , " id" :" curltest" , " method" : " z_mergetoaddress" , " params" : [[" ANY_SAPLING" , " t1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd" ], " ztestsapling19rnyu293v44f0kvtmszhx35lpdug574twc0lwyf4s7w0umtkrdq5nfcauxrxcyfmh3m7slemqsj" ] }' -H ' content-type: text/plain;' http://127.0.0.1:8232/
2018-03-08 17:34:40 -08:00
2018-03-09 04:16:57 -08:00
< / pre >
< hr >
2018-03-08 17:34:40 -08:00
< p >
2018-06-10 07:43:39 -07:00
Made by < a href = "https://twitter.com/karel_3d" > @karel_3d< / a > ; license of the docs is MIT (see < a href = "https://github.com/zcash/zcash" > zcash repo< / a > ), license of the scripts and webpage is also MIT ((C) 2018 Karel Bilek) (< a href = "https://github.com/zcash-rpc/zcash-rpc.github.io" > github repo< / a > )
2018-03-08 17:34:40 -08:00
< / p >
< p >
2018-08-20 09:15:35 -07:00
Note it uses a mainnet node
2018-03-08 17:34:40 -08:00
< / p >
< / div >
2018-03-08 18:26:01 -08:00
< div class = "col-4 col-lg-3 col-xl-2" >
2018-03-09 04:16:57 -08:00
< div class = "card" >
< div class = "card-header" >
Blockchain
< / div >
< div class = "card-body" >
< a href = "getbestblockhash.html" > getbestblockhash< / a >
< br >
< a href = "getblock.html" > getblock< / a >
< br >
< a href = "getblockchaininfo.html" > getblockchaininfo< / a >
< br >
< a href = "getblockcount.html" > getblockcount< / a >
< br >
< a href = "getblockhash.html" > getblockhash< / a >
< br >
< a href = "getblockheader.html" > getblockheader< / a >
< br >
< a href = "getchaintips.html" > getchaintips< / a >
< br >
< a href = "getdifficulty.html" > getdifficulty< / a >
< br >
< a href = "getmempoolinfo.html" > getmempoolinfo< / a >
< br >
< a href = "getrawmempool.html" > getrawmempool< / a >
< br >
< a href = "gettxout.html" > gettxout< / a >
< br >
< a href = "gettxoutproof.html" > gettxoutproof< / a >
< br >
< a href = "gettxoutsetinfo.html" > gettxoutsetinfo< / a >
< br >
< a href = "verifychain.html" > verifychain< / a >
< br >
< a href = "verifytxoutproof.html" > verifytxoutproof< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Control
< / div >
< div class = "card-body" >
2018-06-10 07:43:39 -07:00
< a href = "getinfo.html" > getinfo< / a >
2018-03-09 04:16:57 -08:00
< br >
< a href = "help.html" > help< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "stop.html" > stop< / a >
2018-03-09 04:16:57 -08:00
< br >
2018-06-10 07:43:39 -07:00
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Disclosure
< / div >
< div class = "card-body" >
< a href = "z_getpaymentdisclosure.html" > z_getpaymentdisclosure< / a >
2018-03-09 04:16:57 -08:00
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_validatepaymentdisclosure.html" > z_validatepaymentdisclosure< / a >
2018-03-09 04:16:57 -08:00
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Generating
< / div >
< div class = "card-body" >
< a href = "generate.html" > generate< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "getgenerate.html" > getgenerate< / a >
< br >
< a href = "setgenerate.html" > setgenerate< / a >
2018-03-09 04:16:57 -08:00
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Mining
< / div >
< div class = "card-body" >
2018-06-10 07:43:39 -07:00
< a href = "getblocksubsidy.html" > getblocksubsidy< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "getblocktemplate.html" > getblocktemplate< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "getlocalsolps.html" > getlocalsolps< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "getmininginfo.html" > getmininginfo< / a >
< br >
< a href = "getnetworkhashps.html" > getnetworkhashps< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "getnetworksolps.html" > getnetworksolps< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "prioritisetransaction.html" > prioritisetransaction< / a >
< br >
< a href = "submitblock.html" > submitblock< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Network
< / div >
< div class = "card-body" >
< a href = "addnode.html" > addnode< / a >
< br >
< a href = "clearbanned.html" > clearbanned< / a >
< br >
< a href = "disconnectnode.html" > disconnectnode< / a >
< br >
< a href = "getaddednodeinfo.html" > getaddednodeinfo< / a >
< br >
< a href = "getconnectioncount.html" > getconnectioncount< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "getdeprecationinfo.html" > getdeprecationinfo< / a >
< br >
2018-03-09 04:16:57 -08:00
< a href = "getnettotals.html" > getnettotals< / a >
< br >
< a href = "getnetworkinfo.html" > getnetworkinfo< / a >
< br >
< a href = "getpeerinfo.html" > getpeerinfo< / a >
< br >
< a href = "listbanned.html" > listbanned< / a >
< br >
< a href = "ping.html" > ping< / a >
< br >
< a href = "setban.html" > setban< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Rawtransactions
< / div >
< div class = "card-body" >
< a href = "createrawtransaction.html" > createrawtransaction< / a >
< br >
< a href = "decoderawtransaction.html" > decoderawtransaction< / a >
< br >
< a href = "decodescript.html" > decodescript< / a >
< br >
< a href = "fundrawtransaction.html" > fundrawtransaction< / a >
< br >
< a href = "getrawtransaction.html" > getrawtransaction< / a >
< br >
< a href = "sendrawtransaction.html" > sendrawtransaction< / a >
< br >
< a href = "signrawtransaction.html" > signrawtransaction< / a >
< br >
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Util
< / div >
< div class = "card-body" >
< a href = "createmultisig.html" > createmultisig< / a >
< br >
< a href = "estimatefee.html" > estimatefee< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "estimatepriority.html" > estimatepriority< / a >
2018-03-09 04:16:57 -08:00
< br >
< a href = "validateaddress.html" > validateaddress< / a >
< br >
< a href = "verifymessage.html" > verifymessage< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_validateaddress.html" > z_validateaddress< / a >
< br >
2018-03-09 04:16:57 -08:00
< / div >
< / div >
< br >
< div class = "card" >
< div class = "card-header" >
Wallet
< / div >
< div class = "card-body" >
< a href = "addmultisigaddress.html" > addmultisigaddress< / a >
< br >
< a href = "backupwallet.html" > backupwallet< / a >
< br >
< a href = "dumpprivkey.html" > dumpprivkey< / a >
< br >
< a href = "dumpwallet.html" > dumpwallet< / a >
< br >
< a href = "encryptwallet.html" > encryptwallet< / a >
< br >
< a href = "getaccount.html" > getaccount< / a >
< br >
< a href = "getaccountaddress.html" > getaccountaddress< / a >
< br >
< a href = "getaddressesbyaccount.html" > getaddressesbyaccount< / a >
< br >
< a href = "getbalance.html" > getbalance< / a >
< br >
< a href = "getnewaddress.html" > getnewaddress< / a >
< br >
< a href = "getrawchangeaddress.html" > getrawchangeaddress< / a >
< br >
< a href = "getreceivedbyaccount.html" > getreceivedbyaccount< / a >
< br >
< a href = "getreceivedbyaddress.html" > getreceivedbyaddress< / a >
< br >
< a href = "gettransaction.html" > gettransaction< / a >
< br >
< a href = "getunconfirmedbalance.html" > getunconfirmedbalance< / a >
< br >
< a href = "getwalletinfo.html" > getwalletinfo< / a >
< br >
< a href = "importaddress.html" > importaddress< / a >
< br >
< a href = "importprivkey.html" > importprivkey< / a >
< br >
< a href = "importwallet.html" > importwallet< / a >
< br >
< a href = "keypoolrefill.html" > keypoolrefill< / a >
< br >
< a href = "listaccounts.html" > listaccounts< / a >
< br >
< a href = "listaddressgroupings.html" > listaddressgroupings< / a >
< br >
< a href = "listlockunspent.html" > listlockunspent< / a >
< br >
< a href = "listreceivedbyaccount.html" > listreceivedbyaccount< / a >
< br >
< a href = "listreceivedbyaddress.html" > listreceivedbyaddress< / a >
< br >
< a href = "listsinceblock.html" > listsinceblock< / a >
< br >
< a href = "listtransactions.html" > listtransactions< / a >
< br >
< a href = "listunspent.html" > listunspent< / a >
< br >
< a href = "lockunspent.html" > lockunspent< / a >
< br >
< a href = "move.html" > move< / a >
< br >
< a href = "sendfrom.html" > sendfrom< / a >
< br >
< a href = "sendmany.html" > sendmany< / a >
< br >
< a href = "sendtoaddress.html" > sendtoaddress< / a >
< br >
< a href = "setaccount.html" > setaccount< / a >
< br >
< a href = "settxfee.html" > settxfee< / a >
< br >
< a href = "signmessage.html" > signmessage< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_exportkey.html" > z_exportkey< / a >
< br >
< a href = "z_exportviewingkey.html" > z_exportviewingkey< / a >
< br >
< a href = "z_exportwallet.html" > z_exportwallet< / a >
< br >
< a href = "z_getbalance.html" > z_getbalance< / a >
< br >
2019-05-08 13:34:30 -07:00
< a href = "z_getmigrationstatus.html" > z_getmigrationstatus< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_getnewaddress.html" > z_getnewaddress< / a >
< br >
< a href = "z_getoperationresult.html" > z_getoperationresult< / a >
< br >
< a href = "z_getoperationstatus.html" > z_getoperationstatus< / a >
< br >
< a href = "z_gettotalbalance.html" > z_gettotalbalance< / a >
< br >
< a href = "z_importkey.html" > z_importkey< / a >
< br >
< a href = "z_importviewingkey.html" > z_importviewingkey< / a >
< br >
< a href = "z_importwallet.html" > z_importwallet< / a >
< br >
< a href = "z_listaddresses.html" > z_listaddresses< / a >
< br >
< a href = "z_listoperationids.html" > z_listoperationids< / a >
< br >
< a href = "z_listreceivedbyaddress.html" > z_listreceivedbyaddress< / a >
< br >
< a href = "z_listunspent.html" > z_listunspent< / a >
< br >
< a href = "z_mergetoaddress.html" > z_mergetoaddress< / a >
< br >
< a href = "z_sendmany.html" > z_sendmany< / a >
< br >
2019-05-08 13:34:30 -07:00
< a href = "z_setmigration.html" > z_setmigration< / a >
< br >
2018-06-10 07:43:39 -07:00
< a href = "z_shieldcoinbase.html" > z_shieldcoinbase< / a >
< br >
< a href = "zcbenchmark.html" > zcbenchmark< / a >
< br >
< a href = "zcrawjoinsplit.html" > zcrawjoinsplit< / a >
< br >
< a href = "zcrawkeygen.html" > zcrawkeygen< / a >
2018-03-09 04:16:57 -08:00
< br >
2018-06-10 07:43:39 -07:00
< a href = "zcrawreceive.html" > zcrawreceive< / a >
2018-03-09 04:16:57 -08:00
< br >
2018-06-10 07:43:39 -07:00
< a href = "zcsamplejoinsplit.html" > zcsamplejoinsplit< / a >
2018-03-09 04:16:57 -08:00
< br >
< / div >
< / div >
< br >
< / div >
2018-03-08 17:34:40 -08:00
< / div >
2018-03-09 04:16:57 -08:00
< / main >
2018-03-08 17:34:40 -08:00
< / body >
2018-03-09 04:16:57 -08:00
< / html >
