bls

Documentation

Index

• Constants
• Variables
• type PrivateKey
  • func CreateRandomBlsKeys(total int) ([]*PrivateKey, error)
  • func GenerateBlsKey() (*PrivateKey, error)
  • func NewZeroPrivateKey() *PrivateKey
  • func UnmarshalPrivateKey(data []byte) (*PrivateKey, error)
  • func (p *PrivateKey) Marshal() ([]byte, error)
  • func (p *PrivateKey) PublicKey() *PublicKey
  • func (p *PrivateKey) Sign(message, domain []byte) (*Signature, error)
• type PublicKey
  • func UnmarshalPublicKey(data []byte) (*PublicKey, error)
  • func UnmarshalPublicKeyFromBigInt(b [4]*big.Int) (*PublicKey, error)
  • func (p *PublicKey) Marshal() []byte
  • func (p *PublicKey) MarshalText() ([]byte, error)
  • func (p *PublicKey) ToBigInt() [4]*big.Int
  • func (p *PublicKey) UnmarshalText(buf []byte) error
• type PublicKeys
  • func (pks PublicKeys) Aggregate() *PublicKey
• type Signature
  • func UnmarshalSignature(raw []byte) (*Signature, error)
  • func (s *Signature) Marshal() ([]byte, error)
  • func (s Signature) ToBigInt() ([2]*big.Int, error)
  • func (s *Signature) Verify(pub *PublicKey, message, domain []byte) bool
  • func (s *Signature) VerifyAggregated(publicKeys []*PublicKey, msg, domain []byte) bool
• type Signatures
  • func (sigs Signatures) Aggregate() *Signature

Constants

const (
	PublicKeySize = 128
)

const (
	SignatureSize = 64
)

Variables

var (
	ErrInvalidPublicKeySize = fmt.Errorf("public key must be %d bytes long", PublicKeySize)
)

var (
	ErrInvalidSignatureSize = fmt.Errorf("signature must be %d bytes long", SignatureSize)
)

Types

type PrivateKey

type PrivateKey struct {
	// contains filtered or unexported fields
}

PrivateKey holds private key for bls implementation

func CreateRandomBlsKeys

func CreateRandomBlsKeys(total int) ([]*PrivateKey, error)

CreateRandomBlsKeys creates an array of random private and their corresponding public keys

func GenerateBlsKey

func GenerateBlsKey() (*PrivateKey, error)

GenerateBlsKey creates a random private key (and its corresponding public key)

func NewZeroPrivateKey

func NewZeroPrivateKey() *PrivateKey

NewZeroPrivateKey is the constructor of an empty PrivateKey

func UnmarshalPrivateKey

func UnmarshalPrivateKey(data []byte) (*PrivateKey, error)

UnmarshalPrivateKey unmarshals the private key from the given byte slice. This function supports both raw big int string and hex-encoded big int string.

func (*PrivateKey) Marshal

func (p *PrivateKey) Marshal() ([]byte, error)

Marshal marshals private key hex (without 0x prefix) represented as a byte slice

func (*PrivateKey) PublicKey

func (p *PrivateKey) PublicKey() *PublicKey

PublicKey returns the public key from the PrivateKey

func (*PrivateKey) Sign

func (p *PrivateKey) Sign(message, domain []byte) (*Signature, error)

Sign generates a simple BLS signature of the given message

type PublicKey

type PublicKey struct {
	// contains filtered or unexported fields
}

PublicKey represents bls public key

func UnmarshalPublicKey

func UnmarshalPublicKey(data []byte) (*PublicKey, error)

UnmarshalPublicKey unmarshals bytes to public key

func UnmarshalPublicKeyFromBigInt

func UnmarshalPublicKeyFromBigInt(b [4]*big.Int) (*PublicKey, error)

UnmarshalPublicKeyFromBigInt unmarshals public key from 4 big ints Order of coordinates is [A.Y, A.X, B.Y, B.X]

func (*PublicKey) Marshal

func (p *PublicKey) Marshal() []byte

Marshal marshal the key to bytes.

func (*PublicKey) MarshalText

func (p *PublicKey) MarshalText() ([]byte, error)

MarshalText implements the json.Marshaler interface.

func (*PublicKey) ToBigInt

func (p *PublicKey) ToBigInt() [4]*big.Int

ToBigInt converts public key to 4 big ints

func (*PublicKey) UnmarshalText

func (p *PublicKey) UnmarshalText(buf []byte) error

UnmarshalText implements encoding.TextMarshaler interface

type PublicKeys

type PublicKeys []*PublicKey

func (PublicKeys) Aggregate

func (pks PublicKeys) Aggregate() *PublicKey

Aggregate aggregates all public keys into one

type Signature

type Signature struct {
	// contains filtered or unexported fields
}

Signature represents bls signature which is point on the curve

func UnmarshalSignature

func UnmarshalSignature(raw []byte) (*Signature, error)

UnmarshalSignature reads the signature from the given byte array

func (*Signature) Marshal

func (s *Signature) Marshal() ([]byte, error)

Marshal the signature to bytes.

func (Signature) ToBigInt

func (s Signature) ToBigInt() ([2]*big.Int, error)

ToBigInt marshalls signature (which is point) to 2 big ints - one for each coordinate

func (*Signature) Verify

func (s *Signature) Verify(pub *PublicKey, message, domain []byte) bool

Verify checks the BLS signature of the message against the public key of its signer

func (*Signature) VerifyAggregated

func (s *Signature) VerifyAggregated(publicKeys []*PublicKey, msg, domain []byte) bool

VerifyAggregated checks the BLS signature of the message against the aggregated public keys of its signers

type Signatures

type Signatures []*Signature

Signatures is a slice of signatures

func (Signatures) Aggregate

func (sigs Signatures) Aggregate() *Signature

Aggregate aggregates all signatures into one