@ohgeez/fsushi/docs/FarmingLPTokenFactory.md

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.

# FarmingLPTokenFactory









## 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) external view returns (address)
```





#### Parameters

| Name | Type | Description |
|---|---|---|
| _0 | 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 |

### owner

```solidity
function owner() external view returns (address)
```



*Returns the address of the current owner.*


#### 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 |

### renounceOwnership

```solidity
function renounceOwnership() external nonpayable
```



*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.*


### router

```solidity
function router() external view returns (address)
```






#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |

### transferOwnership

```solidity
function transferOwnership(address newOwner) external nonpayable
```



*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.*

#### Parameters

| Name | Type | Description |
|---|---|---|
| newOwner | address | undefined |

### updateMigrator

```solidity
function updateMigrator(address _migrator) external nonpayable
```





#### Parameters

| Name | Type | Description |
|---|---|---|
| _migrator | 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 |

### OwnershipTransferred

```solidity
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
```





#### Parameters

| Name | Type | Description |
|---|---|---|
| previousOwner `indexed` | address | undefined |
| newOwner `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()
```