mirror of https://github.com/certusone/vouch.git
306 lines
10 KiB
Go
306 lines
10 KiB
Go
// Copyright © 2020, 2021 Attestant Limited.
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package standard
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
eth2client "github.com/attestantio/go-eth2-client"
|
|
"github.com/attestantio/vouch/services/accountmanager"
|
|
"github.com/attestantio/vouch/services/attestationaggregator"
|
|
"github.com/attestantio/vouch/services/attester"
|
|
"github.com/attestantio/vouch/services/beaconblockproposer"
|
|
"github.com/attestantio/vouch/services/beaconcommitteesubscriber"
|
|
"github.com/attestantio/vouch/services/chaintime"
|
|
"github.com/attestantio/vouch/services/metrics"
|
|
"github.com/attestantio/vouch/services/scheduler"
|
|
"github.com/attestantio/vouch/services/synccommitteeaggregator"
|
|
"github.com/attestantio/vouch/services/synccommitteemessenger"
|
|
"github.com/attestantio/vouch/services/synccommitteesubscriber"
|
|
"github.com/pkg/errors"
|
|
"github.com/rs/zerolog"
|
|
)
|
|
|
|
type parameters struct {
|
|
logLevel zerolog.Level
|
|
monitor metrics.ControllerMonitor
|
|
specProvider eth2client.SpecProvider
|
|
chainTimeService chaintime.Service
|
|
proposerDutiesProvider eth2client.ProposerDutiesProvider
|
|
attesterDutiesProvider eth2client.AttesterDutiesProvider
|
|
syncCommitteeDutiesProvider eth2client.SyncCommitteeDutiesProvider
|
|
syncCommitteesSubscriber synccommitteesubscriber.Service
|
|
validatingAccountsProvider accountmanager.ValidatingAccountsProvider
|
|
scheduler scheduler.Service
|
|
eventsProvider eth2client.EventsProvider
|
|
attester attester.Service
|
|
syncCommitteeMessenger synccommitteemessenger.Service
|
|
syncCommitteeAggregator synccommitteeaggregator.Service
|
|
beaconBlockProposer beaconblockproposer.Service
|
|
attestationAggregator attestationaggregator.Service
|
|
beaconCommitteeSubscriber beaconcommitteesubscriber.Service
|
|
accountsRefresher accountmanager.Refresher
|
|
maxAttestationDelay time.Duration
|
|
maxSyncCommitteeMessageDelay time.Duration
|
|
reorgs bool
|
|
}
|
|
|
|
// Parameter is the interface for service parameters.
|
|
type Parameter interface {
|
|
apply(*parameters)
|
|
}
|
|
|
|
type parameterFunc func(*parameters)
|
|
|
|
func (f parameterFunc) apply(p *parameters) {
|
|
f(p)
|
|
}
|
|
|
|
// WithLogLevel sets the log level for the module.
|
|
func WithLogLevel(logLevel zerolog.Level) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.logLevel = logLevel
|
|
})
|
|
}
|
|
|
|
// WithMonitor sets the monitor for the module.
|
|
func WithMonitor(monitor metrics.ControllerMonitor) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.monitor = monitor
|
|
})
|
|
}
|
|
|
|
// WithSpecProvider sets the spec provider.
|
|
func WithSpecProvider(provider eth2client.SpecProvider) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.specProvider = provider
|
|
})
|
|
}
|
|
|
|
// WithChainTimeService sets the chain time service.
|
|
func WithChainTimeService(service chaintime.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.chainTimeService = service
|
|
})
|
|
}
|
|
|
|
// WithProposerDutiesProvider sets the proposer duties provider.
|
|
func WithProposerDutiesProvider(provider eth2client.ProposerDutiesProvider) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.proposerDutiesProvider = provider
|
|
})
|
|
}
|
|
|
|
// WithAttesterDutiesProvider sets the attester duties provider.
|
|
func WithAttesterDutiesProvider(provider eth2client.AttesterDutiesProvider) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.attesterDutiesProvider = provider
|
|
})
|
|
}
|
|
|
|
// WithSyncCommitteeDutiesProvider sets the sync committee duties provider.
|
|
func WithSyncCommitteeDutiesProvider(provider eth2client.SyncCommitteeDutiesProvider) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.syncCommitteeDutiesProvider = provider
|
|
})
|
|
}
|
|
|
|
// WithSyncCommitteeSubscriber sets the sync committee subscriber.
|
|
func WithSyncCommitteeSubscriber(subscriber synccommitteesubscriber.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.syncCommitteesSubscriber = subscriber
|
|
})
|
|
}
|
|
|
|
// WithEventsProvider sets the events provider.
|
|
func WithEventsProvider(provider eth2client.EventsProvider) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.eventsProvider = provider
|
|
})
|
|
}
|
|
|
|
// WithValidatingAccountsProvider sets the validating accounts provider.
|
|
func WithValidatingAccountsProvider(provider accountmanager.ValidatingAccountsProvider) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.validatingAccountsProvider = provider
|
|
})
|
|
}
|
|
|
|
// WithScheduler sets the scheduler.
|
|
func WithScheduler(scheduler scheduler.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.scheduler = scheduler
|
|
})
|
|
}
|
|
|
|
// WithAttester sets the attester.
|
|
func WithAttester(attester attester.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.attester = attester
|
|
})
|
|
}
|
|
|
|
// WithSyncCommitteeMessenger sets the sync committee messenger.
|
|
func WithSyncCommitteeMessenger(messenger synccommitteemessenger.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.syncCommitteeMessenger = messenger
|
|
})
|
|
}
|
|
|
|
// WithSyncCommitteeAggregator sets the sync committee aggregator.
|
|
func WithSyncCommitteeAggregator(aggregator synccommitteeaggregator.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.syncCommitteeAggregator = aggregator
|
|
})
|
|
}
|
|
|
|
// WithBeaconBlockProposer sets the beacon block propser.
|
|
func WithBeaconBlockProposer(proposer beaconblockproposer.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.beaconBlockProposer = proposer
|
|
})
|
|
}
|
|
|
|
// WithAttestationAggregator sets the attestation aggregator.
|
|
func WithAttestationAggregator(aggregator attestationaggregator.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.attestationAggregator = aggregator
|
|
})
|
|
}
|
|
|
|
// WithBeaconCommitteeSubscriber sets the beacon committee subscriber.
|
|
func WithBeaconCommitteeSubscriber(subscriber beaconcommitteesubscriber.Service) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.beaconCommitteeSubscriber = subscriber
|
|
})
|
|
}
|
|
|
|
// WithAccountsRefresher sets the account refresher.
|
|
func WithAccountsRefresher(refresher accountmanager.Refresher) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.accountsRefresher = refresher
|
|
})
|
|
}
|
|
|
|
// WithMaxAttestationDelay sets the maximum delay before attesting.
|
|
func WithMaxAttestationDelay(delay time.Duration) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.maxAttestationDelay = delay
|
|
})
|
|
}
|
|
|
|
// WithMaxSyncCommitteeMessageDelay sets the maximum delay before generating sync committee messages.
|
|
func WithMaxSyncCommitteeMessageDelay(delay time.Duration) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.maxSyncCommitteeMessageDelay = delay
|
|
})
|
|
}
|
|
|
|
// WithReorgs sets or unsets reorgs.
|
|
func WithReorgs(reorgs bool) Parameter {
|
|
return parameterFunc(func(p *parameters) {
|
|
p.reorgs = reorgs
|
|
})
|
|
}
|
|
|
|
// parseAndCheckParameters parses and checks parameters to ensure that mandatory parameters are present and correct.
|
|
func parseAndCheckParameters(params ...Parameter) (*parameters, error) {
|
|
parameters := parameters{
|
|
logLevel: zerolog.GlobalLevel(),
|
|
}
|
|
for _, p := range params {
|
|
if params != nil {
|
|
p.apply(¶meters)
|
|
}
|
|
}
|
|
|
|
if parameters.monitor == nil {
|
|
return nil, errors.New("no monitor specified")
|
|
}
|
|
if parameters.specProvider == nil {
|
|
return nil, errors.New("no spec provider specified")
|
|
}
|
|
if parameters.chainTimeService == nil {
|
|
return nil, errors.New("no chain time service specified")
|
|
}
|
|
if parameters.proposerDutiesProvider == nil {
|
|
return nil, errors.New("no proposer duties provider specified")
|
|
}
|
|
if parameters.attesterDutiesProvider == nil {
|
|
return nil, errors.New("no attester duties provider specified")
|
|
}
|
|
if parameters.eventsProvider == nil {
|
|
return nil, errors.New("no events provider specified")
|
|
}
|
|
if parameters.validatingAccountsProvider == nil {
|
|
return nil, errors.New("no validating accounts provider specified")
|
|
}
|
|
if parameters.scheduler == nil {
|
|
return nil, errors.New("no scheduler service specified")
|
|
}
|
|
if parameters.attester == nil {
|
|
return nil, errors.New("no attester specified")
|
|
}
|
|
if parameters.beaconBlockProposer == nil {
|
|
return nil, errors.New("no beacon block proposer specified")
|
|
}
|
|
if parameters.attestationAggregator == nil {
|
|
return nil, errors.New("no attestation aggregator specified")
|
|
}
|
|
if parameters.beaconCommitteeSubscriber == nil {
|
|
return nil, errors.New("no beacon committee subscriber specified")
|
|
}
|
|
if parameters.accountsRefresher == nil {
|
|
return nil, errors.New("no accounts refresher specified")
|
|
}
|
|
var spec map[string]interface{}
|
|
var err error
|
|
if parameters.maxAttestationDelay == 0 {
|
|
spec, err = parameters.specProvider.Spec(context.Background())
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to obtain spec")
|
|
}
|
|
tmp, exists := spec["SECONDS_PER_SLOT"]
|
|
if !exists {
|
|
return nil, errors.New("SECONDS_PER_SLOT not found in spec")
|
|
}
|
|
slotDuration, ok := tmp.(time.Duration)
|
|
if !ok {
|
|
return nil, errors.New("SECONDS_PER_SLOT of unexpected type")
|
|
}
|
|
parameters.maxAttestationDelay = slotDuration / 3
|
|
}
|
|
if parameters.maxSyncCommitteeMessageDelay == 0 {
|
|
if spec == nil {
|
|
spec, err = parameters.specProvider.Spec(context.Background())
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "failed to obtain spec")
|
|
}
|
|
}
|
|
tmp, exists := spec["SECONDS_PER_SLOT"]
|
|
if !exists {
|
|
return nil, errors.New("SECONDS_PER_SLOT not found in spec")
|
|
}
|
|
slotDuration, ok := tmp.(time.Duration)
|
|
if !ok {
|
|
return nil, errors.New("SECONDS_PER_SLOT of unexpected type")
|
|
}
|
|
parameters.maxSyncCommitteeMessageDelay = slotDuration / 3
|
|
}
|
|
// Sync committee duties provider/messenger/aggregator/subscriber are optional so no checks here.
|
|
|
|
return ¶meters, nil
|
|
}
|