Skip to content

Commit

Permalink
Parametrize timespan constants.
Browse files Browse the repository at this point in the history 
The constants are parametrized such that libbitcoin can
be used by various altcoins by solely editing the
config file.
  • Loading branch information
@toxeus
toxeus committed Jun 12, 2018
1 parent cbcc4db commit d856360
Show file tree
Hide file tree
Showing 32 changed files with 950 additions and 544 deletions.
2 changes: 2 additions & 0 deletions Makefile.am
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ src_libbitcoin_la_LDFLAGS = ${boost_LDFLAGS}
src_libbitcoin_la_LIBADD = ${boost_chrono_LIBS} ${boost_date_time_LIBS} ${boost_filesystem_LIBS} ${boost_iostreams_LIBS} ${boost_locale_LIBS} ${boost_log_LIBS} ${boost_program_options_LIBS} ${boost_regex_LIBS} ${boost_system_LIBS} ${boost_thread_LIBS} ${pthread_LIBS} ${rt_LIBS} ${icu_i18n_LIBS} ${dl_LIBS} ${png_LIBS} ${qrencode_LIBS} ${secp256k1_LIBS}
src_libbitcoin_la_SOURCES = \
src/error.cpp \
src/settings.cpp \
src/chain/block.cpp \
src/chain/chain_state.cpp \
src/chain/compact.cpp \
Expand Down Expand Up @@ -363,6 +364,7 @@ include_bitcoin_bitcoin_HEADERS = \
include/bitcoin/bitcoin/define.hpp \
include/bitcoin/bitcoin/error.hpp \
include/bitcoin/bitcoin/handlers.hpp \
include/bitcoin/bitcoin/settings.hpp \
include/bitcoin/bitcoin/version.hpp

include_bitcoin_bitcoin_chaindir = ${includedir}/bitcoin/bitcoin/chain
Expand Down
2 changes: 1 addition & 1 deletion examples/main.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ int bc::main(int argc, char* argv[])
#endif

// Extracting Satoshi's words from genesis block.
const auto block = bc::chain::block::genesis_mainnet();
const auto block = bc::chain::block::genesis_mainnet(bc::settings());
const auto& coinbase = block.transactions().front();
const auto& input = coinbase.inputs().front();
BITCOIN_ASSERT_MSG(input.script().size() > 2u, "unexpected genesis");
Expand Down
17 changes: 10 additions & 7 deletions include/bitcoin/bitcoin/chain/block.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class BC_API block
// Constructors.
//-------------------------------------------------------------------------

block();
block(const settings& settings);

block(block&& other);
block(const block& other);
Expand All @@ -87,9 +87,12 @@ class BC_API block
// Deserialization.
//-------------------------------------------------------------------------

static block factory(const data_chunk& data, bool witness=false);
static block factory(std::istream& stream, bool witness=false);
static block factory(reader& source, bool witness=false);
static block factory(const data_chunk& data, const settings& settings,
bool witness=false);
static block factory(std::istream& stream, const settings& settings,
bool witness=false);
static block factory(reader& source, const settings& settings,
bool witness=false);

bool from_data(const data_chunk& data, bool witness=false);
bool from_data(std::istream& stream, bool witness=false);
Expand Down Expand Up @@ -124,9 +127,9 @@ class BC_API block
// Utilities.
//-------------------------------------------------------------------------

static block genesis_mainnet();
static block genesis_testnet();
static block genesis_regtest();
static block genesis_mainnet(const settings& settings);
static block genesis_testnet(const settings& settings);
static block genesis_regtest(const settings& settings);
static size_t locator_size(size_t top);
static indexes locator_heights(size_t top);

Expand Down
48 changes: 31 additions & 17 deletions include/bitcoin/bitcoin/chain/chain_state.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
#include <cstdint>
#include <memory>
#include <deque>
#include <bitcoin/bitcoin/settings.hpp>
#include <bitcoin/bitcoin/config/checkpoint.hpp>
#include <bitcoin/bitcoin/constants.hpp>
#include <bitcoin/bitcoin/define.hpp>
Expand Down Expand Up @@ -125,23 +126,25 @@ class BC_API chain_state

/// Checkpoints must be ordered by height with greatest at back.
static map get_map(size_t height, const checkpoints& checkpoints,
uint32_t forks);
uint32_t forks, size_t retargeting_interval);

static uint32_t signal_version(uint32_t forks);

/// Create pool state from top chain top block state.
chain_state(const chain_state& top);
chain_state(const chain_state& top, const settings& settings);

/// Create block state from tx pool chain state of same height.
chain_state(const chain_state& pool, const chain::block& block);
chain_state(const chain_state& pool, const chain::block& block,
const settings& settings);

/// Create header state from header pool chain state of parent block.
chain_state(const chain_state& parent, const chain::header& header);
chain_state(const chain_state& parent, const chain::header& header,
const settings& settings);

/// Checkpoints must be ordered by height with greatest at back.
/// Forks and checkpoints must match those provided for map creation.
chain_state(data&& values, const checkpoints& checkpoints, uint32_t forks,
uint32_t stale_seconds);
uint32_t stale_seconds, const settings& settings);

/// Properties.
size_t height() const;
Expand Down Expand Up @@ -181,29 +184,40 @@ class BC_API chain_state

static activations activation(const data& values, uint32_t forks);
static uint32_t median_time_past(const data& values, uint32_t forks);
static uint32_t work_required(const data& values, uint32_t forks);
static uint32_t work_required(const data& values, uint32_t forks,
const settings& settings);

private:
static size_t bits_count(size_t height, uint32_t forks);
static size_t bits_count(size_t height, uint32_t forks,
size_t retargeting_interval);
static size_t version_count(size_t height, uint32_t forks);
static size_t timestamp_count(size_t height, uint32_t forks);
static size_t retarget_height(size_t height, uint32_t forks);
static size_t retarget_height(size_t height, uint32_t forks,
size_t retargeting_interval);
static size_t bip9_bit0_height(size_t height, uint32_t forks);
static size_t bip9_bit1_height(size_t height, uint32_t forks);

static data to_pool(const chain_state& top);
static data to_pool(const chain_state& top, const settings& settings);
static data to_block(const chain_state& pool, const block& block);
static data to_header(const chain_state& parent, const header& header);
data to_header(const chain_state& parent, const header& header,
const settings& settings);

static uint32_t work_required_retarget(const data& values);
static uint32_t retarget_timespan(const chain_state::data& values);
static uint32_t work_required_retarget(const data& values,
uint32_t retarget_proof_of_work_limit, uint32_t min_timespan,
uint32_t max_timespan, uint32_t target_timespan_seconds);
static uint32_t retarget_timespan(const chain_state::data& values,
uint32_t min_timespan, uint32_t max_timespan);

// easy blocks
static uint32_t easy_work_required(const data& values);
static uint32_t easy_time_limit(const chain_state::data& values);
static bool is_retarget_or_non_limit(size_t height, uint32_t bits);
static bool is_retarget_height(size_t height);
static size_t retarget_distance(size_t height);
static uint32_t easy_work_required(const data& values,
size_t retargeting_interval, uint32_t retarget_proof_of_work_limit,
uint32_t easy_spacing_seconds);
static uint32_t easy_time_limit(const chain_state::data& values,
int64_t spacing);
static bool is_retarget_or_non_limit(size_t height, uint32_t bits,
size_t retargeting_interval, uint32_t retarget_proof_of_work_limit);
static bool is_retarget_height(size_t height, size_t retargeting_interval);
static size_t retarget_distance(size_t height, size_t retargeting_interval);

// This is retained as an optimization for other constructions.
// A similar height clone can be partially computed, reducing query cost.
Expand Down
22 changes: 14 additions & 8 deletions include/bitcoin/bitcoin/chain/header.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
#include <bitcoin/bitcoin/chain/chain_state.hpp>
#include <bitcoin/bitcoin/define.hpp>
#include <bitcoin/bitcoin/error.hpp>
#include <bitcoin/bitcoin/settings.hpp>
#include <bitcoin/bitcoin/math/hash.hpp>
#include <bitcoin/bitcoin/utility/data.hpp>
#include <bitcoin/bitcoin/utility/reader.hpp>
Expand Down Expand Up @@ -67,17 +68,17 @@ class BC_API header
// Constructors.
//-------------------------------------------------------------------------

header();
header(const settings& settings);

header(header&& other);
header(const header& other);

header(uint32_t version, const hash_digest& previous_block_hash,
const hash_digest& merkle, uint32_t timestamp, uint32_t bits,
uint32_t nonce);
uint32_t nonce, const settings& settings);
header(uint32_t version, hash_digest&& previous_block_hash,
hash_digest&& merkle, uint32_t timestamp, uint32_t bits,
uint32_t nonce);
uint32_t nonce, const settings& settings);

// Operators.
//-------------------------------------------------------------------------
Expand All @@ -91,12 +92,16 @@ class BC_API header
// Deserialization.
//-------------------------------------------------------------------------

static header factory(const data_chunk& data, bool wire=true);
static header factory(std::istream& stream, bool wire=true);
static header factory(reader& source, bool wire=true);
static header factory(reader& source, hash_digest&& hash, bool wire=true);
static header factory(reader& source, const hash_digest& hash,
static header factory(const data_chunk& data, const settings& settings,
bool wire=true);
static header factory(std::istream& stream, const settings& settings,
bool wire=true);
static header factory(reader& source, const settings& settings,
bool wire=true);
static header factory(reader& source, hash_digest&& hash,
const settings& settings, bool wire=true);
static header factory(reader& source, const hash_digest& hash,
const settings& settings, bool wire=true);

bool from_data(const data_chunk& data, bool wire=true);
bool from_data(std::istream& stream, bool wire=true);
Expand Down Expand Up @@ -179,6 +184,7 @@ class BC_API header
uint32_t timestamp_;
uint32_t bits_;
uint32_t nonce_;
const settings& settings_;
};

} // namespace chain
Expand Down
4 changes: 2 additions & 2 deletions include/bitcoin/bitcoin/config/header.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ class BC_API header
/**
* Default constructor.
*/
header();
header(const libbitcoin::settings& settings);

/**
* Initialization constructor.
* @param[in] hexcode The value to initialize with.
*/
header(const std::string& hexcode);
header(const std::string& hexcode, const libbitcoin::settings& settings);

/**
* Initialization constructor.
Expand Down
25 changes: 0 additions & 25 deletions include/bitcoin/bitcoin/constants.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,31 +95,6 @@ BC_CONSTEXPR uint32_t relative_locktime_mask = 0x0000ffff;
BC_CONSTEXPR uint32_t relative_locktime_disabled = 0x80000000;
BC_CONSTEXPR uint32_t relative_locktime_time_locked = 0x00400000;

// Timespan constants.
//-----------------------------------------------------------------------------

BC_CONSTEXPR uint32_t retargeting_factor = 4;
BC_CONSTEXPR uint32_t easy_spacing_seconds = 20 * 60;
BC_CONSTEXPR uint32_t target_spacing_seconds = 10 * 60;
BC_CONSTEXPR uint32_t target_timespan_seconds = 2 * 7 * 24 * 60 * 60;
BC_CONSTEXPR uint32_t timestamp_future_seconds = 2 * 60 * 60;
BC_CONSTEXPR uint32_t retarget_proof_of_work_limit = 0x1d00ffff;
BC_CONSTEXPR uint32_t no_retarget_proof_of_work_limit = 0x207fffff;
BC_CONSTFUNC uint32_t work_limit(bool retarget=true)
{
return retarget ? retarget_proof_of_work_limit : no_retarget_proof_of_work_limit;
}

// The upper and lower bounds for the retargeting timespan.
BC_CONSTEXPR uint32_t min_timespan =
target_timespan_seconds / retargeting_factor;
BC_CONSTEXPR uint32_t max_timespan =
target_timespan_seconds * retargeting_factor;

// The target number of blocks for 2 weeks of work (2016 blocks).
BC_CONSTEXPR size_t retargeting_interval =
target_timespan_seconds / target_spacing_seconds;

// Fork constants.
//-----------------------------------------------------------------------------

Expand Down
13 changes: 8 additions & 5 deletions include/bitcoin/bitcoin/message/block.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,14 @@ class BC_API block
typedef std::shared_ptr<const_ptr_list> const_ptr_list_ptr;
typedef std::shared_ptr<const const_ptr_list> const_ptr_list_const_ptr;

static block factory(uint32_t version, const data_chunk& data);
static block factory(uint32_t version, std::istream& stream);
static block factory(uint32_t version, reader& source);

block();
static block factory(uint32_t version, const data_chunk& data,
const settings& settings);
static block factory(uint32_t version, std::istream& stream,
const settings& settings);
static block factory(uint32_t version, reader& source,
const settings& settings);

block(const settings& settings);

block(block&& other);
block(const block& other);
Expand Down
23 changes: 14 additions & 9 deletions include/bitcoin/bitcoin/message/compact_block.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,14 @@ class BC_API compact_block
typedef mini_hash short_id;
typedef mini_hash_list short_id_list;

static compact_block factory(uint32_t version, const data_chunk& data);
static compact_block factory(uint32_t version, std::istream& stream);
static compact_block factory(uint32_t version, reader& source);

compact_block();
static compact_block factory(uint32_t version, const data_chunk& data,
const settings& settings);
static compact_block factory(uint32_t version, std::istream& stream,
const settings& settings);
static compact_block factory(uint32_t version, reader& source,
const settings& settings);

compact_block(const settings& settings);
compact_block(const chain::header& header, uint64_t nonce,
const short_id_list& short_ids,
const prefilled_transaction::list& transactions);
Expand Down Expand Up @@ -71,14 +74,16 @@ class BC_API compact_block
void set_transactions(const prefilled_transaction::list& value);
void set_transactions(prefilled_transaction::list&& value);

bool from_data(uint32_t version, const data_chunk& data);
bool from_data(uint32_t version, std::istream& stream);
bool from_data(uint32_t version, reader& source);
bool from_data(uint32_t version, const data_chunk& data,
const settings& settings);
bool from_data(uint32_t version, std::istream& stream,
const settings& settings);
bool from_data(uint32_t version, reader& source, const settings& settings);
data_chunk to_data(uint32_t version) const;
void to_data(uint32_t version, std::ostream& stream) const;
void to_data(uint32_t version, writer& sink) const;
bool is_valid() const;
void reset();
void reset(const settings& settings);
size_t serialized_size(uint32_t version) const;

// This class is move assignable but not copy assignable.
Expand Down
15 changes: 9 additions & 6 deletions include/bitcoin/bitcoin/message/header.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,21 @@ class BC_API header
typedef std::shared_ptr<const_ptr_list> const_ptr_list_ptr;
typedef std::shared_ptr<const const_ptr_list> const_ptr_list_const_ptr;

static header factory(uint32_t version, const data_chunk& data);
static header factory(uint32_t version, std::istream& stream);
static header factory(uint32_t version, reader& source);
static header factory(uint32_t version, const data_chunk& data,
const settings& settings);
static header factory(uint32_t version, std::istream& stream,
const settings& settings);
static header factory(uint32_t version, reader& source,
const settings& settings);
static size_t satoshi_fixed_size(uint32_t version);

header();
header(const settings& settings);
header(uint32_t version, const hash_digest& previous_block_hash,
const hash_digest& merkle, uint32_t timestamp, uint32_t bits,
uint32_t nonce);
uint32_t nonce, const settings& settings);
header(uint32_t version, hash_digest&& previous_block_hash,
hash_digest&& merkle, uint32_t timestamp, uint32_t bits,
uint32_t nonce);
uint32_t nonce, const settings& settings);
header(const chain::header& other);
header(chain::header&& other);
header(const header& other);
Expand Down
17 changes: 11 additions & 6 deletions include/bitcoin/bitcoin/message/headers.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,12 @@ class BC_API headers
typedef std::shared_ptr<headers> ptr;
typedef std::shared_ptr<const headers> const_ptr;

static headers factory(uint32_t version, const data_chunk& data);
static headers factory(uint32_t version, std::istream& stream);
static headers factory(uint32_t version, reader& source);
static headers factory(uint32_t version, const data_chunk& data,
const settings& settings);
static headers factory(uint32_t version, std::istream& stream,
const settings& settings);
static headers factory(uint32_t version, reader& source,
const settings& settings);

headers();
headers(const header::list& values);
Expand All @@ -63,9 +66,11 @@ class BC_API headers
void to_inventory(inventory_vector::list& out,
inventory::type_id type) const;

bool from_data(uint32_t version, const data_chunk& data);
bool from_data(uint32_t version, std::istream& stream);
bool from_data(uint32_t version, reader& source);
bool from_data(uint32_t version, const data_chunk& data,
const settings& settings);
bool from_data(uint32_t version, std::istream& stream,
const settings& settings);
bool from_data(uint32_t version, reader& source, const settings& settings);
data_chunk to_data(uint32_t version) const;
void to_data(uint32_t version, std::ostream& stream) const;
void to_data(uint32_t version, writer& sink) const;
Expand Down
Loading

0 comments on commit d856360

Please sign in to comment.