Skip to content

Commit c594a00

Browse files
committed
wallet: update settxfee help
1 parent d87f0f3 commit c594a00

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

doc/release-notes-20391.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
Updated RPCs
2+
------------
3+
4+
- `settxfee` is marked as deprecated in favor of the new `setfeerate` RPC
5+
described in the "New RPCs" section. This change is part of a larger migration
6+
from BTC/kvB to sat/vB units for fee rates. (#20391)
7+
18
New RPCs
29
------------
310

src/wallet/rpcwallet.cpp

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2310,10 +2310,12 @@ static RPCHelpMan listlockunspent()
23102310
static RPCHelpMan settxfee()
23112311
{
23122312
return RPCHelpMan{"settxfee",
2313-
"\nSet the transaction fee per kB for this wallet. Overrides the global -paytxfee command line parameter.\n"
2314-
"Can be deactivated by passing 0 as the fee. In that case automatic fee selection will be used by default.\n",
2313+
"\n(Deprecated in favor of the setfeerate RPC in " + CURRENCY_ATOM + "/vB, which it is recommended to use instead.)\n"
2314+
"Set the transaction fee rate in " + CURRENCY_UNIT + "/kvB for this wallet.\n"
2315+
"Overrides the global -paytxfee configuration option. Like -paytxfee, it is not persisted after bitcoind shutdown/restart.\n"
2316+
"Can be deactivated by passing 0 as the fee rate, in which case automatic fee selection will be used by default.\n",
23152317
{
2316-
{"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "The transaction fee in " + CURRENCY_UNIT + "/kvB"},
2318+
{"amount", RPCArg::Type::AMOUNT, RPCArg::Optional::NO, "The transaction fee rate in " + CURRENCY_UNIT + "/kvB to set (0 to unset)"},
23172319
},
23182320
RPCResult{
23192321
RPCResult::Type::BOOL, "", "Returns true if successful"

0 commit comments

Comments
 (0)