Retropex/bitcoin
1
0
Fork 0
mirror of https://github.com/Retropex/bitcoin.git synced 2025-05-17 21:50:43 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge bitcoin/bitcoin#24776: docs: update /rest/chaininfo doc referring to RPC help

Browse Source 
1d95b5c783 doc: cleanups to mempool rest endpoints (brunoerg)
b941dec0a9 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 1d95b5c783

Tree-SHA512: 643db202e13e8372105460b0871facb11586dc0ff5e86ec9e105a178bcfeefa3555bb047cd28cfaeb3e747f5a2055e27961813c9e299ba7b2d36151e81049507
This commit is contained in:
MarcoFalke 2022-04-19 12:11:04 +02:00
commit ff78833d3c
No known key found for this signature in database
GPG Key ID: CE2B75697E69A548
1 changed files with 4 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/REST-interface.md
View File

@ -82,17 +82,7 @@ Given a height: returns hash of block in best-block-chain at height provided.
Returns various state info regarding block chain processing. Returns various state info regarding block chain processing.
Only supports JSON as output format. Only supports JSON as output format.
* chain : (string) current network name (main, test, signet, regtest) Refer to the `getblockchaininfo` RPC help for details.
* blocks : (numeric) the current number of blocks processed in the server
* headers : (numeric) the current number of headers we have validated
* bestblockhash : (string) the hash of the currently best block
* difficulty : (numeric) the current difficulty
* mediantime : (numeric) the median time of the 11 blocks before the most recent block on the blockchain
* verificationprogress : (numeric) estimate of verification progress [0..1]
* chainwork : (string) total amount of work in active chain, in hexadecimal
* pruned : (boolean) if the blocks are subject to pruning
* pruneheight : (numeric) highest block available
* softforks : (array) status of softforks in progress
#### Query UTXO set #### Query UTXO set
`GET /rest/getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>` `GET /rest/getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>`
@ -127,13 +117,13 @@ $ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
#### Memory pool #### Memory pool
`GET /rest/mempool/info.json` `GET /rest/mempool/info.json`
Returns various information about the TX mempool. Returns various information about the transaction mempool.
Only supports JSON as output format. Only supports JSON as output format.
Refer to the `getmempoolinfo` RPC for documentation of the fields. Refer to the `getmempoolinfo` RPC help for details.
`GET /rest/mempool/contents.json` `GET /rest/mempool/contents.json`
Returns transactions in the TX mempool. Returns the transactions in the mempool.
Only supports JSON as output format. Only supports JSON as output format.
Risks Risks