state

package
v1.0.0-alpha Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 14, 2020 License: GPL-3.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrNilInnerState = errors.New("nil inner state")

ErrNilInnerState returns when the inner state is nil and no copy set or get operations can be performed on state.

Functions

func CopyAttestation 

func CopyAttestation(att *ethpb.Attestation) *ethpb.Attestation

CopyAttestation copies the provided attestation object.

func CopyAttestationData 

func CopyAttestationData(attData *ethpb.AttestationData) *ethpb.AttestationData

CopyAttestationData copies the provided AttestationData object.

func CopyAttestations 

func CopyAttestations(attestations []*ethpb.Attestation) []*ethpb.Attestation

CopyAttestations copies the provided Attestation array.

func CopyAttesterSlashings 

func CopyAttesterSlashings(slashings []*ethpb.AttesterSlashing) []*ethpb.AttesterSlashing

CopyAttesterSlashings copies the provided AttesterSlashings array (of size 1).

func CopyBeaconBlock 

func CopyBeaconBlock(block *ethpb.BeaconBlock) *ethpb.BeaconBlock

CopyBeaconBlock copies the provided BeaconBlock.

func CopyBeaconBlockBody 

func CopyBeaconBlockBody(body *ethpb.BeaconBlockBody) *ethpb.BeaconBlockBody

CopyBeaconBlockBody copies the provided BeaconBlockBody.

func CopyBeaconBlockHeader 

func CopyBeaconBlockHeader(header *ethpb.BeaconBlockHeader) *ethpb.BeaconBlockHeader

CopyBeaconBlockHeader copies the provided BeaconBlockHeader.

func CopyCheckpoint 

func CopyCheckpoint(cp *ethpb.Checkpoint) *ethpb.Checkpoint

CopyCheckpoint copies the provided checkpoint.

func CopyDeposit 

func CopyDeposit(deposit *ethpb.Deposit) *ethpb.Deposit

CopyDeposit copies the provided deposit.

func CopyDepositData 

func CopyDepositData(depData *ethpb.Deposit_Data) *ethpb.Deposit_Data

CopyDepositData copies the provided deposit data.

func CopyDeposits 

func CopyDeposits(deposits []*ethpb.Deposit) []*ethpb.Deposit

CopyDeposits copies the provided deposit array.

func CopyETH1Data 

func CopyETH1Data(data *ethpb.Eth1Data) *ethpb.Eth1Data

CopyETH1Data copies the provided eth1data object.

func CopyIndexedAttestation 

func CopyIndexedAttestation(indexedAtt *ethpb.IndexedAttestation) *ethpb.IndexedAttestation

CopyIndexedAttestation copies the provided IndexedAttestation.

func CopyPendingAttestation 

func CopyPendingAttestation(att *pbp2p.PendingAttestation) *pbp2p.PendingAttestation

CopyPendingAttestation copies the provided pending attestation object.

func CopyProposerSlashing 

func CopyProposerSlashing(slashing *ethpb.ProposerSlashing) *ethpb.ProposerSlashing

CopyProposerSlashing copies the provided ProposerSlashing.

func CopyProposerSlashings 

func CopyProposerSlashings(slashings []*ethpb.ProposerSlashing) []*ethpb.ProposerSlashing

CopyProposerSlashings copies the provided ProposerSlashing array.

func CopySignedBeaconBlock 

func CopySignedBeaconBlock(sigBlock *ethpb.SignedBeaconBlock) *ethpb.SignedBeaconBlock

CopySignedBeaconBlock copies the provided SignedBeaconBlock.

func CopySignedBeaconBlockHeader 

func CopySignedBeaconBlockHeader(header *ethpb.SignedBeaconBlockHeader) *ethpb.SignedBeaconBlockHeader

CopySignedBeaconBlockHeader copies the provided SignedBeaconBlockHeader.

func CopySignedVoluntaryExit 

func CopySignedVoluntaryExit(exit *ethpb.SignedVoluntaryExit) *ethpb.SignedVoluntaryExit

CopySignedVoluntaryExit copies the provided SignedVoluntaryExit.

func CopySignedVoluntaryExits 

func CopySignedVoluntaryExits(exits []*ethpb.SignedVoluntaryExit) []*ethpb.SignedVoluntaryExit

CopySignedVoluntaryExits copies the provided SignedVoluntaryExits array.

Types

type BeaconState 

type BeaconState struct {
	// contains filtered or unexported fields
}

BeaconState defines a struct containing utilities for the eth2 chain state, defining getters and setters for its respective values and helpful functions such as HashTreeRoot().

func InitializeFromProto 

func InitializeFromProto(st *pbp2p.BeaconState) (*BeaconState, error)

InitializeFromProto the beacon state from a protobuf representation.

func InitializeFromProtoUnsafe 

func InitializeFromProtoUnsafe(st *pbp2p.BeaconState) (*BeaconState, error)

InitializeFromProtoUnsafe directly uses the beacon state protobuf pointer and sets it as the inner state of the BeaconState type.

func (*BeaconState) AddDirtyIndices added in v0.3.5 

func (b *BeaconState) AddDirtyIndices(index fieldIndex, indices []uint64)

AddDirtyIndices adds the relevant dirty field indices, so that they can be recomputed.

func (*BeaconState) AppendBalance 

func (b *BeaconState) AppendBalance(bal uint64) error

AppendBalance for the beacon state. This PR appends the new value to the the end of list.

func (*BeaconState) AppendCurrentEpochAttestations 

func (b *BeaconState) AppendCurrentEpochAttestations(val *pbp2p.PendingAttestation) error

AppendCurrentEpochAttestations for the beacon state. This PR appends the new value to the the end of list.

func (*BeaconState) AppendEth1DataVotes 

func (b *BeaconState) AppendEth1DataVotes(val *ethpb.Eth1Data) error

AppendEth1DataVotes for the beacon state. This PR appends the new value to the the end of list.

func (*BeaconState) AppendHistoricalRoots 

func (b *BeaconState) AppendHistoricalRoots(root [32]byte) error

AppendHistoricalRoots for the beacon state. This PR appends the new value to the the end of list.

func (*BeaconState) AppendPreviousEpochAttestations 

func (b *BeaconState) AppendPreviousEpochAttestations(val *pbp2p.PendingAttestation) error

AppendPreviousEpochAttestations for the beacon state. This PR appends the new value to the the end of list.

func (*BeaconState) AppendValidator 

func (b *BeaconState) AppendValidator(val *ethpb.Validator) error

AppendValidator for the beacon state. This PR appends the new value to the the end of list.

func (*BeaconState) ApplyToEveryValidator 

func (b *BeaconState) ApplyToEveryValidator(f func(idx int, val *ethpb.Validator) (bool, error)) error

ApplyToEveryValidator applies the provided callback function to each validator in the validator registry.

func (*BeaconState) BalanceAtIndex 

func (b *BeaconState) BalanceAtIndex(idx uint64) (uint64, error)

BalanceAtIndex of validator with the provided index.

func (*BeaconState) Balances 

func (b *BeaconState) Balances() []uint64

Balances of validators participating in consensus on the beacon chain.

func (*BeaconState) BalancesLength 

func (b *BeaconState) BalancesLength() int

BalancesLength returns the length of the balances slice.

func (*BeaconState) BlockRootAtIndex 

func (b *BeaconState) BlockRootAtIndex(idx uint64) ([]byte, error)

BlockRootAtIndex retrieves a specific block root based on an input index value.

func (*BeaconState) BlockRoots 

func (b *BeaconState) BlockRoots() [][]byte

BlockRoots kept track of in the beacon state.

func (*BeaconState) CloneInnerState 

func (b *BeaconState) CloneInnerState() *pbp2p.BeaconState

CloneInnerState the beacon state into a protobuf for usage.

func (*BeaconState) Copy 

func (b *BeaconState) Copy() *BeaconState

Copy returns a deep copy of the beacon state.

func (*BeaconState) CurrentEpochAttestations 

func (b *BeaconState) CurrentEpochAttestations() []*pbp2p.PendingAttestation

CurrentEpochAttestations corresponding to blocks on the beacon chain.

func (*BeaconState) CurrentJustifiedCheckpoint 

func (b *BeaconState) CurrentJustifiedCheckpoint() *ethpb.Checkpoint

CurrentJustifiedCheckpoint denoting an epoch and block root.

func (*BeaconState) Eth1Data 

func (b *BeaconState) Eth1Data() *ethpb.Eth1Data

Eth1Data corresponding to the proof-of-work chain information stored in the beacon state.

func (*BeaconState) Eth1DataVotes 

func (b *BeaconState) Eth1DataVotes() []*ethpb.Eth1Data

Eth1DataVotes corresponds to votes from eth2 on the canonical proof-of-work chain data retrieved from eth1.

func (*BeaconState) Eth1DepositIndex 

func (b *BeaconState) Eth1DepositIndex() uint64

Eth1DepositIndex corresponds to the index of the deposit made to the validator deposit contract at the time of this state's eth1 data.

func (*BeaconState) FinalizedCheckpoint 

func (b *BeaconState) FinalizedCheckpoint() *ethpb.Checkpoint

FinalizedCheckpoint denoting an epoch and block root.

func (*BeaconState) FinalizedCheckpointEpoch 

func (b *BeaconState) FinalizedCheckpointEpoch() uint64

FinalizedCheckpointEpoch returns the epoch value of the finalized checkpoint.

func (*BeaconState) Fork 

func (b *BeaconState) Fork() *pbp2p.Fork

Fork version of the beacon chain.

func (*BeaconState) GenesisTime 

func (b *BeaconState) GenesisTime() uint64

GenesisTime of the beacon state as a uint64.

func (*BeaconState) GenesisUnixTime added in v0.3.8 

func (b *BeaconState) GenesisUnixTime() time.Time

GenesisUnixTime returns the genesis time as time.Time.

func (*BeaconState) GenesisValidatorRoot added in v1.0.0 

func (b *BeaconState) GenesisValidatorRoot() []byte

GenesisValidatorRoot of the beacon state.

func (*BeaconState) HasInnerState 

func (b *BeaconState) HasInnerState() bool

HasInnerState detects if the internal reference to the state data structure is populated correctly. Returns false if nil.

func (*BeaconState) HashTreeRoot 

func (b *BeaconState) HashTreeRoot(ctx context.Context) ([32]byte, error)

HashTreeRoot of the beacon state retrieves the Merkle root of the trie representation of the beacon state based on the eth2 Simple Serialize specification.

func (*BeaconState) HistoricalRoots 

func (b *BeaconState) HistoricalRoots() [][]byte

HistoricalRoots based on epochs stored in the beacon state.

func (*BeaconState) InnerStateUnsafe 

func (b *BeaconState) InnerStateUnsafe() *pbp2p.BeaconState

InnerStateUnsafe returns the pointer value of the underlying beacon state proto object, bypassing immutability. Use with care.

func (*BeaconState) JustificationBits 

func (b *BeaconState) JustificationBits() bitfield.Bitvector4

JustificationBits marking which epochs have been justified in the beacon chain.

func (*BeaconState) LatestBlockHeader 

func (b *BeaconState) LatestBlockHeader() *ethpb.BeaconBlockHeader

LatestBlockHeader stored within the beacon state.

func (*BeaconState) NumValidators 

func (b *BeaconState) NumValidators() int

NumValidators returns the size of the validator registry.

func (*BeaconState) ParentRoot added in v0.3.8 

func (b *BeaconState) ParentRoot() [32]byte

ParentRoot is a convenience method to access state.LatestBlockRoot.ParentRoot.

func (*BeaconState) PreviousEpochAttestations 

func (b *BeaconState) PreviousEpochAttestations() []*pbp2p.PendingAttestation

PreviousEpochAttestations corresponding to blocks on the beacon chain.

func (*BeaconState) PreviousJustifiedCheckpoint 

func (b *BeaconState) PreviousJustifiedCheckpoint() *ethpb.Checkpoint

PreviousJustifiedCheckpoint denoting an epoch and block root.

func (*BeaconState) PubkeyAtIndex 

func (b *BeaconState) PubkeyAtIndex(idx uint64) [48]byte

PubkeyAtIndex returns the pubkey at the given validator index.

func (*BeaconState) RandaoMixAtIndex 

func (b *BeaconState) RandaoMixAtIndex(idx uint64) ([]byte, error)

RandaoMixAtIndex retrieves a specific block root based on an input index value.

func (*BeaconState) RandaoMixes 

func (b *BeaconState) RandaoMixes() [][]byte

RandaoMixes of block proposers on the beacon chain.

func (*BeaconState) RandaoMixesLength 

func (b *BeaconState) RandaoMixesLength() int

RandaoMixesLength returns the length of the randao mixes slice.

func (*BeaconState) ReadFromEveryValidator 

func (b *BeaconState) ReadFromEveryValidator(f func(idx int, val *ReadOnlyValidator) error) error

ReadFromEveryValidator reads values from every validator and applies it to the provided function. Warning: This method is potentially unsafe, as it exposes the actual validator registry.

func (*BeaconState) SetBalances 

func (b *BeaconState) SetBalances(val []uint64) error

SetBalances for the beacon state. This PR updates the entire list to a new value by overwriting the previous one.

func (*BeaconState) SetBlockRoots 

func (b *BeaconState) SetBlockRoots(val [][]byte) error

SetBlockRoots for the beacon state. This PR updates the entire list to a new value by overwriting the previous one.

func (*BeaconState) SetCurrentEpochAttestations 

func (b *BeaconState) SetCurrentEpochAttestations(val []*pbp2p.PendingAttestation) error

SetCurrentEpochAttestations for the beacon state. This PR updates the entire list to a new value by overwriting the previous one.

func (*BeaconState) SetCurrentJustifiedCheckpoint 

func (b *BeaconState) SetCurrentJustifiedCheckpoint(val *ethpb.Checkpoint) error

SetCurrentJustifiedCheckpoint for the beacon state.

func (*BeaconState) SetEth1Data 

func (b *BeaconState) SetEth1Data(val *ethpb.Eth1Data) error

SetEth1Data for the beacon state.

func (*BeaconState) SetEth1DataVotes 

func (b *BeaconState) SetEth1DataVotes(val []*ethpb.Eth1Data) error

SetEth1DataVotes for the beacon state. This PR updates the entire list to a new value by overwriting the previous one.

func (*BeaconState) SetEth1DepositIndex 

func (b *BeaconState) SetEth1DepositIndex(val uint64) error

SetEth1DepositIndex for the beacon state.

func (*BeaconState) SetFinalizedCheckpoint 

func (b *BeaconState) SetFinalizedCheckpoint(val *ethpb.Checkpoint) error

SetFinalizedCheckpoint for the beacon state.

func (*BeaconState) SetFork 

func (b *BeaconState) SetFork(val *pbp2p.Fork) error

SetFork version for the beacon chain.

func (*BeaconState) SetGenesisTime 

func (b *BeaconState) SetGenesisTime(val uint64) error

SetGenesisTime for the beacon state.

func (*BeaconState) SetGenesisValidatorRoot added in v1.0.0 

func (b *BeaconState) SetGenesisValidatorRoot(val []byte) error

SetGenesisValidatorRoot for the beacon state.

func (*BeaconState) SetHistoricalRoots 

func (b *BeaconState) SetHistoricalRoots(val [][]byte) error

SetHistoricalRoots for the beacon state. This PR updates the entire list to a new value by overwriting the previous one.

func (*BeaconState) SetJustificationBits 

func (b *BeaconState) SetJustificationBits(val bitfield.Bitvector4) error

SetJustificationBits for the beacon state.

func (*BeaconState) SetLatestBlockHeader 

func (b *BeaconState) SetLatestBlockHeader(val *ethpb.BeaconBlockHeader) error

SetLatestBlockHeader in the beacon state.

func (*BeaconState) SetPreviousEpochAttestations 

func (b *BeaconState) SetPreviousEpochAttestations(val []*pbp2p.PendingAttestation) error

SetPreviousEpochAttestations for the beacon state. This PR updates the entire list to a new value by overwriting the previous one.

func (*BeaconState) SetPreviousJustifiedCheckpoint 

func (b *BeaconState) SetPreviousJustifiedCheckpoint(val *ethpb.Checkpoint) error

SetPreviousJustifiedCheckpoint for the beacon state.

func (*BeaconState) SetRandaoMixes 

func (b *BeaconState) SetRandaoMixes(val [][]byte) error

SetRandaoMixes for the beacon state. This PR updates the entire list to a new value by overwriting the previous one.

func (*BeaconState) SetSlashings 

func (b *BeaconState) SetSlashings(val []uint64) error

SetSlashings for the beacon state. This PR updates the entire list to a new value by overwriting the previous one.

func (*BeaconState) SetSlot 

func (b *BeaconState) SetSlot(val uint64) error

SetSlot for the beacon state.

func (*BeaconState) SetStateRoots 

func (b *BeaconState) SetStateRoots(val [][]byte) error

SetStateRoots for the beacon state. This PR updates the entire to a new value by overwriting the previous one.

func (*BeaconState) SetValidatorIndexByPubkey 

func (b *BeaconState) SetValidatorIndexByPubkey(pubKey [48]byte, validatorIdx uint64)

SetValidatorIndexByPubkey updates the validator index mapping maintained internally to a given input 48-byte, public key.

func (*BeaconState) SetValidators 

func (b *BeaconState) SetValidators(val []*ethpb.Validator) error

SetValidators for the beacon state. This PR updates the entire to a new value by overwriting the previous one.

func (*BeaconState) Slashings 

func (b *BeaconState) Slashings() []uint64

Slashings of validators on the beacon chain.

func (*BeaconState) Slot 

func (b *BeaconState) Slot() uint64

Slot of the current beacon chain state.

func (*BeaconState) StateRoots 

func (b *BeaconState) StateRoots() [][]byte

StateRoots kept track of in the beacon state.

func (*BeaconState) UpdateBalancesAtIndex 

func (b *BeaconState) UpdateBalancesAtIndex(idx uint64, val uint64) error

UpdateBalancesAtIndex for the beacon state. This method updates the balance at a specific index to a new value.

func (*BeaconState) UpdateBlockRootAtIndex 

func (b *BeaconState) UpdateBlockRootAtIndex(idx uint64, blockRoot [32]byte) error

UpdateBlockRootAtIndex for the beacon state. This PR updates the randao mixes at a specific index to a new value.

func (*BeaconState) UpdateRandaoMixesAtIndex 

func (b *BeaconState) UpdateRandaoMixesAtIndex(val []byte, idx uint64) error

UpdateRandaoMixesAtIndex for the beacon state. This PR updates the randao mixes at a specific index to a new value.

func (*BeaconState) UpdateSlashingsAtIndex 

func (b *BeaconState) UpdateSlashingsAtIndex(idx uint64, val uint64) error

UpdateSlashingsAtIndex for the beacon state. This PR updates the randao mixes at a specific index to a new value.

func (*BeaconState) UpdateStateRootAtIndex 

func (b *BeaconState) UpdateStateRootAtIndex(idx uint64, stateRoot [32]byte) error

UpdateStateRootAtIndex for the beacon state. This PR updates the randao mixes at a specific index to a new value.

func (*BeaconState) UpdateValidatorAtIndex 

func (b *BeaconState) UpdateValidatorAtIndex(idx uint64, val *ethpb.Validator) error

UpdateValidatorAtIndex for the beacon state. This PR updates the randao mixes at a specific index to a new value.

func (*BeaconState) ValidatorAtIndex 

func (b *BeaconState) ValidatorAtIndex(idx uint64) (*ethpb.Validator, error)

ValidatorAtIndex is the validator at the provided index.

func (*BeaconState) ValidatorAtIndexReadOnly 

func (b *BeaconState) ValidatorAtIndexReadOnly(idx uint64) (*ReadOnlyValidator, error)

ValidatorAtIndexReadOnly is the validator at the provided index.This method doesn't clone the validator.

func (*BeaconState) ValidatorIndexByPubkey 

func (b *BeaconState) ValidatorIndexByPubkey(key [48]byte) (uint64, bool)

ValidatorIndexByPubkey returns a given validator by its 48-byte public key.

func (*BeaconState) Validators 

func (b *BeaconState) Validators() []*ethpb.Validator

Validators participating in consensus on the beacon chain.

func (*BeaconState) ValidatorsReadOnly 

func (b *BeaconState) ValidatorsReadOnly() []*ReadOnlyValidator

ValidatorsReadOnly returns validators participating in consensus on the beacon chain. This method doesn't clone the respective validators and returns read only references to the validators.

type FieldTrie added in v0.3.5 

type FieldTrie struct {
	*sync.Mutex
	// contains filtered or unexported fields
}

FieldTrie is the representation of the representative trie of the particular field.

func NewFieldTrie added in v0.3.5 

func NewFieldTrie(field fieldIndex, elements interface{}, length uint64) (*FieldTrie, error)

NewFieldTrie is the constructor for the field trie data structure. It creates the corresponding trie according to the given parameters. Depending on whether the field is a basic/composite array which is either fixed/variable length, it will appropriately determine the trie.

func (FieldTrie) AddRef added in v0.3.5 

func (r FieldTrie) AddRef()

func (*FieldTrie) CopyTrie added in v0.3.5 

func (f *FieldTrie) CopyTrie() *FieldTrie

CopyTrie copies the references to the elements the trie is built on.

func (FieldTrie) MinusRef added in v0.3.5 

func (r FieldTrie) MinusRef()

func (*FieldTrie) RecomputeTrie added in v0.3.5 

func (f *FieldTrie) RecomputeTrie(indices []uint64, elements interface{}) ([32]byte, error)

RecomputeTrie rebuilds the affected branches in the trie according to the provided changed indices and elements. This recomputes the trie according to the particular field the trie is based on.

func (*FieldTrie) TrieRoot added in v0.3.5 

func (f *FieldTrie) TrieRoot() ([32]byte, error)

TrieRoot returns the corresponding root of the trie.

type ReadOnlyValidator 

type ReadOnlyValidator struct {
	// contains filtered or unexported fields
}

ReadOnlyValidator returns a wrapper that only allows fields from a validator to be read, and prevents any modification of internal validator fields.

func (*ReadOnlyValidator) ActivationEligibilityEpoch 

func (v *ReadOnlyValidator) ActivationEligibilityEpoch() uint64

ActivationEligibilityEpoch returns the activation eligibility epoch of the read only validator.

func (*ReadOnlyValidator) ActivationEpoch 

func (v *ReadOnlyValidator) ActivationEpoch() uint64

ActivationEpoch returns the activation epoch of the read only validator.

func (*ReadOnlyValidator) EffectiveBalance 

func (v *ReadOnlyValidator) EffectiveBalance() uint64

EffectiveBalance returns the effective balance of the read only validator.

func (*ReadOnlyValidator) ExitEpoch 

func (v *ReadOnlyValidator) ExitEpoch() uint64

ExitEpoch returns the exit epoch of the read only validator.

func (*ReadOnlyValidator) PublicKey 

func (v *ReadOnlyValidator) PublicKey() [48]byte

PublicKey returns the public key of the read only validator.

func (*ReadOnlyValidator) Slashed 

func (v *ReadOnlyValidator) Slashed() bool

Slashed returns the read only validator is slashed.

func (*ReadOnlyValidator) WithdrawableEpoch 

func (v *ReadOnlyValidator) WithdrawableEpoch() uint64

WithdrawableEpoch returns the withdrawable epoch of the read only validator.

func (*ReadOnlyValidator) WithdrawalCredentials 

func (v *ReadOnlyValidator) WithdrawalCredentials() []byte

WithdrawalCredentials returns the withdrawal credentials of the read only validator.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.