Move sat and friends into ordinals crate (#3079)

Cargo.toml

@@ -32,7 +32,6 @@ chrono = { version = "0.4.19", features = ["serde"] }
 ciborium = "0.2.1"
 clap = { version = "4.4.2", features = ["derive"] }
 ctrlc = { version = "3.2.1", features = ["termination"] }
-derive_more = "0.99.17"
 dirs = "5.0.0"
 env_logger = "0.10.0"
 futures = "0.3.21"

crates/ordinals/Cargo.toml

@@ -9,8 +9,9 @@ license = "CC0-1.0"
 rust-version = "1.67"
 
 [dependencies]
-serde = { version = "1.0.137", features = ["derive"] }
 bitcoin = { version = "0.30.1", features = ["rand"] }
+derive_more = "0.99.17"
+serde = { version = "1.0.137", features = ["derive"] }
 thiserror = "1.0.56"
 
 [dev-dependencies]

src/decimal_sat.rs → crates/ordinals/src/decimal_sat.rs

@@ -1,9 +1,9 @@
 use super::*;
 
 #[derive(PartialEq, Debug)]
-pub(crate) struct DecimalSat {
-  height: Height,
-  offset: u64,
+pub struct DecimalSat {
+  pub height: Height,
+  pub offset: u64,
 }
 
 impl From<Sat> for DecimalSat {

src/degree.rs → crates/ordinals/src/degree.rs

@@ -1,11 +1,11 @@
 use super::*;
 
 #[derive(PartialEq, Debug)]
-pub(crate) struct Degree {
-  pub(crate) hour: u32,
-  pub(crate) minute: u32,
-  pub(crate) second: u32,
-  pub(crate) third: u64,
+pub struct Degree {
+  pub hour: u32,
+  pub minute: u32,
+  pub second: u32,
+  pub third: u64,
 }
 
 impl Display for Degree {

src/epoch.rs → crates/ordinals/src/epoch.rs

@@ -1,10 +1,10 @@
 use super::*;
 
 #[derive(Copy, Clone, Eq, PartialEq, Debug, Display, Serialize, PartialOrd)]
-pub(crate) struct Epoch(pub(crate) u32);
+pub struct Epoch(pub u32);
 
 impl Epoch {
-  pub(crate) const STARTING_SATS: [Sat; 34] = [
+  pub const STARTING_SATS: [Sat; 34] = [
     Sat(0),
     Sat(1050000000000000),
     Sat(1575000000000000),
@@ -40,23 +40,23 @@ impl Epoch {
     Sat(2099999997480000),
     Sat(Sat::SUPPLY),
   ];
-  pub(crate) const FIRST_POST_SUBSIDY: Epoch = Self(33);
+  pub const FIRST_POST_SUBSIDY: Epoch = Self(33);
 
-  pub(crate) fn subsidy(self) -> u64 {
+  pub fn subsidy(self) -> u64 {
     if self < Self::FIRST_POST_SUBSIDY {
       (50 * COIN_VALUE) >> self.0
     } else {
       0
     }
   }
 
-  pub(crate) fn starting_sat(self) -> Sat {
+  pub fn starting_sat(self) -> Sat {
     *Self::STARTING_SATS
       .get(usize::try_from(self.0).unwrap())
       .unwrap_or_else(|| Self::STARTING_SATS.last().unwrap())
   }
 
-  pub(crate) fn starting_height(self) -> Height {
+  pub fn starting_height(self) -> Height {
     Height(self.0 * SUBSIDY_HALVING_INTERVAL)
   }
 }

src/height.rs → crates/ordinals/src/height.rs

@@ -1,25 +1,25 @@
 use super::*;
 
 #[derive(Copy, Clone, Debug, Display, FromStr, Ord, Eq, Serialize, PartialEq, PartialOrd)]
-pub(crate) struct Height(pub(crate) u32);
+pub struct Height(pub u32);
 
 impl Height {
-  pub(crate) fn n(self) -> u32 {
+  pub fn n(self) -> u32 {
     self.0
   }
 
-  pub(crate) fn subsidy(self) -> u64 {
+  pub fn subsidy(self) -> u64 {
     Epoch::from(self).subsidy()
   }
 
-  pub(crate) fn starting_sat(self) -> Sat {
+  pub fn starting_sat(self) -> Sat {
     let epoch = Epoch::from(self);
     let epoch_starting_sat = epoch.starting_sat();
     let epoch_starting_height = epoch.starting_height();
     epoch_starting_sat + u64::from(self.n() - epoch_starting_height.n()) * epoch.subsidy()
   }
 
-  pub(crate) fn period_offset(self) -> u32 {
+  pub fn period_offset(self) -> u32 {
     self.0 % DIFFCHANGE_INTERVAL
   }
 }

crates/ordinals/src/lib.rs

@@ -1,23 +1,39 @@
 //! Types for interoperating with ordinals and inscriptions.
 
 use {
+  bitcoin::constants::{COIN_VALUE, DIFFCHANGE_INTERVAL, SUBSIDY_HALVING_INTERVAL},
   bitcoin::{
     consensus::{Decodable, Encodable},
     OutPoint,
   },
+  derive_more::{Display, FromStr},
   serde::{Deserialize, Deserializer, Serialize, Serializer},
   std::{
+    cmp,
     fmt::{self, Display, Formatter},
     io,
+    num::ParseIntError,
+    ops::{Add, AddAssign, Sub},
     str::FromStr,
   },
   thiserror::Error,
 };
 
-pub use sat_point::SatPoint;
+pub const CYCLE_EPOCHS: u32 = 6;
+
+pub use {
+  decimal_sat::DecimalSat, degree::Degree, epoch::Epoch, height::Height, rarity::Rarity, sat::Sat,
+  sat_point::SatPoint,
+};
 
 #[doc(hidden)]
 pub use self::deserialize_from_str::DeserializeFromStr;
 
+mod decimal_sat;
+mod degree;
 mod deserialize_from_str;
+mod epoch;
+mod height;
+mod rarity;
+mod sat;
 mod sat_point;

src/rarity.rs → crates/ordinals/src/rarity.rs

@@ -75,7 +75,7 @@ impl From<Sat> for Rarity {
 }
 
 impl FromStr for Rarity {
-  type Err = Error;
+  type Err = String;
 
   fn from_str(s: &str) -> Result<Self, Self::Err> {
     match s {
@@ -85,7 +85,7 @@ impl FromStr for Rarity {
       "epic" => Ok(Self::Epic),
       "legendary" => Ok(Self::Legendary),
       "mythic" => Ok(Self::Mythic),
-      _ => Err(anyhow!("invalid rarity: {s}")),
+      _ => Err(format!("invalid rarity `{s}`")),
     }
   }
 }
@@ -172,13 +172,6 @@ mod tests {
     case("mythic", Rarity::Mythic);
   }
 
-  #[test]
-  fn from_str_err() {
-    "abc".parse::<Rarity>().unwrap_err();
-
-    "".parse::<Rarity>().unwrap_err();
-  }
-
   #[test]
   fn conversions_with_u8() {
     for &expected in &[
@@ -196,4 +189,9 @@ mod tests {
 
     assert_eq!(Rarity::try_from(6), Err(6));
   }
+
+  #[test]
+  fn error() {
+    assert_eq!("foo".parse::<Rarity>().unwrap_err(), "invalid rarity `foo`");
+  }
 }