Merge pull request #38 from immunefi-team/oracle_mocking

Oracle mocking

src/oracle/README.md

@@ -0,0 +1,49 @@
+## Vulnerability Type
+This template is designed for developing attack proof of concepts (PoCs) that exploit vulnerabilities which rely on data returned by an oracle. Please note: When crafting a PoC which manipulates oracle data, the oracle manipulation must be achievable independently from the attack. Oracle mocking allows for easier testing of situations where the mocked oracle data is known to be achievable by other means. If the data returned is not achievable in normal operation of the Oracle, the vulnerability is not considered valid. The template supports manipulation of the following oracles:
+
+<details>
+  <summary>
+
+### Ethereum
+  </summary>
+
+| Network | Oracle Provider | Library |
+| ------- | --------------- | ------- |
+| Ethereum | Chainlink | [Chainlink](./lib/MockChainLink.sol) |
+| Ethereum | Band Oracle | [Band](./lib/MockBand.sol) |
+| Ethereum | Pyth Oracle | [Pyth](./lib/MockPyth.sol) |
+
+</details>
+
+## Usage
+The following attack contract demonstrates simple oracle data manipulation:
+* [OracleManipulationExample](./examples/MockOracleExample.sol)
+
+Extend the `MockOracleExample` contract:
+```Solidity
+contract Attack is MockOracleExample { }
+```
+
+Please be aware that various oracles adhere to distinct `mockOracleData` structures and types.
+
+To identify the specific naming parameters required, examine the library code. For instance, within [Pyth](./lib/MockPyth.sol), there exists a `PriceFeeds` library that contains all the `bytes32` quotes for the pair.
+
+For guidance on how to import and utilize the libraries, refer to the example provided below.
+
+```Solidity
+    import "../lib/MockPyth.sol";
+    import "../lib/MockChainLink.sol";
+    import "../lib/MockBand.sol";
+
+    function initiateAttack() external {
+        //1. PYTH ORACLE
+        MockPyth.mockOracleData(PriceFeeds.Crypto_BNB_USD, 1337);
+
+        //2. CHAINLINK ORACLE
+        MockChainLink.mockOracleData(EthereumTokens.LINK, Fiat.USD, 1337);
+
+        //3. BAND ORACLE
+        MockBand.mockOracleData("STRK", "USD", 1337);
+        _executeAttack();
+    }
+```

src/oracle/examples/MockOracleExample.sol

@@ -0,0 +1,43 @@
+pragma solidity ^0.8.0;
+
+import "forge-std/console.sol";
+
+import "../../tokens/Tokens.sol";
+
+import "../lib/MockPyth.sol";
+import "../lib/MockChainLink.sol";
+import "../lib/MockBand.sol";
+
+contract MockOracleExample {
+    function initiateAttack() external {
+        //1. PYTH ORACLE
+        MockPyth.mockOracleData(PriceFeeds.Crypto_BNB_USD, 1337);
+        //2. CHAINLINK ORACLE
+        MockChainLink.mockOracleData(EthereumTokens.LINK, Fiat.USD, 1337); // LINK/USD
+        //3. BAND ORACLE
+        MockBand.mockOracleData("STRK", "USD", 1337);
+        _executeAttack();
+    }
+
+    function _executeAttack() internal {
+        //1. PYTH ORACLE
+        PythUpgradable pyth = PythUpgradable(0x4305FB66699C3B2702D4d05CF36551390A4c69C6);
+        PythUpgradable.Price memory p = pyth.getPriceUnsafe(PriceFeeds.Crypto_BNB_USD);
+        console.logInt(p.price);
+        _completeAttack();
+
+        //2. CHAINLINK ORACLE
+        FeedRegistryInterface chainlinkRegistry = FeedRegistryInterface(0x47Fb2585D2C56Fe188D0E6ec628a38b74fCeeeDf);
+        (, int256 answer,,,) = chainlinkRegistry.latestRoundData(EthereumTokens.LINK, Fiat.USD);
+        console.logInt(answer);
+        _completeAttack();
+
+        //3. BAND ORACLE
+        IStdReference bandRegistry = IStdReference(0xDA7a001b254CD22e46d3eAB04d937489c93174C3);
+        IStdReference.ReferenceData memory data = bandRegistry.getReferenceData("STRK", "USD");
+        console.log(data.rate);
+        _completeAttack();
+    }
+
+    function _completeAttack() internal {}
+}

src/oracle/lib/MockBand.sol

@@ -0,0 +1,277 @@
+pragma solidity ^0.8.0;
+
+import "../../tokens/Tokens.sol";
+import "forge-std/Vm.sol";
+
+library MockBand {
+    address constant HEVM_ADDRESS = address(bytes20(uint160(uint256(keccak256("hevm cheat code")))));
+    Vm constant vm = Vm(HEVM_ADDRESS);
+
+    struct Context {
+        IStdReference ref;
+    }
+
+    function mockOracleData(string memory baseToken, string memory quoteToken, uint256 price) internal {
+        Context memory context = context();
+
+        IStdReference.ReferenceData memory data = context.ref.getReferenceData(baseToken, quoteToken);
+
+        vm.mockCall(
+            address(context.ref),
+            abi.encodeCall(IStdReference.getReferenceData, (baseToken, quoteToken)),
+            abi.encode(price, data.lastUpdatedBase, data.lastUpdatedQuote)
+        );
+    }
+
+    function context() internal view returns (Context memory) {
+        IStdReference ref;
+
+        // https://docs.bandchain.org/develop/supported-blockchains/#mainnets
+        if (block.chainid == 1) {
+            // Ethereum Mainnet
+            ref = IStdReference(0xDA7a001b254CD22e46d3eAB04d937489c93174C3);
+        } else if (block.chainid == 10) {
+            // Optimism
+            ref = IStdReference(0xDA7a001b254CD22e46d3eAB04d937489c93174C3);
+        } else if (block.chainid == 56) {
+            // BSC
+            ref = IStdReference(0xDA7a001b254CD22e46d3eAB04d937489c93174C3);
+        } else if (block.chainid == 43114) {
+            // Avalanche
+            ref = IStdReference(0x75B01902D9297fD381bcF3B155a8cEAC78F5A35E);
+        } else if (block.chainid == 42220) {
+            // Celo
+            ref = IStdReference(0xDA7a001b254CD22e46d3eAB04d937489c93174C3);
+        } else if (block.chainid == 32659) {
+            // Fusion
+            ref = IStdReference(0xDA7a001b254CD22e46d3eAB04d937489c93174C3);
+        } else if (block.chainid == 2020) {
+            // Horizen (EON)
+            ref = IStdReference(0xA55d9ef16Af921b70Fed1421C1D298Ca5A3a18F1);
+        } else if (block.chainid == 82) {
+            // Meter
+            ref = IStdReference(0x861C20f77f194EEa4f86e0d39069D789265A3A82);
+        } else if (block.chainid == 1285) {
+            // Moonriver
+            ref = IStdReference(0x75B01902D9297fD381bcF3B155a8cEAC78F5A35E);
+        } else {
+            console.log(block.chainid);
+            revert("MockBandOracle: Chain not supported");
+        }
+
+        return Context(ref);
+    }
+}
+
+interface IStdReference {
+    /// A structure returned whenever someone requests for standard reference data.
+    struct ReferenceData {
+        uint256 rate; // base/quote exchange rate, multiplied by 1e18.
+        uint256 lastUpdatedBase; // UNIX epoch of the last time when base price gets updated.
+        uint256 lastUpdatedQuote; // UNIX epoch of the last time when quote price gets updated.
+    }
+
+    /// Returns the price data for the given base/quote pair. Revert if not available.
+    function getReferenceData(string memory _base, string memory _quote) external view returns (ReferenceData memory);
+
+    /// Similar to getReferenceData, but with multiple base/quote pairs at once.
+    function getReferenceDataBulk(string[] memory _bases, string[] memory _quotes)
+        external
+        view
+        returns (ReferenceData[] memory);
+}
+
+//TODO: Integrate this : https://github.com/bandprotocol/IPFS/blob/06c2693da8976b5a3caafb8a30470e791f75a781/testnet/staging/crypto.rs#L44
+library BaseQuoteTokens {
+    enum Base {
+        AAVE,
+        ABYSS,
+        ADA,
+        AKRO,
+        ALCX,
+        ALGO,
+        ALPHA,
+        AMPL,
+        ANC,
+        ANT,
+        ARPA,
+        AST,
+        ATOM,
+        AUTO,
+        AVAX,
+        AXS,
+        BAL,
+        BAND,
+        BAT,
+        BCH,
+        BEL,
+        BETA,
+        BLZ,
+        BNB,
+        BNT,
+        BOBA,
+        BSV,
+        BTC,
+        BTG,
+        BTM,
+        BTS,
+        BTT,
+        BUSD,
+        BZRX,
+        C98,
+        CAKE,
+        CELO,
+        CKB,
+        COMP,
+        CREAM,
+        CRO,
+        CRV,
+        CUSD,
+        CVC,
+        DAI,
+        DASH,
+        DCR,
+        DGB,
+        DIA,
+        DOGE,
+        DOT,
+        DPI,
+        EGLD,
+        ELF,
+        ENJ,
+        EOS,
+        ETC,
+        ETH,
+        EURS,
+        EWT,
+        FET,
+        FIL,
+        FOR,
+        FRAX,
+        FTM,
+        FTT,
+        GNO,
+        GRT,
+        HBAR,
+        HEGIC,
+        HT,
+        ICX,
+        INJ,
+        IOST,
+        IOTX,
+        JOE,
+        JST,
+        KAI,
+        KAVA,
+        KDA,
+        KEY,
+        KMD,
+        KP3R,
+        KSM,
+        LEO,
+        LINA,
+        LINK,
+        LOOM,
+        LRC,
+        LSK,
+        LTC,
+        LUNA,
+        MANA,
+        MATIC,
+        MIM,
+        MIOTA,
+        MIR,
+        MKR,
+        MLN,
+        MOVR,
+        MTA,
+        MTL,
+        MVL,
+        NEAR,
+        NEO,
+        NMR,
+        OCEAN,
+        OGN,
+        OKB,
+        OMG,
+        ONE,
+        ONT,
+        OSMO,
+        PAXG,
+        PERP,
+        PICKLE,
+        PLR,
+        PNK,
+        PNT,
+        POLY,
+        POWR,
+        QKC,
+        QNT,
+        QTUM,
+        REN,
+        REP,
+        REQ,
+        RLC,
+        ROSE,
+        RSR,
+        RSV,
+        RUNE,
+        RVN,
+        SAND,
+        SC,
+        SCRT,
+        SFI,
+        SHIB,
+        SNT,
+        SNX,
+        SOL,
+        SPELL,
+        SRM,
+        STMX,
+        STORJ,
+        STRK,
+        STX,
+        SUSD,
+        SUSHI,
+        SXP,
+        THETA,
+        TOMO,
+        TRB,
+        TRX,
+        TUSD,
+        TWT,
+        UBT,
+        UMA,
+        UNI,
+        UPP,
+        USDC,
+        USDP,
+        USDT,
+        UST,
+        VET,
+        VIDT,
+        WAN,
+        WAVES,
+        WBTC,
+        WNXM,
+        WRX,
+        XEM,
+        XLM,
+        XMR,
+        XRP,
+        XTZ,
+        XVS,
+        YAM,
+        YAMV2,
+        YFI,
+        YFII,
+        ZEC,
+        ZIL,
+        ZRX
+    }
+    enum Quote {
+        USD,
+        ETH,
+        BTC
+    }
+}