event

Documentation

Index

• type Event
  • func Decode(b []byte) (*Event, error)
  • func (e *Event) Difficulty() int
  • func (e *Event) Encode() ([]byte, error)
  • func (e *Event) GetRawID() [32]byte
  • func (e *Event) IsProtected() bool
  • func (e *Event) IsValid(id [32]byte) bool
  • func (e Event) MarshalEasyJSON(w *jwriter.Writer)
  • func (e Event) MarshalJSON() ([]byte, error)
  • func (e *Event) Serialize() []byte
  • func (e *Event) String() string
  • func (e *Event) UnmarshalEasyJSON(l *jlexer.Lexer)
  • func (e *Event) UnmarshalJSON(data []byte) error

Types

type Event

type Event struct {
	ID        string     `bson:"id"         json:"id"`
	PublicKey string     `bson:"pubkey"     json:"pubkey"`
	CreatedAt int64      `bson:"created_at" json:"created_at"`
	Kind      types.Kind `bson:"kind"       json:"kind"`
	Tags      types.Tags `bson:"tags"       json:"tags"`
	Content   string     `bson:"content"    json:"content"`
	Signature string     `bson:"sig"        json:"sig"`
}

Event represents an event structure defined on NIP-01.

func Decode

func Decode(b []byte) (*Event, error)

Decode decodes a byte array into Event structure.

func (*Event) Difficulty

func (e *Event) Difficulty() int

Difficulty returns the leading zeros of event id in base-2.

func (*Event) Encode

func (e *Event) Encode() ([]byte, error)

Encode encodes an Event to a byte array.

func (*Event) GetRawID

func (e *Event) GetRawID() [32]byte

GetID calculates ID of a given event.

func (*Event) IsProtected

func (e *Event) IsProtected() bool

IsProtected checks is ["-"] is present, look nip-70 for more.

func (*Event) IsValid

func (e *Event) IsValid(id [32]byte) bool

IsValid function validats an event Signature and ID.

func (Event) MarshalEasyJSON

func (e Event) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface.

func (Event) MarshalJSON

func (e Event) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface.

func (*Event) Serialize

func (e *Event) Serialize() []byte

func (*Event) String

func (e *Event) String() string

String returns and encoded string representation of event e.

func (*Event) UnmarshalEasyJSON

func (e *Event) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface.

func (*Event) UnmarshalJSON

func (e *Event) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface.