//SPDX-License-Identifier: UNLICENSEDpragmasolidity ^0.8.19;/******************************************************************************\
* Author: Nick Mudge <nick@perfectabstractions.com> (https://twitter.com/mudgen)
* EIP-2535 Diamonds: https://eips.ethereum.org/EIPS/eip-2535
/******************************************************************************/interfaceIDiamondCut{
enumFacetCutAction {
Add,
Replace,
Remove
}
// Add=0, Replace=1, Remove=2structFacetCut {
address facetAddress;
FacetCutAction action;
bytes4[] functionSelectors;
}
/// @notice Add/replace/remove any number of functions and optionally execute/// a function with delegatecall/// @param _diamondCut Contains the facet addresses and function selectors/// @param _init The address of the contract or facet to execute _calldata/// @param _calldata A function call, including function selector and arguments/// _calldata is executed with delegatecall on _initfunctiondiamondCut(FacetCut[] calldata _diamondCut, address _init, bytescalldata _calldata) external;
eventDiamondCut(FacetCut[] _diamondCut, address _init, bytes _calldata);
}
Contract Source Code
File 2 of 4: LGDiamond.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.19;// Adapted from the Diamond 3 reference implementation by Nick Mudge:// https://github.com/mudgen/diamond-3-hardhatimport'../interfaces/IDiamondCut.sol';
import'../libraries/LibContractOwner.sol';
import'../libraries/LibDiamond.sol';
contractDiamond{
errorFunctionDoesNotExist(bytes4 methodSelector);
errorDiamondAlreadyInitialized();
constructor(address diamondCutFacet) payable{
initializeDiamond(diamondCutFacet);
}
// Find facet for function that is called and execute the// function if a facet is found and return any value.fallback() externalpayable{
/* solhint-disable no-inline-assembly */// get facet from function selectoraddress facet = LibDiamond.diamondStorage().selectorToFacetAndPosition[msg.sig].facetAddress;
if (facet ==address(0)) revert FunctionDoesNotExist(msg.sig);
// Execute external function from facet using delegatecall and return any value.assembly {
// copy function selector and any argumentscalldatacopy(0, 0, calldatasize())
// execute function call using the facetlet result :=delegatecall(gas(), facet, 0, calldatasize(), 0, 0)
// get any return valuereturndatacopy(0, 0, returndatasize())
// return any return value or error back to the callerswitch result
case0 {
revert(0, returndatasize())
}
default {
return(0, returndatasize())
}
}
/* solhint-enable no-inline-assembly */
}
/// @notice Initializes the diamond, by adding the `diamondCut` method and setting the owner./// @dev This function is automatically called by the constructor./// @dev The code is separated out to facilitate on-chain copying utilities.functioninitializeDiamond(address diamondCutFacet) public{
LibDiamond.DiamondStorage storage ds = LibDiamond.diamondStorage();
if (ds.initialized) revert DiamondAlreadyInitialized();
// Attach the diamondCut function from the diamondCutFacet
IDiamondCut.FacetCut[] memory cut =new IDiamondCut.FacetCut[](1);
cut[0] = IDiamondCut.FacetCut({
facetAddress: diamondCutFacet,
action: IDiamondCut.FacetCutAction.Add,
functionSelectors: newbytes4[](1)
});
cut[0].functionSelectors[0] = IDiamondCut.diamondCut.selector;
LibDiamond.diamondCut(cut);
// When deployed from an EOA this will be the owner wallet,// when deployed from the clone function, the copier contract will be the owner.
LibContractOwner.setContractOwner(msg.sender);
ds.initialized =true;
}
receive() externalpayable{}
}
Contract Source Code
File 3 of 4: LibContractOwner.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.19;/// @title Library for the common LG implementation of ERC-173 Contract Ownership Standard/// @author rsampson@laguna.games/// @custom:storage-location erc1967:eip1967.proxy.adminlibraryLibContractOwner{
errorCallerIsNotContractOwner();
/// @notice This emits when ownership of a contract changes./// @dev ERC-173eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/// @notice Emitted when the admin account has changed./// @dev ERC-1967eventAdminChanged(address previousAdmin, address newAdmin);
// @dev Standard storage slot for the ERC-1967 admin address// @dev bytes32(uint256(keccak256('eip1967.proxy.admin')) - 1)bytes32privateconstant ADMIN_SLOT_POSITION =0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103;
structLibOwnerStorage {
address contractOwner;
}
/// @notice Storage slot for Contract Owner state datafunctionownerStorage() internalpurereturns (LibOwnerStorage storage storageSlot) {
bytes32 position = ADMIN_SLOT_POSITION;
// solhint-disable-next-line no-inline-assemblyassembly {
storageSlot.slot:= position
}
}
/// @notice Sets the contract owner/// @param newOwner The new owner/// @custom:emits OwnershipTransferredfunctionsetContractOwner(address newOwner) internal{
LibOwnerStorage storage ls = ownerStorage();
address previousOwner = ls.contractOwner;
ls.contractOwner = newOwner;
emit OwnershipTransferred(previousOwner, newOwner);
emit AdminChanged(previousOwner, newOwner);
}
/// @notice Gets the contract owner wallet/// @return owner The contract ownerfunctioncontractOwner() internalviewreturns (address owner) {
owner = ownerStorage().contractOwner;
}
/// @notice Ensures that the caller is the contract owner, or throws an error./// @custom:throws LibAccess: Must be contract ownerfunctionenforceIsContractOwner() internalview{
if (msg.sender!= ownerStorage().contractOwner) revert CallerIsNotContractOwner();
}
}
Contract Source Code
File 4 of 4: LibDiamond.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.19;import'../interfaces/IDiamondCut.sol';
import'./LibContractOwner.sol';
/// @title LibDiamond/// @notice Library for the common LG implementation of ERC-2535 Diamond Proxy/// @notice Adapted from the Diamond 3 reference implementation by Nick Mudge:/// @notice https://github.com/mudgen/diamond-3-hardhat/// @custom:storage-location erc2535:diamond.standard.diamond.storagelibraryLibDiamond{
errorInvalidFacetCutAction(IDiamondCut.FacetCutAction action);
/// @notice Emitted when facets are added or removed/// @dev ERC-2535eventDiamondCut(IDiamondCut.FacetCut[] _diamondCut, address _init, bytes _calldata);
// @dev Standard storage slot for the ERC-2535 Diamond storage// @dev keccak256('diamond.standard.diamond.storage')bytes32internalconstant DIAMOND_STORAGE_POSITION =0xc8fcad8db84d3cc18b4c41d551ea0ee66dd599cde068d998e57d5e09332c131c;
structFacetAddressAndPosition {
address facetAddress;
uint96 functionSelectorPosition; // position in facetFunctionSelectors.functionSelectors array
}
structFacetFunctionSelectors {
bytes4[] functionSelectors;
uint256 facetAddressPosition; // position of facetAddress in facetAddresses array
}
structDiamondStorage {
// maps function selector to the facet address and// the position of the selector in the facetFunctionSelectors.selectors arraymapping(bytes4=> FacetAddressAndPosition) selectorToFacetAndPosition;
// maps facet addresses to function selectorsmapping(address=> FacetFunctionSelectors) facetFunctionSelectors;
// facet addressesaddress[] facetAddresses;
// true if the diamond has been initializedbool initialized; // THIS IS ONLY SET BY THE DIAMOND CONSTRUCTOR!
}
/// @notice Storage slot for Diamond storagefunctiondiamondStorage() internalpurereturns (DiamondStorage storage ds) {
bytes32 position = DIAMOND_STORAGE_POSITION;
assembly {
ds.slot:= position
}
}
/// @notice Ensures that the caller is the contract owner, or throws an error./// @dev Passthrough to LibContractOwner.enforceIsContractOwner()/// @custom:throws LibAccess: Must be contract ownerfunctionenforceIsContractOwner() internalview{
LibContractOwner.enforceIsContractOwner();
}
// Internal function version of diamondCutfunctiondiamondCut(IDiamondCut.FacetCut[] memory _diamondCut) internal{
for (uint256 facetIndex; facetIndex < _diamondCut.length; ++facetIndex) {
IDiamondCut.FacetCutAction action = _diamondCut[facetIndex].action;
if (action == IDiamondCut.FacetCutAction.Add) {
addFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} elseif (action == IDiamondCut.FacetCutAction.Replace) {
replaceFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} elseif (action == IDiamondCut.FacetCutAction.Remove) {
removeFunctions(_diamondCut[facetIndex].facetAddress, _diamondCut[facetIndex].functionSelectors);
} else {
revert InvalidFacetCutAction(action);
}
}
emit DiamondCut(_diamondCut, address(0), '');
}
functionaddFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal{
require(_functionSelectors.length>0, 'LibDiamondCut: No selectors in facet to cut');
DiamondStorage storage ds = diamondStorage();
require(_facetAddress !=address(0), "LibDiamondCut: Add facet can't be address(0)");
uint96 selectorPosition =uint96(ds.facetFunctionSelectors[_facetAddress].functionSelectors.length);
// add new facet address if it does not existif (selectorPosition ==0) {
addFacet(ds, _facetAddress);
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ++selectorIndex) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
require(oldFacetAddress ==address(0), "LibDiamondCut: Can't add function that already exists");
addFunction(ds, selector, selectorPosition, _facetAddress);
++selectorPosition;
}
}
functionreplaceFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal{
require(_functionSelectors.length>0, 'LibDiamondCut: No selectors in facet to cut');
DiamondStorage storage ds = diamondStorage();
require(_facetAddress !=address(0), "LibDiamondCut: Add facet can't be address(0)");
uint96 selectorPosition =uint96(ds.facetFunctionSelectors[_facetAddress].functionSelectors.length);
// add new facet address if it does not existif (selectorPosition ==0) {
addFacet(ds, _facetAddress);
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ++selectorIndex) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
require(oldFacetAddress != _facetAddress, "LibDiamondCut: Can't replace function with same function");
removeFunction(ds, oldFacetAddress, selector);
addFunction(ds, selector, selectorPosition, _facetAddress);
++selectorPosition;
}
}
functionremoveFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal{
require(_functionSelectors.length>0, 'LibDiamondCut: No selectors in facet to cut');
DiamondStorage storage ds = diamondStorage();
// if function does not exist then do nothing and returnrequire(_facetAddress ==address(0), 'LibDiamondCut: Remove facet address must be address(0)');
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length; ++selectorIndex) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
removeFunction(ds, oldFacetAddress, selector);
}
}
functionaddFacet(DiamondStorage storage ds, address _facetAddress) internal{
enforceHasContractCode(_facetAddress, 'LibDiamondCut: New facet has no code');
ds.facetFunctionSelectors[_facetAddress].facetAddressPosition = ds.facetAddresses.length;
ds.facetAddresses.push(_facetAddress);
}
functionaddFunction(
DiamondStorage storage ds,
bytes4 _selector,
uint96 _selectorPosition,
address _facetAddress
) internal{
ds.selectorToFacetAndPosition[_selector].functionSelectorPosition = _selectorPosition;
ds.facetFunctionSelectors[_facetAddress].functionSelectors.push(_selector);
ds.selectorToFacetAndPosition[_selector].facetAddress = _facetAddress;
}
functionremoveFunction(DiamondStorage storage ds, address _facetAddress, bytes4 _selector) internal{
require(_facetAddress !=address(0), "LibDiamondCut: Can't remove function that doesn't exist");
// an immutable function is a function defined directly in a diamondrequire(_facetAddress !=address(this), "LibDiamondCut: Can't remove immutable function");
// replace selector with last selector, then delete last selectoruint256 selectorPosition = ds.selectorToFacetAndPosition[_selector].functionSelectorPosition;
uint256 lastSelectorPosition = ds.facetFunctionSelectors[_facetAddress].functionSelectors.length-1;
// if not the same then replace _selector with lastSelectorif (selectorPosition != lastSelectorPosition) {
bytes4 lastSelector = ds.facetFunctionSelectors[_facetAddress].functionSelectors[lastSelectorPosition];
ds.facetFunctionSelectors[_facetAddress].functionSelectors[selectorPosition] = lastSelector;
ds.selectorToFacetAndPosition[lastSelector].functionSelectorPosition =uint96(selectorPosition);
}
// delete the last selector
ds.facetFunctionSelectors[_facetAddress].functionSelectors.pop();
delete ds.selectorToFacetAndPosition[_selector];
// if no more selectors for facet address then delete the facet addressif (lastSelectorPosition ==0) {
// replace facet address with last facet address and delete last facet addressuint256 lastFacetAddressPosition = ds.facetAddresses.length-1;
uint256 facetAddressPosition = ds.facetFunctionSelectors[_facetAddress].facetAddressPosition;
if (facetAddressPosition != lastFacetAddressPosition) {
address lastFacetAddress = ds.facetAddresses[lastFacetAddressPosition];
ds.facetAddresses[facetAddressPosition] = lastFacetAddress;
ds.facetFunctionSelectors[lastFacetAddress].facetAddressPosition = facetAddressPosition;
}
ds.facetAddresses.pop();
delete ds.facetFunctionSelectors[_facetAddress].facetAddressPosition;
}
}
functionenforceHasContractCode(address _contract, stringmemory _errorMessage) internalview{
uint256 contractSize;
assembly {
contractSize :=extcodesize(_contract)
}
require(contractSize >0, _errorMessage);
}
}