Electroneum
checkpoints.h
Go to the documentation of this file.
1 // Copyrights(c) 2017-2019, The Electroneum Project
2 // Copyrights(c) 2014-2017, The Monero Project
3 //
4 // All rights reserved.
5 //
6 // Redistribution and use in source and binary forms, with or without modification, are
7 // permitted provided that the following conditions are met:
8 //
9 // 1. Redistributions of source code must retain the above copyright notice, this list of
10 // conditions and the following disclaimer.
11 //
12 // 2. Redistributions in binary form must reproduce the above copyright notice, this list
13 // of conditions and the following disclaimer in the documentation and/or other
14 // materials provided with the distribution.
15 //
16 // 3. Neither the name of the copyright holder nor the names of its contributors may be
17 // used to endorse or promote products derived from this software without specific
18 // prior written permission.
19 //
20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
21 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23 // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
28 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
31 
32 #pragma once
33 #include <map>
34 #include <vector>
35 #include "cryptonote_basic_impl.h"
36 #include "misc_log_ex.h"
37 #include "storages/portable_storage_template_helper.h" // epee json include
38 
39 #define ADD_CHECKPOINT(h, hash) CHECK_AND_ASSERT(add_checkpoint(h, hash), false);
40 #define JSON_HASH_FILE_NAME "checkpoints.json"
41 
42 
43 namespace cryptonote
44 {
53  {
54  public:
55 
59  checkpoints();
60 
71  bool add_checkpoint(uint64_t height, const std::string& hash_str);
72 
84  bool is_in_checkpoint_zone(uint64_t height) const;
85 
101  bool check_block(uint64_t height, const crypto::hash& h, bool& is_a_checkpoint) const;
102 
106  bool check_block(uint64_t height, const crypto::hash& h) const;
107 
122  bool is_alternative_block_allowed(uint64_t blockchain_height, uint64_t block_height) const;
123 
129  uint64_t get_max_height() const;
130 
136  const std::map<uint64_t, crypto::hash>& get_points() const;
137 
148  bool check_for_conflicts(const checkpoints& other) const;
149 
156 
169  bool load_new_checkpoints(const std::string json_hashfile_fullpath, bool testnet=false, bool dns=true);
170 
178  bool load_checkpoints_from_json(const std::string json_hashfile_fullpath);
179 
187  bool load_checkpoints_from_dns(bool testnet = false);
188 
189  private:
190 
191 
195  struct t_hashline
196  {
197  uint64_t height;
198  std::string hash;
199  BEGIN_KV_SERIALIZE_MAP()
200  KV_SERIALIZE(height)
201  KV_SERIALIZE(hash)
202  END_KV_SERIALIZE_MAP()
203  };
204 
208  struct t_hash_json {
209  std::vector<t_hashline> hashlines;
210  BEGIN_KV_SERIALIZE_MAP()
211  KV_SERIALIZE(hashlines)
212  END_KV_SERIALIZE_MAP()
213  };
214 
215  std::map<uint64_t, crypto::hash> m_points;
216 
217  };
218 }
bool add_checkpoint(uint64_t height, const std::string &hash_str)
adds a checkpoint to the container
Definition: checkpoints.cpp:53
bool load_new_checkpoints(const std::string json_hashfile_fullpath, bool testnet=false, bool dns=true)
load new checkpoints
Definition: checkpoints.cpp:245
uint64_t height
the height of the checkpoint
Definition: checkpoints.h:197
uint64_t get_max_height() const
gets the highest checkpoint height
Definition: checkpoints.cpp:113
uint64_t height
Definition: blockchain.cpp:87
crypto namespace.
Definition: crypto.cpp:47
Definition: block_queue.cpp:41
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:73
bool load_checkpoints_from_json(const std::string json_hashfile_fullpath)
load new checkpoints from json
Definition: checkpoints.cpp:161
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:98
bool load_checkpoints_from_dns(bool testnet=false)
load new checkpoints from DNS
Definition: checkpoints.cpp:193
Holds cryptonote related classes and helpers.
Definition: db_bdb.cpp:225
internal::map< const std::string, node > map
Definition: mstch.hpp:119
std::vector< t_hashline > hashlines
the checkpoint lines from the file
Definition: checkpoints.h:209
bool init_default_checkpoints()
loads the default main chain checkpoints
Definition: checkpoints.cpp:139
std::map< uint64_t, crypto::hash > m_points
the checkpoints container
Definition: checkpoints.h:215
std::string hash
the hash for the checkpoint
Definition: checkpoints.h:198
POD_CLASS hash
Definition: hash.h:46
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:122
checkpoints()
default constructor
Definition: checkpoints.cpp:49
struct for loading a checkpoint from json
Definition: checkpoints.h:195
struct for loading many checkpoints from json
Definition: checkpoints.h:208
bool check_for_conflicts(const checkpoints &other) const
checks if our checkpoints container conflicts with another
Definition: checkpoints.cpp:127
bool is_in_checkpoint_zone(uint64_t height) const
checks if there is a checkpoint in the future
Definition: checkpoints.cpp:68