Skip to content

Latest commit

 

History

History
122 lines (87 loc) · 5.07 KB

README.md

File metadata and controls

122 lines (87 loc) · 5.07 KB
Raw

Endgame Toolkit

A set of components for the SubDAO stack in the context of the MakerDAO Endgame.

Components

SubProxy

The SubProxy is the SubDAO level counter-party of the MakerDAO level MCD_PAUSE_PROXY

The reason a Proxy is required is to isolate the context of execution for spells from the main governance contract to avoid potential exploits messing with the original contract storage.

This module is heavily inspired by the original DSPauseProxy contract, with a few modifications:

  • Instead of a single owner, it uses the now classic wards/rely/deny pattern from MCD.
  • The exec function is payable.

SDAO

SDAO is a standard ERC-20 token with permissioned minting capability. It is meant to be the main SubDAO governance token.

There is an uncommon feature that allow the owner of the contract to change both name and symbol. This can be used by SubDAOs in the future to rebrand their tokens. For simplicity, there is no limitation on the amount of times this can be done at code level. Future immutability will be enforced off-chain by governance artifacts.

Farms

For more details about the farming solution in the scope of the Endgame, please refer to the technical document.

VestedRewardsDistribution

Rewards are going to be generated through a DssVestMintable contract and distributed to final users through a StakingRewards contract.

VestedRewardsDistribution is the "glue" between these two very distinct contracts. It controls the vesting stream from DssVest and permissionlessly allows for distributing rewards on a predefined schedule.

StakingRewards

StakingRewards is a port of Synthetix StakingRewards. The changes made include:

  • Upgrade to the Solidity version from 0.5.x to 0.8.x.
    • It was required some reorganization of the internal structure because of changes in the inheritance resolution mechanism.
  • Add referral code functionality for stake().
    • Referral codes are meant to be used by UIs to identify themselves as the preferred solution by users.
    • The original stake(uint256 amount) function still works the same as before.
    • There is a new overload stake(uint256 amount, uint16 referral) which performs the same operation and emits the new Referral event.
  • Update setRewardsDuration() to support changing the reward duration during an active distribution.
    • This allows the duration to be changed even when new reward is added immediately after the end of a distribution period, which would be the case when rewardDistribution is a smart contract distributing new reward every period.
  • Prevent rewardsToken and stakingToken from being the same token.
    • Instead of using the pull pattern, this contract expect the address with the rewardsDistribution role to transfer the tokens to it and call notifyRewardAmount with the correct value.
    • There is a possible scenario where the amount of tokens transferred to the contract is less than the amount used as a parameter in notifyRewardAmount. In such case, if the staking token and rewards token are the same, the staked tokens would be incorporated into the new reward period, causing stakers to lose their capital.

Contributing

Requirements

We use Foundry for all Solidity things and Node.js + Yarn to manage devtools, such as linting and formatting.

Install dependencies

After cloning the repo, run:

# 1. Install solhint, prettier, husky and other tools
yarn install
# 2. Install Foundry dependencies
forge update

Build

⚠️ ATTENTION: The order of execution is important here.

# 1. Build the Solidity 0.6.x contract
FOUNDRY_PROFILE=0_6_x forge build
# 2. Build the default Solidity 0.8.x contracts
forge build

Notice that if you use forge build --force, the out/ directory is going to be erased.

Run tests

forge test -vvv