@libp2p/interface 0.0.1-8b0e6bef → 0.0.1-e9cafd3d

package/dist/src/connection/index.d.ts

@@ -10,31 +10,9 @@ export interface ConnectionTimeline {
     close?: number;
 }
 /**
- * Outbound conections are opened by the local node, inbound streams are opened by the remote
+ * Outbound connections are opened by the local node, inbound streams are opened by the remote
  */
 export type Direction = 'inbound' | 'outbound';
-export interface ConnectionStat {
-    /**
-     * Outbound conections are opened by the local node, inbound streams are opened by the remote
-     */
-    direction: Direction;
-    /**
-     * Lifecycle times for the connection
-     */
-    timeline: ConnectionTimeline;
-    /**
-     * Once a multiplexer has been negotiated for this stream, it will be set on the stat object
-     */
-    multiplexer?: string;
-    /**
-     * Once a connection encrypter has been negotiated for this stream, it will be set on the stat object
-     */
-    encryption?: string;
-    /**
-     * The current status of the connection
-     */
-    status: keyof typeof Status;
-}
 export interface StreamTimeline {
     /**
      * A timestamp of when the stream was opened
@@ -57,20 +35,6 @@ export interface StreamTimeline {
      */
     reset?: number;
 }
-export interface StreamStat {
-    /**
-     * Outbound streams are opened by the local node, inbound streams are opened by the remote
-     */
-    direction: Direction;
-    /**
-     * Lifecycle times for the stream
-     */
-    timeline: StreamTimeline;
-    /**
-     * Once a protocol has been negotiated for this stream, it will be set on the stat object
-     */
-    protocol?: string;
-}
 /**
  * A Stream is a data channel between two peers that
  * can be written to and read from at both ends.
@@ -126,9 +90,17 @@ export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Ui
      */
     id: string;
     /**
-     * Stats about this stream
+     * Outbound streams are opened by the local node, inbound streams are opened by the remote
+     */
+    direction: Direction;
+    /**
+     * Lifecycle times for the stream
+     */
+    timeline: StreamTimeline;
+    /**
+     * Once a protocol has been negotiated for this stream, it will be set on the stat object
      */
-    stat: StreamStat;
+    protocol?: string;
     /**
      * User defined stream metadata
      */
@@ -149,12 +121,46 @@ export interface NewStreamOptions extends AbortOptions {
  * between which the connection is made.
  */
 export interface Connection {
+    /**
+     * The unique identifier for this connection
+     */
     id: string;
-    stat: ConnectionStat;
+    /**
+     * The address of the remote end of the connection
+     */
     remoteAddr: Multiaddr;
+    /**
+     * The id of the peer at the remote end of the connection
+     */
     remotePeer: PeerId;
+    /**
+     * A list of tags applied to this connection
+     */
     tags: string[];
+    /**
+     * A list of open streams on this connection
+     */
     streams: Stream[];
+    /**
+     * Outbound conections are opened by the local node, inbound streams are opened by the remote
+     */
+    direction: Direction;
+    /**
+     * Lifecycle times for the connection
+     */
+    timeline: ConnectionTimeline;
+    /**
+     * Once a multiplexer has been negotiated for this stream, it will be set on the stat object
+     */
+    multiplexer?: string;
+    /**
+     * Once a connection encrypter has been negotiated for this stream, it will be set on the stat object
+     */
+    encryption?: string;
+    /**
+     * The current status of the connection
+     */
+    status: keyof typeof Status;
     newStream: (multicodecs: string | string[], options?: NewStreamOptions) => Promise<Stream>;
     addStream: (stream: Stream) => void;
     removeStream: (id: string) => void;

package/dist/src/connection/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,UAAU,CAAA;AAE9C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,OAAO,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACxH;;;;;;;;OAQG;IACH,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,IAAI,CAAA;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,IAAI,CAAA;IAEtB;;;;;;;;OAQG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAA;IAE3B;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,UAAU,EAAE,SAAS,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,OAAO,EAAE,MAAM,EAAE,CAAA;IAEjB,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IAC1F,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACnC,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B;AAED,eAAO,MAAM,MAAM,eAAmC,CAAA;AAEtD,wBAAgB,YAAY,CAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAE7D;AAED,MAAM,WAAW,mBAAmB;IAElC;;;;OAIG;IACH,OAAO,EAAE,CAAC,UAAU,EAAE,mBAAmB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAC3E;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAChH,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,UAAU,EAAE,SAAS,CAAA;IACrB,QAAQ,EAAE,2BAA2B,CAAA;CACtC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/connection/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,UAAU,CAAA;AAE9C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACxH;;;;;;;;OAQG;IACH,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,IAAI,CAAA;IAErB;;;;OAIG;IACH,UAAU,EAAE,MAAM,IAAI,CAAA;IAEtB;;;;;;;;OAQG;IACH,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAA;IAE3B;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,SAAS,CAAA;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAA;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAA;IAEjB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,OAAO,MAAM,CAAA;IAE3B,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,gBAAgB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;IAC1F,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACnC,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B;AAED,eAAO,MAAM,MAAM,eAAmC,CAAA;AAEtD,wBAAgB,YAAY,CAAE,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAE7D;AAED,MAAM,WAAW,mBAAmB;IAElC;;;;OAIG;IACH,OAAO,EAAE,CAAC,UAAU,EAAE,mBAAmB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAC3E;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAChH,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrC,UAAU,EAAE,SAAS,CAAA;IACrB,QAAQ,EAAE,2BAA2B,CAAA;CACtC"}

package/dist/src/connection/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/connection/index.ts"],"names":[],"mappings":"AA6LA,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;AAEtD,MAAM,UAAU,YAAY,CAAE,KAAU;IACtC,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;AAChD,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/connection/index.ts"],"names":[],"mappings":"AAsMA,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;AAEtD,MAAM,UAAU,YAAY,CAAE,KAAU;IACtC,OAAO,KAAK,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;AAChD,CAAC"}

package/dist/src/pubsub/index.d.ts

@@ -0,0 +1,236 @@
+import type { Stream } from '../connection/index.js';
+import type { EventEmitter } from '../events.js';
+import type { PeerId } from '../peer-id/index.js';
+import type { Pushable } from 'it-pushable';
+import type { Uint8ArrayList } from 'uint8arraylist';
+/**
+ * On the producing side:
+ * * Build messages with the signature, key (from may be enough for certain inlineable public key types), from and seqno fields.
+ *
+ * On the consuming side:
+ * * Enforce the fields to be present, reject otherwise.
+ * * Propagate only if the fields are valid and signature can be verified, reject otherwise.
+ */
+export declare const StrictSign = "StrictSign";
+/**
+ * On the producing side:
+ * * Build messages without the signature, key, from and seqno fields.
+ * * The corresponding protobuf key-value pairs are absent from the marshalled message, not just empty.
+ *
+ * On the consuming side:
+ * * Enforce the fields to be absent, reject otherwise.
+ * * Propagate only if the fields are absent, reject otherwise.
+ * * A message_id function will not be able to use the above fields, and should instead rely on the data field. A commonplace strategy is to calculate a hash.
+ */
+export declare const StrictNoSign = "StrictNoSign";
+export type SignaturePolicy = typeof StrictSign | typeof StrictNoSign;
+export interface SignedMessage {
+    type: 'signed';
+    from: PeerId;
+    topic: string;
+    data: Uint8Array;
+    sequenceNumber: bigint;
+    signature: Uint8Array;
+    key: Uint8Array;
+}
+export interface UnsignedMessage {
+    type: 'unsigned';
+    topic: string;
+    data: Uint8Array;
+}
+export type Message = SignedMessage | UnsignedMessage;
+export interface PubSubRPCMessage {
+    from?: Uint8Array;
+    topic?: string;
+    data?: Uint8Array;
+    sequenceNumber?: Uint8Array;
+    signature?: Uint8Array;
+    key?: Uint8Array;
+}
+export interface PubSubRPCSubscription {
+    subscribe?: boolean;
+    topic?: string;
+}
+export interface PubSubRPC {
+    subscriptions: PubSubRPCSubscription[];
+    messages: PubSubRPCMessage[];
+}
+export interface PeerStreams extends EventEmitter<PeerStreamEvents> {
+    id: PeerId;
+    protocol: string;
+    outboundStream?: Pushable<Uint8ArrayList>;
+    inboundStream?: AsyncIterable<Uint8ArrayList>;
+    isWritable: boolean;
+    close: () => void;
+    write: (buf: Uint8Array | Uint8ArrayList) => void;
+    attachInboundStream: (stream: Stream) => AsyncIterable<Uint8ArrayList>;
+    attachOutboundStream: (stream: Stream) => Promise<Pushable<Uint8ArrayList>>;
+}
+export interface PubSubInit {
+    enabled?: boolean;
+    multicodecs?: string[];
+    /**
+     * defines how signatures should be handled
+     */
+    globalSignaturePolicy?: SignaturePolicy;
+    /**
+     * if can relay messages not subscribed
+     */
+    canRelayMessage?: boolean;
+    /**
+     * if publish should emit to self, if subscribed
+     */
+    emitSelf?: boolean;
+    /**
+     * handle this many incoming pubsub messages concurrently
+     */
+    messageProcessingConcurrency?: number;
+    /**
+     * How many parallel incoming streams to allow on the pubsub protocol per-connection
+     */
+    maxInboundStreams?: number;
+    /**
+     * How many parallel outgoing streams to allow on the pubsub protocol per-connection
+     */
+    maxOutboundStreams?: number;
+}
+interface Subscription {
+    topic: string;
+    subscribe: boolean;
+}
+export interface SubscriptionChangeData {
+    peerId: PeerId;
+    subscriptions: Subscription[];
+}
+export interface PubSubEvents {
+    'subscription-change': CustomEvent<SubscriptionChangeData>;
+    'message': CustomEvent<Message>;
+}
+export interface PublishResult {
+    recipients: PeerId[];
+}
+export declare enum TopicValidatorResult {
+    /**
+     * The message is considered valid, and it should be delivered and forwarded to the network
+     */
+    Accept = "accept",
+    /**
+     * The message is neither delivered nor forwarded to the network
+     */
+    Ignore = "ignore",
+    /**
+     * The message is considered invalid, and it should be rejected
+     */
+    Reject = "reject"
+}
+export interface TopicValidatorFn {
+    (peer: PeerId, message: Message): TopicValidatorResult | Promise<TopicValidatorResult>;
+}
+export interface PubSub<Events extends Record<string, any> = PubSubEvents> extends EventEmitter<Events> {
+    /**
+     * The global signature policy controls whether or not we sill send and receive
+     * signed or unsigned messages.
+     *
+     * Signed messages prevent spoofing message senders and should be preferred to
+     * using unsigned messages.
+     */
+    globalSignaturePolicy: typeof StrictSign | typeof StrictNoSign;
+    /**
+     * A list of multicodecs that contain the pubsub protocol name.
+     */
+    multicodecs: string[];
+    /**
+     * Pubsub routers support message validators per topic, which will validate the message
+     * before its propagations. They are stored in a map where keys are the topic name and
+     * values are the validators.
+     *
+     * @example
+     *
+     * ```js
+     * const topic = 'topic'
+     * const validateMessage = (msgTopic, msg) => {
+     *   const input = uint8ArrayToString(msg.data)
+     *   const validInputs = ['a', 'b', 'c']
+     *
+     *   if (!validInputs.includes(input)) {
+     *     throw new Error('no valid input received')
+     *   }
+     * }
+     * libp2p.pubsub.topicValidators.set(topic, validateMessage)
+     * ```
+     */
+    topicValidators: Map<string, TopicValidatorFn>;
+    getPeers: () => PeerId[];
+    /**
+     * Gets a list of topics the node is subscribed to.
+     *
+     * ```js
+     * const topics = libp2p.pubsub.getTopics()
+     * ```
+     */
+    getTopics: () => string[];
+    /**
+     * Subscribes to a pubsub topic.
+     *
+     * @example
+     *
+     * ```js
+     * const topic = 'topic'
+     * const handler = (msg) => {
+     *   if (msg.topic === topic) {
+     *     // msg.data - pubsub data received
+     *   }
+     * }
+     *
+     * libp2p.pubsub.addEventListener('message', handler)
+     * libp2p.pubsub.subscribe(topic)
+     * ```
+     */
+    subscribe: (topic: string) => void;
+    /**
+     * Unsubscribes from a pubsub topic.
+     *
+     * @example
+     *
+     * ```js
+     * const topic = 'topic'
+     * const handler = (msg) => {
+     *   // msg.data - pubsub data received
+     * }
+     *
+     * libp2p.pubsub.removeEventListener(topic handler)
+     * libp2p.pubsub.unsubscribe(topic)
+     * ```
+     */
+    unsubscribe: (topic: string) => void;
+    /**
+     * Gets a list of the PeerIds that are subscribed to one topic.
+     *
+     * @example
+     *
+     * ```js
+     * const peerIds = libp2p.pubsub.getSubscribers(topic)
+     * ```
+     */
+    getSubscribers: (topic: string) => PeerId[];
+    /**
+     * Publishes messages to the given topic.
+     *
+     * @example
+     *
+     * ```js
+     * const topic = 'topic'
+     * const data = uint8ArrayFromString('data')
+     *
+     * await libp2p.pubsub.publish(topic, data)
+     * ```
+     */
+    publish: (topic: string, data: Uint8Array) => Promise<PublishResult>;
+}
+export interface PeerStreamEvents {
+    'stream:inbound': CustomEvent<never>;
+    'stream:outbound': CustomEvent<never>;
+    'close': CustomEvent<never>;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/src/pubsub/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pubsub/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,eAAe,CAAA;AAEtC;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,iBAAiB,CAAA;AAE1C,MAAM,MAAM,eAAe,GAAG,OAAO,UAAU,GAAG,OAAO,YAAY,CAAA;AAErE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,QAAQ,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,UAAU,CAAA;IAChB,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,UAAU,CAAA;IACrB,GAAG,EAAE,UAAU,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,MAAM,OAAO,GAAG,aAAa,GAAG,eAAe,CAAA;AAErD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,cAAc,CAAC,EAAE,UAAU,CAAA;IAC3B,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,GAAG,CAAC,EAAE,UAAU,CAAA;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,SAAS;IACxB,aAAa,EAAE,qBAAqB,EAAE,CAAA;IACtC,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,WAAY,SAAQ,YAAY,CAAC,gBAAgB,CAAC;IACjE,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,cAAc,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAA;IACzC,aAAa,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAA;IAC7C,UAAU,EAAE,OAAO,CAAA;IAEnB,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,KAAK,EAAE,CAAC,GAAG,EAAE,UAAU,GAAG,cAAc,KAAK,IAAI,CAAA;IACjD,mBAAmB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,aAAa,CAAC,cAAc,CAAC,CAAA;IACtE,oBAAoB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAA;CAC5E;AAED,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,eAAe,CAAA;IAEvC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAA;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,UAAU,YAAY;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,YAAY,EAAE,CAAA;CAC9B;AAED,MAAM,WAAW,YAAY;IAC3B,qBAAqB,EAAE,WAAW,CAAC,sBAAsB,CAAC,CAAA;IAC1D,SAAS,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,MAAM,EAAE,CAAA;CACrB;AAED,oBAAY,oBAAoB;IAC9B;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,MAAM,WAAW;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAA;CACvF;AAED,MAAM,WAAW,MAAM,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,YAAY,CAAE,SAAQ,YAAY,CAAC,MAAM,CAAC;IACrG;;;;;;OAMG;IACH,qBAAqB,EAAE,OAAO,UAAU,GAAG,OAAO,YAAY,CAAA;IAE9D;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAA;IAErB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAE9C,QAAQ,EAAE,MAAM,MAAM,EAAE,CAAA;IAExB;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,MAAM,EAAE,CAAA;IAEzB;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAElC;;;;;;;;;;;;;;OAcG;IACH,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAEpC;;;;;;;;OAQG;IACH,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,EAAE,CAAA;IAE3C;;;;;;;;;;;OAWG;IACH,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;CACrE;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IACpC,iBAAiB,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;IACrC,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAA;CAC5B"}

package/dist/src/pubsub/index.js

@@ -0,0 +1,36 @@
+/**
+ * On the producing side:
+ * * Build messages with the signature, key (from may be enough for certain inlineable public key types), from and seqno fields.
+ *
+ * On the consuming side:
+ * * Enforce the fields to be present, reject otherwise.
+ * * Propagate only if the fields are valid and signature can be verified, reject otherwise.
+ */
+export const StrictSign = 'StrictSign';
+/**
+ * On the producing side:
+ * * Build messages without the signature, key, from and seqno fields.
+ * * The corresponding protobuf key-value pairs are absent from the marshalled message, not just empty.
+ *
+ * On the consuming side:
+ * * Enforce the fields to be absent, reject otherwise.
+ * * Propagate only if the fields are absent, reject otherwise.
+ * * A message_id function will not be able to use the above fields, and should instead rely on the data field. A commonplace strategy is to calculate a hash.
+ */
+export const StrictNoSign = 'StrictNoSign';
+export var TopicValidatorResult;
+(function (TopicValidatorResult) {
+    /**
+     * The message is considered valid, and it should be delivered and forwarded to the network
+     */
+    TopicValidatorResult["Accept"] = "accept";
+    /**
+     * The message is neither delivered nor forwarded to the network
+     */
+    TopicValidatorResult["Ignore"] = "ignore";
+    /**
+     * The message is considered invalid, and it should be rejected
+     */
+    TopicValidatorResult["Reject"] = "reject";
+})(TopicValidatorResult || (TopicValidatorResult = {}));
+//# sourceMappingURL=index.js.map

package/dist/src/pubsub/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/pubsub/index.ts"],"names":[],"mappings":"AAMA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,YAAY,CAAA;AAEtC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,cAAc,CAAA;AA6G1C,MAAM,CAAN,IAAY,oBAaX;AAbD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,yCAAiB,CAAA;IACjB;;OAEG;IACH,yCAAiB,CAAA;IACjB;;OAEG;IACH,yCAAiB,CAAA;AACnB,CAAC,EAbW,oBAAoB,KAApB,oBAAoB,QAa/B"}

package/dist/src/stream-muxer/stream.d.ts

@@ -1,5 +1,5 @@
 import { Uint8ArrayList } from 'uint8arraylist';
-import type { Direction, Stream, StreamStat } from '../connection/index.js';
+import type { Direction, Stream, StreamTimeline } from '../connection/index.js';
 import type { Source } from 'it-stream-types';
 export interface AbstractStreamInit {
     /**
@@ -26,7 +26,9 @@ export interface AbstractStreamInit {
 }
 export declare abstract class AbstractStream implements Stream {
     id: string;
-    stat: StreamStat;
+    direction: Direction;
+    timeline: StreamTimeline;
+    protocol?: string;
     metadata: Record<string, unknown>;
     source: AsyncGenerator<Uint8ArrayList, void, unknown>;
     private readonly abortController;

package/dist/src/stream-muxer/stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../../src/stream-muxer/stream.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAa7C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,SAAS,KAAK,IAAI,CAAA;CAC1C;AAMD,8BAAsB,cAAe,YAAW,MAAM;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,UAAU,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,MAAM,EAAE,cAAc,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IAE5D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA0B;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAmC;IAC1D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;gBAEvB,IAAI,EAAE,kBAAkB;IAwCrC,SAAS,CAAC,WAAW,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAsBzC,SAAS,CAAC,SAAS,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAuBvC,KAAK,IAAK,IAAI;IAQd,SAAS,IAAK,IAAI;IAWlB,UAAU,IAAK,IAAI;IA2BnB,KAAK,CAAE,GAAG,EAAE,KAAK,GAAG,IAAI;IASxB,KAAK,IAAK,IAAI;IAOR,IAAI,CAAE,MAAM,EAAE,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAyGvE;;;OAGG;IACH,UAAU,CAAE,IAAI,EAAE,cAAc,GAAG,IAAI;IAIvC;;;OAGG;IACH,oBAAoB,IAAK,MAAM;IAI/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAE,GAAG,EAAE,cAAc,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE7D;;OAEG;IACH,QAAQ,CAAC,SAAS,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3C;;;OAGG;IACH,QAAQ,CAAC,cAAc,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhD;;;OAGG;IACH,QAAQ,CAAC,aAAa,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAChD"}
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../../src/stream-muxer/stream.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAE/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAC/E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAa7C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;IAEpB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,SAAS,KAAK,IAAI,CAAA;CAC1C;AAMD,8BAAsB,cAAe,YAAW,MAAM;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,SAAS,CAAA;IACpB,QAAQ,EAAE,cAAc,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,MAAM,EAAE,cAAc,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IAE5D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA0B;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAmC;IAC1D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;gBAEvB,IAAI,EAAE,kBAAkB;IAsCrC,SAAS,CAAC,WAAW,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAsBzC,SAAS,CAAC,SAAS,CAAE,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI;IAuBvC,KAAK,IAAK,IAAI;IAQd,SAAS,IAAK,IAAI;IAWlB,UAAU,IAAK,IAAI;IA2BnB,KAAK,CAAE,GAAG,EAAE,KAAK,GAAG,IAAI;IASxB,KAAK,IAAK,IAAI;IAOR,IAAI,CAAE,MAAM,EAAE,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAyGvE;;;OAGG;IACH,UAAU,CAAE,IAAI,EAAE,cAAc,GAAG,IAAI;IAIvC;;;OAGG;IACH,oBAAoB,IAAK,MAAM;IAI/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAE,GAAG,EAAE,cAAc,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE7D;;OAEG;IACH,QAAQ,CAAC,SAAS,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3C;;;OAGG;IACH,QAAQ,CAAC,cAAc,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEhD;;;OAGG;IACH,QAAQ,CAAC,aAAa,IAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAChD"}

package/dist/src/stream-muxer/stream.js

@@ -17,7 +17,9 @@ function isPromise(res) {
 }
 export class AbstractStream {
     id;
-    stat;
+    direction;
+    timeline;
+    protocol;
     metadata;
     source;
     abortController;
@@ -39,18 +41,16 @@ export class AbstractStream {
         this.sinkSunk = false;
         this.id = init.id;
         this.metadata = init.metadata ?? {};
-        this.stat = {
-            direction: init.direction,
-            timeline: {
-                open: Date.now()
-            }
+        this.direction = init.direction;
+        this.timeline = {
+            open: Date.now()
         };
         this.maxDataSize = init.maxDataSize;
         this.onEnd = init.onEnd;
         this.source = this.streamSource = pushable({
             onEnd: () => {
                 // already sent a reset message
-                if (this.stat.timeline.reset !== null) {
+                if (this.timeline.reset !== null) {
                     const res = this.sendCloseRead();
                     if (isPromise(res)) {
                         res.catch(err => {
@@ -68,14 +68,14 @@ export class AbstractStream {
         if (this.sourceEnded) {
             return;
         }
-        this.stat.timeline.closeRead = Date.now();
+        this.timeline.closeRead = Date.now();
         this.sourceEnded = true;
-        log.trace('%s stream %s source end - err: %o', this.stat.direction, this.id, err);
+        log.trace('%s stream %s source end - err: %o', this.direction, this.id, err);
         if (err != null && this.endErr == null) {
             this.endErr = err;
         }
         if (this.sinkEnded) {
-            this.stat.timeline.close = Date.now();
+            this.timeline.close = Date.now();
             if (this.onEnd != null) {
                 this.onEnd(this.endErr);
             }
@@ -85,14 +85,14 @@ export class AbstractStream {
         if (this.sinkEnded) {
             return;
         }
-        this.stat.timeline.closeWrite = Date.now();
+        this.timeline.closeWrite = Date.now();
         this.sinkEnded = true;
-        log.trace('%s stream %s sink end - err: %o', this.stat.direction, this.id, err);
+        log.trace('%s stream %s sink end - err: %o', this.direction, this.id, err);
         if (err != null && this.endErr == null) {
             this.endErr = err;
         }
         if (this.sourceEnded) {
-            this.stat.timeline.close = Date.now();
+            this.timeline.close = Date.now();
             if (this.onEnd != null) {
                 this.onEnd(this.endErr);
             }
@@ -100,13 +100,13 @@ export class AbstractStream {
     }
     // Close for both Reading and Writing
     close() {
-        log.trace('%s stream %s close', this.stat.direction, this.id);
+        log.trace('%s stream %s close', this.direction, this.id);
         this.closeRead();
         this.closeWrite();
     }
     // Close for reading
     closeRead() {
-        log.trace('%s stream %s closeRead', this.stat.direction, this.id);
+        log.trace('%s stream %s closeRead', this.direction, this.id);
         if (this.sourceEnded) {
             return;
         }
@@ -114,7 +114,7 @@ export class AbstractStream {
     }
     // Close for writing
     closeWrite() {
-        log.trace('%s stream %s closeWrite', this.stat.direction, this.id);
+        log.trace('%s stream %s closeWrite', this.direction, this.id);
         if (this.sinkEnded) {
             return;
         }
@@ -130,13 +130,13 @@ export class AbstractStream {
             }
         }
         catch (err) {
-            log.trace('%s stream %s error sending close', this.stat.direction, this.id, err);
+            log.trace('%s stream %s error sending close', this.direction, this.id, err);
         }
         this.onSinkEnd();
     }
     // Close for reading and writing (local error)
     abort(err) {
-        log.trace('%s stream %s abort', this.stat.direction, this.id, err);
+        log.trace('%s stream %s abort', this.direction, this.id, err);
         // End the source with the passed error
         this.streamSource.end(err);
         this.abortController.abort();
@@ -164,7 +164,7 @@ export class AbstractStream {
         ]);
         try {
             source = abortableSource(source, signal);
-            if (this.stat.direction === 'outbound') { // If initiator, open a new stream
+            if (this.direction === 'outbound') { // If initiator, open a new stream
                 const res = this.sendNewStream();
                 if (isPromise(res)) {
                     await res;
@@ -204,19 +204,19 @@ export class AbstractStream {
             }
             // Send no more data if this stream was remotely reset
             if (err.code === ERR_STREAM_RESET) {
-                log.trace('%s stream %s reset', this.stat.direction, this.id);
+                log.trace('%s stream %s reset', this.direction, this.id);
             }
             else {
-                log.trace('%s stream %s error', this.stat.direction, this.id, err);
+                log.trace('%s stream %s error', this.direction, this.id, err);
                 try {
                     const res = this.sendReset();
                     if (isPromise(res)) {
                         await res;
                     }
-                    this.stat.timeline.reset = Date.now();
+                    this.timeline.reset = Date.now();
                 }
                 catch (err) {
-                    log.trace('%s stream %s error sending reset', this.stat.direction, this.id, err);
+                    log.trace('%s stream %s error sending reset', this.direction, this.id, err);
                 }
             }
             this.streamSource.end(err);
@@ -233,7 +233,7 @@ export class AbstractStream {
             }
         }
         catch (err) {
-            log.trace('%s stream %s error sending close', this.stat.direction, this.id, err);
+            log.trace('%s stream %s error sending close', this.direction, this.id, err);
         }
         this.onSinkEnd();
     }

package/dist/src/stream-muxer/stream.js.map

@@ -1 +1 @@
-{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../src/stream-muxer/stream.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAiB,QAAQ,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAIxC,sCAAsC;AAEtC,MAAM,GAAG,GAAQ,GAAG,EAAE,GAAE,CAAC,CAAA;AACzB,GAAG,CAAC,KAAK,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;AACpB,GAAG,CAAC,KAAK,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;AAEpB,MAAM,gBAAgB,GAAG,kBAAkB,CAAA;AAC3C,MAAM,gBAAgB,GAAG,kBAAkB,CAAA;AAC3C,MAAM,cAAc,GAAG,gBAAgB,CAAA;AACvC,MAAM,eAAe,GAAG,iBAAiB,CAAA;AA8BzC,SAAS,SAAS,CAAE,GAAS;IAC3B,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,CAAA;AACtD,CAAC;AAED,MAAM,OAAgB,cAAc;IAC3B,EAAE,CAAQ;IACV,IAAI,CAAY;IAChB,QAAQ,CAAyB;IACjC,MAAM,CAA+C;IAE3C,eAAe,CAAiB;IAChC,eAAe,CAAiB;IAChC,eAAe,CAAiB;IACzC,WAAW,CAAS;IACpB,SAAS,CAAS;IAClB,QAAQ,CAAS;IACjB,MAAM,CAAmB;IAChB,YAAY,CAA0B;IACtC,KAAK,CAAoC;IACzC,WAAW,CAAQ;IAEpC,YAAa,IAAwB;QACnC,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC5C,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC5C,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC5C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAA;QAErB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAA;QACnC,IAAI,CAAC,IAAI,GAAG;YACV,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE;gBACR,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;aACjB;SACF,CAAA;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACnC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QAEvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAiB;YACzD,KAAK,EAAE,GAAG,EAAE;gBACV,+BAA+B;gBAC/B,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE;oBACrC,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;oBAEhC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;wBAClB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;4BACd,GAAG,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAA;wBAClD,CAAC,CAAC,CAAA;qBACH;iBACF;gBAED,IAAI,CAAC,WAAW,EAAE,CAAA;YACpB,CAAC;SACF,CAAC,CAAA;QAEF,gEAAgE;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClC,CAAC;IAES,WAAW,CAAE,GAAW;QAChC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAM;SACP;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACzC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;QAEjF,IAAI,GAAG,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACtC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAA;SAClB;QAED,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAErC,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aACxB;SACF;IACH,CAAC;IAES,SAAS,CAAE,GAAW;QAC9B,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAM;SACP;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAC1C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;QAE/E,IAAI,GAAG,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACtC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAA;SAClB;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAErC,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aACxB;SACF;IACH,CAAC;IAED,qCAAqC;IACrC,KAAK;QACH,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAE7D,IAAI,CAAC,SAAS,EAAE,CAAA;QAChB,IAAI,CAAC,UAAU,EAAE,CAAA;IACnB,CAAC;IAED,oBAAoB;IACpB,SAAS;QACP,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAEjE,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAM;SACP;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAA;IACzB,CAAC;IAED,oBAAoB;IACpB,UAAU;QACR,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAElE,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAM;SACP;QAED,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;QAE5B,IAAI;YACF,uEAAuE;YACvE,uCAAuC;YACvC,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;YAEjC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;gBAClB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;oBACd,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;gBACnD,CAAC,CAAC,CAAA;aACH;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;SACjF;QAED,IAAI,CAAC,SAAS,EAAE,CAAA;IAClB,CAAC;IAED,8CAA8C;IAC9C,KAAK,CAAE,GAAU;QACf,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;QAClE,uCAAuC;QACvC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;QAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IACrB,CAAC;IAED,2DAA2D;IAC3D,KAAK;QACH,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAA;QAC3D,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;QAC5B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI,CAAE,MAA2C;QACrD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,MAAM,IAAI,SAAS,CAAC,+BAA+B,EAAE,eAAe,CAAC,CAAA;SACtE;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QAEpB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,SAAS,CAAC,2BAA2B,EAAE,cAAc,CAAC,CAAA;SACjE;QAED,MAAM,MAAM,GAAG,SAAS,CAAC;YACvB,IAAI,CAAC,eAAe,CAAC,MAAM;YAC3B,IAAI,CAAC,eAAe,CAAC,MAAM;YAC3B,IAAI,CAAC,eAAe,CAAC,MAAM;SAC5B,CAAC,CAAA;QAEF,IAAI;YACF,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YAExC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,UAAU,EAAE,EAAE,kCAAkC;gBAC1E,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;gBAEhC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;oBAClB,MAAM,GAAG,CAAA;iBACV;aACF;YAED,IAAI,KAAK,EAAE,IAAI,IAAI,IAAI,MAAM,EAAE;gBAC7B,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;oBACtB,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,EAAE;wBACnC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;wBAEvF,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,gCAAgC;4BACpD,MAAM,GAAG,CAAA;yBACV;wBAED,MAAK;qBACN;oBACD,IAAI,GAAG,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;oBACnE,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAA;oBAE5D,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;wBAClB,MAAM,GAAG,CAAA;qBACV;oBAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;iBAC/B;aACF;SACF;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,OAAO,KAAK,2BAA2B,EAAE;gBACzE,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;oBACvC,OAAM;iBACP;gBAED,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;oBACvC,GAAG,CAAC,OAAO,GAAG,cAAc,CAAA;oBAC5B,GAAG,CAAC,IAAI,GAAG,gBAAgB,CAAA;iBAC5B;gBAED,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;oBACvC,GAAG,CAAC,OAAO,GAAG,gBAAgB,CAAA;oBAC9B,GAAG,CAAC,IAAI,GAAG,gBAAgB,CAAA;iBAC5B;aACF;YAED,sDAAsD;YACtD,IAAI,GAAG,CAAC,IAAI,KAAK,gBAAgB,EAAE;gBACjC,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;aAC9D;iBAAM;gBACL,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;gBAClE,IAAI;oBACF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;oBAE5B,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;wBAClB,MAAM,GAAG,CAAA;qBACV;oBAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;iBACtC;gBAAC,OAAO,GAAG,EAAE;oBACZ,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;iBACjF;aACF;YAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC1B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;YAEnB,MAAM,GAAG,CAAA;SACV;gBAAS;YACR,MAAM,CAAC,KAAK,EAAE,CAAA;SACf;QAED,IAAI;YACF,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;YAEjC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;gBAClB,MAAM,GAAG,CAAA;aACV;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;SACjF;QAED,IAAI,CAAC,SAAS,EAAE,CAAA;IAClB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAE,IAAoB;QAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACH,oBAAoB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAA;IACzC,CAAC;CA6BF"}
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../../src/stream-muxer/stream.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AACtC,OAAO,EAAiB,QAAQ,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAIxC,sCAAsC;AAEtC,MAAM,GAAG,GAAQ,GAAG,EAAE,GAAE,CAAC,CAAA;AACzB,GAAG,CAAC,KAAK,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;AACpB,GAAG,CAAC,KAAK,GAAG,GAAG,EAAE,GAAE,CAAC,CAAA;AAEpB,MAAM,gBAAgB,GAAG,kBAAkB,CAAA;AAC3C,MAAM,gBAAgB,GAAG,kBAAkB,CAAA;AAC3C,MAAM,cAAc,GAAG,gBAAgB,CAAA;AACvC,MAAM,eAAe,GAAG,iBAAiB,CAAA;AA8BzC,SAAS,SAAS,CAAE,GAAS;IAC3B,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,CAAA;AACtD,CAAC;AAED,MAAM,OAAgB,cAAc;IAC3B,EAAE,CAAQ;IACV,SAAS,CAAW;IACpB,QAAQ,CAAgB;IACxB,QAAQ,CAAS;IACjB,QAAQ,CAAyB;IACjC,MAAM,CAA+C;IAE3C,eAAe,CAAiB;IAChC,eAAe,CAAiB;IAChC,eAAe,CAAiB;IACzC,WAAW,CAAS;IACpB,SAAS,CAAS;IAClB,QAAQ,CAAS;IACjB,MAAM,CAAmB;IAChB,YAAY,CAA0B;IACtC,KAAK,CAAoC;IACzC,WAAW,CAAQ;IAEpC,YAAa,IAAwB;QACnC,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC5C,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC5C,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC5C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAA;QAErB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAA;QACnC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC/B,IAAI,CAAC,QAAQ,GAAG;YACd,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;SACjB,CAAA;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACnC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QAEvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAiB;YACzD,KAAK,EAAE,GAAG,EAAE;gBACV,+BAA+B;gBAC/B,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE;oBAChC,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;oBAEhC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;wBAClB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;4BACd,GAAG,CAAC,KAAK,CAAC,gCAAgC,EAAE,GAAG,CAAC,CAAA;wBAClD,CAAC,CAAC,CAAA;qBACH;iBACF;gBAED,IAAI,CAAC,WAAW,EAAE,CAAA;YACpB,CAAC;SACF,CAAC,CAAA;QAEF,gEAAgE;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClC,CAAC;IAES,WAAW,CAAE,GAAW;QAChC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAM;SACP;QAED,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACpC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;QAE5E,IAAI,GAAG,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACtC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAA;SAClB;QAED,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAEhC,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aACxB;SACF;IACH,CAAC;IAES,SAAS,CAAE,GAAW;QAC9B,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAM;SACP;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;QAE1E,IAAI,GAAG,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE;YACtC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAA;SAClB;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAEhC,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;aACxB;SACF;IACH,CAAC;IAED,qCAAqC;IACrC,KAAK;QACH,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAExD,IAAI,CAAC,SAAS,EAAE,CAAA;QAChB,IAAI,CAAC,UAAU,EAAE,CAAA;IACnB,CAAC;IAED,oBAAoB;IACpB,SAAS;QACP,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAE5D,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAM;SACP;QAED,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAA;IACzB,CAAC;IAED,oBAAoB;IACpB,UAAU;QACR,GAAG,CAAC,KAAK,CAAC,yBAAyB,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAE7D,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,OAAM;SACP;QAED,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;QAE5B,IAAI;YACF,uEAAuE;YACvE,uCAAuC;YACvC,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;YAEjC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;gBAClB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;oBACd,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,GAAG,CAAC,CAAA;gBACnD,CAAC,CAAC,CAAA;aACH;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;SAC5E;QAED,IAAI,CAAC,SAAS,EAAE,CAAA;IAClB,CAAC;IAED,8CAA8C;IAC9C,KAAK,CAAE,GAAU;QACf,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;QAC7D,uCAAuC;QACvC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;QAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IACrB,CAAC;IAED,2DAA2D;IAC3D,KAAK;QACH,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAA;QAC3D,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAA;QAC5B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,IAAI,CAAE,MAA2C;QACrD,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,MAAM,IAAI,SAAS,CAAC,+BAA+B,EAAE,eAAe,CAAC,CAAA;SACtE;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QAEpB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,SAAS,CAAC,2BAA2B,EAAE,cAAc,CAAC,CAAA;SACjE;QAED,MAAM,MAAM,GAAG,SAAS,CAAC;YACvB,IAAI,CAAC,eAAe,CAAC,MAAM;YAC3B,IAAI,CAAC,eAAe,CAAC,MAAM;YAC3B,IAAI,CAAC,eAAe,CAAC,MAAM;SAC5B,CAAC,CAAA;QAEF,IAAI;YACF,MAAM,GAAG,eAAe,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YAExC,IAAI,IAAI,CAAC,SAAS,KAAK,UAAU,EAAE,EAAE,kCAAkC;gBACrE,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;gBAEhC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;oBAClB,MAAM,GAAG,CAAA;iBACV;aACF;YAED,IAAI,KAAK,EAAE,IAAI,IAAI,IAAI,MAAM,EAAE;gBAC7B,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;oBACtB,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,EAAE;wBACnC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;wBAEvF,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,gCAAgC;4BACpD,MAAM,GAAG,CAAA;yBACV;wBAED,MAAK;qBACN;oBACD,IAAI,GAAG,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;oBACnE,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAA;oBAE5D,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;wBAClB,MAAM,GAAG,CAAA;qBACV;oBAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;iBAC/B;aACF;SACF;QAAC,OAAO,GAAQ,EAAE;YACjB,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,OAAO,KAAK,2BAA2B,EAAE;gBACzE,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;oBACvC,OAAM;iBACP;gBAED,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;oBACvC,GAAG,CAAC,OAAO,GAAG,cAAc,CAAA;oBAC5B,GAAG,CAAC,IAAI,GAAG,gBAAgB,CAAA;iBAC5B;gBAED,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE;oBACvC,GAAG,CAAC,OAAO,GAAG,gBAAgB,CAAA;oBAC9B,GAAG,CAAC,IAAI,GAAG,gBAAgB,CAAA;iBAC5B;aACF;YAED,sDAAsD;YACtD,IAAI,GAAG,CAAC,IAAI,KAAK,gBAAgB,EAAE;gBACjC,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;aACzD;iBAAM;gBACL,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;gBAC7D,IAAI;oBACF,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;oBAE5B,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;wBAClB,MAAM,GAAG,CAAA;qBACV;oBAED,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;iBACjC;gBAAC,OAAO,GAAG,EAAE;oBACZ,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;iBAC5E;aACF;YAED,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YAC1B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;YAEnB,MAAM,GAAG,CAAA;SACV;gBAAS;YACR,MAAM,CAAC,KAAK,EAAE,CAAA;SACf;QAED,IAAI;YACF,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAA;YAEjC,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;gBAClB,MAAM,GAAG,CAAA;aACV;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;SAC5E;QAED,IAAI,CAAC,SAAS,EAAE,CAAA;IAClB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAE,IAAoB;QAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAED;;;OAGG;IACH,oBAAoB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAA;IACzC,CAAC;CA6BF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface",
-  "version": "0.0.1-8b0e6bef",
+  "version": "0.0.1-e9cafd3d",
   "description": "The interface implemented by a libp2p node",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/interface#readme",
@@ -112,6 +112,10 @@
       "types": "./dist/src/peer-store/tags.d.ts",
       "import": "./dist/src/peer-store/tags.js"
     },
+    "./pubsub": {
+      "types": "./dist/src/pubsub/index.d.ts",
+      "import": "./dist/src/pubsub/index.js"
+    },
     "./record": {
       "types": "./dist/src/record/index.d.ts",
       "import": "./dist/src/record/index.js"
@@ -167,7 +171,7 @@
   },
   "devDependencies": {
     "@types/sinon": "^10.0.15",
-    "aegir": "^39.0.10",
+    "aegir": "^39.0.13",
     "sinon": "^15.1.2",
     "sinon-ts": "^1.0.0"
   },

package/src/connection/index.ts

@@ -12,37 +12,10 @@ export interface ConnectionTimeline {
 }
 
 /**
- * Outbound conections are opened by the local node, inbound streams are opened by the remote
+ * Outbound connections are opened by the local node, inbound streams are opened by the remote
  */
 export type Direction = 'inbound' | 'outbound'
 
-export interface ConnectionStat {
-  /**
-   * Outbound conections are opened by the local node, inbound streams are opened by the remote
-   */
-  direction: Direction
-
-  /**
-   * Lifecycle times for the connection
-   */
-  timeline: ConnectionTimeline
-
-  /**
-   * Once a multiplexer has been negotiated for this stream, it will be set on the stat object
-   */
-  multiplexer?: string
-
-  /**
-   * Once a connection encrypter has been negotiated for this stream, it will be set on the stat object
-   */
-  encryption?: string
-
-  /**
-   * The current status of the connection
-   */
-  status: keyof typeof Status
-}
-
 export interface StreamTimeline {
   /**
    * A timestamp of when the stream was opened
@@ -70,23 +43,6 @@ export interface StreamTimeline {
   reset?: number
 }
 
-export interface StreamStat {
-  /**
-   * Outbound streams are opened by the local node, inbound streams are opened by the remote
-   */
-  direction: Direction
-
-  /**
-   * Lifecycle times for the stream
-   */
-  timeline: StreamTimeline
-
-  /**
-   * Once a protocol has been negotiated for this stream, it will be set on the stat object
-   */
-  protocol?: string
-}
-
 /**
  * A Stream is a data channel between two peers that
  * can be written to and read from at both ends.
@@ -148,9 +104,19 @@ export interface Stream extends Duplex<AsyncGenerator<Uint8ArrayList>, Source<Ui
   id: string
 
   /**
-   * Stats about this stream
+   * Outbound streams are opened by the local node, inbound streams are opened by the remote
    */
-  stat: StreamStat
+  direction: Direction
+
+  /**
+   * Lifecycle times for the stream
+   */
+  timeline: StreamTimeline
+
+  /**
+   * Once a protocol has been negotiated for this stream, it will be set on the stat object
+   */
+  protocol?: string
 
   /**
    * User defined stream metadata
@@ -174,13 +140,56 @@ export interface NewStreamOptions extends AbortOptions {
  * between which the connection is made.
  */
 export interface Connection {
+  /**
+   * The unique identifier for this connection
+   */
   id: string
-  stat: ConnectionStat
+
+  /**
+   * The address of the remote end of the connection
+   */
   remoteAddr: Multiaddr
+
+  /**
+   * The id of the peer at the remote end of the connection
+   */
   remotePeer: PeerId
+
+  /**
+   * A list of tags applied to this connection
+   */
   tags: string[]
+
+  /**
+   * A list of open streams on this connection
+   */
   streams: Stream[]
 
+  /**
+   * Outbound conections are opened by the local node, inbound streams are opened by the remote
+   */
+  direction: Direction
+
+  /**
+   * Lifecycle times for the connection
+   */
+  timeline: ConnectionTimeline
+
+  /**
+   * Once a multiplexer has been negotiated for this stream, it will be set on the stat object
+   */
+  multiplexer?: string
+
+  /**
+   * Once a connection encrypter has been negotiated for this stream, it will be set on the stat object
+   */
+  encryption?: string
+
+  /**
+   * The current status of the connection
+   */
+  status: keyof typeof Status
+
   newStream: (multicodecs: string | string[], options?: NewStreamOptions) => Promise<Stream>
   addStream: (stream: Stream) => void
   removeStream: (id: string) => void

package/src/pubsub/index.ts

@@ -0,0 +1,269 @@
+import type { Stream } from '../connection/index.js'
+import type { EventEmitter } from '../events.js'
+import type { PeerId } from '../peer-id/index.js'
+import type { Pushable } from 'it-pushable'
+import type { Uint8ArrayList } from 'uint8arraylist'
+
+/**
+ * On the producing side:
+ * * Build messages with the signature, key (from may be enough for certain inlineable public key types), from and seqno fields.
+ *
+ * On the consuming side:
+ * * Enforce the fields to be present, reject otherwise.
+ * * Propagate only if the fields are valid and signature can be verified, reject otherwise.
+ */
+export const StrictSign = 'StrictSign'
+
+/**
+ * On the producing side:
+ * * Build messages without the signature, key, from and seqno fields.
+ * * The corresponding protobuf key-value pairs are absent from the marshalled message, not just empty.
+ *
+ * On the consuming side:
+ * * Enforce the fields to be absent, reject otherwise.
+ * * Propagate only if the fields are absent, reject otherwise.
+ * * A message_id function will not be able to use the above fields, and should instead rely on the data field. A commonplace strategy is to calculate a hash.
+ */
+export const StrictNoSign = 'StrictNoSign'
+
+export type SignaturePolicy = typeof StrictSign | typeof StrictNoSign
+
+export interface SignedMessage {
+  type: 'signed'
+  from: PeerId
+  topic: string
+  data: Uint8Array
+  sequenceNumber: bigint
+  signature: Uint8Array
+  key: Uint8Array
+}
+
+export interface UnsignedMessage {
+  type: 'unsigned'
+  topic: string
+  data: Uint8Array
+}
+
+export type Message = SignedMessage | UnsignedMessage
+
+export interface PubSubRPCMessage {
+  from?: Uint8Array
+  topic?: string
+  data?: Uint8Array
+  sequenceNumber?: Uint8Array
+  signature?: Uint8Array
+  key?: Uint8Array
+}
+
+export interface PubSubRPCSubscription {
+  subscribe?: boolean
+  topic?: string
+}
+
+export interface PubSubRPC {
+  subscriptions: PubSubRPCSubscription[]
+  messages: PubSubRPCMessage[]
+}
+
+export interface PeerStreams extends EventEmitter<PeerStreamEvents> {
+  id: PeerId
+  protocol: string
+  outboundStream?: Pushable<Uint8ArrayList>
+  inboundStream?: AsyncIterable<Uint8ArrayList>
+  isWritable: boolean
+
+  close: () => void
+  write: (buf: Uint8Array | Uint8ArrayList) => void
+  attachInboundStream: (stream: Stream) => AsyncIterable<Uint8ArrayList>
+  attachOutboundStream: (stream: Stream) => Promise<Pushable<Uint8ArrayList>>
+}
+
+export interface PubSubInit {
+  enabled?: boolean
+
+  multicodecs?: string[]
+
+  /**
+   * defines how signatures should be handled
+   */
+  globalSignaturePolicy?: SignaturePolicy
+
+  /**
+   * if can relay messages not subscribed
+   */
+  canRelayMessage?: boolean
+
+  /**
+   * if publish should emit to self, if subscribed
+   */
+  emitSelf?: boolean
+
+  /**
+   * handle this many incoming pubsub messages concurrently
+   */
+  messageProcessingConcurrency?: number
+
+  /**
+   * How many parallel incoming streams to allow on the pubsub protocol per-connection
+   */
+  maxInboundStreams?: number
+
+  /**
+   * How many parallel outgoing streams to allow on the pubsub protocol per-connection
+   */
+  maxOutboundStreams?: number
+}
+
+interface Subscription {
+  topic: string
+  subscribe: boolean
+}
+
+export interface SubscriptionChangeData {
+  peerId: PeerId
+  subscriptions: Subscription[]
+}
+
+export interface PubSubEvents {
+  'subscription-change': CustomEvent<SubscriptionChangeData>
+  'message': CustomEvent<Message>
+}
+
+export interface PublishResult {
+  recipients: PeerId[]
+}
+
+export enum TopicValidatorResult {
+  /**
+   * The message is considered valid, and it should be delivered and forwarded to the network
+   */
+  Accept = 'accept',
+  /**
+   * The message is neither delivered nor forwarded to the network
+   */
+  Ignore = 'ignore',
+  /**
+   * The message is considered invalid, and it should be rejected
+   */
+  Reject = 'reject'
+}
+
+export interface TopicValidatorFn {
+  (peer: PeerId, message: Message): TopicValidatorResult | Promise<TopicValidatorResult>
+}
+
+export interface PubSub<Events extends Record<string, any> = PubSubEvents> extends EventEmitter<Events> {
+  /**
+   * The global signature policy controls whether or not we sill send and receive
+   * signed or unsigned messages.
+   *
+   * Signed messages prevent spoofing message senders and should be preferred to
+   * using unsigned messages.
+   */
+  globalSignaturePolicy: typeof StrictSign | typeof StrictNoSign
+
+  /**
+   * A list of multicodecs that contain the pubsub protocol name.
+   */
+  multicodecs: string[]
+
+  /**
+   * Pubsub routers support message validators per topic, which will validate the message
+   * before its propagations. They are stored in a map where keys are the topic name and
+   * values are the validators.
+   *
+   * @example
+   *
+   * ```js
+   * const topic = 'topic'
+   * const validateMessage = (msgTopic, msg) => {
+   *   const input = uint8ArrayToString(msg.data)
+   *   const validInputs = ['a', 'b', 'c']
+   *
+   *   if (!validInputs.includes(input)) {
+   *     throw new Error('no valid input received')
+   *   }
+   * }
+   * libp2p.pubsub.topicValidators.set(topic, validateMessage)
+   * ```
+   */
+  topicValidators: Map<string, TopicValidatorFn>
+
+  getPeers: () => PeerId[]
+
+  /**
+   * Gets a list of topics the node is subscribed to.
+   *
+   * ```js
+   * const topics = libp2p.pubsub.getTopics()
+   * ```
+   */
+  getTopics: () => string[]
+
+  /**
+   * Subscribes to a pubsub topic.
+   *
+   * @example
+   *
+   * ```js
+   * const topic = 'topic'
+   * const handler = (msg) => {
+   *   if (msg.topic === topic) {
+   *     // msg.data - pubsub data received
+   *   }
+   * }
+   *
+   * libp2p.pubsub.addEventListener('message', handler)
+   * libp2p.pubsub.subscribe(topic)
+   * ```
+   */
+  subscribe: (topic: string) => void
+
+  /**
+   * Unsubscribes from a pubsub topic.
+   *
+   * @example
+   *
+   * ```js
+   * const topic = 'topic'
+   * const handler = (msg) => {
+   *   // msg.data - pubsub data received
+   * }
+   *
+   * libp2p.pubsub.removeEventListener(topic handler)
+   * libp2p.pubsub.unsubscribe(topic)
+   * ```
+   */
+  unsubscribe: (topic: string) => void
+
+  /**
+   * Gets a list of the PeerIds that are subscribed to one topic.
+   *
+   * @example
+   *
+   * ```js
+   * const peerIds = libp2p.pubsub.getSubscribers(topic)
+   * ```
+   */
+  getSubscribers: (topic: string) => PeerId[]
+
+  /**
+   * Publishes messages to the given topic.
+   *
+   * @example
+   *
+   * ```js
+   * const topic = 'topic'
+   * const data = uint8ArrayFromString('data')
+   *
+   * await libp2p.pubsub.publish(topic, data)
+   * ```
+   */
+  publish: (topic: string, data: Uint8Array) => Promise<PublishResult>
+}
+
+export interface PeerStreamEvents {
+  'stream:inbound': CustomEvent<never>
+  'stream:outbound': CustomEvent<never>
+  'close': CustomEvent<never>
+}

package/src/stream-muxer/stream.ts

@@ -4,7 +4,7 @@ import { anySignal } from 'any-signal'
 import { type Pushable, pushable } from 'it-pushable'
 import { Uint8ArrayList } from 'uint8arraylist'
 import { CodeError } from '../errors.js'
-import type { Direction, Stream, StreamStat } from '../connection/index.js'
+import type { Direction, Stream, StreamTimeline } from '../connection/index.js'
 import type { Source } from 'it-stream-types'
 
 // const log = logger('libp2p:stream')
@@ -52,7 +52,9 @@ function isPromise (res?: any): res is Promise<void> {
 
 export abstract class AbstractStream implements Stream {
   public id: string
-  public stat: StreamStat
+  public direction: Direction
+  public timeline: StreamTimeline
+  public protocol?: string
   public metadata: Record<string, unknown>
   public source: AsyncGenerator<Uint8ArrayList, void, unknown>
 
@@ -77,11 +79,9 @@ export abstract class AbstractStream implements Stream {
 
     this.id = init.id
     this.metadata = init.metadata ?? {}
-    this.stat = {
-      direction: init.direction,
-      timeline: {
-        open: Date.now()
-      }
+    this.direction = init.direction
+    this.timeline = {
+      open: Date.now()
     }
     this.maxDataSize = init.maxDataSize
     this.onEnd = init.onEnd
@@ -89,7 +89,7 @@ export abstract class AbstractStream implements Stream {
     this.source = this.streamSource = pushable<Uint8ArrayList>({
       onEnd: () => {
         // already sent a reset message
-        if (this.stat.timeline.reset !== null) {
+        if (this.timeline.reset !== null) {
           const res = this.sendCloseRead()
 
           if (isPromise(res)) {
@@ -112,16 +112,16 @@ export abstract class AbstractStream implements Stream {
       return
     }
 
-    this.stat.timeline.closeRead = Date.now()
+    this.timeline.closeRead = Date.now()
     this.sourceEnded = true
-    log.trace('%s stream %s source end - err: %o', this.stat.direction, this.id, err)
+    log.trace('%s stream %s source end - err: %o', this.direction, this.id, err)
 
     if (err != null && this.endErr == null) {
       this.endErr = err
     }
 
     if (this.sinkEnded) {
-      this.stat.timeline.close = Date.now()
+      this.timeline.close = Date.now()
 
       if (this.onEnd != null) {
         this.onEnd(this.endErr)
@@ -134,16 +134,16 @@ export abstract class AbstractStream implements Stream {
       return
     }
 
-    this.stat.timeline.closeWrite = Date.now()
+    this.timeline.closeWrite = Date.now()
     this.sinkEnded = true
-    log.trace('%s stream %s sink end - err: %o', this.stat.direction, this.id, err)
+    log.trace('%s stream %s sink end - err: %o', this.direction, this.id, err)
 
     if (err != null && this.endErr == null) {
       this.endErr = err
     }
 
     if (this.sourceEnded) {
-      this.stat.timeline.close = Date.now()
+      this.timeline.close = Date.now()
 
       if (this.onEnd != null) {
         this.onEnd(this.endErr)
@@ -153,7 +153,7 @@ export abstract class AbstractStream implements Stream {
 
   // Close for both Reading and Writing
   close (): void {
-    log.trace('%s stream %s close', this.stat.direction, this.id)
+    log.trace('%s stream %s close', this.direction, this.id)
 
     this.closeRead()
     this.closeWrite()
@@ -161,7 +161,7 @@ export abstract class AbstractStream implements Stream {
 
   // Close for reading
   closeRead (): void {
-    log.trace('%s stream %s closeRead', this.stat.direction, this.id)
+    log.trace('%s stream %s closeRead', this.direction, this.id)
 
     if (this.sourceEnded) {
       return
@@ -172,7 +172,7 @@ export abstract class AbstractStream implements Stream {
 
   // Close for writing
   closeWrite (): void {
-    log.trace('%s stream %s closeWrite', this.stat.direction, this.id)
+    log.trace('%s stream %s closeWrite', this.direction, this.id)
 
     if (this.sinkEnded) {
       return
@@ -191,7 +191,7 @@ export abstract class AbstractStream implements Stream {
         })
       }
     } catch (err) {
-      log.trace('%s stream %s error sending close', this.stat.direction, this.id, err)
+      log.trace('%s stream %s error sending close', this.direction, this.id, err)
     }
 
     this.onSinkEnd()
@@ -199,7 +199,7 @@ export abstract class AbstractStream implements Stream {
 
   // Close for reading and writing (local error)
   abort (err: Error): void {
-    log.trace('%s stream %s abort', this.stat.direction, this.id, err)
+    log.trace('%s stream %s abort', this.direction, this.id, err)
     // End the source with the passed error
     this.streamSource.end(err)
     this.abortController.abort()
@@ -234,7 +234,7 @@ export abstract class AbstractStream implements Stream {
     try {
       source = abortableSource(source, signal)
 
-      if (this.stat.direction === 'outbound') { // If initiator, open a new stream
+      if (this.direction === 'outbound') { // If initiator, open a new stream
         const res = this.sendNewStream()
 
         if (isPromise(res)) {
@@ -282,9 +282,9 @@ export abstract class AbstractStream implements Stream {
 
       // Send no more data if this stream was remotely reset
       if (err.code === ERR_STREAM_RESET) {
-        log.trace('%s stream %s reset', this.stat.direction, this.id)
+        log.trace('%s stream %s reset', this.direction, this.id)
       } else {
-        log.trace('%s stream %s error', this.stat.direction, this.id, err)
+        log.trace('%s stream %s error', this.direction, this.id, err)
         try {
           const res = this.sendReset()
 
@@ -292,9 +292,9 @@ export abstract class AbstractStream implements Stream {
             await res
           }
 
-          this.stat.timeline.reset = Date.now()
+          this.timeline.reset = Date.now()
         } catch (err) {
-          log.trace('%s stream %s error sending reset', this.stat.direction, this.id, err)
+          log.trace('%s stream %s error sending reset', this.direction, this.id, err)
         }
       }
 
@@ -313,7 +313,7 @@ export abstract class AbstractStream implements Stream {
         await res
       }
     } catch (err) {
-      log.trace('%s stream %s error sending close', this.stat.direction, this.id, err)
+      log.trace('%s stream %s error sending close', this.direction, this.id, err)
     }
 
     this.onSinkEnd()