From 5e092ff7358158246dbbae8fe62d27db52a9c106 Mon Sep 17 00:00:00 2001 From: MerlinEgalite Date: Mon, 9 Oct 2023 11:16:49 +0200 Subject: [PATCH 1/5] docs: update readme --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 6bb254cd6..fe87d4e61 100644 --- a/README.md +++ b/README.md @@ -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. + +## Whitepaper + +A more detailed description of Morpho Blue can be found in the [Morpho Blue's Whitepaper](./whitepaper.pdf). + +## Repository Structure + +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. + +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. + +The `mocks` directory contains contracts designed exclusively for testing. + +You'll find relevant comments in [Morpho's interface](./src/interfaces/IMorpho.sol), notably a list of assumptions about market creation. + +## Getting Started + +Install dependencies with `yarn`. + +Run tests using forge: `yarn test:forge` + +Run tests using hardhat (gas cost study): `yarn test:hardhat` + +You will find other CLI commands in the [`package.json`](./package.json) file. + ## Licensing The primary license for Morpho Blue is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE). However, some files are dual licensed under `GPL-2.0-or-later`. From 8005c81b3821d68d0767945086ad019cf9fae855 Mon Sep 17 00:00:00 2001 From: Merlin Egalite <44097430+MerlinEgalite@users.noreply.github.com> Date: Mon, 9 Oct 2023 17:32:03 +0200 Subject: [PATCH 2/5] docs: apply some suggestions Co-authored-by: MathisGD <74971347+MathisGD@users.noreply.github.com> Co-authored-by: Quentin Garchery Signed-off-by: Merlin Egalite <44097430+MerlinEgalite@users.noreply.github.com> --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1871f58b9..c3ddae011 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ A more detailed description of Morpho Blue can be found in the [Morpho Blue's Wh ## Repository Structure -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. +[`Morpho.sol`](./src/Morpho.sol) contains most of the source code of the core contract of Morpho Blue. It solely relies on internal libraries in the [`src/libraries`](./src/libraries) subdirectory. -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. +Libaries in the [`src/libraries/periphery`](./src/libraries/periphery) directory are not used by Morpho Blue. They are useful helpers that integrators can reuse or adapt to their own needs. -The `mocks` directory contains contracts designed exclusively for testing. +The [src/mocks](./src/mocks) directory contains contracts designed exclusively for testing. -You'll find relevant comments in [Morpho's interface](./src/interfaces/IMorpho.sol), notably a list of assumptions about market creation. +You'll find relevant comments in [Morpho's interface](./src/interfaces/IMorpho.sol), notably a list of assumptions about market dependencies. ## Getting Started @@ -24,7 +24,7 @@ Run tests using forge: `yarn test:forge` Run tests using hardhat (gas cost study): `yarn test:hardhat` -You will find other CLI commands in the [`package.json`](./package.json) file. +You will find other useful commands in the [`package.json`](./package.json) file. ## Audits From 4338708a8f26f78d486a751fc356df975c615720 Mon Sep 17 00:00:00 2001 From: MerlinEgalite Date: Mon, 9 Oct 2023 17:35:36 +0200 Subject: [PATCH 3/5] docs: next line return + small changes --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c3ddae011..1af8482be 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,15 @@ Morpho Blue is a new lending primitive that offers better rates, high capital ef ## Whitepaper -A more detailed description of Morpho Blue can be found in the [Morpho Blue's Whitepaper](./whitepaper.pdf). +The protocol is described in detail in the [Morpho Blue Whitepaper](./morpho-blue-whitepaper.pdf). ## Repository Structure -[`Morpho.sol`](./src/Morpho.sol) contains most of the source code of the core contract of Morpho Blue. It solely relies on internal libraries in the [`src/libraries`](./src/libraries) subdirectory. +[`Morpho.sol`](./src/Morpho.sol) contains most of the source code of the core contract of Morpho Blue. +It solely relies on internal libraries in the [`src/libraries`](./src/libraries) subdirectory. -Libaries in the [`src/libraries/periphery`](./src/libraries/periphery) directory are not used by Morpho Blue. They are useful helpers that integrators can reuse or adapt to their own needs. +Libaries in the [`src/libraries/periphery`](./src/libraries/periphery) directory are not used by Morpho Blue. +They are useful helpers that integrators can reuse or adapt to their own needs. The [src/mocks](./src/mocks) directory contains contracts designed exclusively for testing. @@ -18,11 +20,11 @@ You'll find relevant comments in [Morpho's interface](./src/interfaces/IMorpho.s ## Getting Started -Install dependencies with `yarn`. +Install dependencies: `yarn` -Run tests using forge: `yarn test:forge` +Run forge tests: `yarn test:forge` -Run tests using hardhat (gas cost study): `yarn test:hardhat` +Run hardhat tests: `yarn test:hardhat` You will find other useful commands in the [`package.json`](./package.json) file. @@ -32,7 +34,8 @@ All audits are stored in the [audits](./audits/)' folder. ## Licensing -The primary license for Morpho Blue is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE). However, some files are dual licensed under `GPL-2.0-or-later`. +The primary license for Morpho Blue is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE). +However, some files are dual licensed under `GPL-2.0-or-later`. All files in the following folders can also be licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers): - `src/interfaces`, see [`src/interfaces/LICENSE`](./src/interfaces/LICENSE) From ad71fe43b23ad7af36e7fa169dd6d0103553dfd8 Mon Sep 17 00:00:00 2001 From: MerlinEgalite Date: Tue, 10 Oct 2023 10:02:00 +0200 Subject: [PATCH 4/5] docs: apply suggestions --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1af8482be..8fec785dc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Morpho Blue -Morpho Blue is a new lending primitive that offers better rates, high capital efficiency and extended flexibility to lenders & borrowers. +Morpho Blue is a noncustodial lending protocol implemented for the Ethereum Virtual Machine. +Morpho Blue offers a new trustless primitive with increased efficiency and flexibility compared to existing lending platforms. +It provides permissionless risk management and permissionless market creation with oracle agnostic pricing. +It also enables higher collateralization factors, improved interest rates, and lower gas consumption. +The protocol is designed to be a simple, immutable, and governance-minimized base layer that allows for a wide variety of other layers to be built on top. +Morpho Blue also offers a convenient developer experience with a singleton implementation, callbacks, free flash loans, and account management features. ## Whitepaper @@ -32,7 +37,7 @@ You will find other useful commands in the [`package.json`](./package.json) file All audits are stored in the [audits](./audits/)' folder. -## Licensing +## Licences The primary license for Morpho Blue is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE). However, some files are dual licensed under `GPL-2.0-or-later`. From fd89539bce4101fdbcfa7c2aa0b5997ea52bc6a5 Mon Sep 17 00:00:00 2001 From: Merlin Egalite <44097430+MerlinEgalite@users.noreply.github.com> Date: Tue, 10 Oct 2023 11:21:46 +0200 Subject: [PATCH 5/5] docs: apply last 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, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8fec785dc..aaf4b4795 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,9 @@ It solely relies on internal libraries in the [`src/libraries`](./src/libraries) Libaries in the [`src/libraries/periphery`](./src/libraries/periphery) directory are not used by Morpho Blue. They are useful helpers that integrators can reuse or adapt to their own needs. -The [src/mocks](./src/mocks) directory contains contracts designed exclusively for testing. +The [`src/mocks`](./src/mocks) directory contains contracts designed exclusively for testing. -You'll find relevant comments in [Morpho's interface](./src/interfaces/IMorpho.sol), notably a list of assumptions about market dependencies. +You'll find relevant comments in [`IMorpho.sol`](./src/interfaces/IMorpho.sol), notably a list of requirements about market dependencies. ## Getting Started @@ -40,9 +40,7 @@ All audits are stored in the [audits](./audits/)' folder. ## Licences The primary license for Morpho Blue is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE). -However, some files are dual licensed under `GPL-2.0-or-later`. - -All files in the following folders can also be licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers): +However, all files in the following folders can also be licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers): - `src/interfaces`, see [`src/interfaces/LICENSE`](./src/interfaces/LICENSE) - `src/libraries`, see [`src/libraries/LICENSE`](./src/libraries/LICENSE) - `src/mocks`, see [`src/mocks/LICENSE`](./src/mocks/LICENSE)