ERC-20
Source Code
Overview
Max Total Supply
225,370,977.516269 eATH
Holders
608
Market
Price
$0.00 @ 0.000000 ETH
Onchain Market Cap
-
Circulating Supply Market Cap
-
Other Info
Token Contract (WITH 18 Decimals)
Balance
24,214.745598130775207124 eATHValue
$0.00Loading...
Loading
Loading...
Loading
Loading...
Loading
Contract Name:
EigenATHSimple
Compiler Version
v0.8.27+commit.40a35a09
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {OFT} from "@layerzerolabs/oft-evm/contracts/OFT.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
/// @title EigenATHSimple
/// @author Aethir
/// @notice A standard OFT (Omnichain Fungible Token) for representing eATH on auxiliary chains (Chain B).
/// @dev This version is a simple OFT without direct ATHVault hooks.
/// It relies on the standard OFT mechanisms for bridging.
contract EigenATHSimple is OFT {
/// @notice Constructor to deploy the EigenATHSimple token.
/// @param _name The name of the token.
/// @param _symbol The symbol of the token.
/// @param _lzEndpoint The LayerZero endpoint address on this chain.
/// @param _initialOwner The initial owner of this contract instance for Ownable and delegate for OApp.
constructor(
string memory _name,
string memory _symbol,
address _lzEndpoint,
address _initialOwner
) OFT(_name, _symbol, _lzEndpoint, _initialOwner) Ownable(_initialOwner) {
// _initialOwner is passed to OFT as the _delegate argument.
// _initialOwner is passed to Ownable for standard OZ ownership.
}
/// @dev Sets the token decimals to 18. OFT requires this.
function decimals() public view virtual override returns (uint8) {
return 18;
}
}// SPDX-License-Identifier: LZBL-1.2
pragma solidity ^0.8.20;
import "@layerzerolabs/lz-evm-protocol-v2/contracts/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;
uint8 internal constant OPTION_TYPE_LZREAD = 5;
error Executor_InvalidLzReceiveOption();
error Executor_InvalidNativeDropOption();
error Executor_InvalidLzComposeOption();
error Executor_InvalidLzReadOption();
/// @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 decodeLzReadOption(
bytes calldata _option
) internal pure returns (uint128 gas, uint32 calldataSize, uint128 value) {
if (_option.length != 20 && _option.length != 36) revert Executor_InvalidLzReadOption();
gas = _option.toU128(0);
calldataSize = _option.toU32(16);
value = _option.length == 36 ? _option.toU128(20) : 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);
}
function encodeLzReadOption(
uint128 _gas,
uint32 _calldataSize,
uint128 _value
) internal pure returns (bytes memory) {
return _value == 0 ? abi.encodePacked(_gas, _calldataSize) : abi.encodePacked(_gas, _calldataSize, _value);
}
}// 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.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 { 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
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-messagelib-v2/contracts/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 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 addExecutorLzReadOption(
bytes memory _options,
uint128 _gas,
uint32 _size,
uint128 _value
) internal pure onlyType3(_options) returns (bytes memory) {
bytes memory option = ExecutorOptions.encodeLzReadOption(_gas, _size, _value);
return addExecutorOption(_options, ExecutorOptions.OPTION_TYPE_LZREAD, 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;
// @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.20;
import { MessagingReceipt, MessagingFee } from "@layerzerolabs/oapp-evm/contracts/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 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 the fee breakdown and settings data for an OFT. Unused in the default implementation.
* @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 for 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 for 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) {
if (_to == address(0x0)) _to = address(0xdead); // _mint(...) does not support address(0x0)
// @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 { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { OApp, Origin } from "@layerzerolabs/oapp-evm/contracts/oapp/OApp.sol";
import { OAppOptionsType3 } from "@layerzerolabs/oapp-evm/contracts/oapp/libs/OAppOptionsType3.sol";
import { IOAppMsgInspector } from "@layerzerolabs/oapp-evm/contracts/oapp/interfaces/IOAppMsgInspector.sol";
import { OAppPreCrimeSimulator } from "@layerzerolabs/oapp-evm/contracts/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 the fee breakdown and settings data for an OFT. Unused in the default implementation.
* @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 = IERC20(this.token()).totalSupply(); // 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) {
return _send(_sendParam, _fee, _refundAddress);
}
/**
* @dev Internal function to execute 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
) internal 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
address inspector = msgInspector; // caches the msgInspector to avoid potential double storage read
if (inspector != address(0)) IOAppMsgInspector(inspector).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
// OpenZeppelin Contracts (last updated v5.3.0) (access/AccessControl.sol)
pragma solidity ^0.8.20;
import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {ERC165Upgradeable} from "../utils/introspection/ERC165Upgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms. This is a lightweight version that doesn't allow enumerating role
* members except through off-chain means by accessing the contract event logs. Some
* applications may benefit from on-chain enumerability, for those cases see
* {AccessControlEnumerable}.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```solidity
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```solidity
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it. We recommend using {AccessControlDefaultAdminRules}
* to enforce additional security measures for this role.
*/
abstract contract AccessControlUpgradeable is Initializable, ContextUpgradeable, IAccessControl, ERC165Upgradeable {
struct RoleData {
mapping(address account => bool) hasRole;
bytes32 adminRole;
}
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/// @custom:storage-location erc7201:openzeppelin.storage.AccessControl
struct AccessControlStorage {
mapping(bytes32 role => RoleData) _roles;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.AccessControl")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant AccessControlStorageLocation = 0x02dd7bc7dec4dceedda775e58dd541e08a116c6c53815c0bd028192f7b626800;
function _getAccessControlStorage() private pure returns (AccessControlStorage storage $) {
assembly {
$.slot := AccessControlStorageLocation
}
}
/**
* @dev Modifier that checks that an account has a specific role. Reverts
* with an {AccessControlUnauthorizedAccount} error including the required role.
*/
modifier onlyRole(bytes32 role) {
_checkRole(role);
_;
}
function __AccessControl_init() internal onlyInitializing {
}
function __AccessControl_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
return interfaceId == type(IAccessControl).interfaceId || super.supportsInterface(interfaceId);
}
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
return $._roles[role].hasRole[account];
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `_msgSender()`
* is missing `role`. Overriding this function changes the behavior of the {onlyRole} modifier.
*/
function _checkRole(bytes32 role) internal view virtual {
_checkRole(role, _msgSender());
}
/**
* @dev Reverts with an {AccessControlUnauthorizedAccount} error if `account`
* is missing `role`.
*/
function _checkRole(bytes32 role, address account) internal view virtual {
if (!hasRole(role, account)) {
revert AccessControlUnauthorizedAccount(account, role);
}
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view virtual returns (bytes32) {
AccessControlStorage storage $ = _getAccessControlStorage();
return $._roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleGranted} event.
*/
function grantRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*
* May emit a {RoleRevoked} event.
*/
function revokeRole(bytes32 role, address account) public virtual onlyRole(getRoleAdmin(role)) {
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been revoked `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*
* May emit a {RoleRevoked} event.
*/
function renounceRole(bytes32 role, address callerConfirmation) public virtual {
if (callerConfirmation != _msgSender()) {
revert AccessControlBadConfirmation();
}
_revokeRole(role, callerConfirmation);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
AccessControlStorage storage $ = _getAccessControlStorage();
bytes32 previousAdminRole = getRoleAdmin(role);
$._roles[role].adminRole = adminRole;
emit RoleAdminChanged(role, previousAdminRole, adminRole);
}
/**
* @dev Attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted.
*
* Internal function without access restriction.
*
* May emit a {RoleGranted} event.
*/
function _grantRole(bytes32 role, address account) internal virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
if (!hasRole(role, account)) {
$._roles[role].hasRole[account] = true;
emit RoleGranted(role, account, _msgSender());
return true;
} else {
return false;
}
}
/**
* @dev Attempts to revoke `role` from `account` and returns a boolean indicating if `role` was revoked.
*
* Internal function without access restriction.
*
* May emit a {RoleRevoked} event.
*/
function _revokeRole(bytes32 role, address account) internal virtual returns (bool) {
AccessControlStorage storage $ = _getAccessControlStorage();
if (hasRole(role, account)) {
$._roles[role].hasRole[account] = false;
emit RoleRevoked(role, account, _msgSender());
return true;
} else {
return false;
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.20;
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Storage of the initializable contract.
*
* It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
* when using with upgradeable contracts.
*
* @custom:storage-location erc7201:openzeppelin.storage.Initializable
*/
struct InitializableStorage {
/**
* @dev Indicates that the contract has been initialized.
*/
uint64 _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool _initializing;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00;
/**
* @dev The contract is already initialized.
*/
error InvalidInitialization();
/**
* @dev The contract is not initializing.
*/
error NotInitializing();
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint64 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
* number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
* production.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
// Cache values to avoid duplicated sloads
bool isTopLevelCall = !$._initializing;
uint64 initialized = $._initialized;
// Allowed calls:
// - initialSetup: the contract is not in the initializing state and no previous version was
// initialized
// - construction: the contract is initialized at version 1 (no reinitialization) and the
// current contract is just being deployed
bool initialSetup = initialized == 0 && isTopLevelCall;
bool construction = initialized == 1 && address(this).code.length == 0;
if (!initialSetup && !construction) {
revert InvalidInitialization();
}
$._initialized = 1;
if (isTopLevelCall) {
$._initializing = true;
}
_;
if (isTopLevelCall) {
$._initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: Setting the version to 2**64 - 1 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint64 version) {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing || $._initialized >= version) {
revert InvalidInitialization();
}
$._initialized = version;
$._initializing = true;
_;
$._initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
_checkInitializing();
_;
}
/**
* @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
*/
function _checkInitializing() internal view virtual {
if (!_isInitializing()) {
revert NotInitializing();
}
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
// solhint-disable-next-line var-name-mixedcase
InitializableStorage storage $ = _getInitializableStorage();
if ($._initializing) {
revert InvalidInitialization();
}
if ($._initialized != type(uint64).max) {
$._initialized = type(uint64).max;
emit Initialized(type(uint64).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint64) {
return _getInitializableStorage()._initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _getInitializableStorage()._initializing;
}
/**
* @dev Pointer to storage slot. Allows integrators to override it with a custom storage location.
*
* NOTE: Consider following the ERC-7201 formula to derive storage locations.
*/
function _initializableStorageSlot() internal pure virtual returns (bytes32) {
return INITIALIZABLE_STORAGE;
}
/**
* @dev Returns a pointer to the storage namespace.
*/
// solhint-disable-next-line var-name-mixedcase
function _getInitializableStorage() private pure returns (InitializableStorage storage $) {
bytes32 slot = _initializableStorageSlot();
assembly {
$.slot := slot
}
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract ContextUpgradeable is Initializable {
function __Context_init() internal onlyInitializing {
}
function __Context_init_unchained() internal onlyInitializing {
}
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
function _contextSuffixLength() internal view virtual returns (uint256) {
return 0;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/ERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
import {Initializable} from "../../proxy/utils/Initializable.sol";
/**
* @dev Implementation of the {IERC165} interface.
*
* Contracts that want to implement ERC-165 should inherit from this contract and override {supportsInterface} to check
* for the additional interface id that will be supported. For example:
*
* ```solidity
* function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
* return interfaceId == type(MyInterface).interfaceId || super.supportsInterface(interfaceId);
* }
* ```
*/
abstract contract ERC165Upgradeable is Initializable, IERC165 {
function __ERC165_init() internal onlyInitializing {
}
function __ERC165_init_unchained() internal onlyInitializing {
}
/**
* @dev See {IERC165-supportsInterface}.
*/
function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) {
return interfaceId == type(IERC165).interfaceId;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (utils/Pausable.sol)
pragma solidity ^0.8.20;
import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which allows children to implement an emergency stop
* mechanism that can be triggered by an authorized account.
*
* This module is used through inheritance. It will make available the
* modifiers `whenNotPaused` and `whenPaused`, which can be applied to
* the functions of your contract. Note that they will not be pausable by
* simply including this module, only once the modifiers are put in place.
*/
abstract contract PausableUpgradeable is Initializable, ContextUpgradeable {
/// @custom:storage-location erc7201:openzeppelin.storage.Pausable
struct PausableStorage {
bool _paused;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Pausable")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant PausableStorageLocation = 0xcd5ed15c6e187e77e9aee88184c21f4f2182ab5827cb3b7e07fbedcd63f03300;
function _getPausableStorage() private pure returns (PausableStorage storage $) {
assembly {
$.slot := PausableStorageLocation
}
}
/**
* @dev Emitted when the pause is triggered by `account`.
*/
event Paused(address account);
/**
* @dev Emitted when the pause is lifted by `account`.
*/
event Unpaused(address account);
/**
* @dev The operation failed because the contract is paused.
*/
error EnforcedPause();
/**
* @dev The operation failed because the contract is not paused.
*/
error ExpectedPause();
/**
* @dev Modifier to make a function callable only when the contract is not paused.
*
* Requirements:
*
* - The contract must not be paused.
*/
modifier whenNotPaused() {
_requireNotPaused();
_;
}
/**
* @dev Modifier to make a function callable only when the contract is paused.
*
* Requirements:
*
* - The contract must be paused.
*/
modifier whenPaused() {
_requirePaused();
_;
}
function __Pausable_init() internal onlyInitializing {
}
function __Pausable_init_unchained() internal onlyInitializing {
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
PausableStorage storage $ = _getPausableStorage();
return $._paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
if (paused()) {
revert EnforcedPause();
}
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
if (!paused()) {
revert ExpectedPause();
}
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
PausableStorage storage $ = _getPausableStorage();
$._paused = false;
emit Unpaused(_msgSender());
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/ReentrancyGuard.sol)
pragma solidity ^0.8.20;
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If EIP-1153 (transient storage) is available on the chain you're deploying at,
* consider using {ReentrancyGuardTransient} instead.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/
abstract contract ReentrancyGuardUpgradeable is Initializable {
// Booleans are more expensive than uint256 or any type that takes up a full
// word because each write operation emits an extra SLOAD to first read the
// slot's contents, replace the bits taken up by the boolean, and then write
// back. This is the compiler's defense against contract upgrades and
// pointer aliasing, and it cannot be disabled.
// The values being non-zero value makes deployment a bit more expensive,
// but in exchange the refund on every call to nonReentrant will be lower in
// amount. Since refunds are capped to a percentage of the total
// transaction's gas, it is best to keep them low in cases like this one, to
// increase the likelihood of the full refund coming into effect.
uint256 private constant NOT_ENTERED = 1;
uint256 private constant ENTERED = 2;
/// @custom:storage-location erc7201:openzeppelin.storage.ReentrancyGuard
struct ReentrancyGuardStorage {
uint256 _status;
}
// keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.ReentrancyGuard")) - 1)) & ~bytes32(uint256(0xff))
bytes32 private constant ReentrancyGuardStorageLocation = 0x9b779b17422d0df92223018b32b4d1fa46e071723d6817e2486d003becc55f00;
function _getReentrancyGuardStorage() private pure returns (ReentrancyGuardStorage storage $) {
assembly {
$.slot := ReentrancyGuardStorageLocation
}
}
/**
* @dev Unauthorized reentrant call.
*/
error ReentrancyGuardReentrantCall();
function __ReentrancyGuard_init() internal onlyInitializing {
__ReentrancyGuard_init_unchained();
}
function __ReentrancyGuard_init_unchained() internal onlyInitializing {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
$._status = NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function _nonReentrantBefore() private {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
// On the first call to nonReentrant, _status will be NOT_ENTERED
if ($._status == ENTERED) {
revert ReentrancyGuardReentrantCall();
}
// Any calls to nonReentrant after this point will fail
$._status = ENTERED;
}
function _nonReentrantAfter() private {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
// By storing the original value once again, a refund is triggered (see
// https://eips.ethereum.org/EIPS/eip-2200)
$._status = NOT_ENTERED;
}
/**
* @dev Returns true if the reentrancy guard is currently set to "entered", which indicates there is a
* `nonReentrant` function in the call stack.
*/
function _reentrancyGuardEntered() internal view returns (bool) {
ReentrancyGuardStorage storage $ = _getReentrancyGuardStorage();
return $._status == ENTERED;
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.0) (access/IAccessControl.sol)
pragma solidity ^0.8.20;
/**
* @dev External interface of AccessControl declared to support ERC-165 detection.
*/
interface IAccessControl {
/**
* @dev The `account` is missing a role.
*/
error AccessControlUnauthorizedAccount(address account, bytes32 neededRole);
/**
* @dev The caller of a function is not the expected one.
*
* NOTE: Don't confuse with {AccessControlUnauthorizedAccount}.
*/
error AccessControlBadConfirmation();
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted to signal this.
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call. This account bears the admin role (for the granted role).
* Expected in cases where the role was granted using the internal {AccessControl-_grantRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `callerConfirmation`.
*/
function renounceRole(bytes32 role, address callerConfirmation) external;
}// 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.1.0) (interfaces/draft-IERC6093.sol)
pragma solidity ^0.8.20;
/**
* @dev Standard ERC-20 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-20 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 ERC-721 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-721 tokens.
*/
interface IERC721Errors {
/**
* @dev Indicates that an address can't be an owner. For example, `address(0)` is a forbidden owner in ERC-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 ERC-1155 Errors
* Interface of the https://eips.ethereum.org/EIPS/eip-6093[ERC-6093] custom errors for ERC-1155 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.1.0) (interfaces/IERC1363.sol)
pragma solidity ^0.8.20;
import {IERC20} from "./IERC20.sol";
import {IERC165} from "./IERC165.sol";
/**
* @title IERC1363
* @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363].
*
* Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract
* after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction.
*/
interface IERC1363 is IERC20, IERC165 {
/*
* Note: the ERC-165 identifier for this interface is 0xb0202a11.
* 0xb0202a11 ===
* bytes4(keccak256('transferAndCall(address,uint256)')) ^
* bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^
* bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^
* bytes4(keccak256('approveAndCall(address,uint256)')) ^
* bytes4(keccak256('approveAndCall(address,uint256,bytes)'))
*/
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from the caller's account to `to`
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value) external returns (bool);
/**
* @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism
* and then calls {IERC1363Receiver-onTransferReceived} on `to`.
* @param from The address which you want to send tokens from.
* @param to The address which you want to transfer to.
* @param value The amount of tokens to be transferred.
* @param data Additional data with no specified format, sent in call to `to`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value) external returns (bool);
/**
* @dev Sets a `value` amount of tokens as the allowance of `spender` over the
* caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`.
* @param spender The address which will spend the funds.
* @param value The amount of tokens to be spent.
* @param data Additional data with no specified format, sent in call to `spender`.
* @return A boolean value indicating whether the operation succeeded unless throwing.
*/
function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol)
pragma solidity ^0.8.20;
import {IERC165} from "../utils/introspection/IERC165.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../token/ERC20/IERC20.sol";// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.3.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 ERC-20
* applications.
*/
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}.
*
* Both 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}.
*
* Skips emitting an {Approval} event indicating an allowance update. This is not
* required by the ERC. See {xref-ERC20-_approve-address-address-uint256-bool-}[_approve].
*
* 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:
*
* ```solidity
* 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/ERC20Burnable.sol)
pragma solidity ^0.8.20;
import {ERC20} from "../ERC20.sol";
import {Context} from "../../../utils/Context.sol";
/**
* @dev Extension of {ERC20} that allows token holders to destroy both their own
* tokens and those that they have an allowance for, in a way that can be
* recognized off-chain (via event analysis).
*/
abstract contract ERC20Burnable is Context, ERC20 {
/**
* @dev Destroys a `value` amount of tokens from the caller.
*
* See {ERC20-_burn}.
*/
function burn(uint256 value) public virtual {
_burn(_msgSender(), value);
}
/**
* @dev Destroys a `value` amount of tokens from `account`, deducting from
* the caller's allowance.
*
* See {ERC20-_burn} and {ERC20-allowance}.
*
* Requirements:
*
* - the caller must have allowance for ``accounts``'s tokens of at least
* `value`.
*/
function burnFrom(address account, uint256 value) public virtual {
_spendAllowance(account, _msgSender(), value);
_burn(account, value);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.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 ERC-20 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.1.0) (token/ERC20/IERC20.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-20 standard as defined in the ERC.
*/
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.3.0) (token/ERC20/utils/SafeERC20.sol)
pragma solidity ^0.8.20;
import {IERC20} from "../IERC20.sol";
import {IERC1363} from "../../../interfaces/IERC1363.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC-20 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 {
/**
* @dev An operation with an ERC-20 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 Variant of {safeTransfer} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransfer(IERC20 token, address to, uint256 value) internal returns (bool) {
return _callOptionalReturnBool(token, abi.encodeCall(token.transfer, (to, value)));
}
/**
* @dev Variant of {safeTransferFrom} that returns a bool instead of reverting if the operation is not successful.
*/
function trySafeTransferFrom(IERC20 token, address from, address to, uint256 value) internal returns (bool) {
return _callOptionalReturnBool(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.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
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.
*
* IMPORTANT: If the token implements ERC-7674 (ERC-20 with temporary allowance), and if the "client"
* smart contract uses ERC-7674 to set temporary allowances, then the "client" smart contract should avoid using
* this function. Performing a {safeIncreaseAllowance} or {safeDecreaseAllowance} operation on a token contract
* that has a non-zero temporary allowance (for that particular owner-spender) will result in unexpected behavior.
*/
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.
*
* NOTE: If the token implements ERC-7674, this function will not modify any temporary allowance. This function
* only sets the "standard" allowance. Any temporary allowance will remain active, in addition to the value being
* set here.
*/
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 Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
safeTransfer(token, to, value);
} else if (!token.transferAndCall(to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target
* has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* Reverts if the returned value is other than `true`.
*/
function transferFromAndCallRelaxed(
IERC1363 token,
address from,
address to,
uint256 value,
bytes memory data
) internal {
if (to.code.length == 0) {
safeTransferFrom(token, from, to, value);
} else if (!token.transferFromAndCall(from, to, value, data)) {
revert SafeERC20FailedOperation(address(token));
}
}
/**
* @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no
* code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when
* targeting contracts.
*
* NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}.
* Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall}
* once without retrying, and relies on the returned value to be true.
*
* Reverts if the returned value is other than `true`.
*/
function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal {
if (to.code.length == 0) {
forceApprove(token, to, value);
} else if (!token.approveAndCall(to, value, data)) {
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 {_callOptionalReturnBool} that reverts if call fails to meet the requirements.
*/
function _callOptionalReturn(IERC20 token, bytes memory data) private {
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
let success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
// bubble errors
if iszero(success) {
let ptr := mload(0x40)
returndatacopy(ptr, 0, returndatasize())
revert(ptr, returndatasize())
}
returnSize := returndatasize()
returnValue := mload(0)
}
if (returnSize == 0 ? address(token).code.length == 0 : returnValue != 1) {
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 silently catches all reverts and returns a bool instead.
*/
function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) {
bool success;
uint256 returnSize;
uint256 returnValue;
assembly ("memory-safe") {
success := call(gas(), token, 0, add(data, 0x20), mload(data), 0, 0x20)
returnSize := returndatasize()
returnValue := mload(0)
}
return success && (returnSize == 0 ? address(token).code.length > 0 : returnValue == 1);
}
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.2.0) (utils/Address.sol)
pragma solidity ^0.8.20;
import {Errors} from "./Errors.sol";
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev There's no code at `target` (it is not a contract).
*/
error AddressEmptyCode(address target);
/**
* @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 Errors.InsufficientBalance(address(this).balance, amount);
}
(bool success, bytes memory returndata) = recipient.call{value: amount}("");
if (!success) {
_revert(returndata);
}
}
/**
* @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
* {Errors.FailedCall} 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 Errors.InsufficientBalance(address(this).balance, value);
}
(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 {Errors.FailedCall}) 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 {Errors.FailedCall} 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 {Errors.FailedCall}.
*/
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
assembly ("memory-safe") {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert Errors.FailedCall();
}
}
}// 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.1.0) (utils/Errors.sol)
pragma solidity ^0.8.20;
/**
* @dev Collection of common custom errors used in multiple contracts
*
* IMPORTANT: Backwards compatibility is not guaranteed in future versions of the library.
* It is recommended to avoid relying on the error API for critical functionality.
*
* _Available since v5.1._
*/
library Errors {
/**
* @dev The ETH balance of the account is not enough to perform the operation.
*/
error InsufficientBalance(uint256 balance, uint256 needed);
/**
* @dev A call to an address target failed. The target may have reverted.
*/
error FailedCall();
/**
* @dev The deployment failed.
*/
error FailedDeployment();
/**
* @dev A necessary precompile is missing.
*/
error MissingPrecompile(address);
}// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v5.1.0) (utils/introspection/IERC165.sol)
pragma solidity ^0.8.20;
/**
* @dev Interface of the ERC-165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[ERC].
*
* 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[ERC 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.1.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/bool 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);
}
/**
* @dev Cast a boolean (false or true) to a uint256 (0 or 1) with no jump.
*/
function toUint(bool b) internal pure returns (uint256 u) {
assembly ("memory-safe") {
u := iszero(iszero(b))
}
}
}// 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 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; } }
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {OFT} from "@layerzerolabs/oft-evm/contracts/OFT.sol";
import {IVault} from "./interfaces/IVault.sol";
import {ILayerZeroEndpointV2} from "@layerzerolabs/lz-evm-protocol-v2/contracts/interfaces/ILayerZeroEndpointV2.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
/// @title EigenATHVault (eATH)
/// @author Aethir
/// @notice ERC20 token representing a user's deposit in ATHVault.
/// @dev This token is minted to users upon depositing ATH into ATHVault and burned during unstaking.
/// It is backed by ATH staked in EigenLayer strategies and/or a StakeBase contract via the ATHVault.
/// Transfers of eATH trigger a hook in ATHVault to re-attribute associated rewards and EigenLayer shares.
contract EigenATHVault is OFT {
uint32 public immutable CHAIN_A_EID; // Endpoint ID of Chain A where ATHVault resides
/// @notice Constructor to deploy the EigenATHVault token.
/// @dev Sets the ATHVault contract (_ownerForOFT) as the initial delegate for OFT and owner for Ownable.
constructor(
string memory _name,
string memory _symbol,
address _lzEndpoint,
address _ownerForOFT, // ATHVault address on Chain A, will be the delegate for OFT and owner for Ownable
uint32 _chainAEid // The EID of the chain where ATHVault (owner) is deployed
) OFT(_name, _symbol, _lzEndpoint, _ownerForOFT) Ownable(_ownerForOFT) {
CHAIN_A_EID = _chainAEid;
// _ownerForOFT (ATHVault) is now the OpenZeppelin owner() and the LayerZero OApp delegate().
// This allows ATHVault to call onlyOwner functions like mint/burn.
}
function decimals() public view virtual override returns (uint8) {
return 18;
}
// --- Owner-callable Mint and Burn for local operations by ATHVault ---
function mint(address to, uint256 amount) external virtual onlyOwner {
_mint(to, amount);
}
function burn(address account, uint256 amount) external virtual onlyOwner {
_burn(account, amount);
}
// --- End Owner-callable Mint and Burn ---
function _currentChainEid() internal view returns (uint32) {
return ILayerZeroEndpointV2(address(endpoint)).eid();
}
/// @dev Overrides ERC20._update to notify the ATHVault on transfers (excluding mints/burns).
/// This allows ATHVault to update reward entitlements and EigenLayer shares.
/// @param from The sender address.
/// @param to The recipient address.
/// @param value The amount of tokens transferred.
function _update(
address from,
address to,
uint256 value
) internal virtual override {
super._update(from, to, value);
if (_currentChainEid() == CHAIN_A_EID) {
// Only call the vault hook if this eATH instance is on Chain A
if (
(from != address(0) && to != address(0) && value > 0) || // Transfer
(from == address(0) && to != address(0) && value > 0) || // Mint
(to == address(0) && from != address(0) && value > 0) // Burn
) {
if (owner() != address(0)) {
// Ensure owner (ATHVault) is set
IVault(payable(owner())).onLocalEATHTransfer(
from,
to,
value
);
}
}
}
}
// _debit is called by send()
function _debit(
address _from,
uint256 _amountLD, // Amount in local decimals
uint256 _minAmountLD, // minAmount to receive on dst side an lzTxParams from OFTCore.sol
uint32 _dstEid // dstEid is part of OFTCore._debit signature
)
internal
virtual
override
returns (uint256 amountSentLD, uint256 amountReceivedLD)
{
if (_currentChainEid() == CHAIN_A_EID) {
// We need _dstEid for handleEATHBridgedOut. OFTCore's _debit provides it.
require(
IVault(payable(owner())).handleEATHBridgedOut(
_from,
_amountLD, // OFT Core _debit takes amountLD, minAmountLD, dstEid. We pass amountLD to the hook.
_dstEid // Pass dstEid to the hook
),
"Vault: bridge out prep failed"
);
}
// The `super._debit` in OFT.sol will call `_debitView` and then `_burn`.
// It expects (_from, _amountLD, _minAmountLD, _dstEid)
return super._debit(_from, _amountLD, _minAmountLD, _dstEid);
}
// _credit is called by _lzReceive() -> _nonblockingLzReceive -> _credit
function _credit(
address _to, // recipient address on this chain
uint256 _amountLD, // amount in local decimals
uint32 _srcEid // _srcEid is part of OFTCore _credit signature
) internal virtual override returns (uint256 amountReceivedLD) {
if (_currentChainEid() == CHAIN_A_EID) {
// We need _srcEid for handleEATHBridgedIn. OFTCore's _credit provides it.
require(
IVault(payable(owner())).handleEATHBridgedIn(
_to,
_amountLD,
_srcEid
),
"Vault: bridge in prep failed"
);
}
// The `super._credit` in OFT.sol will call `_mint`.
// It expects (_to, _amountLD, _srcEid)
return super._credit(_to, _amountLD, _srcEid);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {EigenATHVault} from "./EigenATHVault.sol";
contract EigenATHVaultFactory {
function createEigenATHVault(
string memory _name,
string memory _symbol,
address _lzEndpoint,
address _ownerForOFT, // ATHVault address on Chain A, will be the delegate for OFT and owner for Ownable
uint32 _chainAEid // The EID of the chain where ATHVault (owner) is deployed
) external returns (EigenATHVault) {
EigenATHVault vault = new EigenATHVault(
_name,
_symbol,
_lzEndpoint,
_ownerForOFT,
_chainAEid
);
return vault;
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
import {IRequestVerifier} from "./IRequestVerifier.sol";
/// @title Account Handler Interface
interface IAccountHandler {
/// @notice Emitted when a new account is created
event AccountCreated(
address indexed wallet,
uint256 tid,
Group initialGroup,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when an account is migrated
event AccountMigrationCompleted(
address[] indexed wallets,
uint256[] tids,
Group[] initialGroups,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when a wallet is rebound
event WalletRebound(
address indexed wallet,
uint256 tid,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when a new group is created
event GroupCreated(uint256 tid, uint256 gid, uint64 nonce, bytes32 vhash);
/// @notice Emitted when a group migration is completed
event GroupMigrationCompleted(Group[] groups, uint64 nonce, bytes32 vhash);
/// @notice Emitted when a delegator is assigned to a group
event DelegatorAssigned(
address indexed delegator,
uint256 tid,
uint256 gid,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when a delegator is revoked from a group
event DelegatorRevoked(
uint256 tid,
uint256 gid,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when a fee receiver is set for a group
event FeeReceiverSet(
address indexed receiver,
uint256 tid,
uint256 gid,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when a fee receiver is revoked from a group
event FeeReceiverRevoked(
uint256 tid,
uint256 gid,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when a reward receiver is set for a group
event RewardReceiverSet(
address indexed receiver,
uint256 tid,
uint256 gid,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when a reward receiver is revoked from a group
event RewardReceiverRevoked(
uint256 tid,
uint256 gid,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when a policy is updated
event PolicyUpdated(
uint256 tid,
uint256 gid,
bool delegatorSetFeeReceiver,
bool delegatorSetRewardReceiver
);
/// @notice Emitted when group settings are updated
event GroupsUpdated(Group[] groups, uint64 nonce, bytes32 vhash);
/// @notice Emitted when receivers are set
event ReceiversSet(Receiver[] receivers, uint64 nonce, bytes32 vhash);
struct Group {
uint256 tid;
uint256 gid;
address delegator;
address feeReceiver;
address rewardReceiver;
bool delegatorSetFeeReceiver;
bool delegatorSetRewardReceiver;
}
struct Receiver {
address feeReceiver;
address rewardReceiver;
uint256 tid;
uint256 gid;
bool setFeeReceiver;
bool setRewardReceiver;
}
/// @notice create a new account
/// @param vdata the verifiable data
function createAccount(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice rebind a wallet to a new account
/// @param vdata the verifiable data
function rebindWallet(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice create a new group
/// @param vdata the verifiable data
function createGroup(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice assign a delegator to a group
/// @param vdata the verifiable data
function assignDelegator(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice revoke a delegator from a group
/// @param vdata the verifiable data
function revokeDelegator(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice set a fee receiver for a group
/// @param vdata the verifiable data
function setFeeReceiver(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice revoke a fee receiver from a group
/// @param vdata the verifiable data
function revokeFeeReceiver(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice set a reward receiver for a group
/// @param vdata the verifiable data
function setRewardReceiver(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice revoke a reward receiver from a group
/// @param vdata the verifiable data
function revokeRewardReceiver(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice update a policy
/// @param tid the account tid
/// @param gid the group id
/// @param delegatorSetFeeReceiver whether delegator can set fee receiver
/// @param delegatorSetRewardReceiver whether delegator can set reward receiver
function updatePolicy(
uint256 tid,
uint256 gid,
bool delegatorSetFeeReceiver,
bool delegatorSetRewardReceiver
) external;
/// @notice batch update group settings
/// @param vdata the verifiable data
function batchUpdateGroupSettings(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice batch set receivers
/// @param vdata the verifiable data
function batchSetReceivers(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice get the group information
/// @param tid the account tid
/// @param gid the group id
function getGroup(
uint256 tid,
uint256 gid
) external view returns (Group memory);
/// @notice initial account migration
/// @param vdata the verifiable data
function initialAccountsMigration(
IRequestVerifier.VerifiableData calldata vdata
) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
/**
* @title IACLManager
* @notice Defines the basic interface for the ACL Manager
*/
interface IACLManager {
/// @notice Emitted when required signatures is changed
event RequiredSignaturesChanged(uint8 number);
/// @notice Emitted when required initiator signatures is changed
event RequiredInitiatorSignaturesChanged(uint8 number);
/// @notice revert if the address is not Default Admin
/// @param account: the address to check
function requireDefaultAdmin(address account) external view;
/// @notice revert if the address is not Configuration Admin
/// @param account: the address to check
function requireConfigurationAdmin(address account) external view;
/// @notice revert if the address is not Settlement Operator
/// @param account: the address to check
function requireInitSettlementOperator(address account) external view;
/// @notice revert if the address is not Migrator
/// @param account: the address to check
function requireMigrator(address account) external view;
/// @notice revert if the address is not Validator
/// @param account: the address to check
function requireValidator(address account) external view;
/// @notice revert if the address is not Fund Withdraw Admin
/// @param account: the address to check
function requireFundWithdrawAdmin(address account) external view;
/// @notice get number of required validator signatures for verifiable data
function getRequiredSignatures() external view returns (uint8);
/// @notice set number of required validator signatures for verifiable data
function setRequiredSignatures(uint8 value) external;
/// @notice get number of required initiator signatures for verifiable data
function getRequiredInitiatorSignatures() external view returns (uint8);
/// @notice set number of required initiator signatures for verifiable data
function setRequiredInitiatorSignatures(uint8 value) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
import {IAccountHandler} from "./IAccountHandler.sol";
import {IRequestVerifier} from "./IRequestVerifier.sol";
import {IRewardHandler} from "./IRewardHandler.sol";
import {ISlashHandler} from "./ISlashHandler.sol";
import {IStakeHandler} from "./IStakeHandler.sol";
import {IVestingHandler} from "./IVestingHandler.sol";
bytes4 constant ACCOUNT_HANDLER_ID = type(IAccountHandler).interfaceId;
bytes4 constant REQUEST_VERIFIER_ID = type(IRequestVerifier).interfaceId;
bytes4 constant REWARD_HANDLER_ID = type(IRewardHandler).interfaceId;
bytes4 constant SLASH_HANDLER_ID = type(ISlashHandler).interfaceId;
bytes4 constant STAKE_HANDLER_ID = type(IStakeHandler).interfaceId;
bytes4 constant VESTING_HANDLER_ID = type(IVestingHandler).interfaceId;// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
import {IACLManager} from "./IACLManager.sol";
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
/**
* @title IRegistry
* @notice Defines the basic interface for the Service Registry
*/
interface IRegistry {
/// @notice emitted when the registry is initialized
event Initialized();
/// @notice emitted when the registry is set up
event SetUp(bytes4[] service, address[] impl);
/// @notice emitted when a new service is registered
event SetAddress(bytes4 service, address impl);
/// @notice emitted when the system version is updated
event SetVersion(uint64 value);
/// @notice returns the ACL Manager
function getACLManager() external view returns (IACLManager);
/// @notice returns the ATH token
function getATHToken() external view returns (IERC20);
/// @notice get current implementation address for a service
/// @param service the service typeid
/// @return the address of the implementation
function getAddress(bytes4 service) external view returns (address);
/// @notice register the caller as a new service
/// @param service the service typeid
function register(bytes4 service) external;
/// @notice set new implementation address for a service
/// @param service the service typeid
/// @param impl the address of the implementation
function setAddress(bytes4 service, address impl) external;
/// @notice returns the current system version
function getVersion() external view returns (uint64);
/// @notice registers new system version
/// @param value: new version
function setVersion(uint64 value) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
/**
* @title IRequestVerifier
* @notice Defines the basic interface for the Request Verifier
*/
interface IRequestVerifier {
/// @notice verifiable off-chain data
/// @param nonce: off-chain request id
/// @param deadline: deadline timestamp as seconds since Unix epoch
/// @param lastUpdateBlock: last indexed event blocknumber
/// @param version: system version
/// @param sender: sender address
/// @param target: target contract address
/// @param method: target function selector
/// @param params: request parameters (format according to system version)
/// @param payloads: data payloads (format according to system version)
/// @param proof: data proof (Validator Signature or Merkle Proof)
struct VerifiableData {
uint64 nonce;
uint64 deadline;
uint64 lastUpdateBlock;
uint64 version;
address sender;
address target;
bytes4 method;
bytes params;
bytes payloads;
bytes proof;
}
/// @notice check risk of the request
/// @param method: target function selector
/// @param sender: sender address
function checkRisk(bytes4 method, address sender) external;
/// @notice verify verifiable data with operator signatures
/// @param vdata: verifiable data
/// @param method: target function selector
function verify(
VerifiableData calldata vdata,
address caller,
bytes4 method
) external returns (bytes32 hash);
/// @notice verify verifiable data with initiator signatures
/// @param vdata: verifiable data
/// @param method: target function selector
function verifyInitiator(
VerifiableData calldata vdata,
bytes4 method
) external returns (bytes32 hash);
function getHash(
VerifiableData calldata vdata
) external view returns (bytes32);
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.27;
import {IRequestVerifier} from "./IRequestVerifier.sol";
import {VestingRecord} from "./IVestingHandler.sol";
/// @title IRewardHandler
/// @notice Interface for the RewardHandler contract
interface IRewardHandler {
/// @notice emitted when reward is settled
/// @param epochs reward epochs
/// @param amounts reward amounts
/// @param nonce nonce of the sender
/// @param vhash hash of the vdata
event EmissionScheduleSet(
uint256[] epochs,
uint256[] amounts,
uint64 nonce,
bytes32 vhash
);
/// @notice emitted when reward is settled
/// @param tids array of host id
/// @param gids array of group id
/// @param amounts array of reward amounts
/// @param nonce nonce of the sender
/// @param vhash hash of the vdata
event RewardSettled(
uint256[] tids,
uint256[] gids,
uint256[] amounts,
uint64 nonce,
bytes32 vhash
);
/// @notice emitted when reward is initially settled
/// @param tids array of host id
/// @param gids group id
/// @param record array of record
/// @param nonce nonce of the sender
/// @param vhash hash of the vdata
event RewardInitialSettled(
uint256[] tids,
uint256[] gids,
VestingRecord[] record,
uint64 nonce,
bytes32 vhash
);
/// @notice emitted when reward is settled
/// @param vdata VerifiableData struct
function setEmissionSchedule(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice emitted when reward is settled
/// @param vdata VerifiableData struct
function settleReward(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice emitted when reward is settled
/// @param vdata VerifiableData structs
function initialSettleReward(
IRequestVerifier.VerifiableData calldata vdata
) external;
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.27;
import {VestingRecord} from "./IVestingHandler.sol";
/// @title ISlashHandler
/// @notice Interface for the SlashHandler contract
interface ISlashHandler {
/**
* @notice Processes a new penalty and stores it in the SlashStorage contract.
* @param tid tid;
* @param gid gid;
* @param amount The penalty amount in wei.
* @param container The container of the penalty.
*/
function createTicket(
uint256 tid,
uint256 gid,
uint256 container,
uint256 amount
) external;
/**
* @notice transferring the penalty amount to the SlashDeductionReceiver.
* @param tid tid;
* @param gid gid;
* @param container The container of the penalty.
* @param caller The original sender of the function. Should be the host.
*/
function settlePenalty(
uint256 tid,
uint256 gid,
uint256 container,
address caller
) external returns (uint256);
/**
* @notice Cancels amount of penalty and removes it from the SlashStorage contract.
* @param tid tid;
* @param gid gid;
* @param container The container of the penalty.
* @param amount The penalty amount in wei.
*/
function cancelPenalty(
uint256 tid,
uint256 gid,
uint256 container,
uint256 amount
) external;
/**
* @notice Deducts the penalty amount from alternative balances (e.g., staked tokens or rewards).
* @param tid tid;
* @param gid gid;
* @param container The container of the penalty.
* @param fees The fees to deduct.
* @param rewards The rewards to deduct.
*/
function deductPenalty(
uint256 tid,
uint256 gid,
uint256 container,
VestingRecord calldata fees,
VestingRecord calldata rewards
) external returns (uint256 amount, uint256 slashAmount);
/**
* @notice Refunds tenants to the GrantPool.
* @param tids The list of tenant IDs to refund.
* @param amounts The list of amounts to refund.
*/
function refundTenants(
uint256[] memory tids,
uint256[] memory amounts
) external returns (uint256);
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.27;
import {IRequestVerifier} from "./IRequestVerifier.sol";
import {VestingRecord} from "./IVestingHandler.sol";
/// @title IStakeHandler
/// @notice Interface for the StakeHandler contract
interface IStakeHandler {
/// @notice emitted when a standard stake is made
event StandardStake(
address indexed host,
uint256 tid,
uint256 gid,
uint256[] cids,
uint256[] amounts,
uint256 totalAmount,
uint64 nonce,
bytes32 vhash
);
/// @notice emitted when a delegation stake is made
event DelegationStake(
address indexed delegator,
uint256 tid,
uint256 gid,
uint256[] cids,
uint256[] amounts,
uint256 totalAmount,
uint64 nonce,
bytes32 vhash
);
/// @notice emitted when a standard unstake is made
event Unstake(
address indexed account,
uint256 tid,
uint256 gid,
uint256[] cids,
uint256[] amounts,
uint256 totalAmount,
uint64 nonce,
bytes32 vhash
);
/// @notice emitted when a delegation unstake is made
event DelegationUnstake(
address indexed account,
uint256 tid,
uint256 gid,
uint256[] cids,
uint256[] amounts,
uint256 totalAmount,
uint64 nonce,
bytes32 vhash
);
/// @notice emitted when a delegation unstake is made
event ForceUnstake(
address indexed account,
uint256 tid,
uint256 gid,
uint256[] cids,
uint256[] amounts,
uint256 totalAmount,
uint64 nonce,
bytes32 vhash
);
/// @notice emitted when an initial stake is made
event InitialStake(
address indexed delegator,
uint256 tid,
uint256 gid,
uint256[] cids,
uint256[] amounts,
uint256 totalAmount,
uint64 nonce,
bytes32 vhash
);
/// @notice Emitted when unstake vesting is initially settled
event UnstakeInitialSettled(
uint256[] tids,
uint256[] gids,
VestingRecord[] records,
uint64 nonce,
bytes32 vhash
);
/// @dev The clients should call `approve(address spender, uint256 value)` before calling
/// @notice Standard Staking
/// @param vdata VerifiableData
function stake(IRequestVerifier.VerifiableData calldata vdata) external;
/// @dev The clients should call `approve(address spender, uint256 value)` before calling
/// @notice Delegation Staking
/// @param vdata VerifiableData
function delegationStake(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice Standard Unstaking
/// @param vdata VerifiableData
function unstake(IRequestVerifier.VerifiableData calldata vdata) external;
/// @notice Delegation Unstaking
/// @param vdata VerifiableData
function delegationUnstake(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice Force Unstaking
/// @param vdata VerifiableData
function forceUnstake(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice deduct staked amount
/// @param tid the tenant id
/// @param gid the group id
/// @param cid the container id
/// @param stakedAmount the amount to deduct
function deductStaked(
uint256 tid,
uint256 gid,
uint256 cid,
uint256 stakedAmount
) external;
/// @notice initial settle staking records
/// @param vdata the verifiable data
function initialSettleStakingRecords(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice initial settle unstake vesting records
/// @param vdata the verifiable data
function initialSettleVestingRecords(
IRequestVerifier.VerifiableData calldata vdata
) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
/// @notice Vesting types
enum VestingType {
Stake,
Unstake,
ServiceFee,
Reward
}
/// @notice Vesting record
/// @param amounts array of amounts
/// @param vestingDays array of vesting days
struct VestingRecord {
uint256[] amounts;
uint32[] vestingDays;
}
interface IVestingHandler {
/// @notice Emitted when a new vesting schedule is created
/// @dev beneficiary is the wallet who will receive the vested tokens,
/// beneficiary can be address(0) if the vested tokens go to the host
event VestingCreated(
address indexed beneficiary,
VestingType vestingType,
uint256 tid,
uint256 gid,
VestingRecord records
);
/// @notice Emitted when vested tokens are released
/// @dev beneficiary is the wallet who will receive the vested tokens,
/// beneficiary can be address(0) if the vested tokens go to the host
event VestingReleased(
address indexed beneficiary,
VestingType vestingType,
uint256 tid,
uint256 gid,
VestingRecord records
);
/// @notice Emitted when vested tokens are restaked
event VestingRestaked(
address indexed delegator,
uint256 tid,
uint256 gid,
VestingRecord records,
uint256 restakeFeeAmount
);
/// @notice Emitted when vested tokens are early claimed
/// @dev beneficiary is the wallet who will receive the vested tokens,
/// beneficiary can be address(0) if the vested tokens go to the host
event EarlyClaimed(
address indexed beneficiary,
VestingType vestingType,
uint256 tid,
uint256 gid,
VestingRecord records,
uint256 penaltyAmount,
uint256 penaltyPercentage,
uint256 earlyClaimDays
);
/// @notice Emitted when vested tokens are slashed
event VestingSlashed(
address indexed host,
VestingType vestingType,
uint256 tid,
uint256 gid,
VestingRecord records
);
/// @notice Create a new vesting schedule
/// @param vestingType type of vesting
/// @param tid user tid
/// @param gid group id
/// @param amount amount to vest
function createVesting(
VestingType vestingType,
uint256 tid,
uint256 gid,
uint256 amount
) external;
/// @notice Create a new vesting schedule with custom amounts and vesting days
/// @param vestingType type of vesting
/// @param tid user tid
/// @param gid group id
/// @param record vesting record
function initialVesting(
VestingType vestingType,
uint256 tid,
uint256 gid,
VestingRecord calldata record
) external;
/// @notice Claim vested tokens
/// @param tids user tids
/// @param gids group ids
/// @param fees vesting record
/// @param rewards vesting record
/// @param stakes vesting record
function releaseHostVestedToken(
uint256[] calldata tids,
uint256[] calldata gids,
VestingRecord[] calldata fees,
VestingRecord[] calldata rewards,
VestingRecord[] calldata stakes
) external;
/// @notice Release vested tokens to delegator
/// @param tids user tid
/// @param gids group id
/// @param stakes vesting record
function releaseDelegatorVestedToken(
uint256[] calldata tids,
uint256[] calldata gids,
VestingRecord[] calldata stakes
) external;
/// @notice Release vested tokens to stake fund holder for restake
/// @param tid user tid
/// @param gid group id
/// @param stakes vesting record
/// @dev This function is called by StakeHandler
function restakeVestedToken(
uint256 tid,
uint256 gid,
VestingRecord calldata stakes,
uint256 restakeFeeAmount
) external;
/// @notice Release vested tokens to receiver
/// @param tids user tid
/// @param gids group id
/// @param fees vesting record
/// @param rewards vesting record
function releaseReceiverVestedToken(
uint256[] calldata tids,
uint256[] calldata gids,
VestingRecord[] calldata fees,
VestingRecord[] calldata rewards
) external;
/// @notice Host early claim
/// @param tids user tid
/// @param gids group id
/// @param vestingTypes vesting type
/// @param records vesting record
function hostEarlyClaim(
uint256[] calldata tids,
uint256[] calldata gids,
VestingType[] calldata vestingTypes,
VestingRecord[] calldata records,
uint32 earlyClaimDays
) external;
/// @notice Delegate early claim
/// @param tids user tid
/// @param gids group id
/// @param records vesting record
/// @param earlyClaimDays early claim days
function delegateEarlyClaim(
uint256[] calldata tids,
uint256[] calldata gids,
VestingRecord[] calldata records,
uint32 earlyClaimDays
) external;
/// @notice Receiver early claim
/// @param tids user tid
/// @param gids group id
/// @param vestingTypes vesting type
/// @param records vesting record
/// @param earlyClaimDays early claim days
function receiverEarlyClaim(
uint256[] calldata tids,
uint256[] calldata gids,
VestingType[] calldata vestingTypes,
VestingRecord[] calldata records,
uint32 earlyClaimDays
) external;
/// @notice Settle penalty for slashing.
/// Deducts from Vested Fee, Vested Reward, or Staking in order.
/// Transfers ATH to SlashDeductionReceiver
/// @param tid user tid
/// @param gid group id
/// @param fees vesting record for fees
/// @param rewards vesting record for rewards
function settleSlash(
uint256 tid,
uint256 gid,
VestingRecord calldata fees,
VestingRecord calldata rewards
) external;
/// @notice Release all vested tokens for host
/// @param tids user tid
/// @param gids group id
function releaseHostAllVestedToken(
uint256[] calldata tids,
uint256[] calldata gids,
bool[] calldata releaseServiceFees,
bool[] calldata releaseRewards,
bool[] calldata releaseUnstakes
) external;
/// @notice Release all vested tokens for delegator
/// @param tids user tid
/// @param gids group id
function releaseDelegatorAllVestedToken(
uint256[] calldata tids,
uint256[] calldata gids
) external;
/// @notice Release all vested tokens
/// @param tids user tid
/// @param gids group id
function releaseReceiverAllVestedToken(
uint256[] calldata tids,
uint256[] calldata gids,
bool[] calldata releaseServiceFees,
bool[] calldata releaseRewards
) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "./IStrategy.sol";
/**
* @title Simplified interface for EigenLayer's DelegationManager
* @dev This interface contains only the necessary functions for managing delegations
*/
interface IDelegationManager {
struct QueuedWithdrawalParams {
IStrategy[] strategies;
uint256[] depositShares;
address __deprecated_withdrawer;
}
struct Withdrawal {
address staker;
address delegatedTo;
address withdrawer;
uint256 nonce;
uint32 startBlock;
IStrategy[] strategies;
uint256[] scaledShares;
}
/**
* @notice Allows a staker to queue a withdrawal of their deposit shares
*/
function queueWithdrawals(
QueuedWithdrawalParams[] calldata params
) external returns (bytes32[] memory);
/**
* @notice Used to complete a queued withdrawal after the withdrawal delay has passed
*/
function completeQueuedWithdrawal(
Withdrawal calldata withdrawal,
IERC20[] calldata tokens,
bool receiveAsTokens
) external;
}// SPDX-License-Identifier: MIT
pragma solidity =0.8.27;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
interface IOFT is IERC20 {
function tokenPoolMint(uint256 amount) external;
function tokenPoolBurn(uint256 amount) external;
function send(
uint32 _dstEid,
bytes32 _toAddress,
uint256 _amount,
bytes calldata _options
) external payable;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {MessagingFee} from "@layerzerolabs/oft-evm/contracts/OFTCore.sol";
import {IRequestVerifier} from "./IDCV2/IRequestVerifier.sol";
import {VestingRecord} from "./IDCV2/IVestingHandler.sol";
/// @notice Staker type enum
enum StakerType {
TokenProvider,
CloudHost
}
/// @notice TokenProvider vesting record
struct TPVesting {
uint256 amount; // tokens locked
uint256 vestingEnd; // unlock timestamp
}
interface IStakeBase {
/// @notice Supported token types
enum TokenType {
ATH,
VATH
}
/*//////////////////////////////////////////////////////////////
VIEW
//////////////////////////////////////////////////////////////*/
function minStakeAmount() external view returns (uint256);
function aethir() external view returns (IERC20);
function dstEid() external view returns (uint32);
function providedTokens(address user) external view returns (uint256);
function userTokenTypes(address user) external view returns (TokenType);
function cloudHostPendingWithdrawal(
address user
) external view returns (uint256);
function tokenConfigs(
TokenType t
)
external
view
returns (IERC20 token, bool enabled, uint256 vestingDuration);
function registeredVaults(address vault) external view returns (TokenType);
function stakeBases(uint32 eid) external view returns (address);
/*//////////////////////////////////////////////////////////////
ADMIN
//////////////////////////////////////////////////////////////*/
function configureToken(
TokenType t,
IERC20 token,
bool enabled,
uint256 vestingDuration
) external;
function registerVault(
address vault,
address tokenAddr,
TokenType t
) external;
function registerStakeBase(uint32 eid, address stakeBase) external;
/*//////////////////////////////////////////////////////////////
TOKEN PROVIDER FLOWS
//////////////////////////////////////////////////////////////*/
function stake(uint256 amount, TokenType t) external payable;
function unstakeRequest(uint256 amount) external payable;
function unstake(uint256 vestingId) external payable;
function claim() external payable;
function claimRewards() external payable;
}// SPDX-License-Identifier: MIT
pragma solidity 0.8.27;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
/**
* @title Interface for EigenLayer's Strategy
* @notice Simplified interface with only necessary parts for ATHVault integration
*/
interface IStrategy {
/**
* @notice The underlying token for shares in this Strategy
* @return The underlying ERC20 token
*/
function underlyingToken() external view returns (IERC20);
/**
* @notice The total number of extant shares in this Strategy
*/
function totalShares() external view returns (uint256);
/**
* @notice Used to convert a number of shares to the equivalent amount of underlying tokens
*/
function sharesToUnderlyingView(
uint256 amountShares
) external view returns (uint256);
/**
* @notice Used to convert an amount of underlying tokens to shares
*/
function underlyingToSharesView(
uint256 amountUnderlying
) external view returns (uint256);
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "./IStrategy.sol";
/**
* @title Simplified interface for EigenLayer's StrategyManager
* @dev This interface contains only the necessary functions for deposit/withdrawal
*/
interface IStrategyManager {
/**
* @notice Deposits `amount` of `token` into the specified `strategy` and credits shares to the caller
* @param strategy the strategy that handles `token`
* @param token the token from which the `amount` will be transferred
* @param amount the number of tokens to deposit
* @return depositShares the number of deposit shares credited to the caller
*/
function depositIntoStrategy(
IStrategy strategy,
IERC20 token,
uint256 amount
) external returns (uint256 depositShares);
/**
* @notice Returns the current shares of `user` in `strategy`
*/
function stakerDepositShares(
address user,
IStrategy strategy
) external view returns (uint256 shares);
}
/**
* @title Simplified interface for EigenLayer's DelegationManager
* @dev This interface contains only the necessary functions for managing delegations
*/
interface IDelegationManager {
struct QueuedWithdrawalParams {
IStrategy[] strategies;
uint256[] depositShares;
address __deprecated_withdrawer;
}
struct WithdrawalDataStruct {
address staker;
address delegatedTo;
address withdrawer;
uint256 nonce;
uint32 startBlock;
IStrategy[] strategies;
uint256[] scaledShares;
}
/**
* @notice Allows a staker to queue a withdrawal of their deposit shares
*/
function queueWithdrawals(
QueuedWithdrawalParams[] calldata params
) external returns (bytes32[] memory);
/**
* @notice Used to complete a queued withdrawal after the withdrawal delay has passed
*/
function completeQueuedWithdrawal(
WithdrawalDataStruct calldata withdrawal,
IERC20[] calldata tokens,
bool receiveAsTokens
) external;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
import {MessagingFee} from "@layerzerolabs/oft-evm/contracts/OFTCore.sol";
import "./IDCV2/IRequestVerifier.sol";
import "./IDCV2/IVestingHandler.sol";
/// @notice Types of stakers in the pool
enum StakerType {
TokenProvider,
CloudHost
}
/// @notice Summary of a staker's position
struct Staker {
uint256 stakedAmount; // effective stake (weighted)
uint256 pendingWithdrawal; // queued withdrawals (vesting)
uint256 rewardDebt; // accounting checkpoint
uint256 unclaimedRewards; // accrued but unclaimed
}
/// @notice Vesting record for TokenProviders
struct TPVesting {
uint256 amount; // tokens locked
uint256 vestingEnd; // timestamp when unlocked
}
/// @title ITokenPool
/// @notice Central reward‐ledger and cross-chain router
interface ITokenPool {
/*//////////////////////////////////////////////////////////////
ERRORS
//////////////////////////////////////////////////////////////*/
error InvalidStakerType();
error NoStakeBaseRegistered(uint16 chainId);
error NoRewards();
error InsufficientCloudStake();
error InvalidFee();
/*//////////////////////////////////////////////////////////////
EVENTS
//////////////////////////////////////////////////////////////*/
// Event definitions moved to TokenPool.sol
// event StakeBaseRegistered(uint16 indexed chainId, address stakeBase);
// event RewardTaxUpdated(uint16 taxBps, address collector);
// event DepositTaxUpdated(uint16 taxBps);
//
// // TP Events
// event StakeReceived(address indexed staker, uint256 amount);
// event UnstakeRequested(
// address indexed staker,
// uint256 amount,
// uint256 duration,
// uint256 indexed internalIndex // Represents tpVestingCounter[staker] at time of request
// );
// event UnstakeCompleted(
// address indexed staker,
// uint256 indexed internalIndex, // Matches index from UnstakeRequested
// uint256 amount
// );
//
// // CH Events
// event DelegatedStake(IRequestVerifier.VerifiableData vdata, uint256 amount);
// event DelegatedUnstake(IRequestVerifier.VerifiableData vdata);
// event DelegatedUnstakeCompleted(address indexed staker, uint256 amount); // CH gets principal back in pool
//
// // Reward Events
// event RewardsAdded(uint256 amount);
// event RewardClaimed(
// address indexed staker, // Changed from 'user'
// uint256 amount,
// StakerType stType
// );
//
// // LZ/Internal Events
// event ClaimResponseFailed(address vault, uint256 amount); // Callback failure
/*//////////////////////////////////////////////////////////////
ADMIN
//////////////////////////////////////////////////////////////*/
/// @notice Register a StakeBase on another chain
function registerStakeBase(uint16 chainId, address stakeBase) external;
/// @notice Set a fee (bps) on all reward claims, paid to `collector`
function setRewardTax(uint16 taxBps, address collector) external;
/// @notice Set a fee (bps) on all deposits, paid to the fee collector
function setDepositTax(uint16 taxBps) external;
/*//////////////////////////////////////////////////////////////
VIEW FUNCTIONS
//////////////////////////////////////////////////////////////*/
/// @notice Quote a cross-chain message fee
function quote(
uint16 dstEid,
bytes calldata message,
bytes calldata options,
bool payInLzToken
) external view returns (MessagingFee memory);
/// @notice Get a staker's full position
function getStaker(
address staker,
StakerType stType
) external view returns (Staker memory);
/// @notice Pending reward amount (not including tax)
function pendingReward(
address staker,
StakerType stType
) external view returns (uint256);
/*//////////////////////////////////////////////////////////////
CLOUD-HOST FLOWS
//////////////////////////////////////////////////////////////*/
/// @notice Stake via delegation (cloud host)
function delegatedStake(
IRequestVerifier.VerifiableData calldata vdata,
uint256 hostAmount
) external;
/// @notice Unstake via delegation (cloud host)
function delegatedUnstake(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice Claim tokens after cloud-host vesting completes
function claimDelegationUnstakedTokens(
uint256 tid,
uint256 gid,
VestingRecord calldata stakes
) external;
/*//////////////////////////////////////////////////////////////
REWARD FUNCTIONS
//////////////////////////////////////////////////////////////*/
/// @notice Admin deposits new rewards (pull-through) via signed vdata
function addRewards(
IRequestVerifier.VerifiableData calldata vdata
) external;
/// @notice Claim your share of rewards; fee must be provided
function claimRewards(StakerType stType) external payable;
/// @notice Claim rewards to a specific address; fee must be provided
function claimRewardsTo(
address rewardAddress,
StakerType stType
) external payable;
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {IDelegationManager} from "./IDelegationManager.sol";
/// @title IVault
/// @notice Interface for ATHVault after vault-side vesting removed:
/// users only wait EigenLayer's 7 d cooldown; vATH vesting is 0 d in TokenPool.
interface IVault {
/// @notice Emitted when a user pre-deposits ATH.
event PreDeposit(address indexed user, uint256 amount);
/// @notice Emitted when core staking is enabled/disabled.
event StakingEnabledChanged(bool enabled);
/// @notice Emitted when a user deposits ATH.
event Deposit(address indexed user, uint256 amount);
/// @notice Emitted when ATH is staked into EigenLayer.
event DepositToStrategy(
address indexed user,
uint256 amount,
uint256 shares
);
/// @notice Emitted when a pre-deposit is activated into StakeBase.
event ActivatePreDeposit(address indexed user, uint256 amount);
/// @notice Emitted when a user initiates an unstake request.
event UnstakeInitiated(address indexed user, uint256 amount);
/// @notice Emitted when an EigenLayer withdrawal is queued.
event WithdrawalFromStrategyQueued(
address indexed user,
uint256 amount,
bytes32 root
);
/// @notice Emitted when a user finally receives withdrawn principal.
event Withdraw(address indexed user, uint256 amount);
/// @notice Emitted when rewards from StakeBase are distributed.
event RewardDistributed(uint256 amount);
/// @notice Emitted when a user claims vault-level rewards.
event RewardClaimed(address indexed user, uint256 amount);
/// @notice Emitted when the StakeBase address is set.
event StakeBaseSet(address indexed stakeBase);
/// @notice Emitted when the vault's deposit cap changes.
event DepositCapChanged(uint256 newCap);
/// @notice Emitted when admin locks or unlocks withdrawals.
event WithdrawLockChanged(bool newStatus);
/// @notice Sets the StakeBase contract.
function setStakeBase(address sb) external;
/// @notice Enables or disables staking functions.
function setStakingEnabled(bool enabled) external;
/// @notice Configures EigenLayer integration.
function configureEigen(
address strategyManager,
address strategy,
address delegationManager
) external;
/// @notice Pre-deposit ATH before staking is live.
function preDeposit(uint256 amount) external;
/// @notice Activate a batch of pre-deposits into StakeBase.
function activatePreDepositsBatch(uint256 batchSize) external payable;
/// @notice Deposit ATH when staking is live.
function deposit(uint256 amount) external payable;
/// @notice Kick off an unstake: burns eATH, queues EigenLayer & vATH-unstake.
function initiateUnstake(uint256 amount) external payable;
/// @notice Complete your EigenLayer withdrawal after the 7 d cooldown.
/// @param withdrawal The withdrawal params from DelegationManager.
/// @param tokens The reward tokens array (e.g. [ATH]).
/// @param middlewareTimes Array of timestamps for middleware hooks.
function completeUnstake(
IDelegationManager.Withdrawal calldata withdrawal,
IERC20[] calldata tokens,
uint32[] calldata middlewareTimes
) external;
/// @notice Claim rewards from StakeBase (operator only).
function claimRewardsFromStakeBase() external payable;
/// @notice Claim your accrued vault rewards.
function claimRewards() external;
/// @notice Callback for StakeBase to report reward tokens.
function handleStakeBaseRewards(uint256 amount) external;
/// @notice Function merged from IAthVault
function onLocalEATHTransfer(
address from,
address to,
uint256 amount
) external;
/// @notice Function merged from IAthVault
function handleEATHBridgedOut(
address userDeparting,
uint256 amountBridged,
uint32 destinationEid
) external returns (bool);
/// @notice Function merged from IAthVault
function handleEATHBridgedIn(
address userArriving,
uint256 amountBridged,
uint32 sourceChainEid
) external returns (bool);
}// SPDX-License-Identifier: MIT
pragma solidity =0.8.27;
interface IWAethir {
/**
* @dev Mints `value` tokens to the `account`.
* @param account The address to mint tokens to.
* @param value The amount of tokens to mint.
*/
function mint(address account, uint256 value) external;
/**
* @dev Burns `value` tokens from the `account`.
* @param account The address to burn tokens from.
* @param value The amount of tokens to burn.
*/
function burn(address account, uint256 value) external;
}// SPDX-License-Identifier: MIT
pragma solidity =0.8.27;
library Messages {
// Message type constants
bytes32 internal constant TP_STAKE = keccak256("TP_STAKE");
bytes32 internal constant TP_UNSTAKE_REQUEST =
keccak256("TP_UNSTAKE_REQUEST");
bytes32 internal constant TP_UNSTAKE_RESPONSE =
keccak256("TP_UNSTAKE_RESPONSE");
bytes32 internal constant TP_UNSTAKE = keccak256("TP_UNSTAKE");
bytes32 internal constant TP_CLAIM = keccak256("TP_CLAIM");
bytes32 internal constant TP_UNSTAKE_REQUEST_WITH_DURATION =
keccak256("TP_UNSTAKE_REQUEST_WITH_DURATION");
bytes32 internal constant TP_CLAIM_RESPONSE =
keccak256("TP_CLAIM_RESPONSE");
// --------------------
// Encoding functions
// --------------------
function encodeStake(
address provider,
uint256 amount
) internal pure returns (bytes memory) {
return abi.encode(TP_STAKE, provider, amount);
}
function encodeUnstakeRequest(
address provider,
uint256 amount
) internal pure returns (bytes memory) {
return abi.encode(TP_UNSTAKE_REQUEST, provider, amount);
}
function encodeUnstakeRequestWithDuration(
address provider,
uint256 amount,
uint256 duration
) internal pure returns (bytes memory) {
return
abi.encode(
TP_UNSTAKE_REQUEST_WITH_DURATION,
provider,
amount,
duration
);
}
function encodeUnstakeResponse(
address provider,
uint256 amount
) internal pure returns (bytes memory) {
return abi.encode(TP_UNSTAKE_RESPONSE, provider, amount);
}
function encodeUnstake(
address provider,
uint256 vestingId
) internal pure returns (bytes memory) {
return abi.encode(TP_UNSTAKE, provider, vestingId);
}
function encodeClaim(
address provider,
address rewardAddress,
address vault
) internal pure returns (bytes memory) {
return abi.encode(TP_CLAIM, provider, rewardAddress, vault);
}
function encodeClaimResponse(
address provider,
uint256 amount,
address vault
) internal pure returns (bytes memory) {
return abi.encode(TP_CLAIM_RESPONSE, provider, amount, vault);
}
// --------------------
// Decoding functions
// --------------------
/**
* Decodes a stake message.
* Expects encoding: (TP_STAKE, provider, amount)
*/
function decodeStake(
bytes memory message
) internal pure returns (address provider, uint256 amount) {
bytes32 action;
(action, provider, amount) = abi.decode(
message,
(bytes32, address, uint256)
);
require(action == TP_STAKE, "Invalid action for stake decode");
}
/**
* Decodes an unstake-request message.
* Expects encoding: (TP_UNSTAKE_REQUEST, provider, amount)
*/
function decodeUnstakeRequest(
bytes memory message
) internal pure returns (address provider, uint256 amount) {
bytes32 action;
(action, provider, amount) = abi.decode(
message,
(bytes32, address, uint256)
);
require(
action == TP_UNSTAKE_REQUEST,
"Invalid action for unstake request decode"
);
}
/**
* Decodes an unstake-request message with custom duration.
* Expects encoding: (TP_UNSTAKE_REQUEST_WITH_DURATION, provider, amount, duration)
*/
function decodeUnstakeRequestWithDuration(
bytes memory message
)
internal
pure
returns (address provider, uint256 amount, uint256 duration)
{
bytes32 action;
(action, provider, amount, duration) = abi.decode(
message,
(bytes32, address, uint256, uint256)
);
require(
action == TP_UNSTAKE_REQUEST_WITH_DURATION,
"Invalid action for unstake request with duration decode"
);
}
/**
* Decodes an unstake-response message.
* Expects encoding: (TP_UNSTAKE_RESPONSE, provider, amount)
* Note: The message is expected to have the 32-byte action header already removed.
*/
function decodeUnstakeResponse(
bytes memory message
) internal pure returns (address provider, uint256 amount) {
// Handle messages with and without action prefix differently
if (message.length >= 96) {
// Full message length (32 bytes action + 32 bytes address + 32 bytes amount)
// Try to decode with action prefix
bytes32 action;
(action, provider, amount) = abi.decode(
message,
(bytes32, address, uint256)
);
require(
action == TP_UNSTAKE_RESPONSE,
"Invalid action for unstake response decode"
);
} else {
// Just the payload without action prefix
(provider, amount) = abi.decode(message, (address, uint256));
}
}
/**
* Decodes an unstake message.
* Expects encoding: (TP_UNSTAKE, provider, vestingId)
*/
function decodeUnstake(
bytes memory message
) internal pure returns (address provider, uint256 vestingId) {
bytes32 action;
(action, provider, vestingId) = abi.decode(
message,
(bytes32, address, uint256)
);
require(action == TP_UNSTAKE, "Invalid action for unstake decode");
}
/**
* Decodes a claim message.
* Expects encoding: (TP_CLAIM, provider, rewardAddress, vault)
*/
function decodeClaim(
bytes memory message
)
internal
pure
returns (address provider, address rewardAddress, address vault)
{
bytes32 action;
(action, provider, rewardAddress, vault) = abi.decode(
message,
(bytes32, address, address, address)
);
require(action == TP_CLAIM, "Invalid action for claim decode");
}
/**
* Decodes a claim response message.
* Expects encoding: (TP_CLAIM_RESPONSE, vault, amount, vault)
* Note: The message can be a full message or just the payload.
*/
function decodeClaimResponse(
bytes memory message
) internal pure returns (address provider, uint256 amount, address vault) {
// Handle messages with and without action prefix differently
if (message.length >= 128) {
// Full message length (32 + 32 + 32 + 32)
// Try to decode with action prefix
bytes32 action;
(action, provider, amount, vault) = abi.decode(
message,
(bytes32, address, uint256, address)
);
require(
action == TP_CLAIM_RESPONSE,
"Invalid action for claim response decode"
);
} else {
// Just the payload without action prefix
(provider, amount, vault) = abi.decode(
message,
(address, uint256, address)
);
}
}
function isValidAction(bytes32 action) internal pure returns (bool) {
return (action == TP_STAKE ||
action == TP_UNSTAKE_REQUEST ||
action == TP_UNSTAKE_RESPONSE ||
action == TP_UNSTAKE ||
action == TP_CLAIM ||
action == TP_UNSTAKE_REQUEST_WITH_DURATION ||
action == TP_CLAIM_RESPONSE);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
/// @title PullRewards
/// @notice A shared pull‑through reward library.
/// Supports weighted staking via `effectiveAmount`.
library PullRewards {
// Internal scaling factor for fixed‑point arithmetic.
uint256 internal constant SCALING_FACTOR = 1e12;
/// @notice Per‑user reward state.
struct Staker {
uint256 stakedAmount; // weighted stake
uint256 rewardDebt; // per‑share checkpoint
uint256 unclaimedRewards; // accrued but unclaimed
}
/// @notice Global reward data.
struct Data {
uint256 totalStaked; // sum of effective stakes
uint256 accRewardPerShare; // accumulated rewards per share
mapping(address => Staker) stakers;
}
/// @dev Update `user`'s unclaimedRewards to current state.
function _update(Data storage self, address user) private {
Staker storage st = self.stakers[user];
if (st.stakedAmount == 0) return;
uint256 accumulated = (st.stakedAmount * self.accRewardPerShare) /
SCALING_FACTOR;
uint256 pending = accumulated > st.rewardDebt
? accumulated - st.rewardDebt
: 0;
st.unclaimedRewards += pending;
}
/// @notice Record a new stake.
/// @param amount Raw tokens staked.
/// @param effectiveAmount Weighted stake (e.g. amount×weight).
function stake(
Data storage self,
address user,
uint256 amount,
uint256 effectiveAmount
) internal {
require(amount > 0, "PR: zero stake");
require(effectiveAmount > 0, "PR: zero effective");
_update(self, user);
Staker storage st = self.stakers[user];
st.stakedAmount += effectiveAmount;
self.totalStaked += effectiveAmount;
st.rewardDebt =
(st.stakedAmount * self.accRewardPerShare) /
SCALING_FACTOR;
}
/// @notice Remove a stake.
/// @param amount Raw tokens withdrawn.
/// @param effectiveAmount Weighted stake to remove.
function withdraw(
Data storage self,
address user,
uint256 amount,
uint256 effectiveAmount
) internal {
require(amount > 0, "PR: zero withdraw");
require(effectiveAmount > 0, "PR: zero effective");
Staker storage st = self.stakers[user];
require(st.stakedAmount >= effectiveAmount, "PR: insufficient stake");
_update(self, user);
st.stakedAmount -= effectiveAmount;
self.totalStaked -= effectiveAmount;
// If the staker has fully withdrawn, reset rewardDebt to prevent issues when re-staking
if (st.stakedAmount == 0) {
st.rewardDebt = 0;
} else {
st.rewardDebt =
(st.stakedAmount * self.accRewardPerShare) /
SCALING_FACTOR;
}
}
/// @notice Distribute `amount` rewards across all stakers.
function addRewards(Data storage self, uint256 amount) internal {
require(amount > 0, "PR: zero reward");
require(self.totalStaked > 0, "PR: no stakers");
self.accRewardPerShare += (amount * SCALING_FACTOR) / self.totalStaked;
}
/// @notice Claim accrued rewards for `user`.
/// @return reward The amount claimed.
function claimReward(
Data storage self,
address user
) internal returns (uint256 reward) {
_update(self, user);
Staker storage st = self.stakers[user];
reward = st.unclaimedRewards;
if (reward > 0) {
st.unclaimedRewards = 0;
st.rewardDebt =
(st.stakedAmount * self.accRewardPerShare) /
SCALING_FACTOR;
}
}
/// @notice View the pending rewards for `user`.
function pendingReward(
Data storage self,
address user
) internal view returns (uint256) {
Staker storage st = self.stakers[user];
uint256 accumulated = (st.stakedAmount * self.accRewardPerShare) /
SCALING_FACTOR;
uint256 pending = accumulated > st.rewardDebt
? accumulated - st.rewardDebt
: 0;
return st.unclaimedRewards + pending;
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { IDelegationManager } from "../interfaces/IDelegationManager.sol";
import { IStrategy } from "../interfaces/IStrategy.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { MockStrategyManager } from "./MockStrategyManager.sol"; // Import mock
// Basic mock for IDelegationManager
contract MockDelegationManager is IDelegationManager {
uint256 public withdrawalRootCounter = 1;
mapping(bytes32 => bool) public pendingWithdrawals; // Keyed by hash-based root
mapping(bytes32 => Withdrawal) internal _queuedWithdrawalsDataByHash; // Keyed by hash-based root
mapping(address => uint256) public cumulativeWithdrawalsQueued; // Track nonces
address public mockStrategyManagerAddr;
address public strategyManager;
address public staker;
uint256 public nonce;
uint32 public constant MIN_WITHDRAWAL_DELAY_BLOCKS = 10;
bytes32 nextExpectedRoot; // State variable to hold the root to return
QueuedWithdrawalParams public lastQueuedWithdrawalParams; // Store last params for inspection
// Function to allow test to set the root that queueWithdrawals should return
function setNextExpectedRoot(bytes32 _root) external {
nextExpectedRoot = _root;
}
// Allow setting the mock strategy manager address
function setStrategyManager(address _strategyManager) external {
mockStrategyManagerAddr = _strategyManager;
strategyManager = _strategyManager;
}
function setStaker(address _staker) external {
staker = _staker;
}
function setNonce(uint256 _nonce) external {
nonce = _nonce;
}
// Mock implementation for increaseDelegatedShares (called by MockStrategyManager)
function increaseDelegatedShares(
address /* staker */,
IStrategy /* strategy */,
uint256 /* prevDepositShares */,
uint256 /* addedShares */
) external {
// No-op for the mock, only needs to accept the call if tested
}
function queueWithdrawals(
QueuedWithdrawalParams[] calldata withdrawalsToQueue
) external override returns (bytes32[] memory withdrawalRoots) {
withdrawalRoots = new bytes32[](withdrawalsToQueue.length);
require(withdrawalsToQueue.length == 1, "Mock only handles batch size 1"); // Simplify mock
// Use the pre-set root if available, otherwise generate one
if (nextExpectedRoot != bytes32(0)) {
withdrawalRoots[0] = nextExpectedRoot;
nextExpectedRoot = bytes32(0); // Reset after use
} else {
// Default mock root generation if not pre-set
withdrawalRoots[0] = bytes32(
keccak256(
abi.encodePacked(
withdrawalsToQueue[0].strategies[0],
withdrawalsToQueue[0].depositShares[0],
block.timestamp // Add some variance if needed
)
)
);
}
// Store params for inspection
lastQueuedWithdrawalParams = withdrawalsToQueue[0];
return withdrawalRoots;
}
function completeQueuedWithdrawal(
Withdrawal calldata withdrawal,
IERC20[] calldata tokens,
bool /* receiveAsTokens */ // Match interface signature
) external override /* returns (uint256) removed */ {
// Match interface return type (void)
// Minimal mock implementation
require(tokens.length == 1, "MockDM: completeQueuedWithdrawal expects 1 token");
require(withdrawal.strategies.length == 1, "MockDM: completeQueuedWithdrawal expects 1 strategy in withdrawal");
require(withdrawal.scaledShares.length == 1, "MockDM: completeQueuedWithdrawal expects 1 scaledShare amount");
IERC20 tokenToReturn = tokens[0];
uint256 amountToReturn = withdrawal.scaledShares[0];
// This mock simulates that EigenLayer has returned the funds to the Vault (which is msg.sender to this function call).
// The test should `deal` the `amountToReturn` of `tokenToReturn` to this MockDelegationManager contract address.
// Then, this mock transfers it to the VAULT (msg.sender).
require(
tokenToReturn.balanceOf(address(this)) >= amountToReturn,
"MockDM: Insufficient funds to simulate transfer to Vault"
);
tokenToReturn.transfer(msg.sender, amountToReturn); // Transfer to msg.sender (the Vault calling this)
}
function minWithdrawalDelayBlocks() external view returns (uint32) {
return MIN_WITHDRAWAL_DELAY_BLOCKS;
}
// --- Mock specific helper ---
// function getQueuedWithdrawalData(bytes32 root) external view returns (Withdrawal memory) { // Removed getter
// // This getter is problematic as test uses counterRoot, but data is keyed by hashRoot now
// return _queuedWithdrawalsDataByHash[root]; // Would need hashRoot as input
// }
// Add other necessary functions from IDelegationManager if needed by tests,
// otherwise leave them unimplemented or reverting.
function delegatedTo(address) external view returns (address) {
revert("Not implemented in mock");
}
function stakerNonce(address /* override */) external view returns (uint256) {
revert("Not implemented in mock");
}
function calculateWithdrawalRoot(
Withdrawal calldata /*withdrawal*/ // Input can be ignored for simple mock
) external view returns (bytes32) {
// Removed override, not in simplified interface
require(nextExpectedRoot != bytes32(0), "MockDM: nextExpectedRoot not set for calculateWithdrawalRoot");
bytes32 rootToReturn = nextExpectedRoot;
// Do not reset nextExpectedRoot here, as the vault might call this, then use the root for other things
// The test is responsible for managing setNextExpectedRoot calls.
return rootToReturn;
}
function domainSeparator() external view returns (/* override */ bytes32) {
revert("Not implemented in mock");
}
function pause(uint256) external returns (uint256) {
revert("Not implemented in mock");
}
function unpause(uint256) external returns (uint256) {
revert("Not implemented in mock");
}
function paused(uint256) external view returns (bool) {
revert("Not implemented in mock");
}
function pauserRegistry() external view returns (address) {
revert("Not implemented in mock");
}
function getWithdrawalDelay(IStrategy[] calldata) external view returns (uint256) {
revert("Not implemented in mock");
}
function getCurrentNonce() external view returns (uint256) {
revert("Not implemented in mock");
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
// Very basic ERC20 mock for testing purposes
contract MockERC20 is ERC20 {
constructor(
string memory name_,
string memory symbol_,
uint8 decimals_
) ERC20(name_, symbol_) {
// _setupDecimals(decimals_); // This function is internal and not needed for basic mock
// For mocks, decimals are often assumed or checked elsewhere.
// If explicit setting is needed, consider inheriting from a different base or adding a setter.
}
function mint(address to, uint256 amount) external {
_mint(to, amount);
}
function burn(address from, uint256 amount) external {
_burn(from, amount);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import { IStakeBase } from "../interfaces/IStakeBase.sol";
import { IVault } from "../interfaces/IVault.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { MockERC20 } from "./MockERC20.sol"; // Import MockERC20 for stub return
// Define the struct locally for the mock
struct TokenConfigLocal {
IERC20 token; // Changed from string name to IERC20
bool enabled;
uint256 vestDuration;
}
// Basic mock for IStakeBase
contract MockStakeBase is IStakeBase {
mapping(IStakeBase.TokenType => TokenConfigLocal) public tokenConfigsData; // Use local struct
mapping(address => address) public vaultTokenMap; // No longer used by registerVault
mapping(address => IStakeBase.TokenType) public registeredVaultsData; // Map vault address to token type
mapping(address => bool) public isVaultRegistered; // Keep for simple check if needed
address public vaultAddressForCallback; // Store the specific vault address
uint256 public defaultVestDuration = 1 days;
MockERC20 public mockAthForReturn; // Store a mock token instance
constructor() {
mockAthForReturn = new MockERC20("MockATH", "mATH", 18);
}
// --- Implementations ---
function registerVault(address vault, address tokenAddr, IStakeBase.TokenType t) external override {
isVaultRegistered[vault] = true;
registeredVaultsData[vault] = t;
vaultAddressForCallback = vault; // Store the vault address for callbacks
// Setup a default config for testing if not already present
if (!tokenConfigsData[t].enabled) {
// Use enabled flag as indicator
tokenConfigsData[t] = TokenConfigLocal({
token: tokenAddr == address(0)
? mockAthForReturn // Use mock if address(0) is provided
: IERC20(tokenAddr), // Use the provided token address otherwise
enabled: true,
vestDuration: defaultVestDuration
});
}
}
function stake(uint256 amount, IStakeBase.TokenType t) external payable override {
// Simulate pulling the token from the caller (vault)
TokenConfigLocal storage config = tokenConfigsData[t];
if (address(config.token) != address(0) && amount > 0) {
config.token.transferFrom(msg.sender, address(this), amount);
}
// Original mock logic (if any) can remain or be added below
// No-op for mock besides token pull
}
function unstakeRequest(uint256 amount) external payable override {
// Remove the immediate callback to prevent reentrancy issues in tests
// The handleUnstakeCompletion function should be tested separately,
// simulating a call *from* StakeBase.
/*
if (vaultCallbackTarget != address(0)) {
IVault(vaultCallbackTarget).handleUnstakeCompletion(
msg.sender, // This assumes msg.sender is the user, which is wrong. Vault calls this.
amount
);
}
*/
// Mock only needs to accept the call for requestWithdraw tests
// _; // Remove placeholder
}
function unstake(uint256 vestingId) external payable override {
// No-op for mock
}
function claimRewards() external payable override {
if (vaultAddressForCallback != address(0)) {
IVault(vaultAddressForCallback).handleStakeBaseRewards(1 ether);
}
}
// --- View Functions (Matching Interface) ---
function tokenConfigs(
IStakeBase.TokenType t
) external view override returns (IERC20 token, bool enabled, uint256 vestDuration) {
// Updated return types
TokenConfigLocal storage config = tokenConfigsData[t];
// Return default mock token if not configured
return (config.enabled ? config.token : mockAthForReturn, config.enabled, config.vestDuration);
}
function registeredVaults(address vault) external view override returns (IStakeBase.TokenType) {
return registeredVaultsData[vault];
}
// --- Stubs for Missing Functions ---
function aethir() external view override returns (IERC20) {
return mockAthForReturn; // Return mock token
}
function claim() external payable override {
// No-op stub
}
function cloudHostPendingWithdrawal(address user) external view override returns (uint256) {
return 0; // Default value
}
function configureToken(
IStakeBase.TokenType t,
IERC20 token,
bool enabled,
uint256 vestingDuration
) external override {
tokenConfigsData[t] = TokenConfigLocal({ token: token, enabled: enabled, vestDuration: vestingDuration }); // Use local struct
}
function dstEid() external view override returns (uint32) {
return 0; // Default value, can be made configurable for tests
}
function minStakeAmount() external view override returns (uint256) {
return 1 ether; // Default value
}
function providedTokens(address user) external view override returns (uint256) {
return 0; // Default value
}
function registerStakeBase(
uint32 eid, // Changed from uint16 chainId to uint32 eid
address stakeBase
) external override {
// No-op stub or basic mock logic if needed for tests
// For example: mockRegisteredStakeBases[eid] = stakeBase;
}
function stakeBases(
uint32 eid // Changed from uint16 chainId to uint32 eid
) external view override returns (address) {
return address(0); // Default value, can be made configurable for tests
// For example: return mockRegisteredStakeBases[eid];
}
function userTokenTypes(address user) external view override returns (IStakeBase.TokenType) {
// Return default, real logic needed if used in tests
return IStakeBase.TokenType.ATH;
}
// --- Mock Specific Helper ---
function setVaultCallbackTarget(address target) external {
// vaultCallbackTarget = target; // Deprecated
vaultAddressForCallback = target; // Use the new variable
}
// Removed as StakeBase no longer calls back in the simplified flow
/*
// New function to simulate the callback completion trigger
function mockCompleteUnstake(address user, uint256 amount) external {
// Simulate StakeBase calling the Vault's handler
if (vaultAddressForCallback != address(0)) {
// The msg.sender inside handleUnstakeCompletion will be this mock contract
IVault(vaultAddressForCallback).handleUnstakeCompletion(user, amount);
}
// Note: In real contract, tokens would likely be transferred to 'user' here,
// but we omit that for this mock to focus on the callback.
}
*/
// Removed setVestDuration as configureToken provides this
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import { IStrategy } from "../interfaces/IStrategy.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
// Basic mock for IStrategy
contract MockStrategy is IStrategy {
IERC20 public immutable _underlyingToken;
constructor(IERC20 underlyingToken_) {
_underlyingToken = underlyingToken_;
}
function deposit(IERC20 token, uint256 amount) external payable returns (uint256 shares) {
// Simple mock: 1 share per amount
shares = amount;
// In a real scenario, would transfer token
return shares;
}
function underlyingToken() external view override returns (IERC20) {
return _underlyingToken;
}
// --- Stubs for Missing Functions ---
function totalShares() external view override returns (uint256) {
// Simple mock - assumes 1:1 deposit amount is total shares for simplicity
// A more complex mock might track this based on deposits.
return _underlyingToken.totalSupply(); // Or return a fixed value like 0
}
function sharesToUnderlyingView(uint256 amountShares) external view override returns (uint256) {
// Simple 1:1 mock
return amountShares;
}
function underlyingToSharesView(uint256 amountUnderlying) external view override returns (uint256) {
// Simple 1:1 mock
return amountUnderlying;
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import { IStrategyManager } from "../interfaces/IStrategyManager.sol";
import { IStrategy } from "../interfaces/IStrategy.sol";
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { IDelegationManager } from "../interfaces/IDelegationManager.sol";
// Basic mock for IStrategyManager
contract MockStrategyManager is IStrategyManager {
using SafeERC20 for IERC20;
mapping(address => mapping(IStrategy => uint256)) public _stakerDepositShares;
// Removed old mappings no longer needed with the new logic
address public mockDelegationManagerAddr;
function setDelegationManager(address _delegationManager) external {
mockDelegationManagerAddr = _delegationManager;
}
function depositIntoStrategy(IStrategy strategy, IERC20 token, uint256 amount) external returns (uint256 shares) {
uint256 initialShares = _stakerDepositShares[msg.sender][strategy];
_stakerDepositShares[msg.sender][strategy] += amount; // Simple 1:1 share mock
shares = amount;
// Simulate the transfer of the underlying token (ATH) from the Vault to this mock Strategy Manager
token.safeTransferFrom(msg.sender, address(this), amount);
// Optional: Call mock delegation manager
// if (mockDelegationManagerAddr != address(0)) { // Removed call to non-existent interface function
// IDelegationManager(mockDelegationManagerAddr)
// .increaseDelegatedShares(
// msg.sender,
// strategy,
// initialShares, // Pass previous shares
// shares // Pass added shares
// );
// }
return shares;
}
// Replaced old withdrawSharesAsTokens with correct signature/logic
function withdrawSharesAsTokens(address staker, IStrategy strategy, IERC20 token, uint256 shares) external {
require(_stakerDepositShares[staker][strategy] >= shares, "MockSM: Insufficient shares");
_stakerDepositShares[staker][strategy] -= shares;
uint256 amountToTransfer = shares; // Simple 1:1 mock
// Transfer the mock tokens back to the staker (Vault)
token.safeTransfer(staker, amountToTransfer); // Correct: sends to the Vault (staker)
}
function stakerDepositShares(address staker, IStrategy strategy) external view returns (uint256) {
return _stakerDepositShares[staker][strategy];
}
// --- Stubs for other IStrategyManager functions (if needed by Vault) ---
function getDeposits(
address staker
) external view returns (IStrategy[] memory strategies, uint256[] memory amounts) {
// Basic stub - returns empty arrays.
// Needs implementation if Vault tests rely on this.
strategies = new IStrategy[](0);
amounts = new uint256[](0);
}
function removeDepositShares(
address staker,
IStrategy strategy,
uint256 shares
) external returns (uint256 sharesRemaining) {
require(_stakerDepositShares[staker][strategy] >= shares, "MockSM: Insufficient shares");
_stakerDepositShares[staker][strategy] -= shares;
sharesRemaining = _stakerDepositShares[staker][strategy];
}
function addShares(
address staker,
IStrategy strategy,
uint256 shares
) external returns (uint256 /* prevShares */, uint256 /* newShares */) {
// Simplified stub: just adds shares
uint256 prev = _stakerDepositShares[staker][strategy];
_stakerDepositShares[staker][strategy] += shares;
return (prev, _stakerDepositShares[staker][strategy]);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
import "@layerzerolabs/oapp-evm/contracts/oapp/OApp.sol";
import "@layerzerolabs/oapp-evm/contracts/oapp/libs/OptionsBuilder.sol";
// Note: OFTCore.sol for MessagingFee is usually needed if this contract *sends* OFTs itself.
// For receiving rewards (which are OFTs sent by TokenPool), and sending simple LZ messages,
// the OApp's MessagingFee and ILayerZeroEndpointV2 suffice.
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "./libraries/Messages.sol";
import "./libraries/PullRewards.sol";
import "./interfaces/IDCV2/IRegistry.sol";
// Copied TokenType enum from IStakeBase.sol
enum TokenType {
ATH, // Represents direct Aethir token staking
VATH // Represents staking of a Vault's token (e.g., vATH from ATHVault)
}
/// @title StakeBase
/// @author [Your Name/Organization]
/// @notice Manages staking of ATH or Vault-issued tokens (vATH) on a source chain.
/// @dev This contract interacts with a TokenPool contract on a destination chain via LayerZero.
/// It handles principal token locking, unstake requests, and reward claim initiations.
/// Rewards are received from the TokenPool (as OFTs) and then distributed locally.
contract StakeBase is Ownable, OApp {
using SafeERC20 for IERC20;
using PullRewards for PullRewards.Data;
/// @notice Minimum amount required for staking.
uint256 public immutable minStakeAmount = 1_000 * 1e18;
/// @notice The LayerZero Endpoint ID of the destination chain where the corresponding TokenPool resides.
uint16 public immutable dstEid;
/// @notice The Aethir (ATH) token contract. Used for TokenType.ATH staking and as the reward token.
IERC20 public immutable aethir;
/// @notice The central registry for DCV2 component addresses.
IRegistry public immutable registry;
PullRewards.Data private rewards; // Internal reward accounting for stakers on this StakeBase.
/// @dev Configuration for each supported token type.
struct TokenConfig {
IERC20 token; // The ERC20 token contract for this type.
bool enabled; // Whether staking for this token type is enabled.
uint256 vestingDuration; // Vesting duration for unstakes of this token type.
}
/// @notice Mapping from TokenType to its configuration.
mapping(TokenType => TokenConfig) public tokenConfigs;
/// @notice Mapping from staker address to the TokenType they have staked.
mapping(address => TokenType) public userTokenTypes;
/// @notice Tracks the amount of principal tokens physically held by this StakeBase contract for each staker.
mapping(address => uint256) public providedTokens;
/// @notice Mapping from a vault's address to the TokenType it manages (expected to be VATH).
mapping(address => TokenType) public registeredVaults;
/// @notice Tracks if a vault address has been explicitly registered.
mapping(address => bool) public isExplicitlyRegisteredVault;
/// @notice Mapping from the EID of a TokenPool's chain to the TokenPool contract address.
mapping(uint16 => address) public tokenPools;
// Events
event TokenConfigUpdated(
TokenType indexed tokenType,
address indexed token,
bool enabled,
uint256 vestingDuration
);
event VaultRegistered(address indexed vault, TokenType indexed tokenType);
event TokenPoolRegistered(
uint16 indexed eid,
address indexed tokenPoolAddress
);
event Stake(
address indexed staker,
TokenType indexed tokenType,
uint256 amount
);
event UnstakeRequest(
address indexed staker,
TokenType indexed tokenType,
uint256 amount
);
event UnstakeExecuted(
address indexed staker,
TokenType indexed tokenType,
uint256 amount
);
event Claim(address indexed claimant); // Emitted when a claim process is initiated.
event RewardsDistributed(address indexed recipient, uint256 amount); // Emitted when rewards are successfully distributed.
event ClaimResponseFailed(address indexed recipient, uint256 amount); // Emitted if a vault's reward handler fails post-reward-transfer.
/// @param _dstEid The LayerZero EID of the destination chain (where TokenPool resides).
/// @param _endpoint The LayerZero V2 Endpoint address for OApp.
/// @param _aethirAddress The address of the ATH token, also used as the reward token.
/// @param _registryAddress The address of the DCV2 Registry.
constructor(
uint16 _dstEid,
address _endpoint,
address _aethirAddress,
address _registryAddress
) OApp(_endpoint, msg.sender) Ownable(msg.sender) {
dstEid = _dstEid;
aethir = IERC20(_aethirAddress);
registry = IRegistry(_registryAddress);
// Initialize default configurations
tokenConfigs[TokenType.ATH] = TokenConfig({
token: aethir,
enabled: true,
vestingDuration: 180 days
});
tokenConfigs[TokenType.VATH] = TokenConfig({
token: IERC20(address(0)),
enabled: false,
vestingDuration: 0 days
});
}
//—— Admin ——————————————————————————————————————————
/// @notice Configures or updates settings for a specific TokenType.
/// @dev Only callable by the owner.
/// @param t The TokenType to configure.
/// @param tokenContract The ERC20 token contract for this type.
/// @param enabled Whether staking is enabled for this type.
/// @param vestingDuration The vesting duration for unstakes of this type.
function configureToken(
TokenType t,
IERC20 tokenContract,
bool enabled,
uint256 vestingDuration
) external onlyOwner {
require(uint8(t) < 255, "SB: bad type"); // Basic check against enum overflow
require(address(tokenContract) != address(0), "SB: zero token");
require(vestingDuration > 0, "SB: bad vesting"); // Ensure vesting is meaningful
tokenConfigs[t] = TokenConfig(tokenContract, enabled, vestingDuration);
emit TokenConfigUpdated(
t,
address(tokenContract),
enabled,
vestingDuration
);
}
/// @notice Registers a vault contract and configures its associated VATH token.
/// @dev Only callable by the owner. Vaults must use TokenType.VATH.
/// @param vault The address of the vault contract.
/// @param vAthTokenAddr The address of the VATH token managed by the vault.
/// @param tokenTypeForVault The TokenType the vault will be registered with (must be VATH).
function registerVault(
address vault,
address vAthTokenAddr,
TokenType tokenTypeForVault
) external onlyOwner {
require(vault != address(0), "SB: zero vault");
require(uint8(tokenTypeForVault) < 255, "SB: bad type");
require(
tokenTypeForVault == TokenType.VATH,
"SB: vault must use VATH type"
);
registeredVaults[vault] = tokenTypeForVault;
isExplicitlyRegisteredVault[vault] = true;
// Automatically configure the VATH token for this vault
tokenConfigs[tokenTypeForVault].token = IERC20(vAthTokenAddr);
tokenConfigs[tokenTypeForVault].enabled = true; // Enable VATH staking via this vault
emit VaultRegistered(vault, tokenTypeForVault);
}
/// @notice Registers or updates the address of a TokenPool contract for a given chain EID.
/// @dev Only callable by the owner.
/// @param _eid The LayerZero EID of the chain where the TokenPool contract resides.
/// @param _tokenPoolAddress The address of the TokenPool contract.
function registerTokenPool(
uint16 _eid,
address _tokenPoolAddress
) external onlyOwner {
require(_tokenPoolAddress != address(0), "SB: zero addr");
tokenPools[_eid] = _tokenPoolAddress;
emit TokenPoolRegistered(_eid, _tokenPoolAddress);
}
//—— TokenProvider Flows (Principal Staking/Unstaking) ——————————————
/// @notice Allows a user or vault to stake tokens (ATH or VATH).
/// @dev Transfers principal tokens to this contract and sends a message to TokenPool.
/// @param amount The amount of tokens to stake.
/// @param t The TokenType being staked.
function stake(uint256 amount, TokenType t) external payable {
require(amount >= minStakeAmount, "SB: below min");
TokenConfig storage cfg = tokenConfigs[t];
require(cfg.enabled, "SB: disabled");
require(address(cfg.token) != address(0), "SB: token not configured");
require(msg.value > 0, "SB: no fee for LZ message");
// Principal tokens (ATH or vATH) are transferred from user/vault to this StakeBase.
// These tokens are now "locked" in StakeBase's custody.
cfg.token.safeTransferFrom(msg.sender, address(this), amount);
userTokenTypes[msg.sender] = t;
providedTokens[msg.sender] += amount;
rewards.stake(msg.sender, amount, amount); // For local reward accounting if applicable (though primary rewards from TokenPool)
emit Stake(msg.sender, t, amount);
// Send LayerZero message to TokenPool to notify about the stake.
_lzSend(
dstEid,
Messages.encodeStake(msg.sender, amount),
_lzOpts(),
MessagingFee(msg.value, 0), // Native fee provided by caller
payable(msg.sender) // Refund address
);
}
/// @notice Initiates an unstake request for a user or vault.
/// @dev Reduces locally tracked provided tokens and sends an unstake request message to TokenPool.
/// @param amount The amount of tokens to request unstaking for.
function unstakeRequest(uint256 amount) external payable {
TokenType t = userTokenTypes[msg.sender];
TokenConfig memory cfg = tokenConfigs[t]; // Use memory copy for read-only struct access
require(cfg.enabled, "SB: disabled");
require(
address(cfg.token) != address(0),
"SB: token not configured for user type"
);
require(
providedTokens[msg.sender] >= amount,
"SB: insufficient locked tokens"
);
require(msg.value > 0, "SB: no fee for LZ message");
// Liquidity check for direct ATH stakers: either full withdraw or leave at least 5%.
if (t == TokenType.ATH) {
uint256 remainingStake = providedTokens[msg.sender] - amount;
require(
remainingStake == 0 ||
remainingStake * 100 >= providedTokens[msg.sender] * 5,
"SB: low liq or full withdraw"
);
}
providedTokens[msg.sender] -= amount; // Logically earmark these tokens for withdrawal.
rewards.withdraw(msg.sender, amount, amount); // Update local reward accounting.
emit UnstakeRequest(msg.sender, t, amount);
// Send LayerZero message to TokenPool with vesting duration.
_lzSend(
dstEid,
Messages.encodeUnstakeRequestWithDuration(
msg.sender,
amount,
cfg.vestingDuration
),
_lzOpts(),
MessagingFee(msg.value, 0),
payable(msg.sender)
);
}
/// @notice Allows a user or vault to finalize an unstake after vesting period (by notifying TokenPool).
/// @dev Sends a message to TokenPool to process the vested unstake.
/// @param vestingId The ID of the vesting entry on the TokenPool side.
function unstake(uint256 vestingId) external payable {
require(msg.value > 0, "SB: no fee for LZ message");
// Send LayerZero message to TokenPool to complete the unstake for the given vestingId.
_lzSend(
dstEid,
Messages.encodeUnstake(msg.sender, vestingId),
_lzOpts(),
MessagingFee(msg.value, 0),
payable(msg.sender)
);
}
//—— Reward Claiming Flow ——————————————————————————————————
/// @notice Initiates a reward claim for a direct staker.
/// @dev Sends a message to TokenPool to request reward calculation and distribution.
function claim() external payable {
require(msg.value > 0, "SB: no fee for LZ message");
// Encode claimant, vault context (same as claimant for direct stakers), and recipient (claimant).
_lzSend(
dstEid,
Messages.encodeClaim(msg.sender, msg.sender, msg.sender),
_lzOpts(),
MessagingFee(msg.value, 0),
payable(msg.sender)
);
emit Claim(msg.sender);
}
/// @notice Initiates a reward claim for a registered vault.
/// @dev Sends a message to TokenPool; the vault itself is the claimant and recipient.
function claimRewards() external payable {
require(msg.value > 0, "SB: fee required for LZ message");
require(
isExplicitlyRegisteredVault[msg.sender],
"SB: caller not a registered vault"
);
// Vault acts as claimant, context, and recipient on its behalf.
_lzSend(
dstEid,
Messages.encodeClaim(msg.sender, msg.sender, msg.sender),
_lzOpts(),
MessagingFee(msg.value, 0),
payable(msg.sender)
);
emit Claim(msg.sender);
}
//—— Cross-Chain Callback ——————————————————————————————————
/// @dev Handles incoming LayerZero messages from the paired TokenPool.
function _lzReceive(
Origin calldata origin,
bytes32, // guid
bytes calldata message,
address, // executor
bytes calldata // extraData
) internal override {
address expectedTokenPool = tokenPools[uint16(origin.srcEid)];
require(
expectedTokenPool != address(0),
"SB: TokenPool not registered for srcEid"
);
require(
addressToBytes32(expectedTokenPool) == origin.sender,
"SB: unauthorized TokenPool sender"
);
bytes32 action = bytes32(message[:32]);
if (action == Messages.TP_UNSTAKE_RESPONSE) {
(address userFromMessage, uint256 amountFromMessage) = Messages
.decodeUnstakeResponse(message);
_handleUnstakeResponse(userFromMessage, amountFromMessage);
} else if (action == Messages.TP_CLAIM_RESPONSE) {
(address recipient, uint256 amountClaimed /* vault */, ) = Messages // IGNORE THE LAST VALUE
.decodeClaimResponse(message); // Unpack relevant fields
_handleClaimResponse(recipient, amountClaimed);
} else {
revert("SB: invalid message type");
}
}
/// @dev Handles the response from TokenPool after an unstake operation.
/// @param user The address of the user/vault whose unstake is being processed.
/// @param amt The amount of tokens successfully unstaked and to be returned.
function _handleUnstakeResponse(address user, uint256 amt) internal {
TokenType tokenTypeToReturn = userTokenTypes[user];
require(
uint8(tokenTypeToReturn) < 255,
"SB: Unknown token type for user"
); // Basic enum check
TokenConfig memory cfg = tokenConfigs[tokenTypeToReturn];
require(
address(cfg.token) != address(0),
"SB: Token not configured for type to return"
);
// Transfer the original, locked principal tokens back to the user/vault.
// These tokens were held by StakeBase and are now released.
SafeERC20.safeTransfer(IERC20(address(cfg.token)), user, amt);
emit UnstakeExecuted(user, tokenTypeToReturn, amt);
}
/// @dev Handles the response from TokenPool after a reward claim.
/// @param recipient The final recipient of the rewards (user or vault).
/// @param amt The amount of reward tokens (aethir) received from TokenPool.
function _handleClaimResponse(address recipient, uint256 amt) internal {
// Rewards (aethir OFT) are assumed to have been bridged to this StakeBase contract by TokenPool.
// StakeBase now distributes these locally.
if (amt == 0) {
// No rewards to distribute, can optionally emit an event or simply return.
return;
}
if (isExplicitlyRegisteredVault[recipient]) {
// For vaults, transfer the received 'aethir' (reward OFT) to the vault.
SafeERC20.safeTransfer(IERC20(address(aethir)), recipient, amt);
// Notify the vault that it has received rewards.
// The vault is expected to have a `handleStakeBaseRewards(uint256)` function.
(bool ok, ) = recipient.call(
abi.encodeWithSignature("handleStakeBaseRewards(uint256)", amt)
);
if (!ok) {
// Tokens are already with the vault; this event signals its handler failed.
emit ClaimResponseFailed(recipient, amt);
} else {
emit RewardsDistributed(recipient, amt);
}
} else {
// For direct stakers, transfer the received 'aethir' (reward OFT) directly to them.
SafeERC20.safeTransfer(IERC20(address(aethir)), recipient, amt);
emit RewardsDistributed(recipient, amt);
}
}
/// @dev Generates standard LayerZero options for sending messages.
function _lzOpts() internal pure returns (bytes memory) {
return
OptionsBuilder.addExecutorLzReceiveOption(
OptionsBuilder.newOptions(),
200_000,
0
);
}
/// @dev Converts an address to bytes32 format for LayerZero messages.
function addressToBytes32(address _addr) internal pure returns (bytes32) {
return bytes32(uint256(uint160(_addr)));
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.27;
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@layerzerolabs/oapp-evm/contracts/oapp/OApp.sol";
import "@layerzerolabs/oapp-evm/contracts/oapp/libs/OptionsBuilder.sol";
// Required for endpoint.quoteFee()
import {ILayerZeroEndpointV2, MessagingFee, MessagingParams, Origin} from "@layerzerolabs/lz-evm-protocol-v2/contracts/interfaces/ILayerZeroEndpointV2.sol";
import "./libraries/Messages.sol";
import "./libraries/PullRewards.sol";
import "./interfaces/IDCV2/IRegistry.sol"; // Assuming IRequestVerifier is part of this or another import
import "./interfaces/IDCV2/IStakeHandler.sol";
import "./interfaces/IDCV2/IAccountHandler.sol";
import "./interfaces/IDCV2/IRewardHandler.sol";
import "./interfaces/IDCV2/IVestingHandler.sol";
// Copied StakerType enum from ITokenPool.sol
enum StakerType {
TokenProvider,
CloudHost
}
// Copied TPVesting struct from ITokenPool.sol
struct TPVesting {
uint256 amount; // tokens locked
uint256 vestingEnd; // timestamp when unlocked
}
/// @notice Interface for an OFT (Omnichain Fungible Token) that includes TokenPool-specific mint/burn functions.
interface IOFT is IERC20 {
function tokenPoolMint(uint256 amount) external;
function tokenPoolBurn(uint256 amount) external;
function send(
uint32 _dstEid,
bytes32 _toAddress,
uint256 _amount,
bytes calldata _options
) external payable;
}
/// @title TokenPool
/// @author [Your Name/Organization]
/// @notice Manages staking of synthetic tokens, reward distribution, and cross-chain interactions via LayerZero.
/// @dev This contract acts as a central pool on a specific chain (srcEid). It interacts with StakeBase contracts on other chains
/// for TokenProviders and handles local staking for CloudHosts. It uses OFTs for synthetic assets and rewards.
contract TokenPool is Ownable, OApp {
using SafeERC20 for IERC20;
using PullRewards for PullRewards.Data;
uint256 public constant BPS_DENOM = 10000;
uint256 public constant CLOUD_HOST_BASE_WEIGHT = 100;
uint256 public constant CLOUD_HOST_BOOST_WEIGHT = 120;
/// @notice The OFT representing the primary staked asset.
IOFT public immutable syntheticToken;
/// @notice The OFT used for distributing rewards.
IOFT public immutable rewardOFT;
/// @notice The central registry for DCV2 component addresses.
IRegistry public immutable registry;
/// @notice The LayerZero Endpoint ID of the chain where this TokenPool is deployed.
uint32 public immutable srcEid;
PullRewards.Data private rewards; // Internal reward accounting data.
/// @notice Mapping from LayerZero Endpoint ID (EID) to the address of the StakeBase contract on that chain.
mapping(uint16 => address) public stakeBases;
/// @notice Mapping from staker address to the EID of the chain their StakeBase contract resides on (for TokenProviders).
mapping(address => uint16) public userChain;
/// @notice Mapping from staker address to their StakerType (TokenProvider or CloudHost).
mapping(address => StakerType) public userStakerType;
/// @notice Mapping for TokenProvider vestings: user => vestingId => vesting details.
mapping(address => mapping(uint256 => TPVesting)) public tpVestings;
/// @notice Counter for generating unique vesting IDs per user for TokenProviders.
mapping(address => uint256) public tpVestingCounter;
/// @notice Amount of syntheticToken pending withdrawal for a CloudHost after unstake.
mapping(address => uint256) public cloudHostPendingWithdrawal;
/// @notice Raw amount staked by a CloudHost, before weight adjustments.
mapping(address => uint256) public cloudHostRawStaked;
/// @notice Total raw amount staked by all CloudHosts.
uint256 public totalCloudHostRawStaked;
/// @notice Total amount staked by all TokenProviders.
uint256 public totalTPStaked;
/// @notice Tax rate in basis points applied to rewards.
uint16 public rewardTaxBps;
/// @notice Tax rate in basis points applied to deposits.
uint16 public depositTaxBps;
/// @notice Address that collects deposit and reward taxes.
address public feeCollector;
event StakeBaseRegistered(
uint16 indexed eid,
address indexed stakeBaseAddress
);
event ConfigUpdated(
uint16 rewardTaxBps,
uint16 depositTaxBps,
address feeCollector
);
event StakeReceived(address indexed staker, uint256 amount);
event UnstakeRequested(
address indexed staker,
uint256 amount,
uint256 duration,
uint256 indexed vestingId
);
event UnstakeCompleted(
address indexed staker,
uint256 indexed vestingId,
uint256 amount
);
event RewardClaimed(
address indexed staker,
uint256 amount,
StakerType stakerType
);
event DelegatedStake(IRequestVerifier.VerifiableData vdata, uint256 amount);
event DelegatedUnstakeRequest(
IRequestVerifier.VerifiableData vdata,
uint256 amount
);
event DelegatedUnstakeComplete(
IRequestVerifier.VerifiableData vdata,
uint256 amount
);
event CloudHostWithdrawComplete(address indexed host, uint256 amount);
event GasDeposited(address indexed depositor, uint256 amount);
/// @param _syntheticTokenAddress Address of the synthetic OFT.
/// @param _rewardOFTAddress Address of the reward OFT.
/// @param _registryAddress Address of the DCV2 Registry.
/// @param _endpointAddress Address of the LayerZero V2 Endpoint for OApp.
/// @param _owner The initial owner of the contract.
/// @param _thisChainEid The LayerZero EID of the current chain.
constructor(
address _syntheticTokenAddress,
address _rewardOFTAddress,
address _registryAddress,
address _endpointAddress, // OApp constructor expects endpoint address
address _owner,
uint32 _thisChainEid
) OApp(_endpointAddress, _owner) Ownable(_owner) {
syntheticToken = IOFT(_syntheticTokenAddress);
rewardOFT = IOFT(_rewardOFTAddress);
registry = IRegistry(_registryAddress);
srcEid = _thisChainEid;
}
/// @notice Allows the contract to receive native gas (ETH/MATIC/etc.)
/// @dev This enables direct gas payments to fund cross-chain operations
receive() external payable {}
/// @notice Allows the owner to deposit native gas for cross-chain operations
/// @dev Emits a GasDeposited event
function depositGas() external payable onlyOwner {
emit GasDeposited(msg.sender, msg.value);
}
/// @notice Retrieves the StakeHandler contract address from the registry.
function stakeHandler() public view returns (IStakeHandler) {
return
IStakeHandler(
registry.getAddress(bytes4(keccak256("STAKE_HANDLER")))
);
}
/// @notice Retrieves the AccountHandler contract address from the registry.
function accountHandler() public view returns (IAccountHandler) {
return
IAccountHandler(
registry.getAddress(bytes4(keccak256("ACCOUNT_HANDLER")))
);
}
/// @notice Retrieves the RewardHandler contract address from the registry.
function rewardHandler() public view returns (IRewardHandler) {
return
IRewardHandler(
registry.getAddress(bytes4(keccak256("REWARD_HANDLER")))
);
}
/// @notice Retrieves the VestingHandler contract address from the registry.
function vestingHandler() public view returns (IVestingHandler) {
return
IVestingHandler(
registry.getAddress(bytes4(keccak256("VESTING_HANDLER")))
);
}
/// @notice Registers or updates the address of a StakeBase contract for a given chain EID.
/// @dev Only callable by the owner.
/// @param _eid The LayerZero EID of the chain where the StakeBase contract resides.
/// @param _stakeBaseAddress The address of the StakeBase contract.
function registerStakeBase(
uint16 _eid,
address _stakeBaseAddress
) external onlyOwner {
require(_stakeBaseAddress != address(0), "TP: zero addr");
stakeBases[_eid] = _stakeBaseAddress;
emit StakeBaseRegistered(_eid, _stakeBaseAddress);
}
/// @notice Updates tax rates and the fee collector address.
/// @dev Only callable by the owner.
/// @param _rewardTaxBps New reward tax rate in basis points.
/// @param _depositTaxBps New deposit tax rate in basis points.
/// @param _feeCollector New address for collecting fees.
function updateConfig(
uint16 _rewardTaxBps,
uint16 _depositTaxBps,
address _feeCollector
) external onlyOwner {
require(_rewardTaxBps < BPS_DENOM, "TP: reward tax too high");
require(_depositTaxBps < BPS_DENOM, "TP: deposit tax too high");
require(_feeCollector != address(0), "TP: zero fee collector");
rewardTaxBps = _rewardTaxBps;
depositTaxBps = _depositTaxBps;
feeCollector = _feeCollector;
emit ConfigUpdated(_rewardTaxBps, _depositTaxBps, _feeCollector);
}
/// @notice Allows a CloudHost to stake synthetic tokens via delegation through a verifier.
/// @param vdata Verifiable data from the request verifier.
/// @param hostAmount The gross amount of synthetic tokens the host intends to stake.
function delegatedStake(
IRequestVerifier.VerifiableData calldata vdata,
uint256 hostAmount
) external {
require(vdata.sender == msg.sender, "TP: invalid vdata");
require(hostAmount > 0, "TP: zero");
uint256 netAmount = _applyDepositTaxDelegated(hostAmount, msg.sender);
IERC20(address(syntheticToken)).safeTransferFrom(
msg.sender,
address(this),
netAmount
);
IERC20(address(syntheticToken)).approve(
address(stakeHandler()),
type(uint256).max
);
totalCloudHostRawStaked += netAmount;
cloudHostRawStaked[msg.sender] += netAmount;
uint256 weight = _hostWeight(msg.sender);
userStakerType[msg.sender] = StakerType.CloudHost;
rewards.stake(msg.sender, netAmount, netAmount * weight);
stakeHandler().delegationStake(vdata);
emit DelegatedStake(vdata, netAmount);
}
/// @notice Placeholder for delegated unstake request functionality.
function delegatedUnstakeRequest(
IRequestVerifier.VerifiableData calldata vdata,
uint256 hostAmount
) external {
// Placeholder
emit DelegatedUnstakeRequest(vdata, hostAmount);
}
/// @notice Placeholder for delegated unstake completion functionality.
function delegatedUnstakeComplete(
IRequestVerifier.VerifiableData calldata vdata
) external {
// Placeholder
emit DelegatedUnstakeComplete(vdata, 0);
}
/// @notice Allows a CloudHost or an operator to complete a withdrawal of unstaked tokens.
/// @dev Placeholder: Current implementation might be simplified.
/// @param host The address of the CloudHost whose withdrawal is to be completed.
function completeCloudHostWithdrawal(address host) external {
// Placeholder
uint256 amount = cloudHostPendingWithdrawal[host];
require(amount > 0, "TP: nothing to withdraw");
cloudHostPendingWithdrawal[host] = 0;
IERC20(address(syntheticToken)).safeTransfer(host, amount);
emit CloudHostWithdrawComplete(host, amount);
}
/// @notice Allows a TokenProvider to claim their rewards.
/// @dev Token Providers initiate claims that may involve cross-chain operations to their StakeBase; fee is required upfront.
function claimRewardsForTokenProvider() external payable {
require(msg.value > 0, "TP: TP claim needs fee for cross-chain ops");
_claimRewardsLocalOrCrossChain(
msg.sender,
msg.sender,
StakerType.TokenProvider,
msg.value // This fee is for the _lzReceive execution on this contract if TP_CLAIM comes with value, not for outgoing messages.
// However, since this is a user-initiated call, msg.value isn't from an LZ message.
// This msg.value from the user is NOT used to pay for outgoing LZ messages from TokenPool.
// It's passed as `feeForTpClaimExecution` which is a bit misleading in its current usage.
// For TP initiated claims, this `feeForTpClaimExecution` parameter in _claimRewardsLocalOrCrossChain
// is effectively unused because TP claims from TokenPool *always* mean TokenPool pays for its outgoing messages.
// The `msg.value` here is from the user calling `claimRewardsForTokenProvider`,
// and it's not directly used by `_claimRewardsLocalOrCrossChain` to pay for *its* sends.
// Let's clarify `feeForTpClaimExecution` for `_claimRewardsLocalOrCrossChain`.
// When called from `claimRewardsForTokenProvider`, this `msg.value` is just... there.
// When called from `_lzReceive` (for TP_CLAIM), `msg.value` of `_lzReceive` is passed.
// It's better to pass 0 if TokenPool is always paying for its own messages.
);
}
/// @notice Allows a CloudHost to claim their rewards.
/// @dev CloudHosts always claim rewards locally on this TokenPool's chain.
function claimRewardsForCloudHost() external {
_claimRewardsLocalOrCrossChain(
msg.sender,
msg.sender,
StakerType.CloudHost,
0 // No fee involved for local claim processing from TokenPool's perspective
);
}
/// @dev Internal function to handle reward claiming for both local (CloudHost) and cross-chain (TokenProvider) scenarios.
/// @param staker The address of the staker claiming rewards.
/// @param to The ultimate recipient of the rewards. For TPs, this is the staker address on the StakeBase chain.
/// @param stType The type of the staker.
/// @param feePaidForThisExecution This is the fee *received* by TokenPool if the call originated from an _lzReceive that was paid for.
/// It's NOT used by this function to pay for *its own outgoing* messages.
function _claimRewardsLocalOrCrossChain(
address staker,
address to,
StakerType stType,
uint256 feePaidForThisExecution
) internal {
require(userStakerType[staker] == stType, "TP: wrong type");
uint256 owed = rewards.claimReward(staker);
require(owed > 0, "TP: none owed");
uint256 netRewardAmount = _applyRewardTax(owed);
if (stType == StakerType.CloudHost) {
// CloudHost claims are purely local on TokenPool chain.
// feePaidForThisExecution should be 0 as it's a direct call, not an LZ receive.
require(
feePaidForThisExecution == 0,
"TP: CH local claim expects no prior fee"
);
if (netRewardAmount > 0) {
IERC20(address(rewardOFT)).safeTransfer(to, netRewardAmount); // 'to' is the cloud host
}
} else {
// StakerType.TokenProvider
uint16 dstStakeBaseChainEid = userChain[staker];
address stakeBaseContractAddress = stakeBases[dstStakeBaseChainEid];
require(
stakeBaseContractAddress != address(0),
"TP: no SB registered for staker"
);
bytes memory lzOptions = _lzOpts();
ILayerZeroEndpointV2 lzEndpoint = ILayerZeroEndpointV2(
address(this.endpoint())
);
uint256 feeForOftSend = 0;
MessagingFee memory oftFeeDetails; // To store details if sending
if (netRewardAmount > 0) {
bytes memory oftProxyPayload = abi.encodePacked(
addressToBytes32(stakeBaseContractAddress),
netRewardAmount
);
MessagingParams memory oftParams = MessagingParams({
dstEid: uint32(dstStakeBaseChainEid),
receiver: addressToBytes32(stakeBaseContractAddress),
message: oftProxyPayload,
options: lzOptions,
payInLzToken: false
});
oftFeeDetails = lzEndpoint.quote(oftParams, address(this));
feeForOftSend = oftFeeDetails.nativeFee;
}
bytes memory claimResponseMessage = Messages.encodeClaimResponse(
staker,
netRewardAmount,
to
);
MessagingParams memory appResponseParams = MessagingParams({
dstEid: uint32(dstStakeBaseChainEid),
receiver: addressToBytes32(stakeBaseContractAddress),
message: claimResponseMessage,
options: lzOptions,
payInLzToken: false
});
MessagingFee memory appResponseFeeDetails = lzEndpoint.quote(
appResponseParams,
address(this)
);
uint256 feeForAppResponse = appResponseFeeDetails.nativeFee;
uint256 totalNativeFeeRequired = feeForOftSend + feeForAppResponse;
require(
address(this).balance >= totalNativeFeeRequired,
"TP: Insufficient funds for all return messages"
);
if (netRewardAmount > 0) {
rewardOFT.send{value: feeForOftSend}(
uint32(dstStakeBaseChainEid),
addressToBytes32(stakeBaseContractAddress),
netRewardAmount,
lzOptions
);
}
_lzSend(
dstStakeBaseChainEid,
claimResponseMessage,
lzOptions,
appResponseFeeDetails, // Pass the full MessagingFee struct
payable(address(this))
);
}
emit RewardClaimed(staker, netRewardAmount, stType);
}
// --- Refactored _lzReceive and its handlers ---
function _lzReceive(
Origin calldata origin,
bytes32, // guid
bytes calldata message,
address, // executor
bytes calldata // extraData. Could potentially carry the msg.value if LZ framework supports that.
)
internal
override
// For now, assuming msg.value of _lzReceive itself is the execution fee for this call.
{
address expectedStakeBase = stakeBases[uint16(origin.srcEid)];
require(
expectedStakeBase != address(0),
"TP: StakeBase not registered"
);
require(
addressToBytes32(expectedStakeBase) == origin.sender,
"TP: unauthorized StakeBase sender"
);
bytes32 action = bytes32(message[:32]);
if (action == Messages.TP_STAKE) {
_handleTPStake(origin, message);
} else if (action == Messages.TP_UNSTAKE_REQUEST_WITH_DURATION) {
_handleTPUnstakeRequestWithDuration(origin, message);
} else if (action == Messages.TP_UNSTAKE) {
_handleTPUnstake(origin, message);
} else if (action == Messages.TP_CLAIM) {
// The msg.value of the _lzReceive call itself is the fee paid by the user on StakeBase
// for the execution of this _lzReceive block.
_handleTPClaim(message, msg.value);
} else {
revert("TP: unknown msg type");
}
}
function _handleTPStake(
Origin calldata origin,
bytes calldata message
) internal {
(address staker, uint256 amountFromMessage) = Messages.decodeStake(
message
);
userChain[staker] = uint16(origin.srcEid);
syntheticToken.tokenPoolMint(amountFromMessage);
uint256 netAmount = _applyDepositTaxFromMinted(amountFromMessage);
userStakerType[staker] = StakerType.TokenProvider;
rewards.stake(staker, netAmount, netAmount); // TP weight is 1x
totalTPStaked += netAmount;
emit StakeReceived(staker, netAmount);
}
function _handleTPUnstakeRequestWithDuration(
Origin calldata origin,
bytes calldata message
) internal {
(address staker, uint256 amount, uint256 duration) = Messages
.decodeUnstakeRequestWithDuration(message);
require(
userStakerType[staker] == StakerType.TokenProvider,
"TP: Unstake for non-TP"
);
require(
amount <= rewards.stakers[staker].stakedAmount,
"TP: insufficient stake"
);
rewards.withdraw(staker, amount, amount); // TP weight is 1x
bytes memory lzOptions = _lzOpts();
bytes memory unstakeResponseMessage = Messages.encodeUnstakeResponse(
staker,
amount
);
if (duration == 0) {
syntheticToken.tokenPoolBurn(amount);
totalTPStaked -= amount;
MessagingParams memory unstakeResponseParams = MessagingParams({
dstEid: origin.srcEid,
receiver: origin.sender, // Send back to originating StakeBase OApp
message: unstakeResponseMessage,
options: lzOptions,
payInLzToken: false
});
MessagingFee memory feeDetails = ILayerZeroEndpointV2(
address(this.endpoint())
).quote(unstakeResponseParams, address(this));
require(
address(this).balance >= feeDetails.nativeFee,
"TP: Insufficient funds for unstake resp"
);
_lzSend(
origin.srcEid,
unstakeResponseMessage,
lzOptions,
feeDetails,
payable(address(this))
);
tpVestingCounter[staker]++;
uint256 internalIndex = tpVestingCounter[staker];
tpVestings[staker][internalIndex] = TPVesting({
amount: 0,
vestingEnd: uint64(block.timestamp)
});
emit UnstakeRequested(staker, amount, 0, internalIndex);
emit UnstakeCompleted(staker, internalIndex, amount);
} else {
tpVestingCounter[staker]++;
uint256 internalIndex = tpVestingCounter[staker];
tpVestings[staker][internalIndex] = TPVesting({
amount: amount,
vestingEnd: uint64(block.timestamp + duration)
});
emit UnstakeRequested(staker, amount, duration, internalIndex);
}
}
function _handleTPUnstake(
Origin calldata origin,
bytes calldata message
) internal {
(address staker, uint256 internalIndex) = Messages.decodeUnstake(
message
);
require(
userStakerType[staker] == StakerType.TokenProvider,
"TP: Unstake for non-TP"
);
TPVesting storage v = tpVestings[staker][internalIndex];
require(v.amount > 0, "TP: no vest / already claimed");
require(block.timestamp >= v.vestingEnd, "TP: vesting not complete");
uint256 amtToUnstake = v.amount;
v.amount = 0; // Mark as claimed
syntheticToken.tokenPoolBurn(amtToUnstake);
totalTPStaked -= amtToUnstake;
bytes memory lzOptions = _lzOpts();
bytes memory unstakeResponseMessage = Messages.encodeUnstakeResponse(
staker,
amtToUnstake
);
MessagingParams memory unstakeResponseParams = MessagingParams({
dstEid: origin.srcEid,
receiver: origin.sender, // Send back to originating StakeBase OApp
message: unstakeResponseMessage,
options: lzOptions,
payInLzToken: false
});
MessagingFee memory feeDetails = ILayerZeroEndpointV2(
address(this.endpoint())
).quote(unstakeResponseParams, address(this));
require(
address(this).balance >= feeDetails.nativeFee,
"TP: Insufficient funds for unstake resp"
);
_lzSend(
origin.srcEid,
unstakeResponseMessage,
lzOptions,
feeDetails,
payable(address(this))
);
emit UnstakeCompleted(staker, internalIndex, amtToUnstake);
}
function _handleTPClaim(
bytes calldata message,
uint256 feePaidForThisExecution
) internal {
(address recipientFromStakeBase, , ) = Messages.decodeClaim(message);
StakerType stType = userStakerType[recipientFromStakeBase];
require(
stType == StakerType.TokenProvider,
"TP: Claim from SB must be for TP"
);
// TokenPool pays for its *own* outgoing messages (OFT send, claim response)
// The feePaidForThisExecution is the value that accompanied the _lzReceive call, covering its execution cost.
_claimRewardsLocalOrCrossChain(
recipientFromStakeBase,
recipientFromStakeBase,
stType,
feePaidForThisExecution // Pass it along
);
}
// --- End of _lzReceive handlers ---
/// @dev Applies deposit tax when tokens are minted to this pool (e.g., for TokenProviders).
function _applyDepositTaxFromMinted(
uint256 grossAmountMinted
) internal returns (uint256 netAmount) {
uint256 fee = 0;
if (depositTaxBps > 0 && feeCollector != address(0)) {
fee = (grossAmountMinted * depositTaxBps) / BPS_DENOM;
if (fee > 0) {
IERC20(address(syntheticToken)).safeTransfer(feeCollector, fee);
}
}
return grossAmountMinted - fee;
}
/// @dev Applies deposit tax when tokens are transferred from a payer (e.g., for CloudHosts delegated stake).
function _applyDepositTaxDelegated(
uint256 grossAmount,
address payer
) internal returns (uint256 netAmount) {
uint256 fee = 0;
if (depositTaxBps > 0 && feeCollector != address(0)) {
fee = (grossAmount * depositTaxBps) / BPS_DENOM;
if (fee > 0) {
IERC20(address(syntheticToken)).safeTransferFrom(
payer,
feeCollector,
fee
);
}
}
return grossAmount - fee;
}
/// @dev Applies reward tax to the gross reward amount.
function _applyRewardTax(
uint256 grossRewardAmount
) internal returns (uint256 netAmount) {
uint256 fee = 0;
if (rewardTaxBps > 0 && feeCollector != address(0)) {
fee = (grossRewardAmount * rewardTaxBps) / BPS_DENOM;
if (fee > 0) {
IERC20(address(rewardOFT)).safeTransfer(feeCollector, fee);
}
}
return grossRewardAmount - fee;
}
/// @dev Generates standard LayerZero options for sending messages.
function _lzOpts() internal pure returns (bytes memory) {
return
OptionsBuilder.addExecutorLzReceiveOption(
OptionsBuilder.newOptions(),
200_000, // Default gas for lzReceive execution on destination
0 // Value to send with the message for lzReceive execution (can be overridden)
);
}
/// @dev Calculates the reward weight for a CloudHost based on their stake relative to total.
function _hostWeight(address host) internal view returns (uint256) {
if (totalCloudHostRawStaked == 0) return CLOUD_HOST_BASE_WEIGHT;
// Boost weight if host's stake is >= 50% of total CloudHost raw stake
return
(cloudHostRawStaked[host] * BPS_DENOM >=
totalCloudHostRawStaked * (BPS_DENOM / 2)) // Using BPS_DENOM for percentage comparison
? CLOUD_HOST_BOOST_WEIGHT
: CLOUD_HOST_BASE_WEIGHT;
}
/// @dev Converts an address to bytes32 format for LayerZero messages.
function addressToBytes32(address _addr) internal pure returns (bytes32) {
return bytes32(uint256(uint160(_addr)));
}
/// @notice Retrieves vesting details for a TokenProvider.
/// @param user The address of the TokenProvider.
/// @param index The vesting ID.
/// @return TPVesting struct containing vesting amount and end time.
function getTPVesting(
address user,
uint256 index
) external view returns (TPVesting memory) {
return tpVestings[user][index];
}
/// @notice Retrieves staking information for a given staker.
/// @param staker The address of the staker.
/// @return stakedAmount The current staked amount (after tax, before weight for CH, raw for TP).
/// @return stakerType The type of the staker (TokenProvider or CloudHost).
/// @return chainEid The EID of the staker's chain (for TokenProviders, 0 for CloudHosts or if not set).
function getStakerInfo(
address staker
)
external
view
returns (uint256 stakedAmount, StakerType stakerType, uint16 chainEid)
{
return (
rewards.stakers[staker].stakedAmount, // This is the amount used for reward calculations
userStakerType[staker],
userChain[staker]
);
}
/// @notice Retrieves the pending rewards for a staker.
/// @param staker The address of the staker.
/// @return The amount of rewards pending claim.
function pendingRewards(address staker) external view returns (uint256) {
return rewards.pendingReward(staker);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
//––––– External Dependencies
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import { AccessControlUpgradeable } from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
import { ReentrancyGuardUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
import { Initializable } from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import { PausableUpgradeable } from "@openzeppelin/contracts-upgradeable/utils/PausableUpgradeable.sol";
import { Address } from "@openzeppelin/contracts/utils/Address.sol";
import { PullRewards } from "./libraries/PullRewards.sol";
import { IStakeBase } from "./interfaces/IStakeBase.sol";
import { IStrategyManager } from "./interfaces/IStrategyManager.sol";
import { IDelegationManager } from "./interfaces/IDelegationManager.sol";
import { IStrategy } from "./interfaces/IStrategy.sol";
// Import the moved token contracts
import { EigenATHVaultFactory } from "./EigenATHVaultFactory.sol";
import { EigenATHVault } from "./EigenATHVault.sol";
import { VaultATH } from "./VaultATH.sol";
/// @title ATHVault
/// @author Aethir
/// @notice Manages ATH deposits, staking into EigenLayer and an external StakeBase contract, and handles reward distribution.
/// @dev This contract acts as a central hub for user ATH tokens, interacting with EigenLayer for restaking
/// and a StakeBase contract for additional yield opportunities. It issues eATH (EigenATH) tokens to represent
/// users' overall deposit and vATH (VaultATH) tokens internally to represent ATH staked in StakeBase.
/// Principal vesting/locks are handled by EigenLayer or the StakeBase's TokenPool, not by this vault.
contract ATHVault is Initializable, AccessControlUpgradeable, ReentrancyGuardUpgradeable, PausableUpgradeable {
using SafeERC20 for IERC20;
using PullRewards for PullRewards.Data;
using Address for address payable;
//––––– Roles –––––
bytes32 public constant OPERATOR_ROLE = keccak256("OPERATOR_ROLE");
bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
uint256 public constant MAX_ACTIVATION_BATCH = 50;
//––––– Token References –––––
IERC20 public ATH;
EigenATHVault public eATH;
VaultATH public vATH;
//––––– External Connectors & Flags –––––
/// @notice The StakeBase contract where vATH (representing ATH) is staked.
IStakeBase public stakeBaseContract;
/// @notice The EigenLayer StrategyManager contract.
IStrategyManager public strategyManager;
/// @notice The specific Aethir EigenLayer Strategy contract where ATH is deposited.
IStrategy public aethirStrategy;
/// @notice The EigenLayer DelegationManager contract for managing withdrawals from strategies.
IDelegationManager public delegationManager;
//––––– Global Flags / Params (packed first for gas) –––––
bool public isStakingEnabled;
bool public withdrawLock;
uint256 public vestingPeriod;
//––––– Caps & Running Totals –––––
uint256 public depositCap;
uint256 public totalDeposited;
uint256 public totalEscrowed;
//––––– Pre-deposit Campaign State –––––
mapping(address => uint256) public preDepositAmounts;
address[] public preDepositUsers;
uint256 public nextPreDepositActivationIndex;
//––––– EigenLayer Withdrawal Tracking –––––
struct WithdrawalInfo {
address owner; // who initiated the withdrawal
uint256 principal; // original principal amount
uint256 vestingEnd; // unix timestamp when vesting ends
}
/// @dev All per-root meta in a single place.
mapping(bytes32 => WithdrawalInfo) public withdrawalInfo;
//––––– User Shares in EigenLayer Strategy –––––
/// @notice Mapping from user address to their share count in the EigenLayer strategy.
mapping(address => uint256) public userStrategyShares;
// Flag to skip the next hook in onLocalEATHTransfer (either mint or burn)
mapping(address => bool) private _skipNextHook;
//––––– Reward Accounting –––––
PullRewards.Data private rewardData;
//––––– Events –––––
event StakingEnabledChanged(bool enabled);
event DepositCapChanged(uint256 newCap);
event PreDeposit(address indexed user, uint256 amount);
event ActivatePreDeposit(address indexed user, uint256 amount);
event Deposit(address indexed user, uint256 amount);
event RewardClaimed(address indexed user, uint256 amount);
event UnstakeInitiated(address indexed user, uint256 amount, uint256 sharesToWithdrawFromEL);
event WithdrawalFromStrategyQueued(
address indexed user,
uint256 requestedPrincipal,
bytes32 indexed withdrawalRoot
);
event Withdraw(address indexed user, uint256 amountATHReceived, uint256 vATHBurned);
event RewardDistributed(uint256 amount);
event WithdrawLockChanged(bool newStatus);
event StakeBaseSet(address indexed stakeBaseAddress);
event DepositToStrategy(address indexed user, uint256 amount, uint256 newShares);
event EigenConfigured(
address indexed strategyManager,
address indexed aethirStrategy,
address indexed delegationManager
);
event EscrowUpdated(address indexed user, uint256 newAmount);
event EATHBridgedOut(address indexed userDeparting, uint256 amountBridged, uint32 destinationEid);
event EATHBridgedIn(address indexed userArriving, uint256 amountBridged, uint32 sourceChainEid);
event StakeBaseDeposit(uint256 amountDeposited, uint256 feePaid);
event EATHPeerSet(uint32 indexed eid, bytes32 indexed peer);
event VestingPeriodChanged(uint256 newPeriod);
/// @custom:oz-upgrades-unsafe-allow constructor
constructor() {
_disableInitializers();
}
/// @notice Initializes the ATHVault contract.
/// @dev Sets up initial roles (admin and operator for the deployer), token references, and default values.
/// This function can only be called once by the deployer during proxy initialization.
/// @param ath_ The address of the ATH token contract.
/// @param lzEndpointAddress_ The LayerZero endpoint address for eATH OFT.
/// @param chainAEid_ The LayerZero endpoint ID of this chain (Chain A).
function initialize(
IERC20 ath_,
address lzEndpointAddress_,
uint32 chainAEid_,
EigenATHVaultFactory factory_
) public initializer {
require(address(ath_) != address(0), "ATHVault: zero ATH token");
require(lzEndpointAddress_ != address(0), "ATHVault: zero LZ endpoint");
__AccessControl_init();
__ReentrancyGuard_init();
_grantRole(DEFAULT_ADMIN_ROLE, msg.sender);
_grantRole(OPERATOR_ROLE, msg.sender);
_grantRole(PAUSER_ROLE, msg.sender); // Grant PAUSER_ROLE to deployer
__Pausable_init(); // Initialize Pausable
ATH = ath_;
eATH = factory_.createEigenATHVault("EigenATH", "eATH", lzEndpointAddress_, address(this), chainAEid_);
vATH = new VaultATH();
depositCap = type(uint256).max;
withdrawLock = false;
vestingPeriod = 30 days; // Default vesting period
}
receive() external payable {}
modifier onlyLive() {
require(isStakingEnabled, "ATHVault: not live");
_;
}
modifier onlyNotLive() {
require(!isStakingEnabled, "ATHVault: closed");
_;
}
modifier requiresFee() {
require(msg.value > 0, "ATHVault: fee required");
_;
}
// --- Pause Control ---
/// @notice Pauses the contract. Can only be called by an account with PAUSER_ROLE.
function pause() external onlyRole(PAUSER_ROLE) {
_pause();
}
/// @notice Unpauses the contract. Can only be called by an account with PAUSER_ROLE.
function unpause() external onlyRole(PAUSER_ROLE) {
_unpause();
}
/// @notice Sets the StakeBase contract address.
/// @dev Can only be called by an account with DEFAULT_ADMIN_ROLE.
/// Registers this vault with the StakeBase contract and approves it to spend the vault's vATH.
/// @param stakeBaseAddress The address of the StakeBase contract.
function setStakeBase(address stakeBaseAddress) external onlyRole(DEFAULT_ADMIN_ROLE) {
require(stakeBaseAddress != address(0), "ATHVault: zero address");
if (address(stakeBaseContract) != address(0)) {
vATH.approve(address(stakeBaseContract), 0);
}
stakeBaseContract = IStakeBase(stakeBaseAddress);
stakeBaseContract.registerVault(address(this), address(vATH), IStakeBase.TokenType.VATH);
vATH.approve(stakeBaseAddress, type(uint256).max);
emit StakeBaseSet(stakeBaseAddress);
}
/// @notice Enables or disables staking and pre-deposit activation.
/// @dev Can only be called by an account with DEFAULT_ADMIN_ROLE.
/// Requires StakeBase, StrategyManager, AethirStrategy, and DelegationManager to be configured if enabling.
/// @param enabled True to enable staking, false to disable.
function setStakingEnabled(bool enabled) external onlyRole(DEFAULT_ADMIN_ROLE) {
if (isStakingEnabled == enabled) {
return;
}
if (enabled) {
require(address(stakeBaseContract) != address(0), "ATHVault: no StakeBase");
require(address(strategyManager) != address(0), "ATHVault: no strategyMgr");
require(address(aethirStrategy) != address(0), "ATHVault: no strategy");
require(address(delegationManager) != address(0), "ATHVault: no delegationMgr");
}
isStakingEnabled = enabled;
emit StakingEnabledChanged(enabled);
}
/// @notice Configures the EigenLayer related contract addresses.
/// @dev Can only be called by an account with DEFAULT_ADMIN_ROLE.
/// Approves the StrategyManager to spend the AethirStrategy's underlying token (ATH) from this vault.
/// @param strategyManagerAddress The address of the EigenLayer StrategyManager.
/// @param strategyAddress The address of the Aethir EigenLayer Strategy.
/// @param delegationManagerAddress The address of the EigenLayer DelegationManager.
function configureEigen(
address strategyManagerAddress,
address strategyAddress,
address delegationManagerAddress
) external onlyRole(DEFAULT_ADMIN_ROLE) {
require(strategyManagerAddress != address(0), "ATHVault: zero strategyMgr");
require(strategyAddress != address(0), "ATHVault: zero strategy");
require(delegationManagerAddress != address(0), "ATHVault: zero delegationMgr");
if (
address(strategyManager) != address(0) &&
address(aethirStrategy) != address(0) &&
address(aethirStrategy.underlyingToken()) != address(0)
) {
IERC20 currentUnderlying = aethirStrategy.underlyingToken();
currentUnderlying.approve(address(strategyManager), 0);
}
strategyManager = IStrategyManager(strategyManagerAddress);
aethirStrategy = IStrategy(strategyAddress);
delegationManager = IDelegationManager(delegationManagerAddress);
require(address(aethirStrategy.underlyingToken()) == address(ATH), "ATHVault: wrong underlying");
ATH.approve(strategyManagerAddress, type(uint256).max);
emit EigenConfigured(strategyManagerAddress, strategyAddress, delegationManagerAddress);
}
/// @notice Sets the maximum total deposit cap for ATH tokens.
/// @dev Can only be called by an account with DEFAULT_ADMIN_ROLE.
/// The new cap cannot be less than the current totalDeposited amount.
/// @param newCap The new deposit cap.
function setDepositCap(uint256 newCap) external onlyRole(DEFAULT_ADMIN_ROLE) {
require(newCap >= totalDeposited, "ATHVault: cap < current");
depositCap = newCap;
emit DepositCapChanged(newCap);
}
/// @notice Locks or unlocks all withdrawal functionalities (initiateUnstake, completeUnstake).
/// @dev Can only be called by an account with DEFAULT_ADMIN_ROLE.
/// @param _lockStatus True to lock withdrawals, false to unlock.
function setWithdrawLock(bool _lockStatus) external onlyRole(DEFAULT_ADMIN_ROLE) {
withdrawLock = _lockStatus;
emit WithdrawLockChanged(_lockStatus);
}
/// @notice Allows the owner of ATHVault (admin) to set a peer on the eATH (EigenATHVault) contract.
/// @dev This is necessary because ATHVault owns eATH, and eATH's setPeer is onlyOwner.
/// @param _eid The endpoint ID of the peer network.
/// @param _peer The address of the peer contract on the other network (in bytes32 format).
function setPeerOnEATH(uint32 _eid, bytes32 _peer) external onlyRole(DEFAULT_ADMIN_ROLE) {
require(address(eATH) != address(0), "ATHVault: eATH not deployed/set");
eATH.setPeer(_eid, _peer); // eATH is an EigenATHVault which inherits OAppCore's setPeer
emit EATHPeerSet(_eid, _peer);
}
/// @notice Allows users to pre-deposit ATH tokens before staking is formally enabled.
/// @dev Can only be called when staking is not live (onlyNotLive modifier).
/// Requires EigenLayer (StrategyManager and AethirStrategy) to be configured.
/// Deposits are subject to the depositCap. ATH tokens are transferred to the vault,
/// eATH is minted to the user, and funds are staked into EigenLayer.
/// @param amount The amount of ATH tokens to pre-deposit.
function preDeposit(uint256 amount) external nonReentrant onlyNotLive whenNotPaused {
require(amount > 0, "ATHVault: zero amount");
require(
address(strategyManager) != address(0) && address(aethirStrategy) != address(0),
"ATHVault: Eigen not configured"
);
require(totalDeposited + amount <= depositCap, "ATHVault: cap reached");
ATH.safeTransferFrom(msg.sender, address(this), amount);
eATH.mint(msg.sender, amount);
_stakeEigenLayer(msg.sender, amount);
if (preDepositAmounts[msg.sender] == 0) {
preDepositUsers.push(msg.sender);
}
preDepositAmounts[msg.sender] += amount;
totalDeposited += amount;
emit PreDeposit(msg.sender, amount);
}
/// @notice Activates a batch of pre-deposited funds, staking them into StakeBase.
/// @dev Can only be called by an account with DEFAULT_ADMIN_ROLE when staking is live.
/// Requires msg.value for fees, distributed as evenly as possible (via integer division)
/// among activated users for StakeBase operations. Any remainder from msg.value
/// after this distribution is refunded to the caller (admin).
/// Processes users from preDepositUsers array in batches.
/// @param batchSize The number of users to process in this batch (valid range: 1-50).
function activatePreDepositsBatch(
uint256 batchSize
) external payable nonReentrant onlyLive onlyRole(DEFAULT_ADMIN_ROLE) requiresFee whenNotPaused {
require(batchSize > 0 && batchSize <= MAX_ACTIVATION_BATCH, "ATHVault: batchSize out");
uint256 totalUsers = preDepositUsers.length;
require(nextPreDepositActivationIndex < totalUsers, "ATHVault: none left");
uint256 endIndex = nextPreDepositActivationIndex + batchSize;
if (endIndex > totalUsers) endIndex = totalUsers;
uint256 validCount = 0;
for (uint256 i = nextPreDepositActivationIndex; i < endIndex; i++) {
if (preDepositAmounts[preDepositUsers[i]] > 0) {
validCount++;
}
}
require(validCount > 0, "ATHVault: none to activate");
uint256 feePerUser = msg.value / validCount;
uint256 totalFeeAllocated = feePerUser * validCount;
uint256 refundAmount = msg.value - totalFeeAllocated;
if (refundAmount > 0) {
// Refund the excess amount (the remainder from the division) to the admin.
payable(msg.sender).sendValue(refundAmount);
}
for (uint256 i = nextPreDepositActivationIndex; i < endIndex; i++) {
address user = preDepositUsers[i];
uint256 amt = preDepositAmounts[user];
if (amt > 0) {
preDepositAmounts[user] = 0;
_stakeStakeBase(amt, feePerUser);
emit ActivatePreDeposit(user, amt);
}
}
nextPreDepositActivationIndex = endIndex;
}
/// @notice Allows users to deposit ATH tokens when staking is live.
/// @dev Requires msg.value for fees (for StakeBase). Deposits are subject to depositCap.
/// ATH tokens are transferred, eATH minted, and funds are staked into EigenLayer and StakeBase.
/// @param amount The amount of ATH tokens to deposit.
function deposit(uint256 amount) external payable nonReentrant onlyLive requiresFee whenNotPaused {
require(amount > 0, "ATHVault: zero amount");
require(totalDeposited + amount <= depositCap, "ATHVault: cap reached");
ATH.safeTransferFrom(msg.sender, address(this), amount);
_stakeEigenLayer(msg.sender, amount);
eATH.mint(msg.sender, amount);
_stakeStakeBase(amount, msg.value);
totalDeposited += amount;
emit Deposit(msg.sender, amount);
}
/// @notice Allows a user to claim their accumulated ATH rewards.
/// @dev Utilizes the PullRewards library to calculate and transfer rewards.
/// Reverts if the user has no rewards to claim.
function claimRewards() external nonReentrant whenNotPaused {
uint256 claimed = rewardData.claimReward(msg.sender);
require(claimed > 0, "ATHVault: none");
ATH.safeTransfer(msg.sender, claimed);
emit RewardClaimed(msg.sender, claimed);
}
/// @notice Returns the amount of pending ATH rewards for a given user.
/// @param user The address of the user to query.
/// @return amount The amount of pending rewards.
function pendingRewards(address user) external view returns (uint256) {
return rewardData.pendingReward(user);
}
/// @notice Initiates the unstaking process for a user.
/// @dev Requires msg.value for fees (for StakeBase). Withdrawals must not be locked. User must have sufficient eATH.
/// This function calculates shares to withdraw from EigenLayer (if applicable), burns the user's eATH,
/// updates reward accounting, requests unstaking from StakeBase, and queues withdrawal from EigenLayer.
/// @param amount The total principal amount of ATH the user wishes to unstake. This corresponds to the amount of eATH to burn.
function initiateUnstake(uint256 amount) external payable nonReentrant onlyLive requiresFee whenNotPaused {
require(!withdrawLock, "ATHVault: locked");
require(amount > 0, "ATHVault: zero amount");
uint256 userEATHBalance = eATH.balanceOf(msg.sender);
require(userEATHBalance >= amount, "ATHVault: insuff eATH");
uint256 userTotalSharesInEL = userStrategyShares[msg.sender];
uint256 sharesToWithdrawFromEL = 0;
if (userTotalSharesInEL > 0 && userEATHBalance > 0) {
sharesToWithdrawFromEL = (amount * userTotalSharesInEL) / userEATHBalance;
if (amount == userEATHBalance) {
sharesToWithdrawFromEL = userTotalSharesInEL;
}
}
if (sharesToWithdrawFromEL > 0) {
userStrategyShares[msg.sender] = userTotalSharesInEL - sharesToWithdrawFromEL;
}
eATH.burn(msg.sender, amount);
totalDeposited -= amount;
emit UnstakeInitiated(msg.sender, amount, sharesToWithdrawFromEL);
stakeBaseContract.unstakeRequest{ value: msg.value }(amount);
if (sharesToWithdrawFromEL == 0) {
vATH.burnFrom(address(this), amount);
emit Withdraw(msg.sender, 0, amount);
emit WithdrawalFromStrategyQueued(msg.sender, amount, bytes32(0));
} else {
IDelegationManager.QueuedWithdrawalParams[] memory params = new IDelegationManager.QueuedWithdrawalParams[](
1
);
IStrategy[] memory strategies = new IStrategy[](1);
uint256[] memory shareCounts = new uint256[](1);
strategies[0] = aethirStrategy;
shareCounts[0] = sharesToWithdrawFromEL;
params[0] = IDelegationManager.QueuedWithdrawalParams({
strategies: strategies,
depositShares: shareCounts,
__deprecated_withdrawer: address(0)
});
bytes32[] memory roots = delegationManager.queueWithdrawals(params);
withdrawalInfo[roots[0]] = WithdrawalInfo({
owner: msg.sender,
principal: amount,
vestingEnd: block.timestamp + vestingPeriod
});
emit WithdrawalFromStrategyQueued(msg.sender, amount, roots[0]);
}
}
/// @notice Completes the unstaking process after an EigenLayer withdrawal is finalized.
/// @dev Withdrawals must not be locked. Caller must be the owner of the EigenLayer withdrawal request.
/// This function processes the EigenLayer withdrawal, burns the corresponding vATH from the vault's holdings
/// (representing funds assumed to be returned from StakeBase for this unstake operation),
/// and transfers the ATH actually received from EigenLayer to the user.
/// @param root The EigenLayer withdrawal root associated with the user's withdrawal.
/// @param withdrawal The EigenLayer withdrawal calldata struct.
/// @param rewardTokens An array of reward token addresses for the EigenLayer withdrawal (if any).
function completeUnstake(
bytes32 root,
IDelegationManager.Withdrawal calldata withdrawal,
IERC20[] calldata rewardTokens
) external nonReentrant onlyLive whenNotPaused {
require(!withdrawLock, "ATHVault: locked");
WithdrawalInfo memory info = withdrawalInfo[root];
require(info.owner == msg.sender, "ATHVault: not EL withdrawal owner");
uint256 originalPrincipalUnstaked = info.principal;
require(originalPrincipalUnstaked > 0, "ATHVault: No principal for root or already processed");
require(block.timestamp >= info.vestingEnd, "ATHVault: Vesting period not complete");
delete withdrawalInfo[root];
uint256 beforeATHBal = ATH.balanceOf(address(this));
delegationManager.completeQueuedWithdrawal(withdrawal, rewardTokens, true);
uint256 athReceivedFromEL = ATH.balanceOf(address(this)) - beforeATHBal;
vATH.burnFrom(address(this), originalPrincipalUnstaked);
if (athReceivedFromEL > 0) {
ATH.safeTransfer(msg.sender, athReceivedFromEL);
}
emit Withdraw(msg.sender, athReceivedFromEL, originalPrincipalUnstaked);
}
/// @notice Returns the total ATH token balance held by this vault contract.
/// @return balance The current ATH balance of the vault.
function totalATH() external view returns (uint256) {
return ATH.balanceOf(address(this));
}
/// @notice Allows an operator to trigger reward claiming from the StakeBase contract.
/// @dev Can only be called by an account with OPERATOR_ROLE when staking is live.
/// Requires msg.value for fees passed to the StakeBase contract.
/// Rewards received are then handled by handleStakeBaseRewards.
function claimRewardsFromStakeBase() external payable onlyLive requiresFee onlyRole(OPERATOR_ROLE) whenNotPaused {
stakeBaseContract.claimRewards{ value: msg.value }();
}
/// @notice Handles rewards received from the StakeBase contract.
/// @dev Can only be called by the StakeBase contract itself.
/// Adds the received rewardAmount to the vault's internal reward distribution system.
/// Reverts if rewardAmount is zero or if there are no stakers in the vault (rewardData.totalStaked is 0).
/// @param rewardAmount The amount of ATH rewards received from StakeBase.
function handleStakeBaseRewards(uint256 rewardAmount) external {
require(msg.sender == address(stakeBaseContract), "ATHVault: only StakeBase");
require(rewardAmount > 0, "ATHVault: zero reward");
require(rewardData.totalStaked > 0, "ATHVault: no stakers in vault");
rewardData.addRewards(rewardAmount);
emit RewardDistributed(rewardAmount);
}
//––––– Internal Functions –––––
/// @dev Stakes a user's ATH deposit into the configured EigenLayer strategy.
/// Updates the user's share count in userStrategyShares.
/// If EigenLayer (StrategyManager or AethirStrategy) is not configured, this function effectively becomes a no-op
/// for EL staking but still allows the deposit flow to proceed to StakeBase staking.
/// @param user The address of the user for whom the deposit is being staked.
/// @param amount The amount of ATH to stake into EigenLayer.
/// @return newShares The number of new shares minted by the EigenLayer strategy for this deposit. Returns 0 if EL not configured.
function _stakeEigenLayer(address user, uint256 amount) internal returns (uint256 newShares) {
if (address(strategyManager) == address(0) || address(aethirStrategy) == address(0)) {
emit DepositToStrategy(user, amount, 0);
return 0;
}
uint256 beforeShares = strategyManager.stakerDepositShares(address(this), aethirStrategy);
newShares = strategyManager.depositIntoStrategy(aethirStrategy, ATH, amount);
uint256 afterShares = strategyManager.stakerDepositShares(address(this), aethirStrategy);
require(
afterShares >= beforeShares && (afterShares - beforeShares) == newShares,
"ATHVault: EL share mismatch"
);
if (newShares > 0) {
userStrategyShares[user] += newShares;
}
emit DepositToStrategy(user, amount, newShares);
return newShares;
}
/// @dev Stakes a user's deposit into the StakeBase contract.
/// Updates the vault's internal reward tracking for the user, mints vATH to the vault itself,
/// and then stakes this vATH into StakeBase.
/// @param amount The amount of vATH (derived 1:1 from ATH deposit) to stake into StakeBase.
/// @param feeWei The fee in wei passed to the StakeBase stake call.
function _stakeStakeBase(uint256 amount, uint256 feeWei) internal {
require(feeWei > 0, "ATHVault: fee required");
vATH.mint(address(this), amount);
stakeBaseContract.stake{ value: feeWei }(amount, IStakeBase.TokenType.VATH);
emit StakeBaseDeposit(amount, feeWei);
}
/// @notice Handles preparations when eATH is bridged out of Chain A.
/// @dev Called by EigenATH (OFT) during its _debit operation.
/// "Deactivates" local entitlements (EigenLayer shares, reward basis) for the user.
/// @param user The user whose eATH is being bridged out.
/// @param amount The amount of eATH being bridged out.
/// @param dstEid The LayerZero endpoint ID of the destination chain.
/// @return success True if preparations were successful.
function handleEATHBridgedOut(
address user,
uint256 amount,
uint32 dstEid
) external nonReentrant whenNotPaused returns (bool) {
require(msg.sender == address(eATH), "ATHVault: Only eATH");
require(amount > 0, "ATHVault: zero amount");
// move staking position to vault escrow
rewardData.withdraw(user, amount, amount);
rewardData.stake(address(eATH), amount, amount);
// move EigenLayer shares to vault escrow
uint256 userShares = userStrategyShares[user];
if (userShares > 0) {
uint256 eATHBalanceBeforeThisTransfer = eATH.balanceOf(user);
if (eATHBalanceBeforeThisTransfer == 0) return false;
uint256 sharesToMove;
if (amount >= eATHBalanceBeforeThisTransfer) {
sharesToMove = userShares;
} else {
sharesToMove = (userShares * amount) / eATHBalanceBeforeThisTransfer;
}
if (sharesToMove > 0) {
userStrategyShares[user] -= sharesToMove;
userStrategyShares[address(eATH)] += sharesToMove;
}
}
_skipNextHook[user] = true; // Set flag to skip the upcoming burn in onLocalEATHTransfer
totalEscrowed += amount;
emit EATHBridgedOut(user, amount, dstEid);
return true;
}
/// @notice Handles preparations when eATH is bridged back into Chain A.
/// @dev Called by EigenATH (OFT) during its _credit operation.
/// "Reactivates" local entitlements from escrow for the arriving user.
/// @param user The user whose eATH is returning.
/// @param amount The amount of eATH being bridged back.
/// @param srcEid The LayerZero endpoint ID of the source chain.
/// @return success True if preparations were successful.
function handleEATHBridgedIn(
address user,
uint256 amount,
uint32 srcEid
) external nonReentrant whenNotPaused returns (bool) {
require(msg.sender == address(eATH), "ATHVault: Only eATH");
require(amount > 0, "ATHVault: zero amount");
rewardData.withdraw(address(eATH), amount, amount);
// Capture totalEscrowed before this user's amount is subtracted for pro-rata calculation
uint256 currentTotalEscrowed = totalEscrowed;
uint256 bonusRewardsFromEscrow = rewardData.claimReward(address(eATH));
if (bonusRewardsFromEscrow > 0 && currentTotalEscrowed > 0) {
uint256 shareForUser = (bonusRewardsFromEscrow * amount) / currentTotalEscrowed;
if (shareForUser > 0) {
rewardData.stakers[user].unclaimedRewards += shareForUser;
}
uint256 remainder = bonusRewardsFromEscrow - shareForUser;
if (remainder > 0) {
rewardData.stakers[address(eATH)].unclaimedRewards += remainder;
}
}
// Move EigenLayer shares back to user
uint256 userShares = userStrategyShares[address(eATH)];
if (userShares > 0) {
if (totalEscrowed == 0) return false;
uint256 sharesToMove;
if (amount >= totalEscrowed) {
sharesToMove = userShares;
} else {
sharesToMove = (userShares * amount) / totalEscrowed;
}
if (sharesToMove > 0) {
userStrategyShares[address(eATH)] -= sharesToMove;
userStrategyShares[user] += sharesToMove;
}
}
rewardData.stake(user, amount, amount);
_skipNextHook[user] = true; // Set flag to skip the upcoming mint in onLocalEATHTransfer
require(totalEscrowed >= amount, "ATHVault: escrow mismatch");
totalEscrowed -= amount;
emit EATHBridgedIn(user, amount, srcEid);
return true;
}
function onLocalEATHTransfer(address from, address to, uint256 amount) public virtual {
require(msg.sender == address(eATH), "ATHVault: only eATH");
if (amount == 0 || from == to) return;
if (from == address(0)) {
// Mint
_handleMint(to, amount);
} else if (to == address(0)) {
// Burn
_handleBurn(from, amount);
} else {
// Plain transfer
_handleTransfer(from, to, amount);
}
}
function _handleMint(address to, uint256 amount) internal {
if (_skipNextHook[to]) {
_skipNextHook[to] = false; // Reset the flag
// Staking was already handled in `handleEATHBridgedIn`
return;
}
// Regular mint
rewardData.stake(to, amount, amount);
}
function _handleBurn(address from, uint256 amount) internal {
if (_skipNextHook[from]) {
_skipNextHook[from] = false; // Reset the flag
// Burn was already handled in `handleEATHBridgedOut`
return;
}
// Regular burn
rewardData.withdraw(from, amount, amount);
}
function _handleTransfer(address from, address to, uint256 amount) internal {
// Same-chain Transfer - move reward basis
uint256 stakeFrom = rewardData.stakers[from].stakedAmount;
bool moveRewards = stakeFrom > 0;
if (moveRewards) {
uint256 amountToMoveForRewards = (amount > stakeFrom) ? stakeFrom : amount;
if (amountToMoveForRewards > 0) {
rewardData.withdraw(from, amountToMoveForRewards, amountToMoveForRewards);
rewardData.stake(to, amountToMoveForRewards, amountToMoveForRewards);
}
}
// Same-chain Transfer - move EigenLayer shares
uint256 fromELShares = userStrategyShares[from];
if (fromELShares > 0) {
uint256 eATHBalanceFromBeforeThisTransfer = eATH.balanceOf(from) + amount;
if (eATHBalanceFromBeforeThisTransfer == 0) return;
uint256 sharesToMove;
if (amount >= eATHBalanceFromBeforeThisTransfer) {
sharesToMove = fromELShares;
} else {
sharesToMove = (fromELShares * amount) / eATHBalanceFromBeforeThisTransfer;
}
if (sharesToMove > 0) {
if (sharesToMove > fromELShares) sharesToMove = fromELShares;
userStrategyShares[from] = fromELShares - sharesToMove;
userStrategyShares[to] += sharesToMove;
}
}
}
/// @dev Calculates a pro-rata share amount.
/// @param currentShares The total shares from which a part is taken.
/// @param partToCalcFor The partial amount for which shares are calculate.
/// @param wholeCorrespondsToCurrentShares The total amount corresponding to 'currentShares'.
/// @return The calculated pro-rata shares. Returns 0 if whole is 0, or if part/shares are 0.
/// Returns all currentShares if partToCalcFor is >= wholeCorrespondsToCurrentShares.
function _proRataShares(
uint256 currentShares,
uint256 partToCalcFor,
uint256 wholeCorrespondsToCurrentShares
) internal pure returns (uint256) {
if (wholeCorrespondsToCurrentShares == 0) {
return 0;
}
if (partToCalcFor == 0 || currentShares == 0) {
return 0;
}
if (partToCalcFor >= wholeCorrespondsToCurrentShares) {
return currentShares;
}
return (currentShares * partToCalcFor) / wholeCorrespondsToCurrentShares;
}
// --- Test Helper Functions ---
function getStakedAmountForUser(address user) external view returns (uint256) {
return rewardData.stakers[user].stakedAmount;
}
function getTotalStakedInRewardData() external view returns (uint256) {
return rewardData.totalStaked;
}
/// @notice Updates the global vesting period for future unstakes.
/// @dev Does NOT affect already-initiated unstakes (their timestamp is stored at initiation).
/// @param newPeriod The new vesting period in seconds.
function setVestingPeriod(uint256 newPeriod) external onlyRole(DEFAULT_ADMIN_ROLE) {
require(newPeriod > 7 days, "ATHVault: period too short");
vestingPeriod = newPeriod;
emit VestingPeriodChanged(newPeriod);
}
}// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import {ERC20Burnable} from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol";
import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
/// @title VaultATH (vATH)
/// @author Aethir
/// @notice ERC20 token representing ATH that the ATHVault has staked into an external StakeBase contract.
/// @dev vATH is minted to and held by the ATHVault contract itself. It is an internal accounting token
/// for the vault's stake in StakeBase.
contract VaultATH is ERC20, ERC20Burnable, Ownable {
/// @notice The address of the ATHVault contract that owns and manages this vATH token.
address public immutable vault;
/// @notice Constructor to deploy the VaultATH token.
/// @dev Sets the ATHVault contract (msg.sender) as the owner.
constructor() ERC20("VaultATH", "vATH") Ownable(msg.sender) {
vault = msg.sender;
}
/// @notice Mints vATH tokens.
/// @dev Can only be called by the ATHVault contract (owner). Tokens can only be minted to the vault itself.
/// @param to The address to mint tokens to (must be the vault).
/// @param amount The amount of tokens to mint.
function mint(address to, uint256 amount) external onlyOwner {
require(to == vault, "VaultATH: can only mint to vault");
_mint(to, amount);
}
/// @notice Burns vATH tokens from an account.
/// @dev Can only be called by the ATHVault contract (owner). Tokens can only be burned from the vault's own balance.
/// @param account The account to burn tokens from (must be the vault).
/// @param amount The amount of tokens to burn.
function burnFrom(
address account,
uint256 amount
) public override onlyOwner {
require(account == vault, "VaultATH: can only burn from vault");
_burn(account, amount);
}
/// @notice Disables direct burning of vATH tokens.
/// @dev Only the ATHVault (owner) can burn its own vATH tokens via `burnFrom`.
/// Can only be called by owner (ATHVault), effectively making it non-callable by others directly.
function burn(uint256 /*amount*/) public override onlyOwner {
revert("VaultATH: direct burn disabled");
}
}{
"viaIR": true,
"optimizer": {
"enabled": true,
"runs": 200
},
"evmVersion": "paris",
"outputSelection": {
"*": {
"*": [
"evm.bytecode",
"evm.deployedBytecode",
"abi"
]
}
},
"metadata": {
"useLiteralContent": true
}
}Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
Contract ABI
API[{"inputs":[{"internalType":"string","name":"_name","type":"string"},{"internalType":"string","name":"_symbol","type":"string"},{"internalType":"address","name":"_lzEndpoint","type":"address"},{"internalType":"address","name":"_initialOwner","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"allowance","type":"uint256"},{"internalType":"uint256","name":"needed","type":"uint256"}],"name":"ERC20InsufficientAllowance","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"},{"internalType":"uint256","name":"balance","type":"uint256"},{"internalType":"uint256","name":"needed","type":"uint256"}],"name":"ERC20InsufficientBalance","type":"error"},{"inputs":[{"internalType":"address","name":"approver","type":"address"}],"name":"ERC20InvalidApprover","type":"error"},{"inputs":[{"internalType":"address","name":"receiver","type":"address"}],"name":"ERC20InvalidReceiver","type":"error"},{"inputs":[{"internalType":"address","name":"sender","type":"address"}],"name":"ERC20InvalidSender","type":"error"},{"inputs":[{"internalType":"address","name":"spender","type":"address"}],"name":"ERC20InvalidSpender","type":"error"},{"inputs":[],"name":"InvalidDelegate","type":"error"},{"inputs":[],"name":"InvalidEndpointCall","type":"error"},{"inputs":[],"name":"InvalidLocalDecimals","type":"error"},{"inputs":[{"internalType":"bytes","name":"options","type":"bytes"}],"name":"InvalidOptions","type":"error"},{"inputs":[],"name":"LzTokenUnavailable","type":"error"},{"inputs":[{"internalType":"uint32","name":"eid","type":"uint32"}],"name":"NoPeer","type":"error"},{"inputs":[{"internalType":"uint256","name":"msgValue","type":"uint256"}],"name":"NotEnoughNative","type":"error"},{"inputs":[{"internalType":"address","name":"addr","type":"address"}],"name":"OnlyEndpoint","type":"error"},{"inputs":[{"internalType":"uint32","name":"eid","type":"uint32"},{"internalType":"bytes32","name":"sender","type":"bytes32"}],"name":"OnlyPeer","type":"error"},{"inputs":[],"name":"OnlySelf","type":"error"},{"inputs":[{"internalType":"address","name":"owner","type":"address"}],"name":"OwnableInvalidOwner","type":"error"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"OwnableUnauthorizedAccount","type":"error"},{"inputs":[{"internalType":"address","name":"token","type":"address"}],"name":"SafeERC20FailedOperation","type":"error"},{"inputs":[{"internalType":"bytes","name":"result","type":"bytes"}],"name":"SimulationResult","type":"error"},{"inputs":[{"internalType":"uint256","name":"amountLD","type":"uint256"},{"internalType":"uint256","name":"minAmountLD","type":"uint256"}],"name":"SlippageExceeded","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"spender","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Approval","type":"event"},{"anonymous":false,"inputs":[{"components":[{"internalType":"uint32","name":"eid","type":"uint32"},{"internalType":"uint16","name":"msgType","type":"uint16"},{"internalType":"bytes","name":"options","type":"bytes"}],"indexed":false,"internalType":"struct EnforcedOptionParam[]","name":"_enforcedOptions","type":"tuple[]"}],"name":"EnforcedOptionSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"inspector","type":"address"}],"name":"MsgInspectorSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"guid","type":"bytes32"},{"indexed":false,"internalType":"uint32","name":"srcEid","type":"uint32"},{"indexed":true,"internalType":"address","name":"toAddress","type":"address"},{"indexed":false,"internalType":"uint256","name":"amountReceivedLD","type":"uint256"}],"name":"OFTReceived","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"guid","type":"bytes32"},{"indexed":false,"internalType":"uint32","name":"dstEid","type":"uint32"},{"indexed":true,"internalType":"address","name":"fromAddress","type":"address"},{"indexed":false,"internalType":"uint256","name":"amountSentLD","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"amountReceivedLD","type":"uint256"}],"name":"OFTSent","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint32","name":"eid","type":"uint32"},{"indexed":false,"internalType":"bytes32","name":"peer","type":"bytes32"}],"name":"PeerSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"preCrimeAddress","type":"address"}],"name":"PreCrimeSet","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"from","type":"address"},{"indexed":true,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"Transfer","type":"event"},{"inputs":[],"name":"SEND","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"SEND_AND_CALL","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"srcEid","type":"uint32"},{"internalType":"bytes32","name":"sender","type":"bytes32"},{"internalType":"uint64","name":"nonce","type":"uint64"}],"internalType":"struct Origin","name":"origin","type":"tuple"}],"name":"allowInitializePath","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"spender","type":"address"}],"name":"allowance","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"approvalRequired","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"address","name":"spender","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"approve","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"account","type":"address"}],"name":"balanceOf","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint32","name":"_eid","type":"uint32"},{"internalType":"uint16","name":"_msgType","type":"uint16"},{"internalType":"bytes","name":"_extraOptions","type":"bytes"}],"name":"combineOptions","outputs":[{"internalType":"bytes","name":"","type":"bytes"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimalConversionRate","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"decimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"endpoint","outputs":[{"internalType":"contract ILayerZeroEndpointV2","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint32","name":"eid","type":"uint32"},{"internalType":"uint16","name":"msgType","type":"uint16"}],"name":"enforcedOptions","outputs":[{"internalType":"bytes","name":"enforcedOption","type":"bytes"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"srcEid","type":"uint32"},{"internalType":"bytes32","name":"sender","type":"bytes32"},{"internalType":"uint64","name":"nonce","type":"uint64"}],"internalType":"struct Origin","name":"","type":"tuple"},{"internalType":"bytes","name":"","type":"bytes"},{"internalType":"address","name":"_sender","type":"address"}],"name":"isComposeMsgSender","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint32","name":"_eid","type":"uint32"},{"internalType":"bytes32","name":"_peer","type":"bytes32"}],"name":"isPeer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"srcEid","type":"uint32"},{"internalType":"bytes32","name":"sender","type":"bytes32"},{"internalType":"uint64","name":"nonce","type":"uint64"}],"internalType":"struct Origin","name":"_origin","type":"tuple"},{"internalType":"bytes32","name":"_guid","type":"bytes32"},{"internalType":"bytes","name":"_message","type":"bytes"},{"internalType":"address","name":"_executor","type":"address"},{"internalType":"bytes","name":"_extraData","type":"bytes"}],"name":"lzReceive","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"components":[{"components":[{"internalType":"uint32","name":"srcEid","type":"uint32"},{"internalType":"bytes32","name":"sender","type":"bytes32"},{"internalType":"uint64","name":"nonce","type":"uint64"}],"internalType":"struct Origin","name":"origin","type":"tuple"},{"internalType":"uint32","name":"dstEid","type":"uint32"},{"internalType":"address","name":"receiver","type":"address"},{"internalType":"bytes32","name":"guid","type":"bytes32"},{"internalType":"uint256","name":"value","type":"uint256"},{"internalType":"address","name":"executor","type":"address"},{"internalType":"bytes","name":"message","type":"bytes"},{"internalType":"bytes","name":"extraData","type":"bytes"}],"internalType":"struct InboundPacket[]","name":"_packets","type":"tuple[]"}],"name":"lzReceiveAndRevert","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"srcEid","type":"uint32"},{"internalType":"bytes32","name":"sender","type":"bytes32"},{"internalType":"uint64","name":"nonce","type":"uint64"}],"internalType":"struct Origin","name":"_origin","type":"tuple"},{"internalType":"bytes32","name":"_guid","type":"bytes32"},{"internalType":"bytes","name":"_message","type":"bytes"},{"internalType":"address","name":"_executor","type":"address"},{"internalType":"bytes","name":"_extraData","type":"bytes"}],"name":"lzReceiveSimulate","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[],"name":"msgInspector","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"name","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint32","name":"","type":"uint32"},{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"nextNonce","outputs":[{"internalType":"uint64","name":"nonce","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"oApp","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"oAppVersion","outputs":[{"internalType":"uint64","name":"senderVersion","type":"uint64"},{"internalType":"uint64","name":"receiverVersion","type":"uint64"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"oftVersion","outputs":[{"internalType":"bytes4","name":"interfaceId","type":"bytes4"},{"internalType":"uint64","name":"version","type":"uint64"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint32","name":"eid","type":"uint32"}],"name":"peers","outputs":[{"internalType":"bytes32","name":"peer","type":"bytes32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"preCrime","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"dstEid","type":"uint32"},{"internalType":"bytes32","name":"to","type":"bytes32"},{"internalType":"uint256","name":"amountLD","type":"uint256"},{"internalType":"uint256","name":"minAmountLD","type":"uint256"},{"internalType":"bytes","name":"extraOptions","type":"bytes"},{"internalType":"bytes","name":"composeMsg","type":"bytes"},{"internalType":"bytes","name":"oftCmd","type":"bytes"}],"internalType":"struct SendParam","name":"_sendParam","type":"tuple"}],"name":"quoteOFT","outputs":[{"components":[{"internalType":"uint256","name":"minAmountLD","type":"uint256"},{"internalType":"uint256","name":"maxAmountLD","type":"uint256"}],"internalType":"struct OFTLimit","name":"oftLimit","type":"tuple"},{"components":[{"internalType":"int256","name":"feeAmountLD","type":"int256"},{"internalType":"string","name":"description","type":"string"}],"internalType":"struct OFTFeeDetail[]","name":"oftFeeDetails","type":"tuple[]"},{"components":[{"internalType":"uint256","name":"amountSentLD","type":"uint256"},{"internalType":"uint256","name":"amountReceivedLD","type":"uint256"}],"internalType":"struct OFTReceipt","name":"oftReceipt","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"dstEid","type":"uint32"},{"internalType":"bytes32","name":"to","type":"bytes32"},{"internalType":"uint256","name":"amountLD","type":"uint256"},{"internalType":"uint256","name":"minAmountLD","type":"uint256"},{"internalType":"bytes","name":"extraOptions","type":"bytes"},{"internalType":"bytes","name":"composeMsg","type":"bytes"},{"internalType":"bytes","name":"oftCmd","type":"bytes"}],"internalType":"struct SendParam","name":"_sendParam","type":"tuple"},{"internalType":"bool","name":"_payInLzToken","type":"bool"}],"name":"quoteSend","outputs":[{"components":[{"internalType":"uint256","name":"nativeFee","type":"uint256"},{"internalType":"uint256","name":"lzTokenFee","type":"uint256"}],"internalType":"struct MessagingFee","name":"msgFee","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"dstEid","type":"uint32"},{"internalType":"bytes32","name":"to","type":"bytes32"},{"internalType":"uint256","name":"amountLD","type":"uint256"},{"internalType":"uint256","name":"minAmountLD","type":"uint256"},{"internalType":"bytes","name":"extraOptions","type":"bytes"},{"internalType":"bytes","name":"composeMsg","type":"bytes"},{"internalType":"bytes","name":"oftCmd","type":"bytes"}],"internalType":"struct SendParam","name":"_sendParam","type":"tuple"},{"components":[{"internalType":"uint256","name":"nativeFee","type":"uint256"},{"internalType":"uint256","name":"lzTokenFee","type":"uint256"}],"internalType":"struct MessagingFee","name":"_fee","type":"tuple"},{"internalType":"address","name":"_refundAddress","type":"address"}],"name":"send","outputs":[{"components":[{"internalType":"bytes32","name":"guid","type":"bytes32"},{"internalType":"uint64","name":"nonce","type":"uint64"},{"components":[{"internalType":"uint256","name":"nativeFee","type":"uint256"},{"internalType":"uint256","name":"lzTokenFee","type":"uint256"}],"internalType":"struct MessagingFee","name":"fee","type":"tuple"}],"internalType":"struct MessagingReceipt","name":"msgReceipt","type":"tuple"},{"components":[{"internalType":"uint256","name":"amountSentLD","type":"uint256"},{"internalType":"uint256","name":"amountReceivedLD","type":"uint256"}],"internalType":"struct OFTReceipt","name":"oftReceipt","type":"tuple"}],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"_delegate","type":"address"}],"name":"setDelegate","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"uint32","name":"eid","type":"uint32"},{"internalType":"uint16","name":"msgType","type":"uint16"},{"internalType":"bytes","name":"options","type":"bytes"}],"internalType":"struct EnforcedOptionParam[]","name":"_enforcedOptions","type":"tuple[]"}],"name":"setEnforcedOptions","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_msgInspector","type":"address"}],"name":"setMsgInspector","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint32","name":"_eid","type":"uint32"},{"internalType":"bytes32","name":"_peer","type":"bytes32"}],"name":"setPeer","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_preCrime","type":"address"}],"name":"setPreCrime","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"sharedDecimals","outputs":[{"internalType":"uint8","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"symbol","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"token","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalSupply","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transfer","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"from","type":"address"},{"internalType":"address","name":"to","type":"address"},{"internalType":"uint256","name":"value","type":"uint256"}],"name":"transferFrom","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"}]Contract Creation Code
60c0806040523461048c57600090613021803803809161001f8285610491565b83398101916080828403126104895781516001600160401b038111610487578361004a9184016104ca565b60208301519093906001600160401b038111610483579061006c9184016104ca565b9161007960408201610539565b906001600160a01b039061008f90606001610539565b16801561046f5782546001600160a01b0319811682178455604051929082906001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08680a36001600160a01b0316608081905290813b1561046b57602483858094829463ca5eb5e160e01b845260048401525af18015610460578290610450575b505064e8d4a5100060a05282516001600160401b03811161043c57600854600181811c91168015610432575b602082101461041e57601f81116103bb575b506020601f82116001146103585782939482939261034d575b50508160011b916000199060031b1c1916176008555b8151906001600160401b03821161033957600954600181811c9116801561032f575b602082101461031b57601f81116102b8575b50602090601f83116001146102575791928361024c575b50508160011b916000199060031b1c1916176009555b604051612ad3908161054e82396080518181816107c3015281816108e301528181610ce801528181610fd101528181611822015281816128e60152612988015260a051818181610c380152818161129001528181611e5f0152818161207301526125c10152f35b0151905038806101cf565b90601f1983169360098352818320925b8581106102a057508360019510610287575b505050811b016009556101e5565b015160001960f88460031b161c19169055388080610279565b91926020600181928685015181550194019201610267565b600982527f6e1540171b6c0c960b71a7020d9f60077f6af931a8bbf590da0223dacf75c7af601f840160051c81019160208510610311575b601f0160051c01905b81811061030657506101b8565b8281556001016102f9565b90915081906102f0565b634e487b7160e01b82526022600452602482fd5b90607f16906101a6565b634e487b7160e01b81526041600452602490fd5b01519050388061016e565b6008835280832090601f198316845b8181106103a35750958360019596971061038a575b505050811b01600855610184565b015160001960f88460031b161c1916905538808061037c565b9192602060018192868b015181550194019201610367565b600883527ff3f7a9fe364faab93b216da50a3214154f22a0a2b415b23a84c8169e8b636ee3601f830160051c81019160208410610414575b601f0160051c01905b8181106104095750610155565b8381556001016103fc565b90915081906103f3565b634e487b7160e01b83526022600452602483fd5b90607f1690610143565b634e487b7160e01b82526041600452602482fd5b61045991610491565b3881610117565b6040513d84823e3d90fd5b8380fd5b631e4fbdf760e01b83526004839052602483fd5b8280fd5b505b80fd5b600080fd5b601f909101601f19168101906001600160401b038211908210176104b457604052565b634e487b7160e01b600052604160045260246000fd5b81601f8201121561048c578051906001600160401b0382116104b457604051926104fe601f8401601f191660200185610491565b8284526020838301011161048c5760005b82811061052457505060206000918301015290565b8060208092840101518282870101520161050f565b51906001600160a01b038216820361048c5756fe6080604052600436101561001257600080fd5b60003560e01c806306fdde03146102b2578063095ea7b3146102ad5780630d35b415146102a8578063111ecdad146102a357806313137d651461029e578063134d4f2514610299578063156a0d0f1461029457806317442b701461028f57806318160ddd1461028a5780631f5e13341461028557806323b872dd14610280578063313ce5671461027b5780633400288b146102765780633b6f743b1461027157806352ae2879146101ef5780635535d4611461026c5780635a0dfe4d146102675780635e280f11146102625780636fc1b31e1461025d57806370a0823114610258578063715018a6146102535780637d25a05e1461024e57806382413eac14610249578063857749b0146102445780638da5cb5b1461023f57806395d89b411461023a578063963efcaa146102355780639f68b96414610230578063a9059cbb1461022b578063b731ea0a14610226578063b98bd07014610221578063bb0b6a531461021c578063bc70b35414610217578063bd815db014610212578063c7c7f5b31461020d578063ca5eb5e114610208578063d045a0dc14610203578063d4243885146101fe578063dd62ed3e146101f9578063f2fde38b146101f4578063fc0c546a146101ef5763ff7bd03d146101ea57600080fd5b611a30565b610d8a565b6119a3565b611940565b6118d0565b61189d565b6117f8565b6116a8565b6114fb565b6114a7565b61146c565b611387565b611304565b6112cf565b6112b3565b611278565b6111d0565b6111a7565b61118b565b61112d565b611106565b6110ad565b611070565b611000565b610fbb565b610f73565b610ef4565b610bd4565b610b43565b610b19565b610a6d565b610a51565b610a33565b610a11565b6109ea565b6109ce565b6107b0565b6106d9565b610587565b610411565b610323565b60009103126102c257565b600080fd5b60005b8381106102da5750506000910152565b81810151838201526020016102ca565b90602091610303815180928185528580860191016102c7565b601f01601f1916010190565b9060206103209281815201906102ea565b90565b346102c25760003660031901126102c257604051600060085461034581610dc5565b80845290600181169081156103dc575060011461037d575b6103798361036d81850382610ed3565b6040519182918261030f565b0390f35b600860009081527ff3f7a9fe364faab93b216da50a3214154f22a0a2b415b23a84c8169e8b636ee3939250905b8082106103c25750909150810160200161036d61035d565b9192600181602092548385880101520191019092916103aa565b60ff191660208086019190915291151560051b8401909101915061036d905061035d565b6001600160a01b038116036102c257565b346102c25760403660031901126102c25760043561042e81610400565b60243533156104c2576001600160a01b0382169182156104ac57610472829133600052600660205260406000209060018060a01b0316600052602052604060002090565b5560405190815233907f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92590602090a3602060405160018152f35b634a1406b160e11b600052600060045260246000fd5b63e602df0560e01b600052600060045260246000fd5b908160e09103126102c25790565b939291906105028560a081019260208091805184520151910152565b60a06040860152815180915260c0850190602060c08260051b8801019301916000905b82821061054b57505050509060606105499294019060208091805184520151910152565b565b9091929360208061057960019360bf198c82030186526040838a5180518452015191818582015201906102ea565b960192019201909291610525565b346102c25760203660031901126102c2576004356001600160401b0381116102c2576105b79036906004016104d8565b6105bf611a95565b506105c8611a95565b50604051637e062a3560e11b8152602081600481305afa9081156106a7576004916020916000916106ac575b506040516318160ddd60e01b815292839182906001600160a01b03165afa9081156106a757600091610678575b5061062a611a77565b9060008252602082015261037961065c610642611af5565b936040810135610656606083013592611b3d565b50611e56565b610664611a77565b9182526020820152604051938493846104e6565b61069a915060203d6020116106a0575b6106928183610ed3565b810190611acf565b38610621565b503d610688565b611ac3565b6106cc9150823d84116106d2575b6106c48183610ed3565b810190611aae565b386105f4565b503d6106ba565b346102c25760003660031901126102c2576004546040516001600160a01b039091168152602090f35b60609060031901126102c257600490565b9181601f840112156102c2578235916001600160401b0383116102c257602083818601950101116102c257565b600319810160e081126102c2576060600091126107ad575060049182606435926084356001600160401b0381116102c2578161077d918401610713565b9390939260a43561078d81610400565b9260c4356001600160401b0381116102c2576107a99201610713565b9091565b80fd5b6107b936610740565b50919492915050337f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316036109b95781356107fb81610b35565b61080481611eaa565b90602084013580920361099257505061082c6108208583612591565b6001600160a01b031690565b9361085261084261083d838561259d565b6125b3565b61084b85611b3d565b50866125e7565b9161085d8260281090565b6108b5575b505061088e7fefed6d3500546b29533b128a29e3a94d70788727f0507505ac12eaf2e578fd9c92611b3d565b6040805163ffffffff92909216825260208201929092526001600160a01b039490941693a3005b90826108e0926108da6108ca60408801611ede565b936108d488611b3d565b9261265f565b92612682565b917f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316803b156102c257604051633e5ac80960e11b815293600091859182908490829061093a908b8d60048501611ee8565b03925af19081156106a7577fefed6d3500546b29533b128a29e3a94d70788727f0507505ac12eaf2e578fd9c9361088e92610977575b5092610862565b80610986600061098c93610ed3565b806102b7565b38610970565b806109a163ffffffff92610b35565b63309afaf360e21b6000521660045260245260446000fd5b6391ac5e4f60e01b6000523360045260246000fd5b346102c25760003660031901126102c257602060405160028152f35b346102c25760003660031901126102c2576040805162b9270b60e21b815260016020820152f35b346102c25760003660031901126102c257604080516001815260026020820152f35b346102c25760003660031901126102c2576020600754604051908152f35b346102c25760003660031901126102c257602060405160018152f35b346102c25760603660031901126102c257600435610a8a81610400565b602435610a9681610400565b6001600160a01b03821660009081526006602090815260408083203384529091529020549160443591906000198410610ae0575b610ad49350611f13565b60405160018152602090f35b828410610afc57610af783610ad4950333836124f9565b610aca565b8284637dc7a0d960e11b6000523360045260245260445260646000fd5b346102c25760003660031901126102c257602060405160128152f35b63ffffffff8116036102c257565b346102c25760403660031901126102c2577f238399d427b947898edb290f5ff0f9109849b1c3ba196a42e35f00c50a54b98b600435610b8181610b35565b60243590610b8d611ff9565b63ffffffff8116600052600160205281604060002055610bc5604051928392836020909392919363ffffffff60408201951681520152565b0390a1005b801515036102c257565b346102c25760403660031901126102c2576004356001600160401b0381116102c257610c049036906004016104d8565b602435610c1081610bca565b610c18611a95565b50813591606081013590610c636040820135610c3386610b35565b610c5e7f00000000000000000000000000000000000000000000000000000000000000008092612559565b612579565b91808310610d7257610ce4604086610cc987610c7f888861205c565b90610c8985610b35565b610c91611a95565b50610c9b85611eaa565b610cb2610ca6611a86565b63ffffffff9097168752565b602086015285850152606084015215156080830152565b815180938192631bb8518b60e31b83523090600484016121a8565b03817f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03165afa80156106a75761037991600091610d43575b5060405191829182815181526020918201519181019190915260400190565b610d65915060403d604011610d6b575b610d5d8183610ed3565b810190612194565b82610d24565b503d610d53565b826371c4efed60e01b60005260045260245260446000fd5b346102c25760003660031901126102c2576020604051308152f35b6024359061ffff821682036102c257565b359061ffff821682036102c257565b90600182811c92168015610df5575b6020831014610ddf57565b634e487b7160e01b600052602260045260246000fd5b91607f1691610dd4565b60009291815491610e0f83610dc5565b8083529260018116908115610e655750600114610e2b57505050565b60009081526020812093945091925b838310610e4b575060209250010190565b600181602092949394548385870101520191019190610e3a565b915050602093945060ff929192191683830152151560051b010190565b634e487b7160e01b600052604160045260246000fd5b606081019081106001600160401b03821117610eb357604052565b610e82565b604081019081106001600160401b03821117610eb357604052565b90601f801991011681019081106001600160401b03821117610eb357604052565b346102c25760403660031901126102c257610379610f58610f5f610f4c600435610f1d81610b35565b63ffffffff610f2a610da5565b9116600052600360205260406000209061ffff16600052602052604060002090565b60405192838092610dff565b0382610ed3565b6040519182916020835260208301906102ea565b346102c25760403660031901126102c2576020610fb1600435610f9581610b35565b6024359063ffffffff1660005260016020526040600020541490565b6040519015158152f35b346102c25760003660031901126102c2576040517f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03168152602090f35b346102c25760203660031901126102c2577ff0be4f1e87349231d80c36b33f9e8639658eeaf474014dee15a3e6a4d4414197602060043561104081610400565b611048611ff9565b600480546001600160a01b0319166001600160a01b03929092169182179055604051908152a1005b346102c25760203660031901126102c25760043561108d81610400565b60018060a01b031660005260056020526020604060002054604051908152f35b346102c25760003660031901126102c2576110c6611ff9565b600080546001600160a01b0319811682556001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a3005b346102c25760403660031901126102c257611122600435610b35565b602060405160008152f35b346102c25760a03660031901126102c25761114736610702565b506064356001600160401b0381116102c257611167903690600401610713565b5050602060843561117781610400565b6040516001600160a01b0390911630148152f35b346102c25760003660031901126102c257602060405160068152f35b346102c25760003660031901126102c2576000546040516001600160a01b039091168152602090f35b346102c25760003660031901126102c25760405160006009546111f281610dc5565b80845290600181169081156103dc5750600114611219576103798361036d81850382610ed3565b600960009081527f6e1540171b6c0c960b71a7020d9f60077f6af931a8bbf590da0223dacf75c7af939250905b80821061125e5750909150810160200161036d61035d565b919260018160209254838588010152019101909291611246565b346102c25760003660031901126102c25760206040517f00000000000000000000000000000000000000000000000000000000000000008152f35b346102c25760003660031901126102c257602060405160008152f35b346102c25760403660031901126102c2576112f96004356112ef81610400565b6024359033611f13565b602060405160018152f35b346102c25760003660031901126102c2576002546040516001600160a01b039091168152602090f35b9060206003198301126102c2576004356001600160401b0381116102c25760040160009280601f83011215611383578135936001600160401b0385116107ad57506020808301928560051b0101116102c2579190565b8380fd5b346102c2576113953661132d565b9061139e611ff9565b6113a782611ade565b906113b56040519283610ed3565b828252602082019260051b8101903682116102c25780935b8285106113df576113dd846123d2565b005b84356001600160401b0381116102c2578201906060823603126102c2576040519161140983610e98565b803561141481610b35565b835261142260208201610db6565b60208401526040810135906001600160401b0382116102c257019036601f830112156102c25760209261145c849336908581359101611b62565b60408201528152019401936113cd565b346102c25760203660031901126102c25763ffffffff60043561148e81610b35565b1660005260016020526020604060002054604051908152f35b346102c25760603660031901126102c2576004356114c481610b35565b6114cc610da5565b604435906001600160401b0382116102c257610379926114f3610f5f933690600401610713565b929091611c25565b6115043661132d565b60005b81811061157757604051638e9e709960e01b8152600081600481335afa80156106a75761155091600091611554575b50604051638351eea760e01b81529182916004830161030f565b0390fd5b61157191503d806000833e6115698183610ed3565b810190611dd0565b82611536565b611582818385611ce1565b906115b46115b061159284611b3d565b60208501359063ffffffff1660005260016020526040600020541490565b1590565b61164e5760c08201359160a08101356115d1610100830183611d09565b9490916115e060e08501611d3b565b936115ef610120820182611d09565b959095303b156102c25760009661161d926040519a8b9889978897633411683760e21b895260048901611d56565b0391305af19182156106a757600192611639575b505b01611507565b80610986600061164893610ed3565b38611631565b60019150611633565b916080610549929493611697604060c0830197805184526001600160401b0360208201511660208501520151604083019060208091805184520151910152565b019060208091805184520151910152565b60803660031901126102c2576004356001600160401b0381116102c2576116d39036906004016104d8565b60403660231901126102c2576064356116eb81610400565b6116f3611e2e565b506116fc611a95565b50611705611e2e565b5061170e611a95565b506060820135906117276040840135610c338535610b35565b91808310610d72575033156117e2576117679061174483336126e0565b61174e838561205c565b61175786611b3d565b91611761366124d1565b92612869565b90611770611a77565b928184528160208501527f85496b760a4b7f8d66384b9df21b381f5d1b1e79f229a47aaf4c232edc2fe59a6117d06117a9855193611b3d565b936040519181839233978460409194939263ffffffff606083019616825260208201520152565b0390a361037960405192839283611657565b634b637e8f60e11b600052600060045260246000fd5b346102c257600060203660031901126107ad578060043561181881610400565b611820611ff9565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316803b156118995760405163ca5eb5e160e01b81526001600160a01b0390921660048301529091908290602490829084905af180156106a757829061188b5780f35b61189491610ed3565b388180f35b5050fd5b6118a636610740565b50505092903033036118bf5761082c6108208583612591565b63029a949d60e31b60005260046000fd5b346102c25760203660031901126102c2577fd48d879cef83a1c0bdda516f27b13ddb1b3f8bbac1c9e1511bb2a659c2427760602060043561191081610400565b611918611ff9565b600280546001600160a01b0319166001600160a01b03929092169182179055604051908152a1005b346102c25760403660031901126102c257602061199a60043561196281610400565b6024359061196f82610400565b60018060a01b03166000526006835260406000209060018060a01b0316600052602052604060002090565b54604051908152f35b346102c25760203660031901126102c2576004356119c081610400565b6119c8611ff9565b6001600160a01b03168015611a1a57600080546001600160a01b03198116831782556001600160a01b0316907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09080a3005b631e4fbdf760e01b600052600060045260246000fd5b346102c25760603660031901126102c2576020611a4c36610702565b63ffffffff8135611a5c81610b35565b16600052600182528160406000205491013560405191148152f35b60405190610549604083610ed3565b6040519061054960a083610ed3565b60405190611aa282610eb8565b60006020838281520152565b908160209103126102c2575161032081610400565b6040513d6000823e3d90fd5b908160209103126102c2575190565b6001600160401b038111610eb35760051b60200190565b60405190611b04602083610ed3565b600080835282815b828110611b1857505050565b602090604051611b2781610eb8565b6000815260608382015282828501015201611b0c565b3561032081610b35565b6001600160401b038111610eb357601f01601f191660200190565b929192611b6e82611b47565b91611b7c6040519384610ed3565b8294818452818301116102c2578281602093846000960137010152565b90929192836002116102c25783116102c257600201916001190190565b602083610549939594956040519684611bd8899651809287808a0191016102c7565b8501918483013701016000815203601f198101845283610ed3565b908060209392818452848401376000828201840152601f01601f1916010190565b916020610320938181520191611bf3565b610f4c610f589263ffffffff611c5a939795969716600052600360205260406000209061ffff16600052602052604060002090565b805115611cbd578315611cb7576002841015611c8e575050611550604051928392639a6d49cd60e01b845260048401611c14565b909280611cb19161032094611cac611ca7368484611b62565b612499565b611b99565b91611bb6565b92509050565b509190610320913691611b62565b634e487b7160e01b600052603260045260246000fd5b9190811015611d045760051b8101359061013e19813603018212156102c2570190565b611ccb565b903590601e19813603018212156102c257018035906001600160401b0382116102c2576020019181360383136102c257565b3561032081610400565b6001600160401b038116036102c257565b929093611db2926001600160401b0360406103209a98999763ffffffff8135611d7e81610b35565b168852602081013560208901520135611d9681611d45565b166040860152606085015260e0608085015260e0840191611bf3565b6001600160a01b0390941660a082015280840360c090910152611bf3565b6020818303126102c2578051906001600160401b0382116102c2570181601f820112156102c2578051611e0281611b47565b92611e106040519485610ed3565b818452602082840101116102c25761032091602080850191016102c7565b60405190611e3b82610e98565b8160008152600060208201526040611e51611a95565b910152565b611e8590610c5e7f00000000000000000000000000000000000000000000000000000000000000008092612559565b918291808410611e925750565b836371c4efed60e01b60005260045260245260446000fd5b63ffffffff16806000526001602052604060002054908115611eca575090565b63f6ff4fb760e01b60005260045260246000fd5b3561032081611d45565b610320939260809260018060a01b0316825260208201526000604082015281606082015201906102ea565b90916001600160a01b0382169182156117e2576001600160a01b038416938415611fe3576001600160a01b038216600090815260056020526040812090929054848110611fbd5791611faa91611f8f86600080516020612a7e833981519152979695039160018060a01b03166000526005602052604060002090565b556001600160a01b0316600090815260056020526040902090565b80548301905550604051908152602090a3565b63391434e360e21b84526001600160a01b03909116600452602452506044829052606490fd5b63ec442f0560e01b600052600060045260246000fd5b6000546001600160a01b0316330361200d57565b63118cdaa760e01b6000523360045260246000fd5b908160209103126102c2575161032081610bca565b909161204e610320936040845260408401906102ea565b9160208184039101526102ea565b90916120c16120e8936120a46120986020860135927f000000000000000000000000000000000000000000000000000000000000000090612559565b6001600160401b031690565b6120bb6120b460a0870187611d09565b3691611b62565b916127aa565b9390928394600014612164576002905b6114f36120dd82611b3d565b916080810190611d09565b60045490926001600160a01b0390911690838261210457505050565b60405163043a78eb60e01b8152926020928492839182916121289160048401612037565b03915afa80156106a7576121395750565b61215a9060203d60201161215d575b6121528183610ed3565b810190612022565b50565b503d612148565b6001906120d1565b91908260409103126102c25760405161218481610eb8565b6020808294805184520151910152565b906040828203126102c2576103209161216c565b906020909392936040835263ffffffff815116604084015281810151606084015260806121fc6121e6604084015160a08488015260e08701906102ea565b6060840151868203603f190160a08801526102ea565b910151151560c08401526001600160a01b03909416910152565b8051821015611d045760209160051b010190565b601f821161223757505050565b6000526020600020906020601f840160051c83019310612272575b601f0160051c01905b818110612266575050565b6000815560010161225b565b9091508190612252565b91909182516001600160401b038111610eb3576122a38161229d8454610dc5565b8461222a565b6020601f82116001146122e45781906122d59394956000926122d9575b50508160011b916000199060031b1c19161790565b9055565b0151905038806122c0565b601f198216906122f984600052602060002090565b9160005b8181106123355750958360019596971061231c575b505050811b019055565b015160001960f88460031b161c19169055388080612312565b9192602060018192868b0151815501940192016122fd565b602081016020825282518091526040820191602060408360051b8301019401926000915b83831061238057505050505090565b90919293946020806123c3600193603f19868203018752606060408b5163ffffffff815116845261ffff86820151168685015201519181604082015201906102ea565b97019301930191939290612371565b60005b815181101561246257806123f860406123f060019486612216565b510151612499565b61245c60406124078386612216565b51015163ffffffff6124198487612216565b51511660005260036020526124576040600020612445602061243b878a612216565b51015161ffff1690565b61ffff16600052602052604060002090565b61227c565b016123d5565b506124947fbe4864a8e820971c0247f5992e2da559595f7bf076a21cb5928d443d2a13b674916040519182918261234d565b0390a1565b600361ffff600283015116036124ac5750565b604051639a6d49cd60e01b8152602060048201529081906115509060248301906102ea565b60409060231901126102c257604051906124ea82610eb8565b60243582526044356020830152565b6001600160a01b03169081156104c2576001600160a01b038116156104ac5761254091600052600660205260406000209060018060a01b0316600052602052604060002090565b55565b634e487b7160e01b600052601160045260246000fd5b8115612563570490565b634e487b7160e01b600052601260045260246000fd5b8181029291811591840414171561258c57565b612543565b906020116102c2573590565b906000906028116107ad57506020013560c01c90565b610320906001600160401b037f00000000000000000000000000000000000000000000000000000000000000009116612579565b6001600160a01b03811615612656575b6001600160a01b038116908115611fe3576007549083820180921161258c576007919091556001600160a01b031660009081526005602052604090208281540190556000600080516020612a7e8339815191526020604051858152a390565b5061dead6125f7565b919060009281602811611383579192506103209136916027190190602801611b62565b604c9193610320936040519586936001600160401b0360c01b9060c01b16602085015263ffffffff60e01b9060e01b166028840152602c8301526126cf81518092602086860191016102c7565b81010301601f198101835282610ed3565b6001600160a01b03811691908261272c57509060075482810180911161258c57600092600080516020612a7e833981519152916007555b600780548290039055604051908152602090a3565b6001600160a01b0381166000908152600560205260409020548281106127855791600080516020612a7e8339815191529161277f8260009695039160018060a01b03166000526005602052604060002090565b55612717565b63391434e360e21b6000526001600160a01b0390911660045260245260445260646000fd5b825115801593906127f8576127f59160689160405194859260208401526001600160401b0360c01b9060c01b1660408301523360488301526126cf81518092602086860191016102c7565b91565b50906040519160208301526001600160401b0360c01b9060c01b166040820152602881526127f5604882610ed3565b906080828203126102c25761286190604080519361284485610e98565b80518552602081015161285681611d45565b60208601520161216c565b604082015290565b6128c6608094926128e2969461287d611e2e565b50602061288a865161295a565b95019182518061294b575b5061289f85611eaa565b92511515926128af610ca6611a86565b602086015260408501526060840152151585830152565b6040518095819482936302637a4560e41b8452600484016121a8565b03917f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03165af19081156106a757600091612922575090565b610320915060803d608011612944575b61293c8183610ed3565b810190612827565b503d612932565b61295490612979565b38612895565b8034036129645790565b6304fb820960e51b6000523460045260246000fd5b60405163393f876560e21b81527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690602081600481855afa9081156106a757600091612a5e575b506001600160a01b0316918215612a4d5760209160009160405190848201926323b872dd60e01b84523360248401526044830152606482015260648152612a11608482610ed3565b519082855af115611ac3576000513d612a445750803b155b612a305750565b635274afe760e01b60005260045260246000fd5b60011415612a29565b6329b99a9560e11b60005260046000fd5b612a77915060203d6020116106d2576106c48183610ed3565b386129c956feddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3efa26469706673582212204d0742c0dea051e9e625aad9175bd0dcd1c6b63bf3847ccf7b5dc7c5c339b17064736f6c634300081b0033000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000001a44076050125825900e736c501f859c50fe728c0000000000000000000000004108eaa097bd1e2f05f2571b3075a2473744a5ac0000000000000000000000000000000000000000000000000000000000000008656967656e41544800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000046541544800000000000000000000000000000000000000000000000000000000
Deployed Bytecode
0x6080604052600436101561001257600080fd5b60003560e01c806306fdde03146102b2578063095ea7b3146102ad5780630d35b415146102a8578063111ecdad146102a357806313137d651461029e578063134d4f2514610299578063156a0d0f1461029457806317442b701461028f57806318160ddd1461028a5780631f5e13341461028557806323b872dd14610280578063313ce5671461027b5780633400288b146102765780633b6f743b1461027157806352ae2879146101ef5780635535d4611461026c5780635a0dfe4d146102675780635e280f11146102625780636fc1b31e1461025d57806370a0823114610258578063715018a6146102535780637d25a05e1461024e57806382413eac14610249578063857749b0146102445780638da5cb5b1461023f57806395d89b411461023a578063963efcaa146102355780639f68b96414610230578063a9059cbb1461022b578063b731ea0a14610226578063b98bd07014610221578063bb0b6a531461021c578063bc70b35414610217578063bd815db014610212578063c7c7f5b31461020d578063ca5eb5e114610208578063d045a0dc14610203578063d4243885146101fe578063dd62ed3e146101f9578063f2fde38b146101f4578063fc0c546a146101ef5763ff7bd03d146101ea57600080fd5b611a30565b610d8a565b6119a3565b611940565b6118d0565b61189d565b6117f8565b6116a8565b6114fb565b6114a7565b61146c565b611387565b611304565b6112cf565b6112b3565b611278565b6111d0565b6111a7565b61118b565b61112d565b611106565b6110ad565b611070565b611000565b610fbb565b610f73565b610ef4565b610bd4565b610b43565b610b19565b610a6d565b610a51565b610a33565b610a11565b6109ea565b6109ce565b6107b0565b6106d9565b610587565b610411565b610323565b60009103126102c257565b600080fd5b60005b8381106102da5750506000910152565b81810151838201526020016102ca565b90602091610303815180928185528580860191016102c7565b601f01601f1916010190565b9060206103209281815201906102ea565b90565b346102c25760003660031901126102c257604051600060085461034581610dc5565b80845290600181169081156103dc575060011461037d575b6103798361036d81850382610ed3565b6040519182918261030f565b0390f35b600860009081527ff3f7a9fe364faab93b216da50a3214154f22a0a2b415b23a84c8169e8b636ee3939250905b8082106103c25750909150810160200161036d61035d565b9192600181602092548385880101520191019092916103aa565b60ff191660208086019190915291151560051b8401909101915061036d905061035d565b6001600160a01b038116036102c257565b346102c25760403660031901126102c25760043561042e81610400565b60243533156104c2576001600160a01b0382169182156104ac57610472829133600052600660205260406000209060018060a01b0316600052602052604060002090565b5560405190815233907f8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b92590602090a3602060405160018152f35b634a1406b160e11b600052600060045260246000fd5b63e602df0560e01b600052600060045260246000fd5b908160e09103126102c25790565b939291906105028560a081019260208091805184520151910152565b60a06040860152815180915260c0850190602060c08260051b8801019301916000905b82821061054b57505050509060606105499294019060208091805184520151910152565b565b9091929360208061057960019360bf198c82030186526040838a5180518452015191818582015201906102ea565b960192019201909291610525565b346102c25760203660031901126102c2576004356001600160401b0381116102c2576105b79036906004016104d8565b6105bf611a95565b506105c8611a95565b50604051637e062a3560e11b8152602081600481305afa9081156106a7576004916020916000916106ac575b506040516318160ddd60e01b815292839182906001600160a01b03165afa9081156106a757600091610678575b5061062a611a77565b9060008252602082015261037961065c610642611af5565b936040810135610656606083013592611b3d565b50611e56565b610664611a77565b9182526020820152604051938493846104e6565b61069a915060203d6020116106a0575b6106928183610ed3565b810190611acf565b38610621565b503d610688565b611ac3565b6106cc9150823d84116106d2575b6106c48183610ed3565b810190611aae565b386105f4565b503d6106ba565b346102c25760003660031901126102c2576004546040516001600160a01b039091168152602090f35b60609060031901126102c257600490565b9181601f840112156102c2578235916001600160401b0383116102c257602083818601950101116102c257565b600319810160e081126102c2576060600091126107ad575060049182606435926084356001600160401b0381116102c2578161077d918401610713565b9390939260a43561078d81610400565b9260c4356001600160401b0381116102c2576107a99201610713565b9091565b80fd5b6107b936610740565b50919492915050337f0000000000000000000000001a44076050125825900e736c501f859c50fe728c6001600160a01b0316036109b95781356107fb81610b35565b61080481611eaa565b90602084013580920361099257505061082c6108208583612591565b6001600160a01b031690565b9361085261084261083d838561259d565b6125b3565b61084b85611b3d565b50866125e7565b9161085d8260281090565b6108b5575b505061088e7fefed6d3500546b29533b128a29e3a94d70788727f0507505ac12eaf2e578fd9c92611b3d565b6040805163ffffffff92909216825260208201929092526001600160a01b039490941693a3005b90826108e0926108da6108ca60408801611ede565b936108d488611b3d565b9261265f565b92612682565b917f0000000000000000000000001a44076050125825900e736c501f859c50fe728c6001600160a01b0316803b156102c257604051633e5ac80960e11b815293600091859182908490829061093a908b8d60048501611ee8565b03925af19081156106a7577fefed6d3500546b29533b128a29e3a94d70788727f0507505ac12eaf2e578fd9c9361088e92610977575b5092610862565b80610986600061098c93610ed3565b806102b7565b38610970565b806109a163ffffffff92610b35565b63309afaf360e21b6000521660045260245260446000fd5b6391ac5e4f60e01b6000523360045260246000fd5b346102c25760003660031901126102c257602060405160028152f35b346102c25760003660031901126102c2576040805162b9270b60e21b815260016020820152f35b346102c25760003660031901126102c257604080516001815260026020820152f35b346102c25760003660031901126102c2576020600754604051908152f35b346102c25760003660031901126102c257602060405160018152f35b346102c25760603660031901126102c257600435610a8a81610400565b602435610a9681610400565b6001600160a01b03821660009081526006602090815260408083203384529091529020549160443591906000198410610ae0575b610ad49350611f13565b60405160018152602090f35b828410610afc57610af783610ad4950333836124f9565b610aca565b8284637dc7a0d960e11b6000523360045260245260445260646000fd5b346102c25760003660031901126102c257602060405160128152f35b63ffffffff8116036102c257565b346102c25760403660031901126102c2577f238399d427b947898edb290f5ff0f9109849b1c3ba196a42e35f00c50a54b98b600435610b8181610b35565b60243590610b8d611ff9565b63ffffffff8116600052600160205281604060002055610bc5604051928392836020909392919363ffffffff60408201951681520152565b0390a1005b801515036102c257565b346102c25760403660031901126102c2576004356001600160401b0381116102c257610c049036906004016104d8565b602435610c1081610bca565b610c18611a95565b50813591606081013590610c636040820135610c3386610b35565b610c5e7f000000000000000000000000000000000000000000000000000000e8d4a510008092612559565b612579565b91808310610d7257610ce4604086610cc987610c7f888861205c565b90610c8985610b35565b610c91611a95565b50610c9b85611eaa565b610cb2610ca6611a86565b63ffffffff9097168752565b602086015285850152606084015215156080830152565b815180938192631bb8518b60e31b83523090600484016121a8565b03817f0000000000000000000000001a44076050125825900e736c501f859c50fe728c6001600160a01b03165afa80156106a75761037991600091610d43575b5060405191829182815181526020918201519181019190915260400190565b610d65915060403d604011610d6b575b610d5d8183610ed3565b810190612194565b82610d24565b503d610d53565b826371c4efed60e01b60005260045260245260446000fd5b346102c25760003660031901126102c2576020604051308152f35b6024359061ffff821682036102c257565b359061ffff821682036102c257565b90600182811c92168015610df5575b6020831014610ddf57565b634e487b7160e01b600052602260045260246000fd5b91607f1691610dd4565b60009291815491610e0f83610dc5565b8083529260018116908115610e655750600114610e2b57505050565b60009081526020812093945091925b838310610e4b575060209250010190565b600181602092949394548385870101520191019190610e3a565b915050602093945060ff929192191683830152151560051b010190565b634e487b7160e01b600052604160045260246000fd5b606081019081106001600160401b03821117610eb357604052565b610e82565b604081019081106001600160401b03821117610eb357604052565b90601f801991011681019081106001600160401b03821117610eb357604052565b346102c25760403660031901126102c257610379610f58610f5f610f4c600435610f1d81610b35565b63ffffffff610f2a610da5565b9116600052600360205260406000209061ffff16600052602052604060002090565b60405192838092610dff565b0382610ed3565b6040519182916020835260208301906102ea565b346102c25760403660031901126102c2576020610fb1600435610f9581610b35565b6024359063ffffffff1660005260016020526040600020541490565b6040519015158152f35b346102c25760003660031901126102c2576040517f0000000000000000000000001a44076050125825900e736c501f859c50fe728c6001600160a01b03168152602090f35b346102c25760203660031901126102c2577ff0be4f1e87349231d80c36b33f9e8639658eeaf474014dee15a3e6a4d4414197602060043561104081610400565b611048611ff9565b600480546001600160a01b0319166001600160a01b03929092169182179055604051908152a1005b346102c25760203660031901126102c25760043561108d81610400565b60018060a01b031660005260056020526020604060002054604051908152f35b346102c25760003660031901126102c2576110c6611ff9565b600080546001600160a01b0319811682556001600160a01b03167f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e08280a3005b346102c25760403660031901126102c257611122600435610b35565b602060405160008152f35b346102c25760a03660031901126102c25761114736610702565b506064356001600160401b0381116102c257611167903690600401610713565b5050602060843561117781610400565b6040516001600160a01b0390911630148152f35b346102c25760003660031901126102c257602060405160068152f35b346102c25760003660031901126102c2576000546040516001600160a01b039091168152602090f35b346102c25760003660031901126102c25760405160006009546111f281610dc5565b80845290600181169081156103dc5750600114611219576103798361036d81850382610ed3565b600960009081527f6e1540171b6c0c960b71a7020d9f60077f6af931a8bbf590da0223dacf75c7af939250905b80821061125e5750909150810160200161036d61035d565b919260018160209254838588010152019101909291611246565b346102c25760003660031901126102c25760206040517f000000000000000000000000000000000000000000000000000000e8d4a510008152f35b346102c25760003660031901126102c257602060405160008152f35b346102c25760403660031901126102c2576112f96004356112ef81610400565b6024359033611f13565b602060405160018152f35b346102c25760003660031901126102c2576002546040516001600160a01b039091168152602090f35b9060206003198301126102c2576004356001600160401b0381116102c25760040160009280601f83011215611383578135936001600160401b0385116107ad57506020808301928560051b0101116102c2579190565b8380fd5b346102c2576113953661132d565b9061139e611ff9565b6113a782611ade565b906113b56040519283610ed3565b828252602082019260051b8101903682116102c25780935b8285106113df576113dd846123d2565b005b84356001600160401b0381116102c2578201906060823603126102c2576040519161140983610e98565b803561141481610b35565b835261142260208201610db6565b60208401526040810135906001600160401b0382116102c257019036601f830112156102c25760209261145c849336908581359101611b62565b60408201528152019401936113cd565b346102c25760203660031901126102c25763ffffffff60043561148e81610b35565b1660005260016020526020604060002054604051908152f35b346102c25760603660031901126102c2576004356114c481610b35565b6114cc610da5565b604435906001600160401b0382116102c257610379926114f3610f5f933690600401610713565b929091611c25565b6115043661132d565b60005b81811061157757604051638e9e709960e01b8152600081600481335afa80156106a75761155091600091611554575b50604051638351eea760e01b81529182916004830161030f565b0390fd5b61157191503d806000833e6115698183610ed3565b810190611dd0565b82611536565b611582818385611ce1565b906115b46115b061159284611b3d565b60208501359063ffffffff1660005260016020526040600020541490565b1590565b61164e5760c08201359160a08101356115d1610100830183611d09565b9490916115e060e08501611d3b565b936115ef610120820182611d09565b959095303b156102c25760009661161d926040519a8b9889978897633411683760e21b895260048901611d56565b0391305af19182156106a757600192611639575b505b01611507565b80610986600061164893610ed3565b38611631565b60019150611633565b916080610549929493611697604060c0830197805184526001600160401b0360208201511660208501520151604083019060208091805184520151910152565b019060208091805184520151910152565b60803660031901126102c2576004356001600160401b0381116102c2576116d39036906004016104d8565b60403660231901126102c2576064356116eb81610400565b6116f3611e2e565b506116fc611a95565b50611705611e2e565b5061170e611a95565b506060820135906117276040840135610c338535610b35565b91808310610d72575033156117e2576117679061174483336126e0565b61174e838561205c565b61175786611b3d565b91611761366124d1565b92612869565b90611770611a77565b928184528160208501527f85496b760a4b7f8d66384b9df21b381f5d1b1e79f229a47aaf4c232edc2fe59a6117d06117a9855193611b3d565b936040519181839233978460409194939263ffffffff606083019616825260208201520152565b0390a361037960405192839283611657565b634b637e8f60e11b600052600060045260246000fd5b346102c257600060203660031901126107ad578060043561181881610400565b611820611ff9565b7f0000000000000000000000001a44076050125825900e736c501f859c50fe728c6001600160a01b0316803b156118995760405163ca5eb5e160e01b81526001600160a01b0390921660048301529091908290602490829084905af180156106a757829061188b5780f35b61189491610ed3565b388180f35b5050fd5b6118a636610740565b50505092903033036118bf5761082c6108208583612591565b63029a949d60e31b60005260046000fd5b346102c25760203660031901126102c2577fd48d879cef83a1c0bdda516f27b13ddb1b3f8bbac1c9e1511bb2a659c2427760602060043561191081610400565b611918611ff9565b600280546001600160a01b0319166001600160a01b03929092169182179055604051908152a1005b346102c25760403660031901126102c257602061199a60043561196281610400565b6024359061196f82610400565b60018060a01b03166000526006835260406000209060018060a01b0316600052602052604060002090565b54604051908152f35b346102c25760203660031901126102c2576004356119c081610400565b6119c8611ff9565b6001600160a01b03168015611a1a57600080546001600160a01b03198116831782556001600160a01b0316907f8be0079c531659141344cd1fd0a4f28419497f9722a3daafe3b4186f6b6457e09080a3005b631e4fbdf760e01b600052600060045260246000fd5b346102c25760603660031901126102c2576020611a4c36610702565b63ffffffff8135611a5c81610b35565b16600052600182528160406000205491013560405191148152f35b60405190610549604083610ed3565b6040519061054960a083610ed3565b60405190611aa282610eb8565b60006020838281520152565b908160209103126102c2575161032081610400565b6040513d6000823e3d90fd5b908160209103126102c2575190565b6001600160401b038111610eb35760051b60200190565b60405190611b04602083610ed3565b600080835282815b828110611b1857505050565b602090604051611b2781610eb8565b6000815260608382015282828501015201611b0c565b3561032081610b35565b6001600160401b038111610eb357601f01601f191660200190565b929192611b6e82611b47565b91611b7c6040519384610ed3565b8294818452818301116102c2578281602093846000960137010152565b90929192836002116102c25783116102c257600201916001190190565b602083610549939594956040519684611bd8899651809287808a0191016102c7565b8501918483013701016000815203601f198101845283610ed3565b908060209392818452848401376000828201840152601f01601f1916010190565b916020610320938181520191611bf3565b610f4c610f589263ffffffff611c5a939795969716600052600360205260406000209061ffff16600052602052604060002090565b805115611cbd578315611cb7576002841015611c8e575050611550604051928392639a6d49cd60e01b845260048401611c14565b909280611cb19161032094611cac611ca7368484611b62565b612499565b611b99565b91611bb6565b92509050565b509190610320913691611b62565b634e487b7160e01b600052603260045260246000fd5b9190811015611d045760051b8101359061013e19813603018212156102c2570190565b611ccb565b903590601e19813603018212156102c257018035906001600160401b0382116102c2576020019181360383136102c257565b3561032081610400565b6001600160401b038116036102c257565b929093611db2926001600160401b0360406103209a98999763ffffffff8135611d7e81610b35565b168852602081013560208901520135611d9681611d45565b166040860152606085015260e0608085015260e0840191611bf3565b6001600160a01b0390941660a082015280840360c090910152611bf3565b6020818303126102c2578051906001600160401b0382116102c2570181601f820112156102c2578051611e0281611b47565b92611e106040519485610ed3565b818452602082840101116102c25761032091602080850191016102c7565b60405190611e3b82610e98565b8160008152600060208201526040611e51611a95565b910152565b611e8590610c5e7f000000000000000000000000000000000000000000000000000000e8d4a510008092612559565b918291808410611e925750565b836371c4efed60e01b60005260045260245260446000fd5b63ffffffff16806000526001602052604060002054908115611eca575090565b63f6ff4fb760e01b60005260045260246000fd5b3561032081611d45565b610320939260809260018060a01b0316825260208201526000604082015281606082015201906102ea565b90916001600160a01b0382169182156117e2576001600160a01b038416938415611fe3576001600160a01b038216600090815260056020526040812090929054848110611fbd5791611faa91611f8f86600080516020612a7e833981519152979695039160018060a01b03166000526005602052604060002090565b556001600160a01b0316600090815260056020526040902090565b80548301905550604051908152602090a3565b63391434e360e21b84526001600160a01b03909116600452602452506044829052606490fd5b63ec442f0560e01b600052600060045260246000fd5b6000546001600160a01b0316330361200d57565b63118cdaa760e01b6000523360045260246000fd5b908160209103126102c2575161032081610bca565b909161204e610320936040845260408401906102ea565b9160208184039101526102ea565b90916120c16120e8936120a46120986020860135927f000000000000000000000000000000000000000000000000000000e8d4a5100090612559565b6001600160401b031690565b6120bb6120b460a0870187611d09565b3691611b62565b916127aa565b9390928394600014612164576002905b6114f36120dd82611b3d565b916080810190611d09565b60045490926001600160a01b0390911690838261210457505050565b60405163043a78eb60e01b8152926020928492839182916121289160048401612037565b03915afa80156106a7576121395750565b61215a9060203d60201161215d575b6121528183610ed3565b810190612022565b50565b503d612148565b6001906120d1565b91908260409103126102c25760405161218481610eb8565b6020808294805184520151910152565b906040828203126102c2576103209161216c565b906020909392936040835263ffffffff815116604084015281810151606084015260806121fc6121e6604084015160a08488015260e08701906102ea565b6060840151868203603f190160a08801526102ea565b910151151560c08401526001600160a01b03909416910152565b8051821015611d045760209160051b010190565b601f821161223757505050565b6000526020600020906020601f840160051c83019310612272575b601f0160051c01905b818110612266575050565b6000815560010161225b565b9091508190612252565b91909182516001600160401b038111610eb3576122a38161229d8454610dc5565b8461222a565b6020601f82116001146122e45781906122d59394956000926122d9575b50508160011b916000199060031b1c19161790565b9055565b0151905038806122c0565b601f198216906122f984600052602060002090565b9160005b8181106123355750958360019596971061231c575b505050811b019055565b015160001960f88460031b161c19169055388080612312565b9192602060018192868b0151815501940192016122fd565b602081016020825282518091526040820191602060408360051b8301019401926000915b83831061238057505050505090565b90919293946020806123c3600193603f19868203018752606060408b5163ffffffff815116845261ffff86820151168685015201519181604082015201906102ea565b97019301930191939290612371565b60005b815181101561246257806123f860406123f060019486612216565b510151612499565b61245c60406124078386612216565b51015163ffffffff6124198487612216565b51511660005260036020526124576040600020612445602061243b878a612216565b51015161ffff1690565b61ffff16600052602052604060002090565b61227c565b016123d5565b506124947fbe4864a8e820971c0247f5992e2da559595f7bf076a21cb5928d443d2a13b674916040519182918261234d565b0390a1565b600361ffff600283015116036124ac5750565b604051639a6d49cd60e01b8152602060048201529081906115509060248301906102ea565b60409060231901126102c257604051906124ea82610eb8565b60243582526044356020830152565b6001600160a01b03169081156104c2576001600160a01b038116156104ac5761254091600052600660205260406000209060018060a01b0316600052602052604060002090565b55565b634e487b7160e01b600052601160045260246000fd5b8115612563570490565b634e487b7160e01b600052601260045260246000fd5b8181029291811591840414171561258c57565b612543565b906020116102c2573590565b906000906028116107ad57506020013560c01c90565b610320906001600160401b037f000000000000000000000000000000000000000000000000000000e8d4a510009116612579565b6001600160a01b03811615612656575b6001600160a01b038116908115611fe3576007549083820180921161258c576007919091556001600160a01b031660009081526005602052604090208281540190556000600080516020612a7e8339815191526020604051858152a390565b5061dead6125f7565b919060009281602811611383579192506103209136916027190190602801611b62565b604c9193610320936040519586936001600160401b0360c01b9060c01b16602085015263ffffffff60e01b9060e01b166028840152602c8301526126cf81518092602086860191016102c7565b81010301601f198101835282610ed3565b6001600160a01b03811691908261272c57509060075482810180911161258c57600092600080516020612a7e833981519152916007555b600780548290039055604051908152602090a3565b6001600160a01b0381166000908152600560205260409020548281106127855791600080516020612a7e8339815191529161277f8260009695039160018060a01b03166000526005602052604060002090565b55612717565b63391434e360e21b6000526001600160a01b0390911660045260245260445260646000fd5b825115801593906127f8576127f59160689160405194859260208401526001600160401b0360c01b9060c01b1660408301523360488301526126cf81518092602086860191016102c7565b91565b50906040519160208301526001600160401b0360c01b9060c01b166040820152602881526127f5604882610ed3565b906080828203126102c25761286190604080519361284485610e98565b80518552602081015161285681611d45565b60208601520161216c565b604082015290565b6128c6608094926128e2969461287d611e2e565b50602061288a865161295a565b95019182518061294b575b5061289f85611eaa565b92511515926128af610ca6611a86565b602086015260408501526060840152151585830152565b6040518095819482936302637a4560e41b8452600484016121a8565b03917f0000000000000000000000001a44076050125825900e736c501f859c50fe728c6001600160a01b03165af19081156106a757600091612922575090565b610320915060803d608011612944575b61293c8183610ed3565b810190612827565b503d612932565b61295490612979565b38612895565b8034036129645790565b6304fb820960e51b6000523460045260246000fd5b60405163393f876560e21b81527f0000000000000000000000001a44076050125825900e736c501f859c50fe728c6001600160a01b031690602081600481855afa9081156106a757600091612a5e575b506001600160a01b0316918215612a4d5760209160009160405190848201926323b872dd60e01b84523360248401526044830152606482015260648152612a11608482610ed3565b519082855af115611ac3576000513d612a445750803b155b612a305750565b635274afe760e01b60005260045260246000fd5b60011415612a29565b6329b99a9560e11b60005260046000fd5b612a77915060203d6020116106d2576106c48183610ed3565b386129c956feddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3efa26469706673582212204d0742c0dea051e9e625aad9175bd0dcd1c6b63bf3847ccf7b5dc7c5c339b17064736f6c634300081b0033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000001a44076050125825900e736c501f859c50fe728c0000000000000000000000004108eaa097bd1e2f05f2571b3075a2473744a5ac0000000000000000000000000000000000000000000000000000000000000008656967656e41544800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000046541544800000000000000000000000000000000000000000000000000000000
-----Decoded View---------------
Arg [0] : _name (string): eigenATH
Arg [1] : _symbol (string): eATH
Arg [2] : _lzEndpoint (address): 0x1a44076050125825900e736c501f859c50fE728c
Arg [3] : _initialOwner (address): 0x4108EAa097bd1e2F05F2571b3075A2473744a5AC
-----Encoded View---------------
8 Constructor Arguments found :
Arg [0] : 0000000000000000000000000000000000000000000000000000000000000080
Arg [1] : 00000000000000000000000000000000000000000000000000000000000000c0
Arg [2] : 0000000000000000000000001a44076050125825900e736c501f859c50fe728c
Arg [3] : 0000000000000000000000004108eaa097bd1e2f05f2571b3075a2473744a5ac
Arg [4] : 0000000000000000000000000000000000000000000000000000000000000008
Arg [5] : 656967656e415448000000000000000000000000000000000000000000000000
Arg [6] : 0000000000000000000000000000000000000000000000000000000000000004
Arg [7] : 6541544800000000000000000000000000000000000000000000000000000000
Deployed Bytecode Sourcemap
469:894:56:-:0;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;:::i;:::-;;;;;;;:::o;:::-;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;-1:-1:-1;;469:894:56;;;;:::o;:::-;;;;;;;;;;;:::i;:::-;;:::o;:::-;;;;;;-1:-1:-1;;469:894:56;;;;;;;1837:5:45;469:894:56;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;:::i;:::-;;;;;1837:5:45;469:894:56;;;;;;;-1:-1:-1;469:894:56;;;;;;;-1:-1:-1;469:894:56;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;;;;;;;;;;;;-1:-1:-1;469:894:56;;-1:-1:-1;469:894:56;;;-1:-1:-1;;;;;469:894:56;;;;;:::o;:::-;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;:::i;:::-;;;735:10:51;9794:19:45;9790:89;;-1:-1:-1;;;;;469:894:56;;;9892:21:45;;9888:90;;9987:27;735:10:51;;;-1:-1:-1;469:894:56;9987:11:45;469:894:56;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;;;9987:27:45;469:894:56;;;;;;735:10:51;;10066:31:45;;469:894:56;;10066:31:45;469:894:56;;;8823:4:45;469:894:56;;;9888:90:45;9936:31;;;-1:-1:-1;9936:31:45;-1:-1:-1;469:894:56;;;-1:-1:-1;9936:31:45;9790:89;9836:32;;;-1:-1:-1;9836:32:45;-1:-1:-1;469:894:56;;;-1:-1:-1;9836:32:45;469:894:56;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;:::i;:::-;;;:::i;:::-;;;;:::i;:::-;-1:-1:-1;469:894:56;;-1:-1:-1;;;5512:12:29;;469:894:56;;;;5512:4:29;:12;;;;;;;469:894:56;5512:12:29;469:894:56;5512:12:29;-1:-1:-1;5512:12:29;;;469:894:56;-1:-1:-1;469:894:56;;-1:-1:-1;;;5505:34:29;;469:894:56;;;;;-1:-1:-1;;;;;469:894:56;5505:34:29;;;;;;;-1:-1:-1;5505:34:29;;;469:894:56;;;;:::i;:::-;;-1:-1:-1;469:894:56;;;5601:34:29;;469:894:56;;18168:668:29;5752:21;;:::i;:::-;6284:19;469:894:56;6284:19:29;;469:894:56;6353:17:29;6317:22;;;469:894:56;6353:17:29;;:::i;:::-;;18168:668;:::i;:::-;469:894:56;;:::i;:::-;;;;;6403:42:29;;469:894:56;;;;;;;;:::i;5505:34:29:-;;;;469:894:56;5505:34:29;469:894:56;5505:34:29;;;;;;;;:::i;:::-;;;;;:::i;:::-;;;;;;;;;;;:::i;5512:12::-;;;;;;;;;;;;;;;:::i;:::-;;;;;:::i;:::-;;;;;;;;;469:894:56;;;;;;-1:-1:-1;;469:894:56;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;;:::o;:::-;-1:-1:-1;;469:894:56;;;;;;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;:::i;:::-;;;;;;;;;;:::i;:::-;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;:::i;:::-;;;:::o;:::-;;;;;;;:::i;:::-;-1:-1:-1;4694:10:16;;;;-1:-1:-1;;4694:10:16;4681:8;-1:-1:-1;;;;;469:894:56;4673:31:16;4669:68;;469:894:56;;;;;:::i;:::-;4837:32:16;;;:::i;:::-;4873:14;;;;469:894:56;4837:50:16;;;4833:103;;13441:17:29;;:36;:17;;;;:::i;:::-;-1:-1:-1;;;;;469:894:56;;;13441:36:29;13662:19;2939:462:28;13656:26:29;13662:19;;;;:::i;:::-;13656:26;:::i;:::-;13684:14;;;:::i;:::-;;2939:462:28;;:::i;:::-;13714:21:29;;;243:2:32;-1:-1:-1;1282:129:32;;13714:21:29;13710:955;;469:894:56;14699:14:29;;;14680:63;14699:14;;:::i;:::-;469:894:56;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;14680:63:29;469:894:56;13710:955:29;13883:13;;13840:175;13883:13;13980:21;13883:13;;;;;:::i;:::-;13914:14;;;;:::i;:::-;13980:21;;:::i;:::-;13840:175;;:::i;:::-;469:894:56;14562:8:29;-1:-1:-1;;;;;469:894:56;14562:92:29;;;;;13883:13;469:894:56;-1:-1:-1;;;14562:92:29;;469:894:56;-1:-1:-1;;469:894:56;;;;-1:-1:-1;;469:894:56;;14562:92:29;;;;;;;;:::i;:::-;;;;;;;;;;14680:63;14562:92;14699:14;14562:92;;;13710:955;;;;;14562:92;;;-1:-1:-1;14562:92:29;;;:::i;:::-;;;:::i;:::-;;;;4833:103:16;469:894:56;;;;;:::i;:::-;4896:40:16;;;-1:-1:-1;4896:40:16;469:894:56;;;;;;-1:-1:-1;4896:40:16;4669:68;4713:24;;;;;4694:10;469:894:56;;;4713:24:16;;469:894:56;;;;;;-1:-1:-1;;469:894:56;;;;;;;2243:1:29;469:894:56;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;-1:-1:-1;;;469:894:56;;3606:1:29;469:894:56;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;843:1:17;469:894:56;;678:1:16;469:894:56;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;2908:12:45;469:894:56;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;2197:1:29;469:894:56;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;:::i;:::-;;;;;;:::i;:::-;-1:-1:-1;;;;;469:894:56;;-1:-1:-1;469:894:56;;;3638:11:45;469:894:56;;;;;;;;735:10:51;469:894:56;;;;;;;;;;;;;-1:-1:-1;;10561:36:45;;10557:309;;469:894:56;4967:5:45;;;;:::i;:::-;469:894:56;;4990:4:45;469:894:56;;;;;10557:309:45;10617:24;;;10613:130;;10835:5;469:894:56;4967:5:45;469:894:56;;735:10:51;10835:5:45;;:::i;:::-;10557:309;;10613:130;10668:60;;;;;-1:-1:-1;10668:60:45;735:10:51;469:894:56;;;;;;;-1:-1:-1;10668:60:45;469:894:56;;;;;;-1:-1:-1;;469:894:56;;;;;;;1352:2;469:894;;;;;;;;;;:::o;:::-;;;;;;-1:-1:-1;;469:894:56;;;;2393:20:15;469:894:56;;;;;:::i;:::-;;;1500:62:40;;;:::i;:::-;469:894:56;;;-1:-1:-1;469:894:56;2359:5:15;469:894:56;;;;-1:-1:-1;469:894:56;;2393:20:15;469:894:56;;2393:20:15;;;;469:894:56;;;;;;;;;;;;;;;;;2393:20:15;;;;469:894:56;;;;;;;;:::o;:::-;;;;;;-1:-1:-1;;469:894:56;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;:::i;:::-;;;;;;:::i;:::-;;;:::i;:::-;-1:-1:-1;469:894:56;;;7297:22:29;;;469:894:56;;16783:59:29;469:894:56;7276:19:29;;469:894:56;;;;:::i;:::-;16784:33:29;16796:21;16784:33;;;:::i;:::-;16783:59;:::i;:::-;18717:31;;;;18713:117;;2259:163:17;469:894:56;7474:49:29;2291:86:17;7474:49:29;;;;;:::i;:::-;469:894:56;;;;:::i;:::-;;;:::i;:::-;;2316:25:17;;;:::i;:::-;2291:86;469:894:56;;:::i;:::-;;;;;;;;2291:86:17;469:894:56;2291:86:17;;469:894:56;2291:86:17;;;469:894:56;7297:22:29;2291:86:17;;469:894:56;;;2291:86:17;;;469:894:56;;2291:86:17;469:894:56;;;;;;;;;2259:163:17;;2403:4;2259:163;469:894:56;2259:163:17;;;:::i;:::-;;469:894:56;2259:8:17;-1:-1:-1;;;;;469:894:56;2259:163:17;;;;;;469:894:56;2259:163:17;-1:-1:-1;2259:163:17;;;469:894:56;;;;;;;;;;;;;;;;;;;;;;;;;;;;2259:163:17;;;;469:894:56;2259:163:17;469:894:56;2259:163:17;;;;;;;;:::i;:::-;;;;;:::i;:::-;;;;;;;;;18713:117:29;18771:48;;;;-1:-1:-1;18771:48:29;469:894:56;;;;;-1:-1:-1;18771:48:29;469:894:56;;;;;;-1:-1:-1;;469:894:56;;;;;;;956:4:24;469:894:56;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;:::o;:::-;-1:-1:-1;469:894:56;;;;;;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;:::o;:::-;;:::i;:::-;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;:::o;:::-;;;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;:::o;:::-;;;;;;-1:-1:-1;;469:894:56;;;;;;;538:93:22;469:894:56;;;;;:::i;:::-;;;;:::i;:::-;;;-1:-1:-1;469:894:56;538:93:22;469:894:56;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;538:93:22;469:894:56;;;;;;;:::i;:::-;;;;:::i;:::-;;;;;;;;;;;;;;:::i;:::-;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;;;:::i;:::-;;;;;;-1:-1:-1;469:894:56;16256:5:29;469:894:56;;;-1:-1:-1;469:894:56;;16256:20:29;16151:132;;469:894:56;;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;446:46:15;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;4783:30:29;469:894:56;;;;;;:::i;:::-;1500:62:40;;:::i;:::-;469:894:56;;;-1:-1:-1;;;;;;469:894:56;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;4783:30:29;469:894:56;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;:::i;:::-;;;;;;;-1:-1:-1;469:894:56;3076:9:45;469:894:56;;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;1500:62:40;;:::i;:::-;469:894:56;;;-1:-1:-1;;;;;;469:894:56;;;;-1:-1:-1;;;;;469:894:56;3052:40:40;469:894:56;;3052:40:40;469:894:56;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;:::i;:::-;;;;-1:-1:-1;469:894:56;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;:::i;:::-;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;:::i;:::-;;;;;;;;;:::i;:::-;;;-1:-1:-1;;;;;469:894:56;;;2217:4:16;2198:24;469:894:56;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;4301:1:29;469:894:56;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;2041:7:45;469:894:56;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;2041:7:45;469:894:56;;;;;;;-1:-1:-1;469:894:56;;;;;;;-1:-1:-1;469:894:56;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;1861:46:29;469:894:56;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;3440:5:45;469:894:56;;;;;:::i;:::-;;;735:10:51;;3440:5:45;:::i;:::-;469:894:56;;;3463:4:45;469:894:56;;;;;;;;;-1:-1:-1;;469:894:56;;;;559:23:24;469:894:56;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;-1:-1:-1;469:894:56;;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;:::i;:::-;1500:62:40;;;:::i;:::-;469:894:56;;;:::i;:::-;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;1503:37:22;;;:::i;:::-;469:894:56;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;:::i;:::-;;;;;;;;:::i;:::-;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;;:::i;:::-;;-1:-1:-1;469:894:56;569:48:15;469:894:56;;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;:::i;:::-;;;:::i;:::-;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;:::i;:::-;;;;;:::i;:::-;;;;:::i;:::-;1811:1:24;1814:19;;;;;;469:894:56;;-1:-1:-1;;;2978:45:24;;1811:1;469:894:56;;;2988:10:24;2978:45;;;;;;2961:63;2978:45;1811:1;2978:45;;;1794:1037;-1:-1:-1;469:894:56;;-1:-1:-1;;;2961:63:24;;469:894:56;;;;2961:63:24;;;:::i;:::-;;;;2978:45;;;;;;1811:1;2978:45;;;;;;:::i;:::-;;;;;:::i;:::-;;;;1835:3;1886:11;;;;;:::i;:::-;1987:20;1979:51;1980:50;1987:20;;;:::i;:::-;2009;;;469:894:56;1980:50:24;469:894:56;;-1:-1:-1;469:894:56;16256:5:29;469:894:56;;;-1:-1:-1;469:894:56;;16256:20:29;16151:132;;1980:50:24;1979:51;;469:894:56;1979:51:24;1975:65;;2633:12;;;469:894:56;2696:11:24;;;;469:894:56;2725:14:24;;;;;;:::i;:::-;2757:15;;;;469:894:56;2757:15:24;;;:::i;:::-;2790:16;;;;;;;:::i;:::-;2602:4;;;;:218;;;;1811:1;469:894:56;2602:218:24;469:894:56;;;;;;;;;;;;;2602:218:24;;469:894:56;2602:218:24;;;:::i;:::-;;:4;;:218;;;;;;;469:894:56;2602:218:24;;;1835:3;;1799:13;469:894:56;1799:13:24;;2602:218;;;1811:1;2602:218;;;:::i;:::-;;;;1975:65;469:894:56;2032:8:24;;;;469:894:56;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;:::i;:::-;;;-1:-1:-1;;469:894:56;;;;;;;;;:::i;:::-;;;:::i;:::-;;;;:::i;:::-;;;;:::i;:::-;;;;:::i;:::-;-1:-1:-1;469:894:56;10042:22:29;;469:894:56;;16783:59:29;469:894:56;10009:19:29;;469:894:56;;;;;:::i;16783:59:29:-;18717:31;;;;18713:117;;9985:10;;8035:21:45;8031:89;;10412:66:29;9985:10;8158:5:45;9985:10:29;;8158:5:45;:::i;:::-;10240:49:29;;;;:::i;:::-;10420:17;;;:::i;:::-;469:894:56;;;;:::i;:::-;10412:66:29;;:::i;:::-;469:894:56;;;:::i;:::-;;;;;10544:42:29;469:894:56;10544:42:29;;469:894:56;10602:87:29;;10627:17;469:894:56;;10627:17:29;;:::i;:::-;469:894:56;;;9985:10:29;;;;;10602:87;;469:894:56;;;;;;;;;;;;;;;;;;;;10602:87:29;;;;469:894:56;;;;;;;;:::i;8031:89:45:-;8079:30;;;-1:-1:-1;8079:30:45;-1:-1:-1;469:894:56;;;-1:-1:-1;8079:30:45;469:894:56;;;;-1:-1:-1;469:894:56;;-1:-1:-1;;469:894:56;;;;;;;;;;:::i;:::-;1500:62:40;;:::i;:::-;3319:8:15;-1:-1:-1;;;;;469:894:56;3319:31:15;;;;;469:894:56;;-1:-1:-1;;;3319:31:15;;-1:-1:-1;;;;;469:894:56;;;;3319:31:15;;469:894:56;;;;;;3319:31:15;;469:894:56;;;;3319:31:15;;;;;;;;;;469:894:56;;3319:31:15;;;;:::i;:::-;;;469:894:56;;3319:31:15;469:894:56;;;;;;;:::i;:::-;3980:4:24;;;;;;3958:10;:27;3954:50;;13441:36:29;:17;;;;:::i;3954:50:24:-;3994:10;;;;;469:894:56;3994:10:24;;469:894:56;;;;;;-1:-1:-1;;469:894:56;;;;1210:22:24;469:894:56;;;;;;:::i;:::-;1500:62:40;;:::i;:::-;1175:20:24;469:894:56;;-1:-1:-1;;;;;;469:894:56;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;1210:22:24;469:894:56;;;;;;;-1:-1:-1;;469:894:56;;;;;3638:27:45;469:894:56;;;;;:::i;:::-;;;;;;;:::i;:::-;;;;;;;-1:-1:-1;469:894:56;3638:11:45;469:894:56;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;;;3638:27:45;469:894:56;;;;;;;;;;;;;-1:-1:-1;;469:894:56;;;;;;;;;:::i;:::-;1500:62:40;;:::i;:::-;-1:-1:-1;;;;;469:894:56;2627:22:40;;2623:91;;-1:-1:-1;469:894:56;;-1:-1:-1;;;;;;469:894:56;;;;;;-1:-1:-1;;;;;469:894:56;;3052:40:40;;-1:-1:-1;3052:40:40;469:894:56;2623:91:40;2672:31;;;-1:-1:-1;2672:31:40;-1:-1:-1;469:894:56;;;-1:-1:-1;2672:31:40;469:894:56;;;;;;-1:-1:-1;;469:894:56;;;;;;;;:::i;:::-;;;;;;;:::i;:::-;;-1:-1:-1;469:894:56;2876:5:16;469:894:56;;;;-1:-1:-1;469:894:56;;2900:13:16;;469:894:56;;;2876:37:16;;469:894:56;;;;;;;;;;;:::i;:::-;;;;;;;;:::i;:::-;;;;;;;:::i;:::-;-1:-1:-1;469:894:56;;;;;;;:::o;:::-;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;:::o;:::-;-1:-1:-1;;;;;469:894:56;;;;;;;;;:::o;:::-;;;;;;;;:::i;:::-;5431:1:29;469:894:56;;;;5431:1:29;469:894:56;;;;;;;;;:::o;:::-;;;;;;;;:::i;:::-;5431:1:29;469:894:56;;;;;;;;;;;;;;;;;;;;;:::i;:::-;-1:-1:-1;;;;;469:894:56;;;;;;-1:-1:-1;;469:894:56;;;;:::o;:::-;;;;;;;:::i;:::-;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;-1:-1:-1;469:894:56;;;;;;:::o;:::-;;;;;;4153:1:22;469:894:56;;;;;;;4153:1:22;469:894:56;;-1:-1:-1;;469:894:56;;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;-1:-1:-1;469:894:56;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;-1:-1:-1;469:894:56;;;;;;;;-1:-1:-1;;469:894:56;;;;:::o;:::-;;;;;;;;;;;:::i;3510:981:22:-;3701:31;469:894:56;3510:981:22;469:894:56;;3510:981:22;;;;;469:894:56;-1:-1:-1;469:894:56;3701:15:22;469:894:56;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;;3861:20:22;3857:46;;3964:25;;3960:46;;4153:1;4129:25;;;4125:267;;469:894:56;;4455:29:22;469:894:56;;4455:29:22;;;;;;;;;;;;:::i;4125:267::-;469:894:56;;;4363:17:22;469:894:56;4340:41:22;469:894:56;4170:34:22;469:894:56;;;;;:::i;:::-;4170:34:22;:::i;:::-;4363:17;:::i;:::-;4340:41;;:::i;3960:46::-;3991:15;-1:-1:-1;3991:15:22;-1:-1:-1;3991:15:22:o;3857:46::-;469:894:56;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;;:::i;:::-;;;;;;;;;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;:::o;:::-;;;;;:::i;:::-;-1:-1:-1;;;;;469:894:56;;;;;:::o;:::-;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;:::i;:::-;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;:::i;:::-;;-1:-1:-1;469:894:56;;-1:-1:-1;469:894:56;;;;;;;:::i;:::-;;;;:::o;18168:668:29:-;16783:59;18168:668;16784:33;16796:21;16784:33;;;:::i;16783:59::-;18635:31;;18717;;;;18713:117;;18168:668;:::o;18713:117::-;18771:48;;;;-1:-1:-1;18771:48:29;;469:894:56;;;;-1:-1:-1;18771:48:29;2718:196:15;469:894:56;;;-1:-1:-1;469:894:56;2822:5:15;469:894:56;;;-1:-1:-1;469:894:56;;2847:18:15;;;2843:43;;2896:11;2718:196;:::o;2843:43::-;2874:12;;;-1:-1:-1;2874:12:15;;469:894:56;;-1:-1:-1;2874:12:15;469:894:56;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;13684:14:29;469:894:56;;;;;;;;;;;;:::i;5374:300:45:-;;;-1:-1:-1;;;;;469:894:56;;;5457:18:45;;5453:86;;-1:-1:-1;;;;;469:894:56;;;5552:16:45;;5548:86;;-1:-1:-1;;;;;469:894:56;;5473:1:45;469:894:56;;;6288:9:45;469:894:56;;;;;5473:1:45;;6288:15;469:894:56;6321:19:45;;;6317:115;;469:894:56;7002:13:45;469:894:56;6552:15:45;469:894:56;-1:-1:-1;;;;;;;;;;;469:894:56;;;;6552:15:45;469:894:56;;;;;;;;6288:9:45;469:894:56;;;;;;;6552:15:45;469:894:56;-1:-1:-1;;;;;469:894:56;;;;;6288:9:45;469:894:56;;;;;;;7002:13:45;469:894:56;;;;;;-1:-1:-1;469:894:56;;;;;;;7064:25:45;5374:300::o;6317:115::-;-1:-1:-1;;;6367:50:45;;-1:-1:-1;;;;;469:894:56;;;6367:50:45;469:894:56;;;-1:-1:-1;469:894:56;;;;;6367:50:45;;5548:86;5591:32;;;5473:1;5591:32;5473:1;5591:32;469:894:56;;5473:1:45;5591:32;1796:162:40;1710:6;469:894:56;-1:-1:-1;;;;;469:894:56;735:10:51;1855:23:40;1851:101;;1796:162::o;1851:101::-;1901:40;;;1710:6;1901:40;735:10:51;1901:40:40;469:894:56;;1710:6:40;1901:40;469:894:56;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;:::i;10990:1436:29:-;;;11347:324;11923:67;10990:1436;17535:41;17542:33;11379:13;;;469:894:56;17554:21:29;;17542:33;;:::i;:::-;-1:-1:-1;;;;;469:894:56;;;17535:41:29;469:894:56;11640:21:29;;;;;;:::i;:::-;469:894:56;;;:::i;:::-;11347:324:29;;:::i;:::-;11323:348;;;;11768:33;;;;;2243:1;11768:33;;11966:23;11938:17;;;:::i;:::-;11966:23;;;;;;:::i;11923:67::-;12248:12;469:894:56;;;-1:-1:-1;;;;;469:894:56;;;;;;12336:83:29;;10990:1436;;;:::o;12336:83::-;469:894:56;;-1:-1:-1;;;12365:54:29;;469:894:56;11379:13:29;;469:894:56;;;;;;12365:54:29;;12248:12;12365:54;;;:::i;:::-;;;;;;;;;;;10990:1436;:::o;12365:54::-;;;11379:13;12365:54;11379:13;12365:54;;;;;;;;:::i;:::-;;;;;:::i;:::-;;10990:1436::o;12365:54::-;;;;;11768:33;2197:1;11768:33;;;469:894:56;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;-1:-1:-1;;469:894:56;;;;;;:::i;:::-;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;:::o;:::-;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;:::o;:::-;-1:-1:-1;469:894:56;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;-1:-1:-1;469:894:56;;;;;;;;;-1:-1:-1;469:894:56;;;;;;;;;;-1:-1:-1;;;;;469:894:56;;;;;;;;;;:::i;:::-;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;10580:17:45;;;469:894:56;;;;;;;;;;;;:::o;:::-;;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;;;10580:17:45;;469:894:56;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;2237:514:22;2357:1;2389:3;469:894:56;;2360:27:22;;;;;2542:19;:27;;:19;469:894:56;2542:19:22;;;:::i;:::-;;:27;;;:::i;:::-;469:894:56;2542:27:22;2656:19;;;;:::i;:::-;;:27;;469:894:56;2600:19:22;;;;:::i;:::-;;469:894:56;;2357:1:22;469:894:56;2584:15:22;469:894:56;;2584:69:22;2542:27;2357:1;469:894:56;2625:27:22;469:894:56;2625:19:22;;;;:::i;:::-;;:27;469:894:56;;;;;2625:27:22;469:894:56;;;;;;;;;;;2584:69:22;469:894:56;:::i;:::-;;2345:13:22;;2360:27;;2709:35;;2360:27;2542;469:894:56;2709:35:22;;;;;:::i;:::-;;;;2237:514::o;4631:264::-;463:1;469:894:56;4743:71:22;;;;469:894:56;4827:28:22;4823:65;;4631:264;:::o;4823:65::-;469:894:56;;-1:-1:-1;;;4864:24:22;;469:894:56;4864:24:22;;;469:894:56;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;:::o;9682:432:45:-;-1:-1:-1;;;;;469:894:56;;9794:19:45;;9790:89;;-1:-1:-1;;;;;469:894:56;;9892:21:45;9888:90;;9987:27;469:894:56;-1:-1:-1;469:894:56;9987:11:45;469:894:56;;;-1:-1:-1;469:894:56;;;;;;;;;;;;;;;;;9987:27:45;469:894:56;9682:432:45:o;469:894:56:-;;;;;;;;;;;;;;;;;;;:::o;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;:::o;:::-;;:::i;1573:123:32:-;;188:2;469:894:56;;;188:2:32;1573:123;:::o;1874:152::-;;-1:-1:-1;1975:42:32;469:894:56;;;;-1:-1:-1;469:894:56;;243:2:32;;;;1874:152::o;17073:139:29:-;17172:33;17073:139;-1:-1:-1;;;;;17184:21:29;469:894:56;;17172:33:29;:::i;2939:462:28:-;-1:-1:-1;;;;;469:894:56;;3113:19:28;3109:46;;2939:462;-1:-1:-1;;;;;469:894:56;;;7509:21:45;;7505:91;;6214:21;469:894:56;6214:21:45;469:894:56;;;;;;;;6214:21:45;469:894:56;;;;-1:-1:-1;;;;;469:894:56;;;;;6288:9:45;469:894:56;;;;;;;;;;;3128:3:28;-1:-1:-1;;;;;;;;;;;469:894:56;;;;;;7064:25:45;2939:462:28;:::o;3109:46::-;3134:21;3148:6;3109:46;;2186:130:32;;;-1:-1:-1;2281:28:32;469:894:56;;;;;;;-1:-1:-1;469:894:56;;;;-1:-1:-1;;469:894:56;;;;;:::i;640:284:31:-;469:894:56;640:284:31;;860:57;640:284;469:894:56;;243:2:32;;;-1:-1:-1;;;;;243:2:32;;469:894:56;;;;860:57:31;;;469:894:56;;;;;;;;;;;;;;;;;;;;;860:57:31;469:894:56;;;;;;:::i;:::-;;;860:57:31;;469:894:56;;860:57:31;;;;;;:::i;5989:1107:45:-;-1:-1:-1;;;;;469:894:56;;;5989:1107:45;6078:18;469:894:56;;;;6214:21:45;469:894:56;;;;;;;;;;;-1:-1:-1;;;;;;;;;;;469:894:56;6214:21:45;469:894:56;6074:540:45;6791:21;469:894:56;;;;;;;;;;;;;;7064:25:45;5989:1107::o;6074:540::-;-1:-1:-1;;;;;469:894:56;;;;;;6288:9:45;469:894:56;;;;;;6321:19:45;;;6317:115;;469:894:56;-1:-1:-1;;;;;;;;;;;469:894:56;6552:15:45;469:894:56;;;;;6552:15:45;469:894:56;;;;;;;;6288:9:45;469:894:56;;;;;;;6552:15:45;469:894:56;6074:540:45;;6317:115;-1:-1:-1;;;469:894:56;6367:50:45;-1:-1:-1;;;;;469:894:56;;;6367:50:45;469:894:56;;;;;;;6367:50:45;598:506:32;469:894:56;;791:22:32;;;;469:894:56;934:163:32;;959:83;469:894:56;;;;;959:83:32;;;;;;469:894:56;-1:-1:-1;;;;;243:2:32;;469:894:56;;;;;;;;1017:10:32;469:894:56;;;;;;;;;959:83:32;469:894:56;;;;;;:::i;959:83:32:-;598:506;:::o;934:163::-;469:894:56;;;;1057:40:32;;;;469:894:56;-1:-1:-1;;;;;243:2:32;;469:894:56;;;;;;;;1057:40:32;;;;;;;:::i;469:894:56:-;;;;;;;;;;;;;;;;;;:::i;:::-;;;;;;;;;;;;:::i;:::-;;;;;;;:::i;:::-;;;;;;:::o;3188:766:17:-;3809:92;;3188:766;;3755:192;3188:766;;469:894:56;;:::i;:::-;;3617:15:17;3577:26;469:894:56;;3577:26:17;:::i;:::-;3617:15;;469:894:56;;;3617:19:17;3613:53;;3188:766;3834:25;;;;:::i;:::-;469:894:56;;3881:19:17;;469:894:56;3809:92:17;469:894:56;;:::i;3809:92:17:-;3617:15;3809:92;;469:894:56;3809:92:17;;;469:894:56;3809:92:17;;;469:894:56;;;3809:92:17;;;469:894:56;;3809:92:17;;469:894:56;;;;;;;;;;3755:192:17;;;;;;:::i;:::-;;;:8;-1:-1:-1;;;;;469:894:56;3755:192:17;;;;;;;-1:-1:-1;3755:192:17;;;3677:270;3188:766;:::o;3755:192::-;;;;3809:92;3755:192;3809:92;3755:192;;;;;;;;:::i;:::-;;;;;:::i;:::-;;;;;3613:53;3650:15;;;:::i;:::-;3613:53;;;4650:191;4749:9;;:23;4745:62;;4650:191;:::o;4745:62::-;4781:26;;;;;4749:9;4781:26;469:894:56;;4781:26:17;;5218:410;469:894:56;;-1:-1:-1;;;5389:18:17;;:8;-1:-1:-1;;;;;469:894:56;;5389:18:17;469:894:56;5389:18:17;469:894:56;;5389:18:17;;;;;;;-1:-1:-1;5389:18:17;;;5218:410;-1:-1:-1;;;;;;469:894:56;;5421:21:17;;5417:54;;5389:18;469:894:56;-1:-1:-1;469:894:56;;;1745:53:49;;;;469:894:56;;;;1745:53:49;;5578:10:17;1745:53:49;;;469:894:56;;;;;;;;;;1745:53:49;;;;;;:::i;:::-;8507:421;;;;;;;;;-1:-1:-1;8507:421:49;;8942:15;;8960:26;;;:31;8942:68;8938:146;;5218:410:17;:::o;8938:146:49:-;9033:40;;;-1:-1:-1;9033:40:49;5389:18:17;469:894:56;1745:53:49;-1:-1:-1;9033:40:49;8942:68;9009:1;8994:16;;8942:68;;5417:54:17;5451:20;;;-1:-1:-1;5451:20:17;5389:18;-1:-1:-1;5451:20:17;5389:18;;;;;;;;;;;;;;:::i;:::-;;;
Swarm Source
ipfs://4d0742c0dea051e9e625aad9175bd0dcd1c6b63bf3847ccf7b5dc7c5c339b170
Loading...
Loading
Loading...
Loading
[ Download: CSV Export ]
[ Download: CSV Export ]
A token is a representation of an on-chain or off-chain asset. The token page shows information such as price, total supply, holders, transfers and social links. Learn more about this page in our Knowledge Base.
Add Token to MetaMask (Web3)