Struct Balance

pub struct Balance {
    pub negated: bool,
    pub balance: BTreeMap<Id, Imbalance<NonZeroU128>>,
}

A Balance is a “vector of Values”, where some values may be required, while others may be provided. For a transaction to be valid, its balance must be zero.

Fields

negated: bool

balance: BTreeMap<Id, Imbalance<NonZeroU128>>

Implementations

impl Balance

pub fn zero() -> Self

Make a new, zero balance.

pub fn is_zero(&self) -> bool

Check if this balance is zero.

pub fn dimension(&self) -> usize

Find out how many distinct assets are represented in this balance.

pub fn required( &self, ) -> impl Iterator<Item = Value> + DoubleEndedIterator + FusedIterator + '_

Iterate over all the requirements of the balance, as Values.

pub fn provided( &self, ) -> impl Iterator<Item = Value> + DoubleEndedIterator + FusedIterator + '_

pub fn commit(&self, blinding_factor: Fr) -> Commitment

Commit to a Balance using a provided blinding factor.

This is like a vectorized Value::commit.

Trait Implementations

impl Add<Value> for Balance

type Output = Balance

The resulting type after applying the + operator.

fn add(self, value: Value) -> Self::Output

Performs the + operation.

impl Add for Balance

type Output = Balance

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign<Value> for Balance

fn add_assign(&mut self, other: Value)

Performs the += operation.

impl AddAssign for Balance

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AllocVar<Balance, Fq> for BalanceVar

fn new_variable<T: Borrow<Balance>>( cs: impl Into<Namespace<Fq>>, f: impl FnOnce() -> Result<T, SynthesisError>, mode: AllocationMode, ) -> Result<Self, SynthesisError>

Allocates a new variable of type Self in the ConstraintSystem cs. The mode of allocation is decided by mode.

fn new_constant( cs: impl Into<Namespace<F>>, t: impl Borrow<V>, ) -> Result<Self, SynthesisError>

Allocates a new constant of type Self in the ConstraintSystem cs.

fn new_input<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new public input of type Self in the ConstraintSystem cs.

fn new_witness<T>( cs: impl Into<Namespace<F>>, f: impl FnOnce() -> Result<T, SynthesisError>, ) -> Result<Self, SynthesisError>

where T: Borrow<V>,

Allocates a new private witness of type Self in the ConstraintSystem cs.

impl Clone for Balance

fn clone(&self) -> Balance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Balance

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

Formats the value using the given formatter.

impl Default for Balance

fn default() -> Balance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Balance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for Balance

type Proto = Balance

fn encode_to_vec(&self) -> Vec<u8>

Encode this domain type to a byte vector, via proto type P.

fn to_proto(&self) -> Self::Proto

Convert this domain type to the associated proto type.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Decode this domain type from a byte buffer, via proto type P.

impl From<Balance> for Balance

fn from(v: Balance) -> Self

Converts to this type from the input type.

impl From<Value> for Balance

fn from(_: Value) -> Self

Converts to this type from the input type.

impl IntoIterator for Balance

type Item = Imbalance<Value>

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Neg for Balance

type Output = Balance

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Balance

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Value> for Balance

type Output = Balance

The resulting type after applying the - operator.

fn sub(self, value: Value) -> Self::Output

Performs the - operation.

impl Sub for Balance

type Output = Balance

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl SubAssign<Value> for Balance

fn sub_assign(&mut self, other: Value)

Performs the -= operation.

impl SubAssign for Balance

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl TryFrom<Balance> for Balance

Serialization should normalize the Balance, where the top-level negated field is excluded during serialization. Rather, the sign information is captured in the SignedValue pairs.

Since the underlying BTreeMap can’t hold multiple imbalances for the same asset ID, we implement an ordering-agnostic accumulation scheme that explicitly combines imbalances.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(balance: Balance) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Balance