z_mergetoaddress - Hush 3.10.0 RPC
z_mergetoaddress ["fromaddress", ... ] "toaddress" ( fee ) ( transparent_limit ) ( shielded_limit ) ( memo )
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.
Arguments:
1. fromaddresses (string, required) A JSON array with addresses.
The following special strings are accepted inside the array:
- "*": Merge both UTXOs and notes from all addresses belonging to the wallet.
- "ANY_TADDR": Merge UTXOs from all t-addrs belonging to the wallet.
- "ANY_ZADDR": Merge notes from all z-addrs belonging to the wallet.
If a special string is given, any given addresses of that type will be ignored.
[
"address" (string) Can be a t-addr or a z-addr
,...
]
2. "toaddress" (string, required) The t-addr or z-addr to send the funds to.
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 as many as will fit in the transaction.
4. shielded_limit (numeric, optional, default=90 Sapling Notes) Limit on the maximum number of notes to merge. Set to 0 to merge as many as will fit in the transaction.
5. maximum_utxo_size (numeric, optional) eg, 0.0001 anything under 10000 satoshies will be merged, ignores 10,000 sat p2pk utxo that dragon uses, and merges coinbase utxo.
6. "memo" (string, optional) Encoded as hex. When toaddress is a z-addr, this will be stored in the memo field of the new note.
Result:
{
"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.
"opid": xxx (string) An operationid to pass to z_getoperationstatus to get the result of the operation.
}
Examples:
> hush-cli z_mergetoaddress '["RD6GgnrMpPaTSMn8vai6yiGA7mN4QGPV"]' zs1aW34Gj9FrnGUEf833ywDVL62NWXBM81u6EQnM6VR45eYnXhwztecW1SjxA7JrmAXKJhxhj3vDNEpVCQoSvVoSpmbhtjf
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "z_mergetoaddress", "params": [["RD6GgnrMpPaTSMn8vai6yiGA7mN4QGPV"], "zs1aW34Gj9FrnGUEf833ywDVL62NWXBM81u6EQnM6VR45eYnXhwztecW1SjxA7JrmAXKJhxhj3vDNEpVCQoSvVoSpmbhtjf"] }' -H 'content-type: text/plain;' http://127.0.0.1:18031/
Maintained by The Hush Developers
Welcome to the Hush full node RPC developer documentation!!! You finally made it.
CClib
Addressindex
Auction
Blockchain
coinsupply
getbestblockhash
getblock
getblockchaininfo
getblockcount
getblockhash
getblockhashes
getblockheader
getblockmerkletree
getchaintips
getchaintxstats
getdifficulty
getmempoolinfo
getrawmempool
getspentinfo
gettxout
gettxoutproof
gettxoutsetinfo
kvsearch
kvupdate
minerids
notaries
verifychain
verifytxoutproof
getbestblockhash
getblock
getblockchaininfo
getblockcount
getblockhash
getblockhashes
getblockheader
getblockmerkletree
getchaintips
getchaintxstats
getdifficulty
getmempoolinfo
getrawmempool
getspentinfo
gettxout
gettxoutproof
gettxoutsetinfo
kvsearch
kvupdate
minerids
notaries
verifychain
verifytxoutproof
Channels
Crosschain
MoMoMdata
assetchainproof
calc_MoM
getNotarizationsForBlock
getimports
getwalletburntransactions
height_MoM
importdual
importgatewaybind
importgatewaycompletesigning
importgatewayddress
importgatewaydeposit
importgatewaybind
importgatewaymarkdone
importgatewayspartialsign
importgatewaypendingwithdraws
importgatewayprocessed
importgatewaywithdraw
migrate_checkburntransactionsource
migrate_completeimporttransaction
migrate_converttoexport
migrate_createburntransaction
migrate_createimporttransaction
migrate_createnotaryapprovaltransaction
scanNotarizationsDB
selfimport
assetchainproof
calc_MoM
getNotarizationsForBlock
getimports
getwalletburntransactions
height_MoM
importdual
importgatewaybind
importgatewaycompletesigning
importgatewayddress
importgatewaydeposit
importgatewaybind
importgatewaymarkdone
importgatewayspartialsign
importgatewaypendingwithdraws
importgatewayprocessed
importgatewaywithdraw
migrate_checkburntransactionsource
migrate_completeimporttransaction
migrate_converttoexport
migrate_createburntransaction
migrate_createimporttransaction
migrate_createnotaryapprovaltransaction
scanNotarizationsDB
selfimport
Gateways
Generating
Lotto
Mining
NSPV
Network
Oracles
Payments
Pegs
Rawtransactions
Rewards
Tokens
Util
Wallet
abortrescan
addmultisigaddress
backupwallet
cleanwallettransactions
convertpassphrase
dumpprivkey
dumpwallet
encryptwallet
getaccount
getaccountaddress
getaddressesbyaccount
getalldata
getbalance
getnewaddress
getrawchangeaddress
getreceivedbyaccount
getreceivedbyaddress
getrescaninfo
gettransaction
getunconfirmedbalance
getwalletinfo
importaddress
importprivkey
importwallet
keypoolrefill
listaccounts
listaddresses
listaddressgroupings
listlockunspent
listreceivedbyaccount
listreceivedbyaddress
listsinceblock
listtransactions
listunspent
lockunspent
move
opreturn_burn
rescan
resendwallettransactions
sendfrom
sendmany
sendtoaddress
setaccount
setpubkey
settxfee
signmessage
z_anonsetblockdelta
z_anonsettxdelta
z_consolidationstatus
z_exportkey
z_exportviewingkey
z_exportwallet
z_getbalance
z_getbalances
z_getinfo
z_getnewaddress
z_getnotescount
z_getoperationresult
z_getoperationstatus
z_getstats
z_gettotalbalance
z_importkey
z_importviewingkey
z_importwallet
z_listaddresses
z_listnullifiers
z_listoperationids
z_listreceivedaddress
z_listreceivedbyaddress
z_listsentbyaddress
z_listunspent
z_mergetoaddress
z_sendmany
z_shieldcoinbase
z_sweepstatus
z_viewtransaction
addmultisigaddress
backupwallet
cleanwallettransactions
convertpassphrase
dumpprivkey
dumpwallet
encryptwallet
getaccount
getaccountaddress
getaddressesbyaccount
getalldata
getbalance
getnewaddress
getrawchangeaddress
getreceivedbyaccount
getreceivedbyaddress
getrescaninfo
gettransaction
getunconfirmedbalance
getwalletinfo
importaddress
importprivkey
importwallet
keypoolrefill
listaccounts
listaddresses
listaddressgroupings
listlockunspent
listreceivedbyaccount
listreceivedbyaddress
listsinceblock
listtransactions
listunspent
lockunspent
move
opreturn_burn
rescan
resendwallettransactions
sendfrom
sendmany
sendtoaddress
setaccount
setpubkey
settxfee
signmessage
z_anonsetblockdelta
z_anonsettxdelta
z_consolidationstatus
z_exportkey
z_exportviewingkey
z_exportwallet
z_getbalance
z_getbalances
z_getinfo
z_getnewaddress
z_getnotescount
z_getoperationresult
z_getoperationstatus
z_getstats
z_gettotalbalance
z_importkey
z_importviewingkey
z_importwallet
z_listaddresses
z_listnullifiers
z_listoperationids
z_listreceivedaddress
z_listreceivedbyaddress
z_listsentbyaddress
z_listunspent
z_mergetoaddress
z_sendmany
z_shieldcoinbase
z_sweepstatus
z_viewtransaction