mirror of https://github.com/zcash/rpc.git
615 lines
23 KiB
HTML
615 lines
23 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=1200px, shrink-to-fit=yes">
|
|
<meta name="description" content="Zcash 5.10.0 RPC Docs - getblock">
|
|
<meta name="author" content="">
|
|
<title>getblock - Zcash 6.0.0 RPC Docs</title>
|
|
<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 ">
|
|
<a class="navbar-brand" href="/">Zcash 5.10.0 RPC Docs</a>
|
|
</nav>
|
|
|
|
<main role="main" class="container-fluid" style="margin-top: 1pc;">
|
|
|
|
<div class="row">
|
|
<div class="col-8 col-lg-9 col-xl-10">
|
|
<h1>getblock - Zcash 5.10.0 RPC</h1>
|
|
|
|
<pre>getblock "hash|height" ( verbosity )
|
|
|
|
If verbosity is 0, returns a string that is serialized, hex-encoded data for the block.
|
|
If verbosity is 1, returns an Object with information about the block.
|
|
If verbosity is 2, returns an Object with information about the block and information about each transaction.
|
|
|
|
Arguments:
|
|
1. "hash|height" (string, required) The block hash or height. Height can be negative where -1 is the last known valid block
|
|
2. verbosity (numeric, optional, default=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data
|
|
|
|
Result (for verbosity = 0):
|
|
"data" (string) A string that is serialized, hex-encoded data for the block.
|
|
|
|
Result (for verbosity = 1):
|
|
{
|
|
"hash" : "hash", (string) the block hash (same as provided hash)
|
|
"confirmations" : n, (numeric) The number of confirmations, or -1 if the block is not on the main chain
|
|
"size" : n, (numeric) The block size
|
|
"height" : n, (numeric) The block height or index (same as provided height)
|
|
"version" : n, (numeric) The block version
|
|
"merkleroot" : "xxxx", (string) The merkle root
|
|
"finalsaplingroot" : "xxxx", (string) The root of the Sapling commitment tree after applying this block
|
|
"finalorchardroot" : "xxxx", (string, optional) The root of the Orchard commitment tree after
|
|
applying this block. Omitted for blocks prior to NU5 activation. This
|
|
will be the null hash if this block has never been connected to a
|
|
main chain.
|
|
NB: The serialized representation of this field returned by this method
|
|
was byte-flipped relative to its representation in the `getrawtransaction`
|
|
output in prior releases up to and including v5.2.0. This has now been
|
|
rectified.
|
|
"tx" : [ (array of string) The transaction ids
|
|
"transactionid" (string) The transaction id
|
|
,...
|
|
],
|
|
"time" : ttt, (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
|
|
"nonce" : n, (numeric) The nonce
|
|
"bits" : "1d00ffff", (string) The bits
|
|
"difficulty" : x.xxx, (numeric) The difficulty
|
|
"chainSupply": { (object) information about the total supply
|
|
"monitored": xx, (boolean) true if the total supply is being monitored
|
|
"chainValue": xxxxxx, (numeric, optional) total chain supply after this block, in ZEC
|
|
"chainValueZat": xxxxxx, (numeric, optional) total chain supply after this block, in zatoshis
|
|
"valueDelta": xxxxxx, (numeric, optional) change to the chain supply produced by this block, in ZEC
|
|
"valueDeltaZat": xxxxxx, (numeric, optional) change to the chain supply produced by this block, in zatoshis
|
|
},
|
|
"valuePools": [ (array) information about each value pool
|
|
{
|
|
"id": "xxxx", (string) name of the pool
|
|
"monitored": xx, (boolean) true if the pool is being monitored
|
|
"chainValue": xxxxxx, (numeric, optional) total amount in the pool, in ZEC
|
|
"chainValueZat": xxxxxx, (numeric, optional) total amount in the pool, in zatoshis
|
|
"valueDelta": xxxxxx, (numeric, optional) change to the amount in the pool produced by this block, in ZEC
|
|
"valueDeltaZat": xxxxxx, (numeric, optional) change to the amount in the pool produced by this block, in zatoshis
|
|
}, ...
|
|
],
|
|
"trees": { (object) information about the note commitment trees
|
|
"sapling": { (object, optional)
|
|
"size": n, (numeric) the total number of Sapling note commitments as of the end of this block
|
|
},
|
|
"orchard": { (object, optional)
|
|
"size": n, (numeric) the total number of Orchard note commitments as of the end of this block
|
|
},
|
|
},
|
|
"previousblockhash" : "hash", (string) The hash of the previous block
|
|
"nextblockhash" : "hash" (string) The hash of the next block
|
|
}
|
|
|
|
Result (for verbosity = 2):
|
|
{
|
|
..., Same output as verbosity = 1.
|
|
"tx" : [ (array of Objects) The transactions in the format of the getrawtransaction RPC. Different from verbosity = 1 "tx" result.
|
|
,...
|
|
],
|
|
,... Same output as verbosity = 1.
|
|
}
|
|
|
|
Examples:
|
|
> zcash-cli getblock "00000000febc373a1da2bd9f887b105ad79ddc26ac26c2b28652d64e5207c5b5"
|
|
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblock", "params": ["00000000febc373a1da2bd9f887b105ad79ddc26ac26c2b28652d64e5207c5b5"] }' -H 'content-type: text/plain;' http://127.0.0.1:8232/
|
|
> zcash-cli getblock 12800
|
|
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblock", "params": [12800] }' -H 'content-type: text/plain;' http://127.0.0.1:8232/
|
|
|
|
</pre>
|
|
<hr>
|
|
|
|
<p>
|
|
Maintained by <a href="https://twitter.com/_garethtdavies">@_garethtdavies</a>; modified by: <a href="https://github.com/mdr0id">mdr0id</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 (<a href="https://github.com/zcash-rpc/zcash-rpc.github.io">github repo</a>)
|
|
</p>
|
|
<p>
|
|
Note it uses a mainnet zcash node
|
|
</p>
|
|
</div>
|
|
<div class="col-4 col-lg-3 col-xl-2">
|
|
|
|
<div class="card">
|
|
<div class="card-header">
|
|
Addressindex
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<a href="getaddressbalance.html">getaddressbalance</a>
|
|
<br>
|
|
|
|
<a href="getaddressdeltas.html">getaddressdeltas</a>
|
|
<br>
|
|
|
|
<a href="getaddressmempool.html">getaddressmempool</a>
|
|
<br>
|
|
|
|
<a href="getaddresstxids.html">getaddresstxids</a>
|
|
<br>
|
|
|
|
<a href="getaddressutxos.html">getaddressutxos</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
<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="getblockdeltas.html">getblockdeltas</a>
|
|
<br>
|
|
|
|
<a href="getblockhash.html">getblockhash</a>
|
|
<br>
|
|
|
|
<a href="getblockhashes.html">getblockhashes</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="getspentinfo.html">getspentinfo</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>
|
|
|
|
<a href="z_getsubtreesbyindex.html">z_getsubtreesbyindex</a>
|
|
<br>
|
|
|
|
<a href="z_gettreestate.html">z_gettreestate</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
<div class="card">
|
|
<div class="card-header">
|
|
Control
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<a href="getexperimentalfeatures.html">getexperimentalfeatures</a>
|
|
<br>
|
|
|
|
<a href="getinfo.html">getinfo</a>
|
|
<br>
|
|
|
|
<a href="getmemoryinfo.html">getmemoryinfo</a>
|
|
<br>
|
|
|
|
<a href="help.html">help</a>
|
|
<br>
|
|
|
|
<a href="setlogfilter.html">setlogfilter</a>
|
|
<br>
|
|
|
|
<a href="stop.html">stop</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
<div class="card">
|
|
<div class="card-header">
|
|
Disclosure
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<a href="z_getpaymentdisclosure.html">z_getpaymentdisclosure</a>
|
|
<br>
|
|
|
|
<a href="z_validatepaymentdisclosure.html">z_validatepaymentdisclosure</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
<div class="card">
|
|
<div class="card-header">
|
|
Generating
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<a href="generate.html">generate</a>
|
|
<br>
|
|
|
|
<a href="getgenerate.html">getgenerate</a>
|
|
<br>
|
|
|
|
<a href="setgenerate.html">setgenerate</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
<div class="card">
|
|
<div class="card-header">
|
|
Mining
|
|
</div>
|
|
<div class="card-body">
|
|
|
|
<a href="getblocksubsidy.html">getblocksubsidy</a>
|
|
<br>
|
|
|
|
<a href="getblocktemplate.html">getblocktemplate</a>
|
|
<br>
|
|
|
|
<a href="getlocalsolps.html">getlocalsolps</a>
|
|
<br>
|
|
|
|
<a href="getmininginfo.html">getmininginfo</a>
|
|
<br>
|
|
|
|
<a href="getnetworkhashps.html">getnetworkhashps</a>
|
|
<br>
|
|
|
|
<a href="getnetworksolps.html">getnetworksolps</a>
|
|
<br>
|
|
|
|
<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>
|
|
|
|
<a href="getdeprecationinfo.html">getdeprecationinfo</a>
|
|
<br>
|
|
|
|
<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="validateaddress.html">validateaddress</a>
|
|
<br>
|
|
|
|
<a href="verifymessage.html">verifymessage</a>
|
|
<br>
|
|
|
|
<a href="z_validateaddress.html">z_validateaddress</a>
|
|
<br>
|
|
|
|
</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="encryptwallet.html">encryptwallet</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="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="importpubkey.html">importpubkey</a>
|
|
<br>
|
|
|
|
<a href="importwallet.html">importwallet</a>
|
|
<br>
|
|
|
|
<a href="keypoolrefill.html">keypoolrefill</a>
|
|
<br>
|
|
|
|
<a href="listaddresses.html">listaddresses</a>
|
|
<br>
|
|
|
|
<a href="listaddressgroupings.html">listaddressgroupings</a>
|
|
<br>
|
|
|
|
<a href="listlockunspent.html">listlockunspent</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="sendmany.html">sendmany</a>
|
|
<br>
|
|
|
|
<a href="sendtoaddress.html">sendtoaddress</a>
|
|
<br>
|
|
|
|
<a href="settxfee.html">settxfee</a>
|
|
<br>
|
|
|
|
<a href="signmessage.html">signmessage</a>
|
|
<br>
|
|
|
|
<a href="walletconfirmbackup.html">walletconfirmbackup</a>
|
|
<br>
|
|
|
|
<a href="z_converttex.html">z_converttex</a>
|
|
<br>
|
|
|
|
<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_getaddressforaccount.html">z_getaddressforaccount</a>
|
|
<br>
|
|
|
|
<a href="z_getbalance.html">z_getbalance</a>
|
|
<br>
|
|
|
|
<a href="z_getbalanceforaccount.html">z_getbalanceforaccount</a>
|
|
<br>
|
|
|
|
<a href="z_getbalanceforviewingkey.html">z_getbalanceforviewingkey</a>
|
|
<br>
|
|
|
|
<a href="z_getmigrationstatus.html">z_getmigrationstatus</a>
|
|
<br>
|
|
|
|
<a href="z_getnewaccount.html">z_getnewaccount</a>
|
|
<br>
|
|
|
|
<a href="z_getnewaddress.html">z_getnewaddress</a>
|
|
<br>
|
|
|
|
<a href="z_getnotescount.html">z_getnotescount</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_listaccounts.html">z_listaccounts</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_listunifiedreceivers.html">z_listunifiedreceivers</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>
|
|
|
|
<a href="z_setmigration.html">z_setmigration</a>
|
|
<br>
|
|
|
|
<a href="z_shieldcoinbase.html">z_shieldcoinbase</a>
|
|
<br>
|
|
|
|
<a href="z_viewtransaction.html">z_viewtransaction</a>
|
|
<br>
|
|
|
|
<a href="zcbenchmark.html">zcbenchmark</a>
|
|
<br>
|
|
|
|
<a href="zcsamplejoinsplit.html">zcsamplejoinsplit</a>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
<br>
|
|
|
|
</div>
|
|
</div>
|
|
</main>
|
|
</body>
|
|
</html>
|