Chukti 🚀

⚠️ Important Note: Chukti is a work in progress.
We are actively developing and improving the library. Some features may be incomplete or subject to change. We appreciate your understanding and welcome any feedback or contributions.

Chukti is a powerful library designed to simplify the process of testing smart contracts using Cucumber's human-readable Gherkin syntax. With Chukti, you can write end-to-end tests for your smart contracts in a language that everyone on your team can understand, from developers to non-technical stakeholders.

Features ✨

• Human-Readable Tests: Write tests in plain English using Gherkin syntax.
• Flexible Environment: The initialized project can be expanded with any other tool.
• Reusable Step Definitions: Predefined step definitions for common smart contract operations.
• Automated Setup: Quickly initialize new projects with a single command.
• Extensible: Easily add custom step definitions to suit your project's needs.

Documentation 📚

For comprehensive documentation, visit the Chukti Documentation.

Project Types

Chukti supports both Hardhat + Viem and Forge + Anvil project setups. You can choose the type of project you want to initialize during the setup process.

Contributing 🤝

We welcome contributions from the community! If you have any ideas or suggestions, please open an issue or a pull request. Please see the CONTRIBUTING.md file for detailed guidelines on how to contribute.

License 📜

Chukti is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

Special thanks to the developers and contributors of Viem, Forge, Anvil, Hardhat, and Cucumber for their amazing tools and libraries.

For more information, visit the Chukti Documentation.

Happy Testing! 🚀