Struct Movement 

pub struct Movement {

    pub id: MovementId,
    pub status: MovementStatus,
    pub subsystem: MovementSubsystem,
    pub metadata: HashMap<String, Value>,
    pub intended_balance: SignedAmount,
    pub effective_balance: SignedAmount,
    pub offchain_fee: Amount,
    pub sent_to: Vec<MovementDestination>,
    pub received_on: Vec<MovementDestination>,
    pub input_vtxos: Vec<VtxoId>,
    pub output_vtxos: Vec<VtxoId>,
    pub exited_vtxos: Vec<VtxoId>,
    pub time: MovementTimestamp,
}

Describes an attempted movement of offchain funds within the Wallet.

Fields

id: MovementId

The internal ID of the movement.

status: MovementStatus

The status of the movement.

subsystem: MovementSubsystem

Contains information about the subsystem that created the movement as well as the purpose of the movement.

metadata: HashMap<String, Value>

Miscellaneous metadata for the movement. This is JSON containing arbitrary information as defined by the subsystem that created the movement.

intended_balance: SignedAmount

How much the movement was expected to increase or decrease the balance by. This is always an estimate and often discounts any applicable fees.

effective_balance: SignedAmount

How much the wallet balance actually changed by. Positive numbers indicate an increase and negative numbers indicate a decrease. This is often inclusive of applicable fees, and it should be the most accurate number.

offchain_fee: Amount

How much the movement cost the user in offchain fees. If there are applicable onchain fees they will not be included in this value but, depending on the subsystem, could be found in the metadata.

sent_to: Vec<MovementDestination>

A list of external recipients that received funds from this movement.

received_on: Vec<MovementDestination>

Describes the means by which the wallet received funds in this movement. This could include BOLT11 invoices or other useful data.

input_vtxos: Vec<VtxoId>

A list of Vtxo IDs that were consumed by this movement and are either locked or unavailable.

output_vtxos: Vec<VtxoId>

A list of IDs for new VTXOs that were produced as a result of this movement. Often change VTXOs will be found here for outbound actions unless this was an inbound action.

exited_vtxos: Vec<VtxoId>

A list of IDs for VTXOs that were marked for unilateral exit as a result of this movement. This could happen for many reasons, e.g. an unsuccessful lightning payment which can’t be revoked but is about to expire. VTXOs listed here will result in a reduction of spendable balance due to the VTXOs being managed by the crate::Exit system.

time: MovementTimestamp

Contains the times at which the movement was created, updated and completed.

Implementations

impl Movement

pub fn new( id: MovementId, status: MovementStatus, subsystem: &MovementSubsystem, time: DateTime<Local>, ) -> Self

pub fn received_on(&self, payment_method: &PaymentMethod) -> bool

Checks whether this movement received the given payment method

pub fn sent_to(&self, payment_method: &PaymentMethod) -> bool

Checks whether this movement sent to the given payment method

pub fn lightning_invoice(&self) -> Option<&Invoice>

Get the Lightning invoice associated with this movement

Returns None for movements that don’t have an invoice.

pub fn lightning_offer(&self) -> Option<&Offer>

Get the Lightning offer associated with this movement

Returns None for movements that don’t have an offer.

pub fn lightning_payment_hash(&self) -> Option<PaymentHash>

Get the Lightning payment hash associated with this movement

Returns None for movements that are not Lightning payments.

Trait Implementations

impl Clone for Movement

fn clone(&self) -> Movement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Movement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Movement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Movement

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

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 Movement

impl StructuralPartialEq for Movement