netmap

Documentation

Index

• type AlphabetState
• type Client
  • func NewNetmapClient(netmapClient *netmapclient.Client) Client
• type EpochState
• type EpochTimerReseter
• type NodeValidator
• type Params
• type Processor
  • func New(p *Params) (*Processor, error)
  • func (np *Processor) HandleNewEpochTick(ctx context.Context, ev event.Event)
  • func (np *Processor) ListenerNotaryHandlers() []event.NotaryHandlerInfo
  • func (np *Processor) ListenerNotaryParsers() []event.NotaryParserInfo
  • func (np *Processor) ListenerNotificationHandlers() []event.NotificationHandlerInfo
  • func (np *Processor) ListenerNotificationParsers() []event.NotificationParserInfo

Types

type AlphabetState

type AlphabetState interface {
	IsAlphabet(context.Context) bool
}

AlphabetState is a callback interface for inner ring global state.

type Client

type Client interface {
	MorphNotaryInvoke(ctx context.Context, contract util.Uint160, fee fixedn.Fixed8, nonce uint32, vub *uint32, method string, args ...any) error
	ContractAddress() util.Uint160
	EpochDuration() (uint64, error)
	MorphTxHeight(h util.Uint256) (res uint32, err error)
	NetMap() (*netmap.NetMap, error)
	NewEpoch(ctx context.Context, epoch uint64) error
	MorphIsValidScript(script []byte, signers []transaction.Signer) (valid bool, err error)
	MorphNotarySignAndInvokeTX(mainTx *transaction.Transaction) error
}

func NewNetmapClient

func NewNetmapClient(netmapClient *netmapclient.Client) Client

type EpochState

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

EpochState is a callback interface for inner ring global state.

type EpochTimerReseter

type EpochTimerReseter interface {
	ResetEpochTimer(uint32) error
}

EpochTimerReseter is a callback interface for tickers component.

type NodeValidator

type NodeValidator interface {
	// VerifyAndUpdate 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              *logger.Logger
	Metrics          metrics.Register
	PoolSize         int
	NetmapClient     Client
	EpochTimer       EpochTimerReseter
	EpochState       EpochState
	AlphabetState    AlphabetState
	CleanupEnabled   bool
	CleanupThreshold uint64 // in epochs

	AlphabetSyncHandler  event.Handler
	NotaryDepositHandler event.Handler

	NodeValidator NodeValidator

	NodeStateSettings state.NetworkSettings
}

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(ctx context.Context, ev event.Event)

func (*Processor) ListenerNotaryHandlers

func (np *Processor) ListenerNotaryHandlers() []event.NotaryHandlerInfo

ListenerNotaryHandlers for the 'event.Listener' event producer.

func (*Processor) ListenerNotaryParsers

func (np *Processor) ListenerNotaryParsers() []event.NotaryParserInfo

ListenerNotaryParsers for the 'event.Listener' event producer.

func (*Processor) ListenerNotificationHandlers

func (np *Processor) ListenerNotificationHandlers() []event.NotificationHandlerInfo

ListenerNotificationHandlers for the 'event.Listener' event producer.

func (*Processor) ListenerNotificationParsers

func (np *Processor) ListenerNotificationParsers() []event.NotificationParserInfo

ListenerNotificationParsers for the 'event.Listener' event producer.