Skip to content

Commit

Permalink
chore: documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
cbrzn committed Aug 9, 2021
1 parent 9765d61 commit f8ec8f4
Show file tree
Hide file tree
Showing 3 changed files with 276 additions and 64 deletions.
10 changes: 8 additions & 2 deletions docs/setup_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,16 @@ The first step is to deploy the module. Every Safe will have their own module. T

### Deploying the module


Hardhat tasks can be used to deploy a delay-module instance. There are two different tasks to deploy the module, the first one is through a normal deployment and passing arguments to the constructor (with the task `setup`), or, deploy the Module through a [Minimal Proxy Factory](https://eips.ethereum.org/EIPS/eip-1167) and save on gas costs (with the task `factorySetup`) - In rinkeby the address of the Proxy Factory is: `0x569F2e024D0aD6bBfBd8135097DFa7D0641Ae79b` and the Master Copy of the Delay Module: `0xAe78DF7a4184917dA49f7fCA6139f924A79D0488`.

These setup tasks requires the following parameters: `dao` (the address of the Safe). There are also optional parameters (cooldown and expiration, by default they are set to 24 hours and 7 days, respectively), for more information run `yarn hardhat setup --help` or `yarn hardhat factorySetup --help`.
These setup tasks requires the following parameters:

- `executor` - the address of the executor.
- `owner` - the address of the owner
- `cooldown` - optional, by default is set to 24 hours
- `expiration` - optional, by default is set to 7 days

For more information run `yarn hardhat setup --help` or `yarn hardhat factorySetup --help`.

An example for this on Rinkeby would be:
`yarn hardhat --network rinkeby setup --owner <owner_address> --executor <executor_address>`
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"eslint-plugin-no-only-tests": "2.4.0",
"eslint-plugin-prettier": "3.1.4",
"ethereum-waffle": "3.2.0",
"hardhat": "2.0.8",
"hardhat": "2.6.0",
"hardhat-deploy": "0.7.0-beta.38",
"husky": "5.1.3",
"prettier": "2.1.2",
Expand All @@ -55,7 +55,7 @@
"@gnosis.pm/mock-contract": "^4.0.0",
"argv": "^0.0.2",
"dotenv": "^8.0.0",
"ethers": "^5.0.19",
"ethers": "5.4.4",
"solc": "0.8.1",
"yargs": "^16.1.1"
},
Expand Down
Loading

0 comments on commit f8ec8f4

Please sign in to comment.