Expand description
App-facing FIPS endpoint API.
Structs§
- Config
- Root configuration structure.
- Ethernet
Config - Ethernet transport instance configuration.
- Fips
Address - 128-bit FIPS address with IPv6-compatible format.
- Fips
Endpoint - A running embedded FIPS endpoint.
- Fips
Endpoint Builder - Builder for an embedded FIPS endpoint.
- Fips
Endpoint Direct Packet Batch - Established endpoint packet runs delivered without the endpoint-event queue.
- Fips
Endpoint Direct Packet Run - Consecutive direct endpoint packets from one authenticated FIPS source.
- Fips
Endpoint Direct Receiver - Blocking bounded receiver for authenticated direct endpoint packet runs.
- Fips
Endpoint Message - Source-attributed endpoint data delivered to an embedded application.
- Fips
Endpoint Peer - Authenticated FIPS peer state visible to an embedded application.
- Fips
Endpoint Relay Status - Live Nostr relay state visible to an embedded application.
- Fips
Endpoint Service Datagram - Authenticated FSP DataPacket service payload delivered to an embedder.
- Fips
Endpoint Service Receiver - Port-scoped receiver for one registered FSP service.
- Identity
- A FIPS node identity consisting of a keypair and derived identifiers.
- Node
Addr - 16-byte node identifier derived from truncated SHA-256(pubkey).
- Nostr
Discovery Config - Nostr-mediated overlay endpoint discovery (
node.discovery.nostr.*). - Peer
Address - A transport-specific address for reaching a peer.
- Peer
Config - Configuration for a known peer.
- Peer
Identity - A known peer’s identity (public key only, no signing capability).
- Recent
Peer - Authentication recency and reusable endpoints for one remote identity.
- Recent
Peer Endpoint - One previously authenticated, restart-safe transport endpoint.
- Recent
Peers - Store-agnostic version-1 recent-peer document.
- Recent
Peers File Store - A caller-scoped native file store for recently authenticated FIPS peers.
- Transports
Config - Transports configuration section.
- UdpConfig
- UDP transport instance configuration.
- Update
Peers Outcome - Reports what changed in response to
FipsEndpoint::update_peers. - WebSocket
Config - WebSocket physical transport configuration.
Enums§
- Connect
Policy - Connection policy for a peer.
- Fips
Endpoint Direct Delivery Error - Error returned by an installed direct endpoint sink.
- Fips
Endpoint Error - Errors returned by the endpoint API.
- Identity
Error - Errors that can occur in identity operations.
- Nostr
Discovery Policy - Nostr advert discovery policy.
- Nostr
Peerfinding Source - Source used to publish and receive Nostr peer adverts.
- Peer
Address Provenance - How a peer address became trusted for dialing.
- Recent
Peer Transport - Transport kinds allowed in the version-1 recent-peer schema.
- Recent
Peers Error - Validation or JSON codec error for a recent-peer document.
- Recent
Peers File Error - Error loading or saving a
RecentPeersfile. - Routing
Mode - Daemon routing mode.
- Transport
Instances - Transport instances - either a single config or named instances.
Constants§
- FIPS_
ENDPOINT_ DIRECT_ PACKET_ QUEUE_ MAX_ PACKETS - Maximum endpoint packets pending in an installed direct packet sink.
- FIPS_
ENDPOINT_ DIRECT_ PACKET_ RUN_ MAX_ PACKETS - Maximum endpoint packets in one authenticated direct packet run.
- RECENT_
PEERS_ MAX_ ENDPOINTS_ PER_ PEER - Maximum number of restart endpoints retained for one remote identity.
- RECENT_
PEERS_ MAX_ PEERS - Maximum number of remote identities retained in one cache.
- RECENT_
PEERS_ VERSION - Current recent-peers JSON schema version.
Traits§
- Fips
Endpoint Direct Sink - Application-provided direct dataplane endpoint delivery sink.
Functions§
- decode_
npub - Decode an npub string to an x-only public key.
- decode_
nsec - Decode an nsec string to a secret key.
- decode_
secret - Decode a secret key from either nsec (bech32) or hex format.
- encode_
npub - Encode an x-only public key as a bech32 npub string (NIP-19).
- encode_
nsec - Encode a secret key as a bech32 nsec string (NIP-19).
Type Aliases§
- Fips
Endpoint Data - Endpoint data bytes delivered by FIPS.