Chainlink Price Provider
Chainlink price provider
Methods
DEFAULT_ADMIN_ROLE
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
DESCRIPTION
Returns
Name | Type | Description |
---|---|---|
_0 | string | undefined |
MODERATOR_ROLE
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
chainlinkMetadata
Parameters
Name | Type | Description |
---|---|---|
_0 | address | undefined |
Returns
Name | Type | Description |
---|---|---|
isActive | bool | undefined |
changeActive
Parameters
Name | Type | Description |
---|---|---|
token | address | undefined |
active | bool | undefined |
getEvaluation
returns the equivalent amount in USD
Parameters
Name | Type | Description |
---|---|---|
token | address | the address of token |
tokenAmount | uint256 | the amount of token |
Returns
Name | Type | Description |
---|---|---|
evaluation | uint256 | undefined |
getEvaluationSigned
return the evaluation in $ of tokenAmount
with signed price
Parameters
Name | Type | Description |
---|---|---|
token | address | the address of token to get evaluation in $ |
tokenAmount | uint256 | the amount of token to get evaluation. Amount is scaled by 10 in power token decimals |
priceMantissa | uint256 | the price multiplied by priceDecimals. The dimension of priceMantissa should be $/token |
validTo | uint256 | the timestamp in seconds, when price is gonna be not valid. |
signature | bytes | the ECDSA sign on eliptic curve secp256k1. |
Returns
Name | Type | Description |
---|---|---|
evaluation | uint256 | undefined |
getPrice
Returns the latest asset price mantissa and price decimals[price] = USD/token
First step is get priceMantissa with priceDecimals by this formula: price = 1 * 10 ** tokenDecimals * (chainlinkPrice_1 / 10 ** priceDecimals_1) * ... * (chainlinkPrice_n / 10 ** priceDecimals_n) = = 10 ** tokenDecimals (chainlinkPrice_1 * ... * chainlinkPrice_n) / 10 ** (priceDecimals_1 + ... + priceDecimals_n) Second step is scale priceMantissa to usdDecimals
Parameters
Name | Type | Description |
---|---|---|
token | address | the token address |
Returns
Name | Type | Description |
---|---|---|
priceMantissa | uint256 | undefined |
priceDecimals | uint8 | undefined |
getPriceDecimals
Returns
Name | Type | Description |
---|---|---|
_0 | uint8 | undefined |
getPriceSigned
Parameters
Name | Type | Description |
---|---|---|
token | address | undefined |
priceMantissa | uint256 | undefined |
validTo | uint256 | undefined |
signature | bytes | undefined |
Returns
Name | Type | Description |
---|---|---|
_priceMantissa | uint256 | undefined |
_priceDecimals | uint8 | undefined |
getRoleAdmin
Returns the admin role that controls role
. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bytes32 | undefined |
grandModerator
Parameters
Name | Type | Description |
---|---|---|
newModerator | address | undefined |
grantRole
Grants role
to account
. If account
had not been already granted role
, emits a {RoleGranted} event. Requirements: - the caller must have role
's admin role.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
hasRole
Returns true
if account
has been granted role
.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
initialize
isActive
Parameters
Name | Type | Description |
---|---|---|
token | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
isListed
Parameters
Name | Type | Description |
---|---|---|
token | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
renounceRole
Revokes role
from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been granted role
, emits a {RoleRevoked} event. Requirements: - the caller must be account
.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
revokeModerator
Parameters
Name | Type | Description |
---|---|---|
moderator | address | undefined |
revokeRole
Revokes role
from account
. If account
had been granted role
, emits a {RoleRevoked} event. Requirements: - the caller must have role
's admin role.
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
setTokenAndAggregator
Parameters
Name | Type | Description |
---|---|---|
token | address | undefined |
aggregatorPath | address[] | undefined |
supportsInterface
See {IERC165-supportsInterface}.
Parameters
Name | Type | Description |
---|---|---|
interfaceId | bytes4 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
usdDecimals
Returns
Name | Type | Description |
---|---|---|
_0 | uint8 | undefined |
Events
ChangeActive
Parameters
Name | Type | Description |
---|---|---|
who | address | undefined |
token | address | undefined |
active | bool | undefined |
GrandModeratorRole
Parameters
Name | Type | Description |
---|---|---|
who | address | undefined |
newModerator | address | undefined |
RevokeModeratorRole
Parameters
Name | Type | Description |
---|---|---|
who | address | undefined |
moderator | address | undefined |
RoleAdminChanged
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
previousAdminRole | bytes32 | undefined |
newAdminRole | bytes32 | undefined |
RoleGranted
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
sender | address | undefined |
RoleRevoked
Parameters
Name | Type | Description |
---|---|---|
role | bytes32 | undefined |
account | address | undefined |
sender | address | undefined |
SetTokenAndAggregator
Parameters
Name | Type | Description |
---|---|---|
who | address | undefined |
token | address | undefined |
aggeregatorPath | address[] | undefined |
Last updated