@libp2p/pubsub 0.0.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,35 @@
+# libp2p-pubsub <!-- omit in toc -->
+
+> Contains an implementation of the [Pubsub](https://github.com/libp2p/js-libp2p-interfaces/blob/master/packages/libp2p-interfaces/src/pubsub/index.ts) interface
+
+## Table of contents <!-- omit in toc -->
+
+- [Usage](#usage)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Usage
+
+```console
+npm i libp2p-pubsub
+```
+
+```javascript
+import { PubsubBaseProtocol } from '@libp2p/pubsub'
+
+class MyPubsubImplementation extends PubsubBaseProtocol {
+  // .. extra methods here
+}
+```
+
+## Contribute
+
+The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:
+
+ - Go through the modules and **check out existing issues**. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
+ - **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
+ - **Add tests**. There can never be enough tests.
+
+## License
+
+[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) © Protocol Labs

package/dist/src/errors.d.ts

@@ -0,0 +1,39 @@
+export declare const codes: {
+    /**
+     * Signature policy is invalid
+     */
+    ERR_INVALID_SIGNATURE_POLICY: string;
+    /**
+     * Signature policy is unhandled
+     */
+    ERR_UNHANDLED_SIGNATURE_POLICY: string;
+    /**
+     * Message expected to have a `signature`, but doesn't
+     */
+    ERR_MISSING_SIGNATURE: string;
+    /**
+     * Message expected to have a `seqno`, but doesn't
+     */
+    ERR_MISSING_SEQNO: string;
+    /**
+     * Message `signature` is invalid
+     */
+    ERR_INVALID_SIGNATURE: string;
+    /**
+     * Message expected to not have a `from`, but does
+     */
+    ERR_UNEXPECTED_FROM: string;
+    /**
+     * Message expected to not have a `signature`, but does
+     */
+    ERR_UNEXPECTED_SIGNATURE: string;
+    /**
+     * Message expected to not have a `key`, but does
+     */
+    ERR_UNEXPECTED_KEY: string;
+    /**
+     * Message expected to not have a `seqno`, but does
+     */
+    ERR_UNEXPECTED_SEQNO: string;
+};
+//# sourceMappingURL=errors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,KAAK;IAChB;;OAEG;;IAEH;;OAEG;;IAKH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAKH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEJ,CAAA"}

package/dist/src/errors.js

@@ -0,0 +1,41 @@
+export const codes = {
+    /**
+     * Signature policy is invalid
+     */
+    ERR_INVALID_SIGNATURE_POLICY: 'ERR_INVALID_SIGNATURE_POLICY',
+    /**
+     * Signature policy is unhandled
+     */
+    ERR_UNHANDLED_SIGNATURE_POLICY: 'ERR_UNHANDLED_SIGNATURE_POLICY',
+    // Strict signing codes
+    /**
+     * Message expected to have a `signature`, but doesn't
+     */
+    ERR_MISSING_SIGNATURE: 'ERR_MISSING_SIGNATURE',
+    /**
+     * Message expected to have a `seqno`, but doesn't
+     */
+    ERR_MISSING_SEQNO: 'ERR_MISSING_SEQNO',
+    /**
+     * Message `signature` is invalid
+     */
+    ERR_INVALID_SIGNATURE: 'ERR_INVALID_SIGNATURE',
+    // Strict no-signing codes
+    /**
+     * Message expected to not have a `from`, but does
+     */
+    ERR_UNEXPECTED_FROM: 'ERR_UNEXPECTED_FROM',
+    /**
+     * Message expected to not have a `signature`, but does
+     */
+    ERR_UNEXPECTED_SIGNATURE: 'ERR_UNEXPECTED_SIGNATURE',
+    /**
+     * Message expected to not have a `key`, but does
+     */
+    ERR_UNEXPECTED_KEY: 'ERR_UNEXPECTED_KEY',
+    /**
+     * Message expected to not have a `seqno`, but does
+     */
+    ERR_UNEXPECTED_SEQNO: 'ERR_UNEXPECTED_SEQNO'
+};
+//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB;;OAEG;IACH,4BAA4B,EAAE,8BAA8B;IAC5D;;OAEG;IACH,8BAA8B,EAAE,gCAAgC;IAEhE,uBAAuB;IAEvB;;OAEG;IACH,qBAAqB,EAAE,uBAAuB;IAC9C;;OAEG;IACH,iBAAiB,EAAE,mBAAmB;IACtC;;OAEG;IACH,qBAAqB,EAAE,uBAAuB;IAE9C,0BAA0B;IAE1B;;OAEG;IACH,mBAAmB,EAAE,qBAAqB;IAC1C;;OAEG;IACH,wBAAwB,EAAE,0BAA0B;IACpD;;OAEG;IACH,kBAAkB,EAAE,oBAAoB;IACxC;;OAEG;IACH,oBAAoB,EAAE,sBAAsB;CAC7C,CAAA"}

package/dist/src/index.d.ts

@@ -0,0 +1,180 @@
+/// <reference types="node" />
+import debug from 'debug';
+import { EventEmitter } from 'events';
+import Queue from 'p-queue';
+import { RPC, IRPC } from './message/rpc.js';
+import { PeerStreams } from './peer-streams.js';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { Registrar, IncomingStreamEvent } from '@libp2p/interfaces/registrar';
+import type { Connection } from '@libp2p/interfaces/connection';
+import type BufferList from 'bl';
+import type { PubSub, Message, StrictNoSign, StrictSign, PubsubOptions } from '@libp2p/interfaces/pubsub';
+import type { Startable } from '@libp2p/interfaces';
+export interface TopicValidator {
+    (topic: string, message: Message): Promise<void>;
+}
+/**
+ * PubsubBaseProtocol handles the peers and connections logic for pubsub routers
+ * and specifies the API that pubsub routers should have.
+ */
+export declare abstract class PubsubBaseProtocol extends EventEmitter implements PubSub, Startable {
+    peerId: PeerId;
+    started: boolean;
+    /**
+     * Map of topics to which peers are subscribed to
+     */
+    topics: Map<string, Set<string>>;
+    /**
+     * List of our subscriptions
+     */
+    subscriptions: Set<string>;
+    /**
+     * Map of peer streams
+     */
+    peers: Map<string, PeerStreams>;
+    /**
+     * The signature policy to follow by default
+     */
+    globalSignaturePolicy: StrictNoSign | 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, TopicValidator>;
+    queue: Queue;
+    registrar: Registrar;
+    protected log: debug.Debugger & {
+        err: debug.Debugger;
+    };
+    protected multicodecs: string[];
+    protected _libp2p: any;
+    private _registrarId;
+    constructor(props: PubsubOptions);
+    /**
+     * Register the pubsub protocol onto the libp2p node.
+     *
+     * @returns {void}
+     */
+    start(): void;
+    /**
+     * Unregister the pubsub protocol and the streams with other peers will be closed.
+     *
+     * @returns {void}
+     */
+    stop(): void;
+    isStarted(): boolean;
+    /**
+     * On an inbound stream opened
+     */
+    protected _onIncomingStream({ protocol, stream, connection }: IncomingStreamEvent): 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
+     */
+    protected _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(idB58Str: string, stream: AsyncIterable<Uint8Array | BufferList>, peerStreams: PeerStreams): Promise<void>;
+    /**
+     * Handles an rpc request from a peer
+     */
+    _processRpc(idB58Str: string, peerStreams: PeerStreams, rpc: RPC): Promise<boolean>;
+    /**
+     * Handles a subscription change from a peer
+     */
+    _processRpcSubOpt(id: string, subOpt: RPC.ISubOpts): void;
+    /**
+     * Handles an message from a peer
+     */
+    _processRpcMessage(msg: Message): Promise<void>;
+    /**
+     * Emit a message from a peer
+     */
+    _emitMessage(message: Message): void;
+    /**
+     * The default msgID implementation
+     * Child class can override this.
+     */
+    getMsgId(msg: Message): import("multiformats/hashes/hasher").Await<Uint8Array>;
+    /**
+     * Whether to accept a message from a peer
+     * Override to create a graylist
+     */
+    _acceptFrom(id: string): boolean;
+    /**
+     * Decode Uint8Array into an RPC object.
+     * This can be override to use a custom router protobuf.
+     */
+    _decodeRpc(bytes: Uint8Array): RPC;
+    /**
+     * Encode RPC object into a Uint8Array.
+     * This can be override to use a custom router protobuf.
+     */
+    _encodeRpc(rpc: IRPC): Uint8Array;
+    /**
+     * Send an rpc object to a peer
+     */
+    _sendRpc(id: string, rpc: IRPC): void;
+    /**
+     * Send subscriptions to a peer
+     */
+    _sendSubscriptions(id: string, topics: string[], subscribe: boolean): void;
+    /**
+     * Validates the given message. The signature will be checked for authenticity.
+     * Throws an error on invalid messages
+     */
+    validate(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.
+     */
+    protected _buildMessage(message: Message): Promise<Message>;
+    /**
+     * Get a list of the peer-ids that are subscribed to one topic.
+     */
+    getSubscribers(topic: string): string[];
+    /**
+     * Publishes messages to all subscribed peers
+     */
+    publish(topic: string, message: Uint8Array): Promise<void>;
+    /**
+     * 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
+     */
+    abstract _publish(message: Message): Promise<void>;
+    /**
+     * 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[];
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAGrC,OAAO,KAAK,MAAM,SAAS,CAAA;AAG3B,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAC5C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAA;AAClF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,UAAU,MAAM,IAAI,CAAA;AAKhC,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AACzG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAEnD,MAAM,WAAW,cAAc;IAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE;AAEpF;;;GAGG;AACH,8BAAsB,kBAAmB,SAAQ,YAAa,YAAW,MAAM,EAAE,SAAS;IACjF,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;IACvB;;OAEG;IACI,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;IACvC;;OAEG;IACI,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjC;;OAEG;IACI,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACtC;;OAEG;IACI,qBAAqB,EAAE,YAAY,GAAG,UAAU,CAAA;IACvD;;OAEG;IACI,eAAe,EAAE,OAAO,CAAA;IAC/B;;OAEG;IACI,QAAQ,EAAE,OAAO,CAAA;IACxB;;;;;OAKG;IACI,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC5C,KAAK,EAAE,KAAK,CAAA;IACZ,SAAS,EAAE,SAAS,CAAA;IAE3B,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,GAAG;QAAE,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAA;KAAE,CAAA;IACvD,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,CAAA;IAC/B,SAAS,CAAC,OAAO,EAAE,GAAG,CAAA;IACtB,OAAO,CAAC,YAAY,CAAoB;gBAE3B,KAAK,EAAE,aAAa;IAsCjC;;;;OAIG;IACH,KAAK;IA0BL;;;;OAIG;IACH,IAAI;IAmBJ,SAAS;IAIT;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,mBAAmB;IAUlF;;OAEG;cACa,gBAAgB,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU;IAgBlE;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,UAAU;IAOhE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAuBpD;;OAEG;IACH,SAAS,CAAC,WAAW,CAAE,MAAM,EAAE,MAAM;IAuBrC;;OAEG;IACG,gBAAgB,CAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,UAAU,GAAC,UAAU,CAAC,EAAE,WAAW,EAAE,WAAW;IAuBhH;;OAEG;IACG,WAAW,CAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG;IAyCvE;;OAEG;IACH,iBAAiB,CAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,QAAQ;IAsBnD;;OAEG;IACG,kBAAkB,CAAE,GAAG,EAAE,OAAO;IAmBtC;;OAEG;IACH,YAAY,CAAE,OAAO,EAAE,OAAO;IAQ9B;;;OAGG;IACH,QAAQ,CAAE,GAAG,EAAE,OAAO;IAatB;;;OAGG;IACH,WAAW,CAAE,EAAE,EAAE,MAAM;IAIvB;;;OAGG;IACH,UAAU,CAAE,KAAK,EAAE,UAAU;IAI7B;;;OAGG;IACH,UAAU,CAAE,GAAG,EAAE,IAAI;IAIrB;;OAEG;IACH,QAAQ,CAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI;IAW/B;;OAEG;IACH,kBAAkB,CAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,OAAO;IAMpE;;;OAGG;IACG,QAAQ,CAAE,OAAO,EAAE,OAAO;IAwChC;;;OAGG;cACa,aAAa,CAAE,OAAO,EAAE,OAAO;IAgB/C;;OAEG;IACH,cAAc,CAAE,KAAK,EAAE,MAAM;IAkB7B;;OAEG;IACG,OAAO,CAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU;IAyBjD;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAE,KAAK,EAAE,MAAM;IAWxB;;OAEG;IACH,WAAW,CAAE,KAAK,EAAE,MAAM;IAW1B;;OAEG;IACH,SAAS;CAOV"}