Skip to content

Commit ff78833

Browse files
author
MarcoFalke
committed
Merge bitcoin/bitcoin#24776: docs: update /rest/chaininfo doc referring to RPC help
1d95b5c doc: cleanups to mempool rest endpoints (brunoerg) b941dec docs: update `/rest/chaininfo` doc referring to RPC help (brunoerg) Pull request description: Internally, `/rest/chaininfo` gets the infos from `getblockchaininfo` and I just realized the documentation of it in `REST-interface.md` is outdated compared to the `getblockchaininfo` RPC one. This PR removes the documentation of the fields and adds a reference to the RPC help. ACKs for top commit: jonatack: ACK 1d95b5c Tree-SHA512: 643db202e13e8372105460b0871facb11586dc0ff5e86ec9e105a178bcfeefa3555bb047cd28cfaeb3e747f5a2055e27961813c9e299ba7b2d36151e81049507
2 parents 9076597 + 1d95b5c commit ff78833

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

doc/REST-interface.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,7 @@ Given a height: returns hash of block in best-block-chain at height provided.
8282

8383
Returns various state info regarding block chain processing.
8484
Only supports JSON as output format.
85-
* chain : (string) current network name (main, test, signet, regtest)
86-
* blocks : (numeric) the current number of blocks processed in the server
87-
* headers : (numeric) the current number of headers we have validated
88-
* bestblockhash : (string) the hash of the currently best block
89-
* difficulty : (numeric) the current difficulty
90-
* mediantime : (numeric) the median time of the 11 blocks before the most recent block on the blockchain
91-
* verificationprogress : (numeric) estimate of verification progress [0..1]
92-
* chainwork : (string) total amount of work in active chain, in hexadecimal
93-
* pruned : (boolean) if the blocks are subject to pruning
94-
* pruneheight : (numeric) highest block available
95-
* softforks : (array) status of softforks in progress
85+
Refer to the `getblockchaininfo` RPC help for details.
9686

9787
#### Query UTXO set
9888
`GET /rest/getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>`
@@ -127,13 +117,13 @@ $ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
127117
#### Memory pool
128118
`GET /rest/mempool/info.json`
129119

130-
Returns various information about the TX mempool.
120+
Returns various information about the transaction mempool.
131121
Only supports JSON as output format.
132-
Refer to the `getmempoolinfo` RPC for documentation of the fields.
122+
Refer to the `getmempoolinfo` RPC help for details.
133123

134124
`GET /rest/mempool/contents.json`
135125

136-
Returns transactions in the TX mempool.
126+
Returns the transactions in the mempool.
137127
Only supports JSON as output format.
138128

139129
Risks

0 commit comments

Comments
 (0)