Monero
checkpoints.h
Go to the documentation of this file.
1 // Copyright (c) 2014-2022, The Monero Project
2 //
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification, are
6 // permitted provided that the following conditions are met:
7 //
8 // 1. Redistributions of source code must retain the above copyright notice, this list of
9 // conditions and the following disclaimer.
10 //
11 // 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 // of conditions and the following disclaimer in the documentation and/or other
13 // materials provided with the distribution.
14 //
15 // 3. Neither the name of the copyright holder nor the names of its contributors may be
16 // used to endorse or promote products derived from this software without specific
17 // prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
20 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
27 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 //
29 // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
30 
31 #pragma once
32 #include <map>
33 #include "misc_log_ex.h"
34 #include "crypto/hash.h"
35 #include "cryptonote_config.h"
37 
38 #define ADD_CHECKPOINT(h, hash) CHECK_AND_ASSERT(add_checkpoint(h, hash), false);
39 #define ADD_CHECKPOINT2(h, hash, difficulty) CHECK_AND_ASSERT(add_checkpoint(h, hash, difficulty), false);
40 #define JSON_HASH_FILE_NAME "checkpoints.json"
41 
42 
43 namespace cryptonote
44 {
53  {
54  public:
55 
59  checkpoints();
60 
72  bool add_checkpoint(uint64_t height, const std::string& hash_str, const std::string& difficulty_str = "");
73 
85  bool is_in_checkpoint_zone(uint64_t height) const;
86 
102  bool check_block(uint64_t height, const crypto::hash& h, bool& is_a_checkpoint) const;
103 
107  bool check_block(uint64_t height, const crypto::hash& h) const;
108 
123  bool is_alternative_block_allowed(uint64_t blockchain_height, uint64_t block_height) const;
124 
130  uint64_t get_max_height() const;
131 
137  const std::map<uint64_t, crypto::hash>& get_points() const;
138 
144  const std::map<uint64_t, difficulty_type>& get_difficulty_points() const;
145 
156  bool check_for_conflicts(const checkpoints& other) const;
157 
165 
178  bool load_new_checkpoints(const std::string &json_hashfile_fullpath, network_type nettype=MAINNET, bool dns=true);
179 
187  bool load_checkpoints_from_json(const std::string &json_hashfile_fullpath);
188 
197 
198  private:
199  std::map<uint64_t, crypto::hash> m_points;
200  std::map<uint64_t, difficulty_type> m_difficulty_points;
201  };
202 
203 }
Definition: cryptonote_config.h:303
::std::string string
Definition: gtest-port.h:1097
uint64_t get_max_height() const
gets the highest checkpoint height
Definition: checkpoints.cpp:154
bool init_default_checkpoints(network_type nettype)
loads the default main chain checkpoints
Definition: checkpoints.cpp:183
bool check_block(uint64_t height, const crypto::hash &h, bool &is_a_checkpoint) const
checks if the given height and hash agree with the checkpoints
Definition: checkpoints.cpp:114
bool add_checkpoint(uint64_t height, const std::string &hash_str, const std::string &difficulty_str="")
adds a checkpoint to the container
Definition: checkpoints.cpp:77
bool is_alternative_block_allowed(uint64_t blockchain_height, uint64_t block_height) const
checks if alternate chain blocks should be kept for a given height
Definition: checkpoints.cpp:139
Holds cryptonote related classes and helpers.
Definition: blockchain_db.cpp:44
unsigned __int64 uint64_t
Definition: stdint.h:136
std::map< uint64_t, difficulty_type > m_difficulty_points
the difficulty checkpoints container
Definition: checkpoints.h:200
bool load_checkpoints_from_json(const std::string &json_hashfile_fullpath)
load new checkpoints from json
Definition: checkpoints.cpp:261
const std::map< uint64_t, difficulty_type > & get_difficulty_points() const
gets the difficulty checkpoints container
Definition: checkpoints.cpp:166
network_type
Definition: cryptonote_config.h:301
std::map< uint64_t, crypto::hash > m_points
the checkpoints container
Definition: checkpoints.h:199
bool load_new_checkpoints(const std::string &json_hashfile_fullpath, network_type nettype=MAINNET, bool dns=true)
load new checkpoints
Definition: checkpoints.cpp:353
POD_CLASS hash
Definition: hash.h:49
bool load_checkpoints_from_dns(network_type nettype=MAINNET)
load new checkpoints from DNS
Definition: checkpoints.cpp:297
A container for blockchain checkpoints.
Definition: checkpoints.h:52
const std::map< uint64_t, crypto::hash > & get_points() const
gets the checkpoints container
Definition: checkpoints.cpp:161
checkpoints()
default constructor
Definition: checkpoints.cpp:73
static uint64_t h
Definition: blockchain_stats.cpp:55
bool check_for_conflicts(const checkpoints &other) const
checks if our checkpoints container conflicts with another
Definition: checkpoints.cpp:171
bool is_in_checkpoint_zone(uint64_t height) const
checks if there is a checkpoint in the future
Definition: checkpoints.cpp:109