Skip to content

Commit d2ce7b7

Browse files
committed
Merge #1570: rpc: fix fields describtion in man
a58014a rpc: fix fields describtion in man (Ruslan Kasheparov) Pull request description: ACKs for top commit: tomt1664: ACK a58014a tested locally Tree-SHA512: b7ea26dcd2119d87f37cd7fdd459347ee5432bd3a1a19c2d639e65bf6e516d0f12cad9e06a34a99184654bc7bfe138c8e568eb74c7bdff4c54c94c5b9a16910e
2 parents 7a53073 + a58014a commit d2ce7b7

4 files changed

Lines changed: 8 additions & 10 deletions

File tree

src/rpc/output_script.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ static RPCHelpMan validateaddress()
5151
{RPCResult::Type::STR, "address", ""},
5252
{RPCResult::Type::STR_HEX, "scriptPubKey", "The hex-encoded scriptPubKey generated by the address"},
5353
{RPCResult::Type::STR_HEX, "confidential_key", "The raw blinding public key for that address, if any. \"\" if none"},
54-
{RPCResult::Type::STR_HEX, "unconfidential", "The address without confidentiality key"},
54+
{RPCResult::Type::STR, "unconfidential", "The address without confidentiality key"},
5555
{RPCResult::Type::BOOL, "isscript", "If the key is a script"},
5656
{RPCResult::Type::BOOL, "iswitness", "If the address is a witness address"},
5757
{RPCResult::Type::NUM, "witness_version", /*optional=*/true, "The version number of the witness program"},

src/rpc/rawtransaction.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2555,7 +2555,7 @@ static RPCHelpMan rawblindrawtransaction()
25552555
"Returns the hex-encoded raw transaction.\n"
25562556
"The input raw transaction cannot have already-blinded outputs.\n"
25572557
"The output keys used can be specified by using a confidential address in createrawtransaction.\n"
2558-
"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"
2558+
"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"
25592559
"You can not blind issuances with this call.\n",
25602560
{
25612561
{"hexstring", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "A hex-encoded raw transaction."},

src/wallet/rpc/backup.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2037,7 +2037,7 @@ RPCHelpMan restorewallet()
20372037
RPCHelpMan getwalletpakinfo()
20382038
{
20392039
return RPCHelpMan{"getwalletpakinfo",
2040-
"\nReturns relevant pegout authorization key (PAK) information about this wallet. Throws an error if initpegoutwallet` has not been invoked on this wallet.\n",
2040+
"\nReturns relevant pegout authorization key (PAK) information about this wallet. Throws an error if `initpegoutwallet` has not been invoked on this wallet.\n",
20412041
{},
20422042
RPCResult{
20432043
RPCResult::Type::OBJ, "", "",
@@ -2233,7 +2233,7 @@ RPCHelpMan importissuanceblindingkey()
22332233
},
22342234
RPCResult{RPCResult::Type::NONE, "", ""},
22352235
RPCExamples{
2236-
HelpExampleCli("importblindingkey", "\"my blinded CT address\" <blindinghex>")
2236+
HelpExampleCli("importissuanceblindingkey", "\"<txid>\" 0 \"<blindingkey>\"")
22372237
},
22382238
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
22392239
{

src/wallet/rpc/elements.cpp

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ RPCHelpMan sendtomainchain_pak()
584584
{
585585
{RPCResult::Type::STR, "bitcoin_address", "destination address on Bitcoin mainchain"},
586586
{RPCResult::Type::STR_HEX, "txid", "transaction ID of the resulting Liquid transaction"},
587-
{RPCResult::Type::STR, "fee reason", /*optional=*/true, "If verbose is set to true, the Liquid transaction fee reason"},
587+
{RPCResult::Type::STR, "fee_reason", /*optional=*/true, "If verbose is set to true, the Liquid transaction fee reason"},
588588
{RPCResult::Type::STR, "bitcoin_descriptor", "xpubkey of the child destination address"},
589589
{RPCResult::Type::STR, "bip32_counter", "derivation counter for the `bitcoin_descriptor`"},
590590
},
@@ -1962,7 +1962,7 @@ RPCHelpMan getpegoutkeys()
19621962
"\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",
19631963
{
19641964
{"btcprivkey", RPCArg::Type::STR, RPCArg::Optional::NO, "Base58 Bitcoin private key that will be combined with the offline privkey"},
1965-
{"offlinepubkey", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "Hex pubkey of key to combine with btcprivkey. Primarily intended for integration testing."},
1965+
{"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."},
19661966
},
19671967
RPCResult{
19681968
RPCResult::Type::OBJ, "", "",
@@ -1973,10 +1973,8 @@ RPCHelpMan getpegoutkeys()
19731973
},
19741974
},
19751975
RPCExamples{
1976-
HelpExampleCli("getpegoutkeys", "")
1977-
+ HelpExampleCli("getpegoutkeys", "\"5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF\" \"0389275d512326f7016e014d8625f709c01f23bd0dc16522bf9845a9ee1ef6cbf9\"")
1978-
+ HelpExampleRpc("getpegoutkeys", "")
1979-
+ HelpExampleRpc("getpegoutkeys", "\"5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF\", \"0389275d512326f7016e014d8625f709c01f23bd0dc16522bf9845a9ee1ef6cbf9\"")
1976+
HelpExampleCli("getpegoutkeys", "\"5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF\" \"0389275d512326f7016e014d8625f709c01f23bd0dc16522bf9845a9ee1ef6cbf9\"")
1977+
+ HelpExampleRpc("getpegoutkeys", "\"5Kb8kLf9zgWQnogidDA76MzPL6TsZZY36hWXMssSzNydYXYB9KF\", \"0389275d512326f7016e014d8625f709c01f23bd0dc16522bf9845a9ee1ef6cbf9\"")
19801978
},
19811979
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
19821980
{

0 commit comments

Comments
 (0)