Struct JoinSplitData

pub struct JoinSplitData<P: ZkSnarkProof> {
    pub first: JoinSplit<P>,
    pub rest: Vec<JoinSplit<P>>,
    pub pub_key: VerificationKeyBytes,
    pub sig: Signature,
}

A bundle of JoinSplit descriptions and signature data.

JoinSplit descriptions are optional, but Zcash transactions must include a JoinSplit signature and verification key if and only if there is at least one JoinSplit description. This wrapper type bundles at least one JoinSplit description with the required signature data, so that an Option<JoinSplitData> correctly models the presence or absence of any JoinSplit data.

Fields

first: JoinSplit<P>

The first JoinSplit description in the transaction, using proofs of type P.

Storing this separately from rest ensures that it is impossible to construct an invalid JoinSplitData with no JoinSplits.

However, it’s not necessary to access or process first and rest separately, as the JoinSplitData::joinsplits method provides an iterator over all of the JoinSplits.

rest: Vec<JoinSplit<P>>

The rest of the JoinSplit descriptions, using proofs of type P, in the order they appear in the transaction.

The JoinSplitData::joinsplits method provides an iterator over all JoinSplits.

pub_key: VerificationKeyBytes

The public key for the JoinSplit signature, denoted as joinSplitPubKey in the spec.

sig: Signature

The JoinSplit signature, denoted as joinSplitSig in the spec.

Implementations

impl<P: ZkSnarkProof> JoinSplitData<P>

pub fn joinsplits(&self) -> impl Iterator<Item = &JoinSplit<P>>

Iterate over the JoinSplits in self, in the order they appear in the transaction.

pub fn joinsplits_mut(&mut self) -> impl Iterator<Item = &mut JoinSplit<P>>

Modify the JoinSplits in self, in the order they appear in the transaction.

pub fn nullifiers(&self) -> impl Iterator<Item = &Nullifier>

Iterate over the Nullifiers in self.

pub fn value_balance(&self) -> Result<Amount<NegativeAllowed>, Error>

Return the sprout value balance, the change in the transaction value pool due to sprout JoinSplits.

https://zebra.zfnd.org/dev/rfcs/0012-value-pools.html#definitions

See sprout_value_balance for details.

pub fn joinsplit_value_balances( &self, ) -> Box<dyn Iterator<Item = Amount<NegativeAllowed>> + '_>

Return a list of sprout value balances, the changes in the transaction value pool due to each sprout JoinSplit.

See sprout_value_balance for details.

pub fn note_commitments(&self) -> impl Iterator<Item = &NoteCommitment>

Collect the Sprout note commitments for this transaction, if it contains Outputs, in the order they appear in the transaction.

Trait Implementations

impl<P: ZkSnarkProof + Arbitrary + 'static> Arbitrary for JoinSplitData<P>

type Parameters = ()

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

type Strategy = BoxedStrategy<JoinSplitData<P>>

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

fn arbitrary_with(_args: 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<P: Clone + ZkSnarkProof> Clone for JoinSplitData<P>

fn clone(&self) -> JoinSplitData<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: ZkSnarkProof> Debug for JoinSplitData<P>

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

Formats the value using the given formatter.

impl<'de, P: ZkSnarkProof> Deserialize<'de> for JoinSplitData<P>

where JoinSplit<P>: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<P: ZkSnarkProof> Display for JoinSplitData<P>

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

Formats the value using the given formatter.

impl<P: PartialEq + ZkSnarkProof> PartialEq for JoinSplitData<P>

fn eq(&self, other: &JoinSplitData<P>) -> 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<P: ZkSnarkProof> Serialize for JoinSplitData<P>

where JoinSplit<P>: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<P: ZkSnarkProof> ZcashSerialize for JoinSplitData<P>

fn zcash_serialize<W: Write>(&self, writer: W) -> Result<(), Error>

Write self to the given writer using the canonical format.

fn zcash_serialize_to_vec(&self) -> Result<Vec<u8>, Error>

Helper function to construct a vec to serialize the current struct into

fn zcash_serialized_size(&self) -> usize

Get the size of self by using a fake writer.

impl<P: Eq + ZkSnarkProof> Eq for JoinSplitData<P>

impl<P: ZkSnarkProof> StructuralPartialEq for JoinSplitData<P>