prysm-pulse/beacon-chain/core/helpers/eth1data.go

package helpers

import (
	"math/big"

	"github.com/pkg/errors"
	"github.com/prysmaticlabs/go-ssz"
	ethpb "github.com/prysmaticlabs/prysm/proto/eth/v1alpha1"
	"github.com/prysmaticlabs/prysm/shared/hashutil"
)

// VoteHierarchyMap struct that holds all the relevant data in order to count and
// choose the best vote.
type VoteHierarchyMap struct {
	BestVote       *ethpb.Eth1Data
	bestVoteHeight *big.Int
	mostVotes      uint64
	voteCountMap   map[string]voteHierarchy
}

// voteHierarchy is a structure we use in order to count deposit votes and
// break ties between similarly voted deposits
type voteHierarchy struct {
	votes    uint64
	height   *big.Int
	eth1Data *ethpb.Eth1Data
}

// EmptyVoteHierarchyMap creates and returns an empty VoteHierarchyMap.
func EmptyVoteHierarchyMap() *VoteHierarchyMap {
	vm := &VoteHierarchyMap{}
	vm.voteCountMap = make(map[string]voteHierarchy)
	return vm
}

// CountVote takes a votecount map and adds the given vote to it in the relevant
// position while updating the best vote, most votes and best vote hash.
func CountVote(voteMap *VoteHierarchyMap, vote *ethpb.Eth1Data, blockHeight *big.Int) (*VoteHierarchyMap, error) {
	encoded, err := ssz.Marshal(vote)
	if err != nil {
		return &VoteHierarchyMap{}, errors.Wrap(err, "could not get encoded hash of eth1data object")
	}
	he := hashutil.Hash(encoded)
	v, ok := voteMap.voteCountMap[string(he[:])]

	if !ok {
		v = voteHierarchy{votes: 1, height: blockHeight, eth1Data: vote}
		voteMap.voteCountMap[string(he[:])] = v
	} else {
		v.votes = v.votes + 1
		voteMap.voteCountMap[string(he[:])] = v
	}
	if v.votes > voteMap.mostVotes {
		voteMap.mostVotes = v.votes
		voteMap.BestVote = vote
		voteMap.bestVoteHeight = blockHeight
	} else if v.votes == voteMap.mostVotes && v.height.Cmp(voteMap.bestVoteHeight) == 1 {
		//breaking ties by favoring votes with higher block height.
		voteMap.BestVote = vote
		voteMap.bestVoteHeight = v.height
	}
	return voteMap, nil
}