Safe Haskell	None
Language	GHC2021

LibP2P.DHT.Types

Description

Core types for the Kademlia DHT.

Defines the DHT keyspace (256-bit SHA-256 keys), routing table entry structure, and protocol constants (k=20, alpha=10).

Synopsis

newtype DHTKey = DHTKey ByteString
data BucketEntry = BucketEntry {
- entryPeerId :: !PeerId
- entryKey :: !DHTKey
- entryAddrs :: ![Multiaddr]
- entryLastSeen :: !UTCTime
- entryConnType :: !ConnectionType
}
data ConnectionType
- = NotConnected
- | Connected
- | CanConnect
- | CannotConnect
data InsertResult
- = Inserted
- | Updated
- | BucketFull !PeerId
kValue :: Int
alphaValue :: Int
numBuckets :: Int

Documentation

newtype DHTKey Source #

256-bit key in the DHT keyspace (always exactly 32 bytes, SHA-256 output).

Construct via keyToDHTKey (or peerIdToKey for peer IDs) — never wrap raw wire bytes directly. Per specs/kad-dht the distance metric is XOR over SHA-256 digests, while RPC messages carry the raw key.

Constructors

DHTKey ByteString

Instances

Instances details

Show DHTKey Source #
Instance details Defined in LibP2P.DHT.Types Methods showsPrec :: Int -> DHTKey -> ShowS # show :: DHTKey -> String # showList :: [DHTKey] -> ShowS #
Eq DHTKey Source #
Instance details Defined in LibP2P.DHT.Types Methods (==) :: DHTKey -> DHTKey -> Bool # (/=) :: DHTKey -> DHTKey -> Bool #
Ord DHTKey Source #
Instance details Defined in LibP2P.DHT.Types Methods compare :: DHTKey -> DHTKey -> Ordering # (<) :: DHTKey -> DHTKey -> Bool # (<=) :: DHTKey -> DHTKey -> Bool # (>) :: DHTKey -> DHTKey -> Bool # (>=) :: DHTKey -> DHTKey -> Bool # max :: DHTKey -> DHTKey -> DHTKey # min :: DHTKey -> DHTKey -> DHTKey #

data BucketEntry Source #

A single entry in a k-bucket.

Constructors

BucketEntry
Fields entryPeerId :: !PeerId entryKey :: !DHTKey Cached SHA-256 of peer ID entryAddrs :: ![Multiaddr] entryLastSeen :: !UTCTime entryConnType :: !ConnectionType

Instances

Instances details

Show BucketEntry Source #
Instance details Defined in LibP2P.DHT.Types Methods showsPrec :: Int -> BucketEntry -> ShowS # show :: BucketEntry -> String # showList :: [BucketEntry] -> ShowS #
Eq BucketEntry Source #
Instance details Defined in LibP2P.DHT.Types Methods (==) :: BucketEntry -> BucketEntry -> Bool # (/=) :: BucketEntry -> BucketEntry -> Bool #

data ConnectionType Source #

Connection status of a peer (from DHT protobuf spec).

Constructors

NotConnected	0: no connection, no extra info
Connected	1: live connection
CanConnect	2: recently connected
CannotConnect	3: recently failed to connect

Instances

Instances details

Bounded ConnectionType Source #
Instance details Defined in LibP2P.DHT.Types Methods minBound :: ConnectionType # maxBound :: ConnectionType #
Enum ConnectionType Source #
Instance details Defined in LibP2P.DHT.Types Methods succ :: ConnectionType -> ConnectionType # pred :: ConnectionType -> ConnectionType # toEnum :: Int -> ConnectionType # fromEnum :: ConnectionType -> Int # enumFrom :: ConnectionType -> [ConnectionType] # enumFromThen :: ConnectionType -> ConnectionType -> [ConnectionType] # enumFromTo :: ConnectionType -> ConnectionType -> [ConnectionType] # enumFromThenTo :: ConnectionType -> ConnectionType -> ConnectionType -> [ConnectionType] #
Show ConnectionType Source #
Instance details Defined in LibP2P.DHT.Types Methods showsPrec :: Int -> ConnectionType -> ShowS # show :: ConnectionType -> String # showList :: [ConnectionType] -> ShowS #
Eq ConnectionType Source #
Instance details Defined in LibP2P.DHT.Types Methods (==) :: ConnectionType -> ConnectionType -> Bool # (/=) :: ConnectionType -> ConnectionType -> Bool #

data InsertResult Source #

Result of attempting to insert a peer into the routing table.

Constructors

Inserted	Peer was added to the bucket
Updated	Existing peer was moved to tail (most recently seen)
BucketFull !PeerId	Bucket is full; returns LRS peer ID for pinging

Instances

Instances details

Show InsertResult Source #
Instance details Defined in LibP2P.DHT.Types Methods showsPrec :: Int -> InsertResult -> ShowS # show :: InsertResult -> String # showList :: [InsertResult] -> ShowS #
Eq InsertResult Source #
Instance details Defined in LibP2P.DHT.Types Methods (==) :: InsertResult -> InsertResult -> Bool # (/=) :: InsertResult -> InsertResult -> Bool #

kValue :: Int Source #

Replication parameter: each k-bucket holds up to k peers.

alphaValue :: Int Source #

Concurrency parameter for iterative lookups.

numBuckets :: Int Source #

Number of buckets (one per bit of the 256-bit keyspace).