@libp2p/floodsub 10.1.46 → 11.0.0-049bfa0fa

package/dist/src/constants.d.ts

@@ -0,0 +1,6 @@
+/**
+ * All Pubsub implementations must use this symbol as the name of a property
+ * with a boolean `true` value
+ */
+export declare const pubSubSymbol: unique symbol;
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,YAAY,eAA+B,CAAA"}

package/dist/src/constants.js

@@ -0,0 +1,6 @@
+/**
+ * All Pubsub implementations must use this symbol as the name of a property
+ * with a boolean `true` value
+ */
+export const pubSubSymbol = Symbol.for('@libp2p/pubsub');
+//# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA"}

package/dist/src/floodsub.d.ts

@@ -0,0 +1,205 @@
+import { serviceCapabilities, serviceDependencies } from '@libp2p/interface';
+import { PeerMap, PeerSet } from '@libp2p/peer-collections';
+import { TypedEventEmitter } from 'main-event';
+import Queue from 'p-queue';
+import { SimpleTimeCache } from './cache.js';
+import { pubSubSymbol } from './constants.ts';
+import { PeerStreams } from './peer-streams.js';
+import { StrictNoSign, StrictSign } from './index.js';
+import type { FloodSubComponents, FloodSubEvents, FloodSubInit, FloodSub as FloodSubInterface, Message, PublishResult, TopicValidatorFn } from './index.js';
+import type { Logger, Connection, PeerId, Stream } from '@libp2p/interface';
+import type { Uint8ArrayList } from 'uint8arraylist';
+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[];
+}
+/**
+ * PubSubBaseProtocol handles the peers and connections logic for pubsub routers
+ * and specifies the API that pubsub routers should have.
+ */
+export declare class FloodSub extends TypedEventEmitter<FloodSubEvents> implements FloodSubInterface {
+    protected log: Logger;
+    started: boolean;
+    /**
+     * Map of topics to which peers are subscribed to
+     */
+    topics: Map<string, PeerSet>;
+    /**
+     * List of our subscriptions
+     */
+    subscriptions: Set<string>;
+    /**
+     * Map of peer streams
+     */
+    peers: PeerMap<PeerStreams>;
+    /**
+     * The signature policy to follow by default
+     */
+    globalSignaturePolicy: typeof StrictNoSign | typeof StrictSign;
+    /**
+     * If router can relay received messages, even if not subscribed
+     */
+    canRelayMessage: boolean;
+    /**
+     * if publish should emit to self, if subscribed
+     */
+    emitSelf: boolean;
+    /**
+     * Topic validator map
+     *
+     * Keyed by topic
+     * Topic validators are functions with the following input:
+     */
+    topicValidators: Map<string, TopicValidatorFn>;
+    queue: Queue;
+    protocols: string[];
+    components: FloodSubComponents;
+    private _registrarTopologyIds;
+    private readonly maxInboundStreams;
+    private readonly maxOutboundStreams;
+    seenCache: SimpleTimeCache<boolean>;
+    constructor(components: FloodSubComponents, init: FloodSubInit);
+    readonly [pubSubSymbol] = true;
+    readonly [Symbol.toStringTag] = "@libp2p/floodsub";
+    readonly [serviceCapabilities]: string[];
+    readonly [serviceDependencies]: string[];
+    /**
+     * Register the pubsub protocol onto the libp2p node.
+     */
+    start(): Promise<void>;
+    /**
+     * Unregister the pubsub protocol and the streams with other peers will be closed.
+     */
+    stop(): Promise<void>;
+    isStarted(): boolean;
+    /**
+     * On an inbound stream opened
+     */
+    protected _onIncomingStream(stream: Stream, connection: Connection): void;
+    /**
+     * Registrar notifies an established connection with pubsub protocol
+     */
+    protected _onPeerConnected(peerId: PeerId, conn: Connection): Promise<void>;
+    /**
+     * Registrar notifies a closing connection with pubsub protocol
+     */
+    protected _onPeerDisconnected(peerId: PeerId, conn?: Connection): void;
+    /**
+     * Notifies the router that a peer has been connected
+     */
+    addPeer(peerId: PeerId, protocol: string): PeerStreams;
+    /**
+     * Notifies the router that a peer has been disconnected
+     */
+    protected _removePeer(peerId: PeerId): PeerStreams | undefined;
+    /**
+     * Responsible for processing each RPC message received by other peers.
+     */
+    processMessages(peerId: PeerId, stream: AsyncIterable<Uint8ArrayList>, peerStreams: PeerStreams): Promise<void>;
+    /**
+     * Handles an rpc request from a peer
+     */
+    processRpc(from: PeerId, peerStreams: PeerStreams, rpc: PubSubRPC): Promise<boolean>;
+    /**
+     * Handles a subscription change from a peer
+     */
+    processRpcSubOpt(id: PeerId, subOpt: PubSubRPCSubscription): void;
+    /**
+     * Handles a message from a peer
+     */
+    processMessage(from: PeerId, msg: Message): Promise<void>;
+    /**
+     * The default msgID implementation
+     * Child class can override this.
+     */
+    getMsgId(msg: Message): Promise<Uint8Array> | Uint8Array;
+    /**
+     * Whether to accept a message from a peer
+     * Override to create a gray list
+     */
+    acceptFrom(id: PeerId): boolean;
+    /**
+     * Decode Uint8Array into an RPC object.
+     * This can be override to use a custom router protobuf.
+     */
+    decodeRpc(bytes: Uint8Array | Uint8ArrayList): PubSubRPC;
+    /**
+     * Encode RPC object into a Uint8Array.
+     * This can be override to use a custom router protobuf.
+     */
+    encodeRpc(rpc: PubSubRPC): Uint8Array;
+    /**
+     * Encode RPC object into a Uint8Array.
+     * This can be override to use a custom router protobuf.
+     */
+    encodeMessage(rpc: PubSubRPCMessage): Uint8Array;
+    /**
+     * Send an rpc object to a peer
+     */
+    send(peer: PeerId, data: {
+        messages?: Message[];
+        subscriptions?: string[];
+        subscribe?: boolean;
+    }): void;
+    /**
+     * Send an rpc object to a peer
+     */
+    sendRpc(peer: PeerId, rpc: PubSubRPC): void;
+    /**
+     * Validates the given message. The signature will be checked for authenticity.
+     * Throws an error on invalid messages
+     */
+    validate(from: PeerId, message: Message): Promise<void>;
+    /**
+     * Normalizes the message and signs it, if signing is enabled.
+     * Should be used by the routers to create the message to send.
+     */
+    buildMessage(message: {
+        from: PeerId;
+        topic: string;
+        data: Uint8Array;
+        sequenceNumber: bigint;
+    }): Promise<Message>;
+    /**
+     * Get a list of the peer-ids that are subscribed to one topic.
+     */
+    getSubscribers(topic: string): PeerId[];
+    /**
+     * Publishes messages to all subscribed peers
+     */
+    publish(topic: string, data?: Uint8Array): Promise<PublishResult>;
+    /**
+     * Overriding the implementation of publish should handle the appropriate algorithms for the publish/subscriber implementation.
+     * For example, a Floodsub implementation might simply publish each message to each topic for every peer.
+     *
+     * `sender` might be this peer, or we might be forwarding a message on behalf of another peer, in which case sender
+     * is the peer we received the message from, which may not be the peer the message was created by.
+     */
+    publishMessage(from: PeerId, message: Message): Promise<PublishResult>;
+    /**
+     * Subscribes to a given topic.
+     */
+    subscribe(topic: string): void;
+    /**
+     * Unsubscribe from the given topic
+     */
+    unsubscribe(topic: string): void;
+    /**
+     * Get the list of topics which the peer is subscribed to.
+     */
+    getTopics(): string[];
+    getPeers(): PeerId[];
+}
+//# sourceMappingURL=floodsub.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"floodsub.d.ts","sourceRoot":"","sources":["../../src/floodsub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAC1I,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,KAAK,MAAM,SAAS,CAAA;AAE3B,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,EAAE,WAAW,EAAkC,MAAM,mBAAmB,CAAA;AAG/E,OAAO,EAAY,YAAY,EAAwB,UAAU,EAAE,MAAM,YAAY,CAAA;AACrF,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,IAAI,iBAAiB,EAAE,OAAO,EAAE,aAAa,EAA0B,gBAAgB,EAAE,MAAM,YAAY,CAAA;AACnL,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAY,MAAM,mBAAmB,CAAA;AACrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAEpD,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;;;GAGG;AACH,qBAAa,QAAS,SAAQ,iBAAiB,CAAC,cAAc,CAAE,YAAW,iBAAiB;IAC1F,SAAS,CAAC,GAAG,EAAE,MAAM,CAAA;IAEd,OAAO,EAAE,OAAO,CAAA;IACvB;;OAEG;IACI,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACnC;;OAEG;IACI,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjC;;OAEG;IACI,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAClC;;OAEG;IACI,qBAAqB,EAAE,OAAO,YAAY,GAAG,OAAO,UAAU,CAAA;IACrE;;OAEG;IACI,eAAe,EAAE,OAAO,CAAA;IAC/B;;OAEG;IACI,QAAQ,EAAE,OAAO,CAAA;IACxB;;;;;OAKG;IACI,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAC9C,KAAK,EAAE,KAAK,CAAA;IACZ,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,UAAU,EAAE,kBAAkB,CAAA;IAErC,OAAO,CAAC,qBAAqB,CAAsB;IACnD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAQ;IAC1C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAQ;IACpC,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,CAAA;gBAE7B,UAAU,EAAE,kBAAkB,EAAE,IAAI,EAAE,YAAY;IA4B/D,QAAQ,CAAC,CAAC,YAAY,CAAC,QAAO;IAE9B,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,sBAAqB;IAElD,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAEvC;IAED,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAEvC;IAID;;OAEG;IACG,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;IA6B7B;;OAEG;IACG,IAAI,IAAK,OAAO,CAAC,IAAI,CAAC;IA6B5B,SAAS,IAAK,OAAO;IAIrB;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;IAe1E;;OAEG;cACa,gBAAgB,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBlF;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI;IAKvE;;OAEG;IACH,OAAO,CAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,WAAW;IAwBvD;;OAEG;IACH,SAAS,CAAC,WAAW,CAAE,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAuB/D;;OAEG;IACG,eAAe,CAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IA6CtH;;OAEG;IACG,UAAU,CAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAoD3F;;OAEG;IACH,gBAAgB,CAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,GAAG,IAAI;IAsBlE;;OAEG;IACG,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAoChE;;;OAGG;IACH,QAAQ,CAAE,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU;IAwBzD;;;OAGG;IACH,UAAU,CAAE,EAAE,EAAE,MAAM,GAAG,OAAO;IAIhC;;;OAGG;IACH,SAAS,CAAE,KAAK,EAAE,UAAU,GAAG,cAAc,GAAG,SAAS;IAIzD;;;OAGG;IACH,SAAS,CAAE,GAAG,EAAE,SAAS,GAAG,UAAU;IAItC;;;OAGG;IACH,aAAa,CAAE,GAAG,EAAE,gBAAgB,GAAG,UAAU;IAIjD;;OAEG;IACH,IAAI,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI;IASxG;;OAEG;IACH,OAAO,CAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,GAAG,IAAI;IAkB5C;;;OAGG;IACG,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAsD9D;;;OAGG;IACG,YAAY,CAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,UAAU,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBzH;;OAEG;IACH,cAAc,CAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE;IAkBxC;;OAEG;IACG,OAAO,CAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;IAqCxE;;;;;;OAMG;IACG,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IA6B7E;;OAEG;IACH,SAAS,CAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAgB/B;;OAEG;IACH,WAAW,CAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAkBjC;;OAEG;IACH,SAAS,IAAK,MAAM,EAAE;IAQtB,QAAQ,IAAK,MAAM,EAAE;CAOtB"}