Skip to content
LogoLogo

IBridgeController

Git Source

Functions

isBridgeSupported

Bridge ID => Is bridge adapter deployed.

function isBridgeSupported(uint16 bridgeId) external view returns (bool);

Parameters

NameTypeDescription
bridgeIduint16

Returns

NameTypeDescription
<none>bool

isOutTransferEnabled

Bridge ID => Is outgoing transfer enabled.

function isOutTransferEnabled(uint16 bridgeId) external view returns (bool);

Parameters

NameTypeDescription
bridgeIduint16

Returns

NameTypeDescription
<none>bool

getBridgeAdapter

Bridge ID => Address of the associated bridge adapter.

function getBridgeAdapter(uint16 bridgeId) external view returns (address);

Parameters

NameTypeDescription
bridgeIduint16

Returns

NameTypeDescription
<none>address

getMaxBridgeLossBps

Bridge ID => Max allowed value loss in basis points for transfers via this bridge.

function getMaxBridgeLossBps(uint16 bridgeId) external view returns (uint256);

Parameters

NameTypeDescription
bridgeIduint16

Returns

NameTypeDescription
<none>uint256

setBridgeAdapter

Sets a bridge adapter instance for a given bridge ID.

function setBridgeAdapter(uint16 bridgeId, address bridgeAdapter, uint256 initialMaxBridgeLossBps) external;

Parameters

NameTypeDescription
bridgeIduint16The ID of the bridge.
bridgeAdapteraddressThe address of the new bridge adapter instance.
initialMaxBridgeLossBpsuint256The initial maximum allowed value loss in basis points for transfers via this bridge.

setMaxBridgeLossBps

Sets the maximum allowed value loss in basis points for transfers via this bridge.

function setMaxBridgeLossBps(uint16 bridgeId, uint256 maxBridgeLossBps) external;

Parameters

NameTypeDescription
bridgeIduint16The ID of the bridge.
maxBridgeLossBpsuint256The maximum allowed value loss in basis points.

disableOutTransfer

Disables outgoing transfers for a bridge.

function disableOutTransfer(uint16 bridgeId) external;

Parameters

NameTypeDescription
bridgeIduint16The ID of the bridge.

enableOutTransfer

Enables outgoing transfers for a bridge.

function enableOutTransfer(uint16 bridgeId) external;

Parameters

NameTypeDescription
bridgeIduint16The ID of the bridge.

sendOutBridgeTransfer

Executes a scheduled outgoing bridge transfer.

function sendOutBridgeTransfer(uint16 bridgeId, uint256 transferId, bytes calldata data) external;

Parameters

NameTypeDescription
bridgeIduint16The ID of the bridge.
transferIduint256The ID of the transfer to execute.
databytesThe optional data needed to execute the transfer.

authorizeInBridgeTransfer

Registers a message hash as authorized for an incoming bridge transfer.

function authorizeInBridgeTransfer(uint16 bridgeId, bytes32 messageHash) external;

Parameters

NameTypeDescription
bridgeIduint16The ID of the bridge.
messageHashbytes32The hash of the message to authorize.

claimInBridgeTransfer

Transfers a received bridge transfer out of the corresponding bridge adapter.

function claimInBridgeTransfer(uint16 bridgeId, uint256 transferId) external;

Parameters

NameTypeDescription
bridgeIduint16The ID of the bridge.
transferIduint256The ID of the transfer to claim.

cancelOutBridgeTransfer

Cancels an outgoing bridge transfer.

function cancelOutBridgeTransfer(uint16 bridgeId, uint256 transferId) external;

Parameters

NameTypeDescription
bridgeIduint16The ID of the bridge.
transferIduint256The ID of the transfer to cancel.

resetBridgingState

Resets internal bridge counters for a given token, and withdraws token balances held by all bridge adapters.

This function is intended to be used by the DAO to realign bridge accounting state and maintain protocol consistency, typically in response to operator deviations, external bridge discrepancies, or unbounded counter growth.

function resetBridgingState(address token) external;

Parameters

NameTypeDescription
tokenaddressThe address of the token.

Events

BridgeAdapterSet

event BridgeAdapterSet(uint16 indexed bridgeId, address indexed adapter);

Parameters

NameTypeDescription
bridgeIduint16
adapteraddress

MaxBridgeLossBpsChanged

event MaxBridgeLossBpsChanged(
        uint16 indexed bridgeId, uint256 indexed oldMaxBridgeLossBps, uint256 indexed newMaxBridgeLossBps
    );

Parameters

NameTypeDescription
bridgeIduint16
oldMaxBridgeLossBpsuint256
newMaxBridgeLossBpsuint256

BridgingStateReset

event BridgingStateReset(address indexed token);

Parameters

NameTypeDescription
tokenaddress

OutTransferDisabled

event OutTransferDisabled(uint16 indexed bridgeId);

Parameters

NameTypeDescription
bridgeIduint16

OutTransferEnabled

event OutTransferEnabled(uint16 indexed bridgeId);

Parameters

NameTypeDescription
bridgeIduint16