Merge pull request #218 from gnosis/prepare_deployment

Deployment of 1.2.0

Author: rmeissner

.env.sample

@@ -1,3 +1,2 @@
 MNEMONIC=""
-INFURA_TOKEN=""
-NETWORK="rinkeby"
+INFURA_TOKEN=""

.gitignore

@@ -5,3 +5,5 @@ node_modules/
 .openzeppelin/.session
 env/
 .env
+bin/
+solc

README.md

@@ -32,73 +32,33 @@ Preparation:
 - Set `NETWORK` in `.env`
 - Run `yarn truffle compile`
 
-OpenZeppelin SDK:
-- Make sure that @openzeppelin/cli is version 2.5 (`yarn oz --version`)
-- Make sure that all dependencies use solcjs >0.5.0
-- Set correct version in `package.json`
-- Set `MNEMONIC` in `.env` to current oz package owner (last deployer normally)
-- Optional: if a new deployer account is used
-  - Check that a gloabl versionb of truffle 5 is installed (`truffle version`)
-  - Run `truffle exec scripts/change_oz_owner.js --network=<network> --newOwner="<address>"` to enable new deployer
-  - Set `MNEMONIC` in `.env` to new oz package owner
-- Run `yarn deploy-oz`
-- Once deployed on all networks run `yarn oz --freeze <network>` for each network
-
 Truffle:
 - Set `MNEMONIC` in `.env`
 
 ```bash
 yarn truffle deploy
 ```
 
-Verify Contracts:
-- requires installed solc (>0.5.0)
-```bash
-virtualenv env -p python3
-. env/bin/activate
-pip install solidity-flattener
-mkdir build/flattened_contracts
-solidity_flattener contracts/GnosisSafe.sol --output build/flattened_contracts/GnosisSafe.sol
-solidity_flattener contracts/libraries/CreateAndAddModules.sol --output build/flattened_contracts/CreateAndAddModules.sol --solc-paths="/=/"
-solidity_flattener contracts/libraries/CreateCall.sol --output build/flattened_contracts/CreateCall.sol --solc-paths="/=/"
-solidity_flattener contracts/libraries/MultiSend.sol --output build/flattened_contracts/MultiSend.sol --solc-paths="/=/"
-solidity_flattener contracts/handler/DefaultCallbackHandler.sol --output build/flattened_contracts/DefaultCallbackHandler.sol --solc-paths="/=/"
-solidity_flattener contracts/modules/DailyLimitModule.sol --output build/flattened_contracts/DailyLimitModule.sol --solc-paths="/=/"
-solidity_flattener contracts/modules/SocialRecoveryModule.sol --output build/flattened_contracts/SocialRecoveryModule.sol --solc-paths="/=/"
-solidity_flattener contracts/modules/StateChannelModule.sol --output build/flattened_contracts/StateChannelModule.sol --solc-paths="/=/"
-solidity_flattener contracts/modules/WhitelistModule.sol --output build/flattened_contracts/WhitelistModule.sol --solc-paths="/=/"
-solidity_flattener contracts/proxies/GnosisSafeProxyFactory.sol --output build/flattened_contracts/GnosisSafeProxyFactory.sol
-find build/flattened_contracts -name '*.sol' -exec sed -i '' 's/pragma solidity ^0.4.13;/pragma solidity >=0.5.0 <0.7.0;/g' {} \;
-```
-
-Using with OpenZeppelin SDK
----------------------------
+### Verify contract
 
-You can create a gnosis safe upgradeable instance using [OpenZeppelin SDK](https://docs.openzeppelin.com/sdk/2.5) by linking to the provided [EVM package](https://docs.openzeppelin.com/sdk/2.5/linking). This will use the master copy already deployed to mainnet, kovan, or rinkeby, reducing gas deployment costs.
+Note: To completely replicate the bytecode that has been deployed it is required that the project path is `/gnosis-safe` this can be archived using `sudo mkdir /gnosis-safe && sudo mount -B <your_repo_path> /gnosis-safe`. Make sure the run `yarn` again if the path has been changed after the inital `yarn install`. If you use a different path you will only get partial matches.
 
-To create an instance using OpenZeppelin SDK:
+You can locally verify contract using the scripts `generate_meta.js` and `verify_deployment.js`.
 
-```bash
-$ yarn global add -g @openzeppelin/sdk
-$ oz init YourProject
-$ oz link @gnosis.pm/safe-contracts
-$ oz push --network rinkeby
-> Connecting to dependency @gnosis.pm/safe-contracts 1.0.0
-$ oz create @gnosis.pm//GnosisSafe --init setup --args "[$ADDRESS1,$ADDRESS2,$ADDRESS3],2,0x0000000000000000000000000000000000000000,\"\"" --network rinkeby --from $SENDER
-> Instance created at SAFE_ADDRESS
-```
+With `node scripts/generate_meta.js` a `meta` folder is created in the `build` folder that contains all files required to verify the source code on https://verification.komputing.org/ and https://etherscan.io/
 
-It is suggested to [use a non-default address](https://docs.zeppelinos.org/docs/pattern.html#transparent-proxies-and-function-clashes) as `$SENDER`.
+For Etherscan only the `GnosisSafeEtherscan.json` file is required. For sourcify the `GnosisSafeMeta.json` and all the `.sol` files are required.
 
-> Note: When using the contracts via ZeppelinOS make sure to choose an appropriate Proxy admin. An upgradable proxy enables the user to update the master copy (aka implementation). The default upgradable proxy is managed by an admin address. This admin address is independent from the owners of the Safe. Therefore it would be possible for the admin to change the master copy without the approval of any owner, thus allowing him to gain full access to the Safe.
+Once the meta data has been generated you can verify that your local compiled code corresponds to the version deployed by Gnosis with `yarn do <network> scripts/verify_deployment.js`.
 
 Documentation
 -------------
-- [ReadTheDocs](http://gnosis-safe.readthedocs.io/en/latest/)
-- [Coding guidlines](docs/guidelines.md)
+- [Safe developer portal](http://docs.gnosis.io/safe)
+- [Coding guidelines](docs/guidelines.md)
 
 Audits/ Formal Verification
 ---------
+- [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)
 - [for Version 1.0.0 by Runtime Verification](docs/rv_1_0_0.md)
 - [for Version 0.0.1 by Alexey Akhunov](docs/alexey_audit.md)

contracts/GnosisSafe.sol

@@ -18,7 +18,7 @@ contract GnosisSafe
     using GnosisSafeMath for uint256;
 
     string public constant NAME = "Gnosis Safe";
-    string public constant VERSION = "1.1.1";
+    string public constant VERSION = "1.2.0";
 
     //keccak256(
     //    "EIP712Domain(address verifyingContract)"
@@ -300,7 +300,8 @@ contract GnosisSafe
     }
 
     /**
-    * @dev Marks a message as signed
+    * @dev Marks a message as signed, so that it can be used with EIP-1271
+    * @notice Marks a message (`_data`) as signed.
     * @param _data Arbitrary length data that should be marked as signed on the behalf of address(this)
     */
     function signMessage(bytes calldata _data)

contracts/base/ModuleManager.sol

@@ -31,6 +31,7 @@ contract ModuleManager is SelfAuthorized, Executor {
 
     /// @dev Allows to add a module to the whitelist.
     ///      This can only be done via a Safe transaction.
+    /// @notice Enables the module `module` for the Safe.
     /// @param module Module to be whitelisted.
     function enableModule(Module module)
         public
@@ -47,6 +48,7 @@ contract ModuleManager is SelfAuthorized, Executor {
 
     /// @dev Allows to remove a module from the whitelist.
     ///      This can only be done via a Safe transaction.
+    /// @notice Disables the module `module` for the Safe.
     /// @param prevModule Module that pointed to the module to be removed in the linked list
     /// @param module Module to be removed.
     function disableModule(Module prevModule, Module module)

contracts/base/OwnerManager.sol

@@ -47,6 +47,7 @@ contract OwnerManager is SelfAuthorized {
 
     /// @dev Allows to add a new owner to the Safe and update the threshold at the same time.
     ///      This can only be done via a Safe transaction.
+    /// @notice Adds the owner `owner` to the Safe and updates the threshold to `_threshold`.
     /// @param owner New owner address.
     /// @param _threshold New threshold.
     function addOwnerWithThreshold(address owner, uint256 _threshold)
@@ -68,6 +69,7 @@ contract OwnerManager is SelfAuthorized {
 
     /// @dev Allows to remove an owner from the Safe and update the threshold at the same time.
     ///      This can only be done via a Safe transaction.
+    /// @notice Removes the owner `owner` from the Safe and updates the threshold to `_threshold`.
     /// @param prevOwner Owner that pointed to the owner to be removed in the linked list
     /// @param owner Owner address to be removed.
     /// @param _threshold New threshold.
@@ -91,6 +93,7 @@ contract OwnerManager is SelfAuthorized {
 
     /// @dev Allows to swap/replace an owner from the Safe with another address.
     ///      This can only be done via a Safe transaction.
+    /// @notice Replaces the owner `oldOwner` in the Safe with `newOwner`.
     /// @param prevOwner Owner that pointed to the owner to be replaced in the linked list
     /// @param oldOwner Owner address to be replaced.
     /// @param newOwner New owner address.
@@ -114,6 +117,7 @@ contract OwnerManager is SelfAuthorized {
 
     /// @dev Allows to update the number of required confirmations by Safe owners.
     ///      This can only be done via a Safe transaction.
+    /// @notice Changes the threshold of the Safe to `_threshold`.
     /// @param _threshold New threshold.
     function changeThreshold(uint256 _threshold)
         public

docs/Gnosis_Safe_Audit_Report_1_2_0.pdf

@@ -0,0 +1,12 @@
+### Audit Results
+
+##### Auditor
+* G0 Group (https://github.com/g0-group)
+  * Adam Kolář (@adamkolar)
+  * Nick Munoz-McDonald (@NickErrant)
+
+##### Notes
+The audit was performed on commit [62d4bd39925db65083b035115d6987772b2d2dca](https://github.com/gnosis/safe-contracts/commit/62d4bd39925db65083b035115d6987772b2d2dca)
+
+##### Files
+* [Audit Report 1.2.0](Gnosis_Safe_Audit_Report_1_2_0.pdf)

docs/audit_1_2_0.md

@@ -0,0 +1,7 @@
+var GnosisSafe = artifacts.require("./GnosisSafe.sol");
+
+module.exports = function(deployer) {
+    deployer.deploy(GnosisSafe).then(function (safe) {
+        return safe
+    });
+};