Contract Name:
HookUpgradeableBeacon
Contract Source Code:
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts v4.4.1 (access/IAccessControl.sol)
pragma solidity ^0.8.0;
/**
* @dev External interface of AccessControl declared to support ERC165 detection.
*/
interface IAccessControl {
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*
* _Available since v3.1._
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call, an admin role
* bearer except when using {AccessControl-_setupRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) external view returns (bool);
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {AccessControl-_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) external view returns (bytes32);
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) external;
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) external;
}
// SPDX-License-Identifier: MIT
// OpenZeppelin Contracts 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.5.0) (utils/Address.sol)
pragma solidity ^0.8.1;
/**
* @dev Collection of functions related to the address type
*/
library Address {
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0
// for contracts in construction, since the code is only stored at the end
// of the constructor execution.
return account.code.length > 0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/
function sendValue(address payable recipient, uint256 amount) internal {
require(address(this).balance >= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/
function functionCall(address target, bytes memory data) internal returns (bytes memory) {
return functionCall(target, data, "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");
require(isContract(target), "Address: call to non-contract");
(bool success, bytes memory returndata) = target.call{value: value}(data);
return verifyCallResult(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) {
require(isContract(target), "Address: static call to non-contract");
(bool success, bytes memory returndata) = target.staticcall(data);
return verifyCallResult(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) {
require(isContract(target), "Address: delegate call to non-contract");
(bool success, bytes memory returndata) = target.delegatecall(data);
return verifyCallResult(success, returndata, errorMessage);
}
/**
* @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason 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 {
// Look for revert reason and bubble it up if present
if (returndata.length > 0) {
// The easiest way to bubble the revert reason is using memory via assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// SPDX-License-Identifier: MIT
//
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// ██████████████ ██████████████
// ██████████████ ▄▄████████████████▄▄ ▐█████████████▌
// ██████████████ ▄█████████████████████████████▄ ██████████████
// ██████████▀ ▄█████████████████████████████████ ██████████████▌
// ██████▀ ▄██████████████████████████████████▀ ▄███████████████
// ███▀ ██████████████████████████████████▀ ▄████████████████
// ▀▀ ████████████████████████████████▀▀ ▄█████████████████▌
// █████████████████████▀▀▀▀▀▀▀ ▄▄███████████████████▀
// ██████████████████▀ ▄▄▄█████████████████████████████▀
// ████████████████▀ ▄█████████████████████████████████▀ ██▄
// ▐███████████████▀ ▄██████████████████████████████████▀ █████▄
// ██████████████▀ ▄█████████████████████████████████▀ ▄████████
// ██████████████▀ ███████████████████████████████▀ ▄████████████
// ▐█████████████▌ ▀▀▀▀████████████████████▀▀▀▀ █████████████▌
// ██████████████ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
pragma solidity ^0.8.10;
import "@openzeppelin/contracts/proxy/beacon/IBeacon.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "./mixin/PermissionConstants.sol";
import "./interfaces/IHookProtocol.sol";
/// @dev This contract is used in conjunction with one or more instances of {BeaconProxy} to determine their
/// implementation contract, which is where they will delegate all function calls.
///
/// An owner is able to change the implementation the beacon points to, thus upgrading the proxies that use this beacon.
/// Ownership is managed centrally on the Hook protocol level, where the owner is the holder of a specific permission.
/// This permission should be used only for the purpose of upgrading the particular contract (i.e., the permissions
/// should not be reused).
///
/// This contract is deliberately simple and only has one non-view
/// method - `upgrade`. Timelocks or other upgrade conditions will be managed by
/// the owner of this contract.
/// This contract is based on the UpgradeableBeaconContract from OZ and DharmaUpgradeBeaconController from Dharma
contract HookUpgradeableBeacon is IBeacon, PermissionConstants {
using Address for address;
address private _implementation;
IHookProtocol private _protocol;
bytes32 private _role;
/// @dev Emitted when the implementation returned by the beacon is changed.
event Upgraded(address indexed implementation);
/// @dev Sets the address of the initial implementation, and the deployer account as the owner who can upgrade the
/// beacon.
constructor(
address implementation_,
address hookProtocol,
bytes32 upgraderRole
) {
require(
Address.isContract(hookProtocol),
"UpgradeableBeacon: hookProtocol is not a contract"
);
require(
upgraderRole == VAULT_UPGRADER || upgraderRole == CALL_UPGRADER,
"upgrader role must be vault or call upgrader"
);
_setImplementation(implementation_);
_protocol = IHookProtocol(hookProtocol);
_role = upgraderRole;
}
/// @dev Throws if called by any account other than the owner.
modifier onlyOwner() {
require(
_protocol.hasRole(_role, msg.sender),
"HookUpgradeableBeacon: caller does not have the required upgrade permissions"
);
_;
}
/// @dev Returns the current implementation address.
function implementation() external view virtual override returns (address) {
return _implementation;
}
/// @dev Upgrades the beacon to a new implementation.
///
/// Emits an {Upgraded} event.
///
/// Requirements:
///
/// - msg.sender must be the owner of the contract.
/// - `newImplementation` must be a contract.
function upgradeTo(address newImplementation) external virtual onlyOwner {
_setImplementation(newImplementation);
emit Upgraded(newImplementation);
}
/// @dev Sets the implementation contract address for this beacon
///
/// Requirements:
///
/// - `newImplementation` must be a contract.
function _setImplementation(address newImplementation) private {
require(
Address.isContract(newImplementation),
"HookUpgradeableBeacon: implementation is not a contract"
);
_implementation = newImplementation;
}
}
// SPDX-License-Identifier: MIT
//
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// ██████████████ ██████████████
// ██████████████ ▄▄████████████████▄▄ ▐█████████████▌
// ██████████████ ▄█████████████████████████████▄ ██████████████
// ██████████▀ ▄█████████████████████████████████ ██████████████▌
// ██████▀ ▄██████████████████████████████████▀ ▄███████████████
// ███▀ ██████████████████████████████████▀ ▄████████████████
// ▀▀ ████████████████████████████████▀▀ ▄█████████████████▌
// █████████████████████▀▀▀▀▀▀▀ ▄▄███████████████████▀
// ██████████████████▀ ▄▄▄█████████████████████████████▀
// ████████████████▀ ▄█████████████████████████████████▀ ██▄
// ▐███████████████▀ ▄██████████████████████████████████▀ █████▄
// ██████████████▀ ▄█████████████████████████████████▀ ▄████████
// ██████████████▀ ███████████████████████████████▀ ▄████████████
// ▐█████████████▌ ▀▀▀▀████████████████████▀▀▀▀ █████████████▌
// ██████████████ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
pragma solidity ^0.8.10;
import "@openzeppelin/contracts/access/IAccessControl.sol";
/// @title HookProtocol configuration and access control repository
/// @author Jake [email protected]
/// @custom:coauthor Regynald [email protected]
///
/// @dev it is critically important that the particular protocol implementation
/// is correct as, if it is not, all assets contained within protocol contracts
/// can be easily compromised.
interface IHookProtocol is IAccessControl {
/// @notice the address of the deployed CoveredCallFactory used by the protocol
function coveredCallContract() external view returns (address);
/// @notice the address of the deployed VaultFactory used by the protocol
function vaultContract() external view returns (address);
/// @notice callable function that reverts when the protocol is paused
function throwWhenPaused() external;
/// @notice the standard weth address on this chain
/// @dev these are values for popular chains:
/// mainnet: 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2
/// kovan: 0xd0a1e359811322d97991e03f863a0c30c2cf029c
/// ropsten: 0xc778417e063141139fce010982780140aa0cd5ab
/// rinkeby: 0xc778417e063141139fce010982780140aa0cd5ab
/// @return the weth address
function getWETHAddress() external view returns (address);
/// @notice get a configuration flag with a specific key for a collection
/// @param collectionAddress the collection for which to lookup a configuration flag
/// @param conf the config identifier for the configuration flag
/// @return the true or false value of the config
function getCollectionConfig(address collectionAddress, bytes32 conf)
external
view
returns (bool);
}
// SPDX-License-Identifier: MIT
//
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// █████████████▌ ▐█████████████
// ██████████████ ██████████████
// ██████████████ ▄▄████████████████▄▄ ▐█████████████▌
// ██████████████ ▄█████████████████████████████▄ ██████████████
// ██████████▀ ▄█████████████████████████████████ ██████████████▌
// ██████▀ ▄██████████████████████████████████▀ ▄███████████████
// ███▀ ██████████████████████████████████▀ ▄████████████████
// ▀▀ ████████████████████████████████▀▀ ▄█████████████████▌
// █████████████████████▀▀▀▀▀▀▀ ▄▄███████████████████▀
// ██████████████████▀ ▄▄▄█████████████████████████████▀
// ████████████████▀ ▄█████████████████████████████████▀ ██▄
// ▐███████████████▀ ▄██████████████████████████████████▀ █████▄
// ██████████████▀ ▄█████████████████████████████████▀ ▄████████
// ██████████████▀ ███████████████████████████████▀ ▄████████████
// ▐█████████████▌ ▀▀▀▀████████████████████▀▀▀▀ █████████████▌
// ██████████████ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
// █████████████▌ ██████████████
pragma solidity ^0.8.10;
/// @notice roles on the hook protocol that can be read by other contract
/// @dev new roles here should be initialized in the constructor of the protocol
abstract contract PermissionConstants {
/// ----- ROLES --------
/// @notice the allowlister is able to enable and disable projects to mint instruments
bytes32 public constant ALLOWLISTER_ROLE = keccak256("ALLOWLISTER_ROLE");
/// @notice the pauser is able to start and pause various components of the protocol
bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE");
/// @notice the vault upgrader role is able to upgrade the implementation for all vaults
bytes32 public constant VAULT_UPGRADER = keccak256("VAULT_UPGRADER");
/// @notice the call upgrader role is able to upgrade the implementation of the covered call options
bytes32 public constant CALL_UPGRADER = keccak256("CALL_UPGRADER");
/// @notice the market configuration role allows the actor to make changes to how the market operates
bytes32 public constant MARKET_CONF = keccak256("MARKET_CONF");
/// @notice the collection configuration role allows the actor to make changes the collection
/// configs on the protocol contract
bytes32 public constant COLLECTION_CONF = keccak256("COLLECTION_CONF");
}