From 16dcea6e5c87b032fefa4af07c80b72cbf7f4ff5 Mon Sep 17 00:00:00 2001 From: Merlin Egalite <44097430+MerlinEgalite@users.noreply.github.com> Date: Fri, 26 Apr 2024 18:46:19 +0200 Subject: [PATCH] docs: apply suggestions Co-authored-by: MathisGD <74971347+MathisGD@users.noreply.github.com> Signed-off-by: Merlin Egalite <44097430+MerlinEgalite@users.noreply.github.com> --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1b8c52b..b245af1 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ This oracle handles the following cases among others (let's say that our pair is ## Deploy an Oracle -To deploy a `MorphoChainlinkOracleV2` on the Ethereum mainnet, use the `MorphoChainlinkOracleV2Factory` to create a new oracle. -Call the `createMorphoChainlinkOracleV2` function with the following parameters: +To deploy a `MorphoChainlinkOracleV2` on Ethereum, it is highly recommended to use the factory `MorphoChainlinkOracleV2Factory`. +To do so, call the `createMorphoChainlinkOracleV2` function with the following parameters: - `baseVault`: The ERC4626 token vault for the base asset. - `baseVaultConversionSample`: A sample amount for converting base vault units. @@ -33,12 +33,12 @@ Call the `createMorphoChainlinkOracleV2` function with the following parameters: - `quoteTokenDecimals`: Decimal precision of the quote asset. - `salt`: A unique identifier to create deterministic addresses for deployed oracles. -**Warning:** If there is an ERC4626-compliant vault for `baseVault` or `quoteVault`, the `baseTokenDecimals` or `quoteTokenDecimals` are still the decimals of the asset in the vault, and not the decimals of the Vault asset. +**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. E.g: for a MetaMorpho WETH vault, as `baseVault`, the `baseTokenDecimals` is 18 as WETH has 18 decimals. ### Addresses -The Ethereum Mainnet address of this factory is [0x3A7bB36Ee3f3eE32A60e9f2b33c1e5f2E83ad766](https://etherscan.io/address/0x3a7bb36ee3f3ee32a60e9f2b33c1e5f2e83ad766#code). +The address on Ethereum of this factory is [0x3A7bB36Ee3f3eE32A60e9f2b33c1e5f2E83ad766](https://etherscan.io/address/0x3a7bb36ee3f3ee32a60e9f2b33c1e5f2e83ad766#code). ### Examples