ZSA test vectors modifications by PaulLaux · Pull Request #108 · zcash/zcash-test-vectors

PaulLaux · 2025-08-22T11:10:07Z

Updated reference implementation for the TXV6 and OrchardZSA components.

Issuer keys test vectors implementation

* zsa-note-type: test vectors for note commitment and encryption * zsa-note-type: explicit native then ZSA notes * zsa-note-type: consistent order of arguments * zsa-note-type: revert output format * zsa-note-type: commit note encryption with note type test vectors Co-authored-by: Aurélien Nicolas <info@nau.re>

* zsa-sync-test-vectors: output directly the needed test code * zsa-sync-test-vectors: regenerate rust code with the same content but final format Co-authored-by: Aurélien Nicolas <info@nau.re>

- Updated to support encryption_v3 as given in QED-it/orchard#38 and QED-it/librustzcash#18. - This PR breaks compatibility with OrchardDomainV2

This adds the changes to the zcash test vectors to update the calculation of the Asset Base from the Asset Identifier via the Asset Digest, as detailed in ZIP 227.

We would like to have the same R constant for ZEC and ZSA note commitments.

…orr scheme, and rename `asset_id` to `asset_base` (#12) This updates the ik derivation to be via the Schnorr scheme, and refactors asset_id.py to asset_base.py. It also adds test vector generation code for issuance authorization signature, adds a check to ensure the `isk` is non zero, and updates the generated Rust files.

This merges upstream changes into the `zsa1` branch of our fork.

This separates the additions of the ZSA work into a separate file, creating separate test vector files for them. It also adds in upstream changes to the test vectors crate.

* changing documentation of the BIP 340 code to reflect the specific commit it has been taken from * re-adding the main function to key_components so that orchard vectors can be generated independently * reducing code duplication between orchard and orchard_zsa key_components * cosmetic changes to reduce unnecessary divergences from upstream, addition of blank line at end of some files * making the key component random initialization cleaner * adding suggestions from review

This is to add upstream changes for ZIP 320 test vectors into the repository.

…n next commit

This PR adds in the changes for ZIP 320 vectors from upstream. It also edits the output file in order to reduce the diff between the generated test vectors upstream.

* updating zip_0244 functions to support generating both V5 and V6 digests, and adding NU6 constants to transaction.py * adding V6 transaction class to transaction.py -- code reuse needs to be improved * changes to transaction.py and zip_0244.py * minor update * initial attempt at inheritance, to be improved * changing inheritance structure of TransactionV5 and TransactionV6, and moving TransactionV6 to transaction_zsa.py * reverting zip_0244.py to only include V5 details * separate txid vectors for zsa into separate files * adding ZSA version of zip 244 vectors * renaming to NU7 and so on * still WIP, updating to work with librustzcash code * updating get_random_unicode_bytes to give a slightly wider range of values * changes to the transaction format serialization and the txid generation to make it spec compliant * updating the generated test vectors * some cleanup changes * removing unichr option from get_random_unicode_bytes * cleaner import * simple changes based on review comments * moving common transaction fields in a way that reduces code duplication * reducing code duplication by creating an OrchardActionBase class which is inherited by OrchardActionDEscription and OrchardZSAActionDescription * reducing code duplication in transaction, transaction_zsa, zip_0244 and orchard_zsa/digests files * reducing code duplication inside the main function of zip_0244 and orchard_zsa/digests * changing txn version back to V6 * renaming rho to nf_old in note_encryption files

This renames the TransactionZSA class to TransactionV6 to better reflect its purpose as a V6 transaction format reference implementation

For more details, see ZIP227

* Moving the burn fields into the action group * fixing small issue with switch to asset_desc_hash * regenerating test vector files

Main modifications - Generate test vectors for ZIP230 adresses - Generate test vectors for ZIP32 - Update regenerate script - Update rust output by replacing vectors by slices to support no_std

Add `SighashInfo` (version and associated data) to - Transparent authorizing signatures. Update `auth_digest` by adding `SighashInfo` as defined in ZIP246 Add `SighashInfo` for Sapling/Orchard binding signatures only when the signatures exist

str4d · 2025-11-19T16:14:12Z

+
+  if [ "$gen_type" = "rust" ]; then
+    echo "Running rustfmt on generated Rust files..."
+    rustfmt --edition 2021 test-vectors/rust/*.rs


This change should be extracted into a standalone PR, not proposed as part of the ZSA test vector changes. Changes to the entire output format (and thus the entire test vector set) need to be separately considered.

We have opened #112 for the consideration of these changes. These changes have been rolled back in this PR.

str4d · 2025-11-19T16:17:04Z

+        filename,
+    ))
+    print()
+    visibility = 'pub(crate) '


Likewise, these changes should be extracted from this PR. If it were only the pub(crate) change then it might be fine, but proposing changes to the default indentation makes the PR way too invasive to be done as a side-effect of the ZSA test vector changes.

These changes have been extracted out into QED-it#42, which we can create as an upstream PR after discussing #112.

This has also been opened as #114, which can be reviewed independently. These changes have been rolled back from this PR

oxarbitrage

I left several comments related to cleanup, readability, and adding documentation. Applying some of these suggestions (and moving a few of the unrelated changes into a separate PR) would make the diff smaller and cleaner, which in turn should help us review the critical parts more carefully.

That said, these are all optional suggestions and reflect personal preference; I didn’t find any critical issues in this initial review.

If you prefer, I can also push the suggested changes directly to your branch.

oxarbitrage · 2025-11-11T19:52:00Z

+
+    test_vectors = []
+
+    # Start with the test vector from the BIP 340 repository. Specifically, the index 0 from https://github.com/bitcoin/bips/blob/master/bip-0340/test-vectors.csv


Suggested change

# Start with the test vector from the BIP 340 repository. Specifically, the index 0 from https://github.com/bitcoin/bips/blob/master/bip-0340/test-vectors.csv

# Start with the test vector from the BIP 340 repository. Specifically, the index 0 from https://github.com/bitcoin/bips/blob/445e445144afa55cbd09957919ddda92c579f8d8/bip-0340/test-vectors.csv

Maybe use a specific commit here to avoid a potentially misleading reference if something changes upstream.

Done in QED-it#44

oxarbitrage · 2025-11-12T18:12:37Z

 orchard_group_hash = "zcash_test_vectors.orchard.group_hash:main"
-orchard_map_to_curve = "zcash_test_vectors.orchard.group_hash:map_to_curve_test_vectors"
 orchard_key_components = "zcash_test_vectors.orchard.key_components:main"
+orchard_map_to_curve = "zcash_test_vectors.orchard.group_hash:map_to_curve_test_vectors"


This change appears to be only for alphabetical ordering. Maybe consider moving it to a separate PR to keep this diff smaller.

Done in #114

oxarbitrage · 2025-11-12T18:13:10Z

+  if [ "$gen_type" = "rust" ]; then
+    echo "Running rustfmt on generated Rust files..."
+    rustfmt --edition 2021 test-vectors/rust/*.rs
+  fi


Can be moved to a different PR.

Done, and opened in #112

oxarbitrage · 2025-11-12T18:36:35Z

@@ -261,7 +262,7 @@ def randbytes(l):
            'rseed': note.rseed,
            'memo': np.memo,
            'cv_net': bytes(cv),
-            'rho': bytes(rho),
+            'nf_old': bytes(rho),


Could you add a reference to justify this change?

The test vectors were changed to use nf_old instead of rho in the orchard repository in QED-it/orchard@1a8ded0, but the zcash-test-vectors repository seems not to have been updated to generate the test vectors with nf_old instead of rho. We just fixed that.

oxarbitrage · 2025-11-12T18:37:07Z

The changes in this file to define and use construct_note don’t seem strictly necessary. They appear to have been added to match the implementation in zcash_test_vectors/orchard_zsa/note_encryption.py. I’m fine with keeping them, but they could be moved to a separate PR.

We updated this structure to minimize having to rewrite code between the Vanilla Orchard and OrchardZSA parts (for example, the assert leadByte == 0x02 code needs to change to assert leadByte == 0x03 in OrchardZSA but we do not want to rewrite the entire decrypt_using_ovk function).

I prefer keeping this change in here rather than a separate PR, because the reason why the change is made is clearer when in the context of how it is reused for OrchardZSA, and in a standalone PR it would seem not strictly necessary, as you mentioned.

oxarbitrage · 2025-11-21T13:06:00Z

+# The algorithm byte prefix for the encoding of the BIP340 Schnorr signature in ZIP227 is 0x00.
+ZSA_BIP340_SIG_SCHEME = b'\0'
+
+#This function provides the encoding of the issuance key, with the algorithm byte prefix.


Suggested change

#This function provides the encoding of the issuance key, with the algorithm byte prefix.

# This function provides the encoding of the issuance key, with the algorithm byte prefix.

Done in QED-it#44

oxarbitrage · 2025-11-21T13:09:23Z

@@ -539,7 +574,7 @@ def __bytes__(self):
            for desc in self.vActionsOrchard:
                ret += bytes(desc) # Excludes spendAuthSig
            ret += struct.pack('B', self.flagsOrchard)
-            ret += struct.pack('<Q', self.valueBalanceOrchard)
+            ret += struct.pack('<q', self.valueBalanceOrchard)


Can we justify this change ?

The change was actually unnecessary, thanks for pointing it out! Reverted back to the original in QED-it#44

For more details, see QED-it#44 (comment)

oxarbitrage · 2025-11-21T13:12:12Z

    Script,
    TransactionV5,
+    NU5_TX_VERSION_BYTES,


Unused import

Suggested change

NU5_TX_VERSION_BYTES,

oxarbitrage · 2025-11-21T13:13:05Z

@@ -35,12 +41,22 @@ def transparent_digest(tx):

    return digest.digest()

+TRANSPARENT_AUTH_DIGEST_PERSONALIZAION = b'ZTxAuthTransHash'


Maybe add a reference on top of personalization constants.

Done in QED-it#52

oxarbitrage · 2025-11-21T13:31:53Z

            ret += bytes(self.bindingSigSapling)

+        return ret
+
+class TransactionV5(TransactionBase):


FYI: https://github.com/zcash/zcash-test-vectors/pull/101/files/42b168dc0db097ee9ed0823a0a387dbcea1241f9#r2462749417

We merged the upstream work, and incorporated the ZIP 233 additions

…g in TransactionBase

This performs some code refactoring to make the upstream merge in the next step less complicated. The refactoring is cosmetic in that it doesn't affect the generated test vectors. It mainly splits out the initialization and byte serialization of the transaction (in TransactionBase) to differing functions for header, transparent and sapling parts of the transaction. The Orchard parts are in the child classes (TransactionV5 and TransactionV6) and are not separated out into functions.

This merges in the updates from `upstream/master` to the target branch.

This makes the spacing, comment and minor rearrangements suggested in zcash#108 (review). Specifically, this PR makes the changes that are touching the ZSA portions of the repository.

This refactors the portions of the `TransactionBase` class so that it does not need to use the `version_group_id` to decide behaviour - the way it behaves is decided by redefinition of the added functions in the child classes (aka `TransactionV5` and `TransactionV6`). This refactor does not affect the generated test vectors.

This removes the formatting updates we made (namely the addition of `rustfmt`, and the addition of `pub(crate)` visibility and indentation changes). This reduces the difference between `upstream:master` and our branch significantly, from 69 files to 40 files, and would help speed up the review of the ZSA test vectors.

This expands the sampled code points for the get_random_unicode_bytes function to include all allowed Unicode code points. This changes the random values of the description of the Assets, and therefore changes the orchard_zsa_digests.rs and orchard_zsa_asset_base.rs files, which would need to be copied into the librustzcash and orchard repositories respectively.

This adds comments referencing the relevant sections of the ZIPs, as requested in zcash#108 (comment). We also update some constant names to fix a typo.

- Update nu7 branch id in ZIP233 - Add ZIP233 into `regenerate.sh` script - Update ZIP233 test vectors

daniben31 and others added 29 commits June 7, 2022 14:24

implement text vectors isk and ik

3e9742c

generate test vectors for issuance keys

b1c85ea

Merge pull request #2 from QED-it/issuer_keys

aa6fe2e

Issuer keys test vectors implementation

ZSA update rust code (#3)

42fd320

* zsa-sync-test-vectors: output directly the needed test code * zsa-sync-test-vectors: regenerate rust code with the same content but final format Co-authored-by: Aurélien Nicolas <info@nau.re>

Asset ID (#5)

ee15a53

Testing encryption v3 (#6)

f2566cb

- Updated to support encryption_v3 as given in QED-it/orchard#38 and QED-it/librustzcash#18. - This PR breaks compatibility with OrchardDomainV2

Changes to derive Asset base from the Asset identifier (#7)

4cf6062

This adds the changes to the zcash test vectors to update the calculation of the Asset Base from the Asset Identifier via the Asset Digest, as detailed in ZIP 227.

Update R constant for ZSA note commitment (#8)

ec06009

We would like to have the same R constant for ZEC and ZSA note commitments.

Merge branch 'zsa1' into upstream_change_merge

65e5643

Upstream change merge (#15)

3976d1c

This merges upstream changes into the `zsa1` branch of our fork.

Separate OrchardZSA from Orchard (#13)

e2f96cf

This separates the additions of the ZSA work into a separate file, creating separate test vector files for them. It also adds in upstream changes to the test vectors crate.

Merge branch 'master' into zsa_review

f93cdc5

This is to add upstream changes for ZIP 320 test vectors into the repository.

updating newly merged Rust test vectors to follow format

43e3cbc

change output rendering to reduce git diff -- changes to rust files i…

45e700c

…n next commit

updating files based on previous commit

ec642fa

reverting transaction.py edits, will include in subsequent PR

2b7fcec

Adding upstream changes and reducing the file diff from upstream (#21)

2b26fd8

This PR adds in the changes for ZIP 320 vectors from upstream. It also edits the output file in order to reduce the diff between the generated test vectors upstream.

Rename TransactionZSA to TransactionV6 (#23)

2c4e712

This renames the TransactionZSA class to TransactionV6 to better reflect its purpose as a V6 transaction format reference implementation

Updating test vectors for Action Groups (#24)

acb58a0

Replace asset_desc by asset_desc_hash (#25)

b6df140

For more details, see ZIP227

Merge branch 'master' into merge_master_20250408

218372b

Move burn fields into the Action Group (#28)

357c886

* Moving the burn fields into the action group * fixing small issue with switch to asset_desc_hash * regenerating test vector files

Merge branch 'zsa1' into merge_master_20250408

c79cd3a

Run rustfmt on generated rust files

483e640

Merge branch 'master' into zsa1 (#30)

b3744a0

Main modifications - Generate test vectors for ZIP230 adresses - Generate test vectors for ZIP32 - Update regenerate script - Update rust output by replacing vectors by slices to support no_std

PaulLaux mentioned this pull request Aug 22, 2025

OrchardZSA reference implementation zcash/orchard#372

Closed

str4d requested changes Nov 19, 2025

View reviewed changes

str4d reviewed Nov 19, 2025

View reviewed changes

oxarbitrage reviewed Nov 21, 2025

View reviewed changes

dmidem mentioned this pull request Dec 7, 2025

Upstream PR 471 (OrchardZSA) – internal review and fixes QED-it/orchard#200

Closed

vivek-arte mentioned this pull request Dec 11, 2025

Addition of rustfmt run over generated test vectors. #112

Closed

dmidem mentioned this pull request Dec 12, 2025

Upstream PR 471 (OrchardZSA) – internal review and fixes QED-it/orchard#201

Closed

This was referenced Dec 22, 2025

Minor changes suggested in review (non-ZSA) QED-it/zcash-test-vectors#43

Merged

Minor changes suggested in review (ZSA) #113

Closed

Minor changes suggested in review (ZSA) QED-it/zcash-test-vectors#44

Merged

vivek-arte and others added 14 commits December 23, 2025 15:20

adding init_ functions for the different bundles in the transaction

1bd6f78

splitting to_bytes into components for header, transparent and saplin…

125ab4e

…g in TransactionBase

small renaming to match conventions

51e4035

Merge branch 'master' into upstream_merge_prep_merge_with_master

dc82cbe

Merge branch 'zsa1' into upstream_merge_prep_merge_with_master

1bc824d

Merge with upstream (#46)

d8fd79d

This merges in the updates from `upstream/master` to the target branch.

Minor changes suggested in review (ZSA) (#44)

eb998c5

This makes the spacing, comment and minor rearrangements suggested in zcash#108 (review). Specifically, this PR makes the changes that are touching the ZSA portions of the repository.

revert rustfmt change

57402e1

revert output visibility and indentation

2f13901

regenerating test vectors

54cfa35

PaulLaux mentioned this pull request Feb 2, 2026

Add OrchardZSA zcash/orchard#471

Draft

vivek-arte mentioned this pull request Feb 3, 2026

Add ZIP links to the definition of personalizations, and fix typo QED-it/zcash-test-vectors#52

Merged

vivek-arte and others added 2 commits February 17, 2026 20:26

Add ZIP links to the definition of personalizations, and fix typo (#52)

61ee283

This adds comments referencing the relevant sections of the ZIPs, as requested in zcash#108 (comment). We also update some constant names to fix a typo.

Fix test vectors for ZIP233 (#53)

b11c686

- Update nu7 branch id in ZIP233 - Add ZIP233 into `regenerate.sh` script - Update ZIP233 test vectors

vivek-arte mentioned this pull request Mar 30, 2026

Grant Application - Feature Branch Testnet and Compatible Developer Tooling ZcashCommunityGrants/zcashcommunitygrants#256

Open

9 tasks

vivek-arte mentioned this pull request Apr 14, 2026

Improve usability of the test vectors #128

Open

5 tasks


		test_vectors = []

		# Start with the test vector from the BIP 340 repository. Specifically, the index 0 from https://github.com/bitcoin/bips/blob/master/bip-0340/test-vectors.csv

	#This function provides the encoding of the issuance key, with the algorithm byte prefix.
	# This function provides the encoding of the issuance key, with the algorithm byte prefix.

		@@ -35,12 +41,22 @@ def transparent_digest(tx):

		return digest.digest()

		TRANSPARENT_AUTH_DIGEST_PERSONALIZAION = b'ZTxAuthTransHash'

Conversation

PaulLaux commented Aug 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vivek-arte Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oxarbitrage left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vivek-arte Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vivek-arte Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

PaulLaux commented Aug 22, 2025 •

edited

Loading

vivek-arte Jan 9, 2026 •

edited

Loading

vivek-arte Jan 9, 2026 •

edited

Loading

vivek-arte Feb 3, 2026 •

edited

Loading