fix!: use libp2p ping instad of kad ping (#3074)

The [kad-dht spec](s://github.com./libp2p/specs/tree/master/kad-dht)
says:

> PING: Deprecated message type replaced by the dedicated ping protocol. Implementations may still handle incoming PING requests for backwards compatibility. Implementations must not actively send PING requests.

Switch to using `@libp2p/ping` instead of KAD-DHT `PING` messages to
be compliant with the spec.

BREAKING CHANGE: `@libp2p/kad-dht` now depends on `@libp2p/ping` - please configure this in your service map

Author: achingbrain

.github/workflows/examples.yml

@@ -74,13 +74,15 @@ jobs:
               - '@libp2p/identify@$PWD/packages/protocol-identify'
               - '@libp2p/kad-dht@$PWD/packages/kad-dht'
               - '@libp2p/mdns@$PWD/packages/peer-discovery-mdns'
+              - '@libp2p/ping@$PWD/packages/protocol-ping'
               - '@libp2p/tcp@$PWD/packages/transport-tcp'
               - 'libp2p@$PWD/packages/libp2p'
           - name: js-libp2p-example-peer-and-content-routing
             repo: https://github.com./libp2p/js-libp2p-example-peer-and-content-routing.git
             deps:
               - '@libp2p/identify@$PWD/packages/protocol-identify'
               - '@libp2p/kad-dht@$PWD/packages/kad-dht'
+              - '@libp2p/ping@$PWD/packages/protocol-ping'
               - '@libp2p/tcp@$PWD/packages/transport-tcp'
               - 'libp2p@$PWD/packages/libp2p'
           - name: js-libp2p-example-pnet

packages/integration-tests/test/circuit-relay-discovery.node.ts

@@ -5,6 +5,7 @@ import { circuitRelayServer, type CircuitRelayService, circuitRelayTransport } f
 import { identify } from '@libp2p/identify'
 import { stop } from '@libp2p/interface'
 import { kadDHT, passthroughMapper } from '@libp2p/kad-dht'
+import { ping } from '@libp2p/ping'
 import { plaintext } from '@libp2p/plaintext'
 import { tcp } from '@libp2p/tcp'
 import { expect } from 'aegir/chai'
@@ -43,6 +44,7 @@ describe('circuit-relay discovery', () => {
           }
         }),
         identify: identify(),
+        ping: ping(),
         kadDht: kadDHT({
           protocol: DHT_PROTOCOL,
           peerInfoMapper: passthroughMapper,
@@ -66,6 +68,7 @@ describe('circuit-relay discovery', () => {
       ],
       services: {
         identify: identify(),
+        ping: ping(),
         kadDht: kadDHT({
           protocol: DHT_PROTOCOL,
           peerInfoMapper: passthroughMapper,
@@ -108,6 +111,7 @@ describe('circuit-relay discovery', () => {
         ],
         services: {
           identify: identify(),
+          ping: ping(),
           kadDht: kadDHT({
             protocol: DHT_PROTOCOL,
             peerInfoMapper: passthroughMapper,
@@ -133,6 +137,7 @@ describe('circuit-relay discovery', () => {
         ],
         services: {
           identify: identify(),
+          ping: ping(),
           kadDht: kadDHT({
             protocol: DHT_PROTOCOL,
             peerInfoMapper: passthroughMapper,

packages/integration-tests/test/dht.node.ts

@@ -1,8 +1,10 @@
 /* eslint-env mocha */
 
 import { yamux } from '@chainsafe/libp2p-yamux'
+import { identify, type Identify } from '@libp2p/identify'
 import { kadDHT, passthroughMapper } from '@libp2p/kad-dht'
 import { mplex } from '@libp2p/mplex'
+import { ping } from '@libp2p/ping'
 import { plaintext } from '@libp2p/plaintext'
 import { tcp } from '@libp2p/tcp'
 import { multiaddr } from '@multiformats/multiaddr'
@@ -13,6 +15,7 @@ import pWaitFor from 'p-wait-for'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import type { Libp2p, PeerId } from '@libp2p/interface'
 import type { KadDHT } from '@libp2p/kad-dht'
+import type { PingService } from '@libp2p/ping'
 import type { Multiaddr } from '@multiformats/multiaddr'
 import type { Libp2pOptions } from 'libp2p'
 
@@ -62,7 +65,9 @@ describe('DHT subsystem operates correctly', () => {
             protocol: subsystemMulticodecs[0],
             peerInfoMapper: passthroughMapper,
             allowQueryWithZeroPeers: true
-          })
+          }),
+          ping: ping(),
+          identify: identify()
         }
       })
 
@@ -85,7 +90,9 @@ describe('DHT subsystem operates correctly', () => {
             protocol: subsystemMulticodecs[0],
             peerInfoMapper: passthroughMapper,
             allowQueryWithZeroPeers: true
-          })
+          }),
+          ping: ping(),
+          identify: identify()
         }
       })
 
@@ -145,7 +152,7 @@ describe('DHT subsystem operates correctly', () => {
   it('kad-dht should discover other peers', async () => {
     const deferred = pDefer()
 
-    const getConfig = (): Libp2pOptions<{ dht: KadDHT }> => ({
+    const getConfig = (): Libp2pOptions<{ dht: KadDHT, ping: PingService, identify: Identify }> => ({
       addresses: {
         listen: [
           listenAddr.toString()
@@ -156,7 +163,9 @@ describe('DHT subsystem operates correctly', () => {
           protocol: subsystemMulticodecs[0],
           peerInfoMapper: passthroughMapper,
           allowQueryWithZeroPeers: true
-        })
+        }),
+        ping: ping(),
+        identify: identify()
       }
     })
 

packages/integration-tests/test/interop.ts

@@ -7,11 +7,12 @@ import { privateKeyFromProtobuf } from '@libp2p/crypto/keys'
 import { createClient } from '@libp2p/daemon-client'
 import { createServer } from '@libp2p/daemon-server'
 import { floodsub } from '@libp2p/floodsub'
-import { identify } from '@libp2p/identify'
+import { identify, type Identify } from '@libp2p/identify'
 import { UnsupportedError, interopTests } from '@libp2p/interop'
 import { kadDHT, passthroughMapper } from '@libp2p/kad-dht'
 import { logger } from '@libp2p/logger'
 import { mplex } from '@libp2p/mplex'
+import { ping } from '@libp2p/ping'
 import { plaintext } from '@libp2p/plaintext'
 import { tcp } from '@libp2p/tcp'
 import { tls } from '@libp2p/tls'
@@ -23,6 +24,7 @@ import { createLibp2p, type Libp2pOptions, type ServiceFactoryMap } from 'libp2p
 import pDefer from 'p-defer'
 import type { ServiceMap, PrivateKey } from '@libp2p/interface'
 import type { SpawnOptions, Daemon, DaemonFactory } from '@libp2p/interop'
+import type { PingService } from '@libp2p/ping'
 
 /**
  * @packageDocumentation
@@ -155,8 +157,9 @@ async function createJsPeer (options: SpawnOptions): Promise<Daemon> {
     throw new UnsupportedError()
   }
 
-  const services: ServiceFactoryMap = {
-    identify: identify()
+  const services: ServiceFactoryMap<{ identify: Identify, ping: PingService } & Record<string, any>> = {
+    identify: identify(),
+    ping: ping()
   }
 
   if (options.encryption === 'tls') {

packages/kad-dht/README.md

@@ -34,12 +34,16 @@ The Kademlia DHT allow for several operations such as finding peers, searching f
 import { kadDHT } from '@libp2p/kad-dht'
 import { createLibp2p } from 'libp2p'
 import { peerIdFromString } from '@libp2p/peer-id'
+import { ping } from '@libp2p/ping'
+import { identify } from '@libp2p/identify'
 
 const node = await createLibp2p({
   services: {
     dht: kadDHT({
       // DHT options
-    })
+    }),
+    ping: ping(),
+    identify: identify()
   }
 })
 
@@ -59,13 +63,17 @@ If you are trying to access content on the public internet, this is the implemen
 import { kadDHT, removePrivateAddressesMapper } from '@libp2p/kad-dht'
 import { createLibp2p } from 'libp2p'
 import { peerIdFromString } from '@libp2p/peer-id'
+import { ping } from '@libp2p/ping'
+import { identify } from '@libp2p/identify'
 
 const node = await createLibp2p({
   services: {
     aminoDHT: kadDHT({
       protocol: '/ipfs/kad/1.0.0',
       peerInfoMapper: removePrivateAddressesMapper
-    })
+    }),
+    ping: ping(),
+    identify: identify()
   }
 })
 
@@ -85,14 +93,18 @@ This is for use when peers are on the local area network.
 import { kadDHT, removePublicAddressesMapper } from '@libp2p/kad-dht'
 import { createLibp2p } from 'libp2p'
 import { peerIdFromString } from '@libp2p/peer-id'
+import { ping } from '@libp2p/ping'
+import { identify } from '@libp2p/identify'
 
 const node = await createLibp2p({
   services: {
     lanDHT: kadDHT({
       protocol: '/ipfs/lan/kad/1.0.0',
       peerInfoMapper: removePublicAddressesMapper,
       clientMode: false
-    })
+    }),
+    ping: ping(),
+    identify: identify()
   }
 })
 
@@ -111,6 +123,8 @@ log prefixes to ensure that data is kept separate for each instance.
 import { kadDHT, removePublicAddressesMapper, removePrivateAddressesMapper } from '@libp2p/kad-dht'
 import { createLibp2p } from 'libp2p'
 import { peerIdFromString } from '@libp2p/peer-id'
+import { ping } from '@libp2p/ping'
+import { identify } from '@libp2p/identify'
 
 const node = await createLibp2p({
   services: {
@@ -128,7 +142,9 @@ const node = await createLibp2p({
       logPrefix: 'libp2p:dht-amino',
       datastorePrefix: '/dht-amino',
       metricsPrefix: 'libp2p_dht_amino'
-    })
+    }),
+    ping: ping(),
+    identify: identify()
   }
 })
 

packages/kad-dht/package.json

@@ -62,6 +62,7 @@
     "@libp2p/interface-internal": "^2.3.9",
     "@libp2p/peer-collections": "^6.0.25",
     "@libp2p/peer-id": "^5.1.0",
+    "@libp2p/ping": "^2.0.27",
     "@libp2p/record": "^4.0.5",
     "@libp2p/utils": "^6.6.0",
     "@multiformats/multiaddr": "^12.3.3",

packages/kad-dht/src/index.ts

@@ -11,12 +11,16 @@
  * import { kadDHT } from '@libp2p/kad-dht'
  * import { createLibp2p } from 'libp2p'
  * import { peerIdFromString } from '@libp2p/peer-id'
+ * import { ping } from '@libp2p/ping'
+ * import { identify } from '@libp2p/identify'
  *
  * const node = await createLibp2p({
  *   services: {
  *     dht: kadDHT({
  *       // DHT options
- *     })
+ *     }),
+ *     ping: ping(),
+ *     identify: identify()
  *   }
  * })
  *
@@ -36,13 +40,17 @@
  * import { kadDHT, removePrivateAddressesMapper } from '@libp2p/kad-dht'
  * import { createLibp2p } from 'libp2p'
  * import { peerIdFromString } from '@libp2p/peer-id'
+ * import { ping } from '@libp2p/ping'
+ * import { identify } from '@libp2p/identify'
  *
  * const node = await createLibp2p({
  *   services: {
  *     aminoDHT: kadDHT({
  *       protocol: '/ipfs/kad/1.0.0',
  *       peerInfoMapper: removePrivateAddressesMapper
- *     })
+ *     }),
+ *     ping: ping(),
+ *     identify: identify()
  *   }
  * })
  *
@@ -62,14 +70,18 @@
  * import { kadDHT, removePublicAddressesMapper } from '@libp2p/kad-dht'
  * import { createLibp2p } from 'libp2p'
  * import { peerIdFromString } from '@libp2p/peer-id'
+ * import { ping } from '@libp2p/ping'
+ * import { identify } from '@libp2p/identify'
  *
  * const node = await createLibp2p({
  *   services: {
  *     lanDHT: kadDHT({
  *       protocol: '/ipfs/lan/kad/1.0.0',
  *       peerInfoMapper: removePublicAddressesMapper,
  *       clientMode: false
- *     })
+ *     }),
+ *     ping: ping(),
+ *     identify: identify()
  *   }
  * })
  *
@@ -88,6 +100,8 @@
  * import { kadDHT, removePublicAddressesMapper, removePrivateAddressesMapper } from '@libp2p/kad-dht'
  * import { createLibp2p } from 'libp2p'
  * import { peerIdFromString } from '@libp2p/peer-id'
+ * import { ping } from '@libp2p/ping'
+ * import { identify } from '@libp2p/identify'
  *
  * const node = await createLibp2p({
  *   services: {
@@ -105,7 +119,9 @@
  *       logPrefix: 'libp2p:dht-amino',
  *       datastorePrefix: '/dht-amino',
  *       metricsPrefix: 'libp2p_dht_amino'
- *     })
+ *     }),
+ *     ping: ping(),
+ *     identify: identify()
  *   }
  * })
  *
@@ -121,6 +137,7 @@ import { MessageType } from './message/dht.js'
 import { removePrivateAddressesMapper, removePublicAddressesMapper, passthroughMapper } from './utils.js'
 import type { Libp2pEvents, ComponentLogger, TypedEventTarget, Metrics, PeerId, PeerInfo, PeerStore, RoutingOptions, PrivateKey } from '@libp2p/interface'
 import type { AddressManager, ConnectionManager, Registrar } from '@libp2p/interface-internal'
+import type { Ping } from '@libp2p/ping'
 import type { AdaptiveTimeoutInit } from '@libp2p/utils/src/adaptive-timeout.js'
 import type { Datastore } from 'interface-datastore'
 import type { CID } from 'multiformats/cid'
@@ -617,6 +634,7 @@ export interface KadDHTComponents {
   datastore: Datastore
   events: TypedEventTarget<Libp2pEvents>
   logger: ComponentLogger
+  ping: Ping
 }
 
 /**

packages/kad-dht/src/kad-dht.ts

@@ -366,7 +366,8 @@ export class KadDHT extends TypedEventEmitter<PeerDiscoveryEvents> implements Ka
   ]
 
   readonly [serviceDependencies]: string[] = [
-    '@libp2p/identify'
+    '@libp2p/identify',
+    '@libp2p/ping'
   ]
 
   get [contentRoutingSymbol] (): ContentRouting {

packages/kad-dht/src/routing-table/index.ts

@@ -3,14 +3,13 @@ import { AdaptiveTimeout } from '@libp2p/utils/adaptive-timeout'
 import { PeerQueue } from '@libp2p/utils/peer-queue'
 import { anySignal } from 'any-signal'
 import parallel from 'it-parallel'
-import { EventTypes } from '../index.js'
-import { MessageType } from '../message/dht.js'
 import * as utils from '../utils.js'
 import { ClosestPeers } from './closest-peers.js'
 import { KBucket, isLeafBucket } from './k-bucket.js'
 import type { Bucket, LeafBucket, Peer } from './k-bucket.js'
 import type { Network } from '../network.js'
 import type { AbortOptions, ComponentLogger, CounterGroup, Logger, Metric, Metrics, PeerId, PeerStore, Startable, Stream } from '@libp2p/interface'
+import type { Ping } from '@libp2p/ping'
 import type { AdaptiveTimeoutInit } from '@libp2p/utils/adaptive-timeout'
 
 export const KBUCKET_SIZE = 20
@@ -59,6 +58,7 @@ export interface RoutingTableComponents {
   peerStore: PeerStore
   metrics?: Metrics
   logger: ComponentLogger
+  ping: Ping
 }
 
 export interface RoutingTableEvents {
@@ -379,24 +379,14 @@ export class RoutingTable extends TypedEventEmitter<RoutingTableEvents> implemen
 
     try {
       this.log('pinging contact %p', contact.peerId)
+      await this.components.ping.ping(contact.peerId, options)
+      this.log('contact %p ping ok', contact.peerId)
 
-      for await (const event of this.network.sendRequest(contact.peerId, { type: MessageType.PING }, options)) {
-        if (event.type === EventTypes.PEER_RESPONSE) {
-          if (event.messageType === MessageType.PING) {
-            this.log('contact %p ping ok', contact.peerId)
-
-            this.safeDispatchEvent('peer:ping', {
-              detail: contact.peerId
-            })
-
-            return true
-          }
-
-          return false
-        }
-      }
+      this.safeDispatchEvent('peer:ping', {
+        detail: contact.peerId
+      })
 
-      return false
+      return true
     } catch (err: any) {
       this.log('error pinging old contact %p - %e', contact.peerId, err)
       stream?.abort(err)