Struct AssetAmount 

pub struct AssetAmount { /* private fields */ }

A validated fungible asset amount.

Values created through this type’s constructors, conversions, and arithmetic operations wrap a Felt whose canonical value is at most AssetAmount::MAX_U64. The API mirrors miden_protocol::asset::AssetAmount so that on-chain and off-chain code handle amounts the same way, while the felt representation avoids integer/felt conversions around the transaction kernel procedures.

Unlike a raw Felt, an amount only offers integer semantics: addition and subtraction panic on overflow and underflow instead of wrapping, and comparison follows the canonical integer value. Finite field arithmetic (wrapping at the field modulus, division via the multiplicative inverse) is intentionally unavailable; convert with AssetAmount::as_u64 when full integer functionality is needed.

Implementations

impl AssetAmount

pub const MAX_U64: u64

The maximum value an asset amount can represent, equal to 2^63 - 2^31.

Matches miden_protocol::asset::AssetAmount::MAX, which is chosen so that an amount fits in a field element as both a positive and a negative value.

pub const ZERO: Self

The zero amount.

pub fn max() -> Self

Returns the maximum representable asset amount, equal to Self::MAX_U64.

pub fn new(amount: u64) -> Result<Self, AssetAmountError>

Returns a new asset amount if amount does not exceed Self::MAX_U64.

Errors

Returns an error if amount is greater than Self::MAX_U64.

pub fn as_u64(&self) -> u64

Returns the amount as a u64 value.

pub fn as_felt(&self) -> Felt

Returns the amount as a raw Felt for advanced use.

Trait Implementations

impl Add for AssetAmount

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

Adds two asset amounts, staying in the field domain.

Panics

Panics if either operand or the sum exceeds AssetAmount::MAX_U64.

type Output = AssetAmount

The resulting type after applying the + operator.

impl Clone for AssetAmount

fn clone(&self) -> AssetAmount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AssetAmount

impl Debug for AssetAmount

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

Formats the value using the given formatter.

impl Default for AssetAmount

fn default() -> Self

Returns the “default value” for a type.

impl Display for AssetAmount

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

Formats the value using the given formatter.

impl Eq for AssetAmount

impl From<AssetAmount> for u64

fn from(amount: AssetAmount) -> Self

Converts to this type from the input type.

impl From<AssetAmount> for Felt

fn from(amount: AssetAmount) -> Self

Converts to this type from the input type.

impl From<u8> for AssetAmount

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<u16> for AssetAmount

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for AssetAmount

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for AssetAmount

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AssetAmount

fn cmp(&self, other: &AssetAmount) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for AssetAmount

fn eq(&self, other: &AssetAmount) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AssetAmount

fn partial_cmp(&self, other: &AssetAmount) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for AssetAmount

impl Sub for AssetAmount

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

Subtracts other from self, staying in the field domain.

Panics

Panics if either operand exceeds AssetAmount::MAX_U64 or if other is greater than self.

type Output = AssetAmount

The resulting type after applying the - operator.

impl TryFrom<Felt> for AssetAmount

type Error = AssetAmountError

The type returned in the event of a conversion error.

fn try_from(value: Felt) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for AssetAmount

type Error = AssetAmountError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.