chore!: rename local-discovery to local-peer-cache-discovery (#1867)

Author: danisharora099

.gitignore

@@ -13,4 +13,4 @@ test-results
 playwright-report
 example
 allure-results
-packages/local-discovery/mock_local_storage
+packages/local-peer-cache-discovery/mock_local_storage

package-lock.json

@@ -12,7 +12,7 @@
     "packages/relay",
     "packages/peer-exchange",
     "packages/dns-discovery",
-    "packages/local-discovery",
+    "packages/local-peer-cache-discovery",
     "packages/message-encryption",
     "packages/sdk",
     "packages/tests",

package.json

@@ -3,7 +3,7 @@ import type { Peer, PeerId, TypedEventEmitter } from "@libp2p/interface";
 export enum Tags {
   BOOTSTRAP = "bootstrap",
   PEER_EXCHANGE = "peer-exchange",
-  LOCAL = "local"
+  LOCAL = "local-peer-cache"
 }
 
 export interface ConnectionManagerOptions {

packages/interfaces/src/connection_manager.ts

@@ -1,7 +1,7 @@
 {
-  "name": "@waku/local-discovery",
+  "name": "@waku/local-peer-cache-discovery",
   "version": "0.0.1",
-  "description": "Local Discovery keeps records of healthy peers in the browser's local storage for quicker bootstrapping.",
+  "description": "Local Peer Cache keeps records of healthy peers in the browser's local storage for quicker bootstrapping.",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
   "exports": {
@@ -12,7 +12,7 @@
   },
   "type": "module",
   "author": "Waku Team",
-  "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/local-discovery#readme",
+  "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/local-peer-cache-discovery#readme",
   "repository": {
     "type": "git",
     "url": "https://github.com/waku-org/js-waku.git"

packages/local-discovery/.eslintrc.cjs packages/local-peer-cache-discovery/.eslintrc.cjs

@@ -18,7 +18,7 @@ import { getWsMultiaddrFromMultiaddrs, Logger } from "@waku/utils";
 
 const log = new Logger("peer-exchange-discovery");
 
-type LocalStorageDiscoveryOptions = {
+type LocalPeerCacheDiscoveryOptions = {
   tagName?: string;
   tagValue?: number;
   tagTTL?: number;
@@ -28,7 +28,7 @@ export const DEFAULT_LOCAL_TAG_NAME = Tags.LOCAL;
 const DEFAULT_LOCAL_TAG_VALUE = 50;
 const DEFAULT_LOCAL_TAG_TTL = 100_000_000;
 
-export class LocalStorageDiscovery
+export class LocalPeerCacheDiscovery
   extends TypedEventEmitter<PeerDiscoveryEvents>
   implements PeerDiscovery, Startable
 {
@@ -37,15 +37,15 @@ export class LocalStorageDiscovery
 
   constructor(
     private readonly components: Libp2pComponents,
-    private readonly options?: LocalStorageDiscoveryOptions
+    private readonly options?: LocalPeerCacheDiscoveryOptions
   ) {
     super();
     this.isStarted = false;
     this.peers = this.getPeersFromLocalStorage();
   }
 
   get [Symbol.toStringTag](): string {
-    return "@waku/local-discovery";
+    return "@waku/local-peer-cache-discovery";
   }
 
   async start(): Promise<void> {
@@ -149,12 +149,12 @@ function isValidStoredPeer(peer: any): peer is LocalStoragePeerInfo {
   );
 }
 
-export function wakuLocalStorageDiscovery(): (
+export function wakuLocalPeerCacheDiscovery(): (
   components: Libp2pComponents,
-  options?: LocalStorageDiscoveryOptions
-) => LocalStorageDiscovery {
+  options?: LocalPeerCacheDiscoveryOptions
+) => LocalPeerCacheDiscovery {
   return (
     components: Libp2pComponents,
-    options?: LocalStorageDiscoveryOptions
-  ) => new LocalStorageDiscovery(components, options);
+    options?: LocalPeerCacheDiscoveryOptions
+  ) => new LocalPeerCacheDiscovery(components, options);
 }

packages/local-discovery/.mocha.reporters.json packages/local-peer-cache-discovery/.mocha.reporters.json

@@ -14,7 +14,7 @@ import { MemoryDatastore } from "datastore-core/memory";
 import { LocalStorage } from "node-localstorage";
 import sinon from "sinon";
 
-import { LocalStorageDiscovery } from "./index.js";
+import { LocalPeerCacheDiscovery } from "./index.js";
 
 chai.use(chaiAsPromised);
 
@@ -63,17 +63,17 @@ describe("Local Storage Discovery", function () {
 
     tests({
       async setup() {
-        return new LocalStorageDiscovery(components);
+        return new LocalPeerCacheDiscovery(components);
       },
       async teardown() {}
     });
   });
 
   describe("Unit Tests", function () {
-    let discovery: LocalStorageDiscovery;
+    let discovery: LocalPeerCacheDiscovery;
 
     beforeEach(async function () {
-      discovery = new LocalStorageDiscovery(components);
+      discovery = new LocalPeerCacheDiscovery(components);
       await setPeersInLocalStorage(mockPeers);
     });
 

packages/local-discovery/.mocharc.cjs packages/local-peer-cache-discovery/.mocharc.cjs

@@ -69,7 +69,7 @@
     "@waku/core": "0.0.26",
     "@waku/dns-discovery": "0.0.20",
     "@waku/interfaces": "0.0.21",
-    "@waku/local-discovery": "^0.0.1",
+    "@waku/local-peer-cache-discovery": "^0.0.1",
     "@waku/peer-exchange": "^0.0.19",
     "@waku/relay": "0.0.9",
     "@waku/utils": "0.0.14",

packages/local-discovery/CHANGELOG.md packages/local-peer-cache-discovery/CHANGELOG.md

@@ -20,7 +20,7 @@ import {
   PubsubTopic,
   type ShardInfo
 } from "@waku/interfaces";
-import { wakuLocalStorageDiscovery } from "@waku/local-discovery";
+import { wakuLocalPeerCacheDiscovery } from "@waku/local-peer-cache-discovery";
 import { wakuPeerExchangeDiscovery } from "@waku/peer-exchange";
 import { RelayCreateOptions, wakuGossipSub, wakuRelay } from "@waku/relay";
 import { ensureShardingConfigured } from "@waku/utils";
@@ -188,7 +188,7 @@ export function defaultPeerDiscoveries(
 ): ((components: Libp2pComponents) => PeerDiscovery)[] {
   const discoveries = [
     wakuDnsDiscovery([enrTree["PROD"]], DEFAULT_NODE_REQUIREMENTS),
-    wakuLocalStorageDiscovery(),
+    wakuLocalPeerCacheDiscovery(),
     wakuPeerExchangeDiscovery(pubsubTopics)
   ];
   return discoveries;