ETSAccessControls

Overview

License: MIT

contract ETSAccessControls is Initializable, AccessControlUpgradeable, IETSAccessControls, UUPSUpgradeable

Constants info

NAME (0xa3f4df7e)

string constant NAME = "ETS access controls"

Public constants

RELAYER_ROLE (0x926d7d7f)

bytes32 constant RELAYER_ROLE = keccak256("RELAYER_ROLE")

RELAYER_FACTORY_ROLE (0xdd37dc22)

bytes32 constant RELAYER_FACTORY_ROLE = keccak256("RELAYER_FACTORY_ROLE")

RELAYER_ADMIN_ROLE (0xbf2a2241)

bytes32 constant RELAYER_ADMIN_ROLE = keccak256("RELAYER_ADMIN_ROLE")

AUCTION_ORACLE_ROLE (0xc8d8311d)

bytes32 constant AUCTION_ORACLE_ROLE = keccak256("AUCTION_ORACLE_ROLE")

SMART_CONTRACT_ROLE (0x857d2608)

bytes32 constant SMART_CONTRACT_ROLE = keccak256("SMART_CONTRACT_ROLE")

State variables info

relayerLocked (0x942da8f0)

mapping(address => bool) relayerLocked

Mapping to contain whether Relayer is paused by the protocol.

relayerNameToContract (0x1a943187)

mapping(string => address) relayerNameToContract

Relayer name to contract address.

relayerContractToName (0x5235075c)

mapping(address => string) relayerContractToName

Relayer contract address to human readable name.

relayerOwnerToAddress (0xac9f40a5)

mapping(address => address) relayerOwnerToAddress

Relayer owner address to relayer address.

Modifiers info

onlyValidName

modifier onlyValidName(string calldata _name)

Functions info

constructor

constructor()

oz-upgrades-unsafe-allow: constructor

initialize (0xc4d66de8)

function initialize(address _platformAddress) public initializer

setPlatform (0x6945c5ea)

function setPlatform(
    address payable _platform
) public onlyRole(DEFAULT_ADMIN_ROLE)

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

Parameters:

setRoleAdmin (0x1e4e0091)

function setRoleAdmin(
    bytes32 _role,
    bytes32 _adminRole
) public onlyRole(DEFAULT_ADMIN_ROLE)

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:

registerRelayer (0x2b70420b)

function registerRelayer(
    address _relayer,
    string calldata _name,
    address _owner
) public onlyRole(RELAYER_FACTORY_ROLE)

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

Parameters:

pauseRelayerByOwnerAddress (0xa10138e8)

function pauseRelayerByOwnerAddress(
    address _relayerOwner
) public onlyRole(RELAYER_ADMIN_ROLE)

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

Parameters:

changeRelayerOwner (0x8e0ed37c)

function changeRelayerOwner(
    address _currentOwner,
    address _newOwner
) public onlyRole(RELAYER_ROLE)

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

Parameters:

toggleRelayerLock (0x21c82406)

function toggleRelayerLock(
    address _relayer
) public onlyRole(RELAYER_ADMIN_ROLE)

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

Parameters:

isSmartContract (0x347308b2)

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

Checks whether given address has SMART_CONTRACT role.

Parameters:

Return values:

isAdmin (0x24d7806c)

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

Checks whether given address has DEFAULT_ADMIN_ROLE role.

Parameters:

Return values:

isAuctionOracle (0x58594dc4)

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

Checks whether given address has AUCTION_ORACLE_ROLE role.

Parameters:

Return values:

isRelayerFactory (0xf968b877)

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

Checks whether given address can act as relayer factory.

Parameters:

Return values:

isRelayer (0x541d5548)

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

Checks whether given address is a relayer.

Parameters:

Return values:

isRelayerLocked (0xa8e2f235)

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

Checks relayer is paused by ETS Platform.

Parameters:

Return values:

isRelayerAndNotPaused (0x01b96189)

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

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

Parameters:

Return values:

isRelayerByOwner (0x8776887a)

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

Checks whether given address owns a relayer.

Parameters:

Return values:

isRelayerAdmin (0x3498e6ab)

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

Checks whether given address has RELAYER_ADMIN role.

Parameters:

Return values:

isRelayerByName (0x277c3f40)

function isRelayerByName(string memory _name) public view returns (bool)

Checks whether given Relayer Name is a registered Relayer.

Parameters:

Return values:

isRelayerByAddress (0x6ab04a93)

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

Checks whether given address is a registered Relayer.

Parameters:

Return values:

getRelayerAddressFromName (0xa710f73e)

function getRelayerAddressFromName(
    string memory _name
) public view returns (address)

Get relayer address from it's name.

Parameters:

Return values:

getRelayerNameFromAddress (0x985dcdac)

function getRelayerNameFromAddress(
    address _address
) public view returns (string memory)

Get relayer name from it's address.

Parameters:

Return values:

getRelayerAddressFromOwner (0xdf3b5580)

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

Get relayer address from its owner address.

Parameters:

Return values:

getPlatformAddress (0x3c0c4566)

function getPlatformAddress() public view returns (address payable)

Returns wallet address for ETS Platform.

Return values: