waku-org/js-waku
1
0
Fork 0
mirror of https://github.com/waku-org/js-waku.git synced 2025-02-22 17:18:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

implement generics for interfaces and functions re v1 vs v2

Browse Source
This commit is contained in:
danisharora099 2023-04-26 13:36:40 +05:30
parent 0dcbc72655
commit 833b910915
No known key found for this signature in database
GPG Key ID: FBD2BF500037F135
2 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
packages/create/src/index.ts
View File

@ -41,13 +41,17 @@ export { Libp2pComponents };
/**
* Create a Waku node that uses Waku Light Push, Filter and Store to send and
* receive messages, enabling low resource consumption.
* Implements generics to allow for conditional type checking for Filter V1 and V2 protocols.
* If useFilterV2 is set to true, the node will use Filter V2 protocol and the return type on `LightNode` will be set to `true`.
* If useFilterV2 is set to false or undefined, the node will use Filter V1 protocol and the return type on `LightNode` will be set to `false`.
*
* **Note: This is NOT compatible with nwaku v0.11**
*
* @see https://github.com/status-im/nwaku/issues/1085
*/
export async function createLightNode(
options?: ProtocolCreateOptions & WakuOptions
): Promise<LightNode> {
export async function createLightNode<FilterV2 extends boolean = false>(
options?: ProtocolCreateOptions & WakuOptions & { useFilterV2?: FilterV2 }
): Promise<LightNode<FilterV2 extends true ? true : false>> {
const libp2pOptions = options?.libp2p ?? {};
const peerDiscovery = libp2pOptions.peerDiscovery ?? [];
if (options?.defaultBootstrap) {
@ -65,10 +69,11 @@ export async function createLightNode(
const lightPush = wakuLightPush(options);
let filter: (libp2p: Libp2p) => IFilterV1 | IFilterV2;
if (!options?.useFilterV2) {
filter = wakuFilter(options);
if (options?.useFilterV2) {
filter = wakuFilterV2(options) as (libp2p: Libp2p) => IFilterV2;
} else {
filter = wakuFilterV2(options);
filter = wakuFilter(options) as (libp2p: Libp2p) => IFilterV1;
}
return new WakuNode(
@ -77,7 +82,7 @@ export async function createLightNode(
store,
lightPush,
filter
) as LightNode;
) as LightNode<FilterV2 extends true ? true : false>;
}
/**
@ -114,6 +119,9 @@ export async function createRelayNode(
/**
* Create a Waku node that uses all Waku protocols.
* Implements generics to allow for conditional type checking for Filter V1 and V2 protocols.
* If useFilterV2 is set to true, the node will use Filter V2 protocol and the return type on `LightNode` will be set to `true`.
* If useFilterV2 is set to false or undefined, the node will use Filter V1 protocol and the return type on `LightNode` will be set to `false`.
*
* This helper is not recommended except if:
* - you are interfacing with nwaku v0.11 or below
@ -125,9 +133,9 @@ export async function createRelayNode(
* @see https://github.com/status-im/nwaku/issues/1085
* @internal
*/
export async function createFullNode(
export async function createFullNode<FilterV2 extends boolean = false>(
options?: ProtocolCreateOptions & WakuOptions & Partial<RelayCreateOptions>
): Promise<FullNode> {
): Promise<FullNode<FilterV2 extends true ? true : false>> {
const libp2pOptions = options?.libp2p ?? {};
const peerDiscovery = libp2pOptions.peerDiscovery ?? [];
if (options?.defaultBootstrap) {
@ -160,7 +168,7 @@ export async function createFullNode(
lightPush,
filter,
relay
) as FullNode;
) as FullNode<FilterV2 extends true ? true : false>;
}
export function defaultPeerDiscovery(): (

8
packages/interfaces/src/waku.ts
View File

@ -25,10 +25,10 @@ export interface Waku {
isStarted(): boolean;
}
export interface LightNode extends Waku {
export interface LightNode<FilterV2 extends boolean = false> extends Waku {
relay: undefined;
store: IStore;
filter: IFilterV1 | IFilterV2;
filter: FilterV2 extends true ? IFilterV2 : IFilterV1;
lightPush: ILightPush;
}
@ -39,9 +39,9 @@ export interface RelayNode extends Waku {
lightPush: undefined;
}
export interface FullNode extends Waku {
export interface FullNode<FilterV2 extends boolean = false> extends Waku {
relay: IRelay;
store: IStore;
filter: IFilterV1 | IFilterV2;
filter: FilterV2 extends true ? IFilterV2 : IFilterV1;
lightPush: ILightPush;
}