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

Interface: RelayNodeOptions

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

Options for createRelayNode.

Properties

identity?

optional identity?: PrivateKey | { path: string; }

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

Same semantics as the adapter's identity. PERSIST IT: every server's { relay } addr embeds this node's peer ID, so an ephemeral key invalidates them all on restart.

---

listen?

optional listen?: string[]

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

Listen multiaddrs. Defaults to ['/ip4/0.0.0.0/tcp/<port>/ws'].

---

port?

optional port?: number

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

TCP port of the WebSocket listener. Defaults to 9000. Ignored when listen is given.

---

relay?

optional relay?: CircuitRelayServerInit

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

circuit-relay-v2 server tuning (reservation limits etc.), passed through.

---

topic?

optional topic?: string

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

Adapter topic of the cluster this relay serves (default 'super-line/v1') — only used to derive the <topic>/_peer-discovery gossip topic the relay bridges.