What changed, and why it matters
This commit only fixes mistakes in the text documentation and examples shown to users of the software's remote procedure call (RPC) interface. It changes descriptions of data types, corrects command names in examples, fixes a typo in a backtick, and updates help text to match what the code actually does. There are no code behavior changes, so it cannot be exploited or cause security problems on its own.
No security action needed. Treat as a normal documentation fix.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch is a documentation-only update to RPCHelpMan strings in four source files. It corrects return-type labels (STR_HEX -> STR), fixes a command name in a usage example (importblindingkey -> importissuanceblindingkey), fixes a malformed backtick in getwalletpakinfo, renames a JSON field description from ‘fee reason’ to ‘fee_reason’, updates the rawblindrawtransaction description to reflect actual behavior, and removes empty examples for a required argument in getpegoutkeys. No executable logic, validation, or cryptographic code is modified.
Changed components
src/rpc/output_script.cppsrc/rpc/rawtransaction.cppsrc/wallet/rpc/backup.cppsrc/wallet/rpc/elements.cppInspect captured patch +8 / −10
diff --git a/src/rpc/output_script.cpp b/src/rpc/output_script.cpp
index 4605f81..9bcbc2f 100644
--- a/src/rpc/output_script.cpp
+++ b/src/rpc/output_script.cpp
@@ -51,7 +51,7 @@ static RPCHelpMan validateaddress()
{RPCResult::Type::STR, "address", ""},
{RPCResult::Type::STR_HEX, "scriptPubKey", "The hex-encoded scriptPubKey generated by the address"},
{RPCResult::Type::STR_HEX, "confidential_key", "The raw blinding public key for that address, if any. \"\" if none"},
- {RPCResult::Type::STR_HEX, "unconfidential", "The address without confidentiality key"},
+ {RPCResult::Type::STR, "unconfidential", "The address without confidentiality key"},
{RPCResult::Type::BOOL, "isscript", "If the key is a script"},
{RPCResult::Type::BOOL, "iswitness", "If the address is a witness address"},
{RPCResult::Type::NUM, "witness_version", /*optional=*/true, "The version number of the witness program"},
diff --git a/src/rpc/rawtransaction.cpp b/src/rpc/rawtransaction.cpp
index 2ea9c3e..26ad0fc 100644
--- a/src/rpc/rawtransaction.cpp
+++ b/src/rpc/rawtransaction.cpp
@@ -2557,7 +2557,7 @@ static RPCHelpMan rawblindrawtransaction()
"Returns the hex-encoded raw transaction.\n"
"The input raw transaction cannot have already-blinded outputs.\n"
"The output keys used can be specified by using a confidential address in createrawtransaction.\n"
- "If an additional blinded output is required to make a balanced blinding, a 0-value unspendable output will be added. Since there is no access to the wallet the blinding pubkey from the last output with blinding key will be repeated.\n"
+ "If blinded inputs exist but no output has a blinding pubkey, the caller must add another blindable output; this RPC cannot derive a wallet blinding key and will fail instead of adding a dummy output.\n"
"You can not blind issuances with this call.\n",
{
{"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "A hex-encoded raw transaction."},
diff --git a/src/wallet/rpc/backup.cpp b/src/wallet/rpc/backup.cpp
index cd29303..2ed05bc 100644
--- a/src/wallet/rpc/backup.cpp
+++ b/src/wallet/rpc/backup.cpp
@@ -2037,7 +2037,7 @@ RPCHelpMan restorewallet()
RPCHelpMan getwalletpakinfo()
{
return RPCHelpMan{"getwalletpakinfo",
- "\nReturns relevant pegout authorization key (PAK) information about this wallet. Throws an error if initpegoutwallet` has not been invoked on this wallet.\n",
+ "\nReturns relevant pegout authorization key (PAK) information about this wallet. Throws an error if `initpegoutwallet` has not been invoked on this wallet.\n",
{},
RPCResult{
RPCResult::Type::OBJ, "", "",
@@ -2233,7 +2233,7 @@ RPCHelpMan importissuanceblindingkey()
},
RPCResult{RPCResult::Type::NONE, "", ""},
RPCExamples{
- HelpExampleCli("importblindingkey", "\"my blinded CT address\" <blindinghex>")
+ HelpExampleCli("importissuanceblindingkey", "\"<txid>\" 0 \"<blindingkey>\"")
},
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
{
diff --git a/src/wallet/rpc/elements.cpp b/src/wallet/rpc/elements.cpp
index b455c33..1ea95a2 100644
--- a/src/wallet/rpc/elements.cpp
+++ b/src/wallet/rpc/elements.cpp
@@ -584,7 +584,7 @@ RPCHelpMan sendtomainchain_pak()
{
{RPCResult::Type::STR, "bitcoin_address", "destination address on Bitcoin mainchain"},
{RPCResult::Type::STR_HEX, "txid", "transaction ID of the resulting Liquid transaction"},
- {RPCResult::Type::STR, "fee reason", /*optional=*/true, "If verbose is set to true, the Liquid transaction fee reason"},
+ {RPCResult::Type::STR, "fee_reason", /*optional=*/true, "If verbose is set to true, the Liquid transaction fee reason"},
{RPCResult::Type::STR, "bitcoin_descriptor", "xpubkey of the child destination address"},
{RPCResult::Type::STR, "bip32_counter", "derivation counter for the `bitcoin_descriptor`"},
},
@@ -1962,7 +1962,7 @@ RPCHelpMan getpegoutkeys()
"\n(DEPRECATED) Please see `initpegoutwallet` and `sendtomainchain` for best-supported and easiest workflow. This call is for the Liquid network participants' `offline` wallet ONLY. Returns `sumkeys` corresponding to the sum of the Offline PAK and the imported Bitcoin key. The wallet must have the Offline private PAK to succeed. The output will be used in `generatepegoutproof` and `sendtomainchain`. Care is required to keep the bitcoin private key, as well as the `sumkey` safe, as a leak of both results in the leak of your `offlinekey`. Therefore it is recommended to create Bitcoin keys and do Bitcoin transaction signing directly on an offline wallet co-located with your offline Liquid wallet.\n",
{
{"btcprivkey", RPCArg::Type::STR, RPCArg::Optional::NO, "Base58 Bitcoin private key that will be combined with the offline privkey"},
- {"offlinepubkey", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "Hex pubkey of key to combine with btcprivkey. Primarily intended for integration testing."},
+ {"offlinepubkey", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "33-byte compressed public key encoded as 66 hex characters, to combine with btcprivkey. Primarily intended for integration testing."},
},
RPCResult{
RPCResult::Type::OBJ, "", "",
@@ -1973,10 +1973,8 @@ RPCHelpMan getpegoutkeys()
},
},
RPCExamples{
- HelpExampleCli("getpegoutkeys", "")
- + HelpExampleCli("getpegoutkeys", "\"5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF\" \"0389275d512326f7016e014d8625f709c01f23bd0dc16522bf9845a9ee1ef6cbf9\"")
- + HelpExampleRpc("getpegoutkeys", "")
- + HelpExampleRpc("getpegoutkeys", "\"5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF\", \"0389275d512326f7016e014d8625f709c01f23bd0dc16522bf9845a9ee1ef6cbf9\"")
+ HelpExampleCli("getpegoutkeys", "\"5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF\" \"0389275d512326f7016e014d8625f709c01f23bd0dc16522bf9845a9ee1ef6cbf9\"")
+ + HelpExampleRpc("getpegoutkeys", "\"5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF\", \"0389275d512326f7016e014d8625f709c01f23bd0dc16522bf9845a9ee1ef6cbf9\"")
},
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
{
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.