@waku/interfaces 0.0.29-5674b0e.0 → 0.0.29-8a6571f.0

package/dist/protocols.d.ts

@@ -1,10 +1,13 @@
 import type { Libp2p } from "@libp2p/interface";
 import type { PeerId } from "@libp2p/interface";
-import type { Peer } from "@libp2p/interface";
+import type { ConnectionManagerOptions } from "./connection_manager.js";
+import type { FilterProtocolOptions } from "./filter.js";
 import type { CreateLibp2pOptions } from "./libp2p.js";
+import type { LightPushProtocolOptions } from "./light_push.js";
 import type { IDecodedMessage } from "./message.js";
-import { ThisAndThat, ThisOrThat } from "./misc.js";
-import { AutoSharding, StaticSharding } from "./sharding.js";
+import type { ThisAndThat, ThisOrThat } from "./misc.js";
+import type { AutoSharding, StaticSharding } from "./sharding.js";
+import type { StoreProtocolOptions } from "./store.js";
 export declare enum Protocols {
     Relay = "relay",
     Store = "store",
@@ -13,43 +16,24 @@ export declare enum Protocols {
 }
 export type IBaseProtocolCore = {
     multicodec: string;
-    allPeers: () => Promise<Peer[]>;
-    connectedPeers: () => Promise<Peer[]>;
     addLibp2pEventListener: Libp2p["addEventListener"];
     removeLibp2pEventListener: Libp2p["removeEventListener"];
 };
-export type IBaseProtocolSDK = {
-    readonly connectedPeers: Peer[];
-    renewPeer: (peerToDisconnect: PeerId) => Promise<Peer | undefined>;
-    readonly numPeersToUse: number;
-};
 export type NetworkConfig = StaticSharding | AutoSharding;
-/**
- * Options for using LightPush and Filter
- */
-export type ProtocolUseOptions = {
-    /**
-     * Optional flag to force using all available peers
-     */
-    forceUseAllPeers?: boolean;
+export type CreateNodeOptions = {
     /**
-     * Optional maximum number of attempts for exponential backoff
+     * Set the user agent string to be used in identification of the node.
+     *
+     * @default "js-waku"
      */
-    maxAttempts?: number;
-};
-export type ProtocolCreateOptions = {
+    userAgent?: string;
     /**
-     * Configuration for determining the network in use.
+     * Starts Waku node automatically upon creations.
+     * Calls {@link @waku/sdk!WakuNode.start} before returning {@link @waku/sdk!WakuNode}
      *
-     * If using Static Sharding:
-     * Default value is configured for The Waku Network.
-     * The format to specify a shard is: clusterId: number, shards: number[]
-     * To learn more about the sharding specification, see [Relay Sharding](https://rfc.vac.dev/spec/51/).
-     *
-     * If using Auto Sharding:
-     * See [Waku v2 Topic Usage Recommendations](https://github.com/vacp2p/rfc-index/blob/main/waku/informational/23/topics.md#content-topics) for details.
-     * You cannot add or remove content topics after initialization of the node.
+     * @default true
      */
+    autoStart?: boolean;
     /**
      * Configuration for determining the network in use.
      * Network configuration refers to the shards and clusters used in the network.
@@ -78,10 +62,9 @@ export type ProtocolCreateOptions = {
     libp2p?: Partial<CreateLibp2pOptions>;
     /**
      * Number of peers to connect to, for the usage of the protocol.
-     * This is used by:
-     * - Light Push to send messages,
-     * - Filter to retrieve messages.
-     * Defaults to 2.
+     * This is used by Filter to retrieve messages.
+     *
+     * @default 2.
      */
     numPeersToUse?: number;
     /**
@@ -99,52 +82,43 @@ export type ProtocolCreateOptions = {
      */
     bootstrapPeers?: string[];
     /**
-     * List of nodes' multiaddrs as strings to use for each protocol. If not specified, random nodes will be used.
-     * This should be used only if you know what you are doing.
+     * Configuration for connection manager.
+     * If not specified - default values are applied.
      */
-    nodeToUse?: {
-        store?: string;
-    };
-};
-export type Callback<T extends IDecodedMessage> = (msg: T) => void | Promise<void>;
-export declare enum ProtocolError {
-    /** Could not determine the origin of the fault. Best to check connectivity and try again */
-    GENERIC_FAIL = "Generic error",
+    connectionManager?: Partial<ConnectionManagerOptions>;
     /**
-     * Failure to protobuf encode the message. This is not recoverable and needs
-     * further investigation.
+     * Configuration for Filter protocol.
+     * If not specified - default values are applied.
      */
-    ENCODE_FAILED = "Failed to encode",
+    filter?: Partial<FilterProtocolOptions>;
     /**
-     * Failure to protobuf decode the message. May be due to a remote peer issue,
-     * ensuring that messages are sent via several peer enable mitigation of this error.
+     * Options for the Store protocol.
+     * If not specified - default values are applied.
      */
-    DECODE_FAILED = "Failed to decode",
+    store?: Partial<StoreProtocolOptions>;
     /**
-     * The message payload is empty, making the message invalid. Ensure that a non-empty
-     * payload is set on the outgoing message.
-     */
-    EMPTY_PAYLOAD = "Payload is empty",
-    /**
-     * The message size is above the maximum message size allowed on the Waku Network.
-     * Compressing the message or using an alternative strategy for large messages is recommended.
+     * Options for the LightPush protocol.
+     * If not specified - default values are applied.
      */
-    SIZE_TOO_BIG = "Size is too big",
+    lightPush?: Partial<LightPushProtocolOptions>;
+};
+export type Callback<T extends IDecodedMessage> = (msg: T) => void | Promise<void>;
+export declare enum ProtocolError {
     /**
-     * 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",
+     * Could not determine the origin of the fault. Best to check connectivity and try again
+     * */
+    GENERIC_FAIL = "Generic error",
     /**
-     * The pubsub topic configured on the decoder does not match the pubsub topic setup on the protocol.
-     * Ensure that the pubsub topic used for decoder creation is the same as the one used for protocol.
+     * The remote peer rejected the message. Information provided by the remote peer
+     * is logged. Review message validity, or mitigation for `NO_PEER_AVAILABLE`
+     * or `DECODE_FAILED` can be used.
      */
-    TOPIC_DECODER_MISMATCH = "Topic decoder mismatch",
+    REMOTE_PEER_REJECTED = "Remote peer rejected",
     /**
-     * The topics passed in the decoders do not match each other, or don't exist at all.
-     * Ensure that all the pubsub topics used in the decoders are valid and match each other.
+     * Failure to protobuf decode the message. May be due to a remote peer issue,
+     * ensuring that messages are sent via several peer enable mitigation of this error.
      */
-    INVALID_DECODER_TOPICS = "Invalid decoder topics",
+    DECODE_FAILED = "Failed to decode",
     /**
      * Failure to find a peer with suitable protocols. This may due to a connection issue.
      * Mitigation can be: retrying after a given time period, display connectivity issue
@@ -163,36 +137,44 @@ export declare enum ProtocolError {
      */
     NO_RESPONSE = "No response received",
     /**
-     * The remote peer rejected the message. Information provided by the remote peer
-     * is logged. Review message validity, or mitigation for `NO_PEER_AVAILABLE`
-     * or `DECODE_FAILED` can be used.
+     * Failure to protobuf encode the message. This is not recoverable and needs
+     * further investigation.
      */
-    REMOTE_PEER_REJECTED = "Remote peer rejected",
+    ENCODE_FAILED = "Failed to encode",
     /**
-     * The protocol request timed out without a response. This may be due to a connection issue.
-     * Mitigation can be: retrying after a given time period
+     * The message payload is empty, making the message invalid. Ensure that a non-empty
+     * payload is set on the outgoing message.
      */
-    REQUEST_TIMEOUT = "Request timeout",
+    EMPTY_PAYLOAD = "Payload is empty",
     /**
-     * Missing credentials info message.
-     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L186
+     * The message size is above the maximum message size allowed on the Waku Network.
+     * Compressing the message or using an alternative strategy for large messages is recommended.
      */
-    RLN_IDENTITY_MISSING = "Identity credentials are not set",
+    SIZE_TOO_BIG = "Size is too big",
     /**
-     * Membership index missing info message.
-     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L188
+     * 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.
      */
-    RLN_MEMBERSHIP_INDEX = "Membership index is not set",
+    TOPIC_NOT_CONFIGURED = "Topic not configured",
     /**
-     * Message limit is missing.
-     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L190
+     * Fails when
      */
-    RLN_LIMIT_MISSING = "User message limit is not set",
+    STREAM_ABORTED = "Stream aborted",
     /**
      * General proof generation error message.
      * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L201C19-L201C42
      */
-    RLN_PROOF_GENERATION = "Proof generation failed"
+    RLN_PROOF_GENERATION = "Proof generation failed",
+    /**
+     * The pubsub topic configured on the decoder does not match the pubsub topic setup on the protocol.
+     * Ensure that the pubsub topic used for decoder creation is the same as the one used for protocol.
+     */
+    TOPIC_DECODER_MISMATCH = "Topic decoder mismatch",
+    /**
+     * The topics passed in the decoders do not match each other, or don't exist at all.
+     * Ensure that all the pubsub topics used in the decoders are valid and match each other.
+     */
+    INVALID_DECODER_TOPICS = "Invalid decoder topics"
 }
 export interface Failure {
     error: ProtocolError;

package/dist/protocols.js

@@ -7,43 +7,24 @@ export var Protocols;
 })(Protocols || (Protocols = {}));
 export var ProtocolError;
 (function (ProtocolError) {
-    /** Could not determine the origin of the fault. Best to check connectivity and try again */
+    //
+    // GENERAL ERRORS SECTION
+    //
+    /**
+     * Could not determine the origin of the fault. Best to check connectivity and try again
+     * */
     ProtocolError["GENERIC_FAIL"] = "Generic error";
     /**
-     * Failure to protobuf encode the message. This is not recoverable and needs
-     * further investigation.
+     * The remote peer rejected the message. Information provided by the remote peer
+     * is logged. Review message validity, or mitigation for `NO_PEER_AVAILABLE`
+     * or `DECODE_FAILED` can be used.
      */
-    ProtocolError["ENCODE_FAILED"] = "Failed to encode";
+    ProtocolError["REMOTE_PEER_REJECTED"] = "Remote peer rejected";
     /**
      * Failure to protobuf decode the message. May be due to a remote peer issue,
      * ensuring that messages are sent via several peer enable mitigation of this error.
      */
     ProtocolError["DECODE_FAILED"] = "Failed to decode";
-    /**
-     * The message payload is empty, making the message invalid. Ensure that a non-empty
-     * payload is set on the outgoing message.
-     */
-    ProtocolError["EMPTY_PAYLOAD"] = "Payload is empty";
-    /**
-     * The message size is above the maximum message size allowed on the Waku Network.
-     * Compressing the message or using an alternative strategy for large messages is recommended.
-     */
-    ProtocolError["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.
-     */
-    ProtocolError["TOPIC_NOT_CONFIGURED"] = "Topic not configured";
-    /**
-     * The pubsub topic configured on the decoder does not match the pubsub topic setup on the protocol.
-     * Ensure that the pubsub topic used for decoder creation is the same as the one used for protocol.
-     */
-    ProtocolError["TOPIC_DECODER_MISMATCH"] = "Topic decoder mismatch";
-    /**
-     * The topics passed in the decoders do not match each other, or don't exist at all.
-     * Ensure that all the pubsub topics used in the decoders are valid and match each other.
-     */
-    ProtocolError["INVALID_DECODER_TOPICS"] = "Invalid decoder topics";
     /**
      * Failure to find a peer with suitable protocols. This may due to a connection issue.
      * Mitigation can be: retrying after a given time period, display connectivity issue
@@ -61,36 +42,50 @@ export var ProtocolError;
      * or `DECODE_FAILED` can be used.
      */
     ProtocolError["NO_RESPONSE"] = "No response received";
+    //
+    // SEND ERRORS SECTION
+    //
     /**
-     * The remote peer rejected the message. Information provided by the remote peer
-     * is logged. Review message validity, or mitigation for `NO_PEER_AVAILABLE`
-     * or `DECODE_FAILED` can be used.
+     * Failure to protobuf encode the message. This is not recoverable and needs
+     * further investigation.
      */
-    ProtocolError["REMOTE_PEER_REJECTED"] = "Remote peer rejected";
+    ProtocolError["ENCODE_FAILED"] = "Failed to encode";
     /**
-     * The protocol request timed out without a response. This may be due to a connection issue.
-     * Mitigation can be: retrying after a given time period
+     * The message payload is empty, making the message invalid. Ensure that a non-empty
+     * payload is set on the outgoing message.
      */
-    ProtocolError["REQUEST_TIMEOUT"] = "Request timeout";
+    ProtocolError["EMPTY_PAYLOAD"] = "Payload is empty";
     /**
-     * Missing credentials info message.
-     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L186
+     * The message size is above the maximum message size allowed on the Waku Network.
+     * Compressing the message or using an alternative strategy for large messages is recommended.
      */
-    ProtocolError["RLN_IDENTITY_MISSING"] = "Identity credentials are not set";
+    ProtocolError["SIZE_TOO_BIG"] = "Size is too big";
     /**
-     * Membership index missing info message.
-     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L188
+     * 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.
      */
-    ProtocolError["RLN_MEMBERSHIP_INDEX"] = "Membership index is not set";
+    ProtocolError["TOPIC_NOT_CONFIGURED"] = "Topic not configured";
     /**
-     * Message limit is missing.
-     * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L190
+     * Fails when
      */
-    ProtocolError["RLN_LIMIT_MISSING"] = "User message limit is not set";
+    ProtocolError["STREAM_ABORTED"] = "Stream aborted";
     /**
      * General proof generation error message.
      * nwaku: https://github.com/waku-org/nwaku/blob/c3cb06ac6c03f0f382d3941ea53b330f6a8dd127/waku/waku_rln_relay/group_manager/group_manager_base.nim#L201C19-L201C42
      */
     ProtocolError["RLN_PROOF_GENERATION"] = "Proof generation failed";
+    //
+    // RECEIVE ERRORS SECTION
+    //
+    /**
+     * The pubsub topic configured on the decoder does not match the pubsub topic setup on the protocol.
+     * Ensure that the pubsub topic used for decoder creation is the same as the one used for protocol.
+     */
+    ProtocolError["TOPIC_DECODER_MISMATCH"] = "Topic decoder mismatch";
+    /**
+     * The topics passed in the decoders do not match each other, or don't exist at all.
+     * Ensure that all the pubsub topics used in the decoders are valid and match each other.
+     */
+    ProtocolError["INVALID_DECODER_TOPICS"] = "Invalid decoder topics";
 })(ProtocolError || (ProtocolError = {}));
 //# sourceMappingURL=protocols.js.map

package/dist/protocols.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocols.js","sourceRoot":"","sources":["../src/protocols.ts"],"names":[],"mappings":"AASA,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;AA2GD,MAAM,CAAN,IAAY,aAsFX;AAtFD,WAAY,aAAa;IACvB,4FAA4F;IAC5F,+CAA8B,CAAA;IAC9B;;;OAGG;IACH,mDAAkC,CAAA;IAClC;;;OAGG;IACH,mDAAkC,CAAA;IAClC;;;OAGG;IACH,mDAAkC,CAAA;IAClC;;;OAGG;IACH,iDAAgC,CAAA;IAChC;;;OAGG;IACH,8DAA6C,CAAA;IAC7C;;;OAGG;IACH,kEAAiD,CAAA;IACjD;;;OAGG;IACH,kEAAiD,CAAA;IACjD;;;;;OAKG;IACH,wDAAuC,CAAA;IACvC;;;OAGG;IACH,4DAA2C,CAAA;IAC3C;;;OAGG;IACH,qDAAoC,CAAA;IACpC;;;;OAIG;IACH,8DAA6C,CAAA;IAC7C;;;OAGG;IACH,oDAAmC,CAAA;IACnC;;;OAGG;IACH,0EAAyD,CAAA;IACzD;;;OAGG;IACH,qEAAoD,CAAA;IACpD;;;OAGG;IACH,oEAAmD,CAAA;IACnD;;;OAGG;IACH,iEAAgD,CAAA;AAClD,CAAC,EAtFW,aAAa,KAAb,aAAa,QAsFxB"}
+{"version":3,"file":"protocols.js","sourceRoot":"","sources":["../src/protocols.ts"],"names":[],"mappings":"AAYA,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;AA4GD,MAAM,CAAN,IAAY,aA8FX;AA9FD,WAAY,aAAa;IACvB,EAAE;IACF,yBAAyB;IACzB,EAAE;IACF;;SAEK;IACL,+CAA8B,CAAA;IAE9B;;;;OAIG;IACH,8DAA6C,CAAA;IAE7C;;;OAGG;IACH,mDAAkC,CAAA;IAElC;;;;;OAKG;IACH,wDAAuC,CAAA;IAEvC;;;OAGG;IACH,4DAA2C,CAAA;IAE3C;;;OAGG;IACH,qDAAoC,CAAA;IAEpC,EAAE;IACF,sBAAsB;IACtB,EAAE;IACF;;;OAGG;IACH,mDAAkC,CAAA;IAElC;;;OAGG;IACH,mDAAkC,CAAA;IAElC;;;OAGG;IACH,iDAAgC,CAAA;IAEhC;;;OAGG;IACH,8DAA6C,CAAA;IAE7C;;OAEG;IACH,kDAAiC,CAAA;IAEjC;;;OAGG;IACH,iEAAgD,CAAA;IAEhD,EAAE;IACF,yBAAyB;IACzB,EAAE;IACF;;;OAGG;IACH,kEAAiD,CAAA;IAEjD;;;OAGG;IACH,kEAAiD,CAAA;AACnD,CAAC,EA9FW,aAAa,KAAb,aAAa,QA8FxB"}

package/dist/sender.d.ts

@@ -1,9 +1,9 @@
 import type { IEncoder, IMessage } from "./message.js";
 import { SDKProtocolResult } from "./protocols.js";
-export type ISenderOptions = {
+export type ISendOptions = {
     /**
      * Enables retry of a message that was failed to be sent.
-     * @default false
+     * @default true
      */
     autoRetry?: boolean;
     /**
@@ -13,5 +13,5 @@ export type ISenderOptions = {
     maxAttempts?: number;
 };
 export interface ISender {
-    send: (encoder: IEncoder, message: IMessage, sendOptions?: ISenderOptions) => Promise<SDKProtocolResult>;
+    send: (encoder: IEncoder, message: IMessage, sendOptions?: ISendOptions) => Promise<SDKProtocolResult>;
 }

package/dist/store.d.ts

@@ -1,5 +1,5 @@
 import type { IDecodedMessage, IDecoder } from "./message.js";
-import type { IBaseProtocolCore, IBaseProtocolSDK } from "./protocols.js";
+import type { IBaseProtocolCore } from "./protocols.js";
 export type StoreCursor = Uint8Array;
 /**
  * Parameters for a store query request, as specified in the Waku Store v3 RFC.
@@ -66,10 +66,13 @@ export type QueryRequestParams = {
     paginationLimit?: number;
 };
 export type IStoreCore = IBaseProtocolCore;
-export type IStore = IBaseProtocolSDK & {
+export type IStore = {
     protocol: IBaseProtocolCore;
     createCursor(message: IDecodedMessage): StoreCursor;
     queryGenerator: <T extends IDecodedMessage>(decoders: IDecoder<T>[], options?: Partial<QueryRequestParams>) => AsyncGenerator<Promise<T | undefined>[]>;
     queryWithOrderedCallback: <T extends IDecodedMessage>(decoders: IDecoder<T>[], callback: (message: T) => Promise<void | boolean> | boolean | void, options?: Partial<QueryRequestParams>) => Promise<void>;
     queryWithPromiseCallback: <T extends IDecodedMessage>(decoders: IDecoder<T>[], callback: (message: Promise<T | undefined>) => Promise<void | boolean> | boolean | void, options?: Partial<QueryRequestParams>) => Promise<void>;
 };
+export type StoreProtocolOptions = {
+    peer: string;
+};

package/dist/waku.d.ts

@@ -1,11 +1,11 @@
-import type { PeerId, Stream } from "@libp2p/interface";
+import type { Peer, PeerId, Stream } from "@libp2p/interface";
 import type { MultiaddrInput } from "@multiformats/multiaddr";
-import { IConnectionManager } from "./connection_manager.js";
+import type { IConnectionManager } from "./connection_manager.js";
 import type { IFilter } from "./filter.js";
-import { IHealthManager } from "./health_manager.js";
+import type { IHealthIndicator } from "./health_indicator.js";
 import type { Libp2p } from "./libp2p.js";
 import type { ILightPush } from "./light_push.js";
-import { Protocols } from "./protocols.js";
+import type { Protocols } from "./protocols.js";
 import type { IRelay } from "./relay.js";
 import type { IStore } from "./store.js";
 export interface IWaku {
@@ -14,8 +14,8 @@ export interface IWaku {
     store?: IStore;
     filter?: IFilter;
     lightPush?: ILightPush;
-    health: IHealthManager;
     connectionManager: IConnectionManager;
+    health: IHealthIndicator;
     /**
      * Returns a unique identifier for a node on the network.
      *
@@ -110,6 +110,10 @@ export interface IWaku {
      * @returns {boolean} `true` if the node has working connection and `false` otherwise
      */
     isConnected(): boolean;
+    /**
+     * @returns {Peer[]} an array of all connected peers
+     */
+    getConnectedPeers(): Promise<Peer[]>;
 }
 export interface LightNode extends IWaku {
     relay: undefined;

package/package.json

@@ -1 +1 @@
-{"name":"@waku/interfaces","version":"0.0.29-5674b0e.0","description":"Definition of Waku interfaces","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"type":"module","author":"Waku Team","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/interfaces#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralized","secure","communication","web3","ethereum","dapps","privacy"],"scripts":{"build":"run-s build:**","build:esm":"tsc","fix":"run-s fix:*","fix:lint":"eslint src --fix","check":"run-s check:*","check:lint":"eslint src","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","check:tsc":"tsc -p tsconfig.dev.json","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=20"},"devDependencies":{"@chainsafe/libp2p-gossipsub":"^14.1.0","@multiformats/multiaddr":"^12.0.0","cspell":"^8.6.1","npm-run-all":"^4.1.5","libp2p":"2.1.8"},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"],"dependencies":{"@waku/proto":"0.0.9-5674b0e.0"}}
+{"name":"@waku/interfaces","version":"0.0.29-8a6571f.0","description":"Definition of Waku interfaces","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"type":"module","author":"Waku Team","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/interfaces#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralized","secure","communication","web3","ethereum","dapps","privacy"],"scripts":{"build":"run-s build:**","build:esm":"tsc","fix":"run-s fix:*","fix:lint":"eslint src --fix","check":"run-s check:*","check:lint":"eslint src","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","check:tsc":"tsc -p tsconfig.dev.json","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=20"},"devDependencies":{"@chainsafe/libp2p-gossipsub":"^14.1.0","@multiformats/multiaddr":"^12.0.0","cspell":"^8.6.1","npm-run-all":"^4.1.5","libp2p":"2.1.8"},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"],"dependencies":{"@waku/proto":"0.0.9-8a6571f.0"}}

package/src/connection_manager.ts

@@ -8,22 +8,44 @@ export enum Tags {
   LOCAL = "local-peer-cache"
 }
 
-export interface ConnectionManagerOptions {
+export type ConnectionManagerOptions = {
   /**
-   * Number of attempts before a peer is considered non-dialable
-   * This is used to not spam a peer with dial attempts when it is not dialable
+   * Number of attempts before a peer is considered non-dialable.
+   * This is used to not spam a peer with dial attempts when it is not dialable.
+   *
+   * @default 3
    */
   maxDialAttemptsForPeer: number;
+
   /**
-   * Max number of bootstrap peers allowed to be connected to, initially
-   * This is used to increase intention of dialing non-bootstrap peers, found using other discovery mechanisms (like Peer Exchange)
+   * Max number of bootstrap peers allowed to be connected to initially.
+   * This is used to increase intention of dialing non-bootstrap peers, found using other discovery mechanisms (like Peer Exchange).
+   *
+   * @default 1
    */
   maxBootstrapPeersAllowed: number;
+
   /**
-   * Max number of parallel dials allowed
+   * Max number of parallel dials allowed.
+   *
+   * @default 3
    */
   maxParallelDials: number;
-}
+
+  /**
+   * Keep alive libp2p pings interval in seconds.
+   *
+   * @default 300 seconds
+   */
+  pingKeepAlive: number;
+
+  /**
+   * Gossip sub specific keep alive interval in seconds.
+   *
+   * @default 300 seconds
+   */
+  relayKeepAlive: number;
+};
 
 export enum EPeersByDiscoveryEvents {
   PEER_DISCOVERY_BOOTSTRAP = "peer:discovery:bootstrap",
@@ -63,7 +85,8 @@ export interface IConnectionStateEvents {
 
 export interface IConnectionManager
   extends TypedEventEmitter<IPeersByDiscoveryEvents & IConnectionStateEvents> {
-  configuredPubsubTopics: PubsubTopic[];
+  pubsubTopics: PubsubTopic[];
+  getConnectedPeers(codec?: string): Promise<Peer[]>;
   dropConnection(peerId: PeerId): Promise<void>;
   getPeersByDiscovery(): Promise<PeersByDiscoveryResult>;
   stop(): void;

package/src/filter.ts

@@ -5,9 +5,7 @@ import type { ContentTopic, ThisOrThat } from "./misc.js";
 import type {
   Callback,
   IBaseProtocolCore,
-  IBaseProtocolSDK,
   ProtocolError,
-  ProtocolUseOptions,
   SDKProtocolResult
 } from "./protocols.js";
 import type { IReceiver } from "./receiver.js";
@@ -17,17 +15,34 @@ export type SubscriptionCallback<T extends IDecodedMessage> = {
   callback: Callback<T>;
 };
 
-export type SubscribeOptions = {
-  keepAlive?: number;
-  pingsBeforePeerRenewed?: number;
-  enableLightPushFilterCheck?: boolean;
+export type FilterProtocolOptions = {
+  /**
+   * Interval with which Filter subscription will attempt to send ping requests to subscribed peers.
+   *
+   * @default 60_000
+   */
+  keepAliveIntervalMs: number;
+
+  /**
+   * Number of failed pings allowed to make to a remote peer before attempting to subscribe to a new one.
+   *
+   * @default 3
+   */
+  pingsBeforePeerRenewed: number;
+
+  /**
+   * Enables js-waku to send probe LightPush message over subscribed pubsubTopics on created subscription.
+   * In case message won't be received back through Filter - js-waku will attempt to subscribe to another peer.
+   *
+   * @default false
+   */
+  enableLightPushFilterCheck: boolean;
 };
 
 export interface ISubscription {
   subscribe<T extends IDecodedMessage>(
     decoders: IDecoder<T> | IDecoder<T>[],
-    callback: Callback<T>,
-    options?: SubscribeOptions
+    callback: Callback<T>
   ): Promise<SDKProtocolResult>;
 
   unsubscribe(contentTopics: ContentTopic[]): Promise<SDKProtocolResult>;
@@ -37,15 +52,12 @@ export interface ISubscription {
   unsubscribeAll(): Promise<SDKProtocolResult>;
 }
 
-export type IFilter = IReceiver &
-  IBaseProtocolSDK & { protocol: IBaseProtocolCore } & {
-    subscribe<T extends IDecodedMessage>(
-      decoders: IDecoder<T> | IDecoder<T>[],
-      callback: Callback<T>,
-      protocolUseOptions?: ProtocolUseOptions,
-      subscribeOptions?: SubscribeOptions
-    ): Promise<SubscribeResult>;
-  };
+export type IFilter = IReceiver & { protocol: IBaseProtocolCore } & {
+  subscribe<T extends IDecodedMessage>(
+    decoders: IDecoder<T> | IDecoder<T>[],
+    callback: Callback<T>
+  ): Promise<SubscribeResult>;
+};
 
 export type SubscribeResult = SubscriptionSuccess | SubscriptionError;
 

package/src/health_indicator.ts

@@ -0,0 +1,24 @@
+import { TypedEventEmitter } from "@libp2p/interface";
+
+import { Libp2p } from "./libp2p.js";
+
+export enum HealthStatusChangeEvents {
+  StatusChange = "health:change"
+}
+
+export enum HealthStatus {
+  Unhealthy = "Unhealthy",
+  MinimallyHealthy = "MinimallyHealthy",
+  SufficientlyHealthy = "SufficientlyHealthy"
+}
+
+export type HealthIndicatorEvents = {
+  [HealthStatusChangeEvents.StatusChange]: CustomEvent<HealthStatus>;
+};
+
+export interface IHealthIndicator
+  extends TypedEventEmitter<HealthIndicatorEvents> {}
+
+export type HealthIndicatorParams = {
+  libp2p: Libp2p;
+};

package/src/index.ts

@@ -12,10 +12,9 @@ export * from "./sender.js";
 export * from "./receiver.js";
 export * from "./misc.js";
 export * from "./libp2p.js";
-export * from "./keep_alive_manager.js";
 export * from "./dns_discovery.js";
 export * from "./metadata.js";
 export * from "./constants.js";
 export * from "./local_storage.js";
-export * from "./health_manager.js";
 export * from "./sharding.js";
+export * from "./health_indicator.js";

package/src/light_push.ts

@@ -1,4 +1,23 @@
 import { IBaseProtocolCore } from "./protocols.js";
-import type { ISender } from "./sender.js";
+import type { ISender, ISendOptions } from "./sender.js";
 
-export type ILightPush = ISender & { protocol: IBaseProtocolCore };
+export type LightPushProtocolOptions = ISendOptions & {
+  /**
+   * The interval in milliseconds to wait before retrying a failed push.
+   * @default 1000
+   */
+  retryIntervalMs: number;
+
+  /**
+   * Number of peers to send message to.
+   *
+   * @default 1
+   */
+  numPeersToUse?: number;
+};
+
+export type ILightPush = ISender & {
+  start: () => void;
+  stop: () => void;
+  protocol: IBaseProtocolCore;
+};