netmap

Documentation

Index

• type AlphabetState
• type EpochState
• type EpochTimerReseter
• type NodeValidator
• type Params
• type Processor
  • func New(p *Params) (*Processor, error)
  • func (np *Processor) HandleNewEpochTick(ev event.Event)
  • func (np *Processor) ListenerHandlers() []event.HandlerInfo
  • func (np *Processor) ListenerParsers() []event.ParserInfo
  • func (np *Processor) TimersHandlers() []event.HandlerInfo

Types

type AlphabetState

type AlphabetState interface {
	IsAlphabet() bool
}

AlphabetState is a callback interface for inner ring global state.

type EpochState

type EpochState interface {
	SetEpochCounter(uint64)
	EpochCounter() uint64
}

EpochState is a callback interface for inner ring global state.

type EpochTimerReseter

type EpochTimerReseter interface {
	ResetEpochTimer() error
}

EpochTimerReseter is a callback interface for tickers component.

type NodeValidator

type NodeValidator interface {
	// Must verify and optionally update NodeInfo structure.
	//
	// Must return an error if NodeInfo input is invalid.
	// Must return an error if it is not possible to correctly
	// change the structure for sending to the network map.
	//
	// If no error occurs, the parameter must point to the
	// ready-made NodeInfo structure.
	VerifyAndUpdate(*netmap.NodeInfo) error
}

NodeValidator wraps basic method of checking the correctness of information about the node and its finalization for adding to the network map.

type Params

type Params struct {
	Log      *zap.Logger
	PoolSize int
	// TODO(@fyrchik): add `ContractHash` method to the NetmapClient and remove this parameter.
	NetmapContract   util.Uint160
	NetmapClient     *nmWrapper.Wrapper
	EpochTimer       EpochTimerReseter
	EpochState       EpochState
	AlphabetState    AlphabetState
	CleanupEnabled   bool
	CleanupThreshold uint64 // in epochs
	ContainerWrapper *container.Wrapper

	HandleAudit             event.Handler
	AuditSettlementsHandler event.Handler
	AlphabetSyncHandler     event.Handler

	NodeValidator NodeValidator
}

Params of the processor constructor.

type Processor

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

Processor of events produced by network map contract and new epoch ticker, because it is related to contract.

func New

func New(p *Params) (*Processor, error)

New creates network map contract processor instance.

func (*Processor) HandleNewEpochTick

func (np *Processor) HandleNewEpochTick(ev event.Event)

func (*Processor) ListenerHandlers

func (np *Processor) ListenerHandlers() []event.HandlerInfo

ListenerHandlers for the 'event.Listener' event producer.

func (*Processor) ListenerParsers

func (np *Processor) ListenerParsers() []event.ParserInfo

ListenerParsers for the 'event.Listener' event producer.

func (*Processor) TimersHandlers

func (np *Processor) TimersHandlers() []event.HandlerInfo

TimersHandlers for the 'Timers' event producer.