Merge remote-tracking branch 'origin/master' into embellish-block-page

.gitignore

@@ -6,4 +6,5 @@
 /index.redb
 /ord.log
 /target
+/test-times.txt
 /tmp

Cargo.toml

@@ -30,7 +30,6 @@ http = "0.2.6"
 lazy_static = "1.4.0"
 log = "0.4.14"
 mime_guess = "2.0.4"
-primes = "0.3.0"
 rayon = "1.5.1"
 redb = "0.7.0"
 regex = "1.6.0"

docs/config.toml

@@ -4,6 +4,5 @@ build_search_index = false
 
 [markdown]
 highlight_code = true
-highlight_theme = "base16-atelierdune-light"
 
 [extra]

justfile

@@ -48,9 +48,14 @@ test-deploy:
     . root@192.168.56.4:ord
   ssh root@192.168.56.4 'cd ord && ./deploy/setup'
 
-report-test-time:
+time-tests:
   cargo +nightly test -- -Z unstable-options --report-time
 
+profile-tests:
+  cargo +nightly test -- -Z unstable-options --report-time \
+    | sed -n 's/^test \(.*\) ... ok <\(.*\)s>/\2 \1/p' | sort -n \
+    | tee test-times.txt
+
 status:
   ssh root@65.108.68.37 systemctl status bitcoind
   ssh root@65.108.68.37 systemctl status ord

src/options.rs

@@ -8,20 +8,20 @@ use {
 pub(crate) struct Options {
   #[clap(
     long,
-    help = "Limit the ordinal index to <MAX_INDEX_SIZE> bytes. [mainnet, testnet, and signet default: 1 TiB, regtest default: 10 MiB]"
+    help = "Limit the ordinal index to <MAX_INDEX_SIZE> bytes. This cannot be changed later. [mainnet, testnet, and signet default: 1 TiB, regtest default: 10 MiB]"
   )]
   max_index_size: Option<Bytes>,
-  #[clap(long)]
+  #[clap(long, help = "Load Bitcoin Core RPC cookie file from <COOKIE_FILE>.")]
   cookie_file: Option<PathBuf>,
-  #[clap(long)]
+  #[clap(long, help = "Connect to Bitcoin Core RPC at <RPC_URL>.")]
   rpc_url: Option<String>,
-  #[clap(long, arg_enum, default_value = "mainnet")]
+  #[clap(long, arg_enum, default_value = "mainnet", help = "Index <CHAIN>.")]
   pub(crate) chain: Chain,
-  #[clap(long)]
+  #[clap(long, help = "Store index in <DATA_DIR>.")]
   data_dir: Option<PathBuf>,
-  #[clap(long)]
+  #[clap(long, help = "Load Bitcoin Core data dir from <BITCOIN_DATA_DIR>.")]
   bitcoin_data_dir: Option<PathBuf>,
-  #[clap(long)]
+  #[clap(long, help = "Limit index to <HEIGHT_LIMIT> blocks.")]
   pub(crate) height_limit: Option<u64>,
 }
 

src/ordinal.rs

@@ -52,10 +52,6 @@ impl Ordinal {
     self.into()
   }
 
-  pub(crate) fn prime(self) -> bool {
-    primes::is_prime(self.0)
-  }
-
   pub(crate) fn name(self) -> String {
     let mut x = Self::SUPPLY - self.0;
     let mut name = String::new();

src/subcommand/find.rs

@@ -2,6 +2,7 @@ use super::*;
 
 #[derive(Debug, Parser)]
 pub(crate) struct Find {
+  #[clap(help = "Find output and offset of <ORDINAL>.")]
   ordinal: Ordinal,
 }
 

src/subcommand/list.rs

@@ -2,6 +2,7 @@ use super::*;
 
 #[derive(Debug, Parser)]
 pub(crate) struct List {
+  #[clap(help = "List ordinal ranges in <OUTPOINT>.")]
   outpoint: OutPoint,
 }
 

src/subcommand/parse.rs

@@ -2,6 +2,7 @@ use super::*;
 
 #[derive(Debug, Parser)]
 pub(crate) struct Parse {
+  #[clap(help = "Parse <ORDINAL>.")]
   ordinal: Ordinal,
 }
 

src/subcommand/range.rs

@@ -2,8 +2,9 @@ use super::*;
 
 #[derive(Debug, Parser)]
 pub(crate) struct Range {
-  #[clap(long)]
+  #[clap(long, help = "Display range as names.")]
   name: bool,
+  #[clap(help = "List ordinal range in subsidy at <HEIGHT>.")]
   height: Height,
 }
 

src/subcommand/server.rs

@@ -55,6 +55,13 @@ impl IntoResponse for ServerError {
   }
 }
 
+fn html_status(status_code: StatusCode) -> (StatusCode, Html<&'static str>) {
+  (
+    status_code,
+    Html(status_code.canonical_reason().unwrap_or_default()),
+  )
+}
+
 #[derive(Deserialize)]
 struct Search {
   query: String,
@@ -270,16 +277,7 @@ impl Server {
       Ok(height) => ClockSvg::new(height).into_response(),
       Err(err) => {
         eprintln!("Failed to retrieve height from index: {err}");
-        (
-          StatusCode::INTERNAL_SERVER_ERROR,
-          Html(
-            StatusCode::INTERNAL_SERVER_ERROR
-              .canonical_reason()
-              .unwrap_or_default()
-              .to_string(),
-          ),
-        )
-          .into_response()
+        html_status(StatusCode::INTERNAL_SERVER_ERROR).into_response()
       }
     }
   }
@@ -292,16 +290,7 @@ impl Server {
       Ok(blocktime) => OrdinalHtml { ordinal, blocktime }.page().into_response(),
       Err(err) => {
         eprintln!("Failed to retrieve blocktime from index: {err}");
-        (
-          StatusCode::INTERNAL_SERVER_ERROR,
-          Html(
-            StatusCode::INTERNAL_SERVER_ERROR
-              .canonical_reason()
-              .unwrap_or_default()
-              .to_string(),
-          ),
-        )
-          .into_response()
+        html_status(StatusCode::INTERNAL_SERVER_ERROR).into_response()
       }
     }
   }
@@ -357,16 +346,7 @@ impl Server {
       Ok(blocks) => HomeHtml::new(blocks).page().into_response(),
       Err(err) => {
         eprintln!("Error getting blocks: {err}");
-        (
-          StatusCode::INTERNAL_SERVER_ERROR,
-          Html(
-            StatusCode::INTERNAL_SERVER_ERROR
-              .canonical_reason()
-              .unwrap_or_default()
-              .to_string(),
-          ),
-        )
-          .into_response()
+        html_status(StatusCode::INTERNAL_SERVER_ERROR).into_response()
       }
     }
   }
@@ -420,16 +400,7 @@ impl Server {
         .into_response(),
       Err(error) => {
         eprintln!("Error serving request for block with hash {hash}: {error}");
-        (
-          StatusCode::INTERNAL_SERVER_ERROR,
-          Html(
-            StatusCode::INTERNAL_SERVER_ERROR
-              .canonical_reason()
-              .unwrap_or_default()
-              .to_string(),
-          ),
-        )
-          .into_response()
+        html_status(StatusCode::INTERNAL_SERVER_ERROR).into_response()
       }
     }
   }
@@ -443,28 +414,10 @@ impl Server {
       Ok(Some(transaction)) => TransactionHtml::new(transaction, network.0)
         .page()
         .into_response(),
-      Ok(None) => (
-        StatusCode::NOT_FOUND,
-        Html(
-          StatusCode::NOT_FOUND
-            .canonical_reason()
-            .unwrap_or_default()
-            .to_string(),
-        ),
-      )
-        .into_response(),
+      Ok(None) => html_status(StatusCode::NOT_FOUND).into_response(),
       Err(error) => {
         eprintln!("Error serving request for transaction with txid {txid}: {error}");
-        (
-          StatusCode::INTERNAL_SERVER_ERROR,
-          Html(
-            StatusCode::INTERNAL_SERVER_ERROR
-              .canonical_reason()
-              .unwrap_or_default()
-              .to_string(),
-          ),
-        )
-          .into_response()
+        html_status(StatusCode::INTERNAL_SERVER_ERROR).into_response()
       }
     }
   }
@@ -976,7 +929,7 @@ mod tests {
     TestServer::new().assert_response_regex(
       "/range/0/1",
       StatusCode::OK,
-      r".*<title>Ordinal range \[0,1\)</title>.*<h1>Ordinal range \[0,1\)</h1>
+      r".*<title>Ordinal range 0–1</title>.*<h1>Ordinal range 0–1</h1>
 <dl>
   <dt>value</dt><dd>1</dd>
   <dt>first</dt><dd><a href=/ordinal/0 class=mythic>0</a></dd>
@@ -1055,7 +1008,7 @@ mod tests {
 </dl>
 <h2>1 Ordinal Range</h2>
 <ul class=monospace>
-  <li><a href=/range/0/5000000000 class=mythic>\\[0,5000000000\\)</a></li>
+  <li><a href=/range/0/5000000000 class=mythic>0–5000000000</a></li>
 </ul>.*",
   );
   }
@@ -1090,7 +1043,12 @@ mod tests {
     ".*<title>Ordinals</title>.*<h1>Ordinals</h1>
 <nav>.*</nav>
 .*
-<h2>Recent Blocks</h2>
+<h2>Latest Blocks</h2>
+<dl>
+  <dt>cycle</dt><dd>0</dd>
+  <dt>epoch</dt><dd>0</dd>
+  <dt>period</dt><dd>0</dd>
+</dl>
 <ol start=1 reversed class='blocks monospace'>
   <li><a href=/block/[[:xdigit:]]{64} class=uncommon>[[:xdigit:]]{64}</a></li>
   <li><a href=/block/000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f class=mythic>000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f</a></li>
@@ -1102,12 +1060,12 @@ mod tests {
   fn home_block_limit() {
     let test_server = TestServer::new();
 
-    test_server.bitcoin_rpc_server.mine_blocks(200);
+    test_server.bitcoin_rpc_server.mine_blocks(101);
 
     test_server.assert_response_regex(
     "/",
     StatusCode::OK,
-    ".*<ol start=200 reversed class='blocks monospace'>\n(  <li><a href=/block/[[:xdigit:]]{64} class=uncommon>[[:xdigit:]]{64}</a></li>\n){100}</ol>.*"
+    ".*<ol start=101 reversed class='blocks monospace'>\n(  <li><a href=/block/[[:xdigit:]]{64} class=uncommon>[[:xdigit:]]{64}</a></li>\n){100}</ol>.*"
   );
   }
 

src/subcommand/server/templates/home.rs

@@ -4,11 +4,15 @@ use super::*;
 pub(crate) struct HomeHtml {
   last: u64,
   blocks: Vec<(Rarity, BlockHash)>,
+  starting_ordinal: Option<Ordinal>,
 }
 
 impl HomeHtml {
   pub(crate) fn new(blocks: Vec<(u64, BlockHash)>) -> Self {
     Self {
+      starting_ordinal: blocks
+        .get(0)
+        .map(|(height, _)| Height(*height).starting_ordinal()),
       last: blocks
         .get(0)
         .map(|(height, _)| height)
@@ -37,13 +41,13 @@ mod tests {
     assert_regex_match!(
       &HomeHtml::new(vec![
         (
-          1,
+          1260001,
           "1111111111111111111111111111111111111111111111111111111111111111"
             .parse()
             .unwrap()
         ),
         (
-          0,
+          1260000,
           "0000000000000000000000000000000000000000000000000000000000000000"
             .parse()
             .unwrap()
@@ -54,10 +58,15 @@ mod tests {
 <nav>.*</nav>
 <h2>Search</h2>
 <form action=/search method=get>.*</form>
-<h2>Recent Blocks</h2>
-<ol start=1 reversed class='blocks monospace'>
+<h2>Latest Blocks</h2>
+<dl>
+  <dt>cycle</dt><dd>1</dd>
+  <dt>epoch</dt><dd>6</dd>
+  <dt>period</dt><dd>625</dd>
+</dl>
+<ol start=1260001 reversed class='blocks monospace'>
   <li><a href=/block/1{64} class=uncommon>1{64}</a></li>
-  <li><a href=/block/0{64} class=mythic>0{64}</a></li>
+  <li><a href=/block/0{64} class=legendary>0{64}</a></li>
 </ol>
 ",
     );