Struct NostrConfig 

pub struct NostrConfig {

    pub enabled: bool,
    pub relays: Vec<String>,
    pub event_transport: NostrEventTransport,
    pub allowed_npubs: Vec<String>,
    pub socialgraph_root: Option<String>,
    pub bootstrap_follows: Vec<String>,
    pub social_graph_crawl_depth: u32,
    pub mirror_max_follow_distance: Option<u32>,
    pub max_write_distance: u32,
    pub db_max_size_gb: u64,
    pub spambox_max_size_gb: u64,
    pub negentropy_only: bool,
    pub overmute_threshold: f64,
    pub mirror_kinds: Vec<u16>,
    pub history_sync_author_chunk_size: usize,
    pub history_sync_per_author_event_limit: usize,
    pub history_sync_on_reconnect: bool,
    pub full_text_note_history_follow_distance: Option<u32>,
    pub full_text_note_history_max_relay_pages: usize,
    pub decentralized_pubsub: bool,
    pub decentralized_pubsub_forwarding: bool,
    pub decentralized_pubsub_fanout: usize,
    pub decentralized_pubsub_max_hops: u8,
    pub decentralized_pubsub_max_event_bytes: usize,
}

Fields

enabled: bool

relays: Vec<String>

event_transport: NostrEventTransport

Provider used for Hashtree root/site event lookup and publication.

allowed_npubs: Vec<String>

List of npubs allowed to write (blossom uploads). If empty, uses public_writes setting.

socialgraph_root: Option<String>

Social graph root pubkey (npub). Defaults to own key if not set.

bootstrap_follows: Vec<String>

Pubkeys to seed into contacts.json when a new identity is initialized. Set to [] to opt out.

social_graph_crawl_depth: u32

How many hops to crawl the social graph (default: 2)

mirror_max_follow_distance: Option<u32>

Max follow distance to mirror into public event/profile indexes. Defaults to social_graph_crawl_depth when unset.

max_write_distance: u32

Max follow distance for write access (default: 3)

db_max_size_gb: u64

Max size for the trusted social graph store in GB (default: 10)

spambox_max_size_gb: u64

Max size for the social graph spambox in GB (default: 1) Set to 0 for memory-only spambox (no on-disk DB)

negentropy_only: bool

Require relays to support NIP-77 negentropy for mirror history sync.

overmute_threshold: f64

Threshold for treating a user as overmuted in mirrored profile indexing/search.

mirror_kinds: Vec<u16>

Kinds mirrored from upstream relays for the trusted hashtree index.

history_sync_author_chunk_size: usize

How many graph authors to reconcile before checkpointing the mirror root.

history_sync_per_author_event_limit: usize

Maximum mirrored history events to fetch per author during history sync.

history_sync_on_reconnect: bool

Run a catch-up history sync after relay reconnects.

full_text_note_history_follow_distance: Option<u32>

Fetch complete kind-1 history for authors up to this follow distance. Set to null to disable.

full_text_note_history_max_relay_pages: usize

Maximum relay pages per author for startup text-note history fetches. Set to 0 to skip the expensive startup text-note catch-up.

decentralized_pubsub: bool

Enable experimental decentralized Nostr event pubsub when compiled with the experimental-decentralized-pubsub feature.

decentralized_pubsub_forwarding: bool

Forward decentralized pubsub traffic for peers with downstream interest.

decentralized_pubsub_fanout: usize

Maximum peers selected per decentralized pubsub send.

decentralized_pubsub_max_hops: u8

Initial HTL for decentralized pubsub interest/inventory messages.

decentralized_pubsub_max_event_bytes: usize

Maximum Nostr event payload accepted on decentralized pubsub.

Implementations

impl NostrConfig

pub fn active_relays(&self) -> Vec<String>

pub fn decentralized_pubsub_enabled(&self) -> bool

Trait Implementations

impl Clone for NostrConfig

fn clone(&self) -> NostrConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NostrConfig

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

Formats the value using the given formatter.

impl Default for NostrConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NostrConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for NostrConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.