@libp2p/interface 2.9.0 → 2.10.0

package/src/index.ts

@@ -53,6 +53,9 @@ export interface SignedPeerRecord {
   seq: bigint
 }
 
+/**
+ * A certificate that can be used to secure connections
+ */
 export interface TLSCertificate {
   /**
    * The private key that corresponds to the certificate in PEM format
@@ -130,9 +133,43 @@ export interface Logger {
 }
 
 /**
- * Peer logger component for libp2p
+ * Peer logger component for libp2p. This can be used to create loggers that are
+ * scoped to individual system components or services.
+ *
+ * To see logs, run your app with `DEBUG` set as an env var or for browsers, in
+ * `localStorage`:
+ *
+ * ```console
+ * $ DEBUG=libp2p* node index.js
+ *  libp2p:my-service hello +0ms
+ * ```
  */
 export interface ComponentLogger {
+  /**
+   * Returns a logger for the specified component.
+   *
+   * @example
+   *
+   * ```TypeScript
+   * import { ComponentLogger, Logger } from '@libp2p/interface'
+   *
+   * interface MyServiceComponents {
+   *   logger: ComponentLogger
+   * }
+   *
+   * class MyService {
+   *   private readonly log: Logger
+   *
+   *   constructor (components) {
+   *     this.log = components.logger.forComponent('libp2p:my-service')
+   *
+   *     this.log('hello')
+   *     // logs:
+   *     // libp2p:my-service hello +0ms
+   *   }
+   * }
+   * ```
+   */
   forComponent(name: string): Logger
 }
 

package/src/metrics.ts

@@ -510,7 +510,7 @@ export interface Metrics {
 /**
  * Infer the yielded type of an (async)iterable
  */
-type YieldType<T extends AsyncIterator<any> | Iterator<any>> = T extends AsyncIterator<infer Y> ? Y : T extends Iterator<infer Y, any, any> ? Y : never
+export type YieldType<T extends AsyncIterator<any> | Iterator<any>> = T extends AsyncIterator<infer Y> ? Y : T extends Iterator<infer Y, any, any> ? Y : never
 
 export type TraceAttributes = Record<string, number | string | boolean | number[] | string[] | boolean[]>
 

package/src/peer-discovery.ts

@@ -34,4 +34,9 @@ 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> {}

package/src/peer-routing.ts

@@ -4,8 +4,8 @@ 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`.
+ * PeerRouting instance as the property value, similar to how `Symbol.Iterable`
+ * can be used to return an `Iterable` from an `Iterator`.
  *
  * @example
  *
@@ -28,7 +28,7 @@ export const peerRoutingSymbol = Symbol.for('@libp2p/peer-routing')
  * interested callers.
  */
 export interface PeerRoutingProvider {
-  [peerRoutingSymbol]: PeerRouting
+  [peerRoutingSymbol]: Partial<PeerRouting>
 }
 
 export interface PeerRouting {

package/src/peer-store.ts

@@ -1,5 +1,6 @@
 import type { PublicKey } from './keys.js'
 import type { PeerId } from './peer-id.js'
+import type { PeerInfo } from './peer-info.js'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
 /**
@@ -229,6 +230,32 @@ export interface PeerStore {
    */
   get(peerId: PeerId): Promise<Peer>
 
+  /**
+   * Returns a PeerInfo object for the passed peer id. This is similar to `get`
+   * except the returned value contains fewer fields and is often used to
+   * exchange peer information with other systems.
+   *
+   * The returned object can be passed to `JSON.stringify` without any
+   * additional processing.
+   *
+   * @see https://docs.libp2p.io/concepts/fundamentals/peers/#peer-info
+   *
+   * @example
+   *
+   * ```TypeScript
+   * const peerInfo = await peerStore.getInfo(peerId)
+   *
+   * console.info(JSON.stringify(peerInfo))
+   * // {
+   * //    id: 'peerId'
+   * //    multiaddrs: [
+   * //      '...'
+   * //    ]
+   * // }
+   * ```
+   */
+  getInfo (peerId: PeerId): Promise<PeerInfo>
+
   /**
    * Adds a peer to the peer store, overwriting any existing data
    *

package/src/pubsub.ts

@@ -153,6 +153,9 @@ export interface TopicValidatorFn {
   (peer: PeerId, message: Message): TopicValidatorResult | Promise<TopicValidatorResult>
 }
 
+/**
+ * @deprecated This will be removed from `@libp2p/interface` in a future release, pubsub implementations should declare their own types
+ */
 export interface PubSub<Events extends Record<string, any> = PubSubEvents> extends TypedEventTarget<Events> {
   /**
    * The global signature policy controls whether or not we sill send and receive

package/src/record.ts

@@ -23,13 +23,42 @@ export interface Record {
   equals(other: Record): boolean
 }
 
+/**
+ * A message with a signed payload.
+ */
 export interface Envelope {
+  /**
+   * The public key of the keypair used to sign the payload
+   */
   publicKey: PublicKey
+
+  /**
+   * How the payload should be interpreted
+   */
   payloadType: Uint8Array | Uint8ArrayList
+
+  /**
+   * The contents of the envelope
+   */
   payload: Uint8Array
+
+  /**
+   * A signature that can be used to verify the payload is intact
+   */
   signature: Uint8Array | Uint8ArrayList
 
+  /**
+   * Serialize the envelope to a binary format
+   */
   marshal(): Uint8Array
+
+  /**
+   * Use the public key to validate that the payload is intact
+   */
   validate(domain: string): Promise<boolean>
-  equals(other: Envelope): boolean
+
+  /**
+   * Returns true if this envelope has equivalency with the passed object
+   */
+  equals(other?: Envelope): boolean
 }

package/src/startable.ts

@@ -45,10 +45,37 @@ export interface Startable {
   afterStop?(): void | Promise<void>
 }
 
-export function isStartable (obj: any): obj is Startable {
+/**
+ * Returns `true` if the object has type overlap with `Startable`
+ */
+export function isStartable (obj?: any): obj is Startable {
   return obj != null && typeof obj.start === 'function' && typeof obj.stop === 'function'
 }
 
+/**
+ * A function that can be used to start and objects passed to it. This checks
+ * that an object is startable before invoking its lifecycle methods so it is
+ * safe to pass non-`Startable`s in.
+ *
+ * @example
+ *
+ * ```TypeScript
+ * import { start } from '@libp2p/interface'
+ * import type { Startable } from '@libp2p/interface'
+ *
+ * const startable: Startable = {
+ *   start: () => {},
+ *   stop: () => {}
+ * }
+ *
+ * const notStartable = 5
+ *
+ * await start(
+ *   startable,
+ *   notStartable
+ * )
+ * ```
+ */
 export async function start (...objs: any[]): Promise<void> {
   const startables: Startable[] = []
 
@@ -81,6 +108,30 @@ export async function start (...objs: any[]): Promise<void> {
   )
 }
 
+/**
+ * A function that can be used to stop and objects passed to it. This checks
+ * that an object is startable before invoking its lifecycle methods so it is
+ * safe to pass non-`Startable`s in.
+ *
+ * @example
+ *
+ * ```TypeScript
+ * import { stop } from '@libp2p/interface'
+ * import type { Startable } from '@libp2p/interface'
+ *
+ * const startable: Startable = {
+ *   start: () => {},
+ *   stop: () => {}
+ * }
+ *
+ * const notStartable = 5
+ *
+ * await stop(
+ *   startable,
+ *   notStartable
+ * )
+ * ```
+ */
 export async function stop (...objs: any[]): Promise<void> {
   const startables: Startable[] = []
 

package/src/topology.ts

@@ -2,7 +2,8 @@ import type { Connection } from './connection.js'
 import type { PeerId } from './peer-id.js'
 
 /**
- * A topology filter
+ * A topology filter - this can be used by topologies to ensure they do not
+ * receive duplicate notifications of individual peers
  *
  * @see https://libp2p.github.io/js-libp2p/functions/_libp2p_peer_collections.peerFilter-1.html
  */

package/src/transport.ts

@@ -48,7 +48,12 @@ export interface Listener extends TypedEventTarget<ListenerEvents> {
 
 export const transportSymbol = Symbol.for('@libp2p/transport')
 
-export interface MultiaddrFilter { (multiaddrs: Multiaddr[]): Multiaddr[] }
+/**
+ * A filter that acts on a list of multiaddrs
+ */
+export interface MultiaddrFilter {
+  (multiaddrs: Multiaddr[]): Multiaddr[]
+}
 
 export interface CreateListenerOptions {
   /**
@@ -103,7 +108,10 @@ export interface Transport<DialEvents extends ProgressEvent = ProgressEvent> {
   dialFilter: MultiaddrFilter
 }
 
-export function isTransport (other: any): other is Transport {
+/**
+ * Used to disambiguate transport implementations
+ */
+export function isTransport (other?: any): other is Transport {
   return other != null && Boolean(other[transportSymbol])
 }
 
@@ -122,11 +130,45 @@ export enum FaultTolerance {
   NO_FATAL
 }
 
+/**
+ * Options accepted by the upgrader during connection establishment
+ */
 export interface UpgraderOptions<ConnectionUpgradeEvents extends ProgressEvent = ProgressEvent> extends ProgressOptions<ConnectionUpgradeEvents>, Required<AbortOptions> {
+  /**
+   * If true the invoking transport is expected to implement it's own encryption
+   * and an encryption protocol will not attempted to be negotiated via
+   * multi-stream select
+   *
+   * @default false
+   */
   skipEncryption?: boolean
+
+  /**
+   * If true no connection protection will be performed on the connection.
+   */
   skipProtection?: boolean
+
+  /**
+   * By default a stream muxer protocol will be negotiated via multi-stream
+   * select after an encryption protocol has been agreed on.
+   *
+   * If a transport provides it's own stream muxing facility pass a muxer
+   * factory instance here to skip muxer negotiation.
+   */
   muxerFactory?: StreamMuxerFactory
+
+  /**
+   * If the connection is to have limits applied to it, pass them here
+   */
   limits?: ConnectionLimits
+
+  /**
+   * Multi-stream select is a initiator/responder protocol. By default a
+   * connection returned from `upgrader.upgradeOutbound` will be the initiator
+   * and one returned from `upgrader.upgradeInbound` will be the responder.
+   *
+   * Pass a value here to override the default.
+   */
   initiator?: boolean
 }