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

ZSA integration (cumulative steps 1–7): up to Orchard ZSA consensus modifications #37

Open
wants to merge 127 commits into
base: zsa1
Choose a base branch
from

Conversation

dmidem
Copy link

@dmidem dmidem commented Jan 5, 2025

This pull request merges the changes from several incremental PRs into one cumulative set of updates on top of the zsa1 branch. It introduces ZSA-compatible crates, Network Upgrade 7 (Nu7), initial Transaction V6 support, Orchard generics for ZSA, property-based testing enhancements, note commitment handling for ZSA issuance, and initial consensus modifications for Orchard ZSA.

It does not include the final state management changes or additional tests — those come in subsequent PRs.

Below is a high-level overview of the merged changes:

  1. ZSA-Compatible Crates Integration (Step 1)

    • Replaces core libraries (halo2, zcash_note_encryption, etc.) with QED-it’s ZSA-compatible forks.
    • Maintains full support for Orchard “Vanilla” without activating any new ZSA features yet.
  2. Network Upgrade 7 (Nu7) Support (Step 2)

    • Introduces code paths and placeholders for Nu7, the upcoming network upgrade required for ZSA.
    • Adds FIXME comments where final activation heights and other specifics must be filled in.
  3. Transaction V6 Foundations (Step 3)

    • Adds a V6 variant to Zebra’s Transaction enum, initially mirroring V5 logic.
    • Sets a baseline for future ZSA-related modifications, including placeholders for relevant fields and logic.
  4. Refactor Orchard Structures to Generics (Step 4)

    • Converts key Orchard data structures (e.g., ShieldedData) to generics, enabling a single code path for both Orchard Vanilla and Orchard ZSA.
    • Implements serialization/deserialization for V6 transactions, including a burn field in the ZSA flavor.
  5. Orchard Proptests with ZSA Enhancements (Step 5)

    • Extends the property-based testing framework to handle ZSA-specific fields and behaviors in Transaction V6.
    • Refactors code organization (e.g., extracting Burn types) for better clarity and future expansion.
  6. Integration of ZSA Issuance Commitments (Step 6)

    • Merges issuance action note commitments with existing shielded data commitments for V6 transactions.
    • Ensures Transaction::orchard_note_commitments includes issuance note commitments when present, preserving V5 behavior.
  7. Initial ZSA Consensus Support (Step 7)

    • Modifies zebra-consensus to support Orchard ZSA.

Next Steps

  • State Management & Additional Testing: Future PRs will introduce state-layer modifications, refine consensus checks, and add more comprehensive tests.

By consolidating these first several steps into a single PR, we aim to simplify the review process .

dmidem added 30 commits July 29, 2024 10:13
…l Orchard support only, without supporting and enabling ZSA features.
This commit introduces basic support for Transaction version 6 (Tx V6). This initial implementation treats Tx V6
as a simple copy of Tx V5, without yet integrating ZSA-specific features or the new transaction structure.

- Added a new V6 variant to the Transaction enum in the zebra-chain crate.
- Updated relevant code to handle the new V6 variant.

Note: Tests and additional adjustments are still pending, and will be addressed in subsequent commits.
…(without unit tests fixing for now).

- Refactored `ShieldedData` and `Action` structures to be generics parameterized by Orchard flavor
  (`OrchardVanilla` or `OrchardZSA`), enabling support for both Orchard protocols in Tx V6.
- Introduced a `burn` field in `ShieldedData` to support ZSA, with unit type for Tx V5 and a vector of burn items for Tx V6.
- Modified `Transaction` enum methods (orchard_...) to handle generics properly, ensuring compatibility with both Orchard flavors.
- Implemented serialization and deserialization for Tx V6 while avoiding code redundancy with Tx V5 wherever possible.
dmidem added 29 commits November 3, 2024 19:58
…te_commitments to merge Orchard ZSA issuance note commitments for V6 transactions
… and refactor orchard_shielded_data_iter and orchard_shielded_data_field macros to use it"

This reverts commit 2587b04.
…orchard_shielded_data macro from the reverted commit
…ns from librustzcash/zcash_primitives instead of reimplementing them
… to use the correct order of the asset burn field in V6 transaction as it's defined in ZIP 230
… now - the same as used in librustzcash to make it possible to run tests)
…add issuance_block test function there (now it simply deserialized issuance block from the test vector to check if deserialization functions work properly)
…dd checks of deserialization of transfer and burn blocks
…'re two keys now - VERIFYING_KEY_VANILLA and VERIFYING_KEY_ZSA
… use 77777777 as consensus branch id for Nu7 (to ajdust it with ones used in librustzcash)
…ract ValueCommitment of burn items if they are present
@dmidem dmidem requested a review from PaulLaux January 5, 2025 09:01
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.

1 participant