// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)
pragma solidity ^0.8.0;
/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/
abstract contract Context {
function _msgSender() internal view virtual returns (address) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes calldata) {
return msg.data;
}
}
// SPDX-License-Identifier: MIT
pragma solidity >0.5.0 <0.9.0;
/**
* @title ICrossDomainMessenger
*/
interface ICrossDomainMessenger {
/**********
* Events *
**********/
event SentMessage(
address indexed target,
address sender,
bytes message,
uint256 messageNonce,
uint256 gasLimit
);
event RelayedMessage(bytes32 indexed msgHash);
event FailedRelayedMessage(bytes32 indexed msgHash);
/*************
* Variables *
*************/
function xDomainMessageSender() external view returns (address);
/********************
* Public Functions *
********************/
/**
* Sends a cross domain message to the target messenger.
* @param _target Target contract address.
* @param _message Message to send to the target.
* @param _gasLimit Gas limit for the provided message.
*/
function sendMessage(
address _target,
bytes calldata _message,
uint32 _gasLimit
) external;
}
pragma solidity ^0.8.15;
/// @title Optimism - CrossDomainOwnable3 Interface
/// @author Worldcoin
/// @notice Interface for the CrossDomainOwnable contract for the Optimism L2
/// @dev Adds functionality to the StateBridge to transfer ownership
/// of OpWorldID to another contract on L1 or to a local Optimism EOA
/// @custom:usage abi.encodeCall(ICrossDomainOwnable3.transferOwnership, (_owner, _isLocal));
interface ICrossDomainOwnable3 {
/// @notice transfers owner to a cross-domain or local owner
/// @param _owner new owner (EOA or contract)
/// @param _isLocal true if new owner is on Optimism, false if it is a cross-domain owner
function transferOwnership(address _owner, bool _isLocal) external;
}
//SPDX-License-Identifier: MIT
pragma solidity ^0.8.15;
/// @title Interface for the OpWorldID contract
/// @author Worldcoin
/// @custom:usage abi.encodeCall(IOpWorldID.receiveRoot, (_newRoot, _supersedeTimestamp));
interface IOpWorldID {
////////////////////////////////////////////////////////////////////////////////
/// ROOT MIRRORING ///
///////////////////////////////////////////////////////////////////////////////
/// @notice This function is called by the state bridge contract when it forwards a new root to
/// the bridged WorldID.
/// @dev This function can revert if Optimism's CrossDomainMessenger stops processing proofs
/// or if OPLabs stops submitting them. Next iteration of Optimism's cross-domain messaging, will be
/// fully permissionless for message-passing, so this will not be an issue.
/// Sequencer needs to include changes to the CrossDomainMessenger contract on L1, not economically penalized
/// if messages are not included, however the fraud prover (Cannon) can force the sequencer to include it.
///
/// @param newRoot The value of the new root.
///
/// @custom:reverts CannotOverwriteRoot If the root already exists in the root history.
/// @custom:reverts string If the caller is not the owner.
function receiveRoot(uint256 newRoot) external;
}
//SPDX-License-Identifier: MIT
pragma solidity ^0.8.15;
/// @title Interface for WorldID setRooHistoryExpiry
/// @author Worldcoin
/// @notice Interface for WorldID setRooHistoryExpiry
/// @dev Used in StateBridge to set the root history expiry time on Optimism (OPWorldID)
/// @custom:usage abi.encodeCall(IRootHistory.setRootHistoryExpiry, (_expiryTime));
interface IRootHistory {
/// @notice Sets the amount of time it takes for a root in the root history to expire.
///
/// @param expiryTime The new amount of time it takes for a root to expire.
///
/// @custom:reverts string If the caller is not the owner.
function setRootHistoryExpiry(uint256 expiryTime) external;
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.15;
/// @title IWorldIDIdentityManager
/// @author Worldcoin
/// @dev used to fetch the latest root from the WorldIDIdentityManager
interface IWorldIDIdentityManager {
/// @notice returns the latest root
function latestRoot() external view returns (uint256);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.15;
// Optimism interface for cross domain messaging
import {ICrossDomainMessenger} from
"@eth-optimism/contracts/libraries/bridge/ICrossDomainMessenger.sol";
import {IOpWorldID} from "./interfaces/IOpWorldID.sol";
import {IRootHistory} from "./interfaces/IRootHistory.sol";
import {IWorldIDIdentityManager} from "./interfaces/IWorldIDIdentityManager.sol";
import {Ownable2Step} from "openzeppelin-contracts/access/Ownable2Step.sol";
import {ICrossDomainOwnable3} from "./interfaces/ICrossDomainOwnable3.sol";
/// @title World ID State Bridge Optimism
/// @author Worldcoin
/// @notice Distributes new World ID Identity Manager roots to an OP Stack network
/// @dev This contract lives on Ethereum mainnet and works for Optimism and any OP Stack based chain
contract OpStateBridge is Ownable2Step {
///////////////////////////////////////////////////////////////////
/// STORAGE ///
///////////////////////////////////////////////////////////////////
/// @notice The address of the OpWorldID contract on any OP Stack chain
address public immutable opWorldIDAddress;
/// @notice address for OP Stack chain Ethereum mainnet L1CrossDomainMessenger contract
address internal immutable crossDomainMessengerAddress;
/// @notice Ethereum mainnet worldID Address
address public immutable worldIDAddress;
/// @notice Amount of gas purchased on the OP Stack chain for propagateRoot
uint32 internal _gasLimitPropagateRoot;
/// @notice Amount of gas purchased on the OP Stack chain for SetRootHistoryExpiry
uint32 internal _gasLimitSetRootHistoryExpiry;
/// @notice Amount of gas purchased on the OP Stack chain for transferOwnershipOp
uint32 internal _gasLimitTransferOwnership;
/// @notice The default gas limit amount to buy on an OP stack chain to do simple transactions
uint32 public constant DEFAULT_OP_GAS_LIMIT = 1000000;
///////////////////////////////////////////////////////////////////
/// EVENTS ///
///////////////////////////////////////////////////////////////////
/// @notice Emitted when the StateBridge gives ownership of the OPWorldID contract
/// to the WorldID Identity Manager contract away
/// @param previousOwner The previous owner of the OPWorldID contract
/// @param newOwner The new owner of the OPWorldID contract
/// @param isLocal Whether the ownership transfer is local (Optimism/OP Stack chain EOA/contract)
/// or an Ethereum EOA or contract
event OwnershipTransferredOp(
address indexed previousOwner, address indexed newOwner, bool isLocal
);
/// @notice Emitted when the StateBridge sends a root to the OPWorldID contract
/// @param root The root sent to the OPWorldID contract on the OP Stack chain
event RootPropagated(uint256 root);
/// @notice Emitted when the StateBridge sets the root history expiry for OpWorldID and PolygonWorldID
/// @param rootHistoryExpiry The new root history expiry
event SetRootHistoryExpiry(uint256 rootHistoryExpiry);
/// @notice Emitted when the StateBridge sets the gas limit for sendRootOp
/// @param _opGasLimit The new opGasLimit for sendRootOp
event SetGasLimitPropagateRoot(uint32 _opGasLimit);
/// @notice Emitted when the StateBridge sets the gas limit for SetRootHistoryExpiry
/// @param _opGasLimit The new opGasLimit for SetRootHistoryExpiry
event SetGasLimitSetRootHistoryExpiry(uint32 _opGasLimit);
/// @notice Emitted when the StateBridge sets the gas limit for transferOwnershipOp
/// @param _opGasLimit The new opGasLimit for transferOwnershipOptimism
event SetGasLimitTransferOwnershipOp(uint32 _opGasLimit);
///////////////////////////////////////////////////////////////////
/// ERRORS ///
///////////////////////////////////////////////////////////////////
/// @notice Emitted when an attempt is made to renounce ownership.
error CannotRenounceOwnership();
/// @notice Emitted when an attempt is made to set the gas limit to zero
error GasLimitZero();
/// @notice Emitted when an attempt is made to set an address to zero
error AddressZero();
///////////////////////////////////////////////////////////////////
/// CONSTRUCTOR ///
///////////////////////////////////////////////////////////////////
/// @notice constructor
/// @param _worldIDIdentityManager Deployment address of the WorldID Identity Manager contract
/// @param _opWorldIDAddress Address of the Optimism contract that will receive the new root and timestamp
/// @param _crossDomainMessenger L1CrossDomainMessenger contract used to communicate with the desired OP
/// Stack network
/// @custom:revert if any of the constructor params addresses are zero
constructor(
address _worldIDIdentityManager,
address _opWorldIDAddress,
address _crossDomainMessenger
) {
if (
_worldIDIdentityManager == address(0) || _opWorldIDAddress == address(0)
|| _crossDomainMessenger == address(0)
) {
revert AddressZero();
}
opWorldIDAddress = _opWorldIDAddress;
worldIDAddress = _worldIDIdentityManager;
crossDomainMessengerAddress = _crossDomainMessenger;
_gasLimitPropagateRoot = DEFAULT_OP_GAS_LIMIT;
_gasLimitSetRootHistoryExpiry = DEFAULT_OP_GAS_LIMIT;
_gasLimitTransferOwnership = DEFAULT_OP_GAS_LIMIT;
}
///////////////////////////////////////////////////////////////////
/// PUBLIC API ///
///////////////////////////////////////////////////////////////////
/// @notice Sends the latest WorldID Identity Manager root to the IOpStack.
/// @dev Calls this method on the L1 Proxy contract to relay roots to the destination OP Stack chain
function propagateRoot() external {
uint256 latestRoot = IWorldIDIdentityManager(worldIDAddress).latestRoot();
// The `encodeCall` function is strongly typed, so this checks that we are passing the
// correct data to the optimism bridge.
bytes memory message = abi.encodeCall(IOpWorldID.receiveRoot, (latestRoot));
ICrossDomainMessenger(crossDomainMessengerAddress).sendMessage(
// Contract address on the OP Stack Chain
opWorldIDAddress,
message,
_gasLimitPropagateRoot
);
emit RootPropagated(latestRoot);
}
/// @notice Adds functionality to the StateBridge to transfer ownership
/// of OpWorldID to another contract on L1 or to a local OP Stack chain EOA
/// @param _owner new owner (EOA or contract)
/// @param _isLocal true if new owner is on Optimism, false if it is a cross-domain owner
/// @custom:revert if _owner is set to the zero address
function transferOwnershipOp(address _owner, bool _isLocal) external onlyOwner {
if (_owner == address(0)) {
revert AddressZero();
}
// The `encodeCall` function is strongly typed, so this checks that we are passing the
// correct data to the OP Stack chain bridge.
bytes memory message =
abi.encodeCall(ICrossDomainOwnable3.transferOwnership, (_owner, _isLocal));
ICrossDomainMessenger(crossDomainMessengerAddress).sendMessage(
// Contract address on the OP Stack Chain
opWorldIDAddress,
message,
_gasLimitTransferOwnership
);
emit OwnershipTransferredOp(owner(), _owner, _isLocal);
}
/// @notice Adds functionality to the StateBridge to set the root history expiry on OpWorldID
/// @param _rootHistoryExpiry new root history expiry
function setRootHistoryExpiry(uint256 _rootHistoryExpiry) external onlyOwner {
// The `encodeCall` function is strongly typed, so this checks that we are passing the
// correct data to the optimism bridge.
bytes memory message =
abi.encodeCall(IRootHistory.setRootHistoryExpiry, (_rootHistoryExpiry));
ICrossDomainMessenger(crossDomainMessengerAddress).sendMessage(
// Contract address on the OP Stack Chain
opWorldIDAddress,
message,
_gasLimitSetRootHistoryExpiry
);
emit SetRootHistoryExpiry(_rootHistoryExpiry);
}
///////////////////////////////////////////////////////////////////
/// OP GAS LIMIT ///
///////////////////////////////////////////////////////////////////
/// @notice Sets the gas limit for the propagateRoot method
/// @param _opGasLimit The new gas limit for the propagateRoot method
function setGasLimitPropagateRoot(uint32 _opGasLimit) external onlyOwner {
if (_opGasLimit <= 0) {
revert GasLimitZero();
}
_gasLimitPropagateRoot = _opGasLimit;
emit SetGasLimitPropagateRoot(_opGasLimit);
}
/// @notice Sets the gas limit for the SetRootHistoryExpiry method
/// @param _opGasLimit The new gas limit for the SetRootHistoryExpiry method
function setGasLimitSetRootHistoryExpiry(uint32 _opGasLimit) external onlyOwner {
if (_opGasLimit <= 0) {
revert GasLimitZero();
}
_gasLimitSetRootHistoryExpiry = _opGasLimit;
emit SetGasLimitSetRootHistoryExpiry(_opGasLimit);
}
/// @notice Sets the gas limit for the transferOwnershipOp method
/// @param _opGasLimit The new gas limit for the transferOwnershipOp method
function setGasLimitTransferOwnershipOp(uint32 _opGasLimit) external onlyOwner {
if (_opGasLimit <= 0) {
revert GasLimitZero();
}
_gasLimitTransferOwnership = _opGasLimit;
emit SetGasLimitTransferOwnershipOp(_opGasLimit);
}
///////////////////////////////////////////////////////////////////
/// OWNERSHIP ///
///////////////////////////////////////////////////////////////////
/// @notice Ensures that ownership of WorldID implementations cannot be renounced.
/// @dev This function is intentionally not `virtual` as we do not want it to be possible to
/// renounce ownership for any WorldID implementation.
/// @dev This function is marked as `onlyOwner` to maintain the access restriction from the base
/// contract.
function renounceOwnership() public view override onlyOwner {
revert CannotRenounceOwnership();
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)
pragma solidity ^0.8.0;
import "../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/
abstract contract Ownable is Context {
address private _owner;
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/
constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/
modifier onlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/
function owner() public view virtual returns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/
function _checkOwner() internal view virtual {
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/
function renounceOwnership() public virtual onlyOwner {
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual onlyOwner {
require(newOwner != address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual {
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts (last updated v4.8.0) (access/Ownable2Step.sol)
pragma solidity ^0.8.4;
import "./Ownable.sol";
/**
* @dev Contract module which provides 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} and {acceptOwnership}.
*
* This module is used through inheritance. It will make available all functions
* from parent (Ownable).
*/
abstract contract Ownable2Step is Ownable {
address private _pendingOwner;
event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner);
/**
* @dev Returns the address of the pending owner.
*/
function pendingOwner() public view virtual returns (address) {
return _pendingOwner;
}
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
_pendingOwner = newOwner;
emit OwnershipTransferStarted(owner(), newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner.
* Internal function without access restriction.
*/
function _transferOwnership(address newOwner) internal virtual override {
delete _pendingOwner;
super._transferOwnership(newOwner);
}
/**
* @dev The new owner accepts the ownership transfer.
*/
function acceptOwnership() external {
address sender = _msgSender();
require(pendingOwner() == sender, "Ownable2Step: caller is not the new owner");
_transferOwnership(sender);
}
}
{
"compilationTarget": {
"src/OpStateBridge.sol": "OpStateBridge"
},
"evmVersion": "london",
"libraries": {},
"metadata": {
"bytecodeHash": "none"
},
"optimizer": {
"enabled": true,
"runs": 10000
},
"remappings": [
":@eth-optimism/contracts-bedrock/=node_modules/@eth-optimism/contracts-bedrock/",
":@eth-optimism/contracts/=node_modules/@eth-optimism/contracts/",
":@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/",
":@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/",
":@prb/test/=lib/prb-test/src/",
":@rari-capital/solmate/=lib/solmate/",
":ds-test/=lib/forge-std/lib/ds-test/src/",
":forge-std/=lib/forge-std/src/",
":fx-portal/contracts/=lib/contracts/contracts/",
":openzeppelin-contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/",
":openzeppelin-contracts/=lib/openzeppelin-contracts/contracts/",
":prb-test/=lib/prb-test/src/",
":semaphore-v3/=lib/semaphore-v3/",
":semaphore/=lib/semaphore-v3/packages/contracts/contracts/",
":solmate/=lib/solmate/",
":src/=src/"
]
}
[{"inputs":[{"internalType":"address","name":"_worldIDIdentityManager","type":"address"},{"internalType":"address","name":"_opWorldIDAddress","type":"address"},{"internalType":"address","name":"_crossDomainMessenger","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"AddressZero","type":"error"},{"inputs":[],"name":"CannotRenounceOwnership","type":"error"},{"inputs":[],"name":"GasLimitZero","type":"error"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferStarted","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"}],"name":"OwnershipTransferred","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"previousOwner","type":"address"},{"indexed":true,"internalType":"address","name":"newOwner","type":"address"},{"indexed":false,"internalType":"bool","name":"isLocal","type":"bool"}],"name":"OwnershipTransferredOp","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"root","type":"uint256"}],"name":"RootPropagated","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint32","name":"_opGasLimit","type":"uint32"}],"name":"SetGasLimitPropagateRoot","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint32","name":"_opGasLimit","type":"uint32"}],"name":"SetGasLimitSetRootHistoryExpiry","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint32","name":"_opGasLimit","type":"uint32"}],"name":"SetGasLimitTransferOwnershipOp","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"rootHistoryExpiry","type":"uint256"}],"name":"SetRootHistoryExpiry","type":"event"},{"inputs":[],"name":"DEFAULT_OP_GAS_LIMIT","outputs":[{"internalType":"uint32","name":"","type":"uint32"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"acceptOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"opWorldIDAddress","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pendingOwner","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"propagateRoot","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"renounceOwnership","outputs":[],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint32","name":"_opGasLimit","type":"uint32"}],"name":"setGasLimitPropagateRoot","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint32","name":"_opGasLimit","type":"uint32"}],"name":"setGasLimitSetRootHistoryExpiry","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint32","name":"_opGasLimit","type":"uint32"}],"name":"setGasLimitTransferOwnershipOp","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_rootHistoryExpiry","type":"uint256"}],"name":"setRootHistoryExpiry","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"newOwner","type":"address"}],"name":"transferOwnership","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_owner","type":"address"},{"internalType":"bool","name":"_isLocal","type":"bool"}],"name":"transferOwnershipOp","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"worldIDAddress","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}]