@libp2p/interface 0.1.6-effcfaa8e → 1.0.0

package/src/index.ts

@@ -17,7 +17,6 @@
 import type { Connection, NewStreamOptions, Stream } from './connection/index.js'
 import type { ContentRouting } from './content-routing/index.js'
 import type { TypedEventTarget } from './events.js'
-import type { KeyChain } from './keychain/index.js'
 import type { Metrics } from './metrics/index.js'
 import type { PeerId } from './peer-id/index.js'
 import type { PeerInfo } from './peer-info/index.js'
@@ -394,20 +393,6 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    */
   contentRouting: ContentRouting
 
-  /**
-   * The keychain contains the keys used by the current node, and can create new
-   * keys, export them, import them, etc.
-   *
-   * @example
-   *
-   * ```js
-   * const keyInfo = await libp2p.keychain.createKey('new key')
-   * console.info(keyInfo)
-   * // { id: '...', name: 'new key' }
-   * ```
-   */
-  keychain: KeyChain
-
   /**
    * The metrics subsystem allows recording values to assess the health/performance
    * of the running node.
@@ -624,6 +609,21 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
   services: T
 }
 
+/**
+ * Metadata about the current node
+ */
+export interface NodeInfo {
+  /**
+   * The implementation name
+   */
+  name: string
+
+  /**
+   * The implementation version
+   */
+  version: string
+}
+
 /**
  * An object that contains an AbortSignal as
  * the optional `signal` property.
@@ -660,3 +660,25 @@ export interface LoggerOptions {
 export type RecursivePartial<T> = {
   [P in keyof T]?: T[P] extends Array<infer I> ? Array<RecursivePartial<I>> : T[P] extends (...args: any[]) => any ? T[P] : RecursivePartial<T[P]>
 }
+
+export * from './connection/index.js'
+export * from './connection-encrypter/index.js'
+export * from './connection-gater/index.js'
+export * from './content-routing/index.js'
+export * from './keys/index.js'
+export * from './metrics/index.js'
+export * from './peer-discovery/index.js'
+export * from './peer-id/index.js'
+export * from './peer-info/index.js'
+export * from './peer-routing/index.js'
+export * from './peer-store/index.js'
+export * from './peer-store/tags.js'
+export * from './pubsub/index.js'
+export * from './record/index.js'
+export * from './stream-handler/index.js'
+export * from './stream-muxer/index.js'
+export * from './topology/index.js'
+export * from './transport/index.js'
+export * from './errors.js'
+export * from './events.js'
+export * from './startable.js'

package/src/keys/index.ts

@@ -1,9 +1,11 @@
+import type { Uint8ArrayList } from 'uint8arraylist'
+
 export interface PublicKey {
   readonly bytes: Uint8Array
-  verify(data: Uint8Array, sig: Uint8Array): Promise<boolean>
+  verify(data: Uint8Array | Uint8ArrayList, sig: Uint8Array): boolean | Promise<boolean>
   marshal(): Uint8Array
   equals(key: PublicKey): boolean
-  hash(): Promise<Uint8Array>
+  hash(): Uint8Array | Promise<Uint8Array>
 }
 
 /**
@@ -12,10 +14,10 @@ export interface PublicKey {
 export interface PrivateKey {
   readonly public: PublicKey
   readonly bytes: Uint8Array
-  sign(data: Uint8Array): Promise<Uint8Array>
+  sign(data: Uint8Array | Uint8ArrayList): Uint8Array | Promise<Uint8Array>
   marshal(): Uint8Array
   equals(key: PrivateKey): boolean
-  hash(): Promise<Uint8Array>
+  hash(): Uint8Array | Promise<Uint8Array>
   /**
    * Gets the ID of the key.
    *

package/src/peer-discovery/index.ts

@@ -20,7 +20,7 @@ import type { PeerInfo } from '../peer-info/index.js'
  * }
  * ```
  */
-export const peerDiscovery = Symbol.for('@libp2p/peer-discovery')
+export const peerDiscoverySymbol = Symbol.for('@libp2p/peer-discovery')
 
 export interface PeerDiscoveryEvents {
   'peer': CustomEvent<PeerInfo>

package/src/peer-id/index.ts

@@ -32,8 +32,8 @@ export interface Secp256k1PeerId extends BasePeerId {
 
 export type PeerId = RSAPeerId | Ed25519PeerId | Secp256k1PeerId
 
-export const symbol = Symbol.for('@libp2p/peer-id')
+export const peerIdSymbol = Symbol.for('@libp2p/peer-id')
 
 export function isPeerId (other: any): other is PeerId {
-  return other != null && Boolean(other[symbol])
+  return other != null && Boolean(other[peerIdSymbol])
 }

package/src/peer-info/index.ts

@@ -1,8 +1,20 @@
 import type { PeerId } from '../peer-id/index.js'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
+/**
+ * A `PeerInfo` is a lightweight object that represents a remote peer, it can be
+ * obtained from peer discovery mechanisms, HTTP RPC endpoints, etc.
+ *
+ * @see https://docs.libp2p.io/concepts/fundamentals/peers/#peer-info
+ */
 export interface PeerInfo {
+  /**
+   * The identifier of the remote peer
+   */
   id: PeerId
+
+  /**
+   * The multiaddrs a peer is listening on
+   */
   multiaddrs: Multiaddr[]
-  protocols: string[]
 }

package/src/peer-routing/index.ts

@@ -21,7 +21,7 @@ import type { PeerInfo } from '../peer-info/index.js'
  * }
  * ```
  */
-export const peerRouting = Symbol.for('@libp2p/peer-routing')
+export const peerRoutingSymbol = Symbol.for('@libp2p/peer-routing')
 
 export interface PeerRouting {
   /**

package/src/startable.ts

@@ -2,8 +2,6 @@
  * Implemented by components that have a lifecycle
  */
 export interface Startable {
-  isStarted(): boolean
-
   /**
    * If implemented, this method will be invoked before the start method.
    *
@@ -51,6 +49,10 @@ export function isStartable (obj: any): obj is Startable {
   return obj != null && typeof obj.start === 'function' && typeof obj.stop === 'function'
 }
 
+/**
+ * Start one or more {@link Startable}s, calling the `beforeStart` and
+ * `afterStart` lifecycle methods if defined.
+ */
 export async function start (...objs: any[]): Promise<void> {
   const startables: Startable[] = []
 
@@ -83,6 +85,10 @@ export async function start (...objs: any[]): Promise<void> {
   )
 }
 
+/**
+ * Stop one or more {@link Startable}s, calling the `beforeStop` and
+ * `afterStop` lifecycle methods if defined.
+ */
 export async function stop (...objs: any[]): Promise<void> {
   const startables: Startable[] = []
 

package/src/stream-muxer/index.ts

@@ -1,6 +1,6 @@
 import type { Direction, Stream } from '../connection/index.js'
 import type { AbortOptions } from '../index.js'
-import type { Duplex, Source } from 'it-stream-types'
+import type { Duplex } from 'it-stream-types'
 import type { Uint8ArrayList } from 'uint8arraylist'
 
 export interface StreamMuxerFactory {
@@ -18,7 +18,7 @@ export interface StreamMuxerFactory {
 /**
  * A libp2p stream muxer
  */
-export interface StreamMuxer extends Duplex<AsyncGenerator<Uint8Array>, Source<Uint8ArrayList | Uint8Array>, Promise<void>> {
+export interface StreamMuxer extends Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>> {
   /**
    * The protocol used to select this muxer during connection opening
    */