service

Documentation

Index

• func NewDisabledService(reg RegistrationService) *disabledService
• func NewRound(datadir string, epoch uint, opts ...newRoundOptionFunc) (*round, error)
• func WithConfig(cfg Config) newServiceOptionFunc
• func WithMembershipRoot(root []byte) newRoundOptionFunc
• type ClosedRound
• type Config
  • func DefaultConfig() Config
• type RegistrationService
• type Service
  • func New(ctx context.Context, genesis time.Time, datadir string, ...) (*Service, error)
  • func (s *Service) Run(ctx context.Context) error

Functions

func NewDisabledService

func NewDisabledService(reg RegistrationService) *disabledService

func NewRound

func NewRound(datadir string, epoch uint, opts ...newRoundOptionFunc) (*round, error)

func WithConfig

func WithConfig(cfg Config) newServiceOptionFunc

func WithMembershipRoot

func WithMembershipRoot(root []byte) newRoundOptionFunc

Types

type ClosedRound

type ClosedRound struct {
	Epoch          uint
	MembershipRoot []byte
}

type Config

type Config struct {
	// Merkle-Tree related configuration:
	EstimatedLeavesPerSecond uint `long:"lps"              description:"Estimated number of leaves generated per second"`
	MemoryLayers             uint `long:"memory"           description:"Number of top Merkle tree layers to cache in-memory"`
	TreeFileBufferSize       uint `long:"tree-file-buffer" description:"The size of memory buffer for file-based tree layers"`
}

func DefaultConfig

func DefaultConfig() Config

type RegistrationService

type RegistrationService interface {
	RegisterForRoundClosed(ctx context.Context) <-chan ClosedRound
	NewProof(ctx context.Context, proof shared.NIP) error
}

type Service

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

func New

func New(
	ctx context.Context,
	genesis time.Time,
	datadir string,
	registration RegistrationService,
	roundCfg roundConfig,
	opts ...newServiceOptionFunc,
) (*Service, error)

New creates a new instance of a worker service. It should be started with `Service::Run`.

func (*Service) Run

func (s *Service) Run(ctx context.Context) error

Run starts the Service's loop. It stops when the `ctx` is canceled.