The Pool.sol contract is the main user facing contract of the protocol. It exposes the liquidity management methods that can be invoked using either Solidity or Web3 libraries.

Write Methods

supply

function supply(address asset, uint256 amount, address onBehalfOf, uint16 referralCode)

The referralCode is emitted in Supply event and can be for third party referral integrations. To activate referral feature and obtain a unique referral code, integrators need to submit proposal to HypurrFi Governance.

When supplying, the Pool contract must have**allowance()to spend funds on behalf ofmsg.sender** for at-least**amount** for the asset being supplied. This can be done via the standard ERC20 approve()method on the underlying token contract.

Referral supply is currently inactive, you can pass 0 as referralCode. This program may be activated in the future through a HypurrFi governance proposal.

Param NameTypeDescription
assetaddressaddress of the asset being supplied to the pool.
amountuint256amount of asset being supplied.
onBehalfOfaddress

address that will receive the corresponding hyTokens.

Note: only the onBehalfOf address will be able to withdraw asset from the pool.

referralCodeuint16unique code for 3rd party referral program integration. Use 0 for no referral.

supplyWithPermit

function supplyWithPermit(address asset, uint256 amount, address onBehalfOf, uint16 referralCode, uint256 deadline, uint8 permitV, permitR, bytes32 permitS)

Supply with transfer approval of supplied asset via permit function. This method removes the need for separate approval tx before supplying asset to the pool.

Permit signature must be signed by msg.sender with spender as Pool address.

Referral program is currently inactive, you can pass 0 as referralCode. This program may be activated in the future.

Call Params

NameTypeDescription
assetaddressAddress of underlying asset being supplied. Same asset as used in permit s,v,r
amountuint256Amount of asset to be supplied and signed for approval. Same amount as used in permit s,v,r
onBehalfOfaddressAddress that will receive the hyTokens.
referralCodeuint16

unique code for 3rd party referral program integration.

Use 0 for no referral.

deadlineuint256unix timestamp up-till which signature will be valid
permitVuint8Signature parameter v
permitRbytes32Signature parameter r
permitSbytes32Signature parameter s

withdraw

function withdraw(address asset, uint256 amount, address to)

Withdraws amount of the underlying asset, i.e. redeems the underlying token and burns the hyTokens.

If user has any existing debt backed by the underlying token, then the max amount available to withdraw is the amount that will not leave user health factor < 1 after withdrawal.

When withdrawingtoanother address, msg.sendershould have hyTokenthat will be burned by Pool.

Call Params

NameTypeDescription
assetaddressaddress of the underlying asset, not the hyToken
amountuint256amount deposited, expressed in wei units. Use type(uint).max to withdraw the entire balance.
toaddressaddress that will receive the asset

borrow

function borrow(address asset, uint256 amount, uint256 interestRateMode, uint16 referralCode, address onBehalfOf)

Borrows amount of asset with interestRateMode, sending the amount to msg.sender, with the debt being incurred by onBehalfOf.

Note: If onBehalfOf is not same as msg.sender, then onBehalfOf must have supplied enough collateral via supply() and have delegated credit to msg.sender via approveDelegation().

Referral program is currently inactive, you can pass 0 as referralCode. This program may be activated in the future through a HypurrFi governance proposal.

Call Params

NameTypeDescription
assetaddressaddress of the underlying asset
amountuint256amount to be borrowed, expressed in wei units
interestRateModeuint256

the type of borrow debt.

Stable: 1, Variable: 2

referralCodeuint16referral code for our referral program. Use 0 for no referral code.
onBehalfOfaddress

address of user who will incur the debt.

Use msg.sender when not calling on behalf of a different user.

repay

function repay(address asset, uint256 amount, uint256 rateMode, address onBehalfOf)

Repays onBehalfOf’s debt amount of asset which has a rateMode.

When repaying, the Pool contract must have**allowance()to spend funds on behalf ofmsg.sender** for at-least**amount** for the asset you are repaying with. This can be done via the standard ERC20 approve()method on the underlying token contract.

Referral program is currently inactive, you can pass 0 as referralCode. This program may be activated in the future through a HypurrFi governance proposal.

Call Params

NameTypeDescription
assetaddressaddress of the underlying asset
amountuint256

Amount of underlying asset being repaid.
Use uint(-1) to repay the entire debt, ONLY when the repayment is not executed on behalf of a 3rd party.
In case of repayments on behalf of another user, it’s recommended to send an _amount slightly higher than the current borrowed amount.

rateModeuint256

the type of debt being repaid.
Stable: 1, Variable: 2

onBehalfOfaddress

address of user who will incur the debt.
Use msg.sender when not calling on behalf of a different user.

repayWithPermit

function repayWithPermit(address asset, uint256 amount, uint256 interestRateMode, address onBehalfOf, uint256 deadline, uint8 permitV, permitR, bytes32 permitS)

Repay with transfer approval of borrowed asset via permit function. This method removes the need for separate approval tx before repaying asset to the pool.

Permit signature must be signed by msg.sender with spender value as Pool address.

Call Params

NameTypeDescription
assetaddressAddress of underlying asset being supplied. Same asset as used in permit s,v,r
amountuint256Amount of asset to be supplied and signed for approval. Same amount as used in permit s,v,r
interestRateModeuint256

the type of debt being repaid.
Stable: 1, Variable: 2

onBehalfOfaddressAddress that will receive the hyTokens.
deadlineuint256unix timestamp up-till which signature will be valid
permitVuint8Signature parameter v
permitRbytes32Signature parameter r
permitSbytes32Signature parameter s

repayWithATokens

function repayWithATokens(address asset,uint256 amount,uint256 interestRateMode)

Allows user to repay with hyTokens of the underlying debt asset without any approvals eg. Pay USDC debt using aUSDC tokens.

Call Params

Param NameTypeDescription
assetaddressAddress of the underlying asset to be repaid
amountuint256

Amount of underlying asset being repaid.
Use uint256(-1) to pay without leaving hyToken dust

interestRateModeuint256

Interest rate mode of the debt position
1 - stable
2 - variable

swapBorrowRateMode

function swapBorrowRateMode(address asset, uint256 rateMode)

Swaps msg.sender’s borrow rate mode between stable and variable.

Call Params

NameTypeDescription
assetaddressaddress of the underlying asset
rateModeuint256

the rate mode the user is swapping from.
Stable: 1, Variable: 2

rebalanceStableBorrowRate

function rebalanceStableBorrowRate(address asset, address user)

Rebalances stable borrow rate of the user for given asset. In case of liquidity crunches on the protocol, stable rate borrows might need to be rebalanced to bring back equilibrium between the borrow and supply rates.

Call Params

NameTypeDescription
assetaddressAddress of the underlying token that has been borrowed for which the position is being rebalanced.
useraddressAddress of the user being rebalanced.

setUserUseReserveAsCollateral

function setUserUseReserveAsCollateral(address asset, bool useAsCollateral)

Sets the asset of msg.sender to be used as collateral or not.

An asset in Isolation Mode can be enabled to use as collateral only if no other asset is already enabled to use as collateral.

User won’t be able to disable an asset as collateral if they have an outstanding debt position which could be left with HF < HEALTH_FACTOR_LIQUIDATION_THRESHOLD on disabling the given asset as collateral.

Call Params

NameTypeDescription
assetaddressaddress of the underlying asset to be used as collateral
useAsCollateralbooltrue if the asset should be used as collateral

liquidationCall

function liquidationCall(address collateral, address debt, address user, uint256 debtToCover, bool receiveAToken)

Liquidate positions with a health factor below 1.

When the health factor of a position is below 1, liquidators repay part or all of the outstanding borrowed amount on behalf of the borrower, while receiving a discounted amount of collateral in return (also known as a liquidation ‘bonus”). Liquidators can decide if they want to receive an equivalent amount of collateral hyTokens instead of the underlying asset. When the liquidation is completed successfully, the health factor of the position is increased, bringing the health factor above 1.

Liquidators can only close a certain amount of collateral defined by a close factor. Currently the close factor is 0.5. In other words, liquidators can only liquidate a maximum of 50% of the amount pending to be repaid in a position. The liquidation discount applies to this amount.

Liquidators must `approve()` the `Pool` contract to use `debtToCover` of the underlying ERC20 of the`asset` used for the liquidation.

NOTES

  • In most scenarios, profitable liquidators will choose to liquidate as much as they can (50% of the user position).

  • debtToCover parameter can be set to uint(-1) and the protocol will proceed with the highest possible liquidation allowed by the close factor.

  • To check a user’s health factor, use getUserAccountData().

Call Params

NameTypeDescription
collateraladdressaddress of the collateral reserve
debtaddressaddress of the debt reserve
useraddressaddress of the borrower
debtToCoveruint256amount of asset debt that the liquidator will repay
receiveATokenboolif true, the user receives the hyTokens equivalent of the purchased collateral. If false, the user receives the underlying asset directly.

flashLoan

function flashLoan( address receiverAddress, address[] calldata assets, uint256[] calldata amounts, uint256[] interestRateModes, address onBehalfOf, bytes calldata params, uint16 referralCode)

Allows users to access liquidity of the pool for given list of assets for one transaction as long as the amount taken plus fee is returned or debt position is opened by the end of transaction.

If no debt position is opened, receiver must approve the Pool contract for at least the amount borrowed + fee, else transaction will revert.

Flash loan fee is waived for the approved flashBorrowers.

Referral program is currently inactive, you can pass 0 as referralCode. This program may be activated in the future.

Call Params

NameTypeDescription
receiverAddressaddress

Address of the contract that will receive the flash borrowed funds.
Must implement the IFlashLoanReceiver interface.

assetsaddress[]Addresses of the underlying assets that will be flash borrowed
amountsuint256[]

Amounts of assets being requested for flash borrow.
This needs to contain the same number of entries as assets.

modesuint256[]

the types of debt position to open if the flashloan is not returned.
0: no open debt. (amount+fee must be paid in this case or revert)
1: stable mode debt
2: variable mode debt

onBehalfOfaddress

if the associated mode is not0 then the incurred debt will be applied to the onBehalfOfaddress.
Note: onBehalfOf must already have approved sufficient borrow allowance of the associated asset to msg.sender

paramsbytesArbitrary bytes-encoded params that will be passed to executeOperation() method of the receiver contract.
referralCodeuint16Referral Code used for 3rd party integration referral. The unique referral id is can be requested via governance proposal.

flashLoanSimple

function flashLoanSimple( address receiverAddress, address asset, uint256 amount, bytes calldata params, uint16 referralCode)

Allows users to access liquidity of one reserve or one transaction as long as the amount taken plus fee is returned.

Receiver must approve the Pool contract for at least the amount borrowed + fee, else transaction will revert.

Does not waive few for approved flashBorrowers nor allow opening a debt position instead of repaying.

Referral program is currently inactive, you can pass 0 as referralCode. This program may be activated in the future through a HypurrFi governance proposal.

Call Params

NameTypeDescription
receiverAddressaddress

Address of the contract that will receive the flash borrowed funds.
Must implement the IFlashLoanReceiver interface.

assetaddressAddress of the underlying asset that will be flash borrowed.
amountuint256Amount of asset being requested for flash borrow
paramsbytesArbitrary bytes-encoded params that will be passed to executeOperation() method of the receiver contract.
referralCodeuint16Referral Code used for 3rd party integration referral. The unique referral id can be requested via governance proposal.

mintToTreasury

function mintToTreasury(address[] calldata assets)

Mints reserve income accrued to treasury (as per the reserve factor) for the given list of assets.

Call Params

NameTypeDescription
assetsaddress[]List of assets for which accrued income is minted

setUserEMode

function setUserEMode(uint8 categoryId)

Updates the user efficiency mode category. The category id must be a valid id already defined by Pool or Risk Admins

Will revert if user is borrowing non-compatible asset or change will drop HF < HEALTH_FACTOR_LIQUIDATION_THRESHOLD.

Call Params

NameTypeDescription
categoryIduint8

eMode category id (0 - 255) defined by Risk or Pool Admins.
categoryId == 0 ⇒ non E-mode category.

mintUnbacked

mintUnbacked (asset, amount, onBehalfOf, referralCode)

Allows contracts, with BRIDGE role permission, to mint unbacked hyTokens to the onBehalfOf address.

Only available to the addresses withBRIDGErole. Bridge addresses can be whitelisted by the governance.

ParamTypeDescription
assetaddressaddress of the underlying asset token
amountuint256the amount to be minted
onBehalfOfaddressthe address which will receive the hyTokens
referralCodeuint16

Code used to register the integrator originating the operation, for potential rewards

0 if the action is executed directly by the user, without any middle-man

backUnbacked

backUnbacked (asset, amount, fee)

Allows contracts, with BRIDGE role permission, to back the currently unbacked hyTokens with amount of underlying asset and pay fee.

Only available to the addresses withBRIDGErole. Bridge addresses can be whitelisted by the governance.

ParamTypeDescription
assetaddressaddress of the underlying asset to repay
amountuint256amount of asset supplied to back the unbacked tokens
feeuint256amount paid in fee

rescueTokens

function rescueTokens(address token, address to, uint256 amount)

Rescue and transfer tokens locked in this contract.

Only available toPOOL_ADMINrole. Pool admin is selected by the governance.

View Methods

getReserveData

function getReserveData(address asset)

Returns the state and configuration of the reserve.

Call Params

NameTypeDescription
assetaddressaddress of the underlying reserve asset.

Return Values

NameTypeDescription
configurationuint256

Reserve configuration.
bit 0-15: LTV
bit 16-31: Liquidation threshold
bit 32-47: Liquidation bonus
bit 48-55: Decimals
bit 56: reserve is active
bit 57: reserve is frozen
bit 58: borrowing is enabled
bit 59: stable rate borrowing enabled
bit 60: asset is paused
bit 61: borrowing in isolation mode is enabled
bit 62-63: reserved
bit 64-79: reserve factor
bit 80-115: borrow cap in whole tokens, 0 ⇒ no cap
bit 116-151: supply cap in whole tokens, 0 ⇒ no cap
bit 152-167: liquidation protocol fee
bit 168-175: eMode category
bit 176-211: unbacked mint cap in whole tokens, 0 ⇒ no cap
bit 212-251: debt ceiling for isolation mode with decimals bit 252-255: unused

liquidityIndexuint128yield generated by reserve during time interval since lastUpdatedTimestamp. Expressed in ray
currentLiquidityRateuint128current supply rate. Expressed in ray
variableBorrowIndexuint128yield accrued by reserve during time interval since lastUpdatedTimestamp. Expressed in ray
currentVariableBorrowRateuint128current variable borrow rate. Expressed in ray
currentStableBorrowRateuint128current stable borrow rate. Expressed in ray
lastUpdateTimestampuint40timestamp of when reserve data was last updated. Used for yield calculation.
iduint16reserve’s position in the list of active reserves.
aTokenAddressaddressaddress of associated hyToken
stableDebtTokenAddressaddressaddress of associated stable debt token
variableDebtTokenAddressaddressaddress of associated variable debt token
interestRateStrategyAddressaddressaddress of interest rate strategy.
accruedToTreasuryuint128the current treasury balance (scaled)
unbackeduint128the outstanding unbacked hyTokens minted through the bridging feature
isolationModeTotalDebtuint128the outstanding debt borrowed against this asset in isolation mode

getUserAccountData

function getUserAccountData(address user)

Returns the user account data across all the reserves

Call params

NameTypeDescription
useraddressaddress of the user

Return Values

NameTypeDescription
totalCollateralBaseuint256total collateral of the user, in market’s base currency
totalDebtBaseuint256total debt of the user, in market’s base currency
availableBorrowsBaseuint256borrowing power left of the user, in market’s base currency
currentLiquidationThresholduint256liquidation threshold of the user
ltvuint256Loan To Value of the user
healthFactoruint256current health factor of the user

getConfiguration

function getConfiguration(address asset)

Returns the configuration of the reserve.

Call Params

NameTypeDescription
assetaddressaddress of the underlying reserve asset.

Return Values

NameTypeDescription
configurationuint256

Reserve configuration.
bit 0-15: LTV
bit 16-31: Liquidation threshold
bit 32-47: Liquidation bonus
bit 48-55: Decimals
bit 56: reserve is active
bit 57: reserve is frozen
bit 58: borrowing is enabled
bit 59: stable rate borrowing enabled
bit 60: asset is paused
bit 61: borrowing in isolation mode is enabled
bit 62-63: reserved bit 64-79: reserve factor
bit 80-115: borrow cap in whole tokens, 0 ⇒ no cap
bit 116-151: supply cap in whole tokens, 0 ⇒ no cap
bit 152-167: liquidation protocol fee
bit 168-175: eMode category
bit 176-211: unbacked mint cap in whole tokens, 0 ⇒ no cap
bit 212-251: debt ceiling for isolation mode with decimals
bit 252-255: unused

getUserConfiguration

function getUserConfiguration(address user)

Returns the configuration of the user across all the reserves.

Call Params

NameTypeDescription
useraddressaddress of the user

Return Values

TypeDescription
uint256

Bitmap of the users collaterals and borrows. It’s divided into pairs of bits, one pair for each asset.
The first bit of the pair indicates if it is being used as collateral by the user, the second bit indicates if it is being borrowed. The corresponding assets are in the same position as getReservesList() For example, if the hex value returned is 0x40020, which represents a decimal value of 262176, then in binary it is 1000000000000100000. If we format the binary value into pairs, starting from the right, we get 1 00 00 00 00 00 00 10 00 00. If we start from the right and move left in the above binary pairs, the third pair is 10. Therefore the 1 indicates that third asset from the reserveList is used as collateral, and 0 indicates it has not been borrowed by this user.

getReserveNormalizedIncome

function getReserveNormalizedIncome(address asset)

Returns the ongoing normalized income for the reserve.

A value of 1e27 means there is no income. As time passes, the yield is accrued. A value of 2*1e27 means for each unit of asset one unit of income has been accrued.

Return Value

TypeDescription
uint256Normalized income, expressed in ray

getReserveNormalizedDebt

function getReserveNormalizedVariableDebt(address asset)

Returns the ongoing normalized variable debt for the reserve.

A value of 1e27 means there is no debt. As time passes, the debt is accrued. A value of 2*1e27 means that for each unit of debt, one unit worth of interest has been accumulated.

Return Value

TypeDescription
uint256Normalized debt, expressed in ray

getReservesList

function getReservesList()

Returns the list of initialized reserves.

getEModeCategoryData

function getEModeCategoryData(uint8 id)

Returns category data for the given eModeCategory id.

Return Values

TypeDescription
uint16loan to value (ltv) for the given eModeCategory id
uint16liquidationThreshold for the given eModeCategory id
uint16liquidationBonus for the given eModeCategory id
addresscustom price source for the eMode category
stringcustom label describing the eMode category

getUserEMode

function getUserEMode(address user)

Returns eModeCategory Id of the user’s eMode. 0 ⇒ no eMode.

FLASHLOAN_PREMIUM_TOTAL

function FLASHLOAN_PREMIUM_TOTAL() public view returns (uint128)

Returns the percent of total flashloan premium paid by the borrower. A part of this premium is added to reserve’s liquidity index i.e. paid to the liquidity provider and the other part is paid to the protocol i.e. accrued to the treasury.

FLASHLOAN_PREMIUM_TO_PROTOCOL

function FLASHLOAN_PREMIUM_TO_PROTOCOL() public view returns (uint128)

Returns the percent of flashloan premium that is accrued to the treasury.

ABI