pkg

Documentation

Index

• type B
• type E
• type Generator
• type N
• type S
• type Signer

Types

type B

type B = []byte

type E

type E = error

type Generator

type Generator interface {
	// Generate gathers entropy and derives pubkey bytes for matching, this returns the 33 byte compressed form for
	// checking the oddness of the Y coordinate.
	Generate() (pubBytes B, err E)
	// Negate flips the public key Y coordinate between odd and even.
	Negate()
	// KeyPairBytes returns the raw bytes of the secret and public key, this returns the 32 byte X-only pubkey.
	KeyPairBytes() (secBytes, cmprPubBytes B)
}

Generator is an interface for nost BIP-340 key mining.

type N

type N = int

type S

type S = string

type Signer

type Signer interface {
	// Generate creates a fresh new key pair from system entropy, and ensures it is even (so ECDH works).
	Generate() (err E)
	// InitSec initialises the secret (signing) key from the raw bytes, and also
	// derives the public key because it can.
	InitSec(sec B) (err E)
	// InitPub initializes the public (verification) key from raw bytes.
	InitPub(pub B) (err E)
	// Sec returns the secret key bytes.
	Sec() B
	// Pub returns the public key bytes (x-only schnorr pubkey).
	Pub() B
	// ECPub returns the public key bytes (33 byte ecdsa pubkey). The first byte is always 2 due to ECDH and X-only
	// keys.
	ECPub() B
	// Sign creates a signature using the stored secret key.
	Sign(msg B) (sig B, err E)
	// Verify checks a message hash and signature match the stored public key.
	Verify(msg, sig B) (valid bool, err E)
	// Zero wipes the secret key to prevent memory leaks.
	Zero()
	// ECDH returns a shared secret derived using Elliptic Curve Diffie Hellman on the Signer secret and provided
	// pubkey.
	ECDH(pub B) (secret B, err E)
	// Negate flips the the secret key to change between odd and even compressed public key.
	Negate()
}