package
3.2.3-rc.0
Repository: https://github.com/prysmaticlabs/prysm.git
Documentation: pkg.go.dev

# Functions

ActivationExitEpoch takes in epoch number and returns when the validator is eligible for activation and exit.
ActiveValidatorCount returns the number of active validators in the state at the given epoch.
ActiveValidatorIndices filters out active validators based on validator status and returns their indices in a list.
AggregateSignature returns the aggregated signature of the input attestations.
BeaconCommittee returns the beacon committee of a given slot and committee index.
BeaconCommitteeFromState returns the crosslink committee of a given slot and committee index.
BeaconProposerIndex returns proposer index of a current slot.
BlockRoot returns the block root stored in the BeaconState for epoch start slot.
BlockRootAtSlot returns the block root stored in the BeaconState for a recent slot.
ClearCache clears the beacon committee cache and sync committee cache.
CommitteeAssignments is a map of validator indices pointing to the appropriate committee assignment for the given epoch.
ComputeProposerIndex returns the index sampled by effective balance, which is used to calculate proposer.
ComputeShuffledIndex returns the shuffled validator index corresponding to seed and index count.
ComputeSubnetForAttestation returns the subnet for which the provided attestation will be broadcasted to.
ComputeSubnetFromCommitteeAndSlot is a flattened version of ComputeSubnetForAttestation where we only pass in the relevant fields from the attestation as function arguments.
ComputeWeakSubjectivityPeriod returns weak subjectivity period for the active validator count and finalized epoch.
CurrentPeriodSyncSubcommitteeIndices returns the subcommittee indices of the current period sync committee for input validator.
DecreaseBalance decreases validator with the given 'index' balance by 'delta' in Gwei.
DecreaseBalanceWithVal decreases validator with the given 'index' balance by 'delta' in Gwei.
FinalityDelay returns the finality delay using the beacon state.
IncreaseBalance increases validator with the given 'index' balance by 'delta' in Gwei.
IncreaseBalanceWithVal increases validator with the given 'index' balance by 'delta' in Gwei.
IsActiveNonSlashedValidatorUsingTrie checks if a read only validator is active and not slashed.
IsActiveValidator returns the boolean value on whether the validator is active or not.
IsActiveValidatorUsingTrie checks if a read only validator is active.
IsAggregated returns true if the attestation is an aggregated attestation, false otherwise.
IsAggregator returns true if the signature is from the input validator.
IsCurrentPeriodSyncCommittee returns true if the input validator index belongs in the current period sync committee along with the sync committee root.
IsEligibleForActivation checks if the validator is eligible for activation.
IsEligibleForActivationQueue checks if the validator is eligible to be placed into the activation queue.
IsEligibleForActivationQueueUsingTrie checks if the read-only validator is eligible to be placed into the activation queue.
IsEligibleForActivationUsingTrie checks if the validator is eligible for activation.
IsInInactivityLeak returns true if the state is experiencing inactivity leak.
IsNextPeriodSyncCommittee returns true if the input validator index belongs in the next period sync committee along with the sync period boundary root.
IsSlashableValidator returns the boolean value on whether the validator is slashable or not.
IsSlashableValidatorUsingTrie checks if a read only validator is slashable.
IsWithinWeakSubjectivityPeriod verifies if a given weak subjectivity checkpoint is not stale i.e.
LatestWeakSubjectivityEpoch returns epoch of the most recent weak subjectivity checkpoint known to a node.
NextPeriodSyncSubcommitteeIndices returns the subcommittee indices of the next period sync committee for input validator.
ParseWeakSubjectivityInputString parses "blocks_root:epoch_number" string into a checkpoint.
RandaoMix returns the randao mix (xor'ed seed) of a given slot.
Seed returns the randao seed used for shuffling of a given epoch.
ShuffledIndex returns `p(index)` in a pseudorandom permutation `p` of `0...list_size - 1` with “seed“ as entropy.
ShuffledIndices uses input beacon state and returns the shuffled indices of the input epoch, the shuffled indices then can be used to break up into committees.
ShuffleList returns list of shuffled indexes in a pseudorandom permutation `p` of `0...list_size - 1` with “seed“ as entropy.
SlotCommitteeCount returns the number of beacon committees of a slot.
SplitIndices splits a list into n pieces.
StateRootAtSlot returns the cached state root at that particular slot.
TotalActiveBalance returns the total amount at stake in Gwei of active validators.
TotalBalance returns the total amount at stake in Gwei of input validators.
UnShuffledIndex returns the inverse of ShuffledIndex.
UnshuffleList un-shuffles the list by running backwards through the round count.
UpdateCommitteeCache gets called at the beginning of every epoch to cache the committee shuffled indices list with committee index and epoch number.
UpdateGenesisEth1Data updates eth1 data for genesis state.
UpdateProposerIndicesInCache updates proposer indices entry of the committee cache.
UpdateSyncCommitteeCache updates sync committee cache.
ValidateAttestationTime Validates that the incoming attestation is in the desired time range.
ValidateNilAttestation checks if any composite field of input attestation is nil.
ValidateSlotTargetEpoch checks if attestation data's epoch matches target checkpoint's epoch.
ValidatorChurnLimit returns the number of validators that are allowed to enter and exit validator pool for an epoch.
VerifyAttestationBitfieldLengths verifies that an attestations aggregation bitfields is a valid length matching the size of the committee.
VerifyBitfieldLength verifies that a bitfield length matches the given committee size.
VerifyCheckpointEpoch is within current epoch and previous epoch with respect to current time.

# Variables

No description provided by the author

# Structs

CommitteeAssignmentContainer represents a committee list, committee index, and to be attested slot for a given epoch.