Periphery
UiPoolDataProviderV3
Periphery
UiPoolDataProviderV3
Contract that returns an array of all reserve or user data for a particular market, used by the [HypurrFi Interface] to display Markets and Dashboard data.
The [HypurrFi Utilities SDK] includes an interface to make calls to this contract, and functions to format the response for frontend use-cases.
Data Structures
AggregatedReserveData
View fields of AggregatedReserveData defined at [Github].
UserReserveData
| Name | Type | Description |
|---|---|---|
| underlyingAsset | address | Address of the underlying asset supplied/borrowed |
| scaledATokenBalance | uint256 | scaled balance of hyToken |
| usageAsCollateralEnabledOnUser | bool | true if supplied asset is enabled to be used as collateral |
| stableBorrowRate | uint256 | Stable rate at which underlying asset is borrowed by the user. 0 ⇒ no debt |
| scaledVariableDebt | uint256 | scaled balance of vToken |
| principalStableDebt | uint256 | Principal amount borrowed at stable rate |
| stableBorrowLastUpdateTimestamp | uint256 | unix timestamp of last update on user’s stable borrow position. |
BaseCurrencyInfo
Info data struct for base currency of the HypurrFi protocol market.
| Name | Type | Description |
|---|---|---|
| marketReferenceCurrencyUnit | uint256 | Reference aka base currency of the HypurrFi market |
| marketReferenceCurrencyPriceInUsd | int256 | Price of reference aka base currency in USD |
| networkBaseTokenPriceInUsd | int256 | Price of native token of the network/chain in USD |
| networkBaseTokenPriceDecimals | uint8 | Decimals of native token of the network/chain |
Methods
getReservesList
function getReservesList(IPoolAddressesProvider provider)
Returns the list of initialised reserves in the Pool associated with the given [provider].
getReservesData
function getReservesData(IPoolAddressesProvider provider)
Returns BaseCurrencyInfo of the Pool and AggregatedReserveData[] for all the initialised reserves in the Pool associated with the given [provider].
getUserReservesData
function getUserReservesData(IPoolAddressesProvider provider, address user)
Returns UserReserveData[] for all user reserves in the Pool associated with the given [provider].
ABI
[
{
"inputs": [
{
"internalType": "contract IEACAggregatorProxy",
"name": "_networkBaseTokenPriceInUsdProxyAggregator",
"type": "address"
},
{
"internalType": "contract IEACAggregatorProxy",
"name": "_marketReferenceCurrencyPriceInUsdProxyAggregator",
"type": "address"
}
],
"stateMutability": "nonpayable",
"type": "constructor"
},
{
"inputs": [],
"name": "ETH_CURRENCY_UNIT",
"outputs": [
{
"internalType": "uint256",
"name": "",
"type": "uint256"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "MKR_ADDRESS",
"outputs": [
{
"internalType": "address",
"name": "",
"type": "address"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"internalType": "bytes32",
"name": "_bytes32",
"type": "bytes32"
}
],
"name": "bytes32ToString",
"outputs": [
{
"internalType": "string",
"name": "",
"type": "string"
}
],
"stateMutability": "pure",
"type": "function"
},
{
"inputs": [
{
"internalType": "contract IPoolAddressesProvider",
"name": "provider",
"type": "address"
}
],
"name": "getReservesData",
"outputs": [
{
"components": [
{
"internalType": "address",
"name": "underlyingAsset",
"type": "address"
},
{
"internalType": "string",
"name": "name",
"type": "string"
},
{
"internalType": "string",
"name": "symbol",
"type": "string"
},
{
"internalType": "uint256",
"name": "decimals",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "baseLTVasCollateral",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "reserveLiquidationThreshold",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "reserveLiquidationBonus",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "reserveFactor",
"type": "uint256"
},
{
"internalType": "bool",
"name": "usageAsCollateralEnabled",
"type": "bool"
},
{
"internalType": "bool",
"name": "borrowingEnabled",
"type": "bool"
},
{
"internalType": "bool",
"name": "stableBorrowRateEnabled",
"type": "bool"
},
{
"internalType": "bool",
"name": "isActive",
"type": "bool"
},
{
"internalType": "bool",
"name": "isFrozen",
"type": "bool"
},
{
"internalType": "uint128",
"name": "liquidityIndex",
"type": "uint128"
},
{
"internalType": "uint128",
"name": "variableBorrowIndex",
"type": "uint128"
},
{
"internalType": "uint128",
"name": "liquidityRate",
"type": "uint128"
},
{
"internalType": "uint128",
"name": "variableBorrowRate",
"type": "uint128"
},
{
"internalType": "uint128",
"name": "stableBorrowRate",
"type": "uint128"
},
{
"internalType": "uint40",
"name": "lastUpdateTimestamp",
"type": "uint40"
},
{
"internalType": "address",
"name": "aTokenAddress",
"type": "address"
},
{
"internalType": "address",
"name": "stableDebtTokenAddress",
"type": "address"
},
{
"internalType": "address",
"name": "variableDebtTokenAddress",
"type": "address"
},
{
"internalType": "address",
"name": "interestRateStrategyAddress",
"type": "address"
},
{
"internalType": "uint256",
"name": "availableLiquidity",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "totalPrincipalStableDebt",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "averageStableRate",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "stableDebtLastUpdateTimestamp",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "totalScaledVariableDebt",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "priceInMarketReferenceCurrency",
"type": "uint256"
},
{
"internalType": "address",
"name": "priceOracle",
"type": "address"
},
{
"internalType": "uint256",
"name": "variableRateSlope1",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "variableRateSlope2",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "stableRateSlope1",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "stableRateSlope2",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "baseStableBorrowRate",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "baseVariableBorrowRate",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "optimalUsageRatio",
"type": "uint256"
},
{
"internalType": "bool",
"name": "isPaused",
"type": "bool"
},
{
"internalType": "bool",
"name": "isSiloedBorrowing",
"type": "bool"
},
{
"internalType": "uint128",
"name": "accruedToTreasury",
"type": "uint128"
},
{
"internalType": "uint128",
"name": "unbacked",
"type": "uint128"
},
{
"internalType": "uint128",
"name": "isolationModeTotalDebt",
"type": "uint128"
},
{
"internalType": "uint256",
"name": "debtCeiling",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "debtCeilingDecimals",
"type": "uint256"
},
{
"internalType": "uint8",
"name": "eModeCategoryId",
"type": "uint8"
},
{
"internalType": "uint256",
"name": "borrowCap",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "supplyCap",
"type": "uint256"
},
{
"internalType": "uint16",
"name": "eModeLtv",
"type": "uint16"
},
{
"internalType": "uint16",
"name": "eModeLiquidationThreshold",
"type": "uint16"
},
{
"internalType": "uint16",
"name": "eModeLiquidationBonus",
"type": "uint16"
},
{
"internalType": "address",
"name": "eModePriceSource",
"type": "address"
},
{
"internalType": "string",
"name": "eModeLabel",
"type": "string"
},
{
"internalType": "bool",
"name": "borrowableInIsolation",
"type": "bool"
}
],
"internalType": "struct IUiPoolDataProviderV3.AggregatedReserveData[]",
"name": "",
"type": "tuple[]"
},
{
"components": [
{
"internalType": "uint256",
"name": "marketReferenceCurrencyUnit",
"type": "uint256"
},
{
"internalType": "int256",
"name": "marketReferenceCurrencyPriceInUsd",
"type": "int256"
},
{
"internalType": "int256",
"name": "networkBaseTokenPriceInUsd",
"type": "int256"
},
{
"internalType": "uint8",
"name": "networkBaseTokenPriceDecimals",
"type": "uint8"
}
],
"internalType": "struct IUiPoolDataProviderV3.BaseCurrencyInfo",
"name": "",
"type": "tuple"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"internalType": "contract IPoolAddressesProvider",
"name": "provider",
"type": "address"
}
],
"name": "getReservesList",
"outputs": [
{
"internalType": "address[]",
"name": "",
"type": "address[]"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [
{
"internalType": "contract IPoolAddressesProvider",
"name": "provider",
"type": "address"
},
{
"internalType": "address",
"name": "user",
"type": "address"
}
],
"name": "getUserReservesData",
"outputs": [
{
"components": [
{
"internalType": "address",
"name": "underlyingAsset",
"type": "address"
},
{
"internalType": "uint256",
"name": "scaledATokenBalance",
"type": "uint256"
},
{
"internalType": "bool",
"name": "usageAsCollateralEnabledOnUser",
"type": "bool"
},
{
"internalType": "uint256",
"name": "stableBorrowRate",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "scaledVariableDebt",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "principalStableDebt",
"type": "uint256"
},
{
"internalType": "uint256",
"name": "stableBorrowLastUpdateTimestamp",
"type": "uint256"
}
],
"internalType": "struct IUiPoolDataProviderV3.UserReserveData[]",
"name": "",
"type": "tuple[]"
},
{
"internalType": "uint8",
"name": "",
"type": "uint8"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "marketReferenceCurrencyPriceInUsdProxyAggregator",
"outputs": [
{
"internalType": "contract IEACAggregatorProxy",
"name": "",
"type": "address"
}
],
"stateMutability": "view",
"type": "function"
},
{
"inputs": [],
"name": "networkBaseTokenPriceInUsdProxyAggregator",
"outputs": [
{
"internalType": "contract IEACAggregatorProxy",
"name": "",
"type": "address"
}
],
"stateMutability": "view",
"type": "function"
}
]