Update readme #195
Update readme #195
Conversation
MerlinEgalite
requested review from
a team,
Rubilmax and
Jean-Grimal
and removed request for
a team
I think we should because if I'm not mistaken there won't be any whitepaper. So I think we should have these informations in the Readme |
Update readme
🚨 Vulnerabilities Summary
For more details view the full report in OpenZeppelin Code |
Co-authored-by: Jean-Grimal <[email protected]> Signed-off-by: Merlin Egalite <[email protected]>
Co-authored-by: Jean-Grimal <[email protected]> Signed-off-by: Merlin Egalite <[email protected]>
…into docs/update-readme
…ue-metamorpho into docs/update-readme
There was a problem hiding this comment.
I'm surprised most of the doc does not correspond exactly to https://www.notion.so/morpho-labs/Morpho-Blue-Documentation-Hub-Confidential-67b037dd32eb479483f9d8489074f0a2?pvs=4#054dc16f414049939e00a4f17cb917b4
Why are we writing something different here?
I agree we can harmonize, but in this case we may want to point to the github in the notion no? Else it's a nightmare to maintain |
Co-authored-by: Romain Milon <[email protected]> Signed-off-by: Merlin Egalite <[email protected]>
Definitely agree I think we should just go the other way around: have the README point to this documentation and perhaps add code references to clarify some points (though I don't see any dark corner) |
Are you talking about the notion page?
Well, I'm not sure. When you modify the code it's way easier to keep in sync the README than the Notion. |
Yes
Yes and conversely: modifying the documentation is easier on Notion (or any appropriate tool) than on GitHub I don't really care in the end except having a single place where the documentation is written |
|
Let's discuss during today's call |
Co-authored-by: Romain Milon <[email protected]> Signed-off-by: Merlin Egalite <[email protected]>
| A maximum of 30 markets can be enabled on a given MetaMorpho vault. | ||
| Each market has a supply cap configured onchain that guarantees lenders a maximum absolute exposure to the specific market. | ||
|
|
||
| There are 4 different roles for a MetaMorpho vault (owner, curator, guardian & allocators). |
There was a problem hiding this comment.
There is also the rewards recipient, and the fee recipient, I think we should list them and explain those roles too
There was a problem hiding this comment.
Hmm they cannot trigger any function more than a normal user, should we add them still?
There was a problem hiding this comment.
Just a few sentences would be nice. For example
| There are 4 different roles for a MetaMorpho vault (owner, curator, guardian & allocators). | |
| The fee recipient is the recipient of the fee generated from using the vault. | |
| The rewards recipient is the recipient of the rewards attributed to users of Morpho Blue markets, which can then be redistributed to users of the vault. | |
| On top of those roles there are 4 different roles for a MetaMorpho vault : owner, curator, guardian & allocators. |
|
|
||
| Run forge tests: `yarn test:forge` | ||
|
|
||
| Run hardhat tests: `yarn test:hardhat` |
There was a problem hiding this comment.
Those are gas tests right ? We should explain that if it's the case, otherwise we wonder why we use both hardhat and forge
There was a problem hiding this comment.
We should do the same in blue then but there was that comment: morpho-org/morpho-blue#523 (comment)
There was a problem hiding this comment.
Ok I didn't know it was removed, it's fine if we want to not add that comment
Co-authored-by: Jean-Grimal <[email protected]> Co-authored-by: Quentin Garchery <[email protected]> Signed-off-by: Merlin Egalite <[email protected]>
…ue-metamorpho into docs/update-readme
Fixes #100
Questions: