1.4.0: Improve ProxyFactory
#468
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,26 +4,11 @@ pragma solidity >=0.7.0 <0.9.0; | |
| import "./GnosisSafeProxy.sol"; | ||
| import "./IProxyCreationCallback.sol"; | ||
|
|
||
| /// @title Proxy Factory - Allows to create a new proxy contract and execute a message call to the new proxy within one transaction. | ||
| /// @author Stefan George - <[email protected]> | ||
| contract GnosisSafeProxyFactory { | ||
| event ProxyCreation(GnosisSafeProxy proxy, address singleton); | ||
|
|
||
| /// @dev Allows to retrieve the runtime code of a deployed Proxy. This can be used to check that the expected Proxy was deployed. | ||
| function proxyRuntimeCode() public pure returns (bytes memory) { | ||
| return type(GnosisSafeProxy).runtimeCode; | ||
|
|
@@ -34,18 +19,13 @@ contract GnosisSafeProxyFactory { | |
| return type(GnosisSafeProxy).creationCode; | ||
| } | ||
|
|
||
| /// @dev Allows to create a new proxy contract using CREATE2. | ||
| /// This method is only meant as an utility to be called from other methods | ||
| /// @param _singleton Address of singleton contract. Must be deployed at the time of execution. | ||
| /// @param salt Create2 salt to use for calculating the address of the new proxy contract. | ||
| function deployProxy(address _singleton, bytes32 salt) internal returns (GnosisSafeProxy proxy) { | ||
| require(isContract(_singleton), "Singleton contract not deployed"); | ||
|
|
||
| bytes memory deploymentData = abi.encodePacked(type(GnosisSafeProxy).creationCode, uint256(uint160(_singleton))); | ||
| // solhint-disable-next-line no-inline-assembly | ||
| assembly { | ||
|
|
@@ -54,16 +34,41 @@ contract GnosisSafeProxyFactory { | |
| require(address(proxy) != address(0), "Create2 call failed"); | ||
| } | ||
|
|
||
| /// @dev Allows to create a new proxy contract and execute a message call to the new proxy within one transaction. | ||
| /// @param _singleton Address of singleton contract. Must be deployed at the time of execution. | ||
| /// @param initializer Payload for message call sent to new proxy contract. | ||
| /// @param saltNonce Nonce that will be used to generate the salt to calculate the address of the new proxy contract. | ||
| function createProxyWithNonce( | ||
| address _singleton, | ||
| bytes memory initializer, | ||
| uint256 saltNonce | ||
| ) public returns (GnosisSafeProxy proxy) { | ||
| // If the initializer changes the proxy address should change too. Hashing the initializer data is cheaper than just concatinating it | ||
| bytes32 salt = keccak256(abi.encodePacked(keccak256(initializer), saltNonce)); | ||
| proxy = deployProxy(_singleton, salt); | ||
| if (initializer.length > 0) | ||
| // solhint-disable-next-line no-inline-assembly | ||
| assembly { | ||
| if eq(call(gas(), proxy, 0, add(initializer, 0x20), mload(initializer), 0, 0), 0) { | ||
| revert(0, 0) | ||
| } | ||
| } | ||
| emit ProxyCreation(proxy, _singleton); | ||
| } | ||
|
|
||
| /// @dev Allows to create a new proxy contract that should exist only on 1 network (e.g. specific governance or admin accounts) | ||
| /// by including the chain id in the create2 salt. Such proxies cannot be created on other networks by replaying the transaction. | ||
| /// @param _singleton Address of singleton contract. Must be deployed at the time of execution. | ||
| /// @param initializer Payload for message call sent to new proxy contract. | ||
| /// @param saltNonce Nonce that will be used to generate the salt to calculate the address of the new proxy contract. | ||
| function createChainSpecificProxyWithNonce( | ||
| address _singleton, | ||
| bytes memory initializer, | ||
| uint256 saltNonce | ||
| ) public returns (GnosisSafeProxy proxy) { | ||
| // If the initializer changes the proxy address should change too. Hashing the initializer data is cheaper than just concatinating it | ||
| bytes32 salt = keccak256(abi.encodePacked(keccak256(initializer), saltNonce, getChainId())); | ||
| proxy = deployProxy(_singleton, salt); | ||
| if (initializer.length > 0) | ||
| // solhint-disable-next-line no-inline-assembly | ||
| assembly { | ||
|
|
@@ -74,8 +79,8 @@ contract GnosisSafeProxyFactory { | |
| emit ProxyCreation(proxy, _singleton); | ||
| } | ||
|
|
||
| /// @dev Allows to create a new proxy contract, execute a message call to the new proxy and call a specified callback within one transaction | ||
| /// @param _singleton Address of singleton contract. Must be deployed at the time of execution. | ||
| /// @param initializer Payload for message call sent to new proxy contract. | ||
| /// @param saltNonce Nonce that will be used to generate the salt to calculate the address of the new proxy contract. | ||
| /// @param callback Callback that will be invoked after the new proxy contract has been successfully deployed and initialized. | ||
|
|
@@ -90,18 +95,24 @@ contract GnosisSafeProxyFactory { | |
| if (address(callback) != address(0)) callback.proxyCreated(proxy, _singleton, initializer, saltNonce); | ||
| } | ||
|
|
||
| /// @dev Returns true if `account` is a contract. | ||
| /// @param account The address being queried | ||
| function isContract(address account) internal view returns (bool) { | ||
| uint256 size; | ||
| // solhint-disable-next-line no-inline-assembly | ||
| assembly { | ||
| size := extcodesize(account) | ||
| } | ||
| return size > 0; | ||
| } | ||
|
|
||
| /// @dev Returns the chain id used by this contract. | ||
| function getChainId() public view returns (uint256) { | ||
| uint256 id; | ||
| // solhint-disable-next-line no-inline-assembly | ||
| assembly { | ||
| id := chainid() | ||
| } | ||
| return id; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I realized that we could move this to the
deployProxymethod or use thecreateProxyWithNoncemethod in this function (with thesaltNoncebeingkeccak256(abi.encodePacked(saltNonce, callback))(as it is for createProxyWithCallback). This would reduce code duplication.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good call, please check it now. I had to import the runtime bytecode from solc artifacts to be used in tests though.