feat(SPV-742): adjust to some comments

Author: arkadiuszos4chain

config/defaults.go

@@ -72,8 +72,6 @@ func getP2PDefaults() *P2PConfig {
 		UserAgentName:             ApplicationName,
 		UserAgentVersion:          Version(),
 		Experimental:              false,
-		MaxOutboundConnections:    8,
-		MaxInboundConnections:     8,
 	}
 }
 

internal/transports/p2p/network/address_book.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/bitcoin-sv/block-headers-service/internal/transports/p2p/peer"
 	"github.com/bitcoin-sv/block-headers-service/internal/wire"
+	"golang.org/x/exp/maps"
 )
 
 // AddressBook represents a collection of known network addresses.
@@ -16,11 +17,11 @@ type AddressBook struct {
 	addrs        []*knownAddress // addrs is a slice containing known addresses
 	addrsLookup  map[string]int  // addrLookup is a map for fast lookup of addresses, maps address key to index in addrs slice
 	mu           sync.Mutex
-	addrFitlerFn func(*wire.NetAddress) bool
+	addrFilterFn func(*wire.NetAddress) bool
 }
 
 // NewAddressBook creates and initializes a new AddressBook instance.
-func NewAdressBook(banDuration time.Duration, acceptLocalAddresses bool) *AddressBook {
+func NewAddressBook(banDuration time.Duration, acceptLocalAddresses bool) *AddressBook {
 	// Set the address filter function based on whether local addresses are accepted
 	addrFitlerFn := IsRoutable
 	if acceptLocalAddresses {
@@ -32,7 +33,7 @@ func NewAdressBook(banDuration time.Duration, acceptLocalAddresses bool) *Addres
 		addrs:        make([]*knownAddress, 0, addressesInitCapacity),
 		addrsLookup:  make(map[string]int, addressesInitCapacity),
 		banDuration:  banDuration,
-		addrFitlerFn: addrFitlerFn,
+		addrFilterFn: addrFitlerFn,
 	}
 }
 
@@ -42,12 +43,12 @@ func (a *AddressBook) UpsertPeerAddr(p *peer.Peer) {
 	defer a.mu.Unlock()
 
 	pa := p.GetPeerAddr()
-	key, ka := a.internalFind(pa)
+	key, ka := a.findAddr(pa)
 
 	if ka != nil {
 		ka.peer = p
 	} else {
-		a.internalAddAddr(key, &knownAddress{addr: pa, peer: p})
+		a.addAddr(key, &knownAddress{addr: pa, peer: p})
 	}
 }
 
@@ -57,14 +58,14 @@ func (a *AddressBook) UpsertAddrs(address []*wire.NetAddress) {
 	defer a.mu.Unlock()
 
 	for _, addr := range address {
-		if !a.addrFitlerFn(addr) {
+		if !a.addrFilterFn(addr) {
 			continue
 		}
 
-		key, ka := a.internalFind(addr)
+		key, ka := a.findAddr(addr)
 		// If the address is not found, add it to the AddressBook.
 		if ka == nil {
-			a.internalAddAddr(key, &knownAddress{addr: addr})
+			a.addAddr(key, &knownAddress{addr: addr})
 		} else if addr.Timestamp.After(ka.addr.Timestamp) {
 			// Otherwise, update the timestamp if the new one is newer.
 			ka.addr.Timestamp = addr.Timestamp
@@ -77,18 +78,20 @@ func (a *AddressBook) BanAddr(addr *wire.NetAddress) {
 	a.mu.Lock()
 	defer a.mu.Unlock()
 
-	_, ka := a.internalFind(addr)
+	_, ka := a.findAddr(addr)
 	if ka != nil {
 		now := time.Now()
 		ka.banTimestamp = &now
 	}
 }
 
-// GetRndUnusedAddr returns a randomly chosen unused network address.
-func (a *AddressBook) GetRndUnusedAddr(tries uint) *wire.NetAddress {
+// GetRandUnusedAddr returns a randomly chosen unused network address.
+func (a *AddressBook) GetRandUnusedAddr(tries uint) *wire.NetAddress {
 	a.mu.Lock()
 	defer a.mu.Unlock()
 
+	v := maps.Values(a.addrsLookup)
+
 	alen := len(a.addrs)
 	for i := uint(0); i < tries; i++ {
 		// #nosec G404
@@ -105,7 +108,7 @@ func (a *AddressBook) GetRndUnusedAddr(tries uint) *wire.NetAddress {
 	return nil
 }
 
-func (a *AddressBook) internalFind(addr *wire.NetAddress) (string, *knownAddress) {
+func (a *AddressBook) findAddr(addr *wire.NetAddress) (string, *knownAddress) {
 	key := addrKey(addr)
 	addrIndex, ok := a.addrsLookup[key]
 
@@ -115,7 +118,7 @@ func (a *AddressBook) internalFind(addr *wire.NetAddress) (string, *knownAddress
 	return key, nil
 }
 
-func (a *AddressBook) internalAddAddr(key string, addr *knownAddress) {
+func (a *AddressBook) addAddr(key string, addr *knownAddress) {
 	newItemIndex := len(a.addrs)
 
 	a.addrs = append(a.addrs, addr)

internal/transports/p2p/network/address_book_test.go

@@ -12,7 +12,7 @@ import (
 func TestAddressBook_UpsertAddrs(t *testing.T) {
 	t.Run("add new - accept local", func(t *testing.T) {
 		// given
-		sut := NewAdressBook(0, true)
+		sut := NewAddressBook(0, true)
 		local := &wire.NetAddress{
 			IP:        net.IPv4(127, 0, 0, 1),
 			Port:      8333,
@@ -34,7 +34,7 @@ func TestAddressBook_UpsertAddrs(t *testing.T) {
 
 	t.Run("add new - do not accept local", func(t *testing.T) {
 		// given
-		sut := NewAdressBook(0, false)
+		sut := NewAddressBook(0, false)
 		local := &wire.NetAddress{
 			IP:        net.IPv4(127, 0, 0, 1),
 			Port:      8333,
@@ -56,7 +56,7 @@ func TestAddressBook_UpsertAddrs(t *testing.T) {
 
 	t.Run("add existing", func(t *testing.T) {
 		// given
-		sut := NewAdressBook(0, true)
+		sut := NewAddressBook(0, true)
 		addr := &wire.NetAddress{
 			IP:        net.IPv4(18, 199, 12, 185),
 			Port:      8333,
@@ -82,7 +82,7 @@ func TestAddressBook_UpsertAddrs(t *testing.T) {
 func TestAddressBook_BanAddr(t *testing.T) {
 	t.Run("ban address", func(t *testing.T) {
 		// given
-		sut := NewAdressBook(1, false)
+		sut := NewAddressBook(1, false)
 
 		addr := &wire.NetAddress{
 			IP:        net.IPv4(18, 199, 12, 185),
@@ -100,10 +100,10 @@ func TestAddressBook_BanAddr(t *testing.T) {
 	})
 }
 
-func TestAddressBook_GetRndUnusedAddr(t *testing.T) {
-	t.Run("", func(t *testing.T) {
+func TestAddressBook_GetRandUnusedAddr(t *testing.T) {
+	t.Run("get random address", func(t *testing.T) {
 		// given
-		sut := NewAdressBook(time.Hour, false)
+		sut := NewAddressBook(time.Hour, false)
 
 		addr := &wire.NetAddress{
 			IP:        net.IPv4(18, 199, 12, 186),
@@ -121,7 +121,7 @@ func TestAddressBook_GetRndUnusedAddr(t *testing.T) {
 		sut.BanAddr(addr2)
 
 		// when
-		r := sut.GetRndUnusedAddr(100)
+		r := sut.GetRandUnusedAddr(100)
 
 		// then
 		require.Equal(t, addr, r)

internal/transports/p2p/network/network.go

@@ -5,7 +5,6 @@
 package network
 
 import (
-	"fmt"
 	"net"
 
 	"github.com/bitcoin-sv/block-headers-service/internal/wire"
@@ -238,54 +237,3 @@ func IsRoutableWithLocal(na *wire.NetAddress) bool {
 		IsRFC4843(na) || IsRFC5737(na) || IsRFC6598(na) ||
 		(IsRFC4193(na) && !IsOnionCatTor(na)))
 }
-
-// GroupKey returns a string representing the network group an address is part
-// of.  This is the /16 for IPv4, the /32 (/36 for he.net) for IPv6, the string
-// "local" for a local address, the string "tor:key" where key is the /4 of the
-// onion address for Tor address, and the string "unroutable" for an unroutable
-// address.
-func GroupKey(na *wire.NetAddress) string {
-	if IsLocal(na) {
-		return "local"
-	}
-	if !IsRoutable(na) {
-		return "unroutable"
-	}
-	if IsIPv4(na) {
-		return na.IP.Mask(net.CIDRMask(16, 32)).String()
-	}
-	if IsRFC6145(na) || IsRFC6052(na) {
-		// last four bytes are the ip address
-		ip := na.IP[12:16]
-		return ip.Mask(net.CIDRMask(16, 32)).String()
-	}
-
-	if IsRFC3964(na) {
-		ip := na.IP[2:6]
-		return ip.Mask(net.CIDRMask(16, 32)).String()
-
-	}
-	if IsRFC4380(na) {
-		// teredo tunnels have the last 4 bytes as the v4 address XOR
-		// 0xff.
-		ip := net.IP(make([]byte, 4))
-		for i, ipByte := range na.IP[12:16] {
-			ip[i] = ipByte ^ 0xff
-		}
-		return ip.Mask(net.CIDRMask(16, 32)).String()
-	}
-	if IsOnionCatTor(na) {
-		// group is keyed off the first 4 bits of the actual onion key.
-		return fmt.Sprintf("tor:%d", na.IP[6]&((1<<4)-1))
-	}
-
-	// OK, so now we know ourselves to be a IPv6 address.
-	// bitcoind uses /32 for everything, except for Hurricane Electric's
-	// (he.net) IP range, which it uses /36 for.
-	bits := 32
-	if heNet.Contains(na.IP) {
-		bits = 36
-	}
-
-	return na.IP.Mask(net.CIDRMask(bits, 128)).String()
-}