From 709cc35973d2802b40415e5e8047bba8e55e5d41 Mon Sep 17 00:00:00 2001
From: Matheus Degiovani <opensource@matheusd.com>
Date: Thu, 16 Nov 2023 12:11:50 -0300
Subject: [PATCH] spv: Disconnect from straggler peers

This adds a function to force disconnection from peers that have been
overtaken by the wallet.

During initial sync, we might connect to a peer that is useful during
the earlier block ranges but which is overtaken due to the wallet
connecting to peers with more up to date blocks.

After initial sync completes and the sendheaders message is sent, the
remote peers should be announcing new blocks via headers message. If
a particular peer don't send any headers after the wallet has received
several new headers, it probably means that peer has poor connectivity
to the network and should be disconnected in favor of attempting to find
a better peer.
---
 spv/sync.go | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/spv/sync.go b/spv/sync.go
index 7ef679dd9..46c1ac118 100644
--- a/spv/sync.go
+++ b/spv/sync.go
@@ -6,6 +6,7 @@ package spv
 
 import (
 	"context"
+	"fmt"
 	"runtime"
 	"sync"
 	"sync/atomic"
@@ -1277,6 +1278,7 @@ func (s *Syncer) handleBlockAnnouncements(ctx context.Context, rp *p2p.RemotePee
 		}
 		tipHeader := bestChain[len(bestChain)-1].Header
 		s.setRequiredHeight(int32(tipHeader.Height))
+		s.disconnectStragglers(int32(tipHeader.Height))
 		s.tipChanged(tipHeader, int32(len(prevChain)), matchingTxs)
 
 		return nil
@@ -1314,6 +1316,29 @@ func (s *Syncer) handleBlockAnnouncements(ctx context.Context, rp *p2p.RemotePee
 	return nil
 }
 
+// disconnectStragglers disconnects from any peers that have fallen too much
+// behind the passed tip height.
+func (s *Syncer) disconnectStragglers(height int32) {
+	const stragglerLimit = 6 // How many blocks behind.
+	s.forRemotes(func(rp *p2p.RemotePeer) error {
+		// Use the higher of InitialHeight and LastHeight. During
+		// initial sync, InitialHeight will be higher, after initial
+		// sync and when sendheaders was sent, we'll keep receiving
+		// new headers, which updates LastHeight().
+		peerHeight, initHeight := rp.LastHeight(), rp.InitialHeight()
+		if initHeight > peerHeight {
+			peerHeight = initHeight
+		}
+		if height-peerHeight > stragglerLimit {
+			errMsg := fmt.Sprintf("disconnecting from straggler peer (peer height %d, tip height %d",
+				initHeight, height)
+			err := errors.E(errors.Policy, errMsg)
+			rp.Disconnect(err)
+		}
+		return nil
+	})
+}
+
 // hashStop is a zero value stop hash for fetching all possible data using
 // locators.
 var hashStop chainhash.Hash
@@ -1497,6 +1522,7 @@ func (s *Syncer) getHeaders(ctx context.Context, rp *p2p.RemotePeer) error {
 
 		// Any new peers should not be significantly behind the new tip.
 		s.setRequiredHeight(int32(tip.Header.Height))
+		s.disconnectStragglers(int32(tip.Header.Height))
 
 		// Generate new locators
 		s.locatorMu.Lock()