morpho-org/public-allocator

Public Allocator

Overview

MetaMorpho is a protocol for funds allocations and risk management on top of Morpho Blue. The Public Allocator is a contract that MetaMorpho vault owners can enable as allocator to let anybody reallocate the vault's funds to fill their liquidity needs.

The Public Allocator's function reallocateTo (source, interface) reallocates some liquidity from multiple markets to one market. It takes as input withdrawals, a list of pairs, which will be the markets and amounts that will be reallocated, and supplyMarketParams, a MarketParams, which is the market in which to supply the reallocated funds. Note that the id of the markets in withdrawals must be sorted, and that supplyMarketParams cannot be a market of withdrawals.

The Public Allocator provides the possibility to the vault owner or a per vault settable admin to constrain the public reallocation:

• Max flows: Each market has a max inflow (maxIn) and max outflow (maxOut), that can be set by the vault owner or the Public Allocator vault admin. The markets from which funds are withdrawn through reallocateTo increase their maxIn and decrease their maxOut, and the market in which funds are deposited decrease their maxOut and increase their maxIn.
• Fee: If set, user must pay a fee in ETH to be able to call reallocateTo. The vault owner or the Public Allocator vault admin can set this fee, as well as taking the accumulated fees out by calling transferFee.

Testing

To run tests: forge test. Note that running the tests this way will use this repository's compilation settings for dependencies (Morpho & MetaMorpho), potentially different from the settings used for deployment of those dependencies.

Audits

All audits are stored in the audits' folder.

License

All files are licenced under GPL-2.0-or-later, see LICENSE.

public-allocator's Issues

Pragma for interface IPublicAllocator

public-allocator/src/interfaces/IPublicAllocator.sol

Line 2 in 1cdcee8

pragma solidity ^0.8.21;

As per our conventions, to improve usability, interfaces should have a weaker constraint (eg >= 0.5.0)

dual license?

          let's merge this and open an issue

This software is available under your choice of the GNU General Public
License, version 2 or later.

Originally posted by @MathisGD in #37 (comment)

Update readme

• Explain the purpose of the public allocator
• Explain how to set it up

add test edge case

          If `allocations[i].assets` is exactly 0 after this line, then metamorpho triggers a special case by withdrawing with shares. I think it works out in the end because Morpho.withdraw will do the exact same computation, but I would rest easier if there was a test for it. So the test would pass an amount to withdraw that is equal to the expected supply assets of the vault

Originally posted by @QGarchery in #5 (comment)

put the public allocator in a folder to make it easier to make new ones

forge coverage does not work

Did you successfully run the forge coverage? I'm facing the following issue

Add addresses