Skip to content

Commit cd1ac7a

Browse files
committed
docs: update readme
1 parent 07a9a69 commit cd1ac7a

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,15 @@ 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
21+
### MorphoChainlinkOracleV2Factory
2822

2923
The `MorphoChainlinkOracleV2Factory` is a factory that deploys `MorphoChainlinkOracleV2` instances.
3024

3125
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.
3226

33-
### Usage
34-
35-
The Ethereum Mainnet address of this factory is [0x3A7bB36Ee3f3eE32A60e9f2b33c1e5f2E83ad766](https://etherscan.io/address/0x3a7bb36ee3f3ee32a60e9f2b33c1e5f2e83ad766#code).
27+
#### Deploy an Oracle
3628

37-
To create a new `MorphoChainlinkOracleV2` oracle using the factory, call the `createMorphoChainlinkOracleV2` function with the following parameters:
29+
To deploy a `MorphoChainlinkOracleV2` on the Ethereum mainnet, use the `MorphoChainlinkOracleV2Factory` to create a new oracle. Call the `createMorphoChainlinkOracleV2` function with the following parameters:
3830

3931
- `baseVault`: The ERC4626 token vault for the base asset.
4032
- `baseVaultConversionSample`: A sample amount for converting base vault units.
@@ -46,9 +38,11 @@ To create a new `MorphoChainlinkOracleV2` oracle using the factory, call the `cr
4638
- `quoteTokenDecimals`: Decimal precision of the quote asset.
4739
- `salt`: A unique identifier to create deterministic addresses for deployed oracles.
4840

49-
### Deploy an Oracle
41+
#### Addresses
5042

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

5347
Below are the arguments to fill for the creation of the WETH/USDT oracle:
5448

@@ -98,6 +92,12 @@ and for the wstETH/ETH oracle:
9892
"salt": "<user-defined value used to make the address unique>",
9993
```
10094

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

103103
Install dependencies: `forge install`

0 commit comments

Comments
 (0)