Transaction Hash:
Block:
23017084 at Jul-28-2025 10:35:11 AM +UTC
Transaction Fee:
0.000024402012073944 ETH
$0.05
Gas Used:
94,236 Gas / 0.258945754 Gwei
Emitted Events:
| 571 |
TransparentUpgradeableProxy.0x26ba82f907317eedc97d0cbef23de76a43dd6edb563bdb6e9407645b950a7a2d( 0x26ba82f907317eedc97d0cbef23de76a43dd6edb563bdb6e9407645b950a7a2d, 0x0000000000000000000000000000000000000000000000000000000000006fb5, 0x8655dfdd5efc47a5f6bbe98fee5cf852e8d9908a614af0e5f9ac61f40acd020b, 12e791b21bfdfdf9d39f92ceaf807b13980f4dff22ac3bc350585406e8102289, 766187b45c5aa63e7204704aae9341ec3dc8eb2ea49d92b06939705acf344d59 )
|
Account State Difference:
| Address | Before | After | State Difference | ||
|---|---|---|---|---|---|
|
0x4838B106...B0BAD5f97
Miner
| (Titan Builder) | 19.616245374048894352 Eth | 19.616245374190248352 Eth | 0.000000000141354 | |
| 0x6aB0E960...C3E7584A0 |
1.93974479582262308 Eth
Nonce: 20683
|
1.939720393810549136 Eth
Nonce: 20684
| 0.000024402012073944 | ||
| 0x759894Ce...02E3CeF60 | (Morph: Rollup (L1)) |
Execution Trace
TransparentUpgradeableProxy.13361101( )
-
Rollup.finalizeBatch( _batchHeader=0x010000000000006FB50000000000000000000000000000297D421FC8004FB7E8DFDC90C8781BBA4E4566AAB31DB4EBFDFDC6E8E5E686F3274F0115D6525567E1EC01B22ED3148EF9A6185A5A16137958DD7525685175346F582169F04DF5D224D125C3CC5C82D1916D62CF315926D64F8F6A754D3FB936197C12E791B21BFDFDF9D39F92CEAF807B13980F4DFF22AC3BC350585406E8102289766187B45C5AA63E7204704AAE9341EC3DC8EB2EA49D92B06939705ACF344D59AE9394F64E251BF0BF1A1F97170E0B58C261D7F5BCD9AC678C4ED983FAD13E9450D34A58542269B100554DEA5DBB4C83C237AA7638A9A26040D92AAB9EEDE2920000000000CC6D7C )
File 1 of 2: TransparentUpgradeableProxy
File 2 of 2: Rollup
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.5.0) (interfaces/draft-IERC1822.sol)
pragma solidity ^0.8.0;
/**
* @dev ERC1822: Universal Upgradeable Proxy Standard (UUPS) documents a method for upgradeability through a simplified
* proxy whose upgrades are fully controlled by the current implementation.
*/
interface IERC1822Proxiable {
/**
* @dev Returns the storage slot that the proxiable contract assumes is being used to store the implementation
* address.
*
* IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks
* bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this
* function revert if invoked through a proxy.
*/
function proxiableUUID() external view returns (bytes32);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (interfaces/IERC1967.sol)
pragma solidity ^0.8.0;
/**
* @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC.
*
* _Available since v4.8.3._
*/
interface IERC1967 {
/**
* @dev Emitted when the implementation is upgraded.
*/
event Upgraded(address indexed implementation);
/**
* @dev Emitted when the admin account has changed.
*/
event AdminChanged(address previousAdmin, address newAdmin);
/**
* @dev Emitted when the beacon is changed.
*/
event BeaconUpgraded(address indexed beacon);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (proxy/beacon/IBeacon.sol)
pragma solidity ^0.8.0;
/**
* @dev This is the interface that {BeaconProxy} expects of its beacon.
*/
interface IBeacon {
/**
* @dev Must return an address that can be used as a delegate call target.
*
* {BeaconProxy} will check that this address is a contract.
*/
function implementation() external view returns (address);
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (proxy/ERC1967/ERC1967Proxy.sol)
pragma solidity ^0.8.0;
import "../Proxy.sol";
import "./ERC1967Upgrade.sol";
/**
* @dev This contract implements an upgradeable proxy. It is upgradeable because calls are delegated to an
* implementation address that can be changed. This address is stored in storage in the location specified by
* https://eips.ethereum.org/EIPS/eip-1967[EIP1967], so that it doesn't conflict with the storage layout of the
* implementation behind the proxy.
*/
contract ERC1967Proxy is Proxy, ERC1967Upgrade {
/**
* @dev Initializes the upgradeable proxy with an initial implementation specified by `_logic`.
*
* If `_data` is nonempty, it's used as data in a delegate call to `_logic`. This will typically be an encoded
* function call, and allows initializing the storage of the proxy like a Solidity constructor.
*/
constructor(address _logic, bytes memory _data) payable {
_upgradeToAndCall(_logic, _data, false);
}
/**
* @dev Returns the current implementation address.
*/
function _implementation() internal view virtual override returns (address impl) {
return ERC1967Upgrade._getImplementation();
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/ERC1967/ERC1967Upgrade.sol)
pragma solidity ^0.8.2;
import "../beacon/IBeacon.sol";
import "../../interfaces/IERC1967.sol";
import "../../interfaces/draft-IERC1822.sol";
import "../../utils/Address.sol";
import "../../utils/StorageSlot.sol";
/**
* @dev This abstract contract provides getters and event emitting update functions for
* https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.
*
* _Available since v4.1._
*/
abstract contract ERC1967Upgrade is IERC1967 {
// This is the keccak-256 hash of "eip1967.proxy.rollback" subtracted by 1
bytes32 private constant _ROLLBACK_SLOT = 0x4910fdfa16fed3260ed0e7147f7cc6da11a60208b5b9406d12a635614ffd9143;
/**
* @dev Storage slot with the address of the current implementation.
* This is the keccak-256 hash of "eip1967.proxy.implementation" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
/**
* @dev Returns the current implementation address.
*/
function _getImplementation() internal view returns (address) {
return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
}
/**
* @dev Stores a new address in the EIP1967 implementation slot.
*/
function _setImplementation(address newImplementation) private {
require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract");
StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
}
/**
* @dev Perform implementation upgrade
*
* Emits an {Upgraded} event.
*/
function _upgradeTo(address newImplementation) internal {
_setImplementation(newImplementation);
emit Upgraded(newImplementation);
}
/**
* @dev Perform implementation upgrade with additional setup call.
*
* Emits an {Upgraded} event.
*/
function _upgradeToAndCall(address newImplementation, bytes memory data, bool forceCall) internal {
_upgradeTo(newImplementation);
if (data.length > 0 || forceCall) {
Address.functionDelegateCall(newImplementation, data);
}
}
/**
* @dev Perform implementation upgrade with security checks for UUPS proxies, and additional setup call.
*
* Emits an {Upgraded} event.
*/
function _upgradeToAndCallUUPS(address newImplementation, bytes memory data, bool forceCall) internal {
// Upgrades from old implementations will perform a rollback test. This test requires the new
// implementation to upgrade back to the old, non-ERC1822 compliant, implementation. Removing
// this special case will break upgrade paths from old UUPS implementation to new ones.
if (StorageSlot.getBooleanSlot(_ROLLBACK_SLOT).value) {
_setImplementation(newImplementation);
} else {
try IERC1822Proxiable(newImplementation).proxiableUUID() returns (bytes32 slot) {
require(slot == _IMPLEMENTATION_SLOT, "ERC1967Upgrade: unsupported proxiableUUID");
} catch {
revert("ERC1967Upgrade: new implementation is not UUPS");
}
_upgradeToAndCall(newImplementation, data, forceCall);
}
}
/**
* @dev Storage slot with the admin of the contract.
* This is the keccak-256 hash of "eip1967.proxy.admin" subtracted by 1, and is
* validated in the constructor.
*/
bytes32 internal constant _ADMIN_SLOT = 0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
/**
* @dev Returns the current admin.
*/
function _getAdmin() internal view returns (address) {
return StorageSlot.getAddressSlot(_ADMIN_SLOT).value;
}
/**
* @dev Stores a new address in the EIP1967 admin slot.
*/
function _setAdmin(address newAdmin) private {
require(newAdmin != address(0), "ERC1967: new admin is the zero address");
StorageSlot.getAddressSlot(_ADMIN_SLOT).value = newAdmin;
}
/**
* @dev Changes the admin of the proxy.
*
* Emits an {AdminChanged} event.
*/
function _changeAdmin(address newAdmin) internal {
emit AdminChanged(_getAdmin(), newAdmin);
_setAdmin(newAdmin);
}
/**
* @dev The storage slot of the UpgradeableBeacon contract which defines the implementation for this proxy.
* This is bytes32(uint256(keccak256('eip1967.proxy.beacon')) - 1)) and is validated in the constructor.
*/
bytes32 internal constant _BEACON_SLOT = 0xa3f0ad74e5423aebfd80d3ef4346578335a9a72aeaee59ff6cb3582b35133d50;
/**
* @dev Returns the current beacon.
*/
function _getBeacon() internal view returns (address) {
return StorageSlot.getAddressSlot(_BEACON_SLOT).value;
}
/**
* @dev Stores a new beacon in the EIP1967 beacon slot.
*/
function _setBeacon(address newBeacon) private {
require(Address.isContract(newBeacon), "ERC1967: new beacon is not a contract");
require(
Address.isContract(IBeacon(newBeacon).implementation()),
"ERC1967: beacon implementation is not a contract"
);
StorageSlot.getAddressSlot(_BEACON_SLOT).value = newBeacon;
}
/**
* @dev Perform beacon upgrade with additional setup call. Note: This upgrades the address of the beacon, it does
* not upgrade the implementation contained in the beacon (see {UpgradeableBeacon-_setImplementation} for that).
*
* Emits a {BeaconUpgraded} event.
*/
function _upgradeBeaconToAndCall(address newBeacon, bytes memory data, bool forceCall) internal {
_setBeacon(newBeacon);
emit BeaconUpgraded(newBeacon);
if (data.length > 0 || forceCall) {
Address.functionDelegateCall(IBeacon(newBeacon).implementation(), data);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.6.0) (proxy/Proxy.sol)
pragma solidity ^0.8.0;
/**
* @dev This abstract contract provides a fallback function that delegates all calls to another contract using the EVM
* instruction `delegatecall`. We refer to the second contract as the _implementation_ behind the proxy, and it has to
* be specified by overriding the virtual {_implementation} function.
*
* Additionally, delegation to the implementation can be triggered manually through the {_fallback} function, or to a
* different contract through the {_delegate} function.
*
* The success and return data of the delegated call will be returned back to the caller of the proxy.
*/
abstract contract Proxy {
/**
* @dev Delegates the current call to `implementation`.
*
* This function does not return to its internal call site, it will return directly to the external caller.
*/
function _delegate(address implementation) internal virtual {
assembly {
// Copy msg.data. We take full control of memory in this inline assembly
// block because it will not return to Solidity code. We overwrite the
// Solidity scratch pad at memory position 0.
calldatacopy(0, 0, calldatasize())
// Call the implementation.
// out and outsize are 0 because we don't know the size yet.
let result := delegatecall(gas(), implementation, 0, calldatasize(), 0, 0)
// Copy the returned data.
returndatacopy(0, 0, returndatasize())
switch result
// delegatecall returns 0 on error.
case 0 {
revert(0, returndatasize())
}
default {
return(0, returndatasize())
}
}
}
/**
* @dev This is a virtual function that should be overridden so it returns the address to which the fallback function
* and {_fallback} should delegate.
*/
function _implementation() internal view virtual returns (address);
/**
* @dev Delegates the current call to the address returned by `_implementation()`.
*
* This function does not return to its internal call site, it will return directly to the external caller.
*/
function _fallback() internal virtual {
_beforeFallback();
_delegate(_implementation());
}
/**
* @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if no other
* function in the contract matches the call data.
*/
fallback() external payable virtual {
_fallback();
}
/**
* @dev Fallback function that delegates calls to the address returned by `_implementation()`. Will run if call data
* is empty.
*/
receive() external payable virtual {
_fallback();
}
/**
* @dev Hook that is called before falling back to the implementation. Can happen as part of a manual `_fallback`
* call, or as part of the Solidity `fallback` or `receive` functions.
*
* If overridden should call `super._beforeFallback()`.
*/
function _beforeFallback() internal virtual {}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/transparent/TransparentUpgradeableProxy.sol)
pragma solidity ^0.8.0;
import "../ERC1967/ERC1967Proxy.sol";
/**
* @dev Interface for {TransparentUpgradeableProxy}. In order to implement transparency, {TransparentUpgradeableProxy}
* does not implement this interface directly, and some of its functions are implemented by an internal dispatch
* mechanism. The compiler is unaware that these functions are implemented by {TransparentUpgradeableProxy} and will not
* include them in the ABI so this interface must be used to interact with it.
*/
interface ITransparentUpgradeableProxy is IERC1967 {
function admin() external view returns (address);
function implementation() external view returns (address);
function changeAdmin(address) external;
function upgradeTo(address) external;
function upgradeToAndCall(address, bytes memory) external payable;
}
/**
* @dev This contract implements a proxy that is upgradeable by an admin.
*
* To avoid https://medium.com/nomic-labs-blog/malicious-backdoors-in-ethereum-proxies-62629adf3357[proxy selector
* clashing], which can potentially be used in an attack, this contract uses the
* https://blog.openzeppelin.com/the-transparent-proxy-pattern/[transparent proxy pattern]. This pattern implies two
* things that go hand in hand:
*
* 1. If any account other than the admin calls the proxy, the call will be forwarded to the implementation, even if
* that call matches one of the admin functions exposed by the proxy itself.
* 2. If the admin calls the proxy, it can access the admin functions, but its calls will never be forwarded to the
* implementation. If the admin tries to call a function on the implementation it will fail with an error that says
* "admin cannot fallback to proxy target".
*
* These properties mean that the admin account can only be used for admin actions like upgrading the proxy or changing
* the admin, so it's best if it's a dedicated account that is not used for anything else. This will avoid headaches due
* to sudden errors when trying to call a function from the proxy implementation.
*
* Our recommendation is for the dedicated account to be an instance of the {ProxyAdmin} contract. If set up this way,
* you should think of the `ProxyAdmin` instance as the real administrative interface of your proxy.
*
* NOTE: The real interface of this proxy is that defined in `ITransparentUpgradeableProxy`. This contract does not
* inherit from that interface, and instead the admin functions are implicitly implemented using a custom dispatch
* mechanism in `_fallback`. Consequently, the compiler will not produce an ABI for this contract. This is necessary to
* fully implement transparency without decoding reverts caused by selector clashes between the proxy and the
* implementation.
*
* WARNING: It is not recommended to extend this contract to add additional external functions. If you do so, the compiler
* will not check that there are no selector conflicts, due to the note above. A selector clash between any new function
* and the functions declared in {ITransparentUpgradeableProxy} will be resolved in favor of the new one. This could
* render the admin operations inaccessible, which could prevent upgradeability. Transparency may also be compromised.
*/
contract TransparentUpgradeableProxy is ERC1967Proxy {
/**
* @dev Initializes an upgradeable proxy managed by `_admin`, backed by the implementation at `_logic`, and
* optionally initialized with `_data` as explained in {ERC1967Proxy-constructor}.
*/
constructor(address _logic, address admin_, bytes memory _data) payable ERC1967Proxy(_logic, _data) {
_changeAdmin(admin_);
}
/**
* @dev Modifier used internally that will delegate the call to the implementation unless the sender is the admin.
*
* CAUTION: This modifier is deprecated, as it could cause issues if the modified function has arguments, and the
* implementation provides a function with the same selector.
*/
modifier ifAdmin() {
if (msg.sender == _getAdmin()) {
_;
} else {
_fallback();
}
}
/**
* @dev If caller is the admin process the call internally, otherwise transparently fallback to the proxy behavior
*/
function _fallback() internal virtual override {
if (msg.sender == _getAdmin()) {
bytes memory ret;
bytes4 selector = msg.sig;
if (selector == ITransparentUpgradeableProxy.upgradeTo.selector) {
ret = _dispatchUpgradeTo();
} else if (selector == ITransparentUpgradeableProxy.upgradeToAndCall.selector) {
ret = _dispatchUpgradeToAndCall();
} else if (selector == ITransparentUpgradeableProxy.changeAdmin.selector) {
ret = _dispatchChangeAdmin();
} else if (selector == ITransparentUpgradeableProxy.admin.selector) {
ret = _dispatchAdmin();
} else if (selector == ITransparentUpgradeableProxy.implementation.selector) {
ret = _dispatchImplementation();
} else {
revert("TransparentUpgradeableProxy: admin cannot fallback to proxy target");
}
assembly {
return(add(ret, 0x20), mload(ret))
}
} else {
super._fallback();
}
}
/**
* @dev Returns the current admin.
*
* TIP: To get this value clients can read directly from the storage slot shown below (specified by EIP1967) using the
* https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
* `0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103`
*/
function _dispatchAdmin() private returns (bytes memory) {
_requireZeroValue();
address admin = _getAdmin();
return abi.encode(admin);
}
/**
* @dev Returns the current implementation.
*
* TIP: To get this value clients can read directly from the storage slot shown below (specified by EIP1967) using the
* https://eth.wiki/json-rpc/API#eth_getstorageat[`eth_getStorageAt`] RPC call.
* `0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc`
*/
function _dispatchImplementation() private returns (bytes memory) {
_requireZeroValue();
address implementation = _implementation();
return abi.encode(implementation);
}
/**
* @dev Changes the admin of the proxy.
*
* Emits an {AdminChanged} event.
*/
function _dispatchChangeAdmin() private returns (bytes memory) {
_requireZeroValue();
address newAdmin = abi.decode(msg.data[4:], (address));
_changeAdmin(newAdmin);
return "";
}
/**
* @dev Upgrade the implementation of the proxy.
*/
function _dispatchUpgradeTo() private returns (bytes memory) {
_requireZeroValue();
address newImplementation = abi.decode(msg.data[4:], (address));
_upgradeToAndCall(newImplementation, bytes(""), false);
return "";
}
/**
* @dev Upgrade the implementation of the proxy, and then call a function from the new implementation as specified
* by `data`, which should be an encoded function call. This is useful to initialize new storage variables in the
* proxied contract.
*/
function _dispatchUpgradeToAndCall() private returns (bytes memory) {
(address newImplementation, bytes memory data) = abi.decode(msg.data[4:], (address, bytes));
_upgradeToAndCall(newImplementation, data, true);
return "";
}
/**
* @dev Returns the current admin.
*
* CAUTION: This function is deprecated. Use {ERC1967Upgrade-_getAdmin} instead.
*/
function _admin() internal view virtual returns (address) {
return _getAdmin();
}
/**
* @dev To keep this contract fully transparent, all `ifAdmin` functions must be payable. This helper is here to
* emulate some proxy functions being non-payable while still allowing value to pass through.
*/
function _requireZeroValue() private {
require(msg.value == 0);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/StorageSlot.sol)
// This file was procedurally generated from scripts/generate/templates/StorageSlot.js.
pragma solidity ^0.8.0;
/**
* @dev Library for reading and writing primitive types to specific storage slots.
*
* Storage slots are often used to avoid storage conflict when dealing with upgradeable contracts.
* This library helps with reading and writing to such slots without the need for inline assembly.
*
* The functions in this library return Slot structs that contain a `value` member that can be used to read or write.
*
* Example usage to set ERC1967 implementation slot:
* ```solidity
* contract ERC1967 {
* bytes32 internal constant _IMPLEMENTATION_SLOT = 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc;
*
* function _getImplementation() internal view returns (address) {
* return StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value;
* }
*
* function _setImplementation(address newImplementation) internal {
* require(Address.isContract(newImplementation), "ERC1967: new implementation is not a contract");
* StorageSlot.getAddressSlot(_IMPLEMENTATION_SLOT).value = newImplementation;
* }
* }
* ```
*
* _Available since v4.1 for `address`, `bool`, `bytes32`, `uint256`._
* _Available since v4.9 for `string`, `bytes`._
*/
library StorageSlot {
struct AddressSlot {
address value;
}
struct BooleanSlot {
bool value;
}
struct Bytes32Slot {
bytes32 value;
}
struct Uint256Slot {
uint256 value;
}
struct StringSlot {
string value;
}
struct BytesSlot {
bytes value;
}
/**
* @dev Returns an `AddressSlot` with member `value` located at `slot`.
*/
function getAddressSlot(bytes32 slot) internal pure returns (AddressSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BooleanSlot` with member `value` located at `slot`.
*/
function getBooleanSlot(bytes32 slot) internal pure returns (BooleanSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Bytes32Slot` with member `value` located at `slot`.
*/
function getBytes32Slot(bytes32 slot) internal pure returns (Bytes32Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `Uint256Slot` with member `value` located at `slot`.
*/
function getUint256Slot(bytes32 slot) internal pure returns (Uint256Slot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` with member `value` located at `slot`.
*/
function getStringSlot(bytes32 slot) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `StringSlot` representation of the string storage pointer `store`.
*/
function getStringSlot(string storage store) internal pure returns (StringSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
/**
* @dev Returns an `BytesSlot` with member `value` located at `slot`.
*/
function getBytesSlot(bytes32 slot) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := slot
}
}
/**
* @dev Returns an `BytesSlot` representation of the bytes storage pointer `store`.
*/
function getBytesSlot(bytes storage store) internal pure returns (BytesSlot storage r) {
/// @solidity memory-safe-assembly
assembly {
r.slot := store.slot
}
}
}
File 2 of 2: Rollup
// SPDX-License-Identifier: MIT
pragma solidity =0.8.24;
interface IL1MessageQueue {
/**********
* Errors *
**********/
/// @dev Thrown when the given address is `address(0)`.
error ErrZeroAddress();
/**********
* Events *
**********/
/// @notice Emitted when a new L1 => L2 transaction is appended to the queue.
/// @param sender The address of account who initiates the transaction.
/// @param target The address of account who will receive the transaction.
/// @param value The value passed with the transaction.
/// @param queueIndex The index of this transaction in the queue.
/// @param gasLimit Gas limit required to complete the message relay on L2.
/// @param data The calldata of the transaction.
event QueueTransaction(
address indexed sender,
address indexed target,
uint256 value,
uint64 queueIndex,
uint256 gasLimit,
bytes data
);
/// @notice Emitted when some L1 => L2 transactions are included in L1.
/// @param startIndex The start index of messages popped.
/// @param count The number of messages popped.
event DequeueTransaction(uint256 startIndex, uint256 count);
/// @notice Emitted when owner updates gas oracle contract.
/// @param _oldGasOracle The address of old gas oracle contract.
/// @param _newGasOracle The address of new gas oracle contract.
event UpdateGasOracle(address indexed _oldGasOracle, address indexed _newGasOracle);
/// @notice Emitted when owner updates EnforcedTxGateway contract.
/// @param _oldGateway The address of old EnforcedTxGateway contract.
/// @param _newGateway The address of new EnforcedTxGateway contract.
event UpdateEnforcedTxGateway(address indexed _oldGateway, address indexed _newGateway);
/// @notice Emitted when owner updates max gas limit.
/// @param _oldMaxGasLimit The old max gas limit.
/// @param _newMaxGasLimit The new max gas limit.
event UpdateMaxGasLimit(uint256 _oldMaxGasLimit, uint256 _newMaxGasLimit);
/*************************
* Public View Functions *
*************************/
/// @notice The start index of all pending inclusion messages.
function pendingQueueIndex() external view returns (uint256);
/// @notice Return the index of next appended message.
/// @dev Also the total number of appended messages.
function nextCrossDomainMessageIndex() external view returns (uint256);
/// @notice Return the message of in `queueIndex`.
/// @param queueIndex The index to query.
function getCrossDomainMessage(uint256 queueIndex) external view returns (bytes32);
/// @notice Return the amount of ETH should pay for cross domain message.
/// @param sender The address of the message sender.
/// @param gasLimit Gas limit required to complete the message relay on L2.
/// @dev Estimates the fee for a cross-domain message.
function estimateCrossDomainMessageFee(address sender, uint256 gasLimit) external view returns (uint256);
/// @notice Return the amount of intrinsic gas fee should pay for cross domain message.
/// @param _calldata The calldata of L1-initiated transaction.
function calculateIntrinsicGasFee(bytes memory _calldata) external view returns (uint256);
/// @notice Return the hash of a L1 message.
/// @param sender The address of sender.
/// @param queueIndex The queue index of this message.
/// @param value The amount of Ether transfer to target.
/// @param target The address of target.
/// @param gasLimit The gas limit provided.
/// @param data The calldata passed to target address.
function computeTransactionHash(
address sender,
uint256 queueIndex,
uint256 value,
address target,
uint256 gasLimit,
bytes calldata data
) external view returns (bytes32);
/*****************************
* Public Mutating Functions *
*****************************/
/// @notice Append a L1 to L2 message into this contract.
/// @param target The address of target contract to call in L2.
/// @param gasLimit The maximum gas should be used for relay this message in L2.
/// @param data The calldata passed to target contract.
function appendCrossDomainMessage(address target, uint256 gasLimit, bytes calldata data) external;
/// @notice Append an enforced transaction to this contract.
/// @dev The address of sender should be an EOA.
/// @param sender The address of sender who will initiate this transaction in L2.
/// @param target The address of target contract to call in L2.
/// @param value The value passed
/// @param gasLimit The maximum gas should be used for this transaction in L2.
/// @param data The calldata passed to target contract.
function appendEnforcedTransaction(
address sender,
address target,
uint256 value,
uint256 gasLimit,
bytes calldata data
) external;
/// @notice Pop finalized messages from queue.
///
/// @dev We can pop at most 256 messages each time. And if the message is not skipped,
/// the corresponding entry will be cleared.
///
/// @param startIndex The start index to pop.
/// @param count The number of messages to pop.
function popCrossDomainMessage(uint256 startIndex, uint256 count) external;
}
// SPDX-License-Identifier: MIT
pragma solidity =0.8.24;
interface IRollup {
/***********
* Structs *
***********/
/// @param version The version of current batch.
/// @param parentBatchHeader The header of parent batch, see the comments of `BatchHeaderV0Codec`.
/// @param lastBlockNumber The last block number in this batch
/// @param numL1Messages The number of L1 messages in this batch
/// @param prevStateRoot The state root of parent batch.
/// @param postStateRoot The state root of current batch.
/// @param withdrawalRoot The withdraw trie root of current batch.
struct BatchDataInput {
uint8 version;
bytes parentBatchHeader;
uint64 lastBlockNumber;
uint16 numL1Messages;
bytes32 prevStateRoot;
bytes32 postStateRoot;
bytes32 withdrawalRoot;
}
/// @param signedSequencers The bitmap of signed sequencers
/// @param sequencerSets The latest 3 sequencer sets
/// @param signature The BLS signature
struct BatchSignatureInput {
uint256 signedSequencersBitmap;
bytes sequencerSets;
bytes signature;
}
/// @param originTimestamp
/// @param finalizeTimestamp
/// @param blockNumber
struct BatchData {
uint256 originTimestamp;
uint256 finalizeTimestamp;
uint256 blockNumber;
uint256 signedSequencersBitmap;
}
/// @dev Structure to store information about a batch challenge.
/// @param batchIndex The index of the challenged batch.
/// @param challenger The address of the challenger.
/// @param challengeDeposit The amount of deposit put up by the challenger.
/// @param startTime The timestamp when the challenge started.
/// @param challengeSuccess Flag indicating whether the challenge was successful.
/// @param finished Flag indicating whether the challenge has been resolved.
struct BatchChallenge {
uint64 batchIndex;
address challenger;
uint256 challengeDeposit;
uint256 startTime;
bool challengeSuccess;
bool finished;
}
/// @param receiver
/// @param amount
struct BatchChallengeReward {
address receiver;
uint256 amount;
}
/***********
* Errors *
***********/
/// @notice error zero address
error ErrZeroAddress();
/**********
* Events *
**********/
/// @notice Emitted when a new batch is committed.
/// @param batchIndex The index of the batch.
/// @param batchHash The hash of the batch.
event CommitBatch(uint256 indexed batchIndex, bytes32 indexed batchHash);
/// @notice revert a pending batch.
/// @param batchIndex The index of the batch.
/// @param batchHash The hash of the batch
event RevertBatch(uint256 indexed batchIndex, bytes32 indexed batchHash);
/// @notice Emitted when a batch is finalized.
/// @param batchIndex The index of the batch.
/// @param batchHash The hash of the batch
/// @param stateRoot The state root on layer 2 after this batch.
/// @param withdrawRoot The merkle root on layer2 after this batch.
event FinalizeBatch(uint256 indexed batchIndex, bytes32 indexed batchHash, bytes32 stateRoot, bytes32 withdrawRoot);
/// @notice Emitted when owner updates the proofWindow parameter.
/// @param oldWindow The old proofWindow.
/// @param newWindow The new proofWindow.
event UpdateProofWindow(uint256 oldWindow, uint256 newWindow);
/// @notice Emitted when owner updates the finalizationPeriodSeconds parameter.
/// @param oldPeriod The old finalizationPeriodSeconds.
/// @param newPeriod The new finalizationPeriodSeconds.
event UpdateFinalizationPeriodSeconds(uint256 oldPeriod, uint256 newPeriod);
/// @notice Emitted when owner updates the status of challenger.
/// @param account The address of account updated.
/// @param status The status of the account updated.
event UpdateChallenger(address indexed account, bool status);
/// @notice Emitted when the address of rollup verifier is updated.
/// @param oldVerifier The address of old rollup verifier.
/// @param newVerifier The address of new rollup verifier.
event UpdateVerifier(address indexed oldVerifier, address indexed newVerifier);
/// @notice Emitted when the proof reward percent is updated.
/// @param oldPercent The old proofRewardPercent.
/// @param newPercent The new proofRewardPercent.
event UpdateProofRewardPercent(uint256 oldPercent, uint256 newPercent);
/// @notice Emit when prove remaining claimed.
/// @param receiver receiver address.
/// @param amount claimed amount.
event ProveRemainingClaimed(address receiver, uint256 amount);
/// @notice Emitted when the state of Challenge is updated.
/// @param batchIndex The index of the batch.
/// @param challenger The address of challenger.
/// @param challengeDeposit The deposit of challenger.
event ChallengeState(uint64 indexed batchIndex, address indexed challenger, uint256 challengeDeposit);
/// @notice Emitted when the result of Challenge is updated.
/// @param batchIndex The index of the batch.
/// @param winner The address of winner.
/// @param res The result of challenge.
event ChallengeRes(uint256 indexed batchIndex, address indexed winner, string indexed res);
/// @notice Emitted when the challenger claim the challenge reward.
/// @param receiver receiver address
/// @param amount claimed amount
event ChallengeRewardClaim(address indexed receiver, uint256 amount);
/*************************
* Public View Functions *
*************************/
/// @notice The latest finalized batch index.
function lastFinalizedBatchIndex() external view returns (uint256);
/// @notice The latest finalized batch index.
function lastCommittedBatchIndex() external view returns (uint256);
/// @notice Return the batch hash of a committed batch.
/// @param batchIndex The index of the batch.
function committedBatches(uint256 batchIndex) external view returns (bytes32);
/// @notice Return the state root of a committed batch.
/// @param batchIndex The index of the batch.
function finalizedStateRoots(uint256 batchIndex) external view returns (bytes32);
/// @notice Return the the committed batch of withdrawalRoot.
/// @param withdrawalRoot The withdrawal root.
function withdrawalRoots(bytes32 withdrawalRoot) external view returns (bool);
/// @notice Return whether the batch is finalized by batch index.
/// @param batchIndex The index of the batch.
function isBatchFinalized(uint256 batchIndex) external view returns (bool);
/// @notice Return the rollup config of finalizationPeriodSeconds.
function finalizationPeriodSeconds() external view returns (uint256);
/*****************************
* Public Mutating Functions *
*****************************/
/// @notice Commit a batch of transactions on layer 1.
///
/// @param batchDataInput The BatchDataInput struct
/// @param batchSignatureInput The BatchSignatureInput struct
function commitBatch(
BatchDataInput calldata batchDataInput,
BatchSignatureInput calldata batchSignatureInput
) external payable;
/// @notice Revert a pending batch.
/// @dev one can only revert unfinalized batches.
/// @param batchHeader The header of current batch, see the encoding in comments of `commitBatch`.
/// @param count The number of subsequent batches to revert, including current batch.
function revertBatch(bytes calldata batchHeader, uint256 count) external;
/// @notice Claim challenge reward
/// @param receiver The receiver address
function claimReward(address receiver) external;
}
// SPDX-License-Identifier: MIT
pragma solidity =0.8.24;
import {OwnableUpgradeable} from "node_modules/@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
import {PausableUpgradeable} from "node_modules/@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
import {BatchHeaderCodecV0} from "../../libraries/codec/BatchHeaderCodecV0.sol";
import {BatchHeaderCodecV1} from "../../libraries/codec/BatchHeaderCodecV1.sol";
import {IRollupVerifier} from "../../libraries/verifier/IRollupVerifier.sol";
import {IL1MessageQueue} from "./IL1MessageQueue.sol";
import {IRollup} from "./IRollup.sol";
import {IL1Staking} from "../staking/IL1Staking.sol";
// solhint-disable no-inline-assembly
// solhint-disable reason-string
/// @title Rollup
/// @notice This contract maintains data for the Morph rollup.
contract Rollup is IRollup, OwnableUpgradeable, PausableUpgradeable {
/*************
* Constants *
*************/
/// @notice The zero versioned hash.
bytes32 internal constant ZERO_VERSIONED_HASH = 0x010657f37554c781402a22917dee2f75def7ab966d7b770905398eba3c444014;
/// @notice The BLS MODULUS. Deprecated.
uint256 internal constant __BLS_MODULUS =
52435875175126190479447740508185965837690552500527637822603658699938581184513;
/// @dev Address of the point evaluation precompile used for EIP-4844 blob verification.
address internal constant POINT_EVALUATION_PRECOMPILE_ADDR = address(0x0A);
/// @notice The chain id of the corresponding layer 2 chain.
uint64 public immutable LAYER_2_CHAIN_ID;
/*************
* Variables *
*************/
/// @notice L1 staking contract
address public l1StakingContract;
/// @notice Batch challenge time.
uint256 public finalizationPeriodSeconds;
/// @notice The time when zkProof was generated and executed.
uint256 public proofWindow;
/// @notice The maximum number of transactions allowed in each chunk. Deprecated.
uint256 public __maxNumTxInChunk;
/// @notice The address of L1MessageQueue.
address public messageQueue;
/// @notice The address of RollupVerifier.
address public verifier;
/// @inheritdoc IRollup
uint256 public override lastFinalizedBatchIndex;
/// @inheritdoc IRollup
uint256 public override lastCommittedBatchIndex;
/// @notice Whether an account is a challenger.
mapping(address challengerAddress => bool isChallenger) public isChallenger;
/// @inheritdoc IRollup
mapping(uint256 batchIndex => bytes32 stateRoot) public override finalizedStateRoots;
/// @notice Store committed batch hash.
mapping(uint256 batchIndex => bytes32 batchHash) public override committedBatches;
/// @notice Store committed batch base.
mapping(uint256 batchIndex => BatchData) public batchDataStore;
/// @notice Store the withdrawalRoot.
mapping(bytes32 withdrawalRoot => bool exist) public withdrawalRoots;
/// @notice Store Challenge Information.
mapping(uint256 batchIndex => BatchChallenge) public challenges;
/// @notice Store Challenge reward information.
mapping(address owner => uint256 amount) public batchChallengeReward;
/// @notice Whether in challenge
bool public inChallenge;
/// @notice The batch being challenged
uint256 public batchChallenged;
/// @notice The index of the revert request.
uint256 public revertReqIndex;
/// @notice percentage awarded to prover
uint256 public proofRewardPercent;
/// @notice prove remaining
uint256 public proveRemaining;
/// @notice committedStateRoots
mapping(uint256 batchIndex => bytes32 stateRoot) public committedStateRoots;
/**********************
* Function Modifiers *
**********************/
/// @notice Only active staker allowed.
modifier onlyActiveStaker() {
require(IL1Staking(l1StakingContract).isActiveStaker(_msgSender()), "only active staker allowed");
_;
}
/// @notice Only challenger allowed.
modifier onlyChallenger() {
require(isChallenger[_msgSender()], "caller challenger allowed");
_;
}
/// @notice Modifier to ensure that there is no pending revert request.
modifier nonReqRevert() {
require(revertReqIndex == 0, "need revert");
_;
}
/***************
* Constructor *
***************/
/// @notice constructor
/// @param _chainID The chain ID
constructor(uint64 _chainID) {
LAYER_2_CHAIN_ID = _chainID;
_disableInitializers();
}
/// @notice Allow the contract to receive ETH.
receive() external payable {}
/***************
* Initializer *
***************/
/// @notice initializer
/// @param _l1StakingContract l1 staking contract
/// @param _messageQueue message queue
/// @param _verifier verifier
/// @param _finalizationPeriodSeconds finalization period seconds
/// @param _proofWindow proof window
function initialize(
address _l1StakingContract,
address _messageQueue,
address _verifier,
uint256 _finalizationPeriodSeconds,
uint256 _proofWindow,
uint256 _proofRewardPercent
) public initializer {
if (_messageQueue == address(0) || _verifier == address(0)) {
revert ErrZeroAddress();
}
require(_l1StakingContract != address(0), "invalid l1 staking contract");
__Pausable_init();
__Ownable_init();
l1StakingContract = _l1StakingContract;
messageQueue = _messageQueue;
verifier = _verifier;
finalizationPeriodSeconds = _finalizationPeriodSeconds;
proofWindow = _proofWindow;
proofRewardPercent = _proofRewardPercent;
emit UpdateVerifier(address(0), _verifier);
emit UpdateFinalizationPeriodSeconds(0, _finalizationPeriodSeconds);
emit UpdateProofWindow(0, _proofWindow);
emit UpdateProofRewardPercent(0, _proofRewardPercent);
}
function initialize2(bytes32 _prevStateRoot) external reinitializer(2) {
require(_getInitializedVersion() == 2, "must have initialized!");
require(_prevStateRoot != bytes32(0), "can not set state root with bytes32(0)!");
if (committedStateRoots[lastCommittedBatchIndex] == bytes32(0)) {
committedStateRoots[lastCommittedBatchIndex] = _prevStateRoot;
}
}
/************************
* Restricted Functions *
************************/
/// @notice Import layer 2 genesis block
function importGenesisBatch(bytes calldata _batchHeader) external onlyOwner {
// check whether the genesis batch is imported
require(finalizedStateRoots[0] == bytes32(0), "genesis batch imported");
(uint256 memPtr, bytes32 _batchHash) = _loadBatchHeader(_batchHeader);
uint256 _batchIndex = BatchHeaderCodecV0.getBatchIndex(memPtr);
// check batch index is 0
require(_batchIndex == 0, "invalid batch index");
bytes32 _postStateRoot = BatchHeaderCodecV0.getPostStateHash(memPtr);
require(_postStateRoot != bytes32(0), "zero state root");
// check all fields except `dataHash` and `lastBlockHash` are zero
require(BatchHeaderCodecV0.getL1MessagePopped(memPtr) == 0, "l1 message popped should be 0");
require(BatchHeaderCodecV0.getDataHash(memPtr) != bytes32(0), "zero data hash");
require(BatchHeaderCodecV0.getBlobVersionedHash(memPtr) == ZERO_VERSIONED_HASH, "invalid versioned hash");
committedBatches[_batchIndex] = _batchHash;
batchDataStore[_batchIndex] = BatchData(block.timestamp, block.timestamp, 0, 0);
committedStateRoots[_batchIndex] = _postStateRoot;
finalizedStateRoots[_batchIndex] = _postStateRoot;
lastCommittedBatchIndex = _batchIndex;
lastFinalizedBatchIndex = _batchIndex;
emit CommitBatch(_batchIndex, _batchHash);
emit FinalizeBatch(_batchIndex, _batchHash, _postStateRoot, bytes32(0));
}
/// @inheritdoc IRollup
function commitBatch(
BatchDataInput calldata batchDataInput,
BatchSignatureInput calldata batchSignatureInput
) external payable override onlyActiveStaker nonReqRevert whenNotPaused {
require(batchDataInput.version == 0 || batchDataInput.version == 1, "invalid version");
require(batchDataInput.prevStateRoot != bytes32(0), "previous state root is zero");
require(batchDataInput.postStateRoot != bytes32(0), "new state root is zero");
// The overall memory layout in this function is organized as follows
// +---------------------+-------------------+------------------+
// | parent batch header | batch data hashes | new batch header |
// +---------------------+-------------------+------------------+
// ^ ^ ^
// batchPtr dataPtr newBatchPtr (re-use var batchPtr)
//
// 1. We copy the parent batch header from calldata to memory starting at batchPtr
// 2. we store the batch data hash
// 3. The memory starting at `newBatchPtr` is used to store the new batch header and compute
// the batch hash.
// the variable `batchPtr` will be reused later for the current batch
(uint256 _batchPtr, bytes32 _parentBatchHash) = _loadBatchHeader(batchDataInput.parentBatchHeader);
uint256 _batchIndex = BatchHeaderCodecV0.getBatchIndex(_batchPtr);
require(committedBatches[_batchIndex + 1] == bytes32(0), "batch already committed");
require(_batchIndex == lastCommittedBatchIndex, "incorrect batch index");
require(committedBatches[_batchIndex] == _parentBatchHash, "incorrect parent batch hash");
require(committedStateRoots[_batchIndex] == batchDataInput.prevStateRoot, "incorrect previous state root");
uint256 _totalL1MessagesPoppedOverall = BatchHeaderCodecV0.getTotalL1MessagePopped(_batchPtr);
// compute the data hash for batch
bytes32 dataHash = _commitBatch(
batchDataInput.lastBlockNumber,
batchDataInput.numL1Messages,
_totalL1MessagesPoppedOverall
);
unchecked {
_totalL1MessagesPoppedOverall += batchDataInput.numL1Messages;
}
assembly {
_batchIndex := add(_batchIndex, 1) // increase batch index
}
bytes32 _blobVersionedHash = (blobhash(0) == bytes32(0)) ? ZERO_VERSIONED_HASH : blobhash(0);
{
uint256 _headerLength = BatchHeaderCodecV0.BATCH_HEADER_LENGTH;
if (batchDataInput.version == 1) {
_headerLength = BatchHeaderCodecV1.BATCH_HEADER_LENGTH;
}
assembly {
_batchPtr := mload(0x40)
mstore(0x40, add(_batchPtr, _headerLength))
}
// store entries, the order matters
BatchHeaderCodecV0.storeVersion(_batchPtr, batchDataInput.version);
BatchHeaderCodecV0.storeBatchIndex(_batchPtr, _batchIndex);
BatchHeaderCodecV0.storeL1MessagePopped(_batchPtr, batchDataInput.numL1Messages);
BatchHeaderCodecV0.storeTotalL1MessagePopped(_batchPtr, _totalL1MessagesPoppedOverall);
BatchHeaderCodecV0.storeDataHash(_batchPtr, dataHash);
BatchHeaderCodecV0.storeBlobVersionedHash(_batchPtr, _blobVersionedHash);
BatchHeaderCodecV0.storePrevStateHash(_batchPtr, batchDataInput.prevStateRoot);
BatchHeaderCodecV0.storePostStateHash(_batchPtr, batchDataInput.postStateRoot);
BatchHeaderCodecV0.storeWithdrawRootHash(_batchPtr, batchDataInput.withdrawalRoot);
BatchHeaderCodecV0.storeSequencerSetVerifyHash(_batchPtr, keccak256(batchSignatureInput.sequencerSets));
BatchHeaderCodecV0.storeParentBatchHash(_batchPtr, _parentBatchHash);
// store last block number if version >= 1
if (batchDataInput.version >= 1) {
BatchHeaderCodecV1.storeLastBlockNumber(_batchPtr, batchDataInput.lastBlockNumber);
}
committedBatches[_batchIndex] = BatchHeaderCodecV0.computeBatchHash(_batchPtr, _headerLength);
committedStateRoots[_batchIndex] = batchDataInput.postStateRoot;
uint256 proveRemainingTime = 0;
if (inChallenge) {
// Make the batch finalize time longer than the time required for the current challenge
proveRemainingTime = proofWindow + challenges[batchChallenged].startTime - block.timestamp;
}
// storage batch data for challenge status check
batchDataStore[_batchIndex] = BatchData(
block.timestamp,
block.timestamp + finalizationPeriodSeconds + proveRemainingTime,
batchDataInput.lastBlockNumber,
// Before BLS is implemented, the accuracy of the sequencer set uploaded by rollup cannot be guaranteed.
// Therefore, if the batch is successfully challenged, only the submitter will be punished.
IL1Staking(l1StakingContract).getStakerBitmap(_msgSender()) // => batchSignature.signedSequencersBitmap
);
lastCommittedBatchIndex = _batchIndex;
}
// verify bls signature
require(
IL1Staking(l1StakingContract).verifySignature(
batchSignatureInput.signedSequencersBitmap,
_getValidSequencerSet(batchSignatureInput.sequencerSets, 0),
_getBLSMsgHash(batchDataInput),
batchSignatureInput.signature
),
"the signature verification failed"
);
emit CommitBatch(_batchIndex, committedBatches[_batchIndex]);
}
/// @inheritdoc IRollup
/// @dev If the owner wants to revert a sequence of batches by sending multiple transactions,
/// make sure to revert recent batches first.
function revertBatch(bytes calldata _batchHeader, uint256 _count) external onlyOwner {
require(_count > 0, "count must be nonzero");
(uint256 memPtr, bytes32 _batchHash) = _loadBatchHeader(_batchHeader);
// check batch hash
uint256 _batchIndex = BatchHeaderCodecV0.getBatchIndex(memPtr);
require(committedBatches[_batchIndex] == _batchHash, "incorrect batch hash");
// make sure no gap is left when reverting from the ending to the beginning.
require(committedBatches[_batchIndex + _count] == bytes32(0), "reverting must start from the ending");
// check finalization
require(_batchIndex > lastFinalizedBatchIndex, "can only revert unFinalized batch");
lastCommittedBatchIndex = _batchIndex - 1;
while (_count > 0) {
emit RevertBatch(_batchIndex, _batchHash);
committedBatches[_batchIndex] = bytes32(0);
// if challenge exist and not finished yet, return challenge deposit to challenger
if (batchInChallenge(_batchIndex)) {
batchChallengeReward[challenges[_batchIndex].challenger] += challenges[_batchIndex].challengeDeposit;
inChallenge = false;
}
delete challenges[_batchIndex];
if (revertReqIndex > 0 && _batchIndex == revertReqIndex) {
revertReqIndex = 0;
}
unchecked {
_batchIndex += 1;
_count -= 1;
}
_batchHash = committedBatches[_batchIndex];
if (_batchHash == bytes32(0)) {
break;
}
}
}
/// @dev challengeState challenges a batch by submitting a deposit.
function challengeState(
uint64 batchIndex,
bytes32 _batchHash
) external payable onlyChallenger nonReqRevert whenNotPaused {
require(!inChallenge, "already in challenge");
require(lastFinalizedBatchIndex < batchIndex, "batch already finalized");
require(committedBatches[batchIndex] == _batchHash, "incorrect batch hash");
require(batchExist(batchIndex), "batch not exist");
require(challenges[batchIndex].challenger == address(0), "batch already challenged");
// check challenge window
require(batchInsideChallengeWindow(batchIndex), "cannot challenge batch outside the challenge window");
// check challenge amount
require(msg.value >= IL1Staking(l1StakingContract).challengeDeposit(), "insufficient value");
batchChallenged = batchIndex;
challenges[batchIndex] = BatchChallenge(batchIndex, _msgSender(), msg.value, block.timestamp, false, false);
emit ChallengeState(batchIndex, _msgSender(), msg.value);
for (uint256 i = lastFinalizedBatchIndex + 1; i <= lastCommittedBatchIndex; i++) {
if (i != batchIndex) {
batchDataStore[i].finalizeTimestamp += proofWindow;
}
}
inChallenge = true;
}
/// @notice Update proofWindow.
/// @param _newWindow New proof window.
function updateProofWindow(uint256 _newWindow) external onlyOwner {
require(_newWindow > 0 && _newWindow != proofWindow, "invalid new proof window");
uint256 _oldProofWindow = proofWindow;
proofWindow = _newWindow;
emit UpdateProofWindow(_oldProofWindow, proofWindow);
}
/// @notice Update finalizationPeriodSeconds.
/// @param _newPeriod New finalize period seconds.
function updateFinalizePeriodSeconds(uint256 _newPeriod) external onlyOwner {
require(_newPeriod > 0 && _newPeriod != finalizationPeriodSeconds, "invalid new finalize period");
uint256 _oldFinalizationPeriodSeconds = finalizationPeriodSeconds;
finalizationPeriodSeconds = _newPeriod;
emit UpdateFinalizationPeriodSeconds(_oldFinalizationPeriodSeconds, finalizationPeriodSeconds);
}
/// @notice Add an account to the challenger list.
/// @param _account The address of account to add.
function addChallenger(address _account) external onlyOwner {
require(!isChallenger[_account], "account is already a challenger");
isChallenger[_account] = true;
emit UpdateChallenger(_account, true);
}
/// @notice Remove an account from the challenger list.
/// @param _account The address of account to remove.
function removeChallenger(address _account) external onlyOwner {
require(isChallenger[_account], "account is not a challenger");
isChallenger[_account] = false;
emit UpdateChallenger(_account, false);
}
/// @notice Update the address verifier contract.
/// @param _newVerifier The address of new verifier contract.
function updateVerifier(address _newVerifier) external onlyOwner {
require(_newVerifier != address(0) && _newVerifier != verifier, "invalid new verifier");
address _oldVerifier = verifier;
verifier = _newVerifier;
emit UpdateVerifier(_oldVerifier, _newVerifier);
}
/// @notice Update proof reward percentage
/// @param _newProofRewardPercent Percentage awarded to prover
function updateRewardPercentage(uint256 _newProofRewardPercent) external onlyOwner {
require(
_newProofRewardPercent > 0 && _newProofRewardPercent <= 100 && _newProofRewardPercent != proofRewardPercent,
"invalid proof reward percentage"
);
uint256 _oldRewardPercentage = proofRewardPercent;
proofRewardPercent = _newProofRewardPercent;
emit UpdateProofRewardPercent(_oldRewardPercentage, _newProofRewardPercent);
}
/// @notice claim prove remaining
/// @param receiver receiver address
function claimProveRemaining(address receiver) external onlyOwner {
uint256 _proveRemaining = proveRemaining;
proveRemaining = 0;
_transfer(receiver, _proveRemaining);
emit ProveRemainingClaimed(receiver, _proveRemaining);
}
/// @notice Pause the contract
/// @param _status The pause status to update.
function setPause(bool _status) external onlyOwner {
if (_status) {
_pause();
// if challenge exist and not finished yet, return challenge deposit to challenger
if (inChallenge) {
batchChallengeReward[challenges[batchChallenged].challenger] += challenges[batchChallenged]
.challengeDeposit;
delete challenges[batchChallenged];
inChallenge = false;
}
emit Paused(_msgSender());
} else {
_unpause();
emit Unpaused(_msgSender());
}
}
/*****************************
* Public Mutating Functions *
*****************************/
/// @dev proveState proves a batch by submitting a proof.
function proveState(bytes calldata _batchHeader, bytes calldata _batchProof) external nonReqRevert whenNotPaused onlyActiveStaker{
// get batch data from batch header
(uint256 memPtr, bytes32 _batchHash) = _loadBatchHeader(_batchHeader);
// check batch hash
uint256 _batchIndex = BatchHeaderCodecV0.getBatchIndex(memPtr);
require(committedBatches[_batchIndex] == _batchHash, "incorrect batch hash");
// Ensure challenge exists and is not finished
require(batchInChallenge(_batchIndex), "batch in challenge");
// Mark challenge as finished
challenges[_batchIndex].finished = true;
inChallenge = false;
// Check for timeout
if (challenges[_batchIndex].startTime + proofWindow <= block.timestamp) {
// set status
challenges[_batchIndex].challengeSuccess = true;
_challengerWin(_batchIndex, batchDataStore[_batchIndex].signedSequencersBitmap, "Timeout");
} else {
_verifyProof(memPtr, _batchProof);
// Record defender win
_defenderWin(_batchIndex, _msgSender(), "Proof success");
}
}
/// @dev finalize batch
function finalizeBatch(bytes calldata _batchHeader) public nonReqRevert whenNotPaused {
// get batch data from batch header
(uint256 memPtr, bytes32 _batchHash) = _loadBatchHeader(_batchHeader);
uint256 _batchIndex = BatchHeaderCodecV0.getBatchIndex(memPtr);
require(committedBatches[_batchIndex] == _batchHash, "incorrect batch hash");
require(batchExist(_batchIndex), "batch not exist");
require(!batchInChallenge(_batchIndex), "batch in challenge");
require(!batchChallengedSuccess(_batchIndex), "batch should be revert");
require(!batchInsideChallengeWindow(_batchIndex), "batch in challenge window");
// verify previous state root.
require(
finalizedStateRoots[_batchIndex - 1] == BatchHeaderCodecV0.getPrevStateHash(memPtr),
"incorrect previous state root"
);
// avoid duplicated verification
require(finalizedStateRoots[_batchIndex] == bytes32(0), "batch already verified");
// check and update lastFinalizedBatchIndex
unchecked {
require(lastFinalizedBatchIndex + 1 == _batchIndex, "incorrect batch index");
lastFinalizedBatchIndex = _batchIndex;
}
// record state root and withdraw root
withdrawalRoots[BatchHeaderCodecV0.getWithdrawRootHash(memPtr)] = true;
finalizedStateRoots[_batchIndex] = BatchHeaderCodecV0.getPostStateHash(memPtr);
// Pop finalized and non-skipped message from L1MessageQueue.
_popL1Messages(
BatchHeaderCodecV0.getTotalL1MessagePopped(memPtr),
BatchHeaderCodecV0.getL1MessagePopped(memPtr)
);
delete batchDataStore[_batchIndex - 1];
delete committedStateRoots[_batchIndex - 1];
delete challenges[_batchIndex - 1];
emit FinalizeBatch(
_batchIndex,
committedBatches[_batchIndex],
BatchHeaderCodecV0.getPostStateHash(memPtr),
BatchHeaderCodecV0.getWithdrawRootHash(memPtr)
);
}
/// @notice Claim challenge reward
/// @param receiver The receiver address
function claimReward(address receiver) external {
uint256 amount = batchChallengeReward[_msgSender()];
require(amount != 0, "invalid batchChallengeReward");
delete batchChallengeReward[_msgSender()];
_transfer(receiver, amount);
emit ChallengeRewardClaim(receiver, amount);
}
/*************************
* Public View Functions *
*************************/
/// @inheritdoc IRollup
function isBatchFinalized(uint256 _batchIndex) external view override returns (bool) {
return _batchIndex <= lastFinalizedBatchIndex;
}
/// @dev Public function to checks whether the batch is in challenge.
/// @param batchIndex The index of the batch to be checked.
function batchInChallenge(uint256 batchIndex) public view returns (bool) {
return challenges[batchIndex].challenger != address(0) && !challenges[batchIndex].finished;
}
/// @dev Retrieves the success status of a batch challenge.
/// @param batchIndex The index of the batch to check.
function batchChallengedSuccess(uint256 batchIndex) public view returns (bool) {
return challenges[batchIndex].challengeSuccess;
}
/// @dev Public function to checks whether batch exists.
/// @param batchIndex The index of the batch to be checked.
function batchExist(uint256 batchIndex) public view returns (bool) {
return batchDataStore[batchIndex].originTimestamp > 0 && committedBatches[batchIndex] != bytes32(0);
}
/// @dev Public function to checks whether the batch is in challengeWindow.
/// @param batchIndex The index of the batch to be checked.
function batchInsideChallengeWindow(uint256 batchIndex) public view returns (bool) {
return batchDataStore[batchIndex].finalizeTimestamp > block.timestamp;
}
/**********************
* Internal Functions *
**********************/
/// @dev Internal function to pop finalized l1 messages.
/// @param totalL1MessagePopped The total number of L1 messages popped in all batches including current batch.
/// @param l1MessagePopped The number of L1 messages popped in current batch.
function _popL1Messages(uint256 totalL1MessagePopped, uint256 l1MessagePopped) internal {
if (l1MessagePopped == 0) return;
unchecked {
uint256 startIndex = totalL1MessagePopped - l1MessagePopped;
for (uint256 i = 0; i < l1MessagePopped; i += 256) {
uint256 _count = 256;
if (l1MessagePopped - i < _count) {
_count = l1MessagePopped - i;
}
IL1MessageQueue(messageQueue).popCrossDomainMessage(startIndex, _count);
startIndex += 256;
}
}
}
/// @dev Internal function to verify the zk proof.
function _verifyProof(uint256 memPtr, bytes calldata _batchProof) private view {
// Check validity of proof
require(_batchProof.length > 0, "Invalid batch proof");
uint256 _batchIndex = BatchHeaderCodecV0.getBatchIndex(memPtr);
bytes32 _blobVersionedHash = BatchHeaderCodecV0.getBlobVersionedHash(memPtr);
bytes32 _publicInputHash = keccak256(
abi.encodePacked(
LAYER_2_CHAIN_ID,
BatchHeaderCodecV0.getPrevStateHash(memPtr),
BatchHeaderCodecV0.getPostStateHash(memPtr),
BatchHeaderCodecV0.getWithdrawRootHash(memPtr),
BatchHeaderCodecV0.getSequencerSetVerifyHash(memPtr),
BatchHeaderCodecV0.getDataHash(memPtr),
_blobVersionedHash
)
);
IRollupVerifier(verifier).verifyAggregateProof(
BatchHeaderCodecV0.getVersion(memPtr),
_batchIndex,
_batchProof,
_publicInputHash
);
}
/// @dev Internal function to compute BLS msg hash
function _getBLSMsgHash(
BatchDataInput calldata // batchDataInput
) internal pure returns (bytes32) {
// TODO compute bls message hash
return bytes32(0);
}
/// @dev todo
function _getValidSequencerSet(
bytes calldata sequencerSets,
uint256 blockHeight
) internal pure returns (address[] memory) {
// TODO require submitter was in valid sequencer set after BLS was implemented
(
,
address[] memory sequencerSet0,
uint256 blockHeight1,
address[] memory sequencerSet1,
uint256 blockHeight2,
address[] memory sequencerSet2
) = abi.decode(sequencerSets, (uint256, address[], uint256, address[], uint256, address[]));
if (blockHeight >= blockHeight2) {
return sequencerSet2;
}
if (blockHeight >= blockHeight1) {
return sequencerSet1;
}
return sequencerSet0;
}
/// @dev Internal function executed when the defender wins.
/// @param batchIndex The index of the batch indicating where the challenge occurred.
/// @param prover The zkProof prover address.
/// @param _type Description of the challenge type.
function _defenderWin(uint256 batchIndex, address prover, string memory _type) internal {
uint256 challengeDeposit = challenges[batchIndex].challengeDeposit;
uint256 reward = (challengeDeposit * proofRewardPercent) / 100;
proveRemaining += challengeDeposit - reward;
batchChallengeReward[prover] += reward;
emit ChallengeRes(batchIndex, prover, _type);
}
/// @dev Internal function executed when the challenger wins.
/// @param batchIndex The index of the batch indicating where the challenge occurred.
/// @param sequencersBitmap An array containing the sequencers to be slashed.
/// @param _type Description of the challenge type.
function _challengerWin(uint256 batchIndex, uint256 sequencersBitmap, string memory _type) internal {
revertReqIndex = batchIndex;
address challenger = challenges[batchIndex].challenger;
uint256 reward = IL1Staking(l1StakingContract).slash(sequencersBitmap);
batchChallengeReward[challenges[batchIndex].challenger] += (challenges[batchIndex].challengeDeposit + reward);
emit ChallengeRes(batchIndex, challenger, _type);
}
/// @dev Internal function to transfer ETH to a specified address.
/// @param _to The address to transfer ETH to.
/// @param _amount The amount of ETH to transfer.
function _transfer(address _to, uint256 _amount) internal {
if (_amount > 0) {
(bool success, ) = _to.call{value: _amount}("");
require(success, "Rollup: ETH transfer failed");
}
}
/// @notice Extract the version number from a batch header
/// @param batchHeader The encoded batch header bytes
/// @return version The version of the batch header
function _getBatchVersion(bytes calldata batchHeader) internal pure returns (uint8 version) {
require(batchHeader.length > 0, "Empty batch header");
version = uint8(batchHeader[0]); // Safe extraction of the first byte
}
/// @dev Internal function to load batch header from calldata to memory.
/// @param _batchHeader The batch header in calldata.
/// @return _memPtr The start memory offset of loaded batch header.
/// @return _batchHash The hash of the loaded batch header.
function _loadBatchHeader(bytes calldata _batchHeader) internal pure returns (uint256 _memPtr, bytes32 _batchHash) {
uint8 _version = _getBatchVersion(_batchHeader);
// load to memory
uint256 _length;
if (_version == 0) {
(_memPtr, _length) = BatchHeaderCodecV0.loadAndValidate(_batchHeader);
} else if (_version == 1) {
(_memPtr, _length) = BatchHeaderCodecV1.loadAndValidate(_batchHeader);
} else {
revert("Unsupported batch version");
}
// compute batch hash
// all the versions use the same way to compute batch hash
_batchHash = BatchHeaderCodecV0.computeBatchHash(_memPtr, _length);
}
/// @dev Internal function to commit a batch with version 0.
/// @param _lastBlockNumber The last block number in this batch.
/// @param _numL1Messages The number of L1 messages in this batch
/// @param _totalL1MessagesPoppedOverall The total number of L1 messages popped in all batches including current batch.
/// @return _dataHash The computed data hash for this batch.
function _commitBatch(
uint64 _lastBlockNumber,
uint16 _numL1Messages,
uint256 _totalL1MessagesPoppedOverall
) internal view returns (bytes32 _dataHash) {
uint256 startDataPtr;
uint256 dataPtr;
assembly {
dataPtr := mload(0x40)
startDataPtr := dataPtr
}
assembly {
mstore(dataPtr, shl(192, _lastBlockNumber)) // store lastBlockNumber
dataPtr := add(dataPtr, 8)
mstore(dataPtr, shl(240, _numL1Messages)) // store numL1Messages
dataPtr := add(dataPtr, 2)
mstore(0x40, add(dataPtr, mul(_numL1Messages, 0x20))) // reserve memory for l1 message hashes
}
// concatenate l1 message hashes
dataPtr = _loadL1MessageHashes(dataPtr, _numL1Messages, _totalL1MessagesPoppedOverall);
// compute data hash and store to memory
assembly {
_dataHash := keccak256(startDataPtr, sub(dataPtr, startDataPtr))
}
}
/// @dev Internal function to load L1 message hashes from the message queue.
/// @param _ptr The memory offset to store the transaction hash.
/// @param _numL1Messages The number of L1 messages to load.
/// @param _totalL1MessagesPoppedOverall The total number of L1 messages popped in all batches including current batch.
/// @return uint256 The new memory offset after loading.
function _loadL1MessageHashes(
uint256 _ptr,
uint256 _numL1Messages,
uint256 _totalL1MessagesPoppedOverall
) internal view returns (uint256) {
if (_numL1Messages == 0) {
return _ptr;
}
IL1MessageQueue _messageQueue = IL1MessageQueue(messageQueue);
unchecked {
for (uint256 i = 0; i < _numL1Messages; i++) {
bytes32 _hash = _messageQueue.getCrossDomainMessage(_totalL1MessagesPoppedOverall);
assembly {
mstore(_ptr, _hash)
_ptr := add(_ptr, 0x20)
}
_totalL1MessagesPoppedOverall += 1;
}
}
return _ptr;
}
}
// SPDX-License-Identifier: MIT
pragma solidity =0.8.24;
interface IL1Staking {
/**********
* Events *
**********/
/// @notice staker registered
/// @param addr staker address
/// @param tmKey tendermint pubkey
/// @param blsKey BLS pubkey
event Registered(address addr, bytes32 tmKey, bytes blsKey);
/// @notice stakers removed
/// @param stakers stakers removed
event StakersRemoved(address[] stakers);
/// @notice Withdrawn
/// @param addr staker address
/// @param unlockHeight unlock block height
event Withdrawn(address indexed addr, uint256 unlockHeight);
/// @notice staker claimed
/// @param staker staker claimed
/// @param receiver receiver address
event Claimed(address indexed staker, address receiver);
/// @notice stakers were slashed
/// @param stakers slashed stakers
event Slashed(address[] stakers);
/// @notice slash remaining claimed
/// @param receiver receiver address
/// @param amount claimed amount
event SlashRemainingClaimed(address receiver, uint256 amount);
/// @notice whitelist updated
/// @param add addresses added
/// @param remove addresses removed
event WhitelistUpdated(address[] add, address[] remove);
/// @notice staking value updated
/// @param oldStakingValue old staking value
/// @param newStakingValue new staking value
event StakingValueUpdated(uint256 oldStakingValue, uint256 newStakingValue);
/// @notice gas limit add staker updated
/// @param oldGasLimit old gas limit
/// @param newGasLimit new gas limit
event GasLimitAddStakerUpdated(uint256 oldGasLimit, uint256 newGasLimit);
/// @notice gas limit remove stakers updated
/// @param oldGasLimit old gas limit
/// @param newGasLimit new gas limit
event GasLimitRemoveStakersUpdated(uint256 oldGasLimit, uint256 newGasLimit);
/// @notice reward percentage updated
/// @param oldPercentage old percentage
/// @param newPercentage new percentage
event RewardPercentageUpdated(uint256 oldPercentage, uint256 newPercentage);
/// @notice challenge deposit value updated
/// @param oldChallengeDeposit old challengeDeposit
/// @param newChallengeDeposit new challengeDeposit
event ChallengeDepositUpdated(uint256 oldChallengeDeposit, uint256 newChallengeDeposit);
/*************************
* Public View Functions *
*************************/
/// @notice return all stakers
function getStakers() external view returns (address[255] memory);
/// @notice return active stakers
function getActiveStakers() external view returns (address[] memory);
/// @notice return staking value
function stakingValue() external view returns (uint256);
/// @notice return challenge deposit value
function challengeDeposit() external view returns (uint256);
/// @notice whether address is staker
/// @param addr the address to check
function isStaker(address addr) external view returns (bool);
/// @notice whether address is active staker
/// @param addr the address to check
function isActiveStaker(address addr) external view returns (bool);
/// @notice get staker bitmap
/// @param staker the staker address
function getStakerBitmap(address staker) external view returns (uint256);
/// @notice get stakers bitmap
/// @param stakers the staker address array
function getStakersBitmap(address[] calldata stakers) external view returns (uint256);
/// @notice verify BLS signature
/// @param signedSequencersBitmap bitmap of signed sequencers
/// @param sequencerSet sequencer set
/// @param msgHash bls message hash
/// @param signature batch signature
function verifySignature(
uint256 signedSequencersBitmap,
address[] calldata sequencerSet,
bytes32 msgHash,
bytes calldata signature
) external view returns (bool);
/*****************************
* Public Mutating Functions *
*****************************/
/// @notice challenger win, slash sequencers
/// @param sequencersBitmap the sequencers to slash
function slash(uint256 sequencersBitmap) external returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
// solhint-disable no-inline-assembly
/// @dev Below is the encoding for `BatchHeader` V0, total 249
/// ```text
/// * Field Bytes Type Index Comments
/// * version 1 uint8 0 The batch version
/// * batchIndex 8 uint64 1 The index of the batch
/// * l1MessagePopped 8 uint64 9 Number of L1 messages popped in the batch
/// * totalL1MessagePopped 8 uint64 17 Number of total L1 messages popped after the batch
/// * dataHash 32 bytes32 25 The data hash of the batch
/// * blobVersionedHash 32 bytes32 57 The versioned hash of the blob with this batch’s data
/// * prevStateHash 32 bytes32 89 Preview state root
/// * postStateHash 32 bytes32 121 Post state root
/// * withdrawRootHash 32 bytes32 153 L2 withdrawal tree root hash
/// * sequencerSetVerifyHash 32 bytes32 185 L2 sequencers set verify hash
/// * parentBatchHash 32 bytes32 217 The parent batch hash
/// ```
library BatchHeaderCodecV0 {
/// @dev The length of fixed parts of the batch header.
uint256 internal constant BATCH_HEADER_LENGTH = 249;
/// @notice Load batch header in calldata to memory.
/// @param _batchHeader The encoded batch header bytes in calldata.
/// @return batchPtr The start memory offset of the batch header in memory.
/// @return length The length in bytes of the batch header.
function loadAndValidate(bytes calldata _batchHeader) internal pure returns (uint256 batchPtr, uint256 length) {
length = _batchHeader.length;
require(length >= BATCH_HEADER_LENGTH, "batch header length too small");
// copy batch header to memory.
assembly {
batchPtr := mload(0x40)
calldatacopy(batchPtr, _batchHeader.offset, length)
mstore(0x40, add(batchPtr, length))
}
}
/// @notice Get the version of the batch header.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @return _version The version of the batch header.
function getVersion(uint256 batchPtr) internal pure returns (uint256 _version) {
assembly {
_version := shr(248, mload(batchPtr))
}
}
/// @notice Get the batch index of the batch.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @return _batchIndex The batch index of the batch.
function getBatchIndex(uint256 batchPtr) internal pure returns (uint256 _batchIndex) {
assembly {
_batchIndex := shr(192, mload(add(batchPtr, 1)))
}
}
/// @notice Get the number of L1 messages of the batch.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @return _l1MessagePopped The number of L1 messages of the batch.
function getL1MessagePopped(uint256 batchPtr) internal pure returns (uint256 _l1MessagePopped) {
assembly {
_l1MessagePopped := shr(192, mload(add(batchPtr, 9)))
}
}
/// @notice Get the number of L1 messages popped before this batch.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @return _totalL1MessagePopped The the number of L1 messages popped before this batch.
function getTotalL1MessagePopped(uint256 batchPtr) internal pure returns (uint256 _totalL1MessagePopped) {
assembly {
_totalL1MessagePopped := shr(192, mload(add(batchPtr, 17)))
}
}
/// @notice Get the data hash of the batch header.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @return _dataHash The data hash of the batch header.
function getDataHash(uint256 batchPtr) internal pure returns (bytes32 _dataHash) {
assembly {
_dataHash := mload(add(batchPtr, 25))
}
}
/// @notice Get the blob versioned hash of the batch header.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @return _blobVersionedHash The blob versioned hash of the batch header.
function getBlobVersionedHash(uint256 batchPtr) internal pure returns (bytes32 _blobVersionedHash) {
assembly {
_blobVersionedHash := mload(add(batchPtr, 57))
}
}
function getPrevStateHash(uint256 batchPtr) internal pure returns (bytes32 _prevStateHash) {
assembly {
_prevStateHash := mload(add(batchPtr, 89))
}
}
function getPostStateHash(uint256 batchPtr) internal pure returns (bytes32 _postStateHash) {
assembly {
_postStateHash := mload(add(batchPtr, 121))
}
}
function getWithdrawRootHash(uint256 batchPtr) internal pure returns (bytes32 _withdrawRootHash) {
assembly {
_withdrawRootHash := mload(add(batchPtr, 153))
}
}
function getSequencerSetVerifyHash(uint256 batchPtr) internal pure returns (bytes32 _sequencerSetVerifyHash) {
assembly {
_sequencerSetVerifyHash := mload(add(batchPtr, 185))
}
}
/// @notice Get the parent batch hash of the batch header.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @return _parentBatchHash The parent batch hash of the batch header.
function getParentBatchHash(uint256 batchPtr) internal pure returns (bytes32 _parentBatchHash) {
assembly {
_parentBatchHash := mload(add(batchPtr, 217))
}
}
/// @notice Store the version of batch header.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param _version The version of batch header.
function storeVersion(uint256 batchPtr, uint256 _version) internal pure {
assembly {
mstore8(batchPtr, _version)
}
}
/// @notice Store the batch index of batch header.
/// @dev Because this function can overwrite the subsequent fields, it must be called before
/// `storeL1MessagePopped`, `storeTotalL1MessagePopped`, and `storeDataHash`.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param _batchIndex The batch index.
function storeBatchIndex(uint256 batchPtr, uint256 _batchIndex) internal pure {
assembly {
mstore(add(batchPtr, 1), shl(192, _batchIndex))
}
}
/// @notice Store the number of L1 messages popped in current batch to batch header.
/// @dev Because this function can overwrite the subsequent fields, it must be called before
/// `storeTotalL1MessagePopped` and `storeDataHash`.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param _l1MessagePopped The number of L1 messages popped in current batch.
function storeL1MessagePopped(uint256 batchPtr, uint256 _l1MessagePopped) internal pure {
assembly {
mstore(add(batchPtr, 9), shl(192, _l1MessagePopped))
}
}
/// @notice Store the total number of L1 messages popped after current batch to batch header.
/// @dev Because this function can overwrite the subsequent fields, it must be called before
/// `storeDataHash`.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param _totalL1MessagePopped The total number of L1 messages popped after current batch.
function storeTotalL1MessagePopped(uint256 batchPtr, uint256 _totalL1MessagePopped) internal pure {
assembly {
mstore(add(batchPtr, 17), shl(192, _totalL1MessagePopped))
}
}
/// @notice Store the data hash of batch header.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param _dataHash The data hash.
function storeDataHash(uint256 batchPtr, bytes32 _dataHash) internal pure {
assembly {
mstore(add(batchPtr, 25), _dataHash)
}
}
/// @notice Store the parent batch hash of batch header.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param _blobVersionedHash The versioned hash of the blob with this batch’s data.
function storeBlobVersionedHash(uint256 batchPtr, bytes32 _blobVersionedHash) internal pure {
assembly {
mstore(add(batchPtr, 57), _blobVersionedHash)
}
}
/// @dev Stores the previous state hash.
/// @param batchPtr The memory pointer to the location where the previous state hash will be stored.
/// @param _prevStateHash The hash of the previous state to be stored.
function storePrevStateHash(uint256 batchPtr, bytes32 _prevStateHash) internal pure {
assembly {
mstore(add(batchPtr, 89), _prevStateHash)
}
}
/// @dev Stores the post-state hash.
/// @param batchPtr The memory pointer to the location where the post-state hash will be stored.
/// @param _postStateHash The hash of the post-state to be stored.
function storePostStateHash(uint256 batchPtr, bytes32 _postStateHash) internal pure {
assembly {
mstore(add(batchPtr, 121), _postStateHash)
}
}
/// @dev Stores the withdrawal root hash.
/// @param batchPtr The memory pointer to the location where the hash will be stored.
/// @param _withdrawRootHash The hash of the withdrawal root to be stored.
function storeWithdrawRootHash(uint256 batchPtr, bytes32 _withdrawRootHash) internal pure {
assembly {
mstore(add(batchPtr, 153), _withdrawRootHash)
}
}
/// @dev Stores the hash for verifying the sequencer set.
/// @param batchPtr The memory pointer to the batch data.
/// @param _sequencerSetVerifyHash The hash of the sequencer set to be stored.
function storeSequencerSetVerifyHash(uint256 batchPtr, bytes32 _sequencerSetVerifyHash) internal pure {
assembly {
mstore(add(batchPtr, 185), _sequencerSetVerifyHash)
}
}
/// @notice Store the parent batch hash of batch header.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param _parentBatchHash The parent batch hash.
function storeParentBatchHash(uint256 batchPtr, bytes32 _parentBatchHash) internal pure {
assembly {
mstore(add(batchPtr, 217), _parentBatchHash)
}
}
/// @notice Compute the batch hash.
/// @dev Caller should make sure that the encoded batch header is correct.
///
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param length The length of the batch.
/// @return _batchHash The hash of the corresponding batch.
function computeBatchHash(uint256 batchPtr, uint256 length) internal pure returns (bytes32 _batchHash) {
// in the current version, the hash is: keccak(BatchHeader without timestamp)
assembly {
_batchHash := keccak256(batchPtr, length)
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
// solhint-disable no-inline-assembly
/// @dev Below is the encoding for `BatchHeader` V1, total 257
/// * Field Bytes Type Index Comments
/// * version 1 uint8 0 The batch version
/// * batchIndex 8 uint64 1 The index of the batch
/// * l1MessagePopped 8 uint64 9 Number of L1 messages popped in the batch
/// * totalL1MessagePopped 8 uint64 17 Number of total L1 messages popped after the batch
/// * dataHash 32 bytes32 25 The data hash of the batch
/// * blobVersionedHash 32 bytes32 57 The versioned hash of the blob with this batch’s data
/// * prevStateHash 32 bytes32 89 Preview state root
/// * postStateHash 32 bytes32 121 Post state root
/// * withdrawRootHash 32 bytes32 153 L2 withdrawal tree root hash
/// * sequencerSetVerifyHash 32 bytes32 185 L2 sequencers set verify hash
/// * parentBatchHash 32 bytes32 217 The parent batch hash
///
/// @dev Below is the feilds for `BatchHeader` V1
/// * lastBlockNumber 8 uint64 249 The last block number in this batch
/// ```
library BatchHeaderCodecV1 {
/// @dev The length of fixed parts of the batch header.
uint256 internal constant BATCH_HEADER_LENGTH = 257;
/// @notice Load batch header in calldata to memory.
/// @param _batchHeader The encoded batch header bytes in calldata.
/// @return batchPtr The start memory offset of the batch header in memory.
/// @return length The length in bytes of the batch header.
function loadAndValidate(bytes calldata _batchHeader) internal pure returns (uint256 batchPtr, uint256 length) {
length = _batchHeader.length;
require(length == BATCH_HEADER_LENGTH, "batch header length is incorrect");
// copy batch header to memory.
assembly {
batchPtr := mload(0x40)
calldatacopy(batchPtr, _batchHeader.offset, length)
mstore(0x40, add(batchPtr, length))
}
}
/// @notice Get the last block number of the batch.
function getLastBlockNumber(uint256 batchPtr) internal pure returns (uint256 _lastBlockNumber) {
assembly {
_lastBlockNumber := shr(192, mload(add(batchPtr, 249)))
}
}
/// @notice Store the last block number of the batch.
/// @param batchPtr The start memory offset of the batch header in memory.
/// @param _lastBlockNumber The last block number to store.
function storeLastBlockNumber(uint256 batchPtr, uint256 _lastBlockNumber) internal pure {
assembly {
mstore(add(batchPtr, 249), shl(192, _lastBlockNumber))
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity =0.8.24;
interface IRollupVerifier {
/// @notice Verify aggregate zk proof.
/// @param _version The version of the verifier.
/// @param _batchIndex The batch index to verify.
/// @param _aggrProof The aggregated proof.
/// @param _publicInputHash The public input hash.
function verifyAggregateProof(
uint256 _version,
uint256 _batchIndex,
bytes calldata _aggrProof,
bytes32 _publicInputHash
) external view;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (access/Ownable.sol)
pragma solidity ^0.8.0;
import "../utils/ContextUpgradeable.sol";
import {Initializable} from "../proxy/utils/Initializable.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract OwnableUpgradeable is Initializable, ContextUpgradeable {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
function __Ownable_init() internal onlyInitializing {
__Ownable_init_unchained();
}
function __Ownable_init_unchained() internal onlyInitializing {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions. 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 {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (proxy/utils/Initializable.sol)
pragma solidity ^0.8.2;
import "../../utils/AddressUpgradeable.sol";
/**
* @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed
* behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an
* external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer
* function so it can only be called once. The {initializer} modifier provided by this contract will have this effect.
*
* The initialization functions use a version number. Once a version number is used, it is consumed and cannot be
* reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in
* case an upgrade adds a module that needs to be initialized.
*
* For example:
*
* [.hljs-theme-light.nopadding]
* ```solidity
* contract MyToken is ERC20Upgradeable {
* function initialize() initializer public {
* __ERC20_init("MyToken", "MTK");
* }
* }
*
* contract MyTokenV2 is MyToken, ERC20PermitUpgradeable {
* function initializeV2() reinitializer(2) public {
* __ERC20Permit_init("MyToken");
* }
* }
* ```
*
* TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as
* possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}.
*
* CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure
* that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.
*
* [CAUTION]
* ====
* Avoid leaving a contract uninitialized.
*
* An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation
* contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke
* the {_disableInitializers} function in the constructor to automatically lock it when it is deployed:
*
* [.hljs-theme-light.nopadding]
* ```
* /// @custom:oz-upgrades-unsafe-allow constructor
* constructor() {
* _disableInitializers();
* }
* ```
* ====
*/
abstract contract Initializable {
/**
* @dev Indicates that the contract has been initialized.
* @custom:oz-retyped-from bool
*/
uint8 private _initialized;
/**
* @dev Indicates that the contract is in the process of being initialized.
*/
bool private _initializing;
/**
* @dev Triggered when the contract has been initialized or reinitialized.
*/
event Initialized(uint8 version);
/**
* @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
* `onlyInitializing` functions can be used to initialize parent contracts.
*
* Similar to `reinitializer(1)`, except that functions marked with `initializer` can be nested in the context of a
* constructor.
*
* Emits an {Initialized} event.
*/
modifier initializer() {
bool isTopLevelCall = !_initializing;
require(
(isTopLevelCall && _initialized < 1) || (!AddressUpgradeable.isContract(address(this)) && _initialized == 1),
"Initializable: contract is already initialized"
);
_initialized = 1;
if (isTopLevelCall) {
_initializing = true;
}
_;
if (isTopLevelCall) {
_initializing = false;
emit Initialized(1);
}
}
/**
* @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the
* contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be
* used to initialize parent contracts.
*
* A reinitializer may be used after the original initialization step. This is essential to configure modules that
* are added through upgrades and that require initialization.
*
* When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer`
* cannot be nested. If one is invoked in the context of another, execution will revert.
*
* Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in
* a contract, executing them in the right order is up to the developer or operator.
*
* WARNING: setting the version to 255 will prevent any future reinitialization.
*
* Emits an {Initialized} event.
*/
modifier reinitializer(uint8 version) {
require(!_initializing && _initialized < version, "Initializable: contract is already initialized");
_initialized = version;
_initializing = true;
_;
_initializing = false;
emit Initialized(version);
}
/**
* @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
* {initializer} and {reinitializer} modifiers, directly or indirectly.
*/
modifier onlyInitializing() {
require(_initializing, "Initializable: contract is not initializing");
_;
}
/**
* @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
* Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
* to any version. It is recommended to use this to lock implementation contracts that are designed to be called
* through proxies.
*
* Emits an {Initialized} event the first time it is successfully executed.
*/
function _disableInitializers() internal virtual {
require(!_initializing, "Initializable: contract is initializing");
if (_initialized != type(uint8).max) {
_initialized = type(uint8).max;
emit Initialized(type(uint8).max);
}
}
/**
* @dev Returns the highest version that has been initialized. See {reinitializer}.
*/
function _getInitializedVersion() internal view returns (uint8) {
return _initialized;
}
/**
* @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
*/
function _isInitializing() internal view returns (bool) {
return _initializing;
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (security/Pausable.sol)
pragma solidity ^0.8.0;
import "../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 {
/**
* @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);
bool private _paused;
/**
* @dev Initializes the contract in unpaused state.
*/
function __Pausable_init() internal onlyInitializing {
__Pausable_init_unchained();
}
function __Pausable_init_unchained() internal onlyInitializing {
_paused = false;
}
/**
* @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();
_;
}
/**
* @dev Returns true if the contract is paused, and false otherwise.
*/
function paused() public view virtual returns (bool) {
return _paused;
}
/**
* @dev Throws if the contract is paused.
*/
function _requireNotPaused() internal view virtual {
require(!paused(), "Pausable: paused");
}
/**
* @dev Throws if the contract is not paused.
*/
function _requirePaused() internal view virtual {
require(paused(), "Pausable: not paused");
}
/**
* @dev Triggers stopped state.
*
* Requirements:
*
* - The contract must not be paused.
*/
function _pause() internal virtual whenNotPaused {
_paused = true;
emit Paused(_msgSender());
}
/**
* @dev Returns to normal state.
*
* Requirements:
*
* - The contract must be paused.
*/
function _unpause() internal virtual whenPaused {
_paused = false;
emit Unpaused(_msgSender());
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[49] private __gap;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library AddressUpgradeable {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
*
* Furthermore, `isContract` will also return true if the target contract within
* the same transaction is already scheduled for destruction by `SELFDESTRUCT`,
* which only has an effect at the end of a transaction.
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://consensys.net/diligence/blog/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.8.0/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/
function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/
function functionCallWithValue(
address target,
bytes memory data,
uint256 value,
string memory errorMessage
) internal returns (bytes memory) {
require(address(this).balance >= value, "Address: insufficient balance for call");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/
function functionStaticCall(
address target,
bytes memory data,
string memory errorMessage
) internal view returns (bytes memory) {
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/
function functionDelegateCall(
address target,
bytes memory data,
string memory errorMessage
) internal returns (bytes memory) {
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/
function verifyCallResultFromTarget(
address target,
bool success,
bytes memory returndata,
string memory errorMessage
) internal view returns (bytes memory) {
if (success) {
if (returndata.length == 0) {
// only check isContract if the call was successful and the return data is empty
// otherwise we already know that it was a contract
require(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/
function verifyCallResult(
bool success,
bytes memory returndata,
string memory errorMessage
) internal pure returns (bytes memory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function _revert(bytes memory returndata, string memory errorMessage) private pure {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
/// @solidity memory-safe-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.9.4) (utils/Context.sol)
pragma solidity ^0.8.0;
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;
}
/**
* @dev This empty reserved space is put in place to allow future versions to add new
* variables without shifting down storage in the inheritance chain.
* See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps
*/
uint256[50] private __gap;
}