Skip to content

Commit ea98d9c

Browse files
committed
rpc: fix/add missing RPCExamples for "Util" RPCs
fixes HelpExampleRpc for - createmultisig adds missing HelpExampleRpc for - deriveaddresses - estimatesmartfee - getdescriptorinfo
1 parent c0b1706 commit ea98d9c

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

src/rpc/mining.cpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1030,7 +1030,8 @@ static UniValue estimatesmartfee(const JSONRPCRequest& request)
10301030
"have been observed to make an estimate for any number of blocks."},
10311031
}},
10321032
RPCExamples{
1033-
HelpExampleCli("estimatesmartfee", "6")
1033+
HelpExampleCli("estimatesmartfee", "6") +
1034+
HelpExampleRpc("estimatesmartfee", "6")
10341035
},
10351036
}.Check(request);
10361037

src/rpc/misc.cpp

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ static RPCHelpMan createmultisig()
9898
"\nCreate a multisig address from 2 public keys\n"
9999
+ HelpExampleCli("createmultisig", "2 \"[\\\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\\\",\\\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\\\"]\"") +
100100
"\nAs a JSON-RPC call\n"
101-
+ HelpExampleRpc("createmultisig", "2, \"[\\\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\\\",\\\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\\\"]\"")
101+
+ HelpExampleRpc("createmultisig", "2, [\"03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd\",\"03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626\"]")
102102
},
103103
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
104104
{
@@ -143,6 +143,8 @@ static RPCHelpMan createmultisig()
143143

144144
static RPCHelpMan getdescriptorinfo()
145145
{
146+
const std::string EXAMPLE_DESCRIPTOR = "wpkh([d34db33f/84h/0h/0h]0279be667ef9dcbbac55a06295Ce870b07029Bfcdb2dce28d959f2815b16f81798)";
147+
146148
return RPCHelpMan{"getdescriptorinfo",
147149
{"\nAnalyses a descriptor.\n"},
148150
{
@@ -160,7 +162,8 @@ static RPCHelpMan getdescriptorinfo()
160162
},
161163
RPCExamples{
162164
"Analyse a descriptor\n" +
163-
HelpExampleCli("getdescriptorinfo", "\"wpkh([d34db33f/84h/0h/0h]0279be667ef9dcbbac55a06295Ce870b07029Bfcdb2dce28d959f2815b16f81798)\"")
165+
HelpExampleCli("getdescriptorinfo", "\"" + EXAMPLE_DESCRIPTOR + "\"") +
166+
HelpExampleRpc("getdescriptorinfo", "\"" + EXAMPLE_DESCRIPTOR + "\"")
164167
},
165168
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
166169
{
@@ -186,6 +189,8 @@ static RPCHelpMan getdescriptorinfo()
186189

187190
static RPCHelpMan deriveaddresses()
188191
{
192+
const std::string EXAMPLE_DESCRIPTOR = "wpkh([d34db33f/84h/0h/0h]xpub6DJ2dNUysrn5Vt36jH2KLBT2i1auw1tTSSomg8PhqNiUtx8QX2SvC9nrHu81fT41fvDUnhMjEzQgXnQjKEu3oaqMSzhSrHMxyyoEAmUHQbY/0/*)#cjjspncu";
193+
189194
return RPCHelpMan{"deriveaddresses",
190195
{"\nDerives one or more addresses corresponding to an output descriptor.\n"
191196
"Examples of output descriptors are:\n"
@@ -208,7 +213,8 @@ static RPCHelpMan deriveaddresses()
208213
},
209214
RPCExamples{
210215
"First three native segwit receive addresses\n" +
211-
HelpExampleCli("deriveaddresses", "\"wpkh([d34db33f/84h/0h/0h]xpub6DJ2dNUysrn5Vt36jH2KLBT2i1auw1tTSSomg8PhqNiUtx8QX2SvC9nrHu81fT41fvDUnhMjEzQgXnQjKEu3oaqMSzhSrHMxyyoEAmUHQbY/0/*)#cjjspncu\" \"[0,2]\"")
216+
HelpExampleCli("deriveaddresses", "\"" + EXAMPLE_DESCRIPTOR + "\" \"[0,2]\"") +
217+
HelpExampleRpc("deriveaddresses", "\"" + EXAMPLE_DESCRIPTOR + "\", \"[0,2]\"")
212218
},
213219
[&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
214220
{

0 commit comments

Comments
 (0)