vrf

Documentation

Overview

NOTE: At the time of implementation, the VRF library is only used with consensus, but may be extracted into shared/crypto when/if it will be needed elsewhere.

Index

• Constants
• Variables
• func CreateVRFRandReader(lastBlockHash string, privKey crypto.PrivateKey) (io.Reader, error)
• func ErrBadAppHashLength(seedSize int) error
• func GenerateVRFKeys(reader io.Reader) (*SecretKey, *VerificationKey, error)
• type SecretKey
  • func (key *SecretKey) Bytes() []byte
  • func (key *SecretKey) Prove(msg []byte) (vrf VRFOutput, proof VRFProof, err error)
  • func (key *SecretKey) VerificationKey() (*VerificationKey, error)
• type VRFOutput
• type VRFProof
• type VerificationKey
  • func VerificationKeyFromBytes(data []byte) (*VerificationKey, error)
  • func (key *VerificationKey) Bytes() []byte
  • func (key *VerificationKey) Verify(msg []byte, vrfProof VRFProof, vrfOut VRFOutput) (verified bool, err error)

Constants

const (
	NilPrivateKeyError    = "private key cannot be nil"
	BadAppHashLengthError = "the last block hash must be at least %d bytes in length"
)

const (
	VRFOutputSize = sha512.Size // See github.com/ProtonMail/go-ecvrf for details
)

Variables

var (
	ErrNilPrivateKey = errors.New(NilPrivateKeyError)
)

Functions

func CreateVRFRandReader

func CreateVRFRandReader(lastBlockHash string, privKey crypto.PrivateKey) (io.Reader, error)

func ErrBadAppHashLength

func ErrBadAppHashLength(seedSize int) error

func GenerateVRFKeys

func GenerateVRFKeys(reader io.Reader) (*SecretKey, *VerificationKey, error)

Types

type SecretKey

type SecretKey ecvrf.PrivateKey

func (*SecretKey) Bytes

func (key *SecretKey) Bytes() []byte

func (*SecretKey) Prove

func (key *SecretKey) Prove(msg []byte) (vrf VRFOutput, proof VRFProof, err error)

func (*SecretKey) VerificationKey

func (key *SecretKey) VerificationKey() (*VerificationKey, error)

type VRFOutput

type VRFOutput []byte // Uniformally distributed output that can be normalized to be used in a binomial distribution.

type VRFProof

type VRFProof []byte // A proof to verify that VRFOutput belongs to a certain publicKey.

These are slices rather than arrays in order to more easily comply with the underlying `go-ecvrf/ecvrf` library.

type VerificationKey

type VerificationKey ecvrf.PublicKey

func VerificationKeyFromBytes

func VerificationKeyFromBytes(data []byte) (*VerificationKey, error)

func (*VerificationKey) Bytes

func (key *VerificationKey) Bytes() []byte

func (*VerificationKey) Verify

func (key *VerificationKey) Verify(msg []byte, vrfProof VRFProof, vrfOut VRFOutput) (verified bool, err error)