@waku/relay
Version:
Relay Protocol for Waku
14 lines (13 loc) • 779 B
TypeScript
import type { CreateNodeOptions, RelayNode } from "@waku/interfaces";
import { RelayCreateOptions } from "./relay.js";
/**
* Create a Waku node that uses Waku Relay to send and receive messages,
* enabling some privacy preserving properties.
* * @remarks
* This function creates a Relay Node using the Waku Relay protocol.
* While it is technically possible to use this function in a browser environment,
* it is not recommended due to potential performance issues and limited browser capabilities.
* If you are developing a browser-based application, consider alternative approaches like creating a Light Node
* or use this function with caution.
*/
export declare function createRelayNode(options: CreateNodeOptions & Partial<RelayCreateOptions>): Promise<RelayNode>;