remove instances of PubSub namespace

danisharora099 · danisharora099 · commit e2e498d64e39 · 2023-11-06T12:19:40.000+05:30
diff --git a/.cspell.json b/.cspell.json
@@ -123,7 +123,7 @@
     "Привет",
     "مرحبا"
   ],
-  "flagWords": ["pubSub", "pubSubTopics", "pubSubTopic"],
+  "flagWords": ["pubSub", "pubSubTopics", "pubSubTopic", "PubSub", "PubSubTopics", "PubSubTopic"],
   "ignorePaths": [
     "package.json",
     "package-lock.json",
diff --git a/packages/core/src/lib/connection_manager.ts b/packages/core/src/lib/connection_manager.ts
@@ -12,7 +12,7 @@ import {
   IRelay,
   KeepAliveOptions,
   PeersByDiscoveryResult,
-  PubSubTopic,
+  PubsubTopic,
   ShardInfo
 } from "@waku/interfaces";
 import { Libp2p, Tags } from "@waku/interfaces";
@@ -45,7 +45,7 @@ export class ConnectionManager
     peerId: string,
     libp2p: Libp2p,
     keepAliveOptions: KeepAliveOptions,
-    pubsubTopics: PubSubTopic[],
+    pubsubTopics: PubsubTopic[],
     relay?: IRelay,
     options?: ConnectionManagerOptions
   ): ConnectionManager {
@@ -111,7 +111,7 @@ export class ConnectionManager
   private constructor(
     libp2p: Libp2p,
     keepAliveOptions: KeepAliveOptions,
-    private configuredPubSubTopics: PubSubTopic[],
+    private configuredPubSubTopics: PubsubTopic[],
     relay?: IRelay,
     options?: Partial<ConnectionManagerOptions>
   ) {
diff --git a/packages/core/src/lib/filter/index.ts b/packages/core/src/lib/filter/index.ts
@@ -13,7 +13,7 @@ import type {
   Libp2p,
   PeerIdStr,
   ProtocolCreateOptions,
-  PubSubTopic,
+  PubsubTopic,
   Unsubscribe
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
@@ -50,7 +50,7 @@ export const FilterCodecs = {
 
 class Subscription {
   private readonly peer: Peer;
-  private readonly pubsubTopic: PubSubTopic;
+  private readonly pubsubTopic: PubsubTopic;
   private newStream: (peer: Peer) => Promise<Stream>;
 
   private subscriptionCallbacks: Map<
@@ -59,7 +59,7 @@ class Subscription {
   >;
 
   constructor(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     remotePeer: Peer,
     newStream: (peer: Peer) => Promise<Stream>
   ) {
@@ -256,19 +256,19 @@ class Subscription {
 }
 
 class Filter extends BaseProtocol implements IReceiver {
-  private readonly pubsubTopics: PubSubTopic[] = [];
+  private readonly pubsubTopics: PubsubTopic[] = [];
   private activeSubscriptions = new Map<string, Subscription>();
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   private getActiveSubscription(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     peerIdStr: PeerIdStr
   ): Subscription | undefined {
     return this.activeSubscriptions.get(`${pubsubTopic}_${peerIdStr}`);
   }
 
   private setActiveSubscription(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     peerIdStr: PeerIdStr,
     subscription: Subscription
   ): Subscription {
@@ -367,7 +367,7 @@ class Filter extends BaseProtocol implements IReceiver {
           }
 
           if (!pubsubTopic) {
-            log.error("PubSub topic missing from push message");
+            log.error("Pubsub topic missing from push message");
             return;
           }
 
@@ -408,7 +408,7 @@ export function wakuFilter(
 
 async function pushMessage<T extends IDecodedMessage>(
   subscriptionCallback: SubscriptionCallback<T>,
-  pubsubTopic: PubSubTopic,
+  pubsubTopic: PubsubTopic,
   message: WakuMessage
 ): Promise<void> {
   const { decoders, callback } = subscriptionCallback;
diff --git a/packages/core/src/lib/keep_alive_manager.ts b/packages/core/src/lib/keep_alive_manager.ts
@@ -116,7 +116,7 @@ export class KeepAliveManager {
     relayPeriodSecs: number,
     peerIdStr: PeerIdStr
   ): NodeJS.Timeout[] {
-    // send a ping message to each PubSubTopic the peer is part of
+    // send a ping message to each PubsubTopic the peer is part of
     const intervals: NodeJS.Timeout[] = [];
     for (const topic of relay.pubsubTopics) {
       const meshPeers = relay.getMeshPeers(topic);
diff --git a/packages/core/src/lib/light_push/index.ts b/packages/core/src/lib/light_push/index.ts
@@ -6,7 +6,7 @@ import {
   IMessage,
   Libp2p,
   ProtocolCreateOptions,
-  PubSubTopic,
+  PubsubTopic,
   SendError,
   SendResult
 } from "@waku/interfaces";
@@ -45,7 +45,7 @@ type PreparePushMessageResult =
  * Implements the [Waku v2 Light Push protocol](https://rfc.vac.dev/spec/19/).
  */
 class LightPush extends BaseProtocol implements ILightPush {
-  private readonly pubsubTopics: PubSubTopic[];
+  private readonly pubsubTopics: PubsubTopic[];
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
diff --git a/packages/core/src/lib/message/version_0.ts b/packages/core/src/lib/message/version_0.ts
@@ -7,7 +7,7 @@ import type {
   IMetaSetter,
   IProtoMessage,
   IRateLimitProof,
-  PubSubTopic
+  PubsubTopic
 } from "@waku/interfaces";
 import { proto_message as proto } from "@waku/proto";
 import { Logger } from "@waku/utils";
@@ -76,7 +76,7 @@ export class Encoder implements IEncoder {
   constructor(
     public contentTopic: string,
     public ephemeral: boolean = false,
-    public pubsubTopic: PubSubTopic,
+    public pubsubTopic: PubsubTopic,
     public metaSetter?: IMetaSetter
   ) {
     if (!contentTopic || contentTopic === "") {
@@ -129,7 +129,7 @@ export function createEncoder({
 
 export class Decoder implements IDecoder<DecodedMessage> {
   constructor(
-    public pubsubTopic: PubSubTopic,
+    public pubsubTopic: PubsubTopic,
     public contentTopic: string
   ) {
     if (!contentTopic || contentTopic === "") {
@@ -182,7 +182,7 @@ export class Decoder implements IDecoder<DecodedMessage> {
  */
 export function createDecoder(
   contentTopic: string,
-  pubsubTopic: PubSubTopic = DefaultPubSubTopic
+  pubsubTopic: PubsubTopic = DefaultPubSubTopic
 ): Decoder {
   return new Decoder(pubsubTopic, contentTopic);
 }
diff --git a/packages/core/src/lib/store/index.ts b/packages/core/src/lib/store/index.ts
@@ -7,7 +7,7 @@ import {
   IStore,
   Libp2p,
   ProtocolCreateOptions,
-  PubSubTopic
+  PubsubTopic
 } from "@waku/interfaces";
 import { proto_store as proto } from "@waku/proto";
 import { ensurePubsubTopicIsConfigured, isDefined } from "@waku/utils";
@@ -75,7 +75,7 @@ export interface QueryOptions {
  * The Waku Store protocol can be used to retrieved historical messages.
  */
 class Store extends BaseProtocol implements IStore {
-  private readonly pubsubTopics: PubSubTopic[];
+  private readonly pubsubTopics: PubsubTopic[];
   private readonly NUM_PEERS_PROTOCOL = 1;
 
   constructor(libp2p: Libp2p, options?: ProtocolCreateOptions) {
diff --git a/packages/core/src/lib/waku.ts b/packages/core/src/lib/waku.ts
@@ -7,7 +7,7 @@ import type {
   IRelay,
   IStore,
   Libp2p,
-  PubSubTopic,
+  PubsubTopic,
   Waku
 } from "@waku/interfaces";
 import { Protocols } from "@waku/interfaces";
@@ -53,7 +53,7 @@ export class WakuNode implements Waku {
 
   constructor(
     options: WakuOptions,
-    public readonly pubsubTopics: PubSubTopic[],
+    public readonly pubsubTopics: PubsubTopic[],
     libp2p: Libp2p,
     store?: (libp2p: Libp2p) => IStore,
     lightPush?: (libp2p: Libp2p) => ILightPush,
diff --git a/packages/interfaces/src/message.ts b/packages/interfaces/src/message.ts
@@ -1,4 +1,4 @@
-import type { PubSubTopic } from "./misc.js";
+import type { PubsubTopic } from "./misc.js";
 
 export interface IRateLimitProof {
   proof: Uint8Array;
@@ -38,7 +38,7 @@ export interface IMetaSetter {
 }
 
 export interface EncoderOptions {
-  pubsubTopic?: PubSubTopic;
+  pubsubTopic?: PubsubTopic;
   /** The content topic to set on outgoing messages. */
   contentTopic: string;
   /**
@@ -55,7 +55,7 @@ export interface EncoderOptions {
 }
 
 export interface IEncoder {
-  pubsubTopic: PubSubTopic;
+  pubsubTopic: PubsubTopic;
   contentTopic: string;
   ephemeral: boolean;
   toWire: (message: IMessage) => Promise<Uint8Array | undefined>;
@@ -65,15 +65,15 @@ export interface IEncoder {
 export interface IDecodedMessage {
   payload: Uint8Array;
   contentTopic: string;
-  pubsubTopic: PubSubTopic;
+  pubsubTopic: PubsubTopic;
   timestamp: Date | undefined;
   rateLimitProof: IRateLimitProof | undefined;
   ephemeral: boolean | undefined;
   meta: Uint8Array | undefined;
 }
 
 export interface IDecoder<T extends IDecodedMessage> {
-  pubsubTopic: PubSubTopic;
+  pubsubTopic: PubsubTopic;
   contentTopic: string;
   fromWireToProtoObj: (bytes: Uint8Array) => Promise<IProtoMessage | undefined>;
   fromProtoObj: (
diff --git a/packages/interfaces/src/misc.ts b/packages/interfaces/src/misc.ts
@@ -7,7 +7,7 @@ export interface IAsyncIterator<T extends IDecodedMessage> {
 
 export type Unsubscribe = () => void | Promise<void>;
 
-export type PubSubTopic = string;
+export type PubsubTopic = string;
 export type ContentTopic = string;
 
 export type PeerIdStr = string;
diff --git a/packages/interfaces/src/protocols.ts b/packages/interfaces/src/protocols.ts
@@ -4,7 +4,7 @@ import type { Peer, PeerStore } from "@libp2p/interface/peer-store";
 import type { Libp2pOptions } from "libp2p";
 
 import type { IDecodedMessage } from "./message.js";
-import type { PubSubTopic } from "./misc.js";
+import type { PubsubTopic } from "./misc.js";
 
 export enum Protocols {
   Relay = "relay",
@@ -27,7 +27,7 @@ export type ProtocolCreateOptions = {
    * Waku implements sharding to achieve scalability
    * The format of the sharded topic is `/waku/2/rs/<shard_cluster_index>/<shard_number>`
    * To learn more about the sharding specifications implemented, see [Relay Sharding](https://rfc.vac.dev/spec/51/).
-   * The PubSub Topic to use. Defaults to {@link @waku/core!DefaultPubSubTopic }.
+   * The Pubsub Topic to use. Defaults to {@link @waku/core!DefaultPubSubTopic }.
    *
    * If no pubsub topic is specified, the default pubsub topic is used.
    * The set of pubsub topics that are used to initialize the Waku node, will need to be used by the protocols as well
@@ -39,7 +39,7 @@ export type ProtocolCreateOptions = {
    * See [Waku v2 Topic Usage Recommendations](https://rfc.vac.dev/spec/23/) for details.
    *
    */
-  pubsubTopics?: PubSubTopic[];
+  pubsubTopics?: PubsubTopic[];
   /**
    * You can pass options to the `Libp2p` instance used by {@link @waku/core!WakuNode} using the `libp2p` property.
    * This property is the same type as the one passed to [`Libp2p.create`](https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#create)
@@ -88,8 +88,8 @@ export enum SendError {
    */
   SIZE_TOO_BIG = "Size is too big",
   /**
-   * The PubSubTopic passed to the send function is not configured on the Waku node.
-   * Please ensure that the PubSubTopic is used when initializing the Waku node.
+   * The PubsubTopic passed to the send function is not configured on the Waku node.
+   * Please ensure that the PubsubTopic is used when initializing the Waku node.
    */
   TOPIC_NOT_CONFIGURED = "Topic not configured",
   /**
diff --git a/packages/interfaces/src/receiver.ts b/packages/interfaces/src/receiver.ts
@@ -2,12 +2,12 @@ import type { IDecodedMessage, IDecoder } from "./message.js";
 import type {
   ContentTopic,
   IAsyncIterator,
-  PubSubTopic,
+  PubsubTopic,
   Unsubscribe
 } from "./misc.js";
 import type { Callback } from "./protocols.js";
 
-export type ActiveSubscriptions = Map<PubSubTopic, ContentTopic[]>;
+export type ActiveSubscriptions = Map<PubsubTopic, ContentTopic[]>;
 
 export interface IReceiver {
   toSubscriptionIterator: <T extends IDecodedMessage>(
diff --git a/packages/interfaces/src/relay.ts b/packages/interfaces/src/relay.ts
@@ -1,8 +1,8 @@
 import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
 import type { PeerIdStr, TopicStr } from "@chainsafe/libp2p-gossipsub/types";
 
-import { PubSubTopic } from "./misc.js";
-import { IReceiver } from "./receiver.js";
+import type { PubsubTopic } from "./misc.js";
+import type { IReceiver } from "./receiver.js";
 import type { ISender } from "./sender.js";
 
 /**
@@ -13,7 +13,7 @@ import type { ISender } from "./sender.js";
  * @property getMeshPeers - Function to retrieve the mesh peers for a given topic or all topics if none is specified. Returns an array of peer IDs as strings.
  */
 export interface IRelayAPI {
-  readonly pubsubTopics: Set<PubSubTopic>;
+  readonly pubsubTopics: Set<PubsubTopic>;
   readonly gossipSub: GossipSub;
   start: () => Promise<void>;
   getMeshPeers: (topic?: TopicStr) => PeerIdStr[];
diff --git a/packages/message-encryption/src/ecies.ts b/packages/message-encryption/src/ecies.ts
@@ -1,6 +1,6 @@
 import { DefaultPubSubTopic } from "@waku/core";
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
-import { IMetaSetter, PubSubTopic } from "@waku/interfaces";
+import { IMetaSetter, PubsubTopic } from "@waku/interfaces";
 import type {
   EncoderOptions as BaseEncoderOptions,
   IDecoder,
@@ -33,7 +33,7 @@ const log = new Logger("message-encryption:ecies");
 
 class Encoder implements IEncoder {
   constructor(
-    public pubsubTopic: PubSubTopic,
+    public pubsubTopic: PubsubTopic,
     public contentTopic: string,
     private publicKey: Uint8Array,
     private sigPrivKey?: Uint8Array,
@@ -116,7 +116,7 @@ export function createEncoder({
 
 class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
   constructor(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     contentTopic: string,
     private privateKey: Uint8Array
   ) {
@@ -193,7 +193,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   privateKey: Uint8Array,
-  pubsubTopic: PubSubTopic = DefaultPubSubTopic
+  pubsubTopic: PubsubTopic = DefaultPubSubTopic
 ): Decoder {
   return new Decoder(pubsubTopic, contentTopic, privateKey);
 }
diff --git a/packages/message-encryption/src/symmetric.ts b/packages/message-encryption/src/symmetric.ts
@@ -7,7 +7,7 @@ import type {
   IMessage,
   IMetaSetter,
   IProtoMessage,
-  PubSubTopic
+  PubsubTopic
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
 import { Logger } from "@waku/utils";
@@ -29,7 +29,7 @@ const log = new Logger("message-encryption:symmetric");
 
 class Encoder implements IEncoder {
   constructor(
-    public pubsubTopic: PubSubTopic,
+    public pubsubTopic: PubsubTopic,
     public contentTopic: string,
     private symKey: Uint8Array,
     private sigPrivKey?: Uint8Array,
@@ -112,7 +112,7 @@ export function createEncoder({
 
 class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
   constructor(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     contentTopic: string,
     private symKey: Uint8Array
   ) {
@@ -189,7 +189,7 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   symKey: Uint8Array,
-  pubsubTopic: PubSubTopic = DefaultPubSubTopic
+  pubsubTopic: PubsubTopic = DefaultPubSubTopic
 ): Decoder {
   return new Decoder(pubsubTopic, contentTopic, symKey);
 }
diff --git a/packages/relay/src/index.ts b/packages/relay/src/index.ts
diff --git a/packages/utils/src/common/sharding.ts b/packages/utils/src/common/sharding.ts
