initial fee updates for block weight based tx construction; moved some functions around (+monero_fee_utils)
parent
4ae115f842
commit
bb9e55d4fe
@ -0,0 +1,277 @@
|
||||
//
|
||||
// monero_fee_utils.cpp
|
||||
// Copyright © 2018 MyMonero. All rights reserved.
|
||||
//
|
||||
// All rights reserved.
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without modification, are
|
||||
// permitted provided that the following conditions are met:
|
||||
//
|
||||
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
||||
// conditions and the following disclaimer.
|
||||
//
|
||||
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
||||
// of conditions and the following disclaimer in the documentation and/or other
|
||||
// materials provided with the distribution.
|
||||
//
|
||||
// 3. Neither the name of the copyright holder nor the names of its contributors may be
|
||||
// used to endorse or promote products derived from this software without specific
|
||||
// prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
||||
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
||||
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
//
|
||||
//
|
||||
//
|
||||
//
|
||||
#include "monero_fee_utils.hpp"
|
||||
#include "wallet_errors.h"
|
||||
#include "string_tools.h"
|
||||
//
|
||||
using namespace std;
|
||||
using namespace boost;
|
||||
using namespace epee;
|
||||
using namespace crypto;
|
||||
using namespace cryptonote;
|
||||
using namespace tools; // for error::
|
||||
using namespace monero_fork_rules;
|
||||
//
|
||||
// used to choose when to stop adding outputs to a tx
|
||||
#define APPROXIMATE_INPUT_BYTES 80
|
||||
//
|
||||
uint32_t monero_fee_utils::default_priority()
|
||||
{
|
||||
return 1; // lowest
|
||||
}
|
||||
//
|
||||
uint64_t monero_fee_utils::get_base_fee( // added as of v8
|
||||
uint64_t fee_per_kb,
|
||||
use_fork_rules_fn_type use_fork_rules_fn
|
||||
) {
|
||||
// since this is the lightwallet…
|
||||
if (use_fork_rules_fn(HF_VERSION_PER_BYTE_FEE, 0/*default*/)) {
|
||||
return fee_per_kb / 1024;
|
||||
} else {
|
||||
return fee_per_kb;
|
||||
}
|
||||
}
|
||||
uint64_t monero_fee_utils::get_fee_quantization_mask(
|
||||
use_fork_rules_fn_type use_fork_rules_fn
|
||||
) {
|
||||
// if(m_light_wallet) {
|
||||
return 1; // "TODO"
|
||||
// }
|
||||
// bool use_per_byte_fee = use_fork_rules(HF_VERSION_PER_BYTE_FEE, 0);
|
||||
// if (!use_per_byte_fee)
|
||||
// return 1;
|
||||
//
|
||||
// uint64_t fee_quantization_mask;
|
||||
// boost::optional<std::string> result = m_node_rpc_proxy.get_fee_quantization_mask(fee_quantization_mask);
|
||||
// if (result)
|
||||
// return 1;
|
||||
// return fee_quantization_mask;
|
||||
}
|
||||
//
|
||||
uint64_t monero_fee_utils::estimated_tx_network_fee(
|
||||
uint64_t fee_per_kb,
|
||||
uint32_t priority,
|
||||
use_fork_rules_fn_type use_fork_rules_fn
|
||||
) {
|
||||
bool bulletproof = use_fork_rules_fn(get_bulletproof_fork(), 0); // eventually just hardcode this to true (?)
|
||||
uint64_t fee_multiplier = get_fee_multiplier(priority, default_priority(), get_fee_algorithm(use_fork_rules_fn), use_fork_rules_fn);
|
||||
std::vector<uint8_t> extra; // blank extra
|
||||
size_t est_tx_size = estimate_rct_tx_size(2, fixed_mixinsize(), 2, extra.size(), bulletproof); // typically ~14kb post-rct, pre-bulletproofs
|
||||
uint64_t estimated_fee = calculate_fee(fee_per_kb, est_tx_size, fee_multiplier);
|
||||
//
|
||||
return estimated_fee;
|
||||
}
|
||||
uint64_t monero_fee_utils::get_upper_transaction_weight_limit(
|
||||
uint64_t upper_transaction_weight_limit__or_0_for_default,
|
||||
use_fork_rules_fn_type use_fork_rules_fn
|
||||
) {
|
||||
if (upper_transaction_weight_limit__or_0_for_default > 0)
|
||||
return upper_transaction_weight_limit__or_0_for_default;
|
||||
uint64_t full_reward_zone = use_fork_rules_fn(5, 10) ? CRYPTONOTE_BLOCK_GRANTED_FULL_REWARD_ZONE_V5 : use_fork_rules_fn(2, 10) ? CRYPTONOTE_BLOCK_GRANTED_FULL_REWARD_ZONE_V2 : CRYPTONOTE_BLOCK_GRANTED_FULL_REWARD_ZONE_V1;
|
||||
if (use_fork_rules_fn(8, 10))
|
||||
return full_reward_zone / 2 - CRYPTONOTE_COINBASE_BLOB_RESERVED_SIZE;
|
||||
else
|
||||
return full_reward_zone - CRYPTONOTE_COINBASE_BLOB_RESERVED_SIZE;
|
||||
}
|
||||
uint64_t monero_fee_utils::get_fee_multiplier(
|
||||
uint32_t priority,
|
||||
uint32_t default_priority,
|
||||
int fee_algorithm,
|
||||
use_fork_rules_fn_type use_fork_rules_fn
|
||||
) {
|
||||
static const struct
|
||||
{
|
||||
size_t count;
|
||||
uint64_t multipliers[4];
|
||||
}
|
||||
multipliers[] =
|
||||
{
|
||||
{ 3, {1, 2, 3} },
|
||||
{ 3, {1, 20, 166} },
|
||||
{ 4, {1, 4, 20, 166} },
|
||||
{ 4, {1, 5, 25, 1000} },
|
||||
};
|
||||
|
||||
if (fee_algorithm == -1)
|
||||
fee_algorithm = get_fee_algorithm(use_fork_rules_fn);
|
||||
|
||||
// 0 -> default (here, x1 till fee algorithm 2, x4 from it)
|
||||
if (priority == 0)
|
||||
priority = default_priority;
|
||||
if (priority == 0)
|
||||
{
|
||||
if (fee_algorithm >= 2)
|
||||
priority = 2;
|
||||
else
|
||||
priority = 1;
|
||||
}
|
||||
|
||||
THROW_WALLET_EXCEPTION_IF(fee_algorithm < 0 || fee_algorithm > 3, error::invalid_priority);
|
||||
|
||||
// 1 to 3/4 are allowed as priorities
|
||||
const uint32_t max_priority = multipliers[fee_algorithm].count;
|
||||
if (priority >= 1 && priority <= max_priority)
|
||||
{
|
||||
return multipliers[fee_algorithm].multipliers[priority-1];
|
||||
}
|
||||
|
||||
THROW_WALLET_EXCEPTION_IF (false, error::invalid_priority);
|
||||
return 1;
|
||||
}
|
||||
int monero_fee_utils::get_fee_algorithm(use_fork_rules_fn_type use_fork_rules_fn)
|
||||
{
|
||||
// changes at v3, v5, v8
|
||||
if (use_fork_rules_fn(HF_VERSION_PER_BYTE_FEE, 0))
|
||||
return 3;
|
||||
if (use_fork_rules_fn(5, 0))
|
||||
return 2;
|
||||
if (use_fork_rules_fn(3, -720 * 14))
|
||||
return 1;
|
||||
return 0;
|
||||
}
|
||||
size_t monero_fee_utils::estimate_rct_tx_size(int n_inputs, int mixin, int n_outputs, size_t extra_size, bool bulletproof)
|
||||
{
|
||||
size_t size = 0;
|
||||
|
||||
// tx prefix
|
||||
|
||||
// first few bytes
|
||||
size += 1 + 6;
|
||||
|
||||
// vin
|
||||
size += n_inputs * (1+6+(mixin+1)*2+32);
|
||||
|
||||
// vout
|
||||
size += n_outputs * (6+32);
|
||||
|
||||
// extra
|
||||
size += extra_size;
|
||||
|
||||
// rct signatures
|
||||
|
||||
// type
|
||||
size += 1;
|
||||
|
||||
// rangeSigs
|
||||
if (bulletproof)
|
||||
{
|
||||
size_t log_padded_outputs = 0;
|
||||
while ((1<<log_padded_outputs) < n_outputs)
|
||||
++log_padded_outputs;
|
||||
size += (2 * (6 + log_padded_outputs) + 4 + 5) * 32 + 3;
|
||||
}
|
||||
else
|
||||
size += (2*64*32+32+64*32) * n_outputs;
|
||||
|
||||
// MGs
|
||||
size += n_inputs * (64 * (mixin+1) + 32);
|
||||
|
||||
// mixRing - not serialized, can be reconstructed
|
||||
/* size += 2 * 32 * (mixin+1) * n_inputs; */
|
||||
|
||||
// pseudoOuts
|
||||
size += 32 * n_inputs;
|
||||
// ecdhInfo
|
||||
size += 2 * 32 * n_outputs;
|
||||
// outPk - only commitment is saved
|
||||
size += 32 * n_outputs;
|
||||
// txnFee
|
||||
size += 4;
|
||||
|
||||
LOG_PRINT_L2("estimated " << (bulletproof ? "bulletproof" : "borromean") << " rct tx size for " << n_inputs << " inputs with ring size " << (mixin+1) << " and " << n_outputs << " outputs: " << size << " (" << ((32 * n_inputs/*+1*/) + 2 * 32 * (mixin+1) * n_inputs + 32 * n_outputs) << " saved)");
|
||||
return size;
|
||||
}
|
||||
size_t monero_fee_utils::estimate_tx_size(bool use_rct, int n_inputs, int mixin, int n_outputs, size_t extra_size, bool bulletproof)
|
||||
{
|
||||
if (use_rct)
|
||||
return estimate_rct_tx_size(n_inputs, mixin, n_outputs, extra_size, bulletproof);
|
||||
else
|
||||
return n_inputs * (mixin+1) * APPROXIMATE_INPUT_BYTES + extra_size;
|
||||
}
|
||||
uint64_t monero_fee_utils::estimate_tx_weight(bool use_rct, int n_inputs, int mixin, int n_outputs, size_t extra_size, bool bulletproof)
|
||||
{
|
||||
size_t size = estimate_tx_size(use_rct, n_inputs, mixin, n_outputs, extra_size, bulletproof);
|
||||
if (use_rct && bulletproof && n_outputs > 2)
|
||||
{
|
||||
const uint64_t bp_base = 368;
|
||||
size_t log_padded_outputs = 2;
|
||||
while ((1<<log_padded_outputs) < n_outputs)
|
||||
++log_padded_outputs;
|
||||
uint64_t nlr = 2 * (6 + log_padded_outputs);
|
||||
const uint64_t bp_size = 32 * (9 + nlr);
|
||||
const uint64_t bp_clawback = (bp_base * (1<<log_padded_outputs) - bp_size) * 4 / 5;
|
||||
MDEBUG("clawback on size " << size << ": " << bp_clawback);
|
||||
size += bp_clawback;
|
||||
}
|
||||
return size;
|
||||
}
|
||||
uint64_t monero_fee_utils::estimate_fee(bool use_per_byte_fee, bool use_rct, int n_inputs, int mixin, int n_outputs, size_t extra_size, bool bulletproof, uint64_t base_fee, uint64_t fee_multiplier, uint64_t fee_quantization_mask)
|
||||
{
|
||||
if (use_per_byte_fee)
|
||||
{
|
||||
const size_t estimated_tx_weight = estimate_tx_weight(use_rct, n_inputs, mixin, n_outputs, extra_size, bulletproof);
|
||||
return calculate_fee_from_weight(base_fee, estimated_tx_weight, fee_multiplier, fee_quantization_mask);
|
||||
}
|
||||
else
|
||||
{
|
||||
const size_t estimated_tx_size = estimate_tx_size(use_rct, n_inputs, mixin, n_outputs, extra_size, bulletproof);
|
||||
return calculate_fee(base_fee, estimated_tx_size, fee_multiplier);
|
||||
}
|
||||
}
|
||||
//
|
||||
uint64_t monero_fee_utils::calculate_fee_from_weight(uint64_t base_fee, uint64_t weight, uint64_t fee_multiplier, uint64_t fee_quantization_mask)
|
||||
{
|
||||
uint64_t fee = weight * base_fee * fee_multiplier;
|
||||
fee = (fee + fee_quantization_mask - 1) / fee_quantization_mask * fee_quantization_mask;
|
||||
return fee;
|
||||
}
|
||||
uint64_t monero_fee_utils::calculate_fee(uint64_t fee_per_kb, const cryptonote::blobdata &blob, uint64_t fee_multiplier)
|
||||
{
|
||||
return calculate_fee(fee_per_kb, blob.size(), fee_multiplier);
|
||||
}
|
||||
|
||||
uint64_t monero_fee_utils::calculate_fee(bool use_per_byte_fee, const cryptonote::transaction &tx, size_t blob_size, uint64_t base_fee, uint64_t fee_multiplier, uint64_t fee_quantization_mask)
|
||||
{
|
||||
if (use_per_byte_fee) {
|
||||
return calculate_fee_from_weight(base_fee, cryptonote::get_transaction_weight(tx, blob_size), fee_multiplier, fee_quantization_mask);
|
||||
} else {
|
||||
return calculate_fee(base_fee, blob_size, fee_multiplier);
|
||||
}
|
||||
}
|
||||
uint64_t monero_fee_utils::calculate_fee(uint64_t fee_per_kb, size_t bytes, uint64_t fee_multiplier)
|
||||
{
|
||||
uint64_t kB = (bytes + 1023) / 1024;
|
||||
//
|
||||
return kB * fee_per_kb * fee_multiplier;
|
||||
}
|
@ -0,0 +1,78 @@
|
||||
//
|
||||
// monero_fee_utils.hpp
|
||||
// Copyright (c) 2014-2018, MyMonero.com
|
||||
//
|
||||
// All rights reserved.
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without modification, are
|
||||
// permitted provided that the following conditions are met:
|
||||
//
|
||||
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
||||
// conditions and the following disclaimer.
|
||||
//
|
||||
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
||||
// of conditions and the following disclaimer in the documentation and/or other
|
||||
// materials provided with the distribution.
|
||||
//
|
||||
// 3. Neither the name of the copyright holder nor the names of its contributors may be
|
||||
// used to endorse or promote products derived from this software without specific
|
||||
// prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
||||
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||||
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
||||
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
//
|
||||
//
|
||||
#ifndef monero_fee_utils_hpp
|
||||
#define monero_fee_utils_hpp
|
||||
//
|
||||
#include <boost/optional.hpp>
|
||||
//
|
||||
#include "string_tools.h"
|
||||
//
|
||||
#include "crypto.h"
|
||||
#include "cryptonote_basic.h"
|
||||
#include "cryptonote_format_utils.h"
|
||||
//
|
||||
#include "monero_fork_rules.hpp"
|
||||
//
|
||||
namespace monero_fee_utils
|
||||
{
|
||||
using namespace std;
|
||||
using namespace boost;
|
||||
using namespace cryptonote;
|
||||
using namespace monero_fork_rules;
|
||||
using namespace crypto;
|
||||
//
|
||||
uint32_t default_priority();
|
||||
//
|
||||
uint64_t get_upper_transaction_weight_limit(uint64_t upper_transaction_weight_limit__or_0_for_default, use_fork_rules_fn_type use_fork_rules_fn);
|
||||
uint64_t get_fee_multiplier(uint32_t priority, uint32_t default_priority, int fee_algorithm, use_fork_rules_fn_type use_fork_rules_fn);
|
||||
int get_fee_algorithm(use_fork_rules_fn_type use_fork_rules_fn);
|
||||
uint64_t get_base_fee(uint64_t fee_per_kb, use_fork_rules_fn_type use_fork_rules_fn);
|
||||
uint64_t get_fee_quantization_mask(use_fork_rules_fn_type use_fork_rules_fn);
|
||||
//
|
||||
uint64_t estimate_fee(bool use_per_byte_fee, bool use_rct, int n_inputs, int mixin, int n_outputs, size_t extra_size, bool bulletproof, uint64_t base_fee, uint64_t fee_multiplier, uint64_t fee_quantization_mask);
|
||||
//
|
||||
uint64_t calculate_fee_from_weight(uint64_t base_fee, uint64_t weight, uint64_t fee_multiplier, uint64_t fee_quantization_mask);
|
||||
uint64_t calculate_fee(uint64_t fee_per_kb, size_t bytes, uint64_t fee_multiplier);
|
||||
uint64_t calculate_fee(uint64_t fee_per_kb, const blobdata &blob, uint64_t fee_multiplier);
|
||||
uint64_t calculate_fee(bool use_per_byte_fee, const cryptonote::transaction &tx, size_t blob_size, uint64_t base_fee, uint64_t fee_multiplier, uint64_t fee_quantization_mask);
|
||||
//
|
||||
size_t estimate_rct_tx_size(int n_inputs, int mixin, int n_outputs, size_t extra_size, bool bulletproof);
|
||||
uint64_t estimate_tx_weight(bool use_rct, int n_inputs, int mixin, int n_outputs, size_t extra_size, bool bulletproof);
|
||||
size_t estimate_tx_size(bool use_rct, int n_inputs, int mixin, int n_outputs, size_t extra_size, bool bulletproof);
|
||||
uint64_t estimated_tx_network_fee( // convenience function for size + calc
|
||||
uint64_t fee_per_kb,
|
||||
uint32_t priority, // when priority=0, falls back to monero_fee_utils::default_priority()
|
||||
use_fork_rules_fn_type use_fork_rules_fn // this is extracted to a function so that implementations can optionally query the daemon (although this presently implies that such a call remains blocking)
|
||||
);
|
||||
}
|
||||
|
||||
#endif /* monero_fee_utils_hpp */
|
Loading…
Reference in new issue