Skip to content

Commit 4637bbe

Browse files
committed
rpc: Explain active and internal in listdescriptors
The current help text for active and internal in listdescriptors is not particularly helpful. They require the reader to already know what those terms mean. This help text is updated to actually explain the definitions of those words in context of a descriptor wallet.
1 parent 10a626a commit 4637bbe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/wallet/rpc/backup.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1748,13 +1748,13 @@ RPCHelpMan listdescriptors()
17481748
{RPCResult::Type::OBJ, "", "", {
17491749
{RPCResult::Type::STR, "desc", "Descriptor string representation"},
17501750
{RPCResult::Type::NUM, "timestamp", "The creation time of the descriptor"},
1751-
{RPCResult::Type::BOOL, "active", "Activeness flag"},
1752-
{RPCResult::Type::BOOL, "internal", true, "Whether this is an internal or external descriptor; defined only for active descriptors"},
1753-
{RPCResult::Type::ARR_FIXED, "range", true, "Defined only for ranged descriptors", {
1751+
{RPCResult::Type::BOOL, "active", "Whether this descriptor is currently used to generate new addresses"},
1752+
{RPCResult::Type::BOOL, "internal", /*optional=*/true, "True if this descriptor is used to generate change addresses. False if this descriptor is used to generate receiving addresses; defined only for active descriptors"},
1753+
{RPCResult::Type::ARR_FIXED, "range", /*optional=*/true, "Defined only for ranged descriptors", {
17541754
{RPCResult::Type::NUM, "", "Range start inclusive"},
17551755
{RPCResult::Type::NUM, "", "Range end inclusive"},
17561756
}},
1757-
{RPCResult::Type::NUM, "next", true, "The next index to generate addresses from; defined only for ranged descriptors"},
1757+
{RPCResult::Type::NUM, "next", /*optional=*/true, "The next index to generate addresses from; defined only for ranged descriptors"},
17581758
}},
17591759
}}
17601760
}},

0 commit comments

Comments
 (0)