soft_opt_out.go

package keeper

import (
	"encoding/binary"
	"sort"

	sdk "github.com/cosmos/cosmos-sdk/types"
	"github.com/cosmos/interchain-security/v2/x/ccv/consumer/types"
)

// SetSmallestNonOptOutPower sets the smallest validator power that cannot soft opt out.
func (k Keeper) SetSmallestNonOptOutPower(ctx sdk.Context, power uint64) {
	store := ctx.KVStore(k.storeKey)
	store.Set(types.SmallestNonOptOutPowerKey(), sdk.Uint64ToBigEndian(power))
}

// UpdateSmallestNonOptOutPower updates the smallest validator power that cannot soft opt out.
// This is the smallest validator power such that the sum of the power of all validators with a lower power
// is less than [SoftOptOutThreshold] of the total power of all validators.
func (k Keeper) UpdateSmallestNonOptOutPower(ctx sdk.Context) {
	// get soft opt-out threshold
	optOutThreshold := sdk.MustNewDecFromStr(k.GetSoftOptOutThreshold(ctx))
	if optOutThreshold.IsZero() {
		// If the SoftOptOutThreshold is zero, then soft opt-out is disable.
		// Setting the smallest non-opt-out power to zero, fixes the diff-testing
		// when soft opt-out is disable.
		k.SetSmallestNonOptOutPower(ctx, uint64(0))
		return
	}

	// get all validators
	valset := k.GetAllCCValidator(ctx)

	// Valset should only be empty for hacky tests. Log error in case this ever happens in prod.
	if len(valset) == 0 {
		k.Logger(ctx).Error("UpdateSoftOptOutThresholdPower called with empty validator set")
		return
	}

	// sort validators by power ascending
	sort.SliceStable(valset, func(i, j int) bool {
		return valset[i].Power < valset[j].Power
	})

	// get total power in set
	totalPower := sdk.ZeroDec()
	for _, val := range valset {
		totalPower = totalPower.Add(sdk.NewDecFromInt(sdk.NewInt(val.Power)))
	}

	// get power of the smallest validator that cannot soft opt out
	powerSum := sdk.ZeroDec()
	for _, val := range valset {
		powerSum = powerSum.Add(sdk.NewDecFromInt(sdk.NewInt(val.Power)))
		// if powerSum / totalPower > SoftOptOutThreshold
		if powerSum.Quo(totalPower).GT(optOutThreshold) {
			// set smallest non opt out power
			k.SetSmallestNonOptOutPower(ctx, uint64(val.Power))
			k.Logger(ctx).Info("smallest non opt out power updated", "power", val.Power)
			return
		}
	}
	panic("UpdateSoftOptOutThresholdPower should not reach this point. Incorrect logic!")
}

// GetSmallestNonOptOutPower returns the smallest validator power that cannot soft opt out.
func (k Keeper) GetSmallestNonOptOutPower(ctx sdk.Context) int64 {
	store := ctx.KVStore(k.storeKey)
	bz := store.Get(types.SmallestNonOptOutPowerKey())
	if bz == nil {
		return 0
	}
	return int64(binary.BigEndian.Uint64(bz))
}