@waku/interfaces 0.0.12 → 0.0.14

package/CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The file is maintained by [Release Please](https://github.com/googleapis/release-please) based on [Conventional Commits](https://www.conventionalcommits.org) specification,
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.14](https://github.com/waku-org/js-waku/compare/interfaces-v0.0.13...interfaces-v0.0.14) (2023-05-26)
+
+
+### ⚠ BREAKING CHANGES
+
+* filter v2 ([#1332](https://github.com/waku-org/js-waku/issues/1332))
+
+### Features
+
+* Filter v2 ([#1332](https://github.com/waku-org/js-waku/issues/1332)) ([8d0e647](https://github.com/waku-org/js-waku/commit/8d0e64796695fbafad0a033552eb4412bdff3d78))
+
+## [0.0.13](https://github.com/waku-org/js-waku/compare/interfaces-v0.0.12...interfaces-v0.0.13) (2023-05-18)
+
+
+### Features
+
+* Add 1MB restriction to LightPush and Relay ([#1351](https://github.com/waku-org/js-waku/issues/1351)) ([72f97d4](https://github.com/waku-org/js-waku/commit/72f97d4545512f92936b1a9b50fa0b53f8603f9d))
+* Expose `meta` on `IDecodedMessage` ([5724bb2](https://github.com/waku-org/js-waku/commit/5724bb2b21367e4e397acbc5530b3a2bf315194e))
+
 ## [0.0.12](https://github.com/waku-org/js-waku/compare/interfaces-v0.0.11...interfaces-v0.0.12) (2023-05-09)
 
 

package/dist/filter.d.ts

@@ -1,3 +1,18 @@
-import type { PointToPointProtocol } from "./protocols.js";
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { IDecodedMessage, IDecoder } from "./message.js";
+import type { ContentTopic } from "./misc.js";
+import type { Callback, PointToPointProtocol } from "./protocols.js";
 import type { IReceiver } from "./receiver.js";
+export type ContentFilter = {
+    contentTopic: string;
+};
 export type IFilter = IReceiver & PointToPointProtocol;
+export interface IFilterV2Subscription {
+    subscribe<T extends IDecodedMessage>(decoders: IDecoder<T> | IDecoder<T>[], callback: Callback<T>): Promise<void>;
+    unsubscribe(contentTopics: ContentTopic[]): Promise<void>;
+    ping(): Promise<void>;
+    unsubscribeAll(): Promise<void>;
+}
+export type IFilterV2 = IReceiver & PointToPointProtocol & {
+    createSubscription(pubSubTopic?: string, peerId?: PeerId): Promise<IFilterV2Subscription>;
+};

package/dist/message.d.ts

@@ -61,6 +61,7 @@ export interface IDecodedMessage {
     timestamp: Date | undefined;
     rateLimitProof: IRateLimitProof | undefined;
     ephemeral: boolean | undefined;
+    meta: Uint8Array | undefined;
 }
 export interface IDecoder<T extends IDecodedMessage> {
     contentTopic: string;

package/dist/misc.d.ts

@@ -6,3 +6,4 @@ export interface IAsyncIterator<T extends IDecodedMessage> {
 export type Unsubscribe = () => void | Promise<void>;
 export type PubSubTopic = string;
 export type ContentTopic = string;
+export type PeerIdStr = string;

package/dist/protocols.d.ts

@@ -45,6 +45,12 @@ export type ProtocolCreateOptions = {
      * Use recommended bootstrap method to discovery and connect to new nodes.
      */
     defaultBootstrap?: boolean;
+    /**
+     * FilterV2 has been set to default
+     * Use this flag to enable the previous version of the filter protocol
+     * See [Improved Filter protocol specifications](https://github.com/vacp2p/rfc/pull/562)
+     */
+    useFilterV1?: boolean;
 };
 export type ProtocolOptions = {
     /**
@@ -53,6 +59,14 @@ export type ProtocolOptions = {
     peerId?: PeerId;
 };
 export type Callback<T extends IDecodedMessage> = (msg: T) => void | Promise<void>;
+export declare enum SendError {
+    GENERIC_FAIL = "Generic error",
+    ENCODE_FAILED = "Failed to encode",
+    DECODE_FAILED = "Failed to decode",
+    SIZE_TOO_BIG = "Size is too big",
+    NO_RPC_RESPONSE = "No RPC response"
+}
 export interface SendResult {
+    error?: SendError;
     recipients: PeerId[];
 }

package/dist/protocols.js

@@ -5,4 +5,12 @@ export var Protocols;
     Protocols["LightPush"] = "lightpush";
     Protocols["Filter"] = "filter";
 })(Protocols || (Protocols = {}));
+export var SendError;
+(function (SendError) {
+    SendError["GENERIC_FAIL"] = "Generic error";
+    SendError["ENCODE_FAILED"] = "Failed to encode";
+    SendError["DECODE_FAILED"] = "Failed to decode";
+    SendError["SIZE_TOO_BIG"] = "Size is too big";
+    SendError["NO_RPC_RESPONSE"] = "No RPC response";
+})(SendError || (SendError = {}));
 //# sourceMappingURL=protocols.js.map

package/dist/protocols.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocols.js","sourceRoot":"","sources":["../src/protocols.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB"}
+{"version":3,"file":"protocols.js","sourceRoot":"","sources":["../src/protocols.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;AACnB,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AA2DD,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,2CAA8B,CAAA;IAC9B,+CAAkC,CAAA;IAClC,+CAAkC,CAAA;IAClC,6CAAgC,CAAA;IAChC,gDAAmC,CAAA;AACrC,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB"}

package/dist/receiver.d.ts

@@ -1,9 +1,10 @@
 import type { IDecodedMessage, IDecoder } from "./message.js";
-import type { ContentTopic, IAsyncIterator, PubSubTopic, Unsubscribe } from "./misc.js";
+import type { IAsyncIterator, PubSubTopic, Unsubscribe } from "./misc.js";
 import type { Callback, ProtocolOptions } from "./protocols.js";
+type ContentTopic = string;
 export type ActiveSubscriptions = Map<PubSubTopic, ContentTopic[]>;
 export interface IReceiver {
     toSubscriptionIterator: <T extends IDecodedMessage>(decoders: IDecoder<T> | IDecoder<T>[], opts?: ProtocolOptions) => Promise<IAsyncIterator<T>>;
     subscribe: <T extends IDecodedMessage>(decoders: IDecoder<T> | IDecoder<T>[], callback: Callback<T>, opts?: ProtocolOptions) => Unsubscribe | Promise<Unsubscribe>;
-    getActiveSubscriptions: () => ActiveSubscriptions;
 }
+export {};

package/dist/waku.d.ts

@@ -2,7 +2,7 @@ import type { Stream } from "@libp2p/interface-connection";
 import type { Libp2p } from "@libp2p/interface-libp2p";
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Multiaddr } from "@multiformats/multiaddr";
-import type { IFilter } from "./filter.js";
+import type { IFilter, IFilterV2 } from "./filter.js";
 import type { ILightPush } from "./light_push.js";
 import { Protocols } from "./protocols.js";
 import type { IRelay } from "./relay.js";
@@ -11,7 +11,7 @@ export interface Waku {
     libp2p: Libp2p;
     relay?: IRelay;
     store?: IStore;
-    filter?: IFilter;
+    filter?: IFilter | IFilterV2;
     lightPush?: ILightPush;
     dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
     start(): Promise<void>;
@@ -21,7 +21,7 @@ export interface Waku {
 export interface LightNode extends Waku {
     relay: undefined;
     store: IStore;
-    filter: IFilter;
+    filter: IFilter | IFilterV2;
     lightPush: ILightPush;
 }
 export interface RelayNode extends Waku {
@@ -33,6 +33,6 @@ export interface RelayNode extends Waku {
 export interface FullNode extends Waku {
     relay: IRelay;
     store: IStore;
-    filter: IFilter;
+    filter: IFilter | IFilterV2;
     lightPush: ILightPush;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/interfaces",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Definition of Waku interfaces",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -67,7 +67,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.8.8",
-    "typescript": "^4.9.5"
+    "typescript": "^5.0.4"
   },
   "typedoc": {
     "entryPoint": "./src/index.ts"

package/src/filter.ts

@@ -1,4 +1,33 @@
-import type { PointToPointProtocol } from "./protocols.js";
+import type { PeerId } from "@libp2p/interface-peer-id";
+
+import type { IDecodedMessage, IDecoder } from "./message.js";
+import type { ContentTopic } from "./misc.js";
+import type { Callback, PointToPointProtocol } from "./protocols.js";
 import type { IReceiver } from "./receiver.js";
 
+export type ContentFilter = {
+  contentTopic: string;
+};
+
 export type IFilter = IReceiver & PointToPointProtocol;
+
+export interface IFilterV2Subscription {
+  subscribe<T extends IDecodedMessage>(
+    decoders: IDecoder<T> | IDecoder<T>[],
+    callback: Callback<T>
+  ): Promise<void>;
+
+  unsubscribe(contentTopics: ContentTopic[]): Promise<void>;
+
+  ping(): Promise<void>;
+
+  unsubscribeAll(): Promise<void>;
+}
+
+export type IFilterV2 = IReceiver &
+  PointToPointProtocol & {
+    createSubscription(
+      pubSubTopic?: string,
+      peerId?: PeerId
+    ): Promise<IFilterV2Subscription>;
+  };

package/src/message.ts

@@ -65,6 +65,7 @@ export interface IDecodedMessage {
   timestamp: Date | undefined;
   rateLimitProof: IRateLimitProof | undefined;
   ephemeral: boolean | undefined;
+  meta: Uint8Array | undefined;
 }
 
 export interface IDecoder<T extends IDecodedMessage> {

package/src/misc.ts

@@ -9,3 +9,5 @@ export type Unsubscribe = () => void | Promise<void>;
 
 export type PubSubTopic = string;
 export type ContentTopic = string;
+
+export type PeerIdStr = string;

package/src/protocols.ts

@@ -49,6 +49,12 @@ export type ProtocolCreateOptions = {
    * Use recommended bootstrap method to discovery and connect to new nodes.
    */
   defaultBootstrap?: boolean;
+  /**
+   * FilterV2 has been set to default
+   * Use this flag to enable the previous version of the filter protocol
+   * See [Improved Filter protocol specifications](https://github.com/vacp2p/rfc/pull/562)
+   */
+  useFilterV1?: boolean;
 };
 
 export type ProtocolOptions = {
@@ -62,6 +68,15 @@ export type Callback<T extends IDecodedMessage> = (
   msg: T
 ) => void | Promise<void>;
 
+export enum SendError {
+  GENERIC_FAIL = "Generic error",
+  ENCODE_FAILED = "Failed to encode",
+  DECODE_FAILED = "Failed to decode",
+  SIZE_TOO_BIG = "Size is too big",
+  NO_RPC_RESPONSE = "No RPC response",
+}
+
 export interface SendResult {
+  error?: SendError;
   recipients: PeerId[];
 }

package/src/receiver.ts

@@ -1,12 +1,9 @@
 import type { IDecodedMessage, IDecoder } from "./message.js";
-import type {
-  ContentTopic,
-  IAsyncIterator,
-  PubSubTopic,
-  Unsubscribe,
-} from "./misc.js";
+import type { IAsyncIterator, PubSubTopic, Unsubscribe } from "./misc.js";
 import type { Callback, ProtocolOptions } from "./protocols.js";
 
+type ContentTopic = string;
+
 export type ActiveSubscriptions = Map<PubSubTopic, ContentTopic[]>;
 
 export interface IReceiver {
@@ -19,5 +16,4 @@ export interface IReceiver {
     callback: Callback<T>,
     opts?: ProtocolOptions
   ) => Unsubscribe | Promise<Unsubscribe>;
-  getActiveSubscriptions: () => ActiveSubscriptions;
 }

package/src/waku.ts

@@ -3,7 +3,7 @@ import type { Libp2p } from "@libp2p/interface-libp2p";
 import type { PeerId } from "@libp2p/interface-peer-id";
 import type { Multiaddr } from "@multiformats/multiaddr";
 
-import type { IFilter } from "./filter.js";
+import type { IFilter, IFilterV2 } from "./filter.js";
 import type { ILightPush } from "./light_push.js";
 import { Protocols } from "./protocols.js";
 import type { IRelay } from "./relay.js";
@@ -13,7 +13,7 @@ export interface Waku {
   libp2p: Libp2p;
   relay?: IRelay;
   store?: IStore;
-  filter?: IFilter;
+  filter?: IFilter | IFilterV2;
   lightPush?: ILightPush;
 
   dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
@@ -28,7 +28,7 @@ export interface Waku {
 export interface LightNode extends Waku {
   relay: undefined;
   store: IStore;
-  filter: IFilter;
+  filter: IFilter | IFilterV2;
   lightPush: ILightPush;
 }
 
@@ -42,6 +42,6 @@ export interface RelayNode extends Waku {
 export interface FullNode extends Waku {
   relay: IRelay;
   store: IStore;
-  filter: IFilter;
+  filter: IFilter | IFilterV2;
   lightPush: ILightPush;
 }