Struct TokenAmount 

pub struct TokenAmount(/* private fields */);

Raw token amount (not normalized for decimals)

This represents the raw token amount as stored on-chain in the smallest unit (e.g., wei for ETH, satoshis for WBTC). To convert to human-readable amounts, use normalize with the token’s TokenDecimals.

Examples

use alloy_primitives::U256;
use semioscan::{TokenAmount, TokenDecimals};

// 1.5 ETH in wei (18 decimals)
let amount = TokenAmount::new(U256::from(1_500_000_000_000_000_000u64));
let normalized = amount.normalize(TokenDecimals::STANDARD);
assert!((normalized.as_f64() - 1.5).abs() < 0.0001);

Implementations

impl TokenAmount

pub const ZERO: Self

Zero token amount

pub const fn new(amount: U256) -> Self

Create a new token amount from U256

pub const fn as_u256(&self) -> U256

Get the inner U256 value

pub fn normalize(&self, decimals: TokenDecimals) -> NormalizedAmount

Normalize by token decimals: amount / 10^decimals

Converts raw token amount to human-readable decimal form.

Examples

use alloy_primitives::U256;
use semioscan::{TokenAmount, TokenDecimals};

// 100 USDC (6 decimals)
let raw = TokenAmount::new(U256::from(100_000_000u64));
let normalized = raw.normalize(TokenDecimals::USDC);
assert_eq!(normalized.as_f64(), 100.0);

Trait Implementations

impl Add for TokenAmount

type Output = TokenAmount

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Clone for TokenAmount

fn clone(&self) -> TokenAmount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenAmount

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokenAmount

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TokenAmount

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

Formats the value using the given formatter.

impl From<Uint<256, 4>> for TokenAmount

fn from(value: U256) -> Self

Converts to this type from the input type.

impl From<u64> for TokenAmount

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Ord for TokenAmount

fn cmp(&self, other: &TokenAmount) -> 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.

impl PartialEq for TokenAmount

fn eq(&self, other: &TokenAmount) -> 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 PartialOrd for TokenAmount

fn partial_cmp(&self, other: &TokenAmount) -> 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 Serialize for TokenAmount

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TokenAmount

impl Eq for TokenAmount

impl StructuralPartialEq for TokenAmount