www.asagaia.com
  • Welcome to Asagaia documentation!
  • 1xMM Project
    • Introduction
    • Mini-game
      • User Manual
        • Open a position
        • Reduce or Close a position
        • Position results
        • Profit and Loss computation
      • Bonuses
      • User Profile
      • Levels and Benefits
    • Perpetual Constant Maturity Option
    • API
      • 1XMM Token
        • Public Methods
          • Read
          • Write
        • Errors
      • 1xMM Pools
        • Public Methods
          • Read
    • The 1xMM Pool for 1XMM tokens
Powered by GitBook
On this page
  1. 1xMM Project
  2. API
  3. 1XMM Token
  4. Public Methods

Read

ApprovedTokens
ApprovedTokens() returns(address[])

Returns the list of tokens which can be exchanged against 1XMM, directly via the smart contract.

ETHDepositIsAllowed
ETHDepositIsAllowed() returns(bool)

Returns whether deposits of ETH against 1XMM is allowed or not.

ETHExchangeIsAllowed
ETHExchangeIsAllowed() returns(bool)

Returns whether it is allowed to exchange 1XMM tokens against ETH, directly via the smart contract.

EthExchangeRate
EthExchangeRate() returns(uint64)

Returns the exchange ETH/1XMM rate for users who want to convert their 1XMM tokens into ETH.

The rate is provided in basis points (bp)

allowance
allowance(address owner, address spender) returns(uint256)

Returns the allowance provided by owner to spender .

availableTokens
availableTokens() returns(uint256)

Returns the number of 1XMM tokens which have not been allocated yet.

availableTokens = cap() - totalSupply()

balanceOf
balanceOf(address account) returns(uint256)

Returns the number of 1XMM tokens held by account .

1XMM has 18 decimals

cap
cap() returns(uint256)

Returns the maximum number of tokens which can be allocated. When tokens are burnt, cap is decreased and can never be increased again.

decimals
decimals() returns(uint8)

Returns the number of decimals used by 1XMM tokens; decimals field is immutable and always equal to 18.

getApprovedTokens
getApprovedTokens returns(address[])

Returns the list of tokens which have been approved for exchange against 1XMM tokens.

getAvailableQuantityOfETH
getAvailableQuantityOfETH() returns(uint256)

Returns the amount of ETH which is available for exchange against 1XMM tokens, at ETHExchangeRate price.

getAvailableQuantityOfToken
getAvailableQuantityOfToken(address tokenToBeReceived) returns(uint256 availableQuantity)

Returns the amount of tokenToBeReceived which are available for exchange against 1XMM tokens, at rate price.

getCCIPAdmin
getCCIPAdmin() returns(address)

Returns the address of the ChainLink CCIPAdmin in charge of cross-chain transfers for 1XMM tokens.

getExchangeInfoForToken
getExchangeInfoForToken(address tokenToBeReceived) returns (bool isAllowed, uint64 rate)

Returns the exchange status for tokenToBeReceived against 1XMM tokens, and the rate of exchange. If isAllowed is false, exchange of tokenToBeReceived against 1XMM is not possible, even if a rate is indicated.

getReleasableAmount
getReleasableAmount() returns(uint256 releasableAmt)

Returns the amount of vested tokens owned by msg.sender which are available for trading.

getRemainingVestedAmount
getRemainingVestedAmount() returns(uint256 remainingVestedAmt)

Returns the amount of 1XMM tokens which are still vested.

isChainIdAllowed
isChainIdAllowed(uint64 chainId) returns(bool)

Returns whether a chainId is available for cross-chain transfer using Chain-Link protocol.

owner
owner() returns(address)

Returns the address of the 1XMM contract owner.

totalSupply
totalSupply() returns(uint256)

Returns the amount of 1XMM tokens which have been allocated.

PreviousPublic MethodsNextWrite

Last updated 2 days ago