bls

Documentation

Overview

Package bls implements a go-wrapper around a library implementing the the BLS12-381 curve and signature scheme. This package exposes a public API for verifying and aggregating BLS signatures used by Ethereum.

Index

• Constants
• func AggregateSignatures(sigs []common.Signature) common.Signature
• func NewAggregateSignature() common.Signature
• func RandKey() (common.SecretKey, error)
• func VerifyMultipleSignatures(sigs [][]byte, msgs [][32]byte, pubKeys []common.PublicKey) (bool, error)
• type PublicKey
  • func AggregatePublicKeys(pubs [][]byte) (PublicKey, error)
  • func PublicKeyFromBytes(pubKey []byte) (PublicKey, error)
• type SecretKey
  • func SecretKeyFromBigNum(s string) (SecretKey, error)
  • func SecretKeyFromBytes(privKey []byte) (SecretKey, error)
• type Signature
  • func SignatureFromBytes(sig []byte) (Signature, error)
• type SignatureSet
  • func NewSet() *SignatureSet
  • func (s *SignatureSet) Copy() *SignatureSet
  • func (s *SignatureSet) Join(set *SignatureSet) *SignatureSet
  • func (s *SignatureSet) Verify() (bool, error)

Constants

const CurveOrder = "52435875175126190479447740508185965837690552500527637822603658699938581184513"

CurveOrder for the BLS12-381 curve.

const DomainByteLength = 4

DomainByteLength length of domain byte array.

Functions

func AggregateSignatures

func AggregateSignatures(sigs []common.Signature) common.Signature

AggregateSignatures converts a list of signatures into a single, aggregated sig.

func NewAggregateSignature

func NewAggregateSignature() common.Signature

NewAggregateSignature creates a blank aggregate signature.

func RandKey

func RandKey() (common.SecretKey, error)

RandKey creates a new private key using a random input.

func VerifyMultipleSignatures

func VerifyMultipleSignatures(sigs [][]byte, msgs [][32]byte, pubKeys []common.PublicKey) (bool, error)

VerifyMultipleSignatures verifies multiple signatures for distinct messages securely.

Types

type PublicKey

type PublicKey = common.PublicKey

PublicKey represents a BLS public key.

func AggregatePublicKeys

func AggregatePublicKeys(pubs [][]byte) (PublicKey, error)

AggregatePublicKeys aggregates the provided raw public keys into a single key.

func PublicKeyFromBytes

func PublicKeyFromBytes(pubKey []byte) (PublicKey, error)

PublicKeyFromBytes creates a BLS public key from a BigEndian byte slice.

type SecretKey

type SecretKey = common.SecretKey

SecretKey represents a BLS secret or private key.

func SecretKeyFromBigNum

func SecretKeyFromBigNum(s string) (SecretKey, error)

SecretKeyFromBigNum takes in a big number string and creates a BLS private key.

func SecretKeyFromBytes

func SecretKeyFromBytes(privKey []byte) (SecretKey, error)

SecretKeyFromBytes creates a BLS private key from a BigEndian byte slice.

type Signature

type Signature = common.Signature

Signature represents a BLS signature.

func SignatureFromBytes

func SignatureFromBytes(sig []byte) (Signature, error)

SignatureFromBytes creates a BLS signature from a LittleEndian byte slice.

type SignatureSet

type SignatureSet struct {
	Signatures [][]byte
	PublicKeys []PublicKey
	Messages   [][32]byte
}

SignatureSet refers to the defined set of signatures and its respective public keys and messages required to verify it.

func NewSet

func NewSet() *SignatureSet

NewSet constructs an empty signature set object.

func (*SignatureSet) Copy

func (s *SignatureSet) Copy() *SignatureSet

Copy the attached signature set and return it to the caller.

func (*SignatureSet) Join

func (s *SignatureSet) Join(set *SignatureSet) *SignatureSet

Join merges the provided signature set to out current one.

func (*SignatureSet) Verify

func (s *SignatureSet) Verify() (bool, error)

Verify the current signature set using the batch verify algorithm.