Skip to content
Venus Protocol

VenusLens

VenusLens

Section titled “VenusLens”

Introduction

Section titled “Introduction”

The read only functions on the VenusLens contract provide a view into: - metadata of vToken - daily XVS rewards for an account - account balance for a single vToken - account balances for all vTokens in an account - underlying price of a vToken - underlying prices for a set of vTokens - get liquidity and shortfall of an account - get user’s vote history - get proposal details for a set of proposals - get account XVS balance, total votes, and delegated votes - get historical voting balance for a user - get pending XVS Rewards for an account

Solidity API

Section titled “Solidity API”

BLOCKS_PER_DAY

Section titled “BLOCKS_PER_DAY”

Blocks Per Day

uint256 BLOCKS_PER_DAY

VTOKEN_ACTIONS

Section titled “VTOKEN_ACTIONS”

Total actions available on VToken

uint256 VTOKEN_ACTIONS
struct VenusMarketState {
  uint224 index;
  uint32 block;
}
struct VTokenMetadata {
  address vToken;
  uint256 exchangeRateCurrent;
  uint256 supplyRatePerBlock;
  uint256 borrowRatePerBlock;
  uint256 reserveFactorMantissa;
  uint256 totalBorrows;
  uint256 totalReserves;
  uint256 totalSupply;
  uint256 totalCash;
  bool isListed;
  uint256 collateralFactorMantissa;
  address underlyingAssetAddress;
  uint256 vTokenDecimals;
  uint256 underlyingDecimals;
  uint256 venusSupplySpeed;
  uint256 venusBorrowSpeed;
  uint256 dailySupplyXvs;
  uint256 dailyBorrowXvs;
  uint256 pausedActions;
}
struct VTokenBalances {
  address vToken;
  uint256 balanceOf;
  uint256 borrowBalanceCurrent;
  uint256 balanceOfUnderlying;
  uint256 tokenBalance;
  uint256 tokenAllowance;
}
struct VTokenUnderlyingPrice {
  address vToken;
  uint256 underlyingPrice;
}
struct AccountLimits {
  contract VToken[] markets;
  uint256 liquidity;
  uint256 shortfall;
}
struct XVSBalanceMetadata {
  uint256 balance;
  uint256 votes;
  address delegate;
}
struct XVSBalanceMetadataExt {
  uint256 balance;
  uint256 votes;
  address delegate;
  uint256 allocated;
}
struct VenusVotes {
  uint256 blockNumber;
  uint256 votes;
}
struct ClaimVenusLocalVariables {
  uint256 totalRewards;
  uint224 borrowIndex;
  uint32 borrowBlock;
  uint224 supplyIndex;
  uint32 supplyBlock;
}
struct PendingReward {
  address vTokenAddress;
  uint256 amount;
}
struct RewardSummary {
  address distributorAddress;
  address rewardTokenAddress;
  uint256 totalRewards;
  struct VenusLens.PendingReward[] pendingRewards;
}

MarketData

Section titled “MarketData”

Holds full market information for a single vToken within a specific pool (excluding the Core Pool)

struct MarketData {
  uint96 poolId;
  string poolLabel;
  address vToken;
  bool isListed;
  uint256 collateralFactor;
  bool isVenus;
  uint256 liquidationThreshold;
  uint256 liquidationIncentive;
  bool isBorrowAllowed;
}

PoolWithMarkets

Section titled “PoolWithMarkets”

Struct representing a pool (excluding the Core Pool) and its associated markets

struct PoolWithMarkets {
  uint96 poolId;
  string label;
  struct VenusLens.MarketData[] markets;
}

vTokenMetadata

Section titled “vTokenMetadata”

Query the metadata of a vToken by its address

function vTokenMetadata(contract VToken vToken) public returns (struct VenusLens.VTokenMetadata)
Parameters
Section titled “Parameters”
NameTypeDescription
vTokencontract VTokenThe address of the vToken to fetch VTokenMetadata
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.VTokenMetadataVTokenMetadata struct with vToken supply and borrow information.

vTokenMetadataAll

Section titled “vTokenMetadataAll”

Get VTokenMetadata for an array of vToken addresses

function vTokenMetadataAll(contract VToken[] vTokens) external returns (struct VenusLens.VTokenMetadata[])
Parameters
Section titled “Parameters”
NameTypeDescription
vTokenscontract VToken[]Array of vToken addresses to fetch VTokenMetadata
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.VTokenMetadata[]Array of structs with vToken supply and borrow information.

getDailyXVS

Section titled “getDailyXVS”

Get amount of XVS distributed daily to an account

function getDailyXVS(address payable account, address comptrollerAddress) external returns (uint256)
Parameters
Section titled “Parameters”
NameTypeDescription
accountaddress payableAddress of account to fetch the daily XVS distribution
comptrollerAddressaddressAddress of the comptroller proxy
Return Values
Section titled “Return Values”
NameTypeDescription
[0]uint256Amount of XVS distributed daily to an account

vTokenBalances

Section titled “vTokenBalances”

Get the current vToken balance (outstanding borrows) for an account

function vTokenBalances(contract VToken vToken, address payable account) public returns (struct VenusLens.VTokenBalances)
Parameters
Section titled “Parameters”
NameTypeDescription
vTokencontract VTokenAddress of the token to check the balance of
accountaddress payableAccount address to fetch the balance of
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.VTokenBalancesVTokenBalances with token balance information

vTokenBalancesAll

Section titled “vTokenBalancesAll”

Get the current vToken balances (outstanding borrows) for all vTokens on an account

function vTokenBalancesAll(contract VToken[] vTokens, address payable account) external returns (struct VenusLens.VTokenBalances[])
Parameters
Section titled “Parameters”
NameTypeDescription
vTokenscontract VToken[]Addresses of the tokens to check the balance of
accountaddress payableAccount address to fetch the balance of
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.VTokenBalances[]VTokenBalances Array with token balance information

vTokenUnderlyingPrice

Section titled “vTokenUnderlyingPrice”

Get the price for the underlying asset of a vToken

function vTokenUnderlyingPrice(contract VToken vToken) public view returns (struct VenusLens.VTokenUnderlyingPrice)
Parameters
Section titled “Parameters”
NameTypeDescription
vTokencontract VTokenaddress of the vToken
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.VTokenUnderlyingPriceresponse struct with underlyingPrice info of vToken

vTokenUnderlyingPriceAll

Section titled “vTokenUnderlyingPriceAll”

Query the underlyingPrice of an array of vTokens

function vTokenUnderlyingPriceAll(contract VToken[] vTokens) external view returns (struct VenusLens.VTokenUnderlyingPrice[])
Parameters
Section titled “Parameters”
NameTypeDescription
vTokenscontract VToken[]Array of vToken addresses
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.VTokenUnderlyingPrice[]array of response structs with underlying price information of vTokens

getAccountLimits

Section titled “getAccountLimits”

Query the account liquidity and shortfall of an account

function getAccountLimits(contract ComptrollerInterface comptroller, address account) public view returns (struct VenusLens.AccountLimits)
Parameters
Section titled “Parameters”
NameTypeDescription
comptrollercontract ComptrollerInterfaceAddress of comptroller proxy
accountaddressAddress of the account to query
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.AccountLimitsStruct with markets user has entered, liquidity, and shortfall of the account

getXVSBalanceMetadata

Section titled “getXVSBalanceMetadata”

Query the XVSBalance info of an account

function getXVSBalanceMetadata(contract IXVS xvs, address account) external view returns (struct VenusLens.XVSBalanceMetadata)
Parameters
Section titled “Parameters”
NameTypeDescription
xvscontract IXVSXVS contract address
accountaddressAccount address
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.XVSBalanceMetadataStruct with XVS balance and voter details

getXVSBalanceMetadataExt

Section titled “getXVSBalanceMetadataExt”

Query the XVSBalance extended info of an account

function getXVSBalanceMetadataExt(contract IXVS xvs, contract ComptrollerInterface comptroller, address account) external returns (struct VenusLens.XVSBalanceMetadataExt)
Parameters
Section titled “Parameters”
NameTypeDescription
xvscontract IXVSXVS contract address
comptrollercontract ComptrollerInterfaceComptroller proxy contract address
accountaddressAccount address
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.XVSBalanceMetadataExtStruct with XVS balance and voter details and XVS allocation

getVenusVotes

Section titled “getVenusVotes”

Query the voting power for an account at a specific list of block numbers

function getVenusVotes(contract IXVS xvs, address account, uint32[] blockNumbers) external view returns (struct VenusLens.VenusVotes[])
Parameters
Section titled “Parameters”
NameTypeDescription
xvscontract IXVSXVS contract address
accountaddressAddress of the account
blockNumbersuint32[]Array of blocks to query
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.VenusVotes[]Array of VenusVotes structs with block number and vote count

pendingRewards

Section titled “pendingRewards”

Calculate the total XVS tokens pending and accrued by a user account

function pendingRewards(address holder, contract ComptrollerInterface comptroller) external view returns (struct VenusLens.RewardSummary)
Parameters
Section titled “Parameters”
NameTypeDescription
holderaddressAccount to query pending XVS
comptrollercontract ComptrollerInterfaceAddress of the comptroller
Return Values
Section titled “Return Values”
NameTypeDescription
[0]struct VenusLens.RewardSummaryReward object contraining the totalRewards and pending rewards for each market

getAllPoolsData

Section titled “getAllPoolsData”

Returns all pools (excluding the Core Pool) along with their associated market data

function getAllPoolsData(contract ComptrollerInterface comptroller) external view returns (struct VenusLens.PoolWithMarkets[] poolsData)
Parameters
Section titled “Parameters”
NameTypeDescription
comptrollercontract ComptrollerInterfaceThe Comptroller contract to query
Return Values
Section titled “Return Values”
NameTypeDescription
poolsDatastruct VenusLens.PoolWithMarkets[]An array of PoolWithMarkets structs, each containing pool info and its markets

getMarketsDataByPool

Section titled “getMarketsDataByPool”

Retrieves full market data for all vTokens in a specific pool (excluding the Core Pool)

function getMarketsDataByPool(uint96 poolId, contract ComptrollerInterface comptroller) public view returns (struct VenusLens.MarketData[] result)
Parameters
Section titled “Parameters”
NameTypeDescription
poolIduint96The pool ID to fetch data for
comptrollercontract ComptrollerInterfaceThe address of the Comptroller contract
Return Values
Section titled “Return Values”
NameTypeDescription
resultstruct VenusLens.MarketData[]An array of MarketData structs containing detailed market info for the given pool
❌ Errors
Section titled “❌ Errors”
  • PoolDoesNotExist Reverts if the given pool ID does not exist
  • InvalidOperationForCorePool Reverts if called on the Core Pool (poolId = 0)