// SPDX-License-Identifier: MITpragmasolidity 0.8.23;import {LibDiamond} from"./Libraries/LibDiamond.sol";
import {IDiamondCut} from"./Interfaces/IDiamondCut.sol";
import {LibUtil} from"./Libraries/LibUtil.sol";
contractDiamond{
constructor(address _contractOwner, address _diamondCutFacet) payable{
LibDiamond.setContractOwner(_contractOwner);
// Add the diamondCut external function from the diamondCutFacet
IDiamondCut.FacetCut[] memory cut =new IDiamondCut.FacetCut[](1);
bytes4[] memory functionSelectors =newbytes4[](1);
functionSelectors[0] = IDiamondCut.diamondCut.selector;
cut[0] = IDiamondCut.FacetCut({
facetAddress: _diamondCutFacet,
action: IDiamondCut.FacetCutAction.Add,
functionSelectors: functionSelectors
});
LibDiamond.diamondCut(cut, address(0), "");
}
// Find facet for function that is called and execute the// function if a facet is found and return any value.// solhint-disable-next-line no-complex-fallbackfallback() externalpayable{
LibDiamond.DiamondStorage storage ds;
bytes32 position = LibDiamond.DIAMOND_STORAGE_POSITION;
// get diamond storage// solhint-disable-next-line no-inline-assemblyassembly {
ds.slot:= position
}
// get facet from function selectoraddress facet = ds.selectorToFacetAndPosition[msg.sig].facetAddress;
if (facet ==address(0)) {
revert LibDiamond.FunctionDoesNotExist();
}
// Execute external function from facet using delegatecall and return any value.// solhint-disable-next-line no-inline-assemblyassembly {
// 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()) }
}
}
// Able to receive ether// solhint-disable-next-line no-empty-blocksreceive() externalpayable{}
}
// SPDX-License-Identifier: MITpragmasolidity 0.8.23;interfaceIDiamondCut{
// Add=0, Replace=1, Remove=2enumFacetCutAction {
Add,
Replace,
Remove
}
structFacetCut {
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 4 of 6: LibBytes.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.23;libraryLibBytes{
// solhint-disable no-inline-assembly// LibBytes specific errorserrorSliceOverflow();
errorSliceOutOfBounds();
errorAddressOutOfBounds();
bytes16privateconstant _SYMBOLS ="0123456789abcdef";
// -------------------------functionslice(bytesmemory _bytes, uint256 _start, uint256 _length) internalpurereturns (bytesmemory) {
unchecked {
if (_length +31< _length) revert SliceOverflow();
if (_bytes.length< _start + _length) revert SliceOutOfBounds();
if (_start + _length < _start) revert SliceOverflow();
}
bytesmemory tempBytes;
assembly {
switchiszero(_length)
case0 {
// Get a location of some free memory and store it in tempBytes as// Solidity does for memory variables.
tempBytes :=mload(0x40)
// The first word of the slice result is potentially a partial// word read from the original array. To read it, we calculate// the length of that partial word and start copying that many// bytes into the array. The first word we copy will start with// data we don't care about, but the last `lengthmod` bytes will// land at the beginning of the contents of the new array. When// we're done copying, we overwrite the full first word with// the actual length of the slice.let lengthmod :=and(_length, 31)
// The multiplication in the next line is necessary// because when slicing multiples of 32 bytes (lengthmod == 0)// the following copy loop was copying the origin's length// and then ending prematurely not copying everything it should.let mc :=add(add(tempBytes, lengthmod), mul(0x20, iszero(lengthmod)))
let end :=add(mc, _length)
for {
// The multiplication in the next line has the same exact purpose// as the one above.let cc :=add(add(add(_bytes, lengthmod), mul(0x20, iszero(lengthmod))), _start)
} lt(mc, end) {
mc :=add(mc, 0x20)
cc :=add(cc, 0x20)
} { mstore(mc, mload(cc)) }
mstore(tempBytes, _length)
//update free-memory pointer//allocating the array padded to 32 bytes like the compiler does nowmstore(0x40, and(add(mc, 31), not(31)))
}
//if we want a zero-length slice let's just return a zero-length arraydefault {
tempBytes :=mload(0x40)
//zero out the 32 bytes slice we are about to return//we need to do it because Solidity does not garbage collectmstore(tempBytes, 0)
mstore(0x40, add(tempBytes, 0x20))
}
}
return tempBytes;
}
functiontoAddress(bytesmemory _bytes, uint256 _start) internalpurereturns (address) {
if (_bytes.length< _start +20) {
revert AddressOutOfBounds();
}
address tempAddress;
assembly {
tempAddress :=div(mload(add(add(_bytes, 0x20), _start)), 0x1000000000000000000000000)
}
return tempAddress;
}
/// Copied from OpenZeppelin's `Strings.sol` utility library./// https://github.com/OpenZeppelin/openzeppelin-contracts/blob/8335676b0e99944eef6a742e16dcd9ff6e68e609/contracts/utils/Strings.solfunctiontoHexString(uint256 value, uint256 length) internalpurereturns (stringmemory) {
bytesmemory buffer =newbytes(2* length +2);
buffer[0] ="0";
buffer[1] ="x";
for (uint256 i =2* length +1; i >1; --i) {
buffer[i] = _SYMBOLS[value &0xf];
value >>=4;
}
require(value ==0, "Strings: hex length insufficient");
returnstring(buffer);
}
}
Contract Source Code
File 5 of 6: LibDiamond.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.23;import {IDiamondCut} from"../Interfaces/IDiamondCut.sol";
import {LibUtil} from"../Libraries/LibUtil.sol";
import {OnlyContractOwner} from"../Errors/GenericErrors.sol";
/// Implementation of EIP-2535 Diamond Standard/// https://eips.ethereum.org/EIPS/eip-2535libraryLibDiamond{
bytes32internalconstant DIAMOND_STORAGE_POSITION =keccak256("com.binance.w3w.diamond.storage");
// Diamond specific errorserrorIncorrectFacetCutAction();
errorNoSelectorsInFace();
errorFunctionAlreadyExists();
errorFacetAddressIsZero();
errorFacetAddressIsNotZero();
errorFacetContainsNoCode();
errorFunctionDoesNotExist();
errorFunctionIsImmutable();
errorInitZeroButCalldataNotEmpty();
errorCalldataEmptyButInitNotZero();
errorInitReverted();
// ----------------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;
// Used to query if a contract implements an interface.// Used to implement ERC-165.mapping(bytes4=>bool) supportedInterfaces;
// owner of the contractaddress contractOwner;
}
functiondiamondStorage() internalpurereturns (DiamondStorage storage ds) {
bytes32 position = DIAMOND_STORAGE_POSITION;
// solhint-disable-next-line no-inline-assemblyassembly {
ds.slot:= position
}
}
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
functionsetContractOwner(address _newOwner) internal{
DiamondStorage storage ds = diamondStorage();
address previousOwner = ds.contractOwner;
ds.contractOwner = _newOwner;
emit OwnershipTransferred(previousOwner, _newOwner);
}
functioncontractOwner() internalviewreturns (address contractOwner_) {
contractOwner_ = diamondStorage().contractOwner;
}
functionenforceIsContractOwner() internalview{
if (msg.sender!= diamondStorage().contractOwner) {
revert OnlyContractOwner();
}
}
eventDiamondCut(IDiamondCut.FacetCut[] _diamondCut, address _init, bytes _calldata);
// Internal function version of diamondCutfunctiondiamondCut(IDiamondCut.FacetCut[] memory _diamondCut, address _init, bytesmemory _calldata) internal{
for (uint256 facetIndex; facetIndex < _diamondCut.length;) {
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 IncorrectFacetCutAction();
}
unchecked {
++facetIndex;
}
}
emit DiamondCut(_diamondCut, _init, _calldata);
initializeDiamondCut(_init, _calldata);
}
functionaddFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal{
if (_functionSelectors.length==0) {
revert NoSelectorsInFace();
}
DiamondStorage storage ds = diamondStorage();
if (LibUtil.isZeroAddress(_facetAddress)) {
revert FacetAddressIsZero();
}
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;) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
if (!LibUtil.isZeroAddress(oldFacetAddress)) {
revert FunctionAlreadyExists();
}
addFunction(ds, selector, selectorPosition, _facetAddress);
unchecked {
++selectorPosition;
++selectorIndex;
}
}
}
functionreplaceFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal{
if (_functionSelectors.length==0) {
revert NoSelectorsInFace();
}
DiamondStorage storage ds = diamondStorage();
if (LibUtil.isZeroAddress(_facetAddress)) {
revert FacetAddressIsZero();
}
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;) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
if (oldFacetAddress == _facetAddress) {
revert FunctionAlreadyExists();
}
removeFunction(ds, oldFacetAddress, selector);
addFunction(ds, selector, selectorPosition, _facetAddress);
unchecked {
++selectorPosition;
++selectorIndex;
}
}
}
functionremoveFunctions(address _facetAddress, bytes4[] memory _functionSelectors) internal{
if (_functionSelectors.length==0) {
revert NoSelectorsInFace();
}
DiamondStorage storage ds = diamondStorage();
// if function does not exist then do nothing and returnif (!LibUtil.isZeroAddress(_facetAddress)) {
revert FacetAddressIsNotZero();
}
for (uint256 selectorIndex; selectorIndex < _functionSelectors.length;) {
bytes4 selector = _functionSelectors[selectorIndex];
address oldFacetAddress = ds.selectorToFacetAndPosition[selector].facetAddress;
removeFunction(ds, oldFacetAddress, selector);
unchecked {
++selectorIndex;
}
}
}
functionaddFacet(DiamondStorage storage ds, address _facetAddress) internal{
enforceHasContractCode(_facetAddress);
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{
if (LibUtil.isZeroAddress(_facetAddress)) {
revert FunctionDoesNotExist();
}
// an immutable function is a function defined directly in a diamondif (_facetAddress ==address(this)) {
revert FunctionIsImmutable();
}
// 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;
}
}
functioninitializeDiamondCut(address _init, bytesmemory _calldata) internal{
if (LibUtil.isZeroAddress(_init)) {
if (_calldata.length!=0) {
revert InitZeroButCalldataNotEmpty();
}
} else {
if (_calldata.length==0) {
revert CalldataEmptyButInitNotZero();
}
if (_init !=address(this)) {
enforceHasContractCode(_init);
}
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytesmemoryerror) = _init.delegatecall(_calldata);
if (!success) {
if (error.length>0) {
// bubble up the errorrevert(string(error));
} else {
revert InitReverted();
}
}
}
}
functionenforceHasContractCode(address _contract) internalview{
uint256 contractSize;
// solhint-disable-next-line no-inline-assemblyassembly {
contractSize :=extcodesize(_contract)
}
if (contractSize ==0) {
revert FacetContainsNoCode();
}
}
}
Contract Source Code
File 6 of 6: LibUtil.sol
// SPDX-License-Identifier: MITpragmasolidity 0.8.23;import"./LibBytes.sol";
libraryLibUtil{
usingLibBytesforbytes;
functiongetRevertMsg(bytesmemory _res) internalpurereturns (stringmemory) {
// If the _res length is less than 68, then the transaction failed silently (without a revert message)if (_res.length<68) return"Transaction reverted silently";
bytesmemory revertData = _res.slice(4, _res.length-4); // Remove the selector which is the first 4 bytesreturnabi.decode(revertData, (string)); // All that remains is the revert string
}
/// @notice Determines whether the given address is the zero address/// @param addr The address to verify/// @return Boolean indicating if the address is the zero addressfunctionisZeroAddress(address addr) internalpurereturns (bool) {
return addr ==address(0);
}
}