sr25519

package

v0.38.7 Latest Latest Go to latest Published: Apr 27, 2024 License: Apache-2.0 Imports: 8 Imported by: 13

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cometbft/cometbft

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewBatchVerifier() crypto.BatchVerifier
type BatchVerifier
- func (b *BatchVerifier) Add(key crypto.PubKey, msg, signature []byte) error
- func (b *BatchVerifier) Verify() (bool, []bool)
type PrivKey
- func GenPrivKey() PrivKey
- func GenPrivKeyFromSecret(secret []byte) PrivKey
type PubKey

Constants ¶

View Source

const (
	PrivKeyName = "tendermint/PrivKeySr25519"
	PubKeyName  = "tendermint/PubKeySr25519"
)

View Source

const (
	// PrivKeySize is the number of bytes in an Sr25519 private key.
	PrivKeySize = 32

	KeyType = "sr25519"
)

View Source

const (
	// PubKeySize is the number of bytes in an Sr25519 public key.
	PubKeySize = 32

	// SignatureSize is the size of a Sr25519 signature in bytes.
	SignatureSize = 64
)

Variables ¶

This section is empty.

Functions ¶

func NewBatchVerifier ¶ added in v0.38.0

func NewBatchVerifier() crypto.BatchVerifier

Types ¶

type BatchVerifier ¶ added in v0.38.0

type BatchVerifier struct {
	*sr25519.BatchVerifier
}

BatchVerifier implements batch verification for sr25519.

func (*BatchVerifier) Add ¶ added in v0.38.0

func (b *BatchVerifier) Add(key crypto.PubKey, msg, signature []byte) error

func (*BatchVerifier) Verify ¶ added in v0.38.0

func (b *BatchVerifier) Verify() (bool, []bool)

type PrivKey ¶

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

PrivKey implements crypto.PrivKey.

func GenPrivKey ¶

func GenPrivKey() PrivKey

GenPrivKey generates a new sr25519 private key. It uses OS randomness in conjunction with the current global random seed in cometbft/libs/rand to generate the private key.

func GenPrivKeyFromSecret ¶

func GenPrivKeyFromSecret(secret []byte) PrivKey

GenPrivKeyFromSecret hashes the secret with SHA2, and uses that 32 byte output to create the private key. NOTE: secret should be the output of a KDF like bcrypt, if it's derived from user input.

func (PrivKey) Bytes ¶

func (privKey PrivKey) Bytes() []byte

Bytes returns the byte representation of the PrivKey.

func (PrivKey) Equals ¶

func (privKey PrivKey) Equals(other crypto.PrivKey) bool

Equals - you probably don't need to use this. Runs in constant time based on length of the keys.

func (PrivKey) MarshalJSON ¶ added in v0.38.0

func (privKey PrivKey) MarshalJSON() ([]byte, error)

func (PrivKey) PubKey ¶

func (privKey PrivKey) PubKey() crypto.PubKey

PubKey gets the corresponding public key from the private key.

func (PrivKey) Sign ¶

func (privKey PrivKey) Sign(msg []byte) ([]byte, error)

Sign produces a signature on the provided message.

func (PrivKey) Type ¶

func (privKey PrivKey) Type() string

func (*PrivKey) UnmarshalJSON ¶ added in v0.38.0

func (privKey *PrivKey) UnmarshalJSON(data []byte) error

type PubKey ¶

type PubKey []byte

PubKey implements crypto.PubKey for the Sr25519 signature scheme.

func (PubKey) Address ¶

func (pubKey PubKey) Address() crypto.Address

Address is the SHA256-20 of the raw pubkey bytes.

func (PubKey) Bytes ¶

func (pubKey PubKey) Bytes() []byte

Bytes returns the byte representation of the PubKey.

func (PubKey) Equals ¶

func (pubKey PubKey) Equals(other crypto.PubKey) bool

Equals - checks that two public keys are the same time Runs in constant time based on length of the keys.

func (PubKey) String ¶

func (pubKey PubKey) String() string

func (PubKey) Type ¶

func (pubKey PubKey) Type() string

func (PubKey) VerifySignature ¶

func (pubKey PubKey) VerifySignature(msg []byte, sigBytes []byte) bool

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL