Struct NostrServerTransportConfig 

#[non_exhaustive]
pub struct NostrServerTransportConfig {

    pub relay_urls: Vec<String>,
    pub encryption_mode: EncryptionMode,
    pub gift_wrap_mode: GiftWrapMode,
    pub server_info: Option<ServerInfo>,
    pub is_announced_server: bool,
    pub allowed_public_keys: Vec<String>,
    pub excluded_capabilities: Vec<CapabilityExclusion>,
    pub max_sessions: usize,
    pub cleanup_interval: Duration,
    pub session_timeout: Duration,
    pub request_timeout: Duration,
    pub relay_list_urls: Option<Vec<String>>,
    pub bootstrap_relay_urls: Option<Vec<String>>,
    pub publish_relay_list: bool,
    pub profile_metadata: Option<ProfileMetadata>,
    pub oversized_transfer: OversizedTransferConfig,
    pub open_stream: OpenStreamConfig,
}

Configuration for the server transport.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

relay_urls: Vec<String>

Relay URLs to connect to.

encryption_mode: EncryptionMode

Encryption mode.

gift_wrap_mode: GiftWrapMode

Gift-wrap kind selection policy (CEP-19).

server_info: Option<ServerInfo>

Server information for announcements.

is_announced_server: bool

Whether this server publishes public announcements (CEP-6).

allowed_public_keys: Vec<String>

Allowed client public keys (hex). Empty = allow all.

excluded_capabilities: Vec<CapabilityExclusion>

Capabilities excluded from pubkey whitelisting.

max_sessions: usize

Maximum number of concurrent client sessions (LRU-bounded, default: 1000).

cleanup_interval: Duration

Session cleanup interval (default: 60s).

session_timeout: Duration

Session timeout (default: 300s).

request_timeout: Duration

Correlation-retention TTL for server-side event routes (default: 60s).

Stale route entries older than this are swept from the correlation store. This prevents leaks – rmcp owns actual request timeout and cancellation. Keep this value above your rmcp request timeout to avoid premature cleanup.

relay_list_urls: Option<Vec<String>>

Explicit relay URLs to advertise in kind 10002 (NIP-65 relay list).

Falls back to the transport’s relay_urls when omitted.

bootstrap_relay_urls: Option<Vec<String>>

Additional publication targets for discoverability events.

Merged with relay_list_urls when computing where to send events. Defaults to DEFAULT_BOOTSTRAP_RELAY_URLS when omitted.

publish_relay_list: bool

Whether to publish a relay list event (kind 10002). Default: true.

profile_metadata: Option<ProfileMetadata>

Optional NIP-01 profile metadata (kind 0) to publish at startup.

oversized_transfer: OversizedTransferConfig

CEP-22 oversized payload transfer configuration. Enabled by default.

open_stream: OpenStreamConfig

CEP-41 open-stream configuration. Disabled by default (opt-in).

When enabled, drives capability advertisement/learning, server→client writers, response deferral, and the keepalive sweep. Opt in with OpenStreamConfig::enabled() / with_enabled(true).

Implementations

impl NostrServerTransportConfig

pub fn with_encryption_mode(self, mode: EncryptionMode) -> Self

Set the encryption mode.

pub fn with_gift_wrap_mode(self, mode: GiftWrapMode) -> Self

Set the gift-wrap mode (CEP-19).

pub fn with_server_info(self, info: ServerInfo) -> Self

Set server information for announcements.

pub fn with_announced_server(self, announced: bool) -> Self

Enable or disable public announcement publishing (CEP-6).

pub fn with_allowed_public_keys(self, keys: Vec<String>) -> Self

Set the allowed client public keys (hex). Empty = allow all.

pub fn with_excluded_capabilities(self, caps: Vec<CapabilityExclusion>) -> Self

Set capabilities excluded from pubkey whitelisting.

pub fn with_max_sessions(self, max: usize) -> Self

Set the maximum number of concurrent client sessions.

pub fn with_relay_urls(self, urls: Vec<String>) -> Self

Set the relay URLs to connect to.

pub fn with_cleanup_interval(self, interval: Duration) -> Self

Set the session cleanup interval.

pub fn with_session_timeout(self, timeout: Duration) -> Self

Set the session timeout.

pub fn with_request_timeout(self, timeout: Duration) -> Self

Set the correlation-retention TTL for event routes.

pub fn with_relay_list_urls(self, urls: Vec<String>) -> Self

Set explicit relay URLs to advertise in the relay list event (kind 10002).

pub fn with_bootstrap_relay_urls(self, urls: Vec<String>) -> Self

Set additional bootstrap relay URLs for discoverability event publication.

pub fn with_publish_relay_list(self, publish: bool) -> Self

Enable or disable relay list publication (kind 10002).

pub fn with_profile_metadata(self, metadata: ProfileMetadata) -> Self

Set NIP-01 profile metadata (kind 0) for publication at startup.

pub fn with_oversized_transfer(self, config: OversizedTransferConfig) -> Self

Set the full CEP-22 oversized payload transfer configuration.

pub fn with_oversized_enabled(self, enabled: bool) -> Self

Enable or disable CEP-22 oversized payload transfer, leaving other knobs at default.

pub fn with_open_stream(self, config: OpenStreamConfig) -> Self

Set the full CEP-41 open-stream configuration (disabled by default; opt in with OpenStreamConfig::enabled()).

Trait Implementations

impl Clone for NostrServerTransportConfig

fn clone(&self) -> NostrServerTransportConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NostrServerTransportConfig

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

Formats the value using the given formatter.

impl Default for NostrServerTransportConfig

fn default() -> Self

Returns the “default value” for a type.