@rhinestone/modulekit
v0.3.7
Published
ModuleKit is a development toolkit to build Smart Account Modules
Downloads
49
Maintainers
Readme
ModuleKit
A development kit for building and testing smart account modules.
ModuleKit allows you to:
- Easily build smart account modules with interfaces for:
- Validators
- Executors
- Hooks
- Unit test your modules using a dedicated helper library
- Integration test your modules using different modular ERC-4337 accounts and a helper library that abstracts away the complexity
In-depth documentation is available at docs.rhinestone.wtf.
The ModuleKit is in active development and is subject to breaking changes. If you spot a bug, please take out an issue and we will fix it as soon as we can.
Installation
Using our template
Use the module-template to create a new repo and install the dependencies:
pnpm install
Using git submodules
forge install rhinestonewtf/modulekit
Using a package manager
pnpm install @rhinestone/modulekit
Updating
To update the ModuleKit, run:
forge update rhinestonewtf/modulekit
or
pnpm update @rhinestone/modulekit
Usage
To learn more about using ModuleKit, visit the tools section of the docs. To get a better understanding of Modules generally, visit the modules section and for hands-on tutorials on the entire lifecycle of modules, visit the tutorials section.
Features
- [ ] ERC-4337 integration tests
- [x] On-chain integration test (EntryPoint -> Account)
- [ ] Off-chain integration test (Bundler simulation and spec validation)
- [ ] Unit testing library
- [x] Different Module types
- [x] Validators
- [x] Executors
- [x] Hooks
- [x] Different modular accounts
- [x] ERC-7579
- [x] Safe
- [x] Biconomy
- [x] Kernel
- [x] Deployment helper using Module Registry
- [x] Gas calculation helper
Examples
For module examples, check out our modulekit examples and for module inspiration see our module idea list. For general examples, check out the awesome modular accounts repo.
Contributing
For feature or change requests, feel free to open a PR, start a discussion or get in touch with us.
For guidance on how to create PRs, see the CONTRIBUTING guide.
Using this repo
To install dependencies, run:
pnpm install
To build the project, run:
pnpm build
To run tests, run:
pnpm test -r
Credits
- Safe{Core} Protocol: ExecutorManager.sol is heavily insprired by Safe's SafeProtocolManager but is compatible across all supported accounts