ImErc20Host
Title: ImErc20Host
Author: Merge Layers Inc.
Interface for host-side mERC20 cross-chain operations
Functions
mintOrBorrowMigration
Mints mTokens during migration without requiring underlying transfer
function mintOrBorrowMigration(bool mint, uint256 amount, address receiver, address borrower, uint256 minAmount)
external;
Parameters
| Name | Type | Description |
|---|---|---|
mint | bool | Mint or borrow |
amount | uint256 | The amount of underlying to be accounted for |
receiver | address | The address that will receive the mTokens or the underlying in case of borrowing |
borrower | address | The address that borrow is executed for |
minAmount | uint256 | The min amount of underlying to be accounted for |
extractForRebalancing
Extract amount to be used for rebalancing operation
function extractForRebalancing(uint256 amount) external;
Parameters
| Name | Type | Description |
|---|---|---|
amount | uint256 | The amount to rebalance |
updateAllowedCallerStatus
Set caller status for msg.sender
function updateAllowedCallerStatus(address caller, bool status) external;
Parameters
| Name | Type | Description |
|---|---|---|
caller | address | The caller address |
status | bool | The status to set for caller |
liquidateExternal
Mints tokens after external verification
function liquidateExternal(
bytes calldata journalData,
bytes calldata seal,
address[] calldata userToLiquidate,
uint256[] calldata liquidateAmount,
address[] calldata collateral,
address receiver
) external;
Parameters
| Name | Type | Description |
|---|---|---|
journalData | bytes | The journal data for minting (array of encoded journals) |
seal | bytes | The Zk proof seal |
userToLiquidate | address[] | Array of positions to liquidate |
liquidateAmount | uint256[] | Array of amounts to liquidate |
collateral | address[] | Array of collaterals to seize |
receiver | address | The collateral receiver |
mintExternal
Mints tokens after external verification
function mintExternal(
bytes calldata journalData,
bytes calldata seal,
uint256[] calldata mintAmount,
uint256[] calldata minAmountsOut,
address receiver
) external;
Parameters
| Name | Type | Description |
|---|---|---|
journalData | bytes | The journal data for minting (array of encoded journals) |
seal | bytes | The Zk proof seal |
mintAmount | uint256[] | Array of amounts to mint |
minAmountsOut | uint256[] | Array of min amounts accepted |
receiver | address | The tokens receiver |
repayExternal
Repays tokens after external verification
function repayExternal(
bytes calldata journalData,
bytes calldata seal,
uint256[] calldata repayAmount,
address receiver
) external;
Parameters
| Name | Type | Description |
|---|---|---|
journalData | bytes | The journal data for repayment (array of encoded journals) |
seal | bytes | The Zk proof seal |
repayAmount | uint256[] | Array of amounts to repay |
receiver | address | The position to repay for |
performExtensionCall
Initiates a withdraw operation
function performExtensionCall(uint256 actionType, uint256 amount, uint32 dstChainId) external payable;
Parameters
| Name | Type | Description |
|---|---|---|
actionType | uint256 | The actionType param (1 - withdraw, 2 - borrow) |
amount | uint256 | The amount to withdraw |
dstChainId | uint32 | The destination chain to recieve funds |
getProofData
Returns the proof data journal
function getProofData(address user, uint32 dstId) external view returns (uint256 dataRoot, uint256 journalHash);
Parameters
| Name | Type | Description |
|---|---|---|
user | address | The user address for the proof |
dstId | uint32 | The destination chain identifier |
Returns
| Name | Type | Description |
|---|---|---|
dataRoot | uint256 | The proof data root |
journalHash | uint256 | The proof journal hash |
Events
AllowedCallerUpdated
Emitted when a user updates allowed callers
event AllowedCallerUpdated(address indexed sender, address indexed caller, bool status);
Parameters
| Name | Type | Description |
|---|---|---|
sender | address | The caller updating permission |
caller | address | The address whose status is updated |
status | bool | Whether the caller is allowed |
mErc20Host_ChainStatusUpdated
Emitted when a chain id whitelist status is updated
event mErc20Host_ChainStatusUpdated(uint32 indexed chainId, bool status);
Parameters
| Name | Type | Description |
|---|---|---|
chainId | uint32 | The chain identifier |
status | bool | Whether the chain is whitelisted |
mErc20Host_LiquidateExternal
Emitted when a liquidate operation is executed
event mErc20Host_LiquidateExternal(
address indexed msgSender,
address indexed srcSender,
address userToLiquidate,
address receiver,
address indexed collateral,
uint32 srcChainId,
uint256 amount
);
Parameters
| Name | Type | Description |
|---|---|---|
msgSender | address | The caller on host chain |
srcSender | address | The caller on source chain |
userToLiquidate | address | The user being liquidated |
receiver | address | The receiver of seized collateral |
collateral | address | The collateral market |
srcChainId | uint32 | Source chain identifier |
amount | uint256 | The repay amount |
mErc20Host_MintExternal
Emitted when a mint operation is executed
event mErc20Host_MintExternal(
address indexed msgSender, address indexed srcSender, address indexed receiver, uint32 chainId, uint256 amount
);
Parameters
| Name | Type | Description |
|---|---|---|
msgSender | address | The caller on host chain |
srcSender | address | The caller on source chain |
receiver | address | The receiver of minted tokens |
chainId | uint32 | Source chain identifier |
amount | uint256 | The mint amount |
mErc20Host_BorrowExternal
Emitted when a borrow operation is executed
event mErc20Host_BorrowExternal(
address indexed msgSender, address indexed srcSender, uint32 indexed chainId, uint256 amount
);
Parameters
| Name | Type | Description |
|---|---|---|
msgSender | address | The caller on host chain |
srcSender | address | The caller on source chain |
chainId | uint32 | Source chain identifier |
amount | uint256 | The borrow amount |
mErc20Host_RepayExternal
Emitted when a repay operation is executed
event mErc20Host_RepayExternal(
address indexed msgSender, address indexed srcSender, address indexed position, uint32 chainId, uint256 amount
);
Parameters
| Name | Type | Description |
|---|---|---|
msgSender | address | The caller on host chain |
srcSender | address | The caller on source chain |
position | address | The position being repaid |
chainId | uint32 | Source chain identifier |
amount | uint256 | The repay amount |
mErc20Host_WithdrawExternal
Emitted when a withdrawal is executed
event mErc20Host_WithdrawExternal(
address indexed msgSender, address indexed srcSender, uint32 indexed chainId, uint256 amount
);
Parameters
| Name | Type | Description |
|---|---|---|
msgSender | address | The caller on host chain |
srcSender | address | The caller on source chain |
chainId | uint32 | Source chain identifier |
amount | uint256 | The withdrawal amount |
mErc20Host_BorrowOnExtensionChain
Emitted when a borrow operation is triggered for an extension chain
event mErc20Host_BorrowOnExtensionChain(address indexed sender, uint32 dstChainId, uint256 amount);
Parameters
| Name | Type | Description |
|---|---|---|
sender | address | The caller initiating the borrow |
dstChainId | uint32 | Destination chain identifier |
amount | uint256 | The borrow amount |
mErc20Host_WithdrawOnExtensionChain
Emitted when a withdraw operation is triggered for an extension chain
event mErc20Host_WithdrawOnExtensionChain(address indexed sender, uint32 dstChainId, uint256 amount);
Parameters
| Name | Type | Description |
|---|---|---|
sender | address | The caller initiating the withdrawal |
dstChainId | uint32 | Destination chain identifier |
amount | uint256 | The withdrawal amount |
mErc20Host_GasFeeUpdated
Emitted when gas fees are updated for a dst chain
event mErc20Host_GasFeeUpdated(uint32 indexed dstChainId, uint256 amount);
Parameters
| Name | Type | Description |
|---|---|---|
dstChainId | uint32 | Destination chain identifier |
amount | uint256 | The gas fee amount |
mErc20Host_MintMigration
Emitted when migration mint is performed
event mErc20Host_MintMigration(address indexed receiver, uint256 amount);
Parameters
| Name | Type | Description |
|---|---|---|
receiver | address | Receiver of the migrated tokens |
amount | uint256 | Amount minted |
mErc20Host_BorrowMigration
Emitted when migration borrow is performed
event mErc20Host_BorrowMigration(address indexed borrower, uint256 amount);
Parameters
| Name | Type | Description |
|---|---|---|
borrower | address | Borrower receiving funds |
amount | uint256 | Amount borrowed |
mErc20Host_MigratorUpdated
Emitted when migrator address is updated
event mErc20Host_MigratorUpdated(address indexed migrator);
Parameters
| Name | Type | Description |
|---|---|---|
migrator | address | The new migrator address |
mErc20Host_GasHelperUpdated
Emitted when gas helper address is updated
event mErc20Host_GasHelperUpdated(address indexed helper);
Parameters
| Name | Type | Description |
|---|---|---|
helper | address | The new gas helper address |
Errors
mErc20Host_ProofGenerationInputNotValid
Thrown when the chain id is not LINEA
error mErc20Host_ProofGenerationInputNotValid();
mErc20Host_DstChainNotValid
Thrown when the dst chain id is not current chain
error mErc20Host_DstChainNotValid();
mErc20Host_ChainNotValid
Thrown when the chain id is not LINEA
error mErc20Host_ChainNotValid();
mErc20Host_AddressNotValid
Thrown when the address is not valid
error mErc20Host_AddressNotValid();
mErc20Host_AmountTooBig
Thrown when the amount provided is bigger than the available amount`
error mErc20Host_AmountTooBig();
mErc20Host_AmountNotValid
Thrown when the amount specified is invalid (e.g., zero)
error mErc20Host_AmountNotValid();
mErc20Host_JournalNotValid
Thrown when the journal data provided is invalid or corrupted
error mErc20Host_JournalNotValid();
mErc20Host_CallerNotAllowed
Thrown when caller is not allowed
error mErc20Host_CallerNotAllowed();
mErc20Host_NotRebalancer
Thrown when caller is not rebalancer
error mErc20Host_NotRebalancer();
mErc20Host_LengthMismatch
Thrown when length of array is not valid
error mErc20Host_LengthMismatch();
mErc20Host_NotEnoughGasFee
Thrown when not enough gas fee was received
error mErc20Host_NotEnoughGasFee();
mErc20Host_L1InclusionRequired
Thrown when L1 inclusion is required
error mErc20Host_L1InclusionRequired();
mErc20Host_ActionNotAvailable
Thrown when extension action is not valid
error mErc20Host_ActionNotAvailable();