Draft protocol spec refactoring for Ironwood#1300
Draft
daira wants to merge 9 commits into
Draft
Conversation
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
(Jubjub) rather than r_P (Orchard). Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
…n for TODOs, so that those colours can be reused. Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
…pools via semantic *type markup. This is preparation for Ironwood: the main practical reason to make the distinction is that the Orchard shielded protocol will be used for both the Orchard and Ironwood shielded pools. It has also always been annoying that "Sapling" named a Network Upgrade as well as a shielded protocol and its pool. Introduce a "concept -> typeface" indirection: low-level typeface macros (\strongtype, \slantedtype, \mathsanstype, \mathsansitalictype, ...) and semantic macros mapping each concept to one of them (\upgradetype, \topprotocoltype, \subprotocoltype, \pooltype, \softwaretype, \fieldnametype, ...), so the typeface for a concept is chosen in one place. Rework \emph/\schoolbook to override the variant typefaces rather than the previous \fakebold hack, and retire \mathsfit. Add the \term<concept> wrappers and \ChainValuePoolBalance. Redefine the existing top-level-protocol, Network Upgrade, shielded-protocol, and pool name macros (Zcash; Overwinter ... NU6.1; the Sprout, Sapling, and Orchard protocols and pools) to use the semantic markup, and apply it throughout the existing text: upgrades bold, protocols upright math sans, pools slanted. Some of the references to shielded protocols become references to corresponding pools, but not the ones that are entangled with subsequent changes. Note that the refactoring, in particular the switch from associating notes, etc. with shielded protocols to associating them with shielded pools, is applied also to the Change History. Since shielded protocols were in one-to-one correspondence with shielded pools throughout this history, I believe this isn't too much of a misrepresentation. Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org> Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
daira
commented
Jun 16, 2026
|
|
||
| % \indexstyle is normally plain, but is overridden to be \strongitalictype while in \defining. |
Collaborator
Author
There was a problem hiding this comment.
Suggested change
| % \indexstyle is normally plain, but is overridden to be \strongitalictype while in \defining. | |
| % \indextype is normally normalstyle (plain), but is overridden to be strongitalictype while in \defining. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Work in progress.