Crate pkarr

Pkarr

Rust implementation of Pkarr.

Publish and resolve DNS packets over Mainline DHT.

API Docs

Get started

Check the Examples.

Feature flags

• dht (enabled by default) — Use PkarrClient
• rand (enabled by default) — Use Keypair::random
• async — Use async versions of PkarrClient and/or PkarrRelayClient
• relay — Use PkarrRelayClient
• serde — Derive serde Serialize/Deserialize for PublicKey
• full — Use all features

Re-exports

• pub use bytes;
• pub use simple_dns as dns;
• pub use mainline;

Structs

• InMemoryPkarrCache
  A thread safe wrapper around LruCache
• Keypair
  Ed25519 keypair to sign dns Packets.
• PkarrClient
  Pkarr client for publishing and resolving SignedPackets over mainline.
• PkarrClientAsync
  Async version of PkarrClient
• PkarrClientBuilder
  Builder for PkarrClient
• PkarrRelayClient
  Pkarr client for publishing and resolving SignedPackets over relays.
• PkarrRelayClientAsync
• PublicKey
  Ed25519 public key to verify a signature over dns Packets.
• RelaySettings
  PkarrRelayClient’s settings
• Settings
  PkarrClient’s settings
• SignedPacket
  Signed DNS packet

Enums

• Error
  Pkarr crate error enum.

Constants

• DEFAULT_CACHE_SIZE
  Default cache size: 1000
• DEFAULT_MAXIMUM_TTL
  Default maximum TTL: 24 hours
• DEFAULT_MINIMUM_TTL
  Default minimum TTL: 5 minutes
• DEFAULT_RELAYS
• DEFAULT_RESOLVERS

Traits

• PkarrCache

Functions

• system_time
  Return the number of microseconds since SystemTime::UNIX_EPOCH

Type Aliases

• PkarrCacheKey
  The sha1 hash of the crate::PublicKey used as the key in PkarrCache.
• Result