BridgeAdapter

Inherits: Initializable, ReentrancyGuard, MakinaContext, IBridgeAdapter

Constants

MAX_BPS

Full scale value in basis points

uint256 private constant MAX_BPS = 10_000;

approvalTarget

Address of the external bridge approval target contract.

address public immutable override approvalTarget;

Returns

Name	Type	Description
<none>	`address`

executionTarget

Address of the external bridge execution target contract.

address public immutable override executionTarget;

Returns

Name	Type	Description
<none>	`address`

receiveSource

Address of the external bridge contract responsible for sending output funds.

address public immutable override receiveSource;

Returns

Name	Type	Description
<none>	`address`

BridgeAdapterStorageLocation

bytes32 private constant BridgeAdapterStorageLocation =
        0xe24ea70efbf545f0256b406d064fa196624401f48d56c665b3e8bc995282c700;

Functions

_getBridgeAdapterStorage

function _getBridgeAdapterStorage() internal pure returns (BridgeAdapterStorage storage $);

Returns

Name	Type	Description
$	`BridgeAdapterStorage`

constructor

constructor(address _registry, address _approvalTarget, address _executionTarget, address _receiveSource)
        MakinaContext(_registry);

Parameters

Name	Type	Description
_registry	`address`
_approvalTarget	`address`
_executionTarget	`address`
_receiveSource	`address`

__BridgeAdapter_init

function __BridgeAdapter_init(address _controller, uint16 _bridgeId) internal onlyInitializing;

Parameters

Name	Type	Description
_controller	`address`
_bridgeId	`uint16`

onlyController

modifier onlyController();

controller

Address of the bridge controller contract.

function controller() external view override returns (address);

Returns

Name	Type	Description
<none>	`address`

bridgeId

ID of the adapted external bridge.

function bridgeId() external view override returns (uint16);

Returns

Name	Type	Description
<none>	`uint16`

nextOutTransferId

ID of the next outgoing transfer.

function nextOutTransferId() external view override returns (uint256);

Returns

Name	Type	Description
<none>	`uint256`

nextInTransferId

ID of the next incoming transfer.

function nextInTransferId() external view override returns (uint256);

Returns

Name	Type	Description
<none>	`uint256`

outBridgeTransferCancelDefault

Returns the default amount that must be transferred to the adapter to cancel an outgoing bridge transfer.

If the transfer has not yet been sent, or if the full amount was refunded to this contract by the external bridge, returns 0.
If the bridge retains a fee upon cancellation and only a partial refund was received, the returned value reflects that fee.
In all other cases (e.g. including pending refunds or successful bridge transfers), returns the full amount of the transfer.

function outBridgeTransferCancelDefault(uint256 transferId) external view override returns (uint256);

Parameters

Name	Type	Description
transferId	`uint256`	The ID of the transfer to check.

Returns

Name	Type	Description
<none>	`uint256`	The amount required to cancel the transfer.

scheduleOutBridgeTransfer

Schedules an outgoing bridge transfer and returns the message hash.

Emits an event containing the id of the transfer and the hash of the bridge transfer message.

function scheduleOutBridgeTransfer(
        uint256 destinationChainId,
        address recipient,
        address inputToken,
        uint256 inputAmount,
        address outputToken,
        uint256 minOutputAmount
    ) external override nonReentrant onlyController;

Parameters

Name	Type	Description
destinationChainId	`uint256`	The ID of the destination chain.
recipient	`address`	The address of the recipient on the destination chain.
inputToken	`address`	The address of the input token.
inputAmount	`uint256`	The amount of the input token to transfer.
outputToken	`address`	The address of the output token on the destination chain.
minOutputAmount	`uint256`	The minimum amount of the output token to receive.

authorizeInBridgeTransfer

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

function authorizeInBridgeTransfer(bytes32 messageHash) external override onlyController;

Parameters

Name	Type	Description
messageHash	`bytes32`	The hash of the message to authorize.

sendOutBridgeTransfer

Executes a scheduled outgoing bridge transfer.

function sendOutBridgeTransfer(uint256 transferId, bytes calldata data)
        external
        override
        nonReentrant
        onlyController;

Parameters

Name	Type	Description
transferId	`uint256`	The ID of the transfer to execute.
data	`bytes`	The optional data needed to execute the transfer.

cancelOutBridgeTransfer

Cancels an outgoing bridge transfer.

function cancelOutBridgeTransfer(uint256 transferId) external override nonReentrant onlyController;

Parameters

Name	Type	Description
transferId	`uint256`	The ID of the transfer to cancel.

claimInBridgeTransfer

Transfers a received bridge transfer out of the adapter.

function claimInBridgeTransfer(uint256 transferId) external override nonReentrant onlyController;

Parameters

Name	Type	Description
transferId	`uint256`	The ID of the transfer to claim.

withdrawPendingFunds

Resets internal state for a given token address, and transfers token balance to associated controller.

This function is intended to be used by the DAO to unlock funds stuck in the adapter, typically in response to operator deviations or external bridge discrepancies.

function withdrawPendingFunds(address token) external override nonReentrant onlyController;

Parameters

Name	Type	Description
token	`address`	The address of the token.

_receiveInBridgeTransfer

Updates contract state when receiving an incoming bridge transfer.

function _receiveInBridgeTransfer(bytes memory encodedMessage, address receivedToken, uint256 receivedAmount)
        internal
        virtual;

Parameters

Name	Type	Description
encodedMessage	`bytes`
receivedToken	`address`
receivedAmount	`uint256`

_getSet

Returns a reference to the current active set for this versioned set.

function _getSet(VersionedUintSet storage self) internal view returns (EnumerableSet.UintSet storage);

Parameters

Name	Type	Description
self	`VersionedUintSet`

Returns

Name	Type	Description
<none>	`EnumerableSet.UintSet`

_clearSet

Virtually clears the set by incrementing the version. All future operations will apply to a fresh, empty set. Previous versions remain in storage and are not deleted.

function _clearSet(VersionedUintSet storage self) internal;

Parameters

Name	Type	Description
self	`VersionedUintSet`

_checkOutBridgeTransferRouteIsSupported

Checks if an outgoing bridge transfer route is supported.

function _checkOutBridgeTransferRouteIsSupported(
        uint256 destinationChainId,
        address inputToken,
        uint256, /*inputAmount*/
        address outputToken
    ) internal view virtual;

Parameters

Name	Type	Description
destinationChainId	`uint256`
inputToken	`address`
_	`uint256`
outputToken	`address`

_getConfig

Returns the address of the config contract associated with this bridge adapter.

function _getConfig() internal view returns (address);

Returns

Name	Type	Description
<none>	`address`

_checkOutBridgeTransferIsCancellable

Checks if an outgoing bridge transfer is in a cancellable state.

function _checkOutBridgeTransferIsCancellable(uint256 transferId) internal virtual;

Parameters

Name	Type	Description
transferId	`uint256`

_sendOutBridgeTransfer

Handles logic specific to the external bridge protocol for sending out a bridge transfer.

function _sendOutBridgeTransfer(uint256 transferId, bytes calldata data) internal virtual;

Parameters

Name	Type	Description
transferId	`uint256`
data	`bytes`

_outBridgeTransferCancelDefault

Internal logic for outgoing bridge transfer cancellation default.

function _outBridgeTransferCancelDefault(uint256 transferId) internal view virtual returns (uint256);

Parameters

Name	Type	Description
transferId	`uint256`

Returns

Name	Type	Description
<none>	`uint256`

Structs

VersionedUintSet

EnumerableSet wrapper supporting efficient clearing by switching to a new version.

struct VersionedUintSet {
        mapping(uint256 => EnumerableSet.UintSet) _sets;
        uint256 _currentVersion;
    }

Properties

Name	Type	Description
_sets	`mapping(uint256 => EnumerableSet.UintSet)`
_currentVersion	`uint256`

BridgeAdapterStorage

Note:

storage-location: erc7201:makina.storage.BridgeAdapter

struct BridgeAdapterStorage {
        address _controller;
        uint16 _bridgeId;
        uint256 _nextOutTransferId;
        uint256 _nextInTransferId;
        mapping(uint256 outTransferId => OutBridgeTransfer transfer) _outgoingTransfers;
        mapping(uint256 inTransferId => InBridgeTransfer transfer) _incomingTransfers;
        mapping(address token => VersionedUintSet) _pendingOutTransferIds;
        mapping(address token => VersionedUintSet) _sentOutTransferIds;
        mapping(address token => VersionedUintSet) _pendingInTransferIds;
        mapping(bytes32 messageHash => bool isExpected) _expectedInMessages;
        mapping(address token => uint256 amount) _reservedBalances;
    }

Properties

Name	Type	Description
_controller	`address`
_bridgeId	`uint16`
_nextOutTransferId	`uint256`
_nextInTransferId	`uint256`
_outgoingTransfers	`mapping(uint256 outTransferId => OutBridgeTransfer transfer)`
_incomingTransfers	`mapping(uint256 inTransferId => InBridgeTransfer transfer)`
_pendingOutTransferIds	`mapping(address token => VersionedUintSet)`
_sentOutTransferIds	`mapping(address token => VersionedUintSet)`
_pendingInTransferIds	`mapping(address token => VersionedUintSet)`
_expectedInMessages	`mapping(bytes32 messageHash => bool isExpected)`
_reservedBalances	`mapping(address token => uint256 amount)`

Edit this page on GitHub