Skip to content

rpc: fix fields type in man #1568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RuslanProgrammer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

rpc: fix fields type in man #1568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/rpc/blockchain.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1454,14 +1454,14 @@ RPCHelpMan getblockchaininfo()
{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"},
/* ELEMENTS: not present {RPCResult::Type::NUM, "difficulty", "the current difficulty"}, */
{RPCResult::Type::STR_HEX, "bits", "nBits: compact representation of the block difficulty target"},
{RPCResult::Type::STR_HEX, "target", "The difficulty target"},
{RPCResult::Type::STR_HEX, "bits", /*optional=*/true, "nBits: compact representation of the block difficulty target"},
{RPCResult::Type::STR_HEX, "target", /*optional=*/true, "The difficulty target"},
{RPCResult::Type::NUM, "difficulty", /*optional=*/true, "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"},
/* ELEMENTS: not present {RPCResult::Type::STR_HEX, "chainwork", "total amount of work in active chain, in hexadecimal"}, */
{RPCResult::Type::STR_HEX, "chainwork", /*optional=*/true, "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::BOOL, "trim_headers", "whether header trimming is enabled (-trim-headers)"},
Expand Down
19 changes: 12 additions & 7 deletions src/rpc/node.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,8 @@ static RPCHelpMan tweakfedpegscript()
RPCResult::Type::OBJ, "", "",
{
{RPCResult::Type::STR_HEX, "script", "The fedpegscript tweaked with claim_script"},
{RPCResult::Type::STR, "address", "The address corresponding to the tweaked fedpegscript"},
{RPCResult::Type::STR, "p2wsh", "The native segwit address for the tweaked fedpegscript"},
{RPCResult::Type::STR, "p2shwsh", "The P2SH-wrapped segwit address for the tweaked fedpegscript"},
}
},
RPCExamples{""},
Expand Down Expand Up @@ -492,7 +493,11 @@ static RPCHelpMan getpakinfo()
{
{RPCResult::Type::OBJ, "block_paklist", "The PAK list loaded from latest epoch",
{
{RPCResult::Type::ELISION, "", ""}
{RPCResult::Type::ARR, "online", "Online PAK pubkeys in hex",
{{RPCResult::Type::STR_HEX, "", "online pubkey"}}},
{RPCResult::Type::ARR, "offline", "Offline PAK pubkeys in hex",
{{RPCResult::Type::STR_HEX, "", "offline pubkey"}}},
{RPCResult::Type::BOOL, "reject", "Whether peg-outs are rejected (no offline keys)"},
}},
}
},
Expand All @@ -516,9 +521,9 @@ static RPCHelpMan calcfastmerkleroot()
return RPCHelpMan{"calcfastmerkleroot",
"\nhidden utility RPC for computing sha2 midstates\n",
{
{"leaves", RPCArg::Type::ARR, RPCArg::Optional::NO, "array of data to compute the fast merkle root of.",
{"leaves", RPCArg::Type::ARR, RPCArg::Optional::NO, "Array of 32-byte hashes to compute the fast merkle root of.",
{
{"data", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "hex-encoded data"},
{"hash", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "32-byte hex-encoded hash"},
}},
},
RPCResult{
Expand Down Expand Up @@ -548,12 +553,12 @@ static RPCHelpMan calcfastmerkleroot()
static RPCHelpMan dumpassetlabels()
{
return RPCHelpMan{"dumpassetlabels",
"\nLists all known asset id/label pairs in this wallet. This list can be modified with `-assetdir` configuration argument.\n",
"\nLists all known asset label/id pairs known to this node. This list can be modified with the `-assetdir` configuration argument.\n",
{},
RPCResult{
RPCResult::Type::OBJ, "labels", "",
{
{RPCResult::Type::ELISION, "", "the label for each asset id"},
{RPCResult::Type::ELISION, "", "the asset id (hex) for each label"},
},
},
RPCExamples{
Expand Down Expand Up @@ -623,7 +628,7 @@ static RPCHelpMan createblindedaddress()
{"blinding_key", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The blinding public key. This can be obtained for a given address using `getaddressinfo` (`confidential_key` field)."},
},
RPCResult{
RPCResult::Type::STR, "blinded_address", "The blinded address"
RPCResult::Type::STR, "", "The blinded address"
},
RPCExamples{
"\nCreate a blinded address\n"
Expand Down
Loading
Loading