Skip to content

Commit e804ca2

Browse files
Merge pull request #96 from morpho-org/docs/update-readme
docs: update readme
2 parents 07a9a69 + 16dcea6 commit e804ca2

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,10 @@ This oracle handles the following cases among others (let's say that our pair is
1818
- A/C and C/B are feeds (typically, WBTC/BTC and BTC/ETH).
1919
- A'/C and B/C are feeds, and there is an exchange rate between A and A'. (typically A=sDAI and A'=DAI).
2020

21-
## WstETH/stETH Exchange Rate Adapter
22-
23-
A specific implementation, the `WstEthStEthExchangeRateChainlinkAdapter`, provides the exchange rate between wstETH and stETH as a Chainlink-interface-compliant feed.
24-
25-
This adapter is deployed on Ethereum Mainnet at the address [0x905b7dAbCD3Ce6B792D874e303D336424Cdb1421](https://etherscan.io/address/0x905b7dabcd3ce6b792d874e303d336424cdb1421#code).
26-
27-
## MorphoChainlinkOracleV2Factory
28-
29-
The `MorphoChainlinkOracleV2Factory` is a factory that deploys `MorphoChainlinkOracleV2` instances.
30-
31-
The factory facilitates the creation and indexing of `MorphoChainlinkOracleV2` oracles. This factory contract streamlines the process of deploying new oracles, catering to various market pairs without the need to deploy individual contracts manually for each pair.
32-
33-
### Usage
21+
## Deploy an Oracle
3422

35-
The Ethereum Mainnet address of this factory is [0x3A7bB36Ee3f3eE32A60e9f2b33c1e5f2E83ad766](https://etherscan.io/address/0x3a7bb36ee3f3ee32a60e9f2b33c1e5f2e83ad766#code).
36-
37-
To create a new `MorphoChainlinkOracleV2` oracle using the factory, call the `createMorphoChainlinkOracleV2` function with the following parameters:
23+
To deploy a `MorphoChainlinkOracleV2` on Ethereum, it is highly recommended to use the factory `MorphoChainlinkOracleV2Factory`.
24+
To do so, call the `createMorphoChainlinkOracleV2` function with the following parameters:
3825

3926
- `baseVault`: The ERC4626 token vault for the base asset.
4027
- `baseVaultConversionSample`: A sample amount for converting base vault units.
@@ -46,9 +33,14 @@ To create a new `MorphoChainlinkOracleV2` oracle using the factory, call the `cr
4633
- `quoteTokenDecimals`: Decimal precision of the quote asset.
4734
- `salt`: A unique identifier to create deterministic addresses for deployed oracles.
4835

49-
### Deploy an Oracle
36+
**Warning:** If there is an ERC4626-compliant vault for `baseVault` or `quoteVault`, the `baseTokenDecimals` or `quoteTokenDecimals` are still the decimals of the underlying asset of the vault, and not the decimals of the Vault itself.
37+
E.g: for a MetaMorpho WETH vault, as `baseVault`, the `baseTokenDecimals` is 18 as WETH has 18 decimals.
38+
39+
### Addresses
5040

51-
To deploy a `MorphoChainlinkOracleV2` on the Ethereum mainnet, use the `MorphoChainlinkOracleV2Factory` to create a new oracle.
41+
The address on Ethereum of this factory is [0x3A7bB36Ee3f3eE32A60e9f2b33c1e5f2E83ad766](https://etherscan.io/address/0x3a7bb36ee3f3ee32a60e9f2b33c1e5f2e83ad766#code).
42+
43+
### Examples
5244

5345
Below are the arguments to fill for the creation of the WETH/USDT oracle:
5446

@@ -98,6 +90,12 @@ and for the wstETH/ETH oracle:
9890
"salt": "<user-defined value used to make the address unique>",
9991
```
10092

93+
## WstETH/stETH Exchange Rate Adapter
94+
95+
A specific implementation, the `WstEthStEthExchangeRateChainlinkAdapter`, provides the exchange rate between wstETH and stETH as a Chainlink-interface-compliant feed.
96+
97+
This adapter is deployed on the Ethereum Mainnet at the address [0x905b7dAbCD3Ce6B792D874e303D336424Cdb1421](https://etherscan.io/address/0x905b7dabcd3ce6b792d874e303d336424cdb1421#code).
98+
10199
## Getting Started
102100

103101
Install dependencies: `forge install`

0 commit comments

Comments
 (0)