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

Update readme #523

Merged
merged 6 commits into from
Oct 10, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Morpho Blue

Morpho Blue is a new lending primitive that offers better rates, high capital efficiency and extended flexibility to lenders & borrowers.
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved

## Whitepaper

A more detailed description of Morpho Blue can be found in the [Morpho Blue's Whitepaper](./whitepaper.pdf).
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved

## Repository Structure
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved

Morpho Blue is a singleton contract at the `src`'s root: [`Morpho.sol`](./src/Morpho.sol). It solely relies on internal libraries in the [`src/libraries`](./src/libraries) directory. No external dependency is used.
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved

Libaries in the [`src/libraries/periphery`](./src/libraries/periphery) directory are not directly used by Morpho Blue. They are useful helpers that integrators can reuse or adapt to their own needs.
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved

The `mocks` directory contains contracts designed exclusively for testing.
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved

You'll find relevant comments in [Morpho's interface](./src/interfaces/IMorpho.sol), notably a list of assumptions about market creation.
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved

## Getting Started

Install dependencies with `yarn`.

Run tests using forge: `yarn test:forge`
MathisGD marked this conversation as resolved.
Show resolved Hide resolved

Run tests using hardhat (gas cost study): `yarn test:hardhat`
MathisGD marked this conversation as resolved.
Show resolved Hide resolved

You will find other CLI commands in the [`package.json`](./package.json) file.
MerlinEgalite marked this conversation as resolved.
Show resolved Hide resolved

## Audits

All audits are stored in the [audits](./audits/)' folder.
Expand Down