V3 Technical Docs
  • Deployed Contracts
    • Notional V3
      • Ethereum Mainnet
      • Arbitrum
  • Security
    • Audits
    • Bug Bounty
  • Currency Ids & Precision
    • Currency Ids
    • Market Indexes
    • Notional Internal Precision
  • Contract interaction guides
    • Intro
    • Trading guide
      • Deposit (Prime Lend)
      • Trade fCash (Borrow & Lend Fixed)
      • Add liquidity (Mint nTokens)
      • Withdraw liquidity (Redeem nTokens)
      • Withdraw (Prime Cash)
      • Settle Account
      • Enter Leveraged Vaults
      • Exit Leveraged Vaults
    • Accounts
    • Prime Cash Markets
    • fCash Markets
    • nTokens
    • Leveraged Vaults
    • Oracles
    • Governance parameters
  • Subgraph guides
    • Notional V3 Subgraphs
      • Fetch Notional Accounts
      • Fetch Notional's reserves
      • Fetch Notional nToken accounts
      • Fetch Historical Trades
      • Fetch an Account's P&L
      • Fetch current fCash and Prime Cash Rates
      • Fetch Historical Prime Cash & Prime Debt Exchange Rates
      • Fetch Prime Cash Market Balances
      • Fetch fCash Market Balances
      • Fetch Outstanding Debt
      • Fetch Historical nToken Exchange Rates
      • Fetch ETH Oracle Exchange Rates
      • Fetch Annual Incentive Rates
      • Fetch Interest Rate Models
      • Fetch Governance Parameters
  • Dune Dashboard
  • Notional Risk Docs
  • Notional V3 Docs
  • Notional Blog
Powered by GitBook
On this page
  • Get nToken Address
  • Get nToken Total Supply
  • Get nToken PV
  • Get the underlying value of one nToken
  • Get nToken Portfolio
  • nToken Annual Incentive Rate
  1. Contract interaction guides

nTokens

Get nToken Address

nTokenAddress = notional.nTokenAddress(currencyId)

Get nToken Total Supply

nTokenSupply = notional.nTokenTotalSupply(nTokenAddress)

Get nToken PV

nTokenPV = notional.nTokenPresentValueUnderlyingDenominated(currencyId)

Get the underlying value of one nToken

nTokenValue = nTokenPV / nTokenSupply

Get nToken Portfolio

An nToken portfolio can hold multiple positions (Prime Cash, fCash, Liquitity tokens):

nTokenPrimeCashBalance = notional.getNTokenAccount(nTokenAddress)["cashBalance"]
nTokenFCashPortfolio  = notional.getNTokenPortfolio(nTokenAddress)["netfCashAssets"]
nToken3MFCashMaturity = notional.getNTokenPortfolio(nTokenAddress)["netfCashAssets"][0][1]
nToken3MFCashBalance = notional.getNTokenPortfolio(nTokenAddress)["netfCashAssets"][0][3]

nTokenLiquidityTokenPortfolio = notional.getNTokenPortfolio(nTokenAddress)["liquidityTokens"]
nToken3MLiquidityTokenMaturity = notional.getNTokenPortfolio(nTokenAddress)["liquidityTokens"][0][1]
nToken3MLiquidityTokenBalance = notional.getNTokenPortfolio(nTokenAddress)["liquidityTokens"][0][3]

nToken Annual Incentive Rate

The nToken annual incentive rate defines the number of NOTE tokens that are given as incentives annually to nToken holders:

incentiveAnnualRate = notional.getNTokenAccount(nTokenAddress)["incentiveAnnualEmissionRate"]
PreviousfCash MarketsNextLeveraged Vaults

Last updated 11 months ago