core

package
v0.12.0 Latest Latest
Warning

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

 Go to latest Published: May 20, 2020 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const BASE_REWARDS_PER_EPOCH = 4
View Source 
const BASE_REWARD_FACTOR = generated.BASE_REWARD_FACTOR

Reward and penalty quotients

View Source 
const BLS_WITHDRAWAL_PREFIX byte = generated.BLS_WITHDRAWAL_PREFIX
View Source 
const CHURN_LIMIT_QUOTIENT = generated.CHURN_LIMIT_QUOTIENT
View Source 
const DEPOSIT_CONTRACT_TREE_DEPTH = 32
View Source 
const FAR_FUTURE_EPOCH = Epoch(^uint64(0))
View Source 
const HALF_INCREMENT = generated.EFFECTIVE_BALANCE_INCREMENT / 2
View Source 
const HISTORICAL_ROOTS_LIMIT = generated.HISTORICAL_ROOTS_LIMIT
View Source 
const HYSTERESIS_DOWNWARD_MULTIPLIER uint64 = generated.HYSTERESIS_DOWNWARD_MULTIPLIER
View Source 
const HYSTERESIS_QUOTIENT uint64 = generated.HYSTERESIS_QUOTIENT
View Source 
const HYSTERESIS_UPWARD_MULTIPLIER uint64 = generated.HYSTERESIS_UPWARD_MULTIPLIER
View Source 
const INACTIVITY_PENALTY_QUOTIENT = generated.INACTIVITY_PENALTY_QUOTIENT
View Source 
const MAX_ATTESTATIONS = generated.MAX_ATTESTATIONS
View Source 
const MAX_ATTESTER_SLASHINGS = generated.MAX_ATTESTER_SLASHINGS
View Source 
const MAX_COMMITTEES_PER_SLOT = generated.MAX_COMMITTEES_PER_SLOT

Misc.

View Source 
const MAX_DEPOSITS = generated.MAX_DEPOSITS
View Source 
const MAX_PROPOSER_SLASHINGS = generated.MAX_PROPOSER_SLASHINGS

Max transactions per block

View Source 
const MAX_VALIDATORS_PER_COMMITTEE = generated.MAX_VALIDATORS_PER_COMMITTEE
View Source 
const MAX_VOLUNTARY_EXITS = generated.MAX_VOLUNTARY_EXITS
View Source 
const MIN_GENESIS_ACTIVE_VALIDATOR_COUNT = generated.MIN_GENESIS_ACTIVE_VALIDATOR_COUNT

Genesis

View Source 
const MIN_GENESIS_TIME = generated.MIN_GENESIS_TIME
View Source 
const MIN_PER_EPOCH_CHURN_LIMIT = generated.MIN_PER_EPOCH_CHURN_LIMIT
View Source 
const MIN_SLASHING_PENALTY_QUOTIENT = generated.MIN_SLASHING_PENALTY_QUOTIENT
View Source 
const PRESET_NAME = generated.PRESET_NAME

Helper to know what preset is active

View Source 
const PROPOSER_REWARD_QUOTIENT = generated.PROPOSER_REWARD_QUOTIENT
View Source 
const SECONDS_PER_DAY = 24 * 60 * 60
View Source 
const SHUFFLE_ROUND_COUNT uint8 = generated.SHUFFLE_ROUND_COUNT
View Source 
const TARGET_COMMITTEE_SIZE = generated.TARGET_COMMITTEE_SIZE
View Source 
const VALIDATOR_REGISTRY_LIMIT = generated.VALIDATOR_REGISTRY_LIMIT
View Source 
const ValidatorIndexMarker = ValidatorIndex(^uint64(0))

Custom constant, not in spec: An impossible high validator index used to mark special internal cases. (all 1s binary)

View Source 
const WHISTLEBLOWER_REWARD_QUOTIENT = generated.WHISTLEBLOWER_REWARD_QUOTIENT

Variables

View Source 
var DeltasSSZ = zssz.GetSSZ((*Deltas)(nil))
View Source 
var ForkDataSSZ = zssz.GetSSZ((*ForkData)(nil))
View Source 
var GENESIS_FORK_VERSION = parseVersion(generated.GENESIS_FORK_VERSION)

Initial values

View Source 
var SigningRootSSZ = zssz.GetSSZ((*SigningRoot)(nil))

Functions

This section is empty.

Types

type AttesterFlag added in v0.8.2 

type AttesterFlag uint8
const (
	PrevSourceAttester AttesterFlag = 1 << iota
	PrevTargetAttester
	PrevHeadAttester

	CurrSourceAttester
	CurrTargetAttester
	CurrHeadAttester

	UnslashedAttester
	EligibleAttester
)

func (AttesterFlag) HasMarkers added in v0.8.2 

func (flags AttesterFlag) HasMarkers(markers AttesterFlag) bool

type AttesterStatus added in v0.8.2 

type AttesterStatus struct {
	// The delay of inclusion of the latest attestation by the attester.
	// No delay (i.e. 0) by default
	InclusionDelay Slot
	// The validator index of the proposer of the attested beacon block.
	// Only valid if the validator has an attesting flag set.
	AttestedProposer ValidatorIndex
	// A bitfield of markers describing the recent actions of the validator
	Flags AttesterFlag
}

type BLSDomain 

type BLSDomain [32]byte

BLS domain (8 bytes): fork version (32 bits) concatenated with BLS domain type (32 bits)

func ComputeDomain added in v0.8.2 

func ComputeDomain(domainType BLSDomainType, forkVersion Version, genesisValidatorsRoot Root) (out BLSDomain)

type BLSDomainType 

type BLSDomainType [4]byte

Mixed into a BLS domain to define its type 

var (
	DOMAIN_BEACON_PROPOSER     BLSDomainType = parseDomain(generated.DOMAIN_BEACON_PROPOSER)
	DOMAIN_RANDAO              BLSDomainType = parseDomain(generated.DOMAIN_RANDAO)
	DOMAIN_BEACON_ATTESTER     BLSDomainType = parseDomain(generated.DOMAIN_BEACON_ATTESTER)
	DOMAIN_DEPOSIT             BLSDomainType = parseDomain(generated.DOMAIN_DEPOSIT)
	DOMAIN_VOLUNTARY_EXIT      BLSDomainType = parseDomain(generated.DOMAIN_VOLUNTARY_EXIT)
	DOMAIN_SELECTION_PROOF     BLSDomainType = parseDomain(generated.DOMAIN_SELECTION_PROOF)
	DOMAIN_AGGREGATE_AND_PROOF BLSDomainType = parseDomain(generated.DOMAIN_AGGREGATE_AND_PROOF)
)

Signature domains

type BLSPubkey 

type BLSPubkey [48]byte

type BLSPubkeyMessagePair added in v0.10.1 

type BLSPubkeyMessagePair struct {
	PK      BLSPubkey
	Message []byte
}

type BLSSignature 

type BLSSignature [96]byte

type Bytes 

type Bytes []byte

type Checkpoint added in v0.8.2 

type Checkpoint struct {
	Epoch Epoch
	Root  Root
}

type CommitteeIndex added in v0.9.0 

type CommitteeIndex uint64

type Deltas added in v0.8.2 

type Deltas struct {
	Rewards   GweiList
	Penalties GweiList
}

func NewDeltas added in v0.8.2 

func NewDeltas(validatorCount uint64) *Deltas

func (*Deltas) Add added in v0.8.2 

func (deltas *Deltas) Add(other *Deltas)

type DepositIndex 

type DepositIndex uint64

Eth1 deposit ordering

type Epoch 

type Epoch uint64
const EPOCHS_PER_ETH1_VOTING_PERIOD Epoch = generated.EPOCHS_PER_ETH1_VOTING_PERIOD
const EPOCHS_PER_HISTORICAL_VECTOR Epoch = generated.EPOCHS_PER_HISTORICAL_VECTOR

State list lengths 

const EPOCHS_PER_SLASHINGS_VECTOR Epoch = generated.EPOCHS_PER_SLASHINGS_VECTOR
const GENESIS_EPOCH Epoch = 0
const MAX_EPOCHS_PER_CROSSLINK Epoch = generated.MAX_EPOCHS_PER_CROSSLINK
const MAX_SEED_LOOKAHEAD Epoch = generated.MAX_SEED_LOOKAHEAD
const MIN_EPOCHS_TO_INACTIVITY_PENALTY Epoch = generated.MIN_EPOCHS_TO_INACTIVITY_PENALTY
const MIN_SEED_LOOKAHEAD Epoch = generated.MIN_SEED_LOOKAHEAD
const MIN_VALIDATOR_WITHDRAWABILITY_DELAY Epoch = generated.MIN_VALIDATOR_WITHDRAWABILITY_DELAY
const SHARD_COMMITTEE_PERIOD Epoch = generated.SHARD_COMMITTEE_PERIOD

func (Epoch) ComputeActivationExitEpoch added in v0.8.2 

func (e Epoch) ComputeActivationExitEpoch() Epoch

Return the epoch at which an activation or exit triggered in epoch takes effect.

func (Epoch) GetStartSlot 

func (e Epoch) GetStartSlot() Slot

func (Epoch) Previous added in v0.8.2 

func (e Epoch) Previous() Epoch

type ForkData added in v0.11.0 

type ForkData struct {
	CurrentVersion        Version
	GenesisValidatorsRoot Root
}

type ForkDigest added in v0.11.0 

type ForkDigest [4]byte

A digest of the current fork data

func CompureForkDigest added in v0.11.0 

func CompureForkDigest(currentVersion Version, genesisValidatorsRoot Root) ForkDigest

type Gwei 

type Gwei uint64
const EFFECTIVE_BALANCE_INCREMENT Gwei = generated.EFFECTIVE_BALANCE_INCREMENT
const EJECTION_BALANCE Gwei = generated.EJECTION_BALANCE

unused const FORK_CHOICE_BALANCE_INCREMENT Gwei = generated.FORK_CHOICE_BALANCE_INCREMENT 

const MAX_EFFECTIVE_BALANCE Gwei = generated.MAX_EFFECTIVE_BALANCE
const MIN_DEPOSIT_AMOUNT Gwei = generated.MIN_DEPOSIT_AMOUNT

Gwei values

type GweiList added in v0.12.0 

type GweiList []Gwei

func (*GweiList) Limit added in v0.12.0 

func (_ *GweiList) Limit() uint64

type RegistryIndices added in v0.8.2 

type RegistryIndices []ValidatorIndex

func (*RegistryIndices) Limit added in v0.8.2 

func (*RegistryIndices) Limit() uint64

type RewardsAndPenalties added in v0.12.0 

type RewardsAndPenalties struct {
	Source         *Deltas
	Target         *Deltas
	Head           *Deltas
	InclusionDelay *Deltas
	Inactivity     *Deltas
}

func NewRewardsAndPenalties added in v0.12.0 

func NewRewardsAndPenalties(validatorCount uint64) *RewardsAndPenalties

type Root 

type Root [32]byte

func ComputeForkDataRoot added in v0.11.0 

func ComputeForkDataRoot(currentVersion Version, genesisValidatorsRoot Root) Root

func ComputeSigningRoot added in v0.10.1 

func ComputeSigningRoot(msgRoot Root, dom BLSDomain) Root

type Shard 

type Shard uint64

type SigningRoot added in v0.10.1 

type SigningRoot struct {
	ObjectRoot Root
	Domain     BLSDomain
}

type Slot 

type Slot uint64

Current slot 

const GENESIS_SLOT Slot = 0
const MIN_ATTESTATION_INCLUSION_DELAY Slot = generated.MIN_ATTESTATION_INCLUSION_DELAY
const SLOTS_PER_EPOCH Slot = generated.SLOTS_PER_EPOCH
const SLOTS_PER_HISTORICAL_ROOT Slot = generated.SLOTS_PER_HISTORICAL_ROOT

func (Slot) ToEpoch 

func (s Slot) ToEpoch() Epoch

type Timestamp 

type Timestamp uint64

Unix timestamp 

const MIN_GENESIS_DELAY Timestamp = generated.MIN_GENESIS_DELAY

Time parameters 

const SECONDS_PER_SLOT Timestamp = generated.SECONDS_PER_SLOT

func (Timestamp) ToSlot 

func (t Timestamp) ToSlot(genesisTime Timestamp) Slot

type ValidatorIndex 

type ValidatorIndex uint64

Index of a validator, pointing to a validator registry location

type ValidatorSet 

type ValidatorSet []ValidatorIndex

Collection of validators, should always be sorted.

func (*ValidatorSet) Dedup 

func (vs *ValidatorSet) Dedup()

De-duplicates entries in the set in-place. (util to make a valid set from a list with duplicates)

func (ValidatorSet) Intersects 

func (vs ValidatorSet) Intersects(target ValidatorSet) bool

Joins two validator sets: check if there is any overlap

func (ValidatorSet) Len 

func (vs ValidatorSet) Len() int

func (ValidatorSet) Less 

func (vs ValidatorSet) Less(i int, j int) bool

func (ValidatorSet) MergeDisjoint added in v0.8.2 

func (vs ValidatorSet) MergeDisjoint(other ValidatorSet) ValidatorSet

merges with other disjoint set, producing a new set.

func (ValidatorSet) Swap 

func (vs ValidatorSet) Swap(i int, j int)

func (ValidatorSet) ZigZagJoin 

func (vs ValidatorSet) ZigZagJoin(target ValidatorSet, onIn func(i ValidatorIndex), onOut func(i ValidatorIndex))

Joins two validator sets: reports all indices of source that are in the target (call onIn), and those that are not (call onOut)

type Version added in v0.8.2 

type Version [4]byte

32 bits, not strictly an integer, hence represented as 4 bytes (bytes not necessarily corresponding to versions)

func (Version) ToUint32 added in v0.8.2 

func (v Version) ToUint32() uint32

Source Files

View all Source files

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.