IETSAccessControls

Overview

License: MIT

interface IETSAccessControls is IAccessControlUpgradeable

Events info

PlatformSet

event PlatformSet(address newAddress, address prevAddress)

emitted when the ETS Platform address is set.

Parameters:

Name	Type	Description
newAddress	address	wallet address platform is being set to.
prevAddress	address	previous platform address.

RelayerAdded

event RelayerAdded(address relayer)

emitted when a Relayer contract is added & enabled in ETS.

Relayer contracts are not required implement all ETS Core API functions. Therefore, to ease testing of ETS Core API fuinctions, ETS permits addition of ETS owned wallet addresses as Relayers.

Parameters:

Name	Type	Description
relayer	address	Relayer contract address.

RelayerLockToggled

event RelayerLockToggled(address relayer)

emitted when a Relayer contract is paused or unpaused.

Parameters:

Name	Type	Description
relayer	address	Address that had pause toggled.

Functions info

setPlatform (0x6945c5ea)

function setPlatform(address payable _platform) external

Sets the Platform wallet address. Can only be called by address with DEFAULT_ADMIN_ROLE.

Parameters:

Name	Type	Description
_platform	address payable	The new Platform address to set.

registerRelayer (0x2b70420b)

function registerRelayer(
    address _relayer,
    string calldata _name,
    address _owner
) external

Adds a Relayer contract to ETS. Can only be called by address with DEFAULT_ADMIN_ROLE.

Parameters:

Name	Type	Description
_relayer	address	Address of the Relayer contract. Must conform to IETSRelayer.
_name	string	Human readable name of the Relayer.
_owner	address	Address of relayer owner.

pauseRelayerByOwnerAddress (0xa10138e8)

function pauseRelayerByOwnerAddress(address _relayerOwner) external

Pause relayer given the relayer owner address. Callable by Platform only.

Parameters:

Name	Type	Description
_relayerOwner	address	Address of the Relayer owner.

changeRelayerOwner (0x8e0ed37c)

function changeRelayerOwner(address _currentOwner, address _newOwner) external

Change the relayer owner as stored in ETSAccessControls. Callable from Relayer only. Called via changeOwner() on a relayer.

Parameters:

Name	Type	Description
_currentOwner	address	Address of the current relayer owner.
_newOwner	address	Address of the new relayer owner.

toggleRelayerLock (0x21c82406)

function toggleRelayerLock(address _relayer) external

Pauses/Unpauses a Relayer contract. Can only be called by address with DEFAULT_ADMIN_ROLE.

Parameters:

Name	Type	Description
_relayer	address	Address of the Relayer contract.

setRoleAdmin (0x1e4e0091)

function setRoleAdmin(bytes32 _role, bytes32 _adminRole) external

Sets the role admin for a given role. An address with role admin can grant or revoke that role for other addresses. Can only be called by address with DEFAULT_ADMIN_ROLE.

Parameters:

Name	Type	Description
_role	bytes32	bytes32 representation of role being administered.
_adminRole	bytes32	bytes32 representation of administering role.

isSmartContract (0x347308b2)

function isSmartContract(address _addr) external view returns (bool)

Checks whether given address has SMART_CONTRACT role.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address has SMART_CONTRACT role.

isAdmin (0x24d7806c)

function isAdmin(address _addr) external view returns (bool)

Checks whether given address has DEFAULT_ADMIN_ROLE role.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address has DEFAULT_ADMIN_ROLE role.

isAuctionOracle (0x58594dc4)

function isAuctionOracle(address _addr) external view returns (bool)

Checks whether given address has AUCTION_ORACLE_ROLE role.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address has AUCTION_ORACLE_ROLE role.

isRelayerFactory (0xf968b877)

function isRelayerFactory(address _addr) external view returns (bool)

Checks whether given address can act as relayer factory.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address can act as relayer factory.

isRelayer (0x541d5548)

function isRelayer(address _addr) external view returns (bool)

Checks whether given address is a relayer.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address can be a relayer.

isRelayerAndNotPaused (0x01b96189)

function isRelayerAndNotPaused(address _addr) external view returns (bool)

Checks whether given address is a registered Relayer and not paused.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address is a Relayer and not paused.

isRelayerLocked (0xa8e2f235)

function isRelayerLocked(address _addr) external view returns (bool)

Checks relayer is paused by ETS Platform.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if relayer address is paused by platform.

isRelayerByOwner (0x8776887a)

function isRelayerByOwner(address _addr) external view returns (bool)

Checks whether given address owns a relayer.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address owns a relayer.

isRelayerAdmin (0x3498e6ab)

function isRelayerAdmin(address _addr) external view returns (bool)

Checks whether given address has RELAYER_ADMIN role.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address has RELAYER_ADMIN role.

isRelayerByName (0x277c3f40)

function isRelayerByName(string calldata _name) external view returns (bool)

Checks whether given Relayer Name is a registered Relayer.

Parameters:

Name	Type	Description
_name	string	Name being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if _name is a Relayer.

isRelayerByAddress (0x6ab04a93)

function isRelayerByAddress(address _addr) external view returns (bool)

Checks whether given address is a registered Relayer.

Parameters:

Name	Type	Description
_addr	address	Address being checked.

Return values:

Name	Type	Description
[0]	bool	boolean True if address is a registered Relayer.

getRelayerAddressFromName (0xa710f73e)

function getRelayerAddressFromName(
    string calldata _name
) external view returns (address)

Get relayer address from it's name.

Parameters:

Name	Type	Description
_name	string	Name of relayer.

Return values:

Name	Type	Description
[0]	address	Address of relayer.

getRelayerNameFromAddress (0x985dcdac)

function getRelayerNameFromAddress(
    address _address
) external view returns (string calldata)

Get relayer name from it's address.

Parameters:

Name	Type	Description
_address	address	Adsdress of relayer.

Return values:

Name	Type	Description
[0]	string	Name of relayer.

getRelayerAddressFromOwner (0xdf3b5580)

function getRelayerAddressFromOwner(
    address _address
) external view returns (address)

Get relayer address from its owner address.

Parameters:

Name	Type	Description
_address	address	address of relayer owner.

Return values:

Name	Type	Description
[0]	address	Address of relayer.

getPlatformAddress (0x3c0c4566)

function getPlatformAddress() external view returns (address payable)

Returns wallet address for ETS Platform.

Return values:

Name	Type	Description
[0]	address payable	ETS Platform address.