Merge bitcoin/bitcoin#32429: docs: Improve keypoolrefill RPC docs

achow101 · achow101 · commit 95bb305b96a8 · 2025-05-07T14:55:49.000-07:00
ff35a4b docs: Improve `keypoolrefill` RPC docs (w0xlt) Pull request description: Update `keypoolrefill` RPC docs to make it clear that descriptor wallets have 4 ScriptPubKeyManagers by default and each of them is updated in this command, as suggested bitcoin/bitcoin#29924 (comment) Closes bitcoin/bitcoin#29924 ACKs for top commit: achow101: ACK ff35a4b brunoerg: code review ACK ff35a4b Tree-SHA512: b6b9abe3fecebf9551b4ce9280794292c6ac44ccaeb2b9d60eeb4b2c177fe8372d0fe103f99c9cc0baeb2559ec019d1c495c233f24a600531153a38eeacb9670
diff --git a/src/wallet/rpc/addresses.cpp b/src/wallet/rpc/addresses.cpp
@@ -214,7 +214,8 @@ RPCHelpMan listaddressgroupings()
 RPCHelpMan keypoolrefill()
 {
     return RPCHelpMan{"keypoolrefill",
-                "\nFills the keypool."+
+                "Refills each descriptor keypool in the wallet up to the specified number of new keys.\n"
+                "By default, descriptor wallets have 4 active ranged descriptors (\"legacy\", \"p2sh-segwit\", \"bech32\", and \"bech32m\"), each with " + util::ToString(DEFAULT_KEYPOOL_SIZE) + " entries.\n" +
         HELP_REQUIRING_PASSPHRASE,
                 {
                     {"newsize", RPCArg::Type::NUM, RPCArg::DefaultHint{strprintf("%u, or as set by -keypool", DEFAULT_KEYPOOL_SIZE)}, "The new keypool size"},

Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,8 @@ RPCHelpMan listaddressgroupings()`
`214`	`214`	`RPCHelpMan keypoolrefill()`
`215`	`215`	`{`
`216`	`216`	`return RPCHelpMan{"keypoolrefill",`
`217`		`- "\nFills the keypool."+`
	`217`	`+ "Refills each descriptor keypool in the wallet up to the specified number of new keys.\n"`
	`218`	`+ "By default, descriptor wallets have 4 active ranged descriptors (\"legacy\", \"p2sh-segwit\", \"bech32\", and \"bech32m\"), each with " + util::ToString(DEFAULT_KEYPOOL_SIZE) + " entries.\n" +`
`218`	`219`	`HELP_REQUIRING_PASSPHRASE,`
`219`	`220`	`{`
`220`	`221`	`{"newsize", RPCArg::Type::NUM, RPCArg::DefaultHint{strprintf("%u, or as set by -keypool", DEFAULT_KEYPOOL_SIZE)}, "The new keypool size"},`