Struct AddressBalanceLocation

pub struct AddressBalanceLocation {
    balance: Amount<NonNegative>,
    location: OutputLocation,
}

Data which Zebra indexes for each transparent::Address.

Currently, Zebra tracks this data 1:1 for each address:

• the balance Amount for a transparent address, and
• the AddressLocation for the first transparent::Output sent to that address (regardless of whether that output is spent or unspent).

All other address data is tracked multiple times for each address (UTXOs and transactions).

Fields

balance: Amount<NonNegative>

The total balance of all UTXOs sent to an address.

location: OutputLocation

The location of the first transparent::Output sent to an address.

Implementations

impl AddressBalanceLocation

pub fn new(first_output: OutputLocation) -> AddressBalanceLocation

Creates a new AddressBalanceLocation from the location of the first transparent::Output sent to an address.

The returned value has a zero initial balance.

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

Returns the current balance for the address.

pub fn balance_mut(&mut self) -> &mut Amount<NonNegative>

Returns a mutable reference to the current balance for the address.

pub fn receive_output(&mut self, unspent_output: &Output) -> Result<(), Error>

Updates the current balance by adding the supplied output’s value.

pub fn spend_output(&mut self, spent_output: &Output) -> Result<(), Error>

Updates the current balance by subtracting the supplied output’s value.

pub fn address_location(&self) -> OutputLocation

Returns the location of the first transparent::Output sent to an address.

pub fn height_mut(&mut self) -> &mut Height

Allows tests to set the height of the address location.

Trait Implementations

impl Arbitrary for AddressBalanceLocation

type Parameters = (<Amount<NonNegative> as Arbitrary>::Parameters, <OutputLocation as Arbitrary>::Parameters)

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<(<Amount<NonNegative> as Arbitrary>::Strategy, <OutputLocation as Arbitrary>::Strategy), fn(_: (Amount<NonNegative>, OutputLocation)) -> AddressBalanceLocation>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for AddressBalanceLocation

fn clone(&self) -> AddressBalanceLocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddressBalanceLocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AddressBalanceLocation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromDisk for AddressBalanceLocation

fn from_bytes(disk_bytes: impl AsRef<[u8]>) -> Self

Converts raw disk bytes back into the deserialized type.

impl IntoDisk for AddressBalanceLocation

type Bytes = [u8; 16]

The type used to write bytes to disk, and compare a value as a key to on-disk keys.

fn as_bytes(&self) -> Self::Bytes

Converts the current type into serialized raw bytes.

impl PartialEq for AddressBalanceLocation

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for AddressBalanceLocation

impl Eq for AddressBalanceLocation

impl StructuralPartialEq for AddressBalanceLocation