7 "github.com/vapor/common/arithmetic"
8 "github.com/vapor/config"
9 "github.com/vapor/consensus"
10 "github.com/vapor/crypto/ed25519/chainkd"
11 "github.com/vapor/errors"
12 "github.com/vapor/math/checked"
13 "github.com/vapor/protocol/bc"
14 "github.com/vapor/protocol/bc/types"
17 // fedConsensusPath is used to derive federation root xpubs for signing blocks
18 var fedConsensusPath = [][]byte{
19 []byte{0xff, 0xff, 0xff, 0xff},
20 []byte{0xff, 0x00, 0x00, 0x00},
21 []byte{0xff, 0xff, 0xff, 0xff},
22 []byte{0xff, 0x00, 0x00, 0x00},
23 []byte{0xff, 0x00, 0x00, 0x00},
26 // ConsensusNode represents a consensus node
27 type ConsensusNode struct {
33 type byVote []*ConsensusNode
35 func (c byVote) Len() int { return len(c) }
36 func (c byVote) Less(i, j int) bool {
37 return c[i].VoteNum > c[j].VoteNum || (c[i].VoteNum == c[j].VoteNum && c[i].XPub.String() > c[j].XPub.String())
39 func (c byVote) Swap(i, j int) { c[i], c[j] = c[j], c[i] }
41 // CoinbaseReward contains receiver and reward
42 type CoinbaseReward struct {
47 // SortByAmount implements sort.Interface for CoinbaseReward slices
48 type SortByAmount []CoinbaseReward
50 func (a SortByAmount) Len() int { return len(a) }
51 func (a SortByAmount) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
52 func (a SortByAmount) Less(i, j int) bool {
53 return a[i].Amount > a[j].Amount || (a[i].Amount == a[j].Amount && hex.EncodeToString(a[i].ControlProgram) > hex.EncodeToString(a[j].ControlProgram))
56 // CalCoinbaseReward calculate the coinbase reward for block
57 func CalCoinbaseReward(block *types.Block) (*CoinbaseReward, error) {
58 result := &CoinbaseReward{}
59 if len(block.Transactions) > 0 && len(block.Transactions[0].Outputs) > 0 {
60 result.ControlProgram = block.Transactions[0].Outputs[0].ControlProgram()
62 return nil, errors.New("not found coinbase receiver")
65 result.Amount = consensus.BlockSubsidy(block.BlockHeader.Height)
66 for _, tx := range block.Transactions {
67 txFee, err := arithmetic.CalculateTxFee(tx)
69 return nil, errors.Wrap(checked.ErrOverflow, "calculate transaction fee")
72 result.Amount += txFee
77 // CalcVoteSeq calculate the vote sequence
78 // seq 0 is the genesis block
79 // seq 1 is the the block height 1, to block height RoundVoteBlockNums
80 // seq 2 is the block height RoundVoteBlockNums + 1 to block height 2 * RoundVoteBlockNums
81 // consensus node of the current round is the final result of previous round
82 func CalcVoteSeq(blockHeight uint64) uint64 {
86 return (blockHeight-1)/consensus.ActiveNetParams.RoundVoteBlockNums + 1
89 // ConsensusResult represents a snapshot of each round of DPOS voting
90 // Seq indicates the sequence of current votes, which start from zero
91 // NumOfVote indicates the number of votes each consensus node receives, the key of map represent public key
92 // CoinbaseReward indicates the coinbase receiver and reward
93 type ConsensusResult struct {
95 NumOfVote map[string]uint64
96 CoinbaseReward map[string]uint64
101 // ApplyBlock calculate the consensus result for new block
102 func (c *ConsensusResult) ApplyBlock(block *types.Block) error {
103 if c.BlockHash != block.PreviousBlockHash {
104 return errors.New("block parent hash is not equals last block hash of vote result")
107 if err := c.AttachCoinbaseReward(block); err != nil {
111 for _, tx := range block.Transactions {
112 if err := c.ApplyTransaction(tx); err != nil {
117 c.BlockHash = block.Hash()
118 c.BlockHeight = block.Height
119 c.Seq = CalcVoteSeq(block.Height)
123 // ApplyTransaction calculate the consensus result for transaction
124 func (c *ConsensusResult) ApplyTransaction(tx *types.Tx) error {
125 for _, input := range tx.Inputs {
126 vetoInput, ok := input.TypedInput.(*types.VetoInput)
131 pubkey := hex.EncodeToString(vetoInput.Vote)
132 c.NumOfVote[pubkey], ok = checked.SubUint64(c.NumOfVote[pubkey], vetoInput.Amount)
134 return checked.ErrOverflow
137 if c.NumOfVote[pubkey] == 0 {
138 delete(c.NumOfVote, pubkey)
142 for _, output := range tx.Outputs {
143 voteOutput, ok := output.TypedOutput.(*types.VoteOutput)
148 if voteOutput.Amount < consensus.ActiveNetParams.MinVoteOutputAmount {
149 return errors.New("invalid vote transaction with vote amount less than MinVoteOutputAmount")
152 pubkey := hex.EncodeToString(voteOutput.Vote)
153 if _, ok := c.NumOfVote[pubkey]; !ok && voteOutput.Amount < consensus.ActiveNetParams.MinConsensusNodeVoteNum {
154 return errors.New("invalid vote transaction with first vote amount less than MinConsensusNodeVoteNum")
157 if c.NumOfVote[pubkey], ok = checked.AddUint64(c.NumOfVote[pubkey], voteOutput.Amount); !ok {
158 return checked.ErrOverflow
164 // AttachCoinbaseReward attach coinbase reward
165 func (c *ConsensusResult) AttachCoinbaseReward(block *types.Block) error {
166 reward, err := CalCoinbaseReward(block)
171 if block.Height%consensus.ActiveNetParams.RoundVoteBlockNums == 1 {
172 c.CoinbaseReward = map[string]uint64{}
176 program := hex.EncodeToString(reward.ControlProgram)
177 c.CoinbaseReward[program], ok = checked.AddUint64(c.CoinbaseReward[program], reward.Amount)
179 return checked.ErrOverflow
184 // ConsensusNodes returns all consensus nodes
185 func (c *ConsensusResult) ConsensusNodes() (map[string]*ConsensusNode, error) {
186 var nodes []*ConsensusNode
187 for pubkey, voteNum := range c.NumOfVote {
188 if voteNum >= consensus.ActiveNetParams.MinConsensusNodeVoteNum {
189 var xpub chainkd.XPub
190 if err := xpub.UnmarshalText([]byte(pubkey)); err != nil {
194 nodes = append(nodes, &ConsensusNode{XPub: xpub, VoteNum: voteNum})
197 // In principle, there is no need to sort all voting nodes.
198 // if there is a performance problem, consider the optimization later.
199 sort.Sort(byVote(nodes))
200 result := make(map[string]*ConsensusNode)
201 for i := 0; i < len(nodes) && int64(i) < consensus.ActiveNetParams.NumOfConsensusNode; i++ {
202 nodes[i].Order = uint64(i)
203 result[nodes[i].XPub.String()] = nodes[i]
206 if len(result) != 0 {
209 return federationNodes(), nil
212 // DetachBlock calculate the consensus result for detach block
213 func (c *ConsensusResult) DetachBlock(block *types.Block) error {
214 if c.BlockHash != block.Hash() {
215 return errors.New("block hash is not equals last block hash of vote result")
218 if err := c.DetachCoinbaseReward(block); err != nil {
222 for i := len(block.Transactions) - 1; i >= 0; i-- {
223 tx := block.Transactions[i]
224 for _, input := range tx.Inputs {
225 vetoInput, ok := input.TypedInput.(*types.VetoInput)
230 pubkey := hex.EncodeToString(vetoInput.Vote)
231 if c.NumOfVote[pubkey], ok = checked.AddUint64(c.NumOfVote[pubkey], vetoInput.Amount); !ok {
232 return checked.ErrOverflow
236 for _, output := range tx.Outputs {
237 voteOutput, ok := output.TypedOutput.(*types.VoteOutput)
242 pubkey := hex.EncodeToString(voteOutput.Vote)
243 c.NumOfVote[pubkey], ok = checked.SubUint64(c.NumOfVote[pubkey], voteOutput.Amount)
245 return checked.ErrOverflow
248 if c.NumOfVote[pubkey] == 0 {
249 delete(c.NumOfVote, pubkey)
254 c.BlockHash = block.PreviousBlockHash
255 c.BlockHeight = block.Height - 1
256 c.Seq = CalcVoteSeq(block.Height - 1)
260 // DetachCoinbaseReward detach coinbase reward
261 func (c *ConsensusResult) DetachCoinbaseReward(block *types.Block) error {
262 if block.Height%consensus.ActiveNetParams.RoundVoteBlockNums == 0 {
263 for i, output := range block.Transactions[0].Outputs {
267 program := output.ControlProgram()
268 c.CoinbaseReward[hex.EncodeToString(program)] = output.AssetAmount().Amount
272 reward, err := CalCoinbaseReward(block)
278 program := hex.EncodeToString(reward.ControlProgram)
279 if c.CoinbaseReward[program], ok = checked.SubUint64(c.CoinbaseReward[program], reward.Amount); !ok {
280 return checked.ErrOverflow
283 if c.CoinbaseReward[program] == 0 {
284 delete(c.CoinbaseReward, program)
289 // Fork copy the ConsensusResult struct
290 func (c *ConsensusResult) Fork() *ConsensusResult {
291 f := &ConsensusResult{
293 NumOfVote: map[string]uint64{},
294 CoinbaseReward: map[string]uint64{},
295 BlockHash: c.BlockHash,
296 BlockHeight: c.BlockHeight,
299 for key, value := range c.NumOfVote {
300 f.NumOfVote[key] = value
303 for key, value := range c.CoinbaseReward {
304 f.CoinbaseReward[key] = value
309 // IsFinalize check if the result is end of consensus round
310 func (c *ConsensusResult) IsFinalize() bool {
311 return c.BlockHeight%consensus.ActiveNetParams.RoundVoteBlockNums == 0
314 // GetCoinbaseRewards convert into CoinbaseReward array and sort it by amount
315 func (c *ConsensusResult) GetCoinbaseRewards(blockHeight uint64) ([]CoinbaseReward, error) {
316 rewards := []CoinbaseReward{}
317 if blockHeight%consensus.ActiveNetParams.RoundVoteBlockNums != 0 {
321 for p, amount := range c.CoinbaseReward {
322 program, err := hex.DecodeString(p)
327 rewards = append(rewards, CoinbaseReward{
329 ControlProgram: program,
332 sort.Sort(SortByAmount(rewards))
336 func federationNodes() map[string]*ConsensusNode {
337 consensusResult := map[string]*ConsensusNode{}
338 for i, xpub := range config.CommonConfig.Federation.Xpubs {
339 derivedXPub := xpub.Derive(fedConsensusPath)
340 consensusResult[derivedXPub.String()] = &ConsensusNode{XPub: derivedXPub, VoteNum: 0, Order: uint64(i)}
342 return consensusResult