Skip to content

Commit b34009c

Browse files
MarcoFalkeknst
authored andcommitted
Merge 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
1 parent 9d5b230 commit b34009c

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
@@ -83,17 +83,7 @@ Responds with 404 if block not found.
8383

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

9888
#### Query UTXO set
9989
- `GET /rest/getutxos/<TXID>-<N>/<TXID>-<N>/.../<TXID>-<N>.<bin|hex|json>`
@@ -130,13 +120,13 @@ $ curl localhost:19998/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
130120
#### Memory pool
131121
`GET /rest/mempool/info.json`
132122

133-
Returns various information about the TX mempool.
123+
Returns various information about the transaction mempool.
134124
Only supports JSON as output format.
135-
Refer to the `getmempoolinfo` RPC for documentation of the fields.
125+
Refer to the `getmempoolinfo` RPC help for details.
136126

137127
`GET /rest/mempool/contents.json`
138128

139-
Returns transactions in the TX mempool.
129+
Returns the transactions in the mempool.
140130
Only supports JSON as output format.
141131
Refer to the `getrawmempool` RPC help for details.
142132

0 commit comments

Comments
 (0)