governance

Documentation

Index

• Constants
• type AlphabetState
• type EpochState
• type FrostFSClient
• type IRFetcher
• type MainnetClient
• type MorphClient
• type NetmapClient
• type Params
• type Processor
  • func New(p *Params) (*Processor, error)
  • func (gp *Processor) HandleAlphabetSync(ctx context.Context, e event.Event)
  • func (gp *Processor) ListenerNotaryHandlers() []event.NotaryHandlerInfo
  • func (gp *Processor) ListenerNotaryParsers() []event.NotaryParserInfo
  • func (gp *Processor) ListenerNotificationHandlers() []event.NotificationHandlerInfo
  • func (gp *Processor) ListenerNotificationParsers() []event.NotificationParserInfo
• type Sync
  • func NewSyncEvent(txHash util.Uint256) Sync
  • func (s Sync) MorphEvent()
  • func (s Sync) TxHash() util.Uint256
• type VoteValidatorPrm
• type Voter

Constants

const ProcessorPoolSize = 1

ProcessorPoolSize limits the pool size for governance Processor. Processor manages governance sync tasks. This process must not be interrupted by other sync operation, so we limit the pool size for the processor to one.

Types

type AlphabetState

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

AlphabetState is a callback interface for innerring global state.

type EpochState

type EpochState interface {
	EpochCounter() uint64
}

EpochState is a callback interface for innerring global state.

type FrostFSClient

type FrostFSClient interface {
	AlphabetUpdate(ctx context.Context, p frostfscontract.AlphabetUpdatePrm) error
}

type IRFetcher

type IRFetcher interface {
	InnerRingKeys() (keys.PublicKeys, error)
}

IRFetcher is a callback interface for innerring keys. Implementation must take into account availability of the notary contract.

type MainnetClient

type MainnetClient interface {
	NeoFSAlphabetList() (res keys.PublicKeys, err error)
	GetDesignateHash() util.Uint160
}

type MorphClient

type MorphClient interface {
	Committee() (res keys.PublicKeys, err error)
	UpdateNeoFSAlphabetList(ctx context.Context, prm client.UpdateAlphabetListPrm) error
	UpdateNotaryList(ctx context.Context, prm client.UpdateNotaryListPrm) error
}

type NetmapClient

type NetmapClient interface {
	UpdateInnerRing(p nmClient.UpdateIRPrm) error
}

type Params

type Params struct {
	Log     *logger.Logger
	Metrics metrics.Register

	AlphabetState AlphabetState
	EpochState    EpochState
	Voter         Voter
	IRFetcher     IRFetcher

	MorphClient   MorphClient
	MainnetClient MainnetClient
	FrostFSClient FrostFSClient
}

Params of the processor constructor.

type Processor

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

Processor of events related to governance in the network.

func New

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

New creates a balance contract processor instance.

func (*Processor) HandleAlphabetSync

func (gp *Processor) HandleAlphabetSync(ctx context.Context, e event.Event)

func (*Processor) ListenerNotaryHandlers

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

ListenerNotaryHandlers for the 'event.Listener' event producer.

func (*Processor) ListenerNotaryParsers

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

ListenerNotaryParsers for the 'event.Listener' event producer.

func (*Processor) ListenerNotificationHandlers

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

ListenerNotificationHandlers for the 'event.Listener' event producer.

func (*Processor) ListenerNotificationParsers

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

ListenerNotificationParsers for the 'event.Listener' event producer.

type Sync

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

Sync is an event to start governance synchronization.

func NewSyncEvent

func NewSyncEvent(txHash util.Uint256) Sync

NewSyncEvent creates Sync event that was produced in transaction with txHash hash.

func (Sync) MorphEvent

func (s Sync) MorphEvent()

MorphEvent implements Event interface.

func (Sync) TxHash

func (s Sync) TxHash() util.Uint256

TxHash returns hash of the TX that triggers synchronization process.

type VoteValidatorPrm

type VoteValidatorPrm struct {
	Validators keys.PublicKeys
	Hash       *util.Uint256 // hash of the transaction that triggered voting
}

VoteValidatorPrm groups parameters of the VoteForSidechainValidator operation.

type Voter

type Voter interface {
	VoteForSidechainValidator(context.Context, VoteValidatorPrm) error
}

Voter is a callback interface for alphabet contract voting.