Enum Output 

pub enum Output<N>
where
    N: Network,
{
    Constant(Field<N>, Option<Plaintext<N>>),
    Public(Field<N>, Option<Plaintext<N>>),
    Private(Field<N>, Option<Ciphertext<N>>),
    Record(Field<N>, Field<N>, Option<Record<N, Ciphertext<N>>>, Option<Field<N>>),
    ExternalRecord(Field<N>),
    Future(Field<N>, Option<Future<N>>),
    DynamicRecord(Field<N>),
    RecordWithDynamicID(Field<N>, Field<N>, Option<Record<N, Ciphertext<N>>>, Option<Field<N>>, Field<N>),
    ExternalRecordWithDynamicID(Field<N>, Field<N>),
}

The transition output.

Variants

Constant(Field<N>, Option<Plaintext<N>>)

The plaintext hash and (optional) plaintext.

Public(Field<N>, Option<Plaintext<N>>)

The plaintext hash and (optional) plaintext.

Private(Field<N>, Option<Ciphertext<N>>)

The ciphertext hash and (optional) ciphertext.

Record(Field<N>, Field<N>, Option<Record<N, Ciphertext<N>>>, Option<Field<N>>)

The commitment, checksum, (optional) record ciphertext, and (optional) sender ciphertext.

ExternalRecord(Field<N>)

The hash of the external record’s (function_id, record, tvk, output index).

Future(Field<N>, Option<Future<N>>)

The future hash and (optional) future.

DynamicRecord(Field<N>)

The hash of the dynamic record’s (function_id, record, tvk, output index).

RecordWithDynamicID(Field<N>, Field<N>, Option<Record<N, Ciphertext<N>>>, Option<Field<N>>, Field<N>)

The commitment, checksum, (optional) record ciphertext, (optional) sender ciphertext, and dynamic ID.

ExternalRecordWithDynamicID(Field<N>, Field<N>)

The external record hash and dynamic ID.

Implementations

impl<N> Output<N>

where N: Network,

pub const fn variant(&self) -> u8

Returns the variant of the output.

pub const fn id(&self) -> &Field<N>

Returns the ID of the output.

pub fn to_transition_leaf(&self, index: u8) -> TransitionLeaf<N>

Returns the output as a transition leaf. Note: RecordWithDynamicID uses leaf variant 3 (same as Record) with version 2. Note: ExternalRecordWithDynamicID uses leaf variant 4 (same as ExternalRecord) with version 2.

pub const fn record(&self) -> Option<(&Field<N>, &Record<N, Ciphertext<N>>)>

Returns the commitment and record, if the output is a record.

pub fn into_record(self) -> Option<(Field<N>, Record<N, Ciphertext<N>>)>

Consumes self and returns the commitment and record, if the output is a record.

pub const fn commitment(&self) -> Option<&Field<N>>

Returns the commitment, if the output is a record.

pub fn into_commitment(self) -> Option<Field<N>>

Returns the commitment, if the output is a record, and consumes self.

pub const fn nonce(&self) -> Option<&Group<N>>

Returns the nonce, if the output is a record.

pub fn into_nonce(self) -> Option<Group<N>>

Returns the nonce, if the output is a record, and consumes self.

pub const fn checksum(&self) -> Option<&Field<N>>

Returns the checksum, if the output is a record.

pub fn into_checksum(self) -> Option<Field<N>>

Returns the checksum, if the output is a record, and consumes self.

pub const fn sender_ciphertext(&self) -> Option<&Field<N>>

Returns the sender ciphertext, if the output is a record.

pub fn into_sender_ciphertext(self) -> Option<Field<N>>

Returns the sender ciphertext, if the output is a record, and consumes self.

pub const fn future(&self) -> Option<&Future<N>>

Returns the future, if the output is a future.

impl<N> Output<N>

where N: Network,

pub fn decrypt_sender_ciphertext( &self, account_view_key: &ViewKey<N>, ) -> Result<Option<Address<N>>, Error>

Returns the sender address, given the account view key of the record owner.

If the output is not a record or does not contain a sender ciphertext, it returns Ok(None). If the record does not belong to the given account view key, it returns Err. If the sender ciphertext is malformed or cannot be decrypted, it returns Err.

impl<N> Output<N>

where N: Network,

pub fn verifier_inputs(&self) -> impl Iterator<Item = <N as Environment>::Field>

Returns the public verifier inputs for the proof.

pub const fn dynamic_id(&self) -> Option<&Field<N>>

Returns the dynamic ID, if the output carries one.

pub fn to_caller_output(&self) -> Output<N>

Returns the output from the caller’s perspective.

pub fn verify( &self, function_id: Field<N>, tcm: &Field<N>, index: usize, ) -> bool

Returns true if the output is well-formed. If the optional value exists, this method checks that it hashes to the output ID.

pub fn is_type(&self, expected_value_type: &ValueType<N>) -> bool

Returns true if the output matches the expected value type.

pub fn valid_as_output( &self, callee_value_type: &ValueType<N>, is_dynamic: Option<bool>, ) -> bool

Returns true if the output matches the given value type as produced by the callee. Record, ExternalRecord, DynamicRecord, RecordWithDynamicID and ExternalRecordWithDynamicID outputs are handled according to the value of is_dynamic:

• Some(true) enforces type correspondence assuming the outputs refer to a dynamic call.
• Some(false) enforces it assuming a static call.
• None is flexible and makes no assumption about the type of call: both dynamic-call and static-call matching patterns return true.

For outputs of an invalid type according to is_dynamic, this function returns false regardless of the value type.

Trait Implementations

impl<N> Clone for Output<N>

where N: Clone + Network,

fn clone(&self) -> Output<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Output<N>

where N: Network,

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

Prints the output as a JSON-string.

impl<'de, N> Deserialize<'de> for Output<N>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<Output<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the transition output from a string or bytes.

impl<N> Display for Output<N>

where N: Network,

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

Displays the output as a JSON-string.

impl<N> Eq for Output<N>

where N: Eq + Network,

impl<N> FromBytes for Output<N>

where N: Network,

fn read_le<R>(reader: R) -> Result<Output<N>, Error>

where R: Read,

Reads the output from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N> FromStr for Output<N>

where N: Network,

fn from_str(output: &str) -> Result<Output<N>, <Output<N> as FromStr>::Err>

Initializes the output from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> PartialEq for Output<N>

where N: PartialEq + Network,

fn eq(&self, other: &Output<N>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<N> Serialize for Output<N>

where N: Network,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serializes the transition output into string or bytes.

impl<N> StructuralPartialEq for Output<N>

where N: PartialEq + Network,

impl<N> ToBytes for Output<N>

where N: Network,

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

where W: Write,

Writes the output to a buffer.

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

where Self: Sized,

Returns self as a byte array in little-endian order.