Contracts Overview

Themis V2 contract is divided into two main parts.

• The first part is the M0 Pool contract, which mainly provides deposit, debit, clearing, and flash credit for mainstream tokens, and issues corresponding t/s/v tokens for deposit and debit. The related contract mainly contains modules for the configuration of the pool each pool price calculation and interest rate, clearing, and other configuration functions. The auxiliary contract mainly contains rewards, ui data provider, incentive data provider, wallet balance provider and WETH gateway.

• The second part is the M1 Pool contract, which mainly provides Uniswap V2/V3, and other third-party LP lending functions, and issues corresponding s/v tokens for the corresponding lending behavior. The relevant contract mainly contains modules for the configuration of the pools each pool price calculation and interest rate, clearing, and other configuration functions.

M0 Pool Core Contracts

Core protocol contracts fall in following 4 categories:

• Configuration

• Pool logic

• Tokenization

• Misc

Configuration

ACLManager

Themis Protocol V2 implements an access control list to segregate powers and/or benefits that can be allocated to different entities on the protocol. The roles and holders are managed in the ACLManager.sol, which keeps track of the individual roles and its holders.

PoolAddressesProvider

The main addresses register of the protocol, containing address of *core protocol contracts *and ACL admin. It acts as factory of proxies and admin of those. The owner of this contract has the right to set/update implementation of the upgradable contracts. The latest contract addresses should be retrieved from this contract by making the appropriate calls.

PoolAddressesProviderRegistry

Contains a list of active

PoolAddressProvider addresses, for different markets. It is used for indexing all Themis protocol’s markets.

PriceOracleSentinel

Oracle Sentinel validates if operations are allowed depending on the PriceOracle health. Once the PriceOracle gets up after an outage/downtime, users can make their positions healthy during a grace period.

Pool Logic

DefaultReserveInterestRateStrategy

Implements the calculation of the interest rates depending on the reserve state. This contract holds the information needed to calculate and update the yield relating to specific liquidity pools. Each contract stores the optimised base curves using the corresponding parameters of each asset. This means that there is a mathematical function which determines the yield of each liquidity pool, with the yield changing based on the amount of borrowed funds and the total liquidity (i.e. utilisation) of the pool.

Pool

The main entry point into the Themis Protocol. Most user interactions with the Themis Protocol occur via the Pool contract. Pool is owned by the PoolAddressesProvider of the specific market. All admin functions are callable by the PoolConfigurator contract, which is defined in PoolAddressesProvider.

PoolConfigurator

Provider configuration methods for the Pool contract. The write methods of this contract can only be called by addresses with corresponding permission-ed system roles that are managed by ACLManager.

Tokenization

TToken

Yield-generating tokens that are minted and burnt upon supply and withdraw of assets to Themis Pool

DelegationAwareTToken

The special type of aToken that are minted and burnt upon supply and withdraw of assets that has voting power associated (which can be delegated) with them.

StableDebtToken

The non-transferable interest accruing, stable rate tokenised borrows.

VariableDebtToken

The non-transferable interest accruing, variable rate tokenised borrows.

Misc

ThemisOracle

Contract to get asset prices, manage price sources and update the fallback oracle.

M0ProtocolDataProvider

Peripheral contract to collect and pre-process information from the Pool.

Peripheral Contracts

Rewards

RewardsController

This contract is responsible for configuring the different rewards and the claim process.

Transfer Strategies

These are isolated contracts that manages the procedure of the rewards transfer at claim. This allows the RewardsController to support any custom rewards like Staked Themis, common ERC20 or even NFT.

Misc

UiIncentiveDataProvider

Helper contract to fetch Incentives Data. It is used by Themis UI for reward balance info.

UiPoolDataProvider

Helper contract, used by Themis UI, to fetch Pool Data such reserves list, all reserves data like liquidity, token addresses, rate strategy etc.

WETHGateway

Only ERC20 tokens can be supplied & borrowed from the Themis Protocol V2 pools. To facilitate using token native to the chain (such ETH on Ethereum or Matic on polygon) a helper contract is used to support single tx supply, borrow, repay and withdraw.

WalletBalanceProvider

Used for getting multiple tokens balance for one user address. This contract is used by Themis backend to reduce the number of blockchain calls for fetching user balance.

M1 Pool Core Contracts

Core protocol contracts fall in following 4 categories:

• Configuration

• M1Pool logic

• Tokenization

• Misc

M1 Configuration

Pool Logic

M1Pool

The main entry point into the Themis Protocol. Most user interactions with the Themis Protocol occur via the Pool contract. Pool is owned by the PoolAddressesProvider of the specific market. All admin functions are callable by the PoolConfigurator contract, which is defined in PoolAddressesProvider.

M1PoolConfigurator

Provider configuration methods for the M1 Pool contract. The write methods of this contract can only be called by addresses with corresponding permission-ed system roles that are managed by ACLManager.

Tokenization

Misc

M1ProtocolDataProvider

Helper contract, used by Themis UI, to fetch Pool Data such reserves list, all reserves data like liquidity, token addresses, rate strategy etc.

M1CollateralValueCalculator

M1Pool

The M1Pool.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

borrowM1

function borrowM1( address collateralAddress, uint256 collateralAmount, address asset, uint256 amount, uint256 interestRateMode, uint16 referralCode, address onBehalfOf ) external

User can borrow the amount of asset by collateral the collateralAddress asset to M1Pool

Call Params

addCollateral

function addCollateral(uint256 userRecordId, uint256 collateralAmount) external

Call Params

reduceCollateral

function reduceCollateral(uint256 userRecordId, uint256 collateralAmount) external

Call Params

extraBorrowM1

function extraBorrowM1(uint256 userRecordId, uint256 amount,address onBehalfOf) external

Call Params

repayM1

function repayM1( address collateralAddress, uint256 userRecordId, address asset, uint256 amount, address onBehalfOf ) external

Call Params

liquidationCallM1

function liquidationCallM1( uint256 recordId ) external

Liquidation operation based on the record ID generated by the collateral, anyone can call this interface when the collateral record triggers the liquidation.

Call Params

View Methods

checkCanLiquidation

function checkCanLiquidation(uint256 recordId) external view returns ( uint256 currentCollateralValueInBaseCurrency, uint256 collateralDebt, uint256 collateralDebtInBaseCurrency, uint256 liquidationThreshold, uint256 collateralCurrentRatio)

Check if the collateral record has been liquidated against the record ID

Return Values

getUserRecordIds

function getUserRecordIds(address user) external view returns (uint256[] memory)

Get information about how many collateral records the user has based on the user's address

Call Params

Return Values

getRecordDetails

function getRecordDetails(uint256 recordId) external view returns (DataTypes.M1LoadAssetDetails memory)

Get the collateral details based on the collateral record ID.

getM1UserTotalLoadAssetInfo

function getM1UserTotalLoadAssetInfo(address user, address asset) external view returns (DataTypes.M1UserLoadAssetInfo memory)

Get the total number of debts for which the user borrowed a certain asset

ACLManager

Access Control List Manager is the main registry of system roles and permissions. ACLManager allows a Role Admin to manage roles. Role Admin is itself a role that is managed by the DEFAULT_ADMIN_ROLE.

DEFAULT_ADMIN_ROLE is held by the*ACLAdmin,*which is initialized in PoolAddressesProvider .

Roles

Below we outline the powers/responsibilities of the roles and the specific methods that are only accessible to the holders of these roles.

View Methods

isPoolAdmin

function isPoolAdmin(address admin)o

Returns true if the address has POOL_ADMIN role.

isEmergencyAdmin

function isEmergencyAdmin(address admin)

Returns true if the address has EMERGENCY_ADMIN role.

isRiskAdmin

function isRiskAdmin(address admin)

Returns true if the address has RISK_ADMIN role.

isFlashBorrower

function isFlashBorrower(address borrower)

Returns true if the address has FLASH_BORROWER role.

isBridge

function isBridge(address bridge)

Returns true if the address has BRIDGE role.

isAssetListingAdmin

function isAssetListingAdmin(address admin)

Returns true if the address has ASSET_LISTING_ADMIN role.

Write Methods

setRoleAdmin

setRoleAdmin(bytes32 role, bytes32 adminRole)

setRoleAdmin(bytes32 role, bytes32 adminRole)

Setup admin to manage Roles.

Call Params

addPoolAdmin

addPoolAdmin(address admin)

Add address to the list of members in POOL_ADMIN role. Holders of this role can update token implementations, drop, (un) pause and (de)activate reserves, update premiums and do everything the ASSET_LISTING_ADMIN and RISK_ADMIN can do.

Call Params

removePoolAdmin

removePoolAdmin(address admin)

Remove given address from the list of members in POOL_ADMIN role.

Call Params

addEmergencyAdmin

addEmergencyAdmin(address admin)

Add address to the list of members in EMERGENCY_ADMIN role. Holders of this role can pause and unpause the pool or an individual reserve.

removeEmergencyAdmin

function removeEmergencyAdmin(address admin)

Remove given address from the list of members in EMERGENCY_ADMIN role.

addRiskAdmin

function addRiskAdmin(address admin)

Add address to the list of members in RISK_ADMIN role. Holders of this role can update grace period of Oracle Sentinels, reserve params, unbacked mint cap,liquidation fee and eMode categories.

removeRiskAdmin

Remove given address from the list of members in RISK_ADMIN role.

addFlashBorrower

function addFlashBorrower(address borrower)

Add address to the list of members in FLASH_BORROWER role. Holders of this role do not pay premium for flash loan (Does not apply to flashLonaSimple).

removeFlashBorrower

function removeFlashBorrower(address borrower)

Remove given address from the list of members in FLASH_BORROWER role.

addBridge

addBridge(address bridge)

Add contract address to the list ofbridges. Holders of this role can leverage the Portal feature to seamlessly move supplied assets across Aave V3 markets on different networks.

removeBridge

removeBridge(address bridge)

Remove contract address from the list of bridges.

addAssetListingAdmin

function addAssetListingAdmin(address admin)

Add address to the list of member in ASSET_LISTING_ADMIN role. Holder of this role can update oracles & add new asset to the Aave market. ``

removeAssetListingAdmin

function removeAssetListingAdmin(address admin)

Remove address from the list of members in ASSET_LISTING_ADMIN role.

PriceOracleSentinel

This contract validates if the operations are allowed depending on the PriceOracle health.

The PriceOracle is considered healthy once its completely up and the grace period has passed.

View Methods

isBorrowAllowed

function isBorrowAllowed()

Return Value

isLiquidationAllowed

function isLiquidationAllowed()

Return Value

getSequencerOracle

function getSequencerOracle()

Return Value

getGracePeriod

function getGracePeriod()

Return Value

Write Methods

setSequencerOracle

function setSequencerOracle(address newSequencerOracle)

Can be called only by PoolAdmin.

Call Params

setGracePeriod

function setGracePeriod(uint256 newGracePeriod)

Can be called only by PoolAdmin or RiskAdmin.

Call Params