Documentation / @super-line/adapter-libp2p / createRelayNode

Function: createRelayNode()

createRelayNode(options?): Promise<Libp2p<ServiceMap>>

Defined in: packages/adapter-libp2p/src/index.ts:397

Run the one public rendezvous node a { relay } discovery strategy points at. It does two jobs on a single WebSocket-reachable libp2p node: a circuit-relay-v2 server (NAT'd nodes reserve a slot and become dialable via /p2p-circuit) and a gossipsub bridge for the peer-discovery topic (listenOnly — it forwards without advertising itself). Adapter traffic never routes through its pubsub: servers mesh directly over their circuit (or DCUtR-upgraded) connections.

Parameters

options?

RelayNodeOptions = {}

Returns

Promise<Libp2p<ServiceMap>>

Example

const relay = await createRelayNode({ port: 9000, identity: { path: './relay-key' } })
console.log(relay.getMultiaddrs().map(String)) // hand this to every server's `discovery.relay`