Skip to content

readme: Add warning for custom adapters #774

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

readme: Add warning for custom adapters #774

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
edf7cae
add warning for custom adapters
qdrn Oct 13, 2025
ed1c07e
add link
qdrn Oct 13, 2025
72803db
add registries link
qdrn Oct 13, 2025
feffcb2
add disclaimer
qdrn Oct 13, 2025
4ac26b2
update README
qdrn Nov 7, 2025
f53994c
Update README.md
qdrn Nov 19, 2025
8371fc1
Merge branch 'main' into docs/custom-adapters
qdrn Nov 19, 2025
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
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

> [!NOTE]
> Vault V2 instances are distinguished between:
>
> - **Morpho Vaults**: Vault V2 with the Morpho registry (link to be added) abdicated. Learn more about Morpho Vaults and their benefits here (link to be added).
> - **Morpho Vaults**: Vault V2 with the [adapter registry](https://github.com/morpho-org/vault-v2/blob/main/src/VaultV2.sol#L89-L97) set to the Morpho registry and abdicated. Learn more about Morpho Vaults and their benefits [here](https://docs.morpho.org/learn/concepts/vault-v2/#:~:text=Basic%20Vaults:%20Vaults,of%20Morpho's%20infrastructure).
> - **Basic Vaults**: Vault V2 that can supply to any protocol. They don't get all the Morpho Vaults benefits. In particular, Vault V2 has been developed and audited only in the context of the Morpho Market V1 and Morpho Vault V1 adapters.

Vault V2 enables anyone to create [non-custodial](#non-custodial-guarantees) vaults that allocate assets to any protocols, including Morpho Market V1, Morpho Market V2, and Morpho Vault V1.
Expand All @@ -22,7 +21,12 @@ Vaults can allocate assets to arbitrary protocols and markets via separate contr
They hold positions on behalf of the vault.
Adapters are also used to know how much these investments are worth (interest and loss realization).

Vaults can set an adapter registry to constrain which adapter they can have and add. This is notably useful when abdicated (see [timelocks](#timelocks)), to ensure that a vault will forever supply into adapters authorized by a given registry. See for example the Morpho Registry (link to be added).
> [!NOTE]
> Developers building adapters for new protocols should carefully review the [Vault V2 NatSpec](https://github.com/morpho-org/vault-v2/blob/main/src/VaultV2.sol#L16-L184), with particular attention to the [adapter specification](https://github.com/morpho-org/vault-v2/blob/main/src/VaultV2.sol#L66-L87) and related technical requirements.
> The code is provided "as is", without any representations, warranties or conditions express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, or non-infringement.
> The development and deployment of custom adapters are undertaken at the developer’s sole risk.

Vaults can set an adapter registry to constrain which adapter they can have and add. This is notably useful when abdicated (see [timelocks](#timelocks)), to ensure that a vault will forever supply into adapters authorized by a given registry. See for example the [Morpho Registries](https://github.com/morpho-org/vault-v2-adapter-registries).

The following adapters are currently available:

Expand Down