Skip to content

Commit

Permalink
Merge branch 'woof-software/custom-price-feed-for-rsweth-on-mainnet' …
Browse files Browse the repository at this point in the history
…of github.com:woof-software/comet into woof-software/add-rsweth-to-mainnet-weth
  • Loading branch information
MishaShWoof committed Aug 5, 2024
2 parents 7fa46d7 + 00034ba commit 8ce39b4
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 0 deletions.
98 changes: 98 additions & 0 deletions contracts/pricefeeds/RswETHExchangePriceFeed.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
// SPDX-License-Identifier: BUSL-1.1
pragma solidity 0.8.15;

import "../vendor/swell/IRswETH.sol";
import "../IPriceFeed.sol";

/**
* @title rswETH Scaling price feed
* @notice A custom price feed that scales up or down the price received from an underlying rswETH / ETH exchange rate price feed and returns the result
* @author Compound
*/
contract RswETHExchangePriceFeed is IPriceFeed {
/** Custom errors **/
error InvalidInt256();
error BadDecimals();

/// @notice Version of the price feed
uint public constant VERSION = 1;

/// @notice Description of the price feed
string public description;

/// @notice Number of decimals for returned prices
uint8 public immutable override decimals;

/// @notice rswETH price feed where prices are fetched from
address public immutable underlyingPriceFeed;

/// @notice Whether or not the price should be upscaled
bool internal immutable shouldUpscale;

/// @notice The amount to upscale or downscale the price by
int256 internal immutable rescaleFactor;

/**
* @notice Construct a new rswETH scaling price feed
* @param rswETH The address of the rswETH to fetch prices from
* @param decimals_ The number of decimals for the returned prices
**/
constructor(address rswETH, uint8 decimals_, string memory description_) {
underlyingPriceFeed = rswETH;
if (decimals_ > 18) revert BadDecimals();
decimals = decimals_;
description = description_;

uint8 rswETHDecimals = 18;
// Note: Solidity does not allow setting immutables in if/else statements
shouldUpscale = rswETHDecimals < decimals_ ? true : false;
rescaleFactor = (shouldUpscale
? signed256(10 ** (decimals_ -rswETHDecimals))
: signed256(10 ** (rswETHDecimals - decimals_))
);
}

Check warning

Code scanning / Semgrep OSS

Semgrep Finding: compound.solidity.missing-constructor-sanity-checks Warning

There're no sanity checks for the constructor argument description_.

Check warning

Code scanning / Semgrep OSS

Semgrep Finding: compound.solidity.missing-constructor-sanity-checks Warning

There're no sanity checks for the constructor argument rswETH.

Check notice

Code scanning / Semgrep OSS

Semgrep Finding: rules.solidity.performance.non-payable-constructor Note

Consider making costructor payable to save gas.

/**
* @notice Price for the latest round
* @return roundId Round id from the underlying price feed
* @return answer Latest price for the asset in terms of ETH
* @return startedAt Timestamp when the round was started; passed on from underlying price feed
* @return updatedAt Timestamp when the round was last updated; passed on from underlying price feed
* @return answeredInRound Round id in which the answer was computed; passed on from underlying price feed
**/
function latestRoundData() override external view returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
) {
uint256 rate = IRswETH(underlyingPriceFeed).rswETHToETHRate();
// protocol uses only the answer value. Other data fields are not provided by the underlying pricefeed and are not used in Comet protocol
// https://etherscan.io/address/0x387dBc0fB00b26fb085aa658527D5BE98302c84C#readProxyContract
return (1, scalePrice(signed256(rate)), block.timestamp, block.timestamp, 1);
}

function signed256(uint256 n) internal pure returns (int256) {
if (n > uint256(type(int256).max)) revert InvalidInt256();
return int256(n);
}

function scalePrice(int256 price) internal view returns (int256) {
int256 scaledPrice;
if (shouldUpscale) {
scaledPrice = price * rescaleFactor;
} else {
scaledPrice = price / rescaleFactor;
}
return scaledPrice;
}

/**
* @notice Price for the latest round
* @return The version of the price feed contract
**/
function version() external pure returns (uint256) {
return VERSION;
}
}
6 changes: 6 additions & 0 deletions contracts/vendor/swell/IRswETH.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

interface IRswETH {
function rswETHToETHRate() external view returns (uint256);
}

0 comments on commit 8ce39b4

Please sign in to comment.