[wallet] [rpc] sendtoaddress/sendmany: Add explicit feerate option #11413

53@@ -54,6 +54,7 @@ bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_esti
54         {"UNSET", FeeEstimateMode::UNSET},
55         {"ECONOMICAL", FeeEstimateMode::ECONOMICAL},
56         {"CONSERVATIVE", FeeEstimateMode::CONSERVATIVE},
57+        {"EXPLICIT", FeeEstimateMode::EXPLICIT},

444@@ -445,12 +445,15 @@ UniValue sendtoaddress(const JSONRPCRequest& request)
445             "       \"UNSET\"\n"
446             "       \"ECONOMICAL\"\n"
447             "       \"CONSERVATIVE\"\n"
448+            "       \"EXPLICIT\"\n"
449+            "9. feerate                (numeric, optional) Fee rate (sat/kb) to use for EXPLICIT mode.\n"

496@@ -494,6 +497,12 @@ UniValue sendtoaddress(const JSONRPCRequest& request)
497         }
498     }
499 
500+    if (!request.params[8].isNull()) {
501+        if (coin_control.m_fee_mode != FeeEstimateMode::EXPLICIT) {
502+            throw JSONRPCError(RPC_INVALID_PARAMETER, "Explicit fee rate can only be used when estimate mode is set to EXPLICIT");

38@@ -39,6 +39,7 @@ static const CRPCConvertParam vRPCConvertParams[] =
39     { "sendtoaddress", 4, "subtractfeefromamount" },
40     { "sendtoaddress", 5 , "replaceable" },
41     { "sendtoaddress", 6 , "conf_target" },
42+    { "sendtoaddress", 8, "feerate"},

444@@ -445,12 +445,15 @@ UniValue sendtoaddress(const JSONRPCRequest& request)
445             "       \"UNSET\"\n"
446             "       \"ECONOMICAL\"\n"
447             "       \"CONSERVATIVE\"\n"
448+            "       \"EXPLICIT\"\n"
449+            "9. feerate                (numeric, optional) Fee rate (sat/kb) to use for EXPLICIT mode. (Note: replaceable defaults to true when used)\n"

496@@ -494,6 +497,14 @@ UniValue sendtoaddress(const JSONRPCRequest& request)
497         }
498     }
499 
500+    if (!request.params[8].isNull()) {

419+        if (coin_control.m_fee_mode != FeeEstimateMode::EXPLICIT) {
420+            coin_control.m_confirm_target = ParseConfirmTarget(request.params[6]);
421+        } else {
422+            coin_control.m_feerate = CFeeRate(request.params[6].get_int());
423+            // default RBF to true for explicit fee rate mode
424+            coin_control.m_signal_bip125_rbf = (coin_control.m_signal_bip125_rbf ? *coin_control.m_signal_bip125_rbf : false) | request.params[5].isNull();

856+        if (coin_control.m_fee_mode != FeeEstimateMode::EXPLICIT) {
857+            coin_control.m_confirm_target = ParseConfirmTarget(request.params[6]);
858+        } else {
859+            coin_control.m_feerate = CFeeRate(request.params[6].get_int());
860+            // default RBF to true for explicit fee rate mode
861+            coin_control.m_signal_bip125_rbf = (coin_control.m_signal_bip125_rbf ? *coin_control.m_signal_bip125_rbf : false) | request.params[5].isNull();

354@@ -355,17 +355,20 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
355             "5. subtractfeefromamount  (boolean, optional, default=false) The fee will be deducted from the amount being sent.\n"
356             "                             The recipient will receive less bitcoins than you enter in the amount field.\n"
357             "6. replaceable            (boolean, optional) Allow this transaction to be replaced by a transaction with higher fees via BIP 125\n"
358-            "7. conf_target            (numeric, optional) Confirmation target (in blocks)\n"
359+            "                             Defaults to false unless explicit estimate mode is used, in which case it defaults to true\n"
360+            "7. conf_target            (numeric, optional) Confirmation target (in blocks), or fee rate (sat/kb) if explicit estimate mode is used\n"

0@@ -0,0 +1,5 @@
1+Low-level RPC changes

356@@ -357,17 +357,20 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
357             "5. subtractfeefromamount  (boolean, optional, default=false) The fee will be deducted from the amount being sent.\n"
358             "                             The recipient will receive less bitcoins than you enter in the amount field.\n"
359             "6. replaceable            (boolean, optional) Allow this transaction to be replaced by a transaction with higher fees via BIP 125\n"
360-            "7. conf_target            (numeric, optional) Confirmation target (in blocks)\n"
361+            "                             Defaults to false unless explicit estimate mode is used, in which case it defaults to true\n"
362+            "7. conf_target            (numeric, optional) Confirmation target (in blocks), or fee rate (BTC/kb) if explicit estimate mode is used\n"

377@@ -377,6 +378,7 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
378             + HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1")
379             + HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"donation\" \"seans outpost\"")
380             + HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"\" \"\" true")
381+            + HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"\" \"\" false true 2000 EXPLICIT")

21@@ -22,6 +22,8 @@ class WalletTest(BitcoinTestFramework):
22     def set_test_params(self):
23         self.num_nodes = 4
24         self.setup_clean_chain = True
25+        # node 2 needs a txindex to look up raw transactions
26+        self.extra_args = [[], [], ["-txindex"], []]

363+            conf_target=0.00002500,
364+            estimate_mode='EXPLICIT',
365+        )
366+        tx_size = self.get_vsize(self.nodes[2].gettransaction(txid)['hex'])
367+        self.sync_all([self.nodes[0:3]])
368+        self.nodes[0].generate(1)

30@@ -31,6 +31,7 @@ bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_esti
31         {"UNSET", FeeEstimateMode::UNSET},
32         {"ECONOMICAL", FeeEstimateMode::ECONOMICAL},
33         {"CONSERVATIVE", FeeEstimateMode::CONSERVATIVE},
34+        {"btc/kb", FeeEstimateMode::BTC_KB},

49@@ -50,6 +50,8 @@ enum class FeeEstimateMode {
50     UNSET,        //!< Use default settings based on other criteria
51     ECONOMICAL,   //!< Force estimateSmartFee to use non-conservative estimates
52     CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates
53+    BTC_KB,       //!< Use explicit BTC/kB fee given in coin control
54+    SAT_B,        //!< Use explicit SAT/b fee given in coin control

375@@ -360,11 +376,13 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
376                     {"subtractfeefromamount", RPCArg::Type::BOOL, /* default */ "false", "The fee will be deducted from the amount being sent.\n"
377             "                             The recipient will receive less bitcoins than you enter in the amount field."},
378                     {"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Allow this transaction to be replaced by a transaction with higher fees via BIP 125"},
379-                    {"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks)"},
380-                    {"estimate_mode", RPCArg::Type::STR, /* default */ "UNSET", "The fee estimate mode, must be one of:\n"
381+                    {"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks), or fee rate (" + CURRENCY_UNIT + "/kB) if " + (CURRENCY_UNIT + "/kB") + " estimate mode is used"},

836@@ -816,11 +837,13 @@ static UniValue sendmany(const JSONRPCRequest& request)
837                         },
838                     },
839                     {"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Allow this transaction to be replaced by a transaction with higher fees via BIP 125"},
840-                    {"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks)"},
841-                    {"estimate_mode", RPCArg::Type::STR, /* default */ "UNSET", "The fee estimate mode, must be one of:\n"
842+                    {"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks), or fee rate (" + CURRENCY_UNIT + "/kB) if " + (CURRENCY_UNIT + "/kB") + " estimate mode is used"},

387@@ -388,7 +388,7 @@ bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::strin
388             key.erase(is_index);
389         }
390 #ifdef WIN32
391-        std::transform(key.begin(), key.end(), key.begin(), ToLower);

49@@ -50,6 +50,8 @@ enum class FeeEstimateMode {
50     UNSET,        //!< Use default settings based on other criteria
51     ECONOMICAL,   //!< Force estimateSmartFee to use non-conservative estimates
52     CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates
53+    BTC_KB,       //!< Use explicit BTC/kB fee given in coin control
54+    SAT_B,        //!< Use explicit SAT/B fee given in coin control

432@@ -413,10 +433,6 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
433         coin_control.m_signal_bip125_rbf = request.params[5].get_bool();
434     }
435 
436-    if (!request.params[6].isNull()) {
437-        coin_control.m_confirm_target = ParseConfirmTarget(request.params[6], pwallet->chain().estimateMaxBlocks());
438-    }
439-
440     if (!request.params[7].isNull()) {
441         if (!FeeModeFromString(request.params[7].get_str(), coin_control.m_fee_mode)) {

375@@ -360,11 +376,13 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
376                     {"subtractfeefromamount", RPCArg::Type::BOOL, /* default */ "false", "The fee will be deducted from the amount being sent.\n"
377             "                             The recipient will receive less bitcoins than you enter in the amount field."},
378                     {"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Allow this transaction to be replaced by a transaction with higher fees via BIP 125"},
379-                    {"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks)"},
380-                    {"estimate_mode", RPCArg::Type::STR, /* default */ "UNSET", "The fee estimate mode, must be one of:\n"
381+                    {"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks), or fee rate (for " + CURRENCY_UNIT + "/KB or " + CURRENCY_ATOM + "/B estimate modes)"},

 7@@ -8,6 +8,7 @@
 8 #include <tinyformat.h>
 9 
10 const std::string CURRENCY_UNIT = "BTC";
11+const std::string CURRENCY_ATOM = "SAT";

392@@ -375,6 +393,8 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
393                     HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1")
394             + HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"donation\" \"seans outpost\"")
395             + HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"\" \"\" true")
396+            + HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"\" \"\" false true 0.00002 " + (CURRENCY_UNIT + "/kB"))
397+            + HelpExampleCli("sendtoaddress", "\"1M72Sfpbz1BPpXFHz9m3CdqATR44Jvaydd\" 0.1 \"\" \"\" false true 2 " + (CURRENCY_ATOM + "/b"))

27@@ -26,15 +28,31 @@ std::string StringForFeeReason(FeeReason reason) {
28     return reason_string->second;
29 }
30 
31-bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode) {
32+const std::map<std::string, FeeEstimateMode>& FeeModeMap() {

42+}
43+
44+std::string FeeModes(const std::string& delimiter = ", ") {
45+    std::ostringstream r;
46+    bool first = true;
47+    for (const auto& i : FeeModeMap()) {

3049-            }
3050-            coinControl.m_confirm_target = ParseConfirmTarget(options["conf_target"], pwallet->chain().estimateMaxBlocks());
3051-        }
3052-        if (options.exists("estimate_mode")) {
3053-            if (options.exists("feeRate")) {
3054-                throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both estimate_mode and feeRate");

3329@@ -3329,10 +3330,11 @@ static UniValue bumpfee(const JSONRPCRequest& request)
3330             },
3331             true, true);
3332 
3333-        if (options.exists("confTarget") && options.exists("totalFee")) {
3334+        auto conf_target_exists = options.exists("confTarget") || options.exists("conf_target");

26@@ -26,15 +27,29 @@ std::string StringForFeeReason(FeeReason reason) {
27     return reason_string->second;
28 }
29 
30-bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode) {
31+const std::map<std::string, FeeEstimateMode>& FeeModeMap() {
32     static const std::map<std::string, FeeEstimateMode> fee_modes = {

174+        if (cc.m_fee_mode == FeeEstimateMode::SAT_B) {
175+            fee_rate /= 100000; // 1 sat / B = 0.00001 BTC / kB
176+        }
177+        cc.m_feerate = CFeeRate(fee_rate);
178+        // default RBF to true for explicit fee rate mode
179+        cc.m_signal_bip125_rbf = (cc.m_signal_bip125_rbf ? *cc.m_signal_bip125_rbf : false) || may_set_rbf;

384-                    {"estimate_mode", RPCArg::Type::STR, /* default */ "UNSET", "The fee estimate mode, must be one of:\n"
385-            "       \"UNSET\"\n"
386-            "       \"ECONOMICAL\"\n"
387-            "       \"CONSERVATIVE\""},
388+                    {"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks), or fee rate (for " + CURRENCY_UNIT + "/KB or " + ToUpper(CURRENCY_ATOM) + "/B estimate modes)"},
389+                    {"estimate_mode", RPCArg::Type::STR, /* default */ "UNSET", std::string() + "The fee estimate mode, must be one of (case insensitive):\n"

43-    auto mode = fee_modes.find(mode_string);
44+    return fee_modes;
45+}
46 
47-    if (mode == fee_modes.end()) return false;
48+std::string FeeModes(const std::string& delimiter = ", ") {

3322@@ -3323,16 +3323,20 @@ static UniValue bumpfee(const JSONRPCRequest& request)
3323         RPCTypeCheckObj(options,
3324             {
3325                 {"confTarget", UniValueType(UniValue::VNUM)},
3326+                {"conf_target", UniValueType(UniValue::VNUM)},

0@@ -0,0 +1,8 @@
1+Low-level RPC changes

816-            "       \"UNSET\"\n"
817-            "       \"ECONOMICAL\"\n"
818-            "       \"CONSERVATIVE\""},
819+                    {"estimate_mode", RPCArg::Type::STR, /* default */ "UNSET", std::string() + "The fee estimate mode, must be one of:\n"
820+            "       \"" + FeeModes("\"\n"
821+            "       \"") + "\""},

29@@ -28,8 +30,8 @@ std::string StringForFeeReason(FeeReason reason) {
30     return reason_string->second;
31 }
32 
33-const std::map<std::string, FeeEstimateMode>& FeeModeMap() {
34-    static const std::map<std::string, FeeEstimateMode> fee_modes = {
35+const std::vector<std::pair<std::string, FeeEstimateMode>>& FeeModeMap() {
36+    static const std::vector<std::pair<std::string, FeeEstimateMode>> fee_modes = {

157@@ -158,6 +158,30 @@ static std::string LabelFromValue(const UniValue& value)
158     return label;
159 }
160 
161+static void SetFeeEstimateMode(CWallet* const pwallet, CCoinControl& cc, const UniValue& estimate_mode, const UniValue& estimate_param)

3329                 {"estimate_mode", UniValueType(UniValue::VSTR)},
3330             },
3331             true, true);
3332 
3333-        if (options.exists("confTarget") && options.exists("totalFee")) {
3334-            throw JSONRPCError(RPC_INVALID_PARAMETER, "confTarget and totalFee options should not both be set. Please provide either a confirmation target for fee estimation or an explicit total fee for the transaction.");

53+}
54 
55-    fee_estimate_mode = mode->second;
56-    return true;
57+bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode) {
58+    auto vector = FeeModeMap();

28@@ -26,16 +29,32 @@ std::string StringForFeeReason(FeeReason reason) {
29     return reason_string->second;
30 }
31 
32-bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode) {
33-    static const std::map<std::string, FeeEstimateMode> fee_modes = {
34+const std::vector<std::pair<std::string, FeeEstimateMode>>& FeeModeMap() {

41+    return fee_modes;
42+}
43 
44-    if (mode == fee_modes.end()) return false;
45+std::string FeeModes(const std::string& delimiter) {
46+    std::ostringstream r;

40-    auto mode = fee_modes.find(mode_string);
41+    return fee_modes;
42+}
43 
44-    if (mode == fee_modes.end()) return false;
45+std::string FeeModes(const std::string& delimiter) {

59-    return true;
60+bool FeeModeFromString(const std::string& mode_string, FeeEstimateMode& fee_estimate_mode) {
61+    auto searchkey = ToUpper(mode_string);
62+    auto vector = FeeModeMap();
63+    for (const auto& pair : vector) {
64+        if (pair.first == searchkey) {

37-        {"CONSERVATIVE", FeeEstimateMode::CONSERVATIVE},
38-    };
39-    auto mode = fee_modes.find(mode_string);
40-
41-    if (mode == fee_modes.end()) return false;
42+static const std::vector<std::pair<std::string, FeeEstimateMode>> fee_modes = {

87@@ -87,6 +88,38 @@ def run_test(self):
88         test_no_more_inputs_fails(rbf_node, dest_address)
89         self.log.info("Success")
90 
91+def test_invalid_parameters(node, dest_address):
92+    txid = spend_one_input(node, dest_address)
93+    # invalid estimate mode
94+    assert_raises_rpc_error(-8, "Invalid estimate_mode parameter", node.bumpfee, txid, {

0@@ -0,0 +1,10 @@
1+Updated or changed RPC
2+----------------------
3+
4+The `bumpfee`, `fundrawtransaction`, `sendmany`, `sendtoaddress`, and `walletcreatefundedpsbt`
5+RPC commands have been updated to include two new fee estimation methods "BTC/KB" and "SAT/B".

 5+RPC commands have been updated to include two new fee estimation methods "BTC/KB" and "SAT/B".
 6+The target is the fee expressed explicitly in the given form.
 7+
 8+In addition, the estimate_mode parameter is now case insensitive for all of the above RPC commands.
 9+
10+The `bumpfee` command now uses `conf_target` rather than `confTarget` in the options.

49+
50+std::string FeeModes(const std::string& delimiter)
51+{
52+    std::string r;
53+    std::string prefix = "";
54+    for (const auto& i : fee_modes) {

177+            fee_rate /= 100000; // 1 sat / B = 0.00001 BTC / kB
178+        }
179+        cc.m_feerate = CFeeRate(fee_rate);
180+        // default RBF to true for explicit fee rate modes
181+        if (cc.m_signal_bip125_rbf == boost::none) cc.m_signal_bip125_rbf = true;
182+    } else {

416+        self.nodes[0].generate(1)
417+        self.sync_all(self.nodes[0:3])
418+        postbalance = self.nodes[2].getbalance()
419+        fee = prebalance - postbalance - Decimal('1')
420+        assert_fee_amount(fee, tx_size, Decimal('0.00002000'))
421+

193+        if (cc.m_fee_mode == FeeEstimateMode::SAT_B) {
194+            fee_rate /= 100000; // 1 sat / B = 0.00001 BTC / kB
195+        }
196+        cc.m_feerate = CFeeRate(fee_rate);
197+        // if feerate < 0.1 sat/b, throw
198+        if (fee_rate < 100) {

38@@ -39,6 +39,10 @@
39 
40 static const std::string WALLET_ENDPOINT_BASE = "/wallet/";
41 
42+static const uint32_t WALLET_MIN_FEERATE = 100; // sat/b
43+
44+static const uint32_t WALLET_BTC_KB_TO_SAT_B = 100000; // 1 sat / B = 0.00001 BTC / kB

38@@ -39,6 +39,10 @@
39 
40 static const std::string WALLET_ENDPOINT_BASE = "/wallet/";
41 
42+static const uint32_t WALLET_MIN_FEERATE = 100; // sat/b

390@@ -338,6 +391,74 @@ def run_test(self):
391         # This will raise an exception for importing an invalid pubkey
392         assert_raises_rpc_error(-5, "Pubkey is not a valid public key", self.nodes[0].importpubkey, "5361746f736869204e616b616d6f746f")
393 
394+        # send with explicit btc/kb fee
395+        self.sync_all(self.nodes[0:3])
396+        self.log.info("test explicit fee (sendtoaddress as btc/kb)")
397+        self.nodes[0].generate(1)

3340@@ -3341,7 +3341,7 @@ static UniValue bumpfee(const JSONRPCRequest& request)
3341                     {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The txid to be bumped"},
3342                     {"options", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED_NAMED_ARG, "",
3343                         {
3344-                            {"confTarget", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks)"},
3345+                            {"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks)"},

193+        }
194+    }
195+
196+    if (cc.m_fee_mode == FeeEstimateMode::BTC_KB || cc.m_fee_mode == FeeEstimateMode::SAT_B) {
197+        if (estimate_param.isNull()) {
198+            throw JSONRPCError(RPC_INVALID_PARAMETER, "Selected estimate_mode requires a confirmation target");

184@@ -183,6 +185,33 @@ static std::string LabelFromValue(const UniValue& value)
185     return label;
186 }
187 
188+static void SetFeeEstimateMode(CWallet* const pwallet, CCoinControl& cc, const UniValue& estimate_mode, const UniValue& estimate_param)

0@@ -0,0 +1,10 @@
1+Updated or changed RPC
2+----------------------
3+
4+The `bumpfee`, `fundrawtransaction`, `sendmany`, `sendtoaddress`, and `walletcreatefundedpsbt`