This repo contains a set of contracts to facilitate on-chain distribution of protocol revenues denominated in MPL tokens. MPL distributions are made using RevenueDistributionToken (RDT) vesting schedule functionaltiy. This allows for multiple deposits to be made to the same contract on a recurring basis with custom vesting parameters.
xMPL inherits the core functionality from Maple's Revenue Distribution Token, which allows users to lock assets to earn rewards distributions based on a vesting schedule, with the increased functionality to perform a one time asset migration for the underlying token. This migration will interact with the contracts defined in mpl-migration.
This mechanism is present in case an MPL migration is ever needed, which would require approval of the Maple DAO. The transaction that perform the migration has a time delay, which allows any parties to withdraw before the changes take effect.
This allows a seamless and safe migration for all users that have staked their MPL into the xMPL contract.
-
The first step to trigger a migration is for the contract governor to call
scheduleMigration, which sets a execution to occur at least 10 days from the transaction time. In the meantime, all functionality in the xMPL contract remain operational. -
During this period, any party that disagrees with the scheduled migration can withdraw their funds from the contract.
-
After the time delay, anyone can call
performMigration, which executes the migration with the parameters set 10 days prior. -
During this migration,the xMPL contract deposits its entire balance of MPL to the migrator contract, which includes non vested and vested funds.
-
The migrator contract takes the MPL amount and returns the exact same amount of MPLv2, with a 1:1 ratio. The MPL tokens will remain locked in the migrator contract so they cannot be migrated twice.
-
In the last step, the address defined as
assetin xMPL contract is switched from MPLv1 to the newly migrated MPLv2 address. From that point on, all subsequent operations will be in relation to the new migrated token.
Holders of the xMPL token do not need to perform any action in order to migrate their tokens, however holders that do not interact with the xMPL contract would need to perform a migration by themselves.
git clone [email protected]:maple-labs/xMPL.git
cd xMPL
forge update- To run all unit/fuzz tests:
make test(runs./test.sh) - To run all invariant tests:
make invariant(runs./invariant.sh) - To run all tests (unit/fuzz and invariant tests):
make test-all - To run specific unit tests:
./test.sh -t <test_name>(e.g.,./test.sh -t test_scheduleMigration) - To run specific invariant tests:
./invariant-test.sh -t <test_name>(e.g.,./invariant-test.sh -t invariant_totalSupply) - To run specific fuzz tests with a specified number of fuzz runs:
./test.sh -r <runs>(e.g.,./test.sh -t testFuzz_performMigration -r 10000)
This project was built using Foundry.
| Auditor | Report link |
|---|---|
| Trail of Bits | ToB Report - April 12, 2022 |
| Code 4rena | C4 Report - April 20, 2022 |
For all information related to the ongoing bug bounty for these contracts run by Immunefi, please visit this site.
| Severity of Finding | Payout |
|---|---|
| Critical | $50,000 |
| High | $25,000 |
| Medium | $1,000 |
Maple Finance is a decentralized corporate credit market. Maple provides capital to institutional borrowers through globally accessible fixed-income yield opportunities.
For all technical documentation related to the currently deployed Maple protocol, please refer to the maple-core GitHub wiki.
