@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.
373 lines (185 loc) • 4.93 kB
Markdown
# FSushiKitchen
## Methods
### addPool
```solidity
function addPool(uint256 pid) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
### checkpoint
```solidity
function checkpoint(uint256) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### flashStrategyFactory
```solidity
function flashStrategyFactory() 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 |
### relativeWeight
```solidity
function relativeWeight(uint256 pid) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### relativeWeightAt
```solidity
function relativeWeightAt(uint256 pid, uint256 timestamp) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
| timestamp | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | 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.*
### totalWeightPoints
```solidity
function totalWeightPoints() external view returns (uint256)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### totalWeightPointsAt
```solidity
function totalWeightPointsAt(uint256 timestamp) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| timestamp | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### totalWeightPointsLength
```solidity
function totalWeightPointsLength() external view returns (uint256)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | 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 |
### updateWeight
```solidity
function updateWeight(uint256 pid, uint256 points) external nonpayable
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
| points | uint256 | undefined |
### weightPoints
```solidity
function weightPoints(uint256 pid) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### weightPointsAt
```solidity
function weightPointsAt(uint256 pid, uint256 timestamp) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
| timestamp | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### weightPointsLength
```solidity
function weightPointsLength(uint256 pid) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
## Events
### AddPool
```solidity
event AddPool(uint256 indexed pid)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid `indexed` | uint256 | undefined |
### OwnershipTransferred
```solidity
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| previousOwner `indexed` | address | undefined |
| newOwner `indexed` | address | undefined |
### UpdateWeight
```solidity
event UpdateWeight(uint256 indexed pid, uint256 weightPoints, uint256 totalWeightPoints)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| pid `indexed` | uint256 | undefined |
| weightPoints | uint256 | undefined |
| totalWeightPoints | uint256 | undefined |
## Errors
### InvalidPid
```solidity
error InvalidPid()
```
### InvalidTimestamp
```solidity
error InvalidTimestamp()
```