Rate limit beefy updates (#1098)

* Rate limit beefy updates * Improve log * Set session length to 2 mins * Comments * Update relayer/relays/beefy/config.go Co-authored-by: Vincent Geddes <[email protected]> * Update relayer/relays/beefy/config.go Co-authored-by: Vincent Geddes <[email protected]> * Set to zero for local setup --------- Co-authored-by: Vincent Geddes <[email protected]>
Snowfork · Jan 18, 2024 · 28e4f09 · 28e4f09
1 parent 2710a25
commit 28e4f09
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 8 deletions.
diff --git a/relayer/relays/beefy/config.go b/relayer/relays/beefy/config.go
@@ -10,8 +10,11 @@ type Config struct {
 }
 
 type SourceConfig struct {
-	Polkadot         config.PolkadotConfig `mapstructure:"polkadot"`
-	FastForwardDepth uint64                `mapstructure:"fast-forward-depth"`
+	Polkadot config.PolkadotConfig `mapstructure:"polkadot"`
+	// Depth to ignore the beefy updates too far away (in number of blocks)
+	FastForwardDepth uint64 `mapstructure:"fast-forward-depth"`
+	// Period to sample the beefy updates (in number of blocks)
+	UpdatePeriod uint64 `mapstructure:"update-period"`
 }
 
 type SinkConfig struct {

diff --git a/relayer/relays/beefy/ethereum-writer.go b/relayer/relays/beefy/ethereum-writer.go
@@ -125,7 +125,11 @@ func (wr *EthereumWriter) submit(ctx context.Context, task Request) error {
 		return err
 	}
 
-	log.WithFields(logrus.Fields{"tx": tx.Hash().Hex(), "blockNumber": task.SignedCommitment.Commitment.BlockNumber}).Debug("Transaction SubmitFinal succeeded")
+	log.WithFields(logrus.Fields{
+		"tx":          tx.Hash().Hex(),
+		"blockNumber": task.SignedCommitment.Commitment.BlockNumber,
+		"IsHandover":  task.IsHandover,
+	}).Debug("Transaction SubmitFinal succeeded")
 
 	return nil
 

diff --git a/relayer/relays/beefy/polkadot-listener.go b/relayer/relays/beefy/polkadot-listener.go
@@ -65,6 +65,7 @@ func (li *PolkadotListener) scanCommitments(
 	if err != nil {
 		return fmt.Errorf("scan commitments: %w", err)
 	}
+	lastSyncedBeefyBlock := currentBeefyBlock
 
 	for {
 		select {
@@ -78,7 +79,7 @@ func (li *PolkadotListener) scanCommitments(
 				return fmt.Errorf("scan safe commitments: %w", result.Error)
 			}
 
-			committedBeefyBlock := result.SignedCommitment.Commitment.BlockNumber
+			committedBeefyBlock := uint64(result.SignedCommitment.Commitment.BlockNumber)
 			validatorSetID := result.SignedCommitment.Commitment.ValidatorSetID
 			nextValidatorSetID := uint64(result.MMRProof.Leaf.BeefyNextAuthoritySet.ID)
 
@@ -96,8 +97,9 @@ func (li *PolkadotListener) scanCommitments(
 					"validatorSetID":     validatorSetID,
 					"nextValidatorSetID": nextValidatorSetID,
 				},
-				"validatorSetID": currentValidatorSet,
-				"IsHandover":     validatorSetID == currentValidatorSet+1,
+				"validatorSetID":       currentValidatorSet,
+				"IsHandover":           validatorSetID == currentValidatorSet+1,
+				"lastSyncedBeefyBlock": lastSyncedBeefyBlock,
 			})
 
 			validators, err := li.queryBeefyAuthorities(result.BlockHash)
@@ -118,18 +120,24 @@ func (li *PolkadotListener) scanCommitments(
 				case requests <- task:
 					logEntry.Info("New commitment with handover added to channel")
 					currentValidatorSet++
+					lastSyncedBeefyBlock = committedBeefyBlock
 				}
 			} else if validatorSetID == currentValidatorSet {
 				if result.Depth > li.config.FastForwardDepth {
 					logEntry.Warn("Discarded commitment with depth not fast forward")
 					continue
 				}
+				if committedBeefyBlock < lastSyncedBeefyBlock+li.config.UpdatePeriod {
+					logEntry.Info("Discarded commitment with sampling")
+					continue
+				}
 
 				// drop task if it can't be processed immediately
 				select {
 				case <-ctx.Done():
 					return ctx.Err()
 				case requests <- task:
+					lastSyncedBeefyBlock = committedBeefyBlock
 					logEntry.Info("New commitment added to channel")
 				default:
 					logEntry.Warn("Discarded commitment fail adding to channel")

diff --git a/web/packages/test/config/beefy-relay.json b/web/packages/test/config/beefy-relay.json
@@ -4,7 +4,8 @@
       "endpoint": "ws://127.0.0.1:9944"
     },
     "beefy-activation-block": 0,
-    "fast-forward-depth": 20
+    "fast-forward-depth": 20,
+    "update-period": 0
   },
   "sink": {
     "ethereum": {

diff --git a/web/packages/test/scripts/build-binary.sh b/web/packages/test/scripts/build-binary.sh
@@ -17,7 +17,8 @@ build_binaries() {
     # Check that all 3 binaries are available and no changes made in the polkadot and substrate dirs
     if [[ ! -e "target/release/polkadot" || ! -e "target/release/polkadot-execute-worker" || ! -e "target/release/polkadot-prepare-worker" || "$changes_detected" -eq 1 ]]; then
         echo "Building polkadot binary, due to changes detected in polkadot or substrate, or binaries not found"
-        cargo build --release --locked --bin polkadot --bin polkadot-execute-worker --bin polkadot-prepare-worker
+        # Increase session length to 2 mins
+        ROCOCO_EPOCH_DURATION=20 cargo build --release --locked --bin polkadot --bin polkadot-execute-worker --bin polkadot-prepare-worker
     else
         echo "No changes detected in polkadot or substrate and binaries are available, not rebuilding relaychain binaries."
     fi