blocks

package
Version: v0.3.10 Latest Latest
Warning

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

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

Documentation

Overview

Package blocks contains block processing libraries. These libraries process and verify block specific messages such as PoW receipt root, RANDAO, validator deposits, exits and slashing proofs.

Index

Constants

This section is empty.

Variables

View Source
var ErrSigFailedToVerify = errors.New("signature did not verify")

ErrSigFailedToVerify returns when a signature of a block object(ie attestation, slashing, exit... etc) failed to verify.

Functions

func ClearEth1DataVoteCache

func ClearEth1DataVoteCache()

ClearEth1DataVoteCache clears the eth1 data vote count cache.

func Eth1DataHasEnoughSupport

func Eth1DataHasEnoughSupport(beaconState *stateTrie.BeaconState, data *ethpb.Eth1Data) (bool, error)

Eth1DataHasEnoughSupport returns true when the given eth1data has more than 50% votes in the eth1 voting period. A vote is cast by including eth1data in a block and part of state processing appends eth1data to the state in the Eth1DataVotes list. Iterating through this list checks the votes to see if they match the eth1data.

func IsSlashableAttestationData

func IsSlashableAttestationData(data1 *ethpb.AttestationData, data2 *ethpb.AttestationData) bool

IsSlashableAttestationData verifies a slashing against the Casper Proof of Stake FFG rules.

Spec pseudocode definition:

def is_slashable_attestation_data(data_1: AttestationData, data_2: AttestationData) -> bool:
 """
 Check if “data_1“ and “data_2“ are slashable according to Casper FFG rules.
 """
 return (
     # Double vote
     (data_1 != data_2 and data_1.target.epoch == data_2.target.epoch) or
     # Surround vote
     (data_1.source.epoch < data_2.source.epoch and data_2.target.epoch < data_1.target.epoch)
 )

func NewGenesisBlock

func NewGenesisBlock(stateRoot []byte) *ethpb.SignedBeaconBlock

NewGenesisBlock returns the canonical, genesis block for the beacon chain protocol.

func ProcessAttestation

func ProcessAttestation(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	att *ethpb.Attestation,
) (*stateTrie.BeaconState, error)

ProcessAttestation verifies an input attestation can pass through processing using the given beacon state.

Spec pseudocode definition:

def process_attestation(state: BeaconState, attestation: Attestation) -> None:
  data = attestation.data
  assert data.index < get_committee_count_at_slot(state, data.slot)
  assert data.target.epoch in (get_previous_epoch(state), get_current_epoch(state))
  assert data.target.epoch == compute_epoch_at_slot(data.slot)
  assert data.slot + MIN_ATTESTATION_INCLUSION_DELAY <= state.slot <= data.slot + SLOTS_PER_EPOCH

  committee = get_beacon_committee(state, data.slot, data.index)
  assert len(attestation.aggregation_bits) == len(committee)

  pending_attestation = PendingAttestation(
      data=data,
      aggregation_bits=attestation.aggregation_bits,
      inclusion_delay=state.slot - data.slot,
      proposer_index=get_beacon_proposer_index(state),
  )

  if data.target.epoch == get_current_epoch(state):
      assert data.source == state.current_justified_checkpoint
      state.current_epoch_attestations.append(pending_attestation)
  else:
      assert data.source == state.previous_justified_checkpoint
      state.previous_epoch_attestations.append(pending_attestation)

  # Check signature
  assert is_valid_indexed_attestation(state, get_indexed_attestation(state, attestation))

func ProcessAttestationNoVerify

func ProcessAttestationNoVerify(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	att *ethpb.Attestation,
) (*stateTrie.BeaconState, error)

ProcessAttestationNoVerify processes the attestation without verifying the attestation signature. This method is used to validate attestations whose signatures have already been verified.

func ProcessAttestations

func ProcessAttestations(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessAttestations applies processing operations to a block's inner attestation records. This function returns a list of pending attestations which can then be appended to the BeaconState's latest attestations.

func ProcessAttestationsNoVerify

func ProcessAttestationsNoVerify(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessAttestationsNoVerify applies processing operations to a block's inner attestation records. The only difference would be that the attestation signature would not be verified.

func ProcessAttesterSlashings

func ProcessAttesterSlashings(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessAttesterSlashings is one of the operations performed on each processed beacon block to slash attesters based on Casper FFG slashing conditions if any slashable events occurred.

Spec pseudocode definition:

def process_attester_slashing(state: BeaconState, attester_slashing: AttesterSlashing) -> None:
 attestation_1 = attester_slashing.attestation_1
 attestation_2 = attester_slashing.attestation_2
 assert is_slashable_attestation_data(attestation_1.data, attestation_2.data)
 assert is_valid_indexed_attestation(state, attestation_1)
 assert is_valid_indexed_attestation(state, attestation_2)

 slashed_any = False
 indices = set(attestation_1.attesting_indices).intersection(attestation_2.attesting_indices)
 for index in sorted(indices):
     if is_slashable_validator(state.validators[index], get_current_epoch(state)):
         slash_validator(state, index)
         slashed_any = True
 assert slashed_any

func ProcessBlockHeader

func ProcessBlockHeader(
	beaconState *stateTrie.BeaconState,
	block *ethpb.SignedBeaconBlock,
) (*stateTrie.BeaconState, error)

ProcessBlockHeader validates a block by its header.

Spec pseudocode definition:

 def process_block_header(state: BeaconState, block: BeaconBlock) -> None:
   # Verify that the slots match
   assert block.slot == state.slot
   # Verify that the parent matches
   assert block.parent_root == signing_root(state.latest_block_header)
   # Save current block as the new latest block
   state.latest_block_header = BeaconBlockHeader(
       slot=block.slot,
       parent_root=block.parent_root,
       # state_root: zeroed, overwritten in the next `process_slot` call
       body_root=hash_tree_root(block.body),
		  # signature is always zeroed
   )
   # Verify proposer is not slashed
   proposer = state.validators[get_beacon_proposer_index(state)]
   assert not proposer.slashed
   # Verify proposer signature
   assert bls_verify(proposer.pubkey, signing_root(block), block.signature, get_domain(state, DOMAIN_BEACON_PROPOSER))

func ProcessBlockHeaderNoVerify

func ProcessBlockHeaderNoVerify(
	beaconState *stateTrie.BeaconState,
	block *ethpb.BeaconBlock,
) (*stateTrie.BeaconState, error)

ProcessBlockHeaderNoVerify validates a block by its header but skips proposer signature verification.

WARNING: This method does not verify proposer signature. This is used for proposer to compute state root using a unsigned block.

Spec pseudocode definition:

 def process_block_header(state: BeaconState, block: BeaconBlock) -> None:
   # Verify that the slots match
   assert block.slot == state.slot
   # Verify that the parent matches
   assert block.parent_root == signing_root(state.latest_block_header)
   # Save current block as the new latest block
   state.latest_block_header = BeaconBlockHeader(
       slot=block.slot,
       parent_root=block.parent_root,
       # state_root: zeroed, overwritten in the next `process_slot` call
       body_root=hash_tree_root(block.body),
		  # signature is always zeroed
   )
   # Verify proposer is not slashed
   proposer = state.validators[get_beacon_proposer_index(state)]
   assert not proposer.slashed

func ProcessDeposit

func ProcessDeposit(
	beaconState *stateTrie.BeaconState,
	deposit *ethpb.Deposit,
) (*stateTrie.BeaconState, error)

ProcessDeposit takes in a deposit object and inserts it into the registry as a new validator or balance change.

Spec pseudocode definition: def process_deposit(state: BeaconState, deposit: Deposit) -> None:

# Verify the Merkle branch
assert is_valid_merkle_branch(
    leaf=hash_tree_root(deposit.data),
    branch=deposit.proof,
    depth=DEPOSIT_CONTRACT_TREE_DEPTH + 1,  # Add 1 for the `List` length mix-in
    index=state.eth1_deposit_index,
    root=state.eth1_data.deposit_root,
)

# Deposits must be processed in order
state.eth1_deposit_index += 1

pubkey = deposit.data.pubkey
amount = deposit.data.amount
validator_pubkeys = [v.pubkey for v in state.validators]
if pubkey not in validator_pubkeys:
    # Verify the deposit signature (proof of possession) for new validators.
    # Note: The deposit contract does not check signatures.
    # Note: Deposits are valid across forks, thus the deposit domain is retrieved directly from `compute_domain`.
    domain = compute_domain(DOMAIN_DEPOSIT)
    if not bls_verify(pubkey, signing_root(deposit.data), deposit.data.signature, domain):
        return

    # Add validator and balance entries
    state.validators.append(Validator(
        pubkey=pubkey,
        withdrawal_credentials=deposit.data.withdrawal_credentials,
        activation_eligibility_epoch=FAR_FUTURE_EPOCH,
        activation_epoch=FAR_FUTURE_EPOCH,
        exit_epoch=FAR_FUTURE_EPOCH,
        withdrawable_epoch=FAR_FUTURE_EPOCH,
        effective_balance=min(amount - amount % EFFECTIVE_BALANCE_INCREMENT, MAX_EFFECTIVE_BALANCE),
    ))
    state.balances.append(amount)
else:
    # Increase balance by deposit amount
    index = ValidatorIndex(validator_pubkeys.index(pubkey))
    increase_balance(state, index, amount)

func ProcessDeposits

func ProcessDeposits(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessDeposits is one of the operations performed on each processed beacon block to verify queued validators from the Ethereum 1.0 Deposit Contract into the beacon chain.

Spec pseudocode definition:

For each deposit in block.body.deposits:
  process_deposit(state, deposit)

func ProcessEth1DataInBlock

func ProcessEth1DataInBlock(beaconState *stateTrie.BeaconState, block *ethpb.BeaconBlock) (*stateTrie.BeaconState, error)

ProcessEth1DataInBlock is an operation performed on each beacon block to ensure the ETH1 data votes are processed into the beacon state.

Official spec definition:

def process_eth1_data(state: BeaconState, body: BeaconBlockBody) -> None:
 state.eth1_data_votes.append(body.eth1_data)
 if state.eth1_data_votes.count(body.eth1_data) * 2 > SLOTS_PER_ETH1_VOTING_PERIOD:
     state.latest_eth1_data = body.eth1_data

func ProcessPreGenesisDeposit added in v0.3.0

func ProcessPreGenesisDeposit(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	deposit *ethpb.Deposit,
) (*stateTrie.BeaconState, error)

ProcessPreGenesisDeposit processes a deposit for the beacon state before chainstart.

func ProcessProposerSlashings

func ProcessProposerSlashings(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessProposerSlashings is one of the operations performed on each processed beacon block to slash proposers based on slashing conditions if any slashable events occurred.

Spec pseudocode definition:

def process_proposer_slashing(state: BeaconState, proposer_slashing: ProposerSlashing) -> None:
 """
 Process “ProposerSlashing“ operation.
 """
 proposer = state.validator_registry[proposer_slashing.proposer_index]
 # Verify slots match
 assert proposer_slashing.header_1.slot == proposer_slashing.header_2.slot
 # But the headers are different
 assert proposer_slashing.header_1 != proposer_slashing.header_2
 # Check proposer is slashable
 assert is_slashable_validator(proposer, get_current_epoch(state))
 # Signatures are valid
 for header in (proposer_slashing.header_1, proposer_slashing.header_2):
     domain = get_domain(state, DOMAIN_BEACON_PROPOSER, slot_to_epoch(header.slot))
     assert bls_verify(proposer.pubkey, signing_root(header), header.signature, domain)

 slash_validator(state, proposer_slashing.proposer_index)

func ProcessRandao

func ProcessRandao(
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessRandao checks the block proposer's randao commitment and generates a new randao mix to update in the beacon state's latest randao mixes slice.

Spec pseudocode definition:

def process_randao(state: BeaconState, body: BeaconBlockBody) -> None:
  proposer = state.validator_registry[get_beacon_proposer_index(state)]
  # Verify that the provided randao value is valid
  assert bls_verify(
      proposer.pubkey,
      hash_tree_root(get_current_epoch(state)),
      body.randao_reveal,
      get_domain(state, DOMAIN_RANDAO),
  )
  # Mix it in
  state.latest_randao_mixes[get_current_epoch(state) % LATEST_RANDAO_MIXES_LENGTH] = (
      xor(get_randao_mix(state, get_current_epoch(state)),
          hash(body.randao_reveal))
  )

func ProcessRandaoNoVerify

func ProcessRandaoNoVerify(
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessRandaoNoVerify generates a new randao mix to update in the beacon state's latest randao mixes slice.

Spec pseudocode definition:

# Mix it in
state.latest_randao_mixes[get_current_epoch(state) % LATEST_RANDAO_MIXES_LENGTH] = (
    xor(get_randao_mix(state, get_current_epoch(state)),
        hash(body.randao_reveal))
)

func ProcessVoluntaryExits

func ProcessVoluntaryExits(
	ctx context.Context,
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessVoluntaryExits is one of the operations performed on each processed beacon block to determine which validators should exit the state's validator registry.

Spec pseudocode definition:

def process_voluntary_exit(state: BeaconState, exit: VoluntaryExit) -> None:
 """
 Process “VoluntaryExit“ operation.
 """
 validator = state.validator_registry[exit.validator_index]
 # Verify the validator is active
 assert is_active_validator(validator, get_current_epoch(state))
 # Verify the validator has not yet exited
 assert validator.exit_epoch == FAR_FUTURE_EPOCH
 # Exits must specify an epoch when they become valid; they are not valid before then
 assert get_current_epoch(state) >= exit.epoch
 # Verify the validator has been active long enough
 assert get_current_epoch(state) >= validator.activation_epoch + PERSISTENT_COMMITTEE_PERIOD
 # Verify signature
 domain = get_domain(state, DOMAIN_VOLUNTARY_EXIT, exit.epoch)
 assert bls_verify(validator.pubkey, signing_root(exit), exit.signature, domain)
 # Initiate exit
 initiate_validator_exit(state, exit.validator_index)

func ProcessVoluntaryExitsNoVerify

func ProcessVoluntaryExitsNoVerify(
	beaconState *stateTrie.BeaconState,
	body *ethpb.BeaconBlockBody,
) (*stateTrie.BeaconState, error)

ProcessVoluntaryExitsNoVerify processes all the voluntary exits in a block body, without verifying their BLS signatures.

func VerifyAttestation

func VerifyAttestation(ctx context.Context, beaconState *stateTrie.BeaconState, att *ethpb.Attestation) error

VerifyAttestation converts and attestation into an indexed attestation and verifies the signature in that attestation.

func VerifyAttesterSlashing

func VerifyAttesterSlashing(ctx context.Context, beaconState *stateTrie.BeaconState, slashing *ethpb.AttesterSlashing) error

VerifyAttesterSlashing validates the attestation data in both attestations in the slashing object.

func VerifyExit

func VerifyExit(validator *ethpb.Validator, currentSlot uint64, fork *pb.Fork, signed *ethpb.SignedVoluntaryExit) error

VerifyExit implements the spec defined validation for voluntary exits.

Spec pseudocode definition:

def process_voluntary_exit(state: BeaconState, exit: VoluntaryExit) -> None:
 """
 Process “VoluntaryExit“ operation.
 """
 validator = state.validator_registry[exit.validator_index]
 # Verify the validator is active
 assert is_active_validator(validator, get_current_epoch(state))
 # Verify the validator has not yet exited
 assert validator.exit_epoch == FAR_FUTURE_EPOCH
 # Exits must specify an epoch when they become valid; they are not valid before then
 assert get_current_epoch(state) >= exit.epoch
 # Verify the validator has been active long enough
 assert get_current_epoch(state) >= validator.activation_epoch + PERSISTENT_COMMITTEE_PERIOD
 # Verify signature
 domain = get_domain(state, DOMAIN_VOLUNTARY_EXIT, exit.epoch)
 assert bls_verify(validator.pubkey, signing_root(exit), exit.signature, domain)

func VerifyIndexedAttestation

func VerifyIndexedAttestation(ctx context.Context, beaconState *stateTrie.BeaconState, indexedAtt *ethpb.IndexedAttestation) error

VerifyIndexedAttestation determines the validity of an indexed attestation.

Spec pseudocode definition:

def is_valid_indexed_attestation(state: BeaconState, indexed_attestation: IndexedAttestation) -> bool:
  """
  Check if “indexed_attestation“ has valid indices and signature.
  """
  indices = indexed_attestation.attesting_indices

  # Verify max number of indices
  if not len(indices) <= MAX_VALIDATORS_PER_COMMITTEE:
      return False
  # Verify indices are sorted and unique
      if not indices == sorted(set(indices)):
  # Verify aggregate signature
  if not bls_verify(
      pubkey=bls_aggregate_pubkeys([state.validators[i].pubkey for i in indices]),
      message_hash=hash_tree_root(indexed_attestation.data),
      signature=indexed_attestation.signature,
      domain=get_domain(state, DOMAIN_BEACON_ATTESTER, indexed_attestation.data.target.epoch),
  ):
      return False
  return True

func VerifyProposerSlashing

func VerifyProposerSlashing(
	beaconState *stateTrie.BeaconState,
	slashing *ethpb.ProposerSlashing,
) error

VerifyProposerSlashing verifies that the data provided fro slashing is valid.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL