Allow setting index size (ordinals#120)

.github/workflows/ci.yaml

@@ -44,7 +44,7 @@ jobs:
  cargo update --locked --package ord
 
  - name: Test
- run: cargo test --all --release
+ run: cargo test --all
 
  - name: Clippy
  run: cargo clippy --all --all-targets

justfile

@@ -4,7 +4,6 @@ export RUST_LOG := log
 
 ci: clippy forbid
  cargo fmt -- --check
- cargo test --release
  cargo test
 
 forbid:
@@ -16,5 +15,5 @@ fmt:
 clippy:
  cargo clippy
 
-watch +args='ltest --release':
+watch +args='ltest':
  cargo watch --clear --exec '{{args}}'

src/arguments.rs

@@ -0,0 +1,15 @@
+use super::*;
+
+#[derive(StructOpt)]
+pub(crate) struct Arguments {
+ #[structopt(long)]
+ index_size: Option<usize>,
+ #[structopt(subcommand)]
+ subcommand: Subcommand,
+}
+
+impl Arguments {
+ pub(crate) fn run(self) -> Result<()> {
+ self.subcommand.run(self.index_size)
+ }
+}

src/index.rs

@@ -12,7 +12,7 @@ impl Index {
  const HEIGHT_TO_HASH: &'static str = "HEIGHT_TO_HASH";
  const OUTPOINT_TO_ORDINAL_RANGES: &'static str = "OUTPOINT_TO_ORDINAL_RANGES";
 
- pub(crate) fn new(blocksdir: Option<&Path>) -> Result<Self> {
+ pub(crate) fn new(blocksdir: Option<&Path>, index_size: Option<usize>) -> Result<Self> {
  let blocksdir = if let Some(blocksdir) = blocksdir {
  blocksdir.to_owned()
  } else if cfg!(target_os = "macos") {
@@ -30,7 +30,7 @@ impl Index {
  };
 
  let index = Self {
- database: unsafe { Database::open("index.redb", 50 << 30)? },
+ database: unsafe { Database::open("index.redb", index_size.unwrap_or(1 << 20))? },
  blocksdir,
  };
 

src/main.rs

@@ -1,5 +1,8 @@
 use {
- crate::{epoch::Epoch, height::Height, index::Index, ordinal::Ordinal, sat_point::SatPoint},
+ crate::{
+ arguments::Arguments, epoch::Epoch, height::Height, index::Index, ordinal::Ordinal,
+ sat_point::SatPoint, subcommand::Subcommand,
+ },
  bitcoin::{
  blockdata::constants::COIN_VALUE,
  consensus::{Decodable, Encodable},
@@ -26,19 +29,20 @@ use {
  structopt::StructOpt,
 };
 
-mod command;
+mod arguments;
 mod epoch;
 mod height;
 mod index;
 mod ordinal;
 mod sat_point;
+mod subcommand;
 
 type Result<T = (), E = Box<dyn std::error::Error>> = std::result::Result<T, E>;
 
 fn main() {
  env_logger::init();
 
- if let Err(error) = command::Command::from_args().run() {
+ if let Err(error) = Arguments::from_args().run() {
  eprintln!("error: {}", error);
  process::exit(1);
  }

src/command.rs → src/subcommand.rs

@@ -9,7 +9,7 @@ mod supply;
 mod traits;
 
 #[derive(StructOpt)]
-pub(crate) enum Command {
+pub(crate) enum Subcommand {
  Epochs,
  Find(find::Find),
  Name(name::Name),
@@ -19,13 +19,13 @@ pub(crate) enum Command {
  Traits(traits::Traits),
 }
 
-impl Command {
- pub(crate) fn run(self) -> Result<()> {
+impl Subcommand {
+ pub(crate) fn run(self, index_size: Option<usize>) -> Result<()> {
  match self {
  Self::Epochs => epochs::run(),
- Self::Find(find) => find.run(),
+ Self::Find(find) => find.run(index_size),
  Self::Name(name) => name.run(),
- Self::List(list) => list.run(),
+ Self::List(list) => list.run(index_size),
  Self::Range(range) => range.run(),
  Self::Supply => supply::run(),
  Self::Traits(traits) => traits.run(),

src/command/find.rs → src/subcommand/find.rs

@@ -12,8 +12,8 @@ pub(crate) struct Find {
 }
 
 impl Find {
- pub(crate) fn run(self) -> Result<()> {
- let index = Index::new(self.blocksdir.as_deref())?;
+ pub(crate) fn run(self, index_size: Option<usize>) -> Result<()> {
+ let index = Index::new(self.blocksdir.as_deref(), index_size)?;
 
  let creation_height = self.ordinal.height().n();
  let block = index.block(creation_height)?.unwrap();

src/command/list.rs → src/subcommand/list.rs

@@ -8,8 +8,8 @@ pub(crate) struct List {
 }
 
 impl List {
- pub(crate) fn run(self) -> Result<()> {
- let index = Index::new(self.blocksdir.as_deref())?;
+ pub(crate) fn run(self, index_size: Option<usize>) -> Result<()> {
+ let index = Index::new(self.blocksdir.as_deref(), index_size)?;
  let ranges = index.list(self.outpoint)?;
 
  for (start, end) in ranges {

tests/index.rs

@@ -0,0 +1,29 @@
+use super::*;
+
+#[test]
+fn default_index_size() -> Result {
+ let tempdir = Test::new()?
+ .command("find --blocksdir blocks 0 --as-of-height 0")
+ .expected_stdout("0396bc915f141f7de025f72ae9b6bb8dcdb5f444fc245d8fac486ba67a38eef9:0:0\n")
+ .block()
+ .output()?
+ .tempdir;
+
+ assert_eq!(tempdir.path().join("index.redb").metadata()?.len(), 1 << 20);
+
+ Ok(())
+}
+
+#[test]
+fn custom_index_size() -> Result {
+ let tempdir = Test::new()?
+ .command("--index-size 2097152 find --blocksdir blocks 0 --as-of-height 0")
+ .expected_stdout("0396bc915f141f7de025f72ae9b6bb8dcdb5f444fc245d8fac486ba67a38eef9:0:0\n")
+ .block()
+ .output()?
+ .tempdir;
+
+ assert_eq!(tempdir.path().join("index.redb").metadata()?.len(), 2 << 20);
+
+ Ok(())
+}

tests/integration.rs

@@ -21,6 +21,7 @@ use {
 
 mod epochs;
 mod find;
+mod index;
 mod list;
 mod name;
 mod range;
@@ -29,6 +30,11 @@ mod traits;
 
 type Result<T = ()> = std::result::Result<T, Box<dyn Error>>;
 
+struct Output {
+ stdout: String,
+ tempdir: TempDir,
+}
+
 struct Test {
  args: Vec<String>,
  blockfiles: Vec<usize>,
@@ -101,10 +107,10 @@ impl Test {
  }
 
  fn run(self) -> Result {
- self.run_with_stdout().map(|_| ())
+ self.output().map(|_| ())
  }
 
- fn run_with_stdout(self) -> Result<String> {
+ fn output(self) -> Result<Output> {
  self.populate_blocksdir()?;
 
  let output = Command::new(executable_path("ord"))
@@ -126,7 +132,10 @@ impl Test {
  assert_eq!(stdout, self.expected_stdout);
  }
 
- Ok(stdout.to_owned())
+ Ok(Output {
+ stdout: stdout.to_string(),
+ tempdir: self.tempdir,
+ })
  }
 
  fn block(self) -> Self {

tests/traits.rs

@@ -5,7 +5,8 @@ fn traits(ordinal: u64) -> Result<BTreeSet<String>> {
  Test::new()?
  .args(&["traits", &ordinal.to_string()])
  .ignore_stdout()
- .run_with_stdout()?
+ .output()?
+ .stdout
  .lines()
  .map(str::to_owned)
  .collect(),