prysm-pulse/beacon-chain/core/helpers/rewards_penalties.go
2019-09-25 18:23:15 -07:00

78 lines
2.5 KiB
Go

package helpers
import (
pb "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
)
// TotalBalance returns the total amount at stake in Gwei
// of input validators.
//
// Spec pseudocode definition:
// def get_total_balance(state: BeaconState, indices: Set[ValidatorIndex]) -> Gwei:
// """
// Return the combined effective balance of the ``indices``. (1 Gwei minimum to avoid divisions by zero.)
// """
// return Gwei(max(1, sum([state.validators[index].effective_balance for index in indices])))
func TotalBalance(state *pb.BeaconState, indices []uint64) uint64 {
total := uint64(0)
for _, idx := range indices {
total += state.Validators[idx].EffectiveBalance
}
// Return 1 Gwei minimum to avoid divisions by zero
if total == 0 {
return 1
}
return total
}
// TotalActiveBalance returns the total amount at stake in Gwei
// of active validators.
//
// Spec pseudocode definition:
// def get_total_active_balance(state: BeaconState) -> Gwei:
// """
// Return the combined effective balance of the active validators.
// """
// return get_total_balance(state, set(get_active_validator_indices(state, get_current_epoch(state))))
func TotalActiveBalance(state *pb.BeaconState) (uint64, error) {
total := uint64(0)
for i, v := range state.Validators {
if IsActiveValidator(v, CurrentEpoch(state)) {
total += state.Validators[i].EffectiveBalance
}
}
return total, nil
}
// IncreaseBalance increases validator with the given 'index' balance by 'delta' in Gwei.
//
// Spec pseudocode definition:
// def increase_balance(state: BeaconState, index: ValidatorIndex, delta: Gwei) -> None:
// """
// Increase the validator balance at index ``index`` by ``delta``.
// """
// state.balances[index] += delta
func IncreaseBalance(state *pb.BeaconState, idx uint64, delta uint64) *pb.BeaconState {
state.Balances[idx] += delta
return state
}
// DecreaseBalance decreases validator with the given 'index' balance by 'delta' in Gwei.
//
// Spec pseudocode definition:
// def decrease_balance(state: BeaconState, index: ValidatorIndex, delta: Gwei) -> None:
// """
// Decrease the validator balance at index ``index`` by ``delta``, with underflow protection.
// """
// state.balances[index] = 0 if delta > state.balances[index] else state.balances[index] - delta
func DecreaseBalance(state *pb.BeaconState, idx uint64, delta uint64) *pb.BeaconState {
if delta > state.Balances[idx] {
state.Balances[idx] = 0
return state
}
state.Balances[idx] -= delta
return state
}