@libp2p/interface/dist/src/peer-routing.d.ts

The interface implemented by a libp2p node

import type { RoutingOptions } from './index.js';
import type { PeerId } from './peer-id.js';
import type { PeerInfo } from './peer-info.js';
/**
 * Any object that implements this Symbol as a property should return a
 * PeerRouting instance as the property value, similar to how `Symbol.Iterable`
 * can be used to return an `Iterable` from an `Iterator`.
 *
 * @example
 *
 * ```TypeScript
 * import { peerRouting, PeerRouting } from '@libp2p/peer-routing'
 *
 * class MyPeerRouter implements PeerRouting {
 *   get [peerRouting] () {
 *     return this
 *   }
 *
 *   // ...other methods
 * }
 * ```
 */
export declare const peerRoutingSymbol: unique symbol;
/**
 * Implementers of this interface can provide a PeerRouting implementation to
 * interested callers.
 */
export interface PeerRoutingProvider {
    [peerRoutingSymbol]: Partial<PeerRouting>;
}
export interface PeerRouting {
    /**
     * Searches the network for peer info corresponding to the passed peer id.
     *
     * @example
     *
     * ```TypeScript
     * // ...
     * const peer = await peerRouting.findPeer(peerId, options)
     * ```
     */
    findPeer(peerId: PeerId, options?: RoutingOptions): Promise<PeerInfo>;
    /**
     * Search the network for peers that are closer to the passed key. Peer
     * info should be yielded in ever-increasing closeness to the key.
     *
     * @example
     *
     * ```TypeScript
     * // Iterate over the closest peers found for the given key
     * for await (const peer of peerRouting.getClosestPeers(key)) {
     *   console.log(peer.id, peer.multiaddrs)
     * }
     * ```
     */
    getClosestPeers(key: Uint8Array, options?: RoutingOptions): AsyncIterable<PeerInfo>;
}
//# sourceMappingURL=peer-routing.d.ts.map