@libp2p/gossipsub 14.1.1-6059227cb

package/dist/src/utils/publishConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publishConfig.js","sourceRoot":"","sources":["../../../src/utils/publishConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAI/C;;GAEG;AACH,MAAM,UAAU,0BAA0B,CACxC,eAAwD,EACxD,MAAc,EACd,UAAsB;IAEtB,QAAQ,eAAe,EAAE,CAAC;QACxB,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,OAAO;gBACL,IAAI,EAAE,iBAAiB,CAAC,OAAO;gBAC/B,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC;gBAC9C,UAAU;aACX,CAAA;QACH,CAAC;QAED,KAAK,YAAY;YACf,OAAO;gBACL,IAAI,EAAE,iBAAiB,CAAC,SAAS;aAClC,CAAA;QAEH;YACE,MAAM,IAAI,KAAK,CAAC,6BAA6B,eAAe,GAAG,CAAC,CAAA;IACpE,CAAC;AACH,CAAC"}

package/dist/src/utils/set.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Exclude up to `ineed` items from a set if item meets condition `cond`
+ */
+export declare function removeItemsFromSet<T>(superSet: Set<T>, ineed: number, cond?: (peer: T) => boolean): Set<T>;
+/**
+ * Exclude up to `ineed` items from a set
+ */
+export declare function removeFirstNItemsFromSet<T>(superSet: Set<T>, ineed: number): Set<T>;
+export declare class MapDef<K, V> extends Map<K, V> {
+    private readonly getDefault;
+    constructor(getDefault: () => V);
+    getOrDefault(key: K): V;
+}
+//# sourceMappingURL=set.d.ts.map

package/dist/src/utils/set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../../../src/utils/set.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAChB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAoB,GACtC,GAAG,CAAC,CAAC,CAAC,CAaR;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,EAAG,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAEpF;AAED,qBAAa,MAAM,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,MAAM,CAAC;IAIjD,YAAY,CAAE,GAAG,EAAE,CAAC,GAAG,CAAC;CAQzB"}

package/dist/src/utils/set.js

@@ -0,0 +1,41 @@
+/**
+ * Exclude up to `ineed` items from a set if item meets condition `cond`
+ */
+export function removeItemsFromSet(superSet, ineed, cond = () => true) {
+    const subset = new Set();
+    if (ineed <= 0) {
+        return subset;
+    }
+    for (const id of superSet) {
+        if (subset.size >= ineed) {
+            break;
+        }
+        if (cond(id)) {
+            subset.add(id);
+            superSet.delete(id);
+        }
+    }
+    return subset;
+}
+/**
+ * Exclude up to `ineed` items from a set
+ */
+export function removeFirstNItemsFromSet(superSet, ineed) {
+    return removeItemsFromSet(superSet, ineed, () => true);
+}
+export class MapDef extends Map {
+    getDefault;
+    constructor(getDefault) {
+        super();
+        this.getDefault = getDefault;
+    }
+    getOrDefault(key) {
+        let value = super.get(key);
+        if (value === undefined) {
+            value = this.getDefault();
+            this.set(key, value);
+        }
+        return value;
+    }
+}
+//# sourceMappingURL=set.js.map

package/dist/src/utils/set.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set.js","sourceRoot":"","sources":["../../../src/utils/set.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,QAAgB,EAChB,KAAa,EACb,OAA6B,GAAG,EAAE,CAAC,IAAI;IAEvC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAK,CAAA;IAC3B,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAAC,OAAO,MAAM,CAAA;IAAC,CAAC;IAEjC,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE,CAAC;QAC1B,IAAI,MAAM,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC;YAAC,MAAK;QAAC,CAAC;QACnC,IAAI,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACd,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QACrB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAK,QAAgB,EAAE,KAAa;IAC1E,OAAO,kBAAkB,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;AACxD,CAAC;AAED,MAAM,OAAO,MAAa,SAAQ,GAAS;IACX;IAA9B,YAA8B,UAAmB;QAC/C,KAAK,EAAE,CAAA;QADqB,eAAU,GAAV,UAAU,CAAS;IAEjD,CAAC;IAED,YAAY,CAAE,GAAM;QAClB,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAC1B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,KAAK,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;YACzB,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACtB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CACF"}

package/dist/src/utils/shuffle.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Pseudo-randomly shuffles an array
+ *
+ * Mutates the input array
+ */
+export declare function shuffle<T>(arr: T[]): T[];
+//# sourceMappingURL=shuffle.d.ts.map

package/dist/src/utils/shuffle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shuffle.d.ts","sourceRoot":"","sources":["../../../src/utils/shuffle.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAG,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAezC"}

package/dist/src/utils/shuffle.js

@@ -0,0 +1,21 @@
+/**
+ * Pseudo-randomly shuffles an array
+ *
+ * Mutates the input array
+ */
+export function shuffle(arr) {
+    if (arr.length <= 1) {
+        return arr;
+    }
+    const randInt = () => {
+        return Math.floor(Math.random() * Math.floor(arr.length));
+    };
+    for (let i = 0; i < arr.length; i++) {
+        const j = randInt();
+        const tmp = arr[i];
+        arr[i] = arr[j];
+        arr[j] = tmp;
+    }
+    return arr;
+}
+//# sourceMappingURL=shuffle.js.map

package/dist/src/utils/shuffle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shuffle.js","sourceRoot":"","sources":["../../../src/utils/shuffle.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAK,GAAQ;IAClC,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,MAAM,OAAO,GAAG,GAAW,EAAE;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAA;IAC3D,CAAC,CAAA;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,OAAO,EAAE,CAAA;QACnB,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAA;QAClB,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAA;QACf,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAA;IACd,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC"}

package/dist/src/utils/time-cache.d.ts

@@ -0,0 +1,22 @@
+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 readonly entries;
+    private readonly validityMs;
+    constructor(opts: SimpleTimeCacheOpts);
+    get size(): number;
+    /** Returns true if there was a key collision and the entry is dropped */
+    put(key: string | number, value: T): boolean;
+    prune(): void;
+    has(key: string): boolean;
+    get(key: string | number): T | undefined;
+    clear(): void;
+}
+export {};
+//# sourceMappingURL=time-cache.d.ts.map

package/dist/src/utils/time-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"time-cache.d.ts","sourceRoot":"","sources":["../../../src/utils/time-cache.ts"],"names":[],"mappings":"AAAA,UAAU,mBAAmB;IAC3B,UAAU,EAAE,MAAM,CAAA;CACnB;AAOD;;;;GAIG;AACH,qBAAa,eAAe,CAAC,CAAC;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA4C;IACpE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;gBAEtB,IAAI,EAAE,mBAAmB;IAOtC,IAAI,IAAI,IAAK,MAAM,CAElB;IAED,yEAAyE;IACzE,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO;IAc7C,KAAK,IAAK,IAAI;IAcd,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;IAI1B,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,GAAG,SAAS;IAKzC,KAAK,IAAK,IAAI;CAGf"}

package/dist/src/utils/time-cache.js

@@ -0,0 +1,54 @@
+/**
+ * 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 {
+    entries = new Map();
+    validityMs;
+    constructor(opts) {
+        this.validityMs = opts.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
+    }
+    get size() {
+        return this.entries.size;
+    }
+    /** Returns true if there was a key collision and the entry is dropped */
+    put(key, value) {
+        if (this.entries.has(key)) {
+            // Key collisions break insertion order in the entries cache, which break prune logic.
+            // prune relies on each iterated entry to have strictly ascending validUntilMs, else it
+            // won't prune expired entries and SimpleTimeCache will grow unexpectedly.
+            // As of Oct 2022 NodeJS v16, inserting the same key twice with different value does not
+            // change the key position in the iterator stream. A unit test asserts this behaviour.
+            return true;
+        }
+        this.entries.set(key, { value, validUntilMs: Date.now() + this.validityMs });
+        return false;
+    }
+    prune() {
+        const now = Date.now();
+        for (const [k, v] of this.entries.entries()) {
+            if (v.validUntilMs < now) {
+                this.entries.delete(k);
+            }
+            else {
+                // Entries are inserted with strictly ascending validUntilMs.
+                // Stop early to save iterations
+                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.clear();
+    }
+}
+//# sourceMappingURL=time-cache.js.map

package/dist/src/utils/time-cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"time-cache.js","sourceRoot":"","sources":["../../../src/utils/time-cache.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,MAAM,OAAO,eAAe;IACT,OAAO,GAAG,IAAI,GAAG,EAAkC,CAAA;IACnD,UAAU,CAAQ;IAEnC,YAAa,IAAyB;QACpC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;QAEjC,+FAA+F;QAC/F,uGAAuG;IACzG,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAA;IAC1B,CAAC;IAED,yEAAyE;IACzE,GAAG,CAAE,GAAoB,EAAE,KAAQ;QACjC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,sFAAsF;YACtF,uFAAuF;YACvF,0EAA0E;YAC1E,wFAAwF;YACxF,sFAAsF;YACtF,OAAO,IAAI,CAAA;QACb,CAAC;QAED,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,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QAEtB,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5C,IAAI,CAAC,CAAC,YAAY,GAAG,GAAG,EAAE,CAAC;gBACzB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;YACxB,CAAC;iBAAM,CAAC;gBACN,6DAA6D;gBAC7D,gCAAgC;gBAChC,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAED,GAAG,CAAE,GAAW;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,GAAG,CAAE,GAAoB;QACvB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACnC,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IACtF,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;CACF"}

package/package.json

@@ -0,0 +1,142 @@
+{
+  "name": "@libp2p/gossipsub",
+  "version": "14.1.1-6059227cb",
+  "description": "A typescript implementation of gossipsub",
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "type": "module",
+  "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    },
+    "./metrics": {
+      "types": "./dist/src/metrics.d.ts",
+      "import": "./dist/src/metrics.js"
+    },
+    "./message": {
+      "types": "./dist/src/message/index.d.ts",
+      "import": "./dist/src/message/index.js"
+    },
+    "./score": {
+      "types": "./dist/src/score/index.d.ts",
+      "import": "./dist/src/score/index.js"
+    },
+    "./types": {
+      "types": "./dist/src/types.d.ts",
+      "import": "./dist/src/types.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
+  "scripts": {
+    "lint": "aegir lint",
+    "release": "aegir release --no-types",
+    "build": "aegir build",
+    "generate": "protons ./src/message/rpc.proto",
+    "pretest": "npm run build",
+    "pretest:e2e": "npm run build",
+    "benchmark": "yarn benchmark:files 'test/benchmark/**/*.test.ts'",
+    "benchmark:files": "NODE_OPTIONS='--max-old-space-size=4096 --loader=ts-node/esm' benchmark --config .benchrc.yaml --defaultBranch master",
+    "test": "aegir test -f './dist/test/*.spec.js'",
+    "test:unit": "aegir test -f './dist/test/unit/*.test.js' --target node",
+    "test:e2e": "aegir test -f './dist/test/e2e/*.spec.js'",
+    "test:browser": "npm run test -- --target browser"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ChainSafe/js-libp2p-gossipsub.git"
+  },
+  "keywords": [
+    "libp2p",
+    "pubsub",
+    "gossip"
+  ],
+  "author": "Cayman Nava",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/ChainSafe/js-libp2p-gossipsub/issues"
+  },
+  "homepage": "https://github.com/ChainSafe/js-libp2p-gossipsub#readme",
+  "dependencies": {
+    "@libp2p/crypto": "5.1.8-6059227cb",
+    "@libp2p/interface": "2.11.0-6059227cb",
+    "@libp2p/interface-internal": "2.3.19-6059227cb",
+    "@libp2p/peer-id": "5.1.9-6059227cb",
+    "@libp2p/pubsub": "^10.0.0",
+    "@multiformats/multiaddr": "^13.0.1",
+    "denque": "^2.1.0",
+    "it-length-prefixed": "^10.0.1",
+    "it-pipe": "^3.0.1",
+    "it-pushable": "^3.2.3",
+    "multiformats": "^13.0.1",
+    "protons-runtime": "^5.5.0",
+    "uint8arraylist": "^2.4.8",
+    "uint8arrays": "^5.0.1"
+  },
+  "devDependencies": {
+    "@chainsafe/as-sha256": "^1.2.0",
+    "@dapplion/benchmark": "^1.0.0",
+    "@libp2p/floodsub": "10.1.46-6059227cb",
+    "@libp2p/interface-compliance-tests": "6.5.0-6059227cb",
+    "@libp2p/logger": "5.2.0-6059227cb",
+    "@libp2p/peer-store": "11.2.7-6059227cb",
+    "@types/node": "^22.18.1",
+    "@types/sinon": "^17.0.3",
+    "abortable-iterator": "^5.1.0",
+    "aegir": "^47.0.21",
+    "datastore-core": "^10.0.0",
+    "delay": "^6.0.0",
+    "it-all": "^3.0.6",
+    "mkdirp": "^3.0.1",
+    "p-defer": "^4.0.0",
+    "p-event": "^6.0.0",
+    "p-retry": "^7.0.0",
+    "p-wait-for": "^5.0.2",
+    "protons": "^7.5.0",
+    "sinon": "^21.0.0",
+    "sinon-ts": "^2.0.0",
+    "time-cache": "^0.3.0"
+  },
+  "engines": {
+    "npm": ">=8.7.0"
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "ignorePatterns": [
+      "src/message/rpc*",
+      "!.aegir.js"
+    ]
+  },
+  "contributors": [
+    "Cayman <caymannava@gmail.com>",
+    "Vasco Santos <vasco.santos@moxy.studio>",
+    "Mikerah <mikerahqc@protonmail.com>",
+    "Tuyen Nguyen <vutuyen2636@gmail.com>",
+    "Alex Potsides <alex@achingbrain.net>",
+    "Marin Petrunić <marin.petrunic@gmail.com>",
+    "Lion - dapplion <35266934+dapplion@users.noreply.github.com>",
+    "Gregory Markou <16929357+GregTheGreek@users.noreply.github.com>",
+    "Alan Shaw <alan.shaw@protocol.ai>",
+    "Tuyen <tuyen@wetrust.io>",
+    "Jacob Heun <jacobheun@gmail.com>",
+    "Patrick Michot <k0m0d0tr0n@gmail.com>",
+    "chainsafe <aidan@chainsafe.io>",
+    "Hugo Dias <hugomrdias@gmail.com>",
+    "Franck Royer <franck@royer.one>",
+    "ChainSafe <superadmin@chainsafe.io>"
+  ],
+  "sideEffects": false
+}

package/src/config.ts

@@ -0,0 +1,31 @@
+export interface GossipsubOptsSpec {
+  /** D sets the optimal degree for a Gossipsub topic mesh. */
+  D: number
+  /** Dlo sets the lower bound on the number of peers we keep in a Gossipsub topic mesh. */
+  Dlo: number
+  /** Dhi sets the upper bound on the number of peers we keep in a Gossipsub topic mesh. */
+  Dhi: number
+  /** Dscore affects how peers are selected when pruning a mesh due to over subscription. */
+  Dscore: number
+  /** Dout sets the quota for the number of outbound connections to maintain in a topic mesh. */
+  Dout: number
+  /**
+   * Dlazy affects the minimum number of peers we will emit gossip to at each
+   * heartbeat.
+   */
+  Dlazy: number
+  /** heartbeatInterval is the time between heartbeats in milliseconds */
+  heartbeatInterval: number
+  /**
+   * fanoutTTL controls how long we keep track of the fanout state. If it's been
+   * fanoutTTL milliseconds since we've published to a topic that we're not subscribed to,
+   * we'll delete the fanout map for that topic.
+   */
+  fanoutTTL: number
+  /** mcacheLength is the number of windows to retain full messages for IWANT responses */
+  mcacheLength: number
+  /** mcacheGossip is the number of windows to gossip about */
+  mcacheGossip: number
+  /** seenTTL is the number of milliseconds to retain message IDs in the seen cache */
+  seenTTL: number
+}

package/src/constants.ts

@@ -0,0 +1,261 @@
+export const second = 1000
+export const minute = 60 * second
+
+// Protocol identifiers
+
+export const FloodsubID = '/floodsub/1.0.0'
+
+/**
+ * The protocol ID for version 1.0.0 of the Gossipsub protocol
+ * It is advertised along with GossipsubIDv11 for backwards compatability
+ */
+export const GossipsubIDv10 = '/meshsub/1.0.0'
+
+/**
+ * The protocol ID for version 1.1.0 of the Gossipsub protocol
+ * See the spec for details about how v1.1.0 compares to v1.0.0:
+ * https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md
+ */
+export const GossipsubIDv11 = '/meshsub/1.1.0'
+
+/**
+ * The protocol ID for version 1.2.0 of the Gossipsub protocol
+ * See the spec for details about how v1.2.0 compares to v1.1.0:
+ * https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.2.md
+ */
+export const GossipsubIDv12 = '/meshsub/1.2.0'
+
+// Overlay parameters
+
+/**
+ * GossipsubD sets the optimal degree for a Gossipsub topic mesh. For example, if GossipsubD == 6,
+ * each peer will want to have about six peers in their mesh for each topic they're subscribed to.
+ * GossipsubD should be set somewhere between GossipsubDlo and GossipsubDhi.
+ */
+export const GossipsubD = 6
+
+/**
+ * GossipsubDlo sets the lower bound on the number of peers we keep in a Gossipsub topic mesh.
+ * If we have fewer than GossipsubDlo peers, we will attempt to graft some more into the mesh at
+ * the next heartbeat.
+ */
+export const GossipsubDlo = 4
+
+/**
+ * GossipsubDhi sets the upper bound on the number of peers we keep in a Gossipsub topic mesh.
+ * If we have more than GossipsubDhi peers, we will select some to prune from the mesh at the next heartbeat.
+ */
+export const GossipsubDhi = 12
+
+/**
+ * GossipsubDscore affects how peers are selected when pruning a mesh due to over subscription.
+ * At least GossipsubDscore of the retained peers will be high-scoring, while the remainder are
+ * chosen randomly.
+ */
+export const GossipsubDscore = 4
+
+/**
+ * GossipsubDout sets the quota for the number of outbound connections to maintain in a topic mesh.
+ * When the mesh is pruned due to over subscription, we make sure that we have outbound connections
+ * to at least GossipsubDout of the survivor peers. This prevents sybil attackers from overwhelming
+ * our mesh with incoming connections.
+ *
+ * GossipsubDout must be set below GossipsubDlo, and must not exceed GossipsubD / 2.
+ */
+export const GossipsubDout = 2
+
+// Gossip parameters
+
+/**
+ * GossipsubHistoryLength controls the size of the message cache used for gossip.
+ * The message cache will remember messages for GossipsubHistoryLength heartbeats.
+ */
+export const GossipsubHistoryLength = 5
+
+/**
+ * GossipsubHistoryGossip controls how many cached message ids we will advertise in
+ * IHAVE gossip messages. When asked for our seen message IDs, we will return
+ * only those from the most recent GossipsubHistoryGossip heartbeats. The slack between
+ * GossipsubHistoryGossip and GossipsubHistoryLength allows us to avoid advertising messages
+ * that will be expired by the time they're requested.
+ *
+ * GossipsubHistoryGossip must be less than or equal to GossipsubHistoryLength to
+ * avoid a runtime panic.
+ */
+export const GossipsubHistoryGossip = 3
+
+/**
+ * GossipsubDlazy affects how many peers we will emit gossip to at each heartbeat.
+ * We will send gossip to at least GossipsubDlazy peers outside our mesh. The actual
+ * number may be more, depending on GossipsubGossipFactor and how many peers we're
+ * connected to.
+ */
+export const GossipsubDlazy = 6
+
+/**
+ * GossipsubGossipFactor affects how many peers we will emit gossip to at each heartbeat.
+ * We will send gossip to GossipsubGossipFactor * (total number of non-mesh peers), or
+ * GossipsubDlazy, whichever is greater.
+ */
+export const GossipsubGossipFactor = 0.25
+
+/**
+ * GossipsubGossipRetransmission controls how many times we will allow a peer to request
+ * the same message id through IWANT gossip before we start ignoring them. This is designed
+ * to prevent peers from spamming us with requests and wasting our resources.
+ */
+export const GossipsubGossipRetransmission = 3
+
+// Heartbeat interval
+
+/**
+ * GossipsubHeartbeatInitialDelay is the short delay before the heartbeat timer begins
+ * after the router is initialized.
+ */
+export const GossipsubHeartbeatInitialDelay = 100
+
+/**
+ * GossipsubHeartbeatInterval controls the time between heartbeats.
+ */
+export const GossipsubHeartbeatInterval = second
+
+/**
+ * GossipsubFanoutTTL controls how long we keep track of the fanout state. If it's been
+ * GossipsubFanoutTTL since we've published to a topic that we're not subscribed to,
+ * we'll delete the fanout map for that topic.
+ */
+export const GossipsubFanoutTTL = minute
+
+/**
+ * GossipsubPrunePeers controls the number of peers to include in prune Peer eXchange.
+ * When we prune a peer that's eligible for PX (has a good score, etc), we will try to
+ * send them signed peer records for up to GossipsubPrunePeers other peers that we
+ * know of.
+ */
+export const GossipsubPrunePeers = 16
+
+/**
+ * GossipsubPruneBackoff controls the backoff time for pruned peers. This is how long
+ * a peer must wait before attempting to graft into our mesh again after being pruned.
+ * When pruning a peer, we send them our value of GossipsubPruneBackoff so they know
+ * the minimum time to wait. Peers running older versions may not send a backoff time,
+ * so if we receive a prune message without one, we will wait at least GossipsubPruneBackoff
+ * before attempting to re-graft.
+ */
+export const GossipsubPruneBackoff = minute
+
+/**
+ * Backoff to use when unsuscribing from a topic. Should not resubscribe to this topic before it expired.
+ */
+export const GossipsubUnsubscribeBackoff = 10 * second
+
+/**
+ * GossipsubPruneBackoffTicks is the number of heartbeat ticks for attempting to prune expired
+ * backoff timers.
+ */
+export const GossipsubPruneBackoffTicks = 15
+
+/**
+ * GossipsubConnectors controls the number of active connection attempts for peers obtained through PX.
+ */
+export const GossipsubConnectors = 8
+
+/**
+ * GossipsubMaxPendingConnections sets the maximum number of pending connections for peers attempted through px.
+ */
+export const GossipsubMaxPendingConnections = 128
+
+/**
+ * GossipsubConnectionTimeout controls the timeout for connection attempts.
+ */
+export const GossipsubConnectionTimeout = 30 * second
+
+/**
+ * GossipsubDirectConnectTicks is the number of heartbeat ticks for attempting to reconnect direct peers
+ * that are not currently connected.
+ */
+export const GossipsubDirectConnectTicks = 300
+
+/**
+ * GossipsubDirectConnectInitialDelay is the initial delay before opening connections to direct peers
+ */
+export const GossipsubDirectConnectInitialDelay = second
+
+/**
+ * GossipsubOpportunisticGraftTicks is the number of heartbeat ticks for attempting to improve the mesh
+ * with opportunistic grafting. Every GossipsubOpportunisticGraftTicks we will attempt to select some
+ * high-scoring mesh peers to replace lower-scoring ones, if the median score of our mesh peers falls
+ * below a threshold
+ */
+export const GossipsubOpportunisticGraftTicks = 60
+
+/**
+ * GossipsubOpportunisticGraftPeers is the number of peers to opportunistically graft.
+ */
+export const GossipsubOpportunisticGraftPeers = 2
+
+/**
+ * If a GRAFT comes before GossipsubGraftFloodThreshold has elapsed since the last PRUNE,
+ * then there is an extra score penalty applied to the peer through P7.
+ */
+export const GossipsubGraftFloodThreshold = 10 * second
+
+/**
+ * GossipsubMaxIHaveLength is the maximum number of messages to include in an IHAVE message.
+ * Also controls the maximum number of IHAVE ids we will accept and request with IWANT from a
+ * peer within a heartbeat, to protect from IHAVE floods. You should adjust this value from the
+ * default if your system is pushing more than 5000 messages in GossipsubHistoryGossip heartbeats;
+ * with the defaults this is 1666 messages/s.
+ */
+export const GossipsubMaxIHaveLength = 5000
+
+/**
+ * GossipsubMaxIHaveMessages is the maximum number of IHAVE messages to accept from a peer within a heartbeat.
+ */
+export const GossipsubMaxIHaveMessages = 10
+
+/**
+ * Time to wait for a message requested through IWANT following an IHAVE advertisement.
+ * If the message is not received within this window, a broken promise is declared and
+ * the router may apply bahavioural penalties.
+ */
+export const GossipsubIWantFollowupTime = 3 * second
+
+/**
+ * Time in milliseconds to keep message ids in the seen cache
+ */
+export const GossipsubSeenTTL = 2 * minute
+
+export const TimeCacheDuration = 120 * 1000
+
+export const ERR_TOPIC_VALIDATOR_REJECT = 'ERR_TOPIC_VALIDATOR_REJECT'
+export const ERR_TOPIC_VALIDATOR_IGNORE = 'ERR_TOPIC_VALIDATOR_IGNORE'
+
+/**
+ * If peer score is better than this, we accept messages from this peer
+ * within ACCEPT_FROM_WHITELIST_DURATION_MS from the last time computing score.
+ */
+export const ACCEPT_FROM_WHITELIST_THRESHOLD_SCORE = 0
+
+/**
+ * If peer score >= ACCEPT_FROM_WHITELIST_THRESHOLD_SCORE, accept up to this
+ * number of messages from that peer.
+ */
+export const ACCEPT_FROM_WHITELIST_MAX_MESSAGES = 128
+
+/**
+ * If peer score >= ACCEPT_FROM_WHITELIST_THRESHOLD_SCORE, accept messages from
+ * this peer up to this time duration.
+ */
+export const ACCEPT_FROM_WHITELIST_DURATION_MS = 1000
+
+/**
+ * The default MeshMessageDeliveriesWindow to be used in metrics.
+ */
+export const DEFAULT_METRIC_MESH_MESSAGE_DELIVERIES_WINDOWS = 1000
+
+/** Wait for 1 more heartbeats before clearing a backoff */
+export const BACKOFF_SLACK = 1
+
+export const GossipsubIdontwantMinDataSize = 512
+export const GossipsubIdontwantMaxMessages = 512

package/src/errors.ts

@@ -0,0 +1,17 @@
+export class InvalidPeerScoreParamsError extends Error {
+  static name = 'InvalidPeerScoreParamsError'
+
+  constructor (message = 'Invalid peer score params') {
+    super(message)
+    this.name = 'InvalidPeerScoreParamsError'
+  }
+}
+
+export class InvalidPeerScoreThresholdsError extends Error {
+  static name = 'InvalidPeerScoreThresholdsError'
+
+  constructor (message = 'Invalid peer score thresholds') {
+    super(message)
+    this.name = 'InvalidPeerScoreThresholdsError'
+  }
+}