Add /output/:outpoint endpoint (ordinals#293)

popcnt1 · Aug 5, 2022 · c456345 · c456345
1 parent 249beac
commit c456345
Show file tree

Hide file tree

Showing 2 changed files with 83 additions and 2 deletions.
diff --git a/src/subcommand/server.rs b/src/subcommand/server.rs
@@ -63,10 +63,11 @@ impl Server {
 
       let app = Router::new()
         .route("/", get(Self::root))
+        .route("/api/list/:outpoint", get(Self::api_list))
         .route("/block/:hash", get(Self::block))
-        .route("/range/:start/:end", get(Self::range))
         .route("/ordinal/:ordinal", get(Self::ordinal))
-        .route("/api/list/:outpoint", get(Self::api_list))
+        .route("/output/:output", get(Self::output))
+        .route("/range/:start/:end", get(Self::range))
         .route("/status", get(Self::status))
         .layer(extract::Extension(index))
         .layer(
@@ -136,6 +137,42 @@ impl Server {
     (StatusCode::OK, Html(format!("{ordinal}")))
   }
 
+  async fn output(
+    index: extract::Extension<Arc<Index>>,
+    extract::Path(outpoint): extract::Path<OutPoint>,
+  ) -> impl IntoResponse {
+    match index.list(outpoint) {
+      Ok(Some(ranges)) => (
+        StatusCode::OK,
+        Html(format!(
+          "<ul>{}</ul>",
+          ranges
+            .iter()
+            .map(|(start, end)| format!(
+              "<li><a href='/range/{start}/{end}'>[{start},{end})</a></li>"
+            ))
+            .collect::<String>()
+        )),
+      ),
+      Ok(None) => (
+        StatusCode::NOT_FOUND,
+        Html("Output unknown, invalid, or spent.".to_string()),
+      ),
+      Err(err) => {
+        eprintln!("Error serving request for output: {err}");
+        (
+          StatusCode::INTERNAL_SERVER_ERROR,
+          Html(
+            StatusCode::INTERNAL_SERVER_ERROR
+              .canonical_reason()
+              .unwrap_or_default()
+              .to_string(),
+          ),
+        )
+      }
+    }
+  }
+
   async fn range(
     extract::Path((DeserializeOrdinalFromStr(start), DeserializeOrdinalFromStr(end))): extract::Path<
       (DeserializeOrdinalFromStr, DeserializeOrdinalFromStr),

diff --git a/tests/server.rs b/tests/server.rs
@@ -151,6 +151,50 @@ fn ordinal_out_of_range() -> Result {
     .run_server(port)
 }
 
+#[test]
+fn invalid_outpoint_hash_returns_400() -> Result {
+  let port = free_port()?;
+
+  Test::new()?
+    .command(&format!("server --address 127.0.0.1 --http-port {port}"))
+    .request(
+      "output/foo:0",
+      400,
+      "Invalid URL: error parsing TXID: odd hex string length 3",
+    )
+    .run_server(port)
+}
+
+#[test]
+fn outpoint_returns_ordinal_ranges() -> Result {
+  let port = free_port()?;
+
+  Test::new()?
+    .command(&format!("server --address 127.0.0.1 --http-port {port}"))
+    .block()
+    .request(
+      "output/0396bc915f141f7de025f72ae9b6bb8dcdb5f444fc245d8fac486ba67a38eef9:0",
+      200,
+      "<ul><li><a href='/range/0/5000000000'>[0,5000000000)</a></li></ul>",
+    )
+    .run_server(port)
+}
+
+#[test]
+fn invalid_vout_returns_404() -> Result {
+  let port = free_port()?;
+
+  Test::new()?
+    .command(&format!("server --address 127.0.0.1 --http-port {port}"))
+    .block()
+    .request(
+      "output/0396bc915f141f7de025f72ae9b6bb8dcdb5f444fc245d8fac486ba67a38eef8:0",
+      404,
+      "Output unknown, invalid, or spent.",
+    )
+    .run_server(port)
+}
+
 #[test]
 fn root() -> Result {
   let port = free_port()?;