Tradegen
  • Introduction
  • Tradegen Platform
    • Use Cases
    • Supported Assets
    • Supported Projects
    • Pools
    • NFT Pools
    • Marketplace
  • Tutorial
    • Investing in a Pool
    • Withdrawing From a Pool
    • Creating a Pool
    • Managing a Pool
    • Investing in an NFT Pool
    • Withdrawing From an NFT Pool
    • Creating an NFT Pool
  • Token Info
    • Introduction
    • Allocation
  • SDK
    • Getting Started
    • Entities
      • Price
      • TokenAmount
      • Percent
      • Fraction
      • Token
      • Pool
    • Fetcher
    • Other Exports
  • Technical
    • Implementation
    • Synthetic Trading Bots
    • Mining System
    • Trading Strategies
  • Contracts
    • Asset Management V1
    • Data Feeds
      • Protocol
      • Candlestick Data Feeds
        • 1-Minute Timeframe
        • 5-Minute Timeframe
        • 1-Hour Timeframe
        • 1-Day Timeframe
    • Tradegen Token
    • Algo Trading
      • Core Contracts
      • Indicators
      • Comparators
      • Component IDs
      • Initial Instances and Keepers
    • Asset Management V2
      • Core Contracts
      • Price Calculators
      • Adapters
      • Asset Verifiers
      • Contract Verifiers
    • Virtual Trading Environments
    • Farming System
    • Synthetic Trading Bots
  • Resources
    • Roadmap
    • Equations
    • Protocol Settings
    • Changelog
      • Pre-launch
      • Phase 1
      • Phase 2
    • Links
    • Github
    • Analytics
    • Whitepaper
  • Deprecated
    • Pools
      • Investing in Pools
      • Farming
      • Creating a Pool
      • Managing a Pool
      • System Architecture
    • Strategies
      • Investing in Strategies
      • Claiming Yield
      • Running Backtests
      • Strategy Approval
        • Voting for a Strategy
        • Submitting a Strategy
      • Trading LP Tokens
      • Building a Strategy
      • System Architecture
    • Components
      • Components Marketplace
      • Building Custom Components
      • Submitting Custom Components
Powered by GitBook
On this page
  • Example
  • Properties
  • Methods

Was this helpful?

  1. SDK
  2. Entities

TokenAmount

Responsible for formatting token amounts with specific decimal places. Derived from Fraction entity.

Example

import { Token, TokenAmount } from '@tradegen/sdk'

const token = new Token(ChainId.ALFAJORES, '0x0000000000000000000000000000000000000001', 18, 'XIAO', 'Mao')

const tokenAmount = new TokenAmount(token, '3000000000000000000')
console.log(tokenAmount.toExact()) // 3

Properties

  • token: Instance of Token entity represented by this instance of TokenAmount

Methods

raw

Returns the full token amount, unadjusted for decimals.

raw(): JSBI

toSignificant

toSignificant(
    significantDigits: number = 6,
    format?: object,
    rounding: Rounding = Rounding.ROUND_DOWN
  ): string

toFixed

toFixed(
    decimalPlaces: number = this.currency.decimals,
    format?: object,
    rounding: Rounding = Rounding.ROUND_DOWN
  ): string

toExact

toExact(format: object = { groupSeparator: '' }): string

add

add(other: TokenAmount): TokenAmount

subtract

subtract(other: TokenAmount): TokenAmount
PreviousPriceNextPercent

Last updated 3 years ago

Was this helpful?