diff options
| author | MarcoFalke <falke.marco@gmail.com> | 2022-04-19 12:11:04 +0200 |
|---|---|---|
| committer | MarcoFalke <falke.marco@gmail.com> | 2022-04-19 12:11:07 +0200 |
| commit | ff78833d3c8639c43a1cc98740cef3744fdcacff (patch) | |
| tree | d5d65289959675f00ccca9fdbfec3225e6c321d1 /doc/REST-interface.md | |
| parent | 907659770bd2e95f4f4af652eb9e443772f2c0f1 (diff) | |
| parent | 1d95b5c78368575c8885a5bf659cdb4d6261f124 (diff) | |
Merge bitcoin/bitcoin#24776: docs: update /rest/chaininfo doc referring to RPC help
1d95b5c78368575c8885a5bf659cdb4d6261f124 doc: cleanups to mempool rest endpoints (brunoerg)
b941dec0a975d441fe08117e84d72aca4c5731bc 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 1d95b5c78368575c8885a5bf659cdb4d6261f124
Tree-SHA512: 643db202e13e8372105460b0871facb11586dc0ff5e86ec9e105a178bcfeefa3555bb047cd28cfaeb3e747f5a2055e27961813c9e299ba7b2d36151e81049507
Diffstat (limited to 'doc/REST-interface.md')
| -rw-r--r-- | doc/REST-interface.md | 18 |
1 files changed, 4 insertions, 14 deletions
diff --git a/doc/REST-interface.md b/doc/REST-interface.md index c359725faf..f11624fd28 100644 --- a/doc/REST-interface.md +++ b/doc/REST-interface.md @@ -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. Only supports JSON as output format. -* chain : (string) current network name (main, test, signet, regtest) -* 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 +Refer to the `getblockchaininfo` RPC help for details. #### Query UTXO set `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 `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. -Refer to the `getmempoolinfo` RPC for documentation of the fields. +Refer to the `getmempoolinfo` RPC help for details. `GET /rest/mempool/contents.json` -Returns transactions in the TX mempool. +Returns the transactions in the mempool. Only supports JSON as output format. Risks |