nostr: small adj. to NIP-47 ListTransactionsRequestParams and LookupInvoiceResponseResult structs

yukibtc · yukibtc · commit e7f4c887a66f · 2024-06-17T12:40:33.000-04:00
Signed-off-by: Yuki Kishimoto &lt;yukikishimoto@protonmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -28,6 +28,7 @@
 ### Changed
 
 * nostr: rename NIP-51 `EventBuilder` set constructors and `Kind` variants ([Yuki Kishimoto])
+* nostr: small adj. to NIP-47 `ListTransactionsRequestParams` and `LookupInvoiceResponseResult` structs ([Yuki Kishimoto])
 * pool: use per-purpose dedicated relay channels ([Yuki Kishimoto])
 * ffi(sdk): convert `RelayPool::handle_notifications` method to async/future ([Yuki Kishimoto])
 
diff --git a/bindings/nostr-ffi/src/nips/nip47.rs b/bindings/nostr-ffi/src/nips/nip47.rs
@@ -10,7 +10,7 @@ use nostr::{JsonUtil, Url};
 use uniffi::{Enum, Object, Record};
 
 use crate::error::Result;
-use crate::{PublicKey, SecretKey};
+use crate::{JsonValue, PublicKey, SecretKey, Timestamp};
 
 /// NIP47 Response Error codes
 #[derive(Enum)]
@@ -480,9 +480,9 @@ impl From<LookupInvoiceRequestParams> for nip47::LookupInvoiceRequestParams {
 #[derive(Record)]
 pub struct ListTransactionsRequestParams {
     /// Starting timestamp in seconds since epoch
-    pub from: Option<u64>,
+    pub from: Option<Arc<Timestamp>>,
     /// Ending timestamp in seconds since epoch
-    pub until: Option<u64>,
+    pub until: Option<Arc<Timestamp>>,
     /// Number of invoices to return
     pub limit: Option<u64>,
     /// Offset of the first invoice to return
@@ -496,8 +496,8 @@ pub struct ListTransactionsRequestParams {
 impl From<nip47::ListTransactionsRequestParams> for ListTransactionsRequestParams {
     fn from(value: nip47::ListTransactionsRequestParams) -> Self {
         Self {
-            from: value.from,
-            until: value.until,
+            from: value.from.map(|t| Arc::new(t.into())),
+            until: value.until.map(|t| Arc::new(t.into())),
             limit: value.limit,
             offset: value.offset,
             unpaid: value.unpaid,
@@ -509,8 +509,8 @@ impl From<nip47::ListTransactionsRequestParams> for ListTransactionsRequestParam
 impl From<ListTransactionsRequestParams> for nip47::ListTransactionsRequestParams {
     fn from(value: ListTransactionsRequestParams) -> Self {
         Self {
-            from: value.from,
-            until: value.until,
+            from: value.from.map(|t| **t),
+            until: value.until.map(|t| **t),
             limit: value.limit,
             offset: value.offset,
             unpaid: value.unpaid,
@@ -651,13 +651,13 @@ pub struct LookupInvoiceResponseResult {
     /// Fees paid in millisatoshis
     pub fees_paid: u64,
     /// Creation timestamp in seconds since epoch
-    pub created_at: u64,
+    pub created_at: Arc<Timestamp>,
     /// Expiration timestamp in seconds since epoch
-    pub expires_at: u64,
+    pub expires_at: Arc<Timestamp>,
     /// Settled timestamp in seconds since epoch
-    pub settled_at: Option<u64>,
+    pub settled_at: Option<Arc<Timestamp>>,
     /// Optional metadata about the payment
-    pub metadata: String,
+    pub metadata: Option<JsonValue>,
 }
 
 impl From<nip47::LookupInvoiceResponseResult> for LookupInvoiceResponseResult {
@@ -671,10 +671,10 @@ impl From<nip47::LookupInvoiceResponseResult> for LookupInvoiceResponseResult {
             payment_hash: value.payment_hash,
             amount: value.amount,
             fees_paid: value.fees_paid,
-            created_at: value.created_at,
-            expires_at: value.expires_at,
-            settled_at: value.settled_at,
-            metadata: value.metadata.to_string(),
+            created_at: Arc::new(value.created_at.into()),
+            expires_at: Arc::new(value.expires_at.into()),
+            settled_at: value.settled_at.map(|t| Arc::new(t.into())),
+            metadata: value.metadata.and_then(|m| m.try_into().ok()),
         }
     }
 }
@@ -690,10 +690,10 @@ impl From<LookupInvoiceResponseResult> for nip47::LookupInvoiceResponseResult {
             payment_hash: value.payment_hash,
             amount: value.amount,
             fees_paid: value.fees_paid,
-            created_at: value.created_at,
-            expires_at: value.expires_at,
-            settled_at: value.settled_at,
-            metadata: value.metadata.into(),
+            created_at: **value.created_at,
+            expires_at: **value.expires_at,
+            settled_at: value.settled_at.map(|t| **t),
+            metadata: value.metadata.and_then(|m| m.try_into().ok()),
         }
     }
 }
diff --git a/bindings/nostr-js/src/nips/nip47.rs b/bindings/nostr-js/src/nips/nip47.rs
@@ -10,6 +10,7 @@ use wasm_bindgen::prelude::*;
 
 use crate::error::{into_err, Result};
 use crate::key::{JsPublicKey, JsSecretKey};
+use crate::types::time::JsTimestamp;
 
 /// NIP47 Response Error codes
 #[wasm_bindgen(js_name = Nip47ErrorCode)]
@@ -327,9 +328,9 @@ impl From<JsLookupInvoiceRequestParams> for LookupInvoiceRequestParams {
 #[wasm_bindgen(js_name = ListTransactionsRequestParams)]
 pub struct JsListTransactionsRequestParams {
     /// Starting timestamp in seconds since epoch
-    pub from: Option<u64>,
+    pub from: Option<JsTimestamp>,
     /// Ending timestamp in seconds since epoch
-    pub until: Option<u64>,
+    pub until: Option<JsTimestamp>,
     /// Number of invoices to return
     pub limit: Option<u64>,
     /// Offset of the first invoice to return
@@ -343,8 +344,8 @@ pub struct JsListTransactionsRequestParams {
 impl From<ListTransactionsRequestParams> for JsListTransactionsRequestParams {
     fn from(value: ListTransactionsRequestParams) -> Self {
         Self {
-            from: value.from,
-            until: value.until,
+            from: value.from.map(|t| t.into()),
+            until: value.until.map(|t| t.into()),
             limit: value.limit,
             offset: value.offset,
             unpaid: value.unpaid,
@@ -356,8 +357,8 @@ impl From<ListTransactionsRequestParams> for JsListTransactionsRequestParams {
 impl From<JsListTransactionsRequestParams> for ListTransactionsRequestParams {
     fn from(value: JsListTransactionsRequestParams) -> Self {
         Self {
-            from: value.from,
-            until: value.until,
+            from: value.from.map(|t| *t),
+            until: value.until.map(|t| *t),
             limit: value.limit,
             offset: value.offset,
             unpaid: value.unpaid,
@@ -464,14 +465,14 @@ pub struct JsLookupInvoiceResponseResult {
     /// Fees paid in millisatoshis
     pub fees_paid: u64,
     /// Creation timestamp in seconds since epoch
-    pub created_at: u64,
+    pub created_at: JsTimestamp,
     /// Expiration timestamp in seconds since epoch
-    pub expires_at: u64,
+    pub expires_at: JsTimestamp,
     /// Settled timestamp in seconds since epoch
-    pub settled_at: Option<u64>,
-    /// Optional metadata about the payment
-    #[wasm_bindgen(getter_with_clone)]
-    pub metadata: String,
+    pub settled_at: Option<JsTimestamp>,
+    // /// Optional metadata about the payment
+    // #[wasm_bindgen(getter_with_clone)]
+    // pub metadata: String, // TODO: this is not a string
 }
 
 impl From<LookupInvoiceResponseResult> for JsLookupInvoiceResponseResult {
@@ -485,10 +486,10 @@ impl From<LookupInvoiceResponseResult> for JsLookupInvoiceResponseResult {
             payment_hash: value.payment_hash,
             amount: value.amount,
             fees_paid: value.fees_paid,
-            created_at: value.created_at,
-            expires_at: value.expires_at,
-            settled_at: value.settled_at,
-            metadata: value.metadata.to_string(),
+            created_at: value.created_at.into(),
+            expires_at: value.expires_at.into(),
+            settled_at: value.settled_at.map(|t| t.into()),
+            // metadata: value.metadata.to_string(),
         }
     }
 }
@@ -504,10 +505,10 @@ impl From<JsLookupInvoiceResponseResult> for LookupInvoiceResponseResult {
             payment_hash: value.payment_hash,
             amount: value.amount,
             fees_paid: value.fees_paid,
-            created_at: value.created_at,
-            expires_at: value.expires_at,
-            settled_at: value.settled_at,
-            metadata: value.metadata.into(),
+            created_at: *value.created_at,
+            expires_at: *value.expires_at,
+            settled_at: value.settled_at.map(|t| *t),
+            metadata: None,
         }
     }
 }
diff --git a/bindings/nostr-js/src/types/time.rs b/bindings/nostr-js/src/types/time.rs
@@ -7,6 +7,7 @@ use std::ops::Deref;
 use nostr::prelude::*;
 use wasm_bindgen::prelude::*;
 
+#[derive(Clone, Copy)]
 #[wasm_bindgen(js_name = Timestamp)]
 pub struct JsTimestamp {
     inner: Timestamp,
diff --git a/crates/nostr/src/nips/nip47.rs b/crates/nostr/src/nips/nip47.rs
@@ -18,7 +18,7 @@ use serde_json::Value;
 use super::nip04;
 use crate::types::url::form_urlencoded::byte_serialize;
 use crate::types::url::{ParseError, Url};
-use crate::{key, Event, JsonUtil, PublicKey, SecretKey};
+use crate::{key, Event, JsonUtil, PublicKey, SecretKey, Timestamp};
 #[cfg(feature = "std")]
 use crate::{EventBuilder, Keys, Kind, Tag};
 
@@ -358,14 +358,14 @@ pub enum TransactionType {
 }
 
 /// List Transactions Request Params
-#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
+#[derive(Debug, Clone, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub struct ListTransactionsRequestParams {
     /// Starting timestamp in seconds since epoch
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub from: Option<u64>,
+    pub from: Option<Timestamp>,
     /// Ending timestamp in seconds since epoch
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub until: Option<u64>,
+    pub until: Option<Timestamp>,
     /// Number of invoices to return
     #[serde(skip_serializing_if = "Option::is_none")]
     pub limit: Option<u64>,
@@ -584,14 +584,15 @@ pub struct LookupInvoiceResponseResult {
     /// Fees paid in millisatoshis
     pub fees_paid: u64,
     /// Creation timestamp in seconds since epoch
-    pub created_at: u64,
+    pub created_at: Timestamp,
     /// Expiration timestamp in seconds since epoch
-    pub expires_at: u64,
+    pub expires_at: Timestamp,
     /// Settled timestamp in seconds since epoch
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub settled_at: Option<u64>,
+    pub settled_at: Option<Timestamp>,
     /// Optional metadata about the payment
-    pub metadata: Value,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub metadata: Option<Value>,
 }
 
 /// NIP47 `get_balance` Response Result
@@ -1070,4 +1071,47 @@ mod tests {
             panic!("Invalid request params");
         }
     }
+
+    #[test]
+    fn test_parse_list_transactions_result() {
+        let json = r#"{
+            "result_type": "list_transactions",
+            "result": {
+                "transactions": [
+                    {
+                       "type": "incoming",
+                       "invoice": "abcd",
+                       "description": "string",
+                       "payment_hash": "",
+                       "amount": 123,
+                       "fees_paid": 1,
+                       "created_at": 123456,
+                       "expires_at": 1234567
+                   }
+                ]
+            }
+        }"#;
+        let result = Response::from_json(json).unwrap();
+        assert_eq!(result.result_type, Method::ListTransactions);
+        assert!(result.error.is_none());
+        assert_eq!(
+            result.result,
+            Some(ResponseResult::ListTransactions(vec![
+                LookupInvoiceResponseResult {
+                    transaction_type: Some(TransactionType::Incoming),
+                    invoice: Some(String::from("abcd")),
+                    description: Some(String::from("string")),
+                    amount: 123,
+                    fees_paid: 1,
+                    created_at: Timestamp::from(123456),
+                    expires_at: Timestamp::from(1234567),
+                    description_hash: None,
+                    payment_hash: String::new(),
+                    metadata: None,
+                    settled_at: None,
+                    preimage: None
+                }
+            ]))
+        )
+    }
 }
