// SPDX-License-Identifier: MIT pragma solidity >=0.6.2 <0.9.0; pragma experimental ABIEncoderV2; import {Vm} from "forge-std/Vm.sol"; import {IMulticall3} from "forge-std/interfaces/IMulticall3.sol"; import {LibClone} from "solady/utils/LibClone.sol"; import {LibString} from "solady/utils/LibString.sol"; library LibDeploy { using LibString for string; /// @dev Used when deploying with create2, https://github.com/Arachnid/deterministic-deployment-proxy. /// The calldata should be the 32 byte 'salt' followed by the init code. address internal constant CREATE2_FACTORY = 0x4e59b44847b379578588920cA78FbF26c0B4956C; /// @dev Deterministic deployment address of the Multicall3 contract. /// Taken from https://www.multicall3.com. address internal constant MULTICALL3_ADDRESS = 0xcA11bde05977b3631167028862bE2a173976CA11; /// @dev Multicall3 bytecode, used in test bytes internal constant MULTICALL3_BYTECODE = hex"6080604052600436106100f35760003560e01c80634d2301cc1161008a578063a8b0574e11610059578063a8b0574e1461025a578063bce38bd714610275578063c3077fa914610288578063ee82ac5e1461029b57600080fd5b80634d2301cc146101ec57806372425d9d1461022157806382ad56cb1461023457806386d516e81461024757600080fd5b80633408e470116100c65780633408e47014610191578063399542e9146101a45780633e64a696146101c657806342cbb15c146101d957600080fd5b80630f28c97d146100f8578063174dea711461011a578063252dba421461013a57806327e86d6e1461015b575b600080fd5b34801561010457600080fd5b50425b6040519081526020015b60405180910390f35b61012d610128366004610a85565b6102ba565b6040516101119190610bbe565b61014d610148366004610a85565b6104ef565b604051610111929190610bd8565b34801561016757600080fd5b50437fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0140610107565b34801561019d57600080fd5b5046610107565b6101b76101b2366004610c60565b610690565b60405161011193929190610cba565b3480156101d257600080fd5b5048610107565b3480156101e557600080fd5b5043610107565b3480156101f857600080fd5b50610107610207366004610ce2565b73ffffffffffffffffffffffffffffffffffffffff163190565b34801561022d57600080fd5b5044610107565b61012d610242366004610a85565b6106ab565b34801561025357600080fd5b5045610107565b34801561026657600080fd5b50604051418152602001610111565b61012d610283366004610c60565b61085a565b6101b7610296366004610a85565b610a1a565b3480156102a757600080fd5b506101076102b6366004610d18565b4090565b60606000828067ffffffffffffffff8111156102d8576102d8610d31565b60405190808252806020026020018201604052801561031e57816020015b6040805180820190915260008152606060208201528152602001906001900390816102f65790505b5092503660005b8281101561047757600085828151811061034157610341610d60565b6020026020010151905087878381811061035d5761035d610d60565b905060200281019061036f9190610d8f565b6040810135958601959093506103886020850185610ce2565b73ffffffffffffffffffffffffffffffffffffffff16816103ac6060870187610dcd565b6040516103ba929190610e32565b60006040518083038185875af1925050503d80600081146103f7576040519150601f19603f3d011682016040523d82523d6000602084013e6103fc565b606091505b50602080850191909152901515808452908501351761046d577f08c379a000000000000000000000000000000000000000000000000000000000600052602060045260176024527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060445260846000fd5b5050600101610325565b508234146104e6576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601a60248201527f4d756c746963616c6c333a2076616c7565206d69736d6174636800000000000060448201526064015b60405180910390fd5b50505092915050565b436060828067ffffffffffffffff81111561050c5761050c610d31565b60405190808252806020026020018201604052801561053f57816020015b606081526020019060019003908161052a5790505b5091503660005b8281101561068657600087878381811061056257610562610d60565b90506020028101906105749190610e42565b92506105836020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff166105a66020850185610dcd565b6040516105b4929190610e32565b6000604051808303816000865af19150503d80600081146105f1576040519150601f19603f3d011682016040523d82523d6000602084013e6105f6565b606091505b5086848151811061060957610609610d60565b602090810291909101015290508061067d576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060448201526064016104dd565b50600101610546565b5050509250929050565b43804060606106a086868661085a565b905093509350939050565b6060818067ffffffffffffffff8111156106c7576106c7610d31565b60405190808252806020026020018201604052801561070d57816020015b6040805180820190915260008152606060208201528152602001906001900390816106e55790505b5091503660005b828110156104e657600084828151811061073057610730610d60565b6020026020010151905086868381811061074c5761074c610d60565b905060200281019061075e9190610e76565b925061076d6020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff166107906040850185610dcd565b60405161079e929190610e32565b6000604051808303816000865af19150503d80600081146107db576040519150601f19603f3d011682016040523d82523d6000602084013e6107e0565b606091505b506020808401919091529015158083529084013517610851577f08c379a000000000000000000000000000000000000000000000000000000000600052602060045260176024527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060445260646000fd5b50600101610714565b6060818067ffffffffffffffff81111561087657610876610d31565b6040519080825280602002602001820160405280156108bc57816020015b6040805180820190915260008152606060208201528152602001906001900390816108945790505b5091503660005b82811015610a105760008482815181106108df576108df610d60565b602002602001015190508686838181106108fb576108fb610d60565b905060200281019061090d9190610e42565b925061091c6020840184610ce2565b73ffffffffffffffffffffffffffffffffffffffff1661093f6020850185610dcd565b60405161094d929190610e32565b6000604051808303816000865af19150503d806000811461098a576040519150601f19603f3d011682016040523d82523d6000602084013e61098f565b606091505b506020830152151581528715610a07578051610a07576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601760248201527f4d756c746963616c6c333a2063616c6c206661696c656400000000000000000060448201526064016104dd565b506001016108c3565b5050509392505050565b6000806060610a2b60018686610690565b919790965090945092505050565b60008083601f840112610a4b57600080fd5b50813567ffffffffffffffff811115610a6357600080fd5b6020830191508360208260051b8501011115610a7e57600080fd5b9250929050565b60008060208385031215610a9857600080fd5b823567ffffffffffffffff811115610aaf57600080fd5b610abb85828601610a39565b90969095509350505050565b6000815180845260005b81811015610aed57602081850181015186830182015201610ad1565b81811115610aff576000602083870101525b50601f017fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe0169290920160200192915050565b600082825180855260208086019550808260051b84010181860160005b84811015610bb1578583037fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe001895281518051151584528401516040858501819052610b9d81860183610ac7565b9a86019a9450505090830190600101610b4f565b5090979650505050505050565b602081526000610bd16020830184610b32565b9392505050565b600060408201848352602060408185015281855180845260608601915060608160051b870101935082870160005b82811015610c52577fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa0888703018452610c40868351610ac7565b95509284019290840190600101610c06565b509398975050505050505050565b600080600060408486031215610c7557600080fd5b83358015158114610c8557600080fd5b9250602084013567ffffffffffffffff811115610ca157600080fd5b610cad86828701610a39565b9497909650939450505050565b838152826020820152606060408201526000610cd96060830184610b32565b95945050505050565b600060208284031215610cf457600080fd5b813573ffffffffffffffffffffffffffffffffffffffff81168114610bd157600080fd5b600060208284031215610d2a57600080fd5b5035919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052604160045260246000fd5b7f4e487b7100000000000000000000000000000000000000000000000000000000600052603260045260246000fd5b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff81833603018112610dc357600080fd5b9190910192915050565b60008083357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffe1843603018112610e0257600080fd5b83018035915067ffffffffffffffff821115610e1d57600080fd5b602001915036819003821315610a7e57600080fd5b8183823760009101908152919050565b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffc1833603018112610dc357600080fd5b600082357fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffa1833603018112610dc357600080fdfea2646970667358221220bb2b5c71a328032f97c676ae39a1ec2148d3e5d6f73d95e9b17910152d61f16264736f6c634300080c0033"; /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/ /* FOUNDRY UTILS */ /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/ Vm private constant vm = Vm(address(uint160(uint256(keccak256("hevm cheat code"))))); /// @notice Get the artifact path for a contract name with validation /// @param outDir Path to the artifacts directory (usually "out") /// @param name Name of the contract /// @return path The path to the contract artifact function getArtifactPath( string memory outDir, string memory name ) internal view returns (string memory path) { // try the standard path first string memory standardPath = string.concat(outDir, "/", name, ".sol/", name, ".json"); if (vm.exists(standardPath)) { return standardPath; } // if standard path doesn't exist, search all artifacts // depth 2 for out/ContractDir/Contract.json Vm.DirEntry[] memory entries = vm.readDir(outDir, 2); string memory jsonFileName = string.concat("/", name, ".json"); for (uint256 i; i < entries.length; ++i) { Vm.DirEntry memory entry = entries[i]; // skip directories and files with errors if (entry.isDir || bytes(entry.errorMessage).length > 0) continue; // check if filename matches if (entry.path.endsWith(jsonFileName)) { return entry.path; } } // no matching artifact found revert( string.concat( "LibDeploy: Could not find artifact for '", name, "'. Ensure the contract exists and has been compiled." ) ); } /// @notice Deploy a contract by fetching the contract bytecode from the artifacts directory /// @dev Credit: forge-std/StdCheatsSafe::deployCode /// @param outDir Path to the artifacts directory (usually "out") /// @param name The name of the contract to deploy /// @param args The abi-encoded constructor arguments /// @param salt The salt to use for the CREATE2 deployment /// @return addr The address of the deployed contract function deployCode( string memory outDir, string memory name, bytes memory args, bytes32 salt ) internal returns (address addr) { string memory artifactPath = getArtifactPath(outDir, name); return deployCode(artifactPath, args, salt); } /// @notice Deploy a contract by fetching the contract bytecode from the artifacts directory /// @dev Credit: forge-std/StdCheatsSafe::deployCode /// @param artifactPath The path to the contract artifact /// @param args The abi-encoded constructor arguments /// @param salt The salt to use for the CREATE2 deployment /// @return addr The address of the deployed contract function deployCode( string memory artifactPath, bytes memory args, bytes32 salt ) internal returns (address addr) { bytes memory bytecode = bytes.concat(vm.getCode(artifactPath), args); addr = LibClone.predictDeterministicAddress(keccak256(bytecode), salt, CREATE2_FACTORY); // if the address is already deployed, return it if (addr.code.length > 0) return addr; addr = deployWithCreate2Factory(bytecode, salt); } /// @notice Deploy a contract by fetching the contract bytecode from the artifacts directory /// @dev Credit: forge-std/StdCheatsSafe::deployCode /// @param artifactPath The path to the contract artifact /// @param args The abi-encoded constructor arguments /// @return The address of the deployed contract function deployCode(string memory artifactPath, bytes memory args) internal returns (address) { return deployCode(artifactPath, args, 0); } /// @notice Predict the address of a contract deployed with deployCode /// @param outDir Path to the artifacts directory (usually "out") /// @param name The name of the contract /// @param args The abi-encoded constructor arguments /// @param salt The salt to use for the CREATE2 deployment /// @return addr The predicted address of the deployed contract function predictDeployCode( string memory outDir, string memory name, bytes memory args, bytes32 salt ) internal view returns (address addr) { string memory artifactPath = getArtifactPath(outDir, name); return predictDeployCode(artifactPath, args, salt); } /// @notice Predict the address of a contract deployed with deployCode /// @param artifactPath The path to the contract artifact /// @param args The abi-encoded constructor arguments /// @param salt The salt to use for the CREATE2 deployment /// @return addr The predicted address of the deployed contract function predictDeployCode( string memory artifactPath, bytes memory args, bytes32 salt ) internal view returns (address addr) { bytes memory bytecode = bytes.concat(vm.getCode(artifactPath), args); addr = LibClone.predictDeterministicAddress(keccak256(bytecode), salt, CREATE2_FACTORY); } /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/ /* CREATE2 UTILS */ /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/ /// @notice Deploy a contract using the default CREATE2 factory /// @param bytecode The bytecode of the contract to deploy /// @param salt The salt to use for the CREATE2 deployment /// @return addr The address of the deployed contract function deployWithCreate2Factory( bytes memory bytecode, bytes32 salt ) internal returns (address addr) { /// @solidity memory-safe-assembly assembly { // cache the length let len := mload(bytecode) // reuse the length pointer to avoid alloc mstore(bytecode, salt) if iszero(call(gas(), CREATE2_FACTORY, 0, bytecode, add(len, 0x20), 0, 0x14)) { returndatacopy(0, 0, returndatasize()) revert(0, returndatasize()) } addr := shr(96, mload(0)) // restore the length mstore(bytecode, len) } } /// @notice Deploy multiple contracts using Multicall3.aggregate /// @param bytecodes Array of bytecodes for the contracts to deploy /// @param salts Array of salts to use for each deployment /// @return addresses Array of addresses of the deployed contracts function deployMultiple( bytes[] memory bytecodes, bytes32[] memory salts ) internal returns (address[] memory addresses) { require(bytecodes.length == salts.length); // Create array of calls for multicall3 IMulticall3.Call[] memory calls = new IMulticall3.Call[](bytecodes.length); for (uint256 i; i < bytecodes.length; ++i) { // CREATE2_FACTORY expects calldata: <32-byte salt> bytes memory callData = bytes.concat(salts[i], bytecodes[i]); IMulticall3.Call memory call = calls[i]; (call.target, call.callData) = (CREATE2_FACTORY, callData); } // Execute all calls in a batch (, bytes[] memory returnData) = IMulticall3(MULTICALL3_ADDRESS).aggregate(calls); // Extract deployed addresses from return data addresses = new address[](bytecodes.length); for (uint256 i; i < bytecodes.length; ++i) { addresses[i] = _extractAddressFromReturnData(returnData[i]); } } /// @dev Extract the deployed contract address from the CREATE2_FACTORY return data /// @param returnData The return data from the CREATE2_FACTORY call /// @return addr The deployed contract address function _extractAddressFromReturnData(bytes memory returnData) private pure returns (address addr) { /// @solidity memory-safe-assembly assembly { addr := shr(96, mload(add(returnData, 0x20))) } } }