Skip to content

Commit 6e8da15

Browse files
committed
docs: add relevant info to README
1 parent 081af65 commit 6e8da15

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# Morpho Blue Oracles
22

3+
[Morpho Blue](https://github.com/morpho-org/morpho-blue) is a trustless lending primitive that offers unparalleled efficiency and flexibility.
4+
5+
Morpho Blue Oracles are contracts that can be used as oracles for markets on Morpho Blue.
6+
The oracles must implement the `IOracle` interface defined in [`IOracle.sol`](https://github.com/morpho-org/morpho-blue/blob/main/src/interfaces/IOracle.sol#L9).
7+
8+
## ChainlinkOracle
9+
10+
The `ChainlinkOracle` is an oracle that uses Chainlink-compliant feeds to provide price data.
11+
12+
This Oracle handles the following cases among others (let's say that our pair is A/B):
13+
- A/B is a feed (typically, stETH/ETH).
14+
- B/A is a feed (typically, USDC/ETH).
15+
- A/C and B/C are feeds (typically, stETH/ETH and USDC/ETH).
16+
- A/C, C/D and B/D are feeds (typically, WBTC/BTC, BTC/USD, USDC/USD).
17+
- A/D, and B/C, C/D are feeds (typically, USDC/USD, WBTC/BTC, BTC/USD).
18+
- A/C, C/D and B/E, E/D are feeds.
19+
- A/C and C/B are feeds (typically, WBTC/BTC and BTC/ETH).
20+
- A'/C and B/C are feeds, and there is an exchange rate between A and A'. (typically A=sDAI and A'=DAI).
21+
22+
## Getting Started
23+
24+
Install dependencies: `forge install`
25+
26+
Run test: `forge test`
27+
328
## License
429

530
Morpho Blue Oracles are licensed under `GPL-2.0-or-later`, see [`LICENSE`](./LICENSE).

0 commit comments

Comments
 (0)