nostr: improve docs of Kind struct methods

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

Author: yukibtc

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

@@ -49,22 +49,6 @@ impl Kind {
         self.inner.into()
     }
 
-    /// Check if it's a NIP90 job request
-    ///
-    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
-    #[inline]
-    pub fn is_job_request(&self) -> bool {
-        self.inner.is_job_request()
-    }
-
-    /// Check if it's a NIP90 job result
-    ///
-    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
-    #[inline]
-    pub fn is_job_result(&self) -> bool {
-        self.inner.is_job_result()
-    }
-
     /// Check if it's regular
     ///
     /// Regular means that event is expected to be stored by relays.
@@ -77,6 +61,9 @@ impl Kind {
 
     /// Check if it's replaceable
     ///
+    /// Replaceable means that, for each combination of `pubkey` and `kind`,
+    /// only the latest event MUST be stored by relays, older versions MAY be discarded.
+    ///
     /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[inline]
     pub fn is_replaceable(&self) -> bool {
@@ -85,6 +72,8 @@ impl Kind {
 
     /// Check if it's ephemeral
     ///
+    /// Ephemeral means that event is not expected to be stored by relays.
+    ///
     /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[inline]
     pub fn is_ephemeral(&self) -> bool {
@@ -93,11 +82,30 @@ impl Kind {
 
     /// Check if it's parameterized replaceable
     ///
+    /// Parametrized replaceable means that, for each combination of `pubkey`, `kind` and the `d` tag's first value,
+    /// only the latest event MUST be stored by relays, older versions MAY be discarded.
+    ///
     /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[inline]
     pub fn is_parameterized_replaceable(&self) -> bool {
         self.inner.is_parameterized_replaceable()
     }
+
+    /// Check if it's a NIP-90 job request
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
+    #[inline]
+    pub fn is_job_request(&self) -> bool {
+        self.inner.is_job_request()
+    }
+
+    /// Check if it's a NIP-90 job result
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
+    #[inline]
+    pub fn is_job_result(&self) -> bool {
+        self.inner.is_job_result()
+    }
 }
 
 #[derive(Enum)]

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

@@ -42,22 +42,6 @@ impl JsKind {
         self.inner.as_u16()
     }
 
-    /// Check if it's a NIP90 job request
-    ///
-    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
-    #[wasm_bindgen(js_name = isJobRequest)]
-    pub fn is_job_request(&self) -> bool {
-        self.inner.is_job_request()
-    }
-
-    /// Check if it's a NIP90 job result
-    ///
-    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
-    #[wasm_bindgen(js_name = isJobResult)]
-    pub fn is_job_result(&self) -> bool {
-        self.inner.is_job_result()
-    }
-
     /// Check if it's regular
     ///
     /// Regular means that event is expected to be stored by relays.
@@ -70,6 +54,9 @@ impl JsKind {
 
     /// Check if it's replaceable
     ///
+    /// Replaceable means that, for each combination of `pubkey` and `kind`,
+    /// only the latest event MUST be stored by relays, older versions MAY be discarded.
+    ///
     /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[wasm_bindgen(js_name = isReplaceable)]
     pub fn is_replaceable(&self) -> bool {
@@ -78,6 +65,8 @@ impl JsKind {
 
     /// Check if it's ephemeral
     ///
+    /// Ephemeral means that event is not expected to be stored by relays.
+    ///
     /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[wasm_bindgen(js_name = isEphemeral)]
     pub fn is_ephemeral(&self) -> bool {
@@ -86,9 +75,28 @@ impl JsKind {
 
     /// Check if it's parameterized replaceable
     ///
+    /// Parametrized replaceable means that, for each combination of `pubkey`, `kind` and the `d` tag's first value,
+    /// only the latest event MUST be stored by relays, older versions MAY be discarded.
+    ///
     /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[wasm_bindgen(js_name = isParametrizedReplaceable)]
     pub fn is_parameterized_replaceable(&self) -> bool {
         self.inner.is_parameterized_replaceable()
     }
+
+    /// Check if it's a NIP-90 job request
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
+    #[wasm_bindgen(js_name = isJobRequest)]
+    pub fn is_job_request(&self) -> bool {
+        self.inner.is_job_request()
+    }
+
+    /// Check if it's a NIP-90 job result
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
+    #[wasm_bindgen(js_name = isJobResult)]
+    pub fn is_job_result(&self) -> bool {
+        self.inner.is_job_result()
+    }
 }

crates/nostr/src/event/kind.rs

@@ -14,9 +14,9 @@ use core::str::FromStr;
 use serde::de::{Deserialize, Deserializer, Error, Visitor};
 use serde::ser::{Serialize, Serializer};
 
-/// NIP90 - Job request range
+/// NIP-90 - Job request range
 pub const NIP90_JOB_REQUEST_RANGE: Range<u16> = 5_000..5_999;
-/// NIP90 - Job result range
+/// NIP-90 - Job result range
 pub const NIP90_JOB_RESULT_RANGE: Range<u16> = 6_000..6_999;
 /// Regular range
 pub const REGULAR_RANGE: Range<u16> = 1_000..10_000;
@@ -219,25 +219,11 @@ impl Kind {
         self.as_u16() as u64
     }
 
-    /// Check if [`Kind`] is a NIP90 job request
-    ///
-    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
-    #[inline]
-    pub fn is_job_request(&self) -> bool {
-        NIP90_JOB_REQUEST_RANGE.contains(&self.as_u16())
-    }
-
-    /// Check if [`Kind`] is a NIP90 job result
-    ///
-    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
-    #[inline]
-    pub fn is_job_result(&self) -> bool {
-        NIP90_JOB_RESULT_RANGE.contains(&self.as_u16())
-    }
-
     /// Check if it's regular
     ///
     /// Regular means that event is expected to be stored by relays.
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     pub fn is_regular(&self) -> bool {
         let kind: u16 = self.as_u16();
 
@@ -250,7 +236,12 @@ impl Kind {
         REGULAR_RANGE.contains(&kind) || !self.is_replaceable()
     }
 
-    /// Check if [`Kind`] is `Replaceable`
+    /// Check if it's replaceable
+    ///
+    /// Replaceable means that, for each combination of `pubkey` and `kind`,
+    /// only the latest event MUST be stored by relays, older versions MAY be discarded.
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[inline]
     pub fn is_replaceable(&self) -> bool {
         matches!(self, Kind::Metadata)
@@ -259,17 +250,42 @@ impl Kind {
             || REPLACEABLE_RANGE.contains(&self.as_u16())
     }
 
-    /// Check if [`Kind`] is `Ephemeral`
+    /// Check if it's ephemeral
+    ///
+    /// Ephemeral means that event is not expected to be stored by relays.
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[inline]
     pub fn is_ephemeral(&self) -> bool {
         EPHEMERAL_RANGE.contains(&self.as_u16())
     }
 
-    /// Check if [`Kind`] is `Parameterized replaceable`
+    /// Check if it's parameterized replaceable
+    ///
+    /// Parametrized replaceable means that, for each combination of `pubkey`, `kind` and the `d` tag's first value,
+    /// only the latest event MUST be stored by relays, older versions MAY be discarded.
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/01.md>
     #[inline]
     pub fn is_parameterized_replaceable(&self) -> bool {
         PARAMETERIZED_REPLACEABLE_RANGE.contains(&self.as_u16())
     }
+
+    /// Check if it's a NIP-90 job request
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
+    #[inline]
+    pub fn is_job_request(&self) -> bool {
+        NIP90_JOB_REQUEST_RANGE.contains(&self.as_u16())
+    }
+
+    /// Check if it's a NIP-90 job result
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/90.md>
+    #[inline]
+    pub fn is_job_result(&self) -> bool {
+        NIP90_JOB_RESULT_RANGE.contains(&self.as_u16())
+    }
 }
 
 impl fmt::Display for Kind {