Struct Amount

pub struct Amount(/* private fields */);

A Bitcoin amount, internally represented as a satoshi [Decimal], which provides the following properties:

• The contained value is non-negative.
• The contained value is no greater than Amount::MAX.
• Converting to sats, bits, or BTC and back via divisions and multiplications by 1000 doesn’t lose any precision beyond msat.
• The contained value is always rounded to the nearest msat.

Implementations

impl Amount

pub const MAX: Amount

The maximum Amount that this type can represent. We set this exactly equal to u64::MAX millisatoshis because it makes conversions to and from u64 infallible and hence ergonomic, desirable because u64 is the most common representation for millisats in non-Lexe code.

pub const ZERO: Amount

An Amount of zero bitcoins.

pub const MAX_BITCOIN_SUPPLY: Amount

The maximum supply of Bitcoin that can ever exist. Analogous to [bitcoin::Amount::MAX_MONEY]; primarily useful as a sanity check.

pub const MAX_BITCOIN_SUPPLY_SATS_U64: u64 = 2_100_000_000_000_000u64

pub const MAX_BITCOIN_SUPPLY_MSATS_U64: u64 = 2_100_000_000_000_000_000u64

pub const INVOICE_MAX_AMOUNT_MSATS_U64: u64 = 1_844_674_407_370_955_161u64

The maximum amount we can set in a BOLT11 invoice via the LDK [lightning_invoice::InvoiceBuilder::amount_milli_satoshis] API. Setting above this value will overflow!

pub fn from_msat(msats: u64) -> Amount

Construct an Amount from a millisatoshi u64 value.

pub fn from_sats_u32(sats_u32: u32) -> Amount

Construct an Amount from a satoshi u32 value.

pub fn try_from_sats_u64(sats_u64: u64) -> Result<Amount, Error>

Construct an Amount from a satoshi u64 value.

pub fn try_from_sats(sats: Decimal) -> Result<Amount, Error>

Construct an Amount from a satoshi [Decimal] value.

pub fn try_from_btc(btc: Decimal) -> Result<Amount, Error>

Construct an Amount from a BTC [Decimal] value.

pub fn msat(&self) -> u64

Returns the Amount as a u64 millisatoshi value.

pub fn invoice_safe_msat(&self) -> Result<u64, Error>

Returns the Amount as a u64 millisatoshi value, but safe to use when building a BOLT11 lightning invoice.

pub fn sats_u64(&self) -> u64

Returns the Amount as a u64 satoshi value.

pub fn sats(&self) -> Decimal

Returns the Amount as a [Decimal] satoshi value.

pub fn btc(&self) -> Decimal

Returns the Amount as a [Decimal] BTC value.

pub fn round_sat(&self) -> Amount

Rounds to the nearest satoshi.

e.g. 123.456 sats => 123 sats

pub fn floor_sat(&self) -> Amount

Rounds to the nearest satoshi, rounding towards zero.

pub fn abs_diff(self, other: Amount) -> Amount

Returns the absolute difference |x-y| between two Amounts.

pub fn approx_eq(self, other: Amount, epsilon: Amount) -> bool

Returns true if two amounts are approximately equal, up to some epsilon max difference.

pub fn checked_add(self, rhs: Amount) -> Option<Amount>

pub fn checked_sub(self, rhs: Amount) -> Option<Amount>

pub fn checked_mul(self, rhs: Decimal) -> Option<Amount>

pub fn checked_div(self, rhs: Decimal) -> Option<Amount>

pub fn saturating_add(self, rhs: Amount) -> Amount

pub fn saturating_sub(self, rhs: Amount) -> Amount

pub fn saturating_mul(self, rhs: Decimal) -> Amount

Trait Implementations

impl Add for Amount

type Output = Amount

The resulting type after applying the + operator.

fn add(self, rhs: Amount) -> <Amount as Add>::Output

Performs the + operation.

impl AddAssign for Amount

fn add_assign(&mut self, rhs: Amount)

Performs the += operation.

impl Clone for Amount

fn clone(&self) -> Amount

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Amount

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Amount

fn deserialize<D>( deserializer: D, ) -> Result<Amount, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Amount

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Div<Decimal> for Amount

type Output = Amount

The resulting type after applying the / operator.

fn div(self, rhs: Decimal) -> <Amount as Div<Decimal>>::Output

Performs the / operation.

impl FromStr for Amount

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Amount, <Amount as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Amount

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<Decimal> for Amount

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, rhs: Decimal) -> <Amount as Mul<Decimal>>::Output

Performs the * operation.

impl Ord for Amount

fn cmp(&self, other: &Amount) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Amount

fn eq(&self, other: &Amount) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Amount

fn partial_cmp(&self, other: &Amount) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Amount

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Amount

type Output = Amount

The resulting type after applying the - operator.

fn sub(self, rhs: Amount) -> <Amount as Sub>::Output

Performs the - operation.

impl Sum for Amount

fn sum<I>(iter: I) -> Amount

where I: Iterator<Item = Amount>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Amount> for Amount

type Error = Error

The type returned in the event of a conversion error.

fn try_from(amt: Amount) -> Result<Amount, <Amount as TryFrom<Amount>>::Error>

Performs the conversion.

impl Copy for Amount

impl Eq for Amount

impl StructuralPartialEq for Amount