Skip mandatory commitment when beefy authorities not changed

contracts/src/BeefyClient.sol

@@ -260,7 +260,7 @@ contract BeefyClient {
             signatureUsageCount = currentValidatorSet.usageCounters.get(proof.index);
             currentValidatorSet.usageCounters.set(proof.index, signatureUsageCount.saturatingAdd(1));
             vset = currentValidatorSet;
-        } else if (commitment.validatorSetID == nextValidatorSet.id) {
+        } else if (commitment.validatorSetID >= nextValidatorSet.id) {
             signatureUsageCount = nextValidatorSet.usageCounters.get(proof.index);
             nextValidatorSet.usageCounters.set(proof.index, signatureUsageCount.saturatingAdd(1));
             vset = nextValidatorSet;
@@ -354,7 +354,7 @@ contract BeefyClient {
 
         bool is_next_session = false;
         ValidatorSetState storage vset;
-        if (commitment.validatorSetID == nextValidatorSet.id) {
+        if (commitment.validatorSetID > currentValidatorSet.id) {
             is_next_session = true;
             vset = nextValidatorSet;
         } else if (commitment.validatorSetID == currentValidatorSet.id) {
@@ -368,7 +368,7 @@ contract BeefyClient {
         bytes32 newMMRRoot = ensureProvidesMMRRoot(commitment);
 
         if (is_next_session) {
-            if (leaf.nextAuthoritySetID != nextValidatorSet.id + 1) {
+            if (leaf.nextAuthoritySetID <= nextValidatorSet.id) {
                 revert InvalidMMRLeaf();
             }
             bool leafIsValid =

relayer/cmd/scan_beefy.go

@@ -61,7 +61,11 @@ func ScanBeefyFn(cmd *cobra.Command, _ []string) error {
 		"validator-set-id":   validatorSetID,
 	}).Info("Connected to relaychain.")
 
-	commitments, err := polkadotListener.Start(ctx, eg, beefyBlock, validatorSetID)
+	var currentState beefy.BeefyState
+	currentState.CurrentValidatorSetId = validatorSetID
+	currentState.LatestBeefyBlock = beefyBlock
+
+	commitments, err := polkadotListener.Start(ctx, eg, currentState)
 	if err != nil {
 		logrus.WithError(err).Fatalf("could not start")
 	}

relayer/relays/beefy/ethereum-writer.go

@@ -89,9 +89,13 @@ func (wr *EthereumWriter) submit(ctx context.Context, task Request) error {
 		return err
 	}
 	if uint32(latestBeefyBlock) >= task.SignedCommitment.Commitment.BlockNumber {
+		log.WithFields(logrus.Fields{
+			"blockNumber":    task.SignedCommitment.Commitment.BlockNumber,
+			"IsHandover":     task.IsHandover,
+			"ValidatorSetID": task.SignedCommitment.Commitment.ValidatorSetID,
+		}).Warn("Ignore outdated commitment")
 		return nil
 	}
-
 	currentValidatorSet, err := wr.contract.CurrentValidatorSet(&callOpts)
 	if err != nil {
 		return err
@@ -103,6 +107,13 @@ func (wr *EthereumWriter) submit(ctx context.Context, task Request) error {
 	task.ValidatorsRoot = currentValidatorSet.Root
 	if task.IsHandover {
 		task.ValidatorsRoot = nextValidatorSet.Root
+		if task.nextAuthoritiesRoot == task.ValidatorsRoot {
+			log.WithFields(logrus.Fields{
+				"blockNumber":    task.SignedCommitment.Commitment.BlockNumber,
+				"ValidatorSetID": task.SignedCommitment.Commitment.ValidatorSetID,
+			}).Warn("Ignore mandatory commitment authorities not change")
+			return nil
+		}
 	}
 
 	// Initial submission

relayer/relays/beefy/main.go

@@ -37,13 +37,15 @@ func NewRelay(config *Config, ethereumKeypair *secp256k1.Keypair) (*Relay, error
 
 	log.Info("Beefy relay created")
 
-	return &Relay{
+	relayer := Relay{
 		config:           config,
 		relaychainConn:   relaychainConn,
 		ethereumConn:     ethereumConn,
 		polkadotListener: polkadotListener,
 		ethereumWriter:   ethereumWriter,
-	}, nil
+	}
+	polkadotListener.relayer = &relayer
+	return &relayer, nil
 }
 
 func (relay *Relay) Start(ctx context.Context, eg *errgroup.Group) error {
@@ -57,16 +59,15 @@ func (relay *Relay) Start(ctx context.Context, eg *errgroup.Group) error {
 		return fmt.Errorf("create ethereum connection: %w", err)
 	}
 
-	initialBeefyBlock, initialValidatorSetID, err := relay.getInitialState(ctx)
+	currentState, err := relay.CurrentState(ctx)
 	if err != nil {
 		return fmt.Errorf("fetch BeefyClient current state: %w", err)
 	}
 	log.WithFields(log.Fields{
-		"beefyBlock":     initialBeefyBlock,
-		"validatorSetID": initialValidatorSetID,
+		"currentState": currentState,
 	}).Info("Retrieved current BeefyClient state")
 
-	requests, err := relay.polkadotListener.Start(ctx, eg, initialBeefyBlock, initialValidatorSetID)
+	requests, err := relay.polkadotListener.Start(ctx, eg, currentState)
 	if err != nil {
 		return fmt.Errorf("initialize polkadot listener: %w", err)
 	}
@@ -79,11 +80,12 @@ func (relay *Relay) Start(ctx context.Context, eg *errgroup.Group) error {
 	return nil
 }
 
-func (relay *Relay) getInitialState(ctx context.Context) (uint64, uint64, error) {
+func (relay *Relay) CurrentState(ctx context.Context) (BeefyState, error) {
+	var currentState BeefyState
 	address := common.HexToAddress(relay.config.Sink.Contracts.BeefyClient)
 	beefyClient, err := contracts.NewBeefyClient(address, relay.ethereumConn.Client())
 	if err != nil {
-		return 0, 0, err
+		return currentState, err
 	}
 
 	callOpts := bind.CallOpts{
@@ -92,13 +94,26 @@ func (relay *Relay) getInitialState(ctx context.Context) (uint64, uint64, error)
 
 	latestBeefyBlock, err := beefyClient.LatestBeefyBlock(&callOpts)
 	if err != nil {
-		return 0, 0, err
+		return currentState, err
 	}
 
 	currentValidatorSet, err := beefyClient.CurrentValidatorSet(&callOpts)
 	if err != nil {
-		return 0, 0, err
+		return currentState, err
+	}
+
+	nextValidatorSet, err := beefyClient.NextValidatorSet(&callOpts)
+	if err != nil {
+		return currentState, err
+	}
+
+	currentState = BeefyState{
+		LatestBeefyBlock:        latestBeefyBlock,
+		CurrentValidatorSetId:   currentValidatorSet.Id.Uint64(),
+		CurrentValidatorSetRoot: currentValidatorSet.Root,
+		NextValidatorSetId:      nextValidatorSet.Id.Uint64(),
+		NextValidatorSetRoot:    nextValidatorSet.Root,
 	}
 
-	return latestBeefyBlock, currentValidatorSet.Id.Uint64(), nil
+	return currentState, nil
 }

relayer/relays/beefy/parameters.go

@@ -245,3 +245,11 @@ func proofToLog(proof contracts.BeefyClientValidatorProof) logrus.Fields {
 		"Proof":   hexProof,
 	}
 }
+
+type BeefyState struct {
+	LatestBeefyBlock        uint64
+	CurrentValidatorSetId   uint64
+	CurrentValidatorSetRoot [32]byte
+	NextValidatorSetId      uint64
+	NextValidatorSetRoot    [32]byte
+}

relayer/relays/beefy/polkadot-listener.go

@@ -17,6 +17,7 @@ type PolkadotListener struct {
 	config              *SourceConfig
 	conn                *relaychain.Connection
 	beefyAuthoritiesKey types.StorageKey
+	relayer             *Relay
 }
 
 func NewPolkadotListener(
@@ -32,8 +33,7 @@ func NewPolkadotListener(
 func (li *PolkadotListener) Start(
 	ctx context.Context,
 	eg *errgroup.Group,
-	currentBeefyBlock uint64,
-	currentValidatorSetID uint64,
+	currentState BeefyState,
 ) (<-chan Request, error) {
 	storageKey, err := types.CreateStorageKey(li.conn.Metadata(), "Beefy", "Authorities", nil, nil)
 	if err != nil {
@@ -45,7 +45,7 @@ func (li *PolkadotListener) Start(
 
 	eg.Go(func() error {
 		defer close(requests)
-		err := li.scanCommitments(ctx, currentBeefyBlock, currentValidatorSetID, requests)
+		err := li.scanCommitments(ctx, currentState, requests)
 		if err != nil {
 			return err
 		}
@@ -57,16 +57,15 @@ func (li *PolkadotListener) Start(
 
 func (li *PolkadotListener) scanCommitments(
 	ctx context.Context,
-	currentBeefyBlock uint64,
-	currentValidatorSet uint64,
+	currentState BeefyState,
 	requests chan<- Request,
 ) error {
-	in, err := ScanSafeCommitments(ctx, li.conn.Metadata(), li.conn.API(), currentBeefyBlock+1)
+	lastSyncedBeefyBlock := currentState.LatestBeefyBlock
+	currentValidatorSet := currentState.CurrentValidatorSetId
+	in, err := ScanSafeCommitments(ctx, li.conn.Metadata(), li.conn.API(), lastSyncedBeefyBlock+1)
 	if err != nil {
 		return fmt.Errorf("scan commitments: %w", err)
 	}
-	lastSyncedBeefyBlock := currentBeefyBlock
-
 	for {
 		select {
 		case <-ctx.Done():
@@ -83,43 +82,49 @@ func (li *PolkadotListener) scanCommitments(
 			validatorSetID := result.SignedCommitment.Commitment.ValidatorSetID
 			nextValidatorSetID := uint64(result.MMRProof.Leaf.BeefyNextAuthoritySet.ID)
 
-			if validatorSetID != currentValidatorSet && validatorSetID != currentValidatorSet+1 {
-				return fmt.Errorf("commitment has unexpected validatorSetID: blockNumber=%v validatorSetID=%v expectedValidatorSetID=%v",
-					committedBeefyBlock,
-					validatorSetID,
-					currentValidatorSet,
-				)
-			}
-
 			logEntry := log.WithFields(log.Fields{
 				"commitment": log.Fields{
 					"blockNumber":        committedBeefyBlock,
 					"validatorSetID":     validatorSetID,
 					"nextValidatorSetID": nextValidatorSetID,
 				},
 				"validatorSetID":       currentValidatorSet,
-				"IsHandover":           validatorSetID == currentValidatorSet+1,
+				"IsHandover":           validatorSetID > currentValidatorSet,
 				"lastSyncedBeefyBlock": lastSyncedBeefyBlock,
 			})
 
 			validators, err := li.queryBeefyAuthorities(result.BlockHash)
 			if err != nil {
 				return fmt.Errorf("fetch beefy authorities at block %v: %w", result.BlockHash, err)
 			}
+			nextAuthoritySet, err := li.queryBeefyNextAuthoritySet(result.BlockHash)
+			if err != nil {
+				return fmt.Errorf("fetch beefy authorities set at block %v: %w", result.BlockHash, err)
+			}
 			task := Request{
 				Validators:       validators,
 				SignedCommitment: result.SignedCommitment,
 				Proof:            result.MMRProof,
 			}
 
-			if validatorSetID == currentValidatorSet+1 && validatorSetID == nextValidatorSetID-1 {
+			currentState, err = li.relayer.CurrentState(ctx)
+			if err != nil {
+				return fmt.Errorf("get current state from beefy LC %w", err)
+			}
+
+			if validatorSetID > currentValidatorSet {
+				if nextAuthoritySet.Root == currentState.NextValidatorSetRoot && committedBeefyBlock < lastSyncedBeefyBlock+li.config.UpdatePeriod {
+					logEntry.Info("Discarded commitment with beefy authorities not change")
+					continue
+				}
 				task.IsHandover = true
+				task.nextAuthoritiesRoot = nextAuthoritySet.Root
 				select {
 				case <-ctx.Done():
 					return ctx.Err()
 				case requests <- task:
 					logEntry.Info("New commitment with handover added to channel")
-					currentValidatorSet++
+					currentValidatorSet = validatorSetID
 					lastSyncedBeefyBlock = committedBeefyBlock
 				}
 			} else if validatorSetID == currentValidatorSet {
@@ -164,7 +169,7 @@ func (li *PolkadotListener) queryBeefyAuthorities(blockHash types.Hash) ([]subst
 
 func (li *PolkadotListener) queryBeefyNextAuthoritySet(blockHash types.Hash) (types.BeefyNextAuthoritySet, error) {
 	var nextAuthoritySet types.BeefyNextAuthoritySet
-	storageKey, err := types.CreateStorageKey(li.conn.Metadata(), "MmrLeaf", "BeefyNextAuthorities", nil, nil)
+	storageKey, err := types.CreateStorageKey(li.conn.Metadata(), "BeefyMmrLeaf", "BeefyNextAuthorities", nil, nil)
 	ok, err := li.conn.API().RPC.State.GetStorage(storageKey, &nextAuthoritySet, blockHash)
 	if err != nil {
 		return nextAuthoritySet, err
@@ -175,3 +180,19 @@ func (li *PolkadotListener) queryBeefyNextAuthoritySet(blockHash types.Hash) (ty
 
 	return nextAuthoritySet, nil
 }
+
+type BeefyAuthoritySet = types.BeefyNextAuthoritySet
+
+func (li *PolkadotListener) queryBeefyAuthoritySet(blockHash types.Hash) (BeefyAuthoritySet, error) {
+	var authoritySet BeefyAuthoritySet
+	storageKey, err := types.CreateStorageKey(li.conn.Metadata(), "BeefyMmrLeaf", "BeefyAuthorities", nil, nil)
+	ok, err := li.conn.API().RPC.State.GetStorage(storageKey, &authoritySet, blockHash)
+	if err != nil {
+		return authoritySet, err
+	}
+	if !ok {
+		return authoritySet, fmt.Errorf("beefy AuthoritySet not found")
+	}
+
+	return authoritySet, nil
+}

relayer/relays/beefy/scanner.go

@@ -128,10 +128,6 @@ func scanCommitments(ctx context.Context, api *gsrpc.SubstrateAPI, startBlock ui
 				sendError(fmt.Errorf("fetch block: %w", err))
 				return
 			}
-			log.WithFields(log.Fields{
-				"blockNumber": result.BlockNumber,
-				"depth":       result.Depth,
-			}).Info("fetch block")
 
 			var commitment *types.SignedCommitment
 			for j := range block.Justifications {
@@ -210,11 +206,6 @@ func scanSafeCommitments(ctx context.Context, meta *types.Metadata, api *gsrpc.S
 				sendError(result.Error)
 				return
 			}
-			log.WithFields(log.Fields{
-				"blockNumber": result.BlockNumber,
-				"depth":       result.Depth,
-				"commitment":  result.SignedCommitment.Commitment,
-			}).Info("fetch commitment")
 
 			blockNumber := result.SignedCommitment.Commitment.BlockNumber
 			blockHash, err := api.RPC.Chain.GetBlockHash(uint64(blockNumber))

relayer/relays/beefy/task.go

@@ -7,9 +7,10 @@ import (
 )
 
 type Request struct {
-	Validators       []substrate.Authority
-	ValidatorsRoot   [32]byte
-	SignedCommitment types.SignedCommitment
-	Proof            merkle.SimplifiedMMRProof
-	IsHandover       bool
+	Validators          []substrate.Authority
+	ValidatorsRoot      [32]byte
+	nextAuthoritiesRoot [32]byte
+	SignedCommitment    types.SignedCommitment
+	Proof               merkle.SimplifiedMMRProof
+	IsHandover          bool
 }