dirk

Documentation

Index

• type Parameter
  • func WithAccountPaths(accountPaths []string) Parameter
  • func WithCACert(cert []byte) Parameter
  • func WithClientCert(cert []byte) Parameter
  • func WithClientKey(key []byte) Parameter
  • func WithClientMonitor(clientMonitor metrics.ClientMonitor) Parameter
  • func WithCurrentEpochProvider(provider chaintime.Service) Parameter
  • func WithDomainProvider(provider eth2client.DomainProvider) Parameter
  • func WithEndpoints(endpoints []string) Parameter
  • func WithFarFutureEpochProvider(provider eth2client.FarFutureEpochProvider) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
  • func WithMonitor(monitor metrics.AccountManagerMonitor) Parameter
  • func WithProcessConcurrency(concurrency int64) Parameter
  • func WithTimeout(timeout time.Duration) Parameter
  • func WithValidatorsManager(provider validatorsmanager.Service) Parameter
• type Service
  • func New(ctx context.Context, params ...Parameter) (*Service, error)
  • func (s *Service) AccountByPublicKey(_ context.Context, pubkey phase0.BLSPubKey) (e2wtypes.Account, error)
  • func (s *Service) Refresh(ctx context.Context)
  • func (s *Service) ValidatingAccountsForEpoch(ctx context.Context, epoch phase0.Epoch) (map[phase0.ValidatorIndex]e2wtypes.Account, error)
  • func (s *Service) ValidatingAccountsForEpochByIndex(ctx context.Context, epoch phase0.Epoch, indices []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]e2wtypes.Account, error)

Types

type Parameter

type Parameter interface {
	// contains filtered or unexported methods
}

Parameter is the interface for service parameters.

func WithAccountPaths

func WithAccountPaths(accountPaths []string) Parameter

WithAccountPaths sets the accounts paths for which to validate.

func WithCACert

func WithCACert(cert []byte) Parameter

WithCACert sets the bytes of the certificate authority TLS certificate.

func WithClientCert

func WithClientCert(cert []byte) Parameter

WithClientCert sets the bytes of the client TLS certificate.

func WithClientKey

func WithClientKey(key []byte) Parameter

WithClientKey sets the bytes of the client TLS key.

func WithClientMonitor

func WithClientMonitor(clientMonitor metrics.ClientMonitor) Parameter

WithClientMonitor sets the client monitor for the module.

func WithCurrentEpochProvider

func WithCurrentEpochProvider(provider chaintime.Service) Parameter

WithCurrentEpochProvider sets the current epoch provider.

func WithDomainProvider

func WithDomainProvider(provider eth2client.DomainProvider) Parameter

WithDomainProvider sets the signature domain provider.

func WithEndpoints

func WithEndpoints(endpoints []string) Parameter

WithEndpoints sets the endpoints to communicate with dirk.

func WithFarFutureEpochProvider

func WithFarFutureEpochProvider(provider eth2client.FarFutureEpochProvider) Parameter

WithFarFutureEpochProvider sets the far future epoch provider.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

func WithMonitor

func WithMonitor(monitor metrics.AccountManagerMonitor) Parameter

WithMonitor sets the monitor for the module.

func WithProcessConcurrency

func WithProcessConcurrency(concurrency int64) Parameter

WithProcessConcurrency sets the concurrency for the service.

func WithTimeout

func WithTimeout(timeout time.Duration) Parameter

WithTimeout sets the timeout for the module.

func WithValidatorsManager

func WithValidatorsManager(provider validatorsmanager.Service) Parameter

WithValidatorsManager sets the validators manager.

type Service

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

Service is the manager for dirk accounts.

func New

func New(ctx context.Context, params ...Parameter) (*Service, error)

New creates a new dirk account manager.

func (*Service) AccountByPublicKey

func (s *Service) AccountByPublicKey(_ context.Context, pubkey phase0.BLSPubKey) (e2wtypes.Account, error)

AccountByPublicKey returns the account for the given public key.

func (*Service) Refresh

func (s *Service) Refresh(ctx context.Context)

Refresh refreshes the accounts from Dirk, and account validator state from the validators provider. This is a relatively expensive operation, so should not be run in the validating path.

func (*Service) ValidatingAccountsForEpoch

func (s *Service) ValidatingAccountsForEpoch(ctx context.Context, epoch phase0.Epoch) (map[phase0.ValidatorIndex]e2wtypes.Account, error)

ValidatingAccountsForEpoch obtains the validating accounts for a given epoch.

func (*Service) ValidatingAccountsForEpochByIndex

func (s *Service) ValidatingAccountsForEpochByIndex(ctx context.Context, epoch phase0.Epoch, indices []phase0.ValidatorIndex) (map[phase0.ValidatorIndex]e2wtypes.Account, error)

ValidatingAccountsForEpochByIndex obtains the specified validating accounts for a given epoch.