Merge branch 'main' of github.com:safe-global/safe-contracts into formal-verification

mmv08 · mmv08 · commit 67d05a69ebe7 · 2023-05-03T15:32:15.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,165 @@
 
 This changelog only contains changes starting from version 1.3.0
 
+# Version 1.4.0
+
+## Compiler settings
+
+Solidity compiler: [0.7.6](https://github.com/ethereum/solidity/releases/tag/v0.7.6) (for more info see issue [#251](https://github.com/safe-global/safe-contracts/issues/251))
+
+Solidity optimizer: `disabled`
+
+## Expected addresses with [Safe Singleton Factory](https://github.com/safe-global/safe-singleton-factory)
+
+### Core contracts
+
+-   `Safe` at `0xc962E67D9490E154D81181879ddf4CD3b65D2132`
+-   `SafeL2` at `0x1eb4681c549d995AbdC4aB189cAbb9f00B508cAb`
+
+### Factory contracts
+
+-   `SafeProxyFactory` at `0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67`
+
+### Handler contracts
+
+-   `TokenCallbackHandler` at `0xeDCF620325E82e3B9836eaaeFdc4283E99Dd7562`
+-   `CompatibilityFallbackHandler` at `0x2a15DE4410d4c8af0A7b6c12803120f43C42B820`
+
+### Lib contracts
+
+-   `MultiSend` at `0x38869bf66a61cF6bDB996A6aE40D5853Fd43B526`
+-   `MultiSendCallOnly` at `0x9641d764fc13c8B624c04430C7356C1C7C8102e2`
+-   `CreateCall` at `0x9b35Af71d77eaf8d7e40252370304687390A1A52`
+-   `SignMessageLib` at `0x58FCe385Ed16beB4BCE49c8DF34c7d6975807520`
+
+### Storage reader contracts
+
+-   `SimulateTxAccessor` at `0x3d4BA2E0884aa488718476ca2FB8Efc291A46199`
+
+## Changes
+
+### General
+
+#### Drop "Gnosis" from contract names
+
+Removed the "Gnosis" prefix from all contract names.
+
+### Core contract
+
+File: [`contracts/SafeL2.sol`](https://github.com/safe-global/safe-contracts/blob/3c3fc80f7f9aef1d39aaae2b53db5f4490051b0d/contracts/SafeL2.sol)
+
+#### Remove usage of the `GAS` opcode in module execute flows
+
+Issue: [#459](https://github.com/safe-global/safe-contracts/issues/459)
+
+The following rule of usage of the `GAS` opcode in the ERC-4337 standard made it impossible to build a module to support ERC4337:
+
+> -   Must not use GAS opcode (unless followed immediately by one of { CALL, DELEGATECALL, CALLCODE, STATICCALL }.)
+
+We removed the `GAS` opcode usage in module transactions to forward all the available gas instead.
+
+#### Require the `to` address to be a contract in `setupModules`
+
+Issue: [#483](https://github.com/safe-global/safe-contracts/issues/483)
+
+The `setupModules` method was changed to require the `to` address to be a contract. If the `to` address is not a contract, the transaction will revert with a `GS002` error code.
+
+#### Enforce the `dataHash` is equal to `data` in the signature verification process for contract signatures
+
+Issue: [#497](https://github.com/safe-global/safe-contracts/issues/497)
+
+To prevent unexpected behaviour, the `dataHash` must now equal a hash of the `data` in the signature verification process for contract signatures. Otherwise, the transaction will revert with a `GS027` error code.
+
+#### Fix `getModulesPaginated` to return a correct `next` pointer
+
+Issue: [#461](https://github.com/safe-global/safe-contracts/issues/461)
+
+The `getModulesPaginated` method was fixed to return a correct `next` pointer. The `next` pointer now equals the last module in the returned array.
+
+#### Check the EIP-165 signature of the Guard before adding
+
+Issue: [#309](https://github.com/safe-global/safe-contracts/issues/309)
+
+When setting a guard, the core contract will check that the target address supports the Guard interface with an EIP-165 check. If it doesn't, the transaction will revert with the `GS300` error code.
+
+#### Index essential parameters when emitting events
+
+Issue: [#541](https://github.com/safe-global/safe-contracts/issues/541)
+
+Index essential parameters in the essential events, such as:
+
+-   Owner additions and removals (Indexed parameter - owner address)
+-   Fallback manager changes (Indexed parameter - fallback manager address)
+-   Module additions and removals (Indexed parameter - module address)
+-   Transaction guard changes (Indexed parameter - guard address)
+-   Transaction execution/failure (Indexed parameter - transaction hash)
+
+### Factory
+
+Umbrella issue: [#462](https://github.com/safe-global/safe-contracts/issues/462)
+
+#### Remove the `createProxy` method
+
+This method uses the `CREATE` opcode, which is not counterfactual for a specific deployment. This caused user errors and lost/stuck funds and is now removed.
+
+#### Add a check that Singleton exists for the initializer call
+
+If the initializer data is provided, the Factory now checks that the Singleton contract exists and the success of the call to avoid a proxy being deployed uninitialized
+
+#### Add `createNetworkSpecificProxy`
+
+This method will use the chain id in the `CREATE2` salt; therefore, deploying a proxy to the same address on other networks is impossible.
+This method should enable the creation of proxies that should exist only on one network (e.g. specific governance or admin accounts)
+
+#### Remove the `calculateProxyAddress` method
+
+Method uses the revert approach to return data that only works well with some nodes, as they all return messages differently. Hence, we removed it, and the off-chain CREATE2 calculation is still possible.
+
+#### Remove the `proxyRuntimeCode` method
+
+The `.runtimeCode` method is not supported by the ZkSync compiler, so we removed it.
+
+### Fallback handlers
+
+Files:
+
+-   [CompatibilityFallbackHandler.sol](https://github.com/safe-global/safe-contracts/blob/3c3fc80f7f9aef1d39aaae2b53db5f4490051b0d/contracts/handler/CompatibilityFallbackHandler.sol)
+-   [TokenCallbackHandler](https://github.com/safe-global/safe-contracts/blob/3c3fc80f7f9aef1d39aaae2b53db5f4490051b0d/contracts/handler/TokenCallbackHandler.sol)
+
+#### Rename `DefaultCallbackHandler` to `TokenCallbackHandler`
+
+Since the `DefaultCallbackHandler` only handled token callbacks, it was renamed to `TokenCallbackHandler`.
+
+#### Remove `NAME` and `VERSION` constants
+
+The `NAME` and `VERSION` constants were removed from the `CompatibilityFallbackHandler` contract.
+
+#### Fix function signature mismatch for `isValidSignature`
+
+Issue: [#440](https://github.com/safe-global/safe-contracts/issues/440)
+
+Fixed mismatch between the function signature in the `isValidSignature` method and the `ISignatureValidator` interface.
+
+### Libraries
+
+#### CreateCall
+
+File: [`contracts/libraries/CreateCall.sol`](https://github.com/safe-global/safe-contracts/blob/3c3fc80f7f9aef1d39aaae2b53db5f4490051b0d/contracts/libraries/CreateCall.sol)
+
+#### Index the created contract address in the `ContractCreation` event
+
+Issue: [#541](https://github.com/safe-global/safe-contracts/issues/541)
+
+The deployed contract address in the `ContractCreation` event is now indexed.
+
+### Deployment process
+
+#### Use the Safe Singleton Factory for all deployments
+
+Issue: [#460](https://github.com/safe-global/safe-contracts/issues/460)
+
+Deployments with the [Safe Singleton Factory](https://github.com/safe-global/safe-singleton-factory) are now the default deployment process to ensure the same addresses on all chains.
+
 # Version 1.3.0-libs.0
 
 ## Compiler settings
diff --git a/README.md b/README.md
@@ -92,6 +92,7 @@ Documentation
 
 Audits/ Formal Verification
 ---------
+- [for Version 1.4.0 by Ackee Blockchain](docs/audit_1_4_0.md)
 - [for Version 1.3.0 by G0 Group](docs/audit_1_3_0.md)
 - [for Version 1.2.0 by G0 Group](docs/audit_1_2_0.md)
 - [for Version 1.1.1 by G0 Group](docs/audit_1_1_1.md)
diff --git a/contracts/handler/CompatibilityFallbackHandler.sol b/contracts/handler/CompatibilityFallbackHandler.sol
@@ -23,7 +23,7 @@ contract CompatibilityFallbackHandler is TokenCallbackHandler, ISignatureValidat
      * @dev Implementation of ISignatureValidator (see `interfaces/ISignatureValidator.sol`)
      * @param _data Arbitrary length data signed on the behalf of address(msg.sender).
      * @param _signature Signature byte array associated with _data.
-     * @return a bool upon valid or invalid signature with corresponding _data.
+     * @return The EIP-1271 magic value.
      */
     function isValidSignature(bytes memory _data, bytes memory _signature) public view override returns (bytes4) {
         // Caller should be a Safe
diff --git a/contracts/handler/TokenCallbackHandler.sol b/contracts/handler/TokenCallbackHandler.sol
@@ -11,9 +11,6 @@ import "../interfaces/IERC165.sol";
  * @author Richard Meissner - @rmeissner
  */
 contract TokenCallbackHandler is ERC1155TokenReceiver, ERC777TokensRecipient, ERC721TokenReceiver, IERC165 {
-    string public constant NAME = "Default Callback Handler";
-    string public constant VERSION = "1.0.0";
-
     /**
      * @notice Handles ERC1155 Token callback.
      * return Standardized onERC1155Received return value.
diff --git a/docs/Safe_Audit_Report_1_4_0.pdf b/docs/Safe_Audit_Report_1_4_0.pdf
diff --git a/docs/audit_1_4_0.md b/docs/audit_1_4_0.md
@@ -0,0 +1,17 @@
+### Audit Results
+
+##### Auditor
+
+-   Ackee Blockchain (https://ackeeblockchain.com/)
+
+##### Notes
+
+The final audit was performed on commit [eb93dbb0f62e2dc1b308ac4c110038062df0a8c9](https://github.com/safe-global/safe-contracts/tree/eb93dbb0f62e2dc1b308ac4c110038062df0a8c9).
+
+##### Files
+
+-   [Final Audit Report 1.4.0](Safe_Audit_Report_1_4_0.pdf)
+
+##### External links for Audit Reports
+
+-   Ackee Blockchain is working on a hosted repository for the audit reports. We will provide the link here as soon as it is available.
diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -38,11 +38,12 @@ import "./src/tasks/local_verify";
 import "./src/tasks/deploy_contracts";
 import "./src/tasks/show_codesize";
 import { BigNumber } from "@ethersproject/bignumber";
+import { DeterministicDeploymentInfo } from "hardhat-deploy/dist/types";
 
 const primarySolidityVersion = SOLIDITY_VERSION || "0.7.6";
 const soliditySettings = !!SOLIDITY_SETTINGS ? JSON.parse(SOLIDITY_SETTINGS) : undefined;
 
-const deterministicDeployment = (network: string) => {
+const deterministicDeployment = (network: string): DeterministicDeploymentInfo => {
     const info = getSingletonFactoryInfo(parseInt(network));
     if (!info) {
         throw new Error(`
@@ -78,9 +79,9 @@ const userConfig: HardhatUserConfig = {
             ...sharedNetworkConfig,
             url: `https://mainnet.infura.io/v3/${INFURA_KEY}`,
         },
-        xdai: {
+        gnosis: {
             ...sharedNetworkConfig,
-            url: "https://xdai.poanetwork.dev",
+            url: "https://rpc.gnosischain.com",
         },
         ewc: {
             ...sharedNetworkConfig,
diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
     "name": "@safe-global/safe-contracts",
-    "version": "1.3.0",
+    "version": "1.4.0",
     "description": "Ethereum multisig contract",
     "homepage": "https://github.com/safe-global/safe-contracts/",
-    "license": "GPL-3.0",
+    "license": "LGPL-3.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "files": [
@@ -48,7 +48,7 @@
         "@gnosis.pm/mock-contract": "^4.0.0",
         "@gnosis.pm/safe-singleton-factory": "^1.0.3",
         "@nomiclabs/hardhat-ethers": "2.0.2",
-        "@nomiclabs/hardhat-etherscan": "^2.1.0",
+        "@nomiclabs/hardhat-etherscan": "^3.1.7",
         "@nomiclabs/hardhat-waffle": "2.0.1",
         "@openzeppelin/contracts": "^3.4.0",
         "@types/chai": "^4.2.14",
@@ -68,7 +68,7 @@
         "ethereum-waffle": "^3.3.0",
         "ethers": "5.4.0",
         "hardhat": "^2.2.1",
-        "hardhat-deploy": "0.9.2",
+        "hardhat-deploy": "0.11.26",
         "husky": "^5.1.3",
         "prettier": "^2.8.4",
         "prettier-plugin-solidity": "1.1.2",
diff --git a/yarn.lock b/yarn.lock
