Improve docs on Denomination

Document what each denomination means.
This commit is contained in:
Tobin C. Harding 2025-01-20 16:06:48 +11:00
parent 05c28cf31d
commit 7c7fc36784
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
1 changed files with 6 additions and 6 deletions

View File

@ -68,17 +68,17 @@ pub use self::{
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)] #[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
#[non_exhaustive] #[non_exhaustive]
pub enum Denomination { pub enum Denomination {
/// BTC /// BTC (1 BTC = 100,000,000 satoshi).
Bitcoin, Bitcoin,
/// cBTC /// cBTC (1 cBTC = 1,000,000 satoshi).
CentiBitcoin, CentiBitcoin,
/// mBTC /// mBTC (1 mBTC = 100,000 satoshi).
MilliBitcoin, MilliBitcoin,
/// uBTC /// uBTC (1 uBTC = 100 satoshi).
MicroBitcoin, MicroBitcoin,
/// bits /// bits (bits = uBTC).
Bit, Bit,
/// satoshi /// satoshi (1 BTC = 100,000,000 satoshi).
Satoshi, Satoshi,
} }