Struct OffboardFees 

pub struct OffboardFees {
    pub base_fee: Amount,
    pub fixed_additional_vb: u64,
    pub ppm_expiry_table: Vec<PpmExpiryFeeEntry>,
}

Fees for offboarding from the ark.

Fields

base_fee: Amount

A fee applied to every transaction regardless of value.

fixed_additional_vb: u64

Fixed number of virtual bytes charged offboard on top of the output size.

The fee for an offboard will be this value, plus the offboard output virtual size, multiplied with the offboard fee rate, plus the base_fee, and plus the additional fee calculated with the ppm_expiry_table.

ppm_expiry_table: Vec<PpmExpiryFeeEntry>

A table mapping how soon a VTXO will expire to a PPM (parts per million) fee rate. The table should be sorted by each expiry_blocks_threshold value in ascending order.

Implementations

impl OffboardFees

pub fn calculate( &self, destination: &ScriptBuf, amount: Amount, fee_rate: FeeRate, vtxos: impl IntoIterator<Item = VtxoFeeInfo>, ) -> Option<Amount>

Returns the fee charged for the user to make an offboard given the fee rate.

Returns None in the calculation overflows because of insane destinations or fee rates.

pub fn calculate_legacy( &self, destination: &ScriptBuf, amount: Amount, fee_rate: FeeRate, vtxos: impl IntoIterator<Item = VtxoFeeInfo>, ) -> Option<Amount>

👎Deprecated:

only for protocol versions <= 3

OffboardFees::calculate for clients on protocol versions that calculate ppm fees per VTXO.

Trait Implementations

impl Clone for OffboardFees

fn clone(&self) -> OffboardFees

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffboardFees

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OffboardFees

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OffboardFees

impl Hash for OffboardFees

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 OffboardFees

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OffboardFees

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OffboardFees