MainchainGatewayManager

0x1a2a1c938ce3ec39b6d47113c7955baa9dd454f2 Copy

About

Stats

Public Functions 20

Event Types 6

Code Size 29,629 bytes

Library Use

Uses AddressUtils for address.

Uses SafeMath for uint256.

Uses ECVerify for bytes32.

Events (6)

AdminChanged Event

Parameters

_oldAdmin	address
_newAdmin	address

AdminRemoved Event

Parameters

_oldAdmin

address

Paused Event

Parameters

TokenDeposited Event

Parameters

_depositId	uint256
_owner	address
_tokenAddress	address
_sidechainAddress	address
_standard	uint32
_tokenNumber	uint256

TokenWithdrew Event

Parameters

_withdrawId	uint256
_owner	address
_tokenAddress	address
_tokenNumber	uint256

Unpaused Event

Parameters

State Variables (7)

registry Variable

address

depositCount Variable

uint256

admin Variable

address

paused Variable

bool

deposits Variable

DepositEntry[]

Internal Variable

withdrawals Variable

mapping(uint256 => WithdrawalEntry)

Internal Variable

_proxyTo Variable

address

Internal Variable

Functions Expand All Collapse All

changeAdmin

Parameters

Name	Type
_newAdmin	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

admin must be equal to the sender's address

Requirements

_newAdmin must not be equal to UNKNOWN VALUE

Source Code

function changeAdmin(address _newAdmin) external onlyAdmin {
  require(_newAdmin != address(0));
  emit AdminChanged(admin, _newAdmin);
  admin = _newAdmin;
}

removeAdmin

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

admin must be equal to the sender's address

Source Code

function removeAdmin() external onlyAdmin {
  emit AdminRemoved(admin);
  admin = address(0);
}

pause

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

admin must be equal to the sender's address

whenNotPaused checks for the following:

paused must not be true

Source Code

function pause() public onlyAdmin whenNotPaused {
  paused = true;
  emit Paused();
}

unpause

Parameters

This function has no parameters.

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

admin must be equal to the sender's address

whenPaused checks for the following:

paused must be true

Source Code

function unpause() public onlyAdmin whenPaused {
  paused = false;
  emit Unpaused();
}

updateRegistry

Parameters

Name	Type
_registry	address

Properties

Visibility public

Mutability transaction

Modifiers

onlyAdmin checks for the following:

admin must be equal to the sender's address

Source Code

function updateRegistry(address _registry) external onlyAdmin {
  registry = Registry(_registry);
}

constructor

Parameters

This function has no parameters.

Properties

Visibility public

Mutability payable

Source Code

function() external payable {}

depositEth

Parameters

This function has no parameters.

Properties

Visibility public

Mutability payable

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

_tokenStandard must be equal to 20

Source Code

function depositEth() external payable whenNotPaused returns (uint256) {
  return depositEthFor(msg.sender);
}

depositERC20

Parameters

Name	Type
_token	address
_amount	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

_tokenStandard must be equal to 20

Source Code

function depositERC20(address _token, uint256 _amount)
  external
  whenNotPaused
  returns (uint256)
{
  return depositERC20For(msg.sender, _token, _amount);
}

depositERC721

Parameters

Name	Type
_token	address
_tokenId	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

_tokenStandard must be equal to 20

Source Code

function depositERC721(address _token, uint256 _tokenId)
  external
  whenNotPaused
  returns (uint256)
{
  return depositERC721For(msg.sender, _token, _tokenId);
}

depositEthFor

Parameters

Name	Type
_owner	address

Properties

Visibility public

Mutability payable

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

_tokenStandard must be equal to 20

Source Code

function depositEthFor(address _owner)
  public
  payable
  whenNotPaused
  returns (uint256)
{
  address _weth = registry.getContract(registry.WETH_TOKEN());
  WETH(_weth).deposit.value(msg.value)();
  return _createDepositEntry(_owner, _weth, 20, msg.value);
}

depositERC20For

Parameters

Name	Type
_user	address
_token	address
_amount	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

_tokenStandard must be equal to 20

Source Code

function depositERC20For(
  address _user,
  address _token,
  uint256 _amount
) public whenNotPaused returns (uint256) {
  require(
    IERC20(_token).transferFrom(msg.sender, address(this), _amount),
    "MainchainGatewayManager: ERC-20 token transfer failed"
  );
  return _createDepositEntry(_user, _token, 20, _amount);
}

depositERC721For

Parameters

Name	Type
_user	address
_token	address
_tokenId	uint256

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

_tokenStandard must be equal to 20

Source Code

function depositERC721For(
  address _user,
  address _token,
  uint256 _tokenId
) public whenNotPaused returns (uint256) {
  IERC721(_token).transferFrom(msg.sender, address(this), _tokenId);
  return _createDepositEntry(_user, _token, 721, _tokenId);
}

depositBulkFor

Parameters

Name	Type
_user	address
_tokens	address[]
_tokenNumbers	uint256[]

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

the number of values in _tokens must be equal to the number of values in _tokenNumbers

Source Code

function depositBulkFor(
  address _user,
  address[] memory _tokens,
  uint256[] memory _tokenNumbers
) public whenNotPaused {
  require(_tokens.length == _tokenNumbers.length);

  for (uint256 _i = 0; _i < _tokens.length; _i++) {
    address _token = _tokens[_i];
    uint256 _tokenNumber = _tokenNumbers[_i];
    (, , uint32 _standard) = registry.getMappedToken(_token, true);

    if (_standard == 20) {
      depositERC20For(_user, _token, _tokenNumber);
    } else if (_standard == 721) {
      depositERC721For(_user, _token, _tokenNumber);
    } else {
      revert("Token is not mapped or token type not supported");
    }
  }
}

withdrawToken

Parameters

Name	Type
_withdrawalId	uint256
_token	address
_amount	uint256
_signatures	bytes

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Source Code

function withdrawToken(
  uint256 _withdrawalId,
  address _token,
  uint256 _amount,
  bytes memory _signatures
) public whenNotPaused {
  withdrawTokenFor(_withdrawalId, msg.sender, _token, _amount, _signatures);
}

withdrawTokenFor

Parameters

Name	Type
_withdrawalId	uint256
_user	address
_token	address
_amount	uint256
_signatures	bytes

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Source Code

function withdrawTokenFor(
  uint256 _withdrawalId,
  address _user,
  address _token,
  uint256 _amount,
  bytes memory _signatures
) public whenNotPaused {
  (, , uint32 _tokenType) = registry.getMappedToken(_token, true);

  if (_tokenType == 20) {
    withdrawERC20For(_withdrawalId, _user, _token, _amount, _signatures);
  } else if (_tokenType == 721) {
    withdrawERC721For(_withdrawalId, _user, _token, _amount, _signatures);
  }
}

withdrawERC20

Parameters

Name	Type
_withdrawalId	uint256
_token	address
_amount	uint256
_signatures	bytes

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

null

Source Code

function withdrawERC20(
  uint256 _withdrawalId,
  address _token,
  uint256 _amount,
  bytes memory _signatures
) public whenNotPaused {
  withdrawERC20For(_withdrawalId, msg.sender, _token, _amount, _signatures);
}

withdrawERC20For

Parameters

Name	Type
_withdrawalId	uint256
_user	address
_token	address
_amount	uint256
_signatures	bytes

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

onlyMappedToken checks for the following:

Requirements

null

Source Code

function withdrawERC20For(
  uint256 _withdrawalId,
  address _user,
  address _token,
  uint256 _amount,
  bytes memory _signatures
) public whenNotPaused onlyMappedToken(_token, 20) {
  bytes32 _hash = keccak256(
    abi.encodePacked("withdrawERC20", _withdrawalId, _user, _token, _amount)
  );

  require(verifySignatures(_hash, _signatures));

  if (_token == registry.getContract(registry.WETH_TOKEN())) {
    _withdrawETHFor(_user, _amount);
  } else {
    uint256 _gatewayBalance = IERC20(_token).balanceOf(address(this));

    if (_gatewayBalance < _amount) {
      require(
        IERC20Mintable(_token).mint(
          address(this),
          _amount.sub(_gatewayBalance)
        ),
        "MainchainGatewayManager: Minting ERC20 token to gateway failed"
      );
    }

    require(IERC20(_token).transfer(_user, _amount), "Transfer failed");
  }

  _insertWithdrawalEntry(_withdrawalId, _user, _token, _amount);
}

withdrawERC721

Parameters

Name	Type
_withdrawalId	uint256
_token	address
_tokenId	uint256
_signatures	bytes

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

Requirements

null

Source Code

function withdrawERC721(
  uint256 _withdrawalId,
  address _token,
  uint256 _tokenId,
  bytes memory _signatures
) public whenNotPaused {
  withdrawERC721For(_withdrawalId, msg.sender, _token, _tokenId, _signatures);
}

withdrawERC721For

Parameters

Name	Type
_withdrawalId	uint256
_user	address
_token	address
_tokenId	uint256
_signatures	bytes

Properties

Visibility public

Mutability transaction

Modifiers

whenNotPaused checks for the following:

paused must not be true

onlyMappedToken checks for the following:

Requirements

null

Source Code

function withdrawERC721For(
  uint256 _withdrawalId,
  address _user,
  address _token,
  uint256 _tokenId,
  bytes memory _signatures
) public whenNotPaused onlyMappedToken(_token, 721) {
  bytes32 _hash = keccak256(
    abi.encodePacked("withdrawERC721", _withdrawalId, _user, _token, _tokenId)
  );

  require(verifySignatures(_hash, _signatures));

  if (!_tryERC721TransferFrom(_token, address(this), _user, _tokenId)) {
    require(
      IERC721Mintable(_token).mint(_user, _tokenId),
      "MainchainGatewayManager: Minting ERC721 token to gateway failed"
    );
  }

  _insertWithdrawalEntry(_withdrawalId, _user, _token, _tokenId);
}

verifySignatures

Parameters

Name	Type
_hash	bytes32
_signatures	bytes

Properties

Visibility public

Mutability view

Source Code

function verifySignatures(bytes32 _hash, bytes memory _signatures)
  public
  view
  returns (bool)
{
  uint256 _signatureCount = _signatures.length.div(66);

  Validator _validator = Validator(registry.getContract(registry.VALIDATOR()));
  uint256 _validatorCount = 0;
  address _lastSigner = address(0);

  for (uint256 i = 0; i < _signatureCount; i++) {
    address _signer = _hash.recover(_signatures, i.mul(66));
    if (_validator.isValidator(_signer)) {
      _validatorCount++;
    }
    // Prevent duplication of signatures
    require(_signer > _lastSigner);
    _lastSigner = _signer;
  }

  return _validator.checkThreshold(_validatorCount);
}

Internal Functions Expand All Collapse All

Internal functions are parts of the contract that can't be used directly, but instead are used by the public functions listed above.

internal MainchainGatewayManager._createDepositEntry

Parameters

Name	Type
_owner	address
_token	address
_standard	uint32
_number	uint256

Properties

Visibility internal

Mutability transaction

Modifiers

onlyMappedToken checks for the following:

Requirements

_tokenStandard must be equal to 20

Source Code

function _createDepositEntry(
  address _owner,
  address _token,
  uint32 _standard,
  uint256 _number
) internal onlyMappedToken(_token, _standard) returns (uint256 _depositId) {
  (, address _sidechainToken, uint32 _tokenStandard) = registry.getMappedToken(
    _token,
    true
  );
  require(_standard == _tokenStandard);

  DepositEntry memory _entry = DepositEntry(
    _owner,
    _token,
    _sidechainToken,
    _standard,
    _number
  );

  deposits.push(_entry);
  _depositId = depositCount++;

  emit TokenDeposited(
    _depositId,
    _owner,
    _token,
    _sidechainToken,
    _standard,
    _number
  );
}

internal MainchainGatewayManager._insertWithdrawalEntry

Parameters

Name	Type
_withdrawalId	uint256
_owner	address
_token	address
_number	uint256

Properties

Visibility internal

Mutability transaction

Modifiers

onlyNewWithdrawal checks for the following:

_entry.tokenAddress must be equal to UNKNOWN VALUE

_entry.owner must be equal to UNKNOWN VALUE

Source Code

function _insertWithdrawalEntry(
  uint256 _withdrawalId,
  address _owner,
  address _token,
  uint256 _number
) internal onlyNewWithdrawal(_withdrawalId) {
  WithdrawalEntry memory _entry = WithdrawalEntry(_owner, _token, _number);

  withdrawals[_withdrawalId] = _entry;

  emit TokenWithdrew(_withdrawalId, _owner, _token, _number);
}

internal MainchainGatewayManager._withdrawETHFor

Parameters

Name	Type
_user	address
_amount	uint256

Properties

Visibility internal

Mutability transaction

Source Code

function _withdrawETHFor(address _user, uint256 _amount) internal {
  address _weth = registry.getContract(registry.WETH_TOKEN());
  WETH(_weth).withdraw(_amount);
  _user.toPayable().transfer(_amount);
}

internal MainchainGatewayManager._tryERC721TransferFrom

Parameters

Name	Type
_token	address
_from	address
_to	address
_tokenId	uint256

Properties

Visibility internal

Mutability transaction

Source Code

function _tryERC721TransferFrom(
  address _token,
  address _from,
  address _to,
  uint256 _tokenId
) internal returns (bool) {
  (bool success, ) = _token.call(
    abi.encodeWithSelector(
      IERC721(_token).transferFrom.selector,
      _from,
      _to,
      _tokenId
    )
  );
  return success;
}

internal HasAdmin.constructor

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability transaction

Source Code

constructor() internal {
  admin = msg.sender;
  emit AdminChanged(address(0), admin);
}

internal HasAdmin.constructor

Parameters

This function has no parameters.

Properties

Visibility internal

Mutability transaction

Source Code

constructor() internal {
  admin = msg.sender;
  emit AdminChanged(address(0), admin);
}

MainchainGatewayManager

About

Stats

Library Use

Events (6) keyboard_arrow_up

AdminChanged Event

Parameters help Event parameters list the data that an event contains.

AdminRemoved Event

Parameters help Event parameters list the data that an event contains.

Paused Event

Parameters help Event parameters list the data that an event contains.

TokenDeposited Event

Parameters help Event parameters list the data that an event contains.

TokenWithdrew Event

Parameters help Event parameters list the data that an event contains.

Unpaused Event

Parameters help Event parameters list the data that an event contains.

State Variables (7) keyboard_arrow_up

registry Variable

depositCount Variable

admin Variable

paused Variable

deposits Variable

withdrawals Variable

_proxyTo Variable

Functions Expand All Collapse All

changeAdmin keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

onlyAdmin checks for the following:

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

removeAdmin keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

onlyAdmin checks for the following:

Source Code

pause keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

onlyAdmin checks for the following:

whenNotPaused checks for the following:

Source Code

unpause keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

onlyAdmin checks for the following:

whenPaused checks for the following:

Source Code

updateRegistry keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

onlyAdmin checks for the following:

Source Code

constructor keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Source Code

depositEth keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

whenNotPaused checks for the following:

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

depositERC20 keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Modifiers help Modifiers are additions to a function that typically make various checks before the function is run.

whenNotPaused checks for the following:

Requirements help Requirements are checks that the function makes when it runs, and give you insight on what conditions are required for the function to succeed.

Source Code

depositERC721 keyboard_arrow_up

Parameters help Function parameters list what input the function expects from the user. Each parameter must be given a value.

Properties

Events (6)

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

State Variables (7)

changeAdmin

Parameters

Modifiers

Requirements

removeAdmin

Parameters

Modifiers

pause

Parameters

Modifiers

unpause

Parameters

Modifiers

updateRegistry

Parameters

Modifiers

constructor

Parameters

depositEth

Parameters

Modifiers

Requirements

depositERC20

Parameters

Modifiers

Requirements

depositERC721

Parameters

Modifiers

Requirements

depositEthFor

Parameters

Modifiers

Requirements

depositERC20For

Parameters

Modifiers

Requirements

depositERC721For

Parameters

Modifiers

Requirements

depositBulkFor

Parameters

Modifiers

Requirements

withdrawToken

Parameters

Modifiers

withdrawTokenFor

Parameters

Modifiers

withdrawERC20

Parameters

Modifiers

Requirements

withdrawERC20For

Parameters

Modifiers

Requirements

withdrawERC721

Parameters

Modifiers

Requirements

withdrawERC721For

Parameters