@waku/interfaces 0.0.5 → 0.0.7

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.7] - 2023-01-18
+
+### Added
+
+- `IPeerExchange` interface.
+- `IEnr` interface.
+
+## [0.0.6] - 2022-12-15
+
+### Changed
+
+- Add `I` prefix to protocol and messages interfaces.
+- Renamed node interfaces to include `Node`.
+- Renamed `WakuPrivacy` to `RelayNode`.
+
+## [0.0.5] - 2022-11-18
+
+### Added
+
+- Alpha version of `@waku/interfaces`.
+
+[unreleased]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.7...HEAD
+[0.0.7]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.6...@waku/interfaces@0.0.7
+[0.0.6]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.5...@waku/interfaces@0.0.6
+[0.0.5]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.4...@waku/interfaces@0.0.5
+[0.0.4]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.3...@waku/interfaces@0.0.4
+[0.0.3]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.2...%40waku/create@0.0.3
+[0.0.2]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.1...%40waku/create@0.0.2
+[0.0.1]: https://github.com/status-im/js-waku/compare/a20b7809d61ff9a9732aba82b99bbe99f229b935...%40waku/create%400.0.2

package/dist/enr.d.ts

@@ -0,0 +1,34 @@
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Multiaddr } from "@multiformats/multiaddr";
+export declare type ENRKey = string;
+export declare type ENRValue = Uint8Array;
+/**
+ * We represent NodeId as a hex string, since node equality is used very heavily
+ * and it is convenient to index data by NodeId
+ */
+export declare type NodeId = string;
+export declare type SequenceNumber = bigint;
+export interface Waku2 {
+    relay: boolean;
+    store: boolean;
+    filter: boolean;
+    lightPush: boolean;
+}
+export interface IEnr extends Map<ENRKey, ENRValue> {
+    nodeId?: NodeId;
+    peerId?: PeerId;
+    id: string;
+    seq: SequenceNumber;
+    publicKey?: Uint8Array;
+    signature?: Uint8Array;
+    ip?: string;
+    tcp?: number;
+    udp?: number;
+    ip6?: string;
+    tcp6?: number;
+    udp6?: number;
+    multiaddrs?: Multiaddr[];
+    waku2?: Waku2;
+    encode(privateKey?: Uint8Array): Promise<Uint8Array>;
+    getFullMultiaddrs(): Multiaddr[];
+}

package/dist/enr.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=enr.js.map

package/dist/enr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enr.js","sourceRoot":"","sources":["../src/enr.ts"],"names":[],"mappings":""}

package/dist/filter.d.ts

@@ -0,0 +1,5 @@
+import type { IDecodedMessage, IDecoder } from "./message.js";
+import type { Callback, PointToPointProtocol, ProtocolOptions } from "./protocols.js";
+export interface IFilter extends PointToPointProtocol {
+    subscribe: <T extends IDecodedMessage>(decoders: IDecoder<T>[], callback: Callback<T>, opts?: ProtocolOptions) => Promise<() => Promise<void>>;
+}

package/dist/filter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=filter.js.map

package/dist/filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../src/filter.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -1,159 +1,9 @@
-import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
-import type { Stream } from "@libp2p/interface-connection";
-import type { PeerId } from "@libp2p/interface-peer-id";
-import type { Peer } from "@libp2p/interface-peer-store";
-import type { PeerStore } from "@libp2p/interface-peer-store";
-import type { Multiaddr } from "@multiformats/multiaddr";
-import type { Libp2p } from "libp2p";
-export declare enum Protocols {
-    Relay = "relay",
-    Store = "store",
-    LightPush = "lightpush",
-    Filter = "filter"
-}
-export interface PointToPointProtocol {
-    peerStore: PeerStore;
-    peers: () => Promise<Peer[]>;
-}
-export interface Index {
-    digest?: Uint8Array;
-    receivedTime?: bigint;
-    senderTime?: bigint;
-    pubsubTopic?: string;
-}
-export declare type ProtocolOptions = {
-    pubSubTopic?: string;
-    /**
-     * Optionally specify an PeerId for the protocol request. If not included, will use a random peer.
-     */
-    peerId?: PeerId;
-};
-export declare type Callback<T extends Message> = (msg: T) => void | Promise<void>;
-export interface Filter extends PointToPointProtocol {
-    subscribe: <T extends DecodedMessage>(decoders: Decoder<T>[], callback: Callback<T>, opts?: ProtocolOptions) => Promise<() => Promise<void>>;
-}
-export interface LightPush extends PointToPointProtocol {
-    push: (encoder: Encoder, message: Message, opts?: ProtocolOptions) => Promise<SendResult>;
-}
-export declare enum PageDirection {
-    BACKWARD = "backward",
-    FORWARD = "forward"
-}
-export interface TimeFilter {
-    startTime: Date;
-    endTime: Date;
-}
-export declare type StoreQueryOptions = {
-    /**
-     * The direction in which pages are retrieved:
-     * - { @link PageDirection.BACKWARD }: Most recent page first.
-     * - { @link PageDirection.FORWARD }: Oldest page first.
-     *
-     * Note: This does not affect the ordering of messages with the page
-     * (the oldest message is always first).
-     *
-     * @default { @link PageDirection.BACKWARD }
-     */
-    pageDirection?: PageDirection;
-    /**
-     * The number of message per page.
-     */
-    pageSize?: number;
-    /**
-     * Retrieve messages with a timestamp within the provided values.
-     */
-    timeFilter?: TimeFilter;
-    /**
-     * Cursor as an index to start a query from.
-     */
-    cursor?: Index;
-} & ProtocolOptions;
-export interface Store extends PointToPointProtocol {
-    queryOrderedCallback: <T extends DecodedMessage>(decoders: Decoder<T>[], callback: (message: T) => Promise<void | boolean> | boolean | void, options?: StoreQueryOptions) => Promise<void>;
-    queryCallbackOnPromise: <T extends DecodedMessage>(decoders: Decoder<T>[], callback: (message: Promise<T | undefined>) => Promise<void | boolean> | boolean | void, options?: StoreQueryOptions) => Promise<void>;
-    queryGenerator: <T extends DecodedMessage>(decoders: Decoder<T>[], options?: StoreQueryOptions) => AsyncGenerator<Promise<T | undefined>[]>;
-}
-export interface Relay extends GossipSub {
-    send: (encoder: Encoder, message: Message) => Promise<SendResult>;
-    addObserver: <T extends DecodedMessage>(decoder: Decoder<T>, callback: Callback<T>) => () => void;
-    getMeshPeers: () => string[];
-}
-export interface Waku {
-    libp2p: Libp2p;
-    relay?: Relay;
-    store?: Store;
-    filter?: Filter;
-    lightPush?: LightPush;
-    dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    isStarted(): boolean;
-}
-export interface WakuLight extends Waku {
-    relay: undefined;
-    store: Store;
-    filter: Filter;
-    lightPush: LightPush;
-}
-export interface WakuPrivacy extends Waku {
-    relay: Relay;
-    store: undefined;
-    filter: undefined;
-    lightPush: undefined;
-}
-export interface WakuFull extends Waku {
-    relay: Relay;
-    store: Store;
-    filter: Filter;
-    lightPush: LightPush;
-}
-export interface RateLimitProof {
-    proof: Uint8Array;
-    merkleRoot: Uint8Array;
-    epoch: Uint8Array;
-    shareX: Uint8Array;
-    shareY: Uint8Array;
-    nullifier: Uint8Array;
-    rlnIdentifier: Uint8Array;
-}
-/**
- * Interface matching the protobuf library.
- * Field types matches the protobuf type over the wire
- */
-export interface ProtoMessage {
-    payload: Uint8Array | undefined;
-    contentTopic: string | undefined;
-    version: number | undefined;
-    timestamp: bigint | undefined;
-    rateLimitProof: RateLimitProof | undefined;
-    ephemeral: boolean | undefined;
-}
-/**
- * Interface for messages to encode and send.
- */
-export interface Message {
-    payload?: Uint8Array;
-    timestamp?: Date;
-    rateLimitProof?: RateLimitProof;
-}
-export interface Encoder {
-    contentTopic: string;
-    ephemeral: boolean;
-    toWire: (message: Message) => Promise<Uint8Array | undefined>;
-    toProtoObj: (message: Message) => Promise<ProtoMessage | undefined>;
-}
-export interface DecodedMessage {
-    payload: Uint8Array | undefined;
-    contentTopic: string | undefined;
-    timestamp: Date | undefined;
-    rateLimitProof: RateLimitProof | undefined;
-    ephemeral: boolean | undefined;
-}
-export interface Decoder<T extends DecodedMessage> {
-    contentTopic: string;
-    fromWireToProtoObj: (bytes: Uint8Array) => Promise<ProtoMessage | undefined>;
-    fromProtoObj: (proto: ProtoMessage) => Promise<T | undefined>;
-}
-export interface SendResult {
-    recipients: PeerId[];
-}
+export * from "./enr.js";
+export * from "./filter.js";
+export * from "./light_push.js";
+export * from "./message.js";
+export * from "./peer_exchange.js";
+export * from "./protocols.js";
+export * from "./relay.js";
+export * from "./store.js";
+export * from "./waku.js";

package/dist/index.js

@@ -1,13 +1,10 @@
-export var Protocols;
-(function (Protocols) {
-    Protocols["Relay"] = "relay";
-    Protocols["Store"] = "store";
-    Protocols["LightPush"] = "lightpush";
-    Protocols["Filter"] = "filter";
-})(Protocols || (Protocols = {}));
-export var PageDirection;
-(function (PageDirection) {
-    PageDirection["BACKWARD"] = "backward";
-    PageDirection["FORWARD"] = "forward";
-})(PageDirection || (PageDirection = {}));
+export * from "./enr.js";
+export * from "./filter.js";
+export * from "./light_push.js";
+export * from "./message.js";
+export * from "./peer_exchange.js";
+export * from "./protocols.js";
+export * from "./relay.js";
+export * from "./store.js";
+export * from "./waku.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,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;AAuCD,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;AACrB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/light_push.d.ts

@@ -0,0 +1,5 @@
+import type { IEncoder, IMessage } from "./message.js";
+import type { PointToPointProtocol, ProtocolOptions, SendResult } from "./protocols.js";
+export interface ILightPush extends PointToPointProtocol {
+    push: (encoder: IEncoder, message: IMessage, opts?: ProtocolOptions) => Promise<SendResult>;
+}

package/dist/light_push.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=light_push.js.map

package/dist/light_push.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"light_push.js","sourceRoot":"","sources":["../src/light_push.ts"],"names":[],"mappings":""}

package/dist/message.d.ts

@@ -0,0 +1,47 @@
+export interface IRateLimitProof {
+    proof: Uint8Array;
+    merkleRoot: Uint8Array;
+    epoch: Uint8Array;
+    shareX: Uint8Array;
+    shareY: Uint8Array;
+    nullifier: Uint8Array;
+    rlnIdentifier: Uint8Array;
+}
+/**
+ * Interface matching the protobuf library.
+ * Field types matches the protobuf type over the wire
+ */
+export interface IProtoMessage {
+    payload: Uint8Array | undefined;
+    contentTopic: string | undefined;
+    version: number | undefined;
+    timestamp: bigint | undefined;
+    rateLimitProof: IRateLimitProof | undefined;
+    ephemeral: boolean | undefined;
+}
+/**
+ * Interface for messages to encode and send.
+ */
+export interface IMessage {
+    payload?: Uint8Array;
+    timestamp?: Date;
+    rateLimitProof?: IRateLimitProof;
+}
+export interface IEncoder {
+    contentTopic: string;
+    ephemeral: boolean;
+    toWire: (message: IMessage) => Promise<Uint8Array | undefined>;
+    toProtoObj: (message: IMessage) => Promise<IProtoMessage | undefined>;
+}
+export interface IDecodedMessage {
+    payload: Uint8Array | undefined;
+    contentTopic: string | undefined;
+    timestamp: Date | undefined;
+    rateLimitProof: IRateLimitProof | undefined;
+    ephemeral: boolean | undefined;
+}
+export interface IDecoder<T extends IDecodedMessage> {
+    contentTopic: string;
+    fromWireToProtoObj: (bytes: Uint8Array) => Promise<IProtoMessage | undefined>;
+    fromProtoObj: (proto: IProtoMessage) => Promise<T | undefined>;
+}

package/dist/message.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=message.js.map

package/dist/message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.js","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":""}

package/dist/peer_exchange.d.ts

@@ -0,0 +1,24 @@
+import type { ConnectionManager } from "@libp2p/interface-connection-manager";
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { PeerStore } from "@libp2p/interface-peer-store";
+import type { Registrar } from "@libp2p/interface-registrar";
+import { IEnr } from "./enr.js";
+import { PointToPointProtocol } from "./protocols.js";
+export interface IPeerExchange extends PointToPointProtocol {
+    query(params: PeerExchangeQueryParams, callback: (response: PeerExchangeResponse) => Promise<void> | void): Promise<void>;
+}
+export interface PeerExchangeQueryParams {
+    numPeers: number;
+    peerId?: PeerId;
+}
+export interface PeerExchangeResponse {
+    peerInfos: PeerInfo[];
+}
+export interface PeerInfo {
+    ENR?: IEnr;
+}
+export interface PeerExchangeComponents {
+    connectionManager: ConnectionManager;
+    peerStore: PeerStore;
+    registrar: Registrar;
+}

package/dist/peer_exchange.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=peer_exchange.js.map

package/dist/peer_exchange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"peer_exchange.js","sourceRoot":"","sources":["../src/peer_exchange.ts"],"names":[],"mappings":""}

package/dist/protocols.d.ts

@@ -0,0 +1,25 @@
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Peer, PeerStore } from "@libp2p/interface-peer-store";
+import type { IMessage } from "./message.js";
+export declare enum Protocols {
+    Relay = "relay",
+    Store = "store",
+    LightPush = "lightpush",
+    Filter = "filter",
+    PeerExchange = "peer-exchange"
+}
+export interface PointToPointProtocol {
+    peerStore: PeerStore;
+    peers: () => Promise<Peer[]>;
+}
+export declare type ProtocolOptions = {
+    pubSubTopic?: string;
+    /**
+     * Optionally specify an PeerId for the protocol request. If not included, will use a random peer.
+     */
+    peerId?: PeerId;
+};
+export declare type Callback<T extends IMessage> = (msg: T) => void | Promise<void>;
+export interface SendResult {
+    recipients: PeerId[];
+}

package/dist/protocols.js

@@ -0,0 +1,9 @@
+export var Protocols;
+(function (Protocols) {
+    Protocols["Relay"] = "relay";
+    Protocols["Store"] = "store";
+    Protocols["LightPush"] = "lightpush";
+    Protocols["Filter"] = "filter";
+    Protocols["PeerExchange"] = "peer-exchange";
+})(Protocols || (Protocols = {}));
+//# sourceMappingURL=protocols.js.map

package/dist/protocols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocols.js","sourceRoot":"","sources":["../src/protocols.ts"],"names":[],"mappings":"AAKA,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,oCAAuB,CAAA;IACvB,8BAAiB,CAAA;IACjB,2CAA8B,CAAA;AAChC,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB"}

package/dist/relay.d.ts

@@ -0,0 +1,8 @@
+import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
+import type { IDecodedMessage, IDecoder, IEncoder, IMessage } from "./message.js";
+import type { Callback, SendResult } from "./protocols.js";
+export interface IRelay extends GossipSub {
+    send: (encoder: IEncoder, message: IMessage) => Promise<SendResult>;
+    addObserver: <T extends IDecodedMessage>(decoder: IDecoder<T>, callback: Callback<T>) => () => void;
+    getMeshPeers: () => string[];
+}

package/dist/relay.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=relay.js.map

package/dist/relay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relay.js","sourceRoot":"","sources":["../src/relay.ts"],"names":[],"mappings":""}

package/dist/store.d.ts

@@ -0,0 +1,51 @@
+import type { IDecodedMessage, IDecoder } from "./message.js";
+import type { PointToPointProtocol, ProtocolOptions } from "./protocols.js";
+export declare enum PageDirection {
+    BACKWARD = "backward",
+    FORWARD = "forward"
+}
+export interface TimeFilter {
+    startTime: Date;
+    endTime: Date;
+}
+export interface Index {
+    digest?: Uint8Array;
+    receivedTime?: bigint;
+    senderTime?: bigint;
+    pubsubTopic?: string;
+}
+export declare type Cursor = {
+    digest?: Uint8Array;
+    senderTime?: bigint;
+    pubsubTopic?: string;
+};
+export declare type StoreQueryOptions = {
+    /**
+     * The direction in which pages are retrieved:
+     * - { @link PageDirection.BACKWARD }: Most recent page first.
+     * - { @link PageDirection.FORWARD }: Oldest page first.
+     *
+     * Note: This does not affect the ordering of messages with the page
+     * (the oldest message is always first).
+     *
+     * @default { @link PageDirection.BACKWARD }
+     */
+    pageDirection?: PageDirection;
+    /**
+     * The number of message per page.
+     */
+    pageSize?: number;
+    /**
+     * Retrieve messages with a timestamp within the provided values.
+     */
+    timeFilter?: TimeFilter;
+    /**
+     * Cursor as an index to start a query from.
+     */
+    cursor?: Cursor;
+} & ProtocolOptions;
+export interface IStore extends PointToPointProtocol {
+    queryOrderedCallback: <T extends IDecodedMessage>(decoders: IDecoder<T>[], callback: (message: T) => Promise<void | boolean> | boolean | void, options?: StoreQueryOptions) => Promise<void>;
+    queryCallbackOnPromise: <T extends IDecodedMessage>(decoders: IDecoder<T>[], callback: (message: Promise<T | undefined>) => Promise<void | boolean> | boolean | void, options?: StoreQueryOptions) => Promise<void>;
+    queryGenerator: <T extends IDecodedMessage>(decoders: IDecoder<T>[], options?: StoreQueryOptions) => AsyncGenerator<Promise<T | undefined>[]>;
+}

package/dist/store.js

@@ -0,0 +1,6 @@
+export var PageDirection;
+(function (PageDirection) {
+    PageDirection["BACKWARD"] = "backward";
+    PageDirection["FORWARD"] = "forward";
+})(PageDirection || (PageDirection = {}));
+//# sourceMappingURL=store.js.map

package/dist/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;AACrB,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB"}

package/dist/waku.d.ts

@@ -0,0 +1,43 @@
+import type { Stream } from "@libp2p/interface-connection";
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Multiaddr } from "@multiformats/multiaddr";
+import type { Libp2p } from "libp2p";
+import type { IFilter } from "./filter.js";
+import type { ILightPush } from "./light_push.js";
+import type { IPeerExchange } from "./peer_exchange.js";
+import { Protocols } from "./protocols.js";
+import type { IRelay } from "./relay.js";
+import type { IStore } from "./store.js";
+export interface Waku {
+    libp2p: Libp2p;
+    relay?: IRelay;
+    store?: IStore;
+    filter?: IFilter;
+    lightPush?: ILightPush;
+    peerExchange?: IPeerExchange;
+    dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    isStarted(): boolean;
+}
+export interface LightNode extends Waku {
+    relay: undefined;
+    store: IStore;
+    filter: IFilter;
+    lightPush: ILightPush;
+    peerExchange: IPeerExchange;
+}
+export interface RelayNode extends Waku {
+    relay: IRelay;
+    store: undefined;
+    filter: undefined;
+    lightPush: undefined;
+    peerExchange: undefined;
+}
+export interface FullNode extends Waku {
+    relay: IRelay;
+    store: IStore;
+    filter: IFilter;
+    lightPush: ILightPush;
+    peerExchange: IPeerExchange;
+}

package/dist/waku.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=waku.js.map

package/dist/waku.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waku.js","sourceRoot":"","sources":["../src/waku.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/interfaces",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Definition of Waku interfaces",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -58,7 +58,7 @@
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.8.1",
     "@typescript-eslint/parser": "^5.8.1",
-    "cspell": "^5.14.0",
+    "cspell": "^6.17.0",
     "eslint": "^8.6.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.2.0",

package/src/enr.ts

@@ -0,0 +1,38 @@
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Multiaddr } from "@multiformats/multiaddr";
+
+export type ENRKey = string;
+export type ENRValue = Uint8Array;
+/**
+ * We represent NodeId as a hex string, since node equality is used very heavily
+ * and it is convenient to index data by NodeId
+ */
+export type NodeId = string;
+export type SequenceNumber = bigint;
+
+export interface Waku2 {
+  relay: boolean;
+  store: boolean;
+  filter: boolean;
+  lightPush: boolean;
+}
+
+export interface IEnr extends Map<ENRKey, ENRValue> {
+  nodeId?: NodeId;
+  peerId?: PeerId;
+  id: string;
+  seq: SequenceNumber;
+  publicKey?: Uint8Array;
+  signature?: Uint8Array;
+  ip?: string;
+  tcp?: number;
+  udp?: number;
+  ip6?: string;
+  tcp6?: number;
+  udp6?: number;
+  multiaddrs?: Multiaddr[];
+  waku2?: Waku2;
+
+  encode(privateKey?: Uint8Array): Promise<Uint8Array>;
+  getFullMultiaddrs(): Multiaddr[];
+}

package/src/filter.ts

@@ -0,0 +1,14 @@
+import type { IDecodedMessage, IDecoder } from "./message.js";
+import type {
+  Callback,
+  PointToPointProtocol,
+  ProtocolOptions,
+} from "./protocols.js";
+
+export interface IFilter extends PointToPointProtocol {
+  subscribe: <T extends IDecodedMessage>(
+    decoders: IDecoder<T>[],
+    callback: Callback<T>,
+    opts?: ProtocolOptions
+  ) => Promise<() => Promise<void>>;
+}

package/src/index.ts

@@ -1,209 +1,9 @@
-import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
-import type { Stream } from "@libp2p/interface-connection";
-import type { PeerId } from "@libp2p/interface-peer-id";
-import type { Peer } from "@libp2p/interface-peer-store";
-import type { PeerStore } from "@libp2p/interface-peer-store";
-import type { Multiaddr } from "@multiformats/multiaddr";
-import type { Libp2p } from "libp2p";
-
-export enum Protocols {
-  Relay = "relay",
-  Store = "store",
-  LightPush = "lightpush",
-  Filter = "filter",
-}
-
-export interface PointToPointProtocol {
-  peerStore: PeerStore;
-  peers: () => Promise<Peer[]>;
-}
-export interface Index {
-  digest?: Uint8Array;
-  receivedTime?: bigint;
-  senderTime?: bigint;
-  pubsubTopic?: string;
-}
-
-export type ProtocolOptions = {
-  pubSubTopic?: string;
-  /**
-   * Optionally specify an PeerId for the protocol request. If not included, will use a random peer.
-   */
-  peerId?: PeerId;
-};
-
-export type Callback<T extends Message> = (msg: T) => void | Promise<void>;
-
-export interface Filter extends PointToPointProtocol {
-  subscribe: <T extends DecodedMessage>(
-    decoders: Decoder<T>[],
-    callback: Callback<T>,
-    opts?: ProtocolOptions
-  ) => Promise<() => Promise<void>>;
-}
-
-export interface LightPush extends PointToPointProtocol {
-  push: (
-    encoder: Encoder,
-    message: Message,
-    opts?: ProtocolOptions
-  ) => Promise<SendResult>;
-}
-
-export enum PageDirection {
-  BACKWARD = "backward",
-  FORWARD = "forward",
-}
-
-export interface TimeFilter {
-  startTime: Date;
-  endTime: Date;
-}
-
-export type StoreQueryOptions = {
-  /**
-   * The direction in which pages are retrieved:
-   * - { @link PageDirection.BACKWARD }: Most recent page first.
-   * - { @link PageDirection.FORWARD }: Oldest page first.
-   *
-   * Note: This does not affect the ordering of messages with the page
-   * (the oldest message is always first).
-   *
-   * @default { @link PageDirection.BACKWARD }
-   */
-  pageDirection?: PageDirection;
-  /**
-   * The number of message per page.
-   */
-  pageSize?: number;
-  /**
-   * Retrieve messages with a timestamp within the provided values.
-   */
-  timeFilter?: TimeFilter;
-  /**
-   * Cursor as an index to start a query from.
-   */
-  cursor?: Index;
-} & ProtocolOptions;
-
-export interface Store extends PointToPointProtocol {
-  queryOrderedCallback: <T extends DecodedMessage>(
-    decoders: Decoder<T>[],
-    callback: (message: T) => Promise<void | boolean> | boolean | void,
-    options?: StoreQueryOptions
-  ) => Promise<void>;
-  queryCallbackOnPromise: <T extends DecodedMessage>(
-    decoders: Decoder<T>[],
-    callback: (
-      message: Promise<T | undefined>
-    ) => Promise<void | boolean> | boolean | void,
-    options?: StoreQueryOptions
-  ) => Promise<void>;
-  queryGenerator: <T extends DecodedMessage>(
-    decoders: Decoder<T>[],
-    options?: StoreQueryOptions
-  ) => AsyncGenerator<Promise<T | undefined>[]>;
-}
-
-export interface Relay extends GossipSub {
-  send: (encoder: Encoder, message: Message) => Promise<SendResult>;
-  addObserver: <T extends DecodedMessage>(
-    decoder: Decoder<T>,
-    callback: Callback<T>
-  ) => () => void;
-  getMeshPeers: () => string[];
-}
-
-export interface Waku {
-  libp2p: Libp2p;
-  relay?: Relay;
-  store?: Store;
-  filter?: Filter;
-  lightPush?: LightPush;
-
-  dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
-
-  start(): Promise<void>;
-
-  stop(): Promise<void>;
-
-  isStarted(): boolean;
-}
-
-export interface WakuLight extends Waku {
-  relay: undefined;
-  store: Store;
-  filter: Filter;
-  lightPush: LightPush;
-}
-
-export interface WakuPrivacy extends Waku {
-  relay: Relay;
-  store: undefined;
-  filter: undefined;
-  lightPush: undefined;
-}
-
-export interface WakuFull extends Waku {
-  relay: Relay;
-  store: Store;
-  filter: Filter;
-  lightPush: LightPush;
-}
-
-export interface RateLimitProof {
-  proof: Uint8Array;
-  merkleRoot: Uint8Array;
-  epoch: Uint8Array;
-  shareX: Uint8Array;
-  shareY: Uint8Array;
-  nullifier: Uint8Array;
-  rlnIdentifier: Uint8Array;
-}
-
-/**
- * Interface matching the protobuf library.
- * Field types matches the protobuf type over the wire
- */
-export interface ProtoMessage {
-  payload: Uint8Array | undefined;
-  contentTopic: string | undefined;
-  version: number | undefined;
-  timestamp: bigint | undefined;
-  rateLimitProof: RateLimitProof | undefined;
-  ephemeral: boolean | undefined;
-}
-
-/**
- * Interface for messages to encode and send.
- */
-export interface Message {
-  payload?: Uint8Array;
-  timestamp?: Date;
-  rateLimitProof?: RateLimitProof;
-}
-
-export interface Encoder {
-  contentTopic: string;
-  ephemeral: boolean;
-  toWire: (message: Message) => Promise<Uint8Array | undefined>;
-  toProtoObj: (message: Message) => Promise<ProtoMessage | undefined>;
-}
-
-export interface DecodedMessage {
-  payload: Uint8Array | undefined;
-  contentTopic: string | undefined;
-  timestamp: Date | undefined;
-  rateLimitProof: RateLimitProof | undefined;
-  ephemeral: boolean | undefined;
-}
-
-export interface Decoder<T extends DecodedMessage> {
-  contentTopic: string;
-  fromWireToProtoObj: (bytes: Uint8Array) => Promise<ProtoMessage | undefined>;
-  fromProtoObj: (proto: ProtoMessage) => Promise<T | undefined>;
-}
-
-export interface SendResult {
-  recipients: PeerId[];
-}
+export * from "./enr.js";
+export * from "./filter.js";
+export * from "./light_push.js";
+export * from "./message.js";
+export * from "./peer_exchange.js";
+export * from "./protocols.js";
+export * from "./relay.js";
+export * from "./store.js";
+export * from "./waku.js";

package/src/light_push.ts

@@ -0,0 +1,14 @@
+import type { IEncoder, IMessage } from "./message.js";
+import type {
+  PointToPointProtocol,
+  ProtocolOptions,
+  SendResult,
+} from "./protocols.js";
+
+export interface ILightPush extends PointToPointProtocol {
+  push: (
+    encoder: IEncoder,
+    message: IMessage,
+    opts?: ProtocolOptions
+  ) => Promise<SendResult>;
+}

package/src/message.ts

@@ -0,0 +1,52 @@
+export interface IRateLimitProof {
+  proof: Uint8Array;
+  merkleRoot: Uint8Array;
+  epoch: Uint8Array;
+  shareX: Uint8Array;
+  shareY: Uint8Array;
+  nullifier: Uint8Array;
+  rlnIdentifier: Uint8Array;
+}
+
+/**
+ * Interface matching the protobuf library.
+ * Field types matches the protobuf type over the wire
+ */
+export interface IProtoMessage {
+  payload: Uint8Array | undefined;
+  contentTopic: string | undefined;
+  version: number | undefined;
+  timestamp: bigint | undefined;
+  rateLimitProof: IRateLimitProof | undefined;
+  ephemeral: boolean | undefined;
+}
+
+/**
+ * Interface for messages to encode and send.
+ */
+export interface IMessage {
+  payload?: Uint8Array;
+  timestamp?: Date;
+  rateLimitProof?: IRateLimitProof;
+}
+
+export interface IEncoder {
+  contentTopic: string;
+  ephemeral: boolean;
+  toWire: (message: IMessage) => Promise<Uint8Array | undefined>;
+  toProtoObj: (message: IMessage) => Promise<IProtoMessage | undefined>;
+}
+
+export interface IDecodedMessage {
+  payload: Uint8Array | undefined;
+  contentTopic: string | undefined;
+  timestamp: Date | undefined;
+  rateLimitProof: IRateLimitProof | undefined;
+  ephemeral: boolean | undefined;
+}
+
+export interface IDecoder<T extends IDecodedMessage> {
+  contentTopic: string;
+  fromWireToProtoObj: (bytes: Uint8Array) => Promise<IProtoMessage | undefined>;
+  fromProtoObj: (proto: IProtoMessage) => Promise<T | undefined>;
+}

package/src/peer_exchange.ts

@@ -0,0 +1,33 @@
+import type { ConnectionManager } from "@libp2p/interface-connection-manager";
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { PeerStore } from "@libp2p/interface-peer-store";
+import type { Registrar } from "@libp2p/interface-registrar";
+
+import { IEnr } from "./enr.js";
+import { PointToPointProtocol } from "./protocols.js";
+
+export interface IPeerExchange extends PointToPointProtocol {
+  query(
+    params: PeerExchangeQueryParams,
+    callback: (response: PeerExchangeResponse) => Promise<void> | void
+  ): Promise<void>;
+}
+
+export interface PeerExchangeQueryParams {
+  numPeers: number;
+  peerId?: PeerId;
+}
+
+export interface PeerExchangeResponse {
+  peerInfos: PeerInfo[];
+}
+
+export interface PeerInfo {
+  ENR?: IEnr;
+}
+
+export interface PeerExchangeComponents {
+  connectionManager: ConnectionManager;
+  peerStore: PeerStore;
+  registrar: Registrar;
+}

package/src/protocols.ts

@@ -0,0 +1,31 @@
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Peer, PeerStore } from "@libp2p/interface-peer-store";
+
+import type { IMessage } from "./message.js";
+
+export enum Protocols {
+  Relay = "relay",
+  Store = "store",
+  LightPush = "lightpush",
+  Filter = "filter",
+  PeerExchange = "peer-exchange",
+}
+
+export interface PointToPointProtocol {
+  peerStore: PeerStore;
+  peers: () => Promise<Peer[]>;
+}
+
+export type ProtocolOptions = {
+  pubSubTopic?: string;
+  /**
+   * Optionally specify an PeerId for the protocol request. If not included, will use a random peer.
+   */
+  peerId?: PeerId;
+};
+
+export type Callback<T extends IMessage> = (msg: T) => void | Promise<void>;
+
+export interface SendResult {
+  recipients: PeerId[];
+}

package/src/relay.ts

@@ -0,0 +1,18 @@
+import type { GossipSub } from "@chainsafe/libp2p-gossipsub";
+
+import type {
+  IDecodedMessage,
+  IDecoder,
+  IEncoder,
+  IMessage,
+} from "./message.js";
+import type { Callback, SendResult } from "./protocols.js";
+
+export interface IRelay extends GossipSub {
+  send: (encoder: IEncoder, message: IMessage) => Promise<SendResult>;
+  addObserver: <T extends IDecodedMessage>(
+    decoder: IDecoder<T>,
+    callback: Callback<T>
+  ) => () => void;
+  getMeshPeers: () => string[];
+}

package/src/store.ts

@@ -0,0 +1,70 @@
+import type { IDecodedMessage, IDecoder } from "./message.js";
+import type { PointToPointProtocol, ProtocolOptions } from "./protocols.js";
+
+export enum PageDirection {
+  BACKWARD = "backward",
+  FORWARD = "forward",
+}
+
+export interface TimeFilter {
+  startTime: Date;
+  endTime: Date;
+}
+
+export interface Index {
+  digest?: Uint8Array;
+  receivedTime?: bigint;
+  senderTime?: bigint;
+  pubsubTopic?: string;
+}
+
+export type Cursor = {
+  digest?: Uint8Array;
+  senderTime?: bigint;
+  pubsubTopic?: string;
+};
+
+export type StoreQueryOptions = {
+  /**
+   * The direction in which pages are retrieved:
+   * - { @link PageDirection.BACKWARD }: Most recent page first.
+   * - { @link PageDirection.FORWARD }: Oldest page first.
+   *
+   * Note: This does not affect the ordering of messages with the page
+   * (the oldest message is always first).
+   *
+   * @default { @link PageDirection.BACKWARD }
+   */
+  pageDirection?: PageDirection;
+  /**
+   * The number of message per page.
+   */
+  pageSize?: number;
+  /**
+   * Retrieve messages with a timestamp within the provided values.
+   */
+  timeFilter?: TimeFilter;
+  /**
+   * Cursor as an index to start a query from.
+   */
+  cursor?: Cursor;
+} & ProtocolOptions;
+
+export interface IStore extends PointToPointProtocol {
+  queryOrderedCallback: <T extends IDecodedMessage>(
+    decoders: IDecoder<T>[],
+    callback: (message: T) => Promise<void | boolean> | boolean | void,
+    options?: StoreQueryOptions
+  ) => Promise<void>;
+  queryCallbackOnPromise: <T extends IDecodedMessage>(
+    decoders: IDecoder<T>[],
+    callback: (
+      message: Promise<T | undefined>
+    ) => Promise<void | boolean> | boolean | void,
+    options?: StoreQueryOptions
+  ) => Promise<void>;
+  queryGenerator: <T extends IDecodedMessage>(
+    decoders: IDecoder<T>[],
+    options?: StoreQueryOptions
+  ) => AsyncGenerator<Promise<T | undefined>[]>;
+}

package/src/waku.ts

@@ -0,0 +1,52 @@
+import type { Stream } from "@libp2p/interface-connection";
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Multiaddr } from "@multiformats/multiaddr";
+import type { Libp2p } from "libp2p";
+
+import type { IFilter } from "./filter.js";
+import type { ILightPush } from "./light_push.js";
+import type { IPeerExchange } from "./peer_exchange.js";
+import { Protocols } from "./protocols.js";
+import type { IRelay } from "./relay.js";
+import type { IStore } from "./store.js";
+
+export interface Waku {
+  libp2p: Libp2p;
+  relay?: IRelay;
+  store?: IStore;
+  filter?: IFilter;
+  lightPush?: ILightPush;
+  peerExchange?: IPeerExchange;
+
+  dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>;
+
+  start(): Promise<void>;
+
+  stop(): Promise<void>;
+
+  isStarted(): boolean;
+}
+
+export interface LightNode extends Waku {
+  relay: undefined;
+  store: IStore;
+  filter: IFilter;
+  lightPush: ILightPush;
+  peerExchange: IPeerExchange;
+}
+
+export interface RelayNode extends Waku {
+  relay: IRelay;
+  store: undefined;
+  filter: undefined;
+  lightPush: undefined;
+  peerExchange: undefined;
+}
+
+export interface FullNode extends Waku {
+  relay: IRelay;
+  store: IStore;
+  filter: IFilter;
+  lightPush: ILightPush;
+  peerExchange: IPeerExchange;
+}