Struct ValueBalance

Source
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,

Source

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

Creates a ValueBalance from the given transparent amount.

Source

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

Creates a ValueBalance from the given sprout amount.

Source

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

Creates a ValueBalance from the given sapling amount.

Source

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

Creates a ValueBalance from the given orchard amount.

Source

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

Get the transparent amount from the ValueBalance.

Source

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.

Source

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

Get the sprout amount from the ValueBalance.

Source

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.

Source

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

Get the sapling amount from the ValueBalance.

Source

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.

Source

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

Get the orchard amount from the ValueBalance.

Source

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.

Source

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

Returns the deferred amount.

Source

pub fn set_deferred_amount(&mut self, deferred_amount: Amount<C>) -> &Self

Sets the deferred amount without affecting other amounts.

Source

pub fn zero() -> Self

Creates a ValueBalance where all the pools are zero.

Source

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>

Source

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>

Source

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>.

Source

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

To byte array

Source

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,

Source§

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

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

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

Source§

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

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

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

Source§

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

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl<C> AddAssign<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>

Source§

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

Performs the += operation. Read more
Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> ValueBalance<C>

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

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

Source§

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
Source§

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

Source§

type Output = ValueBalance<NegativeAllowed>

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

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

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

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

Source§

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

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

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

Source§

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

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl<C> SubAssign<ValueBalance<C>> for Result<ValueBalance<C>, ValueBalanceError>

Source§

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

Performs the -= operation. Read more
Source§

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

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

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

Takes an iterator and generates Self from the elements by “summing up” the items.
Source§

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

Source§

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

Source§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

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

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

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

Source§

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

Compare self to key and return true if they are equal.
Source§

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

Source§

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

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

impl<T> FmtForward for T

Source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

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

Source§

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
Source§

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
Source§

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
Source§

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

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

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

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

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

Borrows 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
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

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

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.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

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

Immutable access to a value. Read more
Source§

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

Mutable access to a value. Read more
Source§

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

Immutable access to the Borrow<B> of a value. Read more
Source§

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

Mutable access to the BorrowMut<B> of a value. Read more
Source§

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
Source§

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
Source§

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
Source§

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
Source§

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

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

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

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

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

Calls .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
where Self: BorrowMut<B>, B: ?Sized,

Calls .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
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .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
where Self: Deref<Target = T>, T: ?Sized,

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

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.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

Source§

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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