Improve documentation for fixed-base constants#417

Merged

daira merged 1 commit into

daira:improve-doc-for-fixed-base-constants

Feb 6, 2024

Contributor

daira commented Feb 6, 2024

Add a pointer to how the Z and U constants for fixed-base scalar multiplication can be reproduced.
Correct errors and omissions in the documentation of the fixed-base generators.

daira added the documentation label

daira assigned ebfull and str4d

daira force-pushed the improve-doc-for-fixed-base-constants branch from fbcbccf to 160a846 Compare

February 6, 2024 12:49

codecov-commenter commented Feb 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8a2abbb) 80.64% compared to head (fbcbccf) 80.64%.

❗ Current head fbcbccf differs from pull request most recent head 160a846. Consider uploading reports for the commit 160a846 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #417   +/-   ##
=======================================
  Coverage   80.64%   80.64%           
=======================================
  Files          30       30           
  Lines        3152     3152           
=======================================
  Hits         2542     2542           
  Misses        610      610

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


          * Add a pointer to how the Z and U constants for fixed-base scalar

ae1ba27

  multiplication can be reproduced.
* Correct errors and omissions in the documentation of the fixed-base
  generators.

Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>

daira force-pushed the improve-doc-for-fixed-base-constants branch from 160a846 to ae1ba27 Compare

February 6, 2024 21:20

str4d approved these changes

View reviewed changes

Contributor

str4d left a comment

ACK ae1ba27. Doc-only.

daira merged commit 3d79ba4 into zcash:main

daira deleted the improve-doc-for-fixed-base-constants branch

February 6, 2024 21:27

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 1 - see details f…

7ef787c

…or list of fixed comments)

r2487849124
r2487851383
r2487857002
r2487858123
r2487968253
r2487968899
r2542305679
r2542313926
r2542359143
r2542360991
r2542333126
r2542371427 (see note)
r2542392826 (see note)
r2542406328
r2542447228
r2542428312
r2542671834
r2542817988
r2542846302
r2542756837
r2543702226

Note: r2542371427 partially addressed - modules moved into issuance
module, zsa-issuance feature flag added to Cargo.toml. The issuance
module is not preceded with the flag yet as there are many places in
the rest of the code that need to be preceded with it. This needs to
be discussed first, so the flag is unused for now.

Note: r2542392826 addressed except orchard_flavor changes.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 2 - see details f…

5fe6c9b

…or list of fixed comments)

r2542352311

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 1 - see details f…

f3721ac

…or list of fixed comments)

r2487849124
r2487851383
r2487857002
r2487858123
r2487968253
r2487968899
r2542305679
r2542313926
r2542359143
r2542360991
r2542333126
r2542371427 (see note)
r2542392826 (see note)
r2542406328
r2542447228
r2542428312
r2542671834
r2542817988
r2542846302
r2542756837
r2543702226

Note: r2542371427 partially addressed - modules moved into issuance
module, zsa-issuance feature flag added to Cargo.toml. The issuance
module is not preceded with the flag yet as there are many places in
the rest of the code that need to be preceded with it. This needs to
be discussed first, so the flag is unused for now.

Note: r2542392826 addressed except orchard_flavor changes.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 1 - see details f…

cc93d5c

…or list of fixed comments)

r2487851383
r2487857002
r2487858123
r2487968253
r2487968899
r2542305679
r2542313926
r2542359143
r2542360991
r2542333126
r2542371427 (see note)
r2542392826 (see note)
r2542406328
r2542447228
r2542428312
r2542671834
r2542817988
r2542846302
r2542756837
r2543702226

Note: r2542371427 partially addressed - modules moved into issuance
module, zsa-issuance feature flag added to Cargo.toml. The issuance
module is not preceded with the flag yet as there are many places in
the rest of the code that need to be preceded with it. This needs to
be discussed first, so the flag is unused for now.

Note: r2542392826 addressed except orchard_flavor changes.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 2 - see details f…

8ca98ef

…or list of fixed comments)

r2542352311

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 2 - see details f…

…or list of fixed comments)

r2542352311

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 1 - see details f…

ad9a23f

…or list of fixed comments)

r2487851383
r2487857002
r2487858123
r2487968253
r2487968899
r2542305679
r2542313926
r2542359143
r2542360991
r2542333126
r2542371427 (see note)
r2542392826 (see note)
r2542406328
r2542447228
r2542428312
r2542671834
r2542599948
r2542817988
r2542846302
r2542756837
r2543702226

Note: r2542371427 partially addressed - modules moved into issuance
module, zsa-issuance feature flag added to Cargo.toml. The issuance
module is not preceded with the flag yet as there are many places in
the rest of the code that need to be preceded with it. This needs to
be discussed first, so the flag is unused for now.

Note: r2542392826 addressed except orchard_flavor changes.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 2 - see details f…

f669f6c

…or list of fixed comments)

r2542352311

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 1 - see details f…

f8503cf

…or list of fixed comments)

r2487851383
r2487857002
r2487858123
r2487968253
r2487968899
r2542305679
r2542313926
r2542359143
r2542360991
r2542333126
r2542371427 (see note)
r2542392826 (see note)
r2542406328
r2542447228
r2542428312
r2542599948
r2542671834
r2542817988
r2542846302
r2542756837
r2543702226

Note: r2542371427 partially addressed - modules moved into issuance
module, zsa-issuance feature flag added to Cargo.toml. The issuance
module is not preceded with the flag yet as there are many places in
the rest of the code that need to be preceded with it. This needs to
be discussed first, so the flag is unused for now.

Note: r2542392826 addressed except orchard_flavor changes.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 2 - see details f…

66e3ecf

…or list of fixed comments)

r2542352311

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 1 - see details f…

0a808ec

…or list of fixed comments)

r2487851383
r2487857002
r2487858123
r2487968253
r2487968899
r2542305679
r2542313926
r2542359143
r2542360991
r2542333126
r2542371427 (see note)
r2542392826 (see note)
r2542406328
r2542447228
r2542428312
r2542599948
r2542671834
r2542817988
r2542846302
r2542756837

Note: r2542371427 partially addressed - modules moved into issuance
module, zsa-issuance feature flag added to Cargo.toml. The issuance
module is not preceded with the flag yet as there are many places in
the rest of the code that need to be preceded with it. This needs to
be discussed first, so the flag is unused for now.

Note: r2542392826 addressed except orchard_flavor changes.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 2 - see details f…

4199aa7

…or list of fixed comments)

r2542352311

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 3 - see details f…

d4a7b8e

…or list of fixed comments)

r2543147318
r2543502871
r2543506591
r2543527521
r2543542313 (see note)
r2543565714 (see note)
r2543575888
r2549938764

Note: r2543542313 - changed pub to pub(crate) but needs to be discussed.

Note: r2543565714 - It's not completely clear from the comment, but I removed
the doc comment for rseed_split_note and updated it for create_split_note -
is that correct? Also kept create_split_note pub, not pub(crate) - needs to
be discussed.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 3 - see details f…

11becf0

…or list of fixed comments)

r2543147318
r2543502871
r2543506591
r2543527521
r2543542313 (see note)
r2543565714 (see note)
r2549938764

Note: r2543542313 - changed pub to pub(crate) but needs to be discussed.

Note: r2543565714 - It's not completely clear from the comment, but I removed
the doc comment for rseed_split_note and updated it for create_split_note -
is that correct? Also kept create_split_note pub, not pub(crate) - needs to
be discussed.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 4 - see details f…

391a834

…or list of fixed comments)

r2542276487
r2542288774

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 5 - see details f…

cb4aae6

…or list of fixed comments)

r2550151848
r2550187398
r2550276814
r2550352041
r2550380193
r2550407188
r2550616659

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 3 - see details f…

…or list of fixed comments)

r2543147318
r2543502871
r2543506591
r2543527521
r2543542313 (see note)
r2543565714 (see note)
r2549938764

Note: r2543542313 - changed pub to pub(crate) but needs to be discussed.

Note: r2543565714 - It's not completely clear from the comment, but I removed
the doc comment for rseed_split_note and updated it for create_split_note -
is that correct? Also kept create_split_note pub, not pub(crate) - needs to
be discussed.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 4 - see details f…

9ca2572

…or list of fixed comments)

r2542276487
r2542288774

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 5 - see details f…

0ed3034

…or list of fixed comments)

r2550151848
r2550187398
r2550276814
r2550352041
r2550380193
r2550407188
r2550616659

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 2 - see details f…

e0b00d9

…or list of fixed comments)

r2543147318
r2543502871
r2543506591
r2543527521
r2543542313 (see note)
r2543565714 (see note)
r2549938764

Note: r2543542313 - changed pub to pub(crate) but needs to be discussed.

Note: r2543565714 - It's not completely clear from the comment, but I removed
the doc comment for rseed_split_note and updated it for create_split_note -
is that correct? Also kept create_split_note pub, not pub(crate) - needs to
be discussed.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 3 - see details f…

d2be7b0

…or list of fixed comments)

r2542276487
r2542288774

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 4 - see details f…

ffae054

…or list of fixed comments)

r2550151848
r2550187398
r2550276814
r2550352041
r2550380193
r2550407188
r2550616659

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 3 - see details f…

f6e7fec

…or list of fixed comments)

r2542276487
r2542288774

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 4 - see details f…

87995d2

…or list of fixed comments)

r2550151848
r2550187398
r2550276814
r2550352041
r2550380193
r2550407188
r2550616659

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (step 5 - see details f…

30aa91d

…or list of fixed comments)

r2585521988
r2585536670
r2585544143
r2585546655
r2585548116
r2585631816
r2585636883
r2599516192
r2599562825
r2599565711
r2599584010
r2599589396
r2599594554
r2599594936
r2599745324
r2602373392
r2602378140
r2602410770
r2602415043
r2602416292
r2602418341
r2602421894
r2602426619
r2602532807
r2602541601
r2602556915
r2602570477 (see note
r2602938883 (see note)

Note: r2602570477 and r2602938883 — we renamed the generic parameter
P to Pr only where it conflicts with P for Proof. Should we use Pr for
OrchardPrimitives everywhere else for consistency?

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (stage 1 - see details …

ccf4c19

…for list of fixed comments)

r2487851383
r2487857002
r2487858123
r2487968253
r2487968899
r2542305679
r2542313926
r2542359143
r2542360991
r2542333126
r2542371427 (see note)
r2542392826 (see note)
r2542406328
r2542447228
r2542428312
r2542599948
r2542671834
r2542817988
r2542846302
r2542756837
r2543147318
r2543502871
r2543506591
r2543527521
r2543542313 (see note)
r2543565714 (see note)
r2549938764
r2542276487
r2542288774
r2550151848
r2550187398
r2550276814
r2550352041
r2550380193
r2550407188
r2550616659

Note: r2542371427 partially addressed - modules moved into issuance
module, zsa-issuance feature flag added to Cargo.toml. The issuance
module is not preceded with the flag yet as there are many places in
the rest of the code that need to be preceded with it. This needs to
be discussed first, so the flag is unused for now.

Note: r2542392826 addressed except orchard_flavor changes.

Note: r2543542313 - changed pub to pub(crate) but needs to be discussed.

Note: r2543565714 - It's not completely clear from the comment, but I removed
the doc comment for rseed_split_note and updated it for create_split_note -
is that correct? Also kept create_split_note pub, not pub(crate) - needs to
be discussed.

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (stage 2 - see details …

…for list of fixed comments)

r2585521988
r2585536670
r2585544143
r2585546655
r2585548116
r2585631816
r2585636883
r2599516192
r2599562825
r2599565711
r2599584010
r2599589396
r2599594554
r2599594936
r2599745324
r2602373392
r2602378140
r2602410770
r2602415043
r2602416292
r2602418341
r2602421894
r2602426619
r2602532807
r2602541601
r2602556915
r2602570477 (see note
r2602938883 (see note)

Note: r2602570477 and r2602938883 — we renamed the generic parameter
P to Pr only where it conflicts with P for Proof. Should we use Pr for
OrchardPrimitives everywhere else for consistency?

dmidem added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (stage 2 - see details …

cd41b4f

…for list of fixed comments)

r2585521988
r2585536670
r2585544143
r2585546655
r2585548116
r2585631816
r2585636883
r2599516192
r2599562825
r2599565711
r2599584010
r2599589396
r2599594554
r2599594936
r2599745324
r2602373392
r2602378140
r2602410770
r2602415043
r2602416292
r2602418341
r2602421894
r2602426619
r2602532807
r2602541601
r2602556915
r2602570477 (see note
r2602938883 (see note)

Note: r2602570477 and r2602938883 — we renamed the generic parameter
P to Pr only where it conflicts with P for Proof. Should we use Pr for
OrchardPrimitives everywhere else for consistency?

ConstanceBeguier added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (restore num_actions)

f120973

r2602512993
r2602520525
r2602993570

ConstanceBeguier added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (remove expiry_height)

e7d1f21

r2585611775
r2585613027
r2585615651
r2585617028
r2585618253
r2585618943

ConstanceBeguier added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (circuit part)

0bf619b

r2599305911
r2599374820
r2599387594
r2599389930
r2599406000
r2599503258
r2487964032
r2487964195
r2488006245
r2599340202

ConstanceBeguier added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (circuit part)

6c9e3ec

r2599305911
r2599374820
r2599387594
r2599389930
r2599406000
r2599503258
r2487964032
r2487964195
r2488006245
r2599340202

ConstanceBeguier added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (remove expiry_height)

302f886

r2585611775
r2585613027
r2585615651
r2585617028
r2585618253
r2585618943

ConstanceBeguier added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (restore num_actions)

8005f29

r2602512993
r2602520525
r2602993570

ConstanceBeguier added a commit to QED-it/orchard that referenced this pull request


          Address upstream PR zcash#417 review comments (simple comments)

b90a5de

r2602385534
r2542846450
r2603002641
r2542892451
r2542967008
r2543575888
r2550196973

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels