Struct ClientBuilder

pub struct ClientBuilder {
    pub signer: Option<Arc<dyn NostrSigner>>,
    pub websocket_transport: Arc<dyn WebSocketTransport>,
    pub admit_policy: Option<Arc<dyn AdmitPolicy>>,
    pub database: Arc<dyn NostrDatabase>,
    pub monitor: Option<Monitor>,
    pub opts: ClientOptions,
}

Client builder

Fields

signer: Option<Arc<dyn NostrSigner>>

Nostr Signer

websocket_transport: Arc<dyn WebSocketTransport>

WebSocket transport

admit_policy: Option<Arc<dyn AdmitPolicy>>

Admission policy

database: Arc<dyn NostrDatabase>

Database

monitor: Option<Monitor>

Relay monitor

opts: ClientOptions

Client options

Implementations

impl ClientBuilder

pub fn new() -> Self

New default client builder

pub fn signer<T>(self, signer: T) -> Self

where T: IntoNostrSigner,

Set signer

Example

use nostr_sdk::prelude::*;

// Signer with private keys
let keys = Keys::generate();
let client = ClientBuilder::new().signer(keys).build();

pub fn websocket_transport<T>(self, transport: T) -> Self

where T: IntoWebSocketTransport,

Set custom WebSocket transport

By default DefaultWebsocketTransport is used.

pub fn admit_policy<T>(self, policy: T) -> Self

where T: AdmitPolicy + 'static,

Set an admission policy

pub fn database<D>(self, database: D) -> Self

where D: IntoNostrDatabase,

Set database

pub fn monitor(self, monitor: Monitor) -> Self

Set monitor

pub fn opts(self, opts: ClientOptions) -> Self

Set opts

pub fn build(self) -> Client

Build Client

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.