#237: Create new delayed_node app
Delayed node is much like witness_node, except it doesn't have support for block productuion (thus cannot be a witness) and it is not intended to use the P2P network. The delayed node requires a trusted node it can connect to via RPC and download blocks from. The delayed node will only download blocks from the trusted node if those blocks have received a configurable number of confirmations. This commit effectively resolves #237
This commit is contained in:
Nathan Hourt
parent
baf6bfc17b
commit
5aa884c574
6 changed files with 360 additions and 20 deletions
|
|
@ -229,9 +229,9 @@ namespace graphene { namespace app {
|
|||
fc::optional<witness_object> get_witness_by_account(account_id_type account)const;
|
||||
|
||||
/**
|
||||
* @brief Given a set of votes, return the objects they are voting for.
|
||||
* @brief Given a set of votes, return the objects they are voting for.
|
||||
*
|
||||
* This will be a mixture of committee_member_object, witness_objects, and worker_objects
|
||||
* This will be a mixture of committee_member_object, witness_objects, and worker_objects
|
||||
*
|
||||
* The results will be in the same order as the votes. Null will be returned for
|
||||
* any vote ids that are not found.
|
||||
|
|
@ -355,7 +355,7 @@ namespace graphene { namespace app {
|
|||
/**
|
||||
* This method will return the set of all public keys that could possibly sign for a given transaction. This call can
|
||||
* be used by wallets to filter their set of public keys to just the relevant subset prior to calling @ref get_required_signatures
|
||||
* to get the minimum subset.
|
||||
* to get the minimum subset.
|
||||
*/
|
||||
set<public_key_type> get_potential_signatures( const signed_transaction& trx )const;
|
||||
|
||||
|
|
|
|||
|
|
@ -31,9 +31,11 @@ namespace detail {
|
|||
struct delayed_node_plugin_impl {
|
||||
std::string remote_endpoint;
|
||||
int delay_blocks;
|
||||
fc::http::websocket_client client;
|
||||
std::shared_ptr<fc::rpc::websocket_api_connection> client_connection;
|
||||
fc::api<graphene::app::database_api> database_api;
|
||||
boost::signals2::scoped_connection client_connection_closed;
|
||||
bool currently_fetching = false;
|
||||
};
|
||||
}
|
||||
|
||||
|
|
@ -41,19 +43,20 @@ delayed_node_plugin::delayed_node_plugin()
|
|||
: my(new detail::delayed_node_plugin_impl)
|
||||
{}
|
||||
|
||||
delayed_node_plugin::~delayed_node_plugin()
|
||||
{}
|
||||
|
||||
void delayed_node_plugin::plugin_set_program_options(bpo::options_description&, bpo::options_description& cfg)
|
||||
{
|
||||
cfg.add_options()
|
||||
("trusted_node", boost::program_options::value<std::string>()->required(), "RPC endpoint of a trusted validating node")
|
||||
("delay_block_count", boost::program_options::value<int>()->required(), "Number of blocks to delay before advancing chain state")
|
||||
("trusted-node", boost::program_options::value<std::string>()->required(), "RPC endpoint of a trusted validating node (required)")
|
||||
("delay-block-count", boost::program_options::value<int>()->required(), "Number of blocks to delay before advancing chain state (required)")
|
||||
;
|
||||
|
||||
}
|
||||
|
||||
void delayed_node_plugin::connect()
|
||||
{
|
||||
fc::http::websocket_client client;
|
||||
my->client_connection = std::make_shared<fc::rpc::websocket_api_connection>(*client.connect(my->remote_endpoint));
|
||||
my->client_connection = std::make_shared<fc::rpc::websocket_api_connection>(*my->client.connect(my->remote_endpoint));
|
||||
my->database_api = my->client_connection->get_remote_api<graphene::app::database_api>(0);
|
||||
my->client_connection_closed = my->client_connection->closed.connect([this] {
|
||||
connection_failed();
|
||||
|
|
@ -62,28 +65,56 @@ void delayed_node_plugin::connect()
|
|||
|
||||
void delayed_node_plugin::plugin_initialize(const boost::program_options::variables_map& options)
|
||||
{
|
||||
my->remote_endpoint = options.at("trusted_node").as<std::string>();
|
||||
my->delay_blocks = options.at("delay_block_count").as<int>();
|
||||
my->remote_endpoint = "ws://" + options.at("trusted-node").as<std::string>();
|
||||
my->delay_blocks = options.at("delay-block-count").as<int>();
|
||||
}
|
||||
|
||||
void delayed_node_plugin::sync_with_trusted_node(uint32_t remote_head_block_num)
|
||||
{
|
||||
struct raii {
|
||||
bool* target;
|
||||
~raii() {
|
||||
*target = false;
|
||||
}
|
||||
};
|
||||
|
||||
if (my->currently_fetching) return;
|
||||
raii releaser{&my->currently_fetching};
|
||||
my->currently_fetching = true;
|
||||
|
||||
auto head_block = database().head_block_num();
|
||||
while (remote_head_block_num - head_block > my->delay_blocks) {
|
||||
fc::optional<graphene::chain::signed_block> block = my->database_api->get_block(++head_block);
|
||||
FC_ASSERT(block, "Trusted node claims it has blocks it doesn't actually have.");
|
||||
ilog("Pushing block #${n}", ("n", block->block_num()));
|
||||
database().push_block(*block);
|
||||
}
|
||||
}
|
||||
|
||||
void delayed_node_plugin::plugin_startup()
|
||||
{
|
||||
try {
|
||||
connect();
|
||||
|
||||
// Go ahead and get in sync now, before subscribing
|
||||
chain::dynamic_global_property_object props = my->database_api->get_dynamic_global_properties();
|
||||
sync_with_trusted_node(props.head_block_number);
|
||||
|
||||
my->database_api->subscribe_to_objects([this] (const fc::variant& v) {
|
||||
auto props = v.as<graphene::chain::dynamic_global_property_object>();
|
||||
sync_with_trusted_node(props.head_block_number);
|
||||
}, {graphene::chain::dynamic_global_property_id_type()});
|
||||
return;
|
||||
} catch (const fc::exception& e) {
|
||||
elog("Error during connection: ${e}", ("e", e.to_detail_string()));
|
||||
connection_failed();
|
||||
}
|
||||
fc::async([this]{connection_failed();});
|
||||
}
|
||||
|
||||
void delayed_node_plugin::connection_failed()
|
||||
{
|
||||
elog("Connection to trusted node failed; retrying in 5 seconds...");
|
||||
fc::usleep(fc::seconds(5));
|
||||
|
||||
try {
|
||||
connect();
|
||||
} catch (const fc::exception& e) {
|
||||
elog("Error during connection: ${e}", ("e", e.to_detail_string()));
|
||||
fc::async([this]{connection_failed();});
|
||||
}
|
||||
fc::schedule([this]{plugin_startup();}, fc::time_point::now() + fc::seconds(5));
|
||||
}
|
||||
|
||||
} }
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ class delayed_node_plugin : public graphene::app::plugin
|
|||
std::unique_ptr<detail::delayed_node_plugin_impl> my;
|
||||
public:
|
||||
delayed_node_plugin();
|
||||
virtual ~delayed_node_plugin(){}
|
||||
virtual ~delayed_node_plugin();
|
||||
|
||||
std::string plugin_name()const override { return "delayed_node"; }
|
||||
virtual void plugin_set_program_options(boost::program_options::options_description&,
|
||||
|
|
@ -38,6 +38,7 @@ public:
|
|||
protected:
|
||||
void connection_failed();
|
||||
void connect();
|
||||
void sync_with_trusted_node(uint32_t remote_head_block_num);
|
||||
};
|
||||
|
||||
} } //graphene::account_history
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
add_subdirectory( cli_wallet )
|
||||
add_subdirectory( witness_node )
|
||||
add_subdirectory( delayed_node )
|
||||
add_subdirectory( js_operation_serializer )
|
||||
add_subdirectory( size_checker )
|
||||
|
||||
|
|
|
|||
21
programs/delayed_node/CMakeLists.txt
Normal file
21
programs/delayed_node/CMakeLists.txt
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
add_executable( delayed_node main.cpp )
|
||||
if( UNIX AND NOT APPLE )
|
||||
set(rt_library rt )
|
||||
endif()
|
||||
|
||||
find_package( Gperftools QUIET )
|
||||
if( GPERFTOOLS_FOUND )
|
||||
message( STATUS "Found gperftools; compiling delayed_node with TCMalloc")
|
||||
list( APPEND PLATFORM_SPECIFIC_LIBS tcmalloc )
|
||||
endif()
|
||||
|
||||
target_link_libraries( delayed_node
|
||||
PRIVATE graphene_app graphene_account_history graphene_market_history graphene_delayed_node graphene_chain graphene_egenesis_full fc ${CMAKE_DL_LIBS} ${PLATFORM_SPECIFIC_LIBS} )
|
||||
|
||||
install( TARGETS
|
||||
delayed_node
|
||||
|
||||
RUNTIME DESTINATION bin
|
||||
LIBRARY DESTINATION lib
|
||||
ARCHIVE DESTINATION lib
|
||||
)
|
||||
286
programs/delayed_node/main.cpp
Normal file
286
programs/delayed_node/main.cpp
Normal file
|
|
@ -0,0 +1,286 @@
|
|||
/*
|
||||
* Copyright (c) 2015, Cryptonomex, Inc.
|
||||
* All rights reserved.
|
||||
*
|
||||
* This source code is provided for evaluation in private test networks only, until September 8, 2015. After this date, this license expires and
|
||||
* the code may not be used, modified or distributed for any purpose. Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted until September 8, 2015, provided that the following conditions are met:
|
||||
*
|
||||
* 1. The code and/or derivative works are used only for private test networks consisting of no more than 10 P2P nodes.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
#include <graphene/app/application.hpp>
|
||||
|
||||
#include <graphene/delayed_node/delayed_node_plugin.hpp>
|
||||
#include <graphene/account_history/account_history_plugin.hpp>
|
||||
#include <graphene/market_history/market_history_plugin.hpp>
|
||||
|
||||
#include <fc/exception/exception.hpp>
|
||||
#include <fc/thread/thread.hpp>
|
||||
#include <fc/interprocess/signals.hpp>
|
||||
#include <fc/log/console_appender.hpp>
|
||||
#include <fc/log/file_appender.hpp>
|
||||
#include <fc/log/logger.hpp>
|
||||
#include <fc/log/logger_config.hpp>
|
||||
|
||||
#include <boost/filesystem.hpp>
|
||||
|
||||
#include <boost/property_tree/ptree.hpp>
|
||||
#include <boost/property_tree/ini_parser.hpp>
|
||||
#include <boost/algorithm/string/predicate.hpp>
|
||||
#include <boost/algorithm/string/classification.hpp>
|
||||
#include <boost/algorithm/string/split.hpp>
|
||||
|
||||
#include <iostream>
|
||||
#include <fstream>
|
||||
|
||||
#ifndef WIN32
|
||||
#include <csignal>
|
||||
#endif
|
||||
|
||||
using namespace graphene;
|
||||
namespace bpo = boost::program_options;
|
||||
|
||||
void write_default_logging_config_to_stream(std::ostream& out);
|
||||
fc::optional<fc::logging_config> load_logging_config_from_ini_file(const fc::path& config_ini_filename);
|
||||
|
||||
int main(int argc, char** argv) {
|
||||
try {
|
||||
app::application node;
|
||||
bpo::options_description app_options("Graphene Delayed Node");
|
||||
bpo::options_description cfg_options("Graphene Delayed Node");
|
||||
app_options.add_options()
|
||||
("help,h", "Print this help message and exit.")
|
||||
("data-dir,d", bpo::value<boost::filesystem::path>()->default_value("delayed_node_data_dir"), "Directory containing databases, configuration file, etc.")
|
||||
;
|
||||
|
||||
bpo::variables_map options;
|
||||
|
||||
auto delayed_plug = node.register_plugin<delayed_node::delayed_node_plugin>();
|
||||
auto history_plug = node.register_plugin<account_history::account_history_plugin>();
|
||||
auto market_history_plug = node.register_plugin<market_history::market_history_plugin>();
|
||||
|
||||
try
|
||||
{
|
||||
bpo::options_description cli, cfg;
|
||||
node.set_program_options(cli, cfg);
|
||||
app_options.add(cli);
|
||||
cfg_options.add(cfg);
|
||||
bpo::store(bpo::parse_command_line(argc, argv, app_options), options);
|
||||
}
|
||||
catch (const boost::program_options::error& e)
|
||||
{
|
||||
std::cerr << "Error parsing command line: " << e.what() << "\n";
|
||||
return 1;
|
||||
}
|
||||
|
||||
if( options.count("help") )
|
||||
{
|
||||
std::cout << app_options << "\n";
|
||||
return 0;
|
||||
}
|
||||
|
||||
fc::path data_dir;
|
||||
if( options.count("data-dir") )
|
||||
{
|
||||
data_dir = options["data-dir"].as<boost::filesystem::path>();
|
||||
if( data_dir.is_relative() )
|
||||
data_dir = fc::current_path() / data_dir;
|
||||
}
|
||||
|
||||
fc::path config_ini_path = data_dir / "config.ini";
|
||||
// Create config file if not already present
|
||||
if( !fc::exists(config_ini_path) )
|
||||
{
|
||||
ilog("Writing new config file at ${path}", ("path", config_ini_path));
|
||||
if( !fc::exists(data_dir) )
|
||||
fc::create_directories(data_dir);
|
||||
|
||||
std::ofstream out_cfg(config_ini_path.preferred_string());
|
||||
for( const boost::shared_ptr<bpo::option_description> od : cfg_options.options() )
|
||||
{
|
||||
if( !od->description().empty() )
|
||||
out_cfg << "# " << od->description() << "\n";
|
||||
boost::any store;
|
||||
if( !od->semantic()->apply_default(store) )
|
||||
out_cfg << "# " << od->long_name() << " = \n";
|
||||
else {
|
||||
auto example = od->format_parameter();
|
||||
if( example.empty() )
|
||||
// This is a boolean switch
|
||||
out_cfg << od->long_name() << " = " << "false\n";
|
||||
else {
|
||||
// The string is formatted "arg (=<interesting part>)"
|
||||
example.erase(0, 6);
|
||||
example.erase(example.length()-1);
|
||||
out_cfg << od->long_name() << " = " << example << "\n";
|
||||
}
|
||||
}
|
||||
out_cfg << "\n";
|
||||
}
|
||||
write_default_logging_config_to_stream(out_cfg);
|
||||
out_cfg.close();
|
||||
// read the default logging config we just wrote out to the file and start using it
|
||||
fc::optional<fc::logging_config> logging_config = load_logging_config_from_ini_file(config_ini_path);
|
||||
if (logging_config)
|
||||
fc::configure_logging(*logging_config);
|
||||
}
|
||||
|
||||
// Parse configuration file
|
||||
try {
|
||||
bpo::store(bpo::parse_config_file<char>(config_ini_path.preferred_string().c_str(), cfg_options, true), options);
|
||||
// try to get logging options from the config file.
|
||||
try
|
||||
{
|
||||
fc::optional<fc::logging_config> logging_config = load_logging_config_from_ini_file(config_ini_path);
|
||||
if (logging_config)
|
||||
fc::configure_logging(*logging_config);
|
||||
}
|
||||
catch (const fc::exception&)
|
||||
{
|
||||
wlog("Error parsing logging config from config file ${config}, using default config", ("config", config_ini_path.preferred_string()));
|
||||
}
|
||||
|
||||
bpo::notify(options);
|
||||
} catch( const boost::program_options::error& e ) {
|
||||
elog("Error parsing configuration file: ${e}", ("e", e.what()));
|
||||
return 1;
|
||||
}
|
||||
node.initialize(data_dir, options);
|
||||
node.initialize_plugins( options );
|
||||
|
||||
node.startup();
|
||||
node.startup_plugins();
|
||||
|
||||
fc::promise<int>::ptr exit_promise = new fc::promise<int>("UNIX Signal Handler");
|
||||
#if defined __APPLE__ || defined __unix__
|
||||
fc::set_signal_handler([&exit_promise](int signal) {
|
||||
exit_promise->set_value(signal);
|
||||
}, SIGINT);
|
||||
#endif
|
||||
|
||||
ilog("Started delayed node on a chain with ${h} blocks.", ("h", node.chain_database()->head_block_num()));
|
||||
ilog("Chain ID is ${id}", ("id", node.chain_database()->get_chain_id()) );
|
||||
|
||||
int signal = exit_promise->wait();
|
||||
ilog("Exiting from signal ${n}", ("n", signal));
|
||||
node.shutdown_plugins();
|
||||
return 0;
|
||||
} catch( const fc::exception& e ) {
|
||||
elog("Exiting with error:\n${e}", ("e", e.to_detail_string()));
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
// logging config is too complicated to be parsed by boost::program_options,
|
||||
// so we do it by hand
|
||||
//
|
||||
// Currently, you can only specify the filenames and logging levels, which
|
||||
// are all most users would want to change. At a later time, options can
|
||||
// be added to control rotation intervals, compression, and other seldom-
|
||||
// used features
|
||||
void write_default_logging_config_to_stream(std::ostream& out)
|
||||
{
|
||||
out << "# declare an appender named \"stderr\" that writes messages to the console\n"
|
||||
"[log.console_appender.stderr]\n"
|
||||
"stream=std_error\n\n"
|
||||
"# declare an appender named \"p2p\" that writes messages to p2p.log\n"
|
||||
"[log.file_appender.p2p]\n"
|
||||
"filename=logs/p2p/p2p.log\n"
|
||||
"# filename can be absolute or relative to this config file\n\n"
|
||||
"# route any messages logged to the default logger to the \"stderr\" logger we\n"
|
||||
"# declared above, if they are info level are higher\n"
|
||||
"[logger.default]\n"
|
||||
"level=info\n"
|
||||
"appenders=stderr\n\n"
|
||||
"# route messages sent to the \"p2p\" logger to the p2p appender declared above\n"
|
||||
"[logger.p2p]\n"
|
||||
"level=debug\n"
|
||||
"appenders=p2p\n\n";
|
||||
}
|
||||
|
||||
fc::optional<fc::logging_config> load_logging_config_from_ini_file(const fc::path& config_ini_filename)
|
||||
{
|
||||
try
|
||||
{
|
||||
fc::logging_config logging_config;
|
||||
bool found_logging_config = false;
|
||||
|
||||
boost::property_tree::ptree config_ini_tree;
|
||||
boost::property_tree::ini_parser::read_ini(config_ini_filename.preferred_string().c_str(), config_ini_tree);
|
||||
for (const auto& section : config_ini_tree)
|
||||
{
|
||||
const std::string& section_name = section.first;
|
||||
const boost::property_tree::ptree& section_tree = section.second;
|
||||
|
||||
const std::string console_appender_section_prefix = "log.console_appender.";
|
||||
const std::string file_appender_section_prefix = "log.file_appender.";
|
||||
const std::string logger_section_prefix = "logger.";
|
||||
|
||||
if (boost::starts_with(section_name, console_appender_section_prefix))
|
||||
{
|
||||
std::string console_appender_name = section_name.substr(console_appender_section_prefix.length());
|
||||
std::string stream_name = section_tree.get<std::string>("stream");
|
||||
|
||||
// construct a default console appender config here
|
||||
// stdout/stderr will be taken from ini file, everything else hard-coded here
|
||||
fc::console_appender::config console_appender_config;
|
||||
console_appender_config.level_colors.emplace_back(
|
||||
fc::console_appender::level_color(fc::log_level::debug,
|
||||
fc::console_appender::color::green));
|
||||
console_appender_config.level_colors.emplace_back(
|
||||
fc::console_appender::level_color(fc::log_level::warn,
|
||||
fc::console_appender::color::brown));
|
||||
console_appender_config.level_colors.emplace_back(
|
||||
fc::console_appender::level_color(fc::log_level::error,
|
||||
fc::console_appender::color::cyan));
|
||||
console_appender_config.stream = fc::variant(stream_name).as<fc::console_appender::stream::type>();
|
||||
logging_config.appenders.push_back(fc::appender_config(console_appender_name, "console", fc::variant(console_appender_config)));
|
||||
found_logging_config = true;
|
||||
}
|
||||
else if (boost::starts_with(section_name, file_appender_section_prefix))
|
||||
{
|
||||
std::string file_appender_name = section_name.substr(file_appender_section_prefix.length());
|
||||
fc::path file_name = section_tree.get<std::string>("filename");
|
||||
if (file_name.is_relative())
|
||||
file_name = fc::absolute(config_ini_filename).parent_path() / file_name;
|
||||
|
||||
|
||||
// construct a default file appender config here
|
||||
// filename will be taken from ini file, everything else hard-coded here
|
||||
fc::file_appender::config file_appender_config;
|
||||
file_appender_config.filename = file_name;
|
||||
file_appender_config.flush = true;
|
||||
file_appender_config.rotate = true;
|
||||
file_appender_config.rotation_interval = fc::hours(1);
|
||||
file_appender_config.rotation_limit = fc::days(1);
|
||||
logging_config.appenders.push_back(fc::appender_config(file_appender_name, "file", fc::variant(file_appender_config)));
|
||||
found_logging_config = true;
|
||||
}
|
||||
else if (boost::starts_with(section_name, logger_section_prefix))
|
||||
{
|
||||
std::string logger_name = section_name.substr(logger_section_prefix.length());
|
||||
std::string level_string = section_tree.get<std::string>("level");
|
||||
std::string appenders_string = section_tree.get<std::string>("appenders");
|
||||
fc::logger_config logger_config(logger_name);
|
||||
logger_config.level = fc::variant(level_string).as<fc::log_level>();
|
||||
boost::split(logger_config.appenders, appenders_string,
|
||||
boost::is_any_of(" ,"),
|
||||
boost::token_compress_on);
|
||||
logging_config.loggers.push_back(logger_config);
|
||||
found_logging_config = true;
|
||||
}
|
||||
}
|
||||
if (found_logging_config)
|
||||
return logging_config;
|
||||
else
|
||||
return fc::optional<fc::logging_config>();
|
||||
}
|
||||
FC_RETHROW_EXCEPTIONS(warn, "")
|
||||
}
|
||||
Loading…
Reference in a new issue