2019-08-24 05:56:44 -07:00
|
|
|
|
.. Title: Specifications and Zcash Improvement Proposals
|
|
|
|
|
|
|
2020-05-30 08:48:36 -07:00
|
|
|
|
|
|
|
|
|
|
What are ZIPs?
|
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
|
|
Zcash Improvement Proposals (ZIPs) are the way to:
|
|
|
|
|
|
|
2022-02-16 13:07:06 -08:00
|
|
|
|
* propose new features for the `Zcash cryptocurrency <https://z.cash/>`__ and their rationale,
|
2020-05-30 08:48:36 -07:00
|
|
|
|
* specify the implementation details of the feature,
|
|
|
|
|
|
* collect community input on the proposal, and
|
|
|
|
|
|
* document design decisions.
|
2019-08-24 05:56:44 -07:00
|
|
|
|
|
2020-03-10 06:06:13 -07:00
|
|
|
|
|
|
|
|
|
|
Contributing
|
|
|
|
|
|
------------
|
|
|
|
|
|
|
2020-05-30 08:48:36 -07:00
|
|
|
|
The authors of a ZIP are responsible for building consensus within the community
|
|
|
|
|
|
and documenting / addressing dissenting opinions.
|
|
|
|
|
|
|
|
|
|
|
|
Anyone can write a ZIP! We encourage community contributions and decentralization
|
|
|
|
|
|
of work on the Zcash protocol. If you’d like to bounce ideas off people before formally
|
2020-10-26 12:07:47 -07:00
|
|
|
|
writing a ZIP, we encourage it! Visit the `ZcashCommunity Discord chat <https://discord.gg/kdjfvps>`__
|
|
|
|
|
|
to talk about your idea.
|
2020-05-30 08:48:36 -07:00
|
|
|
|
|
2019-08-24 05:56:44 -07:00
|
|
|
|
Participation in the Zcash project is subject to a `Code of
|
|
|
|
|
|
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
|
|
|
|
|
|
|
2020-02-07 03:07:13 -08:00
|
|
|
|
The Zcash protocol is documented in its `Protocol Specification <protocol/protocol.pdf>`__.
|
|
|
|
|
|
|
2020-03-10 06:06:13 -07:00
|
|
|
|
To start contributing, first read `ZIP 0 <zip-0000.rst>`__ which documents the ZIP process.
|
|
|
|
|
|
Then clone `this repo <https://github.com/zcash/zips>`__ from GitHub, and start adding
|
2020-05-30 08:48:36 -07:00
|
|
|
|
your draft ZIP, formatted either as reStructuredText or as Markdown.
|
|
|
|
|
|
|
|
|
|
|
|
For example, if using reStructuredText, use a filename matching ``draft-*.rst``.
|
|
|
|
|
|
Use ``make`` to check that you are using correct
|
|
|
|
|
|
`reStructuredText <https://docutils.sourceforge.io/rst.html>`__ or
|
|
|
|
|
|
`Markdown <https://pandoc.org/MANUAL.html#pandocs-markdown>`__ syntax,
|
2020-03-10 06:06:13 -07:00
|
|
|
|
and double-check the generated ``draft-*.html`` file before filing a Pull Request.
|
2023-10-18 09:35:01 -07:00
|
|
|
|
See `here <protocol/README.rst>`__ for the project dependencies.
|
2019-11-16 09:34:32 -08:00
|
|
|
|
|
2023-09-05 07:14:57 -07:00
|
|
|
|
Consider leveraging `our devcontainer.json <devcontainer.rst>`__ for ease of tool aquisition
|
|
|
|
|
|
when working in this repo.
|
|
|
|
|
|
|
2021-04-23 15:10:23 -07:00
|
|
|
|
NU5 ZIPs
|
|
|
|
|
|
--------
|
|
|
|
|
|
|
2022-06-06 07:28:34 -07:00
|
|
|
|
This is the list of ZIPs relevant to the NU5 Upgrade, which `activated on 31st May 2022 <https://z.cash/upgrade/nu5/>`__:
|
2021-04-23 15:10:23 -07:00
|
|
|
|
|
|
|
|
|
|
- `ZIP 32: Shielded Hierarchical Deterministic Wallets <zip-0032.rst>`__ (updated)
|
2021-06-26 09:20:16 -07:00
|
|
|
|
- `ZIP 203: Transaction Expiry <zip-0203.rst>`__ (updated)
|
2021-06-15 08:43:40 -07:00
|
|
|
|
- `ZIP 209: Prohibit Negative Shielded Chain Value Pool Balances <zip-0209.rst>`__ (updated)
|
2021-06-22 07:52:10 -07:00
|
|
|
|
- `ZIP 212: Allow Recipient to Derive Ephemeral Secret from Note Plaintext <zip-0212.rst>`__ (updated)
|
|
|
|
|
|
- `ZIP 213: Shielded Coinbase <zip-0213.rst>`__ (updated)
|
2021-04-23 15:10:23 -07:00
|
|
|
|
- `ZIP 216: Require Canonical Jubjub Point Encodings <zip-0216.rst>`__
|
|
|
|
|
|
- `ZIP 221: FlyClient - Consensus-Layer Changes <zip-0221.rst>`__ (updated)
|
|
|
|
|
|
- `ZIP 224: Orchard Shielded Protocol <zip-0224.rst>`__
|
|
|
|
|
|
- `ZIP 225: Version 5 Transaction Format <zip-0225.rst>`__
|
2021-05-29 09:50:53 -07:00
|
|
|
|
- `ZIP 239: Relay of Version 5 Transactions <zip-0239.rst>`__
|
2021-04-23 15:10:23 -07:00
|
|
|
|
- `ZIP 244: Transaction Identifier Non-Malleability <zip-0244.rst>`__
|
|
|
|
|
|
- `ZIP 252: Deployment of the NU5 Network Upgrade <zip-0252.rst>`__
|
2021-05-29 09:30:29 -07:00
|
|
|
|
- `ZIP 316: Unified Addresses and Unified Viewing Keys <zip-0316.rst>`__
|
2021-09-13 12:26:54 -07:00
|
|
|
|
- `ZIP 401: Addressing Mempool Denial-of-Service <zip-0401.rst>`__ (clarified)
|
2020-01-07 11:21:02 -08:00
|
|
|
|
|
2019-08-24 05:56:44 -07:00
|
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
|
|
Unless otherwise stated in this repository’s individual files, the
|
|
|
|
|
|
contents of this repository are released under the terms of the MIT
|
2020-05-30 08:48:36 -07:00
|
|
|
|
license. See `COPYING <COPYING.rst>`__ for more information or see
|
2019-08-24 05:56:44 -07:00
|
|
|
|
https://opensource.org/licenses/MIT .
|
