prysm-pulse/beacon-chain/state/state-native/setters_validator.go

package state_native

import (
	"github.com/pkg/errors"
	"github.com/prysmaticlabs/prysm/v4/beacon-chain/state/state-native/types"
	"github.com/prysmaticlabs/prysm/v4/beacon-chain/state/stateutil"
	"github.com/prysmaticlabs/prysm/v4/config/features"
	consensus_types "github.com/prysmaticlabs/prysm/v4/consensus-types"
	"github.com/prysmaticlabs/prysm/v4/consensus-types/primitives"
	"github.com/prysmaticlabs/prysm/v4/encoding/bytesutil"
	ethpb "github.com/prysmaticlabs/prysm/v4/proto/prysm/v1alpha1"
	"github.com/prysmaticlabs/prysm/v4/runtime/version"
)

// SetValidators for the beacon state. Updates the entire
// to a new value by overwriting the previous one.
func (b *BeaconState) SetValidators(val []*ethpb.Validator) error {
	b.lock.Lock()
	defer b.lock.Unlock()

	if features.Get().EnableExperimentalState {
		if b.validatorsMultiValue != nil {
			b.validatorsMultiValue.Detach(b)
		}
		b.validatorsMultiValue = NewMultiValueValidators(val)
	} else {
		b.validators = val
		b.sharedFieldReferences[types.Validators].MinusRef()
		b.sharedFieldReferences[types.Validators] = stateutil.NewRef(1)
	}

	b.markFieldAsDirty(types.Validators)
	b.rebuildTrie[types.Validators] = true
	b.valMapHandler = stateutil.NewValMapHandler(val)
	return nil
}

// ApplyToEveryValidator applies the provided callback function to each validator in the
// validator registry.
func (b *BeaconState) ApplyToEveryValidator(f func(idx int, val *ethpb.Validator) (bool, *ethpb.Validator, error)) error {
	var changedVals []uint64
	if features.Get().EnableExperimentalState {
		b.lock.Lock()

		l := b.validatorsMultiValue.Len(b)
		for i := 0; i < l; i++ {
			v, err := b.validatorsMultiValue.At(b, uint64(i))
			if err != nil {
				b.lock.Unlock()
				return err
			}
			changed, newVal, err := f(i, v)
			if err != nil {
				b.lock.Unlock()
				return err
			}
			if changed {
				changedVals = append(changedVals, uint64(i))
				if err = b.validatorsMultiValue.UpdateAt(b, uint64(i), newVal); err != nil {
					b.lock.Unlock()
					return errors.Wrapf(err, "could not update validator at index %d", i)
				}
			}
		}

		b.lock.Unlock()
	} else {
		b.lock.Lock()

		v := b.validators
		if ref := b.sharedFieldReferences[types.Validators]; ref.Refs() > 1 {
			v = b.validatorsReferences()
			ref.MinusRef()
			b.sharedFieldReferences[types.Validators] = stateutil.NewRef(1)
		}

		b.lock.Unlock()

		for i, val := range v {
			changed, newVal, err := f(i, val)
			if err != nil {
				return err
			}
			if changed {
				changedVals = append(changedVals, uint64(i))
				v[i] = newVal
			}
		}

		b.lock.Lock()
		b.validators = v
		b.lock.Unlock()
	}

	b.lock.Lock()
	defer b.lock.Unlock()

	b.markFieldAsDirty(types.Validators)
	b.addDirtyIndices(types.Validators, changedVals)
	return nil
}

// UpdateValidatorAtIndex for the beacon state. Updates the validator
// at a specific index to a new value.
func (b *BeaconState) UpdateValidatorAtIndex(idx primitives.ValidatorIndex, val *ethpb.Validator) error {
	if features.Get().EnableExperimentalState {
		if err := b.validatorsMultiValue.UpdateAt(b, uint64(idx), val); err != nil {
			return errors.Wrap(err, "could not update validator")
		}
	} else {
		if uint64(len(b.validators)) <= uint64(idx) {
			return errors.Wrapf(consensus_types.ErrOutOfBounds, "validator index %d does not exist", idx)
		}

		b.lock.Lock()

		v := b.validators
		if ref := b.sharedFieldReferences[types.Validators]; ref.Refs() > 1 {
			v = b.validatorsReferences()
			ref.MinusRef()
			b.sharedFieldReferences[types.Validators] = stateutil.NewRef(1)
		}
		v[idx] = val
		b.validators = v

		b.lock.Unlock()
	}

	b.lock.Lock()
	defer b.lock.Unlock()

	b.markFieldAsDirty(types.Validators)
	b.addDirtyIndices(types.Validators, []uint64{uint64(idx)})
	return nil
}

// SetBalances for the beacon state. Updates the entire
// list to a new value by overwriting the previous one.
func (b *BeaconState) SetBalances(val []uint64) error {
	b.lock.Lock()
	defer b.lock.Unlock()

	if features.Get().EnableExperimentalState {
		if b.balancesMultiValue != nil {
			b.balancesMultiValue.Detach(b)
		}
		b.balancesMultiValue = NewMultiValueBalances(val)
	} else {
		b.sharedFieldReferences[types.Balances].MinusRef()
		b.sharedFieldReferences[types.Balances] = stateutil.NewRef(1)
		b.balances = val
	}

	b.markFieldAsDirty(types.Balances)
	b.rebuildTrie[types.Balances] = true
	return nil
}

// UpdateBalancesAtIndex for the beacon state. This method updates the balance
// at a specific index to a new value.
func (b *BeaconState) UpdateBalancesAtIndex(idx primitives.ValidatorIndex, val uint64) error {
	if features.Get().EnableExperimentalState {
		if err := b.balancesMultiValue.UpdateAt(b, uint64(idx), val); err != nil {
			return errors.Wrap(err, "could not update balances")
		}
	} else {
		if uint64(len(b.balances)) <= uint64(idx) {
			return errors.Wrapf(consensus_types.ErrOutOfBounds, "balance index %d does not exist", idx)
		}

		b.lock.Lock()

		bals := b.balances
		if b.sharedFieldReferences[types.Balances].Refs() > 1 {
			bals = b.balancesVal()
			b.sharedFieldReferences[types.Balances].MinusRef()
			b.sharedFieldReferences[types.Balances] = stateutil.NewRef(1)
		}
		bals[idx] = val
		b.balances = bals

		b.lock.Unlock()
	}

	b.lock.Lock()
	defer b.lock.Unlock()

	b.markFieldAsDirty(types.Balances)
	b.addDirtyIndices(types.Balances, []uint64{uint64(idx)})
	return nil
}

// SetSlashings for the beacon state. Updates the entire
// list to a new value by overwriting the previous one.
func (b *BeaconState) SetSlashings(val []uint64) error {
	b.lock.Lock()
	defer b.lock.Unlock()

	b.sharedFieldReferences[types.Slashings].MinusRef()
	b.sharedFieldReferences[types.Slashings] = stateutil.NewRef(1)

	b.slashings = val
	b.markFieldAsDirty(types.Slashings)
	return nil
}

// UpdateSlashingsAtIndex for the beacon state. Updates the slashings
// at a specific index to a new value.
func (b *BeaconState) UpdateSlashingsAtIndex(idx, val uint64) error {
	if uint64(len(b.slashings)) <= idx {
		return errors.Errorf("invalid index provided %d", idx)
	}
	b.lock.Lock()
	defer b.lock.Unlock()

	s := b.slashings
	if b.sharedFieldReferences[types.Slashings].Refs() > 1 {
		s = b.slashingsVal()
		b.sharedFieldReferences[types.Slashings].MinusRef()
		b.sharedFieldReferences[types.Slashings] = stateutil.NewRef(1)
	}

	s[idx] = val

	b.slashings = s

	b.markFieldAsDirty(types.Slashings)
	return nil
}

// AppendValidator for the beacon state. Appends the new value
// to the end of list.
func (b *BeaconState) AppendValidator(val *ethpb.Validator) error {
	var valIdx primitives.ValidatorIndex
	if features.Get().EnableExperimentalState {
		b.validatorsMultiValue.Append(b, val)
		valIdx = primitives.ValidatorIndex(b.validatorsMultiValue.Len(b) - 1)
	} else {
		b.lock.Lock()

		vals := b.validators
		if b.sharedFieldReferences[types.Validators].Refs() > 1 {
			vals = b.validatorsReferences()
			b.sharedFieldReferences[types.Validators].MinusRef()
			b.sharedFieldReferences[types.Validators] = stateutil.NewRef(1)
		}

		b.validators = append(vals, val)
		valIdx = primitives.ValidatorIndex(len(b.validators) - 1)

		b.lock.Unlock()
	}

	b.lock.Lock()
	defer b.lock.Unlock()

	b.valMapHandler.Set(bytesutil.ToBytes48(val.PublicKey), valIdx)
	b.markFieldAsDirty(types.Validators)
	b.addDirtyIndices(types.Validators, []uint64{uint64(valIdx)})
	return nil
}

// AppendBalance for the beacon state. Appends the new value
// to the end of list.
func (b *BeaconState) AppendBalance(bal uint64) error {
	var balIdx uint64
	if features.Get().EnableExperimentalState {
		b.balancesMultiValue.Append(b, bal)
		balIdx = uint64(b.balancesMultiValue.Len(b) - 1)
	} else {
		b.lock.Lock()

		bals := b.balances
		if b.sharedFieldReferences[types.Balances].Refs() > 1 {
			bals = make([]uint64, 0, len(b.balances)+1)
			bals = append(bals, b.balances...)
			b.sharedFieldReferences[types.Balances].MinusRef()
			b.sharedFieldReferences[types.Balances] = stateutil.NewRef(1)
		}

		b.balances = append(bals, bal)
		balIdx = uint64(len(b.balances) - 1)

		b.lock.Unlock()
	}

	b.lock.Lock()
	defer b.lock.Unlock()

	b.markFieldAsDirty(types.Balances)
	b.addDirtyIndices(types.Balances, []uint64{balIdx})
	return nil
}

// AppendInactivityScore for the beacon state.
func (b *BeaconState) AppendInactivityScore(s uint64) error {
	if b.version == version.Phase0 {
		return errNotSupported("AppendInactivityScore", b.version)
	}

	if features.Get().EnableExperimentalState {
		b.inactivityScoresMultiValue.Append(b, s)
	} else {
		b.lock.Lock()

		scores := b.inactivityScores
		if b.sharedFieldReferences[types.InactivityScores].Refs() > 1 {
			scores = make([]uint64, 0, len(b.inactivityScores)+1)
			scores = append(scores, b.inactivityScores...)
			b.sharedFieldReferences[types.InactivityScores].MinusRef()
			b.sharedFieldReferences[types.InactivityScores] = stateutil.NewRef(1)
		}
		b.inactivityScores = append(scores, s)

		b.lock.Unlock()
	}

	b.lock.Lock()
	defer b.lock.Unlock()

	b.markFieldAsDirty(types.InactivityScores)
	return nil
}

// SetInactivityScores for the beacon state. Updates the entire
// list to a new value by overwriting the previous one.
func (b *BeaconState) SetInactivityScores(val []uint64) error {
	b.lock.Lock()
	defer b.lock.Unlock()

	if b.version == version.Phase0 {
		return errNotSupported("SetInactivityScores", b.version)
	}

	if features.Get().EnableExperimentalState {
		if b.inactivityScoresMultiValue != nil {
			b.inactivityScoresMultiValue.Detach(b)
		}
		b.inactivityScoresMultiValue = NewMultiValueInactivityScores(val)
	} else {
		b.sharedFieldReferences[types.InactivityScores].MinusRef()
		b.sharedFieldReferences[types.InactivityScores] = stateutil.NewRef(1)
		b.inactivityScores = val
	}

	b.markFieldAsDirty(types.InactivityScores)
	return nil
}