fix: ping peers with correct protocol (#344)

Fixes a bug in the routing table peer eviction routine whereby the wrong protocol was being used.

Author: achingbrain

src/constants.ts

@@ -11,6 +11,10 @@ export const hour = 60 * minute
 
 export const MAX_RECORD_AGE = 36 * hour
 
+export const LAN_PREFIX = '/lan'
+
+export const PROTOCOL_PREFIX = '/ipfs'
+
 export const PROTOCOL_DHT = '/kad/1.0.0'
 
 export const RECORD_KEY_PREFIX = '/dht/record'

src/kad-dht.ts

@@ -25,6 +25,7 @@ import type { KadDHTInit } from './index.js'
 import { validators as recordValidators } from '@libp2p/record/validators'
 import { selectors as recordSelectors } from '@libp2p/record/selectors'
 import { symbol } from '@libp2p/interfaces/peer-discovery'
+import { PROTOCOL_DHT, PROTOCOL_PREFIX, LAN_PREFIX } from './constants.js'
 
 export interface SingleKadDHTInit extends KadDHTInit {
   /**
@@ -81,14 +82,15 @@ export class KadDHT extends EventEmitter<PeerDiscoveryEvents> implements DHT, In
     this.running = false
     this.lan = Boolean(lan)
     this.log = logger(`libp2p:kad-dht:${lan === true ? 'lan' : 'wan'}`)
-    this.protocol = `${protocolPrefix ?? '/ipfs'}${lan === true ? '/lan' : ''}/kad/1.0.0`
+    this.protocol = `${protocolPrefix ?? PROTOCOL_PREFIX}${lan === true ? LAN_PREFIX : ''}${PROTOCOL_DHT}`
     this.kBucketSize = kBucketSize ?? 20
     this.clientMode = clientMode ?? true
     this.routingTable = new RoutingTable({
       kBucketSize,
       lan: this.lan,
       pingTimeout,
-      pingConcurrency
+      pingConcurrency,
+      protocol: this.protocol
     })
 
     this.providers = new Providers()

src/routing-table/index.ts

@@ -2,7 +2,6 @@
 import KBuck from 'k-bucket'
 import * as utils from '../utils.js'
 import Queue from 'p-queue'
-import { PROTOCOL_DHT } from '../constants.js'
 import { TimeoutController } from 'timeout-abort-controller'
 import { logger } from '@libp2p/logger'
 import type { PeerId } from '@libp2p/interfaces/peer-id'
@@ -42,6 +41,7 @@ const METRIC_PING_RUNNING = 'ping-running'
 
 export interface RoutingTableInit {
   lan: boolean
+  protocol: string
   kBucketSize?: number
   pingTimeout?: number
   pingConcurrency?: number
@@ -62,16 +62,18 @@ export class RoutingTable implements Startable, Initializable {
   private readonly pingTimeout: number
   private readonly pingConcurrency: number
   private running: boolean
+  private readonly protocol: string
 
   constructor (init: RoutingTableInit) {
-    const { kBucketSize, pingTimeout, lan, pingConcurrency } = init
+    const { kBucketSize, pingTimeout, lan, pingConcurrency, protocol } = init
 
     this.log = logger(`libp2p:kad-dht:${lan ? 'lan' : 'wan'}:routing-table`)
     this.kBucketSize = kBucketSize ?? 20
     this.pingTimeout = pingTimeout ?? 10000
     this.pingConcurrency = pingConcurrency ?? 10
     this.lan = lan
     this.running = false
+    this.protocol = protocol
 
     const updatePingQueueSizeMetric = () => {
       this.components.getMetrics()?.updateComponentMetric({
@@ -156,7 +158,7 @@ export class RoutingTable implements Startable, Initializable {
 
               this.log('pinging old contact %p', oldContact.peer)
               const connection = await this.components.getConnectionManager().openConnection(oldContact.peer, options)
-              const { stream } = await connection.newStream(PROTOCOL_DHT, options)
+              const { stream } = await connection.newStream(this.protocol, options)
               stream.close()
               responded++
             } catch (err: any) {

test/generate-peers/generate-peers.spec.ts

@@ -58,7 +58,8 @@ describe.skip('generate peers', function () {
     })
     const table = new RoutingTable({
       kBucketSize: 20,
-      lan: false
+      lan: false,
+      protocol: '/ipfs/kad/1.0.0'
     })
     table.init(components)
     refresh = new RoutingTableRefresh({

test/routing-table.spec.ts

@@ -24,7 +24,8 @@ describe('Routing Table', () => {
     })
 
     table = new RoutingTable({
-      lan: false
+      lan: false,
+      protocol: PROTOCOL_DHT
     })
     table.init(components)
     await table.start()