IRebalancer

Title: IRebalancer

Author: Merge Layers Inc.

Interface for rebalancer operations and configuration.

Functions

sendMsg

Sends a bridge message.

function sendMsg(address bridge, address _market, uint256 _amount, Msg calldata _msg) external payable;

Parameters

Name	Type	Description
`bridge`	`address`	The whitelisted bridge address.
`_market`	`address`	The market to rebalance from address.
`_amount`	`uint256`	The amount to rebalance.
`_msg`	`Msg`	The message data.

nonce

Returns current nonce.

function nonce() external view returns (uint256 currentNonce);

Returns

Name	Type	Description
`currentNonce`	`uint256`	Nonce value.

isBridgeWhitelisted

Returns if a bridge implementation is whitelisted.

function isBridgeWhitelisted(address bridge) external view returns (bool whitelisted);

Parameters

Name	Type	Description
`bridge`	`address`	Bridge address.

Returns

Name	Type	Description
`whitelisted`	`bool`	True if whitelisted.

isDestinationWhitelisted

Returns if a destination is whitelisted.

function isDestinationWhitelisted(uint32 dstId) external view returns (bool whitelisted);

Parameters

Name	Type	Description
`dstId`	`uint32`	Destination chain ID.

Returns

Name	Type	Description
`whitelisted`	`bool`	True if whitelisted.

isMarketWhitelisted

Returns if a market is whitelisted.

function isMarketWhitelisted(address market) external view returns (bool whitelisted);

Parameters

Name	Type	Description
`market`	`address`	Market address.

Returns

Name	Type	Description
`whitelisted`	`bool`	True if whitelisted.

Events

BridgeWhitelistedStatusUpdated

Emitted when bridge whitelist status changes.

event BridgeWhitelistedStatusUpdated(address indexed bridge, bool status);

Parameters

Name	Type	Description
`bridge`	`address`	Bridge address.
`status`	`bool`	Whitelist status.

MsgSent

Emitted when a message is sent through a bridge.

event MsgSent(
    address indexed bridge, uint32 indexed dstChainId, address indexed token, bytes message, bytes bridgeData
);

Parameters

Name	Type	Description
`bridge`	`address`	Bridge address.
`dstChainId`	`uint32`	Destination chain ID.
`token`	`address`	Token address.
`message`	`bytes`	Encoded message.
`bridgeData`	`bytes`	Bridge-specific data.

EthSaved

Emitted when ETH is saved back to treasury.

event EthSaved(uint256 amount);

Parameters

Name	Type	Description
`amount`	`uint256`	Amount saved.

MaxTransferSizeUpdated

Emitted when max transfer size is updated.

event MaxTransferSizeUpdated(uint32 indexed dstChainId, address indexed token, uint256 newLimit);

Parameters

Name	Type	Description
`dstChainId`	`uint32`	Destination chain ID.
`token`	`address`	Token address.
`newLimit`	`uint256`	New limit.

MinTransferSizeUpdated

Emitted when min transfer size is updated.

event MinTransferSizeUpdated(uint32 indexed dstChainId, address indexed token, uint256 newLimit);

Parameters

Name	Type	Description
`dstChainId`	`uint32`	Destination chain ID.
`token`	`address`	Token address.
`newLimit`	`uint256`	New limit.

DestinationWhitelistedStatusUpdated

Emitted when destination whitelist status changes.

event DestinationWhitelistedStatusUpdated(uint32 indexed dstChainId, bool status);

Parameters

Name	Type	Description
`dstChainId`	`uint32`	Destination chain ID.
`status`	`bool`	Whitelist status.

AllowedListUpdated

Emitted when allowed list is updated.

event AllowedListUpdated(address[] list, bool status);

Parameters

Name	Type	Description
`list`	`address[]`	List of addresses.
`status`	`bool`	Whitelist status.

TokensSaved

Emitted when tokens are rescued.

event TokensSaved(address indexed token, address indexed market, uint256 amount);

Parameters

Name	Type	Description
`token`	`address`	Token address.
`market`	`address`	Market address.
`amount`	`uint256`	Amount saved.

AllowedTokensUpdated

Emitted when allowed tokens list is updated for a bridge.

event AllowedTokensUpdated(address indexed bridge, bool status, address[] list);

Parameters

Name	Type	Description
`bridge`	`address`	Bridge address.
`status`	`bool`	Whitelist status.
`list`	`address[]`	Token list.

MarketListUpdated

Emitted when the market whitelist list is updated.

event MarketListUpdated(address[] list, bool status);

Parameters

Name	Type	Description
`list`	`address[]`	Market list.
`status`	`bool`	Whitelist status.

NewAdmin

Emitted when a new admin is set.

event NewAdmin(address indexed acc);

Parameters

Name	Type	Description
`acc`	`address`	New admin address.

SaveAddressUpdated

Emitted when the save address is updated.

event SaveAddressUpdated(address indexed save);

Parameters

Name	Type	Description
`save`	`address`	Save address.

Errors

Rebalancer_NotAuthorized

Error thrown when caller not authorized.

error Rebalancer_NotAuthorized();

Rebalancer_MarketNotValid

Error thrown when market is not valid.

error Rebalancer_MarketNotValid();

Rebalancer_RequestNotValid

Error thrown when request is not valid.

error Rebalancer_RequestNotValid();

Rebalancer_AddressNotValid

Error thrown when address is not valid.

error Rebalancer_AddressNotValid();

Rebalancer_BridgeNotWhitelisted

Error thrown when bridge is not whitelisted.

error Rebalancer_BridgeNotWhitelisted();

Rebalancer_TransferSizeExcedeed

Error thrown when transfer size exceeds maximum.

error Rebalancer_TransferSizeExcedeed();

Rebalancer_TransferSizeMinNotMet

Error thrown when transfer size below minimum.

error Rebalancer_TransferSizeMinNotMet();

Rebalancer_DestinationNotWhitelisted

Error thrown when destination not whitelisted.

error Rebalancer_DestinationNotWhitelisted();

Rebalancer_UnderlyingNotAllowedForBridge

Error thrown when underlying token not allowed for bridge.

error Rebalancer_UnderlyingNotAllowedForBridge();

Structs

Msg

struct Msg {
    uint32 dstChainId;
    address token;
    bytes message;
    bytes bridgeData;
}

Malda