@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.
215 lines (100 loc) • 2.41 kB
Markdown
# FSushiAirdropsVotingEscrow
## Methods
### claim
```solidity
function claim(address beneficiary) external nonpayable returns (uint256 amount)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| beneficiary | address | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| amount | uint256 | undefined |
### fSushi
```solidity
function fSushi() external view returns (address)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
### lastCheckpoint
```solidity
function lastCheckpoint() external view returns (uint256)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### lastCheckpointOf
```solidity
function lastCheckpointOf(address) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### startWeek
```solidity
function startWeek() external view returns (uint256)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### votingEscrow
```solidity
function votingEscrow() external view returns (address)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
### votingEscrowInterval
```solidity
function votingEscrowInterval() external view returns (uint256)
```
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
### votingEscrowTotalSupply
```solidity
function votingEscrowTotalSupply(uint256) external view returns (uint256)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
#### Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
## Events
### Claim
```solidity
event Claim(address indexed account, uint256 amount, address indexed beneficiary, uint256 fromWeek, uint256 untilWeek)
```
#### Parameters
| Name | Type | Description |
|---|---|---|
| account `indexed` | address | undefined |
| amount | uint256 | undefined |
| beneficiary `indexed` | address | undefined |
| fromWeek | uint256 | undefined |
| untilWeek | uint256 | undefined |
## Errors
### Claimed
```solidity
error Claimed()
```
### Expired
```solidity
error Expired()
```