UNPKG

@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.

490 lines (268 loc) 7.29 kB
# FlashNFT ## Methods ### approve ```solidity function approve(address to, uint256 tokenId) external nonpayable ``` *See {IERC721-approve}.* #### Parameters | Name | Type | Description | |---|---|---| | to | address | undefined | | tokenId | uint256 | undefined | ### balanceOf ```solidity function balanceOf(address owner) external view returns (uint256) ``` *See {IERC721-balanceOf}.* #### Parameters | Name | Type | Description | |---|---|---| | owner | address | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### burn ```solidity function burn(uint256 _tokenId) external nonpayable returns (bool) ``` #### Parameters | Name | Type | Description | |---|---|---| | _tokenId | uint256 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | bool | undefined | ### contractURI ```solidity function contractURI() external pure returns (string) ``` #### Returns | Name | Type | Description | |---|---|---| | _0 | string | undefined | ### exists ```solidity function exists(uint256 _tokenId) external view returns (bool) ``` #### Parameters | Name | Type | Description | |---|---|---| | _tokenId | uint256 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | bool | undefined | ### getApproved ```solidity function getApproved(uint256 tokenId) external view returns (address) ``` *See {IERC721-getApproved}.* #### Parameters | Name | Type | Description | |---|---|---| | tokenId | uint256 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | address | undefined | ### isApprovedForAll ```solidity function isApprovedForAll(address owner, address operator) external view returns (bool) ``` *See {IERC721-isApprovedForAll}.* #### Parameters | Name | Type | Description | |---|---|---| | owner | address | undefined | | operator | address | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | bool | undefined | ### mint ```solidity function mint(address _recipientAddress) external nonpayable returns (uint256) ``` #### Parameters | Name | Type | Description | |---|---|---| | _recipientAddress | address | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### name ```solidity function name() external view returns (string) ``` *See {IERC721Metadata-name}.* #### Returns | Name | Type | Description | |---|---|---| | _0 | string | undefined | ### owner ```solidity function owner() external view returns (address) ``` *Returns the address of the current owner.* #### Returns | Name | Type | Description | |---|---|---| | _0 | address | undefined | ### ownerOf ```solidity function ownerOf(uint256 tokenId) external view returns (address) ``` *See {IERC721-ownerOf}.* #### Parameters | Name | Type | Description | |---|---|---| | tokenId | uint256 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | 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.* ### safeTransferFrom ```solidity function safeTransferFrom(address from, address to, uint256 tokenId) external nonpayable ``` *See {IERC721-safeTransferFrom}.* #### Parameters | Name | Type | Description | |---|---|---| | from | address | undefined | | to | address | undefined | | tokenId | uint256 | undefined | ### safeTransferFrom ```solidity function safeTransferFrom(address from, address to, uint256 tokenId, bytes data) external nonpayable ``` *See {IERC721-safeTransferFrom}.* #### Parameters | Name | Type | Description | |---|---|---| | from | address | undefined | | to | address | undefined | | tokenId | uint256 | undefined | | data | bytes | undefined | ### setApprovalForAll ```solidity function setApprovalForAll(address operator, bool approved) external nonpayable ``` *See {IERC721-setApprovalForAll}.* #### Parameters | Name | Type | Description | |---|---|---| | operator | address | undefined | | approved | bool | undefined | ### supportsInterface ```solidity function supportsInterface(bytes4 interfaceId) external view returns (bool) ``` *See {IERC165-supportsInterface}.* #### Parameters | Name | Type | Description | |---|---|---| | interfaceId | bytes4 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | bool | undefined | ### symbol ```solidity function symbol() external view returns (string) ``` *See {IERC721Metadata-symbol}.* #### Returns | Name | Type | Description | |---|---|---| | _0 | string | undefined | ### tokenURI ```solidity function tokenURI(uint256 tokenId) external view returns (string) ``` *See {IERC721Metadata-tokenURI}.* #### Parameters | Name | Type | Description | |---|---|---| | tokenId | uint256 | undefined | #### Returns | Name | Type | Description | |---|---|---| | _0 | string | undefined | ### totalSupply ```solidity function totalSupply() external view returns (uint256) ``` #### Returns | Name | Type | Description | |---|---|---| | _0 | uint256 | undefined | ### transferFrom ```solidity function transferFrom(address from, address to, uint256 tokenId) external nonpayable ``` *See {IERC721-transferFrom}.* #### Parameters | Name | Type | Description | |---|---|---| | from | address | undefined | | to | address | undefined | | tokenId | 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 | ## Events ### Approval ```solidity event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId) ``` #### Parameters | Name | Type | Description | |---|---|---| | owner `indexed` | address | undefined | | approved `indexed` | address | undefined | | tokenId `indexed` | uint256 | undefined | ### ApprovalForAll ```solidity event ApprovalForAll(address indexed owner, address indexed operator, bool approved) ``` #### Parameters | Name | Type | Description | |---|---|---| | owner `indexed` | address | undefined | | operator `indexed` | address | undefined | | approved | bool | undefined | ### OwnershipTransferred ```solidity event OwnershipTransferred(address indexed previousOwner, address indexed newOwner) ``` #### Parameters | Name | Type | Description | |---|---|---| | previousOwner `indexed` | address | undefined | | newOwner `indexed` | address | undefined | ### Transfer ```solidity event Transfer(address indexed from, address indexed to, uint256 indexed tokenId) ``` #### Parameters | Name | Type | Description | |---|---|---| | from `indexed` | address | undefined | | to `indexed` | address | undefined | | tokenId `indexed` | uint256 | undefined |