Struct nostr_sdk::client::Client

source ·

pub struct Client { /* private fields */ }

Implementations

source

impl Client

source

pub fn new(keys: &Keys) -> Self

Create a new Client

Example

use nostr_sdk::Client;

let my_keys = Client::generate_keys();
let mut client = Client::new(&my_keys);

source

pub fn generate_keys() -> Keys

Generate new random keys using entorpy from OS

source

pub fn notifications(&self) -> Receiver<RelayPoolNotifications>

Get new notification listener

source

pub fn add_relay(&mut self, url: &str, proxy: Option<SocketAddr>) -> Result<()>

Add new relay

Example

client.add_relay("wss://relay.nostr.info", None)?;
client.add_relay("wss://relay.damus.io", None)?;

source

pub async fn remove_relay(&mut self, url: &str) -> Result<()>

Disconnect and remove relay

Example

client.remove_relay("wss://relay.nostr.info").await?;

source

pub async fn connect_relay(
 &mut self,
 url: &str,
 wait_for_connection: bool
) -> Result<()>

Connect relay

Example

client.connect_relay("wss://relay.nostr.info", true).await?;

source

pub async fn disconnect_relay(&mut self, url: &str) -> Result<()>

Disconnect relay

Example

client.disconnect_relay("wss://relay.nostr.info").await?;

source

pub async fn connect(&mut self) -> Result<()>

Connect to all added relays without waiting for connection and keep connection alive

Example

client.connect().await?;

source

pub async fn connect_and_wait(&mut self) -> Result<()>

Connect to all added relays waiting for initial connection and keep connection alive

Example

client.connect_and_wait().await?;

source

pub async fn disconnect(&mut self) -> Result<()>

Disconnect from all relays

Example

client.disconnect().await?;

Subscribe to filters

Example

use nostr::SubscriptionFilter;

let subscription = SubscriptionFilter::new()
    .pubkeys(vec![my_keys.public_key()])
    .since(Utc::now());

client.subscribe(vec![subscription]).await.unwrap();

source

pub async fn send_event(&self, event: Event) -> Result<()>

Send event

source

pub async fn update_profile(&self, metadata: Metadata) -> Result<()>

Update profile metadata

https://github.com/nostr-protocol/nips/blob/master/01.md

Example

use nostr_sdk::nostr::Metadata;

let metadata = Metadata::new()
    .name("username")
    .display_name("My Username")
    .about("Description")
    .picture(Url::from_str("https://example.com/avatar.png").unwrap())
    .nip05("username@example.com");

client.update_profile(metadata).await.unwrap();

source

pub async fn publish_text_note(&self, content: &str, tags: &[Tag]) -> Result<()>

Publish text note

https://github.com/nostr-protocol/nips/blob/master/01.md

Example

client.publish_text_note("My first text note from Nostr SDK!", &[]).await.unwrap();

source

pub async fn publish_pow_text_note(
 &self,
 content: &str,
 tags: &[Tag],
 difficulty: u8
) -> Result<()>

Publish POW text note

https://github.com/nostr-protocol/nips/blob/master/13.md

Example

client.publish_pow_text_note("My first POW text note from Nostr SDK!", &[], 16).await.unwrap();

source

pub async fn add_recommended_relay(&self, url: &str) -> Result<()>

Add recommended relay

https://github.com/nostr-protocol/nips/blob/master/01.md

Example

client.add_recommended_relay("wss://relay.damus.io").await.unwrap();

source

pub async fn set_contact_list(&self, list: Vec<Contact>) -> Result<()>

Set contact list

https://github.com/nostr-protocol/nips/blob/master/02.md

Example

use nostr::Contact;
use nostr::key::{Keys, FromBech32};

let list = vec![
    Contact::new(
        "my_first_contact",
        Keys::from_bech32_public_key("npub1...").unwrap().public_key(),
        "wss://relay.damus.io",
    ),
];
client.set_contact_list(list).await.unwrap();

source

pub async fn get_contact_list(&mut self) -> Result<Vec<Contact>>

Get contact list

https://github.com/nostr-protocol/nips/blob/master/02.md

Example

let list = client.get_contact_list().await.unwrap();

source

pub async fn send_direct_msg(&self, recipient: &Keys, msg: &str) -> Result<()>

Send encrypted direct message

https://github.com/nostr-protocol/nips/blob/master/04.md

Example

use nostr::key::{Keys, FromBech32};
use nostr_sdk::Client;

let my_keys = Client::generate_keys();
let mut client = Client::new(&my_keys);

client.add_relay("wss://relay.nostr.info", None).unwrap();
client.connect().await.unwrap();

let alice_keys = Keys::from_bech32_public_key("npub1...").unwrap();
client.send_direct_msg(alice_keys, "My first DM fro Nostr SDK!").await.unwrap();

source

pub async fn delete_event(&self, event_id: &str) -> Result<()>

Delete event

https://github.com/nostr-protocol/nips/blob/master/09.md

source

pub async fn like(&self, event: &Event) -> Result<()>

Like event

https://github.com/nostr-protocol/nips/blob/master/25.md

Example

use nostr::Event;

let event = Event::from_json(r#"{
    "pubkey":"a8e76c3ace7829f9ee44cf9293309e21a1824bf1e57631d00685a1ed0b0bd8a2",
    "content":"🔥 78,680 blocks to the next Halving 🔥",
    "id":"3aded8d2194dc2fedb1d7b70480b43b6c4deb0a22dcdc9c471d1958485abcf21",
    "created_at":1667337749,
    "sig":"96e0a125e15ecc889757a1b517fdab0223a9ceae22d2591536b5f5186599b50cb1c5f20c2d0d06cdd5cd75368529e33bac4fcd3b321db9865d47785b95b72625",
    "kind":1,
    "tags":[]
}"#).unwrap();

client.like(event).await.unwrap();

source

pub async fn dislike(&self, event: &Event) -> Result<()>

Disike event

https://github.com/nostr-protocol/nips/blob/master/25.md

Example

use nostr::Event;

let event = Event::from_json(r#"{
    "pubkey":"a8e76c3ace7829f9ee44cf9293309e21a1824bf1e57631d00685a1ed0b0bd8a2",
    "content":"🔥 78,680 blocks to the next Halving 🔥",
    "id":"3aded8d2194dc2fedb1d7b70480b43b6c4deb0a22dcdc9c471d1958485abcf21",
    "created_at":1667337749,
    "sig":"96e0a125e15ecc889757a1b517fdab0223a9ceae22d2591536b5f5186599b50cb1c5f20c2d0d06cdd5cd75368529e33bac4fcd3b321db9865d47785b95b72625",
    "kind":1,
    "tags":[]
}"#).unwrap();
  
client.dislike(event).await.unwrap();

source

pub async fn new_channel(
 &self,
 name: &str,
 about: Option<&str>,
 picture: Option<&str>
) -> Result<()>

Create new channel

https://github.com/nostr-protocol/nips/blob/master/28.md

source

pub async fn update_channel(
 &self,
 channel_id: Hash,
 relay_url: Url,
 name: Option<&str>,
 about: Option<&str>,
 picture: Option<&str>
) -> Result<()>

Update channel metadata

https://github.com/nostr-protocol/nips/blob/master/28.md

source

pub async fn send_channel_msg(
 &self,
 channel_id: Hash,
 relay_url: Url,
 msg: &str
) -> Result<()>

Send message to channel

https://github.com/nostr-protocol/nips/blob/master/28.md

source

pub async fn hide_channel_msg(&self, message_id: Hash, reason: &str) -> Result<()>

Hide channel message

https://github.com/nostr-protocol/nips/blob/master/28.md

source

pub async fn mute_channel_user(
 &self,
 pubkey: XOnlyPublicKey,
 reason: &str
) -> Result<()>

Mute channel user

https://github.com/nostr-protocol/nips/blob/master/28.md

source

pub async fn handle_notifications<F>(&self, func: F) -> Result<()>where
F: Fn(RelayPoolNotifications) -> Result<()>,

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct nostr_sdk::client::Client

Implementations

impl Client

pub fn new(keys: &Keys) -> Self

pub fn generate_keys() -> Keys

pub fn notifications(&self) -> Receiver<RelayPoolNotifications>

pub fn add_relay(&mut self, url: &str, proxy: Option<SocketAddr>) -> Result<()>

pub async fn remove_relay(&mut self, url: &str) -> Result<()>

pub async fn connect_relay( &mut self, url: &str, wait_for_connection: bool) -> Result<()>

pub async fn disconnect_relay(&mut self, url: &str) -> Result<()>

pub async fn connect(&mut self) -> Result<()>

pub async fn connect_and_wait(&mut self) -> Result<()>

pub async fn disconnect(&mut self) -> Result<()>

pub async fn subscribe(&mut self, filters: Vec<SubscriptionFilter>) -> Result<()>

pub async fn send_event(&self, event: Event) -> Result<()>

pub async fn update_profile(&self, metadata: Metadata) -> Result<()>

pub async fn publish_text_note(&self, content: &str, tags: &[Tag]) -> Result<()>

pub async fn publish_pow_text_note( &self, content: &str, tags: &[Tag], difficulty: u8) -> Result<()>

pub async fn add_recommended_relay(&self, url: &str) -> Result<()>

pub async fn set_contact_list(&self, list: Vec<Contact>) -> Result<()>

pub async fn get_contact_list(&mut self) -> Result<Vec<Contact>>

pub async fn send_direct_msg(&self, recipient: &Keys, msg: &str) -> Result<()>

pub async fn delete_event(&self, event_id: &str) -> Result<()>

pub async fn like(&self, event: &Event) -> Result<()>

pub async fn dislike(&self, event: &Event) -> Result<()>

pub async fn new_channel( &self, name: &str, about: Option<&str>, picture: Option<&str>) -> Result<()>

pub async fn update_channel( &self, channel_id: Hash, relay_url: Url, name: Option<&str>, about: Option<&str>, picture: Option<&str>) -> Result<()>

pub async fn send_channel_msg( &self, channel_id: Hash, relay_url: Url, msg: &str) -> Result<()>

pub async fn hide_channel_msg(&self, message_id: Hash, reason: &str) -> Result<()>

pub async fn mute_channel_user( &self, pubkey: XOnlyPublicKey, reason: &str) -> Result<()>

pub async fn handle_notifications<F>(&self, func: F) -> Result<()>where F: Fn(RelayPoolNotifications) -> Result<()>,

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn connect_relay(
&mut self,
url: &str,
wait_for_connection: bool
) -> Result<()>

pub async fn publish_pow_text_note(
&self,
content: &str,
tags: &[Tag],
difficulty: u8
) -> Result<()>

pub async fn new_channel(
&self,
name: &str,
about: Option<&str>,
picture: Option<&str>
) -> Result<()>

pub async fn update_channel(
&self,
channel_id: Hash,
relay_url: Url,
name: Option<&str>,
about: Option<&str>,
picture: Option<&str>
) -> Result<()>

pub async fn send_channel_msg(
&self,
channel_id: Hash,
relay_url: Url,
msg: &str
) -> Result<()>

pub async fn mute_channel_user(
&self,
pubkey: XOnlyPublicKey,
reason: &str
) -> Result<()>

pub async fn handle_notifications<F>(&self, func: F) -> Result<()>where
F: Fn(RelayPoolNotifications) -> Result<()>,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,