From a58014af6e8cba2545f38731dddb91dc0680260e Mon Sep 17 00:00:00 2001 From: Ruslan Kasheparov Date: Thu, 2 Jul 2026 14:39:44 +0200 Subject: [PATCH] rpc: fix fields describtion in man --- src/rpc/output_script.cpp | 2 +- src/rpc/rawtransaction.cpp | 2 +- src/wallet/rpc/backup.cpp | 4 ++-- src/wallet/rpc/elements.cpp | 10 ++++------ 4 files changed, 8 insertions(+), 10 deletions(-) diff --git a/src/rpc/output_script.cpp b/src/rpc/output_script.cpp index 4605f8129c..9bcbc2f5e5 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 2ea9c3e21c..26ad0fcb05 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 cd2930390c..2ed05bc7a1 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\" ") + HelpExampleCli("importissuanceblindingkey", "\"\" 0 \"\"") }, [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue { diff --git a/src/wallet/rpc/elements.cpp b/src/wallet/rpc/elements.cpp index b455c33459..1ea95a2a89 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 {