From 37888c23fc33c2ccd9a7b11a5e2d384ae7c51f5a Mon Sep 17 00:00:00 2001 From: thephez Date: Mon, 9 Oct 2017 12:45:30 -0400 Subject: [PATCH] Add GetBlockHeaders details Minor formatting updates --- _includes/devdoc/dash-core/rpcs/quick-reference.md | 6 +++--- _includes/devdoc/dash-core/rpcs/rpcs/getblockhashes.md | 4 +++- _includes/devdoc/dash-core/rpcs/rpcs/getblockheader.md | 7 +++++++ _includes/helpers/summaries.md | 4 ++-- 4 files changed, 15 insertions(+), 6 deletions(-) diff --git a/_includes/devdoc/dash-core/rpcs/quick-reference.md b/_includes/devdoc/dash-core/rpcs/quick-reference.md index 8564eef2..93905b56 100644 --- a/_includes/devdoc/dash-core/rpcs/quick-reference.md +++ b/_includes/devdoc/dash-core/rpcs/quick-reference.md @@ -20,7 +20,7 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing. {% assign DASH_NOT_IMPLEMENTED='**Not Implemented**' %} -{% assign DASH_NEW0_12_1='*New in Dash Core 0.12.0*' %} +{% assign DASH_NEW0_12_1='*New in Dash Core 0.12.1*' %} {% assign DASH_UPDATED0_12_1='**Updated in Dash Core 0.12.1**' %} @@ -84,9 +84,9 @@ These RPCs are all Dash-specific and not found in Bitcoin Core * [GetBlockChainInfo][rpc getblockchaininfo]: {{summary_getBlockChainInfo}} {{UPDATED0_12_1}} * [GetBlockCount][rpc getblockcount]: {{summary_getBlockCount}} * [GetBlockHash][rpc getblockhash]: {{summary_getBlockHash}} - * [GetBlockHashes][rpc getblockhashes]: {{summary_getBlockHashes}} +* [GetBlockHashes][rpc getblockhashes]: {{summary_getBlockHashes}} {{DASH_NEW0_12_1}} * [GetBlockHeader][rpc getblockheader]: {{summary_getBlockHeader}} {{NEW0_12_0}} - * [GetBlockHeaders][rpc getblockheaders]: {{summary_getBlockHeaders}} +* [GetBlockHeaders][rpc getblockheaders]: {{summary_getBlockHeaders}} {{DASH_NEW0_12_1}} * [GetChainTips][rpc getchaintips]: {{summary_getChainTips}} {{DASH_UPDATED0_12_1}} * [GetDifficulty][rpc getdifficulty]: {{summary_getDifficultly}} * [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} {{UPDATED0_12_0}} diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/getblockhashes.md b/_includes/devdoc/dash-core/rpcs/rpcs/getblockhashes.md index 3100f399..2f732fbc 100644 --- a/_includes/devdoc/dash-core/rpcs/rpcs/getblockhashes.md +++ b/_includes/devdoc/dash-core/rpcs/rpcs/getblockhashes.md @@ -7,10 +7,12 @@ http://opensource.org/licenses/MIT. ##### GetBlockHashes {% include helpers/subhead-links.md %} -{% assign summary_getBlockHashes="returns array of hashes of blocks within the timestamp range provided." %} +{% assign summary_getBlockHashes="returns array of hashes of blocks within the timestamp range provided (requires `timestampindex` to be enabled)." %} {% autocrossref %} +*Added in Dash Core 0.12.1* + The `getblockhashes` RPC {{summary_getBlockHashes}} *Parameter #1---high block timestamp* diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/getblockheader.md b/_includes/devdoc/dash-core/rpcs/rpcs/getblockheader.md index 38662b76..75b4d0fa 100644 --- a/_includes/devdoc/dash-core/rpcs/rpcs/getblockheader.md +++ b/_includes/devdoc/dash-core/rpcs/rpcs/getblockheader.md @@ -78,6 +78,11 @@ The `getblockheader` RPC {{summary_getBlockHeader}} p: "Required
(exactly 1)" d: "The merkle root for this block, encoded as hex in RPC byte order" +- n: "→
`time`" + t: "number (int)" + p: "Required
(exactly 1)" + d: "The time of the block" + - n: "→
`mediantime`" t: "number (int)" p: "Required
(exactly 1)" @@ -178,6 +183,8 @@ Result: * [GetBlock][rpc getblock]: {{summary_getBlock}} * [GetBlockHash][rpc getblockhash]: {{summary_getBlockHash}} +* [GetBlockHashes][rpc getblockhashes]: {{summary_getBlockHashes}} +* [GetBlockHeaders][rpc getblockheaders]: {{summary_getBlockHeaders}} * [GetBestBlockHash][rpc getbestblockhash]: {{summary_getBestBlockHash}} {% endautocrossref %} diff --git a/_includes/helpers/summaries.md b/_includes/helpers/summaries.md index 721dfe7e..102dcaf5 100644 --- a/_includes/helpers/summaries.md +++ b/_includes/helpers/summaries.md @@ -35,9 +35,9 @@ This file is licensed under the terms of its source texts{%endcomment%} {% assign summary_getBlockChainInfo="provides information about the current state of the block chain." %} {% assign summary_getBlockCount="returns the number of blocks in the local best block chain." %} {% assign summary_getBlockHash="returns the header hash of a block at the given height in the local best block chain." %} -{% assign summary_getBlockHashes= %} +{% assign summary_getBlockHashes="returns array of hashes of blocks within the timestamp range provided (requires `timestampindex` to be enabled)." %} {% assign summary_getBlockHeader="gets a block header with a particular header hash from the local block database either as a JSON object or as a serialized block header." %} -{% assign summary_getBlockHeaders= %} +{% assign summary_getBlockHeaders="returns an array of items with information about the requested number of blockheaders starting from the requested hash." %} {% assign summary_getBlockTemplate="gets a block template or proposal for use with mining software." %} {% assign summary_getChainTips="returns information about the highest-height block (tip) of each local block chain." %} {% assign summary_getConnectionCount="returns the number of connections to other nodes." %}