@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.
270 lines (125 loc) • 2.94 kB
Markdown
# IFarmingLPTokenFactory
## Methods
### createFarmingLPToken
```solidity
function createFarmingLPToken(uint256 pid) external nonpayable returns (address token)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| token | address | undefined |
### getFarmingLPToken
```solidity
function getFarmingLPToken(uint256 pid) external view returns (address)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
### masterChef
```solidity
function masterChef() external view returns (address)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
### migrator
```solidity
function migrator() external view returns (address)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
### predictFarmingLPTokenAddress
```solidity
function predictFarmingLPTokenAddress(uint256 pid) external view returns (address token)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| token | address | undefined |
### router
```solidity
function router() external view returns (address)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
### updateMigrator
```solidity
function updateMigrator(address vault) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| vault | address | undefined |
### updateYieldVault
```solidity
function updateYieldVault(address vault) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| vault | address | undefined |
### yieldVault
```solidity
function yieldVault() external view returns (address)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
## Events
### CreateFarmingLPToken
```solidity
event CreateFarmingLPToken(uint256 indexed pid, address indexed token)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid `indexed` | uint256 | undefined |
| token `indexed` | address | undefined |
### UpdateMigrator
```solidity
event UpdateMigrator(address indexed migrator)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| migrator `indexed` | address | undefined |
### UpdateVault
```solidity
event UpdateVault(address indexed vault)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| vault `indexed` | address | undefined |
## Errors
### InvalidAddress
```solidity
error InvalidAddress()
```
### MigratorSet
```solidity
error MigratorSet()
```
### TokenCreated
```solidity
error TokenCreated()
```