standard

Documentation

Index

• type Parameter
  • func WithAccountsProvider(provider accountmanager.AccountsProvider) Parameter
  • func WithBuilderBidProvider(provider builderbid.Provider) Parameter
  • func WithCACertURL(url string) Parameter
  • func WithChainTime(service chaintime.Service) Parameter
  • func WithClientCertURL(url string) Parameter
  • func WithClientKeyURL(url string) Parameter
  • func WithConfigURL(url string) Parameter
  • func WithExcludedBuilders(builders []phase0.BLSPubKey) Parameter
  • func WithFallbackFeeRecipient(feeRecipient bellatrix.ExecutionAddress) Parameter
  • func WithFallbackGasLimit(gasLimit uint64) Parameter
  • func WithListenAddress(address string) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
  • func WithLogResults(logResults bool) Parameter
  • func WithMajordomo(majordomo majordomo.Service) Parameter
  • func WithMonitor(monitor metrics.Service) Parameter
  • func WithReleaseVersion(version string) Parameter
  • func WithScheduler(scheduler scheduler.Service) Parameter
  • func WithSecondaryValidatorRegistrationsSubmitters(submitters []consensusclient.ValidatorRegistrationsSubmitter) Parameter
  • func WithValidatingAccountsProvider(provider accountmanager.ValidatingAccountsProvider) Parameter
  • func WithValidatorRegistrationSigner(signer signer.ValidatorRegistrationSigner) Parameter
• type Service
  • func New(ctx context.Context, params ...Parameter) (*Service, error)
  • func (s *Service) AuctionBlock(ctx context.Context, slot phase0.Slot, parentHash phase0.Hash32, ...) (*blockauctioneer.Results, error)
  • func (s *Service) BuilderBid(ctx context.Context, slot phase0.Slot, parentHash phase0.Hash32, ...) (*spec.VersionedSignedBuilderBid, error)
  • func (s *Service) ProposerConfig(ctx context.Context, account e2wtypes.Account, pubkey phase0.BLSPubKey) (*beaconblockproposer.ProposerConfig, error)
  • func (s *Service) SubmitValidatorRegistrations(ctx context.Context, accounts map[phase0.ValidatorIndex]e2wtypes.Account) error
  • func (*Service) ValidatorRegistrationsPassthrough(_ context.Context, _ io.ReadCloser) ([]string, error)

Types

type Parameter

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

Parameter is the interface for service parameters.

func WithAccountsProvider

func WithAccountsProvider(provider accountmanager.AccountsProvider) Parameter

WithAccountsProvider sets the accounts provider.

func WithBuilderBidProvider

func WithBuilderBidProvider(provider builderbid.Provider) Parameter

WithBuilderBidProvider sets builder bid provider.

func WithCACertURL

func WithCACertURL(url string) Parameter

WithCACertURL sets the URL for the CA certificate when carrying out dynamic requests.

func WithChainTime

func WithChainTime(service chaintime.Service) Parameter

WithChainTime sets the chaintime service.

func WithClientCertURL

func WithClientCertURL(url string) Parameter

WithClientCertURL sets the URL for the client certificate when carrying out dynamic requests.

func WithClientKeyURL

func WithClientKeyURL(url string) Parameter

WithClientKeyURL sets the URL for the client key when carrying out dynamic requests.

func WithConfigURL

func WithConfigURL(url string) Parameter

WithConfigURL sets the URL for the config server.

func WithExcludedBuilders

func WithExcludedBuilders(builders []phase0.BLSPubKey) Parameter

WithExcludedBuilders is the list of builders whose bids will be excluded.

func WithFallbackFeeRecipient

func WithFallbackFeeRecipient(feeRecipient bellatrix.ExecutionAddress) Parameter

WithFallbackFeeRecipient sets the fallback fee recipient for all validators.

func WithFallbackGasLimit

func WithFallbackGasLimit(gasLimit uint64) Parameter

WithFallbackGasLimit sets the fallback gas limit for all validators.

func WithListenAddress

func WithListenAddress(address string) Parameter

WithListenAddress sets the listen address for the module.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

func WithLogResults

func WithLogResults(logResults bool) Parameter

WithLogResults sets the flag to log relay results.

func WithMajordomo

func WithMajordomo(majordomo majordomo.Service) Parameter

WithMajordomo sets majordomo for the module.

func WithMonitor

func WithMonitor(monitor metrics.Service) Parameter

WithMonitor sets the monitor for the module.

func WithReleaseVersion

func WithReleaseVersion(version string) Parameter

WithReleaseVersion sets the release version for Vouch.

func WithScheduler

func WithScheduler(scheduler scheduler.Service) Parameter

WithScheduler provides the scheduler service.

func WithSecondaryValidatorRegistrationsSubmitters

func WithSecondaryValidatorRegistrationsSubmitters(submitters []consensusclient.ValidatorRegistrationsSubmitter) Parameter

WithSecondaryValidatorRegistrationsSubmitters sets the secondary validator registrations submitters.

func WithValidatingAccountsProvider

func WithValidatingAccountsProvider(provider accountmanager.ValidatingAccountsProvider) Parameter

WithValidatingAccountsProvider sets the validating accounts provider.

func WithValidatorRegistrationSigner

func WithValidatorRegistrationSigner(signer signer.ValidatorRegistrationSigner) Parameter

WithValidatorRegistrationSigner sets the validator registration signer.

type Service

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

Service is the builder service for Vouch.

func New

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

New creates a new controller.

func (*Service) AuctionBlock

func (s *Service) AuctionBlock(ctx context.Context,
	slot phase0.Slot,
	parentHash phase0.Hash32,
	pubkey phase0.BLSPubKey,
) (
	*blockauctioneer.Results,
	error,
)

AuctionBlock obtains the best available use of the block space.

func (*Service) BuilderBid

func (s *Service) BuilderBid(ctx context.Context,
	slot phase0.Slot,
	parentHash phase0.Hash32,
	pubkey phase0.BLSPubKey,
) (
	*spec.VersionedSignedBuilderBid,
	error,
)

BuilderBid provides a builder bid.

func (*Service) ProposerConfig

func (s *Service) ProposerConfig(ctx context.Context,
	account e2wtypes.Account,
	pubkey phase0.BLSPubKey,
) (
	*beaconblockproposer.ProposerConfig,
	error,
)

ProposerConfig returns the proposer configuration for the given validator.

func (*Service) SubmitValidatorRegistrations

func (s *Service) SubmitValidatorRegistrations(ctx context.Context,
	accounts map[phase0.ValidatorIndex]e2wtypes.Account,
) error

SubmitValidatorRegistrations submits validator registrations for the given accounts.

func (*Service) ValidatorRegistrationsPassthrough

func (*Service) ValidatorRegistrationsPassthrough(_ context.Context, _ io.ReadCloser) ([]string, error)

ValidatorRegistrationsPassthrough handles validator registrations directly.