nostr: add identifier arg to NIP-51 EventBuilder set constructors

Closes #466

Signed-off-by: Yuki Kishimoto <[email protected]>

Author: yukibtc

CHANGELOG.md

@@ -29,6 +29,7 @@
 
 * nostr: rename NIP-51 `EventBuilder` set constructors and `Kind` variants ([Yuki Kishimoto])
 * nostr: small adj. to NIP-47 `ListTransactionsRequestParams` and `LookupInvoiceResponseResult` structs ([Yuki Kishimoto])
+* nostr: add `identifier` arg to NIP-51 `EventBuilder` set constructors ([Yuki Kishimoto])
 * pool: use per-purpose dedicated relay channels ([Yuki Kishimoto])
 * pool: return relay urls to which `messages`/`events` have or not been sent for `send_*` and `batch_*` methods ([Yuki Kishimoto])
 * ffi(sdk): convert `RelayPool::handle_notifications` method to async/future ([Yuki Kishimoto])

bindings/nostr-ffi/src/event/builder.rs

@@ -686,49 +686,56 @@ impl EventBuilder {
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn follow_set(public_keys: Vec<Arc<PublicKey>>) -> Self {
+    pub fn follow_set(identifier: &str, public_keys: Vec<Arc<PublicKey>>) -> Self {
         Self {
-            inner: nostr::EventBuilder::follow_set(public_keys.into_iter().map(|p| **p)),
+            inner: nostr::EventBuilder::follow_set(
+                identifier,
+                public_keys.into_iter().map(|p| **p),
+            ),
         }
     }
 
     /// Relay set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn relay_set(relays: Vec<String>) -> Self {
+    pub fn relay_set(identifier: &str, relays: Vec<String>) -> Self {
         Self {
-            inner: nostr::EventBuilder::relay_set(relays.into_iter().map(UncheckedUrl::from)),
+            inner: nostr::EventBuilder::relay_set(
+                identifier,
+                relays.into_iter().map(UncheckedUrl::from),
+            ),
         }
     }
 
     /// Bookmark set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn bookmarks_set(list: Bookmarks) -> Result<Self> {
+    pub fn bookmarks_set(identifier: &str, list: Bookmarks) -> Result<Self> {
         Ok(Self {
-            inner: nostr::EventBuilder::bookmarks_set(list.try_into()?),
+            inner: nostr::EventBuilder::bookmarks_set(identifier, list.try_into()?),
         })
     }
 
     /// Article Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn articles_curation_set(list: ArticlesCuration) -> Self {
+    pub fn articles_curation_set(identifier: &str, list: ArticlesCuration) -> Self {
         Self {
-            inner: nostr::EventBuilder::articles_curation_set(list.into()),
+            inner: nostr::EventBuilder::articles_curation_set(identifier, list.into()),
         }
     }
 
     /// Videos Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn videos_curation_set(video: Vec<Arc<Coordinate>>) -> Self {
+    pub fn videos_curation_set(identifier: &str, video: Vec<Arc<Coordinate>>) -> Self {
         Self {
             inner: nostr::EventBuilder::videos_curation_set(
+                identifier,
                 video.into_iter().map(|c| c.as_ref().deref().clone()),
             ),
         }
@@ -738,19 +745,19 @@ impl EventBuilder {
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn interest_set(hashtags: Vec<String>) -> Self {
+    pub fn interest_set(identifier: &str, hashtags: Vec<String>) -> Self {
         Self {
-            inner: nostr::EventBuilder::interest_set(hashtags),
+            inner: nostr::EventBuilder::interest_set(identifier, hashtags),
         }
     }
 
     /// Emoji set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn emoji_set(emojis: Vec<EmojiInfo>) -> Self {
+    pub fn emoji_set(identifier: &str, emojis: Vec<EmojiInfo>) -> Self {
         Self {
-            inner: nostr::EventBuilder::emoji_set(emojis.into_iter().map(|e| e.into())),
+            inner: nostr::EventBuilder::emoji_set(identifier, emojis.into_iter().map(|e| e.into())),
         }
     }
 

bindings/nostr-js/src/event/builder.rs

@@ -705,69 +705,72 @@ impl JsEventBuilder {
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[wasm_bindgen(js_name = followSet)]
-    pub fn follow_set(public_keys: Vec<JsPublicKey>) -> Self {
+    pub fn follow_set(identifier: &str, public_keys: Vec<JsPublicKey>) -> Self {
         Self {
-            inner: EventBuilder::follow_set(public_keys.into_iter().map(|p| p.into())),
+            inner: EventBuilder::follow_set(identifier, public_keys.into_iter().map(|p| p.into())),
         }
     }
 
     /// Relay set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[wasm_bindgen(js_name = relaySet)]
-    pub fn relay_set(relays: Vec<String>) -> Self {
+    pub fn relay_set(identifier: &str, relays: Vec<String>) -> Self {
         Self {
-            inner: EventBuilder::relay_set(relays.into_iter().map(UncheckedUrl::from)),
+            inner: EventBuilder::relay_set(identifier, relays.into_iter().map(UncheckedUrl::from)),
         }
     }
 
     /// Bookmark set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[wasm_bindgen(js_name = bookmarksSet)]
-    pub fn bookmarks_set(list: &JsBookmarks) -> Result<JsEventBuilder> {
+    pub fn bookmarks_set(identifier: &str, list: &JsBookmarks) -> Result<JsEventBuilder> {
         Ok(Self {
-            inner: EventBuilder::bookmarks_set(list.clone().try_into()?),
+            inner: EventBuilder::bookmarks_set(identifier, list.clone().try_into()?),
         })
     }
 
     /// Article Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[wasm_bindgen(js_name = articlesCurationSet)]
-    pub fn articles_curation_set(list: &JsArticlesCuration) -> Self {
+    pub fn articles_curation_set(identifier: &str, list: &JsArticlesCuration) -> Self {
         Self {
-            inner: EventBuilder::articles_curation_set(list.clone().into()),
+            inner: EventBuilder::articles_curation_set(identifier, list.clone().into()),
         }
     }
 
     /// Videos Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[wasm_bindgen(js_name = videosCurationSet)]
-    pub fn videos_curation_set(video: Vec<JsCoordinate>) -> Self {
+    pub fn videos_curation_set(identifier: &str, video: Vec<JsCoordinate>) -> Self {
         Self {
-            inner: EventBuilder::videos_curation_set(video.into_iter().map(|c| c.deref().clone())),
+            inner: EventBuilder::videos_curation_set(
+                identifier,
+                video.into_iter().map(|c| c.deref().clone()),
+            ),
         }
     }
 
     /// Interest set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[wasm_bindgen(js_name = interestSet)]
-    pub fn interest_set(hashtags: Vec<String>) -> Self {
+    pub fn interest_set(identifier: &str, hashtags: Vec<String>) -> Self {
         Self {
-            inner: EventBuilder::interest_set(hashtags),
+            inner: EventBuilder::interest_set(identifier, hashtags),
         }
     }
 
     /// Emoji set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[wasm_bindgen(js_name = emojiSet)]
-    pub fn emoji_set(emoji: Vec<JsEmojiInfo>) -> Self {
+    pub fn emoji_set(identifier: &str, emoji: Vec<JsEmojiInfo>) -> Self {
         Self {
-            inner: EventBuilder::emoji_set(emoji.into_iter().map(|e| e.into())),
+            inner: EventBuilder::emoji_set(identifier, emoji.into_iter().map(|e| e.into())),
         }
     }
 

crates/nostr/src/event/builder.rs

@@ -1508,95 +1508,115 @@ impl EventBuilder {
     /// Follow set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[inline]
-    pub fn follow_set<I>(public_keys: I) -> Self
+    pub fn follow_set<ID, I>(identifier: ID, public_keys: I) -> Self
     where
+        ID: Into<String>,
         I: IntoIterator<Item = PublicKey>,
     {
+        let tags: Vec<Tag> = vec![Tag::identifier(identifier)];
         Self::new(
             Kind::FollowSet,
             "",
-            public_keys.into_iter().map(Tag::public_key),
+            tags.into_iter()
+                .chain(public_keys.into_iter().map(Tag::public_key)),
         )
     }
 
     /// Relay set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[inline]
-    pub fn relay_set<I>(relay: I) -> Self
+    pub fn relay_set<ID, I>(identifier: ID, relays: I) -> Self
     where
+        ID: Into<String>,
         I: IntoIterator<Item = UncheckedUrl>,
     {
+        let tags: Vec<Tag> = vec![Tag::identifier(identifier)];
         Self::new(
             Kind::RelaySet,
             "",
-            relay
-                .into_iter()
-                .map(|r| Tag::from_standardized_without_cell(TagStandard::Relay(r))),
+            tags.into_iter().chain(
+                relays
+                    .into_iter()
+                    .map(|r| Tag::from_standardized_without_cell(TagStandard::Relay(r))),
+            ),
         )
     }
 
     /// Bookmark set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[inline]
-    pub fn bookmarks_set(list: Bookmarks) -> Self {
-        let tags: Vec<Tag> = list.into();
+    pub fn bookmarks_set<ID>(identifier: ID, list: Bookmarks) -> Self
+    where
+        ID: Into<String>,
+    {
+        let mut tags: Vec<Tag> = list.into();
+        tags.push(Tag::identifier(identifier));
         Self::new(Kind::BookmarkSet, "", tags)
     }
 
     /// Article Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[inline]
-    pub fn articles_curation_set(list: ArticlesCuration) -> Self {
-        let tags: Vec<Tag> = list.into();
+    pub fn articles_curation_set<ID>(identifier: ID, list: ArticlesCuration) -> Self
+    where
+        ID: Into<String>,
+    {
+        let mut tags: Vec<Tag> = list.into();
+        tags.push(Tag::identifier(identifier));
         Self::new(Kind::ArticlesCurationSet, "", tags)
     }
 
     /// Videos Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[inline]
-    pub fn videos_curation_set<I>(video: I) -> Self
+    pub fn videos_curation_set<ID, I>(identifier: ID, video: I) -> Self
     where
+        ID: Into<String>,
         I: IntoIterator<Item = Coordinate>,
     {
+        let tags: Vec<Tag> = vec![Tag::identifier(identifier)];
         Self::new(
             Kind::VideosCurationSet,
             "",
-            video.into_iter().map(Tag::from),
+            tags.into_iter()
+                .chain(video.into_iter().map(Tag::coordinate)),
         )
     }
 
     /// Interest set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[inline]
-    pub fn interest_set<I, S>(hashtags: I) -> Self
+    pub fn interest_set<ID, I, S>(identifier: ID, hashtags: I) -> Self
     where
+        ID: Into<String>,
         I: IntoIterator<Item = S>,
         S: Into<String>,
     {
+        let tags: Vec<Tag> = vec![Tag::identifier(identifier)];
         Self::new(
             Kind::InterestSet,
             "",
-            hashtags.into_iter().map(|t| Tag::hashtag(t)),
+            tags.into_iter()
+                .chain(hashtags.into_iter().map(Tag::hashtag)),
         )
     }
 
     /// Emoji set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    pub fn emoji_set<I>(emoji: I) -> Self
+    pub fn emoji_set<ID, I>(identifier: ID, emojis: I) -> Self
     where
+        ID: Into<String>,
         I: IntoIterator<Item = (String, UncheckedUrl)>,
     {
-        let tags = emoji.into_iter().map(|(s, url)| {
-            Tag::from_standardized_without_cell(TagStandard::Emoji { shortcode: s, url })
-        });
-        Self::new(Kind::EmojiSet, "", tags)
+        let tags: Vec<Tag> = vec![Tag::identifier(identifier)];
+        Self::new(
+            Kind::EmojiSet,
+            "",
+            tags.into_iter().chain(emojis.into_iter().map(|(s, url)| {
+                Tag::from_standardized_without_cell(TagStandard::Emoji { shortcode: s, url })
+            })),
+        )
     }
 
     /// Label