mTokenGateway

Git Source

Inherits: OwnableUpgradeable, ImTokenGateway, ImTokenOperationTypes, HypernativeFirewallProtected

Title: mTokenGateway

Author: Merge Layers Inc.

Gateway contract for mToken operations

State Variables

LINEA_CHAIN_ID

Linea chain ID

uint32 private constant LINEA_CHAIN_ID = 59144

rolesOperator

Roles

IRoles public rolesOperator

blacklistOperator

Blacklist operator

IBlacklister public blacklistOperator

verifier

The ZkVerifier contract

IZkVerifier public verifier

paused

Mapping of operation types to pause status

mapping(OperationType operationType => bool paused) public paused

underlying

Returns the address of the underlying token

address public underlying

accAmountIn

Mapping of accumulated amounts in

mapping(address account => uint256 amount) public accAmountIn

accAmountOut

Mapping of accumulated amounts out

mapping(address account => uint256 amount) public accAmountOut

allowedCallers

Mapping of allowed callers

mapping(address caller => mapping(address target => bool allowed)) public allowedCallers

userWhitelisted

Mapping of whitelisted users

mapping(address user => bool whitelisted) public userWhitelisted

whitelistEnabled

Whether whitelist is enabled

bool public whitelistEnabled

gasFee

Gas fee required for supplyOnHost

uint256 public gasFee

__gap

uint256[50] private __gap

Functions

notPaused

Modifier to restrict access to only allowed users

modifier notPaused(OperationType _type) ;

Parameters

onlyAllowedUser

Modifier to restrict access to only allowed users

modifier onlyAllowedUser(address user) ;

Parameters

ifNotBlacklisted

Modifier to restrict access to only not blacklisted users

modifier ifNotBlacklisted(address user) ;

Parameters

liquidateChecks

Modifier to check liquidate conditions

modifier liquidateChecks() ;

constructor

Disables initializers on implementation

Note: oz-upgrades-unsafe-allow: constructor

constructor() ;

initialize

Initializes the gateway

function initialize(
    address payable _owner,
    address _underlying,
    address _roles,
    address _blacklister,
    address zkVerifier_
) external initializer;

Parameters

initFirewall

Initializes the firewall configuration

function initFirewall(address _firewall) external onlyOwner;

Parameters

setBlacklister

Sets the blacklister contract

function setBlacklister(address _blacklister) external onlyOwner;

Parameters

setWhitelistedUser

Sets user whitelist status

function setWhitelistedUser(address user, bool state) external onlyOwner;

Parameters

enableWhitelist

Enable user whitelist

function enableWhitelist() external onlyOwner;

disableWhitelist

Disable user whitelist

function disableWhitelist() external onlyOwner;

setPaused

function setPaused(OperationType _type, bool state) external override;

extractForRebalancing

Extract amount to be used for rebalancing operation

function extractForRebalancing(uint256 amount) external notPaused(OperationType.Rebalancing);

Parameters

setGasFee

Sets the gas fee

function setGasFee(uint256 amount) external onlyOwner;

Parameters

withdrawGasFees

Withdraw gas received so far

function withdrawGasFees(address payable receiver) external;

Parameters

updateZkVerifier

Updates IZkVerifier address

function updateZkVerifier(address _zkVerifier) external onlyOwner;

Parameters

updateAllowedCallerStatus

Set caller status for msg.sender

function updateAllowedCallerStatus(address caller, bool status) external override;

Parameters

supplyOnHost

Supply underlying to the contract

function supplyOnHost(uint256 amount, address receiver, bytes4 lineaSelector)
    external
    payable
    override
    notPaused(OperationType.AmountIn)
    onlyAllowedUser(msg.sender)
    ifNotBlacklisted(msg.sender)
    ifNotBlacklisted(receiver)
    onlyFirewallApproved;

Parameters

liquidate

Liquidate a user

function liquidate(address userToLiquidate, uint256 liquidateAmount, address collateral, address receiver)
    external
    payable
    override
    liquidateChecks
    ifNotBlacklisted(receiver);

Parameters

outHere

Extract tokens

function outHere(bytes calldata journalData, bytes calldata seal, uint256[] calldata amounts, address receiver)
    external
    notPaused(OperationType.AmountOutHere)
    ifNotBlacklisted(msg.sender)
    ifNotBlacklisted(receiver)
    onlyFirewallApproved;

Parameters

isPaused

function isPaused(OperationType _type) external view returns (bool);

getProofData

Returns the proof data journal

function getProofData(address user, uint32) external view returns (uint256, uint256);

Parameters

Returns

firewallRegister

Registers an account in the firewall

function firewallRegister(address _account) public override(HypernativeFirewallProtected);

Parameters

_takeIn

Handles inbound transfers and accounting

function _takeIn(address asset, uint256 amount, address receiver) private;

Parameters

_outHere

Processes an outgoing transfer based on journal data

function _outHere(bytes memory journalData, uint256 amount, address receiver) private;

Parameters

_verifyProof

Verifies proof data and inclusion constraints

function _verifyProof(bytes calldata journalData, bytes calldata seal) private view;

Parameters

_checkSender

Validates sender permissions for proof forwarding

function _checkSender(address msgSender, address srcSender) private view;

Parameters

_getSequencerRole

Returns sequencer role identifier

function _getSequencerRole() private view returns (bytes32);

Returns

_getBatchProofForwarderRole

Returns batch proof forwarder role identifier

function _getBatchProofForwarderRole() private view returns (bytes32);

Returns

_getProofForwarderRole

Returns proof forwarder role identifier

function _getProofForwarderRole() private view returns (bytes32);

Returns

_isAllowedFor

Checks if sender has a specific role

function _isAllowedFor(address _sender, bytes32 role) private view returns (bool);

Parameters

Returns