pbft_vote.hpp

Go to the documentation of this file.

#pragma once
 
#include <json/value.h>
 
#include "common/encoding_rlp.hpp"
#include "common/vrf_wrapper.hpp"
#include "vote.hpp"
#include "vrf_sortition.hpp"
 
namespace taraxa {
 
class PbftVote : public Vote {
 public:
  using vrf_pk_t = vrf_wrapper::vrf_pk_t;
  PbftVote() = default;
  PbftVote(secret_t const& node_sk, VrfPbftSortition vrf_sortition, blk_hash_t const& block_hash);
 
  // Ctor for optimized rlp vote objects - only signature and vrf proof are in the rlp
  explicit PbftVote(const blk_hash_t& block_hash, PbftPeriod period, PbftRound round, PbftStep step,
                    dev::RLP const& rlp);
 
  // Ctors for full rlp vote objects - all data are encoded in the rlp
  explicit PbftVote(dev::RLP const& rlp);
  explicit PbftVote(bytes const& rlp);
 
  bool operator==(const PbftVote& other) const;
 
  bool verifyVrfSortition(const vrf_pk_t& pk, bool strict) const;
 
  const VrfPbftSortition& getVrfSortition() const;
 
  const vrf_wrapper::vrf_proof_t& getSortitionProof() const;
 
  const vrf_wrapper::vrf_output_t& getCredential() const;
 
  PbftVoteTypes getType() const;
 
  PbftPeriod getPeriod() const;
 
  PbftRound getRound() const;
 
  PbftStep getStep() const;
 
  bytes rlp(bool inc_sig = true, bool inc_weight = false) const;
 
  bytes optimizedRlp() const;
 
  uint64_t calculateWeight(uint64_t stake, double dpos_total_votes_count, double threshold) const;
 
  std::optional<uint64_t> getWeight() const;
 
  friend std::ostream& operator<<(std::ostream& strm, PbftVote const& vote) {
    strm << "[Vote] " << std::endl;
    strm << "  vote_hash: " << vote.vote_hash_ << std::endl;
    strm << "  voter: " << vote.getVoter() << std::endl;
    strm << "  vote_signature: " << vote.vote_signature_ << std::endl;
    strm << "  blockhash: " << vote.block_hash_ << std::endl;
    if (vote.weight_) strm << "  weight: " << vote.weight_.value() << std::endl;
    strm << "  vrf_sortition: " << vote.vrf_sortition_ << std::endl;
    return strm;
  }
 
  Json::Value toJSON() const;
 
  HAS_RLP_FIELDS
 
 private:
  vote_hash_t sha3(bool inc_sig) const override;
 
  VrfPbftSortition vrf_sortition_;
  mutable std::optional<uint64_t> weight_;
};
 
}  // namespace taraxa