event

Documentation

Index

• func WrongNumberOfParameters(exp, act int) error
• type Event
• type Handler
• type HandlerInfo
  • func (s HandlerInfo) Handler() Handler
  • func (s *HandlerInfo) SetHandler(v Handler)
• type Listener
  • func NewListener(p ListenerParams) (Listener, error)
• type ListenerParams
• type Parser
• type ParserInfo
  • func (s *ParserInfo) SetParser(v Parser)
  • func (s *ParserInfo) SetType(v Type)
• type Type
  • func TypeFromBytes(data []byte) Type
  • func TypeFromString(str string) Type
  • func (t Type) Equal(t2 Type) bool
  • func (t Type) String() string

Functions

func WrongNumberOfParameters

func WrongNumberOfParameters(exp, act int) error

WrongNumberOfParameters returns an error about wrong number of smart contract parameters.

Types

type Event

type Event interface {
	MorphEvent()
}

Event is an interface that is provided by Neo:Morph event structures.

type Handler

type Handler func(Event)

Handler is an Event processing function.

type HandlerInfo

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

HandlerInfo is a structure that groups the parameters of the handler of particular contract event.

func (HandlerInfo) Handler

func (s HandlerInfo) Handler() Handler

Handler returns an event handler.

func (*HandlerInfo) SetHandler

func (s *HandlerInfo) SetHandler(v Handler)

SetHandler is an event handler setter.

type Listener

type Listener interface {
	// Must start the event listener.
	//
	// Must listen to events with the parser installed.
	Listen(context.Context)

	// Must start the event listener.
	//
	// Must listen to events with the parser installed.
	//
	// Must send error to channel if subscriber channel has been closed or
	// it could not be started.
	ListenWithError(context.Context, chan<- error)

	// Must set the parser of particular contract event.
	//
	// Parser of each event must be set once. All parsers must be set before Listen call.
	//
	// Must ignore nil parsers and all calls after listener has been started.
	SetParser(ParserInfo)

	// Must register the event handler for particular notification event of contract.
	//
	// The specified handler must be called after each capture and parsing of the event
	//
	// Must ignore nil handlers.
	RegisterHandler(HandlerInfo)

	// Must stop the event listener.
	Stop()
}

Listener is an interface of smart contract notification event listener.

func NewListener

func NewListener(p ListenerParams) (Listener, error)

NewListener create the notification event listener instance and returns Listener interface.

type ListenerParams

type ListenerParams struct {
	Logger *zap.Logger

	Subscriber subscriber.Subscriber
}

ListenerParams is a group of parameters for Listener constructor.

type Parser

type Parser func([]stackitem.Item) (Event, error)

Parser is a function that constructs Event from the StackItem list.

type ParserInfo

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

ParserInfo is a structure that groups the parameters of particular contract notification event parser.

func (*ParserInfo) SetParser

func (s *ParserInfo) SetParser(v Parser)

SetParser is an event parser setter.

func (*ParserInfo) SetType

func (s *ParserInfo) SetType(v Type)

SetType is an event type setter.

type Type

type Type string

Type is a notification event enumeration type.

func TypeFromBytes

func TypeFromBytes(data []byte) Type

TypeFromBytes converts bytes slice to Type.

func TypeFromString

func TypeFromString(str string) Type

TypeFromString converts string to Type.

func (Type) Equal

func (t Type) Equal(t2 Type) bool

Equal compares two Type values and returns true if they are equal.

func (Type) String

func (t Type) String() string

String returns casted to string Type.