Glossary
Short definitions for identities, addresses, connections, streams, events, and endpoint lifecycle.
Definitions only. For recipes, follow the linked guides.
| Term | Meaning |
|---|---|
| Endpoint | A running minip2p peer. Rust names the type Endpoint; TypeScript names it Minip2p. |
Minip2p |
The TypeScript endpoint type returned by Minip2p.create or useMinip2p. |
| PeerId | Authenticated public-key identity of a peer. |
| Multiaddr | Transport address without a peer identity (for example /ip4/…/udp/…/quic-v1 or /ip4/…/tcp/…). |
| PeerAddr | A Multiaddr plus a terminal /p2p/<peer-id>. Required for dialing a specific peer. |
| PeerReady | Event after the first Identify exchange; supplies advertised protocols. open_stream is already allowed once connected. |
| Connection attempt | One application-level effort to reach a peer. It has one Connect ID and exactly one terminal: connected, failed, or cancelled. |
| Connect ID | Correlation id for a Connection attempt, including its direct dials, relay fallback, and upgrade. |
| Relay leg | NAT-owned part of an attempt: relay dial, HOP CONNECT, bridge promotion, DCUtR. Does not decide the terminal. |
| Path | NAT result: DirectDialed, DirectPunched, or Relayed. A Relayed path may be provisional until the attempt settles. See Traverse NAT. |
| Stream | A negotiated byte stream for one application protocol. Writes may be split or combined, so applications add their own framing. |
useMinip2p |
React hook that owns an endpoint for a component and closes it during cleanup. |
queueOverflow |
TypeScript event reporting that the application did not consume events quickly enough. Refresh queryable state before relying on event history. |
| Sans-I/O | Deterministic protocol/orchestration state machines; sockets and clocks live in adapters. |
poll |
One non-blocking drive step; returns currently available application events. |
wait |
Blocking Endpoint wait returning an event, deadline, or interruption (ADR 0007). |
EndpointEvent |
Ordered application event from the Endpoint’s single public stream. |
| State snapshot | Getter over durable connection, peer, or transport-bound address state; not one atomic mega-snapshot and may be ahead of the event stream. bound_addresses is bound sockets, not “accepting connections”. |
next_event |
Synchronous drive until one ordinary application event or a deadline (swallows interruption; migration). |
next_wake |
Interruptible drive until an application event, capability progress, interruption, or deadline. |
| Focused wait | Drive until a specific result (wait_peer_ready, nat_wait_path, next_gossipsub_event, …) while buffering unrelated events. |
| Available vs enabled | A Cargo feature makes a capability available; a builder method enables it on an endpoint. See Install. |
| Circuit address | /…/p2p/<relay>/p2p-circuit/p2p/<target> reaches a peer through a Circuit Relay v2 reservation. |
For symptom-driven fixes, see Rust troubleshooting or TypeScript troubleshooting. For APIs grouped by feature, see the feature matrix.