standard

Documentation

Index

• type Parameter
  • func WithAdminIPs(adminIPs []string) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
  • func WithStoragePath(storagePath string) Parameter
• type Service
  • func New(ctx context.Context, params ...Parameter) (*Service, error)
  • func (s *Service) Close(ctx context.Context) error
  • func (s *Service) ExportSlashingProtection(ctx context.Context) (map[[48]byte]*rules.SlashingProtection, error)
  • func (s *Service) ImportSlashingProtection(ctx context.Context, protection map[[48]byte]*rules.SlashingProtection) error
  • func (s *Service) OnCreateAccount(ctx context.Context, _ *rules.ReqMetadata, _ *rules.CreateAccountData) rules.Result
  • func (s *Service) OnListAccounts(ctx context.Context, _ *rules.ReqMetadata, _ *rules.AccessAccountData) rules.Result
  • func (s *Service) OnLockAccount(ctx context.Context, _ *rules.ReqMetadata, _ *rules.LockAccountData) rules.Result
  • func (s *Service) OnLockWallet(ctx context.Context, _ *rules.ReqMetadata, _ *rules.LockWalletData) rules.Result
  • func (s *Service) OnSign(ctx context.Context, metadata *rules.ReqMetadata, req *rules.SignData) rules.Result
  • func (s *Service) OnSignBeaconAttestation(ctx context.Context, metadata *rules.ReqMetadata, ...) rules.Result
  • func (s *Service) OnSignBeaconAttestations(ctx context.Context, metadata []*rules.ReqMetadata, ...) []rules.Result
  • func (s *Service) OnSignBeaconProposal(ctx context.Context, metadata *rules.ReqMetadata, ...) rules.Result
  • func (s *Service) OnUnlockAccount(ctx context.Context, _ *rules.ReqMetadata, _ *rules.UnlockAccountData) rules.Result
  • func (s *Service) OnUnlockWallet(ctx context.Context, _ *rules.ReqMetadata, _ *rules.UnlockWalletData) rules.Result
• type Store
  • func NewStore(base string) (*Store, error)
  • func (s *Store) BatchStore(ctx context.Context, keys [][]byte, values [][]byte) error
  • func (s *Store) Close(_ context.Context) error
  • func (s *Store) Fetch(ctx context.Context, key []byte) ([]byte, error)
  • func (s *Store) FetchAll(_ context.Context) (map[[49]byte][]byte, error)
  • func (s *Store) Store(ctx context.Context, key []byte, value []byte) error

Types

type Parameter

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

Parameter is the interface for service parameters.

func WithAdminIPs

func WithAdminIPs(adminIPs []string) Parameter

WithAdminIPs sets the administration IP addreses for the module.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

func WithStoragePath

func WithStoragePath(storagePath string) Parameter

WithStoragePath sets the storage path for the module.

type Service

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

Service is the structure that keeps track of rules.

func New

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

New creates new rules.

func (*Service) Close

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

Close closes the database for the persistent rules information.

func (*Service) ExportSlashingProtection

func (s *Service) ExportSlashingProtection(ctx context.Context) (map[[48]byte]*rules.SlashingProtection, error)

ExportSlashingProtection exports the slashing protection data.

func (*Service) ImportSlashingProtection

func (s *Service) ImportSlashingProtection(ctx context.Context, protection map[[48]byte]*rules.SlashingProtection) error

ImportSlashingProtection imports the slashing protection data.

func (*Service) OnCreateAccount

func (s *Service) OnCreateAccount(ctx context.Context, _ *rules.ReqMetadata, _ *rules.CreateAccountData) rules.Result

OnCreateAccount is called when a request to create an account needs to be approved.

func (*Service) OnListAccounts

func (s *Service) OnListAccounts(ctx context.Context, _ *rules.ReqMetadata, _ *rules.AccessAccountData) rules.Result

OnListAccounts is called when a request to list accounts needs to be approved.

func (*Service) OnLockAccount

func (s *Service) OnLockAccount(ctx context.Context, _ *rules.ReqMetadata, _ *rules.LockAccountData) rules.Result

OnLockAccount is called when a request to lock an account needs to be approved.

func (*Service) OnLockWallet

func (s *Service) OnLockWallet(ctx context.Context, _ *rules.ReqMetadata, _ *rules.LockWalletData) rules.Result

OnLockWallet is called when a request to lock a wallet needs to be approved.

func (*Service) OnSign

func (s *Service) OnSign(ctx context.Context, metadata *rules.ReqMetadata, req *rules.SignData) rules.Result

OnSign is called when a request to sign generic data needs to be approved.

func (*Service) OnSignBeaconAttestation

func (s *Service) OnSignBeaconAttestation(ctx context.Context, metadata *rules.ReqMetadata, req *rules.SignBeaconAttestationData) rules.Result

OnSignBeaconAttestation is called when a request to sign a beacon block attestation needs to be approved.

func (*Service) OnSignBeaconAttestations

func (s *Service) OnSignBeaconAttestations(ctx context.Context,
	metadata []*rules.ReqMetadata,
	req []*rules.SignBeaconAttestationData,
) []rules.Result

OnSignBeaconAttestations is called when a request to sign multiple beacon block attestations needs to be approved.

func (*Service) OnSignBeaconProposal

func (s *Service) OnSignBeaconProposal(ctx context.Context, metadata *rules.ReqMetadata, req *rules.SignBeaconProposalData) rules.Result

OnSignBeaconProposal is called when a request to sign a beacon block proposal needs to be approved.

func (*Service) OnUnlockAccount

func (s *Service) OnUnlockAccount(ctx context.Context, _ *rules.ReqMetadata, _ *rules.UnlockAccountData) rules.Result

OnUnlockAccount is called when a request to unlock an account needs to be approved.

func (*Service) OnUnlockWallet

func (s *Service) OnUnlockWallet(ctx context.Context, _ *rules.ReqMetadata, _ *rules.UnlockWalletData) rules.Result

OnUnlockWallet is called when a request to unlock a wallet needs to be approved.

type Store

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

Store holds key/value pairs in a badger database.

func NewStore

func NewStore(base string) (*Store, error)

NewStore creates a new badger store.

func (*Store) BatchStore

func (s *Store) BatchStore(ctx context.Context, keys [][]byte, values [][]byte) error

BatchStore stores multiple keys and values.

func (*Store) Close

func (s *Store) Close(_ context.Context) error

Close closes the store.

func (*Store) Fetch

func (s *Store) Fetch(ctx context.Context, key []byte) ([]byte, error)

Fetch fetches a value for a given key.

func (*Store) FetchAll

func (s *Store) FetchAll(_ context.Context) (map[[49]byte][]byte, error)

FetchAll fetches a map of all keys and values.

func (*Store) Store

func (s *Store) Store(ctx context.Context, key []byte, value []byte) error

Store stores the value for a given key.