// Copyright (c) 2014-2022, 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 #if BOOST_VERSION >= 107400 #include #endif #include #include #include #include #include #include #include #include #include #include #include #include "span.h" #include "syncobj.h" #include "string_tools.h" #include "rolling_median.h" #include "cryptonote_basic/cryptonote_basic.h" #include "common/powerof.h" #include "common/util.h" #include "cryptonote_protocol/cryptonote_protocol_defs.h" #include "rpc/core_rpc_server_commands_defs.h" #include "cryptonote_basic/difficulty.h" #include "cryptonote_tx_utils.h" #include "cryptonote_basic/verification_context.h" #include "crypto/hash.h" #include "checkpoints/checkpoints.h" #include "cryptonote_basic/hardfork.h" #include "blockchain_db/blockchain_db.h" namespace tools { class Notify; } namespace cryptonote { class tx_memory_pool; struct test_options; /** Declares ways in which the BlockchainDB backend should be told to sync * */ enum blockchain_db_sync_mode { db_defaultsync, //!< user didn't specify, use db_async db_sync, //!< handle syncing calls instead of the backing db, synchronously db_async, //!< handle syncing calls instead of the backing db, asynchronously db_nosync //!< Leave syncing up to the backing db (safest, but slowest because of disk I/O) }; /** * @brief Callback routine that returns checkpoints data for specific network type * * @param network network type * * @return checkpoints data, empty span if there ain't any checkpoints for specific network type */ typedef std::function(cryptonote::network_type network)> GetCheckpointsCallback; typedef boost::function /* blocks */)> BlockNotifyCallback; typedef boost::function& /* tx_backlog */)> MinerNotifyCallback; /************************************************************************/ /* */ /************************************************************************/ class Blockchain { public: /** * @brief container for passing a block and metadata about it on the blockchain */ struct block_extended_info { block bl; //!< the block uint64_t height; //!< the height of the block in the blockchain uint64_t block_cumulative_weight; //!< the weight of the block difficulty_type cumulative_difficulty; //!< the accumulated difficulty after that block uint64_t already_generated_coins; //!< the total coins minted after that block }; /** * @brief Blockchain constructor * * @param tx_pool a reference to the transaction pool to be kept by the Blockchain */ Blockchain(tx_memory_pool& tx_pool); /** * @brief Blockchain destructor */ ~Blockchain(); /** * @brief Initialize the Blockchain state * * @param db a pointer to the backing store to use for the blockchain * @param nettype network type * @param offline true if running offline, else false * @param test_options test parameters * @param fixed_difficulty fixed difficulty for testing purposes; 0 means disabled * @param get_checkpoints if set, will be called to get checkpoints data * * @return true on success, false if any initialization steps fail */ bool init(BlockchainDB* db, const network_type nettype = MAINNET, bool offline = false, const cryptonote::test_options *test_options = NULL, difficulty_type fixed_difficulty = 0, const GetCheckpointsCallback& get_checkpoints = nullptr); /** * @brief Initialize the Blockchain state * * @param db a pointer to the backing store to use for the blockchain * @param hf a structure containing hardfork information * @param nettype network type * @param offline true if running offline, else false * * @return true on success, false if any initialization steps fail */ bool init(BlockchainDB* db, HardFork*& hf, const network_type nettype = MAINNET, bool offline = false); /** * @brief Uninitializes the blockchain state * * Saves to disk any state that needs to be maintained * * @return true on success, false if any uninitialization steps fail */ bool deinit(); /** * @brief assign a set of blockchain checkpoint hashes * * @param chk_pts the set of checkpoints to assign */ void set_checkpoints(checkpoints&& chk_pts) { m_checkpoints = chk_pts; } /** * @brief get blocks and transactions from blocks based on start height and count * * @param start_offset the height on the blockchain to start at * @param count the number of blocks to get, if there are as many after start_offset * @param blocks return-by-reference container to put result blocks in * @param txs return-by-reference container to put result transactions in * * @return false if start_offset > blockchain height, else true */ bool get_blocks(uint64_t start_offset, size_t count, std::vector>& blocks, std::vector& txs) const; /** * @brief get blocks from blocks based on start height and count * * @param start_offset the height on the blockchain to start at * @param count the number of blocks to get, if there are as many after start_offset * @param blocks return-by-reference container to put result blocks in * * @return false if start_offset > blockchain height, else true */ bool get_blocks(uint64_t start_offset, size_t count, std::vector>& blocks) const; /** * @brief compiles a list of all blocks stored as alternative chains * * @param blocks return-by-reference container to put result blocks in * * @return true */ bool get_alternative_blocks(std::vector& blocks) const; /** * @brief returns the number of alternative blocks stored * * @return the number of alternative blocks stored */ size_t get_alternative_blocks_count() const; /** * @brief gets a block's hash given a height * * @param height the height of the block * * @return the hash of the block at the requested height, or a zeroed hash if there is no such block */ crypto::hash get_block_id_by_height(uint64_t height) const; /** * @brief gets a block's hash given a height * * Used only by prepare_handle_incoming_blocks. Will look in the list of incoming blocks * if the height is contained there. * * @param height the height of the block * * @return the hash of the block at the requested height, or a zeroed hash if there is no such block */ crypto::hash get_pending_block_id_by_height(uint64_t height) const; /** * @brief gets the block with a given hash * * @param h the hash to look for * @param blk return-by-reference variable to put result block in * @param orphan if non-NULL, will be set to true if not in the main chain, false otherwise * * @return true if the block was found, else false */ bool get_block_by_hash(const crypto::hash &h, block &blk, bool *orphan = NULL) const; /** * @brief performs some preprocessing on a group of incoming blocks to speed up verification * * @param blocks_entry a list of incoming blocks * @param blocks the parsed blocks * * @return false on erroneous blocks, else true */ bool prepare_handle_incoming_blocks(const std::vector &blocks_entry, std::vector &blocks); /** * @brief incoming blocks post-processing, cleanup, and disk sync * * @param force_sync if true, and Blockchain is handling syncing to disk, always sync * * @return true */ bool cleanup_handle_incoming_blocks(bool force_sync = false); /** * @brief search the blockchain for a transaction by hash * * @param id the hash to search for * * @return true if the tx exists, else false */ bool have_tx(const crypto::hash &id) const; /** * @brief check if any key image in a transaction has already been spent * * @param tx the transaction to check * * @return true if any key image is already spent in the blockchain, else false */ bool have_tx_keyimges_as_spent(const transaction &tx) const; /** * @brief check if a key image is already spent on the blockchain * * Whenever a transaction output is used as an input for another transaction * (a true input, not just one of a mixing set), a key image is generated * and stored in the transaction in order to prevent double spending. If * this key image is seen again, the transaction using it is rejected. * * @param key_im the key image to search for * * @return true if the key image is already spent in the blockchain, else false */ bool have_tx_keyimg_as_spent(const crypto::key_image &key_im) const; /** * @brief get the current height of the blockchain * * @return the height */ uint64_t get_current_blockchain_height() const; /** * @brief get the hash of the most recent block on the blockchain * * @return the hash */ crypto::hash get_tail_id() const; /** * @brief get the height and hash of the most recent block on the blockchain * * @param height return-by-reference variable to store the height in * * @return the hash */ crypto::hash get_tail_id(uint64_t& height) const; /** * @brief returns the difficulty target the next block to be added must meet * * @return the target */ difficulty_type get_difficulty_for_next_block(); /** * @brief check currently stored difficulties against difficulty checkpoints * * @return {flag, height} flag: true if all difficulty checkpoints pass, height: the last checkpoint height before the difficulty drift bug starts */ std::pair check_difficulty_checkpoints() const; /** * @brief recalculate difficulties for blocks after the last difficulty checkpoints to circumvent the annoying 'difficulty drift' bug * * @param start_height: if omitted, starts recalculation from the last difficulty checkpoint * * @return number of blocks whose difficulties got corrected */ size_t recalculate_difficulties(boost::optional start_height = boost::none); /** * @brief adds a block to the blockchain * * Adds a new block to the blockchain. If the block's parent is not the * current top of the blockchain, the block may be added to an alternate * chain. If the block does not belong, is already in the blockchain * or an alternate chain, or is invalid, return false. * * @param bl_ the block to be added * @param bvc metadata about the block addition's success/failure * * @return true on successful addition to the blockchain, else false */ bool add_new_block(const block& bl_, block_verification_context& bvc); /** * @brief clears the blockchain and starts a new one * * @param b the first block in the new chain (the genesis block) * * @return true on success, else false */ bool reset_and_set_genesis_block(const block& b); /** * @brief creates a new block to mine against * * @param b return-by-reference block to be filled in * @param from_block optional block hash to start mining from (main chain tip if NULL) * @param miner_address address new coins for the block will go to * @param di return-by-reference tells the miner what the difficulty target is * @param height return-by-reference tells the miner what height it's mining against * @param expected_reward return-by-reference the total reward awarded to the miner finding this block, including transaction fees * @param ex_nonce extra data to be added to the miner transaction's extra * * @return true if block template filled in successfully, else false */ bool create_block_template(block& b, const account_public_address& miner_address, difficulty_type& di, uint64_t& height, uint64_t& expected_reward, const blobdata& ex_nonce, uint64_t &seed_height, crypto::hash &seed_hash); bool create_block_template(block& b, const crypto::hash *from_block, const account_public_address& miner_address, difficulty_type& di, uint64_t& height, uint64_t& expected_reward, const blobdata& ex_nonce, uint64_t &seed_height, crypto::hash &seed_hash); /** * @brief gets data required to create a block template and start mining on it * * @param major_version current hardfork version * @param height current blockchain height * @param prev_id hash of the top block * @param seed_hash seed hash used for RandomX initialization * @param difficulty current mining difficulty * @param median_weight current median block weight * @param already_generated_coins current emission * @param tx_backlog transactions in mempool ready to be mined * * @return true if block template filled in successfully, else false */ bool get_miner_data(uint8_t& major_version, uint64_t& height, crypto::hash& prev_id, crypto::hash& seed_hash, difficulty_type& difficulty, uint64_t& median_weight, uint64_t& already_generated_coins, std::vector& tx_backlog); /** * @brief checks if a block is known about with a given hash * * This function checks the main chain, alternate chains, and invalid blocks * for a block with the given hash * * @param id the hash to search for * @param where the type of block, if non NULL * * @return true if the block is known, else false */ bool have_block_unlocked(const crypto::hash& id, int *where = NULL) const; bool have_block(const crypto::hash& id, int *where = NULL) const; /** * @brief gets the total number of transactions on the main chain * * @return the number of transactions on the main chain */ size_t get_total_transactions() const; /** * @brief gets the hashes for a subset of the blockchain * * puts into list a list of hashes representing certain blocks * from the blockchain in reverse chronological order * * the blocks chosen, at the time of this writing, are: * the most recent 11 * powers of 2 less recent from there, so 13, 17, 25, etc... * * @param ids return-by-reference list to put the resulting hashes in * * @return true */ bool get_short_chain_history(std::list& ids) const; /** * @brief get recent block hashes for a foreign chain * * Find the split point between us and foreign blockchain and return * (by reference) the most recent common block hash along with up to * BLOCKS_IDS_SYNCHRONIZING_DEFAULT_COUNT additional (more recent) hashes. * * @param qblock_ids the foreign chain's "short history" (see get_short_chain_history) * @param hashes the hashes to be returned, return-by-reference * @param weights the block weights to be returned, return-by-reference * @param start_height the start height, return-by-reference * @param current_height the current blockchain height, return-by-reference * @param clip_pruned whether to constrain results to unpruned data * * @return true if a block found in common, else false */ bool find_blockchain_supplement(const std::list& qblock_ids, std::vector& hashes, std::vector* weights, uint64_t& start_height, uint64_t& current_height, bool clip_pruned) const; /** * @brief get recent block hashes for a foreign chain * * Find the split point between us and foreign blockchain and return * (by reference) the most recent common block hash along with up to * BLOCKS_IDS_SYNCHRONIZING_DEFAULT_COUNT additional (more recent) hashes. * * @param qblock_ids the foreign chain's "short history" (see get_short_chain_history) * @param clip_pruned clip pruned blocks if true, include them otherwise * @param resp return-by-reference the split height and subsequent blocks' hashes * * @return true if a block found in common, else false */ bool find_blockchain_supplement(const std::list& qblock_ids, bool clip_pruned, NOTIFY_RESPONSE_CHAIN_ENTRY::request& resp) const; /** * @brief find the most recent common point between ours and a foreign chain * * This function takes a list of block hashes from another node * on the network to find where the split point is between us and them. * This is used to see what to send another node that needs to sync. * * @param qblock_ids the foreign chain's "short history" (see get_short_chain_history) * @param starter_offset return-by-reference the most recent common block's height * * @return true if a block found in common, else false */ bool find_blockchain_supplement(const std::list& qblock_ids, uint64_t& starter_offset) const; /** * @brief get recent blocks for a foreign chain * * This function gets recent blocks relative to a foreign chain, starting either at * a requested height or whatever height is the most recent ours and the foreign * chain have in common. * * @param req_start_block if non-zero, specifies a start point (otherwise find most recent commonality) * @param qblock_ids the foreign chain's "short history" (see get_short_chain_history) * @param blocks return-by-reference the blocks and their transactions * @param total_height return-by-reference our current blockchain height * @param start_height return-by-reference the height of the first block returned * @param pruned whether to return full or pruned tx blobs * @param max_block_count the max number of blocks to get * @param max_tx_count the max number of txes to get (it can get overshot by the last block's number of txes minus 1) * * @return true if a block found in common or req_start_block specified, else false */ bool find_blockchain_supplement(const uint64_t req_start_block, const std::list& qblock_ids, std::vector, std::vector > > >& blocks, uint64_t& total_height, uint64_t& start_height, bool pruned, bool get_miner_tx_hash, size_t max_block_count, size_t max_tx_count) const; /** * @brief retrieves a set of blocks and their transactions, and possibly other transactions * * the request object encapsulates a list of block hashes and a (possibly empty) list of * transaction hashes. for each block hash, the block is fetched along with all of that * block's transactions. Any transactions requested separately are fetched afterwards. * * @param arg the request * @param rsp return-by-reference the response to fill in * * @return true unless any blocks or transactions are missing */ bool handle_get_objects(NOTIFY_REQUEST_GET_OBJECTS::request& arg, NOTIFY_RESPONSE_GET_OBJECTS::request& rsp); /** * @brief get number of outputs of an amount past the minimum spendable age * * @param amount the output amount * * @return the number of mature outputs */ uint64_t get_num_mature_outputs(uint64_t amount) const; /** * @brief get the public key for an output * * @param amount the output amount * @param global_index the output amount-global index * * @return the public key */ crypto::public_key get_output_key(uint64_t amount, uint64_t global_index) const; /** * @brief gets specific outputs to mix with * * This function takes an RPC request for outputs to mix with * and creates an RPC response with the resultant output indices. * * Outputs to mix with are specified in the request. * * @param req the outputs to return * @param res return-by-reference the resultant output indices and keys * * @return true */ bool get_outs(const COMMAND_RPC_GET_OUTPUTS_BIN::request& req, COMMAND_RPC_GET_OUTPUTS_BIN::response& res) const; /** * @brief gets an output's key and unlocked state * * @param amount in - the output amount * @param index in - the output global amount index * @param mask out - the output's RingCT mask * @param key out - the output's key * @param unlocked out - the output's unlocked state */ void get_output_key_mask_unlocked(const uint64_t& amount, const uint64_t& index, crypto::public_key& key, rct::key& mask, bool& unlocked) const; /** * @brief gets per block distribution of outputs of a given amount * * @param amount the amount to get a ditribution for * @param from_height the height before which we do not care about the data * @param to_height the height after which we do not care about the data * @param return-by-reference start_height the height of the first rct output * @param return-by-reference distribution the start offset of the first rct output in this block (same as previous if none) * @param return-by-reference base how many outputs of that amount are before the stated distribution */ bool get_output_distribution(uint64_t amount, uint64_t from_height, uint64_t to_height, uint64_t &start_height, std::vector &distribution, uint64_t &base) const; /** * @brief gets the global indices for outputs from a given transaction * * This function gets the global indices for all outputs belonging * to a specific transaction. * * @param tx_id the hash of the transaction to fetch indices for * @param indexs return-by-reference the global indices for the transaction's outputs * @param n_txes how many txes in a row to get results for * * @return false if the transaction does not exist, or if no indices are found, otherwise true */ bool get_tx_outputs_gindexs(const crypto::hash& tx_id, std::vector& indexs) const; bool get_tx_outputs_gindexs(const crypto::hash& tx_id, size_t n_txes, std::vector>& indexs) const; /** * @brief stores the blockchain * * If Blockchain is handling storing of the blockchain (rather than BlockchainDB), * this initiates a blockchain save. * * @return true unless saving the blockchain fails */ bool store_blockchain(); /** * @brief validates a transaction's inputs * * validates a transaction's inputs as correctly used and not previously * spent. also returns the hash and height of the most recent block * which contains an output that was used as an input to the transaction. * The transaction's rct signatures, if any, are expanded. * * @param tx the transaction to validate * @param pmax_used_block_height return-by-reference block height of most recent input * @param max_used_block_id return-by-reference block hash of most recent input * @param tvc returned information about tx verification * @param kept_by_block whether or not the transaction is from a previously-verified block * * @return false if any input is invalid, otherwise true */ bool check_tx_inputs(transaction& tx, uint64_t& pmax_used_block_height, crypto::hash& max_used_block_id, tx_verification_context &tvc, bool kept_by_block = false) const; /** * @brief get fee quantization mask * * The dynamic fee may be quantized, to mask out the last decimal places * * @return the fee quantized mask */ static uint64_t get_fee_quantization_mask() { return tools::PowerOf<10, CRYPTONOTE_DISPLAY_DECIMAL_POINT - PER_KB_FEE_QUANTIZATION_DECIMALS>::Value; } /** * @brief get dynamic per kB or byte fee for a given block weight * * The dynamic fee is based on the block weight in a past window, and * the current block reward. It is expressed by kB before v8, and * per byte from v8. * * @param block_reward the current block reward * @param median_block_weight the median block weight in the past window * @param version hard fork version for rules and constants to use * * @return the fee */ static uint64_t get_dynamic_base_fee(uint64_t block_reward, size_t median_block_weight, uint8_t version); /** * @brief get dynamic per kB or byte fee estimate for the next few blocks * * The dynamic fee is based on the block weight in a past window, and * the current block reward. It is expressed by kB before v8, and * per byte from v8. * This function calculates an estimate for a dynamic fee which will be * valid for the next grace_blocks * * @param grace_blocks number of blocks we want the fee to be valid for * * @return the fee estimate */ uint64_t get_dynamic_base_fee_estimate(uint64_t grace_blocks) const; void get_dynamic_base_fee_estimate_2021_scaling(uint64_t grace_blocks, uint64_t base_reward, uint64_t Mnw, uint64_t Mlw, std::vector &fees) const; /** * @brief get four levels of dynamic per byte fee estimate for the next few blocks * * The dynamic fee is based on the block weight in a past window, and * the current block reward. It is expressed per byte, and is based on * https://github.com/ArticMine/Monero-Documents/blob/master/MoneroScaling2021-02.pdf * This function calculates an estimate for a dynamic fee which will be * valid for the next grace_blocks * * @param grace_blocks number of blocks we want the fee to be valid for * * @return the fee estimates (4 of them) */ void get_dynamic_base_fee_estimate_2021_scaling(uint64_t grace_blocks, std::vector &fees) const; /** * @brief validate a transaction's fee * * This function validates the fee is enough for the transaction. * This is based on the weight of the transaction, and, after a * height threshold, on the average weight of transaction in a past window * * @param tx_weight the transaction weight * @param fee the fee * * @return true if the fee is enough, false otherwise */ bool check_fee(size_t tx_weight, uint64_t fee) const; /** * @brief check that a transaction's outputs conform to current standards * * This function checks, for example at the time of this writing, that * each output is of the form a * 10^b (phrased differently, that if * written out would have only one non-zero digit in base 10). * * @param tx the transaction to check the outputs of * @param tvc returned info about tx verification * * @return false if any outputs do not conform, otherwise true */ bool check_tx_outputs(const transaction& tx, tx_verification_context &tvc) const; /** * @brief gets the block weight limit based on recent blocks * * @return the limit */ uint64_t get_current_cumulative_block_weight_limit() const; /** * @brief gets the long term block weight for a new block * * @return the long term block weight */ uint64_t get_next_long_term_block_weight(uint64_t block_weight) const; /** * @brief gets the block weight median based on recent blocks (same window as for the limit) * * @return the median */ uint64_t get_current_cumulative_block_weight_median() const; /** * @brief gets the difficulty of the block with a given height * * @param i the height * * @return the difficulty */ difficulty_type block_difficulty(uint64_t i) const; /** * @brief gets blocks based on a list of block hashes * * @tparam t_ids_container a standard-iterable container * @tparam t_blocks_container a standard-iterable container * @tparam t_missed_container a standard-iterable container * @param block_ids a container of block hashes for which to get the corresponding blocks * @param blocks return-by-reference a container to store result blocks in * @param missed_bs return-by-reference a container to store missed blocks in * * @return false if an unexpected exception occurs, else true */ template bool get_blocks(const t_ids_container& block_ids, t_blocks_container& blocks, t_missed_container& missed_bs) const; /** * @brief gets transactions based on a list of transaction hashes * * @tparam t_ids_container a standard-iterable container * @tparam t_tx_container a standard-iterable container * @tparam t_missed_container a standard-iterable container * @param txs_ids a container of hashes for which to get the corresponding transactions * @param txs return-by-reference a container to store result transactions in * @param missed_txs return-by-reference a container to store missed transactions in * @param pruned whether to return full or pruned blobs * * @return false if an unexpected exception occurs, else true */ bool get_transactions_blobs(const std::vector& txs_ids, std::vector& txs, std::vector& missed_txs, bool pruned = false) const; bool get_transactions_blobs(const std::vector& txs_ids, std::vector& txs, std::vector& missed_txs, bool pruned = false) const; template bool get_split_transactions_blobs(const t_ids_container& txs_ids, t_tx_container& txs, t_missed_container& missed_txs) const; template bool get_transactions(const t_ids_container& txs_ids, t_tx_container& txs, t_missed_container& missed_txs, bool pruned = false) const; //debug functions /** * @brief check the blockchain against a set of checkpoints * * If a block fails a checkpoint and enforce is enabled, the blockchain * will be rolled back to two blocks prior to that block. If enforce * is disabled, as is currently the default case with DNS-based checkpoints, * an error will be printed to the user but no other action will be taken. * * @param points the checkpoints to check against * @param enforce whether or not to take action on failure */ void check_against_checkpoints(const checkpoints& points, bool enforce); /** * @brief configure whether or not to enforce DNS-based checkpoints * * @param enforce the new enforcement setting */ void set_enforce_dns_checkpoints(bool enforce); /** * @brief loads new checkpoints from a file and optionally from DNS * * @param file_path the path of the file to look for and load checkpoints from * @param check_dns whether or not to check for new DNS-based checkpoints * * @return false if any enforced checkpoint type fails to load, otherwise true */ bool update_checkpoints(const std::string& file_path, bool check_dns); // user options, must be called before calling init() /** * @brief sets various performance options * * @param maxthreads max number of threads when preparing blocks for addition * @param sync_on_blocks whether to sync based on blocks or bytes * @param sync_threshold number of blocks/bytes to cache before syncing to database * @param sync_mode the ::blockchain_db_sync_mode to use * @param fast_sync sync using built-in block hashes as trusted */ void set_user_options(uint64_t maxthreads, bool sync_on_blocks, uint64_t sync_threshold, blockchain_db_sync_mode sync_mode, bool fast_sync); /** * @brief sets a block notify object to call for every new block * * @param notify the notify object to call at every new block */ void add_block_notify(BlockNotifyCallback&& notify); /** * @brief sets a miner notify object to call for every new block * * @param notify the notify object to call at every new block */ void add_miner_notify(MinerNotifyCallback&& notify); /** * @brief sets a reorg notify object to call for every reorg * * @param notify the notify object to call at every reorg */ void set_reorg_notify(const std::shared_ptr ¬ify) { m_reorg_notify = notify; } /** * @brief Put DB in safe sync mode */ void safesyncmode(const bool onoff); /** * @brief set whether or not to show/print time statistics * * @param stats the new time stats setting */ void set_show_time_stats(bool stats) { m_show_time_stats = stats; } /** * @brief gets the hardfork voting state object * * @return the HardFork object */ HardFork::State get_hard_fork_state() const; /** * @brief gets the current hardfork version in use/voted for * * @return the version */ uint8_t get_current_hard_fork_version() const { return m_hardfork->get_current_version(); } /** * @brief returns the newest hardfork version known to the blockchain * * @return the version */ uint8_t get_ideal_hard_fork_version() const { return m_hardfork->get_ideal_version(); } /** * @brief returns the next hardfork version * * @return the version */ uint8_t get_next_hard_fork_version() const { return m_hardfork->get_next_version(); } /** * @brief returns the newest hardfork version voted to be enabled * as of a certain height * * @param height the height for which to check version info * * @return the version */ uint8_t get_ideal_hard_fork_version(uint64_t height) const { return m_hardfork->get_ideal_version(height); } /** * @brief returns the actual hardfork version for a given block height * * @param height the height for which to check version info * * @return the version */ uint8_t get_hard_fork_version(uint64_t height) const { return m_hardfork->get(height); } /** * @brief returns the earliest block a given version may activate * * @return the height */ uint64_t get_earliest_ideal_height_for_version(uint8_t version) const { return m_hardfork->get_earliest_ideal_height_for_version(version); } /** * @brief get information about hardfork voting for a version * * @param version the version in question * @param window the size of the voting window * @param votes the number of votes to enable * @param threshold the number of votes required to enable * @param earliest_height the earliest height at which is allowed * @param voting which version this node is voting for/using * * @return whether the version queried is enabled */ bool get_hard_fork_voting_info(uint8_t version, uint32_t &window, uint32_t &votes, uint32_t &threshold, uint64_t &earliest_height, uint8_t &voting) const; /** * @brief get difficulty target based on chain and hardfork version * * @return difficulty target */ uint64_t get_difficulty_target() const; /** * @brief remove transactions from the transaction pool (if present) * * @param txids a list of hashes of transactions to be removed * * @return false if any removals fail, otherwise true */ bool flush_txes_from_pool(const std::vector &txids); /** * @brief return a histogram of outputs on the blockchain * * @param amounts optional set of amounts to lookup * @param unlocked whether to restrict instances to unlocked ones * @param recent_cutoff timestamp to consider outputs as recent * @param min_count return only amounts with at least that many instances * * @return a set of amount/instances */ std::map> get_output_histogram(const std::vector &amounts, bool unlocked, uint64_t recent_cutoff, uint64_t min_count = 0) const; /** * @brief perform a check on all key images in the blockchain * * @param std::function the check to perform, pass/fail * * @return false if any key image fails the check, otherwise true */ bool for_all_key_images(std::function) const; /** * @brief perform a check on all blocks in the blockchain in the given range * * @param h1 the start height * @param h2 the end height * @param std::function the check to perform, pass/fail * * @return false if any block fails the check, otherwise true */ bool for_blocks_range(const uint64_t& h1, const uint64_t& h2, std::function) const; /** * @brief perform a check on all transactions in the blockchain * * @param std::function the check to perform, pass/fail * @param bool pruned whether to return pruned txes only * * @return false if any transaction fails the check, otherwise true */ bool for_all_transactions(std::function, bool pruned) const; /** * @brief perform a check on all outputs in the blockchain * * @param std::function the check to perform, pass/fail * * @return false if any output fails the check, otherwise true */ bool for_all_outputs(std::function) const; /** * @brief perform a check on all outputs of a given amount in the blockchain * * @param amount the amount to iterate through * @param std::function the check to perform, pass/fail * * @return false if any output fails the check, otherwise true */ bool for_all_outputs(uint64_t amount, std::function) const; /** * @brief get a reference to the BlockchainDB in use by Blockchain * * @return a reference to the BlockchainDB instance */ const BlockchainDB& get_db() const { return *m_db; } /** * @brief get a reference to the BlockchainDB in use by Blockchain * * @return a reference to the BlockchainDB instance */ BlockchainDB& get_db() { return *m_db; } /** * @brief get a number of outputs of a specific amount * * @param amount the amount * @param offsets the indices (indexed to the amount) of the outputs * @param outputs return-by-reference the outputs collected */ void output_scan_worker(const uint64_t amount,const std::vector &offsets, std::vector &outputs) const; /** * @brief computes the "short" and "long" hashes for a set of blocks * * @param height the height of the first block * @param blocks the blocks to be hashed * @param map return-by-reference the hashes for each block */ void block_longhash_worker(uint64_t height, const epee::span &blocks, std::unordered_map &map) const; /** * @brief returns a set of known alternate chains * * @return a vector of chains */ std::vector>> get_alternative_chains() const; void add_txpool_tx(const crypto::hash &txid, const cryptonote::blobdata &blob, const txpool_tx_meta_t &meta); void update_txpool_tx(const crypto::hash &txid, const txpool_tx_meta_t &meta); void remove_txpool_tx(const crypto::hash &txid); uint64_t get_txpool_tx_count(bool include_sensitive = false) const; bool get_txpool_tx_meta(const crypto::hash& txid, txpool_tx_meta_t &meta) const; bool get_txpool_tx_blob(const crypto::hash& txid, cryptonote::blobdata &bd, relay_category tx_category) const; cryptonote::blobdata get_txpool_tx_blob(const crypto::hash& txid, relay_category tx_category) const; bool for_all_txpool_txes(std::function, bool include_blob = false, relay_category tx_category = relay_category::broadcasted) const; bool txpool_tx_matches_category(const crypto::hash& tx_hash, relay_category category); bool is_within_compiled_block_hash_area() const { return is_within_compiled_block_hash_area(m_db->height()); } uint64_t prevalidate_block_hashes(uint64_t height, const std::vector &hashes, const std::vector &weights); uint32_t get_blockchain_pruning_seed() const { return m_db->get_blockchain_pruning_seed(); } bool prune_blockchain(uint32_t pruning_seed = 0); bool update_blockchain_pruning(); bool check_blockchain_pruning(); void lock(); void unlock(); void cancel(); /** * @brief called when we see a tx originating from a block * * Used for handling txes from historical blocks in a fast way */ void on_new_tx_from_block(const cryptonote::transaction &tx); /** * @brief returns the timestamps of the last N blocks */ std::vector get_last_block_timestamps(unsigned int blocks) const; /** * @brief removes blocks from the top of the blockchain * * @param nblocks number of blocks to be removed */ void pop_blocks(uint64_t nblocks); /** * @brief checks whether a given block height is included in the precompiled block hash area * * @param height the height to check for */ bool is_within_compiled_block_hash_area(uint64_t height) const; /** * @brief checks whether we have known weights for the given block heights * * @param height the start height to check for * @param nblocks how many blocks to check from that height */ bool has_block_weights(uint64_t height, uint64_t nblocks) const; /** * @brief flush the invalid blocks set */ void flush_invalid_blocks(); /** * @brief get the "adjusted time" * * Computes the median timestamp of the previous 60 blocks, projects it * onto the current block to get an 'adjusted median time' which approximates * what the current block's timestamp should be. Also projects the previous * block's timestamp to estimate the current block's timestamp. * * Returns the minimum of the two projections, or the current local time on * the machine if less than 60 blocks are available. * * @return current time approximated from chain data */ uint64_t get_adjusted_time(uint64_t height) const; #ifndef IN_UNIT_TESTS private: #endif // TODO: evaluate whether or not each of these typedefs are left over from blockchain_storage typedef std::unordered_set key_images_container; typedef std::vector blocks_container; typedef std::unordered_map blocks_ext_by_hash; BlockchainDB* m_db; tx_memory_pool& m_tx_pool; mutable epee::critical_section m_blockchain_lock; // TODO: add here reader/writer lock // main chain size_t m_current_block_cumul_weight_limit; size_t m_current_block_cumul_weight_median; // metadata containers std::unordered_map>> m_scan_table; std::unordered_map m_blocks_longhash_table; // Keccak hashes for each block and for fast pow checking std::vector> m_blocks_hash_of_hashes; std::vector> m_blocks_hash_check; std::vector m_blocks_txs_check; blockchain_db_sync_mode m_db_sync_mode; bool m_fast_sync; bool m_show_time_stats; bool m_db_default_sync; bool m_db_sync_on_blocks; uint64_t m_db_sync_threshold; uint64_t m_max_prepare_blocks_threads; uint64_t m_fake_pow_calc_time; uint64_t m_fake_scan_time; uint64_t m_sync_counter; uint64_t m_bytes_to_sync; std::vector m_timestamps; std::vector m_difficulties; uint64_t m_timestamps_and_difficulties_height; bool m_reset_timestamps_and_difficulties_height; uint64_t m_long_term_block_weights_window; uint64_t m_long_term_effective_median_block_weight; mutable crypto::hash m_long_term_block_weights_cache_tip_hash; mutable epee::misc_utils::rolling_median_t m_long_term_block_weights_cache_rolling_median; epee::critical_section m_difficulty_lock; crypto::hash m_difficulty_for_next_block_top_hash; difficulty_type m_difficulty_for_next_block; boost::asio::io_service m_async_service; boost::thread_group m_async_pool; std::unique_ptr m_async_work_idle; // some invalid blocks blocks_ext_by_hash m_invalid_blocks; // crypto::hash -> block_extended_info checkpoints m_checkpoints; bool m_enforce_dns_checkpoints; HardFork *m_hardfork; network_type m_nettype; bool m_offline; difficulty_type m_fixed_difficulty; std::atomic m_cancel; // block template cache block m_btc; account_public_address m_btc_address; blobdata m_btc_nonce; difficulty_type m_btc_difficulty; uint64_t m_btc_height; uint64_t m_btc_pool_cookie; uint64_t m_btc_expected_reward; crypto::hash m_btc_seed_hash; uint64_t m_btc_seed_height; bool m_btc_valid; bool m_batch_success; /* `boost::function` is used because the implementation never allocates if the callable object has a single `std::shared_ptr` or `std::weap_ptr` internally. Whereas, the libstdc++ `std::function` will allocate. */ std::vector m_block_notifiers; std::vector m_miner_notifiers; std::shared_ptr m_reorg_notify; // for prepare_handle_incoming_blocks uint64_t m_prepare_height; uint64_t m_prepare_nblocks; std::vector *m_prepare_blocks; /** * @brief collects the keys for all outputs being "spent" as an input * * This function makes sure that each "input" in an input (mixins) exists * and collects the public key for each from the transaction it was included in * via the visitor passed to it. * * If pmax_related_block_height is not NULL, its value is set to the height * of the most recent block which contains an output used in the input set * * @tparam visitor_t a class encapsulating tx is unlocked and collect tx key * @param tx_in_to_key a transaction input instance * @param vis an instance of the visitor to use * @param tx_prefix_hash the hash of the associated transaction_prefix * @param pmax_related_block_height return-by-pointer the height of the most recent block in the input set * @param tx_version version of the tx, if > 1 we also get commitments * * @return false if any keys are not found or any inputs are not unlocked, otherwise true */ template inline bool scan_outputkeys_for_indexes(size_t tx_version, const txin_to_key& tx_in_to_key, visitor_t &vis, const crypto::hash &tx_prefix_hash, uint64_t* pmax_related_block_height = NULL) const; /** * @brief collect output public keys of a transaction input set * * This function locates all outputs associated with a given input set (mixins) * and validates that they exist and are usable * (unlocked, unspent is checked elsewhere). * * If pmax_related_block_height is not NULL, its value is set to the height * of the most recent block which contains an output used in the input set * * @param tx_version the transaction version * @param txin the transaction input * @param tx_prefix_hash the transaction prefix hash, for caching organization * @param sig the input signature * @param output_keys return-by-reference the public keys of the outputs in the input set * @param rct_signatures the ringCT signatures, which are only valid if tx version > 1 * @param pmax_related_block_height return-by-pointer the height of the most recent block in the input set * @param hf_version the consensus rules version to use * * @return false if any output is not yet unlocked, or is missing, otherwise true */ bool check_tx_input(size_t tx_version,const txin_to_key& txin, const crypto::hash& tx_prefix_hash, const std::vector& sig, const rct::rctSig &rct_signatures, std::vector &output_keys, uint64_t* pmax_related_block_height, uint8_t hf_version) const; /** * @brief validate a transaction's inputs and their keys * * This function validates transaction inputs and their keys. Previously * it also performed double spend checking, but that has been moved to its * own function. * The transaction's rct signatures, if any, are expanded. * * If pmax_related_block_height is not NULL, its value is set to the height * of the most recent block which contains an output used in any input set * * Currently this function calls ring signature validation for each * transaction. * * @param tx the transaction to validate * @param tvc returned information about tx verification * @param pmax_related_block_height return-by-pointer the height of the most recent block in the input set * * @return false if any validation step fails, otherwise true */ bool check_tx_inputs(transaction& tx, tx_verification_context &tvc, uint64_t* pmax_used_block_height = NULL) const; /** * @brief performs a blockchain reorganization according to the longest chain rule * * This function aggregates all the actions necessary to switch to a * newly-longer chain. If any step in the reorganization process fails, * the blockchain is reverted to its previous state. * * @param alt_chain the chain to switch to * @param discard_disconnected_chain whether or not to keep the old chain as an alternate * * @return false if the reorganization fails, otherwise true */ bool switch_to_alternative_blockchain(std::list& alt_chain, bool discard_disconnected_chain); /** * @brief removes the most recent block from the blockchain * * @return the block removed */ block pop_block_from_blockchain(); /** * @brief validate and add a new block to the end of the blockchain * * This function is merely a convenience wrapper around the other * of the same name. This one passes the block's hash to the other * as well as the block and verification context. * * @param bl the block to be added * @param bvc metadata concerning the block's validity * @param notify if set to true, sends new block notification on success * * @return true if the block was added successfully, otherwise false */ bool handle_block_to_main_chain(const block& bl, block_verification_context& bvc, bool notify = true); /** * @brief validate and add a new block to the end of the blockchain * * When a block is given to Blockchain to be added to the blockchain, it * is passed here if it is determined to belong at the end of the current * chain. * * @param bl the block to be added * @param id the hash of the block * @param bvc metadata concerning the block's validity * @param notify if set to true, sends new block notification on success * * @return true if the block was added successfully, otherwise false */ bool handle_block_to_main_chain(const block& bl, const crypto::hash& id, block_verification_context& bvc, bool notify = true); /** * @brief validate and add a new block to an alternate blockchain * * If a block to be added does not belong to the main chain, but there * is an alternate chain to which it should be added, that is handled * here. * * @param b the block to be added * @param id the hash of the block * @param bvc metadata concerning the block's validity * * @return true if the block was added successfully, otherwise false */ bool handle_alternative_block(const block& b, const crypto::hash& id, block_verification_context& bvc); /** * @brief builds a list of blocks connecting a block to the main chain * * @param prev_id the block hash of the tip of the alt chain * @param alt_chain the chain to be added to * @param timestamps returns the timestamps of previous blocks * @param bvc the block verification context for error return * * @return true on success, false otherwise */ bool build_alt_chain(const crypto::hash &prev_id, std::list& alt_chain, std::vector ×tamps, block_verification_context& bvc) const; /** * @brief gets the difficulty requirement for a new block on an alternate chain * * @param alt_chain the chain to be added to * @param bei the block being added (and metadata, see ::block_extended_info) * * @return the difficulty requirement */ difficulty_type get_next_difficulty_for_alternative_chain(const std::list& alt_chain, block_extended_info& bei) const; /** * @brief sanity checks a miner transaction before validating an entire block * * This function merely checks basic things like the structure of the miner * transaction, the unlock time, and that the amount doesn't overflow. * * @param b the block containing the miner transaction * @param height the height at which the block will be added * @param hf_version the consensus rules to apply * * @return false if anything is found wrong with the miner transaction, otherwise true */ bool prevalidate_miner_transaction(const block& b, uint64_t height, uint8_t hf_version); /** * @brief validates a miner (coinbase) transaction * * This function makes sure that the miner calculated his reward correctly * and that his miner transaction totals reward + fee. * * @param b the block containing the miner transaction to be validated * @param cumulative_block_weight the block's weight * @param fee the total fees collected in the block * @param base_reward return-by-reference the new block's generated coins * @param already_generated_coins the amount of currency generated prior to this block * @param partial_block_reward return-by-reference true if miner accepted only partial reward * @param version hard fork version for that transaction * * @return false if anything is found wrong with the miner transaction, otherwise true */ bool validate_miner_transaction(const block& b, size_t cumulative_block_weight, uint64_t fee, uint64_t& base_reward, uint64_t already_generated_coins, bool &partial_block_reward, uint8_t version); /** * @brief reverts the blockchain to its previous state following a failed switch * * If Blockchain fails to switch to an alternate chain when it means * to do so, this function reverts the blockchain to how it was before * the attempted switch. * * @param original_chain the chain to switch back to * @param rollback_height the height to revert to before appending the original chain * * @return false if something goes wrong with reverting (very bad), otherwise true */ bool rollback_blockchain_switching(std::list& original_chain, uint64_t rollback_height); /** * @brief gets recent block weights for median calculation * * get the block weights of the last blocks, and return by reference . * * @param weights return-by-reference the list of weights * @param count the number of blocks to get weights for */ void get_last_n_blocks_weights(std::vector& weights, size_t count) const; /** * @brief gets block long term weight median * * get the block long term weight median of blocks starting at * * @param start_height the block height of the first block to query * @param count the number of blocks to get weights for * * @return the long term median block weight */ uint64_t get_long_term_block_weight_median(uint64_t start_height, size_t count) const; /** * @brief checks if a transaction is unlocked (its outputs spendable) * * This function checks to see if a transaction is unlocked. * unlock_time is either a block index or a unix time. * * @param unlock_time the unlock parameter (height or time) * @param hf_version the consensus rules version to use * * @return true if spendable, otherwise false */ bool is_tx_spendtime_unlocked(uint64_t unlock_time, uint8_t hf_version) const; /** * @brief stores an invalid block in a separate container * * Storing invalid blocks allows quick dismissal of the same block * if it is seen again. * * @param bl the invalid block * @param h the block's hash * * @return false if the block cannot be stored for some reason, otherwise true */ bool add_block_as_invalid(const block& bl, const crypto::hash& h); /** * @brief stores an invalid block in a separate container * * Storing invalid blocks allows quick dismissal of the same block * if it is seen again. * * @param bei the invalid block (see ::block_extended_info) * @param h the block's hash * * @return false if the block cannot be stored for some reason, otherwise true */ bool add_block_as_invalid(const block_extended_info& bei, const crypto::hash& h); /** * @brief checks a block's timestamp * * This function grabs the timestamps from the most recent blocks, * where n = BLOCKCHAIN_TIMESTAMP_CHECK_WINDOW. If there are not those many * blocks in the blockchain, the timestap is assumed to be valid. If there * are, this function returns: * true if the block's timestamp is not less than the timestamp of the * median of the selected blocks * false otherwise * * @param b the block to be checked * @param median_ts return-by-reference the median of timestamps * * @return true if the block's timestamp is valid, otherwise false */ bool check_block_timestamp(const block& b, uint64_t& median_ts) const; bool check_block_timestamp(const block& b) const { uint64_t median_ts; return check_block_timestamp(b, median_ts); } /** * @brief checks a block's timestamp * * If the block is not more recent than the median of the recent * timestamps passed here, it is considered invalid. * * @param timestamps a list of the most recent timestamps to check against * @param b the block to be checked * * @return true if the block's timestamp is valid, otherwise false */ bool check_block_timestamp(std::vector& timestamps, const block& b, uint64_t& median_ts) const; bool check_block_timestamp(std::vector& timestamps, const block& b) const { uint64_t median_ts; return check_block_timestamp(timestamps, b, median_ts); } /** * @brief finish an alternate chain's timestamp window from the main chain * * for an alternate chain, get the timestamps from the main chain to complete * the needed number of timestamps for the BLOCKCHAIN_TIMESTAMP_CHECK_WINDOW. * * @param start_height the alternate chain's attachment height to the main chain * @param timestamps return-by-value the timestamps set to be populated * * @return true unless start_height is greater than the current blockchain height */ bool complete_timestamps_vector(uint64_t start_height, std::vector& timestamps) const; /** * @brief calculate the block weight limit for the next block to be added * * @param long_term_effective_median_block_weight optionally return that value * * @return true */ bool update_next_cumulative_weight_limit(uint64_t *long_term_effective_median_block_weight = NULL); void return_tx_to_pool(std::vector> &txs); /** * @brief make sure a transaction isn't attempting a double-spend * * @param tx the transaction to check * @param keys_this_block a cumulative list of spent keys for the current block * * @return false if a double spend was detected, otherwise true */ bool check_for_double_spend(const transaction& tx, key_images_container& keys_this_block) const; /** * @brief validates a transaction input's ring signature * * @param tx_prefix_hash the transaction prefix' hash * @param key_image the key image generated from the true input * @param pubkeys the public keys for each input in the ring signature * @param sig the signature generated for each input in the ring signature * @param result false if the ring signature is invalid, otherwise true */ void check_ring_signature(const crypto::hash &tx_prefix_hash, const crypto::key_image &key_image, const std::vector &pubkeys, const std::vector &sig, uint64_t &result) const; /** * @brief loads block hashes from compiled-in data set * * A (possibly empty) set of block hashes can be compiled into the * monero daemon binary. This function loads those hashes into * a useful state. * * @param get_checkpoints if set, will be called to get checkpoints data */ void load_compiled_in_block_hashes(const GetCheckpointsCallback& get_checkpoints); /** * @brief expands v2 transaction data from blockchain * * RingCT transactions do not transmit some of their data if it * can be reconstituted by the receiver. This function expands * that implicit data. */ bool expand_transaction_2(transaction &tx, const crypto::hash &tx_prefix_hash, const std::vector> &pubkeys) const; /** * @brief invalidates any cached block template */ void invalidate_block_template_cache(); /** * @brief stores a new cached block template * * At some point, may be used to push an update to miners */ void cache_block_template(const block &b, const cryptonote::account_public_address &address, const blobdata &nonce, const difficulty_type &diff, uint64_t height, uint64_t expected_reward, uint64_t seed_height, const crypto::hash &seed_hash, uint64_t pool_cookie); /** * @brief sends new block notifications to ZMQ `miner_data` subscribers * * @param prev_id hash of new blockchain tip * @param already_generated_coins total coins mined by the network so far */ void send_miner_notifications(const crypto::hash &prev_id, uint64_t already_generated_coins); }; } // namespace cryptonote