Show decimal rune balances (ordinals#3505)

src/decimal.rs

@@ -2,8 +2,8 @@ use super::*;
 
 #[derive(Debug, PartialEq, Copy, Clone, Default, DeserializeFromStr, SerializeDisplay)]
 pub struct Decimal {
- value: u128,
- scale: u8,
+ pub value: u128,
+ pub scale: u8,
 }
 
 impl Decimal {

src/lib.rs

@@ -102,7 +102,7 @@ pub mod api;
 pub mod arguments;
 mod blocktime;
 pub mod chain;
-mod decimal;
+pub mod decimal;
 mod deserialize_from_str;
 mod fee_rate;
 pub mod index;

src/subcommand/wallet/balance.rs

@@ -5,7 +5,7 @@ pub struct Output {
  pub cardinal: u64,
  pub ordinal: u64,
  #[serde(default, skip_serializing_if = "Option::is_none")]
- pub runes: Option<BTreeMap<SpacedRune, u128>>,
+ pub runes: Option<BTreeMap<SpacedRune, Decimal>>,
  #[serde(default, skip_serializing_if = "Option::is_none")]
  pub runic: Option<u64>,
  pub total: u64,
@@ -37,7 +37,16 @@ pub(crate) fn run(wallet: Wallet) -> SubcommandResult {
 
  if is_runic {
  for (spaced_rune, pile) in rune_balances {
- *runes.entry(spaced_rune).or_default() += pile.amount;
+ runes
+ .entry(spaced_rune)
+ .and_modify(|decimal: &mut Decimal| {
+ assert_eq!(decimal.scale, pile.divisibility);
+ decimal.value += pile.amount;
+ })
+ .or_insert(Decimal {
+ value: pile.amount,
+ scale: pile.divisibility,
+ });
  }
  runic += txout.value;
  }

src/subcommand/wallet/batch_command.rs

@@ -101,7 +101,7 @@ impl Batch {
  terms
  .cap
  .checked_mul(terms.amount.to_integer(etching.divisibility)?)
- .ok_or_else(|| anyhow!("`terms.count` * `terms.amount` over maximum"))
+ .ok_or_else(|| anyhow!("`terms.cap` * `terms.amount` over maximum"))
  })
  .transpose()?
  .unwrap_or_default();
@@ -110,8 +110,8 @@ impl Batch {
  supply
  == premine
  .checked_add(mintable)
- .ok_or_else(|| anyhow!("`premine` + `terms.count` * `terms.amount` over maximum"))?,
- "`supply` not equal to `premine` + `terms.count` * `terms.amount`"
+ .ok_or_else(|| anyhow!("`premine` + `terms.cap` * `terms.amount` over maximum"))?,
+ "`supply` not equal to `premine` + `terms.cap` * `terms.amount`"
  );
 
  ensure!(supply > 0, "`supply` must be greater than zero");

tests/wallet/balance.rs

@@ -1,4 +1,4 @@
-use super::*;
+use {super::*, ord::decimal::Decimal};
 
 #[test]
 fn wallet_balance() {
@@ -127,14 +127,21 @@ fn runic_utxos_are_deducted_from_cardinal() {
  ordinal: 10000,
  runic: Some(10_000),
  runes: Some(
- vec![(SpacedRune { rune, spacers: 1 }, 1000)]
- .into_iter()
- .collect()
+ vec![(
+ SpacedRune { rune, spacers: 1 },
+ Decimal {
+ value: 1000,
+ scale: 0,
+ }
+ )]
+ .into_iter()
+ .collect()
  ),
  total: 50 * COIN_VALUE * 8,
  }
  );
 }
+
 #[test]
 fn unsynced_wallet_fails_with_unindexed_output() {
  let core = mockcore::spawn();
@@ -176,3 +183,76 @@ fn unsynced_wallet_fails_with_unindexed_output() {
  .stderr_regex(r"error: output in wallet but not in ord server: [[:xdigit:]]{64}:\d+.*")
  .run_and_extract_stdout();
 }
+
+#[test]
+fn runic_utxos_are_displayed_with_decimal_amount() {
+ let core = mockcore::builder().network(Network::Regtest).build();
+
+ let ord = TestServer::spawn_with_server_args(&core, &["--regtest", "--index-runes"], &[]);
+
+ create_wallet(&core, &ord);
+
+ pretty_assert_eq!(
+ CommandBuilder::new("--regtest --index-runes wallet balance")
+ .core(&core)
+ .ord(&ord)
+ .run_and_deserialize_output::<Balance>(),
+ Balance {
+ cardinal: 0,
+ ordinal: 0,
+ runic: Some(0),
+ runes: Some(BTreeMap::new()),
+ total: 0,
+ }
+ );
+
+ let rune = Rune(RUNE);
+
+ batch(
+ &core,
+ &ord,
+ batch::File {
+ etching: Some(batch::Etching {
+ divisibility: 3,
+ premine: "1.111".parse().unwrap(),
+ rune: SpacedRune { rune, spacers: 1 },
+ supply: "2.222".parse().unwrap(),
+ symbol: '¢',
+ terms: Some(batch::Terms {
+ amount: "1.111".parse().unwrap(),
+ cap: 1,
+ ..default()
+ }),
+ }),
+ inscriptions: vec![batch::Entry {
+ file: "inscription.jpeg".into(),
+ ..default()
+ }],
+ ..default()
+ },
+ );
+
+ pretty_assert_eq!(
+ CommandBuilder::new("--regtest --index-runes wallet balance")
+ .core(&core)
+ .ord(&ord)
+ .run_and_deserialize_output::<Balance>(),
+ Balance {
+ cardinal: 50 * COIN_VALUE * 8 - 20_000,
+ ordinal: 10000,
+ runic: Some(10_000),
+ runes: Some(
+ vec![(
+ SpacedRune { rune, spacers: 1 },
+ Decimal {
+ value: 1111,
+ scale: 3,
+ }
+ )]
+ .into_iter()
+ .collect()
+ ),
+ total: 50 * COIN_VALUE * 8,
+ }
+ );
+}

tests/wallet/batch_command.rs

@@ -1,4 +1,6 @@
-use {super::*, ord::subcommand::wallet::send, pretty_assertions::assert_eq};
+use {
+ super::*, ord::decimal::Decimal, ord::subcommand::wallet::send, pretty_assertions::assert_eq,
+};
 
 fn receive(core: &mockcore::Handle, ord: &TestServer) -> Address {
  let address = CommandBuilder::new("wallet receive")
@@ -1505,7 +1507,17 @@ fn batch_can_etch_rune() {
  cardinal: 44999980000,
  ordinal: 10000,
  runic: Some(10000),
- runes: Some(vec![(rune, 1000)].into_iter().collect()),
+ runes: Some(
+ vec![(
+ rune,
+ Decimal {
+ value: 1000,
+ scale: 0,
+ }
+ )]
+ .into_iter()
+ .collect()
+ ),
  total: 450 * COIN_VALUE,
  }
  );
@@ -1990,7 +2002,7 @@ fn etch_mintable_overflow_error() {
  )
  .core(&core)
  .ord(&ord)
- .expected_stderr("error: `terms.count` * `terms.amount` over maximum\n")
+ .expected_stderr("error: `terms.cap` * `terms.amount` over maximum\n")
  .expected_exit_code(1)
  .run_and_extract_stdout();
 }
@@ -2039,7 +2051,7 @@ fn etch_mintable_plus_premine_overflow_error() {
  )
  .core(&core)
  .ord(&ord)
- .expected_stderr("error: `premine` + `terms.count` * `terms.amount` over maximum\n")
+ .expected_stderr("error: `premine` + `terms.cap` * `terms.amount` over maximum\n")
  .expected_exit_code(1)
  .run_and_extract_stdout();
 }
@@ -2088,7 +2100,7 @@ fn incorrect_supply_error() {
  )
  .core(&core)
  .ord(&ord)
- .expected_stderr("error: `supply` not equal to `premine` + `terms.count` * `terms.amount`\n")
+ .expected_stderr("error: `supply` not equal to `premine` + `terms.cap` * `terms.amount`\n")
  .expected_exit_code(1)
  .run_and_extract_stdout();
 }

tests/wallet/mint.rs

@@ -1,4 +1,4 @@
-use {super::*, ord::subcommand::wallet::mint};
+use {super::*, ord::decimal::Decimal, ord::subcommand::wallet::mint};
 
 #[test]
 fn minting_rune_and_fails_if_after_end() {
@@ -209,7 +209,10 @@ fn minting_rune_and_then_sending_works() {
 
  assert_eq!(
  *balance.runes.unwrap().first_key_value().unwrap().1,
- 111_u128
+ Decimal {
+ value: 111,
+ scale: 0,
+ }
  );
 
  let output = CommandBuilder::new(format!(
@@ -229,7 +232,10 @@ fn minting_rune_and_then_sending_works() {
 
  assert_eq!(
  *balance.runes.unwrap().first_key_value().unwrap().1,
- 132_u128
+ Decimal {
+ value: 132,
+ scale: 0,
+ }
  );
 
  pretty_assert_eq!(