Struct PeerBook 

pub struct PeerBook { /* private fields */ }

Implementations

impl PeerBook

pub const CAPACITY: usize = 1024

pub const CIRCUIT_CAPACITY: usize = 256

Entries reachable only through relays, out of CAPACITY.

pub const ADDRESSES: usize = 4

pub const GROUP_LIMIT: usize = 2

Gossip entries per IPv4 /24 or IPv6 /48.

pub const SEED_BACKOFF_CAP: u64 = 600

Seeds are operator configuration, never banned like gossip: their backoff stops growing at ten minutes.

pub fn empty(chain_genesis: BlockHash) -> Self

pub fn load(path: &Path, chain_genesis: BlockHash) -> Result<Self, Error>

Load a bounded regular JSON file for the caller’s explicit network. Only NotFound yields an empty book; any invalid file, including an older format version, is refused whole and preserved untouched.

pub fn save(&self, path: &Path) -> Result<(), Error>

Atomically replace a bounded snapshot sorted by identity then address.

pub fn entries(&self) -> &[BookEntry]

pub fn add(&mut self, address: Multiaddr, origin: Origin) -> Result<bool, Error>

Add one address. A terminal /p2p names the peer; without it the entry stays unidentified until a dial succeeds. Gossip only accepts public literal IPs under the group cap, and is the only origin of circuit addresses; manual and seed accept any usable direct address including loopback and names. Returns whether memory changed; capacity is made by evicting the worst gossip entry only.

pub fn merge( &mut self, peers: &[GossipPeer], local: PeerId, omitting: &[String], ) -> usize

Merge one peer’s gossip under the caps. The local identity and peers this archive found omitting records are never stored from gossip. Returns how many addresses changed memory; refusals are skipped.

pub fn merge_identified( &mut self, peers: &[GossipPeer], local: PeerId, omitting: &[String], ) -> usize

Peers that identified themselves over a connection: like gossip, but a known peer may gain the addresses it reported for itself.

pub fn succeeded( &mut self, address: &Multiaddr, peer: PeerId, local: PeerId, now: u64, )

A dial through address reached peer. Resets failures and records the success; an unidentified literal-IP entry learns the identity. An entry that turns out to be this node is dropped: the book never holds ourselves.

pub fn failed(&mut self, address: &Multiaddr, now: u64)

A dial through address failed: back off 60 s × 2^(failures−1), so the first failure waits 60 s, capped at one day (ten minutes for seeds). The address moves to the back, so the next dial tries another one.

pub fn failed_peer(&mut self, peer: PeerId, now: u64) -> bool

A peer misbehaved during sync: back its entry off like a failed dial. Returns whether the book holds that peer.

pub fn candidates( &self, now: u64, connected: &[PeerId], omitting: &[String], count: usize, ) -> Vec<Multiaddr>

Up to count dial addresses for non-seed entries that are not banned, connected or omitting. Entries with a direct address come before circuit-only ones. Within each, never-tried entries (picked at random) alternate with tried ones (oldest backoff expiry first), so fresh gossip cannot starve peers that were reached before.

pub fn seeds(&self, omitting: &[String], now: Option<u64>) -> Vec<Multiaddr>

Seed dial addresses in random order, skipping seeds known to be this node’s omitters and, given now, seeds still backing off. A ban beyond the seed cap (persisted under an older policy) counts as expired.

pub fn sync_addresses(&self, omitting: &[String]) -> Vec<PeerAddress>

Identified direct IP addresses for record, commit and inventory sources, one per peer, excluding peers this archive found omitting records. Circuit addresses never become sync sources.

pub fn gossip(&self, limit: usize, omitting: &[String]) -> Vec<GossipPeer>

Verified, identified peers with public literal-IP addresses (circuits through public relays included), most recently successful first, for answering a Peers request.

pub fn stats(&self) -> BookStats

pub fn listing(&self) -> Vec<ListedEntry>

Bounded JSON snapshot for the local control API.

pub fn remove(&mut self, peer: PeerId) -> bool

Remove a peer’s entry from memory without persisting.