Break out beacon block proposal functions

2020-09-29 15:57:49 +01:00 · 2020-09-29 15:57:49 +01:00 · 75576b1303
parent 6d3657da5d
commit 75576b1303
5 changed files with 216 additions and 49 deletions
--- a/go.mod
+++ b/go.mod
@ -50,4 +50,5 @@ require (
 	google.golang.org/genproto v0.0.0-20200925023002-c2d885f95484 // indirect
 	google.golang.org/grpc v1.32.0
 	gopkg.in/ini.v1 v1.61.0 // indirect
+	gotest.tools v2.2.0+incompatible
 )
--- a/mock/eth2client.go
+++ b/mock/eth2client.go
@ -20,6 +20,7 @@ import (

 	eth2client "github.com/attestantio/go-eth2-client"
 	spec "github.com/attestantio/go-eth2-client/spec/phase0"
+	"github.com/prysmaticlabs/go-bitfield"
 )

 // GenesisTimeProvider is a mock for eth2client.GenesisTimeProvider.
@ -187,5 +188,84 @@ func NewBeaconBlockProposalProvider() eth2client.BeaconBlockProposalProvider {

 // SubmitBeaconBlock is a mock.
 func (m *BeaconBlockProposalProvider) BeaconBlockProposal(ctx context.Context, slot uint64, randaoReveal []byte, graffiti []byte) (*spec.BeaconBlock, error) {
-	return nil, nil
+	// Graffiti should be 32 bytes.
+	fixedGraffiti := make([]byte, 32)
+	copy(fixedGraffiti, graffiti)
+
+	// Build a beacon block.
+
+	// Create a few attestations.
+	attestations := make([]*spec.Attestation, 4)
+	for i := uint64(0); i < 4; i++ {
+		aggregationBits := bitfield.NewBitlist(128)
+		aggregationBits.SetBitAt(i, true)
+		attestations[i] = &spec.Attestation{
+			AggregationBits: aggregationBits,
+			Data: &spec.AttestationData{
+				Slot:  slot - 1,
+				Index: i,
+				BeaconBlockRoot: []byte{
+					0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
+					0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
+				},
+				Source: &spec.Checkpoint{
+					Epoch: 0,
+					Root: []byte{
+						0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
+						0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
+					},
+				},
+				Target: &spec.Checkpoint{
+					Epoch: 1,
+					Root: []byte{
+						0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
+						0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
+					},
+				},
+			},
+			Signature: []byte{
+				0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
+				0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
+				0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
+				0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
+				0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
+				0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
+			},
+		}
+	}
+
+	block := &spec.BeaconBlock{
+		Slot:          slot,
+		ProposerIndex: 1,
+		ParentRoot: []byte{
+			0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
+			0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
+		},
+		StateRoot: []byte{
+			0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
+			0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
+		},
+		Body: &spec.BeaconBlockBody{
+			RANDAOReveal: randaoReveal,
+			ETH1Data: &spec.ETH1Data{
+				DepositRoot: []byte{
+					0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
+					0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
+				},
+				DepositCount: 16384,
+				BlockHash: []byte{
+					0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
+					0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f,
+				},
+			},
+			Graffiti:          fixedGraffiti,
+			ProposerSlashings: []*spec.ProposerSlashing{},
+			AttesterSlashings: []*spec.AttesterSlashing{},
+			Attestations:      attestations,
+			Deposits:          []*spec.Deposit{},
+			VoluntaryExits:    []*spec.SignedVoluntaryExit{},
+		},
+	}
+
+	return block, nil
 }
--- a/strategies/beaconblockproposal/best/beaconblockproposal.go
+++ b/strategies/beaconblockproposal/best/beaconblockproposal.go
@ -0,0 +1,70 @@
+// 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"
+	"sync"
+	"time"
+
+	eth2client "github.com/attestantio/go-eth2-client"
+	spec "github.com/attestantio/go-eth2-client/spec/phase0"
+	"golang.org/x/sync/semaphore"
+)
+
+// BeaconBlockProposal provies the best beacon block proposal from a number of beacon nodes.
+func (s *Service) BeaconBlockProposal(ctx context.Context, slot uint64, randaoReveal []byte, graffiti []byte) (*spec.BeaconBlock, error) {
+	var mu sync.Mutex
+	bestScore := float64(0)
+	var bestProposal *spec.BeaconBlock
+
+	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", slot).Logger()
+
+			opCtx, cancel := context.WithTimeout(ctx, s.timeout)
+			started := time.Now()
+			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()
+
+			mu.Lock()
+			score := scoreBeaconBlockProposal(ctx, name, proposal)
+			if score > bestScore || bestProposal == nil {
+				bestScore = score
+				bestProposal = proposal
+			}
+			mu.Unlock()
+		}(ctx, sem, &wg, name, provider, &mu)
+	}
+	wg.Wait()
+
+	return bestProposal, nil
+}
--- a/strategies/beaconblockproposal/best/beaconblockproposal_test.go
+++ b/strategies/beaconblockproposal/best/beaconblockproposal_test.go
@ -0,0 +1,64 @@
+// 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_test
+
+import (
+	"context"
+	"testing"
+
+	eth2client "github.com/attestantio/go-eth2-client"
+	"github.com/attestantio/vouch/mock"
+	"github.com/attestantio/vouch/services/metrics/null"
+	"github.com/attestantio/vouch/strategies/beaconblockproposal/best"
+	"github.com/rs/zerolog"
+	"github.com/stretchr/testify/require"
+)
+
+func TestBeaconBlockProposal(t *testing.T) {
+	ctx := context.Background()
+
+	service, err := best.New(ctx,
+		best.WithLogLevel(zerolog.Disabled),
+		best.WithClientMonitor(null.New(context.Background())),
+		best.WithProcessConcurrency(6),
+		best.WithBeaconBlockProposalProviders(map[string]eth2client.BeaconBlockProposalProvider{
+			"one":   mock.NewBeaconBlockProposalProvider(),
+			"two":   mock.NewBeaconBlockProposalProvider(),
+			"three": mock.NewBeaconBlockProposalProvider(),
+		}),
+	)
+	require.NoError(t, err)
+
+	block, err := service.BeaconBlockProposal(ctx,
+		12345,
+		[]byte{
+			0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
+			0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
+		},
+		nil,
+	)
+	require.NoError(t, err)
+	require.NotNil(t, block)
+
+	//	for _, test := range tests {
+	//		t.Run(test.name, func(t *testing.T) {
+	//			_, err := best.New(context.Background(), test.params...)
+	//			if test.err != "" {
+	//				require.EqualError(t, err, test.err)
+	//			} else {
+	//				require.NoError(t, err)
+	//			}
+	//		})
+	//	}
+}
--- a/strategies/beaconblockproposal/best/service.go
+++ b/strategies/beaconblockproposal/best/service.go
@ -15,16 +15,13 @@ package best

 import (
 	"context"
-	"sync"
 	"time"

 	eth2client "github.com/attestantio/go-eth2-client"
-	spec "github.com/attestantio/go-eth2-client/spec/phase0"
 	"github.com/attestantio/vouch/services/metrics"
 	"github.com/pkg/errors"
 	"github.com/rs/zerolog"
 	zerologger "github.com/rs/zerolog/log"
-	"golang.org/x/sync/semaphore"
 )

 // Service is the provider for beacon block proposals.
@ -60,48 +57,3 @@ func New(ctx context.Context, params ...Parameter) (*Service, error) {

 	return s, nil
 }
-
-// BeaconBlockProposal provies the best beacon block proposal from a number of beacon nodes.
-func (s *Service) BeaconBlockProposal(ctx context.Context, slot uint64, randaoReveal []byte, graffiti []byte) (*spec.BeaconBlock, error) {
-	var mu sync.Mutex
-	bestScore := float64(0)
-	var bestProposal *spec.BeaconBlock
-
-	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
-			}
-			log := log.With().Str("provider", name).Uint64("slot", slot).Logger()
-
-			opCtx, cancel := context.WithTimeout(ctx, s.timeout)
-			started := time.Now()
-			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()
-
-			mu.Lock()
-			score := scoreBeaconBlockProposal(ctx, name, proposal)
-			if score > bestScore || bestProposal == nil {
-				bestScore = score
-				bestProposal = proposal
-			}
-			mu.Unlock()
-		}(ctx, sem, &wg, name, provider, &mu)
-	}
-	wg.Wait()
-
-	return bestProposal, nil
-}