Struct Fee

pub struct Fee<N: Network> { /* private fields */ }

Implementations

impl<N: Network> Fee<N>

pub fn from( transition: Transition<N>, global_state_root: N::StateRoot, proof: Option<Proof<N>>, ) -> Result<Self>

Initializes a new Fee instance with the given transition, global state root, and proof.

pub const fn from_unchecked( transition: Transition<N>, global_state_root: N::StateRoot, proof: Option<Proof<N>>, ) -> Self

Initializes a new Fee instance with the given transition, global state root, and proof.

impl<N: Network> Fee<N>

pub fn is_fee_private(&self) -> bool

Returns true if this is a fee_private transition.

pub fn is_fee_public(&self) -> bool

Returns true if this is a fee_public transition.

impl<N: Network> Fee<N>

pub fn is_zero(&self) -> Result<bool>

Returns ‘true’ if the fee amount is zero.

pub fn payer(&self) -> Option<Address<N>>

Returns the payer, if the fee is public.

pub fn amount(&self) -> Result<U64<N>>

Returns the amount (in microcredits).

pub fn base_amount(&self) -> Result<U64<N>>

Returns the base amount (in microcredits).

pub fn priority_amount(&self) -> Result<U64<N>>

Returns the base amount (in microcredits).

pub fn deployment_or_execution_id(&self) -> Result<Field<N>>

Returns the deployment or execution ID.

pub fn num_finalize_operations(&self) -> usize

Returns the number of finalize operations.

pub fn transition_id(&self) -> &N::TransitionID

Returns the transition ID.

pub const fn transition(&self) -> &Transition<N>

Returns the transition.

pub fn into_transition(self) -> Transition<N>

Returns the transition, consuming self in the process.

pub const fn global_state_root(&self) -> N::StateRoot

Returns the global state root.

pub const fn proof(&self) -> Option<&Proof<N>>

Returns the proof.

Methods from Deref<Target = Transition<N>>

pub fn to_root(&self) -> Result<Field<N>>

Returns the transition root, by computing the root for a Merkle tree of the input and output IDs.

pub fn to_path(&self, leaf: &TransitionLeaf<N>) -> Result<TransitionPath<N>>

Returns the Merkle path for the transition leaf.

pub fn to_leaf( &self, id: &Field<N>, is_input: bool, ) -> Result<TransitionLeaf<N>>

Returns the Merkle leaf for the given input or output ID in the transition.

pub fn to_tree(&self) -> Result<TransitionTree<N>>

The Merkle tree of input and output IDs for the transition.

pub fn id(&self) -> &N::TransitionID

Returns the transition ID.

pub fn program_id(&self) -> &ProgramID<N>

Returns the program ID.

pub fn function_name(&self) -> &Identifier<N>

Returns the function name.

pub fn inputs(&self) -> &[Input<N>]

Returns the inputs.

pub fn outputs(&self) -> &[Output<N>]

Return the outputs.

pub fn tpk(&self) -> &Group<N>

Returns the transition public key.

pub fn tcm(&self) -> &Field<N>

Returns the transition commitment.

pub fn scm(&self) -> &Field<N>

Returns the signer commitment.

pub fn is_bond_public(&self) -> bool

Returns true if this is a bond_public transition.

pub fn is_bond_validator(&self) -> bool

Returns true if this is a bond_validator transition.

pub fn is_unbond_public(&self) -> bool

Returns true if this is an unbond_public transition.

pub fn is_fee_private(&self) -> bool

Returns true if this is a fee_private transition.

pub fn is_fee_public(&self) -> bool

Returns true if this is a fee_public transition.

pub fn is_split(&self) -> bool

Returns true if this is a split transition.

pub fn contains_serial_number(&self, serial_number: &Field<N>) -> bool

Returns true if the transition contains the given serial number.

pub fn contains_commitment(&self, commitment: &Field<N>) -> bool

Returns true if the transition contains the given commitment.

pub fn find_record( &self, commitment: &Field<N>, ) -> Option<&Record<N, Ciphertext<N>>>

Returns the record with the corresponding commitment, if it exists.

pub fn input_ids(&self) -> impl '_ + ExactSizeIterator<Item = &Field<N>>

Returns the input IDs.

pub fn serial_numbers(&self) -> impl '_ + Iterator<Item = &Field<N>>

Returns an iterator over the serial numbers, for inputs that are records.

pub fn tags(&self) -> impl '_ + Iterator<Item = &Field<N>>

Returns an iterator over the tags, for inputs that are records.

pub fn output_ids(&self) -> impl '_ + ExactSizeIterator<Item = &Field<N>>

Returns the output IDs.

pub fn commitments(&self) -> impl '_ + Iterator<Item = &Field<N>>

Returns an iterator over the commitments, for outputs that are records.

pub fn nonces(&self) -> impl '_ + Iterator<Item = &Group<N>>

Returns an iterator over the nonces, for outputs that are records.

pub fn records( &self, ) -> impl '_ + Iterator<Item = (&Field<N>, &Record<N, Ciphertext<N>>)>

Returns an iterator over the output records, as a tuple of (commitment, record).

Trait Implementations

impl<N: Clone + Network> Clone for Fee<N>

where N::StateRoot: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for Fee<N>

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

Prints the fee as a JSON-string.

impl<N: Network> Deref for Fee<N>

type Target = Transition<N>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, N: Network> Deserialize<'de> for Fee<N>

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

Deserializes the fee from a string or bytes.

impl<N: Network> Display for Fee<N>

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

Displays the fee as a JSON-string.

impl<N: Network> FromBytes for Fee<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the fee 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.

impl<N: Network> FromStr for Fee<N>

fn from_str(fee: &str) -> Result<Self, Self::Err>

Initializes the fee from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N: PartialEq + Network> PartialEq for Fee<N>

where N::StateRoot: PartialEq,

fn eq(&self, other: &Fee<N>) -> 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<N: Network> Serialize for Fee<N>

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

Serializes the fee into string or bytes.

impl<N: Network> ToBytes for Fee<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the fee 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.

impl<N: Eq + Network> Eq for Fee<N>

where N::StateRoot: Eq,

impl<N: Network> StructuralPartialEq for Fee<N>