eth-prices 0.0.3

A library for fetching Ethereum prices.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Token metadata and identifier helpers.

use crate::Result;
use alloy::{
    primitives::{Address, U256},
    providers::DynProvider,
};

use crate::token::erc20::ERC20;

pub mod erc20;
pub mod identity;

pub use identity::TokenIdentifier;

/// A resolved asset with display metadata and decimal precision.
#[derive(Debug, Clone, PartialEq)]
pub struct Token {
    /// Canonical identifier for the asset.
    pub identifier: TokenIdentifier,
    /// Human-readable asset name.
    pub name: String,
    /// Short symbol used for display.
    pub symbol: String,
    /// Number of decimal places used by on-chain amounts.
    pub decimals: u8,
}

const FIAT_DECIMALS: u8 = 6;

impl Token {
    /// Resolves token metadata for the provided identifier.
    ///
    /// ERC-20 metadata is loaded from chain, while fiat and native assets use local defaults.
    pub async fn new(identifier: TokenIdentifier, provider: &DynProvider) -> Result<Self> {
        let (name, symbol, decimals) = match &identifier {
            TokenIdentifier::ERC20 { address } => {
                let erc20 = ERC20::new(*address, provider);

                (
                    erc20.name().call().await?,
                    erc20.symbol().call().await?,
                    erc20.decimals().call().await?,
                )
            }
            TokenIdentifier::Fiat { symbol } => (symbol.clone(), symbol.clone(), FIAT_DECIMALS),
            TokenIdentifier::Native => ("Native".to_string(), "ETH".to_string(), 18),
        };

        Ok(Self {
            identifier,
            name,
            symbol,
            decimals,
        })
    }

    /// Returns one nominal unit for this token in base precision.
    pub async fn nominal_amount(&self) -> U256 {
        U256::from(10).pow(U256::from(self.decimals))
    }

    /// Formats a raw integer amount into a human-readable decimal string.
    pub fn format_amount(&self, amount: U256, precision: usize) -> crate::Result<String> {
        let amount = amount
            .to_string()
            .parse::<f64>()
            .map_err(|e| crate::error::EthPricesError::InvalidTokenAmount(e.to_string()))?;
        let amount = amount / 10_f64.powf(self.decimals as f64);
        Ok(format!("{:.precision$}", amount))
    }

    /// Returns the ERC-20 contract address.
    ///
    /// Returns the underlying contract address, if applicable.
    pub fn address(&self) -> Option<Address> {
        match &self.identifier {
            TokenIdentifier::ERC20 { address } => Some(*address),
            TokenIdentifier::Fiat { .. } => None,
            TokenIdentifier::Native => None,
        }
    }
}