Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(command): zebra download #5901

Merged
merged 4 commits into from
Jan 19, 2023
Merged

docs(command): zebra download #5901

merged 4 commits into from
Jan 19, 2023

Conversation

oxarbitrage
Copy link
Contributor

Motivation

We want to have some sort of the documentation for the zk-SNARK parameters zebra download at startup or using the zebrad download command.

Close #3383

Solution

  • Add a new section to the book.
  • Document the parameters and their usage in zebra.
  • Add an extra logging line to show the process of downloading/verifying parameters is complete.

Review

Anyone can review.

Reviewer Checklist

  • Will the PR name make sense to users?
    • Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
    • Does it change concurrent code, unsafe code, or consensus rules?
  • How do you know it works? Does it have tests?

@oxarbitrage oxarbitrage requested review from a team as code owners December 29, 2022 22:15
@oxarbitrage oxarbitrage requested review from teor2345 and removed request for a team December 29, 2022 22:15
@oxarbitrage oxarbitrage self-assigned this Dec 29, 2022
@oxarbitrage oxarbitrage added A-docs Area: Documentation P-Low ❄️ A-cryptography Area: Cryptography related no-review-reminders Turn off review reminders labels Dec 29, 2022
@codecov
Copy link

codecov bot commented Dec 29, 2022

Codecov Report

Merging #5901 (4a7a32d) into main (256b1c0) will increase coverage by 0.08%.
The diff coverage is 100.00%.

❗ Current head 4a7a32d differs from pull request most recent head f2a2d4b. Consider uploading reports for the commit f2a2d4b to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5901      +/-   ##
==========================================
+ Coverage   77.94%   78.03%   +0.08%     
==========================================
  Files         312      312              
  Lines       38987    38996       +9     
==========================================
+ Hits        30387    30429      +42     
+ Misses       8600     8567      -33     

Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I just want to check about the panic, that seems bad.

book/src/user/parameters.md Outdated Show resolved Hide resolved
book/src/user/parameters.md Show resolved Hide resolved
@teor2345 teor2345 added the S-waiting-on-author Status: waiting on the ticket or PR author label Jan 6, 2023
Copy link
Contributor

@mpguerra mpguerra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, great summary! A few typos to fix and that's it from me

book/src/user/parameters.md Outdated Show resolved Hide resolved
book/src/user/parameters.md Outdated Show resolved Hide resolved
book/src/user/parameters.md Outdated Show resolved Hide resolved
book/src/user/parameters.md Outdated Show resolved Hide resolved
book/src/user/parameters.md Outdated Show resolved Hide resolved
@oxarbitrage oxarbitrage removed no-review-reminders Turn off review reminders S-waiting-on-author Status: waiting on the ticket or PR author labels Jan 18, 2023
Copy link
Contributor

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks good to me!

@teor2345 teor2345 dismissed mpguerra’s stale review January 19, 2023 02:40

Requested changes were made

mergify bot added a commit that referenced this pull request Jan 19, 2023
mergify bot added a commit that referenced this pull request Jan 19, 2023
@mergify mergify bot merged commit de2ed81 into main Jan 19, 2023
@mergify mergify bot deleted the issue3383 branch January 19, 2023 05:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-cryptography Area: Cryptography related A-docs Area: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document zebrad download command
3 participants