innerring

Documentation

Index

• func ParsePublicKeysFromStrings(pubKeys []string) (keys.PublicKeys, error)
• type ClientCache
  • func (c *ClientCache) Get(address network.AddressGroup) (client.Client, error)
  • func (c *ClientCache) GetHeader(task *audit.Task, node *netmap.Node, id *object.ID, relay bool) (*object.Object, error)
  • func (c *ClientCache) GetRangeHash(task *audit.Task, node *netmap.Node, id *object.ID, rng *object.Range) ([]byte, error)
  • func (c *ClientCache) GetSG(task *audit.Task, id *object.ID) (*storagegroup.StorageGroup, error)
• type ContractProcessor
• type GlagoliticLetter
  • func (l GlagoliticLetter) String() string
• type IrFetcherWithNotary
  • func NewIRFetcherWithNotary(cli *client.Client) *IrFetcherWithNotary
  • func (fN IrFetcherWithNotary) InnerRingKeys() (keys.PublicKeys, error)
• type IrFetcherWithoutNotary
  • func NewIRFetcherWithoutNotary(nm *nmWrapper.Wrapper) *IrFetcherWithoutNotary
  • func (f IrFetcherWithoutNotary) InnerRingKeys() (keys.PublicKeys, error)
• type Server
  • func New(ctx context.Context, log *zap.Logger, cfg *viper.Viper) (*Server, error)
  • func (s *Server) AlphabetIndex() int
  • func (s *Server) EpochCounter() uint64
  • func (s *Server) HealthStatus() control.HealthStatus
  • func (s *Server) InitAndVoteForSidechainValidator(validators keys.PublicKeys) error
  • func (s *Server) InnerRingIndex() int
  • func (s *Server) InnerRingSize() int
  • func (s *Server) IsActive() bool
  • func (s *Server) IsAlphabet() bool
  • func (s *Server) ResetEpochTimer() error
  • func (s *Server) SetEpochCounter(val uint64)
  • func (s *Server) Start(ctx context.Context, intError chan<- error) (err error)
  • func (s *Server) Stop()
  • func (s *Server) VoteForSidechainValidator(validators keys.PublicKeys) error
  • func (s *Server) WriteReport(r *audit.Report) error

Functions

func ParsePublicKeysFromStrings

func ParsePublicKeysFromStrings(pubKeys []string) (keys.PublicKeys, error)

ParsePublicKeysFromStrings returns slice of neo public keys from slice of hex encoded strings.

Types

type ClientCache

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

func (*ClientCache) Get

func (c *ClientCache) Get(address network.AddressGroup) (client.Client, error)

func (*ClientCache) GetHeader

func (c *ClientCache) GetHeader(task *audit.Task, node *netmap.Node, id *object.ID, relay bool) (*object.Object, error)

GetHeader requests node from the container under audit to return object header by id.

func (*ClientCache) GetRangeHash

func (c *ClientCache) GetRangeHash(task *audit.Task, node *netmap.Node, id *object.ID, rng *object.Range) ([]byte, error)

GetRangeHash requests node from the container under audit to return Tillich-Zemor hash of the payload range of the object with specified identifier.

func (*ClientCache) GetSG

func (c *ClientCache) GetSG(task *audit.Task, id *object.ID) (*storagegroup.StorageGroup, error)

GetSG polls the container from audit task to get the object by id. Returns storage groups structure from received object.

type ContractProcessor

type ContractProcessor interface {
	ListenerParsers() []event.ParserInfo
	ListenerHandlers() []event.HandlerInfo
	TimersHandlers() []event.HandlerInfo
}

ContractProcessor interface defines functions for binding event producers such as event.Listener and Timers with contract processor.

type GlagoliticLetter

type GlagoliticLetter int8

func (GlagoliticLetter) String

func (l GlagoliticLetter) String() string

returns string in config-compatible format

type IrFetcherWithNotary

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

IrFetcherWithNotary fetches keys using notary contract. Must be created with NewIRFetcherWithNotary.

func NewIRFetcherWithNotary

func NewIRFetcherWithNotary(cli *client.Client) *IrFetcherWithNotary

NewIRFetcherWithNotary creates IrFetcherWithNotary.

IrFetcherWithNotary can be used to obtain innerring key list if network that client is connected to supports notary contract.

Passed client is required. Panics if nil.

func (IrFetcherWithNotary) InnerRingKeys

func (fN IrFetcherWithNotary) InnerRingKeys() (keys.PublicKeys, error)

InnerRingKeys fetches list of innerring keys from NeoFSAlphabet role in side chain.

type IrFetcherWithoutNotary

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

IrFetcherWithoutNotary fetches keys using netmap contract. Must be created with NewIRFetcherWithoutNotary.

func NewIRFetcherWithoutNotary

func NewIRFetcherWithoutNotary(nm *nmWrapper.Wrapper) *IrFetcherWithoutNotary

NewIRFetcherWithoutNotary creates IrFetcherWithoutNotary.

IrFetcherWithoutNotary must be used to obtain innerring key list if network that netmap wrapper is connected to does not support notary contract.

Passed netmap wrapper is required. Panics if nil.

func (IrFetcherWithoutNotary) InnerRingKeys

func (f IrFetcherWithoutNotary) InnerRingKeys() (keys.PublicKeys, error)

InnerRingKeys fetches list of innerring keys from netmap contract in side chain.

type Server

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

Server is the inner ring application structure, that contains all event processors, shared variables and event handlers.

func New

func New(ctx context.Context, log *zap.Logger, cfg *viper.Viper) (*Server, error)

New creates instance of inner ring sever structure.

func (*Server) AlphabetIndex

func (s *Server) AlphabetIndex() int

AlphabetIndex is a getter for a global index of node in alphabet list. Negative index means that node is not in the alphabet list.

func (*Server) EpochCounter

func (s *Server) EpochCounter() uint64

EpochCounter is a getter for a global epoch counter.

func (*Server) HealthStatus

func (s *Server) HealthStatus() control.HealthStatus

HealthStatus returns current health status of IR application.

func (*Server) InitAndVoteForSidechainValidator

func (s *Server) InitAndVoteForSidechainValidator(validators keys.PublicKeys) error

InitAndVoteForSidechainValidator is a public function to use outside of inner ring daemon execution. It initialize inner ring structure with data from blockchain and then calls vote method on alphabet contracts.

func (*Server) InnerRingIndex

func (s *Server) InnerRingIndex() int

InnerRingIndex is a getter for a global index of node in inner ring list. Negative index means that node is not in the inner ring list.

func (*Server) InnerRingSize

func (s *Server) InnerRingSize() int

InnerRingSize is a getter for a global size of inner ring list. This value paired with inner ring index.

func (*Server) IsActive

func (s *Server) IsActive() bool

IsActive is a getter for a global active flag state.

func (*Server) IsAlphabet

func (s *Server) IsAlphabet() bool

IsAlphabet is a getter for a global alphabet flag state.

func (*Server) ResetEpochTimer

func (s *Server) ResetEpochTimer() error

ResetEpochTimer resets block timer that produces events to update epoch counter in netmap contract. Used to synchronize this even production based on block with notification of last epoch.

func (*Server) SetEpochCounter

func (s *Server) SetEpochCounter(val uint64)

SetEpochCounter is a setter for contract processors to update global epoch counter.

func (*Server) Start

func (s *Server) Start(ctx context.Context, intError chan<- error) (err error)

Start runs all event providers.

func (*Server) Stop

func (s *Server) Stop()

Stop closes all subscription channels.

func (*Server) VoteForSidechainValidator

func (s *Server) VoteForSidechainValidator(validators keys.PublicKeys) error

VoteForSidechainValidator calls vote method on alphabet contracts with provided list of keys.

func (*Server) WriteReport

func (s *Server) WriteReport(r *audit.Report) error

WriteReport composes audit result structure from audit report and sends it to Audit contract.