Protocol spec: Add macro and Makefile support for NU6

protocol/Makefile

@@ -20,10 +20,10 @@ NOCRUFT?=|perl -pe 's|[{\<\(]\/[^ ]* ?||g;s|^.* has been referenced but does not
 
 .PHONY: all all-specs release discard
 all: .Makefile.uptodate
-	$(MAKE) nu5 canopy heartwood blossom sapling
+	$(MAKE) nu6 nu5 canopy heartwood blossom sapling
 
 all-specs: .Makefile.uptodate
-	$(MAKE) nu5.pdf canopy.pdf heartwood.pdf blossom.pdf sapling.pdf
+	$(MAKE) nu6.pdf nu5.pdf canopy.pdf heartwood.pdf blossom.pdf sapling.pdf
 
 release:
 ifeq ($(shell git tag --points-at HEAD |wc -l),0)
@@ -60,6 +60,9 @@ canopy.pdf: protocol.tex zcash.bib incremental_merkle.png key_components_sapling
 nu5.pdf: protocol.tex zcash.bib incremental_merkle.png key_components_sapling.png
 	$(MAKE) nu5
 
+nu6.pdf: protocol.tex zcash.bib incremental_merkle.png key_components_sapling.png
+	$(MAKE) nu6
+
 .PHONY: auxsapling
 auxsapling:
 	printf '\\toggletrue{issapling}\n\\renewcommand{\\docversion}{Version %s [\\SaplingSpec]}' "$$(git describe --tags --abbrev=6)" |tee protocol.ver
@@ -126,6 +129,20 @@ nu5:
 	mv -f aux/nu5.pdf .
 	cp -f nu5.pdf protocol.pdf
 
+.PHONY: auxnu6
+auxnu6:
+	printf '\\toggletrue{isnusix}\n\\renewcommand{\\docversion}{Version %s [\\NUSixSpec]}' "$$(git describe --tags --abbrev=6)" |tee protocol.ver
+	mkdir -p aux
+	rm -f aux/nu6.*
+	cp mymakeindex.sh aux
+	$(LATEXMK) -jobname=nu6 -auxdir=aux -outdir=aux $(EXTRAOPT) protocol $(NOCRUFT)
+
+.PHONY: nu6
+nu6:
+	$(MAKE) auxnu6
+	mv -f aux/nu6.pdf .
+	cp -f nu6.pdf protocol.pdf
+
 .PHONY: nolatexmk-sapling
 nolatexmk-sapling:
 	printf '\\toggletrue{issapling}\n\\renewcommand{\\docversion}{Version %s [\\SaplingSpec]}' "$$(git describe --tags --abbrev=6)" |tee protocol.ver
@@ -187,6 +204,18 @@ nolatexmk-nu5:
 	sh mymakeindex.sh -o nu5.ind nu5.idx
 	$(LATEX) -jobname=nu5 protocol.tex || { touch incremental_merkle.png; exit 1; }
 
+.PHONY: nolatexmk-nu6
+nolatexmk-nu6:
+	printf '\\toggletrue{isnusix}\n\\renewcommand{\\docversion}{Version %s [\\NUSixSpec]}' "$$(git describe --tags --abbrev=6)" |tee protocol.ver
+	# If $(LATEX) fails, touch an input so that 'make' won't think it is up-to-date next time.
+	rm -f nu6.aux nu6.bbl nu6.blg nu6.brf nu6.bcf
+	$(LATEX) -jobname=nu6 protocol.tex || { touch incremental_merkle.png; exit 1; }
+	biber nu6
+	$(LATEX) -jobname=nu6 protocol.tex || { touch incremental_merkle.png; exit 1; }
+	$(LATEX) -jobname=nu6 protocol.tex || { touch incremental_merkle.png; exit 1; }
+	sh mymakeindex.sh -o nu6.ind nu6.idx
+	$(LATEX) -jobname=nu6 protocol.tex || { touch incremental_merkle.png; exit 1; }
+
 .PHONY: clean
 clean:
-	rm -f aux/* html/* protocol.ver protocol.pdf nu5.pdf canopy.pdf heartwood.pdf blossom.pdf sapling.pdf
+	rm -f aux/* html/* protocol.ver protocol.pdf nu6.pdf nu5.pdf canopy.pdf heartwood.pdf blossom.pdf sapling.pdf

protocol/protocol.tex

@@ -521,6 +521,7 @@
 \newcommand{\HeartwoodSpec}{Overwinter+Sapling+Blossom+Heartwood}
 \newcommand{\CanopySpec}{Overwinter+Sapling+Blossom+Heartwood+Canopy}
 \newcommand{\NUFiveSpec}{NU5}
+\newcommand{\NUSixSpec}{NU6}
 \newtoggle{issapling}
 \togglefalse{issapling}
 \newtoggle{isblossom}
@@ -531,6 +532,8 @@
 \togglefalse{iscanopy}
 \newtoggle{isnufive}
 \togglefalse{isnufive}
+\newtoggle{isnusix}
+\togglefalse{isnusix}
 \InputIfFileExists{protocol.ver}{}{}
 
 \newcommand{\doctitle}{Zcash Protocol Specification}
@@ -563,8 +566,24 @@
 \newcommand{\canopycolorname}{purple}
 \newcommand{\nufivecolor}{black!25!blue!65!green!65}
 \newcommand{\nufivecolorname}{slate blue}
+\newcommand{\nusixcolor}{red!92!green!54}
+\newcommand{\nusixcolorname}{magenta}
 \newcommand{\labelcolor}{yellow!20}
 
+\iftoggle{isnusix}{
+  \providecommand{\baseurl}{https://zips.z.cash/protocol/nu6.pdf}
+  \toggletrue{isnusix}
+  \newcommand{\setnusix}{\color{\nusixcolor}}
+  \newcommand{\nusix}[1]{\texorpdfstring{{\setnusix{#1}}}{#1}}
+  \newcommand{\notnusix}[1]{}
+  \newcommand{\notbeforenusix}[1]{#1}
+} {
+  \newcommand{\setnusix}{}
+  \newcommand{\nusix}[1]{}
+  \newcommand{\notnusix}[1]{#1}
+  \newcommand{\notbeforenusix}[1]{}
+}
+
 \iftoggle{isnufive}{
   \providecommand{\baseurl}{https://zips.z.cash/protocol/protocol.pdf}
   \toggletrue{iscanopy}
@@ -705,6 +724,8 @@
 \newcommand{\CanopyText}{\textbf{Canopy}}
 \newcommand{\NUFive}{\termbf{NU5}}
 \newcommand{\NUFiveText}{\textbf{NU5}}
+\newcommand{\NUSix}{\termbf{NU6}}
+\newcommand{\NUSixText}{\textbf{NU6}}
 \newcommand{\Orchard}{\termbf{Orchard}}
 \newcommand{\OrchardText}{\textbf{Orchard}}
 \newcommand{\SaplingOrOrchard}{\Sapling{}\nufive{ or \Orchard{}}\xspace}
@@ -2377,6 +2398,8 @@
 \newcommand{\consensusrule}[1]{\needspace{4ex}\vspace{2ex}\callout{}{Consensus rule:}{#1}}
 \newenvironment{consensusrules}{\introlist\callout{}{Consensus rules:}\begin{itemize}}{\end{itemize}}
 
+\newcommand{\prenusixitem}[1]{\item \prenusix{#1}}
+\newcommand{\nusixonwarditem}[1]{\nusix{\item {[\NUSix onward]}\, {#1}}}
 \newcommand{\prenufiveitem}[1]{\item \prenufive{#1}}
 \newcommand{\nufiveonwarditem}[1]{\nufive{\item {[\NUFive onward]}\, {#1}}}
 \newcommand{\precanopyitem}[1]{\item \precanopy{#1}}
@@ -2396,6 +2419,8 @@
 \newcommand{\overwinterprenufiveitem}[1]{\overwinter{\item \overwinterprenufive{#1}}}
 \newcommand{\sproutspecificitem}[1]{\item \sproutspecific{#1}}
 
+\newcommand{\prenusix}[1]{\notbeforenusix{\nusix{[Pre-\NUSix\!]\,}} {#1}}
+\newcommand{\nusixonward}[1]{\nusix{[\NUSix onward]\, {#1}}}
 \newcommand{\prenufive}[1]{\notbeforenufive{\nufive{[Pre-\NUFive\!]\,}} {#1}}
 \newcommand{\nufiveonward}[1]{\nufive{[\NUFive onward]\, {#1}}}
 \newcommand{\precanopy}[1]{\notbeforecanopy{\canopy{[Pre-\Canopy\!]\,}} {#1}}
@@ -2423,6 +2448,8 @@
 \newcommand{\nnote}[1]{\needspace{4ex}\vspace{2ex}\callout{}{Non-normative note:}{#1}}
 \newenvironment{nnotes}{\introlist\callout{}{Non-normative notes:}\begin{itemize}}{\end{itemize}}
 
+\newcommand{\nusixonwardnnote}[1]{\nusix{\callout{[\NUSix onward]\,\,}{Non-normative note:}{#1}}}
+\newcommand{\nusixonwardpnote}[1]{\nusix{\callout{[\NUSix onward]\,\,}{Note:}{#1}}}
 \newcommand{\nufiveonwardnnote}[1]{\nufive{\callout{[\NUFive onward]\,\,}{Non-normative note:}{#1}}}
 \newcommand{\nufiveonwardpnote}[1]{\nufive{\callout{[\NUFive onward]\,\,}{Note:}{#1}}}
 \newcommand{\canopyonwardnnote}[1]{\canopy{\callout{[\Canopy onward]\,\,}{Non-normative note:}{#1}}}
@@ -2487,10 +2514,14 @@
 at launch, and after each of the upgrades codenamed \Overwinter, \Sapling, \Blossom,
 \Heartwood, and \Canopy. It is a work in progress. Protocol differences from \Zerocash and
 \Bitcoin are also explained.}}
-\nufive{\noindent This draft specification defines the \Zcash consensus protocol
+\notnusix{\nufive{\noindent This specification defines the \Zcash consensus protocol
 at launch; after each of the upgrades codenamed \Overwinter, \Sapling, \Blossom,
-\Heartwood, and \Canopy; and proposed changes for \NUFive. It is a work in progress.
-Protocol differences from \Zerocash and \Bitcoin are also explained.}
+\Heartwood, \Canopy, and \NUFive. It is a work in progress. Protocol
+differences from \Zerocash and \Bitcoin are also explained.}}
+\nusix{\noindent This draft specification defines the \Zcash consensus protocol
+at launch; after each of the upgrades codenamed \Overwinter, \Sapling, \Blossom,
+\Heartwood, \Canopy, and \NUFive; and proposed changes for \NUSix. It is a work
+in progress. Protocol differences from \Zerocash and \Bitcoin are also explained.}
 
 \vspace{2.5ex}
 \noindent \textbf{Keywords:}~ \StrSubstitute[0]{\keywords}{,}{, }.
@@ -2560,6 +2591,9 @@
 \notbeforenufive{Changes specific to the \NUFive upgrade following \Canopy
 are highlighted in \nufive{\nufivecolorname}.}
 
+\notbeforenusix{Changes specific to the \NUSix upgrade following \NUFive
+are highlighted in \nusix{\nusixcolorname}.}
+
 All of these are also changes from \Zerocash.
 The name \Sprout is used for the \Zcash protocol prior to \Sapling
 (both before and after \Overwinter), and in particular its shielded protocol.
@@ -12281,10 +12315,15 @@
 \cite{ZIP-212}, \cite{ZIP-213}, and \cite{ZIP-221}.
 Additional information and rationale is given in \cite{Zcash-Orchard} and \cite{Zcash-halo2}.}
 
+\nusix{
+This draft specification describes the set of changes proposed for the \NUSix \networkUpgrade
+(for which activation heights have not yet been set).
+} %nusix
+
 \introlist
 \vspace{1ex}
 This section summarizes the strategy for upgrading from \Sprout to subsequent versions
-of the protocol (\Overwinter, \Sapling, \Blossom, \Heartwood, \Canopy, and \NUFive),
+of the protocol (\Overwinter, \Sapling, \Blossom, \Heartwood, \Canopy, \NUFive, and \NUSix),
 and for future upgrades.
 
 \defining{The \networkUpgrade mechanism is described in \cite{ZIP-200}.}