mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-11-12 15:09:59 +01:00
rpc: Auto-format RPCResult
This commit is contained in:
MarcoFalke
@@ -90,8 +90,7 @@ static UniValue getnetworkhashps(const JSONRPCRequest& request)
|
||||
{"height", RPCArg::Type::NUM, /* default */ "-1", "To estimate at the time of the given height."},
|
||||
},
|
||||
RPCResult{
|
||||
"x (numeric) Hashes per second estimated\n"
|
||||
},
|
||||
RPCResult::Type::NUM, "", "Hashes per second estimated"},
|
||||
RPCExamples{
|
||||
HelpExampleCli("getnetworkhashps", "")
|
||||
+ HelpExampleRpc("getnetworkhashps", "")
|
||||
@@ -154,7 +153,11 @@ static UniValue generatetodescriptor(const JSONRPCRequest& request)
|
||||
{"maxtries", RPCArg::Type::NUM, /* default */ "1000000", "How many iterations to try."},
|
||||
},
|
||||
RPCResult{
|
||||
"[ blockhashes ] (json array) hashes of blocks generated\n"},
|
||||
RPCResult::Type::ARR, "", "hashes of blocks generated",
|
||||
{
|
||||
{RPCResult::Type::STR_HEX, "", "blockhash"},
|
||||
}
|
||||
},
|
||||
RPCExamples{
|
||||
"\nGenerate 11 blocks to mydesc\n" + HelpExampleCli("generatetodescriptor", "11 \"mydesc\"")},
|
||||
}
|
||||
@@ -196,8 +199,10 @@ static UniValue generatetoaddress(const JSONRPCRequest& request)
|
||||
{"maxtries", RPCArg::Type::NUM, /* default */ "1000000", "How many iterations to try."},
|
||||
},
|
||||
RPCResult{
|
||||
"[ blockhashes ] (json array) hashes of blocks generated\n"
|
||||
},
|
||||
RPCResult::Type::ARR, "", "hashes of blocks generated",
|
||||
{
|
||||
{RPCResult::Type::STR_HEX, "", "blockhash"},
|
||||
}},
|
||||
RPCExamples{
|
||||
"\nGenerate 11 blocks to myaddress\n"
|
||||
+ HelpExampleCli("generatetoaddress", "11 \"myaddress\"")
|
||||
@@ -230,17 +235,17 @@ static UniValue getmininginfo(const JSONRPCRequest& request)
|
||||
"\nReturns a json object containing mining-related information.",
|
||||
{},
|
||||
RPCResult{
|
||||
"{\n"
|
||||
" \"blocks\" : nnn, (numeric) The current block\n"
|
||||
" \"currentblockweight\" : nnn, (numeric, optional) The block weight of the last assembled block (only present if a block was ever assembled)\n"
|
||||
" \"currentblocktx\" : nnn, (numeric, optional) The number of block transactions of the last assembled block (only present if a block was ever assembled)\n"
|
||||
" \"difficulty\" : xxx.xxxxx (numeric) The current difficulty\n"
|
||||
" \"networkhashps\" : nnn, (numeric) The network hashes per second\n"
|
||||
" \"pooledtx\" : n (numeric) The size of the mempool\n"
|
||||
" \"chain\" : \"xxxx\", (string) current network name (main, test, regtest)\n"
|
||||
" \"warnings\" : \"...\" (string) any network and blockchain warnings\n"
|
||||
"}\n"
|
||||
},
|
||||
RPCResult::Type::OBJ, "", "",
|
||||
{
|
||||
{RPCResult::Type::NUM, "blocks", "The current block"},
|
||||
{RPCResult::Type::NUM, "currentblockweight", /* optional */ true, "The block weight of the last assembled block (only present if a block was ever assembled)"},
|
||||
{RPCResult::Type::NUM, "currentblocktx", /* optional */ true, "The number of block transactions of the last assembled block (only present if a block was ever assembled)"},
|
||||
{RPCResult::Type::NUM, "difficulty", "The current difficulty"},
|
||||
{RPCResult::Type::NUM, "networkhashps", "The network hashes per second"},
|
||||
{RPCResult::Type::NUM, "pooledtx", "The size of the mempool"},
|
||||
{RPCResult::Type::STR, "chain", "current network name (main, test, regtest)"},
|
||||
{RPCResult::Type::STR, "warnings", "any network and blockchain warnings"},
|
||||
}},
|
||||
RPCExamples{
|
||||
HelpExampleCli("getmininginfo", "")
|
||||
+ HelpExampleRpc("getmininginfo", "")
|
||||
@@ -278,8 +283,7 @@ static UniValue prioritisetransaction(const JSONRPCRequest& request)
|
||||
" considers the transaction as it would have paid a higher (or lower) fee."},
|
||||
},
|
||||
RPCResult{
|
||||
"true (boolean) Returns true\n"
|
||||
},
|
||||
RPCResult::Type::BOOL, "", "Returns true"},
|
||||
RPCExamples{
|
||||
HelpExampleCli("prioritisetransaction", "\"txid\" 0.0 10000")
|
||||
+ HelpExampleRpc("prioritisetransaction", "\"txid\", 0.0, 10000")
|
||||
@@ -356,48 +360,58 @@ static UniValue getblocktemplate(const JSONRPCRequest& request)
|
||||
"\"template_request\""},
|
||||
},
|
||||
RPCResult{
|
||||
"{\n"
|
||||
" \"version\" : n, (numeric) The preferred block version\n"
|
||||
" \"rules\" : [ \"rulename\", ... ], (array of strings) specific block rules that are to be enforced\n"
|
||||
" \"vbavailable\" : { (json object) set of pending, supported versionbit (BIP 9) softfork deployments\n"
|
||||
" \"rulename\" : bitnumber (numeric) identifies the bit number as indicating acceptance and readiness for the named softfork rule\n"
|
||||
" ,...\n"
|
||||
" },\n"
|
||||
" \"vbrequired\" : n, (numeric) bit mask of versionbits the server requires set in submissions\n"
|
||||
" \"previousblockhash\" : \"xxxx\", (string) The hash of current highest block\n"
|
||||
" \"transactions\" : [ (json array) contents of non-coinbase transactions that should be included in the next block\n"
|
||||
" {\n"
|
||||
" \"data\" : \"xxxx\", (string) transaction data encoded in hexadecimal (byte-for-byte)\n"
|
||||
" \"txid\" : \"xxxx\", (string) transaction id encoded in little-endian hexadecimal\n"
|
||||
" \"hash\" : \"xxxx\", (string) hash encoded in little-endian hexadecimal (including witness data)\n"
|
||||
" \"depends\" : [ (json array) array of numbers \n"
|
||||
" n (numeric) transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is\n"
|
||||
" ,...\n"
|
||||
" ],\n"
|
||||
" \"fee\" : n, (numeric) difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one\n"
|
||||
" \"sigops\" : n, (numeric) total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero\n"
|
||||
" \"weight\" : n, (numeric) total transaction weight, as counted for purposes of block limits\n"
|
||||
" }\n"
|
||||
" ,...\n"
|
||||
" ],\n"
|
||||
" \"coinbaseaux\" : { ... }, (json object) data that should be included in the coinbase's scriptSig content\n"
|
||||
" \"coinbasevalue\" : n, (numeric) maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis)\n"
|
||||
" \"coinbasetxn\" : { ... }, (json object) information for coinbase transaction\n"
|
||||
" \"target\" : \"xxxx\", (string) The hash target\n"
|
||||
" \"mintime\" : xxx, (numeric) The minimum timestamp appropriate for the next block time, expressed in " + UNIX_EPOCH_TIME + "\n"
|
||||
" \"mutable\" : [ (array of string) list of ways the block template may be changed \n"
|
||||
" \"value\" (string) A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'\n"
|
||||
" ,...\n"
|
||||
" ],\n"
|
||||
" \"noncerange\" : \"00000000ffffffff\",(string) A range of valid nonces\n"
|
||||
" \"sigoplimit\" : n, (numeric) limit of sigops in blocks\n"
|
||||
" \"sizelimit\" : n, (numeric) limit of block size\n"
|
||||
" \"weightlimit\" : n, (numeric) limit of block weight\n"
|
||||
" \"curtime\" : ttt, (numeric) current timestamp in " + UNIX_EPOCH_TIME + "\n"
|
||||
" \"bits\" : \"xxxxxxxx\", (string) compressed target of next block\n"
|
||||
" \"height\" : n (numeric) The height of the next block\n"
|
||||
"}\n"
|
||||
},
|
||||
RPCResult::Type::OBJ, "", "",
|
||||
{
|
||||
{RPCResult::Type::NUM, "version", "The preferred block version"},
|
||||
{RPCResult::Type::ARR, "rules", "specific block rules that are to be enforced",
|
||||
{
|
||||
{RPCResult::Type::STR, "", "rulename"},
|
||||
}},
|
||||
{RPCResult::Type::OBJ_DYN, "vbavailable", "set of pending, supported versionbit (BIP 9) softfork deployments",
|
||||
{
|
||||
{RPCResult::Type::NUM, "rulename", "identifies the bit number as indicating acceptance and readiness for the named softfork rule"},
|
||||
}},
|
||||
{RPCResult::Type::NUM, "vbrequired", "bit mask of versionbits the server requires set in submissions"},
|
||||
{RPCResult::Type::STR, "previousblockhash", "The hash of current highest block"},
|
||||
{RPCResult::Type::ARR, "", "contents of non-coinbase transactions that should be included in the next block",
|
||||
{
|
||||
{RPCResult::Type::OBJ, "", "",
|
||||
{
|
||||
{RPCResult::Type::STR_HEX, "data", "transaction data encoded in hexadecimal (byte-for-byte)"},
|
||||
{RPCResult::Type::STR_HEX, "txid", "transaction id encoded in little-endian hexadecimal"},
|
||||
{RPCResult::Type::STR_HEX, "hash", "hash encoded in little-endian hexadecimal (including witness data)"},
|
||||
{RPCResult::Type::ARR, "depends", "array of numbers",
|
||||
{
|
||||
{RPCResult::Type::NUM, "", "transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is"},
|
||||
}},
|
||||
{RPCResult::Type::NUM, "fee", "difference in value between transaction inputs and outputs (in satoshis); for coinbase transactions, this is a negative Number of the total collected block fees (ie, not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one"},
|
||||
{RPCResult::Type::NUM, "sigops", "total SigOps cost, as counted for purposes of block limits; if key is not present, sigop cost is unknown and clients MUST NOT assume it is zero"},
|
||||
{RPCResult::Type::NUM, "weight", "total transaction weight, as counted for purposes of block limits"},
|
||||
}},
|
||||
}},
|
||||
{RPCResult::Type::OBJ, "coinbaseaux", "data that should be included in the coinbase's scriptSig content",
|
||||
{
|
||||
{RPCResult::Type::ELISION, "", ""},
|
||||
}},
|
||||
{RPCResult::Type::NUM, "coinbasevalue", "maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis)"},
|
||||
{RPCResult::Type::OBJ, "coinbasetxn", "information for coinbase transaction",
|
||||
{
|
||||
{RPCResult::Type::ELISION, "", ""},
|
||||
}},
|
||||
{RPCResult::Type::STR, "target", "The hash target"},
|
||||
{RPCResult::Type::NUM_TIME, "mintime", "The minimum timestamp appropriate for the next block time, expressed in " + UNIX_EPOCH_TIME},
|
||||
{RPCResult::Type::ARR, "mutable", "list of ways the block template may be changed",
|
||||
{
|
||||
{RPCResult::Type::STR, "value", "A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'"},
|
||||
}},
|
||||
{RPCResult::Type::STR_HEX, "noncerange", "A range of valid nonces"},
|
||||
{RPCResult::Type::NUM, "sigoplimit", "limit of sigops in blocks"},
|
||||
{RPCResult::Type::NUM, "sizelimit", "limit of block size"},
|
||||
{RPCResult::Type::NUM, "weightlimit", "limit of block weight"},
|
||||
{RPCResult::Type::NUM_TIME, "curtime", "current timestamp in " + UNIX_EPOCH_TIME},
|
||||
{RPCResult::Type::STR, "bits", "compressed target of next block"},
|
||||
{RPCResult::Type::NUM, "height", "The height of the next block"},
|
||||
}},
|
||||
RPCExamples{
|
||||
HelpExampleCli("getblocktemplate", "'{\"rules\": [\"segwit\"]}'")
|
||||
+ HelpExampleRpc("getblocktemplate", "{\"rules\": [\"segwit\"]}")
|
||||
@@ -800,8 +814,7 @@ static UniValue submitheader(const JSONRPCRequest& request)
|
||||
{"hexdata", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "the hex-encoded block header data"},
|
||||
},
|
||||
RPCResult{
|
||||
"None"
|
||||
},
|
||||
RPCResult::Type::NONE, "", "None"},
|
||||
RPCExamples{
|
||||
HelpExampleCli("submitheader", "\"aabbcc\"") +
|
||||
HelpExampleRpc("submitheader", "\"aabbcc\"")
|
||||
@@ -848,17 +861,19 @@ static UniValue estimatesmartfee(const JSONRPCRequest& request)
|
||||
" \"CONSERVATIVE\""},
|
||||
},
|
||||
RPCResult{
|
||||
"{\n"
|
||||
" \"feerate\" : x.x, (numeric, optional) estimate fee rate in " + CURRENCY_UNIT + "/kB\n"
|
||||
" \"errors\" : [ str... ] (json array of strings, optional) Errors encountered during processing\n"
|
||||
" \"blocks\" : n (numeric) block number where estimate was found\n"
|
||||
"}\n"
|
||||
"\n"
|
||||
RPCResult::Type::OBJ, "", "",
|
||||
{
|
||||
{RPCResult::Type::NUM, "feerate", /* optional */ true, "estimate fee rate in " + CURRENCY_UNIT + "/kB (only present if no errors were encountered)"},
|
||||
{RPCResult::Type::ARR, "errors", "Errors encountered during processing",
|
||||
{
|
||||
{RPCResult::Type::STR, "", "error"},
|
||||
}},
|
||||
{RPCResult::Type::NUM, "blocks", "block number where estimate was found\n"
|
||||
"The request target will be clamped between 2 and the highest target\n"
|
||||
"fee estimation is able to return based on how long it has been running.\n"
|
||||
"An error is returned if not enough transactions and blocks\n"
|
||||
"have been observed to make an estimate for any number of blocks.\n"
|
||||
},
|
||||
"have been observed to make an estimate for any number of blocks."},
|
||||
}},
|
||||
RPCExamples{
|
||||
HelpExampleCli("estimatesmartfee", "6")
|
||||
},
|
||||
@@ -908,36 +923,40 @@ static UniValue estimaterawfee(const JSONRPCRequest& request)
|
||||
" lower buckets."},
|
||||
},
|
||||
RPCResult{
|
||||
"{ (json object) Results are returned for any horizon which tracks blocks up to the confirmation target\n"
|
||||
" \"short\" : { (json object, optional) estimate for short time horizon\n"
|
||||
" \"feerate\" : x.x, (numeric, optional) estimate fee rate in " + CURRENCY_UNIT + "/kB\n"
|
||||
" \"decay\" : x.x, (numeric) exponential decay (per block) for historical moving average of confirmation data\n"
|
||||
" \"scale\" : x, (numeric) The resolution of confirmation targets at this time horizon\n"
|
||||
" \"pass\" : { (json object, optional) information about the lowest range of feerates to succeed in meeting the threshold\n"
|
||||
" \"startrange\" : x.x, (numeric) start of feerate range\n"
|
||||
" \"endrange\" : x.x, (numeric) end of feerate range\n"
|
||||
" \"withintarget\" : x.x, (numeric) number of txs over history horizon in the feerate range that were confirmed within target\n"
|
||||
" \"totalconfirmed\" : x.x, (numeric) number of txs over history horizon in the feerate range that were confirmed at any point\n"
|
||||
" \"inmempool\" : x.x, (numeric) current number of txs in mempool in the feerate range unconfirmed for at least target blocks\n"
|
||||
" \"leftmempool\" : x.x, (numeric) number of txs over history horizon in the feerate range that left mempool unconfirmed after target\n"
|
||||
" },\n"
|
||||
" \"fail\" : { (json object, optional) information about the highest range of feerates to fail to meet the threshold\n"
|
||||
" ...\n"
|
||||
" },\n"
|
||||
" \"errors\" : [ (json array, optional) Errors encountered during processing\n"
|
||||
" \"str\", (string)\n"
|
||||
" ...\n"
|
||||
" ],\n"
|
||||
" },\n"
|
||||
" \"medium\" : { (json object, optional) estimate for medium time horizon\n"
|
||||
" ...\n"
|
||||
" },\n"
|
||||
" \"long\" : { (json object, optional) estimate for long time horizon\n"
|
||||
" ...\n"
|
||||
" },\n"
|
||||
"}\n"
|
||||
"\n"
|
||||
},
|
||||
RPCResult::Type::OBJ, "", "Results are returned for any horizon which tracks blocks up to the confirmation target",
|
||||
{
|
||||
{RPCResult::Type::OBJ, "short", /* optional */ true, "estimate for short time horizon",
|
||||
{
|
||||
{RPCResult::Type::NUM, "feerate", /* optional */ true, "estimate fee rate in " + CURRENCY_UNIT + "/kB"},
|
||||
{RPCResult::Type::NUM, "decay", "exponential decay (per block) for historical moving average of confirmation data"},
|
||||
{RPCResult::Type::NUM, "scale", "The resolution of confirmation targets at this time horizon"},
|
||||
{RPCResult::Type::OBJ, "pass", /* optional */ true, "information about the lowest range of feerates to succeed in meeting the threshold",
|
||||
{
|
||||
{RPCResult::Type::NUM, "startrange", "start of feerate range"},
|
||||
{RPCResult::Type::NUM, "endrange", "end of feerate range"},
|
||||
{RPCResult::Type::NUM, "withintarget", "number of txs over history horizon in the feerate range that were confirmed within target"},
|
||||
{RPCResult::Type::NUM, "totalconfirmed", "number of txs over history horizon in the feerate range that were confirmed at any point"},
|
||||
{RPCResult::Type::NUM, "inmempool", "current number of txs in mempool in the feerate range unconfirmed for at least target blocks"},
|
||||
{RPCResult::Type::NUM, "leftmempool", "number of txs over history horizon in the feerate range that left mempool unconfirmed after target"},
|
||||
}},
|
||||
{RPCResult::Type::OBJ, "fail", /* optional */ true, "information about the highest range of feerates to fail to meet the threshold",
|
||||
{
|
||||
{RPCResult::Type::ELISION, "", ""},
|
||||
}},
|
||||
{RPCResult::Type::ARR, "errors", /* optional */ true, "Errors encountered during processing",
|
||||
{
|
||||
{RPCResult::Type::STR, "error", ""},
|
||||
}},
|
||||
}},
|
||||
{RPCResult::Type::OBJ, "medium", /* optional */ true, "estimate for medium time horizon",
|
||||
{
|
||||
{RPCResult::Type::ELISION, "", ""},
|
||||
}},
|
||||
{RPCResult::Type::OBJ, "long", /* optional */ true, "estimate for long time horizon",
|
||||
{
|
||||
{RPCResult::Type::ELISION, "", ""},
|
||||
}},
|
||||
}},
|
||||
RPCExamples{
|
||||
HelpExampleCli("estimaterawfee", "6 0.9")
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user