Skip to content

Commit

Permalink
chore: documentation updated with new params
Browse files Browse the repository at this point in the history
  • Loading branch information
cbrzn committed Aug 7, 2021
1 parent 8e4d5ab commit ed3d91e
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 15
node-version: 14
- uses: actions/cache@v2
with:
path: '**/node_modules'
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v15.6.0
v14.17.4
10 changes: 5 additions & 5 deletions docs/setup_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,23 @@ 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 `factory-setup`) - In rinkeby the address of the Proxy Factory is: `0xd067410a85ffC8C55f7245DE4BfE16C95329D232` and the Master Copy of the Delay Module: `0x3cc7aBD1908906e2102D302249c82d083975e1EF`.
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 factory-setup --help`.
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`.

An example for this on Rinkeby would be:
`yarn hardhat --network rinkeby setup --dao <safe_address>`
`yarn hardhat --network rinkeby setup --owner <owner_address> --executor <executor_address>`

or

`yarn hardhat --network rinkeby factory-setup --factory <factory_address> --mastercopy <mastercopy_address> --dao <safe_address>`
`yarn hardhat --network rinkeby factorySetup --factory <factory_address> --mastercopy <mastercopy_address> --owner <owner_address> --executor <executor_address>`

This should return the address of the deployed delay-module. For this guide we assume this to be `0x4242424242424242424242424242424242424242`

Once the module is deployed you should verify the source code (Note: If you used the factory deployment the contract should be already verified). If you use a network that is Etherscan compatible and you configure the `ETHERSCAN_API_KEY` in your environment you can use the provided hardhat task to do this.

An example for this on Rinkeby would be:
`yarn hardhat --network rinkeby verifyEtherscan --module 0x4242424242424242424242424242424242424242 --dao <safe_address>`
`yarn hardhat --network rinkeby verifyEtherscan --module 0x4242424242424242424242424242424242424242 --owner <owner_address> --executor <executor_address>`

### Enabling the module

Expand Down
2 changes: 1 addition & 1 deletion src/tasks/setup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ task("setup", "Deploys a SafeDelay module")
console.log("Module deployed to:", module.address);
});

task("factory-setup", "Deploys a SafeDelay module through a proxy")
task("factorySetup", "Deploys a SafeDelay module through a proxy")
.addParam("factory", "Address of the Proxy Factory", undefined, types.string)
.addParam("mastercopy", "Address of the Delay Module Master Copy", undefined, types.string)
.addParam("owner", "Address of the owner", undefined, types.string)
Expand Down

0 comments on commit ed3d91e

Please sign in to comment.