Transaction Hash:
Block:
19346815 at Mar-02-2024 10:13:59 AM +UTC
Transaction Fee:
0.00474421097473568 ETH
$11.99
Gas Used:
115,136 Gas / 41.205278755 Gwei
Emitted Events:
191 |
TransparentUpgradeableProxy.0xea3b023b4c8680d4b4824f0143132c95476359a2bb70a81d6c5a36f6918f6339( 0xea3b023b4c8680d4b4824f0143132c95476359a2bb70a81d6c5a36f6918f6339, 0x00000000000000000000000000000000000000000000000000000000000808df, 0xc762a9748ba0f13b53f71b8b266e2e44802d688ba6cffe08c356cca9778030be, 0xa18885fc69a72f80543f58f2c62b4007d2a766d94a9f125ad0b27480f81f7911 )
|
192 |
TransparentUpgradeableProxy.0xe856c2b8bd4eb0027ce32eeaf595c21b0b6b4644b326e5b7bd80a1cf8db72e6c( 0xe856c2b8bd4eb0027ce32eeaf595c21b0b6b4644b326e5b7bd80a1cf8db72e6c, 0x000000000000000000000000789ac91519a3344e4845e12870f3364e7df26d23, 0x000000000000000000000000cbb852a6274e03fa00fb4895de0463f66df27a11, 0xa18885fc69a72f80543f58f2c62b4007d2a766d94a9f125ad0b27480f81f7911, 0000000000000000000000000000000000000000000000000000000000000000, 0000000000000000000000000000000000000000000000000000000000000000, 00000000000000000000000000000000000000000000000000000000000808df, 0000000000000000000000000000000000000000000000000000000000000080, 00000000000000000000000000000000000000000000000000000000000000c4, cc29a306000000000000000000000000acc3c946bdacd741989f1880d160753b, 55f7d82c00000000000000000000000000000000000000000000000004d2bee2, 33afe00000000000000000000000000000000000000000000000000004cc9268, c03a84000000000000000000000000000000000000000000000000000000018e, 22b3aa28000000000000000000000000710bda329b2a6224e4b44833de30f38e, 7f81d56400000000000000000000000000000000000000000000000000049e57, d635400000000000000000000000000000000000000000000000000000000000 )
|
193 |
L1_ETH_Bridge.TransferSentToL2( chainId=59144, recipient=[Sender] 0xacc3c946bdacd741989f1880d160753b55f7d82c, amount=347550000000000000, amountOutMin=345812250000000000, deadline=1709979183656, relayer=0x710bDa32...E7f81d564, relayerFee=1300000000000000 )
|
194 |
SocketGateway.0x74594da9e31ee4068e17809037db37db496702bf7d8d63afe6f97949277d1609( 0x74594da9e31ee4068e17809037db37db496702bf7d8d63afe6f97949277d1609, 00000000000000000000000000000000000000000000000004d2bee233afe000, 000000000000000000000000eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee, 000000000000000000000000000000000000000000000000000000000000e708, 837ed841e30438f54fb6b0097c30a5c4f64b47545c3df655bcd6e44bb8991e37, 000000000000000000000000acc3c946bdacd741989f1880d160753b55f7d82c, 000000000000000000000000acc3c946bdacd741989f1880d160753b55f7d82c, 00000000000000000000000000000000000000000000000000000000000008c8 )
|
Account State Difference:
Address | Before | After | State Difference | ||
---|---|---|---|---|---|
0x538da63D...81B0655d7
Miner
| (MEV Builder: 0x538d...5d7) | 1.696693896947351698 Eth | 1.696694736400588754 Eth | 0.000000839453237056 | |
0xacc3c946...B55f7d82C |
0.427172750635782341 Eth
Nonce: 45
|
0.074878539661046661 Eth
Nonce: 46
| 0.35229421097473568 | ||
0xb8901acB...02919727f | (Hop Protocol: Ethereum Bridge) | 11,291.989904798373008455 Eth | 11,292.337454798373008455 Eth | 0.34755 | |
0xd19d4B5d...D11B0876F | (Linea: L1 Message Service) |
Execution Trace
ETH 0.34755
SocketGateway.00000014( )
ETH 0.34755
0x2197a1d9af24b4d6a64bff95b4c29fcd3ff28c30.d025dec0( )
ETH 0.34755
L1_ETH_Bridge.sendToL2( chainId=59144, recipient=0xacc3c946bdAcd741989f1880D160753B55f7d82C, amount=347550000000000000, amountOutMin=345812250000000000, deadline=1709979183656, relayer=0x710bDa329b2a6224E4B44833DE30F38E7f81d564, relayerFee=1300000000000000 )
LineaMessengerWrapper.sendCrossDomainMessage( _calldata=0xCC29A306000000000000000000000000ACC3C946BDACD741989F1880D160753B55F7D82C00000000000000000000000000000000000000000000000004D2BEE233AFE00000000000000000000000000000000000000000000000000004CC9268C03A84000000000000000000000000000000000000000000000000000000018E22B3AA28000000000000000000000000710BDA329B2A6224E4B44833DE30F38E7F81D56400000000000000000000000000000000000000000000000000049E57D6354000 )
TransparentUpgradeableProxy.9f3ce55a( )
-
LineaRollup.sendMessage( _to=0xCbb852A6274e03fA00fb4895dE0463f66dF27a11, _fee=0, _calldata=0xCC29A306000000000000000000000000ACC3C946BDACD741989F1880D160753B55F7D82C00000000000000000000000000000000000000000000000004D2BEE233AFE00000000000000000000000000000000000000000000000000004CC9268C03A84000000000000000000000000000000000000000000000000000000018E22B3AA28000000000000000000000000710BDA329B2A6224E4B44833DE30F38E7F81D56400000000000000000000000000000000000000000000000000049E57D6354000 )
-
File 1 of 5: SocketGateway
File 2 of 5: TransparentUpgradeableProxy
File 3 of 5: L1_ETH_Bridge
File 4 of 5: LineaMessengerWrapper
File 5 of 5: LineaRollup
// SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; /// @notice Modern and gas efficient ERC20 + EIP-2612 implementation. /// @author Solmate (https://github.com/transmissions11/solmate/blob/main/src/tokens/ERC20.sol) /// @author Modified from Uniswap (https://github.com/Uniswap/uniswap-v2-core/blob/master/contracts/UniswapV2ERC20.sol) /// @dev Do not manually set balances without updating totalSupply, as the sum of all user balances must not exceed it. abstract contract ERC20 { /*////////////////////////////////////////////////////////////// EVENTS //////////////////////////////////////////////////////////////*/ event Transfer(address indexed from, address indexed to, uint256 amount); event Approval(address indexed owner, address indexed spender, uint256 amount); /*////////////////////////////////////////////////////////////// METADATA STORAGE //////////////////////////////////////////////////////////////*/ string public name; string public symbol; uint8 public immutable decimals; /*////////////////////////////////////////////////////////////// ERC20 STORAGE //////////////////////////////////////////////////////////////*/ uint256 public totalSupply; mapping(address => uint256) public balanceOf; mapping(address => mapping(address => uint256)) public allowance; /*////////////////////////////////////////////////////////////// EIP-2612 STORAGE //////////////////////////////////////////////////////////////*/ uint256 internal immutable INITIAL_CHAIN_ID; bytes32 internal immutable INITIAL_DOMAIN_SEPARATOR; mapping(address => uint256) public nonces; /*////////////////////////////////////////////////////////////// CONSTRUCTOR //////////////////////////////////////////////////////////////*/ constructor( string memory _name, string memory _symbol, uint8 _decimals ) { name = _name; symbol = _symbol; decimals = _decimals; INITIAL_CHAIN_ID = block.chainid; INITIAL_DOMAIN_SEPARATOR = computeDomainSeparator(); } /*////////////////////////////////////////////////////////////// ERC20 LOGIC //////////////////////////////////////////////////////////////*/ function approve(address spender, uint256 amount) public virtual returns (bool) { allowance[msg.sender][spender] = amount; emit Approval(msg.sender, spender, amount); return true; } function transfer(address to, uint256 amount) public virtual returns (bool) { balanceOf[msg.sender] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(msg.sender, to, amount); return true; } function transferFrom( address from, address to, uint256 amount ) public virtual returns (bool) { uint256 allowed = allowance[from][msg.sender]; // Saves gas for limited approvals. if (allowed != type(uint256).max) allowance[from][msg.sender] = allowed - amount; balanceOf[from] -= amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(from, to, amount); return true; } /*////////////////////////////////////////////////////////////// EIP-2612 LOGIC //////////////////////////////////////////////////////////////*/ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) public virtual { require(deadline >= block.timestamp, "PERMIT_DEADLINE_EXPIRED"); // Unchecked because the only math done is incrementing // the owner's nonce which cannot realistically overflow. unchecked { address recoveredAddress = ecrecover( keccak256( abi.encodePacked( "\\x19\\x01", DOMAIN_SEPARATOR(), keccak256( abi.encode( keccak256( "Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)" ), owner, spender, value, nonces[owner]++, deadline ) ) ) ), v, r, s ); require(recoveredAddress != address(0) && recoveredAddress == owner, "INVALID_SIGNER"); allowance[recoveredAddress][spender] = value; } emit Approval(owner, spender, value); } function DOMAIN_SEPARATOR() public view virtual returns (bytes32) { return block.chainid == INITIAL_CHAIN_ID ? INITIAL_DOMAIN_SEPARATOR : computeDomainSeparator(); } function computeDomainSeparator() internal view virtual returns (bytes32) { return keccak256( abi.encode( keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"), keccak256(bytes(name)), keccak256("1"), block.chainid, address(this) ) ); } /*////////////////////////////////////////////////////////////// INTERNAL MINT/BURN LOGIC //////////////////////////////////////////////////////////////*/ function _mint(address to, uint256 amount) internal virtual { totalSupply += amount; // Cannot overflow because the sum of all user // balances can't exceed the max uint256 value. unchecked { balanceOf[to] += amount; } emit Transfer(address(0), to, amount); } function _burn(address from, uint256 amount) internal virtual { balanceOf[from] -= amount; // Cannot underflow because a user's balance // will never be larger than the total supply. unchecked { totalSupply -= amount; } emit Transfer(from, address(0), amount); } } // SPDX-License-Identifier: AGPL-3.0-only pragma solidity >=0.8.0; import {ERC20} from "../tokens/ERC20.sol"; /// @notice Safe ETH and ERC20 transfer library that gracefully handles missing return values. /// @author Solmate (https://github.com/transmissions11/solmate/blob/main/src/utils/SafeTransferLib.sol) /// @dev Use with caution! Some functions in this library knowingly create dirty bits at the destination of the free memory pointer. /// @dev Note that none of the functions in this library check that a token has code at all! That responsibility is delegated to the caller. library SafeTransferLib { /*////////////////////////////////////////////////////////////// ETH OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferETH(address to, uint256 amount) internal { bool success; /// @solidity memory-safe-assembly assembly { // Transfer the ETH and store if it succeeded or not. success := call(gas(), to, amount, 0, 0, 0, 0) } require(success, "ETH_TRANSFER_FAILED"); } /*////////////////////////////////////////////////////////////// ERC20 OPERATIONS //////////////////////////////////////////////////////////////*/ function safeTransferFrom( ERC20 token, address from, address to, uint256 amount ) internal { bool success; /// @solidity memory-safe-assembly assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata into memory, beginning with the function selector. mstore(freeMemoryPointer, 0x23b872dd00000000000000000000000000000000000000000000000000000000) mstore(add(freeMemoryPointer, 4), from) // Append the "from" argument. mstore(add(freeMemoryPointer, 36), to) // Append the "to" argument. mstore(add(freeMemoryPointer, 68), amount) // Append the "amount" argument. success := and( // Set success to whether the call reverted, if not we check it either // returned exactly 1 (can't just be non-zero data), or had no return data. or(and(eq(mload(0), 1), gt(returndatasize(), 31)), iszero(returndatasize())), // We use 100 because the length of our calldata totals up like so: 4 + 32 * 3. // We use 0 and 32 to copy up to 32 bytes of return data into the scratch space. // Counterintuitively, this call must be positioned second to the or() call in the // surrounding and() call or else returndatasize() will be zero during the computation. call(gas(), token, 0, freeMemoryPointer, 100, 0, 32) ) } require(success, "TRANSFER_FROM_FAILED"); } function safeTransfer( ERC20 token, address to, uint256 amount ) internal { bool success; /// @solidity memory-safe-assembly assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata into memory, beginning with the function selector. mstore(freeMemoryPointer, 0xa9059cbb00000000000000000000000000000000000000000000000000000000) mstore(add(freeMemoryPointer, 4), to) // Append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Append the "amount" argument. success := and( // Set success to whether the call reverted, if not we check it either // returned exactly 1 (can't just be non-zero data), or had no return data. or(and(eq(mload(0), 1), gt(returndatasize(), 31)), iszero(returndatasize())), // We use 68 because the length of our calldata totals up like so: 4 + 32 * 2. // We use 0 and 32 to copy up to 32 bytes of return data into the scratch space. // Counterintuitively, this call must be positioned second to the or() call in the // surrounding and() call or else returndatasize() will be zero during the computation. call(gas(), token, 0, freeMemoryPointer, 68, 0, 32) ) } require(success, "TRANSFER_FAILED"); } function safeApprove( ERC20 token, address to, uint256 amount ) internal { bool success; /// @solidity memory-safe-assembly assembly { // Get a pointer to some free memory. let freeMemoryPointer := mload(0x40) // Write the abi-encoded calldata into memory, beginning with the function selector. mstore(freeMemoryPointer, 0x095ea7b300000000000000000000000000000000000000000000000000000000) mstore(add(freeMemoryPointer, 4), to) // Append the "to" argument. mstore(add(freeMemoryPointer, 36), amount) // Append the "amount" argument. success := and( // Set success to whether the call reverted, if not we check it either // returned exactly 1 (can't just be non-zero data), or had no return data. or(and(eq(mload(0), 1), gt(returndatasize(), 31)), iszero(returndatasize())), // We use 68 because the length of our calldata totals up like so: 4 + 32 * 2. // We use 0 and 32 to copy up to 32 bytes of return data into the scratch space. // Counterintuitively, this call must be positioned second to the or() call in the // surrounding and() call or else returndatasize() will be zero during the computation. call(gas(), token, 0, freeMemoryPointer, 68, 0, 32) ) } require(success, "APPROVE_FAILED"); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import "./interfaces/across.sol"; import "../BridgeImplBase.sol"; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {ACROSS} from "../../static/RouteIdentifiers.sol"; /** * @title Across-Route Implementation * @notice Route implementation with functions to bridge ERC20 and Native via Across-Bridge * Called via SocketGateway if the routeId in the request maps to the routeId of AcrossImplementation * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract AcrossImpl is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable AcrossIdentifier = ACROSS; /// @notice Function-selector for ERC20-token bridging on Across-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable ACROSS_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(uint256,uint256,bytes32,address,address,uint32,uint64)" ) ); /// @notice Function-selector for Native bridging on Across-Route /// @dev This function selector is to be used while buidling transaction-data to bridge Native tokens bytes4 public immutable ACROSS_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeNativeTo(uint256,uint256,bytes32,address,uint32,uint64)" ) ); bytes4 public immutable ACROSS_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(uint256,address,uint32,uint64,bytes32))" ) ); /// @notice spokePool Contract instance used to deposit ERC20 and Native on to Across-Bridge /// @dev contract instance is to be initialized in the constructor using the spokePoolAddress passed as constructor argument SpokePool public immutable spokePool; address public immutable spokePoolAddress; /// @notice address of WETH token to be initialised in constructor address public immutable WETH; /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct AcrossBridgeDataNoToken { uint256 toChainId; address receiverAddress; uint32 quoteTimestamp; uint64 relayerFeePct; bytes32 metadata; } struct AcrossBridgeData { uint256 toChainId; address receiverAddress; address token; uint32 quoteTimestamp; uint64 relayerFeePct; bytes32 metadata; } /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase /// @dev ensure spokepool, weth-address are set properly for the chainId in which the contract is being deployed constructor( address _spokePool, address _wethAddress, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { spokePool = SpokePool(_spokePool); spokePoolAddress = _spokePool; WETH = _wethAddress; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in AcrossBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for AcrossBridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { AcrossBridgeData memory acrossBridgeData = abi.decode( bridgeData, (AcrossBridgeData) ); if (acrossBridgeData.token == NATIVE_TOKEN_ADDRESS) { spokePool.deposit{value: amount}( acrossBridgeData.receiverAddress, WETH, amount, acrossBridgeData.toChainId, acrossBridgeData.relayerFeePct, acrossBridgeData.quoteTimestamp ); } else { spokePool.deposit( acrossBridgeData.receiverAddress, acrossBridgeData.token, amount, acrossBridgeData.toChainId, acrossBridgeData.relayerFeePct, acrossBridgeData.quoteTimestamp ); } emit SocketBridge( amount, acrossBridgeData.token, acrossBridgeData.toChainId, AcrossIdentifier, msg.sender, acrossBridgeData.receiverAddress, acrossBridgeData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in AcrossBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param acrossBridgeData encoded data for AcrossBridge */ function swapAndBridge( uint32 swapId, bytes calldata swapData, AcrossBridgeDataNoToken calldata acrossBridgeData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); if (token == NATIVE_TOKEN_ADDRESS) { spokePool.deposit{value: bridgeAmount}( acrossBridgeData.receiverAddress, WETH, bridgeAmount, acrossBridgeData.toChainId, acrossBridgeData.relayerFeePct, acrossBridgeData.quoteTimestamp ); } else { spokePool.deposit( acrossBridgeData.receiverAddress, token, bridgeAmount, acrossBridgeData.toChainId, acrossBridgeData.relayerFeePct, acrossBridgeData.quoteTimestamp ); } emit SocketBridge( bridgeAmount, token, acrossBridgeData.toChainId, AcrossIdentifier, msg.sender, acrossBridgeData.receiverAddress, acrossBridgeData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Across-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount being bridged * @param toChainId destination ChainId * @param receiverAddress address of receiver of bridged tokens * @param token address of token being bridged * @param quoteTimestamp timestamp for quote and this is to be used by Across-Bridge contract * @param relayerFeePct feePct that will be relayed by the Bridge to the relayer */ function bridgeERC20To( uint256 amount, uint256 toChainId, bytes32 metadata, address receiverAddress, address token, uint32 quoteTimestamp, uint64 relayerFeePct ) external payable { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); spokePool.deposit( receiverAddress, address(token), amount, toChainId, relayerFeePct, quoteTimestamp ); emit SocketBridge( amount, token, toChainId, AcrossIdentifier, msg.sender, receiverAddress, metadata ); } /** * @notice function to handle Native bridging to receipent via Across-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount being bridged * @param toChainId destination ChainId * @param receiverAddress address of receiver of bridged tokens * @param quoteTimestamp timestamp for quote and this is to be used by Across-Bridge contract * @param relayerFeePct feePct that will be relayed by the Bridge to the relayer */ function bridgeNativeTo( uint256 amount, uint256 toChainId, bytes32 metadata, address receiverAddress, uint32 quoteTimestamp, uint64 relayerFeePct ) external payable { spokePool.deposit{value: amount}( receiverAddress, WETH, amount, toChainId, relayerFeePct, quoteTimestamp ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, toChainId, AcrossIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; /// @notice interface with functions to interact with SpokePool contract of Across-Bridge interface SpokePool { /************************************** * DEPOSITOR FUNCTIONS * **************************************/ /** * @notice Called by user to bridge funds from origin to destination chain. Depositor will effectively lock * tokens in this contract and receive a destination token on the destination chain. The origin => destination * token mapping is stored on the L1 HubPool. * @notice The caller must first approve this contract to spend amount of originToken. * @notice The originToken => destinationChainId must be enabled. * @notice This method is payable because the caller is able to deposit native token if the originToken is * wrappedNativeToken and this function will handle wrapping the native token to wrappedNativeToken. * @param recipient Address to receive funds at on destination chain. * @param originToken Token to lock into this contract to initiate deposit. * @param amount Amount of tokens to deposit. Will be amount of tokens to receive less fees. * @param destinationChainId Denotes network where user will receive funds from SpokePool by a relayer. * @param relayerFeePct % of deposit amount taken out to incentivize a fast relayer. * @param quoteTimestamp Timestamp used by relayers to compute this deposit's realizedLPFeePct which is paid * to LP pool on HubPool. */ function deposit( address recipient, address originToken, uint256 amount, uint256 destinationChainId, uint64 relayerFeePct, uint32 quoteTimestamp ) external payable; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {BridgeImplBase} from "../../BridgeImplBase.sol"; import {ANYSWAP} from "../../../static/RouteIdentifiers.sol"; /** * @title Anyswap-V4-Route L1 Implementation * @notice Route implementation with functions to bridge ERC20 via Anyswap-Bridge * Called via SocketGateway if the routeId in the request maps to the routeId of AnyswapImplementation * This is the L1 implementation, so this is used when transferring from l1 to supported l1s or L1. * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ /// @notice Interface to interact with AnyswapV4-Router Implementation interface AnyswapV4Router { function anySwapOutUnderlying( address token, address to, uint256 amount, uint256 toChainID ) external; } contract AnyswapImplL1 is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable AnyswapIdentifier = ANYSWAP; /// @notice Function-selector for ERC20-token bridging on Anyswap-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable ANYSWAP_L1_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(uint256,uint256,bytes32,address,address,address)" ) ); bytes4 public immutable ANYSWAP_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(uint256,address,address,bytes32))" ) ); /// @notice AnSwapV4Router Contract instance used to deposit ERC20 on to Anyswap-Bridge /// @dev contract instance is to be initialized in the constructor using the router-address passed as constructor argument AnyswapV4Router public immutable router; /** * @notice Constructor sets the router address and socketGateway address. * @dev anyswap 4 router is immutable. so no setter function required. */ constructor( address _router, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { router = AnyswapV4Router(_router); } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct AnyswapBridgeDataNoToken { /// @notice destination ChainId uint256 toChainId; /// @notice address of receiver of bridged tokens address receiverAddress; /// @notice address of wrapperToken, WrappedVersion of the token being bridged address wrapperTokenAddress; /// @notice socket offchain created hash bytes32 metadata; } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct AnyswapBridgeData { /// @notice destination ChainId uint256 toChainId; /// @notice address of receiver of bridged tokens address receiverAddress; /// @notice address of wrapperToken, WrappedVersion of the token being bridged address wrapperTokenAddress; /// @notice address of token being bridged address token; /// @notice socket offchain created hash bytes32 metadata; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in AnyswapBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for AnyswapBridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { AnyswapBridgeData memory anyswapBridgeData = abi.decode( bridgeData, (AnyswapBridgeData) ); ERC20(anyswapBridgeData.token).safeApprove(address(router), amount); router.anySwapOutUnderlying( anyswapBridgeData.wrapperTokenAddress, anyswapBridgeData.receiverAddress, amount, anyswapBridgeData.toChainId ); emit SocketBridge( amount, anyswapBridgeData.token, anyswapBridgeData.toChainId, AnyswapIdentifier, msg.sender, anyswapBridgeData.receiverAddress, anyswapBridgeData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in AnyswapBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param anyswapBridgeData encoded data for AnyswapBridge */ function swapAndBridge( uint32 swapId, bytes calldata swapData, AnyswapBridgeDataNoToken calldata anyswapBridgeData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); ERC20(token).safeApprove(address(router), bridgeAmount); router.anySwapOutUnderlying( anyswapBridgeData.wrapperTokenAddress, anyswapBridgeData.receiverAddress, bridgeAmount, anyswapBridgeData.toChainId ); emit SocketBridge( bridgeAmount, token, anyswapBridgeData.toChainId, AnyswapIdentifier, msg.sender, anyswapBridgeData.receiverAddress, anyswapBridgeData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Anyswap-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount being bridged * @param toChainId destination ChainId * @param receiverAddress address of receiver of bridged tokens * @param token address of token being bridged * @param wrapperTokenAddress address of wrapperToken, WrappedVersion of the token being bridged */ function bridgeERC20To( uint256 amount, uint256 toChainId, bytes32 metadata, address receiverAddress, address token, address wrapperTokenAddress ) external payable { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(address(router), amount); router.anySwapOutUnderlying( wrapperTokenAddress, receiverAddress, amount, toChainId ); emit SocketBridge( amount, token, toChainId, AnyswapIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {BridgeImplBase} from "../../BridgeImplBase.sol"; import {ANYSWAP} from "../../../static/RouteIdentifiers.sol"; /** * @title Anyswap-V4-Route L1 Implementation * @notice Route implementation with functions to bridge ERC20 via Anyswap-Bridge * Called via SocketGateway if the routeId in the request maps to the routeId of AnyswapImplementation * This is the L2 implementation, so this is used when transferring from l2. * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ interface AnyswapV4Router { function anySwapOutUnderlying( address token, address to, uint256 amount, uint256 toChainID ) external; } contract AnyswapL2Impl is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable AnyswapIdentifier = ANYSWAP; /// @notice Function-selector for ERC20-token bridging on Anyswap-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable ANYSWAP_L2_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(uint256,uint256,bytes32,address,address,address)" ) ); bytes4 public immutable ANYSWAP_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(uint256,address,address,bytes32))" ) ); // polygon router multichain router v4 AnyswapV4Router public immutable router; /** * @notice Constructor sets the router address and socketGateway address. * @dev anyswap v4 router is immutable. so no setter function required. */ constructor( address _router, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { router = AnyswapV4Router(_router); } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct AnyswapBridgeDataNoToken { /// @notice destination ChainId uint256 toChainId; /// @notice address of receiver of bridged tokens address receiverAddress; /// @notice address of wrapperToken, WrappedVersion of the token being bridged address wrapperTokenAddress; /// @notice socket offchain created hash bytes32 metadata; } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct AnyswapBridgeData { /// @notice destination ChainId uint256 toChainId; /// @notice address of receiver of bridged tokens address receiverAddress; /// @notice address of wrapperToken, WrappedVersion of the token being bridged address wrapperTokenAddress; /// @notice address of token being bridged address token; /// @notice socket offchain created hash bytes32 metadata; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in AnyswapBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for AnyswapBridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { AnyswapBridgeData memory anyswapBridgeData = abi.decode( bridgeData, (AnyswapBridgeData) ); ERC20(anyswapBridgeData.token).safeApprove(address(router), amount); router.anySwapOutUnderlying( anyswapBridgeData.wrapperTokenAddress, anyswapBridgeData.receiverAddress, amount, anyswapBridgeData.toChainId ); emit SocketBridge( amount, anyswapBridgeData.token, anyswapBridgeData.toChainId, AnyswapIdentifier, msg.sender, anyswapBridgeData.receiverAddress, anyswapBridgeData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in AnyswapBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param anyswapBridgeData encoded data for AnyswapBridge */ function swapAndBridge( uint32 swapId, bytes calldata swapData, AnyswapBridgeDataNoToken calldata anyswapBridgeData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); ERC20(token).safeApprove(address(router), bridgeAmount); router.anySwapOutUnderlying( anyswapBridgeData.wrapperTokenAddress, anyswapBridgeData.receiverAddress, bridgeAmount, anyswapBridgeData.toChainId ); emit SocketBridge( bridgeAmount, token, anyswapBridgeData.toChainId, AnyswapIdentifier, msg.sender, anyswapBridgeData.receiverAddress, anyswapBridgeData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Anyswap-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount being bridged * @param toChainId destination ChainId * @param receiverAddress address of receiver of bridged tokens * @param token address of token being bridged * @param wrapperTokenAddress address of wrapperToken, WrappedVersion of the token being bridged */ function bridgeERC20To( uint256 amount, uint256 toChainId, bytes32 metadata, address receiverAddress, address token, address wrapperTokenAddress ) external payable { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(address(router), amount); router.anySwapOutUnderlying( wrapperTokenAddress, receiverAddress, amount, toChainId ); emit SocketBridge( amount, token, toChainId, AnyswapIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: Apache-2.0 /* * Copyright 2021, Offchain Labs, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ pragma solidity >=0.8.0; /** * @title L1gatewayRouter for native-arbitrum */ interface L1GatewayRouter { /** * @notice outbound function to bridge ERC20 via NativeArbitrum-Bridge * @param _token address of token being bridged via GatewayRouter * @param _to recipient of the token on arbitrum chain * @param _amount amount of ERC20 token being bridged * @param _maxGas a depositParameter for bridging the token * @param _gasPriceBid a depositParameter for bridging the token * @param _data a depositParameter for bridging the token * @return calldata returns the output of transactioncall made on gatewayRouter */ function outboundTransfer( address _token, address _to, uint256 _amount, uint256 _maxGas, uint256 _gasPriceBid, bytes calldata _data ) external payable returns (bytes calldata); } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {L1GatewayRouter} from "../interfaces/arbitrum.sol"; import {BridgeImplBase} from "../../BridgeImplBase.sol"; import {NATIVE_ARBITRUM} from "../../../static/RouteIdentifiers.sol"; /** * @title Native Arbitrum-Route Implementation * @notice Route implementation with functions to bridge ERC20 via NativeArbitrum-Bridge * @notice Called via SocketGateway if the routeId in the request maps to the routeId of NativeArbitrum-Implementation * @notice This is used when transferring from ethereum chain to arbitrum via their native bridge. * @notice Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * @notice RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract NativeArbitrumImpl is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable NativeArbitrumIdentifier = NATIVE_ARBITRUM; uint256 public constant DESTINATION_CHAIN_ID = 42161; /// @notice Function-selector for ERC20-token bridging on NativeArbitrum /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable NATIVE_ARBITRUM_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(uint256,uint256,uint256,uint256,bytes32,address,address,address,bytes)" ) ); bytes4 public immutable NATIVE_ARBITRUM_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(uint256,uint256,uint256,address,address,bytes32,bytes))" ) ); /// @notice router address of NativeArbitrum Bridge /// @notice GatewayRouter looks up ERC20Token's gateway, and finding that it's Standard ERC20 gateway (the L1ERC20Gateway contract). address public immutable router; /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase /// @dev ensure router-address are set properly for the chainId in which the contract is being deployed constructor( address _router, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { router = _router; } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct NativeArbitrumBridgeDataNoToken { uint256 value; /// @notice maxGas is a depositParameter derived from erc20Bridger of nativeArbitrum uint256 maxGas; /// @notice gasPriceBid is a depositParameter derived from erc20Bridger of nativeArbitrum uint256 gasPriceBid; /// @notice address of receiver of bridged tokens address receiverAddress; /// @notice address of Gateway which handles the token bridging for the token /// @notice gatewayAddress is unique for each token address gatewayAddress; /// @notice socket offchain created hash bytes32 metadata; /// @notice data is a depositParameter derived from erc20Bridger of nativeArbitrum bytes data; } struct NativeArbitrumBridgeData { uint256 value; /// @notice maxGas is a depositParameter derived from erc20Bridger of nativeArbitrum uint256 maxGas; /// @notice gasPriceBid is a depositParameter derived from erc20Bridger of nativeArbitrum uint256 gasPriceBid; /// @notice address of receiver of bridged tokens address receiverAddress; /// @notice address of Gateway which handles the token bridging for the token /// @notice gatewayAddress is unique for each token address gatewayAddress; /// @notice address of token being bridged address token; /// @notice socket offchain created hash bytes32 metadata; /// @notice data is a depositParameter derived from erc20Bridger of nativeArbitrum bytes data; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in NativeArbitrumBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for NativeArbitrumBridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { NativeArbitrumBridgeData memory nativeArbitrumBridgeData = abi.decode( bridgeData, (NativeArbitrumBridgeData) ); ERC20(nativeArbitrumBridgeData.token).safeApprove( nativeArbitrumBridgeData.gatewayAddress, amount ); L1GatewayRouter(router).outboundTransfer{ value: nativeArbitrumBridgeData.value }( nativeArbitrumBridgeData.token, nativeArbitrumBridgeData.receiverAddress, amount, nativeArbitrumBridgeData.maxGas, nativeArbitrumBridgeData.gasPriceBid, nativeArbitrumBridgeData.data ); emit SocketBridge( amount, nativeArbitrumBridgeData.token, DESTINATION_CHAIN_ID, NativeArbitrumIdentifier, msg.sender, nativeArbitrumBridgeData.receiverAddress, nativeArbitrumBridgeData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in NativeArbitrumBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param nativeArbitrumBridgeData encoded data for NativeArbitrumBridge */ function swapAndBridge( uint32 swapId, bytes calldata swapData, NativeArbitrumBridgeDataNoToken calldata nativeArbitrumBridgeData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); ERC20(token).safeApprove( nativeArbitrumBridgeData.gatewayAddress, bridgeAmount ); L1GatewayRouter(router).outboundTransfer{ value: nativeArbitrumBridgeData.value }( token, nativeArbitrumBridgeData.receiverAddress, bridgeAmount, nativeArbitrumBridgeData.maxGas, nativeArbitrumBridgeData.gasPriceBid, nativeArbitrumBridgeData.data ); emit SocketBridge( bridgeAmount, token, DESTINATION_CHAIN_ID, NativeArbitrumIdentifier, msg.sender, nativeArbitrumBridgeData.receiverAddress, nativeArbitrumBridgeData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via NativeArbitrum-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount being bridged * @param value value * @param maxGas maxGas is a depositParameter derived from erc20Bridger of nativeArbitrum * @param gasPriceBid gasPriceBid is a depositParameter derived from erc20Bridger of nativeArbitrum * @param receiverAddress address of receiver of bridged tokens * @param token address of token being bridged * @param gatewayAddress address of Gateway which handles the token bridging for the token, gatewayAddress is unique for each token * @param data data is a depositParameter derived from erc20Bridger of nativeArbitrum */ function bridgeERC20To( uint256 amount, uint256 value, uint256 maxGas, uint256 gasPriceBid, bytes32 metadata, address receiverAddress, address token, address gatewayAddress, bytes memory data ) external payable { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(gatewayAddress, amount); L1GatewayRouter(router).outboundTransfer{value: value}( token, receiverAddress, amount, maxGas, gasPriceBid, data ); emit SocketBridge( amount, token, DESTINATION_CHAIN_ID, NativeArbitrumIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {ISocketGateway} from "../interfaces/ISocketGateway.sol"; import {ISocketRoute} from "../interfaces/ISocketRoute.sol"; import {OnlySocketGatewayOwner, OnlySocketDeployer} from "../errors/SocketErrors.sol"; /** * @title Abstract Implementation Contract. * @notice All Bridge Implementation will follow this interface. */ abstract contract BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; /// @notice Address used to identify if it is a native token transfer or not address public immutable NATIVE_TOKEN_ADDRESS = address(0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE); /// @notice immutable variable to store the socketGateway address address public immutable socketGateway; /// @notice immutable variable to store the socketGateway address address public immutable socketDeployFactory; /// @notice immutable variable with instance of SocketRoute to access route functions ISocketRoute public immutable socketRoute; /// @notice FunctionSelector used to delegatecall from swap to the function of bridge router implementation bytes4 public immutable BRIDGE_AFTER_SWAP_SELECTOR = bytes4(keccak256("bridgeAfterSwap(uint256,bytes)")); /**************************************** * EVENTS * ****************************************/ event SocketBridge( uint256 amount, address token, uint256 toChainId, bytes32 bridgeName, address sender, address receiver, bytes32 metadata ); /** * @notice Construct the base for all BridgeImplementations. * @param _socketGateway Socketgateway address, an immutable variable to set. * @param _socketDeployFactory Socket Deploy Factory address, an immutable variable to set. */ constructor(address _socketGateway, address _socketDeployFactory) { socketGateway = _socketGateway; socketDeployFactory = _socketDeployFactory; socketRoute = ISocketRoute(_socketGateway); } /**************************************** * MODIFIERS * ****************************************/ /// @notice Implementing contract needs to make use of the modifier where restricted access is to be used modifier isSocketGatewayOwner() { if (msg.sender != ISocketGateway(socketGateway).owner()) { revert OnlySocketGatewayOwner(); } _; } /// @notice Implementing contract needs to make use of the modifier where restricted access is to be used modifier isSocketDeployFactory() { if (msg.sender != socketDeployFactory) { revert OnlySocketDeployer(); } _; } /**************************************** * RESTRICTED FUNCTIONS * ****************************************/ /** * @notice function to rescue the ERC20 tokens in the bridge Implementation contract * @notice this is a function restricted to Owner of SocketGateway only * @param token address of ERC20 token being rescued * @param userAddress receipient address to which ERC20 tokens will be rescued to * @param amount amount of ERC20 tokens being rescued */ function rescueFunds( address token, address userAddress, uint256 amount ) external isSocketGatewayOwner { ERC20(token).safeTransfer(userAddress, amount); } /** * @notice function to rescue the native-balance in the bridge Implementation contract * @notice this is a function restricted to Owner of SocketGateway only * @param userAddress receipient address to which native-balance will be rescued to * @param amount amount of native balance tokens being rescued */ function rescueEther( address payable userAddress, uint256 amount ) external isSocketGatewayOwner { userAddress.transfer(amount); } function killme() external isSocketDeployFactory { selfdestruct(payable(msg.sender)); } /****************************** * VIRTUAL FUNCTIONS * *****************************/ /** * @notice function to bridge which is succeeding the swap function * @notice this function is to be used only when bridging as a succeeding step * @notice All bridge implementation contracts must implement this function * @notice bridge-implementations will have a bridge specific struct with properties used in bridging * @param bridgeData encoded value of properties in the bridgeData Struct */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable virtual; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import "../../libraries/Pb.sol"; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import "./interfaces/cbridge.sol"; import "./interfaces/ICelerStorageWrapper.sol"; import {TransferIdExists, InvalidCelerRefund, CelerAlreadyRefunded, CelerRefundNotReady} from "../../errors/SocketErrors.sol"; import {BridgeImplBase} from "../BridgeImplBase.sol"; import {CBRIDGE} from "../../static/RouteIdentifiers.sol"; /** * @title Celer-Route Implementation * @notice Route implementation with functions to bridge ERC20 and Native via Celer-Bridge * Called via SocketGateway if the routeId in the request maps to the routeId of CelerImplementation * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract CelerImpl is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable CBridgeIdentifier = CBRIDGE; /// @notice Utility to perform operation on Buffer using Pb for Pb.Buffer; /// @notice Function-selector for ERC20-token bridging on Celer-Route /// @dev This function selector is to be used while building transaction-data to bridge ERC20 tokens bytes4 public immutable CELER_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(address,address,uint256,bytes32,uint64,uint64,uint32)" ) ); /// @notice Function-selector for Native bridging on Celer-Route /// @dev This function selector is to be used while building transaction-data to bridge Native tokens bytes4 public immutable CELER_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeNativeTo(address,uint256,bytes32,uint64,uint64,uint32)" ) ); bytes4 public immutable CELER_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(address,uint64,uint32,uint64,bytes32))" ) ); /// @notice router Contract instance used to deposit ERC20 and Native on to Celer-Bridge /// @dev contract instance is to be initialized in the constructor using the routerAddress passed as constructor argument ICBridge public immutable router; /// @notice celerStorageWrapper Contract instance used to store the transferId generated during ERC20 and Native bridge on to Celer-Bridge /// @dev contract instance is to be initialized in the constructor using the celerStorageWrapperAddress passed as constructor argument ICelerStorageWrapper public immutable celerStorageWrapper; /// @notice WETH token address address public immutable weth; /// @notice chainId used during generation of transferId generated while bridging ERC20 and Native on to Celer-Bridge /// @dev this is to be initialised in the constructor uint64 public immutable chainId; struct WithdrawMsg { uint64 chainid; // tag: 1 uint64 seqnum; // tag: 2 address receiver; // tag: 3 address token; // tag: 4 uint256 amount; // tag: 5 bytes32 refid; // tag: 6 } /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase /// @dev ensure routerAddress, weth-address, celerStorageWrapperAddress are set properly for the chainId in which the contract is being deployed constructor( address _routerAddress, address _weth, address _celerStorageWrapperAddress, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { router = ICBridge(_routerAddress); celerStorageWrapper = ICelerStorageWrapper(_celerStorageWrapperAddress); weth = _weth; chainId = uint64(block.chainid); } // Function to receive Ether. msg.data must be empty receive() external payable {} /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct CelerBridgeDataNoToken { address receiverAddress; uint64 toChainId; uint32 maxSlippage; uint64 nonce; bytes32 metadata; } struct CelerBridgeData { address token; address receiverAddress; uint64 toChainId; uint32 maxSlippage; uint64 nonce; bytes32 metadata; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in CelerBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for CelerBridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { CelerBridgeData memory celerBridgeData = abi.decode( bridgeData, (CelerBridgeData) ); if (celerBridgeData.token == NATIVE_TOKEN_ADDRESS) { // transferId is generated using the request-params and nonce of the account // transferId should be unique for each request and this is used while handling refund from celerBridge bytes32 transferId = keccak256( abi.encodePacked( address(this), celerBridgeData.receiverAddress, weth, amount, celerBridgeData.toChainId, celerBridgeData.nonce, chainId ) ); // transferId is stored in CelerStorageWrapper with in a mapping where key is transferId and value is the msg-sender celerStorageWrapper.setAddressForTransferId(transferId, msg.sender); router.sendNative{value: amount}( celerBridgeData.receiverAddress, amount, celerBridgeData.toChainId, celerBridgeData.nonce, celerBridgeData.maxSlippage ); } else { // transferId is generated using the request-params and nonce of the account // transferId should be unique for each request and this is used while handling refund from celerBridge bytes32 transferId = keccak256( abi.encodePacked( address(this), celerBridgeData.receiverAddress, celerBridgeData.token, amount, celerBridgeData.toChainId, celerBridgeData.nonce, chainId ) ); // transferId is stored in CelerStorageWrapper with in a mapping where key is transferId and value is the msg-sender celerStorageWrapper.setAddressForTransferId(transferId, msg.sender); router.send( celerBridgeData.receiverAddress, celerBridgeData.token, amount, celerBridgeData.toChainId, celerBridgeData.nonce, celerBridgeData.maxSlippage ); } emit SocketBridge( amount, celerBridgeData.token, celerBridgeData.toChainId, CBridgeIdentifier, msg.sender, celerBridgeData.receiverAddress, celerBridgeData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in CelerBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param celerBridgeData encoded data for CelerBridgeData */ function swapAndBridge( uint32 swapId, bytes calldata swapData, CelerBridgeDataNoToken calldata celerBridgeData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); if (token == NATIVE_TOKEN_ADDRESS) { // transferId is generated using the request-params and nonce of the account // transferId should be unique for each request and this is used while handling refund from celerBridge bytes32 transferId = keccak256( abi.encodePacked( address(this), celerBridgeData.receiverAddress, weth, bridgeAmount, celerBridgeData.toChainId, celerBridgeData.nonce, chainId ) ); // transferId is stored in CelerStorageWrapper with in a mapping where key is transferId and value is the msg-sender celerStorageWrapper.setAddressForTransferId(transferId, msg.sender); router.sendNative{value: bridgeAmount}( celerBridgeData.receiverAddress, bridgeAmount, celerBridgeData.toChainId, celerBridgeData.nonce, celerBridgeData.maxSlippage ); } else { // transferId is generated using the request-params and nonce of the account // transferId should be unique for each request and this is used while handling refund from celerBridge bytes32 transferId = keccak256( abi.encodePacked( address(this), celerBridgeData.receiverAddress, token, bridgeAmount, celerBridgeData.toChainId, celerBridgeData.nonce, chainId ) ); // transferId is stored in CelerStorageWrapper with in a mapping where key is transferId and value is the msg-sender celerStorageWrapper.setAddressForTransferId(transferId, msg.sender); router.send( celerBridgeData.receiverAddress, token, bridgeAmount, celerBridgeData.toChainId, celerBridgeData.nonce, celerBridgeData.maxSlippage ); } emit SocketBridge( bridgeAmount, token, celerBridgeData.toChainId, CBridgeIdentifier, msg.sender, celerBridgeData.receiverAddress, celerBridgeData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Celer-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param receiverAddress address of recipient * @param token address of token being bridged * @param amount amount of token for bridging * @param toChainId destination ChainId * @param nonce nonce of the sender-account address * @param maxSlippage maximum Slippage for the bridging */ function bridgeERC20To( address receiverAddress, address token, uint256 amount, bytes32 metadata, uint64 toChainId, uint64 nonce, uint32 maxSlippage ) external payable { /// @notice transferId is generated using the request-params and nonce of the account /// @notice transferId should be unique for each request and this is used while handling refund from celerBridge bytes32 transferId = keccak256( abi.encodePacked( address(this), receiverAddress, token, amount, toChainId, nonce, chainId ) ); /// @notice stored in the CelerStorageWrapper contract celerStorageWrapper.setAddressForTransferId(transferId, msg.sender); ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); router.send( receiverAddress, token, amount, toChainId, nonce, maxSlippage ); emit SocketBridge( amount, token, toChainId, CBridgeIdentifier, msg.sender, receiverAddress, metadata ); } /** * @notice function to handle Native bridging to receipent via Celer-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param receiverAddress address of recipient * @param amount amount of token for bridging * @param toChainId destination ChainId * @param nonce nonce of the sender-account address * @param maxSlippage maximum Slippage for the bridging */ function bridgeNativeTo( address receiverAddress, uint256 amount, bytes32 metadata, uint64 toChainId, uint64 nonce, uint32 maxSlippage ) external payable { bytes32 transferId = keccak256( abi.encodePacked( address(this), receiverAddress, weth, amount, toChainId, nonce, chainId ) ); celerStorageWrapper.setAddressForTransferId(transferId, msg.sender); router.sendNative{value: amount}( receiverAddress, amount, toChainId, nonce, maxSlippage ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, toChainId, CBridgeIdentifier, msg.sender, receiverAddress, metadata ); } /** * @notice function to handle refund from CelerBridge-Router * @param _request request data generated offchain using the celer-SDK * @param _sigs generated offchain using the celer-SDK * @param _signers generated offchain using the celer-SDK * @param _powers generated offchain using the celer-SDK */ function refundCelerUser( bytes calldata _request, bytes[] calldata _sigs, address[] calldata _signers, uint256[] calldata _powers ) external payable { WithdrawMsg memory request = decWithdrawMsg(_request); bytes32 transferId = keccak256( abi.encodePacked( request.chainid, request.seqnum, request.receiver, request.token, request.amount ) ); uint256 _initialNativeBalance = address(this).balance; uint256 _initialTokenBalance = ERC20(request.token).balanceOf( address(this) ); if (!router.withdraws(transferId)) { router.withdraw(_request, _sigs, _signers, _powers); } if (request.receiver != socketGateway) { revert InvalidCelerRefund(); } address _receiver = celerStorageWrapper.getAddressFromTransferId( request.refid ); celerStorageWrapper.deleteTransferId(request.refid); if (_receiver == address(0)) { revert CelerAlreadyRefunded(); } uint256 _nativeBalanceAfter = address(this).balance; uint256 _tokenBalanceAfter = ERC20(request.token).balanceOf( address(this) ); if (_nativeBalanceAfter > _initialNativeBalance) { if ((_nativeBalanceAfter - _initialNativeBalance) != request.amount) revert CelerRefundNotReady(); payable(_receiver).transfer(request.amount); return; } if (_tokenBalanceAfter > _initialTokenBalance) { if ((_tokenBalanceAfter - _initialTokenBalance) != request.amount) revert CelerRefundNotReady(); ERC20(request.token).safeTransfer(_receiver, request.amount); return; } revert CelerRefundNotReady(); } function decWithdrawMsg( bytes memory raw ) internal pure returns (WithdrawMsg memory m) { Pb.Buffer memory buf = Pb.fromBytes(raw); uint256 tag; Pb.WireType wire; while (buf.hasMore()) { (tag, wire) = buf.decKey(); if (false) {} // solidity has no switch/case else if (tag == 1) { m.chainid = uint64(buf.decVarint()); } else if (tag == 2) { m.seqnum = uint64(buf.decVarint()); } else if (tag == 3) { m.receiver = Pb._address(buf.decBytes()); } else if (tag == 4) { m.token = Pb._address(buf.decBytes()); } else if (tag == 5) { m.amount = Pb._uint256(buf.decBytes()); } else if (tag == 6) { m.refid = Pb._bytes32(buf.decBytes()); } else { buf.skipValue(wire); } // skip value of unknown tag } } // end decoder WithdrawMsg } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.0; import {OnlySocketGateway, TransferIdExists, TransferIdDoesnotExist} from "../../errors/SocketErrors.sol"; /** * @title CelerStorageWrapper * @notice handle storageMappings used while bridging ERC20 and native on CelerBridge * @dev all functions ehich mutate the storage are restricted to Owner of SocketGateway * @author Socket dot tech. */ contract CelerStorageWrapper { /// @notice Socketgateway-address to be set in the constructor of CelerStorageWrapper address public immutable socketGateway; /// @notice mapping to store the transferId generated during bridging on Celer to message-sender mapping(bytes32 => address) private transferIdMapping; /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase constructor(address _socketGateway) { socketGateway = _socketGateway; } /** * @notice function to store the transferId and message-sender of a bridging activity * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in CelerBridgeData struct * @param transferId transferId generated during the bridging of ERC20 or native on CelerBridge * @param transferIdAddress message sender who is making the bridging on CelerBridge */ function setAddressForTransferId( bytes32 transferId, address transferIdAddress ) external { if (msg.sender != socketGateway) { revert OnlySocketGateway(); } if (transferIdMapping[transferId] != address(0)) { revert TransferIdExists(); } transferIdMapping[transferId] = transferIdAddress; } /** * @notice function to delete the transferId when the celer bridge processes a refund. * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in CelerBridgeData struct * @param transferId transferId generated during the bridging of ERC20 or native on CelerBridge */ function deleteTransferId(bytes32 transferId) external { if (msg.sender != socketGateway) { revert OnlySocketGateway(); } if (transferIdMapping[transferId] == address(0)) { revert TransferIdDoesnotExist(); } delete transferIdMapping[transferId]; } /** * @notice function to lookup the address mapped to the transferId * @param transferId transferId generated during the bridging of ERC20 or native on CelerBridge * @return address of account mapped to transferId */ function getAddressFromTransferId( bytes32 transferId ) external view returns (address) { return transferIdMapping[transferId]; } } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.0; interface ICBridge { function send( address _receiver, address _token, uint256 _amount, uint64 _dstChinId, uint64 _nonce, uint32 _maxSlippage ) external; function sendNative( address _receiver, uint256 _amount, uint64 _dstChinId, uint64 _nonce, uint32 _maxSlippage ) external payable; function withdraws(bytes32 withdrawId) external view returns (bool); function withdraw( bytes calldata _wdmsg, bytes[] calldata _sigs, address[] calldata _signers, uint256[] calldata _powers ) external; } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.0; /** * @title Celer-StorageWrapper interface * @notice Interface to handle storageMappings used while bridging ERC20 and native on CelerBridge * @dev all functions ehich mutate the storage are restricted to Owner of SocketGateway * @author Socket dot tech. */ interface ICelerStorageWrapper { /** * @notice function to store the transferId and message-sender of a bridging activity * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in CelerBridgeData struct * @param transferId transferId generated during the bridging of ERC20 or native on CelerBridge * @param transferIdAddress message sender who is making the bridging on CelerBridge */ function setAddressForTransferId( bytes32 transferId, address transferIdAddress ) external; /** * @notice function to store the transferId and message-sender of a bridging activity * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in CelerBridgeData struct * @param transferId transferId generated during the bridging of ERC20 or native on CelerBridge */ function deleteTransferId(bytes32 transferId) external; /** * @notice function to lookup the address mapped to the transferId * @param transferId transferId generated during the bridging of ERC20 or native on CelerBridge * @return address of account mapped to transferId */ function getAddressFromTransferId( bytes32 transferId ) external view returns (address); } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; /** * @title HopAMM * @notice Interface to handle the token bridging to L2 chains. */ interface HopAMM { /** * @notice To send funds L2->L1 or L2->L2, call the swapAndSend on the L2 AMM Wrapper contract * @param chainId chainId of the L2 contract * @param recipient receiver address * @param amount amount is the amount the user wants to send plus the Bonder fee * @param bonderFee fees * @param amountOutMin minimum amount * @param deadline deadline for bridging * @param destinationAmountOutMin minimum amount expected to be bridged on L2 * @param destinationDeadline destination time before which token is to be bridged on L2 */ function swapAndSend( uint256 chainId, address recipient, uint256 amount, uint256 bonderFee, uint256 amountOutMin, uint256 deadline, uint256 destinationAmountOutMin, uint256 destinationDeadline ) external payable; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; /** * @title L1Bridge Hop Interface * @notice L1 Hop Bridge, Used to transfer from L1 to L2s. */ interface IHopL1Bridge { /** * @notice `amountOutMin` and `deadline` should be 0 when no swap is intended at the destination. * @notice `amount` is the total amount the user wants to send including the relayer fee * @dev Send tokens to a supported layer-2 to mint hToken and optionally swap the hToken in the * AMM at the destination. * @param chainId The chainId of the destination chain * @param recipient The address receiving funds at the destination * @param amount The amount being sent * @param amountOutMin The minimum amount received after attempting to swap in the destination * AMM market. 0 if no swap is intended. * @param deadline The deadline for swapping in the destination AMM market. 0 if no * swap is intended. * @param relayer The address of the relayer at the destination. * @param relayerFee The amount distributed to the relayer at the destination. This is subtracted from the `amount`. */ function sendToL2( uint256 chainId, address recipient, uint256 amount, uint256 amountOutMin, uint256 deadline, address relayer, uint256 relayerFee ) external payable; } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import "../interfaces/IHopL1Bridge.sol"; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {BridgeImplBase} from "../../BridgeImplBase.sol"; import {HOP} from "../../../static/RouteIdentifiers.sol"; /** * @title Hop-L1 Route Implementation * @notice Route implementation with functions to bridge ERC20 and Native via Hop-Bridge from L1 to Supported L2s * Called via SocketGateway if the routeId in the request maps to the routeId of HopImplementation * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract HopImplL1 is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable HopIdentifier = HOP; /// @notice Function-selector for ERC20-token bridging on Hop-L1-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable HOP_L1_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(address,address,address,address,uint256,uint256,uint256,uint256,(uint256,bytes32))" ) ); /// @notice Function-selector for Native bridging on Hop-L1-Route /// @dev This function selector is to be used while building transaction-data to bridge Native tokens bytes4 public immutable HOP_L1_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeNativeTo(address,address,address,uint256,uint256,uint256,uint256,uint256,bytes32)" ) ); bytes4 public immutable HOP_L1_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(address,address,address,uint256,uint256,uint256,uint256,bytes32))" ) ); /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase constructor( address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) {} /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct HopDataNoToken { // The address receiving funds at the destination address receiverAddress; // address of the Hop-L1-Bridge to handle bridging the tokens address l1bridgeAddr; // relayerFee The amount distributed to the relayer at the destination. This is subtracted from the `_amount`. address relayer; // The chainId of the destination chain uint256 toChainId; // The minimum amount received after attempting to swap in the destination AMM market. 0 if no swap is intended. uint256 amountOutMin; // The amount distributed to the relayer at the destination. This is subtracted from the `amount`. uint256 relayerFee; // The deadline for swapping in the destination AMM market. 0 if no swap is intended. uint256 deadline; // socket offchain created hash bytes32 metadata; } struct HopData { /// @notice address of token being bridged address token; // The address receiving funds at the destination address receiverAddress; // address of the Hop-L1-Bridge to handle bridging the tokens address l1bridgeAddr; // relayerFee The amount distributed to the relayer at the destination. This is subtracted from the `_amount`. address relayer; // The chainId of the destination chain uint256 toChainId; // The minimum amount received after attempting to swap in the destination AMM market. 0 if no swap is intended. uint256 amountOutMin; // The amount distributed to the relayer at the destination. This is subtracted from the `amount`. uint256 relayerFee; // The deadline for swapping in the destination AMM market. 0 if no swap is intended. uint256 deadline; // socket offchain created hash bytes32 metadata; } struct HopERC20Data { uint256 deadline; bytes32 metadata; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in HopBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for Hop-L1-Bridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { HopData memory hopData = abi.decode(bridgeData, (HopData)); if (hopData.token == NATIVE_TOKEN_ADDRESS) { IHopL1Bridge(hopData.l1bridgeAddr).sendToL2{value: amount}( hopData.toChainId, hopData.receiverAddress, amount, hopData.amountOutMin, hopData.deadline, hopData.relayer, hopData.relayerFee ); } else { ERC20(hopData.token).safeApprove(hopData.l1bridgeAddr, amount); // perform bridging IHopL1Bridge(hopData.l1bridgeAddr).sendToL2( hopData.toChainId, hopData.receiverAddress, amount, hopData.amountOutMin, hopData.deadline, hopData.relayer, hopData.relayerFee ); } emit SocketBridge( amount, hopData.token, hopData.toChainId, HopIdentifier, msg.sender, hopData.receiverAddress, hopData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in HopBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param hopData encoded data for HopData */ function swapAndBridge( uint32 swapId, bytes calldata swapData, HopDataNoToken calldata hopData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); if (token == NATIVE_TOKEN_ADDRESS) { IHopL1Bridge(hopData.l1bridgeAddr).sendToL2{value: bridgeAmount}( hopData.toChainId, hopData.receiverAddress, bridgeAmount, hopData.amountOutMin, hopData.deadline, hopData.relayer, hopData.relayerFee ); } else { ERC20(token).safeApprove(hopData.l1bridgeAddr, bridgeAmount); // perform bridging IHopL1Bridge(hopData.l1bridgeAddr).sendToL2( hopData.toChainId, hopData.receiverAddress, bridgeAmount, hopData.amountOutMin, hopData.deadline, hopData.relayer, hopData.relayerFee ); } emit SocketBridge( bridgeAmount, token, hopData.toChainId, HopIdentifier, msg.sender, hopData.receiverAddress, hopData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Hop-L1-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param receiverAddress The address receiving funds at the destination * @param token token being bridged * @param l1bridgeAddr address of the Hop-L1-Bridge to handle bridging the tokens * @param relayer The amount distributed to the relayer at the destination. This is subtracted from the `_amount`. * @param toChainId The chainId of the destination chain * @param amount The amount being sent * @param amountOutMin The minimum amount received after attempting to swap in the destination AMM market. 0 if no swap is intended. * @param relayerFee The amount distributed to the relayer at the destination. This is subtracted from the `amount`. * @param hopData extra data needed to build the tx */ function bridgeERC20To( address receiverAddress, address token, address l1bridgeAddr, address relayer, uint256 toChainId, uint256 amount, uint256 amountOutMin, uint256 relayerFee, HopERC20Data calldata hopData ) external payable { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(l1bridgeAddr, amount); // perform bridging IHopL1Bridge(l1bridgeAddr).sendToL2( toChainId, receiverAddress, amount, amountOutMin, hopData.deadline, relayer, relayerFee ); emit SocketBridge( amount, token, toChainId, HopIdentifier, msg.sender, receiverAddress, hopData.metadata ); } /** * @notice function to handle Native bridging to receipent via Hop-L1-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param receiverAddress The address receiving funds at the destination * @param l1bridgeAddr address of the Hop-L1-Bridge to handle bridging the tokens * @param relayer The amount distributed to the relayer at the destination. This is subtracted from the `_amount`. * @param toChainId The chainId of the destination chain * @param amount The amount being sent * @param amountOutMin The minimum amount received after attempting to swap in the destination AMM market. 0 if no swap is intended. * @param relayerFee The amount distributed to the relayer at the destination. This is subtracted from the `amount`. * @param deadline The deadline for swapping in the destination AMM market. 0 if no swap is intended. */ function bridgeNativeTo( address receiverAddress, address l1bridgeAddr, address relayer, uint256 toChainId, uint256 amount, uint256 amountOutMin, uint256 relayerFee, uint256 deadline, bytes32 metadata ) external payable { IHopL1Bridge(l1bridgeAddr).sendToL2{value: amount}( toChainId, receiverAddress, amount, amountOutMin, deadline, relayer, relayerFee ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, toChainId, HopIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import "../interfaces/amm.sol"; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {BridgeImplBase} from "../../BridgeImplBase.sol"; import {HOP} from "../../../static/RouteIdentifiers.sol"; /** * @title Hop-L2 Route Implementation * @notice This is the L2 implementation, so this is used when transferring from l2 to supported l2s * Called via SocketGateway if the routeId in the request maps to the routeId of HopL2-Implementation * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract HopImplL2 is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable HopIdentifier = HOP; /// @notice Function-selector for ERC20-token bridging on Hop-L2-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable HOP_L2_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(address,address,address,uint256,uint256,(uint256,uint256,uint256,uint256,uint256,bytes32))" ) ); /// @notice Function-selector for Native bridging on Hop-L2-Route /// @dev This function selector is to be used while building transaction-data to bridge Native tokens bytes4 public immutable HOP_L2_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeNativeTo(address,address,uint256,uint256,uint256,uint256,uint256,uint256,uint256,bytes32)" ) ); bytes4 public immutable HOP_L2_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(address,address,uint256,uint256,uint256,uint256,uint256,uint256,bytes32))" ) ); /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase constructor( address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) {} /// @notice Struct to be used as a input parameter for Bridging tokens via Hop-L2-route /// @dev while building transactionData,values should be set in this sequence of properties in this struct struct HopBridgeRequestData { // fees passed to relayer uint256 bonderFee; // The minimum amount received after attempting to swap in the destination AMM market. 0 if no swap is intended. uint256 amountOutMin; // The deadline for swapping in the destination AMM market. 0 if no swap is intended. uint256 deadline; // Minimum amount expected to be received or bridged to destination uint256 amountOutMinDestination; // deadline for bridging to destination uint256 deadlineDestination; // socket offchain created hash bytes32 metadata; } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct HopBridgeDataNoToken { // The address receiving funds at the destination address receiverAddress; // AMM address of Hop on L2 address hopAMM; // The chainId of the destination chain uint256 toChainId; // fees passed to relayer uint256 bonderFee; // The minimum amount received after attempting to swap in the destination AMM market. 0 if no swap is intended. uint256 amountOutMin; // The deadline for swapping in the destination AMM market. 0 if no swap is intended. uint256 deadline; // Minimum amount expected to be received or bridged to destination uint256 amountOutMinDestination; // deadline for bridging to destination uint256 deadlineDestination; // socket offchain created hash bytes32 metadata; } struct HopBridgeData { /// @notice address of token being bridged address token; // The address receiving funds at the destination address receiverAddress; // AMM address of Hop on L2 address hopAMM; // The chainId of the destination chain uint256 toChainId; // fees passed to relayer uint256 bonderFee; // The minimum amount received after attempting to swap in the destination AMM market. 0 if no swap is intended. uint256 amountOutMin; // The deadline for swapping in the destination AMM market. 0 if no swap is intended. uint256 deadline; // Minimum amount expected to be received or bridged to destination uint256 amountOutMinDestination; // deadline for bridging to destination uint256 deadlineDestination; // socket offchain created hash bytes32 metadata; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in HopBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for Hop-L2-Bridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { HopBridgeData memory hopData = abi.decode(bridgeData, (HopBridgeData)); if (hopData.token == NATIVE_TOKEN_ADDRESS) { HopAMM(hopData.hopAMM).swapAndSend{value: amount}( hopData.toChainId, hopData.receiverAddress, amount, hopData.bonderFee, hopData.amountOutMin, hopData.deadline, hopData.amountOutMinDestination, hopData.deadlineDestination ); } else { // perform bridging HopAMM(hopData.hopAMM).swapAndSend( hopData.toChainId, hopData.receiverAddress, amount, hopData.bonderFee, hopData.amountOutMin, hopData.deadline, hopData.amountOutMinDestination, hopData.deadlineDestination ); } emit SocketBridge( amount, hopData.token, hopData.toChainId, HopIdentifier, msg.sender, hopData.receiverAddress, hopData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in HopBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param hopData encoded data for HopData */ function swapAndBridge( uint32 swapId, bytes calldata swapData, HopBridgeDataNoToken calldata hopData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); if (token == NATIVE_TOKEN_ADDRESS) { HopAMM(hopData.hopAMM).swapAndSend{value: bridgeAmount}( hopData.toChainId, hopData.receiverAddress, bridgeAmount, hopData.bonderFee, hopData.amountOutMin, hopData.deadline, hopData.amountOutMinDestination, hopData.deadlineDestination ); } else { // perform bridging HopAMM(hopData.hopAMM).swapAndSend( hopData.toChainId, hopData.receiverAddress, bridgeAmount, hopData.bonderFee, hopData.amountOutMin, hopData.deadline, hopData.amountOutMinDestination, hopData.deadlineDestination ); } emit SocketBridge( bridgeAmount, token, hopData.toChainId, HopIdentifier, msg.sender, hopData.receiverAddress, hopData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Hop-L2-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param receiverAddress The address receiving funds at the destination * @param token token being bridged * @param hopAMM AMM address of Hop on L2 * @param amount The amount being bridged * @param toChainId The chainId of the destination chain * @param hopBridgeRequestData extraData for Bridging across Hop-L2 */ function bridgeERC20To( address receiverAddress, address token, address hopAMM, uint256 amount, uint256 toChainId, HopBridgeRequestData calldata hopBridgeRequestData ) external payable { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); HopAMM(hopAMM).swapAndSend( toChainId, receiverAddress, amount, hopBridgeRequestData.bonderFee, hopBridgeRequestData.amountOutMin, hopBridgeRequestData.deadline, hopBridgeRequestData.amountOutMinDestination, hopBridgeRequestData.deadlineDestination ); emit SocketBridge( amount, token, toChainId, HopIdentifier, msg.sender, receiverAddress, hopBridgeRequestData.metadata ); } /** * @notice function to handle Native bridging to receipent via Hop-L2-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param receiverAddress The address receiving funds at the destination * @param hopAMM AMM address of Hop on L2 * @param amount The amount being bridged * @param toChainId The chainId of the destination chain * @param bonderFee fees passed to relayer * @param amountOutMin The minimum amount received after attempting to swap in the destination AMM market. 0 if no swap is intended. * @param deadline The deadline for swapping in the destination AMM market. 0 if no swap is intended. * @param amountOutMinDestination Minimum amount expected to be received or bridged to destination * @param deadlineDestination deadline for bridging to destination */ function bridgeNativeTo( address receiverAddress, address hopAMM, uint256 amount, uint256 toChainId, uint256 bonderFee, uint256 amountOutMin, uint256 deadline, uint256 amountOutMinDestination, uint256 deadlineDestination, bytes32 metadata ) external payable { // token address might not be indication thats why passed through extraData // perform bridging HopAMM(hopAMM).swapAndSend{value: amount}( toChainId, receiverAddress, amount, bonderFee, amountOutMin, deadline, amountOutMinDestination, deadlineDestination ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, toChainId, HopIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import "./interfaces/hyphen.sol"; import "../BridgeImplBase.sol"; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {HYPHEN} from "../../static/RouteIdentifiers.sol"; /** * @title Hyphen-Route Implementation * @notice Route implementation with functions to bridge ERC20 and Native via Hyphen-Bridge * Called via SocketGateway if the routeId in the request maps to the routeId of HyphenImplementation * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract HyphenImpl is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable HyphenIdentifier = HYPHEN; /// @notice Function-selector for ERC20-token bridging on Hyphen-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable HYPHEN_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256("bridgeERC20To(uint256,bytes32,address,address,uint256)") ); /// @notice Function-selector for Native bridging on Hyphen-Route /// @dev This function selector is to be used while buidling transaction-data to bridge Native tokens bytes4 public immutable HYPHEN_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4(keccak256("bridgeNativeTo(uint256,bytes32,address,uint256)")); bytes4 public immutable HYPHEN_SWAP_BRIDGE_SELECTOR = bytes4( keccak256("swapAndBridge(uint32,bytes,(address,uint256,bytes32))") ); /// @notice liquidityPoolManager - liquidityPool Manager of Hyphen used to bridge ERC20 and native /// @dev this is to be initialized in constructor with a valid deployed address of hyphen-liquidityPoolManager HyphenLiquidityPoolManager public immutable liquidityPoolManager; /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase /// @dev ensure liquidityPoolManager-address are set properly for the chainId in which the contract is being deployed constructor( address _liquidityPoolManager, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { liquidityPoolManager = HyphenLiquidityPoolManager( _liquidityPoolManager ); } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct HyphenData { /// @notice address of token being bridged address token; /// @notice address of receiver address receiverAddress; /// @notice chainId of destination uint256 toChainId; /// @notice socket offchain created hash bytes32 metadata; } struct HyphenDataNoToken { /// @notice address of receiver address receiverAddress; /// @notice chainId of destination uint256 toChainId; /// @notice chainId of destination bytes32 metadata; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in HyphenBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for HyphenBridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { HyphenData memory hyphenData = abi.decode(bridgeData, (HyphenData)); if (hyphenData.token == NATIVE_TOKEN_ADDRESS) { liquidityPoolManager.depositNative{value: amount}( hyphenData.receiverAddress, hyphenData.toChainId, "SOCKET" ); } else { ERC20(hyphenData.token).safeApprove( address(liquidityPoolManager), amount ); liquidityPoolManager.depositErc20( hyphenData.toChainId, hyphenData.token, hyphenData.receiverAddress, amount, "SOCKET" ); } emit SocketBridge( amount, hyphenData.token, hyphenData.toChainId, HyphenIdentifier, msg.sender, hyphenData.receiverAddress, hyphenData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in HyphenBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param hyphenData encoded data for hyphenData */ function swapAndBridge( uint32 swapId, bytes calldata swapData, HyphenDataNoToken calldata hyphenData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); if (token == NATIVE_TOKEN_ADDRESS) { liquidityPoolManager.depositNative{value: bridgeAmount}( hyphenData.receiverAddress, hyphenData.toChainId, "SOCKET" ); } else { ERC20(token).safeApprove( address(liquidityPoolManager), bridgeAmount ); liquidityPoolManager.depositErc20( hyphenData.toChainId, token, hyphenData.receiverAddress, bridgeAmount, "SOCKET" ); } emit SocketBridge( bridgeAmount, token, hyphenData.toChainId, HyphenIdentifier, msg.sender, hyphenData.receiverAddress, hyphenData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Hyphen-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount to be sent * @param receiverAddress address of the token to bridged to the destination chain. * @param token address of token being bridged * @param toChainId chainId of destination */ function bridgeERC20To( uint256 amount, bytes32 metadata, address receiverAddress, address token, uint256 toChainId ) external payable { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(address(liquidityPoolManager), amount); liquidityPoolManager.depositErc20( toChainId, token, receiverAddress, amount, "SOCKET" ); emit SocketBridge( amount, token, toChainId, HyphenIdentifier, msg.sender, receiverAddress, metadata ); } /** * @notice function to handle Native bridging to receipent via Hyphen-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount to be sent * @param receiverAddress address of the token to bridged to the destination chain. * @param toChainId chainId of destination */ function bridgeNativeTo( uint256 amount, bytes32 metadata, address receiverAddress, uint256 toChainId ) external payable { liquidityPoolManager.depositNative{value: amount}( receiverAddress, toChainId, "SOCKET" ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, toChainId, HyphenIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.0; /** * @title HyphenLiquidityPoolManager * @notice interface with functions to bridge ERC20 and Native via Hyphen-Bridge * @author Socket dot tech. */ interface HyphenLiquidityPoolManager { /** * @dev Function used to deposit tokens into pool to initiate a cross chain token transfer. * @param toChainId Chain id where funds needs to be transfered * @param tokenAddress ERC20 Token address that needs to be transfered * @param receiver Address on toChainId where tokens needs to be transfered * @param amount Amount of token being transfered */ function depositErc20( uint256 toChainId, address tokenAddress, address receiver, uint256 amount, string calldata tag ) external; /** * @dev Function used to deposit native token into pool to initiate a cross chain token transfer. * @param receiver Address on toChainId where tokens needs to be transfered * @param toChainId Chain id where funds needs to be transfered */ function depositNative( address receiver, uint256 toChainId, string calldata tag ) external payable; } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.0; interface L1StandardBridge { /** * @dev Performs the logic for deposits by storing the ETH and informing the L2 ETH Gateway of * the deposit. * @param _to Account to give the deposit to on L2. * @param _l2Gas Gas limit required to complete the deposit on L2. * @param _data Optional data to forward to L2. This data is provided * solely as a convenience for external contracts. Aside from enforcing a maximum * length, these contracts provide no guarantees about its content. */ function depositETHTo( address _to, uint32 _l2Gas, bytes calldata _data ) external payable; /** * @dev deposit an amount of ERC20 to a recipient's balance on L2. * @param _l1Token Address of the L1 ERC20 we are depositing * @param _l2Token Address of the L1 respective L2 ERC20 * @param _to L2 address to credit the withdrawal to. * @param _amount Amount of the ERC20 to deposit. * @param _l2Gas Gas limit required to complete the deposit on L2. * @param _data Optional data to forward to L2. This data is provided * solely as a convenience for external contracts. Aside from enforcing a maximum * length, these contracts provide no guarantees about its content. */ function depositERC20To( address _l1Token, address _l2Token, address _to, uint256 _amount, uint32 _l2Gas, bytes calldata _data ) external; } interface OldL1TokenGateway { /** * @dev Transfer SNX to L2 First, moves the SNX into the deposit escrow * * @param _to Account to give the deposit to on L2 * @param _amount Amount of the ERC20 to deposit. */ function depositTo(address _to, uint256 _amount) external; /** * @dev Transfer SNX to L2 First, moves the SNX into the deposit escrow * * @param currencyKey currencyKey for the SynthToken * @param destination Account to give the deposit to on L2 * @param amount Amount of the ERC20 to deposit. */ function initiateSynthTransfer( bytes32 currencyKey, address destination, uint256 amount ) external; } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import "../interfaces/optimism.sol"; import {BridgeImplBase} from "../../BridgeImplBase.sol"; import {UnsupportedInterfaceId} from "../../../errors/SocketErrors.sol"; import {NATIVE_OPTIMISM} from "../../../static/RouteIdentifiers.sol"; /** * @title NativeOptimism-Route Implementation * @notice Route implementation with functions to bridge ERC20 and Native via NativeOptimism-Bridge * Tokens are bridged from Ethereum to Optimism Chain. * Called via SocketGateway if the routeId in the request maps to the routeId of NativeOptimism-Implementation * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract NativeOptimismImpl is BridgeImplBase { using SafeTransferLib for ERC20; bytes32 public immutable NativeOptimismIdentifier = NATIVE_OPTIMISM; uint256 public constant DESTINATION_CHAIN_ID = 10; /// @notice Function-selector for ERC20-token bridging on Native-Optimism-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable NATIVE_OPTIMISM_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(address,address,address,uint32,(bytes32,bytes32),uint256,uint256,address,bytes)" ) ); /// @notice Function-selector for Native bridging on Native-Optimism-Route /// @dev This function selector is to be used while buidling transaction-data to bridge Native balance bytes4 public immutable NATIVE_OPTIMISM_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeNativeTo(address,address,uint32,uint256,bytes32,bytes)" ) ); bytes4 public immutable NATIVE_OPTIMISM_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(uint256,bytes32,bytes32,address,address,uint32,address,bytes))" ) ); /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase constructor( address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) {} /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct OptimismBridgeDataNoToken { // interfaceId to be set offchain which is used to select one of the 3 kinds of bridging (standard bridge / old standard / synthetic) uint256 interfaceId; // currencyKey of the token beingBridged bytes32 currencyKey; // socket offchain created hash bytes32 metadata; // address of receiver of bridged tokens address receiverAddress; /** * OptimismBridge that Performs the logic for deposits by informing the L2 Deposited Token * contract of the deposit and calling a handler to lock the L1 funds. (e.g. transferFrom) */ address customBridgeAddress; // Gas limit required to complete the deposit on L2. uint32 l2Gas; // Address of the L1 respective L2 ERC20 address l2Token; // additional data , for ll contracts this will be 0x data or empty data bytes data; } struct OptimismBridgeData { // interfaceId to be set offchain which is used to select one of the 3 kinds of bridging (standard bridge / old standard / synthetic) uint256 interfaceId; // currencyKey of the token beingBridged bytes32 currencyKey; // socket offchain created hash bytes32 metadata; // address of receiver of bridged tokens address receiverAddress; /** * OptimismBridge that Performs the logic for deposits by informing the L2 Deposited Token * contract of the deposit and calling a handler to lock the L1 funds. (e.g. transferFrom) */ address customBridgeAddress; /// @notice address of token being bridged address token; // Gas limit required to complete the deposit on L2. uint32 l2Gas; // Address of the L1 respective L2 ERC20 address l2Token; // additional data , for ll contracts this will be 0x data or empty data bytes data; } struct OptimismERC20Data { bytes32 currencyKey; bytes32 metadata; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in OptimismBridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for Optimism-Bridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { OptimismBridgeData memory optimismBridgeData = abi.decode( bridgeData, (OptimismBridgeData) ); emit SocketBridge( amount, optimismBridgeData.token, DESTINATION_CHAIN_ID, NativeOptimismIdentifier, msg.sender, optimismBridgeData.receiverAddress, optimismBridgeData.metadata ); if (optimismBridgeData.token == NATIVE_TOKEN_ADDRESS) { L1StandardBridge(optimismBridgeData.customBridgeAddress) .depositETHTo{value: amount}( optimismBridgeData.receiverAddress, optimismBridgeData.l2Gas, optimismBridgeData.data ); } else { if (optimismBridgeData.interfaceId == 0) { revert UnsupportedInterfaceId(); } ERC20(optimismBridgeData.token).safeApprove( optimismBridgeData.customBridgeAddress, amount ); if (optimismBridgeData.interfaceId == 1) { // deposit into standard bridge L1StandardBridge(optimismBridgeData.customBridgeAddress) .depositERC20To( optimismBridgeData.token, optimismBridgeData.l2Token, optimismBridgeData.receiverAddress, amount, optimismBridgeData.l2Gas, optimismBridgeData.data ); return; } // Deposit Using Old Standard - iOVM_L1TokenGateway(Example - SNX Token) if (optimismBridgeData.interfaceId == 2) { OldL1TokenGateway(optimismBridgeData.customBridgeAddress) .depositTo(optimismBridgeData.receiverAddress, amount); return; } if (optimismBridgeData.interfaceId == 3) { OldL1TokenGateway(optimismBridgeData.customBridgeAddress) .initiateSynthTransfer( optimismBridgeData.currencyKey, optimismBridgeData.receiverAddress, amount ); return; } } } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in OptimismBridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param optimismBridgeData encoded data for OptimismBridgeData */ function swapAndBridge( uint32 swapId, bytes calldata swapData, OptimismBridgeDataNoToken calldata optimismBridgeData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); emit SocketBridge( bridgeAmount, token, DESTINATION_CHAIN_ID, NativeOptimismIdentifier, msg.sender, optimismBridgeData.receiverAddress, optimismBridgeData.metadata ); if (token == NATIVE_TOKEN_ADDRESS) { L1StandardBridge(optimismBridgeData.customBridgeAddress) .depositETHTo{value: bridgeAmount}( optimismBridgeData.receiverAddress, optimismBridgeData.l2Gas, optimismBridgeData.data ); } else { if (optimismBridgeData.interfaceId == 0) { revert UnsupportedInterfaceId(); } ERC20(token).safeApprove( optimismBridgeData.customBridgeAddress, bridgeAmount ); if (optimismBridgeData.interfaceId == 1) { // deposit into standard bridge L1StandardBridge(optimismBridgeData.customBridgeAddress) .depositERC20To( token, optimismBridgeData.l2Token, optimismBridgeData.receiverAddress, bridgeAmount, optimismBridgeData.l2Gas, optimismBridgeData.data ); return; } // Deposit Using Old Standard - iOVM_L1TokenGateway(Example - SNX Token) if (optimismBridgeData.interfaceId == 2) { OldL1TokenGateway(optimismBridgeData.customBridgeAddress) .depositTo( optimismBridgeData.receiverAddress, bridgeAmount ); return; } if (optimismBridgeData.interfaceId == 3) { OldL1TokenGateway(optimismBridgeData.customBridgeAddress) .initiateSynthTransfer( optimismBridgeData.currencyKey, optimismBridgeData.receiverAddress, bridgeAmount ); return; } } } /** * @notice function to handle ERC20 bridging to receipent via NativeOptimism-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param token address of token being bridged * @param receiverAddress address of receiver of bridged tokens * @param customBridgeAddress OptimismBridge that Performs the logic for deposits by informing the L2 Deposited Token * contract of the deposit and calling a handler to lock the L1 funds. (e.g. transferFrom) * @param l2Gas Gas limit required to complete the deposit on L2. * @param optimismData extra data needed for optimism bridge * @param amount amount being bridged * @param interfaceId interfaceId to be set offchain which is used to select one of the 3 kinds of bridging (standard bridge / old standard / synthetic) * @param l2Token Address of the L1 respective L2 ERC20 * @param data additional data , for ll contracts this will be 0x data or empty data */ function bridgeERC20To( address token, address receiverAddress, address customBridgeAddress, uint32 l2Gas, OptimismERC20Data calldata optimismData, uint256 amount, uint256 interfaceId, address l2Token, bytes calldata data ) external payable { if (interfaceId == 0) { revert UnsupportedInterfaceId(); } ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(customBridgeAddress, amount); emit SocketBridge( amount, token, DESTINATION_CHAIN_ID, NativeOptimismIdentifier, msg.sender, receiverAddress, optimismData.metadata ); if (interfaceId == 1) { // deposit into standard bridge L1StandardBridge(customBridgeAddress).depositERC20To( token, l2Token, receiverAddress, amount, l2Gas, data ); return; } // Deposit Using Old Standard - iOVM_L1TokenGateway(Example - SNX Token) if (interfaceId == 2) { OldL1TokenGateway(customBridgeAddress).depositTo( receiverAddress, amount ); return; } if (interfaceId == 3) { OldL1TokenGateway(customBridgeAddress).initiateSynthTransfer( optimismData.currencyKey, receiverAddress, amount ); return; } } /** * @notice function to handle native balance bridging to receipent via NativeOptimism-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param receiverAddress address of receiver of bridged tokens * @param customBridgeAddress OptimismBridge that Performs the logic for deposits by informing the L2 Deposited Token * contract of the deposit and calling a handler to lock the L1 funds. (e.g. transferFrom) * @param l2Gas Gas limit required to complete the deposit on L2. * @param amount amount being bridged * @param data additional data , for ll contracts this will be 0x data or empty data */ function bridgeNativeTo( address receiverAddress, address customBridgeAddress, uint32 l2Gas, uint256 amount, bytes32 metadata, bytes calldata data ) external payable { L1StandardBridge(customBridgeAddress).depositETHTo{value: amount}( receiverAddress, l2Gas, data ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, DESTINATION_CHAIN_ID, NativeOptimismIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; /** * @title RootChain Manager Interface for Polygon Bridge. */ interface IRootChainManager { /** * @notice Move ether from root to child chain, accepts ether transfer * Keep in mind this ether cannot be used to pay gas on child chain * Use Matic tokens deposited using plasma mechanism for that * @param user address of account that should receive WETH on child chain */ function depositEtherFor(address user) external payable; /** * @notice Move tokens from root to child chain * @dev This mechanism supports arbitrary tokens as long as its predicate has been registered and the token is mapped * @param sender address of account that should receive this deposit on child chain * @param token address of token that is being deposited * @param extraData bytes data that is sent to predicate and child token contracts to handle deposit */ function depositFor( address sender, address token, bytes memory extraData ) external; } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import "./interfaces/polygon.sol"; import {BridgeImplBase} from "../BridgeImplBase.sol"; import {NATIVE_POLYGON} from "../../static/RouteIdentifiers.sol"; /** * @title NativePolygon-Route Implementation * @notice This is the L1 implementation, so this is used when transferring from ethereum to polygon via their native bridge. * @author Socket dot tech. */ contract NativePolygonImpl is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable NativePolyonIdentifier = NATIVE_POLYGON; /// @notice destination-chain-Id for this router is always arbitrum uint256 public constant DESTINATION_CHAIN_ID = 137; /// @notice Function-selector for ERC20-token bridging on NativePolygon-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable NATIVE_POLYGON_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4(keccak256("bridgeERC20To(uint256,bytes32,address,address)")); /// @notice Function-selector for Native bridging on NativePolygon-Route /// @dev This function selector is to be used while buidling transaction-data to bridge Native tokens bytes4 public immutable NATIVE_POLYGON_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4(keccak256("bridgeNativeTo(uint256,bytes32,address)")); bytes4 public immutable NATIVE_POLYGON_SWAP_BRIDGE_SELECTOR = bytes4(keccak256("swapAndBridge(uint32,address,bytes32,bytes)")); /// @notice root chain manager proxy on the ethereum chain /// @dev to be initialised in the constructor IRootChainManager public immutable rootChainManagerProxy; /// @notice ERC20 Predicate proxy on the ethereum chain /// @dev to be initialised in the constructor address public immutable erc20PredicateProxy; /** * // @notice We set all the required addresses in the constructor while deploying the contract. * // These will be constant addresses. * // @dev Please use the Proxy addresses and not the implementation addresses while setting these * // @param _rootChainManagerProxy address of the root chain manager proxy on the ethereum chain * // @param _erc20PredicateProxy address of the ERC20 Predicate proxy on the ethereum chain. * // @param _socketGateway address of the socketGateway contract that calls this contract */ constructor( address _rootChainManagerProxy, address _erc20PredicateProxy, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { rootChainManagerProxy = IRootChainManager(_rootChainManagerProxy); erc20PredicateProxy = _erc20PredicateProxy; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in NativePolygon-BridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for NativePolygon-Bridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { (address token, address receiverAddress, bytes32 metadata) = abi.decode( bridgeData, (address, address, bytes32) ); if (token == NATIVE_TOKEN_ADDRESS) { IRootChainManager(rootChainManagerProxy).depositEtherFor{ value: amount }(receiverAddress); } else { ERC20(token).safeApprove(erc20PredicateProxy, amount); // deposit into rootchain manager IRootChainManager(rootChainManagerProxy).depositFor( receiverAddress, token, abi.encodePacked(amount) ); } emit SocketBridge( amount, token, DESTINATION_CHAIN_ID, NativePolyonIdentifier, msg.sender, receiverAddress, metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in NativePolygon-BridgeData struct * @param swapId routeId for the swapImpl * @param receiverAddress address of the receiver * @param swapData encoded data for swap */ function swapAndBridge( uint32 swapId, address receiverAddress, bytes32 metadata, bytes calldata swapData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); if (token == NATIVE_TOKEN_ADDRESS) { IRootChainManager(rootChainManagerProxy).depositEtherFor{ value: bridgeAmount }(receiverAddress); } else { ERC20(token).safeApprove(erc20PredicateProxy, bridgeAmount); // deposit into rootchain manager IRootChainManager(rootChainManagerProxy).depositFor( receiverAddress, token, abi.encodePacked(bridgeAmount) ); } emit SocketBridge( bridgeAmount, token, DESTINATION_CHAIN_ID, NativePolyonIdentifier, msg.sender, receiverAddress, metadata ); } /** * @notice function to handle ERC20 bridging to receipent via NativePolygon-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount of tokens being bridged * @param receiverAddress recipient address * @param token address of token being bridged */ function bridgeERC20To( uint256 amount, bytes32 metadata, address receiverAddress, address token ) external payable { ERC20 tokenInstance = ERC20(token); // set allowance for erc20 predicate tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(erc20PredicateProxy, amount); // deposit into rootchain manager rootChainManagerProxy.depositFor( receiverAddress, token, abi.encodePacked(amount) ); emit SocketBridge( amount, token, DESTINATION_CHAIN_ID, NativePolyonIdentifier, msg.sender, receiverAddress, metadata ); } /** * @notice function to handle Native bridging to receipent via NativePolygon-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount of tokens being bridged * @param receiverAddress recipient address */ function bridgeNativeTo( uint256 amount, bytes32 metadata, address receiverAddress ) external payable { rootChainManagerProxy.depositEtherFor{value: amount}(receiverAddress); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, DESTINATION_CHAIN_ID, NativePolyonIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.0; /// @notice interface with functions to interact with Refuel contract interface IRefuel { /** * @notice function to deposit nativeToken to Destination-address on destinationChain * @param destinationChainId chainId of the Destination chain * @param _to recipient address */ function depositNativeToken( uint256 destinationChainId, address _to ) external payable; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import "./interfaces/refuel.sol"; import "../BridgeImplBase.sol"; import {REFUEL} from "../../static/RouteIdentifiers.sol"; /** * @title Refuel-Route Implementation * @notice Route implementation with functions to bridge Native via Refuel-Bridge * Called via SocketGateway if the routeId in the request maps to the routeId of RefuelImplementation * @author Socket dot tech. */ contract RefuelBridgeImpl is BridgeImplBase { bytes32 public immutable RefuelIdentifier = REFUEL; /// @notice refuelBridge-Contract address used to deposit Native on Refuel-Bridge address public immutable refuelBridge; /// @notice Function-selector for Native bridging via Refuel-Bridge /// @dev This function selector is to be used while buidling transaction-data to bridge Native tokens bytes4 public immutable REFUEL_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4(keccak256("bridgeNativeTo(uint256,address,uint256,bytes32)")); bytes4 public immutable REFUEL_NATIVE_SWAP_BRIDGE_SELECTOR = bytes4( keccak256("swapAndBridge(uint32,address,uint256,bytes32,bytes)") ); /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase /// @dev ensure _refuelBridge are set properly for the chainId in which the contract is being deployed constructor( address _refuelBridge, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { refuelBridge = _refuelBridge; } // Function to receive Ether. msg.data must be empty receive() external payable {} /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct RefuelBridgeData { address receiverAddress; uint256 toChainId; bytes32 metadata; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in RefuelBridgeData struct * @param amount amount of tokens being bridged. this must be only native * @param bridgeData encoded data for RefuelBridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { RefuelBridgeData memory refuelBridgeData = abi.decode( bridgeData, (RefuelBridgeData) ); IRefuel(refuelBridge).depositNativeToken{value: amount}( refuelBridgeData.toChainId, refuelBridgeData.receiverAddress ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, refuelBridgeData.toChainId, RefuelIdentifier, msg.sender, refuelBridgeData.receiverAddress, refuelBridgeData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in RefuelBridgeData struct * @param swapId routeId for the swapImpl * @param receiverAddress receiverAddress * @param toChainId toChainId * @param swapData encoded data for swap */ function swapAndBridge( uint32 swapId, address receiverAddress, uint256 toChainId, bytes32 metadata, bytes calldata swapData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, ) = abi.decode(result, (uint256, address)); IRefuel(refuelBridge).depositNativeToken{value: bridgeAmount}( toChainId, receiverAddress ); emit SocketBridge( bridgeAmount, NATIVE_TOKEN_ADDRESS, toChainId, RefuelIdentifier, msg.sender, receiverAddress, metadata ); } /** * @notice function to handle Native bridging to receipent via Refuel-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param amount amount of native being refuelled to destination chain * @param receiverAddress recipient address of the refuelled native * @param toChainId destinationChainId */ function bridgeNativeTo( uint256 amount, address receiverAddress, uint256 toChainId, bytes32 metadata ) external payable { IRefuel(refuelBridge).depositNativeToken{value: amount}( toChainId, receiverAddress ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, toChainId, RefuelIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: GPL-3.0-only pragma solidity >=0.8.0; /** * @title IBridgeStargate Interface Contract. * @notice Interface used by Stargate-L1 and L2 Router implementations * @dev router and routerETH addresses will be distinct for L1 and L2 */ interface IBridgeStargate { // @notice Struct to hold the additional-data for bridging ERC20 token struct lzTxObj { // gas limit to bridge the token in Stargate to destinationChain uint256 dstGasForCall; // destination nativeAmount, this is always set as 0 uint256 dstNativeAmount; // destination nativeAddress, this is always set as 0x bytes dstNativeAddr; } /// @notice function in stargate bridge which is used to bridge ERC20 tokens to recipient on destinationChain function swap( uint16 _dstChainId, uint256 _srcPoolId, uint256 _dstPoolId, address payable _refundAddress, uint256 _amountLD, uint256 _minAmountLD, lzTxObj memory _lzTxParams, bytes calldata _to, bytes calldata _payload ) external payable; /// @notice function in stargate bridge which is used to bridge native tokens to recipient on destinationChain function swapETH( uint16 _dstChainId, // destination Stargate chainId address payable _refundAddress, // refund additional messageFee to this address bytes calldata _toAddress, // the receiver of the destination ETH uint256 _amountLD, // the amount, in Local Decimals, to be swapped uint256 _minAmountLD // the minimum amount accepted out on destination ) external payable; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import "../interfaces/stargate.sol"; import {BridgeImplBase} from "../../BridgeImplBase.sol"; import {STARGATE} from "../../../static/RouteIdentifiers.sol"; /** * @title Stargate-L1-Route Implementation * @notice Route implementation with functions to bridge ERC20 and Native via Stargate-L1-Bridge * Called via SocketGateway if the routeId in the request maps to the routeId of Stargate-L1-Implementation * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract StargateImplL1 is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable StargateIdentifier = STARGATE; /// @notice Function-selector for ERC20-token bridging on Stargate-L1-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable STARGATE_L1_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(address,address,address,uint256,uint256,(uint256,uint256,uint256,uint256,bytes32,bytes,uint16))" ) ); /// @notice Function-selector for Native bridging on Stargate-L1-Route /// @dev This function selector is to be used while buidling transaction-data to bridge Native tokens bytes4 public immutable STARGATE_L1_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeNativeTo(address,address,uint16,uint256,uint256,uint256,bytes32)" ) ); bytes4 public immutable STARGATE_L1_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(address,address,uint16,uint256,uint256,uint256,uint256,uint256,uint256,bytes32,bytes))" ) ); /// @notice Stargate Router to bridge ERC20 tokens IBridgeStargate public immutable router; /// @notice Stargate Router to bridge native tokens IBridgeStargate public immutable routerETH; /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase /// @dev ensure router, routerEth are set properly for the chainId in which the contract is being deployed constructor( address _router, address _routerEth, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { router = IBridgeStargate(_router); routerETH = IBridgeStargate(_routerEth); } struct StargateBridgeExtraData { uint256 srcPoolId; uint256 dstPoolId; uint256 destinationGasLimit; uint256 minReceivedAmt; bytes32 metadata; bytes destinationPayload; uint16 stargateDstChainId; // stargate defines chain id in its way } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct StargateBridgeDataNoToken { address receiverAddress; address senderAddress; uint16 stargateDstChainId; // stargate defines chain id in its way uint256 value; // a unique identifier that is uses to dedup transfers // this value is the a timestamp sent from frontend, but in theory can be any unique number uint256 srcPoolId; uint256 dstPoolId; uint256 minReceivedAmt; // defines the slippage, the min qty you would accept on the destination uint256 optionalValue; uint256 destinationGasLimit; bytes32 metadata; bytes destinationPayload; } struct StargateBridgeData { address token; address receiverAddress; address senderAddress; uint16 stargateDstChainId; // stargate defines chain id in its way uint256 value; // a unique identifier that is uses to dedup transfers // this value is the a timestamp sent from frontend, but in theory can be any unique number uint256 srcPoolId; uint256 dstPoolId; uint256 minReceivedAmt; // defines the slippage, the min qty you would accept on the destination uint256 optionalValue; uint256 destinationGasLimit; bytes32 metadata; bytes destinationPayload; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in Stargate-BridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for Stargate-L1-Bridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { StargateBridgeData memory stargateBridgeData = abi.decode( bridgeData, (StargateBridgeData) ); if (stargateBridgeData.token == NATIVE_TOKEN_ADDRESS) { // perform bridging routerETH.swapETH{value: amount + stargateBridgeData.optionalValue}( stargateBridgeData.stargateDstChainId, payable(stargateBridgeData.senderAddress), abi.encodePacked(stargateBridgeData.receiverAddress), amount, stargateBridgeData.minReceivedAmt ); } else { ERC20(stargateBridgeData.token).safeApprove( address(router), amount ); { router.swap{value: stargateBridgeData.value}( stargateBridgeData.stargateDstChainId, stargateBridgeData.srcPoolId, stargateBridgeData.dstPoolId, payable(stargateBridgeData.senderAddress), // default to refund to main contract amount, stargateBridgeData.minReceivedAmt, IBridgeStargate.lzTxObj( stargateBridgeData.destinationGasLimit, 0, // zero amount since this is a ERC20 bridging "0x" //empty data since this is for only ERC20 ), abi.encodePacked(stargateBridgeData.receiverAddress), stargateBridgeData.destinationPayload ); } } emit SocketBridge( amount, stargateBridgeData.token, stargateBridgeData.stargateDstChainId, StargateIdentifier, msg.sender, stargateBridgeData.receiverAddress, stargateBridgeData.metadata ); } /** * @notice function to bridge tokens after swap. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in Stargate-BridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param stargateBridgeData encoded data for StargateBridgeData */ function swapAndBridge( uint32 swapId, bytes calldata swapData, StargateBridgeDataNoToken calldata stargateBridgeData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); if (token == NATIVE_TOKEN_ADDRESS) { // perform bridging routerETH.swapETH{ value: bridgeAmount + stargateBridgeData.optionalValue }( stargateBridgeData.stargateDstChainId, payable(stargateBridgeData.senderAddress), abi.encodePacked(stargateBridgeData.receiverAddress), bridgeAmount, stargateBridgeData.minReceivedAmt ); } else { ERC20(token).safeApprove(address(router), bridgeAmount); { router.swap{value: stargateBridgeData.value}( stargateBridgeData.stargateDstChainId, stargateBridgeData.srcPoolId, stargateBridgeData.dstPoolId, payable(stargateBridgeData.senderAddress), // default to refund to main contract bridgeAmount, stargateBridgeData.minReceivedAmt, IBridgeStargate.lzTxObj( stargateBridgeData.destinationGasLimit, 0, // zero amount since this is a ERC20 bridging "0x" //empty data since this is for only ERC20 ), abi.encodePacked(stargateBridgeData.receiverAddress), stargateBridgeData.destinationPayload ); } } emit SocketBridge( bridgeAmount, token, stargateBridgeData.stargateDstChainId, StargateIdentifier, msg.sender, stargateBridgeData.receiverAddress, stargateBridgeData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Stargate-L1-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param token address of token being bridged * @param senderAddress address of sender * @param receiverAddress address of recipient * @param amount amount of token being bridge * @param value value * @param stargateBridgeExtraData stargate bridge extradata */ function bridgeERC20To( address token, address senderAddress, address receiverAddress, uint256 amount, uint256 value, StargateBridgeExtraData calldata stargateBridgeExtraData ) external payable { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(address(router), amount); { router.swap{value: value}( stargateBridgeExtraData.stargateDstChainId, stargateBridgeExtraData.srcPoolId, stargateBridgeExtraData.dstPoolId, payable(senderAddress), // default to refund to main contract amount, stargateBridgeExtraData.minReceivedAmt, IBridgeStargate.lzTxObj( stargateBridgeExtraData.destinationGasLimit, 0, // zero amount since this is a ERC20 bridging "0x" //empty data since this is for only ERC20 ), abi.encodePacked(receiverAddress), stargateBridgeExtraData.destinationPayload ); } emit SocketBridge( amount, token, stargateBridgeExtraData.stargateDstChainId, StargateIdentifier, msg.sender, receiverAddress, stargateBridgeExtraData.metadata ); } /** * @notice function to handle Native bridging to receipent via Stargate-L1-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param receiverAddress address of receipient * @param senderAddress address of sender * @param stargateDstChainId stargate defines chain id in its way * @param amount amount of token being bridge * @param minReceivedAmt defines the slippage, the min qty you would accept on the destination * @param optionalValue optionalValue Native amount */ function bridgeNativeTo( address receiverAddress, address senderAddress, uint16 stargateDstChainId, uint256 amount, uint256 minReceivedAmt, uint256 optionalValue, bytes32 metadata ) external payable { // perform bridging routerETH.swapETH{value: amount + optionalValue}( stargateDstChainId, payable(senderAddress), abi.encodePacked(receiverAddress), amount, minReceivedAmt ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, stargateDstChainId, StargateIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import "../interfaces/stargate.sol"; import "../../../errors/SocketErrors.sol"; import {BridgeImplBase} from "../../BridgeImplBase.sol"; import {STARGATE} from "../../../static/RouteIdentifiers.sol"; /** * @title Stargate-L2-Route Implementation * @notice Route implementation with functions to bridge ERC20 and Native via Stargate-L2-Bridge * Called via SocketGateway if the routeId in the request maps to the routeId of Stargate-L2-Implementation * Contains function to handle bridging as post-step i.e linked to a preceeding step for swap * RequestData is different to just bride and bridging chained with swap * @author Socket dot tech. */ contract StargateImplL2 is BridgeImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable StargateIdentifier = STARGATE; /// @notice Function-selector for ERC20-token bridging on Stargate-L2-Route /// @dev This function selector is to be used while buidling transaction-data to bridge ERC20 tokens bytes4 public immutable STARGATE_L2_ERC20_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeERC20To(address,address,address,uint256,uint256,uint256,(uint256,uint256,uint256,uint256,bytes32,bytes,uint16))" ) ); bytes4 public immutable STARGATE_L1_SWAP_BRIDGE_SELECTOR = bytes4( keccak256( "swapAndBridge(uint32,bytes,(address,address,uint16,uint256,uint256,uint256,uint256,uint256,uint256,bytes32,bytes))" ) ); /// @notice Function-selector for Native bridging on Stargate-L2-Route /// @dev This function selector is to be used while buidling transaction-data to bridge Native tokens bytes4 public immutable STARGATE_L2_NATIVE_EXTERNAL_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "bridgeNativeTo(address,address,uint16,uint256,uint256,uint256,bytes32)" ) ); /// @notice Stargate Router to bridge ERC20 tokens IBridgeStargate public immutable router; /// @notice Stargate Router to bridge native tokens IBridgeStargate public immutable routerETH; /// @notice socketGatewayAddress to be initialised via storage variable BridgeImplBase /// @dev ensure router, routerEth are set properly for the chainId in which the contract is being deployed constructor( address _router, address _routerEth, address _socketGateway, address _socketDeployFactory ) BridgeImplBase(_socketGateway, _socketDeployFactory) { router = IBridgeStargate(_router); routerETH = IBridgeStargate(_routerEth); } /// @notice Struct to be used as a input parameter for Bridging tokens via Stargate-L2-route /// @dev while building transactionData,values should be set in this sequence of properties in this struct struct StargateBridgeExtraData { uint256 srcPoolId; uint256 dstPoolId; uint256 destinationGasLimit; uint256 minReceivedAmt; bytes32 metadata; bytes destinationPayload; uint16 stargateDstChainId; // stargate defines chain id in its way } /// @notice Struct to be used in decode step from input parameter - a specific case of bridging after swap. /// @dev the data being encoded in offchain or by caller should have values set in this sequence of properties in this struct struct StargateBridgeDataNoToken { address receiverAddress; address senderAddress; uint16 stargateDstChainId; // stargate defines chain id in its way uint256 value; // a unique identifier that is uses to dedup transfers // this value is the a timestamp sent from frontend, but in theory can be any unique number uint256 srcPoolId; uint256 dstPoolId; uint256 minReceivedAmt; // defines the slippage, the min qty you would accept on the destination uint256 optionalValue; uint256 destinationGasLimit; bytes32 metadata; bytes destinationPayload; } struct StargateBridgeData { address token; address receiverAddress; address senderAddress; uint16 stargateDstChainId; // stargate defines chain id in its way uint256 value; // a unique identifier that is uses to dedup transfers // this value is the a timestamp sent from frontend, but in theory can be any unique number uint256 srcPoolId; uint256 dstPoolId; uint256 minReceivedAmt; // defines the slippage, the min qty you would accept on the destination uint256 optionalValue; uint256 destinationGasLimit; bytes32 metadata; bytes destinationPayload; } /** * @notice function to bridge tokens after swap. * @notice this is different from swapAndBridge, this function is called when the swap has already happened at a different place. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in Stargate-BridgeData struct * @param amount amount of tokens being bridged. this can be ERC20 or native * @param bridgeData encoded data for Stargate-L1-Bridge */ function bridgeAfterSwap( uint256 amount, bytes calldata bridgeData ) external payable override { StargateBridgeData memory stargateBridgeData = abi.decode( bridgeData, (StargateBridgeData) ); if (stargateBridgeData.token == NATIVE_TOKEN_ADDRESS) { // perform bridging routerETH.swapETH{value: amount + stargateBridgeData.optionalValue}( stargateBridgeData.stargateDstChainId, payable(stargateBridgeData.senderAddress), abi.encodePacked(stargateBridgeData.receiverAddress), amount, stargateBridgeData.minReceivedAmt ); } else { ERC20(stargateBridgeData.token).safeApprove( address(router), amount ); { router.swap{value: stargateBridgeData.value}( stargateBridgeData.stargateDstChainId, stargateBridgeData.srcPoolId, stargateBridgeData.dstPoolId, payable(stargateBridgeData.senderAddress), // default to refund to main contract amount, stargateBridgeData.minReceivedAmt, IBridgeStargate.lzTxObj( stargateBridgeData.destinationGasLimit, 0, // zero amount since this is a ERC20 bridging "0x" //empty data since this is for only ERC20 ), abi.encodePacked(stargateBridgeData.receiverAddress), stargateBridgeData.destinationPayload ); } } emit SocketBridge( amount, stargateBridgeData.token, stargateBridgeData.stargateDstChainId, StargateIdentifier, msg.sender, stargateBridgeData.receiverAddress, stargateBridgeData.metadata ); } /** * @notice function to bridge tokens after swapping. * @notice this is different from bridgeAfterSwap since this function holds the logic for swapping tokens too. * @notice This method is payable because the caller is doing token transfer and briding operation * @dev for usage, refer to controller implementations * encodedData for bridge should follow the sequence of properties in Stargate-BridgeData struct * @param swapId routeId for the swapImpl * @param swapData encoded data for swap * @param stargateBridgeData encoded data for StargateBridgeData */ function swapAndBridge( uint32 swapId, bytes calldata swapData, StargateBridgeDataNoToken calldata stargateBridgeData ) external payable { (bool success, bytes memory result) = socketRoute .getRoute(swapId) .delegatecall(swapData); if (!success) { assembly { revert(add(result, 32), mload(result)) } } (uint256 bridgeAmount, address token) = abi.decode( result, (uint256, address) ); if (token == NATIVE_TOKEN_ADDRESS) { routerETH.swapETH{ value: bridgeAmount + stargateBridgeData.optionalValue }( stargateBridgeData.stargateDstChainId, payable(stargateBridgeData.senderAddress), abi.encodePacked(stargateBridgeData.receiverAddress), bridgeAmount, stargateBridgeData.minReceivedAmt ); } else { ERC20(token).safeApprove(address(router), bridgeAmount); { router.swap{value: stargateBridgeData.value}( stargateBridgeData.stargateDstChainId, stargateBridgeData.srcPoolId, stargateBridgeData.dstPoolId, payable(stargateBridgeData.senderAddress), // default to refund to main contract bridgeAmount, stargateBridgeData.minReceivedAmt, IBridgeStargate.lzTxObj( stargateBridgeData.destinationGasLimit, 0, "0x" ), abi.encodePacked(stargateBridgeData.receiverAddress), stargateBridgeData.destinationPayload ); } } emit SocketBridge( bridgeAmount, token, stargateBridgeData.stargateDstChainId, StargateIdentifier, msg.sender, stargateBridgeData.receiverAddress, stargateBridgeData.metadata ); } /** * @notice function to handle ERC20 bridging to receipent via Stargate-L1-Bridge * @notice This method is payable because the caller is doing token transfer and briding operation * @param token address of token being bridged * @param senderAddress address of sender * @param receiverAddress address of recipient * @param amount amount of token being bridge * @param value value * @param optionalValue optionalValue * @param stargateBridgeExtraData stargate bridge extradata */ function bridgeERC20To( address token, address senderAddress, address receiverAddress, uint256 amount, uint256 value, uint256 optionalValue, StargateBridgeExtraData calldata stargateBridgeExtraData ) external payable { // token address might not be indication thats why passed through extraData if (token == NATIVE_TOKEN_ADDRESS) { // perform bridging routerETH.swapETH{value: amount + optionalValue}( stargateBridgeExtraData.stargateDstChainId, payable(senderAddress), abi.encodePacked(receiverAddress), amount, stargateBridgeExtraData.minReceivedAmt ); } else { ERC20 tokenInstance = ERC20(token); tokenInstance.safeTransferFrom(msg.sender, socketGateway, amount); tokenInstance.safeApprove(address(router), amount); { router.swap{value: value}( stargateBridgeExtraData.stargateDstChainId, stargateBridgeExtraData.srcPoolId, stargateBridgeExtraData.dstPoolId, payable(senderAddress), // default to refund to main contract amount, stargateBridgeExtraData.minReceivedAmt, IBridgeStargate.lzTxObj( stargateBridgeExtraData.destinationGasLimit, 0, // zero amount since this is a ERC20 bridging "0x" //empty data since this is for only ERC20 ), abi.encodePacked(receiverAddress), stargateBridgeExtraData.destinationPayload ); } } emit SocketBridge( amount, token, stargateBridgeExtraData.stargateDstChainId, StargateIdentifier, msg.sender, receiverAddress, stargateBridgeExtraData.metadata ); } function bridgeNativeTo( address receiverAddress, address senderAddress, uint16 stargateDstChainId, uint256 amount, uint256 minReceivedAmt, uint256 optionalValue, bytes32 metadata ) external payable { // perform bridging routerETH.swapETH{value: amount + optionalValue}( stargateDstChainId, payable(senderAddress), abi.encodePacked(receiverAddress), amount, minReceivedAmt ); emit SocketBridge( amount, NATIVE_TOKEN_ADDRESS, stargateDstChainId, StargateIdentifier, msg.sender, receiverAddress, metadata ); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {ISocketRequest} from "../interfaces/ISocketRequest.sol"; import {ISocketRoute} from "../interfaces/ISocketRoute.sol"; /// @title BaseController Controller /// @notice Base contract for all controller contracts abstract contract BaseController { /// @notice Address used to identify if it is a native token transfer or not address public immutable NATIVE_TOKEN_ADDRESS = address(0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE); /// @notice Address used to identify if it is a Zero address address public immutable NULL_ADDRESS = address(0); /// @notice FunctionSelector used to delegatecall from swap to the function of bridge router implementation bytes4 public immutable BRIDGE_AFTER_SWAP_SELECTOR = bytes4(keccak256("bridgeAfterSwap(uint256,bytes)")); /// @notice immutable variable to store the socketGateway address address public immutable socketGatewayAddress; /// @notice immutable variable with instance of SocketRoute to access route functions ISocketRoute public immutable socketRoute; /** * @notice Construct the base for all controllers. * @param _socketGatewayAddress Socketgateway address, an immutable variable to set. * @notice initialize the immutable variables of SocketRoute, SocketGateway */ constructor(address _socketGatewayAddress) { socketGatewayAddress = _socketGatewayAddress; socketRoute = ISocketRoute(_socketGatewayAddress); } /** * @notice Construct the base for all BridgeImplementations. * @param routeId routeId mapped to the routrImplementation * @param data transactionData generated with arguments of bridgeRequest (offchain or by caller) * @return returns the bytes response of the route execution (bridging, refuel or swap executions) */ function _executeRoute( uint32 routeId, bytes memory data ) internal returns (bytes memory) { (bool success, bytes memory result) = socketRoute .getRoute(routeId) .delegatecall(data); if (!success) { assembly { revert(add(result, 32), mload(result)) } } return result; } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {BaseController} from "./BaseController.sol"; import {ISocketRequest} from "../interfaces/ISocketRequest.sol"; /** * @title FeesTaker-Controller Implementation * @notice Controller with composed actions to deduct-fees followed by Refuel, Swap and Bridge * to be executed Sequentially and this is atomic * @author Socket dot tech. */ contract FeesTakerController is BaseController { using SafeTransferLib for ERC20; /// @notice event emitted upon fee-deduction to fees-taker address event SocketFeesDeducted( uint256 fees, address feesToken, address feesTaker ); /// @notice Function-selector to invoke deduct-fees and swap token /// @dev This function selector is to be used while building transaction-data bytes4 public immutable FEES_TAKER_SWAP_FUNCTION_SELECTOR = bytes4( keccak256("takeFeesAndSwap((address,address,uint256,uint32,bytes))") ); /// @notice Function-selector to invoke deduct-fees and bridge token /// @dev This function selector is to be used while building transaction-data bytes4 public immutable FEES_TAKER_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "takeFeesAndBridge((address,address,uint256,uint32,bytes))" ) ); /// @notice Function-selector to invoke deduct-fees and bridge multiple tokens /// @dev This function selector is to be used while building transaction-data bytes4 public immutable FEES_TAKER_MULTI_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "takeFeesAndMultiBridge((address,address,uint256,uint32[],bytes[]))" ) ); /// @notice Function-selector to invoke deduct-fees followed by swapping of a token and bridging the swapped bridge /// @dev This function selector is to be used while building transaction-data bytes4 public immutable FEES_TAKER_SWAP_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "takeFeeAndSwapAndBridge((address,address,uint256,uint32,bytes,uint32,bytes))" ) ); /// @notice Function-selector to invoke deduct-fees refuel /// @notice followed by swapping of a token and bridging the swapped bridge /// @dev This function selector is to be used while building transaction-data bytes4 public immutable FEES_TAKER_REFUEL_SWAP_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "takeFeeAndRefuelAndSwapAndBridge((address,address,uint256,uint32,bytes,uint32,bytes,uint32,bytes))" ) ); /// @notice socketGatewayAddress to be initialised via storage variable BaseController constructor( address _socketGatewayAddress ) BaseController(_socketGatewayAddress) {} /** * @notice function to deduct-fees to fees-taker address on source-chain and swap token * @dev ensure correct function selector is used to generate transaction-data for bridgeRequest * @param ftsRequest feesTakerSwapRequest object generated either off-chain or the calling contract using * the function-selector FEES_TAKER_SWAP_FUNCTION_SELECTOR * @return output bytes from the swap operation (last operation in the composed actions) */ function takeFeesAndSwap( ISocketRequest.FeesTakerSwapRequest calldata ftsRequest ) external payable returns (bytes memory) { if (ftsRequest.feesToken == NATIVE_TOKEN_ADDRESS) { //transfer the native amount to the feeTakerAddress payable(ftsRequest.feesTakerAddress).transfer( ftsRequest.feesAmount ); } else { //transfer feesAmount to feesTakerAddress ERC20(ftsRequest.feesToken).safeTransferFrom( msg.sender, ftsRequest.feesTakerAddress, ftsRequest.feesAmount ); } emit SocketFeesDeducted( ftsRequest.feesAmount, ftsRequest.feesTakerAddress, ftsRequest.feesToken ); //call bridge function (executeRoute for the swapRequestData) return _executeRoute(ftsRequest.routeId, ftsRequest.swapRequestData); } /** * @notice function to deduct-fees to fees-taker address on source-chain and bridge amount to destinationChain * @dev ensure correct function selector is used to generate transaction-data for bridgeRequest * @param ftbRequest feesTakerBridgeRequest object generated either off-chain or the calling contract using * the function-selector FEES_TAKER_BRIDGE_FUNCTION_SELECTOR * @return output bytes from the bridge operation (last operation in the composed actions) */ function takeFeesAndBridge( ISocketRequest.FeesTakerBridgeRequest calldata ftbRequest ) external payable returns (bytes memory) { if (ftbRequest.feesToken == NATIVE_TOKEN_ADDRESS) { //transfer the native amount to the feeTakerAddress payable(ftbRequest.feesTakerAddress).transfer( ftbRequest.feesAmount ); } else { //transfer feesAmount to feesTakerAddress ERC20(ftbRequest.feesToken).safeTransferFrom( msg.sender, ftbRequest.feesTakerAddress, ftbRequest.feesAmount ); } emit SocketFeesDeducted( ftbRequest.feesAmount, ftbRequest.feesTakerAddress, ftbRequest.feesToken ); //call bridge function (executeRoute for the bridgeData) return _executeRoute(ftbRequest.routeId, ftbRequest.bridgeRequestData); } /** * @notice function to deduct-fees to fees-taker address on source-chain and bridge amount to destinationChain * @notice multiple bridge-requests are to be generated and sequence and number of routeIds should match with the bridgeData array * @dev ensure correct function selector is used to generate transaction-data for bridgeRequest * @param ftmbRequest feesTakerMultiBridgeRequest object generated either off-chain or the calling contract using * the function-selector FEES_TAKER_MULTI_BRIDGE_FUNCTION_SELECTOR */ function takeFeesAndMultiBridge( ISocketRequest.FeesTakerMultiBridgeRequest calldata ftmbRequest ) external payable { if (ftmbRequest.feesToken == NATIVE_TOKEN_ADDRESS) { //transfer the native amount to the feeTakerAddress payable(ftmbRequest.feesTakerAddress).transfer( ftmbRequest.feesAmount ); } else { //transfer feesAmount to feesTakerAddress ERC20(ftmbRequest.feesToken).safeTransferFrom( msg.sender, ftmbRequest.feesTakerAddress, ftmbRequest.feesAmount ); } emit SocketFeesDeducted( ftmbRequest.feesAmount, ftmbRequest.feesTakerAddress, ftmbRequest.feesToken ); // multiple bridge-requests are to be generated and sequence and number of routeIds should match with the bridgeData array for ( uint256 index = 0; index < ftmbRequest.bridgeRouteIds.length; ++index ) { //call bridge function (executeRoute for the bridgeData) _executeRoute( ftmbRequest.bridgeRouteIds[index], ftmbRequest.bridgeRequestDataItems[index] ); } } /** * @notice function to deduct-fees to fees-taker address on source-chain followed by swap the amount on sourceChain followed by * bridging the swapped amount to destinationChain * @dev while generating implData for swap and bridgeRequests, ensure correct function selector is used * bridge action corresponds to the bridgeAfterSwap function of the bridgeImplementation * @param fsbRequest feesTakerSwapBridgeRequest object generated either off-chain or the calling contract using * the function-selector FEES_TAKER_SWAP_BRIDGE_FUNCTION_SELECTOR */ function takeFeeAndSwapAndBridge( ISocketRequest.FeesTakerSwapBridgeRequest calldata fsbRequest ) external payable returns (bytes memory) { if (fsbRequest.feesToken == NATIVE_TOKEN_ADDRESS) { //transfer the native amount to the feeTakerAddress payable(fsbRequest.feesTakerAddress).transfer( fsbRequest.feesAmount ); } else { //transfer feesAmount to feesTakerAddress ERC20(fsbRequest.feesToken).safeTransferFrom( msg.sender, fsbRequest.feesTakerAddress, fsbRequest.feesAmount ); } emit SocketFeesDeducted( fsbRequest.feesAmount, fsbRequest.feesTakerAddress, fsbRequest.feesToken ); // execute swap operation bytes memory swapResponseData = _executeRoute( fsbRequest.swapRouteId, fsbRequest.swapData ); uint256 swapAmount = abi.decode(swapResponseData, (uint256)); // swapped amount is to be bridged to the recipient on destinationChain bytes memory bridgeImpldata = abi.encodeWithSelector( BRIDGE_AFTER_SWAP_SELECTOR, swapAmount, fsbRequest.bridgeData ); // execute bridge operation and return the byte-data from response of bridge operation return _executeRoute(fsbRequest.bridgeRouteId, bridgeImpldata); } /** * @notice function to deduct-fees to fees-taker address on source-chain followed by refuel followed by * swap the amount on sourceChain followed by bridging the swapped amount to destinationChain * @dev while generating implData for refuel, swap and bridge Requests, ensure correct function selector is used * bridge action corresponds to the bridgeAfterSwap function of the bridgeImplementation * @param frsbRequest feesTakerRefuelSwapBridgeRequest object generated either off-chain or the calling contract using * the function-selector FEES_TAKER_REFUEL_SWAP_BRIDGE_FUNCTION_SELECTOR */ function takeFeeAndRefuelAndSwapAndBridge( ISocketRequest.FeesTakerRefuelSwapBridgeRequest calldata frsbRequest ) external payable returns (bytes memory) { if (frsbRequest.feesToken == NATIVE_TOKEN_ADDRESS) { //transfer the native amount to the feeTakerAddress payable(frsbRequest.feesTakerAddress).transfer( frsbRequest.feesAmount ); } else { //transfer feesAmount to feesTakerAddress ERC20(frsbRequest.feesToken).safeTransferFrom( msg.sender, frsbRequest.feesTakerAddress, frsbRequest.feesAmount ); } emit SocketFeesDeducted( frsbRequest.feesAmount, frsbRequest.feesTakerAddress, frsbRequest.feesToken ); // refuel is also done via bridge execution via refuelRouteImplementation identified by refuelRouteId _executeRoute(frsbRequest.refuelRouteId, frsbRequest.refuelData); // execute swap operation bytes memory swapResponseData = _executeRoute( frsbRequest.swapRouteId, frsbRequest.swapData ); uint256 swapAmount = abi.decode(swapResponseData, (uint256)); // swapped amount is to be bridged to the recipient on destinationChain bytes memory bridgeImpldata = abi.encodeWithSelector( BRIDGE_AFTER_SWAP_SELECTOR, swapAmount, frsbRequest.bridgeData ); // execute bridge operation and return the byte-data from response of bridge operation return _executeRoute(frsbRequest.bridgeRouteId, bridgeImpldata); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {ISocketRequest} from "../interfaces/ISocketRequest.sol"; import {ISocketRoute} from "../interfaces/ISocketRoute.sol"; import {BaseController} from "./BaseController.sol"; /** * @title RefuelSwapAndBridge Controller Implementation * @notice Controller with composed actions for Refuel,Swap and Bridge to be executed Sequentially and this is atomic * @author Socket dot tech. */ contract RefuelSwapAndBridgeController is BaseController { /// @notice Function-selector to invoke refuel-swap-bridge function /// @dev This function selector is to be used while buidling transaction-data bytes4 public immutable REFUEL_SWAP_BRIDGE_FUNCTION_SELECTOR = bytes4( keccak256( "refuelAndSwapAndBridge((uint32,bytes,uint32,bytes,uint32,bytes))" ) ); /// @notice socketGatewayAddress to be initialised via storage variable BaseController constructor( address _socketGatewayAddress ) BaseController(_socketGatewayAddress) {} /** * @notice function to handle refuel followed by Swap and Bridge actions * @notice This method is payable because the caller is doing token transfer and briding operation * @param rsbRequest Request with data to execute refuel followed by swap and bridge * @return output data from bridging operation */ function refuelAndSwapAndBridge( ISocketRequest.RefuelSwapBridgeRequest calldata rsbRequest ) public payable returns (bytes memory) { _executeRoute(rsbRequest.refuelRouteId, rsbRequest.refuelData); // refuel is also a bridging activity via refuel-route-implementation bytes memory swapResponseData = _executeRoute( rsbRequest.swapRouteId, rsbRequest.swapData ); uint256 swapAmount = abi.decode(swapResponseData, (uint256)); //sequence of arguments for implData: amount, token, data // Bridging the swapAmount received in the preceeding step bytes memory bridgeImpldata = abi.encodeWithSelector( BRIDGE_AFTER_SWAP_SELECTOR, swapAmount, rsbRequest.bridgeData ); return _executeRoute(rsbRequest.bridgeRouteId, bridgeImpldata); } } //SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {ISocketGateway} from "../interfaces/ISocketGateway.sol"; import {OnlySocketGatewayOwner} from "../errors/SocketErrors.sol"; contract DisabledSocketRoute { using SafeTransferLib for ERC20; /// @notice immutable variable to store the socketGateway address address public immutable socketGateway; error RouteDisabled(); /** * @notice Construct the base for all BridgeImplementations. * @param _socketGateway Socketgateway address, an immutable variable to set. */ constructor(address _socketGateway) { socketGateway = _socketGateway; } /// @notice Implementing contract needs to make use of the modifier where restricted access is to be used modifier isSocketGatewayOwner() { if (msg.sender != ISocketGateway(socketGateway).owner()) { revert OnlySocketGatewayOwner(); } _; } /** * @notice function to rescue the ERC20 tokens in the bridge Implementation contract * @notice this is a function restricted to Owner of SocketGateway only * @param token address of ERC20 token being rescued * @param userAddress receipient address to which ERC20 tokens will be rescued to * @param amount amount of ERC20 tokens being rescued */ function rescueFunds( address token, address userAddress, uint256 amount ) external isSocketGatewayOwner { ERC20(token).safeTransfer(userAddress, amount); } /** * @notice function to rescue the native-balance in the bridge Implementation contract * @notice this is a function restricted to Owner of SocketGateway only * @param userAddress receipient address to which native-balance will be rescued to * @param amount amount of native balance tokens being rescued */ function rescueEther( address payable userAddress, uint256 amount ) external isSocketGatewayOwner { userAddress.transfer(amount); } /** * @notice Handle route function calls gracefully. */ fallback() external payable { revert RouteDisabled(); } /** * @notice Support receiving ether to handle refunds etc. */ receive() external payable {} } //SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import "../utils/Ownable.sol"; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {ISocketBridgeBase} from "../interfaces/ISocketBridgeBase.sol"; /** * @dev In the constructor, set up the initialization code for socket * contracts as well as the keccak256 hash of the given initialization code. * that will be used to deploy any transient contracts, which will deploy any * socket contracts that require the use of a constructor. * * Socket contract initialization code (29 bytes): * * 0x5860208158601c335a63aaf10f428752fa158151803b80938091923cf3 * * Description: * * pc|op|name | [stack] | <memory> * * ** set the first stack item to zero - used later ** * 00 58 getpc [0] <> * * ** set second stack item to 32, length of word returned from staticcall ** * 01 60 push1 * 02 20 outsize [0, 32] <> * * ** set third stack item to 0, position of word returned from staticcall ** * 03 81 dup2 [0, 32, 0] <> * * ** set fourth stack item to 4, length of selector given to staticcall ** * 04 58 getpc [0, 32, 0, 4] <> * * ** set fifth stack item to 28, position of selector given to staticcall ** * 05 60 push1 * 06 1c inpos [0, 32, 0, 4, 28] <> * * ** set the sixth stack item to msg.sender, target address for staticcall ** * 07 33 caller [0, 32, 0, 4, 28, caller] <> * * ** set the seventh stack item to msg.gas, gas to forward for staticcall ** * 08 5a gas [0, 32, 0, 4, 28, caller, gas] <> * * ** set the eighth stack item to selector, "what" to store via mstore ** * 09 63 push4 * 10 aaf10f42 selector [0, 32, 0, 4, 28, caller, gas, 0xaaf10f42] <> * * ** set the ninth stack item to 0, "where" to store via mstore *** * 11 87 dup8 [0, 32, 0, 4, 28, caller, gas, 0xaaf10f42, 0] <> * * ** call mstore, consume 8 and 9 from the stack, place selector in memory ** * 12 52 mstore [0, 32, 0, 4, 0, caller, gas] <0xaaf10f42> * * ** call staticcall, consume items 2 through 7, place address in memory ** * 13 fa staticcall [0, 1 (if successful)] <address> * * ** flip success bit in second stack item to set to 0 ** * 14 15 iszero [0, 0] <address> * * ** push a third 0 to the stack, position of address in memory ** * 15 81 dup2 [0, 0, 0] <address> * * ** place address from position in memory onto third stack item ** * 16 51 mload [0, 0, address] <> * * ** place address to fourth stack item for extcodesize to consume ** * 17 80 dup1 [0, 0, address, address] <> * * ** get extcodesize on fourth stack item for extcodecopy ** * 18 3b extcodesize [0, 0, address, size] <> * * ** dup and swap size for use by return at end of init code ** * 19 80 dup1 [0, 0, address, size, size] <> * 20 93 swap4 [size, 0, address, size, 0] <> * * ** push code position 0 to stack and reorder stack items for extcodecopy ** * 21 80 dup1 [size, 0, address, size, 0, 0] <> * 22 91 swap2 [size, 0, address, 0, 0, size] <> * 23 92 swap3 [size, 0, size, 0, 0, address] <> * * ** call extcodecopy, consume four items, clone runtime code to memory ** * 24 3c extcodecopy [size, 0] <code> * * ** return to deploy final code in memory ** * 25 f3 return [] *deployed!* */ contract SocketDeployFactory is Ownable { using SafeTransferLib for ERC20; address public immutable disabledRouteAddress; mapping(address => address) _implementations; mapping(uint256 => bool) isDisabled; mapping(uint256 => bool) isRouteDeployed; mapping(address => bool) canDisableRoute; event Deployed(address _addr); event DisabledRoute(address _addr); event Destroyed(address _addr); error ContractAlreadyDeployed(); error NothingToDestroy(); error AlreadyDisabled(); error CannotBeDisabled(); error OnlyDisabler(); constructor(address _owner, address disabledRoute) Ownable(_owner) { disabledRouteAddress = disabledRoute; canDisableRoute[_owner] = true; } modifier onlyDisabler() { if (!canDisableRoute[msg.sender]) { revert OnlyDisabler(); } _; } function addDisablerAddress(address disabler) external onlyOwner { canDisableRoute[disabler] = true; } function removeDisablerAddress(address disabler) external onlyOwner { canDisableRoute[disabler] = false; } /** * @notice Deploys a route contract at predetermined location * @notice Caller must first deploy the route contract at another location and pass its address as implementation. * @param routeId route identifier * @param implementationContract address of deployed route contract. Its byte code will be copied to predetermined location. */ function deploy( uint256 routeId, address implementationContract ) external onlyOwner returns (address) { // assign the initialization code for the socket contract. bytes memory initCode = ( hex"5860208158601c335a63aaf10f428752fa158151803b80938091923cf3" ); // determine the address of the socket contract. address routeContractAddress = _getContractAddress(routeId); if (isRouteDeployed[routeId]) { revert ContractAlreadyDeployed(); } isRouteDeployed[routeId] = true; //first we deploy the code we want to deploy on a separate address // store the implementation to be retrieved by the socket contract. _implementations[routeContractAddress] = implementationContract; address addr; assembly { let encoded_data := add(0x20, initCode) // load initialization code. let encoded_size := mload(initCode) // load init code's length. addr := create2(0, encoded_data, encoded_size, routeId) // routeId is used as salt } require( addr == routeContractAddress, "Failed to deploy the new socket contract." ); emit Deployed(addr); return addr; } /** * @notice Destroy the route deployed at a location. * @param routeId route identifier to be destroyed. */ function destroy(uint256 routeId) external onlyDisabler { // determine the address of the socket contract. _destroy(routeId); } /** * @notice Deploy a disabled contract at destroyed route to handle it gracefully. * @param routeId route identifier to be disabled. */ function disableRoute( uint256 routeId ) external onlyDisabler returns (address) { return _disableRoute(routeId); } /** * @notice Destroy a list of routeIds * @param routeIds array of routeIds to be destroyed. */ function multiDestroy(uint256[] calldata routeIds) external onlyDisabler { for (uint32 index = 0; index < routeIds.length; ) { _destroy(routeIds[index]); unchecked { ++index; } } } /** * @notice Deploy a disabled contract at list of routeIds. * @param routeIds array of routeIds to be disabled. */ function multiDisableRoute( uint256[] calldata routeIds ) external onlyDisabler { for (uint32 index = 0; index < routeIds.length; ) { _disableRoute(routeIds[index]); unchecked { ++index; } } } /** * @dev External view function for calculating a socket contract address * given a particular routeId. */ function getContractAddress( uint256 routeId ) external view returns (address) { // determine the address of the socket contract. return _getContractAddress(routeId); } //those two functions are getting called by the socket Contract function getImplementation() external view returns (address implementation) { return _implementations[msg.sender]; } function _disableRoute(uint256 routeId) internal returns (address) { // assign the initialization code for the socket contract. bytes memory initCode = ( hex"5860208158601c335a63aaf10f428752fa158151803b80938091923cf3" ); // determine the address of the socket contract. address routeContractAddress = _getContractAddress(routeId); if (!isRouteDeployed[routeId]) { revert CannotBeDisabled(); } if (isDisabled[routeId]) { revert AlreadyDisabled(); } isDisabled[routeId] = true; //first we deploy the code we want to deploy on a separate address // store the implementation to be retrieved by the socket contract. _implementations[routeContractAddress] = disabledRouteAddress; address addr; assembly { let encoded_data := add(0x20, initCode) // load initialization code. let encoded_size := mload(initCode) // load init code's length. addr := create2(0, encoded_data, encoded_size, routeId) // routeId is used as salt. } require( addr == routeContractAddress, "Failed to deploy the new socket contract." ); emit Deployed(addr); return addr; } function _destroy(uint256 routeId) internal { // determine the address of the socket contract. address routeContractAddress = _getContractAddress(routeId); if (!isRouteDeployed[routeId]) { revert NothingToDestroy(); } ISocketBridgeBase(routeContractAddress).killme(); emit Destroyed(routeContractAddress); } /** * @dev Internal view function for calculating a socket contract address * given a particular routeId. */ function _getContractAddress( uint256 routeId ) internal view returns (address) { // determine the address of the socket contract. bytes memory initCode = ( hex"5860208158601c335a63aaf10f428752fa158151803b80938091923cf3" ); return address( uint160( // downcast to match the address type. uint256( // convert to uint to truncate upper digits. keccak256( // compute the CREATE2 hash using 4 inputs. abi.encodePacked( // pack all inputs to the hash together. hex"ff", // start with 0xff to distinguish from RLP. address(this), // this contract will be the caller. routeId, // the routeId is used as salt. keccak256(abi.encodePacked(initCode)) // the init code hash. ) ) ) ) ); } /** * @notice Rescues the ERC20 token to an address this is a restricted function to be called by only socketGatewayOwner * @dev as this is a restricted to socketGatewayOwner, ensure the userAddress is a known address * @param token address of the ERC20 token being rescued * @param userAddress address to which ERC20 is to be rescued * @param amount amount of ERC20 tokens being rescued */ function rescueFunds( address token, address userAddress, uint256 amount ) external onlyOwner { ERC20(token).safeTransfer(userAddress, amount); } /** * @notice Rescues the native balance to an address this is a restricted function to be called by only socketGatewayOwner * @dev as this is a restricted to socketGatewayOwner, ensure the userAddress is a known address * @param userAddress address to which native-balance is to be rescued * @param amount amount of native-balance being rescued */ function rescueEther( address payable userAddress, uint256 amount ) external onlyOwner { userAddress.transfer(amount); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; error CelerRefundNotReady(); error OnlySocketDeployer(); error OnlySocketGatewayOwner(); error OnlySocketGateway(); error OnlyOwner(); error OnlyNominee(); error TransferIdExists(); error TransferIdDoesnotExist(); error Address0Provided(); error SwapFailed(); error UnsupportedInterfaceId(); error InvalidCelerRefund(); error CelerAlreadyRefunded(); error IncorrectBridgeRatios(); error ZeroAddressNotAllowed(); error ArrayLengthMismatch(); // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; interface ISocketBridgeBase { function killme() external; } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; /** * @title ISocketController * @notice Interface for SocketController functions. * @dev functions can be added here for invocation from external contracts or off-chain * only restriction is that this should have functions to manage controllers * @author Socket dot tech. */ interface ISocketController { /** * @notice Add controller to the socketGateway This is a restricted function to be called by only socketGatewayOwner * @dev ensure controllerAddress is a verified controller implementation address * @param _controllerAddress The address of controller implementation contract deployed * @return Id of the controller added to the controllers-mapping in socketGateway storage */ function addController( address _controllerAddress ) external returns (uint32); /** * @notice disable controller by setting ZeroAddress to the entry in controllers-mapping identified by controllerId as key. This is a restricted function to be called by only socketGatewayOwner * @param _controllerId The Id of controller-implementation in the controllers mapping */ function disableController(uint32 _controllerId) external; /** * @notice Get controllerImplementation address mapped to the controllerId * @param _controllerId controllerId is the key in the mapping for controllers * @return controller-implementation address */ function getController(uint32 _controllerId) external returns (address); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; /** * @title ISocketGateway * @notice Interface for SocketGateway functions. * @dev functions can be added here for invocation from external contracts or off-chain * @author Socket dot tech. */ interface ISocketGateway { /** * @notice Request-struct for controllerRequests * @dev ensure the value for data is generated using the function-selectors defined in the controllerImplementation contracts */ struct SocketControllerRequest { // controllerId is the id mapped to the controllerAddress uint32 controllerId; // transactionImplData generated off-chain or by caller using function-selector of the controllerContract bytes data; } // @notice view to get owner-address function owner() external view returns (address); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; /** * @title ISocketRoute * @notice Interface with Request DataStructures to invoke controller functions. * @author Socket dot tech. */ interface ISocketRequest { struct SwapMultiBridgeRequest { uint32 swapRouteId; bytes swapImplData; uint32[] bridgeRouteIds; bytes[] bridgeImplDataItems; uint256[] bridgeRatios; bytes[] eventDataItems; } // Datastructure for Refuel-Swap-Bridge function struct RefuelSwapBridgeRequest { uint32 refuelRouteId; bytes refuelData; uint32 swapRouteId; bytes swapData; uint32 bridgeRouteId; bytes bridgeData; } // Datastructure for DeductFees-Swap function struct FeesTakerSwapRequest { address feesTakerAddress; address feesToken; uint256 feesAmount; uint32 routeId; bytes swapRequestData; } // Datastructure for DeductFees-Bridge function struct FeesTakerBridgeRequest { address feesTakerAddress; address feesToken; uint256 feesAmount; uint32 routeId; bytes bridgeRequestData; } // Datastructure for DeductFees-MultiBridge function struct FeesTakerMultiBridgeRequest { address feesTakerAddress; address feesToken; uint256 feesAmount; uint32[] bridgeRouteIds; bytes[] bridgeRequestDataItems; } // Datastructure for DeductFees-Swap-Bridge function struct FeesTakerSwapBridgeRequest { address feesTakerAddress; address feesToken; uint256 feesAmount; uint32 swapRouteId; bytes swapData; uint32 bridgeRouteId; bytes bridgeData; } // Datastructure for DeductFees-Refuel-Swap-Bridge function struct FeesTakerRefuelSwapBridgeRequest { address feesTakerAddress; address feesToken; uint256 feesAmount; uint32 refuelRouteId; bytes refuelData; uint32 swapRouteId; bytes swapData; uint32 bridgeRouteId; bytes bridgeData; } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; /** * @title ISocketRoute * @notice Interface for routeManagement functions in SocketGateway. * @author Socket dot tech. */ interface ISocketRoute { /** * @notice Add route to the socketGateway This is a restricted function to be called by only socketGatewayOwner * @dev ensure routeAddress is a verified bridge or middleware implementation address * @param routeAddress The address of bridge or middleware implementation contract deployed * @return Id of the route added to the routes-mapping in socketGateway storage */ function addRoute(address routeAddress) external returns (uint256); /** * @notice disable a route by setting ZeroAddress to the entry in routes-mapping identified by routeId as key. This is a restricted function to be called by only socketGatewayOwner * @param routeId The Id of route-implementation in the routes mapping */ function disableRoute(uint32 routeId) external; /** * @notice Get routeImplementation address mapped to the routeId * @param routeId routeId is the key in the mapping for routes * @return route-implementation address */ function getRoute(uint32 routeId) external view returns (address); } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; // Functions taken out from https://github.com/GNSPS/solidity-bytes-utils/blob/master/contracts/BytesLib.sol library LibBytes { // solhint-disable no-inline-assembly // LibBytes specific errors error SliceOverflow(); error SliceOutOfBounds(); error AddressOutOfBounds(); error UintOutOfBounds(); // ------------------------- function concat( bytes memory _preBytes, bytes memory _postBytes ) internal pure returns (bytes memory) { bytes memory tempBytes; assembly { // Get a location of some free memory and store it in tempBytes as // Solidity does for memory variables. tempBytes := mload(0x40) // Store the length of the first bytes array at the beginning of // the memory for tempBytes. let length := mload(_preBytes) mstore(tempBytes, length) // Maintain a memory counter for the current write location in the // temp bytes array by adding the 32 bytes for the array length to // the starting location. let mc := add(tempBytes, 0x20) // Stop copying when the memory counter reaches the length of the // first bytes array. let end := add(mc, length) for { // Initialize a copy counter to the start of the _preBytes data, // 32 bytes into its memory. let cc := add(_preBytes, 0x20) } lt(mc, end) { // Increase both counters by 32 bytes each iteration. mc := add(mc, 0x20) cc := add(cc, 0x20) } { // Write the _preBytes data into the tempBytes memory 32 bytes // at a time. mstore(mc, mload(cc)) } // Add the length of _postBytes to the current length of tempBytes // and store it as the new length in the first 32 bytes of the // tempBytes memory. length := mload(_postBytes) mstore(tempBytes, add(length, mload(tempBytes))) // Move the memory counter back from a multiple of 0x20 to the // actual end of the _preBytes data. mc := end // Stop copying when the memory counter reaches the new combined // length of the arrays. end := add(mc, length) for { let cc := add(_postBytes, 0x20) } lt(mc, end) { mc := add(mc, 0x20) cc := add(cc, 0x20) } { mstore(mc, mload(cc)) } // Update the free-memory pointer by padding our last write location // to 32 bytes: add 31 bytes to the end of tempBytes to move to the // next 32 byte block, then round down to the nearest multiple of // 32. If the sum of the length of the two arrays is zero then add // one before rounding down to leave a blank 32 bytes (the length block with 0). mstore( 0x40, and( add(add(end, iszero(add(length, mload(_preBytes)))), 31), not(31) // Round down to the nearest 32 bytes. ) ) } return tempBytes; } function slice( bytes memory _bytes, uint256 _start, uint256 _length ) internal pure returns (bytes memory) { if (_length + 31 < _length) { revert SliceOverflow(); } if (_bytes.length < _start + _length) { revert SliceOutOfBounds(); } bytes memory tempBytes; assembly { switch iszero(_length) case 0 { // Get a location of some free memory and store it in tempBytes as // Solidity does for memory variables. tempBytes := mload(0x40) // The first word of the slice result is potentially a partial // word read from the original array. To read it, we calculate // the length of that partial word and start copying that many // bytes into the array. The first word we copy will start with // data we don't care about, but the last `lengthmod` bytes will // land at the beginning of the contents of the new array. When // we're done copying, we overwrite the full first word with // the actual length of the slice. let lengthmod := and(_length, 31) // The multiplication in the next line is necessary // because when slicing multiples of 32 bytes (lengthmod == 0) // the following copy loop was copying the origin's length // and then ending prematurely not copying everything it should. let mc := add( add(tempBytes, lengthmod), mul(0x20, iszero(lengthmod)) ) let end := add(mc, _length) for { // The multiplication in the next line has the same exact purpose // as the one above. let cc := add( add( add(_bytes, lengthmod), mul(0x20, iszero(lengthmod)) ), _start ) } lt(mc, end) { mc := add(mc, 0x20) cc := add(cc, 0x20) } { mstore(mc, mload(cc)) } mstore(tempBytes, _length) //update free-memory pointer //allocating the array padded to 32 bytes like the compiler does now mstore(0x40, and(add(mc, 31), not(31))) } //if we want a zero-length slice let's just return a zero-length array default { tempBytes := mload(0x40) //zero out the 32 bytes slice we are about to return //we need to do it because Solidity does not garbage collect mstore(tempBytes, 0) mstore(0x40, add(tempBytes, 0x20)) } } return tempBytes; } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import "./LibBytes.sol"; /// @title LibUtil library /// @notice library with helper functions to operate on bytes-data and addresses /// @author socket dot tech library LibUtil { /// @notice LibBytes library to handle operations on bytes using LibBytes for bytes; /// @notice function to extract revertMessage from bytes data /// @dev use the revertMessage and then further revert with a custom revert and message /// @param _res bytes data received from the transaction call function getRevertMsg( bytes memory _res ) internal pure returns (string memory) { // If the _res length is less than 68, then the transaction failed silently (without a revert message) if (_res.length < 68) { return "Transaction reverted silently"; } bytes memory revertData = _res.slice(4, _res.length - 4); // Remove the selector which is the first 4 bytes return abi.decode(revertData, (string)); // All that remains is the revert string } } // SPDX-License-Identifier: GPL-3.0-only pragma solidity ^0.8.4; // runtime proto sol library library Pb { enum WireType { Varint, Fixed64, LengthDelim, StartGroup, EndGroup, Fixed32 } struct Buffer { uint256 idx; // the start index of next read. when idx=b.length, we're done bytes b; // hold serialized proto msg, readonly } // create a new in-memory Buffer object from raw msg bytes function fromBytes( bytes memory raw ) internal pure returns (Buffer memory buf) { buf.b = raw; buf.idx = 0; } // whether there are unread bytes function hasMore(Buffer memory buf) internal pure returns (bool) { return buf.idx < buf.b.length; } // decode current field number and wiretype function decKey( Buffer memory buf ) internal pure returns (uint256 tag, WireType wiretype) { uint256 v = decVarint(buf); tag = v / 8; wiretype = WireType(v & 7); } // read varint from current buf idx, move buf.idx to next read, return the int value function decVarint(Buffer memory buf) internal pure returns (uint256 v) { bytes10 tmp; // proto int is at most 10 bytes (7 bits can be used per byte) bytes memory bb = buf.b; // get buf.b mem addr to use in assembly v = buf.idx; // use v to save one additional uint variable assembly { tmp := mload(add(add(bb, 32), v)) // load 10 bytes from buf.b[buf.idx] to tmp } uint256 b; // store current byte content v = 0; // reset to 0 for return value for (uint256 i = 0; i < 10; i++) { assembly { b := byte(i, tmp) // don't use tmp[i] because it does bound check and costs extra } v |= (b & 0x7F) << (i * 7); if (b & 0x80 == 0) { buf.idx += i + 1; return v; } } revert(); // i=10, invalid varint stream } // read length delimited field and return bytes function decBytes( Buffer memory buf ) internal pure returns (bytes memory b) { uint256 len = decVarint(buf); uint256 end = buf.idx + len; require(end <= buf.b.length); // avoid overflow b = new bytes(len); bytes memory bufB = buf.b; // get buf.b mem addr to use in assembly uint256 bStart; uint256 bufBStart = buf.idx; assembly { bStart := add(b, 32) bufBStart := add(add(bufB, 32), bufBStart) } for (uint256 i = 0; i < len; i += 32) { assembly { mstore(add(bStart, i), mload(add(bufBStart, i))) } } buf.idx = end; } // move idx pass current value field, to beginning of next tag or msg end function skipValue(Buffer memory buf, WireType wire) internal pure { if (wire == WireType.Varint) { decVarint(buf); } else if (wire == WireType.LengthDelim) { uint256 len = decVarint(buf); buf.idx += len; // skip len bytes value data require(buf.idx <= buf.b.length); // avoid overflow } else { revert(); } // unsupported wiretype } function _uint256(bytes memory b) internal pure returns (uint256 v) { require(b.length <= 32); // b's length must be smaller than or equal to 32 assembly { v := mload(add(b, 32)) } // load all 32bytes to v v = v >> (8 * (32 - b.length)); // only first b.length is valid } function _address(bytes memory b) internal pure returns (address v) { v = _addressPayable(b); } function _addressPayable( bytes memory b ) internal pure returns (address payable v) { require(b.length == 20); //load 32bytes then shift right 12 bytes assembly { v := div(mload(add(b, 32)), 0x1000000000000000000000000) } } function _bytes32(bytes memory b) internal pure returns (bytes32 v) { require(b.length == 32); assembly { v := mload(add(b, 32)) } } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; pragma experimental ABIEncoderV2; import "./utils/Ownable.sol"; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {LibUtil} from "./libraries/LibUtil.sol"; import "./libraries/LibBytes.sol"; import {ISocketRoute} from "./interfaces/ISocketRoute.sol"; import {ISocketRequest} from "./interfaces/ISocketRequest.sol"; import {ISocketGateway} from "./interfaces/ISocketGateway.sol"; import {IncorrectBridgeRatios, ZeroAddressNotAllowed, ArrayLengthMismatch} from "./errors/SocketErrors.sol"; /// @title SocketGatewayContract /// @notice Socketgateway is a contract with entrypoint functions for all interactions with socket liquidity layer /// @author Socket Team contract SocketGatewayTemplate is Ownable { using LibBytes for bytes; using LibBytes for bytes4; using SafeTransferLib for ERC20; /// @notice FunctionSelector used to delegatecall from swap to the function of bridge router implementation bytes4 public immutable BRIDGE_AFTER_SWAP_SELECTOR = bytes4(keccak256("bridgeAfterSwap(uint256,bytes)")); /// @notice storage variable to keep track of total number of routes registered in socketgateway uint32 public routesCount = 385; /// @notice storage variable to keep track of total number of controllers registered in socketgateway uint32 public controllerCount; address public immutable disabledRouteAddress; uint256 public constant CENT_PERCENT = 100e18; /// @notice storage mapping for route implementation addresses mapping(uint32 => address) public routes; /// storage mapping for controller implemenation addresses mapping(uint32 => address) public controllers; // Events -------------------------------------------------------------------------------------------------------> /// @notice Event emitted when a router is added to socketgateway event NewRouteAdded(uint32 indexed routeId, address indexed route); /// @notice Event emitted when a route is disabled event RouteDisabled(uint32 indexed routeId); /// @notice Event emitted when ownership transfer is requested by socket-gateway-owner event OwnershipTransferRequested( address indexed _from, address indexed _to ); /// @notice Event emitted when a controller is added to socketgateway event ControllerAdded( uint32 indexed controllerId, address indexed controllerAddress ); /// @notice Event emitted when a controller is disabled event ControllerDisabled(uint32 indexed controllerId); constructor(address _owner, address _disabledRoute) Ownable(_owner) { disabledRouteAddress = _disabledRoute; } // Able to receive ether // solhint-disable-next-line no-empty-blocks receive() external payable {} /******************************************* * EXTERNAL AND PUBLIC FUNCTIONS * *******************************************/ /** * @notice executes functions in the routes identified using routeId and functionSelectorData * @notice The caller must first approve this contract to spend amount of ERC20-Token being bridged/swapped * @dev ensure the data in routeData to be built using the function-selector defined as a * constant in the route implementation contract * @param routeId route identifier * @param routeData functionSelectorData generated using the function-selector defined in the route Implementation */ function executeRoute( uint32 routeId, bytes calldata routeData ) external payable returns (bytes memory) { (bool success, bytes memory result) = addressAt(routeId).delegatecall( routeData ); if (!success) { assembly { revert(add(result, 32), mload(result)) } } return result; } /** * @notice swaps a token on sourceChain and split it across multiple bridge-recipients * @notice The caller must first approve this contract to spend amount of ERC20-Token being swapped * @dev ensure the swap-data and bridge-data is generated using the function-selector defined as a constant in the implementation address * @param swapMultiBridgeRequest request */ function swapAndMultiBridge( ISocketRequest.SwapMultiBridgeRequest calldata swapMultiBridgeRequest ) external payable { uint256 requestLength = swapMultiBridgeRequest.bridgeRouteIds.length; if ( requestLength != swapMultiBridgeRequest.bridgeImplDataItems.length ) { revert ArrayLengthMismatch(); } uint256 ratioAggregate; for (uint256 index = 0; index < requestLength; ) { ratioAggregate += swapMultiBridgeRequest.bridgeRatios[index]; } if (ratioAggregate != CENT_PERCENT) { revert IncorrectBridgeRatios(); } (bool swapSuccess, bytes memory swapResult) = addressAt( swapMultiBridgeRequest.swapRouteId ).delegatecall(swapMultiBridgeRequest.swapImplData); if (!swapSuccess) { assembly { revert(add(swapResult, 32), mload(swapResult)) } } uint256 amountReceivedFromSwap = abi.decode(swapResult, (uint256)); uint256 bridgedAmount; for (uint256 index = 0; index < requestLength; ) { uint256 bridgingAmount; // if it is the last bridge request, bridge the remaining amount if (index == requestLength - 1) { bridgingAmount = amountReceivedFromSwap - bridgedAmount; } else { // bridging amount is the multiplication of bridgeRatio and amountReceivedFromSwap bridgingAmount = (amountReceivedFromSwap * swapMultiBridgeRequest.bridgeRatios[index]) / (CENT_PERCENT); } // update the bridged amount, this would be used for computation for last bridgeRequest bridgedAmount += bridgingAmount; bytes memory bridgeImpldata = abi.encodeWithSelector( BRIDGE_AFTER_SWAP_SELECTOR, bridgingAmount, swapMultiBridgeRequest.bridgeImplDataItems[index] ); (bool bridgeSuccess, bytes memory bridgeResult) = addressAt( swapMultiBridgeRequest.bridgeRouteIds[index] ).delegatecall(bridgeImpldata); if (!bridgeSuccess) { assembly { revert(add(bridgeResult, 32), mload(bridgeResult)) } } unchecked { ++index; } } } /** * @notice sequentially executes functions in the routes identified using routeId and functionSelectorData * @notice The caller must first approve this contract to spend amount of ERC20-Token being bridged/swapped * @dev ensure the data in each dataItem to be built using the function-selector defined as a * constant in the route implementation contract * @param routeIds a list of route identifiers * @param dataItems a list of functionSelectorData generated using the function-selector defined in the route Implementation */ function executeRoutes( uint32[] calldata routeIds, bytes[] calldata dataItems ) external payable { uint256 routeIdslength = routeIds.length; if (routeIdslength != dataItems.length) revert ArrayLengthMismatch(); for (uint256 index = 0; index < routeIdslength; ) { (bool success, bytes memory result) = addressAt(routeIds[index]) .delegatecall(dataItems[index]); if (!success) { assembly { revert(add(result, 32), mload(result)) } } unchecked { ++index; } } } /** * @notice execute a controller function identified using the controllerId in the request * @notice The caller must first approve this contract to spend amount of ERC20-Token being bridged/swapped * @dev ensure the data in request to be built using the function-selector defined as a * constant in the controller implementation contract * @param socketControllerRequest socketControllerRequest with controllerId to identify the * controllerAddress and byteData constructed using functionSelector * of the function being invoked * @return bytes data received from the call delegated to controller */ function executeController( ISocketGateway.SocketControllerRequest calldata socketControllerRequest ) external payable returns (bytes memory) { (bool success, bytes memory result) = controllers[ socketControllerRequest.controllerId ].delegatecall(socketControllerRequest.data); if (!success) { assembly { revert(add(result, 32), mload(result)) } } return result; } /** * @notice sequentially executes all controller requests * @notice The caller must first approve this contract to spend amount of ERC20-Token being bridged/swapped * @dev ensure the data in each controller-request to be built using the function-selector defined as a * constant in the controller implementation contract * @param controllerRequests a list of socketControllerRequest * Each controllerRequest contains controllerId to identify the controllerAddress and * byteData constructed using functionSelector of the function being invoked */ function executeControllers( ISocketGateway.SocketControllerRequest[] calldata controllerRequests ) external payable { for (uint32 index = 0; index < controllerRequests.length; ) { (bool success, bytes memory result) = controllers[ controllerRequests[index].controllerId ].delegatecall(controllerRequests[index].data); if (!success) { assembly { revert(add(result, 32), mload(result)) } } unchecked { ++index; } } } /************************************** * ADMIN FUNCTIONS * **************************************/ /** * @notice Add route to the socketGateway This is a restricted function to be called by only socketGatewayOwner * @dev ensure routeAddress is a verified bridge or middleware implementation address * @param routeAddress The address of bridge or middleware implementation contract deployed * @return Id of the route added to the routes-mapping in socketGateway storage */ function addRoute( address routeAddress ) external onlyOwner returns (uint32) { uint32 routeId = routesCount; routes[routeId] = routeAddress; routesCount += 1; emit NewRouteAdded(routeId, routeAddress); return routeId; } /** * @notice Give Infinite or 0 approval to bridgeRoute for the tokenAddress This is a restricted function to be called by only socketGatewayOwner */ function setApprovalForRouters( address[] memory routeAddresses, address[] memory tokenAddresses, bool isMax ) external onlyOwner { for (uint32 index = 0; index < routeAddresses.length; ) { ERC20(tokenAddresses[index]).approve( routeAddresses[index], isMax ? type(uint256).max : 0 ); unchecked { ++index; } } } /** * @notice Add controller to the socketGateway This is a restricted function to be called by only socketGatewayOwner * @dev ensure controllerAddress is a verified controller implementation address * @param controllerAddress The address of controller implementation contract deployed * @return Id of the controller added to the controllers-mapping in socketGateway storage */ function addController( address controllerAddress ) external onlyOwner returns (uint32) { uint32 controllerId = controllerCount; controllers[controllerId] = controllerAddress; controllerCount += 1; emit ControllerAdded(controllerId, controllerAddress); return controllerId; } /** * @notice disable controller by setting ZeroAddress to the entry in controllers-mapping identified by controllerId as key. This is a restricted function to be called by only socketGatewayOwner * @param controllerId The Id of controller-implementation in the controllers mapping */ function disableController(uint32 controllerId) public onlyOwner { controllers[controllerId] = disabledRouteAddress; emit ControllerDisabled(controllerId); } /** * @notice disable a route by setting ZeroAddress to the entry in routes-mapping identified by routeId as key. This is a restricted function to be called by only socketGatewayOwner * @param routeId The Id of route-implementation in the routes mapping */ function disableRoute(uint32 routeId) external onlyOwner { routes[routeId] = disabledRouteAddress; emit RouteDisabled(routeId); } /******************************************* * RESTRICTED RESCUE FUNCTIONS * *******************************************/ /** * @notice Rescues the ERC20 token to an address this is a restricted function to be called by only socketGatewayOwner * @dev as this is a restricted to socketGatewayOwner, ensure the userAddress is a known address * @param token address of the ERC20 token being rescued * @param userAddress address to which ERC20 is to be rescued * @param amount amount of ERC20 tokens being rescued */ function rescueFunds( address token, address userAddress, uint256 amount ) external onlyOwner { ERC20(token).safeTransfer(userAddress, amount); } /** * @notice Rescues the native balance to an address this is a restricted function to be called by only socketGatewayOwner * @dev as this is a restricted to socketGatewayOwner, ensure the userAddress is a known address * @param userAddress address to which native-balance is to be rescued * @param amount amount of native-balance being rescued */ function rescueEther( address payable userAddress, uint256 amount ) external onlyOwner { userAddress.transfer(amount); } /******************************************* * VIEW FUNCTIONS * *******************************************/ /** * @notice Get routeImplementation address mapped to the routeId * @param routeId routeId is the key in the mapping for routes * @return route-implementation address */ function getRoute(uint32 routeId) public view returns (address) { return addressAt(routeId); } /** * @notice Get controllerImplementation address mapped to the controllerId * @param controllerId controllerId is the key in the mapping for controllers * @return controller-implementation address */ function getController(uint32 controllerId) public view returns (address) { return controllers[controllerId]; } function addressAt(uint32 routeId) public view returns (address) { if (routeId < 385) { if (routeId < 257) { if (routeId < 129) { if (routeId < 65) { if (routeId < 33) { if (routeId < 17) { if (routeId < 9) { if (routeId < 5) { if (routeId < 3) { if (routeId == 1) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 3) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 7) { if (routeId == 5) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 7) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 13) { if (routeId < 11) { if (routeId == 9) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 11) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 15) { if (routeId == 13) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 15) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 25) { if (routeId < 21) { if (routeId < 19) { if (routeId == 17) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 19) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 23) { if (routeId == 21) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 23) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 29) { if (routeId < 27) { if (routeId == 25) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 27) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 31) { if (routeId == 29) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 31) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } else { if (routeId < 49) { if (routeId < 41) { if (routeId < 37) { if (routeId < 35) { if (routeId == 33) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 35) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 39) { if (routeId == 37) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 39) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 45) { if (routeId < 43) { if (routeId == 41) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 43) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 47) { if (routeId == 45) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 47) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 57) { if (routeId < 53) { if (routeId < 51) { if (routeId == 49) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 51) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 55) { if (routeId == 53) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 55) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 61) { if (routeId < 59) { if (routeId == 57) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 59) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 63) { if (routeId == 61) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 63) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } } else { if (routeId < 97) { if (routeId < 81) { if (routeId < 73) { if (routeId < 69) { if (routeId < 67) { if (routeId == 65) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 67) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 71) { if (routeId == 69) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 71) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 77) { if (routeId < 75) { if (routeId == 73) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 75) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 79) { if (routeId == 77) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 79) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 89) { if (routeId < 85) { if (routeId < 83) { if (routeId == 81) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 83) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 87) { if (routeId == 85) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 87) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 93) { if (routeId < 91) { if (routeId == 89) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 91) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 95) { if (routeId == 93) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 95) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } else { if (routeId < 113) { if (routeId < 105) { if (routeId < 101) { if (routeId < 99) { if (routeId == 97) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 99) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 103) { if (routeId == 101) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 103) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 109) { if (routeId < 107) { if (routeId == 105) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 107) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 111) { if (routeId == 109) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 111) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 121) { if (routeId < 117) { if (routeId < 115) { if (routeId == 113) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 115) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 119) { if (routeId == 117) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 119) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 125) { if (routeId < 123) { if (routeId == 121) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 123) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 127) { if (routeId == 125) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 127) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } } } else { if (routeId < 193) { if (routeId < 161) { if (routeId < 145) { if (routeId < 137) { if (routeId < 133) { if (routeId < 131) { if (routeId == 129) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 131) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 135) { if (routeId == 133) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 135) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 141) { if (routeId < 139) { if (routeId == 137) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 139) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 143) { if (routeId == 141) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 143) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 153) { if (routeId < 149) { if (routeId < 147) { if (routeId == 145) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 147) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 151) { if (routeId == 149) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 151) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 157) { if (routeId < 155) { if (routeId == 153) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 155) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 159) { if (routeId == 157) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 159) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } else { if (routeId < 177) { if (routeId < 169) { if (routeId < 165) { if (routeId < 163) { if (routeId == 161) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 163) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 167) { if (routeId == 165) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 167) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 173) { if (routeId < 171) { if (routeId == 169) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 171) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 175) { if (routeId == 173) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 175) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 185) { if (routeId < 181) { if (routeId < 179) { if (routeId == 177) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 179) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 183) { if (routeId == 181) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 183) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 189) { if (routeId < 187) { if (routeId == 185) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 187) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 191) { if (routeId == 189) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 191) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } } else { if (routeId < 225) { if (routeId < 209) { if (routeId < 201) { if (routeId < 197) { if (routeId < 195) { if (routeId == 193) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 195) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 199) { if (routeId == 197) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 199) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 205) { if (routeId < 203) { if (routeId == 201) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 203) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 207) { if (routeId == 205) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 207) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 217) { if (routeId < 213) { if (routeId < 211) { if (routeId == 209) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 211) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 215) { if (routeId == 213) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 215) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 221) { if (routeId < 219) { if (routeId == 217) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 219) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 223) { if (routeId == 221) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 223) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } else { if (routeId < 241) { if (routeId < 233) { if (routeId < 229) { if (routeId < 227) { if (routeId == 225) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 227) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 231) { if (routeId == 229) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 231) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 237) { if (routeId < 235) { if (routeId == 233) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 235) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 239) { if (routeId == 237) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 239) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 249) { if (routeId < 245) { if (routeId < 243) { if (routeId == 241) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 243) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 247) { if (routeId == 245) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 247) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 253) { if (routeId < 251) { if (routeId == 249) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 251) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 255) { if (routeId == 253) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 255) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } } } } else { if (routeId < 321) { if (routeId < 289) { if (routeId < 273) { if (routeId < 265) { if (routeId < 261) { if (routeId < 259) { if (routeId == 257) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 259) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 263) { if (routeId == 261) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 263) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 269) { if (routeId < 267) { if (routeId == 265) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 267) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 271) { if (routeId == 269) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 271) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 281) { if (routeId < 277) { if (routeId < 275) { if (routeId == 273) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 275) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 279) { if (routeId == 277) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 279) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 285) { if (routeId < 283) { if (routeId == 281) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 283) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 287) { if (routeId == 285) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 287) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } else { if (routeId < 305) { if (routeId < 297) { if (routeId < 293) { if (routeId < 291) { if (routeId == 289) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 291) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 295) { if (routeId == 293) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 295) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 301) { if (routeId < 299) { if (routeId == 297) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 299) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 303) { if (routeId == 301) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 303) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 313) { if (routeId < 309) { if (routeId < 307) { if (routeId == 305) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 307) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 311) { if (routeId == 309) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 311) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 317) { if (routeId < 315) { if (routeId == 313) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 315) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 319) { if (routeId == 317) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 319) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } } else { if (routeId < 353) { if (routeId < 337) { if (routeId < 329) { if (routeId < 325) { if (routeId < 323) { if (routeId == 321) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 323) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 327) { if (routeId == 325) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 327) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 333) { if (routeId < 331) { if (routeId == 329) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 331) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 335) { if (routeId == 333) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 335) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 345) { if (routeId < 341) { if (routeId < 339) { if (routeId == 337) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 339) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 343) { if (routeId == 341) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 343) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 349) { if (routeId < 347) { if (routeId == 345) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 347) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 351) { if (routeId == 349) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 351) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } else { if (routeId < 369) { if (routeId < 361) { if (routeId < 357) { if (routeId < 355) { if (routeId == 353) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 355) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 359) { if (routeId == 357) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 359) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 365) { if (routeId < 363) { if (routeId == 361) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 363) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 367) { if (routeId == 365) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 367) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } else { if (routeId < 377) { if (routeId < 373) { if (routeId < 371) { if (routeId == 369) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 371) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 375) { if (routeId == 373) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 375) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } else { if (routeId < 381) { if (routeId < 379) { if (routeId == 377) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 379) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } else { if (routeId < 383) { if (routeId == 381) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } else { if (routeId == 383) { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } else { return 0x822D4B4e63499a576Ab1cc152B86D1CFFf794F4f; } } } } } } } } } if (routes[routeId] == address(0)) revert ZeroAddressNotAllowed(); return routes[routeId]; } /// @notice fallback function to handle swap, bridge execution /// @dev ensure routeId is converted to bytes4 and sent as msg.sig in the transaction fallback() external payable { address routeAddress = addressAt(uint32(msg.sig)); bytes memory result; assembly { // copy function selector and any arguments calldatacopy(0, 4, sub(calldatasize(), 4)) // execute function call using the facet result := delegatecall( gas(), routeAddress, 0, sub(calldatasize(), 4), 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()) } } } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; pragma experimental ABIEncoderV2; import "./utils/Ownable.sol"; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {LibUtil} from "./libraries/LibUtil.sol"; import "./libraries/LibBytes.sol"; import {ISocketRoute} from "./interfaces/ISocketRoute.sol"; import {ISocketRequest} from "./interfaces/ISocketRequest.sol"; import {ISocketGateway} from "./interfaces/ISocketGateway.sol"; import {IncorrectBridgeRatios, ZeroAddressNotAllowed, ArrayLengthMismatch} from "./errors/SocketErrors.sol"; /// @title SocketGatewayContract /// @notice Socketgateway is a contract with entrypoint functions for all interactions with socket liquidity layer /// @author Socket Team contract SocketGateway is Ownable { using LibBytes for bytes; using LibBytes for bytes4; using SafeTransferLib for ERC20; /// @notice FunctionSelector used to delegatecall from swap to the function of bridge router implementation bytes4 public immutable BRIDGE_AFTER_SWAP_SELECTOR = bytes4(keccak256("bridgeAfterSwap(uint256,bytes)")); /// @notice storage variable to keep track of total number of routes registered in socketgateway uint32 public routesCount = 385; /// @notice storage variable to keep track of total number of controllers registered in socketgateway uint32 public controllerCount; address public immutable disabledRouteAddress; uint256 public constant CENT_PERCENT = 100e18; /// @notice storage mapping for route implementation addresses mapping(uint32 => address) public routes; /// storage mapping for controller implemenation addresses mapping(uint32 => address) public controllers; // Events -------------------------------------------------------------------------------------------------------> /// @notice Event emitted when a router is added to socketgateway event NewRouteAdded(uint32 indexed routeId, address indexed route); /// @notice Event emitted when a route is disabled event RouteDisabled(uint32 indexed routeId); /// @notice Event emitted when ownership transfer is requested by socket-gateway-owner event OwnershipTransferRequested( address indexed _from, address indexed _to ); /// @notice Event emitted when a controller is added to socketgateway event ControllerAdded( uint32 indexed controllerId, address indexed controllerAddress ); /// @notice Event emitted when a controller is disabled event ControllerDisabled(uint32 indexed controllerId); constructor(address _owner, address _disabledRoute) Ownable(_owner) { disabledRouteAddress = _disabledRoute; } // Able to receive ether // solhint-disable-next-line no-empty-blocks receive() external payable {} /******************************************* * EXTERNAL AND PUBLIC FUNCTIONS * *******************************************/ /** * @notice executes functions in the routes identified using routeId and functionSelectorData * @notice The caller must first approve this contract to spend amount of ERC20-Token being bridged/swapped * @dev ensure the data in routeData to be built using the function-selector defined as a * constant in the route implementation contract * @param routeId route identifier * @param routeData functionSelectorData generated using the function-selector defined in the route Implementation */ function executeRoute( uint32 routeId, bytes calldata routeData ) external payable returns (bytes memory) { (bool success, bytes memory result) = addressAt(routeId).delegatecall( routeData ); if (!success) { assembly { revert(add(result, 32), mload(result)) } } return result; } /** * @notice swaps a token on sourceChain and split it across multiple bridge-recipients * @notice The caller must first approve this contract to spend amount of ERC20-Token being swapped * @dev ensure the swap-data and bridge-data is generated using the function-selector defined as a constant in the implementation address * @param swapMultiBridgeRequest request */ function swapAndMultiBridge( ISocketRequest.SwapMultiBridgeRequest calldata swapMultiBridgeRequest ) external payable { uint256 requestLength = swapMultiBridgeRequest.bridgeRouteIds.length; if ( requestLength != swapMultiBridgeRequest.bridgeImplDataItems.length ) { revert ArrayLengthMismatch(); } uint256 ratioAggregate; for (uint256 index = 0; index < requestLength; ) { ratioAggregate += swapMultiBridgeRequest.bridgeRatios[index]; } if (ratioAggregate != CENT_PERCENT) { revert IncorrectBridgeRatios(); } (bool swapSuccess, bytes memory swapResult) = addressAt( swapMultiBridgeRequest.swapRouteId ).delegatecall(swapMultiBridgeRequest.swapImplData); if (!swapSuccess) { assembly { revert(add(swapResult, 32), mload(swapResult)) } } uint256 amountReceivedFromSwap = abi.decode(swapResult, (uint256)); uint256 bridgedAmount; for (uint256 index = 0; index < requestLength; ) { uint256 bridgingAmount; // if it is the last bridge request, bridge the remaining amount if (index == requestLength - 1) { bridgingAmount = amountReceivedFromSwap - bridgedAmount; } else { // bridging amount is the multiplication of bridgeRatio and amountReceivedFromSwap bridgingAmount = (amountReceivedFromSwap * swapMultiBridgeRequest.bridgeRatios[index]) / (CENT_PERCENT); } // update the bridged amount, this would be used for computation for last bridgeRequest bridgedAmount += bridgingAmount; bytes memory bridgeImpldata = abi.encodeWithSelector( BRIDGE_AFTER_SWAP_SELECTOR, bridgingAmount, swapMultiBridgeRequest.bridgeImplDataItems[index] ); (bool bridgeSuccess, bytes memory bridgeResult) = addressAt( swapMultiBridgeRequest.bridgeRouteIds[index] ).delegatecall(bridgeImpldata); if (!bridgeSuccess) { assembly { revert(add(bridgeResult, 32), mload(bridgeResult)) } } unchecked { ++index; } } } /** * @notice sequentially executes functions in the routes identified using routeId and functionSelectorData * @notice The caller must first approve this contract to spend amount of ERC20-Token being bridged/swapped * @dev ensure the data in each dataItem to be built using the function-selector defined as a * constant in the route implementation contract * @param routeIds a list of route identifiers * @param dataItems a list of functionSelectorData generated using the function-selector defined in the route Implementation */ function executeRoutes( uint32[] calldata routeIds, bytes[] calldata dataItems ) external payable { uint256 routeIdslength = routeIds.length; if (routeIdslength != dataItems.length) revert ArrayLengthMismatch(); for (uint256 index = 0; index < routeIdslength; ) { (bool success, bytes memory result) = addressAt(routeIds[index]) .delegatecall(dataItems[index]); if (!success) { assembly { revert(add(result, 32), mload(result)) } } unchecked { ++index; } } } /** * @notice execute a controller function identified using the controllerId in the request * @notice The caller must first approve this contract to spend amount of ERC20-Token being bridged/swapped * @dev ensure the data in request to be built using the function-selector defined as a * constant in the controller implementation contract * @param socketControllerRequest socketControllerRequest with controllerId to identify the * controllerAddress and byteData constructed using functionSelector * of the function being invoked * @return bytes data received from the call delegated to controller */ function executeController( ISocketGateway.SocketControllerRequest calldata socketControllerRequest ) external payable returns (bytes memory) { (bool success, bytes memory result) = controllers[ socketControllerRequest.controllerId ].delegatecall(socketControllerRequest.data); if (!success) { assembly { revert(add(result, 32), mload(result)) } } return result; } /** * @notice sequentially executes all controller requests * @notice The caller must first approve this contract to spend amount of ERC20-Token being bridged/swapped * @dev ensure the data in each controller-request to be built using the function-selector defined as a * constant in the controller implementation contract * @param controllerRequests a list of socketControllerRequest * Each controllerRequest contains controllerId to identify the controllerAddress and * byteData constructed using functionSelector of the function being invoked */ function executeControllers( ISocketGateway.SocketControllerRequest[] calldata controllerRequests ) external payable { for (uint32 index = 0; index < controllerRequests.length; ) { (bool success, bytes memory result) = controllers[ controllerRequests[index].controllerId ].delegatecall(controllerRequests[index].data); if (!success) { assembly { revert(add(result, 32), mload(result)) } } unchecked { ++index; } } } /************************************** * ADMIN FUNCTIONS * **************************************/ /** * @notice Add route to the socketGateway This is a restricted function to be called by only socketGatewayOwner * @dev ensure routeAddress is a verified bridge or middleware implementation address * @param routeAddress The address of bridge or middleware implementation contract deployed * @return Id of the route added to the routes-mapping in socketGateway storage */ function addRoute( address routeAddress ) external onlyOwner returns (uint32) { uint32 routeId = routesCount; routes[routeId] = routeAddress; routesCount += 1; emit NewRouteAdded(routeId, routeAddress); return routeId; } /** * @notice Give Infinite or 0 approval to bridgeRoute for the tokenAddress This is a restricted function to be called by only socketGatewayOwner */ function setApprovalForRouters( address[] memory routeAddresses, address[] memory tokenAddresses, bool isMax ) external onlyOwner { for (uint32 index = 0; index < routeAddresses.length; ) { ERC20(tokenAddresses[index]).approve( routeAddresses[index], isMax ? type(uint256).max : 0 ); unchecked { ++index; } } } /** * @notice Add controller to the socketGateway This is a restricted function to be called by only socketGatewayOwner * @dev ensure controllerAddress is a verified controller implementation address * @param controllerAddress The address of controller implementation contract deployed * @return Id of the controller added to the controllers-mapping in socketGateway storage */ function addController( address controllerAddress ) external onlyOwner returns (uint32) { uint32 controllerId = controllerCount; controllers[controllerId] = controllerAddress; controllerCount += 1; emit ControllerAdded(controllerId, controllerAddress); return controllerId; } /** * @notice disable controller by setting ZeroAddress to the entry in controllers-mapping identified by controllerId as key. This is a restricted function to be called by only socketGatewayOwner * @param controllerId The Id of controller-implementation in the controllers mapping */ function disableController(uint32 controllerId) public onlyOwner { controllers[controllerId] = disabledRouteAddress; emit ControllerDisabled(controllerId); } /** * @notice disable a route by setting ZeroAddress to the entry in routes-mapping identified by routeId as key. This is a restricted function to be called by only socketGatewayOwner * @param routeId The Id of route-implementation in the routes mapping */ function disableRoute(uint32 routeId) external onlyOwner { routes[routeId] = disabledRouteAddress; emit RouteDisabled(routeId); } /******************************************* * RESTRICTED RESCUE FUNCTIONS * *******************************************/ /** * @notice Rescues the ERC20 token to an address this is a restricted function to be called by only socketGatewayOwner * @dev as this is a restricted to socketGatewayOwner, ensure the userAddress is a known address * @param token address of the ERC20 token being rescued * @param userAddress address to which ERC20 is to be rescued * @param amount amount of ERC20 tokens being rescued */ function rescueFunds( address token, address userAddress, uint256 amount ) external onlyOwner { ERC20(token).safeTransfer(userAddress, amount); } /** * @notice Rescues the native balance to an address this is a restricted function to be called by only socketGatewayOwner * @dev as this is a restricted to socketGatewayOwner, ensure the userAddress is a known address * @param userAddress address to which native-balance is to be rescued * @param amount amount of native-balance being rescued */ function rescueEther( address payable userAddress, uint256 amount ) external onlyOwner { userAddress.transfer(amount); } /******************************************* * VIEW FUNCTIONS * *******************************************/ /** * @notice Get routeImplementation address mapped to the routeId * @param routeId routeId is the key in the mapping for routes * @return route-implementation address */ function getRoute(uint32 routeId) public view returns (address) { return addressAt(routeId); } /** * @notice Get controllerImplementation address mapped to the controllerId * @param controllerId controllerId is the key in the mapping for controllers * @return controller-implementation address */ function getController(uint32 controllerId) public view returns (address) { return controllers[controllerId]; } function addressAt(uint32 routeId) public view returns (address) { if (routeId < 385) { if (routeId < 257) { if (routeId < 129) { if (routeId < 65) { if (routeId < 33) { if (routeId < 17) { if (routeId < 9) { if (routeId < 5) { if (routeId < 3) { if (routeId == 1) { return 0x8cd6BaCDAe46B449E2e5B34e348A4eD459c84D50; } else { return 0x31524750Cd865fF6A3540f232754Fb974c18585C; } } else { if (routeId == 3) { return 0xEd9b37342BeC8f3a2D7b000732ec87498aA6EC6a; } else { return 0xE8704Ef6211F8988Ccbb11badC89841808d66890; } } } else { if (routeId < 7) { if (routeId == 5) { return 0x9aFF58C460a461578C433e11C4108D1c4cF77761; } else { return 0x2D1733886cFd465B0B99F1492F40847495f334C5; } } else { if (routeId == 7) { return 0x715497Be4D130F04B8442F0A1F7a9312D4e54FC4; } else { return 0x90C8a40c38E633B5B0e0d0585b9F7FA05462CaaF; } } } } else { if (routeId < 13) { if (routeId < 11) { if (routeId == 9) { return 0xa402b70FCfF3F4a8422B93Ef58E895021eAdE4F6; } else { return 0xc1B718522E15CD42C4Ac385a929fc2B51f5B892e; } } else { if (routeId == 11) { return 0xa97bf2f7c26C43c010c349F52f5eA5dC49B2DD38; } else { return 0x969423d71b62C81d2f28d707364c9Dc4a0764c53; } } } else { if (routeId < 15) { if (routeId == 13) { return 0xF86729934C083fbEc8C796068A1fC60701Ea1207; } else { return 0xD7cC2571F5823caCA26A42690D2BE7803DD5393f; } } else { if (routeId == 15) { return 0x7c8837a279bbbf7d8B93413763176de9F65d5bB9; } else { return 0x13b81C27B588C07D04458ed7dDbdbD26D1e39bcc; } } } } } else { if (routeId < 25) { if (routeId < 21) { if (routeId < 19) { if (routeId == 17) { return 0x52560Ac678aFA1345D15474287d16Dc1eA3F78aE; } else { return 0x1E31e376551459667cd7643440c1b21CE69065A0; } } else { if (routeId == 19) { return 0xc57D822CB3288e7b97EF8f8af0EcdcD1B783529B; } else { return 0x2197A1D9Af24b4d6a64Bff95B4c29Fcd3Ff28C30; } } } else { if (routeId < 23) { if (routeId == 21) { return 0xE3700feAa5100041Bf6b7AdBA1f72f647809Fd00; } else { return 0xc02E8a0Fdabf0EeFCEA025163d90B5621E2b9948; } } else { if (routeId == 23) { return 0xF5144235E2926cAb3c69b30113254Fa632f72d62; } else { return 0xBa3F92313B00A1f7Bc53b2c24EB195c8b2F57682; } } } } else { if (routeId < 29) { if (routeId < 27) { if (routeId == 25) { return 0x77a6856fe1fFA5bEB55A1d2ED86E27C7c482CB76; } else { return 0x4826Ff4e01E44b1FCEFBfb38cd96687Eb7786b44; } } else { if (routeId == 27) { return 0x55FF3f5493cf5e80E76DEA7E327b9Cd8440Af646; } else { return 0xF430Db544bE9770503BE4aa51997aA19bBd5BA4f; } } } else { if (routeId < 31) { if (routeId == 29) { return 0x0f166446ce1484EE3B0663E7E67DF10F5D240115; } else { return 0x6365095D92537f242Db5EdFDd572745E72aC33d9; } } else { if (routeId == 31) { return 0x5c7BC93f06ce3eAe75ADf55E10e23d2c1dE5Bc65; } else { return 0xe46383bAD90d7A08197ccF08972e9DCdccCE9BA4; } } } } } } else { if (routeId < 49) { if (routeId < 41) { if (routeId < 37) { if (routeId < 35) { if (routeId == 33) { return 0xf0f21710c071E3B728bdc4654c3c0b873aAaa308; } else { return 0x63Bc9ed3AcAAeB0332531C9fB03b0a2352E9Ff25; } } else { if (routeId == 35) { return 0xd1CE808625CB4007a1708824AE82CdB0ece57De9; } else { return 0x57BbB148112f4ba224841c3FE018884171004661; } } } else { if (routeId < 39) { if (routeId == 37) { return 0x037f7d6933036F34DFabd40Ff8e4D789069f92e3; } else { return 0xeF978c280915CfF3Dca4EDfa8932469e40ADA1e1; } } else { if (routeId == 39) { return 0x92ee9e071B13f7ecFD62B7DED404A16CBc223CD3; } else { return 0x94Ae539c186e41ed762271338Edf140414D1E442; } } } } else { if (routeId < 45) { if (routeId < 43) { if (routeId == 41) { return 0x30A64BBe4DdBD43dA2368EFd1eB2d80C10d84DAb; } else { return 0x3aEABf81c1Dc4c1b73d5B2a95410f126426FB596; } } else { if (routeId == 43) { return 0x25b08aB3D0C8ea4cC9d967b79688C6D98f3f563a; } else { return 0xea40cB15C9A3BBd27af6474483886F7c0c9AE406; } } } else { if (routeId < 47) { if (routeId == 45) { return 0x9580113Cc04e5a0a03359686304EF3A80b936Dd3; } else { return 0xD211c826d568957F3b66a3F4d9c5f68cCc66E619; } } else { if (routeId == 47) { return 0xCEE24D0635c4C56315d133b031984d4A6f509476; } else { return 0x3922e6B987983229798e7A20095EC372744d4D4c; } } } } } else { if (routeId < 57) { if (routeId < 53) { if (routeId < 51) { if (routeId == 49) { return 0x2d92D03413d296e1F31450479349757187F2a2b7; } else { return 0x0fe5308eE90FC78F45c89dB6053eA859097860CA; } } else { if (routeId == 51) { return 0x08Ba68e067C0505bAF0C1311E0cFB2B1B59b969c; } else { return 0x9bee5DdDF75C24897374f92A534B7A6f24e97f4a; } } } else { if (routeId < 55) { if (routeId == 53) { return 0x1FC5A90B232208704B930c1edf82FFC6ACc02734; } else { return 0x5b1B0417cb44c761C2a23ee435d011F0214b3C85; } } else { if (routeId == 55) { return 0x9d70cDaCA12A738C283020760f449D7816D592ec; } else { return 0x95a23b9CB830EcCFDDD5dF56A4ec665e3381Fa12; } } } } else { if (routeId < 61) { if (routeId < 59) { if (routeId == 57) { return 0x483a957Cf1251c20e096C35c8399721D1200A3Fc; } else { return 0xb4AD39Cb293b0Ec7FEDa743442769A7FF04987CD; } } else { if (routeId == 59) { return 0x4C543AD78c1590D81BAe09Fc5B6Df4132A2461d0; } else { return 0x471d5E5195c563902781734cfe1FF3981F8B6c86; } } } else { if (routeId < 63) { if (routeId == 61) { return 0x1B12a54B5E606D95B8B8D123c9Cb09221Ee37584; } else { return 0xE4127cC550baC433646a7D998775a84daC16c7f3; } } else { if (routeId == 63) { return 0xecb1b55AB12E7dd788D585c6C5cD61B5F87be836; } else { return 0xf91ef487C5A1579f70601b6D347e19756092eEBf; } } } } } } } else { if (routeId < 97) { if (routeId < 81) { if (routeId < 73) { if (routeId < 69) { if (routeId < 67) { if (routeId == 65) { return 0x34a16a7e9BADEEFD4f056310cbE0b1423Fa1b760; } else { return 0x60E10E80c7680f429dBbC232830BEcd3D623c4CF; } } else { if (routeId == 67) { return 0x66465285B8D65362A1d86CE00fE2bE949Fd6debF; } else { return 0x5aB231B7e1A3A74a48f67Ab7bde5Cdd4267022E0; } } } else { if (routeId < 71) { if (routeId == 69) { return 0x3A1C3633eE79d43366F5c67802a746aFD6b162Ba; } else { return 0x0C4BfCbA8dC3C811437521a80E81e41DAF479039; } } else { if (routeId == 71) { return 0x6caf25d2e139C5431a1FA526EAf8d73ff2e6252C; } else { return 0x74ad21e09FDa68638CE14A3009A79B6D16574257; } } } } else { if (routeId < 77) { if (routeId < 75) { if (routeId == 73) { return 0xD4923A61008894b99cc1CD3407eF9524f02aA0Ca; } else { return 0x6F159b5EB823BD415886b9271aA2A723a00a1987; } } else { if (routeId == 75) { return 0x742a8aA42E7bfB4554dE30f4Fb07FFb6f2068863; } else { return 0x4AE9702d3360400E47B446e76DE063ACAb930101; } } } else { if (routeId < 79) { if (routeId == 77) { return 0x0E19a0a44ddA7dAD854ec5Cc867d16869c4E80F4; } else { return 0xE021A51968f25148F726E326C88d2556c5647557; } } else { if (routeId == 79) { return 0x64287BDDDaeF4d94E4599a3D882bed29E6Ada4B6; } else { return 0xcBB57Fd2e19cc7e9D444d5b4325A2F1047d0C73f; } } } } } else { if (routeId < 89) { if (routeId < 85) { if (routeId < 83) { if (routeId == 81) { return 0x373DE80DF7D82cFF6D76F29581b360C56331e957; } else { return 0x0466356E131AD61596a51F86BAd1C03A328960D8; } } else { if (routeId == 83) { return 0x01726B960992f1b74311b248E2a922fC707d43A6; } else { return 0x2E21bdf9A4509b89795BCE7E132f248a75814CEc; } } } else { if (routeId < 87) { if (routeId == 85) { return 0x769512b23aEfF842379091d3B6E4B5456F631D42; } else { return 0xe7eD9be946a74Ec19325D39C6EEb57887ccB2B0D; } } else { if (routeId == 87) { return 0xc4D01Ec357c2b511d10c15e6b6974380F0E62e67; } else { return 0x5bC49CC9dD77bECF2fd3A3C55611e84E69AFa3AE; } } } } else { if (routeId < 93) { if (routeId < 91) { if (routeId == 89) { return 0x48bcD879954fA14e7DbdAeb56F79C1e9DDcb69ec; } else { return 0xE929bDde21b462572FcAA4de6F49B9D3246688D0; } } else { if (routeId == 91) { return 0x85Aae300438222f0e3A9Bc870267a5633A9438bd; } else { return 0x51f72E1096a81C55cd142d66d39B688C657f9Be8; } } } else { if (routeId < 95) { if (routeId == 93) { return 0x3A8a05BF68ac54B01E6C0f492abF97465F3d15f9; } else { return 0x145aA67133F0c2C36b9771e92e0B7655f0D59040; } } else { if (routeId == 95) { return 0xa030315d7DB11F9892758C9e7092D841e0ADC618; } else { return 0xdF1f8d81a3734bdDdEfaC6Ca1596E081e57c3044; } } } } } } else { if (routeId < 113) { if (routeId < 105) { if (routeId < 101) { if (routeId < 99) { if (routeId == 97) { return 0xFF2833123B58aa05d04D7fb99f5FB768B2b435F8; } else { return 0xc8f09c1fD751C570233765f71b0e280d74e6e743; } } else { if (routeId == 99) { return 0x3026DA6Ceca2E5A57A05153653D9212FFAaA49d8; } else { return 0xdE68Ee703dE0D11f67B0cE5891cB4a903de6D160; } } } else { if (routeId < 103) { if (routeId == 101) { return 0xE23a7730e81FB4E87A6D0bd9f63EE77ac86C3DA4; } else { return 0x8b1DBe04aD76a7d8bC079cACd3ED4D99B897F4a0; } } else { if (routeId == 103) { return 0xBB227240FA459b69C6889B2b8cb1BE76F118061f; } else { return 0xC062b9b3f0dB28BB8afAfcD4d075729344114ffe; } } } } else { if (routeId < 109) { if (routeId < 107) { if (routeId == 105) { return 0x553188Aa45f5FDB83EC4Ca485982F8fC082480D1; } else { return 0x0109d83D746EaCb6d4014953D9E12d6ca85e330b; } } else { if (routeId == 107) { return 0x45B1bEd29812F5bf6711074ACD180B2aeB783AD9; } else { return 0xdA06eC8c19aea31D77F60299678Cba40E743e1aD; } } } else { if (routeId < 111) { if (routeId == 109) { return 0x3cC5235c97d975a9b4FD4501B3446c981ea3D855; } else { return 0xa1827267d6Bd989Ff38580aE3d9deff6Acf19163; } } else { if (routeId == 111) { return 0x3663CAA0433A3D4171b3581Cf2410702840A735A; } else { return 0x7575D0a7614F655BA77C74a72a43bbd4fA6246a3; } } } } } else { if (routeId < 121) { if (routeId < 117) { if (routeId < 115) { if (routeId == 113) { return 0x2516Defc18bc07089c5dAFf5eafD7B0EF64611E2; } else { return 0xfec5FF08E20fbc107a97Af2D38BD0025b84ee233; } } else { if (routeId == 115) { return 0x0FB5763a87242B25243e23D73f55945fE787523A; } else { return 0xe4C00db89678dBf8391f430C578Ca857Dd98aDE1; } } } else { if (routeId < 119) { if (routeId == 117) { return 0x8F2A22061F9F35E64f14523dC1A5f8159e6a21B7; } else { return 0x18e4b838ae966917E20E9c9c5Ad359cDD38303bB; } } else { if (routeId == 119) { return 0x61ACb1d3Dcb3e3429832A164Cc0fC9849fb75A4a; } else { return 0x7681e3c8e7A41DCA55C257cc0d1Ae757f5530E65; } } } } else { if (routeId < 125) { if (routeId < 123) { if (routeId == 121) { return 0x806a2AB9748C3D1DB976550890E3f528B7E8Faec; } else { return 0xBDb8A5DD52C2c239fbC31E9d43B763B0197028FF; } } else { if (routeId == 123) { return 0x474EC9203706010B9978D6bD0b105D36755e4848; } else { return 0x8dfd0D829b303F2239212E591a0F92a32880f36E; } } } else { if (routeId < 127) { if (routeId == 125) { return 0xad4BcE9745860B1adD6F1Bd34a916f050E4c82C2; } else { return 0xBC701115b9fe14bC8CC5934cdC92517173e308C4; } } else { if (routeId == 127) { return 0x0D1918d786Db8546a11aDeD475C98370E06f255E; } else { return 0xee44f57cD6936DB55B99163f3Df367B01EdA785a; } } } } } } } } else { if (routeId < 193) { if (routeId < 161) { if (routeId < 145) { if (routeId < 137) { if (routeId < 133) { if (routeId < 131) { if (routeId == 129) { return 0x63044521fe5a1e488D7eD419cD0e35b7C24F2aa7; } else { return 0x410085E73BD85e90d97b84A68C125aDB9F91f85b; } } else { if (routeId == 131) { return 0x7913fe97E07C7A397Ec274Ab1d4E2622C88EC5D1; } else { return 0x977f9fE93c064DCf54157406DaABC3a722e8184C; } } } else { if (routeId < 135) { if (routeId == 133) { return 0xCD2236468722057cFbbABad2db3DEA9c20d5B01B; } else { return 0x17c7287A491cf5Ff81E2678cF2BfAE4333F6108c; } } else { if (routeId == 135) { return 0x354D9a5Dbf96c71B79a265F03B595C6Fdc04dadd; } else { return 0xb4e409EB8e775eeFEb0344f9eee884cc7ed21c69; } } } } else { if (routeId < 141) { if (routeId < 139) { if (routeId == 137) { return 0xa1a3c4670Ad69D9be4ab2D39D1231FEC2a63b519; } else { return 0x4589A22199870729C1be5CD62EE93BeD858113E6; } } else { if (routeId == 139) { return 0x8E7b864dB26Bd6C798C38d4Ba36EbA0d6602cF11; } else { return 0xA2D17C7260a4CB7b9854e89Fc367E80E87872a2d; } } } else { if (routeId < 143) { if (routeId == 141) { return 0xC7F0EDf0A1288627b0432304918A75e9084CBD46; } else { return 0xE4B4EF1f9A4aBFEdB371fA7a6143993B15d4df25; } } else { if (routeId == 143) { return 0xfe3D84A2Ef306FEBb5452441C9BDBb6521666F6A; } else { return 0x8A12B6C64121920110aE58F7cd67DfEc21c6a4C3; } } } } } else { if (routeId < 153) { if (routeId < 149) { if (routeId < 147) { if (routeId == 145) { return 0x76c4d9aFC4717a2BAac4e5f26CccF02351f7a3DA; } else { return 0xd4719BA550E397aeAcca1Ad2201c1ba69024FAAf; } } else { if (routeId == 147) { return 0x9646126Ce025224d1682C227d915a386efc0A1Fb; } else { return 0x4DD8Af2E3F2044842f0247920Bc4BABb636915ea; } } } else { if (routeId < 151) { if (routeId == 149) { return 0x8e8a327183Af0cf8C2ece9F0ed547C42A160D409; } else { return 0x9D49614CaE1C685C71678CA6d8CDF7584bfd0740; } } else { if (routeId == 151) { return 0x5a00ef257394cbc31828d48655E3d39e9c11c93d; } else { return 0xC9a2751b38d3dDD161A41Ca0135C5C6c09EC1d56; } } } } else { if (routeId < 157) { if (routeId < 155) { if (routeId == 153) { return 0x7e1c261640a525C94Ca4f8c25b48CF754DD83590; } else { return 0x409Fe24ba6F6BD5aF31C1aAf8059b986A3158233; } } else { if (routeId == 155) { return 0x704Cf5BFDADc0f55fDBb53B6ed8B582E018A72A2; } else { return 0x3982bF65d7d6E77E3b6661cd6F6468c247512737; } } } else { if (routeId < 159) { if (routeId == 157) { return 0x3982b9f26FFD67a13Ee371e2C0a9Da338BA70E7f; } else { return 0x6D834AB385900c1f49055D098e90264077FbC4f2; } } else { if (routeId == 159) { return 0x11FE5F70779A094B7166B391e1Fb73d422eF4e4d; } else { return 0xD347e4E47280d21F13B73D89c6d16f867D50DD13; } } } } } } else { if (routeId < 177) { if (routeId < 169) { if (routeId < 165) { if (routeId < 163) { if (routeId == 161) { return 0xb6035eDD53DDA28d8B69b4ae9836E40C80306CD7; } else { return 0x54c884e6f5C7CcfeCA990396c520C858c922b6CA; } } else { if (routeId == 163) { return 0x5eA93E240b083d686558Ed607BC013d88057cE46; } else { return 0x4C7131eE812De685cBe4e2cCb033d46ecD46612E; } } } else { if (routeId < 167) { if (routeId == 165) { return 0xc1a5Be9F0c33D8483801D702111068669f81fF91; } else { return 0x9E5fAb91455Be5E5b2C05967E73F456c8118B1Fc; } } else { if (routeId == 167) { return 0x3d9A05927223E0DC2F382831770405885e22F0d8; } else { return 0x6303A011fB6063f5B1681cb5a9938EA278dc6128; } } } } else { if (routeId < 173) { if (routeId < 171) { if (routeId == 169) { return 0xe9c60795c90C66797e4c8E97511eA07CdAda32bE; } else { return 0xD56cC98e69A1e13815818b466a8aA6163d84234A; } } else { if (routeId == 171) { return 0x47EbB9D36a6e40895316cD894E4860D774E2c531; } else { return 0xA5EB293629410065d14a7B1663A67829b0618292; } } } else { if (routeId < 175) { if (routeId == 173) { return 0x1b3B4C8146F939cE00899db8B3ddeF0062b7E023; } else { return 0x257Bbc11653625EbfB6A8587eF4f4FBe49828EB3; } } else { if (routeId == 175) { return 0x44cc979C01b5bB1eAC21301E73C37200dFD06F59; } else { return 0x2972fDF43352225D82754C0174Ff853819D1ef2A; } } } } } else { if (routeId < 185) { if (routeId < 181) { if (routeId < 179) { if (routeId == 177) { return 0x3e54144f032648A04D62d79f7B4b93FF3aC2333b; } else { return 0x444016102dB8adbE73C3B6703a1ea7F2f75A510D; } } else { if (routeId == 179) { return 0xac079143f98a6eb744Fde34541ebF243DF5B5dED; } else { return 0xAe9010767Fb112d29d35CEdfba2b372Ad7A308d3; } } } else { if (routeId < 183) { if (routeId == 181) { return 0xfE0BCcF9cCC2265D5fB3450743f17DfE57aE1e56; } else { return 0x04ED8C0545716119437a45386B1d691C63234C7D; } } else { if (routeId == 183) { return 0x636c14013e531A286Bc4C848da34585f0bB73d59; } else { return 0x2Fa67fc7ECC5cAA01C653d3BFeA98ecc5db9C42A; } } } } else { if (routeId < 189) { if (routeId < 187) { if (routeId == 185) { return 0x23e9a0FC180818aA872D2079a985217017E97bd9; } else { return 0x79A95c3Ef81b3ae64ee03A9D5f73e570495F164E; } } else { if (routeId == 187) { return 0xa7EA0E88F04a84ba0ad1E396cb07Fa3fDAD7dF6D; } else { return 0xd23cA1278a2B01a3C0Ca1a00d104b11c1Ebe6f42; } } } else { if (routeId < 191) { if (routeId == 189) { return 0x707bc4a9FA2E349AED5df4e9f5440C15aA9D14Bd; } else { return 0x7E290F2dd539Ac6CE58d8B4C2B944931a1fD3612; } } else { if (routeId == 191) { return 0x707AA5503088Ce06Ba450B6470A506122eA5c8eF; } else { return 0xFbB3f7BF680deeb149f4E7BC30eA3DDfa68F3C3f; } } } } } } } else { if (routeId < 225) { if (routeId < 209) { if (routeId < 201) { if (routeId < 197) { if (routeId < 195) { if (routeId == 193) { return 0xDE74aD8cCC3dbF14992f49Cf24f36855912f4934; } else { return 0x409BA83df7777F070b2B50a10a41DE2468d2a3B3; } } else { if (routeId == 195) { return 0x5CB7Be90A5DD7CfDa54e87626e254FE8C18255B4; } else { return 0x0A684fE12BC64fb72B59d0771a566F49BC090356; } } } else { if (routeId < 199) { if (routeId == 197) { return 0xDf30048d91F8FA2bCfC54952B92bFA8e161D3360; } else { return 0x050825Fff032a547C47061CF0696FDB0f65AEa5D; } } else { if (routeId == 199) { return 0xd55e671dAC1f03d366d8535073ada5DB2Aab1Ea2; } else { return 0x9470C704A9616c8Cd41c595Fcd2181B6fe2183C2; } } } } else { if (routeId < 205) { if (routeId < 203) { if (routeId == 201) { return 0x2D9ffD275181F5865d5e11CbB4ced1521C4dF9f1; } else { return 0x816d28Dec10ec95DF5334f884dE85cA6215918d8; } } else { if (routeId == 203) { return 0xd1f87267c4A43835E666dd69Df077e578A3b6299; } else { return 0x39E89Bde9DACbe5468C025dE371FbDa12bDeBAB1; } } } else { if (routeId < 207) { if (routeId == 205) { return 0x7b40A3207956ecad6686E61EfcaC48912FcD0658; } else { return 0x090cF10D793B1Efba9c7D76115878814B663859A; } } else { if (routeId == 207) { return 0x312A59c06E41327878F2063eD0e9c282C1DA3AfC; } else { return 0x4F1188f46236DD6B5de11Ebf2a9fF08716E7DeB6; } } } } } else { if (routeId < 217) { if (routeId < 213) { if (routeId < 211) { if (routeId == 209) { return 0x0A6F9a3f4fA49909bBfb4339cbE12B42F53BbBeD; } else { return 0x01d13d7aCaCbB955B81935c80ffF31e14BdFa71f; } } else { if (routeId == 211) { return 0x691a14Fa6C7360422EC56dF5876f84d4eDD7f00A; } else { return 0x97Aad18d886d181a9c726B3B6aE15a0A69F5aF73; } } } else { if (routeId < 215) { if (routeId == 213) { return 0x2917241371D2099049Fa29432DC46735baEC33b4; } else { return 0x5F20F20F7890c2e383E29D4147C9695A371165f5; } } else { if (routeId == 215) { return 0xeC0a60e639958335662C5219A320cCEbb56C6077; } else { return 0x96d63CF5062975C09845d17ec672E10255866053; } } } } else { if (routeId < 221) { if (routeId < 219) { if (routeId == 217) { return 0xFF57429e57D383939CAB50f09ABBfB63C0e6c9AD; } else { return 0x18E393A7c8578fb1e235C242076E50013cDdD0d7; } } else { if (routeId == 219) { return 0xE7E5238AF5d61f52E9B4ACC025F713d1C0216507; } else { return 0x428401D4d0F25A2EE1DA4d5366cB96Ded425D9bD; } } } else { if (routeId < 223) { if (routeId == 221) { return 0x42E5733551ff1Ee5B48Aa9fc2B61Af9b58C812E6; } else { return 0x64Df9c7A0551B056d860Bc2419Ca4c1EF75320bE; } } else { if (routeId == 223) { return 0x46006925506145611bBf0263243D8627dAf26B0F; } else { return 0x8D64BE884314662804eAaB884531f5C50F4d500c; } } } } } } else { if (routeId < 241) { if (routeId < 233) { if (routeId < 229) { if (routeId < 227) { if (routeId == 225) { return 0x157a62D92D07B5ce221A5429645a03bBaCE85373; } else { return 0xaF037D33e1F1F2F87309B425fe8a9d895Ef3722B; } } else { if (routeId == 227) { return 0x921D1154E494A2f7218a37ad7B17701f94b4B40e; } else { return 0xF282b4555186d8Dea51B8b3F947E1E0568d09bc4; } } } else { if (routeId < 231) { if (routeId == 229) { return 0xa794E2E1869765a4600b3DFd8a4ebcF16350f6B6; } else { return 0xFEFb048e20c5652F7940A49B1980E0125Ec4D358; } } else { if (routeId == 231) { return 0x220104b641971e9b25612a8F001bf48AbB23f1cF; } else { return 0xcB9D373Bb54A501B35dd3be5bF4Ba43cA31F7035; } } } } else { if (routeId < 237) { if (routeId < 235) { if (routeId == 233) { return 0x37D627F56e3FF36aC316372109ea82E03ac97DAc; } else { return 0x4E81355FfB4A271B4EA59ff78da2b61c7833161f; } } else { if (routeId == 235) { return 0xADd8D65cAF6Cc9ad73127B49E16eA7ac29d91e87; } else { return 0x630F9b95626487dfEAe3C97A44DB6C59cF35d996; } } } else { if (routeId < 239) { if (routeId == 237) { return 0x78CE2BC8238B679680A67FCB98C5A60E4ec17b2D; } else { return 0xA38D776028eD1310b9A6b086f67F788201762E21; } } else { if (routeId == 239) { return 0x7Bb5178827B76B86753Ed62a0d662c72cEcb1bD3; } else { return 0x4faC26f61C76eC5c3D43b43eDfAFF0736Ae0e3da; } } } } } else { if (routeId < 249) { if (routeId < 245) { if (routeId < 243) { if (routeId == 241) { return 0x791Bb49bfFA7129D6889FDB27744422Ac4571A85; } else { return 0x26766fFEbb5fa564777913A6f101dF019AB32afa; } } else { if (routeId == 243) { return 0x05e98E5e95b4ECBbbAf3258c3999Cc81ed8048Be; } else { return 0xC5c4621e52f1D6A1825A5ed4F95855401a3D9C6b; } } } else { if (routeId < 247) { if (routeId == 245) { return 0xfcb15f909BA7FC7Ea083503Fb4c1020203c107EB; } else { return 0xbD27603279d969c74f2486ad14E71080829DFd38; } } else { if (routeId == 247) { return 0xff2f756BcEcC1A55BFc09a30cc5F64720458cFCB; } else { return 0x3bfB968FEbC12F4e8420B2d016EfcE1E615f7246; } } } } else { if (routeId < 253) { if (routeId < 251) { if (routeId == 249) { return 0x982EE9Ffe23051A2ec945ed676D864fa8345222b; } else { return 0xe101899100785E74767d454FFF0131277BaD48d9; } } else { if (routeId == 251) { return 0x4F730C0c6b3B5B7d06ca511379f4Aa5BfB2E9525; } else { return 0x5499c36b365795e4e0Ef671aF6C2ce26D7c78265; } } } else { if (routeId < 255) { if (routeId == 253) { return 0x8AF51F7237Fc8fB2fc3E700488a94a0aC6Ad8b5a; } else { return 0xda8716df61213c0b143F2849785FB85928084857; } } else { if (routeId == 255) { return 0xF040Cf9b1ebD11Bf28e04e80740DF3DDe717e4f5; } else { return 0xB87ba32f759D14023C7520366B844dF7f0F036C2; } } } } } } } } } else { if (routeId < 321) { if (routeId < 289) { if (routeId < 273) { if (routeId < 265) { if (routeId < 261) { if (routeId < 259) { if (routeId == 257) { return 0x0Edde681b8478F0c3194f468EdD2dB5e75c65CDD; } else { return 0x59C70900Fca06eE2aCE1BDd5A8D0Af0cc3BBA720; } } else { if (routeId == 259) { return 0x8041F0f180D17dD07087199632c45E17AeB0BAd5; } else { return 0x4fB4727064BA595995DD516b63b5921Df9B93aC6; } } } else { if (routeId < 263) { if (routeId == 261) { return 0x86e98b594565857eD098864F560915C0dAfd6Ea1; } else { return 0x70f8818E8B698EFfeCd86A513a4c87c0c380Bef6; } } else { if (routeId == 263) { return 0x78Ed227c8A897A21Da2875a752142dd80d865158; } else { return 0xd02A30BB5C3a8C51d2751A029a6fcfDE2Af9fbc6; } } } } else { if (routeId < 269) { if (routeId < 267) { if (routeId == 265) { return 0x0F00d5c5acb24e975e2a56730609f7F40aa763b8; } else { return 0xC3e2091edc2D3D9D98ba09269138b617B536834A; } } else { if (routeId == 267) { return 0xa6FbaF7F30867C9633908998ea8C3da28920E75C; } else { return 0xE6dDdcD41E2bBe8122AE32Ac29B8fbAB79CD21d9; } } } else { if (routeId < 271) { if (routeId == 269) { return 0x537aa8c1Ef6a8Eaf039dd6e1Eb67694a48195cE4; } else { return 0x96ABAC485fd2D0B03CF4a10df8BD58b8dED28300; } } else { if (routeId == 271) { return 0xda8e7D46d04Bd4F62705Cd80355BDB6d441DafFD; } else { return 0xbE50018E7a5c67E2e5f5414393e971CC96F293f2; } } } } } else { if (routeId < 281) { if (routeId < 277) { if (routeId < 275) { if (routeId == 273) { return 0xa1b3907D6CB542a4cbe2eE441EfFAA909FAb62C3; } else { return 0x6d08ee8511C0237a515013aC389e7B3968Cb1753; } } else { if (routeId == 275) { return 0x22faa5B5Fe43eAdbB52745e35a5cdA8bD5F96bbA; } else { return 0x7a673eB74D79e4868D689E7852abB5f93Ec2fD4b; } } } else { if (routeId < 279) { if (routeId == 277) { return 0x0b8531F8AFD4190b76F3e10deCaDb84c98b4d419; } else { return 0x78eABC743A93583DeE403D6b84795490e652216B; } } else { if (routeId == 279) { return 0x3A95D907b2a7a8604B59BccA08585F58Afe0Aa64; } else { return 0xf4271f0C8c9Af0F06A80b8832fa820ccE64FAda8; } } } } else { if (routeId < 285) { if (routeId < 283) { if (routeId == 281) { return 0x74b2DF841245C3748c0d31542e1335659a25C33b; } else { return 0xdFC99Fd0Ad7D16f30f295a5EEFcE029E04d0fa65; } } else { if (routeId == 283) { return 0xE992416b6aC1144eD8148a9632973257839027F6; } else { return 0x54ce55ba954E981BB1fd9399054B35Ce1f2C0816; } } } else { if (routeId < 287) { if (routeId == 285) { return 0xD4AB52f9e7E5B315Bd7471920baD04F405Ab1c38; } else { return 0x3670C990994d12837e95eE127fE2f06FD3E2104B; } } else { if (routeId == 287) { return 0xDcf190B09C47E4f551E30BBb79969c3FdEA1e992; } else { return 0xa65057B967B59677237e57Ab815B209744b9bc40; } } } } } } else { if (routeId < 305) { if (routeId < 297) { if (routeId < 293) { if (routeId < 291) { if (routeId == 289) { return 0x6Efc86B40573e4C7F28659B13327D55ae955C483; } else { return 0x06BcC25CF8e0E72316F53631b3aA7134E9f73Ae0; } } else { if (routeId == 291) { return 0x710b6414E1D53882b1FCD3A168aD5Ccd435fc6D0; } else { return 0x5Ebb2C3d78c4e9818074559e7BaE7FCc99781DC1; } } } else { if (routeId < 295) { if (routeId == 293) { return 0xAf0a409c3AEe0bD08015cfb29D89E90b6e89A88F; } else { return 0x522559d8b99773C693B80cE06DF559036295Ce44; } } else { if (routeId == 295) { return 0xB65290A5Bae838aaa7825c9ECEC68041841a1B64; } else { return 0x801b8F2068edd5Bcb659E6BDa0c425909043C420; } } } } else { if (routeId < 301) { if (routeId < 299) { if (routeId == 297) { return 0x29b5F00515d093627E0B7bd0b5c8E84F6b4cDb87; } else { return 0x652839Ae74683cbF9f1293F1019D938F87464D3E; } } else { if (routeId == 299) { return 0x5Bc95dCebDDE9B79F2b6DC76121BC7936eF8D666; } else { return 0x90db359CEA62E53051158Ab5F99811C0a07Fe686; } } } else { if (routeId < 303) { if (routeId == 301) { return 0x2c3625EedadbDcDbB5330eb0d17b3C39ff269807; } else { return 0xC3f0324471b5c9d415acD625b8d8694a4e48e001; } } else { if (routeId == 303) { return 0x8C60e7E05fa0FfB6F720233736f245134685799d; } else { return 0x98fAF2c09aa4EBb995ad0B56152993E7291a500e; } } } } } else { if (routeId < 313) { if (routeId < 309) { if (routeId < 307) { if (routeId == 305) { return 0x802c1063a861414dFAEc16bacb81429FC0d40D6e; } else { return 0x11C4AeFCC0dC156f64195f6513CB1Fb3Be0Ae056; } } else { if (routeId == 307) { return 0xEff1F3258214E31B6B4F640b4389d55715C3Be2B; } else { return 0x47e379Abe8DDFEA4289aBa01235EFF7E93758fd7; } } } else { if (routeId < 311) { if (routeId == 309) { return 0x3CC26384c3eA31dDc8D9789e8872CeA6F20cD3ff; } else { return 0xEdd9EFa6c69108FAA4611097d643E20Ba0Ed1634; } } else { if (routeId == 311) { return 0xCb93525CA5f3D371F74F3D112bC19526740717B8; } else { return 0x7071E0124EB4438137e60dF1b8DD8Af1BfB362cF; } } } } else { if (routeId < 317) { if (routeId < 315) { if (routeId == 313) { return 0x4691096EB0b78C8F4b4A8091E5B66b18e1835c10; } else { return 0x8d953c9b2d1C2137CF95992079f3A77fCd793272; } } else { if (routeId == 315) { return 0xbdCc2A3Bf6e3Ba49ff86595e6b2b8D70d8368c92; } else { return 0x95E6948aB38c61b2D294E8Bd896BCc4cCC0713cf; } } } else { if (routeId < 319) { if (routeId == 317) { return 0x607b27C881fFEE4Cb95B1c5862FaE7224ccd0b4A; } else { return 0x09D28aFA166e566A2Ee1cB834ea8e78C7E627eD2; } } else { if (routeId == 319) { return 0x9c01449b38bDF0B263818401044Fb1401B29fDfA; } else { return 0x1F7723599bbB658c051F8A39bE2688388d22ceD6; } } } } } } } else { if (routeId < 353) { if (routeId < 337) { if (routeId < 329) { if (routeId < 325) { if (routeId < 323) { if (routeId == 321) { return 0x52B71603f7b8A5d15B4482e965a0619aa3210194; } else { return 0x01c0f072CB210406653752FecFA70B42dA9173a2; } } else { if (routeId == 323) { return 0x3021142f021E943e57fc1886cAF58D06147D09A6; } else { return 0xe6f2AF38e76AB09Db59225d97d3E770942D3D842; } } } else { if (routeId < 327) { if (routeId == 325) { return 0x06a25554e5135F08b9e2eD1DEC1fc3CEd52e0B48; } else { return 0x71d75e670EE3511C8290C705E0620126B710BF8D; } } else { if (routeId == 327) { return 0x8b9cE142b80FeA7c932952EC533694b1DF9B3c54; } else { return 0xd7Be24f32f39231116B3fDc483C2A12E1521f73B; } } } } else { if (routeId < 333) { if (routeId < 331) { if (routeId == 329) { return 0xb40cafBC4797d4Ff64087E087F6D2e661f954CbE; } else { return 0xBdDCe7771EfEe81893e838f62204A4c76D72757e; } } else { if (routeId == 331) { return 0x5d3D299EA7Fd4F39AcDb336E26631Dfee41F9287; } else { return 0x6BfEE09E1Fc0684e0826A9A0dC1352a14B136FAC; } } } else { if (routeId < 335) { if (routeId == 333) { return 0xd0001bB8E2Cb661436093f96458a4358B5156E3c; } else { return 0x1867c6485CfD1eD448988368A22bfB17a7747293; } } else { if (routeId == 335) { return 0x8997EF9F95dF24aB67703AB6C262aABfeEBE33bD; } else { return 0x1e39E9E601922deD91BCFc8F78836302133465e2; } } } } } else { if (routeId < 345) { if (routeId < 341) { if (routeId < 339) { if (routeId == 337) { return 0x8A8ec6CeacFf502a782216774E5AF3421562C6ff; } else { return 0x3B8FC561df5415c8DC01e97Ee6E38435A8F9C40A; } } else { if (routeId == 339) { return 0xD5d5f5B37E67c43ceA663aEDADFFc3a93a2065B0; } else { return 0xCC8F55EC43B4f25013CE1946FBB740c43Be5B96D; } } } else { if (routeId < 343) { if (routeId == 341) { return 0x18f586E816eEeDbb57B8011239150367561B58Fb; } else { return 0xd0CD802B19c1a52501cb2f07d656e3Cd7B0Ce124; } } else { if (routeId == 343) { return 0xe0AeD899b39C6e4f2d83e4913a1e9e0cf6368abE; } else { return 0x0606e1b6c0f1A398C38825DCcc4678a7Cbc2737c; } } } } else { if (routeId < 349) { if (routeId < 347) { if (routeId == 345) { return 0x2d188e85b27d18EF80f16686EA1593ABF7Ed2A63; } else { return 0x64412292fA4A135a3300E24366E99ff59Db2eAc1; } } else { if (routeId == 347) { return 0x38b74c173f3733E8b90aAEf0e98B89791266149F; } else { return 0x36DAA49A79aaEF4E7a217A11530D3cCD84414124; } } } else { if (routeId < 351) { if (routeId == 349) { return 0x10f088FE2C88F90270E4449c46c8B1b232511d58; } else { return 0x4FeDbd25B58586838ABD17D10272697dF1dC3087; } } else { if (routeId == 351) { return 0x685278209248CB058E5cEe93e37f274A80Faf6eb; } else { return 0xDd9F8F1eeC3955f78168e2Fb2d1e808fa8A8f15b; } } } } } } else { if (routeId < 369) { if (routeId < 361) { if (routeId < 357) { if (routeId < 355) { if (routeId == 353) { return 0x7392aEeFD5825aaC28817031dEEBbFaAA20983D9; } else { return 0x0Cc182555E00767D6FB8AD161A10d0C04C476d91; } } else { if (routeId == 355) { return 0x90E52837d56715c79FD592E8D58bFD20365798b2; } else { return 0x6F4451DE14049B6770ad5BF4013118529e68A40C; } } } else { if (routeId < 359) { if (routeId == 357) { return 0x89B97ef2aFAb9ed9c7f0FDb095d02E6840b52d9c; } else { return 0x92A5cC5C42d94d3e23aeB1214fFf43Db2B97759E; } } else { if (routeId == 359) { return 0x63ddc52F135A1dcBA831EAaC11C63849F018b739; } else { return 0x692A691533B571C2c54C1D7F8043A204b3d8120E; } } } } else { if (routeId < 365) { if (routeId < 363) { if (routeId == 361) { return 0x97c7492CF083969F61C6f302d45c8270391b921c; } else { return 0xDeFD2B8643553dAd19548eB14fd94A57F4B9e543; } } else { if (routeId == 363) { return 0x30645C04205cA3f670B67b02F971B088930ACB8C; } else { return 0xA6f80ed2d607Cd67aEB4109B64A0BEcc4D7d03CF; } } } else { if (routeId < 367) { if (routeId == 365) { return 0xBbbbC6c276eB3F7E674f2D39301509236001c42f; } else { return 0xC20E77d349FB40CE88eB01824e2873ad9f681f3C; } } else { if (routeId == 367) { return 0x5fCfD9a962De19294467C358C1FA55082285960b; } else { return 0x4D87BD6a0E4E5cc6332923cb3E85fC71b287F58A; } } } } } else { if (routeId < 377) { if (routeId < 373) { if (routeId < 371) { if (routeId == 369) { return 0x3AA5B757cd6Dde98214E56D57Dde7fcF0F7aB04E; } else { return 0xe28eFCE7192e11a2297f44059113C1fD6967b2d4; } } else { if (routeId == 371) { return 0x3251cAE10a1Cf246e0808D76ACC26F7B5edA0eE5; } else { return 0xbA2091cc9357Cf4c4F25D64F30d1b4Ba3A5a174B; } } } else { if (routeId < 375) { if (routeId == 373) { return 0x49c8e1Da9693692096F63C82D11b52d738566d55; } else { return 0xA0731615aB5FFF451031E9551367A4F7dB27b39c; } } else { if (routeId == 375) { return 0xFb214541888671AE1403CecC1D59763a12fc1609; } else { return 0x1D6bCB17642E2336405df73dF22F07688cAec020; } } } } else { if (routeId < 381) { if (routeId < 379) { if (routeId == 377) { return 0xfC9c0C7bfe187120fF7f4E21446161794A617a9e; } else { return 0xBa5bF37678EeE2dAB17AEf9D898153258252250E; } } else { if (routeId == 379) { return 0x7c55690bd2C9961576A32c02f8EB29ed36415Ec7; } else { return 0xcA40073E868E8Bc611aEc8Fe741D17E68Fe422f6; } } } else { if (routeId < 383) { if (routeId == 381) { return 0x31641bAFb87E9A58f78835050a7BE56921986339; } else { return 0xA54766424f6dA74b45EbCc5Bf0Bd1D74D2CCcaAB; } } else { if (routeId == 383) { return 0xc7bBa57F8C179EDDBaa62117ddA360e28f3F8252; } else { return 0x5e663ED97ea77d393B8858C90d0683bF180E0ffd; } } } } } } } } } if (routes[routeId] == address(0)) revert ZeroAddressNotAllowed(); return routes[routeId]; } /// @notice fallback function to handle swap, bridge execution /// @dev ensure routeId is converted to bytes4 and sent as msg.sig in the transaction fallback() external payable { address routeAddress = addressAt(uint32(msg.sig)); bytes memory result; assembly { // copy function selector and any arguments calldatacopy(0, 4, sub(calldatasize(), 4)) // execute function call using the facet result := delegatecall( gas(), routeAddress, 0, sub(calldatasize(), 4), 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()) } } } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; bytes32 constant ACROSS = keccak256("Across"); bytes32 constant ANYSWAP = keccak256("Anyswap"); bytes32 constant CBRIDGE = keccak256("CBridge"); bytes32 constant HOP = keccak256("Hop"); bytes32 constant HYPHEN = keccak256("Hyphen"); bytes32 constant NATIVE_OPTIMISM = keccak256("NativeOptimism"); bytes32 constant NATIVE_ARBITRUM = keccak256("NativeArbitrum"); bytes32 constant NATIVE_POLYGON = keccak256("NativePolygon"); bytes32 constant REFUEL = keccak256("Refuel"); bytes32 constant STARGATE = keccak256("Stargate"); bytes32 constant ONEINCH = keccak256("OneInch"); bytes32 constant ZEROX = keccak256("Zerox"); bytes32 constant RAINBOW = keccak256("Rainbow"); // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import "../SwapImplBase.sol"; import {SwapFailed} from "../../errors/SocketErrors.sol"; import {ONEINCH} from "../../static/RouteIdentifiers.sol"; /** * @title OneInch-Swap-Route Implementation * @notice Route implementation with functions to swap tokens via OneInch-Swap * Called via SocketGateway if the routeId in the request maps to the routeId of OneInchImplementation * @author Socket dot tech. */ contract OneInchImpl is SwapImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable OneInchIdentifier = ONEINCH; /// @notice address of OneInchAggregator to swap the tokens on Chain address public immutable ONEINCH_AGGREGATOR; /// @notice socketGatewayAddress to be initialised via storage variable SwapImplBase /// @dev ensure _oneinchAggregator are set properly for the chainId in which the contract is being deployed constructor( address _oneinchAggregator, address _socketGateway, address _socketDeployFactory ) SwapImplBase(_socketGateway, _socketDeployFactory) { ONEINCH_AGGREGATOR = _oneinchAggregator; } /** * @notice function to swap tokens on the chain and transfer to receiver address * via OneInch-Middleware-Aggregator * @param fromToken token to be swapped * @param toToken token to which fromToken has to be swapped * @param amount amount of fromToken being swapped * @param receiverAddress address of toToken recipient * @param swapExtraData encoded value of properties in the swapData Struct * @return swapped amount (in toToken Address) */ function performAction( address fromToken, address toToken, uint256 amount, address receiverAddress, bytes calldata swapExtraData ) external payable override returns (uint256) { uint256 returnAmount; if (fromToken != NATIVE_TOKEN_ADDRESS) { ERC20 token = ERC20(fromToken); token.safeTransferFrom(msg.sender, socketGateway, amount); token.safeApprove(ONEINCH_AGGREGATOR, amount); { // additional data is generated in off-chain using the OneInch API which takes in // fromTokenAddress, toTokenAddress, amount, fromAddress, slippage, destReceiver, disableEstimate (bool success, bytes memory result) = ONEINCH_AGGREGATOR.call( swapExtraData ); token.safeApprove(ONEINCH_AGGREGATOR, 0); if (!success) { revert SwapFailed(); } returnAmount = abi.decode(result, (uint256)); } } else { // additional data is generated in off-chain using the OneInch API which takes in // fromTokenAddress, toTokenAddress, amount, fromAddress, slippage, destReceiver, disableEstimate (bool success, bytes memory result) = ONEINCH_AGGREGATOR.call{ value: amount }(swapExtraData); if (!success) { revert SwapFailed(); } returnAmount = abi.decode(result, (uint256)); } emit SocketSwapTokens( fromToken, toToken, returnAmount, amount, OneInchIdentifier, receiverAddress ); return returnAmount; } /** * @notice function to swapWithIn SocketGateway - swaps tokens on the chain to socketGateway as recipient * via OneInch-Middleware-Aggregator * @param fromToken token to be swapped * @param toToken token to which fromToken has to be swapped * @param amount amount of fromToken being swapped * @param swapExtraData encoded value of properties in the swapData Struct * @return swapped amount (in toToken Address) */ function performActionWithIn( address fromToken, address toToken, uint256 amount, bytes calldata swapExtraData ) external payable override returns (uint256, address) { uint256 returnAmount; if (fromToken != NATIVE_TOKEN_ADDRESS) { ERC20 token = ERC20(fromToken); token.safeTransferFrom(msg.sender, socketGateway, amount); token.safeApprove(ONEINCH_AGGREGATOR, amount); { // additional data is generated in off-chain using the OneInch API which takes in // fromTokenAddress, toTokenAddress, amount, fromAddress, slippage, destReceiver, disableEstimate (bool success, bytes memory result) = ONEINCH_AGGREGATOR.call( swapExtraData ); token.safeApprove(ONEINCH_AGGREGATOR, 0); if (!success) { revert SwapFailed(); } returnAmount = abi.decode(result, (uint256)); } } else { // additional data is generated in off-chain using the OneInch API which takes in // fromTokenAddress, toTokenAddress, amount, fromAddress, slippage, destReceiver, disableEstimate (bool success, bytes memory result) = ONEINCH_AGGREGATOR.call{ value: amount }(swapExtraData); if (!success) { revert SwapFailed(); } returnAmount = abi.decode(result, (uint256)); } emit SocketSwapTokens( fromToken, toToken, returnAmount, amount, OneInchIdentifier, socketGateway ); return (returnAmount, toToken); } } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import "../SwapImplBase.sol"; import {Address0Provided, SwapFailed} from "../../errors/SocketErrors.sol"; import {RAINBOW} from "../../static/RouteIdentifiers.sol"; /** * @title Rainbow-Swap-Route Implementation * @notice Route implementation with functions to swap tokens via Rainbow-Swap * Called via SocketGateway if the routeId in the request maps to the routeId of RainbowImplementation * @author Socket dot tech. */ contract RainbowSwapImpl is SwapImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable RainbowIdentifier = RAINBOW; /// @notice unique name to identify the router, used to emit event upon successful bridging bytes32 public immutable NAME = keccak256("Rainbow-Router"); /// @notice address of rainbow-swap-aggregator to swap the tokens on Chain address payable public immutable rainbowSwapAggregator; /// @notice socketGatewayAddress to be initialised via storage variable SwapImplBase /// @notice rainbow swap aggregator contract is payable to allow ethereum swaps /// @dev ensure _rainbowSwapAggregator are set properly for the chainId in which the contract is being deployed constructor( address _rainbowSwapAggregator, address _socketGateway, address _socketDeployFactory ) SwapImplBase(_socketGateway, _socketDeployFactory) { rainbowSwapAggregator = payable(_rainbowSwapAggregator); } receive() external payable {} fallback() external payable {} /** * @notice function to swap tokens on the chain and transfer to receiver address * @notice This method is payable because the caller is doing token transfer and swap operation * @param fromToken address of token being Swapped * @param toToken address of token that recipient will receive after swap * @param amount amount of fromToken being swapped * @param receiverAddress recipient-address * @param swapExtraData additional Data to perform Swap via Rainbow-Aggregator * @return swapped amount (in toToken Address) */ function performAction( address fromToken, address toToken, uint256 amount, address receiverAddress, bytes calldata swapExtraData ) external payable override returns (uint256) { if (fromToken == address(0)) { revert Address0Provided(); } bytes memory swapCallData = abi.decode(swapExtraData, (bytes)); uint256 _initialBalanceTokenOut; uint256 _finalBalanceTokenOut; ERC20 toTokenERC20 = ERC20(toToken); if (toToken != NATIVE_TOKEN_ADDRESS) { _initialBalanceTokenOut = toTokenERC20.balanceOf(socketGateway); } else { _initialBalanceTokenOut = address(this).balance; } if (fromToken != NATIVE_TOKEN_ADDRESS) { ERC20 token = ERC20(fromToken); token.safeTransferFrom(msg.sender, socketGateway, amount); token.safeApprove(rainbowSwapAggregator, amount); // solhint-disable-next-line (bool success, ) = rainbowSwapAggregator.call(swapCallData); if (!success) { revert SwapFailed(); } token.safeApprove(rainbowSwapAggregator, 0); } else { (bool success, ) = rainbowSwapAggregator.call{value: amount}( swapCallData ); if (!success) { revert SwapFailed(); } } if (toToken != NATIVE_TOKEN_ADDRESS) { _finalBalanceTokenOut = toTokenERC20.balanceOf(socketGateway); } else { _finalBalanceTokenOut = address(this).balance; } uint256 returnAmount = _finalBalanceTokenOut - _initialBalanceTokenOut; if (toToken == NATIVE_TOKEN_ADDRESS) { payable(receiverAddress).transfer(returnAmount); } else { toTokenERC20.transfer(receiverAddress, returnAmount); } emit SocketSwapTokens( fromToken, toToken, returnAmount, amount, RainbowIdentifier, receiverAddress ); return returnAmount; } /** * @notice function to swapWithIn SocketGateway - swaps tokens on the chain to socketGateway as recipient * @param fromToken token to be swapped * @param toToken token to which fromToken has to be swapped * @param amount amount of fromToken being swapped * @param swapExtraData encoded value of properties in the swapData Struct * @return swapped amount (in toToken Address) */ function performActionWithIn( address fromToken, address toToken, uint256 amount, bytes calldata swapExtraData ) external payable override returns (uint256, address) { if (fromToken == address(0)) { revert Address0Provided(); } bytes memory swapCallData = abi.decode(swapExtraData, (bytes)); uint256 _initialBalanceTokenOut; uint256 _finalBalanceTokenOut; ERC20 toTokenERC20 = ERC20(toToken); if (toToken != NATIVE_TOKEN_ADDRESS) { _initialBalanceTokenOut = toTokenERC20.balanceOf(socketGateway); } else { _initialBalanceTokenOut = address(this).balance; } if (fromToken != NATIVE_TOKEN_ADDRESS) { ERC20 token = ERC20(fromToken); token.safeTransferFrom(msg.sender, socketGateway, amount); token.safeApprove(rainbowSwapAggregator, amount); // solhint-disable-next-line (bool success, ) = rainbowSwapAggregator.call(swapCallData); if (!success) { revert SwapFailed(); } token.safeApprove(rainbowSwapAggregator, 0); } else { (bool success, ) = rainbowSwapAggregator.call{value: amount}( swapCallData ); if (!success) { revert SwapFailed(); } } if (toToken != NATIVE_TOKEN_ADDRESS) { _finalBalanceTokenOut = toTokenERC20.balanceOf(socketGateway); } else { _finalBalanceTokenOut = address(this).balance; } uint256 returnAmount = _finalBalanceTokenOut - _initialBalanceTokenOut; emit SocketSwapTokens( fromToken, toToken, returnAmount, amount, RainbowIdentifier, socketGateway ); return (returnAmount, toToken); } } // SPDX-License-Identifier: MIT pragma solidity ^0.8.4; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import {ISocketGateway} from "../interfaces/ISocketGateway.sol"; import {OnlySocketGatewayOwner, OnlySocketDeployer} from "../errors/SocketErrors.sol"; /** * @title Abstract Implementation Contract. * @notice All Swap Implementation will follow this interface. * @author Socket dot tech. */ abstract contract SwapImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; /// @notice Address used to identify if it is a native token transfer or not address public immutable NATIVE_TOKEN_ADDRESS = address(0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE); /// @notice immutable variable to store the socketGateway address address public immutable socketGateway; /// @notice immutable variable to store the socketGateway address address public immutable socketDeployFactory; /// @notice FunctionSelector used to delegatecall to the performAction function of swap-router-implementation bytes4 public immutable SWAP_FUNCTION_SELECTOR = bytes4( keccak256("performAction(address,address,uint256,address,bytes)") ); /// @notice FunctionSelector used to delegatecall to the performActionWithIn function of swap-router-implementation bytes4 public immutable SWAP_WITHIN_FUNCTION_SELECTOR = bytes4(keccak256("performActionWithIn(address,address,uint256,bytes)")); /**************************************** * EVENTS * ****************************************/ event SocketSwapTokens( address fromToken, address toToken, uint256 buyAmount, uint256 sellAmount, bytes32 routeName, address receiver ); /** * @notice Construct the base for all SwapImplementations. * @param _socketGateway Socketgateway address, an immutable variable to set. */ constructor(address _socketGateway, address _socketDeployFactory) { socketGateway = _socketGateway; socketDeployFactory = _socketDeployFactory; } /**************************************** * MODIFIERS * ****************************************/ /// @notice Implementing contract needs to make use of the modifier where restricted access is to be used modifier isSocketGatewayOwner() { if (msg.sender != ISocketGateway(socketGateway).owner()) { revert OnlySocketGatewayOwner(); } _; } /// @notice Implementing contract needs to make use of the modifier where restricted access is to be used modifier isSocketDeployFactory() { if (msg.sender != socketDeployFactory) { revert OnlySocketDeployer(); } _; } /**************************************** * RESTRICTED FUNCTIONS * ****************************************/ /** * @notice function to rescue the ERC20 tokens in the Swap-Implementation contract * @notice this is a function restricted to Owner of SocketGateway only * @param token address of ERC20 token being rescued * @param userAddress receipient address to which ERC20 tokens will be rescued to * @param amount amount of ERC20 tokens being rescued */ function rescueFunds( address token, address userAddress, uint256 amount ) external isSocketGatewayOwner { ERC20(token).safeTransfer(userAddress, amount); } /** * @notice function to rescue the native-balance in the Swap-Implementation contract * @notice this is a function restricted to Owner of SocketGateway only * @param userAddress receipient address to which native-balance will be rescued to * @param amount amount of native balance tokens being rescued */ function rescueEther( address payable userAddress, uint256 amount ) external isSocketGatewayOwner { userAddress.transfer(amount); } function killme() external isSocketDeployFactory { selfdestruct(payable(msg.sender)); } /****************************** * VIRTUAL FUNCTIONS * *****************************/ /** * @notice function to swap tokens on the chain * All swap implementation contracts must implement this function * @param fromToken token to be swapped * @param toToken token to which fromToken has to be swapped * @param amount amount of fromToken being swapped * @param receiverAddress recipient address of toToken * @param data encoded value of properties in the swapData Struct */ function performAction( address fromToken, address toToken, uint256 amount, address receiverAddress, bytes memory data ) external payable virtual returns (uint256); /** * @notice function to swapWith - swaps tokens on the chain to socketGateway as recipient * All swap implementation contracts must implement this function * @param fromToken token to be swapped * @param toToken token to which fromToken has to be swapped * @param amount amount of fromToken being swapped * @param swapExtraData encoded value of properties in the swapData Struct */ function performActionWithIn( address fromToken, address toToken, uint256 amount, bytes memory swapExtraData ) external payable virtual returns (uint256, address); } // SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import {SafeTransferLib} from "lib/solmate/src/utils/SafeTransferLib.sol"; import {ERC20} from "lib/solmate/src/tokens/ERC20.sol"; import "../SwapImplBase.sol"; import {Address0Provided, SwapFailed} from "../../errors/SocketErrors.sol"; import {ZEROX} from "../../static/RouteIdentifiers.sol"; /** * @title ZeroX-Swap-Route Implementation * @notice Route implementation with functions to swap tokens via ZeroX-Swap * Called via SocketGateway if the routeId in the request maps to the routeId of ZeroX-Swap-Implementation * @author Socket dot tech. */ contract ZeroXSwapImpl is SwapImplBase { /// @notice SafeTransferLib - library for safe and optimised operations on ERC20 tokens using SafeTransferLib for ERC20; bytes32 public immutable ZeroXIdentifier = ZEROX; /// @notice unique name to identify the router, used to emit event upon successful bridging bytes32 public immutable NAME = keccak256("Zerox-Router"); /// @notice address of ZeroX-Exchange-Proxy to swap the tokens on Chain address payable public immutable zeroXExchangeProxy; /// @notice socketGatewayAddress to be initialised via storage variable SwapImplBase /// @notice ZeroXExchangeProxy contract is payable to allow ethereum swaps /// @dev ensure _zeroXExchangeProxy are set properly for the chainId in which the contract is being deployed constructor( address _zeroXExchangeProxy, address _socketGateway, address _socketDeployFactory ) SwapImplBase(_socketGateway, _socketDeployFactory) { zeroXExchangeProxy = payable(_zeroXExchangeProxy); } receive() external payable {} fallback() external payable {} /** * @notice function to swap tokens on the chain and transfer to receiver address * @dev This is called only when there is a request for a swap. * @param fromToken token to be swapped * @param toToken token to which fromToken is to be swapped * @param amount amount to be swapped * @param receiverAddress address of toToken recipient * @param swapExtraData data required for zeroX Exchange to get the swap done */ function performAction( address fromToken, address toToken, uint256 amount, address receiverAddress, bytes calldata swapExtraData ) external payable override returns (uint256) { if (fromToken == address(0)) { revert Address0Provided(); } bytes memory swapCallData = abi.decode(swapExtraData, (bytes)); uint256 _initialBalanceTokenOut; uint256 _finalBalanceTokenOut; ERC20 erc20ToToken = ERC20(toToken); if (toToken != NATIVE_TOKEN_ADDRESS) { _initialBalanceTokenOut = erc20ToToken.balanceOf(address(this)); } else { _initialBalanceTokenOut = address(this).balance; } if (fromToken != NATIVE_TOKEN_ADDRESS) { ERC20 token = ERC20(fromToken); token.safeTransferFrom(msg.sender, address(this), amount); token.safeApprove(zeroXExchangeProxy, amount); // solhint-disable-next-line (bool success, ) = zeroXExchangeProxy.call(swapCallData); if (!success) { revert SwapFailed(); } token.safeApprove(zeroXExchangeProxy, 0); } else { (bool success, ) = zeroXExchangeProxy.call{value: amount}( swapCallData ); if (!success) { revert SwapFailed(); } } if (toToken != NATIVE_TOKEN_ADDRESS) { _finalBalanceTokenOut = erc20ToToken.balanceOf(address(this)); } else { _finalBalanceTokenOut = address(this).balance; } uint256 returnAmount = _finalBalanceTokenOut - _initialBalanceTokenOut; if (toToken == NATIVE_TOKEN_ADDRESS) { payable(receiverAddress).transfer(returnAmount); } else { erc20ToToken.transfer(receiverAddress, returnAmount); } emit SocketSwapTokens( fromToken, toToken, returnAmount, amount, ZeroXIdentifier, receiverAddress ); return returnAmount; } /** * @notice function to swapWithIn SocketGateway - swaps tokens on the chain to socketGateway as recipient * @param fromToken token to be swapped * @param toToken token to which fromToken has to be swapped * @param amount amount of fromToken being swapped * @param swapExtraData encoded value of properties in the swapData Struct * @return swapped amount (in toToken Address) */ function performActionWithIn( address fromToken, address toToken, uint256 amount, bytes calldata swapExtraData ) external payable override returns (uint256, address) { if (fromToken == address(0)) { revert Address0Provided(); } bytes memory swapCallData = abi.decode(swapExtraData, (bytes)); uint256 _initialBalanceTokenOut; uint256 _finalBalanceTokenOut; ERC20 erc20ToToken = ERC20(toToken); if (toToken != NATIVE_TOKEN_ADDRESS) { _initialBalanceTokenOut = erc20ToToken.balanceOf(address(this)); } else { _initialBalanceTokenOut = address(this).balance; } if (fromToken != NATIVE_TOKEN_ADDRESS) { ERC20 token = ERC20(fromToken); token.safeTransferFrom(msg.sender, address(this), amount); token.safeApprove(zeroXExchangeProxy, amount); // solhint-disable-next-line (bool success, ) = zeroXExchangeProxy.call(swapCallData); if (!success) { revert SwapFailed(); } token.safeApprove(zeroXExchangeProxy, 0); } else { (bool success, ) = zeroXExchangeProxy.call{value: amount}( swapCallData ); if (!success) { revert SwapFailed(); } } if (toToken != NATIVE_TOKEN_ADDRESS) { _finalBalanceTokenOut = erc20ToToken.balanceOf(address(this)); } else { _finalBalanceTokenOut = address(this).balance; } uint256 returnAmount = _finalBalanceTokenOut - _initialBalanceTokenOut; emit SocketSwapTokens( fromToken, toToken, returnAmount, amount, ZeroXIdentifier, socketGateway ); return (returnAmount, toToken); } } // SPDX-License-Identifier: GPL-3.0-only pragma solidity ^0.8.4; import {OnlyOwner, OnlyNominee} from "../errors/SocketErrors.sol"; abstract contract Ownable { address private _owner; address private _nominee; event OwnerNominated(address indexed nominee); event OwnerClaimed(address indexed claimer); constructor(address owner_) { _claimOwner(owner_); } modifier onlyOwner() { if (msg.sender != _owner) { revert OnlyOwner(); } _; } function owner() public view returns (address) { return _owner; } function nominee() public view returns (address) { return _nominee; } function nominateOwner(address nominee_) external { if (msg.sender != _owner) { revert OnlyOwner(); } _nominee = nominee_; emit OwnerNominated(_nominee); } function claimOwner() external { if (msg.sender != _nominee) { revert OnlyNominee(); } _claimOwner(msg.sender); } function _claimOwner(address claimer_) internal { _owner = claimer_; _nominee = address(0); emit OwnerClaimed(claimer_); } }
File 2 of 5: TransparentUpgradeableProxy
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol) pragma solidity ^0.8.0; import "../utils/Context.sol"; /** * @dev Contract module which provides a basic access control mechanism, where * there is an account (an owner) that can be granted exclusive access to * specific functions. * * By default, the owner account will be the one that deploys the contract. This * can later be changed with {transferOwnership}. * * This module is used through inheritance. It will make available the modifier * `onlyOwner`, which can be applied to your functions to restrict their use to * the owner. */ abstract contract Ownable is Context { address private _owner; event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); /** * @dev Initializes the contract setting the deployer as the initial owner. */ constructor() { _transferOwnership(_msgSender()); } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { _checkOwner(); _; } /** * @dev Returns the address of the current owner. */ function owner() public view virtual returns (address) { return _owner; } /** * @dev Throws if the sender is not the owner. */ function _checkOwner() internal view virtual { require(owner() == _msgSender(), "Ownable: caller is not the owner"); } /** * @dev Leaves the contract without owner. It will not be possible to call * `onlyOwner` functions anymore. Can only be called by the current owner. * * NOTE: Renouncing ownership will leave the contract without an owner, * thereby removing any functionality that is only available to the owner. */ function renounceOwnership() public virtual onlyOwner { _transferOwnership(address(0)); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Can only be called by the current owner. */ function transferOwnership(address newOwner) public virtual onlyOwner { require(newOwner != address(0), "Ownable: new owner is the zero address"); _transferOwnership(newOwner); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Internal function without access restriction. */ function _transferOwnership(address newOwner) internal virtual { address oldOwner = _owner; _owner = newOwner; emit OwnershipTransferred(oldOwner, newOwner); } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.5.0) (interfaces/draft-IERC1822.sol) pragma solidity ^0.8.0; /** * @dev ERC1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified * proxy whose upgrades are fully controlled by the current implementation. */ interface IERC1822Proxiable { /** * @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation * address. * * IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks * bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this * function revert if invoked through a proxy. */ function proxiableUUID() external view returns (bytes32); } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.3) (interfaces/IERC1967.sol) pragma solidity ^0.8.0; /** * @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC. * * _Available since v4.9._ */ interface IERC1967 { /** * @dev Emitted when the implementation is upgraded. */ event Upgraded(address indexed implementation); /** * @dev Emitted when the admin account has changed. */ event AdminChanged(address previousAdmin, address newAdmin); /** * @dev Emitted when the beacon is changed. */ event BeaconUpgraded(address indexed beacon); } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (proxy/beacon/BeaconProxy.sol) pragma solidity ^0.8.0; import "./IBeacon.sol"; import "../Proxy.sol"; import "../ERC1967/ERC1967Upgrade.sol"; /** * @dev This contract implements a proxy that gets the implementation address for each call from an {UpgradeableBeacon}. * * The beacon address is stored in storage slot `uint256(keccak256('eip1967.proxy.beacon')) - 1`, so that it doesn't * conflict with the storage layout of the implementation behind the proxy. * * _Available since v3.4._ */ contract BeaconProxy is Proxy, ERC1967Upgrade { /** * @dev Initializes the proxy with `beacon`. * * If `data` is nonempty, it's used as data in a delegate call to the implementation returned by the beacon. This * will typically be an encoded function call, and allows initializing the storage of the proxy like a Solidity * constructor. * * Requirements: * * - `beacon` must be a contract with the interface {IBeacon}. */ constructor(address beacon, bytes memory data) payable { _upgradeBeaconToAndCall(beacon, data, false); } /** * @dev Returns the current beacon address. */ function _beacon() internal view virtual returns (address) { return _getBeacon(); } /** * @dev Returns the current implementation address of the associated beacon. */ function _implementation() internal view virtual override returns (address) { return IBeacon(_getBeacon()).implementation(); } /** * @dev Changes the proxy to use a new beacon. Deprecated: see {_upgradeBeaconToAndCall}. * * If `data` is nonempty, it's used as data in a delegate call to the implementation returned by the beacon. * * Requirements: * * - `beacon` must be a contract. * - The implementation returned by `beacon` must be a contract. */ function _setBeacon(address beacon, bytes memory data) internal virtual { _upgradeBeaconToAndCall(beacon, data, false); } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (proxy/beacon/IBeacon.sol) pragma solidity ^0.8.0; /** * @dev This is the interface that {BeaconProxy} expects of its beacon. */ interface IBeacon { /** * @dev Must return an address that can be used as a delegate call target. * * {BeaconProxy} will check that this address is a contract. */ function implementation() external view returns (address); } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (proxy/beacon/UpgradeableBeacon.sol) pragma solidity ^0.8.0; import "./IBeacon.sol"; import "../../access/Ownable.sol"; import "../../utils/Address.sol"; /** * @dev This contract is used in conjunction with one or more instances of {BeaconProxy} to determine their * implementation contract, which is where they will delegate all function calls. * * An owner is able to change the implementation the beacon points to, thus upgrading the proxies that use this beacon. */ contract UpgradeableBeacon is IBeacon, Ownable { address private _implementation; /** * @dev Emitted when the implementation returned by the beacon is changed. */ event Upgraded(address indexed implementation); /** * @dev Sets the address of the initial implementation, and the deployer account as the owner who can upgrade the * beacon. */ constructor(address implementation_) { _setImplementation(implementation_); } /** * @dev Returns the current implementation address. */ function implementation() public view virtual override returns (address) { return _implementation; } /** * @dev Upgrades the beacon to a new implementation. * * Emits an {Upgraded} event. * * Requirements: * * - msg.sender must be the owner of the contract. * - `newImplementation` must be a contract. */ function upgradeTo(address newImplementation) public virtual onlyOwner { _setImplementation(newImplementation); emit Upgraded(newImplementation); } /** * @dev Sets the implementation contract address for this beacon * * Requirements: * * - `newImplementation` must be a contract. */ function _setImplementation(address newImplementation) private { require(Address.isContract(newImplementation), "UpgradeableBeacon: implementation is not a contract"); _implementation = newImplementation; } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (proxy/ERC1967/ERC1967Proxy.sol) pragma solidity ^0.8.0; import "../Proxy.sol"; import "./ERC1967Upgrade.sol"; /** * @dev This contract implements an upgradeable proxy. It is upgradeable because calls are delegated to an * implementation address that can be changed. This address is stored in storage in the location specified by * https://eips.ethereum.org/EIPS/eip-1967[EIP1967], so that it doesn't conflict with the storage layout of the * implementation behind the proxy. */ contract ERC1967Proxy is Proxy, ERC1967Upgrade { /** * @dev Initializes the upgradeable proxy with an initial implementation specified by `_logic`. * * If `_data` is nonempty, it's used as data in a delegate call to `_logic`. This will typically be an encoded * function call, and allows initializing the storage of the proxy like a Solidity constructor. */ constructor(address _logic, bytes memory _data) payable { _upgradeToAndCall(_logic, _data, false); } /** * @dev Returns the current implementation address. */ function _implementation() internal view virtual override returns (address impl) { return ERC1967Upgrade._getImplementation(); } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.3) (proxy/ERC1967/ERC1967Upgrade.sol) pragma solidity ^0.8.2; import "../beacon/IBeacon.sol"; import "../../interfaces/IERC1967.sol"; import "../../interfaces/draft-IERC1822.sol"; import "../../utils/Address.sol"; import "../../utils/StorageSlot.sol"; /** * @dev This abstract contract provides getters and event emitting update functions for * https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots. * * _Available since v4.1._ * * @custom:oz-upgrades-unsafe-allow delegatecall */ abstract contract ERC1967Upgrade is IERC1967 { // This is the keccak-256 hash of "eip1967.proxy.rollback" subtracted by 1 bytes32 private constant _ROLLBACK_SLOT = 0x4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd9143; /** * @dev Storage slot with the address of the current implementation. * This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1, and is * validated in the constructor. */ bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc; /** * @dev Returns the current implementation address. */ function _getImplementation() internal view returns (address) { return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value; } /** * @dev Stores a new address in the EIP1967 implementation slot. */ function _setImplementation(address newImplementation) private { require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract"); StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation; } /** * @dev Perform implementation upgrade * * Emits an {Upgraded} event. */ function _upgradeTo(address newImplementation) internal { _setImplementation(newImplementation); emit Upgraded(newImplementation); } /** * @dev Perform implementation upgrade with additional setup call. * * Emits an {Upgraded} event. */ function _upgradeToAndCall( address newImplementation, bytes memory data, bool forceCall ) internal { _upgradeTo(newImplementation); if (data.length > 0 || forceCall) { Address.functionDelegateCall(newImplementation, data); } } /** * @dev Perform implementation upgrade with security checks for UUPS proxies, and additional setup call. * * Emits an {Upgraded} event. */ function _upgradeToAndCallUUPS( address newImplementation, bytes memory data, bool forceCall ) internal { // Upgrades from old implementations will perform a rollback test. This test requires the new // implementation to upgrade back to the old, non-ERC1822 compliant, implementation. Removing // this special case will break upgrade paths from old UUPS implementation to new ones. if (StorageSlot.getBooleanSlot(_ROLLBACK_SLOT).value) { _setImplementation(newImplementation); } else { try IERC1822Proxiable(newImplementation).proxiableUUID() returns (bytes32 slot) { require(slot == _IMPLEMENTATION_SLOT, "ERC1967Upgrade: unsupported proxiableUUID"); } catch { revert("ERC1967Upgrade: new implementation is not UUPS"); } _upgradeToAndCall(newImplementation, data, forceCall); } } /** * @dev Storage slot with the admin of the contract. * This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1, and is * validated in the constructor. */ bytes32 internal constant _ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103; /** * @dev Returns the current admin. */ function _getAdmin() internal view returns (address) { return StorageSlot.getAddressSlot(_ADMIN_SLOT).value; } /** * @dev Stores a new address in the EIP1967 admin slot. */ function _setAdmin(address newAdmin) private { require(newAdmin != address(0), "ERC1967: new admin is the zero address"); StorageSlot.getAddressSlot(_ADMIN_SLOT).value = newAdmin; } /** * @dev Changes the admin of the proxy. * * Emits an {AdminChanged} event. */ function _changeAdmin(address newAdmin) internal { emit AdminChanged(_getAdmin(), newAdmin); _setAdmin(newAdmin); } /** * @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy. * This is bytes32(uint256(keccak256('eip1967.proxy.beacon')) - 1)) and is validated in the constructor. */ bytes32 internal constant _BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50; /** * @dev Returns the current beacon. */ function _getBeacon() internal view returns (address) { return StorageSlot.getAddressSlot(_BEACON_SLOT).value; } /** * @dev Stores a new beacon in the EIP1967 beacon slot. */ function _setBeacon(address newBeacon) private { require(Address.isContract(newBeacon), "ERC1967: new beacon is not a contract"); require( Address.isContract(IBeacon(newBeacon).implementation()), "ERC1967: beacon implementation is not a contract" ); StorageSlot.getAddressSlot(_BEACON_SLOT).value = newBeacon; } /** * @dev Perform beacon upgrade with additional setup call. Note: This upgrades the address of the beacon, it does * not upgrade the implementation contained in the beacon (see {UpgradeableBeacon-_setImplementation} for that). * * Emits a {BeaconUpgraded} event. */ function _upgradeBeaconToAndCall( address newBeacon, bytes memory data, bool forceCall ) internal { _setBeacon(newBeacon); emit BeaconUpgraded(newBeacon); if (data.length > 0 || forceCall) { Address.functionDelegateCall(IBeacon(newBeacon).implementation(), data); } } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.6.0) (proxy/Proxy.sol) pragma solidity ^0.8.0; /** * @dev This abstract contract provides a fallback function that delegates all calls to another contract using the EVM * instruction `delegatecall`. We refer to the second contract as the _implementation_ behind the proxy, and it has to * be specified by overriding the virtual {_implementation} function. * * Additionally, delegation to the implementation can be triggered manually through the {_fallback} function, or to a * different contract through the {_delegate} function. * * The success and return data of the delegated call will be returned back to the caller of the proxy. */ abstract contract Proxy { /** * @dev Delegates the current call to `implementation`. * * This function does not return to its internal call site, it will return directly to the external caller. */ function _delegate(address implementation) internal virtual { assembly { // Copy msg.data. We take full control of memory in this inline assembly // block because it will not return to Solidity code. We overwrite the // Solidity scratch pad at memory position 0. calldatacopy(0, 0, calldatasize()) // Call the implementation. // out and outsize are 0 because we don't know the size yet. let result := delegatecall(gas(), implementation, 0, calldatasize(), 0, 0) // Copy the returned data. returndatacopy(0, 0, returndatasize()) switch result // delegatecall returns 0 on error. case 0 { revert(0, returndatasize()) } default { return(0, returndatasize()) } } } /** * @dev This is a virtual function that should be overridden so it returns the address to which the fallback function * and {_fallback} should delegate. */ function _implementation() internal view virtual returns (address); /** * @dev Delegates the current call to the address returned by `_implementation()`. * * This function does not return to its internal call site, it will return directly to the external caller. */ function _fallback() internal virtual { _beforeFallback(); _delegate(_implementation()); } /** * @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if no other * function in the contract matches the call data. */ fallback() external payable virtual { _fallback(); } /** * @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if call data * is empty. */ receive() external payable virtual { _fallback(); } /** * @dev Hook that is called before falling back to the implementation. Can happen as part of a manual `_fallback` * call, or as part of the Solidity `fallback` or `receive` functions. * * If overridden should call `super._beforeFallback()`. */ function _beforeFallback() internal virtual {} } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.3) (proxy/transparent/ProxyAdmin.sol) pragma solidity ^0.8.0; import "./TransparentUpgradeableProxy.sol"; import "../../access/Ownable.sol"; /** * @dev This is an auxiliary contract meant to be assigned as the admin of a {TransparentUpgradeableProxy}. For an * explanation of why you would want to use this see the documentation for {TransparentUpgradeableProxy}. */ contract ProxyAdmin is Ownable { /** * @dev Returns the current implementation of `proxy`. * * Requirements: * * - This contract must be the admin of `proxy`. */ function getProxyImplementation(ITransparentUpgradeableProxy proxy) public view virtual returns (address) { // We need to manually run the static call since the getter cannot be flagged as view // bytes4(keccak256("implementation()")) == 0x5c60da1b (bool success, bytes memory returndata) = address(proxy).staticcall(hex"5c60da1b"); require(success); return abi.decode(returndata, (address)); } /** * @dev Returns the current admin of `proxy`. * * Requirements: * * - This contract must be the admin of `proxy`. */ function getProxyAdmin(ITransparentUpgradeableProxy proxy) public view virtual returns (address) { // We need to manually run the static call since the getter cannot be flagged as view // bytes4(keccak256("admin()")) == 0xf851a440 (bool success, bytes memory returndata) = address(proxy).staticcall(hex"f851a440"); require(success); return abi.decode(returndata, (address)); } /** * @dev Changes the admin of `proxy` to `newAdmin`. * * Requirements: * * - This contract must be the current admin of `proxy`. */ function changeProxyAdmin(ITransparentUpgradeableProxy proxy, address newAdmin) public virtual onlyOwner { proxy.changeAdmin(newAdmin); } /** * @dev Upgrades `proxy` to `implementation`. See {TransparentUpgradeableProxy-upgradeTo}. * * Requirements: * * - This contract must be the admin of `proxy`. */ function upgrade(ITransparentUpgradeableProxy proxy, address implementation) public virtual onlyOwner { proxy.upgradeTo(implementation); } /** * @dev Upgrades `proxy` to `implementation` and calls a function on the new implementation. See * {TransparentUpgradeableProxy-upgradeToAndCall}. * * Requirements: * * - This contract must be the admin of `proxy`. */ function upgradeAndCall( ITransparentUpgradeableProxy proxy, address implementation, bytes memory data ) public payable virtual onlyOwner { proxy.upgradeToAndCall{value: msg.value}(implementation, data); } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.3) (proxy/transparent/TransparentUpgradeableProxy.sol) pragma solidity ^0.8.0; import "../ERC1967/ERC1967Proxy.sol"; /** * @dev Interface for {TransparentUpgradeableProxy}. In order to implement transparency, {TransparentUpgradeableProxy} * does not implement this interface directly, and some of its functions are implemented by an internal dispatch * mechanism. The compiler is unaware that these functions are implemented by {TransparentUpgradeableProxy} and will not * include them in the ABI so this interface must be used to interact with it. */ interface ITransparentUpgradeableProxy is IERC1967 { function admin() external view returns (address); function implementation() external view returns (address); function changeAdmin(address) external; function upgradeTo(address) external; function upgradeToAndCall(address, bytes memory) external payable; } /** * @dev This contract implements a proxy that is upgradeable by an admin. * * To avoid https://medium.com/nomic-labs-blog/malicious-backdoors-in-ethereum-proxies-62629adf3357[proxy selector * clashing], which can potentially be used in an attack, this contract uses the * https://blog.openzeppelin.com/the-transparent-proxy-pattern/[transparent proxy pattern]. This pattern implies two * things that go hand in hand: * * 1. If any account other than the admin calls the proxy, the call will be forwarded to the implementation, even if * that call matches one of the admin functions exposed by the proxy itself. * 2. If the admin calls the proxy, it can access the admin functions, but its calls will never be forwarded to the * implementation. If the admin tries to call a function on the implementation it will fail with an error that says * "admin cannot fallback to proxy target". * * These properties mean that the admin account can only be used for admin actions like upgrading the proxy or changing * the admin, so it's best if it's a dedicated account that is not used for anything else. This will avoid headaches due * to sudden errors when trying to call a function from the proxy implementation. * * Our recommendation is for the dedicated account to be an instance of the {ProxyAdmin} contract. If set up this way, * you should think of the `ProxyAdmin` instance as the real administrative interface of your proxy. * * NOTE: The real interface of this proxy is that defined in `ITransparentUpgradeableProxy`. This contract does not * inherit from that interface, and instead the admin functions are implicitly implemented using a custom dispatch * mechanism in `_fallback`. Consequently, the compiler will not produce an ABI for this contract. This is necessary to * fully implement transparency without decoding reverts caused by selector clashes between the proxy and the * implementation. * * WARNING: It is not recommended to extend this contract to add additional external functions. If you do so, the compiler * will not check that there are no selector conflicts, due to the note above. A selector clash between any new function * and the functions declared in {ITransparentUpgradeableProxy} will be resolved in favor of the new one. This could * render the admin operations inaccessible, which could prevent upgradeability. Transparency may also be compromised. */ contract TransparentUpgradeableProxy is ERC1967Proxy { /** * @dev Initializes an upgradeable proxy managed by `_admin`, backed by the implementation at `_logic`, and * optionally initialized with `_data` as explained in {ERC1967Proxy-constructor}. */ constructor( address _logic, address admin_, bytes memory _data ) payable ERC1967Proxy(_logic, _data) { _changeAdmin(admin_); } /** * @dev Modifier used internally that will delegate the call to the implementation unless the sender is the admin. * * CAUTION: This modifier is deprecated, as it could cause issues if the modified function has arguments, and the * implementation provides a function with the same selector. */ modifier ifAdmin() { if (msg.sender == _getAdmin()) { _; } else { _fallback(); } } /** * @dev If caller is the admin process the call internally, otherwise transparently fallback to the proxy behavior */ function _fallback() internal virtual override { if (msg.sender == _getAdmin()) { bytes memory ret; bytes4 selector = msg.sig; if (selector == ITransparentUpgradeableProxy.upgradeTo.selector) { ret = _dispatchUpgradeTo(); } else if (selector == ITransparentUpgradeableProxy.upgradeToAndCall.selector) { ret = _dispatchUpgradeToAndCall(); } else if (selector == ITransparentUpgradeableProxy.changeAdmin.selector) { ret = _dispatchChangeAdmin(); } else if (selector == ITransparentUpgradeableProxy.admin.selector) { ret = _dispatchAdmin(); } else if (selector == ITransparentUpgradeableProxy.implementation.selector) { ret = _dispatchImplementation(); } else { revert("TransparentUpgradeableProxy: admin cannot fallback to proxy target"); } assembly { return(add(ret, 0x20), mload(ret)) } } else { super._fallback(); } } /** * @dev Returns the current admin. * * TIP: To get this value clients can read directly from the storage slot shown below (specified by EIP1967) using the * https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call. * `0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103` */ function _dispatchAdmin() private returns (bytes memory) { _requireZeroValue(); address admin = _getAdmin(); return abi.encode(admin); } /** * @dev Returns the current implementation. * * TIP: To get this value clients can read directly from the storage slot shown below (specified by EIP1967) using the * https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call. * `0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc` */ function _dispatchImplementation() private returns (bytes memory) { _requireZeroValue(); address implementation = _implementation(); return abi.encode(implementation); } /** * @dev Changes the admin of the proxy. * * Emits an {AdminChanged} event. */ function _dispatchChangeAdmin() private returns (bytes memory) { _requireZeroValue(); address newAdmin = abi.decode(msg.data[4:], (address)); _changeAdmin(newAdmin); return ""; } /** * @dev Upgrade the implementation of the proxy. */ function _dispatchUpgradeTo() private returns (bytes memory) { _requireZeroValue(); address newImplementation = abi.decode(msg.data[4:], (address)); _upgradeToAndCall(newImplementation, bytes(""), false); return ""; } /** * @dev Upgrade the implementation of the proxy, and then call a function from the new implementation as specified * by `data`, which should be an encoded function call. This is useful to initialize new storage variables in the * proxied contract. */ function _dispatchUpgradeToAndCall() private returns (bytes memory) { (address newImplementation, bytes memory data) = abi.decode(msg.data[4:], (address, bytes)); _upgradeToAndCall(newImplementation, data, true); return ""; } /** * @dev Returns the current admin. */ function _admin() internal view virtual returns (address) { return _getAdmin(); } /** * @dev To keep this contract fully transparent, all `ifAdmin` functions must be payable. This helper is here to * emulate some proxy functions being non-payable while still allowing value to pass through. */ function _requireZeroValue() private { require(msg.value == 0); } } // 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 // OpenZeppelin Contracts v4.4.1 (utils/Context.sol) pragma solidity ^0.8.0; /** * @dev Provides information about the current execution context, including the * sender of the transaction and its data. While these are generally available * via msg.sender and msg.data, they should not be accessed in such a direct * manner, since when dealing with meta-transactions the account sending and * paying for execution may not be the actual sender (as far as an application * is concerned). * * This contract is only required for intermediate, library-like contracts. */ abstract contract Context { function _msgSender() internal view virtual returns (address) { return msg.sender; } function _msgData() internal view virtual returns (bytes calldata) { return msg.data; } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (utils/StorageSlot.sol) pragma solidity ^0.8.0; /** * @dev Library for reading and writing primitive types to specific storage slots. * * Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts. * This library helps with reading and writing to such slots without the need for inline assembly. * * The functions in this library return Slot structs that contain a `value` member that can be used to read or write. * * Example usage to set ERC1967 implementation slot: * ``` * contract ERC1967 { * bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc; * * function _getImplementation() internal view returns (address) { * return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value; * } * * function _setImplementation(address newImplementation) internal { * require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract"); * StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation; * } * } * ``` * * _Available since v4.1 for `address`, `bool`, `bytes32`, and `uint256`._ */ library StorageSlot { struct AddressSlot { address value; } struct BooleanSlot { bool value; } struct Bytes32Slot { bytes32 value; } struct Uint256Slot { uint256 value; } /** * @dev Returns an `AddressSlot` with member `value` located at `slot`. */ function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) { /// @solidity memory-safe-assembly assembly { r.slot := slot } } /** * @dev Returns an `BooleanSlot` with member `value` located at `slot`. */ function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) { /// @solidity memory-safe-assembly assembly { r.slot := slot } } /** * @dev Returns an `Bytes32Slot` with member `value` located at `slot`. */ function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) { /// @solidity memory-safe-assembly assembly { r.slot := slot } } /** * @dev Returns an `Uint256Slot` with member `value` located at `slot`. */ function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) { /// @solidity memory-safe-assembly assembly { r.slot := slot } } }
File 3 of 5: L1_ETH_Bridge
// SPDX-License-Identifier: MIT pragma solidity 0.6.12; pragma experimental ABIEncoderV2; import "./L1_Bridge.sol"; /** * @dev A L1_Bridge that uses an ETH as the canonical token */ contract L1_ETH_Bridge is L1_Bridge { constructor (address[] memory bonders, address _governance) public L1_Bridge(bonders, _governance) {} /* ========== Override Functions ========== */ function _transferFromBridge(address recipient, uint256 amount) internal override { (bool success, ) = recipient.call{value: amount}(new bytes(0)); require(success, 'L1_ETH_BRG: ETH transfer failed'); } function _transferToBridge(address /*from*/, uint256 amount) internal override { require(msg.value == amount, "L1_ETH_BRG: Value does not match amount"); } } // SPDX-License-Identifier: MIT pragma solidity 0.6.12; pragma experimental ABIEncoderV2; import "./Bridge.sol"; import "../interfaces/IMessengerWrapper.sol"; /** * @dev L1_Bridge is responsible for the bonding and challenging of TransferRoots. All TransferRoots * originate in the L1_Bridge through `bondTransferRoot` and are propagated up to destination L2s. */ abstract contract L1_Bridge is Bridge { struct TransferBond { address bonder; uint256 createdAt; uint256 totalAmount; uint256 challengeStartTime; address challenger; bool challengeResolved; } /* ========== State ========== */ mapping(uint256 => mapping(bytes32 => uint256)) public transferRootCommittedAt; mapping(bytes32 => TransferBond) public transferBonds; mapping(uint256 => mapping(address => uint256)) public timeSlotToAmountBonded; mapping(uint256 => uint256) public chainBalance; /* ========== Config State ========== */ address public governance; mapping(uint256 => IMessengerWrapper) public crossDomainMessengerWrappers; mapping(uint256 => bool) public isChainIdPaused; uint256 public challengePeriod = 1 days; uint256 public challengeResolutionPeriod = 10 days; uint256 public minTransferRootBondDelay = 15 minutes; uint256 public constant CHALLENGE_AMOUNT_DIVISOR = 10; uint256 public constant TIME_SLOT_SIZE = 4 hours; /* ========== Events ========== */ event TransferSentToL2( uint256 indexed chainId, address indexed recipient, uint256 amount, uint256 amountOutMin, uint256 deadline, address indexed relayer, uint256 relayerFee ); event TransferRootBonded ( bytes32 indexed root, uint256 amount ); event TransferRootConfirmed( uint256 indexed originChainId, uint256 indexed destinationChainId, bytes32 indexed rootHash, uint256 totalAmount ); event TransferBondChallenged( bytes32 indexed transferRootId, bytes32 indexed rootHash, uint256 originalAmount ); event ChallengeResolved( bytes32 indexed transferRootId, bytes32 indexed rootHash, uint256 originalAmount ); /* ========== Modifiers ========== */ modifier onlyL2Bridge(uint256 chainId) { IMessengerWrapper messengerWrapper = crossDomainMessengerWrappers[chainId]; messengerWrapper.verifySender(msg.sender, msg.data); _; } constructor (address[] memory bonders, address _governance) public Bridge(bonders) { governance = _governance; } /* ========== Send Functions ========== */ /** * @notice `amountOutMin` and `deadline` should be 0 when no swap is intended at the destination. * @notice `amount` is the total amount the user wants to send including the relayer fee * @dev Send tokens to a supported layer-2 to mint hToken and optionally swap the hToken in the * AMM at the destination. * @param chainId The chainId of the destination chain * @param recipient The address receiving funds at the destination * @param amount The amount being sent * @param amountOutMin The minimum amount received after attempting to swap in the destination * AMM market. 0 if no swap is intended. * @param deadline The deadline for swapping in the destination AMM market. 0 if no * swap is intended. * @param relayer The address of the relayer at the destination. * @param relayerFee The amount distributed to the relayer at the destination. This is subtracted from the `amount`. */ function sendToL2( uint256 chainId, address recipient, uint256 amount, uint256 amountOutMin, uint256 deadline, address relayer, uint256 relayerFee ) external payable { IMessengerWrapper messengerWrapper = crossDomainMessengerWrappers[chainId]; require(messengerWrapper != IMessengerWrapper(0), "L1_BRG: chainId not supported"); require(isChainIdPaused[chainId] == false, "L1_BRG: Sends to this chainId are paused"); require(amount > 0, "L1_BRG: Must transfer a non-zero amount"); require(amount >= relayerFee, "L1_BRG: Relayer fee cannot exceed amount"); _transferToBridge(msg.sender, amount); bytes memory message = abi.encodeWithSignature( "distribute(address,uint256,uint256,uint256,address,uint256)", recipient, amount, amountOutMin, deadline, relayer, relayerFee ); chainBalance[chainId] = chainBalance[chainId].add(amount); messengerWrapper.sendCrossDomainMessage(message); emit TransferSentToL2( chainId, recipient, amount, amountOutMin, deadline, relayer, relayerFee ); } /* ========== TransferRoot Functions ========== */ /** * @dev Setting a TransferRoot is a two step process. * @dev 1. The TransferRoot is bonded with `bondTransferRoot`. Withdrawals can now begin on L1 * @dev and recipient L2's * @dev 2. The TransferRoot is confirmed after `confirmTransferRoot` is called by the l2 bridge * @dev where the TransferRoot originated. */ /** * @dev Used by the Bonder to bond a TransferRoot and propagate it up to destination L2s * @param rootHash The Merkle root of the TransferRoot Merkle tree * @param destinationChainId The id of the destination chain * @param totalAmount The amount destined for the destination chain */ function bondTransferRoot( bytes32 rootHash, uint256 destinationChainId, uint256 totalAmount ) external onlyBonder requirePositiveBalance { bytes32 transferRootId = getTransferRootId(rootHash, totalAmount); require(transferRootCommittedAt[destinationChainId][transferRootId] == 0, "L1_BRG: TransferRoot has already been confirmed"); require(transferBonds[transferRootId].createdAt == 0, "L1_BRG: TransferRoot has already been bonded"); uint256 currentTimeSlot = getTimeSlot(block.timestamp); uint256 bondAmount = getBondForTransferAmount(totalAmount); timeSlotToAmountBonded[currentTimeSlot][msg.sender] = timeSlotToAmountBonded[currentTimeSlot][msg.sender].add(bondAmount); transferBonds[transferRootId] = TransferBond( msg.sender, block.timestamp, totalAmount, uint256(0), address(0), false ); _distributeTransferRoot(rootHash, destinationChainId, totalAmount); emit TransferRootBonded(rootHash, totalAmount); } /** * @dev Used by an L2 bridge to confirm a TransferRoot via cross-domain message. Once a TransferRoot * has been confirmed, any challenge against that TransferRoot can be resolved as unsuccessful. * @param originChainId The id of the origin chain * @param rootHash The Merkle root of the TransferRoot Merkle tree * @param destinationChainId The id of the destination chain * @param totalAmount The amount destined for each destination chain * @param rootCommittedAt The block timestamp when the TransferRoot was committed on its origin chain */ function confirmTransferRoot( uint256 originChainId, bytes32 rootHash, uint256 destinationChainId, uint256 totalAmount, uint256 rootCommittedAt ) external onlyL2Bridge(originChainId) { bytes32 transferRootId = getTransferRootId(rootHash, totalAmount); require(transferRootCommittedAt[destinationChainId][transferRootId] == 0, "L1_BRG: TransferRoot already confirmed"); require(rootCommittedAt > 0, "L1_BRG: rootCommittedAt must be greater than 0"); transferRootCommittedAt[destinationChainId][transferRootId] = rootCommittedAt; chainBalance[originChainId] = chainBalance[originChainId].sub(totalAmount, "L1_BRG: Amount exceeds chainBalance. This indicates a layer-2 failure."); // If the TransferRoot was never bonded, distribute the TransferRoot. TransferBond storage transferBond = transferBonds[transferRootId]; if (transferBond.createdAt == 0) { _distributeTransferRoot(rootHash, destinationChainId, totalAmount); } emit TransferRootConfirmed(originChainId, destinationChainId, rootHash, totalAmount); } function _distributeTransferRoot( bytes32 rootHash, uint256 chainId, uint256 totalAmount ) internal { // Set TransferRoot on recipient Bridge if (chainId == getChainId()) { // Set L1 TransferRoot _setTransferRoot(rootHash, totalAmount); } else { chainBalance[chainId] = chainBalance[chainId].add(totalAmount); IMessengerWrapper messengerWrapper = crossDomainMessengerWrappers[chainId]; require(messengerWrapper != IMessengerWrapper(0), "L1_BRG: chainId not supported"); // Set L2 TransferRoot bytes memory setTransferRootMessage = abi.encodeWithSignature( "setTransferRoot(bytes32,uint256)", rootHash, totalAmount ); messengerWrapper.sendCrossDomainMessage(setTransferRootMessage); } } /* ========== External TransferRoot Challenges ========== */ /** * @dev Challenge a TransferRoot believed to be fraudulent * @param rootHash The Merkle root of the TransferRoot Merkle tree * @param originalAmount The total amount bonded for this TransferRoot * @param destinationChainId The id of the destination chain */ function challengeTransferBond(bytes32 rootHash, uint256 originalAmount, uint256 destinationChainId) external payable { bytes32 transferRootId = getTransferRootId(rootHash, originalAmount); TransferBond storage transferBond = transferBonds[transferRootId]; require(transferRootCommittedAt[destinationChainId][transferRootId] == 0, "L1_BRG: TransferRoot has already been confirmed"); require(transferBond.createdAt != 0, "L1_BRG: TransferRoot has not been bonded"); uint256 challengePeriodEnd = transferBond.createdAt.add(challengePeriod); require(challengePeriodEnd >= block.timestamp, "L1_BRG: TransferRoot cannot be challenged after challenge period"); require(transferBond.challengeStartTime == 0, "L1_BRG: TransferRoot already challenged"); transferBond.challengeStartTime = block.timestamp; transferBond.challenger = msg.sender; // Move amount from timeSlotToAmountBonded to debit uint256 timeSlot = getTimeSlot(transferBond.createdAt); uint256 bondAmount = getBondForTransferAmount(originalAmount); address bonder = transferBond.bonder; timeSlotToAmountBonded[timeSlot][bonder] = timeSlotToAmountBonded[timeSlot][bonder].sub(bondAmount); _addDebit(transferBond.bonder, bondAmount); // Get stake for challenge uint256 challengeStakeAmount = getChallengeAmountForTransferAmount(originalAmount); _transferToBridge(msg.sender, challengeStakeAmount); emit TransferBondChallenged(transferRootId, rootHash, originalAmount); } /** * @dev Resolve a challenge after the `challengeResolutionPeriod` has passed * @param rootHash The Merkle root of the TransferRoot Merkle tree * @param originalAmount The total amount originally bonded for this TransferRoot * @param destinationChainId The id of the destination chain */ function resolveChallenge(bytes32 rootHash, uint256 originalAmount, uint256 destinationChainId) external { bytes32 transferRootId = getTransferRootId(rootHash, originalAmount); TransferBond storage transferBond = transferBonds[transferRootId]; require(transferBond.challengeStartTime != 0, "L1_BRG: TransferRoot has not been challenged"); require(block.timestamp > transferBond.challengeStartTime.add(challengeResolutionPeriod), "L1_BRG: Challenge period has not ended"); require(transferBond.challengeResolved == false, "L1_BRG: TransferRoot already resolved"); transferBond.challengeResolved = true; uint256 challengeStakeAmount = getChallengeAmountForTransferAmount(originalAmount); if (transferRootCommittedAt[destinationChainId][transferRootId] > 0) { // Invalid challenge if (transferBond.createdAt > transferRootCommittedAt[destinationChainId][transferRootId].add(minTransferRootBondDelay)) { // Credit the bonder back with the bond amount plus the challenger's stake _addCredit(transferBond.bonder, getBondForTransferAmount(originalAmount).add(challengeStakeAmount)); } else { // If the TransferRoot was bonded before it was committed, the challenger and Bonder // get their stake back. This discourages Bonders from tricking challengers into // challenging a valid TransferRoots that haven't yet been committed. It also ensures // that Bonders are not punished if a TransferRoot is bonded too soon in error. // Return the challenger's stake _addCredit(transferBond.challenger, challengeStakeAmount); // Credit the bonder back with the bond amount _addCredit(transferBond.bonder, getBondForTransferAmount(originalAmount)); } } else { // Valid challenge // Burn 25% of the challengers stake _transferFromBridge(address(0xdead), challengeStakeAmount.mul(1).div(4)); // Reward challenger with the remaining 75% of their stake plus 100% of the Bonder's stake _addCredit(transferBond.challenger, challengeStakeAmount.mul(7).div(4)); } emit ChallengeResolved(transferRootId, rootHash, originalAmount); } /* ========== Override Functions ========== */ function _additionalDebit(address bonder) internal view override returns (uint256) { uint256 currentTimeSlot = getTimeSlot(block.timestamp); uint256 bonded = 0; uint256 numTimeSlots = challengePeriod / TIME_SLOT_SIZE; for (uint256 i = 0; i < numTimeSlots; i++) { bonded = bonded.add(timeSlotToAmountBonded[currentTimeSlot - i][bonder]); } return bonded; } function _requireIsGovernance() internal override { require(governance == msg.sender, "L1_BRG: Caller is not the owner"); } /* ========== External Config Management Setters ========== */ function setGovernance(address _newGovernance) external onlyGovernance { require(_newGovernance != address(0), "L1_BRG: _newGovernance cannot be address(0)"); governance = _newGovernance; } function setCrossDomainMessengerWrapper(uint256 chainId, IMessengerWrapper _crossDomainMessengerWrapper) external onlyGovernance { crossDomainMessengerWrappers[chainId] = _crossDomainMessengerWrapper; } function setChainIdDepositsPaused(uint256 chainId, bool isPaused) external onlyGovernance { isChainIdPaused[chainId] = isPaused; } function setChallengePeriod(uint256 _challengePeriod) external onlyGovernance { require(_challengePeriod % TIME_SLOT_SIZE == 0, "L1_BRG: challengePeriod must be divisible by TIME_SLOT_SIZE"); challengePeriod = _challengePeriod; } function setChallengeResolutionPeriod(uint256 _challengeResolutionPeriod) external onlyGovernance { challengeResolutionPeriod = _challengeResolutionPeriod; } function setMinTransferRootBondDelay(uint256 _minTransferRootBondDelay) external onlyGovernance { minTransferRootBondDelay = _minTransferRootBondDelay; } /* ========== Public Getters ========== */ function getBondForTransferAmount(uint256 amount) public pure returns (uint256) { // Bond covers amount plus a bounty to pay a potential challenger return amount.add(getChallengeAmountForTransferAmount(amount)); } function getChallengeAmountForTransferAmount(uint256 amount) public pure returns (uint256) { // Bond covers amount plus a bounty to pay a potential challenger return amount.div(CHALLENGE_AMOUNT_DIVISOR); } function getTimeSlot(uint256 time) public pure returns (uint256) { return time / TIME_SLOT_SIZE; } } // SPDX-License-Identifier: MIT pragma solidity 0.6.12; pragma experimental ABIEncoderV2; import "./Accounting.sol"; import "../libraries/Lib_MerkleTree.sol"; /** * @dev Bridge extends the accounting system and encapsulates the logic that is shared by both the * L1 and L2 Bridges. It allows to TransferRoots to be set by parent contracts and for those * TransferRoots to be withdrawn against. It also allows the bonder to bond and withdraw Transfers * directly through `bondWithdrawal` and then settle those bonds against their TransferRoot once it * has been set. */ abstract contract Bridge is Accounting { using Lib_MerkleTree for bytes32; struct TransferRoot { uint256 total; uint256 amountWithdrawn; uint256 createdAt; } /* ========== Events ========== */ event Withdrew( bytes32 indexed transferId, address indexed recipient, uint256 amount, bytes32 transferNonce ); event WithdrawalBonded( bytes32 indexed transferId, uint256 amount ); event WithdrawalBondSettled( address indexed bonder, bytes32 indexed transferId, bytes32 indexed rootHash ); event MultipleWithdrawalsSettled( address indexed bonder, bytes32 indexed rootHash, uint256 totalBondsSettled ); event TransferRootSet( bytes32 indexed rootHash, uint256 totalAmount ); /* ========== State ========== */ mapping(bytes32 => TransferRoot) private _transferRoots; mapping(bytes32 => bool) private _spentTransferIds; mapping(address => mapping(bytes32 => uint256)) private _bondedWithdrawalAmounts; uint256 constant RESCUE_DELAY = 8 weeks; constructor(address[] memory bonders) public Accounting(bonders) {} /* ========== Public Getters ========== */ /** * @dev Get the hash that represents an individual Transfer. * @param chainId The id of the destination chain * @param recipient The address receiving the Transfer * @param amount The amount being transferred including the `_bonderFee` * @param transferNonce Used to avoid transferId collisions * @param bonderFee The amount paid to the address that withdraws the Transfer * @param amountOutMin The minimum amount received after attempting to swap in the destination * AMM market. 0 if no swap is intended. * @param deadline The deadline for swapping in the destination AMM market. 0 if no * swap is intended. */ function getTransferId( uint256 chainId, address recipient, uint256 amount, bytes32 transferNonce, uint256 bonderFee, uint256 amountOutMin, uint256 deadline ) public pure returns (bytes32) { return keccak256(abi.encode( chainId, recipient, amount, transferNonce, bonderFee, amountOutMin, deadline )); } /** * @notice getChainId can be overridden by subclasses if needed for compatibility or testing purposes. * @dev Get the current chainId * @return chainId The current chainId */ function getChainId() public virtual view returns (uint256 chainId) { this; // Silence state mutability warning without generating any additional byte code assembly { chainId := chainid() } } /** * @dev Get the TransferRoot id for a given rootHash and totalAmount * @param rootHash The Merkle root of the TransferRoot * @param totalAmount The total of all Transfers in the TransferRoot * @return The calculated transferRootId */ function getTransferRootId(bytes32 rootHash, uint256 totalAmount) public pure returns (bytes32) { return keccak256(abi.encodePacked(rootHash, totalAmount)); } /** * @dev Get the TransferRoot for a given rootHash and totalAmount * @param rootHash The Merkle root of the TransferRoot * @param totalAmount The total of all Transfers in the TransferRoot * @return The TransferRoot with the calculated transferRootId */ function getTransferRoot(bytes32 rootHash, uint256 totalAmount) public view returns (TransferRoot memory) { return _transferRoots[getTransferRootId(rootHash, totalAmount)]; } /** * @dev Get the amount bonded for the withdrawal of a transfer * @param bonder The Bonder of the withdrawal * @param transferId The Transfer's unique identifier * @return The amount bonded for a Transfer withdrawal */ function getBondedWithdrawalAmount(address bonder, bytes32 transferId) external view returns (uint256) { return _bondedWithdrawalAmounts[bonder][transferId]; } /** * @dev Get the spent status of a transfer ID * @param transferId The transfer's unique identifier * @return True if the transferId has been spent */ function isTransferIdSpent(bytes32 transferId) external view returns (bool) { return _spentTransferIds[transferId]; } /* ========== User/Relayer External Functions ========== */ /** * @notice Can be called by anyone (recipient or relayer) * @dev Withdraw a Transfer from its destination bridge * @param recipient The address receiving the Transfer * @param amount The amount being transferred including the `_bonderFee` * @param transferNonce Used to avoid transferId collisions * @param bonderFee The amount paid to the address that withdraws the Transfer * @param amountOutMin The minimum amount received after attempting to swap in the destination * AMM market. 0 if no swap is intended. (only used to calculate `transferId` in this function) * @param deadline The deadline for swapping in the destination AMM market. 0 if no * swap is intended. (only used to calculate `transferId` in this function) * @param rootHash The Merkle root of the TransferRoot * @param transferRootTotalAmount The total amount being transferred in a TransferRoot * @param transferIdTreeIndex The index of the transferId in the Merkle tree * @param siblings The siblings of the transferId in the Merkle tree * @param totalLeaves The total number of leaves in the Merkle tree */ function withdraw( address recipient, uint256 amount, bytes32 transferNonce, uint256 bonderFee, uint256 amountOutMin, uint256 deadline, bytes32 rootHash, uint256 transferRootTotalAmount, uint256 transferIdTreeIndex, bytes32[] calldata siblings, uint256 totalLeaves ) external nonReentrant { bytes32 transferId = getTransferId( getChainId(), recipient, amount, transferNonce, bonderFee, amountOutMin, deadline ); require( rootHash.verify( transferId, transferIdTreeIndex, siblings, totalLeaves ) , "BRG: Invalid transfer proof"); bytes32 transferRootId = getTransferRootId(rootHash, transferRootTotalAmount); _addToAmountWithdrawn(transferRootId, amount); _fulfillWithdraw(transferId, recipient, amount, uint256(0)); emit Withdrew(transferId, recipient, amount, transferNonce); } /** * @dev Allows the bonder to bond individual withdrawals before their TransferRoot has been committed. * @param recipient The address receiving the Transfer * @param amount The amount being transferred including the `_bonderFee` * @param transferNonce Used to avoid transferId collisions * @param bonderFee The amount paid to the address that withdraws the Transfer */ function bondWithdrawal( address recipient, uint256 amount, bytes32 transferNonce, uint256 bonderFee ) external onlyBonder requirePositiveBalance nonReentrant { bytes32 transferId = getTransferId( getChainId(), recipient, amount, transferNonce, bonderFee, 0, 0 ); _bondWithdrawal(transferId, amount); _fulfillWithdraw(transferId, recipient, amount, bonderFee); } /** * @dev Refunds the Bonder's stake from a bonded withdrawal and counts that withdrawal against * its TransferRoot. * @param bonder The Bonder of the withdrawal * @param transferId The Transfer's unique identifier * @param rootHash The Merkle root of the TransferRoot * @param transferRootTotalAmount The total amount being transferred in a TransferRoot * @param transferIdTreeIndex The index of the transferId in the Merkle tree * @param siblings The siblings of the transferId in the Merkle tree * @param totalLeaves The total number of leaves in the Merkle tree */ function settleBondedWithdrawal( address bonder, bytes32 transferId, bytes32 rootHash, uint256 transferRootTotalAmount, uint256 transferIdTreeIndex, bytes32[] calldata siblings, uint256 totalLeaves ) external { require( rootHash.verify( transferId, transferIdTreeIndex, siblings, totalLeaves ) , "BRG: Invalid transfer proof"); bytes32 transferRootId = getTransferRootId(rootHash, transferRootTotalAmount); uint256 amount = _bondedWithdrawalAmounts[bonder][transferId]; require(amount > 0, "L2_BRG: transferId has no bond"); _bondedWithdrawalAmounts[bonder][transferId] = 0; _addToAmountWithdrawn(transferRootId, amount); _addCredit(bonder, amount); emit WithdrawalBondSettled(bonder, transferId, rootHash); } /** * @dev Refunds the Bonder for all withdrawals that they bonded in a TransferRoot. * @param bonder The address of the Bonder being refunded * @param transferIds All transferIds in the TransferRoot in order * @param totalAmount The totalAmount of the TransferRoot */ function settleBondedWithdrawals( address bonder, // transferIds _must_ be calldata or it will be mutated by Lib_MerkleTree.getMerkleRoot bytes32[] calldata transferIds, uint256 totalAmount ) external { bytes32 rootHash = Lib_MerkleTree.getMerkleRoot(transferIds); bytes32 transferRootId = getTransferRootId(rootHash, totalAmount); uint256 totalBondsSettled = 0; for(uint256 i = 0; i < transferIds.length; i++) { uint256 transferBondAmount = _bondedWithdrawalAmounts[bonder][transferIds[i]]; if (transferBondAmount > 0) { totalBondsSettled = totalBondsSettled.add(transferBondAmount); _bondedWithdrawalAmounts[bonder][transferIds[i]] = 0; } } _addToAmountWithdrawn(transferRootId, totalBondsSettled); _addCredit(bonder, totalBondsSettled); emit MultipleWithdrawalsSettled(bonder, rootHash, totalBondsSettled); } /* ========== External TransferRoot Rescue ========== */ /** * @dev Allows governance to withdraw the remaining amount from a TransferRoot after the rescue delay has passed. * @param rootHash the Merkle root of the TransferRoot * @param originalAmount The TransferRoot's recorded total * @param recipient The address receiving the remaining balance */ function rescueTransferRoot(bytes32 rootHash, uint256 originalAmount, address recipient) external onlyGovernance { bytes32 transferRootId = getTransferRootId(rootHash, originalAmount); TransferRoot memory transferRoot = getTransferRoot(rootHash, originalAmount); require(transferRoot.createdAt != 0, "BRG: TransferRoot not found"); assert(transferRoot.total == originalAmount); uint256 rescueDelayEnd = transferRoot.createdAt.add(RESCUE_DELAY); require(block.timestamp >= rescueDelayEnd, "BRG: TransferRoot cannot be rescued before the Rescue Delay"); uint256 remainingAmount = transferRoot.total.sub(transferRoot.amountWithdrawn); _addToAmountWithdrawn(transferRootId, remainingAmount); _transferFromBridge(recipient, remainingAmount); } /* ========== Internal Functions ========== */ function _markTransferSpent(bytes32 transferId) internal { require(!_spentTransferIds[transferId], "BRG: The transfer has already been withdrawn"); _spentTransferIds[transferId] = true; } function _addToAmountWithdrawn(bytes32 transferRootId, uint256 amount) internal { TransferRoot storage transferRoot = _transferRoots[transferRootId]; require(transferRoot.total > 0, "BRG: Transfer root not found"); uint256 newAmountWithdrawn = transferRoot.amountWithdrawn.add(amount); require(newAmountWithdrawn <= transferRoot.total, "BRG: Withdrawal exceeds TransferRoot total"); transferRoot.amountWithdrawn = newAmountWithdrawn; } function _setTransferRoot(bytes32 rootHash, uint256 totalAmount) internal { bytes32 transferRootId = getTransferRootId(rootHash, totalAmount); require(_transferRoots[transferRootId].total == 0, "BRG: Transfer root already set"); require(totalAmount > 0, "BRG: Cannot set TransferRoot totalAmount of 0"); _transferRoots[transferRootId] = TransferRoot(totalAmount, 0, block.timestamp); emit TransferRootSet(rootHash, totalAmount); } function _bondWithdrawal(bytes32 transferId, uint256 amount) internal { require(_bondedWithdrawalAmounts[msg.sender][transferId] == 0, "BRG: Withdrawal has already been bonded"); _addDebit(msg.sender, amount); _bondedWithdrawalAmounts[msg.sender][transferId] = amount; emit WithdrawalBonded(transferId, amount); } /* ========== Private Functions ========== */ /// @dev Completes the Transfer, distributes the Bonder fee and marks the Transfer as spent. function _fulfillWithdraw( bytes32 transferId, address recipient, uint256 amount, uint256 bonderFee ) private { _markTransferSpent(transferId); _transferFromBridge(recipient, amount.sub(bonderFee)); if (bonderFee > 0) { _transferFromBridge(msg.sender, bonderFee); } } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.12 <0.8.0; pragma experimental ABIEncoderV2; interface IMessengerWrapper { function sendCrossDomainMessage(bytes memory _calldata) external; function verifySender(address l1BridgeCaller, bytes memory _data) external; } // SPDX-License-Identifier: MIT pragma solidity 0.6.12; pragma experimental ABIEncoderV2; import "@openzeppelin/contracts/math/SafeMath.sol"; import "@openzeppelin/contracts/utils/ReentrancyGuard.sol"; /** * @dev Accounting is an abstract contract that encapsulates the most critical logic in the Hop contracts. * The accounting system works by using two balances that can only increase `_credit` and `_debit`. * A bonder's available balance is the total credit minus the total debit. The contract exposes * two external functions that allows a bonder to stake and unstake and exposes two internal * functions to its child contracts that allow the child contract to add to the credit * and debit balance. In addition, child contracts can override `_additionalDebit` to account * for any additional debit balance in an alternative way. Lastly, it exposes a modifier, * `requirePositiveBalance`, that can be used by child contracts to ensure the bonder does not * use more than its available stake. */ abstract contract Accounting is ReentrancyGuard { using SafeMath for uint256; mapping(address => bool) private _isBonder; mapping(address => uint256) private _credit; mapping(address => uint256) private _debit; event Stake ( address indexed account, uint256 amount ); event Unstake ( address indexed account, uint256 amount ); event BonderAdded ( address indexed newBonder ); event BonderRemoved ( address indexed previousBonder ); /* ========== Modifiers ========== */ modifier onlyBonder { require(_isBonder[msg.sender], "ACT: Caller is not bonder"); _; } modifier onlyGovernance { _requireIsGovernance(); _; } /// @dev Used by parent contract to ensure that the Bonder is solvent at the end of the transaction. modifier requirePositiveBalance { _; require(getCredit(msg.sender) >= getDebitAndAdditionalDebit(msg.sender), "ACT: Not enough available credit"); } /// @dev Sets the Bonder addresses constructor(address[] memory bonders) public { for (uint256 i = 0; i < bonders.length; i++) { require(_isBonder[bonders[i]] == false, "ACT: Cannot add duplicate bonder"); _isBonder[bonders[i]] = true; emit BonderAdded(bonders[i]); } } /* ========== Virtual functions ========== */ /** * @dev The following functions are overridden in L1_Bridge and L2_Bridge */ function _transferFromBridge(address recipient, uint256 amount) internal virtual; function _transferToBridge(address from, uint256 amount) internal virtual; function _requireIsGovernance() internal virtual; /** * @dev This function can be optionally overridden by a parent contract to track any additional * debit balance in an alternative way. */ function _additionalDebit(address /*bonder*/) internal view virtual returns (uint256) { this; // Silence state mutability warning without generating any additional byte code return 0; } /* ========== Public/external getters ========== */ /** * @dev Check if address is a Bonder * @param maybeBonder The address being checked * @return true if address is a Bonder */ function getIsBonder(address maybeBonder) public view returns (bool) { return _isBonder[maybeBonder]; } /** * @dev Get the Bonder's credit balance * @param bonder The owner of the credit balance being checked * @return The credit balance for the Bonder */ function getCredit(address bonder) public view returns (uint256) { return _credit[bonder]; } /** * @dev Gets the debit balance tracked by `_debit` and does not include `_additionalDebit()` * @param bonder The owner of the debit balance being checked * @return The debit amount for the Bonder */ function getRawDebit(address bonder) external view returns (uint256) { return _debit[bonder]; } /** * @dev Get the Bonder's total debit * @param bonder The owner of the debit balance being checked * @return The Bonder's total debit balance */ function getDebitAndAdditionalDebit(address bonder) public view returns (uint256) { return _debit[bonder].add(_additionalDebit(bonder)); } /* ========== Bonder external functions ========== */ /** * @dev Allows the Bonder to deposit tokens and increase its credit balance * @param bonder The address being staked on * @param amount The amount being staked */ function stake(address bonder, uint256 amount) external payable nonReentrant { require(_isBonder[bonder] == true, "ACT: Address is not bonder"); _transferToBridge(msg.sender, amount); _addCredit(bonder, amount); emit Stake(bonder, amount); } /** * @dev Allows the caller to withdraw any available balance and add to their debit balance * @param amount The amount being unstaked */ function unstake(uint256 amount) external requirePositiveBalance nonReentrant { _addDebit(msg.sender, amount); _transferFromBridge(msg.sender, amount); emit Unstake(msg.sender, amount); } /** * @dev Add Bonder to allowlist * @param bonder The address being added as a Bonder */ function addBonder(address bonder) external onlyGovernance { require(_isBonder[bonder] == false, "ACT: Address is already bonder"); _isBonder[bonder] = true; emit BonderAdded(bonder); } /** * @dev Remove Bonder from allowlist * @param bonder The address being removed as a Bonder */ function removeBonder(address bonder) external onlyGovernance { require(_isBonder[bonder] == true, "ACT: Address is not bonder"); _isBonder[bonder] = false; emit BonderRemoved(bonder); } /* ========== Internal functions ========== */ function _addCredit(address bonder, uint256 amount) internal { _credit[bonder] = _credit[bonder].add(amount); } function _addDebit(address bonder, uint256 amount) internal { _debit[bonder] = _debit[bonder].add(amount); } } // SPDX-License-Identifier: MIT pragma solidity >0.5.0 <0.8.0; /** * @title Lib_MerkleTree * @author River Keefer */ library Lib_MerkleTree { /********************** * Internal Functions * **********************/ /** * Calculates a merkle root for a list of 32-byte leaf hashes. WARNING: If the number * of leaves passed in is not a power of two, it pads out the tree with zero hashes. * If you do not know the original length of elements for the tree you are verifying, * then this may allow empty leaves past _elements.length to pass a verification check down the line. * Note that the _elements argument is modified, therefore it must not be used again afterwards * @param _elements Array of hashes from which to generate a merkle root. * @return Merkle root of the leaves, with zero hashes for non-powers-of-two (see above). */ function getMerkleRoot( bytes32[] memory _elements ) internal pure returns ( bytes32 ) { require( _elements.length > 0, "Lib_MerkleTree: Must provide at least one leaf hash." ); if (_elements.length == 1) { return _elements[0]; } uint256[16] memory defaults = [ 0x290decd9548b62a8d60345a988386fc84ba6bc95484008f6362f93160ef3e563, 0x633dc4d7da7256660a892f8f1604a44b5432649cc8ec5cb3ced4c4e6ac94dd1d, 0x890740a8eb06ce9be422cb8da5cdafc2b58c0a5e24036c578de2a433c828ff7d, 0x3b8ec09e026fdc305365dfc94e189a81b38c7597b3d941c279f042e8206e0bd8, 0xecd50eee38e386bd62be9bedb990706951b65fe053bd9d8a521af753d139e2da, 0xdefff6d330bb5403f63b14f33b578274160de3a50df4efecf0e0db73bcdd3da5, 0x617bdd11f7c0a11f49db22f629387a12da7596f9d1704d7465177c63d88ec7d7, 0x292c23a9aa1d8bea7e2435e555a4a60e379a5a35f3f452bae60121073fb6eead, 0xe1cea92ed99acdcb045a6726b2f87107e8a61620a232cf4d7d5b5766b3952e10, 0x7ad66c0a68c72cb89e4fb4303841966e4062a76ab97451e3b9fb526a5ceb7f82, 0xe026cc5a4aed3c22a58cbd3d2ac754c9352c5436f638042dca99034e83636516, 0x3d04cffd8b46a874edf5cfae63077de85f849a660426697b06a829c70dd1409c, 0xad676aa337a485e4728a0b240d92b3ef7b3c372d06d189322bfd5f61f1e7203e, 0xa2fca4a49658f9fab7aa63289c91b7c7b6c832a6d0e69334ff5b0a3483d09dab, 0x4ebfd9cd7bca2505f7bef59cc1c12ecc708fff26ae4af19abe852afe9e20c862, 0x2def10d13dd169f550f578bda343d9717a138562e0093b380a1120789d53cf10 ]; // Reserve memory space for our hashes. bytes memory buf = new bytes(64); // We'll need to keep track of left and right siblings. bytes32 leftSibling; bytes32 rightSibling; // Number of non-empty nodes at the current depth. uint256 rowSize = _elements.length; // Current depth, counting from 0 at the leaves uint256 depth = 0; // Common sub-expressions uint256 halfRowSize; // rowSize / 2 bool rowSizeIsOdd; // rowSize % 2 == 1 while (rowSize > 1) { halfRowSize = rowSize / 2; rowSizeIsOdd = rowSize % 2 == 1; for (uint256 i = 0; i < halfRowSize; i++) { leftSibling = _elements[(2 * i) ]; rightSibling = _elements[(2 * i) + 1]; assembly { mstore(add(buf, 32), leftSibling ) mstore(add(buf, 64), rightSibling) } _elements[i] = keccak256(buf); } if (rowSizeIsOdd) { leftSibling = _elements[rowSize - 1]; rightSibling = bytes32(defaults[depth]); assembly { mstore(add(buf, 32), leftSibling) mstore(add(buf, 64), rightSibling) } _elements[halfRowSize] = keccak256(buf); } rowSize = halfRowSize + (rowSizeIsOdd ? 1 : 0); depth++; } return _elements[0]; } /** * Verifies a merkle branch for the given leaf hash. Assumes the original length * of leaves generated is a known, correct input, and does not return true for indices * extending past that index (even if _siblings would be otherwise valid.) * @param _root The Merkle root to verify against. * @param _leaf The leaf hash to verify inclusion of. * @param _index The index in the tree of this leaf. * @param _siblings Array of sibline nodes in the inclusion proof, starting from depth 0 (bottom of the tree). * @param _totalLeaves The total number of leaves originally passed into. * @return Whether or not the merkle branch and leaf passes verification. */ function verify( bytes32 _root, bytes32 _leaf, uint256 _index, bytes32[] memory _siblings, uint256 _totalLeaves ) internal pure returns ( bool ) { require( _totalLeaves > 0, "Lib_MerkleTree: Total leaves must be greater than zero." ); require( _index < _totalLeaves, "Lib_MerkleTree: Index out of bounds." ); require( _siblings.length == _ceilLog2(_totalLeaves), "Lib_MerkleTree: Total siblings does not correctly correspond to total leaves." ); bytes32 computedRoot = _leaf; for (uint256 i = 0; i < _siblings.length; i++) { if ((_index & 1) == 1) { computedRoot = keccak256( abi.encodePacked( _siblings[i], computedRoot ) ); } else { computedRoot = keccak256( abi.encodePacked( computedRoot, _siblings[i] ) ); } _index >>= 1; } return _root == computedRoot; } /********************* * Private Functions * *********************/ /** * Calculates the integer ceiling of the log base 2 of an input. * @param _in Unsigned input to calculate the log. * @return ceil(log_base_2(_in)) */ function _ceilLog2( uint256 _in ) private pure returns ( uint256 ) { require( _in > 0, "Lib_MerkleTree: Cannot compute ceil(log_2) of 0." ); if (_in == 1) { return 0; } // Find the highest set bit (will be floor(log_2)). // Borrowed with <3 from https://github.com/ethereum/solidity-examples uint256 val = _in; uint256 highest = 0; for (uint256 i = 128; i >= 1; i >>= 1) { if (val & (uint(1) << i) - 1 << i != 0) { highest += i; val >>= i; } } // Increment by one if this is not a perfect logarithm. if ((uint(1) << highest) != _in) { highest += 1; } return highest; } }// SPDX-License-Identifier: MIT pragma solidity >=0.6.0 <0.8.0; /** * @dev Wrappers over Solidity's arithmetic operations with added overflow * checks. * * Arithmetic operations in Solidity wrap on overflow. This can easily result * in bugs, because programmers usually assume that an overflow raises an * error, which is the standard behavior in high level programming languages. * `SafeMath` restores this intuition by reverting the transaction when an * operation overflows. * * Using this library instead of the unchecked operations eliminates an entire * class of bugs, so it's recommended to use it always. */ library SafeMath { /** * @dev Returns the addition of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) { uint256 c = a + b; if (c < a) return (false, 0); return (true, c); } /** * @dev Returns the substraction of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b > a) return (false, 0); return (true, a - b); } /** * @dev Returns the multiplication of two unsigned integers, with an overflow flag. * * _Available since v3.4._ */ function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) { // Gas optimization: this is cheaper than requiring 'a' not being zero, but the // benefit is lost if 'b' is also tested. // See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522 if (a == 0) return (true, 0); uint256 c = a * b; if (c / a != b) return (false, 0); return (true, c); } /** * @dev Returns the division of two unsigned integers, with a division by zero flag. * * _Available since v3.4._ */ function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b == 0) return (false, 0); return (true, a / b); } /** * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag. * * _Available since v3.4._ */ function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b == 0) return (false, 0); return (true, a % b); } /** * @dev Returns the addition of two unsigned integers, reverting on * overflow. * * Counterpart to Solidity's `+` operator. * * Requirements: * * - Addition cannot overflow. */ function add(uint256 a, uint256 b) internal pure returns (uint256) { uint256 c = a + b; require(c >= a, "SafeMath: addition overflow"); return c; } /** * @dev Returns the subtraction of two unsigned integers, reverting on * overflow (when the result is negative). * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub(uint256 a, uint256 b) internal pure returns (uint256) { require(b <= a, "SafeMath: subtraction overflow"); return a - b; } /** * @dev Returns the multiplication of two unsigned integers, reverting on * overflow. * * Counterpart to Solidity's `*` operator. * * Requirements: * * - Multiplication cannot overflow. */ function mul(uint256 a, uint256 b) internal pure returns (uint256) { if (a == 0) return 0; uint256 c = a * b; require(c / a == b, "SafeMath: multiplication overflow"); return c; } /** * @dev Returns the integer division of two unsigned integers, reverting on * division by zero. The result is rounded towards zero. * * Counterpart to Solidity's `/` operator. Note: this function uses a * `revert` opcode (which leaves remaining gas untouched) while Solidity * uses an invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function div(uint256 a, uint256 b) internal pure returns (uint256) { require(b > 0, "SafeMath: division by zero"); return a / b; } /** * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), * reverting when dividing by zero. * * Counterpart to Solidity's `%` operator. This function uses a `revert` * opcode (which leaves remaining gas untouched) while Solidity uses an * invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function mod(uint256 a, uint256 b) internal pure returns (uint256) { require(b > 0, "SafeMath: modulo by zero"); return a % b; } /** * @dev Returns the subtraction of two unsigned integers, reverting with custom message on * overflow (when the result is negative). * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {trySub}. * * Counterpart to Solidity's `-` operator. * * Requirements: * * - Subtraction cannot overflow. */ function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b <= a, errorMessage); return a - b; } /** * @dev Returns the integer division of two unsigned integers, reverting with custom message on * division by zero. The result is rounded towards zero. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {tryDiv}. * * Counterpart to Solidity's `/` operator. Note: this function uses a * `revert` opcode (which leaves remaining gas untouched) while Solidity * uses an invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b > 0, errorMessage); return a / b; } /** * @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo), * reverting with custom message when dividing by zero. * * CAUTION: This function is deprecated because it requires allocating memory for the error * message unnecessarily. For custom revert reasons use {tryMod}. * * Counterpart to Solidity's `%` operator. This function uses a `revert` * opcode (which leaves remaining gas untouched) while Solidity uses an * invalid opcode to revert (consuming all remaining gas). * * Requirements: * * - The divisor cannot be zero. */ function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) { require(b > 0, errorMessage); return a % b; } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.0 <0.8.0; /** * @dev Contract module that helps prevent reentrant calls to a function. * * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier * available, which can be applied to functions to make sure there are no nested * (reentrant) calls to them. * * Note that because there is a single `nonReentrant` guard, functions marked as * `nonReentrant` may not call one another. This can be worked around by making * those functions `private`, and then adding `external` `nonReentrant` entry * points to them. * * TIP: If you would like to learn more about reentrancy and alternative ways * to protect against it, check out our blog post * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul]. */ abstract contract ReentrancyGuard { // Booleans are more expensive than uint256 or any type that takes up a full // word because each write operation emits an extra SLOAD to first read the // slot's contents, replace the bits taken up by the boolean, and then write // back. This is the compiler's defense against contract upgrades and // pointer aliasing, and it cannot be disabled. // The values being non-zero value makes deployment a bit more expensive, // but in exchange the refund on every call to nonReentrant will be lower in // amount. Since refunds are capped to a percentage of the total // transaction's gas, it is best to keep them low in cases like this one, to // increase the likelihood of the full refund coming into effect. uint256 private constant _NOT_ENTERED = 1; uint256 private constant _ENTERED = 2; uint256 private _status; constructor () internal { _status = _NOT_ENTERED; } /** * @dev Prevents a contract from calling itself, directly or indirectly. * Calling a `nonReentrant` function from another `nonReentrant` * function is not supported. It is possible to prevent this from happening * by making the `nonReentrant` function external, and make it call a * `private` function that does the actual work. */ modifier nonReentrant() { // On the first call to nonReentrant, _notEntered will be true require(_status != _ENTERED, "ReentrancyGuard: reentrant call"); // Any calls to nonReentrant after this point will fail _status = _ENTERED; _; // By storing the original value once again, a refund is triggered (see // https://eips.ethereum.org/EIPS/eip-2200) _status = _NOT_ENTERED; } }
File 4 of 5: LineaMessengerWrapper
// SPDX-License-Identifier: MIT pragma solidity >=0.6.12 <=0.8.9; pragma experimental ABIEncoderV2; interface IMessengerWrapper { function sendCrossDomainMessage(bytes memory _calldata) external; function verifySender(address l1BridgeCaller, bytes memory _data) external; function confirmRoots( bytes32[] calldata rootHashes, uint256[] calldata destinationChainIds, uint256[] calldata totalAmounts, uint256[] calldata rootCommittedAts ) external; } // SPDX-License-Identifier: OWNED BY ConsenSys Software Inc. pragma solidity ^0.6.12; /// @title The bridge interface implemented on both chains interface IBridge { event MessageDispatched( address _from, address _to, uint256 _fee, uint256 _value, uint256 _deadline, bytes _calldata ); event MessageDelivered( address _from, address _to, uint256 _fee, uint256 _value, uint256 _deadline, bytes _calldata ); function dispatchMessage( address _to, uint256 _fee, uint256 _deadline, bytes calldata _calldata ) external payable; function deliverMessage( address _from, address _to, uint256 _fee, uint256 _value, uint256 _deadline, bytes calldata _calldata ) external payable; function sender() external view returns (address); // New implementation function sendMessage( address _to, uint256 _fee, bytes calldata _calldata ) external payable; function minimumFeeInWei() external view returns (uint256); }// SPDX-License-Identifier: MIT pragma solidity 0.6.12; pragma experimental ABIEncoderV2; import "../interfaces/linea/messengers/IBridge.sol"; import "./MessengerWrapper.sol"; /** * @dev A MessengerWrapper for Linea - https://docs.linea.build/ * @notice Deployed on layer-1 */ contract LineaMessengerWrapper is MessengerWrapper { IBridge public lineaL1Bridge; address public l2BridgeAddress; constructor( address _l1BridgeAddress, address _l2BridgeAddress, IBridge _lineaL1Bridge, uint256 _l2ChainId ) public MessengerWrapper(_l1BridgeAddress, _l2ChainId) { l2BridgeAddress = _l2BridgeAddress; lineaL1Bridge = _lineaL1Bridge; } /** * @dev Sends a message to the l2BridgeAddress from layer-1 * @param _calldata The data that l2BridgeAddress will be called with */ function sendCrossDomainMessage(bytes memory _calldata) public override onlyL1Bridge { lineaL1Bridge.sendMessage( l2BridgeAddress, 0, _calldata ); } function verifySender(address l1BridgeCaller, bytes memory) public override { if (isRootConfirmation) return; require(lineaL1Bridge.sender() == l2BridgeAddress, "LINEA_MSG_WRP: Invalid cross-domain sender"); require(l1BridgeCaller == address(lineaL1Bridge), "LINEA_MSG_WRP: Caller is not the expected sender"); } } // SPDX-License-Identifier: MIT pragma solidity >=0.6.12 <=0.8.9; pragma experimental ABIEncoderV2; import "../interfaces/IMessengerWrapper.sol"; contract IL1Bridge { struct TransferBond { address bonder; uint256 createdAt; uint256 totalAmount; uint256 challengeStartTime; address challenger; bool challengeResolved; } uint256 public challengePeriod; mapping(bytes32 => TransferBond) public transferBonds; function getIsBonder(address maybeBonder) public view returns (bool) {} function getTransferRootId(bytes32 rootHash, uint256 totalAmount) public pure returns (bytes32) {} function confirmTransferRoot( uint256 originChainId, bytes32 rootHash, uint256 destinationChainId, uint256 totalAmount, uint256 rootCommittedAt ) external {} } abstract contract MessengerWrapper is IMessengerWrapper { address public immutable l1BridgeAddress; uint256 public immutable l2ChainId; bool public isRootConfirmation = false; constructor(address _l1BridgeAddress, uint256 _l2ChainId) internal { l1BridgeAddress = _l1BridgeAddress; l2ChainId = _l2ChainId; } modifier onlyL1Bridge { require(msg.sender == l1BridgeAddress, "MW: Sender must be the L1 Bridge"); _; } modifier rootConfirmation { isRootConfirmation = true; _; isRootConfirmation = false; } /** * @dev Confirm roots that have bonded on L1 and passed the challenge period with no challenge * @param rootHashes The root hashes to confirm * @param destinationChainIds The destinationChainId of the roots to confirm * @param totalAmounts The totalAmount of the roots to confirm * @param rootCommittedAts The rootCommittedAt of the roots to confirm */ function confirmRoots ( bytes32[] calldata rootHashes, uint256[] calldata destinationChainIds, uint256[] calldata totalAmounts, uint256[] calldata rootCommittedAts ) external override rootConfirmation { IL1Bridge l1Bridge = IL1Bridge(l1BridgeAddress); require(l1Bridge.getIsBonder(msg.sender), "MW: Sender must be a bonder"); require(rootHashes.length == totalAmounts.length, "MW: rootHashes and totalAmounts must be the same length"); uint256 challengePeriod = l1Bridge.challengePeriod(); for (uint256 i = 0; i < rootHashes.length; i++) { bool canConfirm = canConfirmRoot(l1Bridge, rootHashes[i], totalAmounts[i], challengePeriod); require(canConfirm, "MW: Root cannot be confirmed"); l1Bridge.confirmTransferRoot( l2ChainId, rootHashes[i], destinationChainIds[i], totalAmounts[i], rootCommittedAts[i] ); } } function canConfirmRoot (IL1Bridge l1Bridge, bytes32 rootHash, uint256 totalAmount, uint256 challengePeriod) public view returns (bool) { bytes32 transferRootId = l1Bridge.getTransferRootId(rootHash, totalAmount); (,uint256 createdAt,,uint256 challengeStartTime,,) = l1Bridge.transferBonds(transferRootId); uint256 timeSinceBondCreation = block.timestamp - createdAt; if ( createdAt != 0 && challengeStartTime == 0 && timeSinceBondCreation > challengePeriod ) { return true; } return false; } }
File 5 of 5: LineaRollup
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.9.0) (access/AccessControl.sol) pragma solidity ^0.8.0; import "./IAccessControlUpgradeable.sol"; import "../utils/ContextUpgradeable.sol"; import "../utils/StringsUpgradeable.sol"; import "../utils/introspection/ERC165Upgradeable.sol"; import "../proxy/utils/Initializable.sol"; /** * @dev Contract module that allows children to implement role-based access * control mechanisms. This is a lightweight version that doesn't allow enumerating role * members except through off-chain means by accessing the contract event logs. Some * applications may benefit from on-chain enumerability, for those cases see * {AccessControlEnumerable}. * * Roles are referred to by their `bytes32` identifier. These should be exposed * in the external API and be unique. The best way to achieve this is by * using `public constant` hash digests: * * ```solidity * bytes32 public constant MY_ROLE = keccak256("MY_ROLE"); * ``` * * Roles can be used to represent a set of permissions. To restrict access to a * function call, use {hasRole}: * * ```solidity * function foo() public { * require(hasRole(MY_ROLE, msg.sender)); * ... * } * ``` * * Roles can be granted and revoked dynamically via the {grantRole} and * {revokeRole} functions. Each role has an associated admin role, and only * accounts that have a role's admin role can call {grantRole} and {revokeRole}. * * By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means * that only accounts with this role will be able to grant or revoke other * roles. More complex role relationships can be created by using * {_setRoleAdmin}. * * WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to * grant and revoke this role. Extra precautions should be taken to secure * accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules} * to enforce additional security measures for this role. */ abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControlUpgradeable, ERC165Upgradeable { function __AccessControl_init() internal onlyInitializing { } function __AccessControl_init_unchained() internal onlyInitializing { } struct RoleData { mapping(address => bool) members; bytes32 adminRole; } mapping(bytes32 => RoleData) private _roles; bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00; /** * @dev Modifier that checks that an account has a specific role. Reverts * with a standardized message including the required role. * * The format of the revert reason is given by the following regular expression: * * /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/ * * _Available since v4.1._ */ modifier onlyRole(bytes32 role) { _checkRole(role); _; } /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IAccessControlUpgradeable).interfaceId || super.supportsInterface(interfaceId); } /** * @dev Returns `true` if `account` has been granted `role`. */ function hasRole(bytes32 role, address account) public view virtual override returns (bool) { return _roles[role].members[account]; } /** * @dev Revert with a standard message if `_msgSender()` is missing `role`. * Overriding this function changes the behavior of the {onlyRole} modifier. * * Format of the revert message is described in {_checkRole}. * * _Available since v4.6._ */ function _checkRole(bytes32 role) internal view virtual { _checkRole(role, _msgSender()); } /** * @dev Revert with a standard message if `account` is missing `role`. * * The format of the revert reason is given by the following regular expression: * * /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/ */ function _checkRole(bytes32 role, address account) internal view virtual { if (!hasRole(role, account)) { revert( string( abi.encodePacked( "AccessControl: account ", StringsUpgradeable.toHexString(account), " is missing role ", StringsUpgradeable.toHexString(uint256(role), 32) ) ) ); } } /** * @dev Returns the admin role that controls `role`. See {grantRole} and * {revokeRole}. * * To change a role's admin, use {_setRoleAdmin}. */ function getRoleAdmin(bytes32 role) public view virtual override returns (bytes32) { return _roles[role].adminRole; } /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. * * Requirements: * * - the caller must have ``role``'s admin role. * * May emit a {RoleGranted} event. */ function grantRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) { _grantRole(role, account); } /** * @dev Revokes `role` from `account`. * * If `account` had been granted `role`, emits a {RoleRevoked} event. * * Requirements: * * - the caller must have ``role``'s admin role. * * May emit a {RoleRevoked} event. */ function revokeRole(bytes32 role, address account) public virtual override onlyRole(getRoleAdmin(role)) { _revokeRole(role, account); } /** * @dev Revokes `role` from the calling account. * * Roles are often managed via {grantRole} and {revokeRole}: this function's * purpose is to provide a mechanism for accounts to lose their privileges * if they are compromised (such as when a trusted device is misplaced). * * If the calling account had been revoked `role`, emits a {RoleRevoked} * event. * * Requirements: * * - the caller must be `account`. * * May emit a {RoleRevoked} event. */ function renounceRole(bytes32 role, address account) public virtual override { require(account == _msgSender(), "AccessControl: can only renounce roles for self"); _revokeRole(role, account); } /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. Note that unlike {grantRole}, this function doesn't perform any * checks on the calling account. * * May emit a {RoleGranted} event. * * [WARNING] * ==== * This function should only be called from the constructor when setting * up the initial roles for the system. * * Using this function in any other way is effectively circumventing the admin * system imposed by {AccessControl}. * ==== * * NOTE: This function is deprecated in favor of {_grantRole}. */ function _setupRole(bytes32 role, address account) internal virtual { _grantRole(role, account); } /** * @dev Sets `adminRole` as ``role``'s admin role. * * Emits a {RoleAdminChanged} event. */ function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual { bytes32 previousAdminRole = getRoleAdmin(role); _roles[role].adminRole = adminRole; emit RoleAdminChanged(role, previousAdminRole, adminRole); } /** * @dev Grants `role` to `account`. * * Internal function without access restriction. * * May emit a {RoleGranted} event. */ function _grantRole(bytes32 role, address account) internal virtual { if (!hasRole(role, account)) { _roles[role].members[account] = true; emit RoleGranted(role, account, _msgSender()); } } /** * @dev Revokes `role` from `account`. * * Internal function without access restriction. * * May emit a {RoleRevoked} event. */ function _revokeRole(bytes32 role, address account) internal virtual { if (hasRole(role, account)) { _roles[role].members[account] = false; emit RoleRevoked(role, account, _msgSender()); } } /** * @dev This empty reserved space is put in place to allow future versions to add new * variables without shifting down storage in the inheritance chain. * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps */ uint256[49] private __gap; } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol) pragma solidity ^0.8.0; /** * @dev External interface of AccessControl declared to support ERC165 detection. */ interface IAccessControlUpgradeable { /** * @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole` * * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite * {RoleAdminChanged} not being emitted signaling this. * * _Available since v3.1._ */ event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole); /** * @dev Emitted when `account` is granted `role`. * * `sender` is the account that originated the contract call, an admin role * bearer except when using {AccessControl-_setupRole}. */ event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender); /** * @dev Emitted when `account` is revoked `role`. * * `sender` is the account that originated the contract call: * - if using `revokeRole`, it is the admin role bearer * - if using `renounceRole`, it is the role bearer (i.e. `account`) */ event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender); /** * @dev Returns `true` if `account` has been granted `role`. */ function hasRole(bytes32 role, address account) external view returns (bool); /** * @dev Returns the admin role that controls `role`. See {grantRole} and * {revokeRole}. * * To change a role's admin, use {AccessControl-_setRoleAdmin}. */ function getRoleAdmin(bytes32 role) external view returns (bytes32); /** * @dev Grants `role` to `account`. * * If `account` had not been already granted `role`, emits a {RoleGranted} * event. * * Requirements: * * - the caller must have ``role``'s admin role. */ function grantRole(bytes32 role, address account) external; /** * @dev Revokes `role` from `account`. * * If `account` had been granted `role`, emits a {RoleRevoked} event. * * Requirements: * * - the caller must have ``role``'s admin role. */ function revokeRole(bytes32 role, address account) external; /** * @dev Revokes `role` from the calling account. * * Roles are often managed via {grantRole} and {revokeRole}: this function's * purpose is to provide a mechanism for accounts to lose their privileges * if they are compromised (such as when a trusted device is misplaced). * * If the calling account had been granted `role`, emits a {RoleRevoked} * event. * * Requirements: * * - the caller must be `account`. */ function renounceRole(bytes32 role, address account) external; } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.9.0) (proxy/utils/Initializable.sol) pragma solidity ^0.8.2; import "../../utils/AddressUpgradeable.sol"; /** * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed * behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect. * * The initialization functions use a version number. Once a version number is used, it is consumed and cannot be * reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in * case an upgrade adds a module that needs to be initialized. * * For example: * * [.hljs-theme-light.nopadding] * ```solidity * contract MyToken is ERC20Upgradeable { * function initialize() initializer public { * __ERC20_init("MyToken", "MTK"); * } * } * * contract MyTokenV2 is MyToken, ERC20PermitUpgradeable { * function initializeV2() reinitializer(2) public { * __ERC20Permit_init("MyToken"); * } * } * ``` * * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}. * * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity. * * [CAUTION] * ==== * Avoid leaving a contract uninitialized. * * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation * contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke * the {_disableInitializers} function in the constructor to automatically lock it when it is deployed: * * [.hljs-theme-light.nopadding] * ``` * /// @custom:oz-upgrades-unsafe-allow constructor * constructor() { * _disableInitializers(); * } * ``` * ==== */ abstract contract Initializable { /** * @dev Indicates that the contract has been initialized. * @custom:oz-retyped-from bool */ uint8 private _initialized; /** * @dev Indicates that the contract is in the process of being initialized. */ bool private _initializing; /** * @dev Triggered when the contract has been initialized or reinitialized. */ event Initialized(uint8 version); /** * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope, * `onlyInitializing` functions can be used to initialize parent contracts. * * Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a * constructor. * * Emits an {Initialized} event. */ modifier initializer() { bool isTopLevelCall = !_initializing; require( (isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1), "Initializable: contract is already initialized" ); _initialized = 1; if (isTopLevelCall) { _initializing = true; } _; if (isTopLevelCall) { _initializing = false; emit Initialized(1); } } /** * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be * used to initialize parent contracts. * * A reinitializer may be used after the original initialization step. This is essential to configure modules that * are added through upgrades and that require initialization. * * When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer` * cannot be nested. If one is invoked in the context of another, execution will revert. * * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in * a contract, executing them in the right order is up to the developer or operator. * * WARNING: setting the version to 255 will prevent any future reinitialization. * * Emits an {Initialized} event. */ modifier reinitializer(uint8 version) { require(!_initializing && _initialized < version, "Initializable: contract is already initialized"); _initialized = version; _initializing = true; _; _initializing = false; emit Initialized(version); } /** * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the * {initializer} and {reinitializer} modifiers, directly or indirectly. */ modifier onlyInitializing() { require(_initializing, "Initializable: contract is not initializing"); _; } /** * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call. * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized * to any version. It is recommended to use this to lock implementation contracts that are designed to be called * through proxies. * * Emits an {Initialized} event the first time it is successfully executed. */ function _disableInitializers() internal virtual { require(!_initializing, "Initializable: contract is initializing"); if (_initialized != type(uint8).max) { _initialized = type(uint8).max; emit Initialized(type(uint8).max); } } /** * @dev Returns the highest version that has been initialized. See {reinitializer}. */ function _getInitializedVersion() internal view returns (uint8) { return _initialized; } /** * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}. */ function _isInitializing() internal view returns (bool) { return _initializing; } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.9.0) (security/ReentrancyGuard.sol) pragma solidity ^0.8.0; import "../proxy/utils/Initializable.sol"; /** * @dev Contract module that helps prevent reentrant calls to a function. * * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier * available, which can be applied to functions to make sure there are no nested * (reentrant) calls to them. * * Note that because there is a single `nonReentrant` guard, functions marked as * `nonReentrant` may not call one another. This can be worked around by making * those functions `private`, and then adding `external` `nonReentrant` entry * points to them. * * TIP: If you would like to learn more about reentrancy and alternative ways * to protect against it, check out our blog post * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul]. */ abstract contract ReentrancyGuardUpgradeable is Initializable { // Booleans are more expensive than uint256 or any type that takes up a full // word because each write operation emits an extra SLOAD to first read the // slot's contents, replace the bits taken up by the boolean, and then write // back. This is the compiler's defense against contract upgrades and // pointer aliasing, and it cannot be disabled. // The values being non-zero value makes deployment a bit more expensive, // but in exchange the refund on every call to nonReentrant will be lower in // amount. Since refunds are capped to a percentage of the total // transaction's gas, it is best to keep them low in cases like this one, to // increase the likelihood of the full refund coming into effect. uint256 private constant _NOT_ENTERED = 1; uint256 private constant _ENTERED = 2; uint256 private _status; function __ReentrancyGuard_init() internal onlyInitializing { __ReentrancyGuard_init_unchained(); } function __ReentrancyGuard_init_unchained() internal onlyInitializing { _status = _NOT_ENTERED; } /** * @dev Prevents a contract from calling itself, directly or indirectly. * Calling a `nonReentrant` function from another `nonReentrant` * function is not supported. It is possible to prevent this from happening * by making the `nonReentrant` function external, and making it call a * `private` function that does the actual work. */ modifier nonReentrant() { _nonReentrantBefore(); _; _nonReentrantAfter(); } function _nonReentrantBefore() private { // On the first call to nonReentrant, _status will be _NOT_ENTERED require(_status != _ENTERED, "ReentrancyGuard: reentrant call"); // Any calls to nonReentrant after this point will fail _status = _ENTERED; } function _nonReentrantAfter() private { // By storing the original value once again, a refund is triggered (see // https://eips.ethereum.org/EIPS/eip-2200) _status = _NOT_ENTERED; } /** * @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a * `nonReentrant` function in the call stack. */ function _reentrancyGuardEntered() internal view returns (bool) { return _status == _ENTERED; } /** * @dev This empty reserved space is put in place to allow future versions to add new * variables without shifting down storage in the inheritance chain. * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps */ uint256[49] private __gap; } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol) pragma solidity ^0.8.1; /** * @dev Collection of functions related to the address type */ library AddressUpgradeable { /** * @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 * * Furthermore, `isContract` will also return true if the target contract within * the same transaction is already scheduled for destruction by `SELFDESTRUCT`, * which only has an effect at the end of a transaction. * ==== * * [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://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.0/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 // OpenZeppelin Contracts v4.4.1 (utils/Context.sol) pragma solidity ^0.8.0; import "../proxy/utils/Initializable.sol"; /** * @dev Provides information about the current execution context, including the * sender of the transaction and its data. While these are generally available * via msg.sender and msg.data, they should not be accessed in such a direct * manner, since when dealing with meta-transactions the account sending and * paying for execution may not be the actual sender (as far as an application * is concerned). * * This contract is only required for intermediate, library-like contracts. */ abstract contract ContextUpgradeable is Initializable { function __Context_init() internal onlyInitializing { } function __Context_init_unchained() internal onlyInitializing { } function _msgSender() internal view virtual returns (address) { return msg.sender; } function _msgData() internal view virtual returns (bytes calldata) { return msg.data; } /** * @dev This empty reserved space is put in place to allow future versions to add new * variables without shifting down storage in the inheritance chain. * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps */ uint256[50] private __gap; } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/introspection/ERC165.sol) pragma solidity ^0.8.0; import "./IERC165Upgradeable.sol"; import "../../proxy/utils/Initializable.sol"; /** * @dev Implementation of the {IERC165} interface. * * Contracts that want to implement ERC165 should inherit from this contract and override {supportsInterface} to check * for the additional interface id that will be supported. For example: * * ```solidity * function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { * return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId); * } * ``` * * Alternatively, {ERC165Storage} provides an easier to use but more expensive implementation. */ abstract contract ERC165Upgradeable is Initializable, IERC165Upgradeable { function __ERC165_init() internal onlyInitializing { } function __ERC165_init_unchained() internal onlyInitializing { } /** * @dev See {IERC165-supportsInterface}. */ function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) { return interfaceId == type(IERC165Upgradeable).interfaceId; } /** * @dev This empty reserved space is put in place to allow future versions to add new * variables without shifting down storage in the inheritance chain. * See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps */ uint256[50] private __gap; } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC165 standard, as defined in the * https://eips.ethereum.org/EIPS/eip-165[EIP]. * * Implementers can declare support of contract interfaces, which can then be * queried by others ({ERC165Checker}). * * For an implementation, see {ERC165}. */ interface IERC165Upgradeable { /** * @dev Returns true if this contract implements the interface defined by * `interfaceId`. See the corresponding * https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] * to learn more about how these ids are created. * * This function call must use less than 30 000 gas. */ function supportsInterface(bytes4 interfaceId) external view returns (bool); } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.9.0) (utils/math/Math.sol) pragma solidity ^0.8.0; /** * @dev Standard math utilities missing in the Solidity language. */ library MathUpgradeable { enum Rounding { Down, // Toward negative infinity Up, // Toward infinity Zero // Toward zero } /** * @dev Returns the largest of two numbers. */ function max(uint256 a, uint256 b) internal pure returns (uint256) { return a > b ? a : b; } /** * @dev Returns the smallest of two numbers. */ function min(uint256 a, uint256 b) internal pure returns (uint256) { return a < b ? a : b; } /** * @dev Returns the average of two numbers. The result is rounded towards * zero. */ function average(uint256 a, uint256 b) internal pure returns (uint256) { // (a + b) / 2 can overflow. return (a & b) + (a ^ b) / 2; } /** * @dev Returns the ceiling of the division of two numbers. * * This differs from standard division with `/` in that it rounds up instead * of rounding down. */ function ceilDiv(uint256 a, uint256 b) internal pure returns (uint256) { // (a + b - 1) / b can overflow on addition, so we distribute. return a == 0 ? 0 : (a - 1) / b + 1; } /** * @notice Calculates floor(x * y / denominator) with full precision. Throws if result overflows a uint256 or denominator == 0 * @dev Original credit to Remco Bloemen under MIT license (https://xn--2-umb.com/21/muldiv) * with further edits by Uniswap Labs also under MIT license. */ function mulDiv(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) { unchecked { // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256 // variables such that product = prod1 * 2^256 + prod0. uint256 prod0; // Least significant 256 bits of the product uint256 prod1; // Most significant 256 bits of the product assembly { let mm := mulmod(x, y, not(0)) prod0 := mul(x, y) prod1 := sub(sub(mm, prod0), lt(mm, prod0)) } // Handle non-overflow cases, 256 by 256 division. if (prod1 == 0) { // Solidity will revert if denominator == 0, unlike the div opcode on its own. // The surrounding unchecked block does not change this fact. // See https://docs.soliditylang.org/en/latest/control-structures.html#checked-or-unchecked-arithmetic. return prod0 / denominator; } // Make sure the result is less than 2^256. Also prevents denominator == 0. require(denominator > prod1, "Math: mulDiv overflow"); /////////////////////////////////////////////// // 512 by 256 division. /////////////////////////////////////////////// // Make division exact by subtracting the remainder from [prod1 prod0]. uint256 remainder; assembly { // Compute remainder using mulmod. remainder := mulmod(x, y, denominator) // Subtract 256 bit number from 512 bit number. prod1 := sub(prod1, gt(remainder, prod0)) prod0 := sub(prod0, remainder) } // Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1. // See https://cs.stackexchange.com/q/138556/92363. // Does not overflow because the denominator cannot be zero at this stage in the function. uint256 twos = denominator & (~denominator + 1); assembly { // Divide denominator by twos. denominator := div(denominator, twos) // Divide [prod1 prod0] by twos. prod0 := div(prod0, twos) // Flip twos such that it is 2^256 / twos. If twos is zero, then it becomes one. twos := add(div(sub(0, twos), twos), 1) } // Shift in bits from prod1 into prod0. prod0 |= prod1 * twos; // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for // four bits. That is, denominator * inv = 1 mod 2^4. uint256 inverse = (3 * denominator) ^ 2; // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works // in modular arithmetic, doubling the correct bits in each step. inverse *= 2 - denominator * inverse; // inverse mod 2^8 inverse *= 2 - denominator * inverse; // inverse mod 2^16 inverse *= 2 - denominator * inverse; // inverse mod 2^32 inverse *= 2 - denominator * inverse; // inverse mod 2^64 inverse *= 2 - denominator * inverse; // inverse mod 2^128 inverse *= 2 - denominator * inverse; // inverse mod 2^256 // Because the division is now exact we can divide by multiplying with the modular inverse of denominator. // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1 // is no longer required. result = prod0 * inverse; return result; } } /** * @notice Calculates x * y / denominator with full precision, following the selected rounding direction. */ function mulDiv(uint256 x, uint256 y, uint256 denominator, Rounding rounding) internal pure returns (uint256) { uint256 result = mulDiv(x, y, denominator); if (rounding == Rounding.Up && mulmod(x, y, denominator) > 0) { result += 1; } return result; } /** * @dev Returns the square root of a number. If the number is not a perfect square, the value is rounded down. * * Inspired by Henry S. Warren, Jr.'s "Hacker's Delight" (Chapter 11). */ function sqrt(uint256 a) internal pure returns (uint256) { if (a == 0) { return 0; } // For our first guess, we get the biggest power of 2 which is smaller than the square root of the target. // // We know that the "msb" (most significant bit) of our target number `a` is a power of 2 such that we have // `msb(a) <= a < 2*msb(a)`. This value can be written `msb(a)=2**k` with `k=log2(a)`. // // This can be rewritten `2**log2(a) <= a < 2**(log2(a) + 1)` // → `sqrt(2**k) <= sqrt(a) < sqrt(2**(k+1))` // → `2**(k/2) <= sqrt(a) < 2**((k+1)/2) <= 2**(k/2 + 1)` // // Consequently, `2**(log2(a) / 2)` is a good first approximation of `sqrt(a)` with at least 1 correct bit. uint256 result = 1 << (log2(a) >> 1); // At this point `result` is an estimation with one bit of precision. We know the true value is a uint128, // since it is the square root of a uint256. Newton's method converges quadratically (precision doubles at // every iteration). We thus need at most 7 iteration to turn our partial result with one bit of precision // into the expected uint128 result. unchecked { result = (result + a / result) >> 1; result = (result + a / result) >> 1; result = (result + a / result) >> 1; result = (result + a / result) >> 1; result = (result + a / result) >> 1; result = (result + a / result) >> 1; result = (result + a / result) >> 1; return min(result, a / result); } } /** * @notice Calculates sqrt(a), following the selected rounding direction. */ function sqrt(uint256 a, Rounding rounding) internal pure returns (uint256) { unchecked { uint256 result = sqrt(a); return result + (rounding == Rounding.Up && result * result < a ? 1 : 0); } } /** * @dev Return the log in base 2, rounded down, of a positive value. * Returns 0 if given 0. */ function log2(uint256 value) internal pure returns (uint256) { uint256 result = 0; unchecked { if (value >> 128 > 0) { value >>= 128; result += 128; } if (value >> 64 > 0) { value >>= 64; result += 64; } if (value >> 32 > 0) { value >>= 32; result += 32; } if (value >> 16 > 0) { value >>= 16; result += 16; } if (value >> 8 > 0) { value >>= 8; result += 8; } if (value >> 4 > 0) { value >>= 4; result += 4; } if (value >> 2 > 0) { value >>= 2; result += 2; } if (value >> 1 > 0) { result += 1; } } return result; } /** * @dev Return the log in base 2, following the selected rounding direction, of a positive value. * Returns 0 if given 0. */ function log2(uint256 value, Rounding rounding) internal pure returns (uint256) { unchecked { uint256 result = log2(value); return result + (rounding == Rounding.Up && 1 << result < value ? 1 : 0); } } /** * @dev Return the log in base 10, rounded down, of a positive value. * Returns 0 if given 0. */ function log10(uint256 value) internal pure returns (uint256) { uint256 result = 0; unchecked { if (value >= 10 ** 64) { value /= 10 ** 64; result += 64; } if (value >= 10 ** 32) { value /= 10 ** 32; result += 32; } if (value >= 10 ** 16) { value /= 10 ** 16; result += 16; } if (value >= 10 ** 8) { value /= 10 ** 8; result += 8; } if (value >= 10 ** 4) { value /= 10 ** 4; result += 4; } if (value >= 10 ** 2) { value /= 10 ** 2; result += 2; } if (value >= 10 ** 1) { result += 1; } } return result; } /** * @dev Return the log in base 10, following the selected rounding direction, of a positive value. * Returns 0 if given 0. */ function log10(uint256 value, Rounding rounding) internal pure returns (uint256) { unchecked { uint256 result = log10(value); return result + (rounding == Rounding.Up && 10 ** result < value ? 1 : 0); } } /** * @dev Return the log in base 256, rounded down, of a positive value. * Returns 0 if given 0. * * Adding one to the result gives the number of pairs of hex symbols needed to represent `value` as a hex string. */ function log256(uint256 value) internal pure returns (uint256) { uint256 result = 0; unchecked { if (value >> 128 > 0) { value >>= 128; result += 16; } if (value >> 64 > 0) { value >>= 64; result += 8; } if (value >> 32 > 0) { value >>= 32; result += 4; } if (value >> 16 > 0) { value >>= 16; result += 2; } if (value >> 8 > 0) { result += 1; } } return result; } /** * @dev Return the log in base 256, following the selected rounding direction, of a positive value. * Returns 0 if given 0. */ function log256(uint256 value, Rounding rounding) internal pure returns (uint256) { unchecked { uint256 result = log256(value); return result + (rounding == Rounding.Up && 1 << (result << 3) < value ? 1 : 0); } } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.0) (utils/math/SignedMath.sol) pragma solidity ^0.8.0; /** * @dev Standard signed math utilities missing in the Solidity language. */ library SignedMathUpgradeable { /** * @dev Returns the largest of two signed numbers. */ function max(int256 a, int256 b) internal pure returns (int256) { return a > b ? a : b; } /** * @dev Returns the smallest of two signed numbers. */ function min(int256 a, int256 b) internal pure returns (int256) { return a < b ? a : b; } /** * @dev Returns the average of two signed numbers without overflow. * The result is rounded towards zero. */ function average(int256 a, int256 b) internal pure returns (int256) { // Formula from the book "Hacker's Delight" int256 x = (a & b) + ((a ^ b) >> 1); return x + (int256(uint256(x) >> 255) & (a ^ b)); } /** * @dev Returns the absolute unsigned value of a signed value. */ function abs(int256 n) internal pure returns (uint256) { unchecked { // must be unchecked in order to support `n = type(int256).min` return uint256(n >= 0 ? n : -n); } } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.9.0) (utils/Strings.sol) pragma solidity ^0.8.0; import "./math/MathUpgradeable.sol"; import "./math/SignedMathUpgradeable.sol"; /** * @dev String operations. */ library StringsUpgradeable { bytes16 private constant _SYMBOLS = "0123456789abcdef"; uint8 private constant _ADDRESS_LENGTH = 20; /** * @dev Converts a `uint256` to its ASCII `string` decimal representation. */ function toString(uint256 value) internal pure returns (string memory) { unchecked { uint256 length = MathUpgradeable.log10(value) + 1; string memory buffer = new string(length); uint256 ptr; /// @solidity memory-safe-assembly assembly { ptr := add(buffer, add(32, length)) } while (true) { ptr--; /// @solidity memory-safe-assembly assembly { mstore8(ptr, byte(mod(value, 10), _SYMBOLS)) } value /= 10; if (value == 0) break; } return buffer; } } /** * @dev Converts a `int256` to its ASCII `string` decimal representation. */ function toString(int256 value) internal pure returns (string memory) { return string(abi.encodePacked(value < 0 ? "-" : "", toString(SignedMathUpgradeable.abs(value)))); } /** * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation. */ function toHexString(uint256 value) internal pure returns (string memory) { unchecked { return toHexString(value, MathUpgradeable.log256(value) + 1); } } /** * @dev Converts a `uint256` to its ASCII `string` hexadecimal representation with fixed length. */ function toHexString(uint256 value, uint256 length) internal pure returns (string memory) { bytes memory buffer = new bytes(2 * length + 2); buffer[0] = "0"; buffer[1] = "x"; for (uint256 i = 2 * length + 1; i > 1; --i) { buffer[i] = _SYMBOLS[value & 0xf]; value >>= 4; } require(value == 0, "Strings: hex length insufficient"); return string(buffer); } /** * @dev Converts an `address` with fixed length of 20 bytes to its not checksummed ASCII `string` hexadecimal representation. */ function toHexString(address addr) internal pure returns (string memory) { return toHexString(uint256(uint160(addr)), _ADDRESS_LENGTH); } /** * @dev Returns true if the two strings are equal. */ function equal(string memory a, string memory b) internal pure returns (bool) { return keccak256(bytes(a)) == keccak256(bytes(b)); } } // SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.9.0) (utils/structs/BitMaps.sol) pragma solidity ^0.8.0; /** * @dev Library for managing uint256 to bool mapping in a compact and efficient way, providing the keys are sequential. * Largely inspired by Uniswap's https://github.com/Uniswap/merkle-distributor/blob/master/contracts/MerkleDistributor.sol[merkle-distributor]. */ library BitMaps { struct BitMap { mapping(uint256 => uint256) _data; } /** * @dev Returns whether the bit at `index` is set. */ function get(BitMap storage bitmap, uint256 index) internal view returns (bool) { uint256 bucket = index >> 8; uint256 mask = 1 << (index & 0xff); return bitmap._data[bucket] & mask != 0; } /** * @dev Sets the bit at `index` to the boolean `value`. */ function setTo(BitMap storage bitmap, uint256 index, bool value) internal { if (value) { set(bitmap, index); } else { unset(bitmap, index); } } /** * @dev Sets the bit at `index`. */ function set(BitMap storage bitmap, uint256 index) internal { uint256 bucket = index >> 8; uint256 mask = 1 << (index & 0xff); bitmap._data[bucket] |= mask; } /** * @dev Unsets the bit at `index`. */ function unset(BitMap storage bitmap, uint256 index) internal { uint256 bucket = index >> 8; uint256 mask = 1 << (index & 0xff); bitmap._data[bucket] &= ~mask; } } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.19 <=0.8.22; /** * @title Interface declaring generic errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IGenericErrors { /** * @dev Thrown when a parameter is the zero address. */ error ZeroAddressNotAllowed(); } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.19 <=0.8.22; /** * @title Interface declaring pre-existing cross-chain messaging functions, events and errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IMessageService { /** * @dev Emitted when a message is sent. * @dev We include the message hash to save hashing costs on the rollup. */ event MessageSent( address indexed _from, address indexed _to, uint256 _fee, uint256 _value, uint256 _nonce, bytes _calldata, bytes32 indexed _messageHash ); /** * @dev Emitted when a message is claimed. */ event MessageClaimed(bytes32 indexed _messageHash); /** * @dev Thrown when fees are lower than the minimum fee. */ error FeeTooLow(); /** * @dev Thrown when the value sent is less than the fee. * @dev Value to forward on is msg.value - _fee. */ error ValueSentTooLow(); /** * @dev Thrown when the destination address reverts. */ error MessageSendingFailed(address destination); /** * @dev Thrown when the recipient address reverts. */ error FeePaymentFailed(address recipient); /** * @notice Sends a message for transporting from the given chain. * @dev This function should be called with a msg.value = _value + _fee. The fee will be paid on the destination chain. * @param _to The destination address on the destination chain. * @param _fee The message service fee on the origin chain. * @param _calldata The calldata used by the destination message service to call the destination contract. */ function sendMessage(address _to, uint256 _fee, bytes calldata _calldata) external payable; /** * @notice Deliver a message to the destination chain. * @notice Is called by the Postman, dApp or end user. * @param _from The msg.sender calling the origin message service. * @param _to The destination address on the destination chain. * @param _value The value to be transferred to the destination address. * @param _fee The message service fee on the origin chain. * @param _feeRecipient Address that will receive the fees. * @param _calldata The calldata used by the destination message service to call/forward to the destination contract. * @param _nonce Unique message number. */ function claimMessage( address _from, address _to, uint256 _fee, uint256 _value, address payable _feeRecipient, bytes calldata _calldata, uint256 _nonce ) external; /** * @notice Returns the original sender of the message on the origin layer. * @return The original sender of the message on the origin layer. */ function sender() external view returns (address); } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.19 <=0.8.22; /** * @title Interface declaring pre-existing pausing functions, events and errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IPauseManager { /** * @dev Thrown when a specific pause type is paused. */ error IsPaused(uint256 pauseType); /** * @dev Thrown when a specific pause type is not paused and expected to be. */ error IsNotPaused(uint256 pauseType); /** * @dev Emitted when a pause type is paused. */ event Paused(address messageSender, uint256 indexed pauseType); /** * @dev Emitted when a pause type is unpaused. */ event UnPaused(address messageSender, uint256 indexed pauseType); } // SPDX-License-Identifier: Apache-2.0 pragma solidity >=0.8.19 <=0.8.22; /** * @title Interface declaring rate limiting messaging functions, events and errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IRateLimiter { /** * @dev Thrown when an amount breaches the limit in the period. */ error RateLimitExceeded(); /** * @dev Thrown when the period is initialised to zero. */ error PeriodIsZero(); /** * @dev Thrown when the limit is initialised to zero. */ error LimitIsZero(); /** * @dev Emitted when the Rate Limit is initialized. */ event RateLimitInitialized(uint256 periodInSeconds, uint256 limitInWei, uint256 currentPeriodEnd); /** * @dev Emitted when the amount in the period is reset to zero. */ event AmountUsedInPeriodReset(address indexed resettingAddress); /** * @dev Emitted when the limit is changed. * @dev If the current used amount is higher than the new limit, the used amount is lowered to the limit. */ event LimitAmountChanged( address indexed amountChangeBy, uint256 amount, bool amountUsedLoweredToLimit, bool usedAmountResetToZero ); /** * @notice Resets the rate limit amount to the amount specified. * @param _amount sets the new limit amount. */ function resetRateLimitAmount(uint256 _amount) external; /** * @notice Resets the amount used in the period to zero. */ function resetAmountUsedInPeriod() external; } // SPDX-License-Identifier: AGPL-3.0 pragma solidity 0.8.22; /** * @title L1 Message manager interface for current functions, events and errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IL1MessageManager { /** * @dev Emitted when a new message is sent and the rolling hash updated. */ event RollingHashUpdated(uint256 indexed messageNumber, bytes32 indexed rollingHash, bytes32 indexed messageHash); /** * @dev Emitted when the l2 merkle root has been anchored on L1. */ event L2MerkleRootAdded(bytes32 indexed l2MerkleRoot, uint256 indexed treeDepth); /** * @dev Emitted when the l2 block contains L2 messages during finalization */ event L2MessagingBlockAnchored(uint256 indexed l2Block); /** * @dev Thrown when the message has already been claimed. */ error MessageAlreadyClaimed(uint256 messageIndex); /** * @dev Thrown when the L2 merkle root has already been anchored on L1. */ error L2MerkleRootAlreadyAnchored(bytes32 merkleRoot); /** * @dev Thrown when the L2 messaging blocks offsets bytes length is not a multiple of 2. */ error BytesLengthNotMultipleOfTwo(uint256 bytesLength); /** * @notice Check if the L2->L1 message is claimed or not. * @param _messageNumber The message number on L2. */ function isMessageClaimed(uint256 _messageNumber) external view returns (bool); } // SPDX-License-Identifier: Apache-2.0 pragma solidity 0.8.22; /** * @title L1 Message manager V1 interface for pre-existing functions, events and errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IL1MessageManagerV1 { /** * @dev Emitted when L2->L1 message hashes have been added to L1 storage. */ event L2L1MessageHashAddedToInbox(bytes32 indexed messageHash); /** * @dev Emitted when L1->L2 messages have been anchored on L2 and updated on L1. */ event L1L2MessagesReceivedOnL2(bytes32[] messageHashes); /** * @dev Thrown when the message has already been claimed. */ error MessageDoesNotExistOrHasAlreadyBeenClaimed(bytes32 messageHash); /** * @dev Thrown when the message has already been received. */ error MessageAlreadyReceived(bytes32 messageHash); /** * @dev Thrown when the L1->L2 message has not been sent. */ error L1L2MessageNotSent(bytes32 messageHash); } // SPDX-License-Identifier: Apache-2.0 pragma solidity 0.8.22; /** * @title L1 Message Service interface for pre-existing functions, events and errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IL1MessageService { /** * @dev Emitted when initializing Linea Rollup contract with a system migration block. */ event SystemMigrationBlockInitialized(uint256 systemMigrationBlock); /** * @dev Thrown when L2 merkle root does not exist. */ error L2MerkleRootDoesNotExist(); /** * @dev Thrown when the merkle proof is invalid. */ error InvalidMerkleProof(); /** * @dev Thrown when merkle depth doesn't match proof length. */ error ProofLengthDifferentThanMerkleDepth(uint256 actual, uint256 expected); /** * @dev Thrown when the system migration block is 0. */ error SystemMigrationBlockZero(); /** * @param proof The proof array related to the claimed message. * @param messageNumber The message number of the claimed message. * @param leafIndex The leaf index related to the merkle proof of the message. * @param from The address of the original sender. * @param to The address the message is intended for. * @param fee The fee being paid for the message delivery. * @param value The value to be transferred to the destination address. * @param feeRecipient The recipient for the fee. * @param merkleRoot The merkle root of the claimed message. * @param data The calldata to pass to the recipient. */ struct ClaimMessageWithProofParams { bytes32[] proof; uint256 messageNumber; uint32 leafIndex; address from; address to; uint256 fee; uint256 value; address payable feeRecipient; bytes32 merkleRoot; bytes data; } } // SPDX-License-Identifier: Apache-2.0 pragma solidity 0.8.22; /** * @title LineaRollup interface for current functions, events and errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface ILineaRollup { /** * @dev parentStateRootHash is the starting root hash. * @dev dataParentHash is used in order to link data. * @dev finalStateRootHash is used to set next data. * @dev firstBlockInData is the first block that is included in the data submitted. * @dev finalBlockInData is the last block that is included in the data submitted. * @dev snarkHash is the computed hash for compressed data (using a SNARK-friendly hash function) that aggregates per data submission to be used in public input. * @dev compressedData is the compressed transaction data. It contains ordered data for each L2 block - l2Timestamps, the encoded txData. */ struct SubmissionData { bytes32 parentStateRootHash; bytes32 dataParentHash; bytes32 finalStateRootHash; uint256 firstBlockInData; uint256 finalBlockInData; bytes32 snarkHash; bytes compressedData; } /** * @dev parentStateRootHash is the expected last state root hash finalized. * @dev dataHashes is the optional previously submitted compressed data item hashes. * @dev dataParentHash is the last finalized compressed data item hash. * @dev finalBlockNumber is the last block that is being finalized. * @dev lastFinalizedTimestamp is the expected last finalized block's timestamp. * @dev finalTimestamp is the timestamp of the last block being finalized. * @dev l1RollingHash is the calculated rolling hash on L2 that is expected to match L1 at l1RollingHashMessageNumber. * This value will be used along with the stored last finalized L2 calculated rolling hash in the public input. * @dev l1RollingHashMessageNumber is the calculated message number on L2 that is expected to match the existing L1 rolling hash. * This value will be used along with the stored last finalized L2 calculated message number in the public input. * @dev l2MerkleRoots is an array of L2 message merkle roots of depth l2MerkleTreesDepth between last finalized block and finalBlockNumber. * @dev l2MerkleTreesDepth is the depth of all l2MerkleRoots. * @dev l2MessagingBlocksOffsets indicates by offset from currentL2BlockNumber which L2 blocks contain MessageSent events. */ struct FinalizationData { bytes32 parentStateRootHash; bytes32[] dataHashes; bytes32 dataParentHash; uint256 finalBlockNumber; uint256 lastFinalizedTimestamp; uint256 finalTimestamp; bytes32 l1RollingHash; uint256 l1RollingHashMessageNumber; bytes32[] l2MerkleRoots; uint256 l2MerkleTreesDepth; bytes l2MessagingBlocksOffsets; } /** * @dev Emitted when a verifier is set for a particular proof type. */ event VerifierAddressChanged( address indexed verifierAddress, uint256 indexed proofType, address indexed verifierSetBy, address oldVerifierAddress ); /** * @dev Emitted when compressed data is being submitted and verified succesfully on L1. */ event DataSubmitted(bytes32 indexed dataHash, uint256 indexed startBlock, uint256 indexed endBlock); /** * @dev Emitted when L2 blocks have been finalized on L1. */ event DataFinalized( uint256 indexed lastBlockFinalized, bytes32 indexed startingRootHash, bytes32 indexed finalRootHash, bool withProof ); /** * @dev Thrown when the starting block in the data item is out of sequence with the last block number. */ error DataStartingBlockDoesNotMatch(uint256 expected, uint256 actual); /** * @dev Thrown when the ending block in the data item is out of sequence with the finalization data. */ error DataEndingBlockDoesNotMatch(uint256 expected, uint256 actual); /** * @dev Thrown when the expected data item's shnarf is empty. */ error DataParentHasEmptyShnarf(); /** * @dev Thrown when the current data was already submitted. */ error DataAlreadySubmitted(bytes32 currentDataHash); /** * @dev Thrown when parent stateRootHash does not match or is empty. */ error StateRootHashInvalid(bytes32 expected, bytes32 actual); /** * @dev Thrown when submissionData is empty. */ error EmptySubmissionData(); /** * @dev Thrown when finalizationData.dataHashes is empty. */ error FinalizationDataMissing(); /** * @dev Thrown when finalizationData.l1RollingHash does not exist on L1 (Feedback loop). */ error L1RollingHashDoesNotExistOnL1(uint256 messageNumber, bytes32 rollingHash); /** * @dev Thrown when finalizationData.lastFinalizedTimestamp does not match currentTimestamp. */ error TimestampsNotInSequence(uint256 expected, uint256 value); /** * @dev Thrown when the last submissionData finalBlockInData does not match finalizationData.finalBlockNumber. */ error FinalBlockNumberInvalid(uint256 expected, uint256 value); /** * @dev Thrown when finalizationData.dataParentHash does not match parent of _finalizationData.dataHashes[0]. */ error ParentHashesDoesNotMatch(bytes32 firstHash, bytes32 secondHash); /** * @dev Thrown when parent finalStateRootHash does not match _finalizationData.parentStateRootHash. */ error FinalStateRootHashDoesNotMatch(bytes32 firstHash, bytes32 secondHash); /** * @dev Thrown when data hashes are not in sequence. */ error DataHashesNotInSequence(bytes32 expected, bytes32 value); /** * @dev Thrown when the first block is greater than final block in submission data. */ error FirstBlockGreaterThanFinalBlock(uint256 firstBlockNumber, uint256 finalBlockNumber); /** * @dev Thrown when the first block in data is less than or equal to the last finalized block during data submission. */ error FirstBlockLessThanOrEqualToLastFinalizedBlock(uint256 firstBlockNumber, uint256 lastFinalizedBlock); /** * @dev Thrown when the final block number in finalization data is less than or equal to the last finalized block during finalization. */ error FinalBlockNumberLessThanOrEqualToLastFinalizedBlock(uint256 finalBlockNumber, uint256 lastFinalizedBlock); /** * @dev Thrown when the final block state equals the zero hash during finalization. */ error FinalBlockStateEqualsZeroHash(); /** * @dev Thrown when final l2 block timestamp higher than current block.timestamp during finalization. */ error FinalizationInTheFuture(uint256 l2BlockTimestamp, uint256 currentBlockTimestamp); /** * @dev Thrown when a rolling hash is provided without a corresponding message number. */ error MissingMessageNumberForRollingHash(bytes32 rollingHash); /** * @dev Thrown when a message number is provided without a corresponding rolling hash. */ error MissingRollingHashForMessageNumber(uint256 messageNumber); /** * @dev Thrown when the first byte is not zero. * @dev This is used explicitly with the four bytes in assembly 0x729eebce. */ error FirstByteIsNotZero(); /** * @dev Thrown when bytes length is not a multiple of 32. */ error BytesLengthNotMultipleOf32(); /** * @notice Adds or updated the verifier contract address for a proof type. * @dev VERIFIER_SETTER_ROLE is required to execute. * @param _newVerifierAddress The address for the verifier contract. * @param _proofType The proof type being set/updated. */ function setVerifierAddress(address _newVerifierAddress, uint256 _proofType) external; /** * @notice Submit compressed data. * @dev OPERATOR_ROLE is required to execute. * @param _submissionData The full compressed data collection - parentStateRootHash, dataParentHash, * finalStateRootHash, firstBlockInData, finalBlockInData, snarkHash, compressedData. */ function submitData(SubmissionData calldata _submissionData) external; /** * @notice Finalize compressed blocks without proof. * @dev DEFAULT_ADMIN_ROLE is required to execute. * @param _finalizationData The full finalization data. */ function finalizeCompressedBlocksWithoutProof(FinalizationData calldata _finalizationData) external; /** * @notice Finalize compressed blocks with proof. * @dev OPERATOR_ROLE is required to execute. * @param _aggregatedProof The aggregated proof. * @param _proofType The proof type. * @param _finalizationData The full finalization data. */ function finalizeCompressedBlocksWithProof( bytes calldata _aggregatedProof, uint256 _proofType, FinalizationData calldata _finalizationData ) external; } // SPDX-License-Identifier: Apache-2.0 pragma solidity 0.8.22; /** * @title Interface declaring verifier functions. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IPlonkVerifier { /** * @notice Interface for verifier contracts. * @param _proof The proof used to verify. * @param _public_inputs The computed public inputs for the proof verification. */ function Verify(bytes calldata _proof, uint256[] calldata _public_inputs) external returns (bool); } // SPDX-License-Identifier: Apache-2.0 pragma solidity 0.8.22; /** * @title ZkEvm rollup interface for pre-existing functions, events and errors. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ interface IZkEvmV2 { /** * @dev blockRootHash is the calculated root hash of the block. * @dev l2BlockTimestamp corresponds to the time the block was produced. * @dev transactions is the transaction collection on the block RLP encoded. * @dev l2ToL1MsgHashes collection contains all the hashes for L2 to L1 anchoring. * @dev fromAddresses is a concatenation of all the from addresses for the transactions. * @dev batchReceptionIndices defines which transactions in the collection are L2 to L1 messages. */ struct BlockData { bytes32 blockRootHash; uint32 l2BlockTimestamp; bytes[] transactions; bytes32[] l2ToL1MsgHashes; bytes fromAddresses; uint16[] batchReceptionIndices; } /** * @dev Emitted when a L2 block has been finalized on L1 */ event BlockFinalized(uint256 indexed blockNumber, bytes32 indexed stateRootHash, bool indexed finalizedWithProof); /** * @dev Emitted when a L2 blocks have been finalized on L1 */ event BlocksVerificationDone(uint256 indexed lastBlockFinalized, bytes32 startingRootHash, bytes32 finalRootHash); /** * @dev Thrown when l2 block timestamp is not correct */ error BlockTimestampError(uint256 l2BlockTimestamp, uint256 currentBlockTimestamp); /** * @dev Thrown when the starting rootHash does not match the existing state */ error StartingRootHashDoesNotMatch(); /** * @dev Thrown when blockData is empty */ error EmptyBlockDataArray(); /** * @dev Thrown when block contains zero transactions */ error EmptyBlock(); /** * @dev Thrown when zk proof is empty bytes */ error ProofIsEmpty(); /** * @dev Thrown when zk proof type is invalid */ error InvalidProofType(); /** * @dev Thrown when zk proof is invalid */ error InvalidProof(); /** * @notice Finalizes blocks without using a proof * @dev DEFAULT_ADMIN_ROLE is required to execute * @param _calldata The full BlockData collection - block, transaction and log data */ function finalizeBlocksWithoutProof(BlockData[] calldata _calldata) external; /** * @notice Finalizes blocks using a proof. * @dev OPERATOR_ROLE is required to execute. * @dev If the verifier based on proof type is not found, it reverts. * @param _blocksData The full BlockData collection - block, transaction and log data. * @param _proof The proof to be verified with the proof type verifier contract. * @param _proofType The proof type to determine which verifier contract to use. * @param _parentStateRootHash The starting roothash for the last known block. */ function finalizeBlocks( BlockData[] calldata _blocksData, bytes calldata _proof, uint256 _proofType, bytes32 _parentStateRootHash ) external; } // SPDX-License-Identifier: AGPL-3.0 pragma solidity >=0.8.19 <=0.8.22; library Utils { /** * @notice Performs a gas optimized keccak hash. * @param _left Left value. * @param _right Right value. */ function _efficientKeccak(bytes32 _left, bytes32 _right) internal pure returns (bytes32 value) { /// @solidity memory-safe-assembly assembly { mstore(0x00, _left) mstore(0x20, _right) value := keccak256(0x00, 0x40) } } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity 0.8.22; import { AccessControlUpgradeable } from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol"; import { L1MessageService } from "./messageService/l1/L1MessageService.sol"; import { ZkEvmV2 } from "./ZkEvmV2.sol"; import { ILineaRollup } from "./interfaces/l1/ILineaRollup.sol"; /** * @title Contract to manage cross-chain messaging on L1 and rollup proving. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ contract LineaRollup is AccessControlUpgradeable, ZkEvmV2, L1MessageService, ILineaRollup { bytes32 public constant VERIFIER_SETTER_ROLE = keccak256("VERIFIER_SETTER_ROLE"); bytes32 internal constant EMPTY_HASH = 0x0; uint256 internal constant Y_MODULUS = 52435875175126190479447740508185965837690552500527637822603658699938581184513; mapping(bytes32 dataHash => bytes32 finalStateRootHash) public dataFinalStateRootHashes; mapping(bytes32 dataHash => bytes32 parentHash) public dataParents; mapping(bytes32 dataHash => bytes32 shnarfHash) public dataShnarfHashes; mapping(bytes32 dataHash => uint256 startingBlock) public dataStartingBlock; mapping(bytes32 dataHash => uint256 endingBlock) public dataEndingBlock; uint256 public currentL2StoredL1MessageNumber; bytes32 public currentL2StoredL1RollingHash; uint256[50] private __gap_ZkEvm; /// @custom:oz-upgrades-unsafe-allow constructor constructor() { _disableInitializers(); } /** * @notice Initializes LineaRollup and underlying service dependencies. * @dev DEFAULT_ADMIN_ROLE is set for the security council. * @dev OPERATOR_ROLE is set for operators. * @param _initialStateRootHash The initial hash at migration used for proof verification. * @param _initialL2BlockNumber The initial block number at migration. * @param _defaultVerifier The default verifier for rollup proofs. * @param _securityCouncil The address for the security council performing admin operations. * @param _operators The allowed rollup operators at initialization. * @param _rateLimitPeriodInSeconds The period in which withdrawal amounts and fees will be accumulated. * @param _rateLimitAmountInWei The limit allowed for withdrawing in the period. * @param _systemMigrationBlock The service migration block. */ function initialize( bytes32 _initialStateRootHash, uint256 _initialL2BlockNumber, address _defaultVerifier, address _securityCouncil, address[] calldata _operators, uint256 _rateLimitPeriodInSeconds, uint256 _rateLimitAmountInWei, uint256 _systemMigrationBlock ) external initializer { if (_defaultVerifier == address(0)) { revert ZeroAddressNotAllowed(); } for (uint256 i; i < _operators.length; ++i) { if (_operators[i] == address(0)) { revert ZeroAddressNotAllowed(); } _grantRole(OPERATOR_ROLE, _operators[i]); } _grantRole(DEFAULT_ADMIN_ROLE, _securityCouncil); _grantRole(VERIFIER_SETTER_ROLE, _securityCouncil); __ReentrancyGuard_init(); __MessageService_init( _securityCouncil, _securityCouncil, _rateLimitPeriodInSeconds, _rateLimitAmountInWei, _systemMigrationBlock ); verifiers[0] = _defaultVerifier; currentL2BlockNumber = _initialL2BlockNumber; stateRootHashes[_initialL2BlockNumber] = _initialStateRootHash; } /** * @notice Reinitializes the LineaRollup and sets the compressed data migration block. * @param _systemMigrationBlock The block number we are synchronizing from. * @dev This must be called in the same upgrade transaction to avoid issues. * @dev __SystemMigrationBlock_init validates the block value. */ function initializeSystemMigrationBlock(uint256 _systemMigrationBlock) external reinitializer(2) { __SystemMigrationBlock_init(_systemMigrationBlock); } /** * @notice Adds or updates the verifier contract address for a proof type. * @dev VERIFIER_SETTER_ROLE is required to execute. * @param _newVerifierAddress The address for the verifier contract. * @param _proofType The proof type being set/updated. */ function setVerifierAddress(address _newVerifierAddress, uint256 _proofType) external onlyRole(VERIFIER_SETTER_ROLE) { if (_newVerifierAddress == address(0)) { revert ZeroAddressNotAllowed(); } emit VerifierAddressChanged(_newVerifierAddress, _proofType, msg.sender, verifiers[_proofType]); verifiers[_proofType] = _newVerifierAddress; } /** * @notice Submit compressed data. * @dev OPERATOR_ROLE is required to execute. * @param _submissionData The full compressed data collection - parentStateRootHash, dataParentHash, * finalStateRootHash, firstBlockInData, finalBlockInData, snarkHash, compressedData. */ function submitData( SubmissionData calldata _submissionData ) external whenTypeAndGeneralNotPaused(PROVING_SYSTEM_PAUSE_TYPE) onlyRole(OPERATOR_ROLE) { _submitData(_submissionData); } /** * @notice Internal function to submit compressed data. * @param _submissionData The full compressed data collection - parentStateRootHash, dataParentHash, * finalStateRootHash, firstBlockInData, finalBlockInData, snarkHash, compressedData. */ function _submitData(SubmissionData calldata _submissionData) internal returns (bytes32 shnarf) { if (_submissionData.compressedData.length == 0) { revert EmptySubmissionData(); } if (_submissionData.finalStateRootHash == EMPTY_HASH) { revert FinalBlockStateEqualsZeroHash(); } shnarf = dataShnarfHashes[_submissionData.dataParentHash]; bytes32 parentFinalStateRootHash = dataFinalStateRootHashes[_submissionData.dataParentHash]; uint256 lastFinalizedBlock = currentL2BlockNumber; uint256 parentEndingBlock = dataEndingBlock[_submissionData.dataParentHash]; // once upgraded, this initial condition will be removed - the internals remain if (_submissionData.dataParentHash != EMPTY_HASH) { if (parentFinalStateRootHash == EMPTY_HASH) { revert StateRootHashInvalid(parentFinalStateRootHash, _submissionData.parentStateRootHash); } uint256 expectedStartingBlock = parentEndingBlock + 1; if (expectedStartingBlock != _submissionData.firstBlockInData) { revert DataStartingBlockDoesNotMatch(expectedStartingBlock, _submissionData.firstBlockInData); } if (shnarf == EMPTY_HASH) { revert DataParentHasEmptyShnarf(); } } if (_submissionData.firstBlockInData <= lastFinalizedBlock) { revert FirstBlockLessThanOrEqualToLastFinalizedBlock(_submissionData.firstBlockInData, lastFinalizedBlock); } if (_submissionData.firstBlockInData > _submissionData.finalBlockInData) { revert FirstBlockGreaterThanFinalBlock(_submissionData.firstBlockInData, _submissionData.finalBlockInData); } if (_submissionData.parentStateRootHash != parentFinalStateRootHash) { revert StateRootHashInvalid(parentFinalStateRootHash, _submissionData.parentStateRootHash); } bytes32 currentDataHash = keccak256(_submissionData.compressedData); if (dataFinalStateRootHashes[currentDataHash] != EMPTY_HASH) { revert DataAlreadySubmitted(currentDataHash); } dataParents[currentDataHash] = _submissionData.dataParentHash; dataFinalStateRootHashes[currentDataHash] = _submissionData.finalStateRootHash; dataStartingBlock[currentDataHash] = _submissionData.firstBlockInData; dataEndingBlock[currentDataHash] = _submissionData.finalBlockInData; bytes32 compressedDataComputedX = keccak256(abi.encode(_submissionData.snarkHash, currentDataHash)); shnarf = keccak256( abi.encode( shnarf, _submissionData.snarkHash, _submissionData.finalStateRootHash, compressedDataComputedX, _calculateY(_submissionData.compressedData, compressedDataComputedX) ) ); dataShnarfHashes[currentDataHash] = shnarf; emit DataSubmitted(currentDataHash, _submissionData.firstBlockInData, _submissionData.finalBlockInData); } /** * @notice Finalize compressed blocks with proof. * @dev OPERATOR_ROLE is required to execute. * @param _aggregatedProof The aggregated proof. * @param _proofType The proof type. * @param _finalizationData The full finalization data. */ function finalizeCompressedBlocksWithProof( bytes calldata _aggregatedProof, uint256 _proofType, FinalizationData calldata _finalizationData ) external whenTypeAndGeneralNotPaused(PROVING_SYSTEM_PAUSE_TYPE) onlyRole(OPERATOR_ROLE) { if (_aggregatedProof.length == 0) { revert ProofIsEmpty(); } uint256 lastFinalizedBlockNumber = currentL2BlockNumber; if (stateRootHashes[lastFinalizedBlockNumber] != _finalizationData.parentStateRootHash) { revert StartingRootHashDoesNotMatch(); } uint256 lastFinalizedL2StoredL1MessageNumber = currentL2StoredL1MessageNumber; bytes32 lastFinalizedL2StoredL1RollingHash = currentL2StoredL1RollingHash; _finalizeCompressedBlocks(_finalizationData, lastFinalizedBlockNumber, true); bytes32 shnarf; unchecked { shnarf = dataShnarfHashes[_finalizationData.dataHashes[_finalizationData.dataHashes.length - 1]]; if (shnarf == EMPTY_HASH) { revert DataParentHasEmptyShnarf(); } } uint256 publicInput = uint256( keccak256( bytes.concat( abi.encode( shnarf, _finalizationData.parentStateRootHash, _finalizationData.lastFinalizedTimestamp, _finalizationData.finalTimestamp, lastFinalizedBlockNumber, _finalizationData.finalBlockNumber ), abi.encode( lastFinalizedL2StoredL1RollingHash, _finalizationData.l1RollingHash, lastFinalizedL2StoredL1MessageNumber, _finalizationData.l1RollingHashMessageNumber, _finalizationData.l2MerkleTreesDepth, keccak256(abi.encodePacked(_finalizationData.l2MerkleRoots)) ) ) ) ); assembly { publicInput := mod(publicInput, MODULO_R) } _verifyProof(publicInput, _proofType, _aggregatedProof, _finalizationData.parentStateRootHash); } /** * @notice Finalize compressed blocks without proof. * @dev DEFAULT_ADMIN_ROLE is required to execute. * @param _finalizationData The simplified finalization data without proof. */ function finalizeCompressedBlocksWithoutProof( FinalizationData calldata _finalizationData ) external whenTypeNotPaused(GENERAL_PAUSE_TYPE) onlyRole(DEFAULT_ADMIN_ROLE) { uint256 lastFinalizedBlock = currentL2BlockNumber; _finalizeCompressedBlocks(_finalizationData, lastFinalizedBlock, false); } /** * @notice Internal function to finalize compressed blocks. * @param _finalizationData The full finalization data. * @param _lastFinalizedBlock The last finalized block. * @param _withProof If we are finalizing with a proof. */ function _finalizeCompressedBlocks( FinalizationData calldata _finalizationData, uint256 _lastFinalizedBlock, bool _withProof ) internal { uint256 finalizationDataDataHashesLength = _finalizationData.dataHashes.length; if (finalizationDataDataHashesLength == 0) { revert FinalizationDataMissing(); } if (_finalizationData.finalBlockNumber <= _lastFinalizedBlock) { revert FinalBlockNumberLessThanOrEqualToLastFinalizedBlock( _finalizationData.finalBlockNumber, _lastFinalizedBlock ); } _validateL2ComputedRollingHash(_finalizationData.l1RollingHashMessageNumber, _finalizationData.l1RollingHash); if (currentTimestamp != _finalizationData.lastFinalizedTimestamp) { revert TimestampsNotInSequence(currentTimestamp, _finalizationData.lastFinalizedTimestamp); } if (_finalizationData.finalTimestamp >= block.timestamp) { revert FinalizationInTheFuture(_finalizationData.finalTimestamp, block.timestamp); } bytes32 startingDataParentHash = dataParents[_finalizationData.dataHashes[0]]; if (startingDataParentHash != _finalizationData.dataParentHash) { revert ParentHashesDoesNotMatch(startingDataParentHash, _finalizationData.dataParentHash); } bytes32 startingParentFinalStateRootHash = dataFinalStateRootHashes[startingDataParentHash]; // once upgraded, this initial condition will be removed - the internals remain if (startingDataParentHash != EMPTY_HASH) { if (startingParentFinalStateRootHash != _finalizationData.parentStateRootHash) { revert FinalStateRootHashDoesNotMatch(startingParentFinalStateRootHash, _finalizationData.parentStateRootHash); } } bytes32 finalBlockState = dataFinalStateRootHashes[ _finalizationData.dataHashes[finalizationDataDataHashesLength - 1] ]; if (finalBlockState == EMPTY_HASH) { revert FinalBlockStateEqualsZeroHash(); } _addL2MerkleRoots(_finalizationData.l2MerkleRoots, _finalizationData.l2MerkleTreesDepth); _anchorL2MessagingBlocks(_finalizationData.l2MessagingBlocksOffsets, _lastFinalizedBlock); for (uint256 i = 1; i < finalizationDataDataHashesLength; ++i) { unchecked { if (dataParents[_finalizationData.dataHashes[i]] != _finalizationData.dataHashes[i - 1]) { revert DataHashesNotInSequence( _finalizationData.dataHashes[i - 1], dataParents[_finalizationData.dataHashes[i]] ); } } } uint256 suppliedStartingBlock = dataStartingBlock[_finalizationData.dataHashes[0]]; uint256 suppliedFinalBlock = dataEndingBlock[_finalizationData.dataHashes[finalizationDataDataHashesLength - 1]]; // check final item supplied matches if (suppliedFinalBlock != _finalizationData.finalBlockNumber) { revert DataEndingBlockDoesNotMatch(suppliedFinalBlock, _finalizationData.finalBlockNumber); } // check suppliedStartingBlock is 1 more than the last finalized block if (suppliedStartingBlock != _lastFinalizedBlock + 1) { revert DataStartingBlockDoesNotMatch(_lastFinalizedBlock + 1, suppliedStartingBlock); } stateRootHashes[_finalizationData.finalBlockNumber] = finalBlockState; currentTimestamp = _finalizationData.finalTimestamp; currentL2BlockNumber = _finalizationData.finalBlockNumber; currentL2StoredL1MessageNumber = _finalizationData.l1RollingHashMessageNumber; currentL2StoredL1RollingHash = _finalizationData.l1RollingHash; emit DataFinalized( _finalizationData.finalBlockNumber, _finalizationData.parentStateRootHash, finalBlockState, _withProof ); } /** * @notice Private function to validate l1 rolling hash. * @param _rollingHashMessageNumber Message number associated with the rolling hash as computed on L2. * @param _rollingHash L1 rolling hash as computed on L2. */ function _validateL2ComputedRollingHash(uint256 _rollingHashMessageNumber, bytes32 _rollingHash) internal view { if (_rollingHashMessageNumber == 0) { if (_rollingHash != EMPTY_HASH) { revert MissingMessageNumberForRollingHash(_rollingHash); } } else { if (_rollingHash == EMPTY_HASH) { revert MissingRollingHashForMessageNumber(_rollingHashMessageNumber); } if (rollingHashes[_rollingHashMessageNumber] != _rollingHash) { revert L1RollingHashDoesNotExistOnL1(_rollingHashMessageNumber, _rollingHash); } } } /** * @notice Internal function to calculate Y for public input generation. * @param _data Compressed data from submission data. * @param _compressedDataComputedX Computed X for public input generation. * @dev Each chunk of 32 bytes must start with a 0 byte. * @dev The compressedDataComputedX value is modulo-ed down during the computation and scalar field checking is not needed. * @dev There is a hard constraint in the circuit to enforce the polynomial degree limit (4096), which will also be enforced with EIP-4844. * @return compressedDataComputedY The Y calculated value using the Horner method. */ function _calculateY( bytes calldata _data, bytes32 _compressedDataComputedX ) internal pure returns (bytes32 compressedDataComputedY) { if (_data.length % 0x20 != 0) { revert BytesLengthNotMultipleOf32(); } bytes4 errorSelector = ILineaRollup.FirstByteIsNotZero.selector; assembly { for { let i := _data.length } gt(i, 0) { } { i := sub(i, 0x20) let chunk := calldataload(add(_data.offset, i)) if iszero(iszero(and(chunk, 0xFF00000000000000000000000000000000000000000000000000000000000000))) { let ptr := mload(0x40) mstore(ptr, errorSelector) revert(ptr, 0x4) } compressedDataComputedY := addmod( mulmod(compressedDataComputedY, _compressedDataComputedX, Y_MODULUS), chunk, Y_MODULUS ) } } } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity 0.8.22; import { BitMaps } from "@openzeppelin/contracts/utils/structs/BitMaps.sol"; import { L1MessageManagerV1 } from "./v1/L1MessageManagerV1.sol"; import { IL1MessageManager } from "../../interfaces/l1/IL1MessageManager.sol"; import { Utils } from "../../lib/Utils.sol"; /** * @title Contract to manage cross-chain message rolling hash computation and storage on L1. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ abstract contract L1MessageManager is L1MessageManagerV1, IL1MessageManager { using BitMaps for BitMaps.BitMap; using Utils for *; mapping(uint256 messageNumber => bytes32 rollingHash) public rollingHashes; BitMaps.BitMap internal _messageClaimedBitMap; mapping(bytes32 merkleRoot => uint256 treeDepth) public l2MerkleRootsDepths; /// @dev Keep free storage slots for future implementation updates to avoid storage collision. uint256[50] private __gap_L1MessageManager; /** * @notice Take an existing message hash, calculates the rolling hash and stores at the message number. * @param _messageNumber The current message number being sent. * @param _messageHash The hash of the message being sent. */ function _addRollingHash(uint256 _messageNumber, bytes32 _messageHash) internal { unchecked { bytes32 newRollingHash = Utils._efficientKeccak(rollingHashes[_messageNumber - 1], _messageHash); rollingHashes[_messageNumber] = newRollingHash; emit RollingHashUpdated(_messageNumber, newRollingHash, _messageHash); } } /** * @notice Set the L2->L1 message as claimed when a user claims a message on L1. * @param _messageNumber The message number on L2. */ function _setL2L1MessageToClaimed(uint256 _messageNumber) internal { if (_messageClaimedBitMap.get(_messageNumber)) { revert MessageAlreadyClaimed(_messageNumber); } _messageClaimedBitMap.set(_messageNumber); } /** * @notice Add the L2 merkle roots to the storage. * @dev This function is called during block finalization. * @param _newRoots New L2 merkle roots. */ function _addL2MerkleRoots(bytes32[] calldata _newRoots, uint256 _treeDepth) internal { for (uint256 i; i < _newRoots.length; ++i) { if (l2MerkleRootsDepths[_newRoots[i]] != 0) { revert L2MerkleRootAlreadyAnchored(_newRoots[i]); } l2MerkleRootsDepths[_newRoots[i]] = _treeDepth; emit L2MerkleRootAdded(_newRoots[i], _treeDepth); } } /** * @notice Emit an event for each L2 block containing L2->L1 messages. * @dev This function is called during block finalization. * @param _l2MessagingBlocksOffsets Is a sequence of uint16 values, where each value plus the last finalized L2 block number. * indicates which L2 blocks have L2->L1 messages. * @param _currentL2BlockNumber Last L2 block number finalized on L1. */ function _anchorL2MessagingBlocks(bytes calldata _l2MessagingBlocksOffsets, uint256 _currentL2BlockNumber) internal { if (_l2MessagingBlocksOffsets.length % 2 != 0) { revert BytesLengthNotMultipleOfTwo(_l2MessagingBlocksOffsets.length); } uint256 l2BlockOffset; unchecked { for (uint256 i; i < _l2MessagingBlocksOffsets.length; ) { assembly { l2BlockOffset := shr(240, calldataload(add(_l2MessagingBlocksOffsets.offset, i))) } emit L2MessagingBlockAnchored(_currentL2BlockNumber + l2BlockOffset); i += 2; } } } /** * @notice Check if the L2->L1 message is claimed or not. * @param _messageNumber The message number on L2. */ function isMessageClaimed(uint256 _messageNumber) external view returns (bool) { return _messageClaimedBitMap.get(_messageNumber); } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity 0.8.22; import { AccessControlUpgradeable } from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol"; import { L1MessageServiceV1 } from "./v1/L1MessageServiceV1.sol"; import { L1MessageManager } from "./L1MessageManager.sol"; import { IL1MessageService } from "../../interfaces/l1/IL1MessageService.sol"; import { IGenericErrors } from "../../interfaces/IGenericErrors.sol"; import { SparseMerkleTreeVerifier } from "../lib/SparseMerkleTreeVerifier.sol"; /** * @title Contract to manage cross-chain messaging on L1. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ abstract contract L1MessageService is AccessControlUpgradeable, L1MessageServiceV1, L1MessageManager, IL1MessageService, IGenericErrors { using SparseMerkleTreeVerifier for *; uint256 public systemMigrationBlock; // Keep free storage slots for future implementation updates to avoid storage collision. uint256[50] private __gap_L1MessageService; /** * @notice Initialises underlying message service dependencies. * @dev _messageSender is initialised to a non-zero value for gas efficiency on claiming. * @param _limitManagerAddress The address owning the rate limiting management role. * @param _pauseManagerAddress The address owning the pause management role. * @param _rateLimitPeriod The period to rate limit against. * @param _rateLimitAmount The limit allowed for withdrawing the period. * @param _systemMigrationBlock The service migration block. */ function __MessageService_init( address _limitManagerAddress, address _pauseManagerAddress, uint256 _rateLimitPeriod, uint256 _rateLimitAmount, uint256 _systemMigrationBlock ) internal onlyInitializing { if (_limitManagerAddress == address(0)) { revert ZeroAddressNotAllowed(); } if (_pauseManagerAddress == address(0)) { revert ZeroAddressNotAllowed(); } __ERC165_init(); __Context_init(); __AccessControl_init(); __RateLimiter_init(_rateLimitPeriod, _rateLimitAmount); _grantRole(RATE_LIMIT_SETTER_ROLE, _limitManagerAddress); _grantRole(PAUSE_MANAGER_ROLE, _pauseManagerAddress); __SystemMigrationBlock_init(_systemMigrationBlock); nextMessageNumber = 1; _messageSender = DEFAULT_SENDER_ADDRESS; } /** * @notice Initializer function when upgrading. * @dev Sets the systemMigrationBlock when the migration will occur. * @param _systemMigrationBlock The future migration block. */ function __SystemMigrationBlock_init(uint256 _systemMigrationBlock) internal onlyInitializing { if (_systemMigrationBlock == 0) { revert SystemMigrationBlockZero(); } systemMigrationBlock = _systemMigrationBlock; emit SystemMigrationBlockInitialized(systemMigrationBlock); } /** * @notice Adds a message for sending cross-chain and emits MessageSent. * @dev The message number is preset (nextMessageNumber) and only incremented at the end if successful for the next caller. * @dev This function should be called with a msg.value = _value + _fee. The fee will be paid on the destination chain. * @param _to The address the message is intended for. * @param _fee The fee being paid for the message delivery. * @param _calldata The calldata to pass to the recipient. */ function sendMessage( address _to, uint256 _fee, bytes calldata _calldata ) external payable whenTypeAndGeneralNotPaused(L1_L2_PAUSE_TYPE) { if (_to == address(0)) { revert ZeroAddressNotAllowed(); } if (_fee > msg.value) { revert ValueSentTooLow(); } uint256 messageNumber = nextMessageNumber++; uint256 valueSent = msg.value - _fee; bytes32 messageHash = keccak256(abi.encode(msg.sender, _to, _fee, valueSent, messageNumber, _calldata)); if (systemMigrationBlock > block.number) { _addL1L2MessageHash(messageHash); } else { _addRollingHash(messageNumber, messageHash); } emit MessageSent(msg.sender, _to, _fee, valueSent, messageNumber, _calldata, messageHash); } /** * @notice Claims and delivers a cross-chain message using merkle proof. * @dev if merkle depth is empty, it will revert with L2MerkleRootDoesNotExist. * @dev if merkle depth is different than proof size, it will revert with ProofLengthDifferentThanMerkleDepth. * @param _params Collection of claim data with proof and supporting data. */ function claimMessageWithProof( ClaimMessageWithProofParams calldata _params ) external nonReentrant distributeFees(_params.fee, _params.to, _params.data, _params.feeRecipient) { _requireTypeAndGeneralNotPaused(L2_L1_PAUSE_TYPE); uint256 merkleDepth = l2MerkleRootsDepths[_params.merkleRoot]; if (merkleDepth == 0) { revert L2MerkleRootDoesNotExist(); } if (merkleDepth != _params.proof.length) { revert ProofLengthDifferentThanMerkleDepth(merkleDepth, _params.proof.length); } _setL2L1MessageToClaimed(_params.messageNumber); _addUsedAmount(_params.fee + _params.value); bytes32 messageLeafHash = keccak256( abi.encode(_params.from, _params.to, _params.fee, _params.value, _params.messageNumber, _params.data) ); if ( !SparseMerkleTreeVerifier._verifyMerkleProof( messageLeafHash, _params.proof, _params.leafIndex, _params.merkleRoot ) ) { revert InvalidMerkleProof(); } _messageSender = _params.from; (bool callSuccess, bytes memory returnData) = _params.to.call{ value: _params.value }(_params.data); if (!callSuccess) { if (returnData.length > 0) { assembly { let data_size := mload(returnData) revert(add(32, returnData), data_size) } } else { revert MessageSendingFailed(_params.to); } } _messageSender = DEFAULT_SENDER_ADDRESS; emit MessageClaimed(messageLeafHash); } /** * @notice Claims and delivers a cross-chain message. * @dev _messageSender is set temporarily when claiming. */ function sender() external view returns (address) { return _messageSender; } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity 0.8.22; import { IL1MessageManagerV1 } from "../../../interfaces/l1/IL1MessageManagerV1.sol"; /** * @title Contract to manage cross-chain message hashes storage and status on L1. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ abstract contract L1MessageManagerV1 is IL1MessageManagerV1 { uint8 public constant INBOX_STATUS_UNKNOWN = 0; uint8 public constant INBOX_STATUS_RECEIVED = 1; uint8 public constant OUTBOX_STATUS_UNKNOWN = 0; uint8 public constant OUTBOX_STATUS_SENT = 1; uint8 public constant OUTBOX_STATUS_RECEIVED = 2; /// @dev Mapping to store L1->L2 message hashes status. /// @dev messageHash => messageStatus (0: unknown, 1: sent, 2: received). mapping(bytes32 messageHash => uint256 messageStatus) public outboxL1L2MessageStatus; /// @dev Mapping to store L2->L1 message hashes status. /// @dev messageHash => messageStatus (0: unknown, 1: received). mapping(bytes32 messageHash => uint256 messageStatus) public inboxL2L1MessageStatus; /// @dev Keep free storage slots for future implementation updates to avoid storage collision. // ******************************************************************************************* // NB: THIS GAP HAS BEEN PUSHED OUT IN FAVOUR OF THE GAP INSIDE THE REENTRANCY CODE //uint256[50] private __gap; // NB: DO NOT USE THIS GAP // ******************************************************************************************* /** * @notice Add cross-chain L2->L1 message hash in storage. * @dev Once the event is emitted, it should be ready for claiming (post block finalization). * @param _messageHash Hash of the message. */ function _addL2L1MessageHash(bytes32 _messageHash) internal { if (inboxL2L1MessageStatus[_messageHash] != INBOX_STATUS_UNKNOWN) { revert MessageAlreadyReceived(_messageHash); } inboxL2L1MessageStatus[_messageHash] = INBOX_STATUS_RECEIVED; emit L2L1MessageHashAddedToInbox(_messageHash); } /** * @notice Update the status of L2->L1 message when a user claims a message on L1. * @dev The L2->L1 message is removed from storage. * @dev Due to the nature of the rollup, we should not get a second entry of this. * @param _messageHash Hash of the message. */ function _updateL2L1MessageStatusToClaimed(bytes32 _messageHash) internal { if (inboxL2L1MessageStatus[_messageHash] != INBOX_STATUS_RECEIVED) { revert MessageDoesNotExistOrHasAlreadyBeenClaimed(_messageHash); } delete inboxL2L1MessageStatus[_messageHash]; } /** * @notice Add L1->L2 message hash in storage when a message is sent on L1. * @param _messageHash Hash of the message. */ function _addL1L2MessageHash(bytes32 _messageHash) internal { outboxL1L2MessageStatus[_messageHash] = OUTBOX_STATUS_SENT; } /** * @notice Update the status of L1->L2 messages as received when messages have been stored on L2. * @dev The expectation here is that the rollup is limited to 100 hashes being added here - array is not open ended. * @param _messageHashes List of message hashes. */ function _updateL1L2MessageStatusToReceived(bytes32[] memory _messageHashes) internal { uint256 messageHashArrayLength = _messageHashes.length; for (uint256 i; i < messageHashArrayLength; ++i) { bytes32 messageHash = _messageHashes[i]; uint256 existingStatus = outboxL1L2MessageStatus[messageHash]; if (existingStatus == OUTBOX_STATUS_UNKNOWN) { revert L1L2MessageNotSent(messageHash); } if (existingStatus != OUTBOX_STATUS_RECEIVED) { outboxL1L2MessageStatus[messageHash] = OUTBOX_STATUS_RECEIVED; } } emit L1L2MessagesReceivedOnL2(_messageHashes); } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity 0.8.22; import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; import { ReentrancyGuardUpgradeable } from "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol"; import { PauseManager } from "../../lib/PauseManager.sol"; import { RateLimiter } from "../../lib/RateLimiter.sol"; import { L1MessageManagerV1 } from "./L1MessageManagerV1.sol"; import { IMessageService } from "../../../interfaces/IMessageService.sol"; /** * @title Contract to manage cross-chain messaging on L1. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ abstract contract L1MessageServiceV1 is Initializable, RateLimiter, L1MessageManagerV1, ReentrancyGuardUpgradeable, PauseManager, IMessageService { // @dev This is initialised to save user cost with existing slot. uint256 public nextMessageNumber; address internal _messageSender; // Keep free storage slots for future implementation updates to avoid storage collision. uint256[50] private __gap; // @dev adding these should not affect storage as they are constants and are stored in bytecode. uint256 internal constant REFUND_OVERHEAD_IN_GAS = 48252; address internal constant DEFAULT_SENDER_ADDRESS = address(123456789); /** * @notice The unspent fee is refunded if applicable. * @param _feeInWei The fee paid for delivery in Wei. * @param _to The recipient of the message and gas refund. * @param _calldata The calldata of the message. */ modifier distributeFees( uint256 _feeInWei, address _to, bytes calldata _calldata, address _feeRecipient ) { //pre-execution uint256 startingGas = gasleft(); _; //post-execution // we have a fee if (_feeInWei > 0) { // default postman fee uint256 deliveryFee = _feeInWei; // do we have empty calldata? if (_calldata.length == 0) { bool isDestinationEOA; assembly { isDestinationEOA := iszero(extcodesize(_to)) } // are we calling an EOA if (isDestinationEOA) { // initial + cost to call and refund minus gasleft deliveryFee = (startingGas + REFUND_OVERHEAD_IN_GAS - gasleft()) * tx.gasprice; if (_feeInWei > deliveryFee) { payable(_to).send(_feeInWei - deliveryFee); } else { deliveryFee = _feeInWei; } } } address feeReceiver = _feeRecipient == address(0) ? msg.sender : _feeRecipient; bool callSuccess = payable(feeReceiver).send(deliveryFee); if (!callSuccess) { revert FeePaymentFailed(feeReceiver); } } } /** * @notice Claims and delivers a cross-chain message. * @dev _feeRecipient can be set to address(0) to receive as msg.sender. * @dev _messageSender is set temporarily when claiming and reset post. Used in sender(). * @dev _messageSender is reset to DEFAULT_SENDER_ADDRESS to be more gas efficient. * @param _from The address of the original sender. * @param _to The address the message is intended for. * @param _fee The fee being paid for the message delivery. * @param _value The value to be transferred to the destination address. * @param _feeRecipient The recipient for the fee. * @param _calldata The calldata to pass to the recipient. * @param _nonce The unique auto generated nonce used when sending the message. */ function claimMessage( address _from, address _to, uint256 _fee, uint256 _value, address payable _feeRecipient, bytes calldata _calldata, uint256 _nonce ) external nonReentrant distributeFees(_fee, _to, _calldata, _feeRecipient) { _requireTypeAndGeneralNotPaused(L2_L1_PAUSE_TYPE); bytes32 messageHash = keccak256(abi.encode(_from, _to, _fee, _value, _nonce, _calldata)); // @dev Status check and revert is in the message manager. _updateL2L1MessageStatusToClaimed(messageHash); _addUsedAmount(_fee + _value); _messageSender = _from; (bool callSuccess, bytes memory returnData) = _to.call{ value: _value }(_calldata); if (!callSuccess) { if (returnData.length > 0) { assembly { let data_size := mload(returnData) revert(add(32, returnData), data_size) } } else { revert MessageSendingFailed(_to); } } _messageSender = DEFAULT_SENDER_ADDRESS; emit MessageClaimed(messageHash); } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity >=0.8.19 <=0.8.22; /** * @title Decoding functions for message service anchoring and bytes slicing. * @author ConsenSys Software Inc. * @notice You can use this to slice bytes and extract anchoring hashes from calldata. * @custom:security-contact [email protected] */ library CodecV2 { /** * @notice Decodes a collection of bytes32 (hashes) from the calldata of a transaction. * @dev Extracts and decodes skipping the function selector (selector is expected in the input). * @dev A check beforehand must be performed to confirm this is the correct type of transaction. * @dev NB: A memory manipulation strips out the function signature, do not reuse. * @param _calldataWithSelector The calldata for the transaction. * @return bytes32[] - array of message hashes. */ function _extractXDomainAddHashes(bytes memory _calldataWithSelector) internal pure returns (bytes32[] memory) { assembly { let len := sub(mload(_calldataWithSelector), 4) _calldataWithSelector := add(_calldataWithSelector, 0x4) mstore(_calldataWithSelector, len) } return abi.decode(_calldataWithSelector, (bytes32[])); } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity >=0.8.19 <=0.8.22; import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; import { AccessControlUpgradeable } from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol"; import { IPauseManager } from "../../interfaces/IPauseManager.sol"; /** * @title Contract to manage cross-chain function pausing. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ abstract contract PauseManager is Initializable, IPauseManager, AccessControlUpgradeable { bytes32 public constant PAUSE_MANAGER_ROLE = keccak256("PAUSE_MANAGER_ROLE"); uint8 public constant GENERAL_PAUSE_TYPE = 1; uint8 public constant L1_L2_PAUSE_TYPE = 2; uint8 public constant L2_L1_PAUSE_TYPE = 3; uint8 public constant PROVING_SYSTEM_PAUSE_TYPE = 4; // @dev DEPRECATED. USE _pauseTypeStatusesBitMap INSTEAD mapping(bytes32 pauseType => bool pauseStatus) public pauseTypeStatuses; uint256 private _pauseTypeStatusesBitMap; uint256[9] private __gap; /** * @dev Modifier to make a function callable only when the specific and general types are not paused. * @param _pauseType The pause type value being checked. * Requirements: * * - The type must not be paused. */ modifier whenTypeAndGeneralNotPaused(uint8 _pauseType) { _requireTypeAndGeneralNotPaused(_pauseType); _; } /** * @dev Modifier to make a function callable only when the type is not paused. * @param _pauseType The pause type value being checked. * Requirements: * * - The type must not be paused. */ modifier whenTypeNotPaused(uint8 _pauseType) { _requireTypeNotPaused(_pauseType); _; } /** * @dev Throws if the specific or general types are paused. * @dev Checks the specific and general pause types. * @param _pauseType The pause type value being checked. */ function _requireTypeAndGeneralNotPaused(uint8 _pauseType) internal view virtual { uint256 pauseBitMap = _pauseTypeStatusesBitMap; if (pauseBitMap & (1 << uint256(_pauseType)) != 0) { revert IsPaused(_pauseType); } if (pauseBitMap & (1 << uint256(GENERAL_PAUSE_TYPE)) != 0) { revert IsPaused(GENERAL_PAUSE_TYPE); } } /** * @dev Throws if the type is paused. * @dev Checks the specific pause type. * @param _pauseType The pause type value being checked. */ function _requireTypeNotPaused(uint8 _pauseType) internal view virtual { if (isPaused(_pauseType)) { revert IsPaused(_pauseType); } } /** * @notice Pauses functionality by specific type. * @dev Requires PAUSE_MANAGER_ROLE. * @param _pauseType The pause type value. */ function pauseByType(uint8 _pauseType) external onlyRole(PAUSE_MANAGER_ROLE) { if (isPaused(_pauseType)) { revert IsPaused(_pauseType); } _pauseTypeStatusesBitMap |= 1 << uint256(_pauseType); emit Paused(_msgSender(), _pauseType); } /** * @notice Unpauses functionality by specific type. * @dev Requires PAUSE_MANAGER_ROLE. * @param _pauseType The pause type value. */ function unPauseByType(uint8 _pauseType) external onlyRole(PAUSE_MANAGER_ROLE) { if (!isPaused(_pauseType)) { revert IsNotPaused(_pauseType); } _pauseTypeStatusesBitMap &= ~(1 << uint256(_pauseType)); emit UnPaused(_msgSender(), _pauseType); } /** * @notice Check if a pause type is enabled. * @param _pauseType The pause type value. * @return boolean True if the pause type if enabled, false otherwise. */ function isPaused(uint8 _pauseType) public view returns (bool) { return (_pauseTypeStatusesBitMap & (1 << uint256(_pauseType))) != 0; } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity >=0.8.19 <=0.8.22; import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; import { AccessControlUpgradeable } from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol"; import { IRateLimiter } from "../../interfaces/IRateLimiter.sol"; /** * @title Rate Limiter by period and amount using the block timestamp. * @author ConsenSys Software Inc. * @notice You can use this control numeric limits over a period using timestamp. * @custom:security-contact [email protected] */ contract RateLimiter is Initializable, IRateLimiter, AccessControlUpgradeable { bytes32 public constant RATE_LIMIT_SETTER_ROLE = keccak256("RATE_LIMIT_SETTER_ROLE"); uint256 public periodInSeconds; // how much time before limit resets. uint256 public limitInWei; // max ether to withdraw per period. // @dev Public for ease of consumption. // @notice The time at which the current period ends at. uint256 public currentPeriodEnd; // @dev Public for ease of consumption. // @notice Amounts already withdrawn this period. uint256 public currentPeriodAmountInWei; uint256[10] private __gap; /** * @notice Initialises the limits and period for the rate limiter. * @param _periodInSeconds The length of the period in seconds. * @param _limitInWei The limit allowed in the period in Wei. */ function __RateLimiter_init(uint256 _periodInSeconds, uint256 _limitInWei) internal onlyInitializing { if (_periodInSeconds == 0) { revert PeriodIsZero(); } if (_limitInWei == 0) { revert LimitIsZero(); } periodInSeconds = _periodInSeconds; limitInWei = _limitInWei; currentPeriodEnd = block.timestamp + _periodInSeconds; emit RateLimitInitialized(periodInSeconds, limitInWei, currentPeriodEnd); } /** * @notice Increments the amount used in the period. * @dev The amount determining logic is external to this (e.g. fees are included when calling here). * @dev Reverts if the limit is breached. * @param _usedAmount The amount used to be added. */ function _addUsedAmount(uint256 _usedAmount) internal { uint256 currentPeriodAmountTemp; if (currentPeriodEnd < block.timestamp) { currentPeriodEnd = block.timestamp + periodInSeconds; currentPeriodAmountTemp = _usedAmount; } else { currentPeriodAmountTemp = currentPeriodAmountInWei + _usedAmount; } if (currentPeriodAmountTemp > limitInWei) { revert RateLimitExceeded(); } currentPeriodAmountInWei = currentPeriodAmountTemp; } /** * @notice Resets the rate limit amount. * @dev If the used amount is higher, it is set to the limit to avoid confusion/issues. * @dev Only the RATE_LIMIT_SETTER_ROLE is allowed to execute this function. * @dev Emits the LimitAmountChanged event. * @dev usedLimitAmountToSet will use the default value of zero if period has expired * @param _amount The amount to reset the limit to. */ function resetRateLimitAmount(uint256 _amount) external onlyRole(RATE_LIMIT_SETTER_ROLE) { uint256 usedLimitAmountToSet; bool amountUsedLoweredToLimit; bool usedAmountResetToZero; if (currentPeriodEnd < block.timestamp) { currentPeriodEnd = block.timestamp + periodInSeconds; usedAmountResetToZero = true; } else { if (_amount < currentPeriodAmountInWei) { usedLimitAmountToSet = _amount; amountUsedLoweredToLimit = true; } } limitInWei = _amount; if (usedAmountResetToZero || amountUsedLoweredToLimit) { currentPeriodAmountInWei = usedLimitAmountToSet; } emit LimitAmountChanged(_msgSender(), _amount, amountUsedLoweredToLimit, usedAmountResetToZero); } /** * @notice Resets the amount used to zero. * @dev Only the RATE_LIMIT_SETTER_ROLE is allowed to execute this function. * @dev Emits the AmountUsedInPeriodReset event. */ function resetAmountUsedInPeriod() external onlyRole(RATE_LIMIT_SETTER_ROLE) { currentPeriodAmountInWei = 0; emit AmountUsedInPeriodReset(_msgSender()); } } // SPDX-License-Identifier: Apache-2.0 /** * @author Hamdi Allam [email protected] * @notice Please reach out with any questions or concerns. * @custom:security-contact [email protected] */ pragma solidity 0.8.22; error NotList(); error WrongBytesLength(); error NoNext(); error MemoryOutOfBounds(uint256 inde); library RLPReader { uint8 internal constant STRING_SHORT_START = 0x80; uint8 internal constant STRING_LONG_START = 0xb8; uint8 internal constant LIST_SHORT_START = 0xc0; uint8 internal constant LIST_LONG_START = 0xf8; uint8 internal constant LIST_SHORT_START_MAX = 0xf7; uint8 internal constant WORD_SIZE = 32; struct RLPItem { uint256 len; uint256 memPtr; } struct Iterator { RLPItem item; // Item that's being iterated over. uint256 nextPtr; // Position of the next item in the list. } /** * @dev Returns the next element in the iteration. Reverts if it has no next element. * @param _self The iterator. * @return nextItem The next element in the iteration. */ function _next(Iterator memory _self) internal pure returns (RLPItem memory nextItem) { if (!_hasNext(_self)) { revert NoNext(); } uint256 ptr = _self.nextPtr; uint256 itemLength = _itemLength(ptr); _self.nextPtr = ptr + itemLength; nextItem.len = itemLength; nextItem.memPtr = ptr; } /** * @dev Returns the number 'skiptoNum' element in the iteration. * @param _self The iterator. * @param _skipToNum Element position in the RLP item iterator to return. * @return item The number 'skipToNum' element in the iteration. */ function _skipTo(Iterator memory _self, uint256 _skipToNum) internal pure returns (RLPItem memory item) { uint256 lenX; uint256 memPtrStart = _self.item.memPtr; uint256 endPtr; uint256 byte0; uint256 byteLen; assembly { // get first byte to know if it is a short/long list byte0 := byte(0, mload(memPtrStart)) // yul has no if/else so if it a short list ( < long list start ) switch lt(byte0, LIST_LONG_START) case 1 { // the length is just the difference in bytes lenX := sub(byte0, 0xc0) } case 0 { // at this point we care only about lists, so this is the default // get how many next bytes indicate the list length byteLen := sub(byte0, 0xf7) // move one over to the list length start memPtrStart := add(memPtrStart, 1) // shift over grabbing the bytelen elements lenX := div(mload(memPtrStart), exp(256, sub(32, byteLen))) } // get the end endPtr := add(memPtrStart, lenX) } uint256 ptr = _self.nextPtr; uint256 itemLength = _itemLength(ptr); _self.nextPtr = ptr + itemLength; for (uint256 i; i < _skipToNum - 1; ) { ptr = _self.nextPtr; if (ptr > endPtr) revert MemoryOutOfBounds(endPtr); itemLength = _itemLength(ptr); _self.nextPtr = ptr + itemLength; unchecked { i++; } } item.len = itemLength; item.memPtr = ptr; } /** * @dev Returns true if the iteration has more elements. * @param _self The iterator. * @return True if the iteration has more elements. */ function _hasNext(Iterator memory _self) internal pure returns (bool) { RLPItem memory item = _self.item; return _self.nextPtr < item.memPtr + item.len; } /** * @param item RLP encoded bytes. * @return newItem The RLP item. */ function _toRlpItem(bytes memory item) internal pure returns (RLPItem memory newItem) { uint256 memPtr; assembly { memPtr := add(item, 0x20) } newItem.len = item.length; newItem.memPtr = memPtr; } /** * @dev Creates an iterator. Reverts if item is not a list. * @param _self The RLP item. * @return iterator 'Iterator' over the item. */ function _iterator(RLPItem memory _self) internal pure returns (Iterator memory iterator) { if (!_isList(_self)) { revert NotList(); } uint256 ptr = _self.memPtr + _payloadOffset(_self.memPtr); iterator.item = _self; iterator.nextPtr = ptr; } /** * @param _item The RLP item. * @return (memPtr, len) Tuple: Location of the item's payload in memory. */ function _payloadLocation(RLPItem memory _item) internal pure returns (uint256, uint256) { uint256 offset = _payloadOffset(_item.memPtr); uint256 memPtr = _item.memPtr + offset; uint256 len = _item.len - offset; // data length return (memPtr, len); } /** * @param _item The RLP item. * @return Indicator whether encoded payload is a list. */ function _isList(RLPItem memory _item) internal pure returns (bool) { if (_item.len == 0) return false; uint8 byte0; uint256 memPtr = _item.memPtr; assembly { byte0 := byte(0, mload(memPtr)) } if (byte0 < LIST_SHORT_START) return false; return true; } /** * @param _item The RLP item. * @return result Returns the item as an address. */ function _toAddress(RLPItem memory _item) internal pure returns (address) { // 1 byte for the length prefix if (_item.len != 21) { revert WrongBytesLength(); } return address(uint160(_toUint(_item))); } /** * @param _item The RLP item. * @return result Returns the item as a uint256. */ function _toUint(RLPItem memory _item) internal pure returns (uint256 result) { if (_item.len == 0 || _item.len > 33) { revert WrongBytesLength(); } (uint256 memPtr, uint256 len) = _payloadLocation(_item); assembly { result := mload(memPtr) // Shfit to the correct location if neccesary. if lt(len, 32) { result := div(result, exp(256, sub(32, len))) } } } /** * @param _item The RLP item. * @return result Returns the item as bytes. */ function _toBytes(RLPItem memory _item) internal pure returns (bytes memory result) { if (_item.len == 0) { revert WrongBytesLength(); } (uint256 memPtr, uint256 len) = _payloadLocation(_item); result = new bytes(len); uint256 destPtr; assembly { destPtr := add(0x20, result) } _copy(memPtr, destPtr, len); } /** * Private Helpers */ /** * @param _memPtr Item memory pointer. * @return Entire RLP item byte length. */ function _itemLength(uint256 _memPtr) private pure returns (uint256) { uint256 itemLen; uint256 dataLen; uint256 byte0; assembly { byte0 := byte(0, mload(_memPtr)) } if (byte0 < STRING_SHORT_START) itemLen = 1; else if (byte0 < STRING_LONG_START) itemLen = byte0 - STRING_SHORT_START + 1; else if (byte0 < LIST_SHORT_START) { assembly { let byteLen := sub(byte0, 0xb7) // # Of bytes the actual length is. _memPtr := add(_memPtr, 1) // Skip over the first byte. /* 32 byte word size */ dataLen := div(mload(_memPtr), exp(256, sub(32, byteLen))) // Right shifting to get the len. itemLen := add(dataLen, add(byteLen, 1)) } } else if (byte0 < LIST_LONG_START) { itemLen = byte0 - LIST_SHORT_START + 1; } else { assembly { let byteLen := sub(byte0, 0xf7) _memPtr := add(_memPtr, 1) dataLen := div(mload(_memPtr), exp(256, sub(32, byteLen))) // Right shifting to the correct length. itemLen := add(dataLen, add(byteLen, 1)) } } return itemLen; } /** * @param _memPtr Item memory pointer. * @return Number of bytes until the data. */ function _payloadOffset(uint256 _memPtr) private pure returns (uint256) { uint256 byte0; assembly { byte0 := byte(0, mload(_memPtr)) } if (byte0 < STRING_SHORT_START) return 0; else if (byte0 < STRING_LONG_START || (byte0 >= LIST_SHORT_START && byte0 < LIST_LONG_START)) return 1; else if (byte0 < LIST_SHORT_START) // being explicit return byte0 - (STRING_LONG_START - 1) + 1; else return byte0 - (LIST_LONG_START - 1) + 1; } /** * @param _src Pointer to source. * @param _dest Pointer to destination. * @param _len Amount of memory to copy from the source. */ function _copy(uint256 _src, uint256 _dest, uint256 _len) private pure { if (_len == 0) return; // copy as many word sizes as possible for (; _len >= WORD_SIZE; _len -= WORD_SIZE) { assembly { mstore(_dest, mload(_src)) } _src += WORD_SIZE; _dest += WORD_SIZE; } if (_len > 0) { // Left over bytes. Mask is used to remove unwanted bytes from the word. uint256 mask = 256 ** (WORD_SIZE - _len) - 1; assembly { let srcpart := and(mload(_src), not(mask)) // Zero out src. let destpart := and(mload(_dest), mask) // Retrieve the bytes. mstore(_dest, or(destpart, srcpart)) } } } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity 0.8.22; /** * @title Library to verify sparse merkle proofs and to get the leaf hash value * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ library SparseMerkleTreeVerifier { /** * @notice Verify merkle proof * @param _leafHash Leaf hash. * @param _proof Sparse merkle tree proof. * @param _leafIndex Index of the leaf. * @param _root Merkle root. */ function _verifyMerkleProof( bytes32 _leafHash, bytes32[] calldata _proof, uint32 _leafIndex, bytes32 _root ) internal pure returns (bool) { bytes32 node = _leafHash; for (uint256 height; height < _proof.length; ++height) { if (((_leafIndex >> height) & 1) == 1) { node = _efficientKeccak(_proof[height], node); } else { node = _efficientKeccak(node, _proof[height]); } } return node == _root; } /** * @notice Performs a gas optimized keccak hash * @param _left Left value. * @param _right Right value. */ function _efficientKeccak(bytes32 _left, bytes32 _right) internal pure returns (bytes32 value) { assembly { mstore(0x00, _left) mstore(0x20, _right) value := keccak256(0x00, 0x40) } } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity >=0.8.19 <=0.8.22; import { RLPReader } from "./Rlp.sol"; using RLPReader for RLPReader.RLPItem; using RLPReader for RLPReader.Iterator; using RLPReader for bytes; /** * dev Thrown when the transaction data length is too short. */ error TransactionShort(); /** * dev Thrown when the transaction type is unknown. */ error UnknownTransactionType(bytes1 versionByte); /** * @title Contract to decode RLP formatted transactions. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ library TransactionDecoder { /** * @notice Decodes the transaction extracting the calldata. * @param _transaction The RLP transaction. * @return data Returns the transaction calldata as bytes. */ function decodeTransaction(bytes calldata _transaction) internal pure returns (bytes memory) { if (_transaction.length < 1) { revert TransactionShort(); } bytes1 version = _transaction[0]; if (version == 0x01) { return _decodeEIP2930Transaction(_transaction); } if (version == 0x02) { return _decodeEIP1559Transaction(_transaction); } if (version >= 0xc0) { return _decodeLegacyTransaction(_transaction); } revert UnknownTransactionType(version); } /** * @notice Decodes the EIP1559 transaction extracting the calldata. * @param _transaction The RLP transaction. * @return data Returns the transaction calldata as bytes. */ function _decodeEIP1559Transaction(bytes calldata _transaction) private pure returns (bytes memory data) { bytes memory txData = _transaction[1:]; // skip the version byte RLPReader.RLPItem memory rlp = txData._toRlpItem(); RLPReader.Iterator memory it = rlp._iterator(); data = it._skipTo(8)._toBytes(); } /** * @notice Decodes the EIP2930 transaction extracting the calldata. * @param _transaction The RLP transaction. * @return data Returns the transaction calldata as bytes. */ function _decodeEIP2930Transaction(bytes calldata _transaction) private pure returns (bytes memory data) { bytes memory txData = _transaction[1:]; // skip the version byte RLPReader.RLPItem memory rlp = txData._toRlpItem(); RLPReader.Iterator memory it = rlp._iterator(); data = it._skipTo(7)._toBytes(); } /** * @notice Decodes the legacy transaction extracting the calldata. * @param _transaction The RLP transaction. * @return data Returns the transaction calldata as bytes. */ function _decodeLegacyTransaction(bytes calldata _transaction) private pure returns (bytes memory data) { bytes memory txData = _transaction; RLPReader.RLPItem memory rlp = txData._toRlpItem(); RLPReader.Iterator memory it = rlp._iterator(); data = it._skipTo(6)._toBytes(); } } // SPDX-License-Identifier: AGPL-3.0 pragma solidity 0.8.22; import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; import { AccessControlUpgradeable } from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol"; import { L1MessageServiceV1 } from "./messageService/l1/v1/L1MessageServiceV1.sol"; import { IZkEvmV2 } from "./interfaces/l1/IZkEvmV2.sol"; import { TransactionDecoder } from "./messageService/lib/TransactionDecoder.sol"; import { CodecV2 } from "./messageService/lib/Codec.sol"; import { IPlonkVerifier } from "./interfaces/l1/IPlonkVerifier.sol"; /** * @title Contract to manage cross-chain messaging on L1 and rollup proving. * @author ConsenSys Software Inc. * @custom:security-contact [email protected] */ abstract contract ZkEvmV2 is Initializable, AccessControlUpgradeable, L1MessageServiceV1, IZkEvmV2 { using TransactionDecoder for *; using CodecV2 for *; uint256 internal constant MODULO_R = 21888242871839275222246405745257275088548364400416034343698204186575808495617; bytes32 public constant OPERATOR_ROLE = keccak256("OPERATOR_ROLE"); uint256 public currentTimestamp; uint256 public currentL2BlockNumber; mapping(uint256 blockNumber => bytes32 stateRootHash) public stateRootHashes; mapping(uint256 proofType => address verifierAddress) public verifiers; uint256[50] private __gap; /** * @notice Finalizes blocks without using a proof. * @dev DEFAULT_ADMIN_ROLE is required to execute. * @dev _blocksData[0].fromAddresses is a temporary workaround to pass bytes calldata. * @param _blocksData The full BlockData collection - block, transaction and log data. */ function finalizeBlocksWithoutProof( BlockData[] calldata _blocksData ) external whenTypeNotPaused(GENERAL_PAUSE_TYPE) onlyRole(DEFAULT_ADMIN_ROLE) { _finalizeBlocks(_blocksData, _blocksData[0].fromAddresses, 0, bytes32(0), false); } /** * @notice Finalizes blocks using a proof. * @dev OPERATOR_ROLE is required to execute. * @dev If the verifier based on proof type is not found, it reverts. * @param _blocksData The full BlockData collection - block, transaction and log data. * @param _proof The proof to be verified with the proof type verifier contract. * @param _proofType The proof type to determine which verifier contract to use. * @param _parentStateRootHash The starting roothash for the last known block. */ function finalizeBlocks( BlockData[] calldata _blocksData, bytes calldata _proof, uint256 _proofType, bytes32 _parentStateRootHash ) external whenTypeAndGeneralNotPaused(PROVING_SYSTEM_PAUSE_TYPE) onlyRole(OPERATOR_ROLE) { if (stateRootHashes[currentL2BlockNumber] != _parentStateRootHash) { revert StartingRootHashDoesNotMatch(); } _finalizeBlocks(_blocksData, _proof, _proofType, _parentStateRootHash, true); } /** * @notice Finalizes blocks with or without using a proof depending on _withProof. * @dev OPERATOR_ROLE is required to execute. * @dev If the verifier based on proof type is not found, it reverts. * @param _blocksData The full BlockData collection - block, transaction and log data. * @param _proof The proof to be verified with the proof type verifier contract. * @param _proofType The proof type to determine which verifier contract to use. * @param _parentStateRootHash The starting roothash for the last known block. */ function _finalizeBlocks( BlockData[] calldata _blocksData, bytes calldata _proof, uint256 _proofType, bytes32 _parentStateRootHash, bool _withProof ) private { if (_blocksData.length == 0) { revert EmptyBlockDataArray(); } uint256 currentBlockNumberTemp = currentL2BlockNumber; uint256 firstBlockNumber; unchecked { firstBlockNumber = currentBlockNumberTemp + 1; } uint256[] memory timestamps = new uint256[](_blocksData.length); bytes32[] memory blockHashes = new bytes32[](_blocksData.length); bytes32[] memory rootHashes; unchecked { rootHashes = new bytes32[](_blocksData.length + 1); } rootHashes[0] = _parentStateRootHash; bytes32 hashOfTxHashes; bytes32 hashOfMessageHashes; for (uint256 i; i < _blocksData.length; ++i) { BlockData calldata blockInfo = _blocksData[i]; if (blockInfo.l2BlockTimestamp >= block.timestamp) { revert BlockTimestampError(blockInfo.l2BlockTimestamp, block.timestamp); } hashOfTxHashes = _processBlockTransactions(blockInfo.transactions, blockInfo.batchReceptionIndices); hashOfMessageHashes = _processMessageHashes(blockInfo.l2ToL1MsgHashes); unchecked { ++currentBlockNumberTemp; } blockHashes[i] = keccak256( abi.encodePacked( hashOfTxHashes, hashOfMessageHashes, keccak256(abi.encodePacked(blockInfo.batchReceptionIndices)), keccak256(blockInfo.fromAddresses) ) ); timestamps[i] = blockInfo.l2BlockTimestamp; unchecked { rootHashes[i + 1] = blockInfo.blockRootHash; } emit BlockFinalized(currentBlockNumberTemp, blockInfo.blockRootHash, _withProof); } unchecked { uint256 arrayIndex = _blocksData.length - 1; stateRootHashes[currentBlockNumberTemp] = _blocksData[arrayIndex].blockRootHash; currentTimestamp = _blocksData[arrayIndex].l2BlockTimestamp; currentL2BlockNumber = currentBlockNumberTemp; } if (_withProof) { uint256 publicInput = uint256( keccak256( abi.encode( keccak256(abi.encodePacked(blockHashes)), firstBlockNumber, keccak256(abi.encodePacked(timestamps)), keccak256(abi.encodePacked(rootHashes)) ) ) ); assembly { publicInput := mod(publicInput, MODULO_R) } _verifyProof(publicInput, _proofType, _proof, _parentStateRootHash); } } /** * @notice Hashes all transactions individually and then hashes the packed hash array. * @dev Updates the outbox status on L1 as received. * @param _transactions The transactions in a particular block. * @param _batchReceptionIndices The indexes where the transaction type is the L1->L2 anchoring message hashes transaction. */ function _processBlockTransactions( bytes[] calldata _transactions, uint16[] calldata _batchReceptionIndices ) internal returns (bytes32 hashOfTxHashes) { bytes32[] memory transactionHashes = new bytes32[](_transactions.length); if (_transactions.length == 0) { revert EmptyBlock(); } for (uint256 i; i < _batchReceptionIndices.length; ++i) { _updateL1L2MessageStatusToReceived( TransactionDecoder.decodeTransaction(_transactions[_batchReceptionIndices[i]])._extractXDomainAddHashes() ); } for (uint256 i; i < _transactions.length; ++i) { transactionHashes[i] = keccak256(_transactions[i]); } hashOfTxHashes = keccak256(abi.encodePacked(transactionHashes)); } /** * @notice Anchors message hashes and hashes the packed hash array. * @dev Also adds L2->L1 sent message hashes for later claiming. * @param _messageHashes The hashes in the message sent event logs. */ function _processMessageHashes(bytes32[] calldata _messageHashes) internal returns (bytes32 hashOfLogHashes) { for (uint256 i; i < _messageHashes.length; ++i) { _addL2L1MessageHash(_messageHashes[i]); } hashOfLogHashes = keccak256(abi.encodePacked(_messageHashes)); } /** * @notice Verifies the proof with locally computed public inputs. * @dev If the verifier based on proof type is not found, it reverts with InvalidProofType. * @param _publicInputHash The full BlockData collection - block, transaction and log data. * @param _proofType The proof type to determine which verifier contract to use. * @param _proof The proof to be verified with the proof type verifier contract. * @param _parentStateRootHash The beginning roothash to start with. */ function _verifyProof( uint256 _publicInputHash, uint256 _proofType, bytes calldata _proof, bytes32 _parentStateRootHash ) internal { uint256[] memory input = new uint256[](1); input[0] = _publicInputHash; address verifierToUse = verifiers[_proofType]; if (verifierToUse == address(0)) { revert InvalidProofType(); } bool success = IPlonkVerifier(verifierToUse).Verify(_proof, input); if (!success) { revert InvalidProof(); } emit BlocksVerificationDone(currentL2BlockNumber, _parentStateRootHash, stateRootHashes[currentL2BlockNumber]); } }