mirror of
https://github.com/ElementsProject/elements.git
synced 2026-08-18 13:17:55 +02:00
Merge 138d55e6a0 into merged_master (Bitcoin PR bitcoin/bitcoin#24579)
In blockchain.cpp: set optional=true for 'softforks' argument in getblockchaininfo docs. Also removed two levels of indentation from that function (to match the associated formatting fix in upstream).
This commit is contained in:
James Dorfman
commit
82b188df34
1 changed files with 46 additions and 46 deletions
|
|
@ -1298,51 +1298,51 @@ RPCHelpMan getblockchaininfo()
|
|||
{
|
||||
/* TODO: from v24, remove -deprecatedrpc=softforks */
|
||||
return RPCHelpMan{"getblockchaininfo",
|
||||
"Returns an object containing various state info regarding blockchain processing.\n",
|
||||
{},
|
||||
RPCResult{
|
||||
RPCResult::Type::OBJ, "", "",
|
||||
{
|
||||
{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, "headers", "the current number of headers we have validated"},
|
||||
{RPCResult::Type::STR, "bestblockhash", "the hash of the currently best block"},
|
||||
{RPCResult::Type::NUM, "difficulty", "the current difficulty"},
|
||||
{RPCResult::Type::NUM_TIME, "time", "The block time expressed in " + UNIX_EPOCH_TIME},
|
||||
{RPCResult::Type::NUM_TIME, "mediantime", "The median block time expressed in " + UNIX_EPOCH_TIME},
|
||||
{RPCResult::Type::NUM, "verificationprogress", "estimate of verification progress [0..1]"},
|
||||
{RPCResult::Type::BOOL, "initialblockdownload", "(debug information) estimate of whether this node is in Initial Block Download mode"},
|
||||
{RPCResult::Type::STR_HEX, "chainwork", "total amount of work in active chain, in hexadecimal"},
|
||||
{RPCResult::Type::NUM, "size_on_disk", "the estimated size of the block and undo files on disk"},
|
||||
{RPCResult::Type::BOOL, "pruned", "if the blocks are subject to pruning"},
|
||||
{RPCResult::Type::STR_HEX, "current_params_root", "the root of the currently active dynafed params"},
|
||||
{RPCResult::Type::STR, "signblock_asm", "ASM of sign block challenge data from genesis block"},
|
||||
{RPCResult::Type::STR_HEX, "signblock_hex", "Hex of sign block challenge data from genesis block"},
|
||||
{RPCResult::Type::STR, "current_signblock_asm", "ASM of sign block challenge data enforced on the next block"},
|
||||
{RPCResult::Type::STR_HEX, "current_signblock_hex", "Hex of sign block challenge data enforced on the next block"},
|
||||
{RPCResult::Type::NUM, "max_block_witness", "maximum sized block witness serialized size for the next block"},
|
||||
{RPCResult::Type::NUM, "epoch_length", "length of dynamic federations epoch, or signaling period"},
|
||||
{RPCResult::Type::NUM, "total_valid_epochs", "number of epochs a given fedpscript is valid for, defined per chain"},
|
||||
{RPCResult::Type::NUM, "epoch_age", "number of blocks into a dynamic federation epoch chain tip is. This number is between 0 to epoch_length-1"},
|
||||
{RPCResult::Type::ARR, "extension_space", "array of extension fields in dynamic blockheader",
|
||||
{
|
||||
{RPCResult::Type::ELISION, "", ""}
|
||||
}},
|
||||
{RPCResult::Type::NUM, "pruneheight", /*optional=*/true, "lowest-height complete block stored (only present if pruning is enabled)"},
|
||||
{RPCResult::Type::BOOL, "automatic_pruning", /*optional=*/true, "whether automatic pruning is enabled (only present if pruning is enabled)"},
|
||||
{RPCResult::Type::NUM, "prune_target_size", /*optional=*/true, "the target size used by pruning (only present if automatic pruning is enabled)"},
|
||||
{RPCResult::Type::OBJ_DYN, "softforks", "(DEPRECATED, returned only if config option -deprecatedrpc=softforks is passed) status of softforks",
|
||||
{
|
||||
{RPCResult::Type::OBJ, "xxxx", "name of the softfork",
|
||||
RPCHelpForDeployment
|
||||
},
|
||||
}},
|
||||
{RPCResult::Type::STR, "warnings", "any network and blockchain warnings"},
|
||||
}},
|
||||
RPCExamples{
|
||||
HelpExampleCli("getblockchaininfo", "")
|
||||
"Returns an object containing various state info regarding blockchain processing.\n",
|
||||
{},
|
||||
RPCResult{
|
||||
RPCResult::Type::OBJ, "", "",
|
||||
{
|
||||
{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, "headers", "the current number of headers we have validated"},
|
||||
{RPCResult::Type::STR, "bestblockhash", "the hash of the currently best block"},
|
||||
{RPCResult::Type::NUM, "difficulty", "the current difficulty"},
|
||||
{RPCResult::Type::NUM_TIME, "time", "The block time expressed in " + UNIX_EPOCH_TIME},
|
||||
{RPCResult::Type::NUM_TIME, "mediantime", "The median block time expressed in " + UNIX_EPOCH_TIME},
|
||||
{RPCResult::Type::NUM, "verificationprogress", "estimate of verification progress [0..1]"},
|
||||
{RPCResult::Type::BOOL, "initialblockdownload", "(debug information) estimate of whether this node is in Initial Block Download mode"},
|
||||
{RPCResult::Type::STR_HEX, "chainwork", "total amount of work in active chain, in hexadecimal"},
|
||||
{RPCResult::Type::NUM, "size_on_disk", "the estimated size of the block and undo files on disk"},
|
||||
{RPCResult::Type::BOOL, "pruned", "if the blocks are subject to pruning"},
|
||||
{RPCResult::Type::STR_HEX, "current_params_root", "the root of the currently active dynafed params"},
|
||||
{RPCResult::Type::STR, "signblock_asm", "ASM of sign block challenge data from genesis block"},
|
||||
{RPCResult::Type::STR_HEX, "signblock_hex", "Hex of sign block challenge data from genesis block"},
|
||||
{RPCResult::Type::STR, "current_signblock_asm", "ASM of sign block challenge data enforced on the next block"},
|
||||
{RPCResult::Type::STR_HEX, "current_signblock_hex", "Hex of sign block challenge data enforced on the next block"},
|
||||
{RPCResult::Type::NUM, "max_block_witness", "maximum sized block witness serialized size for the next block"},
|
||||
{RPCResult::Type::NUM, "epoch_length", "length of dynamic federations epoch, or signaling period"},
|
||||
{RPCResult::Type::NUM, "total_valid_epochs", "number of epochs a given fedpscript is valid for, defined per chain"},
|
||||
{RPCResult::Type::NUM, "epoch_age", "number of blocks into a dynamic federation epoch chain tip is. This number is between 0 to epoch_length-1"},
|
||||
{RPCResult::Type::ARR, "extension_space", "array of extension fields in dynamic blockheader",
|
||||
{
|
||||
{RPCResult::Type::ELISION, "", ""}
|
||||
}},
|
||||
{RPCResult::Type::NUM, "pruneheight", /*optional=*/true, "lowest-height complete block stored (only present if pruning is enabled)"},
|
||||
{RPCResult::Type::BOOL, "automatic_pruning", /*optional=*/true, "whether automatic pruning is enabled (only present if pruning is enabled)"},
|
||||
{RPCResult::Type::NUM, "prune_target_size", /*optional=*/true, "the target size used by pruning (only present if automatic pruning is enabled)"},
|
||||
{RPCResult::Type::OBJ_DYN, "softforks", /*optional=*/true, "(DEPRECATED, returned only if config option -deprecatedrpc=softforks is passed) status of softforks",
|
||||
{
|
||||
{RPCResult::Type::OBJ, "xxxx", "name of the softfork",
|
||||
RPCHelpForDeployment
|
||||
},
|
||||
}},
|
||||
{RPCResult::Type::STR, "warnings", "any network and blockchain warnings"},
|
||||
}},
|
||||
RPCExamples{
|
||||
HelpExampleCli("getblockchaininfo", "")
|
||||
+ HelpExampleRpc("getblockchaininfo", "")
|
||||
},
|
||||
},
|
||||
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
|
||||
{
|
||||
const ArgsManager& args{EnsureAnyArgsman(request.context)};
|
||||
|
|
@ -1452,7 +1452,7 @@ const std::vector<RPCResult> RPCHelpForDeployment{
|
|||
{RPCResult::Type::NUM, "count", "the number of blocks with the version bit set in the current period"},
|
||||
{RPCResult::Type::BOOL, "possible", /*optional=*/true, "returns false if there are not enough blocks left in this period to pass activation threshold (only for \"started\" status)"},
|
||||
}},
|
||||
{RPCResult::Type::STR, "signalling", "indicates blocks that signalled with a # and blocks that did not with a -"},
|
||||
{RPCResult::Type::STR, "signalling", /*optional=*/true, "indicates blocks that signalled with a # and blocks that did not with a -"},
|
||||
}},
|
||||
};
|
||||
|
||||
|
|
@ -1482,7 +1482,7 @@ static RPCHelpMan getdeploymentinfo()
|
|||
RPCResult::Type::OBJ, "", "", {
|
||||
{RPCResult::Type::STR, "hash", "requested block hash (or tip)"},
|
||||
{RPCResult::Type::NUM, "height", "requested block height (or tip)"},
|
||||
{RPCResult::Type::OBJ, "deployments", "", {
|
||||
{RPCResult::Type::OBJ_DYN, "deployments", "", {
|
||||
{RPCResult::Type::OBJ, "xxxx", "name of the deployment", RPCHelpForDeployment}
|
||||
}},
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue