vouch/strategies/beaconblockproposal/best/beaconblockproposal.go

// Copyright © 2020 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 best

import (
	"context"
	"fmt"
	"sync"
	"time"

	eth2client "github.com/attestantio/go-eth2-client"
	"github.com/attestantio/go-eth2-client/spec"
	"github.com/attestantio/go-eth2-client/spec/phase0"
	"github.com/attestantio/vouch/util"
	"golang.org/x/sync/semaphore"
)

// BeaconBlockProposal provides the best beacon block proposal from a number of beacon nodes.
func (s *Service) BeaconBlockProposal(ctx context.Context, slot phase0.Slot, randaoReveal phase0.BLSSignature, graffiti []byte) (*spec.VersionedBeaconBlock, error) {
	var mu sync.Mutex
	bestScore := float64(0)
	var bestProposal *spec.VersionedBeaconBlock
	bestProvider := ""

	started := time.Now()
	log := util.LogWithID(ctx, log, "strategy_id")
	sem := semaphore.NewWeighted(s.processConcurrency)
	var wg sync.WaitGroup
	for name, provider := range s.beaconBlockProposalProviders {
		wg.Add(1)
		go func(ctx context.Context, sem *semaphore.Weighted, wg *sync.WaitGroup, name string, provider eth2client.BeaconBlockProposalProvider, mu *sync.Mutex) {
			defer wg.Done()

			if err := sem.Acquire(ctx, 1); err != nil {
				log.Error().Err(err).Msg("Failed to acquire semaphore")
				return
			}
			defer sem.Release(1)
			log := log.With().Str("provider", name).Uint64("slot", uint64(slot)).Logger()
			log.Trace().Dur("elapsed", time.Since(started)).Msg("Obtained semaphore")

			opCtx, cancel := context.WithTimeout(ctx, s.timeout)
			proposal, err := provider.BeaconBlockProposal(opCtx, slot, randaoReveal, graffiti)
			s.clientMonitor.ClientOperation(name, "beacon block proposal", err == nil, time.Since(started))
			if err != nil {
				log.Warn().Err(err).Msg("Failed to obtain beacon block proposal")
				cancel()
				return
			}
			log.Trace().Dur("elapsed", time.Since(started)).Msg("Obtained beacon block proposal")
			cancel()
			if proposal == nil {
				return
			}

			// Obtain the slot of the block to which the proposal refers.
			// We use this to allow the scorer to score blocks with earlier parents lower.
			parentRoot, err := proposal.ParentRoot()
			if err != nil {
				log.Error().Str("version", proposal.Version.String()).Msg("Failed to obtain parent root")
				return
			}
			var parentSlot phase0.Slot
			parentBlock, err := s.signedBeaconBlockProvider.SignedBeaconBlock(ctx, fmt.Sprintf("%#x", parentRoot[:]))
			switch {
			case err != nil:
				log.Warn().Err(err).Msg("Failed to obtain parent block")
				slot, err := proposal.Slot()
				if err != nil {
					log.Error().Str("version", proposal.Version.String()).Err(err).Msg("Failed to obtain proposal slot")
				}
				parentSlot = slot - 1
			case parentBlock == nil:
				log.Warn().Msg("Empty parent block")
				slot, err := proposal.Slot()
				if err != nil {
					log.Error().Str("version", proposal.Version.String()).Err(err).Msg("Failed to obtain proposal slot")
				}
				parentSlot = slot - 1
			default:
				slot, err := parentBlock.Slot()
				if err != nil {
					log.Error().Str("version", proposal.Version.String()).Err(err).Msg("Failed to obtain proposal slot for parent block")
				}
				parentSlot = slot - 1
			}

			mu.Lock()
			score := scoreBeaconBlockProposal(ctx, name, parentSlot, proposal)
			if score > bestScore || bestProposal == nil {
				bestScore = score
				bestProposal = proposal
				bestProvider = name
			}
			mu.Unlock()
		}(ctx, sem, &wg, name, provider, &mu)
	}
	wg.Wait()

	if bestProvider != "" {
		s.clientMonitor.StrategyOperation("best", bestProvider, "beacon block proposal", time.Since(started))
	}

	return bestProposal, nil
}