From 62b1f74116356653d17b4e2a71988de2d1ada093 Mon Sep 17 00:00:00 2001 From: moneromooo-monero Date: Tue, 1 Sep 2015 09:40:33 +0100 Subject: New hardfork class This keeps track of voting via block version, in order to decide when to enable a particular fork's code. --- src/cryptonote_core/CMakeLists.txt | 6 +- src/cryptonote_core/hardfork.cpp | 266 +++++++++++++++++++++++++++++++++++++ src/cryptonote_core/hardfork.h | 205 ++++++++++++++++++++++++++++ 3 files changed, 475 insertions(+), 2 deletions(-) create mode 100644 src/cryptonote_core/hardfork.cpp create mode 100644 src/cryptonote_core/hardfork.h (limited to 'src') diff --git a/src/cryptonote_core/CMakeLists.txt b/src/cryptonote_core/CMakeLists.txt index 6315fc4f0..7b0a5017d 100644 --- a/src/cryptonote_core/CMakeLists.txt +++ b/src/cryptonote_core/CMakeLists.txt @@ -37,7 +37,8 @@ set(cryptonote_core_sources cryptonote_format_utils.cpp difficulty.cpp miner.cpp - tx_pool.cpp) + tx_pool.cpp + hardfork.cpp) set(cryptonote_core_headers) @@ -60,7 +61,8 @@ set(cryptonote_core_private_headers miner.h tx_extra.h tx_pool.h - verification_context.h) + verification_context.h + hardfork.h) if(PER_BLOCK_CHECKPOINT) set(Blocks "blocks") diff --git a/src/cryptonote_core/hardfork.cpp b/src/cryptonote_core/hardfork.cpp new file mode 100644 index 000000000..c7a69dadb --- /dev/null +++ b/src/cryptonote_core/hardfork.cpp @@ -0,0 +1,266 @@ +// Copyright (c) 2015, The Monero Project +// +// 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. +// +// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers + +#include +#include + +#include "cryptonote_core/cryptonote_basic.h" +#include "blockchain_db/blockchain_db.h" +#include "hardfork.h" + +using namespace cryptonote; + +HardFork::HardFork(uint8_t original_version, time_t forked_time, time_t update_time, uint64_t max_history, int threshold_percent, uint64_t checkpoint_period): + original_version(original_version), + forked_time(forked_time), + update_time(update_time), + max_history(max_history), + threshold_percent(threshold_percent), + checkpoint_period(checkpoint_period) +{ + init(); +} + +bool HardFork::add(uint8_t version, uint64_t height, time_t time) +{ + CRITICAL_REGION_LOCAL(lock); + + // add in order + if (version == 0) + return false; + if (!heights.empty()) { + if (version <= heights.back().version) + return false; + if (height <= heights.back().height) + return false; + if (time <= heights.back().time) + return false; + } + heights.push_back({version: version, height: height, time: time}); + return true; +} + +uint8_t HardFork::get_effective_version(const cryptonote::block &block) const +{ + uint8_t version = block.major_version; + if (!heights.empty()) { + uint8_t max_version = heights.back().version; + if (version > max_version) + version = max_version; + } + return version; +} + +bool HardFork::do_check(const cryptonote::block &block) const +{ + return block.major_version >= heights[current_fork_index].version; +} + +bool HardFork::check(const cryptonote::block &block) const +{ + CRITICAL_REGION_LOCAL(lock); + return do_check(block); +} + +bool HardFork::add(const cryptonote::block &block, uint64_t height) +{ + CRITICAL_REGION_LOCAL(lock); + + if (!do_check(block)) + return false; + + const uint8_t version = get_effective_version(block); + + while (versions.size() >= max_history) { + const uint8_t old_version = versions.front(); + last_versions[old_version]--; + assert(last_versions[old_version] >= 0); + versions.pop_front(); + } + + last_versions[version]++; + versions.push_back(version); + + uint8_t voted = get_voted_fork_index(height); + if (voted > current_fork_index) { + for (int v = heights[current_fork_index].version + 1; v <= heights[voted].version; ++v) { + starting[v] = height; + } + current_fork_index = voted; + } + + if (height % checkpoint_period == 0) + checkpoints.push_back(std::make_pair(height, current_fork_index)); + + return true; +} + +void HardFork::init() +{ + CRITICAL_REGION_LOCAL(lock); + versions.clear(); + for (size_t n = 0; n < 256; ++n) + last_versions[n] = 0; + for (size_t n = 0; n < 256; ++n) + starting[n] = std::numeric_limits::max(); + add(original_version, 0, 0); + for (size_t n = 0; n <= original_version; ++n) + starting[n] = 0; + checkpoints.clear(); + current_fork_index = 0; + vote_threshold = (unsigned int)ceilf(max_history * threshold_percent / 100.0f); +} + +bool HardFork::reorganize_from_block_height(const cryptonote::BlockchainDB *db, uint64_t height) +{ + CRITICAL_REGION_LOCAL(lock); + if (!db || height >= db->height()) + return false; + while (!checkpoints.empty() && checkpoints.back().first > height) + checkpoints.pop_back(); + versions.clear(); + + int v; + for (v = 255; v >= 0; --v) { + if (starting[v] <= height) + break; + if (starting[v] != std::numeric_limits::max()) { + starting[v] = std::numeric_limits::max(); + } + } + for (current_fork_index = 0; current_fork_index < heights.size(); ++current_fork_index) { + if (heights[current_fork_index].version == v) + break; + } + for (size_t n = 0; n < 256; ++n) + last_versions[n] = 0; + const uint64_t rescan_height = height >= (max_history - 1) ? height - (max_history - 1) : 0; + for (uint64_t h = rescan_height; h <= height; ++h) { + cryptonote::block b = db->get_block_from_height(h); + const uint8_t v = get_effective_version(b); + last_versions[v]++; + versions.push_back(v); + } + const uint64_t bc_height = db->height(); + for (uint64_t h = height + 1; h < bc_height; ++h) { + add(db->get_block_from_height(h), h); + } + + return true; +} + +bool HardFork::reorganize_from_chain_height(const cryptonote::BlockchainDB *db, uint64_t height) +{ + if (height == 0) + return false; + return reorganize_from_block_height(db, height - 1); +} + +int HardFork::get_voted_fork_index(uint64_t height) const +{ + CRITICAL_REGION_LOCAL(lock); + unsigned int accumulated_votes = 0; + for (unsigned int n = heights.size() - 1; n > current_fork_index; --n) { + uint8_t v = heights[n].version; + accumulated_votes += last_versions[v]; + if (height >= heights[n].height && accumulated_votes >= vote_threshold) { + return n; + } + } + return current_fork_index; +} + +HardFork::State HardFork::get_state(time_t t) const +{ + CRITICAL_REGION_LOCAL(lock); + + // no hard forks setup yet + if (heights.size() <= 1) + return Ready; + + time_t t_last_fork = heights.back().time; + if (t >= t_last_fork + forked_time) + return LikelyForked; + if (t >= t_last_fork + update_time) + return UpdateNeeded; + return Ready; +} + +HardFork::State HardFork::get_state() const +{ + return get_state(time(NULL)); +} + +uint8_t HardFork::get(uint64_t height) const +{ + CRITICAL_REGION_LOCAL(lock); + for (size_t n = 1; n < 256; ++n) { + if (starting[n] > height) + return n - 1; + } + assert(false); + return 255; +} + +uint64_t HardFork::get_start_height(uint8_t version) const +{ + CRITICAL_REGION_LOCAL(lock); + return starting[version]; +} + +uint8_t HardFork::get_current_version() const +{ + CRITICAL_REGION_LOCAL(lock); + return heights[current_fork_index].version; +} + +uint8_t HardFork::get_ideal_version() const +{ + CRITICAL_REGION_LOCAL(lock); + return heights.back().version; +} + +template +void HardFork::serialize(archive_t & ar, const unsigned int version) +{ + CRITICAL_REGION_LOCAL(lock); + ar & forked_time; + ar & update_time; + ar & max_history; + ar & threshold_percent; + ar & original_version; + ar & heights; + ar & last_versions; + ar & starting; + ar & current_fork_index; + ar & vote_threshold; + ar & checkpoint_period; + ar & checkpoints; +} diff --git a/src/cryptonote_core/hardfork.h b/src/cryptonote_core/hardfork.h new file mode 100644 index 000000000..b478dd0cf --- /dev/null +++ b/src/cryptonote_core/hardfork.h @@ -0,0 +1,205 @@ +// Copyright (c) 2015, The Monero Project +// +// 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. +// +// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers + +#pragma once + +#include +#include +#include "syncobj.h" +#include "cryptonote_core/cryptonote_basic.h" + +namespace cryptonote +{ + class BlockchainDB; + + class HardFork + { + public: + typedef enum { + LikelyForked, + UpdateNeeded, + Ready, + } State; + + static const time_t DEFAULT_FORKED_TIME = 31557600; // a year in seconds + static const time_t DEFAULT_UPDATE_TIME = 31557600 / 2; + static const uint64_t DEFAULT_MAX_HISTORY = 50; // supermajority window check length + static const int DEFAULT_THRESHOLD_PERCENT = 80; + static const uint64_t DEFAULT_CHECKPOINT_PERIOD = 1024; // mark a checkpoint every that many blocks + + /** + * @brief creates a new HardFork object + * + * @param original_version the block version for blocks 0 through to the first fork + * @param forked_time the time in seconds before thinking we're forked + * @param update_time the time in seconds before thinking we need to update + * @param max_history the size of the window in blocks to consider for version voting + * @param threshold_percent the size of the majority in percents + */ + HardFork(uint8_t original_version = 1, time_t forked_time = DEFAULT_FORKED_TIME, time_t update_time = DEFAULT_UPDATE_TIME, uint64_t max_history = DEFAULT_MAX_HISTORY, int threshold_percent = DEFAULT_THRESHOLD_PERCENT, uint64_t checkpoint_period = DEFAULT_CHECKPOINT_PERIOD); + + /** + * @brief add a new hardfork height + * + * returns true if no error, false otherwise + * + * @param version the major block version for the fork + * @param height The height the hardfork takes effect + * @param time Approximate time of the hardfork (seconds since epoch) + */ + bool add(uint8_t version, uint64_t height, time_t time); + + /** + * @brief check whether a new block would be accepted + * + * returns true if the block is accepted, false otherwise + * + * @param block the new block + * + * This check is made by add. It is exposed publicly to allow + * the caller to inexpensively check whether a block would be + * accepted or rejected by its version number. Indeed, if this + * check could only be done as part of add, the caller would + * either have to add the block to the blockchain first, then + * call add, then have to pop the block from the blockchain if + * its version did not satisfy the hard fork requirements, or + * call add first, then, if the hard fork requirements are met, + * add the block to the blockchain, upon which a failure (the + * block being invalid, double spending, etc) would cause the + * hardfork object to rescan the blockchain versions past the + * last checkpoint, potentially causing a large number of DB + * operations. + */ + bool check(const cryptonote::block &block) const; + + /** + * @brief add a new block + * + * returns true if no error, false otherwise + * + * @param block the new block + */ + bool add(const cryptonote::block &block, uint64_t height); + + /** + * @brief called when the blockchain is reorganized + * + * This will rescan the blockchain to determine which hard forks + * have been triggered + * + * returns true if no error, false otherwise + * + * @param blockchain the blockchain + * @param height of the last block kept from the previous blockchain + */ + bool reorganize_from_block_height(const cryptonote::BlockchainDB *db, uint64_t height); + bool reorganize_from_chain_height(const cryptonote::BlockchainDB *db, uint64_t height); + + /** + * @brief returns current state at the given time + * + * Based on the approximate time of the last known hard fork, + * estimate whether we need to update, or if we're way behind + * + * @param t the time to consider + */ + State get_state(time_t t) const; + State get_state() const; + + /** + * @brief returns the hard fork version for the given block height + * + * @param height height of the block to check + */ + uint8_t get(uint64_t height) const; + + /** + * @brief returns the height of the first block on the fork with th given version + * + * @param version version of the fork to query the starting block for + */ + uint64_t get_start_height(uint8_t version) const; + + /** + * @brief returns the latest "ideal" version + * + * This is the latest version that's been scheduled + */ + uint8_t get_ideal_version() const; + + /** + * @brief returns the current version + * + * This is the latest version that's past its trigger date and had enough votes + * at one point in the past. + */ + uint8_t get_current_version() const; + + template + void serialize(archive_t & ar, const unsigned int version); + + private: + + void init(); + bool do_check(const cryptonote::block &block) const; + int get_voted_fork_index(uint64_t height) const; + uint8_t get_effective_version(const cryptonote::block &block) const; + + private: + + time_t forked_time; + time_t update_time; + uint64_t max_history; + int threshold_percent; + + uint8_t original_version; + + typedef struct { + uint8_t version; + uint64_t height; + time_t time; + } Params; + std::vector heights; + + std::deque versions; /* rolling window of the last N blocks' versions */ + unsigned int last_versions[256]; /* count of the block versions in the lsat N blocks */ + uint64_t starting[256]; /* block height at which each fork starts */ + unsigned int current_fork_index; + unsigned int vote_threshold; + + uint64_t checkpoint_period; + std::vector> checkpoints; + + mutable epee::critical_section lock; + }; + +} // namespace cryptonote + +BOOST_CLASS_VERSION(cryptonote::HardFork, 1) -- cgit v1.2.3