Made by <ahref="https://twitter.com/karel_3d">@karel_3d</a>; license of the docs is MIT (see <ahref="https://github.com/zcash/zcash">zcash repo</a>), license of the scripts and webpage is also MIT ((C) 2018 Karel Bilek) (<ahref="https://github.com/zcash-rpc/zcash-rpc.github.io">github repo</a>)
@ -44,25 +44,27 @@ are unlocked. The RPC call `listlockunspent` can be used to return a list of lo
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
number of UTXOs. Any limit is constrained by the consensus rule defining a maximum transaction size of
100000 bytes before Sapling, and 2000000 bytes once Sapling activates.
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.
Arguments:
1. fromaddresses (string, required) A JSON array with addresses.
1. fromaddresses (array, required) A JSON array with addresses.
The following special strings are accepted inside the array:
- "ANY_TADDR": Merge UTXOs from any t-addrs belonging to the wallet.
- "ANY_SPROUT": Merge notes from any Sprout z-addrs belonging to the wallet.
- "ANY_SAPLING": Merge notes from any Sapling z-addrs belonging to the wallet.
If a special string is given, any given addresses of that type will be ignored.
- "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.
[
"address" (string) Can be a t-addr or a z-addr
"address" (string) Can be a taddr or a zaddr
,...
]
2. "toaddress" (string, required) The t-addr or z-addr to send the funds to.
2. "toaddress" (string, required) The taddr or zaddr 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 node option -mempooltxinputlimit (before Overwinter), or as many as will fit in the transaction (after Overwinter).
4. 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.
5. "memo" (string, optional) Encoded as hex. When toaddress is a z-addr, this will be stored in the memo field of the new note.
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.
Result:
{
@ -74,12 +76,12 @@ Result:
"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.
"opid": xxx (string) An operationid to pass to z_getoperationstatus to get the result of the operation.
Gareth Davies
5 years ago