nostrbinary

Documentation

Overview

Package nostrbinary provides a simple interface for using Gob encoding on nostr events.

Index

• func Marshal(evt *event.T) (b []byte, err error)
• func Unmarshal(data []byte) (evt *event.T, err error)
• type Event
  • func FromEventT(evt *event.T) (evb *Event, err error)
  • func (evb *Event) ToEventT() (evt *event.T)

Functions

func Marshal

func Marshal(evt *event.T) (b []byte, err error)

func Unmarshal

func Unmarshal(data []byte) (evt *event.T, err error)

Types

type Event

type Event struct {
	ID        [sha256.Size]byte
	PubKey    [schnorr.PubKeyBytesLen]byte
	CreatedAt timestamp.T
	Kind      kind.T
	Tags      tags.T
	Content   string
	Sig       [schnorr.SignatureSize]byte
}

Event is the most compact and exact form of an event as encoded in native Go form. This will produce the most compact form of Gob encoded binary data.

func FromEventT

func FromEventT(evt *event.T) (evb *Event, err error)

FromEventT converts an event.T into an Event, including validating all fields are correctly formed for their type.

func (*Event) ToEventT

func (evb *Event) ToEventT() (evt *event.T)

ToEventT converts an Event into an event.T.