Safe Haskell	None
Language	GHC2021

Network.LibP2P.Crypto.PeerId

Description

Peer ID derivation from public keys.

A Peer ID is a multihash of the serialized PublicKey protobuf message. Ed25519 keys (36 bytes serialized) use identity multihash. Larger keys (RSA) use SHA-256 multihash.

Synopsis

newtype PeerId = PeerId ByteString
fromPublicKey :: PublicKey -> PeerId
toBase58 :: PeerId -> Text
fromBase58 :: Text -> Either String PeerId
peerIdBytes :: PeerId -> ByteString
parsePeerId :: Text -> Either String PeerId
toCIDv1 :: PeerId -> Text

Documentation

newtype PeerId Source #

A Peer ID is a multihash of the serialized public key.

Constructors

PeerId ByteString

Instances

Instances details

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

fromPublicKey :: PublicKey -> PeerId Source #

Derive a Peer ID from a public key.

toBase58 :: PeerId -> Text Source #

Encode a Peer ID as base58btc text.

fromBase58 :: Text -> Either String PeerId Source #

Decode a Peer ID from base58btc text. Validates that decoded bytes are a well-formed multihash.

peerIdBytes :: PeerId -> ByteString Source #

Get the raw multihash bytes of a Peer ID.

parsePeerId :: Text -> Either String PeerId Source #

Parse a Peer ID from text, accepting both base58btc and CIDv1 (base32lower) formats. CIDv1 format: b prefix + base32lower(0x01 || 0x72 || multihash)

toCIDv1 :: PeerId -> Text Source #

Encode a Peer ID as CIDv1 text (base32lower, no padding). Format: b + base32lower(varint(1) + varint(0x72) + multihash_bytes)