Struct PeerConfig 

pub struct PeerConfig {
    pub npub: String,
    pub alias: Option<String>,
    pub addresses: Vec<PeerAddress>,
    pub connect_policy: ConnectPolicy,
    pub auto_reconnect: bool,
}

Configuration for a known peer.

Peers are identified by their Nostr public key (npub) and can have multiple transport addresses for reaching them.

Fields

npub: String

The peer’s Nostr public key in npub (bech32) or hex format.

alias: Option<String>

Human-readable alias for the peer (optional).

addresses: Vec<PeerAddress>

Transport addresses for reaching this peer.

At least one address is required unless Nostr discovery is enabled, in which case the address list may be empty and endpoints are resolved from the peer’s Nostr advert at dial time.

connect_policy: ConnectPolicy

Connection policy for this peer.

auto_reconnect: bool

Whether to automatically reconnect after link-dead removal. When true (default), the node will retry connecting with exponential backoff after MMP removes this peer due to liveness timeout.

Implementations

impl PeerConfig

pub fn new( npub: impl Into<String>, transport: impl Into<String>, addr: impl Into<String>, ) -> Self

Create a new peer config with a single address.

pub fn with_alias(self, alias: impl Into<String>) -> Self

Set an alias for the peer.

pub fn with_address(self, addr: PeerAddress) -> Self

Add an additional address for the peer.

pub fn addresses_by_priority(&self) -> Vec<&PeerAddress>

Get addresses sorted by priority (lowest first).

pub fn is_auto_connect(&self) -> bool

Check if this peer should auto-connect on startup.

Trait Implementations

impl Clone for PeerConfig

fn clone(&self) -> PeerConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PeerConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PeerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PeerConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PeerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.