@libp2p/interface 2.11.0-6059227cb → 2.11.0-87bc8d4fb

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

@@ -1 +1 @@
-{"version":3,"file":"topology.d.ts","sourceRoot":"","sources":["../../src/topology.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE1C;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,GAAG,CAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,MAAM,CAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,CAAA;IAEvB;;;;;;OAMG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IAEnC;;;OAGG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElE;;;OAGG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACpD"}
+{"version":3,"file":"topology.d.ts","sourceRoot":"","sources":["../../src/topology.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE1C;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,GAAG,CAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,MAAM,CAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,CAAA;IAEvB;;;;;;OAMG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IAEnC;;;OAGG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;OAGG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACpC"}

package/dist/src/transport.d.ts

@@ -1,4 +1,6 @@
-import type { AbortOptions, ClearableSignal, ConnectionEncrypter, MultiaddrConnection, Connection, ConnectionLimits, StreamMuxerFactory, PeerId } from './index.js';
+import type { Connection, ConnectionLimits, MultiaddrConnection } from './connection.js';
+import type { AbortOptions, ClearableSignal, ConnectionEncrypter } from './index.js';
+import type { StreamMuxerFactory } from './stream-muxer.js';
 import type { Multiaddr } from '@multiformats/multiaddr';
 import type { TypedEventTarget } from 'main-event';
 import type { ProgressOptions, ProgressEvent } from 'progress-events';
@@ -112,6 +114,14 @@ export declare enum FaultTolerance {
  * 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.
      */
@@ -137,35 +147,18 @@ export interface UpgraderOptions<ConnectionUpgradeEvents extends ProgressEvent =
      */
     initiator?: boolean;
 }
-/**
- * Options accepted by the upgrader during connection establishment
- */
-export interface UpgraderWithoutEncryptionOptions extends UpgraderOptions {
-    /**
-     * 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
-     */
-    skipEncryption: true;
-    /**
-     * If `skipEncryption` is true, a remote PeerId must be supplied
-     */
-    remotePeer: PeerId;
-}
 export type InboundConnectionUpgradeEvents = ProgressEvent<'upgrader:encrypt-inbound-connection'> | ProgressEvent<'upgrader:multiplex-inbound-connection'>;
 export type OutboundConnectionUpgradeEvents = ProgressEvent<'upgrader:encrypt-outbound-connection'> | ProgressEvent<'upgrader:multiplex-outbound-connection'>;
 export interface Upgrader {
     /**
      * Upgrades an outbound connection created by the `dial` method of a transport
      */
-    upgradeOutbound(maConn: MultiaddrConnection, opts: UpgraderOptions<OutboundConnectionUpgradeEvents>): Promise<Connection>;
-    upgradeOutbound(maConn: MultiaddrConnection, opts: UpgraderWithoutEncryptionOptions): Promise<Connection>;
+    upgradeOutbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<OutboundConnectionUpgradeEvents>): Promise<Connection>;
     /**
      * Upgrades an inbound connection received by a transport listener and
      * notifies other libp2p components about the new connection
      */
-    upgradeInbound(maConn: MultiaddrConnection, opts: UpgraderOptions<InboundConnectionUpgradeEvents>): Promise<void>;
-    upgradeInbound(maConn: MultiaddrConnection, opts: UpgraderWithoutEncryptionOptions): Promise<void>;
+    upgradeInbound(maConn: MultiaddrConnection, opts?: UpgraderOptions<InboundConnectionUpgradeEvents>): Promise<void>;
     /**
      * Used by transports that perform part of the upgrade process themselves and
      * do some async work. This allows configuring inbound upgrade timeouts from a

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

@@ -1 +1 @@
-{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,UAAU,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACnK,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,SAAS,EAAE,WAAW,CAAA;IAEtB;;OAEG;IACH,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IAEzB;;;OAGG;IACH,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,MAAM,WAAW,QAAS,SAAQ,gBAAgB,CAAC,cAAc,CAAC;IAChE;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3C;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE,CAAA;IAEvB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtB;;;OAGG;IACH,mBAAmB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAA;CAC9C;AAED,eAAO,MAAM,eAAe,eAAkC,CAAA;AAE9D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,CAAA;CACvC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,QAAQ,CAAC,YAAY,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;IACjJ;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa;IACzE;;OAEG;IACH,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,CAAC,eAAe,CAAC,EAAE,IAAI,CAAA;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEnF;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAA;IAExD;;;OAGG;IACH,YAAY,EAAE,eAAe,CAAA;IAE7B;;;OAGG;IACH,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAE,KAAK,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,SAAS,CAE5D;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,SAAS,IAAI;IAEb;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,uBAAuB,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,eAAe,CAAC,uBAAuB,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC;IACtK;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAA;IAEzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,eAAe;IACvE;;;;OAIG;IACH,cAAc,EAAE,IAAI,CAAA;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,MAAM,8BAA8B,GAC1C,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,uCAAuC,CAAC,CAAA;AAEtD,MAAM,MAAM,+BAA+B,GAC3C,aAAa,CAAC,sCAAsC,CAAC,GACrD,aAAa,CAAC,wCAAwC,CAAC,CAAA;AAEvD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,eAAe,CAAC,+BAA+B,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IACzH,eAAe,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEzG;;;OAGG;IACH,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,eAAe,CAAC,8BAA8B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACjH,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElG;;;;;;;OAOG;IACH,wBAAwB,CAAE,MAAM,EAAE,WAAW,GAAG,eAAe,CAAA;IAE/D;;OAEG;IACH,eAAe,IAAK,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;IAEnD;;OAEG;IACH,uBAAuB,IAAK,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;CAC7D"}
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../src/transport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACxF,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AACpF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,SAAS,EAAE,WAAW,CAAA;IAEtB;;OAEG;IACH,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IAEzB;;;OAGG;IACH,KAAK,EAAE,WAAW,CAAA;CACnB;AAED,MAAM,WAAW,QAAS,SAAQ,gBAAgB,CAAC,cAAc,CAAC;IAChE;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3C;;OAEG;IACH,QAAQ,IAAI,SAAS,EAAE,CAAA;IACvB;;;;OAIG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACtB;;;OAGG;IACH,mBAAmB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAA;CAC9C;AAED,eAAO,MAAM,eAAe,eAAkC,CAAA;AAE9D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,EAAE,CAAA;CACvC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,QAAQ,CAAC,YAAY,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC;IACjJ;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,UAAU,SAAS,aAAa,GAAG,aAAa;IACzE;;OAEG;IACH,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,CAAC,eAAe,CAAC,EAAE,IAAI,CAAA;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEnF;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,QAAQ,CAAA;IAExD;;;OAGG;IACH,YAAY,EAAE,eAAe,CAAA;IAE7B;;;OAGG;IACH,UAAU,EAAE,eAAe,CAAA;CAC5B;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAE,KAAK,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,SAAS,CAE5D;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,SAAS,IAAI;IAEb;;OAEG;IACH,QAAQ,IAAA;CACT;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,uBAAuB,SAAS,aAAa,GAAG,aAAa,CAAE,SAAQ,eAAe,CAAC,uBAAuB,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC;IACtK;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAA;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAA;IAEzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,MAAM,8BAA8B,GAC1C,aAAa,CAAC,qCAAqC,CAAC,GACpD,aAAa,CAAC,uCAAuC,CAAC,CAAA;AAEtD,MAAM,MAAM,+BAA+B,GAC3C,aAAa,CAAC,sCAAsC,CAAC,GACrD,aAAa,CAAC,wCAAwC,CAAC,CAAA;AAEvD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,+BAA+B,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAE1H;;;OAGG;IACH,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,IAAI,CAAC,EAAE,eAAe,CAAC,8BAA8B,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElH;;;;;;;OAOG;IACH,wBAAwB,CAAE,MAAM,EAAE,WAAW,GAAG,eAAe,CAAA;IAE/D;;OAEG;IACH,eAAe,IAAK,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;IAEnD;;OAEG;IACH,uBAAuB,IAAK,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;CAC7D"}

package/dist/src/transport.js.map

@@ -1 +1 @@
-{"version":3,"file":"transport.js","sourceRoot":"","sources":["../../src/transport.ts"],"names":[],"mappings":"AAiDA,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;AA8D9D;;GAEG;AACH,MAAM,UAAU,WAAW,CAAE,KAAW;IACtC,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAA;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAUX;AAVD,WAAY,cAAc;IACxB;;OAEG;IACH,6DAAa,CAAA;IAEb;;OAEG;IACH,2DAAQ,CAAA;AACV,CAAC,EAVW,cAAc,KAAd,cAAc,QAUzB"}
+{"version":3,"file":"transport.js","sourceRoot":"","sources":["../../src/transport.ts"],"names":[],"mappings":"AAgDA,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;AA8D9D;;GAEG;AACH,MAAM,UAAU,WAAW,CAAE,KAAW;IACtC,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAA;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAUX;AAVD,WAAY,cAAc;IACxB;;OAEG;IACH,6DAAa,CAAA;IAEb;;OAEG;IACH,2DAAQ,CAAA;AACV,CAAC,EAVW,cAAc,KAAd,cAAc,QAUzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface",
-  "version": "2.11.0-6059227cb",
+  "version": "2.11.0-87bc8d4fb",
   "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",
@@ -42,14 +42,16 @@
   },
   "dependencies": {
     "@multiformats/dns": "^1.0.6",
-    "@multiformats/multiaddr": "^13.0.1",
+    "@multiformats/multiaddr": "^12.4.4",
+    "it-pushable": "^3.2.3",
+    "it-stream-types": "^2.0.2",
     "main-event": "^1.0.1",
-    "multiformats": "^13.4.0",
+    "multiformats": "^13.3.6",
     "progress-events": "^1.0.1",
     "uint8arraylist": "^2.4.8"
   },
   "devDependencies": {
-    "aegir": "^47.0.22"
+    "aegir": "^47.0.14"
   },
   "sideEffects": false
 }

package/src/connection-encrypter.ts

@@ -1,4 +1,8 @@
-import type { AbortOptions, StreamMuxerFactory, PeerId, MessageStream } from './index.js'
+import type { MultiaddrConnection } from './connection.js'
+import type { AbortOptions, Logger, StreamMuxerFactory } from './index.js'
+import type { PeerId } from './peer-id.js'
+import type { Duplex } from 'it-stream-types'
+import type { Uint8ArrayList } from 'uint8arraylist'
 
 /**
  * If the remote PeerId is known and passed as an option, the securing operation
@@ -6,9 +10,6 @@ import type { AbortOptions, StreamMuxerFactory, PeerId, MessageStream } from './
  * corresponds to the public key the remote PeerId is derived from.
  */
 export interface SecureConnectionOptions extends AbortOptions {
-  /**
-   * This will be set if the remote peer is known in advance
-   */
   remotePeer?: PeerId
 
   /**
@@ -20,6 +21,13 @@ export interface SecureConnectionOptions extends AbortOptions {
   skipStreamMuxerNegotiation?: boolean
 }
 
+/**
+ * A stream with an optional logger
+ */
+export interface SecurableStream extends Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>> {
+  log?: Logger
+}
+
 /**
  * A libp2p connection encrypter module must be compliant to this interface
  * to ensure all exchanged data between two peers is encrypted.
@@ -32,30 +40,19 @@ export interface ConnectionEncrypter<Extension = unknown> {
    * pass it for extra verification, otherwise it will be determined during
    * the handshake.
    */
-  secureOutbound (connection: MessageStream, options?: SecureConnectionOptions): Promise<SecuredConnection<Extension>>
+  secureOutbound <Stream extends SecurableStream = MultiaddrConnection> (connection: Stream, options?: SecureConnectionOptions): Promise<SecuredConnection<Stream, Extension>>
 
   /**
    * Decrypt incoming data. If the remote PeerId is known,
    * pass it for extra verification, otherwise it will be determined during
    * the handshake
    */
-  secureInbound (connection: MessageStream, options?: SecureConnectionOptions): Promise<SecuredConnection<Extension>>
+  secureInbound <Stream extends SecurableStream = MultiaddrConnection> (connection: Stream, options?: SecureConnectionOptions): Promise<SecuredConnection<Stream, Extension>>
 }
 
-export interface SecuredConnection<Extension = unknown> {
-  /**
-   * The decrypted data stream
-   */
-  connection: MessageStream
-
-  /**
-   * Any extension data transferred as part of the encryption handshake
-   */
+export interface SecuredConnection<Stream = any, Extension = unknown> {
+  conn: Stream
   remoteExtensions?: Extension
-
-  /**
-   * The identifier of the remote peer
-   */
   remotePeer: PeerId
 
   /**

package/src/connection-gater.ts

@@ -1,4 +1,5 @@
-import type { MultiaddrConnection, PeerId } from './index.js'
+import type { MultiaddrConnection } from './connection.js'
+import type { PeerId } from './peer-id.js'
 import type { Multiaddr } from '@multiformats/multiaddr'
 
 export interface ConnectionGater {

package/src/connection.ts

@@ -1,29 +1,179 @@
-import type { AbortOptions, Logger, TypedEventTarget, Stream, MessageStreamEvents, PeerId, MultiaddrConnectionTimeline, MessageStreamStatus, MessageStreamDirection } from './index.js'
+import type { AbortOptions, Logger } from './index.js'
+import type { PeerId } from './peer-id.js'
 import type { Multiaddr } from '@multiformats/multiaddr'
+import type { Duplex, Source } from 'it-stream-types'
+import type { Uint8ArrayList } from 'uint8arraylist'
 
-export type ConnectionStatus = MessageStreamStatus
+export interface ConnectionTimeline {
+  /**
+   * When the connection was opened
+   */
+  open: number
+
+  /**
+   * When the MultiaddrConnection was upgraded to a Connection - e.g. the type
+   * of connection encryption and multiplexing was negotiated.
+   */
+  upgraded?: number
+
+  /**
+   * When the connection was closed.
+   */
+  close?: number
+}
 
 /**
- * Connection limits are present on connections that are only allowed to
- * transfer a certain amount of bytes or be open for a certain number
- * of seconds.
+ * Outbound connections are opened by the local node, inbound streams are opened by the remote
+ */
+export type Direction = 'inbound' | 'outbound'
+
+export interface StreamTimeline {
+  /**
+   * A timestamp of when the stream was opened
+   */
+  open: number
+
+  /**
+   * A timestamp of when the stream was closed for both reading and writing
+   */
+  close?: number
+
+  /**
+   * A timestamp of when the stream was closed for reading
+   */
+  closeRead?: number
+
+  /**
+   * A timestamp of when the stream was closed for writing
+   */
+  closeWrite?: number
+
+  /**
+   * A timestamp of when the stream was reset
+   */
+  reset?: number
+
+  /**
+   * A timestamp of when the stream was aborted
+   */
+  abort?: number
+}
+
+/**
+ * The states a stream can be in
+ */
+export type StreamStatus = 'open' | 'closing' | 'closed' | 'aborted' | 'reset'
+
+/**
+ * The states the readable end of a stream can be in
  *
- * These limits are applied by Circuit Relay v2 servers, for example and
- * the connection will normally be closed abruptly if the limits are
- * exceeded.
+ * ready - the readable end is ready for reading
+ * closing - the readable end is closing
+ * closed - the readable end has closed
  */
-export interface ConnectionLimits {
+export type ReadStatus = 'ready' | 'closing' | 'closed'
+
+/**
+ * The states the writable end of a stream can be in
+ *
+ * ready - the writable end is ready for writing
+ * writing - the writable end is in the process of being written to
+ * done - the source passed to the `.sink` function yielded all values without error
+ * closing - the writable end is closing
+ * closed - the writable end has closed
+ */
+export type WriteStatus = 'ready' | 'writing' | 'done' | 'closing' | 'closed'
+
+/**
+ * A Stream is a data channel between two peers that
+ * can be written to and read from at both ends.
+ *
+ * It may be encrypted and multiplexed depending on the
+ * configuration of the nodes.
+ */
+export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>> {
   /**
-   * If present this is the number of bytes remaining that may be
-   * transferred over this connection
+   * Closes the stream for **reading** *and* **writing**.
+   *
+   * Any buffered data in the source can still be consumed and the stream will end normally.
+   *
+   * This will cause a `CLOSE` message to be sent to the remote, *unless* the sink has already ended.
+   *
+   * The sink and the source will return normally.
    */
-  bytes?: bigint
+  close(options?: AbortOptions): Promise<void>
 
   /**
-   * If present this is the number of seconds that this connection will
-   * remain open for
+   * Closes the stream for **reading**. If iterating over the source of this stream in a `for await of` loop, it will return (exit the loop) after any buffered data has been consumed.
+   *
+   * This function is called automatically by the muxer when it receives a `CLOSE` message from the remote.
+   *
+   * The source will return normally, the sink will continue to consume.
    */
-  seconds?: number
+  closeRead(options?: AbortOptions): Promise<void>
+
+  /**
+   * Closes the stream for **writing**. If iterating over the source of this stream in a `for await of` loop, it will return (exit the loop) after any buffered data has been consumed.
+   *
+   * The source will return normally, the sink will continue to consume.
+   */
+  closeWrite(options?: AbortOptions): Promise<void>
+
+  /**
+   * Closes the stream for **reading** *and* **writing**. This should be called when a *local error* has occurred.
+   *
+   * Note, if called without an error any buffered data in the source can still be consumed and the stream will end normally.
+   *
+   * This will cause a `RESET` message to be sent to the remote, *unless* the sink has already ended.
+   *
+   * The sink will return and the source will throw.
+   */
+  abort(err: Error): void
+
+  /**
+   * Unique identifier for a stream. Identifiers are not unique across muxers.
+   */
+  id: string
+
+  /**
+   * Outbound streams are opened by the local node, inbound streams are opened by the remote
+   */
+  direction: Direction
+
+  /**
+   * Lifecycle times for the stream
+   */
+  timeline: StreamTimeline
+
+  /**
+   * The protocol negotiated for this stream
+   */
+  protocol?: string
+
+  /**
+   * User defined stream metadata
+   */
+  metadata: Record<string, any>
+
+  /**
+   * The current status of the stream
+   */
+  status: StreamStatus
+
+  /**
+   * The current status of the readable end of the stream
+   */
+  readStatus: ReadStatus
+
+  /**
+   * The current status of the writable end of the stream
+   */
+  writeStatus: WriteStatus
+
+  /**
+   * The stream logger
+   */
+  log: Logger
 }
 
 export interface NewStreamOptions extends AbortOptions {
@@ -36,11 +186,10 @@ export interface NewStreamOptions extends AbortOptions {
 
   /**
    * Opt-in to running over a limited connection - one that has restrictions
-   * on the amount of data that may be transferred or how long it may be open
-   * for.
+   * on the amount of data that may be transferred or how long it may be open for.
    *
-   * These limits are typically enforced by a relay server, if the protocol will
-   * be transferring a lot of data or the stream will be open for a long time
+   * These limits are typically enforced by a relay server, if the protocol
+   * will be transferring a lot of data or the stream will be open for a long time
    * consider upgrading to a direct connection before opening the stream.
    *
    * @default false
@@ -75,13 +224,38 @@ export interface NewStreamOptions extends AbortOptions {
   negotiateFully?: boolean
 }
 
+export type ConnectionStatus = 'open' | 'closing' | 'closed'
+
+/**
+ * Connection limits are present on connections that are only allowed to
+ * transfer a certain amount of bytes or be open for a certain number
+ * of seconds.
+ *
+ * These limits are applied by Circuit Relay v2 servers, for example and
+ * the connection will normally be closed abruptly if the limits are
+ * exceeded.
+ */
+export interface ConnectionLimits {
+  /**
+   * If present this is the number of bytes remaining that may be
+   * transferred over this connection
+   */
+  bytes?: bigint
+
+  /**
+   * If present this is the number of seconds that this connection will
+   * remain open for
+   */
+  seconds?: number
+}
+
 /**
  * A Connection is a high-level representation of a connection
  * to a remote peer that may have been secured by encryption and
  * multiplexed, depending on the configuration of the nodes
  * between which the connection is made.
  */
-export interface Connection extends TypedEventTarget<Omit<MessageStreamEvents, 'drain' | 'message'>> {
+export interface Connection {
   /**
    * The unique identifier for this connection
    */
@@ -97,6 +271,11 @@ export interface Connection extends TypedEventTarget<Omit<MessageStreamEvents, '
    */
   remotePeer: PeerId
 
+  /**
+   * A list of tags applied to this connection
+   */
+  tags: string[]
+
   /**
    * A list of open streams on this connection
    */
@@ -105,12 +284,12 @@ export interface Connection extends TypedEventTarget<Omit<MessageStreamEvents, '
   /**
    * Outbound connections are opened by the local node, inbound streams are opened by the remote
    */
-  direction: MessageStreamDirection
+  direction: Direction
 
   /**
-   * When stream life cycle events occurred
+   * Lifecycle times for the connection
    */
-  timeline: MultiaddrConnectionTimeline
+  timeline: ConnectionTimeline
 
   /**
    * The multiplexer negotiated for this connection
@@ -127,11 +306,6 @@ export interface Connection extends TypedEventTarget<Omit<MessageStreamEvents, '
    */
   status: ConnectionStatus
 
-  /**
-   * Whether this connection is direct or, for example, is via a relay
-   */
-  direct: boolean
-
   /**
    * If present, this connection has limits applied to it, perhaps by an
    * intermediate relay. Once the limits have been reached the connection will
@@ -146,28 +320,26 @@ export interface Connection extends TypedEventTarget<Omit<MessageStreamEvents, '
    */
   rtt?: number
 
-  /**
-   * The connection logger, used to log connection-specific information
-   */
-  log: Logger
-
   /**
    * Create a new stream on this connection and negotiate one of the passed protocols
    */
   newStream(protocols: string | string[], options?: NewStreamOptions): Promise<Stream>
 
   /**
-   * Gracefully close the connection. The returned promise will resolve when all
-   * queued data has been written to the underlying transport. Any unread data
-   * will still be emitted as a 'message' event.
+   * Gracefully close the connection. All queued data will be written to the
+   * underlying transport.
    */
   close(options?: AbortOptions): Promise<void>
 
   /**
-   * Immediately close the connection. Any data queued to be sent or read will
-   * be discarded.
+   * Immediately close the connection, any queued data will be discarded
    */
   abort(err: Error): void
+
+  /**
+   * The connection logger
+   */
+  log: Logger
 }
 
 export const connectionSymbol = Symbol.for('@libp2p/connection')
@@ -175,3 +347,63 @@ export const connectionSymbol = Symbol.for('@libp2p/connection')
 export function isConnection (other: any): other is Connection {
   return other != null && Boolean(other[connectionSymbol])
 }
+
+export interface ConnectionProtector {
+  /**
+   * Takes a given Connection and creates a private encryption stream
+   * between its two peers from the PSK the Protector instance was
+   * created with.
+   */
+  protect(connection: MultiaddrConnection, options?: AbortOptions): Promise<MultiaddrConnection>
+}
+
+export interface MultiaddrConnectionTimeline {
+  /**
+   * When the connection was opened
+   */
+  open: number
+
+  /**
+   * When the MultiaddrConnection was upgraded to a Connection - the type of
+   * connection encryption and multiplexing was negotiated.
+   */
+  upgraded?: number
+
+  /**
+   * When the connection was closed.
+   */
+  close?: number
+}
+
+/**
+ * A MultiaddrConnection is returned by transports after dialing
+ * a peer. It is a low-level primitive and is the raw connection
+ * without encryption or stream multiplexing.
+ */
+export interface MultiaddrConnection extends Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>> {
+  /**
+   * Gracefully close the connection. All queued data will be written to the
+   * underlying transport.
+   */
+  close(options?: AbortOptions): Promise<void>
+
+  /**
+   * Immediately close the connection, any queued data will be discarded
+   */
+  abort(err: Error): void
+
+  /**
+   * The address of the remote end of the connection
+   */
+  remoteAddr: Multiaddr
+
+  /**
+   * When connection life cycle events occurred
+   */
+  timeline: MultiaddrConnectionTimeline
+
+  /**
+   * The multiaddr connection logger
+   */
+  log: Logger
+}

package/src/errors.ts

@@ -144,18 +144,6 @@ export class StreamResetError extends Error {
   }
 }
 
-/**
- * Thrown when a protocol stream is aborted locally
- */
-export class StreamAbortedError extends Error {
-  static name = 'StreamAbortedError'
-
-  constructor (message = 'The stream has been aborted') {
-    super(message)
-    this.name = 'StreamAbortedError'
-  }
-}
-
 /**
  * Thrown when a stream is in an invalid state
  */
@@ -168,18 +156,6 @@ export class StreamStateError extends Error {
   }
 }
 
-/**
- * Thrown when a stream buffer is full
- */
-export class StreamBufferError extends Error {
-  static name = 'StreamBufferError'
-
-  constructor (message = 'The stream buffer was full') {
-    super(message)
-    this.name = 'StreamBufferError'
-  }
-}
-
 /**
  * Thrown when a value could not be found
  */