Go to file
Daira Hopwood dbd7339c3f Cleanup: remove duplicate macro \CommitIvkRandom in favour of \CommitIvkRand.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2022-04-28 20:28:07 +01:00
.github Bump actions/checkout from 3.0.0 to 3.0.2 2022-04-27 17:03:59 -04:00
assets
css [Dark mode] Remove unimportant "!important" annotation in section anchor style. 2022-01-11 13:24:24 +00:00
historical
protocol Cleanup: remove duplicate macro \CommitIvkRandom in favour of \CommitIvkRand. 2022-04-28 20:28:07 +01:00
.gitignore Add GitHub Actions workflow that renders and commits spec pdfs (#579) 2022-02-09 16:34:55 -05:00
CNAME
COPYING.html
COPYING.rst
Dockerfile Update Dockerfile to use an updated package that should work in more recent Debian. 2021-09-07 15:16:17 +01:00
Makefile Update links_and_dests.py to support HTML files and rate limiting (part 2). 2021-09-09 14:58:42 +01:00
README.rst Fix typo in README.rst 2022-02-16 15:19:23 -05:00
README.template Fix typo in README.template (which generates README.rst and index.html). 2022-02-16 21:07:06 +00:00
_config.yml _config.yml: attempt to fix unreliable GitHub pages updates. 2021-03-07 19:51:37 +00:00
edithtml.sh [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
index.html Fix typo in README.template (which generates README.rst and index.html). 2022-02-16 21:07:06 +00:00
links_and_dests.py links_and_dests.py: fix false positive "Missing link target" errors for links into rendered BIPs. 2021-12-03 14:54:22 +00:00
makeindex.sh
render-via-docker.sh
zip-0000.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0000.rst Fix all links in ZIPs (and almost eliminate plain http links). 2021-09-09 15:02:46 +01:00
zip-0001.html Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0001.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0002.html
zip-0002.rst
zip-0022.html Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0032-orchard-internal-key-derivation.png ZIP 32: Simplify Orchard internal key derivation diagram. 2022-01-19 19:00:51 +00:00
zip-0032-orchard-internal-key-derivation.svg ZIP 32: Simplify Orchard internal key derivation diagram. 2022-01-19 19:00:51 +00:00
zip-0032-sapling-internal-key-derivation.png ZIP 32: add internal key derivation for Sapling and Orchard. 2022-01-19 19:00:51 +00:00
zip-0032-sapling-internal-key-derivation.svg ZIP 32: add internal key derivation for Sapling and Orchard. 2022-01-19 19:00:51 +00:00
zip-0032.html ZIP 32: Point out that Sapling and Orchard keys can be invalid. 2022-04-28 16:38:15 +01:00
zip-0032.rst ZIP 32: Point out that Sapling and Orchard keys can be invalid. 2022-04-28 16:38:15 +01:00
zip-0076.html
zip-0076.rst
zip-0143.html ZIPs 143 and 243: fix links to zcash-test-vectors code. 2022-01-29 22:27:56 +00:00
zip-0143.rst ZIPs 143 and 243: fix links to zcash-test-vectors code. 2022-01-29 22:27:56 +00:00
zip-0155.html ZIP 155: change peer protocol version for `addrv2` support to ${PLACEHOLDER}. 2022-03-25 16:49:30 +00:00
zip-0155.rst ZIP 155: change peer protocol version for `addrv2` support to ${PLACEHOLDER}. 2022-03-25 16:49:30 +00:00
zip-0173.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0173.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0200.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0200.rst Fix typo. closes #557 2021-09-13 15:09:53 +01:00
zip-0201.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0201.rst Update zip-0201.rst 2021-08-16 13:44:00 -06:00
zip-0202.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0202.rst ZIP 202: fix link. 2021-09-09 15:29:09 +01:00
zip-0203.html ZIP 203: Remove incorrect dependency between expiry heights and lock times. 2022-04-28 16:38:15 +01:00
zip-0203.rst ZIP 203: Remove incorrect dependency between expiry heights and lock times. 2022-04-28 16:38:15 +01:00
zip-0204.html Rename reserved ZIP 204. 2021-06-03 23:17:21 +01:00
zip-0204.rst Rename reserved ZIP 204. 2021-06-03 23:17:21 +01:00
zip-0205.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0205.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0206.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0206.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0207.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0207.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0208.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0208.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0209.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0209.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0210.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0210.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0211.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0211.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0212.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0212.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0213.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0213.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0214.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0214.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0215.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0215.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0216.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0216.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0217.html
zip-0217.rst
zip-0219.html Add reserved ZIPs 218 (User-Defined Assets and Wrapped Assets) and 219 (Disabling Addition of New Value to the Sapling Chain Value Pool). 2020-12-21 00:49:11 +00:00
zip-0219.rst Add reserved ZIPs 218 (User-Defined Assets and Wrapped Assets) and 219 (Disabling Addition of New Value to the Sapling Chain Value Pool). 2020-12-21 00:49:11 +00:00
zip-0220.html Renumber ZIP 218 stub to ZIP 220. 2021-05-05 21:44:00 +01:00
zip-0220.rst Renumber ZIP 218 stub to ZIP 220. 2021-05-05 21:44:00 +01:00
zip-0221.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0221.rst ZIP 221: fix broken links. 2021-10-02 01:06:21 +01:00
zip-0222.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0222.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0224.html ZIP 224: fix a broken link. 2022-01-29 21:02:24 +00:00
zip-0224.rst ZIP 224: fix a broken link. 2022-01-29 21:02:24 +00:00
zip-0225.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0225.rst ZIP 225: add links to zcashd and librustzcash PRs. 2021-10-02 00:46:17 +01:00
zip-0239.html ZIP 239: remove an inessential reference to the specific peer protocol version that signals NU5 support on Testnet. 2022-03-25 16:42:57 +00:00
zip-0239.rst ZIP 239: remove an inessential reference to the specific peer protocol version that signals NU5 support on Testnet. 2022-03-25 16:42:57 +00:00
zip-0243.html ZIPs 143 and 243: fix links to zcash-test-vectors code. 2022-01-29 22:27:56 +00:00
zip-0243.rst ZIPs 143 and 243: fix links to zcash-test-vectors code. 2022-01-29 22:27:56 +00:00
zip-0244.html ZIP 244: Fix ill-defined commitments for shielded coinbase 2022-01-24 22:46:41 +00:00
zip-0244.rst ZIP 244: Fix ill-defined commitments for shielded coinbase 2022-01-24 22:46:41 +00:00
zip-0245.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0245.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0250.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0250.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0251.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0251.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-0252.html ZIP 252: Use present tense to refer to zcashd v4.7.0 and say that it needs the `-rescan` option. 2022-04-15 12:15:59 +01:00
zip-0252.rst ZIP 252: Use present tense to refer to zcashd v4.7.0 and say that it needs the `-rescan` option. 2022-04-15 12:15:59 +01:00
zip-0300.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0300.rst
zip-0301.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0301.rst Fix all links in ZIPs (and almost eliminate plain http links). 2021-09-09 15:02:46 +01:00
zip-0302.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0302.rst Fix all links in ZIPs (and almost eliminate plain http links). 2021-09-09 15:02:46 +01:00
zip-0303.html Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0303.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0304.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0304.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0305.html
zip-0305.rst
zip-0306.html
zip-0306.rst
zip-0307-arch.png
zip-0307.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0307.rst ZIP 307: clarify that epk is needed 2021-08-25 19:29:49 -04:00
zip-0308.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0308.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0309.html Fix all links in ZIPs (and almost eliminate plain http links). 2021-09-09 15:02:46 +01:00
zip-0309.rst Fix all links in ZIPs (and almost eliminate plain http links). 2021-09-09 15:02:46 +01:00
zip-0310.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0310.rst
zip-0311.html Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0311.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0312.html Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0312.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-0313.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0313.rst Minor updates to ZIP titles. Also add a reference to ZIP 316 from ZIP 252. 2021-05-29 17:30:29 +01:00
zip-0314.html Add stubs for ZIP numbers 314, 315, 316, 322, and 323. 2021-04-07 10:12:11 +01:00
zip-0314.rst Add stubs for ZIP numbers 314, 315, 316, 322, and 323. 2021-04-07 10:12:11 +01:00
zip-0315.html Add stubs for ZIP numbers 314, 315, 316, 322, and 323. 2021-04-07 10:12:11 +01:00
zip-0315.rst Add stubs for ZIP numbers 314, 315, 316, 322, and 323. 2021-04-07 10:12:11 +01:00
zip-0316-f3.png ZIP 316: update Feistel diagrams to include border (needed for dark mode), and add source SVG files. 2021-12-31 16:24:58 +00:00
zip-0316-f3.svg ZIP 316: update Feistel diagrams to include border (needed for dark mode), and add source SVG files. 2021-12-31 16:24:58 +00:00
zip-0316-f4.png ZIP 316: update Feistel diagrams to include border (needed for dark mode), and add source SVG files. 2021-12-31 16:24:58 +00:00
zip-0316-f4.svg ZIP 316: update Feistel diagrams to include border (needed for dark mode), and add source SVG files. 2021-12-31 16:24:58 +00:00
zip-0316.html ZIP 316: make the limitation on total size of encodings more explicit. 2022-04-18 22:25:47 +01:00
zip-0316.rst ZIP 316: make the limitation on total size of encodings more explicit. 2022-04-18 22:25:47 +01:00
zip-0321.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0321.rst ZIP 321: make the "//" invalid example clearer by ensuring it is invalid for only that reason. 2021-05-04 15:14:15 +01:00
zip-0322.html Add stubs for ZIP numbers 314, 315, 316, 322, and 323. 2021-04-07 10:12:11 +01:00
zip-0322.rst Add stubs for ZIP numbers 314, 315, 316, 322, and 323. 2021-04-07 10:12:11 +01:00
zip-0323.html Add stubs for ZIP numbers 314, 315, 316, 322, and 323. 2021-04-07 10:12:11 +01:00
zip-0323.rst Add stubs for ZIP numbers 314, 315, 316, 322, and 323. 2021-04-07 10:12:11 +01:00
zip-0339.html
zip-0339.rst
zip-0400.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0400.rst
zip-0401.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-0401.rst ZIP 401: revert change to use wtxid. 2021-09-17 13:10:02 +01:00
zip-0402.html
zip-0402.rst
zip-0403.html
zip-0403.rst
zip-0416.html ZIP 416: Change title to be more general than RPC support. 2021-12-01 18:07:44 +00:00
zip-0416.rst ZIP 416: Change title to be more general than RPC support. 2021-12-01 18:07:44 +00:00
zip-1001.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1001.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1002.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1002.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1003.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1003.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1004.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1004.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1005.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1005.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1006.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1006.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1007.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1007.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1008.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1008.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1009.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1009.rst Fix stale links, and correct the accenting of [MÁEÁ2010]. 2022-01-03 22:15:14 +00:00
zip-1010.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1010.rst Fix all links in ZIPs (and almost eliminate plain http links). 2021-09-09 15:02:46 +01:00
zip-1011.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1011.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1012.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1012.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1013.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1013.rst Regularize ZIP categories. 2020-11-14 22:17:27 +00:00
zip-1014.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-1014.rst Update references to protocol spec from process and consensus ZIPs (0 to 252 inclusive, and 1014). 2021-10-02 00:46:17 +01:00
zip-guide.html [Dark mode] Fix the background colour of the section anchor image. 2022-01-11 13:19:12 +00:00
zip-guide.rst Fix all links in ZIPs (and almost eliminate plain http links). 2021-09-09 15:02:46 +01:00

README.template

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. Title: Specifications and Zcash Improvement Proposals


What are ZIPs?
--------------

Zcash Improvement Proposals (ZIPs) are the way to:

* propose new features for the `Zcash cryptocurrency <https://z.cash/>`__ and their rationale,
* specify the implementation details of the feature,
* collect community input on the proposal, and
* document design decisions.


Contributing
------------

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 youd like to bounce ideas off people before formally
writing a ZIP, we encourage it! Visit the `ZcashCommunity Discord chat <https://discord.gg/kdjfvps>`__
to talk about your idea.

Participation in the Zcash project is subject to a `Code of
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.

The Zcash protocol is documented in its `Protocol Specification <protocol/protocol.pdf>`__.

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
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,
and double-check the generated ``draft-*.html`` file before filing a Pull Request.


NU5 ZIPs
--------

This is the list of ZIPs relevant to the proposed NU5 Upgrade, which
is planned to activate on Mainnet in January 2022:

- `ZIP 32: Shielded Hierarchical Deterministic Wallets <zip-0032.rst>`__ (updated)
- `ZIP 203: Transaction Expiry <zip-0203.rst>`__ (updated)
- `ZIP 209: Prohibit Negative Shielded Chain Value Pool Balances <zip-0209.rst>`__ (updated)
- `ZIP 212: Allow Recipient to Derive Ephemeral Secret from Note Plaintext <zip-0212.rst>`__ (updated)
- `ZIP 213: Shielded Coinbase <zip-0213.rst>`__ (updated)
- `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>`__
- `ZIP 239: Relay of Version 5 Transactions <zip-0239.rst>`__
- `ZIP 244: Transaction Identifier Non-Malleability <zip-0244.rst>`__
- `ZIP 252: Deployment of the NU5 Network Upgrade <zip-0252.rst>`__
- `ZIP 316: Unified Addresses and Unified Viewing Keys <zip-0316.rst>`__
- `ZIP 401: Addressing Mempool Denial-of-Service <zip-0401.rst>`__ (clarified)


License
-------

Unless otherwise stated in this repositorys individual files, the
contents of this repository are released under the terms of the MIT
license. See `COPYING <COPYING.rst>`__ for more information or see
https://opensource.org/licenses/MIT .