Struct zebra_state::service::non_finalized_state::chain::index::TransparentTransfers

pub struct TransparentTransfers {
    balance: Amount<NegativeAllowed>,
    tx_ids: MultiSet<Hash>,
    created_utxos: BTreeMap<OutputLocation, Output>,
    spent_utxos: BTreeSet<OutputLocation>,
}

Fields

balance: Amount<NegativeAllowed>

The partial chain balance for a transparent address.

tx_ids: MultiSet<Hash>

The partial list of transactions that spent or received UTXOs to a transparent address.

Since transactions can only be added to this set, it does not need special handling for ReadStateService response inconsistencies.

The getaddresstxids RPC needs these transaction IDs to be sorted in chain order.

created_utxos: BTreeMap<OutputLocation, Output>

The partial list of UTXOs received by a transparent address.

The getaddressutxos RPC doesn’t need these transaction IDs to be sorted in chain order, but it might in future. So Zebra does it anyway.

Optional TODOs:

• store Utxos in the chain, and just store the created locations for this address
• if we add an OutputLocation to UTXO, remove this OutputLocation, and use the inner OutputLocation to sort Utxos in chain order

spent_utxos: BTreeSet<OutputLocation>

The partial list of UTXOs spent by a transparent address.

The getaddressutxos RPC doesn’t need these transaction IDs to be sorted in chain order, but it might in future. So Zebra does it anyway.

Optional TODO:

• store spent Utxos by location in the chain, use the chain spent UTXOs to filter, and stop storing spent UTXOs by address

Implementations

impl TransparentTransfers

pub fn is_empty(&self) -> bool

Returns true if there are no transfers for this address.

pub fn balance(&self) -> Amount<NegativeAllowed>

Returns the partial balance for this address.

pub fn tx_ids( &self, chain_tx_loc_by_hash: &HashMap<Hash, TransactionLocation>, query_height_range: RangeInclusive<Height>, ) -> BTreeMap<TransactionLocation, Hash>

Returns the transaction::Hashes of the transactions that sent or received transparent transfers to this address, in this partial chain, filtered by query_height_range.

The transactions are returned in chain order.

chain_tx_loc_by_hash should be the tx_loc_by_hash field from the Chain containing this index.

Panics

If chain_tx_loc_by_hash is missing some transaction hashes from this index.

pub fn created_utxos(&self) -> &BTreeMap<OutputLocation, Output>

Returns the new transparent outputs sent to this address, in this partial chain, in chain order.

Some of these outputs might already be spent. TransparentTransfers::spent_utxos returns spent UTXOs.

pub fn spent_utxos(&self) -> &BTreeSet<OutputLocation>

Returns the OutputLocations of the spent transparent outputs sent to this address, in this partial chain, in chain order.

Trait Implementations

impl Clone for TransparentTransfers

fn clone(&self) -> TransparentTransfers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransparentTransfers

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

Formats the value using the given formatter.

impl Default for TransparentTransfers

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for TransparentTransfers

fn eq(&self, other: &TransparentTransfers) -> 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 UpdateWith<(&Input, &Hash, &OrderedUtxo)> for TransparentTransfers

fn update_chain_tip_with( &mut self, (spending_input, spending_tx_hash, spent_output): &(&Input, &Hash, &OrderedUtxo), ) -> Result<(), ValidateContextError>

When T is added to the chain tip, update Chain cumulative data members to add data that are derived from T.

fn revert_chain_with( &mut self, (spending_input, spending_tx_hash, spent_output): &(&Input, &Hash, &OrderedUtxo), _position: RevertPosition, )

When T is removed from position in the chain, revert Chain cumulative data members to remove data that are derived from T.

impl UpdateWith<(&OutPoint, &OrderedUtxo)> for TransparentTransfers

fn update_chain_tip_with( &mut self, (outpoint, created_utxo): &(&OutPoint, &OrderedUtxo), ) -> Result<(), ValidateContextError>

When T is added to the chain tip, update Chain cumulative data members to add data that are derived from T.

fn revert_chain_with( &mut self, (outpoint, created_utxo): &(&OutPoint, &OrderedUtxo), _position: RevertPosition, )

When T is removed from position in the chain, revert Chain cumulative data members to remove data that are derived from T.

impl Eq for TransparentTransfers

impl StructuralPartialEq for TransparentTransfers