Implement /block/:query JSON endpoint

src/subcommand/server.rs

@@ -7,7 +7,7 @@ use {
   super::*,
   crate::page_config::PageConfig,
   crate::templates::{
-    BlockHtml, ClockSvg, HomeHtml, InputHtml, InscriptionHtml, InscriptionJson,
+    BlockHtml, BlockJson, ClockSvg, HomeHtml, InputHtml, InscriptionHtml, InscriptionJson,
     InscriptionsBlockHtml, InscriptionsHtml, InscriptionsJson, OutputHtml, OutputJson, PageContent,
     PageHtml, PreviewAudioHtml, PreviewCodeHtml, PreviewImageHtml, PreviewMarkdownHtml,
     PreviewModelHtml, PreviewPdfHtml, PreviewTextHtml, PreviewUnknownHtml, PreviewVideoHtml,
@@ -577,7 +577,8 @@ impl Server {
     Extension(page_config): Extension<Arc<PageConfig>>,
     Extension(index): Extension<Arc<Index>>,
     Path(DeserializeFromStr(query)): Path<DeserializeFromStr<BlockQuery>>,
-  ) -> ServerResult<PageHtml<BlockHtml>> {
+    accept_json: AcceptJson,
+  ) -> ServerResult<Response> {
     let (block, height) = match query {
       BlockQuery::Height(height) => {
         let block = index
@@ -602,16 +603,26 @@ impl Server {
     let (featured_inscriptions, total_num) =
       index.get_highest_paying_inscriptions_in_block(height, 8)?;
 
-    Ok(
+    Ok(if accept_json.0 {
+      Json(BlockJson::new(
+        block,
+        Height(height),
+        Self::index_height(&index)?,
+        total_num,
+        featured_inscriptions,
+      ))
+      .into_response()
+    } else {
       BlockHtml::new(
         block,
         Height(height),
         Self::index_height(&index)?,
         total_num,
         featured_inscriptions,
       )
-      .page(page_config, index.has_sat_index()?),
-    )
+      .page(page_config, index.has_sat_index()?)
+      .into_response()
+    })
   }
 
   async fn transaction(

src/templates.rs

@@ -1,7 +1,7 @@
 use {super::*, boilerplate::Boilerplate};
 
 pub(crate) use {
-  block::BlockHtml,
+  block::{BlockHtml, BlockJson},
   clock::ClockSvg,
   home::HomeHtml,
   iframe::Iframe,
@@ -22,7 +22,7 @@ pub(crate) use {
   transaction::TransactionHtml,
 };
 
-mod block;
+pub mod block;
 mod clock;
 mod home;
 mod iframe;

src/templates/block.rs

@@ -31,6 +31,36 @@ impl BlockHtml {
   }
 }
 
+#[derive(Debug, PartialEq, Serialize, Deserialize)]
+pub struct BlockJson {
+  pub hash: String,
+  pub target: String,
+  pub best_height: u64,
+  pub height: u64,
+  pub total_num_inscriptions: usize,
+  pub featured_inscriptions: Vec<InscriptionId>,
+}
+
+impl BlockJson {
+  pub(crate) fn new(
+    block: Block,
+    height: Height,
+    best_height: Height,
+    total_num_inscriptions: usize,
+    featured_inscriptions: Vec<InscriptionId>,
+  ) -> Self {
+    Self {
+      hash: block.header.block_hash().to_string(),
+      target: BlockHash::from_raw_hash(Hash::from_byte_array(block.header.target().to_be_bytes()))
+        .to_string(),
+      height: height.0,
+      best_height: best_height.0,
+      total_num_inscriptions,
+      featured_inscriptions,
+    }
+  }
+}
+
 impl PageContent for BlockHtml {
   fn title(&self) -> String {
     format!("Block {}", self.height)

tests/json_api.rs

@@ -397,3 +397,29 @@ fn json_request_fails_when_not_enabled() {
 
   assert_eq!(response.status(), StatusCode::NOT_ACCEPTABLE);
 }
+
+#[test]
+fn get_block() {
+  let rpc_server = test_bitcoincore_rpc::spawn();
+
+  rpc_server.mine_blocks(1);
+
+  let response =
+    TestServer::spawn_with_args(&rpc_server, &["--enable-json-api"]).json_request("/block/0");
+
+  assert_eq!(response.status(), StatusCode::OK);
+
+  let block_json: BlockJson = serde_json::from_str(&response.text().unwrap()).unwrap();
+
+  assert_eq!(
+    block_json,
+    BlockJson {
+      hash: String::from("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f"),
+      target: String::from("0000000000000000000000000000000000000000000000000000ffff00000000"),
+      best_height: 1,
+      height: 0,
+      total_num_inscriptions: 0,
+      featured_inscriptions: vec![],
+    }
+  );
+}

tests/lib.rs

@@ -12,8 +12,8 @@ use {
     inscription_id::InscriptionId,
     rarity::Rarity,
     templates::{
-      inscription::InscriptionJson, inscriptions::InscriptionsJson, output::OutputJson,
-      sat::SatJson,
+      block::BlockJson, inscription::InscriptionJson, inscriptions::InscriptionsJson,
+      output::OutputJson, sat::SatJson,
     },
     SatPoint,
   },