Overview
S Balance
0 S
S Value
$0.00More Info
Private Name Tags
ContractCreator
Latest 15 from a total of 15 transactions
Transaction Hash |
Method
|
Block
|
From
|
To
|
|||||
---|---|---|---|---|---|---|---|---|---|
Set Lz Endpoint ... | 3910723 | 5 days ago | IN | 0 S | 0.00158442 | ||||
Set Chip Out Fee | 3910719 | 5 days ago | IN | 0 S | 0.00157802 | ||||
Store Source Cha... | 3910716 | 5 days ago | IN | 0 S | 0.00256759 | ||||
Set Lz Endpoint ... | 886121 | 30 days ago | IN | 0 S | 0.0000528 | ||||
Set Lz Endpoint ... | 886116 | 30 days ago | IN | 0 S | 0.00005281 | ||||
Set Lz Endpoint ... | 886111 | 30 days ago | IN | 0 S | 0.00005281 | ||||
Set Lz Endpoint ... | 886107 | 30 days ago | IN | 0 S | 0.00005281 | ||||
Set Lz Endpoint ... | 886102 | 30 days ago | IN | 0 S | 0.0000528 | ||||
Set Lz Endpoint ... | 886097 | 30 days ago | IN | 0 S | 0.00005281 | ||||
Set Lz Endpoint ... | 886092 | 30 days ago | IN | 0 S | 0.0000528 | ||||
Set Lz Endpoint ... | 886086 | 30 days ago | IN | 0 S | 0.0000528 | ||||
Set Lz Endpoint ... | 886083 | 30 days ago | IN | 0 S | 0.00005281 | ||||
Set Lz Endpoint ... | 886079 | 30 days ago | IN | 0 S | 0.0000528 | ||||
Set Lz Endpoint ... | 886074 | 30 days ago | IN | 0 S | 0.00005281 | ||||
Set Fees Receive... | 886071 | 30 days ago | IN | 0 S | 0.00005199 |
Loading...
Loading
Contract Source Code Verified (Exact Match)
Contract Name:
ChipsIntentsVerifierV1
Compiler Version
v0.8.24+commit.e11b9ed9
Optimization Enabled:
Yes with 200 runs
Other Settings:
paris EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import "@layerzerolabs/lz-evm-oapp-v2/contracts/oft/OFT.sol"; import "@layerzerolabs/lz-evm-oapp-v2/contracts/oft/OFTCore.sol"; import "@layerzerolabs/lz-evm-oapp-v2/contracts/oapp/libs/OptionsBuilder.sol"; import "../interfaces/IRegistryV1.sol"; import "./NonceMechanisms/AccountAndActionSerialNonceBase.sol"; import "./MultiSourceChainIntentsVerifierBase.sol"; import "../../Peripheral/Chips/WrapNativeChipInOutHelper.sol"; /** * @title ChipsIntentsVerifierV1 * @notice This contract is responsible for verifying Chips elated intents (Currently only CHIP_OUT_LZ) * @dev All verification functions in this contract work in the same manner * - Verify that the payload was signed by the trader * - Verify that the nonce is valid (and mark it as used) * - Perform the action * - Emit an event * * This contract takes a fee from the holder and sends it to the feesReceiver upon each verification */ contract ChipsIntentsVerifierV1 is MultiSourceChainIntentsVerifierBase, AccountAndActionSerialNonceBase { using OptionsBuilder for bytes; // ***** Enums ***** enum ChipsIntentsVerifierActions { NONE, CHIP_OUT_LZ, CHIP_OUT_LZ_UNWRAP } // ***** Action Verifications (Immutable) ***** string public constant REQUEST_PAYLOAD_CHIP_OUT_LZ_TYPE_DESCRIPTOR = "HolderRequestPayload_ChipOutLZ(uint256 nonce,address chip,address holder,address receiver,uint256 amount)"; struct HolderRequestPayload_ChipOutLZ { uint256 nonce; address chip; address holder; address receiver; uint256 amount; } string public constant REQUEST_PAYLOAD_CHIP_OUT_LZ_UNWRAP_TYPE_DESCRIPTOR = "HolderRequestPayload_ChipOutLZ_Unwrap(uint256 nonce,address chip,address holder,address receiver,uint256 amount)"; struct HolderRequestPayload_ChipOutLZ_Unwrap { uint256 nonce; address chip; address holder; address receiver; uint256 amount; } // ***** Contracts (Immutable) ***** IRegistryV1 public immutable registry; // ***** Storage ***** address public feesReceiver; // chip => fee mapping(address => uint256) public chipOutFeeForChip; // evm id => lz eid mapping(uint16 => uint16) public evmIdToLzEid; // oft-chip (engine-chain) => wrapNativeChipInOutHelper (dst-chain) mapping(OFT => WrapNativeChipInOutHelper) public wrapNativeChipInOutHelpers; // ***** Events ***** event ChipOutFeeSet(address indexed chip, uint256 fee); event LzEidSet(uint16 indexed evmId, uint16 indexed lzEid); event FeesReceiverSet(address indexed receiver); event NativeChipInOutHelperSet( OFT indexed oftChip, WrapNativeChipInOutHelper indexed helper ); event ForceChipOut( address indexed chip, address indexed holder, ChipsIntentsVerifierActions action, uint256 amount, uint256 fee ); event ChipsIntentVerified( address indexed sender, address indexed chip, address indexed holder, ChipsIntentsVerifierActions action, uint256 amount, uint256 fee ); event InteractedOnBehalf( address indexed chip, address indexed holder, address indexed permissionedAccount, ChipsIntentsVerifierActions action, uint256 amount, uint256 fee ); // ***** Modifiers ***** // ***** Views ***** function getLZDstChainIdFromChip( address chip ) external view returns (uint16) { uint256 chipSourceChain = sourceChainIdForAsset[chip]; require(chipSourceChain != 0, "NO_SOURCE_CHAIN_FOR_CHIP"); return getLZDstChainIdFromEvmChainIdInternal(uint16(chipSourceChain)); } function getLZDstChainIdFromEvmChainId( uint16 evmChainId ) external view returns (uint16) { return getLZDstChainIdFromEvmChainIdInternal(evmChainId); } function recoverChipOutLZPayloadSigner( HolderRequestPayload_ChipOutLZ calldata payload, uint8 v, bytes32 r, bytes32 s, bytes32 domainSeparator ) public pure returns (address) { bytes32 digest = keccak256( abi.encodePacked("\x19\x01", domainSeparator, hashChipOutPayload(payload)) ); return ecrecover(digest, v, r, s); } function recoverChipOutLZUnwrapPayloadSigner( HolderRequestPayload_ChipOutLZ_Unwrap calldata payload, uint8 v, bytes32 r, bytes32 s, bytes32 domainSeparator ) public pure returns (address) { bytes32 digest = keccak256( abi.encodePacked( "\x19\x01", domainSeparator, hashChipOutUnwrapPayload(payload) ) ); return ecrecover(digest, v, r, s); } function getWrapNativeChipInOutHelper( OFT oftChip ) external view returns (WrapNativeChipInOutHelper) { return wrapNativeChipInOutHelpers[oftChip]; } // ***** Constructor ***** constructor( IRegistryV1 _registry ) MultiSourceChainIntentsVerifierBase("Chips Intents Verifier", "1") { require(address(_registry) != address(0), "WRONG_PARAMS"); registry = _registry; } // ***** Admin functions ***** function setChipOutFee(address chip, uint256 fee) external onlyAdmin { // State chipOutFeeForChip[chip] = fee; // Events emit ChipOutFeeSet(chip, fee); } function setLzEndpointId(uint16 evmId, uint16 lzEid) external onlyAdmin { require(evmId != 0, "NO_EVM_ID"); require(lzEid != 0, "NO_LZ_EID"); require(evmIdToLzEid[evmId] == 0, "ALREADY_SET"); evmIdToLzEid[evmId] = lzEid; emit LzEidSet(evmId, lzEid); } function setFeesReceiver(address receiver) external onlyAdmin { // State feesReceiver = receiver; // Events emit FeesReceiverSet(receiver); } function setWrapNativeChipInOutHelper( OFT oftChip, WrapNativeChipInOutHelper _wrapNativeChipInOutHelper ) external onlyAdmin { // State wrapNativeChipInOutHelpers[oftChip] = _wrapNativeChipInOutHelper; // Events emit NativeChipInOutHelperSet(oftChip, _wrapNativeChipInOutHelper); } function forceChipOut( address chip, address holder, uint256 amount ) external payable onlyAdmin { require(holder != address(0), "RECEIVER_ZERO"); require(amount > 0, "AMOUNT_ZERO"); require(!isContract(holder), "HOLDER_IS_CONTRACT"); (, uint256 chainId) = getDomainSeparatorAndChainForAssetInternal(chip); address receiver = holder; (uint256 amountAfterFeeWithoutDust, uint256 fee) = chipOut( chip, holder, receiver, amount, chainId, false ); // Events emit ForceChipOut( chip, holder, ChipsIntentsVerifierActions.CHIP_OUT_LZ, amountAfterFeeWithoutDust, fee ); } // ***** ChipHolder Interactions -- Direct Actions ***** function verifyIntent_chipOut( HolderRequestPayload_ChipOutLZ calldata payload, uint8 v, bytes32 r, bytes32 s ) external payable { ( bytes32 domainSeparator, uint256 chainId ) = getDomainSeparatorAndChainForAssetInternal(payload.chip); address recoveredSigner = recoverChipOutLZPayloadSigner( payload, v, r, s, domainSeparator ); require( recoveredSigner == payload.holder || isIntentPermitted(payload.chip, payload.holder, recoveredSigner), "HOLDER_NOT_SIGNER" ); require(payload.receiver == payload.holder, "HOLDER_NOT_RECEIVER"); require(payload.amount > 0, "AMOUNT_ZERO"); // Validate & Register Nonce validateNonceForActionAndIncrease( payload.holder, uint8(ChipsIntentsVerifierActions.CHIP_OUT_LZ), payload.nonce ); (uint256 amountAfterFeeWithoutDust, uint256 fee) = chipOut( payload.chip, payload.holder, payload.receiver, payload.amount, chainId, false ); // Events emit ChipsIntentVerified( msg.sender, payload.chip, payload.holder, ChipsIntentsVerifierActions.CHIP_OUT_LZ, amountAfterFeeWithoutDust, fee ); } /** * @notice Interact on behalf of a holder to chip out */ function interactOnBehalf_chipOut( address chip, address holder, uint256 amount ) external payable { ( bytes32 domainSeparator, uint256 chainId ) = getDomainSeparatorAndChainForAssetInternal(chip); address permissionedAccount = msg.sender; require( isIntentPermitted(chip, holder, permissionedAccount), "NO_PERMISSION" ); require(amount > 0, "AMOUNT_ZERO"); address receiver = holder; (uint256 amountAfterFeeWithoutDust, uint256 fee) = chipOut( chip, holder, receiver, amount, chainId, true ); // Events emit InteractedOnBehalf( chip, holder, permissionedAccount, ChipsIntentsVerifierActions.CHIP_OUT_LZ, amountAfterFeeWithoutDust, fee ); } function chipOut( address chip, address holder, address receiver, uint256 amount, uint256 chainId, bool skipFee ) internal returns (uint256 amountAfterFeeWithoutDust, uint256 fee) { (amountAfterFeeWithoutDust, fee) = handleFeesAndTransfers( chip, holder, amount, skipFee ); uint16 destChainId = getLZDstChainIdFromEvmChainIdInternal(uint16(chainId)); require(destChainId != 0, "NO_EID_FOR_CHAIN"); bytes memory emptyBytes; // This assumes 'enforced options' were set for the chip. Otherwise, the call will revert. SendParam memory sendParam = SendParam({ dstEid: destChainId, to: addressToBytes32Internal(receiver), amountLD: amountAfterFeeWithoutDust, minAmountLD: amountAfterFeeWithoutDust, extraOptions: emptyBytes, composeMsg: emptyBytes, oftCmd: emptyBytes }); MessagingFee memory messagingFee = MessagingFee({ nativeFee: msg.value, lzTokenFee: 0 }); address refundAddress = msg.sender; OFT(chip).send{value: msg.value}(sendParam, messagingFee, refundAddress); } function verifyIntent_chipOutAndUnwrap( HolderRequestPayload_ChipOutLZ_Unwrap calldata payload, uint8 v, bytes32 r, bytes32 s ) external payable { ( bytes32 domainSeparator, uint256 chainId ) = getDomainSeparatorAndChainForAssetInternal(payload.chip); address recoveredSigner = recoverChipOutLZUnwrapPayloadSigner( payload, v, r, s, domainSeparator ); require( recoveredSigner == payload.holder || isIntentPermitted(payload.chip, payload.holder, recoveredSigner), "HOLDER_NOT_SIGNER" ); require(payload.receiver == payload.holder, "HOLDER_NOT_RECEIVER"); require(payload.amount > 0, "AMOUNT_ZERO"); WrapNativeChipInOutHelper wrapNativeChipInOutHelper = wrapNativeChipInOutHelpers[ OFT(payload.chip) ]; require( address(wrapNativeChipInOutHelper) != address(0), "NO_WRAP_NATIVE_CHIP_IN_OUT_HELPER" ); // Validate & Register Nonce validateNonceForActionAndIncrease( payload.holder, uint8(ChipsIntentsVerifierActions.CHIP_OUT_LZ_UNWRAP), payload.nonce ); (uint256 amountAfterFeeWithoutDust, uint256 fee) = handleFeesAndTransfers( payload.chip, payload.holder, payload.amount, false ); uint16 destChainId = getLZDstChainIdFromEvmChainIdInternal(uint16(chainId)); require(destChainId != 0, "NO_EID_FOR_CHAIN"); bytes memory extraOptions = OptionsBuilder .newOptions() .addExecutorLzReceiveOption(200000, 0) .addExecutorLzComposeOption(0, 30000, 0); // This assumes 'enforced options' were set for the chip. Otherwise, the call will revert. SendParam memory sendParam = SendParam({ dstEid: destChainId, to: addressToBytes32Internal(address(wrapNativeChipInOutHelper)), amountLD: amountAfterFeeWithoutDust, minAmountLD: amountAfterFeeWithoutDust, extraOptions: extraOptions, composeMsg: abi.encode(payload.receiver), oftCmd: new bytes(0) }); MessagingFee memory messagingFee = MessagingFee({ nativeFee: msg.value, lzTokenFee: 0 }); address refundAddress = msg.sender; OFT(payload.chip).send{value: msg.value}( sendParam, messagingFee, refundAddress ); // Events emit ChipsIntentVerified( msg.sender, payload.chip, payload.holder, ChipsIntentsVerifierActions.CHIP_OUT_LZ_UNWRAP, amountAfterFeeWithoutDust, fee ); } function handleFeesAndTransfers( address chip, address holder, uint256 amount, bool skipFee ) internal returns (uint256 amountAfterFeeWithoutDust, uint256 fee) { // Note : uin256.max means 0 fee = chipOutFeeForChip[chip]; require(fee > 0, "NO_FEE_DEFINED"); if (fee == type(uint256).max || skipFee) { fee = 0; } require(amount > fee, "AMOUNT_LESS_OR_EQUAL_FEE"); // Take the amount from holder takeChip(chip, holder, amount); // Send fee to feesReceiver sendFee(chip, fee); uint256 decimalConversionRate = OFT(chip).decimalConversionRate(); uint256 amountAfterFee = amount - fee; amountAfterFeeWithoutDust = _removeDust( amountAfterFee, decimalConversionRate ); uint256 dustChange = amountAfterFee - amountAfterFeeWithoutDust; // IF there is "dust change" return it to the holder if (dustChange > 0) { sendChip(chip, holder, dustChange); } } // ***** Fees Functions ***** function takeChip(address chip, address holder, uint256 feeAmount) internal { if (feeAmount > 0) { IERC20(chip).transferFrom(holder, address(this), feeAmount); } } function sendFee(address chip, uint256 feeAmount) internal { address _feesReceiver = feesReceiver; require(_feesReceiver != address(0), "NO_FEES_RECEIVER"); sendChip(chip, _feesReceiver, feeAmount); } // ***** Chips Functions ***** function sendChip(address chip, address receiver, uint256 amount) internal { if (amount > 0) { IERC20(chip).transfer(receiver, amount); } } // ***** Intents Permissions ***** function isIntentPermitted( address settlementAsset, address owner, address spender ) internal view returns (bool) { string memory dynRoleIntentsPermissionsSuffix = intentsPermissions[ OFTChip(settlementAsset) ]; if (bytes(dynRoleIntentsPermissionsSuffix).length == 0) { return false; } IntentsPermissions intentsPermissionsContract = IntentsPermissions( registry.getDynamicRoleAddress( string( abi.encodePacked( DYN_ROLE_INTENTS_PERMISSIONS_PREFIX, dynRoleIntentsPermissionsSuffix ) ) ) ); if (address(intentsPermissionsContract) == address(0)) { return false; } return intentsPermissionsContract.permission( PermissionsType.CHIP_OUT, owner, spender ); } // ***** Context Utils ***** function _msgSender() public view returns (address) { return msg.sender; } // ***** Signed Payloads Utils ***** function hashChipOutPayload( HolderRequestPayload_ChipOutLZ memory payload ) internal pure returns (bytes32) { return keccak256( abi.encode( keccak256(bytes(REQUEST_PAYLOAD_CHIP_OUT_LZ_TYPE_DESCRIPTOR)), payload.nonce, payload.chip, payload.holder, payload.receiver, payload.amount ) ); } function hashChipOutUnwrapPayload( HolderRequestPayload_ChipOutLZ_Unwrap memory payload ) internal pure returns (bytes32) { return keccak256( abi.encode( keccak256(bytes(REQUEST_PAYLOAD_CHIP_OUT_LZ_UNWRAP_TYPE_DESCRIPTOR)), payload.nonce, payload.chip, payload.holder, payload.receiver, payload.amount ) ); } // ***** Internal Utils ***** function addressToBytes32Internal( address add ) internal pure returns (bytes32) { return bytes32(uint256(uint160(add))); } function getLZDstChainIdFromEvmChainIdInternal( uint16 evmChainId ) internal view returns (uint16) { return evmIdToLzEid[evmChainId]; } function _removeDust( uint256 _amount, uint256 _decimalConversionRate ) internal view virtual returns (uint256 amountWithoutDust) { amountWithoutDust = (_amount / _decimalConversionRate) * _decimalConversionRate; } function isContract(address account) internal view returns (bool) { uint256 size; assembly { size := extcodesize(account) } return size > 0; } }
// SPDX-License-Identifier: LZBL-1.2 pragma solidity ^0.8.20; import { BytesLib } from "solidity-bytes-utils/contracts/BytesLib.sol"; import { BitMap256 } from "@layerzerolabs/lz-evm-protocol-v2/contracts/messagelib/libs/BitMaps.sol"; import { CalldataBytesLib } from "@layerzerolabs/lz-evm-protocol-v2/contracts/libs/CalldataBytesLib.sol"; library DVNOptions { using CalldataBytesLib for bytes; using BytesLib for bytes; uint8 internal constant WORKER_ID = 2; uint8 internal constant OPTION_TYPE_PRECRIME = 1; error DVN_InvalidDVNIdx(); error DVN_InvalidDVNOptions(uint256 cursor); /// @dev group dvn options by its idx /// @param _options [dvn_id][dvn_option][dvn_id][dvn_option]... /// dvn_option = [option_size][dvn_idx][option_type][option] /// option_size = len(dvn_idx) + len(option_type) + len(option) /// dvn_id: uint8, dvn_idx: uint8, option_size: uint16, option_type: uint8, option: bytes /// @return dvnOptions the grouped options, still share the same format of _options /// @return dvnIndices the dvn indices function groupDVNOptionsByIdx( bytes memory _options ) internal pure returns (bytes[] memory dvnOptions, uint8[] memory dvnIndices) { if (_options.length == 0) return (dvnOptions, dvnIndices); uint8 numDVNs = getNumDVNs(_options); // if there is only 1 dvn, we can just return the whole options if (numDVNs == 1) { dvnOptions = new bytes[](1); dvnOptions[0] = _options; dvnIndices = new uint8[](1); dvnIndices[0] = _options.toUint8(3); // dvn idx return (dvnOptions, dvnIndices); } // otherwise, we need to group the options by dvn_idx dvnIndices = new uint8[](numDVNs); dvnOptions = new bytes[](numDVNs); unchecked { uint256 cursor = 0; uint256 start = 0; uint8 lastDVNIdx = 255; // 255 is an invalid dvn_idx while (cursor < _options.length) { ++cursor; // skip worker_id // optionLength asserted in getNumDVNs (skip check) uint16 optionLength = _options.toUint16(cursor); cursor += 2; // dvnIdx asserted in getNumDVNs (skip check) uint8 dvnIdx = _options.toUint8(cursor); // dvnIdx must equal to the lastDVNIdx for the first option // so it is always skipped in the first option // this operation slices out options whenever the scan finds a different lastDVNIdx if (lastDVNIdx == 255) { lastDVNIdx = dvnIdx; } else if (dvnIdx != lastDVNIdx) { uint256 len = cursor - start - 3; // 3 is for worker_id and option_length bytes memory opt = _options.slice(start, len); _insertDVNOptions(dvnOptions, dvnIndices, lastDVNIdx, opt); // reset the start and lastDVNIdx start += len; lastDVNIdx = dvnIdx; } cursor += optionLength; } // skip check the cursor here because the cursor is asserted in getNumDVNs // if we have reached the end of the options, we need to process the last dvn uint256 size = cursor - start; bytes memory op = _options.slice(start, size); _insertDVNOptions(dvnOptions, dvnIndices, lastDVNIdx, op); // revert dvnIndices to start from 0 for (uint8 i = 0; i < numDVNs; ++i) { --dvnIndices[i]; } } } function _insertDVNOptions( bytes[] memory _dvnOptions, uint8[] memory _dvnIndices, uint8 _dvnIdx, bytes memory _newOptions ) internal pure { // dvnIdx starts from 0 but default value of dvnIndices is 0, // so we tell if the slot is empty by adding 1 to dvnIdx if (_dvnIdx == 255) revert DVN_InvalidDVNIdx(); uint8 dvnIdxAdj = _dvnIdx + 1; for (uint256 j = 0; j < _dvnIndices.length; ++j) { uint8 index = _dvnIndices[j]; if (dvnIdxAdj == index) { _dvnOptions[j] = abi.encodePacked(_dvnOptions[j], _newOptions); break; } else if (index == 0) { // empty slot, that means it is the first time we see this dvn _dvnIndices[j] = dvnIdxAdj; _dvnOptions[j] = _newOptions; break; } } } /// @dev get the number of unique dvns /// @param _options the format is the same as groupDVNOptionsByIdx function getNumDVNs(bytes memory _options) internal pure returns (uint8 numDVNs) { uint256 cursor = 0; BitMap256 bitmap; // find number of unique dvn_idx unchecked { while (cursor < _options.length) { ++cursor; // skip worker_id uint16 optionLength = _options.toUint16(cursor); cursor += 2; if (optionLength < 2) revert DVN_InvalidDVNOptions(cursor); // at least 1 byte for dvn_idx and 1 byte for option_type uint8 dvnIdx = _options.toUint8(cursor); // if dvnIdx is not set, increment numDVNs // max num of dvns is 255, 255 is an invalid dvn_idx // The order of the dvnIdx is not required to be sequential, as enforcing the order may weaken // the composability of the options. e.g. if we refrain from enforcing the order, an OApp that has // already enforced certain options can append additional options to the end of the enforced // ones without restrictions. if (dvnIdx == 255) revert DVN_InvalidDVNIdx(); if (!bitmap.get(dvnIdx)) { ++numDVNs; bitmap = bitmap.set(dvnIdx); } cursor += optionLength; } } if (cursor != _options.length) revert DVN_InvalidDVNOptions(cursor); } /// @dev decode the next dvn option from _options starting from the specified cursor /// @param _options the format is the same as groupDVNOptionsByIdx /// @param _cursor the cursor to start decoding /// @return optionType the type of the option /// @return option the option /// @return cursor the cursor to start decoding the next option function nextDVNOption( bytes calldata _options, uint256 _cursor ) internal pure returns (uint8 optionType, bytes calldata option, uint256 cursor) { unchecked { // skip worker id cursor = _cursor + 1; // read option size uint16 size = _options.toU16(cursor); cursor += 2; // read option type optionType = _options.toU8(cursor + 1); // skip dvn_idx // startCursor and endCursor are used to slice the option from _options uint256 startCursor = cursor + 2; // skip option type and dvn_idx uint256 endCursor = cursor + size; option = _options[startCursor:endCursor]; cursor += size; } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { ILayerZeroComposer } from "@layerzerolabs/lz-evm-protocol-v2/contracts/interfaces/ILayerZeroComposer.sol"; /** * @title IOAppComposer * @dev This interface defines the OApp Composer, allowing developers to inherit only the OApp package without the protocol. */ // solhint-disable-next-line no-empty-blocks interface IOAppComposer is ILayerZeroComposer {}
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { ILayerZeroEndpointV2 } from "@layerzerolabs/lz-evm-protocol-v2/contracts/interfaces/ILayerZeroEndpointV2.sol"; /** * @title IOAppCore */ interface IOAppCore { // Custom error messages error OnlyPeer(uint32 eid, bytes32 sender); error NoPeer(uint32 eid); error InvalidEndpointCall(); error InvalidDelegate(); // Event emitted when a peer (OApp) is set for a corresponding endpoint event PeerSet(uint32 eid, bytes32 peer); /** * @notice Retrieves the OApp version information. * @return senderVersion The version of the OAppSender.sol contract. * @return receiverVersion The version of the OAppReceiver.sol contract. */ function oAppVersion() external view returns (uint64 senderVersion, uint64 receiverVersion); /** * @notice Retrieves the LayerZero endpoint associated with the OApp. * @return iEndpoint The LayerZero endpoint as an interface. */ function endpoint() external view returns (ILayerZeroEndpointV2 iEndpoint); /** * @notice Retrieves the peer (OApp) associated with a corresponding endpoint. * @param _eid The endpoint ID. * @return peer The peer address (OApp instance) associated with the corresponding endpoint. */ function peers(uint32 _eid) external view returns (bytes32 peer); /** * @notice Sets the peer address (OApp instance) for a corresponding endpoint. * @param _eid The endpoint ID. * @param _peer The address of the peer to be associated with the corresponding endpoint. */ function setPeer(uint32 _eid, bytes32 _peer) external; /** * @notice Sets the delegate address for the OApp Core. * @param _delegate The address of the delegate to be set. */ function setDelegate(address _delegate) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; /** * @title IOAppMsgInspector * @dev Interface for the OApp Message Inspector, allowing examination of message and options contents. */ interface IOAppMsgInspector { // Custom error message for inspection failure error InspectionFailed(bytes message, bytes options); /** * @notice Allows the inspector to examine LayerZero message contents and optionally throw a revert if invalid. * @param _message The message payload to be inspected. * @param _options Additional options or parameters for inspection. * @return valid A boolean indicating whether the inspection passed (true) or failed (false). * * @dev Optionally done as a revert, OR use the boolean provided to handle the failure. */ function inspect(bytes calldata _message, bytes calldata _options) external view returns (bool valid); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; /** * @dev Struct representing enforced option parameters. */ struct EnforcedOptionParam { uint32 eid; // Endpoint ID uint16 msgType; // Message Type bytes options; // Additional options } /** * @title IOAppOptionsType3 * @dev Interface for the OApp with Type 3 Options, allowing the setting and combining of enforced options. */ interface IOAppOptionsType3 { // Custom error message for invalid options error InvalidOptions(bytes options); // Event emitted when enforced options are set event EnforcedOptionSet(EnforcedOptionParam[] _enforcedOptions); /** * @notice Sets enforced options for specific endpoint and message type combinations. * @param _enforcedOptions An array of EnforcedOptionParam structures specifying enforced options. */ function setEnforcedOptions(EnforcedOptionParam[] calldata _enforcedOptions) external; /** * @notice Combines options for a given endpoint and message type. * @param _eid The endpoint ID. * @param _msgType The OApp message type. * @param _extraOptions Additional options passed by the caller. * @return options The combination of caller specified options AND enforced options. */ function combineOptions( uint32 _eid, uint16 _msgType, bytes calldata _extraOptions ) external view returns (bytes memory options); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { ILayerZeroReceiver, Origin } from "@layerzerolabs/lz-evm-protocol-v2/contracts/interfaces/ILayerZeroReceiver.sol"; interface IOAppReceiver is ILayerZeroReceiver { /** * @notice Indicates whether an address is an approved composeMsg sender to the Endpoint. * @param _origin The origin information containing the source endpoint and sender address. * - srcEid: The source chain endpoint ID. * - sender: The sender address on the src chain. * - nonce: The nonce of the message. * @param _message The lzReceive payload. * @param _sender The sender address. * @return isSender Is a valid sender. * * @dev Applications can optionally choose to implement a separate composeMsg sender that is NOT the bridging layer. * @dev The default sender IS the OAppReceiver implementer. */ function isComposeMsgSender( Origin calldata _origin, bytes calldata _message, address _sender ) external view returns (bool isSender); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; import { IOAppOptionsType3, EnforcedOptionParam } from "../interfaces/IOAppOptionsType3.sol"; /** * @title OAppOptionsType3 * @dev Abstract contract implementing the IOAppOptionsType3 interface with type 3 options. */ abstract contract OAppOptionsType3 is IOAppOptionsType3, Ownable { uint16 internal constant OPTION_TYPE_3 = 3; // @dev The "msgType" should be defined in the child contract. mapping(uint32 eid => mapping(uint16 msgType => bytes enforcedOption)) public enforcedOptions; /** * @dev Sets the enforced options for specific endpoint and message type combinations. * @param _enforcedOptions An array of EnforcedOptionParam structures specifying enforced options. * * @dev Only the owner/admin of the OApp can call this function. * @dev Provides a way for the OApp to enforce things like paying for PreCrime, AND/OR minimum dst lzReceive gas amounts etc. * @dev These enforced options can vary as the potential options/execution on the remote may differ as per the msgType. * eg. Amount of lzReceive() gas necessary to deliver a lzCompose() message adds overhead you dont want to pay * if you are only making a standard LayerZero message ie. lzReceive() WITHOUT sendCompose(). */ function setEnforcedOptions(EnforcedOptionParam[] calldata _enforcedOptions) public virtual onlyOwner { _setEnforcedOptions(_enforcedOptions); } /** * @dev Sets the enforced options for specific endpoint and message type combinations. * @param _enforcedOptions An array of EnforcedOptionParam structures specifying enforced options. * * @dev Provides a way for the OApp to enforce things like paying for PreCrime, AND/OR minimum dst lzReceive gas amounts etc. * @dev These enforced options can vary as the potential options/execution on the remote may differ as per the msgType. * eg. Amount of lzReceive() gas necessary to deliver a lzCompose() message adds overhead you dont want to pay * if you are only making a standard LayerZero message ie. lzReceive() WITHOUT sendCompose(). */ function _setEnforcedOptions(EnforcedOptionParam[] memory _enforcedOptions) internal virtual { for (uint256 i = 0; i < _enforcedOptions.length; i++) { // @dev Enforced options are only available for optionType 3, as type 1 and 2 dont support combining. _assertOptionsType3(_enforcedOptions[i].options); enforcedOptions[_enforcedOptions[i].eid][_enforcedOptions[i].msgType] = _enforcedOptions[i].options; } emit EnforcedOptionSet(_enforcedOptions); } /** * @notice Combines options for a given endpoint and message type. * @param _eid The endpoint ID. * @param _msgType The OAPP message type. * @param _extraOptions Additional options passed by the caller. * @return options The combination of caller specified options AND enforced options. * * @dev If there is an enforced lzReceive option: * - {gasLimit: 200k, msg.value: 1 ether} AND a caller supplies a lzReceive option: {gasLimit: 100k, msg.value: 0.5 ether} * - The resulting options will be {gasLimit: 300k, msg.value: 1.5 ether} when the message is executed on the remote lzReceive() function. * @dev This presence of duplicated options is handled off-chain in the verifier/executor. */ function combineOptions( uint32 _eid, uint16 _msgType, bytes calldata _extraOptions ) public view virtual returns (bytes memory) { bytes memory enforced = enforcedOptions[_eid][_msgType]; // No enforced options, pass whatever the caller supplied, even if it's empty or legacy type 1/2 options. if (enforced.length == 0) return _extraOptions; // No caller options, return enforced if (_extraOptions.length == 0) return enforced; // @dev If caller provided _extraOptions, must be type 3 as its the ONLY type that can be combined. if (_extraOptions.length >= 2) { _assertOptionsType3(_extraOptions); // @dev Remove the first 2 bytes containing the type from the _extraOptions and combine with enforced. return bytes.concat(enforced, _extraOptions[2:]); } // No valid set of options was found. revert InvalidOptions(_extraOptions); } /** * @dev Internal function to assert that options are of type 3. * @param _options The options to be checked. */ function _assertOptionsType3(bytes memory _options) internal pure virtual { uint16 optionsType; assembly { optionsType := mload(add(_options, 2)) } if (optionsType != OPTION_TYPE_3) revert InvalidOptions(_options); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { BytesLib } from "solidity-bytes-utils/contracts/BytesLib.sol"; import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol"; import { ExecutorOptions } from "@layerzerolabs/lz-evm-protocol-v2/contracts/messagelib/libs/ExecutorOptions.sol"; import { DVNOptions } from "@layerzerolabs/lz-evm-messagelib-v2/contracts/uln/libs/DVNOptions.sol"; /** * @title OptionsBuilder * @dev Library for building and encoding various message options. */ library OptionsBuilder { using SafeCast for uint256; using BytesLib for bytes; // Constants for options types uint16 internal constant TYPE_1 = 1; // legacy options type 1 uint16 internal constant TYPE_2 = 2; // legacy options type 2 uint16 internal constant TYPE_3 = 3; // Custom error message error InvalidSize(uint256 max, uint256 actual); error InvalidOptionType(uint16 optionType); // Modifier to ensure only options of type 3 are used modifier onlyType3(bytes memory _options) { if (_options.toUint16(0) != TYPE_3) revert InvalidOptionType(_options.toUint16(0)); _; } /** * @dev Creates a new options container with type 3. * @return options The newly created options container. */ function newOptions() internal pure returns (bytes memory) { return abi.encodePacked(TYPE_3); } /** * @dev Adds an executor LZ receive option to the existing options. * @param _options The existing options container. * @param _gas The gasLimit used on the lzReceive() function in the OApp. * @param _value The msg.value passed to the lzReceive() function in the OApp. * @return options The updated options container. * * @dev When multiples of this option are added, they are summed by the executor * eg. if (_gas: 200k, and _value: 1 ether) AND (_gas: 100k, _value: 0.5 ether) are sent in an option to the LayerZeroEndpoint, * that becomes (300k, 1.5 ether) when the message is executed on the remote lzReceive() function. */ function addExecutorLzReceiveOption( bytes memory _options, uint128 _gas, uint128 _value ) internal pure onlyType3(_options) returns (bytes memory) { bytes memory option = ExecutorOptions.encodeLzReceiveOption(_gas, _value); return addExecutorOption(_options, ExecutorOptions.OPTION_TYPE_LZRECEIVE, option); } /** * @dev Adds an executor native drop option to the existing options. * @param _options The existing options container. * @param _amount The amount for the native value that is airdropped to the 'receiver'. * @param _receiver The receiver address for the native drop option. * @return options The updated options container. * * @dev When multiples of this option are added, they are summed by the executor on the remote chain. */ function addExecutorNativeDropOption( bytes memory _options, uint128 _amount, bytes32 _receiver ) internal pure onlyType3(_options) returns (bytes memory) { bytes memory option = ExecutorOptions.encodeNativeDropOption(_amount, _receiver); return addExecutorOption(_options, ExecutorOptions.OPTION_TYPE_NATIVE_DROP, option); } /** * @dev Adds an executor LZ compose option to the existing options. * @param _options The existing options container. * @param _index The index for the lzCompose() function call. * @param _gas The gasLimit for the lzCompose() function call. * @param _value The msg.value for the lzCompose() function call. * @return options The updated options container. * * @dev When multiples of this option are added, they are summed PER index by the executor on the remote chain. * @dev If the OApp sends N lzCompose calls on the remote, you must provide N incremented indexes starting with 0. * ie. When your remote OApp composes (N = 3) messages, you must set this option for index 0,1,2 */ function addExecutorLzComposeOption( bytes memory _options, uint16 _index, uint128 _gas, uint128 _value ) internal pure onlyType3(_options) returns (bytes memory) { bytes memory option = ExecutorOptions.encodeLzComposeOption(_index, _gas, _value); return addExecutorOption(_options, ExecutorOptions.OPTION_TYPE_LZCOMPOSE, option); } /** * @dev Adds an executor ordered execution option to the existing options. * @param _options The existing options container. * @return options The updated options container. */ function addExecutorOrderedExecutionOption( bytes memory _options ) internal pure onlyType3(_options) returns (bytes memory) { return addExecutorOption(_options, ExecutorOptions.OPTION_TYPE_ORDERED_EXECUTION, bytes("")); } /** * @dev Adds a DVN pre-crime option to the existing options. * @param _options The existing options container. * @param _dvnIdx The DVN index for the pre-crime option. * @return options The updated options container. */ function addDVNPreCrimeOption( bytes memory _options, uint8 _dvnIdx ) internal pure onlyType3(_options) returns (bytes memory) { return addDVNOption(_options, _dvnIdx, DVNOptions.OPTION_TYPE_PRECRIME, bytes("")); } /** * @dev Adds an executor option to the existing options. * @param _options The existing options container. * @param _optionType The type of the executor option. * @param _option The encoded data for the executor option. * @return options The updated options container. */ function addExecutorOption( bytes memory _options, uint8 _optionType, bytes memory _option ) internal pure onlyType3(_options) returns (bytes memory) { return abi.encodePacked( _options, ExecutorOptions.WORKER_ID, _option.length.toUint16() + 1, // +1 for optionType _optionType, _option ); } /** * @dev Adds a DVN option to the existing options. * @param _options The existing options container. * @param _dvnIdx The DVN index for the DVN option. * @param _optionType The type of the DVN option. * @param _option The encoded data for the DVN option. * @return options The updated options container. */ function addDVNOption( bytes memory _options, uint8 _dvnIdx, uint8 _optionType, bytes memory _option ) internal pure onlyType3(_options) returns (bytes memory) { return abi.encodePacked( _options, DVNOptions.WORKER_ID, _option.length.toUint16() + 2, // +2 for optionType and dvnIdx _dvnIdx, _optionType, _option ); } /** * @dev Encodes legacy options of type 1. * @param _executionGas The gasLimit value passed to lzReceive(). * @return legacyOptions The encoded legacy options. */ function encodeLegacyOptionsType1(uint256 _executionGas) internal pure returns (bytes memory) { if (_executionGas > type(uint128).max) revert InvalidSize(type(uint128).max, _executionGas); return abi.encodePacked(TYPE_1, _executionGas); } /** * @dev Encodes legacy options of type 2. * @param _executionGas The gasLimit value passed to lzReceive(). * @param _nativeForDst The amount of native air dropped to the receiver. * @param _receiver The _nativeForDst receiver address. * @return legacyOptions The encoded legacy options of type 2. */ function encodeLegacyOptionsType2( uint256 _executionGas, uint256 _nativeForDst, bytes memory _receiver // @dev Use bytes instead of bytes32 in legacy type 2 for _receiver. ) internal pure returns (bytes memory) { if (_executionGas > type(uint128).max) revert InvalidSize(type(uint128).max, _executionGas); if (_nativeForDst > type(uint128).max) revert InvalidSize(type(uint128).max, _nativeForDst); if (_receiver.length > 32) revert InvalidSize(32, _receiver.length); return abi.encodePacked(TYPE_2, _executionGas, _nativeForDst, _receiver); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; // @dev Import the 'MessagingFee' and 'MessagingReceipt' so it's exposed to OApp implementers // solhint-disable-next-line no-unused-import import { OAppSender, MessagingFee, MessagingReceipt } from "./OAppSender.sol"; // @dev Import the 'Origin' so it's exposed to OApp implementers // solhint-disable-next-line no-unused-import import { OAppReceiver, Origin } from "./OAppReceiver.sol"; import { OAppCore } from "./OAppCore.sol"; /** * @title OApp * @dev Abstract contract serving as the base for OApp implementation, combining OAppSender and OAppReceiver functionality. */ abstract contract OApp is OAppSender, OAppReceiver { /** * @dev Constructor to initialize the OApp with the provided endpoint and owner. * @param _endpoint The address of the LOCAL LayerZero endpoint. * @param _delegate The delegate capable of making OApp configurations inside of the endpoint. */ constructor(address _endpoint, address _delegate) OAppCore(_endpoint, _delegate) {} /** * @notice Retrieves the OApp version information. * @return senderVersion The version of the OAppSender.sol implementation. * @return receiverVersion The version of the OAppReceiver.sol implementation. */ function oAppVersion() public pure virtual override(OAppSender, OAppReceiver) returns (uint64 senderVersion, uint64 receiverVersion) { return (SENDER_VERSION, RECEIVER_VERSION); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; import { IOAppCore, ILayerZeroEndpointV2 } from "./interfaces/IOAppCore.sol"; /** * @title OAppCore * @dev Abstract contract implementing the IOAppCore interface with basic OApp configurations. */ abstract contract OAppCore is IOAppCore, Ownable { // The LayerZero endpoint associated with the given OApp ILayerZeroEndpointV2 public immutable endpoint; // Mapping to store peers associated with corresponding endpoints mapping(uint32 eid => bytes32 peer) public peers; /** * @dev Constructor to initialize the OAppCore with the provided endpoint and delegate. * @param _endpoint The address of the LOCAL Layer Zero endpoint. * @param _delegate The delegate capable of making OApp configurations inside of the endpoint. * * @dev The delegate typically should be set as the owner of the contract. */ constructor(address _endpoint, address _delegate) { endpoint = ILayerZeroEndpointV2(_endpoint); if (_delegate == address(0)) revert InvalidDelegate(); endpoint.setDelegate(_delegate); } /** * @notice Sets the peer address (OApp instance) for a corresponding endpoint. * @param _eid The endpoint ID. * @param _peer The address of the peer to be associated with the corresponding endpoint. * * @dev Only the owner/admin of the OApp can call this function. * @dev Indicates that the peer is trusted to send LayerZero messages to this OApp. * @dev Set this to bytes32(0) to remove the peer address. * @dev Peer is a bytes32 to accommodate non-evm chains. */ function setPeer(uint32 _eid, bytes32 _peer) public virtual onlyOwner { _setPeer(_eid, _peer); } /** * @notice Sets the peer address (OApp instance) for a corresponding endpoint. * @param _eid The endpoint ID. * @param _peer The address of the peer to be associated with the corresponding endpoint. * * @dev Indicates that the peer is trusted to send LayerZero messages to this OApp. * @dev Set this to bytes32(0) to remove the peer address. * @dev Peer is a bytes32 to accommodate non-evm chains. */ function _setPeer(uint32 _eid, bytes32 _peer) internal virtual { peers[_eid] = _peer; emit PeerSet(_eid, _peer); } /** * @notice Internal function to get the peer address associated with a specific endpoint; reverts if NOT set. * ie. the peer is set to bytes32(0). * @param _eid The endpoint ID. * @return peer The address of the peer associated with the specified endpoint. */ function _getPeerOrRevert(uint32 _eid) internal view virtual returns (bytes32) { bytes32 peer = peers[_eid]; if (peer == bytes32(0)) revert NoPeer(_eid); return peer; } /** * @notice Sets the delegate address for the OApp. * @param _delegate The address of the delegate to be set. * * @dev Only the owner/admin of the OApp can call this function. * @dev Provides the ability for a delegate to set configs, on behalf of the OApp, directly on the Endpoint contract. */ function setDelegate(address _delegate) public onlyOwner { endpoint.setDelegate(_delegate); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { IOAppReceiver, Origin } from "./interfaces/IOAppReceiver.sol"; import { OAppCore } from "./OAppCore.sol"; /** * @title OAppReceiver * @dev Abstract contract implementing the ILayerZeroReceiver interface and extending OAppCore for OApp receivers. */ abstract contract OAppReceiver is IOAppReceiver, OAppCore { // Custom error message for when the caller is not the registered endpoint/ error OnlyEndpoint(address addr); // @dev The version of the OAppReceiver implementation. // @dev Version is bumped when changes are made to this contract. uint64 internal constant RECEIVER_VERSION = 2; /** * @notice Retrieves the OApp version information. * @return senderVersion The version of the OAppSender.sol contract. * @return receiverVersion The version of the OAppReceiver.sol contract. * * @dev Providing 0 as the default for OAppSender version. Indicates that the OAppSender is not implemented. * ie. this is a RECEIVE only OApp. * @dev If the OApp uses both OAppSender and OAppReceiver, then this needs to be override returning the correct versions. */ function oAppVersion() public view virtual returns (uint64 senderVersion, uint64 receiverVersion) { return (0, RECEIVER_VERSION); } /** * @notice Indicates whether an address is an approved composeMsg sender to the Endpoint. * @dev _origin The origin information containing the source endpoint and sender address. * - srcEid: The source chain endpoint ID. * - sender: The sender address on the src chain. * - nonce: The nonce of the message. * @dev _message The lzReceive payload. * @param _sender The sender address. * @return isSender Is a valid sender. * * @dev Applications can optionally choose to implement separate composeMsg senders that are NOT the bridging layer. * @dev The default sender IS the OAppReceiver implementer. */ function isComposeMsgSender( Origin calldata /*_origin*/, bytes calldata /*_message*/, address _sender ) public view virtual returns (bool) { return _sender == address(this); } /** * @notice Checks if the path initialization is allowed based on the provided origin. * @param origin The origin information containing the source endpoint and sender address. * @return Whether the path has been initialized. * * @dev This indicates to the endpoint that the OApp has enabled msgs for this particular path to be received. * @dev This defaults to assuming if a peer has been set, its initialized. * Can be overridden by the OApp if there is other logic to determine this. */ function allowInitializePath(Origin calldata origin) public view virtual returns (bool) { return peers[origin.srcEid] == origin.sender; } /** * @notice Retrieves the next nonce for a given source endpoint and sender address. * @dev _srcEid The source endpoint ID. * @dev _sender The sender address. * @return nonce The next nonce. * * @dev The path nonce starts from 1. If 0 is returned it means that there is NO nonce ordered enforcement. * @dev Is required by the off-chain executor to determine the OApp expects msg execution is ordered. * @dev This is also enforced by the OApp. * @dev By default this is NOT enabled. ie. nextNonce is hardcoded to return 0. */ function nextNonce(uint32 /*_srcEid*/, bytes32 /*_sender*/) public view virtual returns (uint64 nonce) { return 0; } /** * @dev Entry point for receiving messages or packets from the endpoint. * @param _origin The origin information containing the source endpoint and sender address. * - srcEid: The source chain endpoint ID. * - sender: The sender address on the src chain. * - nonce: The nonce of the message. * @param _guid The unique identifier for the received LayerZero message. * @param _message The payload of the received message. * @param _executor The address of the executor for the received message. * @param _extraData Additional arbitrary data provided by the corresponding executor. * * @dev Entry point for receiving msg/packet from the LayerZero endpoint. */ function lzReceive( Origin calldata _origin, bytes32 _guid, bytes calldata _message, address _executor, bytes calldata _extraData ) public payable virtual { // Ensures that only the endpoint can attempt to lzReceive() messages to this OApp. if (address(endpoint) != msg.sender) revert OnlyEndpoint(msg.sender); // Ensure that the sender matches the expected peer for the source endpoint. if (_getPeerOrRevert(_origin.srcEid) != _origin.sender) revert OnlyPeer(_origin.srcEid, _origin.sender); // Call the internal OApp implementation of lzReceive. _lzReceive(_origin, _guid, _message, _executor, _extraData); } /** * @dev Internal function to implement lzReceive logic without needing to copy the basic parameter validation. */ function _lzReceive( Origin calldata _origin, bytes32 _guid, bytes calldata _message, address _executor, bytes calldata _extraData ) internal virtual; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { SafeERC20, IERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; import { MessagingParams, MessagingFee, MessagingReceipt } from "@layerzerolabs/lz-evm-protocol-v2/contracts/interfaces/ILayerZeroEndpointV2.sol"; import { OAppCore } from "./OAppCore.sol"; /** * @title OAppSender * @dev Abstract contract implementing the OAppSender functionality for sending messages to a LayerZero endpoint. */ abstract contract OAppSender is OAppCore { using SafeERC20 for IERC20; // Custom error messages error NotEnoughNative(uint256 msgValue); error LzTokenUnavailable(); // @dev The version of the OAppSender implementation. // @dev Version is bumped when changes are made to this contract. uint64 internal constant SENDER_VERSION = 1; /** * @notice Retrieves the OApp version information. * @return senderVersion The version of the OAppSender.sol contract. * @return receiverVersion The version of the OAppReceiver.sol contract. * * @dev Providing 0 as the default for OAppReceiver version. Indicates that the OAppReceiver is not implemented. * ie. this is a SEND only OApp. * @dev If the OApp uses both OAppSender and OAppReceiver, then this needs to be override returning the correct versions */ function oAppVersion() public view virtual returns (uint64 senderVersion, uint64 receiverVersion) { return (SENDER_VERSION, 0); } /** * @dev Internal function to interact with the LayerZero EndpointV2.quote() for fee calculation. * @param _dstEid The destination endpoint ID. * @param _message The message payload. * @param _options Additional options for the message. * @param _payInLzToken Flag indicating whether to pay the fee in LZ tokens. * @return fee The calculated MessagingFee for the message. * - nativeFee: The native fee for the message. * - lzTokenFee: The LZ token fee for the message. */ function _quote( uint32 _dstEid, bytes memory _message, bytes memory _options, bool _payInLzToken ) internal view virtual returns (MessagingFee memory fee) { return endpoint.quote( MessagingParams(_dstEid, _getPeerOrRevert(_dstEid), _message, _options, _payInLzToken), address(this) ); } /** * @dev Internal function to interact with the LayerZero EndpointV2.send() for sending a message. * @param _dstEid The destination endpoint ID. * @param _message The message payload. * @param _options Additional options for the message. * @param _fee The calculated LayerZero fee for the message. * - nativeFee: The native fee. * - lzTokenFee: The lzToken fee. * @param _refundAddress The address to receive any excess fee values sent to the endpoint. * @return receipt The receipt for the sent message. * - guid: The unique identifier for the sent message. * - nonce: The nonce of the sent message. * - fee: The LayerZero fee incurred for the message. */ function _lzSend( uint32 _dstEid, bytes memory _message, bytes memory _options, MessagingFee memory _fee, address _refundAddress ) internal virtual returns (MessagingReceipt memory receipt) { // @dev Push corresponding fees to the endpoint, any excess is sent back to the _refundAddress from the endpoint. uint256 messageValue = _payNative(_fee.nativeFee); if (_fee.lzTokenFee > 0) _payLzToken(_fee.lzTokenFee); return // solhint-disable-next-line check-send-result endpoint.send{ value: messageValue }( MessagingParams(_dstEid, _getPeerOrRevert(_dstEid), _message, _options, _fee.lzTokenFee > 0), _refundAddress ); } /** * @dev Internal function to pay the native fee associated with the message. * @param _nativeFee The native fee to be paid. * @return nativeFee The amount of native currency paid. * * @dev If the OApp needs to initiate MULTIPLE LayerZero messages in a single transaction, * this will need to be overridden because msg.value would contain multiple lzFees. * @dev Should be overridden in the event the LayerZero endpoint requires a different native currency. * @dev Some EVMs use an ERC20 as a method for paying transactions/gasFees. * @dev The endpoint is EITHER/OR, ie. it will NOT support both types of native payment at a time. */ function _payNative(uint256 _nativeFee) internal virtual returns (uint256 nativeFee) { if (msg.value != _nativeFee) revert NotEnoughNative(msg.value); return _nativeFee; } /** * @dev Internal function to pay the LZ token fee associated with the message. * @param _lzTokenFee The LZ token fee to be paid. * * @dev If the caller is trying to pay in the specified lzToken, then the lzTokenFee is passed to the endpoint. * @dev Any excess sent, is passed back to the specified _refundAddress in the _lzSend(). */ function _payLzToken(uint256 _lzTokenFee) internal virtual { // @dev Cannot cache the token because it is not immutable in the endpoint. address lzToken = endpoint.lzToken(); if (lzToken == address(0)) revert LzTokenUnavailable(); // Pay LZ token fee by sending tokens to the endpoint. IERC20(lzToken).safeTransferFrom(msg.sender, address(endpoint), _lzTokenFee); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { MessagingReceipt, MessagingFee } from "../../oapp/OAppSender.sol"; /** * @dev Struct representing token parameters for the OFT send() operation. */ struct SendParam { uint32 dstEid; // Destination endpoint ID. bytes32 to; // Recipient address. uint256 amountLD; // Amount to send in local decimals. uint256 minAmountLD; // Minimum amount to send in local decimals. bytes extraOptions; // Additional options supplied by the caller to be used in the LayerZero message. bytes composeMsg; // The composed message for the send() operation. bytes oftCmd; // The OFT command to be executed, unused in default OFT implementations. } /** * @dev Struct representing OFT limit information. * @dev These amounts can change dynamically and are up the the specific oft implementation. */ struct OFTLimit { uint256 minAmountLD; // Minimum amount in local decimals that can be sent to the recipient. uint256 maxAmountLD; // Maximum amount in local decimals that can be sent to the recipient. } /** * @dev Struct representing OFT receipt information. */ struct OFTReceipt { uint256 amountSentLD; // Amount of tokens ACTUALLY debited from the sender in local decimals. // @dev In non-default implementations, the amountReceivedLD COULD differ from this value. uint256 amountReceivedLD; // Amount of tokens to be received on the remote side. } /** * @dev Struct representing OFT fee details. * @dev Future proof mechanism to provide a standardized way to communicate fees to things like a UI. */ struct OFTFeeDetail { int256 feeAmountLD; // Amount of the fee in local decimals. string description; // Description of the fee. } /** * @title IOFT * @dev Interface for the OftChain (OFT) token. * @dev Does not inherit ERC20 to accommodate usage by OFTAdapter as well. * @dev This specific interface ID is '0x02e49c2c'. */ interface IOFT { // Custom error messages error InvalidLocalDecimals(); error SlippageExceeded(uint256 amountLD, uint256 minAmountLD); // Events event OFTSent( bytes32 indexed guid, // GUID of the OFT message. uint32 dstEid, // Destination Endpoint ID. address indexed fromAddress, // Address of the sender on the src chain. uint256 amountSentLD, // Amount of tokens sent in local decimals. uint256 amountReceivedLD // Amount of tokens received in local decimals. ); event OFTReceived( bytes32 indexed guid, // GUID of the OFT message. uint32 srcEid, // Source Endpoint ID. address indexed toAddress, // Address of the recipient on the dst chain. uint256 amountReceivedLD // Amount of tokens received in local decimals. ); /** * @notice Retrieves interfaceID and the version of the OFT. * @return interfaceId The interface ID. * @return version The version. * * @dev interfaceId: This specific interface ID is '0x02e49c2c'. * @dev version: Indicates a cross-chain compatible msg encoding with other OFTs. * @dev If a new feature is added to the OFT cross-chain msg encoding, the version will be incremented. * ie. localOFT version(x,1) CAN send messages to remoteOFT version(x,1) */ function oftVersion() external view returns (bytes4 interfaceId, uint64 version); /** * @notice Retrieves the address of the token associated with the OFT. * @return token The address of the ERC20 token implementation. */ function token() external view returns (address); /** * @notice Indicates whether the OFT contract requires approval of the 'token()' to send. * @return requiresApproval Needs approval of the underlying token implementation. * * @dev Allows things like wallet implementers to determine integration requirements, * without understanding the underlying token implementation. */ function approvalRequired() external view returns (bool); /** * @notice Retrieves the shared decimals of the OFT. * @return sharedDecimals The shared decimals of the OFT. */ function sharedDecimals() external view returns (uint8); /** * @notice Provides a quote for OFT-related operations. * @param _sendParam The parameters for the send operation. * @return limit The OFT limit information. * @return oftFeeDetails The details of OFT fees. * @return receipt The OFT receipt information. */ function quoteOFT( SendParam calldata _sendParam ) external view returns (OFTLimit memory, OFTFeeDetail[] memory oftFeeDetails, OFTReceipt memory); /** * @notice Provides a quote for the send() operation. * @param _sendParam The parameters for the send() operation. * @param _payInLzToken Flag indicating whether the caller is paying in the LZ token. * @return fee The calculated LayerZero messaging fee from the send() operation. * * @dev MessagingFee: LayerZero msg fee * - nativeFee: The native fee. * - lzTokenFee: The lzToken fee. */ function quoteSend(SendParam calldata _sendParam, bool _payInLzToken) external view returns (MessagingFee memory); /** * @notice Executes the send() operation. * @param _sendParam The parameters for the send operation. * @param _fee The fee information supplied by the caller. * - nativeFee: The native fee. * - lzTokenFee: The lzToken fee. * @param _refundAddress The address to receive any excess funds from fees etc. on the src. * @return receipt The LayerZero messaging receipt from the send() operation. * @return oftReceipt The OFT receipt information. * * @dev MessagingReceipt: LayerZero msg receipt * - guid: The unique identifier for the sent message. * - nonce: The nonce of the sent message. * - fee: The LayerZero fee incurred for the message. */ function send( SendParam calldata _sendParam, MessagingFee calldata _fee, address _refundAddress ) external payable returns (MessagingReceipt memory, OFTReceipt memory); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; library OFTComposeMsgCodec { // Offset constants for decoding composed messages uint8 private constant NONCE_OFFSET = 8; uint8 private constant SRC_EID_OFFSET = 12; uint8 private constant AMOUNT_LD_OFFSET = 44; uint8 private constant COMPOSE_FROM_OFFSET = 76; /** * @dev Encodes a OFT composed message. * @param _nonce The nonce value. * @param _srcEid The source endpoint ID. * @param _amountLD The amount in local decimals. * @param _composeMsg The composed message. * @return _msg The encoded Composed message. */ function encode( uint64 _nonce, uint32 _srcEid, uint256 _amountLD, bytes memory _composeMsg // 0x[composeFrom][composeMsg] ) internal pure returns (bytes memory _msg) { _msg = abi.encodePacked(_nonce, _srcEid, _amountLD, _composeMsg); } /** * @dev Retrieves the nonce from the composed message. * @param _msg The message. * @return The nonce value. */ function nonce(bytes calldata _msg) internal pure returns (uint64) { return uint64(bytes8(_msg[:NONCE_OFFSET])); } /** * @dev Retrieves the source endpoint ID from the composed message. * @param _msg The message. * @return The source endpoint ID. */ function srcEid(bytes calldata _msg) internal pure returns (uint32) { return uint32(bytes4(_msg[NONCE_OFFSET:SRC_EID_OFFSET])); } /** * @dev Retrieves the amount in local decimals from the composed message. * @param _msg The message. * @return The amount in local decimals. */ function amountLD(bytes calldata _msg) internal pure returns (uint256) { return uint256(bytes32(_msg[SRC_EID_OFFSET:AMOUNT_LD_OFFSET])); } /** * @dev Retrieves the composeFrom value from the composed message. * @param _msg The message. * @return The composeFrom value. */ function composeFrom(bytes calldata _msg) internal pure returns (bytes32) { return bytes32(_msg[AMOUNT_LD_OFFSET:COMPOSE_FROM_OFFSET]); } /** * @dev Retrieves the composed message. * @param _msg The message. * @return The composed message. */ function composeMsg(bytes calldata _msg) internal pure returns (bytes memory) { return _msg[COMPOSE_FROM_OFFSET:]; } /** * @dev Converts an address to bytes32. * @param _addr The address to convert. * @return The bytes32 representation of the address. */ function addressToBytes32(address _addr) internal pure returns (bytes32) { return bytes32(uint256(uint160(_addr))); } /** * @dev Converts bytes32 to an address. * @param _b The bytes32 value to convert. * @return The address representation of bytes32. */ function bytes32ToAddress(bytes32 _b) internal pure returns (address) { return address(uint160(uint256(_b))); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; library OFTMsgCodec { // Offset constants for encoding and decoding OFT messages uint8 private constant SEND_TO_OFFSET = 32; uint8 private constant SEND_AMOUNT_SD_OFFSET = 40; /** * @dev Encodes an OFT LayerZero message. * @param _sendTo The recipient address. * @param _amountShared The amount in shared decimals. * @param _composeMsg The composed message. * @return _msg The encoded message. * @return hasCompose A boolean indicating whether the message has a composed payload. */ function encode( bytes32 _sendTo, uint64 _amountShared, bytes memory _composeMsg ) internal view returns (bytes memory _msg, bool hasCompose) { hasCompose = _composeMsg.length > 0; // @dev Remote chains will want to know the composed function caller ie. msg.sender on the src. _msg = hasCompose ? abi.encodePacked(_sendTo, _amountShared, addressToBytes32(msg.sender), _composeMsg) : abi.encodePacked(_sendTo, _amountShared); } /** * @dev Checks if the OFT message is composed. * @param _msg The OFT message. * @return A boolean indicating whether the message is composed. */ function isComposed(bytes calldata _msg) internal pure returns (bool) { return _msg.length > SEND_AMOUNT_SD_OFFSET; } /** * @dev Retrieves the recipient address from the OFT message. * @param _msg The OFT message. * @return The recipient address. */ function sendTo(bytes calldata _msg) internal pure returns (bytes32) { return bytes32(_msg[:SEND_TO_OFFSET]); } /** * @dev Retrieves the amount in shared decimals from the OFT message. * @param _msg The OFT message. * @return The amount in shared decimals. */ function amountSD(bytes calldata _msg) internal pure returns (uint64) { return uint64(bytes8(_msg[SEND_TO_OFFSET:SEND_AMOUNT_SD_OFFSET])); } /** * @dev Retrieves the composed message from the OFT message. * @param _msg The OFT message. * @return The composed message. */ function composeMsg(bytes calldata _msg) internal pure returns (bytes memory) { return _msg[SEND_AMOUNT_SD_OFFSET:]; } /** * @dev Converts an address to bytes32. * @param _addr The address to convert. * @return The bytes32 representation of the address. */ function addressToBytes32(address _addr) internal pure returns (bytes32) { return bytes32(uint256(uint160(_addr))); } /** * @dev Converts bytes32 to an address. * @param _b The bytes32 value to convert. * @return The address representation of bytes32. */ function bytes32ToAddress(bytes32 _b) internal pure returns (address) { return address(uint160(uint256(_b))); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol"; import { IOFT, OFTCore } from "./OFTCore.sol"; /** * @title OFT Contract * @dev OFT is an ERC-20 token that extends the functionality of the OFTCore contract. */ abstract contract OFT is OFTCore, ERC20 { /** * @dev Constructor for the OFT contract. * @param _name The name of the OFT. * @param _symbol The symbol of the OFT. * @param _lzEndpoint The LayerZero endpoint address. * @param _delegate The delegate capable of making OApp configurations inside of the endpoint. */ constructor( string memory _name, string memory _symbol, address _lzEndpoint, address _delegate ) ERC20(_name, _symbol) OFTCore(decimals(), _lzEndpoint, _delegate) {} /** * @dev Retrieves the address of the underlying ERC20 implementation. * @return The address of the OFT token. * * @dev In the case of OFT, address(this) and erc20 are the same contract. */ function token() public view returns (address) { return address(this); } /** * @notice Indicates whether the OFT contract requires approval of the 'token()' to send. * @return requiresApproval Needs approval of the underlying token implementation. * * @dev In the case of OFT where the contract IS the token, approval is NOT required. */ function approvalRequired() external pure virtual returns (bool) { return false; } /** * @dev Burns tokens from the sender's specified balance. * @param _from The address to debit the tokens from. * @param _amountLD The amount of tokens to send in local decimals. * @param _minAmountLD The minimum amount to send in local decimals. * @param _dstEid The destination chain ID. * @return amountSentLD The amount sent in local decimals. * @return amountReceivedLD The amount received in local decimals on the remote. */ function _debit( address _from, uint256 _amountLD, uint256 _minAmountLD, uint32 _dstEid ) internal virtual override returns (uint256 amountSentLD, uint256 amountReceivedLD) { (amountSentLD, amountReceivedLD) = _debitView(_amountLD, _minAmountLD, _dstEid); // @dev In NON-default OFT, amountSentLD could be 100, with a 10% fee, the amountReceivedLD amount is 90, // therefore amountSentLD CAN differ from amountReceivedLD. // @dev Default OFT burns on src. _burn(_from, amountSentLD); } /** * @dev Credits tokens to the specified address. * @param _to The address to credit the tokens to. * @param _amountLD The amount of tokens to credit in local decimals. * @dev _srcEid The source chain ID. * @return amountReceivedLD The amount of tokens ACTUALLY received in local decimals. */ function _credit( address _to, uint256 _amountLD, uint32 /*_srcEid*/ ) internal virtual override returns (uint256 amountReceivedLD) { // @dev Default OFT mints on dst. _mint(_to, _amountLD); // @dev In the case of NON-default OFT, the _amountLD MIGHT not be == amountReceivedLD. return _amountLD; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { IERC20Metadata, IERC20 } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol"; import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; import { IOFT, OFTCore } from "./OFTCore.sol"; /** * @title OFTAdapter Contract * @dev OFTAdapter is a contract that adapts an ERC-20 token to the OFT functionality. * * @dev For existing ERC20 tokens, this can be used to convert the token to crosschain compatibility. * @dev WARNING: ONLY 1 of these should exist for a given global mesh, * unless you make a NON-default implementation of OFT and needs to be done very carefully. * @dev WARNING: The default OFTAdapter implementation assumes LOSSLESS transfers, ie. 1 token in, 1 token out. * IF the 'innerToken' applies something like a transfer fee, the default will NOT work... * a pre/post balance check will need to be done to calculate the amountSentLD/amountReceivedLD. */ abstract contract OFTAdapter is OFTCore { using SafeERC20 for IERC20; IERC20 internal immutable innerToken; /** * @dev Constructor for the OFTAdapter contract. * @param _token The address of the ERC-20 token to be adapted. * @param _lzEndpoint The LayerZero endpoint address. * @param _delegate The delegate capable of making OApp configurations inside of the endpoint. */ constructor( address _token, address _lzEndpoint, address _delegate ) OFTCore(IERC20Metadata(_token).decimals(), _lzEndpoint, _delegate) { innerToken = IERC20(_token); } /** * @dev Retrieves the address of the underlying ERC20 implementation. * @return The address of the adapted ERC-20 token. * * @dev In the case of OFTAdapter, address(this) and erc20 are NOT the same contract. */ function token() public view returns (address) { return address(innerToken); } /** * @notice Indicates whether the OFT contract requires approval of the 'token()' to send. * @return requiresApproval Needs approval of the underlying token implementation. * * @dev In the case of default OFTAdapter, approval is required. * @dev In non-default OFTAdapter contracts with something like mint and burn privileges, it would NOT need approval. */ function approvalRequired() external pure virtual returns (bool) { return true; } /** * @dev Burns tokens from the sender's specified balance, ie. pull method. * @param _from The address to debit from. * @param _amountLD The amount of tokens to send in local decimals. * @param _minAmountLD The minimum amount to send in local decimals. * @param _dstEid The destination chain ID. * @return amountSentLD The amount sent in local decimals. * @return amountReceivedLD The amount received in local decimals on the remote. * * @dev msg.sender will need to approve this _amountLD of tokens to be locked inside of the contract. * @dev WARNING: The default OFTAdapter implementation assumes LOSSLESS transfers, ie. 1 token in, 1 token out. * IF the 'innerToken' applies something like a transfer fee, the default will NOT work... * a pre/post balance check will need to be done to calculate the amountReceivedLD. */ function _debit( address _from, uint256 _amountLD, uint256 _minAmountLD, uint32 _dstEid ) internal virtual override returns (uint256 amountSentLD, uint256 amountReceivedLD) { (amountSentLD, amountReceivedLD) = _debitView(_amountLD, _minAmountLD, _dstEid); // @dev Lock tokens by moving them into this contract from the caller. innerToken.safeTransferFrom(_from, address(this), amountSentLD); } /** * @dev Credits tokens to the specified address. * @param _to The address to credit the tokens to. * @param _amountLD The amount of tokens to credit in local decimals. * @dev _srcEid The source chain ID. * @return amountReceivedLD The amount of tokens ACTUALLY received in local decimals. * * @dev WARNING: The default OFTAdapter implementation assumes LOSSLESS transfers, ie. 1 token in, 1 token out. * IF the 'innerToken' applies something like a transfer fee, the default will NOT work... * a pre/post balance check will need to be done to calculate the amountReceivedLD. */ function _credit( address _to, uint256 _amountLD, uint32 /*_srcEid*/ ) internal virtual override returns (uint256 amountReceivedLD) { // @dev Unlock the tokens and transfer to the recipient. innerToken.safeTransfer(_to, _amountLD); // @dev In the case of NON-default OFTAdapter, the amountLD MIGHT not be == amountReceivedLD. return _amountLD; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { OApp, Origin } from "../oapp/OApp.sol"; import { OAppOptionsType3 } from "../oapp/libs/OAppOptionsType3.sol"; import { IOAppMsgInspector } from "../oapp/interfaces/IOAppMsgInspector.sol"; import { OAppPreCrimeSimulator } from "../precrime/OAppPreCrimeSimulator.sol"; import { IOFT, SendParam, OFTLimit, OFTReceipt, OFTFeeDetail, MessagingReceipt, MessagingFee } from "./interfaces/IOFT.sol"; import { OFTMsgCodec } from "./libs/OFTMsgCodec.sol"; import { OFTComposeMsgCodec } from "./libs/OFTComposeMsgCodec.sol"; /** * @title OFTCore * @dev Abstract contract for the OftChain (OFT) token. */ abstract contract OFTCore is IOFT, OApp, OAppPreCrimeSimulator, OAppOptionsType3 { using OFTMsgCodec for bytes; using OFTMsgCodec for bytes32; // @notice Provides a conversion rate when swapping between denominations of SD and LD // - shareDecimals == SD == shared Decimals // - localDecimals == LD == local decimals // @dev Considers that tokens have different decimal amounts on various chains. // @dev eg. // For a token // - locally with 4 decimals --> 1.2345 => uint(12345) // - remotely with 2 decimals --> 1.23 => uint(123) // - The conversion rate would be 10 ** (4 - 2) = 100 // @dev If you want to send 1.2345 -> (uint 12345), you CANNOT represent that value on the remote, // you can only display 1.23 -> uint(123). // @dev To preserve the dust that would otherwise be lost on that conversion, // we need to unify a denomination that can be represented on ALL chains inside of the OFT mesh uint256 public immutable decimalConversionRate; // @notice Msg types that are used to identify the various OFT operations. // @dev This can be extended in child contracts for non-default oft operations // @dev These values are used in things like combineOptions() in OAppOptionsType3.sol. uint16 public constant SEND = 1; uint16 public constant SEND_AND_CALL = 2; // Address of an optional contract to inspect both 'message' and 'options' address public msgInspector; event MsgInspectorSet(address inspector); /** * @dev Constructor. * @param _localDecimals The decimals of the token on the local chain (this chain). * @param _endpoint The address of the LayerZero endpoint. * @param _delegate The delegate capable of making OApp configurations inside of the endpoint. */ constructor(uint8 _localDecimals, address _endpoint, address _delegate) OApp(_endpoint, _delegate) { if (_localDecimals < sharedDecimals()) revert InvalidLocalDecimals(); decimalConversionRate = 10 ** (_localDecimals - sharedDecimals()); } /** * @notice Retrieves interfaceID and the version of the OFT. * @return interfaceId The interface ID. * @return version The version. * * @dev interfaceId: This specific interface ID is '0x02e49c2c'. * @dev version: Indicates a cross-chain compatible msg encoding with other OFTs. * @dev If a new feature is added to the OFT cross-chain msg encoding, the version will be incremented. * ie. localOFT version(x,1) CAN send messages to remoteOFT version(x,1) */ function oftVersion() external pure virtual returns (bytes4 interfaceId, uint64 version) { return (type(IOFT).interfaceId, 1); } /** * @dev Retrieves the shared decimals of the OFT. * @return The shared decimals of the OFT. * * @dev Sets an implicit cap on the amount of tokens, over uint64.max() will need some sort of outbound cap / totalSupply cap * Lowest common decimal denominator between chains. * Defaults to 6 decimal places to provide up to 18,446,744,073,709.551615 units (max uint64). * For tokens exceeding this totalSupply(), they will need to override the sharedDecimals function with something smaller. * ie. 4 sharedDecimals would be 1,844,674,407,370,955.1615 */ function sharedDecimals() public view virtual returns (uint8) { return 6; } /** * @dev Sets the message inspector address for the OFT. * @param _msgInspector The address of the message inspector. * * @dev This is an optional contract that can be used to inspect both 'message' and 'options'. * @dev Set it to address(0) to disable it, or set it to a contract address to enable it. */ function setMsgInspector(address _msgInspector) public virtual onlyOwner { msgInspector = _msgInspector; emit MsgInspectorSet(_msgInspector); } /** * @notice Provides a quote for OFT-related operations. * @param _sendParam The parameters for the send operation. * @return oftLimit The OFT limit information. * @return oftFeeDetails The details of OFT fees. * @return oftReceipt The OFT receipt information. */ function quoteOFT( SendParam calldata _sendParam ) external view virtual returns (OFTLimit memory oftLimit, OFTFeeDetail[] memory oftFeeDetails, OFTReceipt memory oftReceipt) { uint256 minAmountLD = 0; // Unused in the default implementation. uint256 maxAmountLD = type(uint64).max; // Unused in the default implementation. oftLimit = OFTLimit(minAmountLD, maxAmountLD); // Unused in the default implementation; reserved for future complex fee details. oftFeeDetails = new OFTFeeDetail[](0); // @dev This is the same as the send() operation, but without the actual send. // - amountSentLD is the amount in local decimals that would be sent from the sender. // - amountReceivedLD is the amount in local decimals that will be credited to the recipient on the remote OFT instance. // @dev The amountSentLD MIGHT not equal the amount the user actually receives. HOWEVER, the default does. (uint256 amountSentLD, uint256 amountReceivedLD) = _debitView( _sendParam.amountLD, _sendParam.minAmountLD, _sendParam.dstEid ); oftReceipt = OFTReceipt(amountSentLD, amountReceivedLD); } /** * @notice Provides a quote for the send() operation. * @param _sendParam The parameters for the send() operation. * @param _payInLzToken Flag indicating whether the caller is paying in the LZ token. * @return msgFee The calculated LayerZero messaging fee from the send() operation. * * @dev MessagingFee: LayerZero msg fee * - nativeFee: The native fee. * - lzTokenFee: The lzToken fee. */ function quoteSend( SendParam calldata _sendParam, bool _payInLzToken ) external view virtual returns (MessagingFee memory msgFee) { // @dev mock the amount to receive, this is the same operation used in the send(). // The quote is as similar as possible to the actual send() operation. (, uint256 amountReceivedLD) = _debitView(_sendParam.amountLD, _sendParam.minAmountLD, _sendParam.dstEid); // @dev Builds the options and OFT message to quote in the endpoint. (bytes memory message, bytes memory options) = _buildMsgAndOptions(_sendParam, amountReceivedLD); // @dev Calculates the LayerZero fee for the send() operation. return _quote(_sendParam.dstEid, message, options, _payInLzToken); } /** * @dev Executes the send operation. * @param _sendParam The parameters for the send operation. * @param _fee The calculated fee for the send() operation. * - nativeFee: The native fee. * - lzTokenFee: The lzToken fee. * @param _refundAddress The address to receive any excess funds. * @return msgReceipt The receipt for the send operation. * @return oftReceipt The OFT receipt information. * * @dev MessagingReceipt: LayerZero msg receipt * - guid: The unique identifier for the sent message. * - nonce: The nonce of the sent message. * - fee: The LayerZero fee incurred for the message. */ function send( SendParam calldata _sendParam, MessagingFee calldata _fee, address _refundAddress ) external payable virtual returns (MessagingReceipt memory msgReceipt, OFTReceipt memory oftReceipt) { // @dev Applies the token transfers regarding this send() operation. // - amountSentLD is the amount in local decimals that was ACTUALLY sent/debited from the sender. // - amountReceivedLD is the amount in local decimals that will be received/credited to the recipient on the remote OFT instance. (uint256 amountSentLD, uint256 amountReceivedLD) = _debit( msg.sender, _sendParam.amountLD, _sendParam.minAmountLD, _sendParam.dstEid ); // @dev Builds the options and OFT message to quote in the endpoint. (bytes memory message, bytes memory options) = _buildMsgAndOptions(_sendParam, amountReceivedLD); // @dev Sends the message to the LayerZero endpoint and returns the LayerZero msg receipt. msgReceipt = _lzSend(_sendParam.dstEid, message, options, _fee, _refundAddress); // @dev Formulate the OFT receipt. oftReceipt = OFTReceipt(amountSentLD, amountReceivedLD); emit OFTSent(msgReceipt.guid, _sendParam.dstEid, msg.sender, amountSentLD, amountReceivedLD); } /** * @dev Internal function to build the message and options. * @param _sendParam The parameters for the send() operation. * @param _amountLD The amount in local decimals. * @return message The encoded message. * @return options The encoded options. */ function _buildMsgAndOptions( SendParam calldata _sendParam, uint256 _amountLD ) internal view virtual returns (bytes memory message, bytes memory options) { bool hasCompose; // @dev This generated message has the msg.sender encoded into the payload so the remote knows who the caller is. (message, hasCompose) = OFTMsgCodec.encode( _sendParam.to, _toSD(_amountLD), // @dev Must be include a non empty bytes if you want to compose, EVEN if you dont need it on the remote. // EVEN if you dont require an arbitrary payload to be sent... eg. '0x01' _sendParam.composeMsg ); // @dev Change the msg type depending if its composed or not. uint16 msgType = hasCompose ? SEND_AND_CALL : SEND; // @dev Combine the callers _extraOptions with the enforced options via the OAppOptionsType3. options = combineOptions(_sendParam.dstEid, msgType, _sendParam.extraOptions); // @dev Optionally inspect the message and options depending if the OApp owner has set a msg inspector. // @dev If it fails inspection, needs to revert in the implementation. ie. does not rely on return boolean if (msgInspector != address(0)) IOAppMsgInspector(msgInspector).inspect(message, options); } /** * @dev Internal function to handle the receive on the LayerZero endpoint. * @param _origin The origin information. * - srcEid: The source chain endpoint ID. * - sender: The sender address from the src chain. * - nonce: The nonce of the LayerZero message. * @param _guid The unique identifier for the received LayerZero message. * @param _message The encoded message. * @dev _executor The address of the executor. * @dev _extraData Additional data. */ function _lzReceive( Origin calldata _origin, bytes32 _guid, bytes calldata _message, address /*_executor*/, // @dev unused in the default implementation. bytes calldata /*_extraData*/ // @dev unused in the default implementation. ) internal virtual override { // @dev The src sending chain doesnt know the address length on this chain (potentially non-evm) // Thus everything is bytes32() encoded in flight. address toAddress = _message.sendTo().bytes32ToAddress(); // @dev Credit the amountLD to the recipient and return the ACTUAL amount the recipient received in local decimals uint256 amountReceivedLD = _credit(toAddress, _toLD(_message.amountSD()), _origin.srcEid); if (_message.isComposed()) { // @dev Proprietary composeMsg format for the OFT. bytes memory composeMsg = OFTComposeMsgCodec.encode( _origin.nonce, _origin.srcEid, amountReceivedLD, _message.composeMsg() ); // @dev Stores the lzCompose payload that will be executed in a separate tx. // Standardizes functionality for executing arbitrary contract invocation on some non-evm chains. // @dev The off-chain executor will listen and process the msg based on the src-chain-callers compose options passed. // @dev The index is used when a OApp needs to compose multiple msgs on lzReceive. // For default OFT implementation there is only 1 compose msg per lzReceive, thus its always 0. endpoint.sendCompose(toAddress, _guid, 0 /* the index of the composed message*/, composeMsg); } emit OFTReceived(_guid, _origin.srcEid, toAddress, amountReceivedLD); } /** * @dev Internal function to handle the OAppPreCrimeSimulator simulated receive. * @param _origin The origin information. * - srcEid: The source chain endpoint ID. * - sender: The sender address from the src chain. * - nonce: The nonce of the LayerZero message. * @param _guid The unique identifier for the received LayerZero message. * @param _message The LayerZero message. * @param _executor The address of the off-chain executor. * @param _extraData Arbitrary data passed by the msg executor. * * @dev Enables the preCrime simulator to mock sending lzReceive() messages, * routes the msg down from the OAppPreCrimeSimulator, and back up to the OAppReceiver. */ function _lzReceiveSimulate( Origin calldata _origin, bytes32 _guid, bytes calldata _message, address _executor, bytes calldata _extraData ) internal virtual override { _lzReceive(_origin, _guid, _message, _executor, _extraData); } /** * @dev Check if the peer is considered 'trusted' by the OApp. * @param _eid The endpoint ID to check. * @param _peer The peer to check. * @return Whether the peer passed is considered 'trusted' by the OApp. * * @dev Enables OAppPreCrimeSimulator to check whether a potential Inbound Packet is from a trusted source. */ function isPeer(uint32 _eid, bytes32 _peer) public view virtual override returns (bool) { return peers[_eid] == _peer; } /** * @dev Internal function to remove dust from the given local decimal amount. * @param _amountLD The amount in local decimals. * @return amountLD The amount after removing dust. * * @dev Prevents the loss of dust when moving amounts between chains with different decimals. * @dev eg. uint(123) with a conversion rate of 100 becomes uint(100). */ function _removeDust(uint256 _amountLD) internal view virtual returns (uint256 amountLD) { return (_amountLD / decimalConversionRate) * decimalConversionRate; } /** * @dev Internal function to convert an amount from shared decimals into local decimals. * @param _amountSD The amount in shared decimals. * @return amountLD The amount in local decimals. */ function _toLD(uint64 _amountSD) internal view virtual returns (uint256 amountLD) { return _amountSD * decimalConversionRate; } /** * @dev Internal function to convert an amount from local decimals into shared decimals. * @param _amountLD The amount in local decimals. * @return amountSD The amount in shared decimals. */ function _toSD(uint256 _amountLD) internal view virtual returns (uint64 amountSD) { return uint64(_amountLD / decimalConversionRate); } /** * @dev Internal function to mock the amount mutation from a OFT debit() operation. * @param _amountLD The amount to send in local decimals. * @param _minAmountLD The minimum amount to send in local decimals. * @dev _dstEid The destination endpoint ID. * @return amountSentLD The amount sent, in local decimals. * @return amountReceivedLD The amount to be received on the remote chain, in local decimals. * * @dev This is where things like fees would be calculated and deducted from the amount to be received on the remote. */ function _debitView( uint256 _amountLD, uint256 _minAmountLD, uint32 /*_dstEid*/ ) internal view virtual returns (uint256 amountSentLD, uint256 amountReceivedLD) { // @dev Remove the dust so nothing is lost on the conversion between chains with different decimals for the token. amountSentLD = _removeDust(_amountLD); // @dev The amount to send is the same as amount received in the default implementation. amountReceivedLD = amountSentLD; // @dev Check for slippage. if (amountReceivedLD < _minAmountLD) { revert SlippageExceeded(amountReceivedLD, _minAmountLD); } } /** * @dev Internal function to perform a debit operation. * @param _from The address to debit. * @param _amountLD The amount to send in local decimals. * @param _minAmountLD The minimum amount to send in local decimals. * @param _dstEid The destination endpoint ID. * @return amountSentLD The amount sent in local decimals. * @return amountReceivedLD The amount received in local decimals on the remote. * * @dev Defined here but are intended to be overriden depending on the OFT implementation. * @dev Depending on OFT implementation the _amountLD could differ from the amountReceivedLD. */ function _debit( address _from, uint256 _amountLD, uint256 _minAmountLD, uint32 _dstEid ) internal virtual returns (uint256 amountSentLD, uint256 amountReceivedLD); /** * @dev Internal function to perform a credit operation. * @param _to The address to credit. * @param _amountLD The amount to credit in local decimals. * @param _srcEid The source endpoint ID. * @return amountReceivedLD The amount ACTUALLY received in local decimals. * * @dev Defined here but are intended to be overriden depending on the OFT implementation. * @dev Depending on OFT implementation the _amountLD could differ from the amountReceivedLD. */ function _credit( address _to, uint256 _amountLD, uint32 _srcEid ) internal virtual returns (uint256 amountReceivedLD); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; // @dev Import the Origin so it's exposed to OAppPreCrimeSimulator implementers. // solhint-disable-next-line no-unused-import import { InboundPacket, Origin } from "../libs/Packet.sol"; /** * @title IOAppPreCrimeSimulator Interface * @dev Interface for the preCrime simulation functionality in an OApp. */ interface IOAppPreCrimeSimulator { // @dev simulation result used in PreCrime implementation error SimulationResult(bytes result); error OnlySelf(); /** * @dev Emitted when the preCrime contract address is set. * @param preCrimeAddress The address of the preCrime contract. */ event PreCrimeSet(address preCrimeAddress); /** * @dev Retrieves the address of the preCrime contract implementation. * @return The address of the preCrime contract. */ function preCrime() external view returns (address); /** * @dev Retrieves the address of the OApp contract. * @return The address of the OApp contract. */ function oApp() external view returns (address); /** * @dev Sets the preCrime contract address. * @param _preCrime The address of the preCrime contract. */ function setPreCrime(address _preCrime) external; /** * @dev Mocks receiving a packet, then reverts with a series of data to infer the state/result. * @param _packets An array of LayerZero InboundPacket objects representing received packets. */ function lzReceiveAndRevert(InboundPacket[] calldata _packets) external payable; /** * @dev checks if the specified peer is considered 'trusted' by the OApp. * @param _eid The endpoint Id to check. * @param _peer The peer to check. * @return Whether the peer passed is considered 'trusted' by the OApp. */ function isPeer(uint32 _eid, bytes32 _peer) external view returns (bool); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; struct PreCrimePeer { uint32 eid; bytes32 preCrime; bytes32 oApp; } // TODO not done yet interface IPreCrime { error OnlyOffChain(); // for simulate() error PacketOversize(uint256 max, uint256 actual); error PacketUnsorted(); error SimulationFailed(bytes reason); // for preCrime() error SimulationResultNotFound(uint32 eid); error InvalidSimulationResult(uint32 eid, bytes reason); error CrimeFound(bytes crime); function getConfig(bytes[] calldata _packets, uint256[] calldata _packetMsgValues) external returns (bytes memory); function simulate( bytes[] calldata _packets, uint256[] calldata _packetMsgValues ) external payable returns (bytes memory); function buildSimulationResult() external view returns (bytes memory); function preCrime( bytes[] calldata _packets, uint256[] calldata _packetMsgValues, bytes[] calldata _simulations ) external; function version() external view returns (uint64 major, uint8 minor); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { Origin } from "@layerzerolabs/lz-evm-protocol-v2/contracts/interfaces/ILayerZeroEndpointV2.sol"; import { PacketV1Codec } from "@layerzerolabs/lz-evm-protocol-v2/contracts/messagelib/libs/PacketV1Codec.sol"; /** * @title InboundPacket * @dev Structure representing an inbound packet received by the contract. */ struct InboundPacket { Origin origin; // Origin information of the packet. uint32 dstEid; // Destination endpointId of the packet. address receiver; // Receiver address for the packet. bytes32 guid; // Unique identifier of the packet. uint256 value; // msg.value of the packet. address executor; // Executor address for the packet. bytes message; // Message payload of the packet. bytes extraData; // Additional arbitrary data for the packet. } /** * @title PacketDecoder * @dev Library for decoding LayerZero packets. */ library PacketDecoder { using PacketV1Codec for bytes; /** * @dev Decode an inbound packet from the given packet data. * @param _packet The packet data to decode. * @return packet An InboundPacket struct representing the decoded packet. */ function decode(bytes calldata _packet) internal pure returns (InboundPacket memory packet) { packet.origin = Origin(_packet.srcEid(), _packet.sender(), _packet.nonce()); packet.dstEid = _packet.dstEid(); packet.receiver = _packet.receiverB20(); packet.guid = _packet.guid(); packet.message = _packet.message(); } /** * @dev Decode multiple inbound packets from the given packet data and associated message values. * @param _packets An array of packet data to decode. * @param _packetMsgValues An array of associated message values for each packet. * @return packets An array of InboundPacket structs representing the decoded packets. */ function decode( bytes[] calldata _packets, uint256[] memory _packetMsgValues ) internal pure returns (InboundPacket[] memory packets) { packets = new InboundPacket[](_packets.length); for (uint256 i = 0; i < _packets.length; i++) { bytes calldata packet = _packets[i]; packets[i] = PacketDecoder.decode(packet); // @dev Allows the verifier to specify the msg.value that gets passed in lzReceive. packets[i].value = _packetMsgValues[i]; } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; import { IPreCrime } from "./interfaces/IPreCrime.sol"; import { IOAppPreCrimeSimulator, InboundPacket, Origin } from "./interfaces/IOAppPreCrimeSimulator.sol"; /** * @title OAppPreCrimeSimulator * @dev Abstract contract serving as the base for preCrime simulation functionality in an OApp. */ abstract contract OAppPreCrimeSimulator is IOAppPreCrimeSimulator, Ownable { // The address of the preCrime implementation. address public preCrime; /** * @dev Retrieves the address of the OApp contract. * @return The address of the OApp contract. * * @dev The simulator contract is the base contract for the OApp by default. * @dev If the simulator is a separate contract, override this function. */ function oApp() external view virtual returns (address) { return address(this); } /** * @dev Sets the preCrime contract address. * @param _preCrime The address of the preCrime contract. */ function setPreCrime(address _preCrime) public virtual onlyOwner { preCrime = _preCrime; emit PreCrimeSet(_preCrime); } /** * @dev Interface for pre-crime simulations. Always reverts at the end with the simulation results. * @param _packets An array of InboundPacket objects representing received packets to be delivered. * * @dev WARNING: MUST revert at the end with the simulation results. * @dev Gives the preCrime implementation the ability to mock sending packets to the lzReceive function, * WITHOUT actually executing them. */ function lzReceiveAndRevert(InboundPacket[] calldata _packets) public payable virtual { for (uint256 i = 0; i < _packets.length; i++) { InboundPacket calldata packet = _packets[i]; // Ignore packets that are not from trusted peers. if (!isPeer(packet.origin.srcEid, packet.origin.sender)) continue; // @dev Because a verifier is calling this function, it doesnt have access to executor params: // - address _executor // - bytes calldata _extraData // preCrime will NOT work for OApps that rely on these two parameters inside of their _lzReceive(). // They are instead stubbed to default values, address(0) and bytes("") // @dev Calling this.lzReceiveSimulate removes ability for assembly return 0 callstack exit, // which would cause the revert to be ignored. this.lzReceiveSimulate{ value: packet.value }( packet.origin, packet.guid, packet.message, packet.executor, packet.extraData ); } // @dev Revert with the simulation results. msg.sender must implement IPreCrime.buildSimulationResult(). revert SimulationResult(IPreCrime(msg.sender).buildSimulationResult()); } /** * @dev Is effectively an internal function because msg.sender must be address(this). * Allows resetting the call stack for 'internal' calls. * @param _origin The origin information containing the source endpoint and sender address. * - srcEid: The source chain endpoint ID. * - sender: The sender address on the src chain. * - nonce: The nonce of the message. * @param _guid The unique identifier of the packet. * @param _message The message payload of the packet. * @param _executor The executor address for the packet. * @param _extraData Additional data for the packet. */ function lzReceiveSimulate( Origin calldata _origin, bytes32 _guid, bytes calldata _message, address _executor, bytes calldata _extraData ) external payable virtual { // @dev Ensure ONLY can be called 'internally'. if (msg.sender != address(this)) revert OnlySelf(); _lzReceiveSimulate(_origin, _guid, _message, _executor, _extraData); } /** * @dev Internal function to handle the OAppPreCrimeSimulator simulated receive. * @param _origin The origin information. * - srcEid: The source chain endpoint ID. * - sender: The sender address from the src chain. * - nonce: The nonce of the LayerZero message. * @param _guid The GUID of the LayerZero message. * @param _message The LayerZero message. * @param _executor The address of the off-chain executor. * @param _extraData Arbitrary data passed by the msg executor. * * @dev Enables the preCrime simulator to mock sending lzReceive() messages, * routes the msg down from the OAppPreCrimeSimulator, and back up to the OAppReceiver. */ function _lzReceiveSimulate( Origin calldata _origin, bytes32 _guid, bytes calldata _message, address _executor, bytes calldata _extraData ) internal virtual; /** * @dev checks if the specified peer is considered 'trusted' by the OApp. * @param _eid The endpoint Id to check. * @param _peer The peer to check. * @return Whether the peer passed is considered 'trusted' by the OApp. */ function isPeer(uint32 _eid, bytes32 _peer) public view virtual returns (bool); }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; /** * @title ILayerZeroComposer */ interface ILayerZeroComposer { /** * @notice Composes a LayerZero message from an OApp. * @param _from The address initiating the composition, typically the OApp where the lzReceive was called. * @param _guid The unique identifier for the corresponding LayerZero src/dst tx. * @param _message The composed message payload in bytes. NOT necessarily the same payload passed via lzReceive. * @param _executor The address of the executor for the composed message. * @param _extraData Additional arbitrary data in bytes passed by the entity who executes the lzCompose. */ function lzCompose( address _from, bytes32 _guid, bytes calldata _message, address _executor, bytes calldata _extraData ) external payable; }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import { IMessageLibManager } from "./IMessageLibManager.sol"; import { IMessagingComposer } from "./IMessagingComposer.sol"; import { IMessagingChannel } from "./IMessagingChannel.sol"; import { IMessagingContext } from "./IMessagingContext.sol"; struct MessagingParams { uint32 dstEid; bytes32 receiver; bytes message; bytes options; bool payInLzToken; } struct MessagingReceipt { bytes32 guid; uint64 nonce; MessagingFee fee; } struct MessagingFee { uint256 nativeFee; uint256 lzTokenFee; } struct Origin { uint32 srcEid; bytes32 sender; uint64 nonce; } interface ILayerZeroEndpointV2 is IMessageLibManager, IMessagingComposer, IMessagingChannel, IMessagingContext { event PacketSent(bytes encodedPayload, bytes options, address sendLibrary); event PacketVerified(Origin origin, address receiver, bytes32 payloadHash); event PacketDelivered(Origin origin, address receiver); event LzReceiveAlert( address indexed receiver, address indexed executor, Origin origin, bytes32 guid, uint256 gas, uint256 value, bytes message, bytes extraData, bytes reason ); event LzTokenSet(address token); event DelegateSet(address sender, address delegate); function quote(MessagingParams calldata _params, address _sender) external view returns (MessagingFee memory); function send( MessagingParams calldata _params, address _refundAddress ) external payable returns (MessagingReceipt memory); function verify(Origin calldata _origin, address _receiver, bytes32 _payloadHash) external; function verifiable(Origin calldata _origin, address _receiver) external view returns (bool); function initializable(Origin calldata _origin, address _receiver) external view returns (bool); function lzReceive( Origin calldata _origin, address _receiver, bytes32 _guid, bytes calldata _message, bytes calldata _extraData ) external payable; // oapp can burn messages partially by calling this function with its own business logic if messages are verified in order function clear(address _oapp, Origin calldata _origin, bytes32 _guid, bytes calldata _message) external; function setLzToken(address _lzToken) external; function lzToken() external view returns (address); function nativeToken() external view returns (address); function setDelegate(address _delegate) external; }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import { Origin } from "./ILayerZeroEndpointV2.sol"; interface ILayerZeroReceiver { function allowInitializePath(Origin calldata _origin) external view returns (bool); function nextNonce(uint32 _eid, bytes32 _sender) external view returns (uint64); function lzReceive( Origin calldata _origin, bytes32 _guid, bytes calldata _message, address _executor, bytes calldata _extraData ) external payable; }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import { IERC165 } from "@openzeppelin/contracts/utils/introspection/IERC165.sol"; import { SetConfigParam } from "./IMessageLibManager.sol"; enum MessageLibType { Send, Receive, SendAndReceive } interface IMessageLib is IERC165 { function setConfig(address _oapp, SetConfigParam[] calldata _config) external; function getConfig(uint32 _eid, address _oapp, uint32 _configType) external view returns (bytes memory config); function isSupportedEid(uint32 _eid) external view returns (bool); // message libs of same major version are compatible function version() external view returns (uint64 major, uint8 minor, uint8 endpointVersion); function messageLibType() external view returns (MessageLibType); }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; struct SetConfigParam { uint32 eid; uint32 configType; bytes config; } interface IMessageLibManager { struct Timeout { address lib; uint256 expiry; } event LibraryRegistered(address newLib); event DefaultSendLibrarySet(uint32 eid, address newLib); event DefaultReceiveLibrarySet(uint32 eid, address newLib); event DefaultReceiveLibraryTimeoutSet(uint32 eid, address oldLib, uint256 expiry); event SendLibrarySet(address sender, uint32 eid, address newLib); event ReceiveLibrarySet(address receiver, uint32 eid, address newLib); event ReceiveLibraryTimeoutSet(address receiver, uint32 eid, address oldLib, uint256 timeout); function registerLibrary(address _lib) external; function isRegisteredLibrary(address _lib) external view returns (bool); function getRegisteredLibraries() external view returns (address[] memory); function setDefaultSendLibrary(uint32 _eid, address _newLib) external; function defaultSendLibrary(uint32 _eid) external view returns (address); function setDefaultReceiveLibrary(uint32 _eid, address _newLib, uint256 _gracePeriod) external; function defaultReceiveLibrary(uint32 _eid) external view returns (address); function setDefaultReceiveLibraryTimeout(uint32 _eid, address _lib, uint256 _expiry) external; function defaultReceiveLibraryTimeout(uint32 _eid) external view returns (address lib, uint256 expiry); function isSupportedEid(uint32 _eid) external view returns (bool); function isValidReceiveLibrary(address _receiver, uint32 _eid, address _lib) external view returns (bool); /// ------------------- OApp interfaces ------------------- function setSendLibrary(address _oapp, uint32 _eid, address _newLib) external; function getSendLibrary(address _sender, uint32 _eid) external view returns (address lib); function isDefaultSendLibrary(address _sender, uint32 _eid) external view returns (bool); function setReceiveLibrary(address _oapp, uint32 _eid, address _newLib, uint256 _gracePeriod) external; function getReceiveLibrary(address _receiver, uint32 _eid) external view returns (address lib, bool isDefault); function setReceiveLibraryTimeout(address _oapp, uint32 _eid, address _lib, uint256 _expiry) external; function receiveLibraryTimeout(address _receiver, uint32 _eid) external view returns (address lib, uint256 expiry); function setConfig(address _oapp, address _lib, SetConfigParam[] calldata _params) external; function getConfig( address _oapp, address _lib, uint32 _eid, uint32 _configType ) external view returns (bytes memory config); }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; interface IMessagingChannel { event InboundNonceSkipped(uint32 srcEid, bytes32 sender, address receiver, uint64 nonce); event PacketNilified(uint32 srcEid, bytes32 sender, address receiver, uint64 nonce, bytes32 payloadHash); event PacketBurnt(uint32 srcEid, bytes32 sender, address receiver, uint64 nonce, bytes32 payloadHash); function eid() external view returns (uint32); // this is an emergency function if a message cannot be verified for some reasons // required to provide _nextNonce to avoid race condition function skip(address _oapp, uint32 _srcEid, bytes32 _sender, uint64 _nonce) external; function nilify(address _oapp, uint32 _srcEid, bytes32 _sender, uint64 _nonce, bytes32 _payloadHash) external; function burn(address _oapp, uint32 _srcEid, bytes32 _sender, uint64 _nonce, bytes32 _payloadHash) external; function nextGuid(address _sender, uint32 _dstEid, bytes32 _receiver) external view returns (bytes32); function inboundNonce(address _receiver, uint32 _srcEid, bytes32 _sender) external view returns (uint64); function outboundNonce(address _sender, uint32 _dstEid, bytes32 _receiver) external view returns (uint64); function inboundPayloadHash( address _receiver, uint32 _srcEid, bytes32 _sender, uint64 _nonce ) external view returns (bytes32); function lazyInboundNonce(address _receiver, uint32 _srcEid, bytes32 _sender) external view returns (uint64); }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; interface IMessagingComposer { event ComposeSent(address from, address to, bytes32 guid, uint16 index, bytes message); event ComposeDelivered(address from, address to, bytes32 guid, uint16 index); event LzComposeAlert( address indexed from, address indexed to, address indexed executor, bytes32 guid, uint16 index, uint256 gas, uint256 value, bytes message, bytes extraData, bytes reason ); function composeQueue( address _from, address _to, bytes32 _guid, uint16 _index ) external view returns (bytes32 messageHash); function sendCompose(address _to, bytes32 _guid, uint16 _index, bytes calldata _message) external; function lzCompose( address _from, address _to, bytes32 _guid, uint16 _index, bytes calldata _message, bytes calldata _extraData ) external payable; }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; interface IMessagingContext { function isSendingMessage() external view returns (bool); function getSendContext() external view returns (uint32 dstEid, address sender); }
// SPDX-License-Identifier: MIT pragma solidity >=0.8.0; import { MessagingFee } from "./ILayerZeroEndpointV2.sol"; import { IMessageLib } from "./IMessageLib.sol"; struct Packet { uint64 nonce; uint32 srcEid; address sender; uint32 dstEid; bytes32 receiver; bytes32 guid; bytes message; } interface ISendLib is IMessageLib { function send( Packet calldata _packet, bytes calldata _options, bool _payInLzToken ) external returns (MessagingFee memory, bytes memory encodedPacket); function quote( Packet calldata _packet, bytes calldata _options, bool _payInLzToken ) external view returns (MessagingFee memory); function setTreasury(address _treasury) external; function withdrawFee(address _to, uint256 _amount) external; function withdrawLzTokenFee(address _lzToken, address _to, uint256 _amount) external; }
// SPDX-License-Identifier: LZBL-1.2 pragma solidity ^0.8.20; library AddressCast { error AddressCast_InvalidSizeForAddress(); error AddressCast_InvalidAddress(); function toBytes32(bytes calldata _addressBytes) internal pure returns (bytes32 result) { if (_addressBytes.length > 32) revert AddressCast_InvalidAddress(); result = bytes32(_addressBytes); unchecked { uint256 offset = 32 - _addressBytes.length; result = result >> (offset * 8); } } function toBytes32(address _address) internal pure returns (bytes32 result) { result = bytes32(uint256(uint160(_address))); } function toBytes(bytes32 _addressBytes32, uint256 _size) internal pure returns (bytes memory result) { if (_size == 0 || _size > 32) revert AddressCast_InvalidSizeForAddress(); result = new bytes(_size); unchecked { uint256 offset = 256 - _size * 8; assembly { mstore(add(result, 32), shl(offset, _addressBytes32)) } } } function toAddress(bytes32 _addressBytes32) internal pure returns (address result) { result = address(uint160(uint256(_addressBytes32))); } function toAddress(bytes calldata _addressBytes) internal pure returns (address result) { if (_addressBytes.length != 20) revert AddressCast_InvalidAddress(); result = address(bytes20(_addressBytes)); } }
// SPDX-License-Identifier: LZBL-1.2 pragma solidity ^0.8.20; library CalldataBytesLib { function toU8(bytes calldata _bytes, uint256 _start) internal pure returns (uint8) { return uint8(_bytes[_start]); } function toU16(bytes calldata _bytes, uint256 _start) internal pure returns (uint16) { unchecked { uint256 end = _start + 2; return uint16(bytes2(_bytes[_start:end])); } } function toU32(bytes calldata _bytes, uint256 _start) internal pure returns (uint32) { unchecked { uint256 end = _start + 4; return uint32(bytes4(_bytes[_start:end])); } } function toU64(bytes calldata _bytes, uint256 _start) internal pure returns (uint64) { unchecked { uint256 end = _start + 8; return uint64(bytes8(_bytes[_start:end])); } } function toU128(bytes calldata _bytes, uint256 _start) internal pure returns (uint128) { unchecked { uint256 end = _start + 16; return uint128(bytes16(_bytes[_start:end])); } } function toU256(bytes calldata _bytes, uint256 _start) internal pure returns (uint256) { unchecked { uint256 end = _start + 32; return uint256(bytes32(_bytes[_start:end])); } } function toAddr(bytes calldata _bytes, uint256 _start) internal pure returns (address) { unchecked { uint256 end = _start + 20; return address(bytes20(_bytes[_start:end])); } } function toB32(bytes calldata _bytes, uint256 _start) internal pure returns (bytes32) { unchecked { uint256 end = _start + 32; return bytes32(_bytes[_start:end]); } } }
// SPDX-License-Identifier: MIT // modified from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/structs/BitMaps.sol pragma solidity ^0.8.20; type BitMap256 is uint256; using BitMaps for BitMap256 global; library BitMaps { /** * @dev Returns whether the bit at `index` is set. */ function get(BitMap256 bitmap, uint8 index) internal pure returns (bool) { uint256 mask = 1 << index; return BitMap256.unwrap(bitmap) & mask != 0; } /** * @dev Sets the bit at `index`. */ function set(BitMap256 bitmap, uint8 index) internal pure returns (BitMap256) { uint256 mask = 1 << index; return BitMap256.wrap(BitMap256.unwrap(bitmap) | mask); } }
// SPDX-License-Identifier: LZBL-1.2 pragma solidity ^0.8.20; import { CalldataBytesLib } from "../../libs/CalldataBytesLib.sol"; library ExecutorOptions { using CalldataBytesLib for bytes; uint8 internal constant WORKER_ID = 1; uint8 internal constant OPTION_TYPE_LZRECEIVE = 1; uint8 internal constant OPTION_TYPE_NATIVE_DROP = 2; uint8 internal constant OPTION_TYPE_LZCOMPOSE = 3; uint8 internal constant OPTION_TYPE_ORDERED_EXECUTION = 4; error Executor_InvalidLzReceiveOption(); error Executor_InvalidNativeDropOption(); error Executor_InvalidLzComposeOption(); /// @dev decode the next executor option from the options starting from the specified cursor /// @param _options [executor_id][executor_option][executor_id][executor_option]... /// executor_option = [option_size][option_type][option] /// option_size = len(option_type) + len(option) /// executor_id: uint8, option_size: uint16, option_type: uint8, option: bytes /// @param _cursor the cursor to start decoding from /// @return optionType the type of the option /// @return option the option of the executor /// @return cursor the cursor to start decoding the next executor option function nextExecutorOption( bytes calldata _options, uint256 _cursor ) internal pure returns (uint8 optionType, bytes calldata option, uint256 cursor) { unchecked { // skip worker id cursor = _cursor + 1; // read option size uint16 size = _options.toU16(cursor); cursor += 2; // read option type optionType = _options.toU8(cursor); // startCursor and endCursor are used to slice the option from _options uint256 startCursor = cursor + 1; // skip option type uint256 endCursor = cursor + size; option = _options[startCursor:endCursor]; cursor += size; } } function decodeLzReceiveOption(bytes calldata _option) internal pure returns (uint128 gas, uint128 value) { if (_option.length != 16 && _option.length != 32) revert Executor_InvalidLzReceiveOption(); gas = _option.toU128(0); value = _option.length == 32 ? _option.toU128(16) : 0; } function decodeNativeDropOption(bytes calldata _option) internal pure returns (uint128 amount, bytes32 receiver) { if (_option.length != 48) revert Executor_InvalidNativeDropOption(); amount = _option.toU128(0); receiver = _option.toB32(16); } function decodeLzComposeOption( bytes calldata _option ) internal pure returns (uint16 index, uint128 gas, uint128 value) { if (_option.length != 18 && _option.length != 34) revert Executor_InvalidLzComposeOption(); index = _option.toU16(0); gas = _option.toU128(2); value = _option.length == 34 ? _option.toU128(18) : 0; } function encodeLzReceiveOption(uint128 _gas, uint128 _value) internal pure returns (bytes memory) { return _value == 0 ? abi.encodePacked(_gas) : abi.encodePacked(_gas, _value); } function encodeNativeDropOption(uint128 _amount, bytes32 _receiver) internal pure returns (bytes memory) { return abi.encodePacked(_amount, _receiver); } function encodeLzComposeOption(uint16 _index, uint128 _gas, uint128 _value) internal pure returns (bytes memory) { return _value == 0 ? abi.encodePacked(_index, _gas) : abi.encodePacked(_index, _gas, _value); } }
// SPDX-License-Identifier: LZBL-1.2 pragma solidity ^0.8.20; import { Packet } from "../../interfaces/ISendLib.sol"; import { AddressCast } from "../../libs/AddressCast.sol"; library PacketV1Codec { using AddressCast for address; using AddressCast for bytes32; uint8 internal constant PACKET_VERSION = 1; // header (version + nonce + path) // version uint256 private constant PACKET_VERSION_OFFSET = 0; // nonce uint256 private constant NONCE_OFFSET = 1; // path uint256 private constant SRC_EID_OFFSET = 9; uint256 private constant SENDER_OFFSET = 13; uint256 private constant DST_EID_OFFSET = 45; uint256 private constant RECEIVER_OFFSET = 49; // payload (guid + message) uint256 private constant GUID_OFFSET = 81; // keccak256(nonce + path) uint256 private constant MESSAGE_OFFSET = 113; function encode(Packet memory _packet) internal pure returns (bytes memory encodedPacket) { encodedPacket = abi.encodePacked( PACKET_VERSION, _packet.nonce, _packet.srcEid, _packet.sender.toBytes32(), _packet.dstEid, _packet.receiver, _packet.guid, _packet.message ); } function encodePacketHeader(Packet memory _packet) internal pure returns (bytes memory) { return abi.encodePacked( PACKET_VERSION, _packet.nonce, _packet.srcEid, _packet.sender.toBytes32(), _packet.dstEid, _packet.receiver ); } function encodePayload(Packet memory _packet) internal pure returns (bytes memory) { return abi.encodePacked(_packet.guid, _packet.message); } function header(bytes calldata _packet) internal pure returns (bytes calldata) { return _packet[0:GUID_OFFSET]; } function version(bytes calldata _packet) internal pure returns (uint8) { return uint8(bytes1(_packet[PACKET_VERSION_OFFSET:NONCE_OFFSET])); } function nonce(bytes calldata _packet) internal pure returns (uint64) { return uint64(bytes8(_packet[NONCE_OFFSET:SRC_EID_OFFSET])); } function srcEid(bytes calldata _packet) internal pure returns (uint32) { return uint32(bytes4(_packet[SRC_EID_OFFSET:SENDER_OFFSET])); } function sender(bytes calldata _packet) internal pure returns (bytes32) { return bytes32(_packet[SENDER_OFFSET:DST_EID_OFFSET]); } function senderAddressB20(bytes calldata _packet) internal pure returns (address) { return sender(_packet).toAddress(); } function dstEid(bytes calldata _packet) internal pure returns (uint32) { return uint32(bytes4(_packet[DST_EID_OFFSET:RECEIVER_OFFSET])); } function receiver(bytes calldata _packet) internal pure returns (bytes32) { return bytes32(_packet[RECEIVER_OFFSET:GUID_OFFSET]); } function receiverB20(bytes calldata _packet) internal pure returns (address) { return receiver(_packet).toAddress(); } function guid(bytes calldata _packet) internal pure returns (bytes32) { return bytes32(_packet[GUID_OFFSET:MESSAGE_OFFSET]); } function message(bytes calldata _packet) internal pure returns (bytes calldata) { return bytes(_packet[MESSAGE_OFFSET:]); } function payload(bytes calldata _packet) internal pure returns (bytes calldata) { return bytes(_packet[GUID_OFFSET:]); } function payloadHash(bytes calldata _packet) internal pure returns (bytes32) { return keccak256(payload(_packet)); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol) pragma solidity ^0.8.20; import {Context} from "../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. * * The initial owner is set to the address provided by the deployer. 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; /** * @dev The caller account is not authorized to perform an operation. */ error OwnableUnauthorizedAccount(address account); /** * @dev The owner is not a valid owner account. (eg. `address(0)`) */ error OwnableInvalidOwner(address owner); event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); /** * @dev Initializes the contract setting the address provided by the deployer as the initial owner. */ constructor(address initialOwner) { if (initialOwner == address(0)) { revert OwnableInvalidOwner(address(0)); } _transferOwnership(initialOwner); } /** * @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 { if (owner() != _msgSender()) { revert OwnableUnauthorizedAccount(_msgSender()); } } /** * @dev Leaves the contract without owner. It will not be possible to call * `onlyOwner` functions. Can only be called by the current owner. * * NOTE: Renouncing ownership will leave the contract without an owner, * thereby disabling 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 { if (newOwner == address(0)) { revert OwnableInvalidOwner(address(0)); } _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 v5.0.0) (interfaces/draft-IERC6093.sol) pragma solidity ^0.8.20; /** * @dev Standard ERC20 Errors * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC20 tokens. */ interface IERC20Errors { /** * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers. * @param sender Address whose tokens are being transferred. * @param balance Current balance for the interacting account. * @param needed Minimum amount required to perform a transfer. */ error ERC20InsufficientBalance(address sender, uint256 balance, uint256 needed); /** * @dev Indicates a failure with the token `sender`. Used in transfers. * @param sender Address whose tokens are being transferred. */ error ERC20InvalidSender(address sender); /** * @dev Indicates a failure with the token `receiver`. Used in transfers. * @param receiver Address to which tokens are being transferred. */ error ERC20InvalidReceiver(address receiver); /** * @dev Indicates a failure with the `spender`’s `allowance`. Used in transfers. * @param spender Address that may be allowed to operate on tokens without being their owner. * @param allowance Amount of tokens a `spender` is allowed to operate with. * @param needed Minimum amount required to perform a transfer. */ error ERC20InsufficientAllowance(address spender, uint256 allowance, uint256 needed); /** * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals. * @param approver Address initiating an approval operation. */ error ERC20InvalidApprover(address approver); /** * @dev Indicates a failure with the `spender` to be approved. Used in approvals. * @param spender Address that may be allowed to operate on tokens without being their owner. */ error ERC20InvalidSpender(address spender); } /** * @dev Standard ERC721 Errors * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC721 tokens. */ interface IERC721Errors { /** * @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in EIP-20. * Used in balance queries. * @param owner Address of the current owner of a token. */ error ERC721InvalidOwner(address owner); /** * @dev Indicates a `tokenId` whose `owner` is the zero address. * @param tokenId Identifier number of a token. */ error ERC721NonexistentToken(uint256 tokenId); /** * @dev Indicates an error related to the ownership over a particular token. Used in transfers. * @param sender Address whose tokens are being transferred. * @param tokenId Identifier number of a token. * @param owner Address of the current owner of a token. */ error ERC721IncorrectOwner(address sender, uint256 tokenId, address owner); /** * @dev Indicates a failure with the token `sender`. Used in transfers. * @param sender Address whose tokens are being transferred. */ error ERC721InvalidSender(address sender); /** * @dev Indicates a failure with the token `receiver`. Used in transfers. * @param receiver Address to which tokens are being transferred. */ error ERC721InvalidReceiver(address receiver); /** * @dev Indicates a failure with the `operator`’s approval. Used in transfers. * @param operator Address that may be allowed to operate on tokens without being their owner. * @param tokenId Identifier number of a token. */ error ERC721InsufficientApproval(address operator, uint256 tokenId); /** * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals. * @param approver Address initiating an approval operation. */ error ERC721InvalidApprover(address approver); /** * @dev Indicates a failure with the `operator` to be approved. Used in approvals. * @param operator Address that may be allowed to operate on tokens without being their owner. */ error ERC721InvalidOperator(address operator); } /** * @dev Standard ERC1155 Errors * Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC1155 tokens. */ interface IERC1155Errors { /** * @dev Indicates an error related to the current `balance` of a `sender`. Used in transfers. * @param sender Address whose tokens are being transferred. * @param balance Current balance for the interacting account. * @param needed Minimum amount required to perform a transfer. * @param tokenId Identifier number of a token. */ error ERC1155InsufficientBalance(address sender, uint256 balance, uint256 needed, uint256 tokenId); /** * @dev Indicates a failure with the token `sender`. Used in transfers. * @param sender Address whose tokens are being transferred. */ error ERC1155InvalidSender(address sender); /** * @dev Indicates a failure with the token `receiver`. Used in transfers. * @param receiver Address to which tokens are being transferred. */ error ERC1155InvalidReceiver(address receiver); /** * @dev Indicates a failure with the `operator`’s approval. Used in transfers. * @param operator Address that may be allowed to operate on tokens without being their owner. * @param owner Address of the current owner of a token. */ error ERC1155MissingApprovalForAll(address operator, address owner); /** * @dev Indicates a failure with the `approver` of a token to be approved. Used in approvals. * @param approver Address initiating an approval operation. */ error ERC1155InvalidApprover(address approver); /** * @dev Indicates a failure with the `operator` to be approved. Used in approvals. * @param operator Address that may be allowed to operate on tokens without being their owner. */ error ERC1155InvalidOperator(address operator); /** * @dev Indicates an array length mismatch between ids and values in a safeBatchTransferFrom operation. * Used in batch transfers. * @param idsLength Length of the array of token identifiers * @param valuesLength Length of the array of token amounts */ error ERC1155InvalidArrayLength(uint256 idsLength, uint256 valuesLength); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/ERC20.sol) pragma solidity ^0.8.20; import {IERC20} from "./IERC20.sol"; import {IERC20Metadata} from "./extensions/IERC20Metadata.sol"; import {Context} from "../../utils/Context.sol"; import {IERC20Errors} from "../../interfaces/draft-IERC6093.sol"; /** * @dev Implementation of the {IERC20} interface. * * This implementation is agnostic to the way tokens are created. This means * that a supply mechanism has to be added in a derived contract using {_mint}. * * TIP: For a detailed writeup see our guide * https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How * to implement supply mechanisms]. * * The default value of {decimals} is 18. To change this, you should override * this function so it returns a different value. * * We have followed general OpenZeppelin Contracts guidelines: functions revert * instead returning `false` on failure. This behavior is nonetheless * conventional and does not conflict with the expectations of ERC20 * applications. * * Additionally, an {Approval} event is emitted on calls to {transferFrom}. * This allows applications to reconstruct the allowance for all accounts just * by listening to said events. Other implementations of the EIP may not emit * these events, as it isn't required by the specification. */ abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors { mapping(address account => uint256) private _balances; mapping(address account => mapping(address spender => uint256)) private _allowances; uint256 private _totalSupply; string private _name; string private _symbol; /** * @dev Sets the values for {name} and {symbol}. * * All two of these values are immutable: they can only be set once during * construction. */ constructor(string memory name_, string memory symbol_) { _name = name_; _symbol = symbol_; } /** * @dev Returns the name of the token. */ function name() public view virtual returns (string memory) { return _name; } /** * @dev Returns the symbol of the token, usually a shorter version of the * name. */ function symbol() public view virtual returns (string memory) { return _symbol; } /** * @dev Returns the number of decimals used to get its user representation. * For example, if `decimals` equals `2`, a balance of `505` tokens should * be displayed to a user as `5.05` (`505 / 10 ** 2`). * * Tokens usually opt for a value of 18, imitating the relationship between * Ether and Wei. This is the default value returned by this function, unless * it's overridden. * * NOTE: This information is only used for _display_ purposes: it in * no way affects any of the arithmetic of the contract, including * {IERC20-balanceOf} and {IERC20-transfer}. */ function decimals() public view virtual returns (uint8) { return 18; } /** * @dev See {IERC20-totalSupply}. */ function totalSupply() public view virtual returns (uint256) { return _totalSupply; } /** * @dev See {IERC20-balanceOf}. */ function balanceOf(address account) public view virtual returns (uint256) { return _balances[account]; } /** * @dev See {IERC20-transfer}. * * Requirements: * * - `to` cannot be the zero address. * - the caller must have a balance of at least `value`. */ function transfer(address to, uint256 value) public virtual returns (bool) { address owner = _msgSender(); _transfer(owner, to, value); return true; } /** * @dev See {IERC20-allowance}. */ function allowance(address owner, address spender) public view virtual returns (uint256) { return _allowances[owner][spender]; } /** * @dev See {IERC20-approve}. * * NOTE: If `value` is the maximum `uint256`, the allowance is not updated on * `transferFrom`. This is semantically equivalent to an infinite approval. * * Requirements: * * - `spender` cannot be the zero address. */ function approve(address spender, uint256 value) public virtual returns (bool) { address owner = _msgSender(); _approve(owner, spender, value); return true; } /** * @dev See {IERC20-transferFrom}. * * Emits an {Approval} event indicating the updated allowance. This is not * required by the EIP. See the note at the beginning of {ERC20}. * * NOTE: Does not update the allowance if the current allowance * is the maximum `uint256`. * * Requirements: * * - `from` and `to` cannot be the zero address. * - `from` must have a balance of at least `value`. * - the caller must have allowance for ``from``'s tokens of at least * `value`. */ function transferFrom(address from, address to, uint256 value) public virtual returns (bool) { address spender = _msgSender(); _spendAllowance(from, spender, value); _transfer(from, to, value); return true; } /** * @dev Moves a `value` amount of tokens from `from` to `to`. * * This internal function is equivalent to {transfer}, and can be used to * e.g. implement automatic token fees, slashing mechanisms, etc. * * Emits a {Transfer} event. * * NOTE: This function is not virtual, {_update} should be overridden instead. */ function _transfer(address from, address to, uint256 value) internal { if (from == address(0)) { revert ERC20InvalidSender(address(0)); } if (to == address(0)) { revert ERC20InvalidReceiver(address(0)); } _update(from, to, value); } /** * @dev Transfers a `value` amount of tokens from `from` to `to`, or alternatively mints (or burns) if `from` * (or `to`) is the zero address. All customizations to transfers, mints, and burns should be done by overriding * this function. * * Emits a {Transfer} event. */ function _update(address from, address to, uint256 value) internal virtual { if (from == address(0)) { // Overflow check required: The rest of the code assumes that totalSupply never overflows _totalSupply += value; } else { uint256 fromBalance = _balances[from]; if (fromBalance < value) { revert ERC20InsufficientBalance(from, fromBalance, value); } unchecked { // Overflow not possible: value <= fromBalance <= totalSupply. _balances[from] = fromBalance - value; } } if (to == address(0)) { unchecked { // Overflow not possible: value <= totalSupply or value <= fromBalance <= totalSupply. _totalSupply -= value; } } else { unchecked { // Overflow not possible: balance + value is at most totalSupply, which we know fits into a uint256. _balances[to] += value; } } emit Transfer(from, to, value); } /** * @dev Creates a `value` amount of tokens and assigns them to `account`, by transferring it from address(0). * Relies on the `_update` mechanism * * Emits a {Transfer} event with `from` set to the zero address. * * NOTE: This function is not virtual, {_update} should be overridden instead. */ function _mint(address account, uint256 value) internal { if (account == address(0)) { revert ERC20InvalidReceiver(address(0)); } _update(address(0), account, value); } /** * @dev Destroys a `value` amount of tokens from `account`, lowering the total supply. * Relies on the `_update` mechanism. * * Emits a {Transfer} event with `to` set to the zero address. * * NOTE: This function is not virtual, {_update} should be overridden instead */ function _burn(address account, uint256 value) internal { if (account == address(0)) { revert ERC20InvalidSender(address(0)); } _update(account, address(0), value); } /** * @dev Sets `value` as the allowance of `spender` over the `owner` s tokens. * * This internal function is equivalent to `approve`, and can be used to * e.g. set automatic allowances for certain subsystems, etc. * * Emits an {Approval} event. * * Requirements: * * - `owner` cannot be the zero address. * - `spender` cannot be the zero address. * * Overrides to this logic should be done to the variant with an additional `bool emitEvent` argument. */ function _approve(address owner, address spender, uint256 value) internal { _approve(owner, spender, value, true); } /** * @dev Variant of {_approve} with an optional flag to enable or disable the {Approval} event. * * By default (when calling {_approve}) the flag is set to true. On the other hand, approval changes made by * `_spendAllowance` during the `transferFrom` operation set the flag to false. This saves gas by not emitting any * `Approval` event during `transferFrom` operations. * * Anyone who wishes to continue emitting `Approval` events on the`transferFrom` operation can force the flag to * true using the following override: * ``` * function _approve(address owner, address spender, uint256 value, bool) internal virtual override { * super._approve(owner, spender, value, true); * } * ``` * * Requirements are the same as {_approve}. */ function _approve(address owner, address spender, uint256 value, bool emitEvent) internal virtual { if (owner == address(0)) { revert ERC20InvalidApprover(address(0)); } if (spender == address(0)) { revert ERC20InvalidSpender(address(0)); } _allowances[owner][spender] = value; if (emitEvent) { emit Approval(owner, spender, value); } } /** * @dev Updates `owner` s allowance for `spender` based on spent `value`. * * Does not update the allowance value in case of infinite allowance. * Revert if not enough allowance is available. * * Does not emit an {Approval} event. */ function _spendAllowance(address owner, address spender, uint256 value) internal virtual { uint256 currentAllowance = allowance(owner, spender); if (currentAllowance != type(uint256).max) { if (currentAllowance < value) { revert ERC20InsufficientAllowance(spender, currentAllowance, value); } unchecked { _approve(owner, spender, currentAllowance - value, false); } } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Metadata.sol) pragma solidity ^0.8.20; import {IERC20} from "../IERC20.sol"; /** * @dev Interface for the optional metadata functions from the ERC20 standard. */ interface IERC20Metadata is IERC20 { /** * @dev Returns the name of the token. */ function name() external view returns (string memory); /** * @dev Returns the symbol of the token. */ function symbol() external view returns (string memory); /** * @dev Returns the decimals places of the token. */ function decimals() external view returns (uint8); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Permit.sol) pragma solidity ^0.8.20; /** * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't * need to send a transaction, and thus is not required to hold Ether at all. * * ==== Security Considerations * * There are two important considerations concerning the use of `permit`. The first is that a valid permit signature * expresses an allowance, and it should not be assumed to convey additional meaning. In particular, it should not be * considered as an intention to spend the allowance in any specific way. The second is that because permits have * built-in replay protection and can be submitted by anyone, they can be frontrun. A protocol that uses permits should * take this into consideration and allow a `permit` call to fail. Combining these two aspects, a pattern that may be * generally recommended is: * * ```solidity * function doThingWithPermit(..., uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s) public { * try token.permit(msg.sender, address(this), value, deadline, v, r, s) {} catch {} * doThing(..., value); * } * * function doThing(..., uint256 value) public { * token.safeTransferFrom(msg.sender, address(this), value); * ... * } * ``` * * Observe that: 1) `msg.sender` is used as the owner, leaving no ambiguity as to the signer intent, and 2) the use of * `try/catch` allows the permit to fail and makes the code tolerant to frontrunning. (See also * {SafeERC20-safeTransferFrom}). * * Additionally, note that smart contract wallets (such as Argent or Safe) are not able to produce permit signatures, so * contracts should have entry points that don't rely on permit. */ interface IERC20Permit { /** * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens, * given ``owner``'s signed approval. * * IMPORTANT: The same issues {IERC20-approve} has related to transaction * ordering also apply here. * * Emits an {Approval} event. * * Requirements: * * - `spender` cannot be the zero address. * - `deadline` must be a timestamp in the future. * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner` * over the EIP712-formatted function arguments. * - the signature must use ``owner``'s current nonce (see {nonces}). * * For more information on the signature format, see the * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP * section]. * * CAUTION: See Security Considerations above. */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external; /** * @dev Returns the current nonce for `owner`. This value must be * included whenever a signature is generated for {permit}. * * Every successful call to {permit} increases ``owner``'s nonce by one. This * prevents a signature from being used multiple times. */ function nonces(address owner) external view returns (uint256); /** * @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}. */ // solhint-disable-next-line func-name-mixedcase function DOMAIN_SEPARATOR() external view returns (bytes32); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol) pragma solidity ^0.8.20; /** * @dev Interface of the ERC20 standard as defined in the EIP. */ interface IERC20 { /** * @dev Emitted when `value` tokens are moved from one account (`from`) to * another (`to`). * * Note that `value` may be zero. */ event Transfer(address indexed from, address indexed to, uint256 value); /** * @dev Emitted when the allowance of a `spender` for an `owner` is set by * a call to {approve}. `value` is the new allowance. */ event Approval(address indexed owner, address indexed spender, uint256 value); /** * @dev Returns the value of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the value of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves a `value` amount of tokens from the caller's account to `to`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address to, uint256 value) external returns (bool); /** * @dev Returns the remaining number of tokens that `spender` will be * allowed to spend on behalf of `owner` through {transferFrom}. This is * zero by default. * * This value changes when {approve} or {transferFrom} are called. */ function allowance(address owner, address spender) external view returns (uint256); /** * @dev Sets a `value` amount of tokens as the allowance of `spender` over the * caller's tokens. * * Returns a boolean value indicating whether the operation succeeded. * * IMPORTANT: Beware that changing an allowance with this method brings the risk * that someone may use both the old and the new allowance by unfortunate * transaction ordering. One possible solution to mitigate this race * condition is to first reduce the spender's allowance to 0 and set the * desired value afterwards: * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 * * Emits an {Approval} event. */ function approve(address spender, uint256 value) external returns (bool); /** * @dev Moves a `value` amount of tokens from `from` to `to` using the * allowance mechanism. `value` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom(address from, address to, uint256 value) external returns (bool); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol) pragma solidity ^0.8.20; import {IERC20} from "../IERC20.sol"; import {IERC20Permit} from "../extensions/IERC20Permit.sol"; import {Address} from "../../../utils/Address.sol"; /** * @title SafeERC20 * @dev Wrappers around ERC20 operations that throw on failure (when the token * contract returns false). Tokens that return no value (and instead revert or * throw on failure) are also supported, non-reverting calls are assumed to be * successful. * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract, * which allows you to call the safe operations as `token.safeTransfer(...)`, etc. */ library SafeERC20 { using Address for address; /** * @dev An operation with an ERC20 token failed. */ error SafeERC20FailedOperation(address token); /** * @dev Indicates a failed `decreaseAllowance` request. */ error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease); /** * @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value, * non-reverting calls are assumed to be successful. */ function safeTransfer(IERC20 token, address to, uint256 value) internal { _callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value))); } /** * @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the * calling contract. If `token` returns no value, non-reverting calls are assumed to be successful. */ function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal { _callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value))); } /** * @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value, * non-reverting calls are assumed to be successful. */ function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal { uint256 oldAllowance = token.allowance(address(this), spender); forceApprove(token, spender, oldAllowance + value); } /** * @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no * value, non-reverting calls are assumed to be successful. */ function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal { unchecked { uint256 currentAllowance = token.allowance(address(this), spender); if (currentAllowance < requestedDecrease) { revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease); } forceApprove(token, spender, currentAllowance - requestedDecrease); } } /** * @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value, * non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval * to be set to zero before setting it to a non-zero value, such as USDT. */ function forceApprove(IERC20 token, address spender, uint256 value) internal { bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value)); if (!_callOptionalReturnBool(token, approvalCall)) { _callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0))); _callOptionalReturn(token, approvalCall); } } /** * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement * on the return value: the return value is optional (but if data is returned, it must not be false). * @param token The token targeted by the call. * @param data The call data (encoded using abi.encode or one of its variants). */ function _callOptionalReturn(IERC20 token, bytes memory data) private { // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since // we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that // the target address contains contract code and also asserts for success in the low-level call. bytes memory returndata = address(token).functionCall(data); if (returndata.length != 0 && !abi.decode(returndata, (bool))) { revert SafeERC20FailedOperation(address(token)); } } /** * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement * on the return value: the return value is optional (but if data is returned, it must not be false). * @param token The token targeted by the call. * @param data The call data (encoded using abi.encode or one of its variants). * * This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead. */ function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) { // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since // we're implementing it ourselves. We cannot use {Address-functionCall} here since this should return false // and not revert is the subcall reverts. (bool success, bytes memory returndata) = address(token).call(data); return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol) pragma solidity ^0.8.20; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev The ETH balance of the account is not enough to perform the operation. */ error AddressInsufficientBalance(address account); /** * @dev There's no code at `target` (it is not a contract). */ error AddressEmptyCode(address target); /** * @dev A call to an address target failed. The target may have reverted. */ error FailedInnerCall(); /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { if (address(this).balance < amount) { revert AddressInsufficientBalance(address(this)); } (bool success, ) = recipient.call{value: amount}(""); if (!success) { revert FailedInnerCall(); } } /** * @dev Performs a Solidity function call using a low level `call`. A * plain `call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason or custom error, it is bubbled * up by this function (like regular Solidity function calls). However, if * the call reverted with no returned reason, this function reverts with a * {FailedInnerCall} error. * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCallWithValue(target, data, 0); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. */ function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) { if (address(this).balance < value) { revert AddressInsufficientBalance(address(this)); } (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResultFromTarget(target, success, returndata); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResultFromTarget(target, success, returndata); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResultFromTarget(target, success, returndata); } /** * @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target * was not a contract or bubbling up the revert reason (falling back to {FailedInnerCall}) in case of an * unsuccessful call. */ function verifyCallResultFromTarget( address target, bool success, bytes memory returndata ) internal view returns (bytes memory) { if (!success) { _revert(returndata); } else { // only check if target is a contract if the call was successful and the return data is empty // otherwise we already know that it was a contract if (returndata.length == 0 && target.code.length == 0) { revert AddressEmptyCode(target); } return returndata; } } /** * @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the * revert reason or with a default {FailedInnerCall} error. */ function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) { if (!success) { _revert(returndata); } else { return returndata; } } /** * @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}. */ function _revert(bytes memory returndata) private pure { // Look for revert reason and bubble it up if present if (returndata.length > 0) { // The easiest way to bubble the revert reason is using memory via assembly /// @solidity memory-safe-assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert FailedInnerCall(); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol) pragma solidity ^0.8.20; /** * @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; } function _contextSuffixLength() internal view virtual returns (uint256) { return 0; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/IERC165.sol) pragma solidity ^0.8.20; /** * @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 IERC165 { /** * @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 v5.0.0) (utils/math/SafeCast.sol) // This file was procedurally generated from scripts/generate/templates/SafeCast.js. pragma solidity ^0.8.20; /** * @dev Wrappers over Solidity's uintXX/intXX casting operators with added overflow * checks. * * Downcasting from uint256/int256 in Solidity does not revert on overflow. This can * easily result in undesired exploitation or bugs, since developers usually * assume that overflows raise errors. `SafeCast` restores this intuition by * reverting the transaction when such 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 SafeCast { /** * @dev Value doesn't fit in an uint of `bits` size. */ error SafeCastOverflowedUintDowncast(uint8 bits, uint256 value); /** * @dev An int value doesn't fit in an uint of `bits` size. */ error SafeCastOverflowedIntToUint(int256 value); /** * @dev Value doesn't fit in an int of `bits` size. */ error SafeCastOverflowedIntDowncast(uint8 bits, int256 value); /** * @dev An uint value doesn't fit in an int of `bits` size. */ error SafeCastOverflowedUintToInt(uint256 value); /** * @dev Returns the downcasted uint248 from uint256, reverting on * overflow (when the input is greater than largest uint248). * * Counterpart to Solidity's `uint248` operator. * * Requirements: * * - input must fit into 248 bits */ function toUint248(uint256 value) internal pure returns (uint248) { if (value > type(uint248).max) { revert SafeCastOverflowedUintDowncast(248, value); } return uint248(value); } /** * @dev Returns the downcasted uint240 from uint256, reverting on * overflow (when the input is greater than largest uint240). * * Counterpart to Solidity's `uint240` operator. * * Requirements: * * - input must fit into 240 bits */ function toUint240(uint256 value) internal pure returns (uint240) { if (value > type(uint240).max) { revert SafeCastOverflowedUintDowncast(240, value); } return uint240(value); } /** * @dev Returns the downcasted uint232 from uint256, reverting on * overflow (when the input is greater than largest uint232). * * Counterpart to Solidity's `uint232` operator. * * Requirements: * * - input must fit into 232 bits */ function toUint232(uint256 value) internal pure returns (uint232) { if (value > type(uint232).max) { revert SafeCastOverflowedUintDowncast(232, value); } return uint232(value); } /** * @dev Returns the downcasted uint224 from uint256, reverting on * overflow (when the input is greater than largest uint224). * * Counterpart to Solidity's `uint224` operator. * * Requirements: * * - input must fit into 224 bits */ function toUint224(uint256 value) internal pure returns (uint224) { if (value > type(uint224).max) { revert SafeCastOverflowedUintDowncast(224, value); } return uint224(value); } /** * @dev Returns the downcasted uint216 from uint256, reverting on * overflow (when the input is greater than largest uint216). * * Counterpart to Solidity's `uint216` operator. * * Requirements: * * - input must fit into 216 bits */ function toUint216(uint256 value) internal pure returns (uint216) { if (value > type(uint216).max) { revert SafeCastOverflowedUintDowncast(216, value); } return uint216(value); } /** * @dev Returns the downcasted uint208 from uint256, reverting on * overflow (when the input is greater than largest uint208). * * Counterpart to Solidity's `uint208` operator. * * Requirements: * * - input must fit into 208 bits */ function toUint208(uint256 value) internal pure returns (uint208) { if (value > type(uint208).max) { revert SafeCastOverflowedUintDowncast(208, value); } return uint208(value); } /** * @dev Returns the downcasted uint200 from uint256, reverting on * overflow (when the input is greater than largest uint200). * * Counterpart to Solidity's `uint200` operator. * * Requirements: * * - input must fit into 200 bits */ function toUint200(uint256 value) internal pure returns (uint200) { if (value > type(uint200).max) { revert SafeCastOverflowedUintDowncast(200, value); } return uint200(value); } /** * @dev Returns the downcasted uint192 from uint256, reverting on * overflow (when the input is greater than largest uint192). * * Counterpart to Solidity's `uint192` operator. * * Requirements: * * - input must fit into 192 bits */ function toUint192(uint256 value) internal pure returns (uint192) { if (value > type(uint192).max) { revert SafeCastOverflowedUintDowncast(192, value); } return uint192(value); } /** * @dev Returns the downcasted uint184 from uint256, reverting on * overflow (when the input is greater than largest uint184). * * Counterpart to Solidity's `uint184` operator. * * Requirements: * * - input must fit into 184 bits */ function toUint184(uint256 value) internal pure returns (uint184) { if (value > type(uint184).max) { revert SafeCastOverflowedUintDowncast(184, value); } return uint184(value); } /** * @dev Returns the downcasted uint176 from uint256, reverting on * overflow (when the input is greater than largest uint176). * * Counterpart to Solidity's `uint176` operator. * * Requirements: * * - input must fit into 176 bits */ function toUint176(uint256 value) internal pure returns (uint176) { if (value > type(uint176).max) { revert SafeCastOverflowedUintDowncast(176, value); } return uint176(value); } /** * @dev Returns the downcasted uint168 from uint256, reverting on * overflow (when the input is greater than largest uint168). * * Counterpart to Solidity's `uint168` operator. * * Requirements: * * - input must fit into 168 bits */ function toUint168(uint256 value) internal pure returns (uint168) { if (value > type(uint168).max) { revert SafeCastOverflowedUintDowncast(168, value); } return uint168(value); } /** * @dev Returns the downcasted uint160 from uint256, reverting on * overflow (when the input is greater than largest uint160). * * Counterpart to Solidity's `uint160` operator. * * Requirements: * * - input must fit into 160 bits */ function toUint160(uint256 value) internal pure returns (uint160) { if (value > type(uint160).max) { revert SafeCastOverflowedUintDowncast(160, value); } return uint160(value); } /** * @dev Returns the downcasted uint152 from uint256, reverting on * overflow (when the input is greater than largest uint152). * * Counterpart to Solidity's `uint152` operator. * * Requirements: * * - input must fit into 152 bits */ function toUint152(uint256 value) internal pure returns (uint152) { if (value > type(uint152).max) { revert SafeCastOverflowedUintDowncast(152, value); } return uint152(value); } /** * @dev Returns the downcasted uint144 from uint256, reverting on * overflow (when the input is greater than largest uint144). * * Counterpart to Solidity's `uint144` operator. * * Requirements: * * - input must fit into 144 bits */ function toUint144(uint256 value) internal pure returns (uint144) { if (value > type(uint144).max) { revert SafeCastOverflowedUintDowncast(144, value); } return uint144(value); } /** * @dev Returns the downcasted uint136 from uint256, reverting on * overflow (when the input is greater than largest uint136). * * Counterpart to Solidity's `uint136` operator. * * Requirements: * * - input must fit into 136 bits */ function toUint136(uint256 value) internal pure returns (uint136) { if (value > type(uint136).max) { revert SafeCastOverflowedUintDowncast(136, value); } return uint136(value); } /** * @dev Returns the downcasted uint128 from uint256, reverting on * overflow (when the input is greater than largest uint128). * * Counterpart to Solidity's `uint128` operator. * * Requirements: * * - input must fit into 128 bits */ function toUint128(uint256 value) internal pure returns (uint128) { if (value > type(uint128).max) { revert SafeCastOverflowedUintDowncast(128, value); } return uint128(value); } /** * @dev Returns the downcasted uint120 from uint256, reverting on * overflow (when the input is greater than largest uint120). * * Counterpart to Solidity's `uint120` operator. * * Requirements: * * - input must fit into 120 bits */ function toUint120(uint256 value) internal pure returns (uint120) { if (value > type(uint120).max) { revert SafeCastOverflowedUintDowncast(120, value); } return uint120(value); } /** * @dev Returns the downcasted uint112 from uint256, reverting on * overflow (when the input is greater than largest uint112). * * Counterpart to Solidity's `uint112` operator. * * Requirements: * * - input must fit into 112 bits */ function toUint112(uint256 value) internal pure returns (uint112) { if (value > type(uint112).max) { revert SafeCastOverflowedUintDowncast(112, value); } return uint112(value); } /** * @dev Returns the downcasted uint104 from uint256, reverting on * overflow (when the input is greater than largest uint104). * * Counterpart to Solidity's `uint104` operator. * * Requirements: * * - input must fit into 104 bits */ function toUint104(uint256 value) internal pure returns (uint104) { if (value > type(uint104).max) { revert SafeCastOverflowedUintDowncast(104, value); } return uint104(value); } /** * @dev Returns the downcasted uint96 from uint256, reverting on * overflow (when the input is greater than largest uint96). * * Counterpart to Solidity's `uint96` operator. * * Requirements: * * - input must fit into 96 bits */ function toUint96(uint256 value) internal pure returns (uint96) { if (value > type(uint96).max) { revert SafeCastOverflowedUintDowncast(96, value); } return uint96(value); } /** * @dev Returns the downcasted uint88 from uint256, reverting on * overflow (when the input is greater than largest uint88). * * Counterpart to Solidity's `uint88` operator. * * Requirements: * * - input must fit into 88 bits */ function toUint88(uint256 value) internal pure returns (uint88) { if (value > type(uint88).max) { revert SafeCastOverflowedUintDowncast(88, value); } return uint88(value); } /** * @dev Returns the downcasted uint80 from uint256, reverting on * overflow (when the input is greater than largest uint80). * * Counterpart to Solidity's `uint80` operator. * * Requirements: * * - input must fit into 80 bits */ function toUint80(uint256 value) internal pure returns (uint80) { if (value > type(uint80).max) { revert SafeCastOverflowedUintDowncast(80, value); } return uint80(value); } /** * @dev Returns the downcasted uint72 from uint256, reverting on * overflow (when the input is greater than largest uint72). * * Counterpart to Solidity's `uint72` operator. * * Requirements: * * - input must fit into 72 bits */ function toUint72(uint256 value) internal pure returns (uint72) { if (value > type(uint72).max) { revert SafeCastOverflowedUintDowncast(72, value); } return uint72(value); } /** * @dev Returns the downcasted uint64 from uint256, reverting on * overflow (when the input is greater than largest uint64). * * Counterpart to Solidity's `uint64` operator. * * Requirements: * * - input must fit into 64 bits */ function toUint64(uint256 value) internal pure returns (uint64) { if (value > type(uint64).max) { revert SafeCastOverflowedUintDowncast(64, value); } return uint64(value); } /** * @dev Returns the downcasted uint56 from uint256, reverting on * overflow (when the input is greater than largest uint56). * * Counterpart to Solidity's `uint56` operator. * * Requirements: * * - input must fit into 56 bits */ function toUint56(uint256 value) internal pure returns (uint56) { if (value > type(uint56).max) { revert SafeCastOverflowedUintDowncast(56, value); } return uint56(value); } /** * @dev Returns the downcasted uint48 from uint256, reverting on * overflow (when the input is greater than largest uint48). * * Counterpart to Solidity's `uint48` operator. * * Requirements: * * - input must fit into 48 bits */ function toUint48(uint256 value) internal pure returns (uint48) { if (value > type(uint48).max) { revert SafeCastOverflowedUintDowncast(48, value); } return uint48(value); } /** * @dev Returns the downcasted uint40 from uint256, reverting on * overflow (when the input is greater than largest uint40). * * Counterpart to Solidity's `uint40` operator. * * Requirements: * * - input must fit into 40 bits */ function toUint40(uint256 value) internal pure returns (uint40) { if (value > type(uint40).max) { revert SafeCastOverflowedUintDowncast(40, value); } return uint40(value); } /** * @dev Returns the downcasted uint32 from uint256, reverting on * overflow (when the input is greater than largest uint32). * * Counterpart to Solidity's `uint32` operator. * * Requirements: * * - input must fit into 32 bits */ function toUint32(uint256 value) internal pure returns (uint32) { if (value > type(uint32).max) { revert SafeCastOverflowedUintDowncast(32, value); } return uint32(value); } /** * @dev Returns the downcasted uint24 from uint256, reverting on * overflow (when the input is greater than largest uint24). * * Counterpart to Solidity's `uint24` operator. * * Requirements: * * - input must fit into 24 bits */ function toUint24(uint256 value) internal pure returns (uint24) { if (value > type(uint24).max) { revert SafeCastOverflowedUintDowncast(24, value); } return uint24(value); } /** * @dev Returns the downcasted uint16 from uint256, reverting on * overflow (when the input is greater than largest uint16). * * Counterpart to Solidity's `uint16` operator. * * Requirements: * * - input must fit into 16 bits */ function toUint16(uint256 value) internal pure returns (uint16) { if (value > type(uint16).max) { revert SafeCastOverflowedUintDowncast(16, value); } return uint16(value); } /** * @dev Returns the downcasted uint8 from uint256, reverting on * overflow (when the input is greater than largest uint8). * * Counterpart to Solidity's `uint8` operator. * * Requirements: * * - input must fit into 8 bits */ function toUint8(uint256 value) internal pure returns (uint8) { if (value > type(uint8).max) { revert SafeCastOverflowedUintDowncast(8, value); } return uint8(value); } /** * @dev Converts a signed int256 into an unsigned uint256. * * Requirements: * * - input must be greater than or equal to 0. */ function toUint256(int256 value) internal pure returns (uint256) { if (value < 0) { revert SafeCastOverflowedIntToUint(value); } return uint256(value); } /** * @dev Returns the downcasted int248 from int256, reverting on * overflow (when the input is less than smallest int248 or * greater than largest int248). * * Counterpart to Solidity's `int248` operator. * * Requirements: * * - input must fit into 248 bits */ function toInt248(int256 value) internal pure returns (int248 downcasted) { downcasted = int248(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(248, value); } } /** * @dev Returns the downcasted int240 from int256, reverting on * overflow (when the input is less than smallest int240 or * greater than largest int240). * * Counterpart to Solidity's `int240` operator. * * Requirements: * * - input must fit into 240 bits */ function toInt240(int256 value) internal pure returns (int240 downcasted) { downcasted = int240(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(240, value); } } /** * @dev Returns the downcasted int232 from int256, reverting on * overflow (when the input is less than smallest int232 or * greater than largest int232). * * Counterpart to Solidity's `int232` operator. * * Requirements: * * - input must fit into 232 bits */ function toInt232(int256 value) internal pure returns (int232 downcasted) { downcasted = int232(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(232, value); } } /** * @dev Returns the downcasted int224 from int256, reverting on * overflow (when the input is less than smallest int224 or * greater than largest int224). * * Counterpart to Solidity's `int224` operator. * * Requirements: * * - input must fit into 224 bits */ function toInt224(int256 value) internal pure returns (int224 downcasted) { downcasted = int224(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(224, value); } } /** * @dev Returns the downcasted int216 from int256, reverting on * overflow (when the input is less than smallest int216 or * greater than largest int216). * * Counterpart to Solidity's `int216` operator. * * Requirements: * * - input must fit into 216 bits */ function toInt216(int256 value) internal pure returns (int216 downcasted) { downcasted = int216(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(216, value); } } /** * @dev Returns the downcasted int208 from int256, reverting on * overflow (when the input is less than smallest int208 or * greater than largest int208). * * Counterpart to Solidity's `int208` operator. * * Requirements: * * - input must fit into 208 bits */ function toInt208(int256 value) internal pure returns (int208 downcasted) { downcasted = int208(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(208, value); } } /** * @dev Returns the downcasted int200 from int256, reverting on * overflow (when the input is less than smallest int200 or * greater than largest int200). * * Counterpart to Solidity's `int200` operator. * * Requirements: * * - input must fit into 200 bits */ function toInt200(int256 value) internal pure returns (int200 downcasted) { downcasted = int200(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(200, value); } } /** * @dev Returns the downcasted int192 from int256, reverting on * overflow (when the input is less than smallest int192 or * greater than largest int192). * * Counterpart to Solidity's `int192` operator. * * Requirements: * * - input must fit into 192 bits */ function toInt192(int256 value) internal pure returns (int192 downcasted) { downcasted = int192(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(192, value); } } /** * @dev Returns the downcasted int184 from int256, reverting on * overflow (when the input is less than smallest int184 or * greater than largest int184). * * Counterpart to Solidity's `int184` operator. * * Requirements: * * - input must fit into 184 bits */ function toInt184(int256 value) internal pure returns (int184 downcasted) { downcasted = int184(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(184, value); } } /** * @dev Returns the downcasted int176 from int256, reverting on * overflow (when the input is less than smallest int176 or * greater than largest int176). * * Counterpart to Solidity's `int176` operator. * * Requirements: * * - input must fit into 176 bits */ function toInt176(int256 value) internal pure returns (int176 downcasted) { downcasted = int176(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(176, value); } } /** * @dev Returns the downcasted int168 from int256, reverting on * overflow (when the input is less than smallest int168 or * greater than largest int168). * * Counterpart to Solidity's `int168` operator. * * Requirements: * * - input must fit into 168 bits */ function toInt168(int256 value) internal pure returns (int168 downcasted) { downcasted = int168(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(168, value); } } /** * @dev Returns the downcasted int160 from int256, reverting on * overflow (when the input is less than smallest int160 or * greater than largest int160). * * Counterpart to Solidity's `int160` operator. * * Requirements: * * - input must fit into 160 bits */ function toInt160(int256 value) internal pure returns (int160 downcasted) { downcasted = int160(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(160, value); } } /** * @dev Returns the downcasted int152 from int256, reverting on * overflow (when the input is less than smallest int152 or * greater than largest int152). * * Counterpart to Solidity's `int152` operator. * * Requirements: * * - input must fit into 152 bits */ function toInt152(int256 value) internal pure returns (int152 downcasted) { downcasted = int152(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(152, value); } } /** * @dev Returns the downcasted int144 from int256, reverting on * overflow (when the input is less than smallest int144 or * greater than largest int144). * * Counterpart to Solidity's `int144` operator. * * Requirements: * * - input must fit into 144 bits */ function toInt144(int256 value) internal pure returns (int144 downcasted) { downcasted = int144(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(144, value); } } /** * @dev Returns the downcasted int136 from int256, reverting on * overflow (when the input is less than smallest int136 or * greater than largest int136). * * Counterpart to Solidity's `int136` operator. * * Requirements: * * - input must fit into 136 bits */ function toInt136(int256 value) internal pure returns (int136 downcasted) { downcasted = int136(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(136, value); } } /** * @dev Returns the downcasted int128 from int256, reverting on * overflow (when the input is less than smallest int128 or * greater than largest int128). * * Counterpart to Solidity's `int128` operator. * * Requirements: * * - input must fit into 128 bits */ function toInt128(int256 value) internal pure returns (int128 downcasted) { downcasted = int128(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(128, value); } } /** * @dev Returns the downcasted int120 from int256, reverting on * overflow (when the input is less than smallest int120 or * greater than largest int120). * * Counterpart to Solidity's `int120` operator. * * Requirements: * * - input must fit into 120 bits */ function toInt120(int256 value) internal pure returns (int120 downcasted) { downcasted = int120(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(120, value); } } /** * @dev Returns the downcasted int112 from int256, reverting on * overflow (when the input is less than smallest int112 or * greater than largest int112). * * Counterpart to Solidity's `int112` operator. * * Requirements: * * - input must fit into 112 bits */ function toInt112(int256 value) internal pure returns (int112 downcasted) { downcasted = int112(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(112, value); } } /** * @dev Returns the downcasted int104 from int256, reverting on * overflow (when the input is less than smallest int104 or * greater than largest int104). * * Counterpart to Solidity's `int104` operator. * * Requirements: * * - input must fit into 104 bits */ function toInt104(int256 value) internal pure returns (int104 downcasted) { downcasted = int104(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(104, value); } } /** * @dev Returns the downcasted int96 from int256, reverting on * overflow (when the input is less than smallest int96 or * greater than largest int96). * * Counterpart to Solidity's `int96` operator. * * Requirements: * * - input must fit into 96 bits */ function toInt96(int256 value) internal pure returns (int96 downcasted) { downcasted = int96(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(96, value); } } /** * @dev Returns the downcasted int88 from int256, reverting on * overflow (when the input is less than smallest int88 or * greater than largest int88). * * Counterpart to Solidity's `int88` operator. * * Requirements: * * - input must fit into 88 bits */ function toInt88(int256 value) internal pure returns (int88 downcasted) { downcasted = int88(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(88, value); } } /** * @dev Returns the downcasted int80 from int256, reverting on * overflow (when the input is less than smallest int80 or * greater than largest int80). * * Counterpart to Solidity's `int80` operator. * * Requirements: * * - input must fit into 80 bits */ function toInt80(int256 value) internal pure returns (int80 downcasted) { downcasted = int80(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(80, value); } } /** * @dev Returns the downcasted int72 from int256, reverting on * overflow (when the input is less than smallest int72 or * greater than largest int72). * * Counterpart to Solidity's `int72` operator. * * Requirements: * * - input must fit into 72 bits */ function toInt72(int256 value) internal pure returns (int72 downcasted) { downcasted = int72(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(72, value); } } /** * @dev Returns the downcasted int64 from int256, reverting on * overflow (when the input is less than smallest int64 or * greater than largest int64). * * Counterpart to Solidity's `int64` operator. * * Requirements: * * - input must fit into 64 bits */ function toInt64(int256 value) internal pure returns (int64 downcasted) { downcasted = int64(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(64, value); } } /** * @dev Returns the downcasted int56 from int256, reverting on * overflow (when the input is less than smallest int56 or * greater than largest int56). * * Counterpart to Solidity's `int56` operator. * * Requirements: * * - input must fit into 56 bits */ function toInt56(int256 value) internal pure returns (int56 downcasted) { downcasted = int56(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(56, value); } } /** * @dev Returns the downcasted int48 from int256, reverting on * overflow (when the input is less than smallest int48 or * greater than largest int48). * * Counterpart to Solidity's `int48` operator. * * Requirements: * * - input must fit into 48 bits */ function toInt48(int256 value) internal pure returns (int48 downcasted) { downcasted = int48(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(48, value); } } /** * @dev Returns the downcasted int40 from int256, reverting on * overflow (when the input is less than smallest int40 or * greater than largest int40). * * Counterpart to Solidity's `int40` operator. * * Requirements: * * - input must fit into 40 bits */ function toInt40(int256 value) internal pure returns (int40 downcasted) { downcasted = int40(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(40, value); } } /** * @dev Returns the downcasted int32 from int256, reverting on * overflow (when the input is less than smallest int32 or * greater than largest int32). * * Counterpart to Solidity's `int32` operator. * * Requirements: * * - input must fit into 32 bits */ function toInt32(int256 value) internal pure returns (int32 downcasted) { downcasted = int32(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(32, value); } } /** * @dev Returns the downcasted int24 from int256, reverting on * overflow (when the input is less than smallest int24 or * greater than largest int24). * * Counterpart to Solidity's `int24` operator. * * Requirements: * * - input must fit into 24 bits */ function toInt24(int256 value) internal pure returns (int24 downcasted) { downcasted = int24(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(24, value); } } /** * @dev Returns the downcasted int16 from int256, reverting on * overflow (when the input is less than smallest int16 or * greater than largest int16). * * Counterpart to Solidity's `int16` operator. * * Requirements: * * - input must fit into 16 bits */ function toInt16(int256 value) internal pure returns (int16 downcasted) { downcasted = int16(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(16, value); } } /** * @dev Returns the downcasted int8 from int256, reverting on * overflow (when the input is less than smallest int8 or * greater than largest int8). * * Counterpart to Solidity's `int8` operator. * * Requirements: * * - input must fit into 8 bits */ function toInt8(int256 value) internal pure returns (int8 downcasted) { downcasted = int8(value); if (downcasted != value) { revert SafeCastOverflowedIntDowncast(8, value); } } /** * @dev Converts an unsigned uint256 into a signed int256. * * Requirements: * * - input must be less than or equal to maxInt256. */ function toInt256(uint256 value) internal pure returns (int256) { // Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive if (value > uint256(type(int256).max)) { revert SafeCastOverflowedUintToInt(value); } return int256(value); } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; contract ClaimableAdminStorage { /** * @notice Administrator for this contract */ address public admin; /** * @notice Pending administrator for this contract */ address public pendingAdmin; /*** Modifiers ***/ modifier onlyAdmin() { require(msg.sender == admin, "ONLY_ADMIN"); _; } /*** Constructor ***/ constructor() { // Set admin to caller admin = msg.sender; } } contract AcceptableImplementationClaimableAdminStorage is ClaimableAdminStorage { /** * @notice Active logic */ address public implementation; /** * @notice Pending logic */ address public pendingImplementation; } contract AcceptableRegistryImplementationClaimableAdminStorage is AcceptableImplementationClaimableAdminStorage { /** * @notice System Registry */ address public registry; }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "./AcceptableImplementationClaimableAdminStorage.sol"; /** * @title Claimable Admin */ contract ClaimableAdmin is ClaimableAdminStorage { /** * @notice Emitted when pendingAdmin is changed */ event NewPendingAdmin(address oldPendingAdmin, address newPendingAdmin); /** * @notice Emitted when pendingAdmin is accepted, which means admin is updated */ event NewAdmin(address oldAdmin, address newAdmin); /*** Admin Functions ***/ /** * @notice Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. * @dev Admin function to begin change of admin. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. * @param newPendingAdmin New pending admin. */ function _setPendingAdmin(address newPendingAdmin) public { // Check caller = admin require(msg.sender == admin, "Not Admin"); // Save current value, if any, for inclusion in log address oldPendingAdmin = pendingAdmin; // Store pendingAdmin with value newPendingAdmin pendingAdmin = newPendingAdmin; // Emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin) emit NewPendingAdmin(oldPendingAdmin, newPendingAdmin); } /** * @notice Accepts transfer of admin rights. msg.sender must be pendingAdmin * @dev Admin function for pending admin to accept role and update admin */ function _acceptAdmin() public { // Check caller is pendingAdmin and pendingAdmin ≠ address(0) require( msg.sender == pendingAdmin && pendingAdmin != address(0), "Not the EXISTING pending admin" ); // Save current values for inclusion in log address oldAdmin = admin; address oldPendingAdmin = pendingAdmin; // Store admin with value pendingAdmin admin = pendingAdmin; // Clear the pending value pendingAdmin = address(0); emit NewAdmin(oldAdmin, admin); emit NewPendingAdmin(oldPendingAdmin, pendingAdmin); } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; interface IContractRegistryBase { function isImplementationValidForProxy( bytes32 proxyNameHash, address _implementation ) external view returns (bool); }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; /** * @title EIP712Utils * @notice Utility functions for EIP-712 logic. * @dev Based on https://github.com/ethereum/EIPs/blob/master/assets/eip-712/Example.sol */ contract EIP712Utils { struct EIP712Domain { string name; string version; uint256 chainId; address verifyingContract; } bytes32 public constant EIP712DOMAIN_TYPEHASH = keccak256( "EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)" ); function hashDomain( EIP712Domain memory eip712Domain ) internal pure returns (bytes32) { return keccak256( abi.encode( EIP712DOMAIN_TYPEHASH, keccak256(bytes(eip712Domain.name)), keccak256(bytes(eip712Domain.version)), eip712Domain.chainId, eip712Domain.verifyingContract ) ); } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "./EIP712Utils.sol"; /** * @title MultiChainEIP712Base * @notice Base contract for EIP712 signature verification using multiple chain ids */ contract MultiChainEIP712Base is EIP712Utils { // ***** Events ***** event DomainSeparatorForChainStored( uint256 indexed chainId, bytes32 domainSeparator ); // ***** Storage ***** string public CONTRACT_DOMAIN_NAME; string public CONTRACT_DOMAIN_VERSION; // asset => domain separator for intents mapping(uint256 => bytes32) public domainSeparatorForChain; // ***** Constructor ***** constructor( string memory _contractDomainName, string memory _contractDomainVersion ) { CONTRACT_DOMAIN_NAME = _contractDomainName; CONTRACT_DOMAIN_VERSION = _contractDomainVersion; } // ***** Domain Generation ***** function generateAndStoreDomainSeparatorIfMissingInternal( uint256 chainId ) internal returns (bytes32) { bytes32 storedDomainSeparator = domainSeparatorForChain[chainId]; if (storedDomainSeparator == bytes32(0)) { bytes32 domainSeparator = hashDomain( EIP712Domain({ name: CONTRACT_DOMAIN_NAME, version: CONTRACT_DOMAIN_VERSION, chainId: chainId, verifyingContract: address(this) }) ); domainSeparatorForChain[chainId] = domainSeparator; emit DomainSeparatorForChainStored(chainId, domainSeparator); return domainSeparator; } else { return storedDomainSeparator; } } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import {ChipEnumsV1} from "../interfaces/ChipEnumsV1.sol"; import "../interfaces/IRegistryV1.sol"; /** * @title BaseChip * @notice Base for Chip contracts to inherit from, handles the auto approval mechanism. */ contract BaseChip is ChipEnumsV1 { // ***** Events ***** event AutoApprovedSpenderSet( string indexed role, address indexed oldSpender, address indexed newSpender ); // ***** Immutable Storage ***** IRegistryV1 public immutable registry; ChipMode public immutable chipMode; // ***** Storage ***** // address => is auto approved mapping(address => bool) public autoApproved; // role hash => role address mapping(bytes32 => address) public autoApprovedSpendersByRoles; // ***** Views ***** function getAutoApprovedSpenderAddressByRole( string calldata role ) public view returns (address) { bytes32 roleHash = keccak256(abi.encodePacked(role)); return autoApprovedSpendersByRoles[roleHash]; } // ***** Constructor ***** constructor(IRegistryV1 _registry, ChipMode _chipMode) { require(address(_registry) != address(0), "!_registry"); registry = _registry; chipMode = _chipMode; } // ***** Admin Functions ***** function setAutoApprovedSpenderForRoleInternal( string calldata role, address spender ) internal { require( spender == address(0) || registry.getValidSpenderTargetForChipByRole(address(this), role) == spender, "NOT_REGISTRY_APPROVED" ); address oldSpender = getAutoApprovedSpenderAddressByRole(role); autoApproved[oldSpender] = false; autoApproved[spender] = true; bytes32 roleHash = keccak256(abi.encodePacked(role)); autoApprovedSpendersByRoles[roleHash] = spender; emit AutoApprovedSpenderSet(role, oldSpender, spender); } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "@layerzerolabs/lz-evm-oapp-v2/contracts/oft/OFT.sol"; import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; import "../../interfaces/IRegistryV1.sol"; import "../../interfaces/ILzCreditControllerV1.sol"; import "../../interfaces/ILzDebitControllerV1.sol"; import "../BaseChip.sol"; /** * @title OFTChip * @notice The OFTChip is a remote chip that extends the LayerZero OFT token. */ contract OFTChip is OFT, BaseChip { // ***** Events ***** event IsSendPausedSet(bool isPaused); event CreditControllerSet( address indexed previousController, address indexed newController ); event DebitControllerSet( address indexed previousController, address indexed newController ); event TokensSwept( address indexed token, address indexed receiver, uint256 amount ); // ***** Storage ***** bool public isSendPaused; ILzCreditControllerV1 public creditController; ILzDebitControllerV1 public debitController; // ***** Constructor ***** constructor( IRegistryV1 _registry, string memory _name, string memory _symbol, address _lzEndpoint, address _delegate, address _initialOwner ) OFT(_name, _symbol, _lzEndpoint, _delegate) BaseChip(_registry, ChipMode.REMOTE) Ownable(_initialOwner) { require(address(_lzEndpoint) != address(0), "!_lzEndpoint"); } // ***** Admin Functions ***** /** * @notice Set the auto approved spender for a role * @param role The role to set the spender for * @param spender The spender to set */ function setAutoApprovedSpenderForRole( string calldata role, address spender ) external onlyOwner { setAutoApprovedSpenderForRoleInternal(role, spender); } /** * @notice Set the send pause state * @param _isPaused The new send pause state */ function setIsSendPaused(bool _isPaused) external onlyOwner { bool currentState = isSendPaused; require(_isPaused != currentState, "ALREADY_SET"); isSendPaused = _isPaused; emit IsSendPausedSet(_isPaused); } /** * @notice Set the credit controller * @param _creditController The new credit controller */ function setCreditController( ILzCreditControllerV1 _creditController ) external onlyOwner { // Sanity require( address(_creditController) == address(0) || _creditController.isCreditController(), "NOT_CREDIT_CONTROLLER" ); address previousController = address(creditController); require(previousController != address(_creditController), "ALREADY_SET"); creditController = _creditController; emit CreditControllerSet(previousController, address(_creditController)); } /** * @notice Set the debit controller * @param _debitController The new debit controller */ function setDebitController( ILzDebitControllerV1 _debitController ) external onlyOwner { // Sanity require( address(_debitController) == address(0) || _debitController.isDebitController(), "NOT_DEBIT_CONTROLLER" ); address previousController = address(debitController); require(previousController != address(_debitController), "ALREADY_SET"); debitController = _debitController; emit DebitControllerSet(previousController, address(_debitController)); } /** * @notice Sweep any non-underlying tokens from the contract * @dev Owner can sweep any tokens other than the underlying token * @param _token The token to sweep * @param _amount The amount to sweep */ function sweepTokens(ERC20 _token, uint256 _amount) external onlyOwner { require(address(_token) != address(this), "CANNOT_SWEEP_SELF"); _token.transfer(owner(), _amount); emit TokensSwept(address(_token), owner(), _amount); } // ***** Lz Functions ***** /** * @dev Credits tokens to the specified address. * @param _to The address to credit the tokens to. * @param _amountLD The amount of tokens to credit in local decimals. * @dev _srcEid The source chain ID. * @return amountReceivedLD The amount of tokens ACTUALLY received in local decimals. */ function _credit( address _to, uint256 _amountLD, uint32 _srcEid ) internal virtual override returns (uint256 amountReceivedLD) { ILzCreditControllerV1 creditController_ = creditController; if (address(creditController_) != address(0)) { try creditController_.informLzCreditRequest(_to, _amountLD, _srcEid) {} catch {} } return super._credit(_to, _amountLD, _srcEid); } /** * @dev Burns tokens from the sender's specified balance. * @param _from The address to debit the tokens from. * @param _amountLD The amount of tokens to send in local decimals. * @param _minAmountLD The minimum amount to send in local decimals. * @param _dstEid The destination chain ID. * @return amountSentLD The amount sent in local decimals. * @return amountReceivedLD The amount received in local decimals on the remote. */ function _debit( address _from, uint256 _amountLD, uint256 _minAmountLD, uint32 _dstEid ) internal virtual override returns (uint256 amountSentLD, uint256 amountReceivedLD) { require(!isSendPaused, "SEND_PAUSED"); ILzDebitControllerV1 debitController_ = debitController; if (address(debitController_) != address(0)) { require( debitController_.informLzDebitRequestWithSource( _from, _amountLD, _minAmountLD, _dstEid ), "DEBIT_NOT_APPROVED" ); } return super._debit(_from, _amountLD, _minAmountLD, _dstEid); } // ***** ERC20 internal override Functions ***** /** * @notice Uses the base ERC20 logic unless 'spender' is marked as 'autoApproved' */ function allowance( address owner, address spender ) public view virtual override returns (uint256) { if (autoApproved[spender]) { return type(uint).max; } else { return ERC20.allowance(owner, spender); } } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; import "@layerzerolabs/lz-evm-oapp-v2/contracts/oft/OFTAdapter.sol"; import "../../interfaces/ILzCreditControllerV1.sol"; import "../../interfaces/ILzDebitControllerV1.sol"; /** * @title OFTChipAdapter * @notice The OFTChipAdapter is a the source chain counterpart of the OFTChip that extends the LayerZero OFT token adapter. */ contract OFTChipAdapter is OFTAdapter { // ***** Events ***** event IsSendPausedSet(bool isPaused); event CreditControllerSet( address indexed previousController, address indexed newController ); event DebitControllerSet( address indexed previousController, address indexed newController ); event UnderlyingRecoveryRenounced(); event UnderlyingRecovered(address indexed receiver, uint256 amount); event TokensSwept( address indexed token, address indexed receiver, uint256 amount ); // ***** Storage ***** bool public isSendPaused; bool public isUnderlyingRecoveryRenounced; ILzCreditControllerV1 public creditController; ILzDebitControllerV1 public debitController; // ***** Constructor ***** constructor( address _token, // a deployed, already existing ERC20 token address address _layerZeroEndpoint, // local endpoint address address _delegate, // delegate address address _initialOwner // token owner ) OFTAdapter(_token, _layerZeroEndpoint, _delegate) Ownable(_initialOwner) {} // ***** Admin Functions ***** /** * @notice Set the send pause state * @param _isPaused The new send pause state */ function setIsSendPaused(bool _isPaused) external onlyOwner { bool currentState = isSendPaused; require(_isPaused != currentState, "ALREADY_SET"); isSendPaused = _isPaused; emit IsSendPausedSet(_isPaused); } /** * @notice Set the credit controller * @param _creditController The new credit controller */ function setCreditController( ILzCreditControllerV1 _creditController ) external onlyOwner { // Sanity require( address(_creditController) == address(0) || _creditController.isCreditController(), "NOT_CREDIT_CONTROLLER" ); address previousController = address(creditController); require(previousController != address(_creditController), "ALREADY_SET"); creditController = _creditController; emit CreditControllerSet(previousController, address(_creditController)); } /** * @notice Set the debit controller * @param _debitController The new debit controller */ function setDebitController( ILzDebitControllerV1 _debitController ) external onlyOwner { // Sanity require( address(_debitController) == address(0) || _debitController.isDebitController(), "NOT_DEBIT_CONTROLLER" ); address previousController = address(debitController); require(previousController != address(_debitController), "ALREADY_SET"); debitController = _debitController; emit DebitControllerSet(previousController, address(_debitController)); } /** * @notice Renounce the ability to recover the underlying token * @dev Once renounced, it cannot be undone */ function renounceUnderlyingRecovery() external onlyOwner { require(!isUnderlyingRecoveryRenounced, "ALREADY_RENOUNCED"); isUnderlyingRecoveryRenounced = true; emit UnderlyingRecoveryRenounced(); } /** * @notice Recover the underlying token * @dev Owner can recover the underlying token in emergency situations * @param _amount The amount to recover */ function recoverUnderlying(uint256 _amount) external onlyOwner { require(!isUnderlyingRecoveryRenounced, "UNDERLYING_RECOVERY_RENOUNCED"); innerToken.transfer(owner(), _amount); emit UnderlyingRecovered(owner(), _amount); } /** * @notice Sweep any non-underlying tokens from the contract * @dev Owner can sweep any tokens other than the underlying token * @param _token The token to sweep * @param _amount The amount to sweep */ function sweepTokens(IERC20 _token, uint256 _amount) external onlyOwner { require( address(_token) != address(innerToken), "CANNOT_SWEEP_ADAPTER_TOKEN" ); _token.transfer(owner(), _amount); emit TokensSwept(address(_token), owner(), _amount); } // ***** Lz Functions ***** /** * @dev Credits tokens to the specified address. * @param _to The address to credit the tokens to. * @param _amountLD The amount of tokens to credit in local decimals. * @dev _srcEid The source chain ID. * @return amountReceivedLD The amount of tokens ACTUALLY received in local decimals. * * @dev WARNING: The default OFTAdapter implementation assumes LOSSLESS transfers, ie. 1 token in, 1 token out. * IF the 'innerToken' applies something like a transfer fee, the default will NOT work... * a pre/post balance check will need to be done to calculate the amountReceivedLD. */ function _credit( address _to, uint256 _amountLD, uint32 _srcEid ) internal virtual override returns (uint256 amountReceivedLD) { // Informs the credit controller if exists // If it fails, it will not affect the main flow ILzCreditControllerV1 creditController_ = creditController; if (address(creditController_) != address(0)) { try creditController_.informLzCreditRequest(_to, _amountLD, _srcEid) {} catch {} } // Continue withe the regular flow return super._credit(_to, _amountLD, _srcEid); } /** * @dev Burns tokens from the sender's specified balance, ie. pull method. * @param _from The address to debit from. * @param _amountLD The amount of tokens to send in local decimals. * @param _minAmountLD The minimum amount to send in local decimals. * @param _dstEid The destination chain ID. * @return amountSentLD The amount sent in local decimals. * @return amountReceivedLD The amount received in local decimals on the remote. * * @dev msg.sender will need to approve this _amountLD of tokens to be locked inside of the contract. * @dev WARNING: The default OFTAdapter implementation assumes LOSSLESS transfers, ie. 1 token in, 1 token out. * IF the 'innerToken' applies something like a transfer fee, the default will NOT work... * a pre/post balance check will need to be done to calculate the amountReceivedLD. */ function _debit( address _from, uint256 _amountLD, uint256 _minAmountLD, uint32 _dstEid ) internal virtual override returns (uint256 amountSentLD, uint256 amountReceivedLD) { // Check if sending is paused require(!isSendPaused, "SEND_PAUSED"); // Request approval from the debit controller if exists ILzDebitControllerV1 debitController_ = debitController; if (address(debitController_) != address(0)) { require( debitController_.informLzDebitRequestWithSource( _from, _amountLD, _minAmountLD, _dstEid ), "DEBIT_NOT_APPROVED" ); } // Continue withe the regular flow return super._debit(_from, _amountLD, _minAmountLD, _dstEid); } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "../../AdministrationContracts/ClaimableAdmin.sol"; import "../../CryptographyContracts/MultiChainEIP712Base.sol"; import {IntentsPermissions, PermissionsType} from "../../Peripheral/Chips/IntentsPermissions.sol"; import {OFTChip} from "../Chips/OFTChip/OFTChip.sol"; /** * @title MultiSourceChainIntentsVerifierBase * @dev Base contract for verifying intents that can be signed with different 'chainId' values. */ contract MultiSourceChainIntentsVerifierBase is ClaimableAdmin, MultiChainEIP712Base { // ***** Storage ***** string public constant DYN_ROLE_INTENTS_PERMISSIONS_PREFIX = "INTENTS_PERMISSIONS_"; // OFTChip => open flag to check for intents permissions mapping(OFTChip => string) public intentsPermissions; // ***** Events ***** event SourceChainIdForAssetStored( address indexed asset, uint256 indexed chainId ); // asset => source chain ID mapping(address => uint256) public sourceChainIdForAsset; constructor( string memory _contractDomainName, string memory _contractDomainVersion ) MultiChainEIP712Base(_contractDomainName, _contractDomainVersion) {} // ***** Views ***** /** * @notice Returns the domain separator for the given asset. * @param asset The asset for which to return the domain separator. * @return The domain separator for the given asset. */ function domainSeparatorForAsset( address asset ) public view returns (bytes32) { return domainSeparatorForChain[sourceChainIdForAsset[asset]]; } // ***** Admin Functions ***** /** * @notice Stores the source chain ID for the given asset. * @param asset The asset for which to store the source chain ID. * @param chainId The source chain ID to store. */ function storeSourceChainForAsset( address asset, uint256 chainId ) external virtual onlyAdmin { storeSourceChainForAssetInternal(asset, chainId); } /** * @notice Opens/Closes the intents permissions check for the chip. * @param oftChip The chip for the intents permissions check. * @param dynAddressSuffix is a suffix for dynamicly set address in the Registry */ function setIntentsPermissions( OFTChip oftChip, string calldata dynAddressSuffix ) external onlyAdmin { intentsPermissions[oftChip] = dynAddressSuffix; } // ***** Internals ***** /** * @notice Stores the source chain ID for the given asset. * @dev chain Ids for assets cannot be changed. * @param asset The asset for which to store the source chain ID. * @param chainId The source chain ID to store. */ function storeSourceChainForAssetInternal( address asset, uint256 chainId ) internal { // Can only configure once require( sourceChainIdForAsset[asset] == 0, "CHAIN_ID_FOR_ASSET_ALREADY_CONFIGURED" ); // Cannot set to zero require(chainId != 0, "CHAIN_ID_ZERO"); // Ensure domain separator is configured for this chain generateAndStoreDomainSeparatorIfMissingInternal(chainId); // Store mapping sourceChainIdForAsset[asset] = chainId; // event emit SourceChainIdForAssetStored(asset, chainId); } /** * @notice Returns the domain separator for the given asset. * @dev Allows inheriting contracts to get the relevant domain separator for intents verifications. * @param _asset The asset for which to return the domain separator. * @return The domain separator for the given asset. */ function getDomainSeparatorForAssetInternal( address _asset ) internal view returns (bytes32) { (bytes32 domainSeparator, ) = getDomainSeparatorAndChainForAssetInternal( _asset ); return domainSeparator; } /** * @notice Returns the domain separator and chain ID for the given asset. * @dev Allows inheriting contracts to get the relevant domain separator and chain ID for intents verifications. * @param _asset The asset for which to return the domain separator and chain ID. * @return The domain separator and chain ID for the given asset. */ function getDomainSeparatorAndChainForAssetInternal( address _asset ) internal view returns (bytes32, uint256) { uint256 chainId = sourceChainIdForAsset[_asset]; require(chainId != 0, "NO_CHAIN_ID_FOR_ASSET"); bytes32 domainSeparator = domainSeparatorForChain[chainId]; require(domainSeparator != bytes32(0), "NO_DOMAIN_SEPARATOR_FOR_CHAIN"); return (domainSeparator, chainId); } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; /** * @title AccountAndActionSerialNonceBase * @notice Base contract for managing serial nonces for actions per account */ contract AccountAndActionSerialNonceBase { // ***** Storage ***** // account => action type => nonce mapping(address => mapping(uint8 => uint256)) public nonceMap; // ***** Views ***** /** * @notice Get the next valid nonce for an account and action type. * @param account The account to get the nonce for. * @param actionType The action type to get the nonce for. * @return The next valid nonce. */ function getNextValidNonceFor( address account, uint8 actionType ) external view returns (uint256) { return nonceMap[account][actionType]; } // ***** Internal ***** /** * @notice Validate a nonce for an account and action type, and increase the stored counter by 1. * @param account The account to validate the nonce for. * @param actionType The action type to validate the nonce for. * @param nonce The nonce to validate. */ function validateNonceForActionAndIncrease( address account, uint8 actionType, uint256 nonce ) internal { uint256 currentNonceMapValue = nonceMap[account][actionType]; require(nonce == currentNonceMapValue, "INCORRECT_NONCE"); nonceMap[account][actionType] = currentNonceMapValue + 1; } }
// SPDX-License-Identifier: UNLICENSED pragma solidity ^0.8.24; contract ChipEnumsV1 { enum ChipMode { NONE, LOCAL, REMOTE, HYBRID } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; interface IGlobalLock { function lock() external; function freeLock() external; }
// SPDX-License-Identifier: UNLICENSED pragma solidity ^0.8.24; interface ILzCreditControllerV1 { function isCreditController() external view returns (bool); function informLzCreditRequest( address _to, uint256 _amountToCreditLD, uint32 /*_srcEid*/ ) external returns (bool isPermitted); }
// SPDX-License-Identifier: UNLICENSED pragma solidity ^0.8.24; interface ILzDebitControllerV1 { function isDebitController() external view returns (bool); function informLzDebitRequest( uint256 _amountToSendLD, // amount to send in local decimals() uint256 _minAmountToCreditLD, // minimum ammount to credit on the destination uint32 _dstEid // destination endpoint id ) external returns (bool isPermitted); function informLzDebitRequestWithSource( address _debitFrom, // address to debit from uint256 _amountToSendLD, // amount to send in local decimals() uint256 _minAmountToCreditLD, // minimum ammount to credit on the destination uint32 _dstEid // destination endpoint id ) external returns (bool isPermitted); }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "../../AdministrationContracts/IContractRegistryBase.sol"; import "./IGlobalLock.sol"; interface IRegistryV1Functionality is IContractRegistryBase, IGlobalLock { // **** Locking mechanism **** function isTradersPortalAndLocker( address _address ) external view returns (bool); function isTriggersAndLocker(address _address) external view returns (bool); function isTradersPortalOrTriggersAndLocker( address _address ) external view returns (bool); } interface IRegistryV1 is IRegistryV1Functionality { // **** Public Storage params **** function feesManagers(address asset) external view returns (address); function orderBook() external view returns (address); function tradersPortal() external view returns (address); function triggers() external view returns (address); function tradeIntentsVerifier() external view returns (address); function liquidityIntentsVerifier() external view returns (address); function chipsIntentsVerifier() external view returns (address); function lexProxiesFactory() external view returns (address); function chipsFactory() external view returns (address); /** * @return An array of all supported trading floors */ function getAllSupportedTradingFloors() external view returns (address[] memory); /** * @return An array of all supported settlement assets */ function getSettlementAssetsForTradingFloor( address _tradingFloor ) external view returns (address[] memory); /** * @return The spender role address that is set for this chip */ function getValidSpenderTargetForChipByRole( address chip, string calldata role ) external view returns (address); /** * @return the address of the valid 'burnHandler' for the chip */ function validBurnHandlerForChip( address chip ) external view returns (address); /** * @return The address matching for the given role */ function getDynamicRoleAddress( string calldata _role ) external view returns (address); }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; interface IWrappedNative { function deposit() external payable returns (uint256); function withdraw(uint256 amount) external returns (uint256); } interface IWrappedNativeNoReturn { function deposit() external payable; function withdraw(uint256) external; }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; import {IOAppComposer} from "@layerzerolabs/lz-evm-oapp-v2/contracts/oapp/interfaces/IOAppComposer.sol"; import {OFTComposeMsgCodec} from "@layerzerolabs/lz-evm-oapp-v2/contracts/oft/libs/OFTComposeMsgCodec.sol"; import "../../AdministrationContracts/ClaimableAdmin.sol"; import "../../Lynx/Chips/OFTChip/OFTChip.sol"; uint8 constant PERMISSIONS_SIZE = 4; // @dev Change PERMISSIONS_SIZE when changing the enum enum PermissionsType { // @dev NEVER CHANGE THE ORDER OF THIS ENUM! NONE, TRADING, LIQUIDITY, CHIP_OUT } struct IntentsPermissionsMsg { bool allow; PermissionsType permissionsType; address spender; } /** * @title IntentsPermissions * @notice Holds permissions for signing intents on behalf of another account */ contract IntentsPermissions is IOAppComposer, ClaimableAdmin { using SafeERC20 for IERC20; // ***** Events ***** event IntentsPermissionsSet( PermissionsType indexed permissionsType, address indexed owner, address indexed spender, bool allow ); event AllowedCreatePermissionsSet(address indexed owner, bool allowed); event TokensSwept( address indexed token, address indexed receiver, uint256 amount ); event NativeSwept(address indexed receiver, uint256 amount); // ***** Immutable Storage ***** OFTChip public immutable oftChip; IERC20 public immutable oftChipToken; // ***** Storage ***** // Owner address => isAllowed mapping(address => bool) public allowedCreatePermissions; // PermissionsType => owner address => spender address => is approved mapping(address => mapping(address => bool))[PERMISSIONS_SIZE] public permissions; // ***** Views ***** function isAllowedCreatePermissions( address owner ) public view returns (bool) { return allowedCreatePermissions[owner]; } function permission( PermissionsType permissionsType, address owner, address spender ) public view returns (bool) { return permissions[uint256(permissionsType)][owner][spender]; } // ***** Constructor ***** constructor(address _oftChip) { require(_oftChip != address(0), "INVALID_OFT_CHIP"); oftChip = OFTChip(_oftChip); oftChipToken = IERC20(oftChip.token()); } // ***** Admin Functions ***** /// @notice Sets the allowedCreatePermissions flag. /// @param _allowedCreatePermissions The new allowedCreatePermissions flag. function setAllowedCreatePermissions( address _allowedCreatePermissions, bool _allowed ) external onlyAdmin { allowedCreatePermissions[_allowedCreatePermissions] = _allowed; emit AllowedCreatePermissionsSet(_allowedCreatePermissions, _allowed); } /** * @notice Sweep any non-underlying tokens from the contract * @dev Owner can sweep any tokens, this contract should not hold any tokens * @param _token The token to sweep * @param _amount The amount to sweep */ function sweepTokens(IERC20 _token, uint256 _amount) external onlyAdmin { _token.safeTransfer(admin, _amount); emit TokensSwept(address(_token), admin, _amount); } /** * @notice Sweep native coin from the contract * @dev Owner can sweep any native coin accidentally sent to the contract * @param _amount The amount to sweep */ function sweepNative(uint256 _amount) external onlyAdmin { payable(admin).transfer(_amount); emit NativeSwept(admin, _amount); } // ***** External Functions ***** /// @notice Handles incoming composed messages from LayerZero. /// @dev Decodes the message payload to perform intents permission setting and pass tokens to the owner. /// This method expects the encoded compose message to contain the permissions type, spender and a flag to turn on/off permissions. /// @param oApp The address of the originating OApp. /// @param /*guid*/ The globally unique identifier of the message (unused). /// @param message The encoded message content in the format of the OFTComposeMsgCodec. /// @param /*Executor*/ Executor address (unused). /// @param /*Executor Data*/ Additional data for checking for a specific executor (unused). function lzCompose( address oApp, bytes32 /*guid*/, bytes calldata message, address /*Executor*/, bytes calldata /*Executor Data*/ ) external payable override { require(oApp == address(oftChip), "INVALID_OAPP_RECEIVED"); require( msg.sender == address(oftChip.endpoint()), "INVALID_ENDPOINT_RECEIVED" ); // Transfer chips to the sender uint256 amountLD = OFTComposeMsgCodec.amountLD(message); address owner = OFTComposeMsgCodec.bytes32ToAddress( OFTComposeMsgCodec.composeFrom(message) ); oftChipToken.safeTransfer(owner, amountLD); // Check if the owner is allowed to create permissions if (!allowedCreatePermissions[owner]) { return; } // Extract the composed message from the delivered message using the MsgCodec IntentsPermissionsMsg memory intentsPermissionsMsg = abi.decode( OFTComposeMsgCodec.composeMsg(message), (IntentsPermissionsMsg) ); permissions[uint256(intentsPermissionsMsg.permissionsType)][owner][ intentsPermissionsMsg.spender ] = intentsPermissionsMsg.allow; // Emit an event to log the given permission emit IntentsPermissionsSet( intentsPermissionsMsg.permissionsType, owner, intentsPermissionsMsg.spender, intentsPermissionsMsg.allow ); } function setPermissionForSpender( PermissionsType _permissionsType, address _spender, bool _allow ) external { address owner = msg.sender; // Check if the owner is allowed to create permissions if (!allowedCreatePermissions[owner]) { return; } // State require( permissions[uint256(_permissionsType)][owner][_spender] != _allow, "ALREADY_SET" ); permissions[uint256(_permissionsType)][owner][_spender] = _allow; // Event emit IntentsPermissionsSet(_permissionsType, owner, _spender, _allow); } }
// SPDX-License-Identifier: BUSL-1.1 pragma solidity ^0.8.24; import "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; import "../../Lynx/interfaces/IWrappedNative.sol"; import "../../Lynx/Chips/OFTChip/OFTChipAdapter.sol"; import "../../AdministrationContracts/ClaimableAdmin.sol"; import "@layerzerolabs/lz-evm-oapp-v2/contracts/oft/interfaces/IOFT.sol"; import {IOAppComposer} from "@layerzerolabs/lz-evm-oapp-v2/contracts/oapp/interfaces/IOAppComposer.sol"; import {OFTComposeMsgCodec} from "@layerzerolabs/lz-evm-oapp-v2/contracts/oft/libs/OFTComposeMsgCodec.sol"; /** * @title WrapNativeChipInOutHelper * @dev Helper contract for wrapping native tokens and sending them to the OFT chip adapter * @dev Helper contract for unwrapping native tokens received from the OFT chip adapter through LZ Composer */ contract WrapNativeChipInOutHelper is IOAppComposer, ClaimableAdmin { using SafeERC20 for IERC20; // ***** Events ***** event TokensSwept( address indexed token, address indexed receiver, uint256 amount ); event NativeSwept(address indexed receiver, uint256 amount); event WrapNativeAndSend(bytes32 to, uint256 amountLD); event UnwrapNativeAndSend(address indexed to, uint256 amountLD); // ***** Immutable State ***** OFTChipAdapter public immutable oftChipAdapter; IWrappedNativeNoReturn public immutable wrappedNativeToken; // ***** Constructor ***** constructor(address _oftChipAdapter) { require(_oftChipAdapter != address(0), "INVALID_ADAPTER"); oftChipAdapter = OFTChipAdapter(_oftChipAdapter); wrappedNativeToken = IWrappedNativeNoReturn(oftChipAdapter.token()); // Check wether deposit/withdraw functions are implemented wrappedNativeToken.deposit{value: 0}(); wrappedNativeToken.withdraw(0); IERC20(address(wrappedNativeToken)).approve( address(oftChipAdapter), type(uint256).max ); } // ***** Admin Functions ***** /** * @notice Sweep any non-underlying tokens from the contract * @dev Owner can sweep any tokens, this contract should not hold any tokens * @param _token The token to sweep * @param _amount The amount to sweep */ function sweepTokens(IERC20 _token, uint256 _amount) external onlyAdmin { _token.safeTransfer(admin, _amount); emit TokensSwept(address(_token), admin, _amount); } /** * @notice Sweep native coin from the contract * @dev Owner can sweep any native coin accidentally sent to the contract * @param _amount The amount to sweep */ function sweepNative(uint256 _amount) external onlyAdmin { payable(admin).transfer(_amount); emit NativeSwept(admin, _amount); } // ***** External Functions ***** function wrapNativeAndSend( SendParam calldata sendParam, MessagingFee calldata fee, address refundAddress ) external payable { require(msg.value == sendParam.amountLD + fee.nativeFee, "INVALID_AMOUNT"); wrappedNativeToken.deposit{value: sendParam.amountLD}(); oftChipAdapter.send{value: fee.nativeFee}(sendParam, fee, refundAddress); emit WrapNativeAndSend(sendParam.to, sendParam.amountLD); } receive() external payable {} /// @notice Handles incoming composed messages from LayerZero. /// @dev Decodes the message payload to perform native token unwrapping. /// This method expects the encoded compose message to contain the token amount and the recipient address. /// @param oApp The address of the originating OApp. /// @param /*guid*/ The globally unique identifier of the message (unused). /// @param message The encoded message content in the format of the OFTComposeMsgCodec. /// @param /*Executor*/ Executor address (unused). /// @param /*Executor Data*/ Additional data for checking for a specific executor (unused). function lzCompose( address oApp, bytes32 /*guid*/, bytes calldata message, address /*Executor*/, bytes calldata /*Executor Data*/ ) external payable override { require(oApp == address(oftChipAdapter), "INVALID_OAPP_RECEIVED"); require( msg.sender == address(oftChipAdapter.endpoint()), "INVALID_ENDPOINT_RECEIVED" ); // Extract the composed message from the delivered message using the MsgCodec address receiver = abi.decode( OFTComposeMsgCodec.composeMsg(message), (address) ); uint256 amountLD = OFTComposeMsgCodec.amountLD(message); // Execute the native unwrapping uint256 balanceBefore = address(this).balance; wrappedNativeToken.withdraw(amountLD); uint256 balanceAfter = address(this).balance; // Transfer the unwrapped native tokens to the receiver payable(receiver).transfer(balanceAfter - balanceBefore); // Emit an event to log the token transfer details emit UnwrapNativeAndSend(receiver, amountLD); } }
// SPDX-License-Identifier: Unlicense /* * @title Solidity Bytes Arrays Utils * @author Gonçalo Sá <[email protected]> * * @dev Bytes tightly packed arrays utility library for ethereum contracts written in Solidity. * The library lets you concatenate, slice and type cast bytes arrays both in memory and storage. */ pragma solidity >=0.8.0 <0.9.0; library BytesLib { 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 concatStorage(bytes storage _preBytes, bytes memory _postBytes) internal { assembly { // Read the first 32 bytes of _preBytes storage, which is the length // of the array. (We don't need to use the offset into the slot // because arrays use the entire slot.) let fslot := sload(_preBytes.slot) // Arrays of 31 bytes or less have an even value in their slot, // while longer arrays have an odd value. The actual length is // the slot divided by two for odd values, and the lowest order // byte divided by two for even values. // If the slot is even, bitwise and the slot with 255 and divide by // two to get the length. If the slot is odd, bitwise and the slot // with -1 and divide by two. let slength := div(and(fslot, sub(mul(0x100, iszero(and(fslot, 1))), 1)), 2) let mlength := mload(_postBytes) let newlength := add(slength, mlength) // slength can contain both the length and contents of the array // if length < 32 bytes so let's prepare for that // v. http://solidity.readthedocs.io/en/latest/miscellaneous.html#layout-of-state-variables-in-storage switch add(lt(slength, 32), lt(newlength, 32)) case 2 { // Since the new array still fits in the slot, we just need to // update the contents of the slot. // uint256(bytes_storage) = uint256(bytes_storage) + uint256(bytes_memory) + new_length sstore( _preBytes.slot, // all the modifications to the slot are inside this // next block add( // we can just add to the slot contents because the // bytes we want to change are the LSBs fslot, add( mul( div( // load the bytes from memory mload(add(_postBytes, 0x20)), // zero all bytes to the right exp(0x100, sub(32, mlength)) ), // and now shift left the number of bytes to // leave space for the length in the slot exp(0x100, sub(32, newlength)) ), // increase length by the double of the memory // bytes length mul(mlength, 2) ) ) ) } case 1 { // The stored value fits in the slot, but the combined value // will exceed it. // get the keccak hash to get the contents of the array mstore(0x0, _preBytes.slot) let sc := add(keccak256(0x0, 0x20), div(slength, 32)) // save new length sstore(_preBytes.slot, add(mul(newlength, 2), 1)) // The contents of the _postBytes array start 32 bytes into // the structure. Our first read should obtain the `submod` // bytes that can fit into the unused space in the last word // of the stored array. To get this, we read 32 bytes starting // from `submod`, so the data we read overlaps with the array // contents by `submod` bytes. Masking the lowest-order // `submod` bytes allows us to add that value directly to the // stored value. let submod := sub(32, slength) let mc := add(_postBytes, submod) let end := add(_postBytes, mlength) let mask := sub(exp(0x100, submod), 1) sstore( sc, add( and( fslot, 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff00 ), and(mload(mc), mask) ) ) for { mc := add(mc, 0x20) sc := add(sc, 1) } lt(mc, end) { sc := add(sc, 1) mc := add(mc, 0x20) } { sstore(sc, mload(mc)) } mask := exp(0x100, sub(mc, end)) sstore(sc, mul(div(mload(mc), mask), mask)) } default { // get the keccak hash to get the contents of the array mstore(0x0, _preBytes.slot) // Start copying to the last used word of the stored array. let sc := add(keccak256(0x0, 0x20), div(slength, 32)) // save new length sstore(_preBytes.slot, add(mul(newlength, 2), 1)) // Copy over the first `submod` bytes of the new data as in // case 1 above. let slengthmod := mod(slength, 32) let mlengthmod := mod(mlength, 32) let submod := sub(32, slengthmod) let mc := add(_postBytes, submod) let end := add(_postBytes, mlength) let mask := sub(exp(0x100, submod), 1) sstore(sc, add(sload(sc), and(mload(mc), mask))) for { sc := add(sc, 1) mc := add(mc, 0x20) } lt(mc, end) { sc := add(sc, 1) mc := add(mc, 0x20) } { sstore(sc, mload(mc)) } mask := exp(0x100, sub(mc, end)) sstore(sc, mul(div(mload(mc), mask), mask)) } } } function slice( bytes memory _bytes, uint256 _start, uint256 _length ) internal pure returns (bytes memory) { require(_length + 31 >= _length, "slice_overflow"); require(_bytes.length >= _start + _length, "slice_outOfBounds"); 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; } function toAddress(bytes memory _bytes, uint256 _start) internal pure returns (address) { require(_bytes.length >= _start + 20, "toAddress_outOfBounds"); address tempAddress; assembly { tempAddress := div(mload(add(add(_bytes, 0x20), _start)), 0x1000000000000000000000000) } return tempAddress; } function toUint8(bytes memory _bytes, uint256 _start) internal pure returns (uint8) { require(_bytes.length >= _start + 1 , "toUint8_outOfBounds"); uint8 tempUint; assembly { tempUint := mload(add(add(_bytes, 0x1), _start)) } return tempUint; } function toUint16(bytes memory _bytes, uint256 _start) internal pure returns (uint16) { require(_bytes.length >= _start + 2, "toUint16_outOfBounds"); uint16 tempUint; assembly { tempUint := mload(add(add(_bytes, 0x2), _start)) } return tempUint; } function toUint32(bytes memory _bytes, uint256 _start) internal pure returns (uint32) { require(_bytes.length >= _start + 4, "toUint32_outOfBounds"); uint32 tempUint; assembly { tempUint := mload(add(add(_bytes, 0x4), _start)) } return tempUint; } function toUint64(bytes memory _bytes, uint256 _start) internal pure returns (uint64) { require(_bytes.length >= _start + 8, "toUint64_outOfBounds"); uint64 tempUint; assembly { tempUint := mload(add(add(_bytes, 0x8), _start)) } return tempUint; } function toUint96(bytes memory _bytes, uint256 _start) internal pure returns (uint96) { require(_bytes.length >= _start + 12, "toUint96_outOfBounds"); uint96 tempUint; assembly { tempUint := mload(add(add(_bytes, 0xc), _start)) } return tempUint; } function toUint128(bytes memory _bytes, uint256 _start) internal pure returns (uint128) { require(_bytes.length >= _start + 16, "toUint128_outOfBounds"); uint128 tempUint; assembly { tempUint := mload(add(add(_bytes, 0x10), _start)) } return tempUint; } function toUint256(bytes memory _bytes, uint256 _start) internal pure returns (uint256) { require(_bytes.length >= _start + 32, "toUint256_outOfBounds"); uint256 tempUint; assembly { tempUint := mload(add(add(_bytes, 0x20), _start)) } return tempUint; } function toBytes32(bytes memory _bytes, uint256 _start) internal pure returns (bytes32) { require(_bytes.length >= _start + 32, "toBytes32_outOfBounds"); bytes32 tempBytes32; assembly { tempBytes32 := mload(add(add(_bytes, 0x20), _start)) } return tempBytes32; } function equal(bytes memory _preBytes, bytes memory _postBytes) internal pure returns (bool) { bool success = true; assembly { let length := mload(_preBytes) // if lengths don't match the arrays are not equal switch eq(length, mload(_postBytes)) case 1 { // cb is a circuit breaker in the for loop since there's // no said feature for inline assembly loops // cb = 1 - don't breaker // cb = 0 - break let cb := 1 let mc := add(_preBytes, 0x20) let end := add(mc, length) for { let cc := add(_postBytes, 0x20) // the next line is the loop condition: // while(uint256(mc < end) + cb == 2) } eq(add(lt(mc, end), cb), 2) { mc := add(mc, 0x20) cc := add(cc, 0x20) } { // if any of these checks fails then arrays are not equal if iszero(eq(mload(mc), mload(cc))) { // unsuccess: success := 0 cb := 0 } } } default { // unsuccess: success := 0 } } return success; } function equal_nonAligned(bytes memory _preBytes, bytes memory _postBytes) internal pure returns (bool) { bool success = true; assembly { let length := mload(_preBytes) // if lengths don't match the arrays are not equal switch eq(length, mload(_postBytes)) case 1 { // cb is a circuit breaker in the for loop since there's // no said feature for inline assembly loops // cb = 1 - don't breaker // cb = 0 - break let cb := 1 let endMinusWord := add(_preBytes, length) let mc := add(_preBytes, 0x20) let cc := add(_postBytes, 0x20) for { // the next line is the loop condition: // while(uint256(mc < endWord) + cb == 2) } eq(add(lt(mc, endMinusWord), cb), 2) { mc := add(mc, 0x20) cc := add(cc, 0x20) } { // if any of these checks fails then arrays are not equal if iszero(eq(mload(mc), mload(cc))) { // unsuccess: success := 0 cb := 0 } } // Only if still successful // For <1 word tail bytes if gt(success, 0) { // Get the remainder of length/32 // length % 32 = AND(length, 32 - 1) let numTailBytes := and(length, 0x1f) let mcRem := mload(mc) let ccRem := mload(cc) for { let i := 0 // the next line is the loop condition: // while(uint256(i < numTailBytes) + cb == 2) } eq(add(lt(i, numTailBytes), cb), 2) { i := add(i, 1) } { if iszero(eq(byte(i, mcRem), byte(i, ccRem))) { // unsuccess: success := 0 cb := 0 } } } } default { // unsuccess: success := 0 } } return success; } function equalStorage( bytes storage _preBytes, bytes memory _postBytes ) internal view returns (bool) { bool success = true; assembly { // we know _preBytes_offset is 0 let fslot := sload(_preBytes.slot) // Decode the length of the stored array like in concatStorage(). let slength := div(and(fslot, sub(mul(0x100, iszero(and(fslot, 1))), 1)), 2) let mlength := mload(_postBytes) // if lengths don't match the arrays are not equal switch eq(slength, mlength) case 1 { // slength can contain both the length and contents of the array // if length < 32 bytes so let's prepare for that // v. http://solidity.readthedocs.io/en/latest/miscellaneous.html#layout-of-state-variables-in-storage if iszero(iszero(slength)) { switch lt(slength, 32) case 1 { // blank the last byte which is the length fslot := mul(div(fslot, 0x100), 0x100) if iszero(eq(fslot, mload(add(_postBytes, 0x20)))) { // unsuccess: success := 0 } } default { // cb is a circuit breaker in the for loop since there's // no said feature for inline assembly loops // cb = 1 - don't breaker // cb = 0 - break let cb := 1 // get the keccak hash to get the contents of the array mstore(0x0, _preBytes.slot) let sc := keccak256(0x0, 0x20) let mc := add(_postBytes, 0x20) let end := add(mc, mlength) // the next line is the loop condition: // while(uint256(mc < end) + cb == 2) for {} eq(add(lt(mc, end), cb), 2) { sc := add(sc, 1) mc := add(mc, 0x20) } { if iszero(eq(sload(sc), mload(mc))) { // unsuccess: success := 0 cb := 0 } } } } } default { // unsuccess: success := 0 } } return success; } }
{ "optimizer": { "enabled": true, "runs": 200 }, "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "devdoc", "userdoc", "metadata", "abi" ] } }, "evmVersion": "paris", "metadata": { "useLiteralContent": true }, "libraries": {} }
Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
[{"inputs":[{"internalType":"contract IRegistryV1","name":"_registry","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"uint16","name":"optionType","type":"uint16"}],"name":"InvalidOptionType","type":"error"},{"inputs":[{"internalType":"uint8","name":"bits","type":"uint8"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"SafeCastOverflowedUintDowncast","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"chip","type":"address"},{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"ChipOutFeeSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":true,"internalType":"address","name":"chip","type":"address"},{"indexed":true,"internalType":"address","name":"holder","type":"address"},{"indexed":false,"internalType":"enum ChipsIntentsVerifierV1.ChipsIntentsVerifierActions","name":"action","type":"uint8"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"ChipsIntentVerified","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint256","name":"chainId","type":"uint256"},{"indexed":false,"internalType":"bytes32","name":"domainSeparator","type":"bytes32"}],"name":"DomainSeparatorForChainStored","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"receiver","type":"address"}],"name":"FeesReceiverSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"chip","type":"address"},{"indexed":true,"internalType":"address","name":"holder","type":"address"},{"indexed":false,"internalType":"enum ChipsIntentsVerifierV1.ChipsIntentsVerifierActions","name":"action","type":"uint8"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"ForceChipOut","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"chip","type":"address"},{"indexed":true,"internalType":"address","name":"holder","type":"address"},{"indexed":true,"internalType":"address","name":"permissionedAccount","type":"address"},{"indexed":false,"internalType":"enum ChipsIntentsVerifierV1.ChipsIntentsVerifierActions","name":"action","type":"uint8"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"InteractedOnBehalf","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"uint16","name":"evmId","type":"uint16"},{"indexed":true,"internalType":"uint16","name":"lzEid","type":"uint16"}],"name":"LzEidSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"contract OFT","name":"oftChip","type":"address"},{"indexed":true,"internalType":"contract WrapNativeChipInOutHelper","name":"helper","type":"address"}],"name":"NativeChipInOutHelperSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"oldAdmin","type":"address"},{"indexed":false,"internalType":"address","name":"newAdmin","type":"address"}],"name":"NewAdmin","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"oldPendingAdmin","type":"address"},{"indexed":false,"internalType":"address","name":"newPendingAdmin","type":"address"}],"name":"NewPendingAdmin","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"asset","type":"address"},{"indexed":true,"internalType":"uint256","name":"chainId","type":"uint256"}],"name":"SourceChainIdForAssetStored","type":"event"},{"inputs":[],"name":"CONTRACT_DOMAIN_NAME","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"CONTRACT_DOMAIN_VERSION","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"DYN_ROLE_INTENTS_PERMISSIONS_PREFIX","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"EIP712DOMAIN_TYPEHASH","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"REQUEST_PAYLOAD_CHIP_OUT_LZ_TYPE_DESCRIPTOR","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"REQUEST_PAYLOAD_CHIP_OUT_LZ_UNWRAP_TYPE_DESCRIPTOR","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"_acceptAdmin","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"_msgSender","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"newPendingAdmin","type":"address"}],"name":"_setPendingAdmin","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"admin","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"chipOutFeeForChip","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"asset","type":"address"}],"name":"domainSeparatorForAsset","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"domainSeparatorForChain","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint16","name":"","type":"uint16"}],"name":"evmIdToLzEid","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"feesReceiver","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"chip","type":"address"},{"internalType":"address","name":"holder","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"forceChipOut","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"chip","type":"address"}],"name":"getLZDstChainIdFromChip","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint16","name":"evmChainId","type":"uint16"}],"name":"getLZDstChainIdFromEvmChainId","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"},{"internalType":"uint8","name":"actionType","type":"uint8"}],"name":"getNextValidNonceFor","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"contract OFT","name":"oftChip","type":"address"}],"name":"getWrapNativeChipInOutHelper","outputs":[{"internalType":"contract WrapNativeChipInOutHelper","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"contract OFTChip","name":"","type":"address"}],"name":"intentsPermissions","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"chip","type":"address"},{"internalType":"address","name":"holder","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"name":"interactOnBehalf_chipOut","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"},{"internalType":"uint8","name":"","type":"uint8"}],"name":"nonceMap","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pendingAdmin","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"uint256","name":"nonce","type":"uint256"},{"internalType":"address","name":"chip","type":"address"},{"internalType":"address","name":"holder","type":"address"},{"internalType":"address","name":"receiver","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"internalType":"struct ChipsIntentsVerifierV1.HolderRequestPayload_ChipOutLZ","name":"payload","type":"tuple"},{"internalType":"uint8","name":"v","type":"uint8"},{"internalType":"bytes32","name":"r","type":"bytes32"},{"internalType":"bytes32","name":"s","type":"bytes32"},{"internalType":"bytes32","name":"domainSeparator","type":"bytes32"}],"name":"recoverChipOutLZPayloadSigner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"pure","type":"function"},{"inputs":[{"components":[{"internalType":"uint256","name":"nonce","type":"uint256"},{"internalType":"address","name":"chip","type":"address"},{"internalType":"address","name":"holder","type":"address"},{"internalType":"address","name":"receiver","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"internalType":"struct ChipsIntentsVerifierV1.HolderRequestPayload_ChipOutLZ_Unwrap","name":"payload","type":"tuple"},{"internalType":"uint8","name":"v","type":"uint8"},{"internalType":"bytes32","name":"r","type":"bytes32"},{"internalType":"bytes32","name":"s","type":"bytes32"},{"internalType":"bytes32","name":"domainSeparator","type":"bytes32"}],"name":"recoverChipOutLZUnwrapPayloadSigner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"registry","outputs":[{"internalType":"contract IRegistryV1","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"chip","type":"address"},{"internalType":"uint256","name":"fee","type":"uint256"}],"name":"setChipOutFee","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"setFeesReceiver","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"contract OFTChip","name":"oftChip","type":"address"},{"internalType":"string","name":"dynAddressSuffix","type":"string"}],"name":"setIntentsPermissions","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint16","name":"evmId","type":"uint16"},{"internalType":"uint16","name":"lzEid","type":"uint16"}],"name":"setLzEndpointId","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"contract OFT","name":"oftChip","type":"address"},{"internalType":"contract WrapNativeChipInOutHelper","name":"_wrapNativeChipInOutHelper","type":"address"}],"name":"setWrapNativeChipInOutHelper","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"sourceChainIdForAsset","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"asset","type":"address"},{"internalType":"uint256","name":"chainId","type":"uint256"}],"name":"storeSourceChainForAsset","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint256","name":"nonce","type":"uint256"},{"internalType":"address","name":"chip","type":"address"},{"internalType":"address","name":"holder","type":"address"},{"internalType":"address","name":"receiver","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"internalType":"struct ChipsIntentsVerifierV1.HolderRequestPayload_ChipOutLZ","name":"payload","type":"tuple"},{"internalType":"uint8","name":"v","type":"uint8"},{"internalType":"bytes32","name":"r","type":"bytes32"},{"internalType":"bytes32","name":"s","type":"bytes32"}],"name":"verifyIntent_chipOut","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"components":[{"internalType":"uint256","name":"nonce","type":"uint256"},{"internalType":"address","name":"chip","type":"address"},{"internalType":"address","name":"holder","type":"address"},{"internalType":"address","name":"receiver","type":"address"},{"internalType":"uint256","name":"amount","type":"uint256"}],"internalType":"struct ChipsIntentsVerifierV1.HolderRequestPayload_ChipOutLZ_Unwrap","name":"payload","type":"tuple"},{"internalType":"uint8","name":"v","type":"uint8"},{"internalType":"bytes32","name":"r","type":"bytes32"},{"internalType":"bytes32","name":"s","type":"bytes32"}],"name":"verifyIntent_chipOutAndUnwrap","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"contract OFT","name":"","type":"address"}],"name":"wrapNativeChipInOutHelpers","outputs":[{"internalType":"contract WrapNativeChipInOutHelper","name":"","type":"address"}],"stateMutability":"view","type":"function"}]
Contract Creation Code
60a06040523480156200001157600080fd5b50604051620033d1380380620033d1833981016040819052620000349162000115565b604080518082018252601681527f436869707320496e74656e747320566572696669657200000000000000000000602080830191909152825180840190935260018352603160f81b90830152600080546001600160a01b031916331790559081816002620000a38382620001ee565b506003620000b28282620001ee565b5050506001600160a01b03831691506200010390505760405162461bcd60e51b815260206004820152600c60248201526b57524f4e475f504152414d5360a01b604482015260640160405180910390fd5b6001600160a01b0316608052620002ba565b6000602082840312156200012857600080fd5b81516001600160a01b03811681146200014057600080fd5b9392505050565b634e487b7160e01b600052604160045260246000fd5b600181811c908216806200017257607f821691505b6020821081036200019357634e487b7160e01b600052602260045260246000fd5b50919050565b601f821115620001e9576000816000526020600020601f850160051c81016020861015620001c45750805b601f850160051c820191505b81811015620001e557828155600101620001d0565b5050505b505050565b81516001600160401b038111156200020a576200020a62000147565b62000222816200021b84546200015d565b8462000199565b602080601f8311600181146200025a5760008415620002415750858301515b600019600386901b1c1916600185901b178555620001e5565b600085815260208120601f198616915b828110156200028b578886015182559484019460019091019084016200026a565b5085821015620002aa5787850151600019600388901b60f8161c191681555b5050505050600190811b01905550565b6080516130f4620002dd6000396000818161050b0152611ac501526130f46000f3fe60806040526004361061021a5760003560e01c80636fccbffc11610123578063b71d1a0c116100ab578063d81587101161006f578063d8158710146106e9578063e9c714f214610731578063f18e795114610746578063f851a44014610766578063ffac4cc81461078657600080fd5b8063b71d1a0c14610635578063bca93cf514610655578063c19152f614610675578063c3055dfc14610695578063c49f91d3146106b557600080fd5b80639d443327116100f25780639d4433271461057b578063a009439c1461059b578063a823b849146105ae578063b589f944146105e4578063b647960e1461061557600080fd5b80636fccbffc146104cc5780637b103999146104f9578063825b392c1461052d5780639652a4bd1461056657600080fd5b806326782247116101a657806358659d6e1161017557806358659d6e1461044f5780635ac928b31461046f578063646208ff1461048257806367329134146104a25780636d156be4146104b757600080fd5b806326782247146103cf5780632f56a071146103ef578063494b6fc61461041c57806352b4aef31461043c57600080fd5b8063123ae93f116101ed578063123ae93f146102ec57806312d99fd11461031f57806313b15f171461034157806316e27a7c146103545780631f470ad31461039757600080fd5b80630da7fba91461021f5780630f2a3d471461024a578063108c66e314610285578063119df25f146102c5575b600080fd5b34801561022b57600080fd5b506102346107a6565b604051610241919061273d565b60405180910390f35b34801561025657600080fd5b50610277610265366004612768565b60066020526000908152604090205481565b604051908152602001610241565b34801561029157600080fd5b5061023460405180604001604052806014815260200173494e54454e54535f5045524d495353494f4e535f60601b81525081565b3480156102d157600080fd5b50335b6040516001600160a01b039091168152602001610241565b3480156102f857600080fd5b5061030c61030736600461279c565b610834565b60405161ffff9091168152602001610241565b34801561032b57600080fd5b5061033f61033a3660046127b7565b610853565b005b61033f61034f366004612806565b610894565b34801561036057600080fd5b5061027761036f366004612768565b6001600160a01b03166000908152600660209081526040808320548352600490915290205490565b3480156103a357600080fd5b506102776103b236600461284a565b600760209081526000928352604080842090915290825290205481565b3480156103db57600080fd5b506001546102d4906001600160a01b031681565b3480156103fb57600080fd5b5061027761040a366004612768565b60096020526000908152604090205481565b34801561042857600080fd5b5061033f61043736600461287f565b610ad7565b61033f61044a366004612806565b610b58565b34801561045b57600080fd5b5061033f61046a3660046128b8565b610ffa565b61033f61047d36600461293d565b61104d565b34801561048e57600080fd5b506102d461049d36600461297e565b61112f565b3480156104ae57600080fd5b506102346111e6565b3480156104c357600080fd5b50610234611202565b3480156104d857600080fd5b506102776104e73660046129ce565b60046020526000908152604090205481565b34801561050557600080fd5b506102d47f000000000000000000000000000000000000000000000000000000000000000081565b34801561053957600080fd5b506102d4610548366004612768565b6001600160a01b039081166000908152600b60205260409020541690565b34801561057257600080fd5b5061023461121e565b34801561058757600080fd5b50610234610596366004612768565b61122b565b61033f6105a936600461293d565b611244565b3480156105ba57600080fd5b506102d46105c9366004612768565b600b602052600090815260409020546001600160a01b031681565b3480156105f057600080fd5b5061030c6105ff36600461279c565b600a6020526000908152604090205461ffff1681565b34801561062157600080fd5b5061033f6106303660046129e7565b611396565b34801561064157600080fd5b5061033f610650366004612768565b6114de565b34801561066157600080fd5b506008546102d4906001600160a01b031681565b34801561068157600080fd5b5061033f6106903660046127b7565b611586565b3480156106a157600080fd5b506102d46106b036600461297e565b611609565b3480156106c157600080fd5b506102777f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f81565b3480156106f557600080fd5b5061027761070436600461284a565b6001600160a01b038216600090815260076020908152604080832060ff8516845290915290205492915050565b34801561073d57600080fd5b5061033f611624565b34801561075257600080fd5b5061033f610761366004612768565b611742565b34801561077257600080fd5b506000546102d4906001600160a01b031681565b34801561079257600080fd5b5061030c6107a1366004612768565b6117b6565b600280546107b390612a11565b80601f01602080910402602001604051908101604052809291908181526020018280546107df90612a11565b801561082c5780601f106108015761010080835404028352916020019161082c565b820191906000526020600020905b81548152906001019060200180831161080f57829003601f168201915b505050505081565b61ffff8082166000908152600a60205260408120549091165b92915050565b6000546001600160a01b031633146108865760405162461bcd60e51b815260040161087d90612a45565b60405180910390fd5b610890828261183c565b5050565b6000806108af6108aa6040880160208901612768565b611941565b9150915060006108c28787878787611609565b90506108d46060880160408901612768565b6001600160a01b0316816001600160a01b0316148061091757506109176109016040890160208a01612768565b61091160608a0160408b01612768565b83611a08565b6109575760405162461bcd60e51b81526020600482015260116024820152702427a62222a92fa727aa2fa9a4a3a722a960791b604482015260640161087d565b6109676060880160408901612768565b6001600160a01b03166109806080890160608a01612768565b6001600160a01b0316146109cc5760405162461bcd60e51b81526020600482015260136024820152722427a62222a92fa727aa2fa922a1a2a4ab22a960691b604482015260640161087d565b60008760800135116109f05760405162461bcd60e51b815260040161087d90612a69565b610a0c610a036060890160408a01612768565b60018935611c34565b600080610a4f610a2260408b0160208c01612768565b610a3260608c0160408d01612768565b610a4260808d0160608e01612768565b8c60800135886000611cd9565b9092509050610a6460608a0160408b01612768565b6001600160a01b0316610a7d60408b0160208c01612768565b6001600160a01b0316336001600160a01b03167f1079ee01d7b99d196004497f2f8f836ba16c547520f3d51d2abdfda2d8e9189c60018686604051610ac493929190612aa4565b60405180910390a4505050505050505050565b6000546001600160a01b03163314610b015760405162461bcd60e51b815260040161087d90612a45565b6001600160a01b038281166000818152600b602052604080822080546001600160a01b0319169486169485179055517f4c81ed7d2492f22714ae0835937bbf99257d379cfb6a220bb66551c3f011d24d9190a35050565b600080610b6e6108aa6040880160208901612768565b915091506000610b81878787878761112f565b9050610b936060880160408901612768565b6001600160a01b0316816001600160a01b03161480610bc05750610bc06109016040890160208a01612768565b610c005760405162461bcd60e51b81526020600482015260116024820152702427a62222a92fa727aa2fa9a4a3a722a960791b604482015260640161087d565b610c106060880160408901612768565b6001600160a01b0316610c296080890160608a01612768565b6001600160a01b031614610c755760405162461bcd60e51b81526020600482015260136024820152722427a62222a92fa727aa2fa922a1a2a4ab22a960691b604482015260640161087d565b6000876080013511610c995760405162461bcd60e51b815260040161087d90612a69565b6000600b81610cae60408b0160208c01612768565b6001600160a01b03908116825260208201929092526040016000205416905080610d245760405162461bcd60e51b815260206004820152602160248201527f4e4f5f575241505f4e41544956455f434849505f494e5f4f55545f48454c50456044820152602960f91b606482015260840161087d565b610d40610d3760608a0160408b01612768565b60028a35611c34565b600080610d72610d5660408c0160208d01612768565b610d6660608d0160408e01612768565b8c608001356000611e4c565b915091506000610d958661ffff9081166000908152600a60205260409020541690565b90508061ffff16600003610dde5760405162461bcd60e51b815260206004820152601060248201526f2727afa2a4a22fa327a92fa1a420a4a760811b604482015260640161087d565b6000610e2860006175306000610e2062030d406000610e1960408051600360f01b602082015281516002818303018152602290910190915290565b9190611fc8565b929190612026565b905060006040518060e001604052808461ffff1663ffffffff168152602001610e57886001600160a01b031690565b81526020018681526020018681526020018381526020018e6060016020810190610e819190612768565b604080516001600160a01b0390921660208301520160408051808303601f19018152918152908252805160008082526020828101909352919092019190508152509050600060405180604001604052803481526020016000815250905060003390508e6020016020810190610ef69190612768565b6001600160a01b031663c7c7f5b3348585856040518563ffffffff1660e01b8152600401610f2693929190612ae2565b60c06040518083038185885af1158015610f44573d6000803e3d6000fd5b50505050506040513d601f19601f82011682018060405250810190610f699190612bed565b50508e6040016020810190610f7e9190612768565b6001600160a01b03168f6020016020810190610f9a9190612768565b6001600160a01b0316336001600160a01b03167f1079ee01d7b99d196004497f2f8f836ba16c547520f3d51d2abdfda2d8e9189c60028b8b604051610fe193929190612aa4565b60405180910390a4505050505050505050505050505050565b6000546001600160a01b031633146110245760405162461bcd60e51b815260040161087d90612a45565b6001600160a01b0383166000908152600560205260409020611047828483612cc8565b50505050565b60008061105985611941565b90925090503361106a868683611a08565b6110a65760405162461bcd60e51b815260206004820152600d60248201526c2727afa822a926a4a9a9a4a7a760991b604482015260640161087d565b600084116110c65760405162461bcd60e51b815260040161087d90612a69565b846000806110d98984808a896001611cd9565b91509150836001600160a01b0316886001600160a01b03168a6001600160a01b03167fdd66fa3092ffc9b32be410c8d63671a98139d1b96d77421ed46bc7ee8db2977f60018686604051610ac493929190612aa4565b6000808261114a611145368a90038a018a612e12565b612070565b60405161190160f01b60208201526022810192909252604282015260620160408051601f1981840301815282825280516020918201206000845290830180835281905260ff8916918301919091526060820187905260808201869052915060019060a0016020604051602081039080840390855afa1580156111d0573d6000803e3d6000fd5b5050604051601f19015198975050505050505050565b6040518060a001604052806070815260200161304f6070913981565b6040518060a0016040528060698152602001612fe66069913981565b600380546107b390612a11565b600560205260009081526040902080546107b390612a11565b6000546001600160a01b0316331461126e5760405162461bcd60e51b815260040161087d90612a45565b6001600160a01b0382166112b45760405162461bcd60e51b815260206004820152600d60248201526c52454345495645525f5a45524f60981b604482015260640161087d565b600081116112d45760405162461bcd60e51b815260040161087d90612a69565b813b156113185760405162461bcd60e51b81526020600482015260126024820152711213d311115497d254d7d0d3d395149050d560721b604482015260640161087d565b600061132384611941565b9150839050600080611339878480888886611cd9565b91509150856001600160a01b0316876001600160a01b03167f88423b880e70edc710bff66a14f9ba383845bf3a03990885371c3b5bcbcf34bb6001858560405161138593929190612aa4565b60405180910390a350505050505050565b6000546001600160a01b031633146113c05760405162461bcd60e51b815260040161087d90612a45565b8161ffff166000036114005760405162461bcd60e51b81526020600482015260096024820152681393d7d1559357d25160ba1b604482015260640161087d565b8061ffff166000036114405760405162461bcd60e51b81526020600482015260096024820152681393d7d31697d1525160ba1b604482015260640161087d565b61ffff8083166000908152600a602052604090205416156114915760405162461bcd60e51b815260206004820152600b60248201526a1053149150511657d4d15560aa1b604482015260640161087d565b61ffff8281166000818152600a6020526040808220805461ffff19169486169485179055517f93e63cb13e93e813c5c78bc35ce8bf5ef30c53cde64cb032c03dea5dcc01fefa9190a35050565b6000546001600160a01b031633146115245760405162461bcd60e51b81526020600482015260096024820152682737ba1020b236b4b760b91b604482015260640161087d565b600180546001600160a01b038381166001600160a01b031983168117909355604080519190921680825260208201939093527fca4f2f25d0898edd99413412fb94012f9e54ec8142f9b093e7720646a95b16a991015b60405180910390a15050565b6000546001600160a01b031633146115b05760405162461bcd60e51b815260040161087d90612a45565b6001600160a01b03821660008181526009602052604090819020839055517f6de5833edd8cadb348e5c7f672228839b7b5be533a4ac9635d26fe6c933b94bc906115fd9084815260200190565b60405180910390a25050565b6000808261114a61161f368a90038a018a612e12565b6120fc565b6001546001600160a01b03163314801561164857506001546001600160a01b031615155b6116945760405162461bcd60e51b815260206004820152601e60248201527f4e6f7420746865204558495354494e472070656e64696e672061646d696e0000604482015260640161087d565b60008054600180546001600160a01b038082166001600160a01b031980861682179096559490911690915560408051919092168082526020820184905292917ff9ffabca9c8276e99321725bcb43fb076a6c66a54b7f21c4e8146d8519b417dc910160405180910390a1600154604080516001600160a01b03808516825290921660208301527fca4f2f25d0898edd99413412fb94012f9e54ec8142f9b093e7720646a95b16a9910161157a565b6000546001600160a01b0316331461176c5760405162461bcd60e51b815260040161087d90612a45565b600880546001600160a01b0319166001600160a01b0383169081179091556040517ffd2d86a41f334e70107fa88620f07ffb476a68c8cc6a5106a93dd39e0e216d6f90600090a250565b6001600160a01b03811660009081526006602052604081205480820361181e5760405162461bcd60e51b815260206004820152601860248201527f4e4f5f534f555243455f434841494e5f464f525f434849500000000000000000604482015260640161087d565b61ffff8082166000908152600a6020526040902054165b9392505050565b6001600160a01b038216600090815260066020526040902054156118b05760405162461bcd60e51b815260206004820152602560248201527f434841494e5f49445f464f525f41535345545f414c52454144595f434f4e464960448201526411d554915160da1b606482015260840161087d565b806000036118f05760405162461bcd60e51b815260206004820152600d60248201526c434841494e5f49445f5a45524f60981b604482015260640161087d565b6118f98161216f565b506001600160a01b038216600081815260066020526040808220849055518392917f8983e01eaf5771a114f1aa7f72a023a35642e048180682aa2fb04db0cbd220c291a35050565b6001600160a01b03811660009081526006602052604081205481908082036119a35760405162461bcd60e51b81526020600482015260156024820152741393d7d0d210525397d25117d193d497d054d4d155605a1b604482015260640161087d565b600081815260046020526040902054806119ff5760405162461bcd60e51b815260206004820152601d60248201527f4e4f5f444f4d41494e5f534550415241544f525f464f525f434841494e000000604482015260640161087d565b94909350915050565b6001600160a01b03831660009081526005602052604081208054829190611a2e90612a11565b80601f0160208091040260200160405190810160405280929190818152602001828054611a5a90612a11565b8015611aa75780601f10611a7c57610100808354040283529160200191611aa7565b820191906000526020600020905b815481529060010190602001808311611a8a57829003601f168201915b505050505090508051600003611ac1576000915050611835565b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166358ca59ce60405180604001604052806014815260200173494e54454e54535f5045524d495353494f4e535f60601b81525084604051602001611b31929190612e2e565b6040516020818303038152906040526040518263ffffffff1660e01b8152600401611b5c919061273d565b602060405180830381865afa158015611b79573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611b9d9190612e5d565b90506001600160a01b038116611bb857600092505050611835565b60405163b0cbc2e160e01b81526001600160a01b0382169063b0cbc2e190611be99060039089908990600401612e7a565b602060405180830381865afa158015611c06573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611c2a9190612eac565b9695505050505050565b6001600160a01b038316600090815260076020908152604080832060ff86168452909152902054818114611c9c5760405162461bcd60e51b815260206004820152600f60248201526e494e434f52524543545f4e4f4e434560881b604482015260640161087d565b611ca7816001612ee4565b6001600160a01b03909416600090815260076020908152604080832060ff909616835294905292909220929092555050565b600080611ce888888786611e4c565b90925090506000611d0c8561ffff9081166000908152600a60205260409020541690565b90508061ffff16600003611d555760405162461bcd60e51b815260206004820152601060248201526f2727afa2a4a22fa327a92fa1a420a4a760811b604482015260640161087d565b606060006040518060e001604052808461ffff1663ffffffff168152602001611d848b6001600160a01b031690565b8152602001868152602001868152602001838152602001838152602001838152509050600060405180604001604052803481526020016000815250905060003390508c6001600160a01b031663c7c7f5b3348585856040518563ffffffff1660e01b8152600401611df793929190612ae2565b60c06040518083038185885af1158015611e15573d6000803e3d6000fd5b50505050506040513d601f19601f82011682018060405250810190611e3a9190612bed565b50505050505050965096945050505050565b6001600160a01b03841660009081526009602052604081205480611ea35760405162461bcd60e51b815260206004820152600e60248201526d1393d7d1915157d111519253915160921b604482015260640161087d565b600019811480611eb05750825b15611eb9575060005b808411611f085760405162461bcd60e51b815260206004820152601860248201527f414d4f554e545f4c4553535f4f525f455155414c5f4645450000000000000000604482015260640161087d565b611f13868686612328565b611f1d86826123ad565b6000866001600160a01b031663963efcaa6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611f5d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611f819190612ef7565b90506000611f8f8387612f10565b9050611f9b8183612404565b93506000611fa98583612f10565b90508015611fbc57611fbc89898361241b565b50505094509492505050565b6060836003611fd8826000612456565b61ffff161461200c57611fec816000612456565b604051633a51740d60e01b815261ffff909116600482015260240161087d565b600061201885856124b3565b9050611c2a8660018361252c565b6060846003612036826000612456565b61ffff161461204a57611fec816000612456565b6000612057868686612597565b90506120658760038361252c565b979650505050505050565b60006040518060a001604052806070815260200161304f6070913980516020918201208351848301516040808701516060808901516080808b01518551998a0198909852938801959095526001600160a01b03938416908701528216908501521660a083015260c082015260e0015b604051602081830303815290604052805190602001209050919050565b60006040518060a0016040528060698152602001612fe66069913980516020918201208351848301516040808701516060808901516080808b01518551998a0198909852938801959095526001600160a01b03938416908701528216908501521660a083015260c082015260e0016120df565b6000818152600460205260408120548061084d5760006122cb6040518060800160405280600280546121a090612a11565b80601f01602080910402602001604051908101604052809291908181526020018280546121cc90612a11565b80156122195780601f106121ee57610100808354040283529160200191612219565b820191906000526020600020905b8154815290600101906020018083116121fc57829003601f168201915b505050505081526020016003805461223090612a11565b80601f016020809104026020016040519081016040528092919081815260200182805461225c90612a11565b80156122a95780601f1061227e576101008083540402835291602001916122a9565b820191906000526020600020905b81548152906001019060200180831161228c57829003601f168201915b50505050508152602001868152602001306001600160a01b031681525061263a565b600085815260046020526040908190208290555190915084907f04df087044a5490c34ea0092af5dbdd1a3a35fefd63f0864c1d05dba3075f165906123139084815260200190565b60405180910390a29392505050565b50919050565b80156123a8576040516323b872dd60e01b81526001600160a01b038381166004830152306024830152604482018390528416906323b872dd906064015b6020604051808303816000875af1158015612384573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906110479190612eac565b505050565b6008546001600160a01b0316806123f95760405162461bcd60e51b815260206004820152601060248201526f2727afa322a2a9afa922a1a2a4ab22a960811b604482015260640161087d565b6123a883828461241b565b6000816124118185612f23565b6118359190612f45565b80156123a85760405163a9059cbb60e01b81526001600160a01b0383811660048301526024820183905284169063a9059cbb90604401612365565b6000612463826002612ee4565b835110156124aa5760405162461bcd60e51b8152602060048201526014602482015273746f55696e7431365f6f75744f66426f756e647360601b604482015260640161087d565b50016002015190565b60606001600160801b038216156124fb57604080516001600160801b0319608086811b8216602084015285901b16603082015201604051602081830303815290604052611835565b6040516001600160801b0319608085901b166020820152603001604051602081830303815290604052905092915050565b606083600361253c826000612456565b61ffff161461255057611fec816000612456565b84600161255d85516126ba565b612568906001612f5c565b868660405160200161257e959493929190612f7e565b6040516020818303038152906040529150509392505050565b60606001600160801b038216156125f4576040516001600160f01b031960f086901b1660208201526001600160801b0319608085811b8216602284015284901b166032820152604201604051602081830303815290604052612632565b6040516001600160f01b031960f086901b1660208201526001600160801b0319608085901b1660228201526032016040516020818303038152906040525b949350505050565b60007f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f826000015180519060200120836020015180519060200120846040015185606001516040516020016120df9594939291909485526020850193909352604084019190915260608301526001600160a01b0316608082015260a00190565b600061ffff8211156126e9576040516306dfcc6560e41b8152601060048201526024810183905260440161087d565b5090565b60005b838110156127085781810151838201526020016126f0565b50506000910152565b600081518084526127298160208601602086016126ed565b601f01601f19169290920160200192915050565b6020815260006118356020830184612711565b6001600160a01b038116811461276557600080fd5b50565b60006020828403121561277a57600080fd5b813561183581612750565b803561ffff8116811461279757600080fd5b919050565b6000602082840312156127ae57600080fd5b61183582612785565b600080604083850312156127ca57600080fd5b82356127d581612750565b946020939093013593505050565b600060a0828403121561232257600080fd5b803560ff8116811461279757600080fd5b600080600080610100858703121561281d57600080fd5b61282786866127e3565b935061283560a086016127f5565b939693955050505060c08201359160e0013590565b6000806040838503121561285d57600080fd5b823561286881612750565b9150612876602084016127f5565b90509250929050565b6000806040838503121561289257600080fd5b823561289d81612750565b915060208301356128ad81612750565b809150509250929050565b6000806000604084860312156128cd57600080fd5b83356128d881612750565b9250602084013567ffffffffffffffff808211156128f557600080fd5b818601915086601f83011261290957600080fd5b81358181111561291857600080fd5b87602082850101111561292a57600080fd5b6020830194508093505050509250925092565b60008060006060848603121561295257600080fd5b833561295d81612750565b9250602084013561296d81612750565b929592945050506040919091013590565b6000806000806000610120868803121561299757600080fd5b6129a187876127e3565b94506129af60a087016127f5565b949794965050505060c08301359260e081013592610100909101359150565b6000602082840312156129e057600080fd5b5035919050565b600080604083850312156129fa57600080fd5b612a0383612785565b915061287660208401612785565b600181811c90821680612a2557607f821691505b60208210810361232257634e487b7160e01b600052602260045260246000fd5b6020808252600a908201526927a7262cafa0a226a4a760b11b604082015260600190565b6020808252600b908201526a414d4f554e545f5a45524f60a81b604082015260600190565b634e487b7160e01b600052602160045260246000fd5b6060810160038510612ab857612ab8612a8e565b938152602081019290925260409091015290565b634e487b7160e01b600052604160045260246000fd5b6080815263ffffffff8451166080820152602084015160a0820152604084015160c0820152606084015160e08201526000608085015160e0610100840152612b2e610160840182612711565b905060a0860151607f198085840301610120860152612b4d8383612711565b925060c08801519150808584030161014086015250612b6c8282612711565b92505050612b87602083018580518252602090810151910152565b6001600160a01b0383166060830152949350505050565b600060408284031215612bb057600080fd5b6040516040810181811067ffffffffffffffff82111715612bd357612bd3612acc565b604052825181526020928301519281019290925250919050565b60008082840360c0811215612c0157600080fd5b6080811215612c0f57600080fd5b506040516060810167ffffffffffffffff8282108183111715612c3457612c34612acc565b8160405285518352602086015191508082168214612c5157600080fd5b506020820152612c648560408601612b9e565b604082015291506128768460808501612b9e565b601f8211156123a8576000816000526020600020601f850160051c81016020861015612ca15750805b601f850160051c820191505b81811015612cc057828155600101612cad565b505050505050565b67ffffffffffffffff831115612ce057612ce0612acc565b612cf483612cee8354612a11565b83612c78565b6000601f841160018114612d285760008515612d105750838201355b600019600387901b1c1916600186901b178355612d82565b600083815260209020601f19861690835b82811015612d595786850135825560209485019460019092019101612d39565b5086821015612d765760001960f88860031b161c19848701351681555b505060018560011b0183555b5050505050565b600060a08284031215612d9b57600080fd5b60405160a0810181811067ffffffffffffffff82111715612dbe57612dbe612acc565b604052823581529050806020830135612dd681612750565b60208201526040830135612de981612750565b60408201526060830135612dfc81612750565b6060820152608092830135920191909152919050565b600060a08284031215612e2457600080fd5b6118358383612d89565b60008351612e408184602088016126ed565b835190830190612e548183602088016126ed565b01949350505050565b600060208284031215612e6f57600080fd5b815161183581612750565b6060810160048510612e8e57612e8e612a8e565b9381526001600160a01b039283166020820152911660409091015290565b600060208284031215612ebe57600080fd5b8151801515811461183557600080fd5b634e487b7160e01b600052601160045260246000fd5b8082018082111561084d5761084d612ece565b600060208284031215612f0957600080fd5b5051919050565b8181038181111561084d5761084d612ece565b600082612f4057634e487b7160e01b600052601260045260246000fd5b500490565b808202811582820484141761084d5761084d612ece565b61ffff818116838216019080821115612f7757612f77612ece565b5092915050565b60008651612f90818460208b016126ed565b6001600160f81b031960f888811b82169285019283526001600160f01b031960f089901b16600184015286901b1660038201528351612fd68160048401602088016126ed565b0160040197965050505050505056fe486f6c646572526571756573745061796c6f61645f436869704f75744c5a2875696e74323536206e6f6e63652c6164647265737320636869702c6164647265737320686f6c6465722c616464726573732072656365697665722c75696e7432353620616d6f756e7429486f6c646572526571756573745061796c6f61645f436869704f75744c5a5f556e777261702875696e74323536206e6f6e63652c6164647265737320636869702c6164647265737320686f6c6465722c616464726573732072656365697665722c75696e7432353620616d6f756e7429a264697066735822122012d15e835c304f9f495923d2c18982205a94082feb87d56021a73cc0840a081e64736f6c634300081800330000000000000000000000004cf3d61165a6be8ff741320ad27cab57fae5c207
Deployed Bytecode
0x60806040526004361061021a5760003560e01c80636fccbffc11610123578063b71d1a0c116100ab578063d81587101161006f578063d8158710146106e9578063e9c714f214610731578063f18e795114610746578063f851a44014610766578063ffac4cc81461078657600080fd5b8063b71d1a0c14610635578063bca93cf514610655578063c19152f614610675578063c3055dfc14610695578063c49f91d3146106b557600080fd5b80639d443327116100f25780639d4433271461057b578063a009439c1461059b578063a823b849146105ae578063b589f944146105e4578063b647960e1461061557600080fd5b80636fccbffc146104cc5780637b103999146104f9578063825b392c1461052d5780639652a4bd1461056657600080fd5b806326782247116101a657806358659d6e1161017557806358659d6e1461044f5780635ac928b31461046f578063646208ff1461048257806367329134146104a25780636d156be4146104b757600080fd5b806326782247146103cf5780632f56a071146103ef578063494b6fc61461041c57806352b4aef31461043c57600080fd5b8063123ae93f116101ed578063123ae93f146102ec57806312d99fd11461031f57806313b15f171461034157806316e27a7c146103545780631f470ad31461039757600080fd5b80630da7fba91461021f5780630f2a3d471461024a578063108c66e314610285578063119df25f146102c5575b600080fd5b34801561022b57600080fd5b506102346107a6565b604051610241919061273d565b60405180910390f35b34801561025657600080fd5b50610277610265366004612768565b60066020526000908152604090205481565b604051908152602001610241565b34801561029157600080fd5b5061023460405180604001604052806014815260200173494e54454e54535f5045524d495353494f4e535f60601b81525081565b3480156102d157600080fd5b50335b6040516001600160a01b039091168152602001610241565b3480156102f857600080fd5b5061030c61030736600461279c565b610834565b60405161ffff9091168152602001610241565b34801561032b57600080fd5b5061033f61033a3660046127b7565b610853565b005b61033f61034f366004612806565b610894565b34801561036057600080fd5b5061027761036f366004612768565b6001600160a01b03166000908152600660209081526040808320548352600490915290205490565b3480156103a357600080fd5b506102776103b236600461284a565b600760209081526000928352604080842090915290825290205481565b3480156103db57600080fd5b506001546102d4906001600160a01b031681565b3480156103fb57600080fd5b5061027761040a366004612768565b60096020526000908152604090205481565b34801561042857600080fd5b5061033f61043736600461287f565b610ad7565b61033f61044a366004612806565b610b58565b34801561045b57600080fd5b5061033f61046a3660046128b8565b610ffa565b61033f61047d36600461293d565b61104d565b34801561048e57600080fd5b506102d461049d36600461297e565b61112f565b3480156104ae57600080fd5b506102346111e6565b3480156104c357600080fd5b50610234611202565b3480156104d857600080fd5b506102776104e73660046129ce565b60046020526000908152604090205481565b34801561050557600080fd5b506102d47f0000000000000000000000004cf3d61165a6be8ff741320ad27cab57fae5c20781565b34801561053957600080fd5b506102d4610548366004612768565b6001600160a01b039081166000908152600b60205260409020541690565b34801561057257600080fd5b5061023461121e565b34801561058757600080fd5b50610234610596366004612768565b61122b565b61033f6105a936600461293d565b611244565b3480156105ba57600080fd5b506102d46105c9366004612768565b600b602052600090815260409020546001600160a01b031681565b3480156105f057600080fd5b5061030c6105ff36600461279c565b600a6020526000908152604090205461ffff1681565b34801561062157600080fd5b5061033f6106303660046129e7565b611396565b34801561064157600080fd5b5061033f610650366004612768565b6114de565b34801561066157600080fd5b506008546102d4906001600160a01b031681565b34801561068157600080fd5b5061033f6106903660046127b7565b611586565b3480156106a157600080fd5b506102d46106b036600461297e565b611609565b3480156106c157600080fd5b506102777f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f81565b3480156106f557600080fd5b5061027761070436600461284a565b6001600160a01b038216600090815260076020908152604080832060ff8516845290915290205492915050565b34801561073d57600080fd5b5061033f611624565b34801561075257600080fd5b5061033f610761366004612768565b611742565b34801561077257600080fd5b506000546102d4906001600160a01b031681565b34801561079257600080fd5b5061030c6107a1366004612768565b6117b6565b600280546107b390612a11565b80601f01602080910402602001604051908101604052809291908181526020018280546107df90612a11565b801561082c5780601f106108015761010080835404028352916020019161082c565b820191906000526020600020905b81548152906001019060200180831161080f57829003601f168201915b505050505081565b61ffff8082166000908152600a60205260408120549091165b92915050565b6000546001600160a01b031633146108865760405162461bcd60e51b815260040161087d90612a45565b60405180910390fd5b610890828261183c565b5050565b6000806108af6108aa6040880160208901612768565b611941565b9150915060006108c28787878787611609565b90506108d46060880160408901612768565b6001600160a01b0316816001600160a01b0316148061091757506109176109016040890160208a01612768565b61091160608a0160408b01612768565b83611a08565b6109575760405162461bcd60e51b81526020600482015260116024820152702427a62222a92fa727aa2fa9a4a3a722a960791b604482015260640161087d565b6109676060880160408901612768565b6001600160a01b03166109806080890160608a01612768565b6001600160a01b0316146109cc5760405162461bcd60e51b81526020600482015260136024820152722427a62222a92fa727aa2fa922a1a2a4ab22a960691b604482015260640161087d565b60008760800135116109f05760405162461bcd60e51b815260040161087d90612a69565b610a0c610a036060890160408a01612768565b60018935611c34565b600080610a4f610a2260408b0160208c01612768565b610a3260608c0160408d01612768565b610a4260808d0160608e01612768565b8c60800135886000611cd9565b9092509050610a6460608a0160408b01612768565b6001600160a01b0316610a7d60408b0160208c01612768565b6001600160a01b0316336001600160a01b03167f1079ee01d7b99d196004497f2f8f836ba16c547520f3d51d2abdfda2d8e9189c60018686604051610ac493929190612aa4565b60405180910390a4505050505050505050565b6000546001600160a01b03163314610b015760405162461bcd60e51b815260040161087d90612a45565b6001600160a01b038281166000818152600b602052604080822080546001600160a01b0319169486169485179055517f4c81ed7d2492f22714ae0835937bbf99257d379cfb6a220bb66551c3f011d24d9190a35050565b600080610b6e6108aa6040880160208901612768565b915091506000610b81878787878761112f565b9050610b936060880160408901612768565b6001600160a01b0316816001600160a01b03161480610bc05750610bc06109016040890160208a01612768565b610c005760405162461bcd60e51b81526020600482015260116024820152702427a62222a92fa727aa2fa9a4a3a722a960791b604482015260640161087d565b610c106060880160408901612768565b6001600160a01b0316610c296080890160608a01612768565b6001600160a01b031614610c755760405162461bcd60e51b81526020600482015260136024820152722427a62222a92fa727aa2fa922a1a2a4ab22a960691b604482015260640161087d565b6000876080013511610c995760405162461bcd60e51b815260040161087d90612a69565b6000600b81610cae60408b0160208c01612768565b6001600160a01b03908116825260208201929092526040016000205416905080610d245760405162461bcd60e51b815260206004820152602160248201527f4e4f5f575241505f4e41544956455f434849505f494e5f4f55545f48454c50456044820152602960f91b606482015260840161087d565b610d40610d3760608a0160408b01612768565b60028a35611c34565b600080610d72610d5660408c0160208d01612768565b610d6660608d0160408e01612768565b8c608001356000611e4c565b915091506000610d958661ffff9081166000908152600a60205260409020541690565b90508061ffff16600003610dde5760405162461bcd60e51b815260206004820152601060248201526f2727afa2a4a22fa327a92fa1a420a4a760811b604482015260640161087d565b6000610e2860006175306000610e2062030d406000610e1960408051600360f01b602082015281516002818303018152602290910190915290565b9190611fc8565b929190612026565b905060006040518060e001604052808461ffff1663ffffffff168152602001610e57886001600160a01b031690565b81526020018681526020018681526020018381526020018e6060016020810190610e819190612768565b604080516001600160a01b0390921660208301520160408051808303601f19018152918152908252805160008082526020828101909352919092019190508152509050600060405180604001604052803481526020016000815250905060003390508e6020016020810190610ef69190612768565b6001600160a01b031663c7c7f5b3348585856040518563ffffffff1660e01b8152600401610f2693929190612ae2565b60c06040518083038185885af1158015610f44573d6000803e3d6000fd5b50505050506040513d601f19601f82011682018060405250810190610f699190612bed565b50508e6040016020810190610f7e9190612768565b6001600160a01b03168f6020016020810190610f9a9190612768565b6001600160a01b0316336001600160a01b03167f1079ee01d7b99d196004497f2f8f836ba16c547520f3d51d2abdfda2d8e9189c60028b8b604051610fe193929190612aa4565b60405180910390a4505050505050505050505050505050565b6000546001600160a01b031633146110245760405162461bcd60e51b815260040161087d90612a45565b6001600160a01b0383166000908152600560205260409020611047828483612cc8565b50505050565b60008061105985611941565b90925090503361106a868683611a08565b6110a65760405162461bcd60e51b815260206004820152600d60248201526c2727afa822a926a4a9a9a4a7a760991b604482015260640161087d565b600084116110c65760405162461bcd60e51b815260040161087d90612a69565b846000806110d98984808a896001611cd9565b91509150836001600160a01b0316886001600160a01b03168a6001600160a01b03167fdd66fa3092ffc9b32be410c8d63671a98139d1b96d77421ed46bc7ee8db2977f60018686604051610ac493929190612aa4565b6000808261114a611145368a90038a018a612e12565b612070565b60405161190160f01b60208201526022810192909252604282015260620160408051601f1981840301815282825280516020918201206000845290830180835281905260ff8916918301919091526060820187905260808201869052915060019060a0016020604051602081039080840390855afa1580156111d0573d6000803e3d6000fd5b5050604051601f19015198975050505050505050565b6040518060a001604052806070815260200161304f6070913981565b6040518060a0016040528060698152602001612fe66069913981565b600380546107b390612a11565b600560205260009081526040902080546107b390612a11565b6000546001600160a01b0316331461126e5760405162461bcd60e51b815260040161087d90612a45565b6001600160a01b0382166112b45760405162461bcd60e51b815260206004820152600d60248201526c52454345495645525f5a45524f60981b604482015260640161087d565b600081116112d45760405162461bcd60e51b815260040161087d90612a69565b813b156113185760405162461bcd60e51b81526020600482015260126024820152711213d311115497d254d7d0d3d395149050d560721b604482015260640161087d565b600061132384611941565b9150839050600080611339878480888886611cd9565b91509150856001600160a01b0316876001600160a01b03167f88423b880e70edc710bff66a14f9ba383845bf3a03990885371c3b5bcbcf34bb6001858560405161138593929190612aa4565b60405180910390a350505050505050565b6000546001600160a01b031633146113c05760405162461bcd60e51b815260040161087d90612a45565b8161ffff166000036114005760405162461bcd60e51b81526020600482015260096024820152681393d7d1559357d25160ba1b604482015260640161087d565b8061ffff166000036114405760405162461bcd60e51b81526020600482015260096024820152681393d7d31697d1525160ba1b604482015260640161087d565b61ffff8083166000908152600a602052604090205416156114915760405162461bcd60e51b815260206004820152600b60248201526a1053149150511657d4d15560aa1b604482015260640161087d565b61ffff8281166000818152600a6020526040808220805461ffff19169486169485179055517f93e63cb13e93e813c5c78bc35ce8bf5ef30c53cde64cb032c03dea5dcc01fefa9190a35050565b6000546001600160a01b031633146115245760405162461bcd60e51b81526020600482015260096024820152682737ba1020b236b4b760b91b604482015260640161087d565b600180546001600160a01b038381166001600160a01b031983168117909355604080519190921680825260208201939093527fca4f2f25d0898edd99413412fb94012f9e54ec8142f9b093e7720646a95b16a991015b60405180910390a15050565b6000546001600160a01b031633146115b05760405162461bcd60e51b815260040161087d90612a45565b6001600160a01b03821660008181526009602052604090819020839055517f6de5833edd8cadb348e5c7f672228839b7b5be533a4ac9635d26fe6c933b94bc906115fd9084815260200190565b60405180910390a25050565b6000808261114a61161f368a90038a018a612e12565b6120fc565b6001546001600160a01b03163314801561164857506001546001600160a01b031615155b6116945760405162461bcd60e51b815260206004820152601e60248201527f4e6f7420746865204558495354494e472070656e64696e672061646d696e0000604482015260640161087d565b60008054600180546001600160a01b038082166001600160a01b031980861682179096559490911690915560408051919092168082526020820184905292917ff9ffabca9c8276e99321725bcb43fb076a6c66a54b7f21c4e8146d8519b417dc910160405180910390a1600154604080516001600160a01b03808516825290921660208301527fca4f2f25d0898edd99413412fb94012f9e54ec8142f9b093e7720646a95b16a9910161157a565b6000546001600160a01b0316331461176c5760405162461bcd60e51b815260040161087d90612a45565b600880546001600160a01b0319166001600160a01b0383169081179091556040517ffd2d86a41f334e70107fa88620f07ffb476a68c8cc6a5106a93dd39e0e216d6f90600090a250565b6001600160a01b03811660009081526006602052604081205480820361181e5760405162461bcd60e51b815260206004820152601860248201527f4e4f5f534f555243455f434841494e5f464f525f434849500000000000000000604482015260640161087d565b61ffff8082166000908152600a6020526040902054165b9392505050565b6001600160a01b038216600090815260066020526040902054156118b05760405162461bcd60e51b815260206004820152602560248201527f434841494e5f49445f464f525f41535345545f414c52454144595f434f4e464960448201526411d554915160da1b606482015260840161087d565b806000036118f05760405162461bcd60e51b815260206004820152600d60248201526c434841494e5f49445f5a45524f60981b604482015260640161087d565b6118f98161216f565b506001600160a01b038216600081815260066020526040808220849055518392917f8983e01eaf5771a114f1aa7f72a023a35642e048180682aa2fb04db0cbd220c291a35050565b6001600160a01b03811660009081526006602052604081205481908082036119a35760405162461bcd60e51b81526020600482015260156024820152741393d7d0d210525397d25117d193d497d054d4d155605a1b604482015260640161087d565b600081815260046020526040902054806119ff5760405162461bcd60e51b815260206004820152601d60248201527f4e4f5f444f4d41494e5f534550415241544f525f464f525f434841494e000000604482015260640161087d565b94909350915050565b6001600160a01b03831660009081526005602052604081208054829190611a2e90612a11565b80601f0160208091040260200160405190810160405280929190818152602001828054611a5a90612a11565b8015611aa75780601f10611a7c57610100808354040283529160200191611aa7565b820191906000526020600020905b815481529060010190602001808311611a8a57829003601f168201915b505050505090508051600003611ac1576000915050611835565b60007f0000000000000000000000004cf3d61165a6be8ff741320ad27cab57fae5c2076001600160a01b03166358ca59ce60405180604001604052806014815260200173494e54454e54535f5045524d495353494f4e535f60601b81525084604051602001611b31929190612e2e565b6040516020818303038152906040526040518263ffffffff1660e01b8152600401611b5c919061273d565b602060405180830381865afa158015611b79573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611b9d9190612e5d565b90506001600160a01b038116611bb857600092505050611835565b60405163b0cbc2e160e01b81526001600160a01b0382169063b0cbc2e190611be99060039089908990600401612e7a565b602060405180830381865afa158015611c06573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611c2a9190612eac565b9695505050505050565b6001600160a01b038316600090815260076020908152604080832060ff86168452909152902054818114611c9c5760405162461bcd60e51b815260206004820152600f60248201526e494e434f52524543545f4e4f4e434560881b604482015260640161087d565b611ca7816001612ee4565b6001600160a01b03909416600090815260076020908152604080832060ff909616835294905292909220929092555050565b600080611ce888888786611e4c565b90925090506000611d0c8561ffff9081166000908152600a60205260409020541690565b90508061ffff16600003611d555760405162461bcd60e51b815260206004820152601060248201526f2727afa2a4a22fa327a92fa1a420a4a760811b604482015260640161087d565b606060006040518060e001604052808461ffff1663ffffffff168152602001611d848b6001600160a01b031690565b8152602001868152602001868152602001838152602001838152602001838152509050600060405180604001604052803481526020016000815250905060003390508c6001600160a01b031663c7c7f5b3348585856040518563ffffffff1660e01b8152600401611df793929190612ae2565b60c06040518083038185885af1158015611e15573d6000803e3d6000fd5b50505050506040513d601f19601f82011682018060405250810190611e3a9190612bed565b50505050505050965096945050505050565b6001600160a01b03841660009081526009602052604081205480611ea35760405162461bcd60e51b815260206004820152600e60248201526d1393d7d1915157d111519253915160921b604482015260640161087d565b600019811480611eb05750825b15611eb9575060005b808411611f085760405162461bcd60e51b815260206004820152601860248201527f414d4f554e545f4c4553535f4f525f455155414c5f4645450000000000000000604482015260640161087d565b611f13868686612328565b611f1d86826123ad565b6000866001600160a01b031663963efcaa6040518163ffffffff1660e01b8152600401602060405180830381865afa158015611f5d573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190611f819190612ef7565b90506000611f8f8387612f10565b9050611f9b8183612404565b93506000611fa98583612f10565b90508015611fbc57611fbc89898361241b565b50505094509492505050565b6060836003611fd8826000612456565b61ffff161461200c57611fec816000612456565b604051633a51740d60e01b815261ffff909116600482015260240161087d565b600061201885856124b3565b9050611c2a8660018361252c565b6060846003612036826000612456565b61ffff161461204a57611fec816000612456565b6000612057868686612597565b90506120658760038361252c565b979650505050505050565b60006040518060a001604052806070815260200161304f6070913980516020918201208351848301516040808701516060808901516080808b01518551998a0198909852938801959095526001600160a01b03938416908701528216908501521660a083015260c082015260e0015b604051602081830303815290604052805190602001209050919050565b60006040518060a0016040528060698152602001612fe66069913980516020918201208351848301516040808701516060808901516080808b01518551998a0198909852938801959095526001600160a01b03938416908701528216908501521660a083015260c082015260e0016120df565b6000818152600460205260408120548061084d5760006122cb6040518060800160405280600280546121a090612a11565b80601f01602080910402602001604051908101604052809291908181526020018280546121cc90612a11565b80156122195780601f106121ee57610100808354040283529160200191612219565b820191906000526020600020905b8154815290600101906020018083116121fc57829003601f168201915b505050505081526020016003805461223090612a11565b80601f016020809104026020016040519081016040528092919081815260200182805461225c90612a11565b80156122a95780601f1061227e576101008083540402835291602001916122a9565b820191906000526020600020905b81548152906001019060200180831161228c57829003601f168201915b50505050508152602001868152602001306001600160a01b031681525061263a565b600085815260046020526040908190208290555190915084907f04df087044a5490c34ea0092af5dbdd1a3a35fefd63f0864c1d05dba3075f165906123139084815260200190565b60405180910390a29392505050565b50919050565b80156123a8576040516323b872dd60e01b81526001600160a01b038381166004830152306024830152604482018390528416906323b872dd906064015b6020604051808303816000875af1158015612384573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906110479190612eac565b505050565b6008546001600160a01b0316806123f95760405162461bcd60e51b815260206004820152601060248201526f2727afa322a2a9afa922a1a2a4ab22a960811b604482015260640161087d565b6123a883828461241b565b6000816124118185612f23565b6118359190612f45565b80156123a85760405163a9059cbb60e01b81526001600160a01b0383811660048301526024820183905284169063a9059cbb90604401612365565b6000612463826002612ee4565b835110156124aa5760405162461bcd60e51b8152602060048201526014602482015273746f55696e7431365f6f75744f66426f756e647360601b604482015260640161087d565b50016002015190565b60606001600160801b038216156124fb57604080516001600160801b0319608086811b8216602084015285901b16603082015201604051602081830303815290604052611835565b6040516001600160801b0319608085901b166020820152603001604051602081830303815290604052905092915050565b606083600361253c826000612456565b61ffff161461255057611fec816000612456565b84600161255d85516126ba565b612568906001612f5c565b868660405160200161257e959493929190612f7e565b6040516020818303038152906040529150509392505050565b60606001600160801b038216156125f4576040516001600160f01b031960f086901b1660208201526001600160801b0319608085811b8216602284015284901b166032820152604201604051602081830303815290604052612632565b6040516001600160f01b031960f086901b1660208201526001600160801b0319608085901b1660228201526032016040516020818303038152906040525b949350505050565b60007f8b73c3c69bb8fe3d512ecc4cf759cc79239f7b179b0ffacaa9a75d522b39400f826000015180519060200120836020015180519060200120846040015185606001516040516020016120df9594939291909485526020850193909352604084019190915260608301526001600160a01b0316608082015260a00190565b600061ffff8211156126e9576040516306dfcc6560e41b8152601060048201526024810183905260440161087d565b5090565b60005b838110156127085781810151838201526020016126f0565b50506000910152565b600081518084526127298160208601602086016126ed565b601f01601f19169290920160200192915050565b6020815260006118356020830184612711565b6001600160a01b038116811461276557600080fd5b50565b60006020828403121561277a57600080fd5b813561183581612750565b803561ffff8116811461279757600080fd5b919050565b6000602082840312156127ae57600080fd5b61183582612785565b600080604083850312156127ca57600080fd5b82356127d581612750565b946020939093013593505050565b600060a0828403121561232257600080fd5b803560ff8116811461279757600080fd5b600080600080610100858703121561281d57600080fd5b61282786866127e3565b935061283560a086016127f5565b939693955050505060c08201359160e0013590565b6000806040838503121561285d57600080fd5b823561286881612750565b9150612876602084016127f5565b90509250929050565b6000806040838503121561289257600080fd5b823561289d81612750565b915060208301356128ad81612750565b809150509250929050565b6000806000604084860312156128cd57600080fd5b83356128d881612750565b9250602084013567ffffffffffffffff808211156128f557600080fd5b818601915086601f83011261290957600080fd5b81358181111561291857600080fd5b87602082850101111561292a57600080fd5b6020830194508093505050509250925092565b60008060006060848603121561295257600080fd5b833561295d81612750565b9250602084013561296d81612750565b929592945050506040919091013590565b6000806000806000610120868803121561299757600080fd5b6129a187876127e3565b94506129af60a087016127f5565b949794965050505060c08301359260e081013592610100909101359150565b6000602082840312156129e057600080fd5b5035919050565b600080604083850312156129fa57600080fd5b612a0383612785565b915061287660208401612785565b600181811c90821680612a2557607f821691505b60208210810361232257634e487b7160e01b600052602260045260246000fd5b6020808252600a908201526927a7262cafa0a226a4a760b11b604082015260600190565b6020808252600b908201526a414d4f554e545f5a45524f60a81b604082015260600190565b634e487b7160e01b600052602160045260246000fd5b6060810160038510612ab857612ab8612a8e565b938152602081019290925260409091015290565b634e487b7160e01b600052604160045260246000fd5b6080815263ffffffff8451166080820152602084015160a0820152604084015160c0820152606084015160e08201526000608085015160e0610100840152612b2e610160840182612711565b905060a0860151607f198085840301610120860152612b4d8383612711565b925060c08801519150808584030161014086015250612b6c8282612711565b92505050612b87602083018580518252602090810151910152565b6001600160a01b0383166060830152949350505050565b600060408284031215612bb057600080fd5b6040516040810181811067ffffffffffffffff82111715612bd357612bd3612acc565b604052825181526020928301519281019290925250919050565b60008082840360c0811215612c0157600080fd5b6080811215612c0f57600080fd5b506040516060810167ffffffffffffffff8282108183111715612c3457612c34612acc565b8160405285518352602086015191508082168214612c5157600080fd5b506020820152612c648560408601612b9e565b604082015291506128768460808501612b9e565b601f8211156123a8576000816000526020600020601f850160051c81016020861015612ca15750805b601f850160051c820191505b81811015612cc057828155600101612cad565b505050505050565b67ffffffffffffffff831115612ce057612ce0612acc565b612cf483612cee8354612a11565b83612c78565b6000601f841160018114612d285760008515612d105750838201355b600019600387901b1c1916600186901b178355612d82565b600083815260209020601f19861690835b82811015612d595786850135825560209485019460019092019101612d39565b5086821015612d765760001960f88860031b161c19848701351681555b505060018560011b0183555b5050505050565b600060a08284031215612d9b57600080fd5b60405160a0810181811067ffffffffffffffff82111715612dbe57612dbe612acc565b604052823581529050806020830135612dd681612750565b60208201526040830135612de981612750565b60408201526060830135612dfc81612750565b6060820152608092830135920191909152919050565b600060a08284031215612e2457600080fd5b6118358383612d89565b60008351612e408184602088016126ed565b835190830190612e548183602088016126ed565b01949350505050565b600060208284031215612e6f57600080fd5b815161183581612750565b6060810160048510612e8e57612e8e612a8e565b9381526001600160a01b039283166020820152911660409091015290565b600060208284031215612ebe57600080fd5b8151801515811461183557600080fd5b634e487b7160e01b600052601160045260246000fd5b8082018082111561084d5761084d612ece565b600060208284031215612f0957600080fd5b5051919050565b8181038181111561084d5761084d612ece565b600082612f4057634e487b7160e01b600052601260045260246000fd5b500490565b808202811582820484141761084d5761084d612ece565b61ffff818116838216019080821115612f7757612f77612ece565b5092915050565b60008651612f90818460208b016126ed565b6001600160f81b031960f888811b82169285019283526001600160f01b031960f089901b16600184015286901b1660038201528351612fd68160048401602088016126ed565b0160040197965050505050505056fe486f6c646572526571756573745061796c6f61645f436869704f75744c5a2875696e74323536206e6f6e63652c6164647265737320636869702c6164647265737320686f6c6465722c616464726573732072656365697665722c75696e7432353620616d6f756e7429486f6c646572526571756573745061796c6f61645f436869704f75744c5a5f556e777261702875696e74323536206e6f6e63652c6164647265737320636869702c6164647265737320686f6c6465722c616464726573732072656365697665722c75696e7432353620616d6f756e7429a264697066735822122012d15e835c304f9f495923d2c18982205a94082feb87d56021a73cc0840a081e64736f6c63430008180033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
0000000000000000000000004cf3d61165a6be8ff741320ad27cab57fae5c207
-----Decoded View---------------
Arg [0] : _registry (address): 0x4CF3d61165a6Be8FF741320ad27Cab57faE5c207
-----Encoded View---------------
1 Constructor Arguments found :
Arg [0] : 0000000000000000000000004cf3d61165a6be8ff741320ad27cab57fae5c207
Loading...
Loading
Loading...
Loading
Multichain Portfolio | 30 Chains
Chain | Token | Portfolio % | Price | Amount | Value |
---|
[ Download: CSV Export ]
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.