@libp2p/interface/src/peer-discovery.ts

The interface implemented by a libp2p node

import type { PeerInfo } from './peer-info.js'
import type { TypedEventTarget } from 'main-event'

/**
 * Any object that implements this Symbol as a property should return a
 * PeerDiscovery instance as the property value, similar to how
 * `Symbol.Iterable` can be used to return an `Iterable` from an `Iterator`.
 *
 * @example
 *
 * ```TypeScript
 * import { peerDiscovery, PeerDiscovery } from '@libp2p/peer-discovery'
 *
 * class MyPeerDiscoverer implements PeerDiscovery {
 *   get [peerDiscovery] () {
 *     return this
 *   }
 *
 *   // ...other methods
 * }
 * ```
 */
export const peerDiscoverySymbol = Symbol.for('@libp2p/peer-discovery')

/**
 * Implementers of this interface can provide a PeerDiscovery implementation to
 * interested callers.
 */
export interface PeerDiscoveryProvider {
  [peerDiscoverySymbol]: PeerDiscovery
}

export interface PeerDiscoveryEvents {
  peer: CustomEvent<PeerInfo>
}

/**
 * A class that implements the `PeerDiscovery` interface uses an
 * implementation-specific method to discover peers. These peers are then added
 * to the peer store for use by other system components and services.
 */
export interface PeerDiscovery extends TypedEventTarget<PeerDiscoveryEvents> {}