Merge pull request #369 from attestantio/vouch-combined-att

Add combinedmajority attestation strategy

Author: Bez625

.github/workflows/release.yml

@@ -64,9 +64,6 @@ jobs:
           sudo apt-mark hold grub-efi-amd64-signed grub-efi-amd64-bin
           sudo apt-get update
           sudo apt-get upgrade
-          echo "================================================================================"
-          go version
-          echo "================================================================================"
           go build -tags osusergo,netgo -v -ldflags="-X github.com/${{ github.repository }}/cmd.ReleaseVersion=${{ needs.env_vars.outputs.release_version }} -extldflags -static"
           tar zcf ${{ needs.env_vars.outputs.binary }}-${{ needs.env_vars.outputs.release_version }}-linux-amd64.tar.gz ${{ needs.env_vars.outputs.binary }}
           sha256sum ${{ needs.env_vars.outputs.binary }}-${{ needs.env_vars.outputs.release_version }}-linux-amd64.tar.gz | sed -e 's/ .*//' >${{ needs.env_vars.outputs.binary }}-${{ needs.env_vars.outputs.release_version }}-linux-amd64.tar.gz.sha256

.golangci.yml

@@ -91,9 +91,11 @@ linters:
     - gochecknoglobals
     - gocognit
     - goconst
+    - godoclint
     - iface
     - ireturn
     - lll
+    - modernize
     - mnd
     - nestif
     - nilnil

CHANGELOG.md

@@ -1,5 +1,6 @@
 dev:
   - update majordomo to v1.1.2
+  - add combinedmajority attestationdata strategy
 
 1.12.0:
   - import fulu container specs from go-eth2-client

main.go

@@ -83,6 +83,7 @@ import (
 	bestaggregateattestationstrategy "github.com/attestantio/vouch/strategies/aggregateattestation/best"
 	firstaggregateattestationstrategy "github.com/attestantio/vouch/strategies/aggregateattestation/first"
 	bestattestationdatastrategy "github.com/attestantio/vouch/strategies/attestationdata/best"
+	combinedmajorityattestationdatastrategy "github.com/attestantio/vouch/strategies/attestationdata/combinedmajority"
 	firstattestationdatastrategy "github.com/attestantio/vouch/strategies/attestationdata/first"
 	majorityattestationdatastrategy "github.com/attestantio/vouch/strategies/attestationdata/majority"
 	combinedattestationpoolstrategy "github.com/attestantio/vouch/strategies/attestationpool/combined"
@@ -115,7 +116,7 @@ import (
 )
 
 // ReleaseVersion is the release version for the code.
-var ReleaseVersion = "1.13.0-dev"
+var ReleaseVersion = "1.13.0-alpha.1"
 
 func main() {
 	exitCode := main2()
@@ -1249,6 +1250,30 @@ func selectAttestationDataProvider(ctx context.Context,
 		if err != nil {
 			return nil, errors.Wrap(err, "failed to start majority attestation data strategy")
 		}
+	case "combinedmajority":
+		log.Info().Msg("Starting combinedmajority attestation data strategy")
+		attestationDataProviders := make(map[string]eth2client.AttestationDataProvider)
+		for _, address := range util.BeaconNodeAddresses("strategies.attestationdata.combinedmajority") {
+			client, err := fetchClient(ctx, monitor, address)
+			if err != nil {
+				return nil, errors.Wrap(err, fmt.Sprintf("failed to fetch client %s for combinedmajority attestation data strategy", address))
+			}
+			attestationDataProviders[address] = client.(eth2client.AttestationDataProvider)
+		}
+		attestationDataProvider, err = combinedmajorityattestationdatastrategy.New(ctx,
+			combinedmajorityattestationdatastrategy.WithClientMonitor(monitor.(metrics.ClientMonitor)),
+			combinedmajorityattestationdatastrategy.WithProcessConcurrency(util.ProcessConcurrency("strategies.attestationdata.combinedmajority")),
+			combinedmajorityattestationdatastrategy.WithLogLevel(util.LogLevel("strategies.attestationdata.combinedmajority")),
+			combinedmajorityattestationdatastrategy.WithAttestationDataProviders(attestationDataProviders),
+			combinedmajorityattestationdatastrategy.WithTimeout(util.Timeout("strategies.attestationdata.combinedmajority")),
+			combinedmajorityattestationdatastrategy.WithChainTime(chainTime),
+			combinedmajorityattestationdatastrategy.WithBlockRootToSlotCache(cacheSvc.(cache.BlockRootToSlotProvider)),
+			combinedmajorityattestationdatastrategy.WithThreshold(viper.GetInt("strategies.attestationdata.combinedmajority.threshold")),
+		)
+		if err != nil {
+			return nil, errors.Wrap(err, "failed to start combinedmajority attestation data strategy")
+		}
+
 	case "first":
 		log.Info().Msg("Starting first attestation data strategy")
 		attestationDataProviders := make(map[string]eth2client.AttestationDataProvider)

mock/eth2client.go

@@ -985,6 +985,84 @@ func (*AttestationDataProvider) AttestationData(_ context.Context,
 	}, nil
 }
 
+// CustomAttestationDataProvider is a mock for eth2client.AttestationDataProvider.
+type CustomAttestationDataProvider struct {
+	changeSlot int
+	changeRoot bool
+}
+
+// NewFuzzingAttestationDataProvider returns a mock attestation data provider.
+// changeSlot: how much to add to the slot, 0 for no change, positive for later, negative for earlier.
+// changeRoot: whether to change the root based on the slot.
+func NewCustomAttestationDataProvider(changeSlot int, changeRoot bool) eth2client.AttestationDataProvider {
+	return &CustomAttestationDataProvider{changeSlot: changeSlot, changeRoot: changeRoot}
+}
+
+// AttestationData is a mock.
+func (m *CustomAttestationDataProvider) AttestationData(_ context.Context,
+	opts *api.AttestationDataOpts,
+) (
+	*api.Response[*phase0.AttestationData],
+	error,
+) {
+	slot := opts.Slot + phase0.Slot(m.changeSlot)
+	// Generate a fixed block root according to the slot.
+	firstByte := byte(opts.Slot & 0xff)
+	if m.changeRoot {
+		firstByte = byte(slot & 0xff)
+	}
+	beaconBlockRoot := phase0.Root([32]byte{
+		firstByte, 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 := &phase0.Checkpoint{
+		Epoch: phase0.Epoch(slot/32 - 1),
+		Root: phase0.Root([32]byte{
+			firstByte, 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 := &phase0.Checkpoint{
+		Epoch: phase0.Epoch(slot / 32),
+		Root: phase0.Root([32]byte{
+			firstByte, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
+			0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
+		}),
+	}
+
+	return &api.Response[*phase0.AttestationData]{
+		Data: &phase0.AttestationData{
+			Slot:            slot,
+			Index:           opts.CommitteeIndex,
+			BeaconBlockRoot: beaconBlockRoot,
+			Source:          source,
+			Target:          target,
+		},
+		Metadata: make(map[string]any),
+	}, nil
+}
+
+// EmptyAttestationDataProvider is a mock for eth2client.AttestationDataProvider.
+type EmptyAttestationDataProvider struct{}
+
+// NewEmptyAttestationDataProvider returns a mock attestation data provider.
+func NewEmptyAttestationDataProvider() eth2client.AttestationDataProvider {
+	return &EmptyAttestationDataProvider{}
+}
+
+// AttestationData is a mock.
+func (*EmptyAttestationDataProvider) AttestationData(_ context.Context,
+	opts *api.AttestationDataOpts,
+) (
+	*api.Response[*phase0.AttestationData],
+	error,
+) {
+	return &api.Response[*phase0.AttestationData]{
+		Data:     &phase0.AttestationData{Slot: opts.Slot},
+		Metadata: make(map[string]any),
+	}, nil
+}
+
 // ErroringAttestationDataProvider is a mock for eth2client.AttestationDataProvider.
 type ErroringAttestationDataProvider struct{}
 

strategies/attestationdata/best/attestationdata.go

@@ -174,7 +174,7 @@ func (s *Service) AttestationData(ctx context.Context,
 		Msg("Results")
 
 	if bestAttestationData == nil {
-		return nil, errors.New("no attestations received")
+		return nil, errors.New("no attestation data received")
 	}
 	log.Trace().Str("provider", bestProvider).Stringer("attestation_data", bestAttestationData).Float64("score", bestScore).Msg("Selected best attestation")
 	if bestProvider != "" {

strategies/attestationdata/best/attestationdata_test.go

@@ -81,7 +81,7 @@ func TestAttestationData(t *testing.T) {
 			},
 			slot:           12345,
 			committeeIndex: 3,
-			err:            "no attestations received",
+			err:            "no attestation data received",
 		},
 		{
 			name: "GoodMixed",