@libp2p/interface 1.1.3 → 1.1.4-1fc929c1c

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface",
-  "version": "1.1.3",
+  "version": "1.1.4-1fc929c1c",
   "description": "The interface implemented by a libp2p node",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/interface#readme",
@@ -43,19 +43,20 @@
   "scripts": {
     "clean": "aegir clean",
     "lint": "aegir lint",
-    "dep-check": "aegir dep-check -i @libp2p/utils",
+    "dep-check": "aegir dep-check",
+    "doc-check": "aegir doc-check",
     "build": "aegir build"
   },
   "dependencies": {
     "@multiformats/multiaddr": "^12.1.14",
     "it-pushable": "^3.2.3",
     "it-stream-types": "^2.0.1",
-    "multiformats": "^13.0.1",
+    "multiformats": "^13.1.0",
     "progress-events": "^1.0.0",
     "uint8arraylist": "^2.4.8"
   },
   "devDependencies": {
-    "aegir": "^42.2.3"
+    "aegir": "^42.2.4"
   },
   "browser": {
     "events": "./dist/src/events.browser.js"

package/src/content-routing/index.ts

@@ -9,7 +9,7 @@ import type { CID } from 'multiformats/cid'
  *
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { contentRoutingSymbol, ContentRouting } from '@libp2p/content-routing'
  *
  * class MyContentRouter implements ContentRouting {
@@ -38,7 +38,7 @@ export interface ContentRouting {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * // ...
    * await contentRouting.provide(cid)
    * ```
@@ -50,7 +50,7 @@ export interface ContentRouting {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * // Iterate over the providers found for the given cid
    * for await (const provider of contentRouting.findProviders(cid)) {
    *  console.log(provider.id, provider.multiaddrs)
@@ -65,7 +65,7 @@ export interface ContentRouting {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * // ...
    * const key = '/key'
    * const value = uint8ArrayFromString('oh hello there')
@@ -80,7 +80,7 @@ export interface ContentRouting {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * // ...
    *
    * const key = '/key'

package/src/errors.ts

@@ -9,6 +9,7 @@ export class AbortError extends Error {
 
   constructor (message: string = 'The operation was aborted') {
     super(message)
+    this.name = 'AbortError'
     this.code = AbortError.code
     this.type = AbortError.type
   }
@@ -54,6 +55,7 @@ export class UnexpectedPeerError extends Error {
 
   constructor (message = 'Unexpected Peer') {
     super(message)
+    this.name = 'UnexpectedPeerError'
     this.code = UnexpectedPeerError.code
   }
 
@@ -65,6 +67,7 @@ export class InvalidCryptoExchangeError extends Error {
 
   constructor (message = 'Invalid crypto exchange') {
     super(message)
+    this.name = 'InvalidCryptoExchangeError'
     this.code = InvalidCryptoExchangeError.code
   }
 
@@ -76,6 +79,7 @@ export class InvalidCryptoTransmissionError extends Error {
 
   constructor (message = 'Invalid crypto transmission') {
     super(message)
+    this.name = 'InvalidCryptoTransmissionError'
     this.code = InvalidCryptoTransmissionError.code
   }
 

package/src/event-target.ts

@@ -1,3 +1,5 @@
+import { setMaxListeners } from './events.js'
+
 export interface EventCallback<EventType> { (evt: EventType): void }
 export interface EventObject<EventType> { handleEvent: EventCallback<EventType> }
 export type EventHandler<EventType> = EventCallback<EventType> | EventObject<EventType>
@@ -34,6 +36,14 @@ export interface TypedEventTarget <EventMap extends Record<string, any>> extends
 export class TypedEventEmitter<EventMap extends Record<string, any>> extends EventTarget implements TypedEventTarget<EventMap> {
   #listeners = new Map<any, Listener[]>()
 
+  constructor () {
+    super()
+
+    // silence MaxListenersExceededWarning warning on Node.js, this is a red
+    // herring almost all of the time
+    setMaxListeners(Infinity, this)
+  }
+
   listenerCount (type: string): number {
     const listeners = this.#listeners.get(type)
 

package/src/index.ts

@@ -136,7 +136,7 @@ export interface Libp2pEvents<T extends ServiceMap = ServiceMap> {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * libp2p.addEventListener('peer:discovery', (event) => {
    *    const peerInfo = event.detail
    *    // ...
@@ -150,7 +150,7 @@ export interface Libp2pEvents<T extends ServiceMap = ServiceMap> {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * libp2p.addEventListener('peer:connect', (event) => {
    *   const peerId = event.detail
    *   // ...
@@ -166,7 +166,7 @@ export interface Libp2pEvents<T extends ServiceMap = ServiceMap> {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * libp2p.addEventListener('peer:disconnect', (event) => {
    *   const peerId = event.detail
    *   // ...
@@ -182,7 +182,7 @@ export interface Libp2pEvents<T extends ServiceMap = ServiceMap> {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * libp2p.addEventListener('peer:identify', (event) => {
    *   const identifyResult = event.detail
    *   // ...
@@ -210,7 +210,7 @@ export interface Libp2pEvents<T extends ServiceMap = ServiceMap> {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * libp2p.addEventListener('self:peer:update', (event) => {
    *   const { peer } = event.detail
    *   // ...
@@ -251,7 +251,7 @@ export interface Libp2pEvents<T extends ServiceMap = ServiceMap> {
   /**
    * This event notifies listeners that the node has started
    *
-   * ```js
+   * ```TypeScript
    * libp2p.addEventListener('start', (event) => {
    *   console.info(libp2p.isStarted()) // true
    * })
@@ -262,7 +262,7 @@ export interface Libp2pEvents<T extends ServiceMap = ServiceMap> {
   /**
    * This event notifies listeners that the node has stopped
    *
-   * ```js
+   * ```TypeScript
    * libp2p.addEventListener('stop', (event) => {
    *   console.info(libp2p.isStarted()) // false
    * })
@@ -277,7 +277,7 @@ export interface Libp2pEvents<T extends ServiceMap = ServiceMap> {
  *
  * @example
  *
- * ```js
+ * ```TypeScript
  * const node = await createLibp2p({
  *   // ...other options
  *   services: {
@@ -336,7 +336,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * console.info(libp2p.peerId)
    * // PeerId(12D3Foo...)
    * ````
@@ -349,7 +349,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const peer = await libp2p.peerStore.get(peerId)
    * console.info(peer)
    * // { id: PeerId(12D3Foo...), addresses: [] ... }
@@ -363,7 +363,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const peerInfo = await libp2p.peerRouting.findPeer(peerId)
    * console.info(peerInfo)
    * // { id: PeerId(12D3Foo...), multiaddrs: [] ... }
@@ -371,7 +371,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * for await (const peerInfo of libp2p.peerRouting.getClosestPeers(key)) {
    *   console.info(peerInfo)
    *   // { id: PeerId(12D3Foo...), multiaddrs: [] ... }
@@ -387,7 +387,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * for await (const peerInfo of libp2p.contentRouting.findProviders(cid)) {
    *   console.info(peerInfo)
    *   // { id: PeerId(12D3Foo...), multiaddrs: [] ... }
@@ -402,7 +402,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const metric = libp2p.metrics.registerMetric({
    *   'my-metric'
    * })
@@ -433,7 +433,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const listenMa = libp2p.getMultiaddrs()
    * // [ <Multiaddr 047f00000106f9ba - /ip4/127.0.0.1/tcp/63930> ]
    * ```
@@ -445,7 +445,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const protocols = libp2p.getProtocols()
    * // [ '/ipfs/ping/1.0.0', '/ipfs/id/1.0.0' ]
    * ```
@@ -458,7 +458,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * for (const connection of libp2p.getConnections()) {
    *   console.log(peerId, connection.remoteAddr.toString())
    *   // Logs the PeerId string and the observed remote multiaddr of each Connection
@@ -472,7 +472,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * for (const pendingDial of libp2p.getDialQueue()) {
    *   console.log(pendingDial)
    * }
@@ -493,7 +493,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const conn = await libp2p.dial(remotePeerId)
    *
    * // create a new stream within the connection
@@ -514,7 +514,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * import { pipe } from 'it-pipe'
    *
    * const { stream, protocol } = await libp2p.dialProtocol(remotePeerId, protocols)
@@ -534,7 +534,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * await libp2p.hangUp(remotePeerId)
    * ```
    */
@@ -549,7 +549,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const handler = ({ connection, stream, protocol }) => {
    *   // use stream or connection according to the needs
    * }
@@ -568,7 +568,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * libp2p.unhandle(['/echo/1.0.0'])
    * ```
    */
@@ -580,7 +580,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const id = await libp2p.register('/echo/1.0.0', {
    *   onConnect: (peer, connection) => {
    *     // handle connect
@@ -599,7 +599,7 @@ export interface Libp2p<T extends ServiceMap = ServiceMap> extends Startable, Ty
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const id = await libp2p.register(...)
    *
    * libp2p.unregister(id)
@@ -641,7 +641,7 @@ export interface NodeInfo {
  *
  * @example
  *
- * ```js
+ * ```TypeScript
  * const controller = new AbortController()
  *
  * aLongRunningOperation({

package/src/peer-discovery/index.ts

@@ -8,7 +8,7 @@ import type { PeerInfo } from '../peer-info/index.js'
  *
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { peerDiscovery, PeerDiscovery } from '@libp2p/peer-discovery'
  *
  * class MyPeerDiscoverer implements PeerDiscovery {

package/src/peer-routing/index.ts

@@ -9,7 +9,7 @@ import type { PeerInfo } from '../peer-info/index.js'
  *
  * @example
  *
- * ```js
+ * ```TypeScript
  * import { peerRouting, PeerRouting } from '@libp2p/peer-routing'
  *
  * class MyPeerRouter implements PeerRouting {
@@ -37,7 +37,7 @@ export interface PeerRouting {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * // ...
    * const peer = await peerRouting.findPeer(peerId, options)
    * ```
@@ -50,7 +50,7 @@ export interface PeerRouting {
    *
    * @example
    *
-   * ```js
+   * ```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)

package/src/peer-store/index.ts

@@ -150,7 +150,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * await peerStore.forEach(peer => {
    *   // ...
    * })
@@ -163,7 +163,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * for (const peer of await peerStore.all()) {
    *   // ...
    * }
@@ -176,7 +176,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * await peerStore.addressBook.set(peerId, multiaddrs)
    * await peerStore.addressBook.get(peerId)
    * // multiaddrs[]
@@ -194,7 +194,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * await peerStore.has(peerId)
    * // false
    * await peerStore.addressBook.add(peerId, multiaddrs)
@@ -209,7 +209,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const peer = await peerStore.get(peerId)
    * // { .. }
    * ```
@@ -221,7 +221,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * await peerStore.save(peerId, {
    *   multiaddrs
    * })
@@ -234,7 +234,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * await peerStore.patch(peerId, {
    *   multiaddrs
    * })
@@ -247,7 +247,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * await peerStore.merge(peerId, {
    *   multiaddrs
    * })
@@ -264,7 +264,7 @@ export interface PeerStore {
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * await peerStore.consumePeerRecord(buf, expectedPeer)
    * ```
    */

package/src/pubsub/index.ts

@@ -174,7 +174,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const topic = 'topic'
    * const validateMessage = (msgTopic, msg) => {
    *   const input = uint8ArrayToString(msg.data)
@@ -194,7 +194,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
   /**
    * Gets a list of topics the node is subscribed to.
    *
-   * ```js
+   * ```TypeScript
    * const topics = libp2p.pubsub.getTopics()
    * ```
    */
@@ -205,7 +205,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const topic = 'topic'
    * const handler = (msg) => {
    *   if (msg.topic === topic) {
@@ -224,7 +224,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const topic = 'topic'
    * const handler = (msg) => {
    *   // msg.data - pubsub data received
@@ -241,7 +241,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const peerIds = libp2p.pubsub.getSubscribers(topic)
    * ```
    */
@@ -252,7 +252,7 @@ export interface PubSub<Events extends Record<string, any> = PubSubEvents> exten
    *
    * @example
    *
-   * ```js
+   * ```TypeScript
    * const topic = 'topic'
    * const data = uint8ArrayFromString('data')
    *