Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme #96

Merged
merged 5 commits into from
Apr 26, 2024
Merged

docs: update readme #96

merged 5 commits into from
Apr 26, 2024

Conversation

Jean-Grimal
Copy link
Contributor

@Jean-Grimal Jean-Grimal commented Apr 9, 2024

Fixes #90 and #92

README.md Outdated Show resolved Hide resolved
QGarchery
QGarchery previously approved these changes Apr 11, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
MerlinEgalite
MerlinEgalite previously approved these changes Apr 12, 2024
QGarchery
QGarchery previously approved these changes Apr 12, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@@ -46,9 +33,14 @@ To create a new `MorphoChainlinkOracleV2` oracle using the factory, call the `cr
- `quoteTokenDecimals`: Decimal precision of the quote asset.
- `salt`: A unique identifier to create deterministic addresses for deployed oracles.

### Deploy an Oracle
**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.
E.g: for a MetaMorpho WETH vault, as `baseVault`, the `baseTokenDecimals` is 18 as WETH has 18 decimals.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metamorpho also has 18 decimals (and most vaults do), so the example is not perfect

to me we can just remove it

@MerlinEgalite MerlinEgalite dismissed stale reviews from QGarchery and themself via 16dcea6 April 26, 2024 16:46
Co-authored-by: MathisGD <[email protected]>
Signed-off-by: Merlin Egalite <[email protected]>
@MerlinEgalite
Copy link
Contributor

Apply changes and merged, PR pending for too long

@MerlinEgalite MerlinEgalite merged commit e804ca2 into main Apr 26, 2024
2 checks passed
@MerlinEgalite MerlinEgalite deleted the docs/update-readme branch April 26, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants