Struct OffboardRequest

pub struct OffboardRequest {
    pub script_pubkey: ScriptBuf,
    pub amount: Amount,
}

Fields

script_pubkey: ScriptBuf

amount: Amount

Implementations

impl OffboardRequest

pub fn calculate_fee( script_pubkey: &Script, fee_rate: FeeRate, fixed_weight_charged: Weight, ) -> Option<Amount>

Calculate the fee we have to charge for adding an output with the given scriptPubkey to a transaction.

Use the fixed_weight_charged argument to add the fixed fee part that the server charges. This will be added to the offboard’s output size and multiplied with the given fee rate.

Returns None in the calculation overflows because of insane scriptPubkey or fee rate.

pub fn validate(&self) -> Result<(), InvalidOffboardRequestError>

Validate that the offboard has a valid script.

pub fn to_txout(&self) -> TxOut

Convert into a tx output.

pub fn fee( &self, fee_rate: FeeRate, fixed_weight_charged: Weight, ) -> Option<Amount>

Returns the fee charged for the user to make this offboard given the fee rate

Use the fixed_weight_charged argument to add the fixed fee part that the server charges. This will be added to the offboard’s output size and multiplied with the given fee rate.

Returns None in the calculation overflows because of insane scriptPubkey or fee rate.

Trait Implementations

impl Clone for OffboardRequest

fn clone(&self) -> OffboardRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffboardRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OffboardRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for OffboardRequest

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 Ord for OffboardRequest

fn cmp(&self, other: &OffboardRequest) -> 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 OffboardRequest

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

fn partial_cmp(&self, other: &OffboardRequest) -> 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 OffboardRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OffboardRequest

impl StructuralPartialEq for OffboardRequest