Skip to content

Commit

Permalink
chore: update target branch
Browse files Browse the repository at this point in the history
  • Loading branch information
@QGarchery
QGarchery committed Jul 21, 2023
2 parents 8d6b624 + 28e96a5 commit 9cd9667
Show file tree
Hide file tree
Showing 7 changed files with 312 additions and 117 deletions.
11 changes: 4 additions & 7 deletions certora/specs/Blue.spec
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
methods {
function supply(Blue.Market, uint256 amount) external;
function _.borrowRate(Blue.Market) external => DISPATCHER(true);


function _.borrowRate(Blue.Market) external returns (uint256) => DISPATCH(true);

function _.safeTransfer(address, uint256) internal returns (bool) envfree => DISPATCH(true);
function _.safeTransferFrom(address, address, uint256) internal returns (bool) envfree => DISPATCH(true);
function _.transfer(address, uint256) external => DISPATCHER(true);
function _.transferFrom(address, address, uint256) external => DISPATCHER(true);
}

rule supplyRevertZero(Blue.Market market) {
env e;

supply@withrevert(market, 0);
supply@withrevert(e, market, 0, e.msg.sender);

assert lastReverted;
}
117 changes: 69 additions & 48 deletions src/Blue.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,25 @@ pragma solidity 0.8.20;

import {IIrm} from "src/interfaces/IIrm.sol";
import {IERC20} from "src/interfaces/IERC20.sol";
import {IOracle} from "src/interfaces/IOracle.sol";

import {MathLib} from "src/libraries/MathLib.sol";
import {Id, Market, MarketLib} from "src/libraries/MarketLib.sol";
import {SafeTransferLib} from "src/libraries/SafeTransferLib.sol";

uint256 constant WAD = 1e18;
uint256 constant ALPHA = 0.5e18;

// Market id.
type Id is bytes32;

// Market.
struct Market {
IERC20 borrowableAsset;
IERC20 collateralAsset;
IOracle borrowableOracle;
IOracle collateralOracle;
IIrm irm;
uint256 lltv;
}

using {toId} for Market;

function toId(Market memory market) pure returns (Id) {
return Id.wrap(keccak256(abi.encode(market)));
}

contract Blue {
using MathLib for uint256;
using MarketLib for Market;
using SafeTransferLib for IERC20;

// Storage.

// Owner.
address public owner;
// Fee recipient.
address public feeRecipient;
// User' supply balances.
mapping(Id => mapping(address => uint256)) public supplyShare;
// User' borrow balances.
Expand All @@ -54,10 +38,14 @@ contract Blue {
mapping(Id => uint256) public totalBorrowShares;
// Interests last update (used to check if a market has been created).
mapping(Id => uint256) public lastUpdate;
// Fee.
mapping(Id => uint256) public fee;
// Enabled IRMs.
mapping(IIrm => bool) public isIrmEnabled;
// Enabled LLTVs.
mapping(uint256 => bool) public isLltvEnabled;
// User's managers.
mapping(address => mapping(address => bool)) public isApproved;

// Constructor.

Expand Down Expand Up @@ -87,10 +75,22 @@ contract Blue {
isLltvEnabled[lltv] = true;
}

// @notice It is the owner's responsibility to ensure a fee recipient is set before setting a non-zero fee.
function setFee(Market calldata market, uint256 newFee) external onlyOwner {
Id id = market.id();
require(lastUpdate[id] != 0, "unknown market");
require(newFee <= WAD, "fee must be <= 1");
fee[id] = newFee;
}

function setFeeRecipient(address recipient) external onlyOwner {
feeRecipient = recipient;
}

// Markets management.

function createMarket(Market memory market) external {
Id id = market.toId();
function createMarket(Market calldata market) external {
Id id = market.id();
require(isIrmEnabled[market.irm], "IRM not enabled");
require(isLltvEnabled[market.lltv], "LLTV not enabled");
require(lastUpdate[id] == 0, "market already exists");
Expand All @@ -100,19 +100,19 @@ contract Blue {

// Supply management.

function supply(Market memory market, uint256 amount) external {
Id id = market.toId();
function supply(Market calldata market, uint256 amount, address onBehalf) external {
Id id = market.id();
require(lastUpdate[id] != 0, "unknown market");
require(amount != 0, "zero amount");

accrueInterests(market, id);

if (totalSupply[id] == 0) {
supplyShare[id][msg.sender] = WAD;
supplyShare[id][onBehalf] = WAD;
totalSupplyShares[id] = WAD;
} else {
uint256 shares = amount.wMul(totalSupplyShares[id]).wDiv(totalSupply[id]);
supplyShare[id][msg.sender] += shares;
supplyShare[id][onBehalf] += shares;
totalSupplyShares[id] += shares;
}

Expand All @@ -121,15 +121,16 @@ contract Blue {
market.borrowableAsset.safeTransferFrom(msg.sender, address(this), amount);
}

function withdraw(Market memory market, uint256 amount) external {
Id id = market.toId();
function withdraw(Market calldata market, uint256 amount, address onBehalf) external {
Id id = market.id();
require(lastUpdate[id] != 0, "unknown market");
require(amount != 0, "zero amount");
require(isSenderOrIsApproved(onBehalf), "not approved");

accrueInterests(market, id);

uint256 shares = amount.wMul(totalSupplyShares[id]).wDiv(totalSupply[id]);
supplyShare[id][msg.sender] -= shares;
supplyShare[id][onBehalf] -= shares;
totalSupplyShares[id] -= shares;

totalSupply[id] -= amount;
Expand All @@ -141,39 +142,40 @@ contract Blue {

// Borrow management.

function borrow(Market memory market, uint256 amount) external {
Id id = market.toId();
function borrow(Market calldata market, uint256 amount, address onBehalf) external {
Id id = market.id();
require(lastUpdate[id] != 0, "unknown market");
require(amount != 0, "zero amount");
require(isSenderOrIsApproved(onBehalf), "not approved");

accrueInterests(market, id);

if (totalBorrow[id] == 0) {
borrowShare[id][msg.sender] = WAD;
borrowShare[id][onBehalf] = WAD;
totalBorrowShares[id] = WAD;
} else {
uint256 shares = amount.wMul(totalBorrowShares[id]).wDiv(totalBorrow[id]);
borrowShare[id][msg.sender] += shares;
borrowShare[id][onBehalf] += shares;
totalBorrowShares[id] += shares;
}

totalBorrow[id] += amount;

require(isHealthy(market, id, msg.sender), "not enough collateral");
require(isHealthy(market, id, onBehalf), "not enough collateral");
require(totalBorrow[id] <= totalSupply[id], "not enough liquidity");

market.borrowableAsset.safeTransfer(msg.sender, amount);
}

function repay(Market memory market, uint256 amount) external {
Id id = market.toId();
function repay(Market calldata market, uint256 amount, address onBehalf) external {
Id id = market.id();
require(lastUpdate[id] != 0, "unknown market");
require(amount != 0, "zero amount");

accrueInterests(market, id);

uint256 shares = amount.wMul(totalBorrowShares[id]).wDiv(totalBorrow[id]);
borrowShare[id][msg.sender] -= shares;
borrowShare[id][onBehalf] -= shares;
totalBorrowShares[id] -= shares;

totalBorrow[id] -= amount;
Expand All @@ -184,36 +186,37 @@ contract Blue {
// Collateral management.

/// @dev Don't accrue interests because it's not required and it saves gas.
function supplyCollateral(Market memory market, uint256 amount) external {
Id id = market.toId();
function supplyCollateral(Market calldata market, uint256 amount, address onBehalf) external {
Id id = market.id();
require(lastUpdate[id] != 0, "unknown market");
require(amount != 0, "zero amount");

// Don't accrue interests because it's not required and it saves gas.

collateral[id][msg.sender] += amount;
collateral[id][onBehalf] += amount;

market.collateralAsset.safeTransferFrom(msg.sender, address(this), amount);
}

function withdrawCollateral(Market memory market, uint256 amount) external {
Id id = market.toId();
function withdrawCollateral(Market calldata market, uint256 amount, address onBehalf) external {
Id id = market.id();
require(lastUpdate[id] != 0, "unknown market");
require(amount != 0, "zero amount");
require(isSenderOrIsApproved(onBehalf), "not approved");

accrueInterests(market, id);

collateral[id][msg.sender] -= amount;
collateral[id][onBehalf] -= amount;

require(isHealthy(market, id, msg.sender), "not enough collateral");
require(isHealthy(market, id, onBehalf), "not enough collateral");

market.collateralAsset.safeTransfer(msg.sender, amount);
}

// Liquidation.

function liquidate(Market memory market, address borrower, uint256 seized) external {
Id id = market.toId();
function liquidate(Market calldata market, address borrower, uint256 seized) external {
Id id = market.id();
require(lastUpdate[id] != 0, "unknown market");
require(seized != 0, "zero amount");

Expand Down Expand Up @@ -246,24 +249,42 @@ contract Blue {
market.borrowableAsset.safeTransferFrom(msg.sender, address(this), repaid);
}

// Position management.

function setApproval(address manager, bool isAllowed) external {
isApproved[msg.sender][manager] = isAllowed;
}

function isSenderOrIsApproved(address user) internal view returns (bool) {
return msg.sender == user || isApproved[user][msg.sender];
}

// Interests management.

function accrueInterests(Market memory market, Id id) private {
function accrueInterests(Market calldata market, Id id) private {
uint256 marketTotalBorrow = totalBorrow[id];

if (marketTotalBorrow != 0) {
uint256 borrowRate = market.irm.borrowRate(market);
uint256 accruedInterests = marketTotalBorrow.wMul(borrowRate).wMul(block.timestamp - lastUpdate[id]);
totalBorrow[id] = marketTotalBorrow + accruedInterests;
totalSupply[id] += accruedInterests;

if (fee[id] != 0) {
uint256 feeAmount = accruedInterests.wMul(fee[id]);
// The fee amount is subtracted from the total supply in this calculation to compensate for the fact that total supply is already updated.
uint256 feeShares = feeAmount.wMul(totalSupplyShares[id]).wDiv(totalSupply[id] - feeAmount);
supplyShare[id][feeRecipient] += feeShares;
totalSupplyShares[id] += feeShares;
}
}

lastUpdate[id] = block.timestamp;
}

// Health check.

function isHealthy(Market memory market, Id id, address user) private view returns (bool) {
function isHealthy(Market calldata market, Id id, address user) private view returns (bool) {
uint256 borrowShares = borrowShare[id][user];
if (borrowShares == 0) return true;
// totalBorrowShares[id] > 0 when borrowShares > 0.
Expand Down
2 changes: 1 addition & 1 deletion src/interfaces/IIrm.sol
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.5.0;

import {Market} from "src/Blue.sol";
import {Market} from "src/libraries/MarketLib.sol";

interface IIrm {
function borrowRate(Market memory market) external returns (uint256);
Expand Down
23 changes: 23 additions & 0 deletions src/libraries/MarketLib.sol
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity ^0.8.0;

import {IIrm} from "src/interfaces/IIrm.sol";
import {IERC20} from "src/interfaces/IERC20.sol";
import {IOracle} from "src/interfaces/IOracle.sol";

type Id is bytes32;

struct Market {
IERC20 borrowableAsset;
IERC20 collateralAsset;
IOracle borrowableOracle;
IOracle collateralOracle;
IIrm irm;
uint256 lltv;
}

library MarketLib {
function id(Market calldata market) internal pure returns (Id) {
return Id.wrap(keccak256(abi.encode(market)));
}
}
10 changes: 7 additions & 3 deletions src/mocks/IrmMock.sol
View file
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
// SPDX-License-Identifier: UNLICENSED
pragma solidity 0.8.20;

import {IIrm} from "src/interfaces/IIrm.sol";

import {MathLib} from "src/libraries/MathLib.sol";
import {Id, Market, MarketLib} from "src/libraries/MarketLib.sol";

import "src/Blue.sol";
import {Blue} from "src/Blue.sol";

contract IrmMock is IIrm {
using MathLib for uint256;
using MarketLib for Market;

Blue public immutable blue;

constructor(Blue blueInstance) {
blue = Blue(blueInstance);
}

function borrowRate(Market memory market) external view returns (uint256) {
Id id = Id.wrap(keccak256(abi.encode(market)));
function borrowRate(Market calldata market) external view returns (uint256) {
Id id = market.id();
uint256 utilization = blue.totalBorrow(id).wDiv(blue.totalSupply(id));

// Divide by the number of seconds in a year.
Expand Down
Loading

0 comments on commit 9cd9667

Please sign in to comment.