@ohgeez/fsushi

Version:

fSUSHI is a protocol built on top of [FlashStake](http://flashstake.io/) and [SushiSwap](https://sushi.com) that enables stakers to get instant, upfront yield without waiting for it to accrue.

github.com/ohgeez-dao/fsushi

228 lines (112 loc) • 3 kB

Markdown

# IFlashStrategy ## Methods ### burnFToken ```solidity function burnFToken(uint256 _tokenAmount, uint256 _minimumReturned, address _yieldTo) external nonpayable returns (uint256) ``` #### Parameters | Name | Type | Description | |---|---|---| | _tokenAmount | uint256 | undefined | | _minimumReturned | uint256 | undefined | | _yieldTo | address | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### depositPrincipal ```solidity function depositPrincipal(uint256 _tokenAmount) external nonpayable returns (uint256) ``` #### Parameters | Name | Type | Description | |---|---|---| | _tokenAmount | uint256 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### getMaxStakeDuration ```solidity function getMaxStakeDuration() external view returns (uint256) ``` #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### getPrincipalAddress ```solidity function getPrincipalAddress() external view returns (address) ``` #### Returns | Name | Type | Description | |---|---|---| | _0 | address | undefined | ### getPrincipalBalance ```solidity function getPrincipalBalance() external view returns (uint256) ``` #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### getYieldBalance ```solidity function getYieldBalance() external view returns (uint256) ``` #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### quoteBurnFToken ```solidity function quoteBurnFToken(uint256 _tokenAmount) external view returns (uint256) ``` #### Parameters | Name | Type | Description | |---|---|---| | _tokenAmount | uint256 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### quoteMintFToken ```solidity function quoteMintFToken(uint256 _tokenAmount, uint256 duration) external view returns (uint256) ``` #### Parameters | Name | Type | Description | |---|---|---| | _tokenAmount | uint256 | undefined | | duration | uint256 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### setFTokenAddress ```solidity function setFTokenAddress(address _fTokenAddress) external nonpayable ``` #### Parameters | Name | Type | Description | |---|---|---| | _fTokenAddress | address | undefined | ### withdrawPrincipal ```solidity function withdrawPrincipal(uint256 _tokenAmount) external nonpayable ``` #### Parameters | Name | Type | Description | |---|---|---| | _tokenAmount | uint256 | undefined | ## Events ### BurnedFToken ```solidity event BurnedFToken(address indexed _address, uint256 _tokenAmount, uint256 _yieldReturned) ``` #### Parameters | Name | Type | Description | |---|---|---| | _address `indexed` | address | undefined | | _tokenAmount | uint256 | undefined | | _yieldReturned | uint256 | undefined |