rpc/wallet: add two explicit modes to estimate_mode
This commit is contained in:
parent
b188d80c2d
commit
6fcf448430
3 changed files with 58 additions and 41 deletions
|
@ -19,6 +19,8 @@ enum class FeeEstimateMode {
|
||||||
UNSET, //!< Use default settings based on other criteria
|
UNSET, //!< Use default settings based on other criteria
|
||||||
ECONOMICAL, //!< Force estimateSmartFee to use non-conservative estimates
|
ECONOMICAL, //!< Force estimateSmartFee to use non-conservative estimates
|
||||||
CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates
|
CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates
|
||||||
|
BTC_KB, //!< Use explicit BTC/kB fee given in coin control
|
||||||
|
SAT_B, //!< Use explicit sat/B fee given in coin control
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -40,6 +40,8 @@ const std::vector<std::pair<std::string, FeeEstimateMode>>& FeeModeMap()
|
||||||
{"unset", FeeEstimateMode::UNSET},
|
{"unset", FeeEstimateMode::UNSET},
|
||||||
{"economical", FeeEstimateMode::ECONOMICAL},
|
{"economical", FeeEstimateMode::ECONOMICAL},
|
||||||
{"conservative", FeeEstimateMode::CONSERVATIVE},
|
{"conservative", FeeEstimateMode::CONSERVATIVE},
|
||||||
|
{(CURRENCY_UNIT + "/kB"), FeeEstimateMode::BTC_KB},
|
||||||
|
{(CURRENCY_ATOM + "/B"), FeeEstimateMode::SAT_B},
|
||||||
};
|
};
|
||||||
return FEE_MODES;
|
return FEE_MODES;
|
||||||
}
|
}
|
||||||
|
|
|
@ -45,6 +45,8 @@ using interfaces::FoundBlock;
|
||||||
static const std::string WALLET_ENDPOINT_BASE = "/wallet/";
|
static const std::string WALLET_ENDPOINT_BASE = "/wallet/";
|
||||||
static const std::string HELP_REQUIRING_PASSPHRASE{"\nRequires wallet passphrase to be set with walletpassphrase call if wallet is encrypted.\n"};
|
static const std::string HELP_REQUIRING_PASSPHRASE{"\nRequires wallet passphrase to be set with walletpassphrase call if wallet is encrypted.\n"};
|
||||||
|
|
||||||
|
static const uint32_t WALLET_BTC_KB_TO_SAT_B = COIN / 1000; // 1 sat / B = 0.00001 BTC / kB
|
||||||
|
|
||||||
static inline bool GetAvoidReuseFlag(const CWallet* const pwallet, const UniValue& param) {
|
static inline bool GetAvoidReuseFlag(const CWallet* const pwallet, const UniValue& param) {
|
||||||
bool can_avoid_reuse = pwallet->IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE);
|
bool can_avoid_reuse = pwallet->IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE);
|
||||||
bool avoid_reuse = param.isNull() ? can_avoid_reuse : param.get_bool();
|
bool avoid_reuse = param.isNull() ? can_avoid_reuse : param.get_bool();
|
||||||
|
@ -191,6 +193,42 @@ static std::string LabelFromValue(const UniValue& value)
|
||||||
return label;
|
return label;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update coin control with fee estimation based on the given parameters
|
||||||
|
*
|
||||||
|
* @param[in] pwallet Wallet pointer
|
||||||
|
* @param[in,out] cc Coin control which is to be updated
|
||||||
|
* @param[in] estimate_mode String value (e.g. "ECONOMICAL")
|
||||||
|
* @param[in] estimate_param Parameter (blocks to confirm, explicit fee rate, etc)
|
||||||
|
* @throws a JSONRPCError if estimate_mode is unknown, or if estimate_param is missing when required
|
||||||
|
*/
|
||||||
|
static void SetFeeEstimateMode(const CWallet* pwallet, CCoinControl& cc, const UniValue& estimate_mode, const UniValue& estimate_param)
|
||||||
|
{
|
||||||
|
if (!estimate_mode.isNull()) {
|
||||||
|
if (!FeeModeFromString(estimate_mode.get_str(), cc.m_fee_mode)) {
|
||||||
|
throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid estimate_mode parameter");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (cc.m_fee_mode == FeeEstimateMode::BTC_KB || cc.m_fee_mode == FeeEstimateMode::SAT_B) {
|
||||||
|
if (estimate_param.isNull()) {
|
||||||
|
throw JSONRPCError(RPC_INVALID_PARAMETER, "Selected estimate_mode requires a fee rate");
|
||||||
|
}
|
||||||
|
|
||||||
|
CAmount fee_rate = AmountFromValue(estimate_param);
|
||||||
|
if (cc.m_fee_mode == FeeEstimateMode::SAT_B) {
|
||||||
|
fee_rate /= WALLET_BTC_KB_TO_SAT_B;
|
||||||
|
}
|
||||||
|
|
||||||
|
cc.m_feerate = CFeeRate(fee_rate);
|
||||||
|
|
||||||
|
// default RBF to true for explicit fee rate modes
|
||||||
|
if (cc.m_signal_bip125_rbf == boost::none) cc.m_signal_bip125_rbf = true;
|
||||||
|
} else if (!estimate_param.isNull()) {
|
||||||
|
cc.m_confirm_target = ParseConfirmTarget(estimate_param, pwallet->chain().estimateMaxBlocks());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
static UniValue getnewaddress(const JSONRPCRequest& request)
|
static UniValue getnewaddress(const JSONRPCRequest& request)
|
||||||
{
|
{
|
||||||
RPCHelpMan{"getnewaddress",
|
RPCHelpMan{"getnewaddress",
|
||||||
|
@ -369,7 +407,7 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
|
||||||
{"subtractfeefromamount", RPCArg::Type::BOOL, /* default */ "false", "The fee will be deducted from the amount being sent.\n"
|
{"subtractfeefromamount", RPCArg::Type::BOOL, /* default */ "false", "The fee will be deducted from the amount being sent.\n"
|
||||||
" The recipient will receive less bitcoins than you enter in the amount field."},
|
" The recipient will receive less bitcoins than you enter in the amount field."},
|
||||||
{"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Allow this transaction to be replaced by a transaction with higher fees via BIP 125"},
|
{"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Allow this transaction to be replaced by a transaction with higher fees via BIP 125"},
|
||||||
{"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks)"},
|
{"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)"},
|
||||||
{"estimate_mode", RPCArg::Type::STR, /* default */ "unset", std::string() + "The fee estimate mode, must be one of (case insensitive):\n"
|
{"estimate_mode", RPCArg::Type::STR, /* default */ "unset", std::string() + "The fee estimate mode, must be one of (case insensitive):\n"
|
||||||
" \"" + FeeModes("\"\n\"") + "\""},
|
" \"" + FeeModes("\"\n\"") + "\""},
|
||||||
{"avoid_reuse", RPCArg::Type::BOOL, /* default */ "true", "(only available if avoid_reuse wallet flag is set) Avoid spending from dirty addresses; addresses are considered\n"
|
{"avoid_reuse", RPCArg::Type::BOOL, /* default */ "true", "(only available if avoid_reuse wallet flag is set) Avoid spending from dirty addresses; addresses are considered\n"
|
||||||
|
@ -382,6 +420,8 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
|
||||||
HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1")
|
HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1")
|
||||||
+ HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1 \"donation\" \"seans outpost\"")
|
+ HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1 \"donation\" \"seans outpost\"")
|
||||||
+ HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1 \"\" \"\" true")
|
+ HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1 \"\" \"\" true")
|
||||||
|
+ HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1 \"\" \"\" false true 0.00002 " + (CURRENCY_UNIT + "/kB"))
|
||||||
|
+ HelpExampleCli("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0.1 \"\" \"\" false true 2 " + (CURRENCY_ATOM + "/B"))
|
||||||
+ HelpExampleRpc("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\", 0.1, \"donation\", \"seans outpost\"")
|
+ HelpExampleRpc("sendtoaddress", "\"" + EXAMPLE_ADDRESS[0] + "\", 0.1, \"donation\", \"seans outpost\"")
|
||||||
},
|
},
|
||||||
}.Check(request);
|
}.Check(request);
|
||||||
|
@ -423,20 +463,12 @@ static UniValue sendtoaddress(const JSONRPCRequest& request)
|
||||||
coin_control.m_signal_bip125_rbf = request.params[5].get_bool();
|
coin_control.m_signal_bip125_rbf = request.params[5].get_bool();
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!request.params[6].isNull()) {
|
|
||||||
coin_control.m_confirm_target = ParseConfirmTarget(request.params[6], pwallet->chain().estimateMaxBlocks());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!request.params[7].isNull()) {
|
|
||||||
if (!FeeModeFromString(request.params[7].get_str(), coin_control.m_fee_mode)) {
|
|
||||||
throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid estimate_mode parameter");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
coin_control.m_avoid_address_reuse = GetAvoidReuseFlag(pwallet, request.params[8]);
|
coin_control.m_avoid_address_reuse = GetAvoidReuseFlag(pwallet, request.params[8]);
|
||||||
// We also enable partial spend avoidance if reuse avoidance is set.
|
// We also enable partial spend avoidance if reuse avoidance is set.
|
||||||
coin_control.m_avoid_partial_spends |= coin_control.m_avoid_address_reuse;
|
coin_control.m_avoid_partial_spends |= coin_control.m_avoid_address_reuse;
|
||||||
|
|
||||||
|
SetFeeEstimateMode(pwallet, coin_control, request.params[7], request.params[6]);
|
||||||
|
|
||||||
EnsureWalletIsUnlocked(pwallet);
|
EnsureWalletIsUnlocked(pwallet);
|
||||||
|
|
||||||
CTransactionRef tx = SendMoney(pwallet, dest, nAmount, fSubtractFeeFromAmount, coin_control, std::move(mapValue));
|
CTransactionRef tx = SendMoney(pwallet, dest, nAmount, fSubtractFeeFromAmount, coin_control, std::move(mapValue));
|
||||||
|
@ -778,7 +810,7 @@ static UniValue sendmany(const JSONRPCRequest& request)
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Allow this transaction to be replaced by a transaction with higher fees via BIP 125"},
|
{"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Allow this transaction to be replaced by a transaction with higher fees via BIP 125"},
|
||||||
{"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks)"},
|
{"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)"},
|
||||||
{"estimate_mode", RPCArg::Type::STR, /* default */ "unset", std::string() + "The fee estimate mode, must be one of (case insensitive):\n"
|
{"estimate_mode", RPCArg::Type::STR, /* default */ "unset", std::string() + "The fee estimate mode, must be one of (case insensitive):\n"
|
||||||
" \"" + FeeModes("\"\n\"") + "\""},
|
" \"" + FeeModes("\"\n\"") + "\""},
|
||||||
},
|
},
|
||||||
|
@ -826,15 +858,7 @@ static UniValue sendmany(const JSONRPCRequest& request)
|
||||||
coin_control.m_signal_bip125_rbf = request.params[5].get_bool();
|
coin_control.m_signal_bip125_rbf = request.params[5].get_bool();
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!request.params[6].isNull()) {
|
SetFeeEstimateMode(pwallet, coin_control, request.params[7], request.params[6]);
|
||||||
coin_control.m_confirm_target = ParseConfirmTarget(request.params[6], pwallet->chain().estimateMaxBlocks());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!request.params[7].isNull()) {
|
|
||||||
if (!FeeModeFromString(request.params[7].get_str(), coin_control.m_fee_mode)) {
|
|
||||||
throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid estimate_mode parameter");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
std::set<CTxDestination> destinations;
|
std::set<CTxDestination> destinations;
|
||||||
std::vector<CRecipient> vecSend;
|
std::vector<CRecipient> vecSend;
|
||||||
|
@ -2978,6 +3002,12 @@ void FundTransaction(CWallet* const pwallet, CMutableTransaction& tx, CAmount& f
|
||||||
|
|
||||||
if (options.exists("feeRate"))
|
if (options.exists("feeRate"))
|
||||||
{
|
{
|
||||||
|
if (options.exists("conf_target")) {
|
||||||
|
throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both conf_target and feeRate");
|
||||||
|
}
|
||||||
|
if (options.exists("estimate_mode")) {
|
||||||
|
throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both estimate_mode and feeRate");
|
||||||
|
}
|
||||||
coinControl.m_feerate = CFeeRate(AmountFromValue(options["feeRate"]));
|
coinControl.m_feerate = CFeeRate(AmountFromValue(options["feeRate"]));
|
||||||
coinControl.fOverrideFeeRate = true;
|
coinControl.fOverrideFeeRate = true;
|
||||||
}
|
}
|
||||||
|
@ -2988,20 +3018,7 @@ void FundTransaction(CWallet* const pwallet, CMutableTransaction& tx, CAmount& f
|
||||||
if (options.exists("replaceable")) {
|
if (options.exists("replaceable")) {
|
||||||
coinControl.m_signal_bip125_rbf = options["replaceable"].get_bool();
|
coinControl.m_signal_bip125_rbf = options["replaceable"].get_bool();
|
||||||
}
|
}
|
||||||
if (options.exists("conf_target")) {
|
SetFeeEstimateMode(pwallet, coinControl, options["estimate_mode"], options["conf_target"]);
|
||||||
if (options.exists("feeRate")) {
|
|
||||||
throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both conf_target and feeRate");
|
|
||||||
}
|
|
||||||
coinControl.m_confirm_target = ParseConfirmTarget(options["conf_target"], pwallet->chain().estimateMaxBlocks());
|
|
||||||
}
|
|
||||||
if (options.exists("estimate_mode")) {
|
|
||||||
if (options.exists("feeRate")) {
|
|
||||||
throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot specify both estimate_mode and feeRate");
|
|
||||||
}
|
|
||||||
if (!FeeModeFromString(options["estimate_mode"].get_str(), coinControl.m_fee_mode)) {
|
|
||||||
throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid estimate_mode parameter");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// if options is null and not a bool
|
// if options is null and not a bool
|
||||||
|
@ -3068,7 +3085,7 @@ static UniValue fundrawtransaction(const JSONRPCRequest& request)
|
||||||
},
|
},
|
||||||
{"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Marks this transaction as BIP125 replaceable.\n"
|
{"replaceable", RPCArg::Type::BOOL, /* default */ "wallet default", "Marks this transaction as BIP125 replaceable.\n"
|
||||||
" Allows this transaction to be replaced by a transaction with higher fees"},
|
" Allows this transaction to be replaced by a transaction with higher fees"},
|
||||||
{"conf_target", RPCArg::Type::NUM, /* default */ "wallet default", "Confirmation target (in blocks)"},
|
{"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)"},
|
||||||
{"estimate_mode", RPCArg::Type::STR, /* default */ "unset", std::string() + "The fee estimate mode, must be one of (case insensitive):\n"
|
{"estimate_mode", RPCArg::Type::STR, /* default */ "unset", std::string() + "The fee estimate mode, must be one of (case insensitive):\n"
|
||||||
" \"" + FeeModes("\"\n\"") + "\""},
|
" \"" + FeeModes("\"\n\"") + "\""},
|
||||||
},
|
},
|
||||||
|
@ -3315,11 +3332,7 @@ static UniValue bumpfee(const JSONRPCRequest& request)
|
||||||
if (options.exists("replaceable")) {
|
if (options.exists("replaceable")) {
|
||||||
coin_control.m_signal_bip125_rbf = options["replaceable"].get_bool();
|
coin_control.m_signal_bip125_rbf = options["replaceable"].get_bool();
|
||||||
}
|
}
|
||||||
if (options.exists("estimate_mode")) {
|
SetFeeEstimateMode(pwallet, coin_control, options["estimate_mode"], conf_target);
|
||||||
if (!FeeModeFromString(options["estimate_mode"].get_str(), coin_control.m_fee_mode)) {
|
|
||||||
throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid estimate_mode parameter");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Make sure the results are valid at least up to the most recent block
|
// Make sure the results are valid at least up to the most recent block
|
||||||
|
|
Loading…
Reference in a new issue