subscriber

Documentation

Index

• Variables
• type NotificationChannels
• type Params
• type Subscriber
  • func New(ctx context.Context, p *Params) (Subscriber, error)

Variables

var (
	// ErrStaleNode is returned from [New] when StartFromBlock requirement
	// specified in [Params] is not satisfied by the given node.
	ErrStaleNode = errors.New("RPC node is not yet up to date")
)

Types

type NotificationChannels

type NotificationChannels struct {
	BlockCh          <-chan *block.Block
	NotificationsCh  <-chan *state.ContainedNotificationEvent
	NotaryRequestsCh <-chan *result.NotaryRequestEvent
}

type Params

type Params struct {
	Log            *zap.Logger
	StartFromBlock uint32
	Client         *client.Client
}

Params is a group of Subscriber constructor parameters.

type Subscriber

type Subscriber interface {
	SubscribeForNotification(...util.Uint160) error
	BlockNotifications() error
	SubscribeForNotaryRequests(mainTXSigner util.Uint160) error

	NotificationChannels() NotificationChannels

	Close()
}

Subscriber is an interface of the NotificationEvent listener.

func New

func New(ctx context.Context, p *Params) (Subscriber, error)

New is a constructs Neo:Morph event listener and returns Subscriber interface.