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(transaction encoding): sapling fields #3501

Merged
merged 1 commit into from
Feb 11, 2022

Conversation

oxarbitrage
Copy link
Contributor

Motivation

We want to make sure all the fields in the transaction tables of the protocol are documented in Zebra at serialization and deserialization.

This pull request deals with the sapling fields of transactions.

Closes #3422

Solution

Document sapling transaction fields.

Review

Anyone can review.

Reviewer Checklist

  • All fields considered "sapling" are documented.

Follow Up Work

Orchard fields: #3424

@codecov
Copy link

codecov bot commented Feb 9, 2022

Codecov Report

Merging #3501 (622d63a) into main (499ae89) will increase coverage by 0.20%.
The diff coverage is 74.75%.

@@            Coverage Diff             @@
##             main    #3501      +/-   ##
==========================================
+ Coverage   78.34%   78.54%   +0.20%     
==========================================
  Files         267      273       +6     
  Lines       31526    31902     +376     
==========================================
+ Hits        24698    25059     +361     
- Misses       6828     6843      +15     

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!

If you're looking to cut down on the work for future PRs, we can just mention each field the first time it is used in a Rust file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document types specified in 7.1: Sapling
2 participants