Merge #20917: doc, rpc: add missing signet mentions in network name lists

fc726e0138 doc, rpc: add missing signet mentions in network name lists (Sebastian Falbesoner)

Pull request description:

  This small PR adds a few missing mentions of signet w.r.t. chain enumerations:

  - RPC `getblockchaininfo`: result description for `"chain"`
  - RPC `getmininginfo`: result description for `"chain"`
  - REST interface documentation:
      - default ports listing for each chain
      - `"chain"` description for `chaininfo` endpoint result

  The instances were identified via `git grep -i "main.*test.*reg"`.

ACKs for top commit:
  ajtowns:
    ACK fc726e0138 -- quick code review only
  benthecarman:
    ACK fc726e0138

Tree-SHA512: 62cdc6ef74fa10db75cc04b9eaf7367183f726b3fee3d21fdf741b3816669dd21508735e89da389ddac980f49773ab229263748d1399553375fefe4526361846
This commit is contained in:
MarcoFalke 2021-01-13 17:31:32 +01:00
commit 22fa9673b0
No known key found for this signature in database
GPG key ID: D2EA4850E7528B25
3 changed files with 4 additions and 4 deletions

View file

@ -4,7 +4,7 @@ Unauthenticated REST Interface
The REST API can be enabled with the `-rest` option. The REST API can be enabled with the `-rest` option.
The interface runs on the same port as the JSON-RPC interface, by default port 8332 for mainnet, port 18332 for testnet, The interface runs on the same port as the JSON-RPC interface, by default port 8332 for mainnet, port 18332 for testnet,
and port 18443 for regtest. port 38332 for signet, and port 18443 for regtest.
REST Interface consistency guarantees REST Interface consistency guarantees
------------------------------------- -------------------------------------
@ -62,7 +62,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, regtest) * chain : (string) current network name (main, test, signet, regtest)
* blocks : (numeric) the current number of blocks processed in the server * blocks : (numeric) the current number of blocks processed in the server
* headers : (numeric) the current number of headers we have validated * headers : (numeric) the current number of headers we have validated
* bestblockhash : (string) the hash of the currently best block * bestblockhash : (string) the hash of the currently best block

View file

@ -1283,7 +1283,7 @@ RPCHelpMan getblockchaininfo()
RPCResult{ RPCResult{
RPCResult::Type::OBJ, "", "", RPCResult::Type::OBJ, "", "",
{ {
{RPCResult::Type::STR, "chain", "current network name (main, test, regtest)"}, {RPCResult::Type::STR, "chain", "current network name (main, test, signet, regtest)"},
{RPCResult::Type::NUM, "blocks", "the height of the most-work fully-validated chain. The genesis block has height 0"}, {RPCResult::Type::NUM, "blocks", "the height of the most-work fully-validated chain. The genesis block has height 0"},
{RPCResult::Type::NUM, "headers", "the current number of headers we have validated"}, {RPCResult::Type::NUM, "headers", "the current number of headers we have validated"},
{RPCResult::Type::STR, "bestblockhash", "the hash of the currently best block"}, {RPCResult::Type::STR, "bestblockhash", "the hash of the currently best block"},

View file

@ -409,7 +409,7 @@ static RPCHelpMan getmininginfo()
{RPCResult::Type::NUM, "difficulty", "The current difficulty"}, {RPCResult::Type::NUM, "difficulty", "The current difficulty"},
{RPCResult::Type::NUM, "networkhashps", "The network hashes per second"}, {RPCResult::Type::NUM, "networkhashps", "The network hashes per second"},
{RPCResult::Type::NUM, "pooledtx", "The size of the mempool"}, {RPCResult::Type::NUM, "pooledtx", "The size of the mempool"},
{RPCResult::Type::STR, "chain", "current network name (main, test, regtest)"}, {RPCResult::Type::STR, "chain", "current network name (main, test, signet, regtest)"},
{RPCResult::Type::STR, "warnings", "any network and blockchain warnings"}, {RPCResult::Type::STR, "warnings", "any network and blockchain warnings"},
}}, }},
RPCExamples{ RPCExamples{