Struct TokenAmount 

pub struct TokenAmount {
    pub amount: TokenAmountAmount,
    pub decimals: i64,
}

Amount of a given token.

JSON schema

{
 "description": "Amount of a given token.",
 "examples": [
   {
     "amount": "125000000000000000000",
     "decimals": 18
   }
 ],
 "type": "object",
 "required": [
   "amount",
   "decimals"
 ],
 "properties": {
   "amount": {
     "description": "The amount is denominated in the smallest indivisible unit of the token. For ETH, the smallest indivisible unit is Wei (10^-18 ETH). For ERC-20s, the smallest unit is the unit returned from `function totalSupply() public view returns (uint256)`.",
     "examples": [
       "1250000000000000000"
     ],
     "type": "string",
     "pattern": "^[0-9]+$"
   },
   "decimals": {
     "description": "'decimals' is the exponential value N that satisfies the equation `amount * 10^-N = standard_denomination`. The standard denomination is the most commonly used denomination for the token.\n- In the case of the native gas token, `decimals` is defined via convention. As an example, for ETH of Ethereum mainnet, the standard denomination is 10^-18 the smallest denomination (Wei). As such, for ETH on Ethereum mainnet, `decimals` is 18. - In the case of ERC-20 tokens, `decimals` is defined via configuration. `decimals` will be the number returned by `function decimals() public view returns (uint8)` on the underlying token contract.\nNot all tokens have a `decimals` field, as this function is [optional in the ERC-20 specification](https://eips.ethereum.org/EIPS/eip-20#decimals). This field will be left empty if the underlying token contract doesn't implement `decimals`.\nFurther, this endpoint will only populate this value for a small subset of whitelisted ERC-20 tokens at this time. We intend to improve coverage in the future.",
     "examples": [
       18
     ],
     "type": "integer",
     "format": "int64"
   }
 }
}

Fields

amount: TokenAmountAmount

The amount is denominated in the smallest indivisible unit of the token. For ETH, the smallest indivisible unit is Wei (10^-18 ETH). For ERC-20s, the smallest unit is the unit returned from function totalSupply() public view returns (uint256).

decimals: i64

‘decimals’ is the exponential value N that satisfies the equation amount * 10^-N = standard_denomination. The standard denomination is the most commonly used denomination for the token. - In the case of the native gas token, decimals is defined via convention. As an example, for ETH of Ethereum mainnet, the standard denomination is 10^-18 the smallest denomination (Wei). As such, for ETH on Ethereum mainnet, decimals is 18. - In the case of ERC-20 tokens, decimals is defined via configuration. decimals will be the number returned by function decimals() public view returns (uint8) on the underlying token contract. Not all tokens have a decimals field, as this function is optional in the ERC-20 specification. This field will be left empty if the underlying token contract doesn’t implement decimals. Further, this endpoint will only populate this value for a small subset of whitelisted ERC-20 tokens at this time. We intend to improve coverage in the future.

Implementations

impl TokenAmount

pub fn builder() -> TokenAmount

Trait Implementations

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 From<&TokenAmount> for TokenAmount

fn from(value: &TokenAmount) -> Self

Converts to this type from the input type.

impl From<TokenAmount> for TokenAmount

fn from(value: TokenAmount) -> Self

Converts to this type from the input type.

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 TryFrom<TokenAmount> for TokenAmount

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: TokenAmount) -> Result<Self, ConversionError>

Performs the conversion.