ETSToken

Overview

License: MIT

contract ETSToken is ERC721PausableUpgradeable, ERC721BurnableUpgradeable, IETSToken, ReentrancyGuardUpgradeable, UUPSUpgradeable, StringHelpers

Constants info

NAME (0xa3f4df7e)

string constant NAME = "CTAG Token"

State variables info

ets (0x15ccda22)

contract IETS ets

etsAccessControls (0x8299f9f9)

contract IETSAccessControls etsAccessControls

tagMinStringLength (0xadf63cd2)

uint256 tagMinStringLength

tagMaxStringLength (0x2e611630)

uint256 tagMaxStringLength

ownershipTermLength (0xdb7af5fb)

uint256 ownershipTermLength

tokenIdToTag (0xad014a5b)

mapping(uint256 => struct IETSToken.Tag) tokenIdToTag

Map of CTAG id to CTAG record.

tokenIdToLastRenewed (0xcd025dea)

mapping(uint256 => uint256) tokenIdToLastRenewed

Mapping of tokenId to last renewal.

isTagPremium (0xc45b5ee1)

mapping(string => bool) isTagPremium

Defines whether a tag has been set up as premium

Modifiers info

onlyETSCore

modifier onlyETSCore()

Modifiers

onlyAdmin

modifier onlyAdmin()

onlyRelayer

modifier onlyRelayer()

Functions info

constructor

constructor()

oz-upgrades-unsafe-allow: constructor

initialize (0x4ec81af1)

function initialize(
    IETSAccessControls _etsAccessControls,
    uint256 _tagMinStringLength,
    uint256 _tagMaxStringLength,
    uint256 _ownershipTermLength
) public initializer

setETSCore (0xfd524313)

function setETSCore(IETS _ets) public onlyAdmin

Sets ETS core on the ETSToken contract so functions can be restricted to ETS platform only.

Parameters:

setAccessControls (0xcd15832f)

function setAccessControls(IETSAccessControls _accessControls) public onlyAdmin

Sets ETSAccessControls on the ETSToken contract function calls can be restricted to ETS platform only. Note: Caller of this function must be deployer or pre-set as admin of new contract.

Parameters:

pause (0x8456cb59)

function pause() public onlyAdmin whenNotPaused

Pauses ETSToken contract.

unPause (0xf7b188a5)

function unPause() public onlyAdmin whenPaused

Unpauses ETSToken contract.

burn (0x42966c68)

function burn(uint256 tokenId) public override onlyAdmin

Burns tokenId. See {ERC721-_burn}.

Requirements:

• The caller must own tokenId or be an approved operator.

setTagMaxStringLength (0x060defec)

function setTagMaxStringLength(uint256 _tagMaxStringLength) public onlyAdmin

admin function to set maximum character length of CTAG display string.

Parameters:

setTagMinStringLength (0x86f57171)

function setTagMinStringLength(uint256 _tagMinStringLength) public onlyAdmin

Admin function to set minimum character length of CTAG display string.

Parameters:

setOwnershipTermLength (0xf66e7623)

function setOwnershipTermLength(uint256 _ownershipTermLength) public onlyAdmin

Admin function to set the ownership term length of a CTAG is set.

Parameters:

preSetPremiumTags (0xa1de95e5)

function preSetPremiumTags(
    string[] calldata _tags,
    bool _enabled
) public onlyAdmin

Admin function to flag/unflag tag string(s) as premium prior to minting.

Parameters:

setPremiumFlag (0x27a2e473)

function setPremiumFlag(
    uint256[] calldata _tokenIds,
    bool _isPremium
) public onlyAdmin

Admin function to flag/unflag CTAG(s) as premium.

Parameters:

setReservedFlag (0xaf46adb8)

function setReservedFlag(
    uint256[] calldata _tokenIds,
    bool _reserved
) public onlyAdmin

Admin function to flag/unflag CTAG(s) as reserved.

Tags flagged as reserved cannot be auctioned.

Parameters:

getOrCreateTag (0x07348e26)

function getOrCreateTag(
    string calldata _tag,
    address payable _relayer,
    address payable _creator
) public payable returns (IETSToken.Tag memory tag)

getOrCreateTagId (0xfed6c2e9)

function getOrCreateTagId(
    string calldata _tag,
    address payable _relayer,
    address payable _creator
) public payable returns (uint256 tokenId)

Get CTAG token Id from tag string.

Combo function that accepts a tag string and returns it's CTAG token Id if it exists, or creates a new CTAG and returns corresponding Id.

Only ETS Core can call this function.

Parameters:

Return values:

createTag (0xa675f1e3)

function createTag(
    string calldata _tag,
    address payable _relayer,
    address payable _creator
) public payable nonReentrant onlyETSCore returns (uint256 _tokenId)

Create CTAG token from tag string.

Reverts if tag exists or is invalid.

Only ETS Core can call this function.

Parameters:

Return values:

renewTag (0xc157daea)

function renewTag(uint256 _tokenId) public

Renews ownership term of a CTAG.

A "CTAG ownership term" is utilized to prevent CTAGs from being abandoned or inaccessable due to lost private keys.

Any wallet address may renew the term of a CTAG for an owner. When renewed, the term is extended from the current block timestamp plus the ownershipTermLength public variable.

Parameters:

recycleTag (0xe8d3e4b6)

function recycleTag(uint256 _tokenId) public

Recycles a CTAG back to ETS.

When ownership term of a CTAG has expired, any wallet or contract may call this function to recycle the tag back to ETS. Once recycled, a tag may be auctioned again.

Parameters:

supportsInterface (0x01ffc9a7)

function supportsInterface(
    bytes4 interfaceId
) public view virtual override returns (bool)

computeTagId (0xf143fc61)

function computeTagId(string memory _tag) public pure returns (uint256)

Function to deterministically compute & return a CTAG token Id.

Every CTAG token and it's associated data struct is mapped to by it's token Id. This Id is computed from the "display" tag string lowercased, hashed and cast as an unsigned integer.

Note: Function does not verify if CTAG record exists.

Parameters:

Return values:

tagExistsByString (0xf6ba042a)

function tagExistsByString(string calldata _tag) public view returns (bool)

Check that a CTAG token exists for a given tag string.

Parameters:

Return values:

tagExistsById (0xb7bd44ed)

function tagExistsById(uint256 _tokenId) public view returns (bool)

Check that CTAG token exists for a given computed token Id.

Parameters:

Return values:

tagOwnershipTermExpired (0xe9bd8126)

function tagOwnershipTermExpired(uint256 _tokenId) public view returns (bool)

Check if CTAG token ownership term has expired.

Parameters:

Return values:

getTagByString (0x6c1244b6)

function getTagByString(
    string calldata _tag
) public view returns (IETSToken.Tag memory)

Retrieve a CTAG record for a given tag string.

Note: returns a struct with empty members when no CTAG exists.

Parameters:

Return values:

getTagById (0x4b3d267f)

function getTagById(
    uint256 _tokenId
) public view returns (IETSToken.Tag memory)

Retrieve a CTAG record for a given token Id.

Note: returns a struct with empty members when no CTAG exists.

Parameters:

Return values:

getOwnershipTermLength (0x500aac87)

function getOwnershipTermLength() public view returns (uint256)

Retrieve CTAG ownership term length global setting.

Return values:

getLastRenewed (0xb06a89a7)

function getLastRenewed(uint256 _tokenId) public view returns (uint256)

Retrieve last renewal block timestamp for a CTAG.

Parameters:

Return values:

getPlatformAddress (0x3c0c4566)

function getPlatformAddress() public view returns (address payable)

Retrieve wallet address for ETS Platform.

Return values:

getCreatorAddress (0xa30b4db9)

function getCreatorAddress(uint256 _tokenId) public view returns (address)

Retrieve Creator address for a CTAG token.

Parameters:

Return values: