Struct RelayBuilder

pub struct RelayBuilder(/* private fields */);

A builder for Pkarr Relay

Implementations

impl RelayBuilder

pub fn http_port(&mut self, port: u16) -> &mut Self

Set the port for the HTTP endpoint.

pub fn storage(&mut self, storage: PathBuf) -> &mut Self

Set the storage directory.

This Relay’s cache will be stored in a subdirectory (pkarr-cache) inside that storage directory

Defaults to the path to the user’s data directory

pub fn cache_size(&mut self, size: usize) -> &mut Self

See pkarr::ClientBuilder::cache_size

Defaults to 1_000_000

pub fn disable_rate_limiter(&mut self) -> &mut Self

Disable the rate limiter.

Useful when running in a local test network.

pub fn rate_limiter_config(&mut self, config: RateLimiterConfig) -> &mut Self

Set the RateLimiterConfig.

Defaults to RateLimiterConfig::default.

pub fn pkarr<F>(&mut self, f: F) -> &mut Self

where F: FnOnce(&mut ClientBuilder) -> &mut ClientBuilder,

Allows mutating the internal pkarr::ClientBuilder with a callback function.

pub async unsafe fn run(self) -> Result<Relay>

Run a Pkarr relay with the provided configuration.

Safety

This method is marked as unsafe because it uses LmdbCache, which can lead to undefined behavior if the lock file is corrupted or improperly handled.