zodiaceco/zodiac-mod-starter-kit(opens in a new tab)
Language: TypeScript
Out of the box starting point for building Zodiac modules
- stars
- 7
- watchers
- 3
- forks
- 4
- open issues
- 1
- Last updated
- 08/31/2024
Language: TypeScript
Out of the box starting point for building Zodiac modules
A starter kit for creating Zodiac Modules and Modifiers.
The repo contains a sample based on the "Zodiac: build your own module" tutorial found here.
This starter kit is set up to be used with Hardhat. A starter kit using Foundry is available here.
To see available commands run yarn hardhat.
Some helpful commands:
yarn install # install dependencies
yarn build # compiles contracts
yarn test # runs the tests
yarn deploy # deploys the contracts add the `--network` param to select a network
This project is set up for deployment via the Mastercopy / Minimal Proxy pattern (using our ModuleProxyFactory).
yarn deploy
This will set up a minimal sample Zodiac Module in the following steps:
contracts/MyModule.sol).This deployment uses the Singleton Factory contract (EIP-2470). See a list of supported networks here. For adding support to other chains, check out the documentation here and here.
Once you have created a module and want to add it to a Gnosis Safe:
It will then show up under Modules and Modifiers in the Gnosis Safe's Zodiac app.