nostr: rename NIP-51 EventBuilder set constructors and Kind variants

Ref #465

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

Author: yukibtc

CHANGELOG.md

@@ -27,6 +27,7 @@
 
 ### Changed
 
+* nostr: rename NIP-51 `EventBuilder` set constructors and `Kind` variants ([Yuki Kishimoto])
 * pool: use per-purpose dedicated relay channels ([Yuki Kishimoto])
 * ffi(sdk): convert `RelayPool::handle_notifications` method to async/future ([Yuki Kishimoto])
 

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

@@ -682,65 +682,65 @@ impl EventBuilder {
         }
     }
 
-    /// Follow sets
+    /// Follow set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn follow_sets(publick_keys: Vec<Arc<PublicKey>>) -> Self {
+    pub fn follow_set(public_keys: Vec<Arc<PublicKey>>) -> Self {
         Self {
-            inner: nostr::EventBuilder::follow_sets(publick_keys.into_iter().map(|p| **p)),
+            inner: nostr::EventBuilder::follow_set(public_keys.into_iter().map(|p| **p)),
         }
     }
 
-    /// Relay sets
+    /// Relay set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn relay_sets(relay: Vec<String>) -> Self {
+    pub fn relay_set(relays: Vec<String>) -> Self {
         Self {
-            inner: nostr::EventBuilder::relay_sets(relay.into_iter().map(UncheckedUrl::from)),
+            inner: nostr::EventBuilder::relay_set(relays.into_iter().map(UncheckedUrl::from)),
         }
     }
 
-    /// Bookmark sets
+    /// Bookmark set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn bookmarks_sets(list: Bookmarks) -> Result<Self> {
+    pub fn bookmarks_set(list: Bookmarks) -> Result<Self> {
         Ok(Self {
-            inner: nostr::EventBuilder::bookmarks_sets(list.try_into()?),
+            inner: nostr::EventBuilder::bookmarks_set(list.try_into()?),
         })
     }
 
-    /// Article Curation sets
+    /// Article Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn articles_curation_sets(list: ArticlesCuration) -> Self {
+    pub fn articles_curation_set(list: ArticlesCuration) -> Self {
         Self {
-            inner: nostr::EventBuilder::articles_curation_sets(list.into()),
+            inner: nostr::EventBuilder::articles_curation_set(list.into()),
         }
     }
 
-    /// Videos Curation sets
+    /// Videos Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn videos_curation_sets(video: Vec<Arc<Coordinate>>) -> Self {
+    pub fn videos_curation_set(video: Vec<Arc<Coordinate>>) -> Self {
         Self {
-            inner: nostr::EventBuilder::videos_curation_sets(
+            inner: nostr::EventBuilder::videos_curation_set(
                 video.into_iter().map(|c| c.as_ref().deref().clone()),
             ),
         }
     }
 
-    /// Emoji sets
+    /// Emoji set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[uniffi::constructor]
-    pub fn emoji_sets(emojis: Vec<EmojiInfo>) -> Self {
+    pub fn emoji_set(emojis: Vec<EmojiInfo>) -> Self {
         Self {
-            inner: nostr::EventBuilder::emoji_sets(emojis.into_iter().map(|e| e.into())),
+            inner: nostr::EventBuilder::emoji_set(emojis.into_iter().map(|e| e.into())),
         }
     }
 

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

@@ -153,38 +153,38 @@ pub enum KindEnum {
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     Emojis,
-    /// Follow Sets
+    /// Follow Set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    FollowSets,
-    /// Relay Sets
+    FollowSet,
+    /// Relay Set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    RelaySets,
-    /// Bookmark Sets
+    RelaySet,
+    /// Bookmark Set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    BookmarkSets,
-    /// Articles Curation Sets
+    BookmarkSet,
+    /// Articles Curation Set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    ArticlesCurationSets,
-    /// Videos Curation Sets
+    ArticlesCurationSet,
+    /// Videos Curation Set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    VideosCurationSets,
-    /// Interest Sets
+    VideosCurationSet,
+    /// Interest Set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    InterestSets,
-    /// Emoji Sets
+    InterestSet,
+    /// Emoji Set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    EmojiSets,
-    /// Release Artifact Sets
+    EmojiSet,
+    /// Release Artifact Set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    ReleaseArtifactSets,
+    ReleaseArtifactSet,
     /// Relay List Metadata (NIP65)
     RelayList,
     /// Client Authentication (NIP42)
@@ -288,14 +288,14 @@ impl From<nostr::Kind> for KindEnum {
             nostr::Kind::SimpleGroups => Self::SimpleGroups,
             nostr::Kind::Interests => Self::Interests,
             nostr::Kind::Emojis => Self::Emojis,
-            nostr::Kind::FollowSets => Self::FollowSets,
-            nostr::Kind::RelaySets => Self::RelaySets,
-            nostr::Kind::BookmarkSets => Self::BookmarkSets,
-            nostr::Kind::ArticlesCurationSets => Self::ArticlesCurationSets,
-            nostr::Kind::VideosCurationSets => Self::VideosCurationSets,
-            nostr::Kind::InterestSets => Self::InterestSets,
-            nostr::Kind::EmojiSets => Self::EmojiSets,
-            nostr::Kind::ReleaseArtifactSets => Self::ReleaseArtifactSets,
+            nostr::Kind::FollowSet => Self::FollowSet,
+            nostr::Kind::RelaySet => Self::RelaySet,
+            nostr::Kind::BookmarkSet => Self::BookmarkSet,
+            nostr::Kind::ArticlesCurationSet => Self::ArticlesCurationSet,
+            nostr::Kind::VideosCurationSet => Self::VideosCurationSet,
+            nostr::Kind::InterestSet => Self::InterestSet,
+            nostr::Kind::EmojiSet => Self::EmojiSet,
+            nostr::Kind::ReleaseArtifactSet => Self::ReleaseArtifactSet,
             nostr::Kind::RelayList => Self::RelayList,
             nostr::Kind::Authentication => Self::Authentication,
             nostr::Kind::WalletConnectRequest => Self::WalletConnectRequest,
@@ -366,14 +366,14 @@ impl From<KindEnum> for nostr::Kind {
             KindEnum::SimpleGroups => Self::SimpleGroups,
             KindEnum::Interests => Self::Interests,
             KindEnum::Emojis => Self::Emojis,
-            KindEnum::FollowSets => Self::FollowSets,
-            KindEnum::RelaySets => Self::RelaySets,
-            KindEnum::BookmarkSets => Self::BookmarkSets,
-            KindEnum::ArticlesCurationSets => Self::ArticlesCurationSets,
-            KindEnum::VideosCurationSets => Self::VideosCurationSets,
-            KindEnum::InterestSets => Self::InterestSets,
-            KindEnum::EmojiSets => Self::EmojiSets,
-            KindEnum::ReleaseArtifactSets => Self::ReleaseArtifactSets,
+            KindEnum::FollowSet => Self::FollowSet,
+            KindEnum::RelaySet => Self::RelaySet,
+            KindEnum::BookmarkSet => Self::BookmarkSet,
+            KindEnum::ArticlesCurationSet => Self::ArticlesCurationSet,
+            KindEnum::VideosCurationSet => Self::VideosCurationSet,
+            KindEnum::InterestSet => Self::InterestSet,
+            KindEnum::EmojiSet => Self::EmojiSet,
+            KindEnum::ReleaseArtifactSet => Self::ReleaseArtifactSet,
             KindEnum::RelayList => Self::RelayList,
             KindEnum::Authentication => Self::Authentication,
             KindEnum::WalletConnectRequest => Self::WalletConnectRequest,

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

@@ -701,63 +701,63 @@ impl JsEventBuilder {
         }
     }
 
-    /// Follow sets
+    /// Follow set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[wasm_bindgen(js_name = followSets)]
-    pub fn follow_sets(public_keys: Vec<JsPublicKey>) -> Self {
+    #[wasm_bindgen(js_name = followSet)]
+    pub fn follow_set(public_keys: Vec<JsPublicKey>) -> Self {
         Self {
-            inner: EventBuilder::follow_sets(public_keys.into_iter().map(|p| p.into())),
+            inner: EventBuilder::follow_set(public_keys.into_iter().map(|p| p.into())),
         }
     }
 
-    /// Relay sets
+    /// Relay set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[wasm_bindgen(js_name = relaySets)]
-    pub fn relay_sets(relays: Vec<String>) -> Self {
+    #[wasm_bindgen(js_name = relaySet)]
+    pub fn relay_set(relays: Vec<String>) -> Self {
         Self {
-            inner: EventBuilder::relay_sets(relays.into_iter().map(UncheckedUrl::from)),
+            inner: EventBuilder::relay_set(relays.into_iter().map(UncheckedUrl::from)),
         }
     }
 
-    /// Bookmark sets
+    /// Bookmark set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[wasm_bindgen(js_name = bookmarksSets)]
-    pub fn bookmarks_sets(list: &JsBookmarks) -> Result<JsEventBuilder> {
+    #[wasm_bindgen(js_name = bookmarksSet)]
+    pub fn bookmarks_set(list: &JsBookmarks) -> Result<JsEventBuilder> {
         Ok(Self {
-            inner: EventBuilder::bookmarks_sets(list.clone().try_into()?),
+            inner: EventBuilder::bookmarks_set(list.clone().try_into()?),
         })
     }
 
-    /// Article Curation sets
+    /// Article Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[wasm_bindgen(js_name = articlesCurationSets)]
-    pub fn articles_curation_sets(list: &JsArticlesCuration) -> Self {
+    #[wasm_bindgen(js_name = articlesCurationSet)]
+    pub fn articles_curation_set(list: &JsArticlesCuration) -> Self {
         Self {
-            inner: EventBuilder::articles_curation_sets(list.clone().into()),
+            inner: EventBuilder::articles_curation_set(list.clone().into()),
         }
     }
 
-    /// Videos Curation sets
+    /// Videos Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[wasm_bindgen(js_name = videosCurationSets)]
-    pub fn videos_curation_sets(video: Vec<JsCoordinate>) -> Self {
+    #[wasm_bindgen(js_name = videosCurationSet)]
+    pub fn videos_curation_set(video: Vec<JsCoordinate>) -> Self {
         Self {
-            inner: EventBuilder::videos_curation_sets(video.into_iter().map(|c| c.deref().clone())),
+            inner: EventBuilder::videos_curation_set(video.into_iter().map(|c| c.deref().clone())),
         }
     }
 
-    /// Emoji sets
+    /// Emoji set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    #[wasm_bindgen(js_name = emojiSets)]
-    pub fn emoji_sets(emoji: Vec<JsEmojiInfo>) -> Self {
+    #[wasm_bindgen(js_name = emojiSet)]
+    pub fn emoji_set(emoji: Vec<JsEmojiInfo>) -> Self {
         Self {
-            inner: EventBuilder::emoji_sets(emoji.into_iter().map(|e| e.into())),
+            inner: EventBuilder::emoji_set(emoji.into_iter().map(|e| e.into())),
         }
     }
 

crates/nostr/src/event/builder.rs

@@ -1505,82 +1505,82 @@ impl EventBuilder {
         Self::new(Kind::Emojis, "", tags)
     }
 
-    /// Follow sets
+    /// Follow set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[inline]
-    pub fn follow_sets<I>(public_keys: I) -> Self
+    pub fn follow_set<I>(public_keys: I) -> Self
     where
         I: IntoIterator<Item = PublicKey>,
     {
         Self::new(
-            Kind::FollowSets,
+            Kind::FollowSet,
             "",
             public_keys.into_iter().map(Tag::public_key),
         )
     }
 
-    /// Relay sets
+    /// Relay set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[inline]
-    pub fn relay_sets<I>(relay: I) -> Self
+    pub fn relay_set<I>(relay: I) -> Self
     where
         I: IntoIterator<Item = UncheckedUrl>,
     {
         Self::new(
-            Kind::RelaySets,
+            Kind::RelaySet,
             "",
             relay
                 .into_iter()
                 .map(|r| Tag::from_standardized_without_cell(TagStandard::Relay(r))),
         )
     }
 
-    /// Bookmark sets
+    /// Bookmark set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[inline]
-    pub fn bookmarks_sets(list: Bookmarks) -> Self {
+    pub fn bookmarks_set(list: Bookmarks) -> Self {
         let tags: Vec<Tag> = list.into();
-        Self::new(Kind::BookmarkSets, "", tags)
+        Self::new(Kind::BookmarkSet, "", tags)
     }
 
-    /// Article Curation sets
+    /// Article Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[inline]
-    pub fn articles_curation_sets(list: ArticlesCuration) -> Self {
+    pub fn articles_curation_set(list: ArticlesCuration) -> Self {
         let tags: Vec<Tag> = list.into();
-        Self::new(Kind::ArticlesCurationSets, "", tags)
+        Self::new(Kind::ArticlesCurationSet, "", tags)
     }
 
-    /// Videos Curation sets
+    /// Videos Curation set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
     #[inline]
-    pub fn videos_curation_sets<I>(video: I) -> Self
+    pub fn videos_curation_set<I>(video: I) -> Self
     where
         I: IntoIterator<Item = Coordinate>,
     {
         Self::new(
-            Kind::VideosCurationSets,
+            Kind::VideosCurationSet,
             "",
             video.into_iter().map(Tag::from),
         )
     }
 
-    /// Emoji sets
+    /// Emoji set
     ///
     /// <https://github.com/nostr-protocol/nips/blob/master/51.md>
-    pub fn emoji_sets<I>(emoji: I) -> Self
+    pub fn emoji_set<I>(emoji: I) -> Self
     where
         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::EmojiSets, "", tags)
+        Self::new(Kind::EmojiSet, "", tags)
     }
 
     /// Label