pbft_block.hpp

Go to the documentation of this file.

#pragma once
 
#include <libdevcore/Common.h>
#include <libdevcore/RLP.h>
#include <libdevcore/SHA3.h>
#include <libdevcrypto/Common.h>
 
#include "common/encoding_rlp.hpp"
#include "common/types.hpp"
#include "pbft_block_extra_data.hpp"
 
namespace taraxa {
 
class PbftBlock {
 public:
  PbftBlock() = default;
  PbftBlock(const blk_hash_t& prev_blk_hash, const blk_hash_t& dag_blk_hash_as_pivot, const blk_hash_t& order_hash,
            const blk_hash_t& final_chain_hash, PbftPeriod period, const addr_t& beneficiary, const secret_t& sk,
            std::vector<vote_hash_t>&& reward_votes, const std::optional<PbftBlockExtraData>& extra_data = {});
  explicit PbftBlock(const dev::RLP& rlp);
  explicit PbftBlock(const bytes& RLP);
 
  blk_hash_t sha3(bool include_sig) const;
 
  std::string getJsonStr() const;
 
  Json::Value getJson() const;
 
  void streamRLP(dev::RLPStream& strm, bool include_sig) const;
 
  bytes rlp(bool include_sig) const;
 
  static Json::Value toJson(const PbftBlock& b, const std::vector<blk_hash_t>& dag_blks);
 
  const auto& getBlockHash() const { return block_hash_; }
 
  const auto& getPrevBlockHash() const { return prev_block_hash_; }
 
  const auto& getPivotDagBlockHash() const { return dag_block_hash_as_pivot_; }
 
  const auto& getOrderHash() const { return order_hash_; }
 
  const auto& getFinalChainHash() const { return final_chain_hash_; }
 
  PbftPeriod getPeriod() const { return period_; }
 
  auto getTimestamp() const { return timestamp_; }
 
  auto getExtraData() const { return extra_data_; }
 
  auto getExtraDataRlp() const { return extra_data_.has_value() ? extra_data_->rlp() : bytes(); }
 
  const auto& getBeneficiary() const { return beneficiary_; }
 
  const auto& getRewardVotes() const { return reward_votes_; }
 
  HAS_RLP_FIELDS
 
 private:
  void calculateHash_();
 
  void checkUniqueRewardVotes();
 
 private:
  blk_hash_t block_hash_;
  blk_hash_t prev_block_hash_;
  blk_hash_t dag_block_hash_as_pivot_;
  blk_hash_t order_hash_;
  blk_hash_t final_chain_hash_;
  PbftPeriod period_;  // Block index, PBFT head block is period 0, first PBFT block is period 1
  uint64_t timestamp_;
  addr_t beneficiary_;
  sig_t signature_;
  std::vector<vote_hash_t> reward_votes_;  // Cert votes in previous period
  std::optional<PbftBlockExtraData> extra_data_;
};
std::ostream& operator<<(std::ostream& strm, const PbftBlock& pbft_blk);
 
}  // namespace taraxa