ZRC (Zilliqa Reference Contracts)
Contract standards for the Zilliqa platform
The Zilliqa Reference Contracts (ZRCs) are the contract standards for the Zilliqa platform.
| ZRC | Title |
|---|---|
| ZRC-7 | NFT Metadata Standard |
| ZRC-6 | Non-Fungible Token Standard |
| ZRC-5 | Convention for Deposit of ZIL |
| ZRC-4 | Standard for Multisig Wallet |
| ZRC-3 | Standard for Metatransactions |
| ZRC-2 | Standard for Fungible Tokens |
| ZRC-1 | Standard for Non Fungible Tokens (deprecated) |
Contributing
- Review ZRC-0.
- Fork the repository by clicking "Fork" in the top right.
- Add your ZRC to your fork of the repository. There is a template ZRC here.
- Submit a Pull Request to Zilliqa's ZRC repository.
Your first PR should be a first draft of the final ZRC. An editor will manually review the first PR for a new ZRC and assign it a number before merging it. Make sure you include a discussions-to header with the URL to a discussion forum or open GitHub issue where people can discuss the ZRC as a whole.
If your ZRC requires images, the image files should be included in a subdirectory of the assets folder for that ZRC as follow: assets/zrc-X (for zrc X). When linking to an image in the ZRC, use relative links such as ../assets/zrc-X/image.png.
When you believe your ZRC is ready to progress past the 'Draft' phase, you should go to our Zilliqa Official Discord server and ask to have your issue added to the next community dev call where it can be discussed for inclusion in a future platform upgrade. If the community agrees to include it, the ZRC editors will update the state of your ZRC to 'Approved'.
ZRC Status
- Draft - a preliminary version of the ZRC that is not yet ready for submission.
- Ready - a preliminary version of the ZRC that is ready for review by a wide audience.
- Approved - a finalized version of the ZRC that has been in the 'Ready' state for at least 2 weeks and any technical changes that were requested have been addressed by the author.
- Implemented - a finalized version of the ZRC that the Core Devs have decided to implement and release.
Contract Testing
npm test
Runs contract tests using Isolated Server container, Jest, and Scilla JSON Utils
License
This project is open source software licensed as MIT.