-
Notifications
You must be signed in to change notification settings - Fork 148
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add wUSDM as collateral to USDT market on Optimism #945
Open
MishaShWoof
wants to merge
12
commits into
compound-finance:main
Choose a base branch
from
woof-software:woof-software/add-wusdm-to-optimism-usdt
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
cd92eb6
feat: wUSDM price feed
MishaShWoof e769138
fix: rename
MishaShWoof 6f7d5ec
fix: sync version
MishaShWoof 53bc4b9
fix: remove comment
MishaShWoof f3782e7
Merge branch 'woof-software/wusdm-price-feed' of github.com:woof-soft…
MishaShWoof ca4ff5e
feat: migration
MishaShWoof b51bce6
fix: pr link
MishaShWoof 4295a53
fix: audit fix
MishaShWoof b04a946
fix: force deploy
MishaShWoof 131f995
Merge branch 'woof-software/wusdm-price-feed' of github.com:woof-soft…
MishaShWoof 332d9cd
Merge branch 'main' of github.com:woof-software/comet into woof-softw…
MishaShWoof 6116139
feat: add ankr RPC for Optimism and Base
vitalii-woof-software File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,230 @@ | ||
// SPDX-License-Identifier: MIT | ||
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC4626.sol) | ||
|
||
pragma solidity 0.8.15; | ||
|
||
/** | ||
* @dev Interface of the ERC-4626 "Tokenized Vault Standard", as defined in | ||
* https://eips.ethereum.org/EIPS/eip-4626[ERC-4626]. | ||
*/ | ||
interface IERC4626 { | ||
event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares); | ||
|
||
event Withdraw( | ||
address indexed sender, | ||
address indexed receiver, | ||
address indexed owner, | ||
uint256 assets, | ||
uint256 shares | ||
); | ||
|
||
/// @dev Returns decimals of the Vault shares. | ||
function decimals() external view returns (uint8); | ||
|
||
/** | ||
* @dev Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing. | ||
* | ||
* - MUST be an ERC-20 token contract. | ||
* - MUST NOT revert. | ||
*/ | ||
function asset() external view returns (address assetTokenAddress); | ||
|
||
/** | ||
* @dev Returns the total amount of the underlying asset that is “managed” by Vault. | ||
* | ||
* - SHOULD include any compounding that occurs from yield. | ||
* - MUST be inclusive of any fees that are charged against assets in the Vault. | ||
* - MUST NOT revert. | ||
*/ | ||
function totalAssets() external view returns (uint256 totalManagedAssets); | ||
|
||
/** | ||
* @dev Returns the amount of shares that the Vault would exchange for the amount of assets provided, in an ideal | ||
* scenario where all the conditions are met. | ||
* | ||
* - MUST NOT be inclusive of any fees that are charged against assets in the Vault. | ||
* - MUST NOT show any variations depending on the caller. | ||
* - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange. | ||
* - MUST NOT revert. | ||
* | ||
* NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the | ||
* “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and | ||
* from. | ||
*/ | ||
function convertToShares(uint256 assets) external view returns (uint256 shares); | ||
|
||
/** | ||
* @dev Returns the amount of assets that the Vault would exchange for the amount of shares provided, in an ideal | ||
* scenario where all the conditions are met. | ||
* | ||
* - MUST NOT be inclusive of any fees that are charged against assets in the Vault. | ||
* - MUST NOT show any variations depending on the caller. | ||
* - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange. | ||
* - MUST NOT revert. | ||
* | ||
* NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the | ||
* “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and | ||
* from. | ||
*/ | ||
function convertToAssets(uint256 shares) external view returns (uint256 assets); | ||
|
||
/** | ||
* @dev Returns the maximum amount of the underlying asset that can be deposited into the Vault for the receiver, | ||
* through a deposit call. | ||
* | ||
* - MUST return a limited value if receiver is subject to some deposit limit. | ||
* - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited. | ||
* - MUST NOT revert. | ||
*/ | ||
function maxDeposit(address receiver) external view returns (uint256 maxAssets); | ||
|
||
/** | ||
* @dev Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given | ||
* current on-chain conditions. | ||
* | ||
* - MUST return as close to and no more than the exact amount of Vault shares that would be minted in a deposit | ||
* call in the same transaction. I.e. deposit should return the same or more shares as previewDeposit if called | ||
* in the same transaction. | ||
* - MUST NOT account for deposit limits like those returned from maxDeposit and should always act as though the | ||
* deposit would be accepted, regardless if the user has enough tokens approved, etc. | ||
* - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees. | ||
* - MUST NOT revert. | ||
* | ||
* NOTE: any unfavorable discrepancy between convertToShares and previewDeposit SHOULD be considered slippage in | ||
* share price or some other type of condition, meaning the depositor will lose assets by depositing. | ||
*/ | ||
function previewDeposit(uint256 assets) external view returns (uint256 shares); | ||
|
||
/** | ||
* @dev Mints shares Vault shares to receiver by depositing exactly amount of underlying tokens. | ||
* | ||
* - MUST emit the Deposit event. | ||
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the | ||
* deposit execution, and are accounted for during deposit. | ||
* - MUST revert if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not | ||
* approving enough underlying tokens to the Vault contract, etc). | ||
* | ||
* NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token. | ||
*/ | ||
function deposit(uint256 assets, address receiver) external returns (uint256 shares); | ||
|
||
/** | ||
* @dev Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call. | ||
* - MUST return a limited value if receiver is subject to some mint limit. | ||
* - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted. | ||
* - MUST NOT revert. | ||
*/ | ||
function maxMint(address receiver) external view returns (uint256 maxShares); | ||
|
||
/** | ||
* @dev Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given | ||
* current on-chain conditions. | ||
* | ||
* - MUST return as close to and no fewer than the exact amount of assets that would be deposited in a mint call | ||
* in the same transaction. I.e. mint should return the same or fewer assets as previewMint if called in the | ||
* same transaction. | ||
* - MUST NOT account for mint limits like those returned from maxMint and should always act as though the mint | ||
* would be accepted, regardless if the user has enough tokens approved, etc. | ||
* - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees. | ||
* - MUST NOT revert. | ||
* | ||
* NOTE: any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in | ||
* share price or some other type of condition, meaning the depositor will lose assets by minting. | ||
*/ | ||
function previewMint(uint256 shares) external view returns (uint256 assets); | ||
|
||
/** | ||
* @dev Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens. | ||
* | ||
* - MUST emit the Deposit event. | ||
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint | ||
* execution, and are accounted for during mint. | ||
* - MUST revert if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not | ||
* approving enough underlying tokens to the Vault contract, etc). | ||
* | ||
* NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token. | ||
*/ | ||
function mint(uint256 shares, address receiver) external returns (uint256 assets); | ||
|
||
/** | ||
* @dev Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the | ||
* Vault, through a withdraw call. | ||
* | ||
* - MUST return a limited value if owner is subject to some withdrawal limit or timelock. | ||
* - MUST NOT revert. | ||
*/ | ||
function maxWithdraw(address owner) external view returns (uint256 maxAssets); | ||
|
||
/** | ||
* @dev Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block, | ||
* given current on-chain conditions. | ||
* | ||
* - MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw | ||
* call in the same transaction. I.e. withdraw should return the same or fewer shares as previewWithdraw if | ||
* called | ||
* in the same transaction. | ||
* - MUST NOT account for withdrawal limits like those returned from maxWithdraw and should always act as though | ||
* the withdrawal would be accepted, regardless if the user has enough shares, etc. | ||
* - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees. | ||
* - MUST NOT revert. | ||
* | ||
* NOTE: any unfavorable discrepancy between convertToShares and previewWithdraw SHOULD be considered slippage in | ||
* share price or some other type of condition, meaning the depositor will lose assets by depositing. | ||
*/ | ||
function previewWithdraw(uint256 assets) external view returns (uint256 shares); | ||
|
||
/** | ||
* @dev Burns shares from owner and sends exactly assets of underlying tokens to receiver. | ||
* | ||
* - MUST emit the Withdraw event. | ||
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the | ||
* withdraw execution, and are accounted for during withdraw. | ||
* - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner | ||
* not having enough shares, etc). | ||
* | ||
* Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed. | ||
* Those methods should be performed separately. | ||
*/ | ||
function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares); | ||
|
||
/** | ||
* @dev Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault, | ||
* through a redeem call. | ||
* | ||
* - MUST return a limited value if owner is subject to some withdrawal limit or timelock. | ||
* - MUST return balanceOf(owner) if owner is not subject to any withdrawal limit or timelock. | ||
* - MUST NOT revert. | ||
*/ | ||
function maxRedeem(address owner) external view returns (uint256 maxShares); | ||
|
||
/** | ||
* @dev Allows an on-chain or off-chain user to simulate the effects of their redeemption at the current block, | ||
* given current on-chain conditions. | ||
* | ||
* - MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call | ||
* in the same transaction. I.e. redeem should return the same or more assets as previewRedeem if called in the | ||
* same transaction. | ||
* - MUST NOT account for redemption limits like those returned from maxRedeem and should always act as though the | ||
* redemption would be accepted, regardless if the user has enough shares, etc. | ||
* - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees. | ||
* - MUST NOT revert. | ||
* | ||
* NOTE: any unfavorable discrepancy between convertToAssets and previewRedeem SHOULD be considered slippage in | ||
* share price or some other type of condition, meaning the depositor will lose assets by redeeming. | ||
*/ | ||
function previewRedeem(uint256 shares) external view returns (uint256 assets); | ||
|
||
/** | ||
* @dev Burns exactly shares from owner and sends assets of underlying tokens to receiver. | ||
* | ||
* - MUST emit the Withdraw event. | ||
* - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the | ||
* redeem execution, and are accounted for during redeem. | ||
* - MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner | ||
* not having enough shares, etc). | ||
* | ||
* NOTE: some implementations will require pre-requesting to the Vault before a withdrawal may be performed. | ||
* Those methods should be performed separately. | ||
*/ | ||
function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
// SPDX-License-Identifier: BUSL-1.1 | ||
pragma solidity 0.8.15; | ||
|
||
import "../vendor/@chainlink/contracts/src/v0.8/interfaces/AggregatorV3Interface.sol"; | ||
import "../IERC4626.sol"; | ||
import "../IPriceFeed.sol"; | ||
|
||
/** | ||
* @title Price feed for ERC4626 assets | ||
* @notice A custom price feed that calculates the price for an ERC4626 asset | ||
* @author Compound | ||
*/ | ||
contract PriceFeedWith4626Support is IPriceFeed { | ||
/** Custom errors **/ | ||
error BadDecimals(); | ||
error InvalidInt256(); | ||
|
||
/// @notice Version of the price feed | ||
uint public constant VERSION = 1; | ||
|
||
/// @notice Description of the price feed | ||
string public override description; | ||
|
||
/// @notice Number of decimals for returned prices | ||
uint8 public immutable override decimals; | ||
|
||
/// @notice Number of decimals for the 4626 rate provider | ||
uint8 rateProviderDecimals; | ||
|
||
/// @notice Number of decimals for the underlying asset | ||
uint8 underlyingDecimals; | ||
|
||
/// @notice 4626 rate provider | ||
address public immutable rateProvider; | ||
|
||
/// @notice Chainlink oracle for the underlying asset | ||
address public immutable underlyingPriceFeed; | ||
|
||
/// @notice Combined scale of the two underlying price feeds | ||
int public immutable combinedScale; | ||
|
||
/// @notice Scale of this price feed | ||
int public immutable priceFeedScale; | ||
|
||
/** | ||
* @notice Construct a new 4626 price feed | ||
* @param rateProvider_ The address of the 4626 rate provider | ||
* @param underlyingPriceFeed_ The address of the underlying asset price feed to fetch prices from | ||
* @param decimals_ The number of decimals for the returned prices | ||
**/ | ||
constructor(address rateProvider_, address underlyingPriceFeed_, uint8 decimals_, string memory description_) { | ||
rateProvider = rateProvider_; | ||
underlyingPriceFeed = underlyingPriceFeed_; | ||
rateProviderDecimals = IERC4626(rateProvider_).decimals(); | ||
underlyingDecimals = AggregatorV3Interface(underlyingPriceFeed_).decimals(); | ||
combinedScale = signed256(10 ** (rateProviderDecimals + underlyingDecimals)); | ||
description = description_; | ||
|
||
if (decimals_ > 18) revert BadDecimals(); | ||
decimals = decimals_; | ||
priceFeedScale = int256(10 ** decimals); | ||
} | ||
|
||
/** | ||
* @notice Get the latest price for the underlying asset | ||
* @return roundId Round id from the underlying asset price feed | ||
* @return answer Latest price for the underlying asset | ||
* @return startedAt Timestamp when the round was started; passed on from the underlying asset price feed | ||
* @return updatedAt Timestamp when the round was last updated; passed on from the underlying asset price feed | ||
* @return answeredInRound Round id in which the answer was computed; passed on from the underlying asset price feed | ||
**/ | ||
function latestRoundData() override external view returns (uint80, int256, uint256, uint256, uint80) { | ||
uint256 rate = IERC4626(rateProvider).convertToAssets(10**rateProviderDecimals); | ||
(uint80 roundId_, int256 underlyingPrice, uint256 startedAt_, uint256 updatedAt_, uint80 answeredInRound_) = AggregatorV3Interface(underlyingPriceFeed).latestRoundData(); | ||
|
||
if (rate <= 0 || underlyingPrice <= 0) return (roundId_, 0, startedAt_, updatedAt_, answeredInRound_); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: since |
||
|
||
int256 price = signed256(rate) * underlyingPrice * priceFeedScale / combinedScale; | ||
return (roundId_, price, startedAt_, updatedAt_, answeredInRound_); | ||
} | ||
|
||
function signed256(uint256 n) internal pure returns (int256) { | ||
if (n > uint256(type(int256).max)) revert InvalidInt256(); | ||
return int256(n); | ||
} | ||
|
||
/** | ||
* @notice Price for the latest round | ||
* @return The version of the price feed contract | ||
**/ | ||
function version() external pure returns (uint256) { | ||
return VERSION; | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: having this comparison at the beginning might be better for readability