github.com/MetalBlockchain/metalgo@v1.11.9/vms/proposervm/proposer/windower_test.go

// Copyright (C) 2019-2024, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.

package proposer

import (
	"context"
	"math"
	"math/rand"
	"testing"
	"time"

	"github.com/stretchr/testify/require"

	"github.com/MetalBlockchain/metalgo/ids"
	"github.com/MetalBlockchain/metalgo/snow/validators"

	safemath "github.com/MetalBlockchain/metalgo/utils/math"
)

var (
	subnetID      = ids.GenerateTestID()
	randomChainID = ids.GenerateTestID()
	fixedChainID  = ids.ID{0, 2}
)

func TestWindowerNoValidators(t *testing.T) {
	require := require.New(t)

	_, vdrState := makeValidators(t, 0)
	w := New(vdrState, subnetID, randomChainID)

	var (
		chainHeight  uint64 = 1
		pChainHeight uint64 = 0
		nodeID              = ids.GenerateTestNodeID()
		slot         uint64 = 1
	)
	delay, err := w.Delay(context.Background(), chainHeight, pChainHeight, nodeID, MaxVerifyWindows)
	require.NoError(err)
	require.Zero(delay)

	proposer, err := w.ExpectedProposer(context.Background(), chainHeight, pChainHeight, slot)
	require.ErrorIs(err, ErrAnyoneCanPropose)
	require.Equal(ids.EmptyNodeID, proposer)

	delay, err = w.MinDelayForProposer(context.Background(), chainHeight, pChainHeight, nodeID, slot)
	require.ErrorIs(err, ErrAnyoneCanPropose)
	require.Zero(delay)
}

func TestWindowerRepeatedValidator(t *testing.T) {
	require := require.New(t)

	var (
		validatorID    = ids.GenerateTestNodeID()
		nonValidatorID = ids.GenerateTestNodeID()
	)

	vdrState := &validators.TestState{
		T: t,
		GetValidatorSetF: func(context.Context, uint64, ids.ID) (map[ids.NodeID]*validators.GetValidatorOutput, error) {
			return map[ids.NodeID]*validators.GetValidatorOutput{
				validatorID: {
					NodeID: validatorID,
					Weight: 10,
				},
			}, nil
		},
	}

	w := New(vdrState, subnetID, randomChainID)

	validatorDelay, err := w.Delay(context.Background(), 1, 0, validatorID, MaxVerifyWindows)
	require.NoError(err)
	require.Zero(validatorDelay)

	nonValidatorDelay, err := w.Delay(context.Background(), 1, 0, nonValidatorID, MaxVerifyWindows)
	require.NoError(err)
	require.Equal(MaxVerifyDelay, nonValidatorDelay)
}

func TestDelayChangeByHeight(t *testing.T) {
	require := require.New(t)

	validatorIDs, vdrState := makeValidators(t, MaxVerifyWindows)
	w := New(vdrState, subnetID, fixedChainID)

	expectedDelays1 := []time.Duration{
		2 * WindowDuration,
		5 * WindowDuration,
		3 * WindowDuration,
		4 * WindowDuration,
		0 * WindowDuration,
		1 * WindowDuration,
	}
	for i, expectedDelay := range expectedDelays1 {
		vdrID := validatorIDs[i]
		validatorDelay, err := w.Delay(context.Background(), 1, 0, vdrID, MaxVerifyWindows)
		require.NoError(err)
		require.Equal(expectedDelay, validatorDelay)
	}

	expectedDelays2 := []time.Duration{
		5 * WindowDuration,
		1 * WindowDuration,
		3 * WindowDuration,
		4 * WindowDuration,
		0 * WindowDuration,
		2 * WindowDuration,
	}
	for i, expectedDelay := range expectedDelays2 {
		vdrID := validatorIDs[i]
		validatorDelay, err := w.Delay(context.Background(), 2, 0, vdrID, MaxVerifyWindows)
		require.NoError(err)
		require.Equal(expectedDelay, validatorDelay)
	}
}

func TestDelayChangeByChain(t *testing.T) {
	require := require.New(t)

	source := rand.NewSource(int64(0))
	rng := rand.New(source) // #nosec G404

	chainID0 := ids.Empty
	_, err := rng.Read(chainID0[:])
	require.NoError(err)

	chainID1 := ids.Empty
	_, err = rng.Read(chainID1[:])
	require.NoError(err)

	validatorIDs, vdrState := makeValidators(t, MaxVerifyWindows)
	w0 := New(vdrState, subnetID, chainID0)
	w1 := New(vdrState, subnetID, chainID1)

	expectedDelays0 := []time.Duration{
		5 * WindowDuration,
		2 * WindowDuration,
		0 * WindowDuration,
		3 * WindowDuration,
		1 * WindowDuration,
		4 * WindowDuration,
	}
	for i, expectedDelay := range expectedDelays0 {
		vdrID := validatorIDs[i]
		validatorDelay, err := w0.Delay(context.Background(), 1, 0, vdrID, MaxVerifyWindows)
		require.NoError(err)
		require.Equal(expectedDelay, validatorDelay)
	}

	expectedDelays1 := []time.Duration{
		0 * WindowDuration,
		1 * WindowDuration,
		4 * WindowDuration,
		5 * WindowDuration,
		3 * WindowDuration,
		2 * WindowDuration,
	}
	for i, expectedDelay := range expectedDelays1 {
		vdrID := validatorIDs[i]
		validatorDelay, err := w1.Delay(context.Background(), 1, 0, vdrID, MaxVerifyWindows)
		require.NoError(err)
		require.Equal(expectedDelay, validatorDelay)
	}
}

func TestExpectedProposerChangeByHeight(t *testing.T) {
	require := require.New(t)

	validatorIDs, vdrState := makeValidators(t, 10)
	w := New(vdrState, subnetID, fixedChainID)

	var (
		dummyCtx            = context.Background()
		pChainHeight uint64 = 0
		slot         uint64 = 0
	)

	expectedProposers := map[uint64]ids.NodeID{
		1: validatorIDs[2],
		2: validatorIDs[1],
	}

	for chainHeight, expectedProposerID := range expectedProposers {
		proposerID, err := w.ExpectedProposer(dummyCtx, chainHeight, pChainHeight, slot)
		require.NoError(err)
		require.Equal(expectedProposerID, proposerID)
	}
}

func TestExpectedProposerChangeByChain(t *testing.T) {
	require := require.New(t)

	source := rand.NewSource(int64(0))
	rng := rand.New(source) // #nosec G404

	chainID0 := ids.Empty
	_, err := rng.Read(chainID0[:])
	require.NoError(err)

	chainID1 := ids.Empty
	_, err = rng.Read(chainID1[:])
	require.NoError(err)

	validatorIDs, vdrState := makeValidators(t, 10)

	var (
		dummyCtx            = context.Background()
		chainHeight  uint64 = 1
		pChainHeight uint64 = 0
		slot         uint64 = 0
	)

	expectedProposers := map[ids.ID]ids.NodeID{
		chainID0: validatorIDs[5],
		chainID1: validatorIDs[3],
	}

	for chainID, expectedProposerID := range expectedProposers {
		w := New(vdrState, subnetID, chainID)
		proposerID, err := w.ExpectedProposer(dummyCtx, chainHeight, pChainHeight, slot)
		require.NoError(err)
		require.Equal(expectedProposerID, proposerID)
	}
}

func TestExpectedProposerChangeBySlot(t *testing.T) {
	require := require.New(t)

	validatorIDs, vdrState := makeValidators(t, 10)
	w := New(vdrState, subnetID, fixedChainID)

	var (
		dummyCtx            = context.Background()
		chainHeight  uint64 = 1
		pChainHeight uint64 = 0
	)

	proposers := []ids.NodeID{
		validatorIDs[2],
		validatorIDs[0],
		validatorIDs[9],
		validatorIDs[7],
		validatorIDs[0],
		validatorIDs[3],
		validatorIDs[3],
		validatorIDs[3],
		validatorIDs[3],
		validatorIDs[3],
		validatorIDs[4],
		validatorIDs[0],
		validatorIDs[6],
		validatorIDs[3],
		validatorIDs[2],
		validatorIDs[1],
		validatorIDs[6],
		validatorIDs[0],
		validatorIDs[5],
		validatorIDs[1],
		validatorIDs[9],
		validatorIDs[6],
		validatorIDs[0],
		validatorIDs[8],
	}
	expectedProposers := map[uint64]ids.NodeID{
		MaxLookAheadSlots:     validatorIDs[4],
		MaxLookAheadSlots + 1: validatorIDs[6],
	}
	for slot, expectedProposerID := range proposers {
		expectedProposers[uint64(slot)] = expectedProposerID
	}

	for slot, expectedProposerID := range expectedProposers {
		actualProposerID, err := w.ExpectedProposer(dummyCtx, chainHeight, pChainHeight, slot)
		require.NoError(err)
		require.Equal(expectedProposerID, actualProposerID)
	}
}

func TestCoherenceOfExpectedProposerAndMinDelayForProposer(t *testing.T) {
	require := require.New(t)

	_, vdrState := makeValidators(t, 10)
	w := New(vdrState, subnetID, fixedChainID)

	var (
		dummyCtx            = context.Background()
		chainHeight  uint64 = 1
		pChainHeight uint64 = 0
	)

	for slot := uint64(0); slot < 3*MaxLookAheadSlots; slot++ {
		proposerID, err := w.ExpectedProposer(dummyCtx, chainHeight, pChainHeight, slot)
		require.NoError(err)

		// proposerID is the scheduled proposer. It should start with the
		// expected delay
		delay, err := w.MinDelayForProposer(dummyCtx, chainHeight, pChainHeight, proposerID, slot)
		require.NoError(err)
		require.Equal(time.Duration(slot)*WindowDuration, delay)
	}
}

func TestMinDelayForProposer(t *testing.T) {
	require := require.New(t)

	validatorIDs, vdrState := makeValidators(t, 10)
	w := New(vdrState, subnetID, fixedChainID)

	var (
		dummyCtx            = context.Background()
		chainHeight  uint64 = 1
		pChainHeight uint64 = 0
		slot         uint64 = 0
	)

	expectedDelays := map[ids.NodeID]time.Duration{
		validatorIDs[0]:          1 * WindowDuration,
		validatorIDs[1]:          15 * WindowDuration,
		validatorIDs[2]:          0 * WindowDuration,
		validatorIDs[3]:          5 * WindowDuration,
		validatorIDs[4]:          10 * WindowDuration,
		validatorIDs[5]:          18 * WindowDuration,
		validatorIDs[6]:          12 * WindowDuration,
		validatorIDs[7]:          3 * WindowDuration,
		validatorIDs[8]:          23 * WindowDuration,
		validatorIDs[9]:          2 * WindowDuration,
		ids.GenerateTestNodeID(): MaxLookAheadWindow,
	}

	for nodeID, expectedDelay := range expectedDelays {
		delay, err := w.MinDelayForProposer(dummyCtx, chainHeight, pChainHeight, nodeID, slot)
		require.NoError(err)
		require.Equal(expectedDelay, delay)
	}
}

func BenchmarkMinDelayForProposer(b *testing.B) {
	require := require.New(b)

	_, vdrState := makeValidators(b, 10)
	w := New(vdrState, subnetID, fixedChainID)

	var (
		dummyCtx            = context.Background()
		pChainHeight uint64 = 0
		chainHeight  uint64 = 1
		nodeID              = ids.GenerateTestNodeID() // Ensure to exhaust the search
		slot         uint64 = 0
	)

	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		_, err := w.MinDelayForProposer(dummyCtx, chainHeight, pChainHeight, nodeID, slot)
		require.NoError(err)
	}
}

func TestTimeToSlot(t *testing.T) {
	parentTime := time.Now()
	tests := []struct {
		timeOffset   time.Duration
		expectedSlot uint64
	}{
		{
			timeOffset:   -WindowDuration,
			expectedSlot: 0,
		},
		{
			timeOffset:   -time.Second,
			expectedSlot: 0,
		},
		{
			timeOffset:   0,
			expectedSlot: 0,
		},
		{
			timeOffset:   WindowDuration,
			expectedSlot: 1,
		},
		{
			timeOffset:   2 * WindowDuration,
			expectedSlot: 2,
		},
	}
	for _, test := range tests {
		t.Run(test.timeOffset.String(), func(t *testing.T) {
			slot := TimeToSlot(parentTime, parentTime.Add(test.timeOffset))
			require.Equal(t, test.expectedSlot, slot)
		})
	}
}

// Ensure that the proposer distribution is within 3 standard deviations of the
// expected value assuming a truly random binomial distribution.
func TestProposerDistribution(t *testing.T) {
	require := require.New(t)

	validatorIDs, vdrState := makeValidators(t, 10)
	w := New(vdrState, subnetID, fixedChainID)

	var (
		dummyCtx               = context.Background()
		pChainHeight    uint64 = 0
		numChainHeights uint64 = 100
		numSlots        uint64 = 100
	)

	proposerFrequency := make(map[ids.NodeID]int)
	for _, validatorID := range validatorIDs {
		// Initialize the map to 0s to include validators that are never sampled
		// in the analysis.
		proposerFrequency[validatorID] = 0
	}
	for chainHeight := uint64(0); chainHeight < numChainHeights; chainHeight++ {
		for slot := uint64(0); slot < numSlots; slot++ {
			proposerID, err := w.ExpectedProposer(dummyCtx, chainHeight, pChainHeight, slot)
			require.NoError(err)
			proposerFrequency[proposerID]++
		}
	}

	var (
		totalNumberOfSamples      = numChainHeights * numSlots
		probabilityOfBeingSampled = 1 / float64(len(validatorIDs))
		expectedNumberOfSamples   = uint64(probabilityOfBeingSampled * float64(totalNumberOfSamples))
		variance                  = float64(totalNumberOfSamples) * probabilityOfBeingSampled * (1 - probabilityOfBeingSampled)
		stdDeviation              = math.Sqrt(variance)
		maxDeviation              uint64
	)
	for _, sampled := range proposerFrequency {
		maxDeviation = max(
			maxDeviation,
			safemath.AbsDiff(
				uint64(sampled),
				expectedNumberOfSamples,
			),
		)
	}

	maxSTDDeviation := float64(maxDeviation) / stdDeviation
	require.Less(maxSTDDeviation, 3.)
}

func makeValidators(t testing.TB, count int) ([]ids.NodeID, *validators.TestState) {
	validatorIDs := make([]ids.NodeID, count)
	for i := range validatorIDs {
		validatorIDs[i] = ids.BuildTestNodeID([]byte{byte(i) + 1})
	}

	vdrState := &validators.TestState{
		T: t,
		GetValidatorSetF: func(context.Context, uint64, ids.ID) (map[ids.NodeID]*validators.GetValidatorOutput, error) {
			vdrs := make(map[ids.NodeID]*validators.GetValidatorOutput, MaxVerifyWindows)
			for _, id := range validatorIDs {
				vdrs[id] = &validators.GetValidatorOutput{
					NodeID: id,
					Weight: 1,
				}
			}
			return vdrs, nil
		},
	}
	return validatorIDs, vdrState
}