pub struct ValueBalance<C> { /* private fields */ }
Expand description
A balance in each chain value pool or transaction value pool.
Implementations§
Source§impl<C> ValueBalance<C>where
C: Constraint + Copy,
impl<C> ValueBalance<C>where
C: Constraint + Copy,
Sourcepub fn from_transparent_amount(transparent_amount: Amount<C>) -> Self
pub fn from_transparent_amount(transparent_amount: Amount<C>) -> Self
Creates a ValueBalance
from the given transparent amount.
Sourcepub fn from_sprout_amount(sprout_amount: Amount<C>) -> Self
pub fn from_sprout_amount(sprout_amount: Amount<C>) -> Self
Creates a ValueBalance
from the given sprout amount.
Sourcepub fn from_sapling_amount(sapling_amount: Amount<C>) -> Self
pub fn from_sapling_amount(sapling_amount: Amount<C>) -> Self
Creates a ValueBalance
from the given sapling amount.
Sourcepub fn from_orchard_amount(orchard_amount: Amount<C>) -> Self
pub fn from_orchard_amount(orchard_amount: Amount<C>) -> Self
Creates a ValueBalance
from the given orchard amount.
Sourcepub fn transparent_amount(&self) -> Amount<C>
pub fn transparent_amount(&self) -> Amount<C>
Get the transparent amount from the ValueBalance
.
Sourcepub fn set_transparent_value_balance(
&mut self,
transparent_value_balance: ValueBalance<C>,
) -> &Self
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.
Sourcepub fn sprout_amount(&self) -> Amount<C>
pub fn sprout_amount(&self) -> Amount<C>
Get the sprout amount from the ValueBalance
.
Sourcepub fn set_sprout_value_balance(
&mut self,
sprout_value_balance: ValueBalance<C>,
) -> &Self
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.
Sourcepub fn sapling_amount(&self) -> Amount<C>
pub fn sapling_amount(&self) -> Amount<C>
Get the sapling amount from the ValueBalance
.
Sourcepub fn set_sapling_value_balance(
&mut self,
sapling_value_balance: ValueBalance<C>,
) -> &Self
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.
Sourcepub fn orchard_amount(&self) -> Amount<C>
pub fn orchard_amount(&self) -> Amount<C>
Get the orchard amount from the ValueBalance
.
Sourcepub fn set_orchard_value_balance(
&mut self,
orchard_value_balance: ValueBalance<C>,
) -> &Self
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.
Sourcepub fn deferred_amount(&self) -> Amount<C>
pub fn deferred_amount(&self) -> Amount<C>
Returns the deferred amount.
Sourcepub fn set_deferred_amount(&mut self, deferred_amount: Amount<C>) -> &Self
pub fn set_deferred_amount(&mut self, deferred_amount: Amount<C>) -> &Self
Sets the deferred amount without affecting other amounts.
Sourcepub fn zero() -> Self
pub fn zero() -> Self
Creates a ValueBalance
where all the pools are zero.
Sourcepub fn constrain<C2>(self) -> Result<ValueBalance<C2>, ValueBalanceError>where
C2: Constraint,
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
Source§impl ValueBalance<NegativeAllowed>
impl ValueBalance<NegativeAllowed>
Sourcepub fn remaining_transaction_value(&self) -> Result<Amount<NonNegative>, Error>
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.
https://zips.z.cash/protocol/protocol.pdf#transactions
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
Source§impl ValueBalance<NonNegative>
impl ValueBalance<NonNegative>
Sourcepub fn add_chain_value_pool_change(
self,
chain_value_pool_change: ValueBalance<NegativeAllowed>,
) -> Result<ValueBalance<NonNegative>, ValueBalanceError>
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 given chain_value_pool_change
.
Note that the chain value pool has the opposite sign to the transaction value pool.
§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.
https://zips.z.cash/protocol/protocol.pdf#joinsplitbalance
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
We implement the consensus rules above by constraining the returned value balance to
ValueBalance<NonNegative>
.
Sourcepub fn from_bytes(
bytes: &[u8],
) -> Result<ValueBalance<NonNegative>, ValueBalanceError>
pub fn from_bytes( bytes: &[u8], ) -> Result<ValueBalance<NonNegative>, ValueBalanceError>
From byte array
Trait Implementations§
Source§impl<C> Add<Result<ValueBalance<C>, ValueBalanceError>> for ValueBalance<C>where
C: Constraint,
impl<C> Add<Result<ValueBalance<C>, ValueBalanceError>> for ValueBalance<C>where
C: Constraint,
Source§type Output = Result<ValueBalance<C>, ValueBalanceError>
type Output = Result<ValueBalance<C>, ValueBalanceError>
+
operator.Source§fn add(self, rhs: Result<ValueBalance<C>, ValueBalanceError>) -> Self::Output
fn add(self, rhs: Result<ValueBalance<C>, ValueBalanceError>) -> Self::Output
+
operation. Read moreSource§impl<C> Add<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>where
C: Constraint,
impl<C> Add<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>where
C: Constraint,
Source§type Output = Result<ValueBalance<C>, ValueBalanceError>
type Output = Result<ValueBalance<C>, ValueBalanceError>
+
operator.Source§impl<C> Add for ValueBalance<C>where
C: Constraint,
impl<C> Add for ValueBalance<C>where
C: Constraint,
Source§type Output = Result<ValueBalance<C>, ValueBalanceError>
type Output = Result<ValueBalance<C>, ValueBalanceError>
+
operator.Source§impl<C> AddAssign<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
impl<C> AddAssign<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
Source§fn add_assign(&mut self, rhs: ValueBalance<C>)
fn add_assign(&mut self, rhs: ValueBalance<C>)
+=
operation. Read moreSource§impl<C: Clone> Clone for ValueBalance<C>
impl<C: Clone> Clone for ValueBalance<C>
Source§fn clone(&self) -> ValueBalance<C>
fn clone(&self) -> ValueBalance<C>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl<C: Debug> Debug for ValueBalance<C>
impl<C: Debug> Debug for ValueBalance<C>
Source§impl<C: Default> Default for ValueBalance<C>
impl<C: Default> Default for ValueBalance<C>
Source§fn default() -> ValueBalance<C>
fn default() -> ValueBalance<C>
Source§impl<C: Hash> Hash for ValueBalance<C>
impl<C: Hash> Hash for ValueBalance<C>
Source§impl<C> Neg for ValueBalance<C>where
C: Constraint,
impl<C> Neg for ValueBalance<C>where
C: Constraint,
Source§type Output = ValueBalance<NegativeAllowed>
type Output = ValueBalance<NegativeAllowed>
-
operator.Source§impl<C: PartialEq> PartialEq for ValueBalance<C>
impl<C: PartialEq> PartialEq for ValueBalance<C>
Source§impl<C> Sub<Result<ValueBalance<C>, ValueBalanceError>> for ValueBalance<C>where
C: Constraint,
impl<C> Sub<Result<ValueBalance<C>, ValueBalanceError>> for ValueBalance<C>where
C: Constraint,
Source§type Output = Result<ValueBalance<C>, ValueBalanceError>
type Output = Result<ValueBalance<C>, ValueBalanceError>
-
operator.Source§fn sub(self, rhs: Result<ValueBalance<C>, ValueBalanceError>) -> Self::Output
fn sub(self, rhs: Result<ValueBalance<C>, ValueBalanceError>) -> Self::Output
-
operation. Read moreSource§impl<C> Sub<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>where
C: Constraint,
impl<C> Sub<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>where
C: Constraint,
Source§type Output = Result<ValueBalance<C>, ValueBalanceError>
type Output = Result<ValueBalance<C>, ValueBalanceError>
-
operator.Source§impl<C> Sub for ValueBalance<C>where
C: Constraint,
impl<C> Sub for ValueBalance<C>where
C: Constraint,
Source§type Output = Result<ValueBalance<C>, ValueBalanceError>
type Output = Result<ValueBalance<C>, ValueBalanceError>
-
operator.Source§impl<C> SubAssign<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
impl<C> SubAssign<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>
Source§fn sub_assign(&mut self, rhs: ValueBalance<C>)
fn sub_assign(&mut self, rhs: ValueBalance<C>)
-=
operation. Read moreSource§impl<'amt, C> Sum<&'amt ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>where
C: Constraint + Copy + 'amt,
impl<'amt, C> Sum<&'amt ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>where
C: Constraint + Copy + 'amt,
Source§fn sum<I: Iterator<Item = &'amt ValueBalance<C>>>(iter: I) -> Self
fn sum<I: Iterator<Item = &'amt ValueBalance<C>>>(iter: I) -> Self
Self
from the elements by “summing up”
the items.Source§impl<C> Sum<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>where
C: Constraint + Copy,
impl<C> Sum<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>where
C: Constraint + Copy,
Source§fn sum<I: Iterator<Item = ValueBalance<C>>>(iter: I) -> Self
fn sum<I: Iterator<Item = ValueBalance<C>>>(iter: I) -> Self
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> Freeze for ValueBalance<C>
impl<C> RefUnwindSafe for ValueBalance<C>where
C: RefUnwindSafe,
impl<C> Send for ValueBalance<C>where
C: Send,
impl<C> Sync for ValueBalance<C>where
C: Sync,
impl<C> Unpin for ValueBalance<C>where
C: Unpin,
impl<C> UnwindSafe for ValueBalance<C>where
C: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.