BitShares-Core  5.0.0
BitShares blockchain implementation and command-line interface software
Public Member Functions | Public Attributes | List of all members
graphene::app::detail::application_impl Class Reference

#include <application_impl.hxx>

Inheritance diagram for graphene::app::detail::application_impl:

Public Member Functions

void reset_p2p_node (const fc::path &data_dir)
void new_connection (const fc::http::websocket_connection_ptr &c)
void reset_websocket_server ()
void reset_websocket_tls_server ()
 application_impl (application *self)
virtual ~application_impl ()
void set_dbg_init_key (graphene::chain::genesis_state_type &genesis, const std::string &init_key)
void set_api_limit ()
void startup ()
fc::optional< api_access_infoget_api_access_info (const string &username) const
void set_api_access_info (const string &username, api_access_info &&permissions)
virtual bool has_item (const net::item_id &id) override
virtual bool handle_block (const graphene::net::block_message &blk_msg, bool sync_mode, std::vector< fc::uint160_t > &contained_transaction_message_ids) override
 allows the application to validate an item prior to broadcasting to peers. More...
virtual void handle_transaction (const graphene::net::trx_message &transaction_message) override
 Called when a new transaction comes in from the network. More...
void handle_message (const graphene::net::message &message_to_process) override
 Called when a new message comes in from the network other than a block or a transaction. Currently there are no other possible messages, so this should never be called. More...
bool is_included_block (const graphene::chain::block_id_type &block_id)
virtual std::vector< graphene::net::item_hash_tget_block_ids (const std::vector< graphene::net::item_hash_t > &blockchain_synopsis, uint32_t &remaining_item_count, uint32_t limit) override
virtual graphene::net::message get_item (const graphene::net::item_id &id) override
virtual graphene::chain::chain_id_type get_chain_id () const override
virtual std::vector< graphene::net::item_hash_tget_blockchain_synopsis (const graphene::net::item_hash_t &reference_point, uint32_t number_of_blocks_after_reference_point) override
virtual void sync_status (uint32_t item_type, uint32_t item_count) override
virtual void connection_count_changed (uint32_t c) override
virtual uint32_t get_block_number (const graphene::net::item_hash_t &block_id) override
virtual fc::time_point_sec get_block_time (const graphene::net::item_hash_t &block_id) override
virtual graphene::net::item_hash_t get_head_block_id () const override
virtual uint32_t estimate_last_known_fork_from_git_revision_timestamp (uint32_t unix_timestamp) const override
virtual void error_encountered (const std::string &message, const fc::oexception &error) override
uint8_t get_current_block_interval_in_seconds () const override
- Public Member Functions inherited from graphene::net::node_delegate
virtual ~node_delegate ()
virtual std::vector< item_hash_tget_block_ids (const std::vector< item_hash_t > &blockchain_synopsis, uint32_t &remaining_item_count, uint32_t limit=2000)=0

Public Attributes

fc::optional< fc::temp_file_lock_file
bool _is_block_producer = false
bool _force_validate = false
application_options _app_options
fc::path _data_dir
const boost::program_options::variables_map * _options = nullptr
api_access _apiaccess
std::shared_ptr< graphene::chain::database_chain_db
std::shared_ptr< graphene::net::node_p2p_network
std::shared_ptr< fc::http::websocket_server_websocket_server
std::shared_ptr< fc::http::websocket_tls_server_websocket_tls_server
std::map< string, std::shared_ptr< abstract_plugin > > _active_plugins
std::map< string, std::shared_ptr< abstract_plugin > > _available_plugins
bool _is_finished_syncing = false

Detailed Description

Definition at line 15 of file application_impl.hxx.

Constructor & Destructor Documentation

graphene::app::detail::application_impl::application_impl ( application self)

Definition at line 31 of file application_impl.hxx.

virtual graphene::app::detail::application_impl::~application_impl ( )

Definition at line 37 of file application_impl.hxx.

Member Function Documentation

void graphene::app::detail::application_impl::connection_count_changed ( uint32_t  c)

Call any time the number of connected peers changes.

Implements graphene::net::node_delegate.

Definition at line 911 of file application.cpp.

void graphene::app::detail::application_impl::error_encountered ( const std::string &  message,
const fc::oexception error 

Implements graphene::net::node_delegate.

Definition at line 942 of file application.cpp.

uint32_t graphene::app::detail::application_impl::estimate_last_known_fork_from_git_revision_timestamp ( uint32_t  unix_timestamp) const

Implements graphene::net::node_delegate.

Definition at line 937 of file application.cpp.

optional< api_access_info > graphene::app::detail::application_impl::get_api_access_info ( const string &  username) const

Definition at line 495 of file application.cpp.

std::vector< item_hash_t > graphene::app::detail::application_impl::get_block_ids ( const std::vector< graphene::net::item_hash_t > &  blockchain_synopsis,
uint32_t &  remaining_item_count,
uint32_t  limit 

Assuming all data elements are ordered in some way, this method should return up to limit ids that occur after the last ID in synopsis that we recognize.

On return, remaining_item_count will be set to the number of items in our blockchain after the last item returned in the result, or 0 if the result contains the last item in the blockchain

Definition at line 646 of file application.cpp.

uint32_t graphene::app::detail::application_impl::get_block_number ( const graphene::net::item_hash_t block_id)

Implements graphene::net::node_delegate.

Definition at line 916 of file application.cpp.

fc::time_point_sec graphene::app::detail::application_impl::get_block_time ( const graphene::net::item_hash_t block_id)

Returns the time a block was produced (if block_id = 0, returns genesis time). If we don't know about the block, returns time_point_sec::min()

Implements graphene::net::node_delegate.

Definition at line 925 of file application.cpp.

std::vector< item_hash_t > graphene::app::detail::application_impl::get_blockchain_synopsis ( const graphene::net::item_hash_t reference_point,
uint32_t  number_of_blocks_after_reference_point 

Returns a synopsis of the blockchain used for syncing. This consists of a list of block hashes at intervals exponentially increasing towards the genesis block. When syncing to a peer, the peer uses this data to determine if we're on the same fork as they are, and if not, what blocks they need to send us to get us on their fork.

In the over-simplified case, this is a straighforward synopsis of our current preferred blockchain; when we first connect up to a peer, this is what we will be sending. It looks like this: If the blockchain is empty, it will return the empty list. If the blockchain has one block, it will return a list containing just that block. If it contains more than one block: the first element in the list will be the hash of the highest numbered block that we cannot undo the second element will be the hash of an item at the half way point in the undoable segment of the blockchain the third will be ~3/4 of the way through the undoable segment of the block chain the fourth will be at ~7/8... &c. the last item in the list will be the hash of the most recent block on our preferred chain so if the blockchain had 26 blocks labeled a - z, the synopsis would be: a n u x z the idea being that by sending a small (<30) number of block ids, we can summarize a huge blockchain. The block ids are more dense near the end of the chain where because we are more likely to be almost in sync when we first connect, and forks are likely to be short. If the peer we're syncing with in our example is on a fork that started at block 'v', then they will reply to our synopsis with a list of all blocks starting from block 'u', the last block they know that we had in common.

In the real code, there are several complications.

First, as an optimization, we don't usually send a synopsis of the entire blockchain, we send a synopsis of only the segment of the blockchain that we have undo data for. If their fork doesn't build off of something in our undo history, we would be unable to switch, so there's no reason to fetch the blocks.

Second, when a peer replies to our initial synopsis and gives us a list of the blocks they think we are missing, they only send a chunk of a few thousand blocks at once. After we get those block ids, we need to request more blocks by sending another synopsis (we can't just say "send me the next 2000 ids" because they may have switched forks themselves and they don't track what they've sent us). For faster performance, we want to get a fairly long list of block ids first, then start downloading the blocks. The peer doesn't handle these follow-up block id requests any different from the initial request; it treats the synopsis we send as our blockchain and bases its response entirely off that. So to get the response we want (the next chunk of block ids following the last one they sent us, or, failing that, the shortest fork off of the last list of block ids they sent), we need to construct a synopsis as if our blockchain was made up of:

  1. the blocks in our block chain up to the fork point (if there is a fork) or the head block (if no fork)
  2. the blocks we've already pushed from their fork (if there's a fork)
  3. the block ids they've previously sent us Segment 3 is handled in the p2p code, it just tells us the number of blocks it has (in number_of_blocks_after_reference_point) so we can leave space in the synopsis for them. We're responsible for constructing the synopsis of Segments 1 and 2 from our active blockchain and fork database. The reference_point parameter is the last block from that peer that has been successfully pushed to the blockchain, so that tells us whether the peer is on a fork or on the main chain.

Implements graphene::net::node_delegate.

Definition at line 776 of file application.cpp.

chain_id_type graphene::app::detail::application_impl::get_chain_id ( ) const

Implements graphene::net::node_delegate.

Definition at line 713 of file application.cpp.

uint8_t graphene::app::detail::application_impl::get_current_block_interval_in_seconds ( ) const

Implements graphene::net::node_delegate.

Definition at line 947 of file application.cpp.

item_hash_t graphene::app::detail::application_impl::get_head_block_id ( ) const

Implements graphene::net::node_delegate.

Definition at line 932 of file application.cpp.

message graphene::app::detail::application_impl::get_item ( const graphene::net::item_id id)

Given the hash of the requested data, fetch the body.

Implements graphene::net::node_delegate.

Definition at line 697 of file application.cpp.

bool graphene::app::detail::application_impl::handle_block ( const graphene::net::block_message blk_msg,
bool  sync_mode,
std::vector< fc::uint160_t > &  contained_transaction_message_ids 

allows the application to validate an item prior to broadcasting to peers.

sync_modetrue if the message was fetched through the sync process, false during normal operation
true if this message caused the blockchain to switch forks, false if it did not
exceptionif error validating the item, otherwise the item is safe to broadcast on.

Implements graphene::net::node_delegate.

Definition at line 536 of file application.cpp.

void graphene::app::detail::application_impl::handle_message ( const graphene::net::message message_to_process)

Called when a new message comes in from the network other than a block or a transaction. Currently there are no other possible messages, so this should never be called.

exceptionif error validating the item, otherwise the item is safe to broadcast on.

Implements graphene::net::node_delegate.

Definition at line 624 of file application.cpp.

void graphene::app::detail::application_impl::handle_transaction ( const graphene::net::trx_message trx_msg)

Called when a new transaction comes in from the network.

exceptionif error validating the item, otherwise the item is safe to broadcast on.

Implements graphene::net::node_delegate.

Definition at line 608 of file application.cpp.

bool graphene::app::detail::application_impl::has_item ( const net::item_id id)

If delegate has the item, the network has no need to fetch it.

Implements graphene::net::node_delegate.

Definition at line 516 of file application.cpp.

bool graphene::app::detail::application_impl::is_included_block ( const graphene::chain::block_id_type block_id)

Definition at line 630 of file application.cpp.

void graphene::app::detail::application_impl::new_connection ( const fc::http::websocket_connection_ptr c)

Definition at line 158 of file application.cpp.

void graphene::app::detail::application_impl::reset_p2p_node ( const fc::path data_dir)

Definition at line 117 of file application.cpp.

void graphene::app::detail::application_impl::reset_websocket_server ( )

Definition at line 190 of file application.cpp.

void graphene::app::detail::application_impl::reset_websocket_tls_server ( )

Definition at line 207 of file application.cpp.

void graphene::app::detail::application_impl::set_api_access_info ( const string &  username,
api_access_info &&  permissions 

Definition at line 508 of file application.cpp.

void graphene::app::detail::application_impl::set_api_limit ( )

Definition at line 241 of file application.cpp.

void graphene::app::detail::application_impl::set_dbg_init_key ( graphene::chain::genesis_state_type genesis,
const std::string &  init_key 

Definition at line 231 of file application.cpp.

void graphene::app::detail::application_impl::startup ( )

Definition at line 334 of file application.cpp.

void graphene::app::detail::application_impl::sync_status ( uint32_t  item_type,
uint32_t  item_count 

Call this after the call to handle_message succeeds.

item_typethe type of the item we're synchronizing, will be the same as item passed to the sync_from() call
item_countthe number of items known to the node that haven't been sent to handle_item() yet. After item_count more calls to handle_item(), the node will be in sync

Implements graphene::net::node_delegate.

Definition at line 903 of file application.cpp.

Member Data Documentation

std::map<string, std::shared_ptr<abstract_plugin> > graphene::app::detail::application_impl::_active_plugins

Definition at line 194 of file application_impl.hxx.

api_access graphene::app::detail::application_impl::_apiaccess

Definition at line 187 of file application_impl.hxx.

application_options graphene::app::detail::application_impl::_app_options

Definition at line 21 of file application_impl.hxx.

std::map<string, std::shared_ptr<abstract_plugin> > graphene::app::detail::application_impl::_available_plugins

Definition at line 195 of file application_impl.hxx.

std::shared_ptr<graphene::chain::database> graphene::app::detail::application_impl::_chain_db

Definition at line 189 of file application_impl.hxx.

fc::path graphene::app::detail::application_impl::_data_dir

Definition at line 185 of file application_impl.hxx.

bool graphene::app::detail::application_impl::_force_validate = false

Definition at line 20 of file application_impl.hxx.

bool graphene::app::detail::application_impl::_is_block_producer = false

Definition at line 19 of file application_impl.hxx.

bool graphene::app::detail::application_impl::_is_finished_syncing = false

Definition at line 197 of file application_impl.hxx.

fc::optional<fc::temp_file> graphene::app::detail::application_impl::_lock_file

Definition at line 18 of file application_impl.hxx.

const boost::program_options::variables_map* graphene::app::detail::application_impl::_options = nullptr

Definition at line 186 of file application_impl.hxx.

std::shared_ptr<graphene::net::node> graphene::app::detail::application_impl::_p2p_network

Definition at line 190 of file application_impl.hxx.

application* graphene::app::detail::application_impl::_self

Definition at line 183 of file application_impl.hxx.

std::shared_ptr<fc::http::websocket_server> graphene::app::detail::application_impl::_websocket_server

Definition at line 191 of file application_impl.hxx.

std::shared_ptr<fc::http::websocket_tls_server> graphene::app::detail::application_impl::_websocket_tls_server

Definition at line 192 of file application_impl.hxx.

The documentation for this class was generated from the following files: