Hotstuff integration

libraries/CMakeLists.txt

@@ -22,6 +22,7 @@ add_subdirectory( testing )
 add_subdirectory( version )
 add_subdirectory( state_history )
 add_subdirectory( cli11 )
+add_subdirectory( hotstuff )
 
 set(USE_EXISTING_SOFTFLOAT ON CACHE BOOL "use pre-exisiting softfloat lib")
 set(ENABLE_TOOLS OFF CACHE BOOL "Build tools")

libraries/chain/controller.cpp

@@ -340,6 +340,7 @@ struct controller_impl {
       set_activation_handler<builtin_protocol_feature_t::get_block_num>();
       set_activation_handler<builtin_protocol_feature_t::crypto_primitives>();
       set_activation_handler<builtin_protocol_feature_t::bls_primitives>();
+      set_activation_handler<builtin_protocol_feature_t::instant_finality>();
 
       self.irreversible_block.connect([this](const block_state_ptr& bsp) {
          wasm_if_collect.current_lib(bsp->block_num);
@@ -1973,6 +1974,22 @@ struct controller_impl {
       pending->push();
    }
 
+   void commit_hs_proposal_msg(hs_proposal_message_ptr msg){
+      emit( self.new_hs_proposal_message, msg );
+   }
+
+   void commit_hs_vote_msg(hs_vote_message_ptr msg){
+      emit( self.new_hs_vote_message, msg );
+   }
+
+   void commit_hs_new_view_msg(hs_new_view_message_ptr msg){
+      emit( self.new_hs_new_view_message, msg );
+   }
+
+   void commit_hs_new_block_msg(hs_new_block_message_ptr msg){
+      emit( self.new_hs_new_block_message, msg );
+   }
+
    /**
     *  This method is called from other threads. The controller_impl should outlive those threads.
     *  However, to avoid race conditions, it means that the behavior of this function should not change
@@ -2966,6 +2983,22 @@ void controller::commit_block() {
    my->commit_block(block_status::incomplete);
 }
 
+void controller::commit_hs_proposal_msg(hs_proposal_message_ptr msg) {
+   my->commit_hs_proposal_msg(msg);
+}
+
+void controller::commit_hs_vote_msg(hs_vote_message_ptr msg) {
+   my->commit_hs_vote_msg(msg);
+}
+
+void controller::commit_hs_new_view_msg(hs_new_view_message_ptr msg) {
+   my->commit_hs_new_view_msg(msg);
+}
+
+void controller::commit_hs_new_block_msg(hs_new_block_message_ptr msg) {
+   my->commit_hs_new_block_msg(msg);
+}
+
 deque<transaction_metadata_ptr> controller::abort_block() {
    return my->abort_block();
 }
@@ -3840,6 +3873,14 @@ void controller_impl::on_activation<builtin_protocol_feature_t::bls_primitives>(
    } );
 }
 
+template<>
+void controller_impl::on_activation<builtin_protocol_feature_t::instant_finality>() {
+   db.modify( db.get<protocol_state_object>(), [&]( auto& ps ) {
+#warning host functions to set proposers, leaders, finalizers/validators
+      // FIXME/TODO: host functions to set proposers, leaders, finalizers/validators
+   } );
+}
+
 /// End of protocol feature activation handlers
 
 } } /// eosio::chain

libraries/chain/include/eosio/chain/config.hpp

@@ -12,6 +12,7 @@ const static auto reversible_blocks_dir_name = "reversible";
 
 const static auto default_state_dir_name     = "state";
 const static auto forkdb_filename            = "fork_db.dat";
+const static auto qcdb_filename              = "qc_db.dat";
 const static auto default_state_size            = 1*1024*1024*1024ll;
 const static auto default_state_guard_size      =    128*1024*1024ll;
 

libraries/chain/include/eosio/chain/controller.hpp

@@ -21,6 +21,15 @@ namespace eosio { namespace vm { class wasm_allocator; }}
 
 namespace eosio { namespace chain {
 
+   struct hs_proposal_message;
+   struct hs_vote_message;
+   struct hs_new_view_message;
+   struct hs_new_block_message;
+   using hs_proposal_message_ptr = std::shared_ptr<hs_proposal_message>;
+   using hs_vote_message_ptr = std::shared_ptr<hs_vote_message>;
+   using hs_new_view_message_ptr = std::shared_ptr<hs_new_view_message>;
+   using hs_new_block_message_ptr = std::shared_ptr<hs_new_block_message>;
+
    class authorization_manager;
 
    namespace resource_limits {
@@ -166,6 +175,12 @@ namespace eosio { namespace chain {
          block_state_ptr finalize_block( block_report& br, const signer_callback_type& signer_callback );
          void sign_block( const signer_callback_type& signer_callback );
          void commit_block();
+
+         void commit_hs_proposal_msg(hs_proposal_message_ptr msg);
+         void commit_hs_vote_msg(hs_vote_message_ptr msg);
+
+         void commit_hs_new_view_msg(hs_new_view_message_ptr msg);
+         void commit_hs_new_block_msg(hs_new_block_message_ptr msg);
 
          // thread-safe
          std::future<block_state_ptr> create_block_state_future( const block_id_type& id, const signed_block_ptr& b );
@@ -337,6 +352,10 @@ namespace eosio { namespace chain {
          signal<void(const transaction_metadata_ptr&)> accepted_transaction;
          signal<void(std::tuple<const transaction_trace_ptr&, const packed_transaction_ptr&>)> applied_transaction;
          signal<void(const int&)>                      bad_alloc;
+         signal<void(const hs_proposal_message_ptr&)>    new_hs_proposal_message;
+         signal<void(const hs_vote_message_ptr&)> new_hs_vote_message;
+         signal<void(const hs_new_view_message_ptr&)>    new_hs_new_view_message;
+         signal<void(const hs_new_block_message_ptr&)> new_hs_new_block_message;
 
          /*
          signal<void()>                                  pre_apply_block;

libraries/chain/include/eosio/chain/hotstuff.hpp

@@ -0,0 +1,93 @@
+#pragma once
+#include <eosio/chain/block_header.hpp>
+#include <fc/bitutil.hpp>
+#include <fc/crypto/bls_private_key.hpp>
+#include <fc/crypto/bls_public_key.hpp>
+#include <fc/crypto/bls_signature.hpp>
+#include <fc/crypto/bls_utils.hpp>
+
+namespace eosio::chain {
+
+   const block_id_type NULL_BLOCK_ID = block_id_type("00");
+   const fc::sha256 NULL_PROPOSAL_ID = fc::sha256("00");
+
+   inline uint64_t compute_height(uint32_t block_height, uint32_t phase_counter) {
+      return (uint64_t{block_height} << 32) | phase_counter;
+   }
+
+   struct extended_schedule {
+      producer_authority_schedule                          producer_schedule;
+      std::map<name, fc::crypto::blslib::bls_public_key>   bls_pub_keys;
+   };
+
+   struct quorum_certificate {
+      fc::sha256                          proposal_id = NULL_PROPOSAL_ID;
+      fc::unsigned_int                    active_finalizers = 0; //bitset encoding, following canonical order
+      fc::crypto::blslib::bls_signature   active_agg_sig;
+      bool                                quorum_met = false;
+   };
+
+   struct hs_vote_message {
+      fc::sha256                          proposal_id = NULL_PROPOSAL_ID; //vote on proposal
+      name                                finalizer;
+      fc::crypto::blslib::bls_signature   sig;
+   };
+
+   struct hs_proposal_message {
+      fc::sha256                          proposal_id = NULL_PROPOSAL_ID; //vote on proposal
+      block_id_type                       block_id = NULL_BLOCK_ID;
+      fc::sha256                          parent_id = NULL_PROPOSAL_ID; //new proposal
+      fc::sha256                          final_on_qc = NULL_PROPOSAL_ID;
+      quorum_certificate                  justify; //justification
+      uint8_t                             phase_counter = 0;
+
+      uint32_t block_num() const { return block_header::num_from_id(block_id); }
+      uint64_t get_height() const { return compute_height(block_header::num_from_id(block_id), phase_counter); };
+   };
+
+   struct hs_new_block_message {
+      block_id_type        block_id = NULL_BLOCK_ID; //new proposal
+      quorum_certificate   justify; //justification
+   };
+
+   struct hs_new_view_message {
+      quorum_certificate   high_qc; //justification
+   };
+
+   struct finalizer_state {
+
+      bool chained_mode = false;
+      fc::sha256 b_leaf = NULL_PROPOSAL_ID;
+      fc::sha256 b_lock = NULL_PROPOSAL_ID;
+      fc::sha256 b_exec = NULL_PROPOSAL_ID;
+      fc::sha256 b_finality_violation = NULL_PROPOSAL_ID;
+      block_id_type block_exec = NULL_BLOCK_ID;
+      block_id_type pending_proposal_block = NULL_BLOCK_ID;
+      uint32_t v_height = 0;
+      eosio::chain::quorum_certificate high_qc;
+      eosio::chain::quorum_certificate current_qc;
+      eosio::chain::extended_schedule schedule;
+      map<fc::sha256, hs_proposal_message> proposals;
+
+      const hs_proposal_message* get_proposal(const fc::sha256& id) const {
+         auto it = proposals.find(id);
+         if (it == proposals.end())
+            return nullptr;
+         return & it->second;
+      }
+   };
+
+   using hs_proposal_message_ptr = std::shared_ptr<hs_proposal_message>;
+   using hs_vote_message_ptr = std::shared_ptr<hs_vote_message>;
+   using hs_new_view_message_ptr = std::shared_ptr<hs_new_view_message>;
+   using hs_new_block_message_ptr = std::shared_ptr<hs_new_block_message>;
+
+} //eosio::chain
+
+FC_REFLECT(eosio::chain::quorum_certificate, (proposal_id)(active_finalizers)(active_agg_sig));
+FC_REFLECT(eosio::chain::extended_schedule, (producer_schedule)(bls_pub_keys));
+FC_REFLECT(eosio::chain::hs_vote_message, (proposal_id)(finalizer)(sig));
+FC_REFLECT(eosio::chain::hs_proposal_message, (proposal_id)(block_id)(parent_id)(final_on_qc)(justify)(phase_counter));
+FC_REFLECT(eosio::chain::hs_new_block_message, (block_id)(justify));
+FC_REFLECT(eosio::chain::hs_new_view_message, (high_qc));
+FC_REFLECT(eosio::chain::finalizer_state, (chained_mode)(b_leaf)(b_lock)(b_exec)(b_finality_violation)(block_exec)(pending_proposal_block)(v_height)(high_qc)(current_qc)(schedule)(proposals));

libraries/chain/include/eosio/chain/protocol_feature_manager.hpp

@@ -36,6 +36,7 @@ enum class builtin_protocol_feature_t : uint32_t {
    crypto_primitives = 19,
    get_block_num = 20,
    bls_primitives = 21,
+   instant_finality = 22,
    reserved_private_fork_protocol_features = 500000,
 };
 

libraries/chain/include/eosio/chain/types.hpp

@@ -76,7 +76,7 @@ namespace eosio::chain {
    using public_key_type  = fc::crypto::public_key;
    using private_key_type = fc::crypto::private_key;
    using signature_type   = fc::crypto::signature;
-   
+
    // configurable boost deque (for boost >= 1.71) performs much better than std::deque in our use cases
    using block_1024_option_t = boost::container::deque_options< boost::container::block_size<1024u> >::type;
    template<typename T>

libraries/chain/protocol_feature_manager.cpp

@@ -269,6 +269,15 @@ Enables new `get_block_num` intrinsic which returns the current block number.
 Builtin protocol feature: BLS_PRIMITIVES
 Adds new cryptographic host functions
 - Add, multiply, multi-exponentiation and pairing functions for the bls12-381 elliptic curve.
+*/
+            {}
+         } )
+         (  builtin_protocol_feature_t::instant_finality, builtin_protocol_feature_spec{
+            "INSTANT_FINALITY",
+            fc::variant("bc726a24928ea2d71ba294b70c5c9efc515c1542139bcf9e42f8bc174f2e72ff").as<digest_type>(),
+            // SHA256 hash of the raw message below within the comment delimiters (do not modify message below).
+/*
+Builtin protocol feature: INSTANT_FINALITY
 */
             {}
          } )

libraries/hotstuff/CMakeLists.txt

@@ -0,0 +1,17 @@
+file(GLOB HEADERS "include/eosio/hotstuff/*.hpp")
+
+add_library( hotstuff
+             chain_pacemaker.cpp
+             qc_chain.cpp
+             ${HEADERS}
+           )
+
+target_link_libraries( hotstuff 
+                       PUBLIC eosio_chain fc
+                     )
+
+target_include_directories( hotstuff
+                            PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include" 
+                          )
+
+add_subdirectory( test )