// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;import { ReentrancyGuard } from'@openzeppelin/contracts/security/ReentrancyGuard.sol';
import { IActionDataStructures } from'./interfaces/IActionDataStructures.sol';
import { IGateway } from'./crosschain/interfaces/IGateway.sol';
import { IGatewayClient } from'./crosschain/interfaces/IGatewayClient.sol';
import { IRegistry } from'./interfaces/IRegistry.sol';
import { ISettings } from'./interfaces/ISettings.sol';
import { ITokenMint } from'./interfaces/ITokenMint.sol';
import { IVariableBalanceRecords } from'./interfaces/IVariableBalanceRecords.sol';
import { IVault } from'./interfaces/IVault.sol';
import { BalanceManagement } from'./BalanceManagement.sol';
import { CallerGuard } from'./CallerGuard.sol';
import { Pausable } from'./Pausable.sol';
import { SystemVersionId } from'./SystemVersionId.sol';
import { TokenMintError, ZeroAddressError } from'./Errors.sol';
import'./helpers/AddressHelper.sol'asAddressHelper;
import'./helpers/DecimalsHelper.sol'asDecimalsHelper;
import'./helpers/GasReserveHelper.sol'asGasReserveHelper;
import'./helpers/RefundHelper.sol'asRefundHelper;
import'./helpers/TransferHelper.sol'asTransferHelper;
import'./Constants.sol'asConstants;
/**
* @title ActionExecutor
* @notice The main contract for cross-chain swaps
*/contractActionExecutorisSystemVersionId,
Pausable,
ReentrancyGuard,
CallerGuard,
BalanceManagement,
IGatewayClient,
ISettings,
IActionDataStructures{
/**
* @dev The contract for action settings
*/
IRegistry public registry;
/**
* @dev The contract for variable balance storage
*/
IVariableBalanceRecords public variableBalanceRecords;
uint256private lastActionId =block.chainid*1e7+555**2;
/**
* @notice Emitted when source chain action is performed
* @param actionId The ID of the action
* @param targetChainId The ID of the target chain
* @param sourceSender The address of the user on the source chain
* @param targetRecipient The address of the recipient on the target chain
* @param gatewayType The type of cross-chain gateway
* @param sourceToken The address of the input token on the source chain
* @param targetToken The address of the output token on the target chain
* @param amount The amount of the vault asset used for the action, with decimals set to 18
* @param fee The fee amount, measured in vault asset with decimals set to 18
* @param timestamp The timestamp of the action (in seconds)
*/eventActionSource(uint256indexed actionId,
uint256indexed targetChainId,
addressindexed sourceSender,
address targetRecipient,
uint256 gatewayType,
address sourceToken,
address targetToken,
uint256 amount,
uint256 fee,
uint256 timestamp
);
/**
* @notice Emitted when target chain action is performed
* @param actionId The ID of the action
* @param sourceChainId The ID of the source chain
* @param isSuccess The status of the action execution
* @param timestamp The timestamp of the action (in seconds)
*/eventActionTarget(uint256indexed actionId,
uint256indexed sourceChainId,
boolindexed isSuccess,
uint256 timestamp
);
/**
* @notice Emitted when single-chain action is performed
* @param actionId The ID of the action
* @param sender The address of the user
* @param recipient The address of the recipient
* @param fromToken The address of the input token
* @param toToken The address of the output token
* @param fromAmount The input token amount
* @param toAmount The output token amount
* @param toTokenFee The fee amount, measured in the output token
* @param timestamp The timestamp of the action (in seconds)
*/eventActionLocal(uint256indexed actionId,
addressindexed sender,
address recipient,
address fromToken,
address toToken,
uint256 fromAmount,
uint256 toAmount,
uint256 toTokenFee,
uint256 timestamp
);
/**
* @notice Emitted for source chain and single-chain actions when user's funds processing is completed
* @param actionId The ID of the action
* @param isLocal The action type flag, is true for single-chain actions
* @param sender The address of the user
* @param routerType The type of the swap router
* @param fromTokenAddress The address of the swap input token
* @param toTokenAddress The address of the swap output token
* @param fromAmount The input token amount
* @param resultAmount The swap result token amount
*/eventSourceProcessed(uint256indexed actionId,
boolindexed isLocal,
addressindexed sender,
uint256 routerType,
address fromTokenAddress,
address toTokenAddress,
uint256 fromAmount,
uint256 resultAmount
);
/**
* @notice Emitted for target chain actions when the user's funds processing is completed
* @param actionId The ID of the action
* @param recipient The address of the recipient
* @param routerType The type of the swap router
* @param fromTokenAddress The address of the swap input token
* @param toTokenAddress The address of the swap output token
* @param fromAmount The input token amount
* @param resultAmount The swap result token amount
*/eventTargetProcessed(uint256indexed actionId,
addressindexed recipient,
uint256 routerType,
address fromTokenAddress,
address toTokenAddress,
uint256 fromAmount,
uint256 resultAmount
);
/**
* @notice Emitted when the variable balance is allocated on the target chain
* @param actionId The ID of the action
* @param recipient The address of the variable balance recipient
* @param vaultType The type of the corresponding vault
* @param amount The allocated variable balance amount
*/eventVariableBalanceAllocated(uint256indexed actionId,
addressindexed recipient,
uint256 vaultType,
uint256 amount
);
/**
* @notice Emitted when the Registry contract address is updated
* @param registryAddress The address of the Registry contract
*/eventSetRegistry(addressindexed registryAddress);
/**
* @notice Emitted when the VariableBalanceRecords contract address is updated
* @param recordsAddress The address of the VariableBalanceRecords contract
*/eventSetVariableBalanceRecords(addressindexed recordsAddress);
/**
* @notice Emitted when the caller is not a registered cross-chain gateway
*/errorOnlyGatewayError();
/**
* @notice Emitted when the call is not from the current contract
*/errorOnlySelfError();
/**
* @notice Emitted when a cross-chain swap is attempted with the target chain ID matching the current chain
*/errorSameChainIdError();
/**
* @notice Emitted when a single-chain swap is attempted with the same token as input and output
*/errorSameTokenError();
/**
* @notice Emitted when the native token value of the transaction does not correspond to the swap amount
*/errorNativeTokenValueError();
/**
* @notice Emitted when the requested cross-chain gateway type is not set
*/errorGatewayNotSetError();
/**
* @notice Emitted when the requested swap router type is not set
*/errorRouterNotSetError();
/**
* @notice Emitted when the requested vault type is not set
*/errorVaultNotSetError();
/**
* @notice Emitted when the provided call value is not sufficient for the cross-chain message sending
*/errorMessageFeeError();
/**
* @notice Emitted when the swap amount is greater than the allowed maximum
*/errorSwapAmountMaxError();
/**
* @notice Emitted when the swap amount is less than the allowed minimum
*/errorSwapAmountMinError();
/**
* @notice Emitted when the swap process results in an error
*/errorSwapError();
/**
* @notice Emitted when there is no matching target swap info option
*/errorTargetSwapInfoError();
/**
* @dev Modifier to check if the caller is a registered cross-chain gateway
*/modifieronlyGateway() {
if (!registry.isGatewayAddress(msg.sender)) {
revert OnlyGatewayError();
}
_;
}
/**
* @dev Modifier to check if the caller is the current contract
*/modifieronlySelf() {
if (msg.sender!=address(this)) {
revert OnlySelfError();
}
_;
}
/**
* @notice Deploys the ActionExecutor contract
* @param _registry The address of the action settings registry contract
* @param _variableBalanceRecords The address of the variable balance records contract
* @param _actionIdOffset The initial offset of the action ID value
* @param _owner The address of the initial owner of the contract
* @param _managers The addresses of initial managers of the contract
* @param _addOwnerToManagers The flag to optionally add the owner to the list of managers
*/constructor(
IRegistry _registry,
IVariableBalanceRecords _variableBalanceRecords,
uint256 _actionIdOffset,
address _owner,
address[] memory _managers,
bool _addOwnerToManagers
) {
_setRegistry(_registry);
_setVariableBalanceRecords(_variableBalanceRecords);
lastActionId += _actionIdOffset;
_initRoles(_owner, _managers, _addOwnerToManagers);
}
/**
* @notice The standard "receive" function
* @dev Is payable to allow receiving native token funds from a target swap router
*/receive() externalpayable{}
/**
* @notice Sets the address of the action settings registry contract
* @param _registry The address of the action settings registry contract
*/functionsetRegistry(IRegistry _registry) externalonlyManager{
_setRegistry(_registry);
}
/**
* @notice Executes a single-chain action
* @param _localAction The parameters of the action
*/functionexecuteLocal(
LocalAction calldata _localAction
) externalpayablewhenNotPausednonReentrantcheckCallerreturns (uint256 actionId) {
if (_localAction.fromTokenAddress == _localAction.toTokenAddress) {
revert SameTokenError();
}
// For single-chain swaps of the native token,// the value of the transaction should be equal to the swap amountif (
_localAction.fromTokenAddress == Constants.NATIVE_TOKEN_ADDRESS &&msg.value!= _localAction.swapInfo.fromAmount
) {
revert NativeTokenValueError();
}
uint256 initialBalance =address(this).balance-msg.value;
lastActionId++;
actionId = lastActionId;
LocalSettings memory settings = registry.localSettings(
msg.sender,
_localAction.swapInfo.routerType
);
(uint256 processedAmount, ) = _processSource(
actionId,
true,
_localAction.fromTokenAddress,
_localAction.toTokenAddress,
_localAction.swapInfo,
settings.router,
settings.routerTransfer
);
address recipient = _localAction.recipient ==address(0)
? msg.sender
: _localAction.recipient;
uint256 recipientAmount = _calculateLocalAmount(
processedAmount,
true,
settings.systemFeeLocal,
settings.isWhitelist
);
if (_localAction.toTokenAddress == Constants.NATIVE_TOKEN_ADDRESS) {
TransferHelper.safeTransferNative(recipient, recipientAmount);
} else {
TransferHelper.safeTransfer(_localAction.toTokenAddress, recipient, recipientAmount);
}
// - - - System fee transfer - - -uint256 systemFeeAmount = processedAmount - recipientAmount;
if (systemFeeAmount >0) {
address feeCollector = settings.feeCollectorLocal;
if (feeCollector !=address(0)) {
if (_localAction.toTokenAddress == Constants.NATIVE_TOKEN_ADDRESS) {
TransferHelper.safeTransferNative(feeCollector, systemFeeAmount);
} else {
TransferHelper.safeTransfer(
_localAction.toTokenAddress,
feeCollector,
systemFeeAmount
);
}
} elseif (_localAction.toTokenAddress == Constants.NATIVE_TOKEN_ADDRESS) {
initialBalance += systemFeeAmount; // Keep at the contract address
}
}
// - - -// - - - Extra balance transfer - - -
RefundHelper.refundExtraBalance(address(this), initialBalance, payable(msg.sender));
// - - -emit ActionLocal(
actionId,
msg.sender,
recipient,
_localAction.fromTokenAddress,
_localAction.toTokenAddress,
_localAction.swapInfo.fromAmount,
recipientAmount,
systemFeeAmount,
block.timestamp
);
}
/**
* @notice Executes a cross-chain action
* @param _action The parameters of the action
*/functionexecute(
Action calldata _action
) externalpayablewhenNotPausednonReentrantcheckCallerreturns (uint256 actionId) {
if (_action.targetChainId ==block.chainid) {
revert SameChainIdError();
}
// For cross-chain swaps of the native token,// the value of the transaction should be greater or equal to the swap amountif (
_action.sourceTokenAddress == Constants.NATIVE_TOKEN_ADDRESS &&msg.value< _action.sourceSwapInfo.fromAmount
) {
revert NativeTokenValueError();
}
uint256 initialBalance =address(this).balance-msg.value;
lastActionId++;
actionId = lastActionId;
SourceSettings memory settings = registry.sourceSettings(
msg.sender,
_action.targetChainId,
_action.gatewayType,
_action.sourceSwapInfo.routerType,
_action.vaultType
);
if (settings.vault ==address(0)) {
revert VaultNotSetError();
}
address vaultAsset = IVault(settings.vault).asset();
(uint256 processedAmount, uint256 nativeTokenSpent) = _processSource(
actionId,
false,
_action.sourceTokenAddress,
vaultAsset,
_action.sourceSwapInfo,
settings.router,
settings.routerTransfer
);
uint256 targetVaultAmountMax = _calculateVaultAmount(
settings.sourceVaultDecimals,
settings.targetVaultDecimals,
processedAmount,
true,
settings.systemFee,
settings.isWhitelist
);
SwapInfo memory targetSwapInfo;
uint256 targetOptionsLength = _action.targetSwapInfoOptions.length;
if (targetOptionsLength ==0) {
targetSwapInfo = SwapInfo({
fromAmount: targetVaultAmountMax,
routerType: uint256(0),
routerData: newbytes(0)
});
} else {
for (uint256 index; index < targetOptionsLength; index++) {
SwapInfo memory targetSwapInfoOption = _action.targetSwapInfoOptions[index];
if (targetSwapInfoOption.fromAmount <= targetVaultAmountMax) {
targetSwapInfo = targetSwapInfoOption;
break;
}
}
if (targetSwapInfo.fromAmount ==0) {
revert TargetSwapInfoError();
}
}
uint256 sourceVaultAmount = DecimalsHelper.convertDecimals(
settings.targetVaultDecimals,
settings.sourceVaultDecimals,
targetSwapInfo.fromAmount
);
uint256 normalizedAmount = DecimalsHelper.convertDecimals(
settings.sourceVaultDecimals,
Constants.DECIMALS_DEFAULT,
sourceVaultAmount
);
if (!settings.isWhitelist) {
_checkSwapAmountLimits(
normalizedAmount,
settings.swapAmountMin,
settings.swapAmountMax
);
}
// - - - Transfer to vault - - -
TransferHelper.safeTransfer(vaultAsset, settings.vault, sourceVaultAmount);
// - - -bytesmemory targetMessageData =abi.encode(
TargetMessage({
actionId: actionId,
sourceSender: msg.sender,
vaultType: _action.vaultType,
targetTokenAddress: _action.targetTokenAddress,
targetSwapInfo: targetSwapInfo,
targetRecipient: _action.targetRecipient ==address(0)
? msg.sender
: _action.targetRecipient
})
);
_sendMessage(settings, _action, targetMessageData, msg.value- nativeTokenSpent);
// - - - System fee transfer - - -uint256 systemFeeAmount = processedAmount - sourceVaultAmount;
if (systemFeeAmount >0&& settings.feeCollector !=address(0)) {
TransferHelper.safeTransfer(vaultAsset, settings.feeCollector, systemFeeAmount);
}
// - - -// - - - Extra balance transfer - - -
RefundHelper.refundExtraBalance(address(this), initialBalance, payable(msg.sender));
// - - -
_emitActionSourceEvent(
actionId,
_action,
normalizedAmount,
DecimalsHelper.convertDecimals(
settings.sourceVaultDecimals,
Constants.DECIMALS_DEFAULT,
systemFeeAmount
)
);
}
/**
* @notice Variable token claim by user's variable balance
* @param _vaultType The type of the variable balance vault
*/functionclaimVariableToken(uint256 _vaultType
) externalwhenNotPausednonReentrantcheckCaller{
_processVariableBalanceRepayment(_vaultType, false);
}
/**
* @notice Vault asset claim by user's variable balance
* @param _vaultType The type of the variable balance vault
*/functionconvertVariableBalanceToVaultAsset(uint256 _vaultType
) externalwhenNotPausednonReentrantcheckCaller{
_processVariableBalanceRepayment(_vaultType, true);
}
/**
* @notice Cross-chain message fee estimation
* @param _gatewayType The type of the cross-chain gateway
* @param _targetChainId The ID of the target chain
* @param _targetRouterDataOptions The array of transaction data options for the target chain
* @param _gatewaySettings The settings specific to the selected cross-chain gateway
*/functionmessageFeeEstimate(uint256 _gatewayType,
uint256 _targetChainId,
bytes[] calldata _targetRouterDataOptions,
bytescalldata _gatewaySettings
) externalviewreturns (uint256) {
if (_targetChainId ==block.chainid) {
return0;
}
MessageFeeEstimateSettings memory settings = registry.messageFeeEstimateSettings(
_gatewayType
);
if (settings.gateway ==address(0)) {
revert GatewayNotSetError();
}
uint256 result =0;
if (_targetRouterDataOptions.length==0) {
result = IGateway(settings.gateway).messageFee(
_targetChainId,
_blankMessage(newbytes(0)),
_gatewaySettings
);
} else {
for (uint256 index; index < _targetRouterDataOptions.length; index++) {
bytesmemory messageData = _blankMessage(_targetRouterDataOptions[index]);
uint256 value = IGateway(settings.gateway).messageFee(
_targetChainId,
messageData,
_gatewaySettings
);
if (value > result) {
result = value;
}
}
}
return result;
}
/**
* @notice Swap result amount for single-chain actions, taking the system fee into account
* @param _fromAmount The amount before the calculation
* @param _isForward The direction of the calculation
*/functioncalculateLocalAmount(uint256 _fromAmount,
bool _isForward
) externalviewreturns (uint256 result) {
LocalAmountCalculationSettings memory settings = registry.localAmountCalculationSettings(
msg.sender
);
return
_calculateLocalAmount(
_fromAmount,
_isForward,
settings.systemFeeLocal,
settings.isWhitelist
);
}
/**
* @notice Swap result amount for cross-chain actions, taking the system fee into account
* @param _vaultType The type of the vault
* @param _fromChainId The ID of the source chain
* @param _toChainId The ID of the target chain
* @param _fromAmount The amount before the calculation
* @param _isForward The direction of the calculation
*/functioncalculateVaultAmount(uint256 _vaultType,
uint256 _fromChainId,
uint256 _toChainId,
uint256 _fromAmount,
bool _isForward
) externalviewreturns (uint256 result) {
VaultAmountCalculationSettings memory settings = registry.vaultAmountCalculationSettings(
msg.sender,
_vaultType,
_fromChainId,
_toChainId
);
return
_calculateVaultAmount(
settings.fromDecimals,
settings.toDecimals,
_fromAmount,
_isForward,
settings.systemFee,
settings.isWhitelist
);
}
/**
* @notice The variable balance of the account
* @param _account The address of the variable balance owner
* @param _vaultType The type of the vault
*/functionvariableBalance(address _account, uint256 _vaultType) externalviewreturns (uint256) {
return variableBalanceRecords.getAccountBalance(_account, _vaultType);
}
/**
* @notice Cross-chain message handler on the target chain
* @dev The function is called by cross-chain gateways
* @param _messageSourceChainId The ID of the message source chain
* @param _payloadData The content of the cross-chain message
*/functionhandleExecutionPayload(uint256 _messageSourceChainId,
bytescalldata _payloadData
) externalwhenNotPausedonlyGateway{
TargetMessage memory targetMessage =abi.decode(_payloadData, (TargetMessage));
TargetSettings memory settings = registry.targetSettings(
targetMessage.vaultType,
targetMessage.targetSwapInfo.routerType
);
bool selfCallSuccess;
(bool hasGasReserve, uint256 gasAllowed) = GasReserveHelper.checkGasReserve(
settings.gasReserve
);
if (hasGasReserve) {
trythis.selfCallTarget{ gas: gasAllowed }(settings, targetMessage) {
selfCallSuccess =true;
} catch {}
}
if (!selfCallSuccess) {
_targetAllocateVariableBalance(targetMessage);
}
emit ActionTarget(
targetMessage.actionId,
_messageSourceChainId,
selfCallSuccess,
block.timestamp
);
}
/**
* @notice Controllable processing of the target chain logic
* @dev Is called by the current contract to enable error handling
* @param _settings Target action settings
* @param _targetMessage The content of the cross-chain message
*/functionselfCallTarget(
TargetSettings calldata _settings,
TargetMessage calldata _targetMessage
) externalonlySelf{
if (_settings.vault ==address(0)) {
revert VaultNotSetError();
}
// - - - Transfer from vault - - -address assetAddress = IVault(_settings.vault).requestAsset(
_targetMessage.targetSwapInfo.fromAmount,
address(this),
false
);
// - - -
_processTarget(
_settings,
_targetMessage.actionId,
assetAddress,
_targetMessage.targetTokenAddress,
_targetMessage.targetSwapInfo,
_targetMessage.targetRecipient
);
}
function_processSource(uint256 _actionId,
bool _isLocal,
address _fromTokenAddress,
address _toTokenAddress,
SwapInfo memory _sourceSwapInfo,
address _routerAddress,
address _routerTransferAddress
) privatereturns (uint256 resultAmount, uint256 nativeTokenSpent) {
uint256 toTokenBalanceBefore = tokenBalance(_toTokenAddress);
if (_fromTokenAddress == Constants.NATIVE_TOKEN_ADDRESS) {
if (_routerAddress ==address(0)) {
revert RouterNotSetError();
}
// - - - Source swap (native token) - - -
(bool routerCallSuccess, ) =payable(_routerAddress).call{
value: _sourceSwapInfo.fromAmount
}(_sourceSwapInfo.routerData);
if (!routerCallSuccess) {
revert SwapError();
}
// - - -
nativeTokenSpent = _sourceSwapInfo.fromAmount;
} else {
TransferHelper.safeTransferFrom(
_fromTokenAddress,
msg.sender,
address(this),
_sourceSwapInfo.fromAmount
);
if (_fromTokenAddress != _toTokenAddress) {
if (_routerAddress ==address(0)) {
revert RouterNotSetError();
}
// - - - Source swap (non-native token) - - -
TransferHelper.safeApprove(
_fromTokenAddress,
_routerTransferAddress,
_sourceSwapInfo.fromAmount
);
(bool routerCallSuccess, ) = _routerAddress.call(_sourceSwapInfo.routerData);
if (!routerCallSuccess) {
revert SwapError();
}
TransferHelper.safeApprove(_fromTokenAddress, _routerTransferAddress, 0);
// - - -
}
nativeTokenSpent =0;
}
resultAmount = tokenBalance(_toTokenAddress) - toTokenBalanceBefore;
emit SourceProcessed(
_actionId,
_isLocal,
msg.sender,
_sourceSwapInfo.routerType,
_fromTokenAddress,
_toTokenAddress,
_sourceSwapInfo.fromAmount,
resultAmount
);
}
function_processTarget(
TargetSettings memory settings,
uint256 _actionId,
address _fromTokenAddress,
address _toTokenAddress,
SwapInfo memory _targetSwapInfo,
address _targetRecipient
) private{
uint256 resultAmount;
if (_toTokenAddress == _fromTokenAddress) {
resultAmount = _targetSwapInfo.fromAmount;
} else {
if (settings.router ==address(0)) {
revert RouterNotSetError();
}
uint256 toTokenBalanceBefore = tokenBalance(_toTokenAddress);
// - - - Target swap - - -
TransferHelper.safeApprove(
_fromTokenAddress,
settings.routerTransfer,
_targetSwapInfo.fromAmount
);
(bool success, ) = settings.router.call(_targetSwapInfo.routerData);
if (!success) {
revert SwapError();
}
TransferHelper.safeApprove(_fromTokenAddress, settings.routerTransfer, 0);
// - - -
resultAmount = tokenBalance(_toTokenAddress) - toTokenBalanceBefore;
}
if (_toTokenAddress == Constants.NATIVE_TOKEN_ADDRESS) {
TransferHelper.safeTransferNative(_targetRecipient, resultAmount);
} else {
TransferHelper.safeTransfer(_toTokenAddress, _targetRecipient, resultAmount);
}
emit TargetProcessed(
_actionId,
_targetRecipient,
_targetSwapInfo.routerType,
_fromTokenAddress,
_toTokenAddress,
_targetSwapInfo.fromAmount,
resultAmount
);
}
function_targetAllocateVariableBalance(TargetMessage memory _targetMessage) private{
address tokenRecipient = _targetMessage.targetRecipient;
uint256 vaultType = _targetMessage.vaultType;
uint256 tokenAmount = _targetMessage.targetSwapInfo.fromAmount;
variableBalanceRecords.increaseBalance(tokenRecipient, vaultType, tokenAmount);
emit VariableBalanceAllocated(
_targetMessage.actionId,
tokenRecipient,
vaultType,
tokenAmount
);
}
function_processVariableBalanceRepayment(uint256 _vaultType,
bool _convertToVaultAsset
) private{
VariableBalanceRepaymentSettings memory settings = registry
.variableBalanceRepaymentSettings(_vaultType);
if (settings.vault ==address(0)) {
revert VaultNotSetError();
}
uint256 tokenAmount = variableBalanceRecords.getAccountBalance(msg.sender, _vaultType);
variableBalanceRecords.clearBalance(msg.sender, _vaultType);
if (tokenAmount >0) {
if (_convertToVaultAsset) {
IVault(settings.vault).requestAsset(tokenAmount, msg.sender, true);
} else {
address variableTokenAddress = IVault(settings.vault).checkVariableTokenState();
bool mintSuccess = ITokenMint(variableTokenAddress).mint(msg.sender, tokenAmount);
if (!mintSuccess) {
revert TokenMintError();
}
}
}
}
function_setRegistry(IRegistry _registry) private{
AddressHelper.requireContract(address(_registry));
registry = _registry;
emit SetRegistry(address(_registry));
}
function_setVariableBalanceRecords(IVariableBalanceRecords _variableBalanceRecords) private{
AddressHelper.requireContract(address(_variableBalanceRecords));
variableBalanceRecords = _variableBalanceRecords;
emit SetVariableBalanceRecords(address(_variableBalanceRecords));
}
function_sendMessage(
SourceSettings memory settings,
Action calldata _action,
bytesmemory _messageData,
uint256 _availableValue
) private{
if (settings.gateway ==address(0)) {
revert GatewayNotSetError();
}
uint256 messageFee = IGateway(settings.gateway).messageFee(
_action.targetChainId,
_messageData,
_action.gatewaySettings
);
if (_availableValue < messageFee) {
revert MessageFeeError();
}
IGateway(settings.gateway).sendMessage{ value: messageFee }(
_action.targetChainId,
_messageData,
_action.gatewaySettings
);
}
function_emitActionSourceEvent(uint256 _actionId,
Action calldata _action,
uint256 _amount,
uint256 _fee
) private{
emit ActionSource(
_actionId,
_action.targetChainId,
msg.sender,
_action.targetRecipient,
_action.gatewayType,
_action.sourceTokenAddress,
_action.targetTokenAddress,
_amount,
_fee,
block.timestamp
);
}
function_checkSwapAmountLimits(uint256 _normalizedAmount,
uint256 _swapAmountMin,
uint256 _swapAmountMax
) privatepure{
if (_normalizedAmount < _swapAmountMin) {
revert SwapAmountMinError();
}
if (_normalizedAmount > _swapAmountMax) {
revert SwapAmountMaxError();
}
}
function_calculateLocalAmount(uint256 _fromAmount,
bool _isForward,
uint256 _systemFeeLocal,
bool _isWhitelist
) privatepurereturns (uint256 result) {
if (_isWhitelist || _systemFeeLocal ==0) {
return _fromAmount;
}
return
_isForward
? (_fromAmount * (Constants.MILLIPERCENT_FACTOR - _systemFeeLocal)) /
Constants.MILLIPERCENT_FACTOR
: (_fromAmount * Constants.MILLIPERCENT_FACTOR) /
(Constants.MILLIPERCENT_FACTOR - _systemFeeLocal);
}
function_calculateVaultAmount(uint256 _fromDecimals,
uint256 _toDecimals,
uint256 _fromAmount,
bool _isForward,
uint256 _systemFee,
bool _isWhitelist
) privatepurereturns (uint256 result) {
bool isZeroFee = _isWhitelist || _systemFee ==0;
uint256 amountToConvert = (!_isForward || isZeroFee)
? _fromAmount
: (_fromAmount * (Constants.MILLIPERCENT_FACTOR - _systemFee)) /
Constants.MILLIPERCENT_FACTOR;
uint256 convertedAmount = DecimalsHelper.convertDecimals(
_fromDecimals,
_toDecimals,
amountToConvert
);
result = (_isForward || isZeroFee)
? convertedAmount
: (convertedAmount * Constants.MILLIPERCENT_FACTOR) /
(Constants.MILLIPERCENT_FACTOR - _systemFee);
}
function_blankMessage(bytesmemory _targetRouterData) privatepurereturns (bytesmemory) {
bytesmemory messageData =abi.encode(
TargetMessage({
actionId: uint256(0),
sourceSender: address(0),
vaultType: uint256(0),
targetTokenAddress: address(0),
targetSwapInfo: SwapInfo({
fromAmount: uint256(0),
routerType: uint256(0),
routerData: _targetRouterData
}),
targetRecipient: address(0)
})
);
return messageData;
}
}
Contract Source Code
File 2 of 27: AddressHelper.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @notice Emitted when the account is not a contract
* @param account The account address
*/errorNonContractAddressError(address account);
/**
* @notice Function to check if the account is a contract
* @return The account contract status flag
*/functionisContract(address _account) viewreturns (bool) {
return _account.code.length>0;
}
/**
* @notice Function to require an account to be a contract
*/functionrequireContract(address _account) view{
if (!isContract(_account)) {
revert NonContractAddressError(_account);
}
}
/**
* @notice Function to require an account to be a contract or a zero address
*/functionrequireContractOrZeroAddress(address _account) view{
if (_account !=address(0)) {
requireContract(_account);
}
}
Contract Source Code
File 3 of 27: BalanceManagement.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;import { ITokenBalance } from'./interfaces/ITokenBalance.sol';
import { ManagerRole } from'./roles/ManagerRole.sol';
import'./helpers/TransferHelper.sol'asTransferHelper;
import'./Constants.sol'asConstants;
/**
* @title BalanceManagement
* @notice Base contract for the withdrawal of tokens, except for reserved ones
*/abstractcontractBalanceManagementisManagerRole{
/**
* @notice Emitted when the specified token is reserved
*/errorReservedTokenError();
/**
* @notice Performs the withdrawal of tokens, except for reserved ones
* @dev Use the "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE" address for the native token
* @param _tokenAddress The address of the token
* @param _tokenAmount The amount of the token
*/functioncleanup(address _tokenAddress, uint256 _tokenAmount) externalonlyManager{
if (isReservedToken(_tokenAddress)) {
revert ReservedTokenError();
}
if (_tokenAddress == Constants.NATIVE_TOKEN_ADDRESS) {
TransferHelper.safeTransferNative(msg.sender, _tokenAmount);
} else {
TransferHelper.safeTransfer(_tokenAddress, msg.sender, _tokenAmount);
}
}
/**
* @notice Getter of the token balance of the current contract
* @dev Use the "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE" address for the native token
* @param _tokenAddress The address of the token
* @return The token balance of the current contract
*/functiontokenBalance(address _tokenAddress) publicviewreturns (uint256) {
if (_tokenAddress == Constants.NATIVE_TOKEN_ADDRESS) {
returnaddress(this).balance;
} else {
return ITokenBalance(_tokenAddress).balanceOf(address(this));
}
}
/**
* @notice Getter of the reserved token flag
* @dev Override to add reserved token addresses
* @param _tokenAddress The address of the token
* @return The reserved token flag
*/functionisReservedToken(address _tokenAddress) publicviewvirtualreturns (bool) {
// The function returns false by default.// The explicit return statement is omitted to avoid the unused parameter warning.// See https://github.com/ethereum/solidity/issues/5295
}
}
Contract Source Code
File 4 of 27: CallerGuard.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;import { ManagerRole } from'./roles/ManagerRole.sol';
import'./helpers/AddressHelper.sol'asAddressHelper;
import'./Constants.sol'asConstants;
import'./DataStructures.sol'asDataStructures;
/**
* @title CallerGuard
* @notice Base contract to control access from other contracts
*/abstractcontractCallerGuardisManagerRole{
/**
* @dev Caller guard mode enumeration
*/enumCallerGuardMode {
ContractForbidden,
ContractList,
ContractAllowed
}
/**
* @dev Caller guard mode value
*/
CallerGuardMode public callerGuardMode = CallerGuardMode.ContractForbidden;
/**
* @dev Registered contract list for "ContractList" mode
*/address[] public listedCallerGuardContractList;
/**
* @dev Registered contract list indices for "ContractList" mode
*/mapping(address/*account*/=> DataStructures.OptionalValue /*index*/)
public listedCallerGuardContractIndexMap;
/**
* @notice Emitted when the caller guard mode is set
* @param callerGuardMode The caller guard mode
*/eventSetCallerGuardMode(CallerGuardMode indexed callerGuardMode);
/**
* @notice Emitted when a registered contract for "ContractList" mode is added or removed
* @param contractAddress The contract address
* @param isListed The registered contract list inclusion flag
*/eventSetListedCallerGuardContract(addressindexed contractAddress, boolindexed isListed);
/**
* @notice Emitted when the caller is not allowed to perform the intended action
*/errorCallerGuardError(address caller);
/**
* @dev Modifier to check if the caller is allowed to perform the intended action
*/modifiercheckCaller() {
if (msg.sender!=tx.origin) {
bool condition = (callerGuardMode == CallerGuardMode.ContractAllowed ||
(callerGuardMode == CallerGuardMode.ContractList &&
isListedCallerGuardContract(msg.sender)));
if (!condition) {
revert CallerGuardError(msg.sender);
}
}
_;
}
/**
* @notice Sets the caller guard mode
* @param _callerGuardMode The caller guard mode
*/functionsetCallerGuardMode(CallerGuardMode _callerGuardMode) externalonlyManager{
callerGuardMode = _callerGuardMode;
emit SetCallerGuardMode(_callerGuardMode);
}
/**
* @notice Updates the list of registered contracts for the "ContractList" mode
* @param _items The addresses and flags for the contracts
*/functionsetListedCallerGuardContracts(
DataStructures.AccountToFlag[] calldata _items
) externalonlyManager{
for (uint256 index; index < _items.length; index++) {
DataStructures.AccountToFlag calldata item = _items[index];
if (item.flag) {
AddressHelper.requireContract(item.account);
}
DataStructures.uniqueAddressListUpdate(
listedCallerGuardContractList,
listedCallerGuardContractIndexMap,
item.account,
item.flag,
Constants.LIST_SIZE_LIMIT_DEFAULT
);
emit SetListedCallerGuardContract(item.account, item.flag);
}
}
/**
* @notice Getter of the registered contract count
* @return The registered contract count
*/functionlistedCallerGuardContractCount() externalviewreturns (uint256) {
return listedCallerGuardContractList.length;
}
/**
* @notice Getter of the complete list of registered contracts
* @return The complete list of registered contracts
*/functionfullListedCallerGuardContractList() externalviewreturns (address[] memory) {
return listedCallerGuardContractList;
}
/**
* @notice Getter of a listed contract flag
* @param _account The contract address
* @return The listed contract flag
*/functionisListedCallerGuardContract(address _account) publicviewreturns (bool) {
return listedCallerGuardContractIndexMap[_account].isSet;
}
}
Contract Source Code
File 5 of 27: Constants.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @dev The default token decimals value
*/uint256constant DECIMALS_DEFAULT =18;
/**
* @dev The maximum uint256 value for swap amount limit settings
*/uint256constant INFINITY =type(uint256).max;
/**
* @dev The default limit of account list size
*/uint256constant LIST_SIZE_LIMIT_DEFAULT =100;
/**
* @dev The limit of swap router list size
*/uint256constant LIST_SIZE_LIMIT_ROUTERS =200;
/**
* @dev The factor for percentage settings. Example: 100 is 0.1%
*/uint256constant MILLIPERCENT_FACTOR =100_000;
/**
* @dev The de facto standard address to denote the native token
*/addressconstant NATIVE_TOKEN_ADDRESS =0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;
Contract Source Code
File 6 of 27: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)pragmasolidity ^0.8.0;/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Contract Source Code
File 7 of 27: DataStructures.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @notice Optional value structure
* @dev Is used in mappings to allow zero values
* @param isSet Value presence flag
* @param value Numeric value
*/structOptionalValue {
bool isSet;
uint256 value;
}
/**
* @notice Key-to-value structure
* @dev Is used as an array parameter item to perform multiple key-value settings
* @param key Numeric key
* @param value Numeric value
*/structKeyToValue {
uint256 key;
uint256 value;
}
/**
* @notice Key-to-value structure for address values
* @dev Is used as an array parameter item to perform multiple key-value settings with address values
* @param key Numeric key
* @param value Address value
*/structKeyToAddressValue {
uint256 key;
address value;
}
/**
* @notice Address-to-flag structure
* @dev Is used as an array parameter item to perform multiple settings
* @param account Account address
* @param flag Flag value
*/structAccountToFlag {
address account;
bool flag;
}
/**
* @notice Emitted when a list exceeds the size limit
*/errorListSizeLimitError();
/**
* @notice Sets or updates a value in a combined map (a mapping with a key list and key index mapping)
* @param _map The mapping reference
* @param _keyList The key list reference
* @param _keyIndexMap The key list index mapping reference
* @param _key The numeric key
* @param _value The address value
* @param _sizeLimit The map and list size limit
* @return isNewKey True if the key was just added, otherwise false
*/functioncombinedMapSet(mapping(uint256 => address) storage _map,
uint256[] storage _keyList,
mapping(uint256 => OptionalValue) storage _keyIndexMap,
uint256 _key,
address _value,
uint256 _sizeLimit
) returns (bool isNewKey) {
isNewKey =!_keyIndexMap[_key].isSet;
if (isNewKey) {
uniqueListAdd(_keyList, _keyIndexMap, _key, _sizeLimit);
}
_map[_key] = _value;
}
/**
* @notice Removes a value from a combined map (a mapping with a key list and key index mapping)
* @param _map The mapping reference
* @param _keyList The key list reference
* @param _keyIndexMap The key list index mapping reference
* @param _key The numeric key
* @return isChanged True if the combined map was changed, otherwise false
*/functioncombinedMapRemove(mapping(uint256 => address) storage _map,
uint256[] storage _keyList,
mapping(uint256 => OptionalValue) storage _keyIndexMap,
uint256 _key
) returns (bool isChanged) {
isChanged = _keyIndexMap[_key].isSet;
if (isChanged) {
delete _map[_key];
uniqueListRemove(_keyList, _keyIndexMap, _key);
}
}
/**
* @notice Adds a value to a unique value list (a list with value index mapping)
* @param _list The list reference
* @param _indexMap The value index mapping reference
* @param _value The numeric value
* @param _sizeLimit The list size limit
* @return isChanged True if the list was changed, otherwise false
*/functionuniqueListAdd(uint256[] storage _list,
mapping(uint256 => OptionalValue) storage _indexMap,
uint256 _value,
uint256 _sizeLimit
) returns (bool isChanged) {
isChanged =!_indexMap[_value].isSet;
if (isChanged) {
if (_list.length>= _sizeLimit) {
revert ListSizeLimitError();
}
_indexMap[_value] = OptionalValue(true, _list.length);
_list.push(_value);
}
}
/**
* @notice Removes a value from a unique value list (a list with value index mapping)
* @param _list The list reference
* @param _indexMap The value index mapping reference
* @param _value The numeric value
* @return isChanged True if the list was changed, otherwise false
*/functionuniqueListRemove(uint256[] storage _list,
mapping(uint256 => OptionalValue) storage _indexMap,
uint256 _value
) returns (bool isChanged) {
OptionalValue storage indexItem = _indexMap[_value];
isChanged = indexItem.isSet;
if (isChanged) {
uint256 itemIndex = indexItem.value;
uint256 lastIndex = _list.length-1;
if (itemIndex != lastIndex) {
uint256 lastValue = _list[lastIndex];
_list[itemIndex] = lastValue;
_indexMap[lastValue].value= itemIndex;
}
_list.pop();
delete _indexMap[_value];
}
}
/**
* @notice Adds a value to a unique address value list (a list with value index mapping)
* @param _list The list reference
* @param _indexMap The value index mapping reference
* @param _value The address value
* @param _sizeLimit The list size limit
* @return isChanged True if the list was changed, otherwise false
*/functionuniqueAddressListAdd(address[] storage _list,
mapping(address => OptionalValue) storage _indexMap,
address _value,
uint256 _sizeLimit
) returns (bool isChanged) {
isChanged =!_indexMap[_value].isSet;
if (isChanged) {
if (_list.length>= _sizeLimit) {
revert ListSizeLimitError();
}
_indexMap[_value] = OptionalValue(true, _list.length);
_list.push(_value);
}
}
/**
* @notice Removes a value from a unique address value list (a list with value index mapping)
* @param _list The list reference
* @param _indexMap The value index mapping reference
* @param _value The address value
* @return isChanged True if the list was changed, otherwise false
*/functionuniqueAddressListRemove(address[] storage _list,
mapping(address => OptionalValue) storage _indexMap,
address _value
) returns (bool isChanged) {
OptionalValue storage indexItem = _indexMap[_value];
isChanged = indexItem.isSet;
if (isChanged) {
uint256 itemIndex = indexItem.value;
uint256 lastIndex = _list.length-1;
if (itemIndex != lastIndex) {
address lastValue = _list[lastIndex];
_list[itemIndex] = lastValue;
_indexMap[lastValue].value= itemIndex;
}
_list.pop();
delete _indexMap[_value];
}
}
/**
* @notice Adds or removes a value to/from a unique address value list (a list with value index mapping)
* @dev The list size limit is checked on items adding only
* @param _list The list reference
* @param _indexMap The value index mapping reference
* @param _value The address value
* @param _flag The value inclusion flag
* @param _sizeLimit The list size limit
* @return isChanged True if the list was changed, otherwise false
*/functionuniqueAddressListUpdate(address[] storage _list,
mapping(address => OptionalValue) storage _indexMap,
address _value,
bool _flag,
uint256 _sizeLimit
) returns (bool isChanged) {
return
_flag
? uniqueAddressListAdd(_list, _indexMap, _value, _sizeLimit)
: uniqueAddressListRemove(_list, _indexMap, _value);
}
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @notice Emitted when an attempt to burn a token fails
*/errorTokenBurnError();
/**
* @notice Emitted when an attempt to mint a token fails
*/errorTokenMintError();
/**
* @notice Emitted when a zero address is specified where it is not allowed
*/errorZeroAddressError();
Contract Source Code
File 10 of 27: GasReserveHelper.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @notice Function to check if the available gas matches the specified gas reserve value
* @param _gasReserve Gas reserve value
* @return hasGasReserve Flag of gas reserve availability
* @return gasAllowed The remaining gas quantity taking the reserve into account
*/functioncheckGasReserve(uint256 _gasReserve
) viewreturns (bool hasGasReserve, uint256 gasAllowed) {
uint256 gasLeft =gasleft();
hasGasReserve = gasLeft >= _gasReserve;
gasAllowed = hasGasReserve ? gasLeft - _gasReserve : 0;
}
Contract Source Code
File 11 of 27: IActionDataStructures.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title IActionDataStructures
* @notice Action data structure declarations
*/interfaceIActionDataStructures{
/**
* @notice Single-chain action data structure
* @param fromTokenAddress The address of the input token
* @param toTokenAddress The address of the output token
* @param swapInfo The data for the single-chain swap
* @param recipient The address of the recipient
*/structLocalAction {
address fromTokenAddress;
address toTokenAddress;
SwapInfo swapInfo;
address recipient;
}
/**
* @notice Cross-chain action data structure
* @param gatewayType The numeric type of the cross-chain gateway
* @param vaultType The numeric type of the vault
* @param sourceTokenAddress The address of the input token on the source chain
* @param sourceSwapInfo The data for the source chain swap
* @param targetChainId The action target chain ID
* @param targetTokenAddress The address of the output token on the destination chain
* @param targetSwapInfoOptions The list of data options for the target chain swap
* @param targetRecipient The address of the recipient on the target chain
* @param gatewaySettings The gateway-specific settings data
*/structAction {
uint256 gatewayType;
uint256 vaultType;
address sourceTokenAddress;
SwapInfo sourceSwapInfo;
uint256 targetChainId;
address targetTokenAddress;
SwapInfo[] targetSwapInfoOptions;
address targetRecipient;
bytes gatewaySettings;
}
/**
* @notice Token swap data structure
* @param fromAmount The quantity of the token
* @param routerType The numeric type of the swap router
* @param routerData The data for the swap router call
*/structSwapInfo {
uint256 fromAmount;
uint256 routerType;
bytes routerData;
}
/**
* @notice Cross-chain message data structure
* @param actionId The unique identifier of the cross-chain action
* @param sourceSender The address of the sender on the source chain
* @param vaultType The numeric type of the vault
* @param targetTokenAddress The address of the output token on the target chain
* @param targetSwapInfo The data for the target chain swap
* @param targetRecipient The address of the recipient on the target chain
*/structTargetMessage {
uint256 actionId;
address sourceSender;
uint256 vaultType;
address targetTokenAddress;
SwapInfo targetSwapInfo;
address targetRecipient;
}
}
Contract Source Code
File 12 of 27: IGateway.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title IGateway
* @notice Cross-chain gateway interface
*/interfaceIGateway{
/**
* @notice Send a cross-chain message
* @param _targetChainId The message target chain ID
* @param _message The message content
* @param _settings The gateway-specific settings
*/functionsendMessage(uint256 _targetChainId,
bytescalldata _message,
bytescalldata _settings
) externalpayable;
/**
* @notice Cross-chain message fee estimation
* @param _targetChainId The ID of the target chain
* @param _message The message content
* @param _settings The gateway-specific settings
*/functionmessageFee(uint256 _targetChainId,
bytescalldata _message,
bytescalldata _settings
) externalviewreturns (uint256);
}
Contract Source Code
File 13 of 27: IGatewayClient.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title IGatewayClient
* @notice Cross-chain gateway client interface
*/interfaceIGatewayClient{
/**
* @notice Cross-chain message handler on the target chain
* @dev The function is called by cross-chain gateways
* @param _messageSourceChainId The ID of the message source chain
* @param _payloadData The content of the cross-chain message
*/functionhandleExecutionPayload(uint256 _messageSourceChainId,
bytescalldata _payloadData
) external;
/**
* @notice The standard "receive" function
*/receive() externalpayable;
}
Contract Source Code
File 14 of 27: IRegistry.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;import { ISettings } from'./ISettings.sol';
interfaceIRegistryisISettings{
/**
* @notice Getter of the registered gateway flag by the account address
* @param _account The account address
* @return The registered gateway flag
*/functionisGatewayAddress(address _account) externalviewreturns (bool);
/**
* @notice Settings for a single-chain swap
* @param _caller The user's account address
* @param _routerType The type of the swap router
* @return Settings for a single-chain swap
*/functionlocalSettings(address _caller,
uint256 _routerType
) externalviewreturns (LocalSettings memory);
/**
* @notice Getter of source chain settings for a cross-chain swap
* @param _caller The user's account address
* @param _targetChainId The target chain ID
* @param _gatewayType The type of the cross-chain gateway
* @param _routerType The type of the swap router
* @param _vaultType The type of the vault
* @return Source chain settings for a cross-chain swap
*/functionsourceSettings(address _caller,
uint256 _targetChainId,
uint256 _gatewayType,
uint256 _routerType,
uint256 _vaultType
) externalviewreturns (SourceSettings memory);
/**
* @notice Getter of target chain settings for a cross-chain swap
* @param _vaultType The type of the vault
* @param _routerType The type of the swap router
* @return Target chain settings for a cross-chain swap
*/functiontargetSettings(uint256 _vaultType,
uint256 _routerType
) externalviewreturns (TargetSettings memory);
/**
* @notice Getter of variable balance repayment settings
* @param _vaultType The type of the vault
* @return Variable balance repayment settings
*/functionvariableBalanceRepaymentSettings(uint256 _vaultType
) externalviewreturns (VariableBalanceRepaymentSettings memory);
/**
* @notice Getter of cross-chain message fee estimation settings
* @param _gatewayType The type of the cross-chain gateway
* @return Cross-chain message fee estimation settings
*/functionmessageFeeEstimateSettings(uint256 _gatewayType
) externalviewreturns (MessageFeeEstimateSettings memory);
/**
* @notice Getter of swap result calculation settings for a single-chain swap
* @param _caller The user's account address
* @return Swap result calculation settings for a single-chain swap
*/functionlocalAmountCalculationSettings(address _caller
) externalviewreturns (LocalAmountCalculationSettings memory);
/**
* @notice Getter of swap result calculation settings for a cross-chain swap
* @param _caller The user's account address
* @param _vaultType The type of the vault
* @param _fromChainId The ID of the swap source chain
* @param _toChainId The ID of the swap target chain
* @return Swap result calculation settings for a cross-chain swap
*/functionvaultAmountCalculationSettings(address _caller,
uint256 _vaultType,
uint256 _fromChainId,
uint256 _toChainId
) externalviewreturns (VaultAmountCalculationSettings memory);
/**
* @notice Getter of amount limits in USD for cross-chain swaps
* @param _vaultType The type of the vault
* @return min Minimum cross-chain swap amount in USD, with decimals = 18
* @return max Maximum cross-chain swap amount in USD, with decimals = 18
*/functionswapAmountLimits(uint256 _vaultType) externalviewreturns (uint256 min, uint256 max);
}
Contract Source Code
File 15 of 27: ISettings.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title ISettings
* @notice Settings data structure declarations
*/interfaceISettings{
/**
* @notice Settings for a single-chain swap
* @param router The swap router contract address
* @param routerTransfer The swap router transfer contract address
* @param systemFeeLocal The system fee value in milli-percent, e.g., 100 is 0.1%
* @param feeCollectorLocal The address of the single-chain action fee collector
* @param isWhitelist The whitelist flag
*/structLocalSettings {
address router;
address routerTransfer;
uint256 systemFeeLocal;
address feeCollectorLocal;
bool isWhitelist;
}
/**
* @notice Source chain settings for a cross-chain swap
* @param gateway The cross-chain gateway contract address
* @param router The swap router contract address
* @param routerTransfer The swap router transfer contract address
* @param vault The vault contract address
* @param sourceVaultDecimals The value of the vault decimals on the source chain
* @param targetVaultDecimals The value of the vault decimals on the target chain
* @param systemFee The system fee value in milli-percent, e.g., 100 is 0.1%
* @param feeCollector The address of the cross-chain action fee collector
* @param isWhitelist The whitelist flag
* @param swapAmountMin The minimum cross-chain swap amount in USD, with decimals = 18
* @param swapAmountMax The maximum cross-chain swap amount in USD, with decimals = 18
*/structSourceSettings {
address gateway;
address router;
address routerTransfer;
address vault;
uint256 sourceVaultDecimals;
uint256 targetVaultDecimals;
uint256 systemFee;
address feeCollector;
bool isWhitelist;
uint256 swapAmountMin;
uint256 swapAmountMax;
}
/**
* @notice Target chain settings for a cross-chain swap
* @param router The swap router contract address
* @param routerTransfer The swap router transfer contract address
* @param vault The vault contract address
* @param gasReserve The target chain gas reserve value
*/structTargetSettings {
address router;
address routerTransfer;
address vault;
uint256 gasReserve;
}
/**
* @notice Variable balance repayment settings
* @param vault The vault contract address
*/structVariableBalanceRepaymentSettings {
address vault;
}
/**
* @notice Cross-chain message fee estimation settings
* @param gateway The cross-chain gateway contract address
*/structMessageFeeEstimateSettings {
address gateway;
}
/**
* @notice Swap result calculation settings for a single-chain swap
* @param systemFee The system fee value in milli-percent, e.g., 100 is 0.1%
* @param isWhitelist The whitelist flag
*/structLocalAmountCalculationSettings {
uint256 systemFeeLocal;
bool isWhitelist;
}
/**
* @notice Swap result calculation settings for a cross-chain swap
* @param fromDecimals The value of the vault decimals on the source chain
* @param toDecimals The value of the vault decimals on the target chain
* @param systemFee The system fee value in milli-percent, e.g., 100 is 0.1%
* @param isWhitelist The whitelist flag
*/structVaultAmountCalculationSettings {
uint256 fromDecimals;
uint256 toDecimals;
uint256 systemFee;
bool isWhitelist;
}
}
Contract Source Code
File 16 of 27: ITokenBalance.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title ITokenBalance
* @notice Token balance interface
*/interfaceITokenBalance{
/**
* @notice Getter of the token balance by the account
* @param _account The account address
* @return Token balance
*/functionbalanceOf(address _account) externalviewreturns (uint256);
}
Contract Source Code
File 17 of 27: ITokenMint.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title ITokenMint
* @notice Token minting interface
*/interfaceITokenMint{
/**
* @notice Mints tokens to the account, increasing the total supply
* @param _to The token receiver account address
* @param _amount The number of tokens to mint
* @return Token burning success status
*/functionmint(address _to, uint256 _amount) externalreturns (bool);
}
Contract Source Code
File 18 of 27: IVariableBalanceRecords.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title IVariableBalanceRecords
* @notice Variable balance records interface
*/interfaceIVariableBalanceRecords{
/**
* @notice Increases the variable balance for the account
* @param _account The account address
* @param _vaultType The vault type
* @param _amount The amount by which to increase the variable balance
*/functionincreaseBalance(address _account, uint256 _vaultType, uint256 _amount) external;
/**
* @notice Clears the variable balance for the account
* @param _account The account address
* @param _vaultType The vault type
*/functionclearBalance(address _account, uint256 _vaultType) external;
/**
* @notice Getter of the variable balance by the account
* @param _account The account address
* @param _vaultType The vault type
*/functiongetAccountBalance(address _account,
uint256 _vaultType
) externalviewreturns (uint256);
}
Contract Source Code
File 19 of 27: IVault.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title IVault
* @notice Vault interface
*/interfaceIVault{
/**
* @notice The getter of the vault asset address
*/functionasset() externalviewreturns (address);
/**
* @notice Checks the status of the variable token and balance actions and the variable token address
* @return The address of the variable token
*/functioncheckVariableTokenState() externalviewreturns (address);
/**
* @notice Requests the vault asset tokens
* @param _amount The amount of the vault asset tokens
* @param _to The address of the vault asset tokens receiver
* @param _forVariableBalance True if the request is made for a variable balance repayment, otherwise false
* @return assetAddress The address of the vault asset token
*/functionrequestAsset(uint256 _amount,
address _to,
bool _forVariableBalance
) externalreturns (address assetAddress);
}
Contract Source Code
File 20 of 27: ManagerRole.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;import { Ownable } from'@openzeppelin/contracts/access/Ownable.sol';
import { RoleBearers } from'./RoleBearers.sol';
/**
* @title ManagerRole
* @notice Base contract that implements the Manager role.
* The manager role is a high-permission role for core team members only.
* Managers can set vaults and routers addresses, fees, cross-chain protocols,
* and other parameters for Interchain (cross-chain) swaps and single-network swaps.
* Please note, the manager role is unique for every contract,
* hence different addresses may be assigned as managers for different contracts.
*/abstractcontractManagerRoleisOwnable, RoleBearers{
bytes32privateconstant ROLE_KEY =keccak256('Manager');
/**
* @notice Emitted when the Manager role status for the account is updated
* @param account The account address
* @param value The Manager role status flag
*/eventSetManager(addressindexed account, boolindexed value);
/**
* @notice Emitted when the Manager role status for the account is renounced
* @param account The account address
*/eventRenounceManagerRole(addressindexed account);
/**
* @notice Emitted when the caller is not a Manager role bearer
*/errorOnlyManagerError();
/**
* @dev Modifier to check if the caller is a Manager role bearer
*/modifieronlyManager() {
if (!isManager(msg.sender)) {
revert OnlyManagerError();
}
_;
}
/**
* @notice Updates the Manager role status for the account
* @param _account The account address
* @param _value The Manager role status flag
*/functionsetManager(address _account, bool _value) publiconlyOwner{
_setRoleBearer(ROLE_KEY, _account, _value);
emit SetManager(_account, _value);
}
/**
* @notice Renounces the Manager role
*/functionrenounceManagerRole() externalonlyManager{
_setRoleBearer(ROLE_KEY, msg.sender, false);
emit RenounceManagerRole(msg.sender);
}
/**
* @notice Getter of the Manager role bearer count
* @return The Manager role bearer count
*/functionmanagerCount() externalviewreturns (uint256) {
return _roleBearerCount(ROLE_KEY);
}
/**
* @notice Getter of the complete list of the Manager role bearers
* @return The complete list of the Manager role bearers
*/functionfullManagerList() externalviewreturns (address[] memory) {
return _fullRoleBearerList(ROLE_KEY);
}
/**
* @notice Getter of the Manager role bearer status
* @param _account The account address
*/functionisManager(address _account) publicviewreturns (bool) {
return _isRoleBearer(ROLE_KEY, _account);
}
function_initRoles(address _owner,
address[] memory _managers,
bool _addOwnerToManagers
) internal{
address ownerAddress = _owner ==address(0) ? msg.sender : _owner;
for (uint256 index; index < _managers.length; index++) {
setManager(_managers[index], true);
}
if (_addOwnerToManagers &&!isManager(ownerAddress)) {
setManager(ownerAddress, true);
}
if (ownerAddress !=msg.sender) {
transferOwnership(ownerAddress);
}
}
}
Contract Source Code
File 21 of 27: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)pragmasolidity ^0.8.0;import"../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/abstractcontractOwnableisContext{
addressprivate _owner;
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/function_checkOwner() internalviewvirtual{
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
require(newOwner !=address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
Contract Source Code
File 22 of 27: Pausable.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;import { PausableasPausableBase } from'@openzeppelin/contracts/security/Pausable.sol';
import { ManagerRole } from'./roles/ManagerRole.sol';
/**
* @title Pausable
* @notice Base contract that implements the emergency pause mechanism
*/abstractcontractPausableisPausableBase, ManagerRole{
/**
* @notice Enter pause state
*/functionpause() externalonlyManagerwhenNotPaused{
_pause();
}
/**
* @notice Exit pause state
*/functionunpause() externalonlyManagerwhenPaused{
_unpause();
}
}
Contract Source Code
File 23 of 27: ReentrancyGuard.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol)pragmasolidity ^0.8.0;/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/abstractcontractReentrancyGuard{
// Booleans are more expensive than uint256 or any type that takes up a full// word because each write operation emits an extra SLOAD to first read the// slot's contents, replace the bits taken up by the boolean, and then write// back. This is the compiler's defense against contract upgrades and// pointer aliasing, and it cannot be disabled.// The values being non-zero value makes deployment a bit more expensive,// but in exchange the refund on every call to nonReentrant will be lower in// amount. Since refunds are capped to a percentage of the total// transaction's gas, it is best to keep them low in cases like this one, to// increase the likelihood of the full refund coming into effect.uint256privateconstant _NOT_ENTERED =1;
uint256privateconstant _ENTERED =2;
uint256private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/modifiernonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function_nonReentrantBefore() private{
// On the first call to nonReentrant, _status will be _NOT_ENTEREDrequire(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function_nonReentrantAfter() private{
// By storing the original value once again, a refund is triggered (see// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
Contract Source Code
File 24 of 27: RefundHelper.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;import'./TransferHelper.sol'asTransferHelper;
/**
* @notice Refunds the extra balance of the native token
* @dev Reverts on subtraction if the actual balance is less than expected
* @param _self The address of the executing contract
* @param _expectedBalance The expected native token balance value
* @param _to The refund receiver's address
*/functionrefundExtraBalance(address _self, uint256 _expectedBalance, addresspayable _to) {
uint256 extraBalance = _self.balance- _expectedBalance;
if (extraBalance >0) {
TransferHelper.safeTransferNative(_to, extraBalance);
}
}
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @title SystemVersionId
* @notice Base contract providing the system version identifier
*/abstractcontractSystemVersionId{
/**
* @dev The system version identifier
*/uint256publicconstant SYSTEM_VERSION_ID =uint256(keccak256('Initial'));
}
Contract Source Code
File 27 of 27: TransferHelper.sol
// SPDX-License-Identifier: AGPL-3.0-onlypragmasolidity 0.8.19;/**
* @notice Emitted when an approval action fails
*/errorSafeApproveError();
/**
* @notice Emitted when a transfer action fails
*/errorSafeTransferError();
/**
* @notice Emitted when a transferFrom action fails
*/errorSafeTransferFromError();
/**
* @notice Emitted when a transfer of the native token fails
*/errorSafeTransferNativeError();
/**
* @notice Safely approve the token to the account
* @param _token The token address
* @param _to The token approval recipient address
* @param _value The token approval amount
*/functionsafeApprove(address _token, address _to, uint256 _value) {
// 0x095ea7b3 is the selector for "approve(address,uint256)"
(bool success, bytesmemory data) = _token.call(
abi.encodeWithSelector(0x095ea7b3, _to, _value)
);
bool condition = success && (data.length==0||abi.decode(data, (bool)));
if (!condition) {
revert SafeApproveError();
}
}
/**
* @notice Safely transfer the token to the account
* @param _token The token address
* @param _to The token transfer recipient address
* @param _value The token transfer amount
*/functionsafeTransfer(address _token, address _to, uint256 _value) {
// 0xa9059cbb is the selector for "transfer(address,uint256)"
(bool success, bytesmemory data) = _token.call(
abi.encodeWithSelector(0xa9059cbb, _to, _value)
);
bool condition = success && (data.length==0||abi.decode(data, (bool)));
if (!condition) {
revert SafeTransferError();
}
}
/**
* @notice Safely transfer the token between the accounts
* @param _token The token address
* @param _from The token transfer source address
* @param _to The token transfer recipient address
* @param _value The token transfer amount
*/functionsafeTransferFrom(address _token, address _from, address _to, uint256 _value) {
// 0x23b872dd is the selector for "transferFrom(address,address,uint256)"
(bool success, bytesmemory data) = _token.call(
abi.encodeWithSelector(0x23b872dd, _from, _to, _value)
);
bool condition = success && (data.length==0||abi.decode(data, (bool)));
if (!condition) {
revert SafeTransferFromError();
}
}
/**
* @notice Safely transfer the native token to the account
* @param _to The native token transfer recipient address
* @param _value The native token transfer amount
*/functionsafeTransferNative(address _to, uint256 _value) {
(bool success, ) = _to.call{ value: _value }(newbytes(0));
if (!success) {
revert SafeTransferNativeError();
}
}