diff --git a/Makefile b/Makefile index 8a54ee51..660e2d7a 100644 --- a/Makefile +++ b/Makefile @@ -2,14 +2,14 @@ .PHONY: all all-zips tag-release protocol discard all-zips: .Makefile.uptodate - echo "$(sort $(wildcard zip-*.rst) $(wildcard zip-*.md))" >.zipfilelist.new + echo "$(patsubst zips/%,%,$(sort $(wildcard zips/zip-*.rst) $(wildcard zips/zip-*.md)))" >.zipfilelist.new diff .zipfilelist.current .zipfilelist.new || cp -f .zipfilelist.new .zipfilelist.current rm -f .zipfilelist.new - echo "$(sort $(wildcard draft-*.rst) $(wildcard draft-*.md))" >.draftfilelist.new + echo "$(patsubst zips/%,%,$(sort $(wildcard zips/draft-*.rst) $(wildcard zips/draft-*.md)))" >.draftfilelist.new diff .draftfilelist.current .draftfilelist.new || cp -f .draftfilelist.new .draftfilelist.current rm -f .draftfilelist.new $(MAKE) README.rst - $(MAKE) rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(filter-out README,$(basename $(sort $(wildcard *.rst) $(wildcard *.md)))))) + $(MAKE) rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md)))))) all: all-zips protocol @@ -27,13 +27,13 @@ discard: touch .Makefile.uptodate define PROCESSRST -$(eval TITLE := $(shell echo '$(basename $<)' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||')) +$(eval TITLE := $(shell echo '$(patsubst zips/%,%,$(basename $<))' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||')) rst2html5 -v --title="$(TITLE)" $< >$@ ./edithtml.sh --rst $@ endef define PROCESSMD -$(eval TITLE := $(shell echo '$(basename $<)' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||')) +$(eval TITLE := $(shell echo '$(patsubst zips/%,%,$(basename $<))' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||')) pandoc --from=markdown --to=html $< --output=$@ ./edithtml.sh --md $@ "${TITLE}" endef @@ -41,13 +41,13 @@ endef rendered/index.html: README.rst edithtml.sh $(PROCESSRST) -rendered/%.html: %.rst edithtml.sh +rendered/%.html: zips/%.rst edithtml.sh $(PROCESSRST) -rendered/%.html: %.md edithtml.sh +rendered/%.html: zips/%.md edithtml.sh $(PROCESSMD) -README.rst: .zipfilelist.current .draftfilelist.current makeindex.sh README.template $(wildcard zip-*.rst) $(wildcard zip-*.md) $(wildcard draft-*.rst) $(wildcard draft-*.md) +README.rst: .zipfilelist.current .draftfilelist.current makeindex.sh README.template $(wildcard zips/zip-*.rst) $(wildcard zips/zip-*.md) $(wildcard zips/draft-*.rst) $(wildcard zips/draft-*.md) ./makeindex.sh | cat README.template - >README.rst .PHONY: linkcheck @@ -57,4 +57,4 @@ linkcheck: all-zips .PHONY: clean clean: - rm -f .zipfilelist.* README.rst rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(sort $(wildcard *.rst) $(wildcard *.md))))) + rm -f .zipfilelist.* README.rst rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md)))))) diff --git a/README.rst b/README.rst index 1d248421..92cae079 100644 --- a/README.rst +++ b/README.rst @@ -28,11 +28,11 @@ Conduct `__. The Zcash protocol is documented in its `Protocol Specification `__. -To start contributing, first read `ZIP 0 `__ which documents the ZIP process. +To start contributing, first read `ZIP 0 `__ which documents the ZIP process. Then clone `this repo `__ from GitHub, and start adding -your draft ZIP, formatted either as reStructuredText or as Markdown. +your draft ZIP, formatted either as reStructuredText or as Markdown, into the `zips/` directory. -For example, if using reStructuredText, use a filename matching ``draft-*.rst``. +For example, if using reStructuredText, use a filename matching ``zips/draft-*.rst``. Use ``make`` to check that you are using correct `reStructuredText `__ or `Markdown `__ syntax, @@ -55,99 +55,99 @@ Index of ZIPs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ZIP Title Status
0 ZIP Process Active
1 Network Upgrade Policy and Scheduling Reserved
2 Design Considerations for Network Upgrades Reserved
32 Shielded Hierarchical Deterministic Wallets Final
76 Transaction Signature Validation before Overwinter Reserved
143 Transaction Signature Validation for Overwinter Final
155 addrv2 message Proposed
173 Bech32 Format Final
200 Network Upgrade Mechanism Final
201 Network Peer Management for Overwinter Final
202 Version 3 Transaction Format for Overwinter Final
203 Transaction Expiry Final
204 Zcash P2P Network Protocol Reserved
205 Deployment of the Sapling Network Upgrade Final
206 Deployment of the Blossom Network Upgrade Final
207 Funding Streams Final
208 Shorter Block Target Spacing Final
209 Prohibit Negative Shielded Chain Value Pool Balances Final
210 Sapling Anchor Deduplication within Transactions Withdrawn
211 Disabling Addition of New Value to the Sprout Chain Value Pool Final
212 Allow Recipient to Derive Ephemeral Secret from Note Plaintext Final
213 Shielded Coinbase Final
214 Consensus rules for a Zcash Development Fund Final
215 Explicitly Defining and Modifying Ed25519 Validation Rules Final
216 Require Canonical Jubjub Point Encodings Final
217 Aggregate Signatures Reserved
219 Disabling Addition of New Value to the Sapling Chain Value Pool Reserved
220 Zcash Shielded Assets Withdrawn
221 FlyClient - Consensus-Layer Changes Final
222 Transparent Zcash Extensions Draft
224 Orchard Shielded Protocol Final
225 Version 5 Transaction Format Final
226 Transfer and Burn of Zcash Shielded Assets Draft
227 Issuance of Zcash Shielded Assets Draft
228 Asset Swaps for Zcash Shielded Assets Reserved
230 Version 6 Transaction Format Draft
231 Decouple Memos from Transaction Outputs Reserved
239 Relay of Version 5 Transactions Final
243 Transaction Signature Validation for Sapling Final
244 Transaction Identifier Non-Malleability Final
245 Transaction Identifier Digests & Signature Validation for Transparent Zcash Extensions Draft
250 Deployment of the Heartwood Network Upgrade Final
251 Deployment of the Canopy Network Upgrade Final
252 Deployment of the NU5 Network Upgrade Final
253 Deployment of the NU6 Network Upgrade Reserved
300 Cross-chain Atomic Transactions Proposed
301 Zcash Stratum Protocol Final
302 Standardized Memo Field Format Draft
303 Sprout Payment Disclosure Reserved
304 Sapling Address Signatures Draft
305 Best Practices for Hardware Wallets supporting Sapling Reserved
306 Security Considerations for Anchor Selection Reserved
307 Light Client Protocol for Payment Detection Draft
308 Sprout to Sapling Migration Final
309 Blind Off-chain Lightweight Transactions (BOLT) Reserved
310 Security Properties of Sapling Viewing Keys Draft
311 Sapling Payment Disclosure Reserved
312 Shielded Multisignatures using FROST Reserved
313 Reduce Conventional Transaction Fee to 1000 zatoshis Obsolete
314 Privacy upgrades to the Zcash light client protocol Reserved
315 Best Practices for Wallet Implementations Draft
316 Unified Addresses and Unified Viewing Keys Revision 0: Final, Revision 1: Proposed
317 Proportional Transfer Fee Mechanism Active
318 Associated Payload Encryption Reserved
319 Options for Shielded Pool Retirement Reserved
320 Defining an Address Type to which funds can only be sent from Transparent Addresses Proposed
321 Payment Request URIs Proposed
322 Generic Signed Message Format Reserved
323 Specification of getblocktemplate for Zcash Reserved
324 URI-Encapsulated Payments Draft
332 Wallet Recovery from zcashd HD Seeds Reserved
339 Wallet Recovery Words Reserved
400 Wallet.dat format Draft
401 Addressing Mempool Denial-of-Service Active
402 New Wallet Database Format Reserved
403 Verification Behaviour of zcashd Reserved
416 Support for Unified Addresses in zcashd Reserved
1001 Keep the Block Distribution as Initially Defined — 90% to Miners Obsolete
1002 Opt-in Donation Feature Obsolete
1003 20% Split Evenly Between the ECC and the Zcash Foundation, and a Voting System Mandate Obsolete
1004 Miner-Directed Dev Fund Obsolete
1005 Zcash Community Funding System Obsolete
1006 Development Fund of 10% to a 2-of-3 Multisig with Community-Involved Third Entity Obsolete
1007 Enforce Development Fund Commitments with a Legal Charter Obsolete
1008 Fund ECC for Two More Years Obsolete
1009 Five-Entity Strategic Council Obsolete
1010 Compromise Dev Fund Proposal With Diverse Funding Streams Obsolete
1011 Decentralize the Dev Fee Obsolete
1012 Dev Fund to ECC + ZF + Major Grants Obsolete
1013 Keep It Simple, Zcashers: 10% to ECC, 10% to ZF Obsolete
1014 Establishing a Dev Fund for ECC, ZF, and Major Grants Active
guide-markdown {Something Short and To the Point} Draft
guide {Something Short and To the Point} Draft
0 ZIP Process Active
1 Network Upgrade Policy and Scheduling Reserved
2 Design Considerations for Network Upgrades Reserved
32 Shielded Hierarchical Deterministic Wallets Final
76 Transaction Signature Validation before Overwinter Reserved
143 Transaction Signature Validation for Overwinter Final
155 addrv2 message Proposed
173 Bech32 Format Final
200 Network Upgrade Mechanism Final
201 Network Peer Management for Overwinter Final
202 Version 3 Transaction Format for Overwinter Final
203 Transaction Expiry Final
204 Zcash P2P Network Protocol Reserved
205 Deployment of the Sapling Network Upgrade Final
206 Deployment of the Blossom Network Upgrade Final
207 Funding Streams Final
208 Shorter Block Target Spacing Final
209 Prohibit Negative Shielded Chain Value Pool Balances Final
210 Sapling Anchor Deduplication within Transactions Withdrawn
211 Disabling Addition of New Value to the Sprout Chain Value Pool Final
212 Allow Recipient to Derive Ephemeral Secret from Note Plaintext Final
213 Shielded Coinbase Final
214 Consensus rules for a Zcash Development Fund Final
215 Explicitly Defining and Modifying Ed25519 Validation Rules Final
216 Require Canonical Jubjub Point Encodings Final
217 Aggregate Signatures Reserved
219 Disabling Addition of New Value to the Sapling Chain Value Pool Reserved
220 Zcash Shielded Assets Withdrawn
221 FlyClient - Consensus-Layer Changes Final
222 Transparent Zcash Extensions Draft
224 Orchard Shielded Protocol Final
225 Version 5 Transaction Format Final
226 Transfer and Burn of Zcash Shielded Assets Draft
227 Issuance of Zcash Shielded Assets Draft
228 Asset Swaps for Zcash Shielded Assets Reserved
230 Version 6 Transaction Format Draft
231 Decouple Memos from Transaction Outputs Reserved
239 Relay of Version 5 Transactions Final
243 Transaction Signature Validation for Sapling Final
244 Transaction Identifier Non-Malleability Final
245 Transaction Identifier Digests & Signature Validation for Transparent Zcash Extensions Draft
250 Deployment of the Heartwood Network Upgrade Final
251 Deployment of the Canopy Network Upgrade Final
252 Deployment of the NU5 Network Upgrade Final
253 Deployment of the NU6 Network Upgrade Reserved
300 Cross-chain Atomic Transactions Proposed
301 Zcash Stratum Protocol Final
302 Standardized Memo Field Format Draft
303 Sprout Payment Disclosure Reserved
304 Sapling Address Signatures Draft
305 Best Practices for Hardware Wallets supporting Sapling Reserved
306 Security Considerations for Anchor Selection Reserved
307 Light Client Protocol for Payment Detection Draft
308 Sprout to Sapling Migration Final
309 Blind Off-chain Lightweight Transactions (BOLT) Reserved
310 Security Properties of Sapling Viewing Keys Draft
311 Sapling Payment Disclosure Reserved
312 Shielded Multisignatures using FROST Reserved
313 Reduce Conventional Transaction Fee to 1000 zatoshis Obsolete
314 Privacy upgrades to the Zcash light client protocol Reserved
315 Best Practices for Wallet Implementations Draft
316 Unified Addresses and Unified Viewing Keys Revision 0: Final, Revision 1: Proposed
317 Proportional Transfer Fee Mechanism Active
318 Associated Payload Encryption Reserved
319 Options for Shielded Pool Retirement Reserved
320 Defining an Address Type to which funds can only be sent from Transparent Addresses Proposed
321 Payment Request URIs Proposed
322 Generic Signed Message Format Reserved
323 Specification of getblocktemplate for Zcash Reserved
324 URI-Encapsulated Payments Draft
332 Wallet Recovery from zcashd HD Seeds Reserved
339 Wallet Recovery Words Reserved
400 Wallet.dat format Draft
401 Addressing Mempool Denial-of-Service Active
402 New Wallet Database Format Reserved
403 Verification Behaviour of zcashd Reserved
416 Support for Unified Addresses in zcashd Reserved
1001 Keep the Block Distribution as Initially Defined — 90% to Miners Obsolete
1002 Opt-in Donation Feature Obsolete
1003 20% Split Evenly Between the ECC and the Zcash Foundation, and a Voting System Mandate Obsolete
1004 Miner-Directed Dev Fund Obsolete
1005 Zcash Community Funding System Obsolete
1006 Development Fund of 10% to a 2-of-3 Multisig with Community-Involved Third Entity Obsolete
1007 Enforce Development Fund Commitments with a Legal Charter Obsolete
1008 Fund ECC for Two More Years Obsolete
1009 Five-Entity Strategic Council Obsolete
1010 Compromise Dev Fund Proposal With Diverse Funding Streams Obsolete
1011 Decentralize the Dev Fee Obsolete
1012 Dev Fund to ECC + ZF + Major Grants Obsolete
1013 Keep It Simple, Zcashers: 10% to ECC, 10% to ZF Obsolete
1014 Establishing a Dev Fund for ECC, ZF, and Major Grants Active
guide-markdown {Something Short and To the Point} Draft
guide {Something Short and To the Point} Draft
Drafts without assigned ZIP numbers @@ -162,9 +162,9 @@ be deleted. - - - - - + + + + +
Title
Blocks should balance exactly
Manufacturing Consent; Re-Establishing a Dev Fund for ECC, ZF, ZCG, Qedit, FPF, and ZecHub
Block Reward Allocation for Non-Direct Development Funding
Lockbox Funding Streams
Establishing a Hybrid Dev Fund for ZF, ZCG and a Dev Fund Reserve
Blocks should balance exactly
Manufacturing Consent; Re-Establishing a Dev Fund for ECC, ZF, ZCG, Qedit, FPF, and ZecHub
Block Reward Allocation for Non-Direct Development Funding
Lockbox Funding Streams
Establishing a Hybrid Dev Fund for ZF, ZCG and a Dev Fund Reserve
diff --git a/README.template b/README.template index c91d0a2f..2c6f9219 100644 --- a/README.template +++ b/README.template @@ -28,11 +28,11 @@ Conduct `__. The Zcash protocol is documented in its `Protocol Specification `__. -To start contributing, first read `ZIP 0 `__ which documents the ZIP process. +To start contributing, first read `ZIP 0 `__ which documents the ZIP process. Then clone `this repo `__ from GitHub, and start adding -your draft ZIP, formatted either as reStructuredText or as Markdown. +your draft ZIP, formatted either as reStructuredText or as Markdown, into the `zips/` directory. -For example, if using reStructuredText, use a filename matching ``draft-*.rst``. +For example, if using reStructuredText, use a filename matching ``zips/draft-*.rst``. Use ``make`` to check that you are using correct `reStructuredText `__ or `Markdown `__ syntax, diff --git a/edithtml.sh b/edithtml.sh index ed61ffa3..27c11943 100755 --- a/edithtml.sh +++ b/edithtml.sh @@ -37,8 +37,9 @@ sed -i.sedbak 's||||g' "$2" sed -i.sedbak 's|<\(https:[^&]*\)>|\<\1\>|g' "$2" -sed -i.sedbak 's|src="rendered/|src="|g' "$2" +sed -i.sedbak 's|src="../rendered/|src="|g' "$2" sed -i.sedbak 's|\s*.?\s*([^<]*(?:[^<]*[^<]*)?)|
\3 |g' "$2" diff --git a/makeindex.sh b/makeindex.sh index b7034c2f..65a46bfd 100755 --- a/makeindex.sh +++ b/makeindex.sh @@ -11,6 +11,7 @@ Index of ZIPs ZIP Title Status EndOfHeader for zipfile in $(cat .zipfilelist.current); do + zipfile=zips/$zipfile echo Adding $zipfile to index. >/dev/stderr if grep -E '^\s*Status:\s*Reserved' $zipfile >/dev/null; then echo " `basename $(basename $zipfile .rst) .md | sed -E 's@zip-0{0,3}@@'` `grep '^\s*Title:' $zipfile | sed -E 's@\s*Title:\s*@@'` `grep '^\s*Status:' $zipfile | sed -E 's@\s*Status:\s*@@'`" @@ -40,6 +41,7 @@ be deleted. Title EndOfDraftHeader for draftfile in $(cat .draftfilelist.current); do + draftfile=zips/$draftfile echo Adding $draftfile to index of drafts. >/dev/stderr echo " `grep '^\s*Title:' $draftfile | sed -E 's@\s*Title:\s*@@'`" done diff --git a/rendered/index.html b/rendered/index.html index e302ce9b..0e1edd2d 100644 --- a/rendered/index.html +++ b/rendered/index.html @@ -21,8 +21,8 @@

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 writing a ZIP, we encourage it! Visit the ZcashCommunity Discord chat to talk about your idea.

Participation in the Zcash project is subject to a Code of Conduct.

The Zcash protocol is documented in its Protocol Specification.

-

To start contributing, first read ZIP 0 which documents the ZIP process. Then clone this repo 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 or Markdown syntax, and double-check the generated rendered/draft-*.html file before filing a Pull Request. See here for the project dependencies.

+

To start contributing, first read ZIP 0 which documents the ZIP process. Then clone this repo from GitHub, and start adding your draft ZIP, formatted either as reStructuredText or as Markdown, into the zips/ directory.

+

For example, if using reStructuredText, use a filename matching zips/draft-*.rst. Use make to check that you are using correct reStructuredText or Markdown syntax, and double-check the generated rendered/draft-*.html file before filing a Pull Request. See here for the project dependencies.

License

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

diff --git a/rendered/zip-0315.html b/rendered/zip-0315.html index 380f111d..c373b47c 100644 --- a/rendered/zip-0315.html +++ b/rendered/zip-0315.html @@ -76,21 +76,21 @@ Pull-Request: <https://githu

It is RECOMMENDED that wallets only hold funds as shielded in the long term; that is, if a wallet supports receiving transparent funds (or supports importing a seed from another wallet that might have done so), then it SHOULD auto-shield such funds by default.

A shielding transaction is always linked to the transparent addresses it spends from. This can cause undesirable information leaks: a) if there are multiple transparent addresses, they will be linked to each

-

System Message: ERROR/3 (zip-0315.rst line 136)

+

System Message: ERROR/3 (zips/zip-0315.rst line 136)

Unexpected indentation.

other;

-

System Message: WARNING/2 (zip-0315.rst line 137)

+

System Message: WARNING/2 (zips/zip-0315.rst line 137)

Block quote ends without a blank line; unexpected unindent.

  1. a link between the input transparent address(es) and the payment will be visible to the recipient(s), or to any other holder of an Incoming Viewing Key for the destination address(es).
-

System Message: INFO/1 (zip-0315.rst line 123)

+

System Message: INFO/1 (zips/zip-0315.rst line 123)

Enumerated list start value not ordinal-1: "b" (ordinal 2)

Despite the fact that it is not possible to achieve strong privacy guarantees from any use of transparent addresses, it is undesirable to reveal this additional information. In particular, issue b) motivates ruling out the use of "opportunistic shielding", i.e. shielding previously received transparent funds as part of a user-initiated transaction.

@@ -167,14 +167,14 @@ Pull-Request: <https://githu

Sent transactions

A transaction is sent if it was either: * created by the wallet, or * detected by using the wallet's outgoing viewing keys to decrypt

-

System Message: ERROR/3 (zip-0315.rst line 308)

+

System Message: ERROR/3 (zips/zip-0315.rst line 308)

Unexpected indentation.

Sapling or Orchard outputs, or

-

System Message: WARNING/2 (zip-0315.rst line 309)

+

System Message: WARNING/2 (zips/zip-0315.rst line 309)

Block quote ends without a blank line; unexpected unindent.

    @@ -401,15 +401,15 @@ Pull-Request: <https://githu

    Docutils System Messages

    -

    System Message: ERROR/3 (zip-0315.rst line 65)

    +

    System Message: ERROR/3 (zips/zip-0315.rst line 65)

    Too many autonumbered footnote references: only 0 corresponding footnotes available.

    -

    System Message: ERROR/3 (zip-0315.rst line 65) footnote-reference-2

    +

    System Message: ERROR/3 (zips/zip-0315.rst line 65) footnote-reference-2

    Unknown target name: "zip-0032".

    -

    System Message: ERROR/3 (zip-0315.rst line 65) footnote-reference-3

    +

    System Message: ERROR/3 (zips/zip-0315.rst line 65) footnote-reference-3

    Unknown target name: "zip-0316".

    diff --git a/draft-hopwood-coinbase-balance.rst b/zips/draft-hopwood-coinbase-balance.rst similarity index 100% rename from draft-hopwood-coinbase-balance.rst rename to zips/draft-hopwood-coinbase-balance.rst diff --git a/draft-noamchom67-manufacturing-consent.rst b/zips/draft-noamchom67-manufacturing-consent.rst similarity index 100% rename from draft-noamchom67-manufacturing-consent.rst rename to zips/draft-noamchom67-manufacturing-consent.rst diff --git a/draft-nuttycom-funding-allocation.rst b/zips/draft-nuttycom-funding-allocation.rst similarity index 100% rename from draft-nuttycom-funding-allocation.rst rename to zips/draft-nuttycom-funding-allocation.rst diff --git a/draft-nuttycom-lockbox-streams.rst b/zips/draft-nuttycom-lockbox-streams.rst similarity index 100% rename from draft-nuttycom-lockbox-streams.rst rename to zips/draft-nuttycom-lockbox-streams.rst diff --git a/draft-zf-community-dev-fund-2-proposal.rst b/zips/draft-zf-community-dev-fund-2-proposal.rst similarity index 100% rename from draft-zf-community-dev-fund-2-proposal.rst rename to zips/draft-zf-community-dev-fund-2-proposal.rst diff --git a/zip-0000.rst b/zips/zip-0000.rst similarity index 100% rename from zip-0000.rst rename to zips/zip-0000.rst diff --git a/zip-0001.rst b/zips/zip-0001.rst similarity index 100% rename from zip-0001.rst rename to zips/zip-0001.rst diff --git a/zip-0002.rst b/zips/zip-0002.rst similarity index 100% rename from zip-0002.rst rename to zips/zip-0002.rst diff --git a/zip-0032-orchard-internal-key-derivation.svg b/zips/zip-0032-orchard-internal-key-derivation.svg similarity index 100% rename from zip-0032-orchard-internal-key-derivation.svg rename to zips/zip-0032-orchard-internal-key-derivation.svg diff --git a/zip-0032-sapling-internal-key-derivation.svg b/zips/zip-0032-sapling-internal-key-derivation.svg similarity index 100% rename from zip-0032-sapling-internal-key-derivation.svg rename to zips/zip-0032-sapling-internal-key-derivation.svg diff --git a/zip-0032.rst b/zips/zip-0032.rst similarity index 99% rename from zip-0032.rst rename to zips/zip-0032.rst index 49a895cb..a008a740 100644 --- a/zip-0032.rst +++ b/zips/zip-0032.rst @@ -319,7 +319,7 @@ The values of :math:`I`, :math:`I_\mathsf{nsk}`, and :math:`R` are the same betw a full viewing key, and deriving the corresponding spending key. Both of these derivations are shown in the following diagram: -.. figure:: rendered/assets/images/zip-0032-sapling-internal-key-derivation.png +.. figure:: ../rendered/assets/images/zip-0032-sapling-internal-key-derivation.png :width: 900px :align: center :figclass: align-center @@ -432,7 +432,7 @@ field relative to the external full viewing key, which results in different fields being derived, as specified in [#protocol-orchardkeycomponents]_ and shown in the following diagram: -.. figure:: rendered/assets/images/zip-0032-orchard-internal-key-derivation.png +.. figure:: ../rendered/assets/images/zip-0032-orchard-internal-key-derivation.png :width: 720px :align: center :figclass: align-center diff --git a/zip-0076.rst b/zips/zip-0076.rst similarity index 100% rename from zip-0076.rst rename to zips/zip-0076.rst diff --git a/zip-0143.rst b/zips/zip-0143.rst similarity index 100% rename from zip-0143.rst rename to zips/zip-0143.rst diff --git a/zip-0155.rst b/zips/zip-0155.rst similarity index 100% rename from zip-0155.rst rename to zips/zip-0155.rst diff --git a/zip-0173.rst b/zips/zip-0173.rst similarity index 100% rename from zip-0173.rst rename to zips/zip-0173.rst diff --git a/zip-0200.rst b/zips/zip-0200.rst similarity index 100% rename from zip-0200.rst rename to zips/zip-0200.rst diff --git a/zip-0201.rst b/zips/zip-0201.rst similarity index 100% rename from zip-0201.rst rename to zips/zip-0201.rst diff --git a/zip-0202.rst b/zips/zip-0202.rst similarity index 100% rename from zip-0202.rst rename to zips/zip-0202.rst diff --git a/zip-0203.rst b/zips/zip-0203.rst similarity index 100% rename from zip-0203.rst rename to zips/zip-0203.rst diff --git a/zip-0204.rst b/zips/zip-0204.rst similarity index 100% rename from zip-0204.rst rename to zips/zip-0204.rst diff --git a/zip-0205.rst b/zips/zip-0205.rst similarity index 100% rename from zip-0205.rst rename to zips/zip-0205.rst diff --git a/zip-0206.rst b/zips/zip-0206.rst similarity index 100% rename from zip-0206.rst rename to zips/zip-0206.rst diff --git a/zip-0207.rst b/zips/zip-0207.rst similarity index 100% rename from zip-0207.rst rename to zips/zip-0207.rst diff --git a/zip-0208.rst b/zips/zip-0208.rst similarity index 100% rename from zip-0208.rst rename to zips/zip-0208.rst diff --git a/zip-0209.rst b/zips/zip-0209.rst similarity index 100% rename from zip-0209.rst rename to zips/zip-0209.rst diff --git a/zip-0210.rst b/zips/zip-0210.rst similarity index 100% rename from zip-0210.rst rename to zips/zip-0210.rst diff --git a/zip-0211.rst b/zips/zip-0211.rst similarity index 100% rename from zip-0211.rst rename to zips/zip-0211.rst diff --git a/zip-0212.rst b/zips/zip-0212.rst similarity index 100% rename from zip-0212.rst rename to zips/zip-0212.rst diff --git a/zip-0213.rst b/zips/zip-0213.rst similarity index 100% rename from zip-0213.rst rename to zips/zip-0213.rst diff --git a/zip-0214.rst b/zips/zip-0214.rst similarity index 100% rename from zip-0214.rst rename to zips/zip-0214.rst diff --git a/zip-0215.rst b/zips/zip-0215.rst similarity index 100% rename from zip-0215.rst rename to zips/zip-0215.rst diff --git a/zip-0216.rst b/zips/zip-0216.rst similarity index 100% rename from zip-0216.rst rename to zips/zip-0216.rst diff --git a/zip-0217.rst b/zips/zip-0217.rst similarity index 100% rename from zip-0217.rst rename to zips/zip-0217.rst diff --git a/zip-0219.rst b/zips/zip-0219.rst similarity index 100% rename from zip-0219.rst rename to zips/zip-0219.rst diff --git a/zip-0220.rst b/zips/zip-0220.rst similarity index 100% rename from zip-0220.rst rename to zips/zip-0220.rst diff --git a/zip-0221.rst b/zips/zip-0221.rst similarity index 100% rename from zip-0221.rst rename to zips/zip-0221.rst diff --git a/zip-0222.rst b/zips/zip-0222.rst similarity index 100% rename from zip-0222.rst rename to zips/zip-0222.rst diff --git a/zip-0224.rst b/zips/zip-0224.rst similarity index 100% rename from zip-0224.rst rename to zips/zip-0224.rst diff --git a/zip-0225.rst b/zips/zip-0225.rst similarity index 100% rename from zip-0225.rst rename to zips/zip-0225.rst diff --git a/zip-0226.rst b/zips/zip-0226.rst similarity index 100% rename from zip-0226.rst rename to zips/zip-0226.rst diff --git a/zip-0227-asset-identifier-relation.svg b/zips/zip-0227-asset-identifier-relation.svg similarity index 100% rename from zip-0227-asset-identifier-relation.svg rename to zips/zip-0227-asset-identifier-relation.svg diff --git a/zip-0227-key-components-zsa.svg b/zips/zip-0227-key-components-zsa.svg similarity index 100% rename from zip-0227-key-components-zsa.svg rename to zips/zip-0227-key-components-zsa.svg diff --git a/zip-0227.rst b/zips/zip-0227.rst similarity index 99% rename from zip-0227.rst rename to zips/zip-0227.rst index 1de0c243..94bb5084 100644 --- a/zip-0227.rst +++ b/zips/zip-0227.rst @@ -89,7 +89,7 @@ The Orchard-ZSA Protocol adds the following keys to the key components [#protoco The relations between these keys are shown in the following diagram: -.. figure:: rendered/assets/images/zip-0227-key-components-zsa.png +.. figure:: ../rendered/assets/images/zip-0227-key-components-zsa.png :width: 450px :align: center :figclass: align-center @@ -201,7 +201,7 @@ where :math:`\mathsf{GroupHash}^\mathbb{P}` is defined as in [#protocol-concrete The relations between the Asset Identifier, Asset Digest, and Asset Base are shown in the following diagram: -.. figure:: rendered/assets/images/zip-0227-asset-identifier-relation.png +.. figure:: ../rendered/assets/images/zip-0227-asset-identifier-relation.png :width: 600px :align: center :figclass: align-center diff --git a/zip-0228.rst b/zips/zip-0228.rst similarity index 100% rename from zip-0228.rst rename to zips/zip-0228.rst diff --git a/zip-0230.rst b/zips/zip-0230.rst similarity index 100% rename from zip-0230.rst rename to zips/zip-0230.rst diff --git a/zip-0231.rst b/zips/zip-0231.rst similarity index 100% rename from zip-0231.rst rename to zips/zip-0231.rst diff --git a/zip-0239.rst b/zips/zip-0239.rst similarity index 100% rename from zip-0239.rst rename to zips/zip-0239.rst diff --git a/zip-0243.rst b/zips/zip-0243.rst similarity index 100% rename from zip-0243.rst rename to zips/zip-0243.rst diff --git a/zip-0244.rst b/zips/zip-0244.rst similarity index 100% rename from zip-0244.rst rename to zips/zip-0244.rst diff --git a/zip-0245.rst b/zips/zip-0245.rst similarity index 100% rename from zip-0245.rst rename to zips/zip-0245.rst diff --git a/zip-0250.rst b/zips/zip-0250.rst similarity index 100% rename from zip-0250.rst rename to zips/zip-0250.rst diff --git a/zip-0251.rst b/zips/zip-0251.rst similarity index 100% rename from zip-0251.rst rename to zips/zip-0251.rst diff --git a/zip-0252.rst b/zips/zip-0252.rst similarity index 100% rename from zip-0252.rst rename to zips/zip-0252.rst diff --git a/zip-0253.rst b/zips/zip-0253.rst similarity index 100% rename from zip-0253.rst rename to zips/zip-0253.rst diff --git a/zip-0300.rst b/zips/zip-0300.rst similarity index 100% rename from zip-0300.rst rename to zips/zip-0300.rst diff --git a/zip-0301.rst b/zips/zip-0301.rst similarity index 100% rename from zip-0301.rst rename to zips/zip-0301.rst diff --git a/zip-0302.rst b/zips/zip-0302.rst similarity index 100% rename from zip-0302.rst rename to zips/zip-0302.rst diff --git a/zip-0303.rst b/zips/zip-0303.rst similarity index 100% rename from zip-0303.rst rename to zips/zip-0303.rst diff --git a/zip-0304.rst b/zips/zip-0304.rst similarity index 100% rename from zip-0304.rst rename to zips/zip-0304.rst diff --git a/zip-0305.rst b/zips/zip-0305.rst similarity index 100% rename from zip-0305.rst rename to zips/zip-0305.rst diff --git a/zip-0306.rst b/zips/zip-0306.rst similarity index 100% rename from zip-0306.rst rename to zips/zip-0306.rst diff --git a/zip-0307.rst b/zips/zip-0307.rst similarity index 99% rename from zip-0307.rst rename to zips/zip-0307.rst index 2f370309..720443c8 100644 --- a/zip-0307.rst +++ b/zips/zip-0307.rst @@ -53,7 +53,7 @@ There are three logical components to a Zcash light client system: update its own view of the chain state. The light client MAY be attached to a wallet backend that will track particular Sapling notes. -.. figure:: rendered/assets/images/zip-0307-arch.png +.. figure:: ../rendered/assets/images/zip-0307-arch.png :align: center :figclass: align-center diff --git a/zip-0308.rst b/zips/zip-0308.rst similarity index 100% rename from zip-0308.rst rename to zips/zip-0308.rst diff --git a/zip-0309.rst b/zips/zip-0309.rst similarity index 100% rename from zip-0309.rst rename to zips/zip-0309.rst diff --git a/zip-0310.rst b/zips/zip-0310.rst similarity index 100% rename from zip-0310.rst rename to zips/zip-0310.rst diff --git a/zip-0311.rst b/zips/zip-0311.rst similarity index 100% rename from zip-0311.rst rename to zips/zip-0311.rst diff --git a/zip-0312.rst b/zips/zip-0312.rst similarity index 100% rename from zip-0312.rst rename to zips/zip-0312.rst diff --git a/zip-0313.rst b/zips/zip-0313.rst similarity index 100% rename from zip-0313.rst rename to zips/zip-0313.rst diff --git a/zip-0314.rst b/zips/zip-0314.rst similarity index 100% rename from zip-0314.rst rename to zips/zip-0314.rst diff --git a/zip-0315.rst b/zips/zip-0315.rst similarity index 100% rename from zip-0315.rst rename to zips/zip-0315.rst diff --git a/zip-0316-f3.svg b/zips/zip-0316-f3.svg similarity index 100% rename from zip-0316-f3.svg rename to zips/zip-0316-f3.svg diff --git a/zip-0316-f4.svg b/zips/zip-0316-f4.svg similarity index 100% rename from zip-0316-f4.svg rename to zips/zip-0316-f4.svg diff --git a/zip-0316.rst b/zips/zip-0316.rst similarity index 99% rename from zip-0316.rst rename to zips/zip-0316.rst index 365e65a0..91b6c412 100644 --- a/zip-0316.rst +++ b/zips/zip-0316.rst @@ -1088,7 +1088,7 @@ concatenation of :math:`\mathsf{I2LEOSP}_{16}(j), u) \text{ for } j \text{ from}` :math:`0 \text{ up to } \mathsf{ceiling}(\ell_R/\ell_H)-1].` -.. figure:: rendered/assets/images/zip-0316-f4.png +.. figure:: ../rendered/assets/images/zip-0316-f4.png :width: 372px :align: center :figclass: align-center @@ -1158,7 +1158,7 @@ Heuristic analysis A 3-round unkeyed Feistel, as shown, is not sufficient: -.. figure:: rendered/assets/images/zip-0316-f3.png +.. figure:: ../rendered/assets/images/zip-0316-f3.png :width: 372px :align: center :figclass: align-center diff --git a/zip-0317.rst b/zips/zip-0317.rst similarity index 100% rename from zip-0317.rst rename to zips/zip-0317.rst diff --git a/zip-0318.rst b/zips/zip-0318.rst similarity index 100% rename from zip-0318.rst rename to zips/zip-0318.rst diff --git a/zip-0319.rst b/zips/zip-0319.rst similarity index 100% rename from zip-0319.rst rename to zips/zip-0319.rst diff --git a/zip-0320.rst b/zips/zip-0320.rst similarity index 100% rename from zip-0320.rst rename to zips/zip-0320.rst diff --git a/zip-0321.rst b/zips/zip-0321.rst similarity index 100% rename from zip-0321.rst rename to zips/zip-0321.rst diff --git a/zip-0322.rst b/zips/zip-0322.rst similarity index 100% rename from zip-0322.rst rename to zips/zip-0322.rst diff --git a/zip-0323.rst b/zips/zip-0323.rst similarity index 100% rename from zip-0323.rst rename to zips/zip-0323.rst diff --git a/zip-0324.rst b/zips/zip-0324.rst similarity index 100% rename from zip-0324.rst rename to zips/zip-0324.rst diff --git a/zip-0332.rst b/zips/zip-0332.rst similarity index 100% rename from zip-0332.rst rename to zips/zip-0332.rst diff --git a/zip-0339.rst b/zips/zip-0339.rst similarity index 100% rename from zip-0339.rst rename to zips/zip-0339.rst diff --git a/zip-0400.rst b/zips/zip-0400.rst similarity index 100% rename from zip-0400.rst rename to zips/zip-0400.rst diff --git a/zip-0401.rst b/zips/zip-0401.rst similarity index 100% rename from zip-0401.rst rename to zips/zip-0401.rst diff --git a/zip-0402.rst b/zips/zip-0402.rst similarity index 100% rename from zip-0402.rst rename to zips/zip-0402.rst diff --git a/zip-0403.rst b/zips/zip-0403.rst similarity index 100% rename from zip-0403.rst rename to zips/zip-0403.rst diff --git a/zip-0416.rst b/zips/zip-0416.rst similarity index 100% rename from zip-0416.rst rename to zips/zip-0416.rst diff --git a/zip-1001.rst b/zips/zip-1001.rst similarity index 100% rename from zip-1001.rst rename to zips/zip-1001.rst diff --git a/zip-1002.rst b/zips/zip-1002.rst similarity index 100% rename from zip-1002.rst rename to zips/zip-1002.rst diff --git a/zip-1003.rst b/zips/zip-1003.rst similarity index 100% rename from zip-1003.rst rename to zips/zip-1003.rst diff --git a/zip-1004.rst b/zips/zip-1004.rst similarity index 100% rename from zip-1004.rst rename to zips/zip-1004.rst diff --git a/zip-1005.rst b/zips/zip-1005.rst similarity index 100% rename from zip-1005.rst rename to zips/zip-1005.rst diff --git a/zip-1006.rst b/zips/zip-1006.rst similarity index 100% rename from zip-1006.rst rename to zips/zip-1006.rst diff --git a/zip-1007.rst b/zips/zip-1007.rst similarity index 100% rename from zip-1007.rst rename to zips/zip-1007.rst diff --git a/zip-1008.rst b/zips/zip-1008.rst similarity index 100% rename from zip-1008.rst rename to zips/zip-1008.rst diff --git a/zip-1009.rst b/zips/zip-1009.rst similarity index 100% rename from zip-1009.rst rename to zips/zip-1009.rst diff --git a/zip-1010.rst b/zips/zip-1010.rst similarity index 100% rename from zip-1010.rst rename to zips/zip-1010.rst diff --git a/zip-1011.rst b/zips/zip-1011.rst similarity index 100% rename from zip-1011.rst rename to zips/zip-1011.rst diff --git a/zip-1012.rst b/zips/zip-1012.rst similarity index 100% rename from zip-1012.rst rename to zips/zip-1012.rst diff --git a/zip-1013.rst b/zips/zip-1013.rst similarity index 100% rename from zip-1013.rst rename to zips/zip-1013.rst diff --git a/zip-1014.rst b/zips/zip-1014.rst similarity index 100% rename from zip-1014.rst rename to zips/zip-1014.rst diff --git a/zip-guide-markdown.md b/zips/zip-guide-markdown.md similarity index 100% rename from zip-guide-markdown.md rename to zips/zip-guide-markdown.md diff --git a/zip-guide.rst b/zips/zip-guide.rst similarity index 100% rename from zip-guide.rst rename to zips/zip-guide.rst