Merge #526: Adding RPC documentation

8572871 Cleanup RPC doc generating script (Karel Bilek)
7625ce8 RPC ToC is expanded without JS (Karel Bilek)
5c56a0f Generated RPC docs 0.16.0 (Karel Bilek)
24d6530 Add RPC doc blurb into contrib readme (Karel Bilek)
b6235fc Correcting strange CSS bug with menu overlap (Karel Bilek)
2846d12 RPC doc to dev menu (Karel Bilek)
b6e50f4 RPC indexes (Karel Bilek)
c218e2f Style for generated RPC docs (Karel Bilek)
ecf0a91 Layouts + header for generated RPC docs (Karel Bilek)
c29ee3d RPC doc as a collection in config (Karel Bilek)
37c1494 Golang script for generating RPC docs (Karel Bilek)
ef3cf45 Prepare JS, SASS, layout for more headers in TOC (Karel Bilek)

Pull request description:

  I have added auto-generated RPC docs.

  I think the best place for Bitcoin Core documentation is Bitcoin Core website.

  The script is in doc-gen folder.

  I have reused ToC component for the RPC list; this needed some change in the javascript. I unfortunately needed to edit the minified javascript by hand (see #525)

  It looks fairly good in my opinion.

Tree-SHA512: 0a1052248c1d8647532abd86dcaf16e39f9ff4651f6cb978b90aa1ba8e5ea33ceea199031c55fda70a7e365a43812de6c4b8dc7f7a5004beb900ac8b4223540d

Author: harding

_config.yml

@@ -81,7 +81,16 @@ defaults:
       layout: page
       lang: en
       share: true
+  - scope:
+      path: ""
+      type: doc
+    values:
+      layout: doc
+      lang: en
+      share: true
 
 collections:
   releases:
     output: true
+  doc:
+    output: true

_doc/en/0.16.0/index.html

@@ -0,0 +1,8 @@
+---
+name: index
+btcversion: 0.16.0
+btcgroup: index
+permalink: en/doc/0.16.0/
+---
+
+

_doc/en/0.16.0/rpc/blockchain/getbestblockhash.html

@@ -0,0 +1,19 @@
+---
+name: getbestblockhash
+btcversion: 0.16.0
+btcgroup: blockchain
+permalink: en/doc/0.16.0/rpc/blockchain/getbestblockhash/
+---
+
+getbestblockhash
+
+Returns the hash of the best (tip) block in the longest blockchain.
+
+Result:
+"hex"      (string) the block hash hex encoded
+
+Examples:
+> bitcoin-cli getbestblockhash 
+> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbestblockhash", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
+
+

_doc/en/0.16.0/rpc/blockchain/getblock.html

@@ -0,0 +1,59 @@
+---
+name: getblock
+btcversion: 0.16.0
+btcgroup: blockchain
+permalink: en/doc/0.16.0/rpc/blockchain/getblock/
+---
+
+getblock "blockhash" ( verbosity ) 
+
+If verbosity is 0, returns a string that is serialized, hex-encoded data for block 'hash'.
+If verbosity is 1, returns an Object with information about block <hash>.
+If verbosity is 2, returns an Object with information about block <hash> and information about each transaction. 
+
+Arguments:
+1. "blockhash"          (string, required) The block hash
+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 block 'hash'.
+
+Result (for verbosity = 1):
+{
+  "hash" : "hash",     (string) the block hash (same as provided)
+  "confirmations" : n,   (numeric) The number of confirmations, or -1 if the block is not on the main chain
+  "size" : n,            (numeric) The block size
+  "strippedsize" : n,    (numeric) The block size excluding witness data
+  "weight" : n           (numeric) The block weight as defined in BIP 141
+  "height" : n,          (numeric) The block height or index
+  "version" : n,         (numeric) The block version
+  "versionHex" : "00000000", (string) The block version formatted in hexadecimal
+  "merkleroot" : "xxxx", (string) The merkle root
+  "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)
+  "mediantime" : ttt,    (numeric) The median 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
+  "chainwork" : "xxxx",  (string) Expected number of hashes required to produce the chain up to this block (in hex)
+  "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:
+> bitcoin-cli getblock "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"
+> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblock", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
+
+

_doc/en/0.16.0/rpc/blockchain/getblockchaininfo.html

@@ -0,0 +1,59 @@
+---
+name: getblockchaininfo
+btcversion: 0.16.0
+btcgroup: blockchain
+permalink: en/doc/0.16.0/rpc/blockchain/getblockchaininfo/
+---
+
+getblockchaininfo
+Returns an object containing various state info regarding blockchain processing.
+
+Result:
+{
+  "chain": "xxxx",              (string) current network name as defined in BIP70 (main, test, regtest)
+  "blocks": xxxxxx,             (numeric) the current number of blocks processed in the server
+  "headers": xxxxxx,            (numeric) the current number of headers we have validated
+  "bestblockhash": "...",       (string) the hash of the currently best block
+  "difficulty": xxxxxx,         (numeric) the current difficulty
+  "mediantime": xxxxxx,         (numeric) median time for the current best block
+  "verificationprogress": xxxx, (numeric) estimate of verification progress [0..1]
+  "initialblockdownload": xxxx, (bool) (debug information) estimate of whether this node is in Initial Block Download mode.
+  "chainwork": "xxxx"           (string) total amount of work in active chain, in hexadecimal
+  "size_on_disk": xxxxxx,       (numeric) the estimated size of the block and undo files on disk
+  "pruned": xx,                 (boolean) if the blocks are subject to pruning
+  "pruneheight": xxxxxx,        (numeric) lowest-height complete block stored (only present if pruning is enabled)
+  "automatic_pruning": xx,      (boolean) whether automatic pruning is enabled (only present if pruning is enabled)
+  "prune_target_size": xxxxxx,  (numeric) the target size used by pruning (only present if automatic pruning is enabled)
+  "softforks": [                (array) status of softforks in progress
+     {
+        "id": "xxxx",           (string) name of softfork
+        "version": xx,          (numeric) block version
+        "reject": {             (object) progress toward rejecting pre-softfork blocks
+           "status": xx,        (boolean) true if threshold reached
+        },
+     }, ...
+  ],
+  "bip9_softforks": {           (object) status of BIP9 softforks in progress
+     "xxxx" : {                 (string) name of the softfork
+        "status": "xxxx",       (string) one of "defined", "started", "locked_in", "active", "failed"
+        "bit": xx,              (numeric) the bit (0-28) in the block version field used to signal this softfork (only for "started" status)
+        "startTime": xx,        (numeric) the minimum median time past of a block at which the bit gains its meaning
+        "timeout": xx,          (numeric) the median time past of a block at which the deployment is considered failed if not yet locked in
+        "since": xx,            (numeric) height of the first block to which the status applies
+        "statistics": {         (object) numeric statistics about BIP9 signalling for a softfork (only for "started" status)
+           "period": xx,        (numeric) the length in blocks of the BIP9 signalling period 
+           "threshold": xx,     (numeric) the number of blocks with the version bit set required to activate the feature 
+           "elapsed": xx,       (numeric) the number of blocks elapsed since the beginning of the current period 
+           "count": xx,         (numeric) the number of blocks with the version bit set in the current period 
+           "possible": xx       (boolean) returns false if there are not enough blocks left in this period to pass activation threshold 
+        }
+     }
+  }
+  "warnings" : "...",           (string) any network and blockchain warnings.
+}
+
+Examples:
+> bitcoin-cli getblockchaininfo 
+> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockchaininfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
+
+

_doc/en/0.16.0/rpc/blockchain/getblockcount.html

@@ -0,0 +1,19 @@
+---
+name: getblockcount
+btcversion: 0.16.0
+btcgroup: blockchain
+permalink: en/doc/0.16.0/rpc/blockchain/getblockcount/
+---
+
+getblockcount
+
+Returns the number of blocks in the longest blockchain.
+
+Result:
+n    (numeric) The current block count
+
+Examples:
+> bitcoin-cli getblockcount 
+> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockcount", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
+
+

_doc/en/0.16.0/rpc/blockchain/getblockhash.html

@@ -0,0 +1,22 @@
+---
+name: getblockhash
+btcversion: 0.16.0
+btcgroup: blockchain
+permalink: en/doc/0.16.0/rpc/blockchain/getblockhash/
+---
+
+getblockhash height
+
+Returns hash of block in best-block-chain at height provided.
+
+Arguments:
+1. height         (numeric, required) The height index
+
+Result:
+"hash"         (string) The block hash
+
+Examples:
+> bitcoin-cli getblockhash 1000
+> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockhash", "params": [1000] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
+
+

_doc/en/0.16.0/rpc/blockchain/getblockheader.html

@@ -0,0 +1,42 @@
+---
+name: getblockheader
+btcversion: 0.16.0
+btcgroup: blockchain
+permalink: en/doc/0.16.0/rpc/blockchain/getblockheader/
+---
+
+getblockheader "hash" ( verbose )
+
+If verbose is false, returns a string that is serialized, hex-encoded data for blockheader 'hash'.
+If verbose is true, returns an Object with information about blockheader <hash>.
+
+Arguments:
+1. "hash"          (string, required) The block hash
+2. verbose           (boolean, optional, default=true) true for a json object, false for the hex encoded data
+
+Result (for verbose = true):
+{
+  "hash" : "hash",     (string) the block hash (same as provided)
+  "confirmations" : n,   (numeric) The number of confirmations, or -1 if the block is not on the main chain
+  "height" : n,          (numeric) The block height or index
+  "version" : n,         (numeric) The block version
+  "versionHex" : "00000000", (string) The block version formatted in hexadecimal
+  "merkleroot" : "xxxx", (string) The merkle root
+  "time" : ttt,          (numeric) The block time in seconds since epoch (Jan 1 1970 GMT)
+  "mediantime" : ttt,    (numeric) The median 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
+  "chainwork" : "0000...1f3"     (string) Expected number of hashes required to produce the current chain (in hex)
+  "previousblockhash" : "hash",  (string) The hash of the previous block
+  "nextblockhash" : "hash",      (string) The hash of the next block
+}
+
+Result (for verbose=false):
+"data"             (string) A string that is serialized, hex-encoded data for block 'hash'.
+
+Examples:
+> bitcoin-cli getblockheader "00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"
+> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getblockheader", "params": ["00000000c937983704a73af28acdec37b049d214adbda81d7e2a3dd146f6ed09"] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
+
+

_doc/en/0.16.0/rpc/blockchain/getchaintips.html

@@ -0,0 +1,37 @@
+---
+name: getchaintips
+btcversion: 0.16.0
+btcgroup: blockchain
+permalink: en/doc/0.16.0/rpc/blockchain/getchaintips/
+---
+
+getchaintips
+Return information about all known tips in the block tree, including the main chain as well as orphaned branches.
+
+Result:
+[
+  {
+    "height": xxxx,         (numeric) height of the chain tip
+    "hash": "xxxx",         (string) block hash of the tip
+    "branchlen": 0          (numeric) zero for main chain
+    "status": "active"      (string) "active" for the main chain
+  },
+  {
+    "height": xxxx,
+    "hash": "xxxx",
+    "branchlen": 1          (numeric) length of branch connecting the tip to the main chain
+    "status": "xxxx"        (string) status of the chain (active, valid-fork, valid-headers, headers-only, invalid)
+  }
+]
+Possible values for status:
+1.  "invalid"               This branch contains at least one invalid block
+2.  "headers-only"          Not all blocks for this branch are available, but the headers are valid
+3.  "valid-headers"         All blocks are available for this branch, but they were never fully validated
+4.  "valid-fork"            This branch is not part of the active chain, but is fully validated
+5.  "active"                This is the tip of the active main chain, which is certainly valid
+
+Examples:
+> bitcoin-cli getchaintips 
+> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getchaintips", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
+
+

_doc/en/0.16.0/rpc/blockchain/getchaintxstats.html

@@ -0,0 +1,30 @@
+---
+name: getchaintxstats
+btcversion: 0.16.0
+btcgroup: blockchain
+permalink: en/doc/0.16.0/rpc/blockchain/getchaintxstats/
+---
+
+getchaintxstats ( nblocks blockhash )
+
+Compute statistics about the total number and rate of transactions in the chain.
+
+Arguments:
+1. nblocks      (numeric, optional) Size of the window in number of blocks (default: one month).
+2. "blockhash"  (string, optional) The hash of the block that ends the window.
+
+Result:
+{
+  "time": xxxxx,                (numeric) The timestamp for the final block in the window in UNIX format.
+  "txcount": xxxxx,             (numeric) The total number of transactions in the chain up to that point.
+  "window_block_count": xxxxx,  (numeric) Size of the window in number of blocks.
+  "window_tx_count": xxxxx,     (numeric) The number of transactions in the window. Only returned if "window_block_count" is > 0.
+  "window_interval": xxxxx,     (numeric) The elapsed time in the window in seconds. Only returned if "window_block_count" is > 0.
+  "txrate": x.xx,               (numeric) The average rate of transactions per second in the window. Only returned if "window_interval" is > 0.
+}
+
+Examples:
+> bitcoin-cli getchaintxstats 
+> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getchaintxstats", "params": [2016] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/
+
+