Welcome to the world of Paymasters!! 🎉 🌍 🎉
⚠️ Work in Progress: Please note that none of the contracts in this repository have been fully audited or extensively tested. These contracts are examples and, therefore, are not designed for production use.
This repository houses a variety of example Paymaster Contracts demonstrating different use cases. Plus, a user-friendly, configurable frontend to interact with these examples, developed using React and Next.js.
The repository is divided into two main sections:
-
/contracts: This directory contains the smart contracts, where each sub-directory represents a unique Paymaster use case. -
/frontend: This directory hosts the frontend developed using React and Next.js. The frontend allows you to interact with the various Paymaster contracts provided.
Here are some useful commands to get started:
yarn compile:contracts: Compiles the contracts.yarn deploy:contracts: This command deploys contracts. Scripts for deployment can be found in the/contracts/deploydirectory.yarn test:contracts: Runs contract tests. Please ensure to check the test requirements in /contracts directory.yarn serve:ui: Serves up frontend onlocalhost:3000yarn format: Runs prettier formatter.
Do you want to see a specific type of Paymaster contract included in this repository? Head over to the zkync-developers/discussions and tell us about it! We highly value your feedback and are always open to new ideas for showcasing different use-cases and techniques.
We welcome all contributors! If you're interested in contributing to this project, please review the CONTRIBUTING guide but for a quick summary:
- Fork the repository
- Create a new branch for your changes
- Implement your changes and commit them
- Push your changes to your fork
- Submit a pull request to the main repository
Your contribution will be reviewed and, if it's beneficial to the project, merged into the main branch. Thank you for your interest in our project!