Skip to content

Latest commit

 

History

History
463 lines (391 loc) · 14.8 KB

PriceFeedV1PoolOracle.md

File metadata and controls

463 lines (391 loc) · 14.8 KB

PriceFeedV1PoolOracle.sol

View Source: contracts/feeds/PriceFeedV1PoolOracle.sol

↗ Extends: IPriceFeedsExt, Ownable

PriceFeedV1PoolOracle contract

The Price Feed V1 Pool Oracle contract.

  • This contract implements V1 Pool Oracle query functionality, getting the price from v1 pool oracle.

Contract Members

Constants & Variables

address public v1PoolOracleAddress;
address public wRBTCAddress;
address public docAddress;
address public baseCurrency;

Events

event SetV1PoolOracleAddress(address indexed v1PoolOracleAddress, address  changerAddress);
event SetWRBTCAddress(address indexed wRBTCAddress, address  changerAddress);
event SetDOCAddress(address indexed docAddress, address  changerAddress);
event SetBaseCurrency(address indexed baseCurrency, address  changerAddress);

Functions

constructor

Initialize a new V1 Pool Oracle. *

function (address _v1PoolOracleAddress, address _wRBTCAddress, address _docAddress, address _baseCurrency) public nonpayable

Arguments

Name Type Description
_v1PoolOracleAddress address The V1 Pool Oracle address.
_wRBTCAddress address The wrbtc token address.
_docAddress address The doc token address.
_baseCurrency address
Source Code 
constructor(
        address _v1PoolOracleAddress,
        address _wRBTCAddress,
        address _docAddress,
        address _baseCurrency
    ) public {
        setRBTCAddress(_wRBTCAddress);
        setDOCAddress(_docAddress);
        setV1PoolOracleAddress(_v1PoolOracleAddress);
        setBaseCurrency(_baseCurrency);
    }

latestAnswer

undefined

Get the oracle price.

function latestAnswer() external view
returns(uint256)
Source Code 
function latestAnswer() external view returns (uint256) {
        IV1PoolOracle _v1PoolOracle = IV1PoolOracle(v1PoolOracleAddress);

        uint256 _price = _v1PoolOracle.latestPrice(baseCurrency);

        // Need to convert to USD, since the V1 pool return value is based on BTC
        uint256 priceInUSD = _convertAnswerToUsd(_price);
        require(priceInUSD != 0, "price error");

        return priceInUSD;
    }

_convertAnswerToUsd

function _convertAnswerToUsd(uint256 _valueInBTC) private view
returns(uint256)

Arguments

Name Type Description
_valueInBTC uint256
Source Code 
function _convertAnswerToUsd(uint256 _valueInBTC) private view returns (uint256) {
        address _priceFeeds = msg.sender;

        uint256 precision = IPriceFeeds(_priceFeeds).queryPrecision(wRBTCAddress, docAddress);
        uint256 valueInUSD =
            IPriceFeeds(_priceFeeds).queryReturn(wRBTCAddress, docAddress, _valueInBTC);

        /// Need to multiply by query precision (doc's precision) and divide by 1*10^18 (Because the based price in v1 pool is using 18 decimals)
        return valueInUSD.mul(precision).div(1e18);
    }

setV1PoolOracleAddress

Set the V1 Pool Oracle address. *

function setV1PoolOracleAddress(address _v1PoolOracleAddress) public nonpayable onlyOwner

Arguments

Name Type Description
_v1PoolOracleAddress address The V1 Pool Oracle address.
Source Code 
function setV1PoolOracleAddress(address _v1PoolOracleAddress) public onlyOwner {
        require(Address.isContract(_v1PoolOracleAddress), "_v1PoolOracleAddress not a contract");
        IV1PoolOracle _v1PoolOracle = IV1PoolOracle(_v1PoolOracleAddress);
        address liquidityPool = _v1PoolOracle.liquidityPool();
        require(
            ILiquidityPoolV1Converter(liquidityPool).reserveTokens(0) == wRBTCAddress ||
                ILiquidityPoolV1Converter(liquidityPool).reserveTokens(1) == wRBTCAddress,
            "one of the two reserves needs to be wrbtc"
        );
        v1PoolOracleAddress = _v1PoolOracleAddress;
        emit SetV1PoolOracleAddress(v1PoolOracleAddress, msg.sender);
    }

setRBTCAddress

Set the rBtc address. V1 pool based price is BTC, so need to convert the value from v1 pool to USD. That's why we need to get the price of the rBtc *

function setRBTCAddress(address _wRBTCAddress) public nonpayable onlyOwner

Arguments

Name Type Description
_wRBTCAddress address The rBTC address
Source Code 
function setRBTCAddress(address _wRBTCAddress) public onlyOwner {
        require(_wRBTCAddress != address(0), "wRBTC address cannot be zero address");
        wRBTCAddress = _wRBTCAddress;
        emit SetWRBTCAddress(wRBTCAddress, msg.sender);
    }

setDOCAddress

Set the DoC address. V1 pool based price is BTC, so need to convert the value from v1 pool to USD. That's why we need to get the price of the DoC *

function setDOCAddress(address _docAddress) public nonpayable onlyOwner

Arguments

Name Type Description
_docAddress address The DoC address
Source Code 
function setDOCAddress(address _docAddress) public onlyOwner {
        require(_docAddress != address(0), "DOC address cannot be zero address");
        docAddress = _docAddress;
        emit SetDOCAddress(_docAddress, msg.sender);
    }

setBaseCurrency

Set the base currency address. That's the reserve address which is not WRBTC *

function setBaseCurrency(address _baseCurrency) public nonpayable onlyOwner

Arguments

Name Type Description
_baseCurrency address The base currency address
Source Code 
function setBaseCurrency(address _baseCurrency) public onlyOwner {
        require(_baseCurrency != address(0), "Base currency address cannot be zero address");
        baseCurrency = _baseCurrency;
        emit SetBaseCurrency(_baseCurrency, msg.sender);
    }

Contracts