LPPriceProvider
Overview
License: MIT
The LPPriceProvider contract is the contract that provides the functionality of getting the latest price from Uniswap V2 LP tokens.
Contract that provides the functionality of getting the latest price from Uniswap V2 LP tokens. Inherit from PriceProvider.
Structs info
LPMetadata
Events info
SetLPTokenAndPriceProvider
Emitted when the LPToken and its corresponding price provider are set.
Parameters:
token
address
The address of the LPToken.
priceProvider
address
The address of the price provider contract.
ChangeActive
Emitted when the active status of a token changes.
Parameters:
token
address
The address of the token whose active status has changed.
active
bool
The new active status of the token.
SetTokenDecimals
Emitted when the token decimals is set.
Parameters:
newTokenDecimals
uint8
The new token decimals.
Constants info
MODERATOR_ROLE (0x797669c9)
State variables info
tokenDecimals (0x3b97e856)
lpMetadata (0x1e3214d8)
Modifiers info
onlyModerator
Modifier to restrict access to functions to only the contract's moderator.
Functions info
initialize (0x8129fc1c)
Initializes the LPPriceProvider contract by setting up the access control roles and the number of decimals for the USD price.
setTokenDecimals (0xf2cf47be)
Sets the number of decimals used by the token. Only the moderator can call this function.
Parameters:
newTokenDecimals
uint8
The new number of decimals used by the token.
setLPTokenAndProvider (0x98a0fb36)
Sets the LP token and price provider for the given LP token address.
Requirements:
lpToken
cannot be the zero address.provider
cannot be the zero address.
Parameters:
lpToken
address
The address of the LP token.
provider
address
The address of the price provider.
changeActive (0x258a4532)
Changes the active status of a token in the LPPriceProvider contract.
Requirements:
The token must be listed in the contract.
Only the contract moderator can call this function.
Parameters:
token
address
The address of the token to change the active status for.
active
bool
The new active status of the token.
isListed (0xf794062e)
Checks if a token is listed in the LPPriceProvider.
Parameters:
token
address
The address of the token to check.
Return values:
[0]
bool
A boolean indicating whether the token is listed or not.
isActive (0x9f8a13d7)
Returns whether a token is active or not.
Parameters:
token
address
The address of the token to check.
Return values:
[0]
bool
A boolean indicating whether the token is active or not.
getUSDPx (0x89378bc7)
Returns the value of the given input as ETH per unit, multiplied by 2**112.
Parameters:
lpToken
address
The address of the LP token.
Return values:
[0]
uint256
The USD price of the LP token in uint256 format.
getPrice (0x41976e09)
Returns the price of the given LP token in USD.
Parameters:
lpToken
address
The address of the LP token.
Return values:
priceMantissa
uint256
The price of the LP token in USD, represented as a mantissa.
priceDecimals
uint8
The number of decimals in the price of the LP token in USD.
getPriceDecimals (0x1b30aafc)
Returns the number of decimals used for the price provided by this contract.
Return values:
[0]
uint8
The number of decimals used for the price provided by this contract.
Last updated