set_finalizers host function (#1511)

libraries/chain/controller.cpp

@@ -27,6 +27,7 @@
 #include <eosio/chain/platform_timer.hpp>
 #include <eosio/chain/deep_mind.hpp>
 #include <eosio/chain/wasm_interface_collection.hpp>
+#include <eosio/chain/finalizer_set.hpp>
 
 #include <chainbase/chainbase.hpp>
 #include <eosio/vm/allocator.hpp>
@@ -263,6 +264,10 @@ struct controller_impl {
    map< account_name, map<handler_key, apply_handler> >   apply_handlers;
    unordered_map< builtin_protocol_feature_t, std::function<void(controller_impl&)>, enum_hash<builtin_protocol_feature_t> > protocol_feature_activation_handlers;
 
+   // TODO: This probably wants to be something better;
+   //       Storing when set_finalizers() is called; retrievable via get_finalizers() (called by chain_pacemaker)
+   uint64_t                     fthreshold = 0;
+   vector<finalizer_authority>  finalizers;
 
    void pop_block() {
       auto prev = fork_db.get_block( head->header.previous );
@@ -1990,6 +1995,15 @@ struct controller_impl {
       emit( self.new_hs_new_block_message, msg );
    }
 
+   void set_finalizers_impl(uint64_t fthreshold, vector<finalizer_authority> finalizers) {
+      this->fthreshold = fthreshold;
+      this->finalizers = std::move(finalizers);
+   }
+
+   std::pair<uint64_t, vector<finalizer_authority>> get_finalizers_impl() const {
+      return { fthreshold, finalizers };
+   }
+
    /**
     *  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
@@ -3313,6 +3327,14 @@ int64_t controller::set_proposed_producers( vector<producer_authority> producers
    return version;
 }
 
+void controller::set_finalizers( uint64_t fthreshold, vector<finalizer_authority> finalizers ) {
+   my->set_finalizers_impl(fthreshold, std::move(finalizers));
+}
+
+std::pair<uint64_t, vector<finalizer_authority>> controller::get_finalizers() const {
+   return my->get_finalizers_impl();
+}
+
 const producer_authority_schedule&    controller::active_producers()const {
    if( !(my->pending) )
       return  my->head->active_schedule;
@@ -3876,8 +3898,7 @@ 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
+      add_intrinsic_to_whitelist( ps.whitelisted_intrinsics, "set_finalizers" );
    } );
 }
 

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

@@ -130,6 +130,10 @@ const static int max_producers = 125;
 const static size_t maximum_tracked_dpos_confirmations = 1024;     ///<
 static_assert(maximum_tracked_dpos_confirmations >= ((max_producers * 2 / 3) + 1) * producer_repetitions, "Settings never allow for DPOS irreversibility" );
 
+/**
+ * Maximum number of finalizers in the finalizer set
+ */
+const static int max_finalizers = max_producers;
 
 /**
  * The number of blocks produced per round is based upon all producers having a chance

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

@@ -29,6 +29,7 @@ namespace eosio { namespace chain {
    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>;
+   struct finalizer_authority;
 
    class authorization_manager;
 
@@ -306,6 +307,9 @@ namespace eosio { namespace chain {
 
          int64_t set_proposed_producers( vector<producer_authority> producers );
 
+         void set_finalizers( uint64_t fthreshold, vector<finalizer_authority> finalizers );
+         std::pair<uint64_t, vector<finalizer_authority>> get_finalizers() const;
+
          bool light_validation_allowed() const;
          bool skip_auth_check()const;
          bool skip_trx_checks()const;
@@ -395,7 +399,6 @@ namespace eosio { namespace chain {
          chainbase::database& mutable_db()const;
 
          std::unique_ptr<controller_impl> my;
-
    };
 
 } }  /// eosio::chain

libraries/chain/include/eosio/chain/finalizer_set.hpp

@@ -0,0 +1,127 @@
+#pragma once
+
+#include <eosio/chain/config.hpp>
+#include <eosio/chain/types.hpp>
+#include <chainbase/chainbase.hpp>
+#include <eosio/chain/authority.hpp>
+#include <eosio/chain/snapshot.hpp>
+
+#include <fc/crypto/bls_public_key.hpp>
+
+namespace eosio::chain {
+
+   struct shared_finalizer_authority {
+      shared_finalizer_authority() = delete;
+      shared_finalizer_authority( const shared_finalizer_authority& ) = default;
+      shared_finalizer_authority( shared_finalizer_authority&& ) = default;
+      shared_finalizer_authority& operator= ( shared_finalizer_authority && ) = default;
+      shared_finalizer_authority& operator= ( const shared_finalizer_authority & ) = default;
+
+      shared_finalizer_authority( const std::string& description, const uint64_t fweight, const fc::crypto::blslib::bls_public_key& public_key )
+      :description(description)
+      ,fweight(fweight)
+      ,public_key(public_key)
+      {}
+
+#warning FIXME: Must change std::string to shared_string.
+      std::string      description;
+      uint64_t         fweight;
+      fc::crypto::blslib::bls_public_key   public_key;
+   };
+
+   struct shared_finalizer_set {
+      shared_finalizer_set() = delete;
+
+      explicit shared_finalizer_set( chainbase::allocator<char> alloc )
+      :finalizers(alloc){}
+
+      shared_finalizer_set( const shared_finalizer_set& ) = default;
+      shared_finalizer_set( shared_finalizer_set&& ) = default;
+      shared_finalizer_set& operator= ( shared_finalizer_set && ) = default;
+      shared_finalizer_set& operator= ( const shared_finalizer_set & ) = default;
+
+      uint32_t                                   version = 0; ///< sequentially incrementing version number
+      uint64_t                                   fthreshold = 0; // minimum finalizer fweight sum for block finalization
+      shared_vector<shared_finalizer_authority>  finalizers;
+   };
+
+   struct finalizer_authority {
+
+      std::string  description;
+      uint64_t     fweight; // weight that this finalizer's vote has for meeting fthreshold
+      fc::crypto::blslib::bls_public_key  public_key;
+
+      auto to_shared(chainbase::allocator<char> alloc) const {
+         return shared_finalizer_authority(description, fweight, public_key);
+      }
+
+      static auto from_shared( const shared_finalizer_authority& src ) {
+         return finalizer_authority { src.description, src.fweight, src.public_key };
+      }
+
+      friend bool operator == ( const finalizer_authority& lhs, const finalizer_authority& rhs ) {
+         return tie( lhs.description, lhs.fweight, lhs.public_key ) == tie( rhs.description, rhs.fweight, rhs.public_key );
+      }
+      friend bool operator != ( const finalizer_authority& lhs, const finalizer_authority& rhs ) {
+         return !(lhs == rhs);
+      }
+   };
+
+   struct finalizer_set {
+      finalizer_set() = default;
+
+      finalizer_set( uint32_t version, uint64_t fthreshold, std::initializer_list<finalizer_authority> finalizers )
+      :version(version)
+      ,fthreshold(fthreshold)
+      ,finalizers(finalizers)
+      {}
+
+      auto to_shared(chainbase::allocator<char> alloc) const {
+         auto result = shared_finalizer_set(alloc);
+         result.version = version;
+         result.fthreshold = fthreshold;
+         result.finalizers.clear();
+         result.finalizers.reserve( finalizers.size() );
+         for( const auto& f : finalizers ) {
+            result.finalizers.emplace_back(f.to_shared(alloc));
+         }
+         return result;
+      }
+
+      static auto from_shared( const shared_finalizer_set& src ) {
+         finalizer_set result;
+         result.version = src.version;
+         result.fthreshold = src.fthreshold;
+         result.finalizers.reserve( src.finalizers.size() );
+         for( const auto& f : src.finalizers ) {
+            result.finalizers.emplace_back(finalizer_authority::from_shared(f));
+         }
+         return result;
+      }
+
+      uint32_t                                       version = 0; ///< sequentially incrementing version number
+      uint64_t                                       fthreshold;  // vote fweight threshold to finalize blocks
+      vector<finalizer_authority>                    finalizers; // Instant Finality voter set
+
+      friend bool operator == ( const finalizer_set& a, const finalizer_set& b )
+      {
+         if( a.version != b.version ) return false;
+         if( a.fthreshold != b.fthreshold ) return false;
+         if ( a.finalizers.size() != b.finalizers.size() ) return false;
+         for( uint32_t i = 0; i < a.finalizers.size(); ++i )
+            if( ! (a.finalizers[i] == b.finalizers[i]) ) return false;
+         return true;
+      }
+
+      friend bool operator != ( const finalizer_set& a, const finalizer_set& b )
+      {
+         return !(a==b);
+      }
+   };
+
+} /// eosio::chain
+
+FC_REFLECT( eosio::chain::finalizer_authority, (description)(fweight)(public_key) )
+FC_REFLECT( eosio::chain::finalizer_set, (version)(fthreshold)(finalizers) )
+FC_REFLECT( eosio::chain::shared_finalizer_authority, (description)(fweight)(public_key) )
+FC_REFLECT( eosio::chain::shared_finalizer_set, (version)(fthreshold)(finalizers) )

libraries/chain/include/eosio/chain/webassembly/interface.hpp

@@ -173,6 +173,15 @@ namespace webassembly {
          */
          int64_t set_proposed_producers_ex(uint64_t packed_producer_format, legacy_span<const char> packed_producer_schedule);
 
+         /**
+          * Submits a finalizer set change to Hotstuff.
+          *
+          * @ingroup privileged
+          *
+          * @param packed_finalizer_set - a serialized finalizer_set object.
+         */
+         void set_finalizers(span<const char> packed_finalizer_set);
+
          /**
           * Retrieve the blockchain config parameters.
           *

libraries/chain/webassembly/privileged.cpp

@@ -5,6 +5,7 @@
 #include <eosio/chain/transaction_context.hpp>
 #include <eosio/chain/resource_limits.hpp>
 #include <eosio/chain/apply_context.hpp>
+#include <eosio/chain/finalizer_set.hpp>
 
 #include <fc/io/datastream.hpp>
 
@@ -150,6 +151,35 @@ namespace eosio { namespace chain { namespace webassembly {
       }
    }
 
+   void interface::set_finalizers(span<const char> packed_finalizer_set) {
+      EOS_ASSERT(!context.trx_context.is_read_only(), wasm_execution_error, "set_proposed_finalizers not allowed in a readonly transaction");
+      fc::datastream<const char*> ds( packed_finalizer_set.data(), packed_finalizer_set.size() );
+      finalizer_set finset;
+      fc::raw::unpack(ds, finset);
+      vector<finalizer_authority> & finalizers = finset.finalizers;
+
+      EOS_ASSERT( finalizers.size() <= config::max_finalizers, wasm_execution_error, "Finalizer set exceeds the maximum finalizer count for this chain" );
+      EOS_ASSERT( finalizers.size() > 0, wasm_execution_error, "Finalizer set cannot be empty" );
+
+      std::set<fc::crypto::blslib::bls_public_key> unique_finalizer_keys;
+#warning REVIEW: Is checking for unique finalizer descriptions at all relevant?
+      std::set<std::string> unique_finalizers;
+      uint64_t f_weight_sum = 0;
+
+      for (const auto& f: finalizers) {
+         EOS_ASSERT( f.public_key.valid(), wasm_execution_error, "Finalizer set includes an invalid key" );
+         f_weight_sum += f.fweight;
+         unique_finalizer_keys.insert(f.public_key);
+         unique_finalizers.insert(f.description);
+      }
+
+      EOS_ASSERT( finalizers.size() == unique_finalizers.size(), wasm_execution_error, "Duplicate finalizer description in finalizer set" );
+      EOS_ASSERT( finalizers.size() == unique_finalizer_keys.size(), wasm_execution_error, "Duplicate finalizer bls key in finalizer set" );
+      EOS_ASSERT( finset.fthreshold > f_weight_sum / 2, wasm_execution_error, "Finalizer set threshold cannot be met by finalizer weights" );
+
+      context.control.set_finalizers( finset.fthreshold, std::move(finalizers) );
+   }
+
    uint32_t interface::get_blockchain_parameters_packed( legacy_span<char> packed_blockchain_parameters ) const {
       auto& gpo = context.control.get_global_properties();
 

libraries/hotstuff/chain_pacemaker.cpp

@@ -235,6 +235,23 @@ namespace eosio { namespace hotstuff {
    }
 
    std::vector<name> chain_pacemaker::get_finalizers() {
+
+#warning FIXME: Use new finalizer list in pacemaker/qc_chain.
+      // Every time qc_chain wants to know what the finalizers are, we get it from the controller, which
+      //   is where it's currently stored.
+      //
+      // TODO:
+      // - solve threading. for this particular case, I don't think using _chain-> is a big deal really;
+      //   set_finalizers is called once in a blue moon, and this could be solved by a simple mutex even
+      //   if it is the main thread that is waiting for a lock. But maybe there's a better way to do this
+      //   overall.
+      // - use this information in qc_chain and delete the old code below
+      // - list of string finalizer descriptions instead of eosio name now
+      // - also return the keys for each finalizer, not just name/description so qc_chain can use them
+      //
+      auto [threshold, finalizers] = _chain->get_finalizers();
+
+      // Old code: get eosio::name from the producer schedule
       const block_state_ptr& hbs = _chain->head_block_state();
       const std::vector<producer_authority>& pa_list = hbs->active_schedule.producers;
       std::vector<name> pn_list;

libraries/hotstuff/include/eosio/hotstuff/chain_pacemaker.hpp

@@ -3,6 +3,8 @@
 #include <eosio/hotstuff/base_pacemaker.hpp>
 #include <eosio/hotstuff/qc_chain.hpp>
 
+#include <eosio/chain/finalizer_set.hpp>
+
 #include <shared_mutex>
 
 namespace eosio::chain {
@@ -70,7 +72,6 @@ namespace eosio::hotstuff {
 
       uint32_t                _quorum_threshold = 15; //FIXME/TODO: calculate from schedule
       fc::logger&             _logger;
-
    };
 
 } // namespace eosio::hotstuff

libraries/libfc/include/fc/crypto/bls_public_key.hpp

@@ -60,9 +60,9 @@ namespace fc { namespace crypto { namespace blslib {
 
 
          friend std::ostream& operator<< (std::ostream& s, const bls_public_key& k);
-         //friend bool operator == ( const bls_public_key& p1, const bls_public_key& p2);
-         //friend bool operator != ( const bls_public_key& p1, const bls_public_key& p2);
-         //friend bool operator < ( const bls_public_key& p1, const bls_public_key& p2);
+      friend bool operator == ( const bls_public_key& p1, const bls_public_key& p2) { return p1._pkey.equal(p2._pkey); }
+      friend bool operator != ( const bls_public_key& p1, const bls_public_key& p2) { return !p1._pkey.equal(p2._pkey);  }
+      friend bool operator < ( const bls_public_key& p1, const bls_public_key& p2) { return p1._pkey.affine().x.cmp(p2._pkey.affine().x) < 0; }
          friend struct reflector<bls_public_key>;
          friend class bls_private_key;
    }; // bls_public_key