feat!: filter v2 (#1332)

* implement proto

* implement filter v2

* add tests

* minor improvements
- make unsubscribe functions private in
filter
- enable all tests

* enable all tests

* readd multiaddrinput

* address comment removals

* unsubscribe based on contentFilters passed

* update unsubscribe function parameters in test

* reset interfaces & filter v1

* refactor filterv2 into 2 classes
- removes generics from types on filter which means
manual typecasting to filter version is required on
consumer side
- defaults to filterv2
- splits filterv2 into 2 classes:
  - one to create the subscription object with a
peer which returns the second class
  - the other to manage all subscription functions

* updates filter tests for the new API
- also fixes an interface import

* update `toAsyncIterator` test for Filter V1

* implement IReceiver on FilterV2

* remove return values from subscription functions

* update `to_async_iterator`

* address variable naming

* add tsdoc comments for hidden function

* address minor comments

* update docs to default to filter v2

* address comments

* rename `wakuFilter` to `wakuFilterV1`

* chore: Remove static variables (#1371)

* chore: Remove static variables

- Remove internal types from `@core/interfaces`
- Remove data being redundantly stored (pubsub topic)
- Remove usage of static variables
- Clean up callbacks and decoders when using `unsubscribe`
- Clean up callbacks and decoders when using `unsubscribeAll`

* fix setting activeSubscription

---------

Co-authored-by: danisharora099 <danisharora099@gmail.com>

* make activeSub getter and setter private

* update size-limit

---------

Co-authored-by: fryorcraken.eth <110212804+fryorcraken@users.noreply.github.com>

Author: danisharora099

.cspell.json

@@ -39,6 +39,8 @@
     "exponentiate",
     "extip",
     "fanout",
+    "Filterv1",
+    "Filterv2",
     "floodsub",
     "fontsource",
     "globby",

.size-limit.cjs

@@ -36,7 +36,7 @@ module.exports = [
   {
     name: "Light protocols",
     path: "packages/core/bundle/index.js",
-    import: "{ wakuLightPush, wakuFilter }",
+    import: "{ wakuLightPush, wakuFilterV1, wakuFilterV2 }",
   },
   {
     name: "History retrieval protocols",

package-lock.json

@@ -11,8 +11,11 @@ export * as message from "./lib/message/index.js";
 export * as waku from "./lib/waku.js";
 export { WakuNode, WakuOptions } from "./lib/waku.js";
 
-export * as waku_filter from "./lib/filter/index.js";
-export { wakuFilter } from "./lib/filter/index.js";
+export * as waku_filter_v1 from "./lib/filter/v1/index.js";
+export { wakuFilter as wakuFilterV1 } from "./lib/filter/v1/index.js";
+
+export * as waku_filter_v2 from "./lib/filter/v2/index.js";
+export { wakuFilterV2 } from "./lib/filter/v2/index.js";
 
 export * as waku_light_push from "./lib/light_push/index.js";
 export { wakuLightPush, LightPushCodec } from "./lib/light_push/index.js";

packages/core/src/index.ts

@@ -1,10 +1,7 @@
+import { ContentFilter } from "@waku/interfaces";
 import { proto_filter as proto } from "@waku/proto";
 import { v4 as uuid } from "uuid";
 
-export type ContentFilter = {
-  contentTopic: string;
-};
-
 /**
  * FilterRPC represents a message conforming to the Waku Filter protocol
  */

packages/core/src/lib/filter/filter_rpc.ts packages/core/src/lib/filter/v1/filter_rpc.ts

@@ -4,6 +4,7 @@ import type { IncomingStreamData } from "@libp2p/interface-registrar";
 import type {
   ActiveSubscriptions,
   Callback,
+  ContentFilter,
   IAsyncIterator,
   IDecodedMessage,
   IDecoder,
@@ -19,13 +20,11 @@ import all from "it-all";
 import * as lp from "it-length-prefixed";
 import { pipe } from "it-pipe";
 
-import { BaseProtocol } from "../base_protocol.js";
-import { DefaultPubSubTopic } from "../constants.js";
-import { toProtoMessage } from "../to_proto_message.js";
+import { BaseProtocol } from "../../base_protocol.js";
+import { DefaultPubSubTopic } from "../../constants.js";
+import { toProtoMessage } from "../../to_proto_message.js";
 
-import { ContentFilter, FilterRpc } from "./filter_rpc.js";
-
-export { ContentFilter };
+import { FilterRpc } from "./filter_rpc.js";
 
 export const FilterCodec = "/vac/waku/filter/2.0.0-beta1";