# SuperYFI Protocol Specs

### Glossary

* veYFI: Voting Escrowed YFI token used for governance power.
* SuperYFI : a fully transferable token that is minted on a 1:1 ratio by providing YFI, which is later perpetually locked onto Yearn's vote-escrowed system, veYFI.
* Staked SuperYFI (st-superYFI): Yearn v3 vault to deposit SuperYFI, that receives and compounds dYFI and YFI rewards from perpetually locked YFI on veYFI.
* SuperYFI Liquidity Provider: Yearn v3 vault to deposit a SuperYFI/YFI LP vault, that receives and compounds rewards from LP, and dYFI from a veYFI gauge.
* SuperBoosted Vaults: Yearn v3 vaults for each gauge available in veYFI, that receive and compound dYFI rewards to the underlying asset, boosted by SuperYFI.
* Voter: Core component that holds the balance of veYFI for the protocol. Executes the locking and interactions with veYFI system. Critical functionality is restricted to governance.
* Governance: role for trusted operations, settings, configurations and smart contract emergency use cases.
* Management: Can set roles, fees, and other configurable parameters for deployed strategies.
* Guardian: Emergency privileges.
* Treasury: receives performance fees.

### Use Cases

* As a YFI holder, I can mint superYFI with YFI on a 1:1 ratio.
* As a superYFI holder, I can Stake my superYFI to receive dYFI/YFI rewards that auto compound.
* As a superYFI holder, I can LP my superYFI in the curve pool and deposit my LP into a Yearn vault for auto compounding rewards from LP and dYFI from gauges.

### System Specification

* superYFI can only be minted with YFI on a 1:1 ratio.
* No proxy contracts used.
* Contracts are immutable and designed to be composable components that can be changed only by governance.
* Core components cannot be updated and would require a redeployment.

### Emergency Functions

* Pause: system can be pause by governance/guardian on emergency scenarios.
* In pause state, no user can deposit YFI to mint superYFI into the system.
* In pause state, governance or guardian can undo pause mode to restore normal operations.

### SuperYFI token
* ERC20 contract representing a 1:1 ratio with locked veYFI.
* Minting of superYFI is exclusive with YFI on a 1:1 ratio.
* Has direct dependency with Voter, on any minting operation the YFI is transfered fully to Voter to execute the locking strategy according to settings.
* This contract should hold no balance of YFI tokens.
* Governance can do an emergency sweep of outstanding tokens left in balance.

### Staking contract for SuperYFI token (st-superYFI)

* Staking contract is a Yearn v3 vault compatible with ERC20 and ERC4626 standards.
* Users can deposit superYFI to mint shares of st-superYFI representing a proportional amount of the underlying asset contained in the staking contract.
* Users can burn shares to receive the underlying asset from the staking contract in proportion to the total number of shares.
* The staking contract has harvest functionality to auto compound rewards and increase total underlying for users holding shares.
* Users can transfer shares of staking contract to other users.

### Voter Specification
* Core contract that receives YFI for locking into veYFI system and allows locking and claiming of rewards.
* Configurable strategy settings for managing locking and boost.
* Can handle increase of locks and release.
* Claims rewards for the protocol from veYFI system.
* Interacts with gauges for deposits and withdrawals.
* Can interact with veYFI system for execution of operations. These functions are restricted to only be called by Governance or specific whitelisted strategies.
* Follows implementation and best practices from battle tested Yearn contracts from other veToken systems. e.g CRV.

### Fees

* The protocol collects a performance fee from the yield generated.
* The performance fees are credited to the Treasury in forms of st-superYFI.
* A protocol fee is automatically sent to Yearn treasury via V3 vault system.
* Governance/Management can set the performance fees limited to a certain range.
* An acknowlegement fee can be set to send a percentage of fees from SuperBoosted vaults to st-superYFI holder.