├── audits └── ChainSecurity_SparkDAO_SparkLend_Advanced_audit.pdf ├── .gitignore ├── src ├── interfaces │ ├── IRateSource.sol │ ├── IPriceSource.sol │ └── AggregatorV3Interface.sol ├── FixedPriceOracle.sol ├── PotRateSource.sol ├── SSRRateSource.sol ├── CappedOracle.sol ├── RETHExchangeRateOracle.sol ├── WEETHExchangeRateOracle.sol ├── WSTETHExchangeRateOracle.sol ├── RSETHExchangeRateOracle.sol ├── MorphoUpgradableOracle.sol ├── EZETHExchangeRateOracle.sol ├── CappedFallbackRateSource.sol ├── RateTargetBaseInterestRateStrategy.sol ├── RateTargetKinkInterestRateStrategy.sol └── VariableBorrowInterestRateStrategy.sol ├── foundry.toml ├── .gitmodules ├── test ├── mocks │ ├── RateSourceMock.sol │ └── PriceSourceMock.sol ├── FixedPriceOracle.t.sol ├── PotRateSource.t.sol ├── SSRRateSource.t.sol ├── VariableBorrowInterestRateStrategy.t.sol ├── ExchangeRateOracleAttack.t.sol ├── CappedOracle.t.sol ├── MorphoUpgradableOracle.t.sol ├── WSTETHExchangeRateOracle.t.sol ├── RETHExchangeRateOracle.t.sol ├── WEETHExchangeRateOracle.t.sol ├── RSETHExchangeRateOracle.t.sol ├── EZETHExchangeRateOracle.t.sol ├── InterestRateStrategyBase.t.sol ├── RateTargetBaseInterestRateStrategy.t.sol ├── CappedFallbackRateSource.t.sol ├── RateTargetKinkInterestRateStrategy.t.sol └── SparkLendMainnetIntegration.t.sol ├── .github └── workflows │ └── ci.yml ├── README.md └── LICENSE /audits/ChainSecurity_SparkDAO_SparkLend_Advanced_audit.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sparkdotfi/sparklend-advanced/HEAD/audits/ChainSecurity_SparkDAO_SparkLend_Advanced_audit.pdf -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiler files 2 | cache/ 3 | out/ 4 | 5 | # Ignores development broadcast logs 6 | !/broadcast 7 | /broadcast/*/31337/ 8 | /broadcast/**/dry-run/ 9 | 10 | # Docs 11 | docs/ 12 | 13 | # Dotenv file 14 | .env 15 | 16 | lcov.info 17 | -------------------------------------------------------------------------------- /src/interfaces/IRateSource.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity >=0.8.0; 3 | 4 | interface IRateSource { 5 | function getAPR() external view returns (uint256); 6 | function decimals() external view returns (uint8); 7 | } 8 | -------------------------------------------------------------------------------- /src/interfaces/IPriceSource.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity >=0.8.0; 3 | 4 | interface IPriceSource { 5 | function latestAnswer() external view returns (int256); 6 | function decimals() external view returns (uint8); 7 | } 8 | -------------------------------------------------------------------------------- /foundry.toml: -------------------------------------------------------------------------------- 1 | [profile.default] 2 | src = "src" 3 | out = "out" 4 | libs = ["lib"] 5 | solc_version = "0.8.25" 6 | optimizer = true 7 | optimizer_runs = 200 8 | evm_version = "cancun" 9 | remappings = [ 10 | "ds-test/=lib/forge-std/lib/ds-test/src/", 11 | "erc20-helpers/=lib/erc20-helpers/src/", 12 | "forge-std/=lib/forge-std/src/", 13 | "sparklend-v1-core/=lib/sparklend-v1-core/contracts" 14 | ] 15 | 16 | [fuzz] 17 | runs = 10000 18 | 19 | # See more config options https://github.com/foundry-rs/foundry/tree/master/config 20 | -------------------------------------------------------------------------------- /src/FixedPriceOracle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | contract FixedPriceOracle { 5 | 6 | int256 public immutable price; 7 | 8 | constructor(int256 _price) { 9 | require(_price > 0, "FixedPriceOracle/invalid-price"); 10 | 11 | price = _price; 12 | } 13 | 14 | function latestAnswer() external view returns (int256) { 15 | return price; 16 | } 17 | 18 | function decimals() external pure returns (uint8) { 19 | return 8; 20 | } 21 | 22 | } 23 | -------------------------------------------------------------------------------- /src/PotRateSource.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IRateSource } from "./interfaces/IRateSource.sol"; 5 | 6 | interface IPot { 7 | function dsr() external view returns (uint256); 8 | } 9 | 10 | contract PotRateSource is IRateSource { 11 | 12 | IPot public immutable pot; 13 | 14 | constructor(address _pot) { 15 | pot = IPot(_pot); 16 | } 17 | 18 | function getAPR() external override view returns (uint256) { 19 | return (pot.dsr() - 1e27) * 365 days; 20 | } 21 | 22 | function decimals() external pure returns (uint8) { 23 | return 27; 24 | } 25 | 26 | } 27 | -------------------------------------------------------------------------------- /src/SSRRateSource.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IRateSource } from "./interfaces/IRateSource.sol"; 5 | 6 | interface ISUSDS { 7 | function ssr() external view returns (uint256); 8 | } 9 | 10 | contract SSRRateSource is IRateSource { 11 | 12 | ISUSDS public immutable susds; 13 | 14 | constructor(address _susds) { 15 | susds = ISUSDS(_susds); 16 | } 17 | 18 | function getAPR() external override view returns (uint256) { 19 | return (susds.ssr() - 1e27) * 365 days; 20 | } 21 | 22 | function decimals() external pure returns (uint8) { 23 | return 27; 24 | } 25 | 26 | } 27 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "lib/forge-std"] 2 | path = lib/forge-std 3 | url = https://github.com/foundry-rs/forge-std 4 | [submodule "lib/erc20-helpers"] 5 | path = lib/erc20-helpers 6 | url = https://github.com/marsfoundation/erc20-helpers 7 | [submodule "lib/sparklend-v1-core"] 8 | path = lib/sparklend-v1-core 9 | url = https://github.com/marsfoundation/sparklend-v1-core 10 | [submodule "lib/openzeppelin-contracts"] 11 | path = lib/openzeppelin-contracts 12 | url = https://github.com/openzeppelin/openzeppelin-contracts 13 | [submodule "lib/sparklend-address-registry"] 14 | path = lib/sparklend-address-registry 15 | url = https://github.com/marsfoundation/sparklend-address-registry 16 | -------------------------------------------------------------------------------- /test/mocks/RateSourceMock.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IRateSource } from "../../src/interfaces/IRateSource.sol"; 5 | 6 | contract RateSourceMock is IRateSource { 7 | 8 | uint256 public rate; 9 | uint8 public decimals; 10 | 11 | constructor(uint256 _rate, uint8 _decimals) { 12 | rate = _rate; 13 | decimals = _decimals; 14 | } 15 | 16 | function setRate(uint256 _rate) external { 17 | rate = _rate; 18 | } 19 | 20 | function getAPR() external override view returns (uint256) { 21 | return rate; 22 | } 23 | 24 | function setDecimals(uint8 _decimals) external { 25 | decimals = _decimals; 26 | } 27 | 28 | } 29 | -------------------------------------------------------------------------------- /src/interfaces/AggregatorV3Interface.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.5.0; 3 | 4 | /// @dev From 5 | /// https://github.com/smartcontractkit/chainlink/blob/master/contracts/src/v0.8/shared/interfaces/AggregatorV3Interface.sol 6 | interface AggregatorV3Interface { 7 | function decimals() external view returns (uint8); 8 | 9 | function description() external view returns (string memory); 10 | 11 | function version() external view returns (uint256); 12 | 13 | function getRoundData(uint80 _roundId) 14 | external 15 | view 16 | returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound); 17 | 18 | function latestRoundData() 19 | external 20 | view 21 | returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound); 22 | } 23 | -------------------------------------------------------------------------------- /test/mocks/PriceSourceMock.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | contract PriceSourceMock { 5 | 6 | int256 public latestAnswer; 7 | uint8 public decimals; 8 | 9 | constructor(int256 _latestAnswer, uint8 _decimals) { 10 | latestAnswer = _latestAnswer; 11 | decimals = _decimals; 12 | } 13 | 14 | function setLatestAnswer(int256 _latestAnswer) external { 15 | latestAnswer = _latestAnswer; 16 | } 17 | 18 | function setDecimals(uint8 _decimals) external { 19 | decimals = _decimals; 20 | } 21 | 22 | function latestRoundData() external view returns ( 23 | uint80 roundId, 24 | int256 answer, 25 | uint256 startedAt, 26 | uint256 updatedAt, 27 | uint80 answeredInRound 28 | ) { 29 | return (0, latestAnswer, 0, 0, 0); 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /test/FixedPriceOracle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { FixedPriceOracle } from "../src/FixedPriceOracle.sol"; 7 | 8 | contract FixedPriceOracleTest is Test { 9 | 10 | FixedPriceOracle oracle; 11 | 12 | function setUp() public { 13 | oracle = new FixedPriceOracle(123e8); 14 | } 15 | 16 | function test_constructor() public { 17 | assertEq(oracle.price(), 123e8); 18 | assertEq(oracle.decimals(), 8); 19 | } 20 | 21 | function test_bad_price_values() public { 22 | vm.expectRevert("FixedPriceOracle/invalid-price"); 23 | new FixedPriceOracle(0); 24 | 25 | vm.expectRevert("FixedPriceOracle/invalid-price"); 26 | new FixedPriceOracle(-1); 27 | } 28 | 29 | function test_latestAnswer() public { 30 | assertEq(oracle.latestAnswer(), 123e8); 31 | } 32 | 33 | } 34 | -------------------------------------------------------------------------------- /src/CappedOracle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IPriceSource } from "./interfaces/IPriceSource.sol"; 5 | 6 | contract CappedOracle { 7 | 8 | IPriceSource public immutable source; 9 | int256 public immutable maxPrice; 10 | 11 | constructor(address _source, int256 _maxPrice) { 12 | // 8 decimals required as AaveOracle assumes this 13 | require(IPriceSource(_source).decimals() == 8, "CappedOracle/invalid-decimals"); 14 | require(_maxPrice > 0, "CappedOracle/invalid-max-price"); 15 | 16 | source = IPriceSource(_source); 17 | maxPrice = _maxPrice; 18 | } 19 | 20 | function latestAnswer() external view returns (int256) { 21 | int256 price = source.latestAnswer(); 22 | 23 | return price < maxPrice ? price : maxPrice; 24 | } 25 | 26 | function decimals() external pure returns (uint8) { 27 | return 8; 28 | } 29 | 30 | } 31 | -------------------------------------------------------------------------------- /test/PotRateSource.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { PotRateSource } from "../src/PotRateSource.sol"; 7 | 8 | contract PotMock { 9 | 10 | uint256 public dsr; 11 | 12 | constructor(uint256 _dsr) { 13 | dsr = _dsr; 14 | } 15 | 16 | function setDSR(uint256 _dsr) external { 17 | dsr = _dsr; 18 | } 19 | 20 | } 21 | 22 | contract PotRateSourceTest is Test { 23 | 24 | // To calculate: bc -l <<< 'scale=27; e( l(1.05)/(60 * 60 * 24 * 365) )' 25 | uint256 constant FIVE_PCT_APY_DSR = 1.000000001547125957863212448e27; 26 | uint256 constant FIVE_PCT_APY_APR = 0.048790164207174267760128000e27; 27 | 28 | PotMock pot; 29 | 30 | PotRateSource rateSource; 31 | 32 | function setUp() public { 33 | pot = new PotMock(FIVE_PCT_APY_DSR); 34 | 35 | rateSource = new PotRateSource(address(pot)); 36 | } 37 | 38 | function test_constructor() public { 39 | assertEq(address(rateSource.pot()), address(pot)); 40 | assertEq(rateSource.decimals(), 27); 41 | } 42 | 43 | function test_bad_dsr_value() public { 44 | pot.setDSR(1e27 - 1); 45 | 46 | vm.expectRevert(stdError.arithmeticError); 47 | rateSource.getAPR(); 48 | } 49 | 50 | function test_getAPR() public { 51 | assertEq(rateSource.getAPR(), FIVE_PCT_APY_APR); 52 | 53 | pot.setDSR(1e27); 54 | 55 | assertEq(rateSource.getAPR(), 0); 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /test/SSRRateSource.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { SSRRateSource } from "../src/SSRRateSource.sol"; 7 | 8 | contract SUSDSMock { 9 | 10 | uint256 public ssr; 11 | 12 | constructor(uint256 _ssr) { 13 | ssr = _ssr; 14 | } 15 | 16 | function setSSR(uint256 _ssr) external { 17 | ssr = _ssr; 18 | } 19 | 20 | } 21 | 22 | contract SSRRateSourceTest is Test { 23 | 24 | // To calculate: bc -l <<< 'scale=27; e( l(1.05)/(60 * 60 * 24 * 365) )' 25 | uint256 constant FIVE_PCT_APY_SSR = 1.000000001547125957863212448e27; 26 | uint256 constant FIVE_PCT_APY_APR = 0.048790164207174267760128000e27; 27 | 28 | SUSDSMock susds; 29 | 30 | SSRRateSource rateSource; 31 | 32 | function setUp() public { 33 | susds = new SUSDSMock(FIVE_PCT_APY_SSR); 34 | 35 | rateSource = new SSRRateSource(address(susds)); 36 | } 37 | 38 | function test_constructor() public { 39 | assertEq(address(rateSource.susds()), address(susds)); 40 | assertEq(rateSource.decimals(), 27); 41 | } 42 | 43 | function test_bad_ssr_value() public { 44 | susds.setSSR(1e27 - 1); 45 | 46 | vm.expectRevert(stdError.arithmeticError); 47 | rateSource.getAPR(); 48 | } 49 | 50 | function test_getAPR() public { 51 | assertEq(rateSource.getAPR(), FIVE_PCT_APY_APR); 52 | 53 | susds.setSSR(1e27); 54 | 55 | assertEq(rateSource.getAPR(), 0); 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /src/RETHExchangeRateOracle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IPriceSource } from "./interfaces/IPriceSource.sol"; 5 | 6 | interface IRocketPoolStakedEth { 7 | function getExchangeRate() external view returns (uint256); 8 | } 9 | 10 | /** 11 | * @title RETHExchangeRateOracle 12 | * @dev Provides rETH / USD by multiplying the rETH exchange rate by ETH / USD. 13 | * This provides a "non-market" price. Any depeg event will be ignored. 14 | */ 15 | contract RETHExchangeRateOracle { 16 | 17 | /// @notice RocketPool staked eth token contract. 18 | IRocketPoolStakedEth public immutable reth; 19 | 20 | /// @notice The price source for ETH / USD. 21 | IPriceSource public immutable ethSource; 22 | 23 | constructor(address _reth, address _ethSource) { 24 | // 8 decimals required as AaveOracle assumes this 25 | require(IPriceSource(_ethSource).decimals() == 8, "RETHExchangeRateOracle/invalid-decimals"); 26 | 27 | reth = IRocketPoolStakedEth(_reth); 28 | ethSource = IPriceSource(_ethSource); 29 | } 30 | 31 | function latestAnswer() external view returns (int256) { 32 | int256 ethUsd = ethSource.latestAnswer(); 33 | int256 exchangeRate = int256(reth.getExchangeRate()); 34 | 35 | if (ethUsd <= 0 || exchangeRate <= 0) { 36 | return 0; 37 | } 38 | 39 | return exchangeRate * ethUsd / 1e18; 40 | } 41 | 42 | function decimals() external pure returns (uint8) { 43 | return 8; 44 | } 45 | 46 | } 47 | -------------------------------------------------------------------------------- /src/WEETHExchangeRateOracle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IPriceSource } from "./interfaces/IPriceSource.sol"; 5 | 6 | interface IWrappedEtherfiRestakedEth { 7 | function getRate() external view returns (uint256); 8 | } 9 | 10 | /** 11 | * @title WEETHExchangeRateOracle 12 | * @dev Provides weETH / USD by multiplying the weETH exchange rate by ETH / USD. 13 | * This provides a "non-market" price. Any depeg event will be ignored. 14 | */ 15 | contract WEETHExchangeRateOracle { 16 | 17 | /// @notice Etherfi restaked wrapped eth token contract. 18 | IWrappedEtherfiRestakedEth public immutable weeth; 19 | 20 | /// @notice The price source for ETH / USD. 21 | IPriceSource public immutable ethSource; 22 | 23 | constructor(address _weeth, address _ethSource) { 24 | // 8 decimals required as AaveOracle assumes this 25 | require(IPriceSource(_ethSource).decimals() == 8, "WEETHExchangeRateOracle/invalid-decimals"); 26 | 27 | weeth = IWrappedEtherfiRestakedEth(_weeth); 28 | ethSource = IPriceSource(_ethSource); 29 | } 30 | 31 | function latestAnswer() external view returns (int256) { 32 | int256 ethUsd = ethSource.latestAnswer(); 33 | int256 exchangeRate = int256(weeth.getRate()); 34 | 35 | if (ethUsd <= 0 || exchangeRate <= 0) { 36 | return 0; 37 | } 38 | 39 | return exchangeRate * ethUsd / 1e18; 40 | } 41 | 42 | function decimals() external pure returns (uint8) { 43 | return 8; 44 | } 45 | 46 | } 47 | -------------------------------------------------------------------------------- /src/WSTETHExchangeRateOracle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IPriceSource } from "./interfaces/IPriceSource.sol"; 5 | 6 | interface ILidoStakedEth { 7 | function getPooledEthByShares(uint256 shares) external view returns (uint256); 8 | } 9 | 10 | /** 11 | * @title WSTETHExchangeRateOracle 12 | * @dev Provides wstETH / USD by multiplying the wstETH exchange rate by ETH / USD. 13 | * This provides a "non-market" price. Any depeg event will be ignored. 14 | */ 15 | contract WSTETHExchangeRateOracle { 16 | 17 | /// @notice Lido staked eth token contract. 18 | ILidoStakedEth public immutable steth; 19 | 20 | /// @notice The price source for ETH / USD. 21 | IPriceSource public immutable ethSource; 22 | 23 | constructor(address _steth, address _ethSource) { 24 | // 8 decimals required as AaveOracle assumes this 25 | require(IPriceSource(_ethSource).decimals() == 8, "WSTETHExchangeRateOracle/invalid-decimals"); 26 | 27 | steth = ILidoStakedEth(_steth); 28 | ethSource = IPriceSource(_ethSource); 29 | } 30 | 31 | function latestAnswer() external view returns (int256) { 32 | int256 ethUsd = ethSource.latestAnswer(); 33 | int256 exchangeRate = int256(steth.getPooledEthByShares(1e18)); 34 | 35 | if (ethUsd <= 0 || exchangeRate <= 0) { 36 | return 0; 37 | } 38 | 39 | return exchangeRate * ethUsd / 1e18; 40 | } 41 | 42 | function decimals() external pure returns (uint8) { 43 | return 8; 44 | } 45 | 46 | } 47 | -------------------------------------------------------------------------------- /src/RSETHExchangeRateOracle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IPriceSource } from "./interfaces/IPriceSource.sol"; 5 | 6 | interface IKelpDAORestakedEthOracle { 7 | function rsETHPrice() external view returns (uint256); 8 | } 9 | 10 | /** 11 | * @title RSETHExchangeRateOracle 12 | * @dev Provides rsETH / USD by multiplying the rsETH exchange rate by ETH / USD. 13 | * This provides a "non-market" price. Any depeg event will be ignored. 14 | */ 15 | contract RSETHExchangeRateOracle { 16 | 17 | /// @notice KelpDAO restaked eth rate source oracle contract. 18 | IKelpDAORestakedEthOracle public immutable oracle; 19 | 20 | /// @notice The price source for ETH / USD. 21 | IPriceSource public immutable ethSource; 22 | 23 | constructor(address _oracle, address _ethSource) { 24 | // 8 decimals required as AaveOracle assumes this 25 | require(IPriceSource(_ethSource).decimals() == 8, "RSETHExchangeRateOracle/invalid-decimals"); 26 | 27 | oracle = IKelpDAORestakedEthOracle(_oracle); 28 | ethSource = IPriceSource(_ethSource); 29 | } 30 | 31 | function latestAnswer() external view returns (int256) { 32 | int256 ethUsd = ethSource.latestAnswer(); 33 | int256 exchangeRate = int256(oracle.rsETHPrice()); 34 | 35 | if (ethUsd <= 0 || exchangeRate <= 0) { 36 | return 0; 37 | } 38 | 39 | return exchangeRate * ethUsd / 1e18; 40 | } 41 | 42 | function decimals() external pure returns (uint8) { 43 | return 8; 44 | } 45 | 46 | } 47 | -------------------------------------------------------------------------------- /src/MorphoUpgradableOracle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { Ownable } from "lib/openzeppelin-contracts/contracts/access/Ownable.sol"; 5 | 6 | import { AggregatorV3Interface } from "./interfaces/AggregatorV3Interface.sol"; 7 | 8 | /** 9 | * @title MorphoUpgradableOracle 10 | * @notice An oracle which allows changing the source. 11 | * @dev Can be used as a Morpho Blue price feed. Interface is restricted to what Morpho Blue needs. 12 | * https://github.com/morpho-org/morpho-blue-oracles/blob/07a9a6988b0e1b316ac2fa97ec62ad485fbd0041/src/morpho-chainlink/libraries/ChainlinkDataFeedLib.sol 13 | */ 14 | contract MorphoUpgradableOracle is Ownable { 15 | 16 | event SourceChanged(address indexed oldSource, address indexed newSource); 17 | 18 | AggregatorV3Interface public source; 19 | 20 | constructor(address _owner, address _source) Ownable(_owner) { 21 | source = AggregatorV3Interface(_source); 22 | emit SourceChanged(address(0), _source); 23 | } 24 | 25 | function setSource(address _source) external onlyOwner { 26 | emit SourceChanged(address(source), _source); 27 | source = AggregatorV3Interface(_source); 28 | } 29 | 30 | function decimals() external view returns (uint8) { 31 | return source.decimals(); 32 | } 33 | 34 | function latestRoundData() external view returns ( 35 | uint80 roundId, 36 | int256 answer, 37 | uint256 startedAt, 38 | uint256 updatedAt, 39 | uint80 answeredInRound 40 | ) { 41 | (, answer,,,) = source.latestRoundData(); 42 | } 43 | 44 | } 45 | -------------------------------------------------------------------------------- /src/EZETHExchangeRateOracle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IPriceSource } from "./interfaces/IPriceSource.sol"; 5 | 6 | interface IEZETHExchangeRateOracle { 7 | function calculateTVLs() external view returns (uint256[][] memory, uint256[] memory, uint256); 8 | function ezETH() external view returns (address); 9 | } 10 | 11 | interface IEZETH { 12 | function totalSupply() external view returns (uint256); 13 | } 14 | 15 | /** 16 | * @title EZETHExchangeRateOracle 17 | * @dev Provides ezETH / USD by multiplying the ezETH exchange rate by ETH / USD. 18 | * This provides a "non-market" price. Any depeg event will be ignored. 19 | */ 20 | contract EZETHExchangeRateOracle { 21 | 22 | /// @notice Renzo restaked eth rate source oracle contract. 23 | IEZETHExchangeRateOracle public immutable oracle; 24 | 25 | /// @notice Renzo restaked eth token contract. 26 | IEZETH public immutable ezETH; 27 | 28 | /// @notice The price source for ETH / USD. 29 | IPriceSource public immutable ethSource; 30 | 31 | constructor(address _oracle, address _ethSource) { 32 | // 8 decimals required as AaveOracle assumes this 33 | require(IPriceSource(_ethSource).decimals() == 8, "EZETHExchangeRateOracle/invalid-decimals"); 34 | 35 | oracle = IEZETHExchangeRateOracle(_oracle); 36 | ezETH = IEZETH(oracle.ezETH()); 37 | ethSource = IPriceSource(_ethSource); 38 | } 39 | 40 | function latestAnswer() external view returns (int256) { 41 | int256 ethUsd = ethSource.latestAnswer(); 42 | ( ,, uint256 tvl ) = oracle.calculateTVLs(); 43 | int256 exchangeRate = int256(tvl * 1e18 / ezETH.totalSupply()); 44 | 45 | if (ethUsd <= 0 || exchangeRate <= 0) { 46 | return 0; 47 | } 48 | 49 | return exchangeRate * ethUsd / 1e18; 50 | } 51 | 52 | function decimals() external pure returns (uint8) { 53 | return 8; 54 | } 55 | 56 | } 57 | -------------------------------------------------------------------------------- /test/VariableBorrowInterestRateStrategy.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "./InterestRateStrategyBase.t.sol"; 5 | 6 | import { RateSourceMock } from "./mocks/RateSourceMock.sol"; 7 | 8 | import { 9 | VariableBorrowInterestRateStrategy, 10 | IPoolAddressesProvider 11 | } from "../src/VariableBorrowInterestRateStrategy.sol"; 12 | 13 | contract VariableBorrowInterestRateStrategyTest is InterestRateStrategyBaseTest { 14 | 15 | VariableBorrowInterestRateStrategy interestStrategy; 16 | 17 | function setUp() public { 18 | interestStrategy = new VariableBorrowInterestRateStrategy({ 19 | provider: IPoolAddressesProvider(address(123)), 20 | optimalUsageRatio: 0.8e27, 21 | baseVariableBorrowRate: 0.005e27, 22 | variableRateSlope1: 0.01e27, 23 | variableRateSlope2: 0.45e27 24 | }); 25 | 26 | initBase(interestStrategy); 27 | } 28 | 29 | function test_constructor() public { 30 | assertEq(address(interestStrategy.ADDRESSES_PROVIDER()), address(123)); 31 | 32 | assertEq(interestStrategy.OPTIMAL_USAGE_RATIO(), 0.8e27); 33 | assertEq(interestStrategy.OPTIMAL_STABLE_TO_TOTAL_DEBT_RATIO(), 0); 34 | assertEq(interestStrategy.MAX_EXCESS_USAGE_RATIO(), 0.2e27); 35 | assertEq(interestStrategy.MAX_EXCESS_STABLE_TO_TOTAL_DEBT_RATIO(), 1e27); 36 | 37 | assertEq(interestStrategy.getVariableRateSlope1(), 0.01e27); 38 | assertEq(interestStrategy.getVariableRateSlope2(), 0.45e27); 39 | assertEq(interestStrategy.getStableRateSlope1(), 0); 40 | assertEq(interestStrategy.getStableRateSlope2(), 0); 41 | assertEq(interestStrategy.getStableRateExcessOffset(), 0); 42 | assertEq(interestStrategy.getBaseStableBorrowRate(), 0.01e27); 43 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.005e27); 44 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.465e27); 45 | } 46 | 47 | } 48 | -------------------------------------------------------------------------------- /src/CappedFallbackRateSource.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IRateSource } from "./interfaces/IRateSource.sol"; 5 | 6 | /** 7 | * @title CappedFallbackRateSource 8 | * @notice Wraps another rate source, caps the rate and protects against reverts with a fallback value. 9 | */ 10 | contract CappedFallbackRateSource is IRateSource { 11 | 12 | IRateSource public immutable source; 13 | uint256 public immutable lowerBound; 14 | uint256 public immutable upperBound; 15 | uint256 public immutable defaultRate; 16 | 17 | constructor( 18 | address _source, 19 | uint256 _lowerBound, 20 | uint256 _upperBound, 21 | uint256 _defaultRate 22 | ) { 23 | require(_lowerBound <= _upperBound, "CappedFallbackRateSource/invalid-bounds"); 24 | require(_defaultRate >= _lowerBound && _defaultRate <= _upperBound, "CappedFallbackRateSource/invalid-default-rate"); 25 | 26 | source = IRateSource(_source); 27 | lowerBound = _lowerBound; 28 | upperBound = _upperBound; 29 | defaultRate = _defaultRate; 30 | } 31 | 32 | function getAPR() external override view returns (uint256) { 33 | try source.getAPR() returns (uint256 rate) { 34 | if (rate < lowerBound) return lowerBound; 35 | else if (rate > upperBound) return upperBound; 36 | 37 | return rate; 38 | } catch (bytes memory err) { 39 | // This is a special case where you can trigger the catch in the try-catch by messing with the gas limit to 40 | // revert with out of gas (OOG) inside the inner loop. The refund may be enough to cover the remainder of 41 | // the execution so we need to check that the revert error is not empty (OOG) to prevent abuse. 42 | require(err.length > 0, "CappedFallbackRateSource/zero-length-error"); 43 | 44 | return defaultRate; 45 | } 46 | } 47 | 48 | function decimals() external view override returns (uint8) { 49 | return source.decimals(); 50 | } 51 | 52 | } 53 | -------------------------------------------------------------------------------- /test/ExchangeRateOracleAttack.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { IAaveOracle } from "sparklend-v1-core/interfaces/IAaveOracle.sol"; 7 | 8 | import { Ethereum } from "lib/sparklend-address-registry/src/Ethereum.sol"; 9 | 10 | import { WEETHExchangeRateOracle } from "src/WEETHExchangeRateOracle.sol"; 11 | 12 | interface IWEETH { 13 | function getEETHByWeETH(uint256 amount) external view returns (uint256); 14 | } 15 | 16 | interface IEETH { 17 | function burnShares(address user, uint256 shares) external; 18 | } 19 | 20 | contract ExchangeRateOracleAttackBase is Test { 21 | 22 | WEETHExchangeRateOracle oracle; 23 | 24 | address EETH = 0x35fA164735182de50811E8e2E824cFb9B6118ac2; 25 | address EETH_WHALE = 0x1de713F78aA5f29874bBcc95e125721F002Da7f2; 26 | address ETHUSD_ORACLE = 0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419; 27 | address WEETH = 0xCd5fE23C85820F7B72D0926FC9b05b43E359b7ee; 28 | 29 | IAaveOracle aaveOracle = IAaveOracle(Ethereum.AAVE_ORACLE); 30 | IEETH eeth = IEETH(EETH); 31 | IWEETH weeth = IWEETH(WEETH); 32 | 33 | function test_attack() public { 34 | vm.createSelectFork(getChain("mainnet").rpcUrl, 19895484); // May 18, 2024 35 | 36 | oracle = new WEETHExchangeRateOracle(WEETH, ETHUSD_ORACLE); 37 | 38 | address[] memory assets = new address[](1); 39 | assets[0] = WEETH; 40 | address[] memory sources = new address[](1); 41 | sources[0] = address(oracle); 42 | 43 | vm.prank(Ethereum.SPARK_PROXY); 44 | aaveOracle.setAssetSources( 45 | assets, 46 | sources 47 | ); 48 | 49 | uint256 price = 3225.32665359e8; 50 | 51 | assertEq(weeth.getEETHByWeETH((1e18)), 1.038650846493764559e18); 52 | 53 | assertEq(aaveOracle.getAssetPrice(WEETH), price); 54 | assertEq(aaveOracle.getSourceOfAsset(WEETH), address(oracle)); 55 | 56 | // Have to burn 10k shares to change exchange rate by 1% 57 | vm.prank(EETH_WHALE); 58 | eeth.burnShares(EETH_WHALE, 10_000e18); 59 | 60 | assertEq(weeth.getEETHByWeETH((1e18)), 1.046247736567006321e18); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /test/CappedOracle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { PriceSourceMock } from "./mocks/PriceSourceMock.sol"; 7 | 8 | import { CappedOracle } from "../src/CappedOracle.sol"; 9 | 10 | contract CappedOracleTest is Test { 11 | 12 | PriceSourceMock priceSource; 13 | 14 | CappedOracle oracle; 15 | 16 | function setUp() public { 17 | priceSource = new PriceSourceMock(0.8e8, 8); 18 | oracle = new CappedOracle(address(priceSource), 1e8); 19 | } 20 | 21 | function test_constructor() public { 22 | assertEq(oracle.latestAnswer(), 0.8e8); 23 | assertEq(oracle.decimals(), 8); 24 | 25 | assertEq(address(oracle.source()), address(priceSource)); 26 | } 27 | 28 | function test_invalid_decimals() public { 29 | priceSource.setLatestAnswer(0.8e18); 30 | priceSource.setDecimals(18); 31 | vm.expectRevert("CappedOracle/invalid-decimals"); 32 | new CappedOracle(address(priceSource), 1e18); 33 | } 34 | 35 | function test_maxPrice_invalid() public { 36 | vm.expectRevert("CappedOracle/invalid-max-price"); 37 | new CappedOracle(address(priceSource), 0); 38 | 39 | vm.expectRevert("CappedOracle/invalid-max-price"); 40 | new CappedOracle(address(priceSource), -1); 41 | } 42 | 43 | function test_price_at_max() public { 44 | assertEq(oracle.latestAnswer(), 0.8e8); 45 | priceSource.setLatestAnswer(1e8); 46 | assertEq(oracle.latestAnswer(), 1e8); 47 | } 48 | 49 | function test_price_above_max() public { 50 | assertEq(oracle.latestAnswer(), 0.8e8); 51 | priceSource.setLatestAnswer(1e8 + 1); 52 | assertEq(oracle.latestAnswer(), 1e8); 53 | } 54 | 55 | function test_price_below_max() public { 56 | assertEq(oracle.latestAnswer(), 0.8e8); 57 | priceSource.setLatestAnswer(1e8 - 1); 58 | assertEq(oracle.latestAnswer(), 1e8 - 1); 59 | } 60 | 61 | function test_price_below_zero() public { 62 | // This below zero behaviour will carry through 63 | assertEq(oracle.latestAnswer(), 0.8e8); 64 | priceSource.setLatestAnswer(-1e8); 65 | assertEq(oracle.latestAnswer(), -1e8); 66 | } 67 | 68 | } 69 | -------------------------------------------------------------------------------- /src/RateTargetBaseInterestRateStrategy.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IRateSource } from './interfaces/IRateSource.sol'; 5 | 6 | import { 7 | VariableBorrowInterestRateStrategy, 8 | IPoolAddressesProvider 9 | } from './VariableBorrowInterestRateStrategy.sol'; 10 | 11 | /** 12 | * @title RateTargetBaseInterestRateStrategy 13 | * @notice Sets the base interest rate as a fixed spread from a rate source. 14 | */ 15 | contract RateTargetBaseInterestRateStrategy is VariableBorrowInterestRateStrategy { 16 | 17 | IRateSource public immutable RATE_SOURCE; 18 | 19 | // Base variable borrow rate spread when usage rate = 0. Expressed in ray. 20 | uint256 internal immutable _baseVariableBorrowRateSpread; 21 | 22 | /** 23 | * @dev Constructor. 24 | * @param provider The address of the PoolAddressesProvider contract. 25 | * @param rateSource The address of the rate source contract. 26 | * @param optimalUsageRatio The optimal usage ratio. 27 | * @param baseVariableBorrowRateSpread The base variable borrow rate spread. 28 | * @param variableRateSlope1 The variable rate slope below optimal usage ratio. 29 | * @param variableRateSlope2 The variable rate slope above optimal usage ratio. 30 | */ 31 | constructor( 32 | IPoolAddressesProvider provider, 33 | address rateSource, 34 | uint256 optimalUsageRatio, 35 | uint256 baseVariableBorrowRateSpread, 36 | uint256 variableRateSlope1, 37 | uint256 variableRateSlope2 38 | ) VariableBorrowInterestRateStrategy( 39 | provider, 40 | optimalUsageRatio, 41 | 0, 42 | variableRateSlope1, 43 | variableRateSlope2 44 | ) { 45 | RATE_SOURCE = IRateSource(rateSource); 46 | require(RATE_SOURCE.decimals() <= 27, "RateTargetBaseInterestRateStrategy/invalid-rate-source-decimals"); 47 | 48 | _baseVariableBorrowRateSpread = baseVariableBorrowRateSpread; 49 | } 50 | 51 | function _getBaseVariableBorrowRate() internal override view returns (uint256) { 52 | uint256 apr = RATE_SOURCE.getAPR() * 10 ** (27 - RATE_SOURCE.decimals()); 53 | return apr + _baseVariableBorrowRateSpread; 54 | } 55 | 56 | function getBaseVariableBorrowRateSpread() external view returns (uint256) { 57 | return _baseVariableBorrowRateSpread; 58 | } 59 | 60 | } 61 | -------------------------------------------------------------------------------- /test/MorphoUpgradableOracle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { PriceSourceMock } from "./mocks/PriceSourceMock.sol"; 7 | 8 | import { MorphoUpgradableOracle } from "../src/MorphoUpgradableOracle.sol"; 9 | 10 | contract MorphoUpgradableOracleTest is Test { 11 | 12 | event SourceChanged(address indexed oldSource, address indexed newSource); 13 | event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); 14 | 15 | address owner = makeAddr("owner"); 16 | 17 | PriceSourceMock priceSource1; 18 | PriceSourceMock priceSource2; 19 | 20 | MorphoUpgradableOracle oracle; 21 | 22 | function setUp() public { 23 | priceSource1 = new PriceSourceMock(123e8, 8); 24 | priceSource2 = new PriceSourceMock(456e18, 18); 25 | 26 | oracle = new MorphoUpgradableOracle(owner, address(priceSource1)); 27 | } 28 | 29 | function test_constructor() public { 30 | vm.expectEmit(); 31 | emit OwnershipTransferred(address(0), owner); 32 | vm.expectEmit(); 33 | emit SourceChanged(address(0), address(priceSource1)); 34 | oracle = new MorphoUpgradableOracle(owner, address(priceSource1)); 35 | 36 | assertEq(address(oracle.owner()), owner); 37 | assertEq(address(oracle.source()), address(priceSource1)); 38 | } 39 | 40 | function test_setSource_notOwner() public { 41 | vm.expectRevert(abi.encodeWithSignature('OwnableUnauthorizedAccount(address)', address(this))); 42 | oracle.setSource(address(priceSource2)); 43 | } 44 | 45 | function test_setSource() public { 46 | assertEq(address(oracle.source()), address(priceSource1)); 47 | assertEq(oracle.decimals(), 8); 48 | assertEq(oracle.decimals(), priceSource1.decimals()); 49 | (, int256 answer,,,) = oracle.latestRoundData(); 50 | assertEq(answer, 123e8); 51 | 52 | vm.expectEmit(address(oracle)); 53 | emit SourceChanged(address(priceSource1), address(priceSource2)); 54 | vm.prank(owner); 55 | oracle.setSource(address(priceSource2)); 56 | 57 | assertEq(address(oracle.source()), address(priceSource2)); 58 | assertEq(oracle.decimals(), 18); 59 | assertEq(oracle.decimals(), priceSource2.decimals()); 60 | (, answer,,,) = oracle.latestRoundData(); 61 | assertEq(answer, 456e18); 62 | } 63 | 64 | } 65 | -------------------------------------------------------------------------------- /src/RateTargetKinkInterestRateStrategy.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import { IRateSource } from './interfaces/IRateSource.sol'; 5 | 6 | import { 7 | VariableBorrowInterestRateStrategy, 8 | IPoolAddressesProvider 9 | } from './VariableBorrowInterestRateStrategy.sol'; 10 | 11 | /** 12 | * @title RateTargetKinkInterestRateStrategy 13 | * @notice Sets the kink interest rate as a fixed spread from a rate source. 14 | */ 15 | contract RateTargetKinkInterestRateStrategy is VariableBorrowInterestRateStrategy { 16 | 17 | IRateSource public immutable RATE_SOURCE; 18 | 19 | // Slope spread of the variable interest curve when usage ratio > 0 and <= OPTIMAL_USAGE_RATIO. Expressed in ray. 20 | int256 internal immutable _variableRateSlope1Spread; 21 | 22 | /** 23 | * @dev Constructor. 24 | * @param provider The address of the PoolAddressesProvider contract. 25 | * @param rateSource The address of the rate source contract. 26 | * @param optimalUsageRatio The optimal usage ratio. 27 | * @param baseVariableBorrowRate The base variable borrow rate. 28 | * @param variableRateSlope1Spread The spread between the rate source and the desired target kink rate. 29 | * Note: This discounts the base variable borrow rate. 30 | * @param variableRateSlope2 The variable rate slope above optimal usage ratio. 31 | */ 32 | constructor( 33 | IPoolAddressesProvider provider, 34 | address rateSource, 35 | uint256 optimalUsageRatio, 36 | uint256 baseVariableBorrowRate, 37 | int256 variableRateSlope1Spread, 38 | uint256 variableRateSlope2 39 | ) VariableBorrowInterestRateStrategy( 40 | provider, 41 | optimalUsageRatio, 42 | baseVariableBorrowRate, 43 | 0, 44 | variableRateSlope2 45 | ) { 46 | RATE_SOURCE = IRateSource(rateSource); 47 | require(RATE_SOURCE.decimals() <= 27, "RateTargetKinkInterestRateStrategy/invalid-rate-source-decimals"); 48 | 49 | _variableRateSlope1Spread = variableRateSlope1Spread; 50 | } 51 | 52 | function _getVariableRateSlope1() internal override view returns (uint256) { 53 | // We assume all rates are below max int. This is a reasonable assumption because 54 | // otherwise the rates will be so high that the protocol will stop working 55 | int256 rate = int256(RATE_SOURCE.getAPR() * 10 ** (27 - RATE_SOURCE.decimals())) + _variableRateSlope1Spread - int256(_baseVariableBorrowRate); 56 | return rate > 0 ? uint256(rate) : 0; 57 | } 58 | 59 | function getVariableRateSlope1Spread() external view returns (int256) { 60 | return _variableRateSlope1Spread; 61 | } 62 | 63 | } 64 | -------------------------------------------------------------------------------- /test/WSTETHExchangeRateOracle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { PriceSourceMock } from "./mocks/PriceSourceMock.sol"; 7 | 8 | import { WSTETHExchangeRateOracle } from "../src/WSTETHExchangeRateOracle.sol"; 9 | 10 | contract STETHMock { 11 | 12 | uint256 exchangeRate; 13 | 14 | constructor(uint256 _exchangeRate) { 15 | exchangeRate = _exchangeRate; 16 | } 17 | 18 | function getPooledEthByShares(uint256 amount) external view returns (uint256) { 19 | return exchangeRate * amount / 1e18; 20 | } 21 | 22 | function setExchangeRate(uint256 _exchangeRate) external { 23 | exchangeRate = _exchangeRate; 24 | } 25 | 26 | } 27 | 28 | contract WSTETHExchangeRateOracleTest is Test { 29 | 30 | STETHMock steth; 31 | PriceSourceMock ethSource; 32 | 33 | WSTETHExchangeRateOracle oracle; 34 | 35 | function setUp() public { 36 | steth = new STETHMock(1.2e18); 37 | ethSource = new PriceSourceMock(2000e8, 8); 38 | oracle = new WSTETHExchangeRateOracle(address(steth), address(ethSource)); 39 | } 40 | 41 | function test_constructor() public { 42 | assertEq(address(oracle.steth()), address(steth)); 43 | assertEq(address(oracle.ethSource()), address(ethSource)); 44 | assertEq(oracle.decimals(), 8); 45 | } 46 | 47 | function test_invalid_decimals() public { 48 | ethSource.setLatestAnswer(2000e18); 49 | ethSource.setDecimals(18); 50 | vm.expectRevert("WSTETHExchangeRateOracle/invalid-decimals"); 51 | new WSTETHExchangeRateOracle(address(steth), address(ethSource)); 52 | } 53 | 54 | function test_latestAnswer_zeroEthUsd() public { 55 | ethSource.setLatestAnswer(0); 56 | assertEq(oracle.latestAnswer(), 0); 57 | } 58 | 59 | function test_latestAnswer_negativeEthUsd() public { 60 | ethSource.setLatestAnswer(-1); 61 | assertEq(oracle.latestAnswer(), 0); 62 | } 63 | 64 | function test_latestAnswer_zeroExchangeRate() public { 65 | steth.setExchangeRate(0); 66 | assertEq(oracle.latestAnswer(), 0); 67 | } 68 | 69 | // Note: Exchange rate cannot overflow to negative because it multiplies by 70 | // the _sharesAmount parameter and divides by total shares. 71 | 72 | function test_latestAnswer() public { 73 | // 1.2 * 2000 = 2400 74 | assertEq(oracle.latestAnswer(), 2400e8); 75 | 76 | // 1 * 2000 = 2000 77 | steth.setExchangeRate(1e18); 78 | assertEq(oracle.latestAnswer(), 2000e8); 79 | 80 | // 0.5 * 1200 = 600 81 | steth.setExchangeRate(0.5e18); 82 | ethSource.setLatestAnswer(1200e8); 83 | assertEq(oracle.latestAnswer(), 600e8); 84 | } 85 | 86 | } 87 | -------------------------------------------------------------------------------- /test/RETHExchangeRateOracle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { PriceSourceMock } from "./mocks/PriceSourceMock.sol"; 7 | 8 | import { RETHExchangeRateOracle } from "../src/RETHExchangeRateOracle.sol"; 9 | 10 | contract RETHMock { 11 | 12 | uint256 exchangeRate; 13 | 14 | constructor(uint256 _exchangeRate) { 15 | exchangeRate = _exchangeRate; 16 | } 17 | 18 | function getExchangeRate() external view returns (uint256) { 19 | return exchangeRate; 20 | } 21 | 22 | function setExchangeRate(uint256 _exchangeRate) external { 23 | exchangeRate = _exchangeRate; 24 | } 25 | 26 | } 27 | 28 | contract RETHExchangeRateOracleTest is Test { 29 | 30 | RETHMock reth; 31 | PriceSourceMock ethSource; 32 | 33 | RETHExchangeRateOracle oracle; 34 | 35 | function setUp() public { 36 | reth = new RETHMock(1.2e18); 37 | ethSource = new PriceSourceMock(2000e8, 8); 38 | oracle = new RETHExchangeRateOracle(address(reth), address(ethSource)); 39 | } 40 | 41 | function test_constructor() public { 42 | assertEq(address(oracle.reth()), address(reth)); 43 | assertEq(address(oracle.ethSource()), address(ethSource)); 44 | assertEq(oracle.decimals(), 8); 45 | } 46 | 47 | function test_invalid_decimals() public { 48 | ethSource.setLatestAnswer(2000e18); 49 | ethSource.setDecimals(18); 50 | vm.expectRevert("RETHExchangeRateOracle/invalid-decimals"); 51 | new RETHExchangeRateOracle(address(reth), address(ethSource)); 52 | } 53 | 54 | function test_latestAnswer_zeroEthUsd() public { 55 | ethSource.setLatestAnswer(0); 56 | assertEq(oracle.latestAnswer(), 0); 57 | } 58 | 59 | function test_latestAnswer_negativeEthUsd() public { 60 | ethSource.setLatestAnswer(-1); 61 | assertEq(oracle.latestAnswer(), 0); 62 | } 63 | 64 | function test_latestAnswer_zeroExchangeRate() public { 65 | reth.setExchangeRate(0); 66 | assertEq(oracle.latestAnswer(), 0); 67 | } 68 | 69 | function test_latestAnswer_negativeExchangeRate() public { 70 | // RETH ER can't go negative, but it can have a silent overflow 71 | assertLt(int256(uint256(int256(-1))), 0); 72 | reth.setExchangeRate(uint256(int256(-1))); 73 | assertEq(oracle.latestAnswer(), 0); 74 | } 75 | 76 | function test_latestAnswer() public { 77 | // 1.2 * 2000 = 2400 78 | assertEq(oracle.latestAnswer(), 2400e8); 79 | 80 | // 1 * 2000 = 2000 81 | reth.setExchangeRate(1e18); 82 | assertEq(oracle.latestAnswer(), 2000e8); 83 | 84 | // 0.5 * 1200 = 600 85 | reth.setExchangeRate(0.5e18); 86 | ethSource.setLatestAnswer(1200e8); 87 | assertEq(oracle.latestAnswer(), 600e8); 88 | } 89 | 90 | } 91 | -------------------------------------------------------------------------------- /test/WEETHExchangeRateOracle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { PriceSourceMock } from "./mocks/PriceSourceMock.sol"; 7 | 8 | import { WEETHExchangeRateOracle } from "../src/WEETHExchangeRateOracle.sol"; 9 | 10 | contract WEETHMock { 11 | 12 | uint256 exchangeRate; 13 | 14 | constructor(uint256 _exchangeRate) { 15 | exchangeRate = _exchangeRate; 16 | } 17 | 18 | function getRate() external view returns (uint256) { 19 | return exchangeRate; 20 | } 21 | 22 | function setExchangeRate(uint256 _exchangeRate) external { 23 | exchangeRate = _exchangeRate; 24 | } 25 | 26 | } 27 | 28 | contract WEETHExchangeRateOracleTest is Test { 29 | 30 | WEETHMock weeth; 31 | PriceSourceMock ethSource; 32 | 33 | WEETHExchangeRateOracle oracle; 34 | 35 | function setUp() public { 36 | weeth = new WEETHMock(1.2e18); 37 | ethSource = new PriceSourceMock(2000e8, 8); 38 | oracle = new WEETHExchangeRateOracle(address(weeth), address(ethSource)); 39 | } 40 | 41 | function test_constructor() public { 42 | assertEq(address(oracle.weeth()), address(weeth)); 43 | assertEq(address(oracle.ethSource()), address(ethSource)); 44 | assertEq(oracle.decimals(), 8); 45 | } 46 | 47 | function test_invalid_decimals() public { 48 | ethSource.setLatestAnswer(2000e18); 49 | ethSource.setDecimals(18); 50 | vm.expectRevert("WEETHExchangeRateOracle/invalid-decimals"); 51 | new WEETHExchangeRateOracle(address(weeth), address(ethSource)); 52 | } 53 | 54 | function test_latestAnswer_zeroEthUsd() public { 55 | ethSource.setLatestAnswer(0); 56 | assertEq(oracle.latestAnswer(), 0); 57 | } 58 | 59 | function test_latestAnswer_negativeEthUsd() public { 60 | ethSource.setLatestAnswer(-1); 61 | assertEq(oracle.latestAnswer(), 0); 62 | } 63 | 64 | function test_latestAnswer_zeroExchangeRate() public { 65 | weeth.setExchangeRate(0); 66 | assertEq(oracle.latestAnswer(), 0); 67 | } 68 | 69 | function test_latestAnswer_negativeExchangeRate() public { 70 | // RETH ER can't go negative, but it can have a silent overflow 71 | assertLt(int256(uint256(int256(-1))), 0); 72 | weeth.setExchangeRate(uint256(int256(-1))); 73 | assertEq(oracle.latestAnswer(), 0); 74 | } 75 | 76 | function test_latestAnswer() public { 77 | // 1.2 * 2000 = 2400 78 | assertEq(oracle.latestAnswer(), 2400e8); 79 | 80 | // 1 * 2000 = 2000 81 | weeth.setExchangeRate(1e18); 82 | assertEq(oracle.latestAnswer(), 2000e8); 83 | 84 | // 0.5 * 1200 = 600 85 | weeth.setExchangeRate(0.5e18); 86 | ethSource.setLatestAnswer(1200e8); 87 | assertEq(oracle.latestAnswer(), 600e8); 88 | } 89 | 90 | } 91 | -------------------------------------------------------------------------------- /test/RSETHExchangeRateOracle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { PriceSourceMock } from "./mocks/PriceSourceMock.sol"; 7 | 8 | import { RSETHExchangeRateOracle } from "../src/RSETHExchangeRateOracle.sol"; 9 | 10 | contract RSETHOracleMock { 11 | 12 | uint256 exchangeRate; 13 | 14 | constructor(uint256 _exchangeRate) { 15 | exchangeRate = _exchangeRate; 16 | } 17 | 18 | function rsETHPrice() external view returns (uint256) { 19 | return exchangeRate; 20 | } 21 | 22 | function setExchangeRate(uint256 _exchangeRate) external { 23 | exchangeRate = _exchangeRate; 24 | } 25 | 26 | } 27 | 28 | contract RSETHExchangeRateOracleTest is Test { 29 | 30 | RSETHOracleMock rsethOracle; 31 | PriceSourceMock ethSource; 32 | 33 | RSETHExchangeRateOracle oracle; 34 | 35 | function setUp() public { 36 | rsethOracle = new RSETHOracleMock(1.2e18); 37 | ethSource = new PriceSourceMock(2000e8, 8); 38 | oracle = new RSETHExchangeRateOracle(address(rsethOracle), address(ethSource)); 39 | } 40 | 41 | function test_constructor() public { 42 | assertEq(address(oracle.oracle()), address(rsethOracle)); 43 | assertEq(address(oracle.ethSource()), address(ethSource)); 44 | assertEq(oracle.decimals(), 8); 45 | } 46 | 47 | function test_invalid_decimals() public { 48 | ethSource.setLatestAnswer(2000e18); 49 | ethSource.setDecimals(18); 50 | vm.expectRevert("RSETHExchangeRateOracle/invalid-decimals"); 51 | new RSETHExchangeRateOracle(address(rsethOracle), address(ethSource)); 52 | } 53 | 54 | function test_latestAnswer_zeroEthUsd() public { 55 | ethSource.setLatestAnswer(0); 56 | assertEq(oracle.latestAnswer(), 0); 57 | } 58 | 59 | function test_latestAnswer_negativeEthUsd() public { 60 | ethSource.setLatestAnswer(-1); 61 | assertEq(oracle.latestAnswer(), 0); 62 | } 63 | 64 | function test_latestAnswer_zeroExchangeRate() public { 65 | rsethOracle.setExchangeRate(0); 66 | assertEq(oracle.latestAnswer(), 0); 67 | } 68 | 69 | function test_latestAnswer_negativeExchangeRate() public { 70 | // RETH ER can't go negative, but it can have a silent overflow 71 | assertLt(int256(uint256(int256(-1))), 0); 72 | rsethOracle.setExchangeRate(uint256(int256(-1))); 73 | assertEq(oracle.latestAnswer(), 0); 74 | } 75 | 76 | function test_latestAnswer() public { 77 | // 1.2 * 2000 = 2400 78 | assertEq(oracle.latestAnswer(), 2400e8); 79 | 80 | // 1 * 2000 = 2000 81 | rsethOracle.setExchangeRate(1e18); 82 | assertEq(oracle.latestAnswer(), 2000e8); 83 | 84 | // 0.5 * 1200 = 600 85 | rsethOracle.setExchangeRate(0.5e18); 86 | ethSource.setLatestAnswer(1200e8); 87 | assertEq(oracle.latestAnswer(), 600e8); 88 | } 89 | 90 | } 91 | -------------------------------------------------------------------------------- /test/EZETHExchangeRateOracle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { PriceSourceMock } from "./mocks/PriceSourceMock.sol"; 7 | 8 | import { EZETHExchangeRateOracle } from "../src/EZETHExchangeRateOracle.sol"; 9 | 10 | // This can be both the oracle and the ezETH token for the purposes of this unit testing contract 11 | contract EZETHOracleMock { 12 | 13 | uint256 exchangeRate; 14 | 15 | constructor(uint256 _exchangeRate) { 16 | exchangeRate = _exchangeRate; 17 | } 18 | 19 | function calculateTVLs() external view returns (uint256[][] memory, uint256[] memory, uint256 _exchangeRate) { 20 | _exchangeRate = exchangeRate; 21 | } 22 | 23 | function totalSupply() external pure returns (uint256) { 24 | return 1e18; 25 | } 26 | 27 | function ezETH() external view returns (address) { 28 | return address(this); 29 | } 30 | 31 | function setExchangeRate(uint256 _exchangeRate) external { 32 | exchangeRate = _exchangeRate; 33 | } 34 | 35 | } 36 | 37 | contract EZETHExchangeRateOracleTest is Test { 38 | 39 | EZETHOracleMock ezethOracle; 40 | PriceSourceMock ethSource; 41 | 42 | EZETHExchangeRateOracle oracle; 43 | 44 | function setUp() public { 45 | ezethOracle = new EZETHOracleMock(1.2e18); 46 | ethSource = new PriceSourceMock(2000e8, 8); 47 | oracle = new EZETHExchangeRateOracle(address(ezethOracle), address(ethSource)); 48 | } 49 | 50 | function test_constructor() public { 51 | assertEq(address(oracle.oracle()), address(ezethOracle)); 52 | assertEq(address(oracle.ethSource()), address(ethSource)); 53 | assertEq(oracle.decimals(), 8); 54 | } 55 | 56 | function test_invalid_decimals() public { 57 | ethSource.setLatestAnswer(2000e18); 58 | ethSource.setDecimals(18); 59 | vm.expectRevert("EZETHExchangeRateOracle/invalid-decimals"); 60 | new EZETHExchangeRateOracle(address(ezethOracle), address(ethSource)); 61 | } 62 | 63 | function test_latestAnswer_zeroEthUsd() public { 64 | ethSource.setLatestAnswer(0); 65 | assertEq(oracle.latestAnswer(), 0); 66 | } 67 | 68 | function test_latestAnswer_negativeEthUsd() public { 69 | ethSource.setLatestAnswer(-1); 70 | assertEq(oracle.latestAnswer(), 0); 71 | } 72 | 73 | function test_latestAnswer_zeroExchangeRate() public { 74 | ezethOracle.setExchangeRate(0); 75 | assertEq(oracle.latestAnswer(), 0); 76 | } 77 | 78 | function test_latestAnswer() public { 79 | // 1.2 * 2000 = 2400 80 | assertEq(oracle.latestAnswer(), 2400e8); 81 | 82 | // 1 * 2000 = 2000 83 | ezethOracle.setExchangeRate(1e18); 84 | assertEq(oracle.latestAnswer(), 2000e8); 85 | 86 | // 0.5 * 1200 = 600 87 | ezethOracle.setExchangeRate(0.5e18); 88 | ethSource.setLatestAnswer(1200e8); 89 | assertEq(oracle.latestAnswer(), 600e8); 90 | } 91 | 92 | } 93 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | push: 7 | branches: 8 | - master 9 | 10 | env: 11 | FOUNDRY_PROFILE: ci 12 | 13 | jobs: 14 | build: 15 | runs-on: ubuntu-latest 16 | steps: 17 | - uses: actions/checkout@v3 18 | 19 | - name: Install Foundry 20 | uses: foundry-rs/foundry-toolchain@v1 21 | 22 | - name: Build contracts 23 | run: | 24 | forge --version 25 | forge build --sizes 26 | 27 | test: 28 | runs-on: ubuntu-latest 29 | steps: 30 | - uses: actions/checkout@v3 31 | 32 | - name: Install Foundry 33 | uses: foundry-rs/foundry-toolchain@v1 34 | 35 | - name: Run tests 36 | env: 37 | MAINNET_RPC_URL: ${{secrets.MAINNET_RPC_URL}} 38 | OPTIMISM_RPC_URL: ${{secrets.OPTIMISM_RPC_URL}} 39 | ARBITRUM_ONE_RPC_URL: ${{secrets.ARBITRUM_ONE_RPC_URL}} 40 | ARBITRUM_NOVA_RPC_URL: ${{secrets.ARBITRUM_NOVA_RPC_URL}} 41 | GNOSIS_CHAIN_RPC_URL: ${{secrets.GNOSIS_CHAIN_RPC_URL}} 42 | BASE_RPC_URL: ${{secrets.BASE_RPC_URL}} 43 | GOERLI_RPC_URL: ${{secrets.GOERLI_RPC_URL}} 44 | run: FOUNDRY_PROFILE=ci forge test 45 | 46 | coverage: 47 | runs-on: ubuntu-latest 48 | steps: 49 | - uses: actions/checkout@v3 50 | 51 | - name: Install Foundry 52 | uses: foundry-rs/foundry-toolchain@v1 53 | 54 | - name: Run coverage 55 | run: forge coverage --report summary --report lcov 56 | 57 | # To ignore coverage for certain directories modify the paths in this step as needed. The 58 | # below default ignores coverage results for the test and script directories. Alternatively, 59 | # to include coverage in all directories, comment out this step. Note that because this 60 | # filtering applies to the lcov file, the summary table generated in the previous step will 61 | # still include all files and directories. 62 | # The `--rc lcov_branch_coverage=1` part keeps branch info in the filtered report, since lcov 63 | # defaults to removing branch info. 64 | - name: Filter directories 65 | run: | 66 | sudo apt update && sudo apt install -y lcov 67 | lcov --remove lcov.info 'test/*' --output-file lcov.info --rc lcov_branch_coverage=1 68 | 69 | # This step posts a detailed coverage report as a comment and deletes previous comments on 70 | # each push. The below step is used to fail coverage if the specified coverage threshold is 71 | # not met. The below step can post a comment (when it's `github-token` is specified) but it's 72 | # not as useful, and this action cannot fail CI based on a minimum coverage threshold, which 73 | # is why we use both in this way. 74 | - name: Post coverage report 75 | if: github.event_name == 'pull_request' # This action fails when ran outside of a pull request. 76 | uses: romeovs/lcov-reporter-action@v0.3.1 77 | with: 78 | delete-old-comments: true 79 | lcov-file: ./lcov.info 80 | github-token: ${{ secrets.GITHUB_TOKEN }} # Adds a coverage summary comment to the PR. 81 | 82 | - name: Verify minimum coverage 83 | uses: zgosalvez/github-actions-report-lcov@v2 84 | with: 85 | coverage-files: ./lcov.info 86 | minimum-coverage: 90 # Set coverage threshold. 87 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SparkLend Advanced Contracts 2 | 3 | This repository contains advanced features to improve SparkLend beyond the core contracts. This repository is mostly focused on improving security and automating governance processes. 4 | 5 | ## Available Contracts 6 | 7 | ### Oracles 8 | 9 | Please note all these oracles are designed for consumption by `AaveOracle` which assumes 8 decimal places. 10 | 11 | [FixedPriceOracle](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/FixedPriceOracle.sol): A hardcoded oracle price that never changes. Used for: DAI/USDC/USDT markets 12 | 13 | [CappedOracle](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/CappedOracle.sol): Returns `min(market price, hardcoded max price)`. Not currently used. 14 | 15 | [WSTETHExchangeRateOracle](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/WSTETHExchangeRateOracle.sol): Provides wstETH/USD by multiplying the wstETH exchange rate by ETH/USD. Used for: wstETH market 16 | 17 | [RETHExchangeRateOracle](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/RETHExchangeRateOracle.sol): Provides rETH/USD by multiplying the rETH exchange rate by ETH/USD. Used for: rETH market 18 | 19 | [WEETHExchangeRateOracle](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/WEETHExchangeRateOracle.sol): Provides weETH/USD by multiplying the weETH exchange rate by ETH/USD. Used for: weETH market 20 | 21 | [RSETHExchangeRateOracle](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/RSETHExchangeRateOracle.sol): Provides rsETH/USD by multiplying the rsETH exchange rate by ETH/USD. Used for: rsETH market 22 | 23 | [EZETHExchangeRateOracle](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/EZETHExchangeRateOracle.sol): Provides ezETH/USD by multiplying the ezETH exchange rate by ETH/USD. Used for: ezETH market 24 | 25 | [MorphoUpgradableOracle](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/MorphoUpgradableOracle.sol): Allows Spark Governance to change an oracle for Morpho Blue markets. Planned to be used in Morpho Blue. 26 | 27 | ### Custom Interest Rate Strategies 28 | 29 | [VariableBorrowInterestRateStrategy](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/VariableBorrowInterestRateStrategy.sol): Modified version of `DefaultReserveInterestRateStrategy` that removes the stable borrow logic. 30 | 31 | [RateTargetBaseInterestRateStrategy](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/RateTargetBaseInterestRateStrategy.sol): Overridden version of `VariableBorrowInterestRateStrategy` that sets the base variable borrow rate to match an external rate source with a fixed spread. Used for: DAI market 32 | 33 | [RateTargetKinkInterestRateStrategy](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/RateTargetKinkInterestRateStrategy.sol): Overridden version of `VariableBorrowInterestRateStrategy` that sets the variable slope 1 rate to match an external rate source with a fixed spread. Used for: ETH/USDC/USDT markets 34 | 35 | ### Rate Sources 36 | 37 | [PotRateSource](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/PotRateSource.sol): Adapter to convert DSR into APR which can be consumed by one of the rate target interest rate strategies. Used for: DAI/USDC/USDT markets 38 | 39 | [CappedFallbackRateSource](https://github.com/marsfoundation/sparklend-advanced/blob/master/src/CappedFallbackRateSource.sol): Wraps another rate source, caps the rate and protects against reverts with a fallback value. Used for: ETH market 40 | 41 | ## Usage 42 | 43 | ```bash 44 | forge build 45 | ``` 46 | 47 | ## Test 48 | 49 | ```bash 50 | forge test 51 | ``` 52 | -------------------------------------------------------------------------------- /test/InterestRateStrategyBase.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { IDefaultInterestRateStrategy } from "sparklend-v1-core/interfaces/IDefaultInterestRateStrategy.sol"; 7 | import { DataTypes } from "sparklend-v1-core/protocol/libraries/types/DataTypes.sol"; 8 | import { DefaultReserveInterestRateStrategy } from "sparklend-v1-core/protocol/pool/DefaultReserveInterestRateStrategy.sol"; 9 | 10 | import { MockERC20 } from "erc20-helpers/MockERC20.sol"; 11 | 12 | abstract contract InterestRateStrategyBaseTest is Test { 13 | 14 | uint256 constant MAX_TOKEN_AMOUNT = 1e27; // 1 billion tokens at 18 decimals 15 | 16 | MockERC20 asset; 17 | 18 | IDefaultInterestRateStrategy private interestStrategy; 19 | DefaultReserveInterestRateStrategy private defaultInterestStrategy; 20 | 21 | function initBase(IDefaultInterestRateStrategy _interestStrategy) internal { 22 | asset = new MockERC20("Token", "TKN", 18); 23 | interestStrategy = _interestStrategy; 24 | 25 | // Mirror the values to the default strategy 26 | defaultInterestStrategy = new DefaultReserveInterestRateStrategy({ 27 | provider: interestStrategy.ADDRESSES_PROVIDER(), 28 | optimalUsageRatio: interestStrategy.OPTIMAL_USAGE_RATIO(), 29 | baseVariableBorrowRate: interestStrategy.getBaseVariableBorrowRate(), 30 | variableRateSlope1: interestStrategy.getVariableRateSlope1(), 31 | variableRateSlope2: interestStrategy.getVariableRateSlope2(), 32 | stableRateSlope1: interestStrategy.getStableRateSlope1(), 33 | stableRateSlope2: interestStrategy.getStableRateSlope2(), 34 | baseStableRateOffset: interestStrategy.getBaseStableBorrowRate() - interestStrategy.getStableRateSlope1(), 35 | stableRateExcessOffset: interestStrategy.getStableRateExcessOffset(), 36 | optimalStableToTotalDebtRatio: interestStrategy.OPTIMAL_STABLE_TO_TOTAL_DEBT_RATIO() 37 | }); 38 | } 39 | 40 | function test_calculateInterestRates( 41 | uint256 liquidityAvailable, 42 | DataTypes.CalculateInterestRatesParams memory params 43 | ) public { 44 | // Bound everything to reasonable values 45 | // Disable stable borrow stuff 46 | liquidityAvailable = bound(liquidityAvailable, 0, MAX_TOKEN_AMOUNT); 47 | params.unbacked = bound(params.unbacked, 0, MAX_TOKEN_AMOUNT); 48 | params.liquidityAdded = bound(params.liquidityAdded, 0, MAX_TOKEN_AMOUNT); 49 | params.liquidityTaken = bound(params.liquidityTaken, 0, liquidityAvailable + params.liquidityAdded); 50 | params.totalStableDebt = 0; 51 | params.totalVariableDebt = bound(params.totalVariableDebt, 0, MAX_TOKEN_AMOUNT); 52 | params.reserveFactor = bound(params.reserveFactor, 0, 100_00); 53 | params.reserve = address(asset); 54 | params.aToken = makeAddr("aToken"); 55 | 56 | asset.mint(params.aToken, liquidityAvailable); 57 | 58 | ( 59 | uint256 expectedLiquidityRate, 60 | , 61 | uint256 expectedVariableBorrowRate 62 | ) = defaultInterestStrategy.calculateInterestRates(params); 63 | ( 64 | uint256 actualLiquidityRate, 65 | , 66 | uint256 actualVariableBorrowRate 67 | ) = interestStrategy.calculateInterestRates(params); 68 | 69 | // Small diff from simplifying the stable borrow stuff which removes rounding errors from integer division 70 | assertApproxEqRel(expectedLiquidityRate, actualLiquidityRate, 0.000001e18, "liquidity rate mismatch"); 71 | assertEq(expectedVariableBorrowRate, actualVariableBorrowRate, "variable borrow rate mismatch"); 72 | } 73 | 74 | } 75 | -------------------------------------------------------------------------------- /test/RateTargetBaseInterestRateStrategy.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "./InterestRateStrategyBase.t.sol"; 5 | 6 | import { RateSourceMock } from "./mocks/RateSourceMock.sol"; 7 | 8 | import { 9 | RateTargetBaseInterestRateStrategy, 10 | IPoolAddressesProvider 11 | } from "../src/RateTargetBaseInterestRateStrategy.sol"; 12 | 13 | contract RateTargetBaseInterestRateStrategyTest is InterestRateStrategyBaseTest { 14 | 15 | RateSourceMock rateSource; 16 | 17 | RateTargetBaseInterestRateStrategy interestStrategy; 18 | 19 | function setUp() public { 20 | rateSource = new RateSourceMock(0.05e27, 27); 21 | 22 | interestStrategy = new RateTargetBaseInterestRateStrategy({ 23 | provider: IPoolAddressesProvider(address(123)), 24 | rateSource: address(rateSource), 25 | optimalUsageRatio: 0.8e27, 26 | baseVariableBorrowRateSpread: 0.005e27, 27 | variableRateSlope1: 0.01e27, 28 | variableRateSlope2: 0.45e27 29 | }); 30 | 31 | initBase(interestStrategy); 32 | } 33 | 34 | function test_constructor() public { 35 | assertEq(address(interestStrategy.ADDRESSES_PROVIDER()), address(123)); 36 | assertEq(address(interestStrategy.RATE_SOURCE()), address(rateSource)); 37 | 38 | assertEq(interestStrategy.OPTIMAL_USAGE_RATIO(), 0.8e27); 39 | assertEq(interestStrategy.OPTIMAL_STABLE_TO_TOTAL_DEBT_RATIO(), 0); 40 | assertEq(interestStrategy.MAX_EXCESS_USAGE_RATIO(), 0.2e27); 41 | assertEq(interestStrategy.MAX_EXCESS_STABLE_TO_TOTAL_DEBT_RATIO(), 1e27); 42 | 43 | assertEq(interestStrategy.getVariableRateSlope1(), 0.01e27); 44 | assertEq(interestStrategy.getVariableRateSlope2(), 0.45e27); 45 | assertEq(interestStrategy.getStableRateSlope1(), 0); 46 | assertEq(interestStrategy.getStableRateSlope2(), 0); 47 | assertEq(interestStrategy.getStableRateExcessOffset(), 0); 48 | assertEq(interestStrategy.getBaseStableBorrowRate(), 0.01e27); 49 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.055e27); 50 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.515e27); 51 | assertEq(interestStrategy.getBaseVariableBorrowRateSpread(), 0.005e27); 52 | } 53 | 54 | function test_rateSource_changeRate() public { 55 | assertEq(interestStrategy.getVariableRateSlope1(), 0.01e27); 56 | assertEq(interestStrategy.getVariableRateSlope2(), 0.45e27); 57 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.055e27); 58 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.515e27); 59 | 60 | rateSource.setRate(0.07e27); 61 | 62 | assertEq(interestStrategy.getVariableRateSlope1(), 0.01e27); 63 | assertEq(interestStrategy.getVariableRateSlope2(), 0.45e27); 64 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.075e27); 65 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.535e27); 66 | } 67 | 68 | function test_rateSource_changeDecimals() public { 69 | assertEq(interestStrategy.getVariableRateSlope1(), 0.01e27); 70 | assertEq(interestStrategy.getVariableRateSlope2(), 0.45e27); 71 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.055e27); 72 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.515e27); 73 | 74 | // Note that the rate will still convert to 27 decimals even if it's reported at 18 75 | rateSource.setRate(0.05e18); 76 | rateSource.setDecimals(18); 77 | 78 | assertEq(interestStrategy.getVariableRateSlope1(), 0.01e27); 79 | assertEq(interestStrategy.getVariableRateSlope2(), 0.45e27); 80 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.055e27); 81 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.515e27); 82 | } 83 | 84 | function test_rateSource_invalidDecimals() public { 85 | rateSource.setRate(0.07e28); 86 | rateSource.setDecimals(28); 87 | 88 | vm.expectRevert("RateTargetBaseInterestRateStrategy/invalid-rate-source-decimals"); 89 | new RateTargetBaseInterestRateStrategy({ 90 | provider: IPoolAddressesProvider(address(123)), 91 | rateSource: address(rateSource), 92 | optimalUsageRatio: 0.8e27, 93 | baseVariableBorrowRateSpread: 0.005e27, 94 | variableRateSlope1: 0.01e27, 95 | variableRateSlope2: 0.45e27 96 | }); 97 | } 98 | 99 | } 100 | -------------------------------------------------------------------------------- /test/CappedFallbackRateSource.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { RateSourceMock } from "./mocks/RateSourceMock.sol"; 7 | 8 | import { CappedFallbackRateSource } from "../src/CappedFallbackRateSource.sol"; 9 | 10 | contract RevertingRateSource { 11 | function getAPR() external pure returns (uint256) { 12 | revert("RevertingRateSource/some-error"); 13 | } 14 | } 15 | 16 | contract ZeroLengthRevertingRateSource { 17 | function getAPR() external pure returns (uint256) { 18 | revert(); 19 | } 20 | } 21 | 22 | contract LargeGasUsageRateSource { 23 | function getAPR() external pure returns (uint256) { 24 | uint256 result = 0; 25 | for (uint256 i = 0; i < 10000; i++) { 26 | result += i; 27 | } 28 | return result; 29 | } 30 | } 31 | 32 | contract CappedFallbackRateSourceTest is Test { 33 | 34 | RateSourceMock originalSource; 35 | 36 | CappedFallbackRateSource rateSource; 37 | 38 | function setUp() public { 39 | originalSource = new RateSourceMock(0.037e18, 18); 40 | 41 | rateSource = new CappedFallbackRateSource({ 42 | _source: address(originalSource), 43 | _lowerBound: 0.01e18, 44 | _upperBound: 0.08e18, 45 | _defaultRate: 0.03e18 46 | }); 47 | } 48 | 49 | function test_constructor_lowerBoundGtUpperBoundBoundary() public { 50 | vm.expectRevert("CappedFallbackRateSource/invalid-bounds"); 51 | new CappedFallbackRateSource({ 52 | _source: address(originalSource), 53 | _lowerBound: 0.01e18 + 1, // Lower bound is larger than upper bound 54 | _upperBound: 0.01e18, 55 | _defaultRate: 0.01e18 56 | }); 57 | 58 | new CappedFallbackRateSource({ 59 | _source: address(originalSource), 60 | _lowerBound: 0.01e18, 61 | _upperBound: 0.01e18, 62 | _defaultRate: 0.01e18 63 | }); 64 | } 65 | 66 | function test_constructor_defaultRateLtLowerBoundBoundary() public { 67 | vm.expectRevert("CappedFallbackRateSource/invalid-default-rate"); 68 | new CappedFallbackRateSource({ 69 | _source: address(originalSource), 70 | _lowerBound: 0.01e18, 71 | _upperBound: 0.08e18, 72 | _defaultRate: 0.01e18 - 1 // Default rate is below lower bound 73 | }); 74 | 75 | new CappedFallbackRateSource({ 76 | _source: address(originalSource), 77 | _lowerBound: 0.01e18, 78 | _upperBound: 0.08e18, 79 | _defaultRate: 0.01e18 80 | }); 81 | } 82 | 83 | function test_constructor_defaultRateGtUpperBoundBoundary() public { 84 | vm.expectRevert("CappedFallbackRateSource/invalid-default-rate"); 85 | new CappedFallbackRateSource({ 86 | _source: address(originalSource), 87 | _lowerBound: 0.01e18, 88 | _upperBound: 0.08e18, 89 | _defaultRate: 0.08e18 + 1 // Default rate is above upper bound 90 | }); 91 | 92 | new CappedFallbackRateSource({ 93 | _source: address(originalSource), 94 | _lowerBound: 0.01e18, 95 | _upperBound: 0.08e18, 96 | _defaultRate: 0.08e18 97 | }); 98 | } 99 | 100 | function test_constructor() public { 101 | assertEq(address(rateSource.source()), address(originalSource)); 102 | assertEq(rateSource.lowerBound(), 0.01e18); 103 | assertEq(rateSource.upperBound(), 0.08e18); 104 | assertEq(rateSource.defaultRate(), 0.03e18); 105 | } 106 | 107 | function test_decimals() public { 108 | assertEq(rateSource.decimals(), 18); 109 | 110 | originalSource.setDecimals(27); 111 | 112 | assertEq(rateSource.decimals(), 27); 113 | } 114 | 115 | function test_getAPR_rateWithinBounds() public { 116 | assertEq(rateSource.getAPR(), 0.037e18); 117 | } 118 | 119 | function test_getAPR_rateBelowLowerBoundBoundary() public { 120 | originalSource.setRate(0.01e18 - 1); 121 | 122 | assertEq(rateSource.getAPR(), 0.01e18); // Use lowerBound 123 | 124 | originalSource.setRate(0.01e18); 125 | 126 | assertEq(rateSource.getAPR(), 0.01e18); // Use sourceRate 127 | 128 | originalSource.setRate(0.01e18 + 1); 129 | 130 | assertEq(rateSource.getAPR(), 0.01e18 + 1); // Use sourceRate 131 | } 132 | 133 | function test_getAPR_rateAboveUpperBoundBoundary() public { 134 | originalSource.setRate(0.08e18 + 1); 135 | 136 | assertEq(rateSource.getAPR(), 0.08e18); // Use upperBound 137 | 138 | originalSource.setRate(0.08e18); 139 | 140 | assertEq(rateSource.getAPR(), 0.08e18); // Use sourceRate 141 | 142 | originalSource.setRate(0.08e18 - 1); 143 | 144 | assertEq(rateSource.getAPR(), 0.08e18 - 1); // Use sourceRate 145 | } 146 | 147 | function test_getAPR_rateReverts() public { 148 | rateSource = new CappedFallbackRateSource({ 149 | _source: address(new RevertingRateSource()), 150 | _lowerBound: 0.01e18, 151 | _upperBound: 0.08e18, 152 | _defaultRate: 0.03e18 153 | }); 154 | 155 | assertEq(rateSource.getAPR(), 0.03e18); 156 | } 157 | 158 | // Example of inner zero-length revert due to explicit revert() 159 | // Must ensure the inner contract does not revert with zero-length error 160 | function test_getAPR_rateRevertsZeroLength() public { 161 | rateSource = new CappedFallbackRateSource({ 162 | _source: address(new ZeroLengthRevertingRateSource()), 163 | _lowerBound: 0.01e18, 164 | _upperBound: 0.08e18, 165 | _defaultRate: 0.03e18 166 | }); 167 | 168 | vm.expectRevert("CappedFallbackRateSource/zero-length-error"); 169 | rateSource.getAPR(); 170 | } 171 | 172 | // Example of inner zero-length revert due to OOG 173 | function test_getAPR_rateRevertsOutOfGas() public { 174 | rateSource = new CappedFallbackRateSource({ 175 | _source: address(new LargeGasUsageRateSource()), 176 | _lowerBound: 0.01e18, 177 | _upperBound: 0.08e18, 178 | _defaultRate: 0.03e18 179 | }); 180 | 181 | vm.expectRevert("CappedFallbackRateSource/zero-length-error"); 182 | rateSource.getAPR{gas:30000}(); 183 | } 184 | 185 | } 186 | -------------------------------------------------------------------------------- /test/RateTargetKinkInterestRateStrategy.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "./InterestRateStrategyBase.t.sol"; 5 | 6 | import { RateSourceMock } from "./mocks/RateSourceMock.sol"; 7 | 8 | import { 9 | RateTargetKinkInterestRateStrategy, 10 | IPoolAddressesProvider 11 | } from "../src/RateTargetKinkInterestRateStrategy.sol"; 12 | 13 | contract RateTargetKinkInterestRateStrategyTest is InterestRateStrategyBaseTest { 14 | 15 | RateSourceMock rateSource; 16 | 17 | RateTargetKinkInterestRateStrategy interestStrategy; 18 | RateTargetKinkInterestRateStrategy interestStrategyPositiveSpread; 19 | 20 | function setUp() public { 21 | rateSource = new RateSourceMock(0.05e27, 27); 22 | 23 | interestStrategy = new RateTargetKinkInterestRateStrategy({ 24 | provider: IPoolAddressesProvider(address(123)), 25 | rateSource: address(rateSource), 26 | optimalUsageRatio: 0.8e27, 27 | baseVariableBorrowRate: 0.01e27, 28 | variableRateSlope1Spread: -0.005e27, 29 | variableRateSlope2: 0.55e27 30 | }); 31 | 32 | interestStrategyPositiveSpread = new RateTargetKinkInterestRateStrategy({ 33 | provider: IPoolAddressesProvider(address(123)), 34 | rateSource: address(rateSource), 35 | optimalUsageRatio: 0, 36 | baseVariableBorrowRate: 0.01e27, 37 | variableRateSlope1Spread: 0.005e27, 38 | variableRateSlope2: 0.55e27 39 | }); 40 | 41 | initBase(interestStrategy); 42 | } 43 | 44 | function test_constructor() public { 45 | assertEq(address(interestStrategy.ADDRESSES_PROVIDER()), address(123)); 46 | assertEq(address(interestStrategy.RATE_SOURCE()), address(rateSource)); 47 | 48 | assertEq(interestStrategy.OPTIMAL_USAGE_RATIO(), 0.8e27); 49 | assertEq(interestStrategy.OPTIMAL_STABLE_TO_TOTAL_DEBT_RATIO(), 0); 50 | assertEq(interestStrategy.MAX_EXCESS_USAGE_RATIO(), 0.2e27); 51 | assertEq(interestStrategy.MAX_EXCESS_STABLE_TO_TOTAL_DEBT_RATIO(), 1e27); 52 | 53 | assertEq(interestStrategy.getVariableRateSlope1(), 0.035e27); 54 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 55 | assertEq(interestStrategy.getStableRateSlope1(), 0); 56 | assertEq(interestStrategy.getStableRateSlope2(), 0); 57 | assertEq(interestStrategy.getStableRateExcessOffset(), 0); 58 | assertEq(interestStrategy.getBaseStableBorrowRate(), 0.035e27); 59 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 60 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.595e27); 61 | assertEq(interestStrategy.getVariableRateSlope1Spread(), -0.005e27); 62 | 63 | assertEq(interestStrategyPositiveSpread.getVariableRateSlope1(), 0.045e27); 64 | assertEq(interestStrategyPositiveSpread.getVariableRateSlope2(), 0.55e27); 65 | assertEq(interestStrategyPositiveSpread.getMaxVariableBorrowRate(), 0.605e27); 66 | assertEq(interestStrategyPositiveSpread.getVariableRateSlope1Spread(), 0.005e27); 67 | } 68 | 69 | function test_rateSource_change_kink_above_base() public { 70 | assertEq(interestStrategy.getVariableRateSlope1(), 0.035e27); 71 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 72 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 73 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.595e27); 74 | 75 | rateSource.setRate(0.07e27); 76 | 77 | assertEq(interestStrategy.getVariableRateSlope1(), 0.055e27); 78 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 79 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 80 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.615e27); 81 | } 82 | 83 | function test_rateSource_change_kink_below_base() public { 84 | assertEq(interestStrategy.getVariableRateSlope1(), 0.035e27); 85 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 86 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 87 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.595e27); 88 | 89 | rateSource.setRate(0.012e27); // 1.2% - 0.5% = 0.7% < 1.0% 90 | 91 | assertEq(interestStrategy.getVariableRateSlope1(), 0); 92 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 93 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 94 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.56e27); 95 | } 96 | 97 | function test_rateSource_change_rate_below_base() public { 98 | assertEq(interestStrategy.getVariableRateSlope1(), 0.035e27); 99 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 100 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 101 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.595e27); 102 | 103 | rateSource.setRate(0); 104 | 105 | assertEq(interestStrategy.getVariableRateSlope1(), 0); 106 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 107 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 108 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.56e27); 109 | } 110 | 111 | function test_rateSource_changeDecimals() public { 112 | assertEq(interestStrategy.getVariableRateSlope1(), 0.035e27); 113 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 114 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 115 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.595e27); 116 | 117 | // Note that the rate will still convert to 27 decimals even if it's reported at 18 118 | rateSource.setRate(0.05e18); 119 | rateSource.setDecimals(18); 120 | 121 | assertEq(interestStrategy.getVariableRateSlope1(), 0.035e27); 122 | assertEq(interestStrategy.getVariableRateSlope2(), 0.55e27); 123 | assertEq(interestStrategy.getBaseVariableBorrowRate(), 0.01e27); 124 | assertEq(interestStrategy.getMaxVariableBorrowRate(), 0.595e27); 125 | } 126 | 127 | function test_rateSource_invalidDecimals() public { 128 | rateSource.setRate(0.07e28); 129 | rateSource.setDecimals(28); 130 | 131 | vm.expectRevert("RateTargetKinkInterestRateStrategy/invalid-rate-source-decimals"); 132 | new RateTargetKinkInterestRateStrategy({ 133 | provider: IPoolAddressesProvider(address(123)), 134 | rateSource: address(rateSource), 135 | optimalUsageRatio: 0.8e27, 136 | baseVariableBorrowRate: 0.01e27, 137 | variableRateSlope1Spread: -0.005e27, 138 | variableRateSlope2: 0.55e27 139 | }); 140 | } 141 | 142 | } 143 | -------------------------------------------------------------------------------- /src/VariableBorrowInterestRateStrategy.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity ^0.8.10; 3 | 4 | import { IERC20 } from 'sparklend-v1-core/dependencies/openzeppelin/contracts/IERC20.sol'; 5 | 6 | import { IDefaultInterestRateStrategy } from 'sparklend-v1-core/interfaces/IDefaultInterestRateStrategy.sol'; 7 | import { IPoolAddressesProvider } from 'sparklend-v1-core/interfaces/IPoolAddressesProvider.sol'; 8 | import { IReserveInterestRateStrategy } from 'sparklend-v1-core/interfaces/IReserveInterestRateStrategy.sol'; 9 | 10 | import { DataTypes } from 'sparklend-v1-core/protocol/libraries/types/DataTypes.sol'; 11 | import { Errors } from 'sparklend-v1-core/protocol/libraries/helpers/Errors.sol'; 12 | import { PercentageMath } from 'sparklend-v1-core/protocol/libraries/math/PercentageMath.sol'; 13 | import { WadRayMath } from 'sparklend-v1-core/protocol/libraries/math/WadRayMath.sol'; 14 | 15 | /** 16 | * @title VariableBorrowInterestRateStrategy contract 17 | * @author Aave 18 | * @notice Implements the calculation of the interest rates depending on the reserve state. 19 | * @dev The model of interest rate is based on 2 slopes, one before the `OPTIMAL_USAGE_RATIO` 20 | * point of usage and another from that one to 100%. 21 | * - An instance of this same contract, can't be used across different Aave markets, 22 | * due to the caching of the PoolAddressesProvider. 23 | * - NOTE: This is a modified version of DefaultReserveInterestRateStrategy with 24 | * the stable borrow feature disabled. 25 | */ 26 | contract VariableBorrowInterestRateStrategy is IDefaultInterestRateStrategy { 27 | 28 | using WadRayMath for uint256; 29 | using PercentageMath for uint256; 30 | 31 | /**********************************************************************************************/ 32 | /*** Declarations and Constructor ***/ 33 | /**********************************************************************************************/ 34 | 35 | // Unused functionality, so initialized to 100% and 0% respectively. 36 | uint256 public override constant MAX_EXCESS_STABLE_TO_TOTAL_DEBT_RATIO = WadRayMath.RAY; 37 | uint256 public override constant OPTIMAL_STABLE_TO_TOTAL_DEBT_RATIO = 0; 38 | 39 | uint256 public override immutable MAX_EXCESS_USAGE_RATIO; 40 | uint256 public override immutable OPTIMAL_USAGE_RATIO; 41 | 42 | IPoolAddressesProvider public override immutable ADDRESSES_PROVIDER; 43 | 44 | // Base variable borrow rate when usage rate = 0. 45 | // Expressed in ray. 46 | uint256 internal immutable _baseVariableBorrowRate; 47 | 48 | // Slope of the variable interest curve when usage ratio > 0 and <= OPTIMAL_USAGE_RATIO. 49 | // Expressed in ray. 50 | uint256 internal immutable _variableRateSlope1; 51 | 52 | // Slope of the variable interest curve when usage ratio > OPTIMAL_USAGE_RATIO. 53 | // Expressed in ray. 54 | uint256 internal immutable _variableRateSlope2; 55 | 56 | /** 57 | * @dev Constructor. 58 | * @param provider The address of the PoolAddressesProvider contract. 59 | * @param optimalUsageRatio The optimal usage ratio. 60 | * @param baseVariableBorrowRate The base variable borrow rate. 61 | * @param variableRateSlope1 The variable rate slope below optimal usage ratio. 62 | * @param variableRateSlope2 The variable rate slope above optimal usage ratio. 63 | */ 64 | constructor( 65 | IPoolAddressesProvider provider, 66 | uint256 optimalUsageRatio, 67 | uint256 baseVariableBorrowRate, 68 | uint256 variableRateSlope1, 69 | uint256 variableRateSlope2 70 | ) { 71 | require(WadRayMath.RAY >= optimalUsageRatio, Errors.INVALID_OPTIMAL_USAGE_RATIO); 72 | 73 | OPTIMAL_USAGE_RATIO = optimalUsageRatio; 74 | MAX_EXCESS_USAGE_RATIO = WadRayMath.RAY - optimalUsageRatio; 75 | ADDRESSES_PROVIDER = provider; 76 | 77 | _baseVariableBorrowRate = baseVariableBorrowRate; 78 | _variableRateSlope1 = variableRateSlope1; 79 | _variableRateSlope2 = variableRateSlope2; 80 | } 81 | 82 | /**********************************************************************************************/ 83 | /*** Internal Virtual Functions (Override for different functionality) ***/ 84 | /**********************************************************************************************/ 85 | 86 | function _getBaseVariableBorrowRate() internal virtual view returns (uint256) { 87 | return _baseVariableBorrowRate; 88 | } 89 | 90 | function _getVariableRateSlope1() internal virtual view returns (uint256) { 91 | return _variableRateSlope1; 92 | } 93 | 94 | function _getVariableRateSlope2() internal virtual view returns (uint256) { 95 | return _variableRateSlope2; 96 | } 97 | 98 | /**********************************************************************************************/ 99 | /*** Standard Interface Getter Functions ***/ 100 | /**********************************************************************************************/ 101 | 102 | function getBaseStableBorrowRate() external override view returns (uint256) { 103 | return _getVariableRateSlope1(); 104 | } 105 | 106 | function getBaseVariableBorrowRate() external override view returns (uint256) { 107 | return _getBaseVariableBorrowRate(); 108 | } 109 | 110 | function getVariableRateSlope1() external override view returns (uint256) { 111 | return _getVariableRateSlope1(); 112 | } 113 | 114 | function getVariableRateSlope2() external override view returns (uint256) { 115 | return _getVariableRateSlope2(); 116 | } 117 | 118 | function getStableRateSlope1() external override pure returns (uint256) { 119 | return 0; 120 | } 121 | 122 | function getStableRateSlope2() external override pure returns (uint256) { 123 | return 0; 124 | } 125 | 126 | function getStableRateExcessOffset() external override pure returns (uint256) { 127 | return 0; 128 | } 129 | 130 | function getMaxVariableBorrowRate() external view override returns (uint256) { 131 | return _getBaseVariableBorrowRate() + _getVariableRateSlope1() + _getVariableRateSlope2(); 132 | } 133 | 134 | /**********************************************************************************************/ 135 | /*** Interest Calculation Function ***/ 136 | /**********************************************************************************************/ 137 | 138 | struct CalcInterestRatesLocalVars { 139 | uint256 availableLiquidity; 140 | uint256 currentVariableBorrowRate; 141 | uint256 currentLiquidityRate; 142 | uint256 borrowUsageRatio; 143 | uint256 supplyUsageRatio; 144 | uint256 availableLiquidityPlusDebt; 145 | } 146 | 147 | function calculateInterestRates( 148 | DataTypes.CalculateInterestRatesParams memory params 149 | ) 150 | external view override 151 | returns (uint256 liquidityRate, uint256 stableBorrowRate, uint256 variableBorrowRate) 152 | { 153 | CalcInterestRatesLocalVars memory vars; 154 | 155 | // 1. Set the current variable borrow rate to the base rate. 156 | 157 | vars.currentLiquidityRate = 0; 158 | vars.currentVariableBorrowRate = _getBaseVariableBorrowRate(); 159 | 160 | // 2. Calculate the borrow and supply usage ratios. 161 | 162 | if (params.totalVariableDebt != 0) { 163 | // Calculate the total resulting cash in the reserve after the call is complete. 164 | vars.availableLiquidity = 165 | IERC20(params.reserve).balanceOf(params.aToken) + 166 | params.liquidityAdded - 167 | params.liquidityTaken; 168 | 169 | // Calculate the total value of the asset in the reserve (cash + debt). 170 | vars.availableLiquidityPlusDebt = vars.availableLiquidity + params.totalVariableDebt; 171 | 172 | // Calculate the borrowUsageRatio (debt / total value). 173 | vars.borrowUsageRatio = params.totalVariableDebt.rayDiv(vars.availableLiquidityPlusDebt); 174 | 175 | // Calculate the supplyUsageRatio (debt / total value + unbacked). 176 | // NOTE: The supplyUsageRatio will almost always equal the borrowUsageRatio, except 177 | // when unbacked aTokens are minted. 178 | vars.supplyUsageRatio 179 | = params.totalVariableDebt.rayDiv(vars.availableLiquidityPlusDebt + params.unbacked); 180 | } 181 | 182 | // 3. Calculate the variable borrow rate, using the 2-slope model. 183 | 184 | if (vars.borrowUsageRatio > OPTIMAL_USAGE_RATIO) { 185 | // excessBorrowUsageRatio = (borrowRatio - optimalRatio) / (1 - optimalRatio) 186 | uint256 excessBorrowUsageRatio 187 | = (vars.borrowUsageRatio - OPTIMAL_USAGE_RATIO).rayDiv(MAX_EXCESS_USAGE_RATIO); 188 | 189 | vars.currentVariableBorrowRate += 190 | _getVariableRateSlope1() + 191 | _getVariableRateSlope2().rayMul(excessBorrowUsageRatio); 192 | } else { 193 | vars.currentVariableBorrowRate += 194 | _getVariableRateSlope1().rayMul(vars.borrowUsageRatio).rayDiv(OPTIMAL_USAGE_RATIO); 195 | } 196 | 197 | // 4. Calculate the liquidity rate by multiplying the current variable borrow rate by 198 | // the supply usage ratio and multiplying by (100% - the protocol's reserve factor). 199 | // This yields the amount that the lenders are earning based on the interest paid by 200 | // the borrowers, before the protocol's cut, taking into account idle capital. 201 | 202 | if (params.totalVariableDebt != 0) { 203 | vars.currentLiquidityRate = 204 | vars.currentVariableBorrowRate 205 | .rayMul(vars.supplyUsageRatio) 206 | .percentMul(PercentageMath.PERCENTAGE_FACTOR - params.reserveFactor); 207 | } 208 | 209 | return ( 210 | vars.currentLiquidityRate, 211 | 0, 212 | vars.currentVariableBorrowRate 213 | ); 214 | } 215 | 216 | } 217 | -------------------------------------------------------------------------------- /test/SparkLendMainnetIntegration.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0 2 | pragma solidity ^0.8.0; 3 | 4 | import "forge-std/Test.sol"; 5 | 6 | import { IERC20 } from "erc20-helpers/interfaces/IERC20.sol"; 7 | import { SafeERC20 } from "erc20-helpers/SafeERC20.sol"; 8 | 9 | import { IAaveOracle } from "sparklend-v1-core/interfaces/IAaveOracle.sol"; 10 | import { IPoolAddressesProvider } from "sparklend-v1-core/interfaces/IPoolAddressesProvider.sol"; 11 | import { IPool } from "sparklend-v1-core/interfaces/IPool.sol"; 12 | import { IPoolConfigurator } from "sparklend-v1-core/interfaces/IPoolConfigurator.sol"; 13 | import { IDefaultInterestRateStrategy } from "sparklend-v1-core/interfaces/IDefaultInterestRateStrategy.sol"; 14 | 15 | import { FixedPriceOracle } from "src/FixedPriceOracle.sol"; 16 | import { CappedFallbackRateSource } from "src/CappedFallbackRateSource.sol"; 17 | import { CappedOracle } from "src/CappedOracle.sol"; 18 | import { SSRRateSource } from "src/SSRRateSource.sol"; 19 | import { RateTargetBaseInterestRateStrategy } from "src/RateTargetBaseInterestRateStrategy.sol"; 20 | import { RateTargetKinkInterestRateStrategy } from "src/RateTargetKinkInterestRateStrategy.sol"; 21 | import { RETHExchangeRateOracle } from "src/RETHExchangeRateOracle.sol"; 22 | import { WSTETHExchangeRateOracle } from "src/WSTETHExchangeRateOracle.sol"; 23 | import { WEETHExchangeRateOracle } from "src/WEETHExchangeRateOracle.sol"; 24 | import { RSETHExchangeRateOracle } from "src/RSETHExchangeRateOracle.sol"; 25 | import { EZETHExchangeRateOracle } from "src/EZETHExchangeRateOracle.sol"; 26 | 27 | interface ITollLike { 28 | function kiss(address) external; 29 | } 30 | 31 | // TODO: Add capped oracles for WBTC (need to import the combining contract first) 32 | contract SparkLendMainnetIntegrationTest is Test { 33 | 34 | using SafeERC20 for IERC20; 35 | 36 | address AAVE_ORACLE = 0x8105f69D9C41644c6A0803fDA7D03Aa70996cFD9; 37 | address POOL_ADDRESSES_PROVIDER = 0x02C3eA4e34C0cBd694D2adFa2c690EECbC1793eE; 38 | address POOL = 0xC13e21B648A5Ee794902342038FF3aDAB66BE987; 39 | address POOL_CONFIGURATOR = 0x542DBa469bdE58FAeE189ffB60C6b49CE60E0738; 40 | address ADMIN = 0x3300f198988e4C9C63F75dF86De36421f06af8c4; // SubDAO Proxy 41 | 42 | address DAI = 0x6B175474E89094C44Da98b954EedeAC495271d0F; 43 | address ETH = 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2; 44 | address USDC = 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48; 45 | address USDT = 0xdAC17F958D2ee523a2206206994597C13D831ec7; 46 | address STETH = 0xae7ab96520DE3A18E5e111B5EaAb095312D7fE84; 47 | address WSTETH = 0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0; 48 | address RETH = 0xae78736Cd615f374D3085123A210448E74Fc6393; 49 | address WEETH = 0xCd5fE23C85820F7B72D0926FC9b05b43E359b7ee; 50 | address RSETH = 0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7; 51 | address EZETH = 0xbf5495Efe5DB9ce00f80364C8B423567e58d2110; 52 | address SUSDS = 0xa3931d71877C0E7a3148CB7Eb4463524FEc27fbD; 53 | 54 | address ETH_IRM = 0xD7A8461e6aF708a086D8285f8fD900309336347c; 55 | address USDC_ORACLE = 0x8fFfFfd4AfB6115b954Bd326cbe7B4BA576818f6; 56 | address USDT_ORACLE = 0x3E7d1eAB13ad0104d2750B8863b489D65364e32D; 57 | address USDC_USDT_IRM = 0xbc8A68B0ab0617D7c90d15bb1601B25d795Dc4c8; // Note: This is the same for both because the parameters are the same 58 | address ETHUSD_ORACLE = 0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419; 59 | address RETH_ORACLE = 0x05225Cd708bCa9253789C1374e4337a019e99D56; 60 | address WSTETH_ORACLE = 0x8B6851156023f4f5A66F68BEA80851c3D905Ac93; 61 | address RSETH_ORACLE = 0x349A73444b1a310BAe67ef67973022020d70020d; 62 | address EZETH_ORACLE = 0x74a09653A083691711cF8215a6ab074BB4e99ef5; 63 | 64 | address LST_RATE_SOURCE = 0x08669C836F41AEaD03e3EF81a59f3b8e72EC417A; 65 | 66 | IAaveOracle aaveOracle = IAaveOracle(AAVE_ORACLE); 67 | IPoolAddressesProvider poolAddressesProvider = IPoolAddressesProvider(POOL_ADDRESSES_PROVIDER); 68 | IPool pool = IPool(POOL); 69 | IPoolConfigurator configurator = IPoolConfigurator(POOL_CONFIGURATOR); 70 | 71 | function setUp() public { 72 | vm.createSelectFork(getChain("mainnet").rpcUrl, 19895484); // May 18, 2024 73 | } 74 | 75 | function test_dai_market_oracle() public { 76 | // Set fork state to before this was introduced 77 | vm.createSelectFork(getChain("mainnet").rpcUrl, 18784436); // Dec 14, 2023 78 | 79 | FixedPriceOracle oracle = new FixedPriceOracle(1e8); 80 | 81 | // Nothing is special about this number, it just happens to be the price at this block 82 | assertEq(aaveOracle.getAssetPrice(DAI), 0.99982058e8); 83 | 84 | address[] memory assets = new address[](1); 85 | assets[0] = DAI; 86 | address[] memory sources = new address[](1); 87 | sources[0] = address(oracle); 88 | 89 | vm.prank(ADMIN); 90 | aaveOracle.setAssetSources( 91 | assets, 92 | sources 93 | ); 94 | 95 | assertEq(aaveOracle.getAssetPrice(DAI), 1e8); 96 | } 97 | 98 | function test_dai_market_irm() public { 99 | vm.createSelectFork(getChain("mainnet").rpcUrl, 20965077); // Oct 14, 2024 100 | 101 | RateTargetBaseInterestRateStrategy strategy 102 | = new RateTargetBaseInterestRateStrategy({ 103 | provider: poolAddressesProvider, 104 | rateSource: address(new SSRRateSource(SUSDS)), 105 | optimalUsageRatio: 1e27, 106 | baseVariableBorrowRateSpread: 0, 107 | variableRateSlope1: 0, 108 | variableRateSlope2: 0 109 | }); 110 | 111 | uint256 currentBorrowRate = 0.062930507342065968556080000e27; 112 | 113 | // Previous borrow rate 114 | assertEq(_getBorrowRate(DAI), currentBorrowRate); 115 | 116 | vm.prank(ADMIN); 117 | configurator.setReserveInterestRateStrategyAddress( 118 | DAI, 119 | address(strategy) 120 | ); 121 | 122 | // Trigger an update from the new IRM 123 | _triggerUpdate(DAI); 124 | 125 | // Should be approximately unchanged because the spread is 1% lower which cancels the 1% higher SSR 126 | assertApproxEqRel(_getBorrowRate(DAI), currentBorrowRate, 0.001e18); 127 | 128 | // Change the borrow spread to 1% 129 | strategy = new RateTargetBaseInterestRateStrategy({ 130 | provider: poolAddressesProvider, 131 | rateSource: address(new SSRRateSource(SUSDS)), 132 | optimalUsageRatio: 1e27, 133 | baseVariableBorrowRateSpread: 0.01e27, 134 | variableRateSlope1: 0, 135 | variableRateSlope2: 0 136 | }); 137 | vm.prank(ADMIN); 138 | configurator.setReserveInterestRateStrategyAddress( 139 | DAI, 140 | address(strategy) 141 | ); 142 | 143 | // Trigger an update from the new IRM 144 | _triggerUpdate(DAI); 145 | 146 | // Should be 1% higher than before 147 | assertApproxEqRel(_getBorrowRate(DAI), currentBorrowRate + 0.01e27, 0.001e18); 148 | } 149 | 150 | function test_eth_market_irm() public { 151 | CappedFallbackRateSource rateSource = new CappedFallbackRateSource({ 152 | _source: LST_RATE_SOURCE, 153 | _lowerBound: 0.01e18, 154 | _upperBound: 0.08e18, 155 | _defaultRate: 0.03e18 156 | }); 157 | 158 | // Need to whitelist the rate source 159 | // Use a random authed address on the Chronicle oracle 160 | vm.prank(0xc50dFeDb7E93eF7A3DacCAd7987D0960c4e2CD4b); 161 | ITollLike(LST_RATE_SOURCE).kiss(address(rateSource)); 162 | 163 | uint256 ethYield = 0.028485207053926554e27; // 2.8% (approx APR as of May 18, 2024) 164 | uint256 spread = 0.0015e27; // 0.15% 165 | 166 | RateTargetKinkInterestRateStrategy strategy 167 | = new RateTargetKinkInterestRateStrategy({ 168 | provider: poolAddressesProvider, 169 | rateSource: address(rateSource), 170 | optimalUsageRatio: 0.9e27, 171 | baseVariableBorrowRate: 0, 172 | variableRateSlope1Spread: -int256(spread), 173 | variableRateSlope2: 1.2e27 174 | }); 175 | IDefaultInterestRateStrategy prevStrategy 176 | = IDefaultInterestRateStrategy(ETH_IRM); 177 | 178 | _triggerUpdate(ETH); 179 | 180 | assertEq(strategy.getBaseVariableBorrowRate(), prevStrategy.getBaseVariableBorrowRate()); 181 | assertEq(prevStrategy.getVariableRateSlope1(), 0.028e27); 182 | assertEq(strategy.getVariableRateSlope1(), ethYield - spread); 183 | assertEq(strategy.getVariableRateSlope2(), prevStrategy.getVariableRateSlope2()); 184 | assertEq(prevStrategy.getMaxVariableBorrowRate(), 1.228e27); 185 | assertEq(strategy.getMaxVariableBorrowRate(), 1.2e27 + ethYield - spread); 186 | 187 | _triggerUpdate(ETH); 188 | 189 | assertEq(_getBorrowRate(ETH), 0.017624470144971981744160716e27); 190 | 191 | vm.prank(ADMIN); 192 | configurator.setReserveInterestRateStrategyAddress( 193 | ETH, 194 | address(strategy) 195 | ); 196 | 197 | _triggerUpdate(ETH); 198 | 199 | // slope1 has adjusted down a bit so the borrow rate is slightly lower at same utilization 200 | assertEq(_getBorrowRate(ETH), 0.016985713431350567055736333e27); 201 | } 202 | 203 | function test_usdc_usdt_market_oracles() public { 204 | // Set fork state to before this was introduced 205 | vm.createSelectFork(getChain("mainnet").rpcUrl, 18784436); // Dec 14, 2023 206 | 207 | CappedOracle usdcOracle = new CappedOracle(USDC_ORACLE, 1e8); 208 | CappedOracle usdtOracle = new CappedOracle(USDT_ORACLE, 1e8); 209 | 210 | // Nothing is special about these numbers, they just happen to be the price at this block 211 | assertEq(aaveOracle.getAssetPrice(USDC), 1.00005299e8); 212 | assertEq(aaveOracle.getAssetPrice(USDT), 0.99961441e8); 213 | 214 | address[] memory assets = new address[](2); 215 | assets[0] = USDC; 216 | assets[1] = USDT; 217 | address[] memory sources = new address[](2); 218 | sources[0] = address(usdcOracle); 219 | sources[1] = address(usdtOracle); 220 | 221 | vm.prank(ADMIN); 222 | aaveOracle.setAssetSources( 223 | assets, 224 | sources 225 | ); 226 | 227 | assertEq(aaveOracle.getAssetPrice(USDC), 1e8); 228 | assertEq(aaveOracle.getAssetPrice(USDT), 0.99961441e8); 229 | } 230 | 231 | function test_usdc_usdt_market_irms() public { 232 | vm.createSelectFork(getChain("mainnet").rpcUrl, 20965077); // Oct 14, 2024 233 | 234 | RateTargetKinkInterestRateStrategy strategy 235 | = new RateTargetKinkInterestRateStrategy({ 236 | provider: poolAddressesProvider, 237 | rateSource: address(new SSRRateSource(SUSDS)), 238 | optimalUsageRatio: 0.95e27, 239 | baseVariableBorrowRate: 0, 240 | variableRateSlope1Spread: 0.01e27, // 1% spread 241 | variableRateSlope2: 0.2e27 242 | }); 243 | 244 | _triggerUpdate(USDC); 245 | _triggerUpdate(USDT); 246 | 247 | uint256 currentRateUSDC = 0.207489689165388369527167411e27; 248 | uint256 currentRateUSDT = 0.057737691380706874411856558e27; 249 | 250 | assertEq(_getBorrowRate(USDC), currentRateUSDC, "before: USDC mismatch"); 251 | assertEq(_getBorrowRate(USDT), currentRateUSDT, "before: USDT mismatch"); 252 | 253 | vm.startPrank(ADMIN); 254 | configurator.setReserveInterestRateStrategyAddress( 255 | USDC, 256 | address(strategy) 257 | ); 258 | configurator.setReserveInterestRateStrategyAddress( 259 | USDT, 260 | address(strategy) 261 | ); 262 | vm.stopPrank(); 263 | 264 | _triggerUpdate(USDC); 265 | _triggerUpdate(USDT); 266 | 267 | // Rates will change due to SSR being 1% higher than DSR 268 | // The 1% APR change will result in a much higher jump for USDC which is already at ~20% APY 269 | uint256 newRateUSDC = 0.264906695480144435148836548e27; 270 | uint256 newRateUSDT = 0.066310128707421710970337545e27; 271 | 272 | assertEq(_getBorrowRate(USDC), newRateUSDC, "after1: USDC mismatch"); 273 | assertEq(_getBorrowRate(USDT), newRateUSDT, "after1: USDT mismatch"); 274 | } 275 | 276 | function test_reth_market_oracle() public { 277 | // Set fork state to before this was introduced 278 | vm.createSelectFork(getChain("mainnet").rpcUrl, 19015252); // Jan 15, 2024 279 | 280 | RETHExchangeRateOracle oracle = new RETHExchangeRateOracle(RETH, ETHUSD_ORACLE); 281 | 282 | // Nothing is special about this number, it just happens to be the price at this block 283 | uint256 beforePrice = 2747.09479896e8; 284 | assertEq(aaveOracle.getAssetPrice(RETH), beforePrice); 285 | assertEq(aaveOracle.getSourceOfAsset(RETH), RETH_ORACLE); 286 | 287 | address[] memory assets = new address[](1); 288 | assets[0] = RETH; 289 | address[] memory sources = new address[](1); 290 | sources[0] = address(oracle); 291 | 292 | vm.prank(ADMIN); 293 | aaveOracle.setAssetSources( 294 | assets, 295 | sources 296 | ); 297 | 298 | assertEq(aaveOracle.getAssetPrice(RETH), beforePrice); 299 | assertEq(aaveOracle.getSourceOfAsset(RETH), address(oracle)); 300 | } 301 | 302 | function test_wsteth_market_oracle() public { 303 | // Set fork state to before this was introduced 304 | vm.createSelectFork(getChain("mainnet").rpcUrl, 19015252); // Jan 15, 2024 305 | 306 | WSTETHExchangeRateOracle oracle = new WSTETHExchangeRateOracle(STETH, ETHUSD_ORACLE); 307 | 308 | // Nothing is special about this number, it just happens to be the price at this block 309 | uint256 beforePrice = 2893.26746079e8; 310 | assertEq(aaveOracle.getAssetPrice(WSTETH), beforePrice); 311 | assertEq(aaveOracle.getSourceOfAsset(WSTETH), WSTETH_ORACLE); 312 | 313 | address[] memory assets = new address[](1); 314 | assets[0] = WSTETH; 315 | address[] memory sources = new address[](1); 316 | sources[0] = address(oracle); 317 | 318 | vm.prank(ADMIN); 319 | aaveOracle.setAssetSources( 320 | assets, 321 | sources 322 | ); 323 | 324 | assertEq(aaveOracle.getAssetPrice(WSTETH), beforePrice); 325 | assertEq(aaveOracle.getSourceOfAsset(WSTETH), address(oracle)); 326 | } 327 | 328 | function test_weeth_market_oracle() public { 329 | WEETHExchangeRateOracle oracle = new WEETHExchangeRateOracle(WEETH, ETHUSD_ORACLE); 330 | 331 | vm.expectRevert(); // Not setup yet 332 | assertEq(aaveOracle.getAssetPrice(WEETH), 0); 333 | assertEq(aaveOracle.getSourceOfAsset(WEETH), address(0)); 334 | 335 | address[] memory assets = new address[](1); 336 | assets[0] = WEETH; 337 | address[] memory sources = new address[](1); 338 | sources[0] = address(oracle); 339 | 340 | vm.prank(ADMIN); 341 | aaveOracle.setAssetSources( 342 | assets, 343 | sources 344 | ); 345 | 346 | // Nothing is special about this number, it just happens to be the price at this block 347 | uint256 price = 3225.32665359e8; 348 | 349 | assertEq(aaveOracle.getAssetPrice(WEETH), price); 350 | assertEq(aaveOracle.getSourceOfAsset(WEETH), address(oracle)); 351 | } 352 | 353 | function test_rseth_market_oracle() public { 354 | RSETHExchangeRateOracle oracle = new RSETHExchangeRateOracle(RSETH_ORACLE, ETHUSD_ORACLE); 355 | 356 | vm.expectRevert(); // Not setup yet 357 | assertEq(aaveOracle.getAssetPrice(RSETH), 0); 358 | assertEq(aaveOracle.getSourceOfAsset(RSETH), address(0)); 359 | 360 | address[] memory assets = new address[](1); 361 | assets[0] = RSETH; 362 | address[] memory sources = new address[](1); 363 | sources[0] = address(oracle); 364 | 365 | vm.prank(ADMIN); 366 | aaveOracle.setAssetSources( 367 | assets, 368 | sources 369 | ); 370 | 371 | // Nothing is special about this number, it just happens to be the price at this block 372 | uint256 price = 3144.93204796e8; 373 | 374 | assertEq(aaveOracle.getAssetPrice(RSETH), price); 375 | assertEq(aaveOracle.getSourceOfAsset(RSETH), address(oracle)); 376 | } 377 | 378 | function test_ezeth_market_oracle() public { 379 | EZETHExchangeRateOracle oracle = new EZETHExchangeRateOracle(EZETH_ORACLE, ETHUSD_ORACLE); 380 | 381 | vm.expectRevert(); // Not setup yet 382 | assertEq(aaveOracle.getAssetPrice(EZETH), 0); 383 | assertEq(aaveOracle.getSourceOfAsset(EZETH), address(0)); 384 | 385 | address[] memory assets = new address[](1); 386 | assets[0] = EZETH; 387 | address[] memory sources = new address[](1); 388 | sources[0] = address(oracle); 389 | 390 | vm.prank(ADMIN); 391 | aaveOracle.setAssetSources( 392 | assets, 393 | sources 394 | ); 395 | 396 | // Nothing is special about this number, it just happens to be the price at this block 397 | uint256 price = 3135.93175044e8; 398 | 399 | assertEq(aaveOracle.getAssetPrice(EZETH), price); 400 | assertEq(aaveOracle.getSourceOfAsset(EZETH), address(oracle)); 401 | } 402 | 403 | /**********************************************************************************************/ 404 | /*** Helper Functions ***/ 405 | /**********************************************************************************************/ 406 | 407 | function _getBorrowRate(address asset) internal view returns (uint256) { 408 | return pool.getReserveData(asset).currentVariableBorrowRate; 409 | } 410 | 411 | function _triggerUpdate(address asset) internal { 412 | // Flashloan small amount to force indices update 413 | pool.flashLoanSimple(address(this), asset, 1, "", 0); 414 | } 415 | 416 | // Flashloan callback 417 | function executeOperation( 418 | address asset, 419 | uint256 amount, 420 | uint256 fee, 421 | address, 422 | bytes calldata 423 | ) external returns (bool) { 424 | IERC20(asset).safeApprove(msg.sender, amount + fee); 425 | return true; 426 | } 427 | 428 | } 429 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------