BIP-352: test vectors: allow to check found output count for receiving

theStack · theStack · commit ddbddc8a7b8d · 2026-02-27T03:21:11.000+01:00
Introduce an optional "n_outputs" field as alternative to the detailed
"outputs" objects (the field was already specified, but not used so
far). Also update the documentation of the fields.
diff --git a/bip-0352.mediawiki b/bip-0352.mediawiki
@@ -422,15 +422,15 @@ A [[bip-0352/send_and_receive_test_vectors.json|collection of test vectors in JS
          },
          "expected": {
              "addresses": [<array of bech32m strings, one for the silent payment address and each labeled address (if used)>],
-             "outputs": [<array of outputs with tweak and signature; contains all possible output sets, tester must match a subset of size `n_outputs`>
+             "outputs": [<optional array of outputs with tweak and signature, tester must match this set (alternatively, "n_outputs" can be specified)>
                  {
                      "priv_key_tweak": <hex encoded private key tweak data>,
                      "pub_key": <hex encoded X-only public key>,
                      "signature": <hex encoded signature for the output (produced with spend_priv_key + priv_key_tweak)>
                  },
                  ...
              ],
-             "n_outputs": <integer for the exact number of expected outputs>
+             "n_outputs": <optional integer for the number of expected found outputs (alternative to "outputs")>
          }
      }
 
diff --git a/bip-0352/reference.py b/bip-0352/reference.py
@@ -367,9 +367,14 @@ def scanning(b_scan: ECKey, B_spend: ECPubKey, A_sum: ECPubKey, input_hash: byte
             # same sender but with different labels. Because of this, expected["outputs"] contains all possible valid output sets,
             # based on all possible permutations of recipient address orderings. Must match exactly one of the possible found output
             # sets in expected["outputs"]
-            generated_set = {frozenset(d.items()) for d in add_to_wallet}
-            expected_set = {frozenset(d.items()) for d in expected["outputs"]}
-            assert generated_set == expected_set, "Receive test failed"
+            if "outputs" in expected:  # detailed check against expected outputs
+                generated_set = {frozenset(d.items()) for d in add_to_wallet}
+                expected_set = {frozenset(d.items()) for d in expected["outputs"]}
+                assert generated_set == expected_set, "Receive test failed"
+            elif "n_outputs" in expected:  # only check the number of found outputs
+                assert len(add_to_wallet) == expected["n_outputs"], "Receive test failed"
+            else:
+                assert False, "either 'outputs' or 'n_outputs' must be specified in 'expected' field of receiving test vector"
 
 
     print("All tests passed")

Original file line number	Diff line number	Diff line change
`@@ -422,15 +422,15 @@ A [[bip-0352/send_and_receive_test_vectors.json\|collection of test vectors in JS`
`422`	`422`	`},`
`423`	`423`	`"expected": {`
`424`	`424`	`"addresses": [<array of bech32m strings, one for the silent payment address and each labeled address (if used)>],`
`425`		- "outputs": [<array of outputs with tweak and signature; contains all possible output sets, tester must match a subset of size `n_outputs`>
	`425`	`+ "outputs": [<optional array of outputs with tweak and signature, tester must match this set (alternatively, "n_outputs" can be specified)>`
`426`	`426`	`{`
`427`	`427`	`"priv_key_tweak": <hex encoded private key tweak data>,`
`428`	`428`	`"pub_key": <hex encoded X-only public key>,`
`429`	`429`	`"signature": <hex encoded signature for the output (produced with spend_priv_key + priv_key_tweak)>`
`430`	`430`	`},`
`431`	`431`	`...`
`432`	`432`	`],`
`433`		`- "n_outputs": <integer for the exact number of expected outputs>`
	`433`	`+ "n_outputs": <optional integer for the number of expected found outputs (alternative to "outputs")>`
`434`	`434`	`}`
`435`	`435`	`}`
`436`	`436`