crypto

Documentation

Index

• Constants
• Variables
• type Address
  • func AddressFromString(text string) (Address, error)
  • func NewAddress(typ AddressType, data []byte) Address
  • func (addr Address) Bytes() []byte
  • func (addr *Address) Decode(r io.Reader) error
  • func (addr Address) Encode(w io.Writer) error
  • func (addr Address) IsAccountAddress() bool
  • func (addr Address) IsTreasuryAddress() bool
  • func (addr Address) IsValidatorAddress() bool
  • func (addr Address) SerializeSize() int
  • func (addr Address) ShortString() string
  • func (addr Address) String() string
  • func (addr Address) Type() AddressType
• type AddressMismatchError
  • func (e AddressMismatchError) Error() string
• type AddressType
• type InvalidAddressTypeError
  • func (e InvalidAddressTypeError) Error() string
• type InvalidHRPError
  • func (e InvalidHRPError) Error() string
• type InvalidLengthError
  • func (e InvalidLengthError) Error() string
• type PrivateKey
• type PublicKey
• type Signature

Constants

const (
	SignatureTypeTreasury byte = 0
	SignatureTypeBLS      byte = 1
)

const (
	AddressSize = 21
)

Variables

var (
	// AddressHRP is the Human Readable Part (HRP) for address.
	AddressHRP = "pc"
	// PublicKeyHRP is the Human Readable Part (HRP) for public key.
	PublicKeyHRP = "public"
	// PrivateKeyHRP is the Human Readable Part (HRP) for private key.
	PrivateKeyHRP = "secret"
	// XPublicKeyHRP is the Human Readable Part (HRP) for extended public key.
	XPublicKeyHRP = "xpublic"
	// XPrivateKeyHRP is the Human Readable Part (HRP) for extended private key.
	XPrivateKeyHRP = "xsecret"
)

var ErrInvalidSignature = errors.New("invalid signature")

ErrInvalidSignature is returned when a signature is invalid.

var TreasuryAddress = Address{0}

Types

type Address

type Address [AddressSize]byte

func AddressFromString

func AddressFromString(text string) (Address, error)

AddressFromString decodes the string encoding of an address and returns the Address if text is a valid encoding for a known address type.

func NewAddress

func NewAddress(typ AddressType, data []byte) Address

NewAddress create a new address based.

func (Address) Bytes

func (addr Address) Bytes() []byte

Bytes returns the 21 bytes of the address data.

func (*Address) Decode

func (addr *Address) Decode(r io.Reader) error

func (Address) Encode

func (addr Address) Encode(w io.Writer) error

func (Address) IsAccountAddress

func (addr Address) IsAccountAddress() bool

func (Address) IsTreasuryAddress

func (addr Address) IsTreasuryAddress() bool

func (Address) IsValidatorAddress

func (addr Address) IsValidatorAddress() bool

func (Address) SerializeSize

func (addr Address) SerializeSize() int

SerializeSize returns the number of bytes it would take to serialize the address.

func (Address) ShortString

func (addr Address) ShortString() string

ShortString returns a short string for the address useful for logger.

func (Address) String

func (addr Address) String() string

String returns a human-readable string for the address.

func (Address) Type

func (addr Address) Type() AddressType

type AddressMismatchError

type AddressMismatchError struct {
	Expected Address
	Got      Address
}

AddressMismatchError is returned when the provided address is not derived from the corresponding public key.

func (AddressMismatchError) Error

func (e AddressMismatchError) Error() string

type AddressType

type AddressType byte

const (
	AddressTypeTreasury   AddressType = 0
	AddressTypeValidator  AddressType = 1
	AddressTypeBLSAccount AddressType = 2
)

type InvalidAddressTypeError

type InvalidAddressTypeError int

InvalidAddressTypeError is returned when the address type is not recognized or supported.

func (InvalidAddressTypeError) Error

func (e InvalidAddressTypeError) Error() string

type InvalidHRPError

type InvalidHRPError string

InvalidHRPError is returned when the provided HRP code does not match the expected value.

func (InvalidHRPError) Error

func (e InvalidHRPError) Error() string

type InvalidLengthError

type InvalidLengthError int

InvalidLengthError is returned when the length of the data does not match the expected length.

func (InvalidLengthError) Error

func (e InvalidLengthError) Error() string

type PrivateKey

type PrivateKey interface {
	Bytes() []byte
	String() string
	Sign(msg []byte) Signature
	PublicKey() PublicKey
	EqualsTo(right PrivateKey) bool
}

type PublicKey

type PublicKey interface {
	Bytes() []byte
	String() string
	MarshalCBOR() ([]byte, error)
	UnmarshalCBOR([]byte) error
	Encode(io.Writer) error
	Decode(io.Reader) error
	Verify(msg []byte, sig Signature) error
	VerifyAddress(addr Address) error
	EqualsTo(right PublicKey) bool
}

type Signature

type Signature interface {
	Bytes() []byte
	String() string
	MarshalCBOR() ([]byte, error)
	UnmarshalCBOR([]byte) error
	Encode(io.Writer) error
	Decode(io.Reader) error
	EqualsTo(right Signature) bool
}