@libp2p/floodsub 0.29.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,88 @@
+# js-libp2p-floodsub <!-- omit in toc -->
+
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-floodsub/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-floodsub?branch=master)
+[![Build Status](https://github.com/libp2p/js-libp2p-floodsub/actions/workflows/js-test-and-release.yml/badge.svg?branch=main)](https://github.com/libp2p/js-libp2p-floodsub/actions/workflows/js-test-and-release.yml)
+[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-floodsub.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-floodsub) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+[![](https://img.shields.io/badge/pm-waffle-yellow.svg?style=flat-square)](https://waffle.io/libp2p/js-libp2p-floodsub)
+
+> libp2p-floodsub, also known as pubsub-flood or just dumbsub, this implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).
+
+## Table of Contents <!-- omit in toc -->
+
+- [Install](#install)
+- [Usage](#usage)
+- [API](#api)
+  - [Create a floodsub implementation](#create-a-floodsub-implementation)
+- [Events](#events)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Install
+
+```sh
+> npm install @libp2p/floodsub
+```
+
+## Usage
+
+```JavaScript
+import { FloodSub } from '@libp2p/floodsub'
+
+// registrar is provided by libp2p
+const fsub = new FloodSub(peerId, registrar, options)
+
+await fsub.start()
+
+fsub.on('fruit', (data) => {
+  console.log(data)
+})
+fsub.subscribe('fruit')
+
+fsub.publish('fruit', new TextEncoder().encode('banana'))
+```
+
+## API
+
+### Create a floodsub implementation
+
+```js
+const options = {…}
+const floodsub = new Floodsub(peerId, registrar, options)
+```
+
+Options is an optional object with the following key-value pairs:
+
+* **`emitSelf`**: boolean identifying whether the node should emit to self on publish, in the event of the topic being subscribed (defaults to **false**).
+
+For the remaining API, see https://github.com/libp2p/js-libp2p-pubsub
+
+## Events
+
+Floodsub emits two kinds of events:
+1. `<topic>` when a message is received for a particular topic
+  ```Javascript
+    fsub.on('fruit', (data) => { ... })
+  ```
+  - `data`: a Uint8Array containing the data that was published to the topic
+2. `floodsub:subscription-change` when the local peer receives an update to the subscriptions of a remote peer.
+  ```Javascript
+    fsub.on('floodsub:subscription-change', (peerId, topics, changes) => { ... })
+  ```
+  - `peerId`: a [PeerId](https://github.com/libp2p/js-peer-id) object
+  - `topics`: the topics that the peer is now subscribed to
+  - `changes`: an array of `{ topicID: <topic>, subscribe: <boolean> }`
+     eg `[ { topicID: 'fruit', subscribe: true }, { topicID: 'vegetables': false } ]`
+
+## Contribute
+
+Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-pubsub/issues)!
+
+This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+## License
+
+[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) © Protocol Labs

package/dist/src/cache.d.ts

@@ -0,0 +1,21 @@
+interface SimpleTimeCacheOpts {
+    validityMs: number;
+}
+/**
+ * This is similar to https://github.com/daviddias/time-cache/blob/master/src/index.js
+ * for our own need, we don't use lodash throttle to improve performance.
+ * This gives 4x - 5x performance gain compared to npm TimeCache
+ */
+export declare class SimpleTimeCache<T> {
+    private entries;
+    private readonly validityMs;
+    private lastPruneTime;
+    constructor(options: SimpleTimeCacheOpts);
+    put(key: string, value: T): void;
+    prune(): void;
+    has(key: string): boolean;
+    get(key: string): T | undefined;
+    clear(): void;
+}
+export {};
+//# sourceMappingURL=cache.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../src/cache.ts"],"names":[],"mappings":"AAAA,UAAU,mBAAmB;IAC3B,UAAU,EAAE,MAAM,CAAA;CACnB;AAOD;;;;GAIG;AACH,qBAAa,eAAe,CAAC,CAAC;IAC5B,OAAO,CAAC,OAAO,CAA4B;IAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,aAAa,CAAI;gBAEZ,OAAO,EAAE,mBAAmB;IAQzC,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAKjC,KAAK,IAAK,IAAI;IAiBd,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAI1B,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAKhC,KAAK,IAAK,IAAI;CAIf"}

package/dist/src/cache.js

@@ -0,0 +1,46 @@
+/**
+ * This is similar to https://github.com/daviddias/time-cache/blob/master/src/index.js
+ * for our own need, we don't use lodash throttle to improve performance.
+ * This gives 4x - 5x performance gain compared to npm TimeCache
+ */
+export class SimpleTimeCache {
+    constructor(options) {
+        this.lastPruneTime = 0;
+        this.entries = new Map();
+        this.validityMs = options.validityMs;
+        // allow negative validityMs so that this does not cache anything, spec test compliance.spec.js
+        // sends duplicate messages and expect peer to receive all. Application likely uses positive validityMs
+    }
+    put(key, value) {
+        this.entries.set(key, { value, validUntilMs: Date.now() + this.validityMs });
+        this.prune();
+    }
+    prune() {
+        const now = Date.now();
+        if (now - this.lastPruneTime < 200) {
+            return;
+        }
+        this.lastPruneTime = now;
+        for (const [k, v] of this.entries.entries()) {
+            if (v.validUntilMs < now) {
+                this.entries.delete(k);
+            }
+            else {
+                // sort by insertion order
+                break;
+            }
+        }
+    }
+    has(key) {
+        return this.entries.has(key);
+    }
+    get(key) {
+        const value = this.entries.get(key);
+        return (value != null && value.validUntilMs >= Date.now()) ? value.value : undefined;
+    }
+    clear() {
+        this.entries = new Map();
+        this.lastPruneTime = 0;
+    }
+}
+//# sourceMappingURL=cache.js.map

package/dist/src/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/cache.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAK1B,YAAa,OAA4B;QAFjC,kBAAa,GAAG,CAAC,CAAA;QAGvB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;QACxB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QAEpC,+FAA+F;QAC/F,uGAAuG;IACzG,CAAC;IAED,GAAG,CAAE,GAAW,EAAE,KAAQ;QACxB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;QAC5E,IAAI,CAAC,KAAK,EAAE,CAAA;IACd,CAAC;IAED,KAAK;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,IAAI,GAAG,GAAG,IAAI,CAAC,aAAa,GAAG,GAAG,EAAE;YAClC,OAAM;SACP;QACD,IAAI,CAAC,aAAa,GAAG,GAAG,CAAA;QAExB,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE;YAC3C,IAAI,CAAC,CAAC,YAAY,GAAG,GAAG,EAAE;gBACxB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;aACvB;iBAAM;gBACL,0BAA0B;gBAC1B,MAAK;aACN;SACF;IACH,CAAC;IAED,GAAG,CAAE,GAAW;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,GAAG,CAAE,GAAW;QACd,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACnC,OAAO,CAAC,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IACtF,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;QACxB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IACxB,CAAC;CACF"}

package/dist/src/config.d.ts

@@ -0,0 +1,3 @@
+export declare const log: import("@libp2p/logger").Logger;
+export declare const multicodec = "/floodsub/1.0.0";
+//# sourceMappingURL=config.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,GAAG,iCAA4B,CAAA;AAE5C,eAAO,MAAM,UAAU,oBAAoB,CAAA"}

package/dist/src/config.js

@@ -0,0 +1,4 @@
+import { logger } from '@libp2p/logger';
+export const log = logger('libp2p:floodsub');
+export const multicodec = '/floodsub/1.0.0';
+//# sourceMappingURL=config.js.map

package/dist/src/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEvC,MAAM,CAAC,MAAM,GAAG,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAA;AAE5C,MAAM,CAAC,MAAM,UAAU,GAAG,iBAAiB,CAAA"}

package/dist/src/index.d.ts

@@ -0,0 +1,28 @@
+import { PubsubBaseProtocol } from '@libp2p/pubsub';
+import { multicodec } from './config.js';
+import { SimpleTimeCache } from './cache.js';
+import type { PubSub, PubSubEvents, PubSubOptions, Message } from '@libp2p/interfaces/pubsub';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+export { multicodec };
+export interface FloodSubOptions extends PubSubOptions {
+    seenTTL?: number;
+}
+/**
+ * FloodSub (aka dumbsub is an implementation of pubsub focused on
+ * delivering an API for Publish/Subscribe, but with no CastTree Forming
+ * (it just floods the network).
+ */
+export declare class FloodSub<EventMap extends PubSubEvents = PubSubEvents> extends PubsubBaseProtocol<EventMap> implements PubSub<EventMap & PubSubEvents> {
+    seenCache: SimpleTimeCache<boolean>;
+    constructor(options: FloodSubOptions);
+    /**
+     * Process incoming message
+     * Extends base implementation to check router cache.
+     */
+    processMessage(from: PeerId, message: Message): Promise<void>;
+    /**
+     * Publish message created. Forward it to the peers.
+     */
+    publishMessage(from: PeerId, message: Message): Promise<void>;
+}
+//# 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":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAC7F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAIxD,OAAO,EAAE,UAAU,EAAE,CAAA;AAErB,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,qBAAa,QAAQ,CAAE,QAAQ,SAAS,YAAY,GAAG,YAAY,CAAE,SAAQ,kBAAkB,CAAC,QAAQ,CAAE,YAAW,MAAM,CAAC,QAAQ,GAAG,YAAY,CAAC;IAC3I,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,CAAA;gBAE7B,OAAO,EAAE,eAAe;IAkBrC;;;OAGG;IACG,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAcpD;;OAEG;IACG,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAwBrD"}

package/dist/src/index.js

@@ -0,0 +1,66 @@
+import { toString } from 'uint8arrays/to-string';
+import { PubsubBaseProtocol } from '@libp2p/pubsub';
+import { multicodec } from './config.js';
+import { SimpleTimeCache } from './cache.js';
+const debugName = 'libp2p:floodsub';
+export { multicodec };
+/**
+ * FloodSub (aka dumbsub is an implementation of pubsub focused on
+ * delivering an API for Publish/Subscribe, but with no CastTree Forming
+ * (it just floods the network).
+ */
+export class FloodSub extends PubsubBaseProtocol {
+    constructor(options) {
+        super({
+            ...options,
+            debugName: debugName,
+            canRelayMessage: true,
+            multicodecs: [multicodec]
+        });
+        /**
+         * Cache of seen messages
+         *
+         * @type {TimeCache}
+         */
+        this.seenCache = new SimpleTimeCache({
+            validityMs: options.seenTTL ?? 30000
+        });
+    }
+    /**
+     * Process incoming message
+     * Extends base implementation to check router cache.
+     */
+    async processMessage(from, message) {
+        // Check if I've seen the message, if yes, ignore
+        const seqno = await super.getMsgId(message);
+        const msgIdStr = toString(seqno, 'base64');
+        if (this.seenCache.has(msgIdStr)) {
+            return;
+        }
+        this.seenCache.put(msgIdStr, true);
+        await super.processMessage(from, message);
+    }
+    /**
+     * Publish message created. Forward it to the peers.
+     */
+    async publishMessage(from, message) {
+        const peers = this.getSubscribers(message.topic);
+        if (peers == null || peers.length === 0) {
+            this.log('no peers are subscribed to topic %s', message.topic);
+            return;
+        }
+        peers.forEach(id => {
+            if (this.peerId.equals(id)) {
+                this.log('not sending message on topic %s to myself', message.topic);
+                return;
+            }
+            if (id.equals(from)) {
+                this.log('not sending message on topic %s to sender %p', message.topic, id);
+                return;
+            }
+            this.log('publish msgs on topics %s %p', message.topic, id);
+            this.send(id, { messages: [message] });
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAI5C,MAAM,SAAS,GAAG,iBAAiB,CAAA;AAEnC,OAAO,EAAE,UAAU,EAAE,CAAA;AAMrB;;;;GAIG;AACH,MAAM,OAAO,QAAwD,SAAQ,kBAA4B;IAGvG,YAAa,OAAwB;QACnC,KAAK,CAAC;YACJ,GAAG,OAAO;YACV,SAAS,EAAE,SAAS;YACpB,eAAe,EAAE,IAAI;YACrB,WAAW,EAAE,CAAC,UAAU,CAAC;SAC1B,CAAC,CAAA;QAEF;;;;WAIG;QACH,IAAI,CAAC,SAAS,GAAG,IAAI,eAAe,CAAU;YAC5C,UAAU,EAAE,OAAO,CAAC,OAAO,IAAI,KAAK;SACrC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAE,IAAY,EAAE,OAAgB;QAClD,iDAAiD;QACjD,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;QAC3C,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QAE1C,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YAChC,OAAM;SACP;QAED,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;QAElC,MAAM,KAAK,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAC3C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAE,IAAY,EAAE,OAAgB;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAEhD,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACvC,IAAI,CAAC,GAAG,CAAC,qCAAqC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;YAC9D,OAAM;SACP;QAED,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACjB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;gBAC1B,IAAI,CAAC,GAAG,CAAC,2CAA2C,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;gBACpE,OAAM;aACP;YAED,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;gBACnB,IAAI,CAAC,GAAG,CAAC,8CAA8C,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;gBAC3E,OAAM;aACP;YAED,IAAI,CAAC,GAAG,CAAC,8BAA8B,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;YAE3D,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACxC,CAAC,CAAC,CAAA;IACJ,CAAC;CACF"}

package/package.json

@@ -0,0 +1,157 @@
+{
+  "name": "@libp2p/floodsub",
+  "version": "0.29.0",
+  "description": "libp2p-floodsub, also known as pubsub-flood or just dumbsub, this implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/libp2p/js-libp2p-floodsub#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p-floodsub.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p-floodsub/issues"
+  },
+  "keywords": [
+    "IPFS",
+    "flood",
+    "flooding",
+    "gossip",
+    "libp2p",
+    "pubsub"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist/src",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "chore",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "build": "tsc",
+    "pretest": "npm run build",
+    "test": "aegir test -f dist/test",
+    "test:chrome": "npm run test -- -t browser --cov",
+    "test:chrome-webworker": "npm run test -- -t webworker",
+    "test:firefox": "npm run test -- -t browser -- --browser firefox",
+    "test:firefox-webworker": "npm run test -- -t webworker -- --browser firefox",
+    "test:node": "npm run test -- -t node --cov",
+    "test:electron-main": "npm run test -- -t electron-main",
+    "release": "semantic-release"
+  },
+  "dependencies": {
+    "@libp2p/interfaces": "^1.3.6",
+    "@libp2p/logger": "^1.0.3",
+    "@libp2p/pubsub": "^1.2.4",
+    "uint8arrays": "^3.0.0"
+  },
+  "devDependencies": {
+    "@libp2p/interface-compliance-tests": "^1.0.8",
+    "@libp2p/peer-id": "^1.1.3",
+    "@libp2p/peer-id-factory": "^1.0.5",
+    "@multiformats/multiaddr": "^10.1.5",
+    "aegir": "^36.1.1",
+    "multiformats": "^9.4.5",
+    "p-wait-for": "^4.1.0",
+    "sinon": "^13.0.1",
+    "wherearewe": "^1.0.0"
+  }
+}

package/src/cache.ts

@@ -0,0 +1,63 @@
+interface SimpleTimeCacheOpts {
+  validityMs: number
+}
+
+interface CacheValue<T> {
+  value: T
+  validUntilMs: number
+}
+
+/**
+ * This is similar to https://github.com/daviddias/time-cache/blob/master/src/index.js
+ * for our own need, we don't use lodash throttle to improve performance.
+ * This gives 4x - 5x performance gain compared to npm TimeCache
+ */
+export class SimpleTimeCache<T> {
+  private entries: Map<string, CacheValue<T>>
+  private readonly validityMs: number
+  private lastPruneTime = 0
+
+  constructor (options: SimpleTimeCacheOpts) {
+    this.entries = new Map()
+    this.validityMs = options.validityMs
+
+    // allow negative validityMs so that this does not cache anything, spec test compliance.spec.js
+    // sends duplicate messages and expect peer to receive all. Application likely uses positive validityMs
+  }
+
+  put (key: string, value: T): void {
+    this.entries.set(key, { value, validUntilMs: Date.now() + this.validityMs })
+    this.prune()
+  }
+
+  prune (): void {
+    const now = Date.now()
+    if (now - this.lastPruneTime < 200) {
+      return
+    }
+    this.lastPruneTime = now
+
+    for (const [k, v] of this.entries.entries()) {
+      if (v.validUntilMs < now) {
+        this.entries.delete(k)
+      } else {
+        // sort by insertion order
+        break
+      }
+    }
+  }
+
+  has (key: string): boolean {
+    return this.entries.has(key)
+  }
+
+  get (key: string): T | undefined {
+    const value = this.entries.get(key)
+    return (value != null && value.validUntilMs >= Date.now()) ? value.value : undefined
+  }
+
+  clear (): void {
+    this.entries = new Map()
+    this.lastPruneTime = 0
+  }
+}

package/src/config.ts

@@ -0,0 +1,5 @@
+import { logger } from '@libp2p/logger'
+
+export const log = logger('libp2p:floodsub')
+
+export const multicodec = '/floodsub/1.0.0'

package/src/index.ts

@@ -0,0 +1,87 @@
+import { toString } from 'uint8arrays/to-string'
+import { PubsubBaseProtocol } from '@libp2p/pubsub'
+import { multicodec } from './config.js'
+import { SimpleTimeCache } from './cache.js'
+import type { PubSub, PubSubEvents, PubSubOptions, Message } from '@libp2p/interfaces/pubsub'
+import type { PeerId } from '@libp2p/interfaces/peer-id'
+
+const debugName = 'libp2p:floodsub'
+
+export { multicodec }
+
+export interface FloodSubOptions extends PubSubOptions {
+  seenTTL?: number
+}
+
+/**
+ * FloodSub (aka dumbsub is an implementation of pubsub focused on
+ * delivering an API for Publish/Subscribe, but with no CastTree Forming
+ * (it just floods the network).
+ */
+export class FloodSub <EventMap extends PubSubEvents = PubSubEvents> extends PubsubBaseProtocol<EventMap> implements PubSub<EventMap & PubSubEvents> {
+  public seenCache: SimpleTimeCache<boolean>
+
+  constructor (options: FloodSubOptions) {
+    super({
+      ...options,
+      debugName: debugName,
+      canRelayMessage: true,
+      multicodecs: [multicodec]
+    })
+
+    /**
+     * Cache of seen messages
+     *
+     * @type {TimeCache}
+     */
+    this.seenCache = new SimpleTimeCache<boolean>({
+      validityMs: options.seenTTL ?? 30000
+    })
+  }
+
+  /**
+   * Process incoming message
+   * Extends base implementation to check router cache.
+   */
+  async processMessage (from: PeerId, message: Message) {
+    // Check if I've seen the message, if yes, ignore
+    const seqno = await super.getMsgId(message)
+    const msgIdStr = toString(seqno, 'base64')
+
+    if (this.seenCache.has(msgIdStr)) {
+      return
+    }
+
+    this.seenCache.put(msgIdStr, true)
+
+    await super.processMessage(from, message)
+  }
+
+  /**
+   * Publish message created. Forward it to the peers.
+   */
+  async publishMessage (from: PeerId, message: Message) {
+    const peers = this.getSubscribers(message.topic)
+
+    if (peers == null || peers.length === 0) {
+      this.log('no peers are subscribed to topic %s', message.topic)
+      return
+    }
+
+    peers.forEach(id => {
+      if (this.peerId.equals(id)) {
+        this.log('not sending message on topic %s to myself', message.topic)
+        return
+      }
+
+      if (id.equals(from)) {
+        this.log('not sending message on topic %s to sender %p', message.topic, id)
+        return
+      }
+
+      this.log('publish msgs on topics %s %p', message.topic, id)
+
+      this.send(id, { messages: [message] })
+    })
+  }
+}