Author: GuildCrypt
Documentation generated by @GuildCrypt/solspecdown
Type | Name | Description | Indexed? | |
---|---|---|---|---|
0 |
address |
owner |
true |
|
1 |
address |
approved |
true |
|
2 |
uint256 |
tokenId |
true |
Type | Name | Description | Indexed? | |
---|---|---|---|---|
0 |
address |
owner |
true |
|
1 |
address |
operator |
true |
|
2 |
bool |
approved |
false |
Approves another address to transfer the given token ID The zero address indicates there is no approved address. There can only be one approved address per token at a given time. Can only be called by the token owner or an approved operator.
Type | Name | Description | |
---|---|---|---|
0 |
address |
to |
address to be approved for the given token ID |
1 |
uint256 |
tokenId |
uint256 ID of the token to be approved |
Gets the balance of the specified address
Type | Name | Description | |
---|---|---|---|
0 |
address |
owner |
address to query the balance of |
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
Type | Name | Description | |
---|---|---|---|
0 |
string |
name |
|
1 |
string |
symbol |
Gets the approved address for a token ID, or zero if no address set Reverts if the token ID does not exist.
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
uint256 ID of the token to query the approval of |
Type | Name | Description | |
---|---|---|---|
0 |
address |
Initiate a sunset. Sets sunsetInitiatedAt
to current timestamp. Only owner
may call this function.
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
The id of the token |
Tells whether an operator is approved by a given owner
Type | Name | Description | |
---|---|---|---|
0 |
address |
owner |
owner address which you want to query the approval of |
1 |
address |
operator |
operator address which you want to query the approval of |
Type | Name | Description | |
---|---|---|---|
0 |
bool |
Type | Name | Description | |
---|---|---|---|
0 |
bool |
Mint a token. Only owner
may call this function.
Type | Name | Description | |
---|---|---|---|
0 |
address |
to |
The receiver of the token |
1 |
string |
tokenURI |
The tokenURI of the the tokenURI |
2 |
uint256 |
__sunsetLength |
The length (in seconds) that a sunset period can last |
Gets the token name
Type | Name | Description | |
---|---|---|---|
0 |
string |
Returns the token id of the next minted token
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
Type | Name | Description | |
---|---|---|---|
0 |
address |
Gets the owner of the specified token ID
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
uint256 ID of the token to query the owner of |
Type | Name | Description | |
---|---|---|---|
0 |
address |
Type | Name | Description | Indexed? | |
---|---|---|---|---|
0 |
address |
previousOwner |
true |
|
1 |
address |
newOwner |
true |
Returns the redemption code hash submitted for a token
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
The token id |
Type | Name | Description | |
---|---|---|---|
0 |
bytes32 |
Type | Name | Description | Indexed? | |
---|---|---|---|---|
0 |
uint256 |
tokenId |
true |
|
1 |
bytes32 |
redemptionCodeHash |
false |
Returns the timestamp at which a redemption code hash was submitted
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
The token id |
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
Safely transfers the ownership of a given token ID to another address If the target address is a contract, it must implement onERC721Received
, which is called upon a safe transfer, and return the magic value bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))
; otherwise, the transfer is reverted. Requires the msg sender to be the owner, approved, or operator
Type | Name | Description | |
---|---|---|---|
0 |
address |
from |
current owner of the token |
1 |
address |
to |
address to receive the ownership of the given token ID |
2 |
uint256 |
tokenId |
uint256 ID of the token to be transferred |
3 |
bytes |
_data |
bytes data to send along with a safe transfer check |
Safely transfers the ownership of a given token ID to another address If the target address is a contract, it must implement onERC721Received
, which is called upon a safe transfer, and return the magic value bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))
; otherwise, the transfer is reverted. * Requires the msg sender to be the owner, approved, or operator
Type | Name | Description | |
---|---|---|---|
0 |
address |
from |
current owner of the token |
1 |
address |
to |
address to receive the ownership of the given token ID |
2 |
uint256 |
tokenId |
uint256 ID of the token to be transferred |
Sets or unsets the approval of a given operator An operator is allowed to transfer all tokens of the sender on their behalf
Type | Name | Description | |
---|---|---|---|
0 |
address |
to |
operator address to set the approval |
1 |
bool |
approved |
representing the status of the approval to be set |
Set tokenUri
. Only owner
may do this.
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
The id of the token |
1 |
string |
tokenURI |
The token URI |
Submit a redemption code hash for a specific token. Burns the token. Sets redemptionCodeHashSubmittedAt
to current timestamp. Decreases totalSupply
by 1.
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
The id of the token |
1 |
bytes32 |
__redemptionCodeHash |
The redemption code hash |
Type | Name | Description | Indexed? | |
---|---|---|---|---|
0 |
uint256 |
tokenId |
true |
Returns the timestamp at which a token's sunset was initated. Returns 0 if no sunset has been initated.
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
The token id |
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
Returns the sunset length of a token
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
The token id |
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
implement supportsInterface(bytes4) using a lookup table
Type | Name | Description | |
---|---|---|---|
0 |
bytes4 |
interfaceId |
Type | Name | Description | |
---|---|---|---|
0 |
bool |
Gets the token symbol
Type | Name | Description | |
---|---|---|---|
0 |
string |
Returns an URI for a given token ID Throws if the token ID does not exist. May return an empty string.
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
tokenId |
uint256 ID of the token to query |
Type | Name | Description | |
---|---|---|---|
0 |
string |
Returns the total number of tokens (minted - burned) registered
Type | Name | Description | |
---|---|---|---|
0 |
uint256 |
Type | Name | Description | Indexed? | |
---|---|---|---|---|
0 |
address |
from |
true |
|
1 |
address |
to |
true |
|
2 |
uint256 |
tokenId |
true |
Transfers the ownership of a given token ID to another address. Usage of this method is discouraged, use safeTransferFrom
whenever possible. Requires the msg sender to be the owner, approved, or operator
Type | Name | Description | |
---|---|---|---|
0 |
address |
from |
current owner of the token |
1 |
address |
to |
address to receive the ownership of the given token ID |
2 |
uint256 |
tokenId |
uint256 ID of the token to be transferred |
Allows the current owner to transfer control of the contract to a newOwner.
Type | Name | Description | |
---|---|---|---|
0 |
address |
newOwner |
The address to transfer ownership to. |