nip19

Documentation

Index

• Constants
• func ConvertForBech32(b8 []byte) (b5 []byte, e error)
• func ConvertFromBech32(b5 []byte) (b8 []byte, e error)
• func Decode(bech32string string) (prefix string, value any, e error)
• func DecodeSignature(encoded string) (sig *schnorr.Signature, e error)
• func DecodeToString(bech32String string) (prefix, value string, e error)
• func EncodeEntity(publicKey string, kind kind.T, identifier string, relays []string) (s string, e error)
• func EncodeEvent(eventIDHex string, relays []string, author string) (s string, e error)
• func EncodeNote(eventIDHex string) (s string, e error)
• func EncodePrivateKey(privateKeyHex string) (string, error)
• func EncodeProfile(publicKeyHex string, relays []string) (s string, e error)
• func EncodePublicKey(publicKeyHex string) (s string, e error)
• func EncodeSignature(sig *schnorr.Signature) (str string, e error)
• func GetPublicKey(sk string) (s string, e error)
• func HexToPublicKey(pk string) (p *btcec.PublicKey, e error)
• func HexToSecretKey(sk string) (s *btcec.SecretKey, e error)
• func NpubToPublicKey(encoded string) (pk *secp.PublicKey, e error)
• func NsecToSecretKey(encoded string) (sk *secp.SecretKey, e error)
• func PublicKeyToNpub(pk *secp.PublicKey) (encoded string, e error)
• func SecretKeyToNsec(sk *secp.SecretKey) (encoded string, e error)

Constants

const (
	// MinKeyStringLen is 56 because Bech32 needs 52 characters plus 4 for the HRP,
	// any string shorter than this cannot be a nostr key.
	MinKeyStringLen = 56
	HexKeyLen       = 64
	Bech32HRPLen    = 4
	SecHRP          = "nsec"
	PubHRP          = "npub"
	SigHRP          = "nsig"
)

const (
	NoteHRP     = "note"
	NsecHRP     = "nsec"
	NpubHRP     = "npub"
	NprofileHRP = "nprofile"
	NeventHRP   = "nevent"
	NentityHRP  = "naddr"
)

const (
	TLVDefault uint8 = 0
	TLVRelay   uint8 = 1
	TLVAuthor  uint8 = 2
	TLVKind    uint8 = 3
)

Functions

func ConvertForBech32

func ConvertForBech32(b8 []byte) (b5 []byte, e error)

ConvertForBech32 performs the bit expansion required for encoding into Bech32.

func ConvertFromBech32

func ConvertFromBech32(b5 []byte) (b8 []byte, e error)

ConvertFromBech32 collapses together the bit expanded 5 bit numbers encoded in bech32.

func Decode

func Decode(bech32string string) (prefix string, value any, e error)

func DecodeSignature

func DecodeSignature(encoded string) (sig *schnorr.Signature, e error)

DecodeSignature decodes a Bech32 encoded nsig nostr (schnorr) signature into its runtime binary form.

func DecodeToString

func DecodeToString(bech32String string) (prefix, value string, e error)

func EncodeEntity

func EncodeEntity(publicKey string, kind kind.T, identifier string,
	relays []string) (s string, e error)

func EncodeEvent

func EncodeEvent(eventIDHex string, relays []string,
	author string) (s string, e error)

func EncodeNote

func EncodeNote(eventIDHex string) (s string, e error)

func EncodePrivateKey

func EncodePrivateKey(privateKeyHex string) (string, error)

func EncodeProfile

func EncodeProfile(publicKeyHex string, relays []string) (s string, e error)

func EncodePublicKey

func EncodePublicKey(publicKeyHex string) (s string, e error)

func EncodeSignature

func EncodeSignature(sig *schnorr.Signature) (str string, e error)

EncodeSignature encodes a schnorr signature as Bech32 with the HRP "nsig" to be consistent with the key encodings 4 characters starting with 'n'.

func GetPublicKey

func GetPublicKey(sk string) (s string, e error)

func HexToPublicKey

func HexToPublicKey(pk string) (p *btcec.PublicKey, e error)

HexToPublicKey decodes a string that should be a 64 character long hex encoded public key into a btcec.PublicKey that can be used to verify a signature or encode to Bech32.

func HexToSecretKey

func HexToSecretKey(sk string) (s *btcec.SecretKey, e error)

HexToSecretKey decodes a string that should be a 64 character long hex encoded public key into a btcec.PublicKey that can be used to verify a signature or encode to Bech32.

func NpubToPublicKey

func NpubToPublicKey(encoded string) (pk *secp.PublicKey, e error)

NpubToPublicKey decodes an nostr public key (npub) and returns an secp256k1 public key.

func NsecToSecretKey

func NsecToSecretKey(encoded string) (sk *secp.SecretKey, e error)

NsecToSecretKey decodes a nostr secret key (nsec) and returns the secp256k1 secret key.

func PublicKeyToNpub

func PublicKeyToNpub(pk *secp.PublicKey) (encoded string, e error)

PublicKeyToNpub encodes a public kxey as a bech32 string (npub).

func SecretKeyToNsec

func SecretKeyToNsec(sk *secp.SecretKey) (encoded string, e error)

SecretKeyToNsec encodes an secp256k1 secret key as a Bech32 string (nsec).