zec
/
zcash.rpc.github.io
mirror of https://github.com/zcash/zcash.rpc.github.io.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #1 from garethtdavies/v2.0.1 

V2.0.1
This commit is contained in:
Karel Bílek 2018-10-19 16:27:11 +07:00 committed by GitHub
parent bb2aac3fbb c8b63c1c5c
commit 021a348164
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
getwalletinfo.html
View File

@ -48,6 +48,7 @@ Result:
"keypoolsize": xxxx, (numeric) how many new keys are pre-generated "keypoolsize": xxxx, (numeric) how many new keys are pre-generated
"unlocked_until": ttt, (numeric) the timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked "unlocked_until": ttt, (numeric) the timestamp in seconds since epoch (midnight Jan 1 1970 GMT) that the wallet is unlocked for transfers, or 0 if the wallet is locked
"paytxfee": x.xxxx, (numeric) the transaction fee configuration, set in ZEC/kB "paytxfee": x.xxxx, (numeric) the transaction fee configuration, set in ZEC/kB
"seedfp": "uint256", (string) the BLAKE2b-256 hash of the HD seed
} }
Examples: Examples:

8
script/template.html
View File

@ -3,10 +3,10 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="width=1200px, shrink-to-fit=yes"> <meta name="viewport" content="width=1200px, shrink-to-fit=yes">
<meta name="description" content="Zcash 2.0.0 RPC Docs{{if .Command}} - {{.Command.Name}}{{end}}"> <meta name="description" content="Zcash 2.0.1 RPC Docs{{if .Command}} - {{.Command.Name}}{{end}}">
<meta name="author" content=""> <meta name="author" content="">
<title>{{if .Command}}{{.Command.Name}} - {{end}}Zcash 2.0.0 RPC Docs</title> <title>{{if .Command}}{{.Command.Name}} - {{end}}Zcash 2.0.1 RPC Docs</title>
<link href="./bootstrap.min.css" rel="stylesheet"> <link href="./bootstrap.min.css" rel="stylesheet">
</head> </head>
@ -25,14 +25,14 @@
<nav class="navbar navbar-dark bg-dark "> <nav class="navbar navbar-dark bg-dark ">
<a class="navbar-brand" href="/">Zcash 2.0.0 RPC docs</a> <a class="navbar-brand" href="/">Zcash 2.0.1 RPC docs</a>
</nav> </nav>
<main role="main" class="container-fluid" style="margin-top: 1pc;"> <main role="main" class="container-fluid" style="margin-top: 1pc;">
<div class="row"> <div class="row">
<div class="col-8 col-lg-9 col-xl-10"> <div class="col-8 col-lg-9 col-xl-10">
<h1>{{if .Command}}{{.Command.Name}} - {{end}}Zcash 2.0.0 RPC</h1> <h1>{{if .Command}}{{.Command.Name}} - {{end}}Zcash 2.0.1 RPC</h1>
{{if .Command}} {{if .Command}}
<pre>{{.Command.Description}}</pre> <pre>{{.Command.Description}}</pre>
<hr> <hr>

1
signrawtransaction.html
View File

@ -68,6 +68,7 @@ Arguments:
&#34;ALL|ANYONECANPAY&#34; &#34;ALL|ANYONECANPAY&#34;
&#34;NONE|ANYONECANPAY&#34; &#34;NONE|ANYONECANPAY&#34;
&#34;SINGLE|ANYONECANPAY&#34; &#34;SINGLE|ANYONECANPAY&#34;
5. &#34;branchid&#34; (string, optional) The hex representation of the consensus branch id to sign with. This can be used to force signing with consensus rules that are ahead of the node&#39;s current height.
Result: Result:
{ {

4
z_getbalance.html
View File

@ -38,8 +38,8 @@
Returns the balance of a taddr or zaddr belonging to the node’s wallet. Returns the balance of a taddr or zaddr belonging to the node’s wallet.
CAUTION: If address is a watch-only zaddr, the returned balance may be larger than the actual balance, CAUTION: If the wallet has only an incoming viewing key for this address, then spends cannot be
because spends cannot be detected with incoming viewing keys. detected, and so the returned balance may be larger than the actual balance.
Arguments: Arguments:
1. &#34;address&#34; (string) The selected address. It may be a transparent or private address. 1. &#34;address&#34; (string) The selected address. It may be a transparent or private address.

7
z_gettotalbalance.html
View File

@ -38,8 +38,9 @@
Return the total value of funds stored in the node’s wallet. Return the total value of funds stored in the node’s wallet.
CAUTION: If the wallet contains watch-only zaddrs, the returned private balance may be larger than the actual balance, CAUTION: If the wallet contains any addresses for which it only has incoming viewing keys,
because spends cannot be detected with incoming viewing keys. the returned private balance may be larger than the actual balance, because spends cannot
be detected with incoming viewing keys.
Arguments: Arguments:
1. minconf (numeric, optional, default=1) Only include private and transparent transactions confirmed at least this many times. 1. minconf (numeric, optional, default=1) Only include private and transparent transactions confirmed at least this many times.
@ -48,7 +49,7 @@ Arguments:
Result: Result:
{ {
&#34;transparent&#34;: xxxxx, (numeric) the total balance of transparent funds &#34;transparent&#34;: xxxxx, (numeric) the total balance of transparent funds
&#34;private&#34;: xxxxx, (numeric) the total balance of private funds &#34;private&#34;: xxxxx, (numeric) the total balance of private funds (in both Sprout and Sapling addresses)
&#34;total&#34;: xxxxx, (numeric) the total balance of both transparent and private funds &#34;total&#34;: xxxxx, (numeric) the total balance of both transparent and private funds
} }

8
z_listunspent.html
View File

@ -40,13 +40,14 @@ Returns array of unspent shielded notes with between minconf and maxconf (inclus
Optionally filter to only include notes sent to specified addresses. Optionally filter to only include notes sent to specified addresses.
When minconf is 0, unspent notes with zero confirmations are returned, even though they are not immediately spendable. When minconf is 0, unspent notes with zero confirmations are returned, even though they are not immediately spendable.
Results are an array of Objects, each of which has: Results are an array of Objects, each of which has:
{txid, jsindex, jsoutindex, confirmations, address, amount, memo} {txid, jsindex, jsoutindex, confirmations, address, amount, memo} (Sprout)
{txid, outindex, confirmations, address, amount, memo} (Sapling)
Arguments: Arguments:
1. minconf (numeric, optional, default=1) The minimum confirmations to filter 1. minconf (numeric, optional, default=1) The minimum confirmations to filter
2. maxconf (numeric, optional, default=9999999) The maximum confirmations to filter 2. maxconf (numeric, optional, default=9999999) The maximum confirmations to filter
3. includeWatchonly (bool, optional, default=false) Also include watchonly addresses (see &#39;z_importviewingkey&#39;) 3. includeWatchonly (bool, optional, default=false) Also include watchonly addresses (see &#39;z_importviewingkey&#39;)
4. &#34;addresses&#34; (string) A json array of zaddrs to filter on. Duplicate addresses not allowed. 4. &#34;addresses&#34; (string) A json array of zaddrs (both Sprout and Sapling) to filter on. Duplicate addresses not allowed.
[ [
&#34;address&#34; (string) zaddr &#34;address&#34; (string) zaddr
,... ,...
@ -57,7 +58,8 @@ Result
{ {
&#34;txid&#34; : &#34;txid&#34;, (string) the transaction id &#34;txid&#34; : &#34;txid&#34;, (string) the transaction id
&#34;jsindex&#34; : n (numeric) the joinsplit index &#34;jsindex&#34; : n (numeric) the joinsplit index
&#34;jsoutindex&#34; : n (numeric) the output index of the joinsplit &#34;jsoutindex&#34; (sprout) : n (numeric) the output index of the joinsplit
&#34;outindex&#34; (sapling) : n (numeric) the output index
&#34;confirmations&#34; : n (numeric) the number of confirmations &#34;confirmations&#34; : n (numeric) the number of confirmations
&#34;spendable&#34; : true|false (boolean) true if note can be spent by wallet, false if note has zero confirmations, false if address is watchonly &#34;spendable&#34; : true|false (boolean) true if note can be spent by wallet, false if note has zero confirmations, false if address is watchonly
&#34;address&#34; : &#34;address&#34;, (string) the shielded address &#34;address&#34; : &#34;address&#34;, (string) the shielded address

2
z_sendmany.html
View File

@ -37,7 +37,7 @@
<pre>z_sendmany &#34;fromaddress&#34; [{&#34;address&#34;:... ,&#34;amount&#34;:...},...] ( minconf ) ( fee ) <pre>z_sendmany &#34;fromaddress&#34; [{&#34;address&#34;:... ,&#34;amount&#34;:...},...] ( minconf ) ( fee )
Send multiple times. Amounts are double-precision floating point numbers. Send multiple times. Amounts are double-precision floating point numbers.
Change from a taddr flows to a new taddr address, while change from zaddr returns to itself. Change generated from a taddr flows to a new taddr address, while change generated from a zaddr returns to itself.
When sending coinbase UTXOs to a zaddr, change is not allowed. The entire value of the UTXO(s) must be consumed. When sending coinbase UTXOs to a zaddr, change is not allowed. The entire value of the UTXO(s) must be consumed.
Before Sapling activates, the maximum number of zaddr outputs is 54 due to transaction size limits. Before Sapling activates, the maximum number of zaddr outputs is 54 due to transaction size limits.