github.com/klaytn/klaytn@v1.10.2/consensus/istanbul/validator/multi_staking_test.go

// Copyright 2019 The klaytn Authors
// This file is part of the klaytn library.
//
// The klaytn library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The klaytn library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the klaytn library. If not, see <http://www.gnu.org/licenses/>.

/*
Multiple Staking Contracts

Validators can deploy multiple staking contracts.
If a validator wants to deploy additional staking contracts, those staking contracts should have same rewardAddress.
StakingAmounts of staking contracts with a same rewardAddress will be added and it is reflected to a probability of becoming a block proposer.

Testing

StakingInfos are data from addressBook.
A StakingInfo has lists of addresses and stakingAmount.
They are matched by an index. Values of the lists with a same index are from a same staking contract.

All addresses used in tests are made by 3 digits number.
NodeAddress : begin with 1
rewardAddress : begin with 2
NodeAddress of additional staking contract : begin with 9
*/
package validator

import (
	"testing"

	"github.com/klaytn/klaytn/common"
	"github.com/klaytn/klaytn/consensus/istanbul"
	"github.com/klaytn/klaytn/reward"
	"github.com/stretchr/testify/assert"
)

func newTestWeightedCouncil(nodeAddrs []common.Address) *weightedCouncil {
	return NewWeightedCouncil(nodeAddrs, nil, nil, make([]uint64, len(nodeAddrs)), nil, istanbul.WeightedRandom, 0, 0, 0, nil)
}

// TestWeightedCouncil_getStakingAmountsOfValidators checks if validators and stakingAmounts from a stakingInfo are matched well.
// stakingAmounts of additional staking contracts will be added to stakingAmounts of validators which have the same reward address.
// input
//  - validator and stakingInfo is matched by a nodeAddress.
// output
//  - weightedValidators are sorted by nodeAddress
//  - stakingAmounts should be same as expectedStakingAmounts
func TestWeightedCouncil_getStakingAmountsOfValidators(t *testing.T) {
	testCases := []struct {
		validators             []common.Address
		stakingInfo            *reward.StakingInfo
		expectedStakingAmounts []float64
	}{
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203")},
				CouncilStakingAmounts: []uint64{10000000, 5000000, 5000000},
			},
			[]float64{10000000, 5000000, 5000000},
		},
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203")},
				CouncilStakingAmounts: []uint64{7000000, 5000000, 10000000},
			},
			[]float64{7000000, 5000000, 10000000},
		},
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("901")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203"), common.StringToAddress("204"), common.StringToAddress("201")},
				CouncilStakingAmounts: []uint64{5000000, 5000000, 5000000, 5000000, 5000000},
			},
			[]float64{10000000, 5000000, 5000000, 5000000},
		},
		{
			[]common.Address{common.StringToAddress("104"), common.StringToAddress("103"), common.StringToAddress("102"), common.StringToAddress("101")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("901"), common.StringToAddress("902")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203"), common.StringToAddress("204"), common.StringToAddress("201"), common.StringToAddress("202")},
				CouncilStakingAmounts: []uint64{5000000, 5000000, 5000000, 5000000, 5000000, 5000000},
			},
			[]float64{10000000, 10000000, 5000000, 5000000},
		},
	}
	for _, testCase := range testCases {
		council := newTestWeightedCouncil(testCase.validators)
		candidates := append(council.validators, council.demotedValidators...)
		weightedValidators, stakingAmounts, err := getStakingAmountsOfValidators(candidates, testCase.stakingInfo)

		assert.NoError(t, err)
		assert.Equal(t, len(testCase.validators), len(weightedValidators))
		for _, validator := range weightedValidators {
			assert.Contains(t, testCase.validators, validator.address)
		}
		assert.Equal(t, testCase.expectedStakingAmounts, stakingAmounts)
	}
}

// TestCalcTotalAmount tests calcTotalAmount that calculates totalAmount of stakingAmounts and gini coefficient if UseGini is true.
// if UseGini is true, gini is calculated and reflected to stakingAmounts.
func TestCalcTotalAmount(t *testing.T) {
	testCases := []struct {
		weightedValidators     []*weightedValidator // Produced by getStakingAmountsOfValidators()
		stakingInfo            *reward.StakingInfo  // Produced by GetStakingInfo()
		stakingAmounts         []float64            // Produced by getStakingAmountsOfValidators()
		expectedGini           float64              // Gini among the []weightedValidators which is a subset of CouncilNodeAddrs
		expectedTotalAmount    float64              // Sum of Gini-adjusted amounts
		expectedStakingAmounts []float64            // Gini-adjusted amounts
	}{
		{ // Gini disabled
			[]*weightedValidator{
				{address: common.StringToAddress("101")}, {address: common.StringToAddress("102")}, {address: common.StringToAddress("103")},
			},
			&reward.StakingInfo{
				CouncilNodeAddrs: []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103")},
				UseGini:          false,
				Gini:             reward.DefaultGiniCoefficient, // To see if calcTotalAmount modifies Gini field, set it to -1.
			},
			[]float64{5000000, 5000000, 5000000},
			reward.DefaultGiniCoefficient,
			15000000,
			[]float64{5000000, 5000000, 5000000},
		},
		{ // Gini enabled but equal amounts.
			[]*weightedValidator{
				{address: common.StringToAddress("101")}, {address: common.StringToAddress("102")}, {address: common.StringToAddress("103")},
			},
			&reward.StakingInfo{
				CouncilNodeAddrs: []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103")},
				UseGini:          true,
				Gini:             reward.DefaultGiniCoefficient,
			},
			[]float64{5000000, 5000000, 5000000},
			0,
			15000000,
			[]float64{5000000, 5000000, 5000000},
		},
		{ // Gini enabled and unequal amounts.
			[]*weightedValidator{
				{address: common.StringToAddress("101")}, {address: common.StringToAddress("102")}, {address: common.StringToAddress("103")}, {address: common.StringToAddress("104")}, {address: common.StringToAddress("105")},
			},
			&reward.StakingInfo{
				CouncilNodeAddrs: []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("105")},
				UseGini:          true,
				Gini:             reward.DefaultGiniCoefficient,
			},
			[]float64{10000000, 20000000, 30000000, 40000000, 50000000},
			0.27,
			3779508,
			[]float64{324946, 560845, 771786, 967997, 1153934},
		},
	}
	for _, testCase := range testCases {
		stakingAmounts := testCase.stakingAmounts
		totalAmount, giniUsed := calcTotalAmount(testCase.weightedValidators, testCase.stakingInfo, stakingAmounts)

		assert.Equal(t, testCase.expectedGini, giniUsed)                          // calcTotalAmount computes gini among validators on its own
		assert.Equal(t, reward.DefaultGiniCoefficient, testCase.stakingInfo.Gini) // stakingInfo.Gini left untouched
		assert.Equal(t, testCase.expectedTotalAmount, totalAmount)
		assert.Equal(t, testCase.expectedStakingAmounts, stakingAmounts)
	}
}

// TestCalcWeight tests calcWeight that calculates weights and saves them to validators.
// weights are the ratio of each stakingAmount to totalStaking
func TestCalcWeight(t *testing.T) {
	testCases := []struct {
		weightedValidators []*weightedValidator
		stakingAmounts     []float64
		totalStaking       float64
		expectedWeights    []uint64
	}{
		{
			[]*weightedValidator{
				{}, {}, {},
			},
			[]float64{0, 0, 0},
			0,
			[]uint64{0, 0, 0},
		},
		{
			[]*weightedValidator{
				{}, {}, {},
			},
			[]float64{5000000, 5000000, 5000000},
			15000000,
			[]uint64{33, 33, 33},
		},
		{
			[]*weightedValidator{
				{}, {}, {}, {},
			},
			[]float64{5000000, 10000000, 5000000, 5000000},
			25000000,
			[]uint64{20, 40, 20, 20},
		},
		{
			[]*weightedValidator{
				{}, {}, {}, {}, {},
			},
			[]float64{324946, 560845, 771786, 967997, 1153934},
			3779508,
			[]uint64{9, 15, 20, 26, 31},
		},
	}
	for _, testCase := range testCases {
		calcWeight(testCase.weightedValidators, testCase.stakingAmounts, testCase.totalStaking)
		for i, weight := range testCase.expectedWeights {
			assert.Equal(t, weight, testCase.weightedValidators[i].Weight())
		}
	}
}

// TestWeightedCouncil_validatorWeightWithStakingInfo is union of above tests.
// Weight should be calculated exactly by a validator list and a stakingInfo given
func TestWeightedCouncil_validatorWeightWithStakingInfo(t *testing.T) {
	testCases := []struct {
		validators      []common.Address
		stakingInfo     *reward.StakingInfo
		expectedWeights []uint64
	}{
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203")},
				UseGini:               false,
				CouncilStakingAmounts: []uint64{0, 0, 0},
			},
			[]uint64{0, 0, 0},
		},
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203"), common.StringToAddress("204")},
				UseGini:               true,
				CouncilStakingAmounts: []uint64{5000000, 5000000, 5000000, 5000000},
			},
			[]uint64{25, 25, 25, 25},
		},
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("105")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("105")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203"), common.StringToAddress("204"), common.StringToAddress("205")},
				UseGini:               true,
				CouncilStakingAmounts: []uint64{10000000, 20000000, 30000000, 40000000, 50000000},
			},
			[]uint64{9, 15, 20, 26, 31},
		},
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("901")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203"), common.StringToAddress("204"), common.StringToAddress("201")},
				UseGini:               false,
				CouncilStakingAmounts: []uint64{5000000, 5000000, 5000000, 5000000, 5000000},
			},
			[]uint64{40, 20, 20, 20},
		},
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("901")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203"), common.StringToAddress("204"), common.StringToAddress("201")},
				UseGini:               true,
				CouncilStakingAmounts: []uint64{5000000, 5000000, 5000000, 5000000, 5000000},
			},
			[]uint64{38, 21, 21, 21},
		},
		{
			[]common.Address{common.StringToAddress("104"), common.StringToAddress("103"), common.StringToAddress("102"), common.StringToAddress("101")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("901"), common.StringToAddress("902")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203"), common.StringToAddress("204"), common.StringToAddress("201"), common.StringToAddress("202")},
				UseGini:               true,
				CouncilStakingAmounts: []uint64{10000000, 5000000, 20000000, 5000000, 5000000, 5000000},
			},
			[]uint64{29, 21, 37, 12},
		},
		{
			[]common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("105")},
			&reward.StakingInfo{
				CouncilNodeAddrs:      []common.Address{common.StringToAddress("101"), common.StringToAddress("102"), common.StringToAddress("103"), common.StringToAddress("104"), common.StringToAddress("901"), common.StringToAddress("902")},
				CouncilRewardAddrs:    []common.Address{common.StringToAddress("201"), common.StringToAddress("202"), common.StringToAddress("203"), common.StringToAddress("204"), common.StringToAddress("201"), common.StringToAddress("202")},
				UseGini:               true,
				CouncilStakingAmounts: []uint64{10000000, 5000000, 20000000, 5000000, 5000000, 5000000},
			},
			[]uint64{29, 21, 37, 12, 1},
		},
	}
	for _, testCase := range testCases {
		council := newTestWeightedCouncil(testCase.validators)
		candidates := append(council.validators, council.demotedValidators...)
		weightedValidators, stakingAmounts, err := getStakingAmountsOfValidators(candidates, testCase.stakingInfo)
		assert.NoError(t, err)
		totalStaking, _ := calcTotalAmount(weightedValidators, testCase.stakingInfo, stakingAmounts)
		calcWeight(weightedValidators, stakingAmounts, totalStaking)

		for i, weight := range testCase.expectedWeights {
			assert.Equal(t, weight, weightedValidators[i].Weight())
		}
	}
}