Onyx Protocol
  • πŸ“–Onyx Documentation
  • β˜•Getting Started
    • πŸ”¬Networks
    • πŸ“’Protocol Math
      • oToken and Underlying Decimals
      • Interpreting Exchange Rates
      • Calculating Accrued Interest
      • Calculating the APY Using Rate Per Block
    • πŸ’ΉGas Costs
  • πŸ§‘β€πŸ’»OTokens
    • Mint
    • Redeem
    • Redeem Underlying
    • Borrow
    • Repay Borrow
    • Repay Borrow Behalf
    • Transfer
    • Liquidate Borrow
    • Key Events
    • Error Codes
    • Failure Info
    • Exchange Rate
    • Get Cash
    • Total Borrow
    • Borrow Balance
    • Borrow Rate
    • Total Supply
    • Underlying Balance
    • Supply Rate
    • Total Reserves
    • Reserve Factor
  • βš™οΈComptroller
    • Enter Markets
    • Exit Market
    • Get Assets In
    • Collateral Factor
    • Get Account Liquidity
    • Close Factor
    • Liquidation Incentive
    • Key Events
    • Error Codes
    • Failure Info
    • XCN Distribution Speeds
    • Claim XCN
    • Market Metadata
  • πŸ‘¨β€πŸ‘©β€πŸ‘¦Governance
    • Governor Alpha
    • Quorum Votes
    • Proposal Threshold
    • Proposal Max Operations
    • Voting Delay
    • Voting Period
    • Propose
    • Queue
    • Execute
    • Cancel
    • Get Actions
    • Get Receipt
    • State
    • Cast Vote
    • Cast Vote By Signature
    • Timelock
    • Pause Guardian
  • πŸ”‘API
    • Basic API
      • GET: /otoken
      • GET: /market_history/graph
      • GET: /user/history
      • GET: /get_liquidators
      • GET: /get_liquidator:account
      • GET: /get_liquidator_detail:account
      • GET: /liquidator
    • GraphQL API
      • oTokens Subgraph
      • History Subgraph
      • Governance Subgraph
    • Governance API
      • GET: /proposal
      • GET: /proposal/:proposalId
      • GET: /voter/:proposalId
      • GET: /voter/accounts
      • GET: /voter/history/:address
    • Shared Data Types
  • πŸ“–Onyx.js
    • Onyx Constructor
    • API Methods
      • Account
      • oToken
      • Market History
      • Governance
    • oToken Methods
      • Supply
      • Redeem
      • Borrow
      • Repay Borrow
    • XCN Methods
      • To Checksum Address
      • Get XCN Balance
      • Get XCN Accrued
      • Claim XCN
      • Delegate
      • Delegate By Sig
      • Create Delegate Signature
    • Comptroller Methods
      • Enter Markets
      • Exit Market
    • Ethereum Methods
      • Read
      • Trx
      • Get Balance
    • Governance Methods
      • Cast Vote
      • Cast Vote By Sig
      • Create Vote Signature
    • Price Feed Methods
      • Get Price
    • Utility Methods
      • Get Address
      • Get ABI
      • Get Network Name With Chain ID
  • πŸ”’Security
    • Bug Bounty Program
  • πŸ“„Terms of Service
Powered by GitBook
On this page
  • Utilization rate
  • Borrow & Supply rates
  1. Getting Started
  2. Protocol Math

Calculating Accrued Interest

Interest rates for each market update on any block in which the ratio of borrowed assets to supplied assets in the market has changed. The amount interest rates are changed depends on the interest rate model smart contract implemented for the market, and the amount of change in the ratio of borrowed assets to supplied assets in the market.

Utilization rate

All interest rates in Onyx are determined as a function of a metric known as the utilization rate. The utilization rate UaU_aUa​ for a money market aaa is defined as:

Ua=Borrowsa/(Casha+Borrowsaβˆ’Reservesa)U_a = Borrows_a / (Cash_a + Borrows_a - Reserves_a)Ua​=Borrowsa​/(Casha​+Borrowsaβ€‹βˆ’Reservesa​)

  • BorrowsaBorrows_aBorrowsa​ refers to the amount of aaa borrowed.

  • CashaCash_aCasha​ refers to the amount of aaa left in the system.

  • ReservesaReserves_aReservesa​ refers to the amount of aaa that Drops keeps as profit.

Intuitively speaking, this is the percentage of money borrowed out of the total money supplied.

Borrow & Supply rates

The borrowing rate's calculation depends on something called an interest rate model - the algorithmic model to determine a money market's borrow and supply rates.

Borrow and supply rates are calculated using the utilization rate and several arbitrary constants.

Markets follow what is known as the "Jump Rate" model, which contains the following parameters:

  • Base rate per year - the minimum borrowing rate

  • Multiplier per year - the rate of increase in interest rate with respect to utilization

  • Kink - the point in the model in which the model follows the jump multiplier

  • Jump Multiplier per year - the rate of increase in the interest rate with respect to utilization after the "kink"

The borrow rate of the jump rate model is defined as follows:

Interest accrues to all suppliers and borrowers in a market when any Ethereum address interacts with the market’s oToken contract, calling one of these functions: mint, redeem, borrow, or repay. Successful execution of one of these functions triggers the accrueInterest method, which causes interest to be added to the underlying balance of every supplier and borrower in the market. Interest accrues for the current block, as well as each prior block in which the accrueInterest method was not triggered (no user interacted with the oToken contract). Interest compounds only during blocks in which the oToken contract has one of the aforementioned methods invoked.

Here is an example of supply interest accrual:

Alice supplies 1 ETH to the Onyx protocol. At the time of supply, the supplyRatePerBlock is 37893605 Wei, or 0.000000000037893605 ETH per block. No one interacts with the oEther contract for 3 Ethereum blocks. On the subsequent 4th block, Bob borrows some ETH. Alice’s underlying balance is now 1.000000000151574420 ETH (which is 37893605 Wei times 4 blocks, plus the original 1 ETH). Alice’s underlying ETH balance in subsequent blocks will have interest accrued based on the new value of 1.000000000151574420 ETH instead of the initial 1 ETH. Note that the supplyRatePerBlock value may change at any time.

PreviousInterpreting Exchange RatesNextCalculating the APY Using Rate Per Block

Last updated 1 year ago

β˜•
πŸ“’