1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
// Copyright (c) 2022-2023 Yuki Kishimoto
// Copyright (c) 2023-2024 Rust Nostr Developers
// Distributed under the MIT software license
//! Client
use std::collections::HashMap;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::time::Duration;
use async_utility::thread;
use nostr::event::builder::Error as EventBuilderError;
use nostr::key::XOnlyPublicKey;
#[cfg(feature = "nip46")]
use nostr::nips::nip46::{NostrConnectMetadata, NostrConnectURI, Request, Response};
use nostr::nips::nip94::FileMetadata;
use nostr::types::metadata::Error as MetadataError;
use nostr::url::Url;
use nostr::util::EventIdOrCoordinate;
use nostr::{
ClientMessage, Contact, Event, EventBuilder, EventId, Filter, JsonUtil, Keys, Kind, Metadata,
Result, Tag, Timestamp,
};
use nostr_database::DynNostrDatabase;
use nostr_sdk_net::futures_util::Future;
use tokio::sync::{broadcast, RwLock};
#[cfg(feature = "blocking")]
pub mod blocking;
pub mod builder;
pub mod options;
#[cfg(feature = "nip46")]
pub mod signer;
pub use self::builder::ClientBuilder;
pub use self::options::Options;
#[cfg(feature = "nip46")]
pub use self::signer::remote::RemoteSigner;
use crate::relay::pool::{self, Error as RelayPoolError, RelayPool};
use crate::relay::{
FilterOptions, NegentropyOptions, Relay, RelayOptions, RelayPoolNotification, RelaySendOptions,
};
use crate::util::TryIntoUrl;
/// [`Client`] error
#[derive(Debug, thiserror::Error)]
pub enum Error {
/// Keys error
#[error(transparent)]
Keys(#[from] nostr::key::Error),
/// Url parse error
#[error("impossible to parse URL: {0}")]
Url(#[from] nostr::url::ParseError),
/// [`RelayPool`] error
#[error("relay pool error: {0}")]
RelayPool(#[from] RelayPoolError),
/// [`EventBuilder`] error
#[error("event builder error: {0}")]
EventBuilder(#[from] EventBuilderError),
/// Unsigned event error
#[error("unsigned event error: {0}")]
UnsignedEvent(#[from] nostr::event::unsigned::Error),
/// Secp256k1 error
#[error("secp256k1 error: {0}")]
Secp256k1(#[from] nostr::secp256k1::Error),
/// Hex error
#[error("hex decoding error: {0}")]
Hex(#[from] nostr::hashes::hex::Error),
/// Metadata error
#[error(transparent)]
Metadata(#[from] MetadataError),
/// Notification Handler error
#[error("notification handler error: {0}")]
Handler(String),
/// Signer not configured
#[cfg(feature = "nip46")]
#[error("signer not configured")]
SignerNotConfigured,
/// NIP04 error
#[cfg(feature = "nip04")]
#[error(transparent)]
NIP04(#[from] nostr::nips::nip04::Error),
/// NIP46 error
#[cfg(feature = "nip46")]
#[error(transparent)]
NIP46(#[from] nostr::nips::nip46::Error),
/// JSON error
#[cfg(feature = "nip46")]
#[error(transparent)]
JSON(#[from] nostr::serde_json::Error),
/// Generic NIP46 error
#[cfg(feature = "nip46")]
#[error("generic error")]
Generic,
/// NIP46 response error
#[cfg(feature = "nip46")]
#[error("response error: {0}")]
Response(String),
/// Signer public key not found
#[cfg(feature = "nip46")]
#[error("signer public key not found")]
SignerPublicKeyNotFound,
/// Timeout
#[cfg(feature = "nip46")]
#[error("timeout")]
Timeout,
/// Response not match to the request
#[cfg(feature = "nip46")]
#[error("response not match to the request")]
ResponseNotMatchRequest,
}
/// Nostr client
#[derive(Debug, Clone)]
pub struct Client {
pool: RelayPool,
keys: Arc<RwLock<Keys>>,
opts: Options,
dropped: Arc<AtomicBool>,
#[cfg(feature = "nip46")]
remote_signer: Option<RemoteSigner>,
}
impl Drop for Client {
fn drop(&mut self) {
if self.opts.shutdown_on_drop {
if self.dropped.load(Ordering::SeqCst) {
tracing::warn!("Client already dropped");
} else {
tracing::debug!("Dropping the Client...");
let _ = self
.dropped
.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |_| Some(true));
let client: Client = self.clone();
thread::spawn(async move {
client
.shutdown()
.await
.expect("Impossible to drop the client")
});
}
}
}
}
impl Client {
/// Create a new [`Client`]
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// let my_keys = Keys::generate();
/// let client = Client::new(&my_keys);
/// ```
pub fn new(keys: &Keys) -> Self {
Self::with_opts(keys, Options::default())
}
/// Create a new [`Client`] with [`Options`]
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// let my_keys = Keys::generate();
/// let opts = Options::new().wait_for_send(true);
/// let client = Client::with_opts(&my_keys, opts);
/// ```
pub fn with_opts(keys: &Keys, opts: Options) -> Self {
ClientBuilder::new(keys).opts(opts).build()
}
/// Create a new NIP46 Client
#[cfg(feature = "nip46")]
pub fn with_remote_signer(app_keys: &Keys, remote_signer: RemoteSigner) -> Self {
Self::with_remote_signer_and_opts(app_keys, remote_signer, Options::default())
}
/// Create a new NIP46 Client with custom [`Options`]
#[cfg(feature = "nip46")]
pub fn with_remote_signer_and_opts(
app_keys: &Keys,
remote_signer: RemoteSigner,
opts: Options,
) -> Self {
ClientBuilder::new(app_keys)
.remote_signer(remote_signer)
.opts(opts)
.build()
}
/// Compose [`Client`] from [`ClientBuilder`]
pub fn from_builder(builder: ClientBuilder) -> Self {
Self {
pool: RelayPool::with_database(builder.opts.pool, builder.database),
keys: Arc::new(RwLock::new(builder.keys)),
opts: builder.opts,
dropped: Arc::new(AtomicBool::new(false)),
#[cfg(feature = "nip46")]
remote_signer: builder.remote_signer,
}
}
/// Update default difficulty for new [`Event`]
pub fn update_difficulty(&self, difficulty: u8) {
self.opts.update_difficulty(difficulty);
}
/// Get current [`Keys`]
pub async fn keys(&self) -> Keys {
let keys = self.keys.read().await;
keys.clone()
}
/// Change [`Keys`]
pub async fn set_keys(&self, keys: &Keys) {
let mut current_keys = self.keys.write().await;
*current_keys = keys.clone();
}
/// Get [`RelayPool`]
pub fn pool(&self) -> RelayPool {
self.pool.clone()
}
/// Get database
pub fn database(&self) -> Arc<DynNostrDatabase> {
self.pool.database()
}
/// Get NIP46 uri
#[cfg(feature = "nip46")]
pub async fn nostr_connect_uri(
&self,
metadata: NostrConnectMetadata,
) -> Result<NostrConnectURI, Error> {
let signer = self
.remote_signer
.as_ref()
.ok_or(Error::SignerNotConfigured)?;
let keys = self.keys.read().await;
Ok(NostrConnectURI::new(
keys.public_key(),
signer.relay_url(),
metadata.name,
))
}
/// Get remote signer
#[cfg(feature = "nip46")]
pub fn remote_signer(&self) -> Result<RemoteSigner, Error> {
self.remote_signer.clone().ok_or(Error::SignerNotConfigured)
}
/// Start a previously stopped client
pub async fn start(&self) {
self.pool.start();
self.connect().await;
}
/// Stop the client
///
/// Disconnect all relays and set their status to `RelayStatus::Stopped`.
pub async fn stop(&self) -> Result<(), Error> {
Ok(self.pool.stop().await?)
}
/// Check if [`RelayPool`] is running
pub fn is_running(&self) -> bool {
self.pool.is_running()
}
/// Completely shutdown [`Client`]
pub async fn shutdown(self) -> Result<(), Error> {
Ok(self.pool.clone().shutdown().await?)
}
/// Clear already seen events
#[deprecated]
pub async fn clear_already_seen_events(&self) {}
/// Get new notification listener
pub fn notifications(&self) -> broadcast::Receiver<RelayPoolNotification> {
self.pool.notifications()
}
/// Get relays
pub async fn relays(&self) -> HashMap<Url, Relay> {
self.pool.relays().await
}
/// Get a previously added [`Relay`]
pub async fn relay<U>(&self, url: U) -> Result<Relay, Error>
where
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
Ok(self.pool.relay(url).await?)
}
/// Add new relay
///
/// This method **NOT** automatically start connection with relay!
///
/// Return `false` if the relay already exists.
///
/// To use a proxy, see `Client::add_relay_with_opts`.
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// client.add_relay("wss://relay.nostr.info").await.unwrap();
/// client.add_relay("wss://relay.damus.io").await.unwrap();
///
/// client.connect().await;
/// # }
/// ```
pub async fn add_relay<U>(&self, url: U) -> Result<bool, Error>
where
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
#[cfg(not(target_arch = "wasm32"))]
let opts: RelayOptions = RelayOptions::new().proxy(self.opts.proxy);
#[cfg(target_arch = "wasm32")]
let opts: RelayOptions = RelayOptions::new();
self.add_relay_with_opts(url, opts).await
}
/// Add new relay with [`RelayOptions`]
///
/// This method **NOT** automatically start connection with relay!
///
/// Return `false` if the relay already exists.
///
/// # Example
/// ```rust,no_run
/// use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4};
///
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let proxy = Some(SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, 9050)));
/// let opts = RelayOptions::new().proxy(proxy).write(false).retry_sec(11);
/// client
/// .add_relay_with_opts("wss://relay.nostr.info", opts)
/// .await
/// .unwrap();
///
/// client.connect().await;
/// # }
/// ```
pub async fn add_relay_with_opts<U>(&self, url: U, opts: RelayOptions) -> Result<bool, Error>
where
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
Ok(self.pool.add_relay(url, opts).await?)
}
/// Disconnect and remove relay
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// client.remove_relay("wss://relay.nostr.info").await.unwrap();
/// # }
/// ```
pub async fn remove_relay<U>(&self, url: U) -> Result<(), Error>
where
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
self.pool.remove_relay(url).await?;
Ok(())
}
/// Add multiple relays
///
/// This method **NOT** automatically start connection with relays!
pub async fn add_relays<I, U>(&self, relays: I) -> Result<(), Error>
where
I: IntoIterator<Item = U>,
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
for url in relays.into_iter() {
self.add_relay(url).await?;
}
Ok(())
}
/// Connect to a previously added relay
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// client
/// .connect_relay("wss://relay.nostr.info")
/// .await
/// .unwrap();
/// # }
/// ```
pub async fn connect_relay<U>(&self, url: U) -> Result<(), Error>
where
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
let relay: Relay = self.relay(url).await?;
self.pool
.connect_relay(&relay, self.opts.wait_for_connection)
.await;
Ok(())
}
/// Disconnect relay
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// client
/// .disconnect_relay("wss://relay.nostr.info")
/// .await
/// .unwrap();
/// # }
/// ```
pub async fn disconnect_relay<U>(&self, url: U) -> Result<(), Error>
where
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
let relay = self.relay(url).await?;
self.pool.disconnect_relay(&relay).await?;
Ok(())
}
/// Connect relays
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// client.connect().await;
/// # }
/// ```
pub async fn connect(&self) {
self.pool.connect(self.opts.wait_for_connection).await;
}
/// Disconnect from all relays
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// client.disconnect().await.unwrap();
/// # }
/// ```
pub async fn disconnect(&self) -> Result<(), Error> {
Ok(self.pool.disconnect().await?)
}
/// Subscribe to filters
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let subscription = Filter::new()
/// .pubkeys(vec![my_keys.public_key()])
/// .since(Timestamp::now());
///
/// client.subscribe(vec![subscription]).await;
/// # }
/// ```
pub async fn subscribe(&self, filters: Vec<Filter>) {
let wait: Option<Duration> = if self.opts.get_wait_for_subscription() {
self.opts.send_timeout
} else {
None
};
self.pool.subscribe(filters, wait).await;
}
/// Subscribe to filters with custom wait
pub async fn subscribe_with_custom_wait(&self, filters: Vec<Filter>, wait: Option<Duration>) {
self.pool.subscribe(filters, wait).await;
}
/// Unsubscribe from filters
pub async fn unsubscribe(&self) {
let wait: Option<Duration> = if self.opts.get_wait_for_subscription() {
self.opts.send_timeout
} else {
None
};
self.pool.unsubscribe(wait).await;
}
/// Unsubscribe from filters with custom wait
pub async fn unsubscribe_with_custom_wait(&self, wait: Option<Duration>) {
self.pool.unsubscribe(wait).await;
}
/// Get events of filters
///
/// If timeout is set to `None`, the default from [`Options`] will be used.
///
/// # Example
/// ```rust,no_run
/// use std::time::Duration;
///
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let subscription = Filter::new()
/// .pubkeys(vec![my_keys.public_key()])
/// .since(Timestamp::now());
///
/// let timeout = Duration::from_secs(10);
/// let _events = client
/// .get_events_of(vec![subscription], Some(timeout))
/// .await
/// .unwrap();
/// # }
/// ```
pub async fn get_events_of(
&self,
filters: Vec<Filter>,
timeout: Option<Duration>,
) -> Result<Vec<Event>, Error> {
self.get_events_of_with_opts(filters, timeout, FilterOptions::ExitOnEOSE)
.await
}
/// Get events of filters with [`FilterOptions`]
///
/// If timeout is set to `None`, the default from [`Options`] will be used.
pub async fn get_events_of_with_opts(
&self,
filters: Vec<Filter>,
timeout: Option<Duration>,
opts: FilterOptions,
) -> Result<Vec<Event>, Error> {
let timeout: Duration = match timeout {
Some(t) => t,
None => self.opts.timeout,
};
Ok(self.pool.get_events_of(filters, timeout, opts).await?)
}
/// Request events of filters
/// All events will be received on notification listener (`client.notifications()`)
/// until the EOSE "end of stored events" message is received from the relay.
///
/// If timeout is set to `None`, the default from [`Options`] will be used.
pub async fn req_events_of(&self, filters: Vec<Filter>, timeout: Option<Duration>) {
self.req_events_of_with_opts(filters, timeout, FilterOptions::ExitOnEOSE)
.await
}
/// Request events of filters with [`FilterOptions`]
///
/// If timeout is set to `None`, the default from [`Options`] will be used.
pub async fn req_events_of_with_opts(
&self,
filters: Vec<Filter>,
timeout: Option<Duration>,
opts: FilterOptions,
) {
let timeout: Duration = match timeout {
Some(t) => t,
None => self.opts.timeout,
};
self.pool.req_events_of(filters, timeout, opts).await;
}
/// Send client message
pub async fn send_msg(&self, msg: ClientMessage) -> Result<(), Error> {
let wait: Option<Duration> = if self.opts.get_wait_for_send() {
self.opts.send_timeout
} else {
None
};
self.pool.send_msg(msg, wait).await?;
Ok(())
}
/// Batch send client messages
pub async fn batch_msg(
&self,
msgs: Vec<ClientMessage>,
wait: Option<Duration>,
) -> Result<(), Error> {
self.pool.batch_msg(msgs, wait).await?;
Ok(())
}
/// Send client message to a specific relay
pub async fn send_msg_to<U>(&self, url: U, msg: ClientMessage) -> Result<(), Error>
where
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
let wait: Option<Duration> = if self.opts.get_wait_for_send() {
self.opts.send_timeout
} else {
None
};
Ok(self.pool.send_msg_to(url, msg, wait).await?)
}
/// Send event
///
/// This method will wait for the `OK` message from the relay.
/// If you not want to wait for the `OK` message, use `send_msg` method instead.
pub async fn send_event(&self, event: Event) -> Result<EventId, Error> {
let timeout: Option<Duration> = self.opts.send_timeout;
let opts = RelaySendOptions::new()
.skip_disconnected(self.opts.get_skip_disconnected_relays())
.timeout(timeout);
Ok(self.pool.send_event(event, opts).await?)
}
/// Send multiple [`Event`] at once
pub async fn batch_event(
&self,
events: Vec<Event>,
opts: RelaySendOptions,
) -> Result<(), Error> {
self.pool.batch_event(events, opts).await?;
Ok(())
}
/// Send event to specific relay
///
/// This method will wait for the `OK` message from the relay.
/// If you not want to wait for the `OK` message, use `send_msg` method instead.
pub async fn send_event_to<U>(&self, url: U, event: Event) -> Result<EventId, Error>
where
U: TryIntoUrl,
pool::Error: From<<U as TryIntoUrl>::Err>,
{
let timeout: Option<Duration> = self.opts.send_timeout;
let opts = RelaySendOptions::new()
.skip_disconnected(self.opts.get_skip_disconnected_relays())
.timeout(timeout);
Ok(self.pool.send_event_to(url, event, opts).await?)
}
async fn send_event_builder(&self, builder: EventBuilder) -> Result<EventId, Error> {
#[cfg(feature = "nip46")]
let event: Event = if let Some(signer) = self.remote_signer.as_ref() {
let signer_public_key = signer
.signer_public_key()
.await
.ok_or(Error::SignerPublicKeyNotFound)?;
let unsigned_event = {
let difficulty: u8 = self.opts.get_difficulty();
if difficulty > 0 {
builder.to_unsigned_pow_event(signer_public_key, difficulty)
} else {
builder.to_unsigned_event(signer_public_key)
}
};
let res: Response = self
.send_req_to_signer(
Request::SignEvent(unsigned_event.clone()),
self.opts.nip46_timeout,
)
.await?;
if let Response::SignEvent(event) = res {
event
} else {
return Err(Error::ResponseNotMatchRequest);
}
} else {
let difficulty: u8 = self.opts.get_difficulty();
let keys = self.keys.read().await;
if difficulty > 0 {
builder.to_pow_event(&keys, difficulty)?
} else {
builder.to_event(&keys)?
}
};
#[cfg(not(feature = "nip46"))]
let event: Event = {
let difficulty: u8 = self.opts.get_difficulty();
let keys = self.keys.read().await;
if difficulty > 0 {
builder.to_pow_event(&keys, difficulty)?
} else {
builder.to_event(&keys)?
}
};
self.send_event(event).await
}
/// Update metadata
///
/// <https://github.com/nostr-protocol/nips/blob/master/01.md>
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let metadata = Metadata::new()
/// .name("username")
/// .display_name("My Username")
/// .about("Description")
/// .picture(Url::parse("https://example.com/avatar.png").unwrap())
/// .nip05("username@example.com");
///
/// client.set_metadata(&metadata).await.unwrap();
/// # }
/// ```
pub async fn set_metadata(&self, metadata: &Metadata) -> Result<EventId, Error> {
let builder = EventBuilder::set_metadata(metadata);
self.send_event_builder(builder).await
}
/// Publish text note
///
/// <https://github.com/nostr-protocol/nips/blob/master/01.md>
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// client
/// .publish_text_note("My first text note from Nostr SDK!", [])
/// .await
/// .unwrap();
/// # }
/// ```
pub async fn publish_text_note<S, I>(&self, content: S, tags: I) -> Result<EventId, Error>
where
S: Into<String>,
I: IntoIterator<Item = Tag>,
{
let builder = EventBuilder::new_text_note(content, tags);
self.send_event_builder(builder).await
}
/// Add recommended relay
///
/// <https://github.com/nostr-protocol/nips/blob/master/01.md>
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// client
/// .add_recommended_relay("wss://relay.damus.io")
/// .await
/// .unwrap();
/// # }
/// ```
pub async fn add_recommended_relay<U>(&self, url: U) -> Result<EventId, Error>
where
U: TryIntoUrl,
Error: From<<U as TryIntoUrl>::Err>,
{
let url: Url = url.try_into_url()?;
let builder = EventBuilder::add_recommended_relay(&url);
self.send_event_builder(builder).await
}
/// Set contact list
///
/// <https://github.com/nostr-protocol/nips/blob/master/02.md>
pub async fn set_contact_list<I>(&self, list: I) -> Result<EventId, Error>
where
I: IntoIterator<Item = Contact>,
{
let builder = EventBuilder::set_contact_list(list);
self.send_event_builder(builder).await
}
async fn get_contact_list_filters(&self) -> Result<Vec<Filter>, Error> {
#[cfg(feature = "nip46")]
let filter = {
let mut filter = Filter::new().kind(Kind::ContactList).limit(1);
if let Some(signer) = self.remote_signer.as_ref() {
let signer_public_key = signer
.signer_public_key()
.await
.ok_or(Error::SignerPublicKeyNotFound)?;
filter = filter.author(signer_public_key);
} else {
let keys = self.keys.read().await;
filter = filter.author(keys.public_key());
}
filter
};
#[cfg(not(feature = "nip46"))]
let filter: Filter = {
let keys = self.keys.read().await;
Filter::new()
.author(keys.public_key())
.kind(Kind::ContactList)
.limit(1)
};
Ok(vec![filter])
}
/// Get contact list
///
/// <https://github.com/nostr-protocol/nips/blob/master/02.md>
///
/// # Example
/// ```rust,no_run
/// use std::time::Duration;
///
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let timeout = Duration::from_secs(10);
/// let _list = client.get_contact_list(Some(timeout)).await.unwrap();
/// # }
/// ```
pub async fn get_contact_list(&self, timeout: Option<Duration>) -> Result<Vec<Contact>, Error> {
let mut contact_list: Vec<Contact> = Vec::new();
let filters: Vec<Filter> = self.get_contact_list_filters().await?;
let events: Vec<Event> = self.get_events_of(filters, timeout).await?;
for event in events.into_iter() {
for tag in event.tags.into_iter() {
if let Tag::PublicKey {
public_key,
relay_url,
alias,
} = tag
{
contact_list.push(Contact::new(public_key, relay_url, alias))
}
}
}
Ok(contact_list)
}
/// Get contact list public keys
///
/// <https://github.com/nostr-protocol/nips/blob/master/02.md>
pub async fn get_contact_list_public_keys(
&self,
timeout: Option<Duration>,
) -> Result<Vec<XOnlyPublicKey>, Error> {
let mut pubkeys: Vec<XOnlyPublicKey> = Vec::new();
let filters: Vec<Filter> = self.get_contact_list_filters().await?;
let events: Vec<Event> = self.get_events_of(filters, timeout).await?;
for event in events.into_iter() {
pubkeys.extend(event.public_keys());
}
Ok(pubkeys)
}
/// Get contact list [`Metadata`]
pub async fn get_contact_list_metadata(
&self,
timeout: Option<Duration>,
) -> Result<HashMap<XOnlyPublicKey, Metadata>, Error> {
let public_keys = self.get_contact_list_public_keys(timeout).await?;
let mut contacts: HashMap<XOnlyPublicKey, Metadata> =
public_keys.iter().map(|p| (*p, Metadata::new())).collect();
let chunk_size: usize = self.opts.get_req_filters_chunk_size();
for chunk in public_keys.chunks(chunk_size) {
let mut filters: Vec<Filter> = Vec::new();
for public_key in chunk.iter() {
filters.push(
Filter::new()
.author(*public_key)
.kind(Kind::Metadata)
.limit(1),
);
}
let events: Vec<Event> = self.get_events_of(filters, timeout).await?;
for event in events.into_iter() {
let metadata = Metadata::from_json(&event.content)?;
if let Some(m) = contacts.get_mut(&event.pubkey) {
*m = metadata
};
}
}
Ok(contacts)
}
/// Send encrypted direct message
///
/// <https://github.com/nostr-protocol/nips/blob/master/04.md>
///
/// # Example
/// ```rust,no_run
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let alice_pubkey = XOnlyPublicKey::from_bech32(
/// "npub14f8usejl26twx0dhuxjh9cas7keav9vr0v8nvtwtrjqx3vycc76qqh9nsy",
/// )
/// .unwrap();
///
/// client
/// .send_direct_msg(alice_pubkey, "My first DM fro Nostr SDK!", None)
/// .await
/// .unwrap();
/// # }
/// ```
#[cfg(feature = "nip04")]
pub async fn send_direct_msg<S>(
&self,
receiver: XOnlyPublicKey,
msg: S,
reply_to: Option<EventId>,
) -> Result<EventId, Error>
where
S: Into<String>,
{
#[cfg(feature = "nip46")]
let builder: EventBuilder = if self.remote_signer.is_some() {
let req = Request::Nip04Encrypt {
public_key: receiver,
text: msg.into(),
};
let res: Response = self
.send_req_to_signer(req, self.opts.nip46_timeout)
.await?;
if let Response::Nip04Encrypt(content) = res {
EventBuilder::new(
Kind::EncryptedDirectMessage,
content,
[Tag::public_key(receiver)],
)
} else {
return Err(Error::ResponseNotMatchRequest);
}
} else {
let keys = self.keys.read().await;
EventBuilder::new_encrypted_direct_msg(&keys, receiver, msg, reply_to)?
};
#[cfg(not(feature = "nip46"))]
let builder = EventBuilder::new_encrypted_direct_msg(&self.keys, receiver, msg, reply_to)?;
self.send_event_builder(builder).await
}
/// Repost event
pub async fn repost_event(
&self,
event_id: EventId,
public_key: XOnlyPublicKey,
) -> Result<EventId, Error> {
let builder = EventBuilder::repost(event_id, public_key);
self.send_event_builder(builder).await
}
/// Delete event
///
/// <https://github.com/nostr-protocol/nips/blob/master/09.md>
pub async fn delete_event<T>(&self, id: T) -> Result<EventId, Error>
where
T: Into<EventIdOrCoordinate>,
{
let builder = EventBuilder::delete([id]);
self.send_event_builder(builder).await
}
/// Like event
///
/// <https://github.com/nostr-protocol/nips/blob/master/25.md>
///
/// # Example
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let event_id =
/// EventId::from_hex("3aded8d2194dc2fedb1d7b70480b43b6c4deb0a22dcdc9c471d1958485abcf21")
/// .unwrap();
/// let public_key = XOnlyPublicKey::from_str(
/// "a8e76c3ace7829f9ee44cf9293309e21a1824bf1e57631d00685a1ed0b0bd8a2",
/// )
/// .unwrap();
///
/// client.like(event_id, public_key).await.unwrap();
/// # }
/// ```
pub async fn like(
&self,
event_id: EventId,
public_key: XOnlyPublicKey,
) -> Result<EventId, Error> {
let builder = EventBuilder::new_reaction(event_id, public_key, "+");
self.send_event_builder(builder).await
}
/// Disike event
///
/// <https://github.com/nostr-protocol/nips/blob/master/25.md>
///
/// # Example
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let event_id =
/// EventId::from_hex("3aded8d2194dc2fedb1d7b70480b43b6c4deb0a22dcdc9c471d1958485abcf21")
/// .unwrap();
/// let public_key = XOnlyPublicKey::from_str(
/// "a8e76c3ace7829f9ee44cf9293309e21a1824bf1e57631d00685a1ed0b0bd8a2",
/// )
/// .unwrap();
///
/// client.dislike(event_id, public_key).await.unwrap();
/// # }
/// ```
pub async fn dislike(
&self,
event_id: EventId,
public_key: XOnlyPublicKey,
) -> Result<EventId, Error> {
let builder = EventBuilder::new_reaction(event_id, public_key, "-");
self.send_event_builder(builder).await
}
/// React to an [`Event`]
///
/// <https://github.com/nostr-protocol/nips/blob/master/25.md>
///
/// # Example
/// ```rust,no_run
/// use std::str::FromStr;
///
/// use nostr_sdk::prelude::*;
///
/// # #[tokio::main]
/// # async fn main() {
/// # let my_keys = Keys::generate();
/// # let client = Client::new(&my_keys);
/// let event_id =
/// EventId::from_hex("3aded8d2194dc2fedb1d7b70480b43b6c4deb0a22dcdc9c471d1958485abcf21")
/// .unwrap();
/// let public_key = XOnlyPublicKey::from_str(
/// "a8e76c3ace7829f9ee44cf9293309e21a1824bf1e57631d00685a1ed0b0bd8a2",
/// )
/// .unwrap();
///
/// client.reaction(event_id, public_key, "🐻").await.unwrap();
/// # }
/// ```
pub async fn reaction<S>(
&self,
event_id: EventId,
public_key: XOnlyPublicKey,
content: S,
) -> Result<EventId, Error>
where
S: Into<String>,
{
let builder = EventBuilder::new_reaction(event_id, public_key, content);
self.send_event_builder(builder).await
}
/// Create new channel
///
/// <https://github.com/nostr-protocol/nips/blob/master/28.md>
pub async fn new_channel(&self, metadata: &Metadata) -> Result<EventId, Error> {
let builder = EventBuilder::new_channel(metadata);
self.send_event_builder(builder).await
}
/// Update channel metadata
///
/// <https://github.com/nostr-protocol/nips/blob/master/28.md>
pub async fn set_channel_metadata(
&self,
channel_id: EventId,
relay_url: Option<Url>,
metadata: &Metadata,
) -> Result<EventId, Error> {
let builder = EventBuilder::set_channel_metadata(channel_id, relay_url, metadata);
self.send_event_builder(builder).await
}
/// Send message to channel
///
/// <https://github.com/nostr-protocol/nips/blob/master/28.md>
pub async fn send_channel_msg<S>(
&self,
channel_id: EventId,
relay_url: Url,
msg: S,
) -> Result<EventId, Error>
where
S: Into<String>,
{
let builder = EventBuilder::new_channel_msg(channel_id, relay_url, msg);
self.send_event_builder(builder).await
}
/// Hide channel message
///
/// <https://github.com/nostr-protocol/nips/blob/master/28.md>
pub async fn hide_channel_msg<S>(
&self,
message_id: EventId,
reason: Option<S>,
) -> Result<EventId, Error>
where
S: Into<String>,
{
let builder = EventBuilder::hide_channel_msg(message_id, reason);
self.send_event_builder(builder).await
}
/// Mute channel user
///
/// <https://github.com/nostr-protocol/nips/blob/master/28.md>
pub async fn mute_channel_user<S>(
&self,
pubkey: XOnlyPublicKey,
reason: Option<S>,
) -> Result<EventId, Error>
where
S: Into<String>,
{
let builder = EventBuilder::mute_channel_user(pubkey, reason);
self.send_event_builder(builder).await
}
/// Create an auth event
///
/// <https://github.com/nostr-protocol/nips/blob/master/42.md>
pub async fn auth<S>(&self, challenge: S, relay: Url) -> Result<EventId, Error>
where
S: Into<String>,
{
let builder = EventBuilder::auth(challenge, relay);
self.send_event_builder(builder).await
}
/// Create zap receipt event
///
/// <https://github.com/nostr-protocol/nips/blob/master/57.md>
pub async fn new_zap_receipt<S>(
&self,
bolt11: S,
preimage: Option<S>,
zap_request: Event,
) -> Result<EventId, Error>
where
S: Into<String>,
{
let builder = EventBuilder::new_zap_receipt(bolt11, preimage, zap_request);
self.send_event_builder(builder).await
}
/// File metadata
///
/// <https://github.com/nostr-protocol/nips/blob/master/94.md>
pub async fn file_metadata<S>(
&self,
description: S,
metadata: FileMetadata,
) -> Result<EventId, Error>
where
S: Into<String>,
{
let builder = EventBuilder::file_metadata(description, metadata);
self.send_event_builder(builder).await
}
/// Negentropy reconciliation
pub async fn reconcile(&self, filter: Filter, opts: NegentropyOptions) -> Result<(), Error> {
Ok(self.pool.reconcile(filter, opts).await?)
}
/// Negentropy reconciliation with items
pub async fn reconcile_with_items(
&self,
filter: Filter,
items: Vec<(EventId, Timestamp)>,
opts: NegentropyOptions,
) -> Result<(), Error> {
Ok(self.pool.reconcile_with_items(filter, items, opts).await?)
}
/// Get a list of channels
pub async fn get_channels(&self, timeout: Option<Duration>) -> Result<Vec<Event>, Error> {
self.get_events_of(vec![Filter::new().kind(Kind::ChannelCreation)], timeout)
.await
}
/// Handle notifications
pub async fn handle_notifications<F, Fut>(&self, func: F) -> Result<(), Error>
where
F: Fn(RelayPoolNotification) -> Fut,
Fut: Future<Output = Result<bool>>,
{
let mut notifications = self.notifications();
while let Ok(notification) = notifications.recv().await {
let stop: bool = RelayPoolNotification::Stop == notification;
let shutdown: bool = RelayPoolNotification::Shutdown == notification;
let exit: bool = func(notification)
.await
.map_err(|e| Error::Handler(e.to_string()))?;
if exit || stop || shutdown {
break;
}
}
Ok(())
}
}