stateutil

Documentation

Overview

Package stateutil defines utility functions to compute state roots using advanced merkle branch caching techniques.package stateutil

Package stateutil defines utility functions to compute state roots using advanced merkle branch caching techniques.

Index

• func AddInMixin(root [32]byte, length uint64) ([32]byte, error)
• func AttestationDataRoot(data *ethpb.AttestationData) ([32]byte, error)
• func BlockBodyRoot(body *ethpb.BeaconBlockBody) ([32]byte, error)
• func BlockHeaderRoot(header *ethpb.BeaconBlockHeader) ([32]byte, error)
• func BlockRoot(blk *ethpb.BeaconBlock) ([32]byte, error)
• func ComputeFieldRoots(state *pb.BeaconState) ([][]byte, error)
• func Eth1DataVotesRoot(eth1DataVotes []*ethpb.Eth1Data) ([32]byte, error)
• func Eth1Root(hasher htrutils.HashFn, eth1Data *ethpb.Eth1Data) ([32]byte, error)
• func HashTreeRootState(state *pb.BeaconState) ([32]byte, error)
• func PendingAttestationRoot(hasher htrutils.HashFn, att *pb.PendingAttestation) ([32]byte, error)
• func RecomputeFromLayer(changedLeaves [][32]byte, changedIdx []uint64, layer [][]*[32]byte) ([32]byte, [][]*[32]byte, error)
• func RecomputeFromLayerVariable(changedLeaves [][32]byte, changedIdx []uint64, layer [][]*[32]byte) ([32]byte, [][]*[32]byte, error)
• func ReturnTrieLayer(elements [][32]byte, length uint64) [][]*[32]byte
• func ReturnTrieLayerVariable(elements [][32]byte, length uint64) [][]*[32]byte
• func RootsArrayHashTreeRoot(vals [][]byte, length uint64, fieldName string) ([32]byte, error)
• func ValidatorBalancesRoot(balances []uint64) ([32]byte, error)
• func ValidatorRegistryRoot(vals []*ethpb.Validator) ([32]byte, error)
• func ValidatorRoot(hasher htrutils.HashFn, validator *ethpb.Validator) ([32]byte, error)

Functions

func AddInMixin

func AddInMixin(root [32]byte, length uint64) ([32]byte, error)

AddInMixin describes a method from which a lenth mixin is added to the provided root.

func AttestationDataRoot

func AttestationDataRoot(data *ethpb.AttestationData) ([32]byte, error)

AttestationDataRoot describes a method that serves as a HashTreeRoot function for attestation data.

func BlockBodyRoot

func BlockBodyRoot(body *ethpb.BeaconBlockBody) ([32]byte, error)

BlockBodyRoot returns the hash tree root of the block body.

func BlockHeaderRoot

func BlockHeaderRoot(header *ethpb.BeaconBlockHeader) ([32]byte, error)

BlockHeaderRoot computes the HashTreeRoot Merkleization of a BeaconBlockHeader struct according to the eth2 Simple Serialize specification.

func BlockRoot

func BlockRoot(blk *ethpb.BeaconBlock) ([32]byte, error)

BlockRoot returns the block hash tree root of the provided block.

func ComputeFieldRoots

func ComputeFieldRoots(state *pb.BeaconState) ([][]byte, error)

ComputeFieldRoots returns the hash tree root computations of every field in the beacon state as a list of 32 byte roots.

func Eth1DataVotesRoot

func Eth1DataVotesRoot(eth1DataVotes []*ethpb.Eth1Data) ([32]byte, error)

Eth1DataVotesRoot computes the HashTreeRoot Merkleization of a list of Eth1Data structs according to the eth2 Simple Serialize specification.

func Eth1Root

func Eth1Root(hasher htrutils.HashFn, eth1Data *ethpb.Eth1Data) ([32]byte, error)

Eth1Root computes the HashTreeRoot Merkleization of a BeaconBlockHeader struct according to the eth2 Simple Serialize specification.

func HashTreeRootState

func HashTreeRootState(state *pb.BeaconState) ([32]byte, error)

HashTreeRootState provides a fully-customized version of ssz.HashTreeRoot for the BeaconState type of the official Ethereum Serenity specification. The reason for this particular function is to optimize for speed and memory allocation at the expense of complete specificity (that is, this function can only be used on the Prysm BeaconState data structure).

func PendingAttestationRoot

func PendingAttestationRoot(hasher htrutils.HashFn, att *pb.PendingAttestation) ([32]byte, error)

PendingAttestationRoot describes a method from which the hash tree root of a pending attestation is returned.

func RecomputeFromLayer

func RecomputeFromLayer(changedLeaves [][32]byte, changedIdx []uint64, layer [][]*[32]byte) ([32]byte, [][]*[32]byte, error)

RecomputeFromLayer recomputes specific branches of a fixed sized trie depending on the provided changed indexes.

func RecomputeFromLayerVariable

func RecomputeFromLayerVariable(changedLeaves [][32]byte, changedIdx []uint64, layer [][]*[32]byte) ([32]byte, [][]*[32]byte, error)

RecomputeFromLayerVariable recomputes specific branches of a variable sized trie depending on the provided changed indexes.

func ReturnTrieLayer

func ReturnTrieLayer(elements [][32]byte, length uint64) [][]*[32]byte

ReturnTrieLayer returns the representation of a merkle trie when provided with the elements of a fixed sized trie and the corresponding depth of it.

func ReturnTrieLayerVariable

func ReturnTrieLayerVariable(elements [][32]byte, length uint64) [][]*[32]byte

ReturnTrieLayerVariable returns the representation of a merkle trie when provided with the elements of a variable sized trie and the corresponding depth of it.

func RootsArrayHashTreeRoot

func RootsArrayHashTreeRoot(vals [][]byte, length uint64, fieldName string) ([32]byte, error)

RootsArrayHashTreeRoot computes the Merkle root of arrays of 32-byte hashes, such as [64][32]byte according to the Simple Serialize specification of eth2.

func ValidatorBalancesRoot

func ValidatorBalancesRoot(balances []uint64) ([32]byte, error)

ValidatorBalancesRoot computes the HashTreeRoot Merkleization of a list of validator uint64 balances according to the eth2 Simple Serialize specification.

func ValidatorRegistryRoot

func ValidatorRegistryRoot(vals []*ethpb.Validator) ([32]byte, error)

ValidatorRegistryRoot computes the HashTreeRoot Merkleization of a list of validator structs according to the eth2 Simple Serialize specification.

func ValidatorRoot

func ValidatorRoot(hasher htrutils.HashFn, validator *ethpb.Validator) ([32]byte, error)

ValidatorRoot describes a method from which the hash tree root of a validator is returned.