Transaction Hash:
Block:
22512169 at May-18-2025 08:10:47 PM +UTC
Transaction Fee:
0.000580845011773725 ETH
$1.23
Gas Used:
79,025 Gas / 7.350142509 Gwei
Emitted Events:
| 281 |
RangoDiamond.0xdf4363408b2d9811d1e5c23efdb5bae0b7a68bd9de2de1cbae18a11be3e67ef5( 0xdf4363408b2d9811d1e5c23efdb5bae0b7a68bd9de2de1cbae18a11be3e67ef5, 0000000000000000000000000000000000000000000000000000000000000000, 00000000000000000000000000000000000000000000000000033ba3e2bee000, 000000000000000000000000c84f14c250128357c82e1b737bf19e6efb1111bc )
|
| 282 |
RangoDiamond.0xf14fbd8b6e3ad3ae34babfa1f3b6a099f57643662f4cfc24eb335ae8718f534b( 0xf14fbd8b6e3ad3ae34babfa1f3b6a099f57643662f4cfc24eb335ae8718f534b, 0x000000000000000000000000c84f14c250128357c82e1b737bf19e6efb1111bc, 0x00000000000000000000000000000000000000000000000000000000000004ad, 0000000000000000000000000000000000000000000000000000000000000000, 0000000000000000000000000000000000000000000000000000000000000000, 0000000000000000000000000000000000000000000000000000000000000000, 00000000000000000000000000000000000000000000000000033ba3e2bee000 )
|
| 283 |
Vault.SwapNative( dstChain=5, dstAddress=0xAF4E419C5E7D128D5842C3408E8480892DA6DDC1B21F4F43FA21B904F71D1840, dstToken=9, amount=129090000000000000, sender=[Receiver] RangoDiamond, cfParameters=0x0096000000969F2F1EAE94D3D458C823B8441BA3E38B1DD4A3C8881A6476F31828A5E33B2D3C000000000000000000000000000000000000000000E0A3208A8748C830691A567B66A9B1D93B93ABA308AF9004C0C4A20569F30D07000000 )
|
| 284 |
RangoDiamond.0x012c155f3836c4edb9222305b909a109f9efa46288efffe40a0e66da3a9a9800( 0x012c155f3836c4edb9222305b909a109f9efa46288efffe40a0e66da3a9a9800, 0x000000000000000000000000000000008dba4fc410454a42a699b869b6a535b3, 0x0000000000000000000000000000000000000000000000000000000000000017, 0x00000000000000000000000000000000000000000000000000000000000004ad, 0000000000000000000000000000000000000000000000000000000000000000, 00000000000000000000000000000000000000000000000001ca9eabca0e2000, 000000000000000000000000af4e419c5e7d128d5842c3408e8480892da6ddc1, 0000000000000000000000000000000000000000000000000000000000000005, 0000000000000000000000000000000000000000000000000000000000000000, 0000000000000000000000000000000000000000000000000000000000000000, 00000000000000000000000000000000000000000000000000000000000000e0, 000000000000000000000000000000000000000000000000000000000000000b, 547275737457616c6c6574000000000000000000000000000000000000000000 )
|
Account State Difference:
| Address | Before | After | State Difference | ||
|---|---|---|---|---|---|
|
0x4838B106...B0BAD5f97
Miner
| (Titan Builder) | 14.885304358200548083 Eth | 14.885383383200548083 Eth | 0.000079025 | |
| 0x969f2F1e...38b1dd4A3 |
0.152316899834225388 Eth
Nonce: 286
|
0.021736054822451663 Eth
Nonce: 287
| 0.130580845011773725 | ||
| 0xc84f14C2...Efb1111bc | 29.09540725543875763 Eth | 29.09631725543875763 Eth | 0.00091 | ||
| 0xF5e10380...5b9f62Bcc | (Chainflip 1) | 596.605154319610388626 Eth | 596.734244319610388626 Eth | 0.12909 |
Execution Trace
ETH 0.13
RangoDiamond.9fe99b64( )
ETH 0.13
RangoChainFlipFacet.chainFlipBridge( request=[{name:dstChain, type:uint32, order:1, indexed:false, value:5, valueString:5}, {name:dstAddress, type:bytes, order:2, indexed:false, value:0xAF4E419C5E7D128D5842C3408E8480892DA6DDC1B21F4F43FA21B904F71D1840, valueString:0xAF4E419C5E7D128D5842C3408E8480892DA6DDC1B21F4F43FA21B904F71D1840}, {name:dstToken, type:uint32, order:3, indexed:false, value:9, valueString:9}, {name:message, type:bytes, order:4, indexed:false, value:0x, valueString:0x}, {name:gasAmount, type:uint256, order:5, indexed:false, value:0, valueString:0}, {name:cfParameters, type:bytes, order:6, indexed:false, value:0x0096000000969F2F1EAE94D3D458C823B8441BA3E38B1DD4A3C8881A6476F31828A5E33B2D3C000000000000000000000000000000000000000000E0A3208A8748C830691A567B66A9B1D93B93ABA308AF9004C0C4A20569F30D07000000, valueString:0x0096000000969F2F1EAE94D3D458C823B8441BA3E38B1DD4A3C8881A6476F31828A5E33B2D3C000000000000000000000000000000000000000000E0A3208A8748C830691A567B66A9B1D93B93ABA308AF9004C0C4A20569F30D07000000}], bridgeRequest=[{name:requestId, type:address, order:1, indexed:false, value:0x000000008Dba4Fc410454a42a699b869B6a535B3, valueString:0x000000008Dba4Fc410454a42a699b869B6a535B3}, {name:token, type:address, order:2, indexed:false, value:0x0000000000000000000000000000000000000000, valueString:0x0000000000000000000000000000000000000000}, {name:amount, type:uint256, order:3, indexed:false, value:129090000000000000, valueString:129090000000000000}, {name:platformFee, type:uint256, order:4, indexed:false, value:0, valueString:0}, {name:affiliateFee, type:uint256, order:5, indexed:false, value:910000000000000, valueString:910000000000000}, {name:affiliatorAddress, type:address, order:6, indexed:false, value:0xc84f14C250128357C82E1b737Bf19e6Efb1111bc, valueString:0xc84f14C250128357C82E1b737Bf19e6Efb1111bc}, {name:destinationExecutorFee, type:uint256, order:7, indexed:false, value:0, valueString:0}, {name:dAppTag, type:uint16, order:8, indexed:false, value:1197, valueString:1197}, {name:dAppName, type:string, order:9, indexed:false, value:TrustWallet, valueString:TrustWallet}] )- ETH 0.00091
0xc84f14c250128357c82e1b737bf19e6efb1111bc.CALL( ) - ETH 0.12909
Vault.xSwapNative( dstChain=5, dstAddress=0xAF4E419C5E7D128D5842C3408E8480892DA6DDC1B21F4F43FA21B904F71D1840, dstToken=9, cfParameters=0x0096000000969F2F1EAE94D3D458C823B8441BA3E38B1DD4A3C8881A6476F31828A5E33B2D3C000000000000000000000000000000000000000000E0A3208A8748C830691A567B66A9B1D93B93ABA308AF9004C0C4A20569F30D07000000 )
- ETH 0.00091
chainFlipBridge[RangoChainFlipFacet (ln:479)]
enforceNotPaused[RangoChainFlipFacet (ln:483)]getPausableStorage[LibPausable (ln:1097)]
sumFees[RangoChainFlipFacet (ln:485)]safeTransferFrom[RangoChainFlipFacet (ln:493)]_callOptionalReturn[SafeERC20 (ln:198)]functionCall[SafeERC20 (ln:243)]decode[SafeERC20 (ln:244)]SafeERC20FailedOperation[SafeERC20 (ln:245)]
encodeCall[SafeERC20 (ln:198)]
collectFees[RangoChainFlipFacet (ln:495)]getBaseSwapperStorage[LibSwapper (ln:1441)]_sendToken[LibSwapper (ln:1444)]_sendNative[LibSwapper (ln:1389)]safeTransfer[LibSwapper (ln:1389)]functionCall[SafeERC20 (ln:187)]encodeCall[SafeERC20 (ln:187)]decode[SafeERC20 (ln:188)]SafeERC20FailedOperation[SafeERC20 (ln:189)]
_sendToken[LibSwapper (ln:1449)]_sendNative[LibSwapper (ln:1389)]safeTransfer[LibSwapper (ln:1389)]functionCall[SafeERC20 (ln:187)]encodeCall[SafeERC20 (ln:187)]decode[SafeERC20 (ln:188)]SafeERC20FailedOperation[SafeERC20 (ln:189)]
FeeInfo[LibSwapper (ln:1452)]
doChainFlipBridge[RangoChainFlipFacet (ln:496)]getChainFlipStorage[RangoChainFlipFacet (ln:520)]xCallNative[RangoChainFlipFacet (ln:523)]approveMax[RangoChainFlipFacet (ln:532)]allowance[LibSwapper (ln:1383)]forceApprove[LibSwapper (ln:1385)]encodeCall[SafeERC20 (ln:227)]_callOptionalReturnBool[SafeERC20 (ln:228)]call[SafeERC20 (ln:260)]decode[SafeERC20 (ln:261)]
_callOptionalReturn[SafeERC20 (ln:229)]functionCall[SafeERC20 (ln:243)]decode[SafeERC20 (ln:244)]SafeERC20FailedOperation[SafeERC20 (ln:245)]
encodeCall[SafeERC20 (ln:229)]_callOptionalReturn[SafeERC20 (ln:230)]functionCall[SafeERC20 (ln:243)]decode[SafeERC20 (ln:244)]SafeERC20FailedOperation[SafeERC20 (ln:245)]
type[LibSwapper (ln:1385)]
xCallToken[RangoChainFlipFacet (ln:533)]xSwapNative[RangoChainFlipFacet (ln:546)]approveMax[RangoChainFlipFacet (ln:553)]allowance[LibSwapper (ln:1383)]forceApprove[LibSwapper (ln:1385)]encodeCall[SafeERC20 (ln:227)]_callOptionalReturnBool[SafeERC20 (ln:228)]call[SafeERC20 (ln:260)]decode[SafeERC20 (ln:261)]
_callOptionalReturn[SafeERC20 (ln:229)]functionCall[SafeERC20 (ln:243)]decode[SafeERC20 (ln:244)]SafeERC20FailedOperation[SafeERC20 (ln:245)]
encodeCall[SafeERC20 (ln:229)]_callOptionalReturn[SafeERC20 (ln:230)]functionCall[SafeERC20 (ln:243)]decode[SafeERC20 (ln:244)]SafeERC20FailedOperation[SafeERC20 (ln:245)]
type[LibSwapper (ln:1385)]
xSwapToken[RangoChainFlipFacet (ln:554)]
RangoBridgeInitiated[RangoChainFlipFacet (ln:498)]bytesToAddress[RangoChainFlipFacet (ln:502)]
File 1 of 3: RangoDiamond
File 2 of 3: Vault
File 3 of 3: RangoChainFlipFacet
// SPDX-License-Identifier: MIT
pragma solidity 0.8.16;
interface IDiamondCut {
enum FacetCutAction {
Add,
Replace,
Remove
}
// Add=0, Replace=1, Remove=2
struct FacetCut {
address facetAddress;
FacetCutAction action;
bytes4[] functionSelectors;
}
/// @notice Add/replace/remove any number of functions and optionally execute
/// a function with delegatecall
/// @param _diamondCut Contains the facet addresses and function selectors
/// @param _init The address of the contract or facet to execute _calldata
/// @param _calldata A function call, including function selector and arguments
/// _calldata is executed with delegatecall on _init
function diamondCut(
FacetCut[] calldata _diamondCut,
address _init,
bytes calldata _calldata
) external;
event DiamondCut(FacetCut[] _diamondCut, address _init, bytes _calldata);
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.16;
import { IDiamondCut } from "../interfaces/IDiamondCut.sol";
/// Implementation of EIP-2535 Diamond Standard
/// https://eips.ethereum.org/EIPS/eip-2535
library LibDiamond {
/// @dev keccak256("diamond.standard.diamond.storage");
bytes32 internal constant DIAMOND_STORAGE_POSITION = hex"c8fcad8db84d3cc18b4c41d551ea0ee66dd599cde068d998e57d5e09332c131c";
// Diamond specific errors
error IncorrectFacetCutAction();
error NoSelectorsInFacet();
error FunctionAlreadyExists();
error FacetAddressIsZero();
error FacetAddressIsNotZero();
error FacetContainsNoCode();
error FunctionDoesNotExist();
error FunctionIsImmutable();
error InitZeroButCalldataNotEmpty();
error CalldataEmptyButInitNotZero();
error InitReverted();
// ----------------
struct FacetAddressAndPosition {
address facetAddress;
uint96 functionSelectorPosition; // position in facetFunctionSelectors.functionSelectors array
}
struct FacetFunctionSelectors {
bytes4[] functionSelectors;
uint256 facetAddressPosition; // position of facetAddress in facetAddresses array
}
struct DiamondStorage {
// maps function selector to the facet address and
// the position of the selector in the facetFunctionSelectors.selectors array
mapping(bytes4 => FacetAddressAndPosition) selectorToFacetAndPosition;
// maps facet addresses to function selectors
mapping(address => FacetFunctionSelectors) facetFunctionSelectors;
// facet addresses
address[] facetAddresses;
// Used to query if a contract implements an interface.
// Used to implement ERC-165.
mapping(bytes4 => bool) supportedInterfaces;
// owner of the contract
address contractOwner;
}
function diamondStorage() internal pure returns (DiamondStorage storage ds) {
bytes32 position = DIAMOND_STORAGE_POSITION;
// solhint-disable-next-line no-inline-assembly
assembly {
ds.slot := position
}
}
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
function setContractOwner(address _newOwner) internal {
DiamondStorage storage ds = diamondStorage();
address previousOwner = ds.contractOwner;
ds.contractOwner = _newOwner;
emit OwnershipTransferred(previousOwner, _newOwner);
}
function contractOwner() internal view returns (address contractOwner_) {
contractOwner_ = diamondStorage().contractOwner;
}
function enforceIsContractOwner() internal view {
require(msg.sender == diamondStorage().contractOwner, "LibDiamond: Must be contract owner");
}
event DiamondCut(IDiamondCut.FacetCut[] _diamondCut, address _init, bytes _calldata);
// Internal function version of diamondCut
function diamondCut(
IDiamondCut.FacetCut[] memory _diamondCut,
address _init,
bytes memory _calldata
) internal {
for (uint256 facetIndex; facetIndex < _diamondCut.length; ) {
IDiamondCut.FacetCutAction action = _diamondCut[facetIndex].action;
if (action == IDiamondCut.FacetCutAction.Add) {
addFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} else if (action == IDiamondCut.FacetCutAction.Replace) {
replaceFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} else if (action == IDiamondCut.FacetCutAction.Remove) {
removeFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} else {
revert IncorrectFacetCutAction();
}
unchecked {
++facetIndex;
}
}
emit DiamondCut(_diamondCut, _init, _calldata);
initializeDiamondCut(_init, _calldata);
}
function addFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal {
if (_facetAddress == address(0)) {
revert FacetAddressIsZero();
}
if (_functionSelectors.length == 0) {
revert NoSelectorsInFacet();
}
DiamondStorage storage ds = diamondStorage();
uint96 selectorPosition = uint96(ds.facetFunctionSelectors[_facetAddress].functionSelectors.length);
// add new facet address if it does not exist
if (selectorPosition == 0) {
addFacet(ds, _facetAddress);
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
if (oldFacetAddress != address(0)) {
revert FunctionAlreadyExists();
}
addFunction(ds, selector, selectorPosition, _facetAddress);
unchecked {
++selectorPosition;
++selectorIndex;
}
}
}
function replaceFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal {
if (_functionSelectors.length == 0) {
revert NoSelectorsInFacet();
}
if (_facetAddress == address(0)) {
revert FacetAddressIsZero();
}
DiamondStorage storage ds = diamondStorage();
uint96 selectorPosition = uint96(ds.facetFunctionSelectors[_facetAddress].functionSelectors.length);
// add new facet address if it does not exist
if (selectorPosition == 0) {
addFacet(ds, _facetAddress);
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
if (oldFacetAddress == _facetAddress) {
revert FunctionAlreadyExists();
}
removeFunction(ds, oldFacetAddress, selector);
addFunction(ds, selector, selectorPosition, _facetAddress);
unchecked {
++selectorPosition;
++selectorIndex;
}
}
}
function removeFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal {
if (_functionSelectors.length == 0) {
revert NoSelectorsInFacet();
}
DiamondStorage storage ds = diamondStorage();
// if function does not exist then do nothing and return
if (_facetAddress != address(0)) {
revert FacetAddressIsNotZero();
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
removeFunction(ds, oldFacetAddress, selector);
unchecked {
++selectorIndex;
}
}
}
function addFacet(DiamondStorage storage ds, address _facetAddress) internal {
enforceHasContractCode(_facetAddress);
ds.facetFunctionSelectors[_facetAddress].facetAddressPosition = ds.facetAddresses.length;
ds.facetAddresses.push(_facetAddress);
}
function addFunction(
DiamondStorage storage ds,
bytes4 _selector,
uint96 _selectorPosition,
address _facetAddress
) internal {
ds.selectorToFacetAndPosition[_selector].functionSelectorPosition = _selectorPosition;
ds.facetFunctionSelectors[_facetAddress].functionSelectors.push(_selector);
ds.selectorToFacetAndPosition[_selector].facetAddress = _facetAddress;
}
function removeFunction(
DiamondStorage storage ds,
address _facetAddress,
bytes4 _selector
) internal {
if (_facetAddress == address(0)) {
revert FunctionDoesNotExist();
}
// an immutable function is a function defined directly in a diamond
if (_facetAddress == address(this)) {
revert FunctionIsImmutable();
}
// replace selector with last selector, then delete last selector
uint256 selectorPosition = ds.selectorToFacetAndPosition[_selector].functionSelectorPosition;
uint256 lastSelectorPosition = ds.facetFunctionSelectors[_facetAddress].functionSelectors.length - 1;
// if not the same then replace _selector with lastSelector
if (selectorPosition != lastSelectorPosition) {
bytes4 lastSelector = ds.facetFunctionSelectors[_facetAddress].functionSelectors[lastSelectorPosition];
ds.facetFunctionSelectors[_facetAddress].functionSelectors[selectorPosition] = lastSelector;
ds.selectorToFacetAndPosition[lastSelector].functionSelectorPosition = uint96(selectorPosition);
}
// delete the last selector
ds.facetFunctionSelectors[_facetAddress].functionSelectors.pop();
delete ds.selectorToFacetAndPosition[_selector];
// if no more selectors for facet address then delete the facet address
if (lastSelectorPosition == 0) {
// replace facet address with last facet address and delete last facet address
uint256 lastFacetAddressPosition = ds.facetAddresses.length - 1;
uint256 facetAddressPosition = ds.facetFunctionSelectors[_facetAddress].facetAddressPosition;
if (facetAddressPosition != lastFacetAddressPosition) {
address lastFacetAddress = ds.facetAddresses[lastFacetAddressPosition];
ds.facetAddresses[facetAddressPosition] = lastFacetAddress;
ds.facetFunctionSelectors[lastFacetAddress].facetAddressPosition = facetAddressPosition;
}
ds.facetAddresses.pop();
delete ds.facetFunctionSelectors[_facetAddress].facetAddressPosition;
}
}
function initializeDiamondCut(address _init, bytes memory _calldata) internal {
if (_init == address(0)) {
if (_calldata.length != 0) {
revert InitZeroButCalldataNotEmpty();
}
} else {
if (_calldata.length == 0) {
revert CalldataEmptyButInitNotZero();
}
if (_init != address(this)) {
enforceHasContractCode(_init);
}
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory error) = _init.delegatecall(_calldata);
if (!success) {
if (error.length > 0) {
// bubble up the error
revert(string(error));
} else {
revert InitReverted();
}
}
}
}
function enforceHasContractCode(address _contract) internal view {
uint256 contractSize;
// solhint-disable-next-line no-inline-assembly
assembly {
contractSize := extcodesize(_contract)
}
if (contractSize == 0) {
revert FacetContainsNoCode();
}
}
}
// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.16;
import { LibDiamond } from "../libraries/LibDiamond.sol";
import { IDiamondCut } from "../interfaces/IDiamondCut.sol";
contract RangoDiamond {
constructor(address _contractOwner, address _diamondCutFacet) payable {
LibDiamond.setContractOwner(_contractOwner);
// Add the diamondCut external function from the diamondCutFacet
IDiamondCut.FacetCut[] memory cut = new IDiamondCut.FacetCut[](1);
bytes4[] memory functionSelectors = new bytes4[](1);
functionSelectors[0] = IDiamondCut.diamondCut.selector;
cut[0] = IDiamondCut.FacetCut({
facetAddress: _diamondCutFacet,
action: IDiamondCut.FacetCutAction.Add,
functionSelectors: functionSelectors
});
LibDiamond.diamondCut(cut, address(0), "");
}
// Find facet for function that is called and execute the
// function if a facet is found and return any value.
// solhint-disable-next-line no-complex-fallback
fallback() external payable {
LibDiamond.DiamondStorage storage ds;
bytes32 position = LibDiamond.DIAMOND_STORAGE_POSITION;
// get diamond storage
// solhint-disable-next-line no-inline-assembly
assembly {
ds.slot := position
}
// get facet from function selector
address facet = ds.selectorToFacetAndPosition[msg.sig].facetAddress;
if (facet == address(0)) {
revert LibDiamond.FunctionDoesNotExist();
}
// Execute external function from facet using delegatecall and return any value.
// solhint-disable-next-line no-inline-assembly
assembly {
// copy function selector and any arguments
calldatacopy(0, 0, calldatasize())
// execute function call using the facet
let result := delegatecall(gas(), facet, 0, calldatasize(), 0, 0)
// get any return value
returndatacopy(0, 0, returndatasize())
// return any return value or error back to the caller
switch result
case 0 {
revert(0, returndatasize())
}
default {
return(0, returndatasize())
}
}
}
// Able to receive ether
// solhint-disable-next-line no-empty-blocks
receive() external payable {}
}File 2 of 3: Vault
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "SafeERC20.sol";
import "IVault.sol";
import "IKeyManager.sol";
import "ICFReceiver.sol";
import "Shared.sol";
import "Deposit.sol";
import "AggKeyNonceConsumer.sol";
import "GovernanceCommunityGuarded.sol";
/**
* @title Vault contract
* @notice The vault for holding and transferring native or ERC20 tokens and deploying contracts for
* fetching individual deposits. It also allows users to do cross-chain swaps and(or) calls by
* making a function call directly to this contract.
*/
contract Vault is IVault, AggKeyNonceConsumer, GovernanceCommunityGuarded {
using SafeERC20 for IERC20;
uint256 private constant _AGG_KEY_EMERGENCY_TIMEOUT = 3 days;
uint256 private constant _GAS_TO_FORWARD = 8_000;
uint256 private constant _FINALIZE_GAS_BUFFER = 30_000;
constructor(IKeyManager keyManager) AggKeyNonceConsumer(keyManager) {}
/// @dev Get the governor address from the KeyManager. This is called by the onlyGovernor
/// modifier in the GovernanceCommunityGuarded. This logic can't be moved to the
/// GovernanceCommunityGuarded since it requires a reference to the KeyManager.
function _getGovernor() internal view override returns (address) {
return getKeyManager().getGovernanceKey();
}
/// @dev Get the community key from the KeyManager. This is called by the isCommunityKey
/// modifier in the GovernanceCommunityGuarded. This logic can't be moved to the
/// GovernanceCommunityGuarded since it requires a reference to the KeyManager.
function _getCommunityKey() internal view override returns (address) {
return getKeyManager().getCommunityKey();
}
/// @dev Ensure that a new keyManager has the getGovernanceKey(), getCommunityKey()
/// and getLastValidateTime() are implemented. These are functions required for
/// this contract to at least be able to use the emergency mechanism.
function _checkUpdateKeyManager(IKeyManager keyManager, bool omitChecks) internal view override {
address newGovKey = keyManager.getGovernanceKey();
address newCommKey = keyManager.getCommunityKey();
uint256 lastValidateTime = keyManager.getLastValidateTime();
if (!omitChecks) {
// Ensure that the keys are the same
require(newGovKey == _getGovernor() && newCommKey == _getCommunityKey());
Key memory newAggKey = keyManager.getAggregateKey();
Key memory currentAggKey = getKeyManager().getAggregateKey();
require(
newAggKey.pubKeyX == currentAggKey.pubKeyX && newAggKey.pubKeyYParity == currentAggKey.pubKeyYParity
);
// Ensure that the last validate time is not in the future
require(lastValidateTime <= block.timestamp);
} else {
// Check that the addresses have been initialized
require(newGovKey != address(0) && newCommKey != address(0));
}
}
//////////////////////////////////////////////////////////////
// //
// Transfer and Fetch //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Can do a combination of all fcns in this contract. It first fetches all
* deposits , then it performs all transfers specified with the rest
* of the inputs, the same as transferBatch (where all inputs are again required
* to be of equal length - however the lengths of the fetch inputs do not have to
* be equal to lengths of the transfer inputs). Fetches/transfers of native tokens are
* indicated with 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE as the token address.
* @dev FetchAndDeploy is executed first to handle the edge case , which probably shouldn't
* happen anyway, where a deploy and a fetch for the same address are in the same batch.
* Transfers are executed last to ensure that all fetching has been completed first.
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param deployFetchParamsArray The array of deploy and fetch parameters
* @param fetchParamsArray The array of fetch parameters
* @param transferParamsArray The array of transfer parameters
*/
function allBatch(
SigData calldata sigData,
DeployFetchParams[] calldata deployFetchParamsArray,
FetchParams[] calldata fetchParamsArray,
TransferParams[] calldata transferParamsArray
)
external
override
onlyNotSuspended
consumesKeyNonce(
sigData,
keccak256(abi.encode(this.allBatch.selector, deployFetchParamsArray, fetchParamsArray, transferParamsArray))
)
{
// Fetch by deploying new deposits
_deployAndFetchBatch(deployFetchParamsArray);
// Fetch from already deployed deposits
_fetchBatch(fetchParamsArray);
// Send all transfers
_transferBatch(transferParamsArray);
}
/**
* @notice Same functionality as allBatch but removing the contract deployments
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param fetchParamsArray The array of fetch parameters
* @param transferParamsArray The array of transfer parameters
*/
function allBatchV2(
SigData calldata sigData,
FetchParams[] calldata fetchParamsArray,
TransferParams[] calldata transferParamsArray
)
external
override
onlyNotSuspended
consumesKeyNonce(
sigData,
keccak256(abi.encode(this.allBatchV2.selector, fetchParamsArray, transferParamsArray))
)
{
// Fetch from already deployed deposits
_fetchBatch(fetchParamsArray);
// Send all transfers
_transferBatch(transferParamsArray);
}
//////////////////////////////////////////////////////////////
// //
// Transfers //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Transfers native tokens or a ERC20 token from this vault to a recipient
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param transferParams The transfer parameters
*/
function transfer(
SigData calldata sigData,
TransferParams calldata transferParams
)
external
override
onlyNotSuspended
nzAddr(transferParams.token)
nzAddr(transferParams.recipient)
nzUint(transferParams.amount)
consumesKeyNonce(sigData, keccak256(abi.encode(this.transfer.selector, transferParams)))
{
_transfer(transferParams.token, transferParams.recipient, transferParams.amount);
}
/**
* @notice Fallback transfer tokens from this vault to a recipient with all the gas.
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param transferParams The transfer parameters
*/
function transferFallback(
SigData calldata sigData,
TransferParams calldata transferParams
)
external
onlyNotSuspended
nzAddr(transferParams.token)
nzAddr(transferParams.recipient)
nzUint(transferParams.amount)
consumesKeyNonce(sigData, keccak256(abi.encode(this.transferFallback.selector, transferParams)))
{
if (transferParams.token == _NATIVE_ADDR) {
(bool success, ) = transferParams.recipient.call{value: transferParams.amount}("");
require(success, "Vault: transfer fallback failed");
} else {
IERC20(transferParams.token).safeTransfer(transferParams.recipient, transferParams.amount);
}
}
/**
* @notice Transfers native tokens or ERC20 tokens from this vault to recipients.
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param transferParamsArray The array of transfer parameters.
*/
function transferBatch(
SigData calldata sigData,
TransferParams[] calldata transferParamsArray
)
external
override
onlyNotSuspended
consumesKeyNonce(sigData, keccak256(abi.encode(this.transferBatch.selector, transferParamsArray)))
{
_transferBatch(transferParamsArray);
}
/**
* @notice Transfers native tokens or ERC20 tokens from this vault to recipients.
* @param transferParamsArray The array of transfer parameters.
*/
function _transferBatch(TransferParams[] calldata transferParamsArray) private {
uint256 length = transferParamsArray.length;
for (uint256 i = 0; i < length; ) {
_transfer(transferParamsArray[i].token, transferParamsArray[i].recipient, transferParamsArray[i].amount);
unchecked {
++i;
}
}
}
/**
* @notice Transfers ETH or a token from this vault to a recipient
* @dev When transfering native tokens, using call function limiting the amount of gas so
* the receivers can't consume all the gas. Setting that amount of gas to more than
* 2300 to future-proof the contract in case of opcode gas costs changing.
* @dev When transferring ERC20 tokens, if it fails ensure the transfer fails gracefully
* to not revert an entire batch. e.g. usdc blacklisted recipient. Following safeTransfer
* approach to support tokens that don't return a bool.
* @param token The address of the token to be transferred
* @param recipient The address of the recipient of the transfer
* @param amount The amount to transfer, in wei (uint)
*/
function _transfer(address token, address payable recipient, uint256 amount) private {
if (address(token) == _NATIVE_ADDR) {
// solhint-disable-next-line avoid-low-level-calls
(bool success, ) = recipient.call{gas: _GAS_TO_FORWARD, value: amount}("");
if (!success) {
emit TransferNativeFailed(recipient, amount);
}
} else {
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = token.call(
abi.encodeWithSelector(IERC20(token).transfer.selector, recipient, amount)
);
// No need to check token.code.length since it comes from a gated call
bool transferred = success && (returndata.length == uint256(0) || abi.decode(returndata, (bool)));
if (!transferred) emit TransferTokenFailed(recipient, amount, token, returndata);
}
}
//////////////////////////////////////////////////////////////
// //
// Fetch Deposits //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Retrieves any token from multiple address, deterministically generated using
* create2, by creating a contract for that address, sending it to this vault.
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param deployFetchParamsArray The array of deploy and fetch parameters
*/
function deployAndFetchBatch(
SigData calldata sigData,
DeployFetchParams[] calldata deployFetchParamsArray
)
external
override
onlyNotSuspended
consumesKeyNonce(sigData, keccak256(abi.encode(this.deployAndFetchBatch.selector, deployFetchParamsArray)))
{
_deployAndFetchBatch(deployFetchParamsArray);
}
function _deployAndFetchBatch(DeployFetchParams[] calldata deployFetchParamsArray) private {
// Deploy deposit contracts
uint256 length = deployFetchParamsArray.length;
for (uint256 i = 0; i < length; ) {
new Deposit{salt: deployFetchParamsArray[i].swapID}(deployFetchParamsArray[i].token);
unchecked {
++i;
}
}
}
/**
* @notice Retrieves any token addresses where a Deposit contract is already deployed.
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param fetchParamsArray The array of fetch parameters
*/
function fetchBatch(
SigData calldata sigData,
FetchParams[] calldata fetchParamsArray
)
external
override
onlyNotSuspended
consumesKeyNonce(sigData, keccak256(abi.encode(this.fetchBatch.selector, fetchParamsArray)))
{
_fetchBatch(fetchParamsArray);
}
/**
* @notice Retrieves any token from multiple addresses where a Deposit contract is already deployed.
* It emits an event if the fetch fails.
* @param fetchParamsArray The array of fetch parameters
*/
function _fetchBatch(FetchParams[] calldata fetchParamsArray) private {
uint256 length = fetchParamsArray.length;
for (uint256 i = 0; i < length; ) {
Deposit(fetchParamsArray[i].fetchContract).fetch(fetchParamsArray[i].token);
unchecked {
++i;
}
}
}
//////////////////////////////////////////////////////////////
// //
// Initiate cross-chain swaps (source chain) //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Swaps native token for a token in another chain. The egress token will be transferred to the specified
* destination address on the destination chain.
* @dev Checking the validity of inputs shall be done as part of the event witnessing. Only the amount is checked
* to explicity indicate that an amount is required. It isn't preventing spamming.
* @param dstChain The destination chain according to the Chainflip Protocol's nomenclature.
* @param dstAddress Bytes containing the destination address on the destination chain.
* @param dstToken Destination token to be swapped to.
* @param cfParameters Additional parameters to be passed to the Chainflip protocol.
*/
function xSwapNative(
uint32 dstChain,
bytes memory dstAddress,
uint32 dstToken,
bytes calldata cfParameters
) external payable override onlyNotSuspended nzUint(msg.value) {
emit SwapNative(dstChain, dstAddress, dstToken, msg.value, msg.sender, cfParameters);
}
/**
* @notice Swaps ERC20 token for a token in another chain. The desired token will be transferred to the specified
* destination address on the destination chain. The provided ERC20 token must be supported by the Chainflip Protocol.
* @dev Checking the validity of inputs shall be done as part of the event witnessing. Only the amount is checked
* to explicity indicate that an amount is required.
* @param dstChain The destination chain according to the Chainflip Protocol's nomenclature.
* @param dstAddress Bytes containing the destination address on the destination chain.
* @param dstToken Uint containing the specifics of the swap to be performed according to Chainflip's nomenclature.
* @param srcToken Address of the source token to swap.
* @param amount Amount of tokens to swap.
* @param cfParameters Additional parameters to be passed to the Chainflip protocol.
*/
function xSwapToken(
uint32 dstChain,
bytes memory dstAddress,
uint32 dstToken,
IERC20 srcToken,
uint256 amount,
bytes calldata cfParameters
) external override onlyNotSuspended nzUint(amount) {
srcToken.safeTransferFrom(msg.sender, address(this), amount);
emit SwapToken(dstChain, dstAddress, dstToken, address(srcToken), amount, msg.sender, cfParameters);
}
//////////////////////////////////////////////////////////////
// //
// Initiate cross-chain call and swap (source chain) //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Performs a cross-chain call to the destination address on the destination chain. Native tokens must be paid
* to this contract. The swap intent determines if the provided tokens should be swapped to a different token
* and transferred as part of the cross-chain call. Otherwise, all tokens are used as a payment for gas on the destination chain.
* The message parameter is transmitted to the destination chain as part of the cross-chain call.
* @dev Checking the validity of inputs shall be done as part of the event witnessing. Only the amount is checked
* to explicity inidcate that an amount is required. It isn't preventing spamming.
* @param dstChain The destination chain according to the Chainflip Protocol's nomenclature.
* @param dstAddress Bytes containing the destination address on the destination chain.
* @param dstToken Uint containing the specifics of the swap to be performed, if any, as part of the xCall. The string
* must follow Chainflip's nomenclature. It can signal that no swap needs to take place
* and the source token will be used for gas in a swapless xCall.
* @param message General purpose message to be sent to the egress chain. Notice that the Chainflip protocol has a limit size
* for the message. Ensure that the message length is smaller that the limit before starting a swap.
* @param gasAmount The amount to be used for gas in the egress chain.
* @param cfParameters Additional parameters to be passed to the Chainflip protocol.
*/
function xCallNative(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
bytes calldata message,
uint256 gasAmount,
bytes calldata cfParameters
) external payable override onlyNotSuspended nzUint(msg.value) {
emit XCallNative(dstChain, dstAddress, dstToken, msg.value, msg.sender, message, gasAmount, cfParameters);
}
/**
* @notice Performs a cross-chain call to the destination chain and destination address. An ERC20 token amount
* needs to be approved to this contract. The ERC20 token must be supported by the Chainflip Protocol.
* The swap intent determines whether the provided tokens should be swapped to a different token
* by the Chainflip Protocol. If so, the swapped tokens will be transferred to the destination chain as part
* of the cross-chain call. Otherwise, the tokens are used as a payment for gas on the destination chain.
* The message parameter is transmitted to the destination chain as part of the cross-chain call.
* @dev Checking the validity of inputs shall be done as part of the event witnessing. Only the amount is checked
* to explicity indicate that an amount is required.
* @param dstChain The destination chain according to the Chainflip Protocol's nomenclature.
* @param dstAddress Bytes containing the destination address on the destination chain.
* @param dstToken Uint containing the specifics of the swap to be performed, if any, as part of the xCall. The string
* must follow Chainflip's nomenclature. It can signal that no swap needs to take place
* and the source token will be used for gas in a swapless xCall.
* @param message General purpose message to be sent to the egress chain. Notice that the Chainflip protocol has a limit size
* for the message. Ensure that the message length is smaller that the limit before starting a swap.
* @param gasAmount The amount to be used for gas in the egress chain.
* @param srcToken Address of the source token.
* @param amount Amount of tokens to swap.
* @param cfParameters Additional parameters to be passed to the Chainflip protocol.
*/
function xCallToken(
uint32 dstChain,
bytes memory dstAddress,
uint32 dstToken,
bytes calldata message,
uint256 gasAmount,
IERC20 srcToken,
uint256 amount,
bytes calldata cfParameters
) external override onlyNotSuspended nzUint(amount) {
srcToken.safeTransferFrom(msg.sender, address(this), amount);
emit XCallToken(
dstChain,
dstAddress,
dstToken,
address(srcToken),
amount,
msg.sender,
message,
gasAmount,
cfParameters
);
}
//////////////////////////////////////////////////////////////
// //
// Gas topups //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Add gas (topup) to an existing cross-chain call with the unique identifier swapID.
* Native tokens must be paid to this contract as part of the call.
* @param swapID The unique identifier for this swap (bytes32)
*/
function addGasNative(bytes32 swapID) external payable override onlyNotSuspended nzUint(msg.value) {
emit AddGasNative(swapID, msg.value);
}
/**
* @notice Add gas (topup) to an existing cross-chain call with the unique identifier swapID.
* A Chainflip supported token must be paid to this contract as part of the call.
* @param swapID The unique identifier for this swap (bytes32)
* @param token Address of the token to provide.
* @param amount Amount of tokens to provide.
*/
function addGasToken(
bytes32 swapID,
uint256 amount,
IERC20 token
) external override onlyNotSuspended nzUint(amount) {
token.safeTransferFrom(msg.sender, address(this), amount);
emit AddGasToken(swapID, amount, address(token));
}
//////////////////////////////////////////////////////////////
// //
// Execute cross-chain call and swap (dest. chain) //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Transfers native tokens or an ERC20 token from this vault to a recipient and makes a function
* call completing a cross-chain swap and call. The ICFReceiver interface is expected on
* the receiver's address. A message is passed to the receiver along with other
* parameters specifying the origin of the swap.
* @dev Not checking nzUint(amount) to prevent reversions in edge cases (e.g. all input amount used for gas).
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param transferParams The transfer parameters
* @param srcChain The source chain where the call originated from.
* @param srcAddress The address where the transfer originated within the ingress chain.
* @param message The message to be passed to the recipient.
*/
function executexSwapAndCall(
SigData calldata sigData,
TransferParams calldata transferParams,
uint32 srcChain,
bytes calldata srcAddress,
bytes calldata message
)
external
override
onlyNotSuspended
nzAddr(transferParams.token)
nzAddr(transferParams.recipient)
consumesKeyNonce(
sigData,
keccak256(abi.encode(this.executexSwapAndCall.selector, transferParams, srcChain, srcAddress, message))
)
{
// Logic in another internal function to avoid the stackTooDeep error
_executexSwapAndCall(transferParams, srcChain, srcAddress, message);
}
/**
* @notice Logic for transferring the tokens and calling the recipient. It's on the receiver to
* make sure the call doesn't revert, otherwise the tokens won't be transferred.
* The _transfer function is not used because we want to be able to embed the native token
* into the cfReceive call to avoid doing two external calls.
* In case of revertion the tokens will remain in the Vault. Therefore, the destination
* contract must ensure it doesn't revert e.g. using try-catch mechanisms.
* @dev In the case of the ERC20 transfer reverting, not handling the error to allow for tx replay.
* Also, to ensure the cfReceive call is made only if the transfer is successful.
*/
function _executexSwapAndCall(
TransferParams calldata transferParams,
uint32 srcChain,
bytes calldata srcAddress,
bytes calldata message
) private {
uint256 nativeAmount;
if (transferParams.amount > 0) {
if (transferParams.token == _NATIVE_ADDR) {
nativeAmount = transferParams.amount;
} else {
IERC20(transferParams.token).safeTransfer(transferParams.recipient, transferParams.amount);
}
}
ICFReceiver(transferParams.recipient).cfReceive{value: nativeAmount}(
srcChain,
srcAddress,
message,
transferParams.token,
transferParams.amount
);
}
//////////////////////////////////////////////////////////////
// //
// Execute cross-chain call (dest. chain) //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Executes a cross-chain function call. The ICFReceiver interface is expected on
* the receiver's address. A message is passed to the receiver along with other
* parameters specifying the origin of the swap. This is used for cross-chain messaging
* without any swap taking place on the Chainflip Protocol.
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param srcChain The source chain where the call originated from.
* @param srcAddress The address where the transfer originated from in the ingressParams.
* @param message The message to be passed to the recipient.
*/
function executexCall(
SigData calldata sigData,
address recipient,
uint32 srcChain,
bytes calldata srcAddress,
bytes calldata message
)
external
override
onlyNotSuspended
nzAddr(recipient)
consumesKeyNonce(
sigData,
keccak256(abi.encode(this.executexCall.selector, recipient, srcChain, srcAddress, message))
)
{
ICFReceiver(recipient).cfReceivexCall(srcChain, srcAddress, message);
}
//////////////////////////////////////////////////////////////
// //
// Auxiliary chain actions //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Transfer funds and pass calldata to be executed on a Multicall contract.
* @dev For safety purposes it's preferred to execute calldata externally with
* a limited amount of funds instead of executing arbitrary calldata here.
* @dev Calls are not reverted upon Multicall.run() failure so the nonce gets consumed. The
* gasMulticall parameters is needed to prevent an insufficient gas griefing attack.
* The _GAS_BUFFER is a conservative estimation of the gas required to finalize the call.
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param transferParams The transfer parameters inluding the token and amount to be transferred
* and the multicall contract address.
* @param calls Array of actions to be executed.
* @param gasMulticall Gas that must be forwarded to the multicall.
*/
function executeActions(
SigData calldata sigData,
TransferParams calldata transferParams,
IMulticall.Call[] calldata calls,
uint256 gasMulticall
)
external
override
onlyNotSuspended
consumesKeyNonce(
sigData,
keccak256(abi.encode(this.executeActions.selector, transferParams, calls, gasMulticall))
)
{
// Fund and run multicall
uint256 valueToSend;
if (transferParams.amount > 0) {
if (transferParams.token == _NATIVE_ADDR) {
valueToSend = transferParams.amount;
} else {
IERC20(transferParams.token).approve(transferParams.recipient, transferParams.amount);
}
}
// Ensure that the amount of gas supplied to the call to the Multicall contract is at least the gas
// limit specified. We can do this by enforcing that we still have gasMulticall + gas buffer available.
// The gas buffer is to ensure there is enough gas to finalize the call, including a safety margin.
// The 63/64 rule specified in EIP-150 needs to be taken into account.
require(gasleft() >= ((gasMulticall + _FINALIZE_GAS_BUFFER) * 64) / 63, "Vault: insufficient gas");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory reason) = transferParams.recipient.call{
gas: gasleft() - _FINALIZE_GAS_BUFFER,
value: valueToSend
}(abi.encodeWithSelector(IMulticall.run.selector, calls, transferParams.token, transferParams.amount));
if (!success) {
if (transferParams.amount > 0 && transferParams.token != _NATIVE_ADDR) {
IERC20(transferParams.token).approve(transferParams.recipient, 0);
}
emit ExecuteActionsFailed(transferParams.recipient, transferParams.amount, transferParams.token, reason);
} else {
require(transferParams.recipient.code.length > 0);
}
}
//////////////////////////////////////////////////////////////
// //
// Governance //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Withdraw all funds to governance address in case of emergency. This withdrawal needs
* to be approved by the Community and it can only be executed if no nonce from the
* current AggKey had been consumed in _AGG_KEY_TIMEOUT time. It is a last resort and
* can be used to rectify an emergency.
* @param tokens The addresses of the tokens to be transferred
*/
function govWithdraw(
address[] calldata tokens
) external override onlyGovernor onlyCommunityGuardDisabled onlySuspended timeoutEmergency {
// Could use msg.sender or getGovernor() but hardcoding the get call just for extra safety
address payable recipient = payable(getKeyManager().getGovernanceKey());
// Transfer all native tokens and ERC20 Tokens
for (uint256 i = 0; i < tokens.length; i++) {
if (tokens[i] == _NATIVE_ADDR) {
_transfer(_NATIVE_ADDR, recipient, address(this).balance);
} else {
_transfer(tokens[i], recipient, IERC20(tokens[i]).balanceOf(address(this)));
}
}
}
//////////////////////////////////////////////////////////////
// //
// Modifiers //
// //
//////////////////////////////////////////////////////////////
/// @dev Check that no nonce has been consumed in the last 3 days - emergency
modifier timeoutEmergency() {
require(
block.timestamp - getKeyManager().getLastValidateTime() >= _AGG_KEY_EMERGENCY_TIMEOUT,
"Vault: not enough time"
);
_;
}
//////////////////////////////////////////////////////////////
// //
// Fallbacks //
// //
//////////////////////////////////////////////////////////////
/// @dev For receiving native tokens from the Deposit contracts
receive() external payable {
emit FetchedNative(msg.sender, msg.value);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.0;
import "IERC20.sol";
import "draft-IERC20Permit.sol";
import "Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
function safeTransfer(
IERC20 token,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
function safeTransferFrom(
IERC20 token,
address from,
address to,
uint256 value
) internal {
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/
function safeApprove(
IERC20 token,
address spender,
uint256 value
) internal {
// safeApprove should only be called when setting an initial allowance,
// or when resetting it to zero. To increase and decrease it, use
// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'
require(
(value == 0) || (token.allowance(address(this), spender) == 0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
function safeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal {
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
function safePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal {
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length > 0) {
// Return data is optional
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 amount) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 amount) external returns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(
address from,
address to,
uint256 amount
) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol)
pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value
) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IAggKeyNonceConsumer.sol";
import "IGovernanceCommunityGuarded.sol";
import "IMulticall.sol";
/**
* @title Vault interface
* @notice The interface for functions Vault implements
*/
interface IVault is IGovernanceCommunityGuarded, IAggKeyNonceConsumer {
event FetchedNative(address indexed sender, uint256 amount);
event TransferNativeFailed(address payable indexed recipient, uint256 amount);
event TransferTokenFailed(address payable indexed recipient, uint256 amount, address indexed token, bytes reason);
event SwapNative(
uint32 dstChain,
bytes dstAddress,
uint32 dstToken,
uint256 amount,
address indexed sender,
bytes cfParameters
);
event SwapToken(
uint32 dstChain,
bytes dstAddress,
uint32 dstToken,
address srcToken,
uint256 amount,
address indexed sender,
bytes cfParameters
);
/// @dev bytes parameters is not indexed because indexing a dynamic type for it to be filtered
/// makes it so we won't be able to decode it unless we specifically search for it. If we want
/// to filter it and decode it then we would need to have both the indexed and the non-indexed
/// version in the event. That is unnecessary.
event XCallNative(
uint32 dstChain,
bytes dstAddress,
uint32 dstToken,
uint256 amount,
address indexed sender,
bytes message,
uint256 gasAmount,
bytes cfParameters
);
event XCallToken(
uint32 dstChain,
bytes dstAddress,
uint32 dstToken,
address srcToken,
uint256 amount,
address indexed sender,
bytes message,
uint256 gasAmount,
bytes cfParameters
);
event AddGasNative(bytes32 swapID, uint256 amount);
event AddGasToken(bytes32 swapID, uint256 amount, address token);
event ExecuteActionsFailed(
address payable indexed multicallAddress,
uint256 amount,
address indexed token,
bytes reason
);
function allBatch(
SigData calldata sigData,
DeployFetchParams[] calldata deployFetchParamsArray,
FetchParams[] calldata fetchParamsArray,
TransferParams[] calldata transferParamsArray
) external;
function allBatchV2(
SigData calldata sigData,
FetchParams[] calldata fetchParamsArray,
TransferParams[] calldata transferParamsArray
) external;
//////////////////////////////////////////////////////////////
// //
// Transfers //
// //
//////////////////////////////////////////////////////////////
function transfer(SigData calldata sigData, TransferParams calldata transferParams) external;
function transferBatch(SigData calldata sigData, TransferParams[] calldata transferParamsArray) external;
//////////////////////////////////////////////////////////////
// //
// Fetch Deposits //
// //
//////////////////////////////////////////////////////////////
function deployAndFetchBatch(
SigData calldata sigData,
DeployFetchParams[] calldata deployFetchParamsArray
) external;
function fetchBatch(SigData calldata sigData, FetchParams[] calldata fetchParamsArray) external;
//////////////////////////////////////////////////////////////
// //
// Initiate cross-chain swaps (source chain) //
// //
//////////////////////////////////////////////////////////////
function xSwapToken(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
IERC20 srcToken,
uint256 amount,
bytes calldata cfParameters
) external;
function xSwapNative(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
bytes calldata cfParameters
) external payable;
//////////////////////////////////////////////////////////////
// //
// Initiate cross-chain call and swap (source chain) //
// //
//////////////////////////////////////////////////////////////
function xCallNative(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
bytes calldata message,
uint256 gasAmount,
bytes calldata cfParameters
) external payable;
function xCallToken(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
bytes calldata message,
uint256 gasAmount,
IERC20 srcToken,
uint256 amount,
bytes calldata cfParameters
) external;
//////////////////////////////////////////////////////////////
// //
// Gas topups //
// //
//////////////////////////////////////////////////////////////
function addGasNative(bytes32 swapID) external payable;
function addGasToken(bytes32 swapID, uint256 amount, IERC20 token) external;
//////////////////////////////////////////////////////////////
// //
// Execute cross-chain call and swap (dest. chain) //
// //
//////////////////////////////////////////////////////////////
function executexSwapAndCall(
SigData calldata sigData,
TransferParams calldata transferParams,
uint32 srcChain,
bytes calldata srcAddress,
bytes calldata message
) external;
//////////////////////////////////////////////////////////////
// //
// Execute cross-chain call (dest. chain) //
// //
//////////////////////////////////////////////////////////////
function executexCall(
SigData calldata sigData,
address recipient,
uint32 srcChain,
bytes calldata srcAddress,
bytes calldata message
) external;
//////////////////////////////////////////////////////////////
// //
// Auxiliary chain actions //
// //
//////////////////////////////////////////////////////////////
function executeActions(
SigData calldata sigData,
TransferParams calldata transferParams,
IMulticall.Call[] calldata calls,
uint256 gasMulticall
) external;
//////////////////////////////////////////////////////////////
// //
// Governance //
// //
//////////////////////////////////////////////////////////////
function govWithdraw(address[] calldata tokens) external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IShared.sol";
import "IKeyManager.sol";
/**
* @title AggKeyNonceConsumer interface
*/
interface IAggKeyNonceConsumer is IShared {
event UpdatedKeyManager(address keyManager);
//////////////////////////////////////////////////////////////
// //
// State-changing functions //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Update KeyManager reference. Used if KeyManager contract is updated
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param keyManager New KeyManager's address
* @param omitChecks Allow the omission of the extra checks in a special case
*/
function updateKeyManager(SigData calldata sigData, IKeyManager keyManager, bool omitChecks) external;
//////////////////////////////////////////////////////////////
// //
// Getters //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Get the KeyManager address/interface that's used to validate sigs
* @return The KeyManager (IKeyManager)
*/
function getKeyManager() external view returns (IKeyManager);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IERC20.sol";
/**
* @title Shared interface
* @notice Holds structs needed by other interfaces
*/
interface IShared {
/**
* @dev SchnorrSECP256K1 requires that each key has a public key part (x coordinate),
* a parity for the y coordinate (0 if the y ordinate of the public key is even, 1
* if it's odd)
*/
struct Key {
uint256 pubKeyX;
uint8 pubKeyYParity;
}
/**
* @dev Contains a signature and the nonce used to create it. Also the recovered address
* to check that the signature is valid
*/
struct SigData {
uint256 sig;
uint256 nonce;
address kTimesGAddress;
}
/**
* @param token The address of the token to be transferred
* @param recipient The address of the recipient of the transfer
* @param amount The amount to transfer, in wei (uint)
*/
struct TransferParams {
address token;
address payable recipient;
uint256 amount;
}
/**
* @param swapID The unique identifier for this swap (bytes32), used for create2
* @param token The token to be transferred
*/
struct DeployFetchParams {
bytes32 swapID;
address token;
}
/**
* @param fetchContract The address of the deployed Deposit contract
* @param token The token to be transferred
*/
struct FetchParams {
address payable fetchContract;
address token;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IShared.sol";
/**
* @title KeyManager interface
* @notice The interface for functions KeyManager implements
*/
interface IKeyManager is IShared {
event AggKeySetByAggKey(Key oldAggKey, Key newAggKey);
event AggKeySetByGovKey(Key oldAggKey, Key newAggKey);
event GovKeySetByAggKey(address oldGovKey, address newGovKey);
event GovKeySetByGovKey(address oldGovKey, address newGovKey);
event CommKeySetByAggKey(address oldCommKey, address newCommKey);
event CommKeySetByCommKey(address oldCommKey, address newCommKey);
event SignatureAccepted(SigData sigData, address signer);
event GovernanceAction(bytes32 message);
//////////////////////////////////////////////////////////////
// //
// State-changing functions //
// //
//////////////////////////////////////////////////////////////
function consumeKeyNonce(SigData memory sigData, bytes32 contractMsgHash) external;
function setAggKeyWithAggKey(SigData memory sigData, Key memory newAggKey) external;
function setAggKeyWithGovKey(Key memory newAggKey) external;
function setGovKeyWithAggKey(SigData calldata sigData, address newGovKey) external;
function setGovKeyWithGovKey(address newGovKey) external;
function setCommKeyWithAggKey(SigData calldata sigData, address newCommKey) external;
function setCommKeyWithCommKey(address newCommKey) external;
function govAction(bytes32 message) external;
//////////////////////////////////////////////////////////////
// //
// Non-state-changing functions //
// //
//////////////////////////////////////////////////////////////
function getAggregateKey() external view returns (Key memory);
function getGovernanceKey() external view returns (address);
function getCommunityKey() external view returns (address);
function isNonceUsedByAggKey(uint256 nonce) external view returns (bool);
function getLastValidateTime() external view returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IShared.sol";
/**
* @title GovernanceCommunityGuarded interface
*/
interface IGovernanceCommunityGuarded is IShared {
event CommunityGuardDisabled(bool communityGuardDisabled);
event Suspended(bool suspended);
//////////////////////////////////////////////////////////////
// //
// State-changing functions //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Enable Community Guard
*/
function enableCommunityGuard() external;
/**
* @notice Disable Community Guard
*/
function disableCommunityGuard() external;
/**
* @notice Can be used to suspend contract execution - only executable by
* governance and only to be used in case of emergency.
*/
function suspend() external;
/**
* @notice Resume contract execution
*/
function resume() external;
//////////////////////////////////////////////////////////////
// //
// Getters //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Get the Community Key
* @return The CommunityKey
*/
function getCommunityKey() external view returns (address);
/**
* @notice Get the Community Guard state
* @return The Community Guard state
*/
function getCommunityGuardDisabled() external view returns (bool);
/**
* @notice Get suspended state
* @return The suspended state
*/
function getSuspendedState() external view returns (bool);
/**
* @notice Get governor address
* @return The governor address
*/
function getGovernor() external view returns (address);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
interface IMulticall {
enum CallType {
Default,
FullTokenBalance,
FullNativeBalance,
CollectTokenBalance
}
struct Call {
CallType callType;
address target;
uint256 value;
bytes callData;
bytes payload;
}
error AlreadyRunning();
error CallFailed(uint256 callPosition, bytes reason);
function run(Call[] calldata calls, address tokenIn, uint256 amountIn) external payable;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @title CF Receiver interface
* @dev The ICFReceiver interface is the interface required to receive tokens and
* cross-chain calls from the Chainflip Protocol.
*/
interface ICFReceiver {
/**
* @notice Receiver of a cross-chain swap and call made by the Chainflip Protocol.
* @param srcChain The source chain according to the Chainflip Protocol's nomenclature.
* @param srcAddress Bytes containing the source address on the source chain.
* @param message The message sent on the source chain. This is a general purpose message.
* @param token Address of the token received. _NATIVE_ADDR if it's native tokens.
* @param amount Amount of tokens received. This will match msg.value for native tokens.
*/
function cfReceive(
uint32 srcChain,
bytes calldata srcAddress,
bytes calldata message,
address token,
uint256 amount
) external payable;
/**
* @notice Receiver of a cross-chain call made by the Chainflip Protocol.
* @param srcChain The source chain according to the Chainflip Protocol's nomenclature.
* @param srcAddress Bytes containing the source address on the source chain.
* @param message The message sent on the source chain. This is a general purpose message.
*/
function cfReceivexCall(uint32 srcChain, bytes calldata srcAddress, bytes calldata message) external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IShared.sol";
/**
* @title Shared contract
* @notice Holds constants and modifiers that are used in multiple contracts
* @dev It would be nice if this could be a library, but modifiers can't be exported :(
*/
abstract contract Shared is IShared {
/// @dev The address used to indicate whether transfer should send native or a token
address internal constant _NATIVE_ADDR = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;
address internal constant _ZERO_ADDR = address(0);
bytes32 internal constant _NULL = "";
uint256 internal constant _E_18 = 1e18;
/// @dev Checks that a uint isn't zero/empty
modifier nzUint(uint256 u) {
require(u != 0, "Shared: uint input is empty");
_;
}
/// @dev Checks that an address isn't zero/empty
modifier nzAddr(address a) {
require(a != _ZERO_ADDR, "Shared: address input is empty");
_;
}
/// @dev Checks that a bytes32 isn't zero/empty
modifier nzBytes32(bytes32 b) {
require(b != _NULL, "Shared: bytes32 input is empty");
_;
}
/// @dev Checks that the pubKeyX is populated
modifier nzKey(Key memory key) {
require(key.pubKeyX != 0, "Shared: pubKeyX is empty");
_;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IERC20Lite.sol";
/**
* @title Deposit contract
* @notice Creates a contract with a known address and withdraws tokens from it.
* After deployment, the Vault will call fetch() to withdraw tokens.
* @dev Any change in this contract, including comments, will affect the final
* bytecode and therefore will affect the create2 derived addresses.
* Do NOT modify unless the consequences of doing so are fully understood.
*/
contract Deposit {
address payable private immutable vault;
/**
* @notice Upon deployment it fetches the tokens (native or ERC20) to the Vault.
* @param token The address of the token to fetch
*/
constructor(address token) {
vault = payable(msg.sender);
// Slightly cheaper to use msg.sender instead of Vault.
if (token == 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) {
// solhint-disable-next-line avoid-low-level-calls
(bool success, ) = msg.sender.call{value: address(this).balance}("");
require(success);
} else {
// IERC20Lite.transfer doesn't have a return bool to avoid reverts on non-standard ERC20s
IERC20Lite(token).transfer(msg.sender, IERC20Lite(token).balanceOf(address(this)));
}
}
/**
* @notice Allows the Vault to fetch ERC20 tokens from this contract.
* @param token The address of the token to fetch
*/
function fetch(address token) external {
require(msg.sender == vault);
// IERC20Lite.transfer doesn't have a return bool to avoid reverts on non-standard ERC20s
IERC20Lite(token).transfer(msg.sender, IERC20Lite(token).balanceOf(address(this)));
}
/// @notice Receives native tokens, emits an event and sends them to the Vault. Note that this
// requires the sender to forward some more gas than for a simple transfer.
receive() external payable {
// solhint-disable-next-line avoid-low-level-calls
(bool success, ) = vault.call{value: address(this).balance}("");
require(success);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
/**
* @title ERC20 Lite Interface
* @notice The interface for functions ERC20Lite implements. This is intended to
* be used only in the Deposit contract.
* @dev Any change in this contract, including comments, will affect the final
* bytecode and therefore will affect the create2 derived addresses.
* Do NOT modify unless the consequences of doing so are fully understood.
*/
interface IERC20Lite {
/// @dev Removed the return bool to avoid reverts on non-standard ERC20s.
function transfer(address, uint256) external;
function balanceOf(address) external view returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IKeyManager.sol";
import "IAggKeyNonceConsumer.sol";
import "Shared.sol";
/**
* @title AggKeyNonceConsumer contract
* @notice Manages the reference to the KeyManager contract. The address
* is set in the constructor and can only be updated with a valid
* signature validated by the current KeyManager contract. This shall
* be done if the KeyManager contract is updated.
*/
abstract contract AggKeyNonceConsumer is Shared, IAggKeyNonceConsumer {
/// @dev The KeyManager used to checks sigs used in functions here
IKeyManager private _keyManager;
constructor(IKeyManager keyManager) nzAddr(address(keyManager)) {
_keyManager = keyManager;
}
//////////////////////////////////////////////////////////////
// //
// State-changing functions //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Update KeyManager reference. Used if KeyManager contract is updated
* @param sigData Struct containing the signature data over the message
* to verify, signed by the aggregate key.
* @param keyManager New KeyManager's address
* @param omitChecks Allow the omission of the extra checks in a special case
*/
function updateKeyManager(
SigData calldata sigData,
IKeyManager keyManager,
bool omitChecks
)
external
override
nzAddr(address(keyManager))
consumesKeyNonce(sigData, keccak256(abi.encode(this.updateKeyManager.selector, keyManager, omitChecks)))
{
// Check that the new KeyManager is a contract
require(address(keyManager).code.length > 0);
// Allow the child to check compatibility with the new KeyManager
_checkUpdateKeyManager(keyManager, omitChecks);
_keyManager = keyManager;
emit UpdatedKeyManager(address(keyManager));
}
/// @dev This will be called when upgrading to a new KeyManager. This allows the child's contract
/// to check its compatibility with the new KeyManager. This is to prevent the contract from
// getting bricked. There is no good way to enforce the implementation of consumeKeyNonce().
function _checkUpdateKeyManager(IKeyManager keyManager, bool omitChecks) internal view virtual;
//////////////////////////////////////////////////////////////
// //
// Getters //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Get the KeyManager address/interface that's used to validate sigs
* @return The KeyManager (IKeyManager)
*/
function getKeyManager() public view override returns (IKeyManager) {
return _keyManager;
}
//////////////////////////////////////////////////////////////
// //
// Modifiers //
// //
//////////////////////////////////////////////////////////////
/// @dev Calls consumeKeyNonce in _keyManager
modifier consumesKeyNonce(SigData calldata sigData, bytes32 contractMsgHash) {
getKeyManager().consumeKeyNonce(sigData, contractMsgHash);
_;
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "IGovernanceCommunityGuarded.sol";
import "AggKeyNonceConsumer.sol";
import "Shared.sol";
/**
* @title GovernanceCommunityGuarded contract
* @notice Allows the governor to perform certain actions for the procotol's safety in
* case of emergency. The aim is to allow the governor to suspend execution of
* critical functions.
* Also, it allows the CommunityKey to safeguard certain functions so the
* governor can execute them iff the communityKey allows it.
*/
abstract contract GovernanceCommunityGuarded is Shared, IGovernanceCommunityGuarded {
/// @dev Community Guard Disabled
bool private _communityGuardDisabled;
/// @dev Whether execution is suspended
bool private _suspended = false;
/**
* @notice Get the governor's address. The contracts inheriting this (StateChainGateway and Vault)
* get the governor's address from the KeyManager through the AggKeyNonceConsumer's
* inheritance. Therefore, the implementation of this function must be left
* to the children. This is not implemented as a virtual onlyGovernor modifier to force
* the children to implement this function - virtual modifiers don't enforce that.
* @return The governor's address
*/
function _getGovernor() internal view virtual returns (address);
/**
* @notice Get the community's address. The contracts inheriting this (StateChainGateway and Vault)
* get the community's address from the KeyManager through the AggKeyNonceConsumer's
* inheritance. Therefore, the implementation of this function must be left
* to the children. This is not implemented as a virtual onlyCommunityKey modifier to force
* the children to implement this function - virtual modifiers don't enforce that.
* @return The community's address
*/
function _getCommunityKey() internal view virtual returns (address);
//////////////////////////////////////////////////////////////
// //
// State-changing functions //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Enable Community Guard
*/
function enableCommunityGuard() external override onlyCommunityKey onlyCommunityGuardDisabled {
_communityGuardDisabled = false;
emit CommunityGuardDisabled(false);
}
/**
* @notice Disable Community Guard
*/
function disableCommunityGuard() external override onlyCommunityKey onlyCommunityGuardEnabled {
_communityGuardDisabled = true;
emit CommunityGuardDisabled(true);
}
/**
* @notice Can be used to suspend contract execution - only executable by
* governance and only to be used in case of emergency.
*/
function suspend() external override onlyGovernor onlyNotSuspended {
_suspended = true;
emit Suspended(true);
}
/**
* @notice Resume contract execution
*/
function resume() external override onlyGovernor onlySuspended {
_suspended = false;
emit Suspended(false);
}
//////////////////////////////////////////////////////////////
// //
// Getters //
// //
//////////////////////////////////////////////////////////////
/**
* @notice Get the Community Key
* @return The CommunityKey
*/
function getCommunityKey() external view override returns (address) {
return _getCommunityKey();
}
/**
* @notice Get the Community Guard state
* @return The Community Guard state
*/
function getCommunityGuardDisabled() external view override returns (bool) {
return _communityGuardDisabled;
}
/**
* @notice Get suspended state
* @return The suspended state
*/
function getSuspendedState() external view override returns (bool) {
return _suspended;
}
/**
* @notice Get governor address
* @return The governor address
*/
function getGovernor() external view override returns (address) {
return _getGovernor();
}
//////////////////////////////////////////////////////////////
// //
// Modifiers //
// //
//////////////////////////////////////////////////////////////
/// @dev Check that the caller is the Community Key address.
modifier onlyCommunityKey() {
require(msg.sender == _getCommunityKey(), "Governance: not Community Key");
_;
}
/// @dev Check that community has disabled the community guard.
modifier onlyCommunityGuardDisabled() {
require(_communityGuardDisabled, "Governance: community guard enabled");
_;
}
/// @dev Check that community has disabled the community guard.
modifier onlyCommunityGuardEnabled() {
require(!_communityGuardDisabled, "Governance: community guard disabled");
_;
}
/// @notice Ensure that the caller is the governor address. Calls the getGovernor
/// function which is implemented by the children.
modifier onlyGovernor() {
require(msg.sender == _getGovernor(), "Governance: not governor");
_;
}
// @notice Check execution is suspended
modifier onlySuspended() {
require(_suspended, "Governance: not suspended");
_;
}
// @notice Check execution is not suspended
modifier onlyNotSuspended() {
require(!_suspended, "Governance: suspended");
_;
}
}
File 3 of 3: RangoChainFlipFacet
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*
* ==== Security Considerations
*
* There are two important considerations concerning the use of `permit`. The first is that a valid permit signature
* expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be
* considered as an intention to spend the allowance in any specific way. The second is that because permits have
* built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should
* take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be
* generally recommended is:
*
* ```solidity
* function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public {
* try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {}
* doThing(..., value);
* }
*
* function doThing(..., uint256 value) public {
* token.safeTransferFrom(msg.sender, address(this), value);
* ...
* }
* ```
*
* Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of
* `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also
* {SafeERC20-safeTransferFrom}).
*
* Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so
* contracts should have entry points that don't rely on permit.
*/
interface IERC20Permit {
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*
* CAUTION: See Security Considerations above.
*/
function permit(
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/
function nonces(address owner) external view returns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/
// solhint-disable-next-line func-name-mixedcase
function DOMAIN_SEPARATOR() external view returns (bytes32);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/
event Transfer(address indexed from, address indexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/
event Approval(address indexed owner, address indexed spender, uint256 value);
/**
* @dev Returns the value of tokens in existence.
*/
function totalSupply() external view returns (uint256);
/**
* @dev Returns the value of tokens owned by `account`.
*/
function balanceOf(address account) external view returns (uint256);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address to, uint256 value) external returns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/
function allowance(address owner, address spender) external view returns (uint256);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/
function approve(address spender, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the
* allowance mechanism. `value` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transferFrom(address from, address to, uint256 value) external returns (bool);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC20Permit} from "../extensions/IERC20Permit.sol";
import {Address} from "../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/
library SafeERC20 {
using Address for address;
/**
* @dev An operation with an ERC20 token failed.
*/
error SafeERC20FailedOperation(address token);
/**
* @dev Indicates a failed `decreaseAllowance` request.
*/
error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease);
/**
* @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeTransfer(IERC20 token, address to, uint256 value) internal {
bytes memory returndata = address(token).functionCall(abi.encodeCall(token.transfer, (to, value)));
if (address(token)!=0xa614f803B6FD780986A42c78Ec9c7f77e6DeD13C && returndata.length != 0 && !abi.decode(returndata, (bool))) {
revert SafeERC20FailedOperation(address(token));
}
// _callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the
* calling contract. If `token` returns no value, non-reverting calls are assumed to be successful.
*/
function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal {
_callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value)));
}
/**
* @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful.
*/
function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 oldAllowance = token.allowance(address(this), spender);
forceApprove(token, spender, oldAllowance + value);
}
/**
* @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no
* value, non-reverting calls are assumed to be successful.
*/
function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal {
unchecked {
uint256 currentAllowance = token.allowance(address(this), spender);
if (currentAllowance < requestedDecrease) {
revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease);
}
forceApprove(token, spender, currentAllowance - requestedDecrease);
}
}
/**
* @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value,
* non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval
* to be set to zero before setting it to a non-zero value, such as USDT.
*/
function forceApprove(IERC20 token, address spender, uint256 value) internal {
bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value));
if (!_callOptionalReturnBool(token, approvalCall)) {
_callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0)));
_callOptionalReturn(token, approvalCall);
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that
// the target address contains contract code and also asserts for success in the low-level call.
bytes memory returndata = address(token).functionCall(data);
if (returndata.length != 0 && !abi.decode(returndata, (bool))) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*
* This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since
// we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false
// and not revert is the subcall reverts.
(bool success, bytes memory returndata) = address(token).call(data);
return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error AddressInsufficientBalance(address account);
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedInnerCall();
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
if (address(this).balance < amount) {
revert AddressInsufficientBalance(address(this));
}
(bool success, ) = recipient.call{value: amount}("");
if (!success) {
revert FailedInnerCall();
}
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason or custom error, it is bubbled
* up by this function (like regular Solidity function calls). However, if
* the call reverted with no returned reason, this function reverts with a
* {FailedInnerCall} error.
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
if (address(this).balance < value) {
revert AddressInsufficientBalance(address(this));
}
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target
* was not a contract or bubbling up the revert reason (falling back to {FailedInnerCall}) in case of an
* unsuccessful call.
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata
) internal view returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
// only check if target is a contract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
if (returndata.length == 0 && target.code.length == 0) {
revert AddressEmptyCode(target);
}
return returndata;
}
}
/**
* @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the
* revert reason or with a default {FailedInnerCall} error.
*/
function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) {
if (!success) {
_revert(returndata);
} else {
return returndata;
}
}
/**
* @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}.
*/
function _revert(bytes memory returndata) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert FailedInnerCall();
}
}
}
// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.25;
import "../../interfaces/IRangoChainFlip.sol";
import "../../interfaces/IChainFlipBridge.sol";
import "../../interfaces/IRango.sol";
import "../../utils/ReentrancyGuard.sol";
import "../../libraries/LibSwapper.sol";
import "../../utils/LibTransform.sol";
import "../../libraries/LibDiamond.sol";
import "../../interfaces/Interchain.sol";
import "../../libraries/LibPausable.sol";
/// @title The root contract that handles Rango's interaction with ChainFlip bridge
/// @author Smnp
/// @dev This is deployed as a facet for RangoDiamond
contract RangoChainFlipFacet is IRango, ReentrancyGuard, IRangoChainFlip {
/// Storage ///
bytes32 internal constant CHAINFLIP_NAMESPACE = keccak256("exchange.rango.facets.ChainFlip");
struct ChainFlipStorage {
/// @notice is the address of chainflip vault that bridge requests are sent into
address chainFlipValutAddress;
}
/// Events ///
/// @notice Notifies that vaulta address is updated
/// @param changedFromAddress The previous address of vault that we changed the chainFlipValutAddress from it.
/// @param changedToAddress The new address of vault that we changed the chainFlipValutAddress to it.
event ChainFlipVaultAddressChangedTo(address changedFromAddress, address changedToAddress);
/// Initialization ///
/// @notice Initialize the contract.
/// @param _chainFlipVaultAddress The contract address of the vault on this chain.
function initChainFlip(address _chainFlipVaultAddress) external {
LibDiamond.enforceIsContractOwner();
changeChainFlipVaultAddressInternal(_chainFlipVaultAddress);
}
/// @notice changes the address of vault contract
/// @param _chainFlipVaultAddress The new contract address of the vault on this chain.
function changeChainFlipVaultAddress(address _chainFlipVaultAddress) public {
LibDiamond.enforceIsContractOwner();
changeChainFlipVaultAddressInternal(_chainFlipVaultAddress);
}
/// @notice Executes a DEX (arbitrary) call + a ChainFlip bridge call
/// @dev request.toToken can be address(0) for native deposits and will be replaced in doChainFlip
/// @param request The general swap request containing from/to token and fee/affiliate rewards
/// @param calls The list of DEX calls, if this list is empty, it means that there is no DEX call and we are only bridging
/// @param bridgeRequest required data for the bridging step, including the destination chain and recipient wallet address
function chainFlipSwapAndBridge(
LibSwapper.SwapRequest memory request,
LibSwapper.Call[] calldata calls,
ChainFlipBridgeRequest memory bridgeRequest
) external payable nonReentrant {
LibPausable.enforceNotPaused();
uint out = LibSwapper.onChainSwapsPreBridge(request, calls, 0);
doChainFlipBridge(bridgeRequest, request.toToken, out);
// event emission
emit RangoBridgeInitiated(
request.requestId,
request.toToken,
out,
LibTransform.bytesToAddress(bridgeRequest.dstAddress),
bridgeRequest.dstChain,
bridgeRequest.message.length > 0,
false,
uint8(BridgeType.ChainFlip),
request.dAppTag,
request.dAppName
);
}
/// @notice starts bridging through ChainFlip bridge
/// @dev request.toToken can be address(0) for native deposits and will be replaced in doChainFlipBridge
function chainFlipBridge(
ChainFlipBridgeRequest memory request,
IRango.RangoBridgeRequest memory bridgeRequest
) external payable nonReentrant {
LibPausable.enforceNotPaused();
address token = bridgeRequest.token;
uint amountWithFee = bridgeRequest.amount + LibSwapper.sumFees(bridgeRequest);
// transfer tokens if necessary
if (token == LibSwapper.ETH) {
require(
msg.value >= amountWithFee,
"Insufficient ETH sent for bridging and fees"
);
} else {
SafeERC20.safeTransferFrom(IERC20(token), msg.sender, address(this), amountWithFee);
}
LibSwapper.collectFees(bridgeRequest);
doChainFlipBridge(request, token, bridgeRequest.amount);
// event emission
emit RangoBridgeInitiated(
bridgeRequest.requestId,
token,
bridgeRequest.amount,
LibTransform.bytesToAddress(request.dstAddress),
request.dstChain,
request.message.length > 0,
false,
uint8(BridgeType.ChainFlip),
bridgeRequest.dAppTag,
bridgeRequest.dAppName
);
}
/// @notice Executes an ChainFlip bridge call
/// @dev request.dstToken can be 0xEeee...eeEEeE for native deposits
/// @param request The other required fields for ChainFlip bridge contract
/// @param amount Amount of tokens to deposit. Will be amount of tokens to receive less fees.
function doChainFlipBridge(
ChainFlipBridgeRequest memory request,
address token,
uint amount
) internal {
ChainFlipStorage storage s = getChainFlipStorage();
if(request.message.length > 0){
if(token == LibSwapper.ETH) {
IChainFlipBridge(s.chainFlipValutAddress).xCallNative{value: amount}(
request.dstChain,
request.dstAddress,
request.dstToken,
request.message,
request.gasAmount,
request.cfParameters
);
} else {
LibSwapper.approveMax(token, s.chainFlipValutAddress, amount);
IChainFlipBridge(s.chainFlipValutAddress).xCallToken(
request.dstChain,
request.dstAddress,
request.dstToken,
request.message,
request.gasAmount,
token,
amount,
request.cfParameters
);
}
}else{
if(token == LibSwapper.ETH) {
IChainFlipBridge(s.chainFlipValutAddress).xSwapNative{value: amount}(
request.dstChain,
request.dstAddress,
request.dstToken,
request.cfParameters
);
} else {
LibSwapper.approveMax(token, s.chainFlipValutAddress, amount);
IChainFlipBridge(s.chainFlipValutAddress).xSwapToken(
request.dstChain,
request.dstAddress,
request.dstToken,
token,
amount,
request.cfParameters
);
}
}
}
function changeChainFlipVaultAddressInternal(address _newChainFlipVaultAddress) private {
ChainFlipStorage storage s = getChainFlipStorage();
address previousVaultAddress = s.chainFlipValutAddress;
require(_newChainFlipVaultAddress != address(0), "Invalid VaultAddress Address");
s.chainFlipValutAddress = _newChainFlipVaultAddress;
emit ChainFlipVaultAddressChangedTo(previousVaultAddress, _newChainFlipVaultAddress);
}
/// @dev fetch local storage
function getChainFlipStorage() private pure returns (ChainFlipStorage storage s) {
bytes32 namespace = CHAINFLIP_NAMESPACE;
// solhint-disable-next-line no-inline-assembly
assembly {
s.slot := namespace
}
}
}// SPDX-License-Identifier: GPL-3.0-only
pragma solidity ^0.8.25;
// This interface is expected to be implemented by any contract that expects to recieve messages from the SpokePool.
interface IChainFlipBridge {
// Swap native token
function xSwapNative(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
bytes calldata cfParameters
) external payable;
// Swap ERC20 token
function xSwapToken(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
address srcToken, /// sep: change to address from IERC20
uint256 amount,
bytes calldata cfParameters
) external;
// Swap native token with message
function xCallNative(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
bytes calldata message,
uint256 gasAmount,
bytes calldata cfParameters
) external payable;
// Swap ERC20 token with message
function xCallToken(
uint32 dstChain,
bytes calldata dstAddress,
uint32 dstToken,
bytes calldata message,
uint256 gasAmount,
address srcToken, /// sep: change to address from IERC20
uint256 amount,
bytes calldata cfParameters
) external;
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.25;
interface IDiamondCut {
enum FacetCutAction {
Add,
Replace,
Remove
}
// Add=0, Replace=1, Remove=2
struct FacetCut {
address facetAddress;
FacetCutAction action;
bytes4[] functionSelectors;
}
/// @notice Add/replace/remove any number of functions and optionally execute
/// a function with delegatecall
/// @param _diamondCut Contains the facet addresses and function selectors
/// @param _init The address of the contract or facet to execute _calldata
/// @param _calldata A function call, including function selector and arguments
/// _calldata is executed with delegatecall on _init
function diamondCut(
FacetCut[] calldata _diamondCut,
address _init,
bytes calldata _calldata
) external;
event DiamondCut(FacetCut[] _diamondCut, address _init, bytes _calldata);
}
// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.25;
/// @title An interface to interchain message types
/// @author Uchiha Sasuke
interface Interchain {
enum ActionType { NO_ACTION, UNI_V2, UNI_V3, CALL, CURVE }
enum CallSubActionType { WRAP, UNWRAP, NO_ACTION }
struct RangoInterChainMessage {
address requestId;
uint64 dstChainId;
// @dev bridgeRealOutput is only used to disambiguate receipt of WETH and ETH and SHOULD NOT be used anywhere else!
address bridgeRealOutput;
address toToken;
address originalSender;
address recipient;
ActionType actionType;
bytes action;
CallSubActionType postAction;
uint16 dAppTag;
// Extra message
bytes dAppMessage;
address dAppSourceContract;
address dAppDestContract;
}
struct UniswapV2Action {
address dexAddress;
uint amountOutMin;
address[] path;
uint deadline;
}
struct UniswapV3ActionExactInputParams {
address dexAddress;
address tokenIn;
address tokenOut;
bytes encodedPath;
uint256 deadline;
uint256 amountOutMinimum;
bool isRouter2;
}
/// @notice The requested call data which is computed off-chain and passed to the contract
/// @param target The dex contract address that should be called
/// @param overwriteAmount if true, by using startIndexForAmount actual value will be used for swap
/// @param startIndexForAmount if overwriteAmount is false, this parameter will be ignored. must be byte number
/// @param callData The required data field that should be give to the dex contract to perform swap
struct CallAction {
address tokenIn;
address spender;
CallSubActionType preAction;
address payable target;
bool overwriteAmount;
uint256 startIndexForAmount;
bytes callData;
}
/// @notice the data needed to call `exchange` method for swap via Curve
struct CurveAction {
address routerContractAddress;
address [11] routes;
uint256 [5][5] swap_params;
uint256 expected;
address [5] pools;
address toToken;
}
}// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.25;
interface IRango {
struct RangoBridgeRequest {
address requestId;
address token;
uint amount;
uint platformFee;
uint affiliateFee;
address payable affiliatorAddress;
uint destinationExecutorFee;
uint16 dAppTag;
string dAppName;
}
enum BridgeType {
Across,
CBridge,
Hop,
Hyphen,
Multichain,
Stargate,
Synapse,
Thorchain,
Symbiosis,
Axelar,
Voyager,
Poly,
OptimismBridge,
ArbitrumBridge,
Wormhole,
AllBridge,
CCTP,
Connext,
NitroAssetForwarder,
DeBridge,
YBridge,
Swft,
Orbiter,
ChainFlip
}
/// @notice Status of cross-chain swap
/// @param Succeeded The whole process is success and end-user received the desired token in the destination
/// @param RefundInSource Bridge was out of liquidity and middle asset (ex: USDC) is returned to user on source chain
/// @param RefundInDestination Our handler on dest chain this.executeMessageWithTransfer failed and we send middle asset (ex: USDC) to user on destination chain
/// @param SwapFailedInDestination Everything was ok, but the final DEX on destination failed (ex: Market price change and slippage)
enum CrossChainOperationStatus {
Succeeded,
RefundInSource,
RefundInDestination,
SwapFailedInDestination
}
event RangoBridgeInitiated(
address indexed requestId,
address bridgeToken,
uint256 bridgeAmount,
address receiver,
uint destinationChainId,
bool hasInterchainMessage,
bool hasDestinationSwap,
uint8 indexed bridgeId,
uint16 indexed dAppTag,
string dAppName
);
event RangoBridgeCompleted(
address indexed requestId,
address indexed token,
address indexed originalSender,
address receiver,
uint amount,
CrossChainOperationStatus status,
uint16 dAppTag
);
}// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.25;
import "../libraries/LibSwapper.sol";
import "./IRango.sol";
/// @title An interface to RangoChainFlipFacet.sol contract to improve type hinting
/// @author Smnp
interface IRangoChainFlip {
/// @notice The request object for ChainFlip bridge call
/// @param dstChain Destination chain for the swap.
/// @param dstAddress Address where the swapped tokens will be sent to on the destination chain. Addresses must be encoded into a bytes type.
/// @param dstToken Token to be received on the destination chain.
/// @param message Message that is passed to the destination address on the destination. It must be shorter than 10k bytes.
/// @param gasAmount Gas budget for the call on the destination chain. This amount is based on the source asset and will be subtracted from the input amount and swapped to pay for gas.
/// @param cfParameters Additional metadata for future features. Currently unused.
struct ChainFlipBridgeRequest {
uint32 dstChain;
bytes dstAddress;
uint32 dstToken;
bytes message;
uint256 gasAmount;
bytes cfParameters;
}
function chainFlipSwapAndBridge(
LibSwapper.SwapRequest memory request,
LibSwapper.Call[] calldata calls,
ChainFlipBridgeRequest memory bridgeRequest
) external payable;
function chainFlipBridge(
ChainFlipBridgeRequest memory request,
IRango.RangoBridgeRequest memory bridgeRequest
) external payable;
}// SPDX-License-Identifier: GPL-3.0-only
pragma solidity 0.8.25;
interface IWETH {
function deposit() external payable;
function withdraw(uint256) external;
}
// SPDX-License-Identifier: MIT
pragma solidity 0.8.25;
import { IDiamondCut } from "../interfaces/IDiamondCut.sol";
/// Implementation of EIP-2535 Diamond Standard
/// https://eips.ethereum.org/EIPS/eip-2535
library LibDiamond {
/// Storage ///
bytes32 internal constant DIAMOND_STORAGE_POSITION = keccak256("diamond.standard.diamond.storage");
// Diamond specific errors
error IncorrectFacetCutAction();
error NoSelectorsInFacet();
error FunctionAlreadyExists();
error FacetAddressIsZero();
error FacetAddressIsNotZero();
error FacetContainsNoCode();
error FunctionDoesNotExist();
error FunctionIsImmutable();
error InitZeroButCalldataNotEmpty();
error CalldataEmptyButInitNotZero();
error InitReverted();
// ----------------
struct FacetAddressAndPosition {
address facetAddress;
uint96 functionSelectorPosition; // position in facetFunctionSelectors.functionSelectors array
}
struct FacetFunctionSelectors {
bytes4[] functionSelectors;
uint256 facetAddressPosition; // position of facetAddress in facetAddresses array
}
struct DiamondStorage {
// maps function selector to the facet address and
// the position of the selector in the facetFunctionSelectors.selectors array
mapping(bytes4 => FacetAddressAndPosition) selectorToFacetAndPosition;
// maps facet addresses to function selectors
mapping(address => FacetFunctionSelectors) facetFunctionSelectors;
// facet addresses
address[] facetAddresses;
// Used to query if a contract implements an interface.
// Used to implement ERC-165.
mapping(bytes4 => bool) supportedInterfaces;
// owner of the contract
address contractOwner;
}
function diamondStorage() internal pure returns (DiamondStorage storage ds) {
bytes32 position = DIAMOND_STORAGE_POSITION;
// solhint-disable-next-line no-inline-assembly
assembly {
ds.slot := position
}
}
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
function setContractOwner(address _newOwner) internal {
DiamondStorage storage ds = diamondStorage();
address previousOwner = ds.contractOwner;
ds.contractOwner = _newOwner;
emit OwnershipTransferred(previousOwner, _newOwner);
}
function contractOwner() internal view returns (address contractOwner_) {
contractOwner_ = diamondStorage().contractOwner;
}
function enforceIsContractOwner() internal view {
require(msg.sender == diamondStorage().contractOwner, "LibDiamond: Must be contract owner");
}
event DiamondCut(IDiamondCut.FacetCut[] _diamondCut, address _init, bytes _calldata);
// Internal function version of diamondCut
function diamondCut(
IDiamondCut.FacetCut[] memory _diamondCut,
address _init,
bytes memory _calldata
) internal {
for (uint256 facetIndex; facetIndex < _diamondCut.length; ) {
IDiamondCut.FacetCutAction action = _diamondCut[facetIndex].action;
if (action == IDiamondCut.FacetCutAction.Add) {
addFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} else if (action == IDiamondCut.FacetCutAction.Replace) {
replaceFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} else if (action == IDiamondCut.FacetCutAction.Remove) {
removeFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} else {
revert IncorrectFacetCutAction();
}
unchecked {
++facetIndex;
}
}
emit DiamondCut(_diamondCut, _init, _calldata);
initializeDiamondCut(_init, _calldata);
}
function addFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal {
if (_facetAddress == address(0)) {
revert FacetAddressIsZero();
}
if (_functionSelectors.length == 0) {
revert NoSelectorsInFacet();
}
DiamondStorage storage ds = diamondStorage();
uint96 selectorPosition = uint96(ds.facetFunctionSelectors[_facetAddress].functionSelectors.length);
// add new facet address if it does not exist
if (selectorPosition == 0) {
addFacet(ds, _facetAddress);
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
if (oldFacetAddress != address(0)) {
revert FunctionAlreadyExists();
}
addFunction(ds, selector, selectorPosition, _facetAddress);
unchecked {
++selectorPosition;
++selectorIndex;
}
}
}
function replaceFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal {
if (_functionSelectors.length == 0) {
revert NoSelectorsInFacet();
}
if (_facetAddress == address(0)) {
revert FacetAddressIsZero();
}
DiamondStorage storage ds = diamondStorage();
uint96 selectorPosition = uint96(ds.facetFunctionSelectors[_facetAddress].functionSelectors.length);
// add new facet address if it does not exist
if (selectorPosition == 0) {
addFacet(ds, _facetAddress);
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
if (oldFacetAddress == _facetAddress) {
revert FunctionAlreadyExists();
}
removeFunction(ds, oldFacetAddress, selector);
addFunction(ds, selector, selectorPosition, _facetAddress);
unchecked {
++selectorPosition;
++selectorIndex;
}
}
}
function removeFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal {
if (_functionSelectors.length == 0) {
revert NoSelectorsInFacet();
}
DiamondStorage storage ds = diamondStorage();
// if function does not exist then do nothing and return
if (_facetAddress != address(0)) {
revert FacetAddressIsNotZero();
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
removeFunction(ds, oldFacetAddress, selector);
unchecked {
++selectorIndex;
}
}
}
function addFacet(DiamondStorage storage ds, address _facetAddress) internal {
enforceHasContractCode(_facetAddress);
ds.facetFunctionSelectors[_facetAddress].facetAddressPosition = ds.facetAddresses.length;
ds.facetAddresses.push(_facetAddress);
}
function addFunction(
DiamondStorage storage ds,
bytes4 _selector,
uint96 _selectorPosition,
address _facetAddress
) internal {
ds.selectorToFacetAndPosition[_selector].functionSelectorPosition = _selectorPosition;
ds.facetFunctionSelectors[_facetAddress].functionSelectors.push(_selector);
ds.selectorToFacetAndPosition[_selector].facetAddress = _facetAddress;
}
function removeFunction(
DiamondStorage storage ds,
address _facetAddress,
bytes4 _selector
) internal {
if (_facetAddress == address(0)) {
revert FunctionDoesNotExist();
}
// an immutable function is a function defined directly in a diamond
if (_facetAddress == address(this)) {
revert FunctionIsImmutable();
}
// replace selector with last selector, then delete last selector
uint256 selectorPosition = ds.selectorToFacetAndPosition[_selector].functionSelectorPosition;
uint256 lastSelectorPosition = ds.facetFunctionSelectors[_facetAddress].functionSelectors.length - 1;
// if not the same then replace _selector with lastSelector
if (selectorPosition != lastSelectorPosition) {
bytes4 lastSelector = ds.facetFunctionSelectors[_facetAddress].functionSelectors[lastSelectorPosition];
ds.facetFunctionSelectors[_facetAddress].functionSelectors[selectorPosition] = lastSelector;
ds.selectorToFacetAndPosition[lastSelector].functionSelectorPosition = uint96(selectorPosition);
}
// delete the last selector
ds.facetFunctionSelectors[_facetAddress].functionSelectors.pop();
delete ds.selectorToFacetAndPosition[_selector];
// if no more selectors for facet address then delete the facet address
if (lastSelectorPosition == 0) {
// replace facet address with last facet address and delete last facet address
uint256 lastFacetAddressPosition = ds.facetAddresses.length - 1;
uint256 facetAddressPosition = ds.facetFunctionSelectors[_facetAddress].facetAddressPosition;
if (facetAddressPosition != lastFacetAddressPosition) {
address lastFacetAddress = ds.facetAddresses[lastFacetAddressPosition];
ds.facetAddresses[facetAddressPosition] = lastFacetAddress;
ds.facetFunctionSelectors[lastFacetAddress].facetAddressPosition = facetAddressPosition;
}
ds.facetAddresses.pop();
delete ds.facetFunctionSelectors[_facetAddress].facetAddressPosition;
}
}
function initializeDiamondCut(address _init, bytes memory _calldata) internal {
if (_init == address(0)) {
if (_calldata.length != 0) {
revert InitZeroButCalldataNotEmpty();
}
} else {
if (_calldata.length == 0) {
revert CalldataEmptyButInitNotZero();
}
if (_init != address(this)) {
enforceHasContractCode(_init);
}
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory error) = _init.delegatecall(_calldata);
if (!success) {
if (error.length > 0) {
// bubble up the error
revert(string(error));
} else {
revert InitReverted();
}
}
}
}
function enforceHasContractCode(address _contract) internal view {
uint256 contractSize;
// solhint-disable-next-line no-inline-assembly
assembly {
contractSize := extcodesize(_contract)
}
if (contractSize == 0) {
revert FacetContainsNoCode();
}
}
}
// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.25;
/// @title Pausable Library
/// @author 0xiDen
/// @notice This library provides pausable feature across entire diamond protected methods. Be advised only methods that call `enforceNotPaused` will be protected!
library LibPausable {
/// Storage ///
bytes32 private constant NAMESPACE = keccak256("exchange.rango.library.pausable");
/// Types ///
struct PausableStorage {
bool isPaused;
}
/// Events ///
/// @notice Notifies that Rango's paused state is updated
/// @param _oldPausedState The previous paused state
/// @param _newPausedState The new fee wallet address
event PausedStateUpdated(bool _oldPausedState, bool _newPausedState);
/// Errors ///
/// Constants ///
/// Modifiers ///
/// Internal Methods ///
/// @notice Sets the isPaused state for Rango
/// @param _paused The receiver wallet address
function updatePauseState(bool _paused) internal {
PausableStorage storage pausableStorage = getPausableStorage();
bool oldState = pausableStorage.isPaused;
pausableStorage.isPaused = _paused;
emit PausedStateUpdated(oldState, _paused);
}
function enforceNotPaused() internal view {
PausableStorage storage pausableStorage = getPausableStorage();
require(pausableStorage.isPaused == false, "Paused");
}
/// Private Methods ///
/// @dev fetch local storage
function getPausableStorage() private pure returns (PausableStorage storage data) {
bytes32 position = NAMESPACE;
// solhint-disable-next-line no-inline-assembly
assembly {
data.slot := position
}
}
}// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.25;
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "../interfaces/IWETH.sol";
import "../interfaces/IRango.sol";
/// @title BaseSwapper
/// @author 0xiden
/// @notice library to provide swap functionality
library LibSwapper {
bytes32 internal constant BASE_SWAPPER_NAMESPACE = keccak256("exchange.rango.library.swapper");
address payable constant ETH = payable(0x0000000000000000000000000000000000000000);
struct BaseSwapperStorage {
address payable feeContractAddress;
address WETH;
mapping(address => bool) whitelistContracts;
mapping(address => mapping(bytes4 => bool)) whitelistMethods;
}
/// @notice Emitted if any fee transfer was required
/// @param token The address of received token, address(0) for native
/// @param affiliatorAddress The address of affiliate wallet
/// @param platformFee The amount received as platform fee
/// @param destinationExecutorFee The amount received to execute transaction on destination (only for cross chain txs)
/// @param affiliateFee The amount received by affiliate
/// @param dAppTag Optional identifier to make tracking easier.
event FeeInfo(
address token,
address indexed affiliatorAddress,
uint platformFee,
uint destinationExecutorFee,
uint affiliateFee,
uint16 indexed dAppTag
);
/// @notice A call to another dex or contract done and here is the result
/// @param target The address of dex or contract that is called
/// @param success A boolean indicating that the call was success or not
/// @param returnData The response of function call
event CallResult(address target, bool success, bytes returnData);
/// @notice A swap request is done and we also emit the output
/// @param requestId Optional parameter to make tracking of transaction easier
/// @param fromToken Input token address to be swapped from
/// @param toToken Output token address to be swapped to
/// @param amountIn Input amount of fromToken that is being swapped
/// @param dAppTag Optional identifier to make tracking easier
/// @param outputAmount The output amount of the swap, measured by the balance change before and after the swap
/// @param receiver The address to receive the output of swap. Can be address(0) when swap is before a bridge action
/// @param dAppName The human readable name of the dApp
event RangoSwap(
address indexed requestId,
address fromToken,
address toToken,
uint amountIn,
uint minimumAmountExpected,
uint16 indexed dAppTag,
uint outputAmount,
address receiver,
string dAppName
);
/// @notice Output amount of a dex calls is logged
/// @param _token The address of output token, ZERO address for native
/// @param amount The amount of output
event DexOutput(address _token, uint amount);
/// @notice The output money (ERC20/Native) is sent to a wallet
/// @param _token The token that is sent to a wallet, ZERO address for native
/// @param _amount The sent amount
/// @param _receiver The receiver wallet address
event SendToken(address _token, uint256 _amount, address _receiver);
/// @notice Notifies that Rango's fee receiver address updated
/// @param _oldAddress The previous fee wallet address
/// @param _newAddress The new fee wallet address
event FeeContractAddressUpdated(address _oldAddress, address _newAddress);
/// @notice Notifies that WETH address is updated
/// @param _oldAddress The previous weth address
/// @param _newAddress The new weth address
event WethContractAddressUpdated(address _oldAddress, address _newAddress);
/// @notice Notifies that admin manually refunded some money
/// @param _token The address of refunded token, 0x000..00 address for native token
/// @param _amount The amount that is refunded
event Refunded(address _token, uint _amount);
/// @notice The requested call data which is computed off-chain and passed to the contract
/// @dev swapFromToken and amount parameters are only helper params and the actual amount and
/// token are set in callData
/// @param spender The contract which the approval is given to if swapFromToken is not native.
/// @param target The dex contract address that should be called
/// @param swapFromToken Token address of to be used in the swap.
/// @param amount The amount to be approved or native amount sent.
/// @param callData The required data field that should be give to the dex contract to perform swap
struct Call {
address spender;
address payable target;
address swapFromToken;
address swapToToken;
bool needsTransferFromUser;
uint amount;
bytes callData;
}
/// @notice General swap request which is given to us in all relevant functions
/// @param requestId The request id passed to make tracking transactions easier
/// @param fromToken The source token that is going to be swapped (in case of simple swap or swap + bridge) or the briding token (in case of solo bridge)
/// @param toToken The output token of swapping. This is the output of DEX step and is also input of bridging step
/// @param amountIn The amount of input token to be swapped
/// @param platformFee The amount of fee charged by platform
/// @param destinationExecutorFee The amount of fee required for relayer execution on the destination
/// @param affiliateFee The amount of fee charged by affiliator dApp
/// @param affiliatorAddress The wallet address that the affiliator fee should be sent to
/// @param minimumAmountExpected The minimum amount of toToken expected after executing Calls
/// @param feeFromInputToken If set to true, the fees will be taken from input token and otherwise, from output token. (platformFee,destinationExecutorFee,affiliateFee)
/// @param dAppTag An optional parameter
/// @param dAppName The Name of the dApp
struct SwapRequest {
address requestId;
address fromToken;
address toToken;
uint amountIn;
uint platformFee;
uint destinationExecutorFee;
uint affiliateFee;
address payable affiliatorAddress;
uint minimumAmountExpected;
bool feeFromInputToken;
uint16 dAppTag;
string dAppName;
}
/// @notice initializes the base swapper and sets the init params (such as Wrapped token address)
/// @param _weth Address of wrapped token (WETH, WBNB, etc.) on the current chain
function setWeth(address _weth) internal {
BaseSwapperStorage storage baseStorage = getBaseSwapperStorage();
address oldAddress = baseStorage.WETH;
baseStorage.WETH = _weth;
require(_weth != address(0), "Invalid WETH!");
emit WethContractAddressUpdated(oldAddress, _weth);
}
/// @notice Sets the wallet that receives Rango's fees from now on
/// @param _address The receiver wallet address
function updateFeeContractAddress(address payable _address) internal {
BaseSwapperStorage storage baseSwapperStorage = getBaseSwapperStorage();
address oldAddress = baseSwapperStorage.feeContractAddress;
baseSwapperStorage.feeContractAddress = _address;
emit FeeContractAddressUpdated(oldAddress, _address);
}
/// Whitelist ///
/// @notice Adds a contract to the whitelisted DEXes that can be called
/// @param contractAddress The address of the DEX
function addWhitelist(address contractAddress) internal {
BaseSwapperStorage storage baseStorage = getBaseSwapperStorage();
baseStorage.whitelistContracts[contractAddress] = true;
}
/// @notice Adds a method of contract to the whitelisted DEXes that can be called
/// @param contractAddress The address of the DEX
/// @param methodIds The method of the DEX
function addMethodWhitelists(address contractAddress, bytes4[] calldata methodIds) internal {
BaseSwapperStorage storage baseStorage = getBaseSwapperStorage();
baseStorage.whitelistContracts[contractAddress] = true;
for (uint i = 0; i < methodIds.length; i++)
baseStorage.whitelistMethods[contractAddress][methodIds[i]] = true;
}
/// @notice Adds a method of contract to the whitelisted DEXes that can be called
/// @param contractAddress The address of the DEX
/// @param methodId The method of the DEX
function addMethodWhitelist(address contractAddress, bytes4 methodId) internal {
BaseSwapperStorage storage baseStorage = getBaseSwapperStorage();
baseStorage.whitelistContracts[contractAddress] = true;
baseStorage.whitelistMethods[contractAddress][methodId] = true;
}
/// @notice Removes a contract from the whitelisted DEXes
/// @param contractAddress The address of the DEX or dApp
function removeWhitelist(address contractAddress) internal {
BaseSwapperStorage storage baseStorage = getBaseSwapperStorage();
delete baseStorage.whitelistContracts[contractAddress];
}
/// @notice Removes a method of contract from the whitelisted DEXes
/// @param contractAddress The address of the DEX or dApp
/// @param methodId The method of the DEX
function removeMethodWhitelist(address contractAddress, bytes4 methodId) internal {
BaseSwapperStorage storage baseStorage = getBaseSwapperStorage();
delete baseStorage.whitelistMethods[contractAddress][methodId];
}
function onChainSwapsPreBridge(
SwapRequest memory request,
Call[] calldata calls,
uint extraFee
) internal returns (uint out) {
uint minimumRequiredValue = getPreBridgeMinAmount(request) + extraFee;
require(msg.value >= minimumRequiredValue, 'Send more ETH to cover input amount + fee');
(, out) = onChainSwapsInternal(request, calls, extraFee);
// when there is a bridge after swap, set the receiver in swap event to address(0)
emitSwapEvent(request, out, ETH);
return out;
}
/// @notice Internal function to compute output amount of DEXes
/// @param request The general swap request containing from/to token and fee/affiliate rewards
/// @param calls The list of DEX calls
/// @param extraNativeFee The amount of native tokens to keep and not return to user as excess amount.
/// @return The response of all DEX calls and the output amount of the whole process
function onChainSwapsInternal(
SwapRequest memory request,
Call[] calldata calls,
uint256 extraNativeFee
) internal returns (bytes[] memory, uint) {
uint toBalanceBefore = getBalanceOf(request.toToken);
uint fromBalanceBefore = getBalanceOf(request.fromToken);
uint256[] memory initialBalancesList = getInitialBalancesList(calls);
// transfer tokens from user for SwapRequest and Calls that require transfer from user.
transferTokensFromUserForSwapRequest(request);
transferTokensFromUserForCalls(calls);
bytes[] memory result = callSwapsAndFees(request, calls);
// check if any extra tokens were taken from contract and return excess tokens if any.
returnExcessAmounts(request, calls, initialBalancesList);
// get balance after returning excesses.
uint fromBalanceAfter = getBalanceOf(request.fromToken);
// check over-expense of fromToken and return excess if any.
if (request.fromToken != ETH) {
require(fromBalanceAfter >= fromBalanceBefore, "Source token balance on contract must not decrease after swap");
if (fromBalanceAfter > fromBalanceBefore)
_sendToken(request.fromToken, fromBalanceAfter - fromBalanceBefore, msg.sender);
}
else {
require(fromBalanceAfter >= fromBalanceBefore - msg.value + extraNativeFee, "Source token balance on contract must not decrease after swap");
// When we are keeping extraNativeFee for bridgingFee, we should consider it in calculations.
if (fromBalanceAfter > fromBalanceBefore - msg.value + extraNativeFee)
_sendToken(request.fromToken, fromBalanceAfter + msg.value - fromBalanceBefore - extraNativeFee, msg.sender);
}
uint toBalanceAfter = getBalanceOf(request.toToken);
uint secondaryBalance = toBalanceAfter - toBalanceBefore;
require(secondaryBalance >= request.minimumAmountExpected, "Output is less than minimum expected");
return (result, secondaryBalance);
}
/// @notice Private function to handle fetching money from wallet to contract, reduce fee/affiliate, perform DEX calls
/// @param request The general swap request containing from/to token and fee/affiliate rewards
/// @param calls The list of DEX calls
/// @dev It checks the whitelisting of all DEX addresses + having enough msg.value as input
/// @return The bytes of all DEX calls response
function callSwapsAndFees(SwapRequest memory request, Call[] calldata calls) private returns (bytes[] memory) {
BaseSwapperStorage storage baseSwapperStorage = getBaseSwapperStorage();
for (uint256 i = 0; i < calls.length; i++) {
require(baseSwapperStorage.whitelistContracts[calls[i].spender], "Contract spender not whitelisted");
require(baseSwapperStorage.whitelistContracts[calls[i].target], "Contract target not whitelisted");
bytes4 sig = bytes4(calls[i].callData[: 4]);
require(baseSwapperStorage.whitelistMethods[calls[i].target][sig], "Unauthorized call data!");
}
// Get Fees Before swap
collectFeesBeforeSwap(request);
// Execute swap Calls
bytes[] memory returnData = new bytes[](calls.length);
address tmpSwapFromToken;
for (uint256 i = 0; i < calls.length; i++) {
tmpSwapFromToken = calls[i].swapFromToken;
bool isTokenNative = tmpSwapFromToken == ETH;
if (isTokenNative == false)
approveMax(tmpSwapFromToken, calls[i].spender, calls[i].amount);
(bool success, bytes memory ret) = isTokenNative
? calls[i].target.call{value : calls[i].amount}(calls[i].callData)
: calls[i].target.call(calls[i].callData);
emit CallResult(calls[i].target, success, ret);
if (!success)
revert(_getRevertMsg(ret));
returnData[i] = ret;
}
// Get Fees After swap
collectFeesAfterSwap(request);
return returnData;
}
/// @notice Approves an ERC20 token to a contract to transfer from the current contract
/// @param token The address of an ERC20 token
/// @param spender The contract address that should be approved
/// @param value The amount that should be approved
function approve(address token, address spender, uint value) internal {
SafeERC20.forceApprove(IERC20(token), spender, value);
}
/// @notice Approves an ERC20 token to a contract to transfer from the current contract, approves for inf value
/// @param token The address of an ERC20 token
/// @param spender The contract address that should be approved
/// @param value The desired allowance. If current allowance is less than this value, infinite allowance will be given
function approveMax(address token, address spender, uint value) internal {
uint256 currentAllowance = IERC20(token).allowance(address(this), spender);
if (currentAllowance < value) {
SafeERC20.forceApprove(IERC20(token), spender, type(uint256).max);
}
}
function _sendToken(address _token, uint256 _amount, address _receiver) internal {
(_token == ETH) ? _sendNative(_receiver, _amount) : SafeERC20.safeTransfer(IERC20(_token), _receiver, _amount);
}
function sumFees(IRango.RangoBridgeRequest memory request) internal pure returns (uint256) {
return request.platformFee + request.affiliateFee + request.destinationExecutorFee;
}
function sumFees(SwapRequest memory request) internal pure returns (uint256) {
return request.platformFee + request.affiliateFee + request.destinationExecutorFee;
}
function getPreBridgeMinAmount(SwapRequest memory request) internal pure returns (uint256) {
bool isNative = request.fromToken == ETH;
if (request.feeFromInputToken) {
return (isNative ? request.platformFee + request.affiliateFee + request.amountIn + request.destinationExecutorFee : 0);
}
return (isNative ? request.amountIn : 0);
}
function collectFeesForSwap(SwapRequest memory request) internal {
BaseSwapperStorage storage baseSwapperStorage = getBaseSwapperStorage();
// Get Platform fee
bool hasPlatformFee = request.platformFee > 0;
bool hasDestExecutorFee = request.destinationExecutorFee > 0;
bool hasAffiliateFee = request.affiliateFee > 0;
address feeToken = request.feeFromInputToken ? request.fromToken : request.toToken;
if (hasPlatformFee || hasDestExecutorFee) {
require(baseSwapperStorage.feeContractAddress != ETH, "Fee contract address not set");
_sendToken(feeToken, request.platformFee + request.destinationExecutorFee, baseSwapperStorage.feeContractAddress, false);
}
// Get affiliate fee
if (hasAffiliateFee) {
require(request.affiliatorAddress != ETH, "Invalid affiliatorAddress");
_sendToken(feeToken, request.affiliateFee, request.affiliatorAddress, false);
}
// emit Fee event
if (hasPlatformFee || hasDestExecutorFee || hasAffiliateFee) {
emit FeeInfo(
feeToken,
request.affiliatorAddress,
request.platformFee,
request.destinationExecutorFee,
request.affiliateFee,
request.dAppTag
);
}
}
function collectFees(IRango.RangoBridgeRequest memory request) internal {
// Get Platform fee
bool hasPlatformFee = request.platformFee > 0;
bool hasDestExecutorFee = request.destinationExecutorFee > 0;
bool hasAffiliateFee = request.affiliateFee > 0;
bool hasAnyFee = hasPlatformFee || hasDestExecutorFee || hasAffiliateFee;
if (!hasAnyFee) {
return;
}
BaseSwapperStorage storage baseSwapperStorage = getBaseSwapperStorage();
if (hasPlatformFee || hasDestExecutorFee) {
require(baseSwapperStorage.feeContractAddress != ETH, "Fee contract address not set");
_sendToken(request.token, request.platformFee + request.destinationExecutorFee, baseSwapperStorage.feeContractAddress, false);
}
// Get affiliate fee
if (hasAffiliateFee) {
require(request.affiliatorAddress != ETH, "Invalid affiliatorAddress");
_sendToken(request.token, request.affiliateFee, request.affiliatorAddress, false);
}
// emit Fee event
emit FeeInfo(
request.token,
request.affiliatorAddress,
request.platformFee,
request.destinationExecutorFee,
request.affiliateFee,
request.dAppTag
);
}
function collectFeesBeforeSwap(SwapRequest memory request) internal {
if (request.feeFromInputToken) {
collectFeesForSwap(request);
}
}
function collectFeesAfterSwap(SwapRequest memory request) internal {
if (!request.feeFromInputToken) {
collectFeesForSwap(request);
}
}
function collectFeesFromSender(IRango.RangoBridgeRequest memory request) internal {
// Get Platform fee
bool hasPlatformFee = request.platformFee > 0;
bool hasDestExecutorFee = request.destinationExecutorFee > 0;
bool hasAffiliateFee = request.affiliateFee > 0;
bool hasAnyFee = hasPlatformFee || hasDestExecutorFee || hasAffiliateFee;
if (!hasAnyFee) {
return;
}
bool isSourceNative = request.token == ETH;
BaseSwapperStorage storage baseSwapperStorage = getBaseSwapperStorage();
if (hasPlatformFee || hasDestExecutorFee) {
require(baseSwapperStorage.feeContractAddress != ETH, "Fee contract address not set");
if (isSourceNative)
_sendToken(request.token, request.platformFee + request.destinationExecutorFee, baseSwapperStorage.feeContractAddress, false);
else
SafeERC20.safeTransferFrom(
IERC20(request.token),
msg.sender,
baseSwapperStorage.feeContractAddress,
request.platformFee + request.destinationExecutorFee
);
}
// Get affiliate fee
if (hasAffiliateFee) {
require(request.affiliatorAddress != ETH, "Invalid affiliatorAddress");
if (isSourceNative)
_sendToken(request.token, request.affiliateFee, request.affiliatorAddress, false);
else
SafeERC20.safeTransferFrom(
IERC20(request.token),
msg.sender,
request.affiliatorAddress,
request.affiliateFee
);
}
// emit Fee event
emit FeeInfo(
request.token,
request.affiliatorAddress,
request.platformFee,
request.destinationExecutorFee,
request.affiliateFee,
request.dAppTag
);
}
/// @notice An internal function to send a token from the current contract to another contract or wallet
/// @dev This function also can convert WETH to ETH before sending if _withdraw flat is set to true
/// @dev To send native token _token param should be set to address zero, otherwise we assume it's an ERC20 transfer
/// @param _token The token that is going to be sent to a wallet, ZERO address for native
/// @param _amount The sent amount
/// @param _receiver The receiver wallet address or contract
/// @param _withdraw If true, indicates that we should swap WETH to ETH before sending the money and _nativeOut must also be true
function _sendToken(
address _token,
uint256 _amount,
address _receiver,
bool _withdraw
) internal {
BaseSwapperStorage storage baseStorage = getBaseSwapperStorage();
emit SendToken(_token, _amount, _receiver);
bool nativeOut = _token == LibSwapper.ETH;
if (_withdraw) {
require(_token == baseStorage.WETH, "token mismatch");
IWETH(baseStorage.WETH).withdraw(_amount);
nativeOut = true;
}
if (nativeOut) {
_sendNative(_receiver, _amount);
} else {
SafeERC20.safeTransfer(IERC20(_token), _receiver, _amount);
}
}
/// @notice An internal function to send native token to a contract or wallet
/// @param _receiver The address that will receive the native token
/// @param _amount The amount of the native token that should be sent
function _sendNative(address _receiver, uint _amount) internal {
(bool sent,) = _receiver.call{value : _amount}("");
require(sent, "failed to send native");
}
/// @notice A utility function to fetch storage from a predefined random slot using assembly
/// @return s The storage object
function getBaseSwapperStorage() internal pure returns (BaseSwapperStorage storage s) {
bytes32 namespace = BASE_SWAPPER_NAMESPACE;
// solhint-disable-next-line no-inline-assembly
assembly {
s.slot := namespace
}
}
/// @notice To extract revert message from a DEX/contract call to represent to the end-user in the blockchain
/// @param _returnData The resulting bytes of a failed call to a DEX or contract
/// @return A string that describes what was the error
function _getRevertMsg(bytes memory _returnData) internal pure returns (string memory) {
// If the _res length is less than 68, then the transaction failed silently (without a revert message)
if (_returnData.length < 68) return 'Transaction reverted silently';
assembly {
// Slice the sighash.
_returnData := add(_returnData, 0x04)
}
return abi.decode(_returnData, (string));
// All that remains is the revert string
}
function getBalanceOf(address token) internal view returns (uint) {
return token == ETH ? address(this).balance : IERC20(token).balanceOf(address(this));
}
/// @notice Fetches the balances of swapToTokens.
/// @dev this fetches the balances for swapToToken of swap Calls. If native eth is received, the balance has already increased so we subtract msg.value.
function getInitialBalancesList(Call[] calldata calls) internal view returns (uint256[] memory) {
uint callsLength = calls.length;
uint256[] memory balancesList = new uint256[](callsLength);
address token;
for (uint256 i = 0; i < callsLength; i++) {
token = calls[i].swapToToken;
balancesList[i] = getBalanceOf(token);
if (token == ETH)
balancesList[i] -= msg.value;
}
return balancesList;
}
/// This function transfers tokens from users based on the SwapRequest, it transfers amountIn + fees.
function transferTokensFromUserForSwapRequest(SwapRequest memory request) private {
uint transferAmount = request.amountIn + (request.feeFromInputToken ? sumFees(request) : 0);
if (request.fromToken != ETH)
SafeERC20.safeTransferFrom(IERC20(request.fromToken), msg.sender, address(this), transferAmount);
else
require(msg.value >= transferAmount);
}
/// This function iterates on calls and if needsTransferFromUser, transfers tokens from user
function transferTokensFromUserForCalls(Call[] calldata calls) private {
uint callsLength = calls.length;
Call calldata call;
address token;
for (uint256 i = 0; i < callsLength; i++) {
call = calls[i];
token = call.swapFromToken;
if (call.needsTransferFromUser && token != ETH)
SafeERC20.safeTransferFrom(IERC20(call.swapFromToken), msg.sender, address(this), call.amount);
}
}
/// @dev returns any excess token left by the contract.
/// We iterate over `swapToToken`s because each swapToToken is either the request.toToken or is the output of
/// another `Call` in the list of swaps which itself either has transferred tokens from user,
/// or is a middle token that is the output of another `Call`.
function returnExcessAmounts(
SwapRequest memory request,
Call[] calldata calls,
uint256[] memory initialBalancesList) internal {
uint excessAmountToToken;
address tmpSwapToToken;
uint currentBalanceTo;
for (uint256 i = 0; i < calls.length; i++) {
tmpSwapToToken = calls[i].swapToToken;
currentBalanceTo = getBalanceOf(tmpSwapToToken);
excessAmountToToken = currentBalanceTo - initialBalancesList[i];
if (excessAmountToToken > 0 && tmpSwapToToken != request.toToken) {
_sendToken(tmpSwapToToken, excessAmountToToken, msg.sender);
}
}
}
function emitSwapEvent(SwapRequest memory request, uint output, address receiver) internal {
emit RangoSwap(
request.requestId,
request.fromToken,
request.toToken,
request.amountIn,
request.minimumAmountExpected,
request.dAppTag,
output,
receiver,
request.dAppName
);
}
}
// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.25;
library LibTransform {
function addressToString(address a) internal pure returns (string memory) {
bytes memory data = abi.encodePacked(a);
bytes memory characters = '0123456789abcdef';
bytes memory byteString = new bytes(2 + data.length * 2);
byteString[0] = '0';
byteString[1] = 'x';
for (uint256 i; i < data.length; ++i) {
byteString[2 + i * 2] = characters[uint256(uint8(data[i] >> 4))];
byteString[3 + i * 2] = characters[uint256(uint8(data[i] & 0x0f))];
}
return string(byteString);
}
function bytesToAddress(bytes memory bs) internal pure returns (address addr) {
return address(uint160(bytes20(bs)));
}
function addressToBytes32LeftPadded(address addr) internal pure returns (bytes32) {
return bytes32(uint256(uint160(addr)));
}
function bytes32LeftPaddedToAddress(bytes32 b) internal pure returns (address){
return address(uint160(uint256(b)));
}
function stringToBytes(string memory s) internal pure returns (bytes memory){
bytes memory b3 = bytes(s);
return b3;
}
function stringToAddress(string memory s) internal pure returns (address){
return bytesToAddress(stringToBytes(s));
}
function extractAddressFromEndOfBytes(bytes calldata bs) internal pure returns (address){
if (bs.length < 20)
return bytesToAddress(bs);
return bytesToAddress(bs[bs.length - 20 :]);
}
function extractAddressWithOffsetFromEnd(bytes calldata bs, uint256 offset) internal pure returns (address){
if (bs.length < 20 || bs.length < offset)
return bytesToAddress(bs);
return bytesToAddress(bs[bs.length - offset :]);
}
}// SPDX-License-Identifier: LGPL-3.0-only
pragma solidity 0.8.25;
/// @title Reentrancy Guard
/// @author
/// @notice Abstract contract to provide protection against reentrancy
abstract contract ReentrancyGuard {
/// Storage ///
bytes32 private constant NAMESPACE = keccak256("exchange.rango.reentrancyguard");
/// Types ///
struct ReentrancyStorage {
uint256 status;
}
/// Errors ///
error ReentrancyError();
/// Constants ///
uint256 private constant _NOT_ENTERED = 0;
uint256 private constant _ENTERED = 1;
/// Modifiers ///
modifier nonReentrant() {
ReentrancyStorage storage s = reentrancyStorage();
if (s.status == _ENTERED) revert ReentrancyError();
s.status = _ENTERED;
_;
s.status = _NOT_ENTERED;
}
/// Private Methods ///
/// @dev fetch local storage
function reentrancyStorage() private pure returns (ReentrancyStorage storage data) {
bytes32 position = NAMESPACE;
// solhint-disable-next-line no-inline-assembly
assembly {
data.slot := position
}
}
}