Go to file
Daira Hopwood aaf0c04f79 edithtml.sh: make it work on macOS (by using perl instead of sed).
Also add permalink anchors to headers containing <code>...</code>.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-06-15 13:20:57 +01:00
assets Add SVG source for section-anchor.png. 2020-02-27 23:13:44 +00:00
css style.css: portability. 2020-04-30 13:21:16 +01:00
historical
protocol Protocol spec: regenerate PDFs. 2020-06-02 18:35:15 +01:00
.gitignore .gitignore: add another pattern for nano save files. 2020-04-14 13:10:23 +01:00
CNAME Create CNAME 2019-08-05 18:01:51 +01:00
COPYING.html Add COPYING.html. 2020-05-12 15:57:01 +01:00
COPYING.rst COPYING -> COPYING.rst 2020-05-12 15:55:46 +01:00
Dockerfile Dockerfile: entrypoint should be "make all", to also make the protocol spec. 2020-04-14 13:09:42 +01:00
Makefile Support writing ZIPs in Markdown, generating the HTML using pandoc. 2020-05-26 23:06:08 +01:00
README.rst Use "validate" rather than "verify" for signature validation in ZIPs. 2020-06-09 12:56:33 +01:00
README.template Some edits made to README.rst should have been made to README.template instead. 2020-05-30 16:51:19 +01:00
_config.yml
edithtml.sh edithtml.sh: make it work on macOS (by using perl instead of sed). 2020-06-15 13:20:57 +01:00
index.html Use "validate" rather than "verify" for signature validation in ZIPs. 2020-06-09 12:56:33 +01:00
makeindex.sh Try to improve consistency of whitespace behaviour for sed on macOS. 2020-01-24 15:33:58 +00:00
render-via-docker.sh Support rendering via Docker. 2020-01-02 11:58:44 -08:00
zip-0000.html ZIP 0: changes Foundation ZIP editor. 2020-05-27 17:38:49 +01:00
zip-0000.rst ZIP 0: changes Foundation ZIP editor. 2020-05-27 17:38:49 +01:00
zip-0032.html ZIP 32: formatting. 2020-05-01 10:16:18 +01:00
zip-0032.rst ZIP 32: formatting. 2020-05-01 10:16:18 +01:00
zip-0143.html edithtml.sh: make it work on macOS (by using perl instead of sed). 2020-06-15 13:20:57 +01:00
zip-0143.rst Use "validate" rather than "verify" for signature validation in ZIPs. 2020-06-09 12:56:33 +01:00
zip-0173.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-0173.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-0200.html Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0200.rst Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0201.html Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0201.rst Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0202.html Use "validate" rather than "verify" for signature validation in ZIPs. 2020-06-09 12:56:33 +01:00
zip-0202.rst Use "validate" rather than "verify" for signature validation in ZIPs. 2020-06-09 12:56:33 +01:00
zip-0203.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-0203.rst Use relative links from ZIPs to other ZIPs and the protocol spec. 2019-11-07 20:28:29 +00:00
zip-0205.html Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0205.rst Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0206.html "branch" -> "consensus branch" 2020-03-16 21:02:36 +00:00
zip-0206.rst "branch" -> "consensus branch" 2020-03-16 21:02:36 +00:00
zip-0207.html ZIPs 250 (for Heartwood) and 251, 207, 214 (for Canopy) to Proposed. 2020-05-30 17:16:56 +01:00
zip-0207.rst ZIPs 250 (for Heartwood) and 251, 207, 214 (for Canopy) to Proposed. 2020-05-30 17:16:56 +01:00
zip-0208.html Use "validate" rather than "verify" for signature validation in ZIPs. 2020-06-09 12:56:33 +01:00
zip-0208.rst Use "validate" rather than "verify" for signature validation in ZIPs. 2020-06-09 12:56:33 +01:00
zip-0209.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-0209.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-0210.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-0210.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-0211.html ZIPs 211, 212, 221: tools.ietf.org -> www.rfc-editor.org. 2020-06-02 18:35:15 +01:00
zip-0211.rst ZIPs 211, 212, 221: tools.ietf.org -> www.rfc-editor.org. 2020-06-02 18:35:15 +01:00
zip-0212.html ZIP 212: fix typo. 2020-06-05 15:55:07 +01:00
zip-0212.rst ZIP 212: fix typo. 2020-06-05 15:55:07 +01:00
zip-0213.html ZIP 213: cosmetic wording change to match the protocol spec. 2020-03-20 16:32:49 +00:00
zip-0213.rst ZIP 213: cosmetic wording change to match the protocol spec. 2020-03-20 16:32:49 +00:00
zip-0214.html ZIPs 250 (for Heartwood) and 251, 207, 214 (for Canopy) to Proposed. 2020-05-30 17:16:56 +01:00
zip-0214.rst ZIPs 250 (for Heartwood) and 251, 207, 214 (for Canopy) to Proposed. 2020-05-30 17:16:56 +01:00
zip-0215.html ZIP 215: "validation criteria" -> "validity criteria". 2020-06-09 13:14:23 +01:00
zip-0215.rst ZIP 215: "validation criteria" -> "validity criteria". 2020-06-09 13:14:23 +01:00
zip-0221.html ZIPs 211, 212, 221: tools.ietf.org -> www.rfc-editor.org. 2020-06-02 18:35:15 +01:00
zip-0221.rst ZIPs 211, 212, 221: tools.ietf.org -> www.rfc-editor.org. 2020-06-02 18:35:15 +01:00
zip-0243.html edithtml.sh: make it work on macOS (by using perl instead of sed). 2020-06-15 13:20:57 +01:00
zip-0243.rst Use "validate" rather than "verify" for signature validation in ZIPs. 2020-06-09 12:56:33 +01:00
zip-0250.html Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0250.rst Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0251.html Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0251.rst Correct references to ZIPs with changed titles. 2020-06-09 13:19:59 +01:00
zip-0308.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-0308.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-0310.html ZIP 310: add Abstract and Motivation. Resolve TODO re: relation between tallies and spending keys. 2020-03-24 23:39:53 +00:00
zip-0310.rst ZIP 310: add Abstract and Motivation. Resolve TODO re: relation between tallies and spending keys. 2020-03-24 23:39:53 +00:00
zip-0401.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-0401.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1001.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1001.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1002.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1002.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1003.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1003.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1004.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1004.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1005.html Obsolete ZIPs 1001 to 1013 inclusive, and regenerate ZIP index and HTML. 2020-02-27 17:54:18 +00:00
zip-1005.rst Obsolete ZIPs 1001 to 1013 inclusive, and regenerate ZIP index and HTML. 2020-02-27 17:54:18 +00:00
zip-1006.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1006.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1007.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1007.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1008.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1008.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1009.html Obsolete ZIPs 1001 to 1013 inclusive, and regenerate ZIP index and HTML. 2020-02-27 17:54:18 +00:00
zip-1009.rst Obsolete ZIPs 1001 to 1013 inclusive, and regenerate ZIP index and HTML. 2020-02-27 17:54:18 +00:00
zip-1010.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1010.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1011.html Upgrade MathJax to v3. fixes #353 2020-04-22 18:22:08 +01:00
zip-1011.rst ZIP 1011: cosmetics. 2020-03-10 16:43:19 +00:00
zip-1012.html Obsolete ZIPs 1001 to 1013 inclusive, and regenerate ZIP index and HTML. 2020-02-27 17:54:18 +00:00
zip-1012.rst Obsolete ZIPs 1001 to 1013 inclusive, and regenerate ZIP index and HTML. 2020-02-27 17:54:18 +00:00
zip-1013.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-1013.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00:00
zip-1014.html Update ZIPs 207, 214, 251, and 1014 to use Canopy name for NU4. 2020-05-26 23:06:08 +01:00
zip-1014.rst Update ZIPs 207, 214, 251, and 1014 to use Canopy name for NU4. 2020-05-26 23:06:08 +01:00
zip-guide.html Rebuild HTML. (This should be a no-op; my version of rst2html5 changed.) 2020-03-10 16:43:19 +00:00
zip-guide.rst Link to https://www.rfc-editor.org/rfc/rfcXXXX.html for RFCs. 2020-02-29 16:00:39 +00: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 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 community
`Discord <https://discord.com/invite/PXHqXV2>`__ channel 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.


Heartwood ZIPs
--------------

This is the list of ZIPs included in Heartwood (Network Upgrade 3), due to activate on
mainnet in mid-July 2020:

- `ZIP 213: Shielded Coinbase <zip-0213.rst>`__
- `ZIP 221: FlyClient - Consensus-Layer Changes <zip-0221.rst>`__


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 .