mirror of https://github.com/zcash/zips.git
Move ZIP source into `zips/` subdirectory
This makes the repo root more approachable for newcomers; the README can be seen in GitHub immediately instead of after much scrolling.
This commit is contained in:
Jack Grigg
parent
080306b42a
commit
26f16f44ec
18
Makefile
18
Makefile
|
|
@ -2,14 +2,14 @@
|
||||||
|
|
||||||
.PHONY: all all-zips tag-release protocol discard
|
.PHONY: all all-zips tag-release protocol discard
|
||||||
all-zips: .Makefile.uptodate
|
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
|
diff .zipfilelist.current .zipfilelist.new || cp -f .zipfilelist.new .zipfilelist.current
|
||||||
rm -f .zipfilelist.new
|
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
|
diff .draftfilelist.current .draftfilelist.new || cp -f .draftfilelist.new .draftfilelist.current
|
||||||
rm -f .draftfilelist.new
|
rm -f .draftfilelist.new
|
||||||
$(MAKE) README.rst
|
$(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
|
all: all-zips protocol
|
||||||
|
|
||||||
|
|
@ -27,13 +27,13 @@ discard:
|
||||||
touch .Makefile.uptodate
|
touch .Makefile.uptodate
|
||||||
|
|
||||||
define PROCESSRST
|
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)" $< >$@
|
rst2html5 -v --title="$(TITLE)" $< >$@
|
||||||
./edithtml.sh --rst $@
|
./edithtml.sh --rst $@
|
||||||
endef
|
endef
|
||||||
|
|
||||||
define PROCESSMD
|
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=$@
|
pandoc --from=markdown --to=html $< --output=$@
|
||||||
./edithtml.sh --md $@ "${TITLE}"
|
./edithtml.sh --md $@ "${TITLE}"
|
||||||
endef
|
endef
|
||||||
|
|
@ -41,13 +41,13 @@ endef
|
||||||
rendered/index.html: README.rst edithtml.sh
|
rendered/index.html: README.rst edithtml.sh
|
||||||
$(PROCESSRST)
|
$(PROCESSRST)
|
||||||
|
|
||||||
rendered/%.html: %.rst edithtml.sh
|
rendered/%.html: zips/%.rst edithtml.sh
|
||||||
$(PROCESSRST)
|
$(PROCESSRST)
|
||||||
|
|
||||||
rendered/%.html: %.md edithtml.sh
|
rendered/%.html: zips/%.md edithtml.sh
|
||||||
$(PROCESSMD)
|
$(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
|
./makeindex.sh | cat README.template - >README.rst
|
||||||
|
|
||||||
.PHONY: linkcheck
|
.PHONY: linkcheck
|
||||||
|
|
@ -57,4 +57,4 @@ linkcheck: all-zips
|
||||||
|
|
||||||
.PHONY: clean
|
.PHONY: clean
|
||||||
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))))))
|
||||||
|
|
|
||||||
202
README.rst
202
README.rst
|
|
@ -28,11 +28,11 @@ Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
|
||||||
|
|
||||||
The Zcash protocol is documented in its `Protocol Specification <rendered/protocol/protocol.pdf>`__.
|
The Zcash protocol is documented in its `Protocol Specification <rendered/protocol/protocol.pdf>`__.
|
||||||
|
|
||||||
To start contributing, first read `ZIP 0 <zip-0000.rst>`__ which documents the ZIP process.
|
To start contributing, first read `ZIP 0 <zips/zip-0000.rst>`__ which documents the ZIP process.
|
||||||
Then clone `this repo <https://github.com/zcash/zips>`__ from GitHub, and start adding
|
Then clone `this repo <https://github.com/zcash/zips>`__ 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
|
Use ``make`` to check that you are using correct
|
||||||
`reStructuredText <https://docutils.sourceforge.io/rst.html>`__ or
|
`reStructuredText <https://docutils.sourceforge.io/rst.html>`__ or
|
||||||
`Markdown <https://pandoc.org/MANUAL.html#pandocs-markdown>`__ syntax,
|
`Markdown <https://pandoc.org/MANUAL.html#pandocs-markdown>`__ syntax,
|
||||||
|
|
@ -55,99 +55,99 @@ Index of ZIPs
|
||||||
|
|
||||||
<embed><table>
|
<embed><table>
|
||||||
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
|
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
|
||||||
<tr> <td>0</td> <td class="left"><a href="zip-0000.rst">ZIP Process</a></td> <td>Active</td>
|
<tr> <td>0</td> <td class="left"><a href="zips/zip-0000.rst">ZIP Process</a></td> <td>Active</td>
|
||||||
<tr> <td><span class="reserved">1</span></td> <td class="left"><a class="reserved" href="zip-0001.rst">Network Upgrade Policy and Scheduling</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">1</span></td> <td class="left"><a class="reserved" href="zips/zip-0001.rst">Network Upgrade Policy and Scheduling</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">2</span></td> <td class="left"><a class="reserved" href="zip-0002.rst">Design Considerations for Network Upgrades</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">2</span></td> <td class="left"><a class="reserved" href="zips/zip-0002.rst">Design Considerations for Network Upgrades</a></td> <td>Reserved</td>
|
||||||
<tr> <td>32</td> <td class="left"><a href="zip-0032.rst">Shielded Hierarchical Deterministic Wallets</a></td> <td>Final</td>
|
<tr> <td>32</td> <td class="left"><a href="zips/zip-0032.rst">Shielded Hierarchical Deterministic Wallets</a></td> <td>Final</td>
|
||||||
<tr> <td><span class="reserved">76</span></td> <td class="left"><a class="reserved" href="zip-0076.rst">Transaction Signature Validation before Overwinter</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">76</span></td> <td class="left"><a class="reserved" href="zips/zip-0076.rst">Transaction Signature Validation before Overwinter</a></td> <td>Reserved</td>
|
||||||
<tr> <td>143</td> <td class="left"><a href="zip-0143.rst">Transaction Signature Validation for Overwinter</a></td> <td>Final</td>
|
<tr> <td>143</td> <td class="left"><a href="zips/zip-0143.rst">Transaction Signature Validation for Overwinter</a></td> <td>Final</td>
|
||||||
<tr> <td>155</td> <td class="left"><a href="zip-0155.rst">addrv2 message</a></td> <td>Proposed</td>
|
<tr> <td>155</td> <td class="left"><a href="zips/zip-0155.rst">addrv2 message</a></td> <td>Proposed</td>
|
||||||
<tr> <td>173</td> <td class="left"><a href="zip-0173.rst">Bech32 Format</a></td> <td>Final</td>
|
<tr> <td>173</td> <td class="left"><a href="zips/zip-0173.rst">Bech32 Format</a></td> <td>Final</td>
|
||||||
<tr> <td>200</td> <td class="left"><a href="zip-0200.rst">Network Upgrade Mechanism</a></td> <td>Final</td>
|
<tr> <td>200</td> <td class="left"><a href="zips/zip-0200.rst">Network Upgrade Mechanism</a></td> <td>Final</td>
|
||||||
<tr> <td>201</td> <td class="left"><a href="zip-0201.rst">Network Peer Management for Overwinter</a></td> <td>Final</td>
|
<tr> <td>201</td> <td class="left"><a href="zips/zip-0201.rst">Network Peer Management for Overwinter</a></td> <td>Final</td>
|
||||||
<tr> <td>202</td> <td class="left"><a href="zip-0202.rst">Version 3 Transaction Format for Overwinter</a></td> <td>Final</td>
|
<tr> <td>202</td> <td class="left"><a href="zips/zip-0202.rst">Version 3 Transaction Format for Overwinter</a></td> <td>Final</td>
|
||||||
<tr> <td>203</td> <td class="left"><a href="zip-0203.rst">Transaction Expiry</a></td> <td>Final</td>
|
<tr> <td>203</td> <td class="left"><a href="zips/zip-0203.rst">Transaction Expiry</a></td> <td>Final</td>
|
||||||
<tr> <td><span class="reserved">204</span></td> <td class="left"><a class="reserved" href="zip-0204.rst">Zcash P2P Network Protocol</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">204</span></td> <td class="left"><a class="reserved" href="zips/zip-0204.rst">Zcash P2P Network Protocol</a></td> <td>Reserved</td>
|
||||||
<tr> <td>205</td> <td class="left"><a href="zip-0205.rst">Deployment of the Sapling Network Upgrade</a></td> <td>Final</td>
|
<tr> <td>205</td> <td class="left"><a href="zips/zip-0205.rst">Deployment of the Sapling Network Upgrade</a></td> <td>Final</td>
|
||||||
<tr> <td>206</td> <td class="left"><a href="zip-0206.rst">Deployment of the Blossom Network Upgrade</a></td> <td>Final</td>
|
<tr> <td>206</td> <td class="left"><a href="zips/zip-0206.rst">Deployment of the Blossom Network Upgrade</a></td> <td>Final</td>
|
||||||
<tr> <td>207</td> <td class="left"><a href="zip-0207.rst">Funding Streams</a></td> <td>Final</td>
|
<tr> <td>207</td> <td class="left"><a href="zips/zip-0207.rst">Funding Streams</a></td> <td>Final</td>
|
||||||
<tr> <td>208</td> <td class="left"><a href="zip-0208.rst">Shorter Block Target Spacing</a></td> <td>Final</td>
|
<tr> <td>208</td> <td class="left"><a href="zips/zip-0208.rst">Shorter Block Target Spacing</a></td> <td>Final</td>
|
||||||
<tr> <td>209</td> <td class="left"><a href="zip-0209.rst">Prohibit Negative Shielded Chain Value Pool Balances</a></td> <td>Final</td>
|
<tr> <td>209</td> <td class="left"><a href="zips/zip-0209.rst">Prohibit Negative Shielded Chain Value Pool Balances</a></td> <td>Final</td>
|
||||||
<tr> <td><strike>210</strike></td> <td class="left"><strike><a href="zip-0210.rst">Sapling Anchor Deduplication within Transactions</a></strike></td> <td>Withdrawn</td>
|
<tr> <td><strike>210</strike></td> <td class="left"><strike><a href="zips/zip-0210.rst">Sapling Anchor Deduplication within Transactions</a></strike></td> <td>Withdrawn</td>
|
||||||
<tr> <td>211</td> <td class="left"><a href="zip-0211.rst">Disabling Addition of New Value to the Sprout Chain Value Pool</a></td> <td>Final</td>
|
<tr> <td>211</td> <td class="left"><a href="zips/zip-0211.rst">Disabling Addition of New Value to the Sprout Chain Value Pool</a></td> <td>Final</td>
|
||||||
<tr> <td>212</td> <td class="left"><a href="zip-0212.rst">Allow Recipient to Derive Ephemeral Secret from Note Plaintext</a></td> <td>Final</td>
|
<tr> <td>212</td> <td class="left"><a href="zips/zip-0212.rst">Allow Recipient to Derive Ephemeral Secret from Note Plaintext</a></td> <td>Final</td>
|
||||||
<tr> <td>213</td> <td class="left"><a href="zip-0213.rst">Shielded Coinbase</a></td> <td>Final</td>
|
<tr> <td>213</td> <td class="left"><a href="zips/zip-0213.rst">Shielded Coinbase</a></td> <td>Final</td>
|
||||||
<tr> <td>214</td> <td class="left"><a href="zip-0214.rst">Consensus rules for a Zcash Development Fund</a></td> <td>Final</td>
|
<tr> <td>214</td> <td class="left"><a href="zips/zip-0214.rst">Consensus rules for a Zcash Development Fund</a></td> <td>Final</td>
|
||||||
<tr> <td>215</td> <td class="left"><a href="zip-0215.rst">Explicitly Defining and Modifying Ed25519 Validation Rules</a></td> <td>Final</td>
|
<tr> <td>215</td> <td class="left"><a href="zips/zip-0215.rst">Explicitly Defining and Modifying Ed25519 Validation Rules</a></td> <td>Final</td>
|
||||||
<tr> <td>216</td> <td class="left"><a href="zip-0216.rst">Require Canonical Jubjub Point Encodings</a></td> <td>Final</td>
|
<tr> <td>216</td> <td class="left"><a href="zips/zip-0216.rst">Require Canonical Jubjub Point Encodings</a></td> <td>Final</td>
|
||||||
<tr> <td><span class="reserved">217</span></td> <td class="left"><a class="reserved" href="zip-0217.rst">Aggregate Signatures</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">217</span></td> <td class="left"><a class="reserved" href="zips/zip-0217.rst">Aggregate Signatures</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">219</span></td> <td class="left"><a class="reserved" href="zip-0219.rst">Disabling Addition of New Value to the Sapling Chain Value Pool</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">219</span></td> <td class="left"><a class="reserved" href="zips/zip-0219.rst">Disabling Addition of New Value to the Sapling Chain Value Pool</a></td> <td>Reserved</td>
|
||||||
<tr> <td><strike>220</strike></td> <td class="left"><strike><a href="zip-0220.rst">Zcash Shielded Assets</a></strike></td> <td>Withdrawn</td>
|
<tr> <td><strike>220</strike></td> <td class="left"><strike><a href="zips/zip-0220.rst">Zcash Shielded Assets</a></strike></td> <td>Withdrawn</td>
|
||||||
<tr> <td>221</td> <td class="left"><a href="zip-0221.rst">FlyClient - Consensus-Layer Changes</a></td> <td>Final</td>
|
<tr> <td>221</td> <td class="left"><a href="zips/zip-0221.rst">FlyClient - Consensus-Layer Changes</a></td> <td>Final</td>
|
||||||
<tr> <td>222</td> <td class="left"><a href="zip-0222.rst">Transparent Zcash Extensions</a></td> <td>Draft</td>
|
<tr> <td>222</td> <td class="left"><a href="zips/zip-0222.rst">Transparent Zcash Extensions</a></td> <td>Draft</td>
|
||||||
<tr> <td>224</td> <td class="left"><a href="zip-0224.rst">Orchard Shielded Protocol</a></td> <td>Final</td>
|
<tr> <td>224</td> <td class="left"><a href="zips/zip-0224.rst">Orchard Shielded Protocol</a></td> <td>Final</td>
|
||||||
<tr> <td>225</td> <td class="left"><a href="zip-0225.rst">Version 5 Transaction Format</a></td> <td>Final</td>
|
<tr> <td>225</td> <td class="left"><a href="zips/zip-0225.rst">Version 5 Transaction Format</a></td> <td>Final</td>
|
||||||
<tr> <td>226</td> <td class="left"><a href="zip-0226.rst">Transfer and Burn of Zcash Shielded Assets</a></td> <td>Draft</td>
|
<tr> <td>226</td> <td class="left"><a href="zips/zip-0226.rst">Transfer and Burn of Zcash Shielded Assets</a></td> <td>Draft</td>
|
||||||
<tr> <td>227</td> <td class="left"><a href="zip-0227.rst">Issuance of Zcash Shielded Assets</a></td> <td>Draft</td>
|
<tr> <td>227</td> <td class="left"><a href="zips/zip-0227.rst">Issuance of Zcash Shielded Assets</a></td> <td>Draft</td>
|
||||||
<tr> <td><span class="reserved">228</span></td> <td class="left"><a class="reserved" href="zip-0228.rst">Asset Swaps for Zcash Shielded Assets</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">228</span></td> <td class="left"><a class="reserved" href="zips/zip-0228.rst">Asset Swaps for Zcash Shielded Assets</a></td> <td>Reserved</td>
|
||||||
<tr> <td>230</td> <td class="left"><a href="zip-0230.rst">Version 6 Transaction Format</a></td> <td>Draft</td>
|
<tr> <td>230</td> <td class="left"><a href="zips/zip-0230.rst">Version 6 Transaction Format</a></td> <td>Draft</td>
|
||||||
<tr> <td><span class="reserved">231</span></td> <td class="left"><a class="reserved" href="zip-0231.rst">Decouple Memos from Transaction Outputs</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">231</span></td> <td class="left"><a class="reserved" href="zips/zip-0231.rst">Decouple Memos from Transaction Outputs</a></td> <td>Reserved</td>
|
||||||
<tr> <td>239</td> <td class="left"><a href="zip-0239.rst">Relay of Version 5 Transactions</a></td> <td>Final</td>
|
<tr> <td>239</td> <td class="left"><a href="zips/zip-0239.rst">Relay of Version 5 Transactions</a></td> <td>Final</td>
|
||||||
<tr> <td>243</td> <td class="left"><a href="zip-0243.rst">Transaction Signature Validation for Sapling</a></td> <td>Final</td>
|
<tr> <td>243</td> <td class="left"><a href="zips/zip-0243.rst">Transaction Signature Validation for Sapling</a></td> <td>Final</td>
|
||||||
<tr> <td>244</td> <td class="left"><a href="zip-0244.rst">Transaction Identifier Non-Malleability</a></td> <td>Final</td>
|
<tr> <td>244</td> <td class="left"><a href="zips/zip-0244.rst">Transaction Identifier Non-Malleability</a></td> <td>Final</td>
|
||||||
<tr> <td>245</td> <td class="left"><a href="zip-0245.rst">Transaction Identifier Digests & Signature Validation for Transparent Zcash Extensions</a></td> <td>Draft</td>
|
<tr> <td>245</td> <td class="left"><a href="zips/zip-0245.rst">Transaction Identifier Digests & Signature Validation for Transparent Zcash Extensions</a></td> <td>Draft</td>
|
||||||
<tr> <td>250</td> <td class="left"><a href="zip-0250.rst">Deployment of the Heartwood Network Upgrade</a></td> <td>Final</td>
|
<tr> <td>250</td> <td class="left"><a href="zips/zip-0250.rst">Deployment of the Heartwood Network Upgrade</a></td> <td>Final</td>
|
||||||
<tr> <td>251</td> <td class="left"><a href="zip-0251.rst">Deployment of the Canopy Network Upgrade</a></td> <td>Final</td>
|
<tr> <td>251</td> <td class="left"><a href="zips/zip-0251.rst">Deployment of the Canopy Network Upgrade</a></td> <td>Final</td>
|
||||||
<tr> <td>252</td> <td class="left"><a href="zip-0252.rst">Deployment of the NU5 Network Upgrade</a></td> <td>Final</td>
|
<tr> <td>252</td> <td class="left"><a href="zips/zip-0252.rst">Deployment of the NU5 Network Upgrade</a></td> <td>Final</td>
|
||||||
<tr> <td><span class="reserved">253</span></td> <td class="left"><a class="reserved" href="zip-0253.rst">Deployment of the NU6 Network Upgrade</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">253</span></td> <td class="left"><a class="reserved" href="zips/zip-0253.rst">Deployment of the NU6 Network Upgrade</a></td> <td>Reserved</td>
|
||||||
<tr> <td>300</td> <td class="left"><a href="zip-0300.rst">Cross-chain Atomic Transactions</a></td> <td>Proposed</td>
|
<tr> <td>300</td> <td class="left"><a href="zips/zip-0300.rst">Cross-chain Atomic Transactions</a></td> <td>Proposed</td>
|
||||||
<tr> <td>301</td> <td class="left"><a href="zip-0301.rst">Zcash Stratum Protocol</a></td> <td>Final</td>
|
<tr> <td>301</td> <td class="left"><a href="zips/zip-0301.rst">Zcash Stratum Protocol</a></td> <td>Final</td>
|
||||||
<tr> <td>302</td> <td class="left"><a href="zip-0302.rst">Standardized Memo Field Format</a></td> <td>Draft</td>
|
<tr> <td>302</td> <td class="left"><a href="zips/zip-0302.rst">Standardized Memo Field Format</a></td> <td>Draft</td>
|
||||||
<tr> <td><span class="reserved">303</span></td> <td class="left"><a class="reserved" href="zip-0303.rst">Sprout Payment Disclosure</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">303</span></td> <td class="left"><a class="reserved" href="zips/zip-0303.rst">Sprout Payment Disclosure</a></td> <td>Reserved</td>
|
||||||
<tr> <td>304</td> <td class="left"><a href="zip-0304.rst">Sapling Address Signatures</a></td> <td>Draft</td>
|
<tr> <td>304</td> <td class="left"><a href="zips/zip-0304.rst">Sapling Address Signatures</a></td> <td>Draft</td>
|
||||||
<tr> <td><span class="reserved">305</span></td> <td class="left"><a class="reserved" href="zip-0305.rst">Best Practices for Hardware Wallets supporting Sapling</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">305</span></td> <td class="left"><a class="reserved" href="zips/zip-0305.rst">Best Practices for Hardware Wallets supporting Sapling</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">306</span></td> <td class="left"><a class="reserved" href="zip-0306.rst">Security Considerations for Anchor Selection</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">306</span></td> <td class="left"><a class="reserved" href="zips/zip-0306.rst">Security Considerations for Anchor Selection</a></td> <td>Reserved</td>
|
||||||
<tr> <td>307</td> <td class="left"><a href="zip-0307.rst">Light Client Protocol for Payment Detection</a></td> <td>Draft</td>
|
<tr> <td>307</td> <td class="left"><a href="zips/zip-0307.rst">Light Client Protocol for Payment Detection</a></td> <td>Draft</td>
|
||||||
<tr> <td>308</td> <td class="left"><a href="zip-0308.rst">Sprout to Sapling Migration</a></td> <td>Final</td>
|
<tr> <td>308</td> <td class="left"><a href="zips/zip-0308.rst">Sprout to Sapling Migration</a></td> <td>Final</td>
|
||||||
<tr> <td><span class="reserved">309</span></td> <td class="left"><a class="reserved" href="zip-0309.rst">Blind Off-chain Lightweight Transactions (BOLT)</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">309</span></td> <td class="left"><a class="reserved" href="zips/zip-0309.rst">Blind Off-chain Lightweight Transactions (BOLT)</a></td> <td>Reserved</td>
|
||||||
<tr> <td>310</td> <td class="left"><a href="zip-0310.rst">Security Properties of Sapling Viewing Keys</a></td> <td>Draft</td>
|
<tr> <td>310</td> <td class="left"><a href="zips/zip-0310.rst">Security Properties of Sapling Viewing Keys</a></td> <td>Draft</td>
|
||||||
<tr> <td><span class="reserved">311</span></td> <td class="left"><a class="reserved" href="zip-0311.rst">Sapling Payment Disclosure</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">311</span></td> <td class="left"><a class="reserved" href="zips/zip-0311.rst">Sapling Payment Disclosure</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">312</span></td> <td class="left"><a class="reserved" href="zip-0312.rst">Shielded Multisignatures using FROST</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">312</span></td> <td class="left"><a class="reserved" href="zips/zip-0312.rst">Shielded Multisignatures using FROST</a></td> <td>Reserved</td>
|
||||||
<tr> <td><strike>313</strike></td> <td class="left"><strike><a href="zip-0313.rst">Reduce Conventional Transaction Fee to 1000 zatoshis</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>313</strike></td> <td class="left"><strike><a href="zips/zip-0313.rst">Reduce Conventional Transaction Fee to 1000 zatoshis</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><span class="reserved">314</span></td> <td class="left"><a class="reserved" href="zip-0314.rst">Privacy upgrades to the Zcash light client protocol</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">314</span></td> <td class="left"><a class="reserved" href="zips/zip-0314.rst">Privacy upgrades to the Zcash light client protocol</a></td> <td>Reserved</td>
|
||||||
<tr> <td>315</td> <td class="left"><a href="zip-0315.rst">Best Practices for Wallet Implementations</a></td> <td>Draft</td>
|
<tr> <td>315</td> <td class="left"><a href="zips/zip-0315.rst">Best Practices for Wallet Implementations</a></td> <td>Draft</td>
|
||||||
<tr> <td>316</td> <td class="left"><a href="zip-0316.rst">Unified Addresses and Unified Viewing Keys</a></td> <td>Revision 0: Final, Revision 1: Proposed</td>
|
<tr> <td>316</td> <td class="left"><a href="zips/zip-0316.rst">Unified Addresses and Unified Viewing Keys</a></td> <td>Revision 0: Final, Revision 1: Proposed</td>
|
||||||
<tr> <td>317</td> <td class="left"><a href="zip-0317.rst">Proportional Transfer Fee Mechanism</a></td> <td>Active</td>
|
<tr> <td>317</td> <td class="left"><a href="zips/zip-0317.rst">Proportional Transfer Fee Mechanism</a></td> <td>Active</td>
|
||||||
<tr> <td><span class="reserved">318</span></td> <td class="left"><a class="reserved" href="zip-0318.rst">Associated Payload Encryption</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">318</span></td> <td class="left"><a class="reserved" href="zips/zip-0318.rst">Associated Payload Encryption</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">319</span></td> <td class="left"><a class="reserved" href="zip-0319.rst">Options for Shielded Pool Retirement</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">319</span></td> <td class="left"><a class="reserved" href="zips/zip-0319.rst">Options for Shielded Pool Retirement</a></td> <td>Reserved</td>
|
||||||
<tr> <td>320</td> <td class="left"><a href="zip-0320.rst">Defining an Address Type to which funds can only be sent from Transparent Addresses</a></td> <td>Proposed</td>
|
<tr> <td>320</td> <td class="left"><a href="zips/zip-0320.rst">Defining an Address Type to which funds can only be sent from Transparent Addresses</a></td> <td>Proposed</td>
|
||||||
<tr> <td>321</td> <td class="left"><a href="zip-0321.rst">Payment Request URIs</a></td> <td>Proposed</td>
|
<tr> <td>321</td> <td class="left"><a href="zips/zip-0321.rst">Payment Request URIs</a></td> <td>Proposed</td>
|
||||||
<tr> <td><span class="reserved">322</span></td> <td class="left"><a class="reserved" href="zip-0322.rst">Generic Signed Message Format</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">322</span></td> <td class="left"><a class="reserved" href="zips/zip-0322.rst">Generic Signed Message Format</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">323</span></td> <td class="left"><a class="reserved" href="zip-0323.rst">Specification of getblocktemplate for Zcash</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">323</span></td> <td class="left"><a class="reserved" href="zips/zip-0323.rst">Specification of getblocktemplate for Zcash</a></td> <td>Reserved</td>
|
||||||
<tr> <td>324</td> <td class="left"><a href="zip-0324.rst">URI-Encapsulated Payments</a></td> <td>Draft</td>
|
<tr> <td>324</td> <td class="left"><a href="zips/zip-0324.rst">URI-Encapsulated Payments</a></td> <td>Draft</td>
|
||||||
<tr> <td><span class="reserved">332</span></td> <td class="left"><a class="reserved" href="zip-0332.rst">Wallet Recovery from zcashd HD Seeds</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">332</span></td> <td class="left"><a class="reserved" href="zips/zip-0332.rst">Wallet Recovery from zcashd HD Seeds</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">339</span></td> <td class="left"><a class="reserved" href="zip-0339.rst">Wallet Recovery Words</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">339</span></td> <td class="left"><a class="reserved" href="zips/zip-0339.rst">Wallet Recovery Words</a></td> <td>Reserved</td>
|
||||||
<tr> <td>400</td> <td class="left"><a href="zip-0400.rst">Wallet.dat format</a></td> <td>Draft</td>
|
<tr> <td>400</td> <td class="left"><a href="zips/zip-0400.rst">Wallet.dat format</a></td> <td>Draft</td>
|
||||||
<tr> <td>401</td> <td class="left"><a href="zip-0401.rst">Addressing Mempool Denial-of-Service</a></td> <td>Active</td>
|
<tr> <td>401</td> <td class="left"><a href="zips/zip-0401.rst">Addressing Mempool Denial-of-Service</a></td> <td>Active</td>
|
||||||
<tr> <td><span class="reserved">402</span></td> <td class="left"><a class="reserved" href="zip-0402.rst">New Wallet Database Format</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">402</span></td> <td class="left"><a class="reserved" href="zips/zip-0402.rst">New Wallet Database Format</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">403</span></td> <td class="left"><a class="reserved" href="zip-0403.rst">Verification Behaviour of zcashd</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">403</span></td> <td class="left"><a class="reserved" href="zips/zip-0403.rst">Verification Behaviour of zcashd</a></td> <td>Reserved</td>
|
||||||
<tr> <td><span class="reserved">416</span></td> <td class="left"><a class="reserved" href="zip-0416.rst">Support for Unified Addresses in zcashd</a></td> <td>Reserved</td>
|
<tr> <td><span class="reserved">416</span></td> <td class="left"><a class="reserved" href="zips/zip-0416.rst">Support for Unified Addresses in zcashd</a></td> <td>Reserved</td>
|
||||||
<tr> <td><strike>1001</strike></td> <td class="left"><strike><a href="zip-1001.rst">Keep the Block Distribution as Initially Defined — 90% to Miners</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1001</strike></td> <td class="left"><strike><a href="zips/zip-1001.rst">Keep the Block Distribution as Initially Defined — 90% to Miners</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1002</strike></td> <td class="left"><strike><a href="zip-1002.rst">Opt-in Donation Feature</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1002</strike></td> <td class="left"><strike><a href="zips/zip-1002.rst">Opt-in Donation Feature</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1003</strike></td> <td class="left"><strike><a href="zip-1003.rst">20% Split Evenly Between the ECC and the Zcash Foundation, and a Voting System Mandate</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1003</strike></td> <td class="left"><strike><a href="zips/zip-1003.rst">20% Split Evenly Between the ECC and the Zcash Foundation, and a Voting System Mandate</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1004</strike></td> <td class="left"><strike><a href="zip-1004.rst">Miner-Directed Dev Fund</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1004</strike></td> <td class="left"><strike><a href="zips/zip-1004.rst">Miner-Directed Dev Fund</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1005</strike></td> <td class="left"><strike><a href="zip-1005.rst">Zcash Community Funding System</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1005</strike></td> <td class="left"><strike><a href="zips/zip-1005.rst">Zcash Community Funding System</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1006</strike></td> <td class="left"><strike><a href="zip-1006.rst">Development Fund of 10% to a 2-of-3 Multisig with Community-Involved Third Entity</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1006</strike></td> <td class="left"><strike><a href="zips/zip-1006.rst">Development Fund of 10% to a 2-of-3 Multisig with Community-Involved Third Entity</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1007</strike></td> <td class="left"><strike><a href="zip-1007.rst">Enforce Development Fund Commitments with a Legal Charter</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1007</strike></td> <td class="left"><strike><a href="zips/zip-1007.rst">Enforce Development Fund Commitments with a Legal Charter</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1008</strike></td> <td class="left"><strike><a href="zip-1008.rst">Fund ECC for Two More Years</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1008</strike></td> <td class="left"><strike><a href="zips/zip-1008.rst">Fund ECC for Two More Years</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1009</strike></td> <td class="left"><strike><a href="zip-1009.rst">Five-Entity Strategic Council</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1009</strike></td> <td class="left"><strike><a href="zips/zip-1009.rst">Five-Entity Strategic Council</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1010</strike></td> <td class="left"><strike><a href="zip-1010.rst">Compromise Dev Fund Proposal With Diverse Funding Streams</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1010</strike></td> <td class="left"><strike><a href="zips/zip-1010.rst">Compromise Dev Fund Proposal With Diverse Funding Streams</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1011</strike></td> <td class="left"><strike><a href="zip-1011.rst">Decentralize the Dev Fee</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1011</strike></td> <td class="left"><strike><a href="zips/zip-1011.rst">Decentralize the Dev Fee</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1012</strike></td> <td class="left"><strike><a href="zip-1012.rst">Dev Fund to ECC + ZF + Major Grants</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1012</strike></td> <td class="left"><strike><a href="zips/zip-1012.rst">Dev Fund to ECC + ZF + Major Grants</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td><strike>1013</strike></td> <td class="left"><strike><a href="zip-1013.rst">Keep It Simple, Zcashers: 10% to ECC, 10% to ZF</a></strike></td> <td>Obsolete</td>
|
<tr> <td><strike>1013</strike></td> <td class="left"><strike><a href="zips/zip-1013.rst">Keep It Simple, Zcashers: 10% to ECC, 10% to ZF</a></strike></td> <td>Obsolete</td>
|
||||||
<tr> <td>1014</td> <td class="left"><a href="zip-1014.rst">Establishing a Dev Fund for ECC, ZF, and Major Grants</a></td> <td>Active</td>
|
<tr> <td>1014</td> <td class="left"><a href="zips/zip-1014.rst">Establishing a Dev Fund for ECC, ZF, and Major Grants</a></td> <td>Active</td>
|
||||||
<tr> <td>guide-markdown</td> <td class="left"><a href="zip-guide-markdown.md">{Something Short and To the Point}</a></td> <td>Draft</td>
|
<tr> <td>guide-markdown</td> <td class="left"><a href="zips/zip-guide-markdown.md">{Something Short and To the Point}</a></td> <td>Draft</td>
|
||||||
<tr> <td>guide</td> <td class="left"><a href="zip-guide.rst">{Something Short and To the Point}</a></td> <td>Draft</td>
|
<tr> <td>guide</td> <td class="left"><a href="zips/zip-guide.rst">{Something Short and To the Point}</a></td> <td>Draft</td>
|
||||||
</table></embed>
|
</table></embed>
|
||||||
|
|
||||||
Drafts without assigned ZIP numbers
|
Drafts without assigned ZIP numbers
|
||||||
|
|
@ -162,9 +162,9 @@ be deleted.
|
||||||
|
|
||||||
<embed><table>
|
<embed><table>
|
||||||
<tr> <th>Title</th> </tr>
|
<tr> <th>Title</th> </tr>
|
||||||
<tr> <td class="left"><a href="draft-hopwood-coinbase-balance.rst">Blocks should balance exactly</a></td>
|
<tr> <td class="left"><a href="zips/draft-hopwood-coinbase-balance.rst">Blocks should balance exactly</a></td>
|
||||||
<tr> <td class="left"><a href="draft-noamchom67-manufacturing-consent.rst">Manufacturing Consent; Re-Establishing a Dev Fund for ECC, ZF, ZCG, Qedit, FPF, and ZecHub</a></td>
|
<tr> <td class="left"><a href="zips/draft-noamchom67-manufacturing-consent.rst">Manufacturing Consent; Re-Establishing a Dev Fund for ECC, ZF, ZCG, Qedit, FPF, and ZecHub</a></td>
|
||||||
<tr> <td class="left"><a href="draft-nuttycom-funding-allocation.rst">Block Reward Allocation for Non-Direct Development Funding</a></td>
|
<tr> <td class="left"><a href="zips/draft-nuttycom-funding-allocation.rst">Block Reward Allocation for Non-Direct Development Funding</a></td>
|
||||||
<tr> <td class="left"><a href="draft-nuttycom-lockbox-streams.rst">Lockbox Funding Streams</a></td>
|
<tr> <td class="left"><a href="zips/draft-nuttycom-lockbox-streams.rst">Lockbox Funding Streams</a></td>
|
||||||
<tr> <td class="left"><a href="draft-zf-community-dev-fund-2-proposal.rst">Establishing a Hybrid Dev Fund for ZF, ZCG and a Dev Fund Reserve</a></td>
|
<tr> <td class="left"><a href="zips/draft-zf-community-dev-fund-2-proposal.rst">Establishing a Hybrid Dev Fund for ZF, ZCG and a Dev Fund Reserve</a></td>
|
||||||
</table></embed>
|
</table></embed>
|
||||||
|
|
|
||||||
|
|
@ -28,11 +28,11 @@ Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
|
||||||
|
|
||||||
The Zcash protocol is documented in its `Protocol Specification <rendered/protocol/protocol.pdf>`__.
|
The Zcash protocol is documented in its `Protocol Specification <rendered/protocol/protocol.pdf>`__.
|
||||||
|
|
||||||
To start contributing, first read `ZIP 0 <zip-0000.rst>`__ which documents the ZIP process.
|
To start contributing, first read `ZIP 0 <zips/zip-0000.rst>`__ which documents the ZIP process.
|
||||||
Then clone `this repo <https://github.com/zcash/zips>`__ from GitHub, and start adding
|
Then clone `this repo <https://github.com/zcash/zips>`__ 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
|
Use ``make`` to check that you are using correct
|
||||||
`reStructuredText <https://docutils.sourceforge.io/rst.html>`__ or
|
`reStructuredText <https://docutils.sourceforge.io/rst.html>`__ or
|
||||||
`Markdown <https://pandoc.org/MANUAL.html#pandocs-markdown>`__ syntax,
|
`Markdown <https://pandoc.org/MANUAL.html#pandocs-markdown>`__ syntax,
|
||||||
|
|
|
||||||
|
|
@ -37,8 +37,9 @@ sed -i.sedbak 's|<a \(class=[^ ]* \)*href="\([^":]*\)\.rst\(\#[^"]*\)*">|<a \1hr
|
||||||
sed -i.sedbak 's|<a \(class=[^ ]* \)*href="\([^":]*\)\.md\(\#[^"]*\)*">|<a \1href="\2\3">|g' "$2"
|
sed -i.sedbak 's|<a \(class=[^ ]* \)*href="\([^":]*\)\.md\(\#[^"]*\)*">|<a \1href="\2\3">|g' "$2"
|
||||||
sed -i.sedbak 's|<\(https:[^&]*\)>|\<<a href="\1">\1</a>\>|g' "$2"
|
sed -i.sedbak 's|<\(https:[^&]*\)>|\<<a href="\1">\1</a>\>|g' "$2"
|
||||||
|
|
||||||
sed -i.sedbak 's|src="rendered/|src="|g' "$2"
|
sed -i.sedbak 's|src="../rendered/|src="|g' "$2"
|
||||||
sed -i.sedbak 's|<a href="rendered/|<a href="|g' "$2"
|
sed -i.sedbak 's|<a href="rendered/|<a href="|g' "$2"
|
||||||
|
sed -i.sedbak 's|<a \(class=[^ ]* \)*href="zips/|<a \1href="|g' "$2"
|
||||||
|
|
||||||
perl -i.sedbak -p0e 's|<section id="([^"]*)">\s*.?\s*<h([1-9])>([^<]*(?:<code>[^<]*</code>[^<]*)?)</h([1-9])>|<section id="\1"><h\2><span class="section-heading">\3</span><span class="section-anchor"> <a rel="bookmark" href="#\1"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h\4>|g' "$2"
|
perl -i.sedbak -p0e 's|<section id="([^"]*)">\s*.?\s*<h([1-9])>([^<]*(?:<code>[^<]*</code>[^<]*)?)</h([1-9])>|<section id="\1"><h\2><span class="section-heading">\3</span><span class="section-anchor"> <a rel="bookmark" href="#\1"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h\4>|g' "$2"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -11,6 +11,7 @@ Index of ZIPs
|
||||||
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
|
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
|
||||||
EndOfHeader
|
EndOfHeader
|
||||||
for zipfile in $(cat .zipfilelist.current); do
|
for zipfile in $(cat .zipfilelist.current); do
|
||||||
|
zipfile=zips/$zipfile
|
||||||
echo Adding $zipfile to index. >/dev/stderr
|
echo Adding $zipfile to index. >/dev/stderr
|
||||||
if grep -E '^\s*Status:\s*Reserved' $zipfile >/dev/null; then
|
if grep -E '^\s*Status:\s*Reserved' $zipfile >/dev/null; then
|
||||||
echo " <tr> <td><span class=\"reserved\">`basename $(basename $zipfile .rst) .md | sed -E 's@zip-0{0,3}@@'`</span></td> <td class=\"left\"><a class=\"reserved\" href=\"`echo $zipfile`\">`grep '^\s*Title:' $zipfile | sed -E 's@\s*Title:\s*@@'`</a></td> <td>`grep '^\s*Status:' $zipfile | sed -E 's@\s*Status:\s*@@'`</td>"
|
echo " <tr> <td><span class=\"reserved\">`basename $(basename $zipfile .rst) .md | sed -E 's@zip-0{0,3}@@'`</span></td> <td class=\"left\"><a class=\"reserved\" href=\"`echo $zipfile`\">`grep '^\s*Title:' $zipfile | sed -E 's@\s*Title:\s*@@'`</a></td> <td>`grep '^\s*Status:' $zipfile | sed -E 's@\s*Status:\s*@@'`</td>"
|
||||||
|
|
@ -40,6 +41,7 @@ be deleted.
|
||||||
<tr> <th>Title</th> </tr>
|
<tr> <th>Title</th> </tr>
|
||||||
EndOfDraftHeader
|
EndOfDraftHeader
|
||||||
for draftfile in $(cat .draftfilelist.current); do
|
for draftfile in $(cat .draftfilelist.current); do
|
||||||
|
draftfile=zips/$draftfile
|
||||||
echo Adding $draftfile to index of drafts. >/dev/stderr
|
echo Adding $draftfile to index of drafts. >/dev/stderr
|
||||||
echo " <tr> <td class=\"left\"><a href=\"`echo $draftfile`\">`grep '^\s*Title:' $draftfile | sed -E 's@\s*Title:\s*@@'`</a></td>"
|
echo " <tr> <td class=\"left\"><a href=\"`echo $draftfile`\">`grep '^\s*Title:' $draftfile | sed -E 's@\s*Title:\s*@@'`</a></td>"
|
||||||
done
|
done
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,8 @@
|
||||||
<p>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 <a href="https://discord.gg/kdjfvps">ZcashCommunity Discord chat</a> to talk about your idea.</p>
|
<p>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 <a href="https://discord.gg/kdjfvps">ZcashCommunity Discord chat</a> to talk about your idea.</p>
|
||||||
<p>Participation in the Zcash project is subject to a <a href="https://github.com/zcash/zcash/blob/master/code_of_conduct.md">Code of Conduct</a>.</p>
|
<p>Participation in the Zcash project is subject to a <a href="https://github.com/zcash/zcash/blob/master/code_of_conduct.md">Code of Conduct</a>.</p>
|
||||||
<p>The Zcash protocol is documented in its <a href="protocol/protocol.pdf">Protocol Specification</a>.</p>
|
<p>The Zcash protocol is documented in its <a href="protocol/protocol.pdf">Protocol Specification</a>.</p>
|
||||||
<p>To start contributing, first read <a href="zip-0000">ZIP 0</a> which documents the ZIP process. Then clone <a href="https://github.com/zcash/zips">this repo</a> from GitHub, and start adding your draft ZIP, formatted either as reStructuredText or as Markdown.</p>
|
<p>To start contributing, first read <a href="zip-0000">ZIP 0</a> which documents the ZIP process. Then clone <a href="https://github.com/zcash/zips">this repo</a> from GitHub, and start adding your draft ZIP, formatted either as reStructuredText or as Markdown, into the <cite>zips/</cite> directory.</p>
|
||||||
<p>For example, if using reStructuredText, use a filename matching <code>draft-*.rst</code>. Use <code>make</code> to check that you are using correct <a href="https://docutils.sourceforge.io/rst.html">reStructuredText</a> or <a href="https://pandoc.org/MANUAL.html#pandocs-markdown">Markdown</a> syntax, and double-check the generated <code>rendered/draft-*.html</code> file before filing a Pull Request. See <a href="protocol/README">here</a> for the project dependencies.</p>
|
<p>For example, if using reStructuredText, use a filename matching <code>zips/draft-*.rst</code>. Use <code>make</code> to check that you are using correct <a href="https://docutils.sourceforge.io/rst.html">reStructuredText</a> or <a href="https://pandoc.org/MANUAL.html#pandocs-markdown">Markdown</a> syntax, and double-check the generated <code>rendered/draft-*.html</code> file before filing a Pull Request. See <a href="protocol/README">here</a> for the project dependencies.</p>
|
||||||
</section>
|
</section>
|
||||||
<section id="license"><h2><span class="section-heading">License</span><span class="section-anchor"> <a rel="bookmark" href="#license"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h2>
|
<section id="license"><h2><span class="section-heading">License</span><span class="section-anchor"> <a rel="bookmark" href="#license"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h2>
|
||||||
<p>Unless otherwise stated in this repository’s individual files, the contents of this repository are released under the terms of the MIT license. See <a href="COPYING">COPYING</a> for more information or see <a href="https://opensource.org/licenses/MIT">https://opensource.org/licenses/MIT</a> .</p>
|
<p>Unless otherwise stated in this repository’s individual files, the contents of this repository are released under the terms of the MIT license. See <a href="COPYING">COPYING</a> for more information or see <a href="https://opensource.org/licenses/MIT">https://opensource.org/licenses/MIT</a> .</p>
|
||||||
|
|
|
||||||
|
|
@ -76,21 +76,21 @@ Pull-Request: <<a href="https://github.com/zcash/zips/pull/607">https://githu
|
||||||
<p>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.</p>
|
<p>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.</p>
|
||||||
<p>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</p>
|
<p>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</p>
|
||||||
<div>
|
<div>
|
||||||
<h1>System Message: ERROR/3 (zip-0315.rst line 136)</h1>
|
<h1>System Message: ERROR/3 (zips/zip-0315.rst line 136)</h1>
|
||||||
<p>Unexpected indentation.</p>
|
<p>Unexpected indentation.</p>
|
||||||
</div>
|
</div>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>other;</p>
|
<p>other;</p>
|
||||||
</blockquote>
|
</blockquote>
|
||||||
<div>
|
<div>
|
||||||
<h1>System Message: WARNING/2 (zip-0315.rst line 137)</h1>
|
<h1>System Message: WARNING/2 (zips/zip-0315.rst line 137)</h1>
|
||||||
<p>Block quote ends without a blank line; unexpected unindent.</p>
|
<p>Block quote ends without a blank line; unexpected unindent.</p>
|
||||||
</div>
|
</div>
|
||||||
<ol suffix=")" start="2" type="a">
|
<ol suffix=")" start="2" type="a">
|
||||||
<li>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).</li>
|
<li>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).</li>
|
||||||
</ol>
|
</ol>
|
||||||
<div>
|
<div>
|
||||||
<h1>System Message: INFO/1 (zip-0315.rst line 123)</h1>
|
<h1>System Message: INFO/1 (zips/zip-0315.rst line 123)</h1>
|
||||||
<p>Enumerated list start value not ordinal-1: "b" (ordinal 2)</p>
|
<p>Enumerated list start value not ordinal-1: "b" (ordinal 2)</p>
|
||||||
</div>
|
</div>
|
||||||
<p>Despite the fact that it is not possible to achieve strong privacy guarantees from <em>any</em> 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.</p>
|
<p>Despite the fact that it is not possible to achieve strong privacy guarantees from <em>any</em> 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.</p>
|
||||||
|
|
@ -167,14 +167,14 @@ Pull-Request: <<a href="https://github.com/zcash/zips/pull/607">https://githu
|
||||||
<section id="sent-transactions"><h4><span class="section-heading">Sent transactions</span><span class="section-anchor"> <a rel="bookmark" href="#sent-transactions"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h4>
|
<section id="sent-transactions"><h4><span class="section-heading">Sent transactions</span><span class="section-anchor"> <a rel="bookmark" href="#sent-transactions"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h4>
|
||||||
<p>A transaction is sent if it was either: * created by the wallet, or * detected by using the wallet's outgoing viewing keys to decrypt</p>
|
<p>A transaction is sent if it was either: * created by the wallet, or * detected by using the wallet's outgoing viewing keys to decrypt</p>
|
||||||
<div>
|
<div>
|
||||||
<h1>System Message: ERROR/3 (zip-0315.rst line 308)</h1>
|
<h1>System Message: ERROR/3 (zips/zip-0315.rst line 308)</h1>
|
||||||
<p>Unexpected indentation.</p>
|
<p>Unexpected indentation.</p>
|
||||||
</div>
|
</div>
|
||||||
<blockquote>
|
<blockquote>
|
||||||
<p>Sapling or Orchard outputs, or</p>
|
<p>Sapling or Orchard outputs, or</p>
|
||||||
</blockquote>
|
</blockquote>
|
||||||
<div>
|
<div>
|
||||||
<h1>System Message: WARNING/2 (zip-0315.rst line 309)</h1>
|
<h1>System Message: WARNING/2 (zips/zip-0315.rst line 309)</h1>
|
||||||
<p>Block quote ends without a blank line; unexpected unindent.</p>
|
<p>Block quote ends without a blank line; unexpected unindent.</p>
|
||||||
</div>
|
</div>
|
||||||
<ul>
|
<ul>
|
||||||
|
|
@ -401,15 +401,15 @@ Pull-Request: <<a href="https://github.com/zcash/zips/pull/607">https://githu
|
||||||
<section class="system-messages">
|
<section class="system-messages">
|
||||||
<h1>Docutils System Messages</h1>
|
<h1>Docutils System Messages</h1>
|
||||||
<div id="system-message-1">
|
<div id="system-message-1">
|
||||||
<h1>System Message: ERROR/3 (zip-0315.rst line 65)</h1>
|
<h1>System Message: ERROR/3 (zips/zip-0315.rst line 65)</h1>
|
||||||
<p>Too many autonumbered footnote references: only 0 corresponding footnotes available.</p>
|
<p>Too many autonumbered footnote references: only 0 corresponding footnotes available.</p>
|
||||||
</div>
|
</div>
|
||||||
<div id="system-message-2">
|
<div id="system-message-2">
|
||||||
<h1>System Message: ERROR/3 (zip-0315.rst line 65) <a href="#footnote-reference-2">footnote-reference-2</a></h1>
|
<h1>System Message: ERROR/3 (zips/zip-0315.rst line 65) <a href="#footnote-reference-2">footnote-reference-2</a></h1>
|
||||||
<p>Unknown target name: "zip-0032".</p>
|
<p>Unknown target name: "zip-0032".</p>
|
||||||
</div>
|
</div>
|
||||||
<div id="system-message-3">
|
<div id="system-message-3">
|
||||||
<h1>System Message: ERROR/3 (zip-0315.rst line 65) <a href="#footnote-reference-3">footnote-reference-3</a></h1>
|
<h1>System Message: ERROR/3 (zips/zip-0315.rst line 65) <a href="#footnote-reference-3">footnote-reference-3</a></h1>
|
||||||
<p>Unknown target name: "zip-0316".</p>
|
<p>Unknown target name: "zip-0316".</p>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 83 KiB |
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 89 KiB |
|
|
@ -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
|
a full viewing key, and deriving the corresponding spending key. Both of these derivations
|
||||||
are shown in the following diagram:
|
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
|
:width: 900px
|
||||||
:align: center
|
:align: center
|
||||||
:figclass: 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
|
fields being derived, as specified in [#protocol-orchardkeycomponents]_ and shown in the following
|
||||||
diagram:
|
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
|
:width: 720px
|
||||||
:align: center
|
:align: center
|
||||||
:figclass: align-center
|
:figclass: align-center
|
||||||
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
|
|
@ -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:
|
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
|
:width: 450px
|
||||||
:align: center
|
:align: center
|
||||||
:figclass: 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:
|
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
|
:width: 600px
|
||||||
:align: center
|
:align: center
|
||||||
:figclass: align-center
|
:figclass: align-center
|
||||||
|
|
@ -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
|
update its own view of the chain state. The light client MAY be attached to a wallet
|
||||||
backend that will track particular Sapling notes.
|
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
|
:align: center
|
||||||
:figclass: align-center
|
:figclass: align-center
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 86 KiB |
|
|
@ -1088,7 +1088,7 @@ concatenation of
|
||||||
:math:`\mathsf{I2LEOSP}_{16}(j), u) \text{ for } j \text{ from}`
|
:math:`\mathsf{I2LEOSP}_{16}(j), u) \text{ for } j \text{ from}`
|
||||||
:math:`0 \text{ up to } \mathsf{ceiling}(\ell_R/\ell_H)-1].`
|
: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
|
:width: 372px
|
||||||
:align: center
|
:align: center
|
||||||
:figclass: align-center
|
:figclass: align-center
|
||||||
|
|
@ -1158,7 +1158,7 @@ Heuristic analysis
|
||||||
|
|
||||||
A 3-round unkeyed Feistel, as shown, is not sufficient:
|
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
|
:width: 372px
|
||||||
:align: center
|
:align: center
|
||||||
:figclass: align-center
|
:figclass: align-center
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue