diff --git a/.github/workflows/formatting.yml b/.github/workflows/formatting.yml new file mode 100644 index 0000000..652fcf5 --- /dev/null +++ b/.github/workflows/formatting.yml @@ -0,0 +1,22 @@ +name: Formatting + +on: + push: + branches: + - main + pull_request: + +env: + FOUNDRY_PROFILE: ci + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: Install Foundry + uses: foundry-rs/foundry-toolchain@v1 + + - name: Run Linter + run: forge fmt --check diff --git a/.github/workflows/test.yml b/.github/workflows/foundry.yml similarity index 90% rename from .github/workflows/test.yml rename to .github/workflows/foundry.yml index 52dd99b..0ddda88 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/foundry.yml @@ -1,13 +1,17 @@ -name: test +name: Foundry -on: push +on: + push: + branches: + - main + pull_request: env: FOUNDRY_PROFILE: ci jobs: check: - name: Foundry project + name: forge-test runs-on: ubuntu-latest steps: - name: Generate a token diff --git a/.gitmodules b/.gitmodules index 1020b31..8391f24 100644 --- a/.gitmodules +++ b/.gitmodules @@ -3,4 +3,4 @@ url = https://github.com/foundry-rs/forge-std [submodule "lib/morpho-blue"] path = lib/morpho-blue - url = https://github.com/morpho-labs/morpho-blue + url = https://github.com/morpho-org/morpho-blue diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..46545b6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,284 @@ +This software is available under your choice of the GNU General Public +License, version 2 or later, or the Business Source License, as set +forth below. + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..3772e88 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Morpho Blue Oracles + +## License + +Morpho Blue Oracles are licensed under `GPL-2.0-or-later`, see [`LICENSE`](./LICENSE). \ No newline at end of file diff --git a/src/ChainlinkOracle.sol b/src/ChainlinkOracle.sol index 4e3bc3d..efaece2 100644 --- a/src/ChainlinkOracle.sol +++ b/src/ChainlinkOracle.sol @@ -1,19 +1,27 @@ -// SPDX-License-Identifier: UNLICENSED +// SPDX-License-Identifier: GPL-2.0-or-later pragma solidity 0.8.19; import {IOracle} from "morpho-blue/interfaces/IOracle.sol"; import {AggregatorV3Interface, ChainlinkDataFeedLib} from "./libraries/ChainlinkDataFeedLib.sol"; +import {IERC4626, VaultLib} from "./libraries/VaultLib.sol"; +import {ErrorsLib} from "./libraries/ErrorsLib.sol"; /// @title ChainlinkOracle /// @author Morpho Labs /// @custom:contact security@morpho.org /// @notice Morpho Blue oracle using Chainlink-compliant feeds. contract ChainlinkOracle is IOracle { + using VaultLib for IERC4626; using ChainlinkDataFeedLib for AggregatorV3Interface; /* IMMUTABLES */ + /// @notice Vault. + IERC4626 public immutable VAULT; + /// @notice Vault conversion sample. The sample amount of shares used to convert to the underlying asset. + /// @notice Should be chosen such that converting `VAULT_CONVERSION_SAMPLE` to assets has enough precision. + uint256 public immutable VAULT_CONVERSION_SAMPLE; /// @notice First base feed. AggregatorV3Interface public immutable BASE_FEED_1; /// @notice Second base feed. @@ -27,20 +35,33 @@ contract ChainlinkOracle is IOracle { /* CONSTRUCTOR */ + /// @param vault Vault. Pass address zero to omit this parameter. /// @param baseFeed1 First base feed. Pass address zero if the price = 1. /// @param baseFeed2 Second base feed. Pass address zero if the price = 1. /// @param quoteFeed1 First quote feed. Pass address zero if the price = 1. /// @param quoteFeed2 Second quote feed. Pass address zero if the price = 1. + /// @param vaultConversionSample Vault conversion sample. Pass 1 if the oracle does not use a vault. /// @param baseTokenDecimals Base token decimals. /// @param quoteTokenDecimals Quote token decimals. constructor( + IERC4626 vault, AggregatorV3Interface baseFeed1, AggregatorV3Interface baseFeed2, AggregatorV3Interface quoteFeed1, AggregatorV3Interface quoteFeed2, + uint256 vaultConversionSample, uint256 baseTokenDecimals, uint256 quoteTokenDecimals ) { + // The vault parameter is used for ERC4626 tokens, to price its shares. + // It is used to price `VAULT_CONVERSION_SAMPLE` of the vault shares, so it requires dividing by that number, + // hence the division by `VAULT_CONVERSION_SAMPLE` in the `SCALE_FACTOR` definition. + // Verify that vault = address(0) => vaultConversionSample = 1. + require( + address(vault) != address(0) || vaultConversionSample == 1, ErrorsLib.VAULT_CONVERSION_SAMPLE_IS_NOT_ONE + ); + VAULT = vault; + VAULT_CONVERSION_SAMPLE = vaultConversionSample; BASE_FEED_1 = baseFeed1; BASE_FEED_2 = baseFeed2; QUOTE_FEED_1 = quoteFeed1; @@ -63,14 +84,15 @@ contract ChainlinkOracle is IOracle { ** ( 36 + quoteTokenDecimals + quoteFeed1.getDecimals() + quoteFeed2.getDecimals() - baseTokenDecimals - baseFeed1.getDecimals() - baseFeed2.getDecimals() - ); + ) / VAULT_CONVERSION_SAMPLE; } /* PRICE */ /// @inheritdoc IOracle function price() external view returns (uint256) { - return (BASE_FEED_1.getPrice() * BASE_FEED_2.getPrice() * SCALE_FACTOR) - / (QUOTE_FEED_1.getPrice() * QUOTE_FEED_2.getPrice()); + return ( + VAULT.getAssets(VAULT_CONVERSION_SAMPLE) * BASE_FEED_1.getPrice() * BASE_FEED_2.getPrice() * SCALE_FACTOR + ) / (QUOTE_FEED_1.getPrice() * QUOTE_FEED_2.getPrice()); } } diff --git a/src/interfaces/IERC4626.sol b/src/interfaces/IERC4626.sol new file mode 100644 index 0000000..224b4cd --- /dev/null +++ b/src/interfaces/IERC4626.sol @@ -0,0 +1,6 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +pragma solidity ^0.8.0; + +interface IERC4626 { + function convertToAssets(uint256) external view returns (uint256); +} diff --git a/src/libraries/ChainlinkDataFeedLib.sol b/src/libraries/ChainlinkDataFeedLib.sol index daf6568..65521d1 100644 --- a/src/libraries/ChainlinkDataFeedLib.sol +++ b/src/libraries/ChainlinkDataFeedLib.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: UNLICENSED +// SPDX-License-Identifier: GPL-2.0-or-later pragma solidity ^0.8.0; import {AggregatorV3Interface} from "../interfaces/AggregatorV3Interface.sol"; diff --git a/src/libraries/ErrorsLib.sol b/src/libraries/ErrorsLib.sol index 2cbf698..dcd6861 100644 --- a/src/libraries/ErrorsLib.sol +++ b/src/libraries/ErrorsLib.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: UNLICENSED +// SPDX-License-Identifier: GPL-2.0-or-later pragma solidity ^0.8.0; /// @title ErrorsLib @@ -8,4 +8,7 @@ pragma solidity ^0.8.0; library ErrorsLib { /// @notice Thrown when the answer returned by a Chainlink feed is negative. string constant NEGATIVE_ANSWER = "negative answer"; + + /// @notice Thrown when the vault conversion sample is not 1 while vault = address(0). + string constant VAULT_CONVERSION_SAMPLE_IS_NOT_ONE = "vault conversion sample is not one"; } diff --git a/src/libraries/VaultLib.sol b/src/libraries/VaultLib.sol new file mode 100644 index 0000000..d667fe3 --- /dev/null +++ b/src/libraries/VaultLib.sol @@ -0,0 +1,18 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +pragma solidity ^0.8.0; + +import {IERC4626} from "../interfaces/IERC4626.sol"; + +/// @title ChainlinkDataFeedLib +/// @author Morpho Labs +/// @custom:contact security@morpho.org +/// @notice Library exposing functions to price shares of an ERC4626 vault. +library VaultLib { + /// @dev Converts `shares` into the corresponding assets on the `vault`. + /// @dev When `vault` is the address zero, returns 1. + function getAssets(IERC4626 vault, uint256 shares) internal view returns (uint256) { + if (address(vault) == address(0)) return 1; + + return vault.convertToAssets(shares); + } +} diff --git a/test/ChainlinkOracleTest.sol b/test/ChainlinkOracleTest.sol index 67deef9..1a727fa 100644 --- a/test/ChainlinkOracleTest.sol +++ b/test/ChainlinkOracleTest.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: UNLICENSED +// SPDX-License-Identifier: GPL-2.0-or-later pragma solidity ^0.8.0; import "forge-std/Test.sol"; @@ -21,6 +21,11 @@ AggregatorV3Interface constant stEthEthFeed = AggregatorV3Interface(0x86392dC19c AggregatorV3Interface constant usdcEthFeed = AggregatorV3Interface(0x986b5E1e1755e3C2440e960477f25201B0a8bbD4); // 8 decimals of precision AggregatorV3Interface constant ethUsdFeed = AggregatorV3Interface(0x5f4eC3Df9cbd43714FE2740f5E3616155c5b8419); +// 18 decimals of precision +AggregatorV3Interface constant daiEthFeed = AggregatorV3Interface(0x773616E4d11A78F511299002da57A0a94577F1f4); + +IERC4626 constant vaultZero = IERC4626(address(0)); +IERC4626 constant sDaiVault = IERC4626(0x83F20F44975D03b1b09e64809B757c47f942BEeA); contract ChainlinkOracleTest is Test { function setUp() public { @@ -28,7 +33,7 @@ contract ChainlinkOracleTest is Test { } function testOracleWbtcUsdc() public { - ChainlinkOracle oracle = new ChainlinkOracle(wBtcBtcFeed, btcUsdFeed, usdcUsdFeed, feedZero, 8, 6); + ChainlinkOracle oracle = new ChainlinkOracle(vaultZero, wBtcBtcFeed, btcUsdFeed, usdcUsdFeed, feedZero, 1, 8, 6); (, int256 firstBaseAnswer,,,) = wBtcBtcFeed.latestRoundData(); (, int256 secondBaseAnswer,,,) = btcUsdFeed.latestRoundData(); (, int256 quoteAnswer,,,) = usdcUsdFeed.latestRoundData(); @@ -40,7 +45,7 @@ contract ChainlinkOracleTest is Test { } function testOracleUsdcWbtc() public { - ChainlinkOracle oracle = new ChainlinkOracle(usdcUsdFeed, feedZero, wBtcBtcFeed, btcUsdFeed, 6, 8); + ChainlinkOracle oracle = new ChainlinkOracle(vaultZero, usdcUsdFeed, feedZero, wBtcBtcFeed, btcUsdFeed, 1, 6, 8); (, int256 baseAnswer,,,) = usdcUsdFeed.latestRoundData(); (, int256 firstQuoteAnswer,,,) = wBtcBtcFeed.latestRoundData(); (, int256 secondQuoteAnswer,,,) = btcUsdFeed.latestRoundData(); @@ -52,41 +57,41 @@ contract ChainlinkOracleTest is Test { } function testOracleWbtcEth() public { - ChainlinkOracle oracle = new ChainlinkOracle(wBtcBtcFeed, btcEthFeed, feedZero, feedZero, 8, 18); + ChainlinkOracle oracle = new ChainlinkOracle(vaultZero,wBtcBtcFeed, btcEthFeed, feedZero, feedZero, 1, 8, 18); (, int256 firstBaseAnswer,,,) = wBtcBtcFeed.latestRoundData(); (, int256 secondBaseAnswer,,,) = btcEthFeed.latestRoundData(); assertEq(oracle.price(), (uint256(firstBaseAnswer) * uint256(secondBaseAnswer) * 10 ** (36 + 18 - 8 - 8 - 18))); } function testOracleStEthUsdc() public { - ChainlinkOracle oracle = new ChainlinkOracle(stEthEthFeed, feedZero, usdcEthFeed, feedZero, 18, 6); + ChainlinkOracle oracle = new ChainlinkOracle(vaultZero, stEthEthFeed, feedZero, usdcEthFeed, feedZero, 1, 18, 6); (, int256 baseAnswer,,,) = stEthEthFeed.latestRoundData(); (, int256 quoteAnswer,,,) = usdcEthFeed.latestRoundData(); assertEq(oracle.price(), uint256(baseAnswer) * 10 ** (36 + 18 + 6 - 18 - 18) / uint256(quoteAnswer)); } function testOracleEthUsd() public { - ChainlinkOracle oracle = new ChainlinkOracle(ethUsdFeed, feedZero, feedZero, feedZero, 18, 0); + ChainlinkOracle oracle = new ChainlinkOracle(vaultZero, ethUsdFeed, feedZero, feedZero, feedZero, 1, 18, 0); (, int256 expectedPrice,,,) = ethUsdFeed.latestRoundData(); assertEq(oracle.price(), uint256(expectedPrice) * 10 ** (36 - 18 - 8)); } function testOracleStEthEth() public { - ChainlinkOracle oracle = new ChainlinkOracle(stEthEthFeed, feedZero, feedZero, feedZero, 18, 18); + ChainlinkOracle oracle = new ChainlinkOracle(vaultZero, stEthEthFeed, feedZero, feedZero, feedZero, 1, 18, 18); (, int256 expectedPrice,,,) = stEthEthFeed.latestRoundData(); assertEq(oracle.price(), uint256(expectedPrice) * 10 ** (36 + 18 - 18 - 18)); assertApproxEqRel(oracle.price(), 1e36, 0.01 ether); } function testOracleEthStEth() public { - ChainlinkOracle oracle = new ChainlinkOracle(feedZero, feedZero, stEthEthFeed, feedZero, 18, 18); + ChainlinkOracle oracle = new ChainlinkOracle(vaultZero, feedZero, feedZero, stEthEthFeed, feedZero, 1, 18, 18); (, int256 expectedPrice,,,) = stEthEthFeed.latestRoundData(); assertEq(oracle.price(), 10 ** (36 + 18 + 18 - 18) / uint256(expectedPrice)); assertApproxEqRel(oracle.price(), 1e36, 0.01 ether); } function testOracleUsdcUsd() public { - ChainlinkOracle oracle = new ChainlinkOracle(usdcUsdFeed, feedZero, feedZero, feedZero, 6, 0); + ChainlinkOracle oracle = new ChainlinkOracle(vaultZero, usdcUsdFeed, feedZero, feedZero, feedZero, 1, 6, 0); assertApproxEqRel(oracle.price(), 1e36 / 1e6, 0.01 ether); } @@ -94,9 +99,42 @@ contract ChainlinkOracleTest is Test { price = bound(price, type(int256).min, -1); ChainlinkAggregatorMock aggregator = new ChainlinkAggregatorMock(); ChainlinkOracle oracle = - new ChainlinkOracle(AggregatorV3Interface(address(aggregator)), feedZero, feedZero, feedZero, 18, 0); + new ChainlinkOracle(vaultZero, AggregatorV3Interface(address(aggregator)), feedZero, feedZero, feedZero, 1, 18, 0); aggregator.setAnwser(price); vm.expectRevert(bytes(ErrorsLib.NEGATIVE_ANSWER)); oracle.price(); } + + function testSDaiEthOracle() public { + ChainlinkOracle oracle = + new ChainlinkOracle(sDaiVault, daiEthFeed, feedZero, feedZero, feedZero, 10 ** 18, 18, 18); + (, int256 expectedPrice,,,) = daiEthFeed.latestRoundData(); + assertEq( + oracle.price(), + sDaiVault.convertToAssets(1e18) * uint256(expectedPrice) * 10 ** (36 + 18 + 0 - 18 - 18 - 18) + ); + } + + function testSDaiUsdcOracle() public { + ChainlinkOracle oracle = + new ChainlinkOracle(sDaiVault, daiEthFeed, feedZero, usdcEthFeed, feedZero, 10 ** 18, 18, 6); + (, int256 baseAnswer,,,) = daiEthFeed.latestRoundData(); + (, int256 quoteAnswer,,,) = usdcEthFeed.latestRoundData(); + assertEq( + oracle.price(), + sDaiVault.convertToAssets(1e18) * uint256(baseAnswer) * 10 ** (36 + 6 + 18 - 18 - 18 - 18) + / uint256(quoteAnswer) + ); + // DAI has 12 more decimals than USDC. + uint256 expectedPrice = 10 ** (36 - 12); + // Admit a 50% interest gain before breaking this test. + uint256 deviation = 0.5 ether; + assertApproxEqRel(oracle.price(), expectedPrice, deviation); + } + + function testConstructorVaultZeroNonOneSample(uint256 vaultConversionSample) public { + vm.assume(vaultConversionSample != 1); + vm.expectRevert(bytes(ErrorsLib.VAULT_CONVERSION_SAMPLE_IS_NOT_ONE)); + new ChainlinkOracle(vaultZero, daiEthFeed, feedZero, usdcEthFeed, feedZero, vaultConversionSample, 18, 6); + } } diff --git a/test/mocks/ChainlinkAggregatorMock.sol b/test/mocks/ChainlinkAggregatorMock.sol index b81c8eb..f446ca6 100644 --- a/test/mocks/ChainlinkAggregatorMock.sol +++ b/test/mocks/ChainlinkAggregatorMock.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: UNLICENSED +// SPDX-License-Identifier: GPL-2.0-or-later pragma solidity ^0.8.0; contract ChainlinkAggregatorMock {