How to propose fixes to the Zcash protocol PDF?

aarnott · July 29, 2023, 7:34pm

Zcash Protocol Specification, Version 2022.3.8 [NU5] has a bug:

Section 5.6.3.3 regards full viewing keys, but states:

For incoming viewing keys on Mainnet, the Human-Readable Part is “zviews”. For incoming viewing keys on Testnet, the Human-Readable Part is “zviewtestsapling”.

This is a copy/paste bug from the prior section 5.6.3.2, which regards incoming viewing keys and states:

For incoming viewing keys on Mainnet, the Human-Readable Part is “zivks”. For incoming viewing keys on Testnet, the Human-Readable Part is “zivktestsapling”

So we see that although the human-readable part strings were updated, both paragraphs claim to describe incoming viewing keys when 5.6.3.3 should claim to describe full viewing keys.

hloo · July 31, 2023, 2:16am

I think you can make a pull request to change this file:

github.com

zcash/zips/blob/main/protocol/protocol.tex

\documentclass{article}
\usepackage{ifxetex}
\usepackage{ifluatex}

% <https://tex.stackexchange.com/a/488473/78411>
\ifluatex
\directlua{
  luatexbase.add_to_callback("luaotfload.patch_font", function (fontdata)
    local parameters = fontdata.parameters
    if not parameters then return end
    if not (parameters.x_height or parameters[5] or 0) == 0 then return end
    if fontdata.characters and fontdata.characters[120] then
      parameters.x_height = fontdata.characters[120].height
    else
      parameters.x_height = (parameters.ascender or 0)*0.5
    end
  end, "Fix x-height")
}
\fi

This file has been truncated. show original

aarnott · July 31, 2023, 1:14pm

Excellent. Preparing a PR now. Thanks.

ava.aries · August 2, 2023, 5:49pm

Create Zcash Improvement Proposal (ZIP): If you have a unique fix or improvement that you believe will benefit the protocol, create a Zcash Improvement Proposal. A ZIP is a formal document that describes the proposed changes and their rationale. You can find the template and guidelines for creating a ZIP in the Zcash GitHub repository.
If the proposal successfully completes the review process and is accepted, it may be scheduled for implementation and activation on the Zcash network.

aarnott · August 3, 2023, 4:12am

Thanks, but I’m just talking about an error-level fix to the existing ZIP. Surely it doesn’t require a new ZIP to fix a word in a prior ZIP, does it?