Vote

Namespaces
namespace	taraxa::network
namespace	taraxa::network::tarcap

Classes
class	taraxa::VoteManager
	VoteManager class manage votes for PBFT consensus. More...
class	taraxa::PbftVote
	PbftVote class is a vote class that includes vote hash, vote on PBFT block hash, vote signature, VRF sortition, voter public key, voter address, and vote weight. More...
class	taraxa::PillarVote
	PillarVote class. More...
class	taraxa::Vote
	Vote class is a vote class that includes vote hash, vote on PBFT block hash, vote signature, VRF sortition, voter public key, voter address, and vote weight. More...
struct	taraxa::OptimizedPbftVotesBundle
struct	taraxa::OptimizedPillarVotesBundle
class	taraxa::VrfPbftMsg
	VrfPbftMsg class uses PBFT period, round and step to generate a message for doing VRF sortition. More...
class	taraxa::VrfPbftSortition
	VrfPbftSortition class used for doing VRF sortition to place a vote or to propose a new PBFT block. More...

Enumerations
enum class	taraxa::PbftVoteTypes : uint8_t {   taraxa::PbftVoteTypes::invalid_vote = 0 , taraxa::PbftVoteTypes::propose_vote , taraxa::PbftVoteTypes::soft_vote , taraxa::PbftVoteTypes::cert_vote ,   taraxa::PbftVoteTypes::next_vote }

Functions
dev::bytes	taraxa::encodePbftVotesBundleRlp (const std::vector< std::shared_ptr< PbftVote > > &votes)
	Encodes pbft votes into optimized votes bundle rlp.
std::vector< std::shared_ptr< PbftVote > >	taraxa::decodePbftVotesBundleRlp (const dev::RLP &votes_bundle_rlp)
	Decodes pbft votes from optimized votes bundle rlp.
dev::bytes	taraxa::encodePillarVotesBundleRlp (const std::vector< std::shared_ptr< PillarVote > > &votes)
	Encodes pillar votes into optimized votes bundle rlp.
std::vector< std::shared_ptr< PillarVote > >	taraxa::decodePillarVotesBundleRlp (const dev::RLP &votes_bundle_rlp)
	Decodes pillar votes from optimized votes bundle rlp.
dev::h256	taraxa::getVoterIndexHash (const vrf_wrapper::vrf_output_t &vrf, const public_t &address, uint64_t index=0)
	Get a hash number of combining VRF output, voter address, and vote weight index.

Variables
static constexpr size_t	taraxa::kPbftVotesBundleRlpSize {5}
static constexpr size_t	taraxa::kPillarVotesBundleRlpSize {3}

Detailed Description

---

Class Documentation

taraxa::VoteManager

class taraxa::VoteManager

VoteManager class manage votes for PBFT consensus.

Collaboration diagram for taraxa::VoteManager:

Public Member Functions
	VoteManager (const FullNodeConfig &config, std::shared_ptr< DbStorage > db, std::shared_ptr< PbftChain > pbft_chain, std::shared_ptr< final_chain::FinalChain > final_chain, std::shared_ptr< KeyManager > key_manager, std::shared_ptr< SlashingManager > slashing_manager)
	~VoteManager ()=default
	VoteManager (const VoteManager &)=delete
	VoteManager (VoteManager &&)=delete
VoteManager &	operator= (const VoteManager &)=delete
VoteManager &	operator= (VoteManager &&)=delete
void	setNetwork (std::weak_ptr< Network > network)
	Set network as a weak pointer.
bool	addVerifiedVote (const std::shared_ptr< PbftVote > &vote)
	Add a vote to the verified votes map.
bool	voteInVerifiedMap (std::shared_ptr< PbftVote > const &vote) const
	Check if the vote has been in the verified votes map.
std::pair< bool, std::shared_ptr< PbftVote > >	isUniqueVote (const std::shared_ptr< PbftVote > &vote) const
std::vector< std::shared_ptr< PbftVote > >	getVerifiedVotes () const
	Get all verified votes.
uint64_t	getVerifiedVotesSize () const
	Get the total size of all verified votes.
void	cleanupVotesByPeriod (PbftPeriod pbft_period)
	Cleanup votes for specified PBFT period.
std::vector< std::shared_ptr< PbftVote > >	getProposalVotes (PbftPeriod period, PbftRound round) const
	Get all verified votes in proposal vote type for the current PBFT round.
std::optional< PbftRound >	determineNewRound (PbftPeriod current_pbft_period, PbftRound current_pbft_round)
	Check if there are enough next voting type votes to set PBFT to a forward round within period.
void	resetRewardVotes (PbftPeriod period, PbftRound round, PbftStep step, const blk_hash_t &block_hash, Batch &batch)
	Replace current reward votes with new period, round & block hash based on vote.
std::pair< bool, std::vector< std::shared_ptr< PbftVote > > >	checkRewardVotes (const std::shared_ptr< PbftBlock > &pbft_block, bool copy_votes)
	Check reward votes for specified pbft block.
std::vector< std::shared_ptr< PbftVote > >	getRewardVotes ()
	Get reward votes with the round during which was the previous block pushed.
PbftPeriod	getRewardVotesPbftBlockPeriod ()
	Get current reward votes pbft block period.
void	saveOwnVerifiedVote (const std::shared_ptr< PbftVote > &vote)
	Saves own verified vote into memory and db.
std::vector< std::shared_ptr< PbftVote > >	getOwnVerifiedVotes ()
void	clearOwnVerifiedVotes (Batch &write_batch)
	Clear own verified votes.
std::shared_ptr< PbftVote >	generateVoteWithWeight (const blk_hash_t &blockhash, PbftVoteTypes vote_type, PbftPeriod period, PbftRound round, PbftStep step, const WalletConfig &wallet)
	Place a vote, save it in the verified votes queue, and gossip to peers.
std::shared_ptr< PbftVote >	generateVote (const blk_hash_t &blockhash, PbftVoteTypes type, PbftPeriod period, PbftRound round, PbftStep step, const WalletConfig &wallet)
	Generate a vote.
std::pair< bool, std::string >	validateVote (const std::shared_ptr< PbftVote > &vote, bool strict=true) const
	Validates vote.
std::optional< uint64_t >	getPbftTwoTPlusOne (PbftPeriod pbft_period, PbftVoteTypes vote_type) const
	Get 2t+1. 2t+1 is 2/3 of PBFT sortition threshold and plus 1 for a specific period.
bool	voteAlreadyValidated (const vote_hash_t &vote_hash) const
bool	genAndValidateVrfSortition (PbftPeriod pbft_period, PbftRound pbft_round, const WalletConfig &wallet) const
	Generates vrf sortition and calculates its weight.
std::optional< blk_hash_t >	getTwoTPlusOneVotedBlock (PbftPeriod period, PbftRound round, TwoTPlusOneVotedBlockType type) const
	Get 2t+1 voted block for specific period, round and type, e.g. soft/cert/next voted block.
std::vector< std::shared_ptr< PbftVote > >	getTwoTPlusOneVotedBlockVotes (PbftPeriod period, PbftRound round, TwoTPlusOneVotedBlockType type) const
StepVotes	getStepVotes (PbftPeriod period, PbftRound round, PbftStep step) const
void	setCurrentPbftPeriodAndRound (PbftPeriod pbft_period, PbftRound pbft_round)
	Sets current pbft period & round. It also checks if we dont already have 2t+1 vote bundles(pf any type) for the provided period & round and if so, it saves these bundles into db.
PbftStep	getNetworkTplusOneNextVotingStep (PbftPeriod period, PbftRound round) const
	Returns greatest step (in specified period & round), for which there is at least t+1 voting power from all nodes.
Private Member Functions
bool	isValidRewardVote (const std::shared_ptr< PbftVote > &vote) const
uint64_t	getPbftSortitionThreshold (uint64_t total_dpos_votes_count, PbftVoteTypes vote_type) const
	Get PBFT sortition threshold for specific period.
Private Attributes
const PbftConfig &	kPbftConfig
std::shared_ptr< DbStorage >	db_
std::shared_ptr< PbftChain >	pbft_chain_
std::shared_ptr< final_chain::FinalChain >	final_chain_
std::shared_ptr< KeyManager >	key_manager_
std::weak_ptr< Network >	network_
std::shared_ptr< SlashingManager >	slashing_manager_
std::atomic< PbftPeriod >	current_pbft_period_ {0}
std::atomic< PbftRound >	current_pbft_round_ {0}
VerifiedVotes	verified_votes_
blk_hash_t	reward_votes_block_hash_
PbftRound	reward_votes_period_
PbftRound	reward_votes_round_
std::vector< vote_hash_t >	extra_reward_votes_
std::shared_mutex	reward_votes_info_mutex_
std::vector< std::shared_ptr< PbftVote > >	own_verified_votes_
std::unordered_map< PbftVoteTypes, std::pair< PbftPeriod, uint64_t > >	current_two_t_plus_one_
std::shared_mutex	current_two_t_plus_one_mutex_
ExpirationCache< vote_hash_t >	already_validated_votes_

Constructor & Destructor Documentation

VoteManager() [1/3]

taraxa::VoteManager::VoteManager	(	const FullNodeConfig &	config,
		std::shared_ptr< DbStorage >	db,
		std::shared_ptr< PbftChain >	pbft_chain,
		std::shared_ptr< final_chain::FinalChain >	final_chain,
		std::shared_ptr< KeyManager >	key_manager,
		std::shared_ptr< SlashingManager >	slashing_manager
	)

~VoteManager()

taraxa::VoteManager::~VoteManager ( )

default

VoteManager() [2/3]

taraxa::VoteManager::VoteManager ( const VoteManager &  )

delete

VoteManager() [3/3]

taraxa::VoteManager::VoteManager ( VoteManager &&  )

delete

Member Function Documentation

addVerifiedVote()

bool taraxa::VoteManager::addVerifiedVote

(

const std::shared_ptr< PbftVote > &

vote

)

Add a vote to the verified votes map.

Parameters

vote

vote

Returns

true if vote was successfully added, otherwise false

checkRewardVotes()

std::pair< bool, std::vector< std::shared_ptr< PbftVote > > > taraxa::VoteManager::checkRewardVotes	(	const std::shared_ptr< PbftBlock > &	pbft_block,
		bool	copy_votes
	)

Check reward votes for specified pbft block.

Parameters

pbft_block
copy_votes	- if set to true, votes are copied and returned, otherwise votes are just checked if present

Returns

<true, votes> - votes are empty in case copy_votes is set to false

cleanupVotesByPeriod()

void taraxa::VoteManager::cleanupVotesByPeriod

(

PbftPeriod

pbft_period

)

Cleanup votes for specified PBFT period.

Parameters

pbft_period

current PBFT period

clearOwnVerifiedVotes()

void taraxa::VoteManager::clearOwnVerifiedVotes

(

Batch &

write_batch

)

Clear own verified votes.

Parameters

write_batch

determineNewRound()

std::optional< PbftRound > taraxa::VoteManager::determineNewRound	(	PbftPeriod	current_pbft_period,
		PbftRound	current_pbft_round
	)

Check if there are enough next voting type votes to set PBFT to a forward round within period.

Parameters

current_pbft_period	current pbft period
current_pbft_round	current pbft round

Returns

optional<new round> if there is enough next votes from prior round, otherwise returns empty optional

genAndValidateVrfSortition()

bool taraxa::VoteManager::genAndValidateVrfSortition	(	PbftPeriod	pbft_period,
		PbftRound	pbft_round,
		const WalletConfig &	wallet
	)		const

Generates vrf sortition and calculates its weight.

Parameters

wallet

Returns

true if sortition weight > 0, otherwise false

generateVote()

std::shared_ptr< PbftVote > taraxa::VoteManager::generateVote	(	const blk_hash_t &	blockhash,
		PbftVoteTypes	type,
		PbftPeriod	period,
		PbftRound	round,
		PbftStep	step,
		const WalletConfig &	wallet
	)

Generate a vote.

Parameters

blockhash	vote on PBFT block hash
type	vote type
period	PBFT period
round	PBFT round
step	PBFT step
wallet

Returns

vote

generateVoteWithWeight()

std::shared_ptr< PbftVote > taraxa::VoteManager::generateVoteWithWeight	(	const blk_hash_t &	blockhash,
		PbftVoteTypes	vote_type,
		PbftPeriod	period,
		PbftRound	round,
		PbftStep	step,
		const WalletConfig &	wallet
	)

Place a vote, save it in the verified votes queue, and gossip to peers.

Parameters

blockhash	vote on PBFT block hash
vote_type	vote type
period	PBFT period
round	PBFT round
step	PBFT step
step	PBFT step
wallet

getNetworkTplusOneNextVotingStep()

PbftStep taraxa::VoteManager::getNetworkTplusOneNextVotingStep	(	PbftPeriod	period,
		PbftRound	round
	)		const

Returns greatest step (in specified period & round), for which there is at least t+1 voting power from all nodes.

Note

It is used for triggering lambda exponential backoff

Parameters

period
round

Returns

greatest network 2t+1 next voting step

getOwnVerifiedVotes()

std::vector< std::shared_ptr< PbftVote > > taraxa::VoteManager::getOwnVerifiedVotes

(

)

Returns

all own verified votes

getPbftSortitionThreshold()

uint64_t taraxa::VoteManager::getPbftSortitionThreshold ( uint64_t  total_dpos_votes_count, PbftVoteTypes  vote_type  ) const

private

Get PBFT sortition threshold for specific period.

Parameters

total_dpos_votes_count	total votes count
vote_type	vote type

Returns

PBFT sortition threshold

getPbftTwoTPlusOne()

std::optional< uint64_t > taraxa::VoteManager::getPbftTwoTPlusOne	(	PbftPeriod	pbft_period,
		PbftVoteTypes	vote_type
	)		const

Get 2t+1. 2t+1 is 2/3 of PBFT sortition threshold and plus 1 for a specific period.

Parameters

pbft_period	pbft period
vote_type	vote type, for which we get 2t+1

Returns

PBFT 2T + 1 if successful, otherwise (due to non-existent data for pbft_period) empty optional

getProposalVotes()

std::vector< std::shared_ptr< PbftVote > > taraxa::VoteManager::getProposalVotes	(	PbftPeriod	period,
		PbftRound	round
	)		const

Get all verified votes in proposal vote type for the current PBFT round.

Parameters

period	new PBFT period (period == chain_size + 1)
round	current PBFT round

Returns

all verified votes in proposal vote type for the current PBFT round

getRewardVotes()

std::vector< std::shared_ptr< PbftVote > > taraxa::VoteManager::getRewardVotes

(

)

Get reward votes with the round during which was the previous block pushed.

Returns

vector of reward votes

getRewardVotesPbftBlockPeriod()

PbftPeriod taraxa::VoteManager::getRewardVotesPbftBlockPeriod

(

)

Get current reward votes pbft block period.

Returns

period

getStepVotes()

StepVotes taraxa::VoteManager::getStepVotes	(	PbftPeriod	period,
		PbftRound	round,
		PbftStep	step
	)		const

Get all step votes for specific period, round and step

Parameters

period
round
step

Returns

getTwoTPlusOneVotedBlock()

std::optional< blk_hash_t > taraxa::VoteManager::getTwoTPlusOneVotedBlock	(	PbftPeriod	period,
		PbftRound	round,
		TwoTPlusOneVotedBlockType	type
	)		const

Get 2t+1 voted block for specific period, round and type, e.g. soft/cert/next voted block.

Parameters

period
round
votes_type

Returns

empty optional if no 2t+1 voted block was found, otherwise initialized optional with block hash

getTwoTPlusOneVotedBlockVotes()

std::vector< std::shared_ptr< PbftVote > > taraxa::VoteManager::getTwoTPlusOneVotedBlockVotes	(	PbftPeriod	period,
		PbftRound	round,
		TwoTPlusOneVotedBlockType	type
	)		const

Get 2t+1 voted block votes for specific period, round and type, e.g. soft/cert/next voted block

Parameters

period
round
type

Returns

vector of votes if 2t+1 voted block votes found, otherwise empty vector

getVerifiedVotes()

std::vector< std::shared_ptr< PbftVote > > taraxa::VoteManager::getVerifiedVotes

(

)

const

Get all verified votes.

Returns

all verified votes

getVerifiedVotesSize()

uint64_t taraxa::VoteManager::getVerifiedVotesSize

(

)

const

Get the total size of all verified votes.

Returns

the total size of all verified votes

isUniqueVote()

std::pair< bool, std::shared_ptr< PbftVote > > taraxa::VoteManager::isUniqueVote

(

const std::shared_ptr< PbftVote > &

vote

)

const

Parameters

vote

Returns

<true, nullptr> if vote is unique per round & step & voter, otherwise <false, existing vote>

isValidRewardVote()

bool taraxa::VoteManager::isValidRewardVote ( const std::shared_ptr< PbftVote > &  vote ) const

private

Parameters

vote

Returns

true if vote is valid potential reward vote

operator=() [1/2]

VoteManager & taraxa::VoteManager::operator= ( const VoteManager &  )

delete

operator=() [2/2]

VoteManager & taraxa::VoteManager::operator= ( VoteManager &&  )

delete

resetRewardVotes()

void taraxa::VoteManager::resetRewardVotes	(	PbftPeriod	period,
		PbftRound	round,
		PbftStep	step,
		const blk_hash_t &	block_hash,
		Batch &	batch
	)

Replace current reward votes with new period, round & block hash based on vote.

Parameters

period
round
step
block_hash
batch

saveOwnVerifiedVote()

void taraxa::VoteManager::saveOwnVerifiedVote

(

const std::shared_ptr< PbftVote > &

vote

)

Saves own verified vote into memory and db.

Parameters

vote

setCurrentPbftPeriodAndRound()

void taraxa::VoteManager::setCurrentPbftPeriodAndRound	(	PbftPeriod	pbft_period,
		PbftRound	pbft_round
	)

Sets current pbft period & round. It also checks if we dont already have 2t+1 vote bundles(pf any type) for the provided period & round and if so, it saves these bundles into db.

Parameters

pbft_period
pbft_round

setNetwork()

void taraxa::VoteManager::setNetwork

(

std::weak_ptr< Network >

network

)

Set network as a weak pointer.

Parameters

network

a weak pointer

validateVote()

std::pair< bool, std::string > taraxa::VoteManager::validateVote	(	const std::shared_ptr< PbftVote > &	vote,
		bool	strict = true
	)		const

Validates vote.

Parameters

vote	to be validated
strict	strict validation

Returns

<true, ""> vote validation passed, otherwise <false, "err msg">

voteAlreadyValidated()

bool taraxa::VoteManager::voteAlreadyValidated

(

const vote_hash_t &

vote_hash

)

const

Parameters

vote_hash

Returns

true if vote_hash was already validated, otherwise false

voteInVerifiedMap()

bool taraxa::VoteManager::voteInVerifiedMap

(

std::shared_ptr< PbftVote > const &

vote

)

const

Check if the vote has been in the verified votes map.

Parameters

vote

vote

Returns

true if exist

Member Data Documentation

already_validated_votes_

ExpirationCache<vote_hash_t> taraxa::VoteManager::already_validated_votes_

mutableprivate

current_pbft_period_

std::atomic<PbftPeriod> taraxa::VoteManager::current_pbft_period_ {0}

private

current_pbft_round_

std::atomic<PbftRound> taraxa::VoteManager::current_pbft_round_ {0}

private

current_two_t_plus_one_

std::unordered_map<PbftVoteTypes, std::pair<PbftPeriod, uint64_t> > taraxa::VoteManager::current_two_t_plus_one_

mutableprivate

current_two_t_plus_one_mutex_

std::shared_mutex taraxa::VoteManager::current_two_t_plus_one_mutex_

mutableprivate

db_

std::shared_ptr<DbStorage> taraxa::VoteManager::db_

private

extra_reward_votes_

std::vector<vote_hash_t> taraxa::VoteManager::extra_reward_votes_

private

final_chain_

std::shared_ptr<final_chain::FinalChain> taraxa::VoteManager::final_chain_

private

key_manager_

std::shared_ptr<KeyManager> taraxa::VoteManager::key_manager_

private

kPbftConfig

const PbftConfig& taraxa::VoteManager::kPbftConfig

private

network_

std::weak_ptr<Network> taraxa::VoteManager::network_

private

own_verified_votes_

std::vector<std::shared_ptr<PbftVote> > taraxa::VoteManager::own_verified_votes_

private

pbft_chain_

std::shared_ptr<PbftChain> taraxa::VoteManager::pbft_chain_

private

reward_votes_block_hash_

blk_hash_t taraxa::VoteManager::reward_votes_block_hash_

private

reward_votes_info_mutex_

std::shared_mutex taraxa::VoteManager::reward_votes_info_mutex_

mutableprivate

reward_votes_period_

PbftRound taraxa::VoteManager::reward_votes_period_

private

reward_votes_round_

PbftRound taraxa::VoteManager::reward_votes_round_

private

slashing_manager_

std::shared_ptr<SlashingManager> taraxa::VoteManager::slashing_manager_

private

verified_votes_

VerifiedVotes taraxa::VoteManager::verified_votes_

private

taraxa::PbftVote

class taraxa::PbftVote

PbftVote class is a vote class that includes vote hash, vote on PBFT block hash, vote signature, VRF sortition, voter public key, voter address, and vote weight.

Collaboration diagram for taraxa::PbftVote:

Public Types
using	vrf_pk_t = vrf_wrapper::vrf_pk_t
Public Member Functions
	PbftVote ()=default
	PbftVote (secret_t const &node_sk, VrfPbftSortition vrf_sortition, blk_hash_t const &block_hash)
	PbftVote (const blk_hash_t &block_hash, PbftPeriod period, PbftRound round, PbftStep step, dev::RLP const &rlp)
	PbftVote (dev::RLP const &rlp)
	PbftVote (bytes const &rlp)
bool	operator== (const PbftVote &other) const
bool	verifyVrfSortition (const vrf_pk_t &pk, bool strict) const
	Verify VRF sortition.
const VrfPbftSortition &	getVrfSortition () const
	Get VRF sortition.
const vrf_wrapper::vrf_proof_t &	getSortitionProof () const
	Get VRF sortition proof.
const vrf_wrapper::vrf_output_t &	getCredential () const
	Get VRF sortition output.
PbftVoteTypes	getType () const
	Get vote type.
PbftPeriod	getPeriod () const
	Get vote PBFT period.
PbftRound	getRound () const
	Get vote PBFT round.
PbftStep	getStep () const
	Get vote PBFT step.
bytes	rlp (bool inc_sig=true, bool inc_weight=false) const
	Recursive Length Prefix.
bytes	optimizedRlp () const
	Optimized Recursive Length Prefix.
uint64_t	calculateWeight (uint64_t stake, double dpos_total_votes_count, double threshold) const
	Calculate vote weight.
std::optional< uint64_t >	getWeight () const
	Get vote weight.
Json::Value	toJSON () const
	Get vote in JSON representation.
Public Member Functions inherited from taraxa::Vote
	Vote ()=default
	Vote (const blk_hash_t &block_hash)
virtual	~Vote ()=default
void	signVote (const secret_t &node_sk)
	Sign the vote.
const vote_hash_t &	getHash () const
	Get vote hash.
const public_t &	getVoter () const
	Get voter public key.
const addr_t &	getVoterAddr () const
	Get voter address.
const sig_t &	getVoteSignature () const
	Get vote signature.
const blk_hash_t &	getBlockHash () const
	Get PBFT block hash that votes on.
bool	verifyVote () const
	Verify vote.
Private Member Functions
vote_hash_t	sha3 (bool inc_sig) const override
	Secure Hash Algorithm 3.
Private Attributes
VrfPbftSortition	vrf_sortition_
std::optional< uint64_t >	weight_
Friends
std::ostream &	operator<< (std::ostream &strm, PbftVote const &vote)

Additional Inherited Members
Protected Attributes inherited from taraxa::Vote
blk_hash_t	block_hash_
sig_t	vote_signature_
vote_hash_t	vote_hash_
public_t	cached_voter_
addr_t	cached_voter_addr_

Member Typedef Documentation

vrf_pk_t

using taraxa::PbftVote::vrf_pk_t = vrf_wrapper::vrf_pk_t

Constructor & Destructor Documentation

PbftVote() [1/5]

taraxa::PbftVote::PbftVote ( )

default

PbftVote() [2/5]

taraxa::PbftVote::PbftVote	(	secret_t const &	node_sk,
		VrfPbftSortition	vrf_sortition,
		blk_hash_t const &	block_hash
	)

PbftVote() [3/5]

taraxa::PbftVote::PbftVote ( const blk_hash_t &  block_hash, PbftPeriod  period, PbftRound  round, PbftStep  step, dev::RLP const &  rlp  )

explicit

PbftVote() [4/5]

taraxa::PbftVote::PbftVote ( dev::RLP const &  rlp )

explicit

PbftVote() [5/5]

taraxa::PbftVote::PbftVote ( bytes const &  rlp )

explicit

Member Function Documentation

calculateWeight()

uint64_t taraxa::PbftVote::calculateWeight	(	uint64_t	stake,
		double	dpos_total_votes_count,
		double	threshold
	)		const

Calculate vote weight.

Parameters

stake	voter DPOS eligible votes count
dpos_total_votes_count	total DPOS votes count
threshold	PBFT sortition threshold that is minimum of between PBFT committee size and total DPOS votes count

Returns

vote weight

getCredential()

const vrf_wrapper::vrf_output_t & taraxa::PbftVote::getCredential

(

)

const

Get VRF sortition output.

Returns

VRF sortition output

getPeriod()

PbftPeriod taraxa::PbftVote::getPeriod

(

)

const

Get vote PBFT period.

Returns

vote PBFT period

getRound()

PbftRound taraxa::PbftVote::getRound

(

)

const

Get vote PBFT round.

Returns

vote PBFT round

getSortitionProof()

const vrf_wrapper::vrf_proof_t & taraxa::PbftVote::getSortitionProof

(

)

const

Get VRF sortition proof.

Returns

VRF sortition proof

getStep()

PbftStep taraxa::PbftVote::getStep

(

)

const

Get vote PBFT step.

Returns

vote PBFT step

getType()

PbftVoteTypes taraxa::PbftVote::getType

(

)

const

Get vote type.

Returns

vote type

getVrfSortition()

const VrfPbftSortition & taraxa::PbftVote::getVrfSortition

(

)

const

Get VRF sortition.

Returns

VRF sortition

getWeight()

std::optional< uint64_t > taraxa::PbftVote::getWeight

(

)

const

Get vote weight.

Returns

vote weight

operator==()

bool taraxa::PbftVote::operator==

(

const PbftVote &

other

)

const

optimizedRlp()

bytes taraxa::PbftVote::optimizedRlp

(

)

const

Optimized Recursive Length Prefix.

Note

Encode only vote's signature and vrf proof into the rlp

Returns

bytes of RLP stream

rlp()

void taraxa::PbftVote::rlp	(	bool	inc_sig = true,
		bool	inc_weight = false
	)		const

Recursive Length Prefix.

Parameters

inc_sig	if include vote signature
inc_weight	if include vote weight

Returns

bytes of RLP stream

sha3()

vote_hash_t taraxa::PbftVote::sha3 ( bool  inc_sig ) const

overrideprivatevirtual

Secure Hash Algorithm 3.

Parameters

inc_sig

if include vote signature

Returns

secure hash as vote hash

Implements taraxa::Vote.

toJSON()

Json::Value taraxa::PbftVote::toJSON

(

)

const

Get vote in JSON representation.

Returns

vote JSON

verifyVrfSortition()

bool taraxa::PbftVote::verifyVrfSortition	(	const vrf_pk_t &	pk,
		bool	strict
	)		const

Verify VRF sortition.

Returns

true if passed

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  strm, PbftVote const &  vote  )

friend

Member Data Documentation

vrf_sortition_

VrfPbftSortition taraxa::PbftVote::vrf_sortition_

private

weight_

std::optional<uint64_t> taraxa::PbftVote::weight_

mutableprivate

taraxa::PillarVote

class taraxa::PillarVote

PillarVote class.

Collaboration diagram for taraxa::PillarVote:

Public Member Functions
	PillarVote ()=default
	PillarVote (const secret_t &node_sk, PbftPeriod period, const blk_hash_t &block_hash)
	PillarVote (PbftPeriod period, const blk_hash_t &block_hash, sig_t &&signature)
	PillarVote (const dev::RLP &rlp)
	PillarVote (const bytes &rlp)
PbftPeriod	getPeriod () const
bytes	rlp () const
	Recursive Length Prefix.
bytes	encodeSolidity (bool inc_sig=true) const
Public Member Functions inherited from taraxa::Vote
	Vote ()=default
	Vote (const blk_hash_t &block_hash)
virtual	~Vote ()=default
void	signVote (const secret_t &node_sk)
	Sign the vote.
const vote_hash_t &	getHash () const
	Get vote hash.
const public_t &	getVoter () const
	Get voter public key.
const addr_t &	getVoterAddr () const
	Get voter address.
const sig_t &	getVoteSignature () const
	Get vote signature.
const blk_hash_t &	getBlockHash () const
	Get PBFT block hash that votes on.
bool	verifyVote () const
	Verify vote.
Static Public Member Functions
static PillarVote	decodeSolidity (const bytes &enc)
	Decodes solidity encoded representation of pillar vote.
Static Public Attributes
static constexpr size_t	kNoSigRlpSize {2}
static constexpr size_t	kStandardRlpSize {3}
Private Member Functions
vote_hash_t	sha3 (bool inc_sig) const override
	Secure Hash Algorithm 3.
Private Attributes
PbftPeriod	period_

Additional Inherited Members
Protected Attributes inherited from taraxa::Vote
blk_hash_t	block_hash_
sig_t	vote_signature_
vote_hash_t	vote_hash_
public_t	cached_voter_
addr_t	cached_voter_addr_

Constructor & Destructor Documentation

PillarVote() [1/5]

taraxa::PillarVote::PillarVote ( )

default

PillarVote() [2/5]

taraxa::PillarVote::PillarVote	(	const secret_t &	node_sk,
		PbftPeriod	period,
		const blk_hash_t &	block_hash
	)

PillarVote() [3/5]

taraxa::PillarVote::PillarVote	(	PbftPeriod	period,
		const blk_hash_t &	block_hash,
		sig_t &&	signature
	)

PillarVote() [4/5]

taraxa::PillarVote::PillarVote ( const dev::RLP &  rlp )

explicit

PillarVote() [5/5]

taraxa::PillarVote::PillarVote ( const bytes &  rlp )

explicit

Member Function Documentation

decodeSolidity()

PillarVote taraxa::PillarVote::decodeSolidity ( const bytes &  enc )

static

Decodes solidity encoded representation of pillar vote.

Parameters

enc

Returns

PillarVote

encodeSolidity()

bytes taraxa::PillarVote::encodeSolidity

(

bool

inc_sig = true

)

const

Note

Solidity encoding is used for data that are sent to smart contracts

Returns

solidity encoded representation of pillar vote

getPeriod()

PbftPeriod taraxa::PillarVote::getPeriod

(

)

const

Returns

vote pbft period

rlp()

bytes taraxa::PillarVote::rlp

(

)

const

Recursive Length Prefix.

Returns

bytes of RLP stream

sha3()

vote_hash_t taraxa::PillarVote::sha3 ( bool  inc_sig ) const

overrideprivatevirtual

Secure Hash Algorithm 3.

Parameters

inc_sig

if include vote signature

Returns

secure hash as vote hash

Implements taraxa::Vote.

Member Data Documentation

kNoSigRlpSize

constexpr size_t taraxa::PillarVote::kNoSigRlpSize {2}

staticconstexpr

kStandardRlpSize

constexpr size_t taraxa::PillarVote::kStandardRlpSize {3}

staticconstexpr

period_

PbftPeriod taraxa::PillarVote::period_

private

taraxa::Vote

class taraxa::Vote

Vote class is a vote class that includes vote hash, vote on PBFT block hash, vote signature, VRF sortition, voter public key, voter address, and vote weight.

Collaboration diagram for taraxa::Vote:

Public Member Functions
	Vote ()=default
	Vote (const blk_hash_t &block_hash)
virtual	~Vote ()=default
void	signVote (const secret_t &node_sk)
	Sign the vote.
const vote_hash_t &	getHash () const
	Get vote hash.
const public_t &	getVoter () const
	Get voter public key.
const addr_t &	getVoterAddr () const
	Get voter address.
const sig_t &	getVoteSignature () const
	Get vote signature.
const blk_hash_t &	getBlockHash () const
	Get PBFT block hash that votes on.
bool	verifyVote () const
	Verify vote.
virtual vote_hash_t	sha3 (bool inc_sig) const =0
	Secure Hash Algorithm 3.
Protected Attributes
blk_hash_t	block_hash_
sig_t	vote_signature_
vote_hash_t	vote_hash_
public_t	cached_voter_
addr_t	cached_voter_addr_

Constructor & Destructor Documentation

Vote() [1/2]

taraxa::Vote::Vote ( )

default

Vote() [2/2]

taraxa::Vote::Vote

(

const blk_hash_t &

block_hash

)

~Vote()

virtual taraxa::Vote::~Vote ( )

virtualdefault

Member Function Documentation

getBlockHash()

const blk_hash_t & taraxa::Vote::getBlockHash

(

)

const

Get PBFT block hash that votes on.

Returns

PBFT block hash

getHash()

const vote_hash_t & taraxa::Vote::getHash

(

)

const

Get vote hash.

Returns

vote hash

getVoter()

const public_t & taraxa::Vote::getVoter

(

)

const

Get voter public key.

Returns

voter public key

getVoterAddr()

const addr_t & taraxa::Vote::getVoterAddr

(

)

const

Get voter address.

Returns

voter address

getVoteSignature()

const sig_t & taraxa::Vote::getVoteSignature

(

)

const

Get vote signature.

Returns

vote signature

sha3()

virtual vote_hash_t taraxa::Vote::sha3 ( bool  inc_sig ) const

pure virtual

Secure Hash Algorithm 3.

Parameters

inc_sig

if include vote signature

Returns

secure hash as vote hash

Implemented in taraxa::PbftVote, and taraxa::PillarVote.

signVote()

void taraxa::Vote::signVote

(

const secret_t &

node_sk

)

Sign the vote.

Parameters

node_sk

verifyVote()

bool taraxa::Vote::verifyVote

(

)

const

Verify vote.

Returns

true if passed

Member Data Documentation

block_hash_

blk_hash_t taraxa::Vote::block_hash_

protected

cached_voter_

public_t taraxa::Vote::cached_voter_

mutableprotected

cached_voter_addr_

addr_t taraxa::Vote::cached_voter_addr_

mutableprotected

vote_hash_

vote_hash_t taraxa::Vote::vote_hash_

mutableprotected

vote_signature_

sig_t taraxa::Vote::vote_signature_

protected

taraxa::OptimizedPbftVotesBundle

struct taraxa::OptimizedPbftVotesBundle

Class Members
vector< shared_ptr< PbftVote > >	votes

taraxa::OptimizedPillarVotesBundle

struct taraxa::OptimizedPillarVotesBundle

Class Members
vector< shared_ptr< PillarVote > >	pillar_votes

taraxa::VrfPbftMsg

class taraxa::VrfPbftMsg

VrfPbftMsg class uses PBFT period, round and step to generate a message for doing VRF sortition.

Public Member Functions
	VrfPbftMsg ()=default
	VrfPbftMsg (PbftVoteTypes type, PbftPeriod period, PbftRound round, PbftStep step)
PbftVoteTypes	getType () const
	Get v type based on vote step.
std::string	toString () const
	Combine vote type, PBFT period, round and step to a string.
bytes	getRlpBytes () const
	Get bytes of RLP stream.
bool	operator== (VrfPbftMsg const &other) const
Public Attributes
PbftPeriod	period_
PbftRound	round_
PbftStep	step_
Friends
std::ostream &	operator<< (std::ostream &strm, VrfPbftMsg const &pbft_msg)

Constructor & Destructor Documentation

VrfPbftMsg() [1/2]

taraxa::VrfPbftMsg::VrfPbftMsg ( )

default

VrfPbftMsg() [2/2]

taraxa::VrfPbftMsg::VrfPbftMsg	(	PbftVoteTypes	type,
		PbftPeriod	period,
		PbftRound	round,
		PbftStep	step
	)

Member Function Documentation

getRlpBytes()

bytes taraxa::VrfPbftMsg::getRlpBytes

(

)

const

Get bytes of RLP stream.

Returns

bytes of RLP stream

getType()

PbftVoteTypes taraxa::VrfPbftMsg::getType

(

)

const

Get v type based on vote step.

Returns

PbftVoteTypes based on vote step

operator==()

bool taraxa::VrfPbftMsg::operator==

(

VrfPbftMsg const &

other

)

const

toString()

std::string taraxa::VrfPbftMsg::toString

(

)

const

Combine vote type, PBFT period, round and step to a string.

Returns

a string of vote type, PBFT period, round and step

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  strm, VrfPbftMsg const &  pbft_msg  )

friend

Member Data Documentation

period_

PbftPeriod taraxa::VrfPbftMsg::period_

round_

PbftRound taraxa::VrfPbftMsg::round_

step_

PbftStep taraxa::VrfPbftMsg::step_

taraxa::VrfPbftSortition

class taraxa::VrfPbftSortition

VrfPbftSortition class used for doing VRF sortition to place a vote or to propose a new PBFT block.

Collaboration diagram for taraxa::VrfPbftSortition:

Public Member Functions
	VrfPbftSortition ()=default
	VrfPbftSortition (vrf_sk_t const &sk, const VrfPbftMsg &pbft_msg)
	VrfPbftSortition (dev::bytes const &rlp)
dev::bytes	getRlpBytes () const
	Get bytes of RLP stream.
bool	verify (const vrf_pk_t &pk, bool strict=true) const
	Verify VRF sortition.
bool	operator== (VrfPbftSortition const &other) const
uint64_t	calculateWeight (uint64_t stake, uint64_t dpos_total_votes_count, uint64_t threshold, const public_t &address) const
	Calculate vote weight.
Public Member Functions inherited from taraxa::vrf_wrapper::VrfSortitionBase
	VrfSortitionBase ()=default
	VrfSortitionBase (vrf_sk_t const &sk, bytes const &msg, uint16_t vote_count=1)
bool	verify (const vrf_pk_t &pk, const bytes &msg, uint16_t vote_count=1, bool strict=true) const
bool	operator== (VrfSortitionBase const &other) const
virtual std::ostream &	print (std::ostream &strm) const
Static Public Member Functions
static uint64_t	getBinominalDistribution (uint64_t stake, double dpos_total_votes_count, double threshold, const uint256_t &hash)
	Calculate a vote weight in binominal distribution.
Static Public Member Functions inherited from taraxa::vrf_wrapper::VrfSortitionBase
static dev::bytes	makeVrfInput (taraxa::level_t level, const dev::h256 &period_hash)
Public Attributes
VrfPbftMsg	pbft_msg_
Public Attributes inherited from taraxa::vrf_wrapper::VrfSortitionBase
vrf_proof_t	proof_
vrf_output_t	output_
uint16_t	threshold_
Static Public Attributes
static uint256_t	max256bits = std::numeric_limits<uint256_t>::max()
static auto	kMax256bFP = max256bits.convert_to<boost::multiprecision::mpfr_float>()
Private Types
using	vrf_sk_t = vrf_wrapper::vrf_sk_t
using	vrf_pk_t = vrf_wrapper::vrf_pk_t
using	vrf_proof_t = vrf_wrapper::vrf_proof_t
using	vrf_output_t = vrf_wrapper::vrf_output_t
Friends
std::ostream &	operator<< (std::ostream &strm, const VrfPbftSortition &vrf_sortition)

Member Typedef Documentation

vrf_output_t

using taraxa::VrfPbftSortition::vrf_output_t = vrf_wrapper::vrf_output_t

private

vrf_pk_t

using taraxa::VrfPbftSortition::vrf_pk_t = vrf_wrapper::vrf_pk_t

private

vrf_proof_t

using taraxa::VrfPbftSortition::vrf_proof_t = vrf_wrapper::vrf_proof_t

private

vrf_sk_t

using taraxa::VrfPbftSortition::vrf_sk_t = vrf_wrapper::vrf_sk_t

private

Constructor & Destructor Documentation

VrfPbftSortition() [1/3]

taraxa::VrfPbftSortition::VrfPbftSortition ( )

default

VrfPbftSortition() [2/3]

taraxa::VrfPbftSortition::VrfPbftSortition ( vrf_sk_t const &  sk, const VrfPbftMsg &  pbft_msg  )

inline

VrfPbftSortition() [3/3]

taraxa::VrfPbftSortition::VrfPbftSortition ( dev::bytes const &  rlp )

explicit

Member Function Documentation

calculateWeight()

uint64_t taraxa::VrfPbftSortition::calculateWeight	(	uint64_t	stake,
		uint64_t	dpos_total_votes_count,
		uint64_t	threshold,
		const public_t &	address
	)		const

Calculate vote weight.

Parameters

stake	voter DPOS eligible votes count
dpos_total_votes_count	total DPOS votes count
threshold	PBFT sortition threshold that is minimum of between PBFT committee size and total DPOS votes count
address	voter public key

Returns

vote weight

getBinominalDistribution()

uint64_t taraxa::VrfPbftSortition::getBinominalDistribution ( uint64_t  stake, double  dpos_total_votes_count, double  threshold, const uint256_t &  hash  )

static

Calculate a vote weight in binominal distribution.

Parameters

stake	voter DPOS eligible votes count
dpos_total_votes_count	total DPOS votes count
threshold	PBFT sortition threshold that is minimum of between PBFT committee size and total DPOS votes count
hash	a hash number of combining VRF output, voter address, and vote weight index

Returns

vote weight

getRlpBytes()

bytes taraxa::VrfPbftSortition::getRlpBytes

(

)

const

Get bytes of RLP stream.

Returns

bytes of RLP stream

operator==()

bool taraxa::VrfPbftSortition::operator== ( VrfPbftSortition const &  other ) const

inline

verify()

bool taraxa::VrfPbftSortition::verify ( const vrf_pk_t &  pk, bool  strict = true  ) const

inline

Verify VRF sortition.

Parameters

strict

strict validation

Returns

true if passed

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  strm, const VrfPbftSortition &  vrf_sortition  )

friend

Member Data Documentation

kMax256bFP

auto taraxa::VrfPbftSortition::kMax256bFP = max256bits.convert_to<boost::multiprecision::mpfr_float>()

inlinestatic

max256bits

uint256_t taraxa::VrfPbftSortition::max256bits = std::numeric_limits<uint256_t>::max()

inlinestatic

pbft_msg_

VrfPbftMsg taraxa::VrfPbftSortition::pbft_msg_

Enumeration Type Documentation

PbftVoteTypes

enum class taraxa::PbftVoteTypes : uint8_t

strong

Enumerator
invalid_vote
propose_vote
soft_vote
cert_vote
next_vote

Function Documentation

decodePbftVotesBundleRlp()

std::vector< std::shared_ptr< PbftVote > > taraxa::decodePbftVotesBundleRlp

(

const dev::RLP &

votes_bundle_rlp

)

Decodes pbft votes from optimized votes bundle rlp.

Parameters

votes_bundle_rlp

Returns

votes

decodePillarVotesBundleRlp()

std::vector< std::shared_ptr< PillarVote > > taraxa::decodePillarVotesBundleRlp

(

const dev::RLP &

votes_bundle_rlp

)

Decodes pillar votes from optimized votes bundle rlp.

Parameters

votes_bundle_rlp

Returns

votes

encodePbftVotesBundleRlp()

dev::bytes taraxa::encodePbftVotesBundleRlp

(

const std::vector< std::shared_ptr< PbftVote > > &

votes

)

Encodes pbft votes into optimized votes bundle rlp.

Parameters

votes

Returns

votes bundle rlp bytes

encodePillarVotesBundleRlp()

dev::bytes taraxa::encodePillarVotesBundleRlp

(

const std::vector< std::shared_ptr< PillarVote > > &

votes

)

Encodes pillar votes into optimized votes bundle rlp.

Parameters

votes

Returns

votes bundle rlp bytes

getVoterIndexHash()

dev::h256 taraxa::getVoterIndexHash	(	const vrf_wrapper::vrf_output_t &	vrf,
		const public_t &	address,
		uint64_t	index = 0
	)

Get a hash number of combining VRF output, voter address, and vote weight index.

Parameters

vrf	VRF output
address	voter address
index	vote weight index

Returns

a hash number in Secure Hash Algorithm 3

Variable Documentation

kPbftVotesBundleRlpSize

constexpr size_t taraxa::kPbftVotesBundleRlpSize {5}

staticconstexpr

kPillarVotesBundleRlpSize

constexpr size_t taraxa::kPillarVotesBundleRlpSize {3}

staticconstexpr