ETS

Overview

License: MIT

contract ETS is IETS, Initializable, ContextUpgradeable, ReentrancyGuardUpgradeable, UUPSUpgradeable

Constants info

NAME (0xa3f4df7e)

string constant NAME = "ETS Core"

Public constants

MODULO (0xa8586f7b)

uint256 constant MODULO = 100

State variables info

etsAccessControls (0x8299f9f9)

contract IETSAccessControls etsAccessControls

ETS access controls contract.

etsToken (0x46ca0f4d)

contract IETSToken etsToken

CTAG erc-721 token contract.

etsTarget (0x56c63489)

contract IETSTarget etsTarget

ETS Targets contract.

taggingFee (0xfe52656f)

uint256 taggingFee

Fee in MATIC Collected by ETS for tagging.

platformPercentage (0x1f741897)

uint256 platformPercentage

Percentage of tagging fee allocated to ETS.

relayerPercentage (0x2a1e1ee1)

uint256 relayerPercentage

Percentage of tagging fee allocated to Relayer.

accrued (0xb148440f)

mapping(address => uint256) accrued

Map for holding amount accrued to participant address wallets.

paid (0xa340cf79)

mapping(address => uint256) paid

Map for holding lifetime amount drawn down from accrued by participants.

taggingRecords (0x74716c81)

mapping(uint256 => struct IETS.TaggingRecord) taggingRecords

Map of tagging id to tagging record.

Modifiers info

onlyAdmin

modifier onlyAdmin()

When applied to a method, only allows execution when the sender has the admin role.

onlyRelayer

modifier onlyRelayer()

onlyOriginalRelayerOrTagger

modifier onlyOriginalRelayerOrTagger(uint256 _taggingRecordId)

Require that caller is original relayer or tagger.

Functions info

constructor

constructor()

oz-upgrades-unsafe-allow: constructor

initialize (0x728cdbca)

function initialize(
    IETSAccessControls _etsAccessControls,
    IETSToken _etsToken,
    IETSTarget _etsTarget,
    uint256 _taggingFee,
    uint256 _platformPercentage,
    uint256 _relayerPercentage
) public initializer

setAccessControls (0xcd15832f)

function setAccessControls(IETSAccessControls _accessControls) public onlyAdmin

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

Parameters:

setTaggingFee (0x962ed232)

function setTaggingFee(uint256 _fee) public onlyAdmin

Sets the fee required to tag an NFT asset.

Parameters:

setPercentages (0xbd2ec8c5)

function setPercentages(
    uint256 _platformPercentage,
    uint256 _relayerPercentage
) public onlyAdmin

Admin functionality for updating the percentages.

Parameters:

createTaggingRecord (0xc38f3037)

function createTaggingRecord(
    uint256[] memory _tagIds,
    uint256 _targetId,
    string calldata _recordType,
    address _tagger
) public payable nonReentrant onlyRelayer

Create a new tagging record.

Requirements:

• Caller must be relayer contract.
• CTAG(s) and TargetId must exist.

Parameters:

getOrCreateTagId (0xa27eee3c)

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

Get or create CTAG token from tag string.

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

Only ETS Relayer contracts may call this function.

Parameters:

Return values:

createTag (0x54b4d676)

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

Create CTAG token from tag string.

Reverts if tag exists or is invalid.

Only ETS Relayer contracts may call this function.

Parameters:

Return values:

applyTagsWithRawInput (0x01f1e2d8)

function applyTagsWithRawInput(
    IETS.TaggingRecordRawInput calldata _rawInput,
    address payable _tagger
) public payable

Apply one or more tags to a targetURI using tagging record raw client input data.

Like it's sister function applyTagsWithCompositeKey, records new ETS Tagging Record or appends tags to an existing record if found to already exist. This function differs in that it creates new ETS target records and CTAG tokens for novel targetURIs and hastag strings respectively. This function can only be called by Relayer contracts.

Parameters:

applyTagsWithCompositeKey (0x8361d140)

function applyTagsWithCompositeKey(
    uint256[] memory _tagIds,
    uint256 _targetId,
    string calldata _recordType,
    address payable _tagger
) public payable

Apply one or more tags to a targetId using using tagging record composite key.

Records new ETS Tagging Record to the blockchain or appends tags if Tagging Record already exists. CTAGs and targetId are created if they don't exist. Caller must be Relayer contract.

Parameters:

replaceTagsWithRawInput (0x70a306f7)

function replaceTagsWithRawInput(
    IETS.TaggingRecordRawInput calldata _rawInput,
    address payable _tagger
) public payable

Replace entire tag set in tagging record using raw data for record lookup.

If supplied tag strings don't have CTAGs, new ones are minted.

Parameters:

replaceTagsWithCompositeKey (0x5bb0b13b)

function replaceTagsWithCompositeKey(
    uint256[] calldata _tagIds,
    uint256 _targetId,
    string memory _recordType,
    address payable _tagger
) public payable

Replace entire tag set in tagging record using composite key for record lookup.

This function overwrites the tags in a tagging record with the supplied tags, only charging for the new tags in the replacement set.

Parameters:

removeTagsWithRawInput (0x7e2babd0)

function removeTagsWithRawInput(
    IETS.TaggingRecordRawInput calldata _rawInput,
    address _tagger
) public

Remove one or more tags from a tagging record using raw data for record lookup.

Parameters:

removeTagsWithCompositeKey (0x3f9fc582)

function removeTagsWithCompositeKey(
    uint256[] calldata _tagIds,
    uint256 _targetId,
    string memory _recordType,
    address payable _tagger
) public

Remove one or more tags from a tagging record using composite key for record lookup.

Parameters:

appendTags (0x0410ca9f)

function appendTags(
    uint256 _taggingRecordId,
    uint256[] memory _tagIds
) public payable nonReentrant onlyOriginalRelayerOrTagger(_taggingRecordId)

Append one or more tags to a tagging record.

Parameters:

replaceTags (0x46444c09)

function replaceTags(
    uint256 _taggingRecordId,
    uint256[] memory _tagIds
) public payable nonReentrant onlyOriginalRelayerOrTagger(_taggingRecordId)

Replaces tags in tagging record.

This function overwrites the tags in a tagging record with the supplied tags, only charging for the new tags in the replacement set.

Parameters:

removeTags (0xa0e0da18)

function removeTags(
    uint256 _taggingRecordId,
    uint256[] memory _tagIds
) public nonReentrant onlyOriginalRelayerOrTagger(_taggingRecordId)

Remove one or more tags from a tagging record.

Parameters:

drawDown (0xc2062005)

function drawDown(address payable _account) external nonReentrant

Function for withdrawing funds from an accrual account. Can be called by the account owner or on behalf of the account. Does nothing when there is nothing due to the account.

Parameters:

computeTaggingRecordIdFromRawInput (0x1632a9bc)

function computeTaggingRecordIdFromRawInput(
    IETS.TaggingRecordRawInput memory _rawInput,
    address _relayer,
    address _tagger
) public view returns (uint256 taggingRecordId)

Compute a taggingRecordId from raw input.

Parameters:

Return values:

computeTaggingRecordIdFromCompositeKey (0x06d05ed2)

function computeTaggingRecordIdFromCompositeKey(
    uint256 _targetId,
    string memory _recordType,
    address _relayer,
    address _tagger
) public pure returns (uint256 taggingRecordId)

Compute & return a taggingRecordId.

Every TaggingRecord in ETS is mapped to by it's taggingRecordId. This Id is a composite key composed of targetId, recordType, relayer contract address and tagger address hashed and cast as a uint256.

Parameters:

Return values:

computeTaggingFeeFromRawInput (0x249f3eec)

function computeTaggingFeeFromRawInput(
    IETS.TaggingRecordRawInput calldata _rawInput,
    address _relayer,
    address _tagger,
    IETS.TaggingAction _action
) public view returns (uint256 fee, uint256 tagCount)

Compute tagging fee for raw input and desired action.

Parameters:

Return values:

computeTaggingFeeFromCompositeKey (0x50064ea4)

function computeTaggingFeeFromCompositeKey(
    uint256[] memory _tagIds,
    uint256 _targetId,
    string calldata _recordType,
    address _relayer,
    address _tagger,
    IETS.TaggingAction _action
) public view returns (uint256 fee, uint256 tagCount)

Compute tagging fee for CTAGs, tagging record composite key and desired action.

Parameters:

Return values:

computeTaggingFee (0xa53d30a4)

function computeTaggingFee(
    uint256 _taggingRecordId,
    uint256[] memory _tagIds,
    IETS.TaggingAction _action
) public view returns (uint256 fee, uint256 tagCount)

Compute tagging fee for CTAGs, tagging record id and desired action.

If the global, service wide tagging fee is set (see ETS.taggingFee() & ETS.setTaggingFee()) ETS charges a per tag for all new tags applied to a tagging record. This applies to both new tagging records and modified tagging records.

Computing the tagging fee involves checking to see if a tagging record exists and if so, given the desired action (append or replace) determining the number of new tags being added and multiplying by the ETS per tag fee.

Parameters:

Return values:

getTaggingRecordFromRawInput (0x8633899c)

function getTaggingRecordFromRawInput(
    IETS.TaggingRecordRawInput memory _rawInput,
    address _relayer,
    address _tagger
)
    public
    view
    returns (
        uint256[] memory tagIds,
        uint256 targetId,
        string memory recordType,
        address relayer,
        address tagger
    )

Retrieve a tagging record from it's raw input.

Parameters:

Return values:

getTaggingRecordFromCompositeKey (0xa33def15)

function getTaggingRecordFromCompositeKey(
    uint256 _targetId,
    string memory _recordType,
    address _relayer,
    address _tagger
)
    public
    view
    returns (
        uint256[] memory tagIds,
        uint256 targetId,
        string memory recordType,
        address relayer,
        address tagger
    )

Retrieve a tagging record from composite key parts.

Parameters:

Return values:

getTaggingRecordFromId (0x68fd4dee)

function getTaggingRecordFromId(
    uint256 _id
)
    public
    view
    returns (
        uint256[] memory tagIds,
        uint256 targetId,
        string memory recordType,
        address relayer,
        address tagger
    )

Retrieve a tagging record from Id.

Parameters:

Return values:

taggingRecordExistsByRawInput (0xea552bc1)

function taggingRecordExistsByRawInput(
    IETS.TaggingRecordRawInput memory _rawInput,
    address _relayer,
    address _tagger
) public view returns (bool)

Check that a tagging record exists for given raw input.

Parameters:

Return values:

taggingRecordExistsByCompositeKey (0xf79fa988)

function taggingRecordExistsByCompositeKey(
    uint256 _targetId,
    string memory _recordType,
    address _relayer,
    address _tagger
) public view returns (bool)

Check that a tagging record exists by it's componsite key parts.

Parameters:

Return values:

taggingRecordExists (0x18fc4776)

function taggingRecordExists(
    uint256 _taggingRecordId
) public view returns (bool)

Check that a tagging record exsits by it's Id.

Parameters:

Return values:

totalDue (0x0ad2f0c3)

function totalDue(address _account) public view returns (uint256 _due)

Function to check how much MATIC has been accrued by an address factoring in amount paid out.

Parameters:

Return values: