Crate pkarr

Expand description

§Pkarr

Rust implementation of Pkarr for publishing and resolving DNS packets over Mainline DHT.

Asynchronous by Default: Built on async/await for optimal performance
Blocking API Available: Use Client::as_blocking() for synchronous operations
Runtime Agnostic: Compatible with non-Tokio runtimes via async_compat

Browser Environment: Designed for JavaScript/Wasm integration
Relay Communication: Uses browser’s Fetch API for relay calls
Limitations:
- Not compatible with WASI
- Cannot use WASI bindings for direct DHT access

dht (enabled by default) — Enable the Client with mainline support.
relays (enabled by default) — Enables Client with Relays.
lmdb-cache — Use LmdbCache implementation. Only available if the client module is enabled.
endpoints — Enables endpoints spec.

Only available if the client module is enabled.
tls — Enables tls spec.

Only available if the client module is enabled.
reqwest-resolve — Use reqwest::dns::Resolve trait implementation for Client.

Only available if the client module is enabled.
reqwest-builder — Create a reqwest::ClientBuilder from Client.

Only available if the client module is enabled.
full-client (enabled by default) — Use all features
extra — Extra features that might benefit most but not all developers building apps using Pkarr.

Only available if the client module is enabled.
full — Use all features including the full-client and extra features.
__client (enabled by default) — Enable client dependencies.

Does not enable anything on its own you need to enable either dht and/or relays to enable the Client.

Except in WASM where you have to enable relays, while dht does not do anything.

errors: Exported errors
extra: Extra features that might benefit most but not all developers building apps using Pkarr.

Client: Pkarr client for publishing and resolving SignedPackets over mainline Dht and/or Relays.
ClientBlocking: A blocking (synchronous) version of Client.
ClientBuilder: A builder for constructing a Client with custom configuration.
InMemoryCache: A thread safe wrapper around lru::LruCache
Keypair: Ed25519 keypair to sign dns Packets.
PublicKey: Ed25519 public key to verify a signature over dns Packets.
SignedPacket: Signed DNS packet
SignedPacketBuilder: A builder for SignedPacket with many convenient methods, see SignedPacket::builder documentation for examples of how to use this builder.
Timestamp: Strictly monotonic timestamp since SystemTime::UNIX_EPOCH in microseconds.