Show inscription on reveal transaction page (#954)

Cargo.toml

@@ -17,7 +17,7 @@ axum = "0.6.1"
 axum-server = "0.4.0"
 base64 = "0.13.1"
 bitcoin = { version = "0.29.1", features = ["rand"] }
-boilerplate = { version = "0.2.2", features = ["axum"] }
+boilerplate = { version = "0.2.3", features = ["axum"] }
 chrono = "0.4.19"
 clap = { version = "3.1.0", features = ["derive"] }
 ctrlc = "3.2.1"

src/inscription.rs

@@ -83,6 +83,10 @@ impl Inscription {
       _ => None,
     }
   }
+
+  pub(crate) fn content_html(&self) -> Trusted<ContentHtml> {
+    Trusted(ContentHtml(self.content()))
+  }
 }
 
 #[derive(Debug, PartialEq)]

src/main.rs

@@ -25,7 +25,7 @@ use {
     ordinal::Ordinal,
     rarity::Rarity,
     sat_point::SatPoint,
-    subcommand::Subcommand,
+    subcommand::{server::templates::ContentHtml, Subcommand},
     tally::Tally,
   },
   anyhow::{anyhow, bail, Context, Error},
@@ -41,6 +41,7 @@ use {
   chrono::{NaiveDateTime, TimeZone, Utc},
   clap::Parser,
   derive_more::{Display, FromStr},
+  html_escaper::{Escape, Trusted},
   regex::Regex,
   serde::{Deserialize, Serialize},
   std::{

src/subcommand.rs

@@ -6,7 +6,7 @@ mod index;
 mod info;
 mod list;
 mod parse;
-mod server;
+pub(crate) mod server;
 mod subsidy;
 mod supply;
 mod traits;

src/subcommand/server.rs

@@ -31,7 +31,7 @@ use {
 };
 
 mod deserialize_from_str;
-mod templates;
+pub(crate) mod templates;
 
 enum BlockQuery {
   Height(u64),
@@ -475,6 +475,15 @@ impl Server {
     Extension(chain): Extension<Chain>,
     Path(txid): Path<Txid>,
   ) -> ServerResult<PageHtml> {
+    let inscription = index
+      .get_inscription_by_inscription_id(txid)
+      .map_err(|err| {
+        ServerError::Internal(anyhow!(
+          "failed to retrieve inscription from txid {txid} from index: {err}"
+        ))
+      })?
+      .map(|(inscription, _satpoint)| inscription);
+
     Ok(
       TransactionHtml::new(
         index
@@ -485,6 +494,7 @@ impl Server {
             ))
           })?
           .ok_or_else(|| ServerError::NotFound(format!("transaction {txid} unknown")))?,
+        inscription,
         chain,
       )
       .page(

src/subcommand/server/templates.rs

@@ -1,17 +1,14 @@
-use {
-  super::*,
-  boilerplate::Boilerplate,
-  html_escaper::{Escape, Trusted},
-};
+use {super::*, boilerplate::Boilerplate};
 
 pub(crate) use {
-  block::BlockHtml, clock::ClockSvg, home::HomeHtml, input::InputHtml,
+  block::BlockHtml, clock::ClockSvg, content::ContentHtml, home::HomeHtml, input::InputHtml,
   inscription::InscriptionHtml, ordinal::OrdinalHtml, output::OutputHtml, range::RangeHtml,
   rare::RareTxt, transaction::TransactionHtml,
 };
 
 mod block;
 mod clock;
+mod content;
 mod home;
 mod input;
 mod inscription;

src/subcommand/server/templates/content.rs

@@ -0,0 +1,17 @@
+use super::*;
+
+pub(crate) struct ContentHtml<'a>(pub(crate) Option<Content<'a>>);
+
+impl<'a> Display for ContentHtml<'a> {
+  fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+    match self.0 {
+      Some(Content::Text(text)) => text.escape(f, false),
+      Some(Content::Png(png)) => write!(
+        f,
+        "<img src='data:image/png;base64,{}'>",
+        base64::encode(png)
+      ),
+      None => write!(f, "UNKNOWN"),
+    }
+  }
+}

src/subcommand/server/templates/inscription.rs

@@ -54,7 +54,7 @@ mod tests {
           <dt>satpoint</dt>
           <dd>1111111111111111111111111111111111111111111111111111111111111111:1:0</dd>
         </dl>
-        <img src=\"data:image/png;base64,AQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ==\">
+        <img src='data:image/png;base64,AQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ=='>
       "
       .unindent()
     );

src/subcommand/server/templates/transaction.rs

@@ -2,17 +2,23 @@ use super::*;
 
 #[derive(Boilerplate)]
 pub(crate) struct TransactionHtml {
-  txid: Txid,
-  transaction: Transaction,
   chain: Chain,
+  inscription: Option<Inscription>,
+  transaction: Transaction,
+  txid: Txid,
 }
 
 impl TransactionHtml {
-  pub(crate) fn new(transaction: Transaction, chain: Chain) -> Self {
+  pub(crate) fn new(
+    transaction: Transaction,
+    inscription: Option<Inscription>,
+    chain: Chain,
+  ) -> Self {
     Self {
       txid: transaction.txid(),
-      transaction,
       chain,
+      inscription,
+      transaction,
     }
   }
 }
@@ -49,7 +55,7 @@ mod tests {
     };
 
     pretty_assert_eq!(
-      TransactionHtml::new(transaction, Chain::Mainnet).to_string(),
+      TransactionHtml::new(transaction, None, Chain::Mainnet).to_string(),
       "
         <h1>Transaction <span class=monospace>9108ec7cbe9f1231dbf6374251b7267fb31cb23f36ed5a1d7344f5635b17dfe9</span></h1>
         <h2>2 Outputs</h2>

templates/inscription.html

@@ -3,14 +3,4 @@ <h1>Inscription</h1>
   <dt>satpoint</dt>
   <dd>{{ self.satpoint }}</dd>
 </dl>
-%% match self.inscription.content() {
-%% Some(Content::Text(text)) => {
-{{ text }}
-%% },
-%% Some(Content::Png(png)) => {
-<img src="data:image/png;base64,{{ base64::encode(png) }}">
-%% },
-%% None => {
-UNKNOWN
-%% },
-%% }
+{{ self.inscription.content_html() }}

templates/ordinal.html

@@ -13,17 +13,7 @@ <h1>Ordinal {{ self.ordinal.n() }}</h1>
   <dt>time</dt><dd>{{ self.blocktime }}</dd>
 %% if let Some(inscription) = &self.inscription {
   <dt>inscription</dt>
-%% match inscription.content() {
-%% Some(Content::Text(text)) => {
-  <dd>{{ text }}</dd>
-%% },
-%% Some(Content::Png(png)) => {
-  <dd><img src="data:image/png;base64,{{ base64::encode(png) }}"></dd>
-%% },
-%% None => {
-  <dd>UNKNOWN</d>
-%% }
-%% }
+  <dd>{{ inscription.content_html() }}</dd>
 %% }
 </dl>
 %% if self.ordinal.n() > 0 {

templates/transaction.html

@@ -1,4 +1,8 @@
 <h1>Transaction <span class=monospace>{{self.txid}}</span></h1>
+%% if let Some(inscription) = &self.inscription {
+<h2>Inscription</h2>
+{{ inscription.content_html() }}
+%% }
 <h2>{{"Output".tally(self.transaction.output.len())}}</h2>
 <ul class=monospace>
 %% for (vout, output) in self.transaction.output.iter().enumerate() {

tests/lib.rs

@@ -33,6 +33,18 @@ macro_rules! assert_regex_match {
   };
 }
 
+fn reveal_txid_from_inscribe_stdout(stdout: &str) -> Txid {
+  stdout
+    .lines()
+    .nth(1)
+    .unwrap()
+    .split('\t')
+    .nth(1)
+    .unwrap()
+    .parse()
+    .unwrap()
+}
+
 mod command_builder;
 mod epochs;
 mod expected;

tests/server.rs

@@ -47,12 +47,11 @@ fn inscription_page() {
   .stdout_regex("commit\t[[:xdigit:]]{64}\nreveal\t[[:xdigit:]]{64}\n")
   .run();
 
-  let reveal_tx = stdout.split("reveal\t").collect::<Vec<&str>>()[1].trim();
+  let reveal_tx = reveal_txid_from_inscribe_stdout(&stdout);
 
   rpc_server.mine_blocks(1);
 
-  let ord_server = TestServer::spawn_with_args(&rpc_server, &[]);
-  ord_server.assert_response_regex(
+  TestServer::spawn_with_args(&rpc_server, &[]).assert_response_regex(
     &format!("/inscription/{}", reveal_tx),
     &format!(
       ".*<h1>Inscription</h1>
@@ -63,19 +62,31 @@ fn inscription_page() {
 HELLOWORLD.*",
     ),
   );
+}
 
-  let ord_server = TestServer::spawn_with_args(&rpc_server, &[]);
-  ord_server.assert_response_regex(
-    &format!("/inscription/{}", reveal_tx),
-    &format!(
-      ".*<h1>Inscription</h1>
-<dl>
-  <dt>satpoint</dt>
-  <dd>{reveal_tx}:0:0</dd>
-</dl>
+#[test]
+fn inscription_appears_on_reveal_transaction_page() {
+  let rpc_server = test_bitcoincore_rpc::spawn_with(Network::Regtest, "ord");
+  let txid = rpc_server.mine_blocks(1)[0].txdata[0].txid();
+
+  let stdout = CommandBuilder::new(format!(
+    "--chain regtest wallet inscribe --satpoint {txid}:0:0 --file hello.txt"
+  ))
+  .write("hello.txt", "HELLOWORLD")
+  .rpc_server(&rpc_server)
+  .stdout_regex("commit\t[[:xdigit:]]{64}\nreveal\t[[:xdigit:]]{64}\n")
+  .run();
+
+  let reveal_tx = reveal_txid_from_inscribe_stdout(&stdout);
+
+  rpc_server.mine_blocks(1);
+
+  TestServer::spawn_with_args(&rpc_server, &[]).assert_response_regex(
+    &format!("/tx/{}", reveal_tx),
+    ".*<h1>Transaction .*</h1>.*
+<h2>Inscription</h2>
 HELLOWORLD.*",
-    ),
-  )
+  );
 }
 
 #[test]
@@ -91,7 +102,7 @@ fn inscription_page_after_send() {
   .stdout_regex("commit\t[[:xdigit:]]{64}\nreveal\t[[:xdigit:]]{64}\n")
   .run();
 
-  let reveal_txid = stdout.split("reveal\t").collect::<Vec<&str>>()[1].trim();
+  let reveal_txid = reveal_txid_from_inscribe_stdout(&stdout);
 
   rpc_server.mine_blocks(1);
 

tests/wallet.rs

@@ -1,17 +1,5 @@
 use {super::*, std::str::FromStr};
 
-fn reveal_txid_from_inscribe_stdout(stdout: &str) -> Txid {
-  stdout
-    .lines()
-    .nth(1)
-    .unwrap()
-    .split('\t')
-    .nth(1)
-    .unwrap()
-    .parse()
-    .unwrap()
-}
-
 #[test]
 fn satoshis() {
   let rpc_server = test_bitcoincore_rpc::spawn();
@@ -509,7 +497,7 @@ fn inscriptions_cannot_be_sent_by_satpoint() {
   .stdout_regex("commit\t[[:xdigit:]]{64}\nreveal\t[[:xdigit:]]{64}\n")
   .run();
 
-  let reveal_txid = stdout.split("reveal\t").collect::<Vec<&str>>()[1].trim();
+  let reveal_txid = reveal_txid_from_inscribe_stdout(&stdout);
 
   rpc_server.mine_blocks(1);