@libp2p/interface-internal 2.3.19 → 3.0.0-049bfa0fa

package/dist/src/connection-manager.d.ts

@@ -1,4 +1,4 @@
-import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions, OpenConnectionProgressEvents } from '@libp2p/interface';
+import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions, OpenConnectionProgressEvents, Stream, NewStreamOptions } from '@libp2p/interface';
 import type { PeerMap } from '@libp2p/peer-collections';
 import type { Multiaddr } from '@multiformats/multiaddr';
 import type { ProgressOptions } from 'progress-events';
@@ -73,6 +73,21 @@ export interface ConnectionManager {
      * @returns A promise that resolves to a `Connection` object.
      */
     openConnection(peer: PeerId | Multiaddr | Multiaddr[], options?: OpenConnectionOptions): Promise<Connection>;
+    /**
+     * Open a protocol stream with a remote peer. If the peer is already connected
+     * an existing connection will be used to open the stream, otherwise they will
+     * be dialed first.
+     *
+     * This is preferable to opening a connection manually as it allows libp2p to
+     * decide what the "best" connection is, and in future, migrate streams across
+     * connections as better connections become available.
+     *
+     * @param peer - The target `PeerId`, `Multiaddr`, or an array of `Multiaddr`s.
+     * @param protocol - The protocol string or strings
+     * @param options - Optional parameters for connection handling.
+     * @returns A promise that resolves to a `Connection` object.
+     */
+    openStream(peer: PeerId | Multiaddr | Multiaddr[], protocol: string | string[], options?: OpenConnectionOptions & NewStreamOptions): Promise<Stream>;
     /**
      * Close our connections to a peer
      *
@@ -88,9 +103,9 @@ export interface ConnectionManager {
      * otherwise it will return false.
      *
      * @param maConn - The multiaddr connection to evaluate.
-     * @returns A promise that resolves to `true` if the connection can be accepted, `false` otherwise.
+     * @returns `true` if the connection can be accepted, `false` otherwise.
      */
-    acceptIncomingConnection(maConn: MultiaddrConnection): Promise<boolean>;
+    acceptIncomingConnection(maConn: MultiaddrConnection): boolean;
     /**
      * Invoked after upgrading an inbound multiaddr connection has finished
      */

package/dist/src/connection-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connection-manager.d.ts","sourceRoot":"","sources":["../../src/connection-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAC5J,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY,EAAE,eAAe,CAAC,4BAA4B,CAAC;IACxG;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAE7C;;;;OAIG;IACH,iBAAiB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE1C;;;;;OAKG;IACH,iBAAiB,IAAI,MAAM,CAAA;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/C;;;;;;OAMG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5G;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;;;;OAQG;IACH,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAEvE;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;;;OAIG;IACH,YAAY,IAAI,WAAW,EAAE,CAAA;IAE7B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC9F"}
+{"version":3,"file":"connection-manager.d.ts","sourceRoot":"","sources":["../../src/connection-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACtL,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY,EAAE,eAAe,CAAC,4BAA4B,CAAC;IACxG;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;IAEf;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CAAA;IAE7C;;;;OAIG;IACH,iBAAiB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAE1C;;;;;OAKG;IACH,iBAAiB,IAAI,MAAM,CAAA;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/C;;;;;;OAMG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE5G;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEpJ;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;;;;OAQG;IACH,wBAAwB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAA;IAE9D;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;;;OAIG;IACH,YAAY,IAAI,WAAW,EAAE,CAAA;IAE7B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;CAC9F"}

package/dist/src/registrar.d.ts

@@ -1,22 +1,4 @@
-import type { StreamHandler, StreamHandlerOptions, StreamHandlerRecord, Topology, IncomingStreamData } from '@libp2p/interface';
-import type { AbortOptions } from '@multiformats/multiaddr';
-export type { 
-/**
- * @deprecated This type should be imported from @libp2p/interface directly
- */
-IncomingStreamData, 
-/**
- * @deprecated This type should be imported from @libp2p/interface directly
- */
-StreamHandler, 
-/**
- * @deprecated This type should be imported from @libp2p/interface directly
- */
-StreamHandlerOptions, 
-/**
- * @deprecated This type should be imported from @libp2p/interface directly
- */
-StreamHandlerRecord };
+import type { StreamHandler, StreamHandlerOptions, StreamHandlerRecord, Topology, StreamMiddleware, AbortOptions } from '@libp2p/interface';
 /**
  * The `Registrar` provides an interface for registering protocol handlers -
  * these are invoked when remote peers open streams on the local node with the
@@ -59,6 +41,27 @@ export interface Registrar {
      * @returns A `StreamHandlerRecord` containing the handler and options.
      */
     getHandler(protocol: string): StreamHandlerRecord;
+    /**
+     * Retrieve any registered middleware for a given protocol.
+     *
+     * @param protocol - The protocol to fetch middleware for
+     * @returns A list of `StreamMiddleware` implementations
+     */
+    use(protocol: string, middleware: StreamMiddleware[]): void;
+    /**
+     * Retrieve any registered middleware for a given protocol.
+     *
+     * @param protocol - The protocol to fetch middleware for
+     * @returns A list of `StreamMiddleware` implementations
+     */
+    unuse(protocol: string): void;
+    /**
+     * Retrieve any registered middleware for a given protocol.
+     *
+     * @param protocol - The protocol to fetch middleware for
+     * @returns A list of `StreamMiddleware` implementations
+     */
+    getMiddleware(protocol: string): StreamMiddleware[];
     /**
      * Register a topology handler for a protocol - the topology will be
      * invoked when peers are discovered on the network that support the

package/dist/src/registrar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registrar.d.ts","sourceRoot":"","sources":["../../src/registrar.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC/H,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAE3D,YAAY;AACV;;GAEG;AACH,kBAAkB;AAElB;;GAEG;AACH,aAAa;AAEb;;GAEG;AACH,oBAAoB;AAEpB;;GAEG;AACH,mBAAmB,EACpB,CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,YAAY,IAAI,MAAM,EAAE,CAAA;IAExB;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/F;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAA;IAEjD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEvF;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;;;;;OAMG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,EAAE,CAAA;CAC5C"}
+{"version":3,"file":"registrar.d.ts","sourceRoot":"","sources":["../../src/registrar.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAE3I;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,YAAY,IAAI,MAAM,EAAE,CAAA;IAExB;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/F;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,mBAAmB,CAAA;IAEjD;;;;;OAKG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAA;IAE3D;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAAA;IAEnD;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAEvF;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;;;;;OAMG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,EAAE,CAAA;CAC5C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface-internal",
-  "version": "2.3.19",
+  "version": "3.0.0-049bfa0fa",
   "description": "Interfaces implemented by internal libp2p components",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/interface-internal#readme",
@@ -41,13 +41,13 @@
     "build": "aegir build"
   },
   "dependencies": {
-    "@libp2p/interface": "^2.11.0",
-    "@libp2p/peer-collections": "^6.0.35",
-    "@multiformats/multiaddr": "^12.4.4",
+    "@libp2p/interface": "3.0.0-049bfa0fa",
+    "@libp2p/peer-collections": "7.0.0-049bfa0fa",
+    "@multiformats/multiaddr": "^13.0.1",
     "progress-events": "^1.0.1"
   },
   "devDependencies": {
-    "aegir": "^47.0.14"
+    "aegir": "^47.0.22"
   },
   "sideEffects": false
 }

package/src/connection-manager.ts

@@ -1,4 +1,4 @@
-import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions, OpenConnectionProgressEvents } from '@libp2p/interface'
+import type { AbortOptions, PendingDial, Connection, MultiaddrConnection, PeerId, IsDialableOptions, OpenConnectionProgressEvents, Stream, NewStreamOptions } from '@libp2p/interface'
 import type { PeerMap } from '@libp2p/peer-collections'
 import type { Multiaddr } from '@multiformats/multiaddr'
 import type { ProgressOptions } from 'progress-events'
@@ -82,6 +82,22 @@ export interface ConnectionManager {
    */
   openConnection(peer: PeerId | Multiaddr | Multiaddr[], options?: OpenConnectionOptions): Promise<Connection>
 
+  /**
+   * Open a protocol stream with a remote peer. If the peer is already connected
+   * an existing connection will be used to open the stream, otherwise they will
+   * be dialed first.
+   *
+   * This is preferable to opening a connection manually as it allows libp2p to
+   * decide what the "best" connection is, and in future, migrate streams across
+   * connections as better connections become available.
+   *
+   * @param peer - The target `PeerId`, `Multiaddr`, or an array of `Multiaddr`s.
+   * @param protocol - The protocol string or strings
+   * @param options - Optional parameters for connection handling.
+   * @returns A promise that resolves to a `Connection` object.
+   */
+  openStream(peer: PeerId | Multiaddr | Multiaddr[], protocol: string | string[], options?: OpenConnectionOptions & NewStreamOptions): Promise<Stream>
+
   /**
    * Close our connections to a peer
    *
@@ -98,9 +114,9 @@ export interface ConnectionManager {
    * otherwise it will return false.
    *
    * @param maConn - The multiaddr connection to evaluate.
-   * @returns A promise that resolves to `true` if the connection can be accepted, `false` otherwise.
+   * @returns `true` if the connection can be accepted, `false` otherwise.
    */
-  acceptIncomingConnection(maConn: MultiaddrConnection): Promise<boolean>
+  acceptIncomingConnection(maConn: MultiaddrConnection): boolean
 
   /**
    * Invoked after upgrading an inbound multiaddr connection has finished

package/src/registrar.ts

@@ -1,27 +1,4 @@
-import type { StreamHandler, StreamHandlerOptions, StreamHandlerRecord, Topology, IncomingStreamData } from '@libp2p/interface'
-import type { AbortOptions } from '@multiformats/multiaddr'
-
-export type {
-  /**
-   * @deprecated This type should be imported from @libp2p/interface directly
-   */
-  IncomingStreamData,
-
-  /**
-   * @deprecated This type should be imported from @libp2p/interface directly
-   */
-  StreamHandler,
-
-  /**
-   * @deprecated This type should be imported from @libp2p/interface directly
-   */
-  StreamHandlerOptions,
-
-  /**
-   * @deprecated This type should be imported from @libp2p/interface directly
-   */
-  StreamHandlerRecord
-}
+import type { StreamHandler, StreamHandlerOptions, StreamHandlerRecord, Topology, StreamMiddleware, AbortOptions } from '@libp2p/interface'
 
 /**
  * The `Registrar` provides an interface for registering protocol handlers -
@@ -69,6 +46,30 @@ export interface Registrar {
    */
   getHandler(protocol: string): StreamHandlerRecord
 
+  /**
+   * Retrieve any registered middleware for a given protocol.
+   *
+   * @param protocol - The protocol to fetch middleware for
+   * @returns A list of `StreamMiddleware` implementations
+   */
+  use(protocol: string, middleware: StreamMiddleware[]): void
+
+  /**
+   * Retrieve any registered middleware for a given protocol.
+   *
+   * @param protocol - The protocol to fetch middleware for
+   * @returns A list of `StreamMiddleware` implementations
+   */
+  unuse(protocol: string): void
+
+  /**
+   * Retrieve any registered middleware for a given protocol.
+   *
+   * @param protocol - The protocol to fetch middleware for
+   * @returns A list of `StreamMiddleware` implementations
+   */
+  getMiddleware(protocol: string): StreamMiddleware[]
+
   /**
    * Register a topology handler for a protocol - the topology will be
    * invoked when peers are discovered on the network that support the

package/dist/typedoc-urls.json

@@ -1,12 +0,0 @@
-{
-  "AddressManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.AddressManager.html",
-  "ConfirmAddressOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.ConfirmAddressOptions.html",
-  "ConnectionManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.ConnectionManager.html",
-  "NodeAddress": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.NodeAddress.html",
-  "OpenConnectionOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.OpenConnectionOptions.html",
-  "RandomWalk": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.RandomWalk.html",
-  "Registrar": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.Registrar.html",
-  "TransportManager": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.TransportManager.html",
-  "TransportManagerDialOptions": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface-internal.TransportManagerDialOptions.html",
-  "AddressType": "https://libp2p.github.io/js-libp2p/types/_libp2p_interface-internal.AddressType.html"
-}