Return properties from inscription JSON API (#4425)

Author: casey

src/api.rs

@@ -108,16 +108,17 @@ pub struct Inscription {
   pub fee: u64,
   pub height: u32,
   pub id: InscriptionId,
+  pub metaprotocol: Option<String>,
   pub next: Option<InscriptionId>,
   pub number: i32,
   pub parents: Vec<InscriptionId>,
   pub previous: Option<InscriptionId>,
+  pub properties: Properties,
   pub rune: Option<SpacedRune>,
   pub sat: Option<ordinals::Sat>,
   pub satpoint: SatPoint,
   pub timestamp: i64,
   pub value: Option<u64>,
-  pub metaprotocol: Option<String>,
 }
 
 #[derive(Debug, PartialEq, Serialize, Deserialize)]

src/index.rs

@@ -2287,6 +2287,7 @@ impl Index {
         number: entry.inscription_number,
         parents,
         previous,
+        properties: inscription.properties(),
         rune,
         sat: entry.sat,
         satpoint,

src/properties.rs

@@ -3,6 +3,7 @@ use super::*;
 mod raw;
 
 #[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
+#[serde(deny_unknown_fields)]
 pub struct Attributes {
   pub title: Option<String>,
 }
@@ -25,19 +26,18 @@ impl From<raw::Attributes> for Attributes {
   }
 }
 
-#[serde_with::skip_serializing_none]
 #[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct Item {
   pub id: InscriptionId,
-  #[serde(flatten)]
   pub attributes: Attributes,
 }
 
-#[derive(Debug, Default, PartialEq)]
+#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
+#[serde(deny_unknown_fields)]
 pub struct Properties {
-  pub(crate) gallery: Vec<Item>,
-  pub(crate) attributes: Attributes,
+  pub gallery: Vec<Item>,
+  pub attributes: Attributes,
 }
 
 impl Properties {

src/wallet/batch/entry.rs

@@ -16,6 +16,14 @@ pub struct Entry {
   pub satpoint: Option<SatPoint>,
 }
 
+#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct Item {
+  pub id: InscriptionId,
+  #[serde(flatten)]
+  pub attributes: Attributes,
+}
+
 impl Entry {
   pub(crate) fn metadata(&self) -> Result<Option<Vec<u8>>> {
     match &self.metadata {

src/wallet/batch/file.rs

@@ -156,7 +156,15 @@ impl File {
         entry.file.clone(),
         Some(pointer),
         Properties {
-          gallery: entry.gallery.clone(),
+          gallery: entry
+            .gallery
+            .clone()
+            .into_iter()
+            .map(|item| Item {
+              id: item.id,
+              attributes: item.attributes,
+            })
+            .collect(),
           attributes: entry.attributes.clone(),
         },
         self
@@ -468,15 +476,15 @@ inscriptions:
           batch::Entry {
             file: Some("gallery.png".into()),
             gallery: vec![
-              Item {
+              batch::entry::Item {
                 id: "a4676e57277b70171d69dc6ad2781485b491fe0ff5870f6f6b01999e7180b29ei0"
                   .parse()
                   .unwrap(),
                 attributes: Attributes {
                   title: Some("Incredible".into()),
                 },
               },
-              Item {
+              batch::entry::Item {
                 id: "a4676e57277b70171d69dc6ad2781485b491fe0ff5870f6f6b01999e7180b29ei3"
                   .parse()
                   .unwrap(),

tests/json_api.rs

@@ -1,8 +1,7 @@
 use {
   super::*,
   bitcoin::{BlockHash, ScriptBuf},
-  ord::subcommand::wallet::send::Output,
-  ord::{Envelope, Inscription},
+  ord::{Attributes, Envelope, Inscription, Properties, subcommand::wallet::send::Output},
 };
 
 #[test]
@@ -180,6 +179,7 @@ fn get_inscription() {
       value: Some(10000),
       parents: Vec::new(),
       previous: None,
+      properties: default(),
       rune: None,
       sat: Some(Sat(50 * COIN_VALUE)),
       satpoint: SatPoint::from_str(&format!("{}:{}:{}", reveal, 0, 0)).unwrap(),
@@ -190,7 +190,7 @@ fn get_inscription() {
 }
 
 #[test]
-fn get_inscription_with_metaprotocol() {
+fn get_inscription_with_metaprotocol_and_properties() {
   let core = mockcore::spawn();
   let ord = TestServer::spawn_with_server_args(&core, &["--index-sats"], &[]);
 
@@ -199,7 +199,7 @@ fn get_inscription_with_metaprotocol() {
   core.mine_blocks(1);
 
   let output = CommandBuilder::new(format!(
-    "--chain {} wallet inscribe --fee-rate 1 --file foo.txt --metaprotocol foo",
+    "--chain {} wallet inscribe --fee-rate 1 --file foo.txt --metaprotocol foo --title bar",
     core.network()
   ))
   .write("foo.txt", "FOO")
@@ -228,14 +228,20 @@ fn get_inscription_with_metaprotocol() {
       content_length: Some(3),
       content_type: Some("text/plain;charset=utf-8".to_string()),
       effective_content_type: Some("text/plain;charset=utf-8".to_string()),
-      fee: 140,
+      fee: 143,
       height: 2,
       id: output.inscriptions[0].id,
       number: 0,
       next: None,
       value: Some(10000),
       parents: Vec::new(),
       previous: None,
+      properties: Properties {
+        gallery: Vec::new(),
+        attributes: Attributes {
+          title: Some("bar".into()),
+        },
+      },
       rune: None,
       sat: Some(Sat(50 * COIN_VALUE)),
       satpoint: SatPoint::from_str(&format!("{}:{}:{}", output.reveal, 0, 0)).unwrap(),