signer: add NostrSigner::unwrap_gift_wrap method

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

Author: yukibtc

CHANGELOG.md

@@ -40,6 +40,7 @@
 * nostr: add `EventBuilder::interest_set` ([Yuki Kishimoto])
 * nostr: add `title`, `image` and `description` constructors to `Tag` ([Yuki Kishimoto])
 * pool: add `SendOutput` and `SendEventOutput` structs ([Yuki Kishimoto])
+* signer: add `NostrSigner::unwrap_gift_wrap` method ([Yuki Kishimoto])
 * js(sdk): partially expose `JsRelayPool` ([Yuki Kishimoto])
 * book: add some python examples ([RydalWater])
 

bindings/nostr-ffi/src/nips/nip59.rs

@@ -54,6 +54,12 @@ pub struct UnwrappedGift {
     inner: nip59::UnwrappedGift,
 }
 
+impl From<nip59::UnwrappedGift> for UnwrappedGift {
+    fn from(inner: nostr::prelude::UnwrappedGift) -> Self {
+        Self { inner }
+    }
+}
+
 #[uniffi::export]
 impl UnwrappedGift {
     /// Unwrap Gift Wrap event

bindings/nostr-js/src/nips/nip59.rs

@@ -19,6 +19,12 @@ pub struct JsUnwrappedGift {
     inner: UnwrappedGift,
 }
 
+impl From<UnwrappedGift> for JsUnwrappedGift {
+    fn from(inner: UnwrappedGift) -> Self {
+        Self { inner }
+    }
+}
+
 #[wasm_bindgen(js_class = UnwrappedGift)]
 impl JsUnwrappedGift {
     /// Unwrap Gift Wrap event

bindings/nostr-sdk-ffi/src/client/signer/mod.rs

@@ -4,6 +4,7 @@
 
 use std::ops::Deref;
 
+use nostr_ffi::nips::nip59::UnwrappedGift;
 use nostr_ffi::{Event, EventBuilder, Keys, PublicKey, UnsignedEvent};
 use nostr_sdk::signer;
 use uniffi::Object;
@@ -91,4 +92,13 @@ impl NostrSigner {
     pub async fn nip44_decrypt(&self, public_key: &PublicKey, content: String) -> Result<String> {
         Ok(self.inner.nip44_decrypt(**public_key, content).await?)
     }
+
+    /// Unwrap Gift Wrap event
+    ///
+    /// Internally verify the `seal` event
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/59.md>
+    pub async fn unwrap_gift_wrap(&self, gift_wrap: &Event) -> Result<UnwrappedGift> {
+        Ok(self.inner.unwrap_gift_wrap(gift_wrap.deref()).await?.into())
+    }
 }

bindings/nostr-sdk-js/src/client/signer/mod.rs

@@ -8,6 +8,7 @@ use nostr_js::error::{into_err, Result};
 use nostr_js::event::{JsEvent, JsEventBuilder, JsUnsignedEvent};
 use nostr_js::key::{JsKeys, JsPublicKey};
 use nostr_js::nips::nip07::JsNip07Signer;
+use nostr_js::nips::nip59::JsUnwrappedGift;
 use nostr_sdk::NostrSigner;
 use wasm_bindgen::prelude::*;
 
@@ -118,4 +119,19 @@ impl JsNostrSigner {
             .await
             .map_err(into_err)
     }
+
+    /// Unwrap Gift Wrap event
+    ///
+    /// Internally verify the `seal` event
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/59.md>
+    #[wasm_bindgen(js_name = unwrapGiftWrap)]
+    pub async fn unwrap_gift_wrap(&self, gift_wrap: &JsEvent) -> Result<JsUnwrappedGift> {
+        Ok(self
+            .inner
+            .unwrap_gift_wrap(gift_wrap.deref())
+            .await
+            .map_err(into_err)?
+            .into())
+    }
 }

crates/nostr-sdk/Cargo.toml

@@ -34,7 +34,7 @@ nip46 = ["nostr/nip46", "nostr-signer/nip46"]
 nip47 = ["nostr/nip47", "dep:nwc"]
 nip49 = ["nostr/nip49"]
 nip57 = ["nostr/nip57", "dep:nostr-zapper", "dep:lnurl-pay"]
-nip59 = ["nostr/nip59"]
+nip59 = ["nostr/nip59", "nostr-signer/nip59"]
 
 [dependencies]
 async-utility.workspace = true

crates/nostr-signer/Cargo.toml

@@ -12,11 +12,12 @@ rust-version.workspace = true
 keywords = ["nostr", "signer"]
 
 [features]
-default = ["nip04", "nip07", "nip44", "nip46"]
+default = ["nip04", "nip07", "nip44", "nip46", "nip59"]
 nip04 = ["nostr/nip04"]
 nip07 = ["nostr/nip07"]
 nip44 = ["nostr/nip44"]
 nip46 = ["nostr/nip46", "dep:nostr-relay-pool", "dep:tracing"]
+nip59 = ["nostr/nip59"]
 
 [dependencies]
 async-utility.workspace = true

crates/nostr-signer/README.md

@@ -12,6 +12,7 @@ The following crate feature flags are available:
 | `nip07` |   Yes   | Enable NIP-07: `window.nostr` capability for web browsers (**available only for `wasm32`!**) |
 | `nip44` |   Yes   | Enable NIP-44: Encrypted Payloads (Versioned)                                                |
 | `nip46` |   Yes   | Enable NIP-46: Nostr Connect                                                                 |
+| `nip59` |   Yes   | Enable NIP-59: Gift Wrap                                                                     |
 
 ## State
 

crates/nostr-signer/src/lib.rs

@@ -10,7 +10,6 @@
 
 use std::fmt;
 
-use nostr::key;
 use nostr::prelude::*;
 use thiserror::Error;
 
@@ -46,6 +45,14 @@ pub enum Error {
     #[cfg(feature = "nip46")]
     #[error(transparent)]
     NIP46(#[from] nip46::Error),
+    /// NIP59 error
+    #[cfg(feature = "nip59")]
+    #[error(transparent)]
+    NIP59(#[from] nip59::Error),
+    /// Event error
+    #[cfg(feature = "nip59")]
+    #[error(transparent)]
+    Event(#[from] event::Error),
 }
 
 /// Nostr Signer Type
@@ -217,6 +224,35 @@ impl NostrSigner {
             Self::NIP46(signer) => Ok(signer.nip44_decrypt(public_key, payload).await?),
         }
     }
+
+    /// Unwrap Gift Wrap event
+    ///
+    /// Internally verify the `seal` event
+    ///
+    /// <https://github.com/nostr-protocol/nips/blob/master/59.md>
+    // TODO: find a way to merge this with the `Keys` implementation in `nostr` crate
+    #[cfg(feature = "nip59")]
+    pub async fn unwrap_gift_wrap(&self, gift_wrap: &Event) -> Result<UnwrappedGift, Error> {
+        // Check event kind
+        if gift_wrap.kind != Kind::GiftWrap {
+            return Err(Error::NIP59(nip59::Error::NotGiftWrap));
+        }
+
+        // Decrypt and verify seal
+        let seal: String = self
+            .nip44_decrypt(gift_wrap.author(), gift_wrap.content())
+            .await?;
+        let seal: Event = Event::from_json(seal)?;
+        seal.verify()?;
+
+        // Decrypt rumor
+        let rumor: String = self.nip44_decrypt(seal.author(), seal.content()).await?;
+
+        Ok(UnwrappedGift {
+            sender: seal.author(),
+            rumor: UnsignedEvent::from_json(rumor)?,
+        })
+    }
 }
 
 impl From<Keys> for NostrSigner {

crates/nostr/src/prelude.rs

@@ -17,14 +17,14 @@ pub use negentropy::Negentropy;
 pub use serde_json::Value;
 
 // Internal modules
-pub use crate::event::builder::*;
-pub use crate::event::id::*;
-pub use crate::event::kind::*;
-pub use crate::event::tag::*;
-pub use crate::event::unsigned::*;
-pub use crate::event::*;
-pub use crate::key::*;
-pub use crate::message::*;
+pub use crate::event::builder::{self, *};
+pub use crate::event::id::{self, *};
+pub use crate::event::kind::{self, *};
+pub use crate::event::tag::{self, *};
+pub use crate::event::unsigned::{self, *};
+pub use crate::event::{self, *};
+pub use crate::key::{self, *};
+pub use crate::message::{self, *};
 // NIPs
 pub use crate::nips::nip01::{self, *};
 #[cfg(feature = "nip04")]