Struct PaymentFee 

pub struct PaymentFee {
    pub base: Amount,
    pub parts_per_million: u64,
}

Fields

base: Amount

parts_per_million: u64

Implementations

impl PaymentFee

pub const SEND_FEE_LIMIT: PaymentFee

This is the maximum send fee of one and a half percent plus one hundred satoshis a correct gateway may recommend as a default. It accounts for the fee required to reliably route this payment over lightning.

pub const TRANSACTION_FEE_DEFAULT: PaymentFee

This is the fee the gateway uses to cover transaction fees with the federation.

pub const RECEIVE_FEE_LIMIT: PaymentFee

This is the maximum receive fee of half of one percent plus fifty satoshis a correct gateway may recommend as a default.

pub fn is_within(&self, limit: &PaymentFee) -> bool

Returns true if this fee is within limit in both components.

absolute_fee is monotonically increasing in base and in parts_per_million, so a fee is bounded by the limit only when neither component exceeds it. This is intentionally a named method rather than a derived PartialOrd, which orders the fields lexicographically and therefore stops at base whenever the two bases differ.

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

Adds two fees, returning None if either component overflows.

Fees reach this method straight from operator input, so the addition has to happen before the limit checks can run. A panicking Add would therefore be reachable with a fee that the limits are meant to reject.

pub fn add_to(&self, msats: u64) -> Amount

pub fn subtract_from(&self, msats: u64) -> Amount

pub fn fee(&self, msats: u64) -> Amount

fn absolute_fee(&self, msats: u64) -> u64

Trait Implementations

impl Clone for PaymentFee

fn clone(&self) -> PaymentFee

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentFee

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

Formats the value using the given formatter.

impl Decodable for PaymentFee

fn consensus_decode_partial_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

fn consensus_decode_partial<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

impl<'de> Deserialize<'de> for PaymentFee

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PaymentFee

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

Formats the value using the given formatter.

impl Encodable for PaymentFee

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> u64

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl From<RoutingFees> for PaymentFee

fn from(value: RoutingFees) -> Self

Converts to this type from the input type.

impl FromStr for PaymentFee

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for PaymentFee

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

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 PartialEq for PaymentFee

fn eq(&self, other: &PaymentFee) -> 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 Serialize for PaymentFee

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PaymentFee> for RoutingFees

type Error = FeeOutOfRangeError

The type returned in the event of a conversion error.

fn try_from(value: PaymentFee) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PaymentFee

impl Eq for PaymentFee

impl StructuralPartialEq for PaymentFee