Skip to content

Commit 998a97f

Browse files
conradoplgconradoplg
authored
Merge pull request zcash#963 from daira/use-multimarkdown
Use MultiMarkdown
2 parents f3d5eb0 + 2bbe652 commit 998a97f

17 files changed

+1762
-1688
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,7 @@
2626
.zipfilelist.*
2727
.draftfilelist.*
2828

29+
MultiMarkdown-6
30+
2931
protocol/aux/
3032
protocol/protocol.ver

‎Dockerfile

+7-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ FROM debian:latest
22

33
RUN apt-get update
44
RUN apt-get install -y \
5-
gawk \
65
perl \
76
sed \
87
git \
8+
cmake \
99
python3 \
1010
python3-pip \
1111
pandoc \
@@ -18,7 +18,12 @@ RUN apt-get install -y \
1818
texlive-bibtex-extra
1919

2020
RUN rm /usr/lib/python3.11/EXTERNALLY-MANAGED
21-
RUN pip install rst2html5
21+
RUN pip install 'docutils==0.21.2' 'rst2html5==2.0.1'
22+
23+
RUN git config --global --add safe.directory /zips
24+
25+
# Use a fork so that we're running pinned code.
26+
RUN git clone -b develop https://github.com/Electric-Coin-Company/MultiMarkdown-6 && cd MultiMarkdown-6 && make release && cd build && make && make install
2227

2328
ENV PATH=${PATH}:/root/.local/bin
2429

‎Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Dependencies: see zip-guide.rst and protocol/README.rst
1+
# Dependencies: see zips/zip-guide.rst and protocol/README.rst
22

3-
MARKDOWN_OPTION?=--pandoc
3+
MARKDOWN_OPTION?=--mmd
44

55
.PHONY: all-zips all tag-release protocol all-protocol discard
66
all-zips: .Makefile.uptodate

‎protocol/README.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Build dependencies on Debian-based systems include, at least:
66

77
.. code::
88
9-
apt install python3-pip pandoc perl sed perl \
9+
apt install python3-pip perl sed cmake \
1010
texlive texlive-science texlive-fonts-extra texlive-bibtex-extra biber latexmk
1111
1212
Prior to Bullseye you may also need the ``awk`` and ``texlive-generic-recommended``
@@ -16,7 +16,7 @@ For link checking, you will also need the following Python packages:
1616

1717
.. code::
1818
19-
pip3 install docutils==0.19 rst2html5 certifi PyPDF2
19+
pip3 install 'docutils==0.21.2' 'rst2html5==2.0.1' certifi PyPDF2
2020
2121
2222
Building

‎render.sh

+2-1
Original file line numberDiff line numberDiff line change
@@ -86,5 +86,6 @@ cat <(
8686
s|<a href="rendered/|<a href="|g;
8787
s|<a \(class=[^ ]* \)*href="zips/|<a \1href="|g' \
8888
| perl -p0e \
89-
'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' \
89+
'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;
90+
s|<h([1-9]) id="([^"]*)">([^<]*(?:<code>[^<]*</code>[^<]*)?)</h([1-9])>|<h\1 id="\2"><span class="section-heading">\3</span><span class="section-anchor"> <a rel="bookmark" href="#\2"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h\4>|g;' \
9091
> "${outputfile}"

‎rendered/css/style.css

+3-3
Original file line numberDiff line numberDiff line change
@@ -334,11 +334,11 @@ span.section-heading:hover + span {
334334
opacity: 1;
335335
}
336336

337-
a.footnote_reference::before, a.footnote-ref::before {
337+
a.footnote_reference::before, a.footnote-ref::before, a.footnote::before {
338338
content: "[";
339339
}
340340

341-
a.footnote_reference::after, a.footnote-ref::after {
341+
a.footnote_reference::after, a.footnote-ref::after, a.footnote::after {
342342
content: "]";
343343
}
344344

@@ -369,7 +369,7 @@ a.footnote_reference::after, a.footnote-ref::after {
369369
/* }}} rst-specific */
370370

371371
/* {{{ md-specific */
372-
a.footnote-ref sup {
372+
a.footnote-ref sup, a.footnote sup {
373373
vertical-align: baseline;
374374
font-size: 100%;
375375
}

‎rendered/zip-0231.html

+594-592
Large diffs are not rendered by default.

‎rendered/zip-0233.html

+209-203
Large diffs are not rendered by default.

‎rendered/zip-0234.html

+265-250
Large diffs are not rendered by default.

‎rendered/zip-0235.html

+191-191
Large diffs are not rendered by default.

‎rendered/zip-0253.html

+102-121
Original file line numberDiff line numberDiff line change
@@ -13,139 +13,120 @@
1313
Category: Consensus / Network
1414
Created: 2024-07-17
1515
License: MIT
16-
Discussions-To: &lt;<a href="https://github.com/zcash/zips/issues/806">https://github.com/zcash/zips/issues/806</a>&gt;</code></pre>
17-
<h1 id="terminology">Terminology</h1>
18-
<p>The key word “MUST” in this document are to be interpreted as
19-
described in BCP 14 <a href="#fn1" class="footnote-ref" id="fnref1"
20-
role="doc-noteref"><sup>1</sup></a> when, and only when, they appear in
21-
all capitals.</p>
22-
<p>The term “network upgrade” in this document is to be interpreted as
23-
described in ZIP 200 <a href="#fn2" class="footnote-ref" id="fnref2"
24-
role="doc-noteref"><sup>2</sup></a>.</p>
25-
<p>The terms “Testnet” and “Mainnet” are to be interpreted as described
26-
in section 3.12 of the Zcash Protocol Specification <a href="#fn3"
27-
class="footnote-ref" id="fnref3"
28-
role="doc-noteref"><sup>3</sup></a>.</p>
29-
<h1 id="abstract">Abstract</h1>
16+
Discussions-To: &lt;<a href="https://github.com/zcash/zips/issues/806">https://github.com/zcash/zips/issues/806</a>&gt;
17+
</code></pre>
18+
19+
<h1 id="terminology"><span class="section-heading">Terminology</span><span class="section-anchor"> <a rel="bookmark" href="#terminology"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h1>
20+
21+
<p>The key word &#8220;MUST&#8221; in this document are to be interpreted as described in
22+
BCP 14 <a href="#fn:1" id="fnref:1" title="see footnote" class="footnote"><sup>1</sup></a> when, and only when, they appear in all capitals.</p>
23+
24+
<p>The term &#8220;network upgrade&#8221; in this document is to be interpreted as described in ZIP 200 <a href="#fn:2" id="fnref:2" title="see footnote" class="footnote"><sup>2</sup></a>.</p>
25+
26+
<p>The terms &#8220;Testnet&#8221; and &#8220;Mainnet&#8221; are to be interpreted as described in
27+
section 3.12 of the Zcash Protocol Specification <a href="#fn:3" id="fnref:3" title="see footnote" class="footnote"><sup>3</sup></a>.</p>
28+
29+
<h1 id="abstract"><span class="section-heading">Abstract</span><span class="section-anchor"> <a rel="bookmark" href="#abstract"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h1>
30+
3031
<p>This proposal defines the deployment of the NU6 network upgrade.</p>
31-
<h1 id="specification">Specification</h1>
32-
<h2 id="nu6-deployment">NU6 deployment</h2>
33-
<p>The primary sources of information about NU6 consensus protocol
34-
changes are:</p>
32+
33+
<h1 id="specification"><span class="section-heading">Specification</span><span class="section-anchor"> <a rel="bookmark" href="#specification"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h1>
34+
35+
<h2 id="nu6deployment"><span class="section-heading">NU6 deployment</span><span class="section-anchor"> <a rel="bookmark" href="#nu6deployment"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h2>
36+
37+
<p>The primary sources of information about NU6 consensus protocol changes are:</p>
38+
3539
<ul>
36-
<li>The Zcash Protocol Specification <a href="#fn4" class="footnote-ref"
37-
id="fnref4" role="doc-noteref"><sup>4</sup></a>.</li>
38-
<li>ZIP 200: Network Upgrade Mechanism <a href="#fn5"
39-
class="footnote-ref" id="fnref5"
40-
role="doc-noteref"><sup>5</sup></a>.</li>
41-
<li>ZIP 236: Blocks should balance exactly <a href="#fn6"
42-
class="footnote-ref" id="fnref6"
43-
role="doc-noteref"><sup>6</sup></a>.</li>
44-
<li>ZIP 1015: Block Reward Allocation for Non-Direct Development Funding
45-
<a href="#fn7" class="footnote-ref" id="fnref7"
46-
role="doc-noteref"><sup>7</sup></a>.</li>
47-
<li>ZIP 2001: Lockbox Funding Streams <a href="#fn8"
48-
class="footnote-ref" id="fnref8"
49-
role="doc-noteref"><sup>8</sup></a>.</li>
40+
<li>The Zcash Protocol Specification <a href="#fn:4" id="fnref:4" title="see footnote" class="footnote"><sup>4</sup></a>.</li>
41+
<li>ZIP 200: Network Upgrade Mechanism <a href="#fn:2" title="see footnote" class="footnote"><sup>2</sup></a>.</li>
42+
<li>ZIP 236: Blocks should balance exactly <a href="#fn:5" id="fnref:5" title="see footnote" class="footnote"><sup>5</sup></a>.</li>
43+
<li>ZIP 1015: Block Reward Allocation for Non-Direct Development Funding <a href="#fn:6" id="fnref:6" title="see footnote" class="footnote"><sup>6</sup></a>.</li>
44+
<li>ZIP 2001: Lockbox Funding Streams <a href="#fn:7" id="fnref:7" title="see footnote" class="footnote"><sup>7</sup></a>.</li>
5045
</ul>
51-
<p>The network handshake and peer management mechanisms defined in ZIP
52-
201 <a href="#fn9" class="footnote-ref" id="fnref9"
53-
role="doc-noteref"><sup>9</sup></a> also apply to this upgrade.</p>
54-
<p>The following ZIPs have been updated in varying degrees to take into
55-
account NU6:</p>
46+
47+
<p>The network handshake and peer management mechanisms defined in ZIP 201 <a href="#fn:8" id="fnref:8" title="see footnote" class="footnote"><sup>8</sup></a> also apply to this upgrade.</p>
48+
49+
<p>The following ZIPs have been updated in varying degrees to take into account NU6:</p>
50+
5651
<ul>
57-
<li>ZIP 207: Funding Streams <a href="#fn10" class="footnote-ref"
58-
id="fnref10" role="doc-noteref"><sup>10</sup></a>.</li>
59-
<li>ZIP 214: Consensus rules for a Zcash Development Fund <a
60-
href="#fn11" class="footnote-ref" id="fnref11"
61-
role="doc-noteref"><sup>11</sup></a>.</li>
52+
<li>ZIP 207: Funding Streams <a href="#fn:9" id="fnref:9" title="see footnote" class="footnote"><sup>9</sup></a>.</li>
53+
<li>ZIP 214: Consensus rules for a Zcash Development Fund <a href="#fn:10" id="fnref:10" title="see footnote" class="footnote"><sup>10</sup></a>.</li>
6254
</ul>
63-
<p>The following network upgrade constants <a href="#fn12"
64-
class="footnote-ref" id="fnref12" role="doc-noteref"><sup>12</sup></a>
65-
are defined for the NU6 upgrade:</p>
55+
56+
<p>The following network upgrade constants <a href="#fn:2" title="see footnote" class="footnote"><sup>2</sup></a> are defined for the NU6 upgrade:</p>
57+
6658
<dl>
6759
<dt>CONSENSUS_BRANCH_ID</dt>
68-
<dd>
69-
<code>0xC8E71055</code>
70-
</dd>
60+
<dd><code>0xC8E71055</code></dd>
61+
7162
<dt>ACTIVATION_HEIGHT (NU6)</dt>
72-
<dd>
73-
Testnet: 2976000
74-
</dd>
75-
<dd>
76-
Mainnet: 2726400
77-
</dd>
63+
<dd>Testnet: 2976000</dd>
64+
65+
<dd>Mainnet: 2726400</dd>
66+
7867
<dt>MIN_NETWORK_PROTOCOL_VERSION (NU6)</dt>
79-
<dd>
80-
Testnet: <code>170110</code>
81-
</dd>
82-
<dd>
83-
Mainnet: <code>170120</code>
84-
</dd>
68+
<dd>Testnet: <code>170110</code></dd>
69+
70+
<dd>Mainnet: <code>170120</code></dd>
8571
</dl>
86-
<p>For each network (Testnet and Mainnet), nodes compatible with NU6
87-
activation on that network MUST advertise a network protocol version
88-
that is greater than or equal to the MIN_NETWORK_PROTOCOL_VERSION (NU6)
89-
for that activation.</p>
90-
<h1 id="backward-compatibility">Backward compatibility</h1>
91-
<p>Prior to the network upgrade activating on each network, NU6 and
92-
pre-NU6 nodes are compatible and can connect to each other. However, NU6
93-
nodes will have a preference for connecting to other NU6 nodes, so
94-
pre-NU6 nodes will gradually be disconnected in the run up to
95-
activation.</p>
96-
<p>Once the network upgrades, even though pre-NU6 nodes can still accept
97-
the numerically larger protocol version used by NU6 as being valid, NU6
98-
nodes will always disconnect peers using lower protocol versions.</p>
99-
<p>NU6 does not define a new transaction version or impose a new minimum
100-
transaction version. NU6 transactions are therefore in the same v4 or v5
101-
formats as NU5 transactions. This does not imply that transactions are
102-
valid across the NU6 activation, since signatures MUST use the
103-
appropriate consensus branch ID.</p>
104-
<h1 id="references">References</h1>
105-
<section id="footnotes" class="footnotes footnotes-end-of-document"
106-
role="doc-endnotes">
72+
73+
<p>For each network (Testnet and Mainnet), nodes compatible with NU6 activation on that network MUST advertise a network protocol version that is greater than or equal to the MIN_NETWORK_PROTOCOL_VERSION (NU6) for that activation.</p>
74+
75+
<h1 id="backwardcompatibility"><span class="section-heading">Backward compatibility</span><span class="section-anchor"> <a rel="bookmark" href="#backwardcompatibility"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h1>
76+
77+
<p>Prior to the network upgrade activating on each network, NU6 and pre-NU6 nodes are compatible and can connect to each other. However, NU6 nodes will have a preference for connecting to other NU6 nodes, so pre-NU6 nodes will gradually be disconnected in the run up to activation.</p>
78+
79+
<p>Once the network upgrades, even though pre-NU6 nodes can still accept the numerically larger protocol version used by NU6 as being valid, NU6 nodes will always disconnect peers using lower protocol versions.</p>
80+
81+
<p>NU6 does not define a new transaction version or impose a new minimum transaction version. NU6 transactions are therefore in the same v4 or v5 formats as NU5 transactions. This does not imply that transactions are valid across the NU6 activation, since signatures MUST use the appropriate consensus branch ID.</p>
82+
83+
<h1 id="references"><span class="section-heading">References</span><span class="section-anchor"> <a rel="bookmark" href="#references"><img width="24" height="24" class="section-anchor" src="assets/images/section-anchor.png" alt=""></a></span></h1>
84+
85+
<div class="footnotes">
10786
<hr />
10887
<ol>
109-
<li id="fn1"><p><a
110-
href="https://www.rfc-editor.org/info/bcp14">Information on BCP 14 —
111-
“RFC 2119: Key words for use in RFCs to Indicate Requirement Levels” and
112-
“RFC 8174: Ambiguity of Uppercase vs Lowercase in RFC 2119 Key
113-
Words”</a><a href="#fnref1" class="footnote-back"
114-
role="doc-backlink">↩︎</a></p></li>
115-
<li id="fn2"><p><a href="zip-0200">ZIP 200: Network Upgrade
116-
Mechanism</a><a href="#fnref2" class="footnote-back"
117-
role="doc-backlink">↩︎</a></p></li>
118-
<li id="fn3"><p><a href="protocol/protocol.pdf#networks">Zcash Protocol
119-
Specification, Version 2024.5.1 [NU6]. Section 3.12: Mainnet and
120-
Testnet</a><a href="#fnref3" class="footnote-back"
121-
role="doc-backlink">↩︎</a></p></li>
122-
<li id="fn4"><p><a href="protocol/protocol.pdf">Zcash Protocol
123-
Specification, Version 2024.5.1 or later</a><a href="#fnref4"
124-
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
125-
<li id="fn5"><p><a href="zip-0200">ZIP 200: Network Upgrade
126-
Mechanism</a><a href="#fnref5" class="footnote-back"
127-
role="doc-backlink">↩︎</a></p></li>
128-
<li id="fn6"><p><a href="zip-0236">ZIP 236: Blocks should balance
129-
exactly</a><a href="#fnref6" class="footnote-back"
130-
role="doc-backlink">↩︎</a></p></li>
131-
<li id="fn7"><p><a href="zip-1015">ZIP 1015: Block Reward Allocation
132-
for Non-Direct Development Funding</a><a href="#fnref7"
133-
class="footnote-back" role="doc-backlink">↩︎</a></p></li>
134-
<li id="fn8"><p><a href="zip-2001">ZIP 2001: Lockbox Funding
135-
Streams</a><a href="#fnref8" class="footnote-back"
136-
role="doc-backlink">↩︎</a></p></li>
137-
<li id="fn9"><p><a href="zip-0201">ZIP 201: Network Peer Management
138-
for Overwinter</a><a href="#fnref9" class="footnote-back"
139-
role="doc-backlink">↩︎</a></p></li>
140-
<li id="fn10"><p><a href="zip-0207">ZIP 207: Funding Streams</a><a
141-
href="#fnref10" class="footnote-back" role="doc-backlink">↩︎</a></p></li>
142-
<li id="fn11"><p><a href="zip-0214">ZIP 214: Consensus rules for a
143-
Zcash Development Fund</a><a href="#fnref11" class="footnote-back"
144-
role="doc-backlink">↩︎</a></p></li>
145-
<li id="fn12"><p><a href="zip-0200">ZIP 200: Network Upgrade
146-
Mechanism</a><a href="#fnref12" class="footnote-back"
147-
role="doc-backlink">↩︎</a></p></li>
88+
89+
<li id="fn:1">
90+
<p><a href="https://www.rfc-editor.org/info/bcp14">Information on BCP 14 — &#8220;RFC 2119: Key words for use in RFCs to Indicate Requirement Levels&#8221; and &#8220;RFC 8174: Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words&#8221;</a> <a href="#fnref:1" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
91+
</li>
92+
93+
<li id="fn:2">
94+
<p><a href="zip-0200">ZIP 200: Network Upgrade Mechanism</a> <a href="#fnref:2" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
95+
</li>
96+
97+
<li id="fn:3">
98+
<p><a href="protocol/protocol.pdf#networks">Zcash Protocol Specification, Version 2024.5.1 [NU6]. Section 3.12: Mainnet and Testnet</a> <a href="#fnref:3" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
99+
</li>
100+
101+
<li id="fn:4">
102+
<p><a href="protocol/protocol.pdf">Zcash Protocol Specification, Version 2024.5.1 or later</a> <a href="#fnref:4" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
103+
</li>
104+
105+
<li id="fn:5">
106+
<p><a href="zip-0236">ZIP 236: Blocks should balance exactly</a> <a href="#fnref:5" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
107+
</li>
108+
109+
<li id="fn:6">
110+
<p><a href="zip-1015">ZIP 1015: Block Reward Allocation for Non-Direct Development Funding</a> <a href="#fnref:6" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
111+
</li>
112+
113+
<li id="fn:7">
114+
<p><a href="zip-2001">ZIP 2001: Lockbox Funding Streams</a> <a href="#fnref:7" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
115+
</li>
116+
117+
<li id="fn:8">
118+
<p><a href="zip-0201">ZIP 201: Network Peer Management for Overwinter</a> <a href="#fnref:8" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
119+
</li>
120+
121+
<li id="fn:9">
122+
<p><a href="zip-0207">ZIP 207: Funding Streams</a> <a href="#fnref:9" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
123+
</li>
124+
125+
<li id="fn:10">
126+
<p><a href="zip-0214">ZIP 214: Consensus rules for a Zcash Development Fund</a> <a href="#fnref:10" title="return to body" class="reversefootnote">&#160;&#8617;&#xfe0e;</a></p>
127+
</li>
128+
148129
</ol>
149-
</section>
130+
</div>
150131
</body>
151132
</html>

0 commit comments

Comments
 (0)