Skip to content

Commit

Permalink
chore: add README instructions on how to export a multisig VIP to Gno…
Browse files Browse the repository at this point in the history
…sis Safe JSON format
  • Loading branch information
0xlucian committed Oct 2, 2023
1 parent 65d8eac commit 09af455
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,37 @@ Proceed by executing the following command:
npx hardhat run scripts/executeMultiSigTx.ts --network sepolia
```

After executing the commant, provide the proposal name to be executed and press enter:
After executing the command, provide the proposal name to be executed and press enter:

```
Name of tx file (from ./multisig/<network>/ dir) to execute =>
```

### Export Gnosis Safe tx JSON

Script to export a VIP in the form of a gnosis safe tx JSON format.

Before executing this script make sure that:

- The network you want to execute the multisig tx exist in `hardhat.config.ts` configuration
- The gnosis safe wallet address exists in `getSafeAddress` function in `multisig/helpers/utils.ts`.
- Make sure that the name of the network in `getSafeAddress` matches the network name in the `hardhat.config.ts` and also `chainID` for this network is correct.

Proceed by executing the following command:

```
npx hardhat run scripts/createProposal.ts --network <networkName>
```

After executing the command, enter the needed information for the script.
Here is example input for exporting an example (`multisig/proposals/sepolia/example.ts`) VIP into a JSON Gnosis Safe format:

```
npx hardhat run scripts/createProposal.ts --network sepolia
Number of the VIP to propose (if using gnosisTXBuilder press enter to skip ) =>
Type of the proposal txBuilder/venusApp/bsc/gnosisTXBuilder => gnosisTXBuilder
Address of the governance contract (optional, press enter to skip) =>
Name of tx file (from ./multisig/network(available)/ dir) to execute => example
```

The script should output a file `gnosisTXBuilder.json` that you can import in your Gnosis Safe UI.

0 comments on commit 09af455

Please sign in to comment.