Struct grin_wallet_libwallet::OutputData

pub struct OutputData {
    pub root_key_id: Identifier,
    pub key_id: Identifier,
    pub n_child: u32,
    pub commit: Option<String>,
    pub mmr_index: Option<u64>,
    pub value: u64,
    pub status: OutputStatus,
    pub height: u64,
    pub lock_height: u64,
    pub is_coinbase: bool,
    pub tx_log_entry: Option<u32>,
}

Information about an output that's being tracked by the wallet. Must be enough to reconstruct the commitment associated with the ouput when the root private key is known.

Fields

root_key_id: Identifier

Root key_id that the key for this output is derived from

key_id: Identifier

Derived key for this output

n_child: u32

How many derivations down from the root key

commit: Option<String>

The actual commit, optionally stored

mmr_index: Option<u64>

PMMR Index, used on restore in case of duplicate wallets using the same key_id (2 wallets using same seed, for instance

value: u64

Value of the output, necessary to rebuild the commitment

status: OutputStatus

Current status of the output

height: u64

Height of the output

lock_height: u64

Height we are locked until

is_coinbase: bool

Is this a coinbase output? Is it subject to coinbase locktime?

tx_log_entry: Option<u32>

Optional corresponding internal entry in tx entry log

Methods

impl OutputData

pub fn lock(&mut self)

Lock a given output to avoid conflicting use

pub fn num_confirmations(&self, current_height: u64) -> u64

How many confirmations has this output received? If height == 0 then we are either Unconfirmed or the output was cut-through so we do not actually know how many confirmations this output had (and never will).

pub fn eligible_to_spend(
    &self,
    current_height: u64,
    minimum_confirmations: u64
) -> bool

Check if output is eligible to spend based on state and height and confirmations

pub fn mark_unspent(&mut self)

Marks this output as unspent if it was previously unconfirmed

pub fn mark_spent(&mut self)

Mark an output as spent

Trait Implementations

impl Clone for OutputData

fn clone(&self) -> OutputData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for OutputData

impl Ord for OutputData

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<OutputData> for OutputData

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<OutputData> for OutputData

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Debug for OutputData

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

Formats the value using the given formatter.

impl Serialize for OutputData

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for OutputData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Writeable for OutputData

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Write the data held by this Writeable to the provided writer

impl Readable for OutputData

fn read(reader: &mut dyn Reader) -> Result<OutputData, Error>

Reads the data necessary to this Readable from the provided reader