Struct zebra_chain::value_balance::ValueBalance

impl<C> ValueBalance<C>
where C: Constraint + Copy,

pub fn from_transparent_amount(transparent_amount: Amount<C>) -> Self

Creates a ValueBalance from the given transparent amount.

pub fn from_sprout_amount(sprout_amount: Amount<C>) -> Self

Creates a ValueBalance from the given sprout amount.

pub fn from_sapling_amount(sapling_amount: Amount<C>) -> Self

Creates a ValueBalance from the given sapling amount.

pub fn from_orchard_amount(orchard_amount: Amount<C>) -> Self

Creates a ValueBalance from the given orchard amount.

pub fn transparent_amount(&self) -> Amount<C>

Get the transparent amount from the ValueBalance.

pub fn set_transparent_value_balance( &mut self, transparent_value_balance: ValueBalance<C> ) -> &Self

Insert a transparent value balance into a given ValueBalance leaving the other values untouched.

pub fn sprout_amount(&self) -> Amount<C>

Get the sprout amount from the ValueBalance.

pub fn set_sprout_value_balance( &mut self, sprout_value_balance: ValueBalance<C> ) -> &Self

Insert a sprout value balance into a given ValueBalance leaving the other values untouched.

pub fn sapling_amount(&self) -> Amount<C>

Get the sapling amount from the ValueBalance.

pub fn set_sapling_value_balance( &mut self, sapling_value_balance: ValueBalance<C> ) -> &Self

Insert a sapling value balance into a given ValueBalance leaving the other values untouched.

pub fn orchard_amount(&self) -> Amount<C>

Get the orchard amount from the ValueBalance.

pub fn set_orchard_value_balance( &mut self, orchard_value_balance: ValueBalance<C> ) -> &Self

Insert an orchard value balance into a given ValueBalance leaving the other values untouched.

pub fn zero() -> Self

Creates a ValueBalance where all the pools are zero.

pub fn constrain<C2>(self) -> Result<ValueBalance<C2>, ValueBalanceError>
where C2: Constraint,

Convert this value balance to a different ValueBalance type, if it satisfies the new constraint

impl ValueBalance<NegativeAllowed>

https://zips.z.cash/protocol/protocol.pdf#transactions

pub fn remaining_transaction_value(&self) -> Result<Amount<NonNegative>, Error>

Assumes that this value balance is a non-coinbase transaction value balance, and returns the remaining value in the transaction value pool.

§Consensus

The remaining value in the transparent transaction value pool MUST be nonnegative.

This rule applies to Block and Mempool transactions.

Design: https://github.com/ZcashFoundation/zebra/blob/main/book/src/dev/rfcs/0012-value-pools.md#definitions

impl ValueBalance<NonNegative>

https://zips.z.cash/protocol/protocol.pdf#joinsplitbalance

pub fn add_block( self, block: impl Borrow<Block>, utxos: &HashMap<OutPoint, Utxo> ) -> Result<ValueBalance<NonNegative>, ValueBalanceError>

Returns the sum of this value balance, and the chain value pool changes in block.

utxos must contain the transparent::Utxos of every input in this block, including UTXOs created by earlier transactions in this block.

Note: the chain value pool has the opposite sign to the transaction value pool.

See Block::chain_value_pool_change for details.

§Consensus

If the Sprout chain value pool balance would become negative in the block chain created as a result of accepting a block, then all nodes MUST reject the block as invalid.

If the Sapling chain value pool balance would become negative in the block chain created as a result of accepting a block, then all nodes MUST reject the block as invalid.

https://zips.z.cash/protocol/protocol.pdf#saplingbalance

If the Orchard chain value pool balance would become negative in the block chain created as a result of accepting a block , then all nodes MUST reject the block as invalid.

https://zips.z.cash/protocol/protocol.pdf#orchardbalance

If any of the “Sprout chain value pool balance”, “Sapling chain value pool balance”, or “Orchard chain value pool balance” would become negative in the block chain created as a result of accepting a block, then all nodes MUST reject the block as invalid.

https://zips.z.cash/zip-0209#specification

Zebra also checks that the transparent value pool is non-negative. In Zebra, we define this pool as the sum of all unspent transaction outputs. (Despite their encoding as an int64, transparent output values must be non-negative.)

This is a consensus rule derived from Bitcoin:

because a UTXO can only be spent once, the full value of the included UTXOs must be spent or given to a miner as a transaction fee.

https://developer.bitcoin.org/devguide/transactions.html#transaction-fees-and-change

pub fn add_chain_value_pool_change( self, chain_value_pool_change: ValueBalance<NegativeAllowed> ) -> Result<ValueBalance<NonNegative>, ValueBalanceError>

Returns the sum of this value balance, and the chain_value_pool_change.

Note: the chain value pool has the opposite sign to the transaction value pool.

See add_block for details.

pub fn to_bytes(self) -> [u8; 32]

To byte array

pub fn from_bytes( bytes: [u8; 32] ) -> Result<ValueBalance<NonNegative>, ValueBalanceError>

From byte array

Trait Implementations§

impl<C> Add<Result<ValueBalance<C>, ValueBalanceError>> for ValueBalance<C>
where C: Constraint,

type Output = Result<ValueBalance<C>, ValueBalanceError>

The resulting type after applying the + operator.

fn add(self, rhs: Result<ValueBalance<C>, ValueBalanceError>) -> Self::Output

Performs the + operation. Read more

impl<C> Add<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
where C: Constraint,

type Output = Result<ValueBalance<C>, ValueBalanceError>

The resulting type after applying the + operator.

fn add(self, rhs: ValueBalance<C>) -> Self::Output

Performs the + operation. Read more

impl<C> Add for ValueBalance<C>
where C: Constraint,

type Output = Result<ValueBalance<C>, ValueBalanceError>

The resulting type after applying the + operator.

fn add(self, rhs: ValueBalance<C>) -> Self::Output

Performs the + operation. Read more

impl<C> AddAssign<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
where ValueBalance<C>: Copy, C: Constraint,

fn add_assign(&mut self, rhs: ValueBalance<C>)

Performs the += operation. Read more

impl<C: Clone> Clone for ValueBalance<C>

fn clone(&self) -> ValueBalance<C>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<C: Debug> Debug for ValueBalance<C>

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

Formats the value using the given formatter. Read more

impl<C: Default> Default for ValueBalance<C>

fn default() -> ValueBalance<C>

Returns the “default value” for a type. Read more

impl<C: Hash> Hash for ValueBalance<C>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl<C> Neg for ValueBalance<C>
where C: Constraint,

type Output = ValueBalance<NegativeAllowed>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

impl<C: PartialEq> PartialEq for ValueBalance<C>

fn eq(&self, other: &ValueBalance<C>) -> bool

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

1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> Sub<Result<ValueBalance<C>, ValueBalanceError>> for ValueBalance<C>
where C: Constraint,

type Output = Result<ValueBalance<C>, ValueBalanceError>

The resulting type after applying the - operator.

fn sub(self, rhs: Result<ValueBalance<C>, ValueBalanceError>) -> Self::Output

Performs the - operation. Read more

impl<C> Sub<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
where C: Constraint,

type Output = Result<ValueBalance<C>, ValueBalanceError>

The resulting type after applying the - operator.

fn sub(self, rhs: ValueBalance<C>) -> Self::Output

Performs the - operation. Read more

impl<C> Sub for ValueBalance<C>
where C: Constraint,

type Output = Result<ValueBalance<C>, ValueBalanceError>

The resulting type after applying the - operator.

fn sub(self, rhs: ValueBalance<C>) -> Self::Output

Performs the - operation. Read more

impl<C> SubAssign<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
where ValueBalance<C>: Copy, C: Constraint,

fn sub_assign(&mut self, rhs: ValueBalance<C>)

Performs the -= operation. Read more

impl<'amt, C> Sum<&'amt ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
where C: Constraint + Copy + 'amt,

fn sum<I: Iterator<Item = &'amt ValueBalance<C>>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<C> Sum<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
where C: Constraint + Copy,

fn sum<I: Iterator<Item = ValueBalance<C>>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<C: Copy> Copy for ValueBalance<C>

impl<C: Eq> Eq for ValueBalance<C>

impl<C> StructuralPartialEq for ValueBalance<C>

Auto Trait Implementations§

impl<C> UnwindSafe for ValueBalance<C>
where C: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more