#include "pchheader.hpp" #include "conf.hpp" #include "util/rollover_hashset.hpp" #include "usr/usr.hpp" #include "usr/user_input.hpp" #include "p2p/p2p.hpp" #include "msg/fbuf/p2pmsg_helpers.hpp" #include "msg/usrmsg_parser.hpp" #include "msg/usrmsg_common.hpp" #include "p2p/peer_session_handler.hpp" #include "hplog.hpp" #include "crypto.hpp" #include "util/h32.hpp" #include "unl.hpp" #include "ledger/ledger.hpp" #include "consensus.hpp" namespace p2pmsg = msg::fbuf::p2pmsg; namespace consensus { constexpr float STAGE_THRESHOLDS[] = {0.5, 0.65, 0.8}; // Voting thresholds for stage 1,2,3 constexpr float MAJORITY_THRESHOLD = 0.8; constexpr size_t ROUND_NONCE_SIZE = 64; constexpr const char *HPFS_SESSION_NAME = "ro_patch_file_to_hp"; // Max no. of time to get unreliable votes before we try heuristics to increase vote receiving reliability. constexpr uint16_t MAX_UNRELIABLE_VOTES_ATTEMPTS = 5; consensus_context ctx; bool init_success = false; std::atomic is_patch_update_pending = false; // Keep track whether the patch file is changed by the SC and is not yet applied to runtime. int init() { refresh_roundtime(false); // Starting consensus processing thread. ctx.consensus_thread = std::thread(run_consensus); init_success = true; return 0; } /** * Cleanup any resources. */ void deinit() { if (init_success) { // Making the consensus while loop stop. ctx.is_shutting_down = true; // Stop the contract if running. { std::scoped_lock lock(ctx.contract_ctx_mutex); if (ctx.contract_ctx) sc::stop(ctx.contract_ctx.value()); } // Joining consensus processing thread. if (ctx.consensus_thread.joinable()) ctx.consensus_thread.join(); } } /** * Joins the consensus processing thread. */ void wait() { ctx.consensus_thread.join(); } void run_consensus() { util::mask_signal(); LOG_INFO << "Consensus processor started."; while (!ctx.is_shutting_down) { if (consensus() == -1) { LOG_ERROR << "Consensus thread exited due to an error."; break; } } LOG_INFO << "Consensus processor stopped."; } int consensus() { // A consensus round consists of 4 stages (0,1,2,3). // For a given stage, this function may get visited multiple times due to time-wait conditions. if (!wait_and_proceed_stage()) return 0; // This means the stage has been reset. LOG_DEBUG << "Started stage " << std::to_string(ctx.stage); // Throughout consensus, we continously update and prune the candidate proposals for newly // arived ones and expired ones. revise_candidate_proposals(); // If possible, switch back to validator mode before stage processing. (if we were syncing before) check_sync_completion(); // Get current lcl, state, patch, primary shard and blob shard info. p2p::sequence_hash lcl_id = ledger::ctx.get_lcl_id(); util::h32 state_hash = sc::contract_fs.get_parent_hash(sc::STATE_DIR_PATH); const util::h32 patch_hash = sc::contract_fs.get_parent_hash(sc::PATCH_FILE_PATH); const p2p::sequence_hash last_primary_shard_id = ledger::ctx.get_last_primary_shard_id(); const p2p::sequence_hash last_blob_shard_id = ledger::ctx.get_last_blob_shard_id(); if (ctx.stage == 0) { // Prepare the consensus candidate user inputs that we have accumulated so far. (We receive them periodically via NUPs) // The candidate inputs will be included in the stage 0 proposal. if (verify_and_populate_candidate_user_inputs(lcl_id.seq_no) == -1) return -1; const p2p::proposal p = create_stage0_proposal(state_hash, patch_hash, last_primary_shard_id, last_blob_shard_id); broadcast_proposal(p); ctx.stage = 1; // Transition to next stage. } else { // Stages 1,2,3 const size_t unl_count = unl::count(); vote_counter votes; const int sync_status = check_sync_status(unl_count, votes); if (sync_status == -2) // Unreliable votes. { ctx.unreliable_votes_attempts++; if (ctx.unreliable_votes_attempts >= MAX_UNRELIABLE_VOTES_ATTEMPTS) { refresh_roundtime(true); ctx.unreliable_votes_attempts = 0; } } else { ctx.unreliable_votes_attempts = 0; } if (sync_status == 0) { // If we are in sync, vote and broadcast the winning votes to next stage. const p2p::proposal p = create_stage123_proposal(votes, unl_count, state_hash, patch_hash, last_primary_shard_id, last_blob_shard_id); broadcast_proposal(p); // Upon successful consensus at stage 3, update the ledger and execute the contract using the consensus proposal. if (ctx.stage == 3 && update_ledger_and_execute_contract(p, state_hash, patch_hash, lcl_id) == -1) LOG_ERROR << "Error occured in Stage 3 consensus execution."; } if (ctx.stage == 2) { // At end of stage 2, broadcast non-unl proposal (NUP) containing inputs from locally connected users. // This will be captured and verified during every round stage 0. // (We broadcast this at stage 2 in order to give it enough time to reach others before next round stage 0) broadcast_nonunl_proposal(); } // We have finished a consensus stage. Transition or reset stage based on sync status. if (sync_status == -2) ctx.stage = 0; // Majority last primary shard unreliable. Reset to stage 0. else ctx.stage = (ctx.stage + 1) % 4; // Transition to next stage. (if at stage 3 go to next round stage 0) } return 0; } /** * Checks whether we are in sync with the received votes. * @return 0 if we are in sync. -1 on ledger or hpfs desync. -2 if majority last ledger primary shard hash unreliable. */ int check_sync_status(const size_t unl_count, vote_counter &votes) { bool is_last_primary_shard_desync = false; p2p::sequence_hash majority_primary_shard_id; if (check_last_primary_shard_hash_votes(is_last_primary_shard_desync, majority_primary_shard_id, votes, unl_count)) { // We proceed further only if last primary shard hash check was success (meaning last primary shard hash check could be reliably performed). // Last primary shard hash sync is commenced if we are out-of-sync with majority last primary shard hash. if (is_last_primary_shard_desync) { conf::change_role(conf::ROLE::OBSERVER); // We first request the latest shard. const std::string majority_shard_seq_no_str = std::to_string(majority_primary_shard_id.seq_no); const std::string sync_name = "primary shard " + majority_shard_seq_no_str; const std::string shard_path = std::string(ledger::PRIMARY_DIR).append("/").append(majority_shard_seq_no_str); ledger::ledger_sync_worker.set_target_push_front(hpfs::sync_target{sync_name, majority_primary_shard_id.hash, shard_path, hpfs::BACKLOG_ITEM_TYPE::DIR}); } // Check out blob shard hash with majority blob shard hash. bool is_last_blob_shard_desync = false; p2p::sequence_hash majority_blob_shard_id; check_last_blob_shard_hash_votes(is_last_blob_shard_desync, majority_blob_shard_id, votes); // Check our state with majority state. bool is_state_desync = false; bool is_patch_desync = false; util::h32 majority_state_hash = util::h32_empty; util::h32 majority_patch_hash = util::h32_empty; check_patch_votes(is_patch_desync, majority_patch_hash, votes); check_state_votes(is_state_desync, majority_state_hash, votes); // Stop any patch file updates triggered from the sc. The sync is triggered because the changes // done by the contract is not meeting consensus. if (is_patch_desync) is_patch_update_pending = false; // Start hpfs sync if we are out-of-sync with majority hpfs patch hash or state hash. if (is_state_desync || is_patch_desync || is_last_blob_shard_desync) { conf::change_role(conf::ROLE::OBSERVER); // Patch file sync is prioritized, Therefore it is set in the front of the sync target list. if (is_patch_desync) sc::contract_sync_worker.set_target_push_front(hpfs::sync_target{"patch", majority_patch_hash, sc::PATCH_FILE_PATH, hpfs::BACKLOG_ITEM_TYPE::FILE}); if (is_state_desync) sc::contract_sync_worker.set_target_push_back(hpfs::sync_target{"state", majority_state_hash, sc::STATE_DIR_PATH, hpfs::BACKLOG_ITEM_TYPE::DIR}); // If ledger blob shard is desync, We first request the latest blob shard. if (is_last_blob_shard_desync) { const std::string majority_shard_seq_no_str = std::to_string(majority_blob_shard_id.seq_no); const std::string sync_name = "blob shard " + majority_shard_seq_no_str; const std::string shard_path = std::string(ledger::BLOB_DIR).append("/").append(majority_shard_seq_no_str); ledger::ledger_sync_worker.set_target_push_back(hpfs::sync_target{sync_name, majority_blob_shard_id.hash, shard_path, hpfs::BACKLOG_ITEM_TYPE::DIR}); } } // Proceed further only if last primary shard, last blob shard, state and patch hashes are in sync with majority. if (!is_last_primary_shard_desync && !is_last_blob_shard_desync && !is_state_desync && !is_patch_desync) { conf::change_role(conf::ROLE::VALIDATOR); return 0; } // Last primary shard hash, last blob shard hash, patch or state desync. return -1; } // Majority last primary shard hash couldn't be detected reliably. return -2; } /** * Checks whether we can switch back from currently ongoing observer-mode sync operation * that has been completed. */ void check_sync_completion() { if (conf::cfg.node.role == conf::ROLE::OBSERVER && !sc::contract_sync_worker.is_syncing && !ledger::ledger_sync_worker.is_syncing) conf::change_role(conf::ROLE::VALIDATOR); } /** * Moves proposals collected from the network into candidate proposals and * cleans up any outdated proposals from the candidate set. */ void revise_candidate_proposals() { // Move over the network proposal collection into a local list. This is to have a private working // set for candidate parsing and avoid threading conflicts with network incoming proposals. std::list collected_proposals; { std::scoped_lock lock(p2p::ctx.collected_msgs.proposals_mutex); collected_proposals.splice(collected_proposals.end(), p2p::ctx.collected_msgs.proposals); } // Provide latest roundtime information to unl statistics. unl::update_roundtime_stats(collected_proposals); // Move collected propsals to candidate set of proposals. // Add propsals of new nodes and replace proposals from old nodes to reflect current status of nodes. for (const auto &proposal : collected_proposals) { ctx.candidate_proposals.erase(proposal.pubkey); // Erase if already exists. ctx.candidate_proposals.emplace(proposal.pubkey, std::move(proposal)); } // Prune any outdated proposals. auto itr = ctx.candidate_proposals.begin(); const uint64_t time_now = util::get_epoch_milliseconds(); while (itr != ctx.candidate_proposals.end()) { const p2p::proposal &cp = itr->second; const uint64_t time_diff = (time_now > cp.sent_timestamp) ? (time_now - cp.sent_timestamp) : 0; const int8_t stage_diff = ctx.stage - cp.stage; // only consider recent proposals and proposals from previous stage and current stage. const bool keep_candidate = (time_diff < (conf::cfg.contract.roundtime * 4)) && (stage_diff == -3 || stage_diff <= 1); LOG_DEBUG << (keep_candidate ? "Prop--->" : "Erased") << " [s" << std::to_string(cp.stage) << "] u/i:" << cp.users.size() << "/" << cp.input_hashes.size() << " ts:" << std::to_string(cp.time) << " state:" << cp.state_hash << " patch:" << cp.patch_hash << " [from:" << ((cp.pubkey == conf::cfg.node.public_key) ? "self" : util::to_hex(cp.pubkey).substr(2, 10)) << "]" << "(" << std::to_string(cp.recv_timestamp > cp.sent_timestamp ? cp.recv_timestamp - cp.sent_timestamp : 0) << "ms)"; if (keep_candidate) ++itr; else ctx.candidate_proposals.erase(itr++); } } /** * Syncrhonise the stage/round time for fixed intervals and reset the stage. * @return True if consensus can proceed in the current round. False if stage is reset. */ bool wait_and_proceed_stage() { // Here, nodes try to synchronise nodes stages using network clock. // We devide universal time to windows of equal size of roundtime. Each round must be synced with the // start of a window. const uint64_t now = util::get_epoch_milliseconds(); // Rrounds are discreet windows of roundtime. if (ctx.stage == 0) { // This gets the start time of current round window. Stage 0 must start in the window after that. const uint64_t previous_round_start = (((uint64_t)((now - ctx.round_boundry_offset) / conf::cfg.contract.roundtime)) * conf::cfg.contract.roundtime) + ctx.round_boundry_offset; // Stage 0 must start in the next round window. // (This makes sure stage 3 gets whichever the remaining time in the round after stages 0,1,2) ctx.round_start_time = previous_round_start + conf::cfg.contract.roundtime; const uint64_t to_wait = ctx.round_start_time - now; LOG_DEBUG << "Waiting " << to_wait << "ms for next round stage 0."; util::sleep(to_wait); return true; } else { const uint64_t stage_start = ctx.round_start_time + (ctx.stage * ctx.stage_time); // Compute stage time wait. // Node wait between stages to collect enough proposals from previous stages from other nodes. const uint64_t to_wait = stage_start - now; // If a node doesn't have enough time (eg. due to network delay) to recieve/send reliable stage proposals for next stage, // it will join in next round. Otherwise it will continue particapating in this round. if (to_wait < ctx.stage_reset_wait_threshold) //todo: self claculating/adjusting network delay { LOG_DEBUG << "Missed stage " << std::to_string(ctx.stage) << " window. Resetting to stage 0."; ctx.stage = 1; return false; } else { LOG_DEBUG << "Waiting " << std::to_string(to_wait) << "ms for stage " << std::to_string(ctx.stage); util::sleep(to_wait); return true; } } } /** * Broadcasts any inputs from locally connected users via an NUP. */ void broadcast_nonunl_proposal() { p2p::nonunl_proposal nup; { // Populate users and inputs to the NUP within user lock. std::scoped_lock lock(usr::ctx.users_mutex); if (usr::ctx.users.empty()) return; // Construct NUP. for (auto &[sid, user] : usr::ctx.users) { std::list user_inputs; user_inputs.splice(user_inputs.end(), user.submitted_inputs); user.collected_input_size = 0; // Reset the collected inputs size counter. // We should create an entry for each user pubkey, even if the user has no inputs. This is // because this data map will be used to track connected users as well in addition to inputs. nup.user_inputs.try_emplace(user.pubkey, std::move(user_inputs)); } } flatbuffers::FlatBufferBuilder fbuf(1024); p2pmsg::create_msg_from_nonunl_proposal(fbuf, nup); p2p::broadcast_message(fbuf, true); LOG_DEBUG << "NUP sent." << " users:" << nup.user_inputs.size(); } /** * Broadcasts the given proposal to all connected peers if in VALIDATOR mode. Does not send in OBSERVER mode. * @return 0 on success. -1 if no peers to broadcast. */ void broadcast_proposal(const p2p::proposal &p) { // In observer mode, we do not send out proposals. if (conf::cfg.node.role == conf::ROLE::OBSERVER || !conf::cfg.node.is_unl) // If we are a non-unl node, do not broadcast proposals. return; flatbuffers::FlatBufferBuilder fbuf(1024); p2pmsg::create_msg_from_proposal(fbuf, p); p2p::broadcast_message(fbuf, true, false, !conf::cfg.contract.is_consensus_public); LOG_DEBUG << "Proposed u/i:" << p.users.size() << "/" << p.input_hashes.size() << " ts:" << std::to_string(p.time) << " state:" << p.state_hash << " patch:" << p.patch_hash << " last_primary_shard_id:" << p.last_primary_shard_id << " last_blob_shard_id:" << p.last_blob_shard_id; } /** * Enqueue npl messages to the npl messages queue. * @param npl_msg Constructed npl message. * @return Returns true if enqueue is success otherwise false. */ bool push_npl_message(p2p::npl_message &npl_msg) { std::scoped_lock lock(ctx.contract_ctx_mutex); if (ctx.contract_ctx) return ctx.contract_ctx->args.npl_messages.try_enqueue(npl_msg); return false; } /** * Enqueue conrol messages to the control messages queue. * @param control_msg Constructed control message. * @return Returns true if enqueue is success otherwise false. */ bool push_control_message(const std::string &control_msg) { std::scoped_lock lock(ctx.contract_ctx_mutex); if (ctx.contract_ctx) return ctx.contract_ctx->args.control_messages.try_enqueue(control_msg); return false; } /** * Verifies the user signatures and populate non-expired user inputs from collected * non-unl proposals (if any) into consensus candidate data. */ int verify_and_populate_candidate_user_inputs(const uint64_t lcl_seq_no) { // Maintains users and any input-acceptance responses we should send to them. // Key: user pubkey. Value: List of responses for that user. std::unordered_map> responses; // Maintains merged list of users with each user's inputs grouped under the user. // Key: user pubkey, Value: List of inputs from the user. std::unordered_map> input_groups; // Move over NUPs collected from the network input groups (grouped by user). { std::list collected_nups; { std::scoped_lock lock(p2p::ctx.collected_msgs.nonunl_proposals_mutex); collected_nups.splice(collected_nups.end(), p2p::ctx.collected_msgs.nonunl_proposals); } for (p2p::nonunl_proposal &p : collected_nups) { for (auto &[pubkey, sbmitted_inputs] : p.user_inputs) { // Move any user inputs from each NUP over to the grouped inputs under the user pubkey. std::list &input_list = input_groups[pubkey]; input_list.splice(input_list.end(), sbmitted_inputs); } } } for (auto &[pubkey, submitted_inputs] : input_groups) { // Populate user list with this user's pubkey. ctx.candidate_users.emplace(pubkey); std::list extracted_inputs; for (const usr::submitted_user_input &submitted_input : submitted_inputs) { usr::extracted_user_input extracted = {}; const char *reject_reason = usr::extract_submitted_input(pubkey, submitted_input, extracted); if (reject_reason == NULL) extracted_inputs.push_back(std::move(extracted)); else responses[pubkey].push_back(usr::input_status_response{submitted_input.protocol, submitted_input.sig, reject_reason}); } // This will sort the inputs in nonce order so the validation will follow the same order on all nodes. extracted_inputs.sort(); // Keep track of total input length to verify against remaining balance. // We only process inputs in the submitted order that can be satisfied with the remaining account balance. size_t total_input_size = 0; for (const usr::extracted_user_input &extracted_input : extracted_inputs) { util::buffer_view stored_input; // Contains pointer to the input data stored in memfd accessed by the contract. std::string hash; // Validate the input against all submission criteria. const char *reject_reason = usr::validate_user_input_submission(pubkey, extracted_input, lcl_seq_no, total_input_size, hash, stored_input); if (reject_reason == NULL && !stored_input.is_null()) { // No reject reason means we should go ahead and subject the input to consensus. ctx.candidate_user_inputs.try_emplace( hash, candidate_user_input(pubkey, stored_input, extracted_input.max_lcl_seqno)); } responses[pubkey].push_back(usr::input_status_response{extracted_input.protocol, extracted_input.sig, reject_reason}); } } input_groups.clear(); usr::send_input_status_responses(responses); return 0; } p2p::proposal create_stage0_proposal(const util::h32 &state_hash, const util::h32 &patch_hash, const p2p::sequence_hash &last_primary_shard_id, const p2p::sequence_hash &last_blob_shard_id) { // This is the proposal that stage 0 votes on. // We report our own values in stage 0. p2p::proposal p; p.time = ctx.round_start_time; p.stage = 0; p.state_hash = state_hash; p.patch_hash = patch_hash; p.last_primary_shard_id = last_primary_shard_id; p.last_blob_shard_id = last_blob_shard_id; crypto::random_bytes(p.nonce, ROUND_NONCE_SIZE); // Populate the proposal with set of candidate user pubkeys. p.users.swap(ctx.candidate_users); // Populate the proposal with hashes of user inputs. for (const auto &[hash, cand_input] : ctx.candidate_user_inputs) p.input_hashes.emplace(hash); // Populate the output hash and our signature. This is the merkle tree root hash of user outputs and state hash. p.output_hash = ctx.user_outputs_hashtree.root_hash(); p.output_sig = ctx.user_outputs_our_sig; return p; } p2p::proposal create_stage123_proposal(vote_counter &votes, const size_t unl_count, const util::h32 &state_hash, const util::h32 &patch_hash, const p2p::sequence_hash &last_primary_shard_id, const p2p::sequence_hash &last_blob_shard_id) { // The proposal to be emited at the end of this stage. p2p::proposal p; p.stage = ctx.stage; // We always vote for our current information regardless of what other peers are saying. // If there's a fork condition we will either request shards or hpfs state from // our peers or we will halt depending on level of consensus on the sides of the fork. p.state_hash = state_hash; p.patch_hash = patch_hash; p.last_primary_shard_id = last_primary_shard_id; p.last_blob_shard_id = last_blob_shard_id; const uint64_t time_now = util::get_epoch_milliseconds(); // Vote for rest of the proposal fields by looking at candidate proposals. for (const auto &[pubkey, cp] : ctx.candidate_proposals) { // Vote for times. // Everyone votes on the discreet time, as long as it's not in the future and within 2 round times. if (time_now > cp.time && (time_now - cp.time) <= (conf::cfg.contract.roundtime * 2)) increment(votes.time, cp.time); // Vote for round nonce. increment(votes.nonce, cp.nonce); // Vote for user pubkeys. for (const std::string &pubkey : cp.users) increment(votes.users, pubkey); // Vote for user inputs (hashes). Only vote for the inputs that are in our candidate_inputs set. for (const std::string &hash : cp.input_hashes) if (ctx.candidate_user_inputs.count(hash) > 0) increment(votes.inputs, hash); // Vote for contract output hash. increment(votes.output_hash, cp.output_hash); } uint32_t required_votes = ceil(STAGE_THRESHOLDS[ctx.stage - 1] * unl_count); // todo: check if inputs being proposed by another node are actually spoofed inputs // from a user locally connected to this node. // if we're at proposal stage 1 we'll accept any input and connection that has 1 or more vote. // Add user pubkeys which have votes over stage threshold to proposal. for (const auto &[pubkey, numvotes] : votes.users) if (numvotes >= required_votes || (ctx.stage == 1 && numvotes > 0)) p.users.emplace(pubkey); // Add inputs which have votes over stage threshold to proposal. for (const auto &[hash, numvotes] : votes.inputs) if (numvotes >= required_votes || (ctx.stage == 1 && numvotes > 0)) p.input_hashes.emplace(hash); // Reset required votes for majority votes. required_votes = ceil(MAJORITY_THRESHOLD * unl_count); // Add the output hash which has most votes over stage threshold to proposal. uint32_t highest_output_vote = 0; for (const auto &[hash, numvotes] : votes.output_hash) { if (numvotes >= required_votes && numvotes > highest_output_vote) { highest_output_vote = numvotes; p.output_hash = hash; } } if (!p.output_hash.empty()) { if (ctx.stage < 3) { // If the elected hash is our output hash, then place our output signature in the proposal. // We only do this if we are at stage 1 or 2. if (p.output_hash == ctx.user_outputs_hashtree.root_hash()) p.output_sig = ctx.user_outputs_our_sig; } else { // If this is the stage 3 proposal, collect the UNL output signatures matching the elected output hash. for (const auto &[pubkey, cp] : ctx.candidate_proposals) { if (cp.output_hash == p.output_hash) ctx.user_outputs_unl_sig.emplace_back(cp.pubkey, cp.output_sig); } } } // time is voted on a simple sorted (highest to lowest) and majority basis. uint32_t highest_time_vote = 0; for (const auto &[time, numvotes] : votes.time) { if (numvotes > highest_time_vote) { highest_time_vote = numvotes; p.time = time; } } // If final time happens to be 0 (this can happen if there were no proposals to vote for), we set the time manually. if (p.time == 0) p.time = ctx.round_start_time; // Round nonce is voted on a simple sorted (highest to lowest) and majority basis, since there will always be disagreement. uint32_t highest_nonce_vote = 0; for (const auto [nonce, numvotes] : votes.nonce) { if (numvotes > highest_nonce_vote) { highest_nonce_vote = numvotes; p.nonce = nonce; } } return p; } /** * Check whether our last primary shard hash is consistent with the proposals being made by our UNL peers last primary shard hash votes. * @param is_desync Indicates whether our ledger primary hash is out-of-sync with majority ledger primary hash. Only valid if this method returns True. * @param majority_primary_shard_id Majority primary shard id. * @param votes Vote counter for this stage. * @param unl_count Number of unl peers. * @return True if majority ledger primary hash could be calculated reliably. False if shard index hash check failed due to unreliable votes. */ bool check_last_primary_shard_hash_votes(bool &is_desync, p2p::sequence_hash &majority_primary_shard_id, vote_counter &votes, const size_t unl_count) { uint32_t total_ledger_primary_hash_votes = 0; for (const auto &[pubkey, cp] : ctx.candidate_proposals) { increment(votes.last_ledger_primary_shard, cp.last_primary_shard_id); total_ledger_primary_hash_votes++; } // Check whether we have received enough votes in total. const uint32_t min_required = ceil(MAJORITY_THRESHOLD * unl_count); if (total_ledger_primary_hash_votes < min_required) { LOG_INFO << "Not enough peers proposing to perform consensus. votes:" << total_ledger_primary_hash_votes << " needed:" << min_required; return false; } uint32_t winning_votes = 0; for (const auto [shard_id, votes] : votes.last_ledger_primary_shard) { if (votes > winning_votes) { winning_votes = votes; majority_primary_shard_id = shard_id; } } // If winning last primary shard hash is not matched with our last primary shard hash, that means we are not on the consensus ledger. // If that's the case we should request shards straight away. if (ledger::ctx.get_last_primary_shard_id() != majority_primary_shard_id) { LOG_DEBUG << "We are not on the consensus ledger, we must request history from a peer."; is_desync = true; return true; } else { // Check wheher there are enough winning votes for the last shard to be reliable. const uint32_t min_wins_required = ceil(MAJORITY_THRESHOLD * ctx.candidate_proposals.size()); if (winning_votes < min_wins_required) { LOG_INFO << "No consensus on last shard hash. Possible fork condition. won:" << winning_votes << " needed:" << min_wins_required; return false; } else { // Reaching here means we have reliable amount of winning last shard hash votes and our last shard hash matches with majority last shard hash. is_desync = false; return true; } } } /** * Check whether our last blob shard hash is consistent with the proposals being made by our UNL peers last blob shard hash votes. * @param is_ledger_blob_desync Indicates whether our ledger blob hash is out-of-sync with majority ledger blob hash. * @param majority_primary_shard_id Majority primary shard id. * @param votes Vote counter for this stage. */ void check_last_blob_shard_hash_votes(bool &is_ledger_blob_desync, p2p::sequence_hash &majority_blob_shard_id, vote_counter &votes) { for (const auto &[pubkey, cp] : ctx.candidate_proposals) { increment(votes.last_ledger_blob_shard, cp.last_blob_shard_id); } uint32_t winning_votes = 0; for (const auto [shard_id, votes] : votes.last_ledger_blob_shard) { if (votes > winning_votes) { winning_votes = votes; majority_blob_shard_id = shard_id; } } is_ledger_blob_desync = (ledger::ctx.get_last_blob_shard_id() != majority_blob_shard_id); } /** * Check state hash against the winning and canonical state hash. * @param is_state_desync Flag to determine whether contract state is out of sync. * @param majority_state_hash Consensused state hash. * @param votes The voting table. */ void check_state_votes(bool &is_state_desync, util::h32 &majority_state_hash, vote_counter &votes) { for (const auto &[pubkey, cp] : ctx.candidate_proposals) { increment(votes.state_hash, cp.state_hash); } uint32_t winning_votes = 0; for (const auto [state_hash, votes] : votes.state_hash) { if (votes > winning_votes) { winning_votes = votes; majority_state_hash = state_hash; } } is_state_desync = (sc::contract_fs.get_parent_hash(sc::STATE_DIR_PATH) != majority_state_hash); } /** * Check state hash against the winning and canonical state hash. * @param is_patch_desync Flag to determine whether patch file is out of sync. * @param majority_patch_hash Consensused patch hash. * @param votes The voting table. */ void check_patch_votes(bool &is_patch_desync, util::h32 &majority_patch_hash, vote_counter &votes) { for (const auto &[pubkey, cp] : ctx.candidate_proposals) { increment(votes.patch_hash, cp.patch_hash); } uint32_t winning_votes = 0; for (const auto [patch_hash, votes] : votes.patch_hash) { if (votes > winning_votes) { winning_votes = votes; majority_patch_hash = patch_hash; } } is_patch_desync = (sc::contract_fs.get_parent_hash(sc::PATCH_FILE_PATH) != majority_patch_hash); } /** * Update the ledger and execute the contract after consensus. * @param cons_prop The proposal that reached consensus. * @param new_state_hash The state hash. * @param patch_hash The patch hash. * @param lcl_id Last lcl seq_no and hash. * @param last_primary_shard_id Last primary shard id. */ int update_ledger_and_execute_contract(const p2p::proposal &cons_prop, util::h32 &new_state_hash, const util::h32 &patch_hash, p2p::sequence_hash &new_lcl_id) { if (ledger::save_ledger(cons_prop, ctx.candidate_user_inputs, ctx.generated_user_outputs) == -1) return -1; new_lcl_id = ledger::ctx.get_lcl_id(); const p2p::sequence_hash new_last_primary_shard_id = ledger::ctx.get_last_primary_shard_id(); LOG_INFO << "****Ledger created**** (lcl:" << new_lcl_id << " state:" << cons_prop.state_hash << " patch:" << cons_prop.patch_hash << ")"; // Apply consensed patch file changes to the hpcore runtime and hp.cfg. if (apply_consensed_patch_file_changes(cons_prop.patch_hash, patch_hash) == -1) return -1; // After the current ledger seq no is updated, we remove any newly expired inputs from candidate set. { auto itr = ctx.candidate_user_inputs.begin(); while (itr != ctx.candidate_user_inputs.end()) { if (itr->second.maxledgerseqno <= new_lcl_id.seq_no) ctx.candidate_user_inputs.erase(itr++); else ++itr; } } // Send any output from the previous consensus round to locally connected users. if (dispatch_user_outputs(cons_prop, new_lcl_id) == -1) return -1; // Execute the contract if (conf::cfg.contract.execute && !ctx.is_shutting_down) { { std::scoped_lock lock(ctx.contract_ctx_mutex); ctx.contract_ctx.emplace(usr::input_store); } sc::contract_execution_args &args = ctx.contract_ctx->args; args.readonly = false; args.time = cons_prop.time; args.lcl = ledger::get_lcl_string(new_lcl_id); // This is currently used for npl message checks. args.lasl_primary_shard_id = new_last_primary_shard_id; // Populate user bufs. if (feed_user_inputs_to_contract_bufmap(args.userbufs, cons_prop) == -1) return -1; if (sc::execute_contract(ctx.contract_ctx.value()) == -1) { LOG_ERROR << "Contract execution failed."; return -1; } // Update state hash in contract fs global hash tracker. sc::contract_fs.set_parent_hash(sc::STATE_DIR_PATH, args.post_execution_state_hash); new_state_hash = args.post_execution_state_hash; extract_user_outputs_from_contract_bufmap(args.userbufs); // Generate user output hash merkle tree and signature with state hash included. if (!ctx.generated_user_outputs.empty()) { std::vector hashes; for (const auto &[hash, output] : ctx.generated_user_outputs) hashes.push_back(hash); hashes.push_back(new_state_hash.to_string_view()); ctx.user_outputs_hashtree.populate(hashes); ctx.user_outputs_our_sig = crypto::sign(ctx.user_outputs_hashtree.root_hash(), conf::cfg.node.private_key); } { std::scoped_lock lock(ctx.contract_ctx_mutex); ctx.contract_ctx.reset(); } } return 0; } /** * Dispatch any consensus-reached outputs to matching users if they are connected to us locally. * @param cons_prop The proposal that achieved consensus. * @param lcl_id Lcl sequnce no hash info. */ int dispatch_user_outputs(const p2p::proposal &cons_prop, const p2p::sequence_hash lcl_id) { if (cons_prop.output_hash == ctx.user_outputs_hashtree.root_hash()) { std::scoped_lock lock(usr::ctx.users_mutex); // If final elected output hash matches our output hash, distribute the outputs // to locally connected users. for (auto &[hash, user_output] : ctx.generated_user_outputs) { // Find user to send by pubkey. const auto user_itr = usr::ctx.users.find(user_output.userpubkey); if (user_itr != usr::ctx.users.end()) // match found { const usr::connected_user &user = user_itr->second; msg::usrmsg::usrmsg_parser parser(user.protocol); // Send the outputs and signatures to the user. std::vector msg; // Get the collapsed hash tree with this user's output hash remaining independently. util::merkle_hash_node collapsed_hash_root = ctx.user_outputs_hashtree.collapse(hash); std::vector outputs; for (const sc::contract_output &output : user_output.outputs) outputs.emplace_back(output.message); parser.create_contract_output_container(msg, outputs, collapsed_hash_root, ctx.user_outputs_unl_sig, lcl_id.seq_no, ledger::get_lcl_string(lcl_id)); user.session.send(msg); } user_output.outputs.clear(); // We no longer need this user's outputs. } } else { LOG_INFO << "Output required but didn't match our output hash."; } // Clear the output hash tree and signature because we no longer need it. ctx.user_outputs_hashtree.clear(); ctx.user_outputs_our_sig.clear(); ctx.user_outputs_unl_sig.clear(); ctx.generated_user_outputs.clear(); return 0; } /** * Transfers consensus-reached inputs into the provided contract buf map so it can be fed into the contract process. * @param bufmap The contract bufmap which needs to be populated with inputs. * @param cons_prop The proposal that achieved consensus. */ int feed_user_inputs_to_contract_bufmap(sc::contract_bufmap_t &bufmap, const p2p::proposal &cons_prop) { // Populate the buf map with all currently connected users regardless of whether they have inputs or not. // This is in case the contract wanted to emit some data to a user without needing any input. for (const std::string &pubkey : cons_prop.users) { bufmap.try_emplace(pubkey, sc::contract_iobufs()); } for (const std::string &hash : cons_prop.input_hashes) { // For each consensus input hash, we need to find the actual input content to feed the contract. const auto itr = ctx.candidate_user_inputs.find(hash); const bool hashfound = (itr != ctx.candidate_user_inputs.end()); if (!hashfound) { LOG_ERROR << "Input required but wasn't in our candidate inputs map, this will potentially cause desync."; return -1; } else { // Populate the input content into the bufmap. // It's VERY important that we preserve the proposal input hash order when feeding to the contract as well. candidate_user_input &cand_input = itr->second; sc::contract_iobufs &contract_user = bufmap[cand_input.userpubkey]; contract_user.inputs.push_back(cand_input.input); // Remove the input from the candidate set because we no longer need it. ctx.candidate_user_inputs.erase(itr); } } return 0; } /** * Reads any outputs the contract has produced on the provided buf map and transfers them to generated outputs * for the next consensus round. * @param bufmap The contract bufmap containing the outputs produced by the contract. */ void extract_user_outputs_from_contract_bufmap(sc::contract_bufmap_t &bufmap) { for (auto &[pubkey, bufs] : bufmap) { if (!bufs.outputs.empty()) { std::vector vect; // Adding public key. vect.push_back(pubkey); // Only using message to generate hash for output messages. Length is not needed. for (sc::contract_output &output : bufs.outputs) { vect.push_back(output.message); } const std::string hash = crypto::get_hash(vect); ctx.generated_user_outputs.try_emplace( std::move(hash), generated_user_output(pubkey, std::move(bufs.outputs))); } } bufmap.clear(); } /** * Increment voting table counter. * @param counter The counter map in which a vote should be incremented. * @param candidate The candidate whose vote should be increased by 1. */ template void increment(std::map &counter, const T &candidate) { if (counter.count(candidate)) counter[candidate]++; else counter.try_emplace(candidate, 1); } /** * Apply patch file changes after verification from consensus. * @param prop_patch_hash Hash of patch file which reached consensus. * @param current_patch_hash Hash of the current patch file. * @return 0 on success. -1 on failure. */ int apply_consensed_patch_file_changes(const util::h32 &prop_patch_hash, const util::h32 ¤t_patch_hash) { // Check whether is there any patch changes to be applied which reached consensus. if (is_patch_update_pending && current_patch_hash == prop_patch_hash) { if (sc::contract_fs.start_ro_session(HPFS_SESSION_NAME, false) != -1) { // Appling new patch file changes to hpcore runtime. if (conf::apply_patch_config(HPFS_SESSION_NAME) == -1) { LOG_ERROR << "Appling patch file changes after consensus failed."; sc::contract_fs.stop_ro_session(HPFS_SESSION_NAME); return -1; } else { unl::update_unl_changes_from_patch(); is_patch_update_pending = false; } } if (sc::contract_fs.stop_ro_session(HPFS_SESSION_NAME) == -1) return -1; } return 0; } /** * Updates roundtime-based calculations with the latest roundtime value. * @param perform_detection Whether or not to detect roundtime from latest network information. */ void refresh_roundtime(const bool perform_detection) { if (perform_detection) { LOG_DEBUG << "Detecting roundtime..."; const uint32_t majority_roundtime = unl::get_majority_roundtime(); if (majority_roundtime == 0 || conf::cfg.contract.roundtime == majority_roundtime) return; LOG_INFO << "New roundtime detected:" << majority_roundtime << " previous:" << conf::cfg.contract.roundtime; conf::cfg.contract.roundtime = majority_roundtime; } // We allocate 1/4 of roundtime for each stage (0, 1, 2, 3). ctx.stage_time = conf::cfg.contract.roundtime / 4; ctx.stage_reset_wait_threshold = conf::cfg.contract.roundtime / 10; // We use a time window boundry offset based on contract id to vary the window boundries between // different contracts with same round time. std::hash str_hasher; ctx.round_boundry_offset = str_hasher(conf::cfg.contract.id) % conf::cfg.contract.roundtime; } } // namespace consensus